Get a list of credit notes for an organization

OAuth scope: client_invoices.read

---

Retrieve all credit notes within a particular Organization.

---

The response contains the list of the credit notes 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
• 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

Filtering

• Credit notes can be filtered by created date time interval using created_at_from and created_at_to where:
  • created_at_from represents the min date
  • created_at_to represents the max date
  • Note that if the created_at_from and created_at_to are not specified in the query parameters, the response will contain all the credit notes of that particular organization.

Sorting

• Credit notes can be sorted by created_at
• Two values are available: asc (Ascending) / desc (Descending)
• By default, the order used to sort created_at is desc

Pagination

• The default number of items per page is 1, max items per page is 100. Pagination data is returned in the response : See Schema here.

{
  "credit_notes": [
    {
      "id": "4d5418bb-bd0d-4df4-865c-c07afab8bb48",
      "invoice_id": "4d5418bb-bd0d-4df4-865c-c07afab8bb48",
      "attachment_id": "4d5418bb-bd0d-4df4-865c-c07afab8bb48",
      "issue_date": "2022-03-01",
      "invoice_issue_date": "2022-03-02",
      "number": "INV001",
      "terms_and_conditions": "This is an example.",
      "header": "This is an example.",
      "footer": "This is an example.",
      "vat_amount": {
        "value": "0.51",
        "currency": "EUR"
      },
      "vat_amount_cents": 51,
      "total_amount": {
        "value": "12.52",
        "currency": "EUR"
      },
      "total_amount_cents": 1252,
      "currency": "EUR",
      "created_at": "2022-03-04T17:58:30+02:00",
      "finalized_at": "2022-03-04T17:58:30+02:00",
      "contact_email": "contact@qonto.com",
      "invoice_url": "https://pay.qonto.com/invoices/00000000-0000-0000-0000-000000000000",
      "welfare_fund": {
        "type": "TC01",
        "rate": "0.0001"
      },
      "withholding_tax": {
        "reason": "RF01",
        "rate": "0.01",
        "amount": "1.00"
      },
      "stamp_duty_amount": "1.00",
      "items": [
        {
          "title": "Plastic tables",
          "description": "Plastic tables for McDonald’s restaurants",
          "quantity": "1.5",
          "unit": "meter",
          "unit_price": {
            "value": "10.0",
            "currency": "EUR"
          },
          "unit_price_cents": 1000,
          "vat_rate": "0.1",
          "discount": {
            "type": "percentage",
            "value": "0.1",
            "amount": {
              "value": "120",
              "currency": "EUR"
            }
          },
          "total_vat": {
            "value": "120",
            "currency": "EUR"
          },
          "total_vat_cents": 12000,
          "total_amount": {
            "value": "300.50",
            "currency": "EUR"
          },
          "total_amount_cents": 30050,
          "subtotal": {
            "value": "120",
            "currency": "EUR"
          },
          "subtotal_cents": 12000
        }
      ],
      "client": {
        "id": "33v418bb-bd0d-4df4-865c-c07afab8bb48",
        "name": "McDonald's",
        "first_name": "Jane",
        "last_name": "Doe",
        "type": "individual",
        "email": "client@qonto.com",
        "vat_number": "FR32123456789",
        "tax_identification_number": "123456789",
        "address": "1 place de l’Opéra",
        "city": "Paris",
        "zip_code": "75009",
        "country_code": "fr",
        "locale": "fr",
        "billing_address": {
          "street_address": "123 Main Street",
          "city": "Paris",
          "zip_code": "75009",
          "country_code": "FR"
        },
        "delivery_address": {
          "street_address": "123 Main Street",
          "city": "Paris",
          "zip_code": "75009",
          "country_code": "FR"
        }
      }
    }
  ],
  "meta": {
    "current_page": 2,
    "prev_page": 1,
    "total_pages": 2,
    "total_count": 150,
    "per_page": 100
  }
}