TRANXACT.AI Help

Accounting · Regulatory Reporting

XBRL Filings

The balance sheet, income statement and cash flow of a period, tagged for a regulator as an XBRL instance and an Inline XBRL document, and checked: contexts, units, decimals, duplicates, totals. The ESEF report package and validation against the published taxonomies (Arelle) are done outside.

Type REST11 operationsBase path /api/accounting/xbrl-filingsPublished as /api/v1/xbrl-filings

Download specification (OpenAPI 3.1) Screen: XBRL Filings

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 › XBRL Filings 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.xbrl_filings · 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

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

GET/api/accounting/xbrl-filingsList xbrl filings

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",
      "filing_no": "FIL-000001",
      "taxonomy_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "period_from": "2026-10-30",
      "period_to": "2026-10-30",
      "entity_name": "Example",
      "entity_identifier": "text",
      "identifier_scheme": "text",
      "currency": "USD",
      "decimals": 10,
      "display_scale": "0",
      "shares_outstanding": "1250.00",
      "status": "draft"
    }
  ],
  "count": 1
}

Sample request

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

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",
  "filing_no": "FIL-000001",
  "taxonomy_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "period_from": "2026-10-30",
  "period_to": "2026-10-30",
  "entity_name": "Example",
  "entity_identifier": "text",
  "identifier_scheme": "text",
  "currency": "USD",
  "decimals": 10,
  "display_scale": "0",
  "shares_outstanding": "1250.00",
  "status": "draft"
}

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

Sample request

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

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
taxonomy_iduuidYesTaxonomy
period_fromdateYesPeriod from
period_todateYesPeriod to
entity_nametextNoEntity name — Empty takes the company’s legal name.
entity_identifiertextYesEntity identifier — The LEI for ESEF and most European filings; the CIK for the SEC; the company number for Companies House.
identifier_schemetextNoIdentifier scheme — http://standards.iso.org/iso/17442 for an LEI, http://www.sec.gov/CIK for a CIK.
currencytextNoCurrency — Empty is the company’s own.
decimalsintegerNoDecimals — 0 reports to the unit, -3 to the thousand.
display_scaleintegerNoDisplay scale — How the Inline XBRL document shows the figures: units, thousands or millions.
Allowed: 0 3 6
shares_outstandingnumericNoShares outstanding — For the number of shares and earnings per share. Leave empty to tag neither.
notestextNoNotes

Sample body

{
  "taxonomy_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "period_from": "2026-10-30",
  "period_to": "2026-10-30",
  "entity_identifier": "text",
  "entity_name": "Example",
  "identifier_scheme": "text",
  "currency": "USD",
  "decimals": 10
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "filing_no": "FIL-000001",
  "taxonomy_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "period_from": "2026-10-30",
  "period_to": "2026-10-30",
  "entity_name": "Example",
  "entity_identifier": "text",
  "identifier_scheme": "text",
  "currency": "USD",
  "decimals": 10,
  "display_scale": "0",
  "shares_outstanding": "1250.00",
  "status": "draft"
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/accounting/xbrl-filings" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"taxonomy_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","period_from":"2026-10-30","period_to":"2026-10-30","entity_identifier":"text","entity_name":"Example","identifier_scheme":"text","currency":"USD","decimals":10}'
PUT/api/accounting/xbrl-filings/{id}Change a xbrl filings

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
taxonomy_iduuidYesTaxonomy
period_fromdateYesPeriod from
period_todateYesPeriod to
entity_nametextNoEntity name — Empty takes the company’s legal name.
entity_identifiertextYesEntity identifier — The LEI for ESEF and most European filings; the CIK for the SEC; the company number for Companies House.
identifier_schemetextNoIdentifier scheme — http://standards.iso.org/iso/17442 for an LEI, http://www.sec.gov/CIK for a CIK.
currencytextNoCurrency — Empty is the company’s own.
decimalsintegerNoDecimals — 0 reports to the unit, -3 to the thousand.
display_scaleintegerNoDisplay scale — How the Inline XBRL document shows the figures: units, thousands or millions.
Allowed: 0 3 6
shares_outstandingnumericNoShares outstanding — For the number of shares and earnings per share. Leave empty to tag neither.
notestextNoNotes

Sample body

{
  "taxonomy_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "period_from": "2026-10-30"
}

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "filing_no": "FIL-000001",
  "taxonomy_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "period_from": "2026-10-30",
  "period_to": "2026-10-30",
  "entity_name": "Example",
  "entity_identifier": "text",
  "identifier_scheme": "text",
  "currency": "USD",
  "decimals": 10,
  "display_scale": "0",
  "shares_outstanding": "1250.00",
  "status": "draft"
}

