Skip to main content
GET
Retrieve Bill

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

id
integer<int64>
required

Query Parameters

include_unreleased
boolean
default:false

Also return bills that are not yet released to the PMS: bills whose visit note is unsigned and that were not released to the PMS before signing. Codes on a bill whose visit note is unsigned can still change until the note is signed. Use ready_for_pms to tell these bills apart.

Response

200 - application/json
billing_date
string<date-time>
required

The date the bill was billed.

billing_error
string
required
Maximum string length: 200
billing_raw_error
string
required
billing_provider
integer<int64>
read-only
billing_status
enum<string>
Available options:
Unbilled,
Billed,
UnresolvedError,
ResolvedError
cpts
object[]
read-only

CPT objects for the bill.

created_date
string<date-time> | null
read-only
deferred_bill
boolean
id
integer
read-only
last_modified_date
string<date-time>
read-only
metadata
object | null
notes
string | null

Additional billing notes.

ordering_provider
object
patient
integer<int64>
read-only
payment
object

Patient payment for the bill.

physician
integer<int64>
read-only
practice
integer<int64>
read-only
prior_authorization
string | null
Maximum string length: 50
ready_for_pms
boolean
read-only

Whether the bill is ready for the PMS to pick up: its visit note is billable and either signed or released to the PMS before signing, the bill is not deferred, and it is not Billed or ResolvedError. False for bills returned only because of include_unreleased=true.

ref_number
string | null
Maximum string length: 50
referring_provider
object
rendering_provider
integer<int64>
read-only
service_date
string<date-time>
read-only
service_date_timezone
string
read-only

The timezone for the service_date. Use this to convert service_date from UTC to local time. Returns the service location's timezone if available, otherwise falls back to the practice's default timezone.

service_location
object
supervising_provider
integer<int64>
read-only
visit_note_deleted_date
string<date-time> | null
read-only
visit_note_id
integer
read-only
visit_note_signed_date
string<date-time>
read-only