TRANXACT.AI Help

Accounting · Ledgers & Principles

Accounting Principles

The rulebooks: IFRS, US GAAP, a local statutory basis, a tax basis. What each says about leases, revenue and inventory is what makes a second ledger necessary.

Type REST6 operationsBase path /api/accounting/accounting-principlesPublished as /api/v1/accounting-principles

Download specification (OpenAPI 3.1) Screen: Accounting Principles

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 › Accounting Principles 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.accounting_principles · 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/accounting-principlesList accounting principles

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",
      "framework": "text",
      "jurisdiction": "text",
      "description": "text",
      "lease_standard": "ifrs16",
      "revenue_standard": "ifrs15",
      "inventory_method": "weighted_average",
      "allows_revaluation": true,
      "capitalises_development": true,
      "functional_currency_rule": "entity",
      "is_active": true
    }
  ],
  "count": 1
}

Sample request

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

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",
  "framework": "text",
  "jurisdiction": "text",
  "description": "text",
  "lease_standard": "ifrs16",
  "revenue_standard": "ifrs15",
  "inventory_method": "weighted_average",
  "allows_revaluation": true,
  "capitalises_development": true,
  "functional_currency_rule": "entity",
  "is_active": true
}

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

Sample request

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

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
codetextYesCode
nametextYesName
frameworktextNoFramework
jurisdictiontextNoJurisdiction — The country (ISO code, e.g. IN, SA, US) where this is the statutory basis. Left blank, a local, statutory or tax basis takes the company’s country, Ind AS takes IN and SOCPA takes SA.
descriptiontextNoDescription
lease_standardtextNoLease standard — IFRS 16 capitalises every lease; ASC 842 keeps a straight-line cost on an operating lease. GASB 87 (US state and local government): one lessee model, a lessor receivable and deferred inflow, and GASB 96 subscriptions.
Allowed: ifrs16 asc842 operating_only none gasb87
revenue_standardtextNoRevenue standard
Allowed: ifrs15 asc606 completed_contract cash none
inventory_methodtextNoInventory method — LIFO is permitted under US GAAP and prohibited under IFRS.
Allowed: weighted_average fifo lifo standard specific
allows_revaluationbooleanNoPermits the revaluation model
capitalises_developmentbooleanNoCapitalises development cost
functional_currency_ruletextNoFunctional currency
Allowed: entity group fixed
is_activebooleanNoActive

Sample body

{
  "code": "COD-000001",
  "name": "Example",
  "framework": "text",
  "jurisdiction": "text",
  "description": "text",
  "lease_standard": "ifrs16"
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "code": "COD-000001",
  "name": "Example",
  "framework": "text",
  "jurisdiction": "text",
  "description": "text",
  "lease_standard": "ifrs16",
  "revenue_standard": "ifrs15",
  "inventory_method": "weighted_average",
  "allows_revaluation": true,
  "capitalises_development": true,
  "functional_currency_rule": "entity",
  "is_active": true
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/accounting/accounting-principles" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"code":"COD-000001","name":"Example","framework":"text","jurisdiction":"text","description":"text","lease_standard":"ifrs16"}'
PUT/api/accounting/accounting-principles/{id}Change a accounting principle

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
frameworktextNoFramework
jurisdictiontextNoJurisdiction — The country (ISO code, e.g. IN, SA, US) where this is the statutory basis. Left blank, a local, statutory or tax basis takes the company’s country, Ind AS takes IN and SOCPA takes SA.
descriptiontextNoDescription
lease_standardtextNoLease standard — IFRS 16 capitalises every lease; ASC 842 keeps a straight-line cost on an operating lease. GASB 87 (US state and local government): one lessee model, a lessor receivable and deferred inflow, and GASB 96 subscriptions.
Allowed: ifrs16 asc842 operating_only none gasb87
revenue_standardtextNoRevenue standard
Allowed: ifrs15 asc606 completed_contract cash none
inventory_methodtextNoInventory method — LIFO is permitted under US GAAP and prohibited under IFRS.
Allowed: weighted_average fifo lifo standard specific
allows_revaluationbooleanNoPermits the revaluation model
capitalises_developmentbooleanNoCapitalises development cost
functional_currency_ruletextNoFunctional currency
Allowed: entity group fixed
is_activebooleanNoActive

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",
  "framework": "text",
  "jurisdiction": "text",
  "description": "text",
  "lease_standard": "ifrs16",
  "revenue_standard": "ifrs15",
  "inventory_method": "weighted_average",
  "allows_revaluation": true,
  "capitalises_development": true,
  "functional_currency_rule": "entity",
  "is_active": true
}

Sample request

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

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/accounting-principles/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/accounting/accounting-principles/{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/accounting-principles/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 accounting principle, 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
frameworktextread, writeFramework
jurisdictiontextread, writeJurisdiction — The country (ISO code, e.g. IN, SA, US) where this is the statutory basis. Left blank, a local, statutory or tax basis takes the company’s country, Ind AS takes IN and SOCPA takes SA.
descriptiontextread, writeDescription
lease_standardtextread, writeLease standard — IFRS 16 capitalises every lease; ASC 842 keeps a straight-line cost on an operating lease. GASB 87 (US state and local government): one lessee model, a lessor receivable and deferred inflow, and GASB 96 subscriptions.
Allowed: ifrs16 asc842 operating_only none gasb87
revenue_standardtextread, writeRevenue standard
Allowed: ifrs15 asc606 completed_contract cash none
inventory_methodtextread, writeInventory method — LIFO is permitted under US GAAP and prohibited under IFRS.
Allowed: weighted_average fifo lifo standard specific
allows_revaluationbooleanread, writePermits the revaluation model
capitalises_developmentbooleanread, writeCapitalises development cost
functional_currency_ruletextread, writeFunctional currency
Allowed: entity group fixed
is_activebooleanread, writeActive
created_attimestamp with time zoneread onlyCreated at
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 › Accounting Principles 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.