---
title: "View Credit Note Balance"
method: GET
path: "/api/v1/creditNotes/{id}/balance"
tags: ["Credit Note"]
---

# View Credit Note Balance

`GET /api/v1/creditNotes/{id}/balance`

Returns balance information (documents, payments) for a single credit note

## Path parameters

- `id` string, required — Resource identifier.

## Response `200`

Operation completed successfully.

- object
  - `data` object
    - `documents` object
      - `invoices` object[]
        - `id` string — Resource identifier.
        - `amount` object — Money object with amount and currency
          - `amount` string, float — A string representing the amount
          - `currency` 'EUR' | 'USD' | 'JPY' | 'BGN' | 'CZK' | 'DKK' | 'GBP' | 'HUF' | 'PLN' | 'RON' | 'SEK' | 'CHF' | 'ISK' | 'NOK' | 'HRK' | 'RUB' | 'TRY' | 'AUD' | 'BRL' | 'CAD' | 'CNY' | 'HKD' | 'IDR' | 'ILS' | 'INR' | 'KRW' | 'MXN' | 'MYR' | 'NZD' | 'PHP' | 'SGD' | 'THB' | 'ZAR' | 'ARS' | 'CLP' | 'SAR' | 'AED' | 'QAR' — Currency matches one of currency values as specified in ISO-4217.
        - `date` string, date-time
      - `creditNotes` object[]
        - `id` string — Resource identifier.
        - `amount` object — Money object with amount and currency
          - `amount` string, float — A string representing the amount
          - `currency` 'EUR' | 'USD' | 'JPY' | 'BGN' | 'CZK' | 'DKK' | 'GBP' | 'HUF' | 'PLN' | 'RON' | 'SEK' | 'CHF' | 'ISK' | 'NOK' | 'HRK' | 'RUB' | 'TRY' | 'AUD' | 'BRL' | 'CAD' | 'CNY' | 'HKD' | 'IDR' | 'ILS' | 'INR' | 'KRW' | 'MXN' | 'MYR' | 'NZD' | 'PHP' | 'SGD' | 'THB' | 'ZAR' | 'ARS' | 'CLP' | 'SAR' | 'AED' | 'QAR' — Currency matches one of currency values as specified in ISO-4217.
        - `date` string, date-time
    - `payments` object[]
      - `reference` object — Only one of the actually referenced object.
        - `invoice` object, nullable — Nullable reference to another resource
          - `id` string, required — Resource identifier.
        - `creditNote` object, nullable — Nullable reference to another resource
          - `id` string, required — Resource identifier.
      - `payment` object
        - `id` string — Resource identifier.
        - `type` 'incoming' | 'outgoing'
        - `statementId` string
        - `accountName` string
        - `amount` object — Money object with amount and currency
          - `amount` string, float — A string representing the amount
          - `currency` 'EUR' | 'USD' | 'JPY' | 'BGN' | 'CZK' | 'DKK' | 'GBP' | 'HUF' | 'PLN' | 'RON' | 'SEK' | 'CHF' | 'ISK' | 'NOK' | 'HRK' | 'RUB' | 'TRY' | 'AUD' | 'BRL' | 'CAD' | 'CNY' | 'HKD' | 'IDR' | 'ILS' | 'INR' | 'KRW' | 'MXN' | 'MYR' | 'NZD' | 'PHP' | 'SGD' | 'THB' | 'ZAR' | 'ARS' | 'CLP' | 'SAR' | 'AED' | 'QAR' — Currency matches one of currency values as specified in ISO-4217.
        - `date` string, date-time

## Other responses

- `400` — IETF RFC 9457 Problem API compliant response
- `404` — Resource was not found or not enough access privileges
- `406` — Requested resource representation does not exist.
- `429` — Too many API calls made.

---

[API](https://skmtc.net/xentral/apis/xentral-api.md) · [All operations](https://skmtc.net/xentral/apis/xentral-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/xentral/xentral-api/revisions/8a27ba392442/schema)