Patient PaymentsV4

Get patient payments

Beta
GET
https://api.joincandidhealth.com/api/patient-payments/v4
Returns all patient payments satisfying the search criteria AND whose organization_id matches the current organization_id of the authenticated user.

Query parameters

limit
optional integer
Defaults to 100. The value must be greater than 0 and less than 1000.
patient_external_id
optional string
claim_id
optional UUID
service_line_id
optional UUID
billing_provider_id
optional UUID
unattributed
optional boolean
returns payments with unattributed allocations if set to true
invoice_id
optional UUID
sources
optional enum
sort
optional enum
Defaults to payment_timestamp
Allowed values: payment_sourceamount_centspayment_timestamppayment_note
sort_direction
optional enum
Sort direction. Defaults to descending order if not provided.
Allowed values: ascdesc
page_token
optional string

Response

This endpoint return an object.
items
list of objects
next_page_token
optional string
prev_page_token
optional string
GET
/api/patient-payments/v4
curl -G https://api.joincandidhealth.com/api/patient-payments/v4 \
-H "Authorization: Bearer <token>" \
-d limit=0 \
-d patient_external_id=string
Response
{
"items": [
{
"patient_payment_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
"organization_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
"payment_source": "MANUAL_ENTRY",
"amount_cents": 0,
"patient_external_id": "string",
"allocations": [
{
"amount_cents": 0,
"target": {
"type": "service_line",
"claim_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
"encounter_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
"service_line_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"
}
}
],
"source_internal_id": "string",
"payment_timestamp": "2023-01-01T00:00:00Z",
"payment_note": "string",
"invoice": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"
}
],
"next_page_token": "string",
"prev_page_token": "string"
}