README
¶
Hydrogen Proton API
Hydrogen Proton API
- API version: 1.9.2
- Build date: 10-11-2021
For more information, please visit https://www.hydrogenplatform.com/apis
Documentation
https://www.hydrogenplatform.com/docs/proton/v1
Installation
Put the package under your project folder and add the following in import:
import sw "proton_api"
Documentation For Authorization
oauth2
- Type: OAuth
- Flow: application
- Authorization URL:
- Scopes: N/A
import "./proton_api"
Example
package main
import (
"bytes"
"encoding/json"
"fmt"
"golang.org/x/net/context"
sw1 "proton_api"
)
const (
empty = ""
tab = "\t"
)
func PrettyJson(data interface{}) (string, error) {
buffer := new(bytes.Buffer)
encoder := json.NewEncoder(buffer)
encoder.SetIndent(empty, tab)
err := encoder.Encode(data)
if err != nil {
return empty, err
}
return buffer.String(), nil
}
func main() {
// Hello world, the web server
var authConfigService = sw1.AuthConfigurationService{};
auth := context.WithValue(context.Background(), sw1.ContextAccessToken, nil)
r1, _, _ := authConfigService.CreateClientCredential(auth, "TestUser", "eIDan^(U3vJ#BAJ2whoRBtC8CoLow)Mj",
sw1.SANDBOX)
tokenSettingAuth := context.WithValue(context.Background(), sw1.ContextAccessToken, r1.AccessToken)
tokenSettingAuth = context.WithValue(tokenSettingAuth, "BasePath", sw1.SANDBOX)
var ratioTargets1 = sw1.RatioTargets1{}
ratioTargets1.ProfitMargin = 0.1
ratioTargets1.ReturnOnAssets = 0.05
ratioTargets1.ReturnOnEquity = 0.15
ratioTargets1.DebtToEquity = 1.5
ratioTargets1.AssetTurnover = 1.0
var businessFinancialManagementService = sw1.BusinessFinancialManagementApiService{}
var businessFinancialHealthCheckRequest = sw1.BusinessFinancialHealthCheckRequest{
RatioTargets: ratioTargets1,
}
businessFinancialHealthCheckRequest.NetIncome = 10000
businessFinancialHealthCheckRequest.TotalRevenue = 50000
businessFinancialHealthCheckRequest.TotalAssets = 122141
businessFinancialHealthCheckRequest.TotalLiabilities = 132542
businessFinancialHealthCheckRequest.TotalEquity = 555
r11, _, _ := businessFinancialManagementService.BusinessFinancialHealthCheck(
tokenSettingAuth, businessFinancialHealthCheckRequest)
b11, _ := PrettyJson(r11)
fmt.Printf("%s",b11)
}
Author
Documentation
¶
Index ¶
- Constants
- Variables
- func CacheExpires(r *http.Response) time.Time
- type APIClient
- type APIKey
- type APIResponse
- type AccumulationGoalDepositConfig
- type AnnuitiesApiService
- func (a *AnnuitiesApiService) AnnuityCalculatorAccumulationHorizon(ctx context.Context, ...) (map[string]interface{}, *http.Response, error)
- func (a *AnnuitiesApiService) AnnuityCalculatorAnnuityAmount(ctx context.Context, ...) (map[string]interface{}, *http.Response, error)
- func (a *AnnuitiesApiService) AnnuityCalculatorDecumulationHorizon(ctx context.Context, ...) (map[string]interface{}, *http.Response, error)
- func (a *AnnuitiesApiService) AnnuityCalculatorDepositAmount(ctx context.Context, ...) (map[string]interface{}, *http.Response, error)
- func (a *AnnuitiesApiService) AnnuityCalculatorInitialBalance(ctx context.Context, ...) (map[string]interface{}, *http.Response, error)
- func (a *AnnuitiesApiService) VariableAnnuity(ctx context.Context, variableAnnuityRequest VariableAnnuityRequest) (map[string]interface{}, *http.Response, error)
- type AnnuityCalculatorAccumulationHorizonRequest
- type AnnuityCalculatorAnnuityAmountRequest
- type AnnuityCalculatorDecumulationHorizonRequest
- type AnnuityCalculatorDepositAmountRequest
- type AnnuityCalculatorInitialBalanceRequest
- type AnnuityDepositSchedule
- type Answer
- type Auth
- type AuthConfigurationService
- func (a *AuthConfigurationService) CreateClientCredential(ctx context.Context, clientId string, clientSecret string, ...) (Auth, *http.Response, error)
- func (a *AuthConfigurationService) CreateClientTokenCredential(ctx context.Context, clientId string, clientSecret string, client_token string, ...) (Auth, *http.Response, error)
- func (a *AuthConfigurationService) CreatePasswordCredential(ctx context.Context, clientId string, clientSecret string, username string, ...) (Auth, *http.Response, error)
- type BacktestRequest
- type BasicAuth
- type BeneficiaryBequestConfig
- type BudgetAggregationAccount
- type BudgetCalculatorRequest
- type BudgetComponent
- type BudgetDetails
- type BusinessFinancialHealthCheckRequest
- type BusinessFinancialManagementApiService
- func (a *BusinessFinancialManagementApiService) BusinessFinancialHealthCheck(ctx context.Context, ...) (map[string]interface{}, *http.Response, error)
- func (a *BusinessFinancialManagementApiService) CashAnalysis(ctx context.Context, cashAnalysisRequest CashAnalysisRequest) (map[string]interface{}, *http.Response, error)
- func (a *BusinessFinancialManagementApiService) CustomerAnalysis(ctx context.Context, customerAnalysisRequest CustomerAnalysisRequest) (map[string]interface{}, *http.Response, error)
- func (a *BusinessFinancialManagementApiService) FinancialStatementAnalysis(ctx context.Context, ...) (map[string]interface{}, *http.Response, error)
- func (a *BusinessFinancialManagementApiService) InvoiceAnalysis(ctx context.Context, invoiceAnalysisRequest BusinessInvoiceAnalysisRequest) (map[string]interface{}, *http.Response, error)
- type BusinessInvoiceAnalysisRequest
- type CalculatorDepositSchedule
- type CalculatorDepositSchedule1
- type CardAnalysisRequest
- type CardLimitCheckRequest
- type CardTransactionAuthorizationRequest
- type CardsApiService
- func (a *CardsApiService) CardAnalysis(ctx context.Context, cardAnalysisRequest CardAnalysisRequest) (map[string]interface{}, *http.Response, error)
- func (a *CardsApiService) CardLimitCheck(ctx context.Context, cardLimitCheckRequest CardLimitCheckRequest) (map[string]interface{}, *http.Response, error)
- func (a *CardsApiService) CardTransactionAuthorization(ctx context.Context, ...) (map[string]interface{}, *http.Response, error)
- type CashAnalysisRequest
- type CashFlowAnalysisRequest
- type ChildrenEducationConfig
- type Configuration
- type CustomerAnalysisRequest
- type DecisionTreeResultRequest
- type DecumulationGoalDepositConfig
- type DimensionalRiskScoreRequest
- type DiversificationScoreRequest
- type EducationCalculatorAnnualCostRequest
- type EducationCalculatorDepositAmountRequest
- type EducationCalculatorPercentCoveredRequest
- type EducationConfig
- type EmergencyFundCalculatorRequest
- type EventStudyRequest
- type FeeAnalysisRequest
- type FinancialHealthApiService
- func (a *FinancialHealthApiService) DiversificationScore(ctx context.Context, diversificationScoreRequest DiversificationScoreRequest) (map[string]interface{}, *http.Response, error)
- func (a *FinancialHealthApiService) EmergencyFundCalculator(ctx context.Context, ...) (map[string]interface{}, *http.Response, error)
- func (a *FinancialHealthApiService) FinancialHealthCheck(ctx context.Context, financialHealthCheckRequest FinancialHealthCheckRequest) (map[string]interface{}, *http.Response, error)
- func (a *FinancialHealthApiService) PortfolioOptimizationScore(ctx context.Context, ...) (map[string]interface{}, *http.Response, error)
- type FinancialHealthCheckRequest
- type FinancialPictureRequest
- type FinancialPlanningApiService
- func (a *FinancialPlanningApiService) EducationCalculatorAnnualCost(ctx context.Context, ...) (map[string]interface{}, *http.Response, error)
- func (a *FinancialPlanningApiService) EducationCalculatorDepositAmount(ctx context.Context, ...) (map[string]interface{}, *http.Response, error)
- func (a *FinancialPlanningApiService) EducationCalculatorPercentCovered(ctx context.Context, ...) (map[string]interface{}, *http.Response, error)
- func (a *FinancialPlanningApiService) MortgageCalculatorDownPayment(ctx context.Context, ...) (map[string]interface{}, *http.Response, error)
- func (a *FinancialPlanningApiService) MortgageCalculatorHomePrice(ctx context.Context, ...) (map[string]interface{}, *http.Response, error)
- func (a *FinancialPlanningApiService) MortgageCalculatorPeriodicPayment(ctx context.Context, ...) (map[string]interface{}, *http.Response, error)
- func (a *FinancialPlanningApiService) PurchaseCalculatorAmount(ctx context.Context, ...) (map[string]interface{}, *http.Response, error)
- func (a *FinancialPlanningApiService) PurchaseCalculatorDepositAmount(ctx context.Context, ...) (map[string]interface{}, *http.Response, error)
- func (a *FinancialPlanningApiService) PurchaseCalculatorHorizon(ctx context.Context, ...) (map[string]interface{}, *http.Response, error)
- func (a *FinancialPlanningApiService) RetirementCalculatorDepositAmount(ctx context.Context, ...) (map[string]interface{}, *http.Response, error)
- func (a *FinancialPlanningApiService) RetirementCalculatorExpenses(ctx context.Context, ...) (map[string]interface{}, *http.Response, error)
- func (a *FinancialPlanningApiService) RetirementCalculatorPercentCovered(ctx context.Context, ...) (map[string]interface{}, *http.Response, error)
- type FinancialStatementAnalysisRequest
- type GenericSwaggerError
- type GoalAccumulationAllocationRequest
- type GoalAccumulationRecommendationRequest
- type GoalAccumulationStatusRequest
- type GoalConfig
- type GoalDecumulationAllocationRequest
- type GoalDecumulationRecommendationRequest
- type GoalDecumulationStatusRequest
- type GoalWithdrawalConfig
- type GoalsApiService
- func (a *GoalsApiService) GoalAccumulationAllocation(ctx context.Context, ...) (map[string]interface{}, *http.Response, error)
- func (a *GoalsApiService) GoalAccumulationRecommendation(ctx context.Context, ...) (map[string]interface{}, *http.Response, error)
- func (a *GoalsApiService) GoalAccumulationStatus(ctx context.Context, ...) (map[string]interface{}, *http.Response, error)
- func (a *GoalsApiService) GoalDecumulationAllocation(ctx context.Context, ...) (map[string]interface{}, *http.Response, error)
- func (a *GoalsApiService) GoalDecumulationRecommendation(ctx context.Context, ...) (map[string]interface{}, *http.Response, error)
- func (a *GoalsApiService) GoalDecumulationStatus(ctx context.Context, ...) (map[string]interface{}, *http.Response, error)
- type GuaranteedRateBenefit
- type IncomeConfig
- type LifeInsuranceApiService
- type LifeInsuranceNeedsCalculatorRequest
- type Location
- type MonteCarloRequest
- type MortgageCalculatorDownPaymentRequest
- type MortgageCalculatorHomePriceRequest
- type MortgageCalculatorPeriodicPaymentRequest
- type MvoRequest
- type OptConfig
- type OptConfig1
- type OrderRebalanceRequest
- type PerformanceCalculatorRequest
- type Periods
- type PersonalFinancialManagementApiService
- func (a *PersonalFinancialManagementApiService) BudgetCalculator(ctx context.Context, budgetCalculatorRequest BudgetCalculatorRequest) (map[string]interface{}, *http.Response, error)
- func (a *PersonalFinancialManagementApiService) CashFlowAnalysis(ctx context.Context, cashFlowAnalysisRequest CashFlowAnalysisRequest) (map[string]interface{}, *http.Response, error)
- func (a *PersonalFinancialManagementApiService) FeeAnalysis(ctx context.Context, feeAnalysisRequest FeeAnalysisRequest) (map[string]interface{}, *http.Response, error)
- func (a *PersonalFinancialManagementApiService) FinancialPicture(ctx context.Context, financialPictureRequest FinancialPictureRequest) (map[string]interface{}, *http.Response, error)
- func (a *PersonalFinancialManagementApiService) RecurringTransactionAnalysis(ctx context.Context, ...) (map[string]interface{}, *http.Response, error)
- func (a *PersonalFinancialManagementApiService) SpendingAnalysis(ctx context.Context, spendingAnalysisRequest SpendingAnalysisRequest) (map[string]interface{}, *http.Response, error)
- type PortfolioConstructionApiService
- type PortfolioManagementApiService
- type PortfolioOptimizationScoreRequest
- type PortfolioWhatIfRequest
- type PurchaseCalculatorAmountRequest
- type PurchaseCalculatorDepositAmountRequest
- type PurchaseCalculatorHorizonRequest
- type RatioTargets
- type RatioTargets1
- type RebalancingSignalRequest
- type RecommendationConfig
- type RecommendationConfig1
- type RecurringTransactionAnalysisRequest
- type RetirementCalculatorDepositAmountRequest
- type RetirementCalculatorExpensesRequest
- type RetirementCalculatorPercentCoveredRequest
- type RiskAllocationRequest
- type RiskScoreRequest
- type RiskScoringApiService
- func (a *RiskScoringApiService) DimensionalRiskScore(ctx context.Context, dimensionalRiskScoreRequest DimensionalRiskScoreRequest) (map[string]interface{}, *http.Response, error)
- func (a *RiskScoringApiService) RiskAllocation(ctx context.Context, riskAllocationRequest RiskAllocationRequest) (map[string]interface{}, *http.Response, error)
- func (a *RiskScoringApiService) RiskScore(ctx context.Context, riskScoreRequest RiskScoreRequest) (map[string]interface{}, *http.Response, error)
- type SavingsCalculatorRequest
- type SavingsDepositSchedule
- type ScenarioAnalysisRequest
- type SensitivityAnalysisRequest
- type SensitivityFactor
- type Settings
- type SimulationsApiService
- func (a *SimulationsApiService) Backtest(ctx context.Context, backtestRequest BacktestRequest) (map[string]interface{}, *http.Response, error)
- func (a *SimulationsApiService) EventStudy(ctx context.Context, eventStudyRequest EventStudyRequest) (map[string]interface{}, *http.Response, error)
- func (a *SimulationsApiService) MonteCarlo(ctx context.Context, monteCarloRequest MonteCarloRequest) (map[string]interface{}, *http.Response, error)
- func (a *SimulationsApiService) PortfolioWhatIf(ctx context.Context, portfolioWhatIfRequest PortfolioWhatIfRequest) (map[string]interface{}, *http.Response, error)
- func (a *SimulationsApiService) SavingsCalculator(ctx context.Context, savingsCalculatorRequest SavingsCalculatorRequest) (map[string]interface{}, *http.Response, error)
- func (a *SimulationsApiService) ScenarioAnalysis(ctx context.Context, scnearioAnalysisRequest ScenarioAnalysisRequest) (map[string]interface{}, *http.Response, error)
- func (a *SimulationsApiService) SensitivityAnalysis(ctx context.Context, sensitivityAnalysisRequest SensitivityAnalysisRequest) (map[string]interface{}, *http.Response, error)
- type SpendingAnalysisRequest
- type UtilApiService
- func (a *UtilApiService) DecisionTreeResult(ctx context.Context, decisionTreeResultRequest DecisionTreeResultRequest) (map[string]interface{}, *http.Response, error)
- func (a *UtilApiService) OrderRebalance(ctx context.Context, orderRebalanceRequest OrderRebalanceRequest) (map[string]interface{}, *http.Response, error)
- func (a *UtilApiService) PerformanceCalculator(ctx context.Context, performanceCalculatorRequest PerformanceCalculatorRequest) (map[string]interface{}, *http.Response, error)
- type VariableAnnuityRequest
- type WConfig
- type WConfig1
Constants ¶
View Source
const ( BEARER = "Bearer " AUTHORIZATION = "Authorization" GRANT_TYPE_KEY = "grant_type" CLIENT_CREDENTIAL = "client_credentials" PASSWORD = "password" USERNAME = "username" MESSAGE = "message" ACCESS_TOKEN = "access_token" CLIENT_TOKEN = "Client-Token" CLIENT_ACCESS_TOKEN_URI = "/authorization/v1/client-token" AUTH_URI = "/authorization/v1/oauth/token" )
View Source
const ( SANDBOX = "https://sandbox.hydrogenplatform.com/proton/v1" PRODUCTION = "https://api.hydrogenplatform.com/proton/v1" )
Variables ¶
View Source
var ( // ContextOAuth2 takes a oauth2.TokenSource as authentication for the request. ContextOAuth2 = contextKey("token") // ContextBasicAuth takes BasicAuth as authentication for the request. ContextBasicAuth = contextKey("basic") // ContextAccessToken takes a string oauth2 access token as authentication for the request. ContextAccessToken = contextKey("accesstoken") // ContextAPIKey takes an APIKey as authentication for the request ContextAPIKey = contextKey("apikey") )
Functions ¶
Types ¶
type APIClient ¶
type APIClient struct {
// API Services
AuthConfiguration *AuthConfigurationService
AnnuitiesApi *AnnuitiesApiService
BusinessFinancialManagementApi *BusinessFinancialManagementApiService
CardsApi *CardsApiService
FinancialHealthApi *FinancialHealthApiService
FinancialPlanningApi *FinancialPlanningApiService
GoalsApi *GoalsApiService
LifeInsuranceApi *LifeInsuranceApiService
PersonalFinancialManagementApi *PersonalFinancialManagementApiService
PortfolioConstructionApi *PortfolioConstructionApiService
PortfolioManagementApi *PortfolioManagementApiService
RiskScoringApi *RiskScoringApiService
SimulationsApi *SimulationsApiService
UtilApi *UtilApiService
// contains filtered or unexported fields
}
APIClient manages communication with the Hydrogen Proton API API v1.9.2 In most cases there should be only one, shared, APIClient.
func NewAPIClient ¶
func NewAPIClient(cfg *Configuration) *APIClient
NewAPIClient creates a new API client. Requires a userAgent string describing your application. optionally a custom http.Client to allow for advanced features such as caching.
func (*APIClient) ChangeBasePath ¶
Change base path to allow switching to mocks
type APIKey ¶
APIKey provides API key based authentication to a request passed via context using ContextAPIKey
type APIResponse ¶
type APIResponse struct {
*http.Response `json:"-"`
Message string `json:"message,omitempty"`
// Operation is the name of the swagger operation.
Operation string `json:"operation,omitempty"`
// RequestURL is the request URL. This value is always available, even if the
// embedded *http.Response is nil.
RequestURL string `json:"url,omitempty"`
// Method is the HTTP method used for the request. This value is always
// available, even if the embedded *http.Response is nil.
Method string `json:"method,omitempty"`
// Payload holds the contents of the response body (which may be nil or empty).
// This is provided here as the raw response.Body() reader will have already
// been drained.
Payload []byte `json:"-"`
}
func NewAPIResponse ¶
func NewAPIResponse(r *http.Response) *APIResponse
func NewAPIResponseWithError ¶
func NewAPIResponseWithError(errorMessage string) *APIResponse
type AccumulationGoalDepositConfig ¶
type AccumulationGoalDepositConfig struct {
DepEndPeriod int32 `json:"dep_end_period,omitempty"`
DepAmount float32 `json:"dep_amount,omitempty"`
DepEndReference string `json:"dep_end_reference,omitempty"`
DepStartPeriod int32 `json:"dep_start_period,omitempty"`
DepFrequency string `json:"dep_frequency,omitempty"`
DepInflation float32 `json:"dep_inflation,omitempty"`
DepStartReference string `json:"dep_start_reference,omitempty"`
}
type AnnuitiesApiService ¶
type AnnuitiesApiService service
func (*AnnuitiesApiService) AnnuityCalculatorAccumulationHorizon ¶
func (a *AnnuitiesApiService) AnnuityCalculatorAccumulationHorizon(ctx context.Context, annuityCalculatorAccumulationHorizonRequest AnnuityCalculatorAccumulationHorizonRequest) (map[string]interface{}, *http.Response, error)
AnnuitiesApiService Annuity Calculator - Accumulation Horizon Calculate the necessary fixed annuity contribution period
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param annuityCalculatorAccumulationHorizonRequest Request payload for Annuity Calculator - Accumulation Horizon
@return map[string]interface{}
func (*AnnuitiesApiService) AnnuityCalculatorAnnuityAmount ¶
func (a *AnnuitiesApiService) AnnuityCalculatorAnnuityAmount(ctx context.Context, annuityCalculatorAnnuityAmountRequest AnnuityCalculatorAnnuityAmountRequest) (map[string]interface{}, *http.Response, error)
AnnuitiesApiService Annuity Calculator - Annuity Amount Calculate the achievable fixed annuity amount
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param annuityCalculatorAnnuityAmountRequest Request payload for Annuity Calculator - Annuity Amount
@return map[string]interface{}
func (*AnnuitiesApiService) AnnuityCalculatorDecumulationHorizon ¶
func (a *AnnuitiesApiService) AnnuityCalculatorDecumulationHorizon(ctx context.Context, annuityCalculatorDecumulationHorizonRequest AnnuityCalculatorDecumulationHorizonRequest) (map[string]interface{}, *http.Response, error)
AnnuitiesApiService Annuity Calculator - Decumulation Horizon Calculate the achievable fixed annuity payout period
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param annuityCalculatorDecumulationHorizonRequest Request payload for Annuity Calculator - Decumulation Horizon
@return map[string]interface{}
func (*AnnuitiesApiService) AnnuityCalculatorDepositAmount ¶
func (a *AnnuitiesApiService) AnnuityCalculatorDepositAmount(ctx context.Context, annuityCalculatorDepositAmountRequest AnnuityCalculatorDepositAmountRequest) (map[string]interface{}, *http.Response, error)
AnnuitiesApiService Annuity Calculator - Deposit Amount Calculate the necessary periodic deposit amount for a fixed annuity
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param annuityCalculatorDepositAmountRequest Request payload for Annuity Calculator - Deposit Amount
@return map[string]interface{}
func (*AnnuitiesApiService) AnnuityCalculatorInitialBalance ¶
func (a *AnnuitiesApiService) AnnuityCalculatorInitialBalance(ctx context.Context, annuityCalculatorInitialBalanceRequest AnnuityCalculatorInitialBalanceRequest) (map[string]interface{}, *http.Response, error)
AnnuitiesApiService Annuity Calculator - Initial Balance Calculate the necessary initial balance for a fixed annuity
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param annuityCalculatorInitialBalanceRequest Request payload for Annuity Calculator - Initial Balance
@return map[string]interface{}
func (*AnnuitiesApiService) VariableAnnuity ¶
func (a *AnnuitiesApiService) VariableAnnuity(ctx context.Context, variableAnnuityRequest VariableAnnuityRequest) (map[string]interface{}, *http.Response, error)
AnnuitiesApiService Variable Annuity Project the behavior of a variable annuity over time
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param variableAnnuityRequest Request payload for Variable Annuity
@return map[string]interface{}
type AnnuityCalculatorAccumulationHorizonRequest ¶
type AnnuityCalculatorAccumulationHorizonRequest struct {
InflationRate float32 `json:"inflation_rate,omitempty"`
DecumulationHorizon int32 `json:"decumulation_horizon"`
AccountIds []string `json:"account_ids,omitempty"`
TaxRate float32 `json:"tax_rate,omitempty"`
AccumulationHorizon int32 `json:"accumulation_horizon,omitempty"`
AnnuityAmount float32 `json:"annuity_amount"`
PortfolioReturn float32 `json:"portfolio_return"`
DepositSchedule *AnnuityDepositSchedule `json:"deposit_schedule,omitempty"`
AnnuityFrequencyInterval string `json:"annuity_frequency_interval,omitempty"`
InitialBalance float32 `json:"initial_balance,omitempty"`
AggregationAccountIds []string `json:"aggregation_account_ids,omitempty"`
CreateLog bool `json:"create_log,omitempty"`
}
type AnnuityCalculatorAnnuityAmountRequest ¶
type AnnuityCalculatorAnnuityAmountRequest struct {
InflationRate float32 `json:"inflation_rate,omitempty"`
DecumulationHorizon int32 `json:"decumulation_horizon"`
AccountIds []string `json:"account_ids,omitempty"`
TaxRate float32 `json:"tax_rate,omitempty"`
AccumulationHorizon int32 `json:"accumulation_horizon"`
AnnuityAmount float32 `json:"annuity_amount,omitempty"`
PortfolioReturn float32 `json:"portfolio_return"`
DepositSchedule *AnnuityDepositSchedule `json:"deposit_schedule,omitempty"`
AnnuityFrequencyInterval string `json:"annuity_frequency_interval,omitempty"`
InitialBalance float32 `json:"initial_balance,omitempty"`
AggregationAccountIds []string `json:"aggregation_account_ids,omitempty"`
CreateLog bool `json:"create_log,omitempty"`
}
type AnnuityCalculatorDecumulationHorizonRequest ¶
type AnnuityCalculatorDecumulationHorizonRequest struct {
InflationRate float32 `json:"inflation_rate,omitempty"`
DecumulationHorizon int32 `json:"decumulation_horizon,omitempty"`
AccountIds []string `json:"account_ids,omitempty"`
TaxRate float32 `json:"tax_rate,omitempty"`
AccumulationHorizon int32 `json:"accumulation_horizon"`
AnnuityAmount float32 `json:"annuity_amount"`
PortfolioReturn float32 `json:"portfolio_return"`
DepositSchedule *AnnuityDepositSchedule `json:"deposit_schedule,omitempty"`
AnnuityFrequencyInterval string `json:"annuity_frequency_interval,omitempty"`
InitialBalance float32 `json:"initial_balance,omitempty"`
AggregationAccountIds []string `json:"aggregation_account_ids,omitempty"`
CreateLog bool `json:"create_log,omitempty"`
}
type AnnuityCalculatorDepositAmountRequest ¶
type AnnuityCalculatorDepositAmountRequest struct {
InflationRate float32 `json:"inflation_rate,omitempty"`
DecumulationHorizon int32 `json:"decumulation_horizon"`
AccountIds []string `json:"account_ids,omitempty"`
TaxRate float32 `json:"tax_rate,omitempty"`
AccumulationHorizon int32 `json:"accumulation_horizon"`
AnnuityAmount float32 `json:"annuity_amount"`
PortfolioReturn float32 `json:"portfolio_return"`
DepositSchedule AnnuityDepositSchedule `json:"deposit_schedule,omitempty"`
AnnuityFrequencyInterval string `json:"annuity_frequency_interval,omitempty"`
InitialBalance float32 `json:"initial_balance,omitempty"`
AggregationAccountIds []string `json:"aggregation_account_ids,omitempty"`
CreateLog bool `json:"create_log,omitempty"`
}
type AnnuityCalculatorInitialBalanceRequest ¶
type AnnuityCalculatorInitialBalanceRequest struct {
InflationRate float32 `json:"inflation_rate,omitempty"`
DecumulationHorizon int32 `json:"decumulation_horizon"`
AccountIds []string `json:"account_ids,omitempty"`
TaxRate float32 `json:"tax_rate,omitempty"`
AccumulationHorizon int32 `json:"accumulation_horizon"`
AnnuityAmount float32 `json:"annuity_amount"`
PortfolioReturn float32 `json:"portfolio_return"`
DepositSchedule AnnuityDepositSchedule `json:"deposit_schedule,omitempty"`
AnnuityFrequencyInterval string `json:"annuity_frequency_interval,omitempty"`
InitialBalance float32 `json:"initial_balance,omitempty"`
AggregationAccountIds []string `json:"aggregation_account_ids,omitempty"`
CreateLog bool `json:"create_log,omitempty"`
}
type AnnuityDepositSchedule ¶
type AuthConfigurationService ¶
type AuthConfigurationService service
func (*AuthConfigurationService) CreateClientCredential ¶
func (*AuthConfigurationService) CreateClientTokenCredential ¶
type BacktestRequest ¶
type BacktestRequest struct {
EndDate string `json:"end_date"`
Trades bool `json:"trades,omitempty"`
ModelId string `json:"model_id,omitempty"`
StartDate string `json:"start_date"`
Stats bool `json:"stats,omitempty"`
InitialWeights interface{} `json:"initial_weights,omitempty"`
Settings Settings `json:"settings,omitempty"`
AssetSize float32 `json:"asset_size,omitempty"`
AssetSizes bool `json:"asset_sizes,omitempty"`
Holdings bool `json:"holdings,omitempty"`
}
type BasicAuth ¶
type BasicAuth struct {
UserName string `json:"userName,omitempty"`
Password string `json:"password,omitempty"`
}
BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth
type BudgetAggregationAccount ¶
type BudgetAggregationAccount struct {
AggregationAccountId string `json:"aggregation_account_id"`
}
type BudgetCalculatorRequest ¶
type BudgetCalculatorRequest struct {
Scope string `json:"scope,omitempty"`
CurrencyConversion string `json:"currency_conversion,omitempty"`
RelativeLookback bool `json:"relative_lookback,omitempty"`
BudgetId string `json:"budget_id,omitempty"`
AsOfDate string `json:"as_of_date,omitempty"`
ShowAverageSpend bool `json:"show_average_spend,omitempty"`
LookbackPeriods int32 `json:"lookback_periods,omitempty"`
BudgetDetails BudgetDetails `json:"budget_details,omitempty"`
TransactionStatusScope []string `json:"transaction_status_scope,omitempty"`
OnlyCleansed bool `json:"only_cleansed,omitempty"`
ShowBudgetTrack bool `json:"show_budget_track,omitempty"`
}
type BudgetComponent ¶
type BudgetDetails ¶
type BudgetDetails struct {
CurrencyCode string `json:"currency_code,omitempty"`
ClientId string `json:"client_id,omitempty"`
Frequency int32 `json:"frequency,omitempty"`
EndDate string `json:"end_date,omitempty"`
TotalValue float32 `json:"total_value,omitempty"`
Budget []BudgetComponent `json:"budget,omitempty"`
AccountId string `json:"account_id,omitempty"`
StartDate string `json:"start_date,omitempty"`
AggregationAccounts []BudgetAggregationAccount `json:"aggregation_accounts,omitempty"`
FrequencyUnit string `json:"frequency_unit"`
}
type BusinessFinancialHealthCheckRequest ¶
type BusinessFinancialHealthCheckRequest struct {
CurrencyCode string `json:"currency_code,omitempty"`
ClientId string `json:"client_id,omitempty"`
RatioTargets RatioTargets1 `json:"ratio_targets,omitempty"`
AccountingMethod string `json:"accounting_method,omitempty"`
TotalLiabilities float32 `json:"total_liabilities,omitempty"`
TotalAssets float32 `json:"total_assets,omitempty"`
CurrencyConversion string `json:"currency_conversion,omitempty"`
PeriodQuarter int32 `json:"period_quarter,omitempty"`
PeriodMonth int32 `json:"period_month,omitempty"`
TotalEquity float32 `json:"total_equity,omitempty"`
BusinessId string `json:"business_id,omitempty"`
PeriodYear int32 `json:"period_year,omitempty"`
TotalRevenue float32 `json:"total_revenue,omitempty"`
PeriodLength string `json:"period_length,omitempty"`
NetIncome float32 `json:"net_income,omitempty"`
PeriodType string `json:"period_type,omitempty"`
}
type BusinessFinancialManagementApiService ¶
type BusinessFinancialManagementApiService service
func (*BusinessFinancialManagementApiService) BusinessFinancialHealthCheck ¶
func (a *BusinessFinancialManagementApiService) BusinessFinancialHealthCheck(ctx context.Context, businessFinancialHealthCheckRequest BusinessFinancialHealthCheckRequest) (map[string]interface{}, *http.Response, error)
BusinessFinancialManagementApiService Business Financial Health Check Calculate a series of financial ratios to assess business financial health
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param businessFinancialHealthCheckRequest Request payload for Business Financial Health Check
@return map[string]interface{}
func (*BusinessFinancialManagementApiService) CashAnalysis ¶
func (a *BusinessFinancialManagementApiService) CashAnalysis(ctx context.Context, cashAnalysisRequest CashAnalysisRequest) (map[string]interface{}, *http.Response, error)
BusinessFinancialManagementApiService Cash Analysis Analyze cash activity over time
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param cashAnalysisRequest Request payload for Cash Analysis
@return map[string]interface{}
func (*BusinessFinancialManagementApiService) CustomerAnalysis ¶
func (a *BusinessFinancialManagementApiService) CustomerAnalysis(ctx context.Context, customerAnalysisRequest CustomerAnalysisRequest) (map[string]interface{}, *http.Response, error)
BusinessFinancialManagementApiService Customer Analysis Analyze customer revenues over a time period
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param customerAnalysisRequest Request payload for Customer Analysis
@return map[string]interface{}
func (*BusinessFinancialManagementApiService) FinancialStatementAnalysis ¶
func (a *BusinessFinancialManagementApiService) FinancialStatementAnalysis(ctx context.Context, financialStatementAnalysisRequest FinancialStatementAnalysisRequest) (map[string]interface{}, *http.Response, error)
BusinessFinancialManagementApiService Financial Statement Analysis Analyze financial statement accounting data for a business
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param financialStatementAnalysisRequest Request payload for Financial Statement Analysis
@return map[string]interface{}
func (*BusinessFinancialManagementApiService) InvoiceAnalysis ¶
func (a *BusinessFinancialManagementApiService) InvoiceAnalysis(ctx context.Context, invoiceAnalysisRequest BusinessInvoiceAnalysisRequest) (map[string]interface{}, *http.Response, error)
BusinessFinancialManagementApiService Invoice Analysis Analyze invoices to understand the context of money owed and paid to a business
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param invoiceAnalysisRequest Request payload for Invoice Analysis
@return map[string]interface{}
type BusinessInvoiceAnalysisRequest ¶
type BusinessInvoiceAnalysisRequest struct {
CurrencyCode string `json:"currency_code,omitempty"`
ClientId string `json:"client_id,omitempty"`
ShowHistory bool `json:"show_history,omitempty"`
ShowOutstandingInvoices bool `json:"show_outstanding_invoices,omitempty"`
ResponseLimit int32 `json:"response_limit,omitempty"`
EndDate string `json:"end_date,omitempty"`
HistoryFrequencyInterval string `json:"history_frequency_interval,omitempty"`
CurrencyConversion string `json:"currency_conversion,omitempty"`
StartDate string `json:"start_date,omitempty"`
FutureDuePeriods []Periods `json:"future_due_periods,omitempty"`
OverduePeriods []Periods `json:"overdue_periods,omitempty"`
BusinessId string `json:"business_id,omitempty"`
InvoiceIds []string `json:"invoice_ids,omitempty"`
CustomerId string `json:"customer_id,omitempty"`
}
type CardAnalysisRequest ¶
type CardAnalysisRequest struct {
CurrencyCode string `json:"currency_code,omitempty"`
ClientId string `json:"client_id,omitempty"`
ShowHistory bool `json:"show_history,omitempty"`
ResponseLimit int32 `json:"response_limit,omitempty"`
CurrencyConversion string `json:"currency_conversion,omitempty"`
EndDate string `json:"end_date,omitempty"`
HistoryFrequencyInterval string `json:"history_frequency_interval,omitempty"`
ShowTopCards bool `json:"show_top_cards,omitempty"`
StartDate string `json:"start_date,omitempty"`
BusinessId string `json:"business_id,omitempty"`
TransactionStatusScope []string `json:"transaction_status_scope,omitempty"`
CardStatusScope []string `json:"card_status_scope,omitempty"`
ShowTopCardholders bool `json:"show_top_cardholders,omitempty"`
CardProgramId string `json:"card_program_id,omitempty"`
ShowTopBusinesses bool `json:"show_top_businesses,omitempty"`
}
type CardLimitCheckRequest ¶
type CardTransactionAuthorizationRequest ¶
type CardTransactionAuthorizationRequest struct {
CurrencyCode string `json:"currency_code"`
Memo string `json:"memo,omitempty"`
PartialAuth bool `json:"partial_auth,omitempty"`
TransactionType string `json:"transaction_type"`
Description string `json:"description,omitempty"`
TransactionCategoryId string `json:"transaction_category_id,omitempty"`
UseAuditLog bool `json:"use_audit_log,omitempty"`
MerchantCategoryCode string `json:"merchant_category_code,omitempty"`
CardId string `json:"card_id"`
TransactionCategory string `json:"transaction_category,omitempty"`
CleanseData bool `json:"cleanse_data,omitempty"`
AuthType []string `json:"auth_type,omitempty"`
Mid string `json:"mid,omitempty"`
TransactionStatusScope []string `json:"transaction_status_scope,omitempty"`
Location Location `json:"location,omitempty"`
Merchant string `json:"merchant,omitempty"`
Amount float32 `json:"amount"`
Date string `json:"date"`
MerchantId string `json:"merchant_id,omitempty"`
}
type CardsApiService ¶
type CardsApiService service
func (*CardsApiService) CardAnalysis ¶
func (a *CardsApiService) CardAnalysis(ctx context.Context, cardAnalysisRequest CardAnalysisRequest) (map[string]interface{}, *http.Response, error)
CardsApiService Card Analysis Analyze cardholder activity over time
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param cardAnalysisRequest Request payload for Card Analysis
@return map[string]interface{}
func (*CardsApiService) CardLimitCheck ¶
func (a *CardsApiService) CardLimitCheck(ctx context.Context, cardLimitCheckRequest CardLimitCheckRequest) (map[string]interface{}, *http.Response, error)
CardsApiService Card Limit Check Evaluate card transaction history against spending controls
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param cardLimitCheckRequest Request payload for Card Limit Check
@return map[string]interface{}
func (*CardsApiService) CardTransactionAuthorization ¶
func (a *CardsApiService) CardTransactionAuthorization(ctx context.Context, cardTransactionAuthorizationRequest CardTransactionAuthorizationRequest) (map[string]interface{}, *http.Response, error)
CardsApiService Card Transaction Authorization Approve or reject a card transaction based on applicable conditions
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param cardTransactionAuthorizationRequest Request payload for Card Transaction Authorization
@return map[string]interface{}
type CashAnalysisRequest ¶
type CashAnalysisRequest struct {
CurrencyCode string `json:"currency_code,omitempty"`
ClientId string `json:"client_id,omitempty"`
ShowHistory bool `json:"show_history,omitempty"`
Scope string `json:"scope,omitempty"`
EndDate string `json:"end_date,omitempty"`
HistoryFrequencyInterval string `json:"history_frequency_interval,omitempty"`
ShowInflowDetails bool `json:"show_inflow_details,omitempty"`
CurrencyConversion string `json:"currency_conversion,omitempty"`
StartDate string `json:"start_date,omitempty"`
TransactionStatusScope []string `json:"transaction_status_scope,omitempty"`
ShowOutflowDetails bool `json:"show_outflow_details,omitempty"`
OnlyCleansed bool `json:"only_cleansed,omitempty"`
}
type CashFlowAnalysisRequest ¶
type CashFlowAnalysisRequest struct {
CurrencyCode string `json:"currency_code,omitempty"`
ClientId string `json:"client_id,omitempty"`
ShowHistory bool `json:"show_history,omitempty"`
BenchmarkStartDate string `json:"benchmark_start_date,omitempty"`
Scope string `json:"scope,omitempty"`
EndDate string `json:"end_date,omitempty"`
AccountIds []string `json:"account_ids,omitempty"`
BenchmarkEndDate string `json:"benchmark_end_date,omitempty"`
CurrencyConversion string `json:"currency_conversion,omitempty"`
StartDate string `json:"start_date,omitempty"`
TransactionStatusScope []string `json:"transaction_status_scope,omitempty"`
ShowIncomeDetails bool `json:"show_income_details,omitempty"`
OnlyCleansed bool `json:"only_cleansed,omitempty"`
HouseholdId string `json:"household_id,omitempty"`
ShowSpendingDetails bool `json:"show_spending_details,omitempty"`
AggregationAccountIds []string `json:"aggregation_account_ids,omitempty"`
}
type ChildrenEducationConfig ¶
type ChildrenEducationConfig struct {
EducationConfig []EducationConfig `json:"education_config"`
CurrentAge int32 `json:"current_age"`
}
type Configuration ¶
type Configuration struct {
BasePath string `json:"basePath,omitempty"`
Host string `json:"host,omitempty"`
Scheme string `json:"scheme,omitempty"`
DefaultHeader map[string]string `json:"defaultHeader,omitempty"`
UserAgent string `json:"userAgent,omitempty"`
HTTPClient *http.Client
}
func NewConfiguration ¶
func NewConfiguration() *Configuration
func (*Configuration) AddDefaultHeader ¶
func (c *Configuration) AddDefaultHeader(key string, value string)
type CustomerAnalysisRequest ¶
type CustomerAnalysisRequest struct {
CurrencyCode string `json:"currency_code,omitempty"`
ClientId string `json:"client_id,omitempty"`
ResponseLimit int32 `json:"response_limit,omitempty"`
EndDate string `json:"end_date,omitempty"`
BenchmarkEndDate string `json:"benchmark_end_date,omitempty"`
CurrencyConversion string `json:"currency_conversion,omitempty"`
StartDate string `json:"start_date,omitempty"`
CustomerIds []string `json:"customer_ids,omitempty"`
BusinessId string `json:"business_id,omitempty"`
BenchmarkStartDate string `json:"benchmark_start_date,omitempty"`
OnlyActiveCustomers bool `json:"only_active_customers,omitempty"`
}
type DecumulationGoalDepositConfig ¶
type DecumulationGoalDepositConfig struct {
DepEndPeriod int32 `json:"dep_end_period,omitempty"`
DepAmount float32 `json:"dep_amount,omitempty"`
DepEndReference string `json:"dep_end_reference,omitempty"`
DepStartPeriod int32 `json:"dep_start_period,omitempty"`
DepFrequency string `json:"dep_frequency,omitempty"`
DepInflation float32 `json:"dep_inflation,omitempty"`
DepStartReference string `json:"dep_start_reference,omitempty"`
}
type DimensionalRiskScoreRequest ¶
type DimensionalRiskScoreRequest struct {
QuestionnaireId string `json:"questionnaire_id,omitempty"`
ClientId string `json:"client_id,omitempty"`
PostScore bool `json:"post_score,omitempty"`
Dims []string `json:"dims"`
AnswerWeights []float32 `json:"answer_weights,omitempty"`
MaxAnswers []float32 `json:"max_answers"`
DimWeights []float32 `json:"dim_weights,omitempty"`
Answers []float32 `json:"answers,omitempty"`
AnswerDims [][]string `json:"answer_dims"`
}
type DiversificationScoreRequest ¶
type DiversificationScoreRequest struct {
AllocationId string `json:"allocation_id,omitempty"`
EndDate string `json:"end_date,omitempty"`
MarketDataSource string `json:"market_data_source,omitempty"`
ModelId string `json:"model_id,omitempty"`
AccountId string `json:"account_id,omitempty"`
StartDate string `json:"start_date,omitempty"`
UseProxyData bool `json:"use_proxy_data,omitempty"`
PortfolioWeights []float32 `json:"portfolio_weights,omitempty"`
PortfolioTickers []string `json:"portfolio_tickers,omitempty"`
CreateLog bool `json:"create_log,omitempty"`
AggregationAccountId string `json:"aggregation_account_id,omitempty"`
PortfolioId string `json:"portfolio_id,omitempty"`
}
type EducationCalculatorAnnualCostRequest ¶
type EducationCalculatorAnnualCostRequest struct {
EducationInflationRate float32 `json:"education_inflation_rate,omitempty"`
DecumulationHorizon int32 `json:"decumulation_horizon"`
AccumulationHorizon int32 `json:"accumulation_horizon"`
AccountIds []string `json:"account_ids,omitempty"`
TaxRate float32 `json:"tax_rate,omitempty"`
GeneralInflationRate float32 `json:"general_inflation_rate,omitempty"`
PortfolioReturn float32 `json:"portfolio_return"`
DepositSchedule CalculatorDepositSchedule1 `json:"deposit_schedule,omitempty"`
InitialBalance float32 `json:"initial_balance,omitempty"`
PercentOfCostsCovered float32 `json:"percent_of_costs_covered,omitempty"`
AggregationAccountIds []string `json:"aggregation_account_ids,omitempty"`
}
type EducationCalculatorDepositAmountRequest ¶
type EducationCalculatorDepositAmountRequest struct {
EducationInflationRate float32 `json:"education_inflation_rate,omitempty"`
DecumulationHorizon int32 `json:"decumulation_horizon"`
AccumulationHorizon int32 `json:"accumulation_horizon"`
AccountIds []string `json:"account_ids,omitempty"`
TaxRate float32 `json:"tax_rate,omitempty"`
GeneralInflationRate float32 `json:"general_inflation_rate,omitempty"`
TotalAnnualCost float32 `json:"total_annual_cost"`
PortfolioReturn float32 `json:"portfolio_return"`
DepositSchedule CalculatorDepositSchedule `json:"deposit_schedule,omitempty"`
InitialBalance float32 `json:"initial_balance,omitempty"`
PercentOfCostsCovered float32 `json:"percent_of_costs_covered,omitempty"`
AggregationAccountIds []string `json:"aggregation_account_ids,omitempty"`
}
type EducationCalculatorPercentCoveredRequest ¶
type EducationCalculatorPercentCoveredRequest struct {
EducationInflationRate float32 `json:"education_inflation_rate,omitempty"`
DecumulationHorizon int32 `json:"decumulation_horizon"`
AccumulationHorizon int32 `json:"accumulation_horizon"`
AccountIds []string `json:"account_ids,omitempty"`
TaxRate float32 `json:"tax_rate,omitempty"`
GeneralInflationRate float32 `json:"general_inflation_rate,omitempty"`
TotalAnnualCost float32 `json:"total_annual_cost"`
PortfolioReturn float32 `json:"portfolio_return"`
DepositSchedule CalculatorDepositSchedule1 `json:"deposit_schedule,omitempty"`
InitialBalance float32 `json:"initial_balance,omitempty"`
AggregationAccountIds []string `json:"aggregation_account_ids,omitempty"`
}
type EducationConfig ¶
type EmergencyFundCalculatorRequest ¶
type EmergencyFundCalculatorRequest struct {
ClientId string `json:"client_id,omitempty"`
SavingsHorizon []int32 `json:"savings_horizon,omitempty"`
HousingCost float32 `json:"housing_cost,omitempty"`
OtherExpenses interface{} `json:"other_expenses,omitempty"`
AccountIds []string `json:"account_ids,omitempty"`
UtilityPayments float32 `json:"utility_payments,omitempty"`
FoodCosts float32 `json:"food_costs,omitempty"`
DebtPayments float32 `json:"debt_payments,omitempty"`
LookbackPeriods int32 `json:"lookback_periods,omitempty"`
FrequencyUnit string `json:"frequency_unit,omitempty"`
CurrentEmergencyFundBalance float32 `json:"current_emergency_fund_balance,omitempty"`
InsurancePayments float32 `json:"insurance_payments,omitempty"`
TelecomPayments float32 `json:"telecom_payments,omitempty"`
TransportationCosts float32 `json:"transportation_costs,omitempty"`
InterestRate float32 `json:"interest_rate,omitempty"`
EmergencyFundDuration int32 `json:"emergency_fund_duration"`
AggregationAccountIds []string `json:"aggregation_account_ids,omitempty"`
}
type EventStudyRequest ¶
type EventStudyRequest struct {
AllocationId string `json:"allocation_id,omitempty"`
Events []string `json:"events,omitempty"`
MarketDataSource string `json:"market_data_source,omitempty"`
ModelId string `json:"model_id,omitempty"`
AccountId string `json:"account_id,omitempty"`
UseProxyData bool `json:"use_proxy_data,omitempty"`
PortfolioWeights []float32 `json:"portfolio_weights,omitempty"`
PortfolioTickers []string `json:"portfolio_tickers,omitempty"`
CreateLog bool `json:"create_log,omitempty"`
AggregationAccountId string `json:"aggregation_account_id,omitempty"`
PortfolioId string `json:"portfolio_id,omitempty"`
}
type FeeAnalysisRequest ¶
type FeeAnalysisRequest struct {
CurrencyCode string `json:"currency_code,omitempty"`
ClientId string `json:"client_id,omitempty"`
EndDate string `json:"end_date,omitempty"`
CurrencyConversion string `json:"currency_conversion,omitempty"`
StartDate string `json:"start_date,omitempty"`
TransactionStatusScope []string `json:"transaction_status_scope,omitempty"`
AggregationAccountIds []string `json:"aggregation_account_ids,omitempty"`
}
type FinancialHealthApiService ¶
type FinancialHealthApiService service
func (*FinancialHealthApiService) DiversificationScore ¶
func (a *FinancialHealthApiService) DiversificationScore(ctx context.Context, diversificationScoreRequest DiversificationScoreRequest) (map[string]interface{}, *http.Response, error)
FinancialHealthApiService Diversification Score Assess how well a group of investments is diversified
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param diversificationScoreRequest Request payload for Diversification Score
@return map[string]interface{}
func (*FinancialHealthApiService) EmergencyFundCalculator ¶
func (a *FinancialHealthApiService) EmergencyFundCalculator(ctx context.Context, emergencyFundCalculatorRequest EmergencyFundCalculatorRequest) (map[string]interface{}, *http.Response, error)
FinancialHealthApiService Emergency Fund Calculator Calculate a target emergency fund amount and savings plan
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param emergencyFundCalculatorRequest Request payload for Emergency Fund Calculator
@return map[string]interface{}
func (*FinancialHealthApiService) FinancialHealthCheck ¶
func (a *FinancialHealthApiService) FinancialHealthCheck(ctx context.Context, financialHealthCheckRequest FinancialHealthCheckRequest) (map[string]interface{}, *http.Response, error)
FinancialHealthApiService Financial Health Check Calculate a series of financial ratios to assess financial health
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param financialHealthCheckRequest Request payload for Financial Health Check
@return map[string]interface{}
func (*FinancialHealthApiService) PortfolioOptimizationScore ¶
func (a *FinancialHealthApiService) PortfolioOptimizationScore(ctx context.Context, portfolioOptimizationScoreRequest PortfolioOptimizationScoreRequest) (map[string]interface{}, *http.Response, error)
FinancialHealthApiService Portfolio Optimization Score Analyze a group of investments against the optimized result
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param portfolioOptimizationScoreRequest Request payload for Portfolio Optimization Score
@return map[string]interface{}
type FinancialHealthCheckRequest ¶
type FinancialHealthCheckRequest struct {
ClientId string `json:"client_id,omitempty"`
RatioTargets RatioTargets `json:"ratio_targets,omitempty"`
LiquidAssets float32 `json:"liquid_assets,omitempty"`
TotalLiabilities float32 `json:"total_liabilities,omitempty"`
GrossAnnualIncome float32 `json:"gross_annual_income,omitempty"`
ShortTermLiabilities float32 `json:"short_term_liabilities,omitempty"`
LookbackPeriods int32 `json:"lookback_periods,omitempty"`
NonLiquidAssets float32 `json:"non_liquid_assets,omitempty"`
MonthlyExpenses float32 `json:"monthly_expenses,omitempty"`
NetMonthlyIncome float32 `json:"net_monthly_income,omitempty"`
}
type FinancialPictureRequest ¶
type FinancialPictureRequest struct {
CurrencyCode string `json:"currency_code,omitempty"`
ClientId string `json:"client_id,omitempty"`
ShowHistory bool `json:"show_history,omitempty"`
EndDate string `json:"end_date,omitempty"`
CurrencyConversion string `json:"currency_conversion,omitempty"`
StartDate string `json:"start_date,omitempty"`
ShowCategoryBreakdown bool `json:"show_category_breakdown,omitempty"`
ShowChange bool `json:"show_change,omitempty"`
HouseholdId string `json:"household_id,omitempty"`
CreateLog bool `json:"create_log,omitempty"`
}
type FinancialPlanningApiService ¶
type FinancialPlanningApiService service
func (*FinancialPlanningApiService) EducationCalculatorAnnualCost ¶
func (a *FinancialPlanningApiService) EducationCalculatorAnnualCost(ctx context.Context, educationCalculatorAnnualCostRequest EducationCalculatorAnnualCostRequest) (map[string]interface{}, *http.Response, error)
FinancialPlanningApiService Education Calculator - Annual Cost Calculate the achievable education costs
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param educationCalculatorAnnualCostRequest Request payload for Education Calculator - Annual Cost
@return map[string]interface{}
func (*FinancialPlanningApiService) EducationCalculatorDepositAmount ¶
func (a *FinancialPlanningApiService) EducationCalculatorDepositAmount(ctx context.Context, educationCalculatorDepositAmountRequest EducationCalculatorDepositAmountRequest) (map[string]interface{}, *http.Response, error)
FinancialPlanningApiService Education Calculator - Deposit Amount Calculate the necessary periodic deposit amount to achieve education costs
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param educationCalculatorDepositAmountRequest Request payload for Education Calculator - Deposit Amount
@return map[string]interface{}
func (*FinancialPlanningApiService) EducationCalculatorPercentCovered ¶
func (a *FinancialPlanningApiService) EducationCalculatorPercentCovered(ctx context.Context, educationCalculatorPercentCoveredRequest EducationCalculatorPercentCoveredRequest) (map[string]interface{}, *http.Response, error)
FinancialPlanningApiService Education Calculator - Percent Covered Calculate the achievable percentage of education costs that can be covered
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param educationCalculatorPercentCoveredRequest Request payload for Education Calculator - Percent Covered
@return map[string]interface{}
func (*FinancialPlanningApiService) MortgageCalculatorDownPayment ¶
func (a *FinancialPlanningApiService) MortgageCalculatorDownPayment(ctx context.Context, mortgageCalculatorDownPaymentRequest MortgageCalculatorDownPaymentRequest) (map[string]interface{}, *http.Response, error)
FinancialPlanningApiService Mortgage Calculator - Down Payment Calculate the necessary down payment for the mortgage
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param mortgageCalculatorDownPaymentRequest Request payload for Mortgage Calculator - Down Payment
@return map[string]interface{}
func (*FinancialPlanningApiService) MortgageCalculatorHomePrice ¶
func (a *FinancialPlanningApiService) MortgageCalculatorHomePrice(ctx context.Context, mortgageCalculatorHomePriceRequest MortgageCalculatorHomePriceRequest) (map[string]interface{}, *http.Response, error)
FinancialPlanningApiService Mortgage Calculator - Home Price Calculate the achievable home price for the mortgage
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param mortgageCalculatorHomePriceRequest Request payload for Mortgage Calculator - Home Price
@return map[string]interface{}
func (*FinancialPlanningApiService) MortgageCalculatorPeriodicPayment ¶
func (a *FinancialPlanningApiService) MortgageCalculatorPeriodicPayment(ctx context.Context, mortgageCalculatorPeriodicPaymentRequest MortgageCalculatorPeriodicPaymentRequest) (map[string]interface{}, *http.Response, error)
FinancialPlanningApiService Mortgage Calculator - Periodic Payment Calculate the periodic payment for the mortgage
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param mortgageCalculatorPeriodicPaymentRequest Request payload for Mortgage Calculator - Periodic Payment
@return map[string]interface{}
func (*FinancialPlanningApiService) PurchaseCalculatorAmount ¶
func (a *FinancialPlanningApiService) PurchaseCalculatorAmount(ctx context.Context, purchaseCalculatorAmountRequest PurchaseCalculatorAmountRequest) (map[string]interface{}, *http.Response, error)
FinancialPlanningApiService Purchase Calculator - Amount Calculate the achievable purchase amount
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param purchaseCalculatorAmountRequest Request payload for Purchase Calculator - Amount
@return map[string]interface{}
func (*FinancialPlanningApiService) PurchaseCalculatorDepositAmount ¶
func (a *FinancialPlanningApiService) PurchaseCalculatorDepositAmount(ctx context.Context, purchaseCalculatorDepositAmountRequest PurchaseCalculatorDepositAmountRequest) (map[string]interface{}, *http.Response, error)
FinancialPlanningApiService Purchase Calculator - Deposit Amount Calculate the necessary periodic deposit amount to achieve the purchase amount
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param purchaseCalculatorDepositAmountRequest Request payload for Purchase Calculator - Deposit Amount
@return map[string]interface{}
func (*FinancialPlanningApiService) PurchaseCalculatorHorizon ¶
func (a *FinancialPlanningApiService) PurchaseCalculatorHorizon(ctx context.Context, purchaseCalculatorHorizonRequest PurchaseCalculatorHorizonRequest) (map[string]interface{}, *http.Response, error)
FinancialPlanningApiService Purchase Calculator - Horizon Calculate the necessary time horizon to achieve the purchase amount
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param purchaseCalculatorHorizonRequest Request payload for Purchase Calculator - Horizon
@return map[string]interface{}
func (*FinancialPlanningApiService) RetirementCalculatorDepositAmount ¶
func (a *FinancialPlanningApiService) RetirementCalculatorDepositAmount(ctx context.Context, retirementCalculatorDepositAmountRequest RetirementCalculatorDepositAmountRequest) (map[string]interface{}, *http.Response, error)
FinancialPlanningApiService Retirement Calculator - Deposit Amount Calculate the necessary period deposit amount to achieve the retirement expenses
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param retirementCalculatorDepositAmountRequest Request payload for Retirement Calculator - Deposit AMount
@return map[string]interface{}
func (*FinancialPlanningApiService) RetirementCalculatorExpenses ¶
func (a *FinancialPlanningApiService) RetirementCalculatorExpenses(ctx context.Context, retirementCalculatorExpensesRequest RetirementCalculatorExpensesRequest) (map[string]interface{}, *http.Response, error)
FinancialPlanningApiService Retirement Calculator - Expenses Calculate the achievable retirement expenses
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param retirementCalculatorExpensesRequest Request payload for Retirement Calculator - Expenses
@return map[string]interface{}
func (*FinancialPlanningApiService) RetirementCalculatorPercentCovered ¶
func (a *FinancialPlanningApiService) RetirementCalculatorPercentCovered(ctx context.Context, retirementCalculatorPercentCoveredRequest RetirementCalculatorPercentCoveredRequest) (map[string]interface{}, *http.Response, error)
FinancialPlanningApiService Retirement Calculator - Percent Covered Calculate the achievable percentage of retirement expenses that can be covered
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param retirementCalculatorPercentCoveredRequest Request payload for Retirement Calculator - Percent Covered
@return map[string]interface{}
type FinancialStatementAnalysisRequest ¶
type FinancialStatementAnalysisRequest struct {
CurrencyCode string `json:"currency_code,omitempty"`
ClientId string `json:"client_id,omitempty"`
ShowHistory bool `json:"show_history,omitempty"`
AccountingMethod string `json:"accounting_method"`
EndDate string `json:"end_date,omitempty"`
HistoryFrequencyInterval string `json:"history_frequency_interval,omitempty"`
CurrencyConversion string `json:"currency_conversion,omitempty"`
PeriodQuarter int32 `json:"period_quarter,omitempty"`
StatementType string `json:"statement_type,omitempty"`
PeriodMonth int32 `json:"period_month,omitempty"`
StartDate string `json:"start_date,omitempty"`
BusinessId string `json:"business_id,omitempty"`
PeriodYear int32 `json:"period_year,omitempty"`
PeriodLength string `json:"period_length,omitempty"`
StatNames []string `json:"stat_names,omitempty"`
PeriodType string `json:"period_type,omitempty"`
}
type GenericSwaggerError ¶
type GenericSwaggerError struct {
// contains filtered or unexported fields
}
GenericSwaggerError Provides access to the body, error and model on returned errors.
func (GenericSwaggerError) Body ¶
func (e GenericSwaggerError) Body() []byte
Body returns the raw bytes of the response
func (GenericSwaggerError) Error ¶
func (e GenericSwaggerError) Error() string
Error returns non-empty string if there was an error.
func (GenericSwaggerError) Model ¶
func (e GenericSwaggerError) Model() interface{}
Model returns the unpacked model of the error
type GoalAccumulationAllocationRequest ¶
type GoalAccumulationAllocationRequest struct {
RecommendationConfig RecommendationConfig `json:"recommendation_config,omitempty"`
CompoundingRate float32 `json:"compounding_rate,omitempty"`
RiskScore float32 `json:"risk_score,omitempty"`
RecommendType string `json:"recommend_type,omitempty"`
CreateLog bool `json:"create_log,omitempty"`
GoalConfig GoalConfig `json:"goal_config,omitempty"`
N int32 `json:"n,omitempty"`
AllocationMethod string `json:"allocation_method"`
AllocationPriority string `json:"allocation_priority"`
RemoveOutliers bool `json:"remove_outliers,omitempty"`
AdjustForCompounding bool `json:"adjust_for_compounding,omitempty"`
GoalId string `json:"goal_id,omitempty"`
ConfTgt float32 `json:"conf_tgt,omitempty"`
TradingDaysPerYear int32 `json:"trading_days_per_year,omitempty"`
UseProxyData bool `json:"use_proxy_data,omitempty"`
Thresh float32 `json:"thresh,omitempty"`
WithdrawalTax float32 `json:"withdrawal_tax,omitempty"`
ClientId string `json:"client_id,omitempty"`
OptConfig OptConfig `json:"opt_config,omitempty"`
MarketDataSource string `json:"market_data_source,omitempty"`
ThreshType string `json:"thresh_type,omitempty"`
HorizonFrequency string `json:"horizon_frequency,omitempty"`
Horizon int32 `json:"horizon,omitempty"`
Allocations []string `json:"allocations,omitempty"`
CurrInv float32 `json:"curr_inv,omitempty"`
DepositConfig []AccumulationGoalDepositConfig `json:"deposit_config,omitempty"`
}
type GoalAccumulationRecommendationRequest ¶
type GoalAccumulationRecommendationRequest struct {
RecommendationConfig RecommendationConfig1 `json:"recommendation_config,omitempty"`
CompoundingRate float32 `json:"compounding_rate,omitempty"`
RecommendType string `json:"recommend_type,omitempty"`
CreateLog bool `json:"create_log,omitempty"`
GoalConfig GoalConfig `json:"goal_config,omitempty"`
N int32 `json:"n,omitempty"`
PRisk []float32 `json:"p_risk"`
RemoveOutliers bool `json:"remove_outliers,omitempty"`
AdjustForCompounding bool `json:"adjust_for_compounding,omitempty"`
GoalId string `json:"goal_id,omitempty"`
ConfTgt float32 `json:"conf_tgt,omitempty"`
TradingDaysPerYear int32 `json:"trading_days_per_year,omitempty"`
Thresh float32 `json:"thresh,omitempty"`
WithdrawalTax float32 `json:"withdrawal_tax,omitempty"`
ClientId string `json:"client_id,omitempty"`
ThreshType string `json:"thresh_type,omitempty"`
HorizonFrequency string `json:"horizon_frequency,omitempty"`
Horizon int32 `json:"horizon,omitempty"`
CurrInv float32 `json:"curr_inv,omitempty"`
DepositConfig []AccumulationGoalDepositConfig `json:"deposit_config,omitempty"`
PRet []float32 `json:"p_ret"`
}
type GoalAccumulationStatusRequest ¶
type GoalAccumulationStatusRequest struct {
RecommendationConfig RecommendationConfig `json:"recommendation_config,omitempty"`
CompoundingRate float32 `json:"compounding_rate,omitempty"`
RecommendType string `json:"recommend_type,omitempty"`
CreateLog bool `json:"create_log,omitempty"`
GoalConfig GoalConfig `json:"goal_config,omitempty"`
N int32 `json:"n,omitempty"`
PRisk []float32 `json:"p_risk"`
RemoveOutliers bool `json:"remove_outliers,omitempty"`
AdjustForCompounding bool `json:"adjust_for_compounding,omitempty"`
GoalId string `json:"goal_id,omitempty"`
ConfTgt float32 `json:"conf_tgt,omitempty"`
TradingDaysPerYear int32 `json:"trading_days_per_year,omitempty"`
Thresh float32 `json:"thresh,omitempty"`
WithdrawalTax float32 `json:"withdrawal_tax,omitempty"`
ClientId string `json:"client_id,omitempty"`
ThreshType string `json:"thresh_type,omitempty"`
HorizonFrequency string `json:"horizon_frequency,omitempty"`
Horizon int32 `json:"horizon,omitempty"`
CurrInv float32 `json:"curr_inv,omitempty"`
DepositConfig []AccumulationGoalDepositConfig `json:"deposit_config,omitempty"`
PRet []float32 `json:"p_ret"`
}
type GoalConfig ¶
type GoalDecumulationAllocationRequest ¶
type GoalDecumulationAllocationRequest struct {
RecommendationConfig RecommendationConfig `json:"recommendation_config,omitempty"`
CompoundingRate float32 `json:"compounding_rate,omitempty"`
RiskScore float32 `json:"risk_score,omitempty"`
RecommendType string `json:"recommend_type,omitempty"`
CreateLog bool `json:"create_log,omitempty"`
N int32 `json:"n,omitempty"`
AHorizon int32 `json:"a_horizon,omitempty"`
AllocationMethod string `json:"allocation_method"`
AllocationPriority string `json:"allocation_priority"`
RemoveOutliers bool `json:"remove_outliers,omitempty"`
AdjustForCompounding bool `json:"adjust_for_compounding,omitempty"`
GoalId string `json:"goal_id,omitempty"`
ConfTgt float32 `json:"conf_tgt,omitempty"`
TradingDaysPerYear int32 `json:"trading_days_per_year,omitempty"`
UseProxyData bool `json:"use_proxy_data,omitempty"`
Thresh float32 `json:"thresh,omitempty"`
WithdrawalTax float32 `json:"withdrawal_tax,omitempty"`
DHorizon int32 `json:"d_horizon,omitempty"`
ClientId string `json:"client_id,omitempty"`
OptConfig OptConfig `json:"opt_config,omitempty"`
MarketDataSource string `json:"market_data_source,omitempty"`
ThreshType string `json:"thresh_type,omitempty"`
HorizonFrequency string `json:"horizon_frequency,omitempty"`
WithdrawalConfig []GoalWithdrawalConfig `json:"withdrawal_config,omitempty"`
Allocations []string `json:"allocations,omitempty"`
CurrInv float32 `json:"curr_inv,omitempty"`
DepositConfig []DecumulationGoalDepositConfig `json:"deposit_config,omitempty"`
}
type GoalDecumulationRecommendationRequest ¶
type GoalDecumulationRecommendationRequest struct {
RecommendationConfig RecommendationConfig1 `json:"recommendation_config,omitempty"`
CompoundingRate float32 `json:"compounding_rate,omitempty"`
RecommendType string `json:"recommend_type,omitempty"`
CreateLog bool `json:"create_log,omitempty"`
N int32 `json:"n,omitempty"`
AHorizon int32 `json:"a_horizon,omitempty"`
PRisk []float32 `json:"p_risk"`
RemoveOutliers bool `json:"remove_outliers,omitempty"`
AdjustForCompounding bool `json:"adjust_for_compounding,omitempty"`
GoalId string `json:"goal_id,omitempty"`
ConfTgt float32 `json:"conf_tgt,omitempty"`
TradingDaysPerYear int32 `json:"trading_days_per_year,omitempty"`
Thresh float32 `json:"thresh,omitempty"`
WithdrawalTax float32 `json:"withdrawal_tax,omitempty"`
DHorizon int32 `json:"d_horizon,omitempty"`
ClientId string `json:"client_id,omitempty"`
ThreshType string `json:"thresh_type,omitempty"`
HorizonFrequency string `json:"horizon_frequency,omitempty"`
WithdrawalConfig []GoalWithdrawalConfig `json:"withdrawal_config,omitempty"`
CurrInv float32 `json:"curr_inv,omitempty"`
DepositConfig []DecumulationGoalDepositConfig `json:"deposit_config,omitempty"`
PRet []float32 `json:"p_ret"`
}
type GoalDecumulationStatusRequest ¶
type GoalDecumulationStatusRequest struct {
RecommendationConfig RecommendationConfig `json:"recommendation_config,omitempty"`
CompoundingRate float32 `json:"compounding_rate,omitempty"`
RecommendType string `json:"recommend_type,omitempty"`
CreateLog bool `json:"create_log,omitempty"`
N int32 `json:"n,omitempty"`
AHorizon int32 `json:"a_horizon,omitempty"`
PRisk []float32 `json:"p_risk"`
RemoveOutliers bool `json:"remove_outliers,omitempty"`
AdjustForCompounding bool `json:"adjust_for_compounding,omitempty"`
GoalId string `json:"goal_id,omitempty"`
ConfTgt float32 `json:"conf_tgt,omitempty"`
TradingDaysPerYear int32 `json:"trading_days_per_year,omitempty"`
Thresh float32 `json:"thresh,omitempty"`
WithdrawalTax float32 `json:"withdrawal_tax,omitempty"`
DHorizon int32 `json:"d_horizon,omitempty"`
ClientId string `json:"client_id,omitempty"`
ThreshType string `json:"thresh_type,omitempty"`
HorizonFrequency string `json:"horizon_frequency,omitempty"`
WithdrawalConfig []GoalWithdrawalConfig `json:"withdrawal_config,omitempty"`
CurrInv float32 `json:"curr_inv,omitempty"`
DepositConfig []DecumulationGoalDepositConfig `json:"deposit_config,omitempty"`
PRet []float32 `json:"p_ret"`
}
type GoalWithdrawalConfig ¶
type GoalWithdrawalConfig struct {
WithInflation float32 `json:"with_inflation,omitempty"`
WithFrequency string `json:"with_frequency,omitempty"`
WithEndReference string `json:"with_end_reference,omitempty"`
WithStartReference string `json:"with_start_reference,omitempty"`
WithEndPeriod int32 `json:"with_end_period,omitempty"`
WithAmount float32 `json:"with_amount,omitempty"`
WithStartPeriod int32 `json:"with_start_period,omitempty"`
}
type GoalsApiService ¶
type GoalsApiService service
func (*GoalsApiService) GoalAccumulationAllocation ¶
func (a *GoalsApiService) GoalAccumulationAllocation(ctx context.Context, goalAccumulationAllocationRequest GoalAccumulationAllocationRequest) (map[string]interface{}, *http.Response, error)
GoalsApiService Goal Accumulation Allocation Allocate based on an accumulation goal
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param goalAccumulationAllocationRequest Request payload for Goal Accumulation Allocation
@return map[string]interface{}
func (*GoalsApiService) GoalAccumulationRecommendation ¶
func (a *GoalsApiService) GoalAccumulationRecommendation(ctx context.Context, goalAccumulationRecommendationRequest GoalAccumulationRecommendationRequest) (map[string]interface{}, *http.Response, error)
GoalsApiService Goal Accumulation Recommendation Generate recommendations to achieve an accumulation goal
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param goalAccumulationRecommendationRequest Request payload for Goal Accumulation Recommendation
@return map[string]interface{}
func (*GoalsApiService) GoalAccumulationStatus ¶
func (a *GoalsApiService) GoalAccumulationStatus(ctx context.Context, goalAccumulationStatusRequest GoalAccumulationStatusRequest) (map[string]interface{}, *http.Response, error)
GoalsApiService Goal Accumulation Status Track the status of an accumulation goal
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param goalAccumulationStatusRequest Request payload for Goal Accumulation Status
@return map[string]interface{}
func (*GoalsApiService) GoalDecumulationAllocation ¶
func (a *GoalsApiService) GoalDecumulationAllocation(ctx context.Context, goalDecumulationAllocationRequest GoalDecumulationAllocationRequest) (map[string]interface{}, *http.Response, error)
GoalsApiService Goal Decumulation Allocation Allocate based on a decumulation goal
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param goalDecumulationAllocationRequest Request payload for Goal Decumulation Allocation
@return map[string]interface{}
func (*GoalsApiService) GoalDecumulationRecommendation ¶
func (a *GoalsApiService) GoalDecumulationRecommendation(ctx context.Context, goalDecumulationRecommendationRequest GoalDecumulationRecommendationRequest) (map[string]interface{}, *http.Response, error)
GoalsApiService Goal Decumulation Recommendation Generate recommendations to achieve a decumulation goal
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param goalDecumulationRecommendationRequest Request payload for Goal Decumulation Recommendation
@return map[string]interface{}
func (*GoalsApiService) GoalDecumulationStatus ¶
func (a *GoalsApiService) GoalDecumulationStatus(ctx context.Context, goalDecumulationStatusRequest GoalDecumulationStatusRequest) (map[string]interface{}, *http.Response, error)
GoalsApiService Goal Decumulation Status Track the status of a decumulation goal
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param goalDecumulationStatusRequest Request payload for Goal Decumulation Status
@return map[string]interface{}
type GuaranteedRateBenefit ¶
type IncomeConfig ¶
type LifeInsuranceApiService ¶
type LifeInsuranceApiService service
func (*LifeInsuranceApiService) LifeInsuranceNeedsCalculator ¶
func (a *LifeInsuranceApiService) LifeInsuranceNeedsCalculator(ctx context.Context, lifeInsuranceNeedsCalculatorRequest LifeInsuranceNeedsCalculatorRequest) (map[string]interface{}, *http.Response, error)
LifeInsuranceApiService Life Insurance Needs Calculator Calculate life insurance needs based on existing asset and liability data
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param lifeInsuranceNeedsCalculatorRequest Request payload for Life Insurance Needs Calculator
@return map[string]interface{}
type LifeInsuranceNeedsCalculatorRequest ¶
type LifeInsuranceNeedsCalculatorRequest struct {
ClientId string `json:"client_id,omitempty"`
BeneficiaryBequestConfig []BeneficiaryBequestConfig `json:"beneficiary_bequest_config,omitempty"`
EducationInflationRate float32 `json:"education_inflation_rate,omitempty"`
MarginOfError float32 `json:"margin_of_error,omitempty"`
LiquidAssets float32 `json:"liquid_assets,omitempty"`
TaxRate float32 `json:"tax_rate,omitempty"`
OtherDebt float32 `json:"other_debt,omitempty"`
EndOfLifeExpenses float32 `json:"end_of_life_expenses,omitempty"`
ExistingLifeInsurance float32 `json:"existing_life_insurance,omitempty"`
IncomeConfig []IncomeConfig `json:"income_config,omitempty"`
MortgageBalance float32 `json:"mortgage_balance,omitempty"`
BenefitAmountRounding int32 `json:"benefit_amount_rounding,omitempty"`
InterestRate float32 `json:"interest_rate"`
ChildrenEducationConfig []ChildrenEducationConfig `json:"children_education_config,omitempty"`
GeneralInflationRate float32 `json:"general_inflation_rate,omitempty"`
}
type MonteCarloRequest ¶
type MonteCarloRequest struct {
MinBal []float32 `json:"min_bal,omitempty"`
MaxBal []float32 `json:"max_bal,omitempty"`
P []float32 `json:"p,omitempty"`
AllocationId string `json:"allocation_id,omitempty"`
InitBal float32 `json:"init_bal,omitempty"`
MaxSample []float32 `json:"max_sample,omitempty"`
ModelId string `json:"model_id,omitempty"`
Cf [][]float32 `json:"cf"`
CreateLog bool `json:"create_log,omitempty"`
AggregationAccountId string `json:"aggregation_account_id,omitempty"`
N int32 `json:"n,omitempty"`
RemoveOutliers bool `json:"remove_outliers,omitempty"`
Sigma []float32 `json:"sigma,omitempty"`
Mu []float32 `json:"mu,omitempty"`
PortfolioId string `json:"portfolio_id,omitempty"`
ResultType string `json:"result_type,omitempty"`
AccountId string `json:"account_id,omitempty"`
UseProxyData bool `json:"use_proxy_data,omitempty"`
MarketDataSource string `json:"market_data_source,omitempty"`
RetMod []float32 `json:"ret_mod,omitempty"`
FrequencyInterval string `json:"frequency_interval,omitempty"`
MinSample []float32 `json:"min_sample,omitempty"`
}
type MvoRequest ¶
type MvoRequest struct {
Tickers []string `json:"tickers"`
WConfig WConfig `json:"w_config"`
MinAssets int32 `json:"min_assets"`
EndDate string `json:"end_date,omitempty"`
MarketDataSource string `json:"market_data_source,omitempty"`
WAssetConfig interface{} `json:"w_asset_config,omitempty"`
StartDate string `json:"start_date,omitempty"`
TgtType string `json:"tgt_type,omitempty"`
UseProxyData bool `json:"use_proxy_data,omitempty"`
TgtVal float32 `json:"tgt_val,omitempty"`
SecTypes []string `json:"sec_types"`
}
type OptConfig ¶
type OptConfig struct {
Tickers []string `json:"tickers"`
WConfig WConfig `json:"w_config"`
MinAssets int32 `json:"min_assets"`
EndDate string `json:"end_date,omitempty"`
WAssetConfig interface{} `json:"w_asset_config,omitempty"`
StartDate string `json:"start_date,omitempty"`
SecTypes []string `json:"sec_types"`
}
type OptConfig1 ¶
type OrderRebalanceRequest ¶
type OrderRebalanceRequest struct {
NonFractional bool `json:"non_fractional,omitempty"`
OrderScope string `json:"order_scope"`
BuyThreshold float32 `json:"buy_threshold,omitempty"`
CommitOrders bool `json:"commit_orders,omitempty"`
AccountId string `json:"account_id,omitempty"`
PortThreshold float32 `json:"port_threshold,omitempty"`
UseCashAvailable bool `json:"use_cash_available,omitempty"`
UseStrategic bool `json:"use_strategic,omitempty"`
SellTransactionCodeId string `json:"sell_transaction_code_id,omitempty"`
BuyTransactionCodeId string `json:"buy_transaction_code_id,omitempty"`
CashPortfolioId string `json:"cash_portfolio_id,omitempty"`
RestrictionsOn bool `json:"restrictions_on,omitempty"`
SellThreshold float32 `json:"sell_threshold,omitempty"`
PortfolioId string `json:"portfolio_id,omitempty"`
}
type PerformanceCalculatorRequest ¶
type PerformanceCalculatorRequest struct {
AnnualizedReturnPeriod string `json:"annualized_return_period,omitempty"`
RiskFreeAlpha float32 `json:"risk_free_alpha,omitempty"`
AllocationId string `json:"allocation_id,omitempty"`
MeanPercentileMonteCarlo float32 `json:"mean_percentile_monte_carlo,omitempty"`
ModelId string `json:"model_id,omitempty"`
MarDownsideDeviation float32 `json:"mar_downside_deviation,omitempty"`
RiskFreeSharpe float32 `json:"risk_free_sharpe,omitempty"`
BenchmarkId string `json:"benchmark_id,omitempty"`
RiskFreeSortino float32 `json:"risk_free_sortino,omitempty"`
HouseholdId string `json:"household_id,omitempty"`
MinPercentileMonteCarlo float32 `json:"min_percentile_monte_carlo,omitempty"`
MovingAverageNDay int32 `json:"moving_average_n_day,omitempty"`
ActivePremiumPeriod string `json:"active_premium_period,omitempty"`
StatName string `json:"stat_name"`
EndDate string `json:"end_date,omitempty"`
StartDate string `json:"start_date,omitempty"`
NDayReturns int32 `json:"n_day_returns,omitempty"`
VarConfInterval float32 `json:"var_conf_interval,omitempty"`
PeriodType string `json:"period_type,omitempty"`
RiskFreeTreynor float32 `json:"risk_free_treynor,omitempty"`
NRollingMaxDrawdown int32 `json:"n_rolling_max_drawdown,omitempty"`
PortfolioId string `json:"portfolio_id,omitempty"`
NumSimMonteCarlo int32 `json:"num_sim_monte_carlo,omitempty"`
GoalId string `json:"goal_id,omitempty"`
AccountId string `json:"account_id,omitempty"`
SecurityId string `json:"security_id,omitempty"`
NPathMonteCarlo int32 `json:"n_path_monte_carlo,omitempty"`
ClientId string `json:"client_id,omitempty"`
NRollingVolatility int32 `json:"n_rolling_volatility,omitempty"`
HistFactor float32 `json:"hist_factor,omitempty"`
MaxPercentileMonteCarlo float32 `json:"max_percentile_monte_carlo,omitempty"`
}
type PersonalFinancialManagementApiService ¶
type PersonalFinancialManagementApiService service
func (*PersonalFinancialManagementApiService) BudgetCalculator ¶
func (a *PersonalFinancialManagementApiService) BudgetCalculator(ctx context.Context, budgetCalculatorRequest BudgetCalculatorRequest) (map[string]interface{}, *http.Response, error)
PersonalFinancialManagementApiService Budget Calculator Analyze spending against a defined budget
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param budgetCalculatorRequest Request payload for Budget Calculator
@return map[string]interface{}
func (*PersonalFinancialManagementApiService) CashFlowAnalysis ¶
func (a *PersonalFinancialManagementApiService) CashFlowAnalysis(ctx context.Context, cashFlowAnalysisRequest CashFlowAnalysisRequest) (map[string]interface{}, *http.Response, error)
PersonalFinancialManagementApiService Cash Flow Analysis Analyze income, expenses, and net income
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param cashFlowAnalysisRequest Request payload for Cash Flow Analysis
@return map[string]interface{}
func (*PersonalFinancialManagementApiService) FeeAnalysis ¶
func (a *PersonalFinancialManagementApiService) FeeAnalysis(ctx context.Context, feeAnalysisRequest FeeAnalysisRequest) (map[string]interface{}, *http.Response, error)
PersonalFinancialManagementApiService RFee Analysis Analyze fee data
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param feeAnalysisRequest Request payload for Fee Analysis
@return map[string]interface{}
func (*PersonalFinancialManagementApiService) FinancialPicture ¶
func (a *PersonalFinancialManagementApiService) FinancialPicture(ctx context.Context, financialPictureRequest FinancialPictureRequest) (map[string]interface{}, *http.Response, error)
PersonalFinancialManagementApiService Financial Picture Assess assets, liabilities, and net worth
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param financialPictureRequest Request payload for Financial Picture
@return map[string]interface{}
func (*PersonalFinancialManagementApiService) RecurringTransactionAnalysis ¶
func (a *PersonalFinancialManagementApiService) RecurringTransactionAnalysis(ctx context.Context, recurringTransactionAnalysisRequest RecurringTransactionAnalysisRequest) (map[string]interface{}, *http.Response, error)
PersonalFinancialManagementApiService Recurring Transaction Analysis Analyze recurring transactions
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param recurringTransactionAnalysisRequest Request payload for Recurring Transaction Analysis
@return map[string]interface{}
func (*PersonalFinancialManagementApiService) SpendingAnalysis ¶
func (a *PersonalFinancialManagementApiService) SpendingAnalysis(ctx context.Context, spendingAnalysisRequest SpendingAnalysisRequest) (map[string]interface{}, *http.Response, error)
PersonalFinancialManagementApiService Spending Analysis Analyze spending transaction activity
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param spendingAnalysisRequest Request payload for Spending Analysis
@return map[string]interface{}
type PortfolioConstructionApiService ¶
type PortfolioConstructionApiService service
func (*PortfolioConstructionApiService) Mvo ¶
func (a *PortfolioConstructionApiService) Mvo(ctx context.Context, mvoRequest MvoRequest) (map[string]interface{}, *http.Response, error)
PortfolioConstructionApiService MVO Run a mean-variance optimization for a group of potential investments
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param mvoRequest Request payload for MVO
@return map[string]interface{}
type PortfolioManagementApiService ¶
type PortfolioManagementApiService service
func (*PortfolioManagementApiService) RebalancingSignal ¶
func (a *PortfolioManagementApiService) RebalancingSignal(ctx context.Context, rebalancingSignalRequest RebalancingSignalRequest) (map[string]interface{}, *http.Response, error)
PortfolioManagementApiService Rebalancing Signal Generate rebalancing signals for a group of investments
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param rebalancingSignalRequest Request payload for Rebalancing Signal
@return map[string]interface{}
type PortfolioOptimizationScoreRequest ¶
type PortfolioOptimizationScoreRequest struct {
OptConfig OptConfig1 `json:"opt_config,omitempty"`
AllocationId string `json:"allocation_id,omitempty"`
EndDate string `json:"end_date,omitempty"`
MarketDataSource string `json:"market_data_source,omitempty"`
ModelId string `json:"model_id,omitempty"`
AccountId string `json:"account_id,omitempty"`
StartDate string `json:"start_date,omitempty"`
TgtType string `json:"tgt_type,omitempty"`
UseProxyData bool `json:"use_proxy_data,omitempty"`
PortfolioWeights []float32 `json:"portfolio_weights,omitempty"`
PortfolioTickers []string `json:"portfolio_tickers,omitempty"`
CreateLog bool `json:"create_log,omitempty"`
AggregationAccountId string `json:"aggregation_account_id,omitempty"`
PortfolioId string `json:"portfolio_id,omitempty"`
}
type PortfolioWhatIfRequest ¶
type PortfolioWhatIfRequest struct {
AllocationId string `json:"allocation_id,omitempty"`
EndDate string `json:"end_date,omitempty"`
MarketDataSource string `json:"market_data_source,omitempty"`
ModelId string `json:"model_id,omitempty"`
AccountId string `json:"account_id,omitempty"`
StartDate string `json:"start_date,omitempty"`
CurrentPortfolioWeights []float32 `json:"current_portfolio_weights,omitempty"`
UseProxyData bool `json:"use_proxy_data,omitempty"`
AlteredPortfolioWeights []float32 `json:"altered_portfolio_weights"`
CreateLog bool `json:"create_log,omitempty"`
CurrentPortfolioTickers []string `json:"current_portfolio_tickers,omitempty"`
AggregationAccountId string `json:"aggregation_account_id,omitempty"`
AlteredPortfolioTickers []string `json:"altered_portfolio_tickers,omitempty"`
PortfolioId string `json:"portfolio_id,omitempty"`
}
type PurchaseCalculatorAmountRequest ¶
type PurchaseCalculatorAmountRequest struct {
AccountIds []string `json:"account_ids,omitempty"`
HorizonFrequencyInterval string `json:"horizon_frequency_interval,omitempty"`
PurchaseHorizon int32 `json:"purchase_horizon"`
InvestmentTax float32 `json:"investment_tax,omitempty"`
PortfolioReturn float32 `json:"portfolio_return"`
DepositSchedule CalculatorDepositSchedule1 `json:"deposit_schedule,omitempty"`
CurrentSavings float32 `json:"current_savings,omitempty"`
InflationRate float32 `json:"inflation_rate,omitempty"`
AggregationAccountIds []string `json:"aggregation_account_ids,omitempty"`
}
type PurchaseCalculatorDepositAmountRequest ¶
type PurchaseCalculatorDepositAmountRequest struct {
AccountIds []string `json:"account_ids,omitempty"`
HorizonFrequencyInterval string `json:"horizon_frequency_interval,omitempty"`
PurchaseHorizon int32 `json:"purchase_horizon"`
InvestmentTax float32 `json:"investment_tax,omitempty"`
PortfolioReturn float32 `json:"portfolio_return"`
DepositSchedule CalculatorDepositSchedule `json:"deposit_schedule,omitempty"`
CurrentSavings float32 `json:"current_savings,omitempty"`
PurchaseAmount float32 `json:"purchase_amount"`
InflationRate float32 `json:"inflation_rate,omitempty"`
AggregationAccountIds []string `json:"aggregation_account_ids,omitempty"`
}
type PurchaseCalculatorHorizonRequest ¶
type PurchaseCalculatorHorizonRequest struct {
AccountIds []string `json:"account_ids,omitempty"`
InvestmentTax float32 `json:"investment_tax,omitempty"`
PortfolioReturn float32 `json:"portfolio_return"`
DepositSchedule CalculatorDepositSchedule1 `json:"deposit_schedule,omitempty"`
CurrentSavings float32 `json:"current_savings,omitempty"`
PurchaseAmount float32 `json:"purchase_amount"`
InflationRate float32 `json:"inflation_rate,omitempty"`
AggregationAccountIds []string `json:"aggregation_account_ids,omitempty"`
}
type RatioTargets ¶
type RatioTargets struct {
LiquidityRatioLiabilities float32 `json:"liquidity_ratio_liabilities,omitempty"`
CurrentRatio float32 `json:"current_ratio,omitempty"`
AssetAllocationRatio float32 `json:"asset_allocation_ratio,omitempty"`
SavingsRatioNet float32 `json:"savings_ratio_net,omitempty"`
SavingsRatioGross float32 `json:"savings_ratio_gross,omitempty"`
LiquidityRatioExpenses float32 `json:"liquidity_ratio_expenses,omitempty"`
}
type RatioTargets1 ¶
type RatioTargets1 struct {
ReturnOnEquity float32 `json:"return_on_equity,omitempty"`
ReturnOnAssets float32 `json:"return_on_assets,omitempty"`
DebtToEquity float32 `json:"debt_to_equity,omitempty"`
ProfitMargin float32 `json:"profit_margin,omitempty"`
DebtRatio float32 `json:"debt_ratio,omitempty"`
AssetTurnover float32 `json:"asset_turnover,omitempty"`
}
type RebalancingSignalRequest ¶
type RebalancingSignalRequest struct {
EndDate string `json:"end_date"`
UpdateModel bool `json:"update_model,omitempty"`
ModelId string `json:"model_id,omitempty"`
StartDate string `json:"start_date"`
InitialWeights interface{} `json:"initial_weights,omitempty"`
Settings Settings `json:"settings,omitempty"`
}
type RecommendationConfig ¶
type RecommendationConfig struct {
HorizonMax int32 `json:"horizon_max,omitempty"`
DepMin float32 `json:"dep_min,omitempty"`
InvMax float32 `json:"inv_max,omitempty"`
InvMin float32 `json:"inv_min,omitempty"`
RecommendedInflation float32 `json:"recommended_inflation,omitempty"`
HorizonMin int32 `json:"horizon_min,omitempty"`
Recommend bool `json:"recommend,omitempty"`
DepMax float32 `json:"dep_max,omitempty"`
}
type RecommendationConfig1 ¶
type RecommendationConfig1 struct {
HorizonMax int32 `json:"horizon_max,omitempty"`
DepMin float32 `json:"dep_min,omitempty"`
InvMax float32 `json:"inv_max,omitempty"`
InvMin float32 `json:"inv_min,omitempty"`
RecommendedInflation float32 `json:"recommended_inflation,omitempty"`
HorizonMin int32 `json:"horizon_min,omitempty"`
DepMax float32 `json:"dep_max,omitempty"`
}
type RecurringTransactionAnalysisRequest ¶
type RecurringTransactionAnalysisRequest struct {
CurrencyCode string `json:"currency_code,omitempty"`
ClientId string `json:"client_id,omitempty"`
Scope string `json:"scope,omitempty"`
EndDate string `json:"end_date,omitempty"`
AccountIds []string `json:"account_ids,omitempty"`
CurrencyConversion string `json:"currency_conversion,omitempty"`
IntervalDeviationThreshold int32 `json:"interval_deviation_threshold,omitempty"`
AmountDeviationThreshold float32 `json:"amount_deviation_threshold,omitempty"`
AnalyzeTransactions bool `json:"analyze_transactions,omitempty"`
StartDate string `json:"start_date,omitempty"`
FlagTransactions bool `json:"flag_transactions,omitempty"`
TransactionStatusScope []string `json:"transaction_status_scope,omitempty"`
OnlyCleansed bool `json:"only_cleansed,omitempty"`
AggregationAccountIds []string `json:"aggregation_account_ids,omitempty"`
ShowRecurringDetails bool `json:"show_recurring_details,omitempty"`
}
type RetirementCalculatorDepositAmountRequest ¶
type RetirementCalculatorDepositAmountRequest struct {
RetirementSavings float32 `json:"retirement_savings,omitempty"`
CurrentAge int32 `json:"current_age"`
AccountIds []string `json:"account_ids,omitempty"`
RetirementIncome float32 `json:"retirement_income,omitempty"`
RetirementTax float32 `json:"retirement_tax,omitempty"`
DeathAge int32 `json:"death_age"`
RetirementAge int32 `json:"retirement_age,omitempty"`
PercentOfExpensesCovered float32 `json:"percent_of_expenses_covered,omitempty"`
PortfolioReturn float32 `json:"portfolio_return"`
RetirementExpenses float32 `json:"retirement_expenses"`
DepositSchedule CalculatorDepositSchedule `json:"deposit_schedule,omitempty"`
InflationRate float32 `json:"inflation_rate,omitempty"`
AggregationAccountIds []string `json:"aggregation_account_ids,omitempty"`
}
type RetirementCalculatorExpensesRequest ¶
type RetirementCalculatorExpensesRequest struct {
RetirementSavings float32 `json:"retirement_savings,omitempty"`
CurrentAge int32 `json:"current_age"`
AccountIds []string `json:"account_ids,omitempty"`
RetirementIncome float32 `json:"retirement_income,omitempty"`
RetirementTax float32 `json:"retirement_tax,omitempty"`
DeathAge int32 `json:"death_age"`
RetirementAge int32 `json:"retirement_age,omitempty"`
PercentOfExpensesCovered float32 `json:"percent_of_expenses_covered,omitempty"`
PortfolioReturn float32 `json:"portfolio_return"`
DepositSchedule CalculatorDepositSchedule1 `json:"deposit_schedule,omitempty"`
InflationRate float32 `json:"inflation_rate,omitempty"`
AggregationAccountIds []string `json:"aggregation_account_ids,omitempty"`
}
type RetirementCalculatorPercentCoveredRequest ¶
type RetirementCalculatorPercentCoveredRequest struct {
RetirementSavings float32 `json:"retirement_savings,omitempty"`
CurrentAge int32 `json:"current_age"`
AccountIds []string `json:"account_ids,omitempty"`
RetirementIncome float32 `json:"retirement_income,omitempty"`
RetirementTax float32 `json:"retirement_tax,omitempty"`
DeathAge int32 `json:"death_age"`
RetirementAge int32 `json:"retirement_age,omitempty"`
PortfolioReturn float32 `json:"portfolio_return"`
RetirementExpenses float32 `json:"retirement_expenses"`
DepositSchedule CalculatorDepositSchedule1 `json:"deposit_schedule,omitempty"`
InflationRate float32 `json:"inflation_rate,omitempty"`
AggregationAccountIds []string `json:"aggregation_account_ids,omitempty"`
}
type RiskAllocationRequest ¶
type RiskAllocationRequest struct {
ClientId string `json:"client_id,omitempty"`
AllocationMethod string `json:"allocation_method"`
OptConfig OptConfig `json:"opt_config,omitempty"`
MarketDataSource string `json:"market_data_source,omitempty"`
RiskScore float32 `json:"risk_score,omitempty"`
UseProxyData bool `json:"use_proxy_data,omitempty"`
Allocations []string `json:"allocations,omitempty"`
}
type RiskScoreRequest ¶
type RiskScoreRequest struct {
QuestionnaireId string `json:"questionnaire_id,omitempty"`
ClientId string `json:"client_id,omitempty"`
PostScore bool `json:"post_score,omitempty"`
MaxAnswers []float32 `json:"max_answers"`
Weights []float32 `json:"weights,omitempty"`
Answers []float32 `json:"answers,omitempty"`
}
type RiskScoringApiService ¶
type RiskScoringApiService service
func (*RiskScoringApiService) DimensionalRiskScore ¶
func (a *RiskScoringApiService) DimensionalRiskScore(ctx context.Context, dimensionalRiskScoreRequest DimensionalRiskScoreRequest) (map[string]interface{}, *http.Response, error)
RiskScoringApiService Dimensional Risk Score Calculate a dimensional risk score based on questionnaire responses
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param dimensionalRiskScoreRequest Request payload for Dimensional Risk Score
@return map[string]interface{}
func (*RiskScoringApiService) RiskAllocation ¶
func (a *RiskScoringApiService) RiskAllocation(ctx context.Context, riskAllocationRequest RiskAllocationRequest) (map[string]interface{}, *http.Response, error)
RiskScoringApiService Risk Allocation Allocate based on a risk score
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param riskAllocationRequest Request payload for Risk Allocation
@return map[string]interface{}
func (*RiskScoringApiService) RiskScore ¶
func (a *RiskScoringApiService) RiskScore(ctx context.Context, riskScoreRequest RiskScoreRequest) (map[string]interface{}, *http.Response, error)
RiskScoringApiService Risk Score Calculate a risk score based on questionnaire responses
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param riskScoreRequest Request payload for Risk Score
@return map[string]interface{}
type SavingsCalculatorRequest ¶
type SavingsCalculatorRequest struct {
InflationRate float32 `json:"inflation_rate,omitempty"`
AccountIds []string `json:"account_ids,omitempty"`
TaxRate float32 `json:"tax_rate,omitempty"`
HorizonFrequencyInterval string `json:"horizon_frequency_interval,omitempty"`
DepositSchedule []SavingsDepositSchedule `json:"deposit_schedule,omitempty"`
Horizon int32 `json:"horizon"`
ReturnSchedule []float32 `json:"return_schedule"`
CreateLog bool `json:"create_log,omitempty"`
InitialBalance float32 `json:"initial_balance,omitempty"`
AggregationAccountIds []string `json:"aggregation_account_ids,omitempty"`
}
type SavingsDepositSchedule ¶
type SavingsDepositSchedule struct {
DepositFrequencyInterval string `json:"deposit_frequency_interval,omitempty"`
DepositAmount float32 `json:"deposit_amount,omitempty"`
DepositDuration int32 `json:"deposit_duration,omitempty"`
AdjustDepositForInflation bool `json:"adjust_deposit_for_inflation,omitempty"`
}
type ScenarioAnalysisRequest ¶
type ScenarioAnalysisRequest struct {
Scenario []SensitivityFactor `json:"scenario"`
AllocationId string `json:"allocation_id,omitempty"`
EndDate string `json:"end_date,omitempty"`
MarketDataSource string `json:"market_data_source,omitempty"`
ModelId string `json:"model_id,omitempty"`
AccountId string `json:"account_id,omitempty"`
StartDate string `json:"start_date,omitempty"`
FrequencyInterval string `json:"frequency_interval"`
TradingDaysPerYear int32 `json:"trading_days_per_year,omitempty"`
UseProxyData bool `json:"use_proxy_data,omitempty"`
PortfolioWeights []float32 `json:"portfolio_weights,omitempty"`
PortfolioTickers []string `json:"portfolio_tickers,omitempty"`
CreateLog bool `json:"create_log,omitempty"`
AggregationAccountId string `json:"aggregation_account_id,omitempty"`
PortfolioId string `json:"portfolio_id,omitempty"`
}
type SensitivityAnalysisRequest ¶
type SensitivityAnalysisRequest struct {
AllocationId string `json:"allocation_id,omitempty"`
EndDate string `json:"end_date,omitempty"`
MarketDataSource string `json:"market_data_source,omitempty"`
ModelId string `json:"model_id,omitempty"`
AccountId string `json:"account_id,omitempty"`
StartDate string `json:"start_date,omitempty"`
FrequencyInterval string `json:"frequency_interval"`
TradingDaysPerYear int32 `json:"trading_days_per_year,omitempty"`
SensitivityFactor SensitivityFactor `json:"sensitivity_factor"`
UseProxyData bool `json:"use_proxy_data,omitempty"`
PortfolioWeights []float32 `json:"portfolio_weights,omitempty"`
PortfolioTickers []string `json:"portfolio_tickers,omitempty"`
CreateLog bool `json:"create_log,omitempty"`
AggregationAccountId string `json:"aggregation_account_id,omitempty"`
PortfolioId string `json:"portfolio_id,omitempty"`
}
type SensitivityFactor ¶
type Settings ¶
type Settings struct {
DefaultDriftFactor float32 `json:"default_drift_factor,omitempty"`
DriftRebal bool `json:"drift_rebal,omitempty"`
Downside bool `json:"downside,omitempty"`
TaxEfficiencyId int32 `json:"tax_efficiency_id,omitempty"`
PeriodRebal bool `json:"period_rebal,omitempty"`
RebalancePeriod int32 `json:"rebalance_period,omitempty"`
}
type SimulationsApiService ¶
type SimulationsApiService service
func (*SimulationsApiService) Backtest ¶
func (a *SimulationsApiService) Backtest(ctx context.Context, backtestRequest BacktestRequest) (map[string]interface{}, *http.Response, error)
SimulationsApiService Backtest Run a historical analysis for a group of investments
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param backtestRequest Request payload for Backtest
@return map[string]interface{}
func (*SimulationsApiService) EventStudy ¶
func (a *SimulationsApiService) EventStudy(ctx context.Context, eventStudyRequest EventStudyRequest) (map[string]interface{}, *http.Response, error)
SimulationsApiService Event Study Analyze a group of investments against key historical events
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param eventStudyRequest Request payload for Event Study
@return map[string]interface{}
func (*SimulationsApiService) MonteCarlo ¶
func (a *SimulationsApiService) MonteCarlo(ctx context.Context, monteCarloRequest MonteCarloRequest) (map[string]interface{}, *http.Response, error)
SimulationsApiService Monte Carlo Simulate the future growth of a group of investments
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param monteCarloRequest Request payload for Monte Carlo
@return map[string]interface{}
func (*SimulationsApiService) PortfolioWhatIf ¶
func (a *SimulationsApiService) PortfolioWhatIf(ctx context.Context, portfolioWhatIfRequest PortfolioWhatIfRequest) (map[string]interface{}, *http.Response, error)
SimulationsApiService Porfolio What-If Simulate the impact of adding, removing, reducing, or increasing various positions in a group of investments
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param portfolioWhatIfRequest Request payload for Portfolio What-If
@return map[string]interface{}
func (*SimulationsApiService) SavingsCalculator ¶
func (a *SimulationsApiService) SavingsCalculator(ctx context.Context, savingsCalculatorRequest SavingsCalculatorRequest) (map[string]interface{}, *http.Response, error)
SimulationsApiService Savings Calculator Simulate the future growth of a simple savings account
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param savingsCalculatorRequest Request payload for Savings Calculator
@return map[string]interface{}
func (*SimulationsApiService) ScenarioAnalysis ¶
func (a *SimulationsApiService) ScenarioAnalysis(ctx context.Context, scnearioAnalysisRequest ScenarioAnalysisRequest) (map[string]interface{}, *http.Response, error)
SimulationsApiService Scenario Analysis Analyze a group of investments against a series of external economic factors
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param scnearioAnalysisRequest Request payload for Scenario Analysis
@return map[string]interface{}
func (*SimulationsApiService) SensitivityAnalysis ¶
func (a *SimulationsApiService) SensitivityAnalysis(ctx context.Context, sensitivityAnalysisRequest SensitivityAnalysisRequest) (map[string]interface{}, *http.Response, error)
SimulationsApiService Sensitivity Analysis Analyze a group of investments against an external economic factor
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param sensitivityAnalysisRequest Request payload for Sensitivity Analysis
@return map[string]interface{}
type SpendingAnalysisRequest ¶
type SpendingAnalysisRequest struct {
MerchantScope []string `json:"merchant_scope,omitempty"`
AccountIds []string `json:"account_ids,omitempty"`
BusinessIds []string `json:"business_ids,omitempty"`
CardIds []string `json:"card_ids,omitempty"`
ShowByMerchant bool `json:"show_by_merchant,omitempty"`
ShowByPeriod bool `json:"show_by_period,omitempty"`
OnlyCleansed bool `json:"only_cleansed,omitempty"`
Frequency int32 `json:"frequency,omitempty"`
EndDate string `json:"end_date,omitempty"`
AsOfDate string `json:"as_of_date,omitempty"`
TransactionCategoryScope []string `json:"transaction_category_scope,omitempty"`
StartDate string `json:"start_date,omitempty"`
CardStatusScope []string `json:"card_status_scope,omitempty"`
OnlyActiveClients bool `json:"only_active_clients,omitempty"`
LookbackPeriods int32 `json:"lookback_periods,omitempty"`
FrequencyUnit string `json:"frequency_unit"`
HouseholdIds []string `json:"household_ids,omitempty"`
AggregationAccountIds []string `json:"aggregation_account_ids,omitempty"`
CurrencyCode string `json:"currency_code,omitempty"`
ClientIds []string `json:"client_ids,omitempty"`
Scope string `json:"scope,omitempty"`
CurrencyConversion string `json:"currency_conversion,omitempty"`
TransactionStatusScope []string `json:"transaction_status_scope,omitempty"`
ShowByCategory bool `json:"show_by_category,omitempty"`
}
type UtilApiService ¶
type UtilApiService service
func (*UtilApiService) DecisionTreeResult ¶
func (a *UtilApiService) DecisionTreeResult(ctx context.Context, decisionTreeResultRequest DecisionTreeResultRequest) (map[string]interface{}, *http.Response, error)
UtilApiService Decision Tree Result Traverse a decision tree and find the resulting leaf node
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param decisionTreeResultRequest Request payload for Decision Tree Result
@return map[string]interface{}
func (*UtilApiService) OrderRebalance ¶
func (a *UtilApiService) OrderRebalance(ctx context.Context, orderRebalanceRequest OrderRebalanceRequest) (map[string]interface{}, *http.Response, error)
UtilApiService Order Rebalance Create orders to rebalance client accounts or portfolios
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param orderRebalanceRequest Request payload for Order Rebalance
@return map[string]interface{}
func (*UtilApiService) PerformanceCalculator ¶
func (a *UtilApiService) PerformanceCalculator(ctx context.Context, performanceCalculatorRequest PerformanceCalculatorRequest) (map[string]interface{}, *http.Response, error)
UtilApiService Performance Calculator Calculate performance/risk metrics for a Nucleus entity
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param performanceCalculatorRequest Request payload for Performance Calculator
@return map[string]interface{}
type VariableAnnuityRequest ¶
type VariableAnnuityRequest struct {
P float32 `json:"p,omitempty"`
AllocationId string `json:"allocation_id,omitempty"`
DecumulationHorizon int32 `json:"decumulation_horizon"`
AccumulationHorizon int32 `json:"accumulation_horizon"`
AnnuitizationRate float32 `json:"annuitization_rate,omitempty"`
GuaranteedRateBenefit []GuaranteedRateBenefit `json:"guaranteed_rate_benefit,omitempty"`
ModelId string `json:"model_id,omitempty"`
PortfolioTickers []string `json:"portfolio_tickers,omitempty"`
CreateLog bool `json:"create_log,omitempty"`
InflationRate float32 `json:"inflation_rate,omitempty"`
AggregationAccountId string `json:"aggregation_account_id,omitempty"`
N int32 `json:"n,omitempty"`
GuaranteedAccumulationBenefit float32 `json:"guaranteed_accumulation_benefit,omitempty"`
EndDate string `json:"end_date,omitempty"`
TaxRate float32 `json:"tax_rate,omitempty"`
StartDate string `json:"start_date,omitempty"`
RemoveOutliers bool `json:"remove_outliers,omitempty"`
PortfolioWeights []float32 `json:"portfolio_weights,omitempty"`
PortfolioId string `json:"portfolio_id,omitempty"`
ResultType string `json:"result_type,omitempty"`
AccountId string `json:"account_id,omitempty"`
TradingDaysPerYear int32 `json:"trading_days_per_year,omitempty"`
UseProxyData bool `json:"use_proxy_data,omitempty"`
InitialBalance float32 `json:"initial_balance,omitempty"`
MarketDataSource string `json:"market_data_source,omitempty"`
FrequencyInterval string `json:"frequency_interval,omitempty"`
DepositSchedule AnnuityDepositSchedule `json:"deposit_schedule,omitempty"`
}
Source Files
¶
- api_annuities.go
- api_business_financial_management.go
- api_cards.go
- api_financial_health.go
- api_financial_planning.go
- api_goals.go
- api_life_insurance.go
- api_personal_financial_management.go
- api_portfolio_construction.go
- api_portfolio_management.go
- api_risk_scoring.go
- api_simulations.go
- api_util.go
- auth_configuration.go
- client.go
- configuration.go
- environment.go
- model_accumulation_goal_deposit_config.go
- model_annuity_calculator_accumulation_horizon_request.go
- model_annuity_calculator_annuity_amount_request.go
- model_annuity_calculator_decumulation_horizon_request.go
- model_annuity_calculator_deposit_amount_request.go
- model_annuity_calculator_initial_balance_request.go
- model_annuity_deposit_schedule.go
- model_answer.go
- model_auth.go
- model_backtest_request.go
- model_beneficiary_bequest_config.go
- model_budget_aggregation_account.go
- model_budget_calculator_request.go
- model_budget_component.go
- model_budget_details.go
- model_business_financial_health_check_request.go
- model_business_invoice_analysis_request.go
- model_calculator_deposit_schedule.go
- model_calculator_deposit_schedule1.go
- model_card_analysis_request.go
- model_card_limit_check_request.go
- model_card_transaction_authorization_request.go
- model_cash_analysis_request.go
- model_cash_flow_analysis_request.go
- model_children_education_config.go
- model_customer_analysis_request.go
- model_decision_tree_result_request.go
- model_decumulation_goal_deposit_config.go
- model_dimensional_risk_score_request.go
- model_diversification_score_request.go
- model_education_calculator_annual_cost_request.go
- model_education_calculator_deposit_amount_request.go
- model_education_calculator_percent_covered_request.go
- model_education_config.go
- model_emergency_fund_calculator_request.go
- model_event_study_request.go
- model_fee_analysis_request.go
- model_financial_health_check_request.go
- model_financial_picture_request.go
- model_financial_statement_analysis_request.go
- model_goal_accumulation_allocation_request.go
- model_goal_accumulation_recommendation_request.go
- model_goal_accumulation_status_request.go
- model_goal_config.go
- model_goal_decumulation_allocation_request.go
- model_goal_decumulation_recommendation_request.go
- model_goal_decumulation_status_request.go
- model_goal_withdrawal_config.go
- model_guaranteed_rate_benefit.go
- model_income_config.go
- model_life_insurance_needs_calculator_request.go
- model_location.go
- model_monte_carlo_request.go
- model_mortgage_calculator_down_payment_request.go
- model_mortgage_calculator_home_price_request.go
- model_mortgage_calculator_periodic_payment_request.go
- model_mvo_request.go
- model_opt_config.go
- model_opt_config1.go
- model_order_rebalance_request.go
- model_performance_calculator_request.go
- model_periods.go
- model_portfolio_optimization_score_request.go
- model_portfolio_what_if_request.go
- model_purchase_calculator_amount_request.go
- model_purchase_calculator_deposit_amount_request.go
- model_purchase_calculator_horizon_request.go
- model_ratio_targets.go
- model_ratio_targets1.go
- model_rebalancing_signal_request.go
- model_recommendation_config.go
- model_recommendation_config1.go
- model_recurring_transaction_analysis_request.go
- model_retirement_calculator_deposit_amount_request.go
- model_retirement_calculator_expenses_request.go
- model_retirement_calculator_percent_covered_request.go
- model_risk_allocation_request.go
- model_risk_score_request.go
- model_savings_calculator_request.go
- model_savings_deposit_schedule.go
- model_scenario_analysis_request.go
- model_sensitivity_analysis_request.go
- model_sensitivity_factor.go
- model_settings.go
- model_spending_analysis_request.go
- model_variable_annuity_request.go
- model_w_config.go
- model_w_config1.go
- response.go
Click to show internal directories.
Click to hide internal directories.