Get a paged array of payments
curl --request GET \
  --url https://api.splose.com/v1/payments \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": 1,
      "paymentNumber": "RCPT-0001",
      "amount": 193.99,
      "patientId": 1,
      "locationId": 1,
      "paymentMethodId": 1,
      "paymentDate": "2023-07-30T09:00:00.000Z",
      "paymentInvoices": [
        {
          "invoiceId": 1,
          "amount": 193.99,
          "xeroId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        }
      ],
      "creditAllocations": [],
      "xeroId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "archivedAt": "<string>",
      "archived": false
    }
  ],
  "links": {
    "previousPage": "/v1/${object_type}?id_gt=200",
    "nextPage": "/v1/${object_type}?id_lt=100"
  }
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
id_gt
integer | null

The starting object id of the next page

Example:

200

​
id_lt
integer | null

The starting object id of the previous page

Example:

100

​
update_gt

Search for objects updated after this date time

Example:

"2023-07-30T09:00:00.000Z"

​
update_lt

Search for objects updated before this date time

Example:

"2023-07-30T09:00:00.000Z"

​
include_archived
enum<string> | null
default:false

Whether archived objects should be retrieved, default is false

Available options:
true,
false
​
patientId
number | null

Search for payments of this patient

Example:

1

​
locationId
number | null

Search for payments created at this location

Example:

1

Response

200 - application/json

A paged array of payments

The response is of type object.