# ps.module.BalanceApi

All URIs are relative to */*

Method | HTTP request | Description
------------- | ------------- | -------------
[**apiVersionBalanceGet**](BalanceApi.md#apiVersionBalanceGet) | **GET** /api/{version}/balance | List all balance transaction
[**apiVersionBalancePut**](BalanceApi.md#apiVersionBalancePut) | **PUT** /api/{version}/balance | Update Top up call credit
[**apiVersionBalanceTenantIdPut**](BalanceApi.md#apiVersionBalanceTenantIdPut) | **PUT** /api/{version}/balance/{tenantId} | Customer's credit adjustment

<a name="apiVersionBalanceGet"></a>
# **apiVersionBalanceGet**
> apiVersionBalanceGet(version, opts)

List all balance transaction

### Example
```javascript
import ps.module from 'phonespeakv2_api';
let defaultClient = ps.module.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2
let oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = 'YOUR ACCESS TOKEN';

let apiInstance = new ps.module.BalanceApi();
let version = "version_example"; // String | 
let opts = { 
  'tenantId': "tenantId_example", // String | 
  'startDate': new Date("2013-10-20T19:20:30+01:00"), // Date | 
  'endDate': new Date("2013-10-20T19:20:30+01:00"), // Date | 
  'transactionType': new ps.module.PhoneSpeakEntitiesEnumsTransactionType(), // PhoneSpeakEntitiesEnumsTransactionType | 
  'status': true, // Boolean | 
  'sortBy': "sortBy_example", // String | 
  'direction': new ps.module.PhoneSpeakEntitiesEnumsListDirection(), // PhoneSpeakEntitiesEnumsListDirection | 
  'search': "search_example", // String | 
  'limit': 56, // Number | 
  'pageNum': 56 // Number | 
};
apiInstance.apiVersionBalanceGet(version, opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
});
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **version** | **String**|  | 
 **tenantId** | **String**|  | [optional] 
 **startDate** | **Date**|  | [optional] 
 **endDate** | **Date**|  | [optional] 
 **transactionType** | [**PhoneSpeakEntitiesEnumsTransactionType**](.md)|  | [optional] 
 **status** | **Boolean**|  | [optional] 
 **sortBy** | **String**|  | [optional] 
 **direction** | [**PhoneSpeakEntitiesEnumsListDirection**](.md)|  | [optional] 
 **search** | **String**|  | [optional] 
 **limit** | **Number**|  | [optional] 
 **pageNum** | **Number**|  | [optional] 

### Return type

null (empty response body)

### Authorization

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

### HTTP request headers

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

<a name="apiVersionBalancePut"></a>
# **apiVersionBalancePut**
> apiVersionBalancePut(version, opts)

Update Top up call credit

### Example
```javascript
import ps.module from 'phonespeakv2_api';
let defaultClient = ps.module.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2
let oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = 'YOUR ACCESS TOKEN';

let apiInstance = new ps.module.BalanceApi();
let version = "version_example"; // String | 
let opts = { 
  'amount': 1.2 // Number | 
};
apiInstance.apiVersionBalancePut(version, opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
});
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **version** | **String**|  | 
 **amount** | **Number**|  | [optional] 

### Return type

null (empty response body)

### Authorization

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

### HTTP request headers

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

<a name="apiVersionBalanceTenantIdPut"></a>
# **apiVersionBalanceTenantIdPut**
> apiVersionBalanceTenantIdPut(tenantId, version, opts)

Customer&#x27;s credit adjustment

### Example
```javascript
import ps.module from 'phonespeakv2_api';
let defaultClient = ps.module.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2
let oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = 'YOUR ACCESS TOKEN';

let apiInstance = new ps.module.BalanceApi();
let tenantId = "tenantId_example"; // String | 
let version = "version_example"; // String | 
let opts = { 
  'amount': 1.2 // Number | 
};
apiInstance.apiVersionBalanceTenantIdPut(tenantId, version, opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
});
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **tenantId** | **String**|  | 
 **version** | **String**|  | 
 **amount** | **Number**|  | [optional] 

### Return type

null (empty response body)

### Authorization

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

### HTTP request headers

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