JOjoincandidhealth
v1

Get all write-offs

Changed on

Returns all write-offs satisfying the search criteria.

get/api/write-offs/v1

Request

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

Query parameters

limitinteger

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

patient_external_idstring
payer_uuidstring uuid
service_line_idstring uuid
claim_idstring uuid
billing_provider_idstring uuid
sort'amount_cents' | 'write_off_timestamp' | 'write_off_note'

Defaults to write_off_timestamp

sort_direction'asc' | 'desc'

Sort direction. Defaults to descending order if not provided.

page_tokenstring
account_types'PATIENT' | 'INSURANCE' | 'THIRD_PARTY_PAYER'

Filters the returned values to include only the provided account types.

Response

Response with status 200

prev_page_tokenstring
next_page_tokenstring

Changes

  • 7fd881bab7b6Revision changes
    • breaking

      added subschema #2 subschema #3 to the / response property oneOf list for the response status

    • info

      removed subschema #2 subschema #3 from the / response property oneOf list for the response status

  • 72fc5ca65ba5Revision changes
    • breaking

      added subschema #1 subschema #2 subschema #3 to the / response property oneOf list for the response status

    • info

      removed subschema #1 subschema #2 subschema #3 from the / response property oneOf list for the response status