read

The proposals waiting in one entity's books: entries, classifications and reconciliations a person decides.

Proposals are written by the books assistant or by an app, and posted by nobody: a person accepts or dismisses each one under Books → Assistant, and accepting books nothing by itself. Each item carries kind (entry, classification, reconciliation), its payload as it was proposed (amounts as decimal strings), rationale, source (assistant for the books assistant, app:<id> for an app), status (proposed, accepted, dismissed) and its timestamps. Ordered by id. 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/proposals

Request

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

status'proposed' | 'accepted' | 'dismissed'

Only proposals in this state.

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.