Explore the Unleashed data model

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

Background

Pulling data from Unleashed 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 Unleashed 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

AttributeSet

Documentation: https://apidocs.unleashedsoftware.com/AttributeSets

Column Type Relates to Notes
RemoteID string - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
Guid guid - -
SetName string - -
Type string - -
CreatedBy string - -
CreatedOn datetime - -
LastModifiedBy string - -
LastModifiedOn datetime - -

Attribute

Column Type Relates to Notes
RemoteID string - -
AttributeRemoteID string - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
Name string - -
Guid guid - -
Value string - -
IsRequired boolean - -
AttributeSetGuid guid AttributeSet → Guid -

Company

Documentation: https://apidocs.unleashedsoftware.com/Companies

Column Type Relates to Notes
RemoteID string - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
Guid guid - -
CompanyName string - -
BaseCurrencyCode string - -
DefaultTaxRate decimal - -

CreditNote

Documentation: https://apidocs.unleashedsoftware.com/CreditNotes

Column Type Relates to Notes
RemoteID string - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
Guid guid - -
Status string - -
CustomerGuid guid Customer → Guid -
CurrencyGuid guid - -
CreditDate datetime - -
CreditNoteNumber string - -
SalesInvoiceDate datetime - -
RequiredDeliveryDate datetime - -
InvoiceNumber string - -
TaxGuid guid -
  • 10 Aug 2020 Foreign Key - References `Taxes` (not implemented).
TaxRate decimal - -
Total decimal - -
BCTotal decimal - -
Comments string - -
SubTotal decimal - -
BCSubTotal decimal - -
TaxTotal decimal - -
BCTaxTotal decimal - -
CreatedBy string - -
CreatedOn datetime - -
LastModifiedBy string - -
WarehouseGuid guid Warehouse → Guid -
LastModifiedOn datetime - -

CreditNoteLine

Column Type Relates to Notes
RemoteID string - -
CreditNoteLineRemoteID string - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
CreditNoteGuid guid CreditNote → Guid -
LineNumber int - -
LineType string - -
ProductGuid guid Product → Guid -
LineTaxCode string - -
XeroSalesAccount string - -
XeroTaxCode string - -
OrderQuantity decimal - -
CreditQuantity decimal - -
CreditPrice decimal - -
LineTotal decimal - -
Comments string - -
TaxRate decimal - -
LineTax decimal - -
Reason string - -
Return boolean -
  • 25 May 2020 The docs say Return exists, but we find ReturnToStock coming down in the response. We will leave Return in here, just in case it is dynamic (which other endpoints in Unleashed have been observed to do)
ReturnToStock boolean -
  • 25 May 2020 Not in documentation, but observed in response. Suspect is is analogous to the (missing) Return property
Disassemble boolean - -
LastModifiedOn datetime - -

Customer

Documentation: https://apidocs.unleashedsoftware.com/Customers

Column Type Relates to Notes
RemoteID string - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
Guid guid - -
TaxCode string - -
TaxRate decimal - -
CustomerCode string - -
CustomerName string - -
GSTVATNumber string - -
BankName string - -
BankBranch string - -
BankAccount string - -
Website string - -
PhoneNumber string - -
FaxNumber string - -
MobileNumber string - -
DDINumber string - -
TollFreeNumber string - -
Email string - -
EmailCC string - -
CurrencyGuid guid - -
CurrencyCode string - -
Notes string - -
Taxable boolean - -
XeroContactID string - -
SalesPersonGuid guid SalesPerson → Guid -
DiscountRate decimal - -
PrintPackingSlipInsteadOfInvoice boolean - -
PrintInvoice boolean - -
StopCredit boolean - -
Obsolete boolean - -
XeroSalesAccount string - -
XeroCostOfGoodsAccount string - -
SellPriceTier string - -
CustomerType string - -
PaymentTerm string - -
ContactFirstName string - -
ContactLastName string - -
SourceID string - -
CreatedBy string - -
CreatedOn datetime - -
LastModifiedBy string - -
LastModifiedOn datetime - -

