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

Request

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

source_internal_idstring

sort'payment_source' | 'amount_cents' | 'payment_timestamp' | 'payment_note'

Defaults to payment_timestamp

sort_direction'asc' | 'desc'

Sort direction. Defaults to descending order if not provided.

page_tokenstring

Response with status 200

prev_page_tokenstring

next_page_tokenstring

Sep 17, 202624b2d80d577a Revision changes
- breaking
  the query request parameter sort was restricted to a list of enum values
- breaking
  the response's body type changed from no type to object for status
- warning
  deleted the header request parameter Authorization
- info
  the endpoint scheme security OAuthScheme was added to the API
- info
  added the new enum value amount_cents to the query request parameter sort
- info
  added the new enum value payment_note to the query request parameter sort
- info
  added the new enum value payment_source to the query request parameter sort
- info
  added the new enum value payment_timestamp to the query request parameter sort
- info
  for the query request parameter sort, the type was generalized from no type to string
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the required property to the response with the status
Sep 12, 20263a81ee81d4ed Revision changes
- info
  api operation id getMulti removed and replaced with v4_getMulti