Explore the Dear Inventory data model

See how the various Dear Inventory endpoints relate to each other, using our handy Entity Relationship Diagram.

Pulling data from Dear Inventory is only the first part of your reporting. You also need to understand the relationships between different endpoints - something that APIs typically fail to convey.

At SyncHub, we not only pull your Dear Inventory endpoints down into a reportable format, we also describe their relationships (e.g. in terms of foreign keys) so that you can quickly get a grasp of your data and how it fits together. This page is intended as technical documentation of these relationships.

Endpoints

Attachment

Column Type Relates to Notes
RemoteID string - -
SaleRemoteID string Sale → RemoteID -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID guid - -
ContentType string - -
IsDefault boolean - -
FileName string - -
DownloadUrl string - -

ChartOfAccount

Documentation: https://dearinventory.docs.apiary.io/#reference/chart-of-accounts/get

Column Type Relates to Notes
RemoteID string - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
Name string - -
Description string - -
Code string - -
Status string - -
Type string - -
Class string - -
SystemAccount string - -
BankAccountNumber string - -
BankAccountID guid - -
ForPayments boolean - -
DisplayName string - -
OldCode string - -

Customer

Documentation: https://dearinventory.docs.apiary.io/#reference/customer/get

Column Type Relates to Notes
RemoteID string - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID guid - -
Name string - -
Currency string - -
PaymentTerm string - -
Discount decimal - -
TaxRule string - -
Carrier string - -
SalesRepresentative string - -
Location string - -
Comments string - -
AccountReceivable string ChartOfAccount → Code -
RevenueAccount string ChartOfAccount → Code -
PriceTier string - -
TaxNumber string - -
AdditionalAttribute1 string - -
AdditionalAttribute2 string - -
AdditionalAttribute3 string - -
AdditionalAttribute4 string - -
AdditionalAttribute5 string - -
AdditionalAttribute6 string - -
AdditionalAttribute7 string - -
AdditionalAttribute8 string - -
AdditionalAttribute9 string - -
AdditionalAttribute10 string - -
Status string - -
CreditLimit decimal - -
IsOnCreditHold boolean - -
LastModifiedOn datetime - -

CustomerAddress

Column Type Relates to Notes
RemoteID string - -
CustomerRemoteID string Customer → RemoteID -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID guid - -
CustomerID guid Customer → ID -
Line1 string - -
Line2 string - -
City string - -
State string - -
Postcode string - -
Country string - -
Type string - -
DefaultForType boolean - -

CustomerContact

Column Type Relates to Notes
RemoteID string - -
CustomerRemoteID string Customer → RemoteID -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID guid - -
Name string - -
CustomerID guid Customer → ID -
JobTitle string - -
Phone string - -
MobilePhone string - -
Fax string - -
Email string - -
Website string - -
Default boolean - -
Comment string - -
IncludeInEmail boolean - -

CustomerProduct

Column Type Relates to Notes
RemoteID string - -
CustomerRemoteID string Customer → RemoteID -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ProductID guid Product → ID -
CustomerID guid Customer → ID -
Price decimal - -

Disassembly

Documentation: https://dearinventory.docs.apiary.io/#reference/disassembly/disassembly/get

Column Type Relates to Notes
RemoteID string - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
WIPAccount string ChartOfAccount → Code -
AssemblyInstructionURL string - -
TaskID guid - -
DisassemblyNumber string - -
ProductID guid Product → ID -
Quantity decimal - -
LocationID guid Location → ID -
Status string - -

DisassemblyOrderLine

Column Type Relates to Notes
RemoteID string - -
DisassemblyRemoteID string Disassembly → RemoteID -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
DisassemblyID guid Disassembly → TaskID -
ProductID guid Product → ID -
BinID guid LocationBin → ID -
Unit string - -
BatchSN string - -
ExpiryDate datetime - -
Account string ChartOfAccount → Code -
Cost decimal - -
Quantity decimal - -

DisassemblyOrderServiceLine

Column Type Relates to Notes
RemoteID string - -
DisassemblyRemoteID string Disassembly → RemoteID -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
Name string - -
DisassemblyID guid Disassembly → TaskID -
ProductID guid Product → ID -
Account string ChartOfAccount → Code -
Comments string - -
Amount decimal - -

DisassemblyPickLine

