The following JSON examples show how the receipt of a downpayment and the subsequent treatment for this downpayment upon delivery or provision of services can be handled in RetailForce. Please note that the term used in RetailForce for downpayments / prepayments is 'deposit'.
Please note that certain property values used in the examples must be adjusted so that you can use the payload in your system (e.g. "UniqueClientId", "BookDate"). The examples have also been created for a specific country, which means that tax rates, gross and net amounts, etc. must also be adjusted.
| User Release Version: | 1.11.16.2546 |
| DOM-Version: | 1.7.0 |
1. Deposit/Downpayment received
In the first step a receipt for the received downpayment is created:
- The customer makes a cash deposit of EUR 1,200 for a future delivery or service.
Transaction properties
The table below shows which properties must be set to which values in order to correctly map the business case.
| Property | Value | Description |
| DocumentType | "0" resp. "[0] = Receipt" | to handle via cash receipt |
| Positions.Type | "3" resp. "[3] = Booking" | A deposit received is recorded as a line item of type "3" (booking position). |
| Positions.BusinessTransactionType | "7" resp. "[7] = Deposit" | The specific business transaction type (BusinessTransactionType) used is "7" (deposit). |
| Positions.VatIdentification | If, in the relevant country, VAT must already be shown or paid upon receipt of an advance payment or deposit, the correct VAT category ID must be specified and VAT calculated accordingly. | |
| Payments.Type | "0" resp. "Cash" | As this particular case involves a cash payment, the payment method must also be specified accordingly. |
Example:
{
"ModelVersion": "1.7.0",
"UniqueClientId": "3e2c0cdf-e72c-43ea-a050-686eb0eb3853",
"UniqueCashRegisterId": null,
"ApplicationVersion": "1.0.0",
"ApplicationVersionId": null,
"ApplicationVersionPrevious": null,
"FiscalModuleVersion": "1.11.0.0",
"FiscalCountryModuleVersion": null,
"SoftwareName": "RetailForce neverPOS",
"RetailForceReceiptId": null,
"AdditionalFields": {},
"AutomaticVatCalculation": 0,
"AllowedVatDeviation": 0.01,
"PrintCount": null,
"TerminalSlaveId": null,
"FooterGraphicIndex": null,
"DocumentGuid": "026f0809-88b8-48c2-9e96-6f3ba37f48ff",
"DocumentId": "0026",
"CreateDate": "2026-06-01T13:30:08+02:00",
"BookDate": "2026-06-01T13:30:08+02:00",
"AccountingDate": "2026-06-01T13:30:08+02:00",
"DocumentNumber": "202500026",
"DocumentNumberSeries": "SI",
"CancellationDocument": false,
"FailedToPay": false,
"DocumentReference": null,
"IsTraining": false,
"TestCaseNumber": null,
"DocumentType": 0,
"DocumentTypeCaption": "POS-Receipt",
"User": {
"Id": "1",
"Caption": "User01",
"FirstName": "Joe",
"LastName": "Dowe",
"TaxNumber": null,
"DateOfEntry": "2025-09-23T15:11:08.6041978+02:00"
},
"SalesPerson": null,
"AllocationGroups": [],
"CustomerCount": null,
"Partner": null,
"Notes": null,
"PaymentTerms": null,
"ServicePeriodStart": null,
"ServicePeriodEnd": null,
"PositionCount": 1,
"DocumentIssueType": null,
"Coupon": null,
"ServiceType": null,
"IsEcommerceTransaction": null,
"TaxPositions": null,
"FiscalDocumentNumber": 0,
"FiscalDocumentRevision": 0,
"FiscalDocumentStartTime": 0,
"Positions": [
{
"PositionNumber": 0,
"Caption": "Downpayment for Order",
"Type": 3,
"BusinessTransactionType": 7,
"PayOutType": null,
"VatIdentification": 1,
"VatPercent": 200.0,
"NetValue": 1000.00,
"GrossValue": 1200.00,
"TaxValue": 200.00,
"AdditionalFields": {},
"ExternalIdentifier": []
}
],
"Payments": [
{
"Amount": 1200.00,
"CurrencyIsoCode": "EUR",
"Caption": "Bar",
"UniqueReadablePaymentIdentifier": "BAR",
"ForeignAmount": 0,
"ForeignAmountExchangeRate": 0,
"AdditionalFields": {},
"PaymentType": 0,
"CreateDate": null,
"VatIdentification": null,
"VatPercent": null,
"VatPercent2": null,
"TaxValue": null,
"TaxValue2": null,
"ExternalIdentifier": [],
"User": null,
"SalesPerson": null,
"PaymentTerminalReferenceId": null,
"CardData": null
}
],
"AdditionalHeader": [],
"AdditionalFooter": [],
"FiscalAdditionalFields": {}
}
2. Settlement of the final payment
Upon delivery or provision of services (e.g. where the customer collects the goods they have ordered), the customer must settle the outstanding balance of the full value of the goods:
- Total value of the goods/services: EUR 2,979.90
- Taking into account the deposit of EUR 1,200
- The customer pays the balance (EUR 1,779.90) in cash as well
The deposit can be included in the final document in two different ways:
Option 1 – Deposit as an item
In this variant, the down payment is included in the payload as a negative item (the opposite of the item in the original payload).
Transaction properties
The table below shows which properties must be set to which values in order to correctly map the business case.
| Property | Value | Description |
| DocumentType | "0" resp. "[0] = Receipt" | to handle via cash receipt |
| Positions.Type | "0" resp. "[0] = Item" | For item position 0 (the item ordered by the customer for which a deposit has been paid) |
| Positions.BusinessTransactionType | "0" resp. "[0] = Revenue" | For item position 0 (the item ordered by the customer for which a deposit has been paid) |
| Positions.Type | "3" resp. "[3] = Booking" | To include the deposit received, item 1 of type "3" (booking position) is used – as in the first example. However, the values (GrossValue, NetValue, etc.) for this position are negative (!) |
| Positions.BusinessTransactionType | "7" resp. "[7] = Deposit" | The specific business transaction type (BusinessTransactionType) used in item 1 is "7" (deposit). |
| Positions.VatIdentification | VAT must also be taken into account when the deposit is settled. | |
| Payments.Type | "0" resp. "Cash" | In the "Payments" section, only the remaining payment is shown in cash (Total Items = Total Payments). Calculation: Position 0: 2,979.90 Position 1: -1,200.00 Total Positions: 1,779.90 Payments: 1,779.90 (cash) Total payments: 1,779.90 |
Example:
{
"ModelVersion": "1.7.0",
"UniqueClientId": "3e2c0cdf-e72c-43ea-a050-686eb0eb3853",
"UniqueCashRegisterId": null,
"ApplicationVersion": "1.0.0",
"ApplicationVersionId": null,
"ApplicationVersionPrevious": null,
"FiscalModuleVersion": "1.11.0.0",
"FiscalCountryModuleVersion": null,
"SoftwareName": "RetailForce neverPOS",
"RetailForceReceiptId": null,
"AdditionalFields": {},
"AutomaticVatCalculation": 0,
"AllowedVatDeviation": 0.01,
"PrintCount": null,
"TerminalSlaveId": null,
"FooterGraphicIndex": null,
"DocumentGuid": "215f0809-88b8-48c2-9e96-6f3ba37f48ff",
"DocumentId": "0021",
"CreateDate": "2025-10-09T12:50:08+02:00",
"BookDate": "2025-10-09T12:50:08+02:00",
"AccountingDate": "2025-10-09T12:50:08+02:00",
"ProcessStartDate": "2025-10-09T12:50:08+02:00",
"DocumentNumber": "202500021",
"DocumentNumberSeries": "SI",
"CancellationDocument": false,
"FailedToPay": false,
"DocumentReference": null,
"IsTraining": false,
"TestCaseNumber": null,
"DocumentType": 0,
"DocumentTypeCaption": "POS-Receipt",
"User": {
"Id": "1",
"Caption": "User01",
"FirstName": "Joe",
"LastName": "Dowe",
"TaxNumber": null,
"DateOfEntry": "2025-09-23T15:11:08.6041978+02:00"
},
"SalesPerson": null,
"AllocationGroups": [],
"CustomerCount": null,
"Partner": null,
"Notes": null,
"PaymentTerms": null,
"ServicePeriodStart": null,
"ServicePeriodEnd": null,
"PositionCount": 2,
"DocumentIssueType": null,
"Coupon": null,
"ServiceType": null,
"IsEcommerceTransaction": null,
"TaxPositions": null,
"FiscalDocumentNumber": 0,
"FiscalDocumentRevision": 0,
"FiscalDocumentStartTime": 0,
"Positions": [
{
"PositionNumber": 0,
"ItemCaption": "RENOXA KnowPal 15.6 Untel Lore Ultra- Z9 399J 32GB RAM 512GB SSD RTX 3060 W11P",
"ItemShortCaption": "RENOXA KnowPal",
"ItemSerialNumber": null,
"Type": 0,
"Quantity": 2.0,
"QuantityUnit": {
"Id": "STK"
},
"ItemType": 0,
"ItemId": "RKP156UZ9",
"ItemTaxType": 0,
"InHouse": true,
"ItemGroupId": "1000",
"ItemGroupCaption": "Notebooks",
"BusinessTransactionType": 0,
"CostPrice": 2979.90,
"BaseNetValue": 2483.25,
"BaseGrossValue": 2979.90,
"BaseTaxValue": 496.65,
"Discounts": [],
"VatIdentification": 1,
"VatPercent": 20.0,
"NetValue": 2483.25,
"GrossValue": 2979.90,
"TaxValue": 496.65,
"AdditionalFields": {},
"ExternalIdentifier": []
},
{
"PositionNumber": 1,
"Caption": "Downpayment for Order",
"Type": 3,
"BusinessTransactionType": 7,
"PayOutType": null,
"VatIdentification": 1,
"VatPercent": 20.0,
"NetValue": -1000.00,
"GrossValue": -1200.00,
"TaxValue": -200.00,
"AdditionalFields": {},
"ExternalIdentifier": []
}
],
"Payments": [
{
"Amount": 1779.90,
"CurrencyIsoCode": "EUR",
"Caption": "Bar",
"UniqueReadablePaymentIdentifier": "Cash",
"ForeignAmount": 0,
"ForeignAmountExchangeRate": 0,
"AdditionalFields": {},
"PaymentType": 0,
"CreateDate": null,
"VatIdentification": null,
"VatPercent": null,
"VatPercent2": null,
"TaxValue": null,
"TaxValue2": null,
"ExternalIdentifier": [],
"User": null,
"SalesPerson": null,
"PaymentTerminalReferenceId": null,
"CardData": null
}
],
"AdditionalHeader": [],
"AdditionalFooter": [],
"FiscalAdditionalFields": {}
}
Option 2 – Deposit as payment
In this variant, the deposit received is shown as a payment item in the payload.
Transaction properties
The table below shows which properties must be set to which values in order to correctly map the business case.
| Property | Value | Description |
| DocumentType | "0" bzw. "[0] = Receipt" | to handle via cash receipt |
| Positions.Type | "0" bzw. "[0] = Item" | For item position 0 (the item ordered by the customer for which a deposit has been paid) |
| Positions.BusinessTransactionType | "0" bzw. "[0] = Revenue" | For item position 0 (the item ordered by the customer for which a deposit has been paid) |
| Payments.Type | "0" bzw. "Cash" | The “Payments” section includes two items: 1. The remaining balance paid in cash, and... |
| Payments.Type | "6" bzw. "[6] = Deposit" | ... the deposit received (positive!). Calculation: Position 0: 2,979.90 Total positions: 2,979.90 Payments: 1,779.90 (Cash) Payments: 1,200.00 (Deposit) Total payments: 2,979.90 |
| Payments.VatPercent | If, in the relevant country, VAT must already be shown or paid upon receipt of an advance payment or deposit, the VAT that has already been declared must also be specified accordingly in the Payments object! | |
| Payments.TaxValue | If, in the relevant country, VAT must already be shown or paid upon receipt of an advance payment or deposit, the VAT that has already been declared must also be specified accordingly in the Payments object! |
Example:
{
"ModelVersion": "1.7.0",
"UniqueClientId": "3e2c0cdf-e72c-43ea-a050-686eb0eb3853",
"UniqueCashRegisterId": null,
"ApplicationVersion": "1.0.0",
"ApplicationVersionId": null,
"ApplicationVersionPrevious": null,
"FiscalModuleVersion": "1.11.0.0",
"FiscalCountryModuleVersion": null,
"SoftwareName": "RetailForce neverPOS",
"RetailForceReceiptId": null,
"AdditionalFields": {},
"AutomaticVatCalculation": 0,
"AllowedVatDeviation": 0.01,
"PrintCount": null,
"TerminalSlaveId": null,
"FooterGraphicIndex": null,
"DocumentGuid": "026f0809-88b8-48c2-9e96-6f3ba37f48ff",
"DocumentId": "0026",
"CreateDate": "2026-06-10T14:39:08+02:00",
"BookDate": "2026-06-10T14:39:08+02:00",
"AccountingDate": "2026-06-10T14:39:08+02:00",
"DocumentNumber": "202500026",
"DocumentNumberSeries": "SI",
"CancellationDocument": false,
"FailedToPay": false,
"DocumentReference": null,
"IsTraining": false,
"TestCaseNumber": null,
"DocumentType": 0,
"DocumentTypeCaption": "POS-Receipt",
"User": {
"Id": "1",
"Caption": "User01",
"FirstName": "Joe",
"LastName": "Dowe",
"TaxNumber": null,
"DateOfEntry": "2025-09-23T15:11:08.6041978+02:00"
},
"SalesPerson": null,
"AllocationGroups": [],
"CustomerCount": null,
"Partner": null,
"Notes": null,
"PaymentTerms": null,
"ServicePeriodStart": null,
"ServicePeriodEnd": null,
"PositionCount": 1,
"DocumentIssueType": null,
"Coupon": null,
"ServiceType": null,
"IsEcommerceTransaction": null,
"TaxPositions": null,
"FiscalDocumentNumber": 0,
"FiscalDocumentRevision": 0,
"FiscalDocumentStartTime": 0,
"Positions": [
{
"PositionNumber": 0,
"ItemCaption": "RENOXA KnowPal 15.6 Untel Lore Ultra- Z9 399J 32GB RAM 512GB SSD RTX 3060 W11P",
"ItemShortCaption": "RENOXA KnowPal",
"ItemSerialNumber": null,
"Type": 0,
"Quantity": 2.0,
"QuantityUnit": {
"Id": "STK"
},
"ItemType": 0,
"ItemId": "RKP156UZ9",
"ItemTaxType": 0,
"InHouse": true,
"ItemGroupId": "1000",
"ItemGroupCaption": "Notebooks",
"BusinessTransactionType": 0,
"CostPrice": 2979.90,
"BaseNetValue": 2483.25,
"BaseGrossValue": 2979.90,
"BaseTaxValue": 496.65,
"Discounts": [],
"VatIdentification": 1,
"VatPercent": 20.0,
"NetValue": 2483.25,
"GrossValue": 2979.90,
"TaxValue": 496.65,
"AdditionalFields": {},
"ExternalIdentifier": []
}
],
"Payments": [
{
"Amount": 1779.90,
"CurrencyIsoCode": "EUR",
"Caption": "Bar",
"UniqueReadablePaymentIdentifier": "Cash",
"ForeignAmount": 0,
"ForeignAmountExchangeRate": 0,
"AdditionalFields": {},
"PaymentType": 0,
"CreateDate": null,
"VatIdentification": null,
"VatPercent": null,
"VatPercent2": null,
"TaxValue": null,
"TaxValue2": null,
"ExternalIdentifier": [],
"User": null,
"SalesPerson": null,
"PaymentTerminalReferenceId": null,
"CardData": null
},
{
"Amount": 1200.00,
"CurrencyIsoCode": "EUR",
"Caption": "Anzahlung",
"UniqueReadablePaymentIdentifier": "Deposit",
"ForeignAmount": 0,
"ForeignAmountExchangeRate": 0,
"AdditionalFields": {},
"PaymentType": 6,
"CreateDate": null,
"VatIdentification": 1,
"VatPercent": 20.0,
"VatPercent2": null,
"TaxValue": 200.00,
"TaxValue2": null,
"ExternalIdentifier": [],
"User": null,
"SalesPerson": null,
"PaymentTerminalReferenceId": null,
"CardData": null
}
],
"AdditionalHeader": [],
"AdditionalFooter": [],
"FiscalAdditionalFields": {}
}
Comments
0 comments
Please sign in to leave a comment.