propose_write

Propose an entry, a classification or a reconciliation for a person to decide. Posts nothing.

Changed on

Answers the proposal id. kind entry takes date, description and lines (each account_code, side debit|credit, amount as a decimal string; debits equal credits); classification takes bank_transaction_id and account_code; reconciliation takes bank_transaction_id and journal_entry_id. Refused with invalid_request and the reason for a closed period, an unbalanced entry or an id of another entity, and with 403 while the entity's owner has not switched app proposals on. Nothing is booked, matched or filed: a person accepts or dismisses it in Books.

post/api/v1/finance/proposals/create

Request

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

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.

kind'entry' | 'classification' | 'reconciliation' required

What is proposed.

rationalestring required

Why, in one or two sentences, for the person who decides (1 to 2000 characters).

datestring date

entry: the entry date; its period must be open.

descriptionstring

entry: the entry description.

bank_transaction_idstring uuid

classification, reconciliation: the bank line.

account_codestring

classification: the account code.

journal_entry_idstring uuid

reconciliation: the journal entry to match.

Response

Result

okboolean required
resultunknown required

Changes