Write OffsV1

Get all write-offs

Beta
GET
https://api.joincandidhealth.com/api/write-offs/v1
Returns all write-offs satisfying the search criteria.

Query parameters

limit
optional integer
Defaults to 100. The value must be greater than 0 and less than 1000.
patient_external_id
optional string
payer_uuid
optional UUID
service_line_id
optional UUID
claim_id
optional UUID
billing_provider_id
optional UUID
sort
optional enum
Defaults to write_off_timestamp
Allowed values: amount_centswrite_off_timestampwrite_off_note
sort_direction
optional enum
Sort direction. Defaults to descending order if not provided.
Allowed values: ascdesc
page_token
optional string
account_types
optional enum
Filters the returned values to include only the provided account types.
Allowed values: PATIENTINSURANCE

Response

This endpoint return an object.
items
list of unions
next_page_token
optional string
prev_page_token
optional string
GET
/api/write-offs/v1
curl -G https://api.joincandidhealth.com/api/write-offs/v1 \
-H "Authorization: Bearer <token>" \
-d limit=0 \
-d patient_external_id=string
Response
{
"items": [
{
"type": "patient",
"amount_cents": 0,
"service_line_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
"write_off_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
"write_off_reason": "SMALL_BALANCE",
"write_off_timestamp": "2023-01-01T00:00:00Z",
"reverted_by_write_off_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
"reverts_write_off_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
"write_off_note": "string"
}
],
"next_page_token": "string",
"prev_page_token": "string"
}