Authorizations

Authorization
string
headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
integer
required

Response

200 - application/json
id
integer
required

Payment id

paymentNumber
string
required

Payment number

amount
number | null
required

Total payment amount. 0 for credit allocation

patientId
integer
required

The payment patient id

locationId
integer
required

The payment location id

paymentMethodId
integer | null
required

The payment method id, null for credit allocation

paymentDate
required

Payment date

paymentInvoices
object[]
required

Payments made to invoices

creditAllocations
object[]
required

Credit allocated to invoices

xeroId
string | null
required

Xero batch payment id

archivedAt
required

Payment archive date time

Create one payment for specific invoiceDelete one payment by ID