What exactly is a dose? Every transaction you create belongs to a batch. Like a receipt, each batch has a number and is a package of transactions. close batch is an administrative operation that the terminal uses to close a batch and prompt the systems to close the batch and open a new one.
Day close initialization
The transaction can be initiated by calling:
gptom://batch/close?…
where the following parameters are used to build the report:
Variable/Field
Format/Format
Description/Description
Example
clientID
String
redirectUrl
String
CZ: The URL of your application to which we will redirect the client after the close batch is complete.
EN: The URL of your application to which we will redirect the client after the close batch is complete.
EN: The URL of your application to which we will redirect the client after the close batch is complete.
fb://Success
printByPaymentApp
bool
EN: Defines whether the receipt is passed to the client by your application or by GP tom. The default value is true (i.e. GP tom will offer the method of passing the receipt to the client). If you send a value of "false", we will return the user to your application immediately after the transaction and it is up to you to hand over the receipt.
EN: Defines whether the receipt is passed to the client by your application or GP tom. The default value is true (i.e. GP will offer a way to pass the receipt to the client). If you send a value of "false", we return the user to your app immediately after the transaction and it's up to you to pass the receipt.
EN: Defines whether the receipt is passed to the client by your application or GP tom. The default value is true (i.e. GP will offer a way to pass the receipt to the client). If you send a value of "false", we return the user to your app immediately after the transaction and it's up to you to pass the receipt.
true/false
preferableReceiptType
enum (sms,email,qr,print)
CZ: In case of sending a receipt from the GP tom application, it is possible to predefine the method of sending the receipt via API . Possible values are:
EN: In the case of sending a receipt from the GP tom application, it is possible to predefine the method of sending the receipt via the API. Possible values are:
PHONE
EMAIL
QR
PRINT
EN: In the case of sending a receipt from the GP tom application, it is possible to predefine the method of sending the receipt via the API. Possible values are:
PHONE
QR
text
clientPhone
String
CZ: Client's phone number.
EN: Client phone number.
EN: Client phone number.
+420606505404
clientEmail
String
CZ: Client's email address.
EN: Client email address.
EN: Client email address.
info@gptom.com
Example call:
gptom://batch/close?preferableReceiptType=QR&redirectUrl=gp://batch/close&clientEmail=info@gptom.com&clientID=223&printByPaymentApp=true&clientPhone=+420606505404
The answer will contain the following fields:
Variable/Field
Format/Format
Description/Description
Example/Example
TASK STATUS
CZ: Gives the answer in which state the request ended.
EN: Gives information in which state has your request ended.
EN: Gives information in which state has your request ended.
COMPLETED
CANCELED
ERROR
CANCELED
ERROR
communicationId
12345678
voidAmount
CZ: Total amount of voided transactions.
EN: Total amount of voided transactions.
EN: Total amount of voided transactions.
5
totalAmount
CZ: Total amount of close batch.
EN: Total amount of close batch.
EN: Total amount of close batch.
100
totalCount
CZ: Number of all transactions in the close batch.
EN: Number of all transactions in the close batch.
EN: Number of all transactions in the close batch.
15
saleAmount
CZ: Total amount of SALE transactions.
EN: Total amount of SALE transactions.
EN: Total amount of SALE transactions.
105
voidCount
CZ: Amount of voided transactions in the close batch.
EN: Amount of voided transactions in the close batch.
EN: Amount of voided transactions in the close batch.
1
previousBatchDate
CZ: Date of the previous day close.
EN: Date of the previous batch.
EN: Date of the previous batch.
2024-10-20T15:11:08.152Z
date
CZ: Date of processing this close batch.
EN: Date of processing this close batch.
EN: Date of processing this close batch.
2024-10-29T12:14:00.198Z
saleCount
CZ: Number of SALE transactions in the close batch.
EN: Number of SALE transactions in the close batch.
EN: Number of SALE transactions in the close batch.
14
firstTransactionDate
CZ: Date of the first transaction in the close batch.
EN: Date of the first transaction in the close batch.
EN: Date of the first transaction in the close batch.
2024-10-21T17:19:20.015Z
subBatches
CZ: Here you will find a breakdown by payment method.
EN: Here you will find overview per payment method.
EN: Here you will find overview per payment method.
CASH
CARD
CARD