Create a new invoice payment event

post/invoice-payment-events

Create a new invoice payment event. Used for disputing an invoice, writing off an invoice, undisputing, un-writting off and undoing a payment for an invoice made in error

SecuritybearerAuth
Request
Request Body schema: application/json

New invoice payment event

invoiceId
required
integer <int64>

Invoice identifier

billRunType
required
string (BillRunType)

Billing run type

Enum: "NORMAL" "ADHOC"
paymentStatus
required
string (PaymentStatus)

Invoice payment status

Enum: "NA" "PAID" "UNPAID" "PENDING" "REFUNDED" "PART_REFUNDED" "REFUND_PENDING" "WRITTEN_OFF" "DISPUTED" "PARTIALLY_PAID"
notes
required
string [ 0 .. 255 ] characters [\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...

Notes on payment change

amountInMajorCurrency
number [ 0.01 .. 100000 ]

Amount in major currency (e.g pounds/dollars/euros)

Responses
200

OK

201

Created

400

Bad Request

401

Unauthorized

403

Forbidden

Request samples
application/json
{
  • "invoiceId": 0,
  • "billRunType": "NORMAL",
  • "paymentStatus": "NA",
  • "notes": "string",
  • "amountInMajorCurrency": 10.5
}
Response samples
application/json
{
  • "id": 1,
  • "invoiceId": 0,
  • "customerId": 1,
  • "billRunType": "NORMAL",
  • "paymentStatus": "NA",
  • "notes": "string",
  • "amountInMajorCurrency": 10.5
}