Accounting · Projects & Portfolios
Projects
A plan and a cost collector at once. The join between them is the work breakdown structure — a WBS element is simultaneously a piece of work and an account assignment.
/api/accounting/projectsPublished as /api/v1/projectsOverview
| 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 › Projects 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.projects · 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
20 operations. Open one for its parameters, bodies, responses and a sample request.
GET/api/accounting/projectsList projects
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",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"project_no": "PRO-000001",
"name": "Example",
"program_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"portfolio_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"parent_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"project_type": "text",
"cost_object_type": "cost_collector",
"account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"opportunity_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"rev_contract_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"manager_employee_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"sponsor_employee_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/accounting/projects?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/accounting/projects/{id}Read one project
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",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"project_no": "PRO-000001",
"name": "Example",
"program_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"portfolio_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"parent_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"project_type": "text",
"cost_object_type": "cost_collector",
"account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"opportunity_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"rev_contract_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"manager_employee_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"sponsor_employee_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/projects/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/accounting/projectsCreate a project
Request body
The record as JSON. Fields marked Yes are required.
| Field | Type | Required | Description |
|---|---|---|---|
name | text | Yes | Name |
program_id | uuid | No | Program |
portfolio_id | uuid | No | Portfolio |
parent_id | uuid | No | Parent project |
project_type | text | No | Type |
cost_object_type | text | No | Cost object — Decides what settlement does with the cost at period end. Getting it wrong strands the cost. Allowed: cost_collector asset_under_construction billable statistical investment |
account_id | uuid | No | Customer |
opportunity_id | uuid | No | Opportunity |
rev_contract_id | uuid | No | Revenue contract |
manager_employee_id | uuid | No | Project manager |
sponsor_employee_id | uuid | No | Sponsor |
cost_center_id | uuid | No | Cost center |
profit_center_id | uuid | No | Profit center |
baseline_start | date | No | Baseline start |
baseline_end | date | No | Baseline end — What was promised. A project that keeps only the current plan cannot show slippage. |
planned_start | date | No | Planned start |
planned_end | date | No | Planned end |
actual_start | date | No | Actual start |
actual_end | date | No | Actual end |
currency | text | No | Currency |
budget_amount | numeric | No | Budget |
approved_amount | numeric | No | Approved |
contract_value | numeric | No | Contract value |
estimate_at_completion | numeric | No | Estimate at completion |
estimate_to_complete | numeric | No | Estimate to complete |
percent_complete | numeric | No | Percent complete |
progress_method | text | No | Progress method Allowed: Cost to cost Effort (hours) Milestones Units completed Physical progress Entered by hand |
allow_direct_postings | boolean | No | Accepts postings at header level — On a real project it should not: a header that takes cost grows a bucket nobody analyses. |
settlement_receiver_type | text | No | Settlement receiver type |
settlement_receiver_id | uuid | No | Settlement receiver id |
asset_id | uuid | No | Asset under construction |
health | text | No | Health Allowed: green amber red |
priority | text | No | Priority Allowed: critical high medium low |
risk_level | text | No | Risk level Allowed: high medium low |
description | text | No | Description |
notes | text | No | Notes |
Sample body
{
"name": "Example",
"program_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"portfolio_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"parent_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"project_type": "text"
}Response 201
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"project_no": "PRO-000001",
"name": "Example",
"program_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"portfolio_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"parent_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"project_type": "text",
"cost_object_type": "cost_collector",
"account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"opportunity_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"rev_contract_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"manager_employee_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"sponsor_employee_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}Sample request
curl -X POST "https://demo.tranxact.ai/api/accounting/projects" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"name":"Example","program_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","portfolio_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","parent_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","project_type":"text"}'PUT/api/accounting/projects/{id}Change a project
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 |
|---|---|---|---|
name | text | Yes | Name |
program_id | uuid | No | Program |
portfolio_id | uuid | No | Portfolio |
parent_id | uuid | No | Parent project |
project_type | text | No | Type |
cost_object_type | text | No | Cost object — Decides what settlement does with the cost at period end. Getting it wrong strands the cost. Allowed: cost_collector asset_under_construction billable statistical investment |
account_id | uuid | No | Customer |
opportunity_id | uuid | No | Opportunity |
rev_contract_id | uuid | No | Revenue contract |
manager_employee_id | uuid | No | Project manager |
sponsor_employee_id | uuid | No | Sponsor |
cost_center_id | uuid | No | Cost center |
profit_center_id | uuid | No | Profit center |
baseline_start | date | No | Baseline start |
baseline_end | date | No | Baseline end — What was promised. A project that keeps only the current plan cannot show slippage. |
planned_start | date | No | Planned start |
planned_end | date | No | Planned end |
actual_start | date | No | Actual start |
actual_end | date | No | Actual end |
currency | text | No | Currency |
budget_amount | numeric | No | Budget |
approved_amount | numeric | No | Approved |
contract_value | numeric | No | Contract value |
estimate_at_completion | numeric | No | Estimate at completion |
estimate_to_complete | numeric | No | Estimate to complete |
percent_complete | numeric | No | Percent complete |
progress_method | text | No | Progress method Allowed: Cost to cost Effort (hours) Milestones Units completed Physical progress Entered by hand |
allow_direct_postings | boolean | No | Accepts postings at header level — On a real project it should not: a header that takes cost grows a bucket nobody analyses. |
settlement_receiver_type | text | No | Settlement receiver type |
settlement_receiver_id | uuid | No | Settlement receiver id |
asset_id | uuid | No | Asset under construction |
health | text | No | Health Allowed: green amber red |
priority | text | No | Priority Allowed: critical high medium low |
risk_level | text | No | Risk level Allowed: high medium low |
description | text | No | Description |
notes | text | No | Notes |
Sample body
{
"name": "Example",
"program_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"project_no": "PRO-000001",
"name": "Example",
"program_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"portfolio_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"parent_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"project_type": "text",
"cost_object_type": "cost_collector",
"account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"opportunity_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"rev_contract_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"manager_employee_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"sponsor_employee_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}Sample request
curl -X PUT "https://demo.tranxact.ai/api/accounting/projects/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"name":"Example","program_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"}'DELETE/api/accounting/projects/{id}Delete a project
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/projects/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/accounting/projects/{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/projects/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/projects/{id}/planPlan
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Response
200 with the data as JSON.
Sample request
curl "https://demo.tranxact.ai/api/accounting/projects/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/plan" \
-H "Authorization: Bearer $TOKEN"POST/api/accounting/projects/{id}/scheduleSchedule
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (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/projects/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/schedule" \
-H "Authorization: Bearer $TOKEN"POST/api/accounting/projects/{id}/progressProgress
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):
method, estimateToComplete, estimateAtCompletionResponse
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/projects/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/progress" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"method":"value","estimateToComplete":"value","estimateAtCompletion":"value"}'POST/api/accounting/projects/{id}/chargeCharge
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):
sourceRef, post, fundId, grantId, creditAccountNo, wbsElementId, activityId, valueType, amount, description, accountNo, hours, employeeId, supplierId, itemId, postingDate, isBillable, override; valueType one of plan|commitment|actual|statistical|revenue|billed|accrual|settlementResponse
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/projects/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/charge" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"sourceRef":"value","post":"value","fundId":"value","grantId":"value","creditAccountNo":"value","wbsElementId":"value"}'POST/api/accounting/projects/{id}/settle-to-assetSettle to asset
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):
usefulLifeMonths, assetAccountNo, aucAccountNo, assetId, inServiceDate, assetName, assetClassIdResponse
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/projects/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/settle-to-asset" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"usefulLifeMonths":"value","assetAccountNo":"value","aucAccountNo":"value","assetId":"value","inServiceDate":"value","assetName":"value"}'GET/api/accounting/projects/{id}/cost-reportCost report
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Response
200 with the data as JSON.
Sample request
curl "https://demo.tranxact.ai/api/accounting/projects/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/cost-report" \
-H "Authorization: Bearer $TOKEN"POST/api/accounting/projects/{id}/approveApprove
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):
approvedAmountResponse
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/projects/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/approve" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"approvedAmount":"value"}'POST/api/accounting/projects/{id}/releaseRelease
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):
releaseWbsResponse
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/projects/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/release" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"releaseWbs":"value"}'POST/api/accounting/projects/{id}/startStart
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):
actualStartResponse
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/projects/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/start" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"actualStart":"value"}'POST/api/accounting/projects/{id}/holdHold
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):
reasonResponse
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/projects/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/hold" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"reason":"value"}'POST/api/accounting/projects/{id}/resumeResume
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (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/projects/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/resume" \
-H "Authorization: Bearer $TOKEN"POST/api/accounting/projects/{id}/completeComplete
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):
actualEndResponse
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/projects/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/complete" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"actualEnd":"value"}'POST/api/accounting/projects/{id}/closeClose
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (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/projects/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/close" \
-H "Authorization: Bearer $TOKEN"POST/api/accounting/projects/{id}/cancelCancel
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):
reasonResponse
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/projects/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/cancel" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"reason":"value"}'Data model
Every field of a project, 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 |
org_unit_id | uuid | read only | Org unit id |
project_no | text | read only | Project no |
name | text | read, write | Name |
program_id | uuid | read, write | Program |
portfolio_id | uuid | read, write | Portfolio |
parent_id | uuid | read, write | Parent project |
project_type | text | read, write | Type |
cost_object_type | text | read, write | Cost object — Decides what settlement does with the cost at period end. Getting it wrong strands the cost. Allowed: cost_collector asset_under_construction billable statistical investment |
account_id | uuid | read, write | Customer |
opportunity_id | uuid | read, write | Opportunity |
rev_contract_id | uuid | read, write | Revenue contract |
manager_employee_id | uuid | read, write | Project manager |
sponsor_employee_id | uuid | read, write | Sponsor |
cost_center_id | uuid | read, write | Cost center |
profit_center_id | uuid | read, write | Profit center |
baseline_start | date | read, write | Baseline start |
baseline_end | date | read, write | Baseline end — What was promised. A project that keeps only the current plan cannot show slippage. |
planned_start | date | read, write | Planned start |
planned_end | date | read, write | Planned end |
actual_start | date | read, write | Actual start |
actual_end | date | read, write | Actual end |
currency | text | read, write | Currency |
budget_amount | numeric | read, write | Budget |
approved_amount | numeric | read, write | Approved |
contract_value | numeric | read, write | Contract value |
estimate_at_completion | numeric | read, write | Estimate at completion |
estimate_to_complete | numeric | read, write | Estimate to complete |
percent_complete | numeric | read, write | Percent complete |
progress_method | text | read, write | Progress method Allowed: Cost to cost Effort (hours) Milestones Units completed Physical progress Entered by hand |
allow_direct_postings | boolean | read, write | Accepts postings at header level — On a real project it should not: a header that takes cost grows a bucket nobody analyses. |
settlement_receiver_type | text | read, write | Settlement receiver type |
settlement_receiver_id | uuid | read, write | Settlement receiver id |
asset_id | uuid | read, write | Asset under construction |
status | text | read only | Status |
health | text | read, write | Health Allowed: green amber red |
priority | text | read, write | Priority Allowed: critical high medium low |
risk_level | text | read, write | Risk level Allowed: high medium low |
approved_by | uuid | read only | Approved by |
approved_at | timestamp with time zone | read only | Approved at |
closed_at | timestamp with time zone | read only | Closed at |
description | text | read, write | Description |
notes | text | read, write | Notes |
created_by | uuid | read only | Created by |
created_at | timestamp with time zone | read only | Created at |
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 |
updated_at | timestamp with time zone | read only | Updated at |
updated_by | uuid | read only | Updated by |
released_at | timestamp with time zone | read only | Released at |
released_by | uuid | read only | Released by |
status_reason | text | read only | Status reason |
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 › Projects 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.