# DepositAccountBalancesApi

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

|Method | HTTP request | Description|
|------------- | ------------- | -------------|
|[**getBalances**](#getbalances) | **GET** /deposits/{depositAccountId}/balances | Get historical balances for the deposit account|

# **getBalances**
> DepositAccountBalances getBalances()


### Example

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

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

let depositAccountId: string; //The ID or encoded key of the deposit account. (default to undefined)
let localDateTime: LocalDateTimeQueryParam; //The datetime to retrieve balances for (in organization timezone). If not provided, returns balances for the current datetime. (optional) (default to undefined)

const { status, data } = await apiInstance.getBalances(
    depositAccountId,
    localDateTime
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **depositAccountId** | [**string**] | The ID or encoded key of the deposit account. | defaults to undefined|
| **localDateTime** | **LocalDateTimeQueryParam** | The datetime to retrieve balances for (in organization timezone). If not provided, returns balances for the current datetime. | (optional) defaults to undefined|


### Return type

**DepositAccountBalances**

### 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 balances have been returned. |  -  |
|**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)