Skip to main content
GET
/
v1
/
credit_notes
List all credit notes
curl --request GET \
  --url https://api.yorlet.com/v1/credit_notes \
  --header 'Authorization: <api-key>'
import requests

url = "https://api.yorlet.com/v1/credit_notes"

headers = {"Authorization": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://api.yorlet.com/v1/credit_notes', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.yorlet.com/v1/credit_notes",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.yorlet.com/v1/credit_notes"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.yorlet.com/v1/credit_notes")
  .header("Authorization", "<api-key>")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.yorlet.com/v1/credit_notes")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body
{
  "count": 1,
  "has_more": false,
  "object": "list",
  "data": [
    {
      "id": "<string>",
      "created": 123,
      "object": "credit_note",
      "amount": 123,
      "currency": "gbp",
      "customer": "<string>",
      "description": "<string>",
      "discount_amount": 123,
      "invoice": "<string>",
      "memo": "<string>",
      "number": "<string>",
      "voided_at": 123,
      "account": "<string>",
      "deleted": false,
      "credit_amount": 0,
      "lines": {
        "count": 1,
        "has_more": false,
        "object": "list",
        "data": [
          {
            "id": "<string>",
            "created": 123,
            "object": "credit_note_line_item",
            "amount": 123,
            "amount_excluding_tax": 123,
            "credit_note": "<string>",
            "currency": "gbp",
            "description": "<string>",
            "invoice_item": "<string>",
            "pretax_credit_amounts": [
              {
                "amount": 123,
                "credit_grant": "<string>",
                "display_name": "<string>",
                "invoice_item": "<string>",
                "type": "credit_grant"
              }
            ],
            "tax_amounts": [
              {
                "amount": 123,
                "tax_rate": 123,
                "taxable_amount": 123
              }
            ],
            "type": "invoice_item",
            "account": "<string>",
            "deleted": false
          }
        ]
      },
      "metadata": {},
      "out_of_band_amount": 0,
      "subtotal": 0,
      "subtotal_excluding_tax": 0,
      "tax_amounts": [],
      "tax": 0,
      "total": 0,
      "total_excluding_tax": 0,
      "total_pretax_credit_amounts": []
    }
  ]
}

Authorizations

Authorization
string
header
required

API Key authentication. Use "Bearer YOUR_API_KEY".

Response

200 - application/json

A object with a data property that contains an array of credit notes.

count
number
required

Total number of items in the list.

Example:

1

has_more
boolean
required

Whether more items are available.

Example:

false

object
enum<string>
required
Available options:
list
data
object[]
required