TRANXACT.AI Help

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.

Type REST10 operationsBase path /api/accounting/cost-estimatesPublished as /api/v1/cost-estimates

Download specification (OpenAPI 3.1) Screen: Cost Estimates

Overview

PackageAccounting
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 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.
Tableacct.cost_estimates · 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

10 operations. Open one for its parameters, bodies, responses and a sample request.

GET/api/accounting/cost-estimatesList cost estimates

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",
      "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

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",
  "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.

FieldTypeRequiredDescription
item_iduuidYesItem id
bom_iduuidNoBom id
routing_iduuidNoRouting id
costing_variant_iduuidNoCosting variant id
estimate_typetextNoEstimate type
lot_sizenumericNoLot size
uomtextNoUom
currencytextNoCurrency
costing_datedateNoCosting date
valid_fromdateNoValid from
valid_todateNoValid to
fiscal_yearintegerNoFiscal year
period_codetextNoPeriod code
notestextNoNotes

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

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
item_iduuidYesItem id
bom_iduuidNoBom id
routing_iduuidNoRouting id
costing_variant_iduuidNoCosting variant id
estimate_typetextNoEstimate type
lot_sizenumericNoLot size
uomtextNoUom
currencytextNoCurrency
costing_datedateNoCosting date
valid_fromdateNoValid from
valid_todateNoValid to
fiscal_yearintegerNoFiscal year
period_codetextNoPeriod code
notestextNoNotes

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

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/accounting/cost-estimates/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/accounting/cost-estimates/{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/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

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/accounting/cost-estimates/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/lines" \
  -H "Authorization: Bearer $TOKEN"
POST/api/accounting/cost-estimates/{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/accounting/cost-estimates/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/lines" \
  -H "Authorization: Bearer $TOKEN"
PUT/api/accounting/cost-estimates/{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/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

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

FieldTypeAccessDescription
iduuidread onlyId
org_iduuidread onlyOrg id
org_unit_iduuidread onlyOrg unit id
estimate_notextread onlyEstimate no
item_iduuidread, writeItem id
bom_iduuidread, writeBom id
routing_iduuidread, writeRouting id
costing_variant_iduuidread, writeCosting variant id
estimate_typetextread, writeEstimate type
lot_sizenumericread, writeLot size
uomtextread, writeUom
currencytextread, writeCurrency
costing_datedateread, writeCosting date
valid_fromdateread, writeValid from
valid_todateread, writeValid to
fiscal_yearintegerread, writeFiscal year
period_codetextread, writePeriod code
total_costnumericread onlyTotal cost
unit_costnumericread onlyUnit cost
fixed_costnumericread onlyFixed cost
variable_costnumericread onlyVariable cost
material_costnumericread onlyMaterial cost
labor_costnumericread onlyLabor cost
machine_costnumericread onlyMachine cost
overhead_costnumericread onlyOverhead cost
statustextread onlyStatus
released_attimestamp with time zoneread onlyReleased at
released_byuuidread onlyReleased by
supersedes_iduuidread onlySupersedes id
previous_unit_costnumericread onlyPrevious unit cost
revaluation_amountnumericread onlyRevaluation amount
revaluation_journal_iduuidread onlyRevaluation journal id
run_iduuidread onlyRun id
exceptionsjsonbread onlyExceptions
notestextread, writeNotes
created_byuuidread onlyCreated by
created_attimestamp with time zoneread onlyCreated at
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

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 Accounting › Cost Estimates 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.