Write OffsV1

Get all write-offs

Beta
GET
Returns all write-offs satisfying the search criteria.

Query parameters

limitintegerOptional
Defaults to 100. The value must be greater than 0 and less than 1000.
patient_external_idstringOptional
payer_uuidUUIDOptional
service_line_idUUIDOptional
claim_idUUIDOptional
billing_provider_idUUIDOptional
sortenumOptional

Defaults to write_off_timestamp

Allowed values: amount_centswrite_off_timestampwrite_off_note
sort_directionenumOptional
Sort direction. Defaults to descending order if not provided.
Allowed values: ascdesc
page_tokenstringOptional
account_typesenumOptional
Filters the returned values to include only the provided account types.
Allowed values: PATIENTINSURANCE

Response

This endpoint returns an object
items
list of unions
next_page_token
stringOptional
prev_page_token
stringOptional
GET
1curl -G https://api.joincandidhealth.com/api/write-offs/v1 \
2 -H "Authorization: Bearer <token>" \
3 -d limit=0 \
4 -d patient_external_id=string
200Retrieved
1{
2 "items": [
3 {
4 "type": "patient",
5 "amount_cents": 0,
6 "service_line_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
7 "write_off_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
8 "write_off_reason": "SMALL_BALANCE",
9 "write_off_timestamp": "2023-01-01T00:00:00Z",
10 "reverted_by_write_off_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
11 "reverts_write_off_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
12 "write_off_note": "string"
13 }
14 ],
15 "next_page_token": "string",
16 "prev_page_token": "string"
17}