Schema ID
https://gobl.org/draft-0/bill/delivery
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. |
| Tags | $tags | array of cbc.Key | Tags are used to help identify specific tax scenarios or requirements that may apply changes to the contents of the document or imply a specific meaning. Converters may use tags to help identify specific situations that do not have a specific extension, for example; self-billed or partial invoices may be identified by their respective tags. |
| UUID | uuid | string | Universally Unique Identifier. |
| Type | type | cbc.Key | Type of delivery document. |
| Series | series | cbc.Code | Series is used to identify groups of deliveries by date, business area, project, type, customer, a combination of any, or other company specific data. If the output format does not support the series as a separate field, it will be prepended to the code for presentation with a dash (-) for separation. |
| Code | code | cbc.Code | Code is a sequential identifier that uniquely identifies the delivery. The code can be left empty initially, but is required to sign the document. |
| Issue Date | issue_date | cal.Date | When the delivery document is to be issued. |
| Issue Time | issue_time | cal.Time | IssueTime is an optional field that may be useful to indicate the time of day when the delivery was issued. Some regions and formats may require this field to be set. An empty string will be automatically updated to reflect the current time, otherwise the field can be left with a nil value. |
| Value Date | value_date | cal.Date | When the taxes of this delivery become accountable, if none set, the issue date is used. |
| Currency | currency | currency.Code | Currency for all delivery totals. |
| Exchange Rates | exchange_rates | array of currency.ExchangeRate | Exchange rates to be used when converting the invoices monetary values into other currencies. |
| Ordering | ordering | bill.Ordering | Ordering details for the delivery, including links to other documents. |
| Preceding Details | preceding | array of org.DocumentRef | Key information regarding previous delivery documents that this one will either extend or replace. |
| Tracking | tracking | bill.Tracking | Tracking is used to define specific codes or IDs that may be used to identify and track delivery. |
| Despatch Date | despatch_date | cal.Date | DespatchDate is the date when the goods are expected to be despatched. |
| Receive Date | receive_date | cal.Date | ReceiveDate is the date when the goods are expected to be received. |
| Tax | tax | bill.Tax | Special tax configuration for calculating totals. |
| Supplier | supplier | org.Party | The entity supplying the goods or services and usually responsible for paying taxes. |
| Customer | customer | org.Party | Legal entity receiving the goods or services, may be nil in certain circumstances such as simplified invoices. |
| Despatcher | despatcher | org.Party | The party who will despatch the goods defined in the invoice. |
| Receiver | receiver | org.Party | The party who will receive delivery of the goods defined in the invoice. |
| Courier | courier | org.Party | The courier responsible for delivering the goods. |
| Lines | lines | array of bill.Line | List of lines representing each of the items to be ordered. |
| Discounts | discounts | array of bill.Discount | Discounts or allowances applied to order totals |
| Charges | charges | array of bill.Charge | Charges or surcharges applied to order totals |
| Totals | totals | bill.Totals | Summary of all the order totals, including taxes (calculated). |
| Notes | notes | array of org.Note | Unstructured information that is relevant to the delivery, such as correction or additional legal details. |
| Complements | complements | array of schema.Object | Additional complementary objects that add relevant information to the delivery. |
| Meta | meta | cbc.Meta | Additional semi-structured data that doesn’t fit into the body of the delivery. |
| Attachments | attachments | array of org.Attachment | Attachments provide additional information or supporting documents that are not included in the main document. It is important that attachments are not used for alternative versions of the PDF, for that, see “links” inside the envelope headers. |
Type Values
| Value | Description |
|---|---|
advice | A delivery or despatch advice document send by the supplier to indicate how an order is to be delivered. |
note | A delivery note is a document accompanying a shipment of goods that lists the items included in the shipment. |
waybill | A waybill is a document issued by a carrier giving details and instructions relating to the shipment of a consignment of goods. |
receipt | A delivery receipt is a document that is signed by the person who receives goods to confirm that they have been received. |
other | Any other type of delivery that does not fit into the standard categories and implies that any scenarios defined in tax regimes or addons will not be applied. This is useful for being able to create deliveries with custom types in extensions, but is not recommended for general use. |
Validation Rules
| Field | Test | Validation Code / Message |
|---|---|---|
type |
| GOBL-BILL-DELIVERY-01Type is required |
type |
| GOBL-BILL-DELIVERY-02Type is not valid |
issue_dateCalculated |
| GOBL-BILL-DELIVERY-03Issue date is required |
supplier |
| GOBL-BILL-DELIVERY-04Supplier is required |
lines |
| GOBL-BILL-DELIVERY-05Lines are required |