Get non-insurance payer payments

Beta

GET

Returns all non-insurance payer payments

Query parameters

limitintegerOptional

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

non_insurance_payer_idUUIDOptional

check_numberstringOptional

invoice_idUUIDOptional

sort"amount_cents" or "payment_timestamp"Optional

Defaults to refund_timestamp

Allowed values: amount_centspayment_timestamp

sort_direction"asc" or "desc"Optional

Sort direction. Defaults to descending order if not provided.

Allowed values: ascdesc

page_tokenstringOptional

Response

This endpoint returns an object.

itemslist of objects

next_page_tokenstringOptional

prev_page_tokenstringOptional

Errors

GET

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

1 {
2   "items": [
3     {
4       "non_insurance_payer_payment_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
5       "non_insurance_payer": {
6         "non_insurance_payer_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
7         "name": "string",
8         "enabled": true,
9         "description": "string",
10         "category": "string"
11       },
12       "amount_cents": 0,
13       "allocations": [
14         {
15           "amount_cents": 0,
16           "target": {
17             "type": "service_line",
18             "claim_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
19             "encounter_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
20             "service_line_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"
21           }
22         }
23       ],
24       "check_number": "string",
25       "payment_timestamp": "2023-01-01T00:00:00Z",
26       "payment_note": "string",
27       "invoice_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"
28     }
29   ],
30   "next_page_token": "string",
31   "prev_page_token": "string"
32 }

Built with

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

1	{
2	"items": [
3	{
4	"non_insurance_payer_payment_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
5	"non_insurance_payer": {
6	"non_insurance_payer_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
7	"name": "string",
8	"enabled": true,
9	"description": "string",
10	"category": "string"
11	},
12	"amount_cents": 0,
13	"allocations": [
14	{
15	"amount_cents": 0,
16	"target": {
17	"type": "service_line",
18	"claim_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
19	"encounter_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
20	"service_line_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"
21	}
22	}
23	],
24	"check_number": "string",
25	"payment_timestamp": "2023-01-01T00:00:00Z",
26	"payment_note": "string",
27	"invoice_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"
28	}
29	],
30	"next_page_token": "string",
31	"prev_page_token": "string"
32	}