Column Type Relates to Notes
RemoteID string - -
DisassemblyRemoteID string Disassembly → RemoteID -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
DisassemblyID guid Disassembly → TaskID -
BinID guid LocationBin → ID -
BatchSN string - -
ExpiryDate datetime - -
Available decimal - -
UnitCost decimal - -
Quantity decimal - -
TotalCost decimal - -
CompletionDate datetime - -

FactoryCalendar

Documentation: https://dearinventory.docs.apiary.io/#reference/production/factory-calendar/get

Column Type Relates to Notes
RemoteID string - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
Year int - -
WeekStart string - -

FactoryCalendarDay

Column Type Relates to Notes
RemoteID string - -
FactoryCalendarRemoteID string FactoryCalendar → RemoteID -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
Year int FactoryCalendar → Year -
DayOfWeek string - -
IsWeekend boolean - -
StartTime decimal - -
EndTime decimal - -
BreakStartTime decimal - -
BreakEndTime decimal - -
Capacity decimal - -

FactoryCalendarSpecialDay

Column Type Relates to Notes
RemoteID string - -
FactoryCalendarRemoteID string FactoryCalendar → RemoteID -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
Year int FactoryCalendar → Year -
Date datetime - -
IsHoliday boolean - -
IsWeekend boolean - -
StartTime decimal - -
EndTime decimal - -
BreakStartTime decimal - -
BreakEndTime decimal - -
Comment string - -
Capacity decimal - -

Location

Documentation: https://dearinventory.docs.apiary.io/#reference/Location/get

Column Type Relates to Notes
RemoteID string - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID guid - -
Name string - -
IsDefault string - -
IsDeprecated string - -
FixedAssetsLocation string - -
ParentID guid Location → ID -
ParentName string - -
ReferenceCount string - -
AddressLine1 string - -
AddressLine2 string - -
AddressCitySuburb string - -
AddressStateProvince string - -
AddressZipPostCode string - -
AddressCountry string - -
PickZones string -
  • 9 May 2022 Formatted as CSV
IsShopfloor string - -
IsCoMan string - -
IsStaging string - -

LocationBin

Column Type Relates to Notes
RemoteID string - -
LocationRemoteID string Location → RemoteID -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID guid - -
Name string - -
LocationID guid Location → ID -
IsDeprecated boolean - -
IsStaging boolean - -

LocationPickZone

Column Type Relates to Notes
RemoteID string - -
LocationRemoteID string Location → RemoteID -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
Name string - -
LocationID guid Location → ID -

Product

Documentation: https://dearinventory.docs.apiary.io/#reference/product/get

Column Type Relates to Notes
RemoteID string - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID guid - -
Name string - -
Description string - -
SKU string - -
Category string -
  • 21 Jun 2022 Dear Inventory returns the category name, but unfortunately not the ID, so we are unable to foreign-key this relationship
Brand string - -
Type string - -
CostingMethod string - -
DropShipMode string - -
DefaultLocation string - -
Length string - -
Width string - -
Height string - -
Weight string - -
UOM string - -
WeightUnits string - -
DimensionsUnits string - -
Barcode string - -
MinimumBeforeReorder string - -
ReorderQuantity string - -
AverageCost string - -
ShortDescription string - -
InternalNote string - -
AdditionalAttribute1 string - -
AdditionalAttribute2 string - -
AdditionalAttribute3 string - -
AdditionalAttribute4 string - -
AdditionalAttribute5 string - -
AdditionalAttribute6 string - -
AdditionalAttribute7 string - -
AdditionalAttribute8 string - -
AdditionalAttribute9 string - -
AdditionalAttribute10 string - -
AttributeSet string - -
DiscountRule string - -
Status string - -
StockLocator string - -
COGSAccount string ChartOfAccount → Code -
RevenueAccount string ChartOfAccount → Code -
ExpenseAccount string ChartOfAccount → Code -
InventoryAccount string ChartOfAccount → Code -
PurchaseTaxRule string - -
SaleTaxRule string - -
Sellable boolean - -
PickZones string - -
BillOfMaterial boolean - -
AutoAssembly boolean - -
AutoDisassembly boolean - -
QuantityToProduce decimal - -
AssemblyInstructionURL string - -
AssemblyCostEstimationMethod string - -
BOMType string - -
LastModifiedOn datetime - -

ProductAvailability

Documentation: https://dearinventory.docs.apiary.io/#reference/product/product-availability/get

