rulesets

One immutable release and its pipeline

One release by id, in any public state (scheduled, sendable or historical), with its pipeline, layers and pinned engine. A release never changes once published; results name the release that produced them, so this is how to see exactly what checked a document.

get/v2/einvoices/rulesets/{id}

Request

  • Base URL: https://api.ironfang.com/finance
  • URL: https://api.ironfang.com/finance/v2/einvoices/rulesets/{id}
  • Auth: one of:
    • none
    • HTTP bearer

Path parameters

idstring required

Response

The release.

bis_releasestring
document_type'invoice' | 'credit_note' required
en16931_releasestring
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.

idstring required
latestboolean required
layersLayer[] required
manifest_sha256string required
official_releasestring required
operationsRulesetOperation[] required
published_onstring date
replaced_bystring
retired_atstring date-time
schema'ironfang/finance/einvoice/ruleset/v2' required
scope'xml' | 'hybrid_pdf' required
sourcesstring[] 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_releasestring
valid_fromstring date-time required
valid_untilstring 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.

Changes

No recorded changes to this operation across all 1 revision of this API.