Charges

Get All Charges (System-wide)

Get all patient charges across all patients. This endpoint returns transactional charges (not charge definitions from the master ledger - use /charge_master for that).

Results can be filtered by date range using either the creation date or transaction date.

get/charges

Request

  • Base URL: https://clinic-subdomain.md-hq.com/api/v1
  • URL: https://clinic-subdomain.md-hq.com/api/v1/charges
  • Auth: HTTP basic

Query parameters

limitinteger

The maximum number of charges to return (default is 100).

offsetinteger

Offset the list to allow cycling through charges.

date_method'created' | 'transaction'

If filtering by date range, should the range be calculated by date the charge was created, or the recorded transaction date? Valid arguments are 'created' and 'transaction' (created is the default).

start_datestring date

Show charges from after this date (calculated by date_method).

end_datestring date

Show charges from before this date (calculated by date_method).

Response

Successful response

object'list'
total_countinteger
has_moreboolean

Changes

No recorded changes to this operation across all 1 revision of this API.