TRANXACT.AI Help

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.

Type REST20 operationsBase path /api/accounting/projectsPublished as /api/v1/projects

Download specification (OpenAPI 3.1) Screen: Projects

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 › 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.
Tableacct.projects · 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

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

GET/api/accounting/projectsList projects

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_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

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_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.

FieldTypeRequiredDescription
nametextYesName
program_iduuidNoProgram
portfolio_iduuidNoPortfolio
parent_iduuidNoParent project
project_typetextNoType
cost_object_typetextNoCost 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_iduuidNoCustomer
opportunity_iduuidNoOpportunity
rev_contract_iduuidNoRevenue contract
manager_employee_iduuidNoProject manager
sponsor_employee_iduuidNoSponsor
cost_center_iduuidNoCost center
profit_center_iduuidNoProfit center
baseline_startdateNoBaseline start
baseline_enddateNoBaseline end — What was promised. A project that keeps only the current plan cannot show slippage.
planned_startdateNoPlanned start
planned_enddateNoPlanned end
actual_startdateNoActual start
actual_enddateNoActual end
currencytextNoCurrency
budget_amountnumericNoBudget
approved_amountnumericNoApproved
contract_valuenumericNoContract value
estimate_at_completionnumericNoEstimate at completion
estimate_to_completenumericNoEstimate to complete
percent_completenumericNoPercent complete
progress_methodtextNoProgress method
Allowed: Cost to cost Effort (hours) Milestones Units completed Physical progress Entered by hand
allow_direct_postingsbooleanNoAccepts postings at header level — On a real project it should not: a header that takes cost grows a bucket nobody analyses.
settlement_receiver_typetextNoSettlement receiver type
settlement_receiver_iduuidNoSettlement receiver id
asset_iduuidNoAsset under construction
healthtextNoHealth
Allowed: green amber red
prioritytextNoPriority
Allowed: critical high medium low
risk_leveltextNoRisk level
Allowed: high medium low
descriptiontextNoDescription
notestextNoNotes

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

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
nametextYesName
program_iduuidNoProgram
portfolio_iduuidNoPortfolio
parent_iduuidNoParent project
project_typetextNoType
cost_object_typetextNoCost 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_iduuidNoCustomer
opportunity_iduuidNoOpportunity
rev_contract_iduuidNoRevenue contract
manager_employee_iduuidNoProject manager
sponsor_employee_iduuidNoSponsor
cost_center_iduuidNoCost center
profit_center_iduuidNoProfit center
baseline_startdateNoBaseline start
baseline_enddateNoBaseline end — What was promised. A project that keeps only the current plan cannot show slippage.
planned_startdateNoPlanned start
planned_enddateNoPlanned end
actual_startdateNoActual start
actual_enddateNoActual end
currencytextNoCurrency
budget_amountnumericNoBudget
approved_amountnumericNoApproved
contract_valuenumericNoContract value
estimate_at_completionnumericNoEstimate at completion
estimate_to_completenumericNoEstimate to complete
percent_completenumericNoPercent complete
progress_methodtextNoProgress method
Allowed: Cost to cost Effort (hours) Milestones Units completed Physical progress Entered by hand
allow_direct_postingsbooleanNoAccepts postings at header level — On a real project it should not: a header that takes cost grows a bucket nobody analyses.
settlement_receiver_typetextNoSettlement receiver type
settlement_receiver_iduuidNoSettlement receiver id
asset_iduuidNoAsset under construction
healthtextNoHealth
Allowed: green amber red
prioritytextNoPriority
Allowed: critical high medium low
risk_leveltextNoRisk level
Allowed: high medium low
descriptiontextNoDescription
notestextNoNotes

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

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

NameTypeDescription
idstring (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

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/projects/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/schedule" \
  -H "Authorization: Bearer $TOKEN"
POST/api/accounting/projects/{id}/progressProgress

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):

method, estimateToComplete, estimateAtCompletion

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/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

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):

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|settlement

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/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

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):

usefulLifeMonths, assetAccountNo, aucAccountNo, assetId, inServiceDate, assetName, assetClassId

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/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

NameTypeDescription
idstring (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

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):

approvedAmount

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/approve" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"approvedAmount":"value"}'
POST/api/accounting/projects/{id}/releaseRelease

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):

releaseWbs

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/release" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"releaseWbs":"value"}'
POST/api/accounting/projects/{id}/startStart

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):

actualStart

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/start" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"actualStart":"value"}'
POST/api/accounting/projects/{id}/holdHold

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):

reason

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/hold" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"reason":"value"}'
POST/api/accounting/projects/{id}/resumeResume

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/projects/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/resume" \
  -H "Authorization: Bearer $TOKEN"
POST/api/accounting/projects/{id}/completeComplete

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):

actualEnd

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/complete" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"actualEnd":"value"}'
POST/api/accounting/projects/{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/projects/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/close" \
  -H "Authorization: Bearer $TOKEN"
POST/api/accounting/projects/{id}/cancelCancel

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):

reason

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/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.

FieldTypeAccessDescription
iduuidread onlyId
org_iduuidread onlyOrg id
org_unit_iduuidread onlyOrg unit id
project_notextread onlyProject no
nametextread, writeName
program_iduuidread, writeProgram
portfolio_iduuidread, writePortfolio
parent_iduuidread, writeParent project
project_typetextread, writeType
cost_object_typetextread, writeCost 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_iduuidread, writeCustomer
opportunity_iduuidread, writeOpportunity
rev_contract_iduuidread, writeRevenue contract
manager_employee_iduuidread, writeProject manager
sponsor_employee_iduuidread, writeSponsor
cost_center_iduuidread, writeCost center
profit_center_iduuidread, writeProfit center
baseline_startdateread, writeBaseline start
baseline_enddateread, writeBaseline end — What was promised. A project that keeps only the current plan cannot show slippage.
planned_startdateread, writePlanned start
planned_enddateread, writePlanned end
actual_startdateread, writeActual start
actual_enddateread, writeActual end
currencytextread, writeCurrency
budget_amountnumericread, writeBudget
approved_amountnumericread, writeApproved
contract_valuenumericread, writeContract value
estimate_at_completionnumericread, writeEstimate at completion
estimate_to_completenumericread, writeEstimate to complete
percent_completenumericread, writePercent complete
progress_methodtextread, writeProgress method
Allowed: Cost to cost Effort (hours) Milestones Units completed Physical progress Entered by hand
allow_direct_postingsbooleanread, writeAccepts postings at header level — On a real project it should not: a header that takes cost grows a bucket nobody analyses.
settlement_receiver_typetextread, writeSettlement receiver type
settlement_receiver_iduuidread, writeSettlement receiver id
asset_iduuidread, writeAsset under construction
statustextread onlyStatus
healthtextread, writeHealth
Allowed: green amber red
prioritytextread, writePriority
Allowed: critical high medium low
risk_leveltextread, writeRisk level
Allowed: high medium low
approved_byuuidread onlyApproved by
approved_attimestamp with time zoneread onlyApproved at
closed_attimestamp with time zoneread onlyClosed at
descriptiontextread, writeDescription
notestextread, writeNotes
created_byuuidread onlyCreated by
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
updated_attimestamp with time zoneread onlyUpdated at
updated_byuuidread onlyUpdated by
released_attimestamp with time zoneread onlyReleased at
released_byuuidread onlyReleased by
status_reasontextread onlyStatus reason

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 › Projects 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.