Explore the Kounta data model

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

Background

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

Category

Documentation: https://apidoc.kounta.com/categories/#get-all-categories

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

Customer

Documentation: https://apidoc.kounta.com/customers/#get-all-customers

Column Type Relates to Notes
RemoteID string - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
Name string - -
CreatedAt datetime - -
UpdatedAt datetime - -
Phone string - -
Address string - -
City string - -
State string - -
PostalCode string - -
Country string - -
FirstName string - -
LastName string - -
PrimaryEmailAddress string - -
Image string - -
Email string - -
AvatarURL string - -
FullName string - -

CustomerTag

Column Type Relates to Notes
RemoteID string - -
CustomerTagRemoteID string - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
CustomerID int Customer → ID -
TagName string - -

StaffMember

Documentation: https://apidoc.kounta.com/staff/#get-a-staff-member

Column Type Relates to Notes
RemoteID string - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
Name string - -
CreatedAt datetime - -
UpdatedAt datetime - -
Fax string - -
Code string - -
PinRotationDays int - -
Mobile string - -
IsAdmin boolean - -
Address string - -
City string - -
State string - -
PostalCode string - -
Country string - -
FirstName string - -
LastName string - -
PrimaryEmailAddress string - -
Image string - -
Email string - -
AvatarURL string - -
FullName string - -

Inventory

Documentation: https://apidoc.kounta.com/inventory/

Column Type Relates to Notes
RemoteID string - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime -
  • 19 May 2020 Inventory is a snapshot in time, so it is fair to stamp this with the current timestamp
WhenModified datetime -
  • 19 May 2020 Inventory is a snapshot in time, so it is fair to stamp this with the current timestamp
ID int - -
ProductID int - -
Stock decimal - -
SiteID int Site → ID -

OrderItemModifier

Column Type Relates to Notes
RemoteID string - -
OrderItemModifierRemoteID string - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
IsAddedToOrder boolean - -
IsRemovedFromOrder boolean - -
ProductID int Product → ID -
OrderItemID string OrderItem → RemoteID -

Order

Documentation: https://apidoc.kounta.com/orders/#get-an-order

Column Type Relates to Notes
RemoteID string - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
Notes string - -
Status string - -
SiteID int Site → ID -
RegisterID int Register → ID -
Total decimal - -
Tips decimal - -
TotalTax decimal - -
CreatedAt datetime - -
StaffMemberID int StaffMember → ID -
SaleNumber string - -
PriceVariation decimal - -
RefundedOrderID string - -
Deleted boolean - -
UpdatedAt datetime - -
Guests int -
  • 2 Dec 2020 Kounta only adds this property if `Guest Tracking` is enabled and if the number of guests is added against an order
OrderType string -
  • 2 Dec 2020 Kounta only adds this property if `Order Types` is enabled and if the order type is set in the order
CustomerID int Customer → ID -
Tip decimal - -
Tax decimal - -
RemoteStaffMemberID string - -
RemoteSiteID string - -
SaleID string - -
IsRefund boolean - -

OrderItem

Column Type Relates to Notes
RemoteID string - -
OrderItemRemoteID string - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
Number int - -
LineID string - -
Quantity decimal - -
Notes string - -
UnitPrice decimal - -
UnitTax decimal - -
LineTotalExTax decimal - -
LineTotalTax decimal - -
PriceVariation decimal - -
UnitPriceGross decimal - -
OrderID int Order → ID -
ProductID int Product → ID -

Payment

Documentation: https://apidoc.kounta.com/payments/

Column Type Relates to Notes
RemoteID string - -
PaymentRemoteID string - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
Number int - -
Amount decimal - -
Tip decimal - -
Reference string - -
CreatedAt datetime - -
OrderID int Order → ID -
PaymentMethodID string - -

PaymentMethod

Documentation: https://apidoc.kounta.com/payment_methods/

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

PriceList

Documentation: https://apidoc.kounta.com/price_lists/#get-a-price-list

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

Product

Documentation: https://apidoc.kounta.com/products/#get-a-product

Column Type Relates to Notes
RemoteID string - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
Name string - -
Description string - -
CreatedAt datetime - -
UpdatedAt datetime - -
VariantParentID int - -
Code string - -
FriendlyName string - -
Barcode string - -
Price decimal - -

ProductCategory

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

ProductPrice

Column Type Relates to Notes
RemoteID string - -
ProductPriceRemoteID string - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
UnitPrice decimal - -
ProductID int Product → ID -
PriceListID int PriceList → ID -

PurchaseOrder

Documentation: https://apidoc.kounta.com/purchase_orders/#get-a-purchase-order

Column Type Relates to Notes
RemoteID string - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
Status string - -
SupplierID int -
  • 26 May 2020 This seems to be pointing to a supplier id in a supplier table but there's no endpoint for suppliers in Kouanta API.
