Schema ID
https://gobl.org/draft-0/bill/payment
Properties
| Title | Property | Type | Description |
|---|---|---|---|
| Tax Regime | $regime | tax.RegimeCode | Country code that identifies the tax regime applicable to the document. It determines which country-specific tax rules, normalizations, and validations are applied. It may be determined automatically via normalization of a supplier or issuer tax identity country code. |
| Addons | $addons | tax.AddonList | 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 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. |
| UUID | uuid | string | Universally Unique Identifier. |
| Type | type | cbc.Key | Type of payment document being issued. |
| 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. |
| Issue Time | issue_time | cal.Time | IssueTime is an optional field that may be useful to indicate the time of day 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 | 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. |
| 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. |
| Lines | lines | array of bill.PaymentLine | List of documents that are being paid for. |
| Methods | methods | array of pay.Record | Methods describes how the payment was settled. At least one method is required; multiple may be present when the payment was split across means (for example, partly card + partly cash). |
| Total | total | num.Amount | Total amount to be paid in this payment, either positive or negative according to the line types and totals. Calculated automatically. |
| 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. |
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. |
Validation Rules
| Field | Test | Validation Code / Message |
|---|---|---|
| Payment |
| GOBL-BILL-PAYMENT-08Methods sum must match total |
typeCalculated |
| GOBL-BILL-PAYMENT-01Payment type is required |
typeCalculated |
| GOBL-BILL-PAYMENT-02Payment type is not valid |
methods |
| GOBL-BILL-PAYMENT-03At least one payment method is required |
methods[*].key |
| GOBL-BILL-PAYMENT-09Payment method key is required |
issue_dateCalculated |
| GOBL-BILL-PAYMENT-04Payment issue date is required |
currencyCalculated |
| GOBL-BILL-PAYMENT-05Payment currency is required |
supplier |
| GOBL-BILL-PAYMENT-06Payment supplier is required |
lines |
| GOBL-BILL-PAYMENT-07Payment lines are required |