Explore the Katana API data model

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

Try our interactive ERD Or, read the docs below

Pulling data from the Katana 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 Katana 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.

Endpoints

Material

Documentation: https://developer.katanamrp.com/reference/material

Column Type Relates to Notes
RemoteID string - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID long - -
Name string - -
Uom string - -
CategoryName string - -
Type string - -
AdditionalInfo string - -
PurchaseUom string - -
PurchaseUomConversionRate decimal - -
DefaultSupplierID long Supplier → ID -
BatchTracked boolean - -
CreatedAt datetime - -
UpdatedAt datetime - -
DeletedAt datetime - -

MaterialConfig

Column Type Relates to Notes
RemoteID string - -
MaterialRemoteID string Material → RemoteID -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID long - -
Name string - -
MaterialID long Material → ID -

MaterialConfigValue

Column Type Relates to Notes
RemoteID string - -
MaterialConfigRemoteID string MaterialConfig → RemoteID -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
MaterialConfigID long MaterialConfig → ID -
Value string - -

SalesOrder

Documentation: https://developer.katanamrp.com/reference/sales-order#list-all-sales-orders

Column Type Relates to Notes
RemoteID string - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID long - -
CustomerID long Customer → ID -
OrderNo string - -
Source string - -
OrderCreatedDate datetime - -
DeliveryDate datetime - -
PickedDate datetime - -
LocationID long Location → ID -
Status string - -
Currency string - -
ConversionRate decimal - -
Total decimal - -
TotalInBaseCurrency decimal - -
ConversionDate datetime - -
ProductExpectedDate datetime - -
IngredientExpectedDate datetime - -
ProductAvailability string - -
IngredientAvailability string - -
ProductionStatus string - -
InvoicingStatus string - -
AdditionalInfo string - -
EcommerceOrderType string - -
EcommerceStoreName string - -
EcommerceOrderID string - -
CreatedAt datetime - -
UpdatedAt datetime - -
DeletedAt datetime - -

SalesOrderRow

Column Type Relates to Notes
RemoteID string - -
SalesOrderRemoteID string SalesOrder → RemoteID -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID long - -
SalesOrderID long SalesOrder → ID -
Quantity decimal - -
VariantID long Variant → ID -
TaxRateID long TaxRate → ID -
PricePerUnit decimal - -
PricePerUnitInBaseCurrency decimal - -
Total decimal - -
TotalInBaseCurrency decimal - -
CreatedAt datetime - -
UpdatedAt datetime - -
DeletedAt datetime - -

Supplier

Documentation: https://developer.katanamrp.com/reference/supplier

Column Type Relates to Notes
RemoteID string - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID long - -
Name string - -
Email string - -
Comment string - -
CreatedAt datetime - -
UpdatedAt datetime - -
DeletedAt datetime - -

TaxRate

Documentation: https://developer.katanamrp.com/reference/tax-rate

Column Type Relates to Notes
RemoteID string - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID long - -
Name string - -
Rate decimal - -
IsDefaultSales boolean - -
IsDefaultPurchases boolean - -
DisplayName string - -
CreatedAt datetime - -
UpdatedAt datetime - -
DeletedAt datetime - -

Customer

Documentation: https://developer.katanamrp.com/reference/customer

Column Type Relates to Notes
RemoteID string - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID long - -
Name string - -
Email string - -
Phone string - -
Currency string - -
Comment string - -
CreatedAt datetime - -
UpdatedAt datetime - -
DeletedAt datetime - -

Inventory

Documentation: https://developer.katanamrp.com/reference/inventory

Column Type Relates to Notes
RemoteID string - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
VariantID long Variant → ID -
LocationID long Location → ID -
ReorderPoint decimal - -
AverageCost decimal - -
ValueInStock decimal - -
QuantityInStock decimal - -
QuantityCommitted decimal - -
QuantityExpected decimal - -
QuantityMissingOrExcess decimal - -

SalesOrderRowAttribute

