# DepositAccountBalanceSummaryApi

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

|Method | HTTP request | Description|
|------------- | ------------- | -------------|
|[**getAll**](#getall) | **GET** /deposits/{depositAccountId}/balanceSummary | Get balance summary for the deposit account|
|[**search**](#search) | **POST** /deposits/balanceSummary:search | Search deposit account balance summary|

# **getAll**
> Array<DepositAccountBalanceSummary> getAll()


### Example

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

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

let depositAccountId: string; //The ID or encoded key of the deposit account. (default to undefined)
let offset: number; //Pagination, index to start searching at when retrieving elements, used in combination with limit to paginate results (optional) (default to undefined)
let limit: number; //Pagination, the number of elements to retrieve, used in combination with offset to paginate results (optional) (default to undefined)
let paginationDetails: 'ON' | 'OFF'; //Flag specifying whether the pagination  details should be provided in response headers. Please note that by default it is disabled (OFF), in order to improve the performance of the APIs (optional) (default to 'OFF')
let startDate: string; //The start date to filter by (optional) (default to undefined)
let endDate: string; //The end date to filter by (optional) (default to undefined)

const { status, data } = await apiInstance.getAll(
    depositAccountId,
    offset,
    limit,
    paginationDetails,
    startDate,
    endDate
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **depositAccountId** | [**string**] | The ID or encoded key of the deposit account. | defaults to undefined|
| **offset** | [**number**] | Pagination, index to start searching at when retrieving elements, used in combination with limit to paginate results | (optional) defaults to undefined|
| **limit** | [**number**] | Pagination, the number of elements to retrieve, used in combination with offset to paginate results | (optional) defaults to undefined|
| **paginationDetails** | [**&#39;ON&#39; | &#39;OFF&#39;**]**Array<&#39;ON&#39; &#124; &#39;OFF&#39;>** | Flag specifying whether the pagination  details should be provided in response headers. Please note that by default it is disabled (OFF), in order to improve the performance of the APIs | (optional) defaults to 'OFF'|
| **startDate** | [**string**] | The start date to filter by | (optional) defaults to undefined|
| **endDate** | [**string**] | The end date to filter by | (optional) defaults to undefined|


### Return type

**Array<DepositAccountBalanceSummary>**

### 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 deposit account balance summary has been returned. |  * Items-Limit - Pagination details, the requested page size <br>  * Items-Offset - Pagination details, the index of the first returned item <br>  * Items-Total - Pagination details, the total available items <br>  |
|**400** | A validation error occurred |  -  |
|**401** | Unauthorized |  -  |
|**403** | Forbidden |  -  |
|**404** | The deposit account 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<DepositAccountBalanceSummary> search(depositAccountBalanceSummarySearchCriteria)


### Example

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

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

let depositAccountBalanceSummarySearchCriteria: DepositAccountBalanceSummarySearchCriteria; //The criteria to be used to search the deposit accounts balance summary.
let offset: number; //Pagination, index to start searching at when retrieving elements, used in combination with limit to paginate results (optional) (default to undefined)
let limit: number; //Pagination, the number of elements to retrieve, used in combination with offset to paginate results (optional) (default to undefined)
let paginationDetails: 'ON' | 'OFF'; //Flag specifying whether the pagination  details should be provided in response headers. Please note that by default it is disabled (OFF), in order to improve the performance of the APIs (optional) (default to 'OFF')

const { status, data } = await apiInstance.search(
    depositAccountBalanceSummarySearchCriteria,
    offset,
    limit,
    paginationDetails
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **depositAccountBalanceSummarySearchCriteria** | **DepositAccountBalanceSummarySearchCriteria**| The criteria to be used to search the deposit accounts balance summary. | |
| **offset** | [**number**] | Pagination, index to start searching at when retrieving elements, used in combination with limit to paginate results | (optional) defaults to undefined|
| **limit** | [**number**] | Pagination, the number of elements to retrieve, used in combination with offset to paginate results | (optional) defaults to undefined|
| **paginationDetails** | [**&#39;ON&#39; | &#39;OFF&#39;**]**Array<&#39;ON&#39; &#124; &#39;OFF&#39;>** | Flag specifying whether the pagination  details should be provided in response headers. Please note that by default it is disabled (OFF), in order to improve the performance of the APIs | (optional) defaults to 'OFF'|


### Return type

**Array<DepositAccountBalanceSummary>**

### 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** | The deposit account balance summary search results have been returned. |  * Items-Limit - Pagination details, the requested page size <br>  * Items-Offset - Pagination details, the index of the first returned item <br>  * Items-Total - Pagination details, the total available items <br>  |
|**400** | A validation error occurred |  -  |
|**401** | Unauthorized |  -  |
|**403** | Forbidden |  -  |
|**404** | The deposit account 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)