credit note

GET /v1/credit_note

Get list of credit notes

Request

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

Query parameters

fromstring

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

Example:2019-12-01

tostring

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.

Example:2020-01-01

intervalstring

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

Example:P1W

sizeinteger

Page size between 10 and 100 (default 20)

Example:10

next_page_tokenstring

Next page token from previous response to get next page

Example:MTYzMjkxNDc4NTAwMDoxMA

Response

Successful operation

sizeinteger required

Page size used in paginated list

countinteger required

Number of elements in current page. If less than page size it is the last page.

tostring required

Local date and time range used as to (exclusive)

fromstring required

Local date and time range used as from (inclusive)

next_page_tokenstring

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.

Example response

{
  "size": 50,
  "count": 50,
  "to": "2021-10-06T13:02:23.190",
  "from": "2021-09-06T13:02:23.190",
  "content": [
    {
      "id": "c33fbb06a00e4dc0b9055f6fb509c0ed",
      "invoice": "inv-2021",
      "transaction": "082ebeb1b5864e019b6bf13cad7c535b",
      "credit": "credit-234",
      "amount": 15000,
      "created": "2015-04-04T12:40:56.656Z",
      "currency": "DKK",
      "customer": "customer006",
      "subscription": "sub010",
      "credits": [
        {
          "credit": "credit002",
          "amount": 10000,
          "created": "2015-04-04T12:40:56.656Z",
          "text": "Credit for lower bandwidth"
        }
      ],
      "amount_vat": 2000,
      "amount_ex_vat": 1323,
      "credit_note_lines": [
        {
          "amount": 15000,
          "text": "Refund product X",
          "description": "Product X",
          "quantity": 1,
          "vat": 0.25,
          "created": "2015-04-04T12:40:56.656Z",
          "origin": "plan",
          "order_line_id": "7f014d7f5d9e4ee89f1741a8cfe214d7",
          "amount_incl_vat": 1230,
          "amount_ex_vat": 1230,
          "unit_amount": 230,
          "unit_amount_vat": 230,
          "unit_amount_ex_vat": 230,
          "amount_incl_vat_defined": true,
          "period_from": "2015-04-04T12:40:56.656Z",
          "period_to": "2015-05-04T12:40:56.656Z",
          "cost_object": "KT-4711"
        }
      ],
      "accounting_number": "CN-2024-03-00005",
      "payable_amount": 10000,
      "download_url": "https://example.com/123",
      "amount_vat_lines": [
        {
          "vat": 0.25,
          "amount_vat": 3000
        }
      ]
    }
  ],
  "next_page_token": "MTYzMjkxNDc4NTAwMDoxMA"
}

Changes

No recorded changes to this operation across all 1 revision of this API.