Accounting · Finance Configuration
Finance Configuration
Company-wide finance switches. AP match defaults apply where neither the item nor the supplier says otherwise (empty keeps today's 2% and three-way). Item accounts and strict posting roles are off until you switch them on.
/api/accounting/fin-config-settingsPublished as /api/v1/fin-config-settingsDownload specification (OpenAPI 3.1) Screen: Finance Configuration
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 Configuration 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_config_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-config-settingsList finance configuration
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",
"ap_price_tolerance_pct": "1250.00",
"ap_quantity_tolerance_pct": "12.0000",
"ap_match_option": "Three-way (order, receipt, invoice) - today",
"honour_item_accounts": true,
"role_resolution": "Tagged account, else demo number or name (today)",
"notes": "text",
"created_at": "2026-10-30T09:00:00Z",
"updated_at": "2026-10-30T09:00:00Z",
"created_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"updated_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"xf_text_1": "text",
"xf_text_2": "text",
"xf_text_3": "text"
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/accounting/fin-config-settings?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/accounting/fin-config-settings/{id}Read one finance configuration
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",
"ap_price_tolerance_pct": "1250.00",
"ap_quantity_tolerance_pct": "12.0000",
"ap_match_option": "Three-way (order, receipt, invoice) - today",
"honour_item_accounts": true,
"role_resolution": "Tagged account, else demo number or name (today)",
"notes": "text",
"created_at": "2026-10-30T09:00:00Z",
"updated_at": "2026-10-30T09:00:00Z",
"created_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"updated_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"xf_text_1": "text",
"xf_text_2": "text",
"xf_text_3": "text"
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/accounting/fin-config-settings/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/accounting/fin-config-settingsCreate a finance configuration
Request body
The record as JSON. Fields marked Yes are required.
| Field | Type | Required | Description |
|---|---|---|---|
ap_price_tolerance_pct | numeric | No | Price tolerance (%) — How far an invoice may exceed the order value and still match. Empty: 2%. An item or supplier tolerance wins. |
ap_quantity_tolerance_pct | numeric | No | Quantity tolerance (%) — How far an invoice may exceed what was received and still match. Empty: 2%. |
ap_match_option | text | No | Supplier invoice match — What a supplier invoice on an order is matched against. An item or supplier set to anything but three-way keeps its own choice. Allowed: Three-way (order, receipt, invoice) - today Two-way (order and invoice) Four-way (adds the inspection) No match |
honour_item_accounts | boolean | No | Post to the item's own accounts — Goods receipts, deliveries and invoices use the inventory, cost of sales and revenue accounts on the item (Item Costing), then the item-group matrix, then the company roles. Off: roles only. |
role_resolution | text | No | Posting roles — Strict never guesses an account from a number or a name: an unset role refuses the posting and names the role. Use Posting Roles > Lock mapping to move over without changing a single answer. Allowed: Tagged account, else demo number or name (today) Strict: tagged account or Account Determination only |
notes | text | No | Notes |
Sample body
{
"ap_price_tolerance_pct": "1250.00",
"ap_quantity_tolerance_pct": "12.0000",
"ap_match_option": "Three-way (order, receipt, invoice) - today",
"honour_item_accounts": true
}Response 201
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"ap_price_tolerance_pct": "1250.00",
"ap_quantity_tolerance_pct": "12.0000",
"ap_match_option": "Three-way (order, receipt, invoice) - today",
"honour_item_accounts": true,
"role_resolution": "Tagged account, else demo number or name (today)",
"notes": "text",
"created_at": "2026-10-30T09:00:00Z",
"updated_at": "2026-10-30T09:00:00Z",
"created_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"updated_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"xf_text_1": "text",
"xf_text_2": "text",
"xf_text_3": "text"
}Sample request
curl -X POST "https://demo.tranxact.ai/api/accounting/fin-config-settings" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"ap_price_tolerance_pct":"1250.00","ap_quantity_tolerance_pct":"12.0000","ap_match_option":"Three-way (order, receipt, invoice) - today","honour_item_accounts":true}'PUT/api/accounting/fin-config-settings/{id}Change a finance configuration
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 |
|---|---|---|---|
ap_price_tolerance_pct | numeric | No | Price tolerance (%) — How far an invoice may exceed the order value and still match. Empty: 2%. An item or supplier tolerance wins. |
ap_quantity_tolerance_pct | numeric | No | Quantity tolerance (%) — How far an invoice may exceed what was received and still match. Empty: 2%. |
ap_match_option | text | No | Supplier invoice match — What a supplier invoice on an order is matched against. An item or supplier set to anything but three-way keeps its own choice. Allowed: Three-way (order, receipt, invoice) - today Two-way (order and invoice) Four-way (adds the inspection) No match |
honour_item_accounts | boolean | No | Post to the item's own accounts — Goods receipts, deliveries and invoices use the inventory, cost of sales and revenue accounts on the item (Item Costing), then the item-group matrix, then the company roles. Off: roles only. |
role_resolution | text | No | Posting roles — Strict never guesses an account from a number or a name: an unset role refuses the posting and names the role. Use Posting Roles > Lock mapping to move over without changing a single answer. Allowed: Tagged account, else demo number or name (today) Strict: tagged account or Account Determination only |
notes | text | No | Notes |
Sample body
{
"ap_price_tolerance_pct": "1250.00",
"ap_quantity_tolerance_pct": "12.0000"
}Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"ap_price_tolerance_pct": "1250.00",
"ap_quantity_tolerance_pct": "12.0000",
"ap_match_option": "Three-way (order, receipt, invoice) - today",
"honour_item_accounts": true,
"role_resolution": "Tagged account, else demo number or name (today)",
"notes": "text",
"created_at": "2026-10-30T09:00:00Z",
"updated_at": "2026-10-30T09:00:00Z",
"created_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"updated_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"xf_text_1": "text",
"xf_text_2": "text",
"xf_text_3": "text"
}Sample request
curl -X PUT "https://demo.tranxact.ai/api/accounting/fin-config-settings/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"ap_price_tolerance_pct":"1250.00","ap_quantity_tolerance_pct":"12.0000"}'DELETE/api/accounting/fin-config-settings/{id}Delete a finance configuration
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-config-settings/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/accounting/fin-config-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-config-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 configuration, 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 |
ap_price_tolerance_pct | numeric | read, write | Price tolerance (%) — How far an invoice may exceed the order value and still match. Empty: 2%. An item or supplier tolerance wins. |
ap_quantity_tolerance_pct | numeric | read, write | Quantity tolerance (%) — How far an invoice may exceed what was received and still match. Empty: 2%. |
ap_match_option | text | read, write | Supplier invoice match — What a supplier invoice on an order is matched against. An item or supplier set to anything but three-way keeps its own choice. Allowed: Three-way (order, receipt, invoice) - today Two-way (order and invoice) Four-way (adds the inspection) No match |
honour_item_accounts | boolean | read, write | Post to the item's own accounts — Goods receipts, deliveries and invoices use the inventory, cost of sales and revenue accounts on the item (Item Costing), then the item-group matrix, then the company roles. Off: roles only. |
role_resolution | text | read, write | Posting roles — Strict never guesses an account from a number or a name: an unset role refuses the posting and names the role. Use Posting Roles > Lock mapping to move over without changing a single answer. Allowed: Tagged account, else demo number or name (today) Strict: tagged account or Account Determination only |
notes | text | read, write | Notes |
created_at | timestamp with time zone | read only | Created at |
updated_at | timestamp with time zone | read only | Updated at |
created_by | uuid | read only | Created by |
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 Configuration 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.