TRANXACT.AI Help

Accounting · Tax

Return Templates

The shape of a form. A VAT return has boxes, a GSTR-1 has tables, a sales tax return has schedules — all three are "a named slot with a rule for what goes in it".

Type REST10 operationsBase path /api/accounting/return-templatesPublished as /api/v1/return-templates

Download specification (OpenAPI 3.1) Screen: Return Templates

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 › Return Templates 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.return_templates · 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

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

GET/api/accounting/return-templatesList return templates

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",
      "authority_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "jurisdiction_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "tax_type": "text",
      "frequency": "monthly",
      "filing_days": 10,
      "payment_days": 10,
      "form_code": "FOR-000001",
      "submission_format": "manual",
      "is_active": true,
      "description": "text"
    }
  ],
  "count": 1
}

Sample request

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

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",
  "authority_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "jurisdiction_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "tax_type": "text",
  "frequency": "monthly",
  "filing_days": 10,
  "payment_days": 10,
  "form_code": "FOR-000001",
  "submission_format": "manual",
  "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/return-templates/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/accounting/return-templatesCreate a return template

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
codetextYesCode
nametextYesName
authority_iduuidNoAuthority
jurisdiction_iduuidNoJurisdiction
tax_typetextNoTax type
frequencytextNoFrequency
Allowed: monthly bi_monthly quarterly semi_annual annual on_demand
filing_daysintegerNoDays to file — What turns a return into a deadline on a calendar.
payment_daysintegerNoDays to pay
form_codetextNoForm code
submission_formattextNoSubmission format
Allowed: manual csv xml json api pdf saf_t
is_activebooleanNoActive
descriptiontextNoDescription

Sample body

{
  "code": "COD-000001",
  "name": "Example",
  "authority_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "jurisdiction_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "tax_type": "text",
  "frequency": "monthly"
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "code": "COD-000001",
  "name": "Example",
  "authority_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "jurisdiction_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "tax_type": "text",
  "frequency": "monthly",
  "filing_days": 10,
  "payment_days": 10,
  "form_code": "FOR-000001",
  "submission_format": "manual",
  "is_active": true,
  "description": "text"
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/accounting/return-templates" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"code":"COD-000001","name":"Example","authority_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","jurisdiction_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","tax_type":"text","frequency":"monthly"}'
PUT/api/accounting/return-templates/{id}Change a return template

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
authority_iduuidNoAuthority
jurisdiction_iduuidNoJurisdiction
tax_typetextNoTax type
frequencytextNoFrequency
Allowed: monthly bi_monthly quarterly semi_annual annual on_demand
filing_daysintegerNoDays to file — What turns a return into a deadline on a calendar.
payment_daysintegerNoDays to pay
form_codetextNoForm code
submission_formattextNoSubmission format
Allowed: manual csv xml json api pdf saf_t
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",
  "authority_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "jurisdiction_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "tax_type": "text",
  "frequency": "monthly",
  "filing_days": 10,
  "payment_days": 10,
  "form_code": "FOR-000001",
  "submission_format": "manual",
  "is_active": true,
  "description": "text"
}

Sample request

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

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/return-templates/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/accounting/return-templates/{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/return-templates/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/copy" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"overrides":"value","preview":"value","withLines":"value"}'
GET/api/accounting/return-templates/{parentId}/boxesBoxes

Path parameters

NameTypeDescription
parentIdstring (uuid)The record's parentId, as a list returns it.

Response

200 with the data as JSON.

Sample request

curl "https://demo.tranxact.ai/api/accounting/return-templates/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/boxes" \
  -H "Authorization: Bearer $TOKEN"
POST/api/accounting/return-templates/{parentId}/boxesBoxes

Path parameters

NameTypeDescription
parentIdstring (uuid)The record's parentId, as a list returns it.

No body is required.

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/return-templates/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/boxes" \
  -H "Authorization: Bearer $TOKEN"
PUT/api/accounting/return-templates/{parentId}/boxes/{lineId}Boxes

Path parameters

NameTypeDescription
parentIdstring (uuid)The record's parentId, as a list returns it.
lineIdstring (uuid)The record's lineId, as a list returns it.

No body is required.

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 PUT "https://demo.tranxact.ai/api/accounting/return-templates/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/boxes/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
DELETE/api/accounting/return-templates/{parentId}/boxes/{lineId}Boxes

Path parameters

NameTypeDescription
parentIdstring (uuid)The record's parentId, as a list returns it.
lineIdstring (uuid)The record's lineId, as a list returns it.

No body is required.

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 DELETE "https://demo.tranxact.ai/api/accounting/return-templates/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/boxes/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"

Data model

Every field of a return template, 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
authority_iduuidread, writeAuthority
jurisdiction_iduuidread, writeJurisdiction
tax_typetextread, writeTax type
frequencytextread, writeFrequency
Allowed: monthly bi_monthly quarterly semi_annual annual on_demand
filing_daysintegerread, writeDays to file — What turns a return into a deadline on a calendar.
payment_daysintegerread, writeDays to pay
form_codetextread, writeForm code
submission_formattextread, writeSubmission format
Allowed: manual csv xml json api pdf saf_t
is_activebooleanread, writeActive
descriptiontextread, writeDescription
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 › Return Templates 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.