TRANXACT.AI Help

CRM · Selling

Sales Orders

Read and maintain sales orders records (crm.sales_orders).

Type REST25 operationsBase path /api/crm/sales-ordersPublished as /api/v1/sales-orders

Download specification (OpenAPI 3.1) Screen: Sales Orders

Overview

PackageCRM
AuthenticationBearer token: a service account's token (POST /api/auth/service-token) or, for the published path, an API key
AuthorizationThe 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.
Tablecrm.sales_orders · kept per company (and organisational unit where it has one)
RecordCreated, changed and (where the screen allows) deleted; key id
RulesThe 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

NameDescriptionExample
limitRows per page (50 by default, at most 200)limit=100
offsetRows to skipoffset=200
qFree-text search over the search columnsq=acme
sortcolumn:asc or column:desc, several separated by commassort=created_at:desc
filterA JSON condition or group (see the filter language), URL-encoded; any field below can be filtered and sortedfilter={"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

NameTypeDescription
idstring (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.

FieldTypeRequiredDescription
account_iduuidYesAccount id
contact_iduuidNoContact id
quotation_iduuidNoQuotation id
opportunity_iduuidNoOpportunity id
order_datedateNoOrder date
requested_datedateNoRequested delivery date
currencytextYesCurrency
statustextNoStatus
customer_po_reftextNoCustomer PO reference
ship_to_addresstextNoShip to — What the carrier and the printed order read. Follows a changed shipping address unless you change this text too.
notestextNoNotes
exchange_ratenumericNoExchange rate
order_type_iduuidNoOrder 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

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Request body

Only the fields to change; fields left out keep their value.

FieldTypeRequiredDescription
account_iduuidYesAccount id
contact_iduuidNoContact id
quotation_iduuidNoQuotation id
opportunity_iduuidNoOpportunity id
order_datedateNoOrder date
requested_datedateNoRequested delivery date
currencytextYesCurrency
statustextNoStatus
customer_po_reftextNoCustomer PO reference
ship_to_addresstextNoShip to — What the carrier and the printed order read. Follows a changed shipping address unless you change this text too.
notestextNoNotes
exchange_ratenumericNoExchange rate
order_type_iduuidNoOrder 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

NameTypeDescription
idstring (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):

configIds

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/discard" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"configIds":"value"}'
GET/api/crm/sales-orders/{id}/mrpMrp

Path parameters

NameTypeDescription
idstring (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

NameTypeDescription
idstring (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

NameTypeDescription
idstring (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, itemIds

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

NameTypeDescription
idstring (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, reason

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

NameTypeDescription
idstring (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

NameTypeDescription
idstring (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

NameTypeDescription
idstring (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, withLines

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

NameTypeDescription
parentIdstring (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

NameTypeDescription
parentIdstring (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

NameTypeDescription
parentIdstring (uuid)The record's parentId, as a list returns it.
lineIdstring (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

NameTypeDescription
parentIdstring (uuid)The record's parentId, as a list returns it.
lineIdstring (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

NameTypeDescription
idstring (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

NameTypeDescription
idstring (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

NameTypeDescription
idstring (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.

FieldTypeAccessDescription
iduuidread onlyId
org_iduuidread onlyOrg id
org_unit_iduuidread onlyOrg unit id
so_notextread onlySo no
account_iduuidread, writeAccount id
contact_iduuidread, writeContact id
quotation_iduuidread, writeQuotation id
opportunity_iduuidread, writeOpportunity id
order_datedateread, writeOrder date
requested_datedateread, writeRequested delivery date
currencytextread, writeCurrency
statustextread, writeStatus
subtotalnumericread onlySubtotal
tax_totalnumericread onlyTax total
totalnumericread onlyTotal
customer_po_reftextread, writeCustomer PO reference
ship_to_addresstextread, writeShip to — What the carrier and the printed order read. Follows a changed shipping address unless you change this text too.
notestextread, writeNotes
created_byuuidread onlyCreated by
created_attimestamp with time zoneread onlyCreated at
location_iduuidread onlyLocation
warehouse_iduuidread onlyShips from warehouse
cost_center_iduuidread onlyCost center id
profit_center_iduuidread onlyProfit center id
cancelled_attimestamp with time zoneread onlyCancelled at
cancelled_byuuidread onlyCancelled by
cancel_reasontextread onlyCancel reason
reversed_by_iduuidread onlyReversed by id
reverses_iduuidread onlyReverses id
exchange_ratenumericread, writeExchange rate
base_totalnumericread onlyBase total
xf_text_1textread onlyXf text 1
xf_text_2textread onlyXf text 2
xf_text_3textread onlyXf text 3
xf_text_4textread onlyXf text 4
xf_text_5textread onlyXf text 5
xf_num_1numericread onlyXf num 1
xf_num_2numericread onlyXf num 2
xf_num_3numericread onlyXf num 3
xf_date_1dateread onlyXf date 1
xf_date_2dateread onlyXf date 2
updated_attimestamp with time zoneread onlyUpdated at
updated_byuuidread onlyUpdated by
edi_interchange_iduuidread onlyEdi interchange id
customer_po_datedateread onlyCustomer po date
source_channeltextread onlySource channel
channel_order_reftextread onlyChannel order ref
commerce_connector_iduuidread onlyCommerce connector id
supplier_gstintextread onlySupplier gstin
buyer_gstintextread onlyBuyer gstin
place_of_supplytextread onlyPlace of supply
is_interstatebooleanread onlyIs interstate
is_reverse_chargebooleanread onlyIs reverse charge
export_typetextread onlyExport type
cgst_totalnumericread onlyCgst total
sgst_totalnumericread onlySgst total
igst_totalnumericread onlyIgst total
cess_totalnumericread onlyCess total
order_type_iduuidread, writeOrder type id
charges_totalnumericread onlyCharges total
accrued_charges_totalnumericread onlyAccrued charges total

Errors

StatusMeaning
400The request could not be read: a filter that is not JSON, a bad parameter
401No credential, or it is wrong, revoked or expired
403The caller's roles do not hold CRM › Sales Orders for this verb, or the address or origin is not allowed
404No record with that id is visible to the caller
409A conflict: a duplicate number, a document in a state that does not allow it, or a record changed or locked by someone else
422Refused 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.