Product

Documentation: https://apidocs.unleashedsoftware.com/Products

Column Type Relates to Notes
RemoteID string - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
Guid guid - -
ProductCode string - -
ProductDescription string - -
Barcode string - -
PackSize decimal - -
Width decimal - -
Height decimal - -
Depth decimal - -
Weight decimal - -
MinStockAlertLevel decimal - -
MaxStockAlertLevel decimal - -
ReOrderPoint decimal - -
UnitOfMeasureGuid guid -
  • 10 Aug 2020 Foreign Key - references `UnitOfMeasures` (not implemented)
NeverDiminishing boolean - -
LastCost decimal - -
DefaultPurchasePrice decimal - -
DefaultSellPrice decimal - -
CustomerSellPrice decimal - -
AverageLandPrice decimal - -
Obsolete boolean - -
Notes string - -
ImageUrl string - -
SellPriceTier1Name string - -
SellPriceTier1Value string - -
SellPriceTier2Name string - -
SellPriceTier2Value string - -
SellPriceTier3Name string - -
SellPriceTier3Value string - -
SellPriceTier4Name string - -
SellPriceTier4Value string - -
SellPriceTier5Name string - -
SellPriceTier5Value string - -
SellPriceTier6Name string - -
SellPriceTier6Value string - -
SellPriceTier7Name string - -
SellPriceTier7Value string - -
SellPriceTier8Name string - -
SellPriceTier8Value string - -
SellPriceTier9Name string - -
SellPriceTier9Value string - -
SellPriceTier10Name string - -
SellPriceTier10Value string - -
XeroTaxCode string - -
XeroTaxRate decimal - -
TaxablePurchase boolean - -
TaxableSales boolean - -
XeroSalesTaxCode string - -
XeroSalesTaxRate decimal - -
IsComponent boolean - -
IsAssembledProduct string - -
ProductGroupGuid guid ProductGroup → Guid -
XeroSalesAccount string - -
XeroCostOfGoodsAccount string - -
PurchaseAccount string -
  • 10 Feb 2020 No mention of PurchaseAccount in the API documentation, but observed in real-world usage
BinLocation string - -
SupplierGuid guid Supplier → Guid -
AttributeSetGuid guid AttributeSet → Guid -
SourceID string - -
SourceVariantParentID string - -
IsSerialized boolean - -
IsBatchTracked boolean - -
IsSellable boolean - -
MinimumSellPrice decimal - -
MinimumSaleQuantity decimal - -
MinimumOrderQuantity decimal - -
CreatedBy string - -
CreatedOn datetime - -
LastModifiedBy string - -
LastModifiedOn datetime - -

ProductGroup

Documentation: https://apidocs.unleashedsoftware.com/ProductGroups

Column Type Relates to Notes
RemoteID string - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
Guid guid - -
GroupName string - -
LastModifiedOn datetime - -

ProductPrice

Documentation: https://apidocs.unleashedsoftware.com/ProductGroups

Column Type Relates to Notes
RemoteID string - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
Guid guid - -
ProductGuid guid Product → Guid -
ProductGroupGuid guid ProductGroup → Guid -
CustomerGuid guid Customer → Guid -
PriceType string - -
DiscountValue decimal - -
MinimumQuantity decimal - -
DefaultSellPrice decimal - -
CustomerPrice decimal - -
ValidFrom datetime - -
ValidTo datetime - -
Comments string - -
LastModifiedOn datetime - -

PurchaseOrder

Documentation: https://apidocs.unleashedsoftware.com/Purchases

Column Type Relates to Notes
RemoteID string - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
Guid guid - -
OrderNumber string - -
OrderDate datetime - -
RequiredDate datetime - -
DeliveryDate datetime - -
CompletedDate datetime - -
SupplierGuid guid Supplier → Guid -
SupplierRef string - -
Comments string - -
Printed boolean - -
OrderStatus string - -
ReceivedDate datetime - -
DeliveryName string - -
DeliveryStreetAddress string - -
DeliveryStreetAddress2 string - -
DeliverySuburb string - -
DeliveryRegion string - -
DeliveryCity string - -
DeliveryCountry string - -
DeliveryPostCode string - -
CurrencyGuid guid - -
ExchangeRate decimal - -
TaxGuid guid -
  • 10 Aug 2020 Foreign Key - References `Taxes` (not implemented)
