API Reference
Knowledge Base

Create a purchase order

post
https://api.katanamrp.com/v1/purchase_orders

Creates a new purchase order object. The order, its rows and their traceability are created together: when a row or traceability entry is refused, no order is created.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

new purchase order details

string
string
enum
Allowed:
integer
required
≤ 2147483647
string

E.g. USD, EUR. All currently active currency codes in ISO 4217 format.

string
enum
Allowed:
string
string
integer
required
≤ 2147483647
integer
≤ 2147483647

Submittable only when entity_type is outsourced

string
purchase_order_rows
array of objects
required
length ≥ 1
purchase_order_rows*
number
required
≤ 100000000000000000
integer
required
≤ 2147483647
integer
≤ 2147483647
number
required
0 to 100000000000000000
number
0 to 100000000000000000
string
length ≤ 7
string
traceability
array of objects

Batch, serial number and bin location breakdown pre-assigned to the row quantity, in the purchase unit of the row. Omit it or send [] to leave the row untraced.

traceability
custom_fields
object | null

During the beta, available when the account turns on Custom fields in Katana Labs. Custom field values keyed by custom field definition ID (UUID) of a definition with entity_type PurchaseOrderRow or OutsourcedPurchaseOrderRow. Each value matches the definition’s field_type — string for shortText/url, number for number, boolean for boolean, YYYY-MM-DD string for date, or the integer choice id for singleSelect. Unknown definition IDs are rejected with a 422.

custom_fields
object | null

During the beta, available when the account turns on Custom fields in Katana Labs. Custom field values keyed by custom field definition ID (UUID) of a definition with entity_type PurchaseOrder or OutsourcedPurchaseOrder. Each value matches the definition’s field_type — string for shortText/url, number for number, boolean for boolean, YYYY-MM-DD string for date, or the integer choice id for singleSelect. Unknown definition IDs are rejected with a 422.

Responses

Updated 6 months ago

Did this page help you?
Language
Credentials
Bearer
LoadingLoading…
Response
Choose an example:
application/json

Updated 6 months ago

Did this page help you?