v1

latestOpenAPI 3.0.0NexHealth License 1.02026-07-2688180386.6 KB

Payments

View payments

This endpoint returns the ledger payments for the specified location, narrowed down by the configured filters (at least one filter is required)

get/payments

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)

include_deletedboolean

Include deleted payments

sortstring

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

Available fields:

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