TaxRate decimal - -
XeroTaxCode string - -
SubTotal decimal - -
Total decimal - -
TotalVolume decimal - -
TotalWeight decimal - -
SupplierInvoiceDate datetime - -
BCSubTotal decimal - -
BCTaxTotal decimal - -
BCTotal decimal - -
WarehouseGuid guid Warehouse → Guid -
DiscountRate decimal - -
CreatedOn datetime - -
CreatedBy string - -
LastModifiedBy string - -
LastModifiedOn datetime - -

PurchaseOrderLine

Column Type Relates to Notes
RemoteID string - -
PurchaseOrderLineRemoteID string - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
Guid guid - -
PurchaseOrderGuid guid PurchaseOrder → Guid -
LineNumber int - -
ProductGuid guid Product → Guid -
DueDate datetime - -
OrderQuantity decimal - -
UnitPrice decimal - -
LineTotal decimal - -
Volume decimal - -
Weight decimal - -
Comments string - -
ReceiptQuantity decimal - -
BCUnitPrice decimal - -
BCSubTotal decimal - -
LineTax decimal - -
LastModifiedOn datetime - -
DiscountedUnitPrice decimal - -
DiscountRate decimal - -

SalesOrder

Documentation: https://apidocs.unleashedsoftware.com/SalesOrders

Column Type Relates to Notes
RemoteID string - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
Guid guid - -
OrderNumber string - -
OrderDate datetime - -
RequiredDate datetime - -
CompletedDate datetime - -
OrderStatus string - -
CustomerGuid guid Customer → Guid -
CustomerRef string - -
WarehouseGuid guid Warehouse → Guid -
ReceivedDate datetime - -
DeliveryInstruction string - -
DeliveryName string - -
DeliveryStreetAddress string - -
DeliveryStreetAddress2 string - -
DeliverySuburb string - -
DeliveryCity string - -
DeliveryRegion string - -
DeliveryCountry string - -
DeliveryPostCode string - -
CurrencyGuid guid - -
ExchangeRate decimal - -
DiscountRate decimal - -
TaxGuid guid -
  • 10 Aug 2020 Foreign Key - References `Taxes` (not implemented).
TaxRate decimal - -
XeroTaxCode string - -
SubTotal decimal - -
TaxTotal decimal - -
Total decimal - -
TotalVolume decimal - -
TotalWeight decimal - -
BCSubTotal decimal - -
BCTaxTotal decimal - -
BCTotal decimal - -
PaymentDueDate datetime - -
AllocateProduct boolean - -
SalesOrderGroup string - -
DeliveryMethod string - -
SalesPersonGuid guid SalesPerson → Guid -
SendAccountingJournalOnly boolean - -
SourceID string - -
CreatedBy string - -
CreatedOn datetime - -
LastModifiedBy string - -
LastModifiedOn datetime - -

SalesOrderLine

Column Type Relates to Notes
RemoteID string - -
SalesOrderLineRemoteID string - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
Guid guid - -
LineNumber int - -
LineType string - -
ProductGuid guid Product → Guid -
DueDate datetime - -
OrderQuantity decimal - -
UnitPrice decimal - -
DiscountRate decimal - -
LineTotal decimal - -
Volume decimal - -
Weight decimal - -
Comments string - -
AverageLandedPriceAtTimeOfSale decimal -
  • 21 May 2020 The documentation does not mention this field, however if you request JSON result format AND the sales order has a shipment, then this is provided instead of UnitCost
UnitCost decimal -
  • 21 May 2020 Note that if you request a JSON result format AND the sales order has a shipment, then this is replaced with the AverageLandedPriceAtTimeOfSale field