SupplierName string - -
SupplierEmail string - -
SiteID int Site → ID -
Notes string - -
PurchaseNumber string - -
SupplierInvoiceNumber string - -
Total decimal - -
TotalTax decimal - -
CreatedAt datetime - -
PlacedAt datetime - -
UpdatedAt datetime - -
DeliveredAt datetime - -
ReceivedAt datetime - -

PurchaseOrdersDetailLine

Column Type Relates to Notes
RemoteID string - -
PurchaseOrdersDetailLineRemoteID string - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
Number int - -
ProductID int Product → ID -
Format string - -
Quantity decimal - -
UnitPriceExTax decimal - -
UnitTax decimal - -
LineTotalExTax decimal - -
LineTotalTax decimal - -
PurchaseOrderID int PurchaseOrder → ID -

Reconciliation

Documentation: https://apidoc.kounta.com/reconciliations/#get-a-reconciliation

Column Type Relates to Notes
RemoteID string - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
Number int - -
Processed boolean - -
ReconciliationLevel string - -
RegisterID int Register → ID -
SiteID int Site → ID -
StaffMemberID int -
  • 23 Feb 2021 After careful testing on several accounts, we cannot find some staff member ids in our corresponding staff_member endpoint.
CreatedAt datetime - -
UpdatedAt datetime - -
GiftCardPaymentsRedeemed decimal - -
PrePaymentsOut decimal - -

ReconciliationPaymentMethod

Column Type Relates to Notes
RemoteID string - -
ReconciliationPaymentMethodRemoteID string - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
Name string - -
ReconciliationID int Reconciliation → ID -
PaymentMethodID int PaymentMethod → ID -
TakingsSalesRecorded decimal - -
TakingsSalesCounted decimal - -
TakingsAccountsRecorded decimal - -
TakingsAccountsCounted decimal - -
TakingsLaybysRecorded decimal - -
TakingsLaybysCounted decimal - -
AdjustmentsCashIn decimal - -
AdjustmentsCashOut decimal - -
AdjustmentsTips decimal - -
GiftCardsTopup decimal - -
PrePaymentsIn decimal - -

ReconciliationRevenueAccountAmount

Column Type Relates to Notes
RemoteID string - -
ReconciliationRevenueAccountAmountRemoteID string - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ParentType string - -
ParentID string - -
TaxID int -
  • 26 May 2020 Foreign Key: Refers to `Taxes` (not implemented).
Net decimal - -
Tax decimal - -

ReconciliationRevenueAccount

Column Type Relates to Notes
RemoteID string - -
ReconciliationRevenueAccountRemoteID string - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ReconciliationID int Reconciliation → ID -
ProductID int Product → ID -

ReconciliationRevenueLaybyAmount

Column Type Relates to Notes
RemoteID string - -
ReconciliationRevenueLaybyAmountRemoteID string - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ParentType string - -
ParentID string - -
TaxID int -
  • 26 May 2020 Foreign Key: Refers to `Taxes` (not implemented).
Net decimal - -
Tax decimal - -

ReconciliationRevenueLayby

Column Type Relates to Notes
RemoteID string - -
ReconciliationRevenueLaybyRemoteID string - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ReconciliationID int Reconciliation → ID -
ProductID int Product → ID -

ReconciliationRevenueSaleAmount

Column Type Relates to Notes
RemoteID string - -
ReconciliationRevenueSaleAmountRemoteID string - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ParentType string - -
ParentID string - -
TaxID int -
  • 26 May 2020 Foreign Key: Refers to `Taxes` (not implemented).
Net decimal - -
Tax decimal - -

ReconciliationRevenueSale

Column Type Relates to Notes
RemoteID string - -
ReconciliationRevenueSaleRemoteID string - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ReconciliationID int Reconciliation → ID -
ProductID int Product → ID -

Register

Documentation: https://apidoc.kounta.com/registers/#get-a-register

Column Type Relates to Notes
RemoteID string - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
Name string - -
Code string - -
SalePrefix string - -
ReturnPrefix string - -
RemoteSiteID string - -

ReportingGroup

Documentation: https://apidoc.kounta.com/reporting_groups/#get-all-reporting-groups

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

ReportingGroupProduct

Column Type Relates to Notes
RemoteID string - -
ReportingGroupProductRemoteID string - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ProductID int Product → ID -
ReportingGroupID int ReportingGroup → ID -

Site

Documentation: https://apidoc.kounta.com/sites/#get-a-site

Column Type Relates to Notes
RemoteID string - -
MirrorRemoteID int - -
TimeZone string - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
Name string - -
CreatedAt datetime - -
UpdatedAt datetime - -
Code string - -
BusinessNumber string - -
Email string - -
Mobile string - -
Phone string - -
Fax string - -
Website string - -
RegisterLevelReconciliation boolean - -

Table

Documentation: https://apidoc.kounta.com/tables/#get-all-tables-for-a-site

Column Type Relates to Notes
RemoteID string - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
Name string - -
Siteid int Site → ID -
SectionName string - -
RemoteSiteID string - -

Need more?

Why not check out our interactive Entity Relationship Diagram.