Column Type Relates to Notes
RemoteID string -
  • 21 Jun 2022 The unique ID compromises the ProductID and Batch code and Location. Note that Batch can be blank, but there is only one
ProductRemoteID string Product → RemoteID -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID guid - -
ProductID guid Product → ID -
SKU string - -
Barcode string - -
Location string -
  • 20 Jun 2022 This is the Location Name, rather than a foreign key GUID reference
Bin string -
  • 20 Jun 2022 This is the Bin Name, rather than a foreign key GUID reference
Batch string - -
ExpiryDate datetime - -
OnHand decimal - -
Allocated decimal - -
Available decimal - -
OnOrder decimal - -
StockOnHand decimal - -

ProductBOMProduct

Column Type Relates to Notes
RemoteID string - -
ProductRemoteID string Product → RemoteID -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ProductID guid Product → ID -
ComponentProductID guid - -
Quantity decimal - -
WastagePercent decimal - -
WastageQuantity decimal - -
CostPercentage decimal - -

ProductBOMService

Column Type Relates to Notes
RemoteID string - -
ProductRemoteID string Product → RemoteID -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ProductID guid Product → ID -
ComponentProductID guid - -
Quantity decimal - -
ExpenseAccount string ChartOfAccount → Code -
PriceTier int - -

ProductCategory

Documentation: https://dearinventory.docs.apiary.io/#reference/product-categories/get

Column Type Relates to Notes
RemoteID string - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID guid - -
Name string - -

ProductCustomPrice

Column Type Relates to Notes
RemoteID string - -
ProductRemoteID string Product → RemoteID -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ProductID guid Product → ID -
CustomerID guid Customer → ID -
CustomerCurrency string - -
Price decimal - -

ProductFamily

Documentation: https://dearinventory.docs.apiary.io/#reference/product-family/product-family/get

Column Type Relates to Notes
RemoteID string - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID guid - -
Name string - -
Description string - -
SKU string - -
Category string - -
DefaultLocation string - -
Brand string - -
CostingMethod string - -
UOM string - -
MinimumBeforeReorder decimal - -
ReorderQuantity string - -
PriceTier1 decimal - -
PriceTier2 decimal - -
PriceTier3 decimal - -
PriceTier4 decimal - -
PriceTier5 decimal - -
PriceTier6 decimal - -
PriceTier7 decimal - -
PriceTier8 decimal - -
PriceTier9 decimal - -
PriceTier10 decimal - -
ShortDescription string - -
DiscountRule string - -
Tags string - -
COGSAccount string ChartOfAccount → Code -
RevenueAccount string ChartOfAccount → Code -
InventoryAccount string ChartOfAccount → Code -
PurchaseTaxRule string - -
SaleTaxRule string - -
DropShipMode string - -
Option1Name string - -
Option2Name string - -
Option3Name string - -
Option1Values string - -
Option2Values string - -
Option3Values string - -
LastModifiedOn datetime - -

ProductFamilyProduct

Column Type Relates to Notes
RemoteID string - -
ProductFamilyRemoteID string ProductFamily → RemoteID -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID guid Product → ID -
Name string - -
ProductFamilyID guid ProductFamily → ID -
SKU string - -
Option1 string - -
Option2 string - -
Option3 string - -

ProductFamilyProductionBOM

Documentation: https://dearinventory.docs.apiary.io/#reference/production/product-production-bom/get

Column Type Relates to Notes
RemoteID string - -
ProductFamilyRemoteID string ProductFamily → RemoteID -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
Name string - -
BOMID guid - -
ProductFamilyID guid ProductFamily → ID -
OutputQuantity decimal - -
BufferPercent decimal - -
InstructionUrl string - -
IgnoreCumulativeLeadTime boolean - -
ComponentProductionLeadTime decimal - -
Version decimal - -
IsDefault boolean - -
CreatedDate datetime - -
DeliveryToID guid Location → ID
  • 17 May 2022 The DeliveryToID refers to the Bin/Location for this BOM
IssueMethod string - -
IsTracing boolean - -
IssueMethodComponent string - -
IssueMethodParameter string - -
MinQuantity decimal - -
MaxQuantity decimal - -
DeviationPercent decimal - -
RunSize decimal - -

ProductFamilyProductionBOMOperation

Column Type Relates to Notes
RemoteID string - -
ProductFamilyProductionBOMRemoteID string ProductFamilyProductionBOM → RemoteID -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
Name string - -
ProductFamilyProductionBOMID guid ProductFamilyProductionBOM → BOMID -
OperationID guid - -
Order decimal - -
CycleTime decimal -
  • 17 May 2022 Specified in seconds
