Payment
Create one payment for specific invoice
Create one payment for specific invoice
Authorizations
Authorization
string
headerrequiredBearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Body
application/json
patientId
integer
requiredPatient id
locationId
integer
requiredLocation id
paymentMethodId
integer
requiredPayment method id
amount
number | null
requiredTotal payment amount, it should be the same as the sum of all paymentInvoice amount
paymentDate
required
Payment date
paymentInvoices
object[]
requiredPayments made to invoices
xeroId
string
Xero batch payment id, only applicable for Xero batch payment
Response
200 - application/json
id
integer
requiredPayment id
paymentNumber
string
requiredPayment number
amount
number | null
requiredTotal payment amount. 0 for credit allocation
patientId
integer
requiredThe payment patient id
locationId
integer
requiredThe payment location id
paymentMethodId
integer | null
requiredThe payment method id, null for credit allocation
paymentDate
required
Payment date
paymentInvoices
object[]
requiredPayments made to invoices
creditAllocations
object[]
requiredCredit allocated to invoices
xeroId
string | null
requiredXero batch payment id
archivedAt
required
Payment archive date time