Beta

Get all write-offs

GET

/api/write-offs/v1

GET

1 import uuid
2 
3 from candid import CandidApiClient
4 from candid.resources.commons import SortDirection
5 from candid.resources.financials import AccountType
6 from candid.resources.write_offs.resources.v_1 import WriteOffSortField
7 
8 client = CandidApiClient(
9     client_id="YOUR_CLIENT_ID",
10     client_secret="YOUR_CLIENT_SECRET",
11 )
12 client.write_offs.v_1.get_multi(
13     limit=1,
14     patient_external_id="string",
15     payer_uuid=uuid.UUID(
16         "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
17     ),
18     service_line_id=uuid.UUID(
19         "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
20     ),
21     claim_id=uuid.UUID(
22         "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
23     ),
24     billing_provider_id=uuid.UUID(
25         "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
26     ),
27     sort=WriteOffSortField.AMOUNT_CENTS,
28     sort_direction=SortDirection.ASC,
29     page_token="eyJ0b2tlbiI6IjEiLCJwYWdlX3Rva2VuIjoiMiJ9",
30     account_types=AccountType.PATIENT,
31 )

Play

200Retrieved

1 {
2   "items": [
3     {
4       "type": "patient",
5       "amount_cents": 0,
6       "claim_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
7       "patient_external_id": "string",
8       "service_line_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
9       "write_off_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
10       "write_off_reason": "SMALL_BALANCE",
11       "write_off_timestamp": "2023-01-01T00:00:00Z",
12       "reverted_by_write_off_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
13       "reverts_write_off_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
14       "write_off_note": "string"
15     }
16   ],
17   "next_page_token": "string",
18   "prev_page_token": "string"
19 }

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:

sort_directionenumOptional

Sort direction. Defaults to descending order if not provided.

Allowed values:

page_tokenstringOptional

account_typesenumOptional

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

Allowed values:

Response

This endpoint returns an object.

itemslist of objects

next_page_tokenstringOptional

prev_page_tokenstringOptional

Headers

Query parameters

Response