Sign in

v1

latestOpenAPI 3.0.02026-07-26550199.6 KB
payment

Create single payment for specific invoice

Create single payment for specific invoice

post/payments

Request body

patientIdinteger required

Patient id

locationIdinteger required

Location id

paymentMethodIdinteger required

Payment method id

amountnumber nullable required

Total payment amount, it should be the same as the sum of all paymentInvoice amount

xeroIdstring uuid

Xero batch payment id, only applicable for Xero batch payment

Example request

{
  "patientId": 1,
  "locationId": 1,
  "paymentMethodId": 1,
  "amount": 193.99,
  "paymentInvoices": [
    {
      "invoiceId": 1,
      "amount": 193.99
    }
  ]
}

Response

Object with payment data.

idinteger required

Payment id

paymentNumberstring required

Payment number

amountnumber nullable required

Total payment amount. 0 for credit allocation

patientIdinteger required

The payment patient id

locationIdinteger required

The payment location id

paymentMethodIdinteger nullable required

The payment method id, null for credit allocation

xeroIdstring uuid nullable required

Xero batch payment id

archivedboolean nullable

Whether the payment has been archived

Example response

{
  "id": 1,
  "paymentNumber": "RCPT-0001",
  "amount": 193.99,
  "patientId": 1,
  "locationId": 1,
  "paymentMethodId": 1,
  "paymentInvoices": [
    {
      "invoiceId": 1,
      "amount": 193.99
    }
  ],
  "creditAllocations": []
}