TRANXACT.AI Help

Accounting · Treasury

Cash Forecast Lines

Confidence is the difference between a forecast and a wish: a receivable from a customer who has never paid late is 95%, a sale that has not been signed is 30%.

Type REST6 operationsBase path /api/accounting/forecast-linesPublished as /api/v1/forecast-lines

Download specification (OpenAPI 3.1) Screen: Cash Forecast Lines

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 Lines 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.forecast_lines · 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/forecast-linesList cash forecast lines

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_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "line_no": 10,
      "liquidity_item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "bank_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "expected_date": "2026-10-30",
      "period_bucket": "text",
      "direction": "inflow",
      "description": "text",
      "currency": "USD",
      "amount": "1250.00",
      "base_amount": "1250.00",
      "exchange_rate": "1250.00"
    }
  ],
  "count": 1
}

Sample request

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

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_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "line_no": 10,
  "liquidity_item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "bank_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "expected_date": "2026-10-30",
  "period_bucket": "text",
  "direction": "inflow",
  "description": "text",
  "currency": "USD",
  "amount": "1250.00",
  "base_amount": "1250.00",
  "exchange_rate": "1250.00"
}

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

Sample request

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

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
forecast_iduuidYesForecast
line_nointegerYesLine
liquidity_item_iduuidNoCategory
bank_account_iduuidNoBank account id
expected_datedateYesExpected date
period_buckettextNoPeriod bucket
directiontextYesDirection
Allowed: inflow outflow
descriptiontextNoDescription
currencytextNoCurrency
amountnumericNoAmount
base_amountnumericNoBase amount
exchange_ratenumericNoExchange rate
confidence_pctnumericNoConfidence %
contractual_datedateNoContractual date
delay_daysintegerNoDelay days
source_typetextNoSource type
source_iduuidNoSource id
source_reftextNoSource ref
account_iduuidNoAccount id
supplier_iduuidNoSupplier id
is_committedbooleanNoCommitted
is_manualbooleanNoEntered by hand
actual_datedateNoActual date
actual_amountnumericNoActual amount
variance_daysintegerNoVariance days

Sample body

{
  "forecast_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "line_no": 10,
  "expected_date": "2026-10-30",
  "direction": "inflow",
  "liquidity_item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "bank_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "period_bucket": "text",
  "description": "text"
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "forecast_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "line_no": 10,
  "liquidity_item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "bank_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "expected_date": "2026-10-30",
  "period_bucket": "text",
  "direction": "inflow",
  "description": "text",
  "currency": "USD",
  "amount": "1250.00",
  "base_amount": "1250.00",
  "exchange_rate": "1250.00"
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/accounting/forecast-lines" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"forecast_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","line_no":10,"expected_date":"2026-10-30","direction":"inflow","liquidity_item_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","bank_account_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","period_bucket":"text","description":"text"}'
PUT/api/accounting/forecast-lines/{id}Change a forecast line

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
forecast_iduuidYesForecast
line_nointegerYesLine
liquidity_item_iduuidNoCategory
bank_account_iduuidNoBank account id
expected_datedateYesExpected date
period_buckettextNoPeriod bucket
directiontextYesDirection
Allowed: inflow outflow
descriptiontextNoDescription
currencytextNoCurrency
amountnumericNoAmount
base_amountnumericNoBase amount
exchange_ratenumericNoExchange rate
confidence_pctnumericNoConfidence %
contractual_datedateNoContractual date
delay_daysintegerNoDelay days
source_typetextNoSource type
source_iduuidNoSource id
source_reftextNoSource ref
account_iduuidNoAccount id
supplier_iduuidNoSupplier id
is_committedbooleanNoCommitted
is_manualbooleanNoEntered by hand
actual_datedateNoActual date
actual_amountnumericNoActual amount
variance_daysintegerNoVariance days

Sample body

{
  "forecast_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "line_no": 10
}

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "forecast_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "line_no": 10,
  "liquidity_item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "bank_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "expected_date": "2026-10-30",
  "period_bucket": "text",
  "direction": "inflow",
  "description": "text",
  "currency": "USD",
  "amount": "1250.00",
  "base_amount": "1250.00",
  "exchange_rate": "1250.00"
}

Sample request

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

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/forecast-lines/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/accounting/forecast-lines/{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/forecast-lines/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 forecast line, 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_iduuidread, writeForecast
line_nointegerread, writeLine
liquidity_item_iduuidread, writeCategory
bank_account_iduuidread, writeBank account id
expected_datedateread, writeExpected date
period_buckettextread, writePeriod bucket
directiontextread, writeDirection
Allowed: inflow outflow
descriptiontextread, writeDescription
currencytextread, writeCurrency
amountnumericread, writeAmount
base_amountnumericread, writeBase amount
exchange_ratenumericread, writeExchange rate
confidence_pctnumericread, writeConfidence %
weighted_amountnumericread onlyWeighted amount
contractual_datedateread, writeContractual date
delay_daysintegerread, writeDelay days
source_typetextread, writeSource type
source_iduuidread, writeSource id
source_reftextread, writeSource ref
account_iduuidread, writeAccount id
supplier_iduuidread, writeSupplier id
is_committedbooleanread, writeCommitted
is_manualbooleanread, writeEntered by hand
actual_datedateread, writeActual date
actual_amountnumericread, writeActual amount
variance_daysintegerread, writeVariance days
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 › Cash Forecast Lines 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.