Column Type Relates to Notes
RemoteID string - -
SalesOrderRowRemoteID string SalesOrderRow → RemoteID -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
SalesOrderRowID long SalesOrderRow → ID -
Key string - -
Value string - -

SalesOrderRowBatchTransaction

Column Type Relates to Notes
RemoteID string - -
SalesOrderRowRemoteID string SalesOrderRow → RemoteID -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
SalesOrderRowID long SalesOrderRow → ID -
BatchID long - -
Quantity decimal - -

Location

Documentation: https://developer.katanamrp.com/reference/location

Column Type Relates to Notes
RemoteID string - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID long - -
Name string - -
LegalName string - -
AddressID long - -
IsPrimary boolean - -
SalesAllowed boolean - -
PurchaseAllowed boolean - -
ManufacturingAllowed boolean - -
CreatedAt datetime - -
UpdatedAt datetime - -
DeletedAt datetime - -

Product

Documentation: https://developer.katanamrp.com/reference/product

Column Type Relates to Notes
RemoteID string - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID long - -
Name string - -
Uom string - -
CategoryName string - -
IsProducible boolean - -
DefaultSupplierID long Supplier → ID -
IsPurchasable boolean - -
Type string - -
PurchaseUom string - -
PurchaseUomConversionRate decimal - -
BatchTracked boolean - -
AdditionalInfo string - -
CreatedAt datetime - -
UpdatedAt datetime - -
DeletedAt datetime - -

ProductConfig

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

ProductConfigValue

Column Type Relates to Notes
RemoteID string - -
ProductConfigRemoteID string ProductConfig → RemoteID -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ProductConfigID long ProductConfig → ID -
Value string - -

Variant

Documentation: https://developer.katanamrp.com/reference/variant#list-all-variants

Column Type Relates to Notes
RemoteID string - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID long - -
Sku string - -
SalesPrice decimal - -
ProductID long Product → ID -
MaterialID long Material → ID -
PurchasePrice decimal - -
Type string - -
InternalBarcode string - -
RegisteredBarcode string - -
CreatedAt datetime - -
UpdatedAt datetime - -
DeletedAt datetime - -

VariantSupplierCode

Column Type Relates to Notes
RemoteID string - -
VariantRemoteID string Variant → RemoteID -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
VariantID long Variant → ID -
Code string - -

VariantConfigValue

Column Type Relates to Notes
RemoteID string - -
VariantRemoteID string Variant → RemoteID -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
VariantID long Variant → ID -
ConfigName string - -
ConfigValue string - -

PurchaseOrder

Documentation: https://developer.katanamrp.com/reference/purchase-order#list-all-purchase-orders

Column Type Relates to Notes
RemoteID string - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID long - -
Status string - -
BillingStatus string - -
OrderNo string - -
SupplierID long Supplier → ID -
Currency string - -
ExpectedArrivalDate datetime - -
OrderCreatedDate datetime - -
AdditionalInfo string - -
LocationID long Location → ID -
Total decimal - -
CreatedAt datetime - -
UpdatedAt datetime - -
DeletedAt datetime - -

PurchaseOrderRow

Column Type Relates to Notes
RemoteID string - -
PurchaseOrderRemoteID string PurchaseOrder → RemoteID -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID long - -
PurchaseOrderID long PurchaseOrder → ID -
Quantity decimal - -
VariantID long Variant → ID -
TaxRateID long TaxRate → ID -
PricePerUnit decimal - -
Total decimal - -
PurchaseUom string - -
Currency string - -
ConversionRate decimal - -
ConversionDate datetime - -
ReceivedDate datetime - -
CreatedAt datetime - -
UpdatedAt datetime - -
DeletedAt datetime - -

StockAdjustment

Documentation: https://developer.katanamrp.com/reference/findstockadjustments

Column Type Relates to Notes
RemoteID string - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID long - -
StockAdjustmentDate string - -
LocationID long Location → ID -
StockAdjustmentNumber string - -
Reason string - -
AdditionalInfo string - -
CreatedAt datetime - -
UpdatedAt datetime - -
DeletedAt datetime - -

