Payments

🚧

Use our latest version to access this data

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

Payments represents a patient or their insurance plan paying for a completed service. Payments are a "credit" meaning they subtract from the patient balance, reducing the amount the patient owes the practice.

It is important to note that this endpoint reflect payments that have been input into the health record system regardless of whether the practice actually received a payment in their bank account. Practices may input payments before or after the "actual" payment is received and processed.

You can determine whether a patient or their insurance is responsible for a payment by accessing the accountable_type and accountable_id properties.

Payments 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
}