Menu

Please select your page

Invoices

Invoices represent the balance due by the customer. It can contain an array of costs represented as invoice lines. The sum of invoice lines make up the invoice totals, which the customer should pay. Riverty enables a variety of payment options making it as simple as possible for the customer to keep up with their payments. If the invoice is credited or paid, it is reflected in the remainingAmount object.

This can be used to perform various actions on the invoice, such as:

  • crediting the invoice

  • pausing the invoice

  • postponing the invoice due date

  • requesting an invoice copy

All of these actions are available through hypermedia controls. The actions are only present on the invoice resource if they can be used on the specific invoice.

Crediting an Invoice

Already created invoices can be credited using the invoice/v1/clients/{clientId}/invoices/{invoiceNo}/credit endpoint, effectively creating a credit note. If the customer has paid, the customer will be reimbursed. There is an option to credit individual invoice lines, or to add custom credit lines. An invoiced subscription period can only be refunded by posting a credit note.