Tael API

Accounts

getAccounts

List accounts


/accounts

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "https://api.tael.taelys.com/v1/accounts"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AccountsApi;

import java.io.File;
import java.util.*;

public class AccountsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure Bearer access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        AccountsApi apiInstance = new AccountsApi();

        try {
            array[Account] result = apiInstance.getAccounts();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountsApi#getAccounts");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();


try {
    final result = await api_instance.getAccounts();
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getAccounts: $e\n');
}

import org.openapitools.client.api.AccountsApi;

public class AccountsApiExample {
    public static void main(String[] args) {
        AccountsApi apiInstance = new AccountsApi();

        try {
            array[Account] result = apiInstance.getAccounts();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountsApi#getAccounts");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
AccountsApi *apiInstance = [[AccountsApi alloc] init];

// List accounts
[apiInstance getAccountsWithCompletionHandler: 
              ^(array[Account] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var TaelApi = require('tael_api');
var defaultClient = TaelApi.ApiClient.instance;

// Configure Bearer access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new TaelApi.AccountsApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAccounts(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getAccountsExample
    {
        public void main()
        {
            // Configure Bearer access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new AccountsApi();

            try {
                // List accounts
                array[Account] result = apiInstance.getAccounts();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AccountsApi.getAccounts: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AccountsApi();

try {
    $result = $api_instance->getAccounts();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AccountsApi->getAccounts: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::AccountsApi;

# Configure Bearer access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::AccountsApi->new();

eval {
    my $result = $api_instance->getAccounts();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AccountsApi->getAccounts: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure Bearer access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.AccountsApi()

try:
    # List accounts
    api_response = api_instance.get_accounts()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AccountsApi->getAccounts: %s\n" % e)
extern crate AccountsApi;

pub fn main() {

    let mut context = AccountsApi::Context::default();
    let result = client.getAccounts(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


Budgets

getBudgets

List budgets


/budgets

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "https://api.tael.taelys.com/v1/budgets?accountExternalId=38400000-8cf0-11bd-b23e-10b96e4ef00d"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.BudgetsApi;

import java.io.File;
import java.util.*;

public class BudgetsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure Bearer access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        BudgetsApi apiInstance = new BudgetsApi();
        UUID accountExternalId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The account to retrieve data for

        try {
            AccountBudgets result = apiInstance.getBudgets(accountExternalId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BudgetsApi#getBudgets");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final UUID accountExternalId = new UUID(); // UUID | The account to retrieve data for

try {
    final result = await api_instance.getBudgets(accountExternalId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getBudgets: $e\n');
}

import org.openapitools.client.api.BudgetsApi;

public class BudgetsApiExample {
    public static void main(String[] args) {
        BudgetsApi apiInstance = new BudgetsApi();
        UUID accountExternalId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The account to retrieve data for

        try {
            AccountBudgets result = apiInstance.getBudgets(accountExternalId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BudgetsApi#getBudgets");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
BudgetsApi *apiInstance = [[BudgetsApi alloc] init];
UUID *accountExternalId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // The account to retrieve data for (default to null)

// List budgets
[apiInstance getBudgetsWith:accountExternalId
              completionHandler: ^(AccountBudgets output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var TaelApi = require('tael_api');
var defaultClient = TaelApi.ApiClient.instance;

// Configure Bearer access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new TaelApi.BudgetsApi()
var accountExternalId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} The account to retrieve data for

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getBudgets(accountExternalId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getBudgetsExample
    {
        public void main()
        {
            // Configure Bearer access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new BudgetsApi();
            var accountExternalId = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | The account to retrieve data for (default to null)

            try {
                // List budgets
                AccountBudgets result = apiInstance.getBudgets(accountExternalId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling BudgetsApi.getBudgets: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\BudgetsApi();
$accountExternalId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The account to retrieve data for

try {
    $result = $api_instance->getBudgets($accountExternalId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BudgetsApi->getBudgets: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::BudgetsApi;

# Configure Bearer access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::BudgetsApi->new();
my $accountExternalId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | The account to retrieve data for

eval {
    my $result = $api_instance->getBudgets(accountExternalId => $accountExternalId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BudgetsApi->getBudgets: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure Bearer access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.BudgetsApi()
accountExternalId = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | The account to retrieve data for (default to null)

try:
    # List budgets
    api_response = api_instance.get_budgets(accountExternalId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BudgetsApi->getBudgets: %s\n" % e)
extern crate BudgetsApi;

pub fn main() {
    let accountExternalId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID

    let mut context = BudgetsApi::Context::default();
    let result = client.getBudgets(accountExternalId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
accountExternalId*
UUID (uuid)
The account to retrieve data for
Required

Responses


Flows

getFlows

Foreseeable flows on time period


/flows/

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "https://api.tael.taelys.com/v1/flows/?accountExternalId=38400000-8cf0-11bd-b23e-10b96e4ef00d&startDate=2013-10-20&endDate=2013-10-20"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FlowsApi;

import java.io.File;
import java.util.*;

public class FlowsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure Bearer access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        FlowsApi apiInstance = new FlowsApi();
        UUID accountExternalId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The account to retrieve data for.
        date startDate = 2013-10-20; // date | Considered period start, included.
        date endDate = 2013-10-20; // date | Considered period end, included.

        try {
            FlowsData result = apiInstance.getFlows(accountExternalId, startDate, endDate);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FlowsApi#getFlows");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final UUID accountExternalId = new UUID(); // UUID | The account to retrieve data for.
final date startDate = new date(); // date | Considered period start, included.
final date endDate = new date(); // date | Considered period end, included.

try {
    final result = await api_instance.getFlows(accountExternalId, startDate, endDate);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getFlows: $e\n');
}

import org.openapitools.client.api.FlowsApi;

public class FlowsApiExample {
    public static void main(String[] args) {
        FlowsApi apiInstance = new FlowsApi();
        UUID accountExternalId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The account to retrieve data for.
        date startDate = 2013-10-20; // date | Considered period start, included.
        date endDate = 2013-10-20; // date | Considered period end, included.

        try {
            FlowsData result = apiInstance.getFlows(accountExternalId, startDate, endDate);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FlowsApi#getFlows");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
FlowsApi *apiInstance = [[FlowsApi alloc] init];
UUID *accountExternalId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // The account to retrieve data for. (default to null)
date *startDate = 2013-10-20; // Considered period start, included. (default to null)
date *endDate = 2013-10-20; // Considered period end, included. (optional) (default to null)

// Foreseeable flows on time period
[apiInstance getFlowsWith:accountExternalId
    startDate:startDate
    endDate:endDate
              completionHandler: ^(FlowsData output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var TaelApi = require('tael_api');
var defaultClient = TaelApi.ApiClient.instance;

// Configure Bearer access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new TaelApi.FlowsApi()
var accountExternalId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} The account to retrieve data for.
var startDate = 2013-10-20; // {date} Considered period start, included.
var opts = {
  'endDate': 2013-10-20 // {date} Considered period end, included.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getFlows(accountExternalId, startDate, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getFlowsExample
    {
        public void main()
        {
            // Configure Bearer access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new FlowsApi();
            var accountExternalId = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | The account to retrieve data for. (default to null)
            var startDate = 2013-10-20;  // date | Considered period start, included. (default to null)
            var endDate = 2013-10-20;  // date | Considered period end, included. (optional)  (default to null)

            try {
                // Foreseeable flows on time period
                FlowsData result = apiInstance.getFlows(accountExternalId, startDate, endDate);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FlowsApi.getFlows: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FlowsApi();
$accountExternalId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The account to retrieve data for.
$startDate = 2013-10-20; // date | Considered period start, included.
$endDate = 2013-10-20; // date | Considered period end, included.

try {
    $result = $api_instance->getFlows($accountExternalId, $startDate, $endDate);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FlowsApi->getFlows: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FlowsApi;

# Configure Bearer access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FlowsApi->new();
my $accountExternalId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | The account to retrieve data for.
my $startDate = 2013-10-20; # date | Considered period start, included.
my $endDate = 2013-10-20; # date | Considered period end, included.

eval {
    my $result = $api_instance->getFlows(accountExternalId => $accountExternalId, startDate => $startDate, endDate => $endDate);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FlowsApi->getFlows: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure Bearer access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.FlowsApi()
accountExternalId = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | The account to retrieve data for. (default to null)
startDate = 2013-10-20 # date | Considered period start, included. (default to null)
endDate = 2013-10-20 # date | Considered period end, included. (optional) (default to null)

try:
    # Foreseeable flows on time period
    api_response = api_instance.get_flows(accountExternalId, startDate, endDate=endDate)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FlowsApi->getFlows: %s\n" % e)
extern crate FlowsApi;

pub fn main() {
    let accountExternalId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID
    let startDate = 2013-10-20; // date
    let endDate = 2013-10-20; // date

    let mut context = FlowsApi::Context::default();
    let result = client.getFlows(accountExternalId, startDate, endDate, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
accountExternalId*
UUID (uuid)
The account to retrieve data for.
Required
startDate*
date (date)
Considered period start, included.
Required
endDate
date (date)
Considered period end, included.

Responses


Products

getProductsData

Products data


/products/data

Usage and SDK Samples

curl -X POST \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.tael.taelys.com/v1/products/data" \
 -d ''
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ProductsApi;

import java.io.File;
import java.util.*;

public class ProductsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure Bearer access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        ProductsApi apiInstance = new ProductsApi();
        ApiV1ProductsDataRequest apiV1ProductsDataRequest = ; // ApiV1ProductsDataRequest | 

        try {
            ProductsDataResponse result = apiInstance.getProductsData(apiV1ProductsDataRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProductsApi#getProductsData");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final ApiV1ProductsDataRequest apiV1ProductsDataRequest = new ApiV1ProductsDataRequest(); // ApiV1ProductsDataRequest | 

try {
    final result = await api_instance.getProductsData(apiV1ProductsDataRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getProductsData: $e\n');
}

import org.openapitools.client.api.ProductsApi;

public class ProductsApiExample {
    public static void main(String[] args) {
        ProductsApi apiInstance = new ProductsApi();
        ApiV1ProductsDataRequest apiV1ProductsDataRequest = ; // ApiV1ProductsDataRequest | 

        try {
            ProductsDataResponse result = apiInstance.getProductsData(apiV1ProductsDataRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProductsApi#getProductsData");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
ProductsApi *apiInstance = [[ProductsApi alloc] init];
ApiV1ProductsDataRequest *apiV1ProductsDataRequest = ; //  (optional)

// Products data
[apiInstance getProductsDataWith:apiV1ProductsDataRequest
              completionHandler: ^(ProductsDataResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var TaelApi = require('tael_api');
var defaultClient = TaelApi.ApiClient.instance;

// Configure Bearer access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new TaelApi.ProductsApi()
var opts = {
  'apiV1ProductsDataRequest':  // {ApiV1ProductsDataRequest} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getProductsData(opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getProductsDataExample
    {
        public void main()
        {
            // Configure Bearer access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ProductsApi();
            var apiV1ProductsDataRequest = new ApiV1ProductsDataRequest(); // ApiV1ProductsDataRequest |  (optional) 

            try {
                // Products data
                ProductsDataResponse result = apiInstance.getProductsData(apiV1ProductsDataRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ProductsApi.getProductsData: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ProductsApi();
$apiV1ProductsDataRequest = ; // ApiV1ProductsDataRequest | 

try {
    $result = $api_instance->getProductsData($apiV1ProductsDataRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProductsApi->getProductsData: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ProductsApi;

# Configure Bearer access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ProductsApi->new();
my $apiV1ProductsDataRequest = WWW::OPenAPIClient::Object::ApiV1ProductsDataRequest->new(); # ApiV1ProductsDataRequest | 

eval {
    my $result = $api_instance->getProductsData(apiV1ProductsDataRequest => $apiV1ProductsDataRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProductsApi->getProductsData: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure Bearer access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ProductsApi()
apiV1ProductsDataRequest =  # ApiV1ProductsDataRequest |  (optional)

try:
    # Products data
    api_response = api_instance.get_products_data(apiV1ProductsDataRequest=apiV1ProductsDataRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProductsApi->getProductsData: %s\n" % e)
extern crate ProductsApi;

pub fn main() {
    let apiV1ProductsDataRequest = ; // ApiV1ProductsDataRequest

    let mut context = ProductsApi::Context::default();
    let result = client.getProductsData(apiV1ProductsDataRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Body parameters
Name Description
apiV1ProductsDataRequest

Responses


Prospective

getProspectiveData

Foreseeable debt data for prospective


/prospective-data/

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "https://api.tael.taelys.com/v1/prospective-data/?accountExternalId=38400000-8cf0-11bd-b23e-10b96e4ef00d&referenceYear=56&budgetExternalId=38400000-8cf0-11bd-b23e-10b96e4ef00d"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ProspectiveApi;

import java.io.File;
import java.util.*;

public class ProspectiveApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure Bearer access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        ProspectiveApi apiInstance = new ProspectiveApi();
        UUID accountExternalId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The account to retrieve data for.
        Integer referenceYear = 56; // Integer | The starting year. All products starting during or after this year are considered new.
        UUID budgetExternalId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The budget to retrieve data for. If not specified then all budgets are taken into account.

        try {
            AccountProspectiveData result = apiInstance.getProspectiveData(accountExternalId, referenceYear, budgetExternalId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProspectiveApi#getProspectiveData");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final UUID accountExternalId = new UUID(); // UUID | The account to retrieve data for.
final Integer referenceYear = new Integer(); // Integer | The starting year. All products starting during or after this year are considered new.
final UUID budgetExternalId = new UUID(); // UUID | The budget to retrieve data for. If not specified then all budgets are taken into account.

try {
    final result = await api_instance.getProspectiveData(accountExternalId, referenceYear, budgetExternalId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getProspectiveData: $e\n');
}

import org.openapitools.client.api.ProspectiveApi;

public class ProspectiveApiExample {
    public static void main(String[] args) {
        ProspectiveApi apiInstance = new ProspectiveApi();
        UUID accountExternalId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The account to retrieve data for.
        Integer referenceYear = 56; // Integer | The starting year. All products starting during or after this year are considered new.
        UUID budgetExternalId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The budget to retrieve data for. If not specified then all budgets are taken into account.

        try {
            AccountProspectiveData result = apiInstance.getProspectiveData(accountExternalId, referenceYear, budgetExternalId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProspectiveApi#getProspectiveData");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
ProspectiveApi *apiInstance = [[ProspectiveApi alloc] init];
UUID *accountExternalId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // The account to retrieve data for. (default to null)
Integer *referenceYear = 56; // The starting year. All products starting during or after this year are considered new. (default to null)
UUID *budgetExternalId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // The budget to retrieve data for. If not specified then all budgets are taken into account. (optional) (default to null)

// Foreseeable debt data for prospective
[apiInstance getProspectiveDataWith:accountExternalId
    referenceYear:referenceYear
    budgetExternalId:budgetExternalId
              completionHandler: ^(AccountProspectiveData output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var TaelApi = require('tael_api');
var defaultClient = TaelApi.ApiClient.instance;

// Configure Bearer access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new TaelApi.ProspectiveApi()
var accountExternalId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} The account to retrieve data for.
var referenceYear = 56; // {Integer} The starting year. All products starting during or after this year are considered new.
var opts = {
  'budgetExternalId': 38400000-8cf0-11bd-b23e-10b96e4ef00d // {UUID} The budget to retrieve data for. If not specified then all budgets are taken into account.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getProspectiveData(accountExternalId, referenceYear, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getProspectiveDataExample
    {
        public void main()
        {
            // Configure Bearer access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ProspectiveApi();
            var accountExternalId = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | The account to retrieve data for. (default to null)
            var referenceYear = 56;  // Integer | The starting year. All products starting during or after this year are considered new. (default to null)
            var budgetExternalId = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | The budget to retrieve data for. If not specified then all budgets are taken into account. (optional)  (default to null)

            try {
                // Foreseeable debt data for prospective
                AccountProspectiveData result = apiInstance.getProspectiveData(accountExternalId, referenceYear, budgetExternalId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ProspectiveApi.getProspectiveData: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ProspectiveApi();
$accountExternalId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The account to retrieve data for.
$referenceYear = 56; // Integer | The starting year. All products starting during or after this year are considered new.
$budgetExternalId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The budget to retrieve data for. If not specified then all budgets are taken into account.

try {
    $result = $api_instance->getProspectiveData($accountExternalId, $referenceYear, $budgetExternalId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProspectiveApi->getProspectiveData: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ProspectiveApi;

# Configure Bearer access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ProspectiveApi->new();
my $accountExternalId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | The account to retrieve data for.
my $referenceYear = 56; # Integer | The starting year. All products starting during or after this year are considered new.
my $budgetExternalId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | The budget to retrieve data for. If not specified then all budgets are taken into account.

eval {
    my $result = $api_instance->getProspectiveData(accountExternalId => $accountExternalId, referenceYear => $referenceYear, budgetExternalId => $budgetExternalId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProspectiveApi->getProspectiveData: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure Bearer access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ProspectiveApi()
accountExternalId = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | The account to retrieve data for. (default to null)
referenceYear = 56 # Integer | The starting year. All products starting during or after this year are considered new. (default to null)
budgetExternalId = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | The budget to retrieve data for. If not specified then all budgets are taken into account. (optional) (default to null)

try:
    # Foreseeable debt data for prospective
    api_response = api_instance.get_prospective_data(accountExternalId, referenceYear, budgetExternalId=budgetExternalId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProspectiveApi->getProspectiveData: %s\n" % e)
extern crate ProspectiveApi;

pub fn main() {
    let accountExternalId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID
    let referenceYear = 56; // Integer
    let budgetExternalId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID

    let mut context = ProspectiveApi::Context::default();
    let result = client.getProspectiveData(accountExternalId, referenceYear, budgetExternalId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
accountExternalId*
UUID (uuid)
The account to retrieve data for.
Required
referenceYear*
Integer
The starting year. All products starting during or after this year are considered new.
Required
budgetExternalId
UUID (uuid)
The budget to retrieve data for. If not specified then all budgets are taken into account.

Responses