Get write-off

Beta

GET

/api/write-offs/v1/:write_off_id

GET

/api/write-offs/v1/:write_off_id

1 import uuid
2 
3 from candid import CandidApiClient
4 
5 client = CandidApiClient(
6     client_id="YOUR_CLIENT_ID",
7     client_secret="YOUR_CLIENT_SECRET",
8 )
9 client.write_offs.v_1.get(
10     write_off_id=uuid.UUID(
11         "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
12     ),
13 )

Try it

200Retrieved

1 {
2   "type": "patient",
3   "amount_cents": 0,
4   "claim_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
5   "patient_external_id": "string",
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 }

Retrieves a previously created write off by its write_off_id.

Path parameters

write_off_idUUIDRequired

Response

This endpoint returns an object.

patientobject

insuranceobject

non_insurance_payerobject

Path parameters

Headers

Response