Sign in

v1

latestOpenAPI 3.0.32026-07-26208618579.9 KB
Update an invoice

Update invoice fields

Update invoice fields:

  • dunning - Update dunning properties.
  • dueDate - Update invoice due date. Note: It is not possible to update both dunning and dueDate in the same request, as there are no invoice statuses that allow both updates simultaneously.
patch/v1/{id}

Path parameters

idstring required

Invoice id for given invoice

Query parameters

auditUserstring required

The audit user to log the request

Request body

dueDatestring date

Date when invoice is due

Example request

{
  "dunning": {
    "reminder1TriggerDate": "2019-11-27",
    "blockTriggerDate": "2019-11-27",
    "reminder2TriggerDate": "2019-11-27",
    "collectionTriggerDate": "2019-11-27"
  }
}

Response

Successfully updated invoice for given invoice id

descriptionstring

Short description of the result of the action

idstring

Will contain the ID of the resource that has been created or updated