v4

Get patient payments

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

get/api/patient-payments/v4

Query parameters

limitinteger

Defaults to 100. The value must be greater than 0 and less than 1000.

patient_external_idstring
claim_idstring uuid
service_line_idstring uuid
billing_provider_idstring uuid
unattributedboolean

returns payments with unattributed allocations if set to true

invoice_idstring uuid
sources'MANUAL_ENTRY' | 'CHARGEBEE' | 'SQUARE' | 'STRIPE' | 'ELATION' | 'CEDAR' | 'HEALTHIE' | 'REALLOCATION' | 'PHREESIA' | 'INSTAMED' | 'SHERPA_HEALTH'
source_internal_idstring
sortV4PatientPaymentSortField — unresolved $ref

Defaults to payment_timestamp

sort_direction'asc' | 'desc'

Sort direction. Defaults to descending order if not provided.

page_tokenstring

Headers

Authorizationstring required

OAuth authentication

Response

Response with status 200

V4PatientPaymentsPage required— unresolved $ref