read

Posted journal entries of one entity with their lines, by entry date.

The ledger is append-only: an entry is never changed or deleted, it is reversed by a new entry of kind reversal whose reverses_entry_id names it. Each line carries its amount in the transaction currency and its base amount, the rate, its source and date. Amounts are { "amount": "<decimal string>", "currency": "<ISO 4217>" } — never a JSON number. Keyset-paged: pass page.next_cursor back as cursor while page.has_more is true. page.truncated is true only when a server-side bound cut this page short of what was asked; it is never a silent cut.

post/api/v1/finance/journal-entries

Request

  • Base URL: https://app.magistry.io
  • URL: https://app.magistry.io/api/v1/finance/journal-entries
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://app.magistry.io/api/oauth/authorize, token URL https://app.magistry.io/api/oauth/token, scopes: finance:read)

Request body

entity_idstring uuid required

The entity, one of those this app was granted (GET /api/v1/finance/entities lists them). In a GET query string entity is accepted too.

fromstring date

Inclusive lower bound on entry_date.

tostring date

Inclusive upper bound on entry_date.

entry_idstring uuid

Only this entry.

import_idstring uuid

Only the entries of this import.

include_linesboolean

Include each entry's lines.

cursorstring

The next_cursor of the previous page. Opaque.

limitinteger

Items per page.

Response

Result

okboolean required
resultunknown required

Changes

No recorded changes to this operation across all 3 revisions of this API.