UnitsPerCycle decimal - -
WorkCenterID guid WorkCenter → WorkCenterID -
WorkCenterCoManProcurementType string - -
OperationType string - -
IsDropShip boolean - -

ProductFamilyTag

Column Type Relates to Notes
RemoteID string - -
ProductFamilyRemoteID string ProductFamily → RemoteID -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ProductFamilyID guid ProductFamily → ID -
Tag string - -

ProductMovement

Column Type Relates to Notes
RemoteID string - -
ProductRemoteID string Product → RemoteID -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ProductID guid Product → ID -
MovementNumber int - -
TaskID guid -
  • 9 May 2022 The TaskID directs to a different entity depending on the Type property. For example, if this is Type='Adjustment', then the TaskID is actually a StockAdjustmentID
StockAdjustmentTaskID guid - -
PurchaseTaskID guid - -
Type string - -
Date datetime - -
Number string - -
Quantity decimal - -
Amount decimal - -
Location string - -
BatchSN string - -
ExpiryDate datetime - -
FromTo string - -

ProductPriceTier

Column Type Relates to Notes
RemoteID string - -
ProductRemoteID string Product → RemoteID -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ProductID guid Product → ID -
PriceTierName string - -
Price decimal - -

ProductProductionBOM

Documentation: https://dearinventory.docs.apiary.io/#reference/production/product-production-bom/get

Column Type Relates to Notes
RemoteID string - -
ProductRemoteID string Product → RemoteID -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
Name string - -
BOMID guid - -
ProductID guid Product → ID -
OutputQuantity decimal - -
BufferPercent decimal - -
InstructionUrl string - -
IgnoreCumulativeLeadTime boolean - -
ComponentProductionLeadTime decimal - -
Version decimal - -
IsDefault boolean - -
CreatedDate datetime - -
DeliveryToID guid Location → ID
  • 17 May 2022 The DeliveryToID refers to the Bin/Location for this BOM
IssueMethod string - -
IsTracing boolean - -
IssueMethodComponent string - -
IssueMethodParameter string - -
MinQuantity decimal - -
MaxQuantity decimal - -
DeviationPercent decimal - -
RunSize decimal - -

ProductProductionBOMOperation

Column Type Relates to Notes
RemoteID string - -
ProductProductionBOMRemoteID string ProductProductionBOM → RemoteID -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
Name string - -
ProductProductionBOMID guid ProductProductionBOM → BOMID -
OperationID guid - -
Order decimal - -
CycleTime decimal -
  • 17 May 2022 Specified in seconds
UnitsPerCycle decimal - -
WorkCenterID guid WorkCenter → WorkCenterID -
WorkCenterCoManProcurementType string - -
OperationType string - -
DeliveryToID guid Location → ID
  • 17 May 2022 The DeliveryToID refers to the Bin/Location for this BOM
DeliveryToName string - -
IssueMethod string - -
IsDropShip boolean - -
IsBackflush boolean - -

ProductReorderLevel

Column Type Relates to Notes
RemoteID string - -
ProductRemoteID string Product → RemoteID -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ProductID guid Product → ID -
LocationID guid - -
MinimumBeforeReorder decimal - -
ReorderQuantity decimal - -
StockLocator string -
  • 9 May 2022 The location of this product in your warehouse
PickZones string -
  • 9 May 2022 CSV string of pick zones for this product in this warehouse

ProductSupplier

Column Type Relates to Notes
RemoteID string - -
ProductRemoteID string Product → RemoteID -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ProductID guid Product → ID -
SupplierID guid Supplier → ID -
SupplierInventoryCode string - -
SupplierProductName string - -
Cost decimal - -
FixedCost decimal - -
Currency string - -
DropShip boolean - -
URL string - -

ProductTag

Column Type Relates to Notes
RemoteID string - -
ProductRemoteID string Product → RemoteID -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ProductID guid Product → ID -
Tag string - -

ProductionOrder

Documentation: https://dearinventory.docs.apiary.io/#reference/production/production-order/get

Column Type Relates to Notes
RemoteID string - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
CostingMethod string - -
WarehouseID guid - -
Unit string - -
SourceName string - -
IsIgnoreLeadTime boolean - -
RetailID guid - -
StartUpdate boolean - -
PlannedBy string - -
ReleasedBy string - -
OrderCycleTime decimal -
  • 17 May 2022 Represented in seconds
