---
title: "Get details of credit note for an organization"
method: GET
path: "/v2/credit_notes/{id}"
tags: ["Credit Notes"]
---

# Get details of credit note for an organization

`GET /v2/credit_notes/{id}`

OAuth scope: `client_invoices.read`

---

Retrieve details about a credit note within a particular Organization.

---

The response contains the details of a credit note and all the related data and attachments.

---

## Attributes details

### Credit Note

- `total_amount` and `total_amount_cents` represent the credit note’s total amount
- `vat_amount` and `vat_amount_cents` represent the credit note VAT amount
- `currency` represents the credit note’s currency
- `contact_email` represents the e-mail address of the credit note’s initiator
- `credit_note_url` represents the URL credit note through which the credit note can be previewed in the web browser
- `number` represents the credit note’s number
- `terms_and_conditions` represents the T&C data added by the credit note’s initiator
- `header` represents the header text added by the credit note’s initiator
- `footer` represents the footer text added by the credit note’s initiator
- `invoice_id` represents the invoice id the credit note is linked to
- `attachment_id` represents an attachment UUID corresponding to that particular credit note. You can obtain details and get the credit note by using [Get attachment](https://api-doc.qonto.com/docs/business-api/345dace7b485b-show-attachment)
- `reason` represents the reason for credit note

### Items

- `total_amount` and `total_amount_cents` represent the amount for that specific item
- `total_vat` and `total_vat_cents`  represent the VAT amount that is applicable for that specific item
- `title` represents the item’s title
- `description` represents the item’s description
- `quantity` represents the item’s quantity
- `unit_price` and `unit_price_cents` represent the amount of the price per unit. Note that an item can contain multiple units. The number of units is defined via `quantity`.
- `vat_rate` represents the VAT rate applicable for that particular item

### Client

- `type` describes the client type. Possible values - company or individual
- `email` represents the e-mail address of the client
- `address` represents the address of the client
- `city` represents the city of the client
- `zip_code` represents the zip code of the client
- `country_code` represents the country code of the client
- `name` represents the name of the client. Note that this attribute will be returned only if the client is  `a company`
- `first_name` represents the first name of the client. Note that this attribute will be returned only if the client is  `an individual`
- `last_name` represents the last name of the client. Note that this attribute will be returned only if the client is  `an individual`
- `tax_identification_number` represents the TAX Identification number of the client
- `vat_number` represents the VAT number of the client
- `billing_address` represents the billing address of the client that needs to pay the invoice. Stores the same data as the root-level fields address fields (`address`, `city`, `zip_code`, `province_code`, `country_code`).
- `delivery_address` represents the delivery address of the client that needs to pay the invoice. Stores the same data as the root-level fields address fields (`address`, `city`, `zip_code`, `province_code`, `country_code`).

### Organization

- `id` represents the unique identifier of organization
- `legal_name` represents the organization's legal name at the time the document was issued
- `legal_number` represents the organization's legal number at the time the document was issued
- `legal_country` represents the organization's legal country at the time the document was issued
- `address_line_1` represents the first line of the organization's address at the time the document was issued
- `address_line_2` represents the second line of the organization's address at the time the document was issued
- `address_zipcode` represents the organization's zip code at the time the document was issued
- `address_city` represents the organization's city at the time the document was issued
- `address_country` represents the country of the organization's address at the time the document was issued
- `company_leadership` represents the organization's leadership at the time the document was issued
- `district_court` represents the organization's district court at the time the document was issued
- `commercial_register_number` is available for French and German organizations and is optional. For French organizations, it represents RCS number (numéro Registre du Commerce et des Sociétés) of an incorporated business. For example: RCS A 123 123 123. 
  For German organizations, it represents the organization's commercial register number (handelsregisternummer). For example: HRB 123455 B.
- `vat_number` represents the organization's VAT number at the time the document was issued
- `tax_number` represents the organization's tax number at the time the document was issued
- `legal_capital_share` represents the capital share of an incorporated business. It is optional and is only for French organizations. It is by default in EUR. 
- `transaction_type` represents the type of transaction performed in the invoice. It is optional and is only for French organizations. Allowed values: `goods`, `services`, `goods_and_services`
- `vat_payment_condition` represents the business’ VAT elected payment condition (whether TVA is paid on receipt or on invoice emission). There are two allowed values: receipt and compensated_for_sales. receipt stands for “sur les encaissements” in French, and compensated_for_sales stands for “sur les débits” in French.
  It is optional and is only for French organizations. Allowed values: `receipt`, `compensated_for_sales`

### Timestamps

- `created_at` represents the date the credit note was created. Note that this is a machine date.
- `issue_date` represents the date the initiator mentioned that the credit note was created.
- `invoice_issue_date` represents the invoice_id’s issue date

## Path parameters

- `id` string, uuid, required

## Headers

- `X-Qonto-Staging-Token` string

## Response `200`

Credit note info

- object
  - `credit_note` CreditNote, required
    - `id` string, uuid
    - `invoice_id` string, uuid
    - `attachment_id` string, uuid
    - `issue_date` string, date
    - `invoice_issue_date` string, date
    - `number` string
    - `terms_and_conditions` string
    - `header` string
    - `footer` string
    - `vat_amount` object
      - `value` string
      - `currency` string
    - `vat_amount_cents` integer
    - `total_amount` object
      - `value` string
      - `currency` string
    - `total_amount_cents` integer
    - `currency` string
    - `created_at` string, date-time
    - `finalized_at` string, date-time
    - `contact_email` string, email
    - `invoice_url` string, uri — represents the URL of the invoice public page, accessible without authentication for 180 days after issuance, provided the invoice has not been canceled.
    - `einvoicing_status` 'pending' | 'submitted' | 'declined' | 'approved' | 'not_delivered' | 'submission_failed'
    - `welfare_fund` object
      - `type` 'TC01' | 'TC02' | 'TC03' | 'TC04' | 'TC05' | 'TC06' | 'TC07' | 'TC08' | 'TC09' | 'TC10' | 'TC11' | 'TC12' | 'TC13' | 'TC14' | 'TC15' | 'TC16' | 'TC17' | 'TC18' | 'TC19' | 'TC20' | 'TC21' | 'TC22'
      - `rate` string
    - `withholding_tax` object — - Only applicable for Italian organizations and Spanish freelancers. - Object which relates to an amount of tax paid by the client, rather than the supplier, for specific cases. - This amount is a percentage deducted from the total amount of the invoice after VAT application. - The `rate` field specifies the percentage of tax and `amount` field specifies the total amount of the tax.
      - `reason` 'RF01' | 'RF02' | 'RF03' | 'RF04' | 'RF05' | 'RF06'
      - `rate` string
      - `payment_reason` string
      - `amount` string
    - `stamp_duty_amount` string
    - `items` DocumentItem[]
      - `title` string
      - `description` string
      - `quantity` string
      - `unit` string
      - `unit_price` object — Amount of the price per unit. Note that an item can contain multiple units. The number of units is defined via `quantity`.
        - `value` string
        - `currency` string
      - `unit_price_cents` integer — Amount in cents of the price per unit. Note that an item can contain multiple units. The number of units is defined via `quantity`.
      - `vat_rate` string — VAT rate in decimal (0.1 for 10%) applicable to that particular item.
      - `vat_exemption_reason` 'N1' | 'N2' | 'N2.1' | 'N2.2' | 'N3' | 'N3.1' | 'N3.2' | 'N3.3' | 'N3.4' | 'N3.5' | 'N3.6' | 'N4' | 'N5' | 'N6' | 'N6.1' | 'N6.2' | 'N6.3' | 'N6.4' | 'N6.5' | 'N6.6' | 'N6.7' | 'N6.8' | 'N6.9' | 'N7' | 'S293B' | 'S262.1' | 'S259' | 'S283' | 'S261' | 'S262' | 'S263' | 'S19.1' | 'S4.1B' | 'S4.1A' | 'S4' | 'S13B' | 'S122' | 'S25' | 'S21' | 'S69' | 'S20' | 'S84.1.2' — Exemption reason
      - `discount` object
        - `type` 'percentage' | 'absolute'
        - `value` string — Discount rate or absolute amount. For percentage, the minimum value is 0.0001 (0.01%), and the maximum value is 1 (100%). For absolute value, the maximum is determined by Quantity * Unit Price.
        - `amount` object
          - `value` string
          - `currency` string
      - `total_vat` object — VAT amount that is applicable to that specific item.
        - `value` string
        - `currency` string
      - `total_vat_cents` integer — VAT amount in cents that is applicable to that specific item.
      - `total_amount` object — Amount that needs to be paid by the client for that specific item.
        - `value` string
        - `currency` string
      - `total_amount_cents` integer — Amount in cents that needs to be paid by the client for that specific item.
      - `subtotal` object
        - `value` string — Subtotal amount for the item without VAT. Quantity * Unit_price.
        - `currency` string
      - `subtotal_cents` integer — Subtotal amount in cents for the item without VAT.
    - `client` EmbeddedClient — Client that needs to pay the invoice.
      - `id` string, uuid
      - `name` string — Note that this attribute will be returned only if the client is a `company`.
      - `first_name` string — Note that this attribute will be returned only if the client is an `individual` or a `freelancer`.
      - `last_name` string — Note that this attribute will be returned only if the client is an `individual` or a `freelancer`.
      - `type` 'individual' | 'company' | 'freelancer'
      - `email` string, email
      - `vat_number` string
      - `tax_identification_number` string
      - `address` string
      - `city` string
      - `zip_code` string
      - `province_code` string — Province code of the client. It is required only for Italian organizations
      - `country_code` string
      - `recipient_code` string — Recipient code, so that the client can receive the e-invoice in his SdI portal.
      - `locale` string
      - `billing_address` ClientBillingAddress — Send either a `billing_address` object filled-in or individual root-level address fields (`address`, `city`, `zip_code`, `province_code`, `country_code`). When both are sent, `billing_address` takes precedence and overwrites root-level fields.
        - `street_address` string — Street address section of the billing address of the client (eg street, number, floor, door, etc).
        - `city` string — City on the billing address of the client
        - `zip_code` string — Zip code on the billing address of the client
        - `province_code` string — Province code of the client's billing address. It is required only for Italian organizations.
        - `country_code` string — Country code on the billing address of the client (ISO 3166 format)
      - `delivery_address` ClientDeliveryAddress
        - `street_address` string — Street address section of the delivery address of the client. (eg street, number, floor, door, etc)
        - `city` string — City on the delivery address of the client
        - `zip_code` string — Zip code on the delivery address of the client
        - `province_code` string — Province code of the client's delivery address. It is required only for Italian organizations
        - `country_code` string — Country code on the delivery address of the client (ISO 3166 format)

## Other responses

- `400` — returns a bad request error
- `404` — returns a not found error
- `422` — returns an unprocessable entity error
- `500` — returns an internal server error

---

[API](https://skmtc.net/hiit-consulting-fr/apis/qonto.md) · [All operations](https://skmtc.net/hiit-consulting-fr/apis/qonto/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/hiit-consulting-fr/qonto/versions/25208d6f9deb/schema)