CRM · Selling
Sales Orders
Read and maintain sales orders records (crm.sales_orders).
/api/crm/sales-ordersPublished as /api/v1/sales-ordersOverview
| Package | CRM |
|---|---|
| Authentication | Bearer token: a service account's token (POST /api/auth/service-token) or, for the published path, an API key |
| Authorization | The caller's roles must hold CRM › Sales Orders on the Roles screen: display for GET, add for POST, change for PUT, delete for DELETE; an action needs the grant of the button that runs it on the screen. |
| Table | crm.sales_orders · kept per company (and organisational unit where it has one) |
| Record | Created, changed and (where the screen allows) deleted; key id |
| Rules | The same as the screen: validation, numbering, approvals, posting, the company the caller belongs to, and the audit trail. |
API reference
25 operations. Open one for its parameters, bodies, responses and a sample request.
GET/api/crm/sales-ordersList sales orders
Query parameters
| Name | Description | Example |
|---|---|---|
limit | Rows per page (50 by default, at most 200) | limit=100 |
offset | Rows to skip | offset=200 |
q | Free-text search over the search columns | q=acme |
sort | column:asc or column:desc, several separated by commas | sort=created_at:desc |
filter | A JSON condition or group (see the filter language), URL-encoded; any field below can be filtered and sorted | filter={"col":"status","op":"eq","value":"open"} |
<field>=<value> | Shorthand for "field is value" |
Response 200
{
"rows": [
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"so_no": "SO-000001",
"account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"contact_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"quotation_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"opportunity_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"order_date": "2026-10-30",
"requested_date": "2026-10-30",
"currency": "USD",
"status": "draft",
"subtotal": "1250.00",
"tax_total": "1250.00",
"total": "1250.00"
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/crm/sales-orders?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/crm/sales-orders/{id}Read one sales orders
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"so_no": "SO-000001",
"account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"contact_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"quotation_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"opportunity_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"order_date": "2026-10-30",
"requested_date": "2026-10-30",
"currency": "USD",
"status": "draft",
"subtotal": "1250.00",
"tax_total": "1250.00",
"total": "1250.00"
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/crm/sales-orders/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/crm/sales-ordersCreate a sales orders
Request body
The record as JSON. Fields marked Yes are required.
| Field | Type | Required | Description |
|---|---|---|---|
account_id | uuid | Yes | Account id |
contact_id | uuid | No | Contact id |
quotation_id | uuid | No | Quotation id |
opportunity_id | uuid | No | Opportunity id |
order_date | date | No | Order date |
requested_date | date | No | Requested delivery date |
currency | text | Yes | Currency |
status | text | No | Status |
customer_po_ref | text | No | Customer PO reference |
ship_to_address | text | No | Ship to — What the carrier and the printed order read. Follows a changed shipping address unless you change this text too. |
notes | text | No | Notes |
exchange_rate | numeric | No | Exchange rate |
order_type_id | uuid | No | Order type id |
Sample body
{
"account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"currency": "USD",
"contact_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"quotation_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"opportunity_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"order_date": "2026-10-30"
}Response 201
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"so_no": "SO-000001",
"account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"contact_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"quotation_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"opportunity_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"order_date": "2026-10-30",
"requested_date": "2026-10-30",
"currency": "USD",
"status": "draft",
"subtotal": "1250.00",
"tax_total": "1250.00",
"total": "1250.00"
}Sample request
curl -X POST "https://demo.tranxact.ai/api/crm/sales-orders" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"account_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","currency":"USD","contact_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","quotation_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","opportunity_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","order_date":"2026-10-30"}'PUT/api/crm/sales-orders/{id}Change a sales orders
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
Only the fields to change; fields left out keep their value.
| Field | Type | Required | Description |
|---|---|---|---|
account_id | uuid | Yes | Account id |
contact_id | uuid | No | Contact id |
quotation_id | uuid | No | Quotation id |
opportunity_id | uuid | No | Opportunity id |
order_date | date | No | Order date |
requested_date | date | No | Requested delivery date |
currency | text | Yes | Currency |
status | text | No | Status |
customer_po_ref | text | No | Customer PO reference |
ship_to_address | text | No | Ship to — What the carrier and the printed order read. Follows a changed shipping address unless you change this text too. |
notes | text | No | Notes |
exchange_rate | numeric | No | Exchange rate |
order_type_id | uuid | No | Order type id |
Sample body
{
"account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"currency": "USD"
}Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"so_no": "SO-000001",
"account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"contact_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"quotation_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"opportunity_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"order_date": "2026-10-30",
"requested_date": "2026-10-30",
"currency": "USD",
"status": "draft",
"subtotal": "1250.00",
"tax_total": "1250.00",
"total": "1250.00"
}Sample request
curl -X PUT "https://demo.tranxact.ai/api/crm/sales-orders/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"account_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","currency":"USD"}'DELETE/api/crm/sales-orders/{id}Delete a sales orders
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Response 200
{ "deleted": true }Many documents are cancelled or reversed instead; the API refuses a delete the screen would refuse.
Sample request
curl -X DELETE "https://demo.tranxact.ai/api/crm/sales-orders/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"GET/api/crm/sales-orders/line-templateLine template
Response
200 with the data as JSON.
Sample request
curl "https://demo.tranxact.ai/api/crm/sales-orders/line-template" \
-H "Authorization: Bearer $TOKEN"POST/api/crm/sales-orders/line-uploadLine upload
No body is required.
Response
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/crm/sales-orders/line-upload" \
-H "Authorization: Bearer $TOKEN"POST/api/crm/sales-orders/line-upload/error-fileLine upload error file
Request body
The keys this action reads (* = required; "one of" lists the only values):
rows: [{ problems, sheet, rowNo, itemNo }]Response
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/crm/sales-orders/line-upload/error-file" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"rows:":"value","sheet":"value","rowNo":"value","itemNo":"value"}'GET/api/crm/sales-orders/line-upload/360Line upload 360
Response
200 with the data as JSON.
Sample request
curl "https://demo.tranxact.ai/api/crm/sales-orders/line-upload/360" \
-H "Authorization: Bearer $TOKEN"POST/api/crm/sales-orders/line-upload/discardLine upload discard
Request body
The keys this action reads (* = required; "one of" lists the only values):
configIdsResponse
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/crm/sales-orders/line-upload/discard" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"configIds":"value"}'GET/api/crm/sales-orders/{id}/mrpMrp
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Response
200 with the data as JSON.
Sample request
curl "https://demo.tranxact.ai/api/crm/sales-orders/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/mrp" \
-H "Authorization: Bearer $TOKEN"POST/api/crm/sales-orders/{id}/run-mrpRun mrp
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
No body is required.
Response
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/crm/sales-orders/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/run-mrp" \
-H "Authorization: Bearer $TOKEN"POST/api/crm/sales-orders/{id}/run-mrp/firmRun mrp firm
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
The keys this action reads (* = required; "one of" lists the only values):
kinds, itemIdsResponse
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/crm/sales-orders/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/run-mrp/firm" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"kinds":"value","itemIds":"value"}'POST/api/crm/sales-orders/{id}/run-mrp/fulfilmentRun mrp fulfilment
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
The keys this action reads (* = required; "one of" lists the only values):
itemId, method, supplierId, reasonResponse
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/crm/sales-orders/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/run-mrp/fulfilment" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"itemId":"value","method":"value","supplierId":"value","reason":"value"}'GET/api/crm/sales-orders/{id}/annexureAnnexure
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Response
200 with the data as JSON.
Sample request
curl "https://demo.tranxact.ai/api/crm/sales-orders/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/annexure" \
-H "Authorization: Bearer $TOKEN"GET/api/crm/sales-orders/{id}/mrp/traceMrp trace
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Response
200 with the data as JSON.
Sample request
curl "https://demo.tranxact.ai/api/crm/sales-orders/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/mrp/trace" \
-H "Authorization: Bearer $TOKEN"POST/api/crm/sales-orders/{id}/copyCopy
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
The keys this action reads (* = required; "one of" lists the only values):
overrides, preview, withLinesResponse
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/crm/sales-orders/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/copy" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"overrides":"value","preview":"value","withLines":"value"}'GET/api/crm/sales-orders/{parentId}/linesLines
Path parameters
| Name | Type | Description |
|---|---|---|
parentId | string (uuid) | The record's parentId, as a list returns it. |
Response
200 with the data as JSON.
Sample request
curl "https://demo.tranxact.ai/api/crm/sales-orders/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/lines" \
-H "Authorization: Bearer $TOKEN"POST/api/crm/sales-orders/{parentId}/linesLines
Path parameters
| Name | Type | Description |
|---|---|---|
parentId | string (uuid) | The record's parentId, as a list returns it. |
No body is required.
Response
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/crm/sales-orders/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/lines" \
-H "Authorization: Bearer $TOKEN"PUT/api/crm/sales-orders/{parentId}/lines/{lineId}Lines
Path parameters
| Name | Type | Description |
|---|---|---|
parentId | string (uuid) | The record's parentId, as a list returns it. |
lineId | string (uuid) | The record's lineId, as a list returns it. |
No body is required.
Response
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X PUT "https://demo.tranxact.ai/api/crm/sales-orders/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/lines/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"DELETE/api/crm/sales-orders/{parentId}/lines/{lineId}Lines
Path parameters
| Name | Type | Description |
|---|---|---|
parentId | string (uuid) | The record's parentId, as a list returns it. |
lineId | string (uuid) | The record's lineId, as a list returns it. |
No body is required.
Response
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X DELETE "https://demo.tranxact.ai/api/crm/sales-orders/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/lines/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/crm/sales-orders/createCreate
Request body
The keys this action reads (* = required; "one of" lists the only values):
shipTo, shipToSiteId, shipFrom, soNo, orderTypeId, order_type_id, accountId*, contactId, requestedDate, currency, exchangeRate, customerPoRef, shipToAddress, costCenterId, warehouseId, locationId, notes; lines: [{ itemId, uom, currency, exchangeRate, requestedDate, description, quantity, unitPrice, discountPct, warehouseId, configId, configUnitPrice, costCenterId, profitCenterId, projectId, customerItemNo, customerTagNo, lineNotes, taxCategory, taxExemptionCode, tariffCode, placeOfSupply, taxCode, attributes, productionVersionId, fulfilment, dropShip, dropShipSupplierId }]Response
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/crm/sales-orders/create" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"shipTo":"value","shipToSiteId":"value","shipFrom":"value","soNo":"value","orderTypeId":"value","order_type_id":"value"}'POST/api/crm/sales-orders/{id}/confirmConfirm
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
No body is required.
Response
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/crm/sales-orders/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/confirm" \
-H "Authorization: Bearer $TOKEN"POST/api/crm/sales-orders/{id}/create-deliveryCreate delivery
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
The keys this action reads (* = required; "one of" lists the only values):
exchangeRate, warehouseId, deliveryDate, incoterms; lines: [{ salesOrderLineId, quantity, id, configured_item_id }]Response
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/crm/sales-orders/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/create-delivery" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"exchangeRate":"value","warehouseId":"value","deliveryDate":"value","incoterms;":"value","quantity":"value","id":"value"}'POST/api/crm/sales-orders/{id}/invoiceInvoice
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
No body is required.
Response
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/crm/sales-orders/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/invoice" \
-H "Authorization: Bearer $TOKEN"Data model
Every field of a sales orders, as the API returns it. Field names are the JSON keys; any of them can be filtered and sorted on a list.
| Field | Type | Access | Description |
|---|---|---|---|
id | uuid | read only | Id |
org_id | uuid | read only | Org id |
org_unit_id | uuid | read only | Org unit id |
so_no | text | read only | So no |
account_id | uuid | read, write | Account id |
contact_id | uuid | read, write | Contact id |
quotation_id | uuid | read, write | Quotation id |
opportunity_id | uuid | read, write | Opportunity id |
order_date | date | read, write | Order date |
requested_date | date | read, write | Requested delivery date |
currency | text | read, write | Currency |
status | text | read, write | Status |
subtotal | numeric | read only | Subtotal |
tax_total | numeric | read only | Tax total |
total | numeric | read only | Total |
customer_po_ref | text | read, write | Customer PO reference |
ship_to_address | text | read, write | Ship to — What the carrier and the printed order read. Follows a changed shipping address unless you change this text too. |
notes | text | read, write | Notes |
created_by | uuid | read only | Created by |
created_at | timestamp with time zone | read only | Created at |
location_id | uuid | read only | Location |
warehouse_id | uuid | read only | Ships from warehouse |
cost_center_id | uuid | read only | Cost center id |
profit_center_id | uuid | read only | Profit center id |
cancelled_at | timestamp with time zone | read only | Cancelled at |
cancelled_by | uuid | read only | Cancelled by |
cancel_reason | text | read only | Cancel reason |
reversed_by_id | uuid | read only | Reversed by id |
reverses_id | uuid | read only | Reverses id |
exchange_rate | numeric | read, write | Exchange rate |
base_total | numeric | read only | Base total |
xf_text_1 | text | read only | Xf text 1 |
xf_text_2 | text | read only | Xf text 2 |
xf_text_3 | text | read only | Xf text 3 |
xf_text_4 | text | read only | Xf text 4 |
xf_text_5 | text | read only | Xf text 5 |
xf_num_1 | numeric | read only | Xf num 1 |
xf_num_2 | numeric | read only | Xf num 2 |
xf_num_3 | numeric | read only | Xf num 3 |
xf_date_1 | date | read only | Xf date 1 |
xf_date_2 | date | read only | Xf date 2 |
updated_at | timestamp with time zone | read only | Updated at |
updated_by | uuid | read only | Updated by |
edi_interchange_id | uuid | read only | Edi interchange id |
customer_po_date | date | read only | Customer po date |
source_channel | text | read only | Source channel |
channel_order_ref | text | read only | Channel order ref |
commerce_connector_id | uuid | read only | Commerce connector id |
supplier_gstin | text | read only | Supplier gstin |
buyer_gstin | text | read only | Buyer gstin |
place_of_supply | text | read only | Place of supply |
is_interstate | boolean | read only | Is interstate |
is_reverse_charge | boolean | read only | Is reverse charge |
export_type | text | read only | Export type |
cgst_total | numeric | read only | Cgst total |
sgst_total | numeric | read only | Sgst total |
igst_total | numeric | read only | Igst total |
cess_total | numeric | read only | Cess total |
order_type_id | uuid | read, write | Order type id |
charges_total | numeric | read only | Charges total |
accrued_charges_total | numeric | read only | Accrued charges total |
Errors
| Status | Meaning |
|---|---|
| 400 | The request could not be read: a filter that is not JSON, a bad parameter |
| 401 | No credential, or it is wrong, revoked or expired |
| 403 | The caller's roles do not hold CRM › Sales Orders for this verb, or the address or origin is not allowed |
| 404 | No record with that id is visible to the caller |
| 409 | A conflict: a duplicate number, a document in a state that does not allow it, or a record changed or locked by someone else |
| 422 | Refused by the same validation as the screen; the error names the field and why |
Every error is JSON: {"error": "a sentence saying what was wrong"}, with field where it applies.