BOMVersion decimal - -
BOMName string - -
Tags string - -
IssueMethodComponent string - -
IssueMethodParameter string - -
RunSize string - -
TaskID guid - -
ProductionOrderID guid - -
Type string -
  • 17 May 2022 O - Production Order; R - Production Order Run
TypeDescription string - -
ProductID guid Product → ID -
OrderNumber string - -
LocationID guid Location → ID -
Status string - -
OrderStatus string - -
Quantity decimal - -
StartDate datetime - -
ReleaseDate datetime - -
RequiredByDate datetime - -
CompletionDate datetime - -
TotalCount decimal - -
CapacityCalculationType string - -
WIPAccountCode string ChartOfAccount → Code -
FinishedGoodsAccountCode string ChartOfAccount → Code -
Comments string - -
CustomField1 string - -
CustomField2 string - -
CustomField3 string - -
CustomField4 string - -
CustomField5 string - -
CustomField6 string - -
CustomField7 string - -
CustomField8 string - -
CustomField9 string - -
CustomField10 string - -

ProductionOrderRun

Documentation: https://dearinventory.docs.apiary.io/#reference/production/production-run/get

Column Type Relates to Notes
RemoteID string - -
ProductionOrderRemoteID string ProductionOrder → RemoteID -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ProductionOrderID guid ProductionOrder → ProductionOrderID -
RunID guid - -
Number decimal - -
Status string - -
Quantity decimal - -
WIPAccount string ChartOfAccount → Code -
StartDate datetime - -
EndDate datetime - -
DueDate datetime - -
ReceivedDate datetime - -
ScheduleStart datetime - -
ScheduleDue datetime - -
IssueMethodParameter string - -

Purchase

Column Type Relates to Notes
RemoteID string - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID guid - -
SupplierID guid Supplier → ID -
Contact string - -
Phone string - -
InventoryAccount string ChartOfAccount → Code -
BlindReceipt boolean - -
Approach string - -
BaseCurrency string - -
SupplierCurrency string - -
TaxRule string - -
TaxCalculation string - -
Terms string - -
RequiredBy datetime - -
Location string - -
Note string - -
OrderDate datetime - -
CombinedReceivingStatus string - -
CombinedInvoiceStatus string - -
CombinedPaymentStatus string - -
Type string - -
IsServiceOnly boolean - -
RelatedDropShipSaleTask guid - -
CurrencyRate decimal - -
OrderMemo string - -
OrderStatus string - -
OrderTotalBeforeTax decimal - -
OrderTax decimal - -
OrderTotal decimal - -
OrderNumber string - -
Status string - -
LastUpdatedDate datetime - -

PurchaseAttachment

Column Type Relates to Notes
RemoteID string - -
PurchaseRemoteID string Purchase → RemoteID -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
PurchaseID guid Purchase → ID -
AttachmentID guid Attachment → ID -

PurchaseOrderLine

Column Type Relates to Notes
RemoteID string - -
PurchaseRemoteID string Purchase → RemoteID -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
PurchaseID guid Purchase → ID -
LineNumber int - -
ProductID guid Product → ID -
SKU string - -
Quantity decimal - -
Price decimal - -
Discount decimal - -
Tax decimal - -
Total decimal - -
TaxRule string - -
SupplierSKU string - -
Comment string - -

PurchasePayment

Documentation: https://dearinventory.docs.apiary.io/#reference/purchase/advanced-purchase-payments/get

Column Type Relates to Notes
RemoteID string - -
PurchaseRemoteID string Purchase → RemoteID -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime -
  • 20 Jun 2022 We have coalesced DatePaid and DateCreated, which isn't technically 100% accurate but it is a likely approximation and fit for purpose
ID guid - -
PurchaseID guid Purchase → ID -
TaskID guid - -
Type string - -
Reference string - -
Amount decimal - -
DatePaid datetime - -
Account string ChartOfAccount → Code -
CurrencyRate decimal - -
DateCreated datetime - -

PurchaseStockReceived

Column Type Relates to Notes
RemoteID string - -
PurchaseRemoteID string Purchase → RemoteID -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID guid - -
PurchaseID guid Purchase → ID -
Iterator int - -
TaskID guid - -
Status string - -

PurchaseStockReceivedLine

