Lumiant GraphQL API Reference
Lumiant's GraphQL API
API Endpoints
# Development:
https://lumiantapi-dev.lumiant.com.au/graphql
# QA - Australia:
https://lumiantapi-qa.lumiant.com.au/graphql
# QA - US:
https://lumiantapi-qaus.lumiant.io/graphql
# Production - Australia:
https://lumiantapi.lumiant.com.au/graphql
# Production - US:
https://lumiantapi.lumiant.io/graphql
Version
2.0.0
Queries
advyzonGetLumiantClientAndHouseholdIds
Response
Returns an AdvyzonGetLumiantClientAndHouseholdIdsOutput
Arguments
| Name | Description |
|---|---|
args - AdvyzonGetLumiantClientAndHouseholdIdsRequest
|
Example
Query
query AdvyzonGetLumiantClientAndHouseholdIds($args: AdvyzonGetLumiantClientAndHouseholdIdsRequest) {
advyzonGetLumiantClientAndHouseholdIds(args: $args) {
clientId
householdId
suggestedSearchTerm
}
}
Variables
{"args": AdvyzonGetLumiantClientAndHouseholdIdsRequest}
Response
{
"data": {
"advyzonGetLumiantClientAndHouseholdIds": {
"clientId": "abc123",
"householdId": "xyz789",
"suggestedSearchTerm": "abc123"
}
}
}
checkIfUserOnRdsCognito
Response
Returns a CheckIfUserOnRdsCognitoOutput
Arguments
| Name | Description |
|---|---|
args - CheckIfUserOnRdsCognitoInput
|
Example
Query
query CheckIfUserOnRdsCognito($args: CheckIfUserOnRdsCognitoInput) {
checkIfUserOnRdsCognito(args: $args) {
message
}
}
Variables
{"args": CheckIfUserOnRdsCognitoInput}
Response
{
"data": {
"checkIfUserOnRdsCognito": {
"message": "xyz789"
}
}
}
financialHealthAssessmentSessionByClientId
Response
Arguments
| Name | Description |
|---|---|
clientId - Int!
|
|
sortDirection - ModelSortDirection
|
|
filter - ModelFinancialHealthAssessmentSessionFilterInput
|
|
limit - Int
|
|
nextToken - String
|
Example
Query
query FinancialHealthAssessmentSessionByClientId(
$clientId: Int!,
$sortDirection: ModelSortDirection,
$filter: ModelFinancialHealthAssessmentSessionFilterInput,
$limit: Int,
$nextToken: String
) {
financialHealthAssessmentSessionByClientId(
clientId: $clientId,
sortDirection: $sortDirection,
filter: $filter,
limit: $limit,
nextToken: $nextToken
) {
items {
id
clientId
inviteCode
householdId
status
firstName
lastName
fullName
hasPartner
partnerId
partnerFirstName
partnerLastName
partnerFullName
finHealthAssessmentFull
responses {
questionId
intResponse
stringResponse
section
}
visionGoalsScore
retirementPlanningScore
insuranceAssetProtectionScore
debtCashFlowManagementScore
educationPlanningScore
investmentPlanningScore
incomeTaxPlanningScore
businessPlanningScore
charitablePlanningScore
estatePlanningScore
createdAt
updatedAt
}
nextToken
}
}
Variables
{
"clientId": 123,
"sortDirection": "ASC",
"filter": ModelFinancialHealthAssessmentSessionFilterInput,
"limit": 123,
"nextToken": "abc123"
}
Response
{
"data": {
"financialHealthAssessmentSessionByClientId": {
"items": [FinancialHealthAssessmentSession],
"nextToken": "abc123"
}
}
}
financialHealthAssessmentSessionByInviteCode
Response
Arguments
| Name | Description |
|---|---|
inviteCode - String!
|
|
sortDirection - ModelSortDirection
|
|
filter - ModelFinancialHealthAssessmentSessionFilterInput
|
|
limit - Int
|
|
nextToken - String
|
Example
Query
query FinancialHealthAssessmentSessionByInviteCode(
$inviteCode: String!,
$sortDirection: ModelSortDirection,
$filter: ModelFinancialHealthAssessmentSessionFilterInput,
$limit: Int,
$nextToken: String
) {
financialHealthAssessmentSessionByInviteCode(
inviteCode: $inviteCode,
sortDirection: $sortDirection,
filter: $filter,
limit: $limit,
nextToken: $nextToken
) {
items {
id
clientId
inviteCode
householdId
status
firstName
lastName
fullName
hasPartner
partnerId
partnerFirstName
partnerLastName
partnerFullName
finHealthAssessmentFull
responses {
questionId
intResponse
stringResponse
section
}
visionGoalsScore
retirementPlanningScore
insuranceAssetProtectionScore
debtCashFlowManagementScore
educationPlanningScore
investmentPlanningScore
incomeTaxPlanningScore
businessPlanningScore
charitablePlanningScore
estatePlanningScore
createdAt
updatedAt
}
nextToken
}
}
Variables
{
"inviteCode": "abc123",
"sortDirection": "ASC",
"filter": ModelFinancialHealthAssessmentSessionFilterInput,
"limit": 987,
"nextToken": "xyz789"
}
Response
{
"data": {
"financialHealthAssessmentSessionByInviteCode": {
"items": [FinancialHealthAssessmentSession],
"nextToken": "abc123"
}
}
}
fullS3ObjectPath
Response
Returns a ModelExternalUploadTrackingConnection
Arguments
| Name | Description |
|---|---|
fullS3ObjectPath - String!
|
|
sortDirection - ModelSortDirection
|
|
filter - ModelExternalUploadTrackingFilterInput
|
|
limit - Int
|
|
nextToken - String
|
Example
Query
query FullS3ObjectPath(
$fullS3ObjectPath: String!,
$sortDirection: ModelSortDirection,
$filter: ModelExternalUploadTrackingFilterInput,
$limit: Int,
$nextToken: String
) {
fullS3ObjectPath(
fullS3ObjectPath: $fullS3ObjectPath,
sortDirection: $sortDirection,
filter: $filter,
limit: $limit,
nextToken: $nextToken
) {
items {
id
fullS3ObjectPath
identityId
objectKey
practiceId
clientId
goalId
createdAt
updatedAt
}
nextToken
}
}
Variables
{
"fullS3ObjectPath": "xyz789",
"sortDirection": "ASC",
"filter": ModelExternalUploadTrackingFilterInput,
"limit": 123,
"nextToken": "abc123"
}
Response
{
"data": {
"fullS3ObjectPath": {
"items": [ExternalUploadTracking],
"nextToken": "abc123"
}
}
}
generateAdviserTrendData
Response
Returns a String
Arguments
| Name | Description |
|---|---|
generateAdviserTrendDataInput - GenerateAdviserTrendDataInput
|
Example
Query
query GenerateAdviserTrendData($generateAdviserTrendDataInput: GenerateAdviserTrendDataInput) {
generateAdviserTrendData(generateAdviserTrendDataInput: $generateAdviserTrendDataInput)
}
Variables
{
"generateAdviserTrendDataInput": GenerateAdviserTrendDataInput
}
Response
{
"data": {
"generateAdviserTrendData": "xyz789"
}
}
generateBillableReport
Response
Returns a String
Arguments
| Name | Description |
|---|---|
reportingInput - ReportingInput
|
Example
Query
query GenerateBillableReport($reportingInput: ReportingInput) {
generateBillableReport(reportingInput: $reportingInput)
}
Variables
{"reportingInput": ReportingInput}
Response
{
"data": {
"generateBillableReport": "abc123"
}
}
generateClientHouseholdStats
Response
Returns a String
Arguments
| Name | Description |
|---|---|
generateClientHouseholdStatsInput - GenerateClientHouseholdStatsInput
|
Example
Query
query GenerateClientHouseholdStats($generateClientHouseholdStatsInput: GenerateClientHouseholdStatsInput) {
generateClientHouseholdStats(generateClientHouseholdStatsInput: $generateClientHouseholdStatsInput)
}
Variables
{
"generateClientHouseholdStatsInput": GenerateClientHouseholdStatsInput
}
Response
{
"data": {
"generateClientHouseholdStats": "xyz789"
}
}
generateGrowthReport
Response
Returns a String
Arguments
| Name | Description |
|---|---|
reportingInput - ReportingInput
|
Example
Query
query GenerateGrowthReport($reportingInput: ReportingInput) {
generateGrowthReport(reportingInput: $reportingInput)
}
Variables
{"reportingInput": ReportingInput}
Response
{"data": {"generateGrowthReport": "abc123"}}
generateHouseholdTrendData
Response
Returns a String
Arguments
| Name | Description |
|---|---|
generateHouseholdTrendDataInput - GenerateHouseholdTrendDataInput
|
Example
Query
query GenerateHouseholdTrendData($generateHouseholdTrendDataInput: GenerateHouseholdTrendDataInput) {
generateHouseholdTrendData(generateHouseholdTrendDataInput: $generateHouseholdTrendDataInput)
}
Variables
{
"generateHouseholdTrendDataInput": GenerateHouseholdTrendDataInput
}
Response
{
"data": {
"generateHouseholdTrendData": "xyz789"
}
}
generateModuleUsageStats
Response
Returns a String
Arguments
| Name | Description |
|---|---|
generateModuleUsageStatsInput - GenerateModuleUsageStatsInput
|
Example
Query
query GenerateModuleUsageStats($generateModuleUsageStatsInput: GenerateModuleUsageStatsInput) {
generateModuleUsageStats(generateModuleUsageStatsInput: $generateModuleUsageStatsInput)
}
Variables
{
"generateModuleUsageStatsInput": GenerateModuleUsageStatsInput
}
Response
{
"data": {
"generateModuleUsageStats": "abc123"
}
}
generateOnboardedReport
Response
Returns a String
Arguments
| Name | Description |
|---|---|
reportingInput - ReportingInput
|
Example
Query
query GenerateOnboardedReport($reportingInput: ReportingInput) {
generateOnboardedReport(reportingInput: $reportingInput)
}
Variables
{"reportingInput": ReportingInput}
Response
{
"data": {
"generateOnboardedReport": "abc123"
}
}
generatePracticeTrendData
Response
Returns a String
Arguments
| Name | Description |
|---|---|
generatePracticeTrendDataInput - GeneratePracticeTrendDataInput
|
Example
Query
query GeneratePracticeTrendData($generatePracticeTrendDataInput: GeneratePracticeTrendDataInput) {
generatePracticeTrendData(generatePracticeTrendDataInput: $generatePracticeTrendDataInput)
}
Variables
{
"generatePracticeTrendDataInput": GeneratePracticeTrendDataInput
}
Response
{
"data": {
"generatePracticeTrendData": "abc123"
}
}
generateStaffLastLoginStats
Response
Returns a String
Arguments
| Name | Description |
|---|---|
generateStaffLastLoginStatsInput - GenerateStaffLastLoginStatsInput
|
Example
Query
query GenerateStaffLastLoginStats($generateStaffLastLoginStatsInput: GenerateStaffLastLoginStatsInput) {
generateStaffLastLoginStats(generateStaffLastLoginStatsInput: $generateStaffLastLoginStatsInput)
}
Variables
{
"generateStaffLastLoginStatsInput": GenerateStaffLastLoginStatsInput
}
Response
{
"data": {
"generateStaffLastLoginStats": "abc123"
}
}
generateStatusReport
Response
Returns a String
Arguments
| Name | Description |
|---|---|
reportingInput - ReportingInput
|
Example
Query
query GenerateStatusReport($reportingInput: ReportingInput) {
generateStatusReport(reportingInput: $reportingInput)
}
Variables
{"reportingInput": ReportingInput}
Response
{"data": {"generateStatusReport": "abc123"}}
getAccountNetInvestmentTimeline
Response
Returns an AccountNetInvestmentTimelineOutput
Arguments
| Name | Description |
|---|---|
args - AccountNetInvestmentTimelineInput
|
Example
Query
query GetAccountNetInvestmentTimeline($args: AccountNetInvestmentTimelineInput) {
getAccountNetInvestmentTimeline(args: $args) {
portfolios {
portfolioId
timelineData {
accountValue {
all {
...GraphPointFragment
}
R3Y {
...GraphPointFragment
}
R1Y {
...GraphPointFragment
}
YTD {
...GraphPointFragment
}
R3M {
...GraphPointFragment
}
}
netInvestments {
all {
...GraphPointFragment
}
R3Y {
...GraphPointFragment
}
R1Y {
...GraphPointFragment
}
YTD {
...GraphPointFragment
}
R3M {
...GraphPointFragment
}
}
}
}
}
}
Variables
{"args": AccountNetInvestmentTimelineInput}
Response
{
"data": {
"getAccountNetInvestmentTimeline": {
"portfolios": [AccountNetInvestmentPortfolio]
}
}
}
getAccounts
Response
Returns an AccountData
Arguments
| Name | Description |
|---|---|
clientId - Int
|
Example
Query
query GetAccounts($clientId: Int) {
getAccounts(clientId: $clientId) {
insurance {
accountId
basiqAccountId
basiqConnectionId
clientId
accountNumber
accountName
accountCurrency
accountType
accountSubtype
accountClassProduct
availableRedraw
lifeInsurance
lifeCovered
incomeProtection
incomeCovered
traumaInsurance
traumaCovered
businessExpenseInsurance
businessExpenseCovered
severityBasedInsurance
severityBasedCovered
tpdInsurance
tpdCovered
maturityDate
fee
instalmentAmount
interestRate
interestType
nextInstalmentDate
offsetAccountNumber
repaymentFrequency
repaymentType
balance
commencementDate
availableFunds
limit
lastUpdated
transactionIntervalsFrom
transactionIntervalsTo
institution
accountHolder
basiqDataId
paymentAmount
payoutPaymentAccount
payoutDetails
payoutWaitingPeriod
payoutLength
otherLoanType
deleted
deletedBy
policyEndDate
policyStatus
}
savings {
accountId
basiqAccountId
basiqConnectionId
clientId
accountNumber
accountName
accountCurrency
accountType
accountSubtype
accountClassProduct
availableRedraw
lifeInsurance
lifeCovered
incomeProtection
incomeCovered
traumaInsurance
traumaCovered
businessExpenseInsurance
businessExpenseCovered
severityBasedInsurance
severityBasedCovered
tpdInsurance
tpdCovered
maturityDate
fee
instalmentAmount
interestRate
interestType
nextInstalmentDate
offsetAccountNumber
repaymentFrequency
repaymentType
balance
commencementDate
availableFunds
limit
lastUpdated
transactionIntervalsFrom
transactionIntervalsTo
institution
accountHolder
basiqDataId
paymentAmount
payoutPaymentAccount
payoutDetails
payoutWaitingPeriod
payoutLength
otherLoanType
deleted
deletedBy
policyEndDate
policyStatus
}
debt {
accountId
basiqAccountId
basiqConnectionId
clientId
accountNumber
accountName
accountCurrency
accountType
accountSubtype
accountClassProduct
availableRedraw
lifeInsurance
lifeCovered
incomeProtection
incomeCovered
traumaInsurance
traumaCovered
businessExpenseInsurance
businessExpenseCovered
severityBasedInsurance
severityBasedCovered
tpdInsurance
tpdCovered
maturityDate
fee
instalmentAmount
interestRate
interestType
nextInstalmentDate
offsetAccountNumber
repaymentFrequency
repaymentType
balance
commencementDate
availableFunds
limit
lastUpdated
transactionIntervalsFrom
transactionIntervalsTo
institution
accountHolder
basiqDataId
paymentAmount
payoutPaymentAccount
payoutDetails
payoutWaitingPeriod
payoutLength
otherLoanType
deleted
deletedBy
policyEndDate
policyStatus
}
}
}
Variables
{"clientId": 987}
Response
{
"data": {
"getAccounts": {
"insurance": [Account],
"savings": [Account],
"debt": [Account]
}
}
}
getAsset
Response
Returns an AssetOutput
Arguments
| Name | Description |
|---|---|
args - GetAssetInput!
|
Example
Query
query GetAsset($args: GetAssetInput!) {
getAsset(args: $args) {
assetId
householdId
clientId
clientFirstName
clientLastName
clientPreferredName
legalEntityId
legalEntityName
beneficiaryClientId
beneficiaryLegalEntityId
otherBeneficiary
relationshipAsset
assetType
superType
pensionType
description
accountNumber
providerName
memberNumber
balance
definedBenefitSalary
definedBenefitMultiple
employeeContribution
employeeContributionBps
employeeContributionType
employeeContributionCap
employeeContributionCapBps
employerContribution
employerContributionBps
employerContributionCap
employerContributionCapBps
makesPersonalContribution
annualContribution
inheritedIraType
deceasedOwnerDateOfBirth
deceasedOwnerDateOfDeath
rmdTakenThisYear
previousYearBalance
annuityTermDate
deathBenefit
surrenderValue
centrelinkValue
isUsedLoanSecurity
loanSecuredAmount
madePersonalContribPast3y
taxFreeComponent
preservationComponent
makesPersonalSuperContribution
isSalarySacrifice
superContributionAmount
superContributionFrequency
employerPaysHigherThanMinimumSuper
higherThanMinimumSuperBps
preRetirementRefModel
postRetirementRefModel
feesBps
feesDollar
addressId
ownOrRent
isPrimaryHome
purchasePrice
purchaseDate
growthBps
currentValue
propertyType
rent
savingInvestmentType
assetUse
assessed
make
model
lastValued
superPhase
annuityType
term
maturityDate
commutedAmount
residualValue
assetExemptionBps
notes
clientNotes
partnerNotes
confidentialNotes
displayName
displayOwnership
externalSystem
assetYodleeMapping {
providerAccountId
additionalStatus
additionalStatusDescription
lastUpdated
isBroken
createdBy
created
updatedBy
updated
}
createdBy
created
updatedBy
updated
constructedAddress
addressLine1
addressLine2
suburb
postCode
state
country
linkedLoan
}
}
Variables
{"args": GetAssetInput}
Response
{
"data": {
"getAsset": {
"assetId": 123,
"householdId": 123,
"clientId": 123,
"clientFirstName": "xyz789",
"clientLastName": "xyz789",
"clientPreferredName": "xyz789",
"legalEntityId": 987,
"legalEntityName": "abc123",
"beneficiaryClientId": 123,
"beneficiaryLegalEntityId": 123,
"otherBeneficiary": "xyz789",
"relationshipAsset": "abc123",
"assetType": "abc123",
"superType": "abc123",
"pensionType": "abc123",
"description": "abc123",
"accountNumber": "abc123",
"providerName": "abc123",
"memberNumber": "xyz789",
"balance": 987.65,
"definedBenefitSalary": 123.45,
"definedBenefitMultiple": 123.45,
"employeeContribution": 123.45,
"employeeContributionBps": 987.65,
"employeeContributionType": "xyz789",
"employeeContributionCap": 987.65,
"employeeContributionCapBps": 987.65,
"employerContribution": 987.65,
"employerContributionBps": 123.45,
"employerContributionCap": 987.65,
"employerContributionCapBps": 987.65,
"makesPersonalContribution": true,
"annualContribution": 123.45,
"inheritedIraType": "abc123",
"deceasedOwnerDateOfBirth": "abc123",
"deceasedOwnerDateOfDeath": "abc123",
"rmdTakenThisYear": false,
"previousYearBalance": 987.65,
"annuityTermDate": "xyz789",
"deathBenefit": 987.65,
"surrenderValue": 123.45,
"centrelinkValue": 123.45,
"isUsedLoanSecurity": true,
"loanSecuredAmount": 987.65,
"madePersonalContribPast3y": true,
"taxFreeComponent": 987.65,
"preservationComponent": 123.45,
"makesPersonalSuperContribution": false,
"isSalarySacrifice": false,
"superContributionAmount": 987.65,
"superContributionFrequency": "abc123",
"employerPaysHigherThanMinimumSuper": false,
"higherThanMinimumSuperBps": 123.45,
"preRetirementRefModel": 987,
"postRetirementRefModel": 987,
"feesBps": 987.65,
"feesDollar": 987.65,
"addressId": 987,
"ownOrRent": "abc123",
"isPrimaryHome": true,
"purchasePrice": 123.45,
"purchaseDate": "xyz789",
"growthBps": 123.45,
"currentValue": 123.45,
"propertyType": "xyz789",
"rent": 987.65,
"savingInvestmentType": "xyz789",
"assetUse": "xyz789",
"assessed": true,
"make": "abc123",
"model": "xyz789",
"lastValued": "abc123",
"superPhase": "abc123",
"annuityType": "xyz789",
"term": 987,
"maturityDate": "abc123",
"commutedAmount": 123.45,
"residualValue": 987.65,
"assetExemptionBps": 987.65,
"notes": "abc123",
"clientNotes": "abc123",
"partnerNotes": "abc123",
"confidentialNotes": "abc123",
"displayName": "xyz789",
"displayOwnership": 123,
"externalSystem": "IL",
"assetYodleeMapping": YodleeMapping,
"createdBy": "abc123",
"created": "xyz789",
"updatedBy": "xyz789",
"updated": "xyz789",
"constructedAddress": "abc123",
"addressLine1": "abc123",
"addressLine2": "abc123",
"suburb": "xyz789",
"postCode": "xyz789",
"state": "abc123",
"country": "abc123",
"linkedLoan": 987
}
}
}
getAssetTree
Response
Returns an AssetTreeOutput
Example
Query
query GetAssetTree {
getAssetTree {
assetTree {
assetTreeId
invGroup {
invGroupId
name
description
isGrowth
}
region {
regionId
name
altName
parentRegion {
regionId
name
altName
parentRegion {
...RegionFragment
}
}
}
assetClass {
assetClassId
name
}
sector {
sectorId
name
}
}
}
}
Response
{"data": {"getAssetTree": {"assetTree": [AssetTree]}}}
getAssets
Response
Returns [AssetOutput]
Arguments
| Name | Description |
|---|---|
args - GetAssetsInput!
|
Example
Query
query GetAssets($args: GetAssetsInput!) {
getAssets(args: $args) {
assetId
householdId
clientId
clientFirstName
clientLastName
clientPreferredName
legalEntityId
legalEntityName
beneficiaryClientId
beneficiaryLegalEntityId
otherBeneficiary
relationshipAsset
assetType
superType
pensionType
description
accountNumber
providerName
memberNumber
balance
definedBenefitSalary
definedBenefitMultiple
employeeContribution
employeeContributionBps
employeeContributionType
employeeContributionCap
employeeContributionCapBps
employerContribution
employerContributionBps
employerContributionCap
employerContributionCapBps
makesPersonalContribution
annualContribution
inheritedIraType
deceasedOwnerDateOfBirth
deceasedOwnerDateOfDeath
rmdTakenThisYear
previousYearBalance
annuityTermDate
deathBenefit
surrenderValue
centrelinkValue
isUsedLoanSecurity
loanSecuredAmount
madePersonalContribPast3y
taxFreeComponent
preservationComponent
makesPersonalSuperContribution
isSalarySacrifice
superContributionAmount
superContributionFrequency
employerPaysHigherThanMinimumSuper
higherThanMinimumSuperBps
preRetirementRefModel
postRetirementRefModel
feesBps
feesDollar
addressId
ownOrRent
isPrimaryHome
purchasePrice
purchaseDate
growthBps
currentValue
propertyType
rent
savingInvestmentType
assetUse
assessed
make
model
lastValued
superPhase
annuityType
term
maturityDate
commutedAmount
residualValue
assetExemptionBps
notes
clientNotes
partnerNotes
confidentialNotes
displayName
displayOwnership
externalSystem
assetYodleeMapping {
providerAccountId
additionalStatus
additionalStatusDescription
lastUpdated
isBroken
createdBy
created
updatedBy
updated
}
createdBy
created
updatedBy
updated
constructedAddress
addressLine1
addressLine2
suburb
postCode
state
country
linkedLoan
}
}
Variables
{"args": GetAssetsInput}
Response
{
"data": {
"getAssets": [
{
"assetId": 123,
"householdId": 123,
"clientId": 123,
"clientFirstName": "abc123",
"clientLastName": "abc123",
"clientPreferredName": "xyz789",
"legalEntityId": 987,
"legalEntityName": "xyz789",
"beneficiaryClientId": 987,
"beneficiaryLegalEntityId": 123,
"otherBeneficiary": "xyz789",
"relationshipAsset": "abc123",
"assetType": "xyz789",
"superType": "abc123",
"pensionType": "xyz789",
"description": "xyz789",
"accountNumber": "abc123",
"providerName": "abc123",
"memberNumber": "xyz789",
"balance": 123.45,
"definedBenefitSalary": 123.45,
"definedBenefitMultiple": 987.65,
"employeeContribution": 123.45,
"employeeContributionBps": 123.45,
"employeeContributionType": "xyz789",
"employeeContributionCap": 987.65,
"employeeContributionCapBps": 123.45,
"employerContribution": 987.65,
"employerContributionBps": 987.65,
"employerContributionCap": 123.45,
"employerContributionCapBps": 123.45,
"makesPersonalContribution": false,
"annualContribution": 123.45,
"inheritedIraType": "xyz789",
"deceasedOwnerDateOfBirth": "xyz789",
"deceasedOwnerDateOfDeath": "abc123",
"rmdTakenThisYear": false,
"previousYearBalance": 987.65,
"annuityTermDate": "abc123",
"deathBenefit": 987.65,
"surrenderValue": 123.45,
"centrelinkValue": 987.65,
"isUsedLoanSecurity": true,
"loanSecuredAmount": 987.65,
"madePersonalContribPast3y": false,
"taxFreeComponent": 987.65,
"preservationComponent": 987.65,
"makesPersonalSuperContribution": true,
"isSalarySacrifice": true,
"superContributionAmount": 987.65,
"superContributionFrequency": "abc123",
"employerPaysHigherThanMinimumSuper": true,
"higherThanMinimumSuperBps": 123.45,
"preRetirementRefModel": 123,
"postRetirementRefModel": 123,
"feesBps": 123.45,
"feesDollar": 987.65,
"addressId": 987,
"ownOrRent": "xyz789",
"isPrimaryHome": false,
"purchasePrice": 987.65,
"purchaseDate": "abc123",
"growthBps": 123.45,
"currentValue": 123.45,
"propertyType": "xyz789",
"rent": 987.65,
"savingInvestmentType": "xyz789",
"assetUse": "xyz789",
"assessed": true,
"make": "abc123",
"model": "abc123",
"lastValued": "xyz789",
"superPhase": "abc123",
"annuityType": "abc123",
"term": 123,
"maturityDate": "xyz789",
"commutedAmount": 987.65,
"residualValue": 987.65,
"assetExemptionBps": 123.45,
"notes": "abc123",
"clientNotes": "xyz789",
"partnerNotes": "xyz789",
"confidentialNotes": "xyz789",
"displayName": "abc123",
"displayOwnership": 987,
"externalSystem": "IL",
"assetYodleeMapping": YodleeMapping,
"createdBy": "abc123",
"created": "abc123",
"updatedBy": "xyz789",
"updated": "xyz789",
"constructedAddress": "abc123",
"addressLine1": "abc123",
"addressLine2": "xyz789",
"suburb": "xyz789",
"postCode": "abc123",
"state": "xyz789",
"country": "abc123",
"linkedLoan": 987
}
]
}
}
getBankingMetadata
Response
Returns a BankingMetadata
Arguments
| Name | Description |
|---|---|
clientId - Int
|
Example
Query
query GetBankingMetadata($clientId: Int) {
getBankingMetadata(clientId: $clientId) {
clientId
basiqUserId
basiqAuthToken
basiqLastError
createdBy
created
updatedBy
updated
}
}
Variables
{"clientId": 123}
Response
{
"data": {
"getBankingMetadata": {
"clientId": 123,
"basiqUserId": "xyz789",
"basiqAuthToken": "xyz789",
"basiqLastError": "xyz789",
"createdBy": "abc123",
"created": "xyz789",
"updatedBy": "abc123",
"updated": "xyz789"
}
}
}
getBasiqConnections
Response
Returns [BasiqConnection]
Arguments
| Name | Description |
|---|---|
clientId - Int
|
Example
Query
query GetBasiqConnections($clientId: Int) {
getBasiqConnections(clientId: $clientId) {
basiqId
status
lastUsed
institution
}
}
Variables
{"clientId": 123}
Response
{
"data": {
"getBasiqConnections": [
{
"basiqId": "abc123",
"status": "abc123",
"lastUsed": "xyz789",
"institution": "abc123"
}
]
}
}
getBeneficiaries
Response
Returns [BeneficiaryOutput]
Arguments
| Name | Description |
|---|---|
args - GetBeneficiariesInput!
|
Example
Query
query GetBeneficiaries($args: GetBeneficiariesInput!) {
getBeneficiaries(args: $args) {
beneficiaryId
estatePlanningId
isPrimary
firstName
middleName
lastName
companyName
relationshipType
nominatedPercentage
ageEntitlement
notes
clientNotes
partnerNotes
confidentialNotes
createdBy
created
updatedBy
updated
}
}
Variables
{"args": GetBeneficiariesInput}
Response
{
"data": {
"getBeneficiaries": [
{
"beneficiaryId": 123,
"estatePlanningId": 123,
"isPrimary": true,
"firstName": "xyz789",
"middleName": "xyz789",
"lastName": "xyz789",
"companyName": "abc123",
"relationshipType": "abc123",
"nominatedPercentage": 123.45,
"ageEntitlement": 987,
"notes": "abc123",
"clientNotes": "xyz789",
"partnerNotes": "xyz789",
"confidentialNotes": "abc123",
"createdBy": "xyz789",
"created": "abc123",
"updatedBy": "xyz789",
"updated": "abc123"
}
]
}
}
getBeneficiary
Response
Returns a BeneficiaryOutput
Arguments
| Name | Description |
|---|---|
args - GetBeneficiaryInput!
|
Example
Query
query GetBeneficiary($args: GetBeneficiaryInput!) {
getBeneficiary(args: $args) {
beneficiaryId
estatePlanningId
isPrimary
firstName
middleName
lastName
companyName
relationshipType
nominatedPercentage
ageEntitlement
notes
clientNotes
partnerNotes
confidentialNotes
createdBy
created
updatedBy
updated
}
}
Variables
{"args": GetBeneficiaryInput}
Response
{
"data": {
"getBeneficiary": {
"beneficiaryId": 123,
"estatePlanningId": 123,
"isPrimary": true,
"firstName": "abc123",
"middleName": "abc123",
"lastName": "xyz789",
"companyName": "abc123",
"relationshipType": "abc123",
"nominatedPercentage": 123.45,
"ageEntitlement": 987,
"notes": "abc123",
"clientNotes": "xyz789",
"partnerNotes": "abc123",
"confidentialNotes": "abc123",
"createdBy": "abc123",
"created": "xyz789",
"updatedBy": "abc123",
"updated": "xyz789"
}
}
}
getBestLifeScenario
Response
Returns a BestLifeProjectionOutput
Arguments
| Name | Description |
|---|---|
args - GetBestLifeScenarioInput
|
Example
Query
query GetBestLifeScenario($args: GetBestLifeScenarioInput) {
getBestLifeScenario(args: $args) {
scenarioId
name
timeline {
data
}
chart {
data
chartSchema
timeMarkers
dataMarkers
}
latestInputs {
data {
scenarioId
name
includeClient
clientAge
clientIncome
clientSuperannuation
clientSuperannuationContribution
clientSuperannuationContributionIsInDollars
clientSuperannuationMatchBps
clientSuperannuationMatchEndsBps
clientSuperannuationFee
clientSuperannuationFeeIsInDollars
clientSuperOther
clientSuperOtherContribution
clientSuperOtherContributionIsInDollars
clientSuperOtherFee
clientSuperOtherFeeIsInDollars
clientRetirementAge
clientPensionPaidFromAge
clientLifeExpectancyAge
clientIncomeRateChange
includePartner
partnerAge
partnerIncome
partnerSuperannuation
partnerSuperannuationContribution
partnerSuperannuationContributionIsInDollars
partnerSuperannuationMatchBps
partnerSuperannuationMatchEndsBps
partnerSuperannuationFee
partnerSuperannuationFeeIsInDollars
partnerSuperOther
partnerSuperOtherContribution
partnerSuperOtherContributionIsInDollars
partnerSuperOtherFee
partnerSuperOtherFeeIsInDollars
partnerRetirementAge
partnerPensionPaidFromAge
partnerLifeExpectancyAge
partnerIncomeRateChange
businessValueGrowthPerAnnum
businessValue
businessEstimatedDateOfSale
businessEstimatedSaleAmount
businessEstimatedTaxOnSale
householdPersonalAssets
householdPersonalDebt
householdProperty
householdPropertyDebt
householdInvestmentProperties
householdInvestmentPropertiesDebt
householdNonSuperInvestments
householdNonSuperInvestmentsFee
householdNonSuperInvestmentsFeeIsInDollars
householdPreRetirementAvgTax
householdPostRetirementAvgTax
householdIncome
householdSavings
householdCashFlow {
id
year
clientAge
clientIncome
clientStatus
partnerAge
partnerIncome
partnerStatus
householdIncome
totalIncome
incomeSaved
incomeSpent
reqRetirementIncome
contribution
withdrawal
}
householdCashFlowHeader
reqRetirementIncome
reqRetirementIncomeRateChange
referenceModel
bestLifeScore
excessCashAllocations {
allocationEnabled
allocationType
allocationRank
maxAmountDollar
maxAmountBps
}
reduceShortfallAllocations {
allocationEnabled
allocationType
allocationRank
maxAmountDollar
maxAmountBps
}
}
}
report {
data
}
}
}
Variables
{"args": GetBestLifeScenarioInput}
Response
{
"data": {
"getBestLifeScenario": {
"scenarioId": 123,
"name": "abc123",
"timeline": BestLifeProjectionTimelineData,
"chart": BestLifeProjectionChartData,
"latestInputs": BestLifeProjectionLatestInputsData,
"report": BestLifeReportData
}
}
}
getBestLifeScenarios
Response
Returns [BestLifeProjectionOutput]
Arguments
| Name | Description |
|---|---|
args - GetBestLifeScenariosInput
|
Example
Query
query GetBestLifeScenarios($args: GetBestLifeScenariosInput) {
getBestLifeScenarios(args: $args) {
scenarioId
name
timeline {
data
}
chart {
data
chartSchema
timeMarkers
dataMarkers
}
latestInputs {
data {
scenarioId
name
includeClient
clientAge
clientIncome
clientSuperannuation
clientSuperannuationContribution
clientSuperannuationContributionIsInDollars
clientSuperannuationMatchBps
clientSuperannuationMatchEndsBps
clientSuperannuationFee
clientSuperannuationFeeIsInDollars
clientSuperOther
clientSuperOtherContribution
clientSuperOtherContributionIsInDollars
clientSuperOtherFee
clientSuperOtherFeeIsInDollars
clientRetirementAge
clientPensionPaidFromAge
clientLifeExpectancyAge
clientIncomeRateChange
includePartner
partnerAge
partnerIncome
partnerSuperannuation
partnerSuperannuationContribution
partnerSuperannuationContributionIsInDollars
partnerSuperannuationMatchBps
partnerSuperannuationMatchEndsBps
partnerSuperannuationFee
partnerSuperannuationFeeIsInDollars
partnerSuperOther
partnerSuperOtherContribution
partnerSuperOtherContributionIsInDollars
partnerSuperOtherFee
partnerSuperOtherFeeIsInDollars
partnerRetirementAge
partnerPensionPaidFromAge
partnerLifeExpectancyAge
partnerIncomeRateChange
businessValueGrowthPerAnnum
businessValue
businessEstimatedDateOfSale
businessEstimatedSaleAmount
businessEstimatedTaxOnSale
householdPersonalAssets
householdPersonalDebt
householdProperty
householdPropertyDebt
householdInvestmentProperties
householdInvestmentPropertiesDebt
householdNonSuperInvestments
householdNonSuperInvestmentsFee
householdNonSuperInvestmentsFeeIsInDollars
householdPreRetirementAvgTax
householdPostRetirementAvgTax
householdIncome
householdSavings
householdCashFlow {
id
year
clientAge
clientIncome
clientStatus
partnerAge
partnerIncome
partnerStatus
householdIncome
totalIncome
incomeSaved
incomeSpent
reqRetirementIncome
contribution
withdrawal
}
householdCashFlowHeader
reqRetirementIncome
reqRetirementIncomeRateChange
referenceModel
bestLifeScore
excessCashAllocations {
allocationEnabled
allocationType
allocationRank
maxAmountDollar
maxAmountBps
}
reduceShortfallAllocations {
allocationEnabled
allocationType
allocationRank
maxAmountDollar
maxAmountBps
}
}
}
report {
data
}
}
}
Variables
{"args": GetBestLifeScenariosInput}
Response
{
"data": {
"getBestLifeScenarios": [
{
"scenarioId": 123,
"name": "abc123",
"timeline": BestLifeProjectionTimelineData,
"chart": BestLifeProjectionChartData,
"latestInputs": BestLifeProjectionLatestInputsData,
"report": BestLifeReportData
}
]
}
}
getBestLifeScore
Response
Returns a Float
Arguments
| Name | Description |
|---|---|
args - GetBestLifeScoreInput
|
Example
Query
query GetBestLifeScore($args: GetBestLifeScoreInput) {
getBestLifeScore(args: $args)
}
Variables
{"args": GetBestLifeScoreInput}
Response
{"data": {"getBestLifeScore": 987.65}}
getBusinessPlanning
Response
Returns a BusinessPlanningOutput
Arguments
| Name | Description |
|---|---|
args - GetBusinessPlanningInput!
|
Example
Query
query GetBusinessPlanning($args: GetBusinessPlanningInput!) {
getBusinessPlanning(args: $args) {
businessPlanningId
householdId
clientId
legalEntityId
hasBusinessDocuments
createdBy
created
updatedBy
updated
}
}
Variables
{"args": GetBusinessPlanningInput}
Response
{
"data": {
"getBusinessPlanning": {
"businessPlanningId": 987,
"householdId": 123,
"clientId": 987,
"legalEntityId": 987,
"hasBusinessDocuments": false,
"createdBy": "xyz789",
"created": "abc123",
"updatedBy": "abc123",
"updated": "xyz789"
}
}
}
getBusinessPlannings
Response
Returns [BusinessPlanningOutput]
Arguments
| Name | Description |
|---|---|
args - GetBusinessPlanningsInput!
|
Example
Query
query GetBusinessPlannings($args: GetBusinessPlanningsInput!) {
getBusinessPlannings(args: $args) {
businessPlanningId
householdId
clientId
legalEntityId
hasBusinessDocuments
createdBy
created
updatedBy
updated
}
}
Variables
{"args": GetBusinessPlanningsInput}
Response
{
"data": {
"getBusinessPlannings": [
{
"businessPlanningId": 123,
"householdId": 987,
"clientId": 987,
"legalEntityId": 123,
"hasBusinessDocuments": true,
"createdBy": "xyz789",
"created": "xyz789",
"updatedBy": "xyz789",
"updated": "xyz789"
}
]
}
}
getCharitablePlanning
Response
Returns a CharitablePlanningOutput
Arguments
| Name | Description |
|---|---|
args - GetCharitablePlanningInput!
|
Example
Query
query GetCharitablePlanning($args: GetCharitablePlanningInput!) {
getCharitablePlanning(args: $args) {
charitablePlanningId
householdId
clientId
legalEntityId
hasCharitableFoundation
createdBy
created
updatedBy
updated
}
}
Variables
{"args": GetCharitablePlanningInput}
Response
{
"data": {
"getCharitablePlanning": {
"charitablePlanningId": 123,
"householdId": 123,
"clientId": 987,
"legalEntityId": 123,
"hasCharitableFoundation": true,
"createdBy": "abc123",
"created": "xyz789",
"updatedBy": "xyz789",
"updated": "xyz789"
}
}
}
getCharitablePlannings
Response
Returns [CharitablePlanningOutput]
Arguments
| Name | Description |
|---|---|
args - GetCharitablePlanningsInput!
|
Example
Query
query GetCharitablePlannings($args: GetCharitablePlanningsInput!) {
getCharitablePlannings(args: $args) {
charitablePlanningId
householdId
clientId
legalEntityId
hasCharitableFoundation
createdBy
created
updatedBy
updated
}
}
Variables
{"args": GetCharitablePlanningsInput}
Response
{
"data": {
"getCharitablePlannings": [
{
"charitablePlanningId": 123,
"householdId": 123,
"clientId": 123,
"legalEntityId": 987,
"hasCharitableFoundation": false,
"createdBy": "xyz789",
"created": "xyz789",
"updatedBy": "abc123",
"updated": "xyz789"
}
]
}
}
getClient
Response
Returns a Client
Arguments
| Name | Description |
|---|---|
args - ClientOrInviteCodeInput
|
Example
Query
query GetClient($args: ClientOrInviteCodeInput) {
getClient(args: $args) {
clientId
householdId
iamId
wealthIds
type
title
firstName
middleName
lastName
preferredName
dob
lastLogin
registered
billableStart
address {
addressId
constructedAddress
addressLine1
addressLine2
suburb
postCode
state
country
createdBy
created
updatedBy
updated
}
postalAddress {
addressId
constructedAddress
addressLine1
addressLine2
suburb
postCode
state
country
createdBy
created
updatedBy
updated
}
contactDetails {
emailAddress
mobileNumber
faxNumber
phoneNumber
createdBy
created
updatedBy
updated
}
moduleStates {
moduleStateId
clientId
previouslyCompleted
module
moduleState
sentDate
sentReminders
startedDate
startedReminders
finishedDate
expiredDate
updatedBy
updated
}
wellnessScore
goalCount
taskCount
sex
relationshipStatus
countryCodeBirth
countryCodeResidency
countryCodeCitizenship
notes
externalId
externalSystem
createdBy
created
updatedBy
updated
}
}
Variables
{"args": ClientOrInviteCodeInput}
Response
{
"data": {
"getClient": {
"clientId": 123,
"householdId": 123,
"iamId": "xyz789",
"wealthIds": ["abc123"],
"type": "abc123",
"title": "xyz789",
"firstName": "xyz789",
"middleName": "xyz789",
"lastName": "abc123",
"preferredName": "xyz789",
"dob": "xyz789",
"lastLogin": "xyz789",
"registered": false,
"billableStart": "abc123",
"address": Address,
"postalAddress": Address,
"contactDetails": ContactDetails,
"moduleStates": [ModuleState],
"wellnessScore": 987.65,
"goalCount": 987,
"taskCount": 123,
"sex": "abc123",
"relationshipStatus": "xyz789",
"countryCodeBirth": "xyz789",
"countryCodeResidency": "xyz789",
"countryCodeCitizenship": "abc123",
"notes": "xyz789",
"externalId": "abc123",
"externalSystem": "xyz789",
"createdBy": "abc123",
"created": "xyz789",
"updatedBy": "xyz789",
"updated": "xyz789"
}
}
}
getClientActions
Response
Returns a GetClientActionsOutput
Arguments
| Name | Description |
|---|---|
args - GetClientActionsInput
|
Example
Query
query GetClientActions($args: GetClientActionsInput) {
getClientActions(args: $args) {
clientActions {
householdId
names
description
itemType
}
}
}
Variables
{"args": GetClientActionsInput}
Response
{
"data": {
"getClientActions": {"clientActions": [ClientAction]}
}
}
getClientConfig
Response
Returns a ClientConfig
Arguments
| Name | Description |
|---|---|
args - GetClientConfig
|
Example
Query
query GetClientConfig($args: GetClientConfig) {
getClientConfig(args: $args) {
clientConfigId
clientId
configuration {
inAppNotifications {
enabled
}
governanceConfig {
hideEmptySections
}
}
}
}
Variables
{"args": GetClientConfig}
Response
{
"data": {
"getClientConfig": {
"clientConfigId": 987,
"clientId": 123,
"configuration": ClientConfigConfiguration
}
}
}
getClientWealthIds
Response
Returns [String]
Arguments
| Name | Description |
|---|---|
args - GetClientWealthIdsInput!
|
Example
Query
query GetClientWealthIds($args: GetClientWealthIdsInput!) {
getClientWealthIds(args: $args)
}
Variables
{"args": GetClientWealthIdsInput}
Response
{"data": {"getClientWealthIds": ["xyz789"]}}
getClientWellnessHistory
Response
Returns [WellnessScore]
Arguments
| Name | Description |
|---|---|
getClientWellnessHistoryInput - ClientWellnessHistoryInput
|
Example
Query
query GetClientWellnessHistory($getClientWellnessHistoryInput: ClientWellnessHistoryInput) {
getClientWellnessHistory(getClientWellnessHistoryInput: $getClientWellnessHistoryInput) {
date
wellnessScore
lifeScore
valuesScore
goalsScore
tasksScore
kaaScore
components
}
}
Variables
{
"getClientWellnessHistoryInput": ClientWellnessHistoryInput
}
Response
{
"data": {
"getClientWellnessHistory": [
{
"date": "abc123",
"wellnessScore": 123.45,
"lifeScore": 987.65,
"valuesScore": 123.45,
"goalsScore": 123.45,
"tasksScore": 123.45,
"kaaScore": 987.65,
"components": "xyz789"
}
]
}
}
getClientYodleeToken
Response
Returns a GetClientYodleeTokenOutput
Arguments
| Name | Description |
|---|---|
args - GetClientYodleeTokenInput!
|
Example
Query
query GetClientYodleeToken($args: GetClientYodleeTokenInput!) {
getClientYodleeToken(args: $args) {
token
fastlink_url
}
}
Variables
{"args": GetClientYodleeTokenInput}
Response
{
"data": {
"getClientYodleeToken": {
"token": "abc123",
"fastlink_url": "xyz789"
}
}
}
getClients
Response
Returns a GetClientsOutput
Arguments
| Name | Description |
|---|---|
args - GetClientsInput
|
Example
Query
query GetClients($args: GetClientsInput) {
getClients(args: $args) {
clients {
clientId
householdId
iamId
wealthIds
type
title
firstName
middleName
lastName
preferredName
dob
lastLogin
registered
billableStart
address {
addressId
constructedAddress
addressLine1
addressLine2
suburb
postCode
state
country
createdBy
created
updatedBy
updated
}
postalAddress {
addressId
constructedAddress
addressLine1
addressLine2
suburb
postCode
state
country
createdBy
created
updatedBy
updated
}
contactDetails {
emailAddress
mobileNumber
faxNumber
phoneNumber
createdBy
created
updatedBy
updated
}
moduleStates {
moduleStateId
clientId
previouslyCompleted
module
moduleState
sentDate
sentReminders
startedDate
startedReminders
finishedDate
expiredDate
updatedBy
updated
}
wellnessScore
goalCount
taskCount
sex
relationshipStatus
countryCodeBirth
countryCodeResidency
countryCodeCitizenship
notes
externalId
externalSystem
createdBy
created
updatedBy
updated
}
pagination {
page
pageSize
numPages
numItems
}
}
}
Variables
{"args": GetClientsInput}
Response
{
"data": {
"getClients": {
"clients": [Client],
"pagination": Pagination
}
}
}
getDefaultScenarioBestLifeProjection
Response
Returns a BestLifeProjectionOutput
Arguments
| Name | Description |
|---|---|
args - DefaultScenarioBestLifeProjectionInput
|
Example
Query
query GetDefaultScenarioBestLifeProjection($args: DefaultScenarioBestLifeProjectionInput) {
getDefaultScenarioBestLifeProjection(args: $args) {
scenarioId
name
timeline {
data
}
chart {
data
chartSchema
timeMarkers
dataMarkers
}
latestInputs {
data {
scenarioId
name
includeClient
clientAge
clientIncome
clientSuperannuation
clientSuperannuationContribution
clientSuperannuationContributionIsInDollars
clientSuperannuationMatchBps
clientSuperannuationMatchEndsBps
clientSuperannuationFee
clientSuperannuationFeeIsInDollars
clientSuperOther
clientSuperOtherContribution
clientSuperOtherContributionIsInDollars
clientSuperOtherFee
clientSuperOtherFeeIsInDollars
clientRetirementAge
clientPensionPaidFromAge
clientLifeExpectancyAge
clientIncomeRateChange
includePartner
partnerAge
partnerIncome
partnerSuperannuation
partnerSuperannuationContribution
partnerSuperannuationContributionIsInDollars
partnerSuperannuationMatchBps
partnerSuperannuationMatchEndsBps
partnerSuperannuationFee
partnerSuperannuationFeeIsInDollars
partnerSuperOther
partnerSuperOtherContribution
partnerSuperOtherContributionIsInDollars
partnerSuperOtherFee
partnerSuperOtherFeeIsInDollars
partnerRetirementAge
partnerPensionPaidFromAge
partnerLifeExpectancyAge
partnerIncomeRateChange
businessValueGrowthPerAnnum
businessValue
businessEstimatedDateOfSale
businessEstimatedSaleAmount
businessEstimatedTaxOnSale
householdPersonalAssets
householdPersonalDebt
householdProperty
householdPropertyDebt
householdInvestmentProperties
householdInvestmentPropertiesDebt
householdNonSuperInvestments
householdNonSuperInvestmentsFee
householdNonSuperInvestmentsFeeIsInDollars
householdPreRetirementAvgTax
householdPostRetirementAvgTax
householdIncome
householdSavings
householdCashFlow {
id
year
clientAge
clientIncome
clientStatus
partnerAge
partnerIncome
partnerStatus
householdIncome
totalIncome
incomeSaved
incomeSpent
reqRetirementIncome
contribution
withdrawal
}
householdCashFlowHeader
reqRetirementIncome
reqRetirementIncomeRateChange
referenceModel
bestLifeScore
excessCashAllocations {
allocationEnabled
allocationType
allocationRank
maxAmountDollar
maxAmountBps
}
reduceShortfallAllocations {
allocationEnabled
allocationType
allocationRank
maxAmountDollar
maxAmountBps
}
}
}
report {
data
}
}
}
Variables
{"args": DefaultScenarioBestLifeProjectionInput}
Response
{
"data": {
"getDefaultScenarioBestLifeProjection": {
"scenarioId": 987,
"name": "xyz789",
"timeline": BestLifeProjectionTimelineData,
"chart": BestLifeProjectionChartData,
"latestInputs": BestLifeProjectionLatestInputsData,
"report": BestLifeReportData
}
}
}
getDirector
Response
Returns a DirectorOutput
Arguments
| Name | Description |
|---|---|
args - GetDirectorInput!
|
Example
Query
query GetDirector($args: GetDirectorInput!) {
getDirector(args: $args) {
directorId
legalEntityId
firstName
middleName
lastName
dateAppointed
notes
clientNotes
partnerNotes
confidentialNotes
createdBy
created
updatedBy
updated
}
}
Variables
{"args": GetDirectorInput}
Response
{
"data": {
"getDirector": {
"directorId": 123,
"legalEntityId": 123,
"firstName": "xyz789",
"middleName": "xyz789",
"lastName": "xyz789",
"dateAppointed": "abc123",
"notes": "xyz789",
"clientNotes": "xyz789",
"partnerNotes": "xyz789",
"confidentialNotes": "abc123",
"createdBy": "xyz789",
"created": "xyz789",
"updatedBy": "xyz789",
"updated": "abc123"
}
}
}
getDirectors
Response
Returns [DirectorOutput]
Arguments
| Name | Description |
|---|---|
args - GetDirectorsInput!
|
Example
Query
query GetDirectors($args: GetDirectorsInput!) {
getDirectors(args: $args) {
directorId
legalEntityId
firstName
middleName
lastName
dateAppointed
notes
clientNotes
partnerNotes
confidentialNotes
createdBy
created
updatedBy
updated
}
}
Variables
{"args": GetDirectorsInput}
Response
{
"data": {
"getDirectors": [
{
"directorId": 123,
"legalEntityId": 123,
"firstName": "abc123",
"middleName": "abc123",
"lastName": "xyz789",
"dateAppointed": "abc123",
"notes": "xyz789",
"clientNotes": "xyz789",
"partnerNotes": "xyz789",
"confidentialNotes": "abc123",
"createdBy": "abc123",
"created": "abc123",
"updatedBy": "xyz789",
"updated": "abc123"
}
]
}
}
getEducationPlanning
Response
Returns an EducationPlanningOutput
Arguments
| Name | Description |
|---|---|
args - GetEducationPlanningInput!
|
Example
Query
query GetEducationPlanning($args: GetEducationPlanningInput!) {
getEducationPlanning(args: $args) {
educationPlanningId
householdId
clientId
legalEntityId
hasEducationSavings
createdBy
created
updatedBy
updated
}
}
Variables
{"args": GetEducationPlanningInput}
Response
{
"data": {
"getEducationPlanning": {
"educationPlanningId": 123,
"householdId": 987,
"clientId": 987,
"legalEntityId": 123,
"hasEducationSavings": true,
"createdBy": "xyz789",
"created": "abc123",
"updatedBy": "abc123",
"updated": "xyz789"
}
}
}
getEducationPlannings
Response
Returns [EducationPlanningOutput]
Arguments
| Name | Description |
|---|---|
args - GetEducationPlanningsInput!
|
Example
Query
query GetEducationPlannings($args: GetEducationPlanningsInput!) {
getEducationPlannings(args: $args) {
educationPlanningId
householdId
clientId
legalEntityId
hasEducationSavings
createdBy
created
updatedBy
updated
}
}
Variables
{"args": GetEducationPlanningsInput}
Response
{
"data": {
"getEducationPlannings": [
{
"educationPlanningId": 123,
"householdId": 987,
"clientId": 987,
"legalEntityId": 123,
"hasEducationSavings": false,
"createdBy": "abc123",
"created": "abc123",
"updatedBy": "xyz789",
"updated": "xyz789"
}
]
}
}
getEmploymentDetails
Response
Returns an EmploymentDetailsOutput
Arguments
| Name | Description |
|---|---|
args - GetEmploymentDetailsInput!
|
Example
Query
query GetEmploymentDetails($args: GetEmploymentDetailsInput!) {
getEmploymentDetails(args: $args) {
employmentDetailsId
clientId
degreeQualified
qualifications
recentRetrenched
employmentStatus
plannedChanges
plannedChangesDescription
businessStructure
employedByOwnCompany
occupation
startDate
employer
secondaryOccupation
secondaryOccupationStartDate
secondaryOccupationEmployer
employmentHoursPerWeek
unusedAnnualLeave
unusedSickLeave
unusedLongServiceLeave
workedOverseas
workedOverseasDetails
salarySacrificeAvailable
notes
confidentialNotes
createdBy
created
updatedBy
updated
}
}
Variables
{"args": GetEmploymentDetailsInput}
Response
{
"data": {
"getEmploymentDetails": {
"employmentDetailsId": 123,
"clientId": 123,
"degreeQualified": false,
"qualifications": "xyz789",
"recentRetrenched": true,
"employmentStatus": "xyz789",
"plannedChanges": false,
"plannedChangesDescription": "abc123",
"businessStructure": "abc123",
"employedByOwnCompany": false,
"occupation": "abc123",
"startDate": "abc123",
"employer": "xyz789",
"secondaryOccupation": "xyz789",
"secondaryOccupationStartDate": "xyz789",
"secondaryOccupationEmployer": "abc123",
"employmentHoursPerWeek": 987.65,
"unusedAnnualLeave": 123.45,
"unusedSickLeave": 123.45,
"unusedLongServiceLeave": 987.65,
"workedOverseas": false,
"workedOverseasDetails": "abc123",
"salarySacrificeAvailable": true,
"notes": "abc123",
"confidentialNotes": "abc123",
"createdBy": "abc123",
"created": "abc123",
"updatedBy": "xyz789",
"updated": "xyz789"
}
}
}
getEstatePlanning
Response
Returns an EstatePlanningOutput
Arguments
| Name | Description |
|---|---|
args - GetEstatePlanningInput!
|
Example
Query
query GetEstatePlanning($args: GetEstatePlanningInput!) {
getEstatePlanning(args: $args) {
estatePlanningId
householdId
clientId
solicitorName
willInPlace
isWillCurrent
willDate
willLocation
willProvisions
healthcareDirective
healthcareDirectiveDetails
funeralArrangement
funeralDetails
prepaidFuneral
funeralExpenseValue
purchaseDate
accountNumber
productProvider
superBeneficiariesNominated
beneficiariesNominated
poaGranted
pogGranted
apoaGranted
letterOfWishes
notes
clientNotes
partnerNotes
confidentialNotes
createdBy
created
updatedBy
updated
}
}
Variables
{"args": GetEstatePlanningInput}
Response
{
"data": {
"getEstatePlanning": {
"estatePlanningId": 987,
"householdId": 987,
"clientId": 987,
"solicitorName": "abc123",
"willInPlace": false,
"isWillCurrent": false,
"willDate": "xyz789",
"willLocation": "abc123",
"willProvisions": "xyz789",
"healthcareDirective": true,
"healthcareDirectiveDetails": "abc123",
"funeralArrangement": "abc123",
"funeralDetails": "xyz789",
"prepaidFuneral": false,
"funeralExpenseValue": 123.45,
"purchaseDate": "abc123",
"accountNumber": "abc123",
"productProvider": "xyz789",
"superBeneficiariesNominated": false,
"beneficiariesNominated": false,
"poaGranted": false,
"pogGranted": false,
"apoaGranted": false,
"letterOfWishes": false,
"notes": "xyz789",
"clientNotes": "abc123",
"partnerNotes": "xyz789",
"confidentialNotes": "abc123",
"createdBy": "abc123",
"created": "abc123",
"updatedBy": "xyz789",
"updated": "abc123"
}
}
}
getEstatePlannings
Response
Returns [EstatePlanningOutput]
Arguments
| Name | Description |
|---|---|
args - GetEstatePlanningsInput!
|
Example
Query
query GetEstatePlannings($args: GetEstatePlanningsInput!) {
getEstatePlannings(args: $args) {
estatePlanningId
householdId
clientId
solicitorName
willInPlace
isWillCurrent
willDate
willLocation
willProvisions
healthcareDirective
healthcareDirectiveDetails
funeralArrangement
funeralDetails
prepaidFuneral
funeralExpenseValue
purchaseDate
accountNumber
productProvider
superBeneficiariesNominated
beneficiariesNominated
poaGranted
pogGranted
apoaGranted
letterOfWishes
notes
clientNotes
partnerNotes
confidentialNotes
createdBy
created
updatedBy
updated
}
}
Variables
{"args": GetEstatePlanningsInput}
Response
{
"data": {
"getEstatePlannings": [
{
"estatePlanningId": 987,
"householdId": 987,
"clientId": 123,
"solicitorName": "abc123",
"willInPlace": false,
"isWillCurrent": false,
"willDate": "abc123",
"willLocation": "xyz789",
"willProvisions": "abc123",
"healthcareDirective": false,
"healthcareDirectiveDetails": "xyz789",
"funeralArrangement": "xyz789",
"funeralDetails": "xyz789",
"prepaidFuneral": false,
"funeralExpenseValue": 123.45,
"purchaseDate": "xyz789",
"accountNumber": "abc123",
"productProvider": "abc123",
"superBeneficiariesNominated": true,
"beneficiariesNominated": false,
"poaGranted": false,
"pogGranted": false,
"apoaGranted": true,
"letterOfWishes": false,
"notes": "abc123",
"clientNotes": "abc123",
"partnerNotes": "xyz789",
"confidentialNotes": "xyz789",
"createdBy": "xyz789",
"created": "abc123",
"updatedBy": "abc123",
"updated": "xyz789"
}
]
}
}
getExecutor
Response
Returns an ExecutorOutput
Arguments
| Name | Description |
|---|---|
args - GetExecutorInput!
|
Example
Query
query GetExecutor($args: GetExecutorInput!) {
getExecutor(args: $args) {
executorId
estatePlanningId
firstName
middleName
lastName
notes
clientNotes
partnerNotes
confidentialNotes
createdBy
created
updatedBy
updated
}
}
Variables
{"args": GetExecutorInput}
Response
{
"data": {
"getExecutor": {
"executorId": 987,
"estatePlanningId": 123,
"firstName": "xyz789",
"middleName": "xyz789",
"lastName": "abc123",
"notes": "abc123",
"clientNotes": "abc123",
"partnerNotes": "xyz789",
"confidentialNotes": "abc123",
"createdBy": "xyz789",
"created": "xyz789",
"updatedBy": "xyz789",
"updated": "xyz789"
}
}
}
getExecutors
Response
Returns [ExecutorOutput]
Arguments
| Name | Description |
|---|---|
args - GetExecutorsInput!
|
Example
Query
query GetExecutors($args: GetExecutorsInput!) {
getExecutors(args: $args) {
executorId
estatePlanningId
firstName
middleName
lastName
notes
clientNotes
partnerNotes
confidentialNotes
createdBy
created
updatedBy
updated
}
}
Variables
{"args": GetExecutorsInput}
Response
{
"data": {
"getExecutors": [
{
"executorId": 123,
"estatePlanningId": 987,
"firstName": "abc123",
"middleName": "abc123",
"lastName": "xyz789",
"notes": "abc123",
"clientNotes": "abc123",
"partnerNotes": "abc123",
"confidentialNotes": "xyz789",
"createdBy": "abc123",
"created": "xyz789",
"updatedBy": "xyz789",
"updated": "abc123"
}
]
}
}
getExpense
Response
Returns an ExpenseOutput
Arguments
| Name | Description |
|---|---|
args - GetExpenseInput!
|
Example
Query
query GetExpense($args: GetExpenseInput!) {
getExpense(args: $args) {
expenseId
householdId
clientId
clientFirstName
clientLastName
clientPreferredName
legalEntityId
legalEntityName
assetId
expenseType
expenseSubType
savingsPlanType
description
amount
amountBps
discretionaryAmount
frequency
endYear
stopAllowance
stopAllowanceAge
feeIncreaseBps
changesExpected
timeFrame
notes
clientNotes
partnerNotes
confidentialNotes
createdBy
created
updatedBy
updated
}
}
Variables
{"args": GetExpenseInput}
Response
{
"data": {
"getExpense": {
"expenseId": 123,
"householdId": 123,
"clientId": 987,
"clientFirstName": "xyz789",
"clientLastName": "xyz789",
"clientPreferredName": "xyz789",
"legalEntityId": 987,
"legalEntityName": "xyz789",
"assetId": 123,
"expenseType": "abc123",
"expenseSubType": "abc123",
"savingsPlanType": "abc123",
"description": "xyz789",
"amount": 123.45,
"amountBps": 987.65,
"discretionaryAmount": 987.65,
"frequency": "xyz789",
"endYear": 987,
"stopAllowance": "abc123",
"stopAllowanceAge": 123,
"feeIncreaseBps": 123.45,
"changesExpected": false,
"timeFrame": "xyz789",
"notes": "abc123",
"clientNotes": "xyz789",
"partnerNotes": "xyz789",
"confidentialNotes": "xyz789",
"createdBy": "xyz789",
"created": "abc123",
"updatedBy": "xyz789",
"updated": "abc123"
}
}
}
getExpenses
Response
Returns [ExpenseOutput]
Arguments
| Name | Description |
|---|---|
args - GetExpensesInput!
|
Example
Query
query GetExpenses($args: GetExpensesInput!) {
getExpenses(args: $args) {
expenseId
householdId
clientId
clientFirstName
clientLastName
clientPreferredName
legalEntityId
legalEntityName
assetId
expenseType
expenseSubType
savingsPlanType
description
amount
amountBps
discretionaryAmount
frequency
endYear
stopAllowance
stopAllowanceAge
feeIncreaseBps
changesExpected
timeFrame
notes
clientNotes
partnerNotes
confidentialNotes
createdBy
created
updatedBy
updated
}
}
Variables
{"args": GetExpensesInput}
Response
{
"data": {
"getExpenses": [
{
"expenseId": 987,
"householdId": 123,
"clientId": 123,
"clientFirstName": "abc123",
"clientLastName": "xyz789",
"clientPreferredName": "xyz789",
"legalEntityId": 123,
"legalEntityName": "abc123",
"assetId": 123,
"expenseType": "abc123",
"expenseSubType": "xyz789",
"savingsPlanType": "xyz789",
"description": "xyz789",
"amount": 987.65,
"amountBps": 123.45,
"discretionaryAmount": 987.65,
"frequency": "abc123",
"endYear": 123,
"stopAllowance": "xyz789",
"stopAllowanceAge": 987,
"feeIncreaseBps": 987.65,
"changesExpected": false,
"timeFrame": "xyz789",
"notes": "xyz789",
"clientNotes": "xyz789",
"partnerNotes": "abc123",
"confidentialNotes": "xyz789",
"createdBy": "abc123",
"created": "xyz789",
"updatedBy": "abc123",
"updated": "xyz789"
}
]
}
}
getExternalUploadTracking
Response
Returns an ExternalUploadTracking
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
query GetExternalUploadTracking($id: ID!) {
getExternalUploadTracking(id: $id) {
id
fullS3ObjectPath
identityId
objectKey
practiceId
clientId
goalId
createdAt
updatedAt
}
}
Variables
{"id": "4"}
Response
{
"data": {
"getExternalUploadTracking": {
"id": 4,
"fullS3ObjectPath": "abc123",
"identityId": "xyz789",
"objectKey": "abc123",
"practiceId": 987,
"clientId": 987,
"goalId": 987,
"createdAt": AWSDateTime,
"updatedAt": AWSDateTime
}
}
}
getFinancialHealthAssessmentSession
Response
Returns a FinancialHealthAssessmentSession
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
query GetFinancialHealthAssessmentSession($id: ID!) {
getFinancialHealthAssessmentSession(id: $id) {
id
clientId
inviteCode
householdId
status
firstName
lastName
fullName
hasPartner
partnerId
partnerFirstName
partnerLastName
partnerFullName
finHealthAssessmentFull
responses {
questionId
intResponse
stringResponse
section
}
visionGoalsScore
retirementPlanningScore
insuranceAssetProtectionScore
debtCashFlowManagementScore
educationPlanningScore
investmentPlanningScore
incomeTaxPlanningScore
businessPlanningScore
charitablePlanningScore
estatePlanningScore
createdAt
updatedAt
}
}
Variables
{"id": 4}
Response
{
"data": {
"getFinancialHealthAssessmentSession": {
"id": 4,
"clientId": 987,
"inviteCode": "abc123",
"householdId": 987,
"status": "xyz789",
"firstName": "abc123",
"lastName": "abc123",
"fullName": "abc123",
"hasPartner": true,
"partnerId": 123,
"partnerFirstName": "abc123",
"partnerLastName": "abc123",
"partnerFullName": "xyz789",
"finHealthAssessmentFull": false,
"responses": [FHAResponse],
"visionGoalsScore": 123,
"retirementPlanningScore": 987,
"insuranceAssetProtectionScore": 123,
"debtCashFlowManagementScore": 123,
"educationPlanningScore": 123,
"investmentPlanningScore": 987,
"incomeTaxPlanningScore": 123,
"businessPlanningScore": 123,
"charitablePlanningScore": 123,
"estatePlanningScore": 987,
"createdAt": AWSDateTime,
"updatedAt": AWSDateTime
}
}
}
getFoundationSurvey
Response
Returns a FoundationSurveyOutput
Arguments
| Name | Description |
|---|---|
args - GetFoundationSurveyInput!
|
Example
Query
query GetFoundationSurvey($args: GetFoundationSurveyInput!) {
getFoundationSurvey(args: $args) {
householdId
clientId
partnerId
incomeHousehold
householdMonthlySpend
totalAssets
totalLiabilities
dobClient
stateOfResidencyClient
employmentStatusClient
incomeClient
retirementAgeClient
retirementIncomeClient
retirementLifestyleClient
dobPartner
stateOfResidencyPartner
employmentStatusPartner
incomePartner
retirementAgePartner
retirementIncomePartner
retirementLifestylePartner
}
}
Variables
{"args": GetFoundationSurveyInput}
Response
{
"data": {
"getFoundationSurvey": {
"householdId": 987,
"clientId": 123,
"partnerId": 987,
"incomeHousehold": 987.65,
"householdMonthlySpend": 987.65,
"totalAssets": 987.65,
"totalLiabilities": 987.65,
"dobClient": "xyz789",
"stateOfResidencyClient": "xyz789",
"employmentStatusClient": "xyz789",
"incomeClient": 123.45,
"retirementAgeClient": 987,
"retirementIncomeClient": 123.45,
"retirementLifestyleClient": "xyz789",
"dobPartner": "abc123",
"stateOfResidencyPartner": "abc123",
"employmentStatusPartner": "abc123",
"incomePartner": 123.45,
"retirementAgePartner": 987,
"retirementIncomePartner": 987.65,
"retirementLifestylePartner": "abc123"
}
}
}
getGoalMetadata
Response
Returns a GoalMetadata
Example
Query
query GetGoalMetadata {
getGoalMetadata {
goalCategories {
goalCategoryId
goalCategory
goalCategoryDescription
}
goalStatuses {
goalStatusId
goalStatus
}
goalImportances {
goalImportanceId
goalImportance
}
}
}
Response
{
"data": {
"getGoalMetadata": {
"goalCategories": [GoalCategory],
"goalStatuses": [GoalStatus],
"goalImportances": [GoalImportance]
}
}
}
getGoals
Response
Returns [GoalOutput]
Arguments
| Name | Description |
|---|---|
args - GetGoalsInput
|
Example
Query
query GetGoals($args: GetGoalsInput) {
getGoals(args: $args) {
id
title
goalNotes
successLooksLike
targetDate
targetDatePA
targetDatePADate
targetDateApprovalStatus
completedDate
rank
supportsStrategies
supportsClientValues
supportsHouseholdValues
supportsLife {
clientId
valueGroupId
}
estimatedCost
estimatedCostPA
estimatedCostPADate
estimatedCostApprovalStatus
goalConfidence
goalProgress
strategies
goalImportance
goalCategory
goalStatus
goalStatusPA
goalStatusPADate
goalStatusApprovalStatus
recurrenceType
recurrenceTypePA
recurrenceTypePADate
recurrenceTypeApprovalStatus
recurrenceInterval
recurrenceIntervalPA
recurrenceIntervalPADate
recurrenceIntervalApprovalStatus
assignedToClientId
assignedToHouseholdId
createdForClientId
createdForHouseholdId
forApproval
approvalStatus
approvalChangeDate
createdBy
created
updatedBy
updated
preSignedGoalImageUrl
confidentialNotes
}
}
Variables
{"args": GetGoalsInput}
Response
{
"data": {
"getGoals": [
{
"id": 123,
"title": "abc123",
"goalNotes": "abc123",
"successLooksLike": "abc123",
"targetDate": "xyz789",
"targetDatePA": "abc123",
"targetDatePADate": "abc123",
"targetDateApprovalStatus": "xyz789",
"completedDate": "xyz789",
"rank": 987,
"supportsStrategies": ["abc123"],
"supportsClientValues": [987],
"supportsHouseholdValues": [987],
"supportsLife": [GoalLife],
"estimatedCost": 123,
"estimatedCostPA": 123,
"estimatedCostPADate": "abc123",
"estimatedCostApprovalStatus": "abc123",
"goalConfidence": 123,
"goalProgress": 123,
"strategies": ["xyz789"],
"goalImportance": 123,
"goalCategory": 987,
"goalStatus": 123,
"goalStatusPA": 987,
"goalStatusPADate": "abc123",
"goalStatusApprovalStatus": "xyz789",
"recurrenceType": "xyz789",
"recurrenceTypePA": "abc123",
"recurrenceTypePADate": "abc123",
"recurrenceTypeApprovalStatus": "xyz789",
"recurrenceInterval": 123,
"recurrenceIntervalPA": 123,
"recurrenceIntervalPADate": "xyz789",
"recurrenceIntervalApprovalStatus": "abc123",
"assignedToClientId": 987,
"assignedToHouseholdId": 123,
"createdForClientId": 123,
"createdForHouseholdId": 123,
"forApproval": false,
"approvalStatus": "abc123",
"approvalChangeDate": "xyz789",
"createdBy": "xyz789",
"created": "xyz789",
"updatedBy": "xyz789",
"updated": "abc123",
"preSignedGoalImageUrl": "abc123",
"confidentialNotes": "xyz789"
}
]
}
}
getGoalsSession
Response
Returns a GoalsSession
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
query GetGoalsSession($id: ID!) {
getGoalsSession(id: $id) {
id
clientId
inviteCode
selectedGoalCategoryIds
createdAt
updatedAt
}
}
Variables
{"id": 4}
Response
{
"data": {
"getGoalsSession": {
"id": 4,
"clientId": 123,
"inviteCode": "abc123",
"selectedGoalCategoryIds": [123],
"createdAt": AWSDateTime,
"updatedAt": AWSDateTime
}
}
}
getHealthDetails
Response
Returns a HealthDetailsOutput
Arguments
| Name | Description |
|---|---|
args - GetHealthDetailsInput!
|
Example
Query
query GetHealthDetails($args: GetHealthDetailsInput!) {
getHealthDetails(args: $args) {
healthDetailsId
clientId
healthStatus
medicalHistoryIssues
isSmoker
smokePerDay
useNicotine
nicotinePerDay
useMedication
medicationDetails
medicalCondition
medicalConditionDetails
majorIllness
majorIllnessDetails
privateHealth
privateHealthDetails
sportsInterestsList
sportsInterests
sportsInterestsFrequency
notes
confidentialNotes
createdBy
created
updatedBy
updated
}
}
Variables
{"args": GetHealthDetailsInput}
Response
{
"data": {
"getHealthDetails": {
"healthDetailsId": 987,
"clientId": 987,
"healthStatus": "abc123",
"medicalHistoryIssues": "abc123",
"isSmoker": false,
"smokePerDay": 987,
"useNicotine": false,
"nicotinePerDay": 123,
"useMedication": false,
"medicationDetails": "xyz789",
"medicalCondition": false,
"medicalConditionDetails": "xyz789",
"majorIllness": false,
"majorIllnessDetails": "xyz789",
"privateHealth": true,
"privateHealthDetails": "xyz789",
"sportsInterestsList": "xyz789",
"sportsInterests": "abc123",
"sportsInterestsFrequency": "abc123",
"notes": "abc123",
"confidentialNotes": "xyz789",
"createdBy": "abc123",
"created": "xyz789",
"updatedBy": "xyz789",
"updated": "abc123"
}
}
}
getHolding
Response
Returns a HoldingOutput
Arguments
| Name | Description |
|---|---|
args - GetHoldingInput!
|
Example
Query
query GetHolding($args: GetHoldingInput!) {
getHolding(args: $args) {
holdingId
portfolioId
securityId
ticker
description
quantity
purchasePrice
purchaseDate
averagePrice
totalCost
marketPrice
marketPriceDate
maturityDate
interestRate
paymentFrequency
currencyCode
overrideAssetTreeId
overrideSecurityGroupId
overrideSecurityTypeId
overrideSecurityStyle
createdBy
created
updatedBy
updated
}
}
Variables
{"args": GetHoldingInput}
Response
{
"data": {
"getHolding": {
"holdingId": 123,
"portfolioId": 123,
"securityId": 123,
"ticker": "xyz789",
"description": "abc123",
"quantity": 123.45,
"purchasePrice": 987.65,
"purchaseDate": "xyz789",
"averagePrice": 987.65,
"totalCost": 987.65,
"marketPrice": 987.65,
"marketPriceDate": "xyz789",
"maturityDate": "abc123",
"interestRate": 987.65,
"paymentFrequency": "abc123",
"currencyCode": "xyz789",
"overrideAssetTreeId": 123,
"overrideSecurityGroupId": 123,
"overrideSecurityTypeId": 987,
"overrideSecurityStyle": "xyz789",
"createdBy": "xyz789",
"created": "abc123",
"updatedBy": "xyz789",
"updated": "abc123"
}
}
}
getHoldings
Response
Returns [HoldingOutput]
Arguments
| Name | Description |
|---|---|
args - GetHoldingsInput!
|
Example
Query
query GetHoldings($args: GetHoldingsInput!) {
getHoldings(args: $args) {
holdingId
portfolioId
securityId
ticker
description
quantity
purchasePrice
purchaseDate
averagePrice
totalCost
marketPrice
marketPriceDate
maturityDate
interestRate
paymentFrequency
currencyCode
overrideAssetTreeId
overrideSecurityGroupId
overrideSecurityTypeId
overrideSecurityStyle
createdBy
created
updatedBy
updated
}
}
Variables
{"args": GetHoldingsInput}
Response
{
"data": {
"getHoldings": [
{
"holdingId": 987,
"portfolioId": 987,
"securityId": 987,
"ticker": "xyz789",
"description": "abc123",
"quantity": 987.65,
"purchasePrice": 987.65,
"purchaseDate": "xyz789",
"averagePrice": 123.45,
"totalCost": 123.45,
"marketPrice": 987.65,
"marketPriceDate": "xyz789",
"maturityDate": "xyz789",
"interestRate": 987.65,
"paymentFrequency": "abc123",
"currencyCode": "abc123",
"overrideAssetTreeId": 123,
"overrideSecurityGroupId": 987,
"overrideSecurityTypeId": 987,
"overrideSecurityStyle": "xyz789",
"createdBy": "abc123",
"created": "xyz789",
"updatedBy": "xyz789",
"updated": "abc123"
}
]
}
}
getHousehold
Response
Returns a Household
Arguments
| Name | Description |
|---|---|
args - GetHouseholdInput
|
Example
Query
query GetHousehold($args: GetHouseholdInput) {
getHousehold(args: $args) {
householdId
name
clients {
clientId
householdId
iamId
wealthIds
type
title
firstName
middleName
lastName
preferredName
dob
lastLogin
registered
billableStart
address {
addressId
constructedAddress
addressLine1
addressLine2
suburb
postCode
state
country
createdBy
created
updatedBy
updated
}
postalAddress {
addressId
constructedAddress
addressLine1
addressLine2
suburb
postCode
state
country
createdBy
created
updatedBy
updated
}
contactDetails {
emailAddress
mobileNumber
faxNumber
phoneNumber
createdBy
created
updatedBy
updated
}
moduleStates {
moduleStateId
clientId
previouslyCompleted
module
moduleState
sentDate
sentReminders
startedDate
startedReminders
finishedDate
expiredDate
updatedBy
updated
}
wellnessScore
goalCount
taskCount
sex
relationshipStatus
countryCodeBirth
countryCodeResidency
countryCodeCitizenship
notes
externalId
externalSystem
createdBy
created
updatedBy
updated
}
householdStaffAccess {
practiceOfficeId
practiceOfficeName
staffId
staffTitle
staffFirstName
staffMiddleName
staffLastName
role
}
isTest
householdPackageCode
practiceSegmentationId
practiceSegmentationName
countryCode
wellnessScore
createdBy
created
updatedBy
updated
}
}
Variables
{"args": GetHouseholdInput}
Response
{
"data": {
"getHousehold": {
"householdId": 123,
"name": "xyz789",
"clients": [Client],
"householdStaffAccess": [HouseholdStaffAccess],
"isTest": false,
"householdPackageCode": "abc123",
"practiceSegmentationId": 123,
"practiceSegmentationName": "abc123",
"countryCode": "abc123",
"wellnessScore": 987.65,
"createdBy": "xyz789",
"created": "xyz789",
"updatedBy": "xyz789",
"updated": "abc123"
}
}
}
getHouseholdActivity
Response
Returns a GetHouseholdActivityOutput
Arguments
| Name | Description |
|---|---|
args - GetHouseholdActivityInput!
|
Example
Query
query GetHouseholdActivity($args: GetHouseholdActivityInput!) {
getHouseholdActivity(args: $args) {
householdId
bestLifePlanLastExported
toeLastExported
governanceLastExported
haloCFOLastSent
haloCFOLastCompleted
haloNonCFOLastSent
haloNonCFOLastCompleted
}
}
Variables
{"args": GetHouseholdActivityInput}
Response
{
"data": {
"getHouseholdActivity": {
"householdId": 123,
"bestLifePlanLastExported": "xyz789",
"toeLastExported": "xyz789",
"governanceLastExported": "abc123",
"haloCFOLastSent": "xyz789",
"haloCFOLastCompleted": "xyz789",
"haloNonCFOLastSent": "abc123",
"haloNonCFOLastCompleted": "abc123"
}
}
}
getHouseholdConfig
Response
Returns a HouseholdConfig
Arguments
| Name | Description |
|---|---|
args - GetHouseholdConfig
|
Example
Query
query GetHouseholdConfig($args: GetHouseholdConfig) {
getHouseholdConfig(args: $args) {
householdConfigId
householdId
configuration {
modules {
bestLife {
enabled
}
bestLifePlan {
enabled
}
goals {
enabled
}
governance {
enabled
}
healthAssessment {
enabled
}
invPrefs {
enabled
}
life {
enabled
}
strategies {
enabled
}
surveys {
enabled
}
tasks {
enabled
}
values {
enabled
}
vault {
enabled
}
wealth {
enabled
}
}
}
}
}
Variables
{"args": GetHouseholdConfig}
Response
{
"data": {
"getHouseholdConfig": {
"householdConfigId": 987,
"householdId": 123,
"configuration": HouseholdConfigConfiguration
}
}
}
getHouseholdKeyAdviceAreas
Response
Returns [HouseholdKeyAdviceArea]
Arguments
| Name | Description |
|---|---|
args - GetHouseholdKeyAdviceAreasInput
|
Example
Query
query GetHouseholdKeyAdviceAreas($args: GetHouseholdKeyAdviceAreasInput) {
getHouseholdKeyAdviceAreas(args: $args) {
householdKeyAdviceAreaId
householdId
practiceKeyAdviceAreaId
enabled
status
rank
createdBy
created
updatedBy
updated
}
}
Variables
{"args": GetHouseholdKeyAdviceAreasInput}
Response
{
"data": {
"getHouseholdKeyAdviceAreas": [
{
"householdKeyAdviceAreaId": 987,
"householdId": 987,
"practiceKeyAdviceAreaId": 987,
"enabled": true,
"status": 123,
"rank": 987,
"createdBy": "abc123",
"created": "xyz789",
"updatedBy": "abc123",
"updated": "abc123"
}
]
}
}
getHouseholdMember
Response
Returns a HouseholdMemberOutput
Arguments
| Name | Description |
|---|---|
args - GetHouseholdMemberInput!
|
Example
Query
query GetHouseholdMember($args: GetHouseholdMemberInput!) {
getHouseholdMember(args: $args) {
householdMemberId
householdId
relation
firstName
middleName
lastName
dob
sex
livingAtHome
financiallyDependent
financiallyDependentUntil
notes
confidentialNotes
createdBy
created
updatedBy
updated
}
}
Variables
{"args": GetHouseholdMemberInput}
Response
{
"data": {
"getHouseholdMember": {
"householdMemberId": 123,
"householdId": 123,
"relation": "xyz789",
"firstName": "abc123",
"middleName": "abc123",
"lastName": "xyz789",
"dob": "abc123",
"sex": "abc123",
"livingAtHome": true,
"financiallyDependent": false,
"financiallyDependentUntil": 987,
"notes": "abc123",
"confidentialNotes": "xyz789",
"createdBy": "abc123",
"created": "xyz789",
"updatedBy": "abc123",
"updated": "abc123"
}
}
}
getHouseholdMembers
Response
Returns [HouseholdMemberOutput]
Arguments
| Name | Description |
|---|---|
args - GetHouseholdMembersInput!
|
Example
Query
query GetHouseholdMembers($args: GetHouseholdMembersInput!) {
getHouseholdMembers(args: $args) {
householdMemberId
householdId
relation
firstName
middleName
lastName
dob
sex
livingAtHome
financiallyDependent
financiallyDependentUntil
notes
confidentialNotes
createdBy
created
updatedBy
updated
}
}
Variables
{"args": GetHouseholdMembersInput}
Response
{
"data": {
"getHouseholdMembers": [
{
"householdMemberId": 123,
"householdId": 987,
"relation": "xyz789",
"firstName": "xyz789",
"middleName": "xyz789",
"lastName": "abc123",
"dob": "abc123",
"sex": "abc123",
"livingAtHome": true,
"financiallyDependent": true,
"financiallyDependentUntil": 987,
"notes": "xyz789",
"confidentialNotes": "abc123",
"createdBy": "abc123",
"created": "abc123",
"updatedBy": "xyz789",
"updated": "abc123"
}
]
}
}
getHouseholdPendingApprovals
Response
Returns a GetHouseholdPendingApprovalsOutput
Arguments
| Name | Description |
|---|---|
args - GetHouseholdPendingApprovalsInput
|
Example
Query
query GetHouseholdPendingApprovals($args: GetHouseholdPendingApprovalsInput) {
getHouseholdPendingApprovals(args: $args) {
approvals {
householdId
clientId
entityType
entityId
approvalStatus
section
fieldName
previousValue
newValue
changeDate
}
page
pageSize
pages
totalCount
}
}
Variables
{"args": GetHouseholdPendingApprovalsInput}
Response
{
"data": {
"getHouseholdPendingApprovals": {
"approvals": [HouseholdApprovalItem],
"page": 123,
"pageSize": 987,
"pages": 987,
"totalCount": 987
}
}
}
getHouseholdStrategies
Response
Returns [HouseholdStrategy]
Arguments
| Name | Description |
|---|---|
args - GetHouseholdStrategiesInput
|
Example
Query
query GetHouseholdStrategies($args: GetHouseholdStrategiesInput) {
getHouseholdStrategies(args: $args) {
householdStrategyId
householdId
practiceKeyAdviceAreaId
practiceStrategyId
strategyName
details
progress
startDate
endDate
status
targetAmount
linkedGoalIds
linkedTaskIds
createdBy
created
updatedBy
updated
confidentialNotes
}
}
Variables
{"args": GetHouseholdStrategiesInput}
Response
{
"data": {
"getHouseholdStrategies": [
{
"householdStrategyId": 123,
"householdId": 987,
"practiceKeyAdviceAreaId": 987,
"practiceStrategyId": 987,
"strategyName": "abc123",
"details": "xyz789",
"progress": 123,
"startDate": "abc123",
"endDate": "abc123",
"status": 987,
"targetAmount": 123.45,
"linkedGoalIds": [987],
"linkedTaskIds": [987],
"createdBy": "xyz789",
"created": "xyz789",
"updatedBy": "abc123",
"updated": "xyz789",
"confidentialNotes": "abc123"
}
]
}
}
getHouseholdSummary
Response
Returns a HouseholdSummaryOutput
Arguments
| Name | Description |
|---|---|
args - GetHouseholdSummaryInput
|
Example
Query
query GetHouseholdSummary($args: GetHouseholdSummaryInput) {
getHouseholdSummary(args: $args) {
householdId
wellnessScore
bestLifeScore
householdAssets
householdLiabilities
goalCount
taskTodoCount
kaaCount
clientLifeModuleState
clientValuesModuleState
clientInvPrefsModuleState
clientRegistrationState
clientNotes
partnerLifeModuleState
partnerValuesModuleState
partnerInvPrefsModuleState
partnerRegistrationState
partnerNotes
householdNotes
}
}
Variables
{"args": GetHouseholdSummaryInput}
Response
{
"data": {
"getHouseholdSummary": {
"householdId": 123,
"wellnessScore": 987.65,
"bestLifeScore": 987.65,
"householdAssets": 987.65,
"householdLiabilities": 123.45,
"goalCount": 987,
"taskTodoCount": 987,
"kaaCount": 987,
"clientLifeModuleState": "abc123",
"clientValuesModuleState": "xyz789",
"clientInvPrefsModuleState": "abc123",
"clientRegistrationState": "abc123",
"clientNotes": "xyz789",
"partnerLifeModuleState": "xyz789",
"partnerValuesModuleState": "abc123",
"partnerInvPrefsModuleState": "xyz789",
"partnerRegistrationState": "xyz789",
"partnerNotes": "abc123",
"householdNotes": "abc123"
}
}
}
getHouseholdTeamMembers
Response
Returns [HouseholdTeamMember]
Arguments
| Name | Description |
|---|---|
args - GetHouseholdTeamMembers!
|
Example
Query
query GetHouseholdTeamMembers($args: GetHouseholdTeamMembers!) {
getHouseholdTeamMembers(args: $args) {
householdId
staffId
practiceOfficeId
role
}
}
Variables
{"args": GetHouseholdTeamMembers}
Response
{
"data": {
"getHouseholdTeamMembers": [
{
"householdId": 987,
"staffId": 123,
"practiceOfficeId": 123,
"role": "P1"
}
]
}
}
getHouseholdVaultContents
Response
Returns a GetYourVaultContentsOutput
Arguments
| Name | Description |
|---|---|
args - GetHouseholdVaultContentsInput
|
Example
Query
query GetHouseholdVaultContents($args: GetHouseholdVaultContentsInput) {
getHouseholdVaultContents(args: $args) {
vaultFiles {
pathAndFilename
presignedPathAndFilename
lastModified
size
status
publishCount
uploaderClientId
uploaderStaffId
}
page
pageSize
pages
totalCount
}
}
Variables
{"args": GetHouseholdVaultContentsInput}
Response
{
"data": {
"getHouseholdVaultContents": {
"vaultFiles": [YourVaultFileInfo],
"page": 123,
"pageSize": 123,
"pages": 987,
"totalCount": 987
}
}
}
getHouseholdWellnessHistory
Response
Returns [WellnessScore]
Arguments
| Name | Description |
|---|---|
getHouseholdWellnessHistoryInput - HouseholdWellnessHistoryInput
|
Example
Query
query GetHouseholdWellnessHistory($getHouseholdWellnessHistoryInput: HouseholdWellnessHistoryInput) {
getHouseholdWellnessHistory(getHouseholdWellnessHistoryInput: $getHouseholdWellnessHistoryInput) {
date
wellnessScore
lifeScore
valuesScore
goalsScore
tasksScore
kaaScore
components
}
}
Variables
{
"getHouseholdWellnessHistoryInput": HouseholdWellnessHistoryInput
}
Response
{
"data": {
"getHouseholdWellnessHistory": [
{
"date": "xyz789",
"wellnessScore": 123.45,
"lifeScore": 123.45,
"valuesScore": 123.45,
"goalsScore": 123.45,
"tasksScore": 987.65,
"kaaScore": 987.65,
"components": "abc123"
}
]
}
}
getHouseholds
Response
Returns a GetHouseholdsOutput
Arguments
| Name | Description |
|---|---|
args - GetHouseholdsInput
|
Example
Query
query GetHouseholds($args: GetHouseholdsInput) {
getHouseholds(args: $args) {
households {
householdId
name
clients {
clientId
householdId
iamId
wealthIds
type
title
firstName
middleName
lastName
preferredName
dob
lastLogin
registered
billableStart
address {
addressId
constructedAddress
addressLine1
addressLine2
suburb
postCode
state
country
createdBy
created
updatedBy
updated
}
postalAddress {
addressId
constructedAddress
addressLine1
addressLine2
suburb
postCode
state
country
createdBy
created
updatedBy
updated
}
contactDetails {
emailAddress
mobileNumber
faxNumber
phoneNumber
createdBy
created
updatedBy
updated
}
moduleStates {
moduleStateId
clientId
previouslyCompleted
module
moduleState
sentDate
sentReminders
startedDate
startedReminders
finishedDate
expiredDate
updatedBy
updated
}
wellnessScore
goalCount
taskCount
sex
relationshipStatus
countryCodeBirth
countryCodeResidency
countryCodeCitizenship
notes
externalId
externalSystem
createdBy
created
updatedBy
updated
}
householdStaffAccess {
practiceOfficeId
practiceOfficeName
staffId
staffTitle
staffFirstName
staffMiddleName
staffLastName
role
}
isTest
householdPackageCode
practiceSegmentationId
practiceSegmentationName
countryCode
wellnessScore
createdBy
created
updatedBy
updated
}
pagination {
page
pageSize
numPages
numItems
}
}
}
Variables
{"args": GetHouseholdsInput}
Response
{
"data": {
"getHouseholds": {
"households": [Household],
"pagination": Pagination
}
}
}
getIncome
Response
Returns an IncomeOutput
Arguments
| Name | Description |
|---|---|
args - GetIncomeInput!
|
Example
Query
query GetIncome($args: GetIncomeInput!) {
getIncome(args: $args) {
incomeId
householdId
clientId
clientFirstName
clientLastName
clientPreferredName
assetId
legalEntityId
legalEntityName
incomeType
employer
jobTitle
salary
superBps
salarySacrifice
income
frequency
incomeSubType
description
assessed
taxStatus
rateChangeBps
bonus
bonusBps
commission
commissionBps
startDate
endDate
plannedChanges
plannedChangesDescription
eligibleSocialBenefits
typeOfConcession
giftedAssets
giftedAssetsList
crn
isReceivingPayments
paymentType
benefitAmount
retirementBenefitAmount
notes
clientNotes
partnerNotes
confidentialNotes
createdBy
created
updatedBy
updated
}
}
Variables
{"args": GetIncomeInput}
Response
{
"data": {
"getIncome": {
"incomeId": 987,
"householdId": 123,
"clientId": 123,
"clientFirstName": "abc123",
"clientLastName": "xyz789",
"clientPreferredName": "abc123",
"assetId": 987,
"legalEntityId": 123,
"legalEntityName": "xyz789",
"incomeType": "abc123",
"employer": "xyz789",
"jobTitle": "abc123",
"salary": 987.65,
"superBps": 987.65,
"salarySacrifice": 987.65,
"income": 123.45,
"frequency": "abc123",
"incomeSubType": "abc123",
"description": "abc123",
"assessed": false,
"taxStatus": "xyz789",
"rateChangeBps": 987.65,
"bonus": 987.65,
"bonusBps": 123.45,
"commission": 987.65,
"commissionBps": 123.45,
"startDate": "xyz789",
"endDate": "abc123",
"plannedChanges": true,
"plannedChangesDescription": "abc123",
"eligibleSocialBenefits": false,
"typeOfConcession": "abc123",
"giftedAssets": false,
"giftedAssetsList": "abc123",
"crn": "abc123",
"isReceivingPayments": false,
"paymentType": "xyz789",
"benefitAmount": 987.65,
"retirementBenefitAmount": 987.65,
"notes": "abc123",
"clientNotes": "abc123",
"partnerNotes": "abc123",
"confidentialNotes": "xyz789",
"createdBy": "xyz789",
"created": "xyz789",
"updatedBy": "abc123",
"updated": "abc123"
}
}
}
getIncomes
Response
Returns [IncomeOutput]
Arguments
| Name | Description |
|---|---|
args - GetIncomesInput!
|
Example
Query
query GetIncomes($args: GetIncomesInput!) {
getIncomes(args: $args) {
incomeId
householdId
clientId
clientFirstName
clientLastName
clientPreferredName
assetId
legalEntityId
legalEntityName
incomeType
employer
jobTitle
salary
superBps
salarySacrifice
income
frequency
incomeSubType
description
assessed
taxStatus
rateChangeBps
bonus
bonusBps
commission
commissionBps
startDate
endDate
plannedChanges
plannedChangesDescription
eligibleSocialBenefits
typeOfConcession
giftedAssets
giftedAssetsList
crn
isReceivingPayments
paymentType
benefitAmount
retirementBenefitAmount
notes
clientNotes
partnerNotes
confidentialNotes
createdBy
created
updatedBy
updated
}
}
Variables
{"args": GetIncomesInput}
Response
{
"data": {
"getIncomes": [
{
"incomeId": 123,
"householdId": 987,
"clientId": 123,
"clientFirstName": "abc123",
"clientLastName": "xyz789",
"clientPreferredName": "abc123",
"assetId": 987,
"legalEntityId": 987,
"legalEntityName": "abc123",
"incomeType": "xyz789",
"employer": "xyz789",
"jobTitle": "abc123",
"salary": 987.65,
"superBps": 123.45,
"salarySacrifice": 123.45,
"income": 987.65,
"frequency": "abc123",
"incomeSubType": "abc123",
"description": "xyz789",
"assessed": false,
"taxStatus": "abc123",
"rateChangeBps": 123.45,
"bonus": 987.65,
"bonusBps": 123.45,
"commission": 987.65,
"commissionBps": 123.45,
"startDate": "abc123",
"endDate": "abc123",
"plannedChanges": false,
"plannedChangesDescription": "xyz789",
"eligibleSocialBenefits": true,
"typeOfConcession": "abc123",
"giftedAssets": false,
"giftedAssetsList": "abc123",
"crn": "xyz789",
"isReceivingPayments": true,
"paymentType": "abc123",
"benefitAmount": 987.65,
"retirementBenefitAmount": 987.65,
"notes": "abc123",
"clientNotes": "xyz789",
"partnerNotes": "xyz789",
"confidentialNotes": "abc123",
"createdBy": "abc123",
"created": "abc123",
"updatedBy": "abc123",
"updated": "abc123"
}
]
}
}
getInstitutions
Response
Returns [Institution]
Example
Query
query GetInstitutions {
getInstitutions {
basiqInstitutionId
basiqInstitutionType
basiqInstitutionName
basiqInstitutionShortName
basiqInstitutionCountry
basiqInstitutionStatRetrieveAccounts
basiqInstitutionStatRetrieveTransactions
basiqInstitutionLogoUrl
}
}
Response
{
"data": {
"getInstitutions": [
{
"basiqInstitutionId": "xyz789",
"basiqInstitutionType": "xyz789",
"basiqInstitutionName": "xyz789",
"basiqInstitutionShortName": "xyz789",
"basiqInstitutionCountry": "xyz789",
"basiqInstitutionStatRetrieveAccounts": 987,
"basiqInstitutionStatRetrieveTransactions": 123,
"basiqInstitutionLogoUrl": "xyz789"
}
]
}
}
getInsurance
Response
Returns an InsuranceOutput
Arguments
| Name | Description |
|---|---|
args - GetInsuranceInput!
|
Example
Query
query GetInsurance($args: GetInsuranceInput!) {
getInsurance(args: $args) {
insuranceId
householdId
clientId
legalEntityId
assetId
beneficiaryClientId
beneficiaryLegalEntityId
beneficiaryHouseholdMemberId
insuranceType
lifeInsuranceType
generalInsuranceType
insurer
description
excess
cashValue
cover
coverBps
insideSuper
ipCoverType
arSubType
premium
frequency
policyNumber
policyStatus
policyToDate
premiumIncreaseBps
payoutPeriod
payoutPeriodEnd
payoutWaitPeriod
endYear
notes
clientNotes
partnerNotes
confidentialNotes
displayName
externalId
externalSystem
insuranceYodleeMapping {
providerAccountId
additionalStatus
additionalStatusDescription
lastUpdated
isBroken
createdBy
created
updatedBy
updated
}
coverages {
insuranceCoverageId
insuranceId
lifeInsuranceType
generalInsuranceType
lifeInsuranceSubType
disabilitySubType
longTermCareSubType
otherInsuranceSubType
cover
coverBps
coverPerAnnum
ipCoverType
arSubType
payoutPeriod
payoutPeriodEnd
payoutWaitPeriod
insideSuper
endYear
deathBenefit
beneficiaryRelation
chronicCareRider
otherBeneficiary
longOrShort
monthlyBenefitAmount
totalBenefits
payoutType
payoutPeriodText
eliminationPeriod
healthcareSource
premiumTaxCredit
createdBy
created
updatedBy
updated
}
createdBy
created
updatedBy
updated
}
}
Variables
{"args": GetInsuranceInput}
Response
{
"data": {
"getInsurance": {
"insuranceId": 123,
"householdId": 987,
"clientId": 123,
"legalEntityId": 123,
"assetId": 987,
"beneficiaryClientId": 987,
"beneficiaryLegalEntityId": 123,
"beneficiaryHouseholdMemberId": 123,
"insuranceType": "xyz789",
"lifeInsuranceType": "xyz789",
"generalInsuranceType": "abc123",
"insurer": "abc123",
"description": "abc123",
"excess": 123.45,
"cashValue": 123.45,
"cover": 987.65,
"coverBps": 987.65,
"insideSuper": false,
"ipCoverType": "abc123",
"arSubType": "abc123",
"premium": 123.45,
"frequency": "xyz789",
"policyNumber": "abc123",
"policyStatus": "abc123",
"policyToDate": "abc123",
"premiumIncreaseBps": 123.45,
"payoutPeriod": "abc123",
"payoutPeriodEnd": "abc123",
"payoutWaitPeriod": 123,
"endYear": 123,
"notes": "xyz789",
"clientNotes": "xyz789",
"partnerNotes": "abc123",
"confidentialNotes": "abc123",
"displayName": "xyz789",
"externalId": "xyz789",
"externalSystem": "IL",
"insuranceYodleeMapping": YodleeMapping,
"coverages": [InsuranceCoverageOutput],
"createdBy": "abc123",
"created": "abc123",
"updatedBy": "abc123",
"updated": "abc123"
}
}
}
getInsurances
Response
Returns [InsuranceOutput]
Arguments
| Name | Description |
|---|---|
args - GetInsurancesInput!
|
Example
Query
query GetInsurances($args: GetInsurancesInput!) {
getInsurances(args: $args) {
insuranceId
householdId
clientId
legalEntityId
assetId
beneficiaryClientId
beneficiaryLegalEntityId
beneficiaryHouseholdMemberId
insuranceType
lifeInsuranceType
generalInsuranceType
insurer
description
excess
cashValue
cover
coverBps
insideSuper
ipCoverType
arSubType
premium
frequency
policyNumber
policyStatus
policyToDate
premiumIncreaseBps
payoutPeriod
payoutPeriodEnd
payoutWaitPeriod
endYear
notes
clientNotes
partnerNotes
confidentialNotes
displayName
externalId
externalSystem
insuranceYodleeMapping {
providerAccountId
additionalStatus
additionalStatusDescription
lastUpdated
isBroken
createdBy
created
updatedBy
updated
}
coverages {
insuranceCoverageId
insuranceId
lifeInsuranceType
generalInsuranceType
lifeInsuranceSubType
disabilitySubType
longTermCareSubType
otherInsuranceSubType
cover
coverBps
coverPerAnnum
ipCoverType
arSubType
payoutPeriod
payoutPeriodEnd
payoutWaitPeriod
insideSuper
endYear
deathBenefit
beneficiaryRelation
chronicCareRider
otherBeneficiary
longOrShort
monthlyBenefitAmount
totalBenefits
payoutType
payoutPeriodText
eliminationPeriod
healthcareSource
premiumTaxCredit
createdBy
created
updatedBy
updated
}
createdBy
created
updatedBy
updated
}
}
Variables
{"args": GetInsurancesInput}
Response
{
"data": {
"getInsurances": [
{
"insuranceId": 123,
"householdId": 987,
"clientId": 987,
"legalEntityId": 123,
"assetId": 987,
"beneficiaryClientId": 987,
"beneficiaryLegalEntityId": 987,
"beneficiaryHouseholdMemberId": 123,
"insuranceType": "abc123",
"lifeInsuranceType": "xyz789",
"generalInsuranceType": "xyz789",
"insurer": "abc123",
"description": "abc123",
"excess": 987.65,
"cashValue": 987.65,
"cover": 987.65,
"coverBps": 123.45,
"insideSuper": true,
"ipCoverType": "abc123",
"arSubType": "xyz789",
"premium": 987.65,
"frequency": "abc123",
"policyNumber": "xyz789",
"policyStatus": "abc123",
"policyToDate": "xyz789",
"premiumIncreaseBps": 123.45,
"payoutPeriod": "abc123",
"payoutPeriodEnd": "abc123",
"payoutWaitPeriod": 123,
"endYear": 123,
"notes": "abc123",
"clientNotes": "xyz789",
"partnerNotes": "abc123",
"confidentialNotes": "abc123",
"displayName": "xyz789",
"externalId": "xyz789",
"externalSystem": "IL",
"insuranceYodleeMapping": YodleeMapping,
"coverages": [InsuranceCoverageOutput],
"createdBy": "abc123",
"created": "xyz789",
"updatedBy": "xyz789",
"updated": "xyz789"
}
]
}
}
getInsurancesV2
Response
Returns [InsuranceOutput]
Arguments
| Name | Description |
|---|---|
args - GetInsurancesInput!
|
Example
Query
query GetInsurancesV2($args: GetInsurancesInput!) {
getInsurancesV2(args: $args) {
insuranceId
householdId
clientId
legalEntityId
assetId
beneficiaryClientId
beneficiaryLegalEntityId
beneficiaryHouseholdMemberId
insuranceType
lifeInsuranceType
generalInsuranceType
insurer
description
excess
cashValue
cover
coverBps
insideSuper
ipCoverType
arSubType
premium
frequency
policyNumber
policyStatus
policyToDate
premiumIncreaseBps
payoutPeriod
payoutPeriodEnd
payoutWaitPeriod
endYear
notes
clientNotes
partnerNotes
confidentialNotes
displayName
externalId
externalSystem
insuranceYodleeMapping {
providerAccountId
additionalStatus
additionalStatusDescription
lastUpdated
isBroken
createdBy
created
updatedBy
updated
}
coverages {
insuranceCoverageId
insuranceId
lifeInsuranceType
generalInsuranceType
lifeInsuranceSubType
disabilitySubType
longTermCareSubType
otherInsuranceSubType
cover
coverBps
coverPerAnnum
ipCoverType
arSubType
payoutPeriod
payoutPeriodEnd
payoutWaitPeriod
insideSuper
endYear
deathBenefit
beneficiaryRelation
chronicCareRider
otherBeneficiary
longOrShort
monthlyBenefitAmount
totalBenefits
payoutType
payoutPeriodText
eliminationPeriod
healthcareSource
premiumTaxCredit
createdBy
created
updatedBy
updated
}
createdBy
created
updatedBy
updated
}
}
Variables
{"args": GetInsurancesInput}
Response
{
"data": {
"getInsurancesV2": [
{
"insuranceId": 123,
"householdId": 123,
"clientId": 987,
"legalEntityId": 123,
"assetId": 123,
"beneficiaryClientId": 123,
"beneficiaryLegalEntityId": 123,
"beneficiaryHouseholdMemberId": 123,
"insuranceType": "abc123",
"lifeInsuranceType": "abc123",
"generalInsuranceType": "xyz789",
"insurer": "xyz789",
"description": "xyz789",
"excess": 123.45,
"cashValue": 123.45,
"cover": 987.65,
"coverBps": 987.65,
"insideSuper": false,
"ipCoverType": "abc123",
"arSubType": "xyz789",
"premium": 123.45,
"frequency": "abc123",
"policyNumber": "xyz789",
"policyStatus": "abc123",
"policyToDate": "xyz789",
"premiumIncreaseBps": 987.65,
"payoutPeriod": "abc123",
"payoutPeriodEnd": "xyz789",
"payoutWaitPeriod": 123,
"endYear": 987,
"notes": "xyz789",
"clientNotes": "xyz789",
"partnerNotes": "xyz789",
"confidentialNotes": "xyz789",
"displayName": "abc123",
"externalId": "abc123",
"externalSystem": "IL",
"insuranceYodleeMapping": YodleeMapping,
"coverages": [InsuranceCoverageOutput],
"createdBy": "xyz789",
"created": "xyz789",
"updatedBy": "xyz789",
"updated": "abc123"
}
]
}
}
getInvestmentPreferencesSession
Response
Returns an InvestmentPreferencesSession
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
query GetInvestmentPreferencesSession($id: ID!) {
getInvestmentPreferencesSession(id: $id) {
id
clientId
inviteCode
fullName
status
introVideo
customisationVideo
customisation
ethicalVideo
ethical
assetClassVideo
allocationVideo
allocationType
riskVideo
comfortableWithDownturn
costVideo
costDriven
prioritisation {
optionId
rank
}
comments
customisationVideoHelp
customisationVideoComments
ethicalVideoHelp
ethicalVideoComments
assetClassVideoHelp
assetClassVideoComments
allocationVideoHelp
allocationVideoComments
riskVideoHelp
riskVideoComments
riskDiversification
riskMarketCorrection
riskPercentageDrop
riskCapitalProtection
riskAccessCapital
riskInfluencedByReturns
riskIncreaseToMeetGoal
riskMaxDownside
riskInflation
costVideoHelp
costVideoComments
assetClassAndDiversificationVideoHelp
assetClassPreferences
assetClassPreferencesComments
assetClassRisk
assetClassRiskComments
ethicalPreferences
ethicalPreferencesComments
activePassiveVideoHelp
costWealthPriorities
riskVolatilityVideoHelp
riskTimelines
riskExperience
riskKnowledge
riskPast
riskCurrent
riskTimeframe
riskVariability
riskVolatility
riskReaction
riskTolerance
riskFuture
includeRiskSection
includeIntroSection
includeCustomisationSection
includeEthicalSection
includeAssetClassSection
includeAllocationSection
includeCostSection
includePrioritisationSection
includeCommentsSection
createdAt
updatedAt
}
}
Variables
{"id": "4"}
Response
{
"data": {
"getInvestmentPreferencesSession": {
"id": 4,
"clientId": 123,
"inviteCode": "abc123",
"fullName": "xyz789",
"status": "abc123",
"introVideo": "xyz789",
"customisationVideo": "xyz789",
"customisation": "Y",
"ethicalVideo": "abc123",
"ethical": "Y",
"assetClassVideo": "xyz789",
"allocationVideo": "xyz789",
"allocationType": "S",
"riskVideo": "xyz789",
"comfortableWithDownturn": "xyz789",
"costVideo": "xyz789",
"costDriven": "Y",
"prioritisation": [InvestmentPreferencesRanking],
"comments": "xyz789",
"customisationVideoHelp": "Y",
"customisationVideoComments": "abc123",
"ethicalVideoHelp": "Y",
"ethicalVideoComments": "abc123",
"assetClassVideoHelp": "Y",
"assetClassVideoComments": "abc123",
"allocationVideoHelp": "Y",
"allocationVideoComments": "xyz789",
"riskVideoHelp": "Y",
"riskVideoComments": "xyz789",
"riskDiversification": 987,
"riskMarketCorrection": 987,
"riskPercentageDrop": 123,
"riskCapitalProtection": "Y",
"riskAccessCapital": 987,
"riskInfluencedByReturns": 123,
"riskIncreaseToMeetGoal": 987,
"riskMaxDownside": 987,
"riskInflation": 123,
"costVideoHelp": "Y",
"costVideoComments": "xyz789",
"assetClassAndDiversificationVideoHelp": "Y",
"assetClassPreferences": "Y",
"assetClassPreferencesComments": "xyz789",
"assetClassRisk": "Y",
"assetClassRiskComments": "abc123",
"ethicalPreferences": "Y",
"ethicalPreferencesComments": "xyz789",
"activePassiveVideoHelp": "Y",
"costWealthPriorities": "A",
"riskVolatilityVideoHelp": "Y",
"riskTimelines": "Y",
"riskExperience": 123,
"riskKnowledge": 123,
"riskPast": 123,
"riskCurrent": 987,
"riskTimeframe": 987,
"riskVariability": 987,
"riskVolatility": 987,
"riskReaction": 987,
"riskTolerance": 987,
"riskFuture": 123,
"includeRiskSection": true,
"includeIntroSection": false,
"includeCustomisationSection": false,
"includeEthicalSection": true,
"includeAssetClassSection": true,
"includeAllocationSection": true,
"includeCostSection": false,
"includePrioritisationSection": true,
"includeCommentsSection": false,
"createdAt": AWSDateTime,
"updatedAt": AWSDateTime
}
}
}
getInvestmentPreferencesVideos
Response
Returns an InvestmentPreferencesVideoOutput
Arguments
| Name | Description |
|---|---|
args - GetInvestmentPreferencesVideosInput
|
Example
Query
query GetInvestmentPreferencesVideos($args: GetInvestmentPreferencesVideosInput) {
getInvestmentPreferencesVideos(args: $args) {
introVideoUrl
customisationVideoUrl
ethicalVideoUrl
assetClassVideoUrl
allocationVideoUrl
riskVideoUrl
costVideoUrl
}
}
Variables
{"args": GetInvestmentPreferencesVideosInput}
Response
{
"data": {
"getInvestmentPreferencesVideos": {
"introVideoUrl": "abc123",
"customisationVideoUrl": "xyz789",
"ethicalVideoUrl": "abc123",
"assetClassVideoUrl": "xyz789",
"allocationVideoUrl": "xyz789",
"riskVideoUrl": "abc123",
"costVideoUrl": "abc123"
}
}
}
getItemsToThinkAbout
Response
Returns a GetItemsToThinkAboutOutput
Arguments
| Name | Description |
|---|---|
args - GetItemsToThinkAboutInput
|
Example
Query
query GetItemsToThinkAbout($args: GetItemsToThinkAboutInput) {
getItemsToThinkAbout(args: $args) {
itemsToThinkAbout {
householdId
names
description
itemType
}
}
}
Variables
{"args": GetItemsToThinkAboutInput}
Response
{
"data": {
"getItemsToThinkAbout": {
"itemsToThinkAbout": [ItemToThinkAbout]
}
}
}
getLatestDiscovery
Response
Returns a Discovery
Arguments
| Name | Description |
|---|---|
args - GetLatestDiscoveryInput
|
Example
Query
query GetLatestDiscovery($args: GetLatestDiscoveryInput) {
getLatestDiscovery(args: $args) {
id
householdId
clientDiscovery {
id
clientId
homeLoanOwing
investmentDebt
investmentPropertyDebt
requiredRetirementIncome
otherDebt
superBalance
savings
income
otherAssets
lifeInsurance
incomeProtection
traumaInsurance
tpdInsurance
desiredRetirementAge
}
partnerDiscovery {
id
clientId
homeLoanOwing
investmentDebt
investmentPropertyDebt
requiredRetirementIncome
otherDebt
superBalance
savings
income
otherAssets
lifeInsurance
incomeProtection
traumaInsurance
tpdInsurance
desiredRetirementAge
}
householdIncome
additionalHouseholdIncome
householdSavings
householdTotalAssets
householdTotalDebt
superContributions
superContributionsDetails
savingsRegularity
savingsAmount
homeValue
investmentPropertiesValue
investmentPropertiesDebt
requiredRetirementIncome
referenceModel
}
}
Variables
{"args": GetLatestDiscoveryInput}
Response
{
"data": {
"getLatestDiscovery": {
"id": 987,
"householdId": 987,
"clientDiscovery": ClientDiscovery,
"partnerDiscovery": ClientDiscovery,
"householdIncome": 987.65,
"additionalHouseholdIncome": 123.45,
"householdSavings": 987.65,
"householdTotalAssets": 987.65,
"householdTotalDebt": 987.65,
"superContributions": "Y",
"superContributionsDetails": "abc123",
"savingsRegularity": "O",
"savingsAmount": 123.45,
"homeValue": 987.65,
"investmentPropertiesValue": 123.45,
"investmentPropertiesDebt": 123.45,
"requiredRetirementIncome": 987.65,
"referenceModel": 123
}
}
}
getLatestHealthAssessment
Response
Returns a HealthAssessment
Arguments
| Name | Description |
|---|---|
args - GetLatestHealthAssessmentInput
|
Example
Query
query GetLatestHealthAssessment($args: GetLatestHealthAssessmentInput) {
getLatestHealthAssessment(args: $args) {
id
clientId
status
visionGoalsScore
retirementPlanningScore
insuranceAssetProtectionScore
debtCashFlowManagementScore
educationPlanningScore
investmentPlanningScore
incomeTaxPlanningScore
businessPlanningScore
charitablePlanningScore
estatePlanningScore
}
}
Variables
{"args": GetLatestHealthAssessmentInput}
Response
{
"data": {
"getLatestHealthAssessment": {
"id": 987,
"clientId": 987,
"status": "abc123",
"visionGoalsScore": 987,
"retirementPlanningScore": 123,
"insuranceAssetProtectionScore": 123,
"debtCashFlowManagementScore": 123,
"educationPlanningScore": 987,
"investmentPlanningScore": 123,
"incomeTaxPlanningScore": 123,
"businessPlanningScore": 987,
"charitablePlanningScore": 123,
"estatePlanningScore": 123
}
}
}
getLatestHealthAssessmentHousehold
Response
Returns [HealthAssessment]
Arguments
| Name | Description |
|---|---|
args - GetLatestHealthAssessmentHouseholdInput
|
Example
Query
query GetLatestHealthAssessmentHousehold($args: GetLatestHealthAssessmentHouseholdInput) {
getLatestHealthAssessmentHousehold(args: $args) {
id
clientId
status
visionGoalsScore
retirementPlanningScore
insuranceAssetProtectionScore
debtCashFlowManagementScore
educationPlanningScore
investmentPlanningScore
incomeTaxPlanningScore
businessPlanningScore
charitablePlanningScore
estatePlanningScore
}
}
Variables
{"args": GetLatestHealthAssessmentHouseholdInput}
Response
{
"data": {
"getLatestHealthAssessmentHousehold": [
{
"id": 987,
"clientId": 123,
"status": "xyz789",
"visionGoalsScore": 123,
"retirementPlanningScore": 987,
"insuranceAssetProtectionScore": 987,
"debtCashFlowManagementScore": 987,
"educationPlanningScore": 123,
"investmentPlanningScore": 987,
"incomeTaxPlanningScore": 987,
"businessPlanningScore": 987,
"charitablePlanningScore": 987,
"estatePlanningScore": 987
}
]
}
}
getLatestInvestmentPreferences
Response
Returns an InvestmentPreferencesOutput
Arguments
| Name | Description |
|---|---|
args - GetInvestmentPreferencesInput
|
Example
Query
query GetLatestInvestmentPreferences($args: GetInvestmentPreferencesInput) {
getLatestInvestmentPreferences(args: $args) {
client {
clientId
introVideo
customisationVideo
customisation
ethicalVideo
ethical
assetClassVideo
allocationVideo
allocationType
riskVideo
comfortableWithDownturn
costVideo
costDriven
prioritisation {
optionId
rank
}
comments
customisationVideoHelp
customisationVideoComments
ethicalVideoHelp
ethicalVideoComments
assetClassVideoHelp
assetClassVideoComments
allocationVideoHelp
allocationVideoComments
riskVideoHelp
riskVideoComments
riskDiversification
riskMarketCorrection
riskPercentageDrop
riskCapitalProtection
riskAccessCapital
riskInfluencedByReturns
riskIncreaseToMeetGoal
riskMaxDownside
riskInflation
costVideoHelp
costVideoComments
assetClassAndDiversificationVideoHelp
assetClassPreferences
assetClassPreferencesComments
assetClassRisk
assetClassRiskComments
ethicalPreferences
ethicalPreferencesComments
activePassiveVideoHelp
costWealthPriorities
riskVolatilityVideoHelp
riskTimelines
riskExperience
riskKnowledge
riskPast
riskCurrent
riskTimeframe
riskVariability
riskVolatility
riskReaction
riskTolerance
riskFuture
createdBy
created
updatedBy
updated
}
partner {
clientId
introVideo
customisationVideo
customisation
ethicalVideo
ethical
assetClassVideo
allocationVideo
allocationType
riskVideo
comfortableWithDownturn
costVideo
costDriven
prioritisation {
optionId
rank
}
comments
customisationVideoHelp
customisationVideoComments
ethicalVideoHelp
ethicalVideoComments
assetClassVideoHelp
assetClassVideoComments
allocationVideoHelp
allocationVideoComments
riskVideoHelp
riskVideoComments
riskDiversification
riskMarketCorrection
riskPercentageDrop
riskCapitalProtection
riskAccessCapital
riskInfluencedByReturns
riskIncreaseToMeetGoal
riskMaxDownside
riskInflation
costVideoHelp
costVideoComments
assetClassAndDiversificationVideoHelp
assetClassPreferences
assetClassPreferencesComments
assetClassRisk
assetClassRiskComments
ethicalPreferences
ethicalPreferencesComments
activePassiveVideoHelp
costWealthPriorities
riskVolatilityVideoHelp
riskTimelines
riskExperience
riskKnowledge
riskPast
riskCurrent
riskTimeframe
riskVariability
riskVolatility
riskReaction
riskTolerance
riskFuture
createdBy
created
updatedBy
updated
}
household {
householdId
customisation
customisationNotes
ethical
ethicalNotes
assetClassNotes
allocationType
allocationNotes
riskNotes
riskGroup
costNotes
costDriven
prioritisationNotes
commentNotes
createdBy
created
updatedBy
updated
}
}
}
Variables
{"args": GetInvestmentPreferencesInput}
Response
{
"data": {
"getLatestInvestmentPreferences": {
"client": InvestmentPreferences,
"partner": InvestmentPreferences,
"household": HouseholdInvestmentPreferences
}
}
}
getLatestYourLife
Response
Returns a GetLatestYourLifeOutput
Arguments
| Name | Description |
|---|---|
args - GetLatestYourLifeInput
|
Example
Query
query GetLatestYourLife($args: GetLatestYourLifeInput) {
getLatestYourLife(args: $args) {
client {
id
clientId
responses {
id
questionId
stringResponse
intResponse
createdBy
created
updatedBy
updated
}
connections {
type
name
createdBy
created
updatedBy
updated
}
notes {
id
householdId
valueGroupId
note
}
overallScore
emotionalScore
environmentalScore
spiritualScore
socialScore
educationScore
occupationalScore
physicalScore
financialScore
completed
createdBy
created
updatedBy
updated
}
partner {
id
clientId
responses {
id
questionId
stringResponse
intResponse
createdBy
created
updatedBy
updated
}
connections {
type
name
createdBy
created
updatedBy
updated
}
notes {
id
householdId
valueGroupId
note
}
overallScore
emotionalScore
environmentalScore
spiritualScore
socialScore
educationScore
occupationalScore
physicalScore
financialScore
completed
createdBy
created
updatedBy
updated
}
}
}
Variables
{"args": GetLatestYourLifeInput}
Response
{
"data": {
"getLatestYourLife": {
"client": Life,
"partner": Life
}
}
}
getLatestYourValues
Response
Returns a ClientAndHouseholdValues
Arguments
| Name | Description |
|---|---|
args - GetLatestYourValuesInput
|
Example
Query
query GetLatestYourValues($args: GetLatestYourValuesInput) {
getLatestYourValues(args: $args) {
client {
id
clientId
regrets {
id
regret
createdBy
created
updatedBy
updated
}
values {
id
cardId
rank
meaningReason
progressAction
createdBy
created
updatedBy
updated
}
createdBy
created
updatedBy
updated
}
partner {
id
clientId
regrets {
id
regret
createdBy
created
updatedBy
updated
}
values {
id
cardId
rank
meaningReason
progressAction
createdBy
created
updatedBy
updated
}
createdBy
created
updatedBy
updated
}
household {
id
householdId
values {
id
cardId
clientId
rank
notes
progress
description
nextSteps {
id
title
notes
assignedToClientId
createdBy
created
updatedBy
updated
}
householdMemberProgress {
id
description
progress
clientId
createdBy
created
updatedBy
updated
}
createdBy
created
updatedBy
updated
}
createdBy
created
updatedBy
updated
}
completed
}
}
Variables
{"args": GetLatestYourValuesInput}
Response
{
"data": {
"getLatestYourValues": {
"client": ClientValues,
"partner": ClientValues,
"household": HouseholdValues,
"completed": true
}
}
}
getLearnWorldLoginLink
Response
Returns a String
Arguments
| Name | Description |
|---|---|
args - GetLearnWorldLoginLinkRequest
|
Example
Query
query GetLearnWorldLoginLink($args: GetLearnWorldLoginLinkRequest) {
getLearnWorldLoginLink(args: $args)
}
Variables
{"args": GetLearnWorldLoginLinkRequest}
Response
{
"data": {
"getLearnWorldLoginLink": "abc123"
}
}
getLegalEntities
Response
Returns [LegalEntityOutput]
Arguments
| Name | Description |
|---|---|
args - GetLegalEntitiesInput!
|
Example
Query
query GetLegalEntities($args: GetLegalEntitiesInput!) {
getLegalEntities(args: $args) {
legalEntityId
householdId
legalEntityType
companyType
trusteeType
trustType
name
purpose
abn
tfn
value
growthBps
growthDollar
clientShare
partnerShare
clientSuperPhase
partnerSuperPhase
notes
clientNotes
partnerNotes
confidentialNotes
createdBy
created
updatedBy
updated
}
}
Variables
{"args": GetLegalEntitiesInput}
Response
{
"data": {
"getLegalEntities": [
{
"legalEntityId": 123,
"householdId": 987,
"legalEntityType": "abc123",
"companyType": "xyz789",
"trusteeType": "abc123",
"trustType": "abc123",
"name": "xyz789",
"purpose": "abc123",
"abn": "abc123",
"tfn": "xyz789",
"value": 123.45,
"growthBps": 987.65,
"growthDollar": 987.65,
"clientShare": 123.45,
"partnerShare": 987.65,
"clientSuperPhase": "xyz789",
"partnerSuperPhase": "xyz789",
"notes": "xyz789",
"clientNotes": "abc123",
"partnerNotes": "abc123",
"confidentialNotes": "xyz789",
"createdBy": "xyz789",
"created": "xyz789",
"updatedBy": "abc123",
"updated": "xyz789"
}
]
}
}
getLegalEntity
Response
Returns a LegalEntityOutput
Arguments
| Name | Description |
|---|---|
args - GetLegalEntityInput!
|
Example
Query
query GetLegalEntity($args: GetLegalEntityInput!) {
getLegalEntity(args: $args) {
legalEntityId
householdId
legalEntityType
companyType
trusteeType
trustType
name
purpose
abn
tfn
value
growthBps
growthDollar
clientShare
partnerShare
clientSuperPhase
partnerSuperPhase
notes
clientNotes
partnerNotes
confidentialNotes
createdBy
created
updatedBy
updated
}
}
Variables
{"args": GetLegalEntityInput}
Response
{
"data": {
"getLegalEntity": {
"legalEntityId": 987,
"householdId": 987,
"legalEntityType": "xyz789",
"companyType": "xyz789",
"trusteeType": "abc123",
"trustType": "abc123",
"name": "xyz789",
"purpose": "abc123",
"abn": "abc123",
"tfn": "abc123",
"value": 123.45,
"growthBps": 987.65,
"growthDollar": 123.45,
"clientShare": 123.45,
"partnerShare": 987.65,
"clientSuperPhase": "abc123",
"partnerSuperPhase": "xyz789",
"notes": "abc123",
"clientNotes": "xyz789",
"partnerNotes": "xyz789",
"confidentialNotes": "xyz789",
"createdBy": "abc123",
"created": "xyz789",
"updatedBy": "abc123",
"updated": "xyz789"
}
}
}
getLiabilities
Response
Returns [LiabilityOutput]
Arguments
| Name | Description |
|---|---|
args - GetLiabilitiesInput!
|
Example
Query
query GetLiabilities($args: GetLiabilitiesInput!) {
getLiabilities(args: $args) {
liabilityId
householdId
clientId
clientFirstName
clientLastName
clientPreferredName
clientIdPA
clientIdPADate
clientIdApprovalStatus
legalEntityId
legalEntityName
legalEntityIdPA
legalEntityIdPADate
legalEntityIdApprovalStatus
assetId
liabilityType
loanType
description
accountNumber
providerName
lender
maxLimit
originalAmount
owing
owingPA
owingPADate
owingApprovalStatus
rate
ratePA
ratePADate
rateApprovalStatus
interestRateType
repayment
repaymentPA
repaymentPADate
repaymentApprovalStatus
repaymentFrequency
repaymentFrequencyPA
repaymentFrequencyPADate
repaymentFrequencyApprovalStatus
monthlyPayment
notes
clientNotes
partnerNotes
confidentialNotes
displayName
externalSystem
liabilityYodleeMapping {
providerAccountId
additionalStatus
additionalStatusDescription
lastUpdated
isBroken
createdBy
created
updatedBy
updated
}
forApproval
approvalStatus
approvalChangeDate
createdBy
created
updatedBy
updated
}
}
Variables
{"args": GetLiabilitiesInput}
Response
{
"data": {
"getLiabilities": [
{
"liabilityId": 987,
"householdId": 123,
"clientId": 123,
"clientFirstName": "xyz789",
"clientLastName": "abc123",
"clientPreferredName": "xyz789",
"clientIdPA": 987,
"clientIdPADate": "xyz789",
"clientIdApprovalStatus": "xyz789",
"legalEntityId": 987,
"legalEntityName": "abc123",
"legalEntityIdPA": 987,
"legalEntityIdPADate": "xyz789",
"legalEntityIdApprovalStatus": "xyz789",
"assetId": 987,
"liabilityType": "abc123",
"loanType": "xyz789",
"description": "xyz789",
"accountNumber": "abc123",
"providerName": "abc123",
"lender": "xyz789",
"maxLimit": 123.45,
"originalAmount": 987.65,
"owing": 123.45,
"owingPA": 123.45,
"owingPADate": "abc123",
"owingApprovalStatus": "xyz789",
"rate": 123.45,
"ratePA": 987.65,
"ratePADate": "xyz789",
"rateApprovalStatus": "xyz789",
"interestRateType": "abc123",
"repayment": 123.45,
"repaymentPA": 123.45,
"repaymentPADate": "xyz789",
"repaymentApprovalStatus": "xyz789",
"repaymentFrequency": "abc123",
"repaymentFrequencyPA": "abc123",
"repaymentFrequencyPADate": "xyz789",
"repaymentFrequencyApprovalStatus": "xyz789",
"monthlyPayment": 987.65,
"notes": "abc123",
"clientNotes": "abc123",
"partnerNotes": "xyz789",
"confidentialNotes": "xyz789",
"displayName": "abc123",
"externalSystem": "IL",
"liabilityYodleeMapping": YodleeMapping,
"forApproval": false,
"approvalStatus": "xyz789",
"approvalChangeDate": "xyz789",
"createdBy": "abc123",
"created": "abc123",
"updatedBy": "abc123",
"updated": "xyz789"
}
]
}
}
getLiability
Response
Returns a LiabilityOutput
Arguments
| Name | Description |
|---|---|
args - GetLiabilityInput!
|
Example
Query
query GetLiability($args: GetLiabilityInput!) {
getLiability(args: $args) {
liabilityId
householdId
clientId
clientFirstName
clientLastName
clientPreferredName
clientIdPA
clientIdPADate
clientIdApprovalStatus
legalEntityId
legalEntityName
legalEntityIdPA
legalEntityIdPADate
legalEntityIdApprovalStatus
assetId
liabilityType
loanType
description
accountNumber
providerName
lender
maxLimit
originalAmount
owing
owingPA
owingPADate
owingApprovalStatus
rate
ratePA
ratePADate
rateApprovalStatus
interestRateType
repayment
repaymentPA
repaymentPADate
repaymentApprovalStatus
repaymentFrequency
repaymentFrequencyPA
repaymentFrequencyPADate
repaymentFrequencyApprovalStatus
monthlyPayment
notes
clientNotes
partnerNotes
confidentialNotes
displayName
externalSystem
liabilityYodleeMapping {
providerAccountId
additionalStatus
additionalStatusDescription
lastUpdated
isBroken
createdBy
created
updatedBy
updated
}
forApproval
approvalStatus
approvalChangeDate
createdBy
created
updatedBy
updated
}
}
Variables
{"args": GetLiabilityInput}
Response
{
"data": {
"getLiability": {
"liabilityId": 123,
"householdId": 123,
"clientId": 123,
"clientFirstName": "abc123",
"clientLastName": "xyz789",
"clientPreferredName": "xyz789",
"clientIdPA": 987,
"clientIdPADate": "xyz789",
"clientIdApprovalStatus": "xyz789",
"legalEntityId": 123,
"legalEntityName": "abc123",
"legalEntityIdPA": 123,
"legalEntityIdPADate": "xyz789",
"legalEntityIdApprovalStatus": "xyz789",
"assetId": 123,
"liabilityType": "xyz789",
"loanType": "xyz789",
"description": "xyz789",
"accountNumber": "xyz789",
"providerName": "xyz789",
"lender": "xyz789",
"maxLimit": 123.45,
"originalAmount": 123.45,
"owing": 987.65,
"owingPA": 987.65,
"owingPADate": "xyz789",
"owingApprovalStatus": "abc123",
"rate": 123.45,
"ratePA": 123.45,
"ratePADate": "xyz789",
"rateApprovalStatus": "abc123",
"interestRateType": "xyz789",
"repayment": 123.45,
"repaymentPA": 987.65,
"repaymentPADate": "xyz789",
"repaymentApprovalStatus": "abc123",
"repaymentFrequency": "abc123",
"repaymentFrequencyPA": "xyz789",
"repaymentFrequencyPADate": "abc123",
"repaymentFrequencyApprovalStatus": "xyz789",
"monthlyPayment": 987.65,
"notes": "xyz789",
"clientNotes": "abc123",
"partnerNotes": "abc123",
"confidentialNotes": "xyz789",
"displayName": "abc123",
"externalSystem": "IL",
"liabilityYodleeMapping": YodleeMapping,
"forApproval": false,
"approvalStatus": "xyz789",
"approvalChangeDate": "abc123",
"createdBy": "xyz789",
"created": "abc123",
"updatedBy": "abc123",
"updated": "abc123"
}
}
}
getLifeNote
Response
Returns a LifeValueNote
Arguments
| Name | Description |
|---|---|
args - LifeNoteInput!
|
Example
Query
query GetLifeNote($args: LifeNoteInput!) {
getLifeNote(args: $args) {
id
householdId
valueGroupId
note
}
}
Variables
{"args": LifeNoteInput}
Response
{
"data": {
"getLifeNote": {
"id": 987,
"householdId": 123,
"valueGroupId": 987,
"note": "xyz789"
}
}
}
getLivingDiscretionaryExpense
Response
Returns a LivingDiscretionaryExpenseOutput
Arguments
| Name | Description |
|---|---|
args - GetLivingDiscretionaryExpenseInput!
|
Example
Query
query GetLivingDiscretionaryExpense($args: GetLivingDiscretionaryExpenseInput!) {
getLivingDiscretionaryExpense(args: $args) {
livingDiscretionaryExpenseId
householdId
alimony
alimonyFrequency
childMaintenance
childMaintenanceFrequency
childCare
childCareFrequency
child
childFrequency
care
careFrequency
education
educationFrequency
rent
rentFrequency
associationFees
associationFeesFrequency
rates
ratesFrequency
water
waterFrequency
gardening
gardeningFrequency
homeImprovement
homeImprovementFrequency
repairs
repairsFrequency
electricity
electricityFrequency
gas
gasFrequency
groceries
groceriesFrequency
homePhone
homePhoneFrequency
cable
cableFrequency
broadband
broadbandFrequency
mobile
mobileFrequency
cleaning
cleaningFrequency
personalCare
personalCareFrequency
petCare
petCareFrequency
appliances
appliancesFrequency
homeOther
homeOtherFrequency
clothing
clothingFrequency
footwear
footwearFrequency
healthcare
healthcareFrequency
dental
dentalFrequency
healthcareOther
healthcareOtherFrequency
carTransport
carTransportFrequency
publicTransport
publicTransportFrequency
livingOther
livingOtherFrequency
memberships
membershipsFrequency
streaming
streamingFrequency
alcohol
alcoholFrequency
tobacco
tobaccoFrequency
entertainment
entertainmentFrequency
hobbies
hobbiesFrequency
vacations
vacationsFrequency
takeAway
takeAwayFrequency
gifts
giftsFrequency
donations
donationsFrequency
discretionaryOther
discretionaryOtherFrequency
notes
clientNotes
partnerNotes
confidentialNotes
createdBy
created
updatedBy
updated
}
}
Variables
{"args": GetLivingDiscretionaryExpenseInput}
Response
{
"data": {
"getLivingDiscretionaryExpense": {
"livingDiscretionaryExpenseId": 987,
"householdId": 987,
"alimony": 123.45,
"alimonyFrequency": "abc123",
"childMaintenance": 123.45,
"childMaintenanceFrequency": "abc123",
"childCare": 987.65,
"childCareFrequency": "abc123",
"child": 987.65,
"childFrequency": "abc123",
"care": 987.65,
"careFrequency": "xyz789",
"education": 987.65,
"educationFrequency": "xyz789",
"rent": 123.45,
"rentFrequency": "abc123",
"associationFees": 987.65,
"associationFeesFrequency": "abc123",
"rates": 123.45,
"ratesFrequency": "abc123",
"water": 123.45,
"waterFrequency": "xyz789",
"gardening": 987.65,
"gardeningFrequency": "xyz789",
"homeImprovement": 987.65,
"homeImprovementFrequency": "abc123",
"repairs": 123.45,
"repairsFrequency": "abc123",
"electricity": 123.45,
"electricityFrequency": "abc123",
"gas": 987.65,
"gasFrequency": "xyz789",
"groceries": 123.45,
"groceriesFrequency": "xyz789",
"homePhone": 987.65,
"homePhoneFrequency": "abc123",
"cable": 987.65,
"cableFrequency": "abc123",
"broadband": 123.45,
"broadbandFrequency": "abc123",
"mobile": 987.65,
"mobileFrequency": "abc123",
"cleaning": 987.65,
"cleaningFrequency": "xyz789",
"personalCare": 987.65,
"personalCareFrequency": "xyz789",
"petCare": 987.65,
"petCareFrequency": "abc123",
"appliances": 987.65,
"appliancesFrequency": "abc123",
"homeOther": 123.45,
"homeOtherFrequency": "xyz789",
"clothing": 123.45,
"clothingFrequency": "xyz789",
"footwear": 987.65,
"footwearFrequency": "xyz789",
"healthcare": 987.65,
"healthcareFrequency": "xyz789",
"dental": 987.65,
"dentalFrequency": "abc123",
"healthcareOther": 987.65,
"healthcareOtherFrequency": "abc123",
"carTransport": 123.45,
"carTransportFrequency": "xyz789",
"publicTransport": 987.65,
"publicTransportFrequency": "xyz789",
"livingOther": 123.45,
"livingOtherFrequency": "abc123",
"memberships": 987.65,
"membershipsFrequency": "xyz789",
"streaming": 123.45,
"streamingFrequency": "abc123",
"alcohol": 123.45,
"alcoholFrequency": "abc123",
"tobacco": 987.65,
"tobaccoFrequency": "xyz789",
"entertainment": 123.45,
"entertainmentFrequency": "abc123",
"hobbies": 123.45,
"hobbiesFrequency": "abc123",
"vacations": 123.45,
"vacationsFrequency": "abc123",
"takeAway": 987.65,
"takeAwayFrequency": "xyz789",
"gifts": 987.65,
"giftsFrequency": "xyz789",
"donations": 987.65,
"donationsFrequency": "abc123",
"discretionaryOther": 123.45,
"discretionaryOtherFrequency": "abc123",
"notes": "abc123",
"clientNotes": "abc123",
"partnerNotes": "xyz789",
"confidentialNotes": "abc123",
"createdBy": "xyz789",
"created": "xyz789",
"updatedBy": "abc123",
"updated": "abc123"
}
}
}
getMoneyGuideMonteCarloMeter
Response
Returns a MoneyGuideMonteCarloMeter
Arguments
| Name | Description |
|---|---|
args - GetMoneyGuideMonteCarloMeterInput
|
Example
Query
query GetMoneyGuideMonteCarloMeter($args: GetMoneyGuideMonteCarloMeterInput) {
getMoneyGuideMonteCarloMeter(args: $args) {
presignedUrl
targetLow
targetHigh
numberOfTrials
numberOfSuccessfulTrials
probabilityOfSuccess
probabilityOfSuccessFormatted
confidenceZoneResult
}
}
Variables
{"args": GetMoneyGuideMonteCarloMeterInput}
Response
{
"data": {
"getMoneyGuideMonteCarloMeter": {
"presignedUrl": "abc123",
"targetLow": 123.45,
"targetHigh": 123.45,
"numberOfTrials": 123.45,
"numberOfSuccessfulTrials": 123.45,
"probabilityOfSuccess": 123.45,
"probabilityOfSuccessFormatted": "abc123",
"confidenceZoneResult": "abc123"
}
}
}
getNetWorthTimeline
Response
Returns a NetWorthTimelineOutput
Arguments
| Name | Description |
|---|---|
args - NetWorthTimelineInput
|
Example
Query
query GetNetWorthTimeline($args: NetWorthTimelineInput) {
getNetWorthTimeline(args: $args) {
assets {
assetId
timelineData {
all {
date
value
}
R3Y {
date
value
}
R1Y {
date
value
}
YTD {
date
value
}
R3M {
date
value
}
}
}
liabilities {
liabilityId
timelineData {
all {
date
value
}
R3Y {
date
value
}
R1Y {
date
value
}
YTD {
date
value
}
R3M {
date
value
}
}
}
}
}
Variables
{"args": NetWorthTimelineInput}
Response
{
"data": {
"getNetWorthTimeline": {
"assets": [AssetTimelineData],
"liabilities": [LiabilityTimelineData]
}
}
}
getNotification
Response
Returns a Notification
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
query GetNotification($id: ID!) {
getNotification(id: $id) {
id
owner
recipient
message
messageRead
createdAt
updatedAt
}
}
Variables
{"id": "4"}
Response
{
"data": {
"getNotification": {
"id": 4,
"owner": "xyz789",
"recipient": "abc123",
"message": "abc123",
"messageRead": false,
"createdAt": AWSDateTime,
"updatedAt": AWSDateTime
}
}
}
getNotificationPointer
Response
Returns a NotificationPointer
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
query GetNotificationPointer($id: ID!) {
getNotificationPointer(id: $id) {
id
owner
recipient
notificationId
createdAt
updatedAt
}
}
Variables
{"id": 4}
Response
{
"data": {
"getNotificationPointer": {
"id": 4,
"owner": "abc123",
"recipient": "xyz789",
"notificationId": "xyz789",
"createdAt": AWSDateTime,
"updatedAt": AWSDateTime
}
}
}
getOriginationSession
Response
Returns an OriginationSession
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
query GetOriginationSession($id: ID!) {
getOriginationSession(id: $id) {
id
clientId
inviteCode
householdId
status
clientFirstName
clientLastName
clientFullName
hasPartner
partnerId
partnerFirstName
partnerLastName
partnerFullName
questionnaires
lifeIncGoals
lifeIncConnections
lifeIncFinancialDetails
finHealthAssessmentFull
foundationsFull
valuesInc3Things
governanceIncPersonalDetails
governanceIncAssetsLiabilitiesIncomeExpenses
governanceIncInsurance
governanceIncBusinessPlanning
governanceIncEducationPlanning
governanceIncCharitablePlanning
governanceIncTaxPlanning
governanceIncEstatePlanning
investmentPreferencesIncRiskSection
investmentPreferencesIncIntroSection
investmentPreferencesIncCustomisationSection
investmentPreferencesIncEthicalSection
investmentPreferencesIncAssetClassSection
investmentPreferencesIncAllocationSection
investmentPreferencesIncCostSection
investmentPreferencesIncPrioritisationSection
investmentPreferencesIncCommentsSection
uploadFileList {
prefix
folder
fileName
share
}
uploadIdentity
stepTracker {
questionId
sectionId
questionnaireStep
questionnaire
}
completedQuestionnaires
failedQuestionnaires
createdAt
updatedAt
}
}
Variables
{"id": "4"}
Response
{
"data": {
"getOriginationSession": {
"id": 4,
"clientId": 987,
"inviteCode": "xyz789",
"householdId": 123,
"status": "abc123",
"clientFirstName": "xyz789",
"clientLastName": "abc123",
"clientFullName": "xyz789",
"hasPartner": false,
"partnerId": 987,
"partnerFirstName": "xyz789",
"partnerLastName": "xyz789",
"partnerFullName": "abc123",
"questionnaires": ["LIFE"],
"lifeIncGoals": true,
"lifeIncConnections": true,
"lifeIncFinancialDetails": false,
"finHealthAssessmentFull": false,
"foundationsFull": false,
"valuesInc3Things": true,
"governanceIncPersonalDetails": false,
"governanceIncAssetsLiabilitiesIncomeExpenses": false,
"governanceIncInsurance": false,
"governanceIncBusinessPlanning": false,
"governanceIncEducationPlanning": true,
"governanceIncCharitablePlanning": true,
"governanceIncTaxPlanning": true,
"governanceIncEstatePlanning": true,
"investmentPreferencesIncRiskSection": false,
"investmentPreferencesIncIntroSection": false,
"investmentPreferencesIncCustomisationSection": true,
"investmentPreferencesIncEthicalSection": true,
"investmentPreferencesIncAssetClassSection": false,
"investmentPreferencesIncAllocationSection": true,
"investmentPreferencesIncCostSection": true,
"investmentPreferencesIncPrioritisationSection": true,
"investmentPreferencesIncCommentsSection": true,
"uploadFileList": [UploadVaultFileInfo],
"uploadIdentity": "abc123",
"stepTracker": StepTracker,
"completedQuestionnaires": ["LIFE"],
"failedQuestionnaires": ["LIFE"],
"createdAt": AWSDateTime,
"updatedAt": AWSDateTime
}
}
}
getOutstandingSurveys
Response
Returns a GetOutstandingSurveysOutput
Arguments
| Name | Description |
|---|---|
args - GetOutstandingSurveysInput
|
Example
Query
query GetOutstandingSurveys($args: GetOutstandingSurveysInput) {
getOutstandingSurveys(args: $args) {
outstandingSurveys {
householdId
names
description
}
}
}
Variables
{"args": GetOutstandingSurveysInput}
Response
{
"data": {
"getOutstandingSurveys": {
"outstandingSurveys": [OutstandingSurveyInfo]
}
}
}
getOverdueUpcomingActions
Response
Returns a GetOverdueUpcomingActionsOutput
Arguments
| Name | Description |
|---|---|
args - GetOverdueUpcomingActionsInput
|
Example
Query
query GetOverdueUpcomingActions($args: GetOverdueUpcomingActionsInput) {
getOverdueUpcomingActions(args: $args) {
overdueUpcomingActions {
type
itemType
description
householdId
names
}
}
}
Variables
{"args": GetOverdueUpcomingActionsInput}
Response
{
"data": {
"getOverdueUpcomingActions": {
"overdueUpcomingActions": [
GoalTaskOverdueUpcomingItem
]
}
}
}
getPackages
Response
Returns a PackagesOutput
Example
Query
query GetPackages {
getPackages {
packages {
code
name
description
usesHouseholdPackages
components {
code
name
description
price
numIncluded
treatIncludedAsMin
}
householdPackages {
code
name
description
requiresLicense
components {
code
name
description
price
numIncluded
treatIncludedAsMin
}
}
}
}
}
Response
{"data": {"getPackages": {"packages": [PracticePackage]}}}
getPartner
Response
Returns a Client
Arguments
| Name | Description |
|---|---|
args - ClientOrInviteCodeInput
|
Example
Query
query GetPartner($args: ClientOrInviteCodeInput) {
getPartner(args: $args) {
clientId
householdId
iamId
wealthIds
type
title
firstName
middleName
lastName
preferredName
dob
lastLogin
registered
billableStart
address {
addressId
constructedAddress
addressLine1
addressLine2
suburb
postCode
state
country
createdBy
created
updatedBy
updated
}
postalAddress {
addressId
constructedAddress
addressLine1
addressLine2
suburb
postCode
state
country
createdBy
created
updatedBy
updated
}
contactDetails {
emailAddress
mobileNumber
faxNumber
phoneNumber
createdBy
created
updatedBy
updated
}
moduleStates {
moduleStateId
clientId
previouslyCompleted
module
moduleState
sentDate
sentReminders
startedDate
startedReminders
finishedDate
expiredDate
updatedBy
updated
}
wellnessScore
goalCount
taskCount
sex
relationshipStatus
countryCodeBirth
countryCodeResidency
countryCodeCitizenship
notes
externalId
externalSystem
createdBy
created
updatedBy
updated
}
}
Variables
{"args": ClientOrInviteCodeInput}
Response
{
"data": {
"getPartner": {
"clientId": 987,
"householdId": 123,
"iamId": "xyz789",
"wealthIds": ["xyz789"],
"type": "abc123",
"title": "abc123",
"firstName": "xyz789",
"middleName": "abc123",
"lastName": "xyz789",
"preferredName": "xyz789",
"dob": "abc123",
"lastLogin": "xyz789",
"registered": false,
"billableStart": "abc123",
"address": Address,
"postalAddress": Address,
"contactDetails": ContactDetails,
"moduleStates": [ModuleState],
"wellnessScore": 123.45,
"goalCount": 123,
"taskCount": 987,
"sex": "xyz789",
"relationshipStatus": "xyz789",
"countryCodeBirth": "abc123",
"countryCodeResidency": "abc123",
"countryCodeCitizenship": "xyz789",
"notes": "abc123",
"externalId": "xyz789",
"externalSystem": "xyz789",
"createdBy": "abc123",
"created": "xyz789",
"updatedBy": "xyz789",
"updated": "xyz789"
}
}
}
getPortfolio
Response
Returns a PortfolioOutput
Arguments
| Name | Description |
|---|---|
args - GetPortfolioInput!
|
Example
Query
query GetPortfolio($args: GetPortfolioInput!) {
getPortfolio(args: $args) {
portfolioId
householdId
clientId
legalEntityId
name
type
accountNumber
riskScore
holdings {
holdingId
portfolioId
securityId
ticker
description
quantity
purchasePrice
purchaseDate
averagePrice
totalCost
marketPrice
marketPriceDate
maturityDate
interestRate
paymentFrequency
currencyCode
overrideAssetTreeId
overrideSecurityGroupId
overrideSecurityTypeId
overrideSecurityStyle
createdBy
created
updatedBy
updated
}
createdBy
created
updatedBy
updated
}
}
Variables
{"args": GetPortfolioInput}
Response
{
"data": {
"getPortfolio": {
"portfolioId": 987,
"householdId": 987,
"clientId": 987,
"legalEntityId": 123,
"name": "abc123",
"type": "xyz789",
"accountNumber": "xyz789",
"riskScore": 987.65,
"holdings": [HoldingOutput],
"createdBy": "xyz789",
"created": "abc123",
"updatedBy": "xyz789",
"updated": "abc123"
}
}
}
getPortfolios
Response
Returns [PortfolioOutput]
Arguments
| Name | Description |
|---|---|
args - GetPortfoliosInput!
|
Example
Query
query GetPortfolios($args: GetPortfoliosInput!) {
getPortfolios(args: $args) {
portfolioId
householdId
clientId
legalEntityId
name
type
accountNumber
riskScore
holdings {
holdingId
portfolioId
securityId
ticker
description
quantity
purchasePrice
purchaseDate
averagePrice
totalCost
marketPrice
marketPriceDate
maturityDate
interestRate
paymentFrequency
currencyCode
overrideAssetTreeId
overrideSecurityGroupId
overrideSecurityTypeId
overrideSecurityStyle
createdBy
created
updatedBy
updated
}
createdBy
created
updatedBy
updated
}
}
Variables
{"args": GetPortfoliosInput}
Response
{
"data": {
"getPortfolios": [
{
"portfolioId": 123,
"householdId": 123,
"clientId": 987,
"legalEntityId": 123,
"name": "xyz789",
"type": "abc123",
"accountNumber": "xyz789",
"riskScore": 987.65,
"holdings": [HoldingOutput],
"createdBy": "xyz789",
"created": "xyz789",
"updatedBy": "abc123",
"updated": "abc123"
}
]
}
}
getPowerOf
Response
Returns a PowerOfOutput
Arguments
| Name | Description |
|---|---|
args - GetPowerOfInput!
|
Example
Query
query GetPowerOf($args: GetPowerOfInput!) {
getPowerOf(args: $args) {
powerOfId
estatePlanningId
powerOfType
poaTypeEnduring
poaTypeMedical
poaTypeLimited
poaTypeCare
poaTypeOther
firstName
middleName
lastName
isAlternate
notes
clientNotes
partnerNotes
confidentialNotes
createdBy
created
updatedBy
updated
}
}
Variables
{"args": GetPowerOfInput}
Response
{
"data": {
"getPowerOf": {
"powerOfId": 123,
"estatePlanningId": 123,
"powerOfType": "abc123",
"poaTypeEnduring": false,
"poaTypeMedical": true,
"poaTypeLimited": true,
"poaTypeCare": true,
"poaTypeOther": true,
"firstName": "abc123",
"middleName": "xyz789",
"lastName": "xyz789",
"isAlternate": true,
"notes": "xyz789",
"clientNotes": "xyz789",
"partnerNotes": "abc123",
"confidentialNotes": "xyz789",
"createdBy": "xyz789",
"created": "abc123",
"updatedBy": "abc123",
"updated": "abc123"
}
}
}
getPowerOfs
Response
Returns [PowerOfOutput]
Arguments
| Name | Description |
|---|---|
args - GetPowerOfsInput!
|
Example
Query
query GetPowerOfs($args: GetPowerOfsInput!) {
getPowerOfs(args: $args) {
powerOfId
estatePlanningId
powerOfType
poaTypeEnduring
poaTypeMedical
poaTypeLimited
poaTypeCare
poaTypeOther
firstName
middleName
lastName
isAlternate
notes
clientNotes
partnerNotes
confidentialNotes
createdBy
created
updatedBy
updated
}
}
Variables
{"args": GetPowerOfsInput}
Response
{
"data": {
"getPowerOfs": [
{
"powerOfId": 987,
"estatePlanningId": 123,
"powerOfType": "xyz789",
"poaTypeEnduring": false,
"poaTypeMedical": true,
"poaTypeLimited": false,
"poaTypeCare": true,
"poaTypeOther": true,
"firstName": "abc123",
"middleName": "xyz789",
"lastName": "abc123",
"isAlternate": true,
"notes": "xyz789",
"clientNotes": "xyz789",
"partnerNotes": "abc123",
"confidentialNotes": "abc123",
"createdBy": "xyz789",
"created": "abc123",
"updatedBy": "xyz789",
"updated": "xyz789"
}
]
}
}
getPractice
Response
Returns a Practice
Arguments
| Name | Description |
|---|---|
args - GetPracticeInput
|
Example
Query
query GetPractice($args: GetPracticeInput) {
getPractice(args: $args) {
practiceId
practiceCode
dealerGroup {
dealerGroupId
name
abn
afsl
afslName
legalName
createdBy
created
updatedBy
updated
}
name
abn
afsl
afslName
legalName
status
originalStatus
ilgn
config {
practiceConfigId
practiceId
palette {
primary {
bgColor
fgColor
}
secondary {
bgColor
fgColor
}
buttons {
primary {
...PracticeConfigPaletteBGFGColorsFragment
}
secondary {
...PracticeConfigPaletteBGFGColorsFragment
}
}
backgrounds {
main {
...PracticeConfigPaletteBGFGColorsFragment
}
workbench {
...PracticeConfigPaletteBGFGColorsFragment
}
}
}
typography {
mainFontFamily
mainMonoFontFamily
}
configuration {
modules {
bestLife {
...PracticeConfigConfigurationModuleBestLifeFragment
}
bestLifePlan {
...PracticeConfigConfigurationModuleBestLifePlanFragment
}
foundations {
...PracticeConfigConfigurationModuleFoundationsFragment
}
goals {
...PracticeConfigConfigurationModuleGoalsFragment
}
governance {
...PracticeConfigConfigurationModuleGovernanceFragment
}
healthAssessment {
...PracticeConfigConfigurationModuleHealthAssessmentFragment
}
invPrefs {
...PracticeConfigConfigurationModuleInvPrefsFragment
}
life {
...PracticeConfigConfigurationModuleLifeFragment
}
strategies {
...PracticeConfigConfigurationModuleStrategiesFragment
}
surveys {
...PracticeConfigConfigurationModuleSurveysFragment
}
tasks {
...PracticeConfigConfigurationModuleTasksFragment
}
termsOfEngagement {
...PracticeConfigConfigurationModuleTermsOfEngagementFragment
}
values {
...PracticeConfigConfigurationModuleValuesFragment
}
vault {
...PracticeConfigConfigurationModuleVaultFragment
}
wealth {
...PracticeConfigConfigurationModuleWealthFragment
}
netWorth {
...PracticeConfigConfigurationModuleNetWorthFragment
}
}
notification {
emailOverrideTo
emailSender
emailSenderName
emailCC
emailSignature
disableTaskEmailNotification
}
mfa {
enforceStaffMfa
}
defaultClientSharing
lockClientDetails
inAppNotifications {
enabled
}
filterSettings {
getHouseholdsFilterSettings {
...PracticeConfigConfigurationFilterSettingsGetHouseholdsFragment
}
}
removeLogoWhiteBackground {
enabled
}
}
theme
}
usesExternalDomain
practicePackageCode
whiteLabelling
logos {
id
practiceLogoId
practiceId
type
logo
createdBy
created
updatedBy
updated
}
offices {
practiceOfficeId
contactDetails {
emailAddress
mobileNumber
faxNumber
phoneNumber
createdBy
created
updatedBy
updated
}
address {
addressId
constructedAddress
addressLine1
addressLine2
suburb
postCode
state
country
createdBy
created
updatedBy
updated
}
name
createdBy
created
updatedBy
updated
}
homeRegion
homeLocale
createdBy
created
updatedBy
updated
}
}
Variables
{"args": GetPracticeInput}
Response
{
"data": {
"getPractice": {
"practiceId": 123,
"practiceCode": "xyz789",
"dealerGroup": DealerGroup,
"name": "abc123",
"abn": "xyz789",
"afsl": "abc123",
"afslName": "xyz789",
"legalName": "abc123",
"status": "abc123",
"originalStatus": "abc123",
"ilgn": "abc123",
"config": PracticeConfig,
"usesExternalDomain": true,
"practicePackageCode": "abc123",
"whiteLabelling": false,
"logos": [PracticeLogo],
"offices": [PracticeOffice],
"homeRegion": "abc123",
"homeLocale": "xyz789",
"createdBy": "xyz789",
"created": "abc123",
"updatedBy": "xyz789",
"updated": "abc123"
}
}
}
getPracticeAssetAllocations
Response
Returns [PracticeAssetAllocation]
Arguments
| Name | Description |
|---|---|
args - GetPracticeAssetAllocationsInput
|
Example
Query
query GetPracticeAssetAllocations($args: GetPracticeAssetAllocationsInput) {
getPracticeAssetAllocations(args: $args) {
practiceAssetAllocationId
riskGroup
assetTreeId
useStyles
saaMin
saa
saaMax
taaMin
taa
taaMax
styleTopLeft
styleTopCenter
styleTopRight
styleMiddleLeft
styleMiddleCenter
styleMiddleRight
styleBottomLeft
styleBottomCenter
styleBottomRight
createdBy
created
updatedBy
updated
}
}
Variables
{"args": GetPracticeAssetAllocationsInput}
Response
{
"data": {
"getPracticeAssetAllocations": [
{
"practiceAssetAllocationId": 987,
"riskGroup": 987,
"assetTreeId": 123,
"useStyles": true,
"saaMin": 123.45,
"saa": 987.65,
"saaMax": 987.65,
"taaMin": 987.65,
"taa": 123.45,
"taaMax": 987.65,
"styleTopLeft": 987.65,
"styleTopCenter": 987.65,
"styleTopRight": 123.45,
"styleMiddleLeft": 987.65,
"styleMiddleCenter": 123.45,
"styleMiddleRight": 987.65,
"styleBottomLeft": 987.65,
"styleBottomCenter": 123.45,
"styleBottomRight": 987.65,
"createdBy": "xyz789",
"created": "xyz789",
"updatedBy": "abc123",
"updated": "xyz789"
}
]
}
}
getPracticeConfig
Response
Returns a PracticeConfig
Arguments
| Name | Description |
|---|---|
args - GetPracticeConfig
|
Example
Query
query GetPracticeConfig($args: GetPracticeConfig) {
getPracticeConfig(args: $args) {
practiceConfigId
practiceId
palette {
primary {
bgColor
fgColor
}
secondary {
bgColor
fgColor
}
buttons {
primary {
bgColor
fgColor
}
secondary {
bgColor
fgColor
}
}
backgrounds {
main {
bgColor
fgColor
}
workbench {
bgColor
fgColor
}
}
}
typography {
mainFontFamily
mainMonoFontFamily
}
configuration {
modules {
bestLife {
name
shortName
}
bestLifePlan {
name
shortName
}
foundations {
hideSwitch
defaultFull
}
goals {
name
shortName
}
governance {
name
shortName
}
healthAssessment {
name
shortName
}
invPrefs {
name
shortName
introVideoUrl
introVideoS3Filename
customisationVideoUrl
customisationVideoS3Filename
ethicalVideoUrl
ethicalVideoS3Filename
assetClassVideoUrl
assetClassVideoS3Filename
allocationVideoUrl
allocationVideoS3Filename
riskVideoUrl
riskVideoS3Filename
costVideoUrl
costVideoS3Filename
createTaskOnCompletion
}
life {
name
shortName
introVideoUrl
introVideoS3Filename
connectionsOverride
factFindOverride
createTaskOnCompletion
}
strategies {
name
categoryName
strategyName
shortName
}
surveys {
name
shortName
surveyTemplateLocationMap {
...PracticeConfigConfigurationModuleSurveysSurveyTemplateLocationMapFragment
}
}
tasks {
name
shortName
}
termsOfEngagement {
sections {
...PracticeConfigConfigurationModuleTermsOfEngagementSectionsFragment
}
}
values {
name
shortName
introVideoUrl
introVideoS3Filename
}
vault {
name
shortName
bestLifePlans
bestLifePlansEnabled
retirementDocuments
retirementDocumentsEnabled
legalDocuments
legalDocumentsEnabled
identityDocuments
identityDocumentsEnabled
estatePlanningDocuments
estatePlanningDocumentsEnabled
adviceDocuments
adviceDocumentsEnabled
taxReturns
taxReturnsEnabled
businessStructures
businessStructuresEnabled
insuranceDocuments
insuranceDocumentsEnabled
educationDocuments
educationDocumentsEnabled
otherDocuments
otherDocumentsEnabled
actionRequired
actionRequiredEnabled
folders {
...VaultFolderFragment
}
}
wealth {
name
shortName
}
netWorth {
name
shortName
}
}
notification {
emailOverrideTo
emailSender
emailSenderName
emailCC
emailSignature
disableTaskEmailNotification
}
mfa {
enforceStaffMfa
}
defaultClientSharing
lockClientDetails
inAppNotifications {
enabled
}
filterSettings {
getHouseholdsFilterSettings {
showAllClients
}
}
removeLogoWhiteBackground {
enabled
}
}
theme
}
}
Variables
{"args": GetPracticeConfig}
Response
{
"data": {
"getPracticeConfig": {
"practiceConfigId": 123,
"practiceId": 987,
"palette": PracticeConfigPalette,
"typography": PracticeConfigTypography,
"configuration": PracticeConfigConfiguration,
"theme": "xyz789"
}
}
}
getPracticeConfigVaultFolders
Response
Returns a PracticeConfigVaultFolders
Arguments
| Name | Description |
|---|---|
args - GetPracticeConfigVaultFolders
|
Example
Query
query GetPracticeConfigVaultFolders($args: GetPracticeConfigVaultFolders) {
getPracticeConfigVaultFolders(args: $args) {
practiceId
folders {
id
name
order
enabled
readonly
}
}
}
Variables
{"args": GetPracticeConfigVaultFolders}
Response
{
"data": {
"getPracticeConfigVaultFolders": {
"practiceId": 987,
"folders": [VaultFolder]
}
}
}
getPracticeIntegrations
Response
Returns [PracticeIntegration]
Arguments
| Name | Description |
|---|---|
args - GetPracticeIntegrationsInput
|
Example
Query
query GetPracticeIntegrations($args: GetPracticeIntegrationsInput) {
getPracticeIntegrations(args: $args) {
practiceIntegrationId
name
description
enabled
createdBy
created
updatedBy
updated
lastSynced
integrationType
integrationMeta1
integrationMeta2
integrationMeta3
integrationMeta4
integrationMeta5
integrationMeta6
integrationMeta7
integrationMeta8
}
}
Variables
{"args": GetPracticeIntegrationsInput}
Response
{
"data": {
"getPracticeIntegrations": [
{
"practiceIntegrationId": 987,
"name": "abc123",
"description": "xyz789",
"enabled": true,
"createdBy": "abc123",
"created": "abc123",
"updatedBy": "abc123",
"updated": "xyz789",
"lastSynced": "xyz789",
"integrationType": "xyz789",
"integrationMeta1": "xyz789",
"integrationMeta2": "abc123",
"integrationMeta3": "abc123",
"integrationMeta4": "xyz789",
"integrationMeta5": "xyz789",
"integrationMeta6": "xyz789",
"integrationMeta7": "abc123",
"integrationMeta8": "abc123"
}
]
}
}
getPracticeKeyAdviceAreas
Response
Returns [PracticeKeyAdviceArea]
Arguments
| Name | Description |
|---|---|
args - GetPracticeKeyAdviceAreasInput
|
Example
Query
query GetPracticeKeyAdviceAreas($args: GetPracticeKeyAdviceAreasInput) {
getPracticeKeyAdviceAreas(args: $args) {
practiceKeyAdviceAreaId
categoryName
description
rank
muiIconName
createdBy
created
updatedBy
updated
strategies {
practiceStrategyId
practiceKeyAdviceAreaId
strategyName
details
createdBy
created
updatedBy
updated
}
}
}
Variables
{"args": GetPracticeKeyAdviceAreasInput}
Response
{
"data": {
"getPracticeKeyAdviceAreas": [
{
"practiceKeyAdviceAreaId": 987,
"categoryName": "xyz789",
"description": "abc123",
"rank": 123,
"muiIconName": "xyz789",
"createdBy": "xyz789",
"created": "xyz789",
"updatedBy": "xyz789",
"updated": "abc123",
"strategies": [PracticeStrategy]
}
]
}
}
getPracticeLogos
Response
Returns [PracticeLogo]
Arguments
| Name | Description |
|---|---|
practiceCode - String
|
Example
Query
query GetPracticeLogos($practiceCode: String) {
getPracticeLogos(practiceCode: $practiceCode) {
id
practiceLogoId
practiceId
type
logo
createdBy
created
updatedBy
updated
}
}
Variables
{"practiceCode": "abc123"}
Response
{
"data": {
"getPracticeLogos": [
{
"id": 4,
"practiceLogoId": 123,
"practiceId": 123,
"type": "xyz789",
"logo": "abc123",
"createdBy": "abc123",
"created": "abc123",
"updatedBy": "abc123",
"updated": "xyz789"
}
]
}
}
getPracticeRiskProfiles
Response
Returns [PracticeRiskProfile]
Arguments
| Name | Description |
|---|---|
args - GetPracticeRiskProfilesInput
|
Example
Query
query GetPracticeRiskProfiles($args: GetPracticeRiskProfilesInput) {
getPracticeRiskProfiles(args: $args) {
practiceRiskProfileId
riskGroup
name
description
enabled
createdBy
created
updatedBy
updated
}
}
Variables
{"args": GetPracticeRiskProfilesInput}
Response
{
"data": {
"getPracticeRiskProfiles": [
{
"practiceRiskProfileId": 123,
"riskGroup": 987,
"name": "abc123",
"description": "xyz789",
"enabled": true,
"createdBy": "xyz789",
"created": "xyz789",
"updatedBy": "abc123",
"updated": "xyz789"
}
]
}
}
getPracticeSegmentation
Response
Returns [PracticeSegmentation]
Arguments
| Name | Description |
|---|---|
args - GetPracticeSegmentationInput
|
Example
Query
query GetPracticeSegmentation($args: GetPracticeSegmentationInput) {
getPracticeSegmentation(args: $args) {
practiceSegmentationId
segmentName
description
rank
configuration
householdCount
createdBy
created
updatedBy
updated
}
}
Variables
{"args": GetPracticeSegmentationInput}
Response
{
"data": {
"getPracticeSegmentation": [
{
"practiceSegmentationId": 123,
"segmentName": "xyz789",
"description": "abc123",
"rank": 987,
"configuration": "abc123",
"householdCount": 123,
"createdBy": "xyz789",
"created": "abc123",
"updatedBy": "abc123",
"updated": "xyz789"
}
]
}
}
getPracticeStrategies
Response
Returns [PracticeStrategy]
Arguments
| Name | Description |
|---|---|
args - GetPracticeStrategiesInput
|
Example
Query
query GetPracticeStrategies($args: GetPracticeStrategiesInput) {
getPracticeStrategies(args: $args) {
practiceStrategyId
practiceKeyAdviceAreaId
strategyName
details
createdBy
created
updatedBy
updated
}
}
Variables
{"args": GetPracticeStrategiesInput}
Response
{
"data": {
"getPracticeStrategies": [
{
"practiceStrategyId": 987,
"practiceKeyAdviceAreaId": 987,
"strategyName": "xyz789",
"details": "xyz789",
"createdBy": "xyz789",
"created": "xyz789",
"updatedBy": "xyz789",
"updated": "abc123"
}
]
}
}
getPractices
Response
Returns a GetPracticesOutput
Arguments
| Name | Description |
|---|---|
args - GetPracticesInput
|
Example
Query
query GetPractices($args: GetPracticesInput) {
getPractices(args: $args) {
practices {
practiceId
practiceCode
dealerGroup {
dealerGroupId
name
abn
afsl
afslName
legalName
createdBy
created
updatedBy
updated
}
name
abn
afsl
afslName
legalName
status
originalStatus
ilgn
config {
practiceConfigId
practiceId
palette {
primary {
...PracticeConfigPaletteBGFGColorsFragment
}
secondary {
...PracticeConfigPaletteBGFGColorsFragment
}
buttons {
...PracticeConfigPaletteButtonsFragment
}
backgrounds {
...PracticeConfigPaletteBackgroundsFragment
}
}
typography {
mainFontFamily
mainMonoFontFamily
}
configuration {
modules {
...PracticeConfigConfigurationModulesFragment
}
notification {
...PracticeConfigConfigurationNotificationFragment
}
mfa {
...PracticeConfigConfigurationMFAFragment
}
defaultClientSharing
lockClientDetails
inAppNotifications {
...PracticeConfigConfigurationInAppNotificationFragment
}
filterSettings {
...PracticeConfigConfigurationFilterSettingsFragment
}
removeLogoWhiteBackground {
...PracticeConfigConfigurationRemoveLogoWhiteBackgroundFragment
}
}
theme
}
usesExternalDomain
practicePackageCode
whiteLabelling
logos {
id
practiceLogoId
practiceId
type
logo
createdBy
created
updatedBy
updated
}
offices {
practiceOfficeId
contactDetails {
emailAddress
mobileNumber
faxNumber
phoneNumber
createdBy
created
updatedBy
updated
}
address {
addressId
constructedAddress
addressLine1
addressLine2
suburb
postCode
state
country
createdBy
created
updatedBy
updated
}
name
createdBy
created
updatedBy
updated
}
homeRegion
homeLocale
createdBy
created
updatedBy
updated
}
pagination {
page
pageSize
numPages
numItems
}
}
}
Variables
{"args": GetPracticesInput}
Response
{
"data": {
"getPractices": {
"practices": [Practice],
"pagination": Pagination
}
}
}
getPresignedUploadUrl
Response
Returns a GetPresignedUploadUrlOutput
Arguments
| Name | Description |
|---|---|
args - GetPresignedUploadUrlInput!
|
Example
Query
query GetPresignedUploadUrl($args: GetPresignedUploadUrlInput!) {
getPresignedUploadUrl(args: $args) {
identityId
preSignedUploadURL
preSignedUploadURLKey
preSignedUploadURLAccessKeyId
preSignedUploadSecurityToken
preSignedUploadURLPolicy
preSignedUploadURLSignature
}
}
Variables
{"args": GetPresignedUploadUrlInput}
Response
{
"data": {
"getPresignedUploadUrl": {
"identityId": "xyz789",
"preSignedUploadURL": "abc123",
"preSignedUploadURLKey": "xyz789",
"preSignedUploadURLAccessKeyId": "abc123",
"preSignedUploadSecurityToken": "abc123",
"preSignedUploadURLPolicy": "xyz789",
"preSignedUploadURLSignature": "xyz789"
}
}
}
getPresignedUploadUrlIdentityId
Response
Returns a String
Arguments
| Name | Description |
|---|---|
args - GetPresignedUploadUrlIdentityIdInput!
|
Example
Query
query GetPresignedUploadUrlIdentityId($args: GetPresignedUploadUrlIdentityIdInput!) {
getPresignedUploadUrlIdentityId(args: $args)
}
Variables
{"args": GetPresignedUploadUrlIdentityIdInput}
Response
{
"data": {
"getPresignedUploadUrlIdentityId": "xyz789"
}
}
getPresignedUrlFiles
Response
Returns a GetPresignedUrlFilesOutput
Arguments
| Name | Description |
|---|---|
args - GetPresignedUrlFilesInput!
|
Example
Query
query GetPresignedUrlFiles($args: GetPresignedUrlFilesInput!) {
getPresignedUrlFiles(args: $args) {
files {
id
fileName
presignDownloadUrl
createdDatetime
}
page
pageSize
pages
totalCount
}
}
Variables
{"args": GetPresignedUrlFilesInput}
Response
{
"data": {
"getPresignedUrlFiles": {
"files": [PresignedUrlFilesListItem],
"page": 987,
"pageSize": 123,
"pages": 123,
"totalCount": 987
}
}
}
getProfessionalContact
Response
Returns a ProfessionalContactOutput
Arguments
| Name | Description |
|---|---|
args - GetProfessionalContactInput!
|
Example
Query
query GetProfessionalContact($args: GetProfessionalContactInput!) {
getProfessionalContact(args: $args) {
professionalContactId
householdId
contactType
contactTypeDetails
name
company
phoneNumber
emailAddress
address
authorityToContact
relationshipQuality
notes
clientNotes
partnerNotes
confidentialNotes
createdBy
created
updatedBy
updated
}
}
Variables
{"args": GetProfessionalContactInput}
Response
{
"data": {
"getProfessionalContact": {
"professionalContactId": 987,
"householdId": 123,
"contactType": "xyz789",
"contactTypeDetails": "abc123",
"name": "xyz789",
"company": "abc123",
"phoneNumber": "xyz789",
"emailAddress": "xyz789",
"address": "xyz789",
"authorityToContact": true,
"relationshipQuality": "abc123",
"notes": "xyz789",
"clientNotes": "abc123",
"partnerNotes": "abc123",
"confidentialNotes": "xyz789",
"createdBy": "abc123",
"created": "abc123",
"updatedBy": "xyz789",
"updated": "xyz789"
}
}
}
getProfessionalContacts
Response
Returns [ProfessionalContactOutput]
Arguments
| Name | Description |
|---|---|
args - GetProfessionalContactsInput!
|
Example
Query
query GetProfessionalContacts($args: GetProfessionalContactsInput!) {
getProfessionalContacts(args: $args) {
professionalContactId
householdId
contactType
contactTypeDetails
name
company
phoneNumber
emailAddress
address
authorityToContact
relationshipQuality
notes
clientNotes
partnerNotes
confidentialNotes
createdBy
created
updatedBy
updated
}
}
Variables
{"args": GetProfessionalContactsInput}
Response
{
"data": {
"getProfessionalContacts": [
{
"professionalContactId": 987,
"householdId": 987,
"contactType": "xyz789",
"contactTypeDetails": "xyz789",
"name": "xyz789",
"company": "abc123",
"phoneNumber": "xyz789",
"emailAddress": "xyz789",
"address": "xyz789",
"authorityToContact": true,
"relationshipQuality": "xyz789",
"notes": "xyz789",
"clientNotes": "xyz789",
"partnerNotes": "abc123",
"confidentialNotes": "abc123",
"createdBy": "xyz789",
"created": "xyz789",
"updatedBy": "abc123",
"updated": "xyz789"
}
]
}
}
getProfileImage
Response
Returns a String
Example
Query
query GetProfileImage {
getProfileImage
}
Response
{"data": {"getProfileImage": "abc123"}}
getQuickSurveys
Response
Returns [GetQuickSurveysOutput]
Arguments
| Name | Description |
|---|---|
args - GetQuickSurveysInput!
|
Example
Query
query GetQuickSurveys($args: GetQuickSurveysInput!) {
getQuickSurveys(args: $args) {
sessionId
sessionName
surveys {
surveyId
surveyName
lifeIncludeConnections
lifeIncludeGoals
valuesIncludeLegacy
foundationsShort
foundationsLong
foundationsIncludeDetails
foundationsIncludeInsurance
foundationsIncludeEstatePlanning
foundationsIncludeBusinessPlanning
fhaLongAssessment
fhaShortAssessment
}
}
}
Variables
{"args": GetQuickSurveysInput}
Response
{
"data": {
"getQuickSurveys": [
{
"sessionId": "xyz789",
"sessionName": "abc123",
"surveys": [GetQuickSurveyResponseSurveyOutput]
}
]
}
}
getRawFeedFiles
Response
Returns a GetRawFeedFilesOutput
Arguments
| Name | Description |
|---|---|
args - GetRawFeedFilesInput
|
Example
Query
query GetRawFeedFiles($args: GetRawFeedFilesInput) {
getRawFeedFiles(args: $args) {
preSignedZipURL
}
}
Variables
{"args": GetRawFeedFilesInput}
Response
{
"data": {
"getRawFeedFiles": {
"preSignedZipURL": "abc123"
}
}
}
getRedtailLoadErrors
Response
Returns a RedtailLoadErrors
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
query GetRedtailLoadErrors($id: ID!) {
getRedtailLoadErrors(id: $id) {
id
errorMessage
redtailPayload
createdAt
updatedAt
}
}
Variables
{"id": 4}
Response
{
"data": {
"getRedtailLoadErrors": {
"id": "4",
"errorMessage": "xyz789",
"redtailPayload": "abc123",
"createdAt": AWSDateTime,
"updatedAt": AWSDateTime
}
}
}
getRegistration
Response
Returns a Registration
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
query GetRegistration($id: ID!) {
getRegistration(id: $id) {
id
clientId
inviteCode
fullName
createdAt
updatedAt
}
}
Variables
{"id": "4"}
Response
{
"data": {
"getRegistration": {
"id": 4,
"clientId": 987,
"inviteCode": "xyz789",
"fullName": "abc123",
"createdAt": AWSDateTime,
"updatedAt": AWSDateTime
}
}
}
getRetirementDetails
Response
Returns a RetirementDetailsOutput
Arguments
| Name | Description |
|---|---|
args - GetRetirementDetailsInput!
|
Example
Query
query GetRetirementDetails($args: GetRetirementDetailsInput!) {
getRetirementDetails(args: $args) {
retirementDetailsId
clientId
retirementAge
requiredIncome
retirementLifestyle
notes
confidentialNotes
createdBy
created
updatedBy
updated
}
}
Variables
{"args": GetRetirementDetailsInput}
Response
{
"data": {
"getRetirementDetails": {
"retirementDetailsId": 987,
"clientId": 987,
"retirementAge": 987,
"requiredIncome": 987.65,
"retirementLifestyle": "abc123",
"notes": "xyz789",
"confidentialNotes": "xyz789",
"createdBy": "xyz789",
"created": "xyz789",
"updatedBy": "xyz789",
"updated": "abc123"
}
}
}
getRiskProfile
Response
Returns a RiskProfileOutput
Arguments
| Name | Description |
|---|---|
args - GetRiskProfileInput!
|
Example
Query
query GetRiskProfile($args: GetRiskProfileInput!) {
getRiskProfile(args: $args) {
riskProfileId
householdId
clientId
legalEntityId
riskProfileAssessed
riskProfileDirected
riskProfileDirectedBy
notes
clientNotes
partnerNotes
confidentialNotes
createdBy
created
updatedBy
updated
}
}
Variables
{"args": GetRiskProfileInput}
Response
{
"data": {
"getRiskProfile": {
"riskProfileId": 987,
"householdId": 987,
"clientId": 123,
"legalEntityId": 123,
"riskProfileAssessed": 123,
"riskProfileDirected": 123,
"riskProfileDirectedBy": "xyz789",
"notes": "abc123",
"clientNotes": "abc123",
"partnerNotes": "abc123",
"confidentialNotes": "xyz789",
"createdBy": "abc123",
"created": "xyz789",
"updatedBy": "xyz789",
"updated": "abc123"
}
}
}
getRiskProfiles
Response
Returns [RiskProfileOutput]
Arguments
| Name | Description |
|---|---|
args - GetRiskProfilesInput!
|
Example
Query
query GetRiskProfiles($args: GetRiskProfilesInput!) {
getRiskProfiles(args: $args) {
riskProfileId
householdId
clientId
legalEntityId
riskProfileAssessed
riskProfileDirected
riskProfileDirectedBy
notes
clientNotes
partnerNotes
confidentialNotes
createdBy
created
updatedBy
updated
}
}
Variables
{"args": GetRiskProfilesInput}
Response
{
"data": {
"getRiskProfiles": [
{
"riskProfileId": 987,
"householdId": 123,
"clientId": 123,
"legalEntityId": 123,
"riskProfileAssessed": 123,
"riskProfileDirected": 123,
"riskProfileDirectedBy": "xyz789",
"notes": "abc123",
"clientNotes": "abc123",
"partnerNotes": "abc123",
"confidentialNotes": "abc123",
"createdBy": "xyz789",
"created": "abc123",
"updatedBy": "xyz789",
"updated": "xyz789"
}
]
}
}
getScenario
Response
Returns a BestLifeProjectionOutput
Arguments
| Name | Description |
|---|---|
args - GetScenarioInput
|
Example
Query
query GetScenario($args: GetScenarioInput) {
getScenario(args: $args) {
scenarioId
name
timeline {
data
}
chart {
data
chartSchema
timeMarkers
dataMarkers
}
latestInputs {
data {
scenarioId
name
includeClient
clientAge
clientIncome
clientSuperannuation
clientSuperannuationContribution
clientSuperannuationContributionIsInDollars
clientSuperannuationMatchBps
clientSuperannuationMatchEndsBps
clientSuperannuationFee
clientSuperannuationFeeIsInDollars
clientSuperOther
clientSuperOtherContribution
clientSuperOtherContributionIsInDollars
clientSuperOtherFee
clientSuperOtherFeeIsInDollars
clientRetirementAge
clientPensionPaidFromAge
clientLifeExpectancyAge
clientIncomeRateChange
includePartner
partnerAge
partnerIncome
partnerSuperannuation
partnerSuperannuationContribution
partnerSuperannuationContributionIsInDollars
partnerSuperannuationMatchBps
partnerSuperannuationMatchEndsBps
partnerSuperannuationFee
partnerSuperannuationFeeIsInDollars
partnerSuperOther
partnerSuperOtherContribution
partnerSuperOtherContributionIsInDollars
partnerSuperOtherFee
partnerSuperOtherFeeIsInDollars
partnerRetirementAge
partnerPensionPaidFromAge
partnerLifeExpectancyAge
partnerIncomeRateChange
businessValueGrowthPerAnnum
businessValue
businessEstimatedDateOfSale
businessEstimatedSaleAmount
businessEstimatedTaxOnSale
householdPersonalAssets
householdPersonalDebt
householdProperty
householdPropertyDebt
householdInvestmentProperties
householdInvestmentPropertiesDebt
householdNonSuperInvestments
householdNonSuperInvestmentsFee
householdNonSuperInvestmentsFeeIsInDollars
householdPreRetirementAvgTax
householdPostRetirementAvgTax
householdIncome
householdSavings
householdCashFlow {
id
year
clientAge
clientIncome
clientStatus
partnerAge
partnerIncome
partnerStatus
householdIncome
totalIncome
incomeSaved
incomeSpent
reqRetirementIncome
contribution
withdrawal
}
householdCashFlowHeader
reqRetirementIncome
reqRetirementIncomeRateChange
referenceModel
bestLifeScore
excessCashAllocations {
allocationEnabled
allocationType
allocationRank
maxAmountDollar
maxAmountBps
}
reduceShortfallAllocations {
allocationEnabled
allocationType
allocationRank
maxAmountDollar
maxAmountBps
}
}
}
report {
data
}
}
}
Variables
{"args": GetScenarioInput}
Response
{
"data": {
"getScenario": {
"scenarioId": 987,
"name": "abc123",
"timeline": BestLifeProjectionTimelineData,
"chart": BestLifeProjectionChartData,
"latestInputs": BestLifeProjectionLatestInputsData,
"report": BestLifeReportData
}
}
}
getScenarios
Response
Returns [BestLifeProjectionOutput]
Arguments
| Name | Description |
|---|---|
args - GetScenarioInput
|
Example
Query
query GetScenarios($args: GetScenarioInput) {
getScenarios(args: $args) {
scenarioId
name
timeline {
data
}
chart {
data
chartSchema
timeMarkers
dataMarkers
}
latestInputs {
data {
scenarioId
name
includeClient
clientAge
clientIncome
clientSuperannuation
clientSuperannuationContribution
clientSuperannuationContributionIsInDollars
clientSuperannuationMatchBps
clientSuperannuationMatchEndsBps
clientSuperannuationFee
clientSuperannuationFeeIsInDollars
clientSuperOther
clientSuperOtherContribution
clientSuperOtherContributionIsInDollars
clientSuperOtherFee
clientSuperOtherFeeIsInDollars
clientRetirementAge
clientPensionPaidFromAge
clientLifeExpectancyAge
clientIncomeRateChange
includePartner
partnerAge
partnerIncome
partnerSuperannuation
partnerSuperannuationContribution
partnerSuperannuationContributionIsInDollars
partnerSuperannuationMatchBps
partnerSuperannuationMatchEndsBps
partnerSuperannuationFee
partnerSuperannuationFeeIsInDollars
partnerSuperOther
partnerSuperOtherContribution
partnerSuperOtherContributionIsInDollars
partnerSuperOtherFee
partnerSuperOtherFeeIsInDollars
partnerRetirementAge
partnerPensionPaidFromAge
partnerLifeExpectancyAge
partnerIncomeRateChange
businessValueGrowthPerAnnum
businessValue
businessEstimatedDateOfSale
businessEstimatedSaleAmount
businessEstimatedTaxOnSale
householdPersonalAssets
householdPersonalDebt
householdProperty
householdPropertyDebt
householdInvestmentProperties
householdInvestmentPropertiesDebt
householdNonSuperInvestments
householdNonSuperInvestmentsFee
householdNonSuperInvestmentsFeeIsInDollars
householdPreRetirementAvgTax
householdPostRetirementAvgTax
householdIncome
householdSavings
householdCashFlow {
id
year
clientAge
clientIncome
clientStatus
partnerAge
partnerIncome
partnerStatus
householdIncome
totalIncome
incomeSaved
incomeSpent
reqRetirementIncome
contribution
withdrawal
}
householdCashFlowHeader
reqRetirementIncome
reqRetirementIncomeRateChange
referenceModel
bestLifeScore
excessCashAllocations {
allocationEnabled
allocationType
allocationRank
maxAmountDollar
maxAmountBps
}
reduceShortfallAllocations {
allocationEnabled
allocationType
allocationRank
maxAmountDollar
maxAmountBps
}
}
}
report {
data
}
}
}
Variables
{"args": GetScenarioInput}
Response
{
"data": {
"getScenarios": [
{
"scenarioId": 123,
"name": "xyz789",
"timeline": BestLifeProjectionTimelineData,
"chart": BestLifeProjectionChartData,
"latestInputs": BestLifeProjectionLatestInputsData,
"report": BestLifeReportData
}
]
}
}
getSecurity
Example
Query
query GetSecurity($id: ID!) {
getSecurity(id: $id) {
id
assetClassName
code
description
exchange
msCode
msNonFundCode
name
securityId
securityType
securityGroup
ticker
createdAt
updatedAt
}
}
Variables
{"id": 4}
Response
{
"data": {
"getSecurity": {
"id": 4,
"assetClassName": "xyz789",
"code": "abc123",
"description": "abc123",
"exchange": "abc123",
"msCode": "xyz789",
"msNonFundCode": "xyz789",
"name": "abc123",
"securityId": 123,
"securityType": "xyz789",
"securityGroup": "abc123",
"ticker": "xyz789",
"createdAt": AWSDateTime,
"updatedAt": AWSDateTime
}
}
}
getSecurityGroups
Response
Returns a SecurityGroupOutput
Example
Query
query GetSecurityGroups {
getSecurityGroups {
securityGroups {
securityGroupId
code
description
}
}
}
Response
{
"data": {
"getSecurityGroups": {
"securityGroups": [SecurityGroup]
}
}
}
getSecurityTypes
Response
Returns a SecurityTypeOutput
Example
Query
query GetSecurityTypes {
getSecurityTypes {
securityTypes {
securityTypeId
type
description
}
}
}
Response
{
"data": {
"getSecurityTypes": {"securityTypes": [SecurityType]}
}
}
getSensitiveDetails
Response
Returns a SensitiveDetailsOutput
Arguments
| Name | Description |
|---|---|
args - GetSensitiveDetailsInput!
|
Example
Query
query GetSensitiveDetails($args: GetSensitiveDetailsInput!) {
getSensitiveDetails(args: $args) {
sensitiveDetailsId
clientId
isPep
isVulnerable
notes
confidentialNotes
createdBy
created
updatedBy
updated
}
}
Variables
{"args": GetSensitiveDetailsInput}
Response
{
"data": {
"getSensitiveDetails": {
"sensitiveDetailsId": 123,
"clientId": 123,
"isPep": true,
"isVulnerable": true,
"notes": "xyz789",
"confidentialNotes": "abc123",
"createdBy": "xyz789",
"created": "xyz789",
"updatedBy": "xyz789",
"updated": "abc123"
}
}
}
getStaff
Response
Returns a Staff
Arguments
| Name | Description |
|---|---|
args - GetStaffInput
|
Example
Query
query GetStaff($args: GetStaffInput) {
getStaff(args: $args) {
staffId
practiceOfficeId
iamId
title
firstName
middleName
lastName
role
staffHouseholdAccess {
householdId
householdName
role
}
digitalSignatureS3Path
contactDetails {
emailAddress
mobileNumber
faxNumber
phoneNumber
createdBy
created
updatedBy
updated
}
externalId
externalSystem
createdBy
created
updatedBy
updated
}
}
Variables
{"args": GetStaffInput}
Response
{
"data": {
"getStaff": {
"staffId": 123,
"practiceOfficeId": 123,
"iamId": "abc123",
"title": "xyz789",
"firstName": "abc123",
"middleName": "xyz789",
"lastName": "xyz789",
"role": "xyz789",
"staffHouseholdAccess": [StaffHouseholdAccess],
"digitalSignatureS3Path": "abc123",
"contactDetails": ContactDetails,
"externalId": "xyz789",
"externalSystem": "xyz789",
"createdBy": "abc123",
"created": "abc123",
"updatedBy": "abc123",
"updated": "xyz789"
}
}
}
getStaffConfig
Response
Returns a StaffConfig
Arguments
| Name | Description |
|---|---|
args - GetStaffConfig
|
Example
Query
query GetStaffConfig($args: GetStaffConfig) {
getStaffConfig(args: $args) {
staffConfigId
staffId
configuration {
modules {
bestLife {
enabled
}
bestLifePlan {
enabled
}
goals {
enabled
}
governance {
enabled
}
healthAssessment {
enabled
}
invPrefs {
enabled
}
life {
enabled
}
strategies {
enabled
}
surveys {
enabled
}
tasks {
enabled
}
values {
enabled
}
vault {
enabled
}
wealth {
enabled
}
}
inAppNotifications {
enabled
}
filterSettings {
getHouseholdsFilterSettings {
showAllClients
}
}
globalSearchBarSettings {
showAllClients
}
recentlyViewed {
households {
householdId
householdName
avatars {
...StaffConfigConfigurationRecentlyViewedClientAvatarFragment
}
}
}
}
}
}
Variables
{"args": GetStaffConfig}
Response
{
"data": {
"getStaffConfig": {
"staffConfigId": 987,
"staffId": 123,
"configuration": StaffConfigConfiguration
}
}
}
getStaffPendingApprovals
Response
Returns a GetStaffPendingApprovalsOutput
Arguments
| Name | Description |
|---|---|
args - GetStaffPendingApprovalsInput
|
Example
Query
query GetStaffPendingApprovals($args: GetStaffPendingApprovalsInput) {
getStaffPendingApprovals(args: $args) {
approvals {
householdId
householdName
goalsCount
governanceCount
}
page
pageSize
pages
totalCount
totalChanges
}
}
Variables
{"args": GetStaffPendingApprovalsInput}
Response
{
"data": {
"getStaffPendingApprovals": {
"approvals": [StaffApprovalItem],
"page": 123,
"pageSize": 987,
"pages": 987,
"totalCount": 987,
"totalChanges": 123
}
}
}
getStaffPendingApprovalsCount
Response
Returns an Int
Arguments
| Name | Description |
|---|---|
args - GetStaffPendingApprovalsCountInput
|
Example
Query
query GetStaffPendingApprovalsCount($args: GetStaffPendingApprovalsCountInput) {
getStaffPendingApprovalsCount(args: $args)
}
Variables
{"args": GetStaffPendingApprovalsCountInput}
Response
{"data": {"getStaffPendingApprovalsCount": 987}}
getStaffs
Response
Returns a GetStaffsOutput
Arguments
| Name | Description |
|---|---|
args - GetStaffsInput
|
Example
Query
query GetStaffs($args: GetStaffsInput) {
getStaffs(args: $args) {
staffs {
staffId
practiceOfficeId
iamId
title
firstName
middleName
lastName
role
staffHouseholdAccess {
householdId
householdName
role
}
digitalSignatureS3Path
contactDetails {
emailAddress
mobileNumber
faxNumber
phoneNumber
createdBy
created
updatedBy
updated
}
externalId
externalSystem
createdBy
created
updatedBy
updated
}
pagination {
page
pageSize
numPages
numItems
}
}
}
Variables
{"args": GetStaffsInput}
Response
{
"data": {
"getStaffs": {
"staffs": [Staff],
"pagination": Pagination
}
}
}
getSubscriptionData
Response
Returns a SubscriptionDataOutput
Example
Query
query GetSubscriptionData {
getSubscriptionData {
planType
planCost
planExpiry
professionalLicenseCount
supportStaffLicenseCount
professionalLicenseAssignedCount
supportStaffLicenseAssignedCount
householdLicenseCount
includedHouseholdsCount
billingCycle
subscriptionLength
whiteLabelling
}
}
Response
{
"data": {
"getSubscriptionData": {
"planType": "xyz789",
"planCost": 123.45,
"planExpiry": "xyz789",
"professionalLicenseCount": 123,
"supportStaffLicenseCount": 123,
"professionalLicenseAssignedCount": 987,
"supportStaffLicenseAssignedCount": 987,
"householdLicenseCount": 123,
"includedHouseholdsCount": 987,
"billingCycle": "abc123",
"subscriptionLength": 987,
"whiteLabelling": true
}
}
}
getSuperBeneficiaries
Response
Returns [SuperBeneficiaryOutput]
Arguments
| Name | Description |
|---|---|
args - GetSuperBeneficiariesInput!
|
Example
Query
query GetSuperBeneficiaries($args: GetSuperBeneficiariesInput!) {
getSuperBeneficiaries(args: $args) {
superBeneficiaryId
legalEntityId
assetId
isPrimary
name
relation
nominated
beneficiaryType
ends
amount
percent
estate
estateAmount
estateBps
notes
clientNotes
partnerNotes
confidentialNotes
createdBy
created
updatedBy
updated
}
}
Variables
{"args": GetSuperBeneficiariesInput}
Response
{
"data": {
"getSuperBeneficiaries": [
{
"superBeneficiaryId": 987,
"legalEntityId": 123,
"assetId": 123,
"isPrimary": true,
"name": "xyz789",
"relation": "xyz789",
"nominated": false,
"beneficiaryType": "xyz789",
"ends": "xyz789",
"amount": 987.65,
"percent": 987.65,
"estate": "xyz789",
"estateAmount": 123.45,
"estateBps": 987.65,
"notes": "xyz789",
"clientNotes": "xyz789",
"partnerNotes": "abc123",
"confidentialNotes": "abc123",
"createdBy": "abc123",
"created": "abc123",
"updatedBy": "xyz789",
"updated": "xyz789"
}
]
}
}
getSuperBeneficiary
Response
Returns a SuperBeneficiaryOutput
Arguments
| Name | Description |
|---|---|
args - GetSuperBeneficiaryInput!
|
Example
Query
query GetSuperBeneficiary($args: GetSuperBeneficiaryInput!) {
getSuperBeneficiary(args: $args) {
superBeneficiaryId
legalEntityId
assetId
isPrimary
name
relation
nominated
beneficiaryType
ends
amount
percent
estate
estateAmount
estateBps
notes
clientNotes
partnerNotes
confidentialNotes
createdBy
created
updatedBy
updated
}
}
Variables
{"args": GetSuperBeneficiaryInput}
Response
{
"data": {
"getSuperBeneficiary": {
"superBeneficiaryId": 987,
"legalEntityId": 123,
"assetId": 987,
"isPrimary": true,
"name": "abc123",
"relation": "abc123",
"nominated": false,
"beneficiaryType": "abc123",
"ends": "xyz789",
"amount": 987.65,
"percent": 123.45,
"estate": "xyz789",
"estateAmount": 123.45,
"estateBps": 123.45,
"notes": "abc123",
"clientNotes": "xyz789",
"partnerNotes": "xyz789",
"confidentialNotes": "abc123",
"createdBy": "abc123",
"created": "abc123",
"updatedBy": "abc123",
"updated": "xyz789"
}
}
}
getSurvey
Response
Returns a GetSurveyOutput
Arguments
| Name | Description |
|---|---|
args - GetSurveyInput!
|
Example
Query
query GetSurvey($args: GetSurveyInput!) {
getSurvey(args: $args) {
surveyMetadata {
clientFirstName
clientLastName
clientInitials
clientAvatarImageUrl
partnerFirstName
partnerLastName
partnerInitials
partnerAvatarImageUrl
hasPartner
lifeIncludeConnections
lifeIncludeGoals
valuesIncludeLegacy
foundationsShort
foundationsLong
foundationsIncludeDetails
foundationsIncludeInsurance
foundationsIncludeEstatePlanning
foundationsIncludeBusinessPlanning
surveyName
timeToComplete
}
palette {
primary {
bgColor
fgColor
}
secondary {
bgColor
fgColor
}
buttons {
primary {
bgColor
fgColor
}
secondary {
bgColor
fgColor
}
}
backgrounds {
main {
bgColor
fgColor
}
workbench {
bgColor
fgColor
}
}
}
surveyData {
keyValueData
id
status
progress
createdAt
updatedAt
}
}
}
Variables
{"args": GetSurveyInput}
Response
{
"data": {
"getSurvey": {
"surveyMetadata": SurveyMetadata,
"palette": PracticeConfigPalette,
"surveyData": SurveyData
}
}
}
getSurveyResponseData
Response
Returns a SurveyResponseData
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
query GetSurveyResponseData($id: ID!) {
getSurveyResponseData(id: $id) {
id
clientId
inviteCode
householdId
keyValueData
status
surveyId
progress
createdAt
updatedAt
}
}
Variables
{"id": 4}
Response
{
"data": {
"getSurveyResponseData": {
"id": 4,
"clientId": 987,
"inviteCode": "xyz789",
"householdId": 987,
"keyValueData": "xyz789",
"status": "SENT",
"surveyId": "xyz789",
"progress": 123.45,
"createdAt": AWSDateTime,
"updatedAt": AWSDateTime
}
}
}
getSurveysSession
Response
Returns a GetSurveysSessionOutput
Arguments
| Name | Description |
|---|---|
args - GetSurveysSessionInput!
|
Example
Query
query GetSurveysSession($args: GetSurveysSessionInput!) {
getSurveysSession(args: $args) {
clientId
inviteCode
surveysSessionId
sessionName
status
surveysInfo {
surveyId
surveyName
status
progress
sessionId
lifeIncludeGoals
lifeIncludeConnections
valuesIncludeLegacy
foundationsShort
foundationsLong
foundationsIncludeDetails
foundationsIncludeInsurance
foundationsIncludeEstatePlanning
foundationsIncludeBusinessPlanning
fhaLongAssessment
fhaShortAssessment
timeToComplete
createdAt
updateAt
}
clientsInfo {
initials
name
}
palette {
primary {
bgColor
fgColor
}
secondary {
bgColor
fgColor
}
buttons {
primary {
bgColor
fgColor
}
secondary {
bgColor
fgColor
}
}
backgrounds {
main {
bgColor
fgColor
}
workbench {
bgColor
fgColor
}
}
}
createdAt
updatedAt
}
}
Variables
{"args": GetSurveysSessionInput}
Response
{
"data": {
"getSurveysSession": {
"clientId": 987,
"inviteCode": "xyz789",
"surveysSessionId": 987,
"sessionName": "abc123",
"status": "xyz789",
"surveysInfo": [SurveyInfo],
"clientsInfo": [ClientInfo],
"palette": PracticeConfigPalette,
"createdAt": "xyz789",
"updatedAt": "abc123"
}
}
}
getSurveysSessions
Response
Returns a GetSurveysSessionsOutput
Arguments
| Name | Description |
|---|---|
args - GetSurveysSessionsInput!
|
Example
Query
query GetSurveysSessions($args: GetSurveysSessionsInput!) {
getSurveysSessions(args: $args) {
householdId
clientSessions {
clientId
inviteCode
surveysSessionId
sessionName
status
surveysInfo {
surveyId
surveyName
status
progress
sessionId
lifeIncludeGoals
lifeIncludeConnections
valuesIncludeLegacy
foundationsShort
foundationsLong
foundationsIncludeDetails
foundationsIncludeInsurance
foundationsIncludeEstatePlanning
foundationsIncludeBusinessPlanning
fhaLongAssessment
fhaShortAssessment
timeToComplete
createdAt
updateAt
}
clientsInfo {
initials
name
}
palette {
primary {
bgColor
fgColor
}
secondary {
bgColor
fgColor
}
buttons {
primary {
...PracticeConfigPaletteBGFGColorsFragment
}
secondary {
...PracticeConfigPaletteBGFGColorsFragment
}
}
backgrounds {
main {
...PracticeConfigPaletteBGFGColorsFragment
}
workbench {
...PracticeConfigPaletteBGFGColorsFragment
}
}
}
createdAt
updatedAt
}
}
}
Variables
{"args": GetSurveysSessionsInput}
Response
{
"data": {
"getSurveysSessions": {
"householdId": 987,
"clientSessions": [GetSurveysSessionOutput]
}
}
}
getTamaracLoadErrors
Response
Returns a TamaracLoadErrors
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
query GetTamaracLoadErrors($id: ID!) {
getTamaracLoadErrors(id: $id) {
id
sourceFile
errorMessage
tamaracPayload
accountId
accountNumber
primaryMemberFirstName
primaryMemberLastName
fuzzyRatio
rdsCombinedAddressString
tamaracCombinedAddressString
createdAt
updatedAt
}
}
Variables
{"id": "4"}
Response
{
"data": {
"getTamaracLoadErrors": {
"id": 4,
"sourceFile": "abc123",
"errorMessage": "xyz789",
"tamaracPayload": "xyz789",
"accountId": "xyz789",
"accountNumber": "xyz789",
"primaryMemberFirstName": "abc123",
"primaryMemberLastName": "xyz789",
"fuzzyRatio": "xyz789",
"rdsCombinedAddressString": "xyz789",
"tamaracCombinedAddressString": "xyz789",
"createdAt": AWSDateTime,
"updatedAt": AWSDateTime
}
}
}
getTask
Response
Returns a TaskOutput
Arguments
| Name | Description |
|---|---|
args - GetTaskInput!
|
Example
Query
query GetTask($args: GetTaskInput!) {
getTask(args: $args) {
id
title
order
description
dueDate
completedDate
status
assignedToClientId
createdForHouseholdId
createdBy
created
updatedBy
updated
}
}
Variables
{"args": GetTaskInput}
Response
{
"data": {
"getTask": {
"id": 987,
"title": "xyz789",
"order": 987,
"description": "xyz789",
"dueDate": "xyz789",
"completedDate": "abc123",
"status": "abc123",
"assignedToClientId": 123,
"createdForHouseholdId": 987,
"createdBy": "abc123",
"created": "xyz789",
"updatedBy": "xyz789",
"updated": "abc123"
}
}
}
getTasks
Response
Returns [TaskOutput]
Arguments
| Name | Description |
|---|---|
args - GetTasksInput
|
Example
Query
query GetTasks($args: GetTasksInput) {
getTasks(args: $args) {
id
title
order
description
dueDate
completedDate
status
assignedToClientId
createdForHouseholdId
createdBy
created
updatedBy
updated
}
}
Variables
{"args": GetTasksInput}
Response
{
"data": {
"getTasks": [
{
"id": 123,
"title": "xyz789",
"order": 123,
"description": "abc123",
"dueDate": "abc123",
"completedDate": "xyz789",
"status": "abc123",
"assignedToClientId": 123,
"createdForHouseholdId": 123,
"createdBy": "xyz789",
"created": "xyz789",
"updatedBy": "xyz789",
"updated": "xyz789"
}
]
}
}
getTaxDetails
Response
Returns a TaxDetailsOutput
Arguments
| Name | Description |
|---|---|
args - GetTaxDetailsInput!
|
Example
Query
query GetTaxDetails($args: GetTaxDetailsInput!) {
getTaxDetails(args: $args) {
taxDetailsId
clientId
tfn
countryCodeTax
stateCodeTax
familyTaxBenefit
notes
confidentialNotes
createdBy
created
updatedBy
updated
}
}
Variables
{"args": GetTaxDetailsInput}
Response
{
"data": {
"getTaxDetails": {
"taxDetailsId": 987,
"clientId": 987,
"tfn": "xyz789",
"countryCodeTax": "xyz789",
"stateCodeTax": "xyz789",
"familyTaxBenefit": true,
"notes": "abc123",
"confidentialNotes": "xyz789",
"createdBy": "xyz789",
"created": "abc123",
"updatedBy": "abc123",
"updated": "xyz789"
}
}
}
getTaxPlanning
Response
Returns a TaxPlanningOutput
Arguments
| Name | Description |
|---|---|
args - GetTaxPlanningInput!
|
Example
Query
query GetTaxPlanning($args: GetTaxPlanningInput!) {
getTaxPlanning(args: $args) {
taxPlanningId
householdId
clientId
legalEntityId
significantChangesImpact
description
createdBy
created
updatedBy
updated
}
}
Variables
{"args": GetTaxPlanningInput}
Response
{
"data": {
"getTaxPlanning": {
"taxPlanningId": 123,
"householdId": 987,
"clientId": 987,
"legalEntityId": 123,
"significantChangesImpact": true,
"description": "xyz789",
"createdBy": "xyz789",
"created": "xyz789",
"updatedBy": "xyz789",
"updated": "xyz789"
}
}
}
getTaxPlannings
Response
Returns [TaxPlanningOutput]
Arguments
| Name | Description |
|---|---|
args - GetTaxPlanningsInput!
|
Example
Query
query GetTaxPlannings($args: GetTaxPlanningsInput!) {
getTaxPlannings(args: $args) {
taxPlanningId
householdId
clientId
legalEntityId
significantChangesImpact
description
createdBy
created
updatedBy
updated
}
}
Variables
{"args": GetTaxPlanningsInput}
Response
{
"data": {
"getTaxPlannings": [
{
"taxPlanningId": 987,
"householdId": 987,
"clientId": 987,
"legalEntityId": 123,
"significantChangesImpact": true,
"description": "abc123",
"createdBy": "abc123",
"created": "abc123",
"updatedBy": "xyz789",
"updated": "abc123"
}
]
}
}
getTrustBeneficiaries
Response
Returns [TrustBeneficiaryOutput]
Arguments
| Name | Description |
|---|---|
args - GetTrustBeneficiariesInput!
|
Example
Query
query GetTrustBeneficiaries($args: GetTrustBeneficiariesInput!) {
getTrustBeneficiaries(args: $args) {
trustBeneficiaryId
legalEntityId
isPrimary
firstName
middleName
lastName
companyName
nominatedPercentage
notes
clientNotes
partnerNotes
confidentialNotes
createdBy
created
updatedBy
updated
}
}
Variables
{"args": GetTrustBeneficiariesInput}
Response
{
"data": {
"getTrustBeneficiaries": [
{
"trustBeneficiaryId": 123,
"legalEntityId": 987,
"isPrimary": true,
"firstName": "xyz789",
"middleName": "xyz789",
"lastName": "abc123",
"companyName": "xyz789",
"nominatedPercentage": 123.45,
"notes": "abc123",
"clientNotes": "xyz789",
"partnerNotes": "abc123",
"confidentialNotes": "xyz789",
"createdBy": "xyz789",
"created": "xyz789",
"updatedBy": "abc123",
"updated": "xyz789"
}
]
}
}
getTrustBeneficiary
Response
Returns a TrustBeneficiaryOutput
Arguments
| Name | Description |
|---|---|
args - GetTrustBeneficiaryInput!
|
Example
Query
query GetTrustBeneficiary($args: GetTrustBeneficiaryInput!) {
getTrustBeneficiary(args: $args) {
trustBeneficiaryId
legalEntityId
isPrimary
firstName
middleName
lastName
companyName
nominatedPercentage
notes
clientNotes
partnerNotes
confidentialNotes
createdBy
created
updatedBy
updated
}
}
Variables
{"args": GetTrustBeneficiaryInput}
Response
{
"data": {
"getTrustBeneficiary": {
"trustBeneficiaryId": 123,
"legalEntityId": 987,
"isPrimary": false,
"firstName": "xyz789",
"middleName": "abc123",
"lastName": "xyz789",
"companyName": "xyz789",
"nominatedPercentage": 987.65,
"notes": "xyz789",
"clientNotes": "xyz789",
"partnerNotes": "xyz789",
"confidentialNotes": "xyz789",
"createdBy": "xyz789",
"created": "abc123",
"updatedBy": "xyz789",
"updated": "xyz789"
}
}
}
getTrustee
Response
Returns a TrusteeOutput
Arguments
| Name | Description |
|---|---|
args - GetTrusteeInput!
|
Example
Query
query GetTrustee($args: GetTrusteeInput!) {
getTrustee(args: $args) {
trusteeId
legalEntityId
trusteeType
firstName
middleName
lastName
companyName
dateAppointed
notes
clientNotes
partnerNotes
confidentialNotes
createdBy
created
updatedBy
updated
}
}
Variables
{"args": GetTrusteeInput}
Response
{
"data": {
"getTrustee": {
"trusteeId": 123,
"legalEntityId": 123,
"trusteeType": "abc123",
"firstName": "abc123",
"middleName": "xyz789",
"lastName": "abc123",
"companyName": "xyz789",
"dateAppointed": "abc123",
"notes": "abc123",
"clientNotes": "abc123",
"partnerNotes": "xyz789",
"confidentialNotes": "xyz789",
"createdBy": "xyz789",
"created": "xyz789",
"updatedBy": "xyz789",
"updated": "xyz789"
}
}
}
getTrustees
Response
Returns [TrusteeOutput]
Arguments
| Name | Description |
|---|---|
args - GetTrusteesInput!
|
Example
Query
query GetTrustees($args: GetTrusteesInput!) {
getTrustees(args: $args) {
trusteeId
legalEntityId
trusteeType
firstName
middleName
lastName
companyName
dateAppointed
notes
clientNotes
partnerNotes
confidentialNotes
createdBy
created
updatedBy
updated
}
}
Variables
{"args": GetTrusteesInput}
Response
{
"data": {
"getTrustees": [
{
"trusteeId": 123,
"legalEntityId": 123,
"trusteeType": "abc123",
"firstName": "xyz789",
"middleName": "xyz789",
"lastName": "abc123",
"companyName": "abc123",
"dateAppointed": "abc123",
"notes": "xyz789",
"clientNotes": "xyz789",
"partnerNotes": "abc123",
"confidentialNotes": "xyz789",
"createdBy": "abc123",
"created": "abc123",
"updatedBy": "xyz789",
"updated": "abc123"
}
]
}
}
getUserPackage
Response
Returns a UserPackageOutput
Example
Query
query GetUserPackage {
getUserPackage {
homeRegion
homeLocale
practicePackageCode
householdPackageCode
}
}
Response
{
"data": {
"getUserPackage": {
"homeRegion": "xyz789",
"homeLocale": "xyz789",
"practicePackageCode": "abc123",
"householdPackageCode": "xyz789"
}
}
}
getWealthData
Response
Returns a WealthOutput
Arguments
| Name | Description |
|---|---|
wealthInput - WealthInput
|
Example
Query
query GetWealthData($wealthInput: WealthInput) {
getWealthData(wealthInput: $wealthInput) {
aggregateTotal
aggregateCashTotal
aggregateFixedIncomeTotal
aggregateRealAssetsTotal
aggregateEquitiesTotal
aggregateAlternativesTotal
aggregateOtherTotal
aggregateMultiAssetTotal
portfolios {
clientIds
portfolioId
legalEntityId
name
type
investmentStructure
portfolioTotal
portfolioCashTotal
portfolioFixedIncomeTotal
portfolioRealAssetsTotal
portfolioEquitiesTotal
portfolioAlternativesTotal
portfolioOtherTotal
portfolioMultiAssetTotal
holdings {
code
ticker
exchange
name
assetTreeId
invGroupId
regionId
assetClassId
sectorId
securityGroupId
securityTypeId
securityStyle
quantity
closePriceDate
closePrice
closePriceAUD
currencyCode
capitalGain
}
drilldownCsv
historicalData {
inceptionToDate {
managedMarketValue
performance
investmentGain
netContribution
contributionRate
}
priorYear {
managedMarketValue
performance
investmentGain
netContribution
contributionRate
}
yearToDate {
managedMarketValue
performance
investmentGain
netContribution
contributionRate
}
}
}
householdAggregate {
householdId
drilldownCsv
clientAggregates {
clientId
drilldownCsv
}
}
}
}
Variables
{"wealthInput": WealthInput}
Response
{
"data": {
"getWealthData": {
"aggregateTotal": 987.65,
"aggregateCashTotal": 987.65,
"aggregateFixedIncomeTotal": 987.65,
"aggregateRealAssetsTotal": 123.45,
"aggregateEquitiesTotal": 987.65,
"aggregateAlternativesTotal": 123.45,
"aggregateOtherTotal": 123.45,
"aggregateMultiAssetTotal": 123.45,
"portfolios": [Portfolio],
"householdAggregate": HouseholdAggregate
}
}
}
getYourLifeHistory
Response
Returns a GetLifeHistoryOutput
Arguments
| Name | Description |
|---|---|
args - GetLifeHistoryInput
|
Example
Query
query GetYourLifeHistory($args: GetLifeHistoryInput) {
getYourLifeHistory(args: $args) {
client {
date
lifeScore
}
partner {
date
lifeScore
}
}
}
Variables
{"args": GetLifeHistoryInput}
Response
{
"data": {
"getYourLifeHistory": {
"client": [LifeHistoryOutput],
"partner": [LifeHistoryOutput]
}
}
}
getYourLifeIntroVideoUrl
Response
Returns a YourLifeIntroVideoUrl
Arguments
| Name | Description |
|---|---|
yourLifeIntroVideoUrlInput - YourLifeIntroVideoUrlInput!
|
Example
Query
query GetYourLifeIntroVideoUrl($yourLifeIntroVideoUrlInput: YourLifeIntroVideoUrlInput!) {
getYourLifeIntroVideoUrl(yourLifeIntroVideoUrlInput: $yourLifeIntroVideoUrlInput) {
url
}
}
Variables
{"yourLifeIntroVideoUrlInput": YourLifeIntroVideoUrlInput}
Response
{
"data": {
"getYourLifeIntroVideoUrl": {
"url": "abc123"
}
}
}
getYourLifeSession
Response
Returns a YourLifeSession
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
query GetYourLifeSession($id: ID!) {
getYourLifeSession(id: $id) {
id
clientId
inviteCode
householdId
status
firstName
lastName
fullName
hasPartner
partnerId
includeGoals
includeConnections
includeFinancialDetails
partnerFirstName
partnerLastName
partnerFullName
responses {
questionId
intResponse
stringResponse
}
lovedOnes
communityConnections
globalConnections
overallScore
emotionalScore
environmentalScore
spiritualScore
socialScore
educationScore
occupationalScore
physicalScore
financialScore
notes {
householdId
valueGroupId
note
}
createdAt
updatedAt
}
}
Variables
{"id": "4"}
Response
{
"data": {
"getYourLifeSession": {
"id": 4,
"clientId": 123,
"inviteCode": "xyz789",
"householdId": 987,
"status": "xyz789",
"firstName": "xyz789",
"lastName": "abc123",
"fullName": "xyz789",
"hasPartner": false,
"partnerId": 987,
"includeGoals": true,
"includeConnections": false,
"includeFinancialDetails": false,
"partnerFirstName": "xyz789",
"partnerLastName": "abc123",
"partnerFullName": "abc123",
"responses": [LifeResponse],
"lovedOnes": ["xyz789"],
"communityConnections": ["xyz789"],
"globalConnections": ["xyz789"],
"overallScore": 987.65,
"emotionalScore": 987.65,
"environmentalScore": 987.65,
"spiritualScore": 987.65,
"socialScore": 123.45,
"educationScore": 987.65,
"occupationalScore": 987.65,
"physicalScore": 123.45,
"financialScore": 987.65,
"notes": [LifeNote],
"createdAt": AWSDateTime,
"updatedAt": AWSDateTime
}
}
}
getYourValuesIntroVideoUrl
Response
Returns a YourValuesIntroVideoUrl
Arguments
| Name | Description |
|---|---|
args - GetYourValuesIntroVideoUrlInput
|
Example
Query
query GetYourValuesIntroVideoUrl($args: GetYourValuesIntroVideoUrlInput) {
getYourValuesIntroVideoUrl(args: $args) {
url
}
}
Variables
{"args": GetYourValuesIntroVideoUrlInput}
Response
{
"data": {
"getYourValuesIntroVideoUrl": {
"url": "abc123"
}
}
}
getYourValuesSession
Response
Returns a YourValuesSession
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
query GetYourValuesSession($id: ID!) {
getYourValuesSession(id: $id) {
id
clientId
inviteCode
partnerId
partnerInviteCode
client {
clientId
regrets
values {
cardId
rank
meaningReason
progressAction
progress
}
step
lastSeen
individualValuesCompleted
}
partner {
clientId
regrets
values {
cardId
rank
meaningReason
progressAction
progress
}
step
lastSeen
individualValuesCompleted
}
adviser {
staffId
step
lastSeen
}
support {
staffId
step
lastSeen
}
alignedValues {
cardId
clientId
rank
notes
progress
description
nextSteps {
id
title
notes
assignedToClientId
created
}
householdMemberProgress {
description
progress
clientId
}
}
valuesInc3Things
partnerValuesInc3Things
individualValuesOnly
step
lastSeen
createdAt
updatedAt
}
}
Variables
{"id": "4"}
Response
{
"data": {
"getYourValuesSession": {
"id": 4,
"clientId": 987,
"inviteCode": "xyz789",
"partnerId": 987,
"partnerInviteCode": "xyz789",
"client": ValuesClient,
"partner": ValuesClient,
"adviser": ValuesStaff,
"support": ValuesStaff,
"alignedValues": [ValuesAlignedValue],
"valuesInc3Things": true,
"partnerValuesInc3Things": false,
"individualValuesOnly": false,
"step": "xyz789",
"lastSeen": "abc123",
"createdAt": AWSDateTime,
"updatedAt": AWSDateTime
}
}
}
getYourVaultContents
Response
Returns a GetYourVaultContentsOutput
Arguments
| Name | Description |
|---|---|
args - GetYourVaultContentsInput
|
Example
Query
query GetYourVaultContents($args: GetYourVaultContentsInput) {
getYourVaultContents(args: $args) {
vaultFiles {
pathAndFilename
presignedPathAndFilename
lastModified
size
status
publishCount
uploaderClientId
uploaderStaffId
}
page
pageSize
pages
totalCount
}
}
Variables
{"args": GetYourVaultContentsInput}
Response
{
"data": {
"getYourVaultContents": {
"vaultFiles": [YourVaultFileInfo],
"page": 123,
"pageSize": 123,
"pages": 123,
"totalCount": 987
}
}
}
getYourVaultFile
Response
Returns a String
Arguments
| Name | Description |
|---|---|
args - GetYourVaultFileInput
|
Example
Query
query GetYourVaultFile($args: GetYourVaultFileInput) {
getYourVaultFile(args: $args)
}
Variables
{"args": GetYourVaultFileInput}
Response
{"data": {"getYourVaultFile": "abc123"}}
goalsSessionByClientId
Response
Returns a ModelGoalsSessionConnection
Arguments
| Name | Description |
|---|---|
clientId - Int!
|
|
sortDirection - ModelSortDirection
|
|
filter - ModelGoalsSessionFilterInput
|
|
limit - Int
|
|
nextToken - String
|
Example
Query
query GoalsSessionByClientId(
$clientId: Int!,
$sortDirection: ModelSortDirection,
$filter: ModelGoalsSessionFilterInput,
$limit: Int,
$nextToken: String
) {
goalsSessionByClientId(
clientId: $clientId,
sortDirection: $sortDirection,
filter: $filter,
limit: $limit,
nextToken: $nextToken
) {
items {
id
clientId
inviteCode
selectedGoalCategoryIds
createdAt
updatedAt
}
nextToken
}
}
Variables
{
"clientId": 123,
"sortDirection": "ASC",
"filter": ModelGoalsSessionFilterInput,
"limit": 987,
"nextToken": "xyz789"
}
Response
{
"data": {
"goalsSessionByClientId": {
"items": [GoalsSession],
"nextToken": "abc123"
}
}
}
goalsSessionByInviteCode
Response
Returns a ModelGoalsSessionConnection
Arguments
| Name | Description |
|---|---|
inviteCode - String!
|
|
sortDirection - ModelSortDirection
|
|
filter - ModelGoalsSessionFilterInput
|
|
limit - Int
|
|
nextToken - String
|
Example
Query
query GoalsSessionByInviteCode(
$inviteCode: String!,
$sortDirection: ModelSortDirection,
$filter: ModelGoalsSessionFilterInput,
$limit: Int,
$nextToken: String
) {
goalsSessionByInviteCode(
inviteCode: $inviteCode,
sortDirection: $sortDirection,
filter: $filter,
limit: $limit,
nextToken: $nextToken
) {
items {
id
clientId
inviteCode
selectedGoalCategoryIds
createdAt
updatedAt
}
nextToken
}
}
Variables
{
"inviteCode": "abc123",
"sortDirection": "ASC",
"filter": ModelGoalsSessionFilterInput,
"limit": 987,
"nextToken": "xyz789"
}
Response
{
"data": {
"goalsSessionByInviteCode": {
"items": [GoalsSession],
"nextToken": "xyz789"
}
}
}
investmentPreferencesSessionByClientId
Response
Arguments
| Name | Description |
|---|---|
clientId - Int!
|
|
sortDirection - ModelSortDirection
|
|
filter - ModelInvestmentPreferencesSessionFilterInput
|
|
limit - Int
|
|
nextToken - String
|
Example
Query
query InvestmentPreferencesSessionByClientId(
$clientId: Int!,
$sortDirection: ModelSortDirection,
$filter: ModelInvestmentPreferencesSessionFilterInput,
$limit: Int,
$nextToken: String
) {
investmentPreferencesSessionByClientId(
clientId: $clientId,
sortDirection: $sortDirection,
filter: $filter,
limit: $limit,
nextToken: $nextToken
) {
items {
id
clientId
inviteCode
fullName
status
introVideo
customisationVideo
customisation
ethicalVideo
ethical
assetClassVideo
allocationVideo
allocationType
riskVideo
comfortableWithDownturn
costVideo
costDriven
prioritisation {
optionId
rank
}
comments
customisationVideoHelp
customisationVideoComments
ethicalVideoHelp
ethicalVideoComments
assetClassVideoHelp
assetClassVideoComments
allocationVideoHelp
allocationVideoComments
riskVideoHelp
riskVideoComments
riskDiversification
riskMarketCorrection
riskPercentageDrop
riskCapitalProtection
riskAccessCapital
riskInfluencedByReturns
riskIncreaseToMeetGoal
riskMaxDownside
riskInflation
costVideoHelp
costVideoComments
assetClassAndDiversificationVideoHelp
assetClassPreferences
assetClassPreferencesComments
assetClassRisk
assetClassRiskComments
ethicalPreferences
ethicalPreferencesComments
activePassiveVideoHelp
costWealthPriorities
riskVolatilityVideoHelp
riskTimelines
riskExperience
riskKnowledge
riskPast
riskCurrent
riskTimeframe
riskVariability
riskVolatility
riskReaction
riskTolerance
riskFuture
includeRiskSection
includeIntroSection
includeCustomisationSection
includeEthicalSection
includeAssetClassSection
includeAllocationSection
includeCostSection
includePrioritisationSection
includeCommentsSection
createdAt
updatedAt
}
nextToken
}
}
Variables
{
"clientId": 987,
"sortDirection": "ASC",
"filter": ModelInvestmentPreferencesSessionFilterInput,
"limit": 123,
"nextToken": "abc123"
}
Response
{
"data": {
"investmentPreferencesSessionByClientId": {
"items": [InvestmentPreferencesSession],
"nextToken": "abc123"
}
}
}
investmentPreferencesSessionByInviteCode
Response
Arguments
| Name | Description |
|---|---|
inviteCode - String!
|
|
sortDirection - ModelSortDirection
|
|
filter - ModelInvestmentPreferencesSessionFilterInput
|
|
limit - Int
|
|
nextToken - String
|
Example
Query
query InvestmentPreferencesSessionByInviteCode(
$inviteCode: String!,
$sortDirection: ModelSortDirection,
$filter: ModelInvestmentPreferencesSessionFilterInput,
$limit: Int,
$nextToken: String
) {
investmentPreferencesSessionByInviteCode(
inviteCode: $inviteCode,
sortDirection: $sortDirection,
filter: $filter,
limit: $limit,
nextToken: $nextToken
) {
items {
id
clientId
inviteCode
fullName
status
introVideo
customisationVideo
customisation
ethicalVideo
ethical
assetClassVideo
allocationVideo
allocationType
riskVideo
comfortableWithDownturn
costVideo
costDriven
prioritisation {
optionId
rank
}
comments
customisationVideoHelp
customisationVideoComments
ethicalVideoHelp
ethicalVideoComments
assetClassVideoHelp
assetClassVideoComments
allocationVideoHelp
allocationVideoComments
riskVideoHelp
riskVideoComments
riskDiversification
riskMarketCorrection
riskPercentageDrop
riskCapitalProtection
riskAccessCapital
riskInfluencedByReturns
riskIncreaseToMeetGoal
riskMaxDownside
riskInflation
costVideoHelp
costVideoComments
assetClassAndDiversificationVideoHelp
assetClassPreferences
assetClassPreferencesComments
assetClassRisk
assetClassRiskComments
ethicalPreferences
ethicalPreferencesComments
activePassiveVideoHelp
costWealthPriorities
riskVolatilityVideoHelp
riskTimelines
riskExperience
riskKnowledge
riskPast
riskCurrent
riskTimeframe
riskVariability
riskVolatility
riskReaction
riskTolerance
riskFuture
includeRiskSection
includeIntroSection
includeCustomisationSection
includeEthicalSection
includeAssetClassSection
includeAllocationSection
includeCostSection
includePrioritisationSection
includeCommentsSection
createdAt
updatedAt
}
nextToken
}
}
Variables
{
"inviteCode": "abc123",
"sortDirection": "ASC",
"filter": ModelInvestmentPreferencesSessionFilterInput,
"limit": 987,
"nextToken": "abc123"
}
Response
{
"data": {
"investmentPreferencesSessionByInviteCode": {
"items": [InvestmentPreferencesSession],
"nextToken": "xyz789"
}
}
}
isLumiantExperienceClient
Response
Returns a Boolean
Arguments
| Name | Description |
|---|---|
args - IsLumiantExperienceClientInput!
|
Example
Query
query IsLumiantExperienceClient($args: IsLumiantExperienceClientInput!) {
isLumiantExperienceClient(args: $args)
}
Variables
{"args": IsLumiantExperienceClientInput}
Response
{"data": {"isLumiantExperienceClient": true}}
isUniqueClientExternalId
Response
Returns a Boolean
Arguments
| Name | Description |
|---|---|
args - IsUniqueExternalIdInput
|
Example
Query
query IsUniqueClientExternalId($args: IsUniqueExternalIdInput) {
isUniqueClientExternalId(args: $args)
}
Variables
{"args": IsUniqueExternalIdInput}
Response
{"data": {"isUniqueClientExternalId": true}}
isUniqueStaffExternalId
Response
Returns a Boolean
Arguments
| Name | Description |
|---|---|
args - IsUniqueExternalIdInput
|
Example
Query
query IsUniqueStaffExternalId($args: IsUniqueExternalIdInput) {
isUniqueStaffExternalId(args: $args)
}
Variables
{"args": IsUniqueExternalIdInput}
Response
{"data": {"isUniqueStaffExternalId": true}}
listAllClientsOfAHousehold
Response
Returns a ListAllClientsOfAHouseholdOutput
Arguments
| Name | Description |
|---|---|
args - ListAllClientsOfAHouseholdInput
|
Example
Query
query ListAllClientsOfAHousehold($args: ListAllClientsOfAHouseholdInput) {
listAllClientsOfAHousehold(args: $args) {
searchResult {
clientId
isClientActive
clientFirstName
clientLastName
clientType
householdId
householdName
staffId
staffFirstName
staffLastName
isStaffActive
}
}
}
Variables
{"args": ListAllClientsOfAHouseholdInput}
Response
{
"data": {
"listAllClientsOfAHousehold": {
"searchResult": [ListAllClientsOfAHouseholdData]
}
}
}
listClients
Response
Returns a ListClientsOutput
Arguments
| Name | Description |
|---|---|
listClientsInput - ListClientsInput
|
Example
Query
query ListClients($listClientsInput: ListClientsInput) {
listClients(listClientsInput: $listClientsInput) {
clients {
clientId
householdId
iamId
wealthIds
type
title
firstName
middleName
lastName
preferredName
dob
lastLogin
registered
billableStart
address {
addressId
constructedAddress
addressLine1
addressLine2
suburb
postCode
state
country
createdBy
created
updatedBy
updated
}
postalAddress {
addressId
constructedAddress
addressLine1
addressLine2
suburb
postCode
state
country
createdBy
created
updatedBy
updated
}
contactDetails {
emailAddress
mobileNumber
faxNumber
phoneNumber
createdBy
created
updatedBy
updated
}
moduleStates {
moduleStateId
clientId
previouslyCompleted
module
moduleState
sentDate
sentReminders
startedDate
startedReminders
finishedDate
expiredDate
updatedBy
updated
}
wellnessScore
goalCount
taskCount
sex
relationshipStatus
countryCodeBirth
countryCodeResidency
countryCodeCitizenship
notes
externalId
externalSystem
createdBy
created
updatedBy
updated
}
page
pageSize
pages
}
}
Variables
{"listClientsInput": ListClientsInput}
Response
{
"data": {
"listClients": {
"clients": [Client],
"page": 987,
"pageSize": 987,
"pages": 987
}
}
}
listExternalUploadTrackings
Response
Returns a ModelExternalUploadTrackingConnection
Arguments
| Name | Description |
|---|---|
filter - ModelExternalUploadTrackingFilterInput
|
|
limit - Int
|
|
nextToken - String
|
Example
Query
query ListExternalUploadTrackings(
$filter: ModelExternalUploadTrackingFilterInput,
$limit: Int,
$nextToken: String
) {
listExternalUploadTrackings(
filter: $filter,
limit: $limit,
nextToken: $nextToken
) {
items {
id
fullS3ObjectPath
identityId
objectKey
practiceId
clientId
goalId
createdAt
updatedAt
}
nextToken
}
}
Variables
{
"filter": ModelExternalUploadTrackingFilterInput,
"limit": 987,
"nextToken": "xyz789"
}
Response
{
"data": {
"listExternalUploadTrackings": {
"items": [ExternalUploadTracking],
"nextToken": "abc123"
}
}
}
listFinancialHealthAssessmentSessions
Response
Arguments
| Name | Description |
|---|---|
filter - ModelFinancialHealthAssessmentSessionFilterInput
|
|
limit - Int
|
|
nextToken - String
|
Example
Query
query ListFinancialHealthAssessmentSessions(
$filter: ModelFinancialHealthAssessmentSessionFilterInput,
$limit: Int,
$nextToken: String
) {
listFinancialHealthAssessmentSessions(
filter: $filter,
limit: $limit,
nextToken: $nextToken
) {
items {
id
clientId
inviteCode
householdId
status
firstName
lastName
fullName
hasPartner
partnerId
partnerFirstName
partnerLastName
partnerFullName
finHealthAssessmentFull
responses {
questionId
intResponse
stringResponse
section
}
visionGoalsScore
retirementPlanningScore
insuranceAssetProtectionScore
debtCashFlowManagementScore
educationPlanningScore
investmentPlanningScore
incomeTaxPlanningScore
businessPlanningScore
charitablePlanningScore
estatePlanningScore
createdAt
updatedAt
}
nextToken
}
}
Variables
{
"filter": ModelFinancialHealthAssessmentSessionFilterInput,
"limit": 987,
"nextToken": "abc123"
}
Response
{
"data": {
"listFinancialHealthAssessmentSessions": {
"items": [FinancialHealthAssessmentSession],
"nextToken": "abc123"
}
}
}
listGoalsSessions
Response
Returns a ModelGoalsSessionConnection
Arguments
| Name | Description |
|---|---|
filter - ModelGoalsSessionFilterInput
|
|
limit - Int
|
|
nextToken - String
|
Example
Query
query ListGoalsSessions(
$filter: ModelGoalsSessionFilterInput,
$limit: Int,
$nextToken: String
) {
listGoalsSessions(
filter: $filter,
limit: $limit,
nextToken: $nextToken
) {
items {
id
clientId
inviteCode
selectedGoalCategoryIds
createdAt
updatedAt
}
nextToken
}
}
Variables
{
"filter": ModelGoalsSessionFilterInput,
"limit": 123,
"nextToken": "abc123"
}
Response
{
"data": {
"listGoalsSessions": {
"items": [GoalsSession],
"nextToken": "abc123"
}
}
}
listHouseholds
Response
Returns a ListHouseholdsOutput
Arguments
| Name | Description |
|---|---|
listHouseholdsInput - ListHouseholdsInput
|
Example
Query
query ListHouseholds($listHouseholdsInput: ListHouseholdsInput) {
listHouseholds(listHouseholdsInput: $listHouseholdsInput) {
households {
householdId
name
clients {
clientId
householdId
iamId
wealthIds
type
title
firstName
middleName
lastName
preferredName
dob
lastLogin
registered
billableStart
address {
addressId
constructedAddress
addressLine1
addressLine2
suburb
postCode
state
country
createdBy
created
updatedBy
updated
}
postalAddress {
addressId
constructedAddress
addressLine1
addressLine2
suburb
postCode
state
country
createdBy
created
updatedBy
updated
}
contactDetails {
emailAddress
mobileNumber
faxNumber
phoneNumber
createdBy
created
updatedBy
updated
}
moduleStates {
moduleStateId
clientId
previouslyCompleted
module
moduleState
sentDate
sentReminders
startedDate
startedReminders
finishedDate
expiredDate
updatedBy
updated
}
wellnessScore
goalCount
taskCount
sex
relationshipStatus
countryCodeBirth
countryCodeResidency
countryCodeCitizenship
notes
externalId
externalSystem
createdBy
created
updatedBy
updated
}
householdStaffAccess {
practiceOfficeId
practiceOfficeName
staffId
staffTitle
staffFirstName
staffMiddleName
staffLastName
role
}
isTest
householdPackageCode
practiceSegmentationId
practiceSegmentationName
countryCode
wellnessScore
createdBy
created
updatedBy
updated
}
page
pageSize
pages
totalCount
}
}
Variables
{"listHouseholdsInput": ListHouseholdsInput}
Response
{
"data": {
"listHouseholds": {
"households": [Household],
"page": 987,
"pageSize": 987,
"pages": 987,
"totalCount": 123
}
}
}
listInvestmentPreferencesSessions
Response
Arguments
| Name | Description |
|---|---|
filter - ModelInvestmentPreferencesSessionFilterInput
|
|
limit - Int
|
|
nextToken - String
|
Example
Query
query ListInvestmentPreferencesSessions(
$filter: ModelInvestmentPreferencesSessionFilterInput,
$limit: Int,
$nextToken: String
) {
listInvestmentPreferencesSessions(
filter: $filter,
limit: $limit,
nextToken: $nextToken
) {
items {
id
clientId
inviteCode
fullName
status
introVideo
customisationVideo
customisation
ethicalVideo
ethical
assetClassVideo
allocationVideo
allocationType
riskVideo
comfortableWithDownturn
costVideo
costDriven
prioritisation {
optionId
rank
}
comments
customisationVideoHelp
customisationVideoComments
ethicalVideoHelp
ethicalVideoComments
assetClassVideoHelp
assetClassVideoComments
allocationVideoHelp
allocationVideoComments
riskVideoHelp
riskVideoComments
riskDiversification
riskMarketCorrection
riskPercentageDrop
riskCapitalProtection
riskAccessCapital
riskInfluencedByReturns
riskIncreaseToMeetGoal
riskMaxDownside
riskInflation
costVideoHelp
costVideoComments
assetClassAndDiversificationVideoHelp
assetClassPreferences
assetClassPreferencesComments
assetClassRisk
assetClassRiskComments
ethicalPreferences
ethicalPreferencesComments
activePassiveVideoHelp
costWealthPriorities
riskVolatilityVideoHelp
riskTimelines
riskExperience
riskKnowledge
riskPast
riskCurrent
riskTimeframe
riskVariability
riskVolatility
riskReaction
riskTolerance
riskFuture
includeRiskSection
includeIntroSection
includeCustomisationSection
includeEthicalSection
includeAssetClassSection
includeAllocationSection
includeCostSection
includePrioritisationSection
includeCommentsSection
createdAt
updatedAt
}
nextToken
}
}
Variables
{
"filter": ModelInvestmentPreferencesSessionFilterInput,
"limit": 987,
"nextToken": "xyz789"
}
Response
{
"data": {
"listInvestmentPreferencesSessions": {
"items": [InvestmentPreferencesSession],
"nextToken": "abc123"
}
}
}
listNotificationPointers
Response
Returns a ModelNotificationPointerConnection
Arguments
| Name | Description |
|---|---|
filter - ModelNotificationPointerFilterInput
|
|
limit - Int
|
|
nextToken - String
|
Example
Query
query ListNotificationPointers(
$filter: ModelNotificationPointerFilterInput,
$limit: Int,
$nextToken: String
) {
listNotificationPointers(
filter: $filter,
limit: $limit,
nextToken: $nextToken
) {
items {
id
owner
recipient
notificationId
createdAt
updatedAt
}
nextToken
}
}
Variables
{
"filter": ModelNotificationPointerFilterInput,
"limit": 987,
"nextToken": "xyz789"
}
Response
{
"data": {
"listNotificationPointers": {
"items": [NotificationPointer],
"nextToken": "abc123"
}
}
}
listNotifications
Response
Returns a ModelNotificationConnection
Arguments
| Name | Description |
|---|---|
filter - ModelNotificationFilterInput
|
|
limit - Int
|
|
nextToken - String
|
Example
Query
query ListNotifications(
$filter: ModelNotificationFilterInput,
$limit: Int,
$nextToken: String
) {
listNotifications(
filter: $filter,
limit: $limit,
nextToken: $nextToken
) {
items {
id
owner
recipient
message
messageRead
createdAt
updatedAt
}
nextToken
}
}
Variables
{
"filter": ModelNotificationFilterInput,
"limit": 123,
"nextToken": "xyz789"
}
Response
{
"data": {
"listNotifications": {
"items": [Notification],
"nextToken": "xyz789"
}
}
}
listOriginationSessions
Response
Returns a ModelOriginationSessionConnection
Arguments
| Name | Description |
|---|---|
filter - ModelOriginationSessionFilterInput
|
|
limit - Int
|
|
nextToken - String
|
Example
Query
query ListOriginationSessions(
$filter: ModelOriginationSessionFilterInput,
$limit: Int,
$nextToken: String
) {
listOriginationSessions(
filter: $filter,
limit: $limit,
nextToken: $nextToken
) {
items {
id
clientId
inviteCode
householdId
status
clientFirstName
clientLastName
clientFullName
hasPartner
partnerId
partnerFirstName
partnerLastName
partnerFullName
questionnaires
lifeIncGoals
lifeIncConnections
lifeIncFinancialDetails
finHealthAssessmentFull
foundationsFull
valuesInc3Things
governanceIncPersonalDetails
governanceIncAssetsLiabilitiesIncomeExpenses
governanceIncInsurance
governanceIncBusinessPlanning
governanceIncEducationPlanning
governanceIncCharitablePlanning
governanceIncTaxPlanning
governanceIncEstatePlanning
investmentPreferencesIncRiskSection
investmentPreferencesIncIntroSection
investmentPreferencesIncCustomisationSection
investmentPreferencesIncEthicalSection
investmentPreferencesIncAssetClassSection
investmentPreferencesIncAllocationSection
investmentPreferencesIncCostSection
investmentPreferencesIncPrioritisationSection
investmentPreferencesIncCommentsSection
uploadFileList {
prefix
folder
fileName
share
}
uploadIdentity
stepTracker {
questionId
sectionId
questionnaireStep
questionnaire
}
completedQuestionnaires
failedQuestionnaires
createdAt
updatedAt
}
nextToken
}
}
Variables
{
"filter": ModelOriginationSessionFilterInput,
"limit": 987,
"nextToken": "xyz789"
}
Response
{
"data": {
"listOriginationSessions": {
"items": [OriginationSession],
"nextToken": "abc123"
}
}
}
listPractices
Response
Returns a ListPracticesOutput
Arguments
| Name | Description |
|---|---|
listPracticesInput - ListPracticesInput
|
Example
Query
query ListPractices($listPracticesInput: ListPracticesInput) {
listPractices(listPracticesInput: $listPracticesInput) {
practice {
practiceId
practiceCode
dealerGroup {
dealerGroupId
name
abn
afsl
afslName
legalName
createdBy
created
updatedBy
updated
}
name
abn
afsl
afslName
legalName
status
originalStatus
ilgn
config {
practiceConfigId
practiceId
palette {
primary {
...PracticeConfigPaletteBGFGColorsFragment
}
secondary {
...PracticeConfigPaletteBGFGColorsFragment
}
buttons {
...PracticeConfigPaletteButtonsFragment
}
backgrounds {
...PracticeConfigPaletteBackgroundsFragment
}
}
typography {
mainFontFamily
mainMonoFontFamily
}
configuration {
modules {
...PracticeConfigConfigurationModulesFragment
}
notification {
...PracticeConfigConfigurationNotificationFragment
}
mfa {
...PracticeConfigConfigurationMFAFragment
}
defaultClientSharing
lockClientDetails
inAppNotifications {
...PracticeConfigConfigurationInAppNotificationFragment
}
filterSettings {
...PracticeConfigConfigurationFilterSettingsFragment
}
removeLogoWhiteBackground {
...PracticeConfigConfigurationRemoveLogoWhiteBackgroundFragment
}
}
theme
}
usesExternalDomain
practicePackageCode
whiteLabelling
logos {
id
practiceLogoId
practiceId
type
logo
createdBy
created
updatedBy
updated
}
offices {
practiceOfficeId
contactDetails {
emailAddress
mobileNumber
faxNumber
phoneNumber
createdBy
created
updatedBy
updated
}
address {
addressId
constructedAddress
addressLine1
addressLine2
suburb
postCode
state
country
createdBy
created
updatedBy
updated
}
name
createdBy
created
updatedBy
updated
}
homeRegion
homeLocale
createdBy
created
updatedBy
updated
}
page
pageSize
pages
totalCount
}
}
Variables
{"listPracticesInput": ListPracticesInput}
Response
{
"data": {
"listPractices": {
"practice": [Practice],
"page": 123,
"pageSize": 987,
"pages": 987,
"totalCount": 987
}
}
}
listRedtailLoadErrors
Response
Returns a ModelRedtailLoadErrorsConnection
Arguments
| Name | Description |
|---|---|
filter - ModelRedtailLoadErrorsFilterInput
|
|
limit - Int
|
|
nextToken - String
|
Example
Query
query ListRedtailLoadErrors(
$filter: ModelRedtailLoadErrorsFilterInput,
$limit: Int,
$nextToken: String
) {
listRedtailLoadErrors(
filter: $filter,
limit: $limit,
nextToken: $nextToken
) {
items {
id
errorMessage
redtailPayload
createdAt
updatedAt
}
nextToken
}
}
Variables
{
"filter": ModelRedtailLoadErrorsFilterInput,
"limit": 123,
"nextToken": "xyz789"
}
Response
{
"data": {
"listRedtailLoadErrors": {
"items": [RedtailLoadErrors],
"nextToken": "xyz789"
}
}
}
listRegistrations
Response
Returns a ModelRegistrationConnection
Arguments
| Name | Description |
|---|---|
filter - ModelRegistrationFilterInput
|
|
limit - Int
|
|
nextToken - String
|
Example
Query
query ListRegistrations(
$filter: ModelRegistrationFilterInput,
$limit: Int,
$nextToken: String
) {
listRegistrations(
filter: $filter,
limit: $limit,
nextToken: $nextToken
) {
items {
id
clientId
inviteCode
fullName
createdAt
updatedAt
}
nextToken
}
}
Variables
{
"filter": ModelRegistrationFilterInput,
"limit": 123,
"nextToken": "xyz789"
}
Response
{
"data": {
"listRegistrations": {
"items": [Registration],
"nextToken": "abc123"
}
}
}
listSecurities
Response
Returns a ModelSecurityConnection
Arguments
| Name | Description |
|---|---|
filter - ModelSecurityFilterInput
|
|
limit - Int
|
|
nextToken - String
|
Example
Query
query ListSecurities(
$filter: ModelSecurityFilterInput,
$limit: Int,
$nextToken: String
) {
listSecurities(
filter: $filter,
limit: $limit,
nextToken: $nextToken
) {
items {
id
assetClassName
code
description
exchange
msCode
msNonFundCode
name
securityId
securityType
securityGroup
ticker
createdAt
updatedAt
}
nextToken
}
}
Variables
{
"filter": ModelSecurityFilterInput,
"limit": 987,
"nextToken": "xyz789"
}
Response
{
"data": {
"listSecurities": {
"items": [Security],
"nextToken": "xyz789"
}
}
}
listStaff
Response
Returns a ListStaffOutput
Arguments
| Name | Description |
|---|---|
args - ListStaffInput
|
Example
Query
query ListStaff($args: ListStaffInput) {
listStaff(args: $args) {
staff {
staffId
practiceOfficeId
iamId
title
firstName
middleName
lastName
role
staffHouseholdAccess {
householdId
householdName
role
}
digitalSignatureS3Path
contactDetails {
emailAddress
mobileNumber
faxNumber
phoneNumber
createdBy
created
updatedBy
updated
}
externalId
externalSystem
createdBy
created
updatedBy
updated
}
page
pageSize
pages
totalCount
}
}
Variables
{"args": ListStaffInput}
Response
{
"data": {
"listStaff": {
"staff": [Staff],
"page": 123,
"pageSize": 987,
"pages": 987,
"totalCount": 987
}
}
}
listSurveyIds
Response
Returns a ListSurveyIdsOutput
Arguments
| Name | Description |
|---|---|
args - ListSurveyIdsInput
|
Example
Query
query ListSurveyIds($args: ListSurveyIdsInput) {
listSurveyIds(args: $args) {
LIFE
FHA
GOALS
IP
GOV
FND
}
}
Variables
{"args": ListSurveyIdsInput}
Response
{
"data": {
"listSurveyIds": {
"LIFE": "xyz789",
"FHA": "xyz789",
"GOALS": "xyz789",
"IP": "abc123",
"GOV": "abc123",
"FND": "xyz789"
}
}
}
listSurveyResponseData
Response
Returns a ModelSurveyResponseDataConnection
Arguments
| Name | Description |
|---|---|
filter - ModelSurveyResponseDataFilterInput
|
|
limit - Int
|
|
nextToken - String
|
Example
Query
query ListSurveyResponseData(
$filter: ModelSurveyResponseDataFilterInput,
$limit: Int,
$nextToken: String
) {
listSurveyResponseData(
filter: $filter,
limit: $limit,
nextToken: $nextToken
) {
items {
id
clientId
inviteCode
householdId
keyValueData
status
surveyId
progress
createdAt
updatedAt
}
nextToken
}
}
Variables
{
"filter": ModelSurveyResponseDataFilterInput,
"limit": 123,
"nextToken": "abc123"
}
Response
{
"data": {
"listSurveyResponseData": {
"items": [SurveyResponseData],
"nextToken": "abc123"
}
}
}
listTamaracLoadErrors
Response
Returns a ModelTamaracLoadErrorsConnection
Arguments
| Name | Description |
|---|---|
filter - ModelTamaracLoadErrorsFilterInput
|
|
limit - Int
|
|
nextToken - String
|
Example
Query
query ListTamaracLoadErrors(
$filter: ModelTamaracLoadErrorsFilterInput,
$limit: Int,
$nextToken: String
) {
listTamaracLoadErrors(
filter: $filter,
limit: $limit,
nextToken: $nextToken
) {
items {
id
sourceFile
errorMessage
tamaracPayload
accountId
accountNumber
primaryMemberFirstName
primaryMemberLastName
fuzzyRatio
rdsCombinedAddressString
tamaracCombinedAddressString
createdAt
updatedAt
}
nextToken
}
}
Variables
{
"filter": ModelTamaracLoadErrorsFilterInput,
"limit": 123,
"nextToken": "abc123"
}
Response
{
"data": {
"listTamaracLoadErrors": {
"items": [TamaracLoadErrors],
"nextToken": "xyz789"
}
}
}
listYourLifeSessions
Response
Returns a ModelYourLifeSessionConnection
Arguments
| Name | Description |
|---|---|
filter - ModelYourLifeSessionFilterInput
|
|
limit - Int
|
|
nextToken - String
|
Example
Query
query ListYourLifeSessions(
$filter: ModelYourLifeSessionFilterInput,
$limit: Int,
$nextToken: String
) {
listYourLifeSessions(
filter: $filter,
limit: $limit,
nextToken: $nextToken
) {
items {
id
clientId
inviteCode
householdId
status
firstName
lastName
fullName
hasPartner
partnerId
includeGoals
includeConnections
includeFinancialDetails
partnerFirstName
partnerLastName
partnerFullName
responses {
questionId
intResponse
stringResponse
}
lovedOnes
communityConnections
globalConnections
overallScore
emotionalScore
environmentalScore
spiritualScore
socialScore
educationScore
occupationalScore
physicalScore
financialScore
notes {
householdId
valueGroupId
note
}
createdAt
updatedAt
}
nextToken
}
}
Variables
{
"filter": ModelYourLifeSessionFilterInput,
"limit": 123,
"nextToken": "abc123"
}
Response
{
"data": {
"listYourLifeSessions": {
"items": [YourLifeSession],
"nextToken": "abc123"
}
}
}
listYourValuesSessions
Response
Returns a ModelYourValuesSessionConnection
Arguments
| Name | Description |
|---|---|
filter - ModelYourValuesSessionFilterInput
|
|
limit - Int
|
|
nextToken - String
|
Example
Query
query ListYourValuesSessions(
$filter: ModelYourValuesSessionFilterInput,
$limit: Int,
$nextToken: String
) {
listYourValuesSessions(
filter: $filter,
limit: $limit,
nextToken: $nextToken
) {
items {
id
clientId
inviteCode
partnerId
partnerInviteCode
client {
clientId
regrets
values {
cardId
rank
meaningReason
progressAction
progress
}
step
lastSeen
individualValuesCompleted
}
partner {
clientId
regrets
values {
cardId
rank
meaningReason
progressAction
progress
}
step
lastSeen
individualValuesCompleted
}
adviser {
staffId
step
lastSeen
}
support {
staffId
step
lastSeen
}
alignedValues {
cardId
clientId
rank
notes
progress
description
nextSteps {
id
title
notes
assignedToClientId
created
}
householdMemberProgress {
description
progress
clientId
}
}
valuesInc3Things
partnerValuesInc3Things
individualValuesOnly
step
lastSeen
createdAt
updatedAt
}
nextToken
}
}
Variables
{
"filter": ModelYourValuesSessionFilterInput,
"limit": 123,
"nextToken": "abc123"
}
Response
{
"data": {
"listYourValuesSessions": {
"items": [YourValuesSession],
"nextToken": "abc123"
}
}
}
originationSessionByClientId
Response
Returns a ModelOriginationSessionConnection
Arguments
| Name | Description |
|---|---|
clientId - Int!
|
|
sortDirection - ModelSortDirection
|
|
filter - ModelOriginationSessionFilterInput
|
|
limit - Int
|
|
nextToken - String
|
Example
Query
query OriginationSessionByClientId(
$clientId: Int!,
$sortDirection: ModelSortDirection,
$filter: ModelOriginationSessionFilterInput,
$limit: Int,
$nextToken: String
) {
originationSessionByClientId(
clientId: $clientId,
sortDirection: $sortDirection,
filter: $filter,
limit: $limit,
nextToken: $nextToken
) {
items {
id
clientId
inviteCode
householdId
status
clientFirstName
clientLastName
clientFullName
hasPartner
partnerId
partnerFirstName
partnerLastName
partnerFullName
questionnaires
lifeIncGoals
lifeIncConnections
lifeIncFinancialDetails
finHealthAssessmentFull
foundationsFull
valuesInc3Things
governanceIncPersonalDetails
governanceIncAssetsLiabilitiesIncomeExpenses
governanceIncInsurance
governanceIncBusinessPlanning
governanceIncEducationPlanning
governanceIncCharitablePlanning
governanceIncTaxPlanning
governanceIncEstatePlanning
investmentPreferencesIncRiskSection
investmentPreferencesIncIntroSection
investmentPreferencesIncCustomisationSection
investmentPreferencesIncEthicalSection
investmentPreferencesIncAssetClassSection
investmentPreferencesIncAllocationSection
investmentPreferencesIncCostSection
investmentPreferencesIncPrioritisationSection
investmentPreferencesIncCommentsSection
uploadFileList {
prefix
folder
fileName
share
}
uploadIdentity
stepTracker {
questionId
sectionId
questionnaireStep
questionnaire
}
completedQuestionnaires
failedQuestionnaires
createdAt
updatedAt
}
nextToken
}
}
Variables
{
"clientId": 123,
"sortDirection": "ASC",
"filter": ModelOriginationSessionFilterInput,
"limit": 123,
"nextToken": "xyz789"
}
Response
{
"data": {
"originationSessionByClientId": {
"items": [OriginationSession],
"nextToken": "abc123"
}
}
}
originationSessionByInviteCode
Response
Returns a ModelOriginationSessionConnection
Arguments
| Name | Description |
|---|---|
inviteCode - String!
|
|
sortDirection - ModelSortDirection
|
|
filter - ModelOriginationSessionFilterInput
|
|
limit - Int
|
|
nextToken - String
|
Example
Query
query OriginationSessionByInviteCode(
$inviteCode: String!,
$sortDirection: ModelSortDirection,
$filter: ModelOriginationSessionFilterInput,
$limit: Int,
$nextToken: String
) {
originationSessionByInviteCode(
inviteCode: $inviteCode,
sortDirection: $sortDirection,
filter: $filter,
limit: $limit,
nextToken: $nextToken
) {
items {
id
clientId
inviteCode
householdId
status
clientFirstName
clientLastName
clientFullName
hasPartner
partnerId
partnerFirstName
partnerLastName
partnerFullName
questionnaires
lifeIncGoals
lifeIncConnections
lifeIncFinancialDetails
finHealthAssessmentFull
foundationsFull
valuesInc3Things
governanceIncPersonalDetails
governanceIncAssetsLiabilitiesIncomeExpenses
governanceIncInsurance
governanceIncBusinessPlanning
governanceIncEducationPlanning
governanceIncCharitablePlanning
governanceIncTaxPlanning
governanceIncEstatePlanning
investmentPreferencesIncRiskSection
investmentPreferencesIncIntroSection
investmentPreferencesIncCustomisationSection
investmentPreferencesIncEthicalSection
investmentPreferencesIncAssetClassSection
investmentPreferencesIncAllocationSection
investmentPreferencesIncCostSection
investmentPreferencesIncPrioritisationSection
investmentPreferencesIncCommentsSection
uploadFileList {
prefix
folder
fileName
share
}
uploadIdentity
stepTracker {
questionId
sectionId
questionnaireStep
questionnaire
}
completedQuestionnaires
failedQuestionnaires
createdAt
updatedAt
}
nextToken
}
}
Variables
{
"inviteCode": "abc123",
"sortDirection": "ASC",
"filter": ModelOriginationSessionFilterInput,
"limit": 123,
"nextToken": "abc123"
}
Response
{
"data": {
"originationSessionByInviteCode": {
"items": [OriginationSession],
"nextToken": "xyz789"
}
}
}
practiceListAllStaffs
Response
Returns a PracticeListAllStaffsOutput
Arguments
| Name | Description |
|---|---|
args - PracticeListAllStaffsInput
|
Example
Query
query PracticeListAllStaffs($args: PracticeListAllStaffsInput) {
practiceListAllStaffs(args: $args) {
searchResult {
staffId
firstName
lastName
email
mobileNumber
role
isActive
externalId
externalSystem
contactDetailsId
practiceOfficeId
practiceOfficeName
practiceId
practiceName
lastLogin
created
createdBy
updated
updatedBy
}
}
}
Variables
{"args": PracticeListAllStaffsInput}
Response
{
"data": {
"practiceListAllStaffs": {
"searchResult": [PracticeListAllStaffsData]
}
}
}
practiceReturnsBillableClientList
Response
Returns a practiceReturnsBillableClientListOutput
Arguments
| Name | Description |
|---|---|
args - practiceReturnsBillableClientListInput
|
Example
Query
query PracticeReturnsBillableClientList($args: practiceReturnsBillableClientListInput) {
practiceReturnsBillableClientList(args: $args) {
searchResult {
practiceId
practiceName
practiceOfficeId
staffId
staffFirstName
staffLastName
householdTeamMemberRole
householdId
cfoClientId
cfoClientFirstName
cfoClientLastName
cfoClientType
cfoClientEmail
cfoClientIsActive
cfoClientLastLogin
cfoClientBillableStart
cfoClientBillableTrigger
nonCfoClientId
nonCfoClientFirstName
nonCfoClientLastName
nonCfoClientType
nonCfoClientEmail
nonCfoClientIsActive
nonCfoClientLastLogin
nonCfoClientBillableStart
nonCfoClientBillableTrigger
}
}
}
Variables
{"args": practiceReturnsBillableClientListInput}
Response
{
"data": {
"practiceReturnsBillableClientList": {
"searchResult": [
practiceReturnsBillableClientListData
]
}
}
}
registrationByClientId
Response
Returns a ModelRegistrationConnection
Arguments
| Name | Description |
|---|---|
clientId - Int!
|
|
sortDirection - ModelSortDirection
|
|
filter - ModelRegistrationFilterInput
|
|
limit - Int
|
|
nextToken - String
|
Example
Query
query RegistrationByClientId(
$clientId: Int!,
$sortDirection: ModelSortDirection,
$filter: ModelRegistrationFilterInput,
$limit: Int,
$nextToken: String
) {
registrationByClientId(
clientId: $clientId,
sortDirection: $sortDirection,
filter: $filter,
limit: $limit,
nextToken: $nextToken
) {
items {
id
clientId
inviteCode
fullName
createdAt
updatedAt
}
nextToken
}
}
Variables
{
"clientId": 987,
"sortDirection": "ASC",
"filter": ModelRegistrationFilterInput,
"limit": 123,
"nextToken": "abc123"
}
Response
{
"data": {
"registrationByClientId": {
"items": [Registration],
"nextToken": "xyz789"
}
}
}
registrationByInviteCode
Response
Returns a ModelRegistrationConnection
Arguments
| Name | Description |
|---|---|
inviteCode - String!
|
|
sortDirection - ModelSortDirection
|
|
filter - ModelRegistrationFilterInput
|
|
limit - Int
|
|
nextToken - String
|
Example
Query
query RegistrationByInviteCode(
$inviteCode: String!,
$sortDirection: ModelSortDirection,
$filter: ModelRegistrationFilterInput,
$limit: Int,
$nextToken: String
) {
registrationByInviteCode(
inviteCode: $inviteCode,
sortDirection: $sortDirection,
filter: $filter,
limit: $limit,
nextToken: $nextToken
) {
items {
id
clientId
inviteCode
fullName
createdAt
updatedAt
}
nextToken
}
}
Variables
{
"inviteCode": "abc123",
"sortDirection": "ASC",
"filter": ModelRegistrationFilterInput,
"limit": 123,
"nextToken": "xyz789"
}
Response
{
"data": {
"registrationByInviteCode": {
"items": [Registration],
"nextToken": "xyz789"
}
}
}
requestAffordabilityReport
Response
Returns a String
Arguments
| Name | Description |
|---|---|
args - RequestAffordabilityReportInput
|
Example
Query
query RequestAffordabilityReport($args: RequestAffordabilityReportInput) {
requestAffordabilityReport(args: $args)
}
Variables
{"args": RequestAffordabilityReportInput}
Response
{
"data": {
"requestAffordabilityReport": "abc123"
}
}
riskalyzeGetCallbackInputs
Response
Returns a RiskalyzeCallbackInputs
Arguments
| Name | Description |
|---|---|
args - RiskalyzeGetCallbackInputsRequest
|
Example
Query
query RiskalyzeGetCallbackInputs($args: RiskalyzeGetCallbackInputsRequest) {
riskalyzeGetCallbackInputs(args: $args) {
clientId
state
redirectUri
}
}
Variables
{"args": RiskalyzeGetCallbackInputsRequest}
Response
{
"data": {
"riskalyzeGetCallbackInputs": {
"clientId": "abc123",
"state": "abc123",
"redirectUri": "xyz789"
}
}
}
riskalyzeGetPortfoliosForClient
Response
Returns [RiskalyzeClientPortfolio]
Arguments
| Name | Description |
|---|---|
args - RiskalyzeGetPortfoliosForClientRequest
|
Example
Query
query RiskalyzeGetPortfoliosForClient($args: RiskalyzeGetPortfoliosForClientRequest) {
riskalyzeGetPortfoliosForClient(args: $args) {
riskalyzePortfolioId
portfolioName
portfolioTotal
}
}
Variables
{"args": RiskalyzeGetPortfoliosForClientRequest}
Response
{
"data": {
"riskalyzeGetPortfoliosForClient": [
{
"riskalyzePortfolioId": 123,
"portfolioName": "xyz789",
"portfolioTotal": 987
}
]
}
}
riskalyzeGetRiskalyzeIdForClient
Response
Returns an Int
Arguments
| Name | Description |
|---|---|
args - RiskalyzeGetRiskalyzeIdForClientRequest
|
Example
Query
query RiskalyzeGetRiskalyzeIdForClient($args: RiskalyzeGetRiskalyzeIdForClientRequest) {
riskalyzeGetRiskalyzeIdForClient(args: $args)
}
Variables
{"args": RiskalyzeGetRiskalyzeIdForClientRequest}
Response
{"data": {"riskalyzeGetRiskalyzeIdForClient": 987}}
riskalyzeGetRiskalyzePortfolioId
Response
Returns an Int
Arguments
| Name | Description |
|---|---|
args - RiskalyzeGetRiskalyzePortfolioIdRequest
|
Example
Query
query RiskalyzeGetRiskalyzePortfolioId($args: RiskalyzeGetRiskalyzePortfolioIdRequest) {
riskalyzeGetRiskalyzePortfolioId(args: $args)
}
Variables
{"args": RiskalyzeGetRiskalyzePortfolioIdRequest}
Response
{"data": {"riskalyzeGetRiskalyzePortfolioId": 123}}
riskalyzeIsClientLinked
Response
Returns a Boolean
Arguments
| Name | Description |
|---|---|
args - RiskalyzeIsClientLinkedRequest
|
Example
Query
query RiskalyzeIsClientLinked($args: RiskalyzeIsClientLinkedRequest) {
riskalyzeIsClientLinked(args: $args)
}
Variables
{"args": RiskalyzeIsClientLinkedRequest}
Response
{"data": {"riskalyzeIsClientLinked": false}}
riskalyzeIsPortfolioLinked
Response
Returns a Boolean
Arguments
| Name | Description |
|---|---|
args - RiskalyzeIsPortfolioLinkedRequest
|
Example
Query
query RiskalyzeIsPortfolioLinked($args: RiskalyzeIsPortfolioLinkedRequest) {
riskalyzeIsPortfolioLinked(args: $args)
}
Variables
{"args": RiskalyzeIsPortfolioLinkedRequest}
Response
{"data": {"riskalyzeIsPortfolioLinked": false}}
riskalyzeSearchClients
Response
Returns [RiskalyzeSearchedClient]
Arguments
| Name | Description |
|---|---|
args - RiskalyzeSearchClientsRequest
|
Example
Query
query RiskalyzeSearchClients($args: RiskalyzeSearchClientsRequest) {
riskalyzeSearchClients(args: $args) {
riskalyzeClientId
firstName
lastName
email
}
}
Variables
{"args": RiskalyzeSearchClientsRequest}
Response
{
"data": {
"riskalyzeSearchClients": [
{
"riskalyzeClientId": "xyz789",
"firstName": "abc123",
"lastName": "xyz789",
"email": "xyz789"
}
]
}
}
search
Response
Returns a SearchResult
Arguments
| Name | Description |
|---|---|
args - SearchInput
|
Example
Query
query Search($args: SearchInput) {
search(args: $args) {
pagination {
page
pageSize
numPages
numItems
}
results {
... on SearchHousehold {
id
name
practiceSegmentationId
clients {
id
firstName
middleName
lastName
goalCount
taskCount
register
wellnessScore
lastLogin
moduleStates {
...SearchModuleStateFragment
}
}
}
}
}
}
Variables
{"args": SearchInput}
Response
{
"data": {
"search": {
"pagination": Pagination,
"results": [SearchHousehold]
}
}
}
searchClientSupport
Response
Returns a SearchClientSupportOutput
Arguments
| Name | Description |
|---|---|
args - SearchClientSupportInput
|
Example
Query
query SearchClientSupport($args: SearchClientSupportInput) {
searchClientSupport(args: $args) {
searchResult {
clientId
contactDetailsId
firstName
lastName
email
mobileNumber
isActive
type
dob
externalId
externalSystem
lastLogin
billableStart
billableTrigger
householdId
householdName
householdIsTest
isClientRegistered
staffId
staffFirstName
staffLastName
staffExternalId
staffExternalSystem
practiceOfficeId
practiceOfficeName
practiceId
practiceName
deleted
deletedBy
created
createdBy
updated
updatedBy
}
}
}
Variables
{"args": SearchClientSupportInput}
Response
{
"data": {
"searchClientSupport": {
"searchResult": [SearchClientSupportData]
}
}
}
searchILCN
Response
Returns an SearchILCNOutput
Arguments
| Name | Description |
|---|---|
searchILCNInput - SearchILCNInput
|
Example
Query
query SearchILCN($searchILCNInput: SearchILCNInput) {
searchILCN(searchILCNInput: $searchILCNInput) {
ilClients {
ilcn
clientName
otherNames
adviserFullName
}
}
}
Variables
{"searchILCNInput": SearchILCNInput}
Response
{"data": {"searchILCN": {"ilClients": [ILClient]}}}
searchPractice
Response
Returns a SearchPracticeOutput
Arguments
| Name | Description |
|---|---|
args - SearchPracticeInput
|
Example
Query
query SearchPractice($args: SearchPracticeInput) {
searchPractice(args: $args) {
searchResult {
practiceName
practiceHomeLocale
practiceId
practiceCodeInUUID
practiceAbn
practiceLegalName
practiceContractStart
practiceContractPeriod
practiceConfigID
practicePackageName
practiceWhitelabelEnabled
practiceStatus
createdBy
created
updatedBy
updated
TCVersion
}
}
}
Variables
{"args": SearchPracticeInput}
Response
{
"data": {
"searchPractice": {
"searchResult": [SearchPracticeData]
}
}
}
searchPracticeLogo
Response
Returns a SearchPracticeLogoOutput
Arguments
| Name | Description |
|---|---|
args - SearchPracticeLogoInput
|
Example
Query
query SearchPracticeLogo($args: SearchPracticeLogoInput) {
searchPracticeLogo(args: $args) {
searchResult {
practiceLogoId
practiceId
practiceLogoType
practiceLogos3Path
createdBy
created
updatedBy
updated
}
}
}
Variables
{"args": SearchPracticeLogoInput}
Response
{
"data": {
"searchPracticeLogo": {
"searchResult": [SearchPracticeLogoData]
}
}
}
searchPracticeOffice
Response
Returns a SearchPracticeOfficeOutput
Arguments
| Name | Description |
|---|---|
args - SearchPracticeOfficeInput
|
Example
Query
query SearchPracticeOffice($args: SearchPracticeOfficeInput) {
searchPracticeOffice(args: $args) {
searchResult {
practiceId
practiceOfficeId
addressId
addressLine1
addressLine2
addressSuburb
addressPostcode
addressState
addressCountry
practiceOfficeName
contactDetailsId
emailAddress
mobileNumber
createdBy
created
updatedBy
updated
}
}
}
Variables
{"args": SearchPracticeOfficeInput}
Response
{
"data": {
"searchPracticeOffice": {
"searchResult": [SearchPracticeOfficeData]
}
}
}
searchSecurities
Response
Returns a SearchableSecurityConnection
Arguments
| Name | Description |
|---|---|
filter - SearchableSecurityFilterInput
|
|
sort - [SearchableSecuritySortInput]
|
|
limit - Int
|
|
nextToken - String
|
|
from - Int
|
|
aggregates - [SearchableSecurityAggregationInput]
|
Example
Query
query SearchSecurities(
$filter: SearchableSecurityFilterInput,
$sort: [SearchableSecuritySortInput],
$limit: Int,
$nextToken: String,
$from: Int,
$aggregates: [SearchableSecurityAggregationInput]
) {
searchSecurities(
filter: $filter,
sort: $sort,
limit: $limit,
nextToken: $nextToken,
from: $from,
aggregates: $aggregates
) {
items {
id
assetClassName
code
description
exchange
msCode
msNonFundCode
name
securityId
securityType
securityGroup
ticker
createdAt
updatedAt
}
nextToken
total
aggregateItems {
name
result {
... on SearchableAggregateScalarResult {
value
}
... on SearchableAggregateBucketResult {
buckets {
...SearchableAggregateBucketResultItemFragment
}
}
}
}
}
}
Variables
{
"filter": SearchableSecurityFilterInput,
"sort": [SearchableSecuritySortInput],
"limit": 123,
"nextToken": "xyz789",
"from": 987,
"aggregates": [SearchableSecurityAggregationInput]
}
Response
{
"data": {
"searchSecurities": {
"items": [Security],
"nextToken": "abc123",
"total": 123,
"aggregateItems": [SearchableAggregateResult]
}
}
}
searchStaffSupport
Response
Returns a SearchStaffSupportOutput
Arguments
| Name | Description |
|---|---|
args - SearchStaffSupportInput
|
Example
Query
query SearchStaffSupport($args: SearchStaffSupportInput) {
searchStaffSupport(args: $args) {
searchResult {
staffId
firstName
lastName
email
mobileNumber
role
isActive
externalId
externalSystem
contactDetailsId
practiceOfficeId
practiceId
practiceName
lastLogin
created
createdBy
updated
updatedBy
}
}
}
Variables
{"args": SearchStaffSupportInput}
Response
{
"data": {
"searchStaffSupport": {
"searchResult": [SearchStaffSupportData]
}
}
}
searchYourVaultContents
Response
Returns a SearchYourVaultContentsOutput
Arguments
| Name | Description |
|---|---|
searchYourVaultContentsInput - SearchYourVaultContentsInput
|
Example
Query
query SearchYourVaultContents($searchYourVaultContentsInput: SearchYourVaultContentsInput) {
searchYourVaultContents(searchYourVaultContentsInput: $searchYourVaultContentsInput) {
vaultFiles {
pathAndFilename
presignedPathAndFilename
lastModified
size
status
publishCount
uploaderClientId
uploaderStaffId
}
totalCount
}
}
Variables
{
"searchYourVaultContentsInput": SearchYourVaultContentsInput
}
Response
{
"data": {
"searchYourVaultContents": {
"vaultFiles": [YourVaultFileInfo],
"totalCount": 123
}
}
}
securityById
Response
Returns a ModelSecurityConnection
Arguments
| Name | Description |
|---|---|
securityId - Int!
|
|
sortDirection - ModelSortDirection
|
|
filter - ModelSecurityFilterInput
|
|
limit - Int
|
|
nextToken - String
|
Example
Query
query SecurityById(
$securityId: Int!,
$sortDirection: ModelSortDirection,
$filter: ModelSecurityFilterInput,
$limit: Int,
$nextToken: String
) {
securityById(
securityId: $securityId,
sortDirection: $sortDirection,
filter: $filter,
limit: $limit,
nextToken: $nextToken
) {
items {
id
assetClassName
code
description
exchange
msCode
msNonFundCode
name
securityId
securityType
securityGroup
ticker
createdAt
updatedAt
}
nextToken
}
}
Variables
{
"securityId": 987,
"sortDirection": "ASC",
"filter": ModelSecurityFilterInput,
"limit": 987,
"nextToken": "abc123"
}
Response
{
"data": {
"securityById": {
"items": [Security],
"nextToken": "abc123"
}
}
}
showStaffCognitoUserGroup
Response
Returns a ShowStaffCognitoUserGroupOutput
Arguments
| Name | Description |
|---|---|
args - ShowStaffCognitoUserGroupInput
|
Example
Query
query ShowStaffCognitoUserGroup($args: ShowStaffCognitoUserGroupInput) {
showStaffCognitoUserGroup(args: $args) {
staffRdsRole
enabledOrDisabled
firstUserGroup
secondUserGroup
thirdUserGroup
fourthUserGroup
fifthUserGroup
sixthUserGroup
seventhUserGroup
eighthUserGroup
ninthUserGroup
}
}
Variables
{"args": ShowStaffCognitoUserGroupInput}
Response
{
"data": {
"showStaffCognitoUserGroup": {
"staffRdsRole": "abc123",
"enabledOrDisabled": "xyz789",
"firstUserGroup": "abc123",
"secondUserGroup": "xyz789",
"thirdUserGroup": "abc123",
"fourthUserGroup": "xyz789",
"fifthUserGroup": "abc123",
"sixthUserGroup": "xyz789",
"seventhUserGroup": "xyz789",
"eighthUserGroup": "abc123",
"ninthUserGroup": "abc123"
}
}
}
surveyResponseDataByClientId
Response
Returns a ModelSurveyResponseDataConnection
Arguments
| Name | Description |
|---|---|
clientId - Int!
|
|
sortDirection - ModelSortDirection
|
|
filter - ModelSurveyResponseDataFilterInput
|
|
limit - Int
|
|
nextToken - String
|
Example
Query
query SurveyResponseDataByClientId(
$clientId: Int!,
$sortDirection: ModelSortDirection,
$filter: ModelSurveyResponseDataFilterInput,
$limit: Int,
$nextToken: String
) {
surveyResponseDataByClientId(
clientId: $clientId,
sortDirection: $sortDirection,
filter: $filter,
limit: $limit,
nextToken: $nextToken
) {
items {
id
clientId
inviteCode
householdId
keyValueData
status
surveyId
progress
createdAt
updatedAt
}
nextToken
}
}
Variables
{
"clientId": 987,
"sortDirection": "ASC",
"filter": ModelSurveyResponseDataFilterInput,
"limit": 123,
"nextToken": "abc123"
}
Response
{
"data": {
"surveyResponseDataByClientId": {
"items": [SurveyResponseData],
"nextToken": "abc123"
}
}
}
surveyResponseDataByInviteCode
Response
Returns a ModelSurveyResponseDataConnection
Arguments
| Name | Description |
|---|---|
inviteCode - String!
|
|
sortDirection - ModelSortDirection
|
|
filter - ModelSurveyResponseDataFilterInput
|
|
limit - Int
|
|
nextToken - String
|
Example
Query
query SurveyResponseDataByInviteCode(
$inviteCode: String!,
$sortDirection: ModelSortDirection,
$filter: ModelSurveyResponseDataFilterInput,
$limit: Int,
$nextToken: String
) {
surveyResponseDataByInviteCode(
inviteCode: $inviteCode,
sortDirection: $sortDirection,
filter: $filter,
limit: $limit,
nextToken: $nextToken
) {
items {
id
clientId
inviteCode
householdId
keyValueData
status
surveyId
progress
createdAt
updatedAt
}
nextToken
}
}
Variables
{
"inviteCode": "xyz789",
"sortDirection": "ASC",
"filter": ModelSurveyResponseDataFilterInput,
"limit": 987,
"nextToken": "xyz789"
}
Response
{
"data": {
"surveyResponseDataByInviteCode": {
"items": [SurveyResponseData],
"nextToken": "abc123"
}
}
}
validateXplanCredentials
Response
Returns a Boolean
Arguments
| Name | Description |
|---|---|
args - ValidateXplanCredentialsInput
|
Example
Query
query ValidateXplanCredentials($args: ValidateXplanCredentialsInput) {
validateXplanCredentials(args: $args)
}
Variables
{"args": ValidateXplanCredentialsInput}
Response
{"data": {"validateXplanCredentials": true}}
verifyEmailUniqueness
Response
Returns a VerifyEmailUniquenessOutput
Arguments
| Name | Description |
|---|---|
args - VerifyEmailUniquenessInput
|
Example
Query
query VerifyEmailUniqueness($args: VerifyEmailUniquenessInput) {
verifyEmailUniqueness(args: $args) {
uniqueness
contactDetailsId
}
}
Variables
{"args": VerifyEmailUniquenessInput}
Response
{
"data": {
"verifyEmailUniqueness": {
"uniqueness": "abc123",
"contactDetailsId": 987
}
}
}
xplanGetCallbackInputs
Response
Returns a XplanCallbackInputs
Example
Query
query XplanGetCallbackInputs {
xplanGetCallbackInputs {
clientId
redirectUrl
}
}
Response
{
"data": {
"xplanGetCallbackInputs": {
"clientId": "xyz789",
"redirectUrl": "xyz789"
}
}
}
yourLifeSessionByClientId
Response
Returns a ModelYourLifeSessionConnection
Arguments
| Name | Description |
|---|---|
clientId - Int!
|
|
sortDirection - ModelSortDirection
|
|
filter - ModelYourLifeSessionFilterInput
|
|
limit - Int
|
|
nextToken - String
|
Example
Query
query YourLifeSessionByClientId(
$clientId: Int!,
$sortDirection: ModelSortDirection,
$filter: ModelYourLifeSessionFilterInput,
$limit: Int,
$nextToken: String
) {
yourLifeSessionByClientId(
clientId: $clientId,
sortDirection: $sortDirection,
filter: $filter,
limit: $limit,
nextToken: $nextToken
) {
items {
id
clientId
inviteCode
householdId
status
firstName
lastName
fullName
hasPartner
partnerId
includeGoals
includeConnections
includeFinancialDetails
partnerFirstName
partnerLastName
partnerFullName
responses {
questionId
intResponse
stringResponse
}
lovedOnes
communityConnections
globalConnections
overallScore
emotionalScore
environmentalScore
spiritualScore
socialScore
educationScore
occupationalScore
physicalScore
financialScore
notes {
householdId
valueGroupId
note
}
createdAt
updatedAt
}
nextToken
}
}
Variables
{
"clientId": 123,
"sortDirection": "ASC",
"filter": ModelYourLifeSessionFilterInput,
"limit": 123,
"nextToken": "xyz789"
}
Response
{
"data": {
"yourLifeSessionByClientId": {
"items": [YourLifeSession],
"nextToken": "xyz789"
}
}
}
yourLifeSessionByInviteCode
Response
Returns a ModelYourLifeSessionConnection
Arguments
| Name | Description |
|---|---|
inviteCode - String!
|
|
sortDirection - ModelSortDirection
|
|
filter - ModelYourLifeSessionFilterInput
|
|
limit - Int
|
|
nextToken - String
|
Example
Query
query YourLifeSessionByInviteCode(
$inviteCode: String!,
$sortDirection: ModelSortDirection,
$filter: ModelYourLifeSessionFilterInput,
$limit: Int,
$nextToken: String
) {
yourLifeSessionByInviteCode(
inviteCode: $inviteCode,
sortDirection: $sortDirection,
filter: $filter,
limit: $limit,
nextToken: $nextToken
) {
items {
id
clientId
inviteCode
householdId
status
firstName
lastName
fullName
hasPartner
partnerId
includeGoals
includeConnections
includeFinancialDetails
partnerFirstName
partnerLastName
partnerFullName
responses {
questionId
intResponse
stringResponse
}
lovedOnes
communityConnections
globalConnections
overallScore
emotionalScore
environmentalScore
spiritualScore
socialScore
educationScore
occupationalScore
physicalScore
financialScore
notes {
householdId
valueGroupId
note
}
createdAt
updatedAt
}
nextToken
}
}
Variables
{
"inviteCode": "abc123",
"sortDirection": "ASC",
"filter": ModelYourLifeSessionFilterInput,
"limit": 123,
"nextToken": "abc123"
}
Response
{
"data": {
"yourLifeSessionByInviteCode": {
"items": [YourLifeSession],
"nextToken": "abc123"
}
}
}
yourValuesSessionByClientId
Response
Returns a ModelYourValuesSessionConnection
Arguments
| Name | Description |
|---|---|
clientId - Int!
|
|
sortDirection - ModelSortDirection
|
|
filter - ModelYourValuesSessionFilterInput
|
|
limit - Int
|
|
nextToken - String
|
Example
Query
query YourValuesSessionByClientId(
$clientId: Int!,
$sortDirection: ModelSortDirection,
$filter: ModelYourValuesSessionFilterInput,
$limit: Int,
$nextToken: String
) {
yourValuesSessionByClientId(
clientId: $clientId,
sortDirection: $sortDirection,
filter: $filter,
limit: $limit,
nextToken: $nextToken
) {
items {
id
clientId
inviteCode
partnerId
partnerInviteCode
client {
clientId
regrets
values {
cardId
rank
meaningReason
progressAction
progress
}
step
lastSeen
individualValuesCompleted
}
partner {
clientId
regrets
values {
cardId
rank
meaningReason
progressAction
progress
}
step
lastSeen
individualValuesCompleted
}
adviser {
staffId
step
lastSeen
}
support {
staffId
step
lastSeen
}
alignedValues {
cardId
clientId
rank
notes
progress
description
nextSteps {
id
title
notes
assignedToClientId
created
}
householdMemberProgress {
description
progress
clientId
}
}
valuesInc3Things
partnerValuesInc3Things
individualValuesOnly
step
lastSeen
createdAt
updatedAt
}
nextToken
}
}
Variables
{
"clientId": 987,
"sortDirection": "ASC",
"filter": ModelYourValuesSessionFilterInput,
"limit": 123,
"nextToken": "xyz789"
}
Response
{
"data": {
"yourValuesSessionByClientId": {
"items": [YourValuesSession],
"nextToken": "abc123"
}
}
}
yourValuesSessionByInviteCode
Response
Returns a ModelYourValuesSessionConnection
Arguments
| Name | Description |
|---|---|
inviteCode - String!
|
|
sortDirection - ModelSortDirection
|
|
filter - ModelYourValuesSessionFilterInput
|
|
limit - Int
|
|
nextToken - String
|
Example
Query
query YourValuesSessionByInviteCode(
$inviteCode: String!,
$sortDirection: ModelSortDirection,
$filter: ModelYourValuesSessionFilterInput,
$limit: Int,
$nextToken: String
) {
yourValuesSessionByInviteCode(
inviteCode: $inviteCode,
sortDirection: $sortDirection,
filter: $filter,
limit: $limit,
nextToken: $nextToken
) {
items {
id
clientId
inviteCode
partnerId
partnerInviteCode
client {
clientId
regrets
values {
cardId
rank
meaningReason
progressAction
progress
}
step
lastSeen
individualValuesCompleted
}
partner {
clientId
regrets
values {
cardId
rank
meaningReason
progressAction
progress
}
step
lastSeen
individualValuesCompleted
}
adviser {
staffId
step
lastSeen
}
support {
staffId
step
lastSeen
}
alignedValues {
cardId
clientId
rank
notes
progress
description
nextSteps {
id
title
notes
assignedToClientId
created
}
householdMemberProgress {
description
progress
clientId
}
}
valuesInc3Things
partnerValuesInc3Things
individualValuesOnly
step
lastSeen
createdAt
updatedAt
}
nextToken
}
}
Variables
{
"inviteCode": "xyz789",
"sortDirection": "ASC",
"filter": ModelYourValuesSessionFilterInput,
"limit": 123,
"nextToken": "xyz789"
}
Response
{
"data": {
"yourValuesSessionByInviteCode": {
"items": [YourValuesSession],
"nextToken": "xyz789"
}
}
}
yourValuesSessionByPartnerId
Response
Returns a ModelYourValuesSessionConnection
Arguments
| Name | Description |
|---|---|
partnerId - Int!
|
|
sortDirection - ModelSortDirection
|
|
filter - ModelYourValuesSessionFilterInput
|
|
limit - Int
|
|
nextToken - String
|
Example
Query
query YourValuesSessionByPartnerId(
$partnerId: Int!,
$sortDirection: ModelSortDirection,
$filter: ModelYourValuesSessionFilterInput,
$limit: Int,
$nextToken: String
) {
yourValuesSessionByPartnerId(
partnerId: $partnerId,
sortDirection: $sortDirection,
filter: $filter,
limit: $limit,
nextToken: $nextToken
) {
items {
id
clientId
inviteCode
partnerId
partnerInviteCode
client {
clientId
regrets
values {
cardId
rank
meaningReason
progressAction
progress
}
step
lastSeen
individualValuesCompleted
}
partner {
clientId
regrets
values {
cardId
rank
meaningReason
progressAction
progress
}
step
lastSeen
individualValuesCompleted
}
adviser {
staffId
step
lastSeen
}
support {
staffId
step
lastSeen
}
alignedValues {
cardId
clientId
rank
notes
progress
description
nextSteps {
id
title
notes
assignedToClientId
created
}
householdMemberProgress {
description
progress
clientId
}
}
valuesInc3Things
partnerValuesInc3Things
individualValuesOnly
step
lastSeen
createdAt
updatedAt
}
nextToken
}
}
Variables
{
"partnerId": 123,
"sortDirection": "ASC",
"filter": ModelYourValuesSessionFilterInput,
"limit": 123,
"nextToken": "xyz789"
}
Response
{
"data": {
"yourValuesSessionByPartnerId": {
"items": [YourValuesSession],
"nextToken": "xyz789"
}
}
}
yourValuesSessionByPartnerInviteCode
Response
Returns a ModelYourValuesSessionConnection
Arguments
| Name | Description |
|---|---|
partnerInviteCode - String!
|
|
sortDirection - ModelSortDirection
|
|
filter - ModelYourValuesSessionFilterInput
|
|
limit - Int
|
|
nextToken - String
|
Example
Query
query YourValuesSessionByPartnerInviteCode(
$partnerInviteCode: String!,
$sortDirection: ModelSortDirection,
$filter: ModelYourValuesSessionFilterInput,
$limit: Int,
$nextToken: String
) {
yourValuesSessionByPartnerInviteCode(
partnerInviteCode: $partnerInviteCode,
sortDirection: $sortDirection,
filter: $filter,
limit: $limit,
nextToken: $nextToken
) {
items {
id
clientId
inviteCode
partnerId
partnerInviteCode
client {
clientId
regrets
values {
cardId
rank
meaningReason
progressAction
progress
}
step
lastSeen
individualValuesCompleted
}
partner {
clientId
regrets
values {
cardId
rank
meaningReason
progressAction
progress
}
step
lastSeen
individualValuesCompleted
}
adviser {
staffId
step
lastSeen
}
support {
staffId
step
lastSeen
}
alignedValues {
cardId
clientId
rank
notes
progress
description
nextSteps {
id
title
notes
assignedToClientId
created
}
householdMemberProgress {
description
progress
clientId
}
}
valuesInc3Things
partnerValuesInc3Things
individualValuesOnly
step
lastSeen
createdAt
updatedAt
}
nextToken
}
}
Variables
{
"partnerInviteCode": "xyz789",
"sortDirection": "ASC",
"filter": ModelYourValuesSessionFilterInput,
"limit": 987,
"nextToken": "abc123"
}
Response
{
"data": {
"yourValuesSessionByPartnerInviteCode": {
"items": [YourValuesSession],
"nextToken": "xyz789"
}
}
}
Mutations
addAccessToHousehold
Response
Returns a Boolean
Arguments
| Name | Description |
|---|---|
args - AddAccessToHouseholdInput!
|
Example
Query
mutation AddAccessToHousehold($args: AddAccessToHouseholdInput!) {
addAccessToHousehold(args: $args)
}
Variables
{"args": AddAccessToHouseholdInput}
Response
{"data": {"addAccessToHousehold": false}}
addPracticeConfigVaultFolder
Response
Returns a VaultFolder
Arguments
| Name | Description |
|---|---|
args - AddVaultFolderInput!
|
Example
Query
mutation AddPracticeConfigVaultFolder($args: AddVaultFolderInput!) {
addPracticeConfigVaultFolder(args: $args) {
id
name
order
enabled
readonly
}
}
Variables
{"args": AddVaultFolderInput}
Response
{
"data": {
"addPracticeConfigVaultFolder": {
"id": "abc123",
"name": "xyz789",
"order": 123,
"enabled": false,
"readonly": false
}
}
}
addRemoveCognitoUserGroup
Response
Returns an AddRemoveCognitoUserGroupOutput
Arguments
| Name | Description |
|---|---|
args - AddRemoveCognitoUserGroupInput!
|
Example
Query
mutation AddRemoveCognitoUserGroup($args: AddRemoveCognitoUserGroupInput!) {
addRemoveCognitoUserGroup(args: $args) {
staffRdsRole
updateMsg
}
}
Variables
{"args": AddRemoveCognitoUserGroupInput}
Response
{
"data": {
"addRemoveCognitoUserGroup": {
"staffRdsRole": "xyz789",
"updateMsg": "xyz789"
}
}
}
advyzonLinkExistingLumiantHousehold
Response
Returns a Boolean
Arguments
| Name | Description |
|---|---|
args - AdvyzonLinkExistingLumiantHouseholdInput
|
Example
Query
mutation AdvyzonLinkExistingLumiantHousehold($args: AdvyzonLinkExistingLumiantHouseholdInput) {
advyzonLinkExistingLumiantHousehold(args: $args)
}
Variables
{"args": AdvyzonLinkExistingLumiantHouseholdInput}
Response
{"data": {"advyzonLinkExistingLumiantHousehold": true}}
advyzonSyncHousehold
Response
Returns a Boolean
Arguments
| Name | Description |
|---|---|
args - AdvyzonSyncHouseholdInput!
|
Example
Query
mutation AdvyzonSyncHousehold($args: AdvyzonSyncHouseholdInput!) {
advyzonSyncHousehold(args: $args)
}
Variables
{"args": AdvyzonSyncHouseholdInput}
Response
{"data": {"advyzonSyncHousehold": true}}
approveRejectClientChanges
Response
Returns a Boolean
Arguments
| Name | Description |
|---|---|
args - ApproveRejectClientChangesInput!
|
Example
Query
mutation ApproveRejectClientChanges($args: ApproveRejectClientChangesInput!) {
approveRejectClientChanges(args: $args)
}
Variables
{"args": ApproveRejectClientChangesInput}
Response
{"data": {"approveRejectClientChanges": false}}
auth0MigrateUser
Response
Returns a Boolean
Arguments
| Name | Description |
|---|---|
args - Auth0MigrateUserInput!
|
Example
Query
mutation Auth0MigrateUser($args: Auth0MigrateUserInput!) {
auth0MigrateUser(args: $args)
}
Variables
{"args": Auth0MigrateUserInput}
Response
{"data": {"auth0MigrateUser": true}}
auth0UpdatePassword
Response
Returns an Auth0UpdatePasswordOutput
Arguments
| Name | Description |
|---|---|
args - Auth0UpdatePasswordInput!
|
Example
Query
mutation Auth0UpdatePassword($args: Auth0UpdatePasswordInput!) {
auth0UpdatePassword(args: $args) {
statusCode
auth0UserId
}
}
Variables
{"args": Auth0UpdatePasswordInput}
Response
{
"data": {
"auth0UpdatePassword": {
"statusCode": 987,
"auth0UserId": "abc123"
}
}
}
auth0UpdateUser
Response
Returns an Auth0UpdateUserOutput
Arguments
| Name | Description |
|---|---|
args - Auth0UpdateUserInput!
|
Example
Query
mutation Auth0UpdateUser($args: Auth0UpdateUserInput!) {
auth0UpdateUser(args: $args) {
statusCode
auth0UserId
}
}
Variables
{"args": Auth0UpdateUserInput}
Response
{
"data": {
"auth0UpdateUser": {
"statusCode": 123,
"auth0UserId": "xyz789"
}
}
}
cashFlowJsonHelper
Response
Returns a CashFlowJsonHelperOutput
Arguments
| Name | Description |
|---|---|
args - CashFlowJsonHelperInput
|
Example
Query
mutation CashFlowJsonHelper($args: CashFlowJsonHelperInput) {
cashFlowJsonHelper(args: $args) {
data
}
}
Variables
{"args": CashFlowJsonHelperInput}
Response
{
"data": {
"cashFlowJsonHelper": {"data": "abc123"}
}
}
changeClientEmail
Response
Returns a Boolean
Arguments
| Name | Description |
|---|---|
args - ChangeClientEmailInput
|
Example
Query
mutation ChangeClientEmail($args: ChangeClientEmailInput) {
changeClientEmail(args: $args)
}
Variables
{"args": ChangeClientEmailInput}
Response
{"data": {"changeClientEmail": false}}
changePracticeOfficeEmail
Response
Returns a Boolean
Arguments
| Name | Description |
|---|---|
args - ChangePracticeOfficeEmailInput
|
Example
Query
mutation ChangePracticeOfficeEmail($args: ChangePracticeOfficeEmailInput) {
changePracticeOfficeEmail(args: $args)
}
Variables
{"args": ChangePracticeOfficeEmailInput}
Response
{"data": {"changePracticeOfficeEmail": false}}
changeStaffEmail
Response
Returns a Boolean
Arguments
| Name | Description |
|---|---|
args - ChangeStaffEmailInput
|
Example
Query
mutation ChangeStaffEmail($args: ChangeStaffEmailInput) {
changeStaffEmail(args: $args)
}
Variables
{"args": ChangeStaffEmailInput}
Response
{"data": {"changeStaffEmail": false}}
checkAndMigrateUser
Response
Returns a CheckAndMigrateUserOutput
Arguments
| Name | Description |
|---|---|
args - CheckAndMigrateUserInput!
|
Example
Query
mutation CheckAndMigrateUser($args: CheckAndMigrateUserInput!) {
checkAndMigrateUser(args: $args) {
statusCode
newRegion
}
}
Variables
{"args": CheckAndMigrateUserInput}
Response
{
"data": {
"checkAndMigrateUser": {
"statusCode": 123,
"newRegion": "xyz789"
}
}
}
checkEmailAddressAvailable
Response
Returns a Boolean
Arguments
| Name | Description |
|---|---|
args - CheckEmailAddressAvailableInput!
|
Example
Query
mutation CheckEmailAddressAvailable($args: CheckEmailAddressAvailableInput!) {
checkEmailAddressAvailable(args: $args)
}
Variables
{"args": CheckEmailAddressAvailableInput}
Response
{"data": {"checkEmailAddressAvailable": false}}
cloneDemoHouseholds
Response
Returns a Boolean
Arguments
| Name | Description |
|---|---|
args - CloneDemoHouseholdsInput
|
Example
Query
mutation CloneDemoHouseholds($args: CloneDemoHouseholdsInput) {
cloneDemoHouseholds(args: $args)
}
Variables
{"args": CloneDemoHouseholdsInput}
Response
{"data": {"cloneDemoHouseholds": false}}
compareScenarios
Response
Returns a BestLifeProjectionChartData
Arguments
| Name | Description |
|---|---|
args - CompareScenariosInput
|
Example
Query
mutation CompareScenarios($args: CompareScenariosInput) {
compareScenarios(args: $args) {
data
chartSchema
timeMarkers
dataMarkers
}
}
Variables
{"args": CompareScenariosInput}
Response
{
"data": {
"compareScenarios": {
"data": "xyz789",
"chartSchema": "abc123",
"timeMarkers": "xyz789",
"dataMarkers": "abc123"
}
}
}
completeYourLife
Response
Returns a Boolean
Arguments
| Name | Description |
|---|---|
args - LifeCompleteInput!
|
Example
Query
mutation CompleteYourLife($args: LifeCompleteInput!) {
completeYourLife(args: $args)
}
Variables
{"args": LifeCompleteInput}
Response
{"data": {"completeYourLife": true}}
createExternalUploadTracking
Response
Returns an ExternalUploadTracking
Arguments
| Name | Description |
|---|---|
input - CreateExternalUploadTrackingInput!
|
|
condition - ModelExternalUploadTrackingConditionInput
|
Example
Query
mutation CreateExternalUploadTracking(
$input: CreateExternalUploadTrackingInput!,
$condition: ModelExternalUploadTrackingConditionInput
) {
createExternalUploadTracking(
input: $input,
condition: $condition
) {
id
fullS3ObjectPath
identityId
objectKey
practiceId
clientId
goalId
createdAt
updatedAt
}
}
Variables
{
"input": CreateExternalUploadTrackingInput,
"condition": ModelExternalUploadTrackingConditionInput
}
Response
{
"data": {
"createExternalUploadTracking": {
"id": 4,
"fullS3ObjectPath": "abc123",
"identityId": "xyz789",
"objectKey": "xyz789",
"practiceId": 123,
"clientId": 987,
"goalId": 987,
"createdAt": AWSDateTime,
"updatedAt": AWSDateTime
}
}
}
createFinancialHealthAssessmentSession
Response
Returns a FinancialHealthAssessmentSession
Arguments
| Name | Description |
|---|---|
input - CreateFinancialHealthAssessmentSessionInput!
|
|
condition - ModelFinancialHealthAssessmentSessionConditionInput
|
Example
Query
mutation CreateFinancialHealthAssessmentSession(
$input: CreateFinancialHealthAssessmentSessionInput!,
$condition: ModelFinancialHealthAssessmentSessionConditionInput
) {
createFinancialHealthAssessmentSession(
input: $input,
condition: $condition
) {
id
clientId
inviteCode
householdId
status
firstName
lastName
fullName
hasPartner
partnerId
partnerFirstName
partnerLastName
partnerFullName
finHealthAssessmentFull
responses {
questionId
intResponse
stringResponse
section
}
visionGoalsScore
retirementPlanningScore
insuranceAssetProtectionScore
debtCashFlowManagementScore
educationPlanningScore
investmentPlanningScore
incomeTaxPlanningScore
businessPlanningScore
charitablePlanningScore
estatePlanningScore
createdAt
updatedAt
}
}
Variables
{
"input": CreateFinancialHealthAssessmentSessionInput,
"condition": ModelFinancialHealthAssessmentSessionConditionInput
}
Response
{
"data": {
"createFinancialHealthAssessmentSession": {
"id": "4",
"clientId": 987,
"inviteCode": "abc123",
"householdId": 123,
"status": "xyz789",
"firstName": "xyz789",
"lastName": "abc123",
"fullName": "abc123",
"hasPartner": false,
"partnerId": 123,
"partnerFirstName": "xyz789",
"partnerLastName": "abc123",
"partnerFullName": "xyz789",
"finHealthAssessmentFull": true,
"responses": [FHAResponse],
"visionGoalsScore": 987,
"retirementPlanningScore": 123,
"insuranceAssetProtectionScore": 987,
"debtCashFlowManagementScore": 123,
"educationPlanningScore": 123,
"investmentPlanningScore": 987,
"incomeTaxPlanningScore": 123,
"businessPlanningScore": 123,
"charitablePlanningScore": 987,
"estatePlanningScore": 987,
"createdAt": AWSDateTime,
"updatedAt": AWSDateTime
}
}
}
createGoalsSession
Response
Returns a GoalsSession
Arguments
| Name | Description |
|---|---|
input - CreateGoalsSessionInput!
|
|
condition - ModelGoalsSessionConditionInput
|
Example
Query
mutation CreateGoalsSession(
$input: CreateGoalsSessionInput!,
$condition: ModelGoalsSessionConditionInput
) {
createGoalsSession(
input: $input,
condition: $condition
) {
id
clientId
inviteCode
selectedGoalCategoryIds
createdAt
updatedAt
}
}
Variables
{
"input": CreateGoalsSessionInput,
"condition": ModelGoalsSessionConditionInput
}
Response
{
"data": {
"createGoalsSession": {
"id": "4",
"clientId": 987,
"inviteCode": "abc123",
"selectedGoalCategoryIds": [987],
"createdAt": AWSDateTime,
"updatedAt": AWSDateTime
}
}
}
createInvestmentPreferencesSession
Response
Returns an InvestmentPreferencesSession
Arguments
| Name | Description |
|---|---|
input - CreateInvestmentPreferencesSessionInput!
|
|
condition - ModelInvestmentPreferencesSessionConditionInput
|
Example
Query
mutation CreateInvestmentPreferencesSession(
$input: CreateInvestmentPreferencesSessionInput!,
$condition: ModelInvestmentPreferencesSessionConditionInput
) {
createInvestmentPreferencesSession(
input: $input,
condition: $condition
) {
id
clientId
inviteCode
fullName
status
introVideo
customisationVideo
customisation
ethicalVideo
ethical
assetClassVideo
allocationVideo
allocationType
riskVideo
comfortableWithDownturn
costVideo
costDriven
prioritisation {
optionId
rank
}
comments
customisationVideoHelp
customisationVideoComments
ethicalVideoHelp
ethicalVideoComments
assetClassVideoHelp
assetClassVideoComments
allocationVideoHelp
allocationVideoComments
riskVideoHelp
riskVideoComments
riskDiversification
riskMarketCorrection
riskPercentageDrop
riskCapitalProtection
riskAccessCapital
riskInfluencedByReturns
riskIncreaseToMeetGoal
riskMaxDownside
riskInflation
costVideoHelp
costVideoComments
assetClassAndDiversificationVideoHelp
assetClassPreferences
assetClassPreferencesComments
assetClassRisk
assetClassRiskComments
ethicalPreferences
ethicalPreferencesComments
activePassiveVideoHelp
costWealthPriorities
riskVolatilityVideoHelp
riskTimelines
riskExperience
riskKnowledge
riskPast
riskCurrent
riskTimeframe
riskVariability
riskVolatility
riskReaction
riskTolerance
riskFuture
includeRiskSection
includeIntroSection
includeCustomisationSection
includeEthicalSection
includeAssetClassSection
includeAllocationSection
includeCostSection
includePrioritisationSection
includeCommentsSection
createdAt
updatedAt
}
}
Variables
{
"input": CreateInvestmentPreferencesSessionInput,
"condition": ModelInvestmentPreferencesSessionConditionInput
}
Response
{
"data": {
"createInvestmentPreferencesSession": {
"id": 4,
"clientId": 123,
"inviteCode": "abc123",
"fullName": "abc123",
"status": "xyz789",
"introVideo": "xyz789",
"customisationVideo": "xyz789",
"customisation": "Y",
"ethicalVideo": "xyz789",
"ethical": "Y",
"assetClassVideo": "abc123",
"allocationVideo": "abc123",
"allocationType": "S",
"riskVideo": "abc123",
"comfortableWithDownturn": "abc123",
"costVideo": "xyz789",
"costDriven": "Y",
"prioritisation": [InvestmentPreferencesRanking],
"comments": "abc123",
"customisationVideoHelp": "Y",
"customisationVideoComments": "abc123",
"ethicalVideoHelp": "Y",
"ethicalVideoComments": "xyz789",
"assetClassVideoHelp": "Y",
"assetClassVideoComments": "xyz789",
"allocationVideoHelp": "Y",
"allocationVideoComments": "xyz789",
"riskVideoHelp": "Y",
"riskVideoComments": "xyz789",
"riskDiversification": 123,
"riskMarketCorrection": 123,
"riskPercentageDrop": 987,
"riskCapitalProtection": "Y",
"riskAccessCapital": 987,
"riskInfluencedByReturns": 123,
"riskIncreaseToMeetGoal": 987,
"riskMaxDownside": 123,
"riskInflation": 987,
"costVideoHelp": "Y",
"costVideoComments": "abc123",
"assetClassAndDiversificationVideoHelp": "Y",
"assetClassPreferences": "Y",
"assetClassPreferencesComments": "abc123",
"assetClassRisk": "Y",
"assetClassRiskComments": "abc123",
"ethicalPreferences": "Y",
"ethicalPreferencesComments": "xyz789",
"activePassiveVideoHelp": "Y",
"costWealthPriorities": "A",
"riskVolatilityVideoHelp": "Y",
"riskTimelines": "Y",
"riskExperience": 123,
"riskKnowledge": 987,
"riskPast": 987,
"riskCurrent": 987,
"riskTimeframe": 987,
"riskVariability": 987,
"riskVolatility": 987,
"riskReaction": 123,
"riskTolerance": 123,
"riskFuture": 123,
"includeRiskSection": false,
"includeIntroSection": false,
"includeCustomisationSection": false,
"includeEthicalSection": true,
"includeAssetClassSection": false,
"includeAllocationSection": true,
"includeCostSection": false,
"includePrioritisationSection": true,
"includeCommentsSection": false,
"createdAt": AWSDateTime,
"updatedAt": AWSDateTime
}
}
}
createLead
Response
Returns a Boolean
Arguments
| Name | Description |
|---|---|
args - CreateLeadInput!
|
Example
Query
mutation CreateLead($args: CreateLeadInput!) {
createLead(args: $args)
}
Variables
{"args": CreateLeadInput}
Response
{"data": {"createLead": false}}
createNotification
Response
Returns a Notification
Arguments
| Name | Description |
|---|---|
input - CreateNotificationInput!
|
|
condition - ModelNotificationConditionInput
|
Example
Query
mutation CreateNotification(
$input: CreateNotificationInput!,
$condition: ModelNotificationConditionInput
) {
createNotification(
input: $input,
condition: $condition
) {
id
owner
recipient
message
messageRead
createdAt
updatedAt
}
}
Variables
{
"input": CreateNotificationInput,
"condition": ModelNotificationConditionInput
}
Response
{
"data": {
"createNotification": {
"id": 4,
"owner": "xyz789",
"recipient": "abc123",
"message": "abc123",
"messageRead": false,
"createdAt": AWSDateTime,
"updatedAt": AWSDateTime
}
}
}
createNotificationPointer
Response
Returns a NotificationPointer
Arguments
| Name | Description |
|---|---|
input - CreateNotificationPointerInput!
|
|
condition - ModelNotificationPointerConditionInput
|
Example
Query
mutation CreateNotificationPointer(
$input: CreateNotificationPointerInput!,
$condition: ModelNotificationPointerConditionInput
) {
createNotificationPointer(
input: $input,
condition: $condition
) {
id
owner
recipient
notificationId
createdAt
updatedAt
}
}
Variables
{
"input": CreateNotificationPointerInput,
"condition": ModelNotificationPointerConditionInput
}
Response
{
"data": {
"createNotificationPointer": {
"id": 4,
"owner": "abc123",
"recipient": "xyz789",
"notificationId": "xyz789",
"createdAt": AWSDateTime,
"updatedAt": AWSDateTime
}
}
}
createOriginationSession
Response
Returns an OriginationSession
Arguments
| Name | Description |
|---|---|
input - CreateOriginationSessionInput!
|
|
condition - ModelOriginationSessionConditionInput
|
Example
Query
mutation CreateOriginationSession(
$input: CreateOriginationSessionInput!,
$condition: ModelOriginationSessionConditionInput
) {
createOriginationSession(
input: $input,
condition: $condition
) {
id
clientId
inviteCode
householdId
status
clientFirstName
clientLastName
clientFullName
hasPartner
partnerId
partnerFirstName
partnerLastName
partnerFullName
questionnaires
lifeIncGoals
lifeIncConnections
lifeIncFinancialDetails
finHealthAssessmentFull
foundationsFull
valuesInc3Things
governanceIncPersonalDetails
governanceIncAssetsLiabilitiesIncomeExpenses
governanceIncInsurance
governanceIncBusinessPlanning
governanceIncEducationPlanning
governanceIncCharitablePlanning
governanceIncTaxPlanning
governanceIncEstatePlanning
investmentPreferencesIncRiskSection
investmentPreferencesIncIntroSection
investmentPreferencesIncCustomisationSection
investmentPreferencesIncEthicalSection
investmentPreferencesIncAssetClassSection
investmentPreferencesIncAllocationSection
investmentPreferencesIncCostSection
investmentPreferencesIncPrioritisationSection
investmentPreferencesIncCommentsSection
uploadFileList {
prefix
folder
fileName
share
}
uploadIdentity
stepTracker {
questionId
sectionId
questionnaireStep
questionnaire
}
completedQuestionnaires
failedQuestionnaires
createdAt
updatedAt
}
}
Variables
{
"input": CreateOriginationSessionInput,
"condition": ModelOriginationSessionConditionInput
}
Response
{
"data": {
"createOriginationSession": {
"id": "4",
"clientId": 987,
"inviteCode": "abc123",
"householdId": 987,
"status": "xyz789",
"clientFirstName": "abc123",
"clientLastName": "xyz789",
"clientFullName": "xyz789",
"hasPartner": true,
"partnerId": 123,
"partnerFirstName": "xyz789",
"partnerLastName": "abc123",
"partnerFullName": "abc123",
"questionnaires": ["LIFE"],
"lifeIncGoals": true,
"lifeIncConnections": true,
"lifeIncFinancialDetails": true,
"finHealthAssessmentFull": true,
"foundationsFull": false,
"valuesInc3Things": false,
"governanceIncPersonalDetails": false,
"governanceIncAssetsLiabilitiesIncomeExpenses": false,
"governanceIncInsurance": false,
"governanceIncBusinessPlanning": false,
"governanceIncEducationPlanning": true,
"governanceIncCharitablePlanning": true,
"governanceIncTaxPlanning": false,
"governanceIncEstatePlanning": false,
"investmentPreferencesIncRiskSection": false,
"investmentPreferencesIncIntroSection": true,
"investmentPreferencesIncCustomisationSection": true,
"investmentPreferencesIncEthicalSection": false,
"investmentPreferencesIncAssetClassSection": true,
"investmentPreferencesIncAllocationSection": true,
"investmentPreferencesIncCostSection": true,
"investmentPreferencesIncPrioritisationSection": true,
"investmentPreferencesIncCommentsSection": true,
"uploadFileList": [UploadVaultFileInfo],
"uploadIdentity": "xyz789",
"stepTracker": StepTracker,
"completedQuestionnaires": ["LIFE"],
"failedQuestionnaires": ["LIFE"],
"createdAt": AWSDateTime,
"updatedAt": AWSDateTime
}
}
}
createPractice
Response
Returns an Int
Arguments
| Name | Description |
|---|---|
args - CreatePracticeInput
|
Example
Query
mutation CreatePractice($args: CreatePracticeInput) {
createPractice(args: $args)
}
Variables
{"args": CreatePracticeInput}
Response
{"data": {"createPractice": 123}}
createPracticeConfig
Response
Returns a CreatePracticeConfigOutput
Arguments
| Name | Description |
|---|---|
args - CreatePracticeConfigInput
|
Example
Query
mutation CreatePracticeConfig($args: CreatePracticeConfigInput) {
createPracticeConfig(args: $args) {
createdPracticeConfigId
videoPreSignedUploadURL
videoPreSignedUploadURLKey
videoPreSignedUploadURLAccessKeyId
videoPreSignedUploadSecurityToken
videoPreSignedUploadURLPolicy
videoPreSignedUploadURLSignature
}
}
Variables
{"args": CreatePracticeConfigInput}
Response
{
"data": {
"createPracticeConfig": {
"createdPracticeConfigId": 123,
"videoPreSignedUploadURL": "abc123",
"videoPreSignedUploadURLKey": "abc123",
"videoPreSignedUploadURLAccessKeyId": "xyz789",
"videoPreSignedUploadSecurityToken": "xyz789",
"videoPreSignedUploadURLPolicy": "xyz789",
"videoPreSignedUploadURLSignature": "xyz789"
}
}
}
createPracticeLogo
Response
Returns a CreatePracticeLogoOutput
Arguments
| Name | Description |
|---|---|
args - CreatePracticeLogoInput!
|
Example
Query
mutation CreatePracticeLogo($args: CreatePracticeLogoInput!) {
createPracticeLogo(args: $args) {
createdPracticeLogoConfigurationId
}
}
Variables
{"args": CreatePracticeLogoInput}
Response
{"data": {"createPracticeLogo": {"createdPracticeLogoConfigurationId": 123}}}
createPracticeOffice
Response
Returns a CreatePracticeOfficeOutput
Arguments
| Name | Description |
|---|---|
args - CreatePracticeOfficeInput!
|
Example
Query
mutation CreatePracticeOffice($args: CreatePracticeOfficeInput!) {
createPracticeOffice(args: $args) {
createdPracticeOfficeId
createdPracticeOfficeIdEmail
}
}
Variables
{"args": CreatePracticeOfficeInput}
Response
{
"data": {
"createPracticeOffice": {
"createdPracticeOfficeId": 123,
"createdPracticeOfficeIdEmail": "abc123"
}
}
}
createPracticeOfficeAndStaff
Response
Returns a CreatePracticeOfficeAndStaffOutput
Arguments
| Name | Description |
|---|---|
args - CreatePracticeOfficeAndStaffInput!
|
Example
Query
mutation CreatePracticeOfficeAndStaff($args: CreatePracticeOfficeAndStaffInput!) {
createPracticeOfficeAndStaff(args: $args) {
createdPracticeOfficeId
createdStaffId
}
}
Variables
{"args": CreatePracticeOfficeAndStaffInput}
Response
{
"data": {
"createPracticeOfficeAndStaff": {
"createdPracticeOfficeId": 987,
"createdStaffId": 987
}
}
}
createQuickSurvey
Response
Returns a CreateQuickSurveyOutput
Arguments
| Name | Description |
|---|---|
args - CreateQuickSurveyInput
|
Example
Query
mutation CreateQuickSurvey($args: CreateQuickSurveyInput) {
createQuickSurvey(args: $args) {
message
}
}
Variables
{"args": CreateQuickSurveyInput}
Response
{
"data": {
"createQuickSurvey": {
"message": "abc123"
}
}
}
createRedtailLoadErrors
Response
Returns a RedtailLoadErrors
Arguments
| Name | Description |
|---|---|
input - CreateRedtailLoadErrorsInput!
|
|
condition - ModelRedtailLoadErrorsConditionInput
|
Example
Query
mutation CreateRedtailLoadErrors(
$input: CreateRedtailLoadErrorsInput!,
$condition: ModelRedtailLoadErrorsConditionInput
) {
createRedtailLoadErrors(
input: $input,
condition: $condition
) {
id
errorMessage
redtailPayload
createdAt
updatedAt
}
}
Variables
{
"input": CreateRedtailLoadErrorsInput,
"condition": ModelRedtailLoadErrorsConditionInput
}
Response
{
"data": {
"createRedtailLoadErrors": {
"id": "4",
"errorMessage": "abc123",
"redtailPayload": "abc123",
"createdAt": AWSDateTime,
"updatedAt": AWSDateTime
}
}
}
createRegistration
Response
Returns a Registration
Arguments
| Name | Description |
|---|---|
input - CreateRegistrationInput!
|
|
condition - ModelRegistrationConditionInput
|
Example
Query
mutation CreateRegistration(
$input: CreateRegistrationInput!,
$condition: ModelRegistrationConditionInput
) {
createRegistration(
input: $input,
condition: $condition
) {
id
clientId
inviteCode
fullName
createdAt
updatedAt
}
}
Variables
{
"input": CreateRegistrationInput,
"condition": ModelRegistrationConditionInput
}
Response
{
"data": {
"createRegistration": {
"id": "4",
"clientId": 123,
"inviteCode": "xyz789",
"fullName": "abc123",
"createdAt": AWSDateTime,
"updatedAt": AWSDateTime
}
}
}
createSecurity
Response
Returns a Security
Arguments
| Name | Description |
|---|---|
input - CreateSecurityInput!
|
|
condition - ModelSecurityConditionInput
|
Example
Query
mutation CreateSecurity(
$input: CreateSecurityInput!,
$condition: ModelSecurityConditionInput
) {
createSecurity(
input: $input,
condition: $condition
) {
id
assetClassName
code
description
exchange
msCode
msNonFundCode
name
securityId
securityType
securityGroup
ticker
createdAt
updatedAt
}
}
Variables
{
"input": CreateSecurityInput,
"condition": ModelSecurityConditionInput
}
Response
{
"data": {
"createSecurity": {
"id": "4",
"assetClassName": "abc123",
"code": "xyz789",
"description": "xyz789",
"exchange": "xyz789",
"msCode": "abc123",
"msNonFundCode": "xyz789",
"name": "xyz789",
"securityId": 123,
"securityType": "xyz789",
"securityGroup": "abc123",
"ticker": "abc123",
"createdAt": AWSDateTime,
"updatedAt": AWSDateTime
}
}
}
createSurveyResponseData
Response
Returns a SurveyResponseData
Arguments
| Name | Description |
|---|---|
input - CreateSurveyResponseDataInput!
|
|
condition - ModelSurveyResponseDataConditionInput
|
Example
Query
mutation CreateSurveyResponseData(
$input: CreateSurveyResponseDataInput!,
$condition: ModelSurveyResponseDataConditionInput
) {
createSurveyResponseData(
input: $input,
condition: $condition
) {
id
clientId
inviteCode
householdId
keyValueData
status
surveyId
progress
createdAt
updatedAt
}
}
Variables
{
"input": CreateSurveyResponseDataInput,
"condition": ModelSurveyResponseDataConditionInput
}
Response
{
"data": {
"createSurveyResponseData": {
"id": 4,
"clientId": 987,
"inviteCode": "abc123",
"householdId": 123,
"keyValueData": "abc123",
"status": "SENT",
"surveyId": "abc123",
"progress": 123.45,
"createdAt": AWSDateTime,
"updatedAt": AWSDateTime
}
}
}
createTamaracLoadErrors
Response
Returns a TamaracLoadErrors
Arguments
| Name | Description |
|---|---|
input - CreateTamaracLoadErrorsInput!
|
|
condition - ModelTamaracLoadErrorsConditionInput
|
Example
Query
mutation CreateTamaracLoadErrors(
$input: CreateTamaracLoadErrorsInput!,
$condition: ModelTamaracLoadErrorsConditionInput
) {
createTamaracLoadErrors(
input: $input,
condition: $condition
) {
id
sourceFile
errorMessage
tamaracPayload
accountId
accountNumber
primaryMemberFirstName
primaryMemberLastName
fuzzyRatio
rdsCombinedAddressString
tamaracCombinedAddressString
createdAt
updatedAt
}
}
Variables
{
"input": CreateTamaracLoadErrorsInput,
"condition": ModelTamaracLoadErrorsConditionInput
}
Response
{
"data": {
"createTamaracLoadErrors": {
"id": 4,
"sourceFile": "abc123",
"errorMessage": "xyz789",
"tamaracPayload": "xyz789",
"accountId": "xyz789",
"accountNumber": "xyz789",
"primaryMemberFirstName": "abc123",
"primaryMemberLastName": "xyz789",
"fuzzyRatio": "xyz789",
"rdsCombinedAddressString": "xyz789",
"tamaracCombinedAddressString": "xyz789",
"createdAt": AWSDateTime,
"updatedAt": AWSDateTime
}
}
}
createYourLifeSession
Response
Returns a YourLifeSession
Arguments
| Name | Description |
|---|---|
input - CreateYourLifeSessionInput!
|
|
condition - ModelYourLifeSessionConditionInput
|
Example
Query
mutation CreateYourLifeSession(
$input: CreateYourLifeSessionInput!,
$condition: ModelYourLifeSessionConditionInput
) {
createYourLifeSession(
input: $input,
condition: $condition
) {
id
clientId
inviteCode
householdId
status
firstName
lastName
fullName
hasPartner
partnerId
includeGoals
includeConnections
includeFinancialDetails
partnerFirstName
partnerLastName
partnerFullName
responses {
questionId
intResponse
stringResponse
}
lovedOnes
communityConnections
globalConnections
overallScore
emotionalScore
environmentalScore
spiritualScore
socialScore
educationScore
occupationalScore
physicalScore
financialScore
notes {
householdId
valueGroupId
note
}
createdAt
updatedAt
}
}
Variables
{
"input": CreateYourLifeSessionInput,
"condition": ModelYourLifeSessionConditionInput
}
Response
{
"data": {
"createYourLifeSession": {
"id": "4",
"clientId": 987,
"inviteCode": "xyz789",
"householdId": 123,
"status": "abc123",
"firstName": "abc123",
"lastName": "abc123",
"fullName": "abc123",
"hasPartner": true,
"partnerId": 123,
"includeGoals": true,
"includeConnections": false,
"includeFinancialDetails": true,
"partnerFirstName": "abc123",
"partnerLastName": "xyz789",
"partnerFullName": "abc123",
"responses": [LifeResponse],
"lovedOnes": ["xyz789"],
"communityConnections": ["abc123"],
"globalConnections": ["abc123"],
"overallScore": 123.45,
"emotionalScore": 123.45,
"environmentalScore": 123.45,
"spiritualScore": 123.45,
"socialScore": 987.65,
"educationScore": 123.45,
"occupationalScore": 123.45,
"physicalScore": 987.65,
"financialScore": 123.45,
"notes": [LifeNote],
"createdAt": AWSDateTime,
"updatedAt": AWSDateTime
}
}
}
createYourLifeSurvey
Response
Returns a String
Arguments
| Name | Description |
|---|---|
args - CreateYourLifeSurveyInput!
|
Example
Query
mutation CreateYourLifeSurvey($args: CreateYourLifeSurveyInput!) {
createYourLifeSurvey(args: $args)
}
Variables
{"args": CreateYourLifeSurveyInput}
Response
{"data": {"createYourLifeSurvey": "xyz789"}}
createYourValuesSession
Response
Returns a YourValuesSession
Arguments
| Name | Description |
|---|---|
input - CreateYourValuesSessionInput!
|
|
condition - ModelYourValuesSessionConditionInput
|
Example
Query
mutation CreateYourValuesSession(
$input: CreateYourValuesSessionInput!,
$condition: ModelYourValuesSessionConditionInput
) {
createYourValuesSession(
input: $input,
condition: $condition
) {
id
clientId
inviteCode
partnerId
partnerInviteCode
client {
clientId
regrets
values {
cardId
rank
meaningReason
progressAction
progress
}
step
lastSeen
individualValuesCompleted
}
partner {
clientId
regrets
values {
cardId
rank
meaningReason
progressAction
progress
}
step
lastSeen
individualValuesCompleted
}
adviser {
staffId
step
lastSeen
}
support {
staffId
step
lastSeen
}
alignedValues {
cardId
clientId
rank
notes
progress
description
nextSteps {
id
title
notes
assignedToClientId
created
}
householdMemberProgress {
description
progress
clientId
}
}
valuesInc3Things
partnerValuesInc3Things
individualValuesOnly
step
lastSeen
createdAt
updatedAt
}
}
Variables
{
"input": CreateYourValuesSessionInput,
"condition": ModelYourValuesSessionConditionInput
}
Response
{
"data": {
"createYourValuesSession": {
"id": "4",
"clientId": 987,
"inviteCode": "xyz789",
"partnerId": 987,
"partnerInviteCode": "xyz789",
"client": ValuesClient,
"partner": ValuesClient,
"adviser": ValuesStaff,
"support": ValuesStaff,
"alignedValues": [ValuesAlignedValue],
"valuesInc3Things": false,
"partnerValuesInc3Things": false,
"individualValuesOnly": true,
"step": "xyz789",
"lastSeen": "abc123",
"createdAt": AWSDateTime,
"updatedAt": AWSDateTime
}
}
}
deactivateStaff
Response
Returns a DeactivateStaffOutput
Arguments
| Name | Description |
|---|---|
args - DeactivateStaffInput!
|
Example
Query
mutation DeactivateStaff($args: DeactivateStaffInput!) {
deactivateStaff(args: $args) {
updateMsg
}
}
Variables
{"args": DeactivateStaffInput}
Response
{
"data": {
"deactivateStaff": {
"updateMsg": "abc123"
}
}
}
deleteAllProfileImages
Response
Returns a DeleteProfileImageOutput
Example
Query
mutation DeleteAllProfileImages {
deleteAllProfileImages {
code
message
}
}
Response
{
"data": {
"deleteAllProfileImages": {
"code": 123,
"message": "abc123"
}
}
}
deleteAsset
Response
Returns a Boolean
Arguments
| Name | Description |
|---|---|
args - DeleteAssetInput!
|
Example
Query
mutation DeleteAsset($args: DeleteAssetInput!) {
deleteAsset(args: $args)
}
Variables
{"args": DeleteAssetInput}
Response
{"data": {"deleteAsset": false}}
deleteBeneficiary
Response
Returns a Boolean
Arguments
| Name | Description |
|---|---|
args - DeleteBeneficiaryInput!
|
Example
Query
mutation DeleteBeneficiary($args: DeleteBeneficiaryInput!) {
deleteBeneficiary(args: $args)
}
Variables
{"args": DeleteBeneficiaryInput}
Response
{"data": {"deleteBeneficiary": false}}
deleteBestLifeScenario
Response
Returns a Boolean
Arguments
| Name | Description |
|---|---|
args - DeleteBestLifeScenarioInput
|
Example
Query
mutation DeleteBestLifeScenario($args: DeleteBestLifeScenarioInput) {
deleteBestLifeScenario(args: $args)
}
Variables
{"args": DeleteBestLifeScenarioInput}
Response
{"data": {"deleteBestLifeScenario": true}}
deleteBusinessPlanning
Response
Returns a Boolean
Arguments
| Name | Description |
|---|---|
args - DeleteBusinessPlanningInput!
|
Example
Query
mutation DeleteBusinessPlanning($args: DeleteBusinessPlanningInput!) {
deleteBusinessPlanning(args: $args)
}
Variables
{"args": DeleteBusinessPlanningInput}
Response
{"data": {"deleteBusinessPlanning": true}}
deleteCharitablePlanning
Response
Returns a Boolean
Arguments
| Name | Description |
|---|---|
args - DeleteCharitablePlanningInput!
|
Example
Query
mutation DeleteCharitablePlanning($args: DeleteCharitablePlanningInput!) {
deleteCharitablePlanning(args: $args)
}
Variables
{"args": DeleteCharitablePlanningInput}
Response
{"data": {"deleteCharitablePlanning": false}}
deleteClient
Response
Returns a Boolean
Arguments
| Name | Description |
|---|---|
args - DeleteClientInput!
|
Example
Query
mutation DeleteClient($args: DeleteClientInput!) {
deleteClient(args: $args)
}
Variables
{"args": DeleteClientInput}
Response
{"data": {"deleteClient": false}}
deleteClientWealthId
Response
Returns a Boolean
Arguments
| Name | Description |
|---|---|
args - DeleteClientWealthIdInput!
|
Example
Query
mutation DeleteClientWealthId($args: DeleteClientWealthIdInput!) {
deleteClientWealthId(args: $args)
}
Variables
{"args": DeleteClientWealthIdInput}
Response
{"data": {"deleteClientWealthId": true}}
deleteClientWealthIds
Response
Returns a Boolean
Arguments
| Name | Description |
|---|---|
args - DeleteClientWealthIdsInput!
|
Example
Query
mutation DeleteClientWealthIds($args: DeleteClientWealthIdsInput!) {
deleteClientWealthIds(args: $args)
}
Variables
{"args": DeleteClientWealthIdsInput}
Response
{"data": {"deleteClientWealthIds": false}}
deleteDirector
Response
Returns a Boolean
Arguments
| Name | Description |
|---|---|
args - DeleteDirectorInput!
|
Example
Query
mutation DeleteDirector($args: DeleteDirectorInput!) {
deleteDirector(args: $args)
}
Variables
{"args": DeleteDirectorInput}
Response
{"data": {"deleteDirector": false}}
deleteEducationPlanning
Response
Returns a Boolean
Arguments
| Name | Description |
|---|---|
args - DeleteEducationPlanningInput!
|
Example
Query
mutation DeleteEducationPlanning($args: DeleteEducationPlanningInput!) {
deleteEducationPlanning(args: $args)
}
Variables
{"args": DeleteEducationPlanningInput}
Response
{"data": {"deleteEducationPlanning": false}}
deleteEmploymentDetails
Response
Returns a Boolean
Arguments
| Name | Description |
|---|---|
args - DeleteEmploymentDetailsInput!
|
Example
Query
mutation DeleteEmploymentDetails($args: DeleteEmploymentDetailsInput!) {
deleteEmploymentDetails(args: $args)
}
Variables
{"args": DeleteEmploymentDetailsInput}
Response
{"data": {"deleteEmploymentDetails": true}}
deleteEstatePlanning
Response
Returns a Boolean
Arguments
| Name | Description |
|---|---|
args - DeleteEstatePlanningInput!
|
Example
Query
mutation DeleteEstatePlanning($args: DeleteEstatePlanningInput!) {
deleteEstatePlanning(args: $args)
}
Variables
{"args": DeleteEstatePlanningInput}
Response
{"data": {"deleteEstatePlanning": false}}
deleteExecutor
Response
Returns a Boolean
Arguments
| Name | Description |
|---|---|
args - DeleteExecutorInput!
|
Example
Query
mutation DeleteExecutor($args: DeleteExecutorInput!) {
deleteExecutor(args: $args)
}
Variables
{"args": DeleteExecutorInput}
Response
{"data": {"deleteExecutor": false}}
deleteExpense
Response
Returns a Boolean
Arguments
| Name | Description |
|---|---|
args - DeleteExpenseInput!
|
Example
Query
mutation DeleteExpense($args: DeleteExpenseInput!) {
deleteExpense(args: $args)
}
Variables
{"args": DeleteExpenseInput}
Response
{"data": {"deleteExpense": false}}
deleteExternalUploadTracking
Response
Returns an ExternalUploadTracking
Arguments
| Name | Description |
|---|---|
input - DeleteExternalUploadTrackingInput!
|
|
condition - ModelExternalUploadTrackingConditionInput
|
Example
Query
mutation DeleteExternalUploadTracking(
$input: DeleteExternalUploadTrackingInput!,
$condition: ModelExternalUploadTrackingConditionInput
) {
deleteExternalUploadTracking(
input: $input,
condition: $condition
) {
id
fullS3ObjectPath
identityId
objectKey
practiceId
clientId
goalId
createdAt
updatedAt
}
}
Variables
{
"input": DeleteExternalUploadTrackingInput,
"condition": ModelExternalUploadTrackingConditionInput
}
Response
{
"data": {
"deleteExternalUploadTracking": {
"id": 4,
"fullS3ObjectPath": "xyz789",
"identityId": "abc123",
"objectKey": "xyz789",
"practiceId": 123,
"clientId": 987,
"goalId": 123,
"createdAt": AWSDateTime,
"updatedAt": AWSDateTime
}
}
}
deleteFinancialHealthAssessmentSession
Response
Returns a FinancialHealthAssessmentSession
Arguments
| Name | Description |
|---|---|
input - DeleteFinancialHealthAssessmentSessionInput!
|
|
condition - ModelFinancialHealthAssessmentSessionConditionInput
|
Example
Query
mutation DeleteFinancialHealthAssessmentSession(
$input: DeleteFinancialHealthAssessmentSessionInput!,
$condition: ModelFinancialHealthAssessmentSessionConditionInput
) {
deleteFinancialHealthAssessmentSession(
input: $input,
condition: $condition
) {
id
clientId
inviteCode
householdId
status
firstName
lastName
fullName
hasPartner
partnerId
partnerFirstName
partnerLastName
partnerFullName
finHealthAssessmentFull
responses {
questionId
intResponse
stringResponse
section
}
visionGoalsScore
retirementPlanningScore
insuranceAssetProtectionScore
debtCashFlowManagementScore
educationPlanningScore
investmentPlanningScore
incomeTaxPlanningScore
businessPlanningScore
charitablePlanningScore
estatePlanningScore
createdAt
updatedAt
}
}
Variables
{
"input": DeleteFinancialHealthAssessmentSessionInput,
"condition": ModelFinancialHealthAssessmentSessionConditionInput
}
Response
{
"data": {
"deleteFinancialHealthAssessmentSession": {
"id": 4,
"clientId": 123,
"inviteCode": "xyz789",
"householdId": 987,
"status": "abc123",
"firstName": "abc123",
"lastName": "xyz789",
"fullName": "xyz789",
"hasPartner": false,
"partnerId": 987,
"partnerFirstName": "abc123",
"partnerLastName": "abc123",
"partnerFullName": "xyz789",
"finHealthAssessmentFull": false,
"responses": [FHAResponse],
"visionGoalsScore": 123,
"retirementPlanningScore": 123,
"insuranceAssetProtectionScore": 987,
"debtCashFlowManagementScore": 987,
"educationPlanningScore": 987,
"investmentPlanningScore": 987,
"incomeTaxPlanningScore": 987,
"businessPlanningScore": 987,
"charitablePlanningScore": 987,
"estatePlanningScore": 987,
"createdAt": AWSDateTime,
"updatedAt": AWSDateTime
}
}
}
deleteGoal
Response
Returns an Int
Arguments
| Name | Description |
|---|---|
args - DeleteGoalInput
|
Example
Query
mutation DeleteGoal($args: DeleteGoalInput) {
deleteGoal(args: $args)
}
Variables
{"args": DeleteGoalInput}
Response
{"data": {"deleteGoal": 123}}
deleteGoalsSession
Response
Returns a GoalsSession
Arguments
| Name | Description |
|---|---|
input - DeleteGoalsSessionInput!
|
|
condition - ModelGoalsSessionConditionInput
|
Example
Query
mutation DeleteGoalsSession(
$input: DeleteGoalsSessionInput!,
$condition: ModelGoalsSessionConditionInput
) {
deleteGoalsSession(
input: $input,
condition: $condition
) {
id
clientId
inviteCode
selectedGoalCategoryIds
createdAt
updatedAt
}
}
Variables
{
"input": DeleteGoalsSessionInput,
"condition": ModelGoalsSessionConditionInput
}
Response
{
"data": {
"deleteGoalsSession": {
"id": 4,
"clientId": 987,
"inviteCode": "abc123",
"selectedGoalCategoryIds": [987],
"createdAt": AWSDateTime,
"updatedAt": AWSDateTime
}
}
}
deleteHealthDetails
Response
Returns a Boolean
Arguments
| Name | Description |
|---|---|
args - DeleteHealthDetailsInput!
|
Example
Query
mutation DeleteHealthDetails($args: DeleteHealthDetailsInput!) {
deleteHealthDetails(args: $args)
}
Variables
{"args": DeleteHealthDetailsInput}
Response
{"data": {"deleteHealthDetails": true}}
deleteHolding
Response
Returns a Boolean
Arguments
| Name | Description |
|---|---|
args - DeleteHoldingInput!
|
Example
Query
mutation DeleteHolding($args: DeleteHoldingInput!) {
deleteHolding(args: $args)
}
Variables
{"args": DeleteHoldingInput}
Response
{"data": {"deleteHolding": false}}
deleteHouseholdKeyAdviceArea
Response
Returns a Boolean
Arguments
| Name | Description |
|---|---|
args - DeleteHouseholdKeyAdviceAreaInput
|
Example
Query
mutation DeleteHouseholdKeyAdviceArea($args: DeleteHouseholdKeyAdviceAreaInput) {
deleteHouseholdKeyAdviceArea(args: $args)
}
Variables
{"args": DeleteHouseholdKeyAdviceAreaInput}
Response
{"data": {"deleteHouseholdKeyAdviceArea": true}}
deleteHouseholdMember
Response
Returns a Boolean
Arguments
| Name | Description |
|---|---|
args - DeleteHouseholdMemberInput!
|
Example
Query
mutation DeleteHouseholdMember($args: DeleteHouseholdMemberInput!) {
deleteHouseholdMember(args: $args)
}
Variables
{"args": DeleteHouseholdMemberInput}
Response
{"data": {"deleteHouseholdMember": true}}
deleteHouseholdStrategy
Response
Returns a Boolean
Arguments
| Name | Description |
|---|---|
args - DeleteHouseholdStrategyInput
|
Example
Query
mutation DeleteHouseholdStrategy($args: DeleteHouseholdStrategyInput) {
deleteHouseholdStrategy(args: $args)
}
Variables
{"args": DeleteHouseholdStrategyInput}
Response
{"data": {"deleteHouseholdStrategy": false}}
deleteIncome
Response
Returns a Boolean
Arguments
| Name | Description |
|---|---|
args - DeleteIncomeInput!
|
Example
Query
mutation DeleteIncome($args: DeleteIncomeInput!) {
deleteIncome(args: $args)
}
Variables
{"args": DeleteIncomeInput}
Response
{"data": {"deleteIncome": true}}
deleteInsurance
Response
Returns a Boolean
Arguments
| Name | Description |
|---|---|
args - DeleteInsuranceInput!
|
Example
Query
mutation DeleteInsurance($args: DeleteInsuranceInput!) {
deleteInsurance(args: $args)
}
Variables
{"args": DeleteInsuranceInput}
Response
{"data": {"deleteInsurance": true}}
deleteInvestmentPreferencesSession
Response
Returns an InvestmentPreferencesSession
Arguments
| Name | Description |
|---|---|
input - DeleteInvestmentPreferencesSessionInput!
|
|
condition - ModelInvestmentPreferencesSessionConditionInput
|
Example
Query
mutation DeleteInvestmentPreferencesSession(
$input: DeleteInvestmentPreferencesSessionInput!,
$condition: ModelInvestmentPreferencesSessionConditionInput
) {
deleteInvestmentPreferencesSession(
input: $input,
condition: $condition
) {
id
clientId
inviteCode
fullName
status
introVideo
customisationVideo
customisation
ethicalVideo
ethical
assetClassVideo
allocationVideo
allocationType
riskVideo
comfortableWithDownturn
costVideo
costDriven
prioritisation {
optionId
rank
}
comments
customisationVideoHelp
customisationVideoComments
ethicalVideoHelp
ethicalVideoComments
assetClassVideoHelp
assetClassVideoComments
allocationVideoHelp
allocationVideoComments
riskVideoHelp
riskVideoComments
riskDiversification
riskMarketCorrection
riskPercentageDrop
riskCapitalProtection
riskAccessCapital
riskInfluencedByReturns
riskIncreaseToMeetGoal
riskMaxDownside
riskInflation
costVideoHelp
costVideoComments
assetClassAndDiversificationVideoHelp
assetClassPreferences
assetClassPreferencesComments
assetClassRisk
assetClassRiskComments
ethicalPreferences
ethicalPreferencesComments
activePassiveVideoHelp
costWealthPriorities
riskVolatilityVideoHelp
riskTimelines
riskExperience
riskKnowledge
riskPast
riskCurrent
riskTimeframe
riskVariability
riskVolatility
riskReaction
riskTolerance
riskFuture
includeRiskSection
includeIntroSection
includeCustomisationSection
includeEthicalSection
includeAssetClassSection
includeAllocationSection
includeCostSection
includePrioritisationSection
includeCommentsSection
createdAt
updatedAt
}
}
Variables
{
"input": DeleteInvestmentPreferencesSessionInput,
"condition": ModelInvestmentPreferencesSessionConditionInput
}
Response
{
"data": {
"deleteInvestmentPreferencesSession": {
"id": 4,
"clientId": 987,
"inviteCode": "xyz789",
"fullName": "abc123",
"status": "xyz789",
"introVideo": "xyz789",
"customisationVideo": "abc123",
"customisation": "Y",
"ethicalVideo": "abc123",
"ethical": "Y",
"assetClassVideo": "xyz789",
"allocationVideo": "abc123",
"allocationType": "S",
"riskVideo": "abc123",
"comfortableWithDownturn": "abc123",
"costVideo": "xyz789",
"costDriven": "Y",
"prioritisation": [InvestmentPreferencesRanking],
"comments": "xyz789",
"customisationVideoHelp": "Y",
"customisationVideoComments": "abc123",
"ethicalVideoHelp": "Y",
"ethicalVideoComments": "abc123",
"assetClassVideoHelp": "Y",
"assetClassVideoComments": "abc123",
"allocationVideoHelp": "Y",
"allocationVideoComments": "abc123",
"riskVideoHelp": "Y",
"riskVideoComments": "abc123",
"riskDiversification": 123,
"riskMarketCorrection": 987,
"riskPercentageDrop": 987,
"riskCapitalProtection": "Y",
"riskAccessCapital": 987,
"riskInfluencedByReturns": 123,
"riskIncreaseToMeetGoal": 123,
"riskMaxDownside": 123,
"riskInflation": 987,
"costVideoHelp": "Y",
"costVideoComments": "xyz789",
"assetClassAndDiversificationVideoHelp": "Y",
"assetClassPreferences": "Y",
"assetClassPreferencesComments": "abc123",
"assetClassRisk": "Y",
"assetClassRiskComments": "xyz789",
"ethicalPreferences": "Y",
"ethicalPreferencesComments": "abc123",
"activePassiveVideoHelp": "Y",
"costWealthPriorities": "A",
"riskVolatilityVideoHelp": "Y",
"riskTimelines": "Y",
"riskExperience": 987,
"riskKnowledge": 123,
"riskPast": 123,
"riskCurrent": 987,
"riskTimeframe": 123,
"riskVariability": 987,
"riskVolatility": 987,
"riskReaction": 987,
"riskTolerance": 123,
"riskFuture": 123,
"includeRiskSection": true,
"includeIntroSection": false,
"includeCustomisationSection": true,
"includeEthicalSection": true,
"includeAssetClassSection": true,
"includeAllocationSection": false,
"includeCostSection": false,
"includePrioritisationSection": true,
"includeCommentsSection": true,
"createdAt": AWSDateTime,
"updatedAt": AWSDateTime
}
}
}
deleteLegalEntity
Response
Returns a Boolean
Arguments
| Name | Description |
|---|---|
args - DeleteLegalEntityInput!
|
Example
Query
mutation DeleteLegalEntity($args: DeleteLegalEntityInput!) {
deleteLegalEntity(args: $args)
}
Variables
{"args": DeleteLegalEntityInput}
Response
{"data": {"deleteLegalEntity": true}}
deleteLiability
Response
Returns a Boolean
Arguments
| Name | Description |
|---|---|
args - DeleteLiabilityInput!
|
Example
Query
mutation DeleteLiability($args: DeleteLiabilityInput!) {
deleteLiability(args: $args)
}
Variables
{"args": DeleteLiabilityInput}
Response
{"data": {"deleteLiability": false}}
deleteLifeNote
Response
Returns a Boolean
Arguments
| Name | Description |
|---|---|
args - LifeNoteInput!
|
Example
Query
mutation DeleteLifeNote($args: LifeNoteInput!) {
deleteLifeNote(args: $args)
}
Variables
{"args": LifeNoteInput}
Response
{"data": {"deleteLifeNote": true}}
deleteLivingDiscretionaryExpense
Response
Returns a Boolean
Arguments
| Name | Description |
|---|---|
args - DeleteLivingDiscretionaryExpenseInput!
|
Example
Query
mutation DeleteLivingDiscretionaryExpense($args: DeleteLivingDiscretionaryExpenseInput!) {
deleteLivingDiscretionaryExpense(args: $args)
}
Variables
{"args": DeleteLivingDiscretionaryExpenseInput}
Response
{"data": {"deleteLivingDiscretionaryExpense": true}}
deleteNotification
Response
Returns a Notification
Arguments
| Name | Description |
|---|---|
input - DeleteNotificationInput!
|
|
condition - ModelNotificationConditionInput
|
Example
Query
mutation DeleteNotification(
$input: DeleteNotificationInput!,
$condition: ModelNotificationConditionInput
) {
deleteNotification(
input: $input,
condition: $condition
) {
id
owner
recipient
message
messageRead
createdAt
updatedAt
}
}
Variables
{
"input": DeleteNotificationInput,
"condition": ModelNotificationConditionInput
}
Response
{
"data": {
"deleteNotification": {
"id": "4",
"owner": "abc123",
"recipient": "xyz789",
"message": "abc123",
"messageRead": false,
"createdAt": AWSDateTime,
"updatedAt": AWSDateTime
}
}
}
deleteNotificationPointer
Response
Returns a NotificationPointer
Arguments
| Name | Description |
|---|---|
input - DeleteNotificationPointerInput!
|
|
condition - ModelNotificationPointerConditionInput
|
Example
Query
mutation DeleteNotificationPointer(
$input: DeleteNotificationPointerInput!,
$condition: ModelNotificationPointerConditionInput
) {
deleteNotificationPointer(
input: $input,
condition: $condition
) {
id
owner
recipient
notificationId
createdAt
updatedAt
}
}
Variables
{
"input": DeleteNotificationPointerInput,
"condition": ModelNotificationPointerConditionInput
}
Response
{
"data": {
"deleteNotificationPointer": {
"id": "4",
"owner": "abc123",
"recipient": "xyz789",
"notificationId": "abc123",
"createdAt": AWSDateTime,
"updatedAt": AWSDateTime
}
}
}
deleteOriginationSession
Response
Returns an OriginationSession
Arguments
| Name | Description |
|---|---|
input - DeleteOriginationSessionInput!
|
|
condition - ModelOriginationSessionConditionInput
|
Example
Query
mutation DeleteOriginationSession(
$input: DeleteOriginationSessionInput!,
$condition: ModelOriginationSessionConditionInput
) {
deleteOriginationSession(
input: $input,
condition: $condition
) {
id
clientId
inviteCode
householdId
status
clientFirstName
clientLastName
clientFullName
hasPartner
partnerId
partnerFirstName
partnerLastName
partnerFullName
questionnaires
lifeIncGoals
lifeIncConnections
lifeIncFinancialDetails
finHealthAssessmentFull
foundationsFull
valuesInc3Things
governanceIncPersonalDetails
governanceIncAssetsLiabilitiesIncomeExpenses
governanceIncInsurance
governanceIncBusinessPlanning
governanceIncEducationPlanning
governanceIncCharitablePlanning
governanceIncTaxPlanning
governanceIncEstatePlanning
investmentPreferencesIncRiskSection
investmentPreferencesIncIntroSection
investmentPreferencesIncCustomisationSection
investmentPreferencesIncEthicalSection
investmentPreferencesIncAssetClassSection
investmentPreferencesIncAllocationSection
investmentPreferencesIncCostSection
investmentPreferencesIncPrioritisationSection
investmentPreferencesIncCommentsSection
uploadFileList {
prefix
folder
fileName
share
}
uploadIdentity
stepTracker {
questionId
sectionId
questionnaireStep
questionnaire
}
completedQuestionnaires
failedQuestionnaires
createdAt
updatedAt
}
}
Variables
{
"input": DeleteOriginationSessionInput,
"condition": ModelOriginationSessionConditionInput
}
Response
{
"data": {
"deleteOriginationSession": {
"id": 4,
"clientId": 987,
"inviteCode": "abc123",
"householdId": 987,
"status": "abc123",
"clientFirstName": "xyz789",
"clientLastName": "xyz789",
"clientFullName": "xyz789",
"hasPartner": true,
"partnerId": 987,
"partnerFirstName": "xyz789",
"partnerLastName": "xyz789",
"partnerFullName": "xyz789",
"questionnaires": ["LIFE"],
"lifeIncGoals": false,
"lifeIncConnections": true,
"lifeIncFinancialDetails": false,
"finHealthAssessmentFull": true,
"foundationsFull": true,
"valuesInc3Things": true,
"governanceIncPersonalDetails": true,
"governanceIncAssetsLiabilitiesIncomeExpenses": false,
"governanceIncInsurance": false,
"governanceIncBusinessPlanning": true,
"governanceIncEducationPlanning": false,
"governanceIncCharitablePlanning": true,
"governanceIncTaxPlanning": false,
"governanceIncEstatePlanning": false,
"investmentPreferencesIncRiskSection": false,
"investmentPreferencesIncIntroSection": true,
"investmentPreferencesIncCustomisationSection": false,
"investmentPreferencesIncEthicalSection": false,
"investmentPreferencesIncAssetClassSection": true,
"investmentPreferencesIncAllocationSection": true,
"investmentPreferencesIncCostSection": true,
"investmentPreferencesIncPrioritisationSection": true,
"investmentPreferencesIncCommentsSection": true,
"uploadFileList": [UploadVaultFileInfo],
"uploadIdentity": "xyz789",
"stepTracker": StepTracker,
"completedQuestionnaires": ["LIFE"],
"failedQuestionnaires": ["LIFE"],
"createdAt": AWSDateTime,
"updatedAt": AWSDateTime
}
}
}
deletePortfolio
Response
Returns a Boolean
Arguments
| Name | Description |
|---|---|
args - DeletePortfolioInput!
|
Example
Query
mutation DeletePortfolio($args: DeletePortfolioInput!) {
deletePortfolio(args: $args)
}
Variables
{"args": DeletePortfolioInput}
Response
{"data": {"deletePortfolio": false}}
deletePowerOf
Response
Returns a Boolean
Arguments
| Name | Description |
|---|---|
args - DeletePowerOfInput!
|
Example
Query
mutation DeletePowerOf($args: DeletePowerOfInput!) {
deletePowerOf(args: $args)
}
Variables
{"args": DeletePowerOfInput}
Response
{"data": {"deletePowerOf": false}}
deletePracticeAssetAllocations
Response
Returns a Boolean
Arguments
| Name | Description |
|---|---|
args - DeletePracticeAssetAllocationsInput
|
Example
Query
mutation DeletePracticeAssetAllocations($args: DeletePracticeAssetAllocationsInput) {
deletePracticeAssetAllocations(args: $args)
}
Variables
{"args": DeletePracticeAssetAllocationsInput}
Response
{"data": {"deletePracticeAssetAllocations": false}}
deletePracticeConfigVaultFolder
Response
Returns a VaultFolder
Arguments
| Name | Description |
|---|---|
args - DeleteVaultFolderInput!
|
Example
Query
mutation DeletePracticeConfigVaultFolder($args: DeleteVaultFolderInput!) {
deletePracticeConfigVaultFolder(args: $args) {
id
name
order
enabled
readonly
}
}
Variables
{"args": DeleteVaultFolderInput}
Response
{
"data": {
"deletePracticeConfigVaultFolder": {
"id": "xyz789",
"name": "abc123",
"order": 987,
"enabled": false,
"readonly": false
}
}
}
deletePracticeIntegration
Response
Returns a Boolean
Arguments
| Name | Description |
|---|---|
args - DeletePracticeIntegrationInput
|
Example
Query
mutation DeletePracticeIntegration($args: DeletePracticeIntegrationInput) {
deletePracticeIntegration(args: $args)
}
Variables
{"args": DeletePracticeIntegrationInput}
Response
{"data": {"deletePracticeIntegration": true}}
deletePracticeKeyAdviceArea
Response
Returns a Boolean
Arguments
| Name | Description |
|---|---|
args - DeletePracticeKeyAdviceAreaInput
|
Example
Query
mutation DeletePracticeKeyAdviceArea($args: DeletePracticeKeyAdviceAreaInput) {
deletePracticeKeyAdviceArea(args: $args)
}
Variables
{"args": DeletePracticeKeyAdviceAreaInput}
Response
{"data": {"deletePracticeKeyAdviceArea": true}}
deletePracticeRiskProfile
Response
Returns a Boolean
Arguments
| Name | Description |
|---|---|
args - DeletePracticeRiskProfileInput
|
Example
Query
mutation DeletePracticeRiskProfile($args: DeletePracticeRiskProfileInput) {
deletePracticeRiskProfile(args: $args)
}
Variables
{"args": DeletePracticeRiskProfileInput}
Response
{"data": {"deletePracticeRiskProfile": true}}
deletePracticeSegmentation
Response
Returns a Boolean
Arguments
| Name | Description |
|---|---|
args - DeletePracticeSegmentationInput
|
Example
Query
mutation DeletePracticeSegmentation($args: DeletePracticeSegmentationInput) {
deletePracticeSegmentation(args: $args)
}
Variables
{"args": DeletePracticeSegmentationInput}
Response
{"data": {"deletePracticeSegmentation": false}}
deletePracticeStrategy
Response
Returns a Boolean
Arguments
| Name | Description |
|---|---|
args - DeletePracticeStrategyInput
|
Example
Query
mutation DeletePracticeStrategy($args: DeletePracticeStrategyInput) {
deletePracticeStrategy(args: $args)
}
Variables
{"args": DeletePracticeStrategyInput}
Response
{"data": {"deletePracticeStrategy": true}}
deletePresignedUrlFile
Response
Returns a Boolean
Arguments
| Name | Description |
|---|---|
args - DeletePresignedUrlFileInput!
|
Example
Query
mutation DeletePresignedUrlFile($args: DeletePresignedUrlFileInput!) {
deletePresignedUrlFile(args: $args)
}
Variables
{"args": DeletePresignedUrlFileInput}
Response
{"data": {"deletePresignedUrlFile": true}}
deleteProfessionalContact
Response
Returns a Boolean
Arguments
| Name | Description |
|---|---|
args - DeleteProfessionalContactInput!
|
Example
Query
mutation DeleteProfessionalContact($args: DeleteProfessionalContactInput!) {
deleteProfessionalContact(args: $args)
}
Variables
{"args": DeleteProfessionalContactInput}
Response
{"data": {"deleteProfessionalContact": true}}
deleteProfileImage
Response
Returns a DeleteProfileImageOutput
Arguments
| Name | Description |
|---|---|
args - DeleteProfileImageInput
|
Example
Query
mutation DeleteProfileImage($args: DeleteProfileImageInput) {
deleteProfileImage(args: $args) {
code
message
}
}
Variables
{"args": DeleteProfileImageInput}
Response
{
"data": {
"deleteProfileImage": {
"code": 123,
"message": "abc123"
}
}
}
deleteQuickSurvey
Response
Returns a Boolean
Arguments
| Name | Description |
|---|---|
args - DeleteQuickSurveyInput
|
Example
Query
mutation DeleteQuickSurvey($args: DeleteQuickSurveyInput) {
deleteQuickSurvey(args: $args)
}
Variables
{"args": DeleteQuickSurveyInput}
Response
{"data": {"deleteQuickSurvey": false}}
deleteRedtailLoadErrors
Response
Returns a RedtailLoadErrors
Arguments
| Name | Description |
|---|---|
input - DeleteRedtailLoadErrorsInput!
|
|
condition - ModelRedtailLoadErrorsConditionInput
|
Example
Query
mutation DeleteRedtailLoadErrors(
$input: DeleteRedtailLoadErrorsInput!,
$condition: ModelRedtailLoadErrorsConditionInput
) {
deleteRedtailLoadErrors(
input: $input,
condition: $condition
) {
id
errorMessage
redtailPayload
createdAt
updatedAt
}
}
Variables
{
"input": DeleteRedtailLoadErrorsInput,
"condition": ModelRedtailLoadErrorsConditionInput
}
Response
{
"data": {
"deleteRedtailLoadErrors": {
"id": 4,
"errorMessage": "xyz789",
"redtailPayload": "abc123",
"createdAt": AWSDateTime,
"updatedAt": AWSDateTime
}
}
}
deleteRegistration
Response
Returns a Registration
Arguments
| Name | Description |
|---|---|
input - DeleteRegistrationInput!
|
|
condition - ModelRegistrationConditionInput
|
Example
Query
mutation DeleteRegistration(
$input: DeleteRegistrationInput!,
$condition: ModelRegistrationConditionInput
) {
deleteRegistration(
input: $input,
condition: $condition
) {
id
clientId
inviteCode
fullName
createdAt
updatedAt
}
}
Variables
{
"input": DeleteRegistrationInput,
"condition": ModelRegistrationConditionInput
}
Response
{
"data": {
"deleteRegistration": {
"id": 4,
"clientId": 987,
"inviteCode": "xyz789",
"fullName": "abc123",
"createdAt": AWSDateTime,
"updatedAt": AWSDateTime
}
}
}
deleteRetirementDetails
Response
Returns a Boolean
Arguments
| Name | Description |
|---|---|
args - DeleteRetirementDetailsInput!
|
Example
Query
mutation DeleteRetirementDetails($args: DeleteRetirementDetailsInput!) {
deleteRetirementDetails(args: $args)
}
Variables
{"args": DeleteRetirementDetailsInput}
Response
{"data": {"deleteRetirementDetails": true}}
deleteRiskProfile
Response
Returns a Boolean
Arguments
| Name | Description |
|---|---|
args - DeleteRiskProfileInput!
|
Example
Query
mutation DeleteRiskProfile($args: DeleteRiskProfileInput!) {
deleteRiskProfile(args: $args)
}
Variables
{"args": DeleteRiskProfileInput}
Response
{"data": {"deleteRiskProfile": false}}
deleteScenario
Response
Returns a Boolean
Arguments
| Name | Description |
|---|---|
args - DeleteScenarioInput
|
Example
Query
mutation DeleteScenario($args: DeleteScenarioInput) {
deleteScenario(args: $args)
}
Variables
{"args": DeleteScenarioInput}
Response
{"data": {"deleteScenario": false}}
deleteSecurity
Response
Returns a Security
Arguments
| Name | Description |
|---|---|
input - DeleteSecurityInput!
|
|
condition - ModelSecurityConditionInput
|
Example
Query
mutation DeleteSecurity(
$input: DeleteSecurityInput!,
$condition: ModelSecurityConditionInput
) {
deleteSecurity(
input: $input,
condition: $condition
) {
id
assetClassName
code
description
exchange
msCode
msNonFundCode
name
securityId
securityType
securityGroup
ticker
createdAt
updatedAt
}
}
Variables
{
"input": DeleteSecurityInput,
"condition": ModelSecurityConditionInput
}
Response
{
"data": {
"deleteSecurity": {
"id": "4",
"assetClassName": "abc123",
"code": "abc123",
"description": "xyz789",
"exchange": "xyz789",
"msCode": "abc123",
"msNonFundCode": "xyz789",
"name": "xyz789",
"securityId": 123,
"securityType": "xyz789",
"securityGroup": "xyz789",
"ticker": "xyz789",
"createdAt": AWSDateTime,
"updatedAt": AWSDateTime
}
}
}
deleteSensitiveDetails
Response
Returns a Boolean
Arguments
| Name | Description |
|---|---|
args - DeleteSensitiveDetailsInput!
|
Example
Query
mutation DeleteSensitiveDetails($args: DeleteSensitiveDetailsInput!) {
deleteSensitiveDetails(args: $args)
}
Variables
{"args": DeleteSensitiveDetailsInput}
Response
{"data": {"deleteSensitiveDetails": false}}
deleteSuperBeneficiary
Response
Returns a Boolean
Arguments
| Name | Description |
|---|---|
args - DeleteSuperBeneficiaryInput!
|
Example
Query
mutation DeleteSuperBeneficiary($args: DeleteSuperBeneficiaryInput!) {
deleteSuperBeneficiary(args: $args)
}
Variables
{"args": DeleteSuperBeneficiaryInput}
Response
{"data": {"deleteSuperBeneficiary": true}}
deleteSurveyResponseData
Response
Returns a SurveyResponseData
Arguments
| Name | Description |
|---|---|
input - DeleteSurveyResponseDataInput!
|
|
condition - ModelSurveyResponseDataConditionInput
|
Example
Query
mutation DeleteSurveyResponseData(
$input: DeleteSurveyResponseDataInput!,
$condition: ModelSurveyResponseDataConditionInput
) {
deleteSurveyResponseData(
input: $input,
condition: $condition
) {
id
clientId
inviteCode
householdId
keyValueData
status
surveyId
progress
createdAt
updatedAt
}
}
Variables
{
"input": DeleteSurveyResponseDataInput,
"condition": ModelSurveyResponseDataConditionInput
}
Response
{
"data": {
"deleteSurveyResponseData": {
"id": 4,
"clientId": 987,
"inviteCode": "abc123",
"householdId": 123,
"keyValueData": "abc123",
"status": "SENT",
"surveyId": "xyz789",
"progress": 987.65,
"createdAt": AWSDateTime,
"updatedAt": AWSDateTime
}
}
}
deleteTamaracLoadErrors
Response
Returns a TamaracLoadErrors
Arguments
| Name | Description |
|---|---|
input - DeleteTamaracLoadErrorsInput!
|
|
condition - ModelTamaracLoadErrorsConditionInput
|
Example
Query
mutation DeleteTamaracLoadErrors(
$input: DeleteTamaracLoadErrorsInput!,
$condition: ModelTamaracLoadErrorsConditionInput
) {
deleteTamaracLoadErrors(
input: $input,
condition: $condition
) {
id
sourceFile
errorMessage
tamaracPayload
accountId
accountNumber
primaryMemberFirstName
primaryMemberLastName
fuzzyRatio
rdsCombinedAddressString
tamaracCombinedAddressString
createdAt
updatedAt
}
}
Variables
{
"input": DeleteTamaracLoadErrorsInput,
"condition": ModelTamaracLoadErrorsConditionInput
}
Response
{
"data": {
"deleteTamaracLoadErrors": {
"id": 4,
"sourceFile": "abc123",
"errorMessage": "xyz789",
"tamaracPayload": "xyz789",
"accountId": "abc123",
"accountNumber": "abc123",
"primaryMemberFirstName": "xyz789",
"primaryMemberLastName": "xyz789",
"fuzzyRatio": "xyz789",
"rdsCombinedAddressString": "xyz789",
"tamaracCombinedAddressString": "xyz789",
"createdAt": AWSDateTime,
"updatedAt": AWSDateTime
}
}
}
deleteTask
Response
Returns an Int
Arguments
| Name | Description |
|---|---|
args - DeleteTaskInput!
|
Example
Query
mutation DeleteTask($args: DeleteTaskInput!) {
deleteTask(args: $args)
}
Variables
{"args": DeleteTaskInput}
Response
{"data": {"deleteTask": 987}}
deleteTaxDetails
Response
Returns a Boolean
Arguments
| Name | Description |
|---|---|
args - DeleteTaxDetailsInput!
|
Example
Query
mutation DeleteTaxDetails($args: DeleteTaxDetailsInput!) {
deleteTaxDetails(args: $args)
}
Variables
{"args": DeleteTaxDetailsInput}
Response
{"data": {"deleteTaxDetails": false}}
deleteTaxPlanning
Response
Returns a Boolean
Arguments
| Name | Description |
|---|---|
args - DeleteTaxPlanningInput!
|
Example
Query
mutation DeleteTaxPlanning($args: DeleteTaxPlanningInput!) {
deleteTaxPlanning(args: $args)
}
Variables
{"args": DeleteTaxPlanningInput}
Response
{"data": {"deleteTaxPlanning": false}}
deleteTrustBeneficiary
Response
Returns a Boolean
Arguments
| Name | Description |
|---|---|
args - DeleteTrustBeneficiaryInput!
|
Example
Query
mutation DeleteTrustBeneficiary($args: DeleteTrustBeneficiaryInput!) {
deleteTrustBeneficiary(args: $args)
}
Variables
{"args": DeleteTrustBeneficiaryInput}
Response
{"data": {"deleteTrustBeneficiary": false}}
deleteTrustee
Response
Returns a Boolean
Arguments
| Name | Description |
|---|---|
args - DeleteTrusteeInput!
|
Example
Query
mutation DeleteTrustee($args: DeleteTrusteeInput!) {
deleteTrustee(args: $args)
}
Variables
{"args": DeleteTrusteeInput}
Response
{"data": {"deleteTrustee": false}}
deleteVaultFile
Response
Returns a YourVaultFileInfo
Arguments
| Name | Description |
|---|---|
args - DeleteVaultFileInput
|
Example
Query
mutation DeleteVaultFile($args: DeleteVaultFileInput) {
deleteVaultFile(args: $args) {
pathAndFilename
presignedPathAndFilename
lastModified
size
status
publishCount
uploaderClientId
uploaderStaffId
}
}
Variables
{"args": DeleteVaultFileInput}
Response
{
"data": {
"deleteVaultFile": {
"pathAndFilename": "abc123",
"presignedPathAndFilename": "xyz789",
"lastModified": "xyz789",
"size": 123,
"status": 123,
"publishCount": 123,
"uploaderClientId": 123,
"uploaderStaffId": 987
}
}
}
deleteYourLifeSession
Response
Returns a YourLifeSession
Arguments
| Name | Description |
|---|---|
input - DeleteYourLifeSessionInput!
|
|
condition - ModelYourLifeSessionConditionInput
|
Example
Query
mutation DeleteYourLifeSession(
$input: DeleteYourLifeSessionInput!,
$condition: ModelYourLifeSessionConditionInput
) {
deleteYourLifeSession(
input: $input,
condition: $condition
) {
id
clientId
inviteCode
householdId
status
firstName
lastName
fullName
hasPartner
partnerId
includeGoals
includeConnections
includeFinancialDetails
partnerFirstName
partnerLastName
partnerFullName
responses {
questionId
intResponse
stringResponse
}
lovedOnes
communityConnections
globalConnections
overallScore
emotionalScore
environmentalScore
spiritualScore
socialScore
educationScore
occupationalScore
physicalScore
financialScore
notes {
householdId
valueGroupId
note
}
createdAt
updatedAt
}
}
Variables
{
"input": DeleteYourLifeSessionInput,
"condition": ModelYourLifeSessionConditionInput
}
Response
{
"data": {
"deleteYourLifeSession": {
"id": 4,
"clientId": 123,
"inviteCode": "xyz789",
"householdId": 987,
"status": "abc123",
"firstName": "abc123",
"lastName": "abc123",
"fullName": "xyz789",
"hasPartner": true,
"partnerId": 123,
"includeGoals": true,
"includeConnections": false,
"includeFinancialDetails": true,
"partnerFirstName": "xyz789",
"partnerLastName": "xyz789",
"partnerFullName": "abc123",
"responses": [LifeResponse],
"lovedOnes": ["abc123"],
"communityConnections": ["abc123"],
"globalConnections": ["abc123"],
"overallScore": 987.65,
"emotionalScore": 123.45,
"environmentalScore": 123.45,
"spiritualScore": 123.45,
"socialScore": 987.65,
"educationScore": 987.65,
"occupationalScore": 987.65,
"physicalScore": 123.45,
"financialScore": 123.45,
"notes": [LifeNote],
"createdAt": AWSDateTime,
"updatedAt": AWSDateTime
}
}
}
deleteYourValuesSession
Response
Returns a YourValuesSession
Arguments
| Name | Description |
|---|---|
input - DeleteYourValuesSessionInput!
|
|
condition - ModelYourValuesSessionConditionInput
|
Example
Query
mutation DeleteYourValuesSession(
$input: DeleteYourValuesSessionInput!,
$condition: ModelYourValuesSessionConditionInput
) {
deleteYourValuesSession(
input: $input,
condition: $condition
) {
id
clientId
inviteCode
partnerId
partnerInviteCode
client {
clientId
regrets
values {
cardId
rank
meaningReason
progressAction
progress
}
step
lastSeen
individualValuesCompleted
}
partner {
clientId
regrets
values {
cardId
rank
meaningReason
progressAction
progress
}
step
lastSeen
individualValuesCompleted
}
adviser {
staffId
step
lastSeen
}
support {
staffId
step
lastSeen
}
alignedValues {
cardId
clientId
rank
notes
progress
description
nextSteps {
id
title
notes
assignedToClientId
created
}
householdMemberProgress {
description
progress
clientId
}
}
valuesInc3Things
partnerValuesInc3Things
individualValuesOnly
step
lastSeen
createdAt
updatedAt
}
}
Variables
{
"input": DeleteYourValuesSessionInput,
"condition": ModelYourValuesSessionConditionInput
}
Response
{
"data": {
"deleteYourValuesSession": {
"id": 4,
"clientId": 123,
"inviteCode": "abc123",
"partnerId": 987,
"partnerInviteCode": "abc123",
"client": ValuesClient,
"partner": ValuesClient,
"adviser": ValuesStaff,
"support": ValuesStaff,
"alignedValues": [ValuesAlignedValue],
"valuesInc3Things": false,
"partnerValuesInc3Things": true,
"individualValuesOnly": false,
"step": "abc123",
"lastSeen": "xyz789",
"createdAt": AWSDateTime,
"updatedAt": AWSDateTime
}
}
}
disconnectYodleeClient
Response
Returns a Boolean
Arguments
| Name | Description |
|---|---|
args - DisconnectYodleeClientInput!
|
Example
Query
mutation DisconnectYodleeClient($args: DisconnectYodleeClientInput!) {
disconnectYodleeClient(args: $args)
}
Variables
{"args": DisconnectYodleeClientInput}
Response
{"data": {"disconnectYodleeClient": true}}
editHousehold
Response
Returns a Household
Arguments
| Name | Description |
|---|---|
args - EditHouseholdInput!
|
Example
Query
mutation EditHousehold($args: EditHouseholdInput!) {
editHousehold(args: $args) {
householdId
name
clients {
clientId
householdId
iamId
wealthIds
type
title
firstName
middleName
lastName
preferredName
dob
lastLogin
registered
billableStart
address {
addressId
constructedAddress
addressLine1
addressLine2
suburb
postCode
state
country
createdBy
created
updatedBy
updated
}
postalAddress {
addressId
constructedAddress
addressLine1
addressLine2
suburb
postCode
state
country
createdBy
created
updatedBy
updated
}
contactDetails {
emailAddress
mobileNumber
faxNumber
phoneNumber
createdBy
created
updatedBy
updated
}
moduleStates {
moduleStateId
clientId
previouslyCompleted
module
moduleState
sentDate
sentReminders
startedDate
startedReminders
finishedDate
expiredDate
updatedBy
updated
}
wellnessScore
goalCount
taskCount
sex
relationshipStatus
countryCodeBirth
countryCodeResidency
countryCodeCitizenship
notes
externalId
externalSystem
createdBy
created
updatedBy
updated
}
householdStaffAccess {
practiceOfficeId
practiceOfficeName
staffId
staffTitle
staffFirstName
staffMiddleName
staffLastName
role
}
isTest
householdPackageCode
practiceSegmentationId
practiceSegmentationName
countryCode
wellnessScore
createdBy
created
updatedBy
updated
}
}
Variables
{"args": EditHouseholdInput}
Response
{
"data": {
"editHousehold": {
"householdId": 123,
"name": "xyz789",
"clients": [Client],
"householdStaffAccess": [HouseholdStaffAccess],
"isTest": true,
"householdPackageCode": "abc123",
"practiceSegmentationId": 123,
"practiceSegmentationName": "xyz789",
"countryCode": "abc123",
"wellnessScore": 987.65,
"createdBy": "abc123",
"created": "abc123",
"updatedBy": "xyz789",
"updated": "xyz789"
}
}
}
emailTempPasswordToStaff
Response
Returns an EmailTempPasswordToStaffOutput
Arguments
| Name | Description |
|---|---|
args - EmailTempPasswordToStaffInput!
|
Example
Query
mutation EmailTempPasswordToStaff($args: EmailTempPasswordToStaffInput!) {
emailTempPasswordToStaff(args: $args) {
updateMessage
}
}
Variables
{"args": EmailTempPasswordToStaffInput}
Response
{
"data": {
"emailTempPasswordToStaff": {
"updateMessage": "xyz789"
}
}
}
emailYourVaultFile
Response
Returns a String
Arguments
| Name | Description |
|---|---|
args - EmailYourVaultFileInput
|
Example
Query
mutation EmailYourVaultFile($args: EmailYourVaultFileInput) {
emailYourVaultFile(args: $args)
}
Variables
{"args": EmailYourVaultFileInput}
Response
{"data": {"emailYourVaultFile": "abc123"}}
enableDisableCognitoUser
Response
Returns an EnableDisableCognitoUserOutput
Arguments
| Name | Description |
|---|---|
args - EnableDisableCognitoUserInput!
|
Example
Query
mutation EnableDisableCognitoUser($args: EnableDisableCognitoUserInput!) {
enableDisableCognitoUser(args: $args) {
updateMsg
}
}
Variables
{"args": EnableDisableCognitoUserInput}
Response
{
"data": {
"enableDisableCognitoUser": {
"updateMsg": "xyz789"
}
}
}
enableDisableLoginMfa
Response
Returns an EnableDisableLoginMfaOutput
Arguments
| Name | Description |
|---|---|
args - EnableDisableLoginMfaInput!
|
Example
Query
mutation EnableDisableLoginMfa($args: EnableDisableLoginMfaInput!) {
enableDisableLoginMfa(args: $args) {
updateMsg
}
}
Variables
{"args": EnableDisableLoginMfaInput}
Response
{
"data": {
"enableDisableLoginMfa": {
"updateMsg": "xyz789"
}
}
}
enqueueClientYodleeSync
Response
Returns a ClientYodleeSync
Arguments
| Name | Description |
|---|---|
args - EnqueueClientYodleeSyncInput!
|
Example
Query
mutation EnqueueClientYodleeSync($args: EnqueueClientYodleeSyncInput!) {
enqueueClientYodleeSync(args: $args) {
MessageId
}
}
Variables
{"args": EnqueueClientYodleeSyncInput}
Response
{
"data": {
"enqueueClientYodleeSync": {
"MessageId": "xyz789"
}
}
}
exportGovernanceZip
Response
Returns a String
Arguments
| Name | Description |
|---|---|
args - ExportGovernanceZipInput!
|
Example
Query
mutation ExportGovernanceZip($args: ExportGovernanceZipInput!) {
exportGovernanceZip(args: $args)
}
Variables
{"args": ExportGovernanceZipInput}
Response
{"data": {"exportGovernanceZip": "xyz789"}}
generateHaloLink
Response
Returns a GenerateHaloLinkOutput
Arguments
| Name | Description |
|---|---|
args - GenerateHaloLinkInput!
|
Example
Query
mutation GenerateHaloLink($args: GenerateHaloLinkInput!) {
generateHaloLink(args: $args) {
url
}
}
Variables
{"args": GenerateHaloLinkInput}
Response
{
"data": {
"generateHaloLink": {"url": "abc123"}
}
}
generateLifebook
Response
Returns a String
Arguments
| Name | Description |
|---|---|
generateLifebookInput - GenerateLifebookInput
|
Example
Query
mutation GenerateLifebook($generateLifebookInput: GenerateLifebookInput) {
generateLifebook(generateLifebookInput: $generateLifebookInput)
}
Variables
{"generateLifebookInput": GenerateLifebookInput}
Response
{"data": {"generateLifebook": "xyz789"}}
generateSurveysSession
Response
Returns a GenerateSurveysSessionOutput
Arguments
| Name | Description |
|---|---|
args - GenerateSurveysSessionInput
|
Example
Query
mutation GenerateSurveysSession($args: GenerateSurveysSessionInput) {
generateSurveysSession(args: $args) {
inviteCode
}
}
Variables
{"args": GenerateSurveysSessionInput}
Response
{
"data": {
"generateSurveysSession": {
"inviteCode": "abc123"
}
}
}
generateTermsOfEngagement
Response
Returns a String
Arguments
| Name | Description |
|---|---|
generateTermsOfEngagementInput - GenerateTermsOfEngagementInput
|
Example
Query
mutation GenerateTermsOfEngagement($generateTermsOfEngagementInput: GenerateTermsOfEngagementInput) {
generateTermsOfEngagement(generateTermsOfEngagementInput: $generateTermsOfEngagementInput)
}
Variables
{
"generateTermsOfEngagementInput": GenerateTermsOfEngagementInput
}
Response
{
"data": {
"generateTermsOfEngagement": "abc123"
}
}
generateYourLifeSurveysSession
Response
Returns a GenerateYourLifeSurveysSessionOutput
Arguments
| Name | Description |
|---|---|
args - GenerateYourLifeSurveysSessionInput!
|
Example
Query
mutation GenerateYourLifeSurveysSession($args: GenerateYourLifeSurveysSessionInput!) {
generateYourLifeSurveysSession(args: $args) {
surveyId
inviteCode
clientId
}
}
Variables
{"args": GenerateYourLifeSurveysSessionInput}
Response
{
"data": {
"generateYourLifeSurveysSession": {
"surveyId": "abc123",
"inviteCode": "abc123",
"clientId": 987
}
}
}
getPracticeStripePortalLinks
Response
Returns a StripePortalLinks
Arguments
| Name | Description |
|---|---|
args - GetPracticeStripePortalLinksInput!
|
Example
Query
mutation GetPracticeStripePortalLinks($args: GetPracticeStripePortalLinksInput!) {
getPracticeStripePortalLinks(args: $args) {
paymentUpdateLink
subscriptionUpdateLink
}
}
Variables
{"args": GetPracticeStripePortalLinksInput}
Response
{
"data": {
"getPracticeStripePortalLinks": {
"paymentUpdateLink": "xyz789",
"subscriptionUpdateLink": "abc123"
}
}
}
hideClientFromStaff
Response
Returns a HideClientFromStaffOutput
Arguments
| Name | Description |
|---|---|
args - HideClientFromStaffInput!
|
Example
Query
mutation HideClientFromStaff($args: HideClientFromStaffInput!) {
hideClientFromStaff(args: $args) {
softDeletedEmail
clientActiveStatus
}
}
Variables
{"args": HideClientFromStaffInput}
Response
{
"data": {
"hideClientFromStaff": {
"softDeletedEmail": "xyz789",
"clientActiveStatus": "xyz789"
}
}
}
inviteInvestmentPreferences
Response
Returns a Boolean
Arguments
| Name | Description |
|---|---|
args - InviteInvestmentPreferencesInput
|
Example
Query
mutation InviteInvestmentPreferences($args: InviteInvestmentPreferencesInput) {
inviteInvestmentPreferences(args: $args)
}
Variables
{"args": InviteInvestmentPreferencesInput}
Response
{"data": {"inviteInvestmentPreferences": true}}
inviteRegistration
Response
Returns a Boolean
Arguments
| Name | Description |
|---|---|
inviteRegistrationInput - InviteRegistrationInput
|
Example
Query
mutation InviteRegistration($inviteRegistrationInput: InviteRegistrationInput) {
inviteRegistration(inviteRegistrationInput: $inviteRegistrationInput)
}
Variables
{"inviteRegistrationInput": InviteRegistrationInput}
Response
{"data": {"inviteRegistration": true}}
inviteYourLife
Response
Returns a Boolean
Arguments
| Name | Description |
|---|---|
inviteYourLifeInput - InviteYourLifeInput
|
Example
Query
mutation InviteYourLife($inviteYourLifeInput: InviteYourLifeInput) {
inviteYourLife(inviteYourLifeInput: $inviteYourLifeInput)
}
Variables
{"inviteYourLifeInput": InviteYourLifeInput}
Response
{"data": {"inviteYourLife": false}}
makeClientNonBillable
Response
Returns a MakeClientNonBillableOutput
Arguments
| Name | Description |
|---|---|
args - MakeClientNonBillableInput!
|
Example
Query
mutation MakeClientNonBillable($args: MakeClientNonBillableInput!) {
makeClientNonBillable(args: $args) {
updateMsg
}
}
Variables
{"args": MakeClientNonBillableInput}
Response
{
"data": {
"makeClientNonBillable": {
"updateMsg": "abc123"
}
}
}
mergeClientsIntoOneHousehold
Response
Returns a Boolean
Arguments
| Name | Description |
|---|---|
args - MergeClientsIntoOneHouseholdInput!
|
Example
Query
mutation MergeClientsIntoOneHousehold($args: MergeClientsIntoOneHouseholdInput!) {
mergeClientsIntoOneHousehold(args: $args)
}
Variables
{"args": MergeClientsIntoOneHouseholdInput}
Response
{"data": {"mergeClientsIntoOneHousehold": true}}
mergeHousehold
Response
Returns a MergeHouseholdOutput
Arguments
| Name | Description |
|---|---|
args - MergeHouseholdInput!
|
Example
Query
mutation MergeHousehold($args: MergeHouseholdInput!) {
mergeHousehold(args: $args) {
householdId
}
}
Variables
{"args": MergeHouseholdInput}
Response
{"data": {"mergeHousehold": {"householdId": 123}}}
moveVaultFile
Response
Returns a YourVaultFileInfo
Arguments
| Name | Description |
|---|---|
args - MoveVaultFileInput
|
Example
Query
mutation MoveVaultFile($args: MoveVaultFileInput) {
moveVaultFile(args: $args) {
pathAndFilename
presignedPathAndFilename
lastModified
size
status
publishCount
uploaderClientId
uploaderStaffId
}
}
Variables
{"args": MoveVaultFileInput}
Response
{
"data": {
"moveVaultFile": {
"pathAndFilename": "xyz789",
"presignedPathAndFilename": "abc123",
"lastModified": "abc123",
"size": 123,
"status": 123,
"publishCount": 987,
"uploaderClientId": 123,
"uploaderStaffId": 987
}
}
}
registerClient
Response
Returns a RegisterClientOutput
Arguments
| Name | Description |
|---|---|
registerClientInput - RegisterClientInput!
|
Example
Query
mutation RegisterClient($registerClientInput: RegisterClientInput!) {
registerClient(registerClientInput: $registerClientInput) {
clientIamId
}
}
Variables
{"registerClientInput": RegisterClientInput}
Response
{
"data": {
"registerClient": {
"clientIamId": "abc123"
}
}
}
registerPracticeManager
Response
Returns a RegisterStaffOutput
Arguments
| Name | Description |
|---|---|
args - RegisterStaffInput!
|
Example
Query
mutation RegisterPracticeManager($args: RegisterStaffInput!) {
registerPracticeManager(args: $args) {
staffId
}
}
Variables
{"args": RegisterStaffInput}
Response
{"data": {"registerPracticeManager": {"staffId": 987}}}
registerProfessional
Response
Returns a RegisterStaffOutput
Arguments
| Name | Description |
|---|---|
args - RegisterStaffInput!
|
Example
Query
mutation RegisterProfessional($args: RegisterStaffInput!) {
registerProfessional(args: $args) {
staffId
}
}
Variables
{"args": RegisterStaffInput}
Response
{"data": {"registerProfessional": {"staffId": 123}}}
registerSupport
Response
Returns a RegisterStaffOutput
Arguments
| Name | Description |
|---|---|
args - RegisterStaffInput!
|
Example
Query
mutation RegisterSupport($args: RegisterStaffInput!) {
registerSupport(args: $args) {
staffId
}
}
Variables
{"args": RegisterStaffInput}
Response
{"data": {"registerSupport": {"staffId": 987}}}
registerUnlicensed
Response
Returns a RegisterStaffOutput
Arguments
| Name | Description |
|---|---|
args - RegisterStaffInput!
|
Example
Query
mutation RegisterUnlicensed($args: RegisterStaffInput!) {
registerUnlicensed(args: $args) {
staffId
}
}
Variables
{"args": RegisterStaffInput}
Response
{"data": {"registerUnlicensed": {"staffId": 987}}}
removeAccessFromHousehold
Response
Returns a Boolean
Arguments
| Name | Description |
|---|---|
args - RemoveAccessFromHouseholdInput!
|
Example
Query
mutation RemoveAccessFromHousehold($args: RemoveAccessFromHouseholdInput!) {
removeAccessFromHousehold(args: $args)
}
Variables
{"args": RemoveAccessFromHouseholdInput}
Response
{"data": {"removeAccessFromHousehold": true}}
removeBasiqConnection
removeYodleeAccount
Response
Returns a Boolean
Arguments
| Name | Description |
|---|---|
args - RemoveYodleeAccountInput!
|
Example
Query
mutation RemoveYodleeAccount($args: RemoveYodleeAccountInput!) {
removeYodleeAccount(args: $args)
}
Variables
{"args": RemoveYodleeAccountInput}
Response
{"data": {"removeYodleeAccount": true}}
removeYodleeProvider
Response
Returns a Boolean
Arguments
| Name | Description |
|---|---|
args - RemoveYodleeProviderInput!
|
Example
Query
mutation RemoveYodleeProvider($args: RemoveYodleeProviderInput!) {
removeYodleeProvider(args: $args)
}
Variables
{"args": RemoveYodleeProviderInput}
Response
{"data": {"removeYodleeProvider": true}}
renamePracticeConfigVaultFolder
Response
Returns a VaultFolder
Arguments
| Name | Description |
|---|---|
args - RenameVaultFolderInput!
|
Example
Query
mutation RenamePracticeConfigVaultFolder($args: RenameVaultFolderInput!) {
renamePracticeConfigVaultFolder(args: $args) {
id
name
order
enabled
readonly
}
}
Variables
{"args": RenameVaultFolderInput}
Response
{
"data": {
"renamePracticeConfigVaultFolder": {
"id": "abc123",
"name": "abc123",
"order": 987,
"enabled": true,
"readonly": false
}
}
}
renameVaultFile
Response
Returns a Boolean
Arguments
| Name | Description |
|---|---|
args - RenameVaultFileInput
|
Example
Query
mutation RenameVaultFile($args: RenameVaultFileInput) {
renameVaultFile(args: $args)
}
Variables
{"args": RenameVaultFileInput}
Response
{"data": {"renameVaultFile": true}}
resetSurveysSession
Response
Returns a ResetSurveysSessionOutput
Arguments
| Name | Description |
|---|---|
args - ResetSurveysSessionInput
|
Example
Query
mutation ResetSurveysSession($args: ResetSurveysSessionInput) {
resetSurveysSession(args: $args) {
success
message
}
}
Variables
{"args": ResetSurveysSessionInput}
Response
{
"data": {
"resetSurveysSession": {
"success": false,
"message": "abc123"
}
}
}
resetTempPassword
Response
Returns an UpdateStaffOutput
Arguments
| Name | Description |
|---|---|
args - ResetTempPasswordInput!
|
Example
Query
mutation ResetTempPassword($args: ResetTempPasswordInput!) {
resetTempPassword(args: $args) {
staffId
}
}
Variables
{"args": ResetTempPasswordInput}
Response
{"data": {"resetTempPassword": {"staffId": 123}}}
resetUserPassword
Response
Returns a String
Arguments
| Name | Description |
|---|---|
args - ResetUserPasswordInput!
|
Example
Query
mutation ResetUserPassword($args: ResetUserPasswordInput!) {
resetUserPassword(args: $args)
}
Variables
{"args": ResetUserPasswordInput}
Response
{"data": {"resetUserPassword": "abc123"}}
riskalyzeDeleteClientLink
Response
Returns a Boolean
Arguments
| Name | Description |
|---|---|
args - RiskalyzeDeleteClientLinkRequest
|
Example
Query
mutation RiskalyzeDeleteClientLink($args: RiskalyzeDeleteClientLinkRequest) {
riskalyzeDeleteClientLink(args: $args)
}
Variables
{"args": RiskalyzeDeleteClientLinkRequest}
Response
{"data": {"riskalyzeDeleteClientLink": false}}
riskalyzeDeletePortfolioLink
Response
Returns a Boolean
Arguments
| Name | Description |
|---|---|
args - RiskalyzeDeletePortfolioLinkRequest
|
Example
Query
mutation RiskalyzeDeletePortfolioLink($args: RiskalyzeDeletePortfolioLinkRequest) {
riskalyzeDeletePortfolioLink(args: $args)
}
Variables
{"args": RiskalyzeDeletePortfolioLinkRequest}
Response
{"data": {"riskalyzeDeletePortfolioLink": false}}
riskalyzeIsCallbackVerified
Response
Returns a Boolean
Arguments
| Name | Description |
|---|---|
args - RiskalyzeIsCallbackVerifiedRequest
|
Example
Query
mutation RiskalyzeIsCallbackVerified($args: RiskalyzeIsCallbackVerifiedRequest) {
riskalyzeIsCallbackVerified(args: $args)
}
Variables
{"args": RiskalyzeIsCallbackVerifiedRequest}
Response
{"data": {"riskalyzeIsCallbackVerified": true}}
riskalyzeSaveClientLink
Response
Returns a Boolean
Arguments
| Name | Description |
|---|---|
args - RiskalyzeSaveClientLinkRequest
|
Example
Query
mutation RiskalyzeSaveClientLink($args: RiskalyzeSaveClientLinkRequest) {
riskalyzeSaveClientLink(args: $args)
}
Variables
{"args": RiskalyzeSaveClientLinkRequest}
Response
{"data": {"riskalyzeSaveClientLink": true}}
riskalyzeSavePortfolioLink
Response
Returns a RiskalyzeSavePortfolioLinkResponse
Arguments
| Name | Description |
|---|---|
args - RiskalyzeSavePortfolioLinkRequest
|
Example
Query
mutation RiskalyzeSavePortfolioLink($args: RiskalyzeSavePortfolioLinkRequest) {
riskalyzeSavePortfolioLink(args: $args) {
status
riskScore
}
}
Variables
{"args": RiskalyzeSavePortfolioLinkRequest}
Response
{"data": {"riskalyzeSavePortfolioLink": {"status": false, "riskScore": 123}}}
runBestLifeProjection
Response
Returns a BestLifeProjectionOutput
Arguments
| Name | Description |
|---|---|
args - BestLifeProjectionInput
|
Example
Query
mutation RunBestLifeProjection($args: BestLifeProjectionInput) {
runBestLifeProjection(args: $args) {
scenarioId
name
timeline {
data
}
chart {
data
chartSchema
timeMarkers
dataMarkers
}
latestInputs {
data {
scenarioId
name
includeClient
clientAge
clientIncome
clientSuperannuation
clientSuperannuationContribution
clientSuperannuationContributionIsInDollars
clientSuperannuationMatchBps
clientSuperannuationMatchEndsBps
clientSuperannuationFee
clientSuperannuationFeeIsInDollars
clientSuperOther
clientSuperOtherContribution
clientSuperOtherContributionIsInDollars
clientSuperOtherFee
clientSuperOtherFeeIsInDollars
clientRetirementAge
clientPensionPaidFromAge
clientLifeExpectancyAge
clientIncomeRateChange
includePartner
partnerAge
partnerIncome
partnerSuperannuation
partnerSuperannuationContribution
partnerSuperannuationContributionIsInDollars
partnerSuperannuationMatchBps
partnerSuperannuationMatchEndsBps
partnerSuperannuationFee
partnerSuperannuationFeeIsInDollars
partnerSuperOther
partnerSuperOtherContribution
partnerSuperOtherContributionIsInDollars
partnerSuperOtherFee
partnerSuperOtherFeeIsInDollars
partnerRetirementAge
partnerPensionPaidFromAge
partnerLifeExpectancyAge
partnerIncomeRateChange
businessValueGrowthPerAnnum
businessValue
businessEstimatedDateOfSale
businessEstimatedSaleAmount
businessEstimatedTaxOnSale
householdPersonalAssets
householdPersonalDebt
householdProperty
householdPropertyDebt
householdInvestmentProperties
householdInvestmentPropertiesDebt
householdNonSuperInvestments
householdNonSuperInvestmentsFee
householdNonSuperInvestmentsFeeIsInDollars
householdPreRetirementAvgTax
householdPostRetirementAvgTax
householdIncome
householdSavings
householdCashFlow {
id
year
clientAge
clientIncome
clientStatus
partnerAge
partnerIncome
partnerStatus
householdIncome
totalIncome
incomeSaved
incomeSpent
reqRetirementIncome
contribution
withdrawal
}
householdCashFlowHeader
reqRetirementIncome
reqRetirementIncomeRateChange
referenceModel
bestLifeScore
excessCashAllocations {
allocationEnabled
allocationType
allocationRank
maxAmountDollar
maxAmountBps
}
reduceShortfallAllocations {
allocationEnabled
allocationType
allocationRank
maxAmountDollar
maxAmountBps
}
}
}
report {
data
}
}
}
Variables
{"args": BestLifeProjectionInput}
Response
{
"data": {
"runBestLifeProjection": {
"scenarioId": 123,
"name": "xyz789",
"timeline": BestLifeProjectionTimelineData,
"chart": BestLifeProjectionChartData,
"latestInputs": BestLifeProjectionLatestInputsData,
"report": BestLifeReportData
}
}
}
runBestLifeScenario
Response
Returns a RunBestLifeScenarioOutput
Arguments
| Name | Description |
|---|---|
args - RunBestLifeScenarioInput
|
Example
Query
mutation RunBestLifeScenario($args: RunBestLifeScenarioInput) {
runBestLifeScenario(args: $args) {
scenarioId
}
}
Variables
{"args": RunBestLifeScenarioInput}
Response
{
"data": {
"runBestLifeScenario": {
"scenarioId": "abc123"
}
}
}
saveAsset
Response
Returns an AssetOutput
Arguments
| Name | Description |
|---|---|
args - SaveAssetInput!
|
Example
Query
mutation SaveAsset($args: SaveAssetInput!) {
saveAsset(args: $args) {
assetId
householdId
clientId
clientFirstName
clientLastName
clientPreferredName
legalEntityId
legalEntityName
beneficiaryClientId
beneficiaryLegalEntityId
otherBeneficiary
relationshipAsset
assetType
superType
pensionType
description
accountNumber
providerName
memberNumber
balance
definedBenefitSalary
definedBenefitMultiple
employeeContribution
employeeContributionBps
employeeContributionType
employeeContributionCap
employeeContributionCapBps
employerContribution
employerContributionBps
employerContributionCap
employerContributionCapBps
makesPersonalContribution
annualContribution
inheritedIraType
deceasedOwnerDateOfBirth
deceasedOwnerDateOfDeath
rmdTakenThisYear
previousYearBalance
annuityTermDate
deathBenefit
surrenderValue
centrelinkValue
isUsedLoanSecurity
loanSecuredAmount
madePersonalContribPast3y
taxFreeComponent
preservationComponent
makesPersonalSuperContribution
isSalarySacrifice
superContributionAmount
superContributionFrequency
employerPaysHigherThanMinimumSuper
higherThanMinimumSuperBps
preRetirementRefModel
postRetirementRefModel
feesBps
feesDollar
addressId
ownOrRent
isPrimaryHome
purchasePrice
purchaseDate
growthBps
currentValue
propertyType
rent
savingInvestmentType
assetUse
assessed
make
model
lastValued
superPhase
annuityType
term
maturityDate
commutedAmount
residualValue
assetExemptionBps
notes
clientNotes
partnerNotes
confidentialNotes
displayName
displayOwnership
externalSystem
assetYodleeMapping {
providerAccountId
additionalStatus
additionalStatusDescription
lastUpdated
isBroken
createdBy
created
updatedBy
updated
}
createdBy
created
updatedBy
updated
constructedAddress
addressLine1
addressLine2
suburb
postCode
state
country
linkedLoan
}
}
Variables
{"args": SaveAssetInput}
Response
{
"data": {
"saveAsset": {
"assetId": 987,
"householdId": 123,
"clientId": 123,
"clientFirstName": "xyz789",
"clientLastName": "abc123",
"clientPreferredName": "abc123",
"legalEntityId": 123,
"legalEntityName": "xyz789",
"beneficiaryClientId": 123,
"beneficiaryLegalEntityId": 123,
"otherBeneficiary": "abc123",
"relationshipAsset": "xyz789",
"assetType": "abc123",
"superType": "abc123",
"pensionType": "abc123",
"description": "abc123",
"accountNumber": "xyz789",
"providerName": "abc123",
"memberNumber": "xyz789",
"balance": 123.45,
"definedBenefitSalary": 123.45,
"definedBenefitMultiple": 987.65,
"employeeContribution": 987.65,
"employeeContributionBps": 987.65,
"employeeContributionType": "xyz789",
"employeeContributionCap": 987.65,
"employeeContributionCapBps": 123.45,
"employerContribution": 987.65,
"employerContributionBps": 123.45,
"employerContributionCap": 123.45,
"employerContributionCapBps": 123.45,
"makesPersonalContribution": false,
"annualContribution": 123.45,
"inheritedIraType": "xyz789",
"deceasedOwnerDateOfBirth": "abc123",
"deceasedOwnerDateOfDeath": "abc123",
"rmdTakenThisYear": false,
"previousYearBalance": 987.65,
"annuityTermDate": "xyz789",
"deathBenefit": 987.65,
"surrenderValue": 123.45,
"centrelinkValue": 987.65,
"isUsedLoanSecurity": false,
"loanSecuredAmount": 987.65,
"madePersonalContribPast3y": true,
"taxFreeComponent": 123.45,
"preservationComponent": 987.65,
"makesPersonalSuperContribution": false,
"isSalarySacrifice": false,
"superContributionAmount": 123.45,
"superContributionFrequency": "xyz789",
"employerPaysHigherThanMinimumSuper": true,
"higherThanMinimumSuperBps": 987.65,
"preRetirementRefModel": 123,
"postRetirementRefModel": 123,
"feesBps": 987.65,
"feesDollar": 123.45,
"addressId": 123,
"ownOrRent": "xyz789",
"isPrimaryHome": false,
"purchasePrice": 987.65,
"purchaseDate": "abc123",
"growthBps": 123.45,
"currentValue": 987.65,
"propertyType": "abc123",
"rent": 123.45,
"savingInvestmentType": "xyz789",
"assetUse": "xyz789",
"assessed": false,
"make": "abc123",
"model": "abc123",
"lastValued": "xyz789",
"superPhase": "xyz789",
"annuityType": "xyz789",
"term": 987,
"maturityDate": "abc123",
"commutedAmount": 987.65,
"residualValue": 987.65,
"assetExemptionBps": 987.65,
"notes": "xyz789",
"clientNotes": "xyz789",
"partnerNotes": "abc123",
"confidentialNotes": "xyz789",
"displayName": "abc123",
"displayOwnership": 123,
"externalSystem": "IL",
"assetYodleeMapping": YodleeMapping,
"createdBy": "xyz789",
"created": "abc123",
"updatedBy": "xyz789",
"updated": "xyz789",
"constructedAddress": "abc123",
"addressLine1": "xyz789",
"addressLine2": "xyz789",
"suburb": "xyz789",
"postCode": "abc123",
"state": "xyz789",
"country": "abc123",
"linkedLoan": 123
}
}
}
saveBeneficiary
Response
Returns a BeneficiaryOutput
Arguments
| Name | Description |
|---|---|
args - SaveBeneficiaryInput!
|
Example
Query
mutation SaveBeneficiary($args: SaveBeneficiaryInput!) {
saveBeneficiary(args: $args) {
beneficiaryId
estatePlanningId
isPrimary
firstName
middleName
lastName
companyName
relationshipType
nominatedPercentage
ageEntitlement
notes
clientNotes
partnerNotes
confidentialNotes
createdBy
created
updatedBy
updated
}
}
Variables
{"args": SaveBeneficiaryInput}
Response
{
"data": {
"saveBeneficiary": {
"beneficiaryId": 987,
"estatePlanningId": 123,
"isPrimary": false,
"firstName": "xyz789",
"middleName": "abc123",
"lastName": "xyz789",
"companyName": "xyz789",
"relationshipType": "xyz789",
"nominatedPercentage": 987.65,
"ageEntitlement": 987,
"notes": "xyz789",
"clientNotes": "xyz789",
"partnerNotes": "xyz789",
"confidentialNotes": "xyz789",
"createdBy": "xyz789",
"created": "xyz789",
"updatedBy": "abc123",
"updated": "xyz789"
}
}
}
saveBestLifeScenario
Response
Returns a Boolean
Arguments
| Name | Description |
|---|---|
args - RunBestLifeScenarioInput
|
Example
Query
mutation SaveBestLifeScenario($args: RunBestLifeScenarioInput) {
saveBestLifeScenario(args: $args)
}
Variables
{"args": RunBestLifeScenarioInput}
Response
{"data": {"saveBestLifeScenario": true}}
saveBusinessPlanning
Response
Returns a BusinessPlanningOutput
Arguments
| Name | Description |
|---|---|
args - SaveBusinessPlanningInput!
|
Example
Query
mutation SaveBusinessPlanning($args: SaveBusinessPlanningInput!) {
saveBusinessPlanning(args: $args) {
businessPlanningId
householdId
clientId
legalEntityId
hasBusinessDocuments
createdBy
created
updatedBy
updated
}
}
Variables
{"args": SaveBusinessPlanningInput}
Response
{
"data": {
"saveBusinessPlanning": {
"businessPlanningId": 123,
"householdId": 987,
"clientId": 987,
"legalEntityId": 123,
"hasBusinessDocuments": true,
"createdBy": "xyz789",
"created": "xyz789",
"updatedBy": "xyz789",
"updated": "abc123"
}
}
}
saveCharitablePlanning
Response
Returns a CharitablePlanningOutput
Arguments
| Name | Description |
|---|---|
args - SaveCharitablePlanningInput!
|
Example
Query
mutation SaveCharitablePlanning($args: SaveCharitablePlanningInput!) {
saveCharitablePlanning(args: $args) {
charitablePlanningId
householdId
clientId
legalEntityId
hasCharitableFoundation
createdBy
created
updatedBy
updated
}
}
Variables
{"args": SaveCharitablePlanningInput}
Response
{
"data": {
"saveCharitablePlanning": {
"charitablePlanningId": 123,
"householdId": 123,
"clientId": 987,
"legalEntityId": 987,
"hasCharitableFoundation": false,
"createdBy": "xyz789",
"created": "abc123",
"updatedBy": "xyz789",
"updated": "xyz789"
}
}
}
saveClient
Response
Returns a SaveClientOutput
Arguments
| Name | Description |
|---|---|
args - SaveClientInput!
|
Example
Query
mutation SaveClient($args: SaveClientInput!) {
saveClient(args: $args) {
clientId
householdId
status
client {
clientId
householdId
iamId
wealthIds
type
title
firstName
middleName
lastName
preferredName
dob
lastLogin
registered
billableStart
address {
addressId
constructedAddress
addressLine1
addressLine2
suburb
postCode
state
country
createdBy
created
updatedBy
updated
}
postalAddress {
addressId
constructedAddress
addressLine1
addressLine2
suburb
postCode
state
country
createdBy
created
updatedBy
updated
}
contactDetails {
emailAddress
mobileNumber
faxNumber
phoneNumber
createdBy
created
updatedBy
updated
}
moduleStates {
moduleStateId
clientId
previouslyCompleted
module
moduleState
sentDate
sentReminders
startedDate
startedReminders
finishedDate
expiredDate
updatedBy
updated
}
wellnessScore
goalCount
taskCount
sex
relationshipStatus
countryCodeBirth
countryCodeResidency
countryCodeCitizenship
notes
externalId
externalSystem
createdBy
created
updatedBy
updated
}
auth0Id
}
}
Variables
{"args": SaveClientInput}
Response
{
"data": {
"saveClient": {
"clientId": 987,
"householdId": 123,
"status": "xyz789",
"client": Client,
"auth0Id": "xyz789"
}
}
}
saveClientConfig
Response
Returns a ClientConfig
Arguments
| Name | Description |
|---|---|
args - SaveClientConfig!
|
Example
Query
mutation SaveClientConfig($args: SaveClientConfig!) {
saveClientConfig(args: $args) {
clientConfigId
clientId
configuration {
inAppNotifications {
enabled
}
governanceConfig {
hideEmptySections
}
}
}
}
Variables
{"args": SaveClientConfig}
Response
{
"data": {
"saveClientConfig": {
"clientConfigId": 123,
"clientId": 123,
"configuration": ClientConfigConfiguration
}
}
}
saveClientWealthId
Response
Returns a Boolean
Arguments
| Name | Description |
|---|---|
args - SaveClientWealthIdInput!
|
Example
Query
mutation SaveClientWealthId($args: SaveClientWealthIdInput!) {
saveClientWealthId(args: $args)
}
Variables
{"args": SaveClientWealthIdInput}
Response
{"data": {"saveClientWealthId": false}}
saveClientWealthIds
Response
Returns a Boolean
Arguments
| Name | Description |
|---|---|
args - SaveClientWealthIdsInput!
|
Example
Query
mutation SaveClientWealthIds($args: SaveClientWealthIdsInput!) {
saveClientWealthIds(args: $args)
}
Variables
{"args": SaveClientWealthIdsInput}
Response
{"data": {"saveClientWealthIds": true}}
saveDealerGroup
Response
Returns a SaveDealerGroupOutput
Arguments
| Name | Description |
|---|---|
args - SaveDealerGroupInput!
|
Example
Query
mutation SaveDealerGroup($args: SaveDealerGroupInput!) {
saveDealerGroup(args: $args) {
dealerGroupId
}
}
Variables
{"args": SaveDealerGroupInput}
Response
{"data": {"saveDealerGroup": {"dealerGroupId": 123}}}
saveDirector
Response
Returns a DirectorOutput
Arguments
| Name | Description |
|---|---|
args - SaveDirectorInput!
|
Example
Query
mutation SaveDirector($args: SaveDirectorInput!) {
saveDirector(args: $args) {
directorId
legalEntityId
firstName
middleName
lastName
dateAppointed
notes
clientNotes
partnerNotes
confidentialNotes
createdBy
created
updatedBy
updated
}
}
Variables
{"args": SaveDirectorInput}
Response
{
"data": {
"saveDirector": {
"directorId": 987,
"legalEntityId": 123,
"firstName": "xyz789",
"middleName": "xyz789",
"lastName": "abc123",
"dateAppointed": "xyz789",
"notes": "xyz789",
"clientNotes": "abc123",
"partnerNotes": "xyz789",
"confidentialNotes": "xyz789",
"createdBy": "xyz789",
"created": "xyz789",
"updatedBy": "xyz789",
"updated": "xyz789"
}
}
}
saveDiscovery
Response
Returns a Discovery
Arguments
| Name | Description |
|---|---|
discoveryInput - DiscoveryInput
|
Example
Query
mutation SaveDiscovery($discoveryInput: DiscoveryInput) {
saveDiscovery(discoveryInput: $discoveryInput) {
id
householdId
clientDiscovery {
id
clientId
homeLoanOwing
investmentDebt
investmentPropertyDebt
requiredRetirementIncome
otherDebt
superBalance
savings
income
otherAssets
lifeInsurance
incomeProtection
traumaInsurance
tpdInsurance
desiredRetirementAge
}
partnerDiscovery {
id
clientId
homeLoanOwing
investmentDebt
investmentPropertyDebt
requiredRetirementIncome
otherDebt
superBalance
savings
income
otherAssets
lifeInsurance
incomeProtection
traumaInsurance
tpdInsurance
desiredRetirementAge
}
householdIncome
additionalHouseholdIncome
householdSavings
householdTotalAssets
householdTotalDebt
superContributions
superContributionsDetails
savingsRegularity
savingsAmount
homeValue
investmentPropertiesValue
investmentPropertiesDebt
requiredRetirementIncome
referenceModel
}
}
Variables
{"discoveryInput": DiscoveryInput}
Response
{
"data": {
"saveDiscovery": {
"id": 987,
"householdId": 987,
"clientDiscovery": ClientDiscovery,
"partnerDiscovery": ClientDiscovery,
"householdIncome": 987.65,
"additionalHouseholdIncome": 987.65,
"householdSavings": 987.65,
"householdTotalAssets": 987.65,
"householdTotalDebt": 123.45,
"superContributions": "Y",
"superContributionsDetails": "abc123",
"savingsRegularity": "O",
"savingsAmount": 987.65,
"homeValue": 123.45,
"investmentPropertiesValue": 123.45,
"investmentPropertiesDebt": 123.45,
"requiredRetirementIncome": 987.65,
"referenceModel": 123
}
}
}
saveEducationPlanning
Response
Returns an EducationPlanningOutput
Arguments
| Name | Description |
|---|---|
args - SaveEducationPlanningInput!
|
Example
Query
mutation SaveEducationPlanning($args: SaveEducationPlanningInput!) {
saveEducationPlanning(args: $args) {
educationPlanningId
householdId
clientId
legalEntityId
hasEducationSavings
createdBy
created
updatedBy
updated
}
}
Variables
{"args": SaveEducationPlanningInput}
Response
{
"data": {
"saveEducationPlanning": {
"educationPlanningId": 987,
"householdId": 123,
"clientId": 987,
"legalEntityId": 987,
"hasEducationSavings": true,
"createdBy": "xyz789",
"created": "abc123",
"updatedBy": "abc123",
"updated": "abc123"
}
}
}
saveEmploymentDetails
Response
Returns an EmploymentDetailsOutput
Arguments
| Name | Description |
|---|---|
args - SaveEmploymentDetailsInput!
|
Example
Query
mutation SaveEmploymentDetails($args: SaveEmploymentDetailsInput!) {
saveEmploymentDetails(args: $args) {
employmentDetailsId
clientId
degreeQualified
qualifications
recentRetrenched
employmentStatus
plannedChanges
plannedChangesDescription
businessStructure
employedByOwnCompany
occupation
startDate
employer
secondaryOccupation
secondaryOccupationStartDate
secondaryOccupationEmployer
employmentHoursPerWeek
unusedAnnualLeave
unusedSickLeave
unusedLongServiceLeave
workedOverseas
workedOverseasDetails
salarySacrificeAvailable
notes
confidentialNotes
createdBy
created
updatedBy
updated
}
}
Variables
{"args": SaveEmploymentDetailsInput}
Response
{
"data": {
"saveEmploymentDetails": {
"employmentDetailsId": 123,
"clientId": 987,
"degreeQualified": true,
"qualifications": "abc123",
"recentRetrenched": true,
"employmentStatus": "abc123",
"plannedChanges": false,
"plannedChangesDescription": "abc123",
"businessStructure": "xyz789",
"employedByOwnCompany": false,
"occupation": "abc123",
"startDate": "xyz789",
"employer": "xyz789",
"secondaryOccupation": "abc123",
"secondaryOccupationStartDate": "abc123",
"secondaryOccupationEmployer": "xyz789",
"employmentHoursPerWeek": 987.65,
"unusedAnnualLeave": 987.65,
"unusedSickLeave": 123.45,
"unusedLongServiceLeave": 987.65,
"workedOverseas": true,
"workedOverseasDetails": "xyz789",
"salarySacrificeAvailable": true,
"notes": "abc123",
"confidentialNotes": "abc123",
"createdBy": "xyz789",
"created": "xyz789",
"updatedBy": "xyz789",
"updated": "xyz789"
}
}
}
saveEnabledHouseholdKeyAdviceArea
Response
Returns a HouseholdKeyAdviceArea
Arguments
| Name | Description |
|---|---|
args - SaveEnabledHouseholdKeyAdviceAreaInput
|
Example
Query
mutation SaveEnabledHouseholdKeyAdviceArea($args: SaveEnabledHouseholdKeyAdviceAreaInput) {
saveEnabledHouseholdKeyAdviceArea(args: $args) {
householdKeyAdviceAreaId
householdId
practiceKeyAdviceAreaId
enabled
status
rank
createdBy
created
updatedBy
updated
}
}
Variables
{"args": SaveEnabledHouseholdKeyAdviceAreaInput}
Response
{
"data": {
"saveEnabledHouseholdKeyAdviceArea": {
"householdKeyAdviceAreaId": 987,
"householdId": 123,
"practiceKeyAdviceAreaId": 987,
"enabled": true,
"status": 987,
"rank": 987,
"createdBy": "abc123",
"created": "xyz789",
"updatedBy": "abc123",
"updated": "abc123"
}
}
}
saveEstatePlanning
Response
Returns an EstatePlanningOutput
Arguments
| Name | Description |
|---|---|
args - SaveEstatePlanningInput!
|
Example
Query
mutation SaveEstatePlanning($args: SaveEstatePlanningInput!) {
saveEstatePlanning(args: $args) {
estatePlanningId
householdId
clientId
solicitorName
willInPlace
isWillCurrent
willDate
willLocation
willProvisions
healthcareDirective
healthcareDirectiveDetails
funeralArrangement
funeralDetails
prepaidFuneral
funeralExpenseValue
purchaseDate
accountNumber
productProvider
superBeneficiariesNominated
beneficiariesNominated
poaGranted
pogGranted
apoaGranted
letterOfWishes
notes
clientNotes
partnerNotes
confidentialNotes
createdBy
created
updatedBy
updated
}
}
Variables
{"args": SaveEstatePlanningInput}
Response
{
"data": {
"saveEstatePlanning": {
"estatePlanningId": 123,
"householdId": 987,
"clientId": 987,
"solicitorName": "abc123",
"willInPlace": false,
"isWillCurrent": true,
"willDate": "xyz789",
"willLocation": "abc123",
"willProvisions": "xyz789",
"healthcareDirective": true,
"healthcareDirectiveDetails": "xyz789",
"funeralArrangement": "abc123",
"funeralDetails": "abc123",
"prepaidFuneral": true,
"funeralExpenseValue": 123.45,
"purchaseDate": "abc123",
"accountNumber": "xyz789",
"productProvider": "abc123",
"superBeneficiariesNominated": false,
"beneficiariesNominated": false,
"poaGranted": false,
"pogGranted": false,
"apoaGranted": false,
"letterOfWishes": false,
"notes": "abc123",
"clientNotes": "xyz789",
"partnerNotes": "abc123",
"confidentialNotes": "xyz789",
"createdBy": "abc123",
"created": "xyz789",
"updatedBy": "xyz789",
"updated": "xyz789"
}
}
}
saveExecutor
Response
Returns an ExecutorOutput
Arguments
| Name | Description |
|---|---|
args - SaveExecutorInput!
|
Example
Query
mutation SaveExecutor($args: SaveExecutorInput!) {
saveExecutor(args: $args) {
executorId
estatePlanningId
firstName
middleName
lastName
notes
clientNotes
partnerNotes
confidentialNotes
createdBy
created
updatedBy
updated
}
}
Variables
{"args": SaveExecutorInput}
Response
{
"data": {
"saveExecutor": {
"executorId": 987,
"estatePlanningId": 987,
"firstName": "abc123",
"middleName": "xyz789",
"lastName": "xyz789",
"notes": "xyz789",
"clientNotes": "xyz789",
"partnerNotes": "xyz789",
"confidentialNotes": "abc123",
"createdBy": "xyz789",
"created": "xyz789",
"updatedBy": "xyz789",
"updated": "xyz789"
}
}
}
saveExpense
Response
Returns an ExpenseOutput
Arguments
| Name | Description |
|---|---|
args - SaveExpenseInput!
|
Example
Query
mutation SaveExpense($args: SaveExpenseInput!) {
saveExpense(args: $args) {
expenseId
householdId
clientId
clientFirstName
clientLastName
clientPreferredName
legalEntityId
legalEntityName
assetId
expenseType
expenseSubType
savingsPlanType
description
amount
amountBps
discretionaryAmount
frequency
endYear
stopAllowance
stopAllowanceAge
feeIncreaseBps
changesExpected
timeFrame
notes
clientNotes
partnerNotes
confidentialNotes
createdBy
created
updatedBy
updated
}
}
Variables
{"args": SaveExpenseInput}
Response
{
"data": {
"saveExpense": {
"expenseId": 987,
"householdId": 987,
"clientId": 987,
"clientFirstName": "xyz789",
"clientLastName": "xyz789",
"clientPreferredName": "xyz789",
"legalEntityId": 123,
"legalEntityName": "xyz789",
"assetId": 123,
"expenseType": "xyz789",
"expenseSubType": "abc123",
"savingsPlanType": "abc123",
"description": "abc123",
"amount": 987.65,
"amountBps": 123.45,
"discretionaryAmount": 987.65,
"frequency": "abc123",
"endYear": 987,
"stopAllowance": "abc123",
"stopAllowanceAge": 987,
"feeIncreaseBps": 123.45,
"changesExpected": false,
"timeFrame": "xyz789",
"notes": "xyz789",
"clientNotes": "abc123",
"partnerNotes": "abc123",
"confidentialNotes": "xyz789",
"createdBy": "abc123",
"created": "abc123",
"updatedBy": "xyz789",
"updated": "abc123"
}
}
}
saveFoundationSurvey
Response
Returns a Boolean
Arguments
| Name | Description |
|---|---|
args - SaveFoundationSurveyInput!
|
Example
Query
mutation SaveFoundationSurvey($args: SaveFoundationSurveyInput!) {
saveFoundationSurvey(args: $args)
}
Variables
{"args": SaveFoundationSurveyInput}
Response
{"data": {"saveFoundationSurvey": false}}
saveGoal
Response
Returns a GoalOutput
Arguments
| Name | Description |
|---|---|
args - GoalInput
|
Example
Query
mutation SaveGoal($args: GoalInput) {
saveGoal(args: $args) {
id
title
goalNotes
successLooksLike
targetDate
targetDatePA
targetDatePADate
targetDateApprovalStatus
completedDate
rank
supportsStrategies
supportsClientValues
supportsHouseholdValues
supportsLife {
clientId
valueGroupId
}
estimatedCost
estimatedCostPA
estimatedCostPADate
estimatedCostApprovalStatus
goalConfidence
goalProgress
strategies
goalImportance
goalCategory
goalStatus
goalStatusPA
goalStatusPADate
goalStatusApprovalStatus
recurrenceType
recurrenceTypePA
recurrenceTypePADate
recurrenceTypeApprovalStatus
recurrenceInterval
recurrenceIntervalPA
recurrenceIntervalPADate
recurrenceIntervalApprovalStatus
assignedToClientId
assignedToHouseholdId
createdForClientId
createdForHouseholdId
forApproval
approvalStatus
approvalChangeDate
createdBy
created
updatedBy
updated
preSignedGoalImageUrl
confidentialNotes
}
}
Variables
{"args": GoalInput}
Response
{
"data": {
"saveGoal": {
"id": 123,
"title": "abc123",
"goalNotes": "xyz789",
"successLooksLike": "abc123",
"targetDate": "abc123",
"targetDatePA": "xyz789",
"targetDatePADate": "abc123",
"targetDateApprovalStatus": "xyz789",
"completedDate": "xyz789",
"rank": 987,
"supportsStrategies": ["xyz789"],
"supportsClientValues": [123],
"supportsHouseholdValues": [987],
"supportsLife": [GoalLife],
"estimatedCost": 123,
"estimatedCostPA": 987,
"estimatedCostPADate": "xyz789",
"estimatedCostApprovalStatus": "xyz789",
"goalConfidence": 123,
"goalProgress": 123,
"strategies": ["abc123"],
"goalImportance": 987,
"goalCategory": 987,
"goalStatus": 987,
"goalStatusPA": 123,
"goalStatusPADate": "xyz789",
"goalStatusApprovalStatus": "abc123",
"recurrenceType": "xyz789",
"recurrenceTypePA": "abc123",
"recurrenceTypePADate": "xyz789",
"recurrenceTypeApprovalStatus": "xyz789",
"recurrenceInterval": 987,
"recurrenceIntervalPA": 987,
"recurrenceIntervalPADate": "abc123",
"recurrenceIntervalApprovalStatus": "xyz789",
"assignedToClientId": 987,
"assignedToHouseholdId": 987,
"createdForClientId": 987,
"createdForHouseholdId": 987,
"forApproval": true,
"approvalStatus": "abc123",
"approvalChangeDate": "abc123",
"createdBy": "xyz789",
"created": "xyz789",
"updatedBy": "xyz789",
"updated": "xyz789",
"preSignedGoalImageUrl": "abc123",
"confidentialNotes": "xyz789"
}
}
}
saveGoals
Response
Returns [GoalOutput]
Arguments
| Name | Description |
|---|---|
args - [GoalInput]
|
Example
Query
mutation SaveGoals($args: [GoalInput]) {
saveGoals(args: $args) {
id
title
goalNotes
successLooksLike
targetDate
targetDatePA
targetDatePADate
targetDateApprovalStatus
completedDate
rank
supportsStrategies
supportsClientValues
supportsHouseholdValues
supportsLife {
clientId
valueGroupId
}
estimatedCost
estimatedCostPA
estimatedCostPADate
estimatedCostApprovalStatus
goalConfidence
goalProgress
strategies
goalImportance
goalCategory
goalStatus
goalStatusPA
goalStatusPADate
goalStatusApprovalStatus
recurrenceType
recurrenceTypePA
recurrenceTypePADate
recurrenceTypeApprovalStatus
recurrenceInterval
recurrenceIntervalPA
recurrenceIntervalPADate
recurrenceIntervalApprovalStatus
assignedToClientId
assignedToHouseholdId
createdForClientId
createdForHouseholdId
forApproval
approvalStatus
approvalChangeDate
createdBy
created
updatedBy
updated
preSignedGoalImageUrl
confidentialNotes
}
}
Variables
{"args": [GoalInput]}
Response
{
"data": {
"saveGoals": [
{
"id": 987,
"title": "xyz789",
"goalNotes": "xyz789",
"successLooksLike": "xyz789",
"targetDate": "abc123",
"targetDatePA": "xyz789",
"targetDatePADate": "xyz789",
"targetDateApprovalStatus": "abc123",
"completedDate": "xyz789",
"rank": 123,
"supportsStrategies": ["abc123"],
"supportsClientValues": [987],
"supportsHouseholdValues": [987],
"supportsLife": [GoalLife],
"estimatedCost": 123,
"estimatedCostPA": 123,
"estimatedCostPADate": "xyz789",
"estimatedCostApprovalStatus": "abc123",
"goalConfidence": 987,
"goalProgress": 123,
"strategies": ["abc123"],
"goalImportance": 987,
"goalCategory": 987,
"goalStatus": 987,
"goalStatusPA": 987,
"goalStatusPADate": "xyz789",
"goalStatusApprovalStatus": "abc123",
"recurrenceType": "abc123",
"recurrenceTypePA": "xyz789",
"recurrenceTypePADate": "xyz789",
"recurrenceTypeApprovalStatus": "abc123",
"recurrenceInterval": 987,
"recurrenceIntervalPA": 987,
"recurrenceIntervalPADate": "abc123",
"recurrenceIntervalApprovalStatus": "xyz789",
"assignedToClientId": 987,
"assignedToHouseholdId": 123,
"createdForClientId": 123,
"createdForHouseholdId": 987,
"forApproval": true,
"approvalStatus": "xyz789",
"approvalChangeDate": "abc123",
"createdBy": "xyz789",
"created": "xyz789",
"updatedBy": "abc123",
"updated": "abc123",
"preSignedGoalImageUrl": "abc123",
"confidentialNotes": "abc123"
}
]
}
}
saveGoalsSurvey
Response
Returns a Boolean
Arguments
| Name | Description |
|---|---|
args - SaveGoalsSurveyInput!
|
Example
Query
mutation SaveGoalsSurvey($args: SaveGoalsSurveyInput!) {
saveGoalsSurvey(args: $args)
}
Variables
{"args": SaveGoalsSurveyInput}
Response
{"data": {"saveGoalsSurvey": false}}
saveHealthDetails
Response
Returns a HealthDetailsOutput
Arguments
| Name | Description |
|---|---|
args - SaveHealthDetailsInput!
|
Example
Query
mutation SaveHealthDetails($args: SaveHealthDetailsInput!) {
saveHealthDetails(args: $args) {
healthDetailsId
clientId
healthStatus
medicalHistoryIssues
isSmoker
smokePerDay
useNicotine
nicotinePerDay
useMedication
medicationDetails
medicalCondition
medicalConditionDetails
majorIllness
majorIllnessDetails
privateHealth
privateHealthDetails
sportsInterestsList
sportsInterests
sportsInterestsFrequency
notes
confidentialNotes
createdBy
created
updatedBy
updated
}
}
Variables
{"args": SaveHealthDetailsInput}
Response
{
"data": {
"saveHealthDetails": {
"healthDetailsId": 123,
"clientId": 123,
"healthStatus": "abc123",
"medicalHistoryIssues": "abc123",
"isSmoker": false,
"smokePerDay": 123,
"useNicotine": true,
"nicotinePerDay": 123,
"useMedication": true,
"medicationDetails": "abc123",
"medicalCondition": true,
"medicalConditionDetails": "abc123",
"majorIllness": true,
"majorIllnessDetails": "xyz789",
"privateHealth": true,
"privateHealthDetails": "xyz789",
"sportsInterestsList": "abc123",
"sportsInterests": "abc123",
"sportsInterestsFrequency": "abc123",
"notes": "abc123",
"confidentialNotes": "abc123",
"createdBy": "xyz789",
"created": "abc123",
"updatedBy": "xyz789",
"updated": "abc123"
}
}
}
saveHolding
Response
Returns a HoldingOutput
Arguments
| Name | Description |
|---|---|
args - SaveHoldingInput!
|
Example
Query
mutation SaveHolding($args: SaveHoldingInput!) {
saveHolding(args: $args) {
holdingId
portfolioId
securityId
ticker
description
quantity
purchasePrice
purchaseDate
averagePrice
totalCost
marketPrice
marketPriceDate
maturityDate
interestRate
paymentFrequency
currencyCode
overrideAssetTreeId
overrideSecurityGroupId
overrideSecurityTypeId
overrideSecurityStyle
createdBy
created
updatedBy
updated
}
}
Variables
{"args": SaveHoldingInput}
Response
{
"data": {
"saveHolding": {
"holdingId": 987,
"portfolioId": 123,
"securityId": 987,
"ticker": "xyz789",
"description": "abc123",
"quantity": 123.45,
"purchasePrice": 987.65,
"purchaseDate": "abc123",
"averagePrice": 987.65,
"totalCost": 123.45,
"marketPrice": 987.65,
"marketPriceDate": "abc123",
"maturityDate": "xyz789",
"interestRate": 123.45,
"paymentFrequency": "xyz789",
"currencyCode": "xyz789",
"overrideAssetTreeId": 123,
"overrideSecurityGroupId": 123,
"overrideSecurityTypeId": 123,
"overrideSecurityStyle": "xyz789",
"createdBy": "xyz789",
"created": "abc123",
"updatedBy": "xyz789",
"updated": "abc123"
}
}
}
saveHouseholdConfig
Response
Returns a HouseholdConfig
Arguments
| Name | Description |
|---|---|
args - SaveHouseholdConfig!
|
Example
Query
mutation SaveHouseholdConfig($args: SaveHouseholdConfig!) {
saveHouseholdConfig(args: $args) {
householdConfigId
householdId
configuration {
modules {
bestLife {
enabled
}
bestLifePlan {
enabled
}
goals {
enabled
}
governance {
enabled
}
healthAssessment {
enabled
}
invPrefs {
enabled
}
life {
enabled
}
strategies {
enabled
}
surveys {
enabled
}
tasks {
enabled
}
values {
enabled
}
vault {
enabled
}
wealth {
enabled
}
}
}
}
}
Variables
{"args": SaveHouseholdConfig}
Response
{
"data": {
"saveHouseholdConfig": {
"householdConfigId": 123,
"householdId": 123,
"configuration": HouseholdConfigConfiguration
}
}
}
saveHouseholdInvestmentPreferences
Response
Returns an InvestmentPreferencesOutput
Arguments
| Name | Description |
|---|---|
args - HouseholdInvestmentPreferencesInput!
|
Example
Query
mutation SaveHouseholdInvestmentPreferences($args: HouseholdInvestmentPreferencesInput!) {
saveHouseholdInvestmentPreferences(args: $args) {
client {
clientId
introVideo
customisationVideo
customisation
ethicalVideo
ethical
assetClassVideo
allocationVideo
allocationType
riskVideo
comfortableWithDownturn
costVideo
costDriven
prioritisation {
optionId
rank
}
comments
customisationVideoHelp
customisationVideoComments
ethicalVideoHelp
ethicalVideoComments
assetClassVideoHelp
assetClassVideoComments
allocationVideoHelp
allocationVideoComments
riskVideoHelp
riskVideoComments
riskDiversification
riskMarketCorrection
riskPercentageDrop
riskCapitalProtection
riskAccessCapital
riskInfluencedByReturns
riskIncreaseToMeetGoal
riskMaxDownside
riskInflation
costVideoHelp
costVideoComments
assetClassAndDiversificationVideoHelp
assetClassPreferences
assetClassPreferencesComments
assetClassRisk
assetClassRiskComments
ethicalPreferences
ethicalPreferencesComments
activePassiveVideoHelp
costWealthPriorities
riskVolatilityVideoHelp
riskTimelines
riskExperience
riskKnowledge
riskPast
riskCurrent
riskTimeframe
riskVariability
riskVolatility
riskReaction
riskTolerance
riskFuture
createdBy
created
updatedBy
updated
}
partner {
clientId
introVideo
customisationVideo
customisation
ethicalVideo
ethical
assetClassVideo
allocationVideo
allocationType
riskVideo
comfortableWithDownturn
costVideo
costDriven
prioritisation {
optionId
rank
}
comments
customisationVideoHelp
customisationVideoComments
ethicalVideoHelp
ethicalVideoComments
assetClassVideoHelp
assetClassVideoComments
allocationVideoHelp
allocationVideoComments
riskVideoHelp
riskVideoComments
riskDiversification
riskMarketCorrection
riskPercentageDrop
riskCapitalProtection
riskAccessCapital
riskInfluencedByReturns
riskIncreaseToMeetGoal
riskMaxDownside
riskInflation
costVideoHelp
costVideoComments
assetClassAndDiversificationVideoHelp
assetClassPreferences
assetClassPreferencesComments
assetClassRisk
assetClassRiskComments
ethicalPreferences
ethicalPreferencesComments
activePassiveVideoHelp
costWealthPriorities
riskVolatilityVideoHelp
riskTimelines
riskExperience
riskKnowledge
riskPast
riskCurrent
riskTimeframe
riskVariability
riskVolatility
riskReaction
riskTolerance
riskFuture
createdBy
created
updatedBy
updated
}
household {
householdId
customisation
customisationNotes
ethical
ethicalNotes
assetClassNotes
allocationType
allocationNotes
riskNotes
riskGroup
costNotes
costDriven
prioritisationNotes
commentNotes
createdBy
created
updatedBy
updated
}
}
}
Variables
{"args": HouseholdInvestmentPreferencesInput}
Response
{
"data": {
"saveHouseholdInvestmentPreferences": {
"client": InvestmentPreferences,
"partner": InvestmentPreferences,
"household": HouseholdInvestmentPreferences
}
}
}
saveHouseholdKeyAdviceArea
Response
Returns a HouseholdKeyAdviceArea
Arguments
| Name | Description |
|---|---|
args - SaveHouseholdKeyAdviceAreaInput
|
Example
Query
mutation SaveHouseholdKeyAdviceArea($args: SaveHouseholdKeyAdviceAreaInput) {
saveHouseholdKeyAdviceArea(args: $args) {
householdKeyAdviceAreaId
householdId
practiceKeyAdviceAreaId
enabled
status
rank
createdBy
created
updatedBy
updated
}
}
Variables
{"args": SaveHouseholdKeyAdviceAreaInput}
Response
{
"data": {
"saveHouseholdKeyAdviceArea": {
"householdKeyAdviceAreaId": 123,
"householdId": 123,
"practiceKeyAdviceAreaId": 987,
"enabled": true,
"status": 987,
"rank": 123,
"createdBy": "abc123",
"created": "xyz789",
"updatedBy": "abc123",
"updated": "abc123"
}
}
}
saveHouseholdKeyAdviceAreas
Response
Returns [HouseholdKeyAdviceArea]
Arguments
| Name | Description |
|---|---|
args - SaveHouseholdKeyAdviceAreasInput
|
Example
Query
mutation SaveHouseholdKeyAdviceAreas($args: SaveHouseholdKeyAdviceAreasInput) {
saveHouseholdKeyAdviceAreas(args: $args) {
householdKeyAdviceAreaId
householdId
practiceKeyAdviceAreaId
enabled
status
rank
createdBy
created
updatedBy
updated
}
}
Variables
{"args": SaveHouseholdKeyAdviceAreasInput}
Response
{
"data": {
"saveHouseholdKeyAdviceAreas": [
{
"householdKeyAdviceAreaId": 123,
"householdId": 123,
"practiceKeyAdviceAreaId": 123,
"enabled": true,
"status": 123,
"rank": 123,
"createdBy": "xyz789",
"created": "abc123",
"updatedBy": "xyz789",
"updated": "xyz789"
}
]
}
}
saveHouseholdMember
Response
Returns a HouseholdMemberOutput
Arguments
| Name | Description |
|---|---|
args - SaveHouseholdMemberInput!
|
Example
Query
mutation SaveHouseholdMember($args: SaveHouseholdMemberInput!) {
saveHouseholdMember(args: $args) {
householdMemberId
householdId
relation
firstName
middleName
lastName
dob
sex
livingAtHome
financiallyDependent
financiallyDependentUntil
notes
confidentialNotes
createdBy
created
updatedBy
updated
}
}
Variables
{"args": SaveHouseholdMemberInput}
Response
{
"data": {
"saveHouseholdMember": {
"householdMemberId": 987,
"householdId": 123,
"relation": "abc123",
"firstName": "abc123",
"middleName": "abc123",
"lastName": "xyz789",
"dob": "xyz789",
"sex": "xyz789",
"livingAtHome": false,
"financiallyDependent": false,
"financiallyDependentUntil": 987,
"notes": "abc123",
"confidentialNotes": "xyz789",
"createdBy": "abc123",
"created": "abc123",
"updatedBy": "xyz789",
"updated": "xyz789"
}
}
}
saveHouseholdStrategy
Response
Returns a HouseholdStrategy
Arguments
| Name | Description |
|---|---|
args - SaveHouseholdStrategyInput
|
Example
Query
mutation SaveHouseholdStrategy($args: SaveHouseholdStrategyInput) {
saveHouseholdStrategy(args: $args) {
householdStrategyId
householdId
practiceKeyAdviceAreaId
practiceStrategyId
strategyName
details
progress
startDate
endDate
status
targetAmount
linkedGoalIds
linkedTaskIds
createdBy
created
updatedBy
updated
confidentialNotes
}
}
Variables
{"args": SaveHouseholdStrategyInput}
Response
{
"data": {
"saveHouseholdStrategy": {
"householdStrategyId": 123,
"householdId": 987,
"practiceKeyAdviceAreaId": 123,
"practiceStrategyId": 123,
"strategyName": "xyz789",
"details": "xyz789",
"progress": 123,
"startDate": "abc123",
"endDate": "xyz789",
"status": 123,
"targetAmount": 123.45,
"linkedGoalIds": [987],
"linkedTaskIds": [987],
"createdBy": "xyz789",
"created": "abc123",
"updatedBy": "abc123",
"updated": "abc123",
"confidentialNotes": "xyz789"
}
}
}
saveIncome
Response
Returns an IncomeOutput
Arguments
| Name | Description |
|---|---|
args - SaveIncomeInput!
|
Example
Query
mutation SaveIncome($args: SaveIncomeInput!) {
saveIncome(args: $args) {
incomeId
householdId
clientId
clientFirstName
clientLastName
clientPreferredName
assetId
legalEntityId
legalEntityName
incomeType
employer
jobTitle
salary
superBps
salarySacrifice
income
frequency
incomeSubType
description
assessed
taxStatus
rateChangeBps
bonus
bonusBps
commission
commissionBps
startDate
endDate
plannedChanges
plannedChangesDescription
eligibleSocialBenefits
typeOfConcession
giftedAssets
giftedAssetsList
crn
isReceivingPayments
paymentType
benefitAmount
retirementBenefitAmount
notes
clientNotes
partnerNotes
confidentialNotes
createdBy
created
updatedBy
updated
}
}
Variables
{"args": SaveIncomeInput}
Response
{
"data": {
"saveIncome": {
"incomeId": 123,
"householdId": 987,
"clientId": 123,
"clientFirstName": "abc123",
"clientLastName": "xyz789",
"clientPreferredName": "xyz789",
"assetId": 987,
"legalEntityId": 123,
"legalEntityName": "xyz789",
"incomeType": "abc123",
"employer": "xyz789",
"jobTitle": "xyz789",
"salary": 123.45,
"superBps": 987.65,
"salarySacrifice": 987.65,
"income": 123.45,
"frequency": "abc123",
"incomeSubType": "abc123",
"description": "xyz789",
"assessed": true,
"taxStatus": "xyz789",
"rateChangeBps": 987.65,
"bonus": 123.45,
"bonusBps": 123.45,
"commission": 123.45,
"commissionBps": 987.65,
"startDate": "xyz789",
"endDate": "xyz789",
"plannedChanges": true,
"plannedChangesDescription": "abc123",
"eligibleSocialBenefits": true,
"typeOfConcession": "abc123",
"giftedAssets": true,
"giftedAssetsList": "xyz789",
"crn": "abc123",
"isReceivingPayments": false,
"paymentType": "xyz789",
"benefitAmount": 987.65,
"retirementBenefitAmount": 123.45,
"notes": "abc123",
"clientNotes": "xyz789",
"partnerNotes": "abc123",
"confidentialNotes": "abc123",
"createdBy": "xyz789",
"created": "abc123",
"updatedBy": "xyz789",
"updated": "abc123"
}
}
}
saveInsurance
Response
Returns an InsuranceOutput
Arguments
| Name | Description |
|---|---|
args - SaveInsuranceInput!
|
Example
Query
mutation SaveInsurance($args: SaveInsuranceInput!) {
saveInsurance(args: $args) {
insuranceId
householdId
clientId
legalEntityId
assetId
beneficiaryClientId
beneficiaryLegalEntityId
beneficiaryHouseholdMemberId
insuranceType
lifeInsuranceType
generalInsuranceType
insurer
description
excess
cashValue
cover
coverBps
insideSuper
ipCoverType
arSubType
premium
frequency
policyNumber
policyStatus
policyToDate
premiumIncreaseBps
payoutPeriod
payoutPeriodEnd
payoutWaitPeriod
endYear
notes
clientNotes
partnerNotes
confidentialNotes
displayName
externalId
externalSystem
insuranceYodleeMapping {
providerAccountId
additionalStatus
additionalStatusDescription
lastUpdated
isBroken
createdBy
created
updatedBy
updated
}
coverages {
insuranceCoverageId
insuranceId
lifeInsuranceType
generalInsuranceType
lifeInsuranceSubType
disabilitySubType
longTermCareSubType
otherInsuranceSubType
cover
coverBps
coverPerAnnum
ipCoverType
arSubType
payoutPeriod
payoutPeriodEnd
payoutWaitPeriod
insideSuper
endYear
deathBenefit
beneficiaryRelation
chronicCareRider
otherBeneficiary
longOrShort
monthlyBenefitAmount
totalBenefits
payoutType
payoutPeriodText
eliminationPeriod
healthcareSource
premiumTaxCredit
createdBy
created
updatedBy
updated
}
createdBy
created
updatedBy
updated
}
}
Variables
{"args": SaveInsuranceInput}
Response
{
"data": {
"saveInsurance": {
"insuranceId": 987,
"householdId": 987,
"clientId": 123,
"legalEntityId": 123,
"assetId": 123,
"beneficiaryClientId": 123,
"beneficiaryLegalEntityId": 123,
"beneficiaryHouseholdMemberId": 987,
"insuranceType": "xyz789",
"lifeInsuranceType": "abc123",
"generalInsuranceType": "abc123",
"insurer": "xyz789",
"description": "xyz789",
"excess": 987.65,
"cashValue": 987.65,
"cover": 123.45,
"coverBps": 987.65,
"insideSuper": true,
"ipCoverType": "abc123",
"arSubType": "xyz789",
"premium": 987.65,
"frequency": "abc123",
"policyNumber": "abc123",
"policyStatus": "xyz789",
"policyToDate": "abc123",
"premiumIncreaseBps": 123.45,
"payoutPeriod": "abc123",
"payoutPeriodEnd": "xyz789",
"payoutWaitPeriod": 123,
"endYear": 123,
"notes": "abc123",
"clientNotes": "xyz789",
"partnerNotes": "xyz789",
"confidentialNotes": "xyz789",
"displayName": "xyz789",
"externalId": "abc123",
"externalSystem": "IL",
"insuranceYodleeMapping": YodleeMapping,
"coverages": [InsuranceCoverageOutput],
"createdBy": "abc123",
"created": "abc123",
"updatedBy": "xyz789",
"updated": "xyz789"
}
}
}
saveInvestmentPreferences
Response
Returns an InvestmentPreferences
Arguments
| Name | Description |
|---|---|
args - InvestmentPreferencesInput!
|
Example
Query
mutation SaveInvestmentPreferences($args: InvestmentPreferencesInput!) {
saveInvestmentPreferences(args: $args) {
clientId
introVideo
customisationVideo
customisation
ethicalVideo
ethical
assetClassVideo
allocationVideo
allocationType
riskVideo
comfortableWithDownturn
costVideo
costDriven
prioritisation {
optionId
rank
}
comments
customisationVideoHelp
customisationVideoComments
ethicalVideoHelp
ethicalVideoComments
assetClassVideoHelp
assetClassVideoComments
allocationVideoHelp
allocationVideoComments
riskVideoHelp
riskVideoComments
riskDiversification
riskMarketCorrection
riskPercentageDrop
riskCapitalProtection
riskAccessCapital
riskInfluencedByReturns
riskIncreaseToMeetGoal
riskMaxDownside
riskInflation
costVideoHelp
costVideoComments
assetClassAndDiversificationVideoHelp
assetClassPreferences
assetClassPreferencesComments
assetClassRisk
assetClassRiskComments
ethicalPreferences
ethicalPreferencesComments
activePassiveVideoHelp
costWealthPriorities
riskVolatilityVideoHelp
riskTimelines
riskExperience
riskKnowledge
riskPast
riskCurrent
riskTimeframe
riskVariability
riskVolatility
riskReaction
riskTolerance
riskFuture
createdBy
created
updatedBy
updated
}
}
Variables
{"args": InvestmentPreferencesInput}
Response
{
"data": {
"saveInvestmentPreferences": {
"clientId": 987,
"introVideo": "xyz789",
"customisationVideo": "xyz789",
"customisation": "Y",
"ethicalVideo": "xyz789",
"ethical": "Y",
"assetClassVideo": "xyz789",
"allocationVideo": "abc123",
"allocationType": "S",
"riskVideo": "abc123",
"comfortableWithDownturn": "abc123",
"costVideo": "xyz789",
"costDriven": "Y",
"prioritisation": [InvestmentPreferencesRanking],
"comments": "xyz789",
"customisationVideoHelp": "Y",
"customisationVideoComments": "abc123",
"ethicalVideoHelp": "Y",
"ethicalVideoComments": "xyz789",
"assetClassVideoHelp": "Y",
"assetClassVideoComments": "xyz789",
"allocationVideoHelp": "Y",
"allocationVideoComments": "abc123",
"riskVideoHelp": "Y",
"riskVideoComments": "abc123",
"riskDiversification": 987,
"riskMarketCorrection": 123,
"riskPercentageDrop": 123,
"riskCapitalProtection": "Y",
"riskAccessCapital": 123,
"riskInfluencedByReturns": 123,
"riskIncreaseToMeetGoal": 987,
"riskMaxDownside": 987,
"riskInflation": 123,
"costVideoHelp": "Y",
"costVideoComments": "xyz789",
"assetClassAndDiversificationVideoHelp": "Y",
"assetClassPreferences": "Y",
"assetClassPreferencesComments": "abc123",
"assetClassRisk": "Y",
"assetClassRiskComments": "abc123",
"ethicalPreferences": "Y",
"ethicalPreferencesComments": "xyz789",
"activePassiveVideoHelp": "Y",
"costWealthPriorities": "A",
"riskVolatilityVideoHelp": "Y",
"riskTimelines": "Y",
"riskExperience": 987,
"riskKnowledge": 123,
"riskPast": 987,
"riskCurrent": 123,
"riskTimeframe": 123,
"riskVariability": 987,
"riskVolatility": 987,
"riskReaction": 987,
"riskTolerance": 987,
"riskFuture": 987,
"createdBy": "abc123",
"created": "xyz789",
"updatedBy": "xyz789",
"updated": "xyz789"
}
}
}
saveLegalEntity
Response
Returns a LegalEntityOutput
Arguments
| Name | Description |
|---|---|
args - SaveLegalEntityInput!
|
Example
Query
mutation SaveLegalEntity($args: SaveLegalEntityInput!) {
saveLegalEntity(args: $args) {
legalEntityId
householdId
legalEntityType
companyType
trusteeType
trustType
name
purpose
abn
tfn
value
growthBps
growthDollar
clientShare
partnerShare
clientSuperPhase
partnerSuperPhase
notes
clientNotes
partnerNotes
confidentialNotes
createdBy
created
updatedBy
updated
}
}
Variables
{"args": SaveLegalEntityInput}
Response
{
"data": {
"saveLegalEntity": {
"legalEntityId": 123,
"householdId": 987,
"legalEntityType": "xyz789",
"companyType": "xyz789",
"trusteeType": "abc123",
"trustType": "abc123",
"name": "abc123",
"purpose": "abc123",
"abn": "abc123",
"tfn": "xyz789",
"value": 987.65,
"growthBps": 123.45,
"growthDollar": 123.45,
"clientShare": 987.65,
"partnerShare": 987.65,
"clientSuperPhase": "xyz789",
"partnerSuperPhase": "abc123",
"notes": "abc123",
"clientNotes": "xyz789",
"partnerNotes": "abc123",
"confidentialNotes": "abc123",
"createdBy": "xyz789",
"created": "abc123",
"updatedBy": "xyz789",
"updated": "xyz789"
}
}
}
saveLiability
Response
Returns a LiabilityOutput
Arguments
| Name | Description |
|---|---|
args - SaveLiabilityInput!
|
Example
Query
mutation SaveLiability($args: SaveLiabilityInput!) {
saveLiability(args: $args) {
liabilityId
householdId
clientId
clientFirstName
clientLastName
clientPreferredName
clientIdPA
clientIdPADate
clientIdApprovalStatus
legalEntityId
legalEntityName
legalEntityIdPA
legalEntityIdPADate
legalEntityIdApprovalStatus
assetId
liabilityType
loanType
description
accountNumber
providerName
lender
maxLimit
originalAmount
owing
owingPA
owingPADate
owingApprovalStatus
rate
ratePA
ratePADate
rateApprovalStatus
interestRateType
repayment
repaymentPA
repaymentPADate
repaymentApprovalStatus
repaymentFrequency
repaymentFrequencyPA
repaymentFrequencyPADate
repaymentFrequencyApprovalStatus
monthlyPayment
notes
clientNotes
partnerNotes
confidentialNotes
displayName
externalSystem
liabilityYodleeMapping {
providerAccountId
additionalStatus
additionalStatusDescription
lastUpdated
isBroken
createdBy
created
updatedBy
updated
}
forApproval
approvalStatus
approvalChangeDate
createdBy
created
updatedBy
updated
}
}
Variables
{"args": SaveLiabilityInput}
Response
{
"data": {
"saveLiability": {
"liabilityId": 123,
"householdId": 987,
"clientId": 987,
"clientFirstName": "xyz789",
"clientLastName": "xyz789",
"clientPreferredName": "abc123",
"clientIdPA": 123,
"clientIdPADate": "abc123",
"clientIdApprovalStatus": "xyz789",
"legalEntityId": 987,
"legalEntityName": "abc123",
"legalEntityIdPA": 987,
"legalEntityIdPADate": "abc123",
"legalEntityIdApprovalStatus": "xyz789",
"assetId": 987,
"liabilityType": "abc123",
"loanType": "abc123",
"description": "xyz789",
"accountNumber": "abc123",
"providerName": "abc123",
"lender": "abc123",
"maxLimit": 123.45,
"originalAmount": 987.65,
"owing": 123.45,
"owingPA": 987.65,
"owingPADate": "xyz789",
"owingApprovalStatus": "xyz789",
"rate": 123.45,
"ratePA": 123.45,
"ratePADate": "abc123",
"rateApprovalStatus": "abc123",
"interestRateType": "xyz789",
"repayment": 123.45,
"repaymentPA": 987.65,
"repaymentPADate": "xyz789",
"repaymentApprovalStatus": "xyz789",
"repaymentFrequency": "abc123",
"repaymentFrequencyPA": "abc123",
"repaymentFrequencyPADate": "xyz789",
"repaymentFrequencyApprovalStatus": "xyz789",
"monthlyPayment": 987.65,
"notes": "abc123",
"clientNotes": "abc123",
"partnerNotes": "abc123",
"confidentialNotes": "abc123",
"displayName": "abc123",
"externalSystem": "IL",
"liabilityYodleeMapping": YodleeMapping,
"forApproval": true,
"approvalStatus": "abc123",
"approvalChangeDate": "xyz789",
"createdBy": "xyz789",
"created": "abc123",
"updatedBy": "xyz789",
"updated": "xyz789"
}
}
}
saveLifeNote
Response
Returns a Boolean
Arguments
| Name | Description |
|---|---|
args - LifeNoteInput!
|
Example
Query
mutation SaveLifeNote($args: LifeNoteInput!) {
saveLifeNote(args: $args)
}
Variables
{"args": LifeNoteInput}
Response
{"data": {"saveLifeNote": true}}
saveLivingDiscretionaryExpense
Response
Returns a LivingDiscretionaryExpenseOutput
Arguments
| Name | Description |
|---|---|
args - SaveLivingDiscretionaryExpenseInput!
|
Example
Query
mutation SaveLivingDiscretionaryExpense($args: SaveLivingDiscretionaryExpenseInput!) {
saveLivingDiscretionaryExpense(args: $args) {
livingDiscretionaryExpenseId
householdId
alimony
alimonyFrequency
childMaintenance
childMaintenanceFrequency
childCare
childCareFrequency
child
childFrequency
care
careFrequency
education
educationFrequency
rent
rentFrequency
associationFees
associationFeesFrequency
rates
ratesFrequency
water
waterFrequency
gardening
gardeningFrequency
homeImprovement
homeImprovementFrequency
repairs
repairsFrequency
electricity
electricityFrequency
gas
gasFrequency
groceries
groceriesFrequency
homePhone
homePhoneFrequency
cable
cableFrequency
broadband
broadbandFrequency
mobile
mobileFrequency
cleaning
cleaningFrequency
personalCare
personalCareFrequency
petCare
petCareFrequency
appliances
appliancesFrequency
homeOther
homeOtherFrequency
clothing
clothingFrequency
footwear
footwearFrequency
healthcare
healthcareFrequency
dental
dentalFrequency
healthcareOther
healthcareOtherFrequency
carTransport
carTransportFrequency
publicTransport
publicTransportFrequency
livingOther
livingOtherFrequency
memberships
membershipsFrequency
streaming
streamingFrequency
alcohol
alcoholFrequency
tobacco
tobaccoFrequency
entertainment
entertainmentFrequency
hobbies
hobbiesFrequency
vacations
vacationsFrequency
takeAway
takeAwayFrequency
gifts
giftsFrequency
donations
donationsFrequency
discretionaryOther
discretionaryOtherFrequency
notes
clientNotes
partnerNotes
confidentialNotes
createdBy
created
updatedBy
updated
}
}
Variables
{"args": SaveLivingDiscretionaryExpenseInput}
Response
{
"data": {
"saveLivingDiscretionaryExpense": {
"livingDiscretionaryExpenseId": 123,
"householdId": 123,
"alimony": 123.45,
"alimonyFrequency": "abc123",
"childMaintenance": 123.45,
"childMaintenanceFrequency": "xyz789",
"childCare": 987.65,
"childCareFrequency": "abc123",
"child": 987.65,
"childFrequency": "xyz789",
"care": 987.65,
"careFrequency": "xyz789",
"education": 987.65,
"educationFrequency": "abc123",
"rent": 987.65,
"rentFrequency": "abc123",
"associationFees": 123.45,
"associationFeesFrequency": "abc123",
"rates": 987.65,
"ratesFrequency": "abc123",
"water": 987.65,
"waterFrequency": "xyz789",
"gardening": 123.45,
"gardeningFrequency": "abc123",
"homeImprovement": 987.65,
"homeImprovementFrequency": "abc123",
"repairs": 987.65,
"repairsFrequency": "abc123",
"electricity": 123.45,
"electricityFrequency": "xyz789",
"gas": 987.65,
"gasFrequency": "abc123",
"groceries": 987.65,
"groceriesFrequency": "abc123",
"homePhone": 123.45,
"homePhoneFrequency": "abc123",
"cable": 987.65,
"cableFrequency": "abc123",
"broadband": 123.45,
"broadbandFrequency": "xyz789",
"mobile": 123.45,
"mobileFrequency": "abc123",
"cleaning": 987.65,
"cleaningFrequency": "xyz789",
"personalCare": 123.45,
"personalCareFrequency": "abc123",
"petCare": 123.45,
"petCareFrequency": "abc123",
"appliances": 987.65,
"appliancesFrequency": "xyz789",
"homeOther": 987.65,
"homeOtherFrequency": "xyz789",
"clothing": 987.65,
"clothingFrequency": "xyz789",
"footwear": 123.45,
"footwearFrequency": "abc123",
"healthcare": 123.45,
"healthcareFrequency": "abc123",
"dental": 987.65,
"dentalFrequency": "abc123",
"healthcareOther": 123.45,
"healthcareOtherFrequency": "xyz789",
"carTransport": 123.45,
"carTransportFrequency": "xyz789",
"publicTransport": 123.45,
"publicTransportFrequency": "xyz789",
"livingOther": 123.45,
"livingOtherFrequency": "xyz789",
"memberships": 123.45,
"membershipsFrequency": "abc123",
"streaming": 987.65,
"streamingFrequency": "abc123",
"alcohol": 123.45,
"alcoholFrequency": "xyz789",
"tobacco": 123.45,
"tobaccoFrequency": "xyz789",
"entertainment": 987.65,
"entertainmentFrequency": "abc123",
"hobbies": 123.45,
"hobbiesFrequency": "xyz789",
"vacations": 123.45,
"vacationsFrequency": "abc123",
"takeAway": 987.65,
"takeAwayFrequency": "xyz789",
"gifts": 123.45,
"giftsFrequency": "abc123",
"donations": 123.45,
"donationsFrequency": "abc123",
"discretionaryOther": 987.65,
"discretionaryOtherFrequency": "abc123",
"notes": "abc123",
"clientNotes": "xyz789",
"partnerNotes": "xyz789",
"confidentialNotes": "xyz789",
"createdBy": "xyz789",
"created": "abc123",
"updatedBy": "abc123",
"updated": "xyz789"
}
}
}
saveNotes
Response
Returns a Boolean
Arguments
| Name | Description |
|---|---|
args - SaveNotesInput!
|
Example
Query
mutation SaveNotes($args: SaveNotesInput!) {
saveNotes(args: $args)
}
Variables
{"args": SaveNotesInput}
Response
{"data": {"saveNotes": true}}
saveOriginationSurvey
Response
Returns a SaveOriginationSurveyOutput
Arguments
| Name | Description |
|---|---|
args - SaveOriginationSurveyInput!
|
Example
Query
mutation SaveOriginationSurvey($args: SaveOriginationSurveyInput!) {
saveOriginationSurvey(args: $args) {
LIFE {
success
errorMessage
}
FHA {
success
errorMessage
}
VALUES {
success
errorMessage
}
GOALS {
success
errorMessage
}
GOV {
success
errorMessage
}
FND {
success
errorMessage
}
IP {
success
errorMessage
}
allSuccess
}
}
Variables
{"args": SaveOriginationSurveyInput}
Response
{
"data": {
"saveOriginationSurvey": {
"LIFE": SurveyResponseStatus,
"FHA": SurveyResponseStatus,
"VALUES": SurveyResponseStatus,
"GOALS": SurveyResponseStatus,
"GOV": SurveyResponseStatus,
"FND": SurveyResponseStatus,
"IP": SurveyResponseStatus,
"allSuccess": true
}
}
}
savePortfolio
Response
Returns a PortfolioOutput
Arguments
| Name | Description |
|---|---|
args - SavePortfolioInput!
|
Example
Query
mutation SavePortfolio($args: SavePortfolioInput!) {
savePortfolio(args: $args) {
portfolioId
householdId
clientId
legalEntityId
name
type
accountNumber
riskScore
holdings {
holdingId
portfolioId
securityId
ticker
description
quantity
purchasePrice
purchaseDate
averagePrice
totalCost
marketPrice
marketPriceDate
maturityDate
interestRate
paymentFrequency
currencyCode
overrideAssetTreeId
overrideSecurityGroupId
overrideSecurityTypeId
overrideSecurityStyle
createdBy
created
updatedBy
updated
}
createdBy
created
updatedBy
updated
}
}
Variables
{"args": SavePortfolioInput}
Response
{
"data": {
"savePortfolio": {
"portfolioId": 123,
"householdId": 987,
"clientId": 123,
"legalEntityId": 123,
"name": "abc123",
"type": "xyz789",
"accountNumber": "xyz789",
"riskScore": 123.45,
"holdings": [HoldingOutput],
"createdBy": "xyz789",
"created": "abc123",
"updatedBy": "xyz789",
"updated": "abc123"
}
}
}
savePowerOf
Response
Returns a PowerOfOutput
Arguments
| Name | Description |
|---|---|
args - SavePowerOfInput!
|
Example
Query
mutation SavePowerOf($args: SavePowerOfInput!) {
savePowerOf(args: $args) {
powerOfId
estatePlanningId
powerOfType
poaTypeEnduring
poaTypeMedical
poaTypeLimited
poaTypeCare
poaTypeOther
firstName
middleName
lastName
isAlternate
notes
clientNotes
partnerNotes
confidentialNotes
createdBy
created
updatedBy
updated
}
}
Variables
{"args": SavePowerOfInput}
Response
{
"data": {
"savePowerOf": {
"powerOfId": 123,
"estatePlanningId": 987,
"powerOfType": "abc123",
"poaTypeEnduring": true,
"poaTypeMedical": false,
"poaTypeLimited": false,
"poaTypeCare": true,
"poaTypeOther": true,
"firstName": "xyz789",
"middleName": "xyz789",
"lastName": "xyz789",
"isAlternate": true,
"notes": "xyz789",
"clientNotes": "abc123",
"partnerNotes": "xyz789",
"confidentialNotes": "xyz789",
"createdBy": "xyz789",
"created": "xyz789",
"updatedBy": "abc123",
"updated": "xyz789"
}
}
}
savePractice
Response
Returns a SavePracticeOutput
Arguments
| Name | Description |
|---|---|
args - SavePracticeInput!
|
Example
Query
mutation SavePractice($args: SavePracticeInput!) {
savePractice(args: $args) {
practiceId
}
}
Variables
{"args": SavePracticeInput}
Response
{"data": {"savePractice": {"practiceId": 123}}}
savePracticeAssetAllocations
Response
Returns a Boolean
Arguments
| Name | Description |
|---|---|
args - SavePracticeAssetAllocationsInput
|
Example
Query
mutation SavePracticeAssetAllocations($args: SavePracticeAssetAllocationsInput) {
savePracticeAssetAllocations(args: $args)
}
Variables
{"args": SavePracticeAssetAllocationsInput}
Response
{"data": {"savePracticeAssetAllocations": false}}
savePracticeConfig
Response
Returns a PracticeConfig
Arguments
| Name | Description |
|---|---|
args - SavePracticeConfig!
|
Example
Query
mutation SavePracticeConfig($args: SavePracticeConfig!) {
savePracticeConfig(args: $args) {
practiceConfigId
practiceId
palette {
primary {
bgColor
fgColor
}
secondary {
bgColor
fgColor
}
buttons {
primary {
bgColor
fgColor
}
secondary {
bgColor
fgColor
}
}
backgrounds {
main {
bgColor
fgColor
}
workbench {
bgColor
fgColor
}
}
}
typography {
mainFontFamily
mainMonoFontFamily
}
configuration {
modules {
bestLife {
name
shortName
}
bestLifePlan {
name
shortName
}
foundations {
hideSwitch
defaultFull
}
goals {
name
shortName
}
governance {
name
shortName
}
healthAssessment {
name
shortName
}
invPrefs {
name
shortName
introVideoUrl
introVideoS3Filename
customisationVideoUrl
customisationVideoS3Filename
ethicalVideoUrl
ethicalVideoS3Filename
assetClassVideoUrl
assetClassVideoS3Filename
allocationVideoUrl
allocationVideoS3Filename
riskVideoUrl
riskVideoS3Filename
costVideoUrl
costVideoS3Filename
createTaskOnCompletion
}
life {
name
shortName
introVideoUrl
introVideoS3Filename
connectionsOverride
factFindOverride
createTaskOnCompletion
}
strategies {
name
categoryName
strategyName
shortName
}
surveys {
name
shortName
surveyTemplateLocationMap {
...PracticeConfigConfigurationModuleSurveysSurveyTemplateLocationMapFragment
}
}
tasks {
name
shortName
}
termsOfEngagement {
sections {
...PracticeConfigConfigurationModuleTermsOfEngagementSectionsFragment
}
}
values {
name
shortName
introVideoUrl
introVideoS3Filename
}
vault {
name
shortName
bestLifePlans
bestLifePlansEnabled
retirementDocuments
retirementDocumentsEnabled
legalDocuments
legalDocumentsEnabled
identityDocuments
identityDocumentsEnabled
estatePlanningDocuments
estatePlanningDocumentsEnabled
adviceDocuments
adviceDocumentsEnabled
taxReturns
taxReturnsEnabled
businessStructures
businessStructuresEnabled
insuranceDocuments
insuranceDocumentsEnabled
educationDocuments
educationDocumentsEnabled
otherDocuments
otherDocumentsEnabled
actionRequired
actionRequiredEnabled
folders {
...VaultFolderFragment
}
}
wealth {
name
shortName
}
netWorth {
name
shortName
}
}
notification {
emailOverrideTo
emailSender
emailSenderName
emailCC
emailSignature
disableTaskEmailNotification
}
mfa {
enforceStaffMfa
}
defaultClientSharing
lockClientDetails
inAppNotifications {
enabled
}
filterSettings {
getHouseholdsFilterSettings {
showAllClients
}
}
removeLogoWhiteBackground {
enabled
}
}
theme
}
}
Variables
{"args": SavePracticeConfig}
Response
{
"data": {
"savePracticeConfig": {
"practiceConfigId": 123,
"practiceId": 123,
"palette": PracticeConfigPalette,
"typography": PracticeConfigTypography,
"configuration": PracticeConfigConfiguration,
"theme": "abc123"
}
}
}
savePracticeIntegration
Response
Returns an Int
Arguments
| Name | Description |
|---|---|
args - SavePracticeIntegrationInput
|
Example
Query
mutation SavePracticeIntegration($args: SavePracticeIntegrationInput) {
savePracticeIntegration(args: $args)
}
Variables
{"args": SavePracticeIntegrationInput}
Response
{"data": {"savePracticeIntegration": 987}}
savePracticeKeyAdviceArea
Response
Returns a PracticeKeyAdviceArea
Arguments
| Name | Description |
|---|---|
args - SavePracticeKeyAdviceAreaInput
|
Example
Query
mutation SavePracticeKeyAdviceArea($args: SavePracticeKeyAdviceAreaInput) {
savePracticeKeyAdviceArea(args: $args) {
practiceKeyAdviceAreaId
categoryName
description
rank
muiIconName
createdBy
created
updatedBy
updated
strategies {
practiceStrategyId
practiceKeyAdviceAreaId
strategyName
details
createdBy
created
updatedBy
updated
}
}
}
Variables
{"args": SavePracticeKeyAdviceAreaInput}
Response
{
"data": {
"savePracticeKeyAdviceArea": {
"practiceKeyAdviceAreaId": 123,
"categoryName": "abc123",
"description": "xyz789",
"rank": 987,
"muiIconName": "abc123",
"createdBy": "abc123",
"created": "abc123",
"updatedBy": "abc123",
"updated": "xyz789",
"strategies": [PracticeStrategy]
}
}
}
savePracticeOffice
Response
Returns a SavePracticeOfficeOutput
Arguments
| Name | Description |
|---|---|
args - SavePracticeOfficeInput!
|
Example
Query
mutation SavePracticeOffice($args: SavePracticeOfficeInput!) {
savePracticeOffice(args: $args) {
practiceOfficeId
}
}
Variables
{"args": SavePracticeOfficeInput}
Response
{"data": {"savePracticeOffice": {"practiceOfficeId": 987}}}
savePracticeRiskProfile
Response
Returns a Boolean
Arguments
| Name | Description |
|---|---|
args - SavePracticeRiskProfileInput
|
Example
Query
mutation SavePracticeRiskProfile($args: SavePracticeRiskProfileInput) {
savePracticeRiskProfile(args: $args)
}
Variables
{"args": SavePracticeRiskProfileInput}
Response
{"data": {"savePracticeRiskProfile": false}}
savePracticeSegmentation
Response
Returns a PracticeSegmentation
Arguments
| Name | Description |
|---|---|
args - SavePracticeSegmentationInput
|
Example
Query
mutation SavePracticeSegmentation($args: SavePracticeSegmentationInput) {
savePracticeSegmentation(args: $args) {
practiceSegmentationId
segmentName
description
rank
configuration
householdCount
createdBy
created
updatedBy
updated
}
}
Variables
{"args": SavePracticeSegmentationInput}
Response
{
"data": {
"savePracticeSegmentation": {
"practiceSegmentationId": 123,
"segmentName": "abc123",
"description": "abc123",
"rank": 987,
"configuration": "xyz789",
"householdCount": 123,
"createdBy": "xyz789",
"created": "xyz789",
"updatedBy": "abc123",
"updated": "abc123"
}
}
}
savePracticeStrategy
Response
Returns a PracticeStrategy
Arguments
| Name | Description |
|---|---|
args - SavePracticeStrategyInput
|
Example
Query
mutation SavePracticeStrategy($args: SavePracticeStrategyInput) {
savePracticeStrategy(args: $args) {
practiceStrategyId
practiceKeyAdviceAreaId
strategyName
details
createdBy
created
updatedBy
updated
}
}
Variables
{"args": SavePracticeStrategyInput}
Response
{
"data": {
"savePracticeStrategy": {
"practiceStrategyId": 987,
"practiceKeyAdviceAreaId": 123,
"strategyName": "xyz789",
"details": "abc123",
"createdBy": "xyz789",
"created": "abc123",
"updatedBy": "xyz789",
"updated": "xyz789"
}
}
}
saveProfessionalContact
Response
Returns a ProfessionalContactOutput
Arguments
| Name | Description |
|---|---|
args - SaveProfessionalContactInput!
|
Example
Query
mutation SaveProfessionalContact($args: SaveProfessionalContactInput!) {
saveProfessionalContact(args: $args) {
professionalContactId
householdId
contactType
contactTypeDetails
name
company
phoneNumber
emailAddress
address
authorityToContact
relationshipQuality
notes
clientNotes
partnerNotes
confidentialNotes
createdBy
created
updatedBy
updated
}
}
Variables
{"args": SaveProfessionalContactInput}
Response
{
"data": {
"saveProfessionalContact": {
"professionalContactId": 987,
"householdId": 123,
"contactType": "abc123",
"contactTypeDetails": "abc123",
"name": "abc123",
"company": "abc123",
"phoneNumber": "abc123",
"emailAddress": "xyz789",
"address": "abc123",
"authorityToContact": true,
"relationshipQuality": "abc123",
"notes": "xyz789",
"clientNotes": "abc123",
"partnerNotes": "abc123",
"confidentialNotes": "abc123",
"createdBy": "xyz789",
"created": "abc123",
"updatedBy": "xyz789",
"updated": "abc123"
}
}
}
saveProfileImage
Response
Returns a String
Arguments
| Name | Description |
|---|---|
args - SaveProfileImageInput
|
Example
Query
mutation SaveProfileImage($args: SaveProfileImageInput) {
saveProfileImage(args: $args)
}
Variables
{"args": SaveProfileImageInput}
Response
{"data": {"saveProfileImage": "xyz789"}}
saveRetirementDetails
Response
Returns a RetirementDetailsOutput
Arguments
| Name | Description |
|---|---|
args - SaveRetirementDetailsInput!
|
Example
Query
mutation SaveRetirementDetails($args: SaveRetirementDetailsInput!) {
saveRetirementDetails(args: $args) {
retirementDetailsId
clientId
retirementAge
requiredIncome
retirementLifestyle
notes
confidentialNotes
createdBy
created
updatedBy
updated
}
}
Variables
{"args": SaveRetirementDetailsInput}
Response
{
"data": {
"saveRetirementDetails": {
"retirementDetailsId": 987,
"clientId": 987,
"retirementAge": 123,
"requiredIncome": 123.45,
"retirementLifestyle": "abc123",
"notes": "xyz789",
"confidentialNotes": "abc123",
"createdBy": "xyz789",
"created": "abc123",
"updatedBy": "xyz789",
"updated": "xyz789"
}
}
}
saveRiskProfile
Response
Returns a RiskProfileOutput
Arguments
| Name | Description |
|---|---|
args - SaveRiskProfileInput!
|
Example
Query
mutation SaveRiskProfile($args: SaveRiskProfileInput!) {
saveRiskProfile(args: $args) {
riskProfileId
householdId
clientId
legalEntityId
riskProfileAssessed
riskProfileDirected
riskProfileDirectedBy
notes
clientNotes
partnerNotes
confidentialNotes
createdBy
created
updatedBy
updated
}
}
Variables
{"args": SaveRiskProfileInput}
Response
{
"data": {
"saveRiskProfile": {
"riskProfileId": 123,
"householdId": 987,
"clientId": 123,
"legalEntityId": 987,
"riskProfileAssessed": 123,
"riskProfileDirected": 987,
"riskProfileDirectedBy": "abc123",
"notes": "xyz789",
"clientNotes": "xyz789",
"partnerNotes": "xyz789",
"confidentialNotes": "xyz789",
"createdBy": "xyz789",
"created": "abc123",
"updatedBy": "abc123",
"updated": "abc123"
}
}
}
saveScenario
Response
Returns a BestLifeProjectionOutput
Arguments
| Name | Description |
|---|---|
args - BestLifeProjectionInput
|
Example
Query
mutation SaveScenario($args: BestLifeProjectionInput) {
saveScenario(args: $args) {
scenarioId
name
timeline {
data
}
chart {
data
chartSchema
timeMarkers
dataMarkers
}
latestInputs {
data {
scenarioId
name
includeClient
clientAge
clientIncome
clientSuperannuation
clientSuperannuationContribution
clientSuperannuationContributionIsInDollars
clientSuperannuationMatchBps
clientSuperannuationMatchEndsBps
clientSuperannuationFee
clientSuperannuationFeeIsInDollars
clientSuperOther
clientSuperOtherContribution
clientSuperOtherContributionIsInDollars
clientSuperOtherFee
clientSuperOtherFeeIsInDollars
clientRetirementAge
clientPensionPaidFromAge
clientLifeExpectancyAge
clientIncomeRateChange
includePartner
partnerAge
partnerIncome
partnerSuperannuation
partnerSuperannuationContribution
partnerSuperannuationContributionIsInDollars
partnerSuperannuationMatchBps
partnerSuperannuationMatchEndsBps
partnerSuperannuationFee
partnerSuperannuationFeeIsInDollars
partnerSuperOther
partnerSuperOtherContribution
partnerSuperOtherContributionIsInDollars
partnerSuperOtherFee
partnerSuperOtherFeeIsInDollars
partnerRetirementAge
partnerPensionPaidFromAge
partnerLifeExpectancyAge
partnerIncomeRateChange
businessValueGrowthPerAnnum
businessValue
businessEstimatedDateOfSale
businessEstimatedSaleAmount
businessEstimatedTaxOnSale
householdPersonalAssets
householdPersonalDebt
householdProperty
householdPropertyDebt
householdInvestmentProperties
householdInvestmentPropertiesDebt
householdNonSuperInvestments
householdNonSuperInvestmentsFee
householdNonSuperInvestmentsFeeIsInDollars
householdPreRetirementAvgTax
householdPostRetirementAvgTax
householdIncome
householdSavings
householdCashFlow {
id
year
clientAge
clientIncome
clientStatus
partnerAge
partnerIncome
partnerStatus
householdIncome
totalIncome
incomeSaved
incomeSpent
reqRetirementIncome
contribution
withdrawal
}
householdCashFlowHeader
reqRetirementIncome
reqRetirementIncomeRateChange
referenceModel
bestLifeScore
excessCashAllocations {
allocationEnabled
allocationType
allocationRank
maxAmountDollar
maxAmountBps
}
reduceShortfallAllocations {
allocationEnabled
allocationType
allocationRank
maxAmountDollar
maxAmountBps
}
}
}
report {
data
}
}
}
Variables
{"args": BestLifeProjectionInput}
Response
{
"data": {
"saveScenario": {
"scenarioId": 123,
"name": "xyz789",
"timeline": BestLifeProjectionTimelineData,
"chart": BestLifeProjectionChartData,
"latestInputs": BestLifeProjectionLatestInputsData,
"report": BestLifeReportData
}
}
}
saveSensitiveDetails
Response
Returns a SensitiveDetailsOutput
Arguments
| Name | Description |
|---|---|
args - SaveSensitiveDetailsInput!
|
Example
Query
mutation SaveSensitiveDetails($args: SaveSensitiveDetailsInput!) {
saveSensitiveDetails(args: $args) {
sensitiveDetailsId
clientId
isPep
isVulnerable
notes
confidentialNotes
createdBy
created
updatedBy
updated
}
}
Variables
{"args": SaveSensitiveDetailsInput}
Response
{
"data": {
"saveSensitiveDetails": {
"sensitiveDetailsId": 123,
"clientId": 987,
"isPep": false,
"isVulnerable": true,
"notes": "xyz789",
"confidentialNotes": "xyz789",
"createdBy": "abc123",
"created": "abc123",
"updatedBy": "xyz789",
"updated": "abc123"
}
}
}
saveStaff
Response
Returns a SaveStaffOutput
Arguments
| Name | Description |
|---|---|
args - SaveStaffInput!
|
Example
Query
mutation SaveStaff($args: SaveStaffInput!) {
saveStaff(args: $args) {
staffId
practiceOfficeId
}
}
Variables
{"args": SaveStaffInput}
Response
{"data": {"saveStaff": {"staffId": 123, "practiceOfficeId": 123}}}
saveStaffConfig
Response
Returns a StaffConfig
Arguments
| Name | Description |
|---|---|
args - SaveStaffConfig!
|
Example
Query
mutation SaveStaffConfig($args: SaveStaffConfig!) {
saveStaffConfig(args: $args) {
staffConfigId
staffId
configuration {
modules {
bestLife {
enabled
}
bestLifePlan {
enabled
}
goals {
enabled
}
governance {
enabled
}
healthAssessment {
enabled
}
invPrefs {
enabled
}
life {
enabled
}
strategies {
enabled
}
surveys {
enabled
}
tasks {
enabled
}
values {
enabled
}
vault {
enabled
}
wealth {
enabled
}
}
inAppNotifications {
enabled
}
filterSettings {
getHouseholdsFilterSettings {
showAllClients
}
}
globalSearchBarSettings {
showAllClients
}
recentlyViewed {
households {
householdId
householdName
avatars {
...StaffConfigConfigurationRecentlyViewedClientAvatarFragment
}
}
}
}
}
}
Variables
{"args": SaveStaffConfig}
Response
{
"data": {
"saveStaffConfig": {
"staffConfigId": 987,
"staffId": 123,
"configuration": StaffConfigConfiguration
}
}
}
saveSuperBeneficiary
Response
Returns a SuperBeneficiaryOutput
Arguments
| Name | Description |
|---|---|
args - SaveSuperBeneficiaryInput!
|
Example
Query
mutation SaveSuperBeneficiary($args: SaveSuperBeneficiaryInput!) {
saveSuperBeneficiary(args: $args) {
superBeneficiaryId
legalEntityId
assetId
isPrimary
name
relation
nominated
beneficiaryType
ends
amount
percent
estate
estateAmount
estateBps
notes
clientNotes
partnerNotes
confidentialNotes
createdBy
created
updatedBy
updated
}
}
Variables
{"args": SaveSuperBeneficiaryInput}
Response
{
"data": {
"saveSuperBeneficiary": {
"superBeneficiaryId": 987,
"legalEntityId": 123,
"assetId": 987,
"isPrimary": true,
"name": "xyz789",
"relation": "xyz789",
"nominated": true,
"beneficiaryType": "abc123",
"ends": "xyz789",
"amount": 123.45,
"percent": 123.45,
"estate": "abc123",
"estateAmount": 123.45,
"estateBps": 987.65,
"notes": "abc123",
"clientNotes": "xyz789",
"partnerNotes": "abc123",
"confidentialNotes": "abc123",
"createdBy": "xyz789",
"created": "xyz789",
"updatedBy": "xyz789",
"updated": "abc123"
}
}
}
saveSurvey
Response
Returns a SaveSurveyOutput
Arguments
| Name | Description |
|---|---|
args - SaveSurveyInput
|
Example
Query
mutation SaveSurvey($args: SaveSurveyInput) {
saveSurvey(args: $args) {
success
message
}
}
Variables
{"args": SaveSurveyInput}
Response
{
"data": {
"saveSurvey": {
"success": false,
"message": "xyz789"
}
}
}
saveTask
Response
Returns a TaskOutput
Arguments
| Name | Description |
|---|---|
args - SaveTaskInput!
|
Example
Query
mutation SaveTask($args: SaveTaskInput!) {
saveTask(args: $args) {
id
title
order
description
dueDate
completedDate
status
assignedToClientId
createdForHouseholdId
createdBy
created
updatedBy
updated
}
}
Variables
{"args": SaveTaskInput}
Response
{
"data": {
"saveTask": {
"id": 123,
"title": "xyz789",
"order": 123,
"description": "xyz789",
"dueDate": "abc123",
"completedDate": "abc123",
"status": "abc123",
"assignedToClientId": 123,
"createdForHouseholdId": 123,
"createdBy": "xyz789",
"created": "xyz789",
"updatedBy": "xyz789",
"updated": "xyz789"
}
}
}
saveTasks
Response
Returns [TaskOutput]
Arguments
| Name | Description |
|---|---|
args - SaveTasksInput!
|
Example
Query
mutation SaveTasks($args: SaveTasksInput!) {
saveTasks(args: $args) {
id
title
order
description
dueDate
completedDate
status
assignedToClientId
createdForHouseholdId
createdBy
created
updatedBy
updated
}
}
Variables
{"args": SaveTasksInput}
Response
{
"data": {
"saveTasks": [
{
"id": 123,
"title": "xyz789",
"order": 987,
"description": "xyz789",
"dueDate": "abc123",
"completedDate": "xyz789",
"status": "abc123",
"assignedToClientId": 123,
"createdForHouseholdId": 123,
"createdBy": "abc123",
"created": "xyz789",
"updatedBy": "abc123",
"updated": "abc123"
}
]
}
}
saveTaxDetails
Response
Returns a TaxDetailsOutput
Arguments
| Name | Description |
|---|---|
args - SaveTaxDetailsInput!
|
Example
Query
mutation SaveTaxDetails($args: SaveTaxDetailsInput!) {
saveTaxDetails(args: $args) {
taxDetailsId
clientId
tfn
countryCodeTax
stateCodeTax
familyTaxBenefit
notes
confidentialNotes
createdBy
created
updatedBy
updated
}
}
Variables
{"args": SaveTaxDetailsInput}
Response
{
"data": {
"saveTaxDetails": {
"taxDetailsId": 123,
"clientId": 987,
"tfn": "abc123",
"countryCodeTax": "abc123",
"stateCodeTax": "xyz789",
"familyTaxBenefit": false,
"notes": "xyz789",
"confidentialNotes": "xyz789",
"createdBy": "xyz789",
"created": "xyz789",
"updatedBy": "abc123",
"updated": "xyz789"
}
}
}
saveTaxPlanning
Response
Returns a TaxPlanningOutput
Arguments
| Name | Description |
|---|---|
args - SaveTaxPlanningInput!
|
Example
Query
mutation SaveTaxPlanning($args: SaveTaxPlanningInput!) {
saveTaxPlanning(args: $args) {
taxPlanningId
householdId
clientId
legalEntityId
significantChangesImpact
description
createdBy
created
updatedBy
updated
}
}
Variables
{"args": SaveTaxPlanningInput}
Response
{
"data": {
"saveTaxPlanning": {
"taxPlanningId": 123,
"householdId": 123,
"clientId": 123,
"legalEntityId": 123,
"significantChangesImpact": true,
"description": "abc123",
"createdBy": "xyz789",
"created": "abc123",
"updatedBy": "abc123",
"updated": "abc123"
}
}
}
saveTrustBeneficiary
Response
Returns a TrustBeneficiaryOutput
Arguments
| Name | Description |
|---|---|
args - SaveTrustBeneficiaryInput!
|
Example
Query
mutation SaveTrustBeneficiary($args: SaveTrustBeneficiaryInput!) {
saveTrustBeneficiary(args: $args) {
trustBeneficiaryId
legalEntityId
isPrimary
firstName
middleName
lastName
companyName
nominatedPercentage
notes
clientNotes
partnerNotes
confidentialNotes
createdBy
created
updatedBy
updated
}
}
Variables
{"args": SaveTrustBeneficiaryInput}
Response
{
"data": {
"saveTrustBeneficiary": {
"trustBeneficiaryId": 987,
"legalEntityId": 987,
"isPrimary": false,
"firstName": "abc123",
"middleName": "abc123",
"lastName": "abc123",
"companyName": "xyz789",
"nominatedPercentage": 123.45,
"notes": "abc123",
"clientNotes": "abc123",
"partnerNotes": "abc123",
"confidentialNotes": "abc123",
"createdBy": "xyz789",
"created": "abc123",
"updatedBy": "abc123",
"updated": "abc123"
}
}
}
saveTrustee
Response
Returns a TrusteeOutput
Arguments
| Name | Description |
|---|---|
args - SaveTrusteeInput!
|
Example
Query
mutation SaveTrustee($args: SaveTrusteeInput!) {
saveTrustee(args: $args) {
trusteeId
legalEntityId
trusteeType
firstName
middleName
lastName
companyName
dateAppointed
notes
clientNotes
partnerNotes
confidentialNotes
createdBy
created
updatedBy
updated
}
}
Variables
{"args": SaveTrusteeInput}
Response
{
"data": {
"saveTrustee": {
"trusteeId": 123,
"legalEntityId": 987,
"trusteeType": "xyz789",
"firstName": "abc123",
"middleName": "xyz789",
"lastName": "xyz789",
"companyName": "xyz789",
"dateAppointed": "abc123",
"notes": "abc123",
"clientNotes": "xyz789",
"partnerNotes": "abc123",
"confidentialNotes": "abc123",
"createdBy": "abc123",
"created": "xyz789",
"updatedBy": "xyz789",
"updated": "xyz789"
}
}
}
saveYourLife
Response
Returns a String
Arguments
| Name | Description |
|---|---|
life - LifeInput!
|
Example
Query
mutation SaveYourLife($life: LifeInput!) {
saveYourLife(life: $life)
}
Variables
{"life": LifeInput}
Response
{"data": {"saveYourLife": "xyz789"}}
saveYourValues
Response
Returns a ClientAndHouseholdValues
Arguments
| Name | Description |
|---|---|
args - ClientAndHouseholdValuesInput!
|
Example
Query
mutation SaveYourValues($args: ClientAndHouseholdValuesInput!) {
saveYourValues(args: $args) {
client {
id
clientId
regrets {
id
regret
createdBy
created
updatedBy
updated
}
values {
id
cardId
rank
meaningReason
progressAction
createdBy
created
updatedBy
updated
}
createdBy
created
updatedBy
updated
}
partner {
id
clientId
regrets {
id
regret
createdBy
created
updatedBy
updated
}
values {
id
cardId
rank
meaningReason
progressAction
createdBy
created
updatedBy
updated
}
createdBy
created
updatedBy
updated
}
household {
id
householdId
values {
id
cardId
clientId
rank
notes
progress
description
nextSteps {
id
title
notes
assignedToClientId
createdBy
created
updatedBy
updated
}
householdMemberProgress {
id
description
progress
clientId
createdBy
created
updatedBy
updated
}
createdBy
created
updatedBy
updated
}
createdBy
created
updatedBy
updated
}
completed
}
}
Variables
{"args": ClientAndHouseholdValuesInput}
Response
{
"data": {
"saveYourValues": {
"client": ClientValues,
"partner": ClientValues,
"household": HouseholdValues,
"completed": true
}
}
}
setPracticeBilling
Response
Returns a Boolean
Arguments
| Name | Description |
|---|---|
args - SetPracticeBillingInput!
|
Example
Query
mutation SetPracticeBilling($args: SetPracticeBillingInput!) {
setPracticeBilling(args: $args)
}
Variables
{"args": SetPracticeBillingInput}
Response
{"data": {"setPracticeBilling": false}}
setPracticeLogo
Response
Returns a Boolean
Arguments
| Name | Description |
|---|---|
setPracticeLogoInput - SetPracticeLogoInput!
|
Example
Query
mutation SetPracticeLogo($setPracticeLogoInput: SetPracticeLogoInput!) {
setPracticeLogo(setPracticeLogoInput: $setPracticeLogoInput)
}
Variables
{"setPracticeLogoInput": SetPracticeLogoInput}
Response
{"data": {"setPracticeLogo": false}}
signUpPractice
Response
Returns a Boolean
Arguments
| Name | Description |
|---|---|
args - SignUpPracticeInput!
|
Example
Query
mutation SignUpPractice($args: SignUpPracticeInput!) {
signUpPractice(args: $args)
}
Variables
{"args": SignUpPracticeInput}
Response
{"data": {"signUpPractice": false}}
signUpPracticeTrial
Response
Returns a Boolean
Arguments
| Name | Description |
|---|---|
args - SignUpPracticeTrialInput!
|
Example
Query
mutation SignUpPracticeTrial($args: SignUpPracticeTrialInput!) {
signUpPracticeTrial(args: $args)
}
Variables
{"args": SignUpPracticeTrialInput}
Response
{"data": {"signUpPracticeTrial": false}}
softDeleteClient
Response
Returns a SoftDeleteClientOutput
Arguments
| Name | Description |
|---|---|
args - SoftDeleteClientInput!
|
Example
Query
mutation SoftDeleteClient($args: SoftDeleteClientInput!) {
softDeleteClient(args: $args) {
softDeletedEmail
clientActiveStatus
updateMsg
}
}
Variables
{"args": SoftDeleteClientInput}
Response
{
"data": {
"softDeleteClient": {
"softDeletedEmail": "xyz789",
"clientActiveStatus": "xyz789",
"updateMsg": "xyz789"
}
}
}
sortPracticeConfigVaultFolders
Response
Returns [VaultFolder]
Arguments
| Name | Description |
|---|---|
args - SortVaultFoldersInput!
|
Example
Query
mutation SortPracticeConfigVaultFolders($args: SortVaultFoldersInput!) {
sortPracticeConfigVaultFolders(args: $args) {
id
name
order
enabled
readonly
}
}
Variables
{"args": SortVaultFoldersInput}
Response
{
"data": {
"sortPracticeConfigVaultFolders": [
{
"id": "abc123",
"name": "xyz789",
"order": 123,
"enabled": true,
"readonly": true
}
]
}
}
updateExternalUploadTracking
Response
Returns an ExternalUploadTracking
Arguments
| Name | Description |
|---|---|
input - UpdateExternalUploadTrackingInput!
|
|
condition - ModelExternalUploadTrackingConditionInput
|
Example
Query
mutation UpdateExternalUploadTracking(
$input: UpdateExternalUploadTrackingInput!,
$condition: ModelExternalUploadTrackingConditionInput
) {
updateExternalUploadTracking(
input: $input,
condition: $condition
) {
id
fullS3ObjectPath
identityId
objectKey
practiceId
clientId
goalId
createdAt
updatedAt
}
}
Variables
{
"input": UpdateExternalUploadTrackingInput,
"condition": ModelExternalUploadTrackingConditionInput
}
Response
{
"data": {
"updateExternalUploadTracking": {
"id": 4,
"fullS3ObjectPath": "xyz789",
"identityId": "abc123",
"objectKey": "xyz789",
"practiceId": 123,
"clientId": 123,
"goalId": 123,
"createdAt": AWSDateTime,
"updatedAt": AWSDateTime
}
}
}
updateFinancialHealthAssessmentSession
Response
Returns a FinancialHealthAssessmentSession
Arguments
| Name | Description |
|---|---|
input - UpdateFinancialHealthAssessmentSessionInput!
|
|
condition - ModelFinancialHealthAssessmentSessionConditionInput
|
Example
Query
mutation UpdateFinancialHealthAssessmentSession(
$input: UpdateFinancialHealthAssessmentSessionInput!,
$condition: ModelFinancialHealthAssessmentSessionConditionInput
) {
updateFinancialHealthAssessmentSession(
input: $input,
condition: $condition
) {
id
clientId
inviteCode
householdId
status
firstName
lastName
fullName
hasPartner
partnerId
partnerFirstName
partnerLastName
partnerFullName
finHealthAssessmentFull
responses {
questionId
intResponse
stringResponse
section
}
visionGoalsScore
retirementPlanningScore
insuranceAssetProtectionScore
debtCashFlowManagementScore
educationPlanningScore
investmentPlanningScore
incomeTaxPlanningScore
businessPlanningScore
charitablePlanningScore
estatePlanningScore
createdAt
updatedAt
}
}
Variables
{
"input": UpdateFinancialHealthAssessmentSessionInput,
"condition": ModelFinancialHealthAssessmentSessionConditionInput
}
Response
{
"data": {
"updateFinancialHealthAssessmentSession": {
"id": 4,
"clientId": 987,
"inviteCode": "xyz789",
"householdId": 987,
"status": "abc123",
"firstName": "abc123",
"lastName": "xyz789",
"fullName": "xyz789",
"hasPartner": false,
"partnerId": 987,
"partnerFirstName": "abc123",
"partnerLastName": "abc123",
"partnerFullName": "xyz789",
"finHealthAssessmentFull": false,
"responses": [FHAResponse],
"visionGoalsScore": 123,
"retirementPlanningScore": 123,
"insuranceAssetProtectionScore": 987,
"debtCashFlowManagementScore": 123,
"educationPlanningScore": 987,
"investmentPlanningScore": 123,
"incomeTaxPlanningScore": 123,
"businessPlanningScore": 987,
"charitablePlanningScore": 123,
"estatePlanningScore": 123,
"createdAt": AWSDateTime,
"updatedAt": AWSDateTime
}
}
}
updateGoalsSession
Response
Returns a GoalsSession
Arguments
| Name | Description |
|---|---|
input - UpdateGoalsSessionInput!
|
|
condition - ModelGoalsSessionConditionInput
|
Example
Query
mutation UpdateGoalsSession(
$input: UpdateGoalsSessionInput!,
$condition: ModelGoalsSessionConditionInput
) {
updateGoalsSession(
input: $input,
condition: $condition
) {
id
clientId
inviteCode
selectedGoalCategoryIds
createdAt
updatedAt
}
}
Variables
{
"input": UpdateGoalsSessionInput,
"condition": ModelGoalsSessionConditionInput
}
Response
{
"data": {
"updateGoalsSession": {
"id": "4",
"clientId": 123,
"inviteCode": "abc123",
"selectedGoalCategoryIds": [123],
"createdAt": AWSDateTime,
"updatedAt": AWSDateTime
}
}
}
updateHouseholdPackage
Response
Returns a Boolean
Arguments
| Name | Description |
|---|---|
args - UpdateHouseholdPackageInput!
|
Example
Query
mutation UpdateHouseholdPackage($args: UpdateHouseholdPackageInput!) {
updateHouseholdPackage(args: $args)
}
Variables
{"args": UpdateHouseholdPackageInput}
Response
{"data": {"updateHouseholdPackage": true}}
updateInvestmentPreferencesSession
Response
Returns an InvestmentPreferencesSession
Arguments
| Name | Description |
|---|---|
input - UpdateInvestmentPreferencesSessionInput!
|
|
condition - ModelInvestmentPreferencesSessionConditionInput
|
Example
Query
mutation UpdateInvestmentPreferencesSession(
$input: UpdateInvestmentPreferencesSessionInput!,
$condition: ModelInvestmentPreferencesSessionConditionInput
) {
updateInvestmentPreferencesSession(
input: $input,
condition: $condition
) {
id
clientId
inviteCode
fullName
status
introVideo
customisationVideo
customisation
ethicalVideo
ethical
assetClassVideo
allocationVideo
allocationType
riskVideo
comfortableWithDownturn
costVideo
costDriven
prioritisation {
optionId
rank
}
comments
customisationVideoHelp
customisationVideoComments
ethicalVideoHelp
ethicalVideoComments
assetClassVideoHelp
assetClassVideoComments
allocationVideoHelp
allocationVideoComments
riskVideoHelp
riskVideoComments
riskDiversification
riskMarketCorrection
riskPercentageDrop
riskCapitalProtection
riskAccessCapital
riskInfluencedByReturns
riskIncreaseToMeetGoal
riskMaxDownside
riskInflation
costVideoHelp
costVideoComments
assetClassAndDiversificationVideoHelp
assetClassPreferences
assetClassPreferencesComments
assetClassRisk
assetClassRiskComments
ethicalPreferences
ethicalPreferencesComments
activePassiveVideoHelp
costWealthPriorities
riskVolatilityVideoHelp
riskTimelines
riskExperience
riskKnowledge
riskPast
riskCurrent
riskTimeframe
riskVariability
riskVolatility
riskReaction
riskTolerance
riskFuture
includeRiskSection
includeIntroSection
includeCustomisationSection
includeEthicalSection
includeAssetClassSection
includeAllocationSection
includeCostSection
includePrioritisationSection
includeCommentsSection
createdAt
updatedAt
}
}
Variables
{
"input": UpdateInvestmentPreferencesSessionInput,
"condition": ModelInvestmentPreferencesSessionConditionInput
}
Response
{
"data": {
"updateInvestmentPreferencesSession": {
"id": "4",
"clientId": 987,
"inviteCode": "abc123",
"fullName": "abc123",
"status": "xyz789",
"introVideo": "xyz789",
"customisationVideo": "xyz789",
"customisation": "Y",
"ethicalVideo": "abc123",
"ethical": "Y",
"assetClassVideo": "xyz789",
"allocationVideo": "xyz789",
"allocationType": "S",
"riskVideo": "xyz789",
"comfortableWithDownturn": "abc123",
"costVideo": "xyz789",
"costDriven": "Y",
"prioritisation": [InvestmentPreferencesRanking],
"comments": "xyz789",
"customisationVideoHelp": "Y",
"customisationVideoComments": "abc123",
"ethicalVideoHelp": "Y",
"ethicalVideoComments": "xyz789",
"assetClassVideoHelp": "Y",
"assetClassVideoComments": "xyz789",
"allocationVideoHelp": "Y",
"allocationVideoComments": "abc123",
"riskVideoHelp": "Y",
"riskVideoComments": "abc123",
"riskDiversification": 987,
"riskMarketCorrection": 123,
"riskPercentageDrop": 123,
"riskCapitalProtection": "Y",
"riskAccessCapital": 123,
"riskInfluencedByReturns": 123,
"riskIncreaseToMeetGoal": 987,
"riskMaxDownside": 123,
"riskInflation": 123,
"costVideoHelp": "Y",
"costVideoComments": "abc123",
"assetClassAndDiversificationVideoHelp": "Y",
"assetClassPreferences": "Y",
"assetClassPreferencesComments": "xyz789",
"assetClassRisk": "Y",
"assetClassRiskComments": "abc123",
"ethicalPreferences": "Y",
"ethicalPreferencesComments": "xyz789",
"activePassiveVideoHelp": "Y",
"costWealthPriorities": "A",
"riskVolatilityVideoHelp": "Y",
"riskTimelines": "Y",
"riskExperience": 987,
"riskKnowledge": 123,
"riskPast": 123,
"riskCurrent": 987,
"riskTimeframe": 987,
"riskVariability": 123,
"riskVolatility": 987,
"riskReaction": 987,
"riskTolerance": 987,
"riskFuture": 987,
"includeRiskSection": false,
"includeIntroSection": true,
"includeCustomisationSection": false,
"includeEthicalSection": true,
"includeAssetClassSection": false,
"includeAllocationSection": true,
"includeCostSection": true,
"includePrioritisationSection": true,
"includeCommentsSection": true,
"createdAt": AWSDateTime,
"updatedAt": AWSDateTime
}
}
}
updateModuleState
Response
Returns a Boolean
Arguments
| Name | Description |
|---|---|
updateModuleStateInput - UpdateModuleStateInput
|
Example
Query
mutation UpdateModuleState($updateModuleStateInput: UpdateModuleStateInput) {
updateModuleState(updateModuleStateInput: $updateModuleStateInput)
}
Variables
{"updateModuleStateInput": UpdateModuleStateInput}
Response
{"data": {"updateModuleState": false}}
updateNotification
Response
Returns a Notification
Arguments
| Name | Description |
|---|---|
input - UpdateNotificationInput!
|
|
condition - ModelNotificationConditionInput
|
Example
Query
mutation UpdateNotification(
$input: UpdateNotificationInput!,
$condition: ModelNotificationConditionInput
) {
updateNotification(
input: $input,
condition: $condition
) {
id
owner
recipient
message
messageRead
createdAt
updatedAt
}
}
Variables
{
"input": UpdateNotificationInput,
"condition": ModelNotificationConditionInput
}
Response
{
"data": {
"updateNotification": {
"id": "4",
"owner": "xyz789",
"recipient": "abc123",
"message": "xyz789",
"messageRead": true,
"createdAt": AWSDateTime,
"updatedAt": AWSDateTime
}
}
}
updateNotificationPointer
Response
Returns a NotificationPointer
Arguments
| Name | Description |
|---|---|
input - UpdateNotificationPointerInput!
|
|
condition - ModelNotificationPointerConditionInput
|
Example
Query
mutation UpdateNotificationPointer(
$input: UpdateNotificationPointerInput!,
$condition: ModelNotificationPointerConditionInput
) {
updateNotificationPointer(
input: $input,
condition: $condition
) {
id
owner
recipient
notificationId
createdAt
updatedAt
}
}
Variables
{
"input": UpdateNotificationPointerInput,
"condition": ModelNotificationPointerConditionInput
}
Response
{
"data": {
"updateNotificationPointer": {
"id": "4",
"owner": "xyz789",
"recipient": "xyz789",
"notificationId": "abc123",
"createdAt": AWSDateTime,
"updatedAt": AWSDateTime
}
}
}
updateOriginationSession
Response
Returns an OriginationSession
Arguments
| Name | Description |
|---|---|
input - UpdateOriginationSessionInput!
|
|
condition - ModelOriginationSessionConditionInput
|
Example
Query
mutation UpdateOriginationSession(
$input: UpdateOriginationSessionInput!,
$condition: ModelOriginationSessionConditionInput
) {
updateOriginationSession(
input: $input,
condition: $condition
) {
id
clientId
inviteCode
householdId
status
clientFirstName
clientLastName
clientFullName
hasPartner
partnerId
partnerFirstName
partnerLastName
partnerFullName
questionnaires
lifeIncGoals
lifeIncConnections
lifeIncFinancialDetails
finHealthAssessmentFull
foundationsFull
valuesInc3Things
governanceIncPersonalDetails
governanceIncAssetsLiabilitiesIncomeExpenses
governanceIncInsurance
governanceIncBusinessPlanning
governanceIncEducationPlanning
governanceIncCharitablePlanning
governanceIncTaxPlanning
governanceIncEstatePlanning
investmentPreferencesIncRiskSection
investmentPreferencesIncIntroSection
investmentPreferencesIncCustomisationSection
investmentPreferencesIncEthicalSection
investmentPreferencesIncAssetClassSection
investmentPreferencesIncAllocationSection
investmentPreferencesIncCostSection
investmentPreferencesIncPrioritisationSection
investmentPreferencesIncCommentsSection
uploadFileList {
prefix
folder
fileName
share
}
uploadIdentity
stepTracker {
questionId
sectionId
questionnaireStep
questionnaire
}
completedQuestionnaires
failedQuestionnaires
createdAt
updatedAt
}
}
Variables
{
"input": UpdateOriginationSessionInput,
"condition": ModelOriginationSessionConditionInput
}
Response
{
"data": {
"updateOriginationSession": {
"id": "4",
"clientId": 123,
"inviteCode": "xyz789",
"householdId": 987,
"status": "abc123",
"clientFirstName": "abc123",
"clientLastName": "xyz789",
"clientFullName": "abc123",
"hasPartner": false,
"partnerId": 123,
"partnerFirstName": "abc123",
"partnerLastName": "abc123",
"partnerFullName": "abc123",
"questionnaires": ["LIFE"],
"lifeIncGoals": true,
"lifeIncConnections": true,
"lifeIncFinancialDetails": true,
"finHealthAssessmentFull": false,
"foundationsFull": true,
"valuesInc3Things": false,
"governanceIncPersonalDetails": false,
"governanceIncAssetsLiabilitiesIncomeExpenses": true,
"governanceIncInsurance": true,
"governanceIncBusinessPlanning": false,
"governanceIncEducationPlanning": true,
"governanceIncCharitablePlanning": false,
"governanceIncTaxPlanning": false,
"governanceIncEstatePlanning": false,
"investmentPreferencesIncRiskSection": false,
"investmentPreferencesIncIntroSection": false,
"investmentPreferencesIncCustomisationSection": false,
"investmentPreferencesIncEthicalSection": true,
"investmentPreferencesIncAssetClassSection": true,
"investmentPreferencesIncAllocationSection": false,
"investmentPreferencesIncCostSection": false,
"investmentPreferencesIncPrioritisationSection": true,
"investmentPreferencesIncCommentsSection": true,
"uploadFileList": [UploadVaultFileInfo],
"uploadIdentity": "abc123",
"stepTracker": StepTracker,
"completedQuestionnaires": ["LIFE"],
"failedQuestionnaires": ["LIFE"],
"createdAt": AWSDateTime,
"updatedAt": AWSDateTime
}
}
}
updatePracticePackage
Response
Returns a Boolean
Arguments
| Name | Description |
|---|---|
args - UpdatePracticePackageInput!
|
Example
Query
mutation UpdatePracticePackage($args: UpdatePracticePackageInput!) {
updatePracticePackage(args: $args)
}
Variables
{"args": UpdatePracticePackageInput}
Response
{"data": {"updatePracticePackage": false}}
updateRedtailLoadErrors
Response
Returns a RedtailLoadErrors
Arguments
| Name | Description |
|---|---|
input - UpdateRedtailLoadErrorsInput!
|
|
condition - ModelRedtailLoadErrorsConditionInput
|
Example
Query
mutation UpdateRedtailLoadErrors(
$input: UpdateRedtailLoadErrorsInput!,
$condition: ModelRedtailLoadErrorsConditionInput
) {
updateRedtailLoadErrors(
input: $input,
condition: $condition
) {
id
errorMessage
redtailPayload
createdAt
updatedAt
}
}
Variables
{
"input": UpdateRedtailLoadErrorsInput,
"condition": ModelRedtailLoadErrorsConditionInput
}
Response
{
"data": {
"updateRedtailLoadErrors": {
"id": "4",
"errorMessage": "abc123",
"redtailPayload": "abc123",
"createdAt": AWSDateTime,
"updatedAt": AWSDateTime
}
}
}
updateRegistration
Response
Returns a Registration
Arguments
| Name | Description |
|---|---|
input - UpdateRegistrationInput!
|
|
condition - ModelRegistrationConditionInput
|
Example
Query
mutation UpdateRegistration(
$input: UpdateRegistrationInput!,
$condition: ModelRegistrationConditionInput
) {
updateRegistration(
input: $input,
condition: $condition
) {
id
clientId
inviteCode
fullName
createdAt
updatedAt
}
}
Variables
{
"input": UpdateRegistrationInput,
"condition": ModelRegistrationConditionInput
}
Response
{
"data": {
"updateRegistration": {
"id": 4,
"clientId": 987,
"inviteCode": "xyz789",
"fullName": "xyz789",
"createdAt": AWSDateTime,
"updatedAt": AWSDateTime
}
}
}
updateSecurity
Response
Returns a Security
Arguments
| Name | Description |
|---|---|
input - UpdateSecurityInput!
|
|
condition - ModelSecurityConditionInput
|
Example
Query
mutation UpdateSecurity(
$input: UpdateSecurityInput!,
$condition: ModelSecurityConditionInput
) {
updateSecurity(
input: $input,
condition: $condition
) {
id
assetClassName
code
description
exchange
msCode
msNonFundCode
name
securityId
securityType
securityGroup
ticker
createdAt
updatedAt
}
}
Variables
{
"input": UpdateSecurityInput,
"condition": ModelSecurityConditionInput
}
Response
{
"data": {
"updateSecurity": {
"id": 4,
"assetClassName": "abc123",
"code": "abc123",
"description": "abc123",
"exchange": "xyz789",
"msCode": "abc123",
"msNonFundCode": "xyz789",
"name": "xyz789",
"securityId": 987,
"securityType": "abc123",
"securityGroup": "xyz789",
"ticker": "abc123",
"createdAt": AWSDateTime,
"updatedAt": AWSDateTime
}
}
}
updateSurveyResponseData
Response
Returns a SurveyResponseData
Arguments
| Name | Description |
|---|---|
input - UpdateSurveyResponseDataInput!
|
|
condition - ModelSurveyResponseDataConditionInput
|
Example
Query
mutation UpdateSurveyResponseData(
$input: UpdateSurveyResponseDataInput!,
$condition: ModelSurveyResponseDataConditionInput
) {
updateSurveyResponseData(
input: $input,
condition: $condition
) {
id
clientId
inviteCode
householdId
keyValueData
status
surveyId
progress
createdAt
updatedAt
}
}
Variables
{
"input": UpdateSurveyResponseDataInput,
"condition": ModelSurveyResponseDataConditionInput
}
Response
{
"data": {
"updateSurveyResponseData": {
"id": "4",
"clientId": 123,
"inviteCode": "xyz789",
"householdId": 987,
"keyValueData": "abc123",
"status": "SENT",
"surveyId": "xyz789",
"progress": 123.45,
"createdAt": AWSDateTime,
"updatedAt": AWSDateTime
}
}
}
updateTamaracLoadErrors
Response
Returns a TamaracLoadErrors
Arguments
| Name | Description |
|---|---|
input - UpdateTamaracLoadErrorsInput!
|
|
condition - ModelTamaracLoadErrorsConditionInput
|
Example
Query
mutation UpdateTamaracLoadErrors(
$input: UpdateTamaracLoadErrorsInput!,
$condition: ModelTamaracLoadErrorsConditionInput
) {
updateTamaracLoadErrors(
input: $input,
condition: $condition
) {
id
sourceFile
errorMessage
tamaracPayload
accountId
accountNumber
primaryMemberFirstName
primaryMemberLastName
fuzzyRatio
rdsCombinedAddressString
tamaracCombinedAddressString
createdAt
updatedAt
}
}
Variables
{
"input": UpdateTamaracLoadErrorsInput,
"condition": ModelTamaracLoadErrorsConditionInput
}
Response
{
"data": {
"updateTamaracLoadErrors": {
"id": "4",
"sourceFile": "xyz789",
"errorMessage": "abc123",
"tamaracPayload": "xyz789",
"accountId": "abc123",
"accountNumber": "abc123",
"primaryMemberFirstName": "abc123",
"primaryMemberLastName": "xyz789",
"fuzzyRatio": "xyz789",
"rdsCombinedAddressString": "xyz789",
"tamaracCombinedAddressString": "xyz789",
"createdAt": AWSDateTime,
"updatedAt": AWSDateTime
}
}
}
updateVaultFileState
Response
Returns a Boolean
Arguments
| Name | Description |
|---|---|
args - ChangeStateVaultFileInput
|
Example
Query
mutation UpdateVaultFileState($args: ChangeStateVaultFileInput) {
updateVaultFileState(args: $args)
}
Variables
{"args": ChangeStateVaultFileInput}
Response
{"data": {"updateVaultFileState": true}}
updateYourLifeSession
Response
Returns a YourLifeSession
Arguments
| Name | Description |
|---|---|
input - UpdateYourLifeSessionInput!
|
|
condition - ModelYourLifeSessionConditionInput
|
Example
Query
mutation UpdateYourLifeSession(
$input: UpdateYourLifeSessionInput!,
$condition: ModelYourLifeSessionConditionInput
) {
updateYourLifeSession(
input: $input,
condition: $condition
) {
id
clientId
inviteCode
householdId
status
firstName
lastName
fullName
hasPartner
partnerId
includeGoals
includeConnections
includeFinancialDetails
partnerFirstName
partnerLastName
partnerFullName
responses {
questionId
intResponse
stringResponse
}
lovedOnes
communityConnections
globalConnections
overallScore
emotionalScore
environmentalScore
spiritualScore
socialScore
educationScore
occupationalScore
physicalScore
financialScore
notes {
householdId
valueGroupId
note
}
createdAt
updatedAt
}
}
Variables
{
"input": UpdateYourLifeSessionInput,
"condition": ModelYourLifeSessionConditionInput
}
Response
{
"data": {
"updateYourLifeSession": {
"id": "4",
"clientId": 123,
"inviteCode": "xyz789",
"householdId": 123,
"status": "abc123",
"firstName": "abc123",
"lastName": "xyz789",
"fullName": "xyz789",
"hasPartner": true,
"partnerId": 123,
"includeGoals": false,
"includeConnections": true,
"includeFinancialDetails": false,
"partnerFirstName": "xyz789",
"partnerLastName": "abc123",
"partnerFullName": "xyz789",
"responses": [LifeResponse],
"lovedOnes": ["abc123"],
"communityConnections": ["xyz789"],
"globalConnections": ["abc123"],
"overallScore": 987.65,
"emotionalScore": 123.45,
"environmentalScore": 987.65,
"spiritualScore": 123.45,
"socialScore": 123.45,
"educationScore": 987.65,
"occupationalScore": 123.45,
"physicalScore": 123.45,
"financialScore": 987.65,
"notes": [LifeNote],
"createdAt": AWSDateTime,
"updatedAt": AWSDateTime
}
}
}
updateYourValuesSession
Response
Returns a YourValuesSession
Arguments
| Name | Description |
|---|---|
input - UpdateYourValuesSessionInput!
|
|
condition - ModelYourValuesSessionConditionInput
|
Example
Query
mutation UpdateYourValuesSession(
$input: UpdateYourValuesSessionInput!,
$condition: ModelYourValuesSessionConditionInput
) {
updateYourValuesSession(
input: $input,
condition: $condition
) {
id
clientId
inviteCode
partnerId
partnerInviteCode
client {
clientId
regrets
values {
cardId
rank
meaningReason
progressAction
progress
}
step
lastSeen
individualValuesCompleted
}
partner {
clientId
regrets
values {
cardId
rank
meaningReason
progressAction
progress
}
step
lastSeen
individualValuesCompleted
}
adviser {
staffId
step
lastSeen
}
support {
staffId
step
lastSeen
}
alignedValues {
cardId
clientId
rank
notes
progress
description
nextSteps {
id
title
notes
assignedToClientId
created
}
householdMemberProgress {
description
progress
clientId
}
}
valuesInc3Things
partnerValuesInc3Things
individualValuesOnly
step
lastSeen
createdAt
updatedAt
}
}
Variables
{
"input": UpdateYourValuesSessionInput,
"condition": ModelYourValuesSessionConditionInput
}
Response
{
"data": {
"updateYourValuesSession": {
"id": "4",
"clientId": 987,
"inviteCode": "xyz789",
"partnerId": 987,
"partnerInviteCode": "abc123",
"client": ValuesClient,
"partner": ValuesClient,
"adviser": ValuesStaff,
"support": ValuesStaff,
"alignedValues": [ValuesAlignedValue],
"valuesInc3Things": true,
"partnerValuesInc3Things": false,
"individualValuesOnly": true,
"step": "xyz789",
"lastSeen": "abc123",
"createdAt": AWSDateTime,
"updatedAt": AWSDateTime
}
}
}
uploadVaultFile
Response
Returns a Boolean
Arguments
| Name | Description |
|---|---|
args - UploadVaultFileInput
|
Example
Query
mutation UploadVaultFile($args: UploadVaultFileInput) {
uploadVaultFile(args: $args)
}
Variables
{"args": UploadVaultFileInput}
Response
{"data": {"uploadVaultFile": true}}
xplanIsCallbackVerified
Response
Returns a Boolean
Arguments
| Name | Description |
|---|---|
args - XplanIsCallbackVerifiedRequest
|
Example
Query
mutation XplanIsCallbackVerified($args: XplanIsCallbackVerifiedRequest) {
xplanIsCallbackVerified(args: $args)
}
Variables
{"args": XplanIsCallbackVerifiedRequest}
Response
{"data": {"xplanIsCallbackVerified": false}}
Subscriptions
onCreateNotificationPointer
Response
Returns a NotificationPointer
Arguments
| Name | Description |
|---|---|
recipient - String!
|
Example
Query
subscription OnCreateNotificationPointer($recipient: String!) {
onCreateNotificationPointer(recipient: $recipient) {
id
owner
recipient
notificationId
createdAt
updatedAt
}
}
Variables
{"recipient": "abc123"}
Response
{
"data": {
"onCreateNotificationPointer": {
"id": 4,
"owner": "xyz789",
"recipient": "xyz789",
"notificationId": "xyz789",
"createdAt": AWSDateTime,
"updatedAt": AWSDateTime
}
}
}
onCreateStaff
Response
Returns a RegisterStaffOutput
Example
Query
subscription OnCreateStaff {
onCreateStaff {
staffId
}
}
Response
{"data": {"onCreateStaff": {"staffId": 987}}}
Types
AWSDateTime
Example
AWSDateTime
Account
Fields
| Field Name | Description |
|---|---|
accountId - Int!
|
|
basiqAccountId - String
|
|
basiqConnectionId - String
|
|
clientId - Int!
|
|
accountNumber - String
|
|
accountName - String
|
|
accountCurrency - String
|
|
accountType - String
|
|
accountSubtype - String
|
|
accountClassProduct - String
|
|
availableRedraw - Float
|
|
lifeInsurance - Boolean
|
|
lifeCovered - Float
|
|
incomeProtection - Boolean
|
|
incomeCovered - Float
|
|
traumaInsurance - Boolean
|
|
traumaCovered - Float
|
|
businessExpenseInsurance - Boolean
|
|
businessExpenseCovered - Float
|
|
severityBasedInsurance - Boolean
|
|
severityBasedCovered - Float
|
|
tpdInsurance - Boolean
|
|
tpdCovered - Float
|
|
maturityDate - String
|
|
fee - Float
|
|
instalmentAmount - Float
|
|
interestRate - Float
|
|
interestType - String
|
|
nextInstalmentDate - String
|
|
offsetAccountNumber - String
|
|
repaymentFrequency - String
|
|
repaymentType - String
|
|
balance - Float
|
|
commencementDate - String
|
|
availableFunds - Float
|
|
limit - Float
|
|
lastUpdated - String
|
|
transactionIntervalsFrom - String
|
|
transactionIntervalsTo - String
|
|
institution - String
|
|
accountHolder - String
|
|
basiqDataId - Int
|
|
paymentAmount - Float
|
|
payoutPaymentAccount - String
|
|
payoutDetails - String
|
|
payoutWaitingPeriod - Int
|
|
payoutLength - Int
|
|
otherLoanType - String
|
|
deleted - String
|
|
deletedBy - String
|
|
policyEndDate - String
|
|
policyStatus - String
|
Example
{
"accountId": 987,
"basiqAccountId": "xyz789",
"basiqConnectionId": "abc123",
"clientId": 123,
"accountNumber": "xyz789",
"accountName": "abc123",
"accountCurrency": "xyz789",
"accountType": "xyz789",
"accountSubtype": "abc123",
"accountClassProduct": "xyz789",
"availableRedraw": 123.45,
"lifeInsurance": true,
"lifeCovered": 987.65,
"incomeProtection": false,
"incomeCovered": 987.65,
"traumaInsurance": false,
"traumaCovered": 123.45,
"businessExpenseInsurance": false,
"businessExpenseCovered": 123.45,
"severityBasedInsurance": true,
"severityBasedCovered": 987.65,
"tpdInsurance": false,
"tpdCovered": 987.65,
"maturityDate": "xyz789",
"fee": 987.65,
"instalmentAmount": 987.65,
"interestRate": 987.65,
"interestType": "xyz789",
"nextInstalmentDate": "xyz789",
"offsetAccountNumber": "xyz789",
"repaymentFrequency": "xyz789",
"repaymentType": "abc123",
"balance": 123.45,
"commencementDate": "abc123",
"availableFunds": 987.65,
"limit": 987.65,
"lastUpdated": "xyz789",
"transactionIntervalsFrom": "abc123",
"transactionIntervalsTo": "xyz789",
"institution": "abc123",
"accountHolder": "xyz789",
"basiqDataId": 123,
"paymentAmount": 123.45,
"payoutPaymentAccount": "xyz789",
"payoutDetails": "abc123",
"payoutWaitingPeriod": 987,
"payoutLength": 987,
"otherLoanType": "abc123",
"deleted": "abc123",
"deletedBy": "abc123",
"policyEndDate": "xyz789",
"policyStatus": "xyz789"
}
AccountData
AccountNetInvestmentPortfolio
Fields
| Field Name | Description |
|---|---|
portfolioId - Int
|
|
timelineData - TimelineData
|
Example
{"portfolioId": 123, "timelineData": TimelineData}
AccountNetInvestmentTimelineInput
AccountNetInvestmentTimelineOutput
Fields
| Field Name | Description |
|---|---|
portfolios - [AccountNetInvestmentPortfolio]
|
Example
{"portfolios": [AccountNetInvestmentPortfolio]}
AddAccessToHouseholdInput
Fields
| Input Field | Description |
|---|---|
practiceId - Int
|
|
householdId - Int!
|
|
staffId - Int
|
|
practiceOfficeId - Int
|
|
role - HouseholdTeamMemberRole!
|
Example
{
"practiceId": 987,
"householdId": 987,
"staffId": 987,
"practiceOfficeId": 123,
"role": "P1"
}
AddRemoveCognitoUserGroupInput
AddRemoveCognitoUserGroupOutput
AddVaultFolderInput
Address
Example
{
"addressId": 123,
"constructedAddress": "abc123",
"addressLine1": "abc123",
"addressLine2": "xyz789",
"suburb": "xyz789",
"postCode": "xyz789",
"state": "abc123",
"country": "abc123",
"createdBy": "xyz789",
"created": "xyz789",
"updatedBy": "xyz789",
"updated": "abc123"
}
AdviserLandingPageCardItemType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"LIFE"
AdvyzonGetLumiantClientAndHouseholdIdsOutput
AdvyzonGetLumiantClientAndHouseholdIdsRequest
Fields
| Input Field | Description |
|---|---|
advyzonHouseholdId - String!
|
Example
{"advyzonHouseholdId": "xyz789"}
AdvyzonLinkExistingLumiantHouseholdInput
AdvyzonSyncHouseholdInput
Allocation
AllocationInput
ApproveReject
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"APPROVE_NEW"
ApproveRejectClientChangesInput
Fields
| Input Field | Description |
|---|---|
practiceId - String
|
|
staffId - String
|
|
householdId - Int!
|
|
entityId - Int!
|
|
entityType - EntityTypesApprovals!
|
|
fieldName - ApproveRejectFieldNames
|
|
operation - ApproveReject!
|
Example
{
"practiceId": "abc123",
"staffId": "abc123",
"householdId": 987,
"entityId": 123,
"entityType": "GOAL",
"fieldName": "GOAL_TARGET_DATE",
"operation": "APPROVE_NEW"
}
ApproveRejectFieldNames
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"GOAL_TARGET_DATE"
AssetAllocationType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"S"
AssetClass
AssetOutput
Fields
| Field Name | Description |
|---|---|
assetId - Int!
|
|
householdId - Int
|
|
clientId - Int
|
|
clientFirstName - String
|
|
clientLastName - String
|
|
clientPreferredName - String
|
|
legalEntityId - Int
|
|
legalEntityName - String
|
|
beneficiaryClientId - Int
|
|
beneficiaryLegalEntityId - Int
|
|
otherBeneficiary - String
|
|
relationshipAsset - String
|
|
assetType - String!
|
|
superType - String
|
|
pensionType - String
|
|
description - String
|
|
accountNumber - String
|
|
providerName - String
|
|
memberNumber - String
|
|
balance - Float
|
|
definedBenefitSalary - Float
|
|
definedBenefitMultiple - Float
|
|
employeeContribution - Float
|
|
employeeContributionBps - Float
|
|
employeeContributionType - String
|
|
employeeContributionCap - Float
|
|
employeeContributionCapBps - Float
|
|
employerContribution - Float
|
|
employerContributionBps - Float
|
|
employerContributionCap - Float
|
|
employerContributionCapBps - Float
|
|
makesPersonalContribution - Boolean
|
|
annualContribution - Float
|
|
inheritedIraType - String
|
|
deceasedOwnerDateOfBirth - String
|
|
deceasedOwnerDateOfDeath - String
|
|
rmdTakenThisYear - Boolean
|
|
previousYearBalance - Float
|
|
annuityTermDate - String
|
|
deathBenefit - Float
|
|
surrenderValue - Float
|
|
centrelinkValue - Float
|
|
isUsedLoanSecurity - Boolean
|
|
loanSecuredAmount - Float
|
|
madePersonalContribPast3y - Boolean
|
|
taxFreeComponent - Float
|
|
preservationComponent - Float
|
|
makesPersonalSuperContribution - Boolean
|
|
isSalarySacrifice - Boolean
|
|
superContributionAmount - Float
|
|
superContributionFrequency - String
|
|
employerPaysHigherThanMinimumSuper - Boolean
|
|
higherThanMinimumSuperBps - Float
|
|
preRetirementRefModel - Int
|
|
postRetirementRefModel - Int
|
|
feesBps - Float
|
|
feesDollar - Float
|
|
addressId - Int
|
|
ownOrRent - String
|
|
isPrimaryHome - Boolean
|
|
purchasePrice - Float
|
|
purchaseDate - String
|
|
growthBps - Float
|
|
currentValue - Float
|
|
propertyType - String
|
|
rent - Float
|
|
savingInvestmentType - String
|
|
assetUse - String
|
|
assessed - Boolean
|
|
make - String
|
|
model - String
|
|
lastValued - String
|
|
superPhase - String
|
|
annuityType - String
|
|
term - Int
|
|
maturityDate - String
|
|
commutedAmount - Float
|
|
residualValue - Float
|
|
assetExemptionBps - Float
|
|
notes - String
|
|
clientNotes - String
|
|
partnerNotes - String
|
|
confidentialNotes - String
|
|
displayName - String
|
|
displayOwnership - Int
|
|
externalSystem - ExternalSystem
|
|
assetYodleeMapping - YodleeMapping
|
|
createdBy - String!
|
|
created - String!
|
|
updatedBy - String!
|
|
updated - String!
|
|
constructedAddress - String
|
|
addressLine1 - String
|
|
addressLine2 - String
|
|
suburb - String
|
|
postCode - String
|
|
state - String
|
|
country - String
|
|
linkedLoan - Int
|
Example
{
"assetId": 987,
"householdId": 987,
"clientId": 123,
"clientFirstName": "abc123",
"clientLastName": "abc123",
"clientPreferredName": "xyz789",
"legalEntityId": 987,
"legalEntityName": "abc123",
"beneficiaryClientId": 123,
"beneficiaryLegalEntityId": 123,
"otherBeneficiary": "abc123",
"relationshipAsset": "xyz789",
"assetType": "abc123",
"superType": "abc123",
"pensionType": "xyz789",
"description": "xyz789",
"accountNumber": "abc123",
"providerName": "abc123",
"memberNumber": "abc123",
"balance": 123.45,
"definedBenefitSalary": 123.45,
"definedBenefitMultiple": 987.65,
"employeeContribution": 987.65,
"employeeContributionBps": 123.45,
"employeeContributionType": "xyz789",
"employeeContributionCap": 123.45,
"employeeContributionCapBps": 987.65,
"employerContribution": 987.65,
"employerContributionBps": 987.65,
"employerContributionCap": 123.45,
"employerContributionCapBps": 987.65,
"makesPersonalContribution": true,
"annualContribution": 123.45,
"inheritedIraType": "xyz789",
"deceasedOwnerDateOfBirth": "abc123",
"deceasedOwnerDateOfDeath": "abc123",
"rmdTakenThisYear": true,
"previousYearBalance": 123.45,
"annuityTermDate": "xyz789",
"deathBenefit": 987.65,
"surrenderValue": 987.65,
"centrelinkValue": 987.65,
"isUsedLoanSecurity": false,
"loanSecuredAmount": 123.45,
"madePersonalContribPast3y": false,
"taxFreeComponent": 123.45,
"preservationComponent": 987.65,
"makesPersonalSuperContribution": false,
"isSalarySacrifice": true,
"superContributionAmount": 987.65,
"superContributionFrequency": "abc123",
"employerPaysHigherThanMinimumSuper": false,
"higherThanMinimumSuperBps": 987.65,
"preRetirementRefModel": 123,
"postRetirementRefModel": 123,
"feesBps": 987.65,
"feesDollar": 123.45,
"addressId": 123,
"ownOrRent": "xyz789",
"isPrimaryHome": true,
"purchasePrice": 123.45,
"purchaseDate": "abc123",
"growthBps": 987.65,
"currentValue": 987.65,
"propertyType": "xyz789",
"rent": 987.65,
"savingInvestmentType": "abc123",
"assetUse": "xyz789",
"assessed": false,
"make": "abc123",
"model": "abc123",
"lastValued": "xyz789",
"superPhase": "xyz789",
"annuityType": "xyz789",
"term": 987,
"maturityDate": "abc123",
"commutedAmount": 123.45,
"residualValue": 123.45,
"assetExemptionBps": 123.45,
"notes": "abc123",
"clientNotes": "abc123",
"partnerNotes": "xyz789",
"confidentialNotes": "abc123",
"displayName": "xyz789",
"displayOwnership": 987,
"externalSystem": "IL",
"assetYodleeMapping": YodleeMapping,
"createdBy": "abc123",
"created": "abc123",
"updatedBy": "xyz789",
"updated": "abc123",
"constructedAddress": "abc123",
"addressLine1": "xyz789",
"addressLine2": "xyz789",
"suburb": "abc123",
"postCode": "xyz789",
"state": "xyz789",
"country": "abc123",
"linkedLoan": 987
}
AssetTimelineData
Fields
| Field Name | Description |
|---|---|
assetId - Int
|
|
timelineData - NetWorthTimelineData
|
Example
{"assetId": 987, "timelineData": NetWorthTimelineData}
AssetTree
Fields
| Field Name | Description |
|---|---|
assetTreeId - Int!
|
|
invGroup - InvGroup!
|
|
region - Region!
|
|
assetClass - AssetClass!
|
|
sector - Sector!
|
Example
{
"assetTreeId": 123,
"invGroup": InvGroup,
"region": Region,
"assetClass": AssetClass,
"sector": Sector
}
AssetTreeOutput
Fields
| Field Name | Description |
|---|---|
assetTree - [AssetTree]
|
Example
{"assetTree": [AssetTree]}
Auth0MigrateUserInput
Auth0UpdatePasswordInput
Auth0UpdatePasswordOutput
Auth0UpdateUserInput
Example
{
"email": "abc123",
"email_verified": "xyz789",
"blocked": "xyz789",
"given_name": "xyz789",
"family_name": "xyz789",
"name": "xyz789",
"connection": "abc123",
"verify_email": "xyz789",
"phone_number": "abc123",
"phone_verified": "abc123",
"migrated": "abc123",
"practice_id": "abc123",
"groups": "xyz789",
"sub": "xyz789"
}
Auth0UpdateUserOutput
AuthProvider
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"apiKey"
AuthRule
Fields
| Input Field | Description |
|---|---|
allow - AuthStrategy!
|
|
provider - AuthProvider
|
|
ownerField - String
|
|
identityClaim - String
|
|
groupClaim - String
|
|
groups - [String]
|
|
groupsField - String
|
|
operations - [ModelOperation]
|
|
queries - [ModelQuery]
|
|
mutations - [ModelMutation]
|
Example
{
"allow": "owner",
"provider": "apiKey",
"ownerField": "abc123",
"identityClaim": "xyz789",
"groupClaim": "abc123",
"groups": ["abc123"],
"groupsField": "abc123",
"operations": ["create"],
"queries": ["get"],
"mutations": ["create"]
}
AuthStrategy
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"owner"
BankingJob
BankingMetadata
Example
{
"clientId": 987,
"basiqUserId": "xyz789",
"basiqAuthToken": "xyz789",
"basiqLastError": "xyz789",
"createdBy": "xyz789",
"created": "xyz789",
"updatedBy": "abc123",
"updated": "xyz789"
}
BasiqConnection
BeneficiaryOutput
Fields
| Field Name | Description |
|---|---|
beneficiaryId - Int!
|
|
estatePlanningId - Int!
|
|
isPrimary - Boolean!
|
|
firstName - String
|
|
middleName - String
|
|
lastName - String
|
|
companyName - String
|
|
relationshipType - String
|
|
nominatedPercentage - Float
|
|
ageEntitlement - Int
|
|
notes - String
|
|
clientNotes - String
|
|
partnerNotes - String
|
|
confidentialNotes - String
|
|
createdBy - String!
|
|
created - String!
|
|
updatedBy - String!
|
|
updated - String!
|
Example
{
"beneficiaryId": 123,
"estatePlanningId": 987,
"isPrimary": false,
"firstName": "xyz789",
"middleName": "xyz789",
"lastName": "abc123",
"companyName": "abc123",
"relationshipType": "abc123",
"nominatedPercentage": 987.65,
"ageEntitlement": 987,
"notes": "abc123",
"clientNotes": "xyz789",
"partnerNotes": "xyz789",
"confidentialNotes": "abc123",
"createdBy": "xyz789",
"created": "abc123",
"updatedBy": "xyz789",
"updated": "abc123"
}
BestLifeProjectionChartData
BestLifeProjectionInput
Fields
| Input Field | Description |
|---|---|
clientId - Int
|
|
scenarioId - Int
|
|
name - String
|
|
includeClient - Boolean
|
|
clientSuperannuation - Float
|
|
clientSuperannuationContribution - Float
|
|
clientSuperannuationContributionIsInDollars - Boolean
|
|
clientSuperannuationMatchBps - Float
|
|
clientSuperannuationMatchEndsBps - Float
|
|
clientSuperannuationFee - Float
|
|
clientSuperannuationFeeIsInDollars - Boolean
|
|
clientSuperOther - Float
|
|
clientSuperOtherContribution - Float
|
|
clientSuperOtherContributionIsInDollars - Boolean
|
|
clientSuperOtherFee - Float
|
|
clientSuperOtherFeeIsInDollars - Boolean
|
|
clientRetirementAge - Int
|
|
clientPensionPaidFromAge - Int
|
|
clientLifeExpectancyAge - Int
|
|
clientIncomeRateChange - Float
|
|
includePartner - Boolean
|
|
partnerSuperannuation - Float
|
|
partnerSuperannuationContribution - Float
|
|
partnerSuperannuationContributionIsInDollars - Boolean
|
|
partnerSuperannuationMatchBps - Float
|
|
partnerSuperannuationMatchEndsBps - Float
|
|
partnerSuperannuationFee - Float
|
|
partnerSuperannuationFeeIsInDollars - Boolean
|
|
partnerSuperOther - Float
|
|
partnerSuperOtherContribution - Float
|
|
partnerSuperOtherContributionIsInDollars - Boolean
|
|
partnerSuperOtherFee - Float
|
|
partnerSuperOtherFeeIsInDollars - Boolean
|
|
partnerRetirementAge - Int
|
|
partnerPensionPaidFromAge - Int
|
|
partnerLifeExpectancyAge - Int
|
|
partnerIncomeRateChange - Float
|
|
businessValueGrowthPerAnnum - Float
|
|
businessValue - Float
|
|
businessEstimatedDateOfSale - String
|
|
businessEstimatedSaleAmount - Float
|
|
businessEstimatedTaxOnSale - Float
|
|
householdPersonalAssets - Float
|
|
householdPersonalDebt - Float
|
|
householdProperty - Float
|
|
householdPropertyDebt - Float
|
|
householdInvestmentProperties - Float
|
|
householdInvestmentPropertiesDebt - Float
|
|
householdNonSuperInvestments - Float
|
|
householdNonSuperInvestmentsFee - Float
|
|
householdNonSuperInvestmentsFeeIsInDollars - Boolean
|
|
householdPreRetirementAvgTax - Float
|
|
householdPostRetirementAvgTax - Float
|
|
householdIncome - Float
|
|
householdSavings - Float
|
|
householdCashFlow - [HouseholdCashFlowInput]
|
|
reqRetirementIncomeRateChange - Float
|
|
referenceModel - Int
|
|
excessCashAllocations - [AllocationInput]
|
|
reduceShortfallAllocations - [AllocationInput]
|
Example
{
"clientId": 987,
"scenarioId": 987,
"name": "xyz789",
"includeClient": true,
"clientSuperannuation": 123.45,
"clientSuperannuationContribution": 123.45,
"clientSuperannuationContributionIsInDollars": false,
"clientSuperannuationMatchBps": 123.45,
"clientSuperannuationMatchEndsBps": 123.45,
"clientSuperannuationFee": 123.45,
"clientSuperannuationFeeIsInDollars": true,
"clientSuperOther": 123.45,
"clientSuperOtherContribution": 123.45,
"clientSuperOtherContributionIsInDollars": true,
"clientSuperOtherFee": 123.45,
"clientSuperOtherFeeIsInDollars": true,
"clientRetirementAge": 123,
"clientPensionPaidFromAge": 123,
"clientLifeExpectancyAge": 123,
"clientIncomeRateChange": 987.65,
"includePartner": true,
"partnerSuperannuation": 123.45,
"partnerSuperannuationContribution": 987.65,
"partnerSuperannuationContributionIsInDollars": true,
"partnerSuperannuationMatchBps": 987.65,
"partnerSuperannuationMatchEndsBps": 123.45,
"partnerSuperannuationFee": 123.45,
"partnerSuperannuationFeeIsInDollars": true,
"partnerSuperOther": 123.45,
"partnerSuperOtherContribution": 123.45,
"partnerSuperOtherContributionIsInDollars": true,
"partnerSuperOtherFee": 123.45,
"partnerSuperOtherFeeIsInDollars": true,
"partnerRetirementAge": 123,
"partnerPensionPaidFromAge": 123,
"partnerLifeExpectancyAge": 123,
"partnerIncomeRateChange": 987.65,
"businessValueGrowthPerAnnum": 987.65,
"businessValue": 123.45,
"businessEstimatedDateOfSale": "abc123",
"businessEstimatedSaleAmount": 123.45,
"businessEstimatedTaxOnSale": 987.65,
"householdPersonalAssets": 123.45,
"householdPersonalDebt": 987.65,
"householdProperty": 987.65,
"householdPropertyDebt": 987.65,
"householdInvestmentProperties": 987.65,
"householdInvestmentPropertiesDebt": 987.65,
"householdNonSuperInvestments": 123.45,
"householdNonSuperInvestmentsFee": 123.45,
"householdNonSuperInvestmentsFeeIsInDollars": false,
"householdPreRetirementAvgTax": 123.45,
"householdPostRetirementAvgTax": 123.45,
"householdIncome": 987.65,
"householdSavings": 123.45,
"householdCashFlow": [HouseholdCashFlowInput],
"reqRetirementIncomeRateChange": 987.65,
"referenceModel": 987,
"excessCashAllocations": [AllocationInput],
"reduceShortfallAllocations": [AllocationInput]
}
BestLifeProjectionLatestInputs
Fields
| Field Name | Description |
|---|---|
scenarioId - Int
|
|
name - String
|
|
includeClient - Boolean
|
|
clientAge - Int
|
|
clientIncome - Float
|
|
clientSuperannuation - Float
|
|
clientSuperannuationContribution - Float
|
|
clientSuperannuationContributionIsInDollars - Boolean
|
|
clientSuperannuationMatchBps - Float
|
|
clientSuperannuationMatchEndsBps - Float
|
|
clientSuperannuationFee - Float
|
|
clientSuperannuationFeeIsInDollars - Boolean
|
|
clientSuperOther - Float
|
|
clientSuperOtherContribution - Float
|
|
clientSuperOtherContributionIsInDollars - Boolean
|
|
clientSuperOtherFee - Float
|
|
clientSuperOtherFeeIsInDollars - Boolean
|
|
clientRetirementAge - Int
|
|
clientPensionPaidFromAge - Int
|
|
clientLifeExpectancyAge - Int
|
|
clientIncomeRateChange - Float
|
|
includePartner - Boolean
|
|
partnerAge - Int
|
|
partnerIncome - Float
|
|
partnerSuperannuation - Float
|
|
partnerSuperannuationContribution - Float
|
|
partnerSuperannuationContributionIsInDollars - Boolean
|
|
partnerSuperannuationMatchBps - Float
|
|
partnerSuperannuationMatchEndsBps - Float
|
|
partnerSuperannuationFee - Float
|
|
partnerSuperannuationFeeIsInDollars - Boolean
|
|
partnerSuperOther - Float
|
|
partnerSuperOtherContribution - Float
|
|
partnerSuperOtherContributionIsInDollars - Boolean
|
|
partnerSuperOtherFee - Float
|
|
partnerSuperOtherFeeIsInDollars - Boolean
|
|
partnerRetirementAge - Int
|
|
partnerPensionPaidFromAge - Int
|
|
partnerLifeExpectancyAge - Int
|
|
partnerIncomeRateChange - Float
|
|
businessValueGrowthPerAnnum - Float
|
|
businessValue - Float
|
|
businessEstimatedDateOfSale - String
|
|
businessEstimatedSaleAmount - Float
|
|
businessEstimatedTaxOnSale - Float
|
|
householdPersonalAssets - Float
|
|
householdPersonalDebt - Float
|
|
householdProperty - Float
|
|
householdPropertyDebt - Float
|
|
householdInvestmentProperties - Float
|
|
householdInvestmentPropertiesDebt - Float
|
|
householdNonSuperInvestments - Float
|
|
householdNonSuperInvestmentsFee - Float
|
|
householdNonSuperInvestmentsFeeIsInDollars - Boolean
|
|
householdPreRetirementAvgTax - Float
|
|
householdPostRetirementAvgTax - Float
|
|
householdIncome - Float
|
|
householdSavings - Float
|
|
householdCashFlow - [HouseholdCashFlow]
|
|
householdCashFlowHeader - String
|
|
reqRetirementIncome - Float
|
|
reqRetirementIncomeRateChange - Float
|
|
referenceModel - Int
|
|
bestLifeScore - Float
|
|
excessCashAllocations - [Allocation]
|
|
reduceShortfallAllocations - [Allocation]
|
Example
{
"scenarioId": 987,
"name": "abc123",
"includeClient": true,
"clientAge": 123,
"clientIncome": 987.65,
"clientSuperannuation": 987.65,
"clientSuperannuationContribution": 987.65,
"clientSuperannuationContributionIsInDollars": false,
"clientSuperannuationMatchBps": 123.45,
"clientSuperannuationMatchEndsBps": 123.45,
"clientSuperannuationFee": 987.65,
"clientSuperannuationFeeIsInDollars": true,
"clientSuperOther": 987.65,
"clientSuperOtherContribution": 123.45,
"clientSuperOtherContributionIsInDollars": false,
"clientSuperOtherFee": 123.45,
"clientSuperOtherFeeIsInDollars": true,
"clientRetirementAge": 123,
"clientPensionPaidFromAge": 987,
"clientLifeExpectancyAge": 987,
"clientIncomeRateChange": 123.45,
"includePartner": false,
"partnerAge": 123,
"partnerIncome": 987.65,
"partnerSuperannuation": 987.65,
"partnerSuperannuationContribution": 123.45,
"partnerSuperannuationContributionIsInDollars": true,
"partnerSuperannuationMatchBps": 987.65,
"partnerSuperannuationMatchEndsBps": 987.65,
"partnerSuperannuationFee": 123.45,
"partnerSuperannuationFeeIsInDollars": false,
"partnerSuperOther": 987.65,
"partnerSuperOtherContribution": 987.65,
"partnerSuperOtherContributionIsInDollars": true,
"partnerSuperOtherFee": 987.65,
"partnerSuperOtherFeeIsInDollars": true,
"partnerRetirementAge": 123,
"partnerPensionPaidFromAge": 123,
"partnerLifeExpectancyAge": 123,
"partnerIncomeRateChange": 123.45,
"businessValueGrowthPerAnnum": 123.45,
"businessValue": 987.65,
"businessEstimatedDateOfSale": "xyz789",
"businessEstimatedSaleAmount": 987.65,
"businessEstimatedTaxOnSale": 123.45,
"householdPersonalAssets": 987.65,
"householdPersonalDebt": 987.65,
"householdProperty": 987.65,
"householdPropertyDebt": 123.45,
"householdInvestmentProperties": 123.45,
"householdInvestmentPropertiesDebt": 123.45,
"householdNonSuperInvestments": 123.45,
"householdNonSuperInvestmentsFee": 987.65,
"householdNonSuperInvestmentsFeeIsInDollars": true,
"householdPreRetirementAvgTax": 123.45,
"householdPostRetirementAvgTax": 123.45,
"householdIncome": 987.65,
"householdSavings": 987.65,
"householdCashFlow": [HouseholdCashFlow],
"householdCashFlowHeader": "abc123",
"reqRetirementIncome": 987.65,
"reqRetirementIncomeRateChange": 987.65,
"referenceModel": 987,
"bestLifeScore": 123.45,
"excessCashAllocations": [Allocation],
"reduceShortfallAllocations": [Allocation]
}
BestLifeProjectionLatestInputsData
Fields
| Field Name | Description |
|---|---|
data - BestLifeProjectionLatestInputs
|
Example
{"data": BestLifeProjectionLatestInputs}
BestLifeProjectionOutput
Fields
| Field Name | Description |
|---|---|
scenarioId - Int
|
|
name - String
|
|
timeline - BestLifeProjectionTimelineData
|
|
chart - BestLifeProjectionChartData
|
|
latestInputs - BestLifeProjectionLatestInputsData
|
|
report - BestLifeReportData
|
Example
{
"scenarioId": 123,
"name": "xyz789",
"timeline": BestLifeProjectionTimelineData,
"chart": BestLifeProjectionChartData,
"latestInputs": BestLifeProjectionLatestInputsData,
"report": BestLifeReportData
}
BestLifeProjectionTimelineData
Fields
| Field Name | Description |
|---|---|
data - String
|
Example
{"data": "abc123"}
BestLifeReportData
Fields
| Field Name | Description |
|---|---|
data - String
|
Example
{"data": "abc123"}
BestLifeScenarioAllocationInput
Example
{
"enabled": true,
"allocationType": "abc123",
"rank": 123,
"assetId": 123,
"liabilityId": 123,
"maxAmountUseDollar": false,
"maxAmountDollar": 987.65,
"maxAmount": 123.45,
"sellAsNeeded": false
}
BestLifeScenarioAssetInput
Fields
| Input Field | Description |
|---|---|
assetId - Int!
|
|
include - Boolean!
|
|
clientId - Int
|
|
entityId - Int
|
|
description - String!
|
|
assetType - String
|
|
superType - String
|
|
pensionType - String
|
|
savingInvestmentType - String
|
|
term - Int
|
|
maturityDate - String
|
|
annuityType - String
|
|
annuityTermDate - String
|
|
deathBenefit - Float
|
|
purchasePrice - Float
|
|
purchaseDate - String
|
|
currentValue - Float!
|
|
growth - Float
|
|
definedBenefitSalary - Float
|
|
definedBenefitMultiple - Float
|
|
employeeContributionType - String
|
|
employeeContributionUseDollar - Boolean
|
|
employeeContributionDollar - Float
|
|
employeeContribution - Float
|
|
employeeContributionCapUseDollar - Boolean
|
|
employeeContributionCapDollar - Float
|
|
employeeContributionCap - Float
|
|
employerContributionUseDollar - Boolean
|
|
employerContributionDollar - Float
|
|
employerContribution - Float
|
|
employerContributionCapUseDollar - Boolean
|
|
employerContributionCapDollar - Float
|
|
employerContributionCap - Float
|
|
riskGroupPreRetirement - Int
|
|
riskGroupPostRetirement - Int
|
|
feesUseDollar - Boolean
|
|
feesDollar - Float
|
|
fees - Float
|
|
addressCountry - String
|
|
addressState - String
|
|
addressPostCode - String
|
|
scenarioSaleDate - String
|
|
scenarioSaleValue - Float
|
Example
{
"assetId": 123,
"include": true,
"clientId": 987,
"entityId": 987,
"description": "xyz789",
"assetType": "xyz789",
"superType": "xyz789",
"pensionType": "abc123",
"savingInvestmentType": "xyz789",
"term": 987,
"maturityDate": "xyz789",
"annuityType": "xyz789",
"annuityTermDate": "xyz789",
"deathBenefit": 987.65,
"purchasePrice": 987.65,
"purchaseDate": "xyz789",
"currentValue": 987.65,
"growth": 123.45,
"definedBenefitSalary": 987.65,
"definedBenefitMultiple": 123.45,
"employeeContributionType": "xyz789",
"employeeContributionUseDollar": true,
"employeeContributionDollar": 123.45,
"employeeContribution": 123.45,
"employeeContributionCapUseDollar": true,
"employeeContributionCapDollar": 987.65,
"employeeContributionCap": 987.65,
"employerContributionUseDollar": true,
"employerContributionDollar": 987.65,
"employerContribution": 987.65,
"employerContributionCapUseDollar": false,
"employerContributionCapDollar": 987.65,
"employerContributionCap": 987.65,
"riskGroupPreRetirement": 123,
"riskGroupPostRetirement": 123,
"feesUseDollar": false,
"feesDollar": 123.45,
"fees": 987.65,
"addressCountry": "abc123",
"addressState": "xyz789",
"addressPostCode": "abc123",
"scenarioSaleDate": "xyz789",
"scenarioSaleValue": 123.45
}
BestLifeScenarioClientInput
Example
{
"clientId": 987,
"include": true,
"clientType": "abc123",
"name": "abc123",
"dob": "abc123",
"sex": "abc123",
"retirementAge": 123,
"pensionPaidFromAge": 987,
"lifeExpectancy": 123,
"taxRatePre": 123.45,
"scenarioTaxRatePre": 987.65,
"taxRatePost": 987.65,
"scenarioTaxRatePost": 123.45
}
BestLifeScenarioEntityInput
Example
{
"entityId": 123,
"include": false,
"entityType": "xyz789",
"name": "xyz789",
"taxRate": 123.45,
"scenarioTaxRate": 987.65,
"scenarioSaleDate": "xyz789",
"scenarioSaleValue": 123.45
}
BestLifeScenarioExpenseInput
Fields
| Input Field | Description |
|---|---|
expenseId - Int!
|
|
include - Boolean!
|
|
clientId - Int
|
|
entityId - Int
|
|
assetId - Int
|
|
description - String!
|
|
expenseType - String
|
|
expenseSubType - String
|
|
savingsPlanType - String
|
|
amountUseDollar - Boolean
|
|
amountDollar - Float
|
|
amount - Float
|
|
frequency - String
|
|
startDate - String
|
|
endDate - String
|
|
amountChange - Float
|
Example
{
"expenseId": 123,
"include": true,
"clientId": 123,
"entityId": 123,
"assetId": 987,
"description": "abc123",
"expenseType": "abc123",
"expenseSubType": "xyz789",
"savingsPlanType": "xyz789",
"amountUseDollar": false,
"amountDollar": 123.45,
"amount": 987.65,
"frequency": "abc123",
"startDate": "abc123",
"endDate": "abc123",
"amountChange": 123.45
}
BestLifeScenarioGoalInput
Example
{
"goalId": 123,
"include": true,
"clientId": 987,
"importance": 123,
"description": "xyz789",
"date": "abc123",
"amount": 123.45,
"scenarioAmount": 123.45,
"recurrenceType": "abc123",
"recurrenceInterval": 123
}
BestLifeScenarioIncomeInput
Fields
| Input Field | Description |
|---|---|
incomeId - Int!
|
|
include - Boolean!
|
|
clientId - Int
|
|
entityId - Int
|
|
assetId - Int
|
|
description - String!
|
|
incomeType - String
|
|
amount - Float!
|
|
frequency - String
|
|
bonusUseDollar - Boolean
|
|
bonusDollar - Float
|
|
bonus - Float
|
|
bonusFrequency - String
|
|
commissionUseDollar - Boolean
|
|
commissionDollar - Float
|
|
commission - Float
|
|
commissionFrequency - String
|
|
amountChange - Float
|
|
taxStatus - String
|
Example
{
"incomeId": 123,
"include": true,
"clientId": 987,
"entityId": 987,
"assetId": 987,
"description": "abc123",
"incomeType": "xyz789",
"amount": 123.45,
"frequency": "xyz789",
"bonusUseDollar": true,
"bonusDollar": 123.45,
"bonus": 987.65,
"bonusFrequency": "xyz789",
"commissionUseDollar": false,
"commissionDollar": 987.65,
"commission": 123.45,
"commissionFrequency": "abc123",
"amountChange": 987.65,
"taxStatus": "abc123"
}
BestLifeScenarioLiabilityInput
Fields
| Input Field | Description |
|---|---|
liabilityId - Int!
|
|
include - Boolean!
|
|
clientId - Int
|
|
entityId - Int
|
|
assetId - Int
|
|
description - String!
|
|
liabilityType - String
|
|
loanType - String
|
|
owing - Float!
|
|
rate - Float
|
|
rateType - String
|
|
repayment - Float
|
|
repaymentFrequency - String
|
|
scenarioRepayment - Float
|
|
scenarioRepaymentFrequency - String
|
Example
{
"liabilityId": 123,
"include": true,
"clientId": 987,
"entityId": 123,
"assetId": 123,
"description": "xyz789",
"liabilityType": "abc123",
"loanType": "abc123",
"owing": 123.45,
"rate": 987.65,
"rateType": "abc123",
"repayment": 987.65,
"repaymentFrequency": "abc123",
"scenarioRepayment": 123.45,
"scenarioRepaymentFrequency": "abc123"
}
BestLifeScenarioLifestyleTradeOffInput
Boolean
Description
The Boolean scalar type represents true or false.
Example
true
BusinessPlanningOutput
Example
{
"businessPlanningId": 987,
"householdId": 987,
"clientId": 987,
"legalEntityId": 987,
"hasBusinessDocuments": true,
"createdBy": "abc123",
"created": "xyz789",
"updatedBy": "abc123",
"updated": "abc123"
}
CashFlowJsonHelperInput
CashFlowJsonHelperOutput
Fields
| Field Name | Description |
|---|---|
data - String
|
Example
{"data": "abc123"}
ChangeClientEmailInput
ChangePracticeOfficeEmailInput
ChangeStaffEmailInput
ChangeStateVaultFileInput
CharitablePlanningOutput
Example
{
"charitablePlanningId": 123,
"householdId": 123,
"clientId": 987,
"legalEntityId": 123,
"hasCharitableFoundation": false,
"createdBy": "abc123",
"created": "abc123",
"updatedBy": "xyz789",
"updated": "xyz789"
}
CheckAndMigrateUserInput
CheckAndMigrateUserOutput
CheckEmailAddressAvailableInput
Fields
| Input Field | Description |
|---|---|
emailAddress - String
|
Example
{"emailAddress": "abc123"}
CheckIfUserOnRdsCognitoInput
Fields
| Input Field | Description |
|---|---|
currentEmail - String!
|
Example
{"currentEmail": "abc123"}
CheckIfUserOnRdsCognitoOutput
Fields
| Field Name | Description |
|---|---|
message - String!
|
Example
{"message": "abc123"}
Client
Fields
| Field Name | Description |
|---|---|
clientId - Int!
|
|
householdId - Int
|
|
iamId - String
|
|
wealthIds - [String]
|
|
type - String!
|
|
title - String!
|
|
firstName - String!
|
|
middleName - String
|
|
lastName - String!
|
|
preferredName - String
|
|
dob - String
|
|
lastLogin - String
|
|
registered - Boolean
|
|
billableStart - String
|
|
address - Address
|
|
postalAddress - Address
|
|
contactDetails - ContactDetails
|
|
moduleStates - [ModuleState]
|
|
wellnessScore - Float
|
|
goalCount - Int
|
|
taskCount - Int
|
|
sex - String
|
|
relationshipStatus - String
|
|
countryCodeBirth - String
|
|
countryCodeResidency - String
|
|
countryCodeCitizenship - String
|
|
notes - String
|
|
externalId - String
|
|
externalSystem - String
|
|
createdBy - String!
|
|
created - String!
|
|
updatedBy - String!
|
|
updated - String!
|
Example
{
"clientId": 987,
"householdId": 123,
"iamId": "xyz789",
"wealthIds": ["xyz789"],
"type": "abc123",
"title": "abc123",
"firstName": "xyz789",
"middleName": "xyz789",
"lastName": "abc123",
"preferredName": "abc123",
"dob": "xyz789",
"lastLogin": "xyz789",
"registered": false,
"billableStart": "abc123",
"address": Address,
"postalAddress": Address,
"contactDetails": ContactDetails,
"moduleStates": [ModuleState],
"wellnessScore": 987.65,
"goalCount": 987,
"taskCount": 123,
"sex": "abc123",
"relationshipStatus": "xyz789",
"countryCodeBirth": "xyz789",
"countryCodeResidency": "xyz789",
"countryCodeCitizenship": "xyz789",
"notes": "xyz789",
"externalId": "abc123",
"externalSystem": "abc123",
"createdBy": "abc123",
"created": "xyz789",
"updatedBy": "xyz789",
"updated": "xyz789"
}
ClientAction
Fields
| Field Name | Description |
|---|---|
householdId - Int
|
|
names - String
|
|
description - String
|
|
itemType - AdviserLandingPageCardItemType
|
Example
{
"householdId": 123,
"names": "abc123",
"description": "abc123",
"itemType": "LIFE"
}
ClientAggregate
ClientAndHouseholdValues
Fields
| Field Name | Description |
|---|---|
client - ClientValues
|
|
partner - ClientValues
|
|
household - HouseholdValues
|
|
completed - Boolean
|
Example
{
"client": ClientValues,
"partner": ClientValues,
"household": HouseholdValues,
"completed": false
}
ClientAndHouseholdValuesInput
Fields
| Input Field | Description |
|---|---|
client - ClientValuesInput!
|
|
partner - ClientValuesInput
|
|
household - HouseholdValuesInput
|
|
completed - Boolean
|
Example
{
"client": ClientValuesInput,
"partner": ClientValuesInput,
"household": HouseholdValuesInput,
"completed": false
}
ClientConfig
Fields
| Field Name | Description |
|---|---|
clientConfigId - Int
|
|
clientId - Int
|
|
configuration - ClientConfigConfiguration
|
Example
{
"clientConfigId": 123,
"clientId": 123,
"configuration": ClientConfigConfiguration
}
ClientConfigConfiguration
Fields
| Field Name | Description |
|---|---|
inAppNotifications - ClientConfigConfigurationInAppNotification
|
|
governanceConfig - ClientConfigConfigurationGovernanceConfig
|
Example
{
"inAppNotifications": ClientConfigConfigurationInAppNotification,
"governanceConfig": ClientConfigConfigurationGovernanceConfig
}
ClientConfigConfigurationGovernanceConfig
Fields
| Field Name | Description |
|---|---|
hideEmptySections - Boolean
|
Example
{"hideEmptySections": true}
ClientConfigConfigurationInAppNotification
Fields
| Field Name | Description |
|---|---|
enabled - Boolean
|
Example
{"enabled": true}
ClientDiscovery
Fields
| Field Name | Description |
|---|---|
id - Int
|
|
clientId - Int!
|
|
homeLoanOwing - Float
|
|
investmentDebt - Float
|
|
investmentPropertyDebt - Float
|
|
requiredRetirementIncome - Float
|
|
otherDebt - Float
|
|
superBalance - Float
|
|
savings - Float
|
|
income - Float
|
|
otherAssets - Float
|
|
lifeInsurance - Boolean
|
|
incomeProtection - Boolean
|
|
traumaInsurance - Boolean
|
|
tpdInsurance - Boolean
|
|
desiredRetirementAge - Int
|
Example
{
"id": 987,
"clientId": 987,
"homeLoanOwing": 123.45,
"investmentDebt": 987.65,
"investmentPropertyDebt": 987.65,
"requiredRetirementIncome": 987.65,
"otherDebt": 123.45,
"superBalance": 123.45,
"savings": 987.65,
"income": 123.45,
"otherAssets": 987.65,
"lifeInsurance": true,
"incomeProtection": false,
"traumaInsurance": true,
"tpdInsurance": true,
"desiredRetirementAge": 123
}
ClientDiscoveryInput
Fields
| Input Field | Description |
|---|---|
clientId - Int!
|
|
homeLoanOwing - Float
|
|
investmentDebt - Float
|
|
income - Float
|
|
otherDebt - Float
|
|
superBalance - Float
|
|
savings - Float
|
|
otherAssets - Float
|
|
lifeInsurance - Boolean
|
|
incomeProtection - Boolean
|
|
traumaInsurance - Boolean
|
|
tpdInsurance - Boolean
|
|
desiredRetirementAge - Int
|
|
dob - String
|
Example
{
"clientId": 123,
"homeLoanOwing": 123.45,
"investmentDebt": 987.65,
"income": 123.45,
"otherDebt": 123.45,
"superBalance": 123.45,
"savings": 987.65,
"otherAssets": 987.65,
"lifeInsurance": false,
"incomeProtection": false,
"traumaInsurance": true,
"tpdInsurance": false,
"desiredRetirementAge": 123,
"dob": "xyz789"
}
ClientInfo
ClientOrInviteCodeInput
ClientRegret
ClientRegretInput
ClientValue
Example
{
"id": 987,
"cardId": 987,
"rank": 123,
"meaningReason": "xyz789",
"progressAction": "xyz789",
"createdBy": "xyz789",
"created": "abc123",
"updatedBy": "abc123",
"updated": "abc123"
}
ClientValueInput
ClientValues
Fields
| Field Name | Description |
|---|---|
id - Int
|
|
clientId - Int!
|
|
regrets - [ClientRegret!]
|
|
values - [ClientValue!]!
|
|
createdBy - String!
|
|
created - String!
|
|
updatedBy - String!
|
|
updated - String!
|
Example
{
"id": 987,
"clientId": 123,
"regrets": [ClientRegret],
"values": [ClientValue],
"createdBy": "xyz789",
"created": "xyz789",
"updatedBy": "abc123",
"updated": "abc123"
}
ClientValuesInput
Fields
| Input Field | Description |
|---|---|
id - Int
|
|
clientId - Int!
|
|
regrets - [ClientRegretInput!]
|
|
values - [ClientValueInput!]
|
Example
{
"id": 987,
"clientId": 987,
"regrets": [ClientRegretInput],
"values": [ClientValueInput]
}
ClientWellnessHistoryInput
ClientYodleeSync
Fields
| Field Name | Description |
|---|---|
MessageId - String
|
Example
{"MessageId": "abc123"}
CloneDemoHouseholdsInput
CompareScenariosInput
ComparisonType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"EQ"
Component
ContactDetails
Example
{
"emailAddress": "xyz789",
"mobileNumber": "abc123",
"faxNumber": "xyz789",
"phoneNumber": "abc123",
"createdBy": "xyz789",
"created": "abc123",
"updatedBy": "xyz789",
"updated": "abc123"
}
CreateExternalUploadTrackingInput
CreateFinancialHealthAssessmentSessionInput
Fields
| Input Field | Description |
|---|---|
id - ID
|
|
clientId - Int!
|
|
inviteCode - String!
|
|
householdId - Int
|
|
status - String
|
|
firstName - String
|
|
lastName - String
|
|
fullName - String
|
|
hasPartner - Boolean
|
|
partnerId - Int
|
|
partnerFirstName - String
|
|
partnerLastName - String
|
|
partnerFullName - String
|
|
finHealthAssessmentFull - Boolean
|
|
responses - [FHAResponseInput!]
|
|
visionGoalsScore - Int
|
|
retirementPlanningScore - Int
|
|
insuranceAssetProtectionScore - Int
|
|
debtCashFlowManagementScore - Int
|
|
educationPlanningScore - Int
|
|
investmentPlanningScore - Int
|
|
incomeTaxPlanningScore - Int
|
|
businessPlanningScore - Int
|
|
charitablePlanningScore - Int
|
|
estatePlanningScore - Int
|
Example
{
"id": 4,
"clientId": 987,
"inviteCode": "xyz789",
"householdId": 123,
"status": "abc123",
"firstName": "xyz789",
"lastName": "xyz789",
"fullName": "xyz789",
"hasPartner": true,
"partnerId": 123,
"partnerFirstName": "xyz789",
"partnerLastName": "xyz789",
"partnerFullName": "abc123",
"finHealthAssessmentFull": true,
"responses": [FHAResponseInput],
"visionGoalsScore": 123,
"retirementPlanningScore": 123,
"insuranceAssetProtectionScore": 987,
"debtCashFlowManagementScore": 123,
"educationPlanningScore": 123,
"investmentPlanningScore": 987,
"incomeTaxPlanningScore": 123,
"businessPlanningScore": 123,
"charitablePlanningScore": 123,
"estatePlanningScore": 987
}
CreateGoalsSessionInput
CreateInvestmentPreferencesSessionInput
Fields
| Input Field | Description |
|---|---|
id - ID
|
|
clientId - Int!
|
|
inviteCode - String
|
|
fullName - String
|
|
status - String
|
|
introVideo - String
|
|
customisationVideo - String
|
|
customisation - YesNoMaybe
|
|
ethicalVideo - String
|
|
ethical - YesNoMaybe
|
|
assetClassVideo - String
|
|
allocationVideo - String
|
|
allocationType - AssetAllocationType
|
|
riskVideo - String
|
|
comfortableWithDownturn - String
|
|
costVideo - String
|
|
costDriven - YesNo
|
|
prioritisation - [InvestmentPreferencesRankingInput!]
|
|
comments - String
|
|
customisationVideoHelp - YesNo
|
|
customisationVideoComments - String
|
|
ethicalVideoHelp - YesNo
|
|
ethicalVideoComments - String
|
|
assetClassVideoHelp - YesNo
|
|
assetClassVideoComments - String
|
|
allocationVideoHelp - YesNo
|
|
allocationVideoComments - String
|
|
riskVideoHelp - YesNo
|
|
riskVideoComments - String
|
|
riskDiversification - Int
|
|
riskMarketCorrection - Int
|
|
riskPercentageDrop - Int
|
|
riskCapitalProtection - YesNo
|
|
riskAccessCapital - Int
|
|
riskInfluencedByReturns - Int
|
|
riskIncreaseToMeetGoal - Int
|
|
riskMaxDownside - Int
|
|
riskInflation - Int
|
|
costVideoHelp - YesNo
|
|
costVideoComments - String
|
|
assetClassAndDiversificationVideoHelp - YesNoUnsure
|
|
assetClassPreferences - YesNo
|
|
assetClassPreferencesComments - String
|
|
assetClassRisk - YesNo
|
|
assetClassRiskComments - String
|
|
ethicalPreferences - YesNo
|
|
ethicalPreferencesComments - String
|
|
activePassiveVideoHelp - YesNoUnsure
|
|
costWealthPriorities - WealthPriorities
|
|
riskVolatilityVideoHelp - YesNoUnsure
|
|
riskTimelines - YesNoUnsure
|
|
riskExperience - Int
|
|
riskKnowledge - Int
|
|
riskPast - Int
|
|
riskCurrent - Int
|
|
riskTimeframe - Int
|
|
riskVariability - Int
|
|
riskVolatility - Int
|
|
riskReaction - Int
|
|
riskTolerance - Int
|
|
riskFuture - Int
|
|
includeRiskSection - Boolean
|
|
includeIntroSection - Boolean
|
|
includeCustomisationSection - Boolean
|
|
includeEthicalSection - Boolean
|
|
includeAssetClassSection - Boolean
|
|
includeAllocationSection - Boolean
|
|
includeCostSection - Boolean
|
|
includePrioritisationSection - Boolean
|
|
includeCommentsSection - Boolean
|
Example
{
"id": 4,
"clientId": 123,
"inviteCode": "abc123",
"fullName": "xyz789",
"status": "xyz789",
"introVideo": "abc123",
"customisationVideo": "abc123",
"customisation": "Y",
"ethicalVideo": "abc123",
"ethical": "Y",
"assetClassVideo": "xyz789",
"allocationVideo": "abc123",
"allocationType": "S",
"riskVideo": "xyz789",
"comfortableWithDownturn": "abc123",
"costVideo": "xyz789",
"costDriven": "Y",
"prioritisation": [InvestmentPreferencesRankingInput],
"comments": "abc123",
"customisationVideoHelp": "Y",
"customisationVideoComments": "xyz789",
"ethicalVideoHelp": "Y",
"ethicalVideoComments": "xyz789",
"assetClassVideoHelp": "Y",
"assetClassVideoComments": "abc123",
"allocationVideoHelp": "Y",
"allocationVideoComments": "abc123",
"riskVideoHelp": "Y",
"riskVideoComments": "abc123",
"riskDiversification": 987,
"riskMarketCorrection": 123,
"riskPercentageDrop": 123,
"riskCapitalProtection": "Y",
"riskAccessCapital": 123,
"riskInfluencedByReturns": 123,
"riskIncreaseToMeetGoal": 123,
"riskMaxDownside": 987,
"riskInflation": 987,
"costVideoHelp": "Y",
"costVideoComments": "xyz789",
"assetClassAndDiversificationVideoHelp": "Y",
"assetClassPreferences": "Y",
"assetClassPreferencesComments": "xyz789",
"assetClassRisk": "Y",
"assetClassRiskComments": "xyz789",
"ethicalPreferences": "Y",
"ethicalPreferencesComments": "xyz789",
"activePassiveVideoHelp": "Y",
"costWealthPriorities": "A",
"riskVolatilityVideoHelp": "Y",
"riskTimelines": "Y",
"riskExperience": 987,
"riskKnowledge": 123,
"riskPast": 123,
"riskCurrent": 123,
"riskTimeframe": 123,
"riskVariability": 123,
"riskVolatility": 987,
"riskReaction": 987,
"riskTolerance": 987,
"riskFuture": 123,
"includeRiskSection": true,
"includeIntroSection": false,
"includeCustomisationSection": true,
"includeEthicalSection": true,
"includeAssetClassSection": false,
"includeAllocationSection": true,
"includeCostSection": true,
"includePrioritisationSection": true,
"includeCommentsSection": true
}
CreateLeadInput
Example
{
"recaptchaChallengeAnswer": "xyz789",
"firstName": "abc123",
"lastName": "abc123",
"emailAddress": "abc123",
"mobileNumber": "abc123",
"companyName": "abc123"
}
CreateNotificationInput
Fields
| Input Field | Description |
|---|---|
id - ID
|
|
owner - String
|
|
recipient - String
|
|
message - String
|
|
messageRead - Boolean
|
|
createdAt - AWSDateTime
|
|
updatedAt - AWSDateTime
|
Example
{
"id": 4,
"owner": "xyz789",
"recipient": "abc123",
"message": "xyz789",
"messageRead": true,
"createdAt": AWSDateTime,
"updatedAt": AWSDateTime
}
CreateNotificationPointerInput
Fields
| Input Field | Description |
|---|---|
id - ID
|
|
owner - String
|
|
recipient - String
|
|
notificationId - String
|
|
createdAt - AWSDateTime
|
|
updatedAt - AWSDateTime
|
Example
{
"id": 4,
"owner": "abc123",
"recipient": "xyz789",
"notificationId": "abc123",
"createdAt": AWSDateTime,
"updatedAt": AWSDateTime
}
CreateOriginationSessionInput
Fields
| Input Field | Description |
|---|---|
id - ID
|
|
clientId - Int!
|
|
inviteCode - String!
|
|
householdId - Int
|
|
status - String
|
|
clientFirstName - String
|
|
clientLastName - String
|
|
clientFullName - String
|
|
hasPartner - Boolean
|
|
partnerId - Int
|
|
partnerFirstName - String
|
|
partnerLastName - String
|
|
partnerFullName - String
|
|
questionnaires - [OriginationQuestionnaire!]!
|
|
lifeIncGoals - Boolean
|
|
lifeIncConnections - Boolean
|
|
lifeIncFinancialDetails - Boolean
|
|
finHealthAssessmentFull - Boolean
|
|
foundationsFull - Boolean
|
|
valuesInc3Things - Boolean
|
|
governanceIncPersonalDetails - Boolean
|
|
governanceIncAssetsLiabilitiesIncomeExpenses - Boolean
|
|
governanceIncInsurance - Boolean
|
|
governanceIncBusinessPlanning - Boolean
|
|
governanceIncEducationPlanning - Boolean
|
|
governanceIncCharitablePlanning - Boolean
|
|
governanceIncTaxPlanning - Boolean
|
|
governanceIncEstatePlanning - Boolean
|
|
investmentPreferencesIncRiskSection - Boolean
|
|
investmentPreferencesIncIntroSection - Boolean
|
|
investmentPreferencesIncCustomisationSection - Boolean
|
|
investmentPreferencesIncEthicalSection - Boolean
|
|
investmentPreferencesIncAssetClassSection - Boolean
|
|
investmentPreferencesIncAllocationSection - Boolean
|
|
investmentPreferencesIncCostSection - Boolean
|
|
investmentPreferencesIncPrioritisationSection - Boolean
|
|
investmentPreferencesIncCommentsSection - Boolean
|
|
uploadFileList - [UploadVaultFileInfoInput]
|
|
uploadIdentity - String
|
|
stepTracker - StepTrackerInput
|
|
completedQuestionnaires - [OriginationQuestionnaire!]
|
|
failedQuestionnaires - [OriginationQuestionnaire!]
|
Example
{
"id": "4",
"clientId": 123,
"inviteCode": "xyz789",
"householdId": 987,
"status": "xyz789",
"clientFirstName": "abc123",
"clientLastName": "xyz789",
"clientFullName": "abc123",
"hasPartner": true,
"partnerId": 123,
"partnerFirstName": "abc123",
"partnerLastName": "abc123",
"partnerFullName": "xyz789",
"questionnaires": ["LIFE"],
"lifeIncGoals": false,
"lifeIncConnections": true,
"lifeIncFinancialDetails": true,
"finHealthAssessmentFull": true,
"foundationsFull": true,
"valuesInc3Things": true,
"governanceIncPersonalDetails": false,
"governanceIncAssetsLiabilitiesIncomeExpenses": false,
"governanceIncInsurance": true,
"governanceIncBusinessPlanning": true,
"governanceIncEducationPlanning": true,
"governanceIncCharitablePlanning": true,
"governanceIncTaxPlanning": false,
"governanceIncEstatePlanning": false,
"investmentPreferencesIncRiskSection": false,
"investmentPreferencesIncIntroSection": true,
"investmentPreferencesIncCustomisationSection": false,
"investmentPreferencesIncEthicalSection": true,
"investmentPreferencesIncAssetClassSection": false,
"investmentPreferencesIncAllocationSection": false,
"investmentPreferencesIncCostSection": true,
"investmentPreferencesIncPrioritisationSection": true,
"investmentPreferencesIncCommentsSection": false,
"uploadFileList": [UploadVaultFileInfoInput],
"uploadIdentity": "abc123",
"stepTracker": StepTrackerInput,
"completedQuestionnaires": ["LIFE"],
"failedQuestionnaires": ["LIFE"]
}
CreatePracticeConfigInput
Fields
| Input Field | Description |
|---|---|
practiceName - String!
|
|
practiceId - Int
|
|
includeOrChangePalette - Boolean
|
|
practicePalette - String!
|
|
includeOrChangeTypography - Boolean
|
|
practiceTypography - String!
|
|
includeOrChangeConfiguration - Boolean
|
|
practiceConfiguration - String!
|
|
practiceInvestmentTypeOfVideo - String!
|
Example
{
"practiceName": "xyz789",
"practiceId": 987,
"includeOrChangePalette": true,
"practicePalette": "xyz789",
"includeOrChangeTypography": true,
"practiceTypography": "xyz789",
"includeOrChangeConfiguration": false,
"practiceConfiguration": "abc123",
"practiceInvestmentTypeOfVideo": "xyz789"
}
CreatePracticeConfigOutput
Fields
| Field Name | Description |
|---|---|
createdPracticeConfigId - Int
|
|
videoPreSignedUploadURL - String!
|
|
videoPreSignedUploadURLKey - String!
|
|
videoPreSignedUploadURLAccessKeyId - String!
|
|
videoPreSignedUploadSecurityToken - String!
|
|
videoPreSignedUploadURLPolicy - String!
|
|
videoPreSignedUploadURLSignature - String!
|
Example
{
"createdPracticeConfigId": 987,
"videoPreSignedUploadURL": "abc123",
"videoPreSignedUploadURLKey": "xyz789",
"videoPreSignedUploadURLAccessKeyId": "abc123",
"videoPreSignedUploadSecurityToken": "abc123",
"videoPreSignedUploadURLPolicy": "abc123",
"videoPreSignedUploadURLSignature": "abc123"
}
CreatePracticeInput
Fields
| Input Field | Description |
|---|---|
practiceCountry - String
|
|
practiceName - String
|
|
practiceAbn - String
|
|
practiceAfsl - String
|
|
practiceAfslName - String
|
|
practiceLegalName - String
|
|
practiceContractStart - String
|
|
practiceStatus - String
|
|
practicePackageId - String
|
|
practicePackageDiscount - String
|
|
practiceTCVersion - String
|
Example
{
"practiceCountry": "abc123",
"practiceName": "abc123",
"practiceAbn": "abc123",
"practiceAfsl": "xyz789",
"practiceAfslName": "xyz789",
"practiceLegalName": "xyz789",
"practiceContractStart": "abc123",
"practiceStatus": "abc123",
"practicePackageId": "xyz789",
"practicePackageDiscount": "abc123",
"practiceTCVersion": "xyz789"
}
CreatePracticeLogoInput
CreatePracticeLogoOutput
Fields
| Field Name | Description |
|---|---|
createdPracticeLogoConfigurationId - Int
|
Example
{"createdPracticeLogoConfigurationId": 123}
CreatePracticeOfficeAndStaffInput
Fields
| Input Field | Description |
|---|---|
practiceName - String!
|
|
practiceEmail - String!
|
|
practiceMobile - String!
|
|
practiceOfficeAddressLine1 - String!
|
|
practiceOfficeAddressLine2 - String!
|
|
practiceOfficeSuburb - String!
|
|
practiceOfficePostcode - String!
|
|
practiceOfficeState - String!
|
|
staffEmail - String!
|
|
staffMobile - String!
|
|
staffTitle - String!
|
|
staffFirstName - String!
|
|
staffLastName - String!
|
|
staffRoles - String!
|
|
staffRdsRole - String!
|
|
staffPassword - String!
|
Example
{
"practiceName": "abc123",
"practiceEmail": "abc123",
"practiceMobile": "abc123",
"practiceOfficeAddressLine1": "xyz789",
"practiceOfficeAddressLine2": "abc123",
"practiceOfficeSuburb": "xyz789",
"practiceOfficePostcode": "xyz789",
"practiceOfficeState": "abc123",
"staffEmail": "abc123",
"staffMobile": "abc123",
"staffTitle": "xyz789",
"staffFirstName": "abc123",
"staffLastName": "xyz789",
"staffRoles": "xyz789",
"staffRdsRole": "abc123",
"staffPassword": "abc123"
}
CreatePracticeOfficeAndStaffOutput
CreatePracticeOfficeInput
Example
{
"practiceName": "xyz789",
"practiceOfficeName": "abc123",
"practiceEmail": "xyz789",
"practiceMobile": "xyz789",
"practiceOfficeAddressLine1": "xyz789",
"practiceOfficeAddressLine2": "xyz789",
"practiceOfficeSuburb": "xyz789",
"practiceOfficePostcode": "abc123",
"practiceOfficeState": "xyz789"
}
CreatePracticeOfficeOutput
CreateQuickSurveyInput
Fields
| Input Field | Description |
|---|---|
practiceId - Int
|
|
sessionId - String
|
|
sessionName - String
|
|
surveys - [CreateQuickSurveyInputItem]
|
Example
{
"practiceId": 987,
"sessionId": "xyz789",
"sessionName": "abc123",
"surveys": [CreateQuickSurveyInputItem]
}
CreateQuickSurveyInputItem
Fields
| Input Field | Description |
|---|---|
surveyId - String
|
|
surveyName - String
|
|
lifeIncludeConnections - Boolean
|
|
lifeIncludeGoals - Boolean
|
|
valuesIncludeLegacy - Boolean
|
|
foundationsShort - Boolean
|
|
foundationsLong - Boolean
|
|
foundationsIncludeDetails - Boolean
|
|
foundationsIncludeInsurance - Boolean
|
|
foundationsIncludeEstatePlanning - Boolean
|
|
foundationsIncludeBusinessPlanning - Boolean
|
|
fhaLongAssessment - Boolean
|
|
fhaShortAssessment - Boolean
|
Example
{
"surveyId": "abc123",
"surveyName": "xyz789",
"lifeIncludeConnections": false,
"lifeIncludeGoals": true,
"valuesIncludeLegacy": true,
"foundationsShort": false,
"foundationsLong": true,
"foundationsIncludeDetails": true,
"foundationsIncludeInsurance": true,
"foundationsIncludeEstatePlanning": false,
"foundationsIncludeBusinessPlanning": false,
"fhaLongAssessment": false,
"fhaShortAssessment": true
}
CreateQuickSurveyOutput
Fields
| Field Name | Description |
|---|---|
message - String
|
Example
{"message": "abc123"}
CreateRedtailLoadErrorsInput
CreateRegistrationInput
CreateSecurityInput
Example
{
"id": "4",
"assetClassName": "xyz789",
"code": "xyz789",
"description": "xyz789",
"exchange": "abc123",
"msCode": "abc123",
"msNonFundCode": "abc123",
"name": "abc123",
"securityId": 123,
"securityType": "abc123",
"securityGroup": "xyz789",
"ticker": "xyz789"
}
CreateSurveyResponseDataInput
Example
{
"id": 4,
"clientId": 123,
"inviteCode": "xyz789",
"householdId": 987,
"keyValueData": "abc123",
"status": "SENT",
"surveyId": "xyz789",
"progress": 987.65
}
CreateTamaracLoadErrorsInput
Fields
| Input Field | Description |
|---|---|
id - ID
|
|
sourceFile - String
|
|
errorMessage - String
|
|
tamaracPayload - String
|
|
accountId - String
|
|
accountNumber - String
|
|
primaryMemberFirstName - String
|
|
primaryMemberLastName - String
|
|
fuzzyRatio - String
|
|
rdsCombinedAddressString - String
|
|
tamaracCombinedAddressString - String
|
Example
{
"id": "4",
"sourceFile": "abc123",
"errorMessage": "abc123",
"tamaracPayload": "abc123",
"accountId": "abc123",
"accountNumber": "abc123",
"primaryMemberFirstName": "abc123",
"primaryMemberLastName": "abc123",
"fuzzyRatio": "abc123",
"rdsCombinedAddressString": "xyz789",
"tamaracCombinedAddressString": "xyz789"
}
CreateYourLifeSessionInput
Fields
| Input Field | Description |
|---|---|
id - ID
|
|
clientId - Int!
|
|
inviteCode - String!
|
|
householdId - Int
|
|
status - String
|
|
firstName - String
|
|
lastName - String
|
|
fullName - String
|
|
hasPartner - Boolean
|
|
partnerId - Int
|
|
includeGoals - Boolean
|
|
includeConnections - Boolean
|
|
includeFinancialDetails - Boolean
|
|
partnerFirstName - String
|
|
partnerLastName - String
|
|
partnerFullName - String
|
|
responses - [LifeResponseInput!]
|
|
lovedOnes - [String!]
|
|
communityConnections - [String!]
|
|
globalConnections - [String!]
|
|
overallScore - Float
|
|
emotionalScore - Float
|
|
environmentalScore - Float
|
|
spiritualScore - Float
|
|
socialScore - Float
|
|
educationScore - Float
|
|
occupationalScore - Float
|
|
physicalScore - Float
|
|
financialScore - Float
|
|
notes - [LifeNoteInput]
|
Example
{
"id": "4",
"clientId": 987,
"inviteCode": "xyz789",
"householdId": 123,
"status": "xyz789",
"firstName": "xyz789",
"lastName": "xyz789",
"fullName": "abc123",
"hasPartner": true,
"partnerId": 987,
"includeGoals": false,
"includeConnections": false,
"includeFinancialDetails": false,
"partnerFirstName": "xyz789",
"partnerLastName": "xyz789",
"partnerFullName": "xyz789",
"responses": [LifeResponseInput],
"lovedOnes": ["xyz789"],
"communityConnections": ["abc123"],
"globalConnections": ["abc123"],
"overallScore": 123.45,
"emotionalScore": 123.45,
"environmentalScore": 987.65,
"spiritualScore": 123.45,
"socialScore": 123.45,
"educationScore": 987.65,
"occupationalScore": 123.45,
"physicalScore": 987.65,
"financialScore": 123.45,
"notes": [LifeNoteInput]
}
CreateYourLifeSurveyInput
Example
{
"practiceCode": "xyz789",
"recaptchaChallengeAnswer": "xyz789",
"firstName": "abc123",
"lastName": "abc123",
"emailAddress": "abc123",
"mobileNumber": "abc123"
}
CreateYourValuesSessionInput
Fields
| Input Field | Description |
|---|---|
id - ID
|
|
clientId - Int!
|
|
inviteCode - String
|
|
partnerId - Int
|
|
partnerInviteCode - String
|
|
client - ValuesClientInput
|
|
partner - ValuesClientInput
|
|
adviser - ValuesStaffInput
|
|
support - ValuesStaffInput
|
|
alignedValues - [ValuesAlignedValueInput!]
|
|
valuesInc3Things - Boolean
|
|
partnerValuesInc3Things - Boolean
|
|
individualValuesOnly - Boolean
|
|
step - String
|
|
lastSeen - String
|
Example
{
"id": "4",
"clientId": 987,
"inviteCode": "abc123",
"partnerId": 123,
"partnerInviteCode": "abc123",
"client": ValuesClientInput,
"partner": ValuesClientInput,
"adviser": ValuesStaffInput,
"support": ValuesStaffInput,
"alignedValues": [ValuesAlignedValueInput],
"valuesInc3Things": true,
"partnerValuesInc3Things": false,
"individualValuesOnly": true,
"step": "abc123",
"lastSeen": "abc123"
}
DeactivateStaffInput
Fields
| Input Field | Description |
|---|---|
currentEmail - String!
|
Example
{"currentEmail": "abc123"}
DeactivateStaffOutput
Fields
| Field Name | Description |
|---|---|
updateMsg - String!
|
Example
{"updateMsg": "xyz789"}
DealerGroup
Example
{
"dealerGroupId": 987,
"name": "abc123",
"abn": "abc123",
"afsl": "xyz789",
"afslName": "xyz789",
"legalName": "abc123",
"createdBy": "abc123",
"created": "abc123",
"updatedBy": "xyz789",
"updated": "abc123"
}
DefaultScenarioBestLifeProjectionInput
Fields
| Input Field | Description |
|---|---|
clientId - Int
|
Example
{"clientId": 123}
DeleteAssetInput
DeleteBeneficiaryInput
DeleteBestLifeScenarioInput
DeleteBusinessPlanningInput
DeleteCharitablePlanningInput
DeleteClientInput
DeleteClientWealthIdInput
DeleteClientWealthIdsInput
DeleteDirectorInput
DeleteEducationPlanningInput
DeleteEmploymentDetailsInput
DeleteEstatePlanningInput
DeleteExecutorInput
DeleteExpenseInput
DeleteExternalUploadTrackingInput
Fields
| Input Field | Description |
|---|---|
id - ID!
|
Example
{"id": "4"}
DeleteFinancialHealthAssessmentSessionInput
Fields
| Input Field | Description |
|---|---|
id - ID!
|
Example
{"id": "4"}
DeleteGoalInput
DeleteGoalsSessionInput
Fields
| Input Field | Description |
|---|---|
id - ID!
|
Example
{"id": 4}
DeleteHealthDetailsInput
DeleteHoldingInput
DeleteHouseholdKeyAdviceAreaInput
DeleteHouseholdMemberInput
DeleteHouseholdStrategyInput
DeleteIncomeInput
DeleteInsuranceInput
DeleteInvestmentPreferencesSessionInput
Fields
| Input Field | Description |
|---|---|
id - ID!
|
Example
{"id": 4}
DeleteLegalEntityInput
DeleteLiabilityInput
DeleteLivingDiscretionaryExpenseInput
DeleteNotificationInput
Fields
| Input Field | Description |
|---|---|
id - ID!
|
Example
{"id": 4}
DeleteNotificationPointerInput
Fields
| Input Field | Description |
|---|---|
id - ID!
|
Example
{"id": "4"}
DeleteOriginationSessionInput
Fields
| Input Field | Description |
|---|---|
id - ID!
|
Example
{"id": "4"}
DeletePortfolioInput
DeletePowerOfInput
DeletePracticeAssetAllocationsInput
DeletePracticeIntegrationInput
DeletePracticeKeyAdviceAreaInput
DeletePracticeRiskProfileInput
DeletePracticeSegmentationInput
DeletePracticeStrategyInput
DeletePresignedUrlFileInput
DeleteProfessionalContactInput
DeleteProfileImageInput
Fields
| Input Field | Description |
|---|---|
imageName - String!
|
Example
{"imageName": "abc123"}
DeleteProfileImageOutput
DeleteQuickSurveyInput
DeleteRedtailLoadErrorsInput
Fields
| Input Field | Description |
|---|---|
id - ID!
|
Example
{"id": 4}
DeleteRegistrationInput
Fields
| Input Field | Description |
|---|---|
id - ID!
|
Example
{"id": 4}
DeleteRetirementDetailsInput
DeleteRiskProfileInput
DeleteScenarioInput
DeleteSecurityInput
Fields
| Input Field | Description |
|---|---|
id - ID!
|
Example
{"id": "4"}
DeleteSensitiveDetailsInput
DeleteSuperBeneficiaryInput
DeleteSurveyResponseDataInput
Fields
| Input Field | Description |
|---|---|
id - ID!
|
Example
{"id": 4}
DeleteTamaracLoadErrorsInput
Fields
| Input Field | Description |
|---|---|
id - ID!
|
Example
{"id": 4}
DeleteTaskInput
Fields
| Input Field | Description |
|---|---|
id - Int
|
Example
{"id": 123}
DeleteTaxDetailsInput
DeleteTaxPlanningInput
DeleteTrustBeneficiaryInput
DeleteTrusteeInput
DeleteVaultFileInput
DeleteVaultFolderInput
DeleteYourLifeSessionInput
Fields
| Input Field | Description |
|---|---|
id - ID!
|
Example
{"id": "4"}
DeleteYourValuesSessionInput
Fields
| Input Field | Description |
|---|---|
id - ID!
|
Example
{"id": "4"}
DirectorOutput
Fields
| Field Name | Description |
|---|---|
directorId - Int!
|
|
legalEntityId - Int!
|
|
firstName - String
|
|
middleName - String
|
|
lastName - String
|
|
dateAppointed - String
|
|
notes - String
|
|
clientNotes - String
|
|
partnerNotes - String
|
|
confidentialNotes - String
|
|
createdBy - String!
|
|
created - String!
|
|
updatedBy - String!
|
|
updated - String!
|
Example
{
"directorId": 987,
"legalEntityId": 123,
"firstName": "abc123",
"middleName": "xyz789",
"lastName": "xyz789",
"dateAppointed": "abc123",
"notes": "xyz789",
"clientNotes": "xyz789",
"partnerNotes": "abc123",
"confidentialNotes": "abc123",
"createdBy": "xyz789",
"created": "abc123",
"updatedBy": "abc123",
"updated": "xyz789"
}
DisconnectYodleeClientInput
Discovery
Fields
| Field Name | Description |
|---|---|
id - Int
|
|
householdId - Int!
|
|
clientDiscovery - ClientDiscovery!
|
|
partnerDiscovery - ClientDiscovery
|
|
householdIncome - Float
|
|
additionalHouseholdIncome - Float
|
|
householdSavings - Float
|
|
householdTotalAssets - Float
|
|
householdTotalDebt - Float
|
|
superContributions - YesNoMaybe!
|
|
superContributionsDetails - String
|
|
savingsRegularity - SavingsRegularity
|
|
savingsAmount - Float
|
|
homeValue - Float
|
|
investmentPropertiesValue - Float
|
|
investmentPropertiesDebt - Float
|
|
requiredRetirementIncome - Float
|
|
referenceModel - Int
|
Example
{
"id": 987,
"householdId": 123,
"clientDiscovery": ClientDiscovery,
"partnerDiscovery": ClientDiscovery,
"householdIncome": 123.45,
"additionalHouseholdIncome": 123.45,
"householdSavings": 987.65,
"householdTotalAssets": 987.65,
"householdTotalDebt": 987.65,
"superContributions": "Y",
"superContributionsDetails": "abc123",
"savingsRegularity": "O",
"savingsAmount": 987.65,
"homeValue": 987.65,
"investmentPropertiesValue": 987.65,
"investmentPropertiesDebt": 987.65,
"requiredRetirementIncome": 987.65,
"referenceModel": 123
}
DiscoveryInput
Fields
| Input Field | Description |
|---|---|
householdId - Int!
|
|
inviteCode - String!
|
|
clientDiscovery - ClientDiscoveryInput!
|
|
partnerDiscovery - ClientDiscoveryInput
|
|
householdIncome - Float
|
|
householdSavings - Float
|
|
householdTotalAssets - Float
|
|
householdTotalDebt - Float
|
|
superContributions - YesNoMaybe
|
|
superContributionsDetails - String
|
|
savingsRegularity - SavingsRegularity
|
|
savingsAmount - Float
|
|
additionalHouseholdIncome - Float
|
|
homeValue - Float
|
|
investmentPropertiesValue - Float
|
|
investmentPropertiesDebt - Float
|
|
requiredRetirementIncome - Float
|
|
referenceModel - Int
|
Example
{
"householdId": 123,
"inviteCode": "abc123",
"clientDiscovery": ClientDiscoveryInput,
"partnerDiscovery": ClientDiscoveryInput,
"householdIncome": 987.65,
"householdSavings": 123.45,
"householdTotalAssets": 123.45,
"householdTotalDebt": 987.65,
"superContributions": "Y",
"superContributionsDetails": "xyz789",
"savingsRegularity": "O",
"savingsAmount": 123.45,
"additionalHouseholdIncome": 123.45,
"homeValue": 987.65,
"investmentPropertiesValue": 987.65,
"investmentPropertiesDebt": 987.65,
"requiredRetirementIncome": 987.65,
"referenceModel": 123
}
EditHouseholdInput
EducationPlanningOutput
Example
{
"educationPlanningId": 987,
"householdId": 987,
"clientId": 987,
"legalEntityId": 123,
"hasEducationSavings": true,
"createdBy": "xyz789",
"created": "xyz789",
"updatedBy": "abc123",
"updated": "abc123"
}
EmailTempPasswordToStaffInput
EmailTempPasswordToStaffOutput
Fields
| Field Name | Description |
|---|---|
updateMessage - String!
|
Example
{"updateMessage": "xyz789"}
EmailYourVaultFileInput
EmploymentDetailsOutput
Fields
| Field Name | Description |
|---|---|
employmentDetailsId - Int!
|
|
clientId - Int
|
|
degreeQualified - Boolean
|
|
qualifications - String
|
|
recentRetrenched - Boolean
|
|
employmentStatus - String
|
|
plannedChanges - Boolean
|
|
plannedChangesDescription - String
|
|
businessStructure - String
|
|
employedByOwnCompany - Boolean
|
|
occupation - String
|
|
startDate - String
|
|
employer - String
|
|
secondaryOccupation - String
|
|
secondaryOccupationStartDate - String
|
|
secondaryOccupationEmployer - String
|
|
employmentHoursPerWeek - Float
|
|
unusedAnnualLeave - Float
|
|
unusedSickLeave - Float
|
|
unusedLongServiceLeave - Float
|
|
workedOverseas - Boolean
|
|
workedOverseasDetails - String
|
|
salarySacrificeAvailable - Boolean
|
|
notes - String
|
|
confidentialNotes - String
|
|
createdBy - String!
|
|
created - String!
|
|
updatedBy - String!
|
|
updated - String!
|
Example
{
"employmentDetailsId": 987,
"clientId": 987,
"degreeQualified": true,
"qualifications": "abc123",
"recentRetrenched": true,
"employmentStatus": "abc123",
"plannedChanges": true,
"plannedChangesDescription": "abc123",
"businessStructure": "xyz789",
"employedByOwnCompany": true,
"occupation": "abc123",
"startDate": "xyz789",
"employer": "xyz789",
"secondaryOccupation": "xyz789",
"secondaryOccupationStartDate": "xyz789",
"secondaryOccupationEmployer": "abc123",
"employmentHoursPerWeek": 123.45,
"unusedAnnualLeave": 123.45,
"unusedSickLeave": 123.45,
"unusedLongServiceLeave": 987.65,
"workedOverseas": true,
"workedOverseasDetails": "abc123",
"salarySacrificeAvailable": false,
"notes": "abc123",
"confidentialNotes": "abc123",
"createdBy": "abc123",
"created": "abc123",
"updatedBy": "abc123",
"updated": "abc123"
}
EnableDisableCognitoUserInput
EnableDisableCognitoUserOutput
Fields
| Field Name | Description |
|---|---|
updateMsg - String!
|
Example
{"updateMsg": "abc123"}
EnableDisableLoginMfaInput
Example
{
"userIsStaffOrClient": "xyz789",
"currentEmail": "abc123",
"authenticatorAppEnabledDisabledInput": "xyz789",
"smsEnabledDisabledInput": "xyz789",
"authenticatorAppOrSmsAsPreferredMfa": "xyz789"
}
EnableDisableLoginMfaOutput
Fields
| Field Name | Description |
|---|---|
updateMsg - String!
|
Example
{"updateMsg": "abc123"}
EnqueueClientYodleeSyncInput
EntityTypesApprovals
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"GOAL"
EstatePlanningOutput
Fields
| Field Name | Description |
|---|---|
estatePlanningId - Int!
|
|
householdId - Int
|
|
clientId - Int
|
|
solicitorName - String
|
|
willInPlace - Boolean
|
|
isWillCurrent - Boolean
|
|
willDate - String
|
|
willLocation - String
|
|
willProvisions - String
|
|
healthcareDirective - Boolean
|
|
healthcareDirectiveDetails - String
|
|
funeralArrangement - String
|
|
funeralDetails - String
|
|
prepaidFuneral - Boolean
|
|
funeralExpenseValue - Float
|
|
purchaseDate - String
|
|
accountNumber - String
|
|
productProvider - String
|
|
superBeneficiariesNominated - Boolean
|
|
beneficiariesNominated - Boolean
|
|
poaGranted - Boolean
|
|
pogGranted - Boolean
|
|
apoaGranted - Boolean
|
|
letterOfWishes - Boolean
|
|
notes - String
|
|
clientNotes - String
|
|
partnerNotes - String
|
|
confidentialNotes - String
|
|
createdBy - String!
|
|
created - String!
|
|
updatedBy - String!
|
|
updated - String!
|
Example
{
"estatePlanningId": 987,
"householdId": 123,
"clientId": 123,
"solicitorName": "xyz789",
"willInPlace": false,
"isWillCurrent": false,
"willDate": "xyz789",
"willLocation": "abc123",
"willProvisions": "xyz789",
"healthcareDirective": false,
"healthcareDirectiveDetails": "abc123",
"funeralArrangement": "abc123",
"funeralDetails": "xyz789",
"prepaidFuneral": false,
"funeralExpenseValue": 123.45,
"purchaseDate": "xyz789",
"accountNumber": "xyz789",
"productProvider": "xyz789",
"superBeneficiariesNominated": false,
"beneficiariesNominated": false,
"poaGranted": false,
"pogGranted": true,
"apoaGranted": true,
"letterOfWishes": false,
"notes": "abc123",
"clientNotes": "xyz789",
"partnerNotes": "xyz789",
"confidentialNotes": "xyz789",
"createdBy": "abc123",
"created": "xyz789",
"updatedBy": "abc123",
"updated": "xyz789"
}
ExecutorOutput
Example
{
"executorId": 123,
"estatePlanningId": 123,
"firstName": "xyz789",
"middleName": "abc123",
"lastName": "xyz789",
"notes": "xyz789",
"clientNotes": "abc123",
"partnerNotes": "xyz789",
"confidentialNotes": "abc123",
"createdBy": "xyz789",
"created": "abc123",
"updatedBy": "abc123",
"updated": "abc123"
}
ExpenseOutput
Fields
| Field Name | Description |
|---|---|
expenseId - Int!
|
|
householdId - Int
|
|
clientId - Int
|
|
clientFirstName - String
|
|
clientLastName - String
|
|
clientPreferredName - String
|
|
legalEntityId - Int
|
|
legalEntityName - String
|
|
assetId - Int
|
|
expenseType - String!
|
|
expenseSubType - String
|
|
savingsPlanType - String
|
|
description - String
|
|
amount - Float
|
|
amountBps - Float
|
|
discretionaryAmount - Float
|
|
frequency - String
|
|
endYear - Int
|
|
stopAllowance - String
|
|
stopAllowanceAge - Int
|
|
feeIncreaseBps - Float
|
|
changesExpected - Boolean
|
|
timeFrame - String
|
|
notes - String
|
|
clientNotes - String
|
|
partnerNotes - String
|
|
confidentialNotes - String
|
|
createdBy - String!
|
|
created - String!
|
|
updatedBy - String!
|
|
updated - String!
|
Example
{
"expenseId": 987,
"householdId": 987,
"clientId": 987,
"clientFirstName": "abc123",
"clientLastName": "abc123",
"clientPreferredName": "abc123",
"legalEntityId": 123,
"legalEntityName": "xyz789",
"assetId": 123,
"expenseType": "abc123",
"expenseSubType": "abc123",
"savingsPlanType": "abc123",
"description": "abc123",
"amount": 987.65,
"amountBps": 987.65,
"discretionaryAmount": 123.45,
"frequency": "abc123",
"endYear": 987,
"stopAllowance": "xyz789",
"stopAllowanceAge": 987,
"feeIncreaseBps": 123.45,
"changesExpected": false,
"timeFrame": "abc123",
"notes": "abc123",
"clientNotes": "abc123",
"partnerNotes": "xyz789",
"confidentialNotes": "abc123",
"createdBy": "abc123",
"created": "abc123",
"updatedBy": "abc123",
"updated": "abc123"
}
ExportGovernanceZipInput
ExternalSystem
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"IL"
ExternalUploadTracking
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
fullS3ObjectPath - String!
|
|
identityId - String!
|
|
objectKey - String!
|
|
practiceId - Int
|
|
clientId - Int
|
|
goalId - Int
|
|
createdAt - AWSDateTime!
|
|
updatedAt - AWSDateTime!
|
Example
{
"id": "4",
"fullS3ObjectPath": "xyz789",
"identityId": "abc123",
"objectKey": "abc123",
"practiceId": 987,
"clientId": 987,
"goalId": 123,
"createdAt": AWSDateTime,
"updatedAt": AWSDateTime
}
FHAResponse
FHAResponseInput
FilterGroupInput
Fields
| Input Field | Description |
|---|---|
operator - FilterOperator
|
|
filters - [FilterInput]
|
|
filterGroups - [FilterGroupInput]
|
Example
{
"operator": "AND",
"filters": [FilterInput],
"filterGroups": [FilterGroupInput]
}
FilterInput
Fields
| Input Field | Description |
|---|---|
field - String!
|
|
comparison - ComparisonType!
|
|
value - String!
|
Example
{
"field": "xyz789",
"comparison": "EQ",
"value": "abc123"
}
FilterOperator
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"AND"
FinancialHealthAssessmentSession
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
clientId - Int!
|
|
inviteCode - String!
|
|
householdId - Int
|
|
status - String
|
|
firstName - String
|
|
lastName - String
|
|
fullName - String
|
|
hasPartner - Boolean
|
|
partnerId - Int
|
|
partnerFirstName - String
|
|
partnerLastName - String
|
|
partnerFullName - String
|
|
finHealthAssessmentFull - Boolean
|
|
responses - [FHAResponse!]
|
|
visionGoalsScore - Int
|
|
retirementPlanningScore - Int
|
|
insuranceAssetProtectionScore - Int
|
|
debtCashFlowManagementScore - Int
|
|
educationPlanningScore - Int
|
|
investmentPlanningScore - Int
|
|
incomeTaxPlanningScore - Int
|
|
businessPlanningScore - Int
|
|
charitablePlanningScore - Int
|
|
estatePlanningScore - Int
|
|
createdAt - AWSDateTime!
|
|
updatedAt - AWSDateTime!
|
Example
{
"id": "4",
"clientId": 123,
"inviteCode": "abc123",
"householdId": 123,
"status": "xyz789",
"firstName": "xyz789",
"lastName": "abc123",
"fullName": "xyz789",
"hasPartner": false,
"partnerId": 123,
"partnerFirstName": "xyz789",
"partnerLastName": "abc123",
"partnerFullName": "abc123",
"finHealthAssessmentFull": false,
"responses": [FHAResponse],
"visionGoalsScore": 987,
"retirementPlanningScore": 987,
"insuranceAssetProtectionScore": 987,
"debtCashFlowManagementScore": 987,
"educationPlanningScore": 987,
"investmentPlanningScore": 123,
"incomeTaxPlanningScore": 987,
"businessPlanningScore": 123,
"charitablePlanningScore": 123,
"estatePlanningScore": 987,
"createdAt": AWSDateTime,
"updatedAt": AWSDateTime
}
Float
Description
The Float scalar type represents signed double-precision fractional values as specified by IEEE 754.
Example
987.65
FoundationSurveyOutput
Fields
| Field Name | Description |
|---|---|
householdId - Int
|
|
clientId - Int
|
|
partnerId - Int
|
|
incomeHousehold - Float
|
|
householdMonthlySpend - Float
|
|
totalAssets - Float
|
|
totalLiabilities - Float
|
|
dobClient - String
|
|
stateOfResidencyClient - String
|
|
employmentStatusClient - String
|
|
incomeClient - Float
|
|
retirementAgeClient - Int
|
|
retirementIncomeClient - Float
|
|
retirementLifestyleClient - String
|
|
dobPartner - String
|
|
stateOfResidencyPartner - String
|
|
employmentStatusPartner - String
|
|
incomePartner - Float
|
|
retirementAgePartner - Int
|
|
retirementIncomePartner - Float
|
|
retirementLifestylePartner - String
|
Example
{
"householdId": 987,
"clientId": 123,
"partnerId": 123,
"incomeHousehold": 123.45,
"householdMonthlySpend": 123.45,
"totalAssets": 123.45,
"totalLiabilities": 123.45,
"dobClient": "xyz789",
"stateOfResidencyClient": "abc123",
"employmentStatusClient": "xyz789",
"incomeClient": 123.45,
"retirementAgeClient": 987,
"retirementIncomeClient": 987.65,
"retirementLifestyleClient": "abc123",
"dobPartner": "xyz789",
"stateOfResidencyPartner": "xyz789",
"employmentStatusPartner": "abc123",
"incomePartner": 987.65,
"retirementAgePartner": 123,
"retirementIncomePartner": 987.65,
"retirementLifestylePartner": "abc123"
}
GenerateAdviserTrendDataInput
GenerateClientHouseholdStatsInput
GenerateHaloLinkInput
GenerateHaloLinkOutput
Fields
| Field Name | Description |
|---|---|
url - String
|
Example
{"url": "abc123"}
GenerateHouseholdTrendDataInput
GenerateLifebookInput
Fields
| Input Field | Description |
|---|---|
clientId - Int!
|
|
adviserComments - String
|
|
includeLife - Boolean
|
|
includeValues - Boolean
|
|
includeGoals - Boolean
|
|
includeInvestmentPreferences - Boolean
|
|
includeTasks - Boolean
|
|
includeClientAcknowledgement - Boolean
|
|
outputFormat - String
|
|
countryOverride - String
|
|
includeHealthAssessment - Boolean
|
|
includeGovernance - Boolean
|
|
includeInvestments - Boolean
|
|
includeNetworth - Boolean
|
|
includeFoundations - Boolean
|
|
includeKAA - Boolean
|
Example
{
"clientId": 987,
"adviserComments": "xyz789",
"includeLife": true,
"includeValues": false,
"includeGoals": true,
"includeInvestmentPreferences": false,
"includeTasks": false,
"includeClientAcknowledgement": false,
"outputFormat": "abc123",
"countryOverride": "xyz789",
"includeHealthAssessment": true,
"includeGovernance": true,
"includeInvestments": false,
"includeNetworth": true,
"includeFoundations": true,
"includeKAA": true
}
GenerateModuleUsageStatsInput
GeneratePracticeTrendDataInput
GenerateStaffLastLoginStatsInput
GenerateSurveysSessionInput
Fields
| Input Field | Description |
|---|---|
practiceId - Int
|
|
householdId - Int
|
|
clientId - Int
|
|
sessionName - String
|
|
surveys - [SurveyInputParams]
|
Example
{
"practiceId": 987,
"householdId": 987,
"clientId": 987,
"sessionName": "xyz789",
"surveys": [SurveyInputParams]
}
GenerateSurveysSessionOutput
Fields
| Field Name | Description |
|---|---|
inviteCode - String
|
Example
{"inviteCode": "xyz789"}
GenerateTermsOfEngagementInput
Example
{
"clientId": 123,
"outputFormat": "abc123",
"countryOverride": "abc123",
"initialFee": 123.45,
"depositPayable": 987.65,
"allAssetsUnderManagement": 123.45,
"minimumAnnualFee": 987.65
}
GenerateYourLifeSurveysSessionInput
Example
{
"practiceCode": "abc123",
"recaptchaChallengeAnswer": "abc123",
"firstName": "abc123",
"lastName": "abc123",
"emailAddress": "abc123",
"mobileNumber": "abc123"
}
GenerateYourLifeSurveysSessionOutput
GetAssetInput
GetAssetsInput
GetBeneficiariesInput
GetBeneficiaryInput
GetBestLifeScenarioInput
GetBestLifeScenariosInput
GetBestLifeScoreInput
GetBusinessPlanningInput
GetBusinessPlanningsInput
GetCharitablePlanningInput
GetCharitablePlanningsInput
GetClientActionsInput
GetClientActionsOutput
Fields
| Field Name | Description |
|---|---|
clientActions - [ClientAction]
|
Example
{"clientActions": [ClientAction]}
GetClientConfig
GetClientWealthIdsInput
GetClientYodleeTokenInput
GetClientYodleeTokenOutput
GetClientsInput
Fields
| Input Field | Description |
|---|---|
practiceId - Int
|
|
filterGroup - FilterGroupInput
|
|
sort - SortInput
|
|
pagination - PaginationInput
|
Example
{
"practiceId": 987,
"filterGroup": FilterGroupInput,
"sort": SortInput,
"pagination": PaginationInput
}
GetClientsOutput
Fields
| Field Name | Description |
|---|---|
clients - [Client]
|
|
pagination - Pagination
|
Example
{
"clients": [Client],
"pagination": Pagination
}
GetDirectorInput
GetDirectorsInput
GetEducationPlanningInput
GetEducationPlanningsInput
GetEmploymentDetailsInput
GetEstatePlanningInput
GetEstatePlanningsInput
GetExecutorInput
GetExecutorsInput
GetExpenseInput
GetExpensesInput
GetFoundationSurveyInput
GetGoalsInput
GetHealthDetailsInput
GetHoldingInput
GetHoldingsInput
GetHouseholdActivityInput
GetHouseholdActivityOutput
Example
{
"householdId": 123,
"bestLifePlanLastExported": "xyz789",
"toeLastExported": "xyz789",
"governanceLastExported": "abc123",
"haloCFOLastSent": "xyz789",
"haloCFOLastCompleted": "abc123",
"haloNonCFOLastSent": "xyz789",
"haloNonCFOLastCompleted": "abc123"
}
GetHouseholdConfig
GetHouseholdInput
Example
{
"inviteClientId": 987,
"inviteCode": "xyz789",
"practiceId": 123,
"householdId": 123,
"clientId": 123,
"externalId": "xyz789",
"externalSystem": "xyz789"
}
GetHouseholdKeyAdviceAreasInput
GetHouseholdMemberInput
GetHouseholdMembersInput
GetHouseholdPendingApprovalsInput
GetHouseholdPendingApprovalsOutput
Fields
| Field Name | Description |
|---|---|
approvals - [HouseholdApprovalItem]!
|
|
page - Int!
|
|
pageSize - Int!
|
|
pages - Int!
|
|
totalCount - Int!
|
Example
{
"approvals": [HouseholdApprovalItem],
"page": 987,
"pageSize": 987,
"pages": 123,
"totalCount": 123
}
GetHouseholdStrategiesInput
GetHouseholdSummaryInput
GetHouseholdTeamMembers
GetHouseholdVaultContentsInput
GetHouseholdsInput
Fields
| Input Field | Description |
|---|---|
practiceId - Int
|
|
filterGroup - FilterGroupInput
|
|
sort - SortInput
|
|
pagination - PaginationInput
|
Example
{
"practiceId": 987,
"filterGroup": FilterGroupInput,
"sort": SortInput,
"pagination": PaginationInput
}
GetHouseholdsOutput
Fields
| Field Name | Description |
|---|---|
households - [Household]
|
|
pagination - Pagination
|
Example
{
"households": [Household],
"pagination": Pagination
}
GetIncomeInput
GetIncomesInput
GetInsuranceInput
GetInsurancesInput
GetInvestmentPreferencesInput
Fields
| Input Field | Description |
|---|---|
clientId - Int
|
Example
{"clientId": 123}
GetInvestmentPreferencesVideosInput
Fields
| Input Field | Description |
|---|---|
practiceCode - String
|
Example
{"practiceCode": "xyz789"}
GetItemsToThinkAboutInput
GetItemsToThinkAboutOutput
Fields
| Field Name | Description |
|---|---|
itemsToThinkAbout - [ItemToThinkAbout]
|
Example
{"itemsToThinkAbout": [ItemToThinkAbout]}
GetLatestDiscoveryInput
GetLatestHealthAssessmentHouseholdInput
GetLatestHealthAssessmentInput
GetLatestYourLifeInput
Fields
| Input Field | Description |
|---|---|
householdId - Int
|
Example
{"householdId": 987}
GetLatestYourLifeOutput
GetLatestYourValuesInput
Fields
| Input Field | Description |
|---|---|
clientId - Int!
|
Example
{"clientId": 987}
GetLearnWorldLoginLinkRequest
Fields
| Input Field | Description |
|---|---|
staffId - Int
|
Example
{"staffId": 987}
GetLegalEntitiesInput
GetLegalEntityInput
GetLiabilitiesInput
GetLiabilityInput
GetLifeHistoryInput
GetLifeHistoryOutput
Fields
| Field Name | Description |
|---|---|
client - [LifeHistoryOutput]
|
|
partner - [LifeHistoryOutput]
|
Example
{
"client": [LifeHistoryOutput],
"partner": [LifeHistoryOutput]
}
GetLivingDiscretionaryExpenseInput
GetMoneyGuideMonteCarloMeterInput
Fields
| Input Field | Description |
|---|---|
clientId - Int
|
Example
{"clientId": 123}
GetOutstandingSurveysInput
GetOutstandingSurveysOutput
Fields
| Field Name | Description |
|---|---|
outstandingSurveys - [OutstandingSurveyInfo]
|
Example
{"outstandingSurveys": [OutstandingSurveyInfo]}
GetOverdueUpcomingActionsInput
GetOverdueUpcomingActionsOutput
Fields
| Field Name | Description |
|---|---|
overdueUpcomingActions - [GoalTaskOverdueUpcomingItem]
|
Example
{"overdueUpcomingActions": [GoalTaskOverdueUpcomingItem]}
GetPortfolioInput
GetPortfoliosInput
GetPowerOfInput
GetPowerOfsInput
GetPracticeAssetAllocationsInput
GetPracticeConfig
GetPracticeConfigVaultFolders
Fields
| Input Field | Description |
|---|---|
practiceId - Int
|
Example
{"practiceId": 987}
GetPracticeInput
GetPracticeIntegrationsInput
GetPracticeKeyAdviceAreasInput
GetPracticeRiskProfilesInput
GetPracticeSegmentationInput
Fields
| Input Field | Description |
|---|---|
practiceId - Int
|
Example
{"practiceId": 987}
GetPracticeStrategiesInput
GetPracticeStripePortalLinksInput
Fields
| Input Field | Description |
|---|---|
practiceId - Int
|
Example
{"practiceId": 123}
GetPracticesInput
Fields
| Input Field | Description |
|---|---|
filterGroup - FilterGroupInput
|
|
sort - SortInput
|
|
pagination - PaginationInput
|
Example
{
"filterGroup": FilterGroupInput,
"sort": SortInput,
"pagination": PaginationInput
}
GetPracticesOutput
Fields
| Field Name | Description |
|---|---|
practices - [Practice]
|
|
pagination - Pagination
|
Example
{
"practices": [Practice],
"pagination": Pagination
}
GetPresignedDownloadUrlInput
GetPresignedDownloadUrlOutput
Fields
| Field Name | Description |
|---|---|
preSignedDownloadURL - String!
|
Example
{"preSignedDownloadURL": "abc123"}
GetPresignedUploadUrlIdentityIdInput
Fields
| Input Field | Description |
|---|---|
inviteCode - String
|
Example
{"inviteCode": "abc123"}
GetPresignedUploadUrlInput
GetPresignedUploadUrlOutput
Example
{
"identityId": "xyz789",
"preSignedUploadURL": "xyz789",
"preSignedUploadURLKey": "xyz789",
"preSignedUploadURLAccessKeyId": "abc123",
"preSignedUploadSecurityToken": "abc123",
"preSignedUploadURLPolicy": "xyz789",
"preSignedUploadURLSignature": "abc123"
}
GetPresignedUrlFilesInput
GetPresignedUrlFilesOutput
Fields
| Field Name | Description |
|---|---|
files - [PresignedUrlFilesListItem]
|
|
page - Int
|
|
pageSize - Int
|
|
pages - Int
|
|
totalCount - Int
|
Example
{
"files": [PresignedUrlFilesListItem],
"page": 987,
"pageSize": 123,
"pages": 987,
"totalCount": 987
}
GetProfessionalContactInput
GetProfessionalContactsInput
GetQuickSurveyResponseSurveyOutput
Fields
| Field Name | Description |
|---|---|
surveyId - String
|
|
surveyName - String
|
|
lifeIncludeConnections - Boolean
|
|
lifeIncludeGoals - Boolean
|
|
valuesIncludeLegacy - Boolean
|
|
foundationsShort - Boolean
|
|
foundationsLong - Boolean
|
|
foundationsIncludeDetails - Boolean
|
|
foundationsIncludeInsurance - Boolean
|
|
foundationsIncludeEstatePlanning - Boolean
|
|
foundationsIncludeBusinessPlanning - Boolean
|
|
fhaLongAssessment - Boolean
|
|
fhaShortAssessment - Boolean
|
Example
{
"surveyId": "xyz789",
"surveyName": "xyz789",
"lifeIncludeConnections": false,
"lifeIncludeGoals": false,
"valuesIncludeLegacy": false,
"foundationsShort": false,
"foundationsLong": false,
"foundationsIncludeDetails": false,
"foundationsIncludeInsurance": false,
"foundationsIncludeEstatePlanning": true,
"foundationsIncludeBusinessPlanning": false,
"fhaLongAssessment": true,
"fhaShortAssessment": true
}
GetQuickSurveysInput
Fields
| Input Field | Description |
|---|---|
practiceId - Int
|
Example
{"practiceId": 123}
GetQuickSurveysOutput
Fields
| Field Name | Description |
|---|---|
sessionId - String
|
|
sessionName - String
|
|
surveys - [GetQuickSurveyResponseSurveyOutput]
|
Example
{
"sessionId": "xyz789",
"sessionName": "xyz789",
"surveys": [GetQuickSurveyResponseSurveyOutput]
}
GetRawFeedFilesInput
GetRawFeedFilesOutput
Fields
| Field Name | Description |
|---|---|
preSignedZipURL - String
|
Example
{"preSignedZipURL": "abc123"}
GetRetirementDetailsInput
GetRiskProfileInput
GetRiskProfilesInput
GetScenarioInput
GetScenariosInput
Fields
| Input Field | Description |
|---|---|
clientId - Int
|
Example
{"clientId": 987}
GetSensitiveDetailsInput
GetStaffConfig
GetStaffInput
GetStaffPendingApprovalsCountInput
GetStaffPendingApprovalsInput
GetStaffPendingApprovalsOutput
GetStaffsInput
Fields
| Input Field | Description |
|---|---|
practiceId - Int
|
|
filterGroup - FilterGroupInput
|
|
sort - SortInput
|
|
pagination - PaginationInput
|
|
withHouseholdTeamMembers - Boolean
|
Example
{
"practiceId": 987,
"filterGroup": FilterGroupInput,
"sort": SortInput,
"pagination": PaginationInput,
"withHouseholdTeamMembers": false
}
GetStaffsOutput
Fields
| Field Name | Description |
|---|---|
staffs - [Staff]
|
|
pagination - Pagination
|
Example
{
"staffs": [Staff],
"pagination": Pagination
}
GetSuperBeneficiariesInput
GetSuperBeneficiaryInput
GetSurveyInput
GetSurveyOutput
Fields
| Field Name | Description |
|---|---|
surveyMetadata - SurveyMetadata
|
|
palette - PracticeConfigPalette
|
|
surveyData - SurveyData
|
Example
{
"surveyMetadata": SurveyMetadata,
"palette": PracticeConfigPalette,
"surveyData": SurveyData
}
GetSurveysSessionInput
GetSurveysSessionOutput
Fields
| Field Name | Description |
|---|---|
clientId - Int
|
|
inviteCode - String
|
|
surveysSessionId - Int
|
|
sessionName - String
|
|
status - String
|
|
surveysInfo - [SurveyInfo]
|
|
clientsInfo - [ClientInfo]
|
|
palette - PracticeConfigPalette
|
|
createdAt - String
|
|
updatedAt - String
|
Example
{
"clientId": 987,
"inviteCode": "abc123",
"surveysSessionId": 987,
"sessionName": "xyz789",
"status": "abc123",
"surveysInfo": [SurveyInfo],
"clientsInfo": [ClientInfo],
"palette": PracticeConfigPalette,
"createdAt": "abc123",
"updatedAt": "abc123"
}
GetSurveysSessionsInput
GetSurveysSessionsOutput
Fields
| Field Name | Description |
|---|---|
householdId - Int
|
|
clientSessions - [GetSurveysSessionOutput]
|
Example
{
"householdId": 987,
"clientSessions": [GetSurveysSessionOutput]
}
GetTaskInput
Fields
| Input Field | Description |
|---|---|
id - Int
|
Example
{"id": 987}
GetTasksInput
GetTaxDetailsInput
GetTaxPlanningInput
GetTaxPlanningsInput
GetTrustBeneficiariesInput
GetTrustBeneficiaryInput
GetTrusteeInput
GetTrusteesInput
GetYourValuesIntroVideoUrlInput
GetYourVaultContentsInput
GetYourVaultContentsOutput
Fields
| Field Name | Description |
|---|---|
vaultFiles - [YourVaultFileInfo]
|
|
page - Int
|
|
pageSize - Int
|
|
pages - Int
|
|
totalCount - Int
|
Example
{
"vaultFiles": [YourVaultFileInfo],
"page": 123,
"pageSize": 123,
"pages": 123,
"totalCount": 123
}
GetYourVaultFileInput
GoalCategory
GoalImportance
GoalInput
Fields
| Input Field | Description |
|---|---|
id - Int
|
|
inviteCode - String
|
|
inviteClientId - Int
|
|
title - String!
|
|
goalNotes - String
|
|
successLooksLike - String
|
|
targetDate - String
|
|
completedDate - String
|
|
rank - Int
|
|
supportsStrategies - [String]
|
|
supportsClientValues - [Int]
|
|
supportsHouseholdValues - [Int]
|
|
supportsLife - [GoalLifeInput]
|
|
estimatedCost - Int
|
|
goalConfidence - Int
|
|
goalProgress - Int
|
|
strategies - [String!]
|
|
goalImportance - Int
|
|
goalCategory - Int
|
|
goalStatus - Int
|
|
recurrenceType - String
|
|
recurrenceInterval - Int
|
|
assignedToClientId - Int
|
|
assignedToHouseholdId - Int
|
|
createdForClientId - Int
|
|
createdForHouseholdId - Int
|
|
goalImageS3ObjectKey - String
|
|
goalImageS3IdentityId - String
|
|
deleteGoalImage - Boolean
|
|
confidentialNotes - String
|
|
useAvScan - Boolean
|
Example
{
"id": 987,
"inviteCode": "xyz789",
"inviteClientId": 987,
"title": "abc123",
"goalNotes": "abc123",
"successLooksLike": "abc123",
"targetDate": "abc123",
"completedDate": "xyz789",
"rank": 123,
"supportsStrategies": ["xyz789"],
"supportsClientValues": [987],
"supportsHouseholdValues": [987],
"supportsLife": [GoalLifeInput],
"estimatedCost": 123,
"goalConfidence": 123,
"goalProgress": 123,
"strategies": ["abc123"],
"goalImportance": 123,
"goalCategory": 987,
"goalStatus": 987,
"recurrenceType": "xyz789",
"recurrenceInterval": 123,
"assignedToClientId": 123,
"assignedToHouseholdId": 987,
"createdForClientId": 987,
"createdForHouseholdId": 987,
"goalImageS3ObjectKey": "xyz789",
"goalImageS3IdentityId": "xyz789",
"deleteGoalImage": true,
"confidentialNotes": "abc123",
"useAvScan": false
}
GoalLife
GoalLifeInput
GoalMetadata
Fields
| Field Name | Description |
|---|---|
goalCategories - [GoalCategory]
|
|
goalStatuses - [GoalStatus]
|
|
goalImportances - [GoalImportance]
|
Example
{
"goalCategories": [GoalCategory],
"goalStatuses": [GoalStatus],
"goalImportances": [GoalImportance]
}
GoalOutput
Fields
| Field Name | Description |
|---|---|
id - Int!
|
|
title - String!
|
|
goalNotes - String
|
|
successLooksLike - String
|
|
targetDate - String
|
|
targetDatePA - String
|
|
targetDatePADate - String
|
|
targetDateApprovalStatus - String
|
|
completedDate - String
|
|
rank - Int
|
|
supportsStrategies - [String]
|
|
supportsClientValues - [Int]
|
|
supportsHouseholdValues - [Int]
|
|
supportsLife - [GoalLife]
|
|
estimatedCost - Int
|
|
estimatedCostPA - Int
|
|
estimatedCostPADate - String
|
|
estimatedCostApprovalStatus - String
|
|
goalConfidence - Int
|
|
goalProgress - Int
|
|
strategies - [String!]
|
|
goalImportance - Int
|
|
goalCategory - Int
|
|
goalStatus - Int
|
|
goalStatusPA - Int
|
|
goalStatusPADate - String
|
|
goalStatusApprovalStatus - String
|
|
recurrenceType - String
|
|
recurrenceTypePA - String
|
|
recurrenceTypePADate - String
|
|
recurrenceTypeApprovalStatus - String
|
|
recurrenceInterval - Int
|
|
recurrenceIntervalPA - Int
|
|
recurrenceIntervalPADate - String
|
|
recurrenceIntervalApprovalStatus - String
|
|
assignedToClientId - Int
|
|
assignedToHouseholdId - Int
|
|
createdForClientId - Int
|
|
createdForHouseholdId - Int
|
|
forApproval - Boolean
|
|
approvalStatus - String
|
|
approvalChangeDate - String
|
|
createdBy - String!
|
|
created - String!
|
|
updatedBy - String!
|
|
updated - String!
|
|
preSignedGoalImageUrl - String
|
|
confidentialNotes - String
|
Example
{
"id": 123,
"title": "abc123",
"goalNotes": "xyz789",
"successLooksLike": "abc123",
"targetDate": "xyz789",
"targetDatePA": "abc123",
"targetDatePADate": "xyz789",
"targetDateApprovalStatus": "abc123",
"completedDate": "abc123",
"rank": 123,
"supportsStrategies": ["abc123"],
"supportsClientValues": [123],
"supportsHouseholdValues": [123],
"supportsLife": [GoalLife],
"estimatedCost": 123,
"estimatedCostPA": 123,
"estimatedCostPADate": "xyz789",
"estimatedCostApprovalStatus": "abc123",
"goalConfidence": 123,
"goalProgress": 123,
"strategies": ["xyz789"],
"goalImportance": 123,
"goalCategory": 987,
"goalStatus": 123,
"goalStatusPA": 123,
"goalStatusPADate": "abc123",
"goalStatusApprovalStatus": "xyz789",
"recurrenceType": "abc123",
"recurrenceTypePA": "abc123",
"recurrenceTypePADate": "xyz789",
"recurrenceTypeApprovalStatus": "xyz789",
"recurrenceInterval": 123,
"recurrenceIntervalPA": 123,
"recurrenceIntervalPADate": "xyz789",
"recurrenceIntervalApprovalStatus": "abc123",
"assignedToClientId": 123,
"assignedToHouseholdId": 123,
"createdForClientId": 123,
"createdForHouseholdId": 987,
"forApproval": false,
"approvalStatus": "xyz789",
"approvalChangeDate": "xyz789",
"createdBy": "xyz789",
"created": "xyz789",
"updatedBy": "abc123",
"updated": "abc123",
"preSignedGoalImageUrl": "xyz789",
"confidentialNotes": "xyz789"
}
GoalStatus
GoalTaskOverdueUpcomingItem
Fields
| Field Name | Description |
|---|---|
type - OverdueUpcomingType
|
|
itemType - AdviserLandingPageCardItemType
|
|
description - String
|
|
householdId - Int
|
|
names - String
|
Example
{
"type": "OVERDUE",
"itemType": "LIFE",
"description": "xyz789",
"householdId": 987,
"names": "abc123"
}
GoalsSession
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
clientId - Int!
|
|
inviteCode - String!
|
|
selectedGoalCategoryIds - [Int!]
|
|
createdAt - AWSDateTime!
|
|
updatedAt - AWSDateTime!
|
Example
{
"id": 4,
"clientId": 123,
"inviteCode": "abc123",
"selectedGoalCategoryIds": [987],
"createdAt": AWSDateTime,
"updatedAt": AWSDateTime
}
GraphElements
Fields
| Field Name | Description |
|---|---|
all - [GraphPoint]
|
|
R3Y - [GraphPoint]
|
|
R1Y - [GraphPoint]
|
|
YTD - [GraphPoint]
|
|
R3M - [GraphPoint]
|
Example
{
"all": [GraphPoint],
"R3Y": [GraphPoint],
"R1Y": [GraphPoint],
"YTD": [GraphPoint],
"R3M": [GraphPoint]
}
GraphPoint
HealthAssessment
Fields
| Field Name | Description |
|---|---|
id - Int
|
|
clientId - Int
|
|
status - String
|
|
visionGoalsScore - Int
|
|
retirementPlanningScore - Int
|
|
insuranceAssetProtectionScore - Int
|
|
debtCashFlowManagementScore - Int
|
|
educationPlanningScore - Int
|
|
investmentPlanningScore - Int
|
|
incomeTaxPlanningScore - Int
|
|
businessPlanningScore - Int
|
|
charitablePlanningScore - Int
|
|
estatePlanningScore - Int
|
Example
{
"id": 123,
"clientId": 987,
"status": "abc123",
"visionGoalsScore": 123,
"retirementPlanningScore": 987,
"insuranceAssetProtectionScore": 987,
"debtCashFlowManagementScore": 987,
"educationPlanningScore": 987,
"investmentPlanningScore": 123,
"incomeTaxPlanningScore": 987,
"businessPlanningScore": 987,
"charitablePlanningScore": 123,
"estatePlanningScore": 987
}
HealthDetailsOutput
Fields
| Field Name | Description |
|---|---|
healthDetailsId - Int!
|
|
clientId - Int
|
|
healthStatus - String
|
|
medicalHistoryIssues - String
|
|
isSmoker - Boolean
|
|
smokePerDay - Int
|
|
useNicotine - Boolean
|
|
nicotinePerDay - Int
|
|
useMedication - Boolean
|
|
medicationDetails - String
|
|
medicalCondition - Boolean
|
|
medicalConditionDetails - String
|
|
majorIllness - Boolean
|
|
majorIllnessDetails - String
|
|
privateHealth - Boolean
|
|
privateHealthDetails - String
|
|
sportsInterestsList - String
|
|
sportsInterests - String
|
|
sportsInterestsFrequency - String
|
|
notes - String
|
|
confidentialNotes - String
|
|
createdBy - String!
|
|
created - String!
|
|
updatedBy - String!
|
|
updated - String!
|
Example
{
"healthDetailsId": 987,
"clientId": 987,
"healthStatus": "abc123",
"medicalHistoryIssues": "xyz789",
"isSmoker": true,
"smokePerDay": 987,
"useNicotine": true,
"nicotinePerDay": 987,
"useMedication": true,
"medicationDetails": "abc123",
"medicalCondition": false,
"medicalConditionDetails": "xyz789",
"majorIllness": false,
"majorIllnessDetails": "abc123",
"privateHealth": true,
"privateHealthDetails": "xyz789",
"sportsInterestsList": "xyz789",
"sportsInterests": "xyz789",
"sportsInterestsFrequency": "xyz789",
"notes": "xyz789",
"confidentialNotes": "abc123",
"createdBy": "xyz789",
"created": "abc123",
"updatedBy": "xyz789",
"updated": "abc123"
}
HideClientFromStaffInput
Fields
| Input Field | Description |
|---|---|
clientId - Int
|
Example
{"clientId": 123}
HideClientFromStaffOutput
HistoricalData
Fields
| Field Name | Description |
|---|---|
inceptionToDate - PerformanceData
|
|
priorYear - PerformanceData
|
|
yearToDate - PerformanceData
|
Example
{
"inceptionToDate": PerformanceData,
"priorYear": PerformanceData,
"yearToDate": PerformanceData
}
Holding
Fields
| Field Name | Description |
|---|---|
code - String
|
|
ticker - String!
|
|
exchange - String
|
|
name - String!
|
|
assetTreeId - Int!
|
|
invGroupId - Int!
|
|
regionId - Int!
|
|
assetClassId - Int!
|
|
sectorId - Int!
|
|
securityGroupId - Int!
|
|
securityTypeId - Int!
|
|
securityStyle - String!
|
|
quantity - Float!
|
|
closePriceDate - String!
|
|
closePrice - Float!
|
|
closePriceAUD - Float!
|
|
currencyCode - String!
|
|
capitalGain - Float
|
Example
{
"code": "xyz789",
"ticker": "xyz789",
"exchange": "abc123",
"name": "xyz789",
"assetTreeId": 987,
"invGroupId": 123,
"regionId": 123,
"assetClassId": 987,
"sectorId": 987,
"securityGroupId": 123,
"securityTypeId": 123,
"securityStyle": "abc123",
"quantity": 123.45,
"closePriceDate": "abc123",
"closePrice": 123.45,
"closePriceAUD": 123.45,
"currencyCode": "xyz789",
"capitalGain": 987.65
}
HoldingOutput
Fields
| Field Name | Description |
|---|---|
holdingId - Int!
|
|
portfolioId - Int!
|
|
securityId - Int
|
|
ticker - String
|
|
description - String
|
|
quantity - Float
|
|
purchasePrice - Float
|
|
purchaseDate - String
|
|
averagePrice - Float
|
|
totalCost - Float
|
|
marketPrice - Float
|
|
marketPriceDate - String
|
|
maturityDate - String
|
|
interestRate - Float
|
|
paymentFrequency - String
|
|
currencyCode - String
|
|
overrideAssetTreeId - Int
|
|
overrideSecurityGroupId - Int
|
|
overrideSecurityTypeId - Int
|
|
overrideSecurityStyle - String
|
|
createdBy - String!
|
|
created - String!
|
|
updatedBy - String!
|
|
updated - String!
|
Example
{
"holdingId": 123,
"portfolioId": 123,
"securityId": 123,
"ticker": "xyz789",
"description": "xyz789",
"quantity": 987.65,
"purchasePrice": 123.45,
"purchaseDate": "xyz789",
"averagePrice": 123.45,
"totalCost": 987.65,
"marketPrice": 123.45,
"marketPriceDate": "xyz789",
"maturityDate": "abc123",
"interestRate": 987.65,
"paymentFrequency": "abc123",
"currencyCode": "abc123",
"overrideAssetTreeId": 987,
"overrideSecurityGroupId": 123,
"overrideSecurityTypeId": 123,
"overrideSecurityStyle": "abc123",
"createdBy": "xyz789",
"created": "abc123",
"updatedBy": "xyz789",
"updated": "xyz789"
}
Household
Fields
| Field Name | Description |
|---|---|
householdId - Int!
|
|
name - String!
|
|
clients - [Client]
|
|
householdStaffAccess - [HouseholdStaffAccess]
|
|
isTest - Boolean
|
|
householdPackageCode - String
|
|
practiceSegmentationId - Int
|
|
practiceSegmentationName - String
|
|
countryCode - String
|
|
wellnessScore - Float
|
|
createdBy - String!
|
|
created - String!
|
|
updatedBy - String!
|
|
updated - String!
|
Example
{
"householdId": 987,
"name": "abc123",
"clients": [Client],
"householdStaffAccess": [HouseholdStaffAccess],
"isTest": false,
"householdPackageCode": "xyz789",
"practiceSegmentationId": 987,
"practiceSegmentationName": "abc123",
"countryCode": "abc123",
"wellnessScore": 123.45,
"createdBy": "abc123",
"created": "abc123",
"updatedBy": "abc123",
"updated": "abc123"
}
HouseholdAggregate
Fields
| Field Name | Description |
|---|---|
householdId - Int!
|
|
drilldownCsv - String
|
|
clientAggregates - [ClientAggregate]
|
Example
{
"householdId": 123,
"drilldownCsv": "xyz789",
"clientAggregates": [ClientAggregate]
}
HouseholdApprovalItem
Example
{
"householdId": 987,
"clientId": 987,
"entityType": "GOAL",
"entityId": 987,
"approvalStatus": "abc123",
"section": "abc123",
"fieldName": "xyz789",
"previousValue": "xyz789",
"newValue": "xyz789",
"changeDate": "xyz789"
}
HouseholdCashFlow
Fields
| Field Name | Description |
|---|---|
id - Int
|
|
year - Int
|
|
clientAge - String
|
|
clientIncome - Float
|
|
clientStatus - String
|
|
partnerAge - String
|
|
partnerIncome - Float
|
|
partnerStatus - String
|
|
householdIncome - Float
|
|
totalIncome - String
|
|
incomeSaved - String
|
|
incomeSpent - Float
|
|
reqRetirementIncome - Float
|
|
contribution - Float
|
|
withdrawal - Float
|
Example
{
"id": 123,
"year": 987,
"clientAge": "abc123",
"clientIncome": 987.65,
"clientStatus": "xyz789",
"partnerAge": "xyz789",
"partnerIncome": 123.45,
"partnerStatus": "xyz789",
"householdIncome": 123.45,
"totalIncome": "abc123",
"incomeSaved": "xyz789",
"incomeSpent": 987.65,
"reqRetirementIncome": 123.45,
"contribution": 987.65,
"withdrawal": 987.65
}
HouseholdCashFlowInput
Fields
| Input Field | Description |
|---|---|
id - Int
|
|
year - Int
|
|
clientAge - String
|
|
clientIncome - Float
|
|
clientStatus - String
|
|
partnerAge - String
|
|
partnerIncome - Float
|
|
partnerStatus - String
|
|
householdIncome - Float
|
|
totalIncome - String
|
|
incomeSaved - String
|
|
incomeSpent - Float
|
|
reqRetirementIncome - Float
|
|
contribution - Float
|
|
withdrawal - Float
|
Example
{
"id": 987,
"year": 987,
"clientAge": "abc123",
"clientIncome": 123.45,
"clientStatus": "xyz789",
"partnerAge": "xyz789",
"partnerIncome": 123.45,
"partnerStatus": "abc123",
"householdIncome": 123.45,
"totalIncome": "abc123",
"incomeSaved": "abc123",
"incomeSpent": 123.45,
"reqRetirementIncome": 987.65,
"contribution": 987.65,
"withdrawal": 987.65
}
HouseholdConfig
Fields
| Field Name | Description |
|---|---|
householdConfigId - Int
|
|
householdId - Int
|
|
configuration - HouseholdConfigConfiguration
|
Example
{
"householdConfigId": 123,
"householdId": 123,
"configuration": HouseholdConfigConfiguration
}
HouseholdConfigConfiguration
Fields
| Field Name | Description |
|---|---|
modules - HouseholdConfigConfigurationModules
|
Example
{"modules": HouseholdConfigConfigurationModules}
HouseholdConfigConfigurationModuleBestLife
Fields
| Field Name | Description |
|---|---|
enabled - Boolean
|
Example
{"enabled": false}
HouseholdConfigConfigurationModuleBestLifePlan
Fields
| Field Name | Description |
|---|---|
enabled - Boolean
|
Example
{"enabled": true}
HouseholdConfigConfigurationModuleGoals
Fields
| Field Name | Description |
|---|---|
enabled - Boolean
|
Example
{"enabled": false}
HouseholdConfigConfigurationModuleGovernance
Fields
| Field Name | Description |
|---|---|
enabled - Boolean
|
Example
{"enabled": false}
HouseholdConfigConfigurationModuleHealthAssessment
Fields
| Field Name | Description |
|---|---|
enabled - Boolean
|
Example
{"enabled": false}
HouseholdConfigConfigurationModuleInvPrefs
Fields
| Field Name | Description |
|---|---|
enabled - Boolean
|
Example
{"enabled": false}
HouseholdConfigConfigurationModuleLife
Fields
| Field Name | Description |
|---|---|
enabled - Boolean
|
Example
{"enabled": true}
HouseholdConfigConfigurationModuleStrategies
Fields
| Field Name | Description |
|---|---|
enabled - Boolean
|
Example
{"enabled": false}
HouseholdConfigConfigurationModuleSurveys
Fields
| Field Name | Description |
|---|---|
enabled - Boolean
|
Example
{"enabled": false}
HouseholdConfigConfigurationModuleTasks
Fields
| Field Name | Description |
|---|---|
enabled - Boolean
|
Example
{"enabled": true}
HouseholdConfigConfigurationModuleValues
Fields
| Field Name | Description |
|---|---|
enabled - Boolean
|
Example
{"enabled": true}
HouseholdConfigConfigurationModuleVault
Fields
| Field Name | Description |
|---|---|
enabled - Boolean
|
Example
{"enabled": false}
HouseholdConfigConfigurationModuleWealth
Fields
| Field Name | Description |
|---|---|
enabled - Boolean
|
Example
{"enabled": false}
HouseholdConfigConfigurationModules
Fields
| Field Name | Description |
|---|---|
bestLife - HouseholdConfigConfigurationModuleBestLife
|
|
bestLifePlan - HouseholdConfigConfigurationModuleBestLifePlan
|
|
goals - HouseholdConfigConfigurationModuleGoals
|
|
governance - HouseholdConfigConfigurationModuleGovernance
|
|
healthAssessment - HouseholdConfigConfigurationModuleHealthAssessment
|
|
invPrefs - HouseholdConfigConfigurationModuleInvPrefs
|
|
life - HouseholdConfigConfigurationModuleLife
|
|
strategies - HouseholdConfigConfigurationModuleStrategies
|
|
surveys - HouseholdConfigConfigurationModuleSurveys
|
|
tasks - HouseholdConfigConfigurationModuleTasks
|
|
values - HouseholdConfigConfigurationModuleValues
|
|
vault - HouseholdConfigConfigurationModuleVault
|
|
wealth - HouseholdConfigConfigurationModuleWealth
|
Example
{
"bestLife": HouseholdConfigConfigurationModuleBestLife,
"bestLifePlan": HouseholdConfigConfigurationModuleBestLifePlan,
"goals": HouseholdConfigConfigurationModuleGoals,
"governance": HouseholdConfigConfigurationModuleGovernance,
"healthAssessment": HouseholdConfigConfigurationModuleHealthAssessment,
"invPrefs": HouseholdConfigConfigurationModuleInvPrefs,
"life": HouseholdConfigConfigurationModuleLife,
"strategies": HouseholdConfigConfigurationModuleStrategies,
"surveys": HouseholdConfigConfigurationModuleSurveys,
"tasks": HouseholdConfigConfigurationModuleTasks,
"values": HouseholdConfigConfigurationModuleValues,
"vault": HouseholdConfigConfigurationModuleVault,
"wealth": HouseholdConfigConfigurationModuleWealth
}
HouseholdInvestmentPreferences
Fields
| Field Name | Description |
|---|---|
householdId - Int!
|
|
customisation - YesNoMaybe
|
|
customisationNotes - String
|
|
ethical - YesNoMaybe
|
|
ethicalNotes - String
|
|
assetClassNotes - String
|
|
allocationType - AssetAllocationType
|
|
allocationNotes - String
|
|
riskNotes - String
|
|
riskGroup - Int
|
|
costNotes - String
|
|
costDriven - String
|
|
prioritisationNotes - String
|
|
commentNotes - String
|
|
createdBy - String!
|
|
created - String!
|
|
updatedBy - String!
|
|
updated - String!
|
Example
{
"householdId": 123,
"customisation": "Y",
"customisationNotes": "abc123",
"ethical": "Y",
"ethicalNotes": "xyz789",
"assetClassNotes": "abc123",
"allocationType": "S",
"allocationNotes": "xyz789",
"riskNotes": "xyz789",
"riskGroup": 123,
"costNotes": "abc123",
"costDriven": "xyz789",
"prioritisationNotes": "abc123",
"commentNotes": "xyz789",
"createdBy": "xyz789",
"created": "abc123",
"updatedBy": "abc123",
"updated": "abc123"
}
HouseholdInvestmentPreferencesInput
Fields
| Input Field | Description |
|---|---|
householdId - Int!
|
|
inviteCode - ID
|
|
customisation - YesNoMaybe
|
|
customisationNotes - String
|
|
ethical - YesNoMaybe
|
|
ethicalNotes - String
|
|
assetClassNotes - String
|
|
allocationType - AssetAllocationType
|
|
allocationNotes - String
|
|
riskNotes - String
|
|
riskGroup - Int
|
|
costNotes - String
|
|
costDriven - String
|
|
prioritisationNotes - String
|
|
commentNotes - String
|
Example
{
"householdId": 123,
"inviteCode": 4,
"customisation": "Y",
"customisationNotes": "abc123",
"ethical": "Y",
"ethicalNotes": "xyz789",
"assetClassNotes": "abc123",
"allocationType": "S",
"allocationNotes": "abc123",
"riskNotes": "abc123",
"riskGroup": 987,
"costNotes": "abc123",
"costDriven": "abc123",
"prioritisationNotes": "abc123",
"commentNotes": "abc123"
}
HouseholdKeyAdviceArea
Example
{
"householdKeyAdviceAreaId": 987,
"householdId": 987,
"practiceKeyAdviceAreaId": 123,
"enabled": true,
"status": 987,
"rank": 987,
"createdBy": "xyz789",
"created": "abc123",
"updatedBy": "abc123",
"updated": "abc123"
}
HouseholdMemberOutput
Fields
| Field Name | Description |
|---|---|
householdMemberId - Int!
|
|
householdId - Int
|
|
relation - String!
|
|
firstName - String!
|
|
middleName - String
|
|
lastName - String!
|
|
dob - String
|
|
sex - String
|
|
livingAtHome - Boolean!
|
|
financiallyDependent - Boolean!
|
|
financiallyDependentUntil - Int
|
|
notes - String
|
|
confidentialNotes - String
|
|
createdBy - String!
|
|
created - String!
|
|
updatedBy - String!
|
|
updated - String!
|
Example
{
"householdMemberId": 123,
"householdId": 123,
"relation": "xyz789",
"firstName": "xyz789",
"middleName": "abc123",
"lastName": "abc123",
"dob": "abc123",
"sex": "xyz789",
"livingAtHome": false,
"financiallyDependent": false,
"financiallyDependentUntil": 987,
"notes": "xyz789",
"confidentialNotes": "xyz789",
"createdBy": "xyz789",
"created": "abc123",
"updatedBy": "xyz789",
"updated": "xyz789"
}
HouseholdMemberProgress
HouseholdMemberProgressInput
HouseholdMemberProgressOutput
Example
{
"id": 987,
"description": "xyz789",
"progress": 123,
"clientId": 987,
"createdBy": "abc123",
"created": "xyz789",
"updatedBy": "abc123",
"updated": "abc123"
}
HouseholdPackage
Fields
| Field Name | Description |
|---|---|
code - String
|
|
name - String
|
|
description - String
|
|
requiresLicense - Boolean
|
|
components - [Component]
|
Example
{
"code": "abc123",
"name": "abc123",
"description": "xyz789",
"requiresLicense": false,
"components": [Component]
}
HouseholdStaffAccess
Example
{
"practiceOfficeId": 987,
"practiceOfficeName": "xyz789",
"staffId": 987,
"staffTitle": "abc123",
"staffFirstName": "xyz789",
"staffMiddleName": "abc123",
"staffLastName": "xyz789",
"role": "abc123"
}
HouseholdStrategy
Fields
| Field Name | Description |
|---|---|
householdStrategyId - Int
|
|
householdId - Int
|
|
practiceKeyAdviceAreaId - Int!
|
|
practiceStrategyId - Int
|
|
strategyName - String
|
|
details - String
|
|
progress - Int
|
|
startDate - String
|
|
endDate - String
|
|
status - Int
|
|
targetAmount - Float
|
|
linkedGoalIds - [Int]
|
|
linkedTaskIds - [Int]
|
|
createdBy - String!
|
|
created - String!
|
|
updatedBy - String!
|
|
updated - String!
|
|
confidentialNotes - String
|
Example
{
"householdStrategyId": 987,
"householdId": 987,
"practiceKeyAdviceAreaId": 987,
"practiceStrategyId": 123,
"strategyName": "xyz789",
"details": "abc123",
"progress": 123,
"startDate": "xyz789",
"endDate": "xyz789",
"status": 123,
"targetAmount": 123.45,
"linkedGoalIds": [987],
"linkedTaskIds": [123],
"createdBy": "abc123",
"created": "abc123",
"updatedBy": "abc123",
"updated": "xyz789",
"confidentialNotes": "xyz789"
}
HouseholdSummaryOutput
Fields
| Field Name | Description |
|---|---|
householdId - Int!
|
|
wellnessScore - Float
|
|
bestLifeScore - Float
|
|
householdAssets - Float
|
|
householdLiabilities - Float
|
|
goalCount - Int!
|
|
taskTodoCount - Int!
|
|
kaaCount - Int!
|
|
clientLifeModuleState - String
|
|
clientValuesModuleState - String
|
|
clientInvPrefsModuleState - String
|
|
clientRegistrationState - String
|
|
clientNotes - String
|
|
partnerLifeModuleState - String
|
|
partnerValuesModuleState - String
|
|
partnerInvPrefsModuleState - String
|
|
partnerRegistrationState - String
|
|
partnerNotes - String
|
|
householdNotes - String
|
Example
{
"householdId": 987,
"wellnessScore": 987.65,
"bestLifeScore": 987.65,
"householdAssets": 123.45,
"householdLiabilities": 987.65,
"goalCount": 987,
"taskTodoCount": 123,
"kaaCount": 987,
"clientLifeModuleState": "abc123",
"clientValuesModuleState": "abc123",
"clientInvPrefsModuleState": "abc123",
"clientRegistrationState": "abc123",
"clientNotes": "xyz789",
"partnerLifeModuleState": "abc123",
"partnerValuesModuleState": "xyz789",
"partnerInvPrefsModuleState": "abc123",
"partnerRegistrationState": "abc123",
"partnerNotes": "xyz789",
"householdNotes": "xyz789"
}
HouseholdTeamMember
Fields
| Field Name | Description |
|---|---|
householdId - Int!
|
|
staffId - Int
|
|
practiceOfficeId - Int
|
|
role - HouseholdTeamMemberRole!
|
Example
{"householdId": 987, "staffId": 987, "practiceOfficeId": 123, "role": "P1"}
HouseholdTeamMemberRole
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"P1"
HouseholdValue
Fields
| Field Name | Description |
|---|---|
id - Int
|
|
cardId - Int!
|
|
clientId - Int
|
|
rank - Int
|
|
notes - String
|
|
progress - Int
|
|
description - String
|
|
nextSteps - [HouseholdValueNextStep!]!
|
|
householdMemberProgress - [HouseholdMemberProgressOutput!]
|
|
createdBy - String!
|
|
created - String!
|
|
updatedBy - String!
|
|
updated - String!
|
Example
{
"id": 987,
"cardId": 123,
"clientId": 123,
"rank": 987,
"notes": "xyz789",
"progress": 987,
"description": "abc123",
"nextSteps": [HouseholdValueNextStep],
"householdMemberProgress": [
HouseholdMemberProgressOutput
],
"createdBy": "abc123",
"created": "abc123",
"updatedBy": "abc123",
"updated": "xyz789"
}
HouseholdValueInput
Fields
| Input Field | Description |
|---|---|
id - Int
|
|
cardId - Int!
|
|
clientId - Int
|
|
rank - Int
|
|
notes - String
|
|
progress - Int
|
|
description - String
|
|
nextSteps - [HouseholdValueNextStepInput!]!
|
|
householdMemberProgress - [HouseholdMemberProgressInput!]!
|
Example
{
"id": 987,
"cardId": 123,
"clientId": 987,
"rank": 123,
"notes": "xyz789",
"progress": 123,
"description": "xyz789",
"nextSteps": [HouseholdValueNextStepInput],
"householdMemberProgress": [
HouseholdMemberProgressInput
]
}
HouseholdValueNextStep
Example
{
"id": 987,
"title": "abc123",
"notes": "abc123",
"assignedToClientId": 987,
"createdBy": "abc123",
"created": "xyz789",
"updatedBy": "xyz789",
"updated": "xyz789"
}
HouseholdValueNextStepInput
HouseholdValues
Example
{
"id": 123,
"householdId": 987,
"values": [HouseholdValue],
"createdBy": "abc123",
"created": "abc123",
"updatedBy": "abc123",
"updated": "xyz789"
}
HouseholdValuesInput
Fields
| Input Field | Description |
|---|---|
id - Int
|
|
householdId - Int
|
|
values - [HouseholdValueInput!]
|
Example
{
"id": 123,
"householdId": 987,
"values": [HouseholdValueInput]
}
HouseholdWellnessHistoryInput
HttpHeader
HttpMethod
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"PUT"
ID
Description
The ID scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "4") or integer (such as 4) input value will be accepted as an ID.
Example
"4"
ILClient
IncomeOutput
Fields
| Field Name | Description |
|---|---|
incomeId - Int!
|
|
householdId - Int
|
|
clientId - Int
|
|
clientFirstName - String
|
|
clientLastName - String
|
|
clientPreferredName - String
|
|
assetId - Int
|
|
legalEntityId - Int
|
|
legalEntityName - String
|
|
incomeType - String!
|
|
employer - String
|
|
jobTitle - String
|
|
salary - Float
|
|
superBps - Float
|
|
salarySacrifice - Float
|
|
income - Float
|
|
frequency - String
|
|
incomeSubType - String
|
|
description - String
|
|
assessed - Boolean
|
|
taxStatus - String
|
|
rateChangeBps - Float
|
|
bonus - Float
|
|
bonusBps - Float
|
|
commission - Float
|
|
commissionBps - Float
|
|
startDate - String
|
|
endDate - String
|
|
plannedChanges - Boolean
|
|
plannedChangesDescription - String
|
|
eligibleSocialBenefits - Boolean
|
|
typeOfConcession - String
|
|
giftedAssets - Boolean
|
|
giftedAssetsList - String
|
|
crn - String
|
|
isReceivingPayments - Boolean
|
|
paymentType - String
|
|
benefitAmount - Float
|
|
retirementBenefitAmount - Float
|
|
notes - String
|
|
clientNotes - String
|
|
partnerNotes - String
|
|
confidentialNotes - String
|
|
createdBy - String!
|
|
created - String!
|
|
updatedBy - String!
|
|
updated - String!
|
Example
{
"incomeId": 987,
"householdId": 987,
"clientId": 987,
"clientFirstName": "xyz789",
"clientLastName": "abc123",
"clientPreferredName": "xyz789",
"assetId": 123,
"legalEntityId": 123,
"legalEntityName": "abc123",
"incomeType": "xyz789",
"employer": "abc123",
"jobTitle": "abc123",
"salary": 987.65,
"superBps": 123.45,
"salarySacrifice": 123.45,
"income": 987.65,
"frequency": "abc123",
"incomeSubType": "abc123",
"description": "xyz789",
"assessed": true,
"taxStatus": "abc123",
"rateChangeBps": 123.45,
"bonus": 123.45,
"bonusBps": 987.65,
"commission": 123.45,
"commissionBps": 987.65,
"startDate": "abc123",
"endDate": "abc123",
"plannedChanges": false,
"plannedChangesDescription": "abc123",
"eligibleSocialBenefits": false,
"typeOfConcession": "xyz789",
"giftedAssets": false,
"giftedAssetsList": "xyz789",
"crn": "xyz789",
"isReceivingPayments": true,
"paymentType": "xyz789",
"benefitAmount": 987.65,
"retirementBenefitAmount": 123.45,
"notes": "xyz789",
"clientNotes": "abc123",
"partnerNotes": "abc123",
"confidentialNotes": "abc123",
"createdBy": "abc123",
"created": "abc123",
"updatedBy": "xyz789",
"updated": "xyz789"
}
Institution
Fields
| Field Name | Description |
|---|---|
basiqInstitutionId - String
|
|
basiqInstitutionType - String
|
|
basiqInstitutionName - String
|
|
basiqInstitutionShortName - String
|
|
basiqInstitutionCountry - String
|
|
basiqInstitutionStatRetrieveAccounts - Int
|
|
basiqInstitutionStatRetrieveTransactions - Int
|
|
basiqInstitutionLogoUrl - String
|
Example
{
"basiqInstitutionId": "xyz789",
"basiqInstitutionType": "xyz789",
"basiqInstitutionName": "abc123",
"basiqInstitutionShortName": "xyz789",
"basiqInstitutionCountry": "xyz789",
"basiqInstitutionStatRetrieveAccounts": 123,
"basiqInstitutionStatRetrieveTransactions": 987,
"basiqInstitutionLogoUrl": "abc123"
}
InsuranceCoverageInput
Fields
| Input Field | Description |
|---|---|
insuranceCoverageId - Int
|
|
insuranceId - Int
|
|
lifeInsuranceType - String
|
|
generalInsuranceType - String
|
|
lifeInsuranceSubType - String
|
|
disabilitySubType - String
|
|
longTermCareSubType - String
|
|
otherInsuranceSubType - String
|
|
cover - Float
|
|
coverBps - Float
|
|
coverPerAnnum - Float
|
|
ipCoverType - String
|
|
arSubType - String
|
|
payoutPeriod - String
|
|
payoutPeriodEnd - String
|
|
payoutWaitPeriod - Int
|
|
insideSuper - Boolean
|
|
endYear - Int
|
|
deathBenefit - Float
|
|
beneficiaryRelation - String
|
|
chronicCareRider - Boolean
|
|
otherBeneficiary - String
|
|
longOrShort - String
|
|
monthlyBenefitAmount - Float
|
|
totalBenefits - Float
|
|
payoutType - String
|
|
payoutPeriodText - String
|
|
eliminationPeriod - Int
|
|
healthcareSource - String
|
|
premiumTaxCredit - Boolean
|
Example
{
"insuranceCoverageId": 123,
"insuranceId": 987,
"lifeInsuranceType": "xyz789",
"generalInsuranceType": "xyz789",
"lifeInsuranceSubType": "abc123",
"disabilitySubType": "abc123",
"longTermCareSubType": "xyz789",
"otherInsuranceSubType": "xyz789",
"cover": 123.45,
"coverBps": 987.65,
"coverPerAnnum": 987.65,
"ipCoverType": "abc123",
"arSubType": "xyz789",
"payoutPeriod": "xyz789",
"payoutPeriodEnd": "abc123",
"payoutWaitPeriod": 987,
"insideSuper": false,
"endYear": 123,
"deathBenefit": 987.65,
"beneficiaryRelation": "abc123",
"chronicCareRider": false,
"otherBeneficiary": "xyz789",
"longOrShort": "abc123",
"monthlyBenefitAmount": 123.45,
"totalBenefits": 123.45,
"payoutType": "abc123",
"payoutPeriodText": "xyz789",
"eliminationPeriod": 123,
"healthcareSource": "abc123",
"premiumTaxCredit": false
}
InsuranceCoverageOutput
Fields
| Field Name | Description |
|---|---|
insuranceCoverageId - Int
|
|
insuranceId - Int
|
|
lifeInsuranceType - String
|
|
generalInsuranceType - String
|
|
lifeInsuranceSubType - String
|
|
disabilitySubType - String
|
|
longTermCareSubType - String
|
|
otherInsuranceSubType - String
|
|
cover - Float
|
|
coverBps - Float
|
|
coverPerAnnum - Float
|
|
ipCoverType - String
|
|
arSubType - String
|
|
payoutPeriod - String
|
|
payoutPeriodEnd - String
|
|
payoutWaitPeriod - Int
|
|
insideSuper - Boolean
|
|
endYear - Int
|
|
deathBenefit - Float
|
|
beneficiaryRelation - String
|
|
chronicCareRider - Boolean
|
|
otherBeneficiary - String
|
|
longOrShort - String
|
|
monthlyBenefitAmount - Float
|
|
totalBenefits - Float
|
|
payoutType - String
|
|
payoutPeriodText - String
|
|
eliminationPeriod - Int
|
|
healthcareSource - String
|
|
premiumTaxCredit - Boolean
|
|
createdBy - String!
|
|
created - String!
|
|
updatedBy - String!
|
|
updated - String!
|
Example
{
"insuranceCoverageId": 123,
"insuranceId": 987,
"lifeInsuranceType": "xyz789",
"generalInsuranceType": "abc123",
"lifeInsuranceSubType": "abc123",
"disabilitySubType": "xyz789",
"longTermCareSubType": "xyz789",
"otherInsuranceSubType": "xyz789",
"cover": 123.45,
"coverBps": 987.65,
"coverPerAnnum": 123.45,
"ipCoverType": "xyz789",
"arSubType": "xyz789",
"payoutPeriod": "xyz789",
"payoutPeriodEnd": "abc123",
"payoutWaitPeriod": 123,
"insideSuper": false,
"endYear": 123,
"deathBenefit": 987.65,
"beneficiaryRelation": "xyz789",
"chronicCareRider": false,
"otherBeneficiary": "abc123",
"longOrShort": "abc123",
"monthlyBenefitAmount": 987.65,
"totalBenefits": 123.45,
"payoutType": "xyz789",
"payoutPeriodText": "abc123",
"eliminationPeriod": 987,
"healthcareSource": "xyz789",
"premiumTaxCredit": false,
"createdBy": "xyz789",
"created": "abc123",
"updatedBy": "abc123",
"updated": "xyz789"
}
InsuranceOutput
Fields
| Field Name | Description |
|---|---|
insuranceId - Int!
|
|
householdId - Int
|
|
clientId - Int
|
|
legalEntityId - Int
|
|
assetId - Int
|
|
beneficiaryClientId - Int
|
|
beneficiaryLegalEntityId - Int
|
|
beneficiaryHouseholdMemberId - Int
|
|
insuranceType - String!
|
|
lifeInsuranceType - String
|
|
generalInsuranceType - String
|
|
insurer - String
|
|
description - String
|
|
excess - Float
|
|
cashValue - Float
|
|
cover - Float
|
|
coverBps - Float
|
|
insideSuper - Boolean
|
|
ipCoverType - String
|
|
arSubType - String
|
|
premium - Float
|
|
frequency - String
|
|
policyNumber - String
|
|
policyStatus - String
|
|
policyToDate - String
|
|
premiumIncreaseBps - Float
|
|
payoutPeriod - String
|
|
payoutPeriodEnd - String
|
|
payoutWaitPeriod - Int
|
|
endYear - Int
|
|
notes - String
|
|
clientNotes - String
|
|
partnerNotes - String
|
|
confidentialNotes - String
|
|
displayName - String
|
|
externalId - String
|
|
externalSystem - ExternalSystem
|
|
insuranceYodleeMapping - YodleeMapping
|
|
coverages - [InsuranceCoverageOutput]
|
|
createdBy - String!
|
|
created - String!
|
|
updatedBy - String!
|
|
updated - String!
|
Example
{
"insuranceId": 123,
"householdId": 123,
"clientId": 123,
"legalEntityId": 123,
"assetId": 123,
"beneficiaryClientId": 987,
"beneficiaryLegalEntityId": 987,
"beneficiaryHouseholdMemberId": 987,
"insuranceType": "xyz789",
"lifeInsuranceType": "xyz789",
"generalInsuranceType": "xyz789",
"insurer": "xyz789",
"description": "xyz789",
"excess": 123.45,
"cashValue": 123.45,
"cover": 987.65,
"coverBps": 123.45,
"insideSuper": true,
"ipCoverType": "xyz789",
"arSubType": "xyz789",
"premium": 987.65,
"frequency": "xyz789",
"policyNumber": "xyz789",
"policyStatus": "xyz789",
"policyToDate": "xyz789",
"premiumIncreaseBps": 123.45,
"payoutPeriod": "xyz789",
"payoutPeriodEnd": "xyz789",
"payoutWaitPeriod": 987,
"endYear": 987,
"notes": "abc123",
"clientNotes": "xyz789",
"partnerNotes": "abc123",
"confidentialNotes": "xyz789",
"displayName": "xyz789",
"externalId": "xyz789",
"externalSystem": "IL",
"insuranceYodleeMapping": YodleeMapping,
"coverages": [InsuranceCoverageOutput],
"createdBy": "abc123",
"created": "abc123",
"updatedBy": "xyz789",
"updated": "abc123"
}
Int
Description
The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.
Example
987
InvGroup
InvestmentPreferences
Fields
| Field Name | Description |
|---|---|
clientId - Int!
|
|
introVideo - String
|
|
customisationVideo - String
|
|
customisation - YesNoMaybe
|
|
ethicalVideo - String
|
|
ethical - YesNoMaybe
|
|
assetClassVideo - String
|
|
allocationVideo - String
|
|
allocationType - AssetAllocationType
|
|
riskVideo - String
|
|
comfortableWithDownturn - String
|
|
costVideo - String
|
|
costDriven - YesNo
|
|
prioritisation - [InvestmentPreferencesRanking]
|
|
comments - String
|
|
customisationVideoHelp - YesNo
|
|
customisationVideoComments - String
|
|
ethicalVideoHelp - YesNo
|
|
ethicalVideoComments - String
|
|
assetClassVideoHelp - YesNo
|
|
assetClassVideoComments - String
|
|
allocationVideoHelp - YesNo
|
|
allocationVideoComments - String
|
|
riskVideoHelp - YesNo
|
|
riskVideoComments - String
|
|
riskDiversification - Int
|
|
riskMarketCorrection - Int
|
|
riskPercentageDrop - Int
|
|
riskCapitalProtection - YesNo
|
|
riskAccessCapital - Int
|
|
riskInfluencedByReturns - Int
|
|
riskIncreaseToMeetGoal - Int
|
|
riskMaxDownside - Int
|
|
riskInflation - Int
|
|
costVideoHelp - YesNo
|
|
costVideoComments - String
|
|
assetClassAndDiversificationVideoHelp - YesNoUnsure
|
|
assetClassPreferences - YesNo
|
|
assetClassPreferencesComments - String
|
|
assetClassRisk - YesNo
|
|
assetClassRiskComments - String
|
|
ethicalPreferences - YesNo
|
|
ethicalPreferencesComments - String
|
|
activePassiveVideoHelp - YesNoUnsure
|
|
costWealthPriorities - WealthPriorities
|
|
riskVolatilityVideoHelp - YesNoUnsure
|
|
riskTimelines - YesNoUnsure
|
|
riskExperience - Int
|
|
riskKnowledge - Int
|
|
riskPast - Int
|
|
riskCurrent - Int
|
|
riskTimeframe - Int
|
|
riskVariability - Int
|
|
riskVolatility - Int
|
|
riskReaction - Int
|
|
riskTolerance - Int
|
|
riskFuture - Int
|
|
createdBy - String!
|
|
created - String!
|
|
updatedBy - String!
|
|
updated - String!
|
Example
{
"clientId": 123,
"introVideo": "abc123",
"customisationVideo": "xyz789",
"customisation": "Y",
"ethicalVideo": "abc123",
"ethical": "Y",
"assetClassVideo": "xyz789",
"allocationVideo": "xyz789",
"allocationType": "S",
"riskVideo": "abc123",
"comfortableWithDownturn": "abc123",
"costVideo": "abc123",
"costDriven": "Y",
"prioritisation": [InvestmentPreferencesRanking],
"comments": "abc123",
"customisationVideoHelp": "Y",
"customisationVideoComments": "abc123",
"ethicalVideoHelp": "Y",
"ethicalVideoComments": "abc123",
"assetClassVideoHelp": "Y",
"assetClassVideoComments": "xyz789",
"allocationVideoHelp": "Y",
"allocationVideoComments": "xyz789",
"riskVideoHelp": "Y",
"riskVideoComments": "abc123",
"riskDiversification": 987,
"riskMarketCorrection": 123,
"riskPercentageDrop": 123,
"riskCapitalProtection": "Y",
"riskAccessCapital": 123,
"riskInfluencedByReturns": 123,
"riskIncreaseToMeetGoal": 987,
"riskMaxDownside": 987,
"riskInflation": 123,
"costVideoHelp": "Y",
"costVideoComments": "xyz789",
"assetClassAndDiversificationVideoHelp": "Y",
"assetClassPreferences": "Y",
"assetClassPreferencesComments": "abc123",
"assetClassRisk": "Y",
"assetClassRiskComments": "xyz789",
"ethicalPreferences": "Y",
"ethicalPreferencesComments": "xyz789",
"activePassiveVideoHelp": "Y",
"costWealthPriorities": "A",
"riskVolatilityVideoHelp": "Y",
"riskTimelines": "Y",
"riskExperience": 987,
"riskKnowledge": 123,
"riskPast": 123,
"riskCurrent": 987,
"riskTimeframe": 987,
"riskVariability": 123,
"riskVolatility": 987,
"riskReaction": 987,
"riskTolerance": 123,
"riskFuture": 123,
"createdBy": "xyz789",
"created": "abc123",
"updatedBy": "xyz789",
"updated": "xyz789"
}
InvestmentPreferencesInput
Fields
| Input Field | Description |
|---|---|
clientId - Int!
|
|
inviteCode - ID
|
|
introVideo - String
|
|
customisationVideo - String
|
|
customisation - YesNoMaybe
|
|
ethicalVideo - String
|
|
ethical - YesNoMaybe
|
|
assetClassVideo - String
|
|
allocationVideo - String
|
|
allocationType - AssetAllocationType
|
|
riskVideo - String
|
|
comfortableWithDownturn - String
|
|
costVideo - String
|
|
costDriven - YesNo
|
|
prioritisation - [InvestmentPreferencesRankingInput]
|
|
comments - String
|
|
customisationVideoHelp - YesNo
|
|
customisationVideoComments - String
|
|
ethicalVideoHelp - YesNo
|
|
ethicalVideoComments - String
|
|
assetClassVideoHelp - YesNo
|
|
assetClassVideoComments - String
|
|
allocationVideoHelp - YesNo
|
|
allocationVideoComments - String
|
|
riskVideoHelp - YesNo
|
|
riskVideoComments - String
|
|
riskDiversification - Int
|
|
riskMarketCorrection - Int
|
|
riskPercentageDrop - Int
|
|
riskCapitalProtection - YesNo
|
|
riskAccessCapital - Int
|
|
riskInfluencedByReturns - Int
|
|
riskIncreaseToMeetGoal - Int
|
|
riskMaxDownside - Int
|
|
riskInflation - Int
|
|
costVideoHelp - YesNo
|
|
costVideoComments - String
|
|
assetClassAndDiversificationVideoHelp - YesNoUnsure
|
|
assetClassPreferences - YesNo
|
|
assetClassPreferencesComments - String
|
|
assetClassRisk - YesNo
|
|
assetClassRiskComments - String
|
|
ethicalPreferences - YesNo
|
|
ethicalPreferencesComments - String
|
|
activePassiveVideoHelp - YesNoUnsure
|
|
costWealthPriorities - WealthPriorities
|
|
riskVolatilityVideoHelp - YesNoUnsure
|
|
riskTimelines - YesNoUnsure
|
|
riskExperience - Int
|
|
riskKnowledge - Int
|
|
riskPast - Int
|
|
riskCurrent - Int
|
|
riskTimeframe - Int
|
|
riskVariability - Int
|
|
riskVolatility - Int
|
|
riskReaction - Int
|
|
riskTolerance - Int
|
|
riskFuture - Int
|
Example
{
"clientId": 123,
"inviteCode": 4,
"introVideo": "xyz789",
"customisationVideo": "xyz789",
"customisation": "Y",
"ethicalVideo": "abc123",
"ethical": "Y",
"assetClassVideo": "xyz789",
"allocationVideo": "xyz789",
"allocationType": "S",
"riskVideo": "abc123",
"comfortableWithDownturn": "abc123",
"costVideo": "abc123",
"costDriven": "Y",
"prioritisation": [InvestmentPreferencesRankingInput],
"comments": "abc123",
"customisationVideoHelp": "Y",
"customisationVideoComments": "abc123",
"ethicalVideoHelp": "Y",
"ethicalVideoComments": "xyz789",
"assetClassVideoHelp": "Y",
"assetClassVideoComments": "xyz789",
"allocationVideoHelp": "Y",
"allocationVideoComments": "abc123",
"riskVideoHelp": "Y",
"riskVideoComments": "abc123",
"riskDiversification": 987,
"riskMarketCorrection": 123,
"riskPercentageDrop": 987,
"riskCapitalProtection": "Y",
"riskAccessCapital": 987,
"riskInfluencedByReturns": 123,
"riskIncreaseToMeetGoal": 987,
"riskMaxDownside": 987,
"riskInflation": 987,
"costVideoHelp": "Y",
"costVideoComments": "xyz789",
"assetClassAndDiversificationVideoHelp": "Y",
"assetClassPreferences": "Y",
"assetClassPreferencesComments": "xyz789",
"assetClassRisk": "Y",
"assetClassRiskComments": "xyz789",
"ethicalPreferences": "Y",
"ethicalPreferencesComments": "xyz789",
"activePassiveVideoHelp": "Y",
"costWealthPriorities": "A",
"riskVolatilityVideoHelp": "Y",
"riskTimelines": "Y",
"riskExperience": 123,
"riskKnowledge": 123,
"riskPast": 123,
"riskCurrent": 123,
"riskTimeframe": 123,
"riskVariability": 123,
"riskVolatility": 987,
"riskReaction": 123,
"riskTolerance": 123,
"riskFuture": 123
}
InvestmentPreferencesOutput
Fields
| Field Name | Description |
|---|---|
client - InvestmentPreferences
|
|
partner - InvestmentPreferences
|
|
household - HouseholdInvestmentPreferences
|
Example
{
"client": InvestmentPreferences,
"partner": InvestmentPreferences,
"household": HouseholdInvestmentPreferences
}
InvestmentPreferencesRanking
InvestmentPreferencesRankingInput
InvestmentPreferencesSession
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
clientId - Int!
|
|
inviteCode - String
|
|
fullName - String
|
|
status - String
|
|
introVideo - String
|
|
customisationVideo - String
|
|
customisation - YesNoMaybe
|
|
ethicalVideo - String
|
|
ethical - YesNoMaybe
|
|
assetClassVideo - String
|
|
allocationVideo - String
|
|
allocationType - AssetAllocationType
|
|
riskVideo - String
|
|
comfortableWithDownturn - String
|
|
costVideo - String
|
|
costDriven - YesNo
|
|
prioritisation - [InvestmentPreferencesRanking!]
|
|
comments - String
|
|
customisationVideoHelp - YesNo
|
|
customisationVideoComments - String
|
|
ethicalVideoHelp - YesNo
|
|
ethicalVideoComments - String
|
|
assetClassVideoHelp - YesNo
|
|
assetClassVideoComments - String
|
|
allocationVideoHelp - YesNo
|
|
allocationVideoComments - String
|
|
riskVideoHelp - YesNo
|
|
riskVideoComments - String
|
|
riskDiversification - Int
|
|
riskMarketCorrection - Int
|
|
riskPercentageDrop - Int
|
|
riskCapitalProtection - YesNo
|
|
riskAccessCapital - Int
|
|
riskInfluencedByReturns - Int
|
|
riskIncreaseToMeetGoal - Int
|
|
riskMaxDownside - Int
|
|
riskInflation - Int
|
|
costVideoHelp - YesNo
|
|
costVideoComments - String
|
|
assetClassAndDiversificationVideoHelp - YesNoUnsure
|
|
assetClassPreferences - YesNo
|
|
assetClassPreferencesComments - String
|
|
assetClassRisk - YesNo
|
|
assetClassRiskComments - String
|
|
ethicalPreferences - YesNo
|
|
ethicalPreferencesComments - String
|
|
activePassiveVideoHelp - YesNoUnsure
|
|
costWealthPriorities - WealthPriorities
|
|
riskVolatilityVideoHelp - YesNoUnsure
|
|
riskTimelines - YesNoUnsure
|
|
riskExperience - Int
|
|
riskKnowledge - Int
|
|
riskPast - Int
|
|
riskCurrent - Int
|
|
riskTimeframe - Int
|
|
riskVariability - Int
|
|
riskVolatility - Int
|
|
riskReaction - Int
|
|
riskTolerance - Int
|
|
riskFuture - Int
|
|
includeRiskSection - Boolean
|
|
includeIntroSection - Boolean
|
|
includeCustomisationSection - Boolean
|
|
includeEthicalSection - Boolean
|
|
includeAssetClassSection - Boolean
|
|
includeAllocationSection - Boolean
|
|
includeCostSection - Boolean
|
|
includePrioritisationSection - Boolean
|
|
includeCommentsSection - Boolean
|
|
createdAt - AWSDateTime!
|
|
updatedAt - AWSDateTime!
|
Example
{
"id": 4,
"clientId": 987,
"inviteCode": "xyz789",
"fullName": "abc123",
"status": "xyz789",
"introVideo": "xyz789",
"customisationVideo": "abc123",
"customisation": "Y",
"ethicalVideo": "xyz789",
"ethical": "Y",
"assetClassVideo": "abc123",
"allocationVideo": "abc123",
"allocationType": "S",
"riskVideo": "abc123",
"comfortableWithDownturn": "abc123",
"costVideo": "xyz789",
"costDriven": "Y",
"prioritisation": [InvestmentPreferencesRanking],
"comments": "xyz789",
"customisationVideoHelp": "Y",
"customisationVideoComments": "abc123",
"ethicalVideoHelp": "Y",
"ethicalVideoComments": "abc123",
"assetClassVideoHelp": "Y",
"assetClassVideoComments": "abc123",
"allocationVideoHelp": "Y",
"allocationVideoComments": "abc123",
"riskVideoHelp": "Y",
"riskVideoComments": "abc123",
"riskDiversification": 123,
"riskMarketCorrection": 987,
"riskPercentageDrop": 987,
"riskCapitalProtection": "Y",
"riskAccessCapital": 987,
"riskInfluencedByReturns": 987,
"riskIncreaseToMeetGoal": 123,
"riskMaxDownside": 123,
"riskInflation": 987,
"costVideoHelp": "Y",
"costVideoComments": "abc123",
"assetClassAndDiversificationVideoHelp": "Y",
"assetClassPreferences": "Y",
"assetClassPreferencesComments": "xyz789",
"assetClassRisk": "Y",
"assetClassRiskComments": "xyz789",
"ethicalPreferences": "Y",
"ethicalPreferencesComments": "abc123",
"activePassiveVideoHelp": "Y",
"costWealthPriorities": "A",
"riskVolatilityVideoHelp": "Y",
"riskTimelines": "Y",
"riskExperience": 123,
"riskKnowledge": 123,
"riskPast": 987,
"riskCurrent": 123,
"riskTimeframe": 987,
"riskVariability": 123,
"riskVolatility": 987,
"riskReaction": 987,
"riskTolerance": 123,
"riskFuture": 123,
"includeRiskSection": true,
"includeIntroSection": false,
"includeCustomisationSection": false,
"includeEthicalSection": false,
"includeAssetClassSection": false,
"includeAllocationSection": true,
"includeCostSection": true,
"includePrioritisationSection": false,
"includeCommentsSection": false,
"createdAt": AWSDateTime,
"updatedAt": AWSDateTime
}
InvestmentPreferencesVideoOutput
Example
{
"introVideoUrl": "xyz789",
"customisationVideoUrl": "abc123",
"ethicalVideoUrl": "abc123",
"assetClassVideoUrl": "xyz789",
"allocationVideoUrl": "xyz789",
"riskVideoUrl": "abc123",
"costVideoUrl": "abc123"
}
InviteInvestmentPreferencesInput
InviteRegistrationInput
InviteYourLifeInput
IsLumiantExperienceClientInput
Fields
| Input Field | Description |
|---|---|
emailAddress - String!
|
Example
{"emailAddress": "abc123"}
IsUniqueExternalIdInput
ItemToThinkAbout
Fields
| Field Name | Description |
|---|---|
householdId - Int
|
|
names - String
|
|
description - String
|
|
itemType - AdviserLandingPageCardItemType
|
Example
{
"householdId": 987,
"names": "abc123",
"description": "abc123",
"itemType": "LIFE"
}
LegalEntityOutput
Fields
| Field Name | Description |
|---|---|
legalEntityId - Int!
|
|
householdId - Int
|
|
legalEntityType - String!
|
|
companyType - String
|
|
trusteeType - String
|
|
trustType - String
|
|
name - String
|
|
purpose - String
|
|
abn - String
|
|
tfn - String
|
|
value - Float
|
|
growthBps - Float
|
|
growthDollar - Float
|
|
clientShare - Float
|
|
partnerShare - Float
|
|
clientSuperPhase - String
|
|
partnerSuperPhase - String
|
|
notes - String
|
|
clientNotes - String
|
|
partnerNotes - String
|
|
confidentialNotes - String
|
|
createdBy - String!
|
|
created - String!
|
|
updatedBy - String!
|
|
updated - String!
|
Example
{
"legalEntityId": 987,
"householdId": 987,
"legalEntityType": "abc123",
"companyType": "xyz789",
"trusteeType": "abc123",
"trustType": "xyz789",
"name": "abc123",
"purpose": "abc123",
"abn": "xyz789",
"tfn": "abc123",
"value": 987.65,
"growthBps": 987.65,
"growthDollar": 987.65,
"clientShare": 987.65,
"partnerShare": 987.65,
"clientSuperPhase": "xyz789",
"partnerSuperPhase": "abc123",
"notes": "xyz789",
"clientNotes": "xyz789",
"partnerNotes": "abc123",
"confidentialNotes": "abc123",
"createdBy": "abc123",
"created": "abc123",
"updatedBy": "xyz789",
"updated": "xyz789"
}
LiabilityOutput
Fields
| Field Name | Description |
|---|---|
liabilityId - Int!
|
|
householdId - Int
|
|
clientId - Int
|
|
clientFirstName - String
|
|
clientLastName - String
|
|
clientPreferredName - String
|
|
clientIdPA - Int
|
|
clientIdPADate - String
|
|
clientIdApprovalStatus - String
|
|
legalEntityId - Int
|
|
legalEntityName - String
|
|
legalEntityIdPA - Int
|
|
legalEntityIdPADate - String
|
|
legalEntityIdApprovalStatus - String
|
|
assetId - Int
|
|
liabilityType - String!
|
|
loanType - String
|
|
description - String
|
|
accountNumber - String
|
|
providerName - String
|
|
lender - String
|
|
maxLimit - Float
|
|
originalAmount - Float
|
|
owing - Float
|
|
owingPA - Float
|
|
owingPADate - String
|
|
owingApprovalStatus - String
|
|
rate - Float
|
|
ratePA - Float
|
|
ratePADate - String
|
|
rateApprovalStatus - String
|
|
interestRateType - String
|
|
repayment - Float
|
|
repaymentPA - Float
|
|
repaymentPADate - String
|
|
repaymentApprovalStatus - String
|
|
repaymentFrequency - String
|
|
repaymentFrequencyPA - String
|
|
repaymentFrequencyPADate - String
|
|
repaymentFrequencyApprovalStatus - String
|
|
monthlyPayment - Float
|
|
notes - String
|
|
clientNotes - String
|
|
partnerNotes - String
|
|
confidentialNotes - String
|
|
displayName - String
|
|
externalSystem - ExternalSystem
|
|
liabilityYodleeMapping - YodleeMapping
|
|
forApproval - Boolean
|
|
approvalStatus - String
|
|
approvalChangeDate - String
|
|
createdBy - String!
|
|
created - String!
|
|
updatedBy - String!
|
|
updated - String!
|
Example
{
"liabilityId": 123,
"householdId": 123,
"clientId": 987,
"clientFirstName": "abc123",
"clientLastName": "xyz789",
"clientPreferredName": "abc123",
"clientIdPA": 123,
"clientIdPADate": "xyz789",
"clientIdApprovalStatus": "abc123",
"legalEntityId": 123,
"legalEntityName": "xyz789",
"legalEntityIdPA": 123,
"legalEntityIdPADate": "abc123",
"legalEntityIdApprovalStatus": "xyz789",
"assetId": 987,
"liabilityType": "abc123",
"loanType": "abc123",
"description": "abc123",
"accountNumber": "abc123",
"providerName": "xyz789",
"lender": "xyz789",
"maxLimit": 123.45,
"originalAmount": 123.45,
"owing": 123.45,
"owingPA": 987.65,
"owingPADate": "xyz789",
"owingApprovalStatus": "abc123",
"rate": 123.45,
"ratePA": 123.45,
"ratePADate": "abc123",
"rateApprovalStatus": "abc123",
"interestRateType": "xyz789",
"repayment": 987.65,
"repaymentPA": 123.45,
"repaymentPADate": "xyz789",
"repaymentApprovalStatus": "xyz789",
"repaymentFrequency": "abc123",
"repaymentFrequencyPA": "xyz789",
"repaymentFrequencyPADate": "xyz789",
"repaymentFrequencyApprovalStatus": "xyz789",
"monthlyPayment": 987.65,
"notes": "abc123",
"clientNotes": "xyz789",
"partnerNotes": "xyz789",
"confidentialNotes": "abc123",
"displayName": "xyz789",
"externalSystem": "IL",
"liabilityYodleeMapping": YodleeMapping,
"forApproval": true,
"approvalStatus": "xyz789",
"approvalChangeDate": "xyz789",
"createdBy": "xyz789",
"created": "abc123",
"updatedBy": "abc123",
"updated": "abc123"
}
LiabilityTimelineData
Fields
| Field Name | Description |
|---|---|
liabilityId - Int
|
|
timelineData - NetWorthTimelineData
|
Example
{"liabilityId": 987, "timelineData": NetWorthTimelineData}
Life
Fields
| Field Name | Description |
|---|---|
id - Int
|
|
clientId - Int
|
|
responses - [LifeQuestionnaireResponse!]!
|
|
connections - [LifeConnection!]!
|
|
notes - [LifeValueNote]
|
|
overallScore - Float
|
|
emotionalScore - Float
|
|
environmentalScore - Float
|
|
spiritualScore - Float
|
|
socialScore - Float
|
|
educationScore - Float
|
|
occupationalScore - Float
|
|
physicalScore - Float
|
|
financialScore - Float
|
|
completed - Boolean
|
|
createdBy - String!
|
|
created - String!
|
|
updatedBy - String!
|
|
updated - String!
|
Example
{
"id": 123,
"clientId": 123,
"responses": [LifeQuestionnaireResponse],
"connections": [LifeConnection],
"notes": [LifeValueNote],
"overallScore": 123.45,
"emotionalScore": 987.65,
"environmentalScore": 123.45,
"spiritualScore": 987.65,
"socialScore": 987.65,
"educationScore": 987.65,
"occupationalScore": 987.65,
"physicalScore": 123.45,
"financialScore": 123.45,
"completed": false,
"createdBy": "xyz789",
"created": "abc123",
"updatedBy": "xyz789",
"updated": "xyz789"
}
LifeCompleteInput
LifeConnection
LifeConnectionsInput
Fields
| Input Field | Description |
|---|---|
lovedOnes - [String!]!
|
|
community - [String!]!
|
|
global - [String!]!
|
Example
{
"lovedOnes": ["abc123"],
"community": ["xyz789"],
"global": ["abc123"]
}
LifeHistoryOutput
LifeInput
Fields
| Input Field | Description |
|---|---|
id - Int
|
|
clientId - Int
|
|
inviteCode - String
|
|
responses - [LifeQuestionnaireResponseInput!]!
|
|
connections - LifeConnectionsInput
|
|
overallScore - Float
|
|
emotionalScore - Float
|
|
environmentalScore - Float
|
|
spiritualScore - Float
|
|
socialScore - Float
|
|
educationScore - Float
|
|
occupationalScore - Float
|
|
physicalScore - Float
|
|
financialScore - Float
|
|
notes - [LifeNoteInput]
|
|
completed - Boolean
|
Example
{
"id": 123,
"clientId": 987,
"inviteCode": "xyz789",
"responses": [LifeQuestionnaireResponseInput],
"connections": LifeConnectionsInput,
"overallScore": 123.45,
"emotionalScore": 123.45,
"environmentalScore": 987.65,
"spiritualScore": 123.45,
"socialScore": 987.65,
"educationScore": 987.65,
"occupationalScore": 123.45,
"physicalScore": 987.65,
"financialScore": 123.45,
"notes": [LifeNoteInput],
"completed": true
}
LifeNote
LifeNoteInput
LifeQuestionnaireResponse
Example
{
"id": 987,
"questionId": 987,
"stringResponse": "xyz789",
"intResponse": 987,
"createdBy": "abc123",
"created": "xyz789",
"updatedBy": "abc123",
"updated": "abc123"
}
LifeQuestionnaireResponseInput
LifeResponse
LifeResponseInput
LifeValueNote
ListAllClientsOfAHouseholdData
Example
{
"clientId": "xyz789",
"isClientActive": false,
"clientFirstName": "abc123",
"clientLastName": "xyz789",
"clientType": "xyz789",
"householdId": "abc123",
"householdName": "abc123",
"staffId": "xyz789",
"staffFirstName": "abc123",
"staffLastName": "abc123",
"isStaffActive": false
}
ListAllClientsOfAHouseholdInput
Fields
| Input Field | Description |
|---|---|
householdId - Int
|
Example
{"householdId": 123}
ListAllClientsOfAHouseholdOutput
Fields
| Field Name | Description |
|---|---|
searchResult - [ListAllClientsOfAHouseholdData]
|
Example
{"searchResult": [ListAllClientsOfAHouseholdData]}
ListClientsInput
ListClientsOutput
ListHouseholdsInput
ListHouseholdsOutput
Fields
| Field Name | Description |
|---|---|
households - [Household]
|
|
page - Int
|
|
pageSize - Int
|
|
pages - Int
|
|
totalCount - Int
|
Example
{
"households": [Household],
"page": 123,
"pageSize": 987,
"pages": 123,
"totalCount": 123
}
ListPracticesInput
Example
{
"practiceIds": [123],
"sortField": "xyz789",
"sortOrder": "xyz789",
"roleFilter": "xyz789",
"emailFilter": "abc123",
"page": 123,
"pageSize": 123
}
ListPracticesOutput
Fields
| Field Name | Description |
|---|---|
practice - [Practice]
|
|
page - Int!
|
|
pageSize - Int!
|
|
pages - Int!
|
|
totalCount - Int!
|
Example
{
"practice": [Practice],
"page": 987,
"pageSize": 123,
"pages": 123,
"totalCount": 123
}
ListStaffInput
Example
{
"staffIds": [123],
"practiceOfficeIds": [123],
"householdId": 123,
"includeAccess": true,
"limitAccessToNonViewOnly": false,
"sortField": "xyz789",
"sortOrder": "abc123",
"page": 987,
"pageSize": 123
}
ListStaffOutput
ListSurveyIdsInput
Fields
| Input Field | Description |
|---|---|
practiceId - Int
|
Example
{"practiceId": 123}
ListSurveyIdsOutput
LivingDiscretionaryExpenseOutput
Fields
| Field Name | Description |
|---|---|
livingDiscretionaryExpenseId - Int!
|
|
householdId - Int
|
|
alimony - Float
|
|
alimonyFrequency - String
|
|
childMaintenance - Float
|
|
childMaintenanceFrequency - String
|
|
childCare - Float
|
|
childCareFrequency - String
|
|
child - Float
|
|
childFrequency - String
|
|
care - Float
|
|
careFrequency - String
|
|
education - Float
|
|
educationFrequency - String
|
|
rent - Float
|
|
rentFrequency - String
|
|
associationFees - Float
|
|
associationFeesFrequency - String
|
|
rates - Float
|
|
ratesFrequency - String
|
|
water - Float
|
|
waterFrequency - String
|
|
gardening - Float
|
|
gardeningFrequency - String
|
|
homeImprovement - Float
|
|
homeImprovementFrequency - String
|
|
repairs - Float
|
|
repairsFrequency - String
|
|
electricity - Float
|
|
electricityFrequency - String
|
|
gas - Float
|
|
gasFrequency - String
|
|
groceries - Float
|
|
groceriesFrequency - String
|
|
homePhone - Float
|
|
homePhoneFrequency - String
|
|
cable - Float
|
|
cableFrequency - String
|
|
broadband - Float
|
|
broadbandFrequency - String
|
|
mobile - Float
|
|
mobileFrequency - String
|
|
cleaning - Float
|
|
cleaningFrequency - String
|
|
personalCare - Float
|
|
personalCareFrequency - String
|
|
petCare - Float
|
|
petCareFrequency - String
|
|
appliances - Float
|
|
appliancesFrequency - String
|
|
homeOther - Float
|
|
homeOtherFrequency - String
|
|
clothing - Float
|
|
clothingFrequency - String
|
|
footwear - Float
|
|
footwearFrequency - String
|
|
healthcare - Float
|
|
healthcareFrequency - String
|
|
dental - Float
|
|
dentalFrequency - String
|
|
healthcareOther - Float
|
|
healthcareOtherFrequency - String
|
|
carTransport - Float
|
|
carTransportFrequency - String
|
|
publicTransport - Float
|
|
publicTransportFrequency - String
|
|
livingOther - Float
|
|
livingOtherFrequency - String
|
|
memberships - Float
|
|
membershipsFrequency - String
|
|
streaming - Float
|
|
streamingFrequency - String
|
|
alcohol - Float
|
|
alcoholFrequency - String
|
|
tobacco - Float
|
|
tobaccoFrequency - String
|
|
entertainment - Float
|
|
entertainmentFrequency - String
|
|
hobbies - Float
|
|
hobbiesFrequency - String
|
|
vacations - Float
|
|
vacationsFrequency - String
|
|
takeAway - Float
|
|
takeAwayFrequency - String
|
|
gifts - Float
|
|
giftsFrequency - String
|
|
donations - Float
|
|
donationsFrequency - String
|
|
discretionaryOther - Float
|
|
discretionaryOtherFrequency - String
|
|
notes - String
|
|
clientNotes - String
|
|
partnerNotes - String
|
|
confidentialNotes - String
|
|
createdBy - String!
|
|
created - String!
|
|
updatedBy - String!
|
|
updated - String!
|
Example
{
"livingDiscretionaryExpenseId": 987,
"householdId": 123,
"alimony": 123.45,
"alimonyFrequency": "abc123",
"childMaintenance": 123.45,
"childMaintenanceFrequency": "xyz789",
"childCare": 987.65,
"childCareFrequency": "abc123",
"child": 987.65,
"childFrequency": "xyz789",
"care": 123.45,
"careFrequency": "abc123",
"education": 123.45,
"educationFrequency": "abc123",
"rent": 987.65,
"rentFrequency": "xyz789",
"associationFees": 987.65,
"associationFeesFrequency": "xyz789",
"rates": 123.45,
"ratesFrequency": "xyz789",
"water": 987.65,
"waterFrequency": "xyz789",
"gardening": 987.65,
"gardeningFrequency": "xyz789",
"homeImprovement": 987.65,
"homeImprovementFrequency": "xyz789",
"repairs": 123.45,
"repairsFrequency": "abc123",
"electricity": 123.45,
"electricityFrequency": "abc123",
"gas": 123.45,
"gasFrequency": "xyz789",
"groceries": 123.45,
"groceriesFrequency": "abc123",
"homePhone": 987.65,
"homePhoneFrequency": "xyz789",
"cable": 987.65,
"cableFrequency": "abc123",
"broadband": 123.45,
"broadbandFrequency": "xyz789",
"mobile": 987.65,
"mobileFrequency": "abc123",
"cleaning": 123.45,
"cleaningFrequency": "abc123",
"personalCare": 987.65,
"personalCareFrequency": "xyz789",
"petCare": 123.45,
"petCareFrequency": "xyz789",
"appliances": 123.45,
"appliancesFrequency": "abc123",
"homeOther": 987.65,
"homeOtherFrequency": "abc123",
"clothing": 123.45,
"clothingFrequency": "abc123",
"footwear": 987.65,
"footwearFrequency": "abc123",
"healthcare": 987.65,
"healthcareFrequency": "xyz789",
"dental": 987.65,
"dentalFrequency": "xyz789",
"healthcareOther": 123.45,
"healthcareOtherFrequency": "xyz789",
"carTransport": 123.45,
"carTransportFrequency": "xyz789",
"publicTransport": 123.45,
"publicTransportFrequency": "abc123",
"livingOther": 123.45,
"livingOtherFrequency": "xyz789",
"memberships": 987.65,
"membershipsFrequency": "xyz789",
"streaming": 123.45,
"streamingFrequency": "xyz789",
"alcohol": 987.65,
"alcoholFrequency": "abc123",
"tobacco": 987.65,
"tobaccoFrequency": "abc123",
"entertainment": 987.65,
"entertainmentFrequency": "abc123",
"hobbies": 987.65,
"hobbiesFrequency": "abc123",
"vacations": 123.45,
"vacationsFrequency": "xyz789",
"takeAway": 123.45,
"takeAwayFrequency": "abc123",
"gifts": 987.65,
"giftsFrequency": "xyz789",
"donations": 987.65,
"donationsFrequency": "xyz789",
"discretionaryOther": 123.45,
"discretionaryOtherFrequency": "abc123",
"notes": "xyz789",
"clientNotes": "xyz789",
"partnerNotes": "abc123",
"confidentialNotes": "abc123",
"createdBy": "xyz789",
"created": "xyz789",
"updatedBy": "abc123",
"updated": "xyz789"
}
MakeClientNonBillableInput
MakeClientNonBillableOutput
Fields
| Field Name | Description |
|---|---|
updateMsg - String!
|
Example
{"updateMsg": "xyz789"}
MergeClientsIntoOneHouseholdInput
MergeHouseholdInput
MergeHouseholdOutput
Fields
| Field Name | Description |
|---|---|
householdId - Int
|
Example
{"householdId": 987}
ModelAssetAllocationTypeInput
Fields
| Input Field | Description |
|---|---|
eq - AssetAllocationType
|
|
ne - AssetAllocationType
|
Example
{"eq": "S", "ne": "S"}
ModelAttributeTypes
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"binary"
ModelBooleanInput
Fields
| Input Field | Description |
|---|---|
ne - Boolean
|
|
eq - Boolean
|
|
attributeExists - Boolean
|
|
attributeType - ModelAttributeTypes
|
Example
{"ne": true, "eq": true, "attributeExists": true, "attributeType": "binary"}
ModelExternalUploadTrackingConditionInput
Fields
| Input Field | Description |
|---|---|
fullS3ObjectPath - ModelStringInput
|
|
identityId - ModelStringInput
|
|
objectKey - ModelStringInput
|
|
practiceId - ModelIntInput
|
|
clientId - ModelIntInput
|
|
goalId - ModelIntInput
|
|
and - [ModelExternalUploadTrackingConditionInput]
|
|
or - [ModelExternalUploadTrackingConditionInput]
|
|
not - ModelExternalUploadTrackingConditionInput
|
Example
{
"fullS3ObjectPath": ModelStringInput,
"identityId": ModelStringInput,
"objectKey": ModelStringInput,
"practiceId": ModelIntInput,
"clientId": ModelIntInput,
"goalId": ModelIntInput,
"and": [ModelExternalUploadTrackingConditionInput],
"or": [ModelExternalUploadTrackingConditionInput],
"not": ModelExternalUploadTrackingConditionInput
}
ModelExternalUploadTrackingConnection
Fields
| Field Name | Description |
|---|---|
items - [ExternalUploadTracking]!
|
|
nextToken - String
|
Example
{
"items": [ExternalUploadTracking],
"nextToken": "abc123"
}
ModelExternalUploadTrackingFilterInput
Fields
| Input Field | Description |
|---|---|
id - ModelIDInput
|
|
fullS3ObjectPath - ModelStringInput
|
|
identityId - ModelStringInput
|
|
objectKey - ModelStringInput
|
|
practiceId - ModelIntInput
|
|
clientId - ModelIntInput
|
|
goalId - ModelIntInput
|
|
and - [ModelExternalUploadTrackingFilterInput]
|
|
or - [ModelExternalUploadTrackingFilterInput]
|
|
not - ModelExternalUploadTrackingFilterInput
|
Example
{
"id": ModelIDInput,
"fullS3ObjectPath": ModelStringInput,
"identityId": ModelStringInput,
"objectKey": ModelStringInput,
"practiceId": ModelIntInput,
"clientId": ModelIntInput,
"goalId": ModelIntInput,
"and": [ModelExternalUploadTrackingFilterInput],
"or": [ModelExternalUploadTrackingFilterInput],
"not": ModelExternalUploadTrackingFilterInput
}
ModelFinancialHealthAssessmentSessionConditionInput
Fields
| Input Field | Description |
|---|---|
clientId - ModelIntInput
|
|
inviteCode - ModelStringInput
|
|
householdId - ModelIntInput
|
|
status - ModelStringInput
|
|
firstName - ModelStringInput
|
|
lastName - ModelStringInput
|
|
fullName - ModelStringInput
|
|
hasPartner - ModelBooleanInput
|
|
partnerId - ModelIntInput
|
|
partnerFirstName - ModelStringInput
|
|
partnerLastName - ModelStringInput
|
|
partnerFullName - ModelStringInput
|
|
finHealthAssessmentFull - ModelBooleanInput
|
|
visionGoalsScore - ModelIntInput
|
|
retirementPlanningScore - ModelIntInput
|
|
insuranceAssetProtectionScore - ModelIntInput
|
|
debtCashFlowManagementScore - ModelIntInput
|
|
educationPlanningScore - ModelIntInput
|
|
investmentPlanningScore - ModelIntInput
|
|
incomeTaxPlanningScore - ModelIntInput
|
|
businessPlanningScore - ModelIntInput
|
|
charitablePlanningScore - ModelIntInput
|
|
estatePlanningScore - ModelIntInput
|
|
and - [ModelFinancialHealthAssessmentSessionConditionInput]
|
|
or - [ModelFinancialHealthAssessmentSessionConditionInput]
|
|
not - ModelFinancialHealthAssessmentSessionConditionInput
|
Example
{
"clientId": ModelIntInput,
"inviteCode": ModelStringInput,
"householdId": ModelIntInput,
"status": ModelStringInput,
"firstName": ModelStringInput,
"lastName": ModelStringInput,
"fullName": ModelStringInput,
"hasPartner": ModelBooleanInput,
"partnerId": ModelIntInput,
"partnerFirstName": ModelStringInput,
"partnerLastName": ModelStringInput,
"partnerFullName": ModelStringInput,
"finHealthAssessmentFull": ModelBooleanInput,
"visionGoalsScore": ModelIntInput,
"retirementPlanningScore": ModelIntInput,
"insuranceAssetProtectionScore": ModelIntInput,
"debtCashFlowManagementScore": ModelIntInput,
"educationPlanningScore": ModelIntInput,
"investmentPlanningScore": ModelIntInput,
"incomeTaxPlanningScore": ModelIntInput,
"businessPlanningScore": ModelIntInput,
"charitablePlanningScore": ModelIntInput,
"estatePlanningScore": ModelIntInput,
"and": [
ModelFinancialHealthAssessmentSessionConditionInput
],
"or": [
ModelFinancialHealthAssessmentSessionConditionInput
],
"not": ModelFinancialHealthAssessmentSessionConditionInput
}
ModelFinancialHealthAssessmentSessionConnection
Fields
| Field Name | Description |
|---|---|
items - [FinancialHealthAssessmentSession]!
|
|
nextToken - String
|
Example
{
"items": [FinancialHealthAssessmentSession],
"nextToken": "abc123"
}
ModelFinancialHealthAssessmentSessionFilterInput
Fields
| Input Field | Description |
|---|---|
id - ModelIDInput
|
|
clientId - ModelIntInput
|
|
inviteCode - ModelStringInput
|
|
householdId - ModelIntInput
|
|
status - ModelStringInput
|
|
firstName - ModelStringInput
|
|
lastName - ModelStringInput
|
|
fullName - ModelStringInput
|
|
hasPartner - ModelBooleanInput
|
|
partnerId - ModelIntInput
|
|
partnerFirstName - ModelStringInput
|
|
partnerLastName - ModelStringInput
|
|
partnerFullName - ModelStringInput
|
|
finHealthAssessmentFull - ModelBooleanInput
|
|
visionGoalsScore - ModelIntInput
|
|
retirementPlanningScore - ModelIntInput
|
|
insuranceAssetProtectionScore - ModelIntInput
|
|
debtCashFlowManagementScore - ModelIntInput
|
|
educationPlanningScore - ModelIntInput
|
|
investmentPlanningScore - ModelIntInput
|
|
incomeTaxPlanningScore - ModelIntInput
|
|
businessPlanningScore - ModelIntInput
|
|
charitablePlanningScore - ModelIntInput
|
|
estatePlanningScore - ModelIntInput
|
|
and - [ModelFinancialHealthAssessmentSessionFilterInput]
|
|
or - [ModelFinancialHealthAssessmentSessionFilterInput]
|
|
not - ModelFinancialHealthAssessmentSessionFilterInput
|
Example
{
"id": ModelIDInput,
"clientId": ModelIntInput,
"inviteCode": ModelStringInput,
"householdId": ModelIntInput,
"status": ModelStringInput,
"firstName": ModelStringInput,
"lastName": ModelStringInput,
"fullName": ModelStringInput,
"hasPartner": ModelBooleanInput,
"partnerId": ModelIntInput,
"partnerFirstName": ModelStringInput,
"partnerLastName": ModelStringInput,
"partnerFullName": ModelStringInput,
"finHealthAssessmentFull": ModelBooleanInput,
"visionGoalsScore": ModelIntInput,
"retirementPlanningScore": ModelIntInput,
"insuranceAssetProtectionScore": ModelIntInput,
"debtCashFlowManagementScore": ModelIntInput,
"educationPlanningScore": ModelIntInput,
"investmentPlanningScore": ModelIntInput,
"incomeTaxPlanningScore": ModelIntInput,
"businessPlanningScore": ModelIntInput,
"charitablePlanningScore": ModelIntInput,
"estatePlanningScore": ModelIntInput,
"and": [
ModelFinancialHealthAssessmentSessionFilterInput
],
"or": [
ModelFinancialHealthAssessmentSessionFilterInput
],
"not": ModelFinancialHealthAssessmentSessionFilterInput
}
ModelFloatInput
Example
{
"ne": 123.45,
"eq": 123.45,
"le": 987.65,
"lt": 987.65,
"ge": 987.65,
"gt": 123.45,
"between": [123.45],
"attributeExists": true,
"attributeType": "binary"
}
ModelGoalsSessionConditionInput
Fields
| Input Field | Description |
|---|---|
clientId - ModelIntInput
|
|
inviteCode - ModelStringInput
|
|
selectedGoalCategoryIds - ModelIntInput
|
|
and - [ModelGoalsSessionConditionInput]
|
|
or - [ModelGoalsSessionConditionInput]
|
|
not - ModelGoalsSessionConditionInput
|
Example
{
"clientId": ModelIntInput,
"inviteCode": ModelStringInput,
"selectedGoalCategoryIds": ModelIntInput,
"and": [ModelGoalsSessionConditionInput],
"or": [ModelGoalsSessionConditionInput],
"not": ModelGoalsSessionConditionInput
}
ModelGoalsSessionConnection
Fields
| Field Name | Description |
|---|---|
items - [GoalsSession]!
|
|
nextToken - String
|
Example
{
"items": [GoalsSession],
"nextToken": "xyz789"
}
ModelGoalsSessionFilterInput
Fields
| Input Field | Description |
|---|---|
id - ModelIDInput
|
|
clientId - ModelIntInput
|
|
inviteCode - ModelStringInput
|
|
selectedGoalCategoryIds - ModelIntInput
|
|
and - [ModelGoalsSessionFilterInput]
|
|
or - [ModelGoalsSessionFilterInput]
|
|
not - ModelGoalsSessionFilterInput
|
Example
{
"id": ModelIDInput,
"clientId": ModelIntInput,
"inviteCode": ModelStringInput,
"selectedGoalCategoryIds": ModelIntInput,
"and": [ModelGoalsSessionFilterInput],
"or": [ModelGoalsSessionFilterInput],
"not": ModelGoalsSessionFilterInput
}
ModelIDInput
Example
{
"ne": 4,
"eq": "4",
"le": "4",
"lt": 4,
"ge": "4",
"gt": "4",
"contains": 4,
"notContains": 4,
"between": ["4"],
"beginsWith": 4,
"attributeExists": false,
"attributeType": "binary",
"size": ModelSizeInput
}
ModelIntInput
Example
{
"ne": 123,
"eq": 123,
"le": 987,
"lt": 987,
"ge": 987,
"gt": 123,
"between": [123],
"attributeExists": true,
"attributeType": "binary"
}
ModelInvestmentPreferencesSessionConditionInput
Fields
| Input Field | Description |
|---|---|
clientId - ModelIntInput
|
|
inviteCode - ModelStringInput
|
|
fullName - ModelStringInput
|
|
status - ModelStringInput
|
|
introVideo - ModelStringInput
|
|
customisationVideo - ModelStringInput
|
|
customisation - ModelYesNoMaybeInput
|
|
ethicalVideo - ModelStringInput
|
|
ethical - ModelYesNoMaybeInput
|
|
assetClassVideo - ModelStringInput
|
|
allocationVideo - ModelStringInput
|
|
allocationType - ModelAssetAllocationTypeInput
|
|
riskVideo - ModelStringInput
|
|
comfortableWithDownturn - ModelStringInput
|
|
costVideo - ModelStringInput
|
|
costDriven - ModelYesNoInput
|
|
comments - ModelStringInput
|
|
customisationVideoHelp - ModelYesNoInput
|
|
customisationVideoComments - ModelStringInput
|
|
ethicalVideoHelp - ModelYesNoInput
|
|
ethicalVideoComments - ModelStringInput
|
|
assetClassVideoHelp - ModelYesNoInput
|
|
assetClassVideoComments - ModelStringInput
|
|
allocationVideoHelp - ModelYesNoInput
|
|
allocationVideoComments - ModelStringInput
|
|
riskVideoHelp - ModelYesNoInput
|
|
riskVideoComments - ModelStringInput
|
|
riskDiversification - ModelIntInput
|
|
riskMarketCorrection - ModelIntInput
|
|
riskPercentageDrop - ModelIntInput
|
|
riskCapitalProtection - ModelYesNoInput
|
|
riskAccessCapital - ModelIntInput
|
|
riskInfluencedByReturns - ModelIntInput
|
|
riskIncreaseToMeetGoal - ModelIntInput
|
|
riskMaxDownside - ModelIntInput
|
|
riskInflation - ModelIntInput
|
|
costVideoHelp - ModelYesNoInput
|
|
costVideoComments - ModelStringInput
|
|
assetClassAndDiversificationVideoHelp - ModelYesNoUnsureInput
|
|
assetClassPreferences - ModelYesNoInput
|
|
assetClassPreferencesComments - ModelStringInput
|
|
assetClassRisk - ModelYesNoInput
|
|
assetClassRiskComments - ModelStringInput
|
|
ethicalPreferences - ModelYesNoInput
|
|
ethicalPreferencesComments - ModelStringInput
|
|
activePassiveVideoHelp - ModelYesNoUnsureInput
|
|
costWealthPriorities - ModelWealthPrioritiesInput
|
|
riskVolatilityVideoHelp - ModelYesNoUnsureInput
|
|
riskTimelines - ModelYesNoUnsureInput
|
|
riskExperience - ModelIntInput
|
|
riskKnowledge - ModelIntInput
|
|
riskPast - ModelIntInput
|
|
riskCurrent - ModelIntInput
|
|
riskTimeframe - ModelIntInput
|
|
riskVariability - ModelIntInput
|
|
riskVolatility - ModelIntInput
|
|
riskReaction - ModelIntInput
|
|
riskTolerance - ModelIntInput
|
|
riskFuture - ModelIntInput
|
|
includeRiskSection - ModelBooleanInput
|
|
includeIntroSection - ModelBooleanInput
|
|
includeCustomisationSection - ModelBooleanInput
|
|
includeEthicalSection - ModelBooleanInput
|
|
includeAssetClassSection - ModelBooleanInput
|
|
includeAllocationSection - ModelBooleanInput
|
|
includeCostSection - ModelBooleanInput
|
|
includePrioritisationSection - ModelBooleanInput
|
|
includeCommentsSection - ModelBooleanInput
|
|
and - [ModelInvestmentPreferencesSessionConditionInput]
|
|
or - [ModelInvestmentPreferencesSessionConditionInput]
|
|
not - ModelInvestmentPreferencesSessionConditionInput
|
Example
{
"clientId": ModelIntInput,
"inviteCode": ModelStringInput,
"fullName": ModelStringInput,
"status": ModelStringInput,
"introVideo": ModelStringInput,
"customisationVideo": ModelStringInput,
"customisation": ModelYesNoMaybeInput,
"ethicalVideo": ModelStringInput,
"ethical": ModelYesNoMaybeInput,
"assetClassVideo": ModelStringInput,
"allocationVideo": ModelStringInput,
"allocationType": ModelAssetAllocationTypeInput,
"riskVideo": ModelStringInput,
"comfortableWithDownturn": ModelStringInput,
"costVideo": ModelStringInput,
"costDriven": ModelYesNoInput,
"comments": ModelStringInput,
"customisationVideoHelp": ModelYesNoInput,
"customisationVideoComments": ModelStringInput,
"ethicalVideoHelp": ModelYesNoInput,
"ethicalVideoComments": ModelStringInput,
"assetClassVideoHelp": ModelYesNoInput,
"assetClassVideoComments": ModelStringInput,
"allocationVideoHelp": ModelYesNoInput,
"allocationVideoComments": ModelStringInput,
"riskVideoHelp": ModelYesNoInput,
"riskVideoComments": ModelStringInput,
"riskDiversification": ModelIntInput,
"riskMarketCorrection": ModelIntInput,
"riskPercentageDrop": ModelIntInput,
"riskCapitalProtection": ModelYesNoInput,
"riskAccessCapital": ModelIntInput,
"riskInfluencedByReturns": ModelIntInput,
"riskIncreaseToMeetGoal": ModelIntInput,
"riskMaxDownside": ModelIntInput,
"riskInflation": ModelIntInput,
"costVideoHelp": ModelYesNoInput,
"costVideoComments": ModelStringInput,
"assetClassAndDiversificationVideoHelp": ModelYesNoUnsureInput,
"assetClassPreferences": ModelYesNoInput,
"assetClassPreferencesComments": ModelStringInput,
"assetClassRisk": ModelYesNoInput,
"assetClassRiskComments": ModelStringInput,
"ethicalPreferences": ModelYesNoInput,
"ethicalPreferencesComments": ModelStringInput,
"activePassiveVideoHelp": ModelYesNoUnsureInput,
"costWealthPriorities": ModelWealthPrioritiesInput,
"riskVolatilityVideoHelp": ModelYesNoUnsureInput,
"riskTimelines": ModelYesNoUnsureInput,
"riskExperience": ModelIntInput,
"riskKnowledge": ModelIntInput,
"riskPast": ModelIntInput,
"riskCurrent": ModelIntInput,
"riskTimeframe": ModelIntInput,
"riskVariability": ModelIntInput,
"riskVolatility": ModelIntInput,
"riskReaction": ModelIntInput,
"riskTolerance": ModelIntInput,
"riskFuture": ModelIntInput,
"includeRiskSection": ModelBooleanInput,
"includeIntroSection": ModelBooleanInput,
"includeCustomisationSection": ModelBooleanInput,
"includeEthicalSection": ModelBooleanInput,
"includeAssetClassSection": ModelBooleanInput,
"includeAllocationSection": ModelBooleanInput,
"includeCostSection": ModelBooleanInput,
"includePrioritisationSection": ModelBooleanInput,
"includeCommentsSection": ModelBooleanInput,
"and": [
ModelInvestmentPreferencesSessionConditionInput
],
"or": [ModelInvestmentPreferencesSessionConditionInput],
"not": ModelInvestmentPreferencesSessionConditionInput
}
ModelInvestmentPreferencesSessionConnection
Fields
| Field Name | Description |
|---|---|
items - [InvestmentPreferencesSession]!
|
|
nextToken - String
|
Example
{
"items": [InvestmentPreferencesSession],
"nextToken": "xyz789"
}
ModelInvestmentPreferencesSessionFilterInput
Fields
| Input Field | Description |
|---|---|
id - ModelIDInput
|
|
clientId - ModelIntInput
|
|
inviteCode - ModelStringInput
|
|
fullName - ModelStringInput
|
|
status - ModelStringInput
|
|
introVideo - ModelStringInput
|
|
customisationVideo - ModelStringInput
|
|
customisation - ModelYesNoMaybeInput
|
|
ethicalVideo - ModelStringInput
|
|
ethical - ModelYesNoMaybeInput
|
|
assetClassVideo - ModelStringInput
|
|
allocationVideo - ModelStringInput
|
|
allocationType - ModelAssetAllocationTypeInput
|
|
riskVideo - ModelStringInput
|
|
comfortableWithDownturn - ModelStringInput
|
|
costVideo - ModelStringInput
|
|
costDriven - ModelYesNoInput
|
|
comments - ModelStringInput
|
|
customisationVideoHelp - ModelYesNoInput
|
|
customisationVideoComments - ModelStringInput
|
|
ethicalVideoHelp - ModelYesNoInput
|
|
ethicalVideoComments - ModelStringInput
|
|
assetClassVideoHelp - ModelYesNoInput
|
|
assetClassVideoComments - ModelStringInput
|
|
allocationVideoHelp - ModelYesNoInput
|
|
allocationVideoComments - ModelStringInput
|
|
riskVideoHelp - ModelYesNoInput
|
|
riskVideoComments - ModelStringInput
|
|
riskDiversification - ModelIntInput
|
|
riskMarketCorrection - ModelIntInput
|
|
riskPercentageDrop - ModelIntInput
|
|
riskCapitalProtection - ModelYesNoInput
|
|
riskAccessCapital - ModelIntInput
|
|
riskInfluencedByReturns - ModelIntInput
|
|
riskIncreaseToMeetGoal - ModelIntInput
|
|
riskMaxDownside - ModelIntInput
|
|
riskInflation - ModelIntInput
|
|
costVideoHelp - ModelYesNoInput
|
|
costVideoComments - ModelStringInput
|
|
assetClassAndDiversificationVideoHelp - ModelYesNoUnsureInput
|
|
assetClassPreferences - ModelYesNoInput
|
|
assetClassPreferencesComments - ModelStringInput
|
|
assetClassRisk - ModelYesNoInput
|
|
assetClassRiskComments - ModelStringInput
|
|
ethicalPreferences - ModelYesNoInput
|
|
ethicalPreferencesComments - ModelStringInput
|
|
activePassiveVideoHelp - ModelYesNoUnsureInput
|
|
costWealthPriorities - ModelWealthPrioritiesInput
|
|
riskVolatilityVideoHelp - ModelYesNoUnsureInput
|
|
riskTimelines - ModelYesNoUnsureInput
|
|
riskExperience - ModelIntInput
|
|
riskKnowledge - ModelIntInput
|
|
riskPast - ModelIntInput
|
|
riskCurrent - ModelIntInput
|
|
riskTimeframe - ModelIntInput
|
|
riskVariability - ModelIntInput
|
|
riskVolatility - ModelIntInput
|
|
riskReaction - ModelIntInput
|
|
riskTolerance - ModelIntInput
|
|
riskFuture - ModelIntInput
|
|
includeRiskSection - ModelBooleanInput
|
|
includeIntroSection - ModelBooleanInput
|
|
includeCustomisationSection - ModelBooleanInput
|
|
includeEthicalSection - ModelBooleanInput
|
|
includeAssetClassSection - ModelBooleanInput
|
|
includeAllocationSection - ModelBooleanInput
|
|
includeCostSection - ModelBooleanInput
|
|
includePrioritisationSection - ModelBooleanInput
|
|
includeCommentsSection - ModelBooleanInput
|
|
and - [ModelInvestmentPreferencesSessionFilterInput]
|
|
or - [ModelInvestmentPreferencesSessionFilterInput]
|
|
not - ModelInvestmentPreferencesSessionFilterInput
|
Example
{
"id": ModelIDInput,
"clientId": ModelIntInput,
"inviteCode": ModelStringInput,
"fullName": ModelStringInput,
"status": ModelStringInput,
"introVideo": ModelStringInput,
"customisationVideo": ModelStringInput,
"customisation": ModelYesNoMaybeInput,
"ethicalVideo": ModelStringInput,
"ethical": ModelYesNoMaybeInput,
"assetClassVideo": ModelStringInput,
"allocationVideo": ModelStringInput,
"allocationType": ModelAssetAllocationTypeInput,
"riskVideo": ModelStringInput,
"comfortableWithDownturn": ModelStringInput,
"costVideo": ModelStringInput,
"costDriven": ModelYesNoInput,
"comments": ModelStringInput,
"customisationVideoHelp": ModelYesNoInput,
"customisationVideoComments": ModelStringInput,
"ethicalVideoHelp": ModelYesNoInput,
"ethicalVideoComments": ModelStringInput,
"assetClassVideoHelp": ModelYesNoInput,
"assetClassVideoComments": ModelStringInput,
"allocationVideoHelp": ModelYesNoInput,
"allocationVideoComments": ModelStringInput,
"riskVideoHelp": ModelYesNoInput,
"riskVideoComments": ModelStringInput,
"riskDiversification": ModelIntInput,
"riskMarketCorrection": ModelIntInput,
"riskPercentageDrop": ModelIntInput,
"riskCapitalProtection": ModelYesNoInput,
"riskAccessCapital": ModelIntInput,
"riskInfluencedByReturns": ModelIntInput,
"riskIncreaseToMeetGoal": ModelIntInput,
"riskMaxDownside": ModelIntInput,
"riskInflation": ModelIntInput,
"costVideoHelp": ModelYesNoInput,
"costVideoComments": ModelStringInput,
"assetClassAndDiversificationVideoHelp": ModelYesNoUnsureInput,
"assetClassPreferences": ModelYesNoInput,
"assetClassPreferencesComments": ModelStringInput,
"assetClassRisk": ModelYesNoInput,
"assetClassRiskComments": ModelStringInput,
"ethicalPreferences": ModelYesNoInput,
"ethicalPreferencesComments": ModelStringInput,
"activePassiveVideoHelp": ModelYesNoUnsureInput,
"costWealthPriorities": ModelWealthPrioritiesInput,
"riskVolatilityVideoHelp": ModelYesNoUnsureInput,
"riskTimelines": ModelYesNoUnsureInput,
"riskExperience": ModelIntInput,
"riskKnowledge": ModelIntInput,
"riskPast": ModelIntInput,
"riskCurrent": ModelIntInput,
"riskTimeframe": ModelIntInput,
"riskVariability": ModelIntInput,
"riskVolatility": ModelIntInput,
"riskReaction": ModelIntInput,
"riskTolerance": ModelIntInput,
"riskFuture": ModelIntInput,
"includeRiskSection": ModelBooleanInput,
"includeIntroSection": ModelBooleanInput,
"includeCustomisationSection": ModelBooleanInput,
"includeEthicalSection": ModelBooleanInput,
"includeAssetClassSection": ModelBooleanInput,
"includeAllocationSection": ModelBooleanInput,
"includeCostSection": ModelBooleanInput,
"includePrioritisationSection": ModelBooleanInput,
"includeCommentsSection": ModelBooleanInput,
"and": [ModelInvestmentPreferencesSessionFilterInput],
"or": [ModelInvestmentPreferencesSessionFilterInput],
"not": ModelInvestmentPreferencesSessionFilterInput
}
ModelMutation
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"create"
ModelMutationMap
ModelNotificationConditionInput
Fields
| Input Field | Description |
|---|---|
owner - ModelStringInput
|
|
recipient - ModelStringInput
|
|
message - ModelStringInput
|
|
messageRead - ModelBooleanInput
|
|
createdAt - ModelStringInput
|
|
updatedAt - ModelStringInput
|
|
and - [ModelNotificationConditionInput]
|
|
or - [ModelNotificationConditionInput]
|
|
not - ModelNotificationConditionInput
|
Example
{
"owner": ModelStringInput,
"recipient": ModelStringInput,
"message": ModelStringInput,
"messageRead": ModelBooleanInput,
"createdAt": ModelStringInput,
"updatedAt": ModelStringInput,
"and": [ModelNotificationConditionInput],
"or": [ModelNotificationConditionInput],
"not": ModelNotificationConditionInput
}
ModelNotificationConnection
Fields
| Field Name | Description |
|---|---|
items - [Notification]!
|
|
nextToken - String
|
Example
{
"items": [Notification],
"nextToken": "xyz789"
}
ModelNotificationFilterInput
Fields
| Input Field | Description |
|---|---|
id - ModelIDInput
|
|
owner - ModelStringInput
|
|
recipient - ModelStringInput
|
|
message - ModelStringInput
|
|
messageRead - ModelBooleanInput
|
|
createdAt - ModelStringInput
|
|
updatedAt - ModelStringInput
|
|
and - [ModelNotificationFilterInput]
|
|
or - [ModelNotificationFilterInput]
|
|
not - ModelNotificationFilterInput
|
Example
{
"id": ModelIDInput,
"owner": ModelStringInput,
"recipient": ModelStringInput,
"message": ModelStringInput,
"messageRead": ModelBooleanInput,
"createdAt": ModelStringInput,
"updatedAt": ModelStringInput,
"and": [ModelNotificationFilterInput],
"or": [ModelNotificationFilterInput],
"not": ModelNotificationFilterInput
}
ModelNotificationPointerConditionInput
Fields
| Input Field | Description |
|---|---|
owner - ModelStringInput
|
|
recipient - ModelStringInput
|
|
notificationId - ModelStringInput
|
|
createdAt - ModelStringInput
|
|
updatedAt - ModelStringInput
|
|
and - [ModelNotificationPointerConditionInput]
|
|
or - [ModelNotificationPointerConditionInput]
|
|
not - ModelNotificationPointerConditionInput
|
Example
{
"owner": ModelStringInput,
"recipient": ModelStringInput,
"notificationId": ModelStringInput,
"createdAt": ModelStringInput,
"updatedAt": ModelStringInput,
"and": [ModelNotificationPointerConditionInput],
"or": [ModelNotificationPointerConditionInput],
"not": ModelNotificationPointerConditionInput
}
ModelNotificationPointerConnection
Fields
| Field Name | Description |
|---|---|
items - [NotificationPointer]!
|
|
nextToken - String
|
Example
{
"items": [NotificationPointer],
"nextToken": "abc123"
}
ModelNotificationPointerFilterInput
Fields
| Input Field | Description |
|---|---|
id - ModelIDInput
|
|
owner - ModelStringInput
|
|
recipient - ModelStringInput
|
|
notificationId - ModelStringInput
|
|
createdAt - ModelStringInput
|
|
updatedAt - ModelStringInput
|
|
and - [ModelNotificationPointerFilterInput]
|
|
or - [ModelNotificationPointerFilterInput]
|
|
not - ModelNotificationPointerFilterInput
|
Example
{
"id": ModelIDInput,
"owner": ModelStringInput,
"recipient": ModelStringInput,
"notificationId": ModelStringInput,
"createdAt": ModelStringInput,
"updatedAt": ModelStringInput,
"and": [ModelNotificationPointerFilterInput],
"or": [ModelNotificationPointerFilterInput],
"not": ModelNotificationPointerFilterInput
}
ModelOperation
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"create"
ModelOriginationQuestionnaireInput
Fields
| Input Field | Description |
|---|---|
eq - OriginationQuestionnaire
|
|
ne - OriginationQuestionnaire
|
Example
{"eq": "LIFE", "ne": "LIFE"}
ModelOriginationQuestionnaireListInput
Fields
| Input Field | Description |
|---|---|
eq - [OriginationQuestionnaire]
|
|
ne - [OriginationQuestionnaire]
|
|
contains - OriginationQuestionnaire
|
|
notContains - OriginationQuestionnaire
|
Example
{"eq": ["LIFE"], "ne": ["LIFE"], "contains": "LIFE", "notContains": "LIFE"}
ModelOriginationSessionConditionInput
Fields
| Input Field | Description |
|---|---|
clientId - ModelIntInput
|
|
inviteCode - ModelStringInput
|
|
householdId - ModelIntInput
|
|
status - ModelStringInput
|
|
clientFirstName - ModelStringInput
|
|
clientLastName - ModelStringInput
|
|
clientFullName - ModelStringInput
|
|
hasPartner - ModelBooleanInput
|
|
partnerId - ModelIntInput
|
|
partnerFirstName - ModelStringInput
|
|
partnerLastName - ModelStringInput
|
|
partnerFullName - ModelStringInput
|
|
questionnaires - ModelOriginationQuestionnaireInput
|
|
lifeIncGoals - ModelBooleanInput
|
|
lifeIncConnections - ModelBooleanInput
|
|
lifeIncFinancialDetails - ModelBooleanInput
|
|
finHealthAssessmentFull - ModelBooleanInput
|
|
foundationsFull - ModelBooleanInput
|
|
valuesInc3Things - ModelBooleanInput
|
|
governanceIncPersonalDetails - ModelBooleanInput
|
|
governanceIncAssetsLiabilitiesIncomeExpenses - ModelBooleanInput
|
|
governanceIncInsurance - ModelBooleanInput
|
|
governanceIncBusinessPlanning - ModelBooleanInput
|
|
governanceIncEducationPlanning - ModelBooleanInput
|
|
governanceIncCharitablePlanning - ModelBooleanInput
|
|
governanceIncTaxPlanning - ModelBooleanInput
|
|
governanceIncEstatePlanning - ModelBooleanInput
|
|
investmentPreferencesIncRiskSection - ModelBooleanInput
|
|
investmentPreferencesIncIntroSection - ModelBooleanInput
|
|
investmentPreferencesIncCustomisationSection - ModelBooleanInput
|
|
investmentPreferencesIncEthicalSection - ModelBooleanInput
|
|
investmentPreferencesIncAssetClassSection - ModelBooleanInput
|
|
investmentPreferencesIncAllocationSection - ModelBooleanInput
|
|
investmentPreferencesIncCostSection - ModelBooleanInput
|
|
investmentPreferencesIncPrioritisationSection - ModelBooleanInput
|
|
investmentPreferencesIncCommentsSection - ModelBooleanInput
|
|
uploadIdentity - ModelStringInput
|
|
completedQuestionnaires - ModelOriginationQuestionnaireListInput
|
|
failedQuestionnaires - ModelOriginationQuestionnaireListInput
|
|
and - [ModelOriginationSessionConditionInput]
|
|
or - [ModelOriginationSessionConditionInput]
|
|
not - ModelOriginationSessionConditionInput
|
Example
{
"clientId": ModelIntInput,
"inviteCode": ModelStringInput,
"householdId": ModelIntInput,
"status": ModelStringInput,
"clientFirstName": ModelStringInput,
"clientLastName": ModelStringInput,
"clientFullName": ModelStringInput,
"hasPartner": ModelBooleanInput,
"partnerId": ModelIntInput,
"partnerFirstName": ModelStringInput,
"partnerLastName": ModelStringInput,
"partnerFullName": ModelStringInput,
"questionnaires": ModelOriginationQuestionnaireInput,
"lifeIncGoals": ModelBooleanInput,
"lifeIncConnections": ModelBooleanInput,
"lifeIncFinancialDetails": ModelBooleanInput,
"finHealthAssessmentFull": ModelBooleanInput,
"foundationsFull": ModelBooleanInput,
"valuesInc3Things": ModelBooleanInput,
"governanceIncPersonalDetails": ModelBooleanInput,
"governanceIncAssetsLiabilitiesIncomeExpenses": ModelBooleanInput,
"governanceIncInsurance": ModelBooleanInput,
"governanceIncBusinessPlanning": ModelBooleanInput,
"governanceIncEducationPlanning": ModelBooleanInput,
"governanceIncCharitablePlanning": ModelBooleanInput,
"governanceIncTaxPlanning": ModelBooleanInput,
"governanceIncEstatePlanning": ModelBooleanInput,
"investmentPreferencesIncRiskSection": ModelBooleanInput,
"investmentPreferencesIncIntroSection": ModelBooleanInput,
"investmentPreferencesIncCustomisationSection": ModelBooleanInput,
"investmentPreferencesIncEthicalSection": ModelBooleanInput,
"investmentPreferencesIncAssetClassSection": ModelBooleanInput,
"investmentPreferencesIncAllocationSection": ModelBooleanInput,
"investmentPreferencesIncCostSection": ModelBooleanInput,
"investmentPreferencesIncPrioritisationSection": ModelBooleanInput,
"investmentPreferencesIncCommentsSection": ModelBooleanInput,
"uploadIdentity": ModelStringInput,
"completedQuestionnaires": ModelOriginationQuestionnaireListInput,
"failedQuestionnaires": ModelOriginationQuestionnaireListInput,
"and": [ModelOriginationSessionConditionInput],
"or": [ModelOriginationSessionConditionInput],
"not": ModelOriginationSessionConditionInput
}
ModelOriginationSessionConnection
Fields
| Field Name | Description |
|---|---|
items - [OriginationSession]!
|
|
nextToken - String
|
Example
{
"items": [OriginationSession],
"nextToken": "abc123"
}
ModelOriginationSessionFilterInput
Fields
| Input Field | Description |
|---|---|
id - ModelIDInput
|
|
clientId - ModelIntInput
|
|
inviteCode - ModelStringInput
|
|
householdId - ModelIntInput
|
|
status - ModelStringInput
|
|
clientFirstName - ModelStringInput
|
|
clientLastName - ModelStringInput
|
|
clientFullName - ModelStringInput
|
|
hasPartner - ModelBooleanInput
|
|
partnerId - ModelIntInput
|
|
partnerFirstName - ModelStringInput
|
|
partnerLastName - ModelStringInput
|
|
partnerFullName - ModelStringInput
|
|
questionnaires - ModelOriginationQuestionnaireInput
|
|
lifeIncGoals - ModelBooleanInput
|
|
lifeIncConnections - ModelBooleanInput
|
|
lifeIncFinancialDetails - ModelBooleanInput
|
|
finHealthAssessmentFull - ModelBooleanInput
|
|
foundationsFull - ModelBooleanInput
|
|
valuesInc3Things - ModelBooleanInput
|
|
governanceIncPersonalDetails - ModelBooleanInput
|
|
governanceIncAssetsLiabilitiesIncomeExpenses - ModelBooleanInput
|
|
governanceIncInsurance - ModelBooleanInput
|
|
governanceIncBusinessPlanning - ModelBooleanInput
|
|
governanceIncEducationPlanning - ModelBooleanInput
|
|
governanceIncCharitablePlanning - ModelBooleanInput
|
|
governanceIncTaxPlanning - ModelBooleanInput
|
|
governanceIncEstatePlanning - ModelBooleanInput
|
|
investmentPreferencesIncRiskSection - ModelBooleanInput
|
|
investmentPreferencesIncIntroSection - ModelBooleanInput
|
|
investmentPreferencesIncCustomisationSection - ModelBooleanInput
|
|
investmentPreferencesIncEthicalSection - ModelBooleanInput
|
|
investmentPreferencesIncAssetClassSection - ModelBooleanInput
|
|
investmentPreferencesIncAllocationSection - ModelBooleanInput
|
|
investmentPreferencesIncCostSection - ModelBooleanInput
|
|
investmentPreferencesIncPrioritisationSection - ModelBooleanInput
|
|
investmentPreferencesIncCommentsSection - ModelBooleanInput
|
|
uploadIdentity - ModelStringInput
|
|
completedQuestionnaires - ModelOriginationQuestionnaireListInput
|
|
failedQuestionnaires - ModelOriginationQuestionnaireListInput
|
|
and - [ModelOriginationSessionFilterInput]
|
|
or - [ModelOriginationSessionFilterInput]
|
|
not - ModelOriginationSessionFilterInput
|
Example
{
"id": ModelIDInput,
"clientId": ModelIntInput,
"inviteCode": ModelStringInput,
"householdId": ModelIntInput,
"status": ModelStringInput,
"clientFirstName": ModelStringInput,
"clientLastName": ModelStringInput,
"clientFullName": ModelStringInput,
"hasPartner": ModelBooleanInput,
"partnerId": ModelIntInput,
"partnerFirstName": ModelStringInput,
"partnerLastName": ModelStringInput,
"partnerFullName": ModelStringInput,
"questionnaires": ModelOriginationQuestionnaireInput,
"lifeIncGoals": ModelBooleanInput,
"lifeIncConnections": ModelBooleanInput,
"lifeIncFinancialDetails": ModelBooleanInput,
"finHealthAssessmentFull": ModelBooleanInput,
"foundationsFull": ModelBooleanInput,
"valuesInc3Things": ModelBooleanInput,
"governanceIncPersonalDetails": ModelBooleanInput,
"governanceIncAssetsLiabilitiesIncomeExpenses": ModelBooleanInput,
"governanceIncInsurance": ModelBooleanInput,
"governanceIncBusinessPlanning": ModelBooleanInput,
"governanceIncEducationPlanning": ModelBooleanInput,
"governanceIncCharitablePlanning": ModelBooleanInput,
"governanceIncTaxPlanning": ModelBooleanInput,
"governanceIncEstatePlanning": ModelBooleanInput,
"investmentPreferencesIncRiskSection": ModelBooleanInput,
"investmentPreferencesIncIntroSection": ModelBooleanInput,
"investmentPreferencesIncCustomisationSection": ModelBooleanInput,
"investmentPreferencesIncEthicalSection": ModelBooleanInput,
"investmentPreferencesIncAssetClassSection": ModelBooleanInput,
"investmentPreferencesIncAllocationSection": ModelBooleanInput,
"investmentPreferencesIncCostSection": ModelBooleanInput,
"investmentPreferencesIncPrioritisationSection": ModelBooleanInput,
"investmentPreferencesIncCommentsSection": ModelBooleanInput,
"uploadIdentity": ModelStringInput,
"completedQuestionnaires": ModelOriginationQuestionnaireListInput,
"failedQuestionnaires": ModelOriginationQuestionnaireListInput,
"and": [ModelOriginationSessionFilterInput],
"or": [ModelOriginationSessionFilterInput],
"not": ModelOriginationSessionFilterInput
}
ModelQuery
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"get"
ModelQueryMap
ModelRedtailLoadErrorsConditionInput
Fields
| Input Field | Description |
|---|---|
errorMessage - ModelStringInput
|
|
redtailPayload - ModelStringInput
|
|
and - [ModelRedtailLoadErrorsConditionInput]
|
|
or - [ModelRedtailLoadErrorsConditionInput]
|
|
not - ModelRedtailLoadErrorsConditionInput
|
Example
{
"errorMessage": ModelStringInput,
"redtailPayload": ModelStringInput,
"and": [ModelRedtailLoadErrorsConditionInput],
"or": [ModelRedtailLoadErrorsConditionInput],
"not": ModelRedtailLoadErrorsConditionInput
}
ModelRedtailLoadErrorsConnection
Fields
| Field Name | Description |
|---|---|
items - [RedtailLoadErrors]!
|
|
nextToken - String
|
Example
{
"items": [RedtailLoadErrors],
"nextToken": "xyz789"
}
ModelRedtailLoadErrorsFilterInput
Fields
| Input Field | Description |
|---|---|
id - ModelIDInput
|
|
errorMessage - ModelStringInput
|
|
redtailPayload - ModelStringInput
|
|
and - [ModelRedtailLoadErrorsFilterInput]
|
|
or - [ModelRedtailLoadErrorsFilterInput]
|
|
not - ModelRedtailLoadErrorsFilterInput
|
Example
{
"id": ModelIDInput,
"errorMessage": ModelStringInput,
"redtailPayload": ModelStringInput,
"and": [ModelRedtailLoadErrorsFilterInput],
"or": [ModelRedtailLoadErrorsFilterInput],
"not": ModelRedtailLoadErrorsFilterInput
}
ModelRegistrationConditionInput
Fields
| Input Field | Description |
|---|---|
clientId - ModelIntInput
|
|
inviteCode - ModelStringInput
|
|
fullName - ModelStringInput
|
|
and - [ModelRegistrationConditionInput]
|
|
or - [ModelRegistrationConditionInput]
|
|
not - ModelRegistrationConditionInput
|
Example
{
"clientId": ModelIntInput,
"inviteCode": ModelStringInput,
"fullName": ModelStringInput,
"and": [ModelRegistrationConditionInput],
"or": [ModelRegistrationConditionInput],
"not": ModelRegistrationConditionInput
}
ModelRegistrationConnection
Fields
| Field Name | Description |
|---|---|
items - [Registration]!
|
|
nextToken - String
|
Example
{
"items": [Registration],
"nextToken": "xyz789"
}
ModelRegistrationFilterInput
Fields
| Input Field | Description |
|---|---|
id - ModelIDInput
|
|
clientId - ModelIntInput
|
|
inviteCode - ModelStringInput
|
|
fullName - ModelStringInput
|
|
and - [ModelRegistrationFilterInput]
|
|
or - [ModelRegistrationFilterInput]
|
|
not - ModelRegistrationFilterInput
|
Example
{
"id": ModelIDInput,
"clientId": ModelIntInput,
"inviteCode": ModelStringInput,
"fullName": ModelStringInput,
"and": [ModelRegistrationFilterInput],
"or": [ModelRegistrationFilterInput],
"not": ModelRegistrationFilterInput
}
ModelSecurityConditionInput
Fields
| Input Field | Description |
|---|---|
assetClassName - ModelStringInput
|
|
code - ModelStringInput
|
|
description - ModelStringInput
|
|
exchange - ModelStringInput
|
|
msCode - ModelStringInput
|
|
msNonFundCode - ModelStringInput
|
|
name - ModelStringInput
|
|
securityId - ModelIntInput
|
|
securityType - ModelStringInput
|
|
securityGroup - ModelStringInput
|
|
ticker - ModelStringInput
|
|
and - [ModelSecurityConditionInput]
|
|
or - [ModelSecurityConditionInput]
|
|
not - ModelSecurityConditionInput
|
Example
{
"assetClassName": ModelStringInput,
"code": ModelStringInput,
"description": ModelStringInput,
"exchange": ModelStringInput,
"msCode": ModelStringInput,
"msNonFundCode": ModelStringInput,
"name": ModelStringInput,
"securityId": ModelIntInput,
"securityType": ModelStringInput,
"securityGroup": ModelStringInput,
"ticker": ModelStringInput,
"and": [ModelSecurityConditionInput],
"or": [ModelSecurityConditionInput],
"not": ModelSecurityConditionInput
}
ModelSecurityConnection
Fields
| Field Name | Description |
|---|---|
items - [Security]!
|
|
nextToken - String
|
Example
{
"items": [Security],
"nextToken": "abc123"
}
ModelSecurityFilterInput
Fields
| Input Field | Description |
|---|---|
id - ModelIDInput
|
|
assetClassName - ModelStringInput
|
|
code - ModelStringInput
|
|
description - ModelStringInput
|
|
exchange - ModelStringInput
|
|
msCode - ModelStringInput
|
|
msNonFundCode - ModelStringInput
|
|
name - ModelStringInput
|
|
securityId - ModelIntInput
|
|
securityType - ModelStringInput
|
|
securityGroup - ModelStringInput
|
|
ticker - ModelStringInput
|
|
and - [ModelSecurityFilterInput]
|
|
or - [ModelSecurityFilterInput]
|
|
not - ModelSecurityFilterInput
|
Example
{
"id": ModelIDInput,
"assetClassName": ModelStringInput,
"code": ModelStringInput,
"description": ModelStringInput,
"exchange": ModelStringInput,
"msCode": ModelStringInput,
"msNonFundCode": ModelStringInput,
"name": ModelStringInput,
"securityId": ModelIntInput,
"securityType": ModelStringInput,
"securityGroup": ModelStringInput,
"ticker": ModelStringInput,
"and": [ModelSecurityFilterInput],
"or": [ModelSecurityFilterInput],
"not": ModelSecurityFilterInput
}
ModelSizeInput
ModelSortDirection
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"ASC"
ModelStringInput
Example
{
"ne": "abc123",
"eq": "abc123",
"le": "xyz789",
"lt": "xyz789",
"ge": "xyz789",
"gt": "abc123",
"contains": "xyz789",
"notContains": "xyz789",
"between": ["xyz789"],
"beginsWith": "xyz789",
"attributeExists": true,
"attributeType": "binary",
"size": ModelSizeInput
}
ModelSubscriptionBooleanInput
ModelSubscriptionFloatInput
ModelSubscriptionIDInput
Example
{
"ne": "4",
"eq": 4,
"le": "4",
"lt": 4,
"ge": "4",
"gt": "4",
"contains": 4,
"notContains": 4,
"between": [4],
"beginsWith": 4,
"in": ["4"],
"notIn": [4]
}
ModelSubscriptionIntInput
ModelSubscriptionLevel
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"off"
ModelSubscriptionMap
Fields
| Input Field | Description |
|---|---|
onCreate - [String]
|
|
onUpdate - [String]
|
|
onDelete - [String]
|
|
level - ModelSubscriptionLevel
|
Example
{
"onCreate": ["abc123"],
"onUpdate": ["abc123"],
"onDelete": ["abc123"],
"level": "off"
}
ModelSubscriptionStringInput
Example
{
"ne": "abc123",
"eq": "xyz789",
"le": "abc123",
"lt": "xyz789",
"ge": "xyz789",
"gt": "xyz789",
"contains": "xyz789",
"notContains": "abc123",
"between": ["abc123"],
"beginsWith": "xyz789",
"in": ["xyz789"],
"notIn": ["xyz789"]
}
ModelSurveyDataResponseStatusInput
Fields
| Input Field | Description |
|---|---|
eq - SurveyDataResponseStatus
|
|
ne - SurveyDataResponseStatus
|
Example
{"eq": "SENT", "ne": "SENT"}
ModelSurveyResponseDataConditionInput
Fields
| Input Field | Description |
|---|---|
clientId - ModelIntInput
|
|
inviteCode - ModelStringInput
|
|
householdId - ModelIntInput
|
|
keyValueData - ModelStringInput
|
|
status - ModelSurveyDataResponseStatusInput
|
|
surveyId - ModelStringInput
|
|
progress - ModelFloatInput
|
|
and - [ModelSurveyResponseDataConditionInput]
|
|
or - [ModelSurveyResponseDataConditionInput]
|
|
not - ModelSurveyResponseDataConditionInput
|
Example
{
"clientId": ModelIntInput,
"inviteCode": ModelStringInput,
"householdId": ModelIntInput,
"keyValueData": ModelStringInput,
"status": ModelSurveyDataResponseStatusInput,
"surveyId": ModelStringInput,
"progress": ModelFloatInput,
"and": [ModelSurveyResponseDataConditionInput],
"or": [ModelSurveyResponseDataConditionInput],
"not": ModelSurveyResponseDataConditionInput
}
ModelSurveyResponseDataConnection
Fields
| Field Name | Description |
|---|---|
items - [SurveyResponseData]!
|
|
nextToken - String
|
Example
{
"items": [SurveyResponseData],
"nextToken": "xyz789"
}
ModelSurveyResponseDataFilterInput
Fields
| Input Field | Description |
|---|---|
id - ModelIDInput
|
|
clientId - ModelIntInput
|
|
inviteCode - ModelStringInput
|
|
householdId - ModelIntInput
|
|
keyValueData - ModelStringInput
|
|
status - ModelSurveyDataResponseStatusInput
|
|
surveyId - ModelStringInput
|
|
progress - ModelFloatInput
|
|
and - [ModelSurveyResponseDataFilterInput]
|
|
or - [ModelSurveyResponseDataFilterInput]
|
|
not - ModelSurveyResponseDataFilterInput
|
Example
{
"id": ModelIDInput,
"clientId": ModelIntInput,
"inviteCode": ModelStringInput,
"householdId": ModelIntInput,
"keyValueData": ModelStringInput,
"status": ModelSurveyDataResponseStatusInput,
"surveyId": ModelStringInput,
"progress": ModelFloatInput,
"and": [ModelSurveyResponseDataFilterInput],
"or": [ModelSurveyResponseDataFilterInput],
"not": ModelSurveyResponseDataFilterInput
}
ModelTamaracLoadErrorsConditionInput
Fields
| Input Field | Description |
|---|---|
sourceFile - ModelStringInput
|
|
errorMessage - ModelStringInput
|
|
tamaracPayload - ModelStringInput
|
|
accountId - ModelStringInput
|
|
accountNumber - ModelStringInput
|
|
primaryMemberFirstName - ModelStringInput
|
|
primaryMemberLastName - ModelStringInput
|
|
fuzzyRatio - ModelStringInput
|
|
rdsCombinedAddressString - ModelStringInput
|
|
tamaracCombinedAddressString - ModelStringInput
|
|
and - [ModelTamaracLoadErrorsConditionInput]
|
|
or - [ModelTamaracLoadErrorsConditionInput]
|
|
not - ModelTamaracLoadErrorsConditionInput
|
Example
{
"sourceFile": ModelStringInput,
"errorMessage": ModelStringInput,
"tamaracPayload": ModelStringInput,
"accountId": ModelStringInput,
"accountNumber": ModelStringInput,
"primaryMemberFirstName": ModelStringInput,
"primaryMemberLastName": ModelStringInput,
"fuzzyRatio": ModelStringInput,
"rdsCombinedAddressString": ModelStringInput,
"tamaracCombinedAddressString": ModelStringInput,
"and": [ModelTamaracLoadErrorsConditionInput],
"or": [ModelTamaracLoadErrorsConditionInput],
"not": ModelTamaracLoadErrorsConditionInput
}
ModelTamaracLoadErrorsConnection
Fields
| Field Name | Description |
|---|---|
items - [TamaracLoadErrors]!
|
|
nextToken - String
|
Example
{
"items": [TamaracLoadErrors],
"nextToken": "xyz789"
}
ModelTamaracLoadErrorsFilterInput
Fields
| Input Field | Description |
|---|---|
id - ModelIDInput
|
|
sourceFile - ModelStringInput
|
|
errorMessage - ModelStringInput
|
|
tamaracPayload - ModelStringInput
|
|
accountId - ModelStringInput
|
|
accountNumber - ModelStringInput
|
|
primaryMemberFirstName - ModelStringInput
|
|
primaryMemberLastName - ModelStringInput
|
|
fuzzyRatio - ModelStringInput
|
|
rdsCombinedAddressString - ModelStringInput
|
|
tamaracCombinedAddressString - ModelStringInput
|
|
and - [ModelTamaracLoadErrorsFilterInput]
|
|
or - [ModelTamaracLoadErrorsFilterInput]
|
|
not - ModelTamaracLoadErrorsFilterInput
|
Example
{
"id": ModelIDInput,
"sourceFile": ModelStringInput,
"errorMessage": ModelStringInput,
"tamaracPayload": ModelStringInput,
"accountId": ModelStringInput,
"accountNumber": ModelStringInput,
"primaryMemberFirstName": ModelStringInput,
"primaryMemberLastName": ModelStringInput,
"fuzzyRatio": ModelStringInput,
"rdsCombinedAddressString": ModelStringInput,
"tamaracCombinedAddressString": ModelStringInput,
"and": [ModelTamaracLoadErrorsFilterInput],
"or": [ModelTamaracLoadErrorsFilterInput],
"not": ModelTamaracLoadErrorsFilterInput
}
ModelWealthPrioritiesInput
Fields
| Input Field | Description |
|---|---|
eq - WealthPriorities
|
|
ne - WealthPriorities
|
Example
{"eq": "A", "ne": "A"}
ModelYesNoInput
ModelYesNoMaybeInput
Fields
| Input Field | Description |
|---|---|
eq - YesNoMaybe
|
|
ne - YesNoMaybe
|
Example
{"eq": "Y", "ne": "Y"}
ModelYesNoUnsureInput
Fields
| Input Field | Description |
|---|---|
eq - YesNoUnsure
|
|
ne - YesNoUnsure
|
Example
{"eq": "Y", "ne": "Y"}
ModelYourLifeSessionConditionInput
Fields
Example
{
"clientId": ModelIntInput,
"inviteCode": ModelStringInput,
"householdId": ModelIntInput,
"status": ModelStringInput,
"firstName": ModelStringInput,
"lastName": ModelStringInput,
"fullName": ModelStringInput,
"hasPartner": ModelBooleanInput,
"partnerId": ModelIntInput,
"includeGoals": ModelBooleanInput,
"includeConnections": ModelBooleanInput,
"includeFinancialDetails": ModelBooleanInput,
"partnerFirstName": ModelStringInput,
"partnerLastName": ModelStringInput,
"partnerFullName": ModelStringInput,
"lovedOnes": ModelStringInput,
"communityConnections": ModelStringInput,
"globalConnections": ModelStringInput,
"overallScore": ModelFloatInput,
"emotionalScore": ModelFloatInput,
"environmentalScore": ModelFloatInput,
"spiritualScore": ModelFloatInput,
"socialScore": ModelFloatInput,
"educationScore": ModelFloatInput,
"occupationalScore": ModelFloatInput,
"physicalScore": ModelFloatInput,
"financialScore": ModelFloatInput,
"and": [ModelYourLifeSessionConditionInput],
"or": [ModelYourLifeSessionConditionInput],
"not": ModelYourLifeSessionConditionInput
}
ModelYourLifeSessionConnection
Fields
| Field Name | Description |
|---|---|
items - [YourLifeSession]!
|
|
nextToken - String
|
Example
{
"items": [YourLifeSession],
"nextToken": "xyz789"
}
ModelYourLifeSessionFilterInput
Fields
Example
{
"id": ModelIDInput,
"clientId": ModelIntInput,
"inviteCode": ModelStringInput,
"householdId": ModelIntInput,
"status": ModelStringInput,
"firstName": ModelStringInput,
"lastName": ModelStringInput,
"fullName": ModelStringInput,
"hasPartner": ModelBooleanInput,
"partnerId": ModelIntInput,
"includeGoals": ModelBooleanInput,
"includeConnections": ModelBooleanInput,
"includeFinancialDetails": ModelBooleanInput,
"partnerFirstName": ModelStringInput,
"partnerLastName": ModelStringInput,
"partnerFullName": ModelStringInput,
"lovedOnes": ModelStringInput,
"communityConnections": ModelStringInput,
"globalConnections": ModelStringInput,
"overallScore": ModelFloatInput,
"emotionalScore": ModelFloatInput,
"environmentalScore": ModelFloatInput,
"spiritualScore": ModelFloatInput,
"socialScore": ModelFloatInput,
"educationScore": ModelFloatInput,
"occupationalScore": ModelFloatInput,
"physicalScore": ModelFloatInput,
"financialScore": ModelFloatInput,
"and": [ModelYourLifeSessionFilterInput],
"or": [ModelYourLifeSessionFilterInput],
"not": ModelYourLifeSessionFilterInput
}
ModelYourValuesSessionConditionInput
Fields
| Input Field | Description |
|---|---|
clientId - ModelIntInput
|
|
inviteCode - ModelStringInput
|
|
partnerId - ModelIntInput
|
|
partnerInviteCode - ModelStringInput
|
|
valuesInc3Things - ModelBooleanInput
|
|
partnerValuesInc3Things - ModelBooleanInput
|
|
individualValuesOnly - ModelBooleanInput
|
|
step - ModelStringInput
|
|
lastSeen - ModelStringInput
|
|
and - [ModelYourValuesSessionConditionInput]
|
|
or - [ModelYourValuesSessionConditionInput]
|
|
not - ModelYourValuesSessionConditionInput
|
Example
{
"clientId": ModelIntInput,
"inviteCode": ModelStringInput,
"partnerId": ModelIntInput,
"partnerInviteCode": ModelStringInput,
"valuesInc3Things": ModelBooleanInput,
"partnerValuesInc3Things": ModelBooleanInput,
"individualValuesOnly": ModelBooleanInput,
"step": ModelStringInput,
"lastSeen": ModelStringInput,
"and": [ModelYourValuesSessionConditionInput],
"or": [ModelYourValuesSessionConditionInput],
"not": ModelYourValuesSessionConditionInput
}
ModelYourValuesSessionConnection
Fields
| Field Name | Description |
|---|---|
items - [YourValuesSession]!
|
|
nextToken - String
|
Example
{
"items": [YourValuesSession],
"nextToken": "abc123"
}
ModelYourValuesSessionFilterInput
Fields
| Input Field | Description |
|---|---|
id - ModelIDInput
|
|
clientId - ModelIntInput
|
|
inviteCode - ModelStringInput
|
|
partnerId - ModelIntInput
|
|
partnerInviteCode - ModelStringInput
|
|
valuesInc3Things - ModelBooleanInput
|
|
partnerValuesInc3Things - ModelBooleanInput
|
|
individualValuesOnly - ModelBooleanInput
|
|
step - ModelStringInput
|
|
lastSeen - ModelStringInput
|
|
and - [ModelYourValuesSessionFilterInput]
|
|
or - [ModelYourValuesSessionFilterInput]
|
|
not - ModelYourValuesSessionFilterInput
|
Example
{
"id": ModelIDInput,
"clientId": ModelIntInput,
"inviteCode": ModelStringInput,
"partnerId": ModelIntInput,
"partnerInviteCode": ModelStringInput,
"valuesInc3Things": ModelBooleanInput,
"partnerValuesInc3Things": ModelBooleanInput,
"individualValuesOnly": ModelBooleanInput,
"step": ModelStringInput,
"lastSeen": ModelStringInput,
"and": [ModelYourValuesSessionFilterInput],
"or": [ModelYourValuesSessionFilterInput],
"not": ModelYourValuesSessionFilterInput
}
ModuleState
Example
{
"moduleStateId": 987,
"clientId": 987,
"previouslyCompleted": true,
"module": "xyz789",
"moduleState": "abc123",
"sentDate": "xyz789",
"sentReminders": 123,
"startedDate": "abc123",
"startedReminders": 987,
"finishedDate": "xyz789",
"expiredDate": "abc123",
"updatedBy": "abc123",
"updated": "xyz789"
}
ModuleStateInput
MoneyGuideMonteCarloMeter
Example
{
"presignedUrl": "xyz789",
"targetLow": 123.45,
"targetHigh": 123.45,
"numberOfTrials": 123.45,
"numberOfSuccessfulTrials": 987.65,
"probabilityOfSuccess": 123.45,
"probabilityOfSuccessFormatted": "abc123",
"confidenceZoneResult": "abc123"
}
MoveVaultFileInput
NetWorthTimelineData
Fields
| Field Name | Description |
|---|---|
all - [GraphPoint]
|
|
R3Y - [GraphPoint]
|
|
R1Y - [GraphPoint]
|
|
YTD - [GraphPoint]
|
|
R3M - [GraphPoint]
|
Example
{
"all": [GraphPoint],
"R3Y": [GraphPoint],
"R1Y": [GraphPoint],
"YTD": [GraphPoint],
"R3M": [GraphPoint]
}
NetWorthTimelineInput
NetWorthTimelineOutput
Fields
| Field Name | Description |
|---|---|
assets - [AssetTimelineData]
|
|
liabilities - [LiabilityTimelineData]
|
Example
{
"assets": [AssetTimelineData],
"liabilities": [LiabilityTimelineData]
}
Notification
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
owner - String
|
|
recipient - String
|
|
message - String
|
|
messageRead - Boolean
|
|
createdAt - AWSDateTime
|
|
updatedAt - AWSDateTime
|
Example
{
"id": 4,
"owner": "abc123",
"recipient": "xyz789",
"message": "xyz789",
"messageRead": true,
"createdAt": AWSDateTime,
"updatedAt": AWSDateTime
}
NotificationPointer
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
owner - String
|
|
recipient - String
|
|
notificationId - String
|
|
createdAt - AWSDateTime
|
|
updatedAt - AWSDateTime
|
Example
{
"id": 4,
"owner": "abc123",
"recipient": "abc123",
"notificationId": "xyz789",
"createdAt": AWSDateTime,
"updatedAt": AWSDateTime
}
OriginationQuestionnaire
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"LIFE"
OriginationSession
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
clientId - Int!
|
|
inviteCode - String!
|
|
householdId - Int
|
|
status - String
|
|
clientFirstName - String
|
|
clientLastName - String
|
|
clientFullName - String
|
|
hasPartner - Boolean
|
|
partnerId - Int
|
|
partnerFirstName - String
|
|
partnerLastName - String
|
|
partnerFullName - String
|
|
questionnaires - [OriginationQuestionnaire!]!
|
|
lifeIncGoals - Boolean
|
|
lifeIncConnections - Boolean
|
|
lifeIncFinancialDetails - Boolean
|
|
finHealthAssessmentFull - Boolean
|
|
foundationsFull - Boolean
|
|
valuesInc3Things - Boolean
|
|
governanceIncPersonalDetails - Boolean
|
|
governanceIncAssetsLiabilitiesIncomeExpenses - Boolean
|
|
governanceIncInsurance - Boolean
|
|
governanceIncBusinessPlanning - Boolean
|
|
governanceIncEducationPlanning - Boolean
|
|
governanceIncCharitablePlanning - Boolean
|
|
governanceIncTaxPlanning - Boolean
|
|
governanceIncEstatePlanning - Boolean
|
|
investmentPreferencesIncRiskSection - Boolean
|
|
investmentPreferencesIncIntroSection - Boolean
|
|
investmentPreferencesIncCustomisationSection - Boolean
|
|
investmentPreferencesIncEthicalSection - Boolean
|
|
investmentPreferencesIncAssetClassSection - Boolean
|
|
investmentPreferencesIncAllocationSection - Boolean
|
|
investmentPreferencesIncCostSection - Boolean
|
|
investmentPreferencesIncPrioritisationSection - Boolean
|
|
investmentPreferencesIncCommentsSection - Boolean
|
|
uploadFileList - [UploadVaultFileInfo]
|
|
uploadIdentity - String
|
|
stepTracker - StepTracker
|
|
completedQuestionnaires - [OriginationQuestionnaire!]
|
|
failedQuestionnaires - [OriginationQuestionnaire!]
|
|
createdAt - AWSDateTime!
|
|
updatedAt - AWSDateTime!
|
Example
{
"id": "4",
"clientId": 987,
"inviteCode": "abc123",
"householdId": 123,
"status": "abc123",
"clientFirstName": "abc123",
"clientLastName": "xyz789",
"clientFullName": "abc123",
"hasPartner": false,
"partnerId": 123,
"partnerFirstName": "abc123",
"partnerLastName": "xyz789",
"partnerFullName": "abc123",
"questionnaires": ["LIFE"],
"lifeIncGoals": false,
"lifeIncConnections": true,
"lifeIncFinancialDetails": false,
"finHealthAssessmentFull": false,
"foundationsFull": true,
"valuesInc3Things": true,
"governanceIncPersonalDetails": false,
"governanceIncAssetsLiabilitiesIncomeExpenses": true,
"governanceIncInsurance": false,
"governanceIncBusinessPlanning": false,
"governanceIncEducationPlanning": true,
"governanceIncCharitablePlanning": true,
"governanceIncTaxPlanning": false,
"governanceIncEstatePlanning": false,
"investmentPreferencesIncRiskSection": false,
"investmentPreferencesIncIntroSection": false,
"investmentPreferencesIncCustomisationSection": true,
"investmentPreferencesIncEthicalSection": false,
"investmentPreferencesIncAssetClassSection": false,
"investmentPreferencesIncAllocationSection": false,
"investmentPreferencesIncCostSection": false,
"investmentPreferencesIncPrioritisationSection": true,
"investmentPreferencesIncCommentsSection": true,
"uploadFileList": [UploadVaultFileInfo],
"uploadIdentity": "xyz789",
"stepTracker": StepTracker,
"completedQuestionnaires": ["LIFE"],
"failedQuestionnaires": ["LIFE"],
"createdAt": AWSDateTime,
"updatedAt": AWSDateTime
}
OutstandingSurveyInfo
OverdueUpcomingType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"OVERDUE"
PackagesOutput
Fields
| Field Name | Description |
|---|---|
packages - [PracticePackage]
|
Example
{"packages": [PracticePackage]}
Pagination
PaginationInput
PerformanceData
Portfolio
Fields
| Field Name | Description |
|---|---|
clientIds - [Int!]!
|
|
portfolioId - Int
|
|
legalEntityId - Int
|
|
name - String
|
|
type - String
|
|
investmentStructure - String
|
|
portfolioTotal - Float
|
|
portfolioCashTotal - Float
|
|
portfolioFixedIncomeTotal - Float
|
|
portfolioRealAssetsTotal - Float
|
|
portfolioEquitiesTotal - Float
|
|
portfolioAlternativesTotal - Float
|
|
portfolioOtherTotal - Float
|
|
portfolioMultiAssetTotal - Float
|
|
holdings - [Holding]
|
|
drilldownCsv - String
|
|
historicalData - HistoricalData
|
Example
{
"clientIds": [123],
"portfolioId": 123,
"legalEntityId": 123,
"name": "abc123",
"type": "abc123",
"investmentStructure": "xyz789",
"portfolioTotal": 123.45,
"portfolioCashTotal": 987.65,
"portfolioFixedIncomeTotal": 987.65,
"portfolioRealAssetsTotal": 987.65,
"portfolioEquitiesTotal": 987.65,
"portfolioAlternativesTotal": 987.65,
"portfolioOtherTotal": 987.65,
"portfolioMultiAssetTotal": 123.45,
"holdings": [Holding],
"drilldownCsv": "xyz789",
"historicalData": HistoricalData
}
PortfolioOutput
Example
{
"portfolioId": 123,
"householdId": 123,
"clientId": 987,
"legalEntityId": 987,
"name": "abc123",
"type": "abc123",
"accountNumber": "xyz789",
"riskScore": 123.45,
"holdings": [HoldingOutput],
"createdBy": "xyz789",
"created": "xyz789",
"updatedBy": "abc123",
"updated": "abc123"
}
PowerOfOutput
Fields
| Field Name | Description |
|---|---|
powerOfId - Int!
|
|
estatePlanningId - Int!
|
|
powerOfType - String
|
|
poaTypeEnduring - Boolean
|
|
poaTypeMedical - Boolean
|
|
poaTypeLimited - Boolean
|
|
poaTypeCare - Boolean
|
|
poaTypeOther - Boolean
|
|
firstName - String!
|
|
middleName - String
|
|
lastName - String!
|
|
isAlternate - Boolean
|
|
notes - String
|
|
clientNotes - String
|
|
partnerNotes - String
|
|
confidentialNotes - String
|
|
createdBy - String!
|
|
created - String!
|
|
updatedBy - String!
|
|
updated - String!
|
Example
{
"powerOfId": 987,
"estatePlanningId": 987,
"powerOfType": "abc123",
"poaTypeEnduring": true,
"poaTypeMedical": false,
"poaTypeLimited": true,
"poaTypeCare": false,
"poaTypeOther": false,
"firstName": "xyz789",
"middleName": "abc123",
"lastName": "xyz789",
"isAlternate": false,
"notes": "xyz789",
"clientNotes": "abc123",
"partnerNotes": "abc123",
"confidentialNotes": "abc123",
"createdBy": "xyz789",
"created": "xyz789",
"updatedBy": "xyz789",
"updated": "xyz789"
}
Practice
Fields
| Field Name | Description |
|---|---|
practiceId - Int!
|
|
practiceCode - String!
|
|
dealerGroup - DealerGroup
|
|
name - String!
|
|
abn - String
|
|
afsl - String
|
|
afslName - String
|
|
legalName - String
|
|
status - String!
|
|
originalStatus - String
|
|
ilgn - String
|
|
config - PracticeConfig
|
|
usesExternalDomain - Boolean
|
|
practicePackageCode - String!
|
|
whiteLabelling - Boolean
|
|
logos - [PracticeLogo]
|
|
offices - [PracticeOffice]
|
|
homeRegion - String!
|
|
homeLocale - String
|
|
createdBy - String!
|
|
created - String!
|
|
updatedBy - String!
|
|
updated - String!
|
Example
{
"practiceId": 123,
"practiceCode": "abc123",
"dealerGroup": DealerGroup,
"name": "xyz789",
"abn": "abc123",
"afsl": "xyz789",
"afslName": "xyz789",
"legalName": "abc123",
"status": "abc123",
"originalStatus": "abc123",
"ilgn": "abc123",
"config": PracticeConfig,
"usesExternalDomain": true,
"practicePackageCode": "abc123",
"whiteLabelling": true,
"logos": [PracticeLogo],
"offices": [PracticeOffice],
"homeRegion": "xyz789",
"homeLocale": "xyz789",
"createdBy": "xyz789",
"created": "xyz789",
"updatedBy": "xyz789",
"updated": "abc123"
}
PracticeAssetAllocation
Fields
| Field Name | Description |
|---|---|
practiceAssetAllocationId - Int!
|
|
riskGroup - Int!
|
|
assetTreeId - Int!
|
|
useStyles - Boolean
|
|
saaMin - Float
|
|
saa - Float
|
|
saaMax - Float
|
|
taaMin - Float
|
|
taa - Float
|
|
taaMax - Float
|
|
styleTopLeft - Float
|
|
styleTopCenter - Float
|
|
styleTopRight - Float
|
|
styleMiddleLeft - Float
|
|
styleMiddleCenter - Float
|
|
styleMiddleRight - Float
|
|
styleBottomLeft - Float
|
|
styleBottomCenter - Float
|
|
styleBottomRight - Float
|
|
createdBy - String!
|
|
created - String!
|
|
updatedBy - String!
|
|
updated - String!
|
Example
{
"practiceAssetAllocationId": 123,
"riskGroup": 987,
"assetTreeId": 123,
"useStyles": false,
"saaMin": 987.65,
"saa": 987.65,
"saaMax": 123.45,
"taaMin": 987.65,
"taa": 123.45,
"taaMax": 123.45,
"styleTopLeft": 987.65,
"styleTopCenter": 987.65,
"styleTopRight": 987.65,
"styleMiddleLeft": 987.65,
"styleMiddleCenter": 123.45,
"styleMiddleRight": 987.65,
"styleBottomLeft": 123.45,
"styleBottomCenter": 123.45,
"styleBottomRight": 123.45,
"createdBy": "xyz789",
"created": "abc123",
"updatedBy": "xyz789",
"updated": "xyz789"
}
PracticeAssetAllocationInput
Fields
| Input Field | Description |
|---|---|
assetTreeId - Int!
|
|
useStyles - Boolean
|
|
saaMin - Float
|
|
saa - Float
|
|
saaMax - Float
|
|
taaMin - Float
|
|
taa - Float
|
|
taaMax - Float
|
|
styleTopLeft - Float
|
|
styleTopCenter - Float
|
|
styleTopRight - Float
|
|
styleMiddleLeft - Float
|
|
styleMiddleCenter - Float
|
|
styleMiddleRight - Float
|
|
styleBottomLeft - Float
|
|
styleBottomCenter - Float
|
|
styleBottomRight - Float
|
Example
{
"assetTreeId": 987,
"useStyles": false,
"saaMin": 123.45,
"saa": 987.65,
"saaMax": 123.45,
"taaMin": 123.45,
"taa": 123.45,
"taaMax": 123.45,
"styleTopLeft": 123.45,
"styleTopCenter": 123.45,
"styleTopRight": 987.65,
"styleMiddleLeft": 987.65,
"styleMiddleCenter": 123.45,
"styleMiddleRight": 123.45,
"styleBottomLeft": 987.65,
"styleBottomCenter": 987.65,
"styleBottomRight": 987.65
}
PracticeConfig
Fields
| Field Name | Description |
|---|---|
practiceConfigId - Int
|
|
practiceId - Int
|
|
palette - PracticeConfigPalette
|
|
typography - PracticeConfigTypography
|
|
configuration - PracticeConfigConfiguration
|
|
theme - String
|
Example
{
"practiceConfigId": 123,
"practiceId": 123,
"palette": PracticeConfigPalette,
"typography": PracticeConfigTypography,
"configuration": PracticeConfigConfiguration,
"theme": "abc123"
}
PracticeConfigConfiguration
Fields
| Field Name | Description |
|---|---|
modules - PracticeConfigConfigurationModules
|
|
notification - PracticeConfigConfigurationNotification
|
|
mfa - PracticeConfigConfigurationMFA
|
|
defaultClientSharing - Int
|
|
lockClientDetails - Boolean
|
|
inAppNotifications - PracticeConfigConfigurationInAppNotification
|
|
filterSettings - PracticeConfigConfigurationFilterSettings
|
|
removeLogoWhiteBackground - PracticeConfigConfigurationRemoveLogoWhiteBackground
|
Example
{
"modules": PracticeConfigConfigurationModules,
"notification": PracticeConfigConfigurationNotification,
"mfa": PracticeConfigConfigurationMFA,
"defaultClientSharing": 123,
"lockClientDetails": false,
"inAppNotifications": PracticeConfigConfigurationInAppNotification,
"filterSettings": PracticeConfigConfigurationFilterSettings,
"removeLogoWhiteBackground": PracticeConfigConfigurationRemoveLogoWhiteBackground
}
PracticeConfigConfigurationFilterSettings
Fields
| Field Name | Description |
|---|---|
getHouseholdsFilterSettings - PracticeConfigConfigurationFilterSettingsGetHouseholds
|
Example
{
"getHouseholdsFilterSettings": PracticeConfigConfigurationFilterSettingsGetHouseholds
}
PracticeConfigConfigurationFilterSettingsGetHouseholds
Fields
| Field Name | Description |
|---|---|
showAllClients - Boolean
|
Example
{"showAllClients": false}
PracticeConfigConfigurationInAppNotification
Fields
| Field Name | Description |
|---|---|
enabled - String
|
Example
{"enabled": "abc123"}
PracticeConfigConfigurationMFA
Fields
| Field Name | Description |
|---|---|
enforceStaffMfa - Boolean
|
Example
{"enforceStaffMfa": false}
PracticeConfigConfigurationModuleBestLife
PracticeConfigConfigurationModuleBestLifePlan
PracticeConfigConfigurationModuleFoundations
PracticeConfigConfigurationModuleGoals
PracticeConfigConfigurationModuleGovernance
PracticeConfigConfigurationModuleHealthAssessment
PracticeConfigConfigurationModuleInvPrefs
Fields
| Field Name | Description |
|---|---|
name - String
|
|
shortName - String
|
|
introVideoUrl - String
|
|
introVideoS3Filename - String
|
|
customisationVideoUrl - String
|
|
customisationVideoS3Filename - String
|
|
ethicalVideoUrl - String
|
|
ethicalVideoS3Filename - String
|
|
assetClassVideoUrl - String
|
|
assetClassVideoS3Filename - String
|
|
allocationVideoUrl - String
|
|
allocationVideoS3Filename - String
|
|
riskVideoUrl - String
|
|
riskVideoS3Filename - String
|
|
costVideoUrl - String
|
|
costVideoS3Filename - String
|
|
createTaskOnCompletion - Boolean
|
Example
{
"name": "abc123",
"shortName": "xyz789",
"introVideoUrl": "xyz789",
"introVideoS3Filename": "abc123",
"customisationVideoUrl": "abc123",
"customisationVideoS3Filename": "xyz789",
"ethicalVideoUrl": "abc123",
"ethicalVideoS3Filename": "xyz789",
"assetClassVideoUrl": "xyz789",
"assetClassVideoS3Filename": "xyz789",
"allocationVideoUrl": "abc123",
"allocationVideoS3Filename": "abc123",
"riskVideoUrl": "abc123",
"riskVideoS3Filename": "xyz789",
"costVideoUrl": "xyz789",
"costVideoS3Filename": "abc123",
"createTaskOnCompletion": true
}
PracticeConfigConfigurationModuleLife
Example
{
"name": "xyz789",
"shortName": "abc123",
"introVideoUrl": "abc123",
"introVideoS3Filename": "abc123",
"connectionsOverride": "abc123",
"factFindOverride": "abc123",
"createTaskOnCompletion": false
}
PracticeConfigConfigurationModuleNetWorth
PracticeConfigConfigurationModuleStrategies
PracticeConfigConfigurationModuleSurveys
Fields
| Field Name | Description |
|---|---|
name - String
|
|
shortName - String
|
|
surveyTemplateLocationMap - PracticeConfigConfigurationModuleSurveysSurveyTemplateLocationMap
|
Example
{
"name": "xyz789",
"shortName": "abc123",
"surveyTemplateLocationMap": PracticeConfigConfigurationModuleSurveysSurveyTemplateLocationMap
}
PracticeConfigConfigurationModuleSurveysSurveyTemplateLocationMap
Example
{
"LIFE": "xyz789",
"VALUES_SURVEY": "xyz789",
"VALUES_SESSION": "xyz789",
"FHA": "abc123",
"FHA_LONG": "abc123",
"GOALS": "xyz789",
"IP": "abc123",
"GOV": "xyz789",
"FND": "abc123",
"FND_LONG": "abc123"
}
PracticeConfigConfigurationModuleTasks
PracticeConfigConfigurationModuleTermsOfEngagement
Fields
| Field Name | Description |
|---|---|
sections - [PracticeConfigConfigurationModuleTermsOfEngagementSections]
|
Example
{
"sections": [
PracticeConfigConfigurationModuleTermsOfEngagementSections
]
}
PracticeConfigConfigurationModuleTermsOfEngagementSections
Example
{
"location": "xyz789",
"title": "xyz789",
"titleReadOnly": true,
"titleVisibleInEditor": true,
"content": "abc123",
"contentReadOnly": false,
"contentVisibleInEditor": true
}
PracticeConfigConfigurationModuleValues
PracticeConfigConfigurationModuleVault
Fields
| Field Name | Description |
|---|---|
name - String
|
|
shortName - String
|
|
bestLifePlans - String
|
|
bestLifePlansEnabled - Boolean
|
|
retirementDocuments - String
|
|
retirementDocumentsEnabled - Boolean
|
|
legalDocuments - String
|
|
legalDocumentsEnabled - Boolean
|
|
identityDocuments - String
|
|
identityDocumentsEnabled - Boolean
|
|
estatePlanningDocuments - String
|
|
estatePlanningDocumentsEnabled - Boolean
|
|
adviceDocuments - String
|
|
adviceDocumentsEnabled - Boolean
|
|
taxReturns - String
|
|
taxReturnsEnabled - Boolean
|
|
businessStructures - String
|
|
businessStructuresEnabled - Boolean
|
|
insuranceDocuments - String
|
|
insuranceDocumentsEnabled - Boolean
|
|
educationDocuments - String
|
|
educationDocumentsEnabled - Boolean
|
|
otherDocuments - String
|
|
otherDocumentsEnabled - Boolean
|
|
actionRequired - String
|
|
actionRequiredEnabled - Boolean
|
|
folders - [VaultFolder]
|
Example
{
"name": "abc123",
"shortName": "xyz789",
"bestLifePlans": "xyz789",
"bestLifePlansEnabled": true,
"retirementDocuments": "abc123",
"retirementDocumentsEnabled": false,
"legalDocuments": "abc123",
"legalDocumentsEnabled": false,
"identityDocuments": "abc123",
"identityDocumentsEnabled": true,
"estatePlanningDocuments": "xyz789",
"estatePlanningDocumentsEnabled": false,
"adviceDocuments": "abc123",
"adviceDocumentsEnabled": true,
"taxReturns": "xyz789",
"taxReturnsEnabled": true,
"businessStructures": "abc123",
"businessStructuresEnabled": true,
"insuranceDocuments": "abc123",
"insuranceDocumentsEnabled": true,
"educationDocuments": "abc123",
"educationDocumentsEnabled": false,
"otherDocuments": "abc123",
"otherDocumentsEnabled": false,
"actionRequired": "abc123",
"actionRequiredEnabled": true,
"folders": [VaultFolder]
}
PracticeConfigConfigurationModuleWealth
PracticeConfigConfigurationModules
Fields
| Field Name | Description |
|---|---|
bestLife - PracticeConfigConfigurationModuleBestLife
|
|
bestLifePlan - PracticeConfigConfigurationModuleBestLifePlan
|
|
foundations - PracticeConfigConfigurationModuleFoundations
|
|
goals - PracticeConfigConfigurationModuleGoals
|
|
governance - PracticeConfigConfigurationModuleGovernance
|
|
healthAssessment - PracticeConfigConfigurationModuleHealthAssessment
|
|
invPrefs - PracticeConfigConfigurationModuleInvPrefs
|
|
life - PracticeConfigConfigurationModuleLife
|
|
strategies - PracticeConfigConfigurationModuleStrategies
|
|
surveys - PracticeConfigConfigurationModuleSurveys
|
|
tasks - PracticeConfigConfigurationModuleTasks
|
|
termsOfEngagement - PracticeConfigConfigurationModuleTermsOfEngagement
|
|
values - PracticeConfigConfigurationModuleValues
|
|
vault - PracticeConfigConfigurationModuleVault
|
|
wealth - PracticeConfigConfigurationModuleWealth
|
|
netWorth - PracticeConfigConfigurationModuleNetWorth
|
Example
{
"bestLife": PracticeConfigConfigurationModuleBestLife,
"bestLifePlan": PracticeConfigConfigurationModuleBestLifePlan,
"foundations": PracticeConfigConfigurationModuleFoundations,
"goals": PracticeConfigConfigurationModuleGoals,
"governance": PracticeConfigConfigurationModuleGovernance,
"healthAssessment": PracticeConfigConfigurationModuleHealthAssessment,
"invPrefs": PracticeConfigConfigurationModuleInvPrefs,
"life": PracticeConfigConfigurationModuleLife,
"strategies": PracticeConfigConfigurationModuleStrategies,
"surveys": PracticeConfigConfigurationModuleSurveys,
"tasks": PracticeConfigConfigurationModuleTasks,
"termsOfEngagement": PracticeConfigConfigurationModuleTermsOfEngagement,
"values": PracticeConfigConfigurationModuleValues,
"vault": PracticeConfigConfigurationModuleVault,
"wealth": PracticeConfigConfigurationModuleWealth,
"netWorth": PracticeConfigConfigurationModuleNetWorth
}
PracticeConfigConfigurationNotification
Example
{
"emailOverrideTo": "xyz789",
"emailSender": "xyz789",
"emailSenderName": "abc123",
"emailCC": "xyz789",
"emailSignature": "abc123",
"disableTaskEmailNotification": false
}
PracticeConfigConfigurationRemoveLogoWhiteBackground
Fields
| Field Name | Description |
|---|---|
enabled - Boolean
|
Example
{"enabled": true}
PracticeConfigPalette
Fields
| Field Name | Description |
|---|---|
primary - PracticeConfigPaletteBGFGColors
|
|
secondary - PracticeConfigPaletteBGFGColors
|
|
buttons - PracticeConfigPaletteButtons
|
|
backgrounds - PracticeConfigPaletteBackgrounds
|
Example
{
"primary": PracticeConfigPaletteBGFGColors,
"secondary": PracticeConfigPaletteBGFGColors,
"buttons": PracticeConfigPaletteButtons,
"backgrounds": PracticeConfigPaletteBackgrounds
}
PracticeConfigPaletteBGFGColors
PracticeConfigPaletteBackgrounds
Fields
| Field Name | Description |
|---|---|
main - PracticeConfigPaletteBGFGColors
|
|
workbench - PracticeConfigPaletteBGFGColors
|
Example
{
"main": PracticeConfigPaletteBGFGColors,
"workbench": PracticeConfigPaletteBGFGColors
}
PracticeConfigPaletteButtons
Fields
| Field Name | Description |
|---|---|
primary - PracticeConfigPaletteBGFGColors
|
|
secondary - PracticeConfigPaletteBGFGColors
|
Example
{
"primary": PracticeConfigPaletteBGFGColors,
"secondary": PracticeConfigPaletteBGFGColors
}
PracticeConfigTypography
PracticeConfigVaultFolders
Fields
| Field Name | Description |
|---|---|
practiceId - Int
|
|
folders - [VaultFolder]
|
Example
{"practiceId": 123, "folders": [VaultFolder]}
PracticeIntegration
Fields
| Field Name | Description |
|---|---|
practiceIntegrationId - Int!
|
|
name - String!
|
|
description - String
|
|
enabled - Boolean!
|
|
createdBy - String!
|
|
created - String!
|
|
updatedBy - String!
|
|
updated - String!
|
|
lastSynced - String
|
|
integrationType - String!
|
|
integrationMeta1 - String
|
|
integrationMeta2 - String
|
|
integrationMeta3 - String
|
|
integrationMeta4 - String
|
|
integrationMeta5 - String
|
|
integrationMeta6 - String
|
|
integrationMeta7 - String
|
|
integrationMeta8 - String
|
Example
{
"practiceIntegrationId": 123,
"name": "abc123",
"description": "abc123",
"enabled": false,
"createdBy": "abc123",
"created": "xyz789",
"updatedBy": "xyz789",
"updated": "abc123",
"lastSynced": "xyz789",
"integrationType": "abc123",
"integrationMeta1": "abc123",
"integrationMeta2": "abc123",
"integrationMeta3": "abc123",
"integrationMeta4": "abc123",
"integrationMeta5": "xyz789",
"integrationMeta6": "abc123",
"integrationMeta7": "abc123",
"integrationMeta8": "abc123"
}
PracticeKeyAdviceArea
Example
{
"practiceKeyAdviceAreaId": 987,
"categoryName": "abc123",
"description": "abc123",
"rank": 123,
"muiIconName": "xyz789",
"createdBy": "abc123",
"created": "abc123",
"updatedBy": "abc123",
"updated": "xyz789",
"strategies": [PracticeStrategy]
}
PracticeListAllStaffsData
Fields
| Field Name | Description |
|---|---|
staffId - String!
|
|
firstName - String!
|
|
lastName - String!
|
|
email - String!
|
|
mobileNumber - String!
|
|
role - String!
|
|
isActive - Boolean
|
|
externalId - String
|
|
externalSystem - String
|
|
contactDetailsId - String!
|
|
practiceOfficeId - String!
|
|
practiceOfficeName - String!
|
|
practiceId - String!
|
|
practiceName - String!
|
|
lastLogin - String
|
|
created - String!
|
|
createdBy - String!
|
|
updated - String!
|
|
updatedBy - String!
|
Example
{
"staffId": "xyz789",
"firstName": "abc123",
"lastName": "abc123",
"email": "abc123",
"mobileNumber": "xyz789",
"role": "xyz789",
"isActive": false,
"externalId": "abc123",
"externalSystem": "xyz789",
"contactDetailsId": "abc123",
"practiceOfficeId": "xyz789",
"practiceOfficeName": "xyz789",
"practiceId": "xyz789",
"practiceName": "abc123",
"lastLogin": "xyz789",
"created": "xyz789",
"createdBy": "abc123",
"updated": "xyz789",
"updatedBy": "xyz789"
}
PracticeListAllStaffsInput
Fields
| Input Field | Description |
|---|---|
practiceId - Int
|
Example
{"practiceId": 987}
PracticeListAllStaffsOutput
Fields
| Field Name | Description |
|---|---|
searchResult - [PracticeListAllStaffsData]
|
Example
{"searchResult": [PracticeListAllStaffsData]}
PracticeLogo
Example
{
"id": 4,
"practiceLogoId": 987,
"practiceId": 123,
"type": "abc123",
"logo": "xyz789",
"createdBy": "abc123",
"created": "xyz789",
"updatedBy": "xyz789",
"updated": "xyz789"
}
PracticeOffice
Example
{
"practiceOfficeId": 987,
"contactDetails": ContactDetails,
"address": Address,
"name": "xyz789",
"createdBy": "abc123",
"created": "xyz789",
"updatedBy": "xyz789",
"updated": "abc123"
}
PracticePackage
Fields
| Field Name | Description |
|---|---|
code - String
|
|
name - String
|
|
description - String
|
|
usesHouseholdPackages - Boolean
|
|
components - [Component]
|
|
householdPackages - [HouseholdPackage]
|
Example
{
"code": "abc123",
"name": "xyz789",
"description": "abc123",
"usesHouseholdPackages": true,
"components": [Component],
"householdPackages": [HouseholdPackage]
}
PracticeRiskProfile
Example
{
"practiceRiskProfileId": 987,
"riskGroup": 123,
"name": "abc123",
"description": "xyz789",
"enabled": false,
"createdBy": "abc123",
"created": "abc123",
"updatedBy": "xyz789",
"updated": "abc123"
}
PracticeSegmentation
Example
{
"practiceSegmentationId": 123,
"segmentName": "abc123",
"description": "abc123",
"rank": 123,
"configuration": "abc123",
"householdCount": 123,
"createdBy": "xyz789",
"created": "xyz789",
"updatedBy": "xyz789",
"updated": "xyz789"
}
PracticeStrategy
Example
{
"practiceStrategyId": 123,
"practiceKeyAdviceAreaId": 987,
"strategyName": "abc123",
"details": "abc123",
"createdBy": "xyz789",
"created": "abc123",
"updatedBy": "xyz789",
"updated": "abc123"
}
PractifiCallbackInputs
PractifiGetCallbackInputsRequest
Fields
| Input Field | Description |
|---|---|
practiceId - Int
|
Example
{"practiceId": 987}
PractifiIsCallbackVerifiedRequest
PredictionsActions
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"identifyText"
PresignedUrlFilesListItem
ProfessionalContactOutput
Fields
| Field Name | Description |
|---|---|
professionalContactId - Int!
|
|
householdId - Int
|
|
contactType - String
|
|
contactTypeDetails - String
|
|
name - String
|
|
company - String
|
|
phoneNumber - String
|
|
emailAddress - String
|
|
address - String
|
|
authorityToContact - Boolean
|
|
relationshipQuality - String
|
|
notes - String
|
|
clientNotes - String
|
|
partnerNotes - String
|
|
confidentialNotes - String
|
|
createdBy - String!
|
|
created - String!
|
|
updatedBy - String!
|
|
updated - String!
|
Example
{
"professionalContactId": 123,
"householdId": 987,
"contactType": "xyz789",
"contactTypeDetails": "abc123",
"name": "abc123",
"company": "abc123",
"phoneNumber": "xyz789",
"emailAddress": "xyz789",
"address": "xyz789",
"authorityToContact": false,
"relationshipQuality": "xyz789",
"notes": "abc123",
"clientNotes": "xyz789",
"partnerNotes": "xyz789",
"confidentialNotes": "xyz789",
"createdBy": "xyz789",
"created": "xyz789",
"updatedBy": "xyz789",
"updated": "abc123"
}
RedtailLoadErrors
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
errorMessage - String
|
|
redtailPayload - String
|
|
createdAt - AWSDateTime!
|
|
updatedAt - AWSDateTime!
|
Example
{
"id": 4,
"errorMessage": "abc123",
"redtailPayload": "xyz789",
"createdAt": AWSDateTime,
"updatedAt": AWSDateTime
}
Region
RegisterClientInput
RegisterClientOutput
Fields
| Field Name | Description |
|---|---|
clientIamId - String
|
Example
{"clientIamId": "xyz789"}
RegisterStaffInput
Example
{
"practiceOfficeId": 987,
"practiceId": 987,
"title": "xyz789",
"firstName": "abc123",
"middleName": "abc123",
"lastName": "xyz789",
"emailAddress": "xyz789",
"mobileNumber": "xyz789",
"country": "xyz789",
"externalId": "xyz789",
"externalSystem": "abc123"
}
RegisterStaffOutput
Fields
| Field Name | Description |
|---|---|
staffId - Int!
|
Example
{"staffId": 987}
Registration
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
clientId - Int!
|
|
inviteCode - String!
|
|
fullName - String
|
|
createdAt - AWSDateTime!
|
|
updatedAt - AWSDateTime!
|
Example
{
"id": 4,
"clientId": 987,
"inviteCode": "abc123",
"fullName": "abc123",
"createdAt": AWSDateTime,
"updatedAt": AWSDateTime
}
RemoveAccessFromHouseholdInput
RemoveYodleeAccountInput
RemoveYodleeProviderInput
RenameVaultFileInput
RenameVaultFolderInput
ReportingInput
Fields
| Input Field | Description |
|---|---|
noEmail - Boolean
|
Example
{"noEmail": false}
RequestAffordabilityReportInput
Fields
| Input Field | Description |
|---|---|
clientId - Int
|
Example
{"clientId": 987}
ResetSurveysSessionInput
ResetSurveysSessionOutput
ResetTempPasswordInput
Fields
| Input Field | Description |
|---|---|
staffId - Int!
|
Example
{"staffId": 987}
ResetUserPasswordInput
Fields
| Input Field | Description |
|---|---|
currentEmail - String!
|
Example
{"currentEmail": "abc123"}
RetirementDetailsOutput
Example
{
"retirementDetailsId": 123,
"clientId": 987,
"retirementAge": 123,
"requiredIncome": 123.45,
"retirementLifestyle": "xyz789",
"notes": "xyz789",
"confidentialNotes": "abc123",
"createdBy": "abc123",
"created": "abc123",
"updatedBy": "abc123",
"updated": "xyz789"
}
RiskProfileOutput
Fields
| Field Name | Description |
|---|---|
riskProfileId - Int
|
|
householdId - Int
|
|
clientId - Int
|
|
legalEntityId - Int
|
|
riskProfileAssessed - Int
|
|
riskProfileDirected - Int
|
|
riskProfileDirectedBy - String
|
|
notes - String
|
|
clientNotes - String
|
|
partnerNotes - String
|
|
confidentialNotes - String
|
|
createdBy - String!
|
|
created - String!
|
|
updatedBy - String!
|
|
updated - String!
|
Example
{
"riskProfileId": 987,
"householdId": 987,
"clientId": 123,
"legalEntityId": 987,
"riskProfileAssessed": 987,
"riskProfileDirected": 987,
"riskProfileDirectedBy": "xyz789",
"notes": "xyz789",
"clientNotes": "xyz789",
"partnerNotes": "xyz789",
"confidentialNotes": "abc123",
"createdBy": "xyz789",
"created": "xyz789",
"updatedBy": "abc123",
"updated": "xyz789"
}
RiskalyzeCallbackInputs
RiskalyzeClientPortfolio
RiskalyzeDeleteClientLinkRequest
Fields
| Input Field | Description |
|---|---|
clientId - Int
|
Example
{"clientId": 987}
RiskalyzeDeletePortfolioLinkRequest
Fields
| Input Field | Description |
|---|---|
portfolioId - Int
|
Example
{"portfolioId": 987}
RiskalyzeGetCallbackInputsRequest
Fields
| Input Field | Description |
|---|---|
practiceId - Int
|
Example
{"practiceId": 123}
RiskalyzeGetPortfoliosForClientRequest
RiskalyzeGetRiskalyzeIdForClientRequest
Fields
| Input Field | Description |
|---|---|
clientId - Int
|
Example
{"clientId": 123}
RiskalyzeGetRiskalyzePortfolioIdRequest
Fields
| Input Field | Description |
|---|---|
portfolioId - Int
|
Example
{"portfolioId": 123}
RiskalyzeIsCallbackVerifiedRequest
RiskalyzeIsClientLinkedRequest
Fields
| Input Field | Description |
|---|---|
clientId - Int
|
Example
{"clientId": 987}
RiskalyzeIsPortfolioLinkedRequest
Fields
| Input Field | Description |
|---|---|
portfolioId - Int
|
Example
{"portfolioId": 987}
RiskalyzeSaveClientLinkRequest
RiskalyzeSavePortfolioLinkRequest
RiskalyzeSavePortfolioLinkResponse
RiskalyzeSearchClientsRequest
Fields
| Input Field | Description |
|---|---|
searchString - String
|
Example
{"searchString": "abc123"}
RiskalyzeSearchedClient
RunBestLifeScenarioInput
Fields
| Input Field | Description |
|---|---|
practiceId - Int
|
|
householdId - Int
|
|
scenarioId - String!
|
|
order - Int!
|
|
name - String!
|
|
householdCountryCode - String!
|
|
clientEditable - Boolean
|
|
clients - [BestLifeScenarioClientInput]
|
|
entities - [BestLifeScenarioEntityInput]
|
|
lifestyleTradeOffs - [BestLifeScenarioLifestyleTradeOffInput]
|
|
goals - [BestLifeScenarioGoalInput]
|
|
assets - [BestLifeScenarioAssetInput]
|
|
liabilities - [BestLifeScenarioLiabilityInput]
|
|
incomes - [BestLifeScenarioIncomeInput]
|
|
expenses - [BestLifeScenarioExpenseInput]
|
|
reqRetirementIncomePA - Float
|
|
reqRetirementIncomePARateChange - Float
|
|
savingsPA - Float
|
|
excessCashAllocations - [BestLifeScenarioAllocationInput]
|
|
reduceShortfallAllocations - [BestLifeScenarioAllocationInput]
|
Example
{
"practiceId": 987,
"householdId": 123,
"scenarioId": "abc123",
"order": 123,
"name": "xyz789",
"householdCountryCode": "abc123",
"clientEditable": false,
"clients": [BestLifeScenarioClientInput],
"entities": [BestLifeScenarioEntityInput],
"lifestyleTradeOffs": [
BestLifeScenarioLifestyleTradeOffInput
],
"goals": [BestLifeScenarioGoalInput],
"assets": [BestLifeScenarioAssetInput],
"liabilities": [BestLifeScenarioLiabilityInput],
"incomes": [BestLifeScenarioIncomeInput],
"expenses": [BestLifeScenarioExpenseInput],
"reqRetirementIncomePA": 987.65,
"reqRetirementIncomePARateChange": 123.45,
"savingsPA": 123.45,
"excessCashAllocations": [
BestLifeScenarioAllocationInput
],
"reduceShortfallAllocations": [
BestLifeScenarioAllocationInput
]
}
RunBestLifeScenarioOutput
Fields
| Field Name | Description |
|---|---|
scenarioId - String
|
Example
{"scenarioId": "abc123"}
SaveAssetInput
Fields
| Input Field | Description |
|---|---|
inviteClientId - Int
|
|
inviteCode - String
|
|
practiceId - Int
|
|
assetId - Int
|
|
householdId - Int
|
|
clientId - Int
|
|
legalEntityId - Int
|
|
beneficiaryClientId - Int
|
|
beneficiaryLegalEntityId - Int
|
|
otherBeneficiary - String
|
|
relationshipAsset - String
|
|
assetType - String!
|
|
superType - String
|
|
pensionType - String
|
|
description - String
|
|
accountNumber - String
|
|
providerName - String
|
|
memberNumber - String
|
|
balance - Float
|
|
definedBenefitSalary - Float
|
|
definedBenefitMultiple - Float
|
|
employeeContribution - Float
|
|
employeeContributionBps - Float
|
|
employeeContributionType - String
|
|
employeeContributionCap - Float
|
|
employeeContributionCapBps - Float
|
|
employerContribution - Float
|
|
employerContributionBps - Float
|
|
employerContributionCap - Float
|
|
employerContributionCapBps - Float
|
|
makesPersonalContribution - Boolean
|
|
annualContribution - Float
|
|
inheritedIraType - String
|
|
deceasedOwnerDateOfBirth - String
|
|
deceasedOwnerDateOfDeath - String
|
|
rmdTakenThisYear - Boolean
|
|
previousYearBalance - Float
|
|
annuityTermDate - String
|
|
deathBenefit - Float
|
|
surrenderValue - Float
|
|
centrelinkValue - Float
|
|
isUsedLoanSecurity - Boolean
|
|
loanSecuredAmount - Float
|
|
madePersonalContribPast3y - Boolean
|
|
taxFreeComponent - Float
|
|
preservationComponent - Float
|
|
makesPersonalSuperContribution - Boolean
|
|
isSalarySacrifice - Boolean
|
|
superContributionAmount - Float
|
|
superContributionFrequency - String
|
|
employerPaysHigherThanMinimumSuper - Boolean
|
|
higherThanMinimumSuperBps - Float
|
|
preRetirementRefModel - Int
|
|
postRetirementRefModel - Int
|
|
feesBps - Float
|
|
feesDollar - Float
|
|
addressId - Int
|
|
ownOrRent - String
|
|
isPrimaryHome - Boolean
|
|
purchasePrice - Float
|
|
purchaseDate - String
|
|
growthBps - Float
|
|
currentValue - Float
|
|
propertyType - String
|
|
rent - Float
|
|
savingInvestmentType - String
|
|
assetUse - String
|
|
assessed - Boolean
|
|
make - String
|
|
model - String
|
|
lastValued - String
|
|
superPhase - String
|
|
annuityType - String
|
|
term - Int
|
|
maturityDate - String
|
|
commutedAmount - Float
|
|
residualValue - Float
|
|
assetExemptionBps - Float
|
|
notes - String
|
|
clientNotes - String
|
|
partnerNotes - String
|
|
confidentialNotes - String
|
|
displayName - String
|
|
displayOwnership - Int
|
|
constructedAddress - String
|
|
addressLine1 - String
|
|
addressLine2 - String
|
|
suburb - String
|
|
postCode - String
|
|
state - String
|
|
country - String
|
|
linkedLoan - Int
|
Example
{
"inviteClientId": 987,
"inviteCode": "abc123",
"practiceId": 987,
"assetId": 123,
"householdId": 123,
"clientId": 123,
"legalEntityId": 987,
"beneficiaryClientId": 987,
"beneficiaryLegalEntityId": 987,
"otherBeneficiary": "abc123",
"relationshipAsset": "xyz789",
"assetType": "xyz789",
"superType": "abc123",
"pensionType": "abc123",
"description": "abc123",
"accountNumber": "abc123",
"providerName": "abc123",
"memberNumber": "xyz789",
"balance": 987.65,
"definedBenefitSalary": 987.65,
"definedBenefitMultiple": 987.65,
"employeeContribution": 987.65,
"employeeContributionBps": 987.65,
"employeeContributionType": "abc123",
"employeeContributionCap": 987.65,
"employeeContributionCapBps": 987.65,
"employerContribution": 123.45,
"employerContributionBps": 123.45,
"employerContributionCap": 123.45,
"employerContributionCapBps": 123.45,
"makesPersonalContribution": true,
"annualContribution": 123.45,
"inheritedIraType": "xyz789",
"deceasedOwnerDateOfBirth": "abc123",
"deceasedOwnerDateOfDeath": "abc123",
"rmdTakenThisYear": false,
"previousYearBalance": 123.45,
"annuityTermDate": "xyz789",
"deathBenefit": 987.65,
"surrenderValue": 123.45,
"centrelinkValue": 987.65,
"isUsedLoanSecurity": true,
"loanSecuredAmount": 123.45,
"madePersonalContribPast3y": false,
"taxFreeComponent": 987.65,
"preservationComponent": 987.65,
"makesPersonalSuperContribution": true,
"isSalarySacrifice": false,
"superContributionAmount": 123.45,
"superContributionFrequency": "abc123",
"employerPaysHigherThanMinimumSuper": false,
"higherThanMinimumSuperBps": 987.65,
"preRetirementRefModel": 123,
"postRetirementRefModel": 123,
"feesBps": 123.45,
"feesDollar": 987.65,
"addressId": 987,
"ownOrRent": "xyz789",
"isPrimaryHome": false,
"purchasePrice": 123.45,
"purchaseDate": "abc123",
"growthBps": 123.45,
"currentValue": 987.65,
"propertyType": "abc123",
"rent": 123.45,
"savingInvestmentType": "xyz789",
"assetUse": "xyz789",
"assessed": true,
"make": "abc123",
"model": "xyz789",
"lastValued": "abc123",
"superPhase": "xyz789",
"annuityType": "xyz789",
"term": 987,
"maturityDate": "abc123",
"commutedAmount": 987.65,
"residualValue": 987.65,
"assetExemptionBps": 123.45,
"notes": "abc123",
"clientNotes": "abc123",
"partnerNotes": "xyz789",
"confidentialNotes": "xyz789",
"displayName": "xyz789",
"displayOwnership": 123,
"constructedAddress": "abc123",
"addressLine1": "xyz789",
"addressLine2": "abc123",
"suburb": "abc123",
"postCode": "xyz789",
"state": "xyz789",
"country": "xyz789",
"linkedLoan": 987
}
SaveBeneficiaryInput
Fields
| Input Field | Description |
|---|---|
inviteClientId - Int
|
|
inviteCode - String
|
|
practiceId - Int
|
|
beneficiaryId - Int
|
|
estatePlanningId - Int!
|
|
isPrimary - Boolean
|
|
firstName - String
|
|
middleName - String
|
|
lastName - String
|
|
companyName - String
|
|
relationshipType - String
|
|
nominatedPercentage - Float
|
|
ageEntitlement - Int
|
|
notes - String
|
|
clientNotes - String
|
|
partnerNotes - String
|
|
confidentialNotes - String
|
Example
{
"inviteClientId": 987,
"inviteCode": "abc123",
"practiceId": 123,
"beneficiaryId": 987,
"estatePlanningId": 123,
"isPrimary": false,
"firstName": "xyz789",
"middleName": "abc123",
"lastName": "abc123",
"companyName": "xyz789",
"relationshipType": "abc123",
"nominatedPercentage": 987.65,
"ageEntitlement": 987,
"notes": "xyz789",
"clientNotes": "abc123",
"partnerNotes": "xyz789",
"confidentialNotes": "xyz789"
}
SaveBusinessPlanningInput
Example
{
"inviteClientId": 987,
"inviteCode": "abc123",
"practiceId": 987,
"businessPlanningId": 123,
"householdId": 987,
"clientId": 123,
"legalEntityId": 987,
"hasBusinessDocuments": false
}
SaveCharitablePlanningInput
Example
{
"inviteClientId": 123,
"inviteCode": "abc123",
"practiceId": 123,
"charitablePlanningId": 123,
"householdId": 123,
"clientId": 987,
"legalEntityId": 987,
"hasCharitableFoundation": true
}
SaveClientConfig
Fields
| Input Field | Description |
|---|---|
practiceId - Int
|
|
clientId - Int
|
|
configuration - SaveClientConfigConfiguration
|
Example
{
"practiceId": 123,
"clientId": 123,
"configuration": SaveClientConfigConfiguration
}
SaveClientConfigConfiguration
Fields
| Input Field | Description |
|---|---|
inAppNotifications - SaveClientConfigConfigurationInAppNotification
|
|
governanceConfig - SaveClientConfigConfigurationGovernanceConfig
|
Example
{
"inAppNotifications": SaveClientConfigConfigurationInAppNotification,
"governanceConfig": SaveClientConfigConfigurationGovernanceConfig
}
SaveClientConfigConfigurationGovernanceConfig
Fields
| Input Field | Description |
|---|---|
hideEmptySections - Boolean
|
Example
{"hideEmptySections": true}
SaveClientConfigConfigurationInAppNotification
Fields
| Input Field | Description |
|---|---|
enabled - Boolean
|
Example
{"enabled": false}
SaveClientInput
Fields
| Input Field | Description |
|---|---|
practiceId - Int
|
|
clientId - Int
|
|
householdId - Int
|
|
type - String
|
|
title - String
|
|
firstName - String
|
|
middleName - String
|
|
lastName - String
|
|
preferredName - String
|
|
dob - String
|
|
sex - String
|
|
relationshipStatus - String
|
|
countryCodeBirth - String
|
|
countryCodeResidency - String
|
|
countryCodeCitizenship - String
|
|
clientCategory - String
|
|
staffEmailAddress - String
|
|
constructedAddress - String
|
|
addressLine1 - String
|
|
addressLine2 - String
|
|
suburb - String
|
|
postCode - String
|
|
state - String
|
|
country - String
|
|
postalConstructedAddress - String
|
|
postalAddressLine1 - String
|
|
postalAddressLine2 - String
|
|
postalSuburb - String
|
|
postalPostCode - String
|
|
postalState - String
|
|
postalCountry - String
|
|
emailAddress - String
|
|
mobileNumber - String
|
|
faxNumber - String
|
|
phoneNumber - String
|
|
externalId - String
|
|
externalSystem - String
|
|
addressExternalId - String
|
|
addressExternalSystem - String
|
|
postalAddressExternalId - String
|
|
postalAddressExternalSystem - String
|
|
contactDetailsExternalId - String
|
|
contactDetailsExternalSystem - String
|
Example
{
"practiceId": 987,
"clientId": 123,
"householdId": 123,
"type": "xyz789",
"title": "xyz789",
"firstName": "xyz789",
"middleName": "xyz789",
"lastName": "abc123",
"preferredName": "xyz789",
"dob": "abc123",
"sex": "abc123",
"relationshipStatus": "abc123",
"countryCodeBirth": "abc123",
"countryCodeResidency": "abc123",
"countryCodeCitizenship": "abc123",
"clientCategory": "xyz789",
"staffEmailAddress": "xyz789",
"constructedAddress": "xyz789",
"addressLine1": "xyz789",
"addressLine2": "abc123",
"suburb": "abc123",
"postCode": "xyz789",
"state": "abc123",
"country": "xyz789",
"postalConstructedAddress": "abc123",
"postalAddressLine1": "abc123",
"postalAddressLine2": "xyz789",
"postalSuburb": "abc123",
"postalPostCode": "abc123",
"postalState": "xyz789",
"postalCountry": "xyz789",
"emailAddress": "xyz789",
"mobileNumber": "abc123",
"faxNumber": "xyz789",
"phoneNumber": "xyz789",
"externalId": "abc123",
"externalSystem": "abc123",
"addressExternalId": "abc123",
"addressExternalSystem": "xyz789",
"postalAddressExternalId": "xyz789",
"postalAddressExternalSystem": "abc123",
"contactDetailsExternalId": "xyz789",
"contactDetailsExternalSystem": "abc123"
}
SaveClientOutput
SaveClientWealthIdInput
SaveClientWealthIdsInput
SaveDealerGroupInput
SaveDealerGroupOutput
Fields
| Field Name | Description |
|---|---|
dealerGroupId - Int
|
Example
{"dealerGroupId": 987}
SaveDirectorInput
Example
{
"inviteClientId": 987,
"inviteCode": "xyz789",
"practiceId": 987,
"directorId": 123,
"legalEntityId": 123,
"firstName": "xyz789",
"middleName": "xyz789",
"lastName": "abc123",
"dateAppointed": "xyz789",
"notes": "xyz789",
"clientNotes": "abc123",
"partnerNotes": "xyz789",
"confidentialNotes": "abc123"
}
SaveEducationPlanningInput
Example
{
"inviteClientId": 123,
"inviteCode": "xyz789",
"practiceId": 123,
"educationPlanningId": 987,
"householdId": 987,
"clientId": 123,
"legalEntityId": 987,
"hasEducationSavings": false
}
SaveEmploymentDetailsInput
Fields
| Input Field | Description |
|---|---|
inviteClientId - Int
|
|
inviteCode - String
|
|
practiceId - Int
|
|
employmentDetailsId - Int
|
|
clientId - Int
|
|
degreeQualified - Boolean
|
|
qualifications - String
|
|
recentRetrenched - Boolean
|
|
employmentStatus - String
|
|
plannedChanges - Boolean
|
|
plannedChangesDescription - String
|
|
businessStructure - String
|
|
employedByOwnCompany - Boolean
|
|
occupation - String
|
|
startDate - String
|
|
employer - String
|
|
secondaryOccupation - String
|
|
secondaryOccupationStartDate - String
|
|
secondaryOccupationEmployer - String
|
|
employmentHoursPerWeek - Float
|
|
unusedAnnualLeave - Float
|
|
unusedSickLeave - Float
|
|
unusedLongServiceLeave - Float
|
|
workedOverseas - Boolean
|
|
workedOverseasDetails - String
|
|
salarySacrificeAvailable - Boolean
|
|
notes - String
|
|
confidentialNotes - String
|
Example
{
"inviteClientId": 987,
"inviteCode": "xyz789",
"practiceId": 987,
"employmentDetailsId": 987,
"clientId": 123,
"degreeQualified": true,
"qualifications": "xyz789",
"recentRetrenched": true,
"employmentStatus": "abc123",
"plannedChanges": false,
"plannedChangesDescription": "xyz789",
"businessStructure": "abc123",
"employedByOwnCompany": true,
"occupation": "abc123",
"startDate": "abc123",
"employer": "xyz789",
"secondaryOccupation": "abc123",
"secondaryOccupationStartDate": "abc123",
"secondaryOccupationEmployer": "xyz789",
"employmentHoursPerWeek": 123.45,
"unusedAnnualLeave": 987.65,
"unusedSickLeave": 123.45,
"unusedLongServiceLeave": 123.45,
"workedOverseas": true,
"workedOverseasDetails": "abc123",
"salarySacrificeAvailable": false,
"notes": "xyz789",
"confidentialNotes": "abc123"
}
SaveEnabledHouseholdKeyAdviceAreaInput
SaveEstatePlanningInput
Fields
| Input Field | Description |
|---|---|
inviteClientId - Int
|
|
inviteCode - String
|
|
practiceId - Int
|
|
estatePlanningId - Int
|
|
householdId - Int
|
|
clientId - Int
|
|
solicitorName - String
|
|
willInPlace - Boolean
|
|
isWillCurrent - Boolean
|
|
willDate - String
|
|
willLocation - String
|
|
willProvisions - String
|
|
healthcareDirective - Boolean
|
|
healthcareDirectiveDetails - String
|
|
funeralArrangement - String
|
|
funeralDetails - String
|
|
prepaidFuneral - Boolean
|
|
funeralExpenseValue - Float
|
|
purchaseDate - String
|
|
accountNumber - String
|
|
productProvider - String
|
|
superBeneficiariesNominated - Boolean
|
|
beneficiariesNominated - Boolean
|
|
poaGranted - Boolean
|
|
pogGranted - Boolean
|
|
apoaGranted - Boolean
|
|
letterOfWishes - Boolean
|
|
notes - String
|
|
clientNotes - String
|
|
partnerNotes - String
|
|
confidentialNotes - String
|
Example
{
"inviteClientId": 987,
"inviteCode": "xyz789",
"practiceId": 123,
"estatePlanningId": 123,
"householdId": 987,
"clientId": 987,
"solicitorName": "abc123",
"willInPlace": false,
"isWillCurrent": false,
"willDate": "xyz789",
"willLocation": "abc123",
"willProvisions": "xyz789",
"healthcareDirective": true,
"healthcareDirectiveDetails": "xyz789",
"funeralArrangement": "xyz789",
"funeralDetails": "abc123",
"prepaidFuneral": false,
"funeralExpenseValue": 987.65,
"purchaseDate": "xyz789",
"accountNumber": "abc123",
"productProvider": "abc123",
"superBeneficiariesNominated": false,
"beneficiariesNominated": true,
"poaGranted": true,
"pogGranted": true,
"apoaGranted": true,
"letterOfWishes": false,
"notes": "abc123",
"clientNotes": "abc123",
"partnerNotes": "xyz789",
"confidentialNotes": "abc123"
}
SaveExecutorInput
Example
{
"inviteClientId": 123,
"inviteCode": "xyz789",
"practiceId": 987,
"executorId": 987,
"estatePlanningId": 987,
"firstName": "xyz789",
"middleName": "xyz789",
"lastName": "abc123",
"notes": "xyz789",
"clientNotes": "abc123",
"partnerNotes": "abc123",
"confidentialNotes": "abc123"
}
SaveExpenseInput
Fields
| Input Field | Description |
|---|---|
inviteClientId - Int
|
|
inviteCode - String
|
|
practiceId - Int
|
|
expenseId - Int
|
|
householdId - Int
|
|
clientId - Int
|
|
legalEntityId - Int
|
|
assetId - Int
|
|
expenseType - String!
|
|
expenseSubType - String
|
|
savingsPlanType - String
|
|
description - String
|
|
amount - Float
|
|
amountBps - Float
|
|
discretionaryAmount - Float
|
|
frequency - String
|
|
endYear - Int
|
|
stopAllowance - String
|
|
stopAllowanceAge - Int
|
|
feeIncreaseBps - Float
|
|
changesExpected - Boolean
|
|
timeFrame - String
|
|
notes - String
|
|
clientNotes - String
|
|
partnerNotes - String
|
|
confidentialNotes - String
|
Example
{
"inviteClientId": 987,
"inviteCode": "xyz789",
"practiceId": 123,
"expenseId": 987,
"householdId": 987,
"clientId": 123,
"legalEntityId": 123,
"assetId": 123,
"expenseType": "xyz789",
"expenseSubType": "xyz789",
"savingsPlanType": "abc123",
"description": "abc123",
"amount": 123.45,
"amountBps": 123.45,
"discretionaryAmount": 123.45,
"frequency": "abc123",
"endYear": 987,
"stopAllowance": "xyz789",
"stopAllowanceAge": 987,
"feeIncreaseBps": 987.65,
"changesExpected": false,
"timeFrame": "xyz789",
"notes": "abc123",
"clientNotes": "abc123",
"partnerNotes": "abc123",
"confidentialNotes": "abc123"
}
SaveFoundationSurveyInput
Fields
| Input Field | Description |
|---|---|
inviteClientId - Int
|
|
inviteCode - String
|
|
practiceId - Int
|
|
householdId - Int
|
|
incomeHousehold - Float
|
|
householdMonthlySpend - Float
|
|
totalAssets - Float
|
|
totalLiabilities - Float
|
|
dobClient - String
|
|
stateOfResidencyClient - String
|
|
employmentStatusClient - String
|
|
incomeClient - Float
|
|
retirementAgeClient - Int
|
|
retirementIncomeClient - Float
|
|
retirementLifestyleClient - String
|
|
dobPartner - String
|
|
stateOfResidencyPartner - String
|
|
employmentStatusPartner - String
|
|
incomePartner - Float
|
|
retirementAgePartner - Int
|
|
retirementIncomePartner - Float
|
|
retirementLifestylePartner - String
|
Example
{
"inviteClientId": 123,
"inviteCode": "xyz789",
"practiceId": 987,
"householdId": 123,
"incomeHousehold": 123.45,
"householdMonthlySpend": 123.45,
"totalAssets": 123.45,
"totalLiabilities": 987.65,
"dobClient": "abc123",
"stateOfResidencyClient": "abc123",
"employmentStatusClient": "abc123",
"incomeClient": 123.45,
"retirementAgeClient": 987,
"retirementIncomeClient": 987.65,
"retirementLifestyleClient": "xyz789",
"dobPartner": "abc123",
"stateOfResidencyPartner": "xyz789",
"employmentStatusPartner": "abc123",
"incomePartner": 987.65,
"retirementAgePartner": 987,
"retirementIncomePartner": 123.45,
"retirementLifestylePartner": "abc123"
}
SaveGoalsSurveyInput
SaveHealthDetailsInput
Fields
| Input Field | Description |
|---|---|
inviteClientId - Int
|
|
inviteCode - String
|
|
practiceId - Int
|
|
healthDetailsId - Int
|
|
clientId - Int
|
|
healthStatus - String
|
|
medicalHistoryIssues - String
|
|
isSmoker - Boolean
|
|
smokePerDay - Int
|
|
useNicotine - Boolean
|
|
nicotinePerDay - Int
|
|
useMedication - Boolean
|
|
medicationDetails - String
|
|
medicalCondition - Boolean
|
|
medicalConditionDetails - String
|
|
majorIllness - Boolean
|
|
majorIllnessDetails - String
|
|
privateHealth - Boolean
|
|
privateHealthDetails - String
|
|
sportsInterestsList - String
|
|
sportsInterests - String
|
|
sportsInterestsFrequency - String
|
|
notes - String
|
|
confidentialNotes - String
|
Example
{
"inviteClientId": 987,
"inviteCode": "abc123",
"practiceId": 123,
"healthDetailsId": 987,
"clientId": 987,
"healthStatus": "abc123",
"medicalHistoryIssues": "abc123",
"isSmoker": false,
"smokePerDay": 987,
"useNicotine": true,
"nicotinePerDay": 987,
"useMedication": false,
"medicationDetails": "xyz789",
"medicalCondition": true,
"medicalConditionDetails": "xyz789",
"majorIllness": false,
"majorIllnessDetails": "abc123",
"privateHealth": false,
"privateHealthDetails": "xyz789",
"sportsInterestsList": "abc123",
"sportsInterests": "abc123",
"sportsInterestsFrequency": "abc123",
"notes": "abc123",
"confidentialNotes": "xyz789"
}
SaveHoldingInput
Fields
| Input Field | Description |
|---|---|
inviteClientId - Int
|
|
inviteCode - String
|
|
practiceId - Int
|
|
holdingId - Int
|
|
householdId - Int
|
|
portfolioId - Int!
|
|
securityId - Int
|
|
ticker - String
|
|
description - String
|
|
quantity - Float
|
|
purchasePrice - Float
|
|
purchaseDate - String
|
|
averagePrice - Float
|
|
totalCost - Float
|
|
marketPrice - Float
|
|
marketPriceDate - String
|
|
maturityDate - String
|
|
interestRate - Float
|
|
paymentFrequency - String
|
|
currencyCode - String
|
|
overrideAssetTreeId - Int
|
|
overrideSecurityGroupId - Int
|
|
overrideSecurityTypeId - Int
|
|
overrideSecurityStyle - String
|
Example
{
"inviteClientId": 987,
"inviteCode": "abc123",
"practiceId": 123,
"holdingId": 987,
"householdId": 123,
"portfolioId": 123,
"securityId": 123,
"ticker": "xyz789",
"description": "abc123",
"quantity": 123.45,
"purchasePrice": 987.65,
"purchaseDate": "abc123",
"averagePrice": 123.45,
"totalCost": 123.45,
"marketPrice": 987.65,
"marketPriceDate": "abc123",
"maturityDate": "abc123",
"interestRate": 123.45,
"paymentFrequency": "xyz789",
"currencyCode": "abc123",
"overrideAssetTreeId": 123,
"overrideSecurityGroupId": 987,
"overrideSecurityTypeId": 123,
"overrideSecurityStyle": "xyz789"
}
SaveHouseholdConfig
Fields
| Input Field | Description |
|---|---|
practiceId - Int
|
|
householdId - Int
|
|
configuration - SaveHouseholdConfigConfiguration
|
Example
{
"practiceId": 123,
"householdId": 123,
"configuration": SaveHouseholdConfigConfiguration
}
SaveHouseholdConfigConfiguration
Fields
| Input Field | Description |
|---|---|
modules - SaveHouseholdConfigConfigurationModules
|
Example
{"modules": SaveHouseholdConfigConfigurationModules}
SaveHouseholdConfigConfigurationModuleBestLife
Fields
| Input Field | Description |
|---|---|
enabled - Boolean
|
Example
{"enabled": false}
SaveHouseholdConfigConfigurationModuleBestLifePlan
Fields
| Input Field | Description |
|---|---|
enabled - Boolean
|
Example
{"enabled": true}
SaveHouseholdConfigConfigurationModuleGoals
Fields
| Input Field | Description |
|---|---|
enabled - Boolean
|
Example
{"enabled": false}
SaveHouseholdConfigConfigurationModuleGovernance
Fields
| Input Field | Description |
|---|---|
enabled - Boolean
|
Example
{"enabled": true}
SaveHouseholdConfigConfigurationModuleHealthAssessment
Fields
| Input Field | Description |
|---|---|
enabled - Boolean
|
Example
{"enabled": false}
SaveHouseholdConfigConfigurationModuleInvPrefs
Fields
| Input Field | Description |
|---|---|
enabled - Boolean
|
Example
{"enabled": false}
SaveHouseholdConfigConfigurationModuleLife
Fields
| Input Field | Description |
|---|---|
enabled - Boolean
|
Example
{"enabled": true}
SaveHouseholdConfigConfigurationModuleStrategies
Fields
| Input Field | Description |
|---|---|
enabled - Boolean
|
Example
{"enabled": true}
SaveHouseholdConfigConfigurationModuleSurveys
Fields
| Input Field | Description |
|---|---|
enabled - Boolean
|
Example
{"enabled": true}
SaveHouseholdConfigConfigurationModuleTasks
Fields
| Input Field | Description |
|---|---|
enabled - Boolean
|
Example
{"enabled": false}
SaveHouseholdConfigConfigurationModuleValues
Fields
| Input Field | Description |
|---|---|
enabled - Boolean
|
Example
{"enabled": false}
SaveHouseholdConfigConfigurationModuleVault
Fields
| Input Field | Description |
|---|---|
enabled - Boolean
|
Example
{"enabled": false}
SaveHouseholdConfigConfigurationModuleWealth
Fields
| Input Field | Description |
|---|---|
enabled - Boolean
|
Example
{"enabled": false}
SaveHouseholdConfigConfigurationModules
Fields
| Input Field | Description |
|---|---|
bestLife - SaveHouseholdConfigConfigurationModuleBestLife
|
|
bestLifePlan - SaveHouseholdConfigConfigurationModuleBestLifePlan
|
|
goals - SaveHouseholdConfigConfigurationModuleGoals
|
|
governance - SaveHouseholdConfigConfigurationModuleGovernance
|
|
healthAssessment - SaveHouseholdConfigConfigurationModuleHealthAssessment
|
|
invPrefs - SaveHouseholdConfigConfigurationModuleInvPrefs
|
|
life - SaveHouseholdConfigConfigurationModuleLife
|
|
strategies - SaveHouseholdConfigConfigurationModuleStrategies
|
|
surveys - SaveHouseholdConfigConfigurationModuleSurveys
|
|
tasks - SaveHouseholdConfigConfigurationModuleTasks
|
|
values - SaveHouseholdConfigConfigurationModuleValues
|
|
vault - SaveHouseholdConfigConfigurationModuleVault
|
|
wealth - SaveHouseholdConfigConfigurationModuleWealth
|
Example
{
"bestLife": SaveHouseholdConfigConfigurationModuleBestLife,
"bestLifePlan": SaveHouseholdConfigConfigurationModuleBestLifePlan,
"goals": SaveHouseholdConfigConfigurationModuleGoals,
"governance": SaveHouseholdConfigConfigurationModuleGovernance,
"healthAssessment": SaveHouseholdConfigConfigurationModuleHealthAssessment,
"invPrefs": SaveHouseholdConfigConfigurationModuleInvPrefs,
"life": SaveHouseholdConfigConfigurationModuleLife,
"strategies": SaveHouseholdConfigConfigurationModuleStrategies,
"surveys": SaveHouseholdConfigConfigurationModuleSurveys,
"tasks": SaveHouseholdConfigConfigurationModuleTasks,
"values": SaveHouseholdConfigConfigurationModuleValues,
"vault": SaveHouseholdConfigConfigurationModuleVault,
"wealth": SaveHouseholdConfigConfigurationModuleWealth
}
SaveHouseholdKeyAdviceAreaInput
SaveHouseholdKeyAdviceAreasInput
Fields
| Input Field | Description |
|---|---|
practiceId - Int
|
|
householdId - Int!
|
|
householdKeyAdviceAreas - [SaveEnabledHouseholdKeyAdviceAreaInput]
|
Example
{
"practiceId": 987,
"householdId": 123,
"householdKeyAdviceAreas": [
SaveEnabledHouseholdKeyAdviceAreaInput
]
}
SaveHouseholdMemberInput
Fields
| Input Field | Description |
|---|---|
inviteClientId - Int
|
|
inviteCode - String
|
|
practiceId - Int
|
|
householdMemberId - Int
|
|
householdId - Int
|
|
relation - String!
|
|
firstName - String!
|
|
middleName - String
|
|
lastName - String!
|
|
dob - String
|
|
sex - String
|
|
livingAtHome - Boolean!
|
|
financiallyDependent - Boolean!
|
|
financiallyDependentUntil - Int
|
|
notes - String
|
|
confidentialNotes - String
|
Example
{
"inviteClientId": 987,
"inviteCode": "abc123",
"practiceId": 987,
"householdMemberId": 123,
"householdId": 123,
"relation": "xyz789",
"firstName": "xyz789",
"middleName": "abc123",
"lastName": "abc123",
"dob": "xyz789",
"sex": "abc123",
"livingAtHome": false,
"financiallyDependent": true,
"financiallyDependentUntil": 987,
"notes": "abc123",
"confidentialNotes": "xyz789"
}
SaveHouseholdStrategyInput
Fields
| Input Field | Description |
|---|---|
practiceId - Int
|
|
householdStrategyId - Int
|
|
householdId - Int!
|
|
practiceKeyAdviceAreaId - Int!
|
|
practiceStrategyId - Int
|
|
strategyName - String
|
|
details - String
|
|
progress - Int!
|
|
startDate - String
|
|
endDate - String
|
|
status - Int
|
|
targetAmount - Float
|
|
confidentialNotes - String
|
|
linkedGoalIds - [Int]
|
|
linkedTaskIds - [Int]
|
Example
{
"practiceId": 987,
"householdStrategyId": 987,
"householdId": 123,
"practiceKeyAdviceAreaId": 987,
"practiceStrategyId": 123,
"strategyName": "xyz789",
"details": "abc123",
"progress": 123,
"startDate": "xyz789",
"endDate": "abc123",
"status": 123,
"targetAmount": 123.45,
"confidentialNotes": "xyz789",
"linkedGoalIds": [987],
"linkedTaskIds": [123]
}
SaveIncomeInput
Fields
| Input Field | Description |
|---|---|
inviteClientId - Int
|
|
inviteCode - String
|
|
practiceId - Int
|
|
incomeId - Int
|
|
householdId - Int
|
|
clientId - Int
|
|
assetId - Int
|
|
legalEntityId - Int
|
|
incomeType - String!
|
|
employer - String
|
|
jobTitle - String
|
|
salary - Float
|
|
superBps - Float
|
|
salarySacrifice - Float
|
|
income - Float
|
|
frequency - String
|
|
incomeSubType - String
|
|
description - String
|
|
assessed - Boolean
|
|
taxStatus - String
|
|
rateChangeBps - Float
|
|
bonus - Float
|
|
bonusBps - Float
|
|
commission - Float
|
|
commissionBps - Float
|
|
startDate - String
|
|
endDate - String
|
|
plannedChanges - Boolean
|
|
plannedChangesDescription - String
|
|
eligibleSocialBenefits - Boolean
|
|
typeOfConcession - String
|
|
giftedAssets - Boolean
|
|
giftedAssetsList - String
|
|
crn - String
|
|
isReceivingPayments - Boolean
|
|
paymentType - String
|
|
benefitAmount - Float
|
|
retirementBenefitAmount - Float
|
|
notes - String
|
|
clientNotes - String
|
|
partnerNotes - String
|
|
confidentialNotes - String
|
Example
{
"inviteClientId": 123,
"inviteCode": "xyz789",
"practiceId": 987,
"incomeId": 123,
"householdId": 987,
"clientId": 987,
"assetId": 123,
"legalEntityId": 123,
"incomeType": "xyz789",
"employer": "xyz789",
"jobTitle": "xyz789",
"salary": 123.45,
"superBps": 123.45,
"salarySacrifice": 123.45,
"income": 123.45,
"frequency": "xyz789",
"incomeSubType": "xyz789",
"description": "abc123",
"assessed": false,
"taxStatus": "abc123",
"rateChangeBps": 123.45,
"bonus": 123.45,
"bonusBps": 123.45,
"commission": 987.65,
"commissionBps": 987.65,
"startDate": "abc123",
"endDate": "abc123",
"plannedChanges": false,
"plannedChangesDescription": "abc123",
"eligibleSocialBenefits": true,
"typeOfConcession": "xyz789",
"giftedAssets": true,
"giftedAssetsList": "xyz789",
"crn": "xyz789",
"isReceivingPayments": false,
"paymentType": "xyz789",
"benefitAmount": 123.45,
"retirementBenefitAmount": 123.45,
"notes": "abc123",
"clientNotes": "xyz789",
"partnerNotes": "xyz789",
"confidentialNotes": "abc123"
}
SaveInsuranceInput
Fields
| Input Field | Description |
|---|---|
inviteClientId - Int
|
|
inviteCode - String
|
|
practiceId - Int
|
|
insuranceId - Int
|
|
householdId - Int
|
|
clientId - Int
|
|
legalEntityId - Int
|
|
assetId - Int
|
|
beneficiaryClientId - Int
|
|
beneficiaryLegalEntityId - Int
|
|
beneficiaryHouseholdMemberId - Int
|
|
insuranceType - String!
|
|
lifeInsuranceType - String
|
|
generalInsuranceType - String
|
|
insurer - String
|
|
description - String
|
|
excess - Float
|
|
cashValue - Float
|
|
cover - Float
|
|
coverBps - Float
|
|
insideSuper - Boolean
|
|
ipCoverType - String
|
|
arSubType - String
|
|
premium - Float
|
|
frequency - String
|
|
policyNumber - String
|
|
policyStatus - String
|
|
policyToDate - String
|
|
premiumIncreaseBps - Float
|
|
payoutPeriod - String
|
|
payoutPeriodEnd - String
|
|
payoutWaitPeriod - Int
|
|
endYear - Int
|
|
notes - String
|
|
clientNotes - String
|
|
partnerNotes - String
|
|
confidentialNotes - String
|
|
displayName - String
|
|
coverages - [InsuranceCoverageInput]
|
Example
{
"inviteClientId": 987,
"inviteCode": "abc123",
"practiceId": 123,
"insuranceId": 123,
"householdId": 987,
"clientId": 987,
"legalEntityId": 987,
"assetId": 123,
"beneficiaryClientId": 123,
"beneficiaryLegalEntityId": 987,
"beneficiaryHouseholdMemberId": 123,
"insuranceType": "xyz789",
"lifeInsuranceType": "abc123",
"generalInsuranceType": "xyz789",
"insurer": "abc123",
"description": "xyz789",
"excess": 123.45,
"cashValue": 123.45,
"cover": 123.45,
"coverBps": 123.45,
"insideSuper": true,
"ipCoverType": "xyz789",
"arSubType": "abc123",
"premium": 123.45,
"frequency": "xyz789",
"policyNumber": "xyz789",
"policyStatus": "xyz789",
"policyToDate": "abc123",
"premiumIncreaseBps": 123.45,
"payoutPeriod": "xyz789",
"payoutPeriodEnd": "xyz789",
"payoutWaitPeriod": 987,
"endYear": 987,
"notes": "xyz789",
"clientNotes": "xyz789",
"partnerNotes": "abc123",
"confidentialNotes": "xyz789",
"displayName": "xyz789",
"coverages": [InsuranceCoverageInput]
}
SaveLegalEntityInput
Fields
| Input Field | Description |
|---|---|
inviteClientId - Int
|
|
inviteCode - String
|
|
practiceId - Int
|
|
legalEntityId - Int
|
|
householdId - Int
|
|
legalEntityType - String!
|
|
companyType - String
|
|
trusteeType - String
|
|
trustType - String
|
|
name - String
|
|
purpose - String
|
|
abn - String
|
|
tfn - String
|
|
value - Float
|
|
growthBps - Float
|
|
growthDollar - Float
|
|
clientShare - Float
|
|
partnerShare - Float
|
|
clientSuperPhase - String
|
|
partnerSuperPhase - String
|
|
notes - String
|
|
clientNotes - String
|
|
partnerNotes - String
|
|
confidentialNotes - String
|
Example
{
"inviteClientId": 987,
"inviteCode": "abc123",
"practiceId": 987,
"legalEntityId": 987,
"householdId": 987,
"legalEntityType": "xyz789",
"companyType": "xyz789",
"trusteeType": "abc123",
"trustType": "abc123",
"name": "abc123",
"purpose": "xyz789",
"abn": "xyz789",
"tfn": "abc123",
"value": 987.65,
"growthBps": 123.45,
"growthDollar": 123.45,
"clientShare": 987.65,
"partnerShare": 987.65,
"clientSuperPhase": "xyz789",
"partnerSuperPhase": "xyz789",
"notes": "xyz789",
"clientNotes": "abc123",
"partnerNotes": "abc123",
"confidentialNotes": "abc123"
}
SaveLiabilityInput
Fields
| Input Field | Description |
|---|---|
inviteClientId - Int
|
|
inviteCode - String
|
|
practiceId - Int
|
|
liabilityId - Int
|
|
householdId - Int
|
|
clientId - Int
|
|
legalEntityId - Int
|
|
assetId - Int
|
|
liabilityType - String!
|
|
loanType - String
|
|
description - String
|
|
accountNumber - String
|
|
providerName - String
|
|
lender - String
|
|
maxLimit - Float
|
|
originalAmount - Float
|
|
owing - Float
|
|
rate - Float
|
|
interestRateType - String
|
|
repayment - Float
|
|
repaymentFrequency - String
|
|
monthlyPayment - Float
|
|
notes - String
|
|
clientNotes - String
|
|
partnerNotes - String
|
|
confidentialNotes - String
|
|
displayName - String
|
Example
{
"inviteClientId": 123,
"inviteCode": "xyz789",
"practiceId": 987,
"liabilityId": 123,
"householdId": 987,
"clientId": 123,
"legalEntityId": 123,
"assetId": 987,
"liabilityType": "xyz789",
"loanType": "xyz789",
"description": "abc123",
"accountNumber": "abc123",
"providerName": "abc123",
"lender": "xyz789",
"maxLimit": 123.45,
"originalAmount": 987.65,
"owing": 123.45,
"rate": 987.65,
"interestRateType": "abc123",
"repayment": 123.45,
"repaymentFrequency": "xyz789",
"monthlyPayment": 123.45,
"notes": "xyz789",
"clientNotes": "abc123",
"partnerNotes": "xyz789",
"confidentialNotes": "abc123",
"displayName": "abc123"
}
SaveLivingDiscretionaryExpenseInput
Fields
| Input Field | Description |
|---|---|
inviteClientId - Int
|
|
inviteCode - String
|
|
practiceId - Int
|
|
livingDiscretionaryExpenseId - Int
|
|
householdId - Int
|
|
alimony - Float
|
|
alimonyFrequency - String
|
|
childMaintenance - Float
|
|
childMaintenanceFrequency - String
|
|
childCare - Float
|
|
childCareFrequency - String
|
|
child - Float
|
|
childFrequency - String
|
|
care - Float
|
|
careFrequency - String
|
|
education - Float
|
|
educationFrequency - String
|
|
rent - Float
|
|
rentFrequency - String
|
|
associationFees - Float
|
|
associationFeesFrequency - String
|
|
rates - Float
|
|
ratesFrequency - String
|
|
water - Float
|
|
waterFrequency - String
|
|
gardening - Float
|
|
gardeningFrequency - String
|
|
homeImprovement - Float
|
|
homeImprovementFrequency - String
|
|
repairs - Float
|
|
repairsFrequency - String
|
|
electricity - Float
|
|
electricityFrequency - String
|
|
gas - Float
|
|
gasFrequency - String
|
|
groceries - Float
|
|
groceriesFrequency - String
|
|
homePhone - Float
|
|
homePhoneFrequency - String
|
|
cable - Float
|
|
cableFrequency - String
|
|
broadband - Float
|
|
broadbandFrequency - String
|
|
mobile - Float
|
|
mobileFrequency - String
|
|
cleaning - Float
|
|
cleaningFrequency - String
|
|
personalCare - Float
|
|
personalCareFrequency - String
|
|
petCare - Float
|
|
petCareFrequency - String
|
|
appliances - Float
|
|
appliancesFrequency - String
|
|
homeOther - Float
|
|
homeOtherFrequency - String
|
|
clothing - Float
|
|
clothingFrequency - String
|
|
footwear - Float
|
|
footwearFrequency - String
|
|
healthcare - Float
|
|
healthcareFrequency - String
|
|
dental - Float
|
|
dentalFrequency - String
|
|
healthcareOther - Float
|
|
healthcareOtherFrequency - String
|
|
carTransport - Float
|
|
carTransportFrequency - String
|
|
publicTransport - Float
|
|
publicTransportFrequency - String
|
|
livingOther - Float
|
|
livingOtherFrequency - String
|
|
memberships - Float
|
|
membershipsFrequency - String
|
|
streaming - Float
|
|
streamingFrequency - String
|
|
alcohol - Float
|
|
alcoholFrequency - String
|
|
tobacco - Float
|
|
tobaccoFrequency - String
|
|
entertainment - Float
|
|
entertainmentFrequency - String
|
|
hobbies - Float
|
|
hobbiesFrequency - String
|
|
vacations - Float
|
|
vacationsFrequency - String
|
|
takeAway - Float
|
|
takeAwayFrequency - String
|
|
gifts - Float
|
|
giftsFrequency - String
|
|
donations - Float
|
|
donationsFrequency - String
|
|
discretionaryOther - Float
|
|
discretionaryOtherFrequency - String
|
|
notes - String
|
|
clientNotes - String
|
|
partnerNotes - String
|
|
confidentialNotes - String
|
Example
{
"inviteClientId": 123,
"inviteCode": "xyz789",
"practiceId": 123,
"livingDiscretionaryExpenseId": 123,
"householdId": 987,
"alimony": 123.45,
"alimonyFrequency": "abc123",
"childMaintenance": 123.45,
"childMaintenanceFrequency": "abc123",
"childCare": 987.65,
"childCareFrequency": "xyz789",
"child": 123.45,
"childFrequency": "abc123",
"care": 123.45,
"careFrequency": "xyz789",
"education": 123.45,
"educationFrequency": "abc123",
"rent": 987.65,
"rentFrequency": "abc123",
"associationFees": 987.65,
"associationFeesFrequency": "abc123",
"rates": 987.65,
"ratesFrequency": "xyz789",
"water": 987.65,
"waterFrequency": "xyz789",
"gardening": 123.45,
"gardeningFrequency": "xyz789",
"homeImprovement": 987.65,
"homeImprovementFrequency": "xyz789",
"repairs": 987.65,
"repairsFrequency": "abc123",
"electricity": 123.45,
"electricityFrequency": "abc123",
"gas": 987.65,
"gasFrequency": "xyz789",
"groceries": 123.45,
"groceriesFrequency": "abc123",
"homePhone": 123.45,
"homePhoneFrequency": "abc123",
"cable": 987.65,
"cableFrequency": "xyz789",
"broadband": 123.45,
"broadbandFrequency": "xyz789",
"mobile": 123.45,
"mobileFrequency": "xyz789",
"cleaning": 987.65,
"cleaningFrequency": "abc123",
"personalCare": 123.45,
"personalCareFrequency": "xyz789",
"petCare": 987.65,
"petCareFrequency": "xyz789",
"appliances": 123.45,
"appliancesFrequency": "abc123",
"homeOther": 123.45,
"homeOtherFrequency": "abc123",
"clothing": 123.45,
"clothingFrequency": "xyz789",
"footwear": 123.45,
"footwearFrequency": "abc123",
"healthcare": 987.65,
"healthcareFrequency": "xyz789",
"dental": 987.65,
"dentalFrequency": "abc123",
"healthcareOther": 123.45,
"healthcareOtherFrequency": "abc123",
"carTransport": 123.45,
"carTransportFrequency": "abc123",
"publicTransport": 987.65,
"publicTransportFrequency": "xyz789",
"livingOther": 987.65,
"livingOtherFrequency": "xyz789",
"memberships": 123.45,
"membershipsFrequency": "xyz789",
"streaming": 987.65,
"streamingFrequency": "xyz789",
"alcohol": 987.65,
"alcoholFrequency": "xyz789",
"tobacco": 123.45,
"tobaccoFrequency": "abc123",
"entertainment": 987.65,
"entertainmentFrequency": "xyz789",
"hobbies": 123.45,
"hobbiesFrequency": "xyz789",
"vacations": 987.65,
"vacationsFrequency": "xyz789",
"takeAway": 987.65,
"takeAwayFrequency": "xyz789",
"gifts": 987.65,
"giftsFrequency": "xyz789",
"donations": 987.65,
"donationsFrequency": "abc123",
"discretionaryOther": 123.45,
"discretionaryOtherFrequency": "abc123",
"notes": "abc123",
"clientNotes": "abc123",
"partnerNotes": "xyz789",
"confidentialNotes": "abc123"
}
SaveNotesInput
SaveOriginationSurveyInput
SaveOriginationSurveyOutput
Fields
| Field Name | Description |
|---|---|
LIFE - SurveyResponseStatus
|
|
FHA - SurveyResponseStatus
|
|
VALUES - SurveyResponseStatus
|
|
GOALS - SurveyResponseStatus
|
|
GOV - SurveyResponseStatus
|
|
FND - SurveyResponseStatus
|
|
IP - SurveyResponseStatus
|
|
allSuccess - Boolean
|
Example
{
"LIFE": SurveyResponseStatus,
"FHA": SurveyResponseStatus,
"VALUES": SurveyResponseStatus,
"GOALS": SurveyResponseStatus,
"GOV": SurveyResponseStatus,
"FND": SurveyResponseStatus,
"IP": SurveyResponseStatus,
"allSuccess": true
}
SavePortfolioInput
Example
{
"inviteClientId": 123,
"inviteCode": "abc123",
"practiceId": 987,
"portfolioId": 123,
"householdId": 123,
"clientId": 123,
"legalEntityId": 987,
"name": "abc123",
"type": "abc123",
"accountNumber": "abc123"
}
SavePowerOfInput
Fields
| Input Field | Description |
|---|---|
inviteClientId - Int
|
|
inviteCode - String
|
|
practiceId - Int
|
|
powerOfId - Int
|
|
estatePlanningId - Int!
|
|
powerOfType - String
|
|
poaTypeEnduring - Boolean
|
|
poaTypeMedical - Boolean
|
|
poaTypeLimited - Boolean
|
|
poaTypeCare - Boolean
|
|
poaTypeOther - Boolean
|
|
firstName - String!
|
|
middleName - String
|
|
lastName - String!
|
|
isAlternate - Boolean
|
|
notes - String
|
|
clientNotes - String
|
|
partnerNotes - String
|
|
confidentialNotes - String
|
Example
{
"inviteClientId": 987,
"inviteCode": "xyz789",
"practiceId": 123,
"powerOfId": 123,
"estatePlanningId": 123,
"powerOfType": "xyz789",
"poaTypeEnduring": false,
"poaTypeMedical": true,
"poaTypeLimited": true,
"poaTypeCare": true,
"poaTypeOther": false,
"firstName": "xyz789",
"middleName": "abc123",
"lastName": "xyz789",
"isAlternate": false,
"notes": "abc123",
"clientNotes": "abc123",
"partnerNotes": "xyz789",
"confidentialNotes": "xyz789"
}
SavePracticeAssetAllocationsInput
Fields
| Input Field | Description |
|---|---|
practiceId - Int
|
|
riskGroup - Int!
|
|
assetAllocations - [PracticeAssetAllocationInput!]!
|
Example
{
"practiceId": 987,
"riskGroup": 987,
"assetAllocations": [PracticeAssetAllocationInput]
}
SavePracticeConfig
Fields
| Input Field | Description |
|---|---|
practiceId - Int
|
|
palette - SavePracticeConfigPalette
|
|
typography - SavePracticeConfigTypography
|
|
configuration - SavePracticeConfigConfiguration
|
|
theme - String
|
Example
{
"practiceId": 123,
"palette": SavePracticeConfigPalette,
"typography": SavePracticeConfigTypography,
"configuration": SavePracticeConfigConfiguration,
"theme": "xyz789"
}
SavePracticeConfigConfiguration
Fields
| Input Field | Description |
|---|---|
modules - SavePracticeConfigConfigurationModules
|
|
notification - SavePracticeConfigConfigurationNotification
|
|
mfa - SavePracticeConfigConfigurationMFA
|
|
defaultClientSharing - Int
|
|
lockClientDetails - Boolean
|
|
inAppNotifications - SavePracticeConfigConfigurationInAppNotification
|
|
filterSettings - SavePracticeConfigConfigurationFilterSettings
|
|
removeLogoWhiteBackground - SavePracticeConfigConfigurationRemoveLogoWhiteBackground
|
Example
{
"modules": SavePracticeConfigConfigurationModules,
"notification": SavePracticeConfigConfigurationNotification,
"mfa": SavePracticeConfigConfigurationMFA,
"defaultClientSharing": 123,
"lockClientDetails": true,
"inAppNotifications": SavePracticeConfigConfigurationInAppNotification,
"filterSettings": SavePracticeConfigConfigurationFilterSettings,
"removeLogoWhiteBackground": SavePracticeConfigConfigurationRemoveLogoWhiteBackground
}
SavePracticeConfigConfigurationFilterSettings
Fields
| Input Field | Description |
|---|---|
getHouseholdsFilterSettings - SavePracticeConfigConfigurationFilterSettingsGetHouseholds
|
Example
{
"getHouseholdsFilterSettings": SavePracticeConfigConfigurationFilterSettingsGetHouseholds
}
SavePracticeConfigConfigurationFilterSettingsGetHouseholds
Fields
| Input Field | Description |
|---|---|
showAllClients - Boolean
|
Example
{"showAllClients": false}
SavePracticeConfigConfigurationInAppNotification
Fields
| Input Field | Description |
|---|---|
enabled - String
|
Example
{"enabled": "abc123"}
SavePracticeConfigConfigurationMFA
Fields
| Input Field | Description |
|---|---|
enforceStaffMfa - Boolean
|
Example
{"enforceStaffMfa": false}
SavePracticeConfigConfigurationModuleBestLife
SavePracticeConfigConfigurationModuleBestLifePlan
SavePracticeConfigConfigurationModuleFoundations
SavePracticeConfigConfigurationModuleGoals
SavePracticeConfigConfigurationModuleGovernance
SavePracticeConfigConfigurationModuleHealthAssessment
SavePracticeConfigConfigurationModuleInvPrefs
Fields
| Input Field | Description |
|---|---|
name - String
|
|
shortName - String
|
|
introVideoUrl - String
|
|
introVideoS3Filename - String
|
|
customisationVideoUrl - String
|
|
customisationVideoS3Filename - String
|
|
ethicalVideoUrl - String
|
|
ethicalVideoS3Filename - String
|
|
assetClassVideoUrl - String
|
|
assetClassVideoS3Filename - String
|
|
allocationVideoUrl - String
|
|
allocationVideoS3Filename - String
|
|
riskVideoUrl - String
|
|
riskVideoS3Filename - String
|
|
costVideoUrl - String
|
|
costVideoS3Filename - String
|
|
createTaskOnCompletion - Boolean
|
Example
{
"name": "xyz789",
"shortName": "xyz789",
"introVideoUrl": "xyz789",
"introVideoS3Filename": "abc123",
"customisationVideoUrl": "abc123",
"customisationVideoS3Filename": "xyz789",
"ethicalVideoUrl": "abc123",
"ethicalVideoS3Filename": "abc123",
"assetClassVideoUrl": "abc123",
"assetClassVideoS3Filename": "abc123",
"allocationVideoUrl": "xyz789",
"allocationVideoS3Filename": "xyz789",
"riskVideoUrl": "abc123",
"riskVideoS3Filename": "xyz789",
"costVideoUrl": "xyz789",
"costVideoS3Filename": "xyz789",
"createTaskOnCompletion": true
}
SavePracticeConfigConfigurationModuleLife
Example
{
"name": "abc123",
"shortName": "abc123",
"introVideoUrl": "xyz789",
"introVideoS3Filename": "xyz789",
"connectionsOverride": "xyz789",
"factFindOverride": "abc123",
"createTaskOnCompletion": false
}
SavePracticeConfigConfigurationModuleNetWorth
SavePracticeConfigConfigurationModuleStrategies
SavePracticeConfigConfigurationModuleSurveys
SavePracticeConfigConfigurationModuleTasks
SavePracticeConfigConfigurationModuleTermsOfEngagement
Fields
| Input Field | Description |
|---|---|
sections - [SavePracticeConfigConfigurationModuleTermsOfEngagementSection]
|
Example
{
"sections": [
SavePracticeConfigConfigurationModuleTermsOfEngagementSection
]
}
SavePracticeConfigConfigurationModuleTermsOfEngagementSection
SavePracticeConfigConfigurationModuleValues
SavePracticeConfigConfigurationModuleVault
Fields
| Input Field | Description |
|---|---|
name - String
|
|
shortName - String
|
|
bestLifePlans - String
|
|
bestLifePlansEnabled - Boolean
|
|
retirementDocuments - String
|
|
retirementDocumentsEnabled - Boolean
|
|
legalDocuments - String
|
|
legalDocumentsEnabled - Boolean
|
|
identityDocuments - String
|
|
identityDocumentsEnabled - Boolean
|
|
estatePlanningDocuments - String
|
|
estatePlanningDocumentsEnabled - Boolean
|
|
adviceDocuments - String
|
|
adviceDocumentsEnabled - Boolean
|
|
taxReturns - String
|
|
taxReturnsEnabled - Boolean
|
|
businessStructures - String
|
|
businessStructuresEnabled - Boolean
|
|
insuranceDocuments - String
|
|
insuranceDocumentsEnabled - Boolean
|
|
educationDocuments - String
|
|
educationDocumentsEnabled - Boolean
|
|
otherDocuments - String
|
|
otherDocumentsEnabled - Boolean
|
|
actionRequired - String
|
|
actionRequiredEnabled - Boolean
|
|
folders - [VaultFolderInput]
|
Example
{
"name": "xyz789",
"shortName": "abc123",
"bestLifePlans": "xyz789",
"bestLifePlansEnabled": true,
"retirementDocuments": "abc123",
"retirementDocumentsEnabled": false,
"legalDocuments": "abc123",
"legalDocumentsEnabled": true,
"identityDocuments": "abc123",
"identityDocumentsEnabled": false,
"estatePlanningDocuments": "xyz789",
"estatePlanningDocumentsEnabled": false,
"adviceDocuments": "abc123",
"adviceDocumentsEnabled": false,
"taxReturns": "xyz789",
"taxReturnsEnabled": true,
"businessStructures": "xyz789",
"businessStructuresEnabled": false,
"insuranceDocuments": "abc123",
"insuranceDocumentsEnabled": false,
"educationDocuments": "xyz789",
"educationDocumentsEnabled": false,
"otherDocuments": "abc123",
"otherDocumentsEnabled": false,
"actionRequired": "xyz789",
"actionRequiredEnabled": true,
"folders": [VaultFolderInput]
}
SavePracticeConfigConfigurationModuleWealth
SavePracticeConfigConfigurationModules
Fields
| Input Field | Description |
|---|---|
bestLife - SavePracticeConfigConfigurationModuleBestLife
|
|
bestLifePlan - SavePracticeConfigConfigurationModuleBestLifePlan
|
|
foundations - SavePracticeConfigConfigurationModuleFoundations
|
|
goals - SavePracticeConfigConfigurationModuleGoals
|
|
governance - SavePracticeConfigConfigurationModuleGovernance
|
|
healthAssessment - SavePracticeConfigConfigurationModuleHealthAssessment
|
|
invPrefs - SavePracticeConfigConfigurationModuleInvPrefs
|
|
life - SavePracticeConfigConfigurationModuleLife
|
|
strategies - SavePracticeConfigConfigurationModuleStrategies
|
|
surveys - SavePracticeConfigConfigurationModuleSurveys
|
|
tasks - SavePracticeConfigConfigurationModuleTasks
|
|
termsOfEngagement - SavePracticeConfigConfigurationModuleTermsOfEngagement
|
|
values - SavePracticeConfigConfigurationModuleValues
|
|
vault - SavePracticeConfigConfigurationModuleVault
|
|
wealth - SavePracticeConfigConfigurationModuleWealth
|
|
netWorth - SavePracticeConfigConfigurationModuleNetWorth
|
Example
{
"bestLife": SavePracticeConfigConfigurationModuleBestLife,
"bestLifePlan": SavePracticeConfigConfigurationModuleBestLifePlan,
"foundations": SavePracticeConfigConfigurationModuleFoundations,
"goals": SavePracticeConfigConfigurationModuleGoals,
"governance": SavePracticeConfigConfigurationModuleGovernance,
"healthAssessment": SavePracticeConfigConfigurationModuleHealthAssessment,
"invPrefs": SavePracticeConfigConfigurationModuleInvPrefs,
"life": SavePracticeConfigConfigurationModuleLife,
"strategies": SavePracticeConfigConfigurationModuleStrategies,
"surveys": SavePracticeConfigConfigurationModuleSurveys,
"tasks": SavePracticeConfigConfigurationModuleTasks,
"termsOfEngagement": SavePracticeConfigConfigurationModuleTermsOfEngagement,
"values": SavePracticeConfigConfigurationModuleValues,
"vault": SavePracticeConfigConfigurationModuleVault,
"wealth": SavePracticeConfigConfigurationModuleWealth,
"netWorth": SavePracticeConfigConfigurationModuleNetWorth
}
SavePracticeConfigConfigurationNotification
Example
{
"emailOverrideTo": "abc123",
"emailSender": "abc123",
"emailSenderName": "abc123",
"emailCC": "xyz789",
"emailSignature": "xyz789",
"disableTaskEmailNotification": true
}
SavePracticeConfigConfigurationRemoveLogoWhiteBackground
Fields
| Input Field | Description |
|---|---|
enabled - Boolean
|
Example
{"enabled": true}
SavePracticeConfigPalette
Fields
| Input Field | Description |
|---|---|
primary - SavePracticeConfigPaletteBGFGColors
|
|
secondary - SavePracticeConfigPaletteBGFGColors
|
|
buttons - SavePracticeConfigPaletteButtons
|
|
backgrounds - SavePracticeConfigPaletteBackgrounds
|
Example
{
"primary": SavePracticeConfigPaletteBGFGColors,
"secondary": SavePracticeConfigPaletteBGFGColors,
"buttons": SavePracticeConfigPaletteButtons,
"backgrounds": SavePracticeConfigPaletteBackgrounds
}
SavePracticeConfigPaletteBGFGColors
SavePracticeConfigPaletteBackgrounds
Fields
| Input Field | Description |
|---|---|
main - SavePracticeConfigPaletteBGFGColors
|
|
workbench - SavePracticeConfigPaletteBGFGColors
|
Example
{
"main": SavePracticeConfigPaletteBGFGColors,
"workbench": SavePracticeConfigPaletteBGFGColors
}
SavePracticeConfigPaletteButtons
Fields
| Input Field | Description |
|---|---|
primary - SavePracticeConfigPaletteBGFGColors
|
|
secondary - SavePracticeConfigPaletteBGFGColors
|
Example
{
"primary": SavePracticeConfigPaletteBGFGColors,
"secondary": SavePracticeConfigPaletteBGFGColors
}
SavePracticeConfigTypography
SavePracticeInput
Fields
| Input Field | Description |
|---|---|
practiceId - Int
|
|
dealerGroupId - Int
|
|
name - String
|
|
abn - String
|
|
afsl - String
|
|
afslName - String
|
|
legalName - String
|
|
status - String
|
|
contractStart - String
|
|
contractPeriod - Int
|
|
ilgn - String
|
|
usesExternalDomain - Boolean
|
|
tandcVersion - String
|
|
practiceHomeRegion - String
|
|
homeLocale - String
|
Example
{
"practiceId": 987,
"dealerGroupId": 123,
"name": "xyz789",
"abn": "abc123",
"afsl": "abc123",
"afslName": "abc123",
"legalName": "abc123",
"status": "abc123",
"contractStart": "xyz789",
"contractPeriod": 987,
"ilgn": "xyz789",
"usesExternalDomain": false,
"tandcVersion": "xyz789",
"practiceHomeRegion": "xyz789",
"homeLocale": "xyz789"
}
SavePracticeIntegrationInput
Fields
| Input Field | Description |
|---|---|
practiceIntegrationId - Int
|
|
name - String!
|
|
description - String
|
|
enabled - Boolean!
|
|
integrationType - String!
|
|
integrationMeta1 - String
|
|
integrationMeta2 - String
|
|
integrationMeta3 - String
|
|
integrationMeta4 - String
|
|
integrationMeta5 - String
|
|
integrationMeta6 - String
|
|
integrationMeta7 - String
|
|
integrationMeta8 - String
|
Example
{
"practiceIntegrationId": 123,
"name": "abc123",
"description": "xyz789",
"enabled": true,
"integrationType": "xyz789",
"integrationMeta1": "abc123",
"integrationMeta2": "xyz789",
"integrationMeta3": "abc123",
"integrationMeta4": "xyz789",
"integrationMeta5": "abc123",
"integrationMeta6": "abc123",
"integrationMeta7": "xyz789",
"integrationMeta8": "abc123"
}
SavePracticeKeyAdviceAreaInput
Example
{
"practiceId": 987,
"practiceKeyAdviceAreaId": 987,
"categoryName": "abc123",
"description": "abc123",
"rank": 123,
"muiIconName": "abc123"
}
SavePracticeOfficeInput
Example
{
"practiceId": 123,
"practiceOfficeId": 987,
"name": "abc123",
"emailAddress": "xyz789",
"mobileNumber": "abc123",
"faxNumber": "xyz789",
"phoneNumber": "xyz789",
"addressLine1": "xyz789",
"addressLine2": "xyz789",
"suburb": "abc123",
"postCode": "abc123",
"state": "xyz789",
"country": "abc123"
}
SavePracticeOfficeOutput
Fields
| Field Name | Description |
|---|---|
practiceOfficeId - Int
|
Example
{"practiceOfficeId": 987}
SavePracticeOutput
Fields
| Field Name | Description |
|---|---|
practiceId - Int
|
Example
{"practiceId": 123}
SavePracticeRiskProfileInput
SavePracticeSegmentationInput
Example
{
"practiceId": 987,
"practiceSegmentationId": 987,
"segmentName": "xyz789",
"description": "xyz789",
"rank": 987,
"configuration": "xyz789"
}
SavePracticeStrategyInput
SaveProfessionalContactInput
Fields
| Input Field | Description |
|---|---|
inviteClientId - Int
|
|
inviteCode - String
|
|
practiceId - Int
|
|
professionalContactId - Int
|
|
householdId - Int
|
|
contactType - String!
|
|
contactTypeDetails - String
|
|
name - String
|
|
company - String
|
|
phoneNumber - String
|
|
emailAddress - String
|
|
address - String
|
|
authorityToContact - Boolean
|
|
relationshipQuality - String
|
|
notes - String
|
|
clientNotes - String
|
|
partnerNotes - String
|
|
confidentialNotes - String
|
Example
{
"inviteClientId": 987,
"inviteCode": "xyz789",
"practiceId": 123,
"professionalContactId": 123,
"householdId": 987,
"contactType": "xyz789",
"contactTypeDetails": "abc123",
"name": "abc123",
"company": "xyz789",
"phoneNumber": "abc123",
"emailAddress": "abc123",
"address": "abc123",
"authorityToContact": false,
"relationshipQuality": "xyz789",
"notes": "abc123",
"clientNotes": "xyz789",
"partnerNotes": "xyz789",
"confidentialNotes": "xyz789"
}
SaveProfileImageInput
SaveRetirementDetailsInput
Example
{
"inviteClientId": 987,
"inviteCode": "abc123",
"practiceId": 123,
"retirementDetailsId": 987,
"clientId": 123,
"retirementAge": 123,
"requiredIncome": 987.65,
"retirementLifestyle": "abc123",
"notes": "xyz789",
"confidentialNotes": "abc123"
}
SaveRiskProfileInput
Fields
| Input Field | Description |
|---|---|
inviteClientId - Int
|
|
inviteCode - String
|
|
practiceId - Int
|
|
riskProfileId - Int
|
|
householdId - Int
|
|
clientId - Int
|
|
legalEntityId - Int
|
|
riskProfileAssessed - Int
|
|
riskProfileDirected - Int
|
|
riskProfileDirectedBy - String
|
|
notes - String
|
|
clientNotes - String
|
|
partnerNotes - String
|
|
confidentialNotes - String
|
Example
{
"inviteClientId": 123,
"inviteCode": "abc123",
"practiceId": 987,
"riskProfileId": 987,
"householdId": 987,
"clientId": 123,
"legalEntityId": 123,
"riskProfileAssessed": 987,
"riskProfileDirected": 123,
"riskProfileDirectedBy": "xyz789",
"notes": "xyz789",
"clientNotes": "xyz789",
"partnerNotes": "abc123",
"confidentialNotes": "abc123"
}
SaveSensitiveDetailsInput
Example
{
"inviteClientId": 123,
"inviteCode": "xyz789",
"practiceId": 123,
"sensitiveDetailsId": 987,
"clientId": 123,
"isPep": true,
"isVulnerable": true,
"notes": "xyz789",
"confidentialNotes": "abc123"
}
SaveStaffConfig
Fields
| Input Field | Description |
|---|---|
practiceId - Int
|
|
staffId - Int
|
|
configuration - SaveStaffConfigConfiguration
|
Example
{
"practiceId": 987,
"staffId": 123,
"configuration": SaveStaffConfigConfiguration
}
SaveStaffConfigConfiguration
Fields
| Input Field | Description |
|---|---|
modules - SaveStaffConfigConfigurationModules
|
|
inAppNotifications - SaveStaffConfigConfigurationInAppNotification
|
|
filterSettings - SaveStaffConfigConfigurationFilterSettings
|
|
globalSearchBarSettings - SaveStaffConfigConfigurationGlobalSearchBarSettings
|
|
recentlyViewed - SaveStaffConfigConfigurationRecentlyViewed
|
Example
{
"modules": SaveStaffConfigConfigurationModules,
"inAppNotifications": SaveStaffConfigConfigurationInAppNotification,
"filterSettings": SaveStaffConfigConfigurationFilterSettings,
"globalSearchBarSettings": SaveStaffConfigConfigurationGlobalSearchBarSettings,
"recentlyViewed": SaveStaffConfigConfigurationRecentlyViewed
}
SaveStaffConfigConfigurationFilterSettings
Fields
| Input Field | Description |
|---|---|
getHouseholdsFilterSettings - SaveStaffConfigConfigurationFilterSettingsGetHouseholds
|
Example
{
"getHouseholdsFilterSettings": SaveStaffConfigConfigurationFilterSettingsGetHouseholds
}
SaveStaffConfigConfigurationFilterSettingsGetHouseholds
Fields
| Input Field | Description |
|---|---|
showAllClients - Boolean
|
Example
{"showAllClients": true}
SaveStaffConfigConfigurationGlobalSearchBarSettings
Fields
| Input Field | Description |
|---|---|
showAllClients - Boolean
|
Example
{"showAllClients": false}
SaveStaffConfigConfigurationInAppNotification
Fields
| Input Field | Description |
|---|---|
enabled - Boolean
|
Example
{"enabled": true}
SaveStaffConfigConfigurationModuleBestLife
Fields
| Input Field | Description |
|---|---|
enabled - Boolean
|
Example
{"enabled": true}
SaveStaffConfigConfigurationModuleBestLifePlan
Fields
| Input Field | Description |
|---|---|
enabled - Boolean
|
Example
{"enabled": true}
SaveStaffConfigConfigurationModuleGoals
Fields
| Input Field | Description |
|---|---|
enabled - Boolean
|
Example
{"enabled": true}
SaveStaffConfigConfigurationModuleGovernance
Fields
| Input Field | Description |
|---|---|
enabled - Boolean
|
Example
{"enabled": false}
SaveStaffConfigConfigurationModuleHealthAssessment
Fields
| Input Field | Description |
|---|---|
enabled - Boolean
|
Example
{"enabled": false}
SaveStaffConfigConfigurationModuleInvPrefs
Fields
| Input Field | Description |
|---|---|
enabled - Boolean
|
Example
{"enabled": true}
SaveStaffConfigConfigurationModuleLife
Fields
| Input Field | Description |
|---|---|
enabled - Boolean
|
Example
{"enabled": false}
SaveStaffConfigConfigurationModuleStrategies
Fields
| Input Field | Description |
|---|---|
enabled - Boolean
|
Example
{"enabled": false}
SaveStaffConfigConfigurationModuleSurveys
Fields
| Input Field | Description |
|---|---|
enabled - Boolean
|
Example
{"enabled": false}
SaveStaffConfigConfigurationModuleTasks
Fields
| Input Field | Description |
|---|---|
enabled - Boolean
|
Example
{"enabled": false}
SaveStaffConfigConfigurationModuleValues
Fields
| Input Field | Description |
|---|---|
enabled - Boolean
|
Example
{"enabled": true}
SaveStaffConfigConfigurationModuleVault
Fields
| Input Field | Description |
|---|---|
enabled - Boolean
|
Example
{"enabled": false}
SaveStaffConfigConfigurationModuleWealth
Fields
| Input Field | Description |
|---|---|
enabled - Boolean
|
Example
{"enabled": false}
SaveStaffConfigConfigurationModules
Fields
| Input Field | Description |
|---|---|
bestLife - SaveStaffConfigConfigurationModuleBestLife
|
|
bestLifePlan - SaveStaffConfigConfigurationModuleBestLifePlan
|
|
goals - SaveStaffConfigConfigurationModuleGoals
|
|
governance - SaveStaffConfigConfigurationModuleGovernance
|
|
healthAssessment - SaveStaffConfigConfigurationModuleHealthAssessment
|
|
invPrefs - SaveStaffConfigConfigurationModuleInvPrefs
|
|
life - SaveStaffConfigConfigurationModuleLife
|
|
strategies - SaveStaffConfigConfigurationModuleStrategies
|
|
surveys - SaveStaffConfigConfigurationModuleSurveys
|
|
tasks - SaveStaffConfigConfigurationModuleTasks
|
|
values - SaveStaffConfigConfigurationModuleValues
|
|
vault - SaveStaffConfigConfigurationModuleVault
|
|
wealth - SaveStaffConfigConfigurationModuleWealth
|
Example
{
"bestLife": SaveStaffConfigConfigurationModuleBestLife,
"bestLifePlan": SaveStaffConfigConfigurationModuleBestLifePlan,
"goals": SaveStaffConfigConfigurationModuleGoals,
"governance": SaveStaffConfigConfigurationModuleGovernance,
"healthAssessment": SaveStaffConfigConfigurationModuleHealthAssessment,
"invPrefs": SaveStaffConfigConfigurationModuleInvPrefs,
"life": SaveStaffConfigConfigurationModuleLife,
"strategies": SaveStaffConfigConfigurationModuleStrategies,
"surveys": SaveStaffConfigConfigurationModuleSurveys,
"tasks": SaveStaffConfigConfigurationModuleTasks,
"values": SaveStaffConfigConfigurationModuleValues,
"vault": SaveStaffConfigConfigurationModuleVault,
"wealth": SaveStaffConfigConfigurationModuleWealth
}
SaveStaffConfigConfigurationRecentlyViewed
Fields
| Input Field | Description |
|---|---|
households - [SaveStaffConfigConfigurationRecentlyViewedHousehold]
|
Example
{
"households": [
SaveStaffConfigConfigurationRecentlyViewedHousehold
]
}
SaveStaffConfigConfigurationRecentlyViewedClientAvatar
SaveStaffConfigConfigurationRecentlyViewedHousehold
Fields
| Input Field | Description |
|---|---|
householdId - Int
|
|
householdName - String
|
|
avatars - [SaveStaffConfigConfigurationRecentlyViewedClientAvatar]
|
Example
{
"householdId": 123,
"householdName": "abc123",
"avatars": [
SaveStaffConfigConfigurationRecentlyViewedClientAvatar
]
}
SaveStaffInput
Fields
| Input Field | Description |
|---|---|
staffId - Int
|
|
role - String
|
|
type - String
|
|
title - String
|
|
emailAddress - String
|
|
firstName - String
|
|
middleName - String
|
|
lastName - String
|
|
mobileNumber - String
|
|
practiceOfficeId - String
|
|
practiceName - String
|
|
practiceEmail - String
|
|
country - String
|
|
externalId - String
|
|
externalSystem - String
|
Example
{
"staffId": 123,
"role": "abc123",
"type": "xyz789",
"title": "xyz789",
"emailAddress": "abc123",
"firstName": "abc123",
"middleName": "xyz789",
"lastName": "abc123",
"mobileNumber": "abc123",
"practiceOfficeId": "xyz789",
"practiceName": "abc123",
"practiceEmail": "abc123",
"country": "xyz789",
"externalId": "abc123",
"externalSystem": "abc123"
}
SaveStaffOutput
SaveSuperBeneficiaryInput
Fields
| Input Field | Description |
|---|---|
inviteClientId - Int
|
|
inviteCode - String
|
|
practiceId - Int
|
|
superBeneficiaryId - Int
|
|
legalEntityId - Int
|
|
isPrimary - Boolean
|
|
assetId - Int
|
|
name - String
|
|
relation - String
|
|
nominated - Boolean
|
|
beneficiaryType - String
|
|
ends - String
|
|
amount - Float
|
|
percent - Float
|
|
estate - String
|
|
estateAmount - Float
|
|
estateBps - Float
|
|
notes - String
|
|
clientNotes - String
|
|
partnerNotes - String
|
|
confidentialNotes - String
|
Example
{
"inviteClientId": 987,
"inviteCode": "abc123",
"practiceId": 123,
"superBeneficiaryId": 987,
"legalEntityId": 123,
"isPrimary": false,
"assetId": 123,
"name": "xyz789",
"relation": "abc123",
"nominated": true,
"beneficiaryType": "xyz789",
"ends": "abc123",
"amount": 987.65,
"percent": 123.45,
"estate": "xyz789",
"estateAmount": 987.65,
"estateBps": 987.65,
"notes": "xyz789",
"clientNotes": "xyz789",
"partnerNotes": "abc123",
"confidentialNotes": "abc123"
}
SaveSurveyInput
SaveSurveyOutput
SaveTaskInput
Fields
| Input Field | Description |
|---|---|
task - TaskInput!
|
Example
{"task": TaskInput}
SaveTasksInput
Fields
| Input Field | Description |
|---|---|
tasks - [TaskInput!]!
|
Example
{"tasks": [TaskInput]}
SaveTaxDetailsInput
Example
{
"inviteClientId": 987,
"inviteCode": "abc123",
"practiceId": 123,
"taxDetailsId": 123,
"clientId": 987,
"tfn": "xyz789",
"countryCodeTax": "xyz789",
"stateCodeTax": "abc123",
"familyTaxBenefit": true,
"notes": "abc123",
"confidentialNotes": "xyz789"
}
SaveTaxPlanningInput
Example
{
"inviteClientId": 987,
"inviteCode": "abc123",
"practiceId": 987,
"taxPlanningId": 123,
"householdId": 987,
"clientId": 987,
"legalEntityId": 123,
"significantChangesImpact": true,
"description": "abc123"
}
SaveTrustBeneficiaryInput
Fields
| Input Field | Description |
|---|---|
inviteClientId - Int
|
|
inviteCode - String
|
|
practiceId - Int
|
|
trustBeneficiaryId - Int
|
|
legalEntityId - Int!
|
|
isPrimary - Boolean
|
|
firstName - String
|
|
middleName - String
|
|
lastName - String
|
|
companyName - String
|
|
nominatedPercentage - Float
|
|
notes - String
|
|
clientNotes - String
|
|
partnerNotes - String
|
|
confidentialNotes - String
|
Example
{
"inviteClientId": 123,
"inviteCode": "xyz789",
"practiceId": 987,
"trustBeneficiaryId": 987,
"legalEntityId": 123,
"isPrimary": true,
"firstName": "xyz789",
"middleName": "abc123",
"lastName": "abc123",
"companyName": "xyz789",
"nominatedPercentage": 123.45,
"notes": "abc123",
"clientNotes": "abc123",
"partnerNotes": "xyz789",
"confidentialNotes": "abc123"
}
SaveTrusteeInput
Fields
| Input Field | Description |
|---|---|
inviteClientId - Int
|
|
inviteCode - String
|
|
practiceId - Int
|
|
trusteeId - Int
|
|
legalEntityId - Int!
|
|
trusteeType - String!
|
|
firstName - String
|
|
middleName - String
|
|
lastName - String
|
|
companyName - String
|
|
dateAppointed - String
|
|
notes - String
|
|
clientNotes - String
|
|
partnerNotes - String
|
|
confidentialNotes - String
|
Example
{
"inviteClientId": 987,
"inviteCode": "xyz789",
"practiceId": 987,
"trusteeId": 987,
"legalEntityId": 123,
"trusteeType": "abc123",
"firstName": "abc123",
"middleName": "xyz789",
"lastName": "abc123",
"companyName": "abc123",
"dateAppointed": "abc123",
"notes": "xyz789",
"clientNotes": "abc123",
"partnerNotes": "xyz789",
"confidentialNotes": "abc123"
}
SavingsRegularity
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"O"
SearchClient
Example
{
"id": 987,
"firstName": "xyz789",
"middleName": "xyz789",
"lastName": "xyz789",
"goalCount": 987,
"taskCount": 987,
"register": false,
"wellnessScore": 123.45,
"lastLogin": "abc123",
"moduleStates": [SearchModuleState]
}
SearchClientSupportData
Fields
| Field Name | Description |
|---|---|
clientId - String!
|
|
contactDetailsId - String
|
|
firstName - String!
|
|
lastName - String!
|
|
email - String!
|
|
mobileNumber - String
|
|
isActive - Boolean!
|
|
type - String!
|
|
dob - String
|
|
externalId - String
|
|
externalSystem - String
|
|
lastLogin - String
|
|
billableStart - String
|
|
billableTrigger - String!
|
|
householdId - String!
|
|
householdName - String!
|
|
householdIsTest - String!
|
|
isClientRegistered - String
|
|
staffId - String
|
|
staffFirstName - String
|
|
staffLastName - String
|
|
staffExternalId - String
|
|
staffExternalSystem - String
|
|
practiceOfficeId - String
|
|
practiceOfficeName - String
|
|
practiceId - String!
|
|
practiceName - String!
|
|
deleted - String
|
|
deletedBy - String
|
|
created - String!
|
|
createdBy - String
|
|
updated - String!
|
|
updatedBy - String
|
Example
{
"clientId": "abc123",
"contactDetailsId": "xyz789",
"firstName": "xyz789",
"lastName": "xyz789",
"email": "xyz789",
"mobileNumber": "xyz789",
"isActive": false,
"type": "xyz789",
"dob": "xyz789",
"externalId": "xyz789",
"externalSystem": "abc123",
"lastLogin": "xyz789",
"billableStart": "xyz789",
"billableTrigger": "xyz789",
"householdId": "abc123",
"householdName": "xyz789",
"householdIsTest": "xyz789",
"isClientRegistered": "abc123",
"staffId": "abc123",
"staffFirstName": "abc123",
"staffLastName": "abc123",
"staffExternalId": "xyz789",
"staffExternalSystem": "abc123",
"practiceOfficeId": "xyz789",
"practiceOfficeName": "abc123",
"practiceId": "abc123",
"practiceName": "abc123",
"deleted": "xyz789",
"deletedBy": "abc123",
"created": "abc123",
"createdBy": "abc123",
"updated": "abc123",
"updatedBy": "xyz789"
}
SearchClientSupportInput
SearchClientSupportOutput
Fields
| Field Name | Description |
|---|---|
searchResult - [SearchClientSupportData]
|
Example
{"searchResult": [SearchClientSupportData]}
SearchHousehold
Fields
| Field Name | Description |
|---|---|
id - Int!
|
|
name - String
|
|
practiceSegmentationId - Int
|
|
clients - [SearchClient]
|
Example
{
"id": 123,
"name": "xyz789",
"practiceSegmentationId": 123,
"clients": [SearchClient]
}
SearchILCNInput
Fields
| Input Field | Description |
|---|---|
searchString - String
|
Example
{"searchString": "abc123"}
SearchILCNOutput
Fields
| Field Name | Description |
|---|---|
ilClients - [ILClient]
|
Example
{"ilClients": [ILClient]}
SearchInput
Example
{
"filterField": "xyz789",
"filter": "abc123",
"searchAll": true,
"sortField": "xyz789",
"sortOrder": "xyz789",
"page": 123,
"pageSize": 123,
"includedTypes": ["abc123"],
"excludedTypes": ["xyz789"],
"range": "xyz789"
}
SearchModuleState
SearchPracticeData
Fields
| Field Name | Description |
|---|---|
practiceName - String!
|
|
practiceHomeLocale - String
|
|
practiceId - String!
|
|
practiceCodeInUUID - String
|
|
practiceAbn - String
|
|
practiceLegalName - String
|
|
practiceContractStart - String
|
|
practiceContractPeriod - String
|
|
practiceConfigID - String
|
|
practicePackageName - String!
|
|
practiceWhitelabelEnabled - String
|
|
practiceStatus - String
|
|
createdBy - String
|
|
created - String!
|
|
updatedBy - String
|
|
updated - String!
|
|
TCVersion - String
|
Example
{
"practiceName": "abc123",
"practiceHomeLocale": "xyz789",
"practiceId": "abc123",
"practiceCodeInUUID": "xyz789",
"practiceAbn": "xyz789",
"practiceLegalName": "abc123",
"practiceContractStart": "xyz789",
"practiceContractPeriod": "xyz789",
"practiceConfigID": "abc123",
"practicePackageName": "xyz789",
"practiceWhitelabelEnabled": "abc123",
"practiceStatus": "abc123",
"createdBy": "abc123",
"created": "xyz789",
"updatedBy": "xyz789",
"updated": "abc123",
"TCVersion": "abc123"
}
SearchPracticeInput
Fields
| Input Field | Description |
|---|---|
practiceName - String
|
Example
{"practiceName": "xyz789"}
SearchPracticeLogoData
Example
{
"practiceLogoId": "xyz789",
"practiceId": "xyz789",
"practiceLogoType": "abc123",
"practiceLogos3Path": "abc123",
"createdBy": "xyz789",
"created": "abc123",
"updatedBy": "xyz789",
"updated": "abc123"
}
SearchPracticeLogoInput
Fields
| Input Field | Description |
|---|---|
practiceLogoId - Int
|
Example
{"practiceLogoId": 987}
SearchPracticeLogoOutput
Fields
| Field Name | Description |
|---|---|
searchResult - [SearchPracticeLogoData]
|
Example
{"searchResult": [SearchPracticeLogoData]}
SearchPracticeOfficeData
Fields
| Field Name | Description |
|---|---|
practiceId - String!
|
|
practiceOfficeId - String!
|
|
addressId - String
|
|
addressLine1 - String
|
|
addressLine2 - String
|
|
addressSuburb - String
|
|
addressPostcode - String
|
|
addressState - String
|
|
addressCountry - String
|
|
practiceOfficeName - String!
|
|
contactDetailsId - String
|
|
emailAddress - String
|
|
mobileNumber - String
|
|
createdBy - String
|
|
created - String!
|
|
updatedBy - String
|
|
updated - String!
|
Example
{
"practiceId": "abc123",
"practiceOfficeId": "xyz789",
"addressId": "xyz789",
"addressLine1": "abc123",
"addressLine2": "xyz789",
"addressSuburb": "xyz789",
"addressPostcode": "abc123",
"addressState": "xyz789",
"addressCountry": "abc123",
"practiceOfficeName": "xyz789",
"contactDetailsId": "xyz789",
"emailAddress": "xyz789",
"mobileNumber": "abc123",
"createdBy": "xyz789",
"created": "abc123",
"updatedBy": "xyz789",
"updated": "xyz789"
}
SearchPracticeOfficeInput
Fields
| Input Field | Description |
|---|---|
practiceId - Int
|
Example
{"practiceId": 123}
SearchPracticeOfficeOutput
Fields
| Field Name | Description |
|---|---|
searchResult - [SearchPracticeOfficeData]
|
Example
{"searchResult": [SearchPracticeOfficeData]}
SearchPracticeOutput
Fields
| Field Name | Description |
|---|---|
searchResult - [SearchPracticeData]
|
Example
{"searchResult": [SearchPracticeData]}
SearchResult
Fields
| Field Name | Description |
|---|---|
pagination - Pagination
|
|
results - [SearchResultUnion]
|
Example
{
"pagination": Pagination,
"results": [SearchHousehold]
}
SearchResultUnion
Types
| Union Types |
|---|
Example
SearchHousehold
SearchStaffSupportData
Fields
| Field Name | Description |
|---|---|
staffId - String!
|
|
firstName - String!
|
|
lastName - String!
|
|
email - String!
|
|
mobileNumber - String!
|
|
role - String
|
|
isActive - Boolean
|
|
externalId - String
|
|
externalSystem - String
|
|
contactDetailsId - String!
|
|
practiceOfficeId - String!
|
|
practiceId - String!
|
|
practiceName - String!
|
|
lastLogin - String
|
|
created - String!
|
|
createdBy - String
|
|
updated - String!
|
|
updatedBy - String
|
Example
{
"staffId": "abc123",
"firstName": "xyz789",
"lastName": "abc123",
"email": "abc123",
"mobileNumber": "xyz789",
"role": "abc123",
"isActive": true,
"externalId": "xyz789",
"externalSystem": "xyz789",
"contactDetailsId": "abc123",
"practiceOfficeId": "abc123",
"practiceId": "abc123",
"practiceName": "xyz789",
"lastLogin": "xyz789",
"created": "abc123",
"createdBy": "abc123",
"updated": "xyz789",
"updatedBy": "abc123"
}
SearchStaffSupportInput
SearchStaffSupportOutput
Fields
| Field Name | Description |
|---|---|
searchResult - [SearchStaffSupportData]
|
Example
{"searchResult": [SearchStaffSupportData]}
SearchYourVaultContentsInput
SearchYourVaultContentsOutput
Fields
| Field Name | Description |
|---|---|
vaultFiles - [YourVaultFileInfo]
|
|
totalCount - Int
|
Example
{"vaultFiles": [YourVaultFileInfo], "totalCount": 123}
SearchableAggregateBucketResult
Fields
| Field Name | Description |
|---|---|
buckets - [SearchableAggregateBucketResultItem]
|
Example
{"buckets": [SearchableAggregateBucketResultItem]}
SearchableAggregateBucketResultItem
SearchableAggregateGenericResult
Types
| Union Types |
|---|
Example
SearchableAggregateScalarResult
SearchableAggregateResult
Fields
| Field Name | Description |
|---|---|
name - String!
|
|
result - SearchableAggregateGenericResult
|
Example
{
"name": "xyz789",
"result": SearchableAggregateScalarResult
}
SearchableAggregateScalarResult
Fields
| Field Name | Description |
|---|---|
value - Float!
|
Example
{"value": 123.45}
SearchableAggregateType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"terms"
SearchableBooleanFilterInput
SearchableFloatFilterInput
SearchableIDFilterInput
Example
{
"ne": 4,
"gt": 4,
"lt": "4",
"gte": 4,
"lte": "4",
"eq": 4,
"match": 4,
"matchPhrase": "4",
"matchPhrasePrefix": "4",
"multiMatch": "4",
"exists": false,
"wildcard": "4",
"regexp": "4",
"range": [4]
}
SearchableIntFilterInput
SearchableQueryMap
Fields
| Input Field | Description |
|---|---|
search - String
|
Example
{"search": "abc123"}
SearchableSecurityAggregateField
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"id"
SearchableSecurityAggregationInput
Fields
| Input Field | Description |
|---|---|
name - String!
|
|
type - SearchableAggregateType!
|
|
field - SearchableSecurityAggregateField!
|
Example
{
"name": "xyz789",
"type": "terms",
"field": "id"
}
SearchableSecurityConnection
Fields
| Field Name | Description |
|---|---|
items - [Security]!
|
|
nextToken - String
|
|
total - Int
|
|
aggregateItems - [SearchableAggregateResult]!
|
Example
{
"items": [Security],
"nextToken": "xyz789",
"total": 987,
"aggregateItems": [SearchableAggregateResult]
}
SearchableSecurityFilterInput
Fields
| Input Field | Description |
|---|---|
id - SearchableIDFilterInput
|
|
assetClassName - SearchableStringFilterInput
|
|
code - SearchableStringFilterInput
|
|
description - SearchableStringFilterInput
|
|
exchange - SearchableStringFilterInput
|
|
msCode - SearchableStringFilterInput
|
|
msNonFundCode - SearchableStringFilterInput
|
|
name - SearchableStringFilterInput
|
|
securityId - SearchableIntFilterInput
|
|
securityType - SearchableStringFilterInput
|
|
securityGroup - SearchableStringFilterInput
|
|
ticker - SearchableStringFilterInput
|
|
createdAt - SearchableStringFilterInput
|
|
updatedAt - SearchableStringFilterInput
|
|
and - [SearchableSecurityFilterInput]
|
|
or - [SearchableSecurityFilterInput]
|
|
not - SearchableSecurityFilterInput
|
Example
{
"id": SearchableIDFilterInput,
"assetClassName": SearchableStringFilterInput,
"code": SearchableStringFilterInput,
"description": SearchableStringFilterInput,
"exchange": SearchableStringFilterInput,
"msCode": SearchableStringFilterInput,
"msNonFundCode": SearchableStringFilterInput,
"name": SearchableStringFilterInput,
"securityId": SearchableIntFilterInput,
"securityType": SearchableStringFilterInput,
"securityGroup": SearchableStringFilterInput,
"ticker": SearchableStringFilterInput,
"createdAt": SearchableStringFilterInput,
"updatedAt": SearchableStringFilterInput,
"and": [SearchableSecurityFilterInput],
"or": [SearchableSecurityFilterInput],
"not": SearchableSecurityFilterInput
}
SearchableSecuritySortInput
Fields
| Input Field | Description |
|---|---|
field - SearchableSecuritySortableFields
|
|
direction - SearchableSortDirection
|
Example
{"field": "id", "direction": "asc"}
SearchableSecuritySortableFields
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"id"
SearchableSortDirection
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"asc"
SearchableStringFilterInput
Example
{
"ne": "xyz789",
"gt": "abc123",
"lt": "xyz789",
"gte": "abc123",
"lte": "abc123",
"eq": "abc123",
"match": "xyz789",
"matchPhrase": "xyz789",
"matchPhrasePrefix": "xyz789",
"multiMatch": "xyz789",
"exists": true,
"wildcard": "abc123",
"regexp": "xyz789",
"range": ["abc123"]
}
Sector
Security
Example
{
"id": 4,
"assetClassName": "xyz789",
"code": "abc123",
"description": "abc123",
"exchange": "xyz789",
"msCode": "abc123",
"msNonFundCode": "xyz789",
"name": "abc123",
"securityId": 987,
"securityType": "abc123",
"securityGroup": "xyz789",
"ticker": "abc123",
"createdAt": AWSDateTime,
"updatedAt": AWSDateTime
}
SecurityGroup
SecurityGroupOutput
Fields
| Field Name | Description |
|---|---|
securityGroups - [SecurityGroup]
|
Example
{"securityGroups": [SecurityGroup]}
SecurityType
SecurityTypeOutput
Fields
| Field Name | Description |
|---|---|
securityTypes - [SecurityType]
|
Example
{"securityTypes": [SecurityType]}
SensitiveDetailsOutput
Example
{
"sensitiveDetailsId": 123,
"clientId": 987,
"isPep": false,
"isVulnerable": true,
"notes": "abc123",
"confidentialNotes": "xyz789",
"createdBy": "xyz789",
"created": "abc123",
"updatedBy": "xyz789",
"updated": "abc123"
}
SetPracticeBillingInput
Fields
| Input Field | Description |
|---|---|
billingPaymentMethodId - String
|
|
billingUsePracticeOfficeAddress - Boolean
|
|
billingFullName - String
|
|
billingEmailAddress - String
|
|
billingBusinessName - String
|
|
billingAddressLine1 - String
|
|
billingAddressLine2 - String
|
|
billingSuburb - String
|
|
billingPostCode - String
|
|
billingState - String
|
|
billingCountry - String
|
Example
{
"billingPaymentMethodId": "xyz789",
"billingUsePracticeOfficeAddress": false,
"billingFullName": "xyz789",
"billingEmailAddress": "abc123",
"billingBusinessName": "abc123",
"billingAddressLine1": "abc123",
"billingAddressLine2": "xyz789",
"billingSuburb": "abc123",
"billingPostCode": "abc123",
"billingState": "xyz789",
"billingCountry": "xyz789"
}
SetPracticeLogoInput
ShowStaffCognitoUserGroupInput
Fields
| Input Field | Description |
|---|---|
currentEmail - String!
|
Example
{"currentEmail": "abc123"}
ShowStaffCognitoUserGroupOutput
Fields
| Field Name | Description |
|---|---|
staffRdsRole - String!
|
|
enabledOrDisabled - String!
|
|
firstUserGroup - String!
|
|
secondUserGroup - String!
|
|
thirdUserGroup - String!
|
|
fourthUserGroup - String!
|
|
fifthUserGroup - String!
|
|
sixthUserGroup - String!
|
|
seventhUserGroup - String!
|
|
eighthUserGroup - String!
|
|
ninthUserGroup - String!
|
Example
{
"staffRdsRole": "abc123",
"enabledOrDisabled": "abc123",
"firstUserGroup": "abc123",
"secondUserGroup": "xyz789",
"thirdUserGroup": "xyz789",
"fourthUserGroup": "abc123",
"fifthUserGroup": "xyz789",
"sixthUserGroup": "abc123",
"seventhUserGroup": "xyz789",
"eighthUserGroup": "xyz789",
"ninthUserGroup": "abc123"
}
SignUpPracticeInput
Fields
| Input Field | Description |
|---|---|
recaptchaChallengeAnswer - String!
|
|
dealerGroupName - String
|
|
dealerGroupAbn - String
|
|
dealerGroupAfsl - String
|
|
dealerGroupAfslName - String
|
|
dealerGroupLegalName - String
|
|
practiceName - String
|
|
practiceAbn - String
|
|
practiceLegalName - String!
|
|
practiceStatus - String
|
|
practiceContractPeriod - Int
|
|
practicePackage - String
|
|
practiceUsesExternalDomain - Boolean
|
|
practiceOfficeEmailAddress - String!
|
|
practiceOfficeMobileNumber - String
|
|
practiceOfficeFaxNumber - String
|
|
practiceOfficePhoneNumber - String
|
|
practiceOfficeAddressLine1 - String!
|
|
practiceOfficeAddressLine2 - String
|
|
practiceOfficeSuburb - String!
|
|
practiceOfficePostCode - String!
|
|
practiceOfficeState - String!
|
|
practiceOfficeCountry - String
|
|
practiceManagerTitle - String
|
|
practiceManagerFirstName - String!
|
|
practiceManagerMiddleName - String
|
|
practiceManagerLastName - String!
|
|
practiceManagerEmailAddress - String!
|
|
practiceManagerMobileNumber - String
|
|
practiceManagerFaxNumber - String
|
|
practiceManagerPhoneNumber - String
|
|
billingPaymentMethodId - String
|
|
billingUsePracticeOfficeAddress - Boolean
|
|
billingFullName - String
|
|
billingEmailAddress - String
|
|
billingBusinessName - String
|
|
billingAddressLine1 - String
|
|
billingAddressLine2 - String
|
|
billingSuburb - String
|
|
billingPostCode - String
|
|
billingState - String
|
|
billingCountry - String
|
|
billingFrequency - String
|
|
numberOfAdviserLicenses - Int
|
|
numberOfSupportLicenses - Int
|
|
numberOfHouseholdLicenses - Int
|
|
includeCRMIntegration - Boolean
|
|
includeWhiteLabelling - Boolean
|
Example
{
"recaptchaChallengeAnswer": "abc123",
"dealerGroupName": "abc123",
"dealerGroupAbn": "abc123",
"dealerGroupAfsl": "xyz789",
"dealerGroupAfslName": "xyz789",
"dealerGroupLegalName": "xyz789",
"practiceName": "xyz789",
"practiceAbn": "abc123",
"practiceLegalName": "xyz789",
"practiceStatus": "xyz789",
"practiceContractPeriod": 123,
"practicePackage": "abc123",
"practiceUsesExternalDomain": false,
"practiceOfficeEmailAddress": "abc123",
"practiceOfficeMobileNumber": "abc123",
"practiceOfficeFaxNumber": "abc123",
"practiceOfficePhoneNumber": "abc123",
"practiceOfficeAddressLine1": "abc123",
"practiceOfficeAddressLine2": "xyz789",
"practiceOfficeSuburb": "abc123",
"practiceOfficePostCode": "xyz789",
"practiceOfficeState": "xyz789",
"practiceOfficeCountry": "xyz789",
"practiceManagerTitle": "xyz789",
"practiceManagerFirstName": "xyz789",
"practiceManagerMiddleName": "abc123",
"practiceManagerLastName": "abc123",
"practiceManagerEmailAddress": "abc123",
"practiceManagerMobileNumber": "xyz789",
"practiceManagerFaxNumber": "abc123",
"practiceManagerPhoneNumber": "abc123",
"billingPaymentMethodId": "abc123",
"billingUsePracticeOfficeAddress": true,
"billingFullName": "xyz789",
"billingEmailAddress": "xyz789",
"billingBusinessName": "abc123",
"billingAddressLine1": "abc123",
"billingAddressLine2": "xyz789",
"billingSuburb": "abc123",
"billingPostCode": "abc123",
"billingState": "xyz789",
"billingCountry": "abc123",
"billingFrequency": "xyz789",
"numberOfAdviserLicenses": 987,
"numberOfSupportLicenses": 987,
"numberOfHouseholdLicenses": 987,
"includeCRMIntegration": false,
"includeWhiteLabelling": false
}
SignUpPracticeTrialInput
Example
{
"recaptchaChallengeAnswer": "abc123",
"practiceOfficeCountry": "abc123",
"practiceManagerFirstName": "xyz789",
"practiceManagerLastName": "xyz789",
"practiceManagerEmailAddress": "abc123",
"practiceManagerMobileNumber": "abc123"
}
SoftDeleteClientInput
Fields
| Input Field | Description |
|---|---|
clientId - Int
|
Example
{"clientId": 123}
SoftDeleteClientOutput
SortDirection
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"ASC"
SortInput
Fields
| Input Field | Description |
|---|---|
field - String!
|
|
direction - SortDirection
|
Example
{"field": "xyz789", "direction": "ASC"}
SortVaultFoldersInput
Staff
Fields
| Field Name | Description |
|---|---|
staffId - Int!
|
|
practiceOfficeId - Int
|
|
iamId - String
|
|
title - String!
|
|
firstName - String!
|
|
middleName - String
|
|
lastName - String!
|
|
role - String!
|
|
staffHouseholdAccess - [StaffHouseholdAccess]
|
|
digitalSignatureS3Path - String
|
|
contactDetails - ContactDetails
|
|
externalId - String
|
|
externalSystem - String
|
|
createdBy - String!
|
|
created - String!
|
|
updatedBy - String!
|
|
updated - String!
|
Example
{
"staffId": 123,
"practiceOfficeId": 123,
"iamId": "abc123",
"title": "abc123",
"firstName": "abc123",
"middleName": "abc123",
"lastName": "xyz789",
"role": "abc123",
"staffHouseholdAccess": [StaffHouseholdAccess],
"digitalSignatureS3Path": "xyz789",
"contactDetails": ContactDetails,
"externalId": "abc123",
"externalSystem": "abc123",
"createdBy": "abc123",
"created": "abc123",
"updatedBy": "abc123",
"updated": "xyz789"
}
StaffApprovalItem
StaffConfig
Fields
| Field Name | Description |
|---|---|
staffConfigId - Int
|
|
staffId - Int
|
|
configuration - StaffConfigConfiguration
|
Example
{
"staffConfigId": 123,
"staffId": 123,
"configuration": StaffConfigConfiguration
}
StaffConfigConfiguration
Fields
| Field Name | Description |
|---|---|
modules - StaffConfigConfigurationModules
|
|
inAppNotifications - StaffConfigConfigurationInAppNotification
|
|
filterSettings - StaffConfigConfigurationFilterSettings
|
|
globalSearchBarSettings - StaffConfigConfigurationGlobalSearchBarSettings
|
|
recentlyViewed - StaffConfigConfigurationRecentlyViewed
|
Example
{
"modules": StaffConfigConfigurationModules,
"inAppNotifications": StaffConfigConfigurationInAppNotification,
"filterSettings": StaffConfigConfigurationFilterSettings,
"globalSearchBarSettings": StaffConfigConfigurationGlobalSearchBarSettings,
"recentlyViewed": StaffConfigConfigurationRecentlyViewed
}
StaffConfigConfigurationFilterSettings
Fields
| Field Name | Description |
|---|---|
getHouseholdsFilterSettings - StaffConfigConfigurationFilterSettingsGetHouseholds
|
Example
{
"getHouseholdsFilterSettings": StaffConfigConfigurationFilterSettingsGetHouseholds
}
StaffConfigConfigurationFilterSettingsGetHouseholds
Fields
| Field Name | Description |
|---|---|
showAllClients - Boolean
|
Example
{"showAllClients": false}
StaffConfigConfigurationGlobalSearchBarSettings
Fields
| Field Name | Description |
|---|---|
showAllClients - Boolean
|
Example
{"showAllClients": true}
StaffConfigConfigurationInAppNotification
Fields
| Field Name | Description |
|---|---|
enabled - Boolean
|
Example
{"enabled": true}
StaffConfigConfigurationModuleBestLife
Fields
| Field Name | Description |
|---|---|
enabled - Boolean
|
Example
{"enabled": true}
StaffConfigConfigurationModuleBestLifePlan
Fields
| Field Name | Description |
|---|---|
enabled - Boolean
|
Example
{"enabled": false}
StaffConfigConfigurationModuleGoals
Fields
| Field Name | Description |
|---|---|
enabled - Boolean
|
Example
{"enabled": false}
StaffConfigConfigurationModuleGovernance
Fields
| Field Name | Description |
|---|---|
enabled - Boolean
|
Example
{"enabled": false}
StaffConfigConfigurationModuleHealthAssessment
Fields
| Field Name | Description |
|---|---|
enabled - Boolean
|
Example
{"enabled": true}
StaffConfigConfigurationModuleInvPrefs
Fields
| Field Name | Description |
|---|---|
enabled - Boolean
|
Example
{"enabled": false}
StaffConfigConfigurationModuleLife
Fields
| Field Name | Description |
|---|---|
enabled - Boolean
|
Example
{"enabled": true}
StaffConfigConfigurationModuleStrategies
Fields
| Field Name | Description |
|---|---|
enabled - Boolean
|
Example
{"enabled": false}
StaffConfigConfigurationModuleSurveys
Fields
| Field Name | Description |
|---|---|
enabled - Boolean
|
Example
{"enabled": false}
StaffConfigConfigurationModuleTasks
Fields
| Field Name | Description |
|---|---|
enabled - Boolean
|
Example
{"enabled": false}
StaffConfigConfigurationModuleValues
Fields
| Field Name | Description |
|---|---|
enabled - Boolean
|
Example
{"enabled": false}
StaffConfigConfigurationModuleVault
Fields
| Field Name | Description |
|---|---|
enabled - Boolean
|
Example
{"enabled": false}
StaffConfigConfigurationModuleWealth
Fields
| Field Name | Description |
|---|---|
enabled - Boolean
|
Example
{"enabled": false}
StaffConfigConfigurationModules
Fields
| Field Name | Description |
|---|---|
bestLife - StaffConfigConfigurationModuleBestLife
|
|
bestLifePlan - StaffConfigConfigurationModuleBestLifePlan
|
|
goals - StaffConfigConfigurationModuleGoals
|
|
governance - StaffConfigConfigurationModuleGovernance
|
|
healthAssessment - StaffConfigConfigurationModuleHealthAssessment
|
|
invPrefs - StaffConfigConfigurationModuleInvPrefs
|
|
life - StaffConfigConfigurationModuleLife
|
|
strategies - StaffConfigConfigurationModuleStrategies
|
|
surveys - StaffConfigConfigurationModuleSurveys
|
|
tasks - StaffConfigConfigurationModuleTasks
|
|
values - StaffConfigConfigurationModuleValues
|
|
vault - StaffConfigConfigurationModuleVault
|
|
wealth - StaffConfigConfigurationModuleWealth
|
Example
{
"bestLife": StaffConfigConfigurationModuleBestLife,
"bestLifePlan": StaffConfigConfigurationModuleBestLifePlan,
"goals": StaffConfigConfigurationModuleGoals,
"governance": StaffConfigConfigurationModuleGovernance,
"healthAssessment": StaffConfigConfigurationModuleHealthAssessment,
"invPrefs": StaffConfigConfigurationModuleInvPrefs,
"life": StaffConfigConfigurationModuleLife,
"strategies": StaffConfigConfigurationModuleStrategies,
"surveys": StaffConfigConfigurationModuleSurveys,
"tasks": StaffConfigConfigurationModuleTasks,
"values": StaffConfigConfigurationModuleValues,
"vault": StaffConfigConfigurationModuleVault,
"wealth": StaffConfigConfigurationModuleWealth
}
StaffConfigConfigurationRecentlyViewed
Fields
| Field Name | Description |
|---|---|
households - [StaffConfigConfigurationRecentlyViewedHousehold]
|
Example
{
"households": [
StaffConfigConfigurationRecentlyViewedHousehold
]
}
StaffConfigConfigurationRecentlyViewedClientAvatar
StaffConfigConfigurationRecentlyViewedHousehold
Fields
| Field Name | Description |
|---|---|
householdId - Int
|
|
householdName - String
|
|
avatars - [StaffConfigConfigurationRecentlyViewedClientAvatar]
|
Example
{
"householdId": 123,
"householdName": "xyz789",
"avatars": [
StaffConfigConfigurationRecentlyViewedClientAvatar
]
}
StaffHouseholdAccess
Fields
| Field Name | Description |
|---|---|
householdId - Int!
|
|
householdName - String!
|
|
role - HouseholdTeamMemberRole!
|
Example
{
"householdId": 123,
"householdName": "xyz789",
"role": "P1"
}
StepTracker
StepTrackerInput
String
Description
The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
Example
"xyz789"
StripePortalLinks
SubscriptionDataOutput
Fields
| Field Name | Description |
|---|---|
planType - String
|
|
planCost - Float
|
|
planExpiry - String
|
|
professionalLicenseCount - Int
|
|
supportStaffLicenseCount - Int
|
|
professionalLicenseAssignedCount - Int
|
|
supportStaffLicenseAssignedCount - Int
|
|
householdLicenseCount - Int
|
|
includedHouseholdsCount - Int
|
|
billingCycle - String
|
|
subscriptionLength - Int
|
|
whiteLabelling - Boolean
|
Example
{
"planType": "xyz789",
"planCost": 987.65,
"planExpiry": "xyz789",
"professionalLicenseCount": 987,
"supportStaffLicenseCount": 987,
"professionalLicenseAssignedCount": 123,
"supportStaffLicenseAssignedCount": 123,
"householdLicenseCount": 987,
"includedHouseholdsCount": 123,
"billingCycle": "abc123",
"subscriptionLength": 987,
"whiteLabelling": true
}
SuperBeneficiaryOutput
Fields
| Field Name | Description |
|---|---|
superBeneficiaryId - Int!
|
|
legalEntityId - Int
|
|
assetId - Int
|
|
isPrimary - Boolean!
|
|
name - String
|
|
relation - String
|
|
nominated - Boolean
|
|
beneficiaryType - String
|
|
ends - String
|
|
amount - Float
|
|
percent - Float
|
|
estate - String
|
|
estateAmount - Float
|
|
estateBps - Float
|
|
notes - String
|
|
clientNotes - String
|
|
partnerNotes - String
|
|
confidentialNotes - String
|
|
createdBy - String!
|
|
created - String!
|
|
updatedBy - String!
|
|
updated - String!
|
Example
{
"superBeneficiaryId": 123,
"legalEntityId": 987,
"assetId": 987,
"isPrimary": false,
"name": "xyz789",
"relation": "xyz789",
"nominated": true,
"beneficiaryType": "xyz789",
"ends": "xyz789",
"amount": 987.65,
"percent": 987.65,
"estate": "abc123",
"estateAmount": 987.65,
"estateBps": 123.45,
"notes": "abc123",
"clientNotes": "abc123",
"partnerNotes": "xyz789",
"confidentialNotes": "abc123",
"createdBy": "xyz789",
"created": "abc123",
"updatedBy": "abc123",
"updated": "abc123"
}
Survey
Fields
| Field Name | Description |
|---|---|
type - String!
|
|
version - Int
|
|
sections - [SurveySection!]
|
|
parameters - [SurveyParameter!]
|
Example
{
"type": "xyz789",
"version": 987,
"sections": [null],
"parameters": [null]
}
SurveyData
SurveyDataResponseStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"SENT"
SurveyInfo
Fields
| Field Name | Description |
|---|---|
surveyId - String
|
|
surveyName - String
|
|
status - String
|
|
progress - Float
|
|
sessionId - String
|
|
lifeIncludeGoals - Boolean
|
|
lifeIncludeConnections - Boolean
|
|
valuesIncludeLegacy - Boolean
|
|
foundationsShort - Boolean
|
|
foundationsLong - Boolean
|
|
foundationsIncludeDetails - Boolean
|
|
foundationsIncludeInsurance - Boolean
|
|
foundationsIncludeEstatePlanning - Boolean
|
|
foundationsIncludeBusinessPlanning - Boolean
|
|
fhaLongAssessment - Boolean
|
|
fhaShortAssessment - Boolean
|
|
timeToComplete - Int
|
|
createdAt - String
|
|
updateAt - String
|
Example
{
"surveyId": "abc123",
"surveyName": "xyz789",
"status": "xyz789",
"progress": 123.45,
"sessionId": "abc123",
"lifeIncludeGoals": false,
"lifeIncludeConnections": true,
"valuesIncludeLegacy": false,
"foundationsShort": true,
"foundationsLong": false,
"foundationsIncludeDetails": true,
"foundationsIncludeInsurance": false,
"foundationsIncludeEstatePlanning": false,
"foundationsIncludeBusinessPlanning": false,
"fhaLongAssessment": false,
"fhaShortAssessment": true,
"timeToComplete": 987,
"createdAt": "abc123",
"updateAt": "xyz789"
}
SurveyInputParams
Fields
| Input Field | Description |
|---|---|
surveyId - String
|
|
surveyName - String
|
|
lifeIncludeGoals - Boolean
|
|
lifeIncludeConnections - Boolean
|
|
valuesIncludeLegacy - Boolean
|
|
foundationsShort - Boolean
|
|
foundationsLong - Boolean
|
|
foundationsIncludeDetails - Boolean
|
|
foundationsIncludeInsurance - Boolean
|
|
foundationsIncludeEstatePlanning - Boolean
|
|
foundationsIncludeBusinessPlanning - Boolean
|
|
fhaLongAssessment - Boolean
|
|
fhaShortAssessment - Boolean
|
Example
{
"surveyId": "xyz789",
"surveyName": "xyz789",
"lifeIncludeGoals": true,
"lifeIncludeConnections": true,
"valuesIncludeLegacy": false,
"foundationsShort": true,
"foundationsLong": true,
"foundationsIncludeDetails": false,
"foundationsIncludeInsurance": false,
"foundationsIncludeEstatePlanning": true,
"foundationsIncludeBusinessPlanning": true,
"fhaLongAssessment": true,
"fhaShortAssessment": false
}
SurveyMetadata
Fields
| Field Name | Description |
|---|---|
clientFirstName - String
|
|
clientLastName - String
|
|
clientInitials - String
|
|
clientAvatarImageUrl - String
|
|
partnerFirstName - String
|
|
partnerLastName - String
|
|
partnerInitials - String
|
|
partnerAvatarImageUrl - String
|
|
hasPartner - Boolean
|
|
lifeIncludeConnections - Boolean
|
|
lifeIncludeGoals - Boolean
|
|
valuesIncludeLegacy - Boolean
|
|
foundationsShort - Boolean
|
|
foundationsLong - Boolean
|
|
foundationsIncludeDetails - Boolean
|
|
foundationsIncludeInsurance - Boolean
|
|
foundationsIncludeEstatePlanning - Boolean
|
|
foundationsIncludeBusinessPlanning - Boolean
|
|
surveyName - String
|
|
timeToComplete - Int
|
Example
{
"clientFirstName": "abc123",
"clientLastName": "xyz789",
"clientInitials": "xyz789",
"clientAvatarImageUrl": "abc123",
"partnerFirstName": "abc123",
"partnerLastName": "abc123",
"partnerInitials": "abc123",
"partnerAvatarImageUrl": "abc123",
"hasPartner": true,
"lifeIncludeConnections": true,
"lifeIncludeGoals": true,
"valuesIncludeLegacy": true,
"foundationsShort": true,
"foundationsLong": true,
"foundationsIncludeDetails": false,
"foundationsIncludeInsurance": true,
"foundationsIncludeEstatePlanning": false,
"foundationsIncludeBusinessPlanning": false,
"surveyName": "abc123",
"timeToComplete": 987
}
SurveyPage
Fields
| Field Name | Description |
|---|---|
pageKey - String!
|
|
pageType - SurveyPageType!
|
|
pageTitle - String
|
|
pageSubtitle - String
|
|
pageDescription - [String]
|
|
showSectionNumberedList - Boolean
|
|
showPageNumberedList - Boolean
|
|
video - String
|
|
pageFooter - String
|
|
pageFooterCaption - String
|
|
pageShowIf - [SurveyShowIf!]
|
|
questionDisplay - String
|
|
questions - [SurveyQuestion!]
|
Example
{
"pageKey": "abc123",
"pageType": null,
"pageTitle": "abc123",
"pageSubtitle": "abc123",
"pageDescription": ["abc123"],
"showSectionNumberedList": true,
"showPageNumberedList": true,
"video": "xyz789",
"pageFooter": "abc123",
"pageFooterCaption": "abc123",
"pageShowIf": [null],
"questionDisplay": "xyz789",
"questions": [null]
}
SurveyPageType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"INFO"
SurveyParameter
Fields
| Field Name | Description |
|---|---|
parameter - String!
|
Example
{"parameter": "xyz789"}
SurveyQuestion
Fields
| Field Name | Description |
|---|---|
questionId - Int!
|
|
questionKey - String!
|
|
questionType - SurveyQuestionType!
|
|
questionText - String
|
|
questionDescription - [String]
|
|
questionFooter - String
|
|
autocompleteItems - [String!]
|
|
likertScaleNum - Int
|
|
likertScaleStart - Int
|
|
likertScaleMinLabel - String
|
|
likertScaleMidLabel - String
|
|
likertScaleMaxLabel - String
|
|
integerMin - Int
|
|
integerMax - Int
|
|
dateMin - String
|
|
dateMax - String
|
|
required - Boolean
|
|
questionShowIf - [SurveyShowIf!]
|
|
validResponses - [SurveyValidResponse!]
|
Example
{
"questionId": 987,
"questionKey": "abc123",
"questionType": null,
"questionText": "abc123",
"questionDescription": ["abc123"],
"questionFooter": "abc123",
"autocompleteItems": ["abc123"],
"likertScaleNum": 987,
"likertScaleStart": 987,
"likertScaleMinLabel": "abc123",
"likertScaleMidLabel": "xyz789",
"likertScaleMaxLabel": "xyz789",
"integerMin": 987,
"integerMax": 123,
"dateMin": "xyz789",
"dateMax": "xyz789",
"required": true,
"questionShowIf": [null],
"validResponses": [null]
}
SurveyQuestionType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"TILE_SELECT"
SurveyResponseData
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
clientId - Int!
|
|
inviteCode - String!
|
|
householdId - Int
|
|
keyValueData - String
|
|
status - SurveyDataResponseStatus
|
|
surveyId - String
|
|
progress - Float
|
|
createdAt - AWSDateTime!
|
|
updatedAt - AWSDateTime!
|
Example
{
"id": 4,
"clientId": 123,
"inviteCode": "xyz789",
"householdId": 123,
"keyValueData": "abc123",
"status": "SENT",
"surveyId": "xyz789",
"progress": 987.65,
"createdAt": AWSDateTime,
"updatedAt": AWSDateTime
}
SurveyResponseStatus
SurveyResponseValueType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"INT"
SurveySection
Fields
| Field Name | Description |
|---|---|
sectionKey - String!
|
|
sectionName - String
|
|
sectionShowIf - [SurveyShowIf!]
|
|
pages - [SurveyPage!]
|
Example
{
"sectionKey": "xyz789",
"sectionName": "abc123",
"sectionShowIf": [null],
"pages": [null]
}
SurveyShowIf
Fields
| Field Name | Description |
|---|---|
showIfType - SurveyShowIfType!
|
|
showIfKey - String
|
|
showIfValues - [String!]
|
Example
{
"showIfType": null,
"showIfKey": "abc123",
"showIfValues": ["xyz789"]
}
SurveyShowIfType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"PARAMETER"
SurveyValidResponse
Fields
| Field Name | Description |
|---|---|
responseValueType - SurveyResponseValueType
|
|
responseValue - String
|
|
responseLabel - String
|
|
responseIcon - String
|
|
responseDescription - String
|
Example
{
"responseValueType": null,
"responseValue": "xyz789",
"responseLabel": "abc123",
"responseIcon": "abc123",
"responseDescription": "xyz789"
}
TamaracLoadErrors
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
sourceFile - String
|
|
errorMessage - String
|
|
tamaracPayload - String
|
|
accountId - String
|
|
accountNumber - String
|
|
primaryMemberFirstName - String
|
|
primaryMemberLastName - String
|
|
fuzzyRatio - String
|
|
rdsCombinedAddressString - String
|
|
tamaracCombinedAddressString - String
|
|
createdAt - AWSDateTime!
|
|
updatedAt - AWSDateTime!
|
Example
{
"id": "4",
"sourceFile": "abc123",
"errorMessage": "xyz789",
"tamaracPayload": "abc123",
"accountId": "abc123",
"accountNumber": "xyz789",
"primaryMemberFirstName": "abc123",
"primaryMemberLastName": "xyz789",
"fuzzyRatio": "abc123",
"rdsCombinedAddressString": "abc123",
"tamaracCombinedAddressString": "xyz789",
"createdAt": AWSDateTime,
"updatedAt": AWSDateTime
}
TaskInput
Example
{
"id": 987,
"title": "xyz789",
"order": 987,
"description": "xyz789",
"dueDate": "abc123",
"completedDate": "xyz789",
"status": "xyz789",
"assignedToClientId": 987,
"createdForHouseholdId": 123
}
TaskOutput
Example
{
"id": 987,
"title": "abc123",
"order": 987,
"description": "abc123",
"dueDate": "xyz789",
"completedDate": "abc123",
"status": "abc123",
"assignedToClientId": 123,
"createdForHouseholdId": 123,
"createdBy": "abc123",
"created": "xyz789",
"updatedBy": "abc123",
"updated": "abc123"
}
TaxDetailsOutput
Example
{
"taxDetailsId": 123,
"clientId": 123,
"tfn": "xyz789",
"countryCodeTax": "xyz789",
"stateCodeTax": "abc123",
"familyTaxBenefit": false,
"notes": "xyz789",
"confidentialNotes": "abc123",
"createdBy": "abc123",
"created": "xyz789",
"updatedBy": "abc123",
"updated": "abc123"
}
TaxPlanningOutput
Example
{
"taxPlanningId": 987,
"householdId": 123,
"clientId": 987,
"legalEntityId": 987,
"significantChangesImpact": true,
"description": "abc123",
"createdBy": "abc123",
"created": "xyz789",
"updatedBy": "abc123",
"updated": "abc123"
}
TimelineData
Fields
| Field Name | Description |
|---|---|
accountValue - GraphElements
|
|
netInvestments - GraphElements
|
Example
{
"accountValue": GraphElements,
"netInvestments": GraphElements
}
TimestampConfiguration
TrustBeneficiaryOutput
Fields
| Field Name | Description |
|---|---|
trustBeneficiaryId - Int!
|
|
legalEntityId - Int!
|
|
isPrimary - Boolean!
|
|
firstName - String
|
|
middleName - String
|
|
lastName - String
|
|
companyName - String
|
|
nominatedPercentage - Float
|
|
notes - String
|
|
clientNotes - String
|
|
partnerNotes - String
|
|
confidentialNotes - String
|
|
createdBy - String!
|
|
created - String!
|
|
updatedBy - String!
|
|
updated - String!
|
Example
{
"trustBeneficiaryId": 987,
"legalEntityId": 987,
"isPrimary": true,
"firstName": "abc123",
"middleName": "abc123",
"lastName": "xyz789",
"companyName": "abc123",
"nominatedPercentage": 123.45,
"notes": "abc123",
"clientNotes": "abc123",
"partnerNotes": "abc123",
"confidentialNotes": "xyz789",
"createdBy": "xyz789",
"created": "xyz789",
"updatedBy": "xyz789",
"updated": "xyz789"
}
TrusteeOutput
Fields
| Field Name | Description |
|---|---|
trusteeId - Int!
|
|
legalEntityId - Int!
|
|
trusteeType - String!
|
|
firstName - String
|
|
middleName - String
|
|
lastName - String
|
|
companyName - String
|
|
dateAppointed - String
|
|
notes - String
|
|
clientNotes - String
|
|
partnerNotes - String
|
|
confidentialNotes - String
|
|
createdBy - String!
|
|
created - String!
|
|
updatedBy - String!
|
|
updated - String!
|
Example
{
"trusteeId": 123,
"legalEntityId": 123,
"trusteeType": "abc123",
"firstName": "abc123",
"middleName": "abc123",
"lastName": "abc123",
"companyName": "abc123",
"dateAppointed": "xyz789",
"notes": "xyz789",
"clientNotes": "xyz789",
"partnerNotes": "xyz789",
"confidentialNotes": "xyz789",
"createdBy": "xyz789",
"created": "abc123",
"updatedBy": "abc123",
"updated": "xyz789"
}
UpdateExternalUploadTrackingInput
UpdateFinancialHealthAssessmentSessionInput
Fields
| Input Field | Description |
|---|---|
id - ID!
|
|
clientId - Int
|
|
inviteCode - String
|
|
householdId - Int
|
|
status - String
|
|
firstName - String
|
|
lastName - String
|
|
fullName - String
|
|
hasPartner - Boolean
|
|
partnerId - Int
|
|
partnerFirstName - String
|
|
partnerLastName - String
|
|
partnerFullName - String
|
|
finHealthAssessmentFull - Boolean
|
|
responses - [FHAResponseInput!]
|
|
visionGoalsScore - Int
|
|
retirementPlanningScore - Int
|
|
insuranceAssetProtectionScore - Int
|
|
debtCashFlowManagementScore - Int
|
|
educationPlanningScore - Int
|
|
investmentPlanningScore - Int
|
|
incomeTaxPlanningScore - Int
|
|
businessPlanningScore - Int
|
|
charitablePlanningScore - Int
|
|
estatePlanningScore - Int
|
Example
{
"id": 4,
"clientId": 987,
"inviteCode": "abc123",
"householdId": 987,
"status": "abc123",
"firstName": "abc123",
"lastName": "abc123",
"fullName": "xyz789",
"hasPartner": false,
"partnerId": 987,
"partnerFirstName": "xyz789",
"partnerLastName": "xyz789",
"partnerFullName": "xyz789",
"finHealthAssessmentFull": false,
"responses": [FHAResponseInput],
"visionGoalsScore": 987,
"retirementPlanningScore": 987,
"insuranceAssetProtectionScore": 987,
"debtCashFlowManagementScore": 123,
"educationPlanningScore": 123,
"investmentPlanningScore": 123,
"incomeTaxPlanningScore": 123,
"businessPlanningScore": 987,
"charitablePlanningScore": 987,
"estatePlanningScore": 987
}
UpdateGoalsSessionInput
UpdateHouseholdPackageInput
UpdateInvestmentPreferencesSessionInput
Fields
| Input Field | Description |
|---|---|
id - ID!
|
|
clientId - Int
|
|
inviteCode - String
|
|
fullName - String
|
|
status - String
|
|
introVideo - String
|
|
customisationVideo - String
|
|
customisation - YesNoMaybe
|
|
ethicalVideo - String
|
|
ethical - YesNoMaybe
|
|
assetClassVideo - String
|
|
allocationVideo - String
|
|
allocationType - AssetAllocationType
|
|
riskVideo - String
|
|
comfortableWithDownturn - String
|
|
costVideo - String
|
|
costDriven - YesNo
|
|
prioritisation - [InvestmentPreferencesRankingInput!]
|
|
comments - String
|
|
customisationVideoHelp - YesNo
|
|
customisationVideoComments - String
|
|
ethicalVideoHelp - YesNo
|
|
ethicalVideoComments - String
|
|
assetClassVideoHelp - YesNo
|
|
assetClassVideoComments - String
|
|
allocationVideoHelp - YesNo
|
|
allocationVideoComments - String
|
|
riskVideoHelp - YesNo
|
|
riskVideoComments - String
|
|
riskDiversification - Int
|
|
riskMarketCorrection - Int
|
|
riskPercentageDrop - Int
|
|
riskCapitalProtection - YesNo
|
|
riskAccessCapital - Int
|
|
riskInfluencedByReturns - Int
|
|
riskIncreaseToMeetGoal - Int
|
|
riskMaxDownside - Int
|
|
riskInflation - Int
|
|
costVideoHelp - YesNo
|
|
costVideoComments - String
|
|
assetClassAndDiversificationVideoHelp - YesNoUnsure
|
|
assetClassPreferences - YesNo
|
|
assetClassPreferencesComments - String
|
|
assetClassRisk - YesNo
|
|
assetClassRiskComments - String
|
|
ethicalPreferences - YesNo
|
|
ethicalPreferencesComments - String
|
|
activePassiveVideoHelp - YesNoUnsure
|
|
costWealthPriorities - WealthPriorities
|
|
riskVolatilityVideoHelp - YesNoUnsure
|
|
riskTimelines - YesNoUnsure
|
|
riskExperience - Int
|
|
riskKnowledge - Int
|
|
riskPast - Int
|
|
riskCurrent - Int
|
|
riskTimeframe - Int
|
|
riskVariability - Int
|
|
riskVolatility - Int
|
|
riskReaction - Int
|
|
riskTolerance - Int
|
|
riskFuture - Int
|
|
includeRiskSection - Boolean
|
|
includeIntroSection - Boolean
|
|
includeCustomisationSection - Boolean
|
|
includeEthicalSection - Boolean
|
|
includeAssetClassSection - Boolean
|
|
includeAllocationSection - Boolean
|
|
includeCostSection - Boolean
|
|
includePrioritisationSection - Boolean
|
|
includeCommentsSection - Boolean
|
Example
{
"id": 4,
"clientId": 123,
"inviteCode": "abc123",
"fullName": "xyz789",
"status": "abc123",
"introVideo": "xyz789",
"customisationVideo": "xyz789",
"customisation": "Y",
"ethicalVideo": "abc123",
"ethical": "Y",
"assetClassVideo": "xyz789",
"allocationVideo": "xyz789",
"allocationType": "S",
"riskVideo": "abc123",
"comfortableWithDownturn": "abc123",
"costVideo": "xyz789",
"costDriven": "Y",
"prioritisation": [InvestmentPreferencesRankingInput],
"comments": "abc123",
"customisationVideoHelp": "Y",
"customisationVideoComments": "xyz789",
"ethicalVideoHelp": "Y",
"ethicalVideoComments": "xyz789",
"assetClassVideoHelp": "Y",
"assetClassVideoComments": "xyz789",
"allocationVideoHelp": "Y",
"allocationVideoComments": "abc123",
"riskVideoHelp": "Y",
"riskVideoComments": "abc123",
"riskDiversification": 987,
"riskMarketCorrection": 123,
"riskPercentageDrop": 123,
"riskCapitalProtection": "Y",
"riskAccessCapital": 987,
"riskInfluencedByReturns": 987,
"riskIncreaseToMeetGoal": 123,
"riskMaxDownside": 123,
"riskInflation": 123,
"costVideoHelp": "Y",
"costVideoComments": "xyz789",
"assetClassAndDiversificationVideoHelp": "Y",
"assetClassPreferences": "Y",
"assetClassPreferencesComments": "xyz789",
"assetClassRisk": "Y",
"assetClassRiskComments": "abc123",
"ethicalPreferences": "Y",
"ethicalPreferencesComments": "abc123",
"activePassiveVideoHelp": "Y",
"costWealthPriorities": "A",
"riskVolatilityVideoHelp": "Y",
"riskTimelines": "Y",
"riskExperience": 123,
"riskKnowledge": 123,
"riskPast": 123,
"riskCurrent": 987,
"riskTimeframe": 987,
"riskVariability": 123,
"riskVolatility": 987,
"riskReaction": 123,
"riskTolerance": 123,
"riskFuture": 987,
"includeRiskSection": false,
"includeIntroSection": true,
"includeCustomisationSection": false,
"includeEthicalSection": false,
"includeAssetClassSection": true,
"includeAllocationSection": false,
"includeCostSection": false,
"includePrioritisationSection": false,
"includeCommentsSection": true
}
UpdateModuleStateInput
Fields
| Input Field | Description |
|---|---|
clientId - Int
|
|
inviteCode - String
|
|
origination - ModuleStateInput
|
|
fha - ModuleStateInput
|
|
governance - ModuleStateInput
|
|
life - ModuleStateInput
|
|
values - ModuleStateInput
|
|
investmentPreferences - ModuleStateInput
|
|
goals - ModuleStateInput
|
|
registration - ModuleStateInput
|
|
foundations - ModuleStateInput
|
|
dashboard - ModuleStateInput
|
|
keyAdviceAreas - ModuleStateInput
|
|
bestLifePlan - ModuleStateInput
|
|
termsOfEngagement - ModuleStateInput
|
Example
{
"clientId": 987,
"inviteCode": "abc123",
"origination": ModuleStateInput,
"fha": ModuleStateInput,
"governance": ModuleStateInput,
"life": ModuleStateInput,
"values": ModuleStateInput,
"investmentPreferences": ModuleStateInput,
"goals": ModuleStateInput,
"registration": ModuleStateInput,
"foundations": ModuleStateInput,
"dashboard": ModuleStateInput,
"keyAdviceAreas": ModuleStateInput,
"bestLifePlan": ModuleStateInput,
"termsOfEngagement": ModuleStateInput
}
UpdateNotificationInput
Fields
| Input Field | Description |
|---|---|
id - ID!
|
|
owner - String
|
|
recipient - String
|
|
message - String
|
|
messageRead - Boolean
|
|
createdAt - AWSDateTime
|
|
updatedAt - AWSDateTime
|
Example
{
"id": "4",
"owner": "abc123",
"recipient": "abc123",
"message": "abc123",
"messageRead": false,
"createdAt": AWSDateTime,
"updatedAt": AWSDateTime
}
UpdateNotificationPointerInput
Fields
| Input Field | Description |
|---|---|
id - ID!
|
|
owner - String
|
|
recipient - String
|
|
notificationId - String
|
|
createdAt - AWSDateTime
|
|
updatedAt - AWSDateTime
|
Example
{
"id": "4",
"owner": "abc123",
"recipient": "abc123",
"notificationId": "xyz789",
"createdAt": AWSDateTime,
"updatedAt": AWSDateTime
}
UpdateOriginationSessionInput
Fields
| Input Field | Description |
|---|---|
id - ID!
|
|
clientId - Int
|
|
inviteCode - String
|
|
householdId - Int
|
|
status - String
|
|
clientFirstName - String
|
|
clientLastName - String
|
|
clientFullName - String
|
|
hasPartner - Boolean
|
|
partnerId - Int
|
|
partnerFirstName - String
|
|
partnerLastName - String
|
|
partnerFullName - String
|
|
questionnaires - [OriginationQuestionnaire!]
|
|
lifeIncGoals - Boolean
|
|
lifeIncConnections - Boolean
|
|
lifeIncFinancialDetails - Boolean
|
|
finHealthAssessmentFull - Boolean
|
|
foundationsFull - Boolean
|
|
valuesInc3Things - Boolean
|
|
governanceIncPersonalDetails - Boolean
|
|
governanceIncAssetsLiabilitiesIncomeExpenses - Boolean
|
|
governanceIncInsurance - Boolean
|
|
governanceIncBusinessPlanning - Boolean
|
|
governanceIncEducationPlanning - Boolean
|
|
governanceIncCharitablePlanning - Boolean
|
|
governanceIncTaxPlanning - Boolean
|
|
governanceIncEstatePlanning - Boolean
|
|
investmentPreferencesIncRiskSection - Boolean
|
|
investmentPreferencesIncIntroSection - Boolean
|
|
investmentPreferencesIncCustomisationSection - Boolean
|
|
investmentPreferencesIncEthicalSection - Boolean
|
|
investmentPreferencesIncAssetClassSection - Boolean
|
|
investmentPreferencesIncAllocationSection - Boolean
|
|
investmentPreferencesIncCostSection - Boolean
|
|
investmentPreferencesIncPrioritisationSection - Boolean
|
|
investmentPreferencesIncCommentsSection - Boolean
|
|
uploadFileList - [UploadVaultFileInfoInput]
|
|
uploadIdentity - String
|
|
stepTracker - StepTrackerInput
|
|
completedQuestionnaires - [OriginationQuestionnaire!]
|
|
failedQuestionnaires - [OriginationQuestionnaire!]
|
Example
{
"id": "4",
"clientId": 123,
"inviteCode": "abc123",
"householdId": 987,
"status": "abc123",
"clientFirstName": "abc123",
"clientLastName": "xyz789",
"clientFullName": "abc123",
"hasPartner": true,
"partnerId": 987,
"partnerFirstName": "abc123",
"partnerLastName": "abc123",
"partnerFullName": "abc123",
"questionnaires": ["LIFE"],
"lifeIncGoals": true,
"lifeIncConnections": false,
"lifeIncFinancialDetails": false,
"finHealthAssessmentFull": true,
"foundationsFull": false,
"valuesInc3Things": false,
"governanceIncPersonalDetails": true,
"governanceIncAssetsLiabilitiesIncomeExpenses": false,
"governanceIncInsurance": false,
"governanceIncBusinessPlanning": true,
"governanceIncEducationPlanning": false,
"governanceIncCharitablePlanning": false,
"governanceIncTaxPlanning": false,
"governanceIncEstatePlanning": false,
"investmentPreferencesIncRiskSection": true,
"investmentPreferencesIncIntroSection": false,
"investmentPreferencesIncCustomisationSection": false,
"investmentPreferencesIncEthicalSection": false,
"investmentPreferencesIncAssetClassSection": false,
"investmentPreferencesIncAllocationSection": false,
"investmentPreferencesIncCostSection": true,
"investmentPreferencesIncPrioritisationSection": false,
"investmentPreferencesIncCommentsSection": true,
"uploadFileList": [UploadVaultFileInfoInput],
"uploadIdentity": "xyz789",
"stepTracker": StepTrackerInput,
"completedQuestionnaires": ["LIFE"],
"failedQuestionnaires": ["LIFE"]
}
UpdatePracticePackageInput
UpdateRedtailLoadErrorsInput
UpdateRegistrationInput
UpdateSecurityInput
Example
{
"id": "4",
"assetClassName": "abc123",
"code": "xyz789",
"description": "abc123",
"exchange": "abc123",
"msCode": "abc123",
"msNonFundCode": "xyz789",
"name": "xyz789",
"securityId": 987,
"securityType": "abc123",
"securityGroup": "abc123",
"ticker": "xyz789"
}
UpdateStaffOutput
Fields
| Field Name | Description |
|---|---|
staffId - Int!
|
Example
{"staffId": 123}
UpdateSurveyResponseDataInput
Example
{
"id": "4",
"clientId": 987,
"inviteCode": "abc123",
"householdId": 123,
"keyValueData": "xyz789",
"status": "SENT",
"surveyId": "abc123",
"progress": 123.45
}
UpdateTamaracLoadErrorsInput
Fields
| Input Field | Description |
|---|---|
id - ID!
|
|
sourceFile - String
|
|
errorMessage - String
|
|
tamaracPayload - String
|
|
accountId - String
|
|
accountNumber - String
|
|
primaryMemberFirstName - String
|
|
primaryMemberLastName - String
|
|
fuzzyRatio - String
|
|
rdsCombinedAddressString - String
|
|
tamaracCombinedAddressString - String
|
Example
{
"id": 4,
"sourceFile": "abc123",
"errorMessage": "abc123",
"tamaracPayload": "abc123",
"accountId": "xyz789",
"accountNumber": "abc123",
"primaryMemberFirstName": "xyz789",
"primaryMemberLastName": "abc123",
"fuzzyRatio": "xyz789",
"rdsCombinedAddressString": "xyz789",
"tamaracCombinedAddressString": "xyz789"
}
UpdateYourLifeSessionInput
Fields
| Input Field | Description |
|---|---|
id - ID!
|
|
clientId - Int
|
|
inviteCode - String
|
|
householdId - Int
|
|
status - String
|
|
firstName - String
|
|
lastName - String
|
|
fullName - String
|
|
hasPartner - Boolean
|
|
partnerId - Int
|
|
includeGoals - Boolean
|
|
includeConnections - Boolean
|
|
includeFinancialDetails - Boolean
|
|
partnerFirstName - String
|
|
partnerLastName - String
|
|
partnerFullName - String
|
|
responses - [LifeResponseInput!]
|
|
lovedOnes - [String!]
|
|
communityConnections - [String!]
|
|
globalConnections - [String!]
|
|
overallScore - Float
|
|
emotionalScore - Float
|
|
environmentalScore - Float
|
|
spiritualScore - Float
|
|
socialScore - Float
|
|
educationScore - Float
|
|
occupationalScore - Float
|
|
physicalScore - Float
|
|
financialScore - Float
|
|
notes - [LifeNoteInput]
|
Example
{
"id": "4",
"clientId": 987,
"inviteCode": "xyz789",
"householdId": 123,
"status": "abc123",
"firstName": "abc123",
"lastName": "xyz789",
"fullName": "xyz789",
"hasPartner": true,
"partnerId": 123,
"includeGoals": true,
"includeConnections": true,
"includeFinancialDetails": true,
"partnerFirstName": "xyz789",
"partnerLastName": "abc123",
"partnerFullName": "xyz789",
"responses": [LifeResponseInput],
"lovedOnes": ["abc123"],
"communityConnections": ["xyz789"],
"globalConnections": ["xyz789"],
"overallScore": 123.45,
"emotionalScore": 987.65,
"environmentalScore": 987.65,
"spiritualScore": 987.65,
"socialScore": 123.45,
"educationScore": 987.65,
"occupationalScore": 123.45,
"physicalScore": 987.65,
"financialScore": 987.65,
"notes": [LifeNoteInput]
}
UpdateYourValuesSessionInput
Fields
| Input Field | Description |
|---|---|
id - ID!
|
|
clientId - Int
|
|
inviteCode - String
|
|
partnerId - Int
|
|
partnerInviteCode - String
|
|
client - ValuesClientInput
|
|
partner - ValuesClientInput
|
|
adviser - ValuesStaffInput
|
|
support - ValuesStaffInput
|
|
alignedValues - [ValuesAlignedValueInput!]
|
|
valuesInc3Things - Boolean
|
|
partnerValuesInc3Things - Boolean
|
|
individualValuesOnly - Boolean
|
|
step - String
|
|
lastSeen - String
|
Example
{
"id": "4",
"clientId": 987,
"inviteCode": "xyz789",
"partnerId": 987,
"partnerInviteCode": "abc123",
"client": ValuesClientInput,
"partner": ValuesClientInput,
"adviser": ValuesStaffInput,
"support": ValuesStaffInput,
"alignedValues": [ValuesAlignedValueInput],
"valuesInc3Things": false,
"partnerValuesInc3Things": false,
"individualValuesOnly": false,
"step": "abc123",
"lastSeen": "xyz789"
}
UploadVaultFileInfo
UploadVaultFileInfoInput
UploadVaultFileInput
UserPackageOutput
ValidateXplanCredentialsInput
ValuesAlignedValue
Fields
| Field Name | Description |
|---|---|
cardId - Int!
|
|
clientId - Int!
|
|
rank - Int
|
|
notes - String
|
|
progress - Int
|
|
description - String
|
|
nextSteps - [ValuesNextStep!]
|
|
householdMemberProgress - [HouseholdMemberProgress!]
|
Example
{
"cardId": 123,
"clientId": 987,
"rank": 123,
"notes": "xyz789",
"progress": 987,
"description": "abc123",
"nextSteps": [ValuesNextStep],
"householdMemberProgress": [HouseholdMemberProgress]
}
ValuesAlignedValueInput
Fields
| Input Field | Description |
|---|---|
cardId - Int!
|
|
clientId - Int!
|
|
rank - Int
|
|
notes - String
|
|
progress - Int
|
|
description - String
|
|
nextSteps - [ValuesNextStepInput!]
|
|
householdMemberProgress - [HouseholdMemberProgressInput!]
|
Example
{
"cardId": 123,
"clientId": 123,
"rank": 123,
"notes": "xyz789",
"progress": 123,
"description": "abc123",
"nextSteps": [ValuesNextStepInput],
"householdMemberProgress": [
HouseholdMemberProgressInput
]
}
ValuesClient
Example
{
"clientId": 987,
"regrets": ["abc123"],
"values": [ValuesClientValue],
"step": "xyz789",
"lastSeen": "abc123",
"individualValuesCompleted": true
}
ValuesClientInput
Example
{
"clientId": 123,
"regrets": ["xyz789"],
"values": [ValuesClientValueInput],
"step": "abc123",
"lastSeen": "xyz789",
"individualValuesCompleted": true
}
ValuesClientValue
ValuesClientValueInput
ValuesNextStep
ValuesNextStepInput
ValuesStaff
ValuesStaffInput
VaultFolder
VaultFolderInput
VerifyEmailUniquenessInput
Fields
| Input Field | Description |
|---|---|
email - String!
|
Example
{"email": "abc123"}
VerifyEmailUniquenessOutput
WealthInput
Fields
| Input Field | Description |
|---|---|
householdId - Int!
|
Example
{"householdId": 123}
WealthOutput
Fields
| Field Name | Description |
|---|---|
aggregateTotal - Float
|
|
aggregateCashTotal - Float
|
|
aggregateFixedIncomeTotal - Float
|
|
aggregateRealAssetsTotal - Float
|
|
aggregateEquitiesTotal - Float
|
|
aggregateAlternativesTotal - Float
|
|
aggregateOtherTotal - Float
|
|
aggregateMultiAssetTotal - Float
|
|
portfolios - [Portfolio]
|
|
householdAggregate - HouseholdAggregate
|
Example
{
"aggregateTotal": 987.65,
"aggregateCashTotal": 123.45,
"aggregateFixedIncomeTotal": 987.65,
"aggregateRealAssetsTotal": 987.65,
"aggregateEquitiesTotal": 987.65,
"aggregateAlternativesTotal": 987.65,
"aggregateOtherTotal": 123.45,
"aggregateMultiAssetTotal": 987.65,
"portfolios": [Portfolio],
"householdAggregate": HouseholdAggregate
}
WealthPriorities
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"A"
WellnessScore
Example
{
"date": "xyz789",
"wellnessScore": 987.65,
"lifeScore": 123.45,
"valuesScore": 987.65,
"goalsScore": 123.45,
"tasksScore": 987.65,
"kaaScore": 987.65,
"components": "abc123"
}
XplanCallbackInputs
XplanIsCallbackVerifiedRequest
YesNo
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"Y"
YesNoMaybe
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"Y"
YesNoUnsure
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"Y"
YodleeMapping
Example
{
"providerAccountId": 987,
"additionalStatus": "xyz789",
"additionalStatusDescription": "xyz789",
"lastUpdated": "xyz789",
"isBroken": false,
"createdBy": "abc123",
"created": "xyz789",
"updatedBy": "abc123",
"updated": "xyz789"
}
YourLifeIntroVideoUrl
Fields
| Field Name | Description |
|---|---|
url - String
|
Example
{"url": "abc123"}
YourLifeIntroVideoUrlInput
YourLifeSession
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
clientId - Int!
|
|
inviteCode - String!
|
|
householdId - Int
|
|
status - String
|
|
firstName - String
|
|
lastName - String
|
|
fullName - String
|
|
hasPartner - Boolean
|
|
partnerId - Int
|
|
includeGoals - Boolean
|
|
includeConnections - Boolean
|
|
includeFinancialDetails - Boolean
|
|
partnerFirstName - String
|
|
partnerLastName - String
|
|
partnerFullName - String
|
|
responses - [LifeResponse!]
|
|
lovedOnes - [String!]
|
|
communityConnections - [String!]
|
|
globalConnections - [String!]
|
|
overallScore - Float
|
|
emotionalScore - Float
|
|
environmentalScore - Float
|
|
spiritualScore - Float
|
|
socialScore - Float
|
|
educationScore - Float
|
|
occupationalScore - Float
|
|
physicalScore - Float
|
|
financialScore - Float
|
|
notes - [LifeNote]
|
|
createdAt - AWSDateTime!
|
|
updatedAt - AWSDateTime!
|
Example
{
"id": "4",
"clientId": 987,
"inviteCode": "abc123",
"householdId": 123,
"status": "xyz789",
"firstName": "abc123",
"lastName": "abc123",
"fullName": "xyz789",
"hasPartner": true,
"partnerId": 123,
"includeGoals": true,
"includeConnections": true,
"includeFinancialDetails": false,
"partnerFirstName": "xyz789",
"partnerLastName": "abc123",
"partnerFullName": "abc123",
"responses": [LifeResponse],
"lovedOnes": ["abc123"],
"communityConnections": ["xyz789"],
"globalConnections": ["xyz789"],
"overallScore": 987.65,
"emotionalScore": 987.65,
"environmentalScore": 987.65,
"spiritualScore": 123.45,
"socialScore": 123.45,
"educationScore": 123.45,
"occupationalScore": 987.65,
"physicalScore": 987.65,
"financialScore": 987.65,
"notes": [LifeNote],
"createdAt": AWSDateTime,
"updatedAt": AWSDateTime
}
YourValuesIntroVideoUrl
Fields
| Field Name | Description |
|---|---|
url - String
|
Example
{"url": "xyz789"}
YourValuesSession
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
clientId - Int!
|
|
inviteCode - String
|
|
partnerId - Int
|
|
partnerInviteCode - String
|
|
client - ValuesClient
|
|
partner - ValuesClient
|
|
adviser - ValuesStaff
|
|
support - ValuesStaff
|
|
alignedValues - [ValuesAlignedValue!]
|
|
valuesInc3Things - Boolean
|
|
partnerValuesInc3Things - Boolean
|
|
individualValuesOnly - Boolean
|
|
step - String
|
|
lastSeen - String
|
|
createdAt - AWSDateTime!
|
|
updatedAt - AWSDateTime!
|
Example
{
"id": 4,
"clientId": 123,
"inviteCode": "abc123",
"partnerId": 987,
"partnerInviteCode": "xyz789",
"client": ValuesClient,
"partner": ValuesClient,
"adviser": ValuesStaff,
"support": ValuesStaff,
"alignedValues": [ValuesAlignedValue],
"valuesInc3Things": true,
"partnerValuesInc3Things": true,
"individualValuesOnly": true,
"step": "xyz789",
"lastSeen": "xyz789",
"createdAt": AWSDateTime,
"updatedAt": AWSDateTime
}
YourVaultFile
Fields
| Field Name | Description |
|---|---|
fileLink - String
|
Example
{"fileLink": "xyz789"}
YourVaultFileInfo
Example
{
"pathAndFilename": "abc123",
"presignedPathAndFilename": "xyz789",
"lastModified": "xyz789",
"size": 123,
"status": 987,
"publishCount": 987,
"uploaderClientId": 123,
"uploaderStaffId": 987
}
practiceReturnsBillableClientListData
Fields
| Field Name | Description |
|---|---|
practiceId - String!
|
|
practiceName - String!
|
|
practiceOfficeId - String
|
|
staffId - String
|
|
staffFirstName - String!
|
|
staffLastName - String!
|
|
householdTeamMemberRole - String!
|
|
householdId - String!
|
|
cfoClientId - String!
|
|
cfoClientFirstName - String!
|
|
cfoClientLastName - String!
|
|
cfoClientType - String!
|
|
cfoClientEmail - String!
|
|
cfoClientIsActive - String
|
|
cfoClientLastLogin - String
|
|
cfoClientBillableStart - String
|
|
cfoClientBillableTrigger - String
|
|
nonCfoClientId - String
|
|
nonCfoClientFirstName - String
|
|
nonCfoClientLastName - String
|
|
nonCfoClientType - String
|
|
nonCfoClientEmail - String
|
|
nonCfoClientIsActive - String
|
|
nonCfoClientLastLogin - String
|
|
nonCfoClientBillableStart - String
|
|
nonCfoClientBillableTrigger - String
|
Example
{
"practiceId": "abc123",
"practiceName": "xyz789",
"practiceOfficeId": "abc123",
"staffId": "abc123",
"staffFirstName": "xyz789",
"staffLastName": "xyz789",
"householdTeamMemberRole": "xyz789",
"householdId": "abc123",
"cfoClientId": "abc123",
"cfoClientFirstName": "xyz789",
"cfoClientLastName": "xyz789",
"cfoClientType": "abc123",
"cfoClientEmail": "abc123",
"cfoClientIsActive": "abc123",
"cfoClientLastLogin": "abc123",
"cfoClientBillableStart": "abc123",
"cfoClientBillableTrigger": "xyz789",
"nonCfoClientId": "xyz789",
"nonCfoClientFirstName": "abc123",
"nonCfoClientLastName": "xyz789",
"nonCfoClientType": "abc123",
"nonCfoClientEmail": "abc123",
"nonCfoClientIsActive": "abc123",
"nonCfoClientLastLogin": "abc123",
"nonCfoClientBillableStart": "xyz789",
"nonCfoClientBillableTrigger": "xyz789"
}
practiceReturnsBillableClientListInput
Fields
| Input Field | Description |
|---|---|
practiceId - Int
|
Example
{"practiceId": 123}
practiceReturnsBillableClientListOutput
Fields
| Field Name | Description |
|---|---|
searchResult - [practiceReturnsBillableClientListData]
|
Example
{"searchResult": [practiceReturnsBillableClientListData]}