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

# View charges

`GET /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.

## 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
- `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

- APIV20240412EntitiesLedgerChargeWithClaimPayoutsCollectionResponseWithCursor — API_V20240412_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` APIV20240412EntitiesLedgerChargeWithClaimPayouts[]
    - `id` integer — Resource id
    - `foreign_id` string — Unique identifier of this resource from the integrated system
    - `location_id` integer, nullable — The ID of the location that this item is for
    - `patient_id` integer, nullable — The ID of the patient that this item is for
    - `guarantor_id` integer, nullable — The ID of the guarantor that this item is for
    - `provider_id` integer, nullable — The ID of the provider that this item is for
    - `procedure_id` integer, nullable — The ID of the procedure associated with this charge
    - `procedure_code` string, nullable — The procedure code associated with this charge
    - `updated_at` string, date-time — Last updated time for item in UTC
    - `description` string, nullable — 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, nullable — The UTC date charge was made
    - `deleted_at` string, date-time, nullable — The UTC datetime the charge was deleted
    - `claim_payouts` APIV20240412EntitiesLedgerInsuranceClaimPayout[] — 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` APIV20240412EntitiesFeeScheduleProcedureCode
        - `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.net/nexhealth/apis/nexhealth-api.md) · [All operations](https://skmtc.net/nexhealth/apis/nexhealth-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/nexhealth/nexhealth-api/revisions/a180e830b672/schema)