Get patient payments

Beta
GET

Returns all patient payments satisfying the search criteria AND whose organization_id matches the current organization_id of the authenticated user.

Query parameters

limitintegerOptional
Defaults to 100. The value must be greater than 0 and less than 1000.
patient_external_idstringOptional
claim_idUUIDOptional
service_line_idUUIDOptional
billing_provider_idUUIDOptional
unattributedbooleanOptional
returns payments with unattributed allocations if set to true
invoice_idUUIDOptional
sourcesenumOptional
sortenumOptional

Defaults to payment_timestamp

Allowed values: payment_sourceamount_centspayment_timestamppayment_note
sort_direction"asc" or "desc"Optional
Sort direction. Defaults to descending order if not provided.
Allowed values: ascdesc
page_tokenstringOptional

Response

This endpoint returns an object.
itemslist of objects
next_page_tokenstringOptional
prev_page_tokenstringOptional

Errors

Built with