Sign in
Invoice Payments

Create Invoice Payment

Create Invoice Payment

post/invoices/{invoice_header_id}/payments

Path parameters

invoice_header_idinteger required

Invoice Id

Request body

organization_idinteger required
paid_onstring date required
deposit_account_idinteger required
deposit_amountnumber required
payment_method'Bank Transfer' | 'Cash' | 'Cheque' | 'Credit Card' | 'Other' | 'Online payment' | 'Trust Account' required
commentsstring
payment_referencestring

Example request

{
  "organization_id": 1,
  "paid_on": "2023-11-02",
  "deposit_account_id": 31,
  "deposit_amount": 400,
  "payment_method": "Cash",
  "comments": "Partial payment",
  "payment_reference": "TXN-20231102-01"
}

Response

Invoice payment has been created successfully.

messagestring

Example response

{
  "message": "Invoice payment has been created.",
  "invoice_payment": {
    "payment_id": 1,
    "date": "2021-11-02",
    "invoice_number": "INV-0000001",
    "payment_total": 400,
    "payment_method": "Cash",
    "comments": "Partial payment",
    "payment_reference": "TXN-20231102-01",
    "created_on": "2024-09-30T10:30:02.000000Z"
  }
}