What exactly is a batch? Every transaction you create forms part of what is known as a batch. Just like a receipt, each batch has its own number and is a collection of transactions. A ‘batch close’ is an administrative operation whereby the terminal closes the batch and instructs the systems to close the batch and open a new one.
Initialisation of the cut-off date
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 once the deadline has passed.
EN: The URL of your application to which we will redirect the client once the close batch has been completed.
EN: The URL of your application to which we will redirect the client once the close batch has been completed.
fb://Success
printByPaymentApp
bool
CZ: 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 the value “false”, we will return the user to your application immediately after the transaction and it is 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.
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 cancelled transactions.
EN: Total number of voided transactions.
EN: Total number of voided transactions.
5
totalAmount
CZ: Total closing balance.
EN: Total amount of the close batch.
EN: Total amount of the close batch.
100
totalCount
CZ: Total number of transactions in the financial statements.
EN: Number of all transactions in the closing batch.
EN: Number of all transactions in the closing batch.
15
saleAmount
CZ: Total value of SALES transactions.
EN: Total number of SALE transactions.
EN: Total number of SALE transactions.
105
voidCount
CZ: Number of cancelled transactions at the close of the financial year.
EN: Number of voided transactions in the closing batch.
EN: Number of voided transactions in the closing batch.
1
previousBatchDate
CZ: Date of the previous deadline.
EN: Date of the previous batch.
EN: Date of the previous batch.
2024-10-20T15:11:08.152Z
date
CZ: Date of the current closing.
EN: Date on which this batch was processed.
EN: Date on which this batch was processed.
2024-10-29T12:14:00.198Z
saleCount
CZ: Number of SALE transactions at the close of trading.
EN: Number of SALE transactions in the closing batch.
EN: Number of SALE transactions in the closing batch.
14
firstTransactionDate
CZ: Date of the first transaction in the financial year.
EN: Date of the first transaction in the closing batch.
EN: Date of the first transaction in the closing batch.
2024-10-21T17:19:20.015Z
subBatches
CZ: Here you will find a breakdown by payment method.
EN: Here you will find an overview by payment method.
EN: Here you will find an overview by payment method.
CASH
CARD
CARD