Skip to content

Retrieve e-invoicing settings

GET/account/e_invoicing

Costs 1 rate-limit point · Rate limits

The e-invoicing setup: whether it is available for the store (German stores), switched on and actually active (paid plan and a complete seller profile), whether e-invoices are generated automatically or on request, and the seller profile (legal name, VAT id or tax number, city, postcode, small-business status, bank details) with the values resolved from store details where the profile leaves them blank. Read-only.

generation values: automatic (Generate with every invoice), manual (Generate on request).

Also searched ase-invoicing settingsis e-invoicing onxrechnung setupzugferd settingse-invoice seller profilewhy is my e-invoice not generated

Returns

  • enabledboolean
    Example: false
  • generationstring
    Example: automatic
  • sellerobject
    Show 8 child attributesHide child attributes
    • legal_namestring, nullable
    • vat_idstring, nullable
    • tax_numberstring, nullable
    • citystring, nullable
    • zipstring, nullable
    • small_businessboolean
      Example: false
    • country_codestring
      Example: DE
    • resolvedobject
      Show 3 child attributesHide child attributes
      • legal_namestring
        Example: Acme GmbH
      • citystring
        Example: Barwaha, khargone
      • zipstring
        Example: 451115
  • bankobject
    Show 3 child attributesHide child attributes
    • ibanstring, nullable
    • bicstring, nullable
    • namestring, nullable
  • availableboolean
    Example: false
  • activeboolean
    Example: false
  • manual_modeboolean
    Example: false
  • readyboolean
    Example: false
  • configuredboolean
    Example: false

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/e_invoicing
curl "https://app.invoicefalcon.com/api/v3/external/account/e_invoicing" \
  -H "X-Auth-Token: $INVOICE_FALCON_API_KEY"
Response
{
  "enabled": false,
  "generation": "automatic",
  "seller": {
    "legal_name": null,
    "vat_id": null,
    "tax_number": null,
    "city": null,
    "zip": null,
    "small_business": false,
    "country_code": "DE",
    "resolved": {
      "legal_name": "Acme GmbH",
      "city": "Barwaha, khargone",
      "zip": "451115"
    }
  },
  "bank": {
    "iban": null,
    "bic": null,
    "name": null
  },
  "available": false,
  "active": false,
  "manual_mode": false,
  "ready": false,
  "configured": false
}