TRANXACT.AI Help

Accounting · Cash Movement

Feed Rules

How a movement nobody has coded is accounted for. The first rule that matches wins, which is what priority decides.

Type REST6 operationsBase path /api/accounting/bank-feed-rulesPublished as /api/v1/bank-feed-rules

Download specification (OpenAPI 3.1) Screen: Feed Rules

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 › Feed Rules 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.bank_feed_rules · 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/bank-feed-rulesList feed rules

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",
      "bank_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "code": "COD-000001",
      "name": "Example",
      "priority": 10,
      "direction": "debit",
      "description_like": "text",
      "counterparty_like": "text",
      "bai_code": "BAI-000001",
      "min_amount": "1250.00",
      "max_amount": "1250.00",
      "category": "text",
      "gl_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "cost_center_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
    }
  ],
  "count": 1
}

Sample request

curl "https://demo.tranxact.ai/api/accounting/bank-feed-rules?limit=20" \
  -H "Authorization: Bearer $TOKEN"
GET/api/accounting/bank-feed-rules/{id}Read one bank feed rules

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "bank_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "code": "COD-000001",
  "name": "Example",
  "priority": 10,
  "direction": "debit",
  "description_like": "text",
  "counterparty_like": "text",
  "bai_code": "BAI-000001",
  "min_amount": "1250.00",
  "max_amount": "1250.00",
  "category": "text",
  "gl_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "cost_center_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}

404 when no record with that id is visible to the caller.

Sample request

curl "https://demo.tranxact.ai/api/accounting/bank-feed-rules/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/accounting/bank-feed-rulesCreate a bank feed rules

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
bank_account_iduuidNoOnly for this account — Leave blank to apply to every account.
codetextYesRule code
nametextYesName
priorityintegerNoPriority — Lower runs first.
directiontextNoDirection
Allowed: debit credit
description_liketextNoDescription contains — Case-insensitive, e.g. SERVICE CHARGE
counterparty_liketextNoCounterparty contains
bai_codetextNoBAI type code
min_amountnumericNoMinimum amount
max_amountnumericNoMaximum amount
categorytextNoCategory
gl_account_iduuidNoPost to
cost_center_iduuidNoCost center
auto_postbooleanNoAuto post
set_match_statustextNoInstead, set aside as — For movements the ledger never needs to explain.
Allowed: ignored excluded
is_activebooleanNoActive

Sample body

{
  "code": "COD-000001",
  "name": "Example",
  "bank_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "priority": 10,
  "direction": "debit",
  "description_like": "text"
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "bank_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "code": "COD-000001",
  "name": "Example",
  "priority": 10,
  "direction": "debit",
  "description_like": "text",
  "counterparty_like": "text",
  "bai_code": "BAI-000001",
  "min_amount": "1250.00",
  "max_amount": "1250.00",
  "category": "text",
  "gl_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "cost_center_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/accounting/bank-feed-rules" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"code":"COD-000001","name":"Example","bank_account_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","priority":10,"direction":"debit","description_like":"text"}'
PUT/api/accounting/bank-feed-rules/{id}Change a bank feed rules

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
bank_account_iduuidNoOnly for this account — Leave blank to apply to every account.
codetextYesRule code
nametextYesName
priorityintegerNoPriority — Lower runs first.
directiontextNoDirection
Allowed: debit credit
description_liketextNoDescription contains — Case-insensitive, e.g. SERVICE CHARGE
counterparty_liketextNoCounterparty contains
bai_codetextNoBAI type code
min_amountnumericNoMinimum amount
max_amountnumericNoMaximum amount
categorytextNoCategory
gl_account_iduuidNoPost to
cost_center_iduuidNoCost center
auto_postbooleanNoAuto post
set_match_statustextNoInstead, set aside as — For movements the ledger never needs to explain.
Allowed: ignored excluded
is_activebooleanNoActive

Sample body

{
  "code": "COD-000001",
  "name": "Example"
}

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "bank_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "code": "COD-000001",
  "name": "Example",
  "priority": 10,
  "direction": "debit",
  "description_like": "text",
  "counterparty_like": "text",
  "bai_code": "BAI-000001",
  "min_amount": "1250.00",
  "max_amount": "1250.00",
  "category": "text",
  "gl_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "cost_center_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}

Sample request

curl -X PUT "https://demo.tranxact.ai/api/accounting/bank-feed-rules/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"code":"COD-000001","name":"Example"}'
DELETE/api/accounting/bank-feed-rules/{id}Delete a bank feed rules

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/bank-feed-rules/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/accounting/bank-feed-rules/{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/bank-feed-rules/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 bank feed rules, 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
bank_account_iduuidread, writeOnly for this account — Leave blank to apply to every account.
codetextread, writeRule code
nametextread, writeName
priorityintegerread, writePriority — Lower runs first.
directiontextread, writeDirection
Allowed: debit credit
description_liketextread, writeDescription contains — Case-insensitive, e.g. SERVICE CHARGE
counterparty_liketextread, writeCounterparty contains
bai_codetextread, writeBAI type code
min_amountnumericread, writeMinimum amount
max_amountnumericread, writeMaximum amount
categorytextread, writeCategory
gl_account_iduuidread, writePost to
cost_center_iduuidread, writeCost center
auto_postbooleanread, writeAuto post
set_match_statustextread, writeInstead, set aside as — For movements the ledger never needs to explain.
Allowed: ignored excluded
hit_countintegerread onlyHit count
last_hit_attimestamp with time zoneread onlyLast hit at
is_activebooleanread, writeActive
created_attimestamp with time zoneread onlyCreated at
org_unit_iduuidread onlyOrg unit id
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
created_byuuidread onlyCreated by
updated_attimestamp with time zoneread onlyUpdated at
updated_byuuidread onlyUpdated by

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 › Feed Rules 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.