# VxcServicesApi.VehicleFinanceApi

All URIs are relative to *https://vxc.prod.autotec.com/api/*

Method | HTTP request | Description
------------- | ------------- | -------------
[**addFinancialPortfolio**](VehicleFinanceApi.md#addFinancialPortfolio) | **POST** /vehicle/financial/portfolio/add | Add financial portfolios
[**financialPortfolioAlerts**](VehicleFinanceApi.md#financialPortfolioAlerts) | **GET** /vehicle/financial/portfolio/alerts | Retrieve financial portfolio alerts
[**removeFinancialPortfolio**](VehicleFinanceApi.md#removeFinancialPortfolio) | **POST** /vehicle/financial/portfolio/remove | Remove financial portfolios


<a name="addFinancialPortfolio"></a>
# **addFinancialPortfolio**
> Empty addFinancialPortfolio(xApiKey, xAutotecId, request)

Add financial portfolios

Method to add financial portfolios

### Example
```javascript
var VxcServicesApi = require('vxc_services_api');
var defaultClient = VxcServicesApi.ApiClient.instance;

// Configure API key authorization: CustomerAuthorizer
var CustomerAuthorizer = defaultClient.authentications['CustomerAuthorizer'];
CustomerAuthorizer.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CustomerAuthorizer.apiKeyPrefix = 'Token';

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix = 'Token';

var apiInstance = new VxcServicesApi.VehicleFinanceApi();

var xApiKey = "xApiKey_example"; // String | the AutoTec assigned authentication credential for the calling customer

var xAutotecId = "xAutotecId_example"; // String | the AutoTec assigned identification id for the calling customer

var request = new VxcServicesApi.Request(); // Request | The financial portfolios to be added


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.addFinancialPortfolio(xApiKey, xAutotecId, request, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **xApiKey** | **String**| the AutoTec assigned authentication credential for the calling customer | 
 **xAutotecId** | **String**| the AutoTec assigned identification id for the calling customer | 
 **request** | [**Request**](Request.md)| The financial portfolios to be added | 

### Return type

[**Empty**](Empty.md)

### Authorization

[CustomerAuthorizer](../README.md#CustomerAuthorizer), [api_key](../README.md#api_key)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json

<a name="financialPortfolioAlerts"></a>
# **financialPortfolioAlerts**
> Empty financialPortfolioAlerts(xApiKey, xAutotecId, opts)

Retrieve financial portfolio alerts

Get Method to retrieve financial portfolio alerts

### Example
```javascript
var VxcServicesApi = require('vxc_services_api');
var defaultClient = VxcServicesApi.ApiClient.instance;

// Configure API key authorization: CustomerAuthorizer
var CustomerAuthorizer = defaultClient.authentications['CustomerAuthorizer'];
CustomerAuthorizer.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CustomerAuthorizer.apiKeyPrefix = 'Token';

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix = 'Token';

var apiInstance = new VxcServicesApi.VehicleFinanceApi();

var xApiKey = "xApiKey_example"; // String | the AutoTec assigned authentication credential for the calling customer

var xAutotecId = "xAutotecId_example"; // String | the AutoTec assigned identification id for the calling customer

var opts = { 
  'startDate': "startDate_example", // String | Start Date for the portfolio alerts
  'endDate': "endDate_example", // String | End Date for the portfolio alerts
  'portfolioId': "portfolioId_example" // String | PortfolioId for the portfolio alerts
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.financialPortfolioAlerts(xApiKey, xAutotecId, opts, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **xApiKey** | **String**| the AutoTec assigned authentication credential for the calling customer | 
 **xAutotecId** | **String**| the AutoTec assigned identification id for the calling customer | 
 **startDate** | **String**| Start Date for the portfolio alerts | [optional] 
 **endDate** | **String**| End Date for the portfolio alerts | [optional] 
 **portfolioId** | **String**| PortfolioId for the portfolio alerts | [optional] 

### Return type

[**Empty**](Empty.md)

### Authorization

[CustomerAuthorizer](../README.md#CustomerAuthorizer), [api_key](../README.md#api_key)

### HTTP request headers

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

<a name="removeFinancialPortfolio"></a>
# **removeFinancialPortfolio**
> Empty removeFinancialPortfolio(xApiKey, xAutotecId, request)

Remove financial portfolios

Method to Remove financial portfolios

### Example
```javascript
var VxcServicesApi = require('vxc_services_api');
var defaultClient = VxcServicesApi.ApiClient.instance;

// Configure API key authorization: CustomerAuthorizer
var CustomerAuthorizer = defaultClient.authentications['CustomerAuthorizer'];
CustomerAuthorizer.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CustomerAuthorizer.apiKeyPrefix = 'Token';

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix = 'Token';

var apiInstance = new VxcServicesApi.VehicleFinanceApi();

var xApiKey = "xApiKey_example"; // String | the AutoTec assigned authentication credential for the calling customer

var xAutotecId = "xAutotecId_example"; // String | the AutoTec assigned identification id for the calling customer

var request = new VxcServicesApi.Request1(); // Request1 | The financial portfolios to be removed


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.removeFinancialPortfolio(xApiKey, xAutotecId, request, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **xApiKey** | **String**| the AutoTec assigned authentication credential for the calling customer | 
 **xAutotecId** | **String**| the AutoTec assigned identification id for the calling customer | 
 **request** | [**Request1**](Request1.md)| The financial portfolios to be removed | 

### Return type

[**Empty**](Empty.md)

### Authorization

[CustomerAuthorizer](../README.md#CustomerAuthorizer), [api_key](../README.md#api_key)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json