Skip to main content
Reason helps the recipient of a message determine why they are receiving it.

Schema ID

https://gobl.org/draft-0/bill/status#/$defs/Reason

Properties

TitlePropertyTypeDescription
Keykeycbc.KeyKey helps identify the reason.
DescriptiondescriptionstringDescription contains a simple text that describes the reason why the original document was not processed.
Conditionsconditionsarray of bill.ConditionCondition provides additional details with codes about what has gone wrong with the incoming document.
Extensionsexttax.ExtensionsExtensions for local or format focussed data

Key Values

ValueDescription
noneReceiver of the documents sends the message just to update the status and there are no problems with document processing.
referencesReceived document did not contain references as required by the receiver for correctly routing the document for approval or processing.
legalInformation in the received document is not according to legal requirements.
unknown-receiverThe party to which the document is addressed is not known.
qualityUnacceptable or incorrect quality.
deliveryDelivery proposed or provided is not acceptable.
pricesPrices not according to previous expectation.
quantityQuantity not according to previous expectation.
itemsItems not according to previous expectation.
payment-termsPayment terms not according to previous expectation.
not-recognizedCommercial transaction not recognized.
finance-termsFinance terms not according to previous expectation.
partialPayment is partially but not fully paid.
otherReason for status is not defined by code.

Validation Rules

FieldTestValidation Code / Message
key
  • Present
GOBL-BILL-REASON-01
Reason key is required
key
  • One of [none, references, legal, unknown-receiver, quality, delivery, prices, quantity, items, payment-terms, not-recognized, finance-terms, partial, other]
GOBL-BILL-REASON-02
Reason key is not valid