Accounting · Finance Automation
Finance Automation Settings
The thresholds behind the finance jobs. What a job may DO with what it finds is the company's autonomy level for it (notify, approve or act); these say what counts as a finding.
/api/accounting/fin-automation-settingsPublished as /api/v1/fin-automation-settingsDownload specification (OpenAPI 3.1) Screen: Finance Automation Settings
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 › Finance Automation Settings 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.fin_automation_settings · 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/fin-automation-settingsList finance automation settings
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",
"cash_auto_apply_min": "1250.00",
"cash_suggest_min": "1250.00",
"cash_amount_tolerance": "1250.00",
"cash_tolerance_pct": "1250.00",
"pay_horizon_days": 10,
"pay_bank_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"credit_hold_after_days": 10,
"soft_close_roles": [],
"budget_variance_pct": "1250.00",
"cash_floor": "1250.00",
"forecast_horizon_days": 10,
"notes": "text"
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/accounting/fin-automation-settings?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/accounting/fin-automation-settings/{id}Read one finance automation settings
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",
"cash_auto_apply_min": "1250.00",
"cash_suggest_min": "1250.00",
"cash_amount_tolerance": "1250.00",
"cash_tolerance_pct": "1250.00",
"pay_horizon_days": 10,
"pay_bank_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"credit_hold_after_days": 10,
"soft_close_roles": [],
"budget_variance_pct": "1250.00",
"cash_floor": "1250.00",
"forecast_horizon_days": 10,
"notes": "text"
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/accounting/fin-automation-settings/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/accounting/fin-automation-settingsCreate a finance automation settings
Request body
The record as JSON. Fields marked Yes are required.
| Field | Type | Required | Description |
|---|---|---|---|
cash_auto_apply_min | numeric | No | Apply a cash match at or above (%) |
cash_suggest_min | numeric | No | Suggest a cash match at or above (%) |
cash_amount_tolerance | numeric | No | Amount tolerance — How far a payment may be from what is open and still be the amount. |
cash_tolerance_pct | numeric | No | Amount tolerance (% of open) |
pay_horizon_days | integer | No | Payment proposal: bills due within (days) |
pay_bank_account_id | uuid | No | Pay from |
credit_hold_after_days | integer | No | Credit hold after (days overdue) — Empty: no automatic credit hold. |
soft_close_roles | _text | No | Who may post into a soft-closed period — Role codes, separated by commas (e.g. controller). The administrator always may. |
budget_variance_pct | numeric | No | Budget alert over (%) |
cash_floor | numeric | No | Cash floor — Empty: no projected-cash alert. |
forecast_horizon_days | integer | No | Cash forecast horizon (days) |
notes | text | No | Notes |
Sample body
{
"cash_auto_apply_min": "1250.00",
"cash_suggest_min": "1250.00",
"cash_amount_tolerance": "1250.00",
"cash_tolerance_pct": "1250.00"
}Response 201
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"cash_auto_apply_min": "1250.00",
"cash_suggest_min": "1250.00",
"cash_amount_tolerance": "1250.00",
"cash_tolerance_pct": "1250.00",
"pay_horizon_days": 10,
"pay_bank_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"credit_hold_after_days": 10,
"soft_close_roles": [],
"budget_variance_pct": "1250.00",
"cash_floor": "1250.00",
"forecast_horizon_days": 10,
"notes": "text"
}Sample request
curl -X POST "https://demo.tranxact.ai/api/accounting/fin-automation-settings" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"cash_auto_apply_min":"1250.00","cash_suggest_min":"1250.00","cash_amount_tolerance":"1250.00","cash_tolerance_pct":"1250.00"}'PUT/api/accounting/fin-automation-settings/{id}Change a finance automation settings
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 |
|---|---|---|---|
cash_auto_apply_min | numeric | No | Apply a cash match at or above (%) |
cash_suggest_min | numeric | No | Suggest a cash match at or above (%) |
cash_amount_tolerance | numeric | No | Amount tolerance — How far a payment may be from what is open and still be the amount. |
cash_tolerance_pct | numeric | No | Amount tolerance (% of open) |
pay_horizon_days | integer | No | Payment proposal: bills due within (days) |
pay_bank_account_id | uuid | No | Pay from |
credit_hold_after_days | integer | No | Credit hold after (days overdue) — Empty: no automatic credit hold. |
soft_close_roles | _text | No | Who may post into a soft-closed period — Role codes, separated by commas (e.g. controller). The administrator always may. |
budget_variance_pct | numeric | No | Budget alert over (%) |
cash_floor | numeric | No | Cash floor — Empty: no projected-cash alert. |
forecast_horizon_days | integer | No | Cash forecast horizon (days) |
notes | text | No | Notes |
Sample body
{
"cash_auto_apply_min": "1250.00",
"cash_suggest_min": "1250.00"
}Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"cash_auto_apply_min": "1250.00",
"cash_suggest_min": "1250.00",
"cash_amount_tolerance": "1250.00",
"cash_tolerance_pct": "1250.00",
"pay_horizon_days": 10,
"pay_bank_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"credit_hold_after_days": 10,
"soft_close_roles": [],
"budget_variance_pct": "1250.00",
"cash_floor": "1250.00",
"forecast_horizon_days": 10,
"notes": "text"
}Sample request
curl -X PUT "https://demo.tranxact.ai/api/accounting/fin-automation-settings/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"cash_auto_apply_min":"1250.00","cash_suggest_min":"1250.00"}'DELETE/api/accounting/fin-automation-settings/{id}Delete a finance automation settings
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/fin-automation-settings/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/accounting/fin-automation-settings/{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/fin-automation-settings/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 finance automation settings, 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 |
cash_auto_apply_min | numeric | read, write | Apply a cash match at or above (%) |
cash_suggest_min | numeric | read, write | Suggest a cash match at or above (%) |
cash_amount_tolerance | numeric | read, write | Amount tolerance — How far a payment may be from what is open and still be the amount. |
cash_tolerance_pct | numeric | read, write | Amount tolerance (% of open) |
pay_horizon_days | integer | read, write | Payment proposal: bills due within (days) |
pay_bank_account_id | uuid | read, write | Pay from |
credit_hold_after_days | integer | read, write | Credit hold after (days overdue) — Empty: no automatic credit hold. |
soft_close_roles | _text | read, write | Who may post into a soft-closed period — Role codes, separated by commas (e.g. controller). The administrator always may. |
budget_variance_pct | numeric | read, write | Budget alert over (%) |
cash_floor | numeric | read, write | Cash floor — Empty: no projected-cash alert. |
forecast_horizon_days | integer | read, write | Cash forecast horizon (days) |
notes | text | read, write | Notes |
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 |
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 |
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 › Finance Automation Settings 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.