Payment Template
The Payments Template provides a structured format for recording payment details, including header information, associated transactions, customer, and vendor data.
Header and Line Data
This section details the payment document, its lines, and associated data.
| Field | Description |
|---|---|
| payment.documentNo | A unique number assigned to each new payment document created. |
| payment.documentDate | The creation date of the document, formatted as "d.m.Y". |
| payment.stage.name | The current stage of the payment (e.g., Pending, Completed). |
| payment.paymentMethod.name | The name of the payment method used (e.g., Credit Card, Bank Transfer). |
| payment.createdBy.names | The full name of the person who created the document. |
| payment.created | The exact date and time the document was created, formatted as "d.m.Y H:i". |
| payment.parent.lines | Lines associated with the payment in parent documents, such as "payment transfer" or "payment revision". |
| payment.parent.paymentMethod.name | The payment method used in the parent document. |
| payment.lines | Lines associated with the payment document itself. |
| line.comment | A comment or note related to the specific line item. |
| line.amount | The monetary amount of the line item, formatted without or with two decimal places. |
| line.invoice.documentNo | The document number of the related invoice, if applicable. |
| line.sale.documentNo | The document number of the related sale, if applicable. |
| line.expense.documentNo | The document number of the related expense, if applicable. |
| additionalData['custom_field'] | Custom field data, if any, included in the payment document. |
| payment.amount | The total amount of the payment, formatted with two decimal places. |
| payment.currency.code | The currency code used for the payment (e.g., USD, EUR). |
Account, Customer, and Address Data
FIelds include customer information and their financial and contact details.
| Field | Description |
|---|---|
| financialInformation.name | The full name of the customer, which can refer to a person or a company. |
| financialInformation.address1 | A detailed description of the customer’s address. |
| financialInformation.country | The country associated with the customer’s address. |
| financialInformation.city | The city associated with the customer’s address. |
| financialInformation.identifierNationalId | The customer’s unique national identification number, if available. |
| financialInformation.identifierTaxId | The customer’s VAT or tax identification number, if available. |
| financialInformation.responsiblePerson | The financially responsible person for the customer’s account, if applicable. |
Vendor Data
This section outlines vendor-related financial and contact information.
| Field | Description |
|---|---|
| vendorFinancialInformation.name | The full name of the vendor, which can refer to a person or a company. |
| vendorFinancialInformation.address1 | A detailed description of the vendor’s address. |
| vendorFinancialInformation.country | The country associated with the vendor’s address. |
| vendorFinancialInformation.city | The city associated with the vendor’s address. |
| vendorFinancialInformation.identifierNationalId | The vendor’s unique national identification number, if available. |
| vendorFinancialInformation.identifierTaxId | The vendor’s VAT or tax identification number, if available. |
| vendorFinancialInformation.responsiblePerson | The financially responsible person for the vendor’s account, if applicable. |