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%.
/api/accounting/forecast-linesPublished as /api/v1/forecast-linesDownload specification (OpenAPI 3.1) Screen: Cash Forecast Lines
Overview
| Package | Accounting |
|---|---|
| Authentication | Bearer token: a service account's token (POST /api/auth/service-token) or, for the published path, an API key |
| Authorization | The 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. |
| Table | acct.forecast_lines · kept per company (and organisational unit where it has one) |
| Record | Created, changed and (where the screen allows) deleted; key id |
| Rules | The 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
| Name | Description | Example |
|---|---|---|
limit | Rows per page (50 by default, at most 200) | limit=100 |
offset | Rows to skip | offset=200 |
q | Free-text search over the search columns | q=acme |
sort | column:asc or column:desc, several separated by commas | sort=created_at:desc |
filter | A JSON condition or group (see the filter language), URL-encoded; any field below can be filtered and sorted | filter={"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
| Name | Type | Description |
|---|---|---|
id | string (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.
| Field | Type | Required | Description |
|---|---|---|---|
forecast_id | uuid | Yes | Forecast |
line_no | integer | Yes | Line |
liquidity_item_id | uuid | No | Category |
bank_account_id | uuid | No | Bank account id |
expected_date | date | Yes | Expected date |
period_bucket | text | No | Period bucket |
direction | text | Yes | Direction Allowed: inflow outflow |
description | text | No | Description |
currency | text | No | Currency |
amount | numeric | No | Amount |
base_amount | numeric | No | Base amount |
exchange_rate | numeric | No | Exchange rate |
confidence_pct | numeric | No | Confidence % |
contractual_date | date | No | Contractual date |
delay_days | integer | No | Delay days |
source_type | text | No | Source type |
source_id | uuid | No | Source id |
source_ref | text | No | Source ref |
account_id | uuid | No | Account id |
supplier_id | uuid | No | Supplier id |
is_committed | boolean | No | Committed |
is_manual | boolean | No | Entered by hand |
actual_date | date | No | Actual date |
actual_amount | numeric | No | Actual amount |
variance_days | integer | No | Variance 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
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
Only the fields to change; fields left out keep their value.
| Field | Type | Required | Description |
|---|---|---|---|
forecast_id | uuid | Yes | Forecast |
line_no | integer | Yes | Line |
liquidity_item_id | uuid | No | Category |
bank_account_id | uuid | No | Bank account id |
expected_date | date | Yes | Expected date |
period_bucket | text | No | Period bucket |
direction | text | Yes | Direction Allowed: inflow outflow |
description | text | No | Description |
currency | text | No | Currency |
amount | numeric | No | Amount |
base_amount | numeric | No | Base amount |
exchange_rate | numeric | No | Exchange rate |
confidence_pct | numeric | No | Confidence % |
contractual_date | date | No | Contractual date |
delay_days | integer | No | Delay days |
source_type | text | No | Source type |
source_id | uuid | No | Source id |
source_ref | text | No | Source ref |
account_id | uuid | No | Account id |
supplier_id | uuid | No | Supplier id |
is_committed | boolean | No | Committed |
is_manual | boolean | No | Entered by hand |
actual_date | date | No | Actual date |
actual_amount | numeric | No | Actual amount |
variance_days | integer | No | Variance 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
| Name | Type | Description |
|---|---|---|
id | string (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
| Name | Type | Description |
|---|---|---|
id | string (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, withLinesResponse
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.
| Field | Type | Access | Description |
|---|---|---|---|
id | uuid | read only | Id |
org_id | uuid | read only | Org id |
org_unit_id | uuid | read only | Org unit id |
forecast_id | uuid | read, write | Forecast |
line_no | integer | read, write | Line |
liquidity_item_id | uuid | read, write | Category |
bank_account_id | uuid | read, write | Bank account id |
expected_date | date | read, write | Expected date |
period_bucket | text | read, write | Period bucket |
direction | text | read, write | Direction Allowed: inflow outflow |
description | text | read, write | Description |
currency | text | read, write | Currency |
amount | numeric | read, write | Amount |
base_amount | numeric | read, write | Base amount |
exchange_rate | numeric | read, write | Exchange rate |
confidence_pct | numeric | read, write | Confidence % |
weighted_amount | numeric | read only | Weighted amount |
contractual_date | date | read, write | Contractual date |
delay_days | integer | read, write | Delay days |
source_type | text | read, write | Source type |
source_id | uuid | read, write | Source id |
source_ref | text | read, write | Source ref |
account_id | uuid | read, write | Account id |
supplier_id | uuid | read, write | Supplier id |
is_committed | boolean | read, write | Committed |
is_manual | boolean | read, write | Entered by hand |
actual_date | date | read, write | Actual date |
actual_amount | numeric | read, write | Actual amount |
variance_days | integer | read, write | Variance days |
xf_text_1 | text | read only | Xf text 1 |
xf_text_2 | text | read only | Xf text 2 |
xf_text_3 | text | read only | Xf text 3 |
xf_text_4 | text | read only | Xf text 4 |
xf_text_5 | text | read only | Xf text 5 |
xf_num_1 | numeric | read only | Xf num 1 |
xf_num_2 | numeric | read only | Xf num 2 |
xf_num_3 | numeric | read only | Xf num 3 |
xf_date_1 | date | read only | Xf date 1 |
xf_date_2 | date | read only | Xf date 2 |
created_at | timestamp with time zone | read only | Created at |
created_by | uuid | read only | Created by |
updated_at | timestamp with time zone | read only | Updated at |
updated_by | uuid | read only | Updated by |
Errors
| Status | Meaning |
|---|---|
| 400 | The request could not be read: a filter that is not JSON, a bad parameter |
| 401 | No credential, or it is wrong, revoked or expired |
| 403 | The caller's roles do not hold Accounting › Cash Forecast Lines for this verb, or the address or origin is not allowed |
| 404 | No record with that id is visible to the caller |
| 409 | A conflict: a duplicate number, a document in a state that does not allow it, or a record changed or locked by someone else |
| 422 | Refused 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.