APapaleo
InvoiceAction

Writes off an invoice

Marks the invoice as Write Off so that the amount of such invoice is removed from the unpaid invoices.<br>You must have this scope: 'invoices.manage'.<br>For fine-grained clients, you must have this permission: 'core.invoice_actions.write_off'.

put/finance/v0-nsfw/invoice-actions/{id}/write-off

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}/write-off
  • Auth
    OAuth 2
    Implicit: https://identity.apaleo.com/connect/authorize
    Scopes: invoices.manage, admin

Path parameters

idstring required

The invoice ID

Request body

reasonstring required

The reason why the open amount of the invoice is written off

Example request

{
  "reason": "Customer refuses to pay."
}

Response

Invoice written off.

Changes

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