Bill
Invoice
Bill
Invoice
Invoice represents a payment claim for goods or services supplied under conditions agreed between the supplier and the customer.
Schema ID
https://gobl.org/draft-0/bill/invoice
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 invoice document subject to the requirements of the local tax regime. | |
| 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. | |
| Preceding Details | preceding | array of org.DocumentRef | Key information regarding previous invoices and potentially details as to why they were corrected. | |
| 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. | |
| Lines | lines | array of bill.Line | List of invoice lines representing each of the items sold to the customer. | |
| Discounts | discounts | array of bill.Discount | Discounts or allowances applied to the complete invoice | |
| Charges | charges | array of bill.Charge | Charges or surcharges applied to the complete invoice | |
| Ordering Details | ordering | bill.Ordering | Ordering details including document references and buyer or seller parties. | |
| Payment Details | payment | bill.Payment | Information on when, how, and to whom the invoice should be paid. | |
| Delivery Details | delivery | bill.Delivery | Specific details on delivery of the goods referenced in the invoice. | |
| Totals | totals | bill.Totals | Summary of all the invoice totals, including taxes (calculated). | |
| Notes | notes | array of cbc.Note | Unstructured information that is relevant to the invoice, such as correction or additional legal details. | |
| Complements | complements | array of schema.Object | Additional complementary objects that add relevant information to the invoice. | |
| Meta | meta | cbc.Meta | Additional semi-structured data that doesn’t fit into the body of the invoice. |
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 |
|---|---|
standard | A regular commercial invoice document between a supplier and customer. |
proforma | For a clients validation before sending a final invoice. |
corrective | Corrected invoice that completely replaces the preceding document. |
credit-note | Reflects a refund either partial or complete of the preceding document. A |
| credit note effectively extends the previous document. | |
debit-note | An additional set of charges to be added to the preceding document. |
other | Any other type of invoice 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 invoices with custom types in extensions, | |
| but is not recommend for general use. |