Navexa API
  1. Schemas
Navexa API
  • Start your Navexa journey
  • Authentication
  • Reports
    • Get ATO myTax report
    • Get ATO myTax report PDF
    • Get Capital Gains Tax report
    • Get Taxable Income report
    • Get Unrealised Capital Gains Tax report
  • Benchmark
    • Get the benchmark return for a portfolio
  • CashAccount
    • Get Cash Account
    • Delete a Cash Account
    • Get all Cash Accounts
    • Create a Cash Account
    • Update a Cash Account
    • Get Cash Account Transactions
  • CashAccountTransactions
    • Get a Cash Account Transaction
    • Delete a Cash Account Transaction
    • Create a Cash Account Transaction
    • Update a Cash Account Transaction
  • Clients
    • Get all Clients
    • Create a client
    • Gets Client
    • Update a client
    • Delete client
    • Get client Portfolios
    • Assign portfolios to client
  • Holdings
    • Get a holding
    • Update a holding
    • Delete a holding
    • Get a holding's trades
    • Get holding income records
    • Update a holding's symbol and exchange
  • PortfolioPerformance
    • Get portfolio performance
  • Portfolios
    • Get all portfolios
    • Create a portfolio
    • Get a portfolio
    • Update a portfolio
    • Delete a portfolio
    • Get all portfolio holdings
  • ProRataDistributions
    • Update ETF Distributions ProRata
  • StocksIncome
    • Get an income record
    • Update Income record
    • Confirm Income record
  • TaxSettings
    • Get all portfolio tax settings
    • Get portfolio tax setting
    • Update portfolio tax settings
  • Trades
    • Get a trade
    • Delete a trade
    • Add a trade
  • CustomInvestmentPrice
    • Get a Price
    • Delete a Price
    • Add a Price
    • Update a Price
  • Schemas
    • Sample Schemas
      • Pet
      • Category
      • Tag
    • Schemas
      • AccountLinkSettings
      • AccountSettings
      • AccountLinkViewModel
      • AddClientVM
      • AddTradeModel
      • AddPriceModel
      • AddClientModel
      • ApplicationUser
      • AuthorizeTokenRequest
      • BenchmarkSettings
      • CalculationSettings
      • AdjustmentData
      • CategoryPerformancePreferenceOptions
      • ChartPreferenceOptions
      • AssignPortfolioToClientVM
      • ChecklistItem
      • Client
      • AutomationSettings
      • ClientExpanded
      • CGTDistributionsModel
      • BillingSettings
      • ClientModel
      • CGTError
      • ClientPortfolio
      • CGTEventModel
      • ClientVM
      • CGTReportModel
      • ColumnSettings
      • ComponentColumn
      • CapitalGainLoss
      • ComponentSettings
      • CapitalGainsBreakdown
      • CreateCashAccountVM
      • CapitalGainsTaxSummary
      • CreateCashTransactionVM
      • CapitalGainsTaxSummaryModel
      • CreateComponentDTO
      • CashInterest
      • CreatePortfolioSettingsModel
      • CryptoIncome
      • CryptoTrade2
      • CustomGroupCategory
      • DiversificationPreferenceOptions
      • Dividend
      • ClientPortfolioVM
      • DividendDTO
      • DividendError
      • EmailSettings
      • EmbeddedComponent
      • FilterCriteria
      • CompanyListResponseDTO
      • GroupAccount
      • CompanyManagementDTO
      • GroupAccountResponse
      • GetPriceModel
      • GroupUserAdd
      • GroupUserLookup
      • CreateProPortfolioVM
      • GroupUserResponse
      • GroupUserUpdate
      • CryptoIncomeDTO
      • Holding
      • CryptoIncomeSummary
      • HoldingClassification
      • HoldingModel
      • HoldingNote
      • DateRange
      • HoldingPerformancePreferenceOptions
      • DeductionsSummary
      • HoldingPublisherData
      • HoldingSettingsModel
      • CryptocurrencyListResponseDTO
      • HoldingTaxSettings
      • CryptocurrencyManagementDTO
      • HoldingType
      • DividendData
      • IHoldingSettings
      • CustomerProfileDto
      • IncomeContributionsSettings
      • CustomerSearchResultDto
      • IncomeReturnPreferenceOptions
      • IntegrationMethodAccuracy
      • IntegrationMethodSupportLevel
      • ForeignTaxableIncomeSummary
      • IntegrationType
      • IntercomSettings
      • IosIapPurchase
      • IosIapSubscriptionInfo
      • ManageClientModel
      • Metadata
      • OnboardingChecklist
      • OnboardingSurvey
      • OverviewPreferences
      • OwnerPlan
      • GicIndustry
      • PaymentPlatform
      • GicIndustryGroup
      • Portfolio
      • GicSector
      • PortfolioDiviersifcationSettings
      • GicSubIndustry
      • PortfolioPreferences
      • HoldingReturnViewModel
      • PortfolioRequest
      • PortfolioSettings
      • PortfolioHoldingModel
      • HoldingSummaryPerformanceViewModel
      • PortfolioTaxSetting
      • PortfolioModel
      • PortfolioType
      • HoldingTaxSettingsVM
      • HoldingSymbolUpdateModel
      • ProRataTotals
      • HoldingTaxSettingsDTO
      • ProRegisterModel
      • HoldingTypeEnum
      • Provider
      • ProviderIntegrationMethod
      • SaleAllocationStrategies
      • IncomeIntegrationMapping
      • SharingSettings
      • IncomeIntegrationMappingDto
      • SubscriptionPlan
      • IncomeRecord
      • ImpersonationRequestDto
      • TestimonialInformation
      • ImpersonationResponseDto
      • TimeSpan
      • TrackingInformation
      • Trade
      • TradeMetadata
      • TradeType
      • InterestIncomeSummary
      • TradeTypeEnum
      • UpdateCashAccountVM
      • UpdateCashTransactionVM
      • UpsertIncomeRecord
      • IntercomAdmin
      • UpsertPortfolioModel
      • UpdatePriceModel
      • MyTaxIncomeSummary
      • IntercomAvatar
      • UserPortfolio
      • MyTaxReportModel
      • IntercomCanvasContext
      • UserPreferences
      • IntercomCanvasInitializeDto
      • UserSharedWith
      • IntercomCanvasSubmitDto
      • IntercomContact
      • IntercomCustomer
      • IntercomRevokeAccessDto
      • PortfolioPerformanceViewModel
      • PortfolioTaxSettingDTO
      • PortfolioTaxSettingsVM
      • SharePortfoliosVM
      • NotificationSettings
      • TaxableIncomeReportModel
      • TaxableIncomeSummary
      • TotalReturnViewModel
      • TradeIntegrationMapping
      • StartImpersonationDto
      • StopImpersonationDto
      • TrialEligibilityDto
      • TrialResetRequestDto
      • TrialResetResponseDto
      • UpdateAccountSettingsDto
      • UpdateUserProfileDto
  1. Schemas

