Responses

API response object reference.

All Document endpoints return one of these response types.

XmlGenerationResponse


ZugferdConversionResponse


SchematronValidationResponse


ValidationError

Schematron validation error detail

FieldTypeRequiredDescription
flagstringNoRaw schematron severity flag id (e.g. fatal_error, warn)
idstringNoSchematron rule ID
locationstringNoXPath location of the error in the XML
severitystringNoParsed severity; ERROR/FATAL_ERROR block sending, WARNING/INFO do not
textstringNoHuman-readable error message

PingResponse

FieldTypeRequiredDescription
environmentstringNo
rolestringNo
statusstringNo
timestampdatetimeNo