Concepts

Concepts used in Katana BDK Book.

Katana purchase order

PurchaseOrder represents a supplier order within the Katana system, serving as a comprehensive record of all order details, receiving status, and associated metadata. It provides essential information to track and manage supplier orders throughout their lifecycle.

Field Name	Description	Type
id	Unique identifier for the object.	text
status	Status of the order.	enum[not_received, partially_received, received]
billing_status	Status of generating the bill through accounting integration.	enum[billed, not_billed, partially_billed]
last_document_status	Status of the last e-mail sent from (O)PO card.	enum[failed, not_sent, sending, sent]
order_no	A unique, identifying string used in the UI and controlled by the user.	text
entity_type	Either "regular" or "outsourced", depending on the purchase order type.	enum[outsourced, regular]
supplier_id	ID of the supplier who this order belongs to.	text
currency	Currency of the purchase order.	text
expected_arrival_date	The timestamp when the items are expected to arrive.	datetime
order_created_date	The timestamp of creating the document.	datetime
location_id	The ID of the location to which items are received.	text
total	The total value of the order (including taxes) in purchase order currency.	number
total_in_base_currency	The total value of the order (including taxes) in base currency.	number
created_at	The timestamp when the purchase order was created.	datetime
updated_at	The timestamp when the purchase order was last updated.	datetime
purchase_order_rows	An array of purchase order rows.	list of json
additional_info	Internal comments, links to external files, additional instructions.	optional[text]
ingredient_availability	Status of ingredients for outsourced purchase orders.	optional[enum[expected, in_stock, not_applicable, not_available, no_recipe, processed]?]
ingredient_expected_date	Latest date for required ingredients on outsourced orders.	optional[datetime]
tracking_location_id	Location where ingredients are processed for outsourced orders.	optional[text]

Katana sales order

SalesOrder represents a customer order within the Katana system, serving as a comprehensive record of all order details, fulfillment status, and associated metadata. It provides essential information to track and manage customer orders throughout their lifecycle.

Field Name	Description	Type
id	Unique identifier for the object.	text
customer_id	ID of the customer who this order belongs to.	text
order_no	A unique, identifying string used in the UI and controlled by the user.	text
source	Indication of whether the sales order was created manually, by API or imported from somewhere else.	text
order_created_date	The timestamp of creating the document.	datetime
delivery_date	A timestamp when the items are required to be delivered to the customer.	datetime
location_id	ID of the location from which the order is shipped by default.	text
status	Status of the order.	enum[delivered, not_shipped, packed, partially_delivered, partially_packed]
currency	Currency of the sales order.	text
conversion_rate	Currency rate used to convert from sales order currency into factory base currency.	number
conversion_date	The date of the conversion rate used.	datetime
invoicing_status	Status of generating the invoice through accounting integration.	text
total	The total value of the order (including taxes) in sales order currency.	number
total_in_base_currency	The total value of the order (including taxes) in base currency.	number
product_availability	Stock status for the products required by the sales order.	enum[expected, in_stock, not_applicable, not_available, picked]
ingredient_availability	Stock status for ingredients required to produce the products.	enum[expected, in_stock, not_applicable, not_available, no_recipe, processed]
production_status	Production status of the manufacturing order.	enum[blocked, done, in_progress, none, not_applicable, not_started]
created_at	The timestamp when the sales order was created.	datetime
updated_at	The timestamp when the sales order was last updated.	datetime
billing_address_id	The ID of the billing address of the sales order.	text
shipping_address_id	The ID of the shipping address of the sales order.	text
sales_order_rows	An array of sales order rows.	list of json
addresses	An array of shipping and billing addresses.	list of json
picked_date	The timestamp when delivery status was marked as "PACKED" or "DELIVERED".	optional[datetime]
additional_info	Internal comments, links to external files, additional instructions.	optional[text]
customer_ref	An identifier to reference the customer associated with the sales order.	optional[text]
ecommerce_order_type	Name of the ecommerce platform if imported from one.	optional[text]
ecommerce_store_name	Name of the ecommerce store if imported from ecommerce platform.	optional[text]
ecommerce_order_id	ID of the order in the source system if imported.	optional[text]
product_expected_date	Latest date of manufacturing/purchasing deadline for required products.	optional[datetime]
ingredient_expected_date	Latest date of manufacturing/purchasing deadline for required ingredients.	optional[datetime]
tracking_number	Deprecated - use tracking_number from sales order fulfillment instead.	optional[text]
tracking_number_url	Deprecated - use tracking_number_url from sales order fulfillment instead.	optional[text]

Concept attribute specifications

purchase_order_rows (katana purchase order)

Name	Type
id	text
quantity	number
variant_id	text
price_per_unit	number
purchase_uom	text
purchase_uom_conversion_rate	optional[number]
total	number
total_in_base_currency	number
conversion_rate	optional[number]
conversion_date	optional[datetime]
created_at	datetime
updated_at	datetime
tax_rate_id	optional[text]
batch_transactions	list of json
received_date	optional[datetime]
arrival_date	optional[datetime]

sales_order_rows (katana sales order)

Name	Type
id	text
quantity	number
variant_id	text
price_per_unit	number
price_per_unit_in_base_currency	number
total	number
total_in_base_currency	number
conversion_rate	text
conversion_date	optional[datetime]
created_at	datetime
updated_at	datetime
tax_rate_id	optional[text]
location_id	optional[text]
product_availability	enum[expected, in_stock, not_applicable, not_available, picked]
product_expected_date	optional[datetime]
cogs_value	optional[number]
attributes	list of json
batch_transactions	list of json
serial_numbers	list of text
linked_manufacturing_order_id	optional[text]

addresses (katana sales order)

Name	Type
id	text
sales_order_id	text
entity_type	enum[billing, shipping]
line_1	text
city	text
zip	text
country	text
created_at	datetime
updated_at	datetime
first_name	optional[text]
last_name	optional[text]
company	optional[text]
phone	optional[text]
line_2	optional[text]
state	optional[text]