JOjoincandidhealth
v1

Get patient refunds

Changed on

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

get/api/patient-refunds/v1

Request

  • Base URL
    https://pre-api.joincandidhealth.com
  • URL
    https://pre-api.joincandidhealth.com/api/patient-refunds/v1
  • Auth
    HTTP bearer

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' | 'LOCKBOX'
sort'refund_source' | 'amount_cents' | 'refund_timestamp' | 'refund_reason' | 'refund_note'

Defaults to refund_timestamp

sort_direction'asc' | 'desc'

Sort direction. Defaults to descending order if not provided.

page_tokenstring

Response

Response with status 200

prev_page_tokenstring
next_page_tokenstring

Changes

  • 24b2d80d577aRevision 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 refund_note to the query request parameter sort

    • info

      added the new enum value refund_reason to the query request parameter sort

    • info

      added the new enum value refund_source to the query request parameter sort

    • info

      added the new enum value refund_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

  • 3a81ee81d4edRevision changes
    • info

      api operation id getMulti removed and replaced with v1_getMulti_3