Skip to main content
GET
Patient balance
When to use it: To answer «does this patient owe anything?». Debt and credit are reported apart, never netted. Amounts are in cents.

Authorizations

Authorization
string
header
required

Brelio API key (organization or user) or a WorkOS access token.

Path Parameters

id
string<uuid>
required

The patient id.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Response

Success

id
string<uuid>
required

The patient id.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
pending
integer
required

Owed on open charges, in cents.

Required range: -9007199254740991 <= x <= 9007199254740991
received
integer
required

Money received, net of corrections, in cents.

Required range: -9007199254740991 <= x <= 9007199254740991
credit
integer
required

Money received and not applied to any charge, in cents.

Required range: -9007199254740991 <= x <= 9007199254740991
uninvoiced
integer
required

Total of open charges that no invoice documents yet, collected or not, in cents.

Required range: -9007199254740991 <= x <= 9007199254740991
currency
string
required

ISO 4217 code, such as EUR.