TRANXACT.AI Help

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.

Type REST6 operationsBase path /api/accounting/fin-config-settingsPublished as /api/v1/fin-config-settings

Download specification (OpenAPI 3.1) Screen: Finance Configuration

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 › 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.
Tableacct.fin_config_settings · 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/fin-config-settingsList finance configuration

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",
      "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

NameTypeDescription
idstring (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.

FieldTypeRequiredDescription
ap_price_tolerance_pctnumericNoPrice tolerance (%) — How far an invoice may exceed the order value and still match. Empty: 2%. An item or supplier tolerance wins.
ap_quantity_tolerance_pctnumericNoQuantity tolerance (%) — How far an invoice may exceed what was received and still match. Empty: 2%.
ap_match_optiontextNoSupplier 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_accountsbooleanNoPost 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_resolutiontextNoPosting 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
notestextNoNotes

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

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
ap_price_tolerance_pctnumericNoPrice tolerance (%) — How far an invoice may exceed the order value and still match. Empty: 2%. An item or supplier tolerance wins.
ap_quantity_tolerance_pctnumericNoQuantity tolerance (%) — How far an invoice may exceed what was received and still match. Empty: 2%.
ap_match_optiontextNoSupplier 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_accountsbooleanNoPost 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_resolutiontextNoPosting 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
notestextNoNotes

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

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/fin-config-settings/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/accounting/fin-config-settings/{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/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.

FieldTypeAccessDescription
iduuidread onlyId
org_iduuidread onlyOrg id
ap_price_tolerance_pctnumericread, writePrice tolerance (%) — How far an invoice may exceed the order value and still match. Empty: 2%. An item or supplier tolerance wins.
ap_quantity_tolerance_pctnumericread, writeQuantity tolerance (%) — How far an invoice may exceed what was received and still match. Empty: 2%.
ap_match_optiontextread, writeSupplier 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_accountsbooleanread, writePost 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_resolutiontextread, writePosting 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
notestextread, writeNotes
created_attimestamp with time zoneread onlyCreated at
updated_attimestamp with time zoneread onlyUpdated at
created_byuuidread onlyCreated by
updated_byuuidread onlyUpdated by
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

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 › Finance Configuration 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.