TRANXACT.AI Help

Accounting · Contract Costing

Results Analysis

Percentage of completion, the revenue it entitles the company to, and what has to be accrued or deferred so the profit lands in the right month rather than all at the end.

Type REST7 operationsBase path /api/accounting/results-analysisPublished as /api/v1/results-analysis

Download specification (OpenAPI 3.1) Screen: Results Analysis

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 › Results Analysis 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.results_analysis · 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

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

GET/api/accounting/results-analysisList results analysis

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",
      "contract_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "wbs_element_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "period_code": "PER-000001",
      "as_of_date": "2026-10-30",
      "method": "text",
      "contract_revenue": "1250.00",
      "cost_to_date": "1250.00",
      "estimate_to_complete": "1250.00",
      "estimate_at_completion": "1250.00",
      "percent_complete": "1250.00",
      "earned_revenue": "1250.00"
    }
  ],
  "count": 1
}

Sample request

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

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",
  "contract_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "wbs_element_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "period_code": "PER-000001",
  "as_of_date": "2026-10-30",
  "method": "text",
  "contract_revenue": "1250.00",
  "cost_to_date": "1250.00",
  "estimate_to_complete": "1250.00",
  "estimate_at_completion": "1250.00",
  "percent_complete": "1250.00",
  "earned_revenue": "1250.00"
}

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

Sample request

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

Request body

The record as JSON. Fields marked Yes are required.

No body.

Sample body

{}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "project_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "contract_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "wbs_element_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "period_code": "PER-000001",
  "as_of_date": "2026-10-30",
  "method": "text",
  "contract_revenue": "1250.00",
  "cost_to_date": "1250.00",
  "estimate_to_complete": "1250.00",
  "estimate_at_completion": "1250.00",
  "percent_complete": "1250.00",
  "earned_revenue": "1250.00"
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/accounting/results-analysis" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{}'
PUT/api/accounting/results-analysis/{id}Change a results analysis

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.

No body.

Sample body

{}

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "project_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "contract_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "wbs_element_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "period_code": "PER-000001",
  "as_of_date": "2026-10-30",
  "method": "text",
  "contract_revenue": "1250.00",
  "cost_to_date": "1250.00",
  "estimate_to_complete": "1250.00",
  "estimate_at_completion": "1250.00",
  "percent_complete": "1250.00",
  "earned_revenue": "1250.00"
}

Sample request

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

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

Request body

The keys this action reads (* = required; "one of" lists the only values):

periodCode, contractId

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/results-analysis/run" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"periodCode":"value","contractId":"value"}'

Data model

Every field of a results analysis, 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 onlyProject id
contract_iduuidread onlyContract id
wbs_element_iduuidread onlyWbs element id
period_codetextread onlyPeriod code
as_of_datedateread onlyAs of date
methodtextread onlyMethod
contract_revenuenumericread onlyContract revenue
cost_to_datenumericread onlyCost to date
estimate_to_completenumericread onlyEstimate to complete
estimate_at_completionnumericread onlyEstimate at completion
percent_completenumericread onlyPercent complete
earned_revenuenumericread onlyEarned revenue
billed_revenuenumericread onlyBilled revenue
revenue_in_excess_of_billingsnumericread onlyRevenue in excess of billings
billings_in_excess_of_revenuenumericread onlyBillings in excess of revenue
recognised_costnumericread onlyRecognised cost
wip_amountnumericread onlyWip amount
accrued_revenuenumericread onlyAccrued revenue
deferred_revenuenumericread onlyDeferred revenue
profitnumericread onlyProfit
margin_pctnumericread onlyMargin pct
expected_lossnumericread onlyExpected loss
loss_provisionnumericread onlyLoss provision
is_loss_makingbooleanread onlyIs loss making
journal_iduuidread onlyJournal id
statustextread onlyStatus
calculated_attimestamp with time zoneread onlyCalculated at
notestextread onlyNotes
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 › Results Analysis 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.