Record - GOBL

Record represents an individual payment transaction made via a specific means (cash, card, credit-transfer, etc.), with its own amount and optional currency.

Schema ID

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

Properties

Title	Property	Type	Description
UUID	`uuid`	string	Universally Unique Identifier.
Date	`date`	cal.Date	When the payment was made.
Key	`key`	cbc.Key	The payment means used.
Reference	`ref`	string	ID or reference for the payment.
Description	`description`	string	Description about the payment.
Percent	`percent`	num.Percentage	Percentage of the total amount payable that was paid. Note that multiple records with percentages may lead to rounding errors, especially when the total sums to 100%. We recommend only including one record 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.
Direct Debit	`direct_debit`	pay.DirectDebit	Details of the payment that was made via direct debit.
Online	`online`	array of pay.Online	Details of the payment that was made via an online provider.
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 by card.
`card+credit`	Payment by credit card.
`card+debit`	Payment by debit 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
`key`	Be or starts with one of [any, card, card+credit, card+debit, credit-transfer, credit-transfer+sepa, debit-transfer, cash, cheque, bank-draft, direct-debit, direct-debit+sepa, online, promissory-note, netting, other]	`GOBL-PAY-RECORD-01` Key must be valid

⌘I