Beta

Get patient payments

GET

/api/patient-payments/v4

GET

1 import uuid
2 
3 from candid import CandidApiClient
4 from candid.resources.commons import SortDirection
5 from candid.resources.financials import PatientTransactionSource
6 from candid.resources.patient_payments.resources.v_4 import (
7     PatientPaymentSortField,
8 )
9 
10 client = CandidApiClient(
11     client_id="YOUR_CLIENT_ID",
12     client_secret="YOUR_CLIENT_SECRET",
13 )
14 client.patient_payments.v_4.get_multi(
15     limit=1,
16     patient_external_id="string",
17     claim_id=uuid.UUID(
18         "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
19     ),
20     service_line_id=uuid.UUID(
21         "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
22     ),
23     billing_provider_id=uuid.UUID(
24         "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
25     ),
26     unattributed=True,
27     invoice_id=uuid.UUID(
28         "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
29     ),
30     sources=PatientTransactionSource.MANUAL_ENTRY,
31     sort=PatientPaymentSortField.PAYMENT_SOURCE,
32     sort_direction=SortDirection.ASC,
33     page_token="eyJ0b2tlbiI6IjEiLCJwYWdlX3Rva2VuIjoiMiJ9",
34 )

Play

200Retrieved

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 }

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:

sort_directionenumOptional

Sort direction. Defaults to descending order if not provided.

Allowed values:

page_tokenstringOptional

Response

This endpoint returns an object.

itemslist of objects

next_page_tokenstringOptional

prev_page_tokenstringOptional

Get patient payments

Headers

Query parameters

Response

Errors