TRANXACT.AI Help

Accounting · Intercompany

Intercompany Transactions

One row holding both sides, because two rows is how the sides come to disagree. Raising it posts in both companies inside one transaction.

Type REST6 operationsBase path /api/accounting/ic-transactionsPublished as /api/v1/ic-transactions

Download specification (OpenAPI 3.1) Screen: Intercompany Transactions

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 Transactions 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_transactions · 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-transactionsList intercompany transactions

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",
      "ic_no": "IC-000001",
      "relationship_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "from_org_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "to_org_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "txn_date": "2026-10-30",
      "period_code": "PER-000001",
      "txn_type": "text",
      "description": "text",
      "currency": "USD",
      "amount": "1250.00",
      "tax_amount": "1250.00",
      "transfer_cost": "1250.00"
    }
  ],
  "count": 1
}

Sample request

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

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",
  "ic_no": "IC-000001",
  "relationship_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "from_org_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "to_org_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "txn_date": "2026-10-30",
  "period_code": "PER-000001",
  "txn_type": "text",
  "description": "text",
  "currency": "USD",
  "amount": "1250.00",
  "tax_amount": "1250.00",
  "transfer_cost": "1250.00"
}

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

Sample request

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

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
relationship_iduuidNoRelationship
from_org_iduuidYesSelling company
to_org_iduuidYesBuying company
txn_datedateNoDate
period_codetextNoPeriod code
txn_typetextNoType
descriptiontextNoDescription
currencytextNoCurrency
amountnumericYesAmount
tax_amountnumericNoTax
transfer_costnumericNoCost to the seller — The difference from the amount is unrealised profit, and comes out at group level if the goods are still in stock.
dispute_reasontextNoDispute reason
source_moduletextNoSource module
source_reftextNoSource reference

Sample body

{
  "from_org_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "to_org_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "amount": "1250.00",
  "relationship_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "txn_date": "2026-10-30",
  "period_code": "PER-000001",
  "txn_type": "text"
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "ic_no": "IC-000001",
  "relationship_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "from_org_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "to_org_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "txn_date": "2026-10-30",
  "period_code": "PER-000001",
  "txn_type": "text",
  "description": "text",
  "currency": "USD",
  "amount": "1250.00",
  "tax_amount": "1250.00",
  "transfer_cost": "1250.00"
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/accounting/ic-transactions" \
  -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","amount":"1250.00","relationship_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","txn_date":"2026-10-30","period_code":"PER-000001","txn_type":"text"}'
PUT/api/accounting/ic-transactions/{id}Change a intercompany transaction

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
relationship_iduuidNoRelationship
from_org_iduuidYesSelling company
to_org_iduuidYesBuying company
txn_datedateNoDate
period_codetextNoPeriod code
txn_typetextNoType
descriptiontextNoDescription
currencytextNoCurrency
amountnumericYesAmount
tax_amountnumericNoTax
transfer_costnumericNoCost to the seller — The difference from the amount is unrealised profit, and comes out at group level if the goods are still in stock.
dispute_reasontextNoDispute reason
source_moduletextNoSource module
source_reftextNoSource reference

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",
  "ic_no": "IC-000001",
  "relationship_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "from_org_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "to_org_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "txn_date": "2026-10-30",
  "period_code": "PER-000001",
  "txn_type": "text",
  "description": "text",
  "currency": "USD",
  "amount": "1250.00",
  "tax_amount": "1250.00",
  "transfer_cost": "1250.00"
}

Sample request

curl -X PUT "https://demo.tranxact.ai/api/accounting/ic-transactions/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-transactions/{id}Delete a intercompany transaction

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-transactions/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/accounting/ic-transactions/{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-transactions/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 transaction, 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
ic_notextread onlyIc no
relationship_iduuidread, writeRelationship
from_org_iduuidread, writeSelling company
to_org_iduuidread, writeBuying company
txn_datedateread, writeDate
period_codetextread, writePeriod code
txn_typetextread, writeType
descriptiontextread, writeDescription
currencytextread, writeCurrency
amountnumericread, writeAmount
tax_amountnumericread, writeTax
transfer_costnumericread, writeCost to the seller — The difference from the amount is unrealised profit, and comes out at group level if the goods are still in stock.
markup_amountnumericread onlyMarkup amount
from_journal_iduuidread onlyFrom journal id
to_journal_iduuidread onlyTo journal id
from_invoice_iduuidread onlyFrom invoice id
to_invoice_iduuidread onlyTo invoice id
statustextread onlyStatus
matched_attimestamp with time zoneread onlyMatched at
dispute_reasontextread, writeDispute reason
source_moduletextread, writeSource module
source_reftextread, writeSource reference
created_byuuidread onlyCreated by
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
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 Transactions 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.