Create write-off

Beta

POST

/api/write-offs/v1

Creates one or many write-offs applied toward a specific service line, claim, or billing provider.

Request

This endpoint expects an object.

write_offslist of objectsRequired

Response

This endpoint returns an object.

write_offslist of objects

POST

1 curl -X POST https://api.joincandidhealth.com/api/write-offs/v1 \
2      -H "Authorization: Bearer <token>" \
3      -H "Content-Type: application/json" \
4      -d '{
5   "write_offs": [
6     {
7       "type": "patient",
8       "amount_cents": 0,
9       "service_line_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
10       "write_off_reason": "SMALL_BALANCE",
11       "write_off_timestamp": "2023-01-01T00:00:00Z"
12     }
13   ]
14 }'

200Successful

1 {
2   "write_offs": [
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 }

Built with

1	curl -X POST https://api.joincandidhealth.com/api/write-offs/v1 \
2	-H "Authorization: Bearer <token>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"write_offs": [
6	{
7	"type": "patient",
8	"amount_cents": 0,
9	"service_line_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
10	"write_off_reason": "SMALL_BALANCE",
11	"write_off_timestamp": "2023-01-01T00:00:00Z"
12	}
13	]
14	}'