A Payment is used to link an invoice or invoices with a payment transaction.

Schema ID

https://gobl.org/draft-0/bill/payment

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 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.
UUIDuuidstringUniversally Unique Identifier.
Typetypecbc.KeyType of payment document being issued.
Methodmethodpay.InstructionsDetails on how the payment was made based on the original instructions.
Seriesseriescbc.CodeSeries is used to identify groups of payments 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.
Codecodecbc.CodeCode is a sequential identifier that uniquely identifies the payment. The code can be left empty initially, but is required to sign the document.
Issue Dateissue_datecal.DateWhen the payment was issued.
Issue Timeissue_timecal.TimeIssueTime is an optional field that may be useful to indicate the time of day when the payment was issued.
Value Datevalue_datecal.DateWhen the taxes of this payment become accountable, if none set, the issue date is assumed.
Currencycurrencycurrency.CodeCurrency for all payment totals.
Exchange Ratesexchange_ratesarray of currency.ExchangeRateExchange rates to be used when converting the payment’s monetary values into other currencies.
Extensionsexttax.ExtensionsExtensions for additional codes that may be required.
Preceding Detailsprecedingarray of org.DocumentRefKey information regarding previous versions of this document.
Suppliersupplierorg.PartytrueThe taxable entity who is responsible for supplying goods or services.
Customercustomerorg.PartyLegal entity that receives the goods or services.
Payeepayeeorg.PartyLegal entity that receives the payment if not the supplier.
Lineslinesarray of bill.PaymentLinetrueList of documents that are being paid for.
Orderingorderingbill.OrderingOrdering allows for additional information about the ordering process including references to other documents and alternative parties involved in the order-to-delivery process.
Totaltotalnum.AmounttrueTotal amount to be paid in this payment, either positive or negative according to the line types and totals. Calculated automatically.
Notesnotesarray of org.NoteUnstructured information that is relevant to the payment, such as correction or additional legal details.
Complementscomplementsarray of schema.ObjectAdditional complementary objects that add relevant information to the payment.
Metametacbc.MetaAdditional semi-structured data that doesn’t fit into the body of the invoice.

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
requestA payment request sent from the supplier to a customer indicating that they are requesting a transfer of funds from the customer directly or a payer. This is used to request payment for specific documents and invoices.
adviceA remittance advice sent from the customer to the supplier reflecting that payment for the referenced documents has been made.
receiptA payment receipt sent from the supplier to a customer indicating that they have received a transfer of funds from the customer directly or a payer. This is the default payment type and may be required by some tax regimes in order to communicate the payment of specific documents and invoices.