
The Communication systems app
Add communication system
Enter communication system parameters
Communication scenario | Choose “Generic” (CCOm offers communication scenarios as well for SAP S/4HANA, SAP Customer Checkout manager) |
Name | Name of the communication system |
Status | Active, Inactive, or Draft. Choose “Active”. |
Tab Destinations
Add button for destinations
Destination parameters
Type | HTTP, Communication takes place using HTTP/HTTPS |
Name | The name of the destination |
Description | Description of the destination |
Host | Host address of the destination |
Port | The port of the destination |
Path | The base path for all endpoints of the destination |
User name | Username of the technical user that is used to connect to the destination |
Password | Password of the technical user that is used to connect to the destination |
Ping Path | (Optional) The endpoint path for executing a ping call to check the availability of the server |
Timeout | In seconds. Max. period of a call to the destination till it times out |
Status | Specifies whether this destination is active or inactive |
Ping the destination
The communication arrangements app
Add a communication arrangement
Select your communication system
Outbound services tab
Outbound services of Generic
Edit outbound service
Active configured receipt endpoint
The generic receipt outbound service configuration options
Resolve sales sets | Flag if sales sets in receipts shall be resolved to their sub items directly attached to the receipt |
Send valid sales items only | Flag if all sales items (also voided items) or only the valid ones shall be transmitted |
Send valid payment items only | Flag if all payment items (also voided items) or only valid ones shall be transmitted |
Aggregate coupon assignments | Not relevant |
The receipt app
List of receipts
The tab Dispatch states
The Jobs app
Add a new job
Select the Receipt repost job type
Set parameters for receipt reposting
Description | Optional |
Type | Choose between “Immediate” (one time execution), “Single” (one time execution), “Hourly”, “Daily”, “Weekly”, “Monthly”, or “Cron expression” and configure accordingly |
Start reposting from (based on business transaction date) | Optional. The date from which onwards all receipts are resent |
Communication system | Communication system that supports receipt posting to which receipts shall be sent |
Dispatch status | “Send failed” (all receipts that are in status “failed”) or “Send failed and unposted” (all receipts that are in status “failed” and those for which no entry is made, e.g., after a server crash) |
The Receipt exports app
The parameters of the Receipt export job
Description | A description of the receipt export action |
Format | “EXCEL” (Receipts in a list in Excel format), “IDEA” (Exports for all receipts sales, payment and tax item information, text file format), “JSON” (contains all stored information about each receipt, same format as for the instant forwarding), “PDF (Cash book)”, “PDF (Cash journal)” |
File name template | The template of the file name after export |
Number of receipts per file | Threshold how many receipts shall be in an exported file, when above a new file is created |
Date from | Starting date (optional) |
Date to | End date (optional) |
Type | Sales transaction, Cash transaction, or empty (means both) |
Status | Void, Posted, Open/Parked, empty (means all) |
POS group | The POS group on which the export shall be restricted (for all if left empty) |
POS system | The POS system on which the export shall be restricted (for all if left empty) |
The exported receipts
The SFTP destination creation dialog
Name | Name of the destination |
Description | Description for the destination |
Host | Host of the SFTP server |
Port | SFTP server port |
Path | The path on the SFTP server to which files shall be exported |
User name | Username for the SFTP server connection |
Passphrase | Optional. In case of a username/password login, the password of the user. In case of a certificate-based login, the field can be left empty |
Private key file name | The file name of the certificate private key |
Private key | The content of the private key to be pasted (use this field or the file name) |
Use known hosts file | Flag if the connection should be restricted by the known hosts file |
Timeout | Timeout for connection to the SFTP server |
Status | Active or Inactive |
{
"checkoutPrefix": "A001",
"receipt": {
...
},
"customer": null
}
The receipt data structure overview
Field | Description |
businessTransactionDate | The business transaction date of the receipt |
cancellationStatus | Indicator if the receipt is cancelled ("1" means not cancelled, "2" partially cancelled, "3" cancelled) |
cashDeskClosingID | The cash desk closing ID to which the receipt is assigned |
createdAt | The unix timestamp when the receipt was created |
createdBy | The cashier that created the receipt |
currency | The currency of the receipt |
discountablePaymentGrossAmount | The total receipt gross amount to be paid that is discountable (sum of discountable sales items) |
discountAmount | In case of a header discount applied on the receipt, the absolute discount amount |
discountPercentage | In case of a header discount applied on the receipt, the discount in percent |
discountPurposeCode | In case of a header discount on the receipt, the according purpose code |
feeGrossAmount | The calculated gross amount of all fees |
feeNetAmount | The calculated net amount of all fees |
feeTaxAmount | The calculated tax amount of all fees |
id | The receipt/invoice ID |
notRoundedPaymentGrossAmount | The total gross amount of the receipt before header rounding |
paymentGrossAmount | The total receipt gross amount that is to be paid, contains discounts and fees. Use this field for the receipt total in your integration. |
paymentGrossAmountWithoutReceiptDiscount | The total gross amount to be paid without the receipt discount |
paymentGrossAmountWithoutVoucher | The total gross amount to be paid excluding voucher amounts |
paymentNetAmount | The total net amount to the paid |
paymentTaxAmount | The tax amount of the receipt to be paid |
percentageDiscount | Flag if the header discount was a percentage or absolute |
posGroupId | The ID of the POS group to which the cash desk is assigned |
posSystemId | The cash desk ID |
priceListId | The ID of the price list |
receiptID | The ID of the receipt |
roundingLevel | The rounding level ("1" means not used, "2" header rounding, "3" item rounding) |
roundingUsed | Flag if rounding is applied on the receipt |
serviceChargeGrossAmount | The amount of all calculated service charges including tax |
serviceChargeNetAmount | The net amount of all calculated service charges |
serviceChargeTaxAmount | The calculated tax amount of all service charges |
status | The status of receipt ("2" means posted, "6" voided) |
totalGrossAmount | The total gross amount based on the sale item unit amount without discounts and fees |
totalNetAmount | The total net amount based on the sale item unit amounts without discounts and fees |
totalTaxAmount | The total tax amount based on the sale item unit amounts without discounts and fees |
typeCode | The type code of the receipt ("1" means sales receipt, "2" cash in receipt, "3" cash out receipt, "5" cash desk closing cash in, "6" cash desk closing cash out, "7" cash desk closing cash balancing, "8" pay in, "9" pay out, "10" cash desk closing carry over, "11" no sale receipt, "12" reserve receipt) |
Field | Description |
calculationMetaData | The calculation meta data used for receipt recalculation |
cashDeskClosing | Reference data on the cash desk closing |
cashDeskPrintReceiptInformation | Cash desk configuration data used for receipt printing, such as VAT registration number |
chargeElements | The charge elements (comprises fees and service charges) |
paymentItems | The payment items of the receipt |
printLogo | The logo that was used in the receipt print |
salesItems | The sales items of the receipt |
taxItems | The tax items |
Field | Description |
businessTransactionAmount | The aggregated tax amount of this tax rate |
externalID | The position of the tax item |
productTaxationCharacteristicsCode | The product taxation characteristics code |
taxCountryCode | The country code of the tax rate |
taxRate | The tax rate |
taxRateTypeCode | The type code of the tax rate |
Field | Description |
cancellationSalesItem | Indicator if the sales item cancels a previous sales item |
courseId | The assigned course (restaurant mode) |
customerReturnReasonCode | The return reason code in case of a return |
deliveredNow | Relevant if receipt type is “Reserve invoice”. Indicator if the sold quantity is delivered along with the sales |
deliveredQuantity | Relevant if receipt type is “Reserve invoice”. The quantity of the sales item that is handed out to the customer |
deliveredQuantityManuallyChanged | Indicator, if the delivered quantity was changed by the cashier |
description | The description of the sales item |
discountable | Indicator if the sales item is discountable |
discountAmount | If an item discount is applied, the absolute discount amount |
discountAmountFromReceipt | The partial amount of the header discount that is distributed to the sales item |
discountPercentage | The percentage of the item discount if applied |
discountPurposeCode | If an item discount is applied, the purpose code |
discountPurposeCodeFromReceipt | The discount purpose code of the receipt discount that is distributed to this sales item |
externalID | The position of the sales item in the sales receipt |
feeGrossAmount | The gross amount of the fee that is calculated for the sales item |
feeNetAmount | The net amount of the fee that is calculated for the sales item |
feeTaxAmount | The tax amount of the fee that is calculated for the sales item |
grossAmount | The gross amount of the sales item without discount or rounding |
id | If a material sales item, the material code, otherwise e.g. the sales business document id |
managedBy | Indicator if the sales item represents a serial or batch number article (“1” means none, “2” serial number, “3” batch number) |
managedByNumber | The serial or batch number assigned to the sales item |
material > externalID | The article ID |
material > materialDescription | The description of the article |
material > prodCatID | Material article group |
netAmount | Net amount of the sales item without discount or rounding |
notRoundedPaymentGrossAmount | The payment gross amount before item rounding |
paymentGrossAmount | The calculated gross amount to be paid for the sales item after header and item discounts |
paymentGrossAmountWithoutReceiptDiscount | The sales item payment gross amount without the partial distributed receipt discount |
paymentNetAmount | The net amount of the sales item to be paid |
paymentTaxAmount | The tax amount to be paid for the sales item after discounts |
percentageDiscount | Indicator if the applied item discount is based on a percentage or absolute |
priceListId | The ID of the price list from which the standard price is taken |
productTaxationCharacteristicsCode | The product taxation characteristics code that is assigned to the sales item |
quantity | The quantity of the sales item |
quantityTypeCode | The unit of measure |
quantityTypeCodeName | The name of the unit of measure |
serviceChargeGrossAmount | The gross amount of the service charge that is calculated for the sales item |
serviceChargeNetAmount | The net amount of the service charge that is calculated for the sales item |
serviceChargeTaxAmount | The tax amount of the service charge that is calculated for the sales item |
status | The status of the sales item (“2” means confirmed, “3” void, “4” invalid) |
stockArea | The warehouse that is assigned to the sales item |
taxAmount | The tax amount of the sales item without discount or rounding |
taxCountryCode | The country code for the tax rate |
taxRate | The tax rate that is applied to the sales item |
taxRateTypeCode | The type code of the tax rate assigned to the sales item |
taxRateTypeCodeChanged | Indicator if the tax rate type code was manually changed by the cashier |
typeCode | The type code of the sales item (“1” means material, “2” voucher, “3” special sales item, “4” cash in/out, “5” cash balancing, “6” invoice, “7” pay in/out, “8” down payment, “9” paid down payment, “10” credit memo, “11” payment on account, “12” sales set, “13” expense”, “14” tip) |
unitBaseQuantity | The base quantity of the unit, usually 1. |
unitBaseQuantityTypeCode | The unit of measure of the unit base |
unitGrossAmount | The gross amount per unit |
unitGrossAmountOrigin | The gross amount per unit based on the price list |
unitNetAmount | The net amount per unit |
unitNetAmountOrigin | The original unit net amount (before any adaptations based on the pricelist) |
unitPriceChanged | Indicator if the unit price was manually changed by the cashier |
unitTaxAmount | The tax amount of the unit |
Field | Description |
additionalPaymentReference | Additional transaction reference field for the payment |
businessTransactionAmount | The business transaction amount of the payment |
businessTransactioncurrency | Business transaction currency |
creditCardErpTypeCode | The ERP type code of the credit card out of the CCOm configuration |
creditCardId | The credit card ID |
creditCardNumber | A dummy credit card number assigned to the payment item |
creditCardTypeCode | The credit card type code |
creditCardTypeName | The credit card name |
exchangeRateUsed | The exchange rate used for payment |
externalID | The position of the payment item in the receipt |
originalBusinessTransactionAmount | The original business transaction amount, if it deviates in the paid currency |
originalBusinessTransactioncurrency | Original business transaction currency, if it deviates in the paid currency |
paymentFormCode | The payment form code, “02” means Card payment, “05” back transfer, “06” check, “09” cash, “20” voucher, “30” debtor item |
paymentTransactionReferenceID | Transaction reference ID of the payment |
pettyCashID | Petty cash ID |
roundingAmount | The rounding amount |
status | The status of the payment item, “2” means confirmed, “3” cancelled, “5” void |
transactionDate | The transaction date and time of the payment |
Field | Description |
chargeElementConfigId | The ID of the charge element type |
chargeElementConfigName | The name of the charge element type |
chargeElementType | The type of the charge element (“FEE” or “SERVICE_CHARGE”) |
grossAmount | The gross amount of the charge element |
journalAccount | The journal account of the charge element type |
netAmount | The net amount of the charge element |
productTaxationCharacteristicsCode | The product taxation characteristics code of the tax rate |
taxAmount | The tax amount of the charge element |
taxCountryCode | The country code of the tax rate |
taxRate | The tax rate |
taxRateTypeCode | The tax rate type code |
Field | Description |
cashDeskClosingID | The ID of the cash desk closing |
companyId | The company ID if the cash desk closing is assigned to a specific company |
currency | The currency code of the cash desk closing |
drawerId | The drawer ID if central drawer management is activated |
Field | Description |
appliedOnReceiptLevel | Indicator if the coupon is applied on receipt or sales item level |
couponId | The account coupon ID |
discountElements > discountAmount | The applied discount amount |
discountElements > discountPurposeCode | The discount purpose code |
discountElements > manually | Indicator if the discount is given manually |
position | The ordered position of the assignment |
returned | Indicator if the coupon is returned |
You must be a registered user to add a comment. If you've already registered, sign in. Otherwise, register and sign in.
User | Count |
---|---|
3 | |
2 | |
1 | |
1 | |
1 | |
1 | |
1 | |
1 | |
1 | |
1 |