GroupAccountResponse

{
    "groupDetails": {
        "id": "string",
        "accountName": "string",
        "dateCreated": "2019-08-24T14:15:22.123Z",
        "primaryAccountUserId": "string",
        "isWhiteLabelled": true,
        "whiteLabelledDomain": "string",
        "type": "string"
    },
    "users": [
        {
            "id": "string",
            "shortId": "string",
            "email": "string",
            "lastName": "string",
            "firstName": "string",
            "userName": "string",
            "dateCreated": "2019-08-24T14:15:22.123Z",
            "profilePicture": "string",
            "groupAccount": {
                "id": "string",
                "accountName": "string",
                "dateCreated": "2019-08-24T14:15:22.123Z",
                "primaryAccountUserId": "string",
                "isWhiteLabelled": true,
                "whiteLabelledDomain": "string",
                "type": "string"
            },
            "isActivated": true,
            "emailConfirmed": true,
            "preferences": {
                "theme": "string",
                "portfolioView": "string",
                "defaultPortfolioId": 0,
                "selectedPortfolioId": 0,
                "portfolioSettings": {
                    "holdingsPagingSetting": 0,
                    "holdingsGroupingSetting": "string",
                    "holdingsShowClosedPositionsSetting": true,
                    "showLocalCurrencySetting": true,
                    "includeClosedPositions": true,
                    "combineHoldings": true,
                    "columnSettings": [
                        {
                            "visibleIndex": 0,
                            "dataField": "string",
                            "name": "string",
                            "dataType": "string",
                            "visible": true,
                            "sortOrder": "string",
                            "sortIndex": 0,
                            "width": 0
                        }
                    ]
                },
                "datePresetSelection": "string",
                "dateFormat": "string",
                "isNavBarCollapsed": true,
                "emailSettings": {
                    "monthlySummary": true,
                    "weeklySummary": true
                },
                "incomeContributionsSettings": {
                    "chartType": "string"
                },
                "portfolioDiversificationSettings": {
                    "chartType": "string"
                },
                "homePage": "string",
                "overviewPreferences": {
                    "chartPreferences": {
                        "metric": "string",
                        "isDollarValue": true,
                        "showBarChart": true,
                        "chartBreakdown": "string"
                    },
                    "holdingPerformancePreferences": {
                        "metric": "string",
                        "isDollarValue": true
                    },
                    "categoryPerformancePreferences": {
                        "category": "string",
                        "metric": "string",
                        "isDollarValue": true
                    },
                    "incomeReturnPreferences": {
                        "isDollarValue": true
                    },
                    "diversificationPreferences": {
                        "category": "string"
                    }
                },
                "notificationSettings": {
                    "pushEnabled": true,
                    "friendRequests": true,
                    "newDividends": true,
                    "newFollowers": true,
                    "contractNotes": true,
                    "brokerFileProcessed": true,
                    "accountLinkActions": true,
                    "bulkUploadCompleted": true,
                    "referralCredits": true
                }
            },
            "claims": [
                "string"
            ],
            "clients": [
                {
                    "clientId": "string",
                    "groupAccountId": "string",
                    "clientUserId": "string",
                    "username": "string",
                    "email": "string",
                    "phoneNumber": "string",
                    "firstName": "string",
                    "lastName": "string",
                    "dateCreated": "2019-08-24T14:15:22.123Z",
                    "createdByUserId": "string",
                    "referralStatus": "string",
                    "referralSentDate": "2019-08-24T14:15:22.123Z",
                    "portfolios": [
                        {
                            "portfolioId": 0,
                            "portfolioName": "string",
                            "isPortfolioOwner": true,
                            "sharingSettings": {
                                "accessLevel": "string",
                                "portfolioOwnerPlan": {
                                    "planName": "string",
                                    "planActive": true
                                }
                            },
                            "dateCreated": "2019-08-24T14:15:22.123Z",
                            "usersSharedWith": [
                                {
                                    "userId": "string",
                                    "name": "string",
                                    "dateShared": "2019-08-24T14:15:22.123Z",
                                    "inviteAccepted": true,
                                    "accessLevel": "string"
                                }
                            ],
                            "baseCurrencyCode": "string",
                            "isPortfolioGroup": true,
                            "firstTradeDate": "2019-08-24T14:15:22.123Z",
                            "settings": {
                                "benchmarkSettings": {
                                    "type": "string",
                                    "symbol": "string",
                                    "exchange": "string",
                                    "displayName": "string",
                                    "portfolioId": 0
                                },
                                "taxEntityType": "string",
                                "calculationSettings": {
                                    "includeClosedPositions": true,
                                    "annualiseReturns": true,
                                    "useSimpleCalculation": true,
                                    "includeCashPositions": true
                                },
                                "endOfFinancialYear": "2019-08-24T14:15:22.123Z",
                                "automationSettings": {
                                    "enableCorporateActionAutomation": true,
                                    "enableDividendAutomation": true
                                }
                            },
                            "userId": "string",
                            "portfolioTypeId": 0,
                            "numHoldings": 0
                        }
                    ],
                    "sharedPortfolios": [
                        {
                            "portfolioId": 0,
                            "portfolioName": "string",
                            "isPortfolioOwner": true,
                            "sharingSettings": {
                                "accessLevel": "string",
                                "portfolioOwnerPlan": {
                                    "planName": "string",
                                    "planActive": true
                                }
                            },
                            "dateCreated": "2019-08-24T14:15:22.123Z",
                            "usersSharedWith": [
                                {
                                    "userId": "string",
                                    "name": "string",
                                    "dateShared": "2019-08-24T14:15:22.123Z",
                                    "inviteAccepted": true,
                                    "accessLevel": "string"
                                }
                            ],
                            "baseCurrencyCode": "string",
                            "isPortfolioGroup": true,
                            "firstTradeDate": "2019-08-24T14:15:22.123Z",
                            "settings": {
                                "benchmarkSettings": {
                                    "type": "string",
                                    "symbol": "string",
                                    "exchange": "string",
                                    "displayName": "string",
                                    "portfolioId": 0
                                },
                                "taxEntityType": "string",
                                "calculationSettings": {
                                    "includeClosedPositions": true,
                                    "annualiseReturns": true,
                                    "useSimpleCalculation": true,
                                    "includeCashPositions": true
                                },
                                "endOfFinancialYear": "2019-08-24T14:15:22.123Z",
                                "automationSettings": {
                                    "enableCorporateActionAutomation": true,
                                    "enableDividendAutomation": true
                                }
                            },
                            "userId": "string",
                            "portfolioTypeId": 0,
                            "numHoldings": 0
                        }
                    ]
                }
            ]
        }
    ],
    "clients": [
        {
            "clientId": "string",
            "groupAccountId": "string",
            "clientUserId": "string",
            "username": "string",
            "email": "string",
            "phoneNumber": "string",
            "firstName": "string",
            "lastName": "string",
            "dateCreated": "2019-08-24T14:15:22.123Z",
            "createdByUserId": "string",
            "referralStatus": "string",
            "referralSentDate": "2019-08-24T14:15:22.123Z",
            "portfolios": [
                {
                    "portfolioId": 0,
                    "portfolioName": "string",
                    "isPortfolioOwner": true,
                    "sharingSettings": {
                        "accessLevel": "string",
                        "portfolioOwnerPlan": {
                            "planName": "string",
                            "planActive": true
                        }
                    },
                    "dateCreated": "2019-08-24T14:15:22.123Z",
                    "usersSharedWith": [
                        {
                            "userId": "string",
                            "name": "string",
                            "dateShared": "2019-08-24T14:15:22.123Z",
                            "inviteAccepted": true,
                            "accessLevel": "string"
                        }
                    ],
                    "baseCurrencyCode": "string",
                    "isPortfolioGroup": true,
                    "firstTradeDate": "2019-08-24T14:15:22.123Z",
                    "settings": {
                        "benchmarkSettings": {
                            "type": "string",
                            "symbol": "string",
                            "exchange": "string",
                            "displayName": "string",
                            "portfolioId": 0
                        },
                        "taxEntityType": "string",
                        "calculationSettings": {
                            "includeClosedPositions": true,
                            "annualiseReturns": true,
                            "useSimpleCalculation": true,
                            "includeCashPositions": true
                        },
                        "endOfFinancialYear": "2019-08-24T14:15:22.123Z",
                        "automationSettings": {
                            "enableCorporateActionAutomation": true,
                            "enableDividendAutomation": true
                        }
                    },
                    "userId": "string",
                    "portfolioTypeId": 0,
                    "numHoldings": 0
                }
            ],
            "sharedPortfolios": [
                {
                    "portfolioId": 0,
                    "portfolioName": "string",
                    "isPortfolioOwner": true,
                    "sharingSettings": {
                        "accessLevel": "string",
                        "portfolioOwnerPlan": {
                            "planName": "string",
                            "planActive": true
                        }
                    },
                    "dateCreated": "2019-08-24T14:15:22.123Z",
                    "usersSharedWith": [
                        {
                            "userId": "string",
                            "name": "string",
                            "dateShared": "2019-08-24T14:15:22.123Z",
                            "inviteAccepted": true,
                            "accessLevel": "string"
                        }
                    ],
                    "baseCurrencyCode": "string",
                    "isPortfolioGroup": true,
                    "firstTradeDate": "2019-08-24T14:15:22.123Z",
                    "settings": {
                        "benchmarkSettings": {
                            "type": "string",
                            "symbol": "string",
                            "exchange": "string",
                            "displayName": "string",
                            "portfolioId": 0
                        },
                        "taxEntityType": "string",
                        "calculationSettings": {
                            "includeClosedPositions": true,
                            "annualiseReturns": true,
                            "useSimpleCalculation": true,
                            "includeCashPositions": true
                        },
                        "endOfFinancialYear": "2019-08-24T14:15:22.123Z",
                        "automationSettings": {
                            "enableCorporateActionAutomation": true,
                            "enableDividendAutomation": true
                        }
                    },
                    "userId": "string",
                    "portfolioTypeId": 0,
                    "numHoldings": 0
                }
            ]
        }
    ]
}
Built with