UnitCostOrAverageLandedPriceAtTimeOfSale decimal - -
TaxRate decimal - -
TaxLine decimal - -
XeroTaxCode string - -
BCUnitPrice decimal - -
BCLineTotal decimal - -
BCLineTax decimal - -
LineTaxCode string - -
XeroSalesAccount string - -
LastModifiedOn datetime - -

Supplier

Documentation: https://apidocs.unleashedsoftware.com/Suppliers

Column Type Relates to Notes
RemoteID string - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
Guid guid - -
LastModifiedOn datetime - -
LastModifiedBy string - -
CreatedOn datetime - -
CreatedBy string - -
SupplierCode string - -
SupplierName string - -
GSTVATNumber string - -
BankName string - -
BankBranch string - -
BankAccount string - -
Website string - -
PhoneNumber string - -
FaxNumber string - -
MobileNumber string - -
DDINumber string - -
TollFreeNumber string - -
Email string - -
CurrencyGuid guid - -
CurrencyCode string - -
Notes string - -
Taxable boolean - -
XeroContactID string - -

StockOnHand

Documentation: https://apidocs.unleashedsoftware.com/StockOnHand

Column Type Relates to Notes
RemoteID string - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
LastModifiedOn datetime - -
ProductGuid guid Product → Guid -
DaysSinceLastSale decimal - -
OnPurchase decimal - -
AllocatedQty decimal - -
AvailableQty decimal - -
QtyOnHand decimal - -
AvgCost decimal - -
TotalCost decimal - -

Warehouse

Documentation: https://apidocs.unleashedsoftware.com/Warehouses

Column Type Relates to Notes
RemoteID string - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
WarehouseCode string - -
WarehouseName string - -
IsDefault boolean - -
StreetNo string - -
AddressLine1 string - -
AddressLine2 string - -
City string - -
Region string - -
Country string - -
PostCode string - -
PhoneNumber string - -
FaxNumber string - -
MobileNumber string - -
DDINumber string - -
ContactName string - -
Obsolete boolean - -
Guid guid - -
LastModifiedOn datetime - -

Assembly

Documentation: https://apidocs.unleashedsoftware.com/Assemblies

Column Type Relates to Notes
RemoteID string - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
Guid guid - -
AssemblyNumber string - -
AssemblyDate datetime - -
AssemblyType string - -
AssemblyStatus string - -
AutoAssembly boolean - -
Quantity decimal - -
Comments string - -
CanAssembleQuantity decimal - -
ProductGuid guid Product → Guid -
SourceWarehouseGuid guid Warehouse → Guid -
DestinationWarehouseGuid guid Warehouse → Guid -
Total decimal - -
TotalCost decimal - -
DisassembleCostTotal decimal - -
SupplierCostsTax decimal - -
SupplierCostsSubTotal decimal - -
LastModifiedBy string -
  • 29 Jul 2020 Email address of user
CreatedBy string -
  • 29 Jul 2020 Email address of user
CreatedOn datetime - -
LastModifiedOn datetime - -

AssemblyLine

Column Type Relates to Notes
RemoteID string - -
AssemblyLineRemoteID string - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ProductGuid guid Product → Guid -
AssemblyGuid guid - -
LineNumber int - -
Quantity decimal - -
DisassembleCost decimal - -
WastageQuantity decimal - -
UnitCost decimal - -
TotalCost decimal - -
LastModifiedOn datetime - -
SubAssemblyGuid guid - -

SupplierCost

Column Type Relates to Notes
RemoteID string - -
SupplierCostRemoteID string - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
AssemblyGuid guid Assembly → Guid -
LineNumber int - -
SupplierGuid guid Supplier → Guid -
Cost decimal - -
CostDate datetime - -
LastModifiedOn datetime - -
Reference string - -
ExchangeRate decimal - -
TaxLine decimal - -
Comment string - -
CurrencyGuid guid - -

BatchNumber

Documentation: https://apidocs.unleashedsoftware.com/BatchNumbers

