TRANXACT.AI Help

Accounting · Intercompany

Intercompany Relationships

Who may trade with whom, on what transfer-pricing basis, and through which accounts. A pair that is not declared is a transaction nobody agreed to.

Type REST6 operationsBase path /api/accounting/ic-relationshipsPublished as /api/v1/ic-relationships

Download specification (OpenAPI 3.1) Screen: Intercompany Relationships

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 › Intercompany Relationships 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.ic_relationships · 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/ic-relationshipsList intercompany relationships

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",
      "from_org_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "to_org_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "relationship": "trading",
      "pricing_method": "cost_plus",
      "markup_pct": "1250.00",
      "currency": "USD",
      "payment_terms_days": 10,
      "ar_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "ap_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "auto_mirror": true,
      "netting_group": "text",
      "agreement_ref": "text"
    }
  ],
  "count": 1
}

Sample request

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

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",
  "from_org_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "to_org_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "relationship": "trading",
  "pricing_method": "cost_plus",
  "markup_pct": "1250.00",
  "currency": "USD",
  "payment_terms_days": 10,
  "ar_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "ap_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "auto_mirror": true,
  "netting_group": "text",
  "agreement_ref": "text"
}

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

Sample request

curl "https://demo.tranxact.ai/api/accounting/ic-relationships/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/accounting/ic-relationshipsCreate a intercompany relationship

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
from_org_iduuidYesFrom company
to_org_iduuidYesTo company
relationshiptextNoRelationship
Allowed: trading financing service royalty cost_share tax_group
pricing_methodtextNoTransfer pricing method — Transfer pricing is a tax matter before it is an accounting one — the method has to be defensible.
Allowed: cost_plus resale_minus cup tnmm profit_split at_cost none
markup_pctnumericNoMarkup %
currencytextNoCurrency
payment_terms_daysintegerNoPayment terms (days)
ar_account_iduuidNoIntercompany receivable account
ap_account_iduuidNoIntercompany payable account
auto_mirrorbooleanNoRaise the other side automatically
netting_grouptextNoNetting group
agreement_reftextNoAgreement reference
valid_fromdateNoValid from
valid_todateNoValid to
is_activebooleanNoActive
notestextNoNotes

Sample body

{
  "from_org_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "to_org_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "relationship": "trading",
  "pricing_method": "cost_plus",
  "markup_pct": "1250.00",
  "currency": "USD"
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "from_org_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "to_org_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "relationship": "trading",
  "pricing_method": "cost_plus",
  "markup_pct": "1250.00",
  "currency": "USD",
  "payment_terms_days": 10,
  "ar_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "ap_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "auto_mirror": true,
  "netting_group": "text",
  "agreement_ref": "text"
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/accounting/ic-relationships" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"from_org_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","to_org_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","relationship":"trading","pricing_method":"cost_plus","markup_pct":"1250.00","currency":"USD"}'
PUT/api/accounting/ic-relationships/{id}Change a intercompany relationship

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
from_org_iduuidYesFrom company
to_org_iduuidYesTo company
relationshiptextNoRelationship
Allowed: trading financing service royalty cost_share tax_group
pricing_methodtextNoTransfer pricing method — Transfer pricing is a tax matter before it is an accounting one — the method has to be defensible.
Allowed: cost_plus resale_minus cup tnmm profit_split at_cost none
markup_pctnumericNoMarkup %
currencytextNoCurrency
payment_terms_daysintegerNoPayment terms (days)
ar_account_iduuidNoIntercompany receivable account
ap_account_iduuidNoIntercompany payable account
auto_mirrorbooleanNoRaise the other side automatically
netting_grouptextNoNetting group
agreement_reftextNoAgreement reference
valid_fromdateNoValid from
valid_todateNoValid to
is_activebooleanNoActive
notestextNoNotes

Sample body

{
  "from_org_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "to_org_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "from_org_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "to_org_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "relationship": "trading",
  "pricing_method": "cost_plus",
  "markup_pct": "1250.00",
  "currency": "USD",
  "payment_terms_days": 10,
  "ar_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "ap_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "auto_mirror": true,
  "netting_group": "text",
  "agreement_ref": "text"
}

Sample request

curl -X PUT "https://demo.tranxact.ai/api/accounting/ic-relationships/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"from_org_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","to_org_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"}'
DELETE/api/accounting/ic-relationships/{id}Delete a intercompany relationship

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/ic-relationships/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/accounting/ic-relationships/{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/ic-relationships/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 intercompany relationship, 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
from_org_iduuidread, writeFrom company
to_org_iduuidread, writeTo company
relationshiptextread, writeRelationship
Allowed: trading financing service royalty cost_share tax_group
pricing_methodtextread, writeTransfer pricing method — Transfer pricing is a tax matter before it is an accounting one — the method has to be defensible.
Allowed: cost_plus resale_minus cup tnmm profit_split at_cost none
markup_pctnumericread, writeMarkup %
currencytextread, writeCurrency
payment_terms_daysintegerread, writePayment terms (days)
ar_account_iduuidread, writeIntercompany receivable account
ap_account_iduuidread, writeIntercompany payable account
auto_mirrorbooleanread, writeRaise the other side automatically
netting_grouptextread, writeNetting group
agreement_reftextread, writeAgreement reference
valid_fromdateread, writeValid from
valid_todateread, writeValid to
is_activebooleanread, writeActive
notestextread, writeNotes
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 › Intercompany Relationships 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.