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 |
-
|
-
|