v1

latestOpenAPI 3.1.02026-07-24447622848.7 KB
Bills

Partially Update Bill

patch/api/2.0/bills/{id}/

Path parameters

idinteger required

Request body

billing_datestring date-time nullable

The date the bill was billed. Required if marking a bill as processed.

billing_errorstring nullable

The error message for the bill. Required if marking a bill as failed. This is the human readable error that users will see.

billing_providerinteger nullable
billing_raw_errorstring nullable

Further details on the billing error. Optional when marking a bill as failed. Useful when debugging why a bill failed to process.

metadataobject
notesstring nullable

Additional billing notes.

payment_amountstring decimal nullable

Dollar amount of the patient payment.

practiceinteger
prior_authorizationstring nullable
ref_numberstring

The reference number of the bill. Required if marking a bill as processed.

rendering_providerinteger nullable
service_locationinteger

The id of the service location the bill is associated with.

supervising_providerinteger nullable

The id of the provider who has undertaken primary responsibility for the patient's health.

visit_noteinteger

Response

billing_datestring date-time nullable

The date the bill was billed. Required if marking a bill as processed.

billing_errorstring nullable

The error message for the bill. Required if marking a bill as failed. This is the human readable error that users will see.

billing_providerinteger nullable
billing_raw_errorstring nullable

Further details on the billing error. Optional when marking a bill as failed. Useful when debugging why a bill failed to process.

metadataobject
notesstring nullable

Additional billing notes.

payment_amountstring decimal nullable

Dollar amount of the patient payment.

practiceinteger
prior_authorizationstring nullable
ref_numberstring

The reference number of the bill. Required if marking a bill as processed.

rendering_providerinteger nullable
service_locationinteger

The id of the service location the bill is associated with.

supervising_providerinteger nullable

The id of the provider who has undertaken primary responsibility for the patient's health.

visit_noteinteger