Charges

🚧

Use our latest version to access this data

Charges are no longer supported in v2.2. Please use the same endpoint in v20240412 to access this data.

Charges represent a patient or their insurance plan being charged money for a service provided. Charges are a "debit" meaning they add to the patient balance, increasing the amount the patient owes the practice.

📘

Understanding charges and procedures

In many systems, all charges will be associated with a completed procedure. You can understand this relationship by adding the query parameter "include[]=procedures" to your /charges requests.

Charge response object

{
  "code": false,
  "description": "Description",
  "error": [
    "Error"
  ],
  "data": [
    {
      "id": 113,
      "accountable_type": "patient",
      "accountable_id": 1,
      "value": {
        "amount": "62.00",
        "currency": "USD"
      },
      "patient_id": 3,
      "provider_id": 15,
      "procedure_id": 42,
      "date": "2020-06-05",
      "patient": {
        ...
      },
      "provider": {
        ...
      },
      "procedure": {
        ...
      },
      "directionality": "credit"
    }
  ],
  "count": 2
}