Sign in

Bills API

List bills

List bills belonging to the authenticated organization.

GEThttps://app.mindbill.org/partner/v2/bills

Use filters to reconcile source records, build receivables views, or recover a bill ID from your external IDs.

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.

Query parameters

FieldTypeDescription
cursor
string

Opaque cursor returned by the previous page.

limit
number

Maximum records to return.

externalId
string

Filter by your bill/report/work-item identifier.

patientExternalId
string

Filter by your patient identifier.

patientId
string

Filter by the canonical MindBill patient ID, not a name or host external ID.

Maximum 200 characters
claimExternalId
string

Filter by your claim or injury identifier.

q
string

Case-insensitive search across patient, administrator, bill/claim identifiers, external IDs, status, procedure codes, and dates. Every word must match; words may match different fields.

At most 160 characters after trimming
dateField
"service" | "submitted"

Choose the date used by the range filter; defaults to submitted.

from
string

Inclusive start of the selected date range.

Real YYYY-MM-DD date; from must not be after to
to
string

Inclusive end of the selected date range.

Real YYYY-MM-DD date; from must not be after to
state
string

Filter by native lifecycle state.

Examples

List bills
curl "https://app.mindbill.org/partner/v2/bills?claimExternalId=claim_17&limit=25" \
  --header "Authorization: Bearer $MINDBILL_API_KEY"

Response

200 OK

Response
{
  "data": [{ "id": "bill_01J6Y7F4Q4XK6P3J9G2C8A1B5D", "externalId": "report_9f7a", "state": "submitted", "amounts": { "charged": 2015, "paid": 0, "balance": 2015 } }],
  "nextCursor": null
}
FieldTypeDescription
dataRequired
Bill[]

Bills in this page.

nextCursorRequired
string | null

Cursor for the next page, or null when complete.