---
title: "View charges (beta)"
method: GET
path: "/charges"
tags: ["Charges"]
---

# View charges (beta)

`GET /charges`

## Request

- Base URL: `https://nexhealth.info`
- URL: `https://nexhealth.info/charges`
- Auth: API key in header `Authorization`

> 🚧 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 `charged_since`.

This endpoint returns ledger charges for the specified location; at least one of `provider_id`, `patient_id`, `procedure_id`, `guarantor_id`, `updated_since`, or `charged_since` must be provided.

## Query parameters

- `subdomain` string, required
- `location_id` integer, required
- `patient_id` integer
- `provider_id` integer
- `procedure_id` integer
- `guarantor_id` integer
- `updated_since` string, date-time
- `charged_since` string, date-time
- `include_deleted` boolean
- `sort` string
- `start_cursor` string
- `end_cursor` string
- `per_page` integer
- `include[]` string[]

## Headers

- `Nex-Api-Version` string, required

## Response `200`

Successful

- APIV31EntitiesLedgerChargeWithClaimPayoutsCollectionResponseWithCursor: API_V31_Entities_Ledger_ChargeWithClaimPayouts_Collection_Response_WithCursor model
  - `code` boolean: Indicates the success or failure of the request
  - `description` string: Additional context on the request to help with debugging.
  - `error` string[]: Any errors that occur during the execution of the request.
  - `data` APIV31EntitiesLedgerChargeWithClaimPayouts[]
    - `id` integer: Resource ID
    - `foreign_id` string: Identifier NexHealth uses to uniquely match this record to its counterpart in the integrated EHR. How it is derived differs between EHRs and may change; treat it as an opaque string and do not parse it.
    - `location_id` integer: The ID of the location that this item is for
    - `patient_id` integer: The ID of the patient that this item is for
    - `guarantor_id` integer: The ID of the guarantor that this item is for
    - `provider_id` integer: The ID of the provider that this item is for
    - `procedure_id` integer: The ID of the procedure associated with this charge
    - `procedure_code` string: The procedure code associated with this charge
    - `updated_at` string, date-time: Last updated time for item in UTC
    - `description` string: A description of the charge
    - `fee` APIV2EntitiesPrice
      - `amount` string: The currency value, in whole units (e.g. dollars)
      - `currency` string: The ISO currency code
    - `charged_at` string, date: The UTC date charge was made
    - `deleted_at` string, date-time: The UTC datetime the charge was deleted
    - `claim_payouts` APIV31EntitiesLedgerInsuranceClaimPayout[]: Claim payouts for this charge
      - `amount_billed_to_insurance` APIV2EntitiesPrice
        - `amount` string: The currency value, in whole units (e.g. dollars)
        - `currency` string: The ISO currency code
      - `estimated_insurance_payment` APIV2EntitiesPrice
        - `amount` string: The currency value, in whole units (e.g. dollars)
        - `currency` string: The ISO currency code
      - `insurance_payment` APIV2EntitiesPrice
        - `amount` string: The currency value, in whole units (e.g. dollars)
        - `currency` string: The ISO currency code
      - `write_off` APIV2EntitiesPrice
        - `amount` string: The currency value, in whole units (e.g. dollars)
        - `currency` string: The ISO currency code
      - `allowed_amount` APIV2EntitiesPrice
        - `amount` string: The currency value, in whole units (e.g. dollars)
        - `currency` string: The ISO currency code
      - `fee_schedule_procedure_code` APIV31EntitiesFeeScheduleProcedureCode
        - `procedure_code_id` string, nullable: The uuid of the procedure code associated with the fee schedule
        - `fee` APIV2EntitiesPrice
          - `amount` string: The currency value, in whole units (e.g. dollars)
          - `currency` string: The ISO currency code
        - `code` string, nullable: The code of the procedure associated with the fee schedule
        - `id` integer: Fee Schedule Procedure Resource ID
        - `location_id` integer, nullable: The location ID of the fee schedule
        - `fee_schedule_id` integer, nullable: The ID of the fee schedule associated with the fee schedule procedure
        - `updated_at` string, date-time: Fee Schedule Procedure update date in UTC
      - `claim_id` integer: The claim ID associated with this payout
  - `page_info` object: Pagination information that can be used for fetching previous and next pages.

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `403`: Forbidden
- `500`: Internal Server Error

---

[API](https://skmtc.dev/nexhealth/apis/nexhealth-api-v3-1-0-beta.md) - [All operations](https://skmtc.dev/nexhealth/apis/nexhealth-api-v3-1-0-beta/llms.txt) - [OpenAPI document](https://skmtc.dev/nexhealth/apis/nexhealth-api-v3-1-0-beta/revisions/93cb4af790a5?raw)