The Sales Template provides a detailed structure for managing sales documents, line items, and associated financial and organizational data. Below is an explanation of each section and its fields.
Header and Document Details
This section includes the primary details of the sales document, such as its creation, payment method, and overall context.
Field
Description
sales.documentNo
A unique number assigned to the sales document.
sales.documentDate
The date the sales document was created.
sales.amountTotal
The total amount due, including all items, taxes, and discounts.
sales.currency.code
The currency code used for the amounts (e.g., USD, EUR).
sales.currencyRate
The exchange rate applied if a multicurrency transaction is involved.
sales.dueDate
The date by which payment is expected.
sales.paymentMethod.name
The name of the payment method selected (e.g., Credit Card, Bank Transfer).
sales.paymentMethod.parent.name
The parent category or group of the selected payment method, if applicable.
sales.paymentMethod.description
Additional details about the payment method, if available.
sales.createdBy.names
The full name of the person who created the sales document.
sales.created
The exact date and time when the document was created.
sales.comment
Optional comments or additional information related to the sales document.
My Company Data
This section contains vendor-specific information, typically representing your organization or business.
Field
Description
vendorFinancialInformation.name
The full name of the vendor (company or individual).
vendorFinancialInformation.city
The first line of the vendor’s address, typically the city.
vendorFinancialInformation.address1
The detailed address of the vendor.
vendorFinancialInformation.uic
The vendor’s unique identification code (e.g., registration or national ID).
vendorFinancialInformation.vat
The vendor’s VAT identification number, if applicable.
vendorFinancialInformation.responsiblePerson
The individual responsible for the vendor’s financial matters.
Line Items
This section lists the individual items included in the sales document, along with their details and calculated values.
Field
Description
line.item.code
A unique code assigned to each item in the sales document.
line.item.nameDocument
The official name of the item as recorded in the document.
line.itemDescription
A description of the item. If none is provided, the item's name is used.
line.batch.name
The batch number or name of the item, if applicable.
line.quantity
The quantity of units for the specified item.
line.measure.name
The measurement unit for the quantity (e.g., kg, pcs), if applicable.
line.unitPriceOriginal
The original unit price of the item before taxes or discounts are applied.
line.amountDiscountOriginal
The discount amount applied to the item, if any.
line.amountTaxOriginal
The tax amount applied to the item, if any.
line.amountTotalOriginal
The total amount for the item, including discounts and taxes.
Document Summary
This section summarizes the overall financial information for the sales document, including discounts, taxes, and total amounts.
Field
Description
sales.amount
The total base amount for the document before applying any taxes or discounts.
sales.Discount
The total discount applied to the document.
sales.amountTax
The total VAT or tax amount applied to the document.
sales.amountTotal
The final total amount payable, inclusive of taxes, discounts, and line items.
sales.taxRate
The VAT rate applied to the document, expressed as a percentage.