NEnexhealth
Payments

View payments (beta)

🚧 Beta

Send Nex-Api-Version: v3.1.0 to use this endpoint. It is still changing, and access is limited to approved partner institutions. Contact NexHealth before you build on it.

Changed from v3.0.0: Adds query param paid_since.

This endpoint returns the ledger payments for the specified location, narrowed down by the configured filters. At least one of the following filters must be provided: provider_id, patient_id, guarantor_id, claim_id, transaction_id, updated_since, or paid_since.

get/payments

Request

  • Base URL
    https://nexhealth.info
  • URL
    https://nexhealth.info/payments
  • Auth
    API key in header Authorization

Query parameters

subdomainstring required

Used to scope the request to the specified institution

location_idinteger required

Used to scope the request to the specified location

patient_idinteger

Filter by the ID of the associated patient

provider_idinteger

Filter by the ID of the associated provider

guarantor_idinteger

Filter by the ID of the associated guarantor

charge_idinteger

Filter by the ID of the associated charge

claim_idinteger

Filter by the ID of the associated claim

transaction_idstring

Filter by transaction ID

updated_sincestring date-time

Filter for payments updated since a specific time (UTC)

paid_sincestring date-time

Payments with paid_at after the specified time (UTC)

include_deletedboolean

Include deleted payments

sortstring

Optional comma-separated string of fields to sort on. Include a leading dash for descending order.

Available fields:

  • paid_at
  • -paid_at
  • updated_at
  • -updated_at
start_cursorstring

First item of the current page. Starts empty

end_cursorstring

Last item of the current page. Starts empty

per_pageinteger

Number of results to return per page. Maximum allowed amount is 1000.

Headers

Nex-Api-Versionstring required

The NexHealth API version

Response

Successful

codeboolean

Indicates the success or failure of the request

descriptionstring

Additional context on the request to help with debugging.

errorstring[]

Any errors that occur during the execution of the request.

page_infoobject

Pagination information that can be used for fetching previous and next pages.

Example response

{
  "description": "Description",
  "error": [
    "Error message"
  ],
  "data": [
    {
      "id": 113,
      "foreign_id": "1234-5678",
      "location_id": 10,
      "patient_id": 3,
      "guarantor_id": 5,
      "provider_id": 15,
      "updated_at": "2024-09-05T20:31:17.007Z",
      "description": "This is a description",
      "deleted_at": "2024-09-15T11:21:26.003Z",
      "payment_amount": {
        "amount": "62.00",
        "currency": "USD"
      },
      "paid_at": "2024-10-01",
      "transaction_id": "NHP:JXZEQ1234",
      "charge_id": 1111,
      "claim_id": 2222,
      "payment_plan_id": 3,
      "insurance_plan_id": 4,
      "payment_type_id": 5
    }
  ],
  "page_info": {
    "has_previous_page": false,
    "has_next_page": false,
    "start_cursor": "AAAAA",
    "end_cursor": "BBBBBB"
  }
}

Changes

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