API Reference

Adjustments

This page has been frozen to prevent breaking changes. To test our most up to date ledger and insurance integration, please navigate to our beta version from the top navigation.

🚧

Supported Integrations

For now, adjustments are only supported for Open Dental.

Adjustments represent a practice adding or subtracting from a patient balance. Adjustments can be applied for a huge variety of reasons including write offs (when a practice chooses not to charge a patient for a fee that was not covered by insurance), late fees, or employee discounts.

📘

Understanding Adjustment Directionality

Unlike payments or charges, which always have a set effect on a patient balance, adjustments can subtract from the overall balance (credits) or add to the overall balance (debits). You can understand the impact of an adjustment on the balance by accessing the directionality field and checking whether the specific adjustment is a "credit" or "debit".

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