Accounting · Product Costing
Cost Estimates
Explode the bill of material, price it, walk the routing, apply the overhead. Released, the estimate becomes the standard — and a standard that can be edited makes every variance since January a fiction.
/api/accounting/cost-estimatesPublished as /api/v1/cost-estimatesOverview
| Package | Accounting |
|---|---|
| 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 Accounting › Cost Estimates 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 | acct.cost_estimates · 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
10 operations. Open one for its parameters, bodies, responses and a sample request.
GET/api/accounting/cost-estimatesList cost estimates
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",
"estimate_no": "EST-000001",
"item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"bom_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"routing_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"costing_variant_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"estimate_type": "text",
"lot_size": "1250.00",
"uom": "text",
"currency": "USD",
"costing_date": "2026-10-30",
"valid_from": "2026-10-30",
"valid_to": "2026-10-30"
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/accounting/cost-estimates?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/accounting/cost-estimates/{id}Read one cost estimate
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",
"estimate_no": "EST-000001",
"item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"bom_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"routing_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"costing_variant_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"estimate_type": "text",
"lot_size": "1250.00",
"uom": "text",
"currency": "USD",
"costing_date": "2026-10-30",
"valid_from": "2026-10-30",
"valid_to": "2026-10-30"
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/accounting/cost-estimates/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/accounting/cost-estimatesCreate a cost estimate
Request body
The record as JSON. Fields marked Yes are required.
| Field | Type | Required | Description |
|---|---|---|---|
item_id | uuid | Yes | Item id |
bom_id | uuid | No | Bom id |
routing_id | uuid | No | Routing id |
costing_variant_id | uuid | No | Costing variant id |
estimate_type | text | No | Estimate type |
lot_size | numeric | No | Lot size |
uom | text | No | Uom |
currency | text | No | Currency |
costing_date | date | No | Costing date |
valid_from | date | No | Valid from |
valid_to | date | No | Valid to |
fiscal_year | integer | No | Fiscal year |
period_code | text | No | Period code |
notes | text | No | Notes |
Sample body
{
"item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"bom_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"routing_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"costing_variant_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"estimate_type": "text"
}Response 201
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"estimate_no": "EST-000001",
"item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"bom_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"routing_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"costing_variant_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"estimate_type": "text",
"lot_size": "1250.00",
"uom": "text",
"currency": "USD",
"costing_date": "2026-10-30",
"valid_from": "2026-10-30",
"valid_to": "2026-10-30"
}Sample request
curl -X POST "https://demo.tranxact.ai/api/accounting/cost-estimates" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"item_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","bom_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","routing_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","costing_variant_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","estimate_type":"text"}'PUT/api/accounting/cost-estimates/{id}Change a cost estimate
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 |
|---|---|---|---|
item_id | uuid | Yes | Item id |
bom_id | uuid | No | Bom id |
routing_id | uuid | No | Routing id |
costing_variant_id | uuid | No | Costing variant id |
estimate_type | text | No | Estimate type |
lot_size | numeric | No | Lot size |
uom | text | No | Uom |
currency | text | No | Currency |
costing_date | date | No | Costing date |
valid_from | date | No | Valid from |
valid_to | date | No | Valid to |
fiscal_year | integer | No | Fiscal year |
period_code | text | No | Period code |
notes | text | No | Notes |
Sample body
{
"item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"bom_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"estimate_no": "EST-000001",
"item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"bom_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"routing_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"costing_variant_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"estimate_type": "text",
"lot_size": "1250.00",
"uom": "text",
"currency": "USD",
"costing_date": "2026-10-30",
"valid_from": "2026-10-30",
"valid_to": "2026-10-30"
}Sample request
curl -X PUT "https://demo.tranxact.ai/api/accounting/cost-estimates/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"item_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","bom_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"}'DELETE/api/accounting/cost-estimates/{id}Delete a cost estimate
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/accounting/cost-estimates/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/accounting/cost-estimates/{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/accounting/cost-estimates/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/copy" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"overrides":"value","preview":"value","withLines":"value"}'GET/api/accounting/cost-estimates/{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/accounting/cost-estimates/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/lines" \
-H "Authorization: Bearer $TOKEN"POST/api/accounting/cost-estimates/{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/accounting/cost-estimates/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/lines" \
-H "Authorization: Bearer $TOKEN"PUT/api/accounting/cost-estimates/{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/accounting/cost-estimates/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/lines/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"DELETE/api/accounting/cost-estimates/{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/accounting/cost-estimates/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/lines/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"Data model
Every field of a cost estimate, 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 |
estimate_no | text | read only | Estimate no |
item_id | uuid | read, write | Item id |
bom_id | uuid | read, write | Bom id |
routing_id | uuid | read, write | Routing id |
costing_variant_id | uuid | read, write | Costing variant id |
estimate_type | text | read, write | Estimate type |
lot_size | numeric | read, write | Lot size |
uom | text | read, write | Uom |
currency | text | read, write | Currency |
costing_date | date | read, write | Costing date |
valid_from | date | read, write | Valid from |
valid_to | date | read, write | Valid to |
fiscal_year | integer | read, write | Fiscal year |
period_code | text | read, write | Period code |
total_cost | numeric | read only | Total cost |
unit_cost | numeric | read only | Unit cost |
fixed_cost | numeric | read only | Fixed cost |
variable_cost | numeric | read only | Variable cost |
material_cost | numeric | read only | Material cost |
labor_cost | numeric | read only | Labor cost |
machine_cost | numeric | read only | Machine cost |
overhead_cost | numeric | read only | Overhead cost |
status | text | read only | Status |
released_at | timestamp with time zone | read only | Released at |
released_by | uuid | read only | Released by |
supersedes_id | uuid | read only | Supersedes id |
previous_unit_cost | numeric | read only | Previous unit cost |
revaluation_amount | numeric | read only | Revaluation amount |
revaluation_journal_id | uuid | read only | Revaluation journal id |
run_id | uuid | read only | Run id |
exceptions | jsonb | read only | Exceptions |
notes | text | read, write | Notes |
created_by | uuid | read only | Created by |
created_at | timestamp with time zone | read only | Created at |
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 |
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 Accounting › Cost Estimates 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.