Sign in

v1

latestOpenAPI 3.0.02026-07-26550199.6 KB
payment

Get a paged array of payments

Get a paged array of payments

get/payments

Query parameters

id_gtinteger nullable

The starting object id of the next page

Example:200
id_ltinteger nullable

The starting object id of the previous page

Example:100
string
OR
string
string
OR
string
include_archived'true' | 'false' nullable

Whether archived objects should be retrieved, default is false

patientIdnumber nullable

Search for payments of this patient

Example:1
locationIdnumber nullable

Search for payments created at this location

Example:1

Response

A paged array of payments

Example response

{
  "data": [
    {
      "id": 1,
      "paymentNumber": "RCPT-0001",
      "amount": 193.99,
      "patientId": 1,
      "locationId": 1,
      "paymentMethodId": 1,
      "paymentInvoices": [
        {
          "invoiceId": 1,
          "amount": 193.99
        }
      ],
      "creditAllocations": []
    }
  ],
  "links": {
    "previousPage": "/v1/${object_type}?id_gt=200",
    "nextPage": "/v1/${object_type}?id_lt=100"
  }
}