---
title: "GET /v1/credit_note"
method: GET
path: "/v1/credit_note"
tags: ["credit note"]
---

# GET /v1/credit_note

`GET /v1/credit_note`

## Request

- Base URL: `https://customer-portal-api.frisbii.com`
- URL: `https://customer-portal-api.frisbii.com/v1/credit_note`
- Auth: none declared

Get list of credit notes

## Query parameters

- `from` string: Time range from (inclusive). Local date and time (according to account timezone) on the form `yyyy-MM-dd`, `yyyyMMdd`, `yyyy-MM-ddTHH:mm`, `yyyy-MM-ddTHH:mm:ss` or `yyyy-MM-ddTHH:mm:ss.SSS`. Default from if no `interval` is given depends on the query. If the query limits on relation e.g. customer and/or subscription, the default from will be epoch 1970-01-01, otherwise one month before `to`
- `to` string: Time range to (exclusive). Local date and time (according to account timezone) on the form `yyyy-MM-dd`, `yyyyMMdd`, `yyyy-MM-ddTHH:mm`, `yyyy-MM-ddTHH:mm:ss` or `yyyy-MM-ddTHH:mm:ss.SSS`. Defaults to now.
- `interval` string: Limit from `to` and interval back in time. E.g. one week. Will take precedence over `from`. Defined in ISO 8601 duration. See https://en.wikipedia.org/wiki/ISO_8601#Durations
- `size` integer: Page size between 10 and 100 (default 20)
- `next_page_token` string: Next page token from previous response to get next page

## Response `200`

Successful operation

- CustomerInvoiceCreditNoteList
  - `size` integer, required: Page size used in paginated list
  - `count` integer, required: Number of elements in current page. If less than page size it is the last page.
  - `to` string, required: Local date and time range used as to (exclusive)
  - `from` string, required: Local date and time range used as from (inclusive)
  - `content` CustomerInvoiceCreditNote[]: List of credit notes
    - `id` string, required: Credit note id
    - `invoice` string, required: Invoice credited by this note
    - `transaction` string: Refund transaction id if credit note has an associated refund
    - `credit` string: Credit reference if the credit note relates to a subscription credit
    - `amount` integer, required: Credit note amount
    - `created` string, date-time, required: Creation date for note, in [ISO-8601](http://en.wikipedia.org/wiki/ISO_8601) extended offset date-time format.
    - `currency` string, required: Credit note currency in [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) three letter alpha code
    - `customer` string, required: Customer handle
    - `subscription` string: Subscription handle, will be null for a one-time customer invoice
    - `credits` CreditInvoice[]: Credits applied to credit note
      - `credit` string, required: Credit handle
      - `amount` integer, required: The credit amount transferred to invoice
      - `created` string, date-time, required: Date when credit was transferred to invoice. In [ISO-8601](http://en.wikipedia.org/wiki/ISO_8601) extended offset date-time format.
      - `text` string, required: Text describing the credit.
    - `amount_vat` integer, required: Credit note vat amount calculated as rounded summed fractional vats for each credit note lines
    - `amount_ex_vat` integer: Credit note total amount excluding VAT calculated as summed amounts excl. vats for each credit note lines
    - `credit_note_lines` CreditNoteLine[], required: Credit note lines
      - `amount` integer, required: Credit note line total amount
      - `text` string, required: Credit note line text
      - `description` string: Order line description
      - `quantity` integer, required: Credit note line quantity
      - `vat` number, float: Vat for this credit note line
      - `created` string, date-time: Creation date for this credit note line, in [ISO-8601](http://en.wikipedia.org/wiki/ISO_8601) extended offset date-time format.
      - `origin` 'plan' | 'add_on' | 'ondemand' | 'additional_cost' | 'credit' | 'discount' | 'setup_fee' | 'surcharge_fee' | 'metered_billing_product': Order line origin, one of the following: `plan`, `add_on`, `ondemand`, `additional_cost`, `credit`, `discount`, `setup_fee`, `surcharge_fee`, `metered_billing_product`
      - `order_line_id` string: Reference to invoice orderline this credit note line relates to
      - `amount_incl_vat` integer: Credit note line total amount including VAT
      - `amount_ex_vat` integer: Credit note line total amount excluding VAT
      - `unit_amount` integer: Credit note line unit amount
      - `unit_amount_vat` integer: Credit note line vat amount
      - `unit_amount_ex_vat` integer: Credit note line unit amount excluding VAT
      - `amount_incl_vat_defined` boolean: Whether the total and units are including VAT.
      - `period_from` string, date-time: The start of billing period in [ISO-8601](http://en.wikipedia.org/wiki/ISO_8601) extended offset date-time format.
      - `period_to` string, date-time: The end of billing period in [ISO-8601](http://en.wikipedia.org/wiki/ISO_8601) extended offset date-time format.
      - `cost_object` string: Cost object number (Kostenträger-Nr.) this line is booked to
    - `accounting_number` string: Credit note accounting number
    - `payable_amount` integer: The credit note amount to be paid including VAT
    - `download_url` string: Url to credit note pdf
    - `amount_vat_lines` AmountVatLine[]: Credit note tax amounts
      - `vat` number, float, required: Vat percent
      - `amount_vat` integer, required: Total vat amount
  - `next_page_token` string: Pagination token to use to get the next page. Notice that page size and range should be the same for all page requests. If not present the last page has been reached.

## Other responses

- `400`: Invalid request, see error codes at https://api.frisbii.com/v1/error_codes
- `401`: None or invalid credentials provided in access to secured resource
- `403`: Not authorized to perform resource operation
- `404`: Resource or referenced resource not found, see error codes at https://api.frisbii.com/v1/error_codes
- `429`: Request limiting exceeded, request rate or concurrent requests, see error code 122 and 123
- `500`: Internal service error, error is reported automatically to Frisbii

---

[API](https://skmtc.dev/frisbii/apis/frisbii-customer-portal-api.md) - [All operations](https://skmtc.dev/frisbii/apis/frisbii-customer-portal-api/llms.txt) - [OpenAPI document](https://skmtc.dev/frisbii/apis/frisbii-customer-portal-api/revisions/f0261fb63b1b?raw)