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

Client

{
    "createdDate": "2019-08-24T14:15:22.123Z",
    "createdById": "string",
    "lastModifiedDate": "2019-08-24T14:15:22.123Z",
    "lastModifiedById": "string",
    "id": "string",
    "groupAccountId": "string",
    "clientUserId": "string",
    "firstName": "string",
    "lastName": "string",
    "email": "string",
    "inviteAccepted": true,
    "groupAccount": {
        "id": "string",
        "accountName": "string",
        "dateCreated": "2019-08-24T14:15:22.123Z",
        "primaryAccountUserId": "string",
        "isWhiteLabelled": true,
        "whiteLabelledDomain": "string",
        "type": "string"
    },
    "clientUser": {
        "id": "string",
        "userName": "string",
        "normalizedUserName": "string",
        "email": "string",
        "normalizedEmail": "string",
        "emailConfirmed": true,
        "passwordHash": "string",
        "securityStamp": "string",
        "concurrencyStamp": "string",
        "phoneNumber": "string",
        "phoneNumberConfirmed": true,
        "twoFactorEnabled": true,
        "lockoutEnd": "2019-08-24T14:15:22.123Z",
        "lockoutEnabled": true,
        "accessFailedCount": 0,
        "shortId": "string",
        "firstName": "string",
        "lastName": "string",
        "dateCreated": "2019-08-24T14:15:22.123Z",
        "publicAccount": true,
        "profilePicture": "string",
        "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
            }
        },
        "accountSettingsId": "e6c65e8b-bdb8-4a1a-880a-33c8eb7b09cc",
        "groupAccountId": "string",
        "isActivated": true,
        "onboardingChecklistId": "3571c081-4c42-402b-9d7f-1c907c84d02b",
        "metadata": {
            "customerSegment": "string",
            "registrationInformation": {
                "source": "string",
                "utmSource": "string",
                "utmId": "string",
                "gclid": "string",
                "atClickId": "string",
                "otUserId": "string",
                "ipAddress": "string",
                "fbclid": "string",
                "hubspotCookie": "string"
            },
            "onPurchaseInformation": {
                "source": "string",
                "utmSource": "string",
                "utmId": "string",
                "gclid": "string",
                "atClickId": "string",
                "otUserId": "string",
                "ipAddress": "string",
                "fbclid": "string",
                "hubspotCookie": "string"
            },
            "onboardingSurvey": {
                "source": "string",
                "sourceOther": "string",
                "mainGoal": "string",
                "numEntities": "string"
            },
            "testimonialInformation": {
                "hasProvidedWebsiteReview": true,
                "lastTestimonialRequest": "2019-08-24T14:15:22.123Z"
            },
            "intercomSettings": {
                "intercomUserId": "string"
            }
        },
        "suspended": true,
        "externalUserId": "string",
        "accountSettings": {
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
            "subscriptionName": "string",
            "paymentPlatform": 1,
            "stripeCustomerId": "string",
            "iosIapInfo": {
                "originalPurchases": [
                    {
                        "id": "string",
                        "autoRenewing": true,
                        "isAcknowledged": true,
                        "productId": "string",
                        "transactionDateUtc": "2019-08-24T14:15:22.123Z"
                    }
                ],
                "currentPlanId": "string",
                "plan": {
                    "platformId": "string",
                    "productId": "string",
                    "platform": "string",
                    "provider": "string",
                    "duration": "string",
                    "amount": 0,
                    "displayName": "string",
                    "baseCurrency": "string",
                    "discontinued": true,
                    "holdingsAllowed": 0,
                    "portfoliosAllowed": 0,
                    "customGroupsAllowed": 0,
                    "subscriptionName": "string",
                    "linkedProvidersAllowed": 0,
                    "features": [
                        "string"
                    ]
                }
            },
            "subscriptionPeriodEnd": "2019-08-24T14:15:22.123Z",
            "subscriptionStatus": "string",
            "subscriptionActive": true,
            "isTrial": true,
            "holdingsAllowed": 0,
            "portfoliosAllowed": 0,
            "customGroupsAllowed": 0,
            "linkedProvidersAllowed": 0,
            "accountSetupComplete": true,
            "onboardingComplete": true,
            "billingCurrency": "string",
            "clientsAllowed": 0,
            "trialStartDate": "2019-08-24T14:15:22.123Z",
            "trialRestarts": 0,
            "billingSettings": {
                "defferedBilling": true
            }
        },
        "groupAccount": {
            "id": "string",
            "accountName": "string",
            "dateCreated": "2019-08-24T14:15:22.123Z",
            "primaryAccountUserId": "string",
            "isWhiteLabelled": true,
            "whiteLabelledDomain": "string",
            "type": "string"
        },
        "onboardingChecklist": {
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
            "checklistData": [
                {
                    "taskName": "string",
                    "isCompleted": true,
                    "reward": 0,
                    "unit": "string",
                    "dateCompleted": "2019-08-24T14:15:22.123Z",
                    "resolvesTasks": [
                        {}
                    ],
                    "isHidden": true
                }
            ]
        }
    }
}
Built with