Sample request

curl -X PUT "https://demo.tranxact.ai/api/accounting/xbrl-filings/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"taxonomy_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","period_from":"2026-10-30"}'
DELETE/api/accounting/xbrl-filings/{id}Delete a xbrl filings

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/xbrl-filings/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/accounting/xbrl-filings/{id}/generateGenerate

Path parameters

NameTypeDescription
idstring (uuid)The record's id, 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/xbrl-filings/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/generate" \
  -H "Authorization: Bearer $TOKEN"
GET/api/accounting/xbrl-filings/{id}/factsFacts

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Response

200 with the data as JSON.

Sample request

curl "https://demo.tranxact.ai/api/accounting/xbrl-filings/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/facts" \
  -H "Authorization: Bearer $TOKEN"
GET/api/accounting/xbrl-filings/{id}/validationValidation

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Response

200 with the data as JSON.

Sample request

curl "https://demo.tranxact.ai/api/accounting/xbrl-filings/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/validation" \
  -H "Authorization: Bearer $TOKEN"
GET/api/accounting/xbrl-filings/{id}/downloadDownload

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Response

200 with the data as JSON.

Sample request

curl "https://demo.tranxact.ai/api/accounting/xbrl-filings/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/download" \
  -H "Authorization: Bearer $TOKEN"
POST/api/accounting/xbrl-filings/{id}/mark-filedMark filed

Path parameters

NameTypeDescription
idstring (uuid)The record's id, 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/xbrl-filings/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/mark-filed" \
  -H "Authorization: Bearer $TOKEN"
POST/api/accounting/xbrl-filings/{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/xbrl-filings/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 xbrl filings, 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
filing_notextread onlyFiling no
taxonomy_iduuidread, writeTaxonomy
period_fromdateread, writePeriod from
period_todateread, writePeriod to
entity_nametextread, writeEntity name — Empty takes the company’s legal name.
entity_identifiertextread, writeEntity identifier — The LEI for ESEF and most European filings; the CIK for the SEC; the company number for Companies House.
identifier_schemetextread, writeIdentifier scheme — http://standards.iso.org/iso/17442 for an LEI, http://www.sec.gov/CIK for a CIK.
currencytextread, writeCurrency — Empty is the company’s own.
decimalsintegerread, writeDecimals — 0 reports to the unit, -3 to the thousand.
display_scaleintegerread, writeDisplay scale — How the Inline XBRL document shows the figures: units, thousands or millions.
Allowed: 0 3 6
shares_outstandingnumericread, writeShares outstanding — For the number of shares and earnings per share. Leave empty to tag neither.
statustextread onlyStatus
fact_countintegerread onlyFact count
error_countintegerread onlyError count
warning_countintegerread onlyWarning count
validationjsonbread onlyValidation
instance_xmltextread onlyInstance xml
ixbrl_htmltextread onlyIxbrl html
generated_attimestamp with time zoneread onlyGenerated at
generated_byuuidread onlyGenerated by
filed_attimestamp with time zoneread onlyFiled at
notestextread, writeNotes
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 › XBRL Filings 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.