Transactions

Archive the transaction

As the app's Archive. The transaction drops out of default lists and totals (filter[archived] brings it back), is skipped by accounting sync and automated work, and is read-only: other writes to it answer 409 until it is unarchived. A pending approval is cancelled. Idempotent: archiving an archived transaction returns it unchanged. Sends the transaction.deleted webhook. Needs the role's Transactions Archive permission, and transaction archiving turned on for the account.

post/v1/transactions/{transaction_id}/archival

Request

  • Base URL: https://api.topkey.io
  • URL: https://api.topkey.io/v1/transactions/{transaction_id}/archival
  • Auth: HTTP bearer

Path parameters

transaction_idstring required

Response

One transaction.

Changes

No recorded changes to this operation across all 1 revision of this API.