---
title: "Retrieve all charges"
method: GET
path: "/api/v2/organizations/{orgSlug}/charges"
tags: ["Charges"]
---

# Retrieve all charges

`GET /api/v2/organizations/{orgSlug}/charges`

## Request

- Base URL: `https://app.officernd.com`
- URL: `https://app.officernd.com/api/v2/organizations/{orgSlug}/charges`
- Auth: OAuth 2
  - Authorization code: `https://identity.officernd.com/auth/authorize`
  - Client credentials
  - Token URL: `https://identity.officernd.com/auth/token` scopes: `flex.billing.charges.read`

Retrieve all charges for a specific invoice. 

 Required scopes: `flex.billing.charges.read`

## Path parameters

- `orgSlug` string, required

## Query parameters

- `_id` string
- `status` string
- `payment` string
- `source` string
- `date` string
- `modifiedAt` string
- `createdAt` string
- `$select` string
- `$cursorNext` string
- `$cursorPrev` string
- `$limit` number
- `$sort` string

## Response `200`

- object
  - `rangeStart` number
  - `rangeEnd` number
  - `cursorNext` string
  - `cursorPrev` string
  - `results` ChargeResultDto[]
    - `_id` string, required: The _id of the charge.
    - `amount` number, required: The amount of the charge.
    - `currency` string: The currency of the charge.
    - `account` string: The account to which the charge is allocated.
    - `reference` string: A short description of the charge
    - `date` string: The date of the charge.
    - `accounting` AccountingResultDto
      - `provider` string: The name of the accounting provider.
      - `providerId` string: The id of the payment in the accounting provider.
      - `externalOrgId` string: The organization id in the accounting provider.
      - `deepLink` string: A deep link to the payment in the accounting provider.
      - `lastSync` string: The date of the last sync of the payment with the accounting integration.
      - `error` string: An error message with more details about the reason of the failure.
    - `source` string: The source of the charge. The source will be an accounting integration if the charge is synced from an integration.
    - `status` 'pending' | 'fail' | 'success' | 'refund': The status of the charge.
    - `payment` string: Reference to the invoice, to which the charge belongs to.
    - `providerChargeReference` string: The payment gateway reference for the charge (e.g., Stripe charge ID).
    - `createdAt` string, date-time: The date when the charge has been created at.
    - `createdBy` string: The user that created the charge.
    - `modifiedAt` string, date-time: The date when the charge has been modified for the last time.
    - `modifiedBy` string: The user that did the last modification to the charge. Before the first modification, this field equals to the createdBy field.

---

[API](https://skmtc.dev/officernd/apis/billing-product-api.md) - [All operations](https://skmtc.dev/officernd/apis/billing-product-api/llms.txt) - [OpenAPI document](https://skmtc.dev/officernd/apis/billing-product-api/revisions/78f9c9851fb0?raw)