TRANXACT.AI Help

Accounting · Projects & Portfolios

Work Breakdown

Both a piece of work and an account assignment. A summary element plans and does not accept postings; a work package accepts them and is where the money actually lands.

Type REST12 operationsBase path /api/accounting/wbs-elementsPublished as /api/v1/wbs-elements

Download specification (OpenAPI 3.1) Screen: Work Breakdown

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 › Work Breakdown 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.wbs_elements · 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

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

GET/api/accounting/wbs-elementsList work breakdown

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",
      "parent_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "wbs_code": "WBS-000001",
      "outline_no": "OUT-000001",
      "level_no": 10,
      "sort_path": "text",
      "name": "Example",
      "element_type": "text",
      "is_planning_element": true,
      "is_account_assignment": true,
      "is_billing_element": true,
      "cost_center_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
    }
  ],
  "count": 1
}

Sample request

curl "https://demo.tranxact.ai/api/accounting/wbs-elements?limit=20" \
  -H "Authorization: Bearer $TOKEN"
GET/api/accounting/wbs-elements/{id}Read one work breakdown element

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",
  "parent_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "wbs_code": "WBS-000001",
  "outline_no": "OUT-000001",
  "level_no": 10,
  "sort_path": "text",
  "name": "Example",
  "element_type": "text",
  "is_planning_element": true,
  "is_account_assignment": true,
  "is_billing_element": true,
  "cost_center_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}

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

Sample request

curl "https://demo.tranxact.ai/api/accounting/wbs-elements/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/accounting/wbs-elementsCreate a work breakdown element

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
project_iduuidYesProject
parent_iduuidNoParent element
wbs_codetextYesWBS code
outline_notextNoOutline number — 1.2.3.1 — maintained by the tree rather than typed.
level_nointegerNoLevel no
nametextYesName
element_typetextNoType
is_planning_elementbooleanNoPlans
is_account_assignmentbooleanNoAccepts postings
is_billing_elementbooleanNoBills
cost_center_iduuidNoCost center
profit_center_iduuidNoProfit center
asset_iduuidNoAsset under construction — Cost collected here settles to this asset — the join this structure exists for.
responsible_employee_iduuidNoResponsible
baseline_startdateNoBaseline start
baseline_enddateNoBaseline end
planned_startdateNoPlanned start
planned_enddateNoPlanned end
actual_startdateNoActual start
actual_enddateNoActual end
planned_hoursnumericNoPlanned hours
actual_hoursnumericNoActual hours
currencytextNoCurrency
budget_amountnumericNoBudget
planned_costnumericNoPlanned cost
planned_revenuenumericNoPlanned revenue
percent_completenumericNoPercent complete
progress_methodtextNoProgress method
weightnumericNoWeight
notestextNoNotes

Sample body

{
  "project_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "wbs_code": "WBS-000001",
  "name": "Example",
  "parent_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "outline_no": "OUT-000001",
  "level_no": 10,
  "element_type": "text"
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "project_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "parent_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "wbs_code": "WBS-000001",
  "outline_no": "OUT-000001",
  "level_no": 10,
  "sort_path": "text",
  "name": "Example",
  "element_type": "text",
  "is_planning_element": true,
  "is_account_assignment": true,
  "is_billing_element": true,
  "cost_center_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/accounting/wbs-elements" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"project_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","wbs_code":"WBS-000001","name":"Example","parent_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","outline_no":"OUT-000001","level_no":10,"element_type":"text"}'