StockAdjustmentRow

Column Type Relates to Notes
RemoteID string - -
StockAdjustmentRemoteID string StockAdjustment → RemoteID -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID long - -
StockAdjustmentID long StockAdjustment → ID -
VariantID long Variant → ID -
Quantity decimal - -
CostPerUnit decimal - -
DeletedAt datetime - -

StockTransfer

Documentation: https://developer.katanamrp.com/reference/findstocktransfers

Column Type Relates to Notes
RemoteID string - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID long - -
TransferDate string - -
TargetLocationID long Location → ID -
SourceLocationID long Location → ID -
StockTransferNumber string - -
AdditionalInfo string - -
CreatedAt datetime - -
UpdatedAt datetime - -
DeletedAt datetime - -

StockTransferRow

Column Type Relates to Notes
RemoteID string - -
StockTransferRemoteID string StockTransfer → RemoteID -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID long - -
StockTransferID long StockTransfer → ID -
VariantID long Variant → ID -
Quantity decimal - -
CostPerUnit decimal - -

ManufacturingOrder

Documentation: https://developer.katanamrp.com/reference/getallmanufacturingorders

Column Type Relates to Notes
RemoteID string - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID long - -
Status string - -
OrderNo string - -
VariantID long Variant → ID -
PlannedQuantity decimal - -
ActualQuantity decimal - -
LocationID long Location → ID -
OrderCreatedDate datetime - -
DoneDate datetime - -
ProductionDeadlineDate datetime - -
AdditionalInfo string - -
IsLinkedToSalesOrder boolean - -
SalesOrderID long SalesOrder → ID -
SalesOrderRowID long SalesOrderRow → ID -
IngredientAvailability string - -
MaterialCost decimal - -
SubassembliesCost decimal - -
OperationsCost decimal - -
TotalCost decimal - -
TotalActualTime decimal - -
TotalPlannedTime decimal - -
CreatedAt datetime - -
UpdatedAt datetime - -
DeletedAt datetime - -

ManufacturingOrderRecipe

Documentation: https://developer.katanamrp.com/reference/getallmanufacturingorderreciperows

Column Type Relates to Notes
RemoteID string - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID long - -
ManufacturingOrderID long ManufacturingOrder → ID -
VariantID long Variant → ID -
Notes string - -
PlannedQuantityPerUnit decimal - -
TotalActualQuantity decimal - -
IngredientAvailability string - -
IngredientExpectedDate datetime - -
Cost decimal - -
CreatedAt datetime - -
UpdatedAt datetime - -
DeletedAt datetime - -

SalesOrderFulfillment

Documentation: https://developer.katanamrp.com/reference/the-sales-order-fulfillment-object

Column Type Relates to Notes
RemoteID string - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID long - -
SalesOrderID long SalesOrder → ID -
TrackingNumber string - -
TrackingUrl string - -
TrackingCarrier string - -
TrackingMethod string - -
PickedDate string - -
ConversionRate int - -
ConversionDate datetime - -
Status string - -
CreatedAt datetime - -
UpdatedAt datetime - -
DeletedAt datetime - -

SalesOrderFulfillmentRow

Column Type Relates to Notes
RemoteID string - -
SalesOrderFulfillmentRemoteID string SalesOrderFulfillment → RemoteID -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
SalesOrderFulfillmentID long SalesOrderFulfillment → ID -
SalesOrderRowID long SalesOrderRow → ID
  • 1 Dec 2022 The ID of the sales order row that is fulfilled, not the ID of the fulfillment row
Quantity decimal - -

SalesOrderFulfillmentRowBatchTransaction

Column Type Relates to Notes
RemoteID string - -
SalesOrderFulfillmentRowRemoteID string SalesOrderFulfillmentRow → RemoteID -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
BatchID long - -
Quantity decimal - -

Need more?

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

Connect your own Katana data Interactive ERD Querying Katana using regular SQL