Create Superbill

1 import datetime 2 3 from candid import CandidApiClient 4 from candid.resources.commons import State, StreetAddressShortZip 5 6 client = CandidApiClient( 7 client_id="YOUR_CLIENT_ID", 8 client_secret="YOUR_CLIENT_SECRET", 9 ) 10 client.superbills.v_1.create_superbill( 11 patient_external_id="string", 12 date_range_min=datetime.date.fromisoformat( 13 "2023-01-15", 14 ), 15 date_range_max=datetime.date.fromisoformat( 16 "2023-01-15", 17 ), 18 pay_to_address=StreetAddressShortZip( 19 address_1="123 Main St", 20 address_2="Apt 1", 21 city="New York", 22 state=State.NY, 23 zip_code="10001", 24 zip_plus_four_code="1234", 25 ), 26 )

1 { 2 "superbills": [ 3 { 4 "superbill_id": "string", 5 "patient_external_id": "string", 6 "authed_url": "string", 7 "date_range_min": "2023-01-01", 8 "date_range_max": "2023-01-01", 9 "file_name": "string" 10 } 11 ] 12 }

Request

This endpoint expects an object.

patient_external_idstringRequired

Empty string not allowed

date_range_mindateRequired

Minimum (inclusive) date selected for the superbill

date_range_maxdateRequired

Maximum (inclusive) date selected for the superbill

pay_to_addressobjectOptional

Address that will be displayed on the superbill as the ‘Pay to’ Address. If not provided this value will be set from available encounter data.

Response

This endpoint returns an object.

superbillslist of objects

Each object represents a single Superbill for a single billing provider.

Headers

Request

Response

Errors