# SmartVolution\V1transactionsApi

All URIs are relative to http://dev.smartvolution.com:9003.

Method | HTTP request | Description
------------- | ------------- | -------------
[**batchLockSuspendedTransaction()**](V1transactionsApi.md#batchLockSuspendedTransaction) | **GET** /v1/batchLockSuspendedTransaction | Batch Lock Suspended Transactions
[**batchLockSuspendedTransactionV2()**](V1transactionsApi.md#batchLockSuspendedTransactionV2) | **GET** /v2/batchLockSuspendedTransaction | Batch Lock Suspended Transactions
[**createTransaction()**](V1transactionsApi.md#createTransaction) | **POST** /v1/transactions | Create a new transaction in the system
[**findPreAuthTransactionItems()**](V1transactionsApi.md#findPreAuthTransactionItems) | **GET** /v1/suspend/findPreAuthTransactionItems | Check if exists Pre Auth Suspended Items
[**findSuspendedTransactionById()**](V1transactionsApi.md#findSuspendedTransactionById) | **GET** /v1/suspended/{id} | Gets suspended transaction details by their id
[**findSuspendedTransactionByIdV2()**](V1transactionsApi.md#findSuspendedTransactionByIdV2) | **GET** /v2/suspended/{id} | Gets suspended transaction details by their id
[**findSuspendedTransactionByIdV3()**](V1transactionsApi.md#findSuspendedTransactionByIdV3) | **GET** /v3/suspended/{id} | Gets suspended transaction details by their id
[**findSuspendedTransactionByReference()**](V1transactionsApi.md#findSuspendedTransactionByReference) | **GET** /v1/suspend/findSuspendedTransactionByReference | Gets a list of used reference that contains suspended transactions
[**findSuspendedTransactionByReferenceV2()**](V1transactionsApi.md#findSuspendedTransactionByReferenceV2) | **GET** /v2/suspend/findSuspendedTransactionByReference | Gets a list of used reference that contains suspended transactions
[**findSuspendedTransactionByTillNumber()**](V1transactionsApi.md#findSuspendedTransactionByTillNumber) | **GET** /v1/suspendedReferences | Gets a list of SuspendedTransactions&#39; references by storeId and till number
[**findTransactionById()**](V1transactionsApi.md#findTransactionById) | **GET** /v1/transactions/{id} | Gets transaction details by their id
[**findTransactionByIdV2()**](V1transactionsApi.md#findTransactionByIdV2) | **GET** /v2/transactions/{id} | Gets transaction details by their id
[**getAllSuspendedTransactions()**](V1transactionsApi.md#getAllSuspendedTransactions) | **GET** /v1/suspended | Gets a list of all the suspended transactions for a tenant
[**getAllSuspendedTransactionsV2()**](V1transactionsApi.md#getAllSuspendedTransactionsV2) | **GET** /v2/suspended | Gets a list of all the suspended transactions for a tenant
[**getAllSuspendedTransactionsV3()**](V1transactionsApi.md#getAllSuspendedTransactionsV3) | **GET** /v3/suspended | Gets a list of all the suspended transactions for a tenant
[**getAllTransactions()**](V1transactionsApi.md#getAllTransactions) | **GET** /v1/transactions | Gets a list of all the transactions for a tenant
[**getAllTransactionsV2()**](V1transactionsApi.md#getAllTransactionsV2) | **GET** /v2/transactions | Gets a list of all the transactions for a tenant
[**getSuspendedClerks()**](V1transactionsApi.md#getSuspendedClerks) | **GET** /v1/suspendedClerks | Gets a list of clerks that contains suspended transactions
[**getSuspendedReasons()**](V1transactionsApi.md#getSuspendedReasons) | **GET** /v1/suspendedReasons | Gets a list of used reasons that contains suspended transactions
[**getTextsRemainingNotification()**](V1transactionsApi.md#getTextsRemainingNotification) | **GET** /v1/textsRemainingNotification | Gets texts remaining notification when the texts remaining lower than text re-order limit
[**putSuspendedTransaction()**](V1transactionsApi.md#putSuspendedTransaction) | **PUT** /v1/suspended | Put a suspended transaction in the system
[**updateTransaction()**](V1transactionsApi.md#updateTransaction) | **PATCH** /v1/transactions | Edit an existing transaction in the system


## `batchLockSuspendedTransaction()`

```php
batchLockSuspendedTransaction($ids, $clerkId, $lock): int[]
```

Batch Lock Suspended Transactions

This is not finalised as there is no security

### Example

```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');



$apiInstance = new SmartVolution\Api\V1transactionsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$ids = array(56); // int[] | ID list of Suspended Transaction to batch lock
$clerkId = 56; // int | ID of Staff to batch lock
$lock = True; // bool | Not used currently

try {
    $result = $apiInstance->batchLockSuspendedTransaction($ids, $clerkId, $lock);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling V1transactionsApi->batchLockSuspendedTransaction: ', $e->getMessage(), PHP_EOL;
}
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **ids** | [**int[]**](../Model/int.md)| ID list of Suspended Transaction to batch lock |
 **clerkId** | **int**| ID of Staff to batch lock | [optional]
 **lock** | **bool**| Not used currently | [optional]

### Return type

**int[]**

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: `application/json`

[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
[[Back to Model list]](../../README.md#models)
[[Back to README]](../../README.md)

## `batchLockSuspendedTransactionV2()`

```php
batchLockSuspendedTransactionV2($ids, $clerkId, $lock): int[]
```

Batch Lock Suspended Transactions

This is not finalised as there is no security

### Example

```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');



$apiInstance = new SmartVolution\Api\V1transactionsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$ids = array(56); // int[] | ID list of Suspended Transaction to batch lock
$clerkId = 56; // int | ID of Staff to batch lock
$lock = True; // bool | Not used currently

try {
    $result = $apiInstance->batchLockSuspendedTransactionV2($ids, $clerkId, $lock);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling V1transactionsApi->batchLockSuspendedTransactionV2: ', $e->getMessage(), PHP_EOL;
}
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **ids** | [**int[]**](../Model/int.md)| ID list of Suspended Transaction to batch lock |
 **clerkId** | **int**| ID of Staff to batch lock | [optional]
 **lock** | **bool**| Not used currently | [optional]

### Return type

**int[]**

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: `application/json`

[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
[[Back to Model list]](../../README.md#models)
[[Back to README]](../../README.md)

## `createTransaction()`

```php
createTransaction($transaction): \SmartVolution\Model\TransactionResponse
```

Create a new transaction in the system

This is not finalised as there is no security

### Example

```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');



$apiInstance = new SmartVolution\Api\V1transactionsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$transaction = new \SmartVolution\Model\Transaction(); // \SmartVolution\Model\Transaction | Transaction object that need to be created

try {
    $result = $apiInstance->createTransaction($transaction);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling V1transactionsApi->createTransaction: ', $e->getMessage(), PHP_EOL;
}
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **transaction** | [**\SmartVolution\Model\Transaction**](../Model/Transaction.md)| Transaction object that need to be created |

### Return type

[**\SmartVolution\Model\TransactionResponse**](../Model/TransactionResponse.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: `application/json`

[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
[[Back to Model list]](../../README.md#models)
[[Back to README]](../../README.md)

## `findPreAuthTransactionItems()`

```php
findPreAuthTransactionItems($deviceId)
```

Check if exists Pre Auth Suspended Items

if no tenant id is passed then will default to the user/device tenant

### Example

```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');



$apiInstance = new SmartVolution\Api\V1transactionsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$deviceId = 56; // int | deviceId

try {
    $apiInstance->findPreAuthTransactionItems($deviceId);
} catch (Exception $e) {
    echo 'Exception when calling V1transactionsApi->findPreAuthTransactionItems: ', $e->getMessage(), PHP_EOL;
}
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **deviceId** | **int**| deviceId | [optional]

### Return type

void (empty response body)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: Not defined

[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
[[Back to Model list]](../../README.md#models)
[[Back to README]](../../README.md)

## `findSuspendedTransactionById()`

```php
findSuspendedTransactionById($id, $clerkId, $noLock): \SmartVolution\Model\SuspendedTransactionOut
```

Gets suspended transaction details by their id

### Example

```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');



$apiInstance = new SmartVolution\Api\V1transactionsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$id = 56; // int | Id of suspended transaction to query
$clerkId = 56; // int | Id of clerk to query
$noLock = True; // bool | Lock of suspended transaction to query

try {
    $result = $apiInstance->findSuspendedTransactionById($id, $clerkId, $noLock);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling V1transactionsApi->findSuspendedTransactionById: ', $e->getMessage(), PHP_EOL;
}
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **id** | **int**| Id of suspended transaction to query |
 **clerkId** | **int**| Id of clerk to query | [optional]
 **noLock** | **bool**| Lock of suspended transaction to query | [optional]

### Return type

[**\SmartVolution\Model\SuspendedTransactionOut**](../Model/SuspendedTransactionOut.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: `application/json`

[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
[[Back to Model list]](../../README.md#models)
[[Back to README]](../../README.md)

## `findSuspendedTransactionByIdV2()`

```php
findSuspendedTransactionByIdV2($id, $clerkId, $noLock): \SmartVolution\Model\SuspendedTransactionOut
```

Gets suspended transaction details by their id

### Example

```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');



$apiInstance = new SmartVolution\Api\V1transactionsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$id = 56; // int | Id of suspended transaction to query
$clerkId = 56; // int | Id of clerk to query
$noLock = True; // bool | Lock of suspended transaction to query

try {
    $result = $apiInstance->findSuspendedTransactionByIdV2($id, $clerkId, $noLock);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling V1transactionsApi->findSuspendedTransactionByIdV2: ', $e->getMessage(), PHP_EOL;
}
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **id** | **int**| Id of suspended transaction to query |
 **clerkId** | **int**| Id of clerk to query | [optional]
 **noLock** | **bool**| Lock of suspended transaction to query | [optional]

### Return type

[**\SmartVolution\Model\SuspendedTransactionOut**](../Model/SuspendedTransactionOut.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: `application/json`

[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
[[Back to Model list]](../../README.md#models)
[[Back to README]](../../README.md)

## `findSuspendedTransactionByIdV3()`

```php
findSuspendedTransactionByIdV3($id, $clerkId, $noLock): \SmartVolution\Model\SuspendedTransactionOut
```

Gets suspended transaction details by their id

### Example

```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');



$apiInstance = new SmartVolution\Api\V1transactionsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$id = 56; // int | Id of suspended transaction to query
$clerkId = 56; // int | Id of clerk to query
$noLock = True; // bool | Lock of suspended transaction to query

try {
    $result = $apiInstance->findSuspendedTransactionByIdV3($id, $clerkId, $noLock);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling V1transactionsApi->findSuspendedTransactionByIdV3: ', $e->getMessage(), PHP_EOL;
}
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **id** | **int**| Id of suspended transaction to query |
 **clerkId** | **int**| Id of clerk to query | [optional]
 **noLock** | **bool**| Lock of suspended transaction to query | [optional]

### Return type

[**\SmartVolution\Model\SuspendedTransactionOut**](../Model/SuspendedTransactionOut.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: `application/json`

[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
[[Back to Model list]](../../README.md#models)
[[Back to README]](../../README.md)

## `findSuspendedTransactionByReference()`

```php
findSuspendedTransactionByReference($reference, $readyToComplete): \SmartVolution\Model\SuspendedTransaction[]
```

Gets a list of used reference that contains suspended transactions

if no tenant id is passed then will default to the user/device tenant

### Example

```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');



$apiInstance = new SmartVolution\Api\V1transactionsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$reference = 'reference_example'; // string
$readyToComplete = True; // bool | readyToComplete of suspended transaction to query

try {
    $result = $apiInstance->findSuspendedTransactionByReference($reference, $readyToComplete);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling V1transactionsApi->findSuspendedTransactionByReference: ', $e->getMessage(), PHP_EOL;
}
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **reference** | **string**|  |
 **readyToComplete** | **bool**| readyToComplete of suspended transaction to query | [optional]

### Return type

[**\SmartVolution\Model\SuspendedTransaction[]**](../Model/SuspendedTransaction.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: `application/json`

[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
[[Back to Model list]](../../README.md#models)
[[Back to README]](../../README.md)

## `findSuspendedTransactionByReferenceV2()`

```php
findSuspendedTransactionByReferenceV2($reference, $readyToComplete): \SmartVolution\Model\SuspendedTransaction[]
```

Gets a list of used reference that contains suspended transactions

if no tenant id is passed then will default to the user/device tenant

### Example

```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');



$apiInstance = new SmartVolution\Api\V1transactionsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$reference = 'reference_example'; // string
$readyToComplete = True; // bool | readyToComplete of suspended transaction to query

try {
    $result = $apiInstance->findSuspendedTransactionByReferenceV2($reference, $readyToComplete);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling V1transactionsApi->findSuspendedTransactionByReferenceV2: ', $e->getMessage(), PHP_EOL;
}
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **reference** | **string**|  |
 **readyToComplete** | **bool**| readyToComplete of suspended transaction to query | [optional]

### Return type

[**\SmartVolution\Model\SuspendedTransaction[]**](../Model/SuspendedTransaction.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: `application/json`

[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
[[Back to Model list]](../../README.md#models)
[[Back to README]](../../README.md)

## `findSuspendedTransactionByTillNumber()`

```php
findSuspendedTransactionByTillNumber($tillNumber): string[]
```

Gets a list of SuspendedTransactions' references by storeId and till number

### Example

```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');



$apiInstance = new SmartVolution\Api\V1transactionsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$tillNumber = 'tillNumber_example'; // string | tillNumber

try {
    $result = $apiInstance->findSuspendedTransactionByTillNumber($tillNumber);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling V1transactionsApi->findSuspendedTransactionByTillNumber: ', $e->getMessage(), PHP_EOL;
}
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **tillNumber** | **string**| tillNumber |

### Return type

**string[]**

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: `application/json`

[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
[[Back to Model list]](../../README.md#models)
[[Back to README]](../../README.md)

## `findTransactionById()`

```php
findTransactionById($id, $local): \SmartVolution\Model\TransactionOut
```

Gets transaction details by their id

### Example

```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');



$apiInstance = new SmartVolution\Api\V1transactionsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$id = 56; // int | Id of transaction to query
$local = True; // bool | Id of transaction to query

try {
    $result = $apiInstance->findTransactionById($id, $local);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling V1transactionsApi->findTransactionById: ', $e->getMessage(), PHP_EOL;
}
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **id** | **int**| Id of transaction to query |
 **local** | **bool**| Id of transaction to query | [optional]

### Return type

[**\SmartVolution\Model\TransactionOut**](../Model/TransactionOut.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: `application/json`

[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
[[Back to Model list]](../../README.md#models)
[[Back to README]](../../README.md)

## `findTransactionByIdV2()`

```php
findTransactionByIdV2($id, $local): \SmartVolution\Model\TransactionOut
```

Gets transaction details by their id

### Example

```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');



$apiInstance = new SmartVolution\Api\V1transactionsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$id = 56; // int | Id of transaction to query
$local = True; // bool | Id of transaction to query

try {
    $result = $apiInstance->findTransactionByIdV2($id, $local);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling V1transactionsApi->findTransactionByIdV2: ', $e->getMessage(), PHP_EOL;
}
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **id** | **int**| Id of transaction to query |
 **local** | **bool**| Id of transaction to query | [optional]

### Return type

[**\SmartVolution\Model\TransactionOut**](../Model/TransactionOut.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: `application/json`

[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
[[Back to Model list]](../../README.md#models)
[[Back to README]](../../README.md)

## `getAllSuspendedTransactions()`

```php
getAllSuspendedTransactions(): \SmartVolution\Model\SuspendedTransaction[]
```

Gets a list of all the suspended transactions for a tenant

if no tenant id is passed then will default to the user/device tenant

### Example

```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');



$apiInstance = new SmartVolution\Api\V1transactionsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);

try {
    $result = $apiInstance->getAllSuspendedTransactions();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling V1transactionsApi->getAllSuspendedTransactions: ', $e->getMessage(), PHP_EOL;
}
```

### Parameters

This endpoint does not need any parameter.

### Return type

[**\SmartVolution\Model\SuspendedTransaction[]**](../Model/SuspendedTransaction.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: `application/json`

[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
[[Back to Model list]](../../README.md#models)
[[Back to README]](../../README.md)

## `getAllSuspendedTransactionsV2()`

```php
getAllSuspendedTransactionsV2($readyToComplete): \SmartVolution\Model\SuspendedTransactionOut[]
```

Gets a list of all the suspended transactions for a tenant

if no tenant id is passed then will default to the user/device tenant

### Example

```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');



$apiInstance = new SmartVolution\Api\V1transactionsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$readyToComplete = True; // bool | readyToComplete of suspended transaction to query

try {
    $result = $apiInstance->getAllSuspendedTransactionsV2($readyToComplete);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling V1transactionsApi->getAllSuspendedTransactionsV2: ', $e->getMessage(), PHP_EOL;
}
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **readyToComplete** | **bool**| readyToComplete of suspended transaction to query | [optional]

### Return type

[**\SmartVolution\Model\SuspendedTransactionOut[]**](../Model/SuspendedTransactionOut.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: `application/json`

[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
[[Back to Model list]](../../README.md#models)
[[Back to README]](../../README.md)

## `getAllSuspendedTransactionsV3()`

```php
getAllSuspendedTransactionsV3($readyToComplete): \SmartVolution\Model\SuspendedTransactionOut[]
```

Gets a list of all the suspended transactions for a tenant

if no tenant id is passed then will default to the user/device tenant

### Example

```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');



$apiInstance = new SmartVolution\Api\V1transactionsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$readyToComplete = True; // bool | readyToComplete of suspended transaction to query

try {
    $result = $apiInstance->getAllSuspendedTransactionsV3($readyToComplete);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling V1transactionsApi->getAllSuspendedTransactionsV3: ', $e->getMessage(), PHP_EOL;
}
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **readyToComplete** | **bool**| readyToComplete of suspended transaction to query | [optional]

### Return type

[**\SmartVolution\Model\SuspendedTransactionOut[]**](../Model/SuspendedTransactionOut.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: `application/json`

[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
[[Back to Model list]](../../README.md#models)
[[Back to README]](../../README.md)

## `getAllTransactions()`

```php
getAllTransactions($tenant, $store, $clerk, $customer, $startTime, $endTime, $since, $deleted, $isBasic, $cardPan, $localTransactionId, $includeReversal): \SmartVolution\Model\TransactionOut[]
```

Gets a list of all the transactions for a tenant

if no tenant id is passed then will default to the user/device tenant

### Example

```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');



$apiInstance = new SmartVolution\Api\V1transactionsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$tenant = 56; // int | Id of Tenant to query
$store = array(56); // int[] | Id of Store to query
$clerk = array(56); // int[] | Id of clerk to query
$customer = 56; // int | Id of customer to query
$startTime = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | Start datetime eg 2015-07-07T14:43:00+00:00
$endTime = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | End datetime eg 2015-07-07T14:43:00+00:00
$since = 56; // int | A time in seconds since midnight January 1st 1970 UTC
$deleted = True; // bool | Shows only records that have been deleted
$isBasic = True; // bool | Return detail or not
$cardPan = 'cardPan_example'; // string | CardPan of Transactions to query
$localTransactionId = 'localTransactionId_example'; // string | localTransactionId of transactions to query
$includeReversal = True; // bool | Return reversal transaciton and its parent or not

try {
    $result = $apiInstance->getAllTransactions($tenant, $store, $clerk, $customer, $startTime, $endTime, $since, $deleted, $isBasic, $cardPan, $localTransactionId, $includeReversal);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling V1transactionsApi->getAllTransactions: ', $e->getMessage(), PHP_EOL;
}
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **tenant** | **int**| Id of Tenant to query | [optional]
 **store** | [**int[]**](../Model/int.md)| Id of Store to query | [optional]
 **clerk** | [**int[]**](../Model/int.md)| Id of clerk to query | [optional]
 **customer** | **int**| Id of customer to query | [optional]
 **startTime** | **\DateTime**| Start datetime eg 2015-07-07T14:43:00+00:00 | [optional]
 **endTime** | **\DateTime**| End datetime eg 2015-07-07T14:43:00+00:00 | [optional]
 **since** | **int**| A time in seconds since midnight January 1st 1970 UTC | [optional]
 **deleted** | **bool**| Shows only records that have been deleted | [optional]
 **isBasic** | **bool**| Return detail or not | [optional]
 **cardPan** | **string**| CardPan of Transactions to query | [optional]
 **localTransactionId** | **string**| localTransactionId of transactions to query | [optional]
 **includeReversal** | **bool**| Return reversal transaciton and its parent or not | [optional]

### Return type

[**\SmartVolution\Model\TransactionOut[]**](../Model/TransactionOut.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: `application/json`

[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
[[Back to Model list]](../../README.md#models)
[[Back to README]](../../README.md)

## `getAllTransactionsV2()`

```php
getAllTransactionsV2($tenant, $store, $clerk, $customer, $startTime, $endTime, $since, $deleted, $isBasic, $cardPan, $localTransactionId, $includeReversal, $isForRefund): \SmartVolution\Model\TransactionOut[]
```

Gets a list of all the transactions for a tenant

if no tenant id is passed then will default to the user/device tenant

### Example

```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');



$apiInstance = new SmartVolution\Api\V1transactionsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$tenant = 56; // int | Id of Tenant to query
$store = array(56); // int[] | Id of Store to query
$clerk = array(56); // int[] | Id of clerk to query
$customer = 56; // int | Id of customer to query
$startTime = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | Start datetime eg 2015-07-07T14:43:00+00:00
$endTime = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | End datetime eg 2015-07-07T14:43:00+00:00
$since = 56; // int | A time in seconds since midnight January 1st 1970 UTC
$deleted = True; // bool | Shows only records that have been deleted
$isBasic = True; // bool | Return detail or not
$cardPan = 'cardPan_example'; // string | CardPan of Transactions to query
$localTransactionId = 'localTransactionId_example'; // string | localTransactionId of transactions to query
$includeReversal = True; // bool | Return reversal transaciton and its parent or not
$isForRefund = True; // bool | Return whether transction list include transction that only contain items of type REFUND

try {
    $result = $apiInstance->getAllTransactionsV2($tenant, $store, $clerk, $customer, $startTime, $endTime, $since, $deleted, $isBasic, $cardPan, $localTransactionId, $includeReversal, $isForRefund);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling V1transactionsApi->getAllTransactionsV2: ', $e->getMessage(), PHP_EOL;
}
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **tenant** | **int**| Id of Tenant to query | [optional]
 **store** | [**int[]**](../Model/int.md)| Id of Store to query | [optional]
 **clerk** | [**int[]**](../Model/int.md)| Id of clerk to query | [optional]
 **customer** | **int**| Id of customer to query | [optional]
 **startTime** | **\DateTime**| Start datetime eg 2015-07-07T14:43:00+00:00 | [optional]
 **endTime** | **\DateTime**| End datetime eg 2015-07-07T14:43:00+00:00 | [optional]
 **since** | **int**| A time in seconds since midnight January 1st 1970 UTC | [optional]
 **deleted** | **bool**| Shows only records that have been deleted | [optional]
 **isBasic** | **bool**| Return detail or not | [optional]
 **cardPan** | **string**| CardPan of Transactions to query | [optional]
 **localTransactionId** | **string**| localTransactionId of transactions to query | [optional]
 **includeReversal** | **bool**| Return reversal transaciton and its parent or not | [optional]
 **isForRefund** | **bool**| Return whether transction list include transction that only contain items of type REFUND | [optional]

### Return type

[**\SmartVolution\Model\TransactionOut[]**](../Model/TransactionOut.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: `application/json`

[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
[[Back to Model list]](../../README.md#models)
[[Back to README]](../../README.md)

## `getSuspendedClerks()`

```php
getSuspendedClerks(): int[]
```

Gets a list of clerks that contains suspended transactions

if no tenant id is passed then will default to the user/device tenant

### Example

```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');



$apiInstance = new SmartVolution\Api\V1transactionsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);

try {
    $result = $apiInstance->getSuspendedClerks();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling V1transactionsApi->getSuspendedClerks: ', $e->getMessage(), PHP_EOL;
}
```

### Parameters

This endpoint does not need any parameter.

### Return type

**int[]**

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: `application/json`

[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
[[Back to Model list]](../../README.md#models)
[[Back to README]](../../README.md)

## `getSuspendedReasons()`

```php
getSuspendedReasons(): int[]
```

Gets a list of used reasons that contains suspended transactions

if no tenant id is passed then will default to the user/device tenant

### Example

```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');



$apiInstance = new SmartVolution\Api\V1transactionsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);

try {
    $result = $apiInstance->getSuspendedReasons();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling V1transactionsApi->getSuspendedReasons: ', $e->getMessage(), PHP_EOL;
}
```

### Parameters

This endpoint does not need any parameter.

### Return type

**int[]**

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: `application/json`

[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
[[Back to Model list]](../../README.md#models)
[[Back to README]](../../README.md)

## `getTextsRemainingNotification()`

```php
getTextsRemainingNotification(): \SmartVolution\Model\ClientNotification
```

Gets texts remaining notification when the texts remaining lower than text re-order limit

if no tenant id is passed then will default to the user/device tenant

### Example

```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');



$apiInstance = new SmartVolution\Api\V1transactionsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);

try {
    $result = $apiInstance->getTextsRemainingNotification();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling V1transactionsApi->getTextsRemainingNotification: ', $e->getMessage(), PHP_EOL;
}
```

### Parameters

This endpoint does not need any parameter.

### Return type

[**\SmartVolution\Model\ClientNotification**](../Model/ClientNotification.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: `application/json`

[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
[[Back to Model list]](../../README.md#models)
[[Back to README]](../../README.md)

## `putSuspendedTransaction()`

```php
putSuspendedTransaction($suspendedTransaction): int
```

Put a suspended transaction in the system

This is not finalised as there is no security

### Example

```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');



$apiInstance = new SmartVolution\Api\V1transactionsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$suspendedTransaction = new \SmartVolution\Model\SuspendedTransactionInPut(); // \SmartVolution\Model\SuspendedTransactionInPut | Transaction object that need to be created

try {
    $result = $apiInstance->putSuspendedTransaction($suspendedTransaction);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling V1transactionsApi->putSuspendedTransaction: ', $e->getMessage(), PHP_EOL;
}
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **suspendedTransaction** | [**\SmartVolution\Model\SuspendedTransactionInPut**](../Model/SuspendedTransactionInPut.md)| Transaction object that need to be created |

### Return type

**int**

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: `application/json`

[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
[[Back to Model list]](../../README.md#models)
[[Back to README]](../../README.md)

## `updateTransaction()`

```php
updateTransaction($transaction)
```

Edit an existing transaction in the system

This is not finalised as there is no security

### Example

```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');



$apiInstance = new SmartVolution\Api\V1transactionsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$transaction = new \SmartVolution\Model\TransactionInEdit(); // \SmartVolution\Model\TransactionInEdit | Transaction object containing edited fields

try {
    $apiInstance->updateTransaction($transaction);
} catch (Exception $e) {
    echo 'Exception when calling V1transactionsApi->updateTransaction: ', $e->getMessage(), PHP_EOL;
}
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **transaction** | [**\SmartVolution\Model\TransactionInEdit**](../Model/TransactionInEdit.md)| Transaction object containing edited fields |

### Return type

void (empty response body)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: Not defined

[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
[[Back to Model list]](../../README.md#models)
[[Back to README]](../../README.md)
