# ArchivedDepositsApi

All URIs are relative to *http://localhost:8889/api*

|Method | HTTP request | Description|
|------------- | ------------- | -------------|
|[**getById**](#getbyid) | **GET** /archive/deposits/transactions/customfields/{transactionId} | Get archived deposit transaction|
|[**search**](#search) | **POST** /archive/deposits/transactions/customfields:search | Search Archived Deposit Transactions|

# **getById**
> ArchivedDepositTransaction getById()


### Example

```typescript
import {
    ArchivedDepositsApi,
    Configuration
} from './api';

const configuration = new Configuration();
const apiInstance = new ArchivedDepositsApi(configuration);

let transactionId: number; //The ID of the archived deposit transaction. (default to undefined)

const { status, data } = await apiInstance.getById(
    transactionId
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **transactionId** | [**number**] | The ID of the archived deposit transaction. | defaults to undefined|


### Return type

**ArchivedDepositTransaction**

### Authorization

[basic](../README.md#basic)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/vnd.mambu.v2+json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | The archived deposit transaction has been returned. |  -  |
|**400** | A validation error occurred |  -  |
|**401** | Unauthorized |  -  |
|**403** | Forbidden |  -  |
|**404** | The archived deposit transaction was not found. |  -  |

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

# **search**
> Array<ArchivedDepositTransaction> search(filterCriteriaValueDateBetweenDTO)


### Example

```typescript
import {
    ArchivedDepositsApi,
    Configuration,
    FilterCriteriaValueDateBetweenDTO
} from './api';

const configuration = new Configuration();
const apiInstance = new ArchivedDepositsApi(configuration);

let filterCriteriaValueDateBetweenDTO: FilterCriteriaValueDateBetweenDTO; //Filter criteria for searching archived deposit transactions
let cursor: string; //Cursor for pagination (optional) (default to '_')
let limit: number; //Limit of items to be returned (optional) (default to 50)

const { status, data } = await apiInstance.search(
    filterCriteriaValueDateBetweenDTO,
    cursor,
    limit
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **filterCriteriaValueDateBetweenDTO** | **FilterCriteriaValueDateBetweenDTO**| Filter criteria for searching archived deposit transactions | |
| **cursor** | [**string**] | Cursor for pagination | (optional) defaults to '_'|
| **limit** | [**number**] | Limit of items to be returned | (optional) defaults to 50|


### Return type

**Array<ArchivedDepositTransaction>**

### Authorization

[basic](../README.md#basic)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/vnd.mambu.v2+json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Archived deposit transaction search executed successfully |  -  |
|**400** | A validation error occurred |  -  |
|**401** | Unauthorized |  -  |
|**403** | Forbidden |  -  |

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