Switch invoice state

Switch the state of an existing invoice.

Path Params
integer
required

An internal identifier that is unique to each Invoice within B2Brouter.

Body Params

Attributes to update the state of the invoice

string
enum
required

Valid states for an issued invoice:

  • new - The initial status of an issued invoice.
  • sent - The invoice has been sent successfully.
  • accepted - When the invoice is marked as accepted.
  • registered - When a registered notification has been received or manually marked as registered.
  • refused - When a refused notification has been received or manually marked as refused.
  • paid - When the invoice has been paid or the invoice is marked manually as paid.
  • closed - Is a final state.

Valid states for a received invoice:

  • new - The initial status of a received invoice or manually marked as new.
  • paid - When the invoice has been paid or the invoice is marked manually as paid.
  • accepted - When the invoice is marked as accepted.
  • refused - When the invoice is marked as refused.
  • annotated - When the invoice is marked annotated.

Valid states for an issued simplified invoice:

  • new - The initial status of an issued simplified invoice.
  • sent - The invoice has been sent successfully.
  • paid - When the invoice has been paid or the invoice is marked manually as paid.
  • downloaded - When the invoice has been downloaded or manually marked as downloaded.
  • accepted - When the invoice is marked as accepted.
  • refused - When a refused notification has been received or manually marked as refused.
  • registered - When a registered notification has been received or manually marked as registered.
  • closed - Is a final state.

Valid states for an issued self-invoice:

  • paid - When the invoice has been paid or the invoice is marked manually as paid.
  • accepted - When the invoice is marked as accepted.
  • registered - When a registered notification has been received or manually marked as registered.
  • closed - Is a final state.
string
enum

Used to send notification of the state chan via mail to the contact. Only for Received Invoices and for states 'accepted', 'refused' & 'paid'.

Allowed:
string

To annotate the reason of the state change, if commit is 'with_mail', and the new state is 'accepted', 'refused' or 'paid', the reason will be included in the mail sent to the contact.

Headers
string
Defaults to 2026-03-02

Specifies the version of the API to use in this request. If not specified uses the API-Version set in the group conifguration B2Brouter UI Application -> Developers -> API Keys -> API Version

Responses

401

Unauthorized

404

Invoice not found

Language
Credentials
Header
URL
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json