Advance

Advance represents a single payment that has been made already, such as a deposit on an intent to purchase, or as credit from a previous invoice which was later corrected or cancelled.

Schema ID

https://gobl.org/draft-0/pay/advance

Properties

Title	Property	Type	Description
UUID	uuid	string	Universally Unique Identifier.
Date	date	cal.Date	When the advance was made.
Key	key	cbc.Key	The payment means used to make the advance.
Reference	ref	string	ID or reference for the advance.
Grant	grant	boolean	If this “advance” payment has come from a public grant or subsidy, set this to true.
Description	description	string	Details about the advance.
Percent	percent	num.Percentage	Percentage of the total amount payable that was paid. Note that multiple advances with percentages may lead to rounding errors, especially when the total advances sums to 100%. We recommend only including one advance with a percent value per document.
Amount	amount	num.Amount	How much was paid.
Currency	currency	currency.Code	If different from the parent document’s base currency.
Card	card	pay.Card	Details of the payment that was made via a credit or debit card.
Credit Transfer	credit_transfer	pay.CreditTransfer	Details about how the payment was made by credit (bank) transfer.
Extensions	ext	tax.Extensions	Tax extensions required by tax regimes or addons.
Meta	meta	cbc.Meta	Additional details useful for the parties involved.

Key Values

Value	Description
any	Any method available, no preference.
card	Payment card.
credit-transfer	Sender initiated bank or wire transfer.
credit-transfer+sepa	Sender initiated bank or wire transfer via SEPA.
debit-transfer	Receiver initiated bank or wire transfer.
cash	Cash in hand.
cheque	Cheque from bank.
bank-draft	Bankers Draft or Bank Cheque.
direct-debit	Direct debit from the customers bank account.
direct-debit+sepa	Direct debit from the customers bank account via SEPA.
online	Online or web payment.
promissory-note	Promissory note contract.
netting	Intercompany clearing or clearing between partners.
other	Other or mutually defined means of payment.

Validation Rules

Field	Test	Validation Code / Message
description	Present	GOBL-PAY-ADVANCE-01 Description is required
key	Be or starts with one of [any, card, credit-transfer, credit-transfer+sepa, debit-transfer, cash, cheque, bank-draft, direct-debit, direct-debit+sepa, online, promissory-note, netting, other]	GOBL-PAY-ADVANCE-02 Key must be valid