provider
billing

List Payments

This endpoint aggregates patient payments and insurance payments into a single table, then filters them according to the PaymentFetchParams. Using DISTINCT on JSON requires either casting them to JSONB (with an equality operator) or removing DISTINCT. Here, we cast to JSONB so that Postgres can do equality checks on the JSON objects.

get/billing/payment/table

Query parameters

pageinteger nullable
per_pageinteger nullable
sort_bystring nullable
sort_direction'asc' | 'desc' nullable
location_idstring nullable
idstring nullable
payerstring nullable
external_patient_idstring nullable
payer_typestring nullable
amountinteger[] nullable
last4string nullable
commentstring nullable
payment_mediumsstring[] nullable
statusPaymentStatus[] nullable
typestring nullable
tagsstring[] nullable
string[]
OR
string
tzstring nullable
location_idsstring[] nullable
creator_namestring nullable
merchant_account_idsstring[] nullable

Headers

TENANTstring required

The tenant you are making this request on behalf of

API-KEYstring required

Your api key

Response

Successful Response

hasInsurancePaymentsboolean required

Changes

No recorded changes to this endpoint across all 1 revision of this API.