Intercompany Transaction

The intercompany transaction resource.

Basehttps://rest.carbon.ms/intercompanyTransaction

GET/intercompanyTransaction

List intercompany transactions

Retrieve a paginated list of intercompany transactions. Filter, order, and select columns with PostgREST query parameters.

Query parameters

selectstring

Comma-separated columns to return. Defaults to all.

orderstring

Column to sort by, e.g. `createdAt.desc`.

limitinteger

Maximum rows to return.

offsetinteger

Rows to skip, for pagination.

GEThttps://rest.carbon.ms/intercompanyTransaction

curl --request GET \
  --url 'https://rest.carbon.ms/intercompanyTransaction?select=*&limit=10' \
  --header 'Authorization: Bearer <api-key>'

Response

[
  {
    "id": "abc123def456",
    "companyGroupId": "xyz789",
    "sourceCompanyId": "xyz789",
    "targetCompanyId": "xyz789",
    "sourceJournalLineId": "xyz789",
    "amount": 0,
    "currencyCode": "string",
    "status": "string"
  }
]

GET/intercompanyTransaction

Retrieve a intercompany transaction

Fetch a single intercompany transaction by filtering on `id`.

Query parameters

idstring

Match on the intercompany transaction's `id`, e.g. `eq.{id}`.

GEThttps://rest.carbon.ms/intercompanyTransaction

curl --request GET \
  --url 'https://rest.carbon.ms/intercompanyTransaction?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'

Response

{
  "id": "abc123def456",
  "companyGroupId": "xyz789",
  "sourceCompanyId": "xyz789",
  "targetCompanyId": "xyz789",
  "sourceJournalLineId": "xyz789",
  "amount": 0,
  "currencyCode": "string",
  "status": "string"
}

POST/intercompanyTransaction

Create a intercompany transaction

Create a new intercompany transaction.

Body parameters

companyGroupIdstringrequired

References companyGroup.id

sourceCompanyIdstringrequired

References company.id

targetCompanyIdstringrequired

References company.id

sourceJournalLineIdstringrequired

References journalLine.id

targetJournalLineIdstring

References journalLine.id

amountnumberrequired

currencyCodestringrequired

descriptionstring

documentTypejournalLineDocumentType

documentIdstring

statusstringrequired

eliminationJournalIdstring

References journal.id

POSThttps://rest.carbon.ms/intercompanyTransaction

curl --request POST \
  --url https://rest.carbon.ms/intercompanyTransaction \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"companyGroupId":"xyz789","sourceCompanyId":"xyz789","targetCompanyId":"xyz789","sourceJournalLineId":"xyz789","amount":0,"currencyCode":"string","description":"string","status":"string"}'

Response

{
  "id": "abc123def456",
  "companyGroupId": "xyz789",
  "sourceCompanyId": "xyz789",
  "targetCompanyId": "xyz789",
  "sourceJournalLineId": "xyz789",
  "amount": 0,
  "currencyCode": "string",
  "status": "string"
}

PATCH/intercompanyTransaction

Update a intercompany transaction

Update an existing intercompany transaction, matched on `id`.

Body parameters

companyGroupIdstringrequired

References companyGroup.id

sourceCompanyIdstringrequired

References company.id

targetCompanyIdstringrequired

References company.id

sourceJournalLineIdstringrequired

References journalLine.id

targetJournalLineIdstring

References journalLine.id

amountnumberrequired

currencyCodestringrequired

descriptionstring

documentTypejournalLineDocumentType

documentIdstring

statusstringrequired

eliminationJournalIdstring

References journal.id

PATCHhttps://rest.carbon.ms/intercompanyTransaction

curl --request PATCH \
  --url 'https://rest.carbon.ms/intercompanyTransaction?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"companyGroupId":"xyz789"}'

Response

{
  "id": "abc123def456",
  "companyGroupId": "xyz789",
  "sourceCompanyId": "xyz789",
  "targetCompanyId": "xyz789",
  "sourceJournalLineId": "xyz789",
  "amount": 0,
  "currencyCode": "string",
  "status": "string"
}

DELETE/intercompanyTransaction

Delete a intercompany transaction

Delete a intercompany transaction, matched on `id`. Returns 204 No Content.

Query parameters

idstring

The `id` of the intercompany transaction to delete, e.g. `eq.{id}`.

DELETEhttps://rest.carbon.ms/intercompanyTransaction

curl --request DELETE \
  --url 'https://rest.carbon.ms/intercompanyTransaction?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'

204 No Content