APapaleo
InvoiceAction

Cancels an invoice

For regular invoices and AR invoices that haven't been paid yet, creates a new cancellation invoice and opens the folio again. For advance invoices, creates a new cancellation invoice. For deposit invoices, creates a deposit cancellation. Re-issuing the entry then creates a deposit correction.<br>You must have this scope: 'invoices.manage'.<br>For fine-grained clients, you must have this permission: 'core.invoice_actions.cancel'.

put/finance/v0-nsfw/invoice-actions/{id}/cancel

Request

  • Base URL
    https://api.apaleo.com (the document declares no server; this is the origin it was published from)
  • URL
    https://api.apaleo.com/finance/v0-nsfw/invoice-actions/{id}/cancel
  • Auth
    OAuth 2
    Implicit: https://identity.apaleo.com/connect/authorize
    Scopes: invoices.manage, admin

Path parameters

idstring required

The invoice ID

Request body

reasonCode'ChangeOfRecipientDetails' | 'ChangeOfInvoiceRecipient' | 'ChangeOfPaymentMethod' | 'ChangeOfInvoiceTransactions' | 'Other' required

The code of the reason why the invoice is cancelled.

Example request

{
  "reasonCode": "ChangeOfRecipientDetails"
}

Response

Invoice canceled.

Changes

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