Accounting · Workforce Planning
Planned Positions
A line is a POSITION rather than a person, because a plan built on named people cannot represent a vacancy — and a vacancy is the largest single source of variance in a personnel budget.
/api/accounting/workforce-linesPublished as /api/v1/workforce-linesDownload specification (OpenAPI 3.1) Screen: Planned Positions
Overview
| 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 › Planned Positions 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.workforce_lines · 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
6 operations. Open one for its parameters, bodies, responses and a sample request.
GET/api/accounting/workforce-linesList planned positions
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",
"plan_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"line_no": 10,
"position_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"employee_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"cost_center_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",
"job_title": "Example",
"grade": "text",
"location": "text",
"worker_type": "employee",
"action": "text"
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/accounting/workforce-lines?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/accounting/workforce-lines/{id}Read one workforce plan line
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",
"plan_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"line_no": 10,
"position_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"employee_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"cost_center_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",
"job_title": "Example",
"grade": "text",
"location": "text",
"worker_type": "employee",
"action": "text"
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/accounting/workforce-lines/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/accounting/workforce-linesCreate a workforce plan line
Request body
The record as JSON. Fields marked Yes are required.
| Field | Type | Required | Description |
|---|---|---|---|
plan_id | uuid | Yes | Plan |
line_no | integer | Yes | Line |
position_id | uuid | No | Position |
employee_id | uuid | No | Person (blank = a vacancy) |
cost_center_id | uuid | No | Cost center |
project_id | uuid | No | Project |
wbs_element_id | uuid | No | Work breakdown element |
job_title | text | No | Job title |
grade | text | No | Grade |
location | text | No | Location |
worker_type | text | No | Worker type Allowed: employee contractor intern agency consultant |
action | text | No | Action |
fte | numeric | No | FTE |
start_date | date | No | From |
end_date | date | No | To |
months_in_plan | numeric | No | Months in plan |
currency | text | No | Currency |
base_salary | numeric | No | Base salary |
allowances | numeric | No | Allowances |
bonus | numeric | No | Bonus |
commission | numeric | No | Commission |
overtime | numeric | No | Overtime |
employer_tax | numeric | No | Employer tax |
benefits | numeric | No | Benefits |
pension | numeric | No | Pension |
other_cost | numeric | No | Other |
increase_pct | numeric | No | Increase % |
effective_increase_date | date | No | Increase effective — A merit increase lands on its effective date, not on 1 January — several per cent on a full-year figure. |
capitalised_pct | numeric | No | Capitalised % |
billable_pct | numeric | No | Billable % |
probability_pct | numeric | No | Probability % |
notes | text | No | Notes |
Sample body
{
"plan_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"line_no": 10,
"position_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"employee_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"cost_center_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"project_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}Response 201
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"plan_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"line_no": 10,
"position_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"employee_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"cost_center_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",
"job_title": "Example",
"grade": "text",
"location": "text",
"worker_type": "employee",
"action": "text"
}Sample request
curl -X POST "https://demo.tranxact.ai/api/accounting/workforce-lines" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"plan_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","line_no":10,"position_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","employee_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","cost_center_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","project_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"}'PUT/api/accounting/workforce-lines/{id}Change a workforce plan line
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 |
|---|---|---|---|
plan_id | uuid | Yes | Plan |
line_no | integer | Yes | Line |
position_id | uuid | No | Position |
employee_id | uuid | No | Person (blank = a vacancy) |
cost_center_id | uuid | No | Cost center |
project_id | uuid | No | Project |
wbs_element_id | uuid | No | Work breakdown element |
job_title | text | No | Job title |
grade | text | No | Grade |
location | text | No | Location |
worker_type | text | No | Worker type Allowed: employee contractor intern agency consultant |
action | text | No | Action |
fte | numeric | No | FTE |
start_date | date | No | From |
end_date | date | No | To |
months_in_plan | numeric | No | Months in plan |
currency | text | No | Currency |
base_salary | numeric | No | Base salary |
allowances | numeric | No | Allowances |
bonus | numeric | No | Bonus |
commission | numeric | No | Commission |
overtime | numeric | No | Overtime |
employer_tax | numeric | No | Employer tax |
benefits | numeric | No | Benefits |
pension | numeric | No | Pension |
other_cost | numeric | No | Other |
increase_pct | numeric | No | Increase % |
effective_increase_date | date | No | Increase effective — A merit increase lands on its effective date, not on 1 January — several per cent on a full-year figure. |
capitalised_pct | numeric | No | Capitalised % |
billable_pct | numeric | No | Billable % |
probability_pct | numeric | No | Probability % |
notes | text | No | Notes |
Sample body
{
"plan_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"line_no": 10
}Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"plan_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"line_no": 10,
"position_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"employee_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"cost_center_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",
"job_title": "Example",
"grade": "text",
"location": "text",
"worker_type": "employee",
"action": "text"
}Sample request
curl -X PUT "https://demo.tranxact.ai/api/accounting/workforce-lines/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"plan_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","line_no":10}'DELETE/api/accounting/workforce-lines/{id}Delete a workforce plan line
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/workforce-lines/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/accounting/workforce-lines/{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/workforce-lines/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 workforce plan line, 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 |
plan_id | uuid | read, write | Plan |
line_no | integer | read, write | Line |
position_id | uuid | read, write | Position |
employee_id | uuid | read, write | Person (blank = a vacancy) |
cost_center_id | uuid | read, write | Cost center |
org_unit_id | uuid | read only | Org unit id |
project_id | uuid | read, write | Project |
wbs_element_id | uuid | read, write | Work breakdown element |
job_title | text | read, write | Job title |
grade | text | read, write | Grade |
location | text | read, write | Location |
worker_type | text | read, write | Worker type Allowed: employee contractor intern agency consultant |
action | text | read, write | Action |
fte | numeric | read, write | FTE |
start_date | date | read, write | From |
end_date | date | read, write | To |
months_in_plan | numeric | read, write | Months in plan |
currency | text | read, write | Currency |
base_salary | numeric | read, write | Base salary |
allowances | numeric | read, write | Allowances |
bonus | numeric | read, write | Bonus |
commission | numeric | read, write | Commission |
overtime | numeric | read, write | Overtime |
employer_tax | numeric | read, write | Employer tax |
benefits | numeric | read, write | Benefits |
pension | numeric | read, write | Pension |
other_cost | numeric | read, write | Other |
total_cost | numeric | read only | Total cost |
increase_pct | numeric | read, write | Increase % |
effective_increase_date | date | read, write | Increase effective — A merit increase lands on its effective date, not on 1 January — several per cent on a full-year figure. |
capitalised_pct | numeric | read, write | Capitalised % |
billable_pct | numeric | read, write | Billable % |
requisition_id | uuid | read only | Requisition id |
probability_pct | numeric | read, write | Probability % |
status | text | read only | Status |
notes | text | read, write | Notes |
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 |
created_at | timestamp with time zone | read only | Created at |
created_by | uuid | read only | Created by |
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 › Planned Positions 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.