TRANXACT.AI Help

Accounting · Fund Accounting

Derivation Rule Sets

One set per thing derived, run in sequence so a later set can read what an earlier one decided. First match stops at the first rule that fires; all applicable lets each refine the last.

Type REST8 operationsBase path /api/accounting/derivation-rule-setsPublished as /api/v1/derivation-rule-sets

Download specification (OpenAPI 3.1) Screen: Derivation Rule Sets

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 › Derivation Rule Sets 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_rule_sets · 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

8 operations. Open one for its parameters, bodies, responses and a sample request.

GET/api/accounting/derivation-rule-setsList derivation rule sets

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",
      "code": "COD-000001",
      "name": "Example",
      "target": "Fund",
      "strategy": "First match wins",
      "document_types": [],
      "apply_on_save": true,
      "apply_on_post": true,
      "sequence_no": 10,
      "valid_from": "2026-10-30",
      "valid_to": "2026-10-30",
      "is_active": true,
      "description": "text"
    }
  ],
  "count": 1
}

Sample request

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

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",
  "code": "COD-000001",
  "name": "Example",
  "target": "Fund",
  "strategy": "First match wins",
  "document_types": [],
  "apply_on_save": true,
  "apply_on_post": true,
  "sequence_no": 10,
  "valid_from": "2026-10-30",
  "valid_to": "2026-10-30",
  "is_active": true,
  "description": "text"
}

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

Sample request

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

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
codetextYesCode
nametextYesName
targettextYesDerives
Allowed: Fund Grant Program Function GL account Cost center
strategytextNoStrategy
Allowed: First match wins All applicable, in priority order
document_types_textNoDocuments — Comma separated: journal, ap_invoice, ar_invoice, purchase_order, expense, payroll. Empty is every document.
apply_on_savebooleanNoApply when a document line is saved
apply_on_postbooleanNoApply when the journal posts
sequence_nointegerNoSequence
valid_fromdateNoValid from
valid_todateNoValid to
is_activebooleanNoActive
descriptiontextNoDescription

Sample body

{
  "code": "COD-000001",
  "name": "Example",
  "target": "Fund",
  "strategy": "First match wins",
  "document_types": [],
  "apply_on_save": true,
  "apply_on_post": true
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "code": "COD-000001",
  "name": "Example",
  "target": "Fund",
  "strategy": "First match wins",
  "document_types": [],
  "apply_on_save": true,
  "apply_on_post": true,
  "sequence_no": 10,
  "valid_from": "2026-10-30",
  "valid_to": "2026-10-30",
  "is_active": true,
  "description": "text"
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/accounting/derivation-rule-sets" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"code":"COD-000001","name":"Example","target":"Fund","strategy":"First match wins","document_types":[],"apply_on_save":true,"apply_on_post":true}'
PUT/api/accounting/derivation-rule-sets/{id}Change a derivation rule set

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
codetextYesCode
nametextYesName
targettextYesDerives
Allowed: Fund Grant Program Function GL account Cost center
strategytextNoStrategy
Allowed: First match wins All applicable, in priority order
document_types_textNoDocuments — Comma separated: journal, ap_invoice, ar_invoice, purchase_order, expense, payroll. Empty is every document.
apply_on_savebooleanNoApply when a document line is saved
apply_on_postbooleanNoApply when the journal posts
sequence_nointegerNoSequence
valid_fromdateNoValid from
valid_todateNoValid to
is_activebooleanNoActive
descriptiontextNoDescription

Sample body

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

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "code": "COD-000001",
  "name": "Example",
  "target": "Fund",
  "strategy": "First match wins",
  "document_types": [],
  "apply_on_save": true,
  "apply_on_post": true,
  "sequence_no": 10,
  "valid_from": "2026-10-30",
  "valid_to": "2026-10-30",
  "is_active": true,
  "description": "text"
}

Sample request

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

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-rule-sets/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
GET/api/accounting/derivation-rule-sets/catalogCatalog

Response

200 with the data as JSON.

Sample request

curl "https://demo.tranxact.ai/api/accounting/derivation-rule-sets/catalog" \
  -H "Authorization: Bearer $TOKEN"
POST/api/accounting/derivation-rule-sets/previewPreview

Request body

The keys this action reads (* = required; "one of" lists the only values):

documentType, stage, date, line

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-rule-sets/preview" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"documentType":"value","stage":"value","date":"value","line":"value"}'
POST/api/accounting/derivation-rule-sets/{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-rule-sets/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 set, 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
codetextread, writeCode
nametextread, writeName
targettextread, writeDerives
Allowed: Fund Grant Program Function GL account Cost center
strategytextread, writeStrategy
Allowed: First match wins All applicable, in priority order
document_types_textread, writeDocuments — Comma separated: journal, ap_invoice, ar_invoice, purchase_order, expense, payroll. Empty is every document.
apply_on_savebooleanread, writeApply when a document line is saved
apply_on_postbooleanread, writeApply when the journal posts
sequence_nointegerread, writeSequence
valid_fromdateread, writeValid from
valid_todateread, writeValid to
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 › Derivation Rule Sets 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.