Get insurance payments

1 import uuid 2 3 from candid import CandidApiClient 4 from candid.resources.commons import SortDirection 5 from candid.resources.insurance_payments.resources.v_1 import ( 6 InsurancePaymentSortField, 7 ) 8 9 client = CandidApiClient( 10 client_id="YOUR_CLIENT_ID", 11 client_secret="YOUR_CLIENT_SECRET", 12 ) 13 client.insurance_payments.v_1.get_multi( 14 limit=1, 15 payer_uuid=uuid.UUID( 16 "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", 17 ), 18 claim_id=uuid.UUID( 19 "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", 20 ), 21 service_line_id=uuid.UUID( 22 "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", 23 ), 24 billing_provider_id=uuid.UUID( 25 "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", 26 ), 27 sort=InsurancePaymentSortField.AMOUNT_CENTS, 28 sort_direction=SortDirection.ASC, 29 page_token="eyJ0b2tlbiI6IjEiLCJwYWdlX3Rva2VuIjoiMiJ9", 30 )

1 { 2 "items": [ 3 { 4 "insurance_payment_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", 5 "payer": { 6 "payer_uuid": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", 7 "payer_id": "string", 8 "payer_name": "string", 9 "availity_payer_name": "string", 10 "availity_claims_payer_id": "string", 11 "availity_eligibility_id": "string", 12 "availity_remittance_payer_id": "string", 13 "street_address": { 14 "address1": "string", 15 "city": "string", 16 "state": "AA", 17 "zip_code": "string", 18 "zip_plus_four_code": "string", 19 "address2": "string" 20 } 21 }, 22 "amount_cents": 0, 23 "allocations": [ 24 { 25 "amount_cents": 0, 26 "target": { 27 "type": "service_line", 28 "claim_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", 29 "encounter_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", 30 "service_line_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32" 31 } 32 } 33 ], 34 "payment_timestamp": "2023-01-01T00:00:00Z", 35 "payment_note": "string" 36 } 37 ], 38 "next_page_token": "string", 39 "prev_page_token": "string" 40 }

Returns all non-ERA originated insurance payments satisfying the search criteria

Query parameters

limitintegerOptional

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

payer_uuidUUIDOptional

claim_idUUIDOptional

service_line_idUUIDOptional

billing_provider_idUUIDOptional

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

Headers

Query parameters

Response

Errors