Column Type Relates to Notes
RemoteID string - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
Guid guid - -
Number string - -
ExpiryDate datetime - -
Quantity decimal - -
OriginalQty decimal - -
ProductCode string - -
WarehouseCode string - -
Status string - -
LastModifiedBy string - -
CreatedBy string - -
CreatedOn datetime - -
LastModifiedOn datetime - -

SalesQuote

Documentation: https://apidocs.unleashedsoftware.com/SalesQuotes

Column Type Relates to Notes
RemoteID string - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
Guid guid - -
QuoteNumber string - -
QuoteDate datetime - -
QuoteExpiryDate datetime - -
AcceptedDate datetime - -
QuoteStatus string - -
CustomerGuid guid Customer → Guid -
CustomerRef string - -
Comments string - -
WarehouseGuid guid Warehouse → Guid -
DeliveryName string - -
DeliveryStreetAddress string - -
DeliveryStreetAddress2 string - -
DeliverySuburb string - -
DeliveryCity string - -
DeliveryRegion string - -
DeliveryCountry string - -
DeliveryPostCode string - -
CurrencyGuid guid - -
ExchangeRate decimal - -
DiscountRate decimal - -
TaxGuid guid -
  • 10 Aug 2020 Foreign Key - References `Taxes` (not implemented).
TaxRate decimal - -
XeroTaxCode string - -
SubTotal decimal - -
TaxTotal decimal - -
Total decimal - -
TotalVolume decimal - -
TotalWeight decimal - -
BCSubTotal decimal - -
BCTaxTotal decimal - -
BCTotal decimal - -
SalesOrderGroup string - -
DeliveryMethod string - -
SalesPersonGuid guid SalesPerson → Guid -
SourceID string - -
CreatedBy string - -
CreatedOn datetime - -
LastModifiedBy string - -
LastModifiedOn datetime - -

SalesQuoteLine

Column Type Relates to Notes
RemoteID string - -
SalesQuoteLineRemoteID string - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
Guid guid - -
SalesQuoteGuid guid SalesQuote → Guid -
LineNumber int - -
LineType string - -
ProductGuid guid Product → Guid -
QuoteQuantity decimal - -
UnitPrice decimal - -
DiscountRate decimal - -
LineTotal decimal - -
Volume decimal - -
Weight decimal - -
Comments string - -
UnitCost decimal - -
TaxRate decimal - -
LineTax decimal - -
XeroTaxCode string - -
BCUnitPrice decimal - -
BCLineTotal decimal - -
BCLineTax decimal - -
LineTaxCode string - -
XeroSalesAccount string - -
LastModifiedOn datetime - -

CustomerType

Documentation: https://apidocs.unleashedsoftware.com/CustomerTypes

Column Type Relates to Notes
RemoteID string - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
Guid guid - -
LastModifiedOn datetime - -
TypeName string - -

BillOfMaterials

Documentation: https://apidocs.unleashedsoftware.com/BillOfMaterials

Column Type Relates to Notes
RemoteID string - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
Guid guid - -
BillNumber string - -
CanAutoAssemble boolean - -
CanAutoDisassemble boolean - -
SortByProductCode boolean - -
TotalCost decimal - -
Obsolete boolean - -
CreatedOn datetime - -
CreatedBy string - -
LastModifiedBy string - -
AssemblyLayoutID string - -
LastModifiedOn datetime - -
ProductGuid guid Product → Guid -

BillOfMaterialsLine

Column Type Relates to Notes
RemoteID string - -
BillOfMaterialsLineRemoteID string - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
Guid guid - -
BillOfMaterialsGuid guid - -
LineNumber int - -
ProductGuid guid Product → Guid -
Quantity decimal - -
WastageQuantity decimal - -
LineTotalCost decimal - -
UnitCost decimal - -
SubBillOfMaterialGuid guid - -
ExpenseAccount string - -
CreatedOn datetime - -
CreatedBy string - -
LastModifiedBy string - -
LastModifiedOn datetime - -

WarehouseStockOnHand

