Skip to content
aimrack

Journal

The journal resource.

Base/journal
GET/journal

List journals

Retrieve a paginated list of journals. 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.

GET/journal
curl --request GET \
  --url '<your-host>/journal?select=*&limit=10' \
  --header 'Authorization: Bearer <api-key>'
Response
[
  {
    "id": "abc123def456",
    "companyId": "xyz789",
    "postingDate": "2026-01-01",
    "createdAt": "2026-01-01T00:00:00Z",
    "journalEntryId": "xyz789",
    "status": "string",
    "description": "string",
    "accountingPeriodId": "xyz789"
  }
]
GET/journal

Retrieve a journal

Fetch a single journal by filtering on `id`.

Query parameters

idstring

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

GET/journal
curl --request GET \
  --url '<your-host>/journal?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'
Response
{
  "id": "abc123def456",
  "companyId": "xyz789",
  "postingDate": "2026-01-01",
  "createdAt": "2026-01-01T00:00:00Z",
  "journalEntryId": "xyz789",
  "status": "string",
  "description": "string",
  "accountingPeriodId": "xyz789"
}
POST/journal

Create a journal

Create a new journal.

Body parameters

descriptionstring
accountingPeriodIdstring

References accountingPeriod.id

companyIdstringrequired

References company.id

postingDatedaterequired
customFieldsobject
tagsarray
journalEntryIdstringrequired
statusjournalEntryStatusrequired
sourceTypejournalEntrySourceType
reversalOfIdstring

References journal.id

reversedByIdstring

References journal.id

postedAttimestamp
postedBystring

References user.id

eliminationKindeliminationKind

Classifies an elimination journal by the intercompany layer it removes (SAP posting-level analog); NULL for ordinary journals

documentIdstring

The record this journal posts: an invoice, payment, memo, receipt, delivery, a production event; a manual journal is its own document, named by its journalEntryId.

documentDatedate

When the document happened, the date on the paper. The posting date defaults to it; the period comes from the posting date.

postingKindjournalPostingKind

post: the document's posting; reverse: its reversal; open: an opening balance brought in at conversion; recognize: deferred revenue recognized on schedule.

POST/journal
curl --request POST \
  --url <your-host>/journal \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"description":"string","companyId":"xyz789","postingDate":"2026-01-01","journalEntryId":"xyz789","status":"string"}'
Response
{
  "id": "abc123def456",
  "companyId": "xyz789",
  "postingDate": "2026-01-01",
  "createdAt": "2026-01-01T00:00:00Z",
  "journalEntryId": "xyz789",
  "status": "string",
  "description": "string",
  "accountingPeriodId": "xyz789"
}
PATCH/journal

Update a journal

Update an existing journal, matched on `id`.

Body parameters

descriptionstring
accountingPeriodIdstring

References accountingPeriod.id

companyIdstringrequired

References company.id

postingDatedaterequired
customFieldsobject
tagsarray
journalEntryIdstringrequired
statusjournalEntryStatusrequired
sourceTypejournalEntrySourceType
reversalOfIdstring

References journal.id

reversedByIdstring

References journal.id

postedAttimestamp
postedBystring

References user.id

eliminationKindeliminationKind

Classifies an elimination journal by the intercompany layer it removes (SAP posting-level analog); NULL for ordinary journals

documentIdstring

The record this journal posts: an invoice, payment, memo, receipt, delivery, a production event; a manual journal is its own document, named by its journalEntryId.

documentDatedate

When the document happened, the date on the paper. The posting date defaults to it; the period comes from the posting date.

postingKindjournalPostingKind

post: the document's posting; reverse: its reversal; open: an opening balance brought in at conversion; recognize: deferred revenue recognized on schedule.

PATCH/journal
curl --request PATCH \
  --url '<your-host>/journal?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"description":"string"}'
Response
{
  "id": "abc123def456",
  "companyId": "xyz789",
  "postingDate": "2026-01-01",
  "createdAt": "2026-01-01T00:00:00Z",
  "journalEntryId": "xyz789",
  "status": "string",
  "description": "string",
  "accountingPeriodId": "xyz789"
}
DELETE/journal

Delete a journal

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

Query parameters

idstring

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

DELETE/journal
curl --request DELETE \
  --url '<your-host>/journal?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'
204 No Content