TRANXACT.AI Help

Accounting · Treasury

Cash Forecast

Receivables at their EXPECTED date, payables at the chosen one, payroll, tax and debt service. Versioned, because accuracy cannot be measured without keeping the forecasts that were wrong.

Type REST10 operationsBase path /api/accounting/cash-forecastsPublished as /api/v1/cash-forecasts

Download specification (OpenAPI 3.1) Screen: Cash Forecast

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 › Cash Forecast 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.cash_forecasts · 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

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

GET/api/accounting/cash-forecastsList cash forecast

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",
      "forecast_no": "FOR-000001",
      "name": "Example",
      "version": 10,
      "supersedes_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "as_of_date": "2026-10-30",
      "horizon_from": "2026-10-30",
      "horizon_to": "2026-10-30",
      "grain": "text",
      "currency": "USD",
      "scenario": "text",
      "collection_delay_days": 10,
      "payment_delay_days": 10
    }
  ],
  "count": 1
}

Sample request

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

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",
  "forecast_no": "FOR-000001",
  "name": "Example",
  "version": 10,
  "supersedes_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "as_of_date": "2026-10-30",
  "horizon_from": "2026-10-30",
  "horizon_to": "2026-10-30",
  "grain": "text",
  "currency": "USD",
  "scenario": "text",
  "collection_delay_days": 10,
  "payment_delay_days": 10
}

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

Sample request

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

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
nametextYesName
as_of_datedateNoAs of date
horizon_fromdateYesHorizon from
horizon_todateYesHorizon to
graintextNoGrain
currencytextNoCurrency
scenariotextNoScenario
collection_delay_daysintegerNoCollection delay days
payment_delay_daysintegerNoPayment delay days
revenue_shift_pctnumericNoRevenue shift pct
fx_shift_pctnumericNoFx shift pct
opening_balancenumericNoOpening balance
notestextNoNotes

Sample body

{
  "name": "Example",
  "horizon_from": "2026-10-30",
  "horizon_to": "2026-10-30",
  "as_of_date": "2026-10-30",
  "grain": "text",
  "currency": "USD",
  "scenario": "text"
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "forecast_no": "FOR-000001",
  "name": "Example",
  "version": 10,
  "supersedes_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "as_of_date": "2026-10-30",
  "horizon_from": "2026-10-30",
  "horizon_to": "2026-10-30",
  "grain": "text",
  "currency": "USD",
  "scenario": "text",
  "collection_delay_days": 10,
  "payment_delay_days": 10
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/accounting/cash-forecasts" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name":"Example","horizon_from":"2026-10-30","horizon_to":"2026-10-30","as_of_date":"2026-10-30","grain":"text","currency":"USD","scenario":"text"}'
PUT/api/accounting/cash-forecasts/{id}Change a cash forecast

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
as_of_datedateNoAs of date
horizon_fromdateYesHorizon from
horizon_todateYesHorizon to
graintextNoGrain
currencytextNoCurrency
scenariotextNoScenario
collection_delay_daysintegerNoCollection delay days
payment_delay_daysintegerNoPayment delay days
revenue_shift_pctnumericNoRevenue shift pct
fx_shift_pctnumericNoFx shift pct
opening_balancenumericNoOpening balance
notestextNoNotes

Sample body

{
  "name": "Example",
  "horizon_from": "2026-10-30"
}

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "forecast_no": "FOR-000001",
  "name": "Example",
  "version": 10,
  "supersedes_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "as_of_date": "2026-10-30",
  "horizon_from": "2026-10-30",
  "horizon_to": "2026-10-30",
  "grain": "text",
  "currency": "USD",
  "scenario": "text",
  "collection_delay_days": 10,
  "payment_delay_days": 10
}

Sample request

curl -X PUT "https://demo.tranxact.ai/api/accounting/cash-forecasts/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name":"Example","horizon_from":"2026-10-30"}'
DELETE/api/accounting/cash-forecasts/{id}Delete a cash forecast

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

Path parameters

NameTypeDescription
parentIdstring (uuid)The record's parentId, as a list returns it.

Response

200 with the data as JSON.

Sample request

curl "https://demo.tranxact.ai/api/accounting/cash-forecasts/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/lines" \
  -H "Authorization: Bearer $TOKEN"
POST/api/accounting/cash-forecasts/{parentId}/linesLines

Path parameters

NameTypeDescription
parentIdstring (uuid)The record's parentId, 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/cash-forecasts/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/lines" \
  -H "Authorization: Bearer $TOKEN"
PUT/api/accounting/cash-forecasts/{parentId}/lines/{lineId}Lines

Path parameters

NameTypeDescription
parentIdstring (uuid)The record's parentId, as a list returns it.
lineIdstring (uuid)The record's lineId, 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 PUT "https://demo.tranxact.ai/api/accounting/cash-forecasts/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/lines/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
DELETE/api/accounting/cash-forecasts/{parentId}/lines/{lineId}Lines

Path parameters

NameTypeDescription
parentIdstring (uuid)The record's parentId, as a list returns it.
lineIdstring (uuid)The record's lineId, 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 DELETE "https://demo.tranxact.ai/api/accounting/cash-forecasts/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/lines/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"

Data model

Every field of a cash forecast, 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
forecast_notextread onlyForecast no
nametextread, writeName
versionintegerread onlyVersion
supersedes_iduuidread onlySupersedes id
as_of_datedateread, writeAs of date
horizon_fromdateread, writeHorizon from
horizon_todateread, writeHorizon to
graintextread, writeGrain
currencytextread, writeCurrency
scenariotextread, writeScenario
collection_delay_daysintegerread, writeCollection delay days
payment_delay_daysintegerread, writePayment delay days
revenue_shift_pctnumericread, writeRevenue shift pct
fx_shift_pctnumericread, writeFx shift pct
opening_balancenumericread, writeOpening balance
total_inflownumericread onlyTotal inflow
total_outflownumericread onlyTotal outflow
closing_balancenumericread onlyClosing balance
minimum_balancenumericread onlyMinimum balance
minimum_datedateread onlyMinimum date
has_shortfallbooleanread onlyHas shortfall
shortfall_amountnumericread onlyShortfall amount
statustextread onlyStatus
accuracy_pctnumericread onlyAccuracy pct
calculated_attimestamp with time zoneread onlyCalculated at
created_byuuidread onlyCreated by
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
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 › Cash Forecast 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.