TRANXACT.AI Help

Accounting · Projects & Portfolios

Risks & Issues

The exposure in money, so a risk register can be added up and compared with the contingency held.

Type REST6 operationsBase path /api/accounting/project-risksPublished as /api/v1/project-risks

Download specification (OpenAPI 3.1) Screen: Risks & Issues

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 › Risks & Issues 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.project_risks · 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

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

GET/api/accounting/project-risksList risks & issues

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",
      "wbs_element_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "risk_no": "RIS-000001",
      "title": "Example",
      "category": "text",
      "risk_type": "risk",
      "probability": "very_high",
      "impact": "very_high",
      "exposure_amount": "1250.00",
      "probability_pct": "1250.00",
      "expected_value": "1250.00",
      "mitigation": "text"
    }
  ],
  "count": 1
}

Sample request

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

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",
  "wbs_element_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "risk_no": "RIS-000001",
  "title": "Example",
  "category": "text",
  "risk_type": "risk",
  "probability": "very_high",
  "impact": "very_high",
  "exposure_amount": "1250.00",
  "probability_pct": "1250.00",
  "expected_value": "1250.00",
  "mitigation": "text"
}

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

Sample request

curl "https://demo.tranxact.ai/api/accounting/project-risks/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/accounting/project-risksCreate a project risk

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
project_iduuidYesProject
wbs_element_iduuidNoWork breakdown element
risk_notextYesNumber
titletextYesTitle
categorytextNoCategory
risk_typetextNoType
Allowed: risk issue assumption dependency change_request
probabilitytextNoProbability
Allowed: very_high high medium low very_low
impacttextNoImpact
Allowed: very_high high medium low very_low
exposure_amountnumericNoExposure
probability_pctnumericNoProbability %
mitigationtextNoMitigation
owner_employee_iduuidNoOwner
due_datedateNoDue
raised_atdateNoRaised
closed_atdateNoClosed at
notestextNoNotes

Sample body

{
  "project_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "risk_no": "RIS-000001",
  "title": "Example",
  "wbs_element_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "category": "text",
  "risk_type": "risk",
  "probability": "very_high"
}

Response 201

{
  "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",
  "risk_no": "RIS-000001",
  "title": "Example",
  "category": "text",
  "risk_type": "risk",
  "probability": "very_high",
  "impact": "very_high",
  "exposure_amount": "1250.00",
  "probability_pct": "1250.00",
  "expected_value": "1250.00",
  "mitigation": "text"
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/accounting/project-risks" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"project_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","risk_no":"RIS-000001","title":"Example","wbs_element_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","category":"text","risk_type":"risk","probability":"very_high"}'
PUT/api/accounting/project-risks/{id}Change a project risk

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
wbs_element_iduuidNoWork breakdown element
risk_notextYesNumber
titletextYesTitle
categorytextNoCategory
risk_typetextNoType
Allowed: risk issue assumption dependency change_request
probabilitytextNoProbability
Allowed: very_high high medium low very_low
impacttextNoImpact
Allowed: very_high high medium low very_low
exposure_amountnumericNoExposure
probability_pctnumericNoProbability %
mitigationtextNoMitigation
owner_employee_iduuidNoOwner
due_datedateNoDue
raised_atdateNoRaised
closed_atdateNoClosed at
notestextNoNotes

Sample body

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

Response 200

{
  "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",
  "risk_no": "RIS-000001",
  "title": "Example",
  "category": "text",
  "risk_type": "risk",
  "probability": "very_high",
  "impact": "very_high",
  "exposure_amount": "1250.00",
  "probability_pct": "1250.00",
  "expected_value": "1250.00",
  "mitigation": "text"
}

Sample request

curl -X PUT "https://demo.tranxact.ai/api/accounting/project-risks/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"project_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","risk_no":"RIS-000001"}'
DELETE/api/accounting/project-risks/{id}Delete a project risk

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/project-risks/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/accounting/project-risks/{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/project-risks/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 project risk, 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
wbs_element_iduuidread, writeWork breakdown element
risk_notextread, writeNumber
titletextread, writeTitle
categorytextread, writeCategory
risk_typetextread, writeType
Allowed: risk issue assumption dependency change_request
probabilitytextread, writeProbability
Allowed: very_high high medium low very_low
impacttextread, writeImpact
Allowed: very_high high medium low very_low
exposure_amountnumericread, writeExposure
probability_pctnumericread, writeProbability %
expected_valuenumericread onlyExpected value
mitigationtextread, writeMitigation
owner_employee_iduuidread, writeOwner
due_datedateread, writeDue
statustextread onlyStatus
raised_atdateread, writeRaised
closed_atdateread, writeClosed at
notestextread, writeNotes
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_attimestamp with time zoneread onlyCreated at
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 › Risks & Issues 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.