TRANXACT.AI Help

Accounting · Consolidation

Consolidation Groups

A reporting entity that does not trade: a currency, a chart, a calendar and a set of member companies.

Type REST10 operationsBase path /api/accounting/consolidation-groupsPublished as /api/v1/consolidation-groups

Download specification (OpenAPI 3.1) Screen: Consolidation Groups

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 › Consolidation Groups 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.consolidation_groups · 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/consolidation-groupsList consolidation groups

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",
      "parent_group_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "group_currency": "USD",
      "principle_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "ledger_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "fiscal_year_start_month": 10,
      "translation_reserve_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "goodwill_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "minority_interest_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "rounding_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "is_active": true
    }
  ],
  "count": 1
}

Sample request

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

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",
  "parent_group_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "group_currency": "USD",
  "principle_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "ledger_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "fiscal_year_start_month": 10,
  "translation_reserve_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "goodwill_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "minority_interest_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "rounding_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "is_active": true
}

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

Sample request

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

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
codetextYesCode
nametextYesName
parent_group_iduuidNoParent group — A sub-group consolidates first and enters the parent as one line.
group_currencytextNoGroup currency
principle_iduuidNoAccounting principle
ledger_iduuidNoLedger
fiscal_year_start_monthintegerNoFiscal year starts in month
translation_reserve_account_iduuidNoTranslation reserve account
goodwill_account_iduuidNoGoodwill account
minority_interest_account_iduuidNoMinority interest account
rounding_account_iduuidNoRounding account
is_activebooleanNoActive
descriptiontextNoDescription

Sample body

{
  "code": "COD-000001",
  "name": "Example",
  "parent_group_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "group_currency": "USD",
  "principle_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "ledger_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",
  "parent_group_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "group_currency": "USD",
  "principle_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "ledger_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "fiscal_year_start_month": 10,
  "translation_reserve_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "goodwill_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "minority_interest_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "rounding_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "is_active": true
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/accounting/consolidation-groups" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"code":"COD-000001","name":"Example","parent_group_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","group_currency":"USD","principle_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","ledger_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"}'
PUT/api/accounting/consolidation-groups/{id}Change a consolidation group

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
parent_group_iduuidNoParent group — A sub-group consolidates first and enters the parent as one line.
group_currencytextNoGroup currency
principle_iduuidNoAccounting principle
ledger_iduuidNoLedger
fiscal_year_start_monthintegerNoFiscal year starts in month
translation_reserve_account_iduuidNoTranslation reserve account
goodwill_account_iduuidNoGoodwill account
minority_interest_account_iduuidNoMinority interest account
rounding_account_iduuidNoRounding account
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",
  "parent_group_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "group_currency": "USD",
  "principle_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "ledger_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "fiscal_year_start_month": 10,
  "translation_reserve_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "goodwill_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "minority_interest_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "rounding_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "is_active": true
}

Sample request

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

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

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/consolidation-groups/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/units" \
  -H "Authorization: Bearer $TOKEN"
POST/api/accounting/consolidation-groups/{parentId}/unitsUnits

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

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/consolidation-groups/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/units/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
DELETE/api/accounting/consolidation-groups/{parentId}/units/{lineId}Units

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/consolidation-groups/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/units/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"

Data model

Every field of a consolidation group, 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
parent_group_iduuidread, writeParent group — A sub-group consolidates first and enters the parent as one line.
group_currencytextread, writeGroup currency
principle_iduuidread, writeAccounting principle
ledger_iduuidread, writeLedger
fiscal_year_start_monthintegerread, writeFiscal year starts in month
translation_reserve_account_iduuidread, writeTranslation reserve account
goodwill_account_iduuidread, writeGoodwill account
minority_interest_account_iduuidread, writeMinority interest account
rounding_account_iduuidread, writeRounding account
is_activebooleanread, writeActive
descriptiontextread, writeDescription
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 › Consolidation Groups 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.