Skip to main content
Fault provides a more formal structure for describing with a specific code what has been unacceptable about the source document, including potentially references to the fields causing issues.

Schema ID

https://gobl.org/draft-0/bill/fault

Properties

TitlePropertyTypeDescription
Codecodecbc.CodeCode or business term provided by the system that raised the condition. These should be searchable in order to help users or systems understand what went wrong with the document.
MessagemessagestringMessage contains human readable details about the specific condition.
Pathspathsarray of stringPaths contains an array of JSON paths that maps the GOBL specific error to a field inside the envelope that the condition is applied to.

Validation Rules

FieldTestValidation Code / Message
code
  • Present
GOBL-BILL-FAULT-01
Fault code is required