Schema ID
https://gobl.org/draft-0/bill/status
Properties
| Title | Property | Type | Description |
|---|---|---|---|
| Tax Regime | $regime | tax.RegimeCode | Country code that identifies the tax regime applicable to the document. It determines which country-specific tax rules, normalizations, and validations are applied. It may be determined automatically via normalization of a supplier or issuer tax identity country code. |
| Addons | $addons | tax.AddonList | Addons defines a list of keys used to identify tax addons that apply special normalization, scenarios, and validation rules to a document. |
| UUID | uuid | string | Universally Unique Identifier. |
| Type | type | cbc.Key | Type of status being reported (e.g. “system” for internal events). |
| Issue Date | issue_date | cal.Date | IssueDate is the date when the status is to be considered effective. |
| Issue Time | issue_time | cal.Time | IssueTime is used when extra precision is required to determine when exactly the status was issued. |
| Series | series | cbc.Code | Series is an optional code to group related status events together. |
| Code | code | cbc.Code | Code provides a way to identify the specific status event being reported. |
| Extensions | ext | tax.Extensions | Ext provides additional structured data specific to the regime or addon. |
| Supplier | supplier | org.Party | Supplier represents the entity supplying the goods or services in the original transaction. |
| Customer | customer | org.Party | Customer is optional and describes the recipient of the original services. |
| Ordering | ordering | bill.Ordering | Ordering provides links to related documents and additional details about which parties may be involved in the transaction. |
| Lines | lines | array of bill.StatusLine | Lines contain the main payload of the message used to describe individual documents which have a status. |
| Notes | notes | array of org.Note | Notes for additional details about the event. |
| Meta | meta | cbc.Meta | Meta contains unstructured data useful for internal tools. |
Type Values
| Value | Description |
|---|---|
response | A response to a document that has been submitted, often used in a two way communication between a customer and supplier. |
update | Issued by the supplier or seller that will be shared with either the customer, a fifth-corner entity such as a government agency, or both. |
system | A system event that is not directly related to a specific document but needs to be recorded for compliance purposes. |
Validation Rules
| Field | Test | Validation Code / Message |
|---|---|---|
type |
| GOBL-BILL-STATUS-01Status type is required |
type |
| GOBL-BILL-STATUS-02Status type is not valid |
supplier |
| GOBL-BILL-STATUS-03Status supplier is required |
lines |
| GOBL-BILL-STATUS-04Status must have at least one line |