TRANXACT.AI Help

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.

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

Download specification (OpenAPI 3.1) Screen: Finance Automation Settings

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 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.
Tableacct.fin_automation_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-automation-settingsList finance automation settings

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

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

FieldTypeRequiredDescription
cash_auto_apply_minnumericNoApply a cash match at or above (%)
cash_suggest_minnumericNoSuggest a cash match at or above (%)
cash_amount_tolerancenumericNoAmount tolerance — How far a payment may be from what is open and still be the amount.
cash_tolerance_pctnumericNoAmount tolerance (% of open)
pay_horizon_daysintegerNoPayment proposal: bills due within (days)
pay_bank_account_iduuidNoPay from
credit_hold_after_daysintegerNoCredit hold after (days overdue) — Empty: no automatic credit hold.
soft_close_roles_textNoWho may post into a soft-closed period — Role codes, separated by commas (e.g. controller). The administrator always may.
budget_variance_pctnumericNoBudget alert over (%)
cash_floornumericNoCash floor — Empty: no projected-cash alert.
forecast_horizon_daysintegerNoCash forecast horizon (days)
notestextNoNotes

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

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
cash_auto_apply_minnumericNoApply a cash match at or above (%)
cash_suggest_minnumericNoSuggest a cash match at or above (%)
cash_amount_tolerancenumericNoAmount tolerance — How far a payment may be from what is open and still be the amount.
cash_tolerance_pctnumericNoAmount tolerance (% of open)
pay_horizon_daysintegerNoPayment proposal: bills due within (days)
pay_bank_account_iduuidNoPay from
credit_hold_after_daysintegerNoCredit hold after (days overdue) — Empty: no automatic credit hold.
soft_close_roles_textNoWho may post into a soft-closed period — Role codes, separated by commas (e.g. controller). The administrator always may.
budget_variance_pctnumericNoBudget alert over (%)
cash_floornumericNoCash floor — Empty: no projected-cash alert.
forecast_horizon_daysintegerNoCash forecast horizon (days)
notestextNoNotes

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

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

FieldTypeAccessDescription
iduuidread onlyId
org_iduuidread onlyOrg id
org_unit_iduuidread onlyOrg unit id
cash_auto_apply_minnumericread, writeApply a cash match at or above (%)
cash_suggest_minnumericread, writeSuggest a cash match at or above (%)
cash_amount_tolerancenumericread, writeAmount tolerance — How far a payment may be from what is open and still be the amount.
cash_tolerance_pctnumericread, writeAmount tolerance (% of open)
pay_horizon_daysintegerread, writePayment proposal: bills due within (days)
pay_bank_account_iduuidread, writePay from
credit_hold_after_daysintegerread, writeCredit hold after (days overdue) — Empty: no automatic credit hold.
soft_close_roles_textread, writeWho may post into a soft-closed period — Role codes, separated by commas (e.g. controller). The administrator always may.
budget_variance_pctnumericread, writeBudget alert over (%)
cash_floornumericread, writeCash floor — Empty: no projected-cash alert.
forecast_horizon_daysintegerread, writeCash forecast horizon (days)
notestextread, writeNotes
created_attimestamp with time zoneread onlyCreated at
created_byuuidread onlyCreated by
updated_attimestamp with time zoneread onlyUpdated at
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 Automation Settings 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.