Column Type Relates to Notes
RemoteID string - -
WarehouseStockOnHandRemoteID string - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ProductGuid guid Product → Guid -
WarehouseID guid Warehouse → Guid
  • 17 Nov 2020 known bug We have observed Unleashed sending empty warehouses down (Guid is empty string, Quantity is 0). Thus we need to make this null simply so it will parse
AvailableQty decimal - -

StockAdjustment

Documentation: https://apidocs.unleashedsoftware.com/StockAdjustments

Column Type Relates to Notes
RemoteID string - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
Guid guid - -
AccountCode string - -
AdjustmentDate datetime - -
AdjustmentNumber string - -
AdjustmentReason string - -
ConfirmedBy string - -
ConfirmedOn datetime - -
CreatedBy string - -
CreatedOn datetime - -
LastModifiedBy string - -
LastModifiedOn datetime - -
Status string - -
WarehouseGuid guid - -

StockAdjustmentLine

Column Type Relates to Notes
RemoteID string - -
StockAdjustmentLineRemoteID string - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
Guid guid - -
StockAdjustmentGuid guid StockAdjustment → Guid -
Comments string - -
LastModifiedOn datetime - -
LineNumber int - -
NewActualValue decimal - -
NewQuantity decimal - -
ProductGuid guid - -

StockAdjustmentLineSerialNumber

Column Type Relates to Notes
RemoteID string - -
StockAdjustmentLineSerialNumberRemoteID string - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
Guid guid - -
SerialNumberGuid guid SerialNumber → Guid -
StockAdjustmentLineGuid guid StockAdjustmentLine → Guid -

StockAdjustmentLineBatchNumber

Column Type Relates to Notes
RemoteID string - -
StockAdjustmentLineBatchNumberRemoteID string - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
Guid guid - -
BatchNumberGuid guid BatchNumber → Guid -
StockAdjustmentLineGuid guid StockAdjustmentLine → Guid -

UnitOfMeasure

Documentation: https://apidocs.unleashedsoftware.com/UnitOfMeasures

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

Tax

Documentation: https://apidocs.unleashedsoftware.com/Taxes

Column Type Relates to Notes
RemoteID string - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
Description string - -
Guid guid - -
TaxCode string - -
TaxRate decimal - -
CanApplyToExpenses boolean - -
CanApplyToRevenue boolean - -
Obsolete boolean - -
LastModifiedOn datetime - -

SellPriceTier

Documentation: https://apidocs.unleashedsoftware.com/SellPriceTiers

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

SalesOrderGroup

Documentation: https://apidocs.unleashedsoftware.com/SalesOrderGroups

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

SalesPerson

Documentation: https://apidocs.unleashedsoftware.com/SalesPersons

Column Type Relates to Notes
RemoteID string - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
Guid guid - -
FullName string - -
Email string - -
Obsolete boolean - -
LastModifiedOn datetime - -

SalesShipment

Documentation: https://apidocs.unleashedsoftware.com/SalesShipments

Column Type Relates to Notes
RemoteID string - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
Guid guid - -
OrderNumber string - -
OrderGuid guid SalesOrder → Guid -
ShipmentNumber string - -
ShipmentStatus string - -
DispatchDate datetime - -
TrackingNumber string - -
ShippingCompanyGuid guid ShippingCompany → Guid -
Comments string - -
CreatedOn datetime - -
CreatedBy string - -
LastModifiedBy string - -
LastModifiedOn datetime - -

SalesShipmentLine

Column Type Relates to Notes
RemoteID string - -
SalesShipmentLineRemoteID string - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
Guid guid - -
SalesShipmentGuid guid SalesShipment → Guid -
LineNumber int - -
ProductGuid guid Product → Guid -
ShipmentQty decimal - -
UnitCost decimal - -
CreatedOn datetime - -
CreatedBy string - -
LastModifiedBy string - -
SalesOrderLineNumber int - -
SalesOrderLineID int - -
LastModifiedOn datetime - -

SalesShipmentLineSerialNumber

