Schemas
Finding
severityfatal and error make a document invalid.
ruleIdRule id of the rule set (e.g. BR-CO-15, BR-DE-15) or of this service (e.g. PDFA-6.2.4.3-2, XMP-CONFORMANCE-LEVEL, CALC-LINE-NET).
messageOfficial rule text, or this service's explanation of what to fix.
xpathLocation in the invoice XML (prefix notation).
sourceLayer that raised it: xsd:
RulesetRef
idversionreleasepreviewPresent (true) only for an upcoming rule set used by /v1/preview/validate.
effectiveFromDate from which the rule set is mandatory, if known.
Summary
fatalerrorwarninginfoValidationResponse
formatcontainersyntaxprofileguidelineIdSpecification identifier (BT-24) found in the document; for KSeF the form code (KodFormularza/@kodSystemowy, e.g. FA (3)); for FatturaPA the versione attribute (FPR12, FPA12).
attachmentNameName of the embedded invoice XML (PDFs only).
Difference
fieldrulelineIdcategorydeclaredcomputedCalculation
consistentParseResponse
formatcontainersyntaxprofileguidelineIdattachmentNameSyntax-neutral representation of an EN 16931 invoice or credit note. Output of POST /v1/parse and input of POST /v1/generate. Each property carries its EN 16931 business term in 'x-bt'. Code-list values are validated by the rule sets, not by this schema.
Problem
typetitlestatusdetailinstancerequestIdavailableunknown-ruleset, preview-ruleset - rule-set versions that can be pinned on this endpoint.
formatsinvalid-format - accepted values.
schema-violation / invalid-for-format - one entry per offending value.
generated-invoice-invalid - findings of the generated document.
maxBytesretryAfterSecondstimeoutSecondsInvoiceAmount
^-?[0-9]{1,17}(\.[0-…Monetary amount as a decimal string, at most 2 fraction digits (EN 16931).
InvoiceUnitPrice
^[0-9]{1,17}(\.[0-9]…Unit price as a decimal string; non-negative. EN 16931 does not limit the fraction digits (up to 20 accepted).
InvoiceQuantity
^-?[0-9]{1,17}(\.[0-…Quantity as a decimal string. EN 16931 does not limit the fraction digits (up to 20 accepted).
InvoicePercentage
^[0-9]{1,3}(\.[0-9]{…Percentage as a decimal string, e.g. "19" or "7.00".
InvoiceIdentifier
valueschemeIdScheme identifier (ISO 6523 ICD for party IDs, EAS for electronic addresses).
InvoiceAddress
countryCode^[A-Z]{2}$ · requiredISO 3166-1 alpha-2.
line1line2line3citypostCodecountrySubdivisionInvoicePeriod
startendInvoiceSeller
nametradingNamevatIdtaxRegistrationIdLocal tax number (German Steuernummer).
additionalLegalInfoThe person who issued the invoice for the seller. Not an EN 16931 term: UBL cac:AccountingSupplierParty/cac:SellerContact, read and written only by the national formats that require it (Croatia: operator label HR-BT-4 and operator OIB HR-BT-5, both mandatory in hr-cius). Not the seller contact (BG-6).
InvoiceOperator
nameOperator label or name (Croatia HR-BT-4).
idOperator identifier (Croatia: the operator's OIB, HR-BT-5).
InvoiceDocumentAllowanceCharge
amount^-?[0-9]{1,17}(\.[0-… · requiredMonetary amount as a decimal string, at most 2 fraction digits (EN 16931).
vatCategoryCodeUNTDID 5305 subset: S, Z, E, AE, K, G, O, L, M.
baseAmount^-?[0-9]{1,17}(\.[0-…Monetary amount as a decimal string, at most 2 fraction digits (EN 16931).
percentage^[0-9]{1,3}(\.[0-9]{…Percentage as a decimal string, e.g. "19" or "7.00".
vatRate^[0-9]{1,3}(\.[0-9]{…Percentage as a decimal string, e.g. "19" or "7.00".
reasonreasonCodeUNTDID 5189 (allowances) or 7161 (charges).
InvoiceLineAllowanceCharge
amount^-?[0-9]{1,17}(\.[0-… · requiredMonetary amount as a decimal string, at most 2 fraction digits (EN 16931).
baseAmount^-?[0-9]{1,17}(\.[0-…Monetary amount as a decimal string, at most 2 fraction digits (EN 16931).
percentage^[0-9]{1,3}(\.[0-9]{…Percentage as a decimal string, e.g. "19" or "7.00".
reasonreasonCodeInvoiceInvoiceLine
idquantity^-?[0-9]{1,17}(\.[0-… · requiredQuantity as a decimal string. EN 16931 does not limit the fraction digits (up to 20 accepted).
unitCodeUN/ECE Recommendation 20/21 unit code, e.g. C62 (piece), HUR (hour), KGM.
netAmount^-?[0-9]{1,17}(\.[0-… · requiredMonetary amount as a decimal string, at most 2 fraction digits (EN 16931).
noteorderLineReferencebuyerAccountingReferenceNormalizedInvoice
invoiceNumberissueDatetypeCode^[0-9]{1,3}$ · requiredUNTDID 1001 code, e.g. 380 commercial invoice, 381 credit note, 384 corrected invoice, 389 self-billed invoice, 326 partial invoice.
currency^[A-Z]{3}$ · requiredISO 4217.
issueTime^[0-9]{2}:[0-9]{2}:[…Issue time hh:mm:ss. Not an EN 16931 term: read from and written to UBL cbc:IssueTime only by the national formats that require it (Croatia: HR-BT-2, mandatory in hr-cius).
vatAccountingCurrency^[A-Z]{3}$ISO 4217.
taxPointDatevatPointDateCodeUNTDID 2005 code (3, 35, 432).
dueDatebuyerReferenceFor XRechnung B2G this carries the Leitweg-ID.
projectReferencecontractReferencepurchaseOrderReferencesalesOrderReferencereceivingAdviceReferencedespatchAdviceReferencetenderOrLotReferencebuyerAccountingReferenceProcess context detected by /parse. On /generate, BT-24 (specificationIdentifier) is set from the 'format' parameter (a conflicting value is rejected with 400); BT-23 (businessProcessType) is taken from the input when given, e.g. the French billing framework code such as S1 or B1 (BR-FR-08), and otherwise defaults per format.
Absent for profiles without line items (MINIMUM, BASIC WL).