Insurance RefundsV1

Get insurance refunds

Beta

GET

Returns all insurance refunds satisfying the search criteria AND whose organization_id matches the current organization_id of the authenticated user.

Query parameters

limitintegerOptional

Defaults to 100. The value must be greater than 0 and less than 1000.

payer_uuidUUIDOptional

claim_idUUIDOptional

service_line_idUUIDOptional

billing_provider_idUUIDOptional

sortenumOptional

Defaults to refund_timestamp

Allowed values: amount_centsrefund_timestamprefund_noterefund_reason

sort_directionenumOptional

Sort direction. Defaults to descending order if not provided.

Allowed values: ascdesc

page_tokenstringOptional

Response

This endpoint returns an object

items

list of objects

next_page_token

stringOptional

prev_page_token

stringOptional

Errors

GET

1 curl -G https://api.joincandidhealth.com/api/insurance-refunds/v1 \
2      -H "Authorization: Bearer <token>" \
3      -d limit=0 \
4      -d payer_uuid=d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32

1 {
2   "items": [
3     {
4       "insurance_refund_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
5       "payer": {
6         "payer_uuid": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
7         "payer_id": "string",
8         "payer_name": "string"
9       },
10       "amount_cents": 0,
11       "allocations": [
12         {
13           "amount_cents": 0,
14           "target": {
15             "type": "service_line",
16             "claim_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
17             "encounter_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
18             "service_line_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"
19           }
20         }
21       ],
22       "refund_timestamp": "2023-01-01T00:00:00Z",
23       "refund_note": "string",
24       "refund_reason": "OVERCHARGED"
25     }
26   ],
27   "next_page_token": "string",
28   "prev_page_token": "string"
29 }

Built with

1	curl -G https://api.joincandidhealth.com/api/insurance-refunds/v1 \
2	-H "Authorization: Bearer <token>" \
3	-d limit=0 \
4	-d payer_uuid=d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32

1	{
2	"items": [
3	{
4	"insurance_refund_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
5	"payer": {
6	"payer_uuid": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
7	"payer_id": "string",
8	"payer_name": "string"
9	},
10	"amount_cents": 0,
11	"allocations": [
12	{
13	"amount_cents": 0,
14	"target": {
15	"type": "service_line",
16	"claim_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
17	"encounter_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
18	"service_line_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"
19	}
20	}
21	],
22	"refund_timestamp": "2023-01-01T00:00:00Z",
23	"refund_note": "string",
24	"refund_reason": "OVERCHARGED"
25	}
26	],
27	"next_page_token": "string",
28	"prev_page_token": "string"
29	}