read

What changed in one entity since a cursor: postings, reversals, period closes, bank imports and dismissals.

The change feed. Items are the entity's public events in commit order, each with event_type, aggregate_type, aggregate_id, its ids-and-codes data and a resource_url that reads the current state. Reversals (fin.entry.reversed) and dismissals (fin.bank_transaction.dismissed, with kind not_a_transaction or duplicate_of) are events, so nothing disappears without a tombstone. Keep next_cursor and pass it back as after. Every event younger than the published retention (guarantees.finance_change_feed_retention_days in /api/v1/changelog.json) is readable whether or not any webhook delivered it; a cursor older than that answers 410 finance_cursor_gone with oldest_cursor — never a silent gap. No after starts at the oldest available event.

The GET form of finance_changes: the same arguments as query parameters.

get/api/v1/finance/changes

Request

  • Base URL: https://app.magistry.io
  • URL: https://app.magistry.io/api/v1/finance/changes
  • 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)

Query parameters

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.

afterstring

The next_cursor (or oldest_cursor) a previous call returned.

limitinteger

Items per page.

entitystring uuid

Alias of entity_id; give one of the two.

Response

Result

okboolean required
resultunknown required

Changes

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