Manufacturing · Order Costing & Profitability
Order Profitability
Quoted against actual, for every customer order: what it was sold for, what it was estimated to cost, what it actually cost element by element, and the margin that came of it.
/api/mfg/order-profitabilityPublished as /api/v1/order-profitabilityDownload specification (OpenAPI 3.1) Screen: Order Profitability
Overview
| Package | Manufacturing |
|---|---|
| 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 Manufacturing › Order Profitability 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 | Read only; key sales_order_id |
| Rules | The same as the screen: validation, numbering, approvals, posting, the company the caller belongs to, and the audit trail. |
API reference
6 operations. Open one for its parameters, bodies, responses and a sample request.
GET/api/mfg/order-profitabilityList order profitability
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/mfg/order-profitability?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/mfg/order-profitability/{sales_order_id}Read one order profitability
Path parameters
| Name | Type | Description |
|---|---|---|
sales_order_id | string (uuid) | The record's sales_order_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/mfg/order-profitability/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/mfg/order-profitabilityPost order profitability
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/mfg/order-profitability" \
-H "Authorization: Bearer $TOKEN"POST/api/mfg/order-profitability/{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/mfg/order-profitability/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/copy" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"overrides":"value","preview":"value","withLines":"value"}'PUT/api/mfg/order-profitability/{id}Put order profitability
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 PUT "https://demo.tranxact.ai/api/mfg/order-profitability/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"DELETE/api/mfg/order-profitability/{id}Delete order profitability
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 DELETE "https://demo.tranxact.ai/api/mfg/order-profitability/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"Data model
Every field of a order profitability, 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 only | Account id |
contact_id | uuid | read only | Contact id |
quotation_id | uuid | read only | Quotation id |
opportunity_id | uuid | read only | Opportunity id |
order_date | date | read only | Order date |
requested_date | date | read only | Requested date |
currency | text | read only | Currency |
status | text | read only | Status |
subtotal | numeric | read only | Subtotal |
tax_total | numeric | read only | Tax total |
total | numeric | read only | Total |
customer_po_ref | text | read only | Customer po ref |
ship_to_address | text | read only | Ship to address |
notes | text | read only | Notes |
created_by | uuid | read only | Created by |
created_at | timestamp with time zone | read only | Created at |
location_id | uuid | read only | Location id |
warehouse_id | uuid | read only | Warehouse id |
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 only | 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 only | 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 Manufacturing › Order Profitability 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.