PUT/api/accounting/wbs-elements/{id}Change a work breakdown element

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
parent_iduuidNoParent element
wbs_codetextYesWBS code
outline_notextNoOutline number — 1.2.3.1 — maintained by the tree rather than typed.
level_nointegerNoLevel no
nametextYesName
element_typetextNoType
is_planning_elementbooleanNoPlans
is_account_assignmentbooleanNoAccepts postings
is_billing_elementbooleanNoBills
cost_center_iduuidNoCost center
profit_center_iduuidNoProfit center
asset_iduuidNoAsset under construction — Cost collected here settles to this asset — the join this structure exists for.
responsible_employee_iduuidNoResponsible
baseline_startdateNoBaseline start
baseline_enddateNoBaseline end
planned_startdateNoPlanned start
planned_enddateNoPlanned end
actual_startdateNoActual start
actual_enddateNoActual end
planned_hoursnumericNoPlanned hours
actual_hoursnumericNoActual hours
currencytextNoCurrency
budget_amountnumericNoBudget
planned_costnumericNoPlanned cost
planned_revenuenumericNoPlanned revenue
percent_completenumericNoPercent complete
progress_methodtextNoProgress method
weightnumericNoWeight
notestextNoNotes

Sample body

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

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "project_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "parent_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "wbs_code": "WBS-000001",
  "outline_no": "OUT-000001",
  "level_no": 10,
  "sort_path": "text",
  "name": "Example",
  "element_type": "text",
  "is_planning_element": true,
  "is_account_assignment": true,
  "is_billing_element": true,
  "cost_center_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}

Sample request

curl -X PUT "https://demo.tranxact.ai/api/accounting/wbs-elements/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"project_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","wbs_code":"WBS-000001"}'
DELETE/api/accounting/wbs-elements/{id}Delete a work breakdown element

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

Path parameters

NameTypeDescription
idstring (uuid)The record's id, 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/wbs-elements/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/release" \
  -H "Authorization: Bearer $TOKEN"
POST/api/accounting/wbs-elements/{id}/completeComplete

Path parameters

NameTypeDescription
idstring (uuid)The record's id, 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/wbs-elements/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/complete" \
  -H "Authorization: Bearer $TOKEN"
POST/api/accounting/wbs-elements/{id}/lockLock

Path parameters

NameTypeDescription
idstring (uuid)The record's id, 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/wbs-elements/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/lock" \
  -H "Authorization: Bearer $TOKEN"
POST/api/accounting/wbs-elements/{id}/unlockUnlock

Path parameters

NameTypeDescription
idstring (uuid)The record's id, 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/wbs-elements/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/unlock" \
  -H "Authorization: Bearer $TOKEN"
POST/api/accounting/wbs-elements/{id}/closeClose

Path parameters

NameTypeDescription
idstring (uuid)The record's id, 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/wbs-elements/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/close" \
  -H "Authorization: Bearer $TOKEN"
POST/api/accounting/wbs-elements/{id}/cancelCancel

Path parameters

NameTypeDescription
idstring (uuid)The record's id, 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/wbs-elements/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/cancel" \
  -H "Authorization: Bearer $TOKEN"

Data model

Every field of a work breakdown element, 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
parent_iduuidread, writeParent element
wbs_codetextread, writeWBS code
outline_notextread, writeOutline number — 1.2.3.1 — maintained by the tree rather than typed.
level_nointegerread, writeLevel no
sort_pathtextread onlySort path
nametextread, writeName
element_typetextread, writeType
is_planning_elementbooleanread, writePlans
is_account_assignmentbooleanread, writeAccepts postings
is_billing_elementbooleanread, writeBills
cost_center_iduuidread, writeCost center
profit_center_iduuidread, writeProfit center
asset_iduuidread, writeAsset under construction — Cost collected here settles to this asset — the join this structure exists for.
responsible_employee_iduuidread, writeResponsible
baseline_startdateread, writeBaseline start
baseline_enddateread, writeBaseline end
planned_startdateread, writePlanned start
planned_enddateread, writePlanned end
actual_startdateread, writeActual start
actual_enddateread, writeActual end
planned_hoursnumericread, writePlanned hours
actual_hoursnumericread, writeActual hours
currencytextread, writeCurrency
budget_amountnumericread, writeBudget
planned_costnumericread, writePlanned cost
planned_revenuenumericread, writePlanned revenue
percent_completenumericread, writePercent complete
progress_methodtextread, writeProgress method
weightnumericread, writeWeight
statustextread onlyStatus
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
released_attimestamp with time zoneread onlyReleased at
closed_attimestamp with time zoneread onlyClosed at

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 › Work Breakdown 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.