PATCH
/
v1
/
{id}
curl --request PATCH \
  --url https://integration-api-cat2./%7B{environment}%7D.ext.%7B{realm}%7D.cia.enfuce.com/invoice/v1/{id} \
  --header 'Content-Type: application/json' \
  --data '{
  "dueDate": "2019-11-27",
  "dunning": {
    "reminder1TriggerDate": "2019-11-27",
    "blockTriggerDate": "2019-11-27",
    "reminder2TriggerDate": "2019-11-27",
    "collectionTriggerDate": "2019-11-27",
    "dunningStatus": "STOPPED"
  }
}'
{
  "amount": 123,
  "createdDate": "2019-11-27T05:08:31",
  "dueDate": "2019-11-27",
  "id": "<string>",
  "paidAmount": 123,
  "paymentReference": {
    "number": 1234567897,
    "type": "MOD10"
  },
  "period": {
    "start": "2020-01-01",
    "end": "2020-01-31"
  },
  "status": "CLOSED",
  "dunning": {
    "dunningStatus": "WAIT",
    "reminder1TriggerDate": "2019-11-27",
    "blockTriggerDate": "2019-11-27",
    "reminder2TriggerDate": "2019-11-27",
    "collectionTriggerDate": "2019-11-27"
  },
  "invoiceNumber": "<string>"
}

Path Parameters

​
id
string
required

Invoice id for given invoice

Query Parameters

​
auditUser
string
required

The audit user to log the request

Body

application/json
Update invoice request body

Update invoice request body, as for now only the dunning properties and invoice due date can be updated. Invoice must be overdue in order to update dunning properties.

​
dueDate
string

Date when invoice is due

Example:

"2019-11-27"

​
dunning
object

Response

200
application/json
Successfully updated invoice for given invoice id
​
amount
number

Total amount of this invoice

​
createdDate
string

Date when invoice was created

Example:

"2019-11-27T05:08:31"

​
dueDate
string

Date when invoice is due

Example:

"2019-11-27"

​
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