Get non-insurance payer payments

Beta

GET

/api/non-insurance-payer-payments/v1

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         "address": {
12           "address1": "string",
13           "city": "string",
14           "state": "AA",
15           "zip_code": "string",
16           "address2": "string",
17           "zip_plus_four_code": "string"
18         }
19       },
20       "amount_cents": 0,
21       "allocations": [
22         {
23           "amount_cents": 0,
24           "target": {
25             "type": "service_line",
26             "claim_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
27             "encounter_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
28             "service_line_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"
29           }
30         }
31       ],
32       "check_number": "string",
33       "payment_timestamp": "2023-01-01T00:00:00Z",
34       "payment_note": "string",
35       "invoice_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"
36     }
37   ],
38   "next_page_token": "string",
39   "prev_page_token": "string"
40 }

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	"address": {
12	"address1": "string",
13	"city": "string",
14	"state": "AA",
15	"zip_code": "string",
16	"address2": "string",
17	"zip_plus_four_code": "string"
18	}
19	},
20	"amount_cents": 0,
21	"allocations": [
22	{
23	"amount_cents": 0,
24	"target": {
25	"type": "service_line",
26	"claim_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
27	"encounter_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
28	"service_line_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"
29	}
30	}
31	],
32	"check_number": "string",
33	"payment_timestamp": "2023-01-01T00:00:00Z",
34	"payment_note": "string",
35	"invoice_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"
36	}
37	],
38	"next_page_token": "string",
39	"prev_page_token": "string"
40	}