---
title: "List the releases a V2 validation can name"
method: GET
path: "/v2/einvoices/rulesets"
tags: ["rulesets"]
---

# List the releases a V2 validation can name

`GET /v2/einvoices/rulesets`

## Request

- Base URL: `https://api.ironfang.com/finance`
- URL: `https://api.ironfang.com/finance/v2/einvoices/rulesets`
- Auth: one of:
  - none
  - HTTP bearer

The `scheduled`, `sendable` and `historical` releases of every
family. Exactly one `sendable` release per capability (family,
variant, syntax, document type and scope) carries `latest: true`: the
one `ruleset=latest` resolves to now. A release of a family in this
list is the only evidence that the family is supported.

## Query parameters

- `family` 'peppol-bis-billing-3' | 'xrechnung' | 'zugferd-facturx': An invoice family. `zugferd-facturx` is one family: ZUGFeRD and Factur-X are corresponding release names of the same standard.
- `variant` 'core' | 'extension' | 'cvd' | 'minimum' | 'basic-wl' | 'basic' | 'en16931' | 'extended' | 'xrechnung': A variant or profile within a family. XRechnung: `core`, `extension`, `cvd`. ZUGFeRD / Factur-X: `minimum`, `basic-wl`, `basic`, `en16931`, `extended`, `xrechnung` (the ZUGFeRD XRECHNUNG reference profile). Peppol BIS Billing 3 has none. Recognition is not support: the ruleset list is the only statement of what is validated.
- `document_type` 'invoice' | 'credit_note'
- `scope` 'xml' | 'hybrid_pdf'
- `operation` 'validate' | 'generate'
- `state` 'scheduled' | 'sendable' | 'historical'

## Response `200`

The matching releases, newest effective date first.

- RulesetList
  - `rulesets` Ruleset[], required
    - `artifacts` RulesetArtifact[], required
      - `layer` 'input' | 'pdfa' | 'hybrid_binding' | 'xml' | 'xsd' | 'en16931' | 'peppol' | 'xrechnung' | 'zugferd_profile', required: A validation stage. A result reports the stages its pipeline runs, in the pipeline's order; no pipeline runs them all.
      - `licence` string, required
      - `licence_status` 'permissive' | 'notice-required' | 'no-raw-redistribution', required
      - `role` 'entry' | 'dependency', required
      - `sha256` string, required
      - `source_url` string, uri, required
    - `bis_release` string
    - `document_type` 'invoice' | 'credit_note', required
    - `en16931_release` string
    - `engine` object, required
      - `image_digest` string, required
      - `name` string, required
    - `family` 'peppol-bis-billing-3' | 'xrechnung' | 'zugferd-facturx', required: An invoice family. `zugferd-facturx` is one family: ZUGFeRD and Factur-X are corresponding release names of the same standard.
    - `id` string, required
    - `latest` boolean, required
    - `layers` Layer[], required
    - `manifest_sha256` string, required
    - `official_release` string, required
    - `operations` RulesetOperation[], required
    - `published_on` string, date
    - `replaced_by` string
    - `retired_at` string, date-time
    - `schema` 'ironfang/finance/einvoice/ruleset/v2', required
    - `scope` 'xml' | 'hybrid_pdf', required
    - `sources` string[], required
    - `state` 'scheduled' | 'sendable' | 'historical', required
    - `syntax` 'ubl-2.1' | 'cii-d16b' | 'cii-d22b', required: The syntax and schema edition a pipeline validates against, taken from the pinned release, never inferred from a namespace.
    - `technical_release` string
    - `valid_from` string, date-time, required
    - `valid_until` string, date-time
    - `variant` 'core' | 'extension' | 'cvd' | 'minimum' | 'basic-wl' | 'basic' | 'en16931' | 'extended' | 'xrechnung': A variant or profile within a family. XRechnung: `core`, `extension`, `cvd`. ZUGFeRD / Factur-X: `minimum`, `basic-wl`, `basic`, `en16931`, `extended`, `xrechnung` (the ZUGFeRD XRECHNUNG reference profile). Peppol BIS Billing 3 has none. Recognition is not support: the ruleset list is the only statement of what is validated.
  - `schema` 'ironfang/finance/einvoice/ruleset-list/v2', required

## Other responses

- `400`: The request is malformed.
- `401`: The credential is missing or not accepted.
- `403`: The key lacks the scope this operation needs.
- `429`: Too many requests.
- `500`: Ironfang Finance failed. Not a verdict on anything.

---

[API](https://skmtc.dev/ironfang/apis/ironfang-finance-e-invoicing-api-2.md) · [All operations](https://skmtc.dev/ironfang/apis/ironfang-finance-e-invoicing-api-2/llms.txt) · [OpenAPI document](https://skmtc.dev/ironfang/apis/ironfang-finance-e-invoicing-api-2/revisions/8140667e556b?raw)