Skip to content

Update document settings

PATCH/account/documents

Costs 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

  • numberingobject
    Show 4 child attributesHide child attributes
    • invoice_prefixstring, nullable

      Prefix of invoice numbers, e.g. INV.

    • next_invoice_numberstring, nullable

      The number the next invoice takes (digits only).

    • use_order_numberboolean

      Number invoices after the Shopify order number instead of a counter.

    • credit_notes_use_invoice_numberboolean

      Credit notes take the invoice's number.

  • datesobject
    Show 5 child attributesHide child attributes
    • use_order_created_dateboolean

      Print the order date as the invoice date.

    • use_paid_dateboolean

      Print the payment date as the invoice date.

    • delivery_date_attributestring, nullable

      Name 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_tagsboolean

      Also read the delivery date from a date-shaped order tag (11-02-2026) when the attribute is absent.

    • invoicing_start_datestring, nullable

      Orders 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.

  • languageobject
    Show 3 child attributesHide child attributes
    • document_localestring

      Language documents are printed in.

      One of azbgcsdadeeleneses-MXetfifritjakoltlvnlnnplptroskslsvzh
    • auto_detect_customer_languageboolean

      Use the customer's checkout language when known.

    • translate_product_namesboolean

      Print translated product names where Shopify has them.

  • currencyobject
    Show 2 child attributesHide child attributes
    • multicurrencyboolean

      Print in the currency the customer paid in.

    • show_currency_codeboolean

      Print the currency code next to amounts.

  • pdfobject
    Show 1 child attributeHide child attributes
    • file_namestring, nullable

      PDF file name pattern, e.g. invoice-{{ invoice_number }}.

  • businessobject
    Show 7 child attributesHide child attributes
    • namestring, nullable

      Business name printed on documents.

    • address_line_1string, nullable
    • address_line_2string, nullable
    • city_linestring, nullable

      City and region line.

    • country_linestring, nullable

      Country and postcode line.

    • emailstring, nullable
    • phonestring, nullable
  • taxobject
    Show 2 child attributesHide child attributes
    • registration_numberstring, nullable

      VAT / GST / ABN number.

    • shown_asstring, nullable

      Label printed before it, e.g. VAT No.

  • complianceobject
    Show 1 child attributeHide child attributes
    • lock_invoices_after_issueboolean

      Shopify 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_notesobject
    Show 2 child attributesHide child attributes
    • outside_eustring, nullable

      Footer note for customers outside the EU (migrated stores only).

    • inside_eustring, nullable

      Footer note for customers inside the EU (migrated stores only).

  • brandingobject
    Show 1 child attributeHide child attributes
    • show_invoice_falcon_brandboolean

      Print "Created with Invoice Falcon"; turning it off needs a paid plan.

Returns

  • numberingobject
    Show 5 child attributesHide child attributes
    • invoice_prefixstring
      Example: INV
    • next_invoice_numberstring, nullable
      Example: 1200
    • 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.

PATCH/account/documents
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"
    }
  }'
Response
{
  "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
  }
}