credit note

GET /v1/credit_note/{id}

Get credit note details

Request

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

Path parameters

idstring required

Credit note id

Response

Successful operation

idstring required

Credit note id

invoicestring required

Invoice credited by this note

transactionstring

Refund transaction id if credit note has an associated refund

creditstring

Credit reference if the credit note relates to a subscription credit

amountinteger required

Credit note amount

createdstring date-time required

Creation date for note, in ISO-8601 extended offset date-time format.

currencystring required

Credit note currency in ISO 4217 three letter alpha code

customerstring required

Customer handle

subscriptionstring

Subscription handle, will be null for a one-time customer invoice

amount_vatinteger required

Credit note vat amount calculated as rounded summed fractional vats for each credit note lines

amount_ex_vatinteger

Credit note total amount excluding VAT calculated as summed amounts excl. vats for each credit note lines

accounting_numberstring

Credit note accounting number

payable_amountinteger

The credit note amount to be paid including VAT

download_urlstring

Url to credit note pdf

Example response

{
  "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
    }
  ]
}

Changes

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