Connector API
Search…
Cashier transactions

Get all cashier transactions

Returns all cashier transactions created within the specified interval.

Request

[PlatformAddress]/api/connector/v1/cashierTransactions/getAll
1
{
2
"ClientToken": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D",
3
"AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D",
4
"Client": "Sample Client 1.0.0",
5
"CreatedUtc": {
6
"StartUtc": "2020-01-05T00:00:00Z",
7
"EndUtc": "2020-01-10T00:00:00Z"
8
}
9
}
Copied!
Property
Type
Contract
Description
ClientToken
string
required
Token identifying the client application.
AccessToken
string
required
Access token of the client application.
Client
string
required
Name and version of the client application.
CreatedUtc
required, max length 3 months
Interval in which the Cashier transaction was created.

Time interval

Property
Type
Contract
Description
StartUtc
string
required
Start of the interval in UTC timezone in ISO 8601 format.
EndUtc
string
required
End of the interval in UTC timezone in ISO 8601 format.

Response

1
{
2
"CashierTransactions": [
3
{
4
"Amount": {
5
"Currency": "EUR",
6
"Value": 100
7
},
8
"CashierId": "9a36e3fa-2299-474b-a8a2-5ea4da317abc",
9
"CreatedUtc": "2017-01-10T00:00:00Z",
10
"Id": "177740c3-fec9-4338-a224-a3b03a35b3e1",
11
"Notes": "Cash payment EUR",
12
"Number": "47",
13
"PaymentId": "a68ef257-2fbc-4a4f-85de-59d808cef657"
14
}
15
]
16
}
Copied!
Property
Type
Contract
Description
CashierTransactions
required
Cashier transactions created in the interval.

Cashier transaction

Property
Type
Contract
Description
Id
string
required
Unique identifier of the transaction.
CashierId
string
required
Unique identifier of the Cashier.
PaymentId
string
optional
Unique identifier of the corresponding payment Payment item.
CreatedUtc
string
required
Creation date and time of the transaction.
Number
string
required
Number of the transaction.
Notes
string
optional
Additional notes of the transaction.
Amount
required
Value of the transaction.
Last modified 3mo ago