Skip to main content
GET
Get Charges Table

Headers

TENANT
string
required

The tenant you are making this request on behalf of

API-KEY
string
required

Your api key

Query Parameters

page
integer | null
per_page
integer | null
sort_by
string
default:created_date
sort_direction
string
default:desc
location_id
string | null
id
string | null
patient_id
string | null
name
string | null
total
integer[] | null
total_outstanding
integer[] | null
description
string | null
status
enum<string>[] | null
Available options:
OUTSTANDING,
PAID,
EXTERNAL_SETTLEMENT,
VOID,
WRITE_OFF,
REFUNDED,
CHARGEBACK,
PAYMENT_PLAN,
COLLECTIONS
external_id
string | null
created_date
payment_date
tz
string | null

Response

Successful Response

data
ChargeTable · object[]
required
total
integer
required