Bills API

Retrieve a bill

Read the complete frozen claim snapshot and payer packet for one bill.

GEThttps://app.mindbill.org/partner/v2/bills/{billId}

Inspect the exact immutable snapshot and payer packet behind a lifecycle or receivables record.

AuthenticationServer API key or browser session + Origin

Permissions by credentialServer: bills:read · Browser: bills:read

IdempotencyNot required

Use this URL with a server API key or a browser session and its exact allowed Origin. Both credentials use the same request and response contract. See the component API inventory for exact paths and SDK methods.

Path parameters

FieldTypeDescription

billIdRequired

string

The MindBill bill identifier returned after atomic submission.

Examples

curl https://app.mindbill.org/partner/v2/bills/$BILL_ID \
  --header "Authorization: Bearer $MINDBILL_API_KEY"

Response

200 OK

{ "id": "bill_01J6Y7F4Q4XK6P3J9G2C8A1B5D", "externalId": "report_9f7a", "state": "submitted", "billingMode": "med_legal", "documents": [], "amounts": { "charged": 2015, "paid": 0, "balance": 2015 } }

FieldTypeDescription

idRequired

string

Stable MindBill bill identifier.

externalIdRequired

string | null

Your supplied source-system identifier.

stateRequired

string

Current native lifecycle state.

billingModeRequired

"med_legal" | "professional"

Billing rule set used by the bill.

billNumberRequired

number | null

Human-readable MindBill bill number when assigned.

patientRequired

PatientSnapshot

Frozen patient values on this bill.

claimRequired

ClaimSnapshot

Frozen claim and payer values, including diagnoses.

serviceRequired

object

Primary service date, optional end date, and authorization number.

serviceLinesRequired

ServiceLine[]

Procedure lines and calculated allowed amounts.

documentsRequired

BillDocument[]

Documents currently included in the payer packet.

amountsRequired

object

Charged, paid, and balance amounts.