Column Type Relates to Notes
RemoteID string - -
SalesShipmentLineSerialNumberRemoteID string - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
Guid guid SerialNumber → Guid -
SerialNumberGuid guid SerialNumber → Guid -
SalesShipmentLineGuid guid SalesShipmentLine → Guid -

SalesShipmentLineBatchNumber

Column Type Relates to Notes
RemoteID string - -
SalesShipmentLineBatchNumberRemoteID string - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
Guid guid BatchNumber → Guid -
BatchNumberGuid guid BatchNumber → Guid -
SalesShipmentLineGuid guid SalesShipmentLine → Guid -

SerialNumber

Documentation: https://apidocs.unleashedsoftware.com/SerialNumbers

Column Type Relates to Notes
RemoteID string - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
Guid guid - -
ProductCode string - -
WarehouseCode string - -
Status string - -
Identifier string - -
LastModifiedBy string - -
LastModifiedOn datetime - -
CreatedBy string - -
CreatedOn datetime - -

ShippingCompany

Documentation: https://apidocs.unleashedsoftware.com/ShippingCompanies

Column Type Relates to Notes
RemoteID string - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
Name string - -
Guid guid - -
Obsolete boolean - -
CreatedBy string - -
LastModifiedOn datetime - -

DeliveryMethod

Documentation: https://apidocs.unleashedsoftware.com/DeliveryMethods

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

PaymentTerm

Documentation: https://apidocs.unleashedsoftware.com/PaymentTerms

Column Type Relates to Notes
RemoteID string - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
Guid guid - -
Obsolete boolean - -
Type string - -
Days int - -
PaymentTermDescription string - -

SupplierReturn

Documentation: https://apidocs.unleashedsoftware.com/SupplierReturns

Column Type Relates to Notes
RemoteID string - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
Guid guid - -
SupplierReturnNumber string - -
SupplierGuid guid Supplier → Guid -
PurchaseOrderGuid guid PurchaseOrder → Guid -
WarehouseGuid guid Warehouse → Guid -
CurrencyGuid guid - -
CurrencyCode string - -
CurrencyDescription string - -
Status string - -
Comments string - -
ExchangeRate decimal - -
TaxRate decimal - -
XeroTaxCode string - -
SupplierRef string - -
ReturnDate datetime - -
SubTotal decimal - -
BaseSubTotal decimal - -
TaxTotal decimal - -
Total decimal - -
BaseReturnCostTaxTotal decimal - -
BaseReturnCostTotal decimal - -
BaseTaxTotal decimal - -
BaseTotal decimal - -
CreatedOn datetime - -
CreatedBy string - -
LastModifiedBy string - -
LastModifiedOn datetime - -

SupplierReturnLine

Column Type Relates to Notes
RemoteID string - -
SupplierReturnLineRemoteID string - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
Guid guid - -
SupplierReturnGuid guid SupplierReturn → Guid -
AverageLandedPriceAfterReturn decimal - -
AverageLandedPriceBeforeReturn decimal - -
Comments string - -
LineNumber int - -
LineTax decimal - -
OriginalOrderLineID int - -
ProductID int - -
ReturnCost decimal - -
ReturnPrice decimal - -
ReturnQuantity decimal - -
ReturnToSupplier boolean - -
StockOnHandBeforeReturn decimal - -
TaxID int - -
TaxRate decimal - -
XeroCostOfGoodsAccount string - -
XeroSalesAccount string - -
XeroTaxCode string - -
ProductGuid guid Product → Guid -
ReturnReason string - -
OrderPrice decimal - -
OrderQuantity decimal - -
PurchaseOrderNumber string - -
InvoiceDate datetime - -
RequiredDate datetime - -

SalesInvoice

Documentation: https://apidocs.unleashedsoftware.com/Invoices

