TRANXACT.AI Help

Accounting · Fund Accounting

Fund Derivation Rules

Every rule as a record. The Derivation Studio draws the condition as a builder; here it is the JSON it is saved as.

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

Download specification (OpenAPI 3.1) Screen: Fund Derivation 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 › Fund Derivation 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.gl_derivation_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/derivation-rulesList fund derivation 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",
      "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "rule_set_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "code": "COD-000001",
      "name": "Example",
      "priority": 10,
      "conditions": {},
      "condition_expr": "text",
      "document_types": [],
      "valid_from": "2026-10-30",
      "valid_to": "2026-10-30",
      "action": "Set a value",
      "value_code": "VAL-000001",
      "copy_field": "text"
    }
  ],
  "count": 1
}

Sample request

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

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",
  "rule_set_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "code": "COD-000001",
  "name": "Example",
  "priority": 10,
  "conditions": {},
  "condition_expr": "text",
  "document_types": [],
  "valid_from": "2026-10-30",
  "valid_to": "2026-10-30",
  "action": "Set a value",
  "value_code": "VAL-000001",
  "copy_field": "text"
}

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

Sample request

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

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
rule_set_iduuidYesRule set
codetextYesCode
nametextYesName
priorityintegerNoPriority — Lower runs first.
conditionsjsonbNoCondition — {"op":"and","items":[{"field":"cost_center_code","operator":"eq","value":"PW-300"}]}. Empty items is always true.
condition_exprtextNoCondition expression — Optional, in the expression language: starts_with(account_no, '5') and amount >= 5000.
document_types_textNoDocuments — Narrower than the set's, when given. Comma separated.
valid_fromdateNoValid from
valid_todateNoValid to
actiontextNoAction
Allowed: Set a value Copy a field Look it up Compute it
value_codetextNoValue — The code to set: a fund, grant, program, function, account number or cost center.
copy_fieldtextNoField to copy
lookup_iduuidNoLookup table
expressiontextNoExpression
modetextNoMode
Allowed: Default (a person may override) Lock (replaces a person's value)
is_activebooleanNoActive
descriptiontextNoDescription

Sample body

{
  "rule_set_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "code": "COD-000001",
  "name": "Example",
  "priority": 10,
  "conditions": {},
  "condition_expr": "text",
  "document_types": []
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "rule_set_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "code": "COD-000001",
  "name": "Example",
  "priority": 10,
  "conditions": {},
  "condition_expr": "text",
  "document_types": [],
  "valid_from": "2026-10-30",
  "valid_to": "2026-10-30",
  "action": "Set a value",
  "value_code": "VAL-000001",
  "copy_field": "text"
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/accounting/derivation-rules" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"rule_set_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","code":"COD-000001","name":"Example","priority":10,"conditions":{},"condition_expr":"text","document_types":[]}'
PUT/api/accounting/derivation-rules/{id}Change a derivation rule

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
rule_set_iduuidYesRule set
codetextYesCode
nametextYesName
priorityintegerNoPriority — Lower runs first.
conditionsjsonbNoCondition — {"op":"and","items":[{"field":"cost_center_code","operator":"eq","value":"PW-300"}]}. Empty items is always true.
condition_exprtextNoCondition expression — Optional, in the expression language: starts_with(account_no, '5') and amount >= 5000.
document_types_textNoDocuments — Narrower than the set's, when given. Comma separated.
valid_fromdateNoValid from
valid_todateNoValid to
actiontextNoAction
Allowed: Set a value Copy a field Look it up Compute it
value_codetextNoValue — The code to set: a fund, grant, program, function, account number or cost center.
copy_fieldtextNoField to copy
lookup_iduuidNoLookup table
expressiontextNoExpression
modetextNoMode
Allowed: Default (a person may override) Lock (replaces a person's value)
is_activebooleanNoActive
descriptiontextNoDescription

Sample body

{
  "rule_set_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "code": "COD-000001"
}

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "rule_set_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "code": "COD-000001",
  "name": "Example",
  "priority": 10,
  "conditions": {},
  "condition_expr": "text",
  "document_types": [],
  "valid_from": "2026-10-30",
  "valid_to": "2026-10-30",
  "action": "Set a value",
  "value_code": "VAL-000001",
  "copy_field": "text"
}

Sample request

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

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/derivation-rules/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/accounting/derivation-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/derivation-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 derivation rule, 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
rule_set_iduuidread, writeRule set
codetextread, writeCode
nametextread, writeName
priorityintegerread, writePriority — Lower runs first.
conditionsjsonbread, writeCondition — {"op":"and","items":[{"field":"cost_center_code","operator":"eq","value":"PW-300"}]}. Empty items is always true.
condition_exprtextread, writeCondition expression — Optional, in the expression language: starts_with(account_no, '5') and amount >= 5000.
document_types_textread, writeDocuments — Narrower than the set's, when given. Comma separated.
valid_fromdateread, writeValid from
valid_todateread, writeValid to
actiontextread, writeAction
Allowed: Set a value Copy a field Look it up Compute it
value_codetextread, writeValue — The code to set: a fund, grant, program, function, account number or cost center.
copy_fieldtextread, writeField to copy
lookup_iduuidread, writeLookup table
expressiontextread, writeExpression
modetextread, writeMode
Allowed: Default (a person may override) Lock (replaces a person's value)
is_activebooleanread, writeActive
descriptiontextread, writeDescription
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 › Fund Derivation 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.