Column Type Relates to Notes
RemoteID string - -
PurchaseStockReceivedRemoteID string PurchaseStockReceived → RemoteID -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
Name string - -
Date datetime - -
Quantity decimal - -
ProductID guid Product → ID -
SKU string - -
LocationID guid Location → ID -
Received boolean - -
BatchSN string - -
SupplierSKU string - -
ExpiryDate datetime - -
PurchaseStockRemoteID string PurchaseStockReceived → RemoteID -
LineNumber int - -

Sale

Documentation: https://dearinventory.docs.apiary.io/#reference/sale/get

Column Type Relates to Notes
RemoteID string - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID guid - -
CustomerID guid Customer → ID -
Contact string - -
Phone string - -
Email string - -
DefaultAccount string - -
SkipQuote boolean - -
ShippingNotes string - -
BaseCurrency string - -
CustomerCurrency string - -
TaxRule string - -
TaxCalculation string - -
Terms string - -
PriceTier string - -
ShipBy datetime - -
Location string - -
SaleOrderDate datetime - -
LastModifiedOn datetime - -
Note string - -
CustomerReference string - -
COGSAmount decimal - -
Status string - -
CombinedPickingStatus string - -
CombinedPackingStatus string - -
CombinedShippingStatus string - -
FulfilmentStatus string - -
CombinedInvoiceStatus string - -
CombinedPaymentStatus string - -
CombinedTrackingNumbers string - -
Carrier string - -
CurrencyRate decimal - -
SalesRepresentative string - -
Type string - -
SourceChannel string - -
ExternalID string - -
ServiceOnly boolean - -
QuoteMemo string - -
QuoteStatus string - -
QuoteTotalBeforeTax decimal - -
QuoteTax decimal - -
QuoteTotal decimal - -
SaleOrderNumber string - -
OrderMemo string - -
OrderTotalBeforeTax decimal - -
OrderTax decimal - -
OrderTotal decimal - -

SaleAttachment

Column Type Relates to Notes
RemoteID string - -
SaleRemoteID string Sale → RemoteID -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
SaleID guid Sale → ID -
AttachmentID guid Attachment → ID -

SaleCreditNote

Column Type Relates to Notes
RemoteID string - -
SaleRemoteID string Sale → RemoteID -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
SaleID guid Sale → ID -
TaskID guid - -
CreditNoteInvoiceNumber string - -
Memo string - -
Status string - -
CreditNoteDate datetime - -
CreditNoteNumber string - -
CreditNoteConversionRate decimal - -
TotalBeforeTax decimal - -
Tax decimal - -
Total decimal - -

SaleCreditNoteLine

Column Type Relates to Notes
RemoteID string - -
SaleCreditNoteRemoteID string SaleCreditNote → RemoteID -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
Name string - -
ProductID guid Product → ID -
SKU string - -
Quantity decimal - -
Price decimal - -
Discount decimal - -
Tax decimal - -
Total decimal - -
AverageCost decimal - -
TaxRule string - -
Account string - -
Comment string - -
LineNumber int - -

SaleFulfilment

Column Type Relates to Notes
RemoteID string - -
SaleRemoteID string Sale → RemoteID -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
TaskID guid -
  • 20 Jun 2022 The TaskID refers to the SaleID this pertains to
SaleID guid Sale → ID -
FulfilmentNumber int - -
LinkedInvoiceNumber string - -
ShippingStatus string - -
ShippingRequireBy datetime - -
ShippingNotes string - -
ShippingDisplayAddressLine1 string - -
ShippingDisplayAddressLine2 string - -
ShippingLine1 string - -
ShippingLine2 string - -
ShippingCity string - -
ShippingState string - -
ShippingPostcode string - -
ShippingCountry string - -
ShippingCompany string - -
ShippingContact string - -
ShippingShipToOther boolean - -
PickStatus string - -
PackStatus string - -

SaleFulfilmentPickPackLine

Column Type Relates to Notes
RemoteID string - -
SaleFulfilmentRemoteID string SaleFulfilment → RemoteID -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ProductID guid Product → ID -
Type string - -
SKU string - -
LocationID guid Location → ID -
Quantity decimal - -
BatchSN string - -
ExpiryDate datetime - -
Box string -
  • 20 Jun 2022 The Box is only relevant to 'Pack' lines
NonInventory boolean - -
WarrantyRegistrationNumber string - -
RestockLocation string - -
RestockLocationID guid Location → ID -
LineNumber int - -