Column Type Relates to Notes
RemoteID string - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
Guid guid - -
InvoiceNumber string - -
OrderNumber string - -
QuoteNumber string - -
InvoiceDate datetime - -
DueDate datetime - -
InvoiceStatus string - -
CustomerGuid guid Customer → Guid -
Comments string - -
DeliveryAddressAddressType string - -
DeliveryAddressAddressName string - -
DeliveryAddressStreetAddress string - -
DeliveryAddressStreetAddress2 string - -
DeliveryAddressSuburb string - -
DeliveryAddressCity string - -
DeliveryAddressRegion string - -
DeliveryAddressCountry string - -
DeliveryAddressPostalCode string - -
DeliveryAddressIsDefault boolean - -
PostalAddressAddressType string - -
PostalAddressAddressName string - -
PostalAddressStreetAddress string - -
PostalAddressStreetAddress2 string - -
PostalAddressSuburb string - -
PostalAddressCity string - -
PostalAddressRegion string - -
PostalAddressCountry string - -
PostalAddressPostalCode string - -
PostalAddressIsDefault boolean - -
DeliveryInstruction string - -
SubTotal decimal - -
TaxTotal decimal - -
Total decimal - -
BCSubTotal decimal - -
BCTaxTotal decimal - -
BCTotal decimal - -
CreatedBy string - -
PaymentTerm string - -
LastModifiedOn datetime - -

SalesInvoiceLine

Column Type Relates to Notes
RemoteID string - -
SalesInvoiceLineRemoteID string - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
Guid guid - -
SalesInvoiceGuid guid SalesInvoice → Guid -
LineNumber int - -
LineType string - -
ProductGuid guid Product → Guid -
OrderQuantity decimal - -
InvoiceQuantity decimal - -
UnitPrice decimal - -
DiscountRate decimal - -
LineTotal decimal - -
Comments string - -
TaxRate decimal - -
LineTax decimal - -
BCUnitPrice decimal - -
LastModifiedOn datetime - -

SalesInvoiceLineSerialNumber

Column Type Relates to Notes
RemoteID string - -
SalesInvoiceLineSerialNumberRemoteID string - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
Guid guid - -
SerialNumberGuid guid - -
SalesInvoiceLineGuid guid - -

SalesInvoiceLineBatchNumber

Column Type Relates to Notes
RemoteID string - -
SalesInvoiceLineBatchNumberRemoteID string - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
Guid guid BatchNumber → Guid -
BatchNumberGuid guid BatchNumber → Guid -
SalesInvoiceLineGuid guid - -

WarehouseStockTransfer

Documentation: https://apidocs.unleashedsoftware.com/WarehouseStockTransfers

Column Type Relates to Notes
RemoteID string -
  • 7 Sep 2020 Inconsistent with the rest of the API, to get the single-item we need to use `TransferOrderNumber` instead of `Guid`.
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
Guid guid - -
TransferOrderNumber string - -
OrderDate datetime - -
SourceWarehouseGuid guid Warehouse → Guid -
DestinationWarehouseGuid guid Warehouse → Guid -
DeliveryDate datetime - -
TransferStatus string - -
Comments string - -
CreatedOn datetime - -
CreatedBy string - -
LastModifiedBy string - -
LastModifiedOn datetime - -

WarehouseStockTransferLine

Column Type Relates to Notes
RemoteID string - -
WarehouseStockTransferLineRemoteID string - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
Guid guid - -
WarehouseStockTransferGuid guid WarehouseStockTransfer → Guid -
TransferOrderID int - -
LineNumber int - -
SourceWarehouseID int - -
WarehouseProductID int - -
WarehouseLocationID int - -
DestinationWarehouseID int - -
DestinationWarehouseLocationID int - -
ReceiptFIFODate datetime - -
BatchNumber string - -
ExpiryDate datetime - -
AvailableQuantity decimal - -
TransferQuantity decimal - -
Comments string - -
AverageLandedPriceAtTimeOfTransfer decimal - -
SourceWarehouseStockOnHandBeforeTransfer decimal - -
DestinateWarehouseStockOnHandBeforeTransfer decimal - -
WarehouseProductCode string - -
ProductGuid guid Product → Guid -
CreatedOn datetime - -
CreatedBy string - -
LastModifiedBy string - -
LastModifiedOn datetime - -

Need more?

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