Skip to content

Retrieve document settings

GET/account/documents

Costs 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

  • numberingobject
    Show 5 child attributesHide child attributes
    • invoice_prefixstring
      Example: INV
    • next_invoice_numberstring, nullable
    • use_order_numberboolean
      Example: false
    • credit_notes_use_invoice_numberboolean
      Example: false
    • per_template_numbering_availableboolean
      Example: true
  • datesobject
    Show 2 child attributesHide child attributes
    • use_order_created_dateboolean
      Example: false
    • use_paid_dateboolean
      Example: false
  • languageobject
    Show 4 child attributesHide child attributes
    • document_localestring
      Example: en
    • auto_detect_customer_languageboolean
      Example: false
    • translate_product_namesboolean
      Example: false
    • available_localesarray of strings
  • currencyobject
    Show 2 child attributesHide child attributes
    • multicurrencyboolean
      Example: true
    • show_currency_codeboolean
      Example: true
  • pdfobject
    Show 1 child attributeHide child attributes
    • file_namestring, nullable
  • businessobject
    Show 7 child attributesHide child attributes
    • namestring
      Example: Acme GmbH
    • address_line_1string, nullable
    • address_line_2string, nullable
    • city_linestring, nullable
    • country_linestring, nullable
    • emailstring, nullable
    • phonestring, nullable
  • taxobject
    Show 2 child attributesHide child attributes
    • registration_numberstring, nullable
    • shown_asstring, nullable
  • complianceobject
    Show 1 child attributeHide child attributes
    • lock_invoices_after_issueboolean
      Example: false
  • eu_vat_footer_notesobject
    Show 3 child attributesHide child attributes
    • outside_eustring, nullable
    • inside_eustring, nullable
    • availableboolean
      Example: false
  • brandingobject
    Show 2 child attributesHide child attributes
    • show_invoice_falcon_brandboolean
      Example: true
    • removal_availableboolean
      Example: true

Errors

401

Missing or unknown X-Auth-Token, or the shop uninstalled the app.

403

v3_required: the shop still runs the previous dashboard. paid_plan_required: API access needs a paid plan.

422

The request failed validation. Nothing was saved.

429

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.

GET/account/documents
curl "https://app.invoicefalcon.com/api/v3/external/account/documents" \
  -H "X-Auth-Token: $INVOICE_FALCON_API_KEY"
Response
{
  "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
  }
}