List invoices
/documents/invoicesCosts 1 rate-limit point · Rate limits
The invoices the V3 Invoices page lists, newest first, as list rows (number, order, customer, financial status, total, sent / printed / reminder timestamps). Invoices only by default; pass document_type to list quotes, credit notes or pro forma invoices from the same table. Trashed invoices are left out unless link=trashed. Read-only.
document_type values: invoice (Invoice), quote (Quote), credit_note (Credit note), pro_forma (Pro forma invoice), custom (Custom invoice).
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).
link values: linked (Created from a Shopify order), not_linked (Standalone (no Shopify order)), trashed (In the trash).
Also searched aslist invoicesshow my invoicesfind an invoicesearch invoicesunpaid invoicesinvoices for an orderinvoices from last monthtrashed invoices
Query parameters
document_typestringWhich documents: 'invoice' (default), 'quote', 'credit_note', 'pro_forma', 'custom'. One of:
invoice(Invoice),quote(Quote),credit_note(Credit note),pro_forma(Pro forma invoice),custom(Custom invoice).One ofinvoicequotecredit_notepro_formacustomlinkstring'linked' (created from a Shopify order), 'not_linked' (standalone) or 'trashed'. One of:
linked(Created from a Shopify order),not_linked(Standalone (no Shopify order)),trashed(In the trash).One oflinkednot_linkedtrashedsortstring'created_at desc' (default) or 'created_at asc'.
One ofcreated_at desccreated_at ascpageinteger1-based page number.
per_pageintegerRows per page, default 25, max 100.
financial_statusstringShopify financial status of the order, one or many ('paid', 'pending,partially_paid'). One of:
pending(Payment pending),authorized(Authorized),partially_paid(Partially paid),paid(Paid),partially_refunded(Partially refunded),refunded(Refunded),voided(Voided),expired(Expired),cancelled(Cancelled).One ofpendingauthorizedpartially_paidpaidpartially_refundedrefundedvoidedexpiredcancelledfromstringCreated on or after this date (ISO 8601).
tostringCreated on or before this date (ISO 8601).
order_idstringThe Shopify order, as a gid (gid://shopify/Order/123) or a bare number.
qstringFree text over invoice number, order name, customer name and email.
Returns
itemsarray of objectsShow 19 child attributesHide child attributes
idintegerExample:980191068document_typestringExample:invoiceinvoice_numberstringExample:#1001titlestringExample:InvoiceorderobjectShow 3 child attributesHide child attributes
shopify_order_idstringExample:gid://shopify/Order/12213474623569namestringExample:#1001numberintegerExample:1001
customerobjectShow 3 child attributesHide child attributes
idintegerExample:43namestringExample:Customer 1emailstringExample:cus1@gmail.com
financial_statusstringExample:paidcurrencystringExample:USDtotalstringExample:1100.22issued_onstringExample:2025-12-11due_onstring, nullablesent_atstring, nullableprinted_atstring, nullablereminder_sent_atstring, nullablepaidbooleanExample:trueeditedbooleanExample:falsetrashedbooleanExample:truee_invoice_statusstring, nullablecreated_atstringExample:2026-11-10T09:41:43Z
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/invoices" \
-H "X-Auth-Token: $INVOICE_FALCON_API_KEY"const res = await fetch("https://app.invoicefalcon.com/api/v3/external/documents/invoices", {
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/invoices",
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/invoices")
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)curl "https://app.invoicefalcon.com/api/v3/external/documents/invoices?document_type=invoice&link=linked&sort=created_at%20desc" \
-H "X-Auth-Token: $INVOICE_FALCON_API_KEY"const res = await fetch("https://app.invoicefalcon.com/api/v3/external/documents/invoices?document_type=invoice&link=linked&sort=created_at%20desc", {
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/invoices?document_type=invoice&link=linked&sort=created_at%20desc",
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/invoices?document_type=invoice&link=linked&sort=created_at%20desc")
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": 980191068,
"document_type": "invoice",
"invoice_number": "#1001",
"title": "Invoice",
"order": {
"shopify_order_id": "gid://shopify/Order/12213474623569",
"name": "#1001",
"number": 1001
},
"customer": {
"id": 43,
"name": "Customer 1",
"email": "cus1@gmail.com"
},
"financial_status": "paid",
"currency": "USD",
"total": "1100.22",
"issued_on": "2025-12-11",
"due_on": null,
"sent_at": null,
"printed_at": null,
"reminder_sent_at": null,
"paid": true,
"edited": false,
"trashed": true,
"e_invoice_status": null,
"created_at": "2026-11-10T09:41:43Z"
}
],
"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"
}