Payment types

Before you start

NexHealth reads financial data from the health record system only on request. To turn it on for your API key, email [email protected]. Sandbox locations have it on.
Every request needs a bearer token from POST /authenticates. See Authentication.
Requests take the practice's subdomain and, for most endpoints, a location_id. See Institutions, syncs, and locations.

Overview

Payment types are the methods a practice accepts for payments, such as cash, credit card, check or insurance payments. Each payment entered in the health record system gets a payment type. This helps practices track how they collect payments and reconcile transactions.

Example use cases

Use the view payment types endpoint to show the payment types a practice accepts when you build a digital payment collection workflow.
Use payment types to categorize transactions when you generate financial reports.

Payment types response

{
  "code": true,
  "description": null,
  "error": null,
  "data": [
    {
      "id": 1,
      "name": "Credit Card",
      "active": true,
      "updated_at": "2024-04-12T10:30:00.000Z"
    },
    {
      "id": 2,
      "name": "Cash",
      "active": true,
      "updated_at": "2024-04-12T10:30:00.000Z"
    },
    {
      "id": 3,
      "name": "Check",
      "active": true,
      "updated_at": "2024-04-12T10:30:00.000Z"
    },
    {
      "id": 4,
      "name": "Insurance Payment",
      "active": false,
      "updated_at": "2024-04-12T10:30:00.000Z"
    }
  ],
  "page_info": {
    "has_previous_page": false,
    "has_next_page": false,
    "start_cursor": "AAAAA",
    "end_cursor": "BBBBBB"
  }
}