Update invoice information
Update invoice by given invoice id
This operation will update an invoice by given invoice id
PATCH
/
v1
/
{id}
Path Parameters
id
string
requiredInvoice id for given invoice
Query Parameters
auditUser
string
requiredThe audit user to log the request
Body
application/json
Update invoice request body, as for now only the dunning properties can be updated. Invoice should be overdue in order to update dunning properties.
dunning
object
Response
200 - application/json
amount
number
Total amount of this invoice
createdDate
string
Date when invoice was created
dueDate
string
Date when invoice is due
id
string
Unique id for invoice
paidAmount
number
Total amount that is paid of this invoice
paymentReference
object
Number connected to account that will be used to map incoming payments to
period
object
status
enum<string>
- CLOSED Closed
- OPEN Open
- OVERDUE Overdue
- PAID Paid
- PAID_PARTIALLY Partially Paid
- WRITE-OFF Written Off
Available options:
CLOSED
, OPEN
, OVERDUE
, PAID
, PAID_PARTIALLY
, WRITE-OFF
dunning
object
Dunning details, this should only be populated if invoice status is overdue
invoiceNumber
string
Number of the invoice