Skip to content

Get all cashier transactions

POST
/api/connector/v1/cashierTransactions/getAll

Returns all cashier transactions. At least one of the filter parameters CashierTransactionIds or CreatedUtc must be specified in the request. Note this operation uses Pagination and supports Portfolio Access Tokens.

CashierTransactionParameters
object
ClientToken
required

Token identifying the client application.

string
>= 1 characters
AccessToken
required

Access token of the client application.

string
>= 1 characters
Client
required

Name and version of the client application.

string
>= 1 characters
Limitation
required

Limitation on the quantity of data returned and optional Cursor for the starting point of data.

object
Count
required
integer format: int32
Cursor
string format: uuid
nullable
EnterpriseIds

Unique identifiers of the Enterprises. If not specified, the operation returns data for all enterprises within scope of the Access Token.

Array<string>
nullable >= 1 items <= 1000 items
CashierTransactionIds

Unique identifiers of the Cashier transactions.

Array<string>
nullable >= 1 items <= 1000 items
CreatedUtc
TimeFilterInterval

Interval in which Cashier transaction was created.

object
StartUtc
string format: date-time
nullable
EndUtc
string format: date-time
nullable
Example
{
"ClientToken": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D",
"AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D",
"Client": "Sample Client 1.0.0",
"EnterpriseIds": [
"3fa85f64-5717-4562-b3fc-2c963f66afa6",
"4d0201db-36f5-428b-8d11-4f0a65e960cc"
],
"CashierTransactionIds": [
"177740c3-fec9-4338-a224-a3b03a35b3e1"
],
"CreatedUtc": {
"StartUtc": "2020-01-05T00:00:00Z",
"EndUtc": "2020-01-10T00:00:00Z"
},
"Limitation": {
"Count": 10
}
}

OK

CashierTransactionResult
object
CashierTransactions
required

The collection of cashier transactions.

Array<object>
Cashier transaction
object
Id
required

Unique identifier of the transaction.

string format: uuid
EnterpriseId
required

Unique identifier of the Enterprise.

string format: uuid
CashierId
required

Unique identifier of the Cashier.

string format: uuid
PaymentId

Unique identifier of the corresponding payment Payment item.

string format: uuid
nullable
CreatedUtc
required

Creation date and time of the transaction.

string
>= 1 characters
Number
required

Number of the transaction.

string
>= 1 characters
Notes

Additional notes of the transaction.

string
nullable
Amount
required
Currency value (ver 2018-06-07)

Total price of the transaction

object
Currency
required
string format: currency
>= 1 characters
Value
number format: double
nullable
Net
number format: double
nullable
Tax
number format: double
nullable
TaxRate
number format: double
nullable
Cursor

Unique identifier of the item one newer in time order than the items to be returned. If Cursor is not specified, i.e. null, then the latest or most recent items will be returned.

string format: uuid
nullable
Example
{
"CashierTransactions": [
{
"Amount": {
"Currency": "EUR",
"Value": 100
},
"CashierId": "9a36e3fa-2299-474b-a8a2-5ea4da317abc",
"CreatedUtc": "2017-01-10T00:00:00Z",
"Id": "177740c3-fec9-4338-a224-a3b03a35b3e1",
"EnterpriseId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"Notes": "Cash payment EUR",
"Number": "47",
"PaymentId": "a68ef257-2fbc-4a4f-85de-59d808cef657"
}
],
"Cursor": "177740c3-fec9-4338-a224-a3b03a35b3e1"
}

Server has successfully fulfilled the request and there is no additional information to send back.

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable

Error caused by the client app, e.g. in case of malformed request or invalid identifier of a resource. In most cases, such an error signifies a bug in the client app (consumer of the API).

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable

Error caused by usage of invalid ClientToken, AccessToken, or you may not have the necessary permission to use the endpoint.

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable

Server error that should be reported to the end user of the client app. Happens for example when the server-side validation fails or when a business-logic check is violated.

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable

Error caused by heavy request that takes too long to process (typically tens of seconds). To get around this, request data in smaller batches. For more information, see Request timeouts

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable

Error caused by too many requests sent in a given amount of time. Response contains Retry-After header indicating how long the user agent should wait before making a follow-up request. For more information, see Request limits.

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable

Unexpected error on the Mews side. This may be due to a software fault. If such a situation occurs, the error will be logged and the development team notified, however you can raise an issue through GitHub on our documentation repository.

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable