Format

The format of the API response can be either JSON or XML.

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.

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

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 client.