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

TitlePropertyTypeReq.Description
Tax Regime$regimel10n.TaxCountryCode
Addons$addonsarray of cbc.KeyAddons defines a list of keys used to identify tax addons that apply special normalization, scenarios, and validation rules to a document.
Tags$tagsarray of cbc.KeyTags 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.
UUIDuuidstringUniversally Unique Identifier.
Typetypecbc.KeyType of invoice document. May be restricted by local tax regime requirements.
Seriesseriescbc.CodeSeries is used to identify groups of invoices by date, business area, project, type of document, customer type, 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.
Codecodecbc.CodeCode is a sequential identifier that uniquely identifies the invoice. The code can be left empty initially, but is required to sign the invoice.
Issue Dateissue_datecal.DateIssue date for when the invoice was created and issued. Todays date is used if none is set. There are often legal restrictions on how far back an invoice can be issued.
Operation Dateop_datecal.DateDate when the operation defined by the invoice became effective.
Value Datevalue_datecal.DateWhen the taxes of this invoice become accountable, if none set, the issue date is used.
Currencycurrencycurrency.CodeCurrency for all invoice amounts and totals, unless explicitly stated otherwise.
Exchange Ratesexchange_ratesarray of currency.ExchangeRateExchange rates to be used when converting the invoices monetary values into other currencies.
Preceding Detailsprecedingarray of org.DocumentRefDocument references for previous invoices that this document replaces or extends.
Taxtaxbill.TaxSpecial billing tax configuration options.
Suppliersupplierorg.PartytrueThe entity supplying the goods or services and usually responsible for paying taxes.
Customercustomerorg.PartyLegal entity receiving the goods or services, may be nil in certain circumstances such as simplified invoices.
Lineslinesarray of bill.LineList of invoice lines representing each of the items sold to the customer.
Discountsdiscountsarray of bill.DiscountDiscounts or allowances applied to the complete invoice
Chargeschargesarray of bill.ChargeCharges or surcharges applied to the complete invoice
Ordering Detailsorderingbill.OrderingOrdering details including document references and buyer or seller parties.
Payment Detailspaymentbill.PaymentDetailsInformation on when, how, and to whom the invoice should be paid.
Delivery Detailsdeliverybill.DeliveryDetailsSpecific details on delivery of the goods referenced in the invoice.
Totalstotalsbill.TotalsSummary of all the invoice totals, including taxes (calculated).
Notesnotesarray of org.NoteUnstructured information that is relevant to the invoice, such as correction or additional legal details.
Complementscomplementsarray of schema.ObjectAdditional complementary objects that add relevant information to the invoice.
Metametacbc.MetaAdditional semi-structured data that doesn’t fit into the body of the invoice.
Attachmentsattachmentsarray of org.AttachmentAttachments 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

ValueDescription
AEUnited Arab Emirates
ATAustria
BEBelgium
BRBrazil
CACanada
CHSwitzerland
COColombia
DEGermany
ELGreece
ESSpain
FRFrance
GBUnited Kingdom
INIndia
ITItaly
MXMexico
NLThe Netherlands
PLPoland
PTPortugal
USUnited States of America

Type Values

ValueDescription
standardA regular commercial invoice document between a supplier and customer.
proformaFor a clients validation before sending a final invoice.
correctiveCorrected invoice that completely replaces the preceding document.
credit-noteReflects a refund either partial or complete of the preceding document. A credit note effectively extends the previous document.
debit-noteAn additional set of charges to be added to the preceding document.
otherAny 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.