Patient PaymentsV4

Get patient payments

Beta
GET

Returns all patient payments 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.
patient_external_idstringOptional
claim_idUUIDOptional
service_line_idUUIDOptional
billing_provider_idUUIDOptional
unattributedbooleanOptional
returns payments with unattributed allocations if set to true
invoice_idUUIDOptional
sourcesenumOptional
sortenumOptional

Defaults to payment_timestamp

Allowed values: payment_sourceamount_centspayment_timestamppayment_note
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
1curl -G https://api.joincandidhealth.com/api/patient-payments/v4 \
2     -H "Authorization: Bearer <token>" \
3     -d limit=0 \
4     -d patient_external_id=string
1{
2  "items": [
3    {
4      "patient_payment_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
5      "organization_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
6      "payment_source": "MANUAL_ENTRY",
7      "amount_cents": 0,
8      "patient_external_id": "string",
9      "allocations": [
10        {
11          "amount_cents": 0,
12          "target": {
13            "type": "service_line",
14            "claim_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
15            "encounter_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
16            "service_line_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"
17          }
18        }
19      ],
20      "source_internal_id": "string",
21      "payment_timestamp": "2023-01-01T00:00:00Z",
22      "payment_note": "string",
23      "invoice": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"
24    }
25  ],
26  "next_page_token": "string",
27  "prev_page_token": "string"
28}
Built with