SaleFulfilmentShipLine

Column Type Relates to Notes
RemoteID string - -
SaleFulfilmentRemoteID string SaleFulfilment → RemoteID -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID guid - -
ShipmentDate datetime - -
Carrier string - -
Boxes string - -
TrackingNumber string - -
TrackingURL string - -
IsShipped boolean - -
LineNumber int - -

SaleInvoice

Column Type Relates to Notes
RemoteID string - -
SaleRemoteID string Sale → RemoteID -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
SaleID guid Sale → ID -
TaskID guid - -
CombineAdditionalCharges boolean - -
InvoiceNumber string - -
Memo string - -
Status string - -
InvoiceDate datetime - -
InvoiceDueDate datetime - -
CurrencyConversionRate decimal - -
BillingAddressLine1 string - -
BillingAddressLine2 string - -
LinkedFulfilmentNumber int - -
TotalBeforeTax decimal - -
Tax decimal - -
Total decimal - -
Paid decimal - -

SaleInvoiceAdditionalCharge

Column Type Relates to Notes
RemoteID string - -
SaleInvoiceRemoteID string SaleInvoice → RemoteID -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
Description string - -
LineNumber int - -
Quantity decimal - -
Price decimal - -
Discount decimal - -
Tax decimal - -
Total decimal - -
TaxRule string - -
Account string - -
Comment string - -

SaleInvoiceLine

Column Type Relates to Notes
RemoteID string - -
SaleInvoiceRemoteID string SaleInvoice → RemoteID -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
Name string - -
ProductID guid Product → ID -
SKU string - -
Quantity decimal - -
Price decimal - -
Discount decimal - -
Tax decimal - -
Total decimal - -
AverageCost decimal - -
TaxRule string - -
Account string - -
Comment string - -
LineNumber int - -

SalePayment

Column Type Relates to Notes
RemoteID string - -
SaleRemoteID string Sale → RemoteID -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID guid - -
SaleID guid Sale → ID -
TaskID guid - -
Reference string - -
Amount decimal - -
DatePaid datetime - -
Account string - -
CurrencyRate decimal - -
DateCreated datetime - -
Type string - -
CreditID guid - -

Supplier

Documentation: https://dearinventory.docs.apiary.io/#reference/Supplier/get

Column Type Relates to Notes
RemoteID string - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID guid - -
Name string - -
Currency string - -
PaymentTerm string - -
TaxRule string - -
Discount decimal - -
Comments string - -
AccountPayable string - -
TaxNumber string - -
AdditionalAttribute1 string - -
AdditionalAttribute2 string - -
AdditionalAttribute3 string - -
AdditionalAttribute4 string - -
AdditionalAttribute5 string - -
AdditionalAttribute6 string - -
AdditionalAttribute7 string - -
AdditionalAttribute8 string - -
AdditionalAttribute9 string - -
AdditionalAttribute10 string - -
Status string - -
LastModifiedOn datetime - -

SupplierAddress

Column Type Relates to Notes
RemoteID string - -
SupplierRemoteID string Supplier → RemoteID -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID guid - -
SupplierID guid Supplier → ID -
Line1 string - -
Line2 string - -
City string - -
State string - -
Postcode string - -
Country string - -
Type string - -
DefaultForType boolean - -

SupplierContact

Column Type Relates to Notes
RemoteID string - -
SupplierRemoteID string Supplier → RemoteID -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID guid - -
Name string - -
SupplierID guid Supplier → ID -
Phone string - -
MobilePhone string - -
Fax string - -
Email string - -
Website string - -
Default boolean - -
Comment string - -
IncludeInEmail boolean - -

WorkCenter

Documentation: https://dearinventory.docs.apiary.io/#reference/production/work-centers/get

Column Type Relates to Notes
RemoteID string - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
Name string - -
WorkCenterID guid - -
Code string - -
IsActive boolean - -
IsCoMan boolean - -
SupplierID guid Supplier → ID -
CoManProcurementType string - -

WorkCenterLocation

Column Type Relates to Notes
RemoteID string - -
WorkCenterRemoteID string WorkCenter → RemoteID -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID guid - -
WorkCenterID guid WorkCenter → WorkCenterID -
LocationID guid Location → ID -
Type string - -

Need more?

SyncHub lives and breathes APIs and data. Keep exploring using the links below.