Retrieve document settings
/account/documentsCosts 1 rate-limit point · Rate limits
The document defaults: invoice numbering (prefix, next number, order number reuse), which dates are printed, document language and auto-detection, multicurrency, PDF file name, the business name, address, contact and tax registration shown on every document, invoice locking, EU VAT footer notes and the "Created with Invoice Falcon" brand. Read-only.
Also searched asdocument settingsinvoice numberingbusiness address on invoicesinvoice languagetax id on invoicespdf file nameare invoices locked after issuenext invoice number
Returns
numberingobjectShow 5 child attributesHide child attributes
invoice_prefixstringExample:INVnext_invoice_numberstring, nullableuse_order_numberbooleanExample:falsecredit_notes_use_invoice_numberbooleanExample:falseper_template_numbering_availablebooleanExample:true
datesobjectShow 2 child attributesHide child attributes
use_order_created_datebooleanExample:falseuse_paid_datebooleanExample:false
languageobjectShow 4 child attributesHide child attributes
document_localestringExample:enauto_detect_customer_languagebooleanExample:falsetranslate_product_namesbooleanExample:falseavailable_localesarray of strings
currencyobjectShow 2 child attributesHide child attributes
multicurrencybooleanExample:trueshow_currency_codebooleanExample:true
pdfobjectShow 1 child attributeHide child attributes
file_namestring, nullable
businessobjectShow 7 child attributesHide child attributes
namestringExample:Acme GmbHaddress_line_1string, nullableaddress_line_2string, nullablecity_linestring, nullablecountry_linestring, nullableemailstring, nullablephonestring, nullable
taxobjectShow 2 child attributesHide child attributes
registration_numberstring, nullableshown_asstring, nullable
complianceobjectShow 1 child attributeHide child attributes
lock_invoices_after_issuebooleanExample:false
eu_vat_footer_notesobjectShow 3 child attributesHide child attributes
outside_eustring, nullableinside_eustring, nullableavailablebooleanExample:false
brandingobjectShow 2 child attributesHide child attributes
show_invoice_falcon_brandbooleanExample:trueremoval_availablebooleanExample:true
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/account/documents" \
-H "X-Auth-Token: $INVOICE_FALCON_API_KEY"const res = await fetch("https://app.invoicefalcon.com/api/v3/external/account/documents", {
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/account/documents",
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/account/documents")
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){
"numbering": {
"invoice_prefix": "INV",
"next_invoice_number": null,
"use_order_number": false,
"credit_notes_use_invoice_number": false,
"per_template_numbering_available": true
},
"dates": {
"use_order_created_date": false,
"use_paid_date": false
},
"language": {
"document_locale": "en",
"auto_detect_customer_language": false,
"translate_product_names": false,
"available_locales": [
"az",
"bg",
"cs"
]
},
"currency": {
"multicurrency": true,
"show_currency_code": true
},
"pdf": {
"file_name": null
},
"business": {
"name": "Acme GmbH",
"address_line_1": null,
"address_line_2": null,
"city_line": null,
"country_line": null,
"email": null,
"phone": null
},
"tax": {
"registration_number": null,
"shown_as": null
},
"compliance": {
"lock_invoices_after_issue": false
},
"eu_vat_footer_notes": {
"outside_eu": null,
"inside_eu": null,
"available": false
},
"branding": {
"show_invoice_falcon_brand": true,
"removal_available": true
}
}{
"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"
}