Explore the Unleashed API data model

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

Free trial Book a demo

Pulling data from the Unleashed API 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 sync your Unleashed API 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.

What can you do with your Unleashed data?

Connect your AI chatbots & agentic workflows

Our Universal MCP Server lets you query your Unleashed data using Claude, ChatGPT or your favourite AI tool.

Empower your BI dashboards

Our Unleashed Connector connects your Unleashed data to favourite reporting tools.

Your business runs on more than just Unleashed

We connect to over over 70+ cloud services, letting you manage the data needs of your entire business in a single location.

Endpoints

Browse the data model below, or if you'd prefer, we also have an interactive ERD over here.

Assembly

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

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
Guid guid - -
CreatedOn datetime - -
LastModifiedOn datetime - -
AssemblyNumber string - -
AssemblyDate datetime - -
AssembleBy datetime - -
AssemblyType string - -
AssemblyStatus string - -
AutoAssembly boolean - -
Quantity decimal - -
Comments string - -
CanAssembleQuantity decimal - -
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
ProductGuid guid Product → Guid -
SourceWarehouseGuid guid Warehouse → Guid -
DestinationWarehouseGuid guid Warehouse → Guid -

AttributeSet

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

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

BatchNumber

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

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

BillOfMaterials

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

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

Company

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

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

Currency

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

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
Description string - -
Guid guid - -
LastModifiedOn datetime - -
CurrencyCode string - -
DefaultBuyRate decimal - -
DefaultSellRate decimal - -

Customer

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

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
Guid guid - -
CreatedOn datetime - -
LastModifiedOn datetime - -
Obsolete boolean - -
CustomerName string - -
TaxCode string - -
TaxRate decimal - -
CustomerCode 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 - -
SalesPersonGuid guid SalesPerson → Guid -
Notes string - -
Taxable boolean - -
XeroContactID string - -
DiscountRate decimal - -
PrintPackingSlipInsteadOfInvoice boolean - -
PrintInvoice boolean - -
StopCredit boolean - -
XeroSalesAccount string - -
XeroCostOfGoodsAccount string - -
SellPriceTier string - -
CustomerType string - -
PaymentTerm string - -
ContactFirstName string - -
ContactLastName string - -
SourceID string - -
CreatedBy string - -
LastModifiedBy string - -
SalesOrderGroup string - -

CustomerType

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

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

DeliveryMethod

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

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

PaymentTerm

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

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

Product

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

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
Guid guid - -
CreatedOn datetime - -
LastModifiedOn datetime - -
ProductCode string - -
ProductBrandGuid guid ProductBrand → Guid -
ProductDescription string - -
Barcode string - -
PackSize decimal - -
Width decimal - -
Height decimal - -
Depth decimal - -
Weight decimal - -
MinStockAlertLevel decimal - -
MaxStockAlertLevel decimal - -
ReOrderPoint decimal - -
NeverDiminishing boolean - -
LastCost decimal - -
DefaultPurchasePrice decimal - -
DefaultSellPrice decimal - -
CustomerSellPrice decimal - -
AverageLandPrice decimal - -
Obsolete boolean - -
Notes string - -
ImageUrl string - -
XeroTaxCode string - -
XeroTaxRate decimal - -
TaxablePurchase boolean - -
TaxableSales boolean - -
XeroSalesTaxCode string - -
XeroSalesTaxRate decimal - -
IsComponent boolean - -
IsAssembledProduct string - -
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 - -
CommerceCode string - -
CustomsDescription string - -
ICCCountryCode string - -
ICCCountryName string - -
SupplementaryClassificationAbbreviation string - -
SourceID string - -
SourceVariantParentID string - -
IsSerialized boolean - -
IsBatchTracked boolean - -
IsSellable boolean - -
MinimumSellPrice decimal - -
MinimumSaleQuantity decimal - -
MinimumOrderQuantity decimal - -
CreatedBy string - -
LastModifiedBy 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 - -
SupplierGuid guid Supplier → Guid -
SupplierProductCode string - -
SupplierProductPrice decimal - -
SupplierProductDescription string - -
SupplierLeadTimeDays decimal - -
SupplierMinimumOrderQuantity decimal - -
SupplierUnitOfMeasureGuid guid UnitOfMeasure → Guid -
ProductGroupGuid guid ProductGroup → Guid -
ProductSubGroupGuid guid ProductGroup → Guid -
UnitOfMeasureGuid guid UnitOfMeasure → Guid -
AttributeSetGuid guid AttributeSet → Guid -

ProductBrand

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

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

