Invoices
Archive the invoice
As the app's Archive. The invoice drops out of default lists (filter[archived] brings it back), its customer can't pay it from the invoice link, it isn't charged by autopay, synced to accounting or, if it is a recurring template, generated from, and it is read-only in the app until it is unarchived. An invoice whose payment is processing can't be archived (422). Idempotent: archiving an archived invoice returns it unchanged. Needs the role's Invoices Archive permission, and invoice archiving turned on for the account.
post/v1/invoices/{invoice_id}/archival
Request
- Base URL: https://api.topkey.io
- URL: https://api.topkey.io/v1/invoices/{invoice_id}/archival
- Auth: HTTP bearer
Path parameters
invoice_idstring required
Response
One invoice.
Changes
No recorded changes to this operation across all 1 revision of this API.