List credit notes
/documents/credit_notesCosts 1 rate-limit point · Rate limits
The credit notes the Credit notes tab lists, newest first, as list rows: credit note number, the invoice and Shopify order it credits, customer, total, and when it was sent or printed. q matches the credit note number and the credited invoice number. Read-only.
financial_status values: pending (Payment pending), authorized (Authorized), partially_paid (Partially paid), paid (Paid), partially_refunded (Partially refunded), refunded (Refunded), voided (Voided), expired (Expired), cancelled (Cancelled).
Also searched aslist credit notesshow credit notesfind a credit notecredit notes for an invoicerefund documentscredit notes this month
Query parameters
pageinteger1-based page number.
per_pageintegerRows per page, default 25, max 100.
qstringFree text over the credit note number, the credited invoice number and the customer email.
fromstringCreated on or after this date (ISO 8601).
tostringCreated on or before this date (ISO 8601).
Returns
itemsarray of objectsShow 20 child attributesHide child attributes
idintegerExample:980191085document_typestringExample:credit_noteinvoice_numberstringExample:1titlestringExample:Credit Noteorderobject, nullablecustomerobjectShow 3 child attributesHide child attributes
idintegerExample:49namestringExample:Customer 1emailstringExample:cus1@gmail.com
financial_statusstringExample:paidcurrencystringExample:USDtotalstringExample:1100.22issued_onstringExample:2026-11-10due_onstring, nullablesent_atstring, nullableprinted_atstring, nullablereminder_sent_atstring, nullablepaidbooleanExample:trueeditedbooleanExample:falsetrashedbooleanExample:falsee_invoice_statusstring, nullablecreated_atstringExample:2026-11-10T09:56:58ZcreditedobjectShow 3 child attributesHide child attributes
invoice_numberstringExample:#1001invoice_idintegerExample:980191084shopify_order_idstringExample:gid://shopify/Order/12213474623569
pageobjectOffset paging of a list (
page,per_pagequery params).Show 4 child attributesHide child attributes
numberinteger1-based page number.
sizeintegerRows per page, max 100.
totalintegerRows across all pages.
total_pagesintegerExample:1
Errors
Missing or unknown X-Auth-Token, or the shop uninstalled the app.
v3_required: the shop still runs the previous dashboard. paid_plan_required: API access needs a paid plan.
The request failed validation. Nothing was saved.
Rate limited: cost-weighted per key (reads cost less than writes). Wait Retry-After seconds; see X-RateLimit-* headers.
Every error has the same shape: see Errors.
curl "https://app.invoicefalcon.com/api/v3/external/documents/credit_notes" \
-H "X-Auth-Token: $INVOICE_FALCON_API_KEY"const res = await fetch("https://app.invoicefalcon.com/api/v3/external/documents/credit_notes", {
headers: {
"X-Auth-Token": process.env.INVOICE_FALCON_API_KEY,
},
});
const data = await res.json();import os
import requests
res = requests.get(
"https://app.invoicefalcon.com/api/v3/external/documents/credit_notes",
headers={"X-Auth-Token": os.environ["INVOICE_FALCON_API_KEY"]},
)
data = res.json()require "net/http"
require "json"
uri = URI("https://app.invoicefalcon.com/api/v3/external/documents/credit_notes")
req = Net::HTTP::Get.new(uri, "X-Auth-Token" => ENV["INVOICE_FALCON_API_KEY"])
res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body){
"items": [
{
"id": 980191085,
"document_type": "credit_note",
"invoice_number": "1",
"title": "Credit Note",
"order": null,
"customer": {
"id": 49,
"name": "Customer 1",
"email": "cus1@gmail.com"
},
"financial_status": "paid",
"currency": "USD",
"total": "1100.22",
"issued_on": "2026-11-10",
"due_on": null,
"sent_at": null,
"printed_at": null,
"reminder_sent_at": null,
"paid": true,
"edited": false,
"trashed": false,
"e_invoice_status": null,
"created_at": "2026-11-10T09:56:58Z",
"credited": {
"invoice_number": "#1001",
"invoice_id": 980191084,
"shopify_order_id": "gid://shopify/Order/12213474623569"
}
}
],
"page": {
"number": 1,
"size": 25,
"total": 1,
"total_pages": 1
}
}{
"errors": [
"Invalid API key"
],
"code": "unauthorized"
}{
"errors": [
"API access requires a paid plan"
],
"code": "paid_plan_required"
}{
"errors": [
"id is missing"
]
}{
"errors": [
"Rate limit exceeded"
],
"code": "rate_limited"
}