TRANXACT.AI Help

Accounting · Projects & Portfolios

Project Costs

Planned, committed, actual and billed in one table, because the four have to be compared and comparing four tables is how a project report disagrees with itself.

Type REST6 operationsBase path /api/accounting/project-costsPublished as /api/v1/project-costs

Download specification (OpenAPI 3.1) Screen: Project Costs

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 › Project Costs 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.project_costs · 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

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

GET/api/accounting/project-costsList project costs

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",
      "project_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "wbs_element_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "activity_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "posting_date": "2026-10-30",
      "period_code": "PER-000001",
      "value_type": "text",
      "cost_element_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "component_code": "COM-000001",
      "gl_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "description": "text",
      "quantity": "12.0000",
      "uom": "text"
    }
  ],
  "count": 1
}

Sample request

curl "https://demo.tranxact.ai/api/accounting/project-costs?limit=20" \
  -H "Authorization: Bearer $TOKEN"
GET/api/accounting/project-costs/{id}Read one project cost

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",
  "project_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "wbs_element_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "activity_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "posting_date": "2026-10-30",
  "period_code": "PER-000001",
  "value_type": "text",
  "cost_element_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "component_code": "COM-000001",
  "gl_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "description": "text",
  "quantity": "12.0000",
  "uom": "text"
}

404 when no record with that id is visible to the caller.

Sample request

curl "https://demo.tranxact.ai/api/accounting/project-costs/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/accounting/project-costsCreate a project cost

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
project_iduuidYesProject id
wbs_element_iduuidNoWbs element id
activity_iduuidNoActivity id
posting_datedateNoPosting date
period_codetextNoPeriod code
value_typetextNoValue type
cost_element_iduuidNoCost element id
component_codetextNoComponent code
gl_account_iduuidNoGl account id
descriptiontextNoDescription
quantitynumericNoQuantity
uomtextNoUom
unit_pricenumericNoUnit price
amountnumericNoAmount
currencytextNoCurrency
hoursnumericNoHours
employee_iduuidNoEmployee id
supplier_iduuidNoSupplier id
item_iduuidNoItem id
source_moduletextNoSource module
source_typetextNoSource type
source_reftextNoSource ref
is_billablebooleanNoIs billable

Sample body

{
  "project_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "wbs_element_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "activity_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "posting_date": "2026-10-30",
  "period_code": "PER-000001"
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "project_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "wbs_element_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "activity_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "posting_date": "2026-10-30",
  "period_code": "PER-000001",
  "value_type": "text",
  "cost_element_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "component_code": "COM-000001",
  "gl_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "description": "text",
  "quantity": "12.0000",
  "uom": "text"
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/accounting/project-costs" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"project_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","wbs_element_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","activity_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","posting_date":"2026-10-30","period_code":"PER-000001"}'
PUT/api/accounting/project-costs/{id}Change a project cost

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
project_iduuidYesProject id
wbs_element_iduuidNoWbs element id
activity_iduuidNoActivity id
posting_datedateNoPosting date
period_codetextNoPeriod code
value_typetextNoValue type
cost_element_iduuidNoCost element id
component_codetextNoComponent code
gl_account_iduuidNoGl account id
descriptiontextNoDescription
quantitynumericNoQuantity
uomtextNoUom
unit_pricenumericNoUnit price
amountnumericNoAmount
currencytextNoCurrency
hoursnumericNoHours
employee_iduuidNoEmployee id
supplier_iduuidNoSupplier id
item_iduuidNoItem id
source_moduletextNoSource module
source_typetextNoSource type
source_reftextNoSource ref
is_billablebooleanNoIs billable

Sample body

{
  "project_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "wbs_element_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "project_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "wbs_element_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "activity_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "posting_date": "2026-10-30",
  "period_code": "PER-000001",
  "value_type": "text",
  "cost_element_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "component_code": "COM-000001",
  "gl_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "description": "text",
  "quantity": "12.0000",
  "uom": "text"
}

Sample request

curl -X PUT "https://demo.tranxact.ai/api/accounting/project-costs/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"project_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","wbs_element_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"}'
DELETE/api/accounting/project-costs/{id}Delete a project cost

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/project-costs/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/accounting/project-costs/{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/project-costs/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/copy" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"overrides":"value","preview":"value","withLines":"value"}'

Data model

Every field of a project cost, 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
project_iduuidread, writeProject id
wbs_element_iduuidread, writeWbs element id
activity_iduuidread, writeActivity id
posting_datedateread, writePosting date
period_codetextread, writePeriod code
value_typetextread, writeValue type
cost_element_iduuidread, writeCost element id
component_codetextread, writeComponent code
gl_account_iduuidread, writeGl account id
descriptiontextread, writeDescription
quantitynumericread, writeQuantity
uomtextread, writeUom
unit_pricenumericread, writeUnit price
amountnumericread, writeAmount
currencytextread, writeCurrency
hoursnumericread, writeHours
employee_iduuidread, writeEmployee id
supplier_iduuidread, writeSupplier id
item_iduuidread, writeItem id
source_moduletextread, writeSource module
source_typetextread, writeSource type
source_iduuidread onlySource id
source_reftextread, writeSource ref
journal_iduuidread onlyJournal id
is_billablebooleanread, writeIs billable
is_billedbooleanread onlyIs billed
ar_invoice_iduuidread onlyAr invoice id
is_settledbooleanread onlyIs settled
settlement_run_iduuidread onlySettlement run id
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
created_byuuidread onlyCreated by
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 › Project Costs 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.