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

# View credit note

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

Returns details of a single credit note.

## Path parameters

- `id` string, required — Resource identifier.

## Response `200`

Operation completed successfully.

- object
  - `data` object, required
    - `id` string — Resource identifier.
    - `number` string, nullable
    - `date` string, date
    - `createdAt` string, date-time
    - `createdBy` object, nullable
      - `name` string, required
    - `sentAt` string, date-time, nullable
    - `sentBy` object, nullable
      - `name` string, required
    - `updatedAt` string, date-time
    - `grossValue` 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.
    - `netValue` 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.
    - `costCenter` string
    - `status` 'approved' | 'sent' | 'created' | 'closed' | 'canceled'
    - `project` object
      - `id` string — Resource identifier.
      - `name` string
    - `customer` object
      - `id` string — Resource identifier.
      - `name` string
    - `tags` object[] — A list of tags
      - `id` string — The identifier of the tag
      - `name` string — The name of the tag
      - `color` string — Hexadecimal color value in 6-digit format without the leading # character.
    - `externalOrderReference` string, nullable
    - `devCustomer` string, nullable
    - `billingAddress` object, nullable — Billing address of the customer.
      - `id` string — Resource identifier.
      - `name` string, required
      - `contactPerson` string, required
      - `department` string, nullable, required
      - `subdivision` string, nullable, required
      - `street` string, required
      - `additionalDetails` string, nullable, required
      - `city` string, required
      - `zipCode` string, required
      - `country` string, required
      - `email` string, nullable
    - `paymentMethodName` string
    - `paymentStatus` 'pending' | 'paid' | 'partlyPaid' | 'canceled' | 'partialCancellation' | 'badDebt' | 'debited' | 'unknown' — Status of the payment. Value `unknown` is displayed when a status from database cannot be identified. Value `unknown` cannot be used when creating or updating statuses (POST or PATCH endpoints)
    - `gln` string, nullable
    - `taxation` number
    - `positions` object[]
      - `id` number
      - `position` number
      - `salesOrderPosition` object, nullable — Nullable reference to another resource
        - `id` string, required — Resource identifier.
      - `createdAt` string, date-time
      - `productId` number
      - `productNumber` string
      - `description` string
      - `quantity` number
      - `price` 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.
      - `vatCategory` string
      - `taxRate` number, float
      - `discount` number, float, nullable

## Other responses

- `400` — IETF RFC 9457 Problem API compliant response
- `401` — Unable to authenticate the client
- `403` — Unable to authorize the client
- `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)