Bill
Order
Bill
Order
Order documents are used for the initial part of a order-to-invoice process where the buyer requests goods or services from the seller.
Schema ID
https://gobl.org/draft-0/bill/order
Properties
| Title | Property | Type | Req. | Description |
|---|---|---|---|---|
| Tax Regime | $regime | l10n.TaxCountryCode | ||
| Addons | $addons | array of cbc.Key | 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 will apply changes to the contents of the invoice. Tags by design should always be optional, it should always be possible to build a valid invoice without any tags. | |
| UUID | uuid | string | Universally Unique Identifier. | |
| Type | type | cbc.Key | Type of the order. | |
| Series | series | cbc.Code | Used as a prefix to group codes. | |
| Code | code | cbc.Code | true | Sequential code used to identify this invoice in tax declarations. |
| Issue Date | issue_date | cal.Date | When the invoice was created. | |
| Operation Date | op_date | cal.Date | Date when the operation defined by the invoice became effective. | |
| Value Date | value_date | cal.Date | When the taxes of this invoice become accountable, if none set, the issue date is used. | |
| Currency | currency | currency.Code | Currency for all invoice totals. | |
| Exchange Rates | exchange_rates | array of currency.ExchangeRate | Exchange rates to be used when converting the invoices monetary values into other currencies. | |
| Contracts | contracts | array of org.DocumentRef | The identification of contracts. | |
| Preceding Details | preceding | array of org.DocumentRef | Key information regarding previous order documents. | |
| Identities | identities | array of org.Identity | Additional codes, IDs, SKUs, or other regional or custom identifiers that may be used to identify the order. | |
| Period | period | cal.Period | Period of time in which the order is valid. | |
| Tax | tax | bill.Tax | Special tax configuration for billing. | |
| Supplier | supplier | org.Party | true | 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. | |
| Buyer | buyer | org.Party | Party who is responsible for issuing payment, if not the same as the customer. | |
| Seller | seller | org.Party | Seller is the party liable to pay taxes on the transaction if not the same as the supplier. | |
| 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 | |
| Payment Details | payment | bill.PaymentDetails | Information on when, how, and to whom a final invoice would be paid. | |
| Delivery Details | delivery | bill.DeliveryDetails | Specific details on delivery of the goods to copy to the final invoice. | |
| 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 order, such as correction or additional legal details. | |
| Complements | complements | array of schema.Object | Additional complementary objects that add relevant information to the order. | |
| Meta | meta | cbc.Meta | Additional semi-structured data that doesn’t fit into the body of the order. | |
| 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. |
Tax Regime Values
| Value | Description |
|---|---|
AE | United Arab Emirates |
AT | Austria |
BE | Belgium |
BR | Brazil |
CA | Canada |
CH | Switzerland |
CO | Colombia |
DE | Germany |
EL | Greece |
ES | Spain |
FR | France |
GB | United Kingdom |
IN | India |
IT | Italy |
MX | Mexico |
NL | The Netherlands |
PL | Poland |
PT | Portugal |
US | United States of America |
Type Values
| Value | Description |
|---|---|
purchase | A purchase order is a document that a buyer sends to a seller to request goods or services. |
sale | A sales order is a document that a seller sends to a buyer to confirm the sale of goods or services. |
quote | A quote is a document that a seller sends to a buyer to provide a price for goods or services. |