ProductGroup

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

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

ProductPrice

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

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

PurchaseOrder

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

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

SalesInvoice

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

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
Guid guid - -
LastModifiedOn datetime - -
InvoiceStatus string - -
InvoiceNumber string - -
InvoiceDate datetime -
  • 21 May 2025 Unusually for invoice dates, this appears to be stored in UTC time, not local time
DueDate datetime - -
CustomerGuid guid Customer → Guid -
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 - -
OrderNumber string - -
QuoteNumber string - -
Comments string - -
DeliveryInstruction string - -
SubTotal decimal - -
TaxTotal decimal - -
Total decimal - -
BCSubTotal decimal - -
BCTaxTotal decimal - -
BCTotal decimal - -
CreatedBy string - -
PaymentTerm string - -

SalesOrder

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

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

SalesOrderGroup

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

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
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 - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
Guid guid - -
LastModifiedOn datetime - -
Obsolete boolean - -
FullName string - -
Email string - -

SalesQuote

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

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

SalesShipment

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

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

SellPriceTier

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

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

SerialNumber

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

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

ShippingCompany

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

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

StockAdjustment

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

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

StockCount

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

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
Description string - -
Guid guid - -
LastModifiedOn datetime - -
Status string - -
StockTakeName string - -
WarehouseGuid guid Warehouse → Guid -
CompletedDate datetime - -
CountDate datetime - -
CostOfGoodsAccount string - -
CountType string - -
StockTakeCode string - -

StockOnHand

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

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

WarehouseStockOnHand

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

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

Supplier

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

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

SupplierReturn

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

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

Tax

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

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

UnitOfMeasure

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

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

Warehouse

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

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
Guid guid - -
LastModifiedOn datetime - -
Obsolete boolean - -
WarehouseName string - -
WarehouseCode 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 - -

WarehouseStockTransfer

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

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
TransferOrderNumber string - -
CreatedOn datetime - -
LastModifiedOn datetime - -
TransferStatus string - -
Guid guid - -
OrderDate datetime - -
DeliveryDate datetime - -
SourceWarehouseGuid guid Warehouse → Guid -
DestinationWarehouseGuid guid Warehouse → Guid -
Comments string - -
CreatedBy string - -
LastModifiedBy string - -

SupplierCost

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

AssemblyLine

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

Attribute

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

BillOfMaterialsLine

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

CreditNoteLine

Column Type Relates to Notes
RemoteID string - -
CreditNoteRemoteID string CreditNote → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
CreditNoteGuid guid CreditNote → Guid -
LineNumber int - -
LastModifiedOn datetime - -
LineType string - -
LineTaxCode string - -
XeroSalesAccount string - -
XeroTaxCode string - -
OrderQuantity decimal - -
CreditQuantity decimal - -
CreditPrice decimal - -
LineTotal decimal - -
TaxRate decimal - -
LineTax decimal - -
Reason string - -
CostOfGoodsAccount string - -
AverageLandedPriceAtTimeOfSale decimal - -
BCLineTax decimal - -
BCLineTotal decimal - -
Disassemble boolean - -
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
Comments string - -
ProductGuid guid Product → Guid -

CustomerContact

Column Type Relates to Notes
RemoteID string - -
CustomerRemoteID string Customer → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
Guid guid - -
CustomerGuid guid Customer → Guid -
ForInvoicing boolean - -
ForShipping boolean - -
ForOrdering boolean - -
IsDefault boolean - -
DDINumber string - -
EmailAddress string - -
FaxNumber string - -
FirstName string - -
LastName string - -
MobilePhone string - -
Notes string - -
OfficePhone string - -
PhoneNumber string - -
TollFreeNumber string - -
Website string - -
DeliveryAddress string - -

CustomerAddress

Column Type Relates to Notes
RemoteID string - -
CustomerRemoteID string Customer → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
CustomerGuid guid Customer → Guid -
StreetAddress string - -
StreetAddress2 string - -
Suburb string - -
AddressType string - -
AddressName string - -
City string - -
Region string - -
Country string - -
PostalCode string - -
IsDefault boolean - -
DeliveryInstruction string - -

ProductAlternateUnitOfMeasure

Column Type Relates to Notes
RemoteID string - -
ProductRemoteID string Product → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ProductGuid guid Product → Guid -
Guid guid UnitOfMeasure → Guid -
ConversionRate decimal - -
ForPurchases boolean - -
Barcode string - -
PackSize decimal - -
Weight decimal - -
Width decimal - -
Height decimal - -
Depth decimal - -
CubicTotal decimal - -

