v1

latestOpenAPI 3.0.0NexHealth License 1.02026-07-2688180386.6 KB

Charges

View charges

This endpoint returns the ledger charges for the specified location. At least one of the patient_id, provider_id, procedure_id, guarantor_id, or updated_since filters must be provided.

get/charges

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

procedure_idinteger

Filter by the id of the associated procedure

guarantor_idinteger

Filter by the id of the associated guarantor

updated_sincestring date-time

Charges updated after the specified time (UTC)

include_deletedboolean

Include deleted charges

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.

include[]string[]

Resources to be included in the response

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,
      "procedure_id": 34,
      "procedure_code": "D0120",
      "updated_at": "2024-09-05T20:31:17.007Z",
      "description": "This is a description",
      "fee": {
        "amount": "62.00",
        "currency": "USD"
      },
      "charged_at": "2024-10-05",
      "deleted_at": "2022-01-01T00:00:00Z",
      "claim_payouts": [
        {
          "amount_billed_to_insurance": {
            "amount": "62.00",
            "currency": "USD"
          },
          "estimated_insurance_payment": {
            "amount": "62.00",
            "currency": "USD"
          },
          "insurance_payment": {
            "amount": "62.00",
            "currency": "USD"
          },
          "write_off": {
            "amount": "62.00",
            "currency": "USD"
          },
          "allowed_amount": {
            "amount": "62.00",
            "currency": "USD"
          },
          "fee_schedule_procedure_code": {
            "procedure_code_id": "ab123456-11aa-99ff-a111-d1ee12345678",
            "fee": {
              "amount": "62.00",
              "currency": "USD"
            },
            "code": "D0120",
            "id": 113,
            "location_id": 10,
            "fee_schedule_id": 1234,
            "updated_at": "2020-06-05T20:16:57.007Z"
          },
          "claim_id": 1234
        }
      ]
    }
  ],
  "page_info": {
    "has_previous_page": false,
    "has_next_page": false,
    "start_cursor": "AAAAA",
    "end_cursor": "BBBBBB"
  }
}