Update document settings
/account/documentsCosts 2 rate-limit points · Rate limits
Change the document defaults every template inherits: invoice numbering, which dates are printed, language and currency, the PDF file name, the business name, address and contact, the tax registration, invoice locking, EU VAT footer notes and the Invoice Falcon brand line. Deep partial. Returns the documents section as the read shows it.
Applies to every document generated from now on; existing PDFs are unchanged. Multicurrency and removing the brand line need a paid plan.
Also searched aschange invoice prefixset the next invoice numberupdate business address on invoiceschange document languageset my vat numberlock invoices after issueremove invoice falcon brandingchange the pdf file name
Request body
numberingobjectShow 4 child attributesHide child attributes
invoice_prefixstring, nullablePrefix of invoice numbers, e.g. INV.
next_invoice_numberstring, nullableThe number the next invoice takes (digits only).
use_order_numberbooleanNumber invoices after the Shopify order number instead of a counter.
credit_notes_use_invoice_numberbooleanCredit notes take the invoice's number.
datesobjectShow 5 child attributesHide child attributes
use_order_created_datebooleanPrint the order date as the invoice date.
use_paid_datebooleanPrint the payment date as the invoice date.
delivery_date_attributestring, nullableName of the order attribute holding the delivery date the buyer chose at checkout, e.g. Liefertermin. It becomes the fulfillment date; blank uses the Shopify fulfillment.
delivery_date_from_tagsbooleanAlso read the delivery date from a date-shaped order tag (11-02-2026) when the attribute is absent.
invoicing_start_datestring, nullableOrders placed before this date (YYYY-MM-DD, in the shop timezone) are never invoiced: not automatically, not from the customer account or order status page, and the order page asks before creating one. Null invoices any order.
languageobjectShow 3 child attributesHide child attributes
document_localestringLanguage documents are printed in.
One ofazbgcsdadeeleneses-MXetfifritjakoltlvnlnnplptroskslsvzhauto_detect_customer_languagebooleanUse the customer's checkout language when known.
translate_product_namesbooleanPrint translated product names where Shopify has them.
currencyobjectShow 2 child attributesHide child attributes
multicurrencybooleanPrint in the currency the customer paid in.
show_currency_codebooleanPrint the currency code next to amounts.
pdfobjectShow 1 child attributeHide child attributes
file_namestring, nullablePDF file name pattern, e.g. invoice-{{ invoice_number }}.
businessobjectShow 7 child attributesHide child attributes
namestring, nullableBusiness name printed on documents.
address_line_1string, nullableaddress_line_2string, nullablecity_linestring, nullableCity and region line.
country_linestring, nullableCountry and postcode line.
emailstring, nullablephonestring, nullable
taxobjectShow 2 child attributesHide child attributes
registration_numberstring, nullableVAT / GST / ABN number.
shown_asstring, nullableLabel printed before it, e.g. VAT No.
complianceobjectShow 1 child attributeHide child attributes
lock_invoices_after_issuebooleanShopify order updates (refunds, cancellations, edits) no longer change an issued invoice; corrections go on a credit note. Manual edits and regenerate still work.
eu_vat_footer_notesobjectShow 2 child attributesHide child attributes
outside_eustring, nullableFooter note for customers outside the EU (migrated stores only).
inside_eustring, nullableFooter note for customers inside the EU (migrated stores only).
brandingobjectShow 1 child attributeHide child attributes
show_invoice_falcon_brandbooleanPrint "Created with Invoice Falcon"; turning it off needs a paid plan.
Returns
numberingobjectShow 5 child attributesHide child attributes
invoice_prefixstringExample:INVnext_invoice_numberstring, nullableExample:1200use_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 -X PATCH "https://app.invoicefalcon.com/api/v3/external/account/documents" \
-H "X-Auth-Token: $INVOICE_FALCON_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"business": {
"name": "Acme GmbH"
},
"numbering": {
"next_invoice_number": "1200"
}
}'const res = await fetch("https://app.invoicefalcon.com/api/v3/external/account/documents", {
method: "PATCH",
headers: {
"X-Auth-Token": process.env.INVOICE_FALCON_API_KEY,
"Content-Type": "application/json",
},
body: JSON.stringify({
"business": {
"name": "Acme GmbH"
},
"numbering": {
"next_invoice_number": "1200"
}
}),
});
const data = await res.json();import os
import requests
res = requests.patch(
"https://app.invoicefalcon.com/api/v3/external/account/documents",
headers={"X-Auth-Token": os.environ["INVOICE_FALCON_API_KEY"]},
json={
"business": {
"name": "Acme GmbH"
},
"numbering": {
"next_invoice_number": "1200"
}
},
)
data = res.json()require "net/http"
require "json"
uri = URI("https://app.invoicefalcon.com/api/v3/external/account/documents")
req = Net::HTTP::Patch.new(uri, "X-Auth-Token" => ENV["INVOICE_FALCON_API_KEY"], "Content-Type" => "application/json")
req.body = {
business: {
name: "Acme GmbH"
},
numbering: {
next_invoice_number: "1200"
}
}.to_json
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": "1200",
"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"
}