Get Patient Financial Records

Returns the patient's debt, collection, and refund records.

GET

/:tenantId/patients/:patientId/payments

Query Parameters

Parameter	Type	Description
search	string	Searches the note and related user name fields.
sort	string	created_at, fulfilled_date, amount, type, or user.name. Prefix with - for descending order. Defaults to newest record.
filter[type]	string	debt, income, or refund.
filter[user_id]	integer	Filters debt owners or active payment distributions by user.
filter[payment_method_id]	integer	Filters by payment method. Credit card is 2.
filter[appointment_id]	integer	Filters by appointment.
filter[fulfilled_date][from]	date	Beginning of the transaction date range.
filter[fulfilled_date][to]	date	End of the transaction date range.
filter[has_undistributed_amount]	boolean	Filters payments with an undistributed amount.
group_financeable_debts	boolean	When true, returns service/package debt fragments as a single row.

Example for recently recorded credit card collections:

/:tenantId/patients/:patientId/payments?filter[type]=income&filter[payment_method_id]=2&sort=-fulfilled_date

Response

HTTP 200 OK

{
  "data": [
    {
      "id": 45002,
      "patient_id": 188413,
      "appointment_id": null,
      "user_id": null,
      "title": "Credit card collection",
      "type": "income",
      "payment_method": {
        "id": 2,
        "name": "credit_card"
      },
      "amount": "1000.00",
      "currency": "TRY",
      "exchange_rate_type": 2,
      "exchange_rate": 1,
      "base_amount": "1000.00",
      "base_currency": "TRY",
      "fulfilled_date": "2026-09-29T14:30:00.000000Z",
      "record_type": null,
      "financeable_id": null,
      "financeable_active": false,
      "financeable_summary": null,
      "split_group": null,
      "distribution": null,
      "settlement": null,
      "note": "Partial collection",
      "created_at": "2026-09-29T14:30:05.000000Z",
      "updated_at": "2026-09-29T14:30:05.000000Z",
      "financial_amounts_masked": false
    }
  ],
  "links": {
    "first": "https://<Base URL>/api/v1/:tenantId/patients/:patientId/payments?page=1",
    "last": "https://<Base URL>/api/v1/:tenantId/patients/:patientId/payments?page=1",
    "prev": null,
    "next": null
  },
  "meta": {
    "current_page": 1,
    "per_page": 15,
    "total": 1
  }
}