TRANXACT.AI Help

Accounting · Workforce Planning

Workforce Cost Plans

People are between forty and seventy per cent of the cost base, so the budget is mostly a workforce plan whether anybody calls it one or not.

Type REST10 operationsBase path /api/accounting/workforce-plansPublished as /api/v1/workforce-plans

Download specification (OpenAPI 3.1) Screen: Workforce Cost Plans

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 › Workforce Cost Plans 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.workforce_plans · 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/workforce-plansList workforce cost plans

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",
      "code": "COD-000001",
      "name": "Example",
      "fiscal_year": 10,
      "version": "plan",
      "baseline_plan_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "period_from": "2026-10-30",
      "period_to": "2026-10-30",
      "currency": "USD",
      "cost_center_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "merit_increase_pct": "1250.00",
      "promotion_budget_pct": "1250.00",
      "attrition_pct": "1250.00"
    }
  ],
  "count": 1
}

Sample request

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

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",
  "code": "COD-000001",
  "name": "Example",
  "fiscal_year": 10,
  "version": "plan",
  "baseline_plan_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "period_from": "2026-10-30",
  "period_to": "2026-10-30",
  "currency": "USD",
  "cost_center_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "merit_increase_pct": "1250.00",
  "promotion_budget_pct": "1250.00",
  "attrition_pct": "1250.00"
}

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

Sample request

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

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
codetextYesCode
nametextYesName
fiscal_yearintegerYesFiscal year
versiontextNoVersion
Allowed: plan budget forecast actual simulation baseline
baseline_plan_iduuidNoCompare against
period_fromdateYesFrom
period_todateYesTo
currencytextNoCurrency
cost_center_iduuidNoCost center
merit_increase_pctnumericNoMerit increase %
promotion_budget_pctnumericNoPromotion budget %
attrition_pctnumericNoAttrition % — A plan that assumes every seat is filled all year overstates by the turnover rate.
benefit_load_pctnumericNoBenefit load %
employer_tax_pctnumericNoEmployer tax %
notestextNoNotes

Sample body

{
  "code": "COD-000001",
  "name": "Example",
  "fiscal_year": 10,
  "period_from": "2026-10-30",
  "period_to": "2026-10-30",
  "version": "plan",
  "baseline_plan_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "currency": "USD"
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "code": "COD-000001",
  "name": "Example",
  "fiscal_year": 10,
  "version": "plan",
  "baseline_plan_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "period_from": "2026-10-30",
  "period_to": "2026-10-30",
  "currency": "USD",
  "cost_center_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "merit_increase_pct": "1250.00",
  "promotion_budget_pct": "1250.00",
  "attrition_pct": "1250.00"
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/accounting/workforce-plans" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"code":"COD-000001","name":"Example","fiscal_year":10,"period_from":"2026-10-30","period_to":"2026-10-30","version":"plan","baseline_plan_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","currency":"USD"}'
PUT/api/accounting/workforce-plans/{id}Change a workforce cost plan

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
codetextYesCode
nametextYesName
fiscal_yearintegerYesFiscal year
versiontextNoVersion
Allowed: plan budget forecast actual simulation baseline
baseline_plan_iduuidNoCompare against
period_fromdateYesFrom
period_todateYesTo
currencytextNoCurrency
cost_center_iduuidNoCost center
merit_increase_pctnumericNoMerit increase %
promotion_budget_pctnumericNoPromotion budget %
attrition_pctnumericNoAttrition % — A plan that assumes every seat is filled all year overstates by the turnover rate.
benefit_load_pctnumericNoBenefit load %
employer_tax_pctnumericNoEmployer tax %
notestextNoNotes

Sample body

{
  "code": "COD-000001",
  "name": "Example"
}

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "code": "COD-000001",
  "name": "Example",
  "fiscal_year": 10,
  "version": "plan",
  "baseline_plan_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "period_from": "2026-10-30",
  "period_to": "2026-10-30",
  "currency": "USD",
  "cost_center_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "merit_increase_pct": "1250.00",
  "promotion_budget_pct": "1250.00",
  "attrition_pct": "1250.00"
}

Sample request

curl -X PUT "https://demo.tranxact.ai/api/accounting/workforce-plans/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"code":"COD-000001","name":"Example"}'
DELETE/api/accounting/workforce-plans/{id}Delete a workforce cost plan

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

Data model

Every field of a workforce cost plan, 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
codetextread, writeCode
nametextread, writeName
fiscal_yearintegerread, writeFiscal year
versiontextread, writeVersion
Allowed: plan budget forecast actual simulation baseline
baseline_plan_iduuidread, writeCompare against
period_fromdateread, writeFrom
period_todateread, writeTo
currencytextread, writeCurrency
cost_center_iduuidread, writeCost center
merit_increase_pctnumericread, writeMerit increase %
promotion_budget_pctnumericread, writePromotion budget %
attrition_pctnumericread, writeAttrition % — A plan that assumes every seat is filled all year overstates by the turnover rate.
benefit_load_pctnumericread, writeBenefit load %
employer_tax_pctnumericread, writeEmployer tax %
opening_headcountnumericread onlyOpening headcount
closing_headcountnumericread onlyClosing headcount
average_ftenumericread onlyAverage fte
total_base_costnumericread onlyTotal base cost
total_loaded_costnumericread onlyTotal loaded cost
hire_countintegerread onlyHire count
leaver_countintegerread onlyLeaver count
statustextread onlyStatus
submitted_byuuidread onlySubmitted by
approved_byuuidread onlyApproved by
approved_attimestamp with time zoneread onlyApproved at
calculated_attimestamp with time zoneread onlyCalculated at
notestextread, writeNotes
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 › Workforce Cost Plans 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.