TRANXACT.AI Help

Accounting · Tax

Deferred Tax Items

Temporary differences between the accounting base and the tax base. Almost universally kept in a spreadsheet, and the reason the tax note is the last thing finished at every year end.

Type REST6 operationsBase path /api/accounting/deferred-tax-itemsPublished as /api/v1/deferred-tax-items

Download specification (OpenAPI 3.1) Screen: Deferred Tax Items

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 › Deferred Tax Items 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.deferred_tax_items · 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/deferred-tax-itemsList deferred tax items

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",
      "category": "fixed_assets",
      "jurisdiction_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "source_type": "asset_area",
      "book_area_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "tax_area_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "gl_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "difference_type": "taxable",
      "tax_rate_pct": "1250.00",
      "recognition_basis": "full",
      "recognised_pct": "1250.00"
    }
  ],
  "count": 1
}

Sample request

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

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",
  "category": "fixed_assets",
  "jurisdiction_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "source_type": "asset_area",
  "book_area_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "tax_area_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "gl_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "difference_type": "taxable",
  "tax_rate_pct": "1250.00",
  "recognition_basis": "full",
  "recognised_pct": "1250.00"
}

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

Sample request

curl "https://demo.tranxact.ai/api/accounting/deferred-tax-items/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/accounting/deferred-tax-itemsCreate a deferred tax item

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
codetextYesCode
nametextYesName
categorytextNoCategory
Allowed: fixed_assets provisions leases revenue inventory losses pensions intangibles fair_value other
jurisdiction_iduuidNoJurisdiction
source_typetextNoSource — An asset area source reads both bases from the register rather than asking for them.
Allowed: asset_area lease provision manual loss_carryforward
book_area_iduuidNoBook area
tax_area_iduuidNoTax area
gl_account_iduuidNoAccount
difference_typetextNoDifference type — A deductible difference gives an asset; a taxable one gives a liability. The sign is the whole of it.
Allowed: taxable deductible
tax_rate_pctnumericNoTax rate %
recognition_basistextNoRecognition — A deferred tax asset is recognised only to the extent future profits will absorb it.
Allowed: full partial not_recognised
recognised_pctnumericNoRecognised %
expected_reversal_yearsintegerNoExpected reversal (years)
dta_account_iduuidNoDeferred tax asset account
dtl_account_iduuidNoDeferred tax liability account
is_activebooleanNoActive
notestextNoNotes

Sample body

{
  "code": "COD-000001",
  "name": "Example",
  "category": "fixed_assets",
  "jurisdiction_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "source_type": "asset_area",
  "book_area_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "code": "COD-000001",
  "name": "Example",
  "category": "fixed_assets",
  "jurisdiction_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "source_type": "asset_area",
  "book_area_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "tax_area_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "gl_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "difference_type": "taxable",
  "tax_rate_pct": "1250.00",
  "recognition_basis": "full",
  "recognised_pct": "1250.00"
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/accounting/deferred-tax-items" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"code":"COD-000001","name":"Example","category":"fixed_assets","jurisdiction_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","source_type":"asset_area","book_area_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"}'
PUT/api/accounting/deferred-tax-items/{id}Change a deferred tax item

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
categorytextNoCategory
Allowed: fixed_assets provisions leases revenue inventory losses pensions intangibles fair_value other
jurisdiction_iduuidNoJurisdiction
source_typetextNoSource — An asset area source reads both bases from the register rather than asking for them.
Allowed: asset_area lease provision manual loss_carryforward
book_area_iduuidNoBook area
tax_area_iduuidNoTax area
gl_account_iduuidNoAccount
difference_typetextNoDifference type — A deductible difference gives an asset; a taxable one gives a liability. The sign is the whole of it.
Allowed: taxable deductible
tax_rate_pctnumericNoTax rate %
recognition_basistextNoRecognition — A deferred tax asset is recognised only to the extent future profits will absorb it.
Allowed: full partial not_recognised
recognised_pctnumericNoRecognised %
expected_reversal_yearsintegerNoExpected reversal (years)
dta_account_iduuidNoDeferred tax asset account
dtl_account_iduuidNoDeferred tax liability account
is_activebooleanNoActive
notestextNoNotes

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",
  "category": "fixed_assets",
  "jurisdiction_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "source_type": "asset_area",
  "book_area_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "tax_area_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "gl_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "difference_type": "taxable",
  "tax_rate_pct": "1250.00",
  "recognition_basis": "full",
  "recognised_pct": "1250.00"
}

Sample request

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

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/deferred-tax-items/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/accounting/deferred-tax-items/{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/deferred-tax-items/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 deferred tax item, 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
categorytextread, writeCategory
Allowed: fixed_assets provisions leases revenue inventory losses pensions intangibles fair_value other
jurisdiction_iduuidread, writeJurisdiction
source_typetextread, writeSource — An asset area source reads both bases from the register rather than asking for them.
Allowed: asset_area lease provision manual loss_carryforward
book_area_iduuidread, writeBook area
tax_area_iduuidread, writeTax area
gl_account_iduuidread, writeAccount
difference_typetextread, writeDifference type — A deductible difference gives an asset; a taxable one gives a liability. The sign is the whole of it.
Allowed: taxable deductible
tax_rate_pctnumericread, writeTax rate %
recognition_basistextread, writeRecognition — A deferred tax asset is recognised only to the extent future profits will absorb it.
Allowed: full partial not_recognised
recognised_pctnumericread, writeRecognised %
expected_reversal_yearsintegerread, writeExpected reversal (years)
dta_account_iduuidread, writeDeferred tax asset account
dtl_account_iduuidread, writeDeferred tax liability account
is_activebooleanread, writeActive
notestextread, writeNotes
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_attimestamp with time zoneread onlyCreated at
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 › Deferred Tax Items 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.