ProductLocation

Column Type Relates to Notes
RemoteID string - -
ProductRemoteID string Product → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
WarehouseGuid guid Warehouse → Guid -
ProductGuid guid Product → Guid -
BinLocation string - -
WarehouseMinStockAlertLevel decimal - -
WarehouseMaxStockAlertLevel decimal - -

ProductAttributeValue

Column Type Relates to Notes
RemoteID string - -
ProductRemoteID string Product → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ProductGuid guid Product → Guid -
AttributeGuid guid Attribute → Guid -
Value string - -

PurchaseOrderCostLine

Column Type Relates to Notes
RemoteID string - -
PurchaseOrderRemoteID string PurchaseOrder → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
PurchaseOrderGuid guid PurchaseOrder → Guid -
LineNumber int - -
CostDate datetime - -
SupplierGuid guid Supplier → Guid -
BCCost decimal - -
BCTaxCost decimal - -
BCTotalCost decimal - -
Cost decimal - -
CostExchangeRate decimal - -
DistributionMethod string - -
OrderExchangeRate decimal - -
Reference string - -
TaxCost decimal - -
TaxRate decimal - -
TaxCode string - -
TotalCost decimal - -
Currency string - -
Receipted boolean - -

PurchaseOrderLine

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

PurchaseOrderSalesOrder

Column Type Relates to Notes
RemoteID string - -
PurchaseOrderRemoteID string PurchaseOrder → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
SalesOrderGuid guid SalesOrder → Guid -
PurchaseOrderGuid guid PurchaseOrder → Guid -

SalesInvoiceLine

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

SalesOrderLine

Column Type Relates to Notes
RemoteID string - -
SalesOrderRemoteID string SalesOrder → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
Guid guid - -
LastModifiedOn datetime - -
DueDate datetime - -
ProductGuid guid Product → Guid -
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 - -
LineNumber int - -
LineType string - -
OrderQuantity decimal - -
UnitPrice decimal - -
DiscountRate decimal - -
LineTotal decimal - -
Volume decimal - -
Weight decimal - -
Comments string - -
TaxRate decimal - -
TaxLine decimal - -
XeroTaxCode string - -
BCUnitPrice decimal - -
BCLineTotal decimal - -
BCLineTax decimal - -
LineTaxCode string - -
XeroSalesAccount string - -

SalesQuoteLine

Column Type Relates to Notes
RemoteID string - -
SalesQuoteRemoteID string SalesQuote → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
Guid guid - -
LastModifiedOn datetime - -
SalesQuoteGuid guid SalesQuote → Guid -
ProductGuid guid Product → Guid -
LineNumber int - -
LineType string - -
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 - -

SalesShipmentLine

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

StockAdjustmentLine

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

StockCountLine

Column Type Relates to Notes
RemoteID string - -
StockCountRemoteID string StockCount → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
StockCountGuid guid StockCount → Guid -
Guid guid -
  • 9 Feb 2024 The Guid property often comes down as an empty Guid, suggesting it is either not a unique identifier for the line item, or there is a bug in the Unleashed API
ProductGuid guid Product → Guid -
ExpiryDate datetime - -
ReceiptFIFODate datetime - -
LastModifiedOn datetime - -
LineNumber int - -
AvailableQuantity decimal - -
AverageLandPriceAtTimeOfStockTake decimal - -
CountQuantity decimal - -
OnHandQuantity decimal - -

SupplierReturnLine

Column Type Relates to Notes
RemoteID string - -
SupplierReturnRemoteID string SupplierReturn → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
Guid guid - -
SupplierReturnGuid guid SupplierReturn → Guid -
InvoiceDate datetime - -
RequiredDate datetime - -
ProductGuid guid Product → 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 - -
ReturnReason string - -
OrderPrice decimal - -
OrderQuantity decimal - -
PurchaseOrderNumber string - -

WarehouseStockTransferLine

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

SalesInvoiceLineSerialNumber

Column Type Relates to Notes
RemoteID string - -
SalesInvoiceLineRemoteID string SalesInvoiceLine → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
Guid guid SerialNumber → Guid -
SerialNumberGuid guid SerialNumber → Guid -
SalesInvoiceLineGuid guid SalesInvoiceLine → Guid -

SalesInvoiceLineBatchNumber

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

SalesShipmentLineBatchNumber

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

SalesShipmentLineSerialNumber

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

StockAdjustmentLineSerialNumber

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

StockAdjustmentLineBatchNumber

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

Need more?

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

Connect your own Unleashed data Querying Unleashed using regular SQL