Journal Line

The journal line resource.

Basehttps://rest.carbon.ms/journalLine

GET/journalLine

List journal lines

Retrieve a paginated list of journal lines. 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/journalLine

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

Response

[
  {
    "id": "abc123def456",
    "journalId": "xyz789",
    "amount": 0,
    "quantity": 10,
    "journalLineReference": "string",
    "accrual": true,
    "companyId": "xyz789",
    "createdAt": "2026-01-01T00:00:00Z"
  }
]

GET/journalLine

Retrieve a journal line

Fetch a single journal line by filtering on `id`.

Query parameters

idstring

Match on the journal line's `id`, e.g. `eq.{id}`.

GEThttps://rest.carbon.ms/journalLine

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

Response

{
  "id": "abc123def456",
  "journalId": "xyz789",
  "amount": 0,
  "quantity": 10,
  "journalLineReference": "string",
  "accrual": true,
  "companyId": "xyz789",
  "createdAt": "2026-01-01T00:00:00Z"
}

POST/journalLine

Create a journal line

Create a new journal line.

Body parameters

journalIdstringrequired

References journal.id

descriptionstring

amountnumberrequired

quantitynumberrequired

documentTypejournalLineDocumentType

documentIdstring

externalDocumentIdstring

journalLineReferencestringrequired

documentLineReferencestring

accrualbooleanrequired

companyIdstringrequired

References company.id

customFieldsobject

tagsarray

accountIdstring

References account.id

intercompanyPartnerIdstring

The counterparty company within the same group for intercompany transactions

References company.id

POSThttps://rest.carbon.ms/journalLine

curl --request POST \
  --url https://rest.carbon.ms/journalLine \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"journalId":"xyz789","description":"string","amount":0,"quantity":10,"journalLineReference":"string","accrual":true,"companyId":"xyz789"}'

Response

{
  "id": "abc123def456",
  "journalId": "xyz789",
  "amount": 0,
  "quantity": 10,
  "journalLineReference": "string",
  "accrual": true,
  "companyId": "xyz789",
  "createdAt": "2026-01-01T00:00:00Z"
}

PATCH/journalLine

Update a journal line

Update an existing journal line, matched on `id`.

Body parameters

journalIdstringrequired

References journal.id

descriptionstring

amountnumberrequired

quantitynumberrequired

documentTypejournalLineDocumentType

documentIdstring

externalDocumentIdstring

journalLineReferencestringrequired

documentLineReferencestring

accrualbooleanrequired

companyIdstringrequired

References company.id

customFieldsobject

tagsarray

accountIdstring

References account.id

intercompanyPartnerIdstring

The counterparty company within the same group for intercompany transactions

References company.id

PATCHhttps://rest.carbon.ms/journalLine

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

Response

{
  "id": "abc123def456",
  "journalId": "xyz789",
  "amount": 0,
  "quantity": 10,
  "journalLineReference": "string",
  "accrual": true,
  "companyId": "xyz789",
  "createdAt": "2026-01-01T00:00:00Z"
}

DELETE/journalLine

Delete a journal line

Delete a journal line, matched on `id`. Returns 204 No Content.

Query parameters

idstring

The `id` of the journal line to delete, e.g. `eq.{id}`.

DELETEhttps://rest.carbon.ms/journalLine

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

204 No Content