Bill
Payment
Bill
Payment
A Payment is used to link an invoice or invoices with a payment transaction.
Schema ID
https://gobl.org/draft-0/bill/payment
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 payment document being issued. | |
| Method | method | pay.Instructions | Details on how the payment was made based on the original instructions. | |
| Series | series | cbc.Code | Series 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. | |
| Code | code | cbc.Code | Code is a sequential identifier that uniquely identifies the payment. The code can be left empty initially, but is required to sign the document. | |
| Issue Date | issue_date | cal.Date | When the payment was issued. | |
| Value Date | value_date | cal.Date | When the taxes of this payment become accountable, if none set, the issue date is assumed. | |
| Currency | currency | currency.Code | Currency for all payment totals. | |
| Exchange Rates | exchange_rates | array of currency.ExchangeRate | Exchange rates to be used when converting the payment’s monetary values into other currencies. | |
| Extensions | ext | tax.Extensions | Extensions for additional codes that may be required. | |
| Preceding Details | preceding | array of org.DocumentRef | Key information regarding previous versions of this document. | |
| Supplier | supplier | org.Party | true | The taxable entity who is responsible for supplying goods or services. |
| Customer | customer | org.Party | Legal entity that receives the goods or services. | |
| Payee | payee | org.Party | Legal entity that receives the payment if not the supplier. | |
| Lines | lines | array of bill.PaymentLine | true | List of documents that are being paid for. |
| Ordering | ordering | bill.Ordering | Ordering allows for additional information about the ordering process including references to other documents and alternative parties involved in the order-to-delivery process. | |
| Tax | tax | tax.Total | Summary of the taxes applied to the payment for tax regimes that require this information to be communicated. | |
| Total | total | num.Amount | true | Total amount to be paid in this payment, either positive or negative according to the line types and totals. |
| Notes | notes | array of org.Note | Unstructured information that is relevant to the payment, such as correction or additional legal details. | |
| Complements | complements | array of schema.Object | Additional complementary objects that add relevant information to the payment. | |
| 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 |
|---|---|
request | A 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. |
advice | A remittance advice sent from the customer to the supplier reflecting that payment for the referenced documents has been made. |
receipt | A 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. |