GET
/
v2
/
credit_notes
curl --request GET \
  --url https://thirdparty.qonto.com/v2/credit_notes \
  --header 'Authorization: Bearer <token>'
{
  "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",
      "einvoicing_status": "pending",
      "welfare_fund": {
        "type": "TC01",
        "rate": "0.0001"
      },
      "withholding_tax": {
        "reason": "RF01",
        "rate": "0.01",
        "payment_reason": "<string>",
        "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",
          "vat_exemption_reason": "N1",
          "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",
        "province_code": "<string>",
        "country_code": "fr",
        "recipient_code": "<string>",
        "locale": "fr",
        "billing_address": {
          "street_address": "123 Main Street",
          "city": "Paris",
          "zip_code": "75009",
          "province_code": "<string>",
          "country_code": "FR"
        },
        "delivery_address": {
          "street_address": "123 Main Street",
          "city": "Paris",
          "zip_code": "75009",
          "province_code": "<string>",
          "country_code": "FR"
        }
      }
    }
  ],
  "meta": {
    "current_page": 2,
    "next_page": "<any>",
    "prev_page": "<any>",
    "total_pages": 2,
    "total_count": 150,
    "per_page": 100
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authorization header: Bearer <token>, where <token> is the access token received from the authorization server at the end of the OAuth 2.0 flow.

Headers

​
X-Qonto-Staging-Token
string

Required only for Sandbox API requests; to get one, please sign up to the Developer Portal.

Query Parameters

​
filter[created_at_from]
string

Credit notes can be filtered by their created_at property. Can be use in combination with the created_at_to query parameter to get credit notes created within a specific timeframe. Please use a valid date time format (ISO 8601 for instance).

Example:

"2022-02-01T12:01:02Z"

​
filter[created_at_to]
string

Credit notes can be filtered by their created_at property. Can be use in combination with the created_at_from query parameter to get credit notes created within a specific timeframe. Please use a valid date time format (ISO 8601 for instance).

Example:

"2022-23-04T16:23:00Z"

​
page
integer

Returned page (cf. Pagination).

Example:

1

​
per_page
integer
default:1

Number of credit notes per page (cf. Pagination).

Required range: x <= 100
​
sort_by
string
default:created_at:desc

Credit notes can be sorted by their created_at property in 2 possible orders: asc (Ascending) / desc (Descending).

Response

200
application/json
Returns the list credit notes.

The response is of type object.