Caruso GraphQL API Documentation (beta)
Introduction
The Caruso API is a GraphQL API that provides comprehensive access to the data available within Caruso. This API is in beta and is frequently changing.
Authorization
To use the Caruso GraphQL API, you will need to include an API token in request headers. You can obtain an API token from the Caruso Customer Success team.
Deprecated fields
From time to time as the API evolves, Caruso will deprecate API schema such as types, fields, queries, and mutations. Deprecated fields are prefixed with a @deprecated directive, and may be removed in future versions of the API. Caruso will endeavor to support deprecated fields for a period of time and provide a replacement for deprecated fields, but this is not guaranteed.
API Endpoints
https://admin-api.getcaruso.com/queryHeaders
# Your API token from the dashboard. Must be included in all API calls.
X-Authorization: Token <YOUR_TOKEN_HERE>Version
1.0.0-beta
Queries
account
Example
Query
query account($id: ID!) {
account(id: $id) {
id
created
updated
lastLoggedIn
email
hasPasswordSet
activationEmailLastSent
legalName {
...LegalNameFragment
}
preferredName
timeZone
dateOfBirth {
...DayMonthYearFragment
}
termsAgreed
isAccountLocked
accountLockedReason
addresses {
...VerifiableAddressFragment
}
phoneNumber {
...PhoneNumberFragment
}
emailConfirmed
status
setupStatus {
...AccountSetupStatusFragment
}
investingEntities {
...InvestingEntityFragment
}
identityVerifications {
...IdentityVerificationFragment
}
pepSearchResult {
...PEPSearchResultFragment
}
notes {
...NoteFragment
}
searchActivityFeed {
...ActivityFeedResultsFragment
}
totalPortfolioValue {
...MoneyFragment
}
jobTitle
industry
organization
twitterProfileUrl
linkedInProfileUrl
biography
accountManager {
...AdminUserFragment
}
tagsV2 {
...InvestorProfileTagFragment
}
connections {
...ConnectionFragment
}
outstandingTasks {
...TaskFragment
}
outstandingNotifications {
...AccountNotificationFragment
}
identityVerificationStatus
allHoldingsCSVUrl
identityVerificationLastSent
}
}
Variables
{"id": 4}
Response
{
"data": {
"account": {
"id": 4,
"created": "2007-12-03T10:15:30Z",
"updated": "2007-12-03T10:15:30Z",
"lastLoggedIn": "2007-12-03T10:15:30Z",
"email": "xyz789",
"hasPasswordSet": true,
"activationEmailLastSent": "2007-12-03T10:15:30Z",
"legalName": LegalName,
"preferredName": "xyz789",
"timeZone": "xyz789",
"dateOfBirth": DayMonthYear,
"termsAgreed": false,
"isAccountLocked": false,
"accountLockedReason": "xyz789",
"addresses": [VerifiableAddress],
"phoneNumber": PhoneNumber,
"emailConfirmed": false,
"status": "PENDING",
"setupStatus": AccountSetupStatus,
"investingEntities": [InvestingEntity],
"identityVerifications": [IdentityVerification],
"pepSearchResult": PEPSearchResult,
"notes": [Note],
"searchActivityFeed": ActivityFeedResults,
"totalPortfolioValue": Money,
"jobTitle": "xyz789",
"industry": "xyz789",
"organization": "xyz789",
"twitterProfileUrl": "http://www.test.com/",
"linkedInProfileUrl": "http://www.test.com/",
"biography": "abc123",
"accountManager": AdminUser,
"tagsV2": [InvestorProfileTag],
"connections": [Connection],
"outstandingTasks": [Task],
"outstandingNotifications": [AccountNotification],
"identityVerificationStatus": "INCOMPLETE",
"allHoldingsCSVUrl": "abc123",
"identityVerificationLastSent": "2007-12-03T10:15:30Z"
}
}
}
activeAdminUser
Description
returns the active admin user
Response
Returns an AdminUser
Example
Query
query activeAdminUser {
activeAdminUser {
id
email
firstName
lastName
profileImageUrl
status
role {
...AdminRoleFragment
}
jobTitle
phoneNumber {
...PhoneNumberFragment
}
calendlyUrl
team
outstandingTasks
intercomHash
}
}
Response
{
"data": {
"activeAdminUser": {
"id": 4,
"email": "xyz789",
"firstName": "xyz789",
"lastName": "abc123",
"profileImageUrl": "abc123",
"status": "ACTIVE",
"role": AdminRole,
"jobTitle": "abc123",
"phoneNumber": PhoneNumber,
"calendlyUrl": "http://www.test.com/",
"team": "INVESTOR_RELATIONS",
"outstandingTasks": 123,
"intercomHash": "xyz789"
}
}
}
adminUser
Description
Admin user by unique identifier
Example
Query
query adminUser($id: ID!) {
adminUser(id: $id) {
id
email
firstName
lastName
profileImageUrl
status
role {
...AdminRoleFragment
}
jobTitle
phoneNumber {
...PhoneNumberFragment
}
calendlyUrl
team
outstandingTasks
intercomHash
}
}
Variables
{"id": 4}
Response
{
"data": {
"adminUser": {
"id": 4,
"email": "abc123",
"firstName": "abc123",
"lastName": "xyz789",
"profileImageUrl": "xyz789",
"status": "ACTIVE",
"role": AdminRole,
"jobTitle": "abc123",
"phoneNumber": PhoneNumber,
"calendlyUrl": "http://www.test.com/",
"team": "INVESTOR_RELATIONS",
"outstandingTasks": 123,
"intercomHash": "abc123"
}
}
}
adminUsers
Response
Returns [AdminUser!]!
Example
Query
query adminUsers {
adminUsers {
id
email
firstName
lastName
profileImageUrl
status
role {
...AdminRoleFragment
}
jobTitle
phoneNumber {
...PhoneNumberFragment
}
calendlyUrl
team
outstandingTasks
intercomHash
}
}
Response
{
"data": {
"adminUsers": [
{
"id": 4,
"email": "abc123",
"firstName": "xyz789",
"lastName": "xyz789",
"profileImageUrl": "xyz789",
"status": "ACTIVE",
"role": AdminRole,
"jobTitle": "abc123",
"phoneNumber": PhoneNumber,
"calendlyUrl": "http://www.test.com/",
"team": "INVESTOR_RELATIONS",
"outstandingTasks": 987,
"intercomHash": "abc123"
}
]
}
}
allocation
Response
Returns an Allocation
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
query allocation($id: ID!) {
allocation(id: $id) {
id
createdAt
offer {
...OfferFragment
}
ownershipPercentage
investingEntity {
...InvestingEntityFragment
}
associatedContact {
... on InvestingEntity {
...InvestingEntityFragment
}
... on Account {
...AccountFragment
}
... on Prospect {
...ProspectFragment
}
}
status
unitCountDecimal {
...FixedPointNumberFragment
}
pricePerUnit {
...MoneyFragment
}
pricePerUnitV2 {
...HighPrecisionMoneyFragment
}
totalValue {
...MoneyFragment
}
expectedReference
payments {
...ManualAllocationPaymentFragment
}
totalPaid {
...MoneyFragment
}
note
balance {
...MoneyFragment
}
unitsIssued {
...FixedPointNumberFragment
}
issuedHolding {
...HoldingFragment
}
capitalCalled {
...HighPrecisionMoneyFragment
}
customFieldSection {
...CustomFieldSectionFragment
}
}
}
Variables
{"id": 4}
Response
{
"data": {
"allocation": {
"id": 4,
"createdAt": "2007-12-03T10:15:30Z",
"offer": Offer,
"ownershipPercentage": "abc123",
"investingEntity": InvestingEntity,
"associatedContact": InvestingEntity,
"status": "INTERESTED",
"unitCountDecimal": FixedPointNumber,
"pricePerUnit": Money,
"pricePerUnitV2": HighPrecisionMoney,
"totalValue": Money,
"expectedReference": "abc123",
"payments": [ManualAllocationPayment],
"totalPaid": Money,
"note": "xyz789",
"balance": Money,
"unitsIssued": FixedPointNumber,
"issuedHolding": Holding,
"capitalCalled": HighPrecisionMoney,
"customFieldSection": [CustomFieldSection]
}
}
}
asset
Description
Asset by unique identifier
Example
Query
query asset($id: ID!) {
asset(id: $id) {
id
name
address
country {
...CountryFragment
}
cardImage {
...RemoteAssetFragment
}
fund {
...FundFragment
}
}
}
Variables
{"id": 4}
Response
{
"data": {
"asset": {
"id": 4,
"name": "xyz789",
"address": "abc123",
"country": Country,
"cardImage": RemoteAsset,
"fund": Fund
}
}
}
assets
Description
Return all Assets
Response
Returns [Asset!]!
Example
Query
query assets {
assets {
id
name
address
country {
...CountryFragment
}
cardImage {
...RemoteAssetFragment
}
fund {
...FundFragment
}
}
}
Response
{
"data": {
"assets": [
{
"id": "4",
"name": "abc123",
"address": "abc123",
"country": Country,
"cardImage": RemoteAsset,
"fund": Fund
}
]
}
}
communication
Description
All communication related queries
Response
Returns a CommunicationQueries!
Example
Query
query communication {
communication {
email {
...EmailQueriesFragment
}
}
}
Response
{"data": {"communication": {"email": EmailQueries}}}
countries
Description
Return all Countries
Response
Returns [Country]!
Arguments
| Name | Description |
|---|---|
filters - [CountryFilter]
|
Example
Query
query countries($filters: [CountryFilter]) {
countries(filters: $filters) {
id
name
isoAlpha2
isoAlpha3
callingCode
}
}
Variables
{"filters": ["HAS_CURRENCY"]}
Response
{
"data": {
"countries": [
{
"id": 4,
"name": "New Zealand",
"isoAlpha2": "NZ",
"isoAlpha3": "NZL",
"callingCode": 64
}
]
}
}
currencies
Description
Return all Currencies
Response
Returns [Currency]!
Example
Query
query currencies {
currencies {
id
name
abbreviation
symbol
decimalSeparator
thousandsSeparator
}
}
Response
{
"data": {
"currencies": [
{
"id": 4,
"name": "New Zealand Dollar",
"abbreviation": "NZD",
"symbol": "$",
"decimalSeparator": ".",
"thousandsSeparator": ","
}
]
}
}
depositMethod
Description
Deposit method by unique identifier
Response
Returns a DepositMethod
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
query depositMethod($id: ID!) {
depositMethod(id: $id) {
id
name
paymentMethod {
... on BankAccountV2 {
...BankAccountV2Fragment
}
... on Cheque {
...ChequeFragment
}
... on Bpay {
...BpayFragment
}
}
isLinked
}
}
Variables
{"id": "4"}
Response
{
"data": {
"depositMethod": {
"id": 4,
"name": "xyz789",
"paymentMethod": BankAccountV2,
"isLinked": true
}
}
}
depositMethods
Description
Return all deposit methods
Response
Returns [DepositMethod!]!
Example
Query
query depositMethods {
depositMethods {
id
name
paymentMethod {
... on BankAccountV2 {
...BankAccountV2Fragment
}
... on Cheque {
...ChequeFragment
}
... on Bpay {
...BpayFragment
}
}
isLinked
}
}
Response
{
"data": {
"depositMethods": [
{
"id": 4,
"name": "abc123",
"paymentMethod": BankAccountV2,
"isLinked": false
}
]
}
}
features
Response
Returns [FeatureFlag!]!
Example
Query
query features {
features {
name
isEnabled
}
}
Response
{
"data": {
"features": [
{"name": "abc123", "isEnabled": false}
]
}
}
fund
Description
Fund by unique identifier
Example
Query
query fund($id: ID!) {
fund(id: $id) {
id
createdAt
updatedAt
name
legalName
shortDescription
summary {
...FundSummaryFragment
}
registrationNumber
legalStructure
assetStructure
inception
currency {
...CurrencyFragment
}
country {
...CountryFragment
}
cardImage {
...RemoteAssetFragment
}
totalUnitCountDecimal {
...FixedPointNumberFragment
}
calculatedNetAssetValue {
...MoneyFragment
}
targetCashReturn {
...FractionFragment
}
targetTotalReturn {
...FractionFragment
}
documents {
...FundDocumentFragment
}
assets {
...AssetFragment
}
asset {
...AssetFragment
}
offers {
...OfferFragment
}
distributions {
...DistributionFragment
}
searchDistributions {
...DistributionSearchResultsFragment
}
distribution {
...DistributionFragment
}
distributionV2 {
...DistributionV2Fragment
}
validateDistribution {
... on InvalidBankAccountDistributionAlert {
...InvalidBankAccountDistributionAlertFragment
}
}
secondaryMarket {
...SecondaryMarketFragment
}
sellOrder {
...SellOrderFragment
}
sellOrders {
...SellOrderFragment
}
buyOrder {
...BuyOrderFragment
}
buyOrders {
...BuyOrderFragment
}
offerStatus
investorType
largestOwnershipPercentageV2
numberOfActiveHoldings
fundManagerName
lastDistributionDate
equityRaised {
...MoneyFragment
}
hideDistributionMetrics
searchUnitRedemptionRequests {
...UnitRedemptionRequestSearchResultsFragment
}
unitRedemptionRequest {
...UnitRedemptionRequestFragment
}
unitRedemptionConfiguration {
...FundUnitRedemptionConfigurationFragment
}
unitPrecisionScale
searchUnitClasses {
...UnitClassSearchResultsFragment
}
showHoldingPageOnInvestorPortal
customMetrics {
...CustomMetricFragment
}
investorPortalConfiguration {
...FundInvestorPortalConfigurationFragment
}
unitTransferRequest {
...UnitTransferRequestFragment
}
depositBankAccount {
...BankAccountFragment
}
searchOutgoingBankAccounts {
...FundOutgoingBankAccountSearchResultsFragment
}
}
}
Variables
{"id": "4"}
Response
{
"data": {
"fund": {
"id": "4",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"name": "abc123",
"legalName": "xyz789",
"shortDescription": "xyz789",
"summary": FundSummary,
"registrationNumber": "abc123",
"legalStructure": "LIMITED_PARTNERSHIP",
"assetStructure": "SINGLE_ASSET",
"inception": "2007-12-03T10:15:30Z",
"currency": Currency,
"country": Country,
"cardImage": RemoteAsset,
"totalUnitCountDecimal": FixedPointNumber,
"calculatedNetAssetValue": Money,
"targetCashReturn": Fraction,
"targetTotalReturn": Fraction,
"documents": [FundDocument],
"assets": [Asset],
"asset": Asset,
"offers": [Offer],
"distributions": [Distribution],
"searchDistributions": DistributionSearchResults,
"distribution": Distribution,
"distributionV2": DistributionV2,
"validateDistribution": [
InvalidBankAccountDistributionAlert
],
"secondaryMarket": SecondaryMarket,
"sellOrder": SellOrder,
"sellOrders": [SellOrder],
"buyOrder": BuyOrder,
"buyOrders": [BuyOrder],
"offerStatus": "OPEN",
"investorType": "WHOLESALE",
"largestOwnershipPercentageV2": 123.45,
"numberOfActiveHoldings": 987,
"fundManagerName": "xyz789",
"lastDistributionDate": "2007-12-03T10:15:30Z",
"equityRaised": Money,
"hideDistributionMetrics": false,
"searchUnitRedemptionRequests": UnitRedemptionRequestSearchResults,
"unitRedemptionRequest": UnitRedemptionRequest,
"unitRedemptionConfiguration": FundUnitRedemptionConfiguration,
"unitPrecisionScale": 123,
"searchUnitClasses": UnitClassSearchResults,
"showHoldingPageOnInvestorPortal": false,
"customMetrics": [CustomMetric],
"investorPortalConfiguration": FundInvestorPortalConfiguration,
"unitTransferRequest": UnitTransferRequest,
"depositBankAccount": BankAccount,
"searchOutgoingBankAccounts": FundOutgoingBankAccountSearchResults
}
}
}
funds
Description
Return all Funds
Response
Returns [Fund!]!
Example
Query
query funds {
funds {
id
createdAt
updatedAt
name
legalName
shortDescription
summary {
...FundSummaryFragment
}
registrationNumber
legalStructure
assetStructure
inception
currency {
...CurrencyFragment
}
country {
...CountryFragment
}
cardImage {
...RemoteAssetFragment
}
totalUnitCountDecimal {
...FixedPointNumberFragment
}
calculatedNetAssetValue {
...MoneyFragment
}
targetCashReturn {
...FractionFragment
}
targetTotalReturn {
...FractionFragment
}
documents {
...FundDocumentFragment
}
assets {
...AssetFragment
}
asset {
...AssetFragment
}
offers {
...OfferFragment
}
distributions {
...DistributionFragment
}
searchDistributions {
...DistributionSearchResultsFragment
}
distribution {
...DistributionFragment
}
distributionV2 {
...DistributionV2Fragment
}
validateDistribution {
... on InvalidBankAccountDistributionAlert {
...InvalidBankAccountDistributionAlertFragment
}
}
secondaryMarket {
...SecondaryMarketFragment
}
sellOrder {
...SellOrderFragment
}
sellOrders {
...SellOrderFragment
}
buyOrder {
...BuyOrderFragment
}
buyOrders {
...BuyOrderFragment
}
offerStatus
investorType
largestOwnershipPercentageV2
numberOfActiveHoldings
fundManagerName
lastDistributionDate
equityRaised {
...MoneyFragment
}
hideDistributionMetrics
searchUnitRedemptionRequests {
...UnitRedemptionRequestSearchResultsFragment
}
unitRedemptionRequest {
...UnitRedemptionRequestFragment
}
unitRedemptionConfiguration {
...FundUnitRedemptionConfigurationFragment
}
unitPrecisionScale
searchUnitClasses {
...UnitClassSearchResultsFragment
}
showHoldingPageOnInvestorPortal
customMetrics {
...CustomMetricFragment
}
investorPortalConfiguration {
...FundInvestorPortalConfigurationFragment
}
unitTransferRequest {
...UnitTransferRequestFragment
}
depositBankAccount {
...BankAccountFragment
}
searchOutgoingBankAccounts {
...FundOutgoingBankAccountSearchResultsFragment
}
}
}
Response
{
"data": {
"funds": [
{
"id": 4,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"name": "xyz789",
"legalName": "xyz789",
"shortDescription": "xyz789",
"summary": FundSummary,
"registrationNumber": "xyz789",
"legalStructure": "LIMITED_PARTNERSHIP",
"assetStructure": "SINGLE_ASSET",
"inception": "2007-12-03T10:15:30Z",
"currency": Currency,
"country": Country,
"cardImage": RemoteAsset,
"totalUnitCountDecimal": FixedPointNumber,
"calculatedNetAssetValue": Money,
"targetCashReturn": Fraction,
"targetTotalReturn": Fraction,
"documents": [FundDocument],
"assets": [Asset],
"asset": Asset,
"offers": [Offer],
"distributions": [Distribution],
"searchDistributions": DistributionSearchResults,
"distribution": Distribution,
"distributionV2": DistributionV2,
"validateDistribution": [
InvalidBankAccountDistributionAlert
],
"secondaryMarket": SecondaryMarket,
"sellOrder": SellOrder,
"sellOrders": [SellOrder],
"buyOrder": BuyOrder,
"buyOrders": [BuyOrder],
"offerStatus": "OPEN",
"investorType": "WHOLESALE",
"largestOwnershipPercentageV2": 987.65,
"numberOfActiveHoldings": 123,
"fundManagerName": "abc123",
"lastDistributionDate": "2007-12-03T10:15:30Z",
"equityRaised": Money,
"hideDistributionMetrics": false,
"searchUnitRedemptionRequests": UnitRedemptionRequestSearchResults,
"unitRedemptionRequest": UnitRedemptionRequest,
"unitRedemptionConfiguration": FundUnitRedemptionConfiguration,
"unitPrecisionScale": 987,
"searchUnitClasses": UnitClassSearchResults,
"showHoldingPageOnInvestorPortal": false,
"customMetrics": [CustomMetric],
"investorPortalConfiguration": FundInvestorPortalConfiguration,
"unitTransferRequest": UnitTransferRequest,
"depositBankAccount": BankAccount,
"searchOutgoingBankAccounts": FundOutgoingBankAccountSearchResults
}
]
}
}
geocodePlaceId
Response
Returns a PlaceAddress
Example
Query
query geocodePlaceId(
$placeId: String!,
$sessionToken: String
) {
geocodePlaceId(
placeId: $placeId,
sessionToken: $sessionToken
) {
line1
suburb
postCode
city
country
description
administrativeArea
}
}
Variables
{
"placeId": "xyz789",
"sessionToken": "xyz789"
}
Response
{
"data": {
"geocodePlaceId": {
"line1": "xyz789",
"suburb": "abc123",
"postCode": "xyz789",
"city": "abc123",
"country": "xyz789",
"description": "abc123",
"administrativeArea": "xyz789"
}
}
}
importBatch
Description
The import batch with the given ID, if it exists.
Response
Returns an ImportBatch
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
query importBatch($id: ID!) {
importBatch(id: $id) {
id
createdAt
updatedAt
type
name
file {
...RemoteAssetFragment
}
createdBy {
...AdminUserFragment
}
confirmedBy {
...AdminUserFragment
}
confirmedAt
status
notificationTime
metadata {
... on UnitIssuanceImportMetadata {
...UnitIssuanceImportMetadataFragment
}
}
validationErrors {
...ImportValidationErrorFragment
}
importJobs {
...ImportJobFragment
}
}
}
Variables
{"id": "4"}
Response
{
"data": {
"importBatch": {
"id": "4",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"type": "UNIT_ISSUANCE",
"name": "abc123",
"file": RemoteAsset,
"createdBy": AdminUser,
"confirmedBy": AdminUser,
"confirmedAt": "2007-12-03T10:15:30Z",
"status": "GENERATING",
"notificationTime": "2007-12-03T10:15:30Z",
"metadata": UnitIssuanceImportMetadata,
"validationErrors": [ImportValidationError],
"importJobs": [ImportJob]
}
}
}
importBatchCsvTemplateUrl
Description
The URL to download a CSV template for the given import type.
Response
Returns a String!
Arguments
| Name | Description |
|---|---|
type - ImportJobType!
|
Example
Query
query importBatchCsvTemplateUrl($type: ImportJobType!) {
importBatchCsvTemplateUrl(type: $type)
}
Variables
{"type": "UNIT_ISSUANCE"}
Response
{
"data": {
"importBatchCsvTemplateUrl": "xyz789"
}
}
importBatches
Description
A paginated list of all the import batches
Response
Returns an ImportBatchConnection!
Example
Query
query importBatches(
$first: Int,
$after: Cursor
) {
importBatches(
first: $first,
after: $after
) {
pageInfo {
...PageInfoFragment
}
edges {
...ImportBatchEdgeFragment
}
}
}
Variables
{"first": 123, "after": Cursor}
Response
{
"data": {
"importBatches": {
"pageInfo": PageInfo,
"edges": [ImportBatchEdge]
}
}
}
investingEntity
Response
Returns an InvestingEntity
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
query investingEntity($id: ID!) {
investingEntity(id: $id) {
id
created
updated
entityType
entity {
... on IndividualInvestingEntity {
...IndividualInvestingEntityFragment
}
... on CompanyInvestingEntity {
...CompanyInvestingEntityFragment
}
... on TrustInvestingEntity {
...TrustInvestingEntityFragment
}
... on JointIndividualInvestingEntity {
...JointIndividualInvestingEntityFragment
}
... on PartnershipInvestingEntity {
...PartnershipInvestingEntityFragment
}
}
sourceOfFundsVerificationEmailLastSent
relationship
country {
...CountryFragment
}
bankAccounts {
...VerifiableBankAccountFragment
}
bankAccount {
...VerifiableBankAccountFragment
}
accreditationsStandardised {
...InvestingEntityStandardisedAccreditationFragment
}
accreditationCountry {
...CountryFragment
}
wholesaleCertificationStatus
primaryOwner {
...AccountFragment
}
accounts {
...AccountFragment
}
beneficialOwners {
...BeneficialOwnerFragment
}
beneficialOwner {
...BeneficialOwnerFragment
}
lastRequestedBeneficialOwnersContactDetails
lastRequestedWholesaleCertification
allocations {
...AllocationFragment
}
riskProfile {
...RiskProfileFragment
}
holdings {
...HoldingFragment
}
totalPortfolioValue {
...MoneyFragment
}
totalHoldingMarkedValue {
...MoneyFragment
}
totalCapitalContributed {
...MoneyFragment
}
searchActivityFeed {
...ActivityFeedResultsFragment
}
governingDocuments {
...InvestingEntityGoverningDocumentFragment
}
searchTransactionsV2 {
...SearchTransactionsResultsFragment
}
outstandingTaskCount
bankAccountVerificationStatus
sourceOfFundsVerificationStatus
outstandingTasks {
...TaskFragment
}
outstandingNotifications {
...InvestingEntityNotificationFragment
}
associatedAccounts {
...AssociatedAccountFragment
}
tags {
...InvestingEntityTagFragment
}
}
}
Variables
{"id": "4"}
Response
{
"data": {
"investingEntity": {
"id": 4,
"created": "2007-12-03T10:15:30Z",
"updated": "2007-12-03T10:15:30Z",
"entityType": "INDIVIDUAL",
"entity": IndividualInvestingEntity,
"sourceOfFundsVerificationEmailLastSent": "2007-12-03T10:15:30Z",
"relationship": "SHAREHOLDING_VOTING_RIGHTS_GREATER_THAN_25_PERCENT",
"country": Country,
"bankAccounts": [VerifiableBankAccount],
"bankAccount": VerifiableBankAccount,
"accreditationsStandardised": [
InvestingEntityStandardisedAccreditation
],
"accreditationCountry": Country,
"wholesaleCertificationStatus": "AWAITING",
"primaryOwner": Account,
"accounts": [Account],
"beneficialOwners": [BeneficialOwner],
"beneficialOwner": BeneficialOwner,
"lastRequestedBeneficialOwnersContactDetails": "2007-12-03T10:15:30Z",
"lastRequestedWholesaleCertification": "2007-12-03T10:15:30Z",
"allocations": [Allocation],
"riskProfile": RiskProfile,
"holdings": [Holding],
"totalPortfolioValue": Money,
"totalHoldingMarkedValue": Money,
"totalCapitalContributed": Money,
"searchActivityFeed": ActivityFeedResults,
"governingDocuments": [
InvestingEntityGoverningDocument
],
"searchTransactionsV2": SearchTransactionsResults,
"outstandingTaskCount": 987,
"bankAccountVerificationStatus": "PENDING",
"sourceOfFundsVerificationStatus": "COMPLETE",
"outstandingTasks": [Task],
"outstandingNotifications": [
InvestingEntityNotification
],
"associatedAccounts": [AssociatedAccount],
"tags": [InvestingEntityTag]
}
}
}
investorPortalConfiguration
Description
Configuration for the investor portal portfolio page
Response
Returns an InvestorPortalConfiguration
Example
Query
query investorPortalConfiguration {
investorPortalConfiguration {
portfolioKeyMetrics {
...PortfolioKeyMetricConfigFragment
}
portfolioGraphs {
...PortfolioGraphConfigFragment
}
portfolioTables {
...PortfolioTableConfigFragment
}
}
}
Response
{
"data": {
"investorPortalConfiguration": {
"portfolioKeyMetrics": [PortfolioKeyMetricConfig],
"portfolioGraphs": [PortfolioGraphConfig],
"portfolioTables": [PortfolioTableConfig]
}
}
}
offer
Description
Offer by unique identifier
Example
Query
query offer($id: ID!) {
offer(id: $id) {
capitalCallBatches {
...CapitalCallBatchConnectionFragment
}
capitalCallBatch {
...CapitalCallBatchFragment
}
id
displayName
createdAt
updatedAt
pricePerUnit {
...MoneyFragment
}
pricePerUnitV2 {
...HighPrecisionMoneyFragment
}
totalUnitCountDecimal {
...FixedPointNumberFragment
}
minimumUnitCountDecimal {
...FixedPointNumberFragment
}
maximumUnitCountDecimal {
...FixedPointNumberFragment
}
areUnitsIssued
status
openedAt
closedAt
fundsDeadline
settledAt
paymentReferencePrefix
allocations {
...AllocationFragment
}
capitalizationTable {
...CapitalizationTableFragment
}
totalEquity {
...MoneyFragment
}
totalEquityV2 {
...HighPrecisionMoneyFragment
}
registrationsOfInterest {
...RegistrationOfInterestFragment
}
fund {
...FundFragment
}
depositMethods {
...OfferDepositMethodFragment
}
digitalSubscription
slug
dataRoom {
...OfferDataRoomFragment
}
unitClass {
...UnitClassFragment
}
searchAllocations {
...AllocationSearchResultsFragment
}
}
}
Variables
{"id": 4}
Response
{
"data": {
"offer": {
"capitalCallBatches": CapitalCallBatchConnection,
"capitalCallBatch": CapitalCallBatch,
"id": "4",
"displayName": "xyz789",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"pricePerUnit": Money,
"pricePerUnitV2": HighPrecisionMoney,
"totalUnitCountDecimal": FixedPointNumber,
"minimumUnitCountDecimal": FixedPointNumber,
"maximumUnitCountDecimal": FixedPointNumber,
"areUnitsIssued": true,
"status": "OPEN",
"openedAt": "2007-12-03T10:15:30Z",
"closedAt": "2007-12-03T10:15:30Z",
"fundsDeadline": "2007-12-03T10:15:30Z",
"settledAt": "2007-12-03T10:15:30Z",
"paymentReferencePrefix": "abc123",
"allocations": [Allocation],
"capitalizationTable": CapitalizationTable,
"totalEquity": Money,
"totalEquityV2": HighPrecisionMoney,
"registrationsOfInterest": [RegistrationOfInterest],
"fund": Fund,
"depositMethods": [OfferDepositMethod],
"digitalSubscription": "ENABLED",
"slug": "xyz789",
"dataRoom": OfferDataRoom,
"unitClass": UnitClass,
"searchAllocations": AllocationSearchResults
}
}
}
offers
Description
Return all offers
Response
Returns [Offer!]!
Example
Query
query offers {
offers {
capitalCallBatches {
...CapitalCallBatchConnectionFragment
}
capitalCallBatch {
...CapitalCallBatchFragment
}
id
displayName
createdAt
updatedAt
pricePerUnit {
...MoneyFragment
}
pricePerUnitV2 {
...HighPrecisionMoneyFragment
}
totalUnitCountDecimal {
...FixedPointNumberFragment
}
minimumUnitCountDecimal {
...FixedPointNumberFragment
}
maximumUnitCountDecimal {
...FixedPointNumberFragment
}
areUnitsIssued
status
openedAt
closedAt
fundsDeadline
settledAt
paymentReferencePrefix
allocations {
...AllocationFragment
}
capitalizationTable {
...CapitalizationTableFragment
}
totalEquity {
...MoneyFragment
}
totalEquityV2 {
...HighPrecisionMoneyFragment
}
registrationsOfInterest {
...RegistrationOfInterestFragment
}
fund {
...FundFragment
}
depositMethods {
...OfferDepositMethodFragment
}
digitalSubscription
slug
dataRoom {
...OfferDataRoomFragment
}
unitClass {
...UnitClassFragment
}
searchAllocations {
...AllocationSearchResultsFragment
}
}
}
Response
{
"data": {
"offers": [
{
"capitalCallBatches": CapitalCallBatchConnection,
"capitalCallBatch": CapitalCallBatch,
"id": 4,
"displayName": "abc123",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"pricePerUnit": Money,
"pricePerUnitV2": HighPrecisionMoney,
"totalUnitCountDecimal": FixedPointNumber,
"minimumUnitCountDecimal": FixedPointNumber,
"maximumUnitCountDecimal": FixedPointNumber,
"areUnitsIssued": true,
"status": "OPEN",
"openedAt": "2007-12-03T10:15:30Z",
"closedAt": "2007-12-03T10:15:30Z",
"fundsDeadline": "2007-12-03T10:15:30Z",
"settledAt": "2007-12-03T10:15:30Z",
"paymentReferencePrefix": "xyz789",
"allocations": [Allocation],
"capitalizationTable": CapitalizationTable,
"totalEquity": Money,
"totalEquityV2": HighPrecisionMoney,
"registrationsOfInterest": [
RegistrationOfInterest
],
"fund": Fund,
"depositMethods": [OfferDepositMethod],
"digitalSubscription": "ENABLED",
"slug": "xyz789",
"dataRoom": OfferDataRoom,
"unitClass": UnitClass,
"searchAllocations": AllocationSearchResults
}
]
}
}
permissions
Response
Returns a Permissions!
Example
Query
query permissions {
permissions {
mutationPermissions {
...MutationPermissionFragment
}
typePermissions {
...TypePermissionFragment
}
}
}
Response
{
"data": {
"permissions": {
"mutationPermissions": [MutationPermission],
"typePermissions": [TypePermission]
}
}
}
prospect
Description
Prospect by unique identifier
Example
Query
query prospect($id: ID!) {
prospect(id: $id) {
id
created
email
firstName
middleName
lastName
preferredName
dateOfBirth {
...DayMonthYearFragment
}
address {
...AddressFragment
}
phoneNumber {
...PhoneNumberFragment
}
jobTitle
industry
organization
twitterProfileUrl
linkedInProfileUrl
biography
searchActivityFeed {
...ActivityFeedResultsFragment
}
tagsV2 {
...InvestorProfileTagFragment
}
connections {
...ConnectionFragment
}
outstandingTasks {
...TaskFragment
}
}
}
Variables
{"id": "4"}
Response
{
"data": {
"prospect": {
"id": 4,
"created": "2007-12-03T10:15:30Z",
"email": "xyz789",
"firstName": "xyz789",
"middleName": "abc123",
"lastName": "abc123",
"preferredName": "xyz789",
"dateOfBirth": DayMonthYear,
"address": Address,
"phoneNumber": PhoneNumber,
"jobTitle": "abc123",
"industry": "xyz789",
"organization": "xyz789",
"twitterProfileUrl": "http://www.test.com/",
"linkedInProfileUrl": "http://www.test.com/",
"biography": "abc123",
"searchActivityFeed": ActivityFeedResults,
"tagsV2": [InvestorProfileTag],
"connections": [Connection],
"outstandingTasks": [Task]
}
}
}
reports
Description
All default reports
Response
Returns a Reports!
Example
Query
query reports {
reports {
allAccountsCSVUrl
allInvestingEntitiesCSVUrl
allInvestorPortalActivitiesCSVUrl
allHoldingsMovementCSVUrl
allHoldingsCSVUrl
allAllocationsCSVUrl
allPepChecksCSVUrl
allInvestorLifetimeValueCSVUrl
allDepositsReportCSVUrl
identityDuplicatesCSVUrl
fundHoldingsCSVUrl
fundHoldingsMovementCSVUrl
offerAllocationRequestsCSVUrl
operationsCSVUrl
apportionmentCSVUrl
fundUnitRedemptionsCSVUrl
allTasksReportCSVUrl
}
}
Response
{
"data": {
"reports": {
"allAccountsCSVUrl": "xyz789",
"allInvestingEntitiesCSVUrl": "xyz789",
"allInvestorPortalActivitiesCSVUrl": "abc123",
"allHoldingsMovementCSVUrl": "abc123",
"allHoldingsCSVUrl": "abc123",
"allAllocationsCSVUrl": "abc123",
"allPepChecksCSVUrl": "xyz789",
"allInvestorLifetimeValueCSVUrl": "xyz789",
"allDepositsReportCSVUrl": "abc123",
"identityDuplicatesCSVUrl": "xyz789",
"fundHoldingsCSVUrl": "abc123",
"fundHoldingsMovementCSVUrl": "abc123",
"offerAllocationRequestsCSVUrl": "xyz789",
"operationsCSVUrl": "xyz789",
"apportionmentCSVUrl": "abc123",
"fundUnitRedemptionsCSVUrl": "abc123",
"allTasksReportCSVUrl": "abc123"
}
}
}
roles
Use rolesV2 instead
Response
Returns [AdminRole!]!
Example
Query
query roles {
roles {
id
sequence
name
description
}
}
Response
{
"data": {
"roles": [
{
"id": "4",
"sequence": 123,
"name": "xyz789",
"description": "xyz789"
}
]
}
}
rolesV2
Response
Returns [Role!]!
Example
Query
query rolesV2 {
rolesV2 {
id
sequence
name
description
systemRole
permissions {
...PermissionFragment
}
}
}
Response
{
"data": {
"rolesV2": [
{
"id": 4,
"sequence": 123,
"name": "xyz789",
"description": "xyz789",
"systemRole": false,
"permissions": [Permission]
}
]
}
}
searchAccountActivity
Description
Query and return a paginated list of Activity for an Account
Response
Returns an ActivitySearchResults!
Example
Query
query searchAccountActivity(
$accountId: ID!,
$first: Int!,
$after: ID,
$keywords: String
) {
searchAccountActivity(
accountId: $accountId,
first: $first,
after: $after,
keywords: $keywords
) {
edges {
...ActivityMessageEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
}
Variables
{
"accountId": 4,
"first": 987,
"after": "4",
"keywords": "xyz789"
}
Response
{
"data": {
"searchAccountActivity": {
"edges": [ActivityMessageEdge],
"pageInfo": PageInfo
}
}
}
searchAddress
Response
Returns an AddressSearchResults!
Arguments
| Name | Description |
|---|---|
query - String!
|
|
searchType - AddressSearchType!
|
|
sessionToken - String
|
Example
Query
query searchAddress(
$query: String!,
$searchType: AddressSearchType!,
$sessionToken: String
) {
searchAddress(
query: $query,
searchType: $searchType,
sessionToken: $sessionToken
) {
results {
...AddressSearchResultFragment
}
sessionToken
}
}
Variables
{
"query": "abc123",
"searchType": "ADDRESS",
"sessionToken": "abc123"
}
Response
{
"data": {
"searchAddress": {
"results": [AddressSearchResult],
"sessionToken": "xyz789"
}
}
}
searchAllocations
Description
Query and return a paginated list of Allocations
Response
Returns an AllocationSearchResults!
Example
Query
query searchAllocations(
$first: Int!,
$after: ID,
$keywords: String,
$statuses: [AllocationStatus!],
$aboveAmount: Float,
$belowAmount: Float
) {
searchAllocations(
first: $first,
after: $after,
keywords: $keywords,
statuses: $statuses,
aboveAmount: $aboveAmount,
belowAmount: $belowAmount
) {
edges {
...AllocationEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
}
Variables
{
"first": 123,
"after": 4,
"keywords": "abc123",
"statuses": ["INTERESTED"],
"aboveAmount": 123.45,
"belowAmount": 123.45
}
Response
{
"data": {
"searchAllocations": {
"edges": [AllocationEdge],
"pageInfo": PageInfo
}
}
}
searchAuditLog
Description
Query and return a paginated list of AuditLogEntries
Response
Returns an AuditLogEntryConnection!
Arguments
| Name | Description |
|---|---|
first - Int!
|
|
after - String
|
|
associatedRecordType - [AuditLogAssociatedRecordType!]
|
|
adminId - [ID!]
|
|
application - [AuditLogApplicationType!]
|
|
dateFrom - DateTime
|
|
dateTo - DateTime
|
Example
Query
query searchAuditLog(
$first: Int!,
$after: String,
$associatedRecordType: [AuditLogAssociatedRecordType!],
$adminId: [ID!],
$application: [AuditLogApplicationType!],
$dateFrom: DateTime,
$dateTo: DateTime
) {
searchAuditLog(
first: $first,
after: $after,
associatedRecordType: $associatedRecordType,
adminId: $adminId,
application: $application,
dateFrom: $dateFrom,
dateTo: $dateTo
) {
edges {
...AuditLogEntryEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
}
Variables
{
"first": 987,
"after": "abc123",
"associatedRecordType": ["ACCOUNT"],
"adminId": ["4"],
"application": ["ADMIN_APP"],
"dateFrom": "2007-12-03T10:15:30Z",
"dateTo": "2007-12-03T10:15:30Z"
}
Response
{
"data": {
"searchAuditLog": {
"edges": [AuditLogEntryEdge],
"pageInfo": PageInfo
}
}
}
searchBeneficialOwners
Description
Query and return a paginated list of Beneficial Owners
Response
Returns a BeneficialOwnerSearchResults!
Example
Query
query searchBeneficialOwners(
$first: Int!,
$after: ID,
$keywords: String
) {
searchBeneficialOwners(
first: $first,
after: $after,
keywords: $keywords
) {
pageInfo {
...PageInfoFragment
}
edges {
...BeneficialOwnerEdgeFragment
}
}
}
Variables
{
"first": 123,
"after": "4",
"keywords": "abc123"
}
Response
{
"data": {
"searchBeneficialOwners": {
"pageInfo": PageInfo,
"edges": [BeneficialOwnerEdge]
}
}
}
searchCompanies
Response
Returns [CompanyResult]!
Example
Query
query searchCompanies(
$query: String!,
$countryId: ID!
) {
searchCompanies(
query: $query,
countryId: $countryId
) {
id
countryId
name
}
}
Variables
{"query": "xyz789", "countryId": 4}
Response
{
"data": {
"searchCompanies": [
{
"id": "4",
"countryId": "4",
"name": "abc123"
}
]
}
}
searchFunds
Response
Returns a FundSearchResults!
Arguments
| Name | Description |
|---|---|
first - Int!
|
|
after - ID
|
|
filters - FundSearchFilters
|
|
sort - FundSearchSort
|
Example
Query
query searchFunds(
$first: Int!,
$after: ID,
$filters: FundSearchFilters,
$sort: FundSearchSort
) {
searchFunds(
first: $first,
after: $after,
filters: $filters,
sort: $sort
) {
pageInfo {
...PageInfoFragment
}
edges {
...FundEdgeFragment
}
}
}
Variables
{
"first": 123,
"after": "4",
"filters": FundSearchFilters,
"sort": FundSearchSort
}
Response
{
"data": {
"searchFunds": {
"pageInfo": PageInfo,
"edges": [FundEdge]
}
}
}
searchHoldings
Response
Returns a HoldingSearchResults!
Arguments
| Name | Description |
|---|---|
first - Int!
|
|
after - ID
|
|
associatedRecord - HoldingAssociatedRecordFilter
|
Example
Query
query searchHoldings(
$first: Int!,
$after: ID,
$associatedRecord: HoldingAssociatedRecordFilter
) {
searchHoldings(
first: $first,
after: $after,
associatedRecord: $associatedRecord
) {
pageInfo {
...PageInfoFragment
}
edges {
...HoldingEdgeFragment
}
}
}
Variables
{
"first": 123,
"after": 4,
"associatedRecord": HoldingAssociatedRecordFilter
}
Response
{
"data": {
"searchHoldings": {
"pageInfo": PageInfo,
"edges": [HoldingEdge]
}
}
}
searchInvestingEntities
Description
Query and return a paginated list of InvestingEntities
Response
Returns an InvestingEntitySearchResults!
Arguments
| Name | Description |
|---|---|
first - Int!
|
|
after - ID
|
|
keywords - String
|
|
entityTypes - [InvestingEntityType!]
|
|
activeHoldings - InvestingEntityActiveHoldingsFilter
|
|
riskProfile - [InvestingEntityRiskProfileFilter!]
|
|
tags - [ID!]
|
Example
Query
query searchInvestingEntities(
$first: Int!,
$after: ID,
$keywords: String,
$entityTypes: [InvestingEntityType!],
$activeHoldings: InvestingEntityActiveHoldingsFilter,
$riskProfile: [InvestingEntityRiskProfileFilter!],
$tags: [ID!]
) {
searchInvestingEntities(
first: $first,
after: $after,
keywords: $keywords,
entityTypes: $entityTypes,
activeHoldings: $activeHoldings,
riskProfile: $riskProfile,
tags: $tags
) {
edges {
...InvestingEntityEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
}
Variables
{
"first": 123,
"after": 4,
"keywords": "abc123",
"entityTypes": ["INDIVIDUAL"],
"activeHoldings": "ZERO_HOLDINGS",
"riskProfile": ["ONE"],
"tags": [4]
}
Response
{
"data": {
"searchInvestingEntities": {
"edges": [InvestingEntityEdge],
"pageInfo": PageInfo
}
}
}
searchInvestingEntityActivity
Description
Query and return a paginated list of Activity for an InvestingEntity
Response
Returns an ActivitySearchResults!
Example
Query
query searchInvestingEntityActivity(
$investingEntityId: ID!,
$first: Int!,
$after: ID,
$keywords: String
) {
searchInvestingEntityActivity(
investingEntityId: $investingEntityId,
first: $first,
after: $after,
keywords: $keywords
) {
edges {
...ActivityMessageEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
}
Variables
{
"investingEntityId": 4,
"first": 123,
"after": 4,
"keywords": "abc123"
}
Response
{
"data": {
"searchInvestingEntityActivity": {
"edges": [ActivityMessageEdge],
"pageInfo": PageInfo
}
}
}
searchInvestorProfiles
Description
Query and return a paginated list of Investor profiles - accounts and prospects
Response
Returns an InvestorProfileSearchResult!
Arguments
| Name | Description |
|---|---|
first - Int!
|
|
after - ID
|
|
keywords - String
|
|
statuses - [InvestorProfileStatus!]
|
|
identityVerificationStatuses - [IdentityVerificationStatus!]
|
|
countryIds - [ID!]
|
|
tagsV2 - [ID!]
|
Filter by the ids of the tags to search for |
Example
Query
query searchInvestorProfiles(
$first: Int!,
$after: ID,
$keywords: String,
$statuses: [InvestorProfileStatus!],
$identityVerificationStatuses: [IdentityVerificationStatus!],
$countryIds: [ID!],
$tagsV2: [ID!]
) {
searchInvestorProfiles(
first: $first,
after: $after,
keywords: $keywords,
statuses: $statuses,
identityVerificationStatuses: $identityVerificationStatuses,
countryIds: $countryIds,
tagsV2: $tagsV2
) {
edges {
...InvestorProfileEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
}
Variables
{
"first": 123,
"after": "4",
"keywords": "abc123",
"statuses": ["ACTIVE"],
"identityVerificationStatuses": ["INCOMPLETE"],
"countryIds": [4],
"tagsV2": ["4"]
}
Response
{
"data": {
"searchInvestorProfiles": {
"edges": [InvestorProfileEdge],
"pageInfo": PageInfo
}
}
}
searchNotes
Description
Query and return a paginated list of notes
Response
Returns a NoteSearchResults!
Arguments
| Name | Description |
|---|---|
first - Int!
|
|
after - ID
|
The cursor that is provided in NoteSearchResults |
associatedRecord - NoteAssociatedRecordFilter
|
If provided, will only return notes for the selected record |
sort - NoteSearchSort
|
Optionally sort the results - if not provided, will sort by ID |
Example
Query
query searchNotes(
$first: Int!,
$after: ID,
$associatedRecord: NoteAssociatedRecordFilter,
$sort: NoteSearchSort
) {
searchNotes(
first: $first,
after: $after,
associatedRecord: $associatedRecord,
sort: $sort
) {
edges {
...NoteEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
}
Variables
{
"first": 987,
"after": "4",
"associatedRecord": NoteAssociatedRecordFilter,
"sort": NoteSearchSort
}
Response
{
"data": {
"searchNotes": {
"edges": [NoteEdge],
"pageInfo": PageInfo
}
}
}
searchOrders
Description
Query and return a paginated list of Orders
Response
Returns an OrderSearchResults!
Arguments
| Name | Description |
|---|---|
first - Int!
|
|
after - ID
|
|
keywords - String
|
|
statuses - [OrderStatus!]
|
|
orderTypes - [OrderType!]
|
|
associatedRecord - OrderAssociatedRecordFilter
|
|
sort - OrderSearchSort
|
Example
Query
query searchOrders(
$first: Int!,
$after: ID,
$keywords: String,
$statuses: [OrderStatus!],
$orderTypes: [OrderType!],
$associatedRecord: OrderAssociatedRecordFilter,
$sort: OrderSearchSort
) {
searchOrders(
first: $first,
after: $after,
keywords: $keywords,
statuses: $statuses,
orderTypes: $orderTypes,
associatedRecord: $associatedRecord,
sort: $sort
) {
edges {
...OrderEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
}
Variables
{
"first": 123,
"after": "4",
"keywords": "abc123",
"statuses": ["REQUESTED"],
"orderTypes": ["ALLOCATION"],
"associatedRecord": OrderAssociatedRecordFilter,
"sort": OrderSearchSort
}
Response
{
"data": {
"searchOrders": {
"edges": [OrderEdge],
"pageInfo": PageInfo
}
}
}
searchTasks
Description
Query and return a paginated list of tasks
Response
Returns a TaskSearchResults!
Arguments
| Name | Description |
|---|---|
first - Int!
|
|
after - ID
|
|
keywords - String
|
|
assignedAdminIds - [ID!]
|
|
assignedTeams - [TaskAssignedTeam!]
|
|
statuses - [TaskStatus!]
|
|
sort - TaskSearchSort
|
|
priorities - [TaskPriority!]
|
|
associatedRecord - TaskAssociatedRecordFilter
|
|
categories - [TaskSearchCategory!]
|
Example
Query
query searchTasks(
$first: Int!,
$after: ID,
$keywords: String,
$assignedAdminIds: [ID!],
$assignedTeams: [TaskAssignedTeam!],
$statuses: [TaskStatus!],
$sort: TaskSearchSort,
$priorities: [TaskPriority!],
$associatedRecord: TaskAssociatedRecordFilter,
$categories: [TaskSearchCategory!]
) {
searchTasks(
first: $first,
after: $after,
keywords: $keywords,
assignedAdminIds: $assignedAdminIds,
assignedTeams: $assignedTeams,
statuses: $statuses,
sort: $sort,
priorities: $priorities,
associatedRecord: $associatedRecord,
categories: $categories
) {
edges {
...TaskEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
}
Variables
{
"first": 123,
"after": "4",
"keywords": "xyz789",
"assignedAdminIds": ["4"],
"assignedTeams": ["UNASSIGNED"],
"statuses": ["OPEN"],
"sort": TaskSearchSort,
"priorities": ["NO_PRIORITY"],
"associatedRecord": TaskAssociatedRecordFilter,
"categories": ["CALL"]
}
Response
{
"data": {
"searchTasks": {
"edges": [TaskEdge],
"pageInfo": PageInfo
}
}
}
searchTransactionsV2
Description
Query and return a paginated list of Transactions
Response
Returns a SearchTransactionsResults!
Arguments
| Name | Description |
|---|---|
first - Int!
|
|
after - ID
|
|
statuses - [SearchTransactionStatus!]
|
|
transactionTypes - [SearchTransactionType!]
|
Example
Query
query searchTransactionsV2(
$first: Int!,
$after: ID,
$statuses: [SearchTransactionStatus!],
$transactionTypes: [SearchTransactionType!]
) {
searchTransactionsV2(
first: $first,
after: $after,
statuses: $statuses,
transactionTypes: $transactionTypes
) {
edges {
...SearchTransactionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
}
Variables
{
"first": 123,
"after": 4,
"statuses": ["WITHHELD"],
"transactionTypes": ["NEW_INVESTMENT"]
}
Response
{
"data": {
"searchTransactionsV2": {
"edges": [SearchTransactionEdge],
"pageInfo": PageInfo
}
}
}
searchUnreconciledDeposits
Description
Query and return a paginated list of unreconciled deposits
Response
Returns an UnreconciledDepositResults!
Example
Query
query searchUnreconciledDeposits(
$first: Int!,
$after: ID
) {
searchUnreconciledDeposits(
first: $first,
after: $after
) {
edges {
...UnreconciledDepositEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
}
Variables
{"first": 987, "after": "4"}
Response
{
"data": {
"searchUnreconciledDeposits": {
"edges": [UnreconciledDepositEdge],
"pageInfo": PageInfo
}
}
}
statementBatch
Description
The statement batch with the given ID, if it exists.
Response
Returns a StatementBatch
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
query statementBatch($id: ID!) {
statementBatch(id: $id) {
id
name
createdAt
status
noData
configuration {
... on InvestorStatementConfig {
...InvestorStatementConfigFragment
}
... on TaxStatementConfig {
...TaxStatementConfigFragment
}
... on HoldingStatementConfig {
...HoldingStatementConfigFragment
}
... on PeriodicStatementConfig {
...PeriodicStatementConfigFragment
}
}
generation {
...StatementGenerationFragment
}
enrichment {
...StatementEnrichmentFragment
}
confirmation {
...StatementConfirmationFragment
}
publication {
...StatementPublicationFragment
}
numberOfStatements
statements {
...StatementConnectionFragment
}
}
}
Variables
{"id": "4"}
Response
{
"data": {
"statementBatch": {
"id": 4,
"name": "xyz789",
"createdAt": "2007-12-03T10:15:30Z",
"status": "GENERATING",
"noData": false,
"configuration": InvestorStatementConfig,
"generation": StatementGeneration,
"enrichment": StatementEnrichment,
"confirmation": StatementConfirmation,
"publication": StatementPublication,
"numberOfStatements": 123,
"statements": StatementConnection
}
}
}
statementBatches
Description
A paginated list of all the statement batches
Response
Returns a StatementBatchConnection!
Example
Query
query statementBatches(
$first: Int,
$after: Cursor
) {
statementBatches(
first: $first,
after: $after
) {
pageInfo {
...PageInfoFragment
}
edges {
...StatementBatchEdgeFragment
}
}
}
Variables
{"first": 987, "after": Cursor}
Response
{
"data": {
"statementBatches": {
"pageInfo": PageInfo,
"edges": [StatementBatchEdge]
}
}
}
task
Description
Return task by ID
Example
Query
query task($id: ID!) {
task(id: $id) {
id
title
created
updated
dueAt
status
assignedAdmin {
...AdminUserFragment
}
notes {
...NoteFragment
}
documents {
...TaskDocumentFragment
}
priority
relatedTasks {
...TaskFragment
}
assignedTeam
}
}
Variables
{"id": 4}
Response
{
"data": {
"task": {
"id": 4,
"title": "xyz789",
"created": "2007-12-03T10:15:30Z",
"updated": "2007-12-03T10:15:30Z",
"dueAt": "2007-12-03T10:15:30Z",
"status": "OPEN",
"assignedAdmin": AdminUser,
"notes": [Note],
"documents": [TaskDocument],
"priority": "NO_PRIORITY",
"relatedTasks": [Task],
"assignedTeam": "UNASSIGNED"
}
}
}
tenantConfiguration
Description
returns tenant configuration
Response
Returns a TenantConfiguration!
Example
Query
query tenantConfiguration {
tenantConfiguration {
general {
...TenantGeneralConfigurationFragment
}
emails {
...TenantEmailsConfigurationFragment
}
resources {
...TenantResourcesConfigurationFragment
}
links {
...TenantLinksConfigurationFragment
}
logos {
...TenantLogosConfigurationFragment
}
colors {
...TenantColorsConfigurationFragment
}
}
}
Response
{
"data": {
"tenantConfiguration": {
"general": TenantGeneralConfiguration,
"emails": TenantEmailsConfiguration,
"resources": TenantResourcesConfiguration,
"links": TenantLinksConfiguration,
"logos": TenantLogosConfiguration,
"colors": TenantColorsConfiguration
}
}
}
unitClass
Description
Query a unit class by ID
Example
Query
query unitClass($id: ID!) {
unitClass(id: $id) {
id
name
code
note
createdAt
unitCount {
...FixedPointNumberFragment
}
holdingCount
unitPrice {
...HighPrecisionMoneyFragment
}
netAssetValue {
...HighPrecisionMoneyFragment
}
outgoingBankAccount {
...FundOutgoingBankAccountFragment
}
managementFees {
...UnitClassFeeFragment
}
unitPrices {
...UnitPriceFragment
}
distributionRates {
...UnitClassDistributionRateFragment
}
}
}
Variables
{"id": 4}
Response
{
"data": {
"unitClass": {
"id": "4",
"name": "abc123",
"code": "xyz789",
"note": "xyz789",
"createdAt": "2007-12-03T10:15:30Z",
"unitCount": FixedPointNumber,
"holdingCount": 987,
"unitPrice": HighPrecisionMoney,
"netAssetValue": HighPrecisionMoney,
"outgoingBankAccount": FundOutgoingBankAccount,
"managementFees": [UnitClassFee],
"unitPrices": [UnitPrice],
"distributionRates": [UnitClassDistributionRate]
}
}
}
validateBSBCode
Description
Check if a BSB code is valid
Response
Returns an BSBCodeValidationResponse!
Arguments
| Name | Description |
|---|---|
bsbCode - String!
|
The BSB code to validate - must be 6 digits long, optionally with a hyphen (e.g. '123456' or '123-456') |
Example
Query
query validateBSBCode($bsbCode: String!) {
validateBSBCode(bsbCode: $bsbCode) {
isValid
}
}
Variables
{"bsbCode": "xyz789"}
Response
{"data": {"validateBSBCode": {"isValid": true}}}
Mutations
acceptPEPMatch
Description
Accept a PEP Match
Response
Returns a PEPMatch!
Arguments
| Name | Description |
|---|---|
form - AcceptPEPMatchInput!
|
Example
Query
mutation acceptPEPMatch($form: AcceptPEPMatchInput!) {
acceptPEPMatch(form: $form) {
id
name
associates {
...PEPAssociateFragment
}
dateOfBirth
citizenship {
...CountryFragment
}
gender
confidence
images
notes
roles {
...PEPMatchRoleFragment
}
status
transactionId
checkedOn
statusUpdate {
...PEPMatchStatusUpdateFragment
}
}
}
Variables
{"form": AcceptPEPMatchInput}
Response
{
"data": {
"acceptPEPMatch": {
"id": "4",
"name": "abc123",
"associates": [PEPAssociate],
"dateOfBirth": "abc123",
"citizenship": Country,
"gender": "abc123",
"confidence": 123.45,
"images": ["xyz789"],
"notes": HTML,
"roles": [PEPMatchRole],
"status": "PENDING",
"transactionId": "xyz789",
"checkedOn": "2007-12-03T10:15:30Z",
"statusUpdate": PEPMatchStatusUpdate
}
}
}
addAccountNote
Description
Add an account note
Response
Returns a Note!
Arguments
| Name | Description |
|---|---|
form - AddAccountNoteInput!
|
Example
Query
mutation addAccountNote($form: AddAccountNoteInput!) {
addAccountNote(form: $form) {
id
created
message
lastModifiedDetails {
...NoteLastModifiedDetailsFragment
}
isPinned
}
}
Variables
{"form": AddAccountNoteInput}
Response
{
"data": {
"addAccountNote": {
"id": "4",
"created": "2007-12-03T10:15:30Z",
"message": "xyz789",
"lastModifiedDetails": NoteLastModifiedDetails,
"isPinned": false
}
}
}
addAdminUsers
Description
Add admin user(s)
Response
Returns [AdminUser!]!
Arguments
| Name | Description |
|---|---|
form - AddAdminUsersInput!
|
Example
Query
mutation addAdminUsers($form: AddAdminUsersInput!) {
addAdminUsers(form: $form) {
id
email
firstName
lastName
profileImageUrl
status
role {
...AdminRoleFragment
}
jobTitle
phoneNumber {
...PhoneNumberFragment
}
calendlyUrl
team
outstandingTasks
intercomHash
}
}
Variables
{"form": AddAdminUsersInput}
Response
{
"data": {
"addAdminUsers": [
{
"id": 4,
"email": "xyz789",
"firstName": "xyz789",
"lastName": "abc123",
"profileImageUrl": "abc123",
"status": "ACTIVE",
"role": AdminRole,
"jobTitle": "xyz789",
"phoneNumber": PhoneNumber,
"calendlyUrl": "http://www.test.com/",
"team": "INVESTOR_RELATIONS",
"outstandingTasks": 123,
"intercomHash": "xyz789"
}
]
}
}
addBeneficialOwner
Description
Create a beneficial owner against an Investing Entity
Response
Returns an InvestingEntity!
Arguments
| Name | Description |
|---|---|
form - AddBeneficialOwnerInput!
|
Example
Query
mutation addBeneficialOwner($form: AddBeneficialOwnerInput!) {
addBeneficialOwner(form: $form) {
id
created
updated
entityType
entity {
... on IndividualInvestingEntity {
...IndividualInvestingEntityFragment
}
... on CompanyInvestingEntity {
...CompanyInvestingEntityFragment
}
... on TrustInvestingEntity {
...TrustInvestingEntityFragment
}
... on JointIndividualInvestingEntity {
...JointIndividualInvestingEntityFragment
}
... on PartnershipInvestingEntity {
...PartnershipInvestingEntityFragment
}
}
sourceOfFundsVerificationEmailLastSent
relationship
country {
...CountryFragment
}
bankAccounts {
...VerifiableBankAccountFragment
}
bankAccount {
...VerifiableBankAccountFragment
}
accreditationsStandardised {
...InvestingEntityStandardisedAccreditationFragment
}
accreditationCountry {
...CountryFragment
}
wholesaleCertificationStatus
primaryOwner {
...AccountFragment
}
accounts {
...AccountFragment
}
beneficialOwners {
...BeneficialOwnerFragment
}
beneficialOwner {
...BeneficialOwnerFragment
}
lastRequestedBeneficialOwnersContactDetails
lastRequestedWholesaleCertification
allocations {
...AllocationFragment
}
riskProfile {
...RiskProfileFragment
}
holdings {
...HoldingFragment
}
totalPortfolioValue {
...MoneyFragment
}
totalHoldingMarkedValue {
...MoneyFragment
}
totalCapitalContributed {
...MoneyFragment
}
searchActivityFeed {
...ActivityFeedResultsFragment
}
governingDocuments {
...InvestingEntityGoverningDocumentFragment
}
searchTransactionsV2 {
...SearchTransactionsResultsFragment
}
outstandingTaskCount
bankAccountVerificationStatus
sourceOfFundsVerificationStatus
outstandingTasks {
...TaskFragment
}
outstandingNotifications {
...InvestingEntityNotificationFragment
}
associatedAccounts {
...AssociatedAccountFragment
}
tags {
...InvestingEntityTagFragment
}
}
}
Variables
{"form": AddBeneficialOwnerInput}
Response
{
"data": {
"addBeneficialOwner": {
"id": 4,
"created": "2007-12-03T10:15:30Z",
"updated": "2007-12-03T10:15:30Z",
"entityType": "INDIVIDUAL",
"entity": IndividualInvestingEntity,
"sourceOfFundsVerificationEmailLastSent": "2007-12-03T10:15:30Z",
"relationship": "SHAREHOLDING_VOTING_RIGHTS_GREATER_THAN_25_PERCENT",
"country": Country,
"bankAccounts": [VerifiableBankAccount],
"bankAccount": VerifiableBankAccount,
"accreditationsStandardised": [
InvestingEntityStandardisedAccreditation
],
"accreditationCountry": Country,
"wholesaleCertificationStatus": "AWAITING",
"primaryOwner": Account,
"accounts": [Account],
"beneficialOwners": [BeneficialOwner],
"beneficialOwner": BeneficialOwner,
"lastRequestedBeneficialOwnersContactDetails": "2007-12-03T10:15:30Z",
"lastRequestedWholesaleCertification": "2007-12-03T10:15:30Z",
"allocations": [Allocation],
"riskProfile": RiskProfile,
"holdings": [Holding],
"totalPortfolioValue": Money,
"totalHoldingMarkedValue": Money,
"totalCapitalContributed": Money,
"searchActivityFeed": ActivityFeedResults,
"governingDocuments": [
InvestingEntityGoverningDocument
],
"searchTransactionsV2": SearchTransactionsResults,
"outstandingTaskCount": 123,
"bankAccountVerificationStatus": "PENDING",
"sourceOfFundsVerificationStatus": "COMPLETE",
"outstandingTasks": [Task],
"outstandingNotifications": [
InvestingEntityNotification
],
"associatedAccounts": [AssociatedAccount],
"tags": [InvestingEntityTag]
}
}
}
addBeneficialOwnerDocument
Description
Add a document to a beneficial owner
Response
Returns a BeneficialOwner!
Arguments
| Name | Description |
|---|---|
form - AddBeneficialOwnerDocumentInput
|
Example
Query
mutation addBeneficialOwnerDocument($form: AddBeneficialOwnerDocumentInput) {
addBeneficialOwnerDocument(form: $form) {
id
created
relationship
nodes {
...BeneficialOwnerFragment
}
notes {
...NoteFragment
}
activity {
...ActivityMessageFragment
}
uploadedDocuments {
...UploadedDocumentFragment
}
parent {
... on EntityBeneficialOwner {
...EntityBeneficialOwnerFragment
}
... on InvestingEntity {
...InvestingEntityFragment
}
}
}
}
Variables
{"form": AddBeneficialOwnerDocumentInput}
Response
{
"data": {
"addBeneficialOwnerDocument": {
"id": "4",
"created": "2007-12-03T10:15:30Z",
"relationship": "DIRECTOR",
"nodes": [BeneficialOwner],
"notes": [Note],
"activity": [ActivityMessage],
"uploadedDocuments": [UploadedDocument],
"parent": EntityBeneficialOwner
}
}
}
addInvestingEntityAccountLink
Description
Link an existing account to an investing entity
Response
Returns an InvestingEntity!
Arguments
| Name | Description |
|---|---|
form - AddInvestingEntityAccountLinkInput!
|
Example
Query
mutation addInvestingEntityAccountLink($form: AddInvestingEntityAccountLinkInput!) {
addInvestingEntityAccountLink(form: $form) {
id
created
updated
entityType
entity {
... on IndividualInvestingEntity {
...IndividualInvestingEntityFragment
}
... on CompanyInvestingEntity {
...CompanyInvestingEntityFragment
}
... on TrustInvestingEntity {
...TrustInvestingEntityFragment
}
... on JointIndividualInvestingEntity {
...JointIndividualInvestingEntityFragment
}
... on PartnershipInvestingEntity {
...PartnershipInvestingEntityFragment
}
}
sourceOfFundsVerificationEmailLastSent
relationship
country {
...CountryFragment
}
bankAccounts {
...VerifiableBankAccountFragment
}
bankAccount {
...VerifiableBankAccountFragment
}
accreditationsStandardised {
...InvestingEntityStandardisedAccreditationFragment
}
accreditationCountry {
...CountryFragment
}
wholesaleCertificationStatus
primaryOwner {
...AccountFragment
}
accounts {
...AccountFragment
}
beneficialOwners {
...BeneficialOwnerFragment
}
beneficialOwner {
...BeneficialOwnerFragment
}
lastRequestedBeneficialOwnersContactDetails
lastRequestedWholesaleCertification
allocations {
...AllocationFragment
}
riskProfile {
...RiskProfileFragment
}
holdings {
...HoldingFragment
}
totalPortfolioValue {
...MoneyFragment
}
totalHoldingMarkedValue {
...MoneyFragment
}
totalCapitalContributed {
...MoneyFragment
}
searchActivityFeed {
...ActivityFeedResultsFragment
}
governingDocuments {
...InvestingEntityGoverningDocumentFragment
}
searchTransactionsV2 {
...SearchTransactionsResultsFragment
}
outstandingTaskCount
bankAccountVerificationStatus
sourceOfFundsVerificationStatus
outstandingTasks {
...TaskFragment
}
outstandingNotifications {
...InvestingEntityNotificationFragment
}
associatedAccounts {
...AssociatedAccountFragment
}
tags {
...InvestingEntityTagFragment
}
}
}
Variables
{"form": AddInvestingEntityAccountLinkInput}
Response
{
"data": {
"addInvestingEntityAccountLink": {
"id": "4",
"created": "2007-12-03T10:15:30Z",
"updated": "2007-12-03T10:15:30Z",
"entityType": "INDIVIDUAL",
"entity": IndividualInvestingEntity,
"sourceOfFundsVerificationEmailLastSent": "2007-12-03T10:15:30Z",
"relationship": "SHAREHOLDING_VOTING_RIGHTS_GREATER_THAN_25_PERCENT",
"country": Country,
"bankAccounts": [VerifiableBankAccount],
"bankAccount": VerifiableBankAccount,
"accreditationsStandardised": [
InvestingEntityStandardisedAccreditation
],
"accreditationCountry": Country,
"wholesaleCertificationStatus": "AWAITING",
"primaryOwner": Account,
"accounts": [Account],
"beneficialOwners": [BeneficialOwner],
"beneficialOwner": BeneficialOwner,
"lastRequestedBeneficialOwnersContactDetails": "2007-12-03T10:15:30Z",
"lastRequestedWholesaleCertification": "2007-12-03T10:15:30Z",
"allocations": [Allocation],
"riskProfile": RiskProfile,
"holdings": [Holding],
"totalPortfolioValue": Money,
"totalHoldingMarkedValue": Money,
"totalCapitalContributed": Money,
"searchActivityFeed": ActivityFeedResults,
"governingDocuments": [
InvestingEntityGoverningDocument
],
"searchTransactionsV2": SearchTransactionsResults,
"outstandingTaskCount": 123,
"bankAccountVerificationStatus": "PENDING",
"sourceOfFundsVerificationStatus": "COMPLETE",
"outstandingTasks": [Task],
"outstandingNotifications": [
InvestingEntityNotification
],
"associatedAccounts": [AssociatedAccount],
"tags": [InvestingEntityTag]
}
}
}
addInvestingEntityBankAccount
Description
Add a new bank account to an Investing Entity
Response
Returns an InvestingEntity!
Arguments
| Name | Description |
|---|---|
form - AddInvestingEntityBankAccountInput!
|
Example
Query
mutation addInvestingEntityBankAccount($form: AddInvestingEntityBankAccountInput!) {
addInvestingEntityBankAccount(form: $form) {
id
created
updated
entityType
entity {
... on IndividualInvestingEntity {
...IndividualInvestingEntityFragment
}
... on CompanyInvestingEntity {
...CompanyInvestingEntityFragment
}
... on TrustInvestingEntity {
...TrustInvestingEntityFragment
}
... on JointIndividualInvestingEntity {
...JointIndividualInvestingEntityFragment
}
... on PartnershipInvestingEntity {
...PartnershipInvestingEntityFragment
}
}
sourceOfFundsVerificationEmailLastSent
relationship
country {
...CountryFragment
}
bankAccounts {
...VerifiableBankAccountFragment
}
bankAccount {
...VerifiableBankAccountFragment
}
accreditationsStandardised {
...InvestingEntityStandardisedAccreditationFragment
}
accreditationCountry {
...CountryFragment
}
wholesaleCertificationStatus
primaryOwner {
...AccountFragment
}
accounts {
...AccountFragment
}
beneficialOwners {
...BeneficialOwnerFragment
}
beneficialOwner {
...BeneficialOwnerFragment
}
lastRequestedBeneficialOwnersContactDetails
lastRequestedWholesaleCertification
allocations {
...AllocationFragment
}
riskProfile {
...RiskProfileFragment
}
holdings {
...HoldingFragment
}
totalPortfolioValue {
...MoneyFragment
}
totalHoldingMarkedValue {
...MoneyFragment
}
totalCapitalContributed {
...MoneyFragment
}
searchActivityFeed {
...ActivityFeedResultsFragment
}
governingDocuments {
...InvestingEntityGoverningDocumentFragment
}
searchTransactionsV2 {
...SearchTransactionsResultsFragment
}
outstandingTaskCount
bankAccountVerificationStatus
sourceOfFundsVerificationStatus
outstandingTasks {
...TaskFragment
}
outstandingNotifications {
...InvestingEntityNotificationFragment
}
associatedAccounts {
...AssociatedAccountFragment
}
tags {
...InvestingEntityTagFragment
}
}
}
Variables
{"form": AddInvestingEntityBankAccountInput}
Response
{
"data": {
"addInvestingEntityBankAccount": {
"id": 4,
"created": "2007-12-03T10:15:30Z",
"updated": "2007-12-03T10:15:30Z",
"entityType": "INDIVIDUAL",
"entity": IndividualInvestingEntity,
"sourceOfFundsVerificationEmailLastSent": "2007-12-03T10:15:30Z",
"relationship": "SHAREHOLDING_VOTING_RIGHTS_GREATER_THAN_25_PERCENT",
"country": Country,
"bankAccounts": [VerifiableBankAccount],
"bankAccount": VerifiableBankAccount,
"accreditationsStandardised": [
InvestingEntityStandardisedAccreditation
],
"accreditationCountry": Country,
"wholesaleCertificationStatus": "AWAITING",
"primaryOwner": Account,
"accounts": [Account],
"beneficialOwners": [BeneficialOwner],
"beneficialOwner": BeneficialOwner,
"lastRequestedBeneficialOwnersContactDetails": "2007-12-03T10:15:30Z",
"lastRequestedWholesaleCertification": "2007-12-03T10:15:30Z",
"allocations": [Allocation],
"riskProfile": RiskProfile,
"holdings": [Holding],
"totalPortfolioValue": Money,
"totalHoldingMarkedValue": Money,
"totalCapitalContributed": Money,
"searchActivityFeed": ActivityFeedResults,
"governingDocuments": [
InvestingEntityGoverningDocument
],
"searchTransactionsV2": SearchTransactionsResults,
"outstandingTaskCount": 123,
"bankAccountVerificationStatus": "PENDING",
"sourceOfFundsVerificationStatus": "COMPLETE",
"outstandingTasks": [Task],
"outstandingNotifications": [
InvestingEntityNotification
],
"associatedAccounts": [AssociatedAccount],
"tags": [InvestingEntityTag]
}
}
}
addInvestingEntityDocument
Description
Add a document for an investing entity
Response
Returns an InvestingEntity!
Arguments
| Name | Description |
|---|---|
form - AddInvestingEntityDocumentInput!
|
Example
Query
mutation addInvestingEntityDocument($form: AddInvestingEntityDocumentInput!) {
addInvestingEntityDocument(form: $form) {
id
created
updated
entityType
entity {
... on IndividualInvestingEntity {
...IndividualInvestingEntityFragment
}
... on CompanyInvestingEntity {
...CompanyInvestingEntityFragment
}
... on TrustInvestingEntity {
...TrustInvestingEntityFragment
}
... on JointIndividualInvestingEntity {
...JointIndividualInvestingEntityFragment
}
... on PartnershipInvestingEntity {
...PartnershipInvestingEntityFragment
}
}
sourceOfFundsVerificationEmailLastSent
relationship
country {
...CountryFragment
}
bankAccounts {
...VerifiableBankAccountFragment
}
bankAccount {
...VerifiableBankAccountFragment
}
accreditationsStandardised {
...InvestingEntityStandardisedAccreditationFragment
}
accreditationCountry {
...CountryFragment
}
wholesaleCertificationStatus
primaryOwner {
...AccountFragment
}
accounts {
...AccountFragment
}
beneficialOwners {
...BeneficialOwnerFragment
}
beneficialOwner {
...BeneficialOwnerFragment
}
lastRequestedBeneficialOwnersContactDetails
lastRequestedWholesaleCertification
allocations {
...AllocationFragment
}
riskProfile {
...RiskProfileFragment
}
holdings {
...HoldingFragment
}
totalPortfolioValue {
...MoneyFragment
}
totalHoldingMarkedValue {
...MoneyFragment
}
totalCapitalContributed {
...MoneyFragment
}
searchActivityFeed {
...ActivityFeedResultsFragment
}
governingDocuments {
...InvestingEntityGoverningDocumentFragment
}
searchTransactionsV2 {
...SearchTransactionsResultsFragment
}
outstandingTaskCount
bankAccountVerificationStatus
sourceOfFundsVerificationStatus
outstandingTasks {
...TaskFragment
}
outstandingNotifications {
...InvestingEntityNotificationFragment
}
associatedAccounts {
...AssociatedAccountFragment
}
tags {
...InvestingEntityTagFragment
}
}
}
Variables
{"form": AddInvestingEntityDocumentInput}
Response
{
"data": {
"addInvestingEntityDocument": {
"id": "4",
"created": "2007-12-03T10:15:30Z",
"updated": "2007-12-03T10:15:30Z",
"entityType": "INDIVIDUAL",
"entity": IndividualInvestingEntity,
"sourceOfFundsVerificationEmailLastSent": "2007-12-03T10:15:30Z",
"relationship": "SHAREHOLDING_VOTING_RIGHTS_GREATER_THAN_25_PERCENT",
"country": Country,
"bankAccounts": [VerifiableBankAccount],
"bankAccount": VerifiableBankAccount,
"accreditationsStandardised": [
InvestingEntityStandardisedAccreditation
],
"accreditationCountry": Country,
"wholesaleCertificationStatus": "AWAITING",
"primaryOwner": Account,
"accounts": [Account],
"beneficialOwners": [BeneficialOwner],
"beneficialOwner": BeneficialOwner,
"lastRequestedBeneficialOwnersContactDetails": "2007-12-03T10:15:30Z",
"lastRequestedWholesaleCertification": "2007-12-03T10:15:30Z",
"allocations": [Allocation],
"riskProfile": RiskProfile,
"holdings": [Holding],
"totalPortfolioValue": Money,
"totalHoldingMarkedValue": Money,
"totalCapitalContributed": Money,
"searchActivityFeed": ActivityFeedResults,
"governingDocuments": [
InvestingEntityGoverningDocument
],
"searchTransactionsV2": SearchTransactionsResults,
"outstandingTaskCount": 123,
"bankAccountVerificationStatus": "PENDING",
"sourceOfFundsVerificationStatus": "COMPLETE",
"outstandingTasks": [Task],
"outstandingNotifications": [
InvestingEntityNotification
],
"associatedAccounts": [AssociatedAccount],
"tags": [InvestingEntityTag]
}
}
}
addInvestingEntityNote
Description
Add a note to an investing entity
Response
Returns a Note!
Arguments
| Name | Description |
|---|---|
form - AddInvestingEntityNoteInput!
|
Example
Query
mutation addInvestingEntityNote($form: AddInvestingEntityNoteInput!) {
addInvestingEntityNote(form: $form) {
id
created
message
lastModifiedDetails {
...NoteLastModifiedDetailsFragment
}
isPinned
}
}
Variables
{"form": AddInvestingEntityNoteInput}
Response
{
"data": {
"addInvestingEntityNote": {
"id": "4",
"created": "2007-12-03T10:15:30Z",
"message": "xyz789",
"lastModifiedDetails": NoteLastModifiedDetails,
"isPinned": false
}
}
}
addManualAllocationPayment
Description
Add manual payment against an allocation
Response
Returns an Allocation!
Arguments
| Name | Description |
|---|---|
form - AddManualAllocationPaymentInput!
|
Example
Query
mutation addManualAllocationPayment($form: AddManualAllocationPaymentInput!) {
addManualAllocationPayment(form: $form) {
id
createdAt
offer {
...OfferFragment
}
ownershipPercentage
investingEntity {
...InvestingEntityFragment
}
associatedContact {
... on InvestingEntity {
...InvestingEntityFragment
}
... on Account {
...AccountFragment
}
... on Prospect {
...ProspectFragment
}
}
status
unitCountDecimal {
...FixedPointNumberFragment
}
pricePerUnit {
...MoneyFragment
}
pricePerUnitV2 {
...HighPrecisionMoneyFragment
}
totalValue {
...MoneyFragment
}
expectedReference
payments {
...ManualAllocationPaymentFragment
}
totalPaid {
...MoneyFragment
}
note
balance {
...MoneyFragment
}
unitsIssued {
...FixedPointNumberFragment
}
issuedHolding {
...HoldingFragment
}
capitalCalled {
...HighPrecisionMoneyFragment
}
customFieldSection {
...CustomFieldSectionFragment
}
}
}
Variables
{"form": AddManualAllocationPaymentInput}
Response
{
"data": {
"addManualAllocationPayment": {
"id": 4,
"createdAt": "2007-12-03T10:15:30Z",
"offer": Offer,
"ownershipPercentage": "abc123",
"investingEntity": InvestingEntity,
"associatedContact": InvestingEntity,
"status": "INTERESTED",
"unitCountDecimal": FixedPointNumber,
"pricePerUnit": Money,
"pricePerUnitV2": HighPrecisionMoney,
"totalValue": Money,
"expectedReference": "xyz789",
"payments": [ManualAllocationPayment],
"totalPaid": Money,
"note": "xyz789",
"balance": Money,
"unitsIssued": FixedPointNumber,
"issuedHolding": Holding,
"capitalCalled": HighPrecisionMoney,
"customFieldSection": [CustomFieldSection]
}
}
}
addOfferDataRoomContentBlock
Description
Add a content block to an offer's data room
Response
Returns an Offer!
Arguments
| Name | Description |
|---|---|
form - AddOfferDataRoomContentBlockInput!
|
Example
Query
mutation addOfferDataRoomContentBlock($form: AddOfferDataRoomContentBlockInput!) {
addOfferDataRoomContentBlock(form: $form) {
capitalCallBatches {
...CapitalCallBatchConnectionFragment
}
capitalCallBatch {
...CapitalCallBatchFragment
}
id
displayName
createdAt
updatedAt
pricePerUnit {
...MoneyFragment
}
pricePerUnitV2 {
...HighPrecisionMoneyFragment
}
totalUnitCountDecimal {
...FixedPointNumberFragment
}
minimumUnitCountDecimal {
...FixedPointNumberFragment
}
maximumUnitCountDecimal {
...FixedPointNumberFragment
}
areUnitsIssued
status
openedAt
closedAt
fundsDeadline
settledAt
paymentReferencePrefix
allocations {
...AllocationFragment
}
capitalizationTable {
...CapitalizationTableFragment
}
totalEquity {
...MoneyFragment
}
totalEquityV2 {
...HighPrecisionMoneyFragment
}
registrationsOfInterest {
...RegistrationOfInterestFragment
}
fund {
...FundFragment
}
depositMethods {
...OfferDepositMethodFragment
}
digitalSubscription
slug
dataRoom {
...OfferDataRoomFragment
}
unitClass {
...UnitClassFragment
}
searchAllocations {
...AllocationSearchResultsFragment
}
}
}
Variables
{"form": AddOfferDataRoomContentBlockInput}
Response
{
"data": {
"addOfferDataRoomContentBlock": {
"capitalCallBatches": CapitalCallBatchConnection,
"capitalCallBatch": CapitalCallBatch,
"id": "4",
"displayName": "xyz789",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"pricePerUnit": Money,
"pricePerUnitV2": HighPrecisionMoney,
"totalUnitCountDecimal": FixedPointNumber,
"minimumUnitCountDecimal": FixedPointNumber,
"maximumUnitCountDecimal": FixedPointNumber,
"areUnitsIssued": true,
"status": "OPEN",
"openedAt": "2007-12-03T10:15:30Z",
"closedAt": "2007-12-03T10:15:30Z",
"fundsDeadline": "2007-12-03T10:15:30Z",
"settledAt": "2007-12-03T10:15:30Z",
"paymentReferencePrefix": "abc123",
"allocations": [Allocation],
"capitalizationTable": CapitalizationTable,
"totalEquity": Money,
"totalEquityV2": HighPrecisionMoney,
"registrationsOfInterest": [RegistrationOfInterest],
"fund": Fund,
"depositMethods": [OfferDepositMethod],
"digitalSubscription": "ENABLED",
"slug": "xyz789",
"dataRoom": OfferDataRoom,
"unitClass": UnitClass,
"searchAllocations": AllocationSearchResults
}
}
}
addProspectNote
Description
Add a prospect note
Response
Returns a Note!
Arguments
| Name | Description |
|---|---|
form - AddProspectNoteInput!
|
Example
Query
mutation addProspectNote($form: AddProspectNoteInput!) {
addProspectNote(form: $form) {
id
created
message
lastModifiedDetails {
...NoteLastModifiedDetailsFragment
}
isPinned
}
}
Variables
{"form": AddProspectNoteInput}
Response
{
"data": {
"addProspectNote": {
"id": 4,
"created": "2007-12-03T10:15:30Z",
"message": "xyz789",
"lastModifiedDetails": NoteLastModifiedDetails,
"isPinned": false
}
}
}
addRelatedTasks
Description
Add related tasks to a task
Response
Returns a Task!
Arguments
| Name | Description |
|---|---|
form - AddRelatedTasksInput!
|
Example
Query
mutation addRelatedTasks($form: AddRelatedTasksInput!) {
addRelatedTasks(form: $form) {
id
title
created
updated
dueAt
status
assignedAdmin {
...AdminUserFragment
}
notes {
...NoteFragment
}
documents {
...TaskDocumentFragment
}
priority
relatedTasks {
...TaskFragment
}
assignedTeam
}
}
Variables
{"form": AddRelatedTasksInput}
Response
{
"data": {
"addRelatedTasks": {
"id": "4",
"title": "xyz789",
"created": "2007-12-03T10:15:30Z",
"updated": "2007-12-03T10:15:30Z",
"dueAt": "2007-12-03T10:15:30Z",
"status": "OPEN",
"assignedAdmin": AdminUser,
"notes": [Note],
"documents": [TaskDocument],
"priority": "NO_PRIORITY",
"relatedTasks": [Task],
"assignedTeam": "UNASSIGNED"
}
}
}
addTaskNote
Description
Add a task note
Response
Returns a Note!
Arguments
| Name | Description |
|---|---|
form - AddTaskNoteInput!
|
Example
Query
mutation addTaskNote($form: AddTaskNoteInput!) {
addTaskNote(form: $form) {
id
created
message
lastModifiedDetails {
...NoteLastModifiedDetailsFragment
}
isPinned
}
}
Variables
{"form": AddTaskNoteInput}
Response
{
"data": {
"addTaskNote": {
"id": 4,
"created": "2007-12-03T10:15:30Z",
"message": "xyz789",
"lastModifiedDetails": NoteLastModifiedDetails,
"isPinned": true
}
}
}
cancelAllocation
Description
Cancel an allocation
Response
Returns an Allocation!
Arguments
| Name | Description |
|---|---|
form - CancelAllocationInput!
|
Example
Query
mutation cancelAllocation($form: CancelAllocationInput!) {
cancelAllocation(form: $form) {
id
createdAt
offer {
...OfferFragment
}
ownershipPercentage
investingEntity {
...InvestingEntityFragment
}
associatedContact {
... on InvestingEntity {
...InvestingEntityFragment
}
... on Account {
...AccountFragment
}
... on Prospect {
...ProspectFragment
}
}
status
unitCountDecimal {
...FixedPointNumberFragment
}
pricePerUnit {
...MoneyFragment
}
pricePerUnitV2 {
...HighPrecisionMoneyFragment
}
totalValue {
...MoneyFragment
}
expectedReference
payments {
...ManualAllocationPaymentFragment
}
totalPaid {
...MoneyFragment
}
note
balance {
...MoneyFragment
}
unitsIssued {
...FixedPointNumberFragment
}
issuedHolding {
...HoldingFragment
}
capitalCalled {
...HighPrecisionMoneyFragment
}
customFieldSection {
...CustomFieldSectionFragment
}
}
}
Variables
{"form": CancelAllocationInput}
Response
{
"data": {
"cancelAllocation": {
"id": 4,
"createdAt": "2007-12-03T10:15:30Z",
"offer": Offer,
"ownershipPercentage": "abc123",
"investingEntity": InvestingEntity,
"associatedContact": InvestingEntity,
"status": "INTERESTED",
"unitCountDecimal": FixedPointNumber,
"pricePerUnit": Money,
"pricePerUnitV2": HighPrecisionMoney,
"totalValue": Money,
"expectedReference": "xyz789",
"payments": [ManualAllocationPayment],
"totalPaid": Money,
"note": "abc123",
"balance": Money,
"unitsIssued": FixedPointNumber,
"issuedHolding": Holding,
"capitalCalled": HighPrecisionMoney,
"customFieldSection": [CustomFieldSection]
}
}
}
cancelBuyOrder
Response
Returns a Fund!
Arguments
| Name | Description |
|---|---|
form - CancelBuyOrderInput!
|
Example
Query
mutation cancelBuyOrder($form: CancelBuyOrderInput!) {
cancelBuyOrder(form: $form) {
id
createdAt
updatedAt
name
legalName
shortDescription
summary {
...FundSummaryFragment
}
registrationNumber
legalStructure
assetStructure
inception
currency {
...CurrencyFragment
}
country {
...CountryFragment
}
cardImage {
...RemoteAssetFragment
}
totalUnitCountDecimal {
...FixedPointNumberFragment
}
calculatedNetAssetValue {
...MoneyFragment
}
targetCashReturn {
...FractionFragment
}
targetTotalReturn {
...FractionFragment
}
documents {
...FundDocumentFragment
}
assets {
...AssetFragment
}
asset {
...AssetFragment
}
offers {
...OfferFragment
}
distributions {
...DistributionFragment
}
searchDistributions {
...DistributionSearchResultsFragment
}
distribution {
...DistributionFragment
}
distributionV2 {
...DistributionV2Fragment
}
validateDistribution {
... on InvalidBankAccountDistributionAlert {
...InvalidBankAccountDistributionAlertFragment
}
}
secondaryMarket {
...SecondaryMarketFragment
}
sellOrder {
...SellOrderFragment
}
sellOrders {
...SellOrderFragment
}
buyOrder {
...BuyOrderFragment
}
buyOrders {
...BuyOrderFragment
}
offerStatus
investorType
largestOwnershipPercentageV2
numberOfActiveHoldings
fundManagerName
lastDistributionDate
equityRaised {
...MoneyFragment
}
hideDistributionMetrics
searchUnitRedemptionRequests {
...UnitRedemptionRequestSearchResultsFragment
}
unitRedemptionRequest {
...UnitRedemptionRequestFragment
}
unitRedemptionConfiguration {
...FundUnitRedemptionConfigurationFragment
}
unitPrecisionScale
searchUnitClasses {
...UnitClassSearchResultsFragment
}
showHoldingPageOnInvestorPortal
customMetrics {
...CustomMetricFragment
}
investorPortalConfiguration {
...FundInvestorPortalConfigurationFragment
}
unitTransferRequest {
...UnitTransferRequestFragment
}
depositBankAccount {
...BankAccountFragment
}
searchOutgoingBankAccounts {
...FundOutgoingBankAccountSearchResultsFragment
}
}
}
Variables
{"form": CancelBuyOrderInput}
Response
{
"data": {
"cancelBuyOrder": {
"id": 4,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"name": "abc123",
"legalName": "abc123",
"shortDescription": "abc123",
"summary": FundSummary,
"registrationNumber": "abc123",
"legalStructure": "LIMITED_PARTNERSHIP",
"assetStructure": "SINGLE_ASSET",
"inception": "2007-12-03T10:15:30Z",
"currency": Currency,
"country": Country,
"cardImage": RemoteAsset,
"totalUnitCountDecimal": FixedPointNumber,
"calculatedNetAssetValue": Money,
"targetCashReturn": Fraction,
"targetTotalReturn": Fraction,
"documents": [FundDocument],
"assets": [Asset],
"asset": Asset,
"offers": [Offer],
"distributions": [Distribution],
"searchDistributions": DistributionSearchResults,
"distribution": Distribution,
"distributionV2": DistributionV2,
"validateDistribution": [
InvalidBankAccountDistributionAlert
],
"secondaryMarket": SecondaryMarket,
"sellOrder": SellOrder,
"sellOrders": [SellOrder],
"buyOrder": BuyOrder,
"buyOrders": [BuyOrder],
"offerStatus": "OPEN",
"investorType": "WHOLESALE",
"largestOwnershipPercentageV2": 987.65,
"numberOfActiveHoldings": 987,
"fundManagerName": "abc123",
"lastDistributionDate": "2007-12-03T10:15:30Z",
"equityRaised": Money,
"hideDistributionMetrics": false,
"searchUnitRedemptionRequests": UnitRedemptionRequestSearchResults,
"unitRedemptionRequest": UnitRedemptionRequest,
"unitRedemptionConfiguration": FundUnitRedemptionConfiguration,
"unitPrecisionScale": 987,
"searchUnitClasses": UnitClassSearchResults,
"showHoldingPageOnInvestorPortal": false,
"customMetrics": [CustomMetric],
"investorPortalConfiguration": FundInvestorPortalConfiguration,
"unitTransferRequest": UnitTransferRequest,
"depositBankAccount": BankAccount,
"searchOutgoingBankAccounts": FundOutgoingBankAccountSearchResults
}
}
}
cancelManualAllocationPayment
Description
Cancel manual payment against an allocation
Response
Returns an Allocation!
Arguments
| Name | Description |
|---|---|
form - CancelManualAllocationPaymentInput!
|
Example
Query
mutation cancelManualAllocationPayment($form: CancelManualAllocationPaymentInput!) {
cancelManualAllocationPayment(form: $form) {
id
createdAt
offer {
...OfferFragment
}
ownershipPercentage
investingEntity {
...InvestingEntityFragment
}
associatedContact {
... on InvestingEntity {
...InvestingEntityFragment
}
... on Account {
...AccountFragment
}
... on Prospect {
...ProspectFragment
}
}
status
unitCountDecimal {
...FixedPointNumberFragment
}
pricePerUnit {
...MoneyFragment
}
pricePerUnitV2 {
...HighPrecisionMoneyFragment
}
totalValue {
...MoneyFragment
}
expectedReference
payments {
...ManualAllocationPaymentFragment
}
totalPaid {
...MoneyFragment
}
note
balance {
...MoneyFragment
}
unitsIssued {
...FixedPointNumberFragment
}
issuedHolding {
...HoldingFragment
}
capitalCalled {
...HighPrecisionMoneyFragment
}
customFieldSection {
...CustomFieldSectionFragment
}
}
}
Variables
{"form": CancelManualAllocationPaymentInput}
Response
{
"data": {
"cancelManualAllocationPayment": {
"id": "4",
"createdAt": "2007-12-03T10:15:30Z",
"offer": Offer,
"ownershipPercentage": "xyz789",
"investingEntity": InvestingEntity,
"associatedContact": InvestingEntity,
"status": "INTERESTED",
"unitCountDecimal": FixedPointNumber,
"pricePerUnit": Money,
"pricePerUnitV2": HighPrecisionMoney,
"totalValue": Money,
"expectedReference": "xyz789",
"payments": [ManualAllocationPayment],
"totalPaid": Money,
"note": "xyz789",
"balance": Money,
"unitsIssued": FixedPointNumber,
"issuedHolding": Holding,
"capitalCalled": HighPrecisionMoney,
"customFieldSection": [CustomFieldSection]
}
}
}
cancelSellOrder
Response
Returns a Fund!
Arguments
| Name | Description |
|---|---|
form - CancelSellOrderInput!
|
Example
Query
mutation cancelSellOrder($form: CancelSellOrderInput!) {
cancelSellOrder(form: $form) {
id
createdAt
updatedAt
name
legalName
shortDescription
summary {
...FundSummaryFragment
}
registrationNumber
legalStructure
assetStructure
inception
currency {
...CurrencyFragment
}
country {
...CountryFragment
}
cardImage {
...RemoteAssetFragment
}
totalUnitCountDecimal {
...FixedPointNumberFragment
}
calculatedNetAssetValue {
...MoneyFragment
}
targetCashReturn {
...FractionFragment
}
targetTotalReturn {
...FractionFragment
}
documents {
...FundDocumentFragment
}
assets {
...AssetFragment
}
asset {
...AssetFragment
}
offers {
...OfferFragment
}
distributions {
...DistributionFragment
}
searchDistributions {
...DistributionSearchResultsFragment
}
distribution {
...DistributionFragment
}
distributionV2 {
...DistributionV2Fragment
}
validateDistribution {
... on InvalidBankAccountDistributionAlert {
...InvalidBankAccountDistributionAlertFragment
}
}
secondaryMarket {
...SecondaryMarketFragment
}
sellOrder {
...SellOrderFragment
}
sellOrders {
...SellOrderFragment
}
buyOrder {
...BuyOrderFragment
}
buyOrders {
...BuyOrderFragment
}
offerStatus
investorType
largestOwnershipPercentageV2
numberOfActiveHoldings
fundManagerName
lastDistributionDate
equityRaised {
...MoneyFragment
}
hideDistributionMetrics
searchUnitRedemptionRequests {
...UnitRedemptionRequestSearchResultsFragment
}
unitRedemptionRequest {
...UnitRedemptionRequestFragment
}
unitRedemptionConfiguration {
...FundUnitRedemptionConfigurationFragment
}
unitPrecisionScale
searchUnitClasses {
...UnitClassSearchResultsFragment
}
showHoldingPageOnInvestorPortal
customMetrics {
...CustomMetricFragment
}
investorPortalConfiguration {
...FundInvestorPortalConfigurationFragment
}
unitTransferRequest {
...UnitTransferRequestFragment
}
depositBankAccount {
...BankAccountFragment
}
searchOutgoingBankAccounts {
...FundOutgoingBankAccountSearchResultsFragment
}
}
}
Variables
{"form": CancelSellOrderInput}
Response
{
"data": {
"cancelSellOrder": {
"id": "4",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"name": "abc123",
"legalName": "abc123",
"shortDescription": "abc123",
"summary": FundSummary,
"registrationNumber": "xyz789",
"legalStructure": "LIMITED_PARTNERSHIP",
"assetStructure": "SINGLE_ASSET",
"inception": "2007-12-03T10:15:30Z",
"currency": Currency,
"country": Country,
"cardImage": RemoteAsset,
"totalUnitCountDecimal": FixedPointNumber,
"calculatedNetAssetValue": Money,
"targetCashReturn": Fraction,
"targetTotalReturn": Fraction,
"documents": [FundDocument],
"assets": [Asset],
"asset": Asset,
"offers": [Offer],
"distributions": [Distribution],
"searchDistributions": DistributionSearchResults,
"distribution": Distribution,
"distributionV2": DistributionV2,
"validateDistribution": [
InvalidBankAccountDistributionAlert
],
"secondaryMarket": SecondaryMarket,
"sellOrder": SellOrder,
"sellOrders": [SellOrder],
"buyOrder": BuyOrder,
"buyOrders": [BuyOrder],
"offerStatus": "OPEN",
"investorType": "WHOLESALE",
"largestOwnershipPercentageV2": 123.45,
"numberOfActiveHoldings": 987,
"fundManagerName": "xyz789",
"lastDistributionDate": "2007-12-03T10:15:30Z",
"equityRaised": Money,
"hideDistributionMetrics": true,
"searchUnitRedemptionRequests": UnitRedemptionRequestSearchResults,
"unitRedemptionRequest": UnitRedemptionRequest,
"unitRedemptionConfiguration": FundUnitRedemptionConfiguration,
"unitPrecisionScale": 987,
"searchUnitClasses": UnitClassSearchResults,
"showHoldingPageOnInvestorPortal": false,
"customMetrics": [CustomMetric],
"investorPortalConfiguration": FundInvestorPortalConfiguration,
"unitTransferRequest": UnitTransferRequest,
"depositBankAccount": BankAccount,
"searchOutgoingBankAccounts": FundOutgoingBankAccountSearchResults
}
}
}
cancelUnitRedemptionRequest
Description
Cancel an existing unit redemption request
Response
Returns a UnitRedemptionRequest!
Arguments
| Name | Description |
|---|---|
form - CancelUnitRedemptionRequestInput!
|
Example
Query
mutation cancelUnitRedemptionRequest($form: CancelUnitRedemptionRequestInput!) {
cancelUnitRedemptionRequest(form: $form) {
id
status
holding {
...HoldingFragment
}
unitCountDecimal {
...FixedPointNumberFragment
}
unitPrice {
...MoneyFragment
}
unitPriceV2 {
...HighPrecisionMoneyFragment
}
orderValue {
...MoneyFragment
}
dateReceived
dateOfRedemption
note {
...NoteFragment
}
tags
}
}
Variables
{"form": CancelUnitRedemptionRequestInput}
Response
{
"data": {
"cancelUnitRedemptionRequest": {
"id": 4,
"status": "REQUESTED",
"holding": Holding,
"unitCountDecimal": FixedPointNumber,
"unitPrice": Money,
"unitPriceV2": HighPrecisionMoney,
"orderValue": Money,
"dateReceived": "2007-12-03T10:15:30Z",
"dateOfRedemption": "2007-12-03T10:15:30Z",
"note": Note,
"tags": ["RELATED_PARTY_NCBO"]
}
}
}
cancelUnitTransferRequest
Description
Cancel an existing unit transfer request
Response
Returns a UnitTransferRequest!
Arguments
| Name | Description |
|---|---|
form - CancelUnitTransferRequestInput!
|
Example
Query
mutation cancelUnitTransferRequest($form: CancelUnitTransferRequestInput!) {
cancelUnitTransferRequest(form: $form) {
id
status
fromHolding {
...HoldingFragment
}
toInvestingEntity {
...InvestingEntityFragment
}
unitCount {
...FixedPointNumberFragment
}
unitPrice {
...MoneyFragment
}
totalValue {
...MoneyFragment
}
dateReceived
dateOfTransfer
note {
...NoteFragment
}
tags
}
}
Variables
{"form": CancelUnitTransferRequestInput}
Response
{
"data": {
"cancelUnitTransferRequest": {
"id": 4,
"status": "REQUESTED",
"fromHolding": Holding,
"toInvestingEntity": InvestingEntity,
"unitCount": FixedPointNumber,
"unitPrice": Money,
"totalValue": Money,
"dateReceived": "2007-12-03T10:15:30Z",
"dateOfTransfer": "2007-12-03T10:15:30Z",
"note": Note,
"tags": ["RELATED_PARTY_NCBO"]
}
}
}
completeSellOrder
Response
Returns a Fund!
Arguments
| Name | Description |
|---|---|
form - CompleteSellOrderInput!
|
Example
Query
mutation completeSellOrder($form: CompleteSellOrderInput!) {
completeSellOrder(form: $form) {
id
createdAt
updatedAt
name
legalName
shortDescription
summary {
...FundSummaryFragment
}
registrationNumber
legalStructure
assetStructure
inception
currency {
...CurrencyFragment
}
country {
...CountryFragment
}
cardImage {
...RemoteAssetFragment
}
totalUnitCountDecimal {
...FixedPointNumberFragment
}
calculatedNetAssetValue {
...MoneyFragment
}
targetCashReturn {
...FractionFragment
}
targetTotalReturn {
...FractionFragment
}
documents {
...FundDocumentFragment
}
assets {
...AssetFragment
}
asset {
...AssetFragment
}
offers {
...OfferFragment
}
distributions {
...DistributionFragment
}
searchDistributions {
...DistributionSearchResultsFragment
}
distribution {
...DistributionFragment
}
distributionV2 {
...DistributionV2Fragment
}
validateDistribution {
... on InvalidBankAccountDistributionAlert {
...InvalidBankAccountDistributionAlertFragment
}
}
secondaryMarket {
...SecondaryMarketFragment
}
sellOrder {
...SellOrderFragment
}
sellOrders {
...SellOrderFragment
}
buyOrder {
...BuyOrderFragment
}
buyOrders {
...BuyOrderFragment
}
offerStatus
investorType
largestOwnershipPercentageV2
numberOfActiveHoldings
fundManagerName
lastDistributionDate
equityRaised {
...MoneyFragment
}
hideDistributionMetrics
searchUnitRedemptionRequests {
...UnitRedemptionRequestSearchResultsFragment
}
unitRedemptionRequest {
...UnitRedemptionRequestFragment
}
unitRedemptionConfiguration {
...FundUnitRedemptionConfigurationFragment
}
unitPrecisionScale
searchUnitClasses {
...UnitClassSearchResultsFragment
}
showHoldingPageOnInvestorPortal
customMetrics {
...CustomMetricFragment
}
investorPortalConfiguration {
...FundInvestorPortalConfigurationFragment
}
unitTransferRequest {
...UnitTransferRequestFragment
}
depositBankAccount {
...BankAccountFragment
}
searchOutgoingBankAccounts {
...FundOutgoingBankAccountSearchResultsFragment
}
}
}
Variables
{"form": CompleteSellOrderInput}
Response
{
"data": {
"completeSellOrder": {
"id": 4,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"name": "xyz789",
"legalName": "xyz789",
"shortDescription": "abc123",
"summary": FundSummary,
"registrationNumber": "abc123",
"legalStructure": "LIMITED_PARTNERSHIP",
"assetStructure": "SINGLE_ASSET",
"inception": "2007-12-03T10:15:30Z",
"currency": Currency,
"country": Country,
"cardImage": RemoteAsset,
"totalUnitCountDecimal": FixedPointNumber,
"calculatedNetAssetValue": Money,
"targetCashReturn": Fraction,
"targetTotalReturn": Fraction,
"documents": [FundDocument],
"assets": [Asset],
"asset": Asset,
"offers": [Offer],
"distributions": [Distribution],
"searchDistributions": DistributionSearchResults,
"distribution": Distribution,
"distributionV2": DistributionV2,
"validateDistribution": [
InvalidBankAccountDistributionAlert
],
"secondaryMarket": SecondaryMarket,
"sellOrder": SellOrder,
"sellOrders": [SellOrder],
"buyOrder": BuyOrder,
"buyOrders": [BuyOrder],
"offerStatus": "OPEN",
"investorType": "WHOLESALE",
"largestOwnershipPercentageV2": 123.45,
"numberOfActiveHoldings": 123,
"fundManagerName": "abc123",
"lastDistributionDate": "2007-12-03T10:15:30Z",
"equityRaised": Money,
"hideDistributionMetrics": true,
"searchUnitRedemptionRequests": UnitRedemptionRequestSearchResults,
"unitRedemptionRequest": UnitRedemptionRequest,
"unitRedemptionConfiguration": FundUnitRedemptionConfiguration,
"unitPrecisionScale": 123,
"searchUnitClasses": UnitClassSearchResults,
"showHoldingPageOnInvestorPortal": true,
"customMetrics": [CustomMetric],
"investorPortalConfiguration": FundInvestorPortalConfiguration,
"unitTransferRequest": UnitTransferRequest,
"depositBankAccount": BankAccount,
"searchOutgoingBankAccounts": FundOutgoingBankAccountSearchResults
}
}
}
confirmAllocation
Description
Confirm allocation
Response
Returns an Allocation!
Arguments
| Name | Description |
|---|---|
form - ConfirmAllocationInput!
|
Example
Query
mutation confirmAllocation($form: ConfirmAllocationInput!) {
confirmAllocation(form: $form) {
id
createdAt
offer {
...OfferFragment
}
ownershipPercentage
investingEntity {
...InvestingEntityFragment
}
associatedContact {
... on InvestingEntity {
...InvestingEntityFragment
}
... on Account {
...AccountFragment
}
... on Prospect {
...ProspectFragment
}
}
status
unitCountDecimal {
...FixedPointNumberFragment
}
pricePerUnit {
...MoneyFragment
}
pricePerUnitV2 {
...HighPrecisionMoneyFragment
}
totalValue {
...MoneyFragment
}
expectedReference
payments {
...ManualAllocationPaymentFragment
}
totalPaid {
...MoneyFragment
}
note
balance {
...MoneyFragment
}
unitsIssued {
...FixedPointNumberFragment
}
issuedHolding {
...HoldingFragment
}
capitalCalled {
...HighPrecisionMoneyFragment
}
customFieldSection {
...CustomFieldSectionFragment
}
}
}
Variables
{"form": ConfirmAllocationInput}
Response
{
"data": {
"confirmAllocation": {
"id": "4",
"createdAt": "2007-12-03T10:15:30Z",
"offer": Offer,
"ownershipPercentage": "abc123",
"investingEntity": InvestingEntity,
"associatedContact": InvestingEntity,
"status": "INTERESTED",
"unitCountDecimal": FixedPointNumber,
"pricePerUnit": Money,
"pricePerUnitV2": HighPrecisionMoney,
"totalValue": Money,
"expectedReference": "xyz789",
"payments": [ManualAllocationPayment],
"totalPaid": Money,
"note": "abc123",
"balance": Money,
"unitsIssued": FixedPointNumber,
"issuedHolding": Holding,
"capitalCalled": HighPrecisionMoney,
"customFieldSection": [CustomFieldSection]
}
}
}
confirmBuyOrder
Response
Returns a Fund!
Arguments
| Name | Description |
|---|---|
form - ConfirmBuyOrderInput!
|
Example
Query
mutation confirmBuyOrder($form: ConfirmBuyOrderInput!) {
confirmBuyOrder(form: $form) {
id
createdAt
updatedAt
name
legalName
shortDescription
summary {
...FundSummaryFragment
}
registrationNumber
legalStructure
assetStructure
inception
currency {
...CurrencyFragment
}
country {
...CountryFragment
}
cardImage {
...RemoteAssetFragment
}
totalUnitCountDecimal {
...FixedPointNumberFragment
}
calculatedNetAssetValue {
...MoneyFragment
}
targetCashReturn {
...FractionFragment
}
targetTotalReturn {
...FractionFragment
}
documents {
...FundDocumentFragment
}
assets {
...AssetFragment
}
asset {
...AssetFragment
}
offers {
...OfferFragment
}
distributions {
...DistributionFragment
}
searchDistributions {
...DistributionSearchResultsFragment
}
distribution {
...DistributionFragment
}
distributionV2 {
...DistributionV2Fragment
}
validateDistribution {
... on InvalidBankAccountDistributionAlert {
...InvalidBankAccountDistributionAlertFragment
}
}
secondaryMarket {
...SecondaryMarketFragment
}
sellOrder {
...SellOrderFragment
}
sellOrders {
...SellOrderFragment
}
buyOrder {
...BuyOrderFragment
}
buyOrders {
...BuyOrderFragment
}
offerStatus
investorType
largestOwnershipPercentageV2
numberOfActiveHoldings
fundManagerName
lastDistributionDate
equityRaised {
...MoneyFragment
}
hideDistributionMetrics
searchUnitRedemptionRequests {
...UnitRedemptionRequestSearchResultsFragment
}
unitRedemptionRequest {
...UnitRedemptionRequestFragment
}
unitRedemptionConfiguration {
...FundUnitRedemptionConfigurationFragment
}
unitPrecisionScale
searchUnitClasses {
...UnitClassSearchResultsFragment
}
showHoldingPageOnInvestorPortal
customMetrics {
...CustomMetricFragment
}
investorPortalConfiguration {
...FundInvestorPortalConfigurationFragment
}
unitTransferRequest {
...UnitTransferRequestFragment
}
depositBankAccount {
...BankAccountFragment
}
searchOutgoingBankAccounts {
...FundOutgoingBankAccountSearchResultsFragment
}
}
}
Variables
{"form": ConfirmBuyOrderInput}
Response
{
"data": {
"confirmBuyOrder": {
"id": 4,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"name": "abc123",
"legalName": "xyz789",
"shortDescription": "xyz789",
"summary": FundSummary,
"registrationNumber": "xyz789",
"legalStructure": "LIMITED_PARTNERSHIP",
"assetStructure": "SINGLE_ASSET",
"inception": "2007-12-03T10:15:30Z",
"currency": Currency,
"country": Country,
"cardImage": RemoteAsset,
"totalUnitCountDecimal": FixedPointNumber,
"calculatedNetAssetValue": Money,
"targetCashReturn": Fraction,
"targetTotalReturn": Fraction,
"documents": [FundDocument],
"assets": [Asset],
"asset": Asset,
"offers": [Offer],
"distributions": [Distribution],
"searchDistributions": DistributionSearchResults,
"distribution": Distribution,
"distributionV2": DistributionV2,
"validateDistribution": [
InvalidBankAccountDistributionAlert
],
"secondaryMarket": SecondaryMarket,
"sellOrder": SellOrder,
"sellOrders": [SellOrder],
"buyOrder": BuyOrder,
"buyOrders": [BuyOrder],
"offerStatus": "OPEN",
"investorType": "WHOLESALE",
"largestOwnershipPercentageV2": 123.45,
"numberOfActiveHoldings": 987,
"fundManagerName": "xyz789",
"lastDistributionDate": "2007-12-03T10:15:30Z",
"equityRaised": Money,
"hideDistributionMetrics": false,
"searchUnitRedemptionRequests": UnitRedemptionRequestSearchResults,
"unitRedemptionRequest": UnitRedemptionRequest,
"unitRedemptionConfiguration": FundUnitRedemptionConfiguration,
"unitPrecisionScale": 987,
"searchUnitClasses": UnitClassSearchResults,
"showHoldingPageOnInvestorPortal": true,
"customMetrics": [CustomMetric],
"investorPortalConfiguration": FundInvestorPortalConfiguration,
"unitTransferRequest": UnitTransferRequest,
"depositBankAccount": BankAccount,
"searchOutgoingBankAccounts": FundOutgoingBankAccountSearchResults
}
}
}
confirmCapitalCallBatch
Description
Confirm a capital call batch
Response
Returns a CapitalCallBatch!
Arguments
| Name | Description |
|---|---|
input - ConfirmCapitalCallBatchInput!
|
Example
Query
mutation confirmCapitalCallBatch($input: ConfirmCapitalCallBatchInput!) {
confirmCapitalCallBatch(input: $input) {
id
status
calculationConfig {
...CapitalCallBatchCalculationConfigFragment
}
createdAt
noticeDate
paymentDeadline
name
commentary
capitalCommitted {
...HighPrecisionMoneyFragment
}
capitalCalled {
...HighPrecisionMoneyFragment
}
capitalCalledToDate {
...HighPrecisionMoneyFragment
}
capitalRemainingToBeCalled {
...HighPrecisionMoneyFragment
}
capitalCallStatusCounts {
...CapitalCallBatchStatusCountFragment
}
failureMessages {
...CapitalCallBatchFailureFragment
}
capitalCalls {
...CapitalCallConnectionFragment
}
isOutdated
emailNotificationsEnabled
publishNoticeToInvestorPortalEnabled
}
}
Variables
{"input": ConfirmCapitalCallBatchInput}
Response
{
"data": {
"confirmCapitalCallBatch": {
"id": 4,
"status": "GENERATING",
"calculationConfig": CapitalCallBatchCalculationConfig,
"createdAt": "2007-12-03T10:15:30Z",
"noticeDate": "2007-12-03T10:15:30Z",
"paymentDeadline": "2007-12-03T10:15:30Z",
"name": "xyz789",
"commentary": "xyz789",
"capitalCommitted": HighPrecisionMoney,
"capitalCalled": HighPrecisionMoney,
"capitalCalledToDate": HighPrecisionMoney,
"capitalRemainingToBeCalled": HighPrecisionMoney,
"capitalCallStatusCounts": [
CapitalCallBatchStatusCount
],
"failureMessages": [CapitalCallBatchFailure],
"capitalCalls": CapitalCallConnection,
"isOutdated": true,
"emailNotificationsEnabled": true,
"publishNoticeToInvestorPortalEnabled": true
}
}
}
confirmDistribution
Description
Confirm a distribution for a fund
Response
Returns a DistributionV2!
Arguments
| Name | Description |
|---|---|
form - ConfirmDistributionInput!
|
Example
Query
mutation confirmDistribution($form: ConfirmDistributionInput!) {
confirmDistribution(form: $form) {
id
status
source
name
fund {
...FundFragment
}
lastCalculated
periodFrom
periodTo
paymentDate
grossDistribution {
...MoneyFragment
}
netDistribution {
...MoneyFragment
}
taxWithheld {
...MoneyFragment
}
totalReinvestment {
...MoneyFragment
}
withheldCount
disabledCount
reinvestmentCount
statementCommentary
components {
... on PercentageDistributionComponent {
...PercentageDistributionComponentFragment
}
... on TotalDollarAmountDistributionComponent {
...TotalDollarAmountDistributionComponentFragment
}
... on CentsPerUnitDistributionComponent {
...CentsPerUnitDistributionComponentFragment
}
... on UnitClassDistributionRatesDistributionComponent {
...UnitClassDistributionRatesDistributionComponentFragment
}
}
summaryForHoldings {
...DistributionSummaryFragment
}
confirmedBy {
...AdminUserFragment
}
confirmedAt
publishedAt
dateOfIssuance
notificationsEnabled
statementsEnabled
reinvestmentRoundingResidual {
...MoneyFragment
}
}
}
Variables
{"form": ConfirmDistributionInput}
Response
{
"data": {
"confirmDistribution": {
"id": 4,
"status": "DRAFT",
"source": "SYSTEM",
"name": "xyz789",
"fund": Fund,
"lastCalculated": "2007-12-03T10:15:30Z",
"periodFrom": "2007-12-03T10:15:30Z",
"periodTo": "2007-12-03T10:15:30Z",
"paymentDate": "2007-12-03T10:15:30Z",
"grossDistribution": Money,
"netDistribution": Money,
"taxWithheld": Money,
"totalReinvestment": Money,
"withheldCount": 987,
"disabledCount": 987,
"reinvestmentCount": 987,
"statementCommentary": "abc123",
"components": [PercentageDistributionComponent],
"summaryForHoldings": [DistributionSummary],
"confirmedBy": AdminUser,
"confirmedAt": "2007-12-03T10:15:30Z",
"publishedAt": "2007-12-03T10:15:30Z",
"dateOfIssuance": "2007-12-03T10:15:30Z",
"notificationsEnabled": true,
"statementsEnabled": true,
"reinvestmentRoundingResidual": Money
}
}
}
confirmEmailBatch
Description
Confirm and schedule the email batch for sending.
Response
Returns a ConfirmEmailBatchResponse!
Arguments
| Name | Description |
|---|---|
form - ConfirmEmailBatchInput!
|
Example
Query
mutation confirmEmailBatch($form: ConfirmEmailBatchInput!) {
confirmEmailBatch(form: $form) {
... on EmailBatch {
...EmailBatchFragment
}
}
}
Variables
{"form": ConfirmEmailBatchInput}
Response
{"data": {"confirmEmailBatch": EmailBatch}}
confirmImportBatch
Description
Process an import batch
Response
Returns an ImportBatch!
Arguments
| Name | Description |
|---|---|
form - ConfirmImportBatchInput!
|
Example
Query
mutation confirmImportBatch($form: ConfirmImportBatchInput!) {
confirmImportBatch(form: $form) {
id
createdAt
updatedAt
type
name
file {
...RemoteAssetFragment
}
createdBy {
...AdminUserFragment
}
confirmedBy {
...AdminUserFragment
}
confirmedAt
status
notificationTime
metadata {
... on UnitIssuanceImportMetadata {
...UnitIssuanceImportMetadataFragment
}
}
validationErrors {
...ImportValidationErrorFragment
}
importJobs {
...ImportJobFragment
}
}
}
Variables
{"form": ConfirmImportBatchInput}
Response
{
"data": {
"confirmImportBatch": {
"id": "4",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"type": "UNIT_ISSUANCE",
"name": "xyz789",
"file": RemoteAsset,
"createdBy": AdminUser,
"confirmedBy": AdminUser,
"confirmedAt": "2007-12-03T10:15:30Z",
"status": "GENERATING",
"notificationTime": "2007-12-03T10:15:30Z",
"metadata": UnitIssuanceImportMetadata,
"validationErrors": [ImportValidationError],
"importJobs": [ImportJob]
}
}
}
confirmSellOrder
Response
Returns a Fund!
Arguments
| Name | Description |
|---|---|
form - ConfirmSellOrderInput!
|
Example
Query
mutation confirmSellOrder($form: ConfirmSellOrderInput!) {
confirmSellOrder(form: $form) {
id
createdAt
updatedAt
name
legalName
shortDescription
summary {
...FundSummaryFragment
}
registrationNumber
legalStructure
assetStructure
inception
currency {
...CurrencyFragment
}
country {
...CountryFragment
}
cardImage {
...RemoteAssetFragment
}
totalUnitCountDecimal {
...FixedPointNumberFragment
}
calculatedNetAssetValue {
...MoneyFragment
}
targetCashReturn {
...FractionFragment
}
targetTotalReturn {
...FractionFragment
}
documents {
...FundDocumentFragment
}
assets {
...AssetFragment
}
asset {
...AssetFragment
}
offers {
...OfferFragment
}
distributions {
...DistributionFragment
}
searchDistributions {
...DistributionSearchResultsFragment
}
distribution {
...DistributionFragment
}
distributionV2 {
...DistributionV2Fragment
}
validateDistribution {
... on InvalidBankAccountDistributionAlert {
...InvalidBankAccountDistributionAlertFragment
}
}
secondaryMarket {
...SecondaryMarketFragment
}
sellOrder {
...SellOrderFragment
}
sellOrders {
...SellOrderFragment
}
buyOrder {
...BuyOrderFragment
}
buyOrders {
...BuyOrderFragment
}
offerStatus
investorType
largestOwnershipPercentageV2
numberOfActiveHoldings
fundManagerName
lastDistributionDate
equityRaised {
...MoneyFragment
}
hideDistributionMetrics
searchUnitRedemptionRequests {
...UnitRedemptionRequestSearchResultsFragment
}
unitRedemptionRequest {
...UnitRedemptionRequestFragment
}
unitRedemptionConfiguration {
...FundUnitRedemptionConfigurationFragment
}
unitPrecisionScale
searchUnitClasses {
...UnitClassSearchResultsFragment
}
showHoldingPageOnInvestorPortal
customMetrics {
...CustomMetricFragment
}
investorPortalConfiguration {
...FundInvestorPortalConfigurationFragment
}
unitTransferRequest {
...UnitTransferRequestFragment
}
depositBankAccount {
...BankAccountFragment
}
searchOutgoingBankAccounts {
...FundOutgoingBankAccountSearchResultsFragment
}
}
}
Variables
{"form": ConfirmSellOrderInput}
Response
{
"data": {
"confirmSellOrder": {
"id": 4,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"name": "abc123",
"legalName": "xyz789",
"shortDescription": "abc123",
"summary": FundSummary,
"registrationNumber": "xyz789",
"legalStructure": "LIMITED_PARTNERSHIP",
"assetStructure": "SINGLE_ASSET",
"inception": "2007-12-03T10:15:30Z",
"currency": Currency,
"country": Country,
"cardImage": RemoteAsset,
"totalUnitCountDecimal": FixedPointNumber,
"calculatedNetAssetValue": Money,
"targetCashReturn": Fraction,
"targetTotalReturn": Fraction,
"documents": [FundDocument],
"assets": [Asset],
"asset": Asset,
"offers": [Offer],
"distributions": [Distribution],
"searchDistributions": DistributionSearchResults,
"distribution": Distribution,
"distributionV2": DistributionV2,
"validateDistribution": [
InvalidBankAccountDistributionAlert
],
"secondaryMarket": SecondaryMarket,
"sellOrder": SellOrder,
"sellOrders": [SellOrder],
"buyOrder": BuyOrder,
"buyOrders": [BuyOrder],
"offerStatus": "OPEN",
"investorType": "WHOLESALE",
"largestOwnershipPercentageV2": 987.65,
"numberOfActiveHoldings": 987,
"fundManagerName": "abc123",
"lastDistributionDate": "2007-12-03T10:15:30Z",
"equityRaised": Money,
"hideDistributionMetrics": true,
"searchUnitRedemptionRequests": UnitRedemptionRequestSearchResults,
"unitRedemptionRequest": UnitRedemptionRequest,
"unitRedemptionConfiguration": FundUnitRedemptionConfiguration,
"unitPrecisionScale": 987,
"searchUnitClasses": UnitClassSearchResults,
"showHoldingPageOnInvestorPortal": true,
"customMetrics": [CustomMetric],
"investorPortalConfiguration": FundInvestorPortalConfiguration,
"unitTransferRequest": UnitTransferRequest,
"depositBankAccount": BankAccount,
"searchOutgoingBankAccounts": FundOutgoingBankAccountSearchResults
}
}
}
confirmStatementBatch
Description
Confirm a statement batch
Response
Returns a StatementBatch!
Arguments
| Name | Description |
|---|---|
input - ConfirmStatementBatchInput!
|
Example
Query
mutation confirmStatementBatch($input: ConfirmStatementBatchInput!) {
confirmStatementBatch(input: $input) {
id
name
createdAt
status
noData
configuration {
... on InvestorStatementConfig {
...InvestorStatementConfigFragment
}
... on TaxStatementConfig {
...TaxStatementConfigFragment
}
... on HoldingStatementConfig {
...HoldingStatementConfigFragment
}
... on PeriodicStatementConfig {
...PeriodicStatementConfigFragment
}
}
generation {
...StatementGenerationFragment
}
enrichment {
...StatementEnrichmentFragment
}
confirmation {
...StatementConfirmationFragment
}
publication {
...StatementPublicationFragment
}
numberOfStatements
statements {
...StatementConnectionFragment
}
}
}
Variables
{"input": ConfirmStatementBatchInput}
Response
{
"data": {
"confirmStatementBatch": {
"id": "4",
"name": "xyz789",
"createdAt": "2007-12-03T10:15:30Z",
"status": "GENERATING",
"noData": true,
"configuration": InvestorStatementConfig,
"generation": StatementGeneration,
"enrichment": StatementEnrichment,
"confirmation": StatementConfirmation,
"publication": StatementPublication,
"numberOfStatements": 987,
"statements": StatementConnection
}
}
}
confirmUnitRedemptionRequest
Description
Confirm an existing unit redemption request
Response
Returns a UnitRedemptionRequest!
Arguments
| Name | Description |
|---|---|
form - ConfirmUnitRedemptionRequestInput!
|
Example
Query
mutation confirmUnitRedemptionRequest($form: ConfirmUnitRedemptionRequestInput!) {
confirmUnitRedemptionRequest(form: $form) {
id
status
holding {
...HoldingFragment
}
unitCountDecimal {
...FixedPointNumberFragment
}
unitPrice {
...MoneyFragment
}
unitPriceV2 {
...HighPrecisionMoneyFragment
}
orderValue {
...MoneyFragment
}
dateReceived
dateOfRedemption
note {
...NoteFragment
}
tags
}
}
Variables
{"form": ConfirmUnitRedemptionRequestInput}
Response
{
"data": {
"confirmUnitRedemptionRequest": {
"id": 4,
"status": "REQUESTED",
"holding": Holding,
"unitCountDecimal": FixedPointNumber,
"unitPrice": Money,
"unitPriceV2": HighPrecisionMoney,
"orderValue": Money,
"dateReceived": "2007-12-03T10:15:30Z",
"dateOfRedemption": "2007-12-03T10:15:30Z",
"note": Note,
"tags": ["RELATED_PARTY_NCBO"]
}
}
}
confirmUnitTransferRequest
Description
Confirm an existing unit transfer request
Response
Returns a UnitTransferRequest!
Arguments
| Name | Description |
|---|---|
form - ConfirmUnitTransferRequestInput!
|
Example
Query
mutation confirmUnitTransferRequest($form: ConfirmUnitTransferRequestInput!) {
confirmUnitTransferRequest(form: $form) {
id
status
fromHolding {
...HoldingFragment
}
toInvestingEntity {
...InvestingEntityFragment
}
unitCount {
...FixedPointNumberFragment
}
unitPrice {
...MoneyFragment
}
totalValue {
...MoneyFragment
}
dateReceived
dateOfTransfer
note {
...NoteFragment
}
tags
}
}
Variables
{"form": ConfirmUnitTransferRequestInput}
Response
{
"data": {
"confirmUnitTransferRequest": {
"id": 4,
"status": "REQUESTED",
"fromHolding": Holding,
"toInvestingEntity": InvestingEntity,
"unitCount": FixedPointNumber,
"unitPrice": Money,
"totalValue": Money,
"dateReceived": "2007-12-03T10:15:30Z",
"dateOfTransfer": "2007-12-03T10:15:30Z",
"note": Note,
"tags": ["RELATED_PARTY_NCBO"]
}
}
}
convertProspectToAccount
Response
Returns an Account!
Arguments
| Name | Description |
|---|---|
form - ConvertProspectToAccountInput!
|
Example
Query
mutation convertProspectToAccount($form: ConvertProspectToAccountInput!) {
convertProspectToAccount(form: $form) {
id
created
updated
lastLoggedIn
email
hasPasswordSet
activationEmailLastSent
legalName {
...LegalNameFragment
}
preferredName
timeZone
dateOfBirth {
...DayMonthYearFragment
}
termsAgreed
isAccountLocked
accountLockedReason
addresses {
...VerifiableAddressFragment
}
phoneNumber {
...PhoneNumberFragment
}
emailConfirmed
status
setupStatus {
...AccountSetupStatusFragment
}
investingEntities {
...InvestingEntityFragment
}
identityVerifications {
...IdentityVerificationFragment
}
pepSearchResult {
...PEPSearchResultFragment
}
notes {
...NoteFragment
}
searchActivityFeed {
...ActivityFeedResultsFragment
}
totalPortfolioValue {
...MoneyFragment
}
jobTitle
industry
organization
twitterProfileUrl
linkedInProfileUrl
biography
accountManager {
...AdminUserFragment
}
tagsV2 {
...InvestorProfileTagFragment
}
connections {
...ConnectionFragment
}
outstandingTasks {
...TaskFragment
}
outstandingNotifications {
...AccountNotificationFragment
}
identityVerificationStatus
allHoldingsCSVUrl
identityVerificationLastSent
}
}
Variables
{"form": ConvertProspectToAccountInput}
Response
{
"data": {
"convertProspectToAccount": {
"id": 4,
"created": "2007-12-03T10:15:30Z",
"updated": "2007-12-03T10:15:30Z",
"lastLoggedIn": "2007-12-03T10:15:30Z",
"email": "abc123",
"hasPasswordSet": false,
"activationEmailLastSent": "2007-12-03T10:15:30Z",
"legalName": LegalName,
"preferredName": "xyz789",
"timeZone": "xyz789",
"dateOfBirth": DayMonthYear,
"termsAgreed": true,
"isAccountLocked": true,
"accountLockedReason": "xyz789",
"addresses": [VerifiableAddress],
"phoneNumber": PhoneNumber,
"emailConfirmed": false,
"status": "PENDING",
"setupStatus": AccountSetupStatus,
"investingEntities": [InvestingEntity],
"identityVerifications": [IdentityVerification],
"pepSearchResult": PEPSearchResult,
"notes": [Note],
"searchActivityFeed": ActivityFeedResults,
"totalPortfolioValue": Money,
"jobTitle": "xyz789",
"industry": "abc123",
"organization": "abc123",
"twitterProfileUrl": "http://www.test.com/",
"linkedInProfileUrl": "http://www.test.com/",
"biography": "xyz789",
"accountManager": AdminUser,
"tagsV2": [InvestorProfileTag],
"connections": [Connection],
"outstandingTasks": [Task],
"outstandingNotifications": [AccountNotification],
"identityVerificationStatus": "INCOMPLETE",
"allHoldingsCSVUrl": "xyz789",
"identityVerificationLastSent": "2007-12-03T10:15:30Z"
}
}
}
convertRegistrationOfInterestToAllocation
Registration of Interest will be merged into Allocation
Description
Converts the registration of interest into an allocation request. The investing entity does not need to be related to the existing assigned prospect or account This deletes the existing registration of interest.
Response
Returns an Allocation!
Arguments
| Name | Description |
|---|---|
form - ConvertRegistrationOfInterestInput!
|
Example
Query
mutation convertRegistrationOfInterestToAllocation($form: ConvertRegistrationOfInterestInput!) {
convertRegistrationOfInterestToAllocation(form: $form) {
id
createdAt
offer {
...OfferFragment
}
ownershipPercentage
investingEntity {
...InvestingEntityFragment
}
associatedContact {
... on InvestingEntity {
...InvestingEntityFragment
}
... on Account {
...AccountFragment
}
... on Prospect {
...ProspectFragment
}
}
status
unitCountDecimal {
...FixedPointNumberFragment
}
pricePerUnit {
...MoneyFragment
}
pricePerUnitV2 {
...HighPrecisionMoneyFragment
}
totalValue {
...MoneyFragment
}
expectedReference
payments {
...ManualAllocationPaymentFragment
}
totalPaid {
...MoneyFragment
}
note
balance {
...MoneyFragment
}
unitsIssued {
...FixedPointNumberFragment
}
issuedHolding {
...HoldingFragment
}
capitalCalled {
...HighPrecisionMoneyFragment
}
customFieldSection {
...CustomFieldSectionFragment
}
}
}
Variables
{"form": ConvertRegistrationOfInterestInput}
Response
{
"data": {
"convertRegistrationOfInterestToAllocation": {
"id": 4,
"createdAt": "2007-12-03T10:15:30Z",
"offer": Offer,
"ownershipPercentage": "xyz789",
"investingEntity": InvestingEntity,
"associatedContact": InvestingEntity,
"status": "INTERESTED",
"unitCountDecimal": FixedPointNumber,
"pricePerUnit": Money,
"pricePerUnitV2": HighPrecisionMoney,
"totalValue": Money,
"expectedReference": "xyz789",
"payments": [ManualAllocationPayment],
"totalPaid": Money,
"note": "abc123",
"balance": Money,
"unitsIssued": FixedPointNumber,
"issuedHolding": Holding,
"capitalCalled": HighPrecisionMoney,
"customFieldSection": [CustomFieldSection]
}
}
}
createAllocation
Description
Create an allocation request for an investing entity against an offer
Response
Returns an Allocation!
Arguments
| Name | Description |
|---|---|
form - CreateAllocationInput!
|
Example
Query
mutation createAllocation($form: CreateAllocationInput!) {
createAllocation(form: $form) {
id
createdAt
offer {
...OfferFragment
}
ownershipPercentage
investingEntity {
...InvestingEntityFragment
}
associatedContact {
... on InvestingEntity {
...InvestingEntityFragment
}
... on Account {
...AccountFragment
}
... on Prospect {
...ProspectFragment
}
}
status
unitCountDecimal {
...FixedPointNumberFragment
}
pricePerUnit {
...MoneyFragment
}
pricePerUnitV2 {
...HighPrecisionMoneyFragment
}
totalValue {
...MoneyFragment
}
expectedReference
payments {
...ManualAllocationPaymentFragment
}
totalPaid {
...MoneyFragment
}
note
balance {
...MoneyFragment
}
unitsIssued {
...FixedPointNumberFragment
}
issuedHolding {
...HoldingFragment
}
capitalCalled {
...HighPrecisionMoneyFragment
}
customFieldSection {
...CustomFieldSectionFragment
}
}
}
Variables
{"form": CreateAllocationInput}
Response
{
"data": {
"createAllocation": {
"id": 4,
"createdAt": "2007-12-03T10:15:30Z",
"offer": Offer,
"ownershipPercentage": "xyz789",
"investingEntity": InvestingEntity,
"associatedContact": InvestingEntity,
"status": "INTERESTED",
"unitCountDecimal": FixedPointNumber,
"pricePerUnit": Money,
"pricePerUnitV2": HighPrecisionMoney,
"totalValue": Money,
"expectedReference": "xyz789",
"payments": [ManualAllocationPayment],
"totalPaid": Money,
"note": "abc123",
"balance": Money,
"unitsIssued": FixedPointNumber,
"issuedHolding": Holding,
"capitalCalled": HighPrecisionMoney,
"customFieldSection": [CustomFieldSection]
}
}
}
createAnnualPercentageUnitClassFee
Description
Create an annual percentage fee on a unit class
Response
Returns a UnitClassFee!
Arguments
| Name | Description |
|---|---|
form - CreateAnnualPercentageUnitClassFeeInput!
|
Example
Query
mutation createAnnualPercentageUnitClassFee($form: CreateAnnualPercentageUnitClassFeeInput!) {
createAnnualPercentageUnitClassFee(form: $form) {
id
unitClass {
...UnitClassFragment
}
config {
... on AnnualPercentageFee {
...AnnualPercentageFeeFragment
}
... on TotalDollarFee {
...TotalDollarFeeFragment
}
}
note
createdBy {
...AdminUserFragment
}
createdAt
}
}
Variables
{"form": CreateAnnualPercentageUnitClassFeeInput}
Response
{
"data": {
"createAnnualPercentageUnitClassFee": {
"id": "4",
"unitClass": UnitClass,
"config": AnnualPercentageFee,
"note": "abc123",
"createdBy": AdminUser,
"createdAt": "2007-12-03T10:15:30Z"
}
}
}
createAsset
Description
Create a new Asset
Response
Returns an Asset!
Arguments
| Name | Description |
|---|---|
form - CreateAssetInput!
|
Example
Query
mutation createAsset($form: CreateAssetInput!) {
createAsset(form: $form) {
id
name
address
country {
...CountryFragment
}
cardImage {
...RemoteAssetFragment
}
fund {
...FundFragment
}
}
}
Variables
{"form": CreateAssetInput}
Response
{
"data": {
"createAsset": {
"id": "4",
"name": "abc123",
"address": "abc123",
"country": Country,
"cardImage": RemoteAsset,
"fund": Fund
}
}
}
createCapitalCallBatch
Description
Create a new capital call batch
Response
Returns a CapitalCallBatch!
Arguments
| Name | Description |
|---|---|
input - CreateCapitalCallBatchInput!
|
Example
Query
mutation createCapitalCallBatch($input: CreateCapitalCallBatchInput!) {
createCapitalCallBatch(input: $input) {
id
status
calculationConfig {
...CapitalCallBatchCalculationConfigFragment
}
createdAt
noticeDate
paymentDeadline
name
commentary
capitalCommitted {
...HighPrecisionMoneyFragment
}
capitalCalled {
...HighPrecisionMoneyFragment
}
capitalCalledToDate {
...HighPrecisionMoneyFragment
}
capitalRemainingToBeCalled {
...HighPrecisionMoneyFragment
}
capitalCallStatusCounts {
...CapitalCallBatchStatusCountFragment
}
failureMessages {
...CapitalCallBatchFailureFragment
}
capitalCalls {
...CapitalCallConnectionFragment
}
isOutdated
emailNotificationsEnabled
publishNoticeToInvestorPortalEnabled
}
}
Variables
{"input": CreateCapitalCallBatchInput}
Response
{
"data": {
"createCapitalCallBatch": {
"id": "4",
"status": "GENERATING",
"calculationConfig": CapitalCallBatchCalculationConfig,
"createdAt": "2007-12-03T10:15:30Z",
"noticeDate": "2007-12-03T10:15:30Z",
"paymentDeadline": "2007-12-03T10:15:30Z",
"name": "xyz789",
"commentary": "abc123",
"capitalCommitted": HighPrecisionMoney,
"capitalCalled": HighPrecisionMoney,
"capitalCalledToDate": HighPrecisionMoney,
"capitalRemainingToBeCalled": HighPrecisionMoney,
"capitalCallStatusCounts": [
CapitalCallBatchStatusCount
],
"failureMessages": [CapitalCallBatchFailure],
"capitalCalls": CapitalCallConnection,
"isOutdated": true,
"emailNotificationsEnabled": false,
"publishNoticeToInvestorPortalEnabled": true
}
}
}
createCompanyInvestingEntity
Description
Create a new company investing entity
Response
Returns an Account!
Arguments
| Name | Description |
|---|---|
form - CreateCompanyInvestingEntityInput!
|
Example
Query
mutation createCompanyInvestingEntity($form: CreateCompanyInvestingEntityInput!) {
createCompanyInvestingEntity(form: $form) {
id
created
updated
lastLoggedIn
email
hasPasswordSet
activationEmailLastSent
legalName {
...LegalNameFragment
}
preferredName
timeZone
dateOfBirth {
...DayMonthYearFragment
}
termsAgreed
isAccountLocked
accountLockedReason
addresses {
...VerifiableAddressFragment
}
phoneNumber {
...PhoneNumberFragment
}
emailConfirmed
status
setupStatus {
...AccountSetupStatusFragment
}
investingEntities {
...InvestingEntityFragment
}
identityVerifications {
...IdentityVerificationFragment
}
pepSearchResult {
...PEPSearchResultFragment
}
notes {
...NoteFragment
}
searchActivityFeed {
...ActivityFeedResultsFragment
}
totalPortfolioValue {
...MoneyFragment
}
jobTitle
industry
organization
twitterProfileUrl
linkedInProfileUrl
biography
accountManager {
...AdminUserFragment
}
tagsV2 {
...InvestorProfileTagFragment
}
connections {
...ConnectionFragment
}
outstandingTasks {
...TaskFragment
}
outstandingNotifications {
...AccountNotificationFragment
}
identityVerificationStatus
allHoldingsCSVUrl
identityVerificationLastSent
}
}
Variables
{"form": CreateCompanyInvestingEntityInput}
Response
{
"data": {
"createCompanyInvestingEntity": {
"id": "4",
"created": "2007-12-03T10:15:30Z",
"updated": "2007-12-03T10:15:30Z",
"lastLoggedIn": "2007-12-03T10:15:30Z",
"email": "abc123",
"hasPasswordSet": true,
"activationEmailLastSent": "2007-12-03T10:15:30Z",
"legalName": LegalName,
"preferredName": "abc123",
"timeZone": "xyz789",
"dateOfBirth": DayMonthYear,
"termsAgreed": false,
"isAccountLocked": true,
"accountLockedReason": "abc123",
"addresses": [VerifiableAddress],
"phoneNumber": PhoneNumber,
"emailConfirmed": true,
"status": "PENDING",
"setupStatus": AccountSetupStatus,
"investingEntities": [InvestingEntity],
"identityVerifications": [IdentityVerification],
"pepSearchResult": PEPSearchResult,
"notes": [Note],
"searchActivityFeed": ActivityFeedResults,
"totalPortfolioValue": Money,
"jobTitle": "abc123",
"industry": "abc123",
"organization": "abc123",
"twitterProfileUrl": "http://www.test.com/",
"linkedInProfileUrl": "http://www.test.com/",
"biography": "xyz789",
"accountManager": AdminUser,
"tagsV2": [InvestorProfileTag],
"connections": [Connection],
"outstandingTasks": [Task],
"outstandingNotifications": [AccountNotification],
"identityVerificationStatus": "INCOMPLETE",
"allHoldingsCSVUrl": "abc123",
"identityVerificationLastSent": "2007-12-03T10:15:30Z"
}
}
}
createConnection
Description
Create a connection between two connection profiles
Response
Returns a ConnectionProfile!
Arguments
| Name | Description |
|---|---|
form - CreateConnectionInput!
|
Example
Query
mutation createConnection($form: CreateConnectionInput!) {
createConnection(form: $form) {
... on Prospect {
...ProspectFragment
}
... on Account {
...AccountFragment
}
}
}
Variables
{"form": CreateConnectionInput}
Response
{"data": {"createConnection": Prospect}}
createDepositMethod
Description
Create a deposit method
Response
Returns a DepositMethod!
Arguments
| Name | Description |
|---|---|
form - CreateDepositMethodInput!
|
Example
Query
mutation createDepositMethod($form: CreateDepositMethodInput!) {
createDepositMethod(form: $form) {
id
name
paymentMethod {
... on BankAccountV2 {
...BankAccountV2Fragment
}
... on Cheque {
...ChequeFragment
}
... on Bpay {
...BpayFragment
}
}
isLinked
}
}
Variables
{"form": CreateDepositMethodInput}
Response
{
"data": {
"createDepositMethod": {
"id": 4,
"name": "xyz789",
"paymentMethod": BankAccountV2,
"isLinked": true
}
}
}
createDistribution
Description
Create a new distribution for a fund
Response
Returns a DistributionV2!
Arguments
| Name | Description |
|---|---|
form - CreateDistributionInput!
|
Example
Query
mutation createDistribution($form: CreateDistributionInput!) {
createDistribution(form: $form) {
id
status
source
name
fund {
...FundFragment
}
lastCalculated
periodFrom
periodTo
paymentDate
grossDistribution {
...MoneyFragment
}
netDistribution {
...MoneyFragment
}
taxWithheld {
...MoneyFragment
}
totalReinvestment {
...MoneyFragment
}
withheldCount
disabledCount
reinvestmentCount
statementCommentary
components {
... on PercentageDistributionComponent {
...PercentageDistributionComponentFragment
}
... on TotalDollarAmountDistributionComponent {
...TotalDollarAmountDistributionComponentFragment
}
... on CentsPerUnitDistributionComponent {
...CentsPerUnitDistributionComponentFragment
}
... on UnitClassDistributionRatesDistributionComponent {
...UnitClassDistributionRatesDistributionComponentFragment
}
}
summaryForHoldings {
...DistributionSummaryFragment
}
confirmedBy {
...AdminUserFragment
}
confirmedAt
publishedAt
dateOfIssuance
notificationsEnabled
statementsEnabled
reinvestmentRoundingResidual {
...MoneyFragment
}
}
}
Variables
{"form": CreateDistributionInput}
Response
{
"data": {
"createDistribution": {
"id": 4,
"status": "DRAFT",
"source": "SYSTEM",
"name": "abc123",
"fund": Fund,
"lastCalculated": "2007-12-03T10:15:30Z",
"periodFrom": "2007-12-03T10:15:30Z",
"periodTo": "2007-12-03T10:15:30Z",
"paymentDate": "2007-12-03T10:15:30Z",
"grossDistribution": Money,
"netDistribution": Money,
"taxWithheld": Money,
"totalReinvestment": Money,
"withheldCount": 987,
"disabledCount": 987,
"reinvestmentCount": 987,
"statementCommentary": "abc123",
"components": [PercentageDistributionComponent],
"summaryForHoldings": [DistributionSummary],
"confirmedBy": AdminUser,
"confirmedAt": "2007-12-03T10:15:30Z",
"publishedAt": "2007-12-03T10:15:30Z",
"dateOfIssuance": "2007-12-03T10:15:30Z",
"notificationsEnabled": false,
"statementsEnabled": true,
"reinvestmentRoundingResidual": Money
}
}
}
createEmailBatch
Description
Create a new email batch in the system.
Response
Returns a CreateEmailBatchResponse!
Arguments
| Name | Description |
|---|---|
form - CreateEmailBatchInput!
|
Example
Query
mutation createEmailBatch($form: CreateEmailBatchInput!) {
createEmailBatch(form: $form) {
... on EmailBatch {
...EmailBatchFragment
}
}
}
Variables
{"form": CreateEmailBatchInput}
Response
{"data": {"createEmailBatch": EmailBatch}}
createEmailTemplate
Description
Create a new email template
Response
Returns an EmailTemplate!
Arguments
| Name | Description |
|---|---|
form - CreateEmailTemplateInput!
|
Example
Query
mutation createEmailTemplate($form: CreateEmailTemplateInput!) {
createEmailTemplate(form: $form) {
id
createdAt
name
template
fund {
...FundFragment
}
contextLinkTypes
}
}
Variables
{"form": CreateEmailTemplateInput}
Response
{
"data": {
"createEmailTemplate": {
"id": "4",
"createdAt": "2007-12-03T10:15:30Z",
"name": "abc123",
"template": "abc123",
"fund": Fund,
"contextLinkTypes": ["FUND"]
}
}
}
createFund
Description
Create a new Fund
Response
Returns a Fund!
Arguments
| Name | Description |
|---|---|
form - CreateFundInput!
|
Example
Query
mutation createFund($form: CreateFundInput!) {
createFund(form: $form) {
id
createdAt
updatedAt
name
legalName
shortDescription
summary {
...FundSummaryFragment
}
registrationNumber
legalStructure
assetStructure
inception
currency {
...CurrencyFragment
}
country {
...CountryFragment
}
cardImage {
...RemoteAssetFragment
}
totalUnitCountDecimal {
...FixedPointNumberFragment
}
calculatedNetAssetValue {
...MoneyFragment
}
targetCashReturn {
...FractionFragment
}
targetTotalReturn {
...FractionFragment
}
documents {
...FundDocumentFragment
}
assets {
...AssetFragment
}
asset {
...AssetFragment
}
offers {
...OfferFragment
}
distributions {
...DistributionFragment
}
searchDistributions {
...DistributionSearchResultsFragment
}
distribution {
...DistributionFragment
}
distributionV2 {
...DistributionV2Fragment
}
validateDistribution {
... on InvalidBankAccountDistributionAlert {
...InvalidBankAccountDistributionAlertFragment
}
}
secondaryMarket {
...SecondaryMarketFragment
}
sellOrder {
...SellOrderFragment
}
sellOrders {
...SellOrderFragment
}
buyOrder {
...BuyOrderFragment
}
buyOrders {
...BuyOrderFragment
}
offerStatus
investorType
largestOwnershipPercentageV2
numberOfActiveHoldings
fundManagerName
lastDistributionDate
equityRaised {
...MoneyFragment
}
hideDistributionMetrics
searchUnitRedemptionRequests {
...UnitRedemptionRequestSearchResultsFragment
}
unitRedemptionRequest {
...UnitRedemptionRequestFragment
}
unitRedemptionConfiguration {
...FundUnitRedemptionConfigurationFragment
}
unitPrecisionScale
searchUnitClasses {
...UnitClassSearchResultsFragment
}
showHoldingPageOnInvestorPortal
customMetrics {
...CustomMetricFragment
}
investorPortalConfiguration {
...FundInvestorPortalConfigurationFragment
}
unitTransferRequest {
...UnitTransferRequestFragment
}
depositBankAccount {
...BankAccountFragment
}
searchOutgoingBankAccounts {
...FundOutgoingBankAccountSearchResultsFragment
}
}
}
Variables
{"form": CreateFundInput}
Response
{
"data": {
"createFund": {
"id": 4,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"name": "abc123",
"legalName": "abc123",
"shortDescription": "abc123",
"summary": FundSummary,
"registrationNumber": "abc123",
"legalStructure": "LIMITED_PARTNERSHIP",
"assetStructure": "SINGLE_ASSET",
"inception": "2007-12-03T10:15:30Z",
"currency": Currency,
"country": Country,
"cardImage": RemoteAsset,
"totalUnitCountDecimal": FixedPointNumber,
"calculatedNetAssetValue": Money,
"targetCashReturn": Fraction,
"targetTotalReturn": Fraction,
"documents": [FundDocument],
"assets": [Asset],
"asset": Asset,
"offers": [Offer],
"distributions": [Distribution],
"searchDistributions": DistributionSearchResults,
"distribution": Distribution,
"distributionV2": DistributionV2,
"validateDistribution": [
InvalidBankAccountDistributionAlert
],
"secondaryMarket": SecondaryMarket,
"sellOrder": SellOrder,
"sellOrders": [SellOrder],
"buyOrder": BuyOrder,
"buyOrders": [BuyOrder],
"offerStatus": "OPEN",
"investorType": "WHOLESALE",
"largestOwnershipPercentageV2": 987.65,
"numberOfActiveHoldings": 987,
"fundManagerName": "xyz789",
"lastDistributionDate": "2007-12-03T10:15:30Z",
"equityRaised": Money,
"hideDistributionMetrics": true,
"searchUnitRedemptionRequests": UnitRedemptionRequestSearchResults,
"unitRedemptionRequest": UnitRedemptionRequest,
"unitRedemptionConfiguration": FundUnitRedemptionConfiguration,
"unitPrecisionScale": 987,
"searchUnitClasses": UnitClassSearchResults,
"showHoldingPageOnInvestorPortal": true,
"customMetrics": [CustomMetric],
"investorPortalConfiguration": FundInvestorPortalConfiguration,
"unitTransferRequest": UnitTransferRequest,
"depositBankAccount": BankAccount,
"searchOutgoingBankAccounts": FundOutgoingBankAccountSearchResults
}
}
}
createFundDocument
Description
Upload a new document against a Fund
Response
Returns a Fund!
Arguments
| Name | Description |
|---|---|
form - CreateFundDocumentInput!
|
Example
Query
mutation createFundDocument($form: CreateFundDocumentInput!) {
createFundDocument(form: $form) {
id
createdAt
updatedAt
name
legalName
shortDescription
summary {
...FundSummaryFragment
}
registrationNumber
legalStructure
assetStructure
inception
currency {
...CurrencyFragment
}
country {
...CountryFragment
}
cardImage {
...RemoteAssetFragment
}
totalUnitCountDecimal {
...FixedPointNumberFragment
}
calculatedNetAssetValue {
...MoneyFragment
}
targetCashReturn {
...FractionFragment
}
targetTotalReturn {
...FractionFragment
}
documents {
...FundDocumentFragment
}
assets {
...AssetFragment
}
asset {
...AssetFragment
}
offers {
...OfferFragment
}
distributions {
...DistributionFragment
}
searchDistributions {
...DistributionSearchResultsFragment
}
distribution {
...DistributionFragment
}
distributionV2 {
...DistributionV2Fragment
}
validateDistribution {
... on InvalidBankAccountDistributionAlert {
...InvalidBankAccountDistributionAlertFragment
}
}
secondaryMarket {
...SecondaryMarketFragment
}
sellOrder {
...SellOrderFragment
}
sellOrders {
...SellOrderFragment
}
buyOrder {
...BuyOrderFragment
}
buyOrders {
...BuyOrderFragment
}
offerStatus
investorType
largestOwnershipPercentageV2
numberOfActiveHoldings
fundManagerName
lastDistributionDate
equityRaised {
...MoneyFragment
}
hideDistributionMetrics
searchUnitRedemptionRequests {
...UnitRedemptionRequestSearchResultsFragment
}
unitRedemptionRequest {
...UnitRedemptionRequestFragment
}
unitRedemptionConfiguration {
...FundUnitRedemptionConfigurationFragment
}
unitPrecisionScale
searchUnitClasses {
...UnitClassSearchResultsFragment
}
showHoldingPageOnInvestorPortal
customMetrics {
...CustomMetricFragment
}
investorPortalConfiguration {
...FundInvestorPortalConfigurationFragment
}
unitTransferRequest {
...UnitTransferRequestFragment
}
depositBankAccount {
...BankAccountFragment
}
searchOutgoingBankAccounts {
...FundOutgoingBankAccountSearchResultsFragment
}
}
}
Variables
{"form": CreateFundDocumentInput}
Response
{
"data": {
"createFundDocument": {
"id": 4,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"name": "abc123",
"legalName": "xyz789",
"shortDescription": "xyz789",
"summary": FundSummary,
"registrationNumber": "xyz789",
"legalStructure": "LIMITED_PARTNERSHIP",
"assetStructure": "SINGLE_ASSET",
"inception": "2007-12-03T10:15:30Z",
"currency": Currency,
"country": Country,
"cardImage": RemoteAsset,
"totalUnitCountDecimal": FixedPointNumber,
"calculatedNetAssetValue": Money,
"targetCashReturn": Fraction,
"targetTotalReturn": Fraction,
"documents": [FundDocument],
"assets": [Asset],
"asset": Asset,
"offers": [Offer],
"distributions": [Distribution],
"searchDistributions": DistributionSearchResults,
"distribution": Distribution,
"distributionV2": DistributionV2,
"validateDistribution": [
InvalidBankAccountDistributionAlert
],
"secondaryMarket": SecondaryMarket,
"sellOrder": SellOrder,
"sellOrders": [SellOrder],
"buyOrder": BuyOrder,
"buyOrders": [BuyOrder],
"offerStatus": "OPEN",
"investorType": "WHOLESALE",
"largestOwnershipPercentageV2": 123.45,
"numberOfActiveHoldings": 987,
"fundManagerName": "xyz789",
"lastDistributionDate": "2007-12-03T10:15:30Z",
"equityRaised": Money,
"hideDistributionMetrics": true,
"searchUnitRedemptionRequests": UnitRedemptionRequestSearchResults,
"unitRedemptionRequest": UnitRedemptionRequest,
"unitRedemptionConfiguration": FundUnitRedemptionConfiguration,
"unitPrecisionScale": 123,
"searchUnitClasses": UnitClassSearchResults,
"showHoldingPageOnInvestorPortal": true,
"customMetrics": [CustomMetric],
"investorPortalConfiguration": FundInvestorPortalConfiguration,
"unitTransferRequest": UnitTransferRequest,
"depositBankAccount": BankAccount,
"searchOutgoingBankAccounts": FundOutgoingBankAccountSearchResults
}
}
}
createFundOutgoingBankAccount
Response
Returns a FundOutgoingBankAccount!
Arguments
| Name | Description |
|---|---|
input - CreateFundOutgoingBankAccountInput!
|
Example
Query
mutation createFundOutgoingBankAccount($input: CreateFundOutgoingBankAccountInput!) {
createFundOutgoingBankAccount(input: $input) {
id
created
name
accountNumber
businessIdentifierCode
currency {
...CurrencyFragment
}
bankAccountLocationDetails {
... on AUDBankAccountBankAccountLocationDetails {
...AUDBankAccountBankAccountLocationDetailsFragment
}
... on USDBankAccountBankAccountLocationDetails {
...USDBankAccountBankAccountLocationDetailsFragment
}
... on GBPBankAccountBankAccountLocationDetails {
...GBPBankAccountBankAccountLocationDetailsFragment
}
}
isFundDefault
}
}
Variables
{"input": CreateFundOutgoingBankAccountInput}
Response
{
"data": {
"createFundOutgoingBankAccount": {
"id": "4",
"created": "2007-12-03T10:15:30Z",
"name": "abc123",
"accountNumber": "xyz789",
"businessIdentifierCode": "xyz789",
"currency": Currency,
"bankAccountLocationDetails": AUDBankAccountBankAccountLocationDetails,
"isFundDefault": false
}
}
}
createImpersonationSession
Response
Returns an URL!
Arguments
| Name | Description |
|---|---|
form - CreateImpersonationSessionInput!
|
Example
Query
mutation createImpersonationSession($form: CreateImpersonationSessionInput!) {
createImpersonationSession(form: $form)
}
Variables
{"form": CreateImpersonationSessionInput}
Response
{
"data": {
"createImpersonationSession": "http://www.test.com/"
}
}
createImportBatch
Description
Create a new import batch
Response
Returns an ImportBatch!
Arguments
| Name | Description |
|---|---|
form - CreateImportBatchInput!
|
Example
Query
mutation createImportBatch($form: CreateImportBatchInput!) {
createImportBatch(form: $form) {
id
createdAt
updatedAt
type
name
file {
...RemoteAssetFragment
}
createdBy {
...AdminUserFragment
}
confirmedBy {
...AdminUserFragment
}
confirmedAt
status
notificationTime
metadata {
... on UnitIssuanceImportMetadata {
...UnitIssuanceImportMetadataFragment
}
}
validationErrors {
...ImportValidationErrorFragment
}
importJobs {
...ImportJobFragment
}
}
}
Variables
{"form": CreateImportBatchInput}
Response
{
"data": {
"createImportBatch": {
"id": 4,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"type": "UNIT_ISSUANCE",
"name": "xyz789",
"file": RemoteAsset,
"createdBy": AdminUser,
"confirmedBy": AdminUser,
"confirmedAt": "2007-12-03T10:15:30Z",
"status": "GENERATING",
"notificationTime": "2007-12-03T10:15:30Z",
"metadata": UnitIssuanceImportMetadata,
"validationErrors": [ImportValidationError],
"importJobs": [ImportJob]
}
}
}
createIndividualInvestingEntity
Description
Create a new individual investing entity
Response
Returns an Account!
Arguments
| Name | Description |
|---|---|
form - CreateIndividualInvestingEntityInput!
|
Example
Query
mutation createIndividualInvestingEntity($form: CreateIndividualInvestingEntityInput!) {
createIndividualInvestingEntity(form: $form) {
id
created
updated
lastLoggedIn
email
hasPasswordSet
activationEmailLastSent
legalName {
...LegalNameFragment
}
preferredName
timeZone
dateOfBirth {
...DayMonthYearFragment
}
termsAgreed
isAccountLocked
accountLockedReason
addresses {
...VerifiableAddressFragment
}
phoneNumber {
...PhoneNumberFragment
}
emailConfirmed
status
setupStatus {
...AccountSetupStatusFragment
}
investingEntities {
...InvestingEntityFragment
}
identityVerifications {
...IdentityVerificationFragment
}
pepSearchResult {
...PEPSearchResultFragment
}
notes {
...NoteFragment
}
searchActivityFeed {
...ActivityFeedResultsFragment
}
totalPortfolioValue {
...MoneyFragment
}
jobTitle
industry
organization
twitterProfileUrl
linkedInProfileUrl
biography
accountManager {
...AdminUserFragment
}
tagsV2 {
...InvestorProfileTagFragment
}
connections {
...ConnectionFragment
}
outstandingTasks {
...TaskFragment
}
outstandingNotifications {
...AccountNotificationFragment
}
identityVerificationStatus
allHoldingsCSVUrl
identityVerificationLastSent
}
}
Variables
{"form": CreateIndividualInvestingEntityInput}
Response
{
"data": {
"createIndividualInvestingEntity": {
"id": "4",
"created": "2007-12-03T10:15:30Z",
"updated": "2007-12-03T10:15:30Z",
"lastLoggedIn": "2007-12-03T10:15:30Z",
"email": "abc123",
"hasPasswordSet": true,
"activationEmailLastSent": "2007-12-03T10:15:30Z",
"legalName": LegalName,
"preferredName": "abc123",
"timeZone": "abc123",
"dateOfBirth": DayMonthYear,
"termsAgreed": true,
"isAccountLocked": true,
"accountLockedReason": "xyz789",
"addresses": [VerifiableAddress],
"phoneNumber": PhoneNumber,
"emailConfirmed": true,
"status": "PENDING",
"setupStatus": AccountSetupStatus,
"investingEntities": [InvestingEntity],
"identityVerifications": [IdentityVerification],
"pepSearchResult": PEPSearchResult,
"notes": [Note],
"searchActivityFeed": ActivityFeedResults,
"totalPortfolioValue": Money,
"jobTitle": "abc123",
"industry": "xyz789",
"organization": "xyz789",
"twitterProfileUrl": "http://www.test.com/",
"linkedInProfileUrl": "http://www.test.com/",
"biography": "xyz789",
"accountManager": AdminUser,
"tagsV2": [InvestorProfileTag],
"connections": [Connection],
"outstandingTasks": [Task],
"outstandingNotifications": [AccountNotification],
"identityVerificationStatus": "INCOMPLETE",
"allHoldingsCSVUrl": "abc123",
"identityVerificationLastSent": "2007-12-03T10:15:30Z"
}
}
}
createJointIndividualInvestingEntity
Description
Create a new joint individual investing entity
Response
Returns an Account!
Arguments
| Name | Description |
|---|---|
form - CreateJointIndividualInvestingEntityInput!
|
Example
Query
mutation createJointIndividualInvestingEntity($form: CreateJointIndividualInvestingEntityInput!) {
createJointIndividualInvestingEntity(form: $form) {
id
created
updated
lastLoggedIn
email
hasPasswordSet
activationEmailLastSent
legalName {
...LegalNameFragment
}
preferredName
timeZone
dateOfBirth {
...DayMonthYearFragment
}
termsAgreed
isAccountLocked
accountLockedReason
addresses {
...VerifiableAddressFragment
}
phoneNumber {
...PhoneNumberFragment
}
emailConfirmed
status
setupStatus {
...AccountSetupStatusFragment
}
investingEntities {
...InvestingEntityFragment
}
identityVerifications {
...IdentityVerificationFragment
}
pepSearchResult {
...PEPSearchResultFragment
}
notes {
...NoteFragment
}
searchActivityFeed {
...ActivityFeedResultsFragment
}
totalPortfolioValue {
...MoneyFragment
}
jobTitle
industry
organization
twitterProfileUrl
linkedInProfileUrl
biography
accountManager {
...AdminUserFragment
}
tagsV2 {
...InvestorProfileTagFragment
}
connections {
...ConnectionFragment
}
outstandingTasks {
...TaskFragment
}
outstandingNotifications {
...AccountNotificationFragment
}
identityVerificationStatus
allHoldingsCSVUrl
identityVerificationLastSent
}
}
Variables
{"form": CreateJointIndividualInvestingEntityInput}
Response
{
"data": {
"createJointIndividualInvestingEntity": {
"id": "4",
"created": "2007-12-03T10:15:30Z",
"updated": "2007-12-03T10:15:30Z",
"lastLoggedIn": "2007-12-03T10:15:30Z",
"email": "xyz789",
"hasPasswordSet": true,
"activationEmailLastSent": "2007-12-03T10:15:30Z",
"legalName": LegalName,
"preferredName": "abc123",
"timeZone": "xyz789",
"dateOfBirth": DayMonthYear,
"termsAgreed": true,
"isAccountLocked": true,
"accountLockedReason": "xyz789",
"addresses": [VerifiableAddress],
"phoneNumber": PhoneNumber,
"emailConfirmed": true,
"status": "PENDING",
"setupStatus": AccountSetupStatus,
"investingEntities": [InvestingEntity],
"identityVerifications": [IdentityVerification],
"pepSearchResult": PEPSearchResult,
"notes": [Note],
"searchActivityFeed": ActivityFeedResults,
"totalPortfolioValue": Money,
"jobTitle": "xyz789",
"industry": "xyz789",
"organization": "abc123",
"twitterProfileUrl": "http://www.test.com/",
"linkedInProfileUrl": "http://www.test.com/",
"biography": "abc123",
"accountManager": AdminUser,
"tagsV2": [InvestorProfileTag],
"connections": [Connection],
"outstandingTasks": [Task],
"outstandingNotifications": [AccountNotification],
"identityVerificationStatus": "INCOMPLETE",
"allHoldingsCSVUrl": "abc123",
"identityVerificationLastSent": "2007-12-03T10:15:30Z"
}
}
}
createManualTask
Description
Create a new 'manual' task
Response
Returns a ManualTask!
Arguments
| Name | Description |
|---|---|
form - CreateManualTaskInput!
|
Example
Query
mutation createManualTask($form: CreateManualTaskInput!) {
createManualTask(form: $form) {
id
created
updated
status
dueAt
assignedAdmin {
...AdminUserFragment
}
notes {
...NoteFragment
}
title
associatedRecord {
... on Account {
...AccountFragment
}
... on Prospect {
...ProspectFragment
}
... on InvestingEntity {
...InvestingEntityFragment
}
... on Fund {
...FundFragment
}
}
documents {
...TaskDocumentFragment
}
priority
relatedTasks {
...TaskFragment
}
assignedTeam
}
}
Variables
{"form": CreateManualTaskInput}
Response
{
"data": {
"createManualTask": {
"id": 4,
"created": "2007-12-03T10:15:30Z",
"updated": "2007-12-03T10:15:30Z",
"status": "OPEN",
"dueAt": "2007-12-03T10:15:30Z",
"assignedAdmin": AdminUser,
"notes": [Note],
"title": "xyz789",
"associatedRecord": Account,
"documents": [TaskDocument],
"priority": "NO_PRIORITY",
"relatedTasks": [Task],
"assignedTeam": "UNASSIGNED"
}
}
}
createOffer
Description
Create an offer
Response
Returns an Offer!
Arguments
| Name | Description |
|---|---|
form - CreateOfferInput!
|
Example
Query
mutation createOffer($form: CreateOfferInput!) {
createOffer(form: $form) {
capitalCallBatches {
...CapitalCallBatchConnectionFragment
}
capitalCallBatch {
...CapitalCallBatchFragment
}
id
displayName
createdAt
updatedAt
pricePerUnit {
...MoneyFragment
}
pricePerUnitV2 {
...HighPrecisionMoneyFragment
}
totalUnitCountDecimal {
...FixedPointNumberFragment
}
minimumUnitCountDecimal {
...FixedPointNumberFragment
}
maximumUnitCountDecimal {
...FixedPointNumberFragment
}
areUnitsIssued
status
openedAt
closedAt
fundsDeadline
settledAt
paymentReferencePrefix
allocations {
...AllocationFragment
}
capitalizationTable {
...CapitalizationTableFragment
}
totalEquity {
...MoneyFragment
}
totalEquityV2 {
...HighPrecisionMoneyFragment
}
registrationsOfInterest {
...RegistrationOfInterestFragment
}
fund {
...FundFragment
}
depositMethods {
...OfferDepositMethodFragment
}
digitalSubscription
slug
dataRoom {
...OfferDataRoomFragment
}
unitClass {
...UnitClassFragment
}
searchAllocations {
...AllocationSearchResultsFragment
}
}
}
Variables
{"form": CreateOfferInput}
Response
{
"data": {
"createOffer": {
"capitalCallBatches": CapitalCallBatchConnection,
"capitalCallBatch": CapitalCallBatch,
"id": "4",
"displayName": "xyz789",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"pricePerUnit": Money,
"pricePerUnitV2": HighPrecisionMoney,
"totalUnitCountDecimal": FixedPointNumber,
"minimumUnitCountDecimal": FixedPointNumber,
"maximumUnitCountDecimal": FixedPointNumber,
"areUnitsIssued": false,
"status": "OPEN",
"openedAt": "2007-12-03T10:15:30Z",
"closedAt": "2007-12-03T10:15:30Z",
"fundsDeadline": "2007-12-03T10:15:30Z",
"settledAt": "2007-12-03T10:15:30Z",
"paymentReferencePrefix": "xyz789",
"allocations": [Allocation],
"capitalizationTable": CapitalizationTable,
"totalEquity": Money,
"totalEquityV2": HighPrecisionMoney,
"registrationsOfInterest": [RegistrationOfInterest],
"fund": Fund,
"depositMethods": [OfferDepositMethod],
"digitalSubscription": "ENABLED",
"slug": "abc123",
"dataRoom": OfferDataRoom,
"unitClass": UnitClass,
"searchAllocations": AllocationSearchResults
}
}
}
createPartnershipInvestingEntity
Description
Create a new partnership investing entity
Response
Returns an Account!
Arguments
| Name | Description |
|---|---|
form - CreatePartnershipInvestingEntityInput!
|
Example
Query
mutation createPartnershipInvestingEntity($form: CreatePartnershipInvestingEntityInput!) {
createPartnershipInvestingEntity(form: $form) {
id
created
updated
lastLoggedIn
email
hasPasswordSet
activationEmailLastSent
legalName {
...LegalNameFragment
}
preferredName
timeZone
dateOfBirth {
...DayMonthYearFragment
}
termsAgreed
isAccountLocked
accountLockedReason
addresses {
...VerifiableAddressFragment
}
phoneNumber {
...PhoneNumberFragment
}
emailConfirmed
status
setupStatus {
...AccountSetupStatusFragment
}
investingEntities {
...InvestingEntityFragment
}
identityVerifications {
...IdentityVerificationFragment
}
pepSearchResult {
...PEPSearchResultFragment
}
notes {
...NoteFragment
}
searchActivityFeed {
...ActivityFeedResultsFragment
}
totalPortfolioValue {
...MoneyFragment
}
jobTitle
industry
organization
twitterProfileUrl
linkedInProfileUrl
biography
accountManager {
...AdminUserFragment
}
tagsV2 {
...InvestorProfileTagFragment
}
connections {
...ConnectionFragment
}
outstandingTasks {
...TaskFragment
}
outstandingNotifications {
...AccountNotificationFragment
}
identityVerificationStatus
allHoldingsCSVUrl
identityVerificationLastSent
}
}
Variables
{"form": CreatePartnershipInvestingEntityInput}
Response
{
"data": {
"createPartnershipInvestingEntity": {
"id": "4",
"created": "2007-12-03T10:15:30Z",
"updated": "2007-12-03T10:15:30Z",
"lastLoggedIn": "2007-12-03T10:15:30Z",
"email": "xyz789",
"hasPasswordSet": false,
"activationEmailLastSent": "2007-12-03T10:15:30Z",
"legalName": LegalName,
"preferredName": "abc123",
"timeZone": "abc123",
"dateOfBirth": DayMonthYear,
"termsAgreed": true,
"isAccountLocked": true,
"accountLockedReason": "abc123",
"addresses": [VerifiableAddress],
"phoneNumber": PhoneNumber,
"emailConfirmed": true,
"status": "PENDING",
"setupStatus": AccountSetupStatus,
"investingEntities": [InvestingEntity],
"identityVerifications": [IdentityVerification],
"pepSearchResult": PEPSearchResult,
"notes": [Note],
"searchActivityFeed": ActivityFeedResults,
"totalPortfolioValue": Money,
"jobTitle": "abc123",
"industry": "xyz789",
"organization": "abc123",
"twitterProfileUrl": "http://www.test.com/",
"linkedInProfileUrl": "http://www.test.com/",
"biography": "abc123",
"accountManager": AdminUser,
"tagsV2": [InvestorProfileTag],
"connections": [Connection],
"outstandingTasks": [Task],
"outstandingNotifications": [AccountNotification],
"identityVerificationStatus": "INCOMPLETE",
"allHoldingsCSVUrl": "abc123",
"identityVerificationLastSent": "2007-12-03T10:15:30Z"
}
}
}
createProspect
Description
Create a prospect
Response
Returns a Prospect!
Arguments
| Name | Description |
|---|---|
form - CreateProspectInput!
|
Example
Query
mutation createProspect($form: CreateProspectInput!) {
createProspect(form: $form) {
id
created
email
firstName
middleName
lastName
preferredName
dateOfBirth {
...DayMonthYearFragment
}
address {
...AddressFragment
}
phoneNumber {
...PhoneNumberFragment
}
jobTitle
industry
organization
twitterProfileUrl
linkedInProfileUrl
biography
searchActivityFeed {
...ActivityFeedResultsFragment
}
tagsV2 {
...InvestorProfileTagFragment
}
connections {
...ConnectionFragment
}
outstandingTasks {
...TaskFragment
}
}
}
Variables
{"form": CreateProspectInput}
Response
{
"data": {
"createProspect": {
"id": "4",
"created": "2007-12-03T10:15:30Z",
"email": "xyz789",
"firstName": "abc123",
"middleName": "abc123",
"lastName": "abc123",
"preferredName": "abc123",
"dateOfBirth": DayMonthYear,
"address": Address,
"phoneNumber": PhoneNumber,
"jobTitle": "xyz789",
"industry": "abc123",
"organization": "abc123",
"twitterProfileUrl": "http://www.test.com/",
"linkedInProfileUrl": "http://www.test.com/",
"biography": "abc123",
"searchActivityFeed": ActivityFeedResults,
"tagsV2": [InvestorProfileTag],
"connections": [Connection],
"outstandingTasks": [Task]
}
}
}
createRegistrationOfInterest
Registration of Interest will be merged into Allocation
Description
Creates a registration of interest against the offer
Response
Returns a RegistrationOfInterest!
Arguments
| Name | Description |
|---|---|
form - CreateRegistrationOfInterestInput!
|
Example
Query
mutation createRegistrationOfInterest($form: CreateRegistrationOfInterestInput!) {
createRegistrationOfInterest(form: $form) {
id
created
status
interestedParty {
... on Account {
...AccountFragment
}
... on Prospect {
...ProspectFragment
}
}
offer {
...OfferFragment
}
unitCount
unitPrice {
...MoneyFragment
}
ownershipPercentage
amount {
...MoneyFragment
}
note
}
}
Variables
{"form": CreateRegistrationOfInterestInput}
Response
{
"data": {
"createRegistrationOfInterest": {
"id": "4",
"created": "2007-12-03T10:15:30Z",
"status": "INTERESTED",
"interestedParty": Account,
"offer": Offer,
"unitCount": 987,
"unitPrice": Money,
"ownershipPercentage": "xyz789",
"amount": Money,
"note": "abc123"
}
}
}
createSellOrder
Response
Returns a Fund!
Arguments
| Name | Description |
|---|---|
form - CreateSellOrderInput!
|
Example
Query
mutation createSellOrder($form: CreateSellOrderInput!) {
createSellOrder(form: $form) {
id
createdAt
updatedAt
name
legalName
shortDescription
summary {
...FundSummaryFragment
}
registrationNumber
legalStructure
assetStructure
inception
currency {
...CurrencyFragment
}
country {
...CountryFragment
}
cardImage {
...RemoteAssetFragment
}
totalUnitCountDecimal {
...FixedPointNumberFragment
}
calculatedNetAssetValue {
...MoneyFragment
}
targetCashReturn {
...FractionFragment
}
targetTotalReturn {
...FractionFragment
}
documents {
...FundDocumentFragment
}
assets {
...AssetFragment
}
asset {
...AssetFragment
}
offers {
...OfferFragment
}
distributions {
...DistributionFragment
}
searchDistributions {
...DistributionSearchResultsFragment
}
distribution {
...DistributionFragment
}
distributionV2 {
...DistributionV2Fragment
}
validateDistribution {
... on InvalidBankAccountDistributionAlert {
...InvalidBankAccountDistributionAlertFragment
}
}
secondaryMarket {
...SecondaryMarketFragment
}
sellOrder {
...SellOrderFragment
}
sellOrders {
...SellOrderFragment
}
buyOrder {
...BuyOrderFragment
}
buyOrders {
...BuyOrderFragment
}
offerStatus
investorType
largestOwnershipPercentageV2
numberOfActiveHoldings
fundManagerName
lastDistributionDate
equityRaised {
...MoneyFragment
}
hideDistributionMetrics
searchUnitRedemptionRequests {
...UnitRedemptionRequestSearchResultsFragment
}
unitRedemptionRequest {
...UnitRedemptionRequestFragment
}
unitRedemptionConfiguration {
...FundUnitRedemptionConfigurationFragment
}
unitPrecisionScale
searchUnitClasses {
...UnitClassSearchResultsFragment
}
showHoldingPageOnInvestorPortal
customMetrics {
...CustomMetricFragment
}
investorPortalConfiguration {
...FundInvestorPortalConfigurationFragment
}
unitTransferRequest {
...UnitTransferRequestFragment
}
depositBankAccount {
...BankAccountFragment
}
searchOutgoingBankAccounts {
...FundOutgoingBankAccountSearchResultsFragment
}
}
}
Variables
{"form": CreateSellOrderInput}
Response
{
"data": {
"createSellOrder": {
"id": "4",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"name": "xyz789",
"legalName": "xyz789",
"shortDescription": "abc123",
"summary": FundSummary,
"registrationNumber": "abc123",
"legalStructure": "LIMITED_PARTNERSHIP",
"assetStructure": "SINGLE_ASSET",
"inception": "2007-12-03T10:15:30Z",
"currency": Currency,
"country": Country,
"cardImage": RemoteAsset,
"totalUnitCountDecimal": FixedPointNumber,
"calculatedNetAssetValue": Money,
"targetCashReturn": Fraction,
"targetTotalReturn": Fraction,
"documents": [FundDocument],
"assets": [Asset],
"asset": Asset,
"offers": [Offer],
"distributions": [Distribution],
"searchDistributions": DistributionSearchResults,
"distribution": Distribution,
"distributionV2": DistributionV2,
"validateDistribution": [
InvalidBankAccountDistributionAlert
],
"secondaryMarket": SecondaryMarket,
"sellOrder": SellOrder,
"sellOrders": [SellOrder],
"buyOrder": BuyOrder,
"buyOrders": [BuyOrder],
"offerStatus": "OPEN",
"investorType": "WHOLESALE",
"largestOwnershipPercentageV2": 123.45,
"numberOfActiveHoldings": 123,
"fundManagerName": "abc123",
"lastDistributionDate": "2007-12-03T10:15:30Z",
"equityRaised": Money,
"hideDistributionMetrics": true,
"searchUnitRedemptionRequests": UnitRedemptionRequestSearchResults,
"unitRedemptionRequest": UnitRedemptionRequest,
"unitRedemptionConfiguration": FundUnitRedemptionConfiguration,
"unitPrecisionScale": 123,
"searchUnitClasses": UnitClassSearchResults,
"showHoldingPageOnInvestorPortal": true,
"customMetrics": [CustomMetric],
"investorPortalConfiguration": FundInvestorPortalConfiguration,
"unitTransferRequest": UnitTransferRequest,
"depositBankAccount": BankAccount,
"searchOutgoingBankAccounts": FundOutgoingBankAccountSearchResults
}
}
}
createStatementBatch
Description
Create a new statement batch
Response
Returns a StatementBatch!
Arguments
| Name | Description |
|---|---|
input - CreateStatementBatchInput!
|
Example
Query
mutation createStatementBatch($input: CreateStatementBatchInput!) {
createStatementBatch(input: $input) {
id
name
createdAt
status
noData
configuration {
... on InvestorStatementConfig {
...InvestorStatementConfigFragment
}
... on TaxStatementConfig {
...TaxStatementConfigFragment
}
... on HoldingStatementConfig {
...HoldingStatementConfigFragment
}
... on PeriodicStatementConfig {
...PeriodicStatementConfigFragment
}
}
generation {
...StatementGenerationFragment
}
enrichment {
...StatementEnrichmentFragment
}
confirmation {
...StatementConfirmationFragment
}
publication {
...StatementPublicationFragment
}
numberOfStatements
statements {
...StatementConnectionFragment
}
}
}
Variables
{"input": CreateStatementBatchInput}
Response
{
"data": {
"createStatementBatch": {
"id": "4",
"name": "abc123",
"createdAt": "2007-12-03T10:15:30Z",
"status": "GENERATING",
"noData": true,
"configuration": InvestorStatementConfig,
"generation": StatementGeneration,
"enrichment": StatementEnrichment,
"confirmation": StatementConfirmation,
"publication": StatementPublication,
"numberOfStatements": 987,
"statements": StatementConnection
}
}
}
createTag
Description
Create a new tag The tag will be associated with the specified type.
Response
Returns a TagV2!
Arguments
| Name | Description |
|---|---|
form - CreateTagInput!
|
Example
Query
mutation createTag($form: CreateTagInput!) {
createTag(form: $form) {
... on InvestingEntityTag {
...InvestingEntityTagFragment
}
... on InvestorProfileTag {
...InvestorProfileTagFragment
}
}
}
Variables
{"form": CreateTagInput}
Response
{"data": {"createTag": InvestingEntityTag}}
createTotalDollarUnitClassFee
Description
Create a total dollar fee on a unit class
Response
Returns a UnitClassFee!
Arguments
| Name | Description |
|---|---|
form - CreateTotalDollarUnitClassFeeInput!
|
Example
Query
mutation createTotalDollarUnitClassFee($form: CreateTotalDollarUnitClassFeeInput!) {
createTotalDollarUnitClassFee(form: $form) {
id
unitClass {
...UnitClassFragment
}
config {
... on AnnualPercentageFee {
...AnnualPercentageFeeFragment
}
... on TotalDollarFee {
...TotalDollarFeeFragment
}
}
note
createdBy {
...AdminUserFragment
}
createdAt
}
}
Variables
{"form": CreateTotalDollarUnitClassFeeInput}
Response
{
"data": {
"createTotalDollarUnitClassFee": {
"id": 4,
"unitClass": UnitClass,
"config": AnnualPercentageFee,
"note": "xyz789",
"createdBy": AdminUser,
"createdAt": "2007-12-03T10:15:30Z"
}
}
}
createTrustInvestingEntity
Description
Create a new trust investing entity
Response
Returns an Account!
Arguments
| Name | Description |
|---|---|
form - CreateTrustInvestingEntityInput!
|
Example
Query
mutation createTrustInvestingEntity($form: CreateTrustInvestingEntityInput!) {
createTrustInvestingEntity(form: $form) {
id
created
updated
lastLoggedIn
email
hasPasswordSet
activationEmailLastSent
legalName {
...LegalNameFragment
}
preferredName
timeZone
dateOfBirth {
...DayMonthYearFragment
}
termsAgreed
isAccountLocked
accountLockedReason
addresses {
...VerifiableAddressFragment
}
phoneNumber {
...PhoneNumberFragment
}
emailConfirmed
status
setupStatus {
...AccountSetupStatusFragment
}
investingEntities {
...InvestingEntityFragment
}
identityVerifications {
...IdentityVerificationFragment
}
pepSearchResult {
...PEPSearchResultFragment
}
notes {
...NoteFragment
}
searchActivityFeed {
...ActivityFeedResultsFragment
}
totalPortfolioValue {
...MoneyFragment
}
jobTitle
industry
organization
twitterProfileUrl
linkedInProfileUrl
biography
accountManager {
...AdminUserFragment
}
tagsV2 {
...InvestorProfileTagFragment
}
connections {
...ConnectionFragment
}
outstandingTasks {
...TaskFragment
}
outstandingNotifications {
...AccountNotificationFragment
}
identityVerificationStatus
allHoldingsCSVUrl
identityVerificationLastSent
}
}
Variables
{"form": CreateTrustInvestingEntityInput}
Response
{
"data": {
"createTrustInvestingEntity": {
"id": 4,
"created": "2007-12-03T10:15:30Z",
"updated": "2007-12-03T10:15:30Z",
"lastLoggedIn": "2007-12-03T10:15:30Z",
"email": "abc123",
"hasPasswordSet": true,
"activationEmailLastSent": "2007-12-03T10:15:30Z",
"legalName": LegalName,
"preferredName": "xyz789",
"timeZone": "abc123",
"dateOfBirth": DayMonthYear,
"termsAgreed": false,
"isAccountLocked": true,
"accountLockedReason": "xyz789",
"addresses": [VerifiableAddress],
"phoneNumber": PhoneNumber,
"emailConfirmed": true,
"status": "PENDING",
"setupStatus": AccountSetupStatus,
"investingEntities": [InvestingEntity],
"identityVerifications": [IdentityVerification],
"pepSearchResult": PEPSearchResult,
"notes": [Note],
"searchActivityFeed": ActivityFeedResults,
"totalPortfolioValue": Money,
"jobTitle": "abc123",
"industry": "abc123",
"organization": "xyz789",
"twitterProfileUrl": "http://www.test.com/",
"linkedInProfileUrl": "http://www.test.com/",
"biography": "xyz789",
"accountManager": AdminUser,
"tagsV2": [InvestorProfileTag],
"connections": [Connection],
"outstandingTasks": [Task],
"outstandingNotifications": [AccountNotification],
"identityVerificationStatus": "INCOMPLETE",
"allHoldingsCSVUrl": "abc123",
"identityVerificationLastSent": "2007-12-03T10:15:30Z"
}
}
}
createUnitClass
Description
Create a new Fund unit Class
Response
Returns a UnitClass!
Arguments
| Name | Description |
|---|---|
form - CreateUnitClassInput!
|
Example
Query
mutation createUnitClass($form: CreateUnitClassInput!) {
createUnitClass(form: $form) {
id
name
code
note
createdAt
unitCount {
...FixedPointNumberFragment
}
holdingCount
unitPrice {
...HighPrecisionMoneyFragment
}
netAssetValue {
...HighPrecisionMoneyFragment
}
outgoingBankAccount {
...FundOutgoingBankAccountFragment
}
managementFees {
...UnitClassFeeFragment
}
unitPrices {
...UnitPriceFragment
}
distributionRates {
...UnitClassDistributionRateFragment
}
}
}
Variables
{"form": CreateUnitClassInput}
Response
{
"data": {
"createUnitClass": {
"id": "4",
"name": "xyz789",
"code": "abc123",
"note": "xyz789",
"createdAt": "2007-12-03T10:15:30Z",
"unitCount": FixedPointNumber,
"holdingCount": 987,
"unitPrice": HighPrecisionMoney,
"netAssetValue": HighPrecisionMoney,
"outgoingBankAccount": FundOutgoingBankAccount,
"managementFees": [UnitClassFee],
"unitPrices": [UnitPrice],
"distributionRates": [UnitClassDistributionRate]
}
}
}
createUnitClassDistributionRate
Description
Create a new distribution rate for a unit class
Response
Returns a UnitClassDistributionRate!
Arguments
| Name | Description |
|---|---|
form - CreateUnitClassDistributionRateInput!
|
Example
Query
mutation createUnitClassDistributionRate($form: CreateUnitClassDistributionRateInput!) {
createUnitClassDistributionRate(form: $form) {
id
createdAt
effectiveFrom
rate {
... on UnitClassAnnualPercentageDistributionRate {
...UnitClassAnnualPercentageDistributionRateFragment
}
... on UnitClassTotalDollarAmountDistributionRate {
...UnitClassTotalDollarAmountDistributionRateFragment
}
... on UnitClassDailyCentsPerUnitDistributionRate {
...UnitClassDailyCentsPerUnitDistributionRateFragment
}
}
note
}
}
Variables
{"form": CreateUnitClassDistributionRateInput}
Response
{
"data": {
"createUnitClassDistributionRate": {
"id": 4,
"createdAt": "2007-12-03T10:15:30Z",
"effectiveFrom": "2007-12-03T10:15:30Z",
"rate": UnitClassAnnualPercentageDistributionRate,
"note": "abc123"
}
}
}
createUnitPrice
Description
Create a class unit value update
Response
Returns a UnitPrice!
Arguments
| Name | Description |
|---|---|
form - CreateUnitPriceInput!
|
Example
Query
mutation createUnitPrice($form: CreateUnitPriceInput!) {
createUnitPrice(form: $form) {
id
unitClass {
...UnitClassFragment
}
priceV2 {
...HighPrecisionMoneyFragment
}
effectiveDate
note
createdBy {
...AdminUserFragment
}
createdAt
}
}
Variables
{"form": CreateUnitPriceInput}
Response
{
"data": {
"createUnitPrice": {
"id": 4,
"unitClass": UnitClass,
"priceV2": HighPrecisionMoney,
"effectiveDate": "2007-12-03T10:15:30Z",
"note": "xyz789",
"createdBy": AdminUser,
"createdAt": "2007-12-03T10:15:30Z"
}
}
}
createUnitRedemptionRequest
Description
Create a new unit redemption request for a holding
Response
Returns a UnitRedemptionRequest!
Arguments
| Name | Description |
|---|---|
form - CreateUnitRedemptionRequestInput!
|
Example
Query
mutation createUnitRedemptionRequest($form: CreateUnitRedemptionRequestInput!) {
createUnitRedemptionRequest(form: $form) {
id
status
holding {
...HoldingFragment
}
unitCountDecimal {
...FixedPointNumberFragment
}
unitPrice {
...MoneyFragment
}
unitPriceV2 {
...HighPrecisionMoneyFragment
}
orderValue {
...MoneyFragment
}
dateReceived
dateOfRedemption
note {
...NoteFragment
}
tags
}
}
Variables
{"form": CreateUnitRedemptionRequestInput}
Response
{
"data": {
"createUnitRedemptionRequest": {
"id": 4,
"status": "REQUESTED",
"holding": Holding,
"unitCountDecimal": FixedPointNumber,
"unitPrice": Money,
"unitPriceV2": HighPrecisionMoney,
"orderValue": Money,
"dateReceived": "2007-12-03T10:15:30Z",
"dateOfRedemption": "2007-12-03T10:15:30Z",
"note": Note,
"tags": ["RELATED_PARTY_NCBO"]
}
}
}
createUnitTransferRequest
Description
Create a new unit transfer request
Response
Returns a UnitTransferRequest!
Arguments
| Name | Description |
|---|---|
form - CreateUnitTransferRequestInput!
|
Example
Query
mutation createUnitTransferRequest($form: CreateUnitTransferRequestInput!) {
createUnitTransferRequest(form: $form) {
id
status
fromHolding {
...HoldingFragment
}
toInvestingEntity {
...InvestingEntityFragment
}
unitCount {
...FixedPointNumberFragment
}
unitPrice {
...MoneyFragment
}
totalValue {
...MoneyFragment
}
dateReceived
dateOfTransfer
note {
...NoteFragment
}
tags
}
}
Variables
{"form": CreateUnitTransferRequestInput}
Response
{
"data": {
"createUnitTransferRequest": {
"id": "4",
"status": "REQUESTED",
"fromHolding": Holding,
"toInvestingEntity": InvestingEntity,
"unitCount": FixedPointNumber,
"unitPrice": Money,
"totalValue": Money,
"dateReceived": "2007-12-03T10:15:30Z",
"dateOfTransfer": "2007-12-03T10:15:30Z",
"note": Note,
"tags": ["RELATED_PARTY_NCBO"]
}
}
}
declineAccreditationCertificate
Description
Decline an accreditation certificate, marking it as declined with an optional reason
Response
Returns an InvestingEntityStandardisedAccreditation!
Arguments
| Name | Description |
|---|---|
form - DeclineAccreditationCertificateInput!
|
Example
Query
mutation declineAccreditationCertificate($form: DeclineAccreditationCertificateInput!) {
declineAccreditationCertificate(form: $form) {
id
updated
type
approvalStatus
country {
...CountryFragment
}
files {
...RemoteAssetFragment
}
signedAt
declinedReason
}
}
Variables
{"form": DeclineAccreditationCertificateInput}
Response
{
"data": {
"declineAccreditationCertificate": {
"id": "4",
"updated": "2007-12-03T10:15:30Z",
"type": "SAFE_HARBOUR",
"approvalStatus": "PENDING",
"country": Country,
"files": [RemoteAsset],
"signedAt": "2007-12-03T10:15:30Z",
"declinedReason": "xyz789"
}
}
}
declineBankAccount
Description
Decline a bank account that is pending verification
Response
Returns a VerifiableBankAccount!
Arguments
| Name | Description |
|---|---|
form - DeclineBankAccountInput!
|
Example
Query
mutation declineBankAccount($form: DeclineBankAccountInput!) {
declineBankAccount(form: $form) {
id
created
updated
name
nickname
currency {
...CurrencyFragment
}
isDefaultAccount
status
documents {
...VerifiableDocumentFragment
}
investingEntity {
...InvestingEntityFragment
}
}
}
Variables
{"form": DeclineBankAccountInput}
Response
{
"data": {
"declineBankAccount": {
"id": "4",
"created": "2007-12-03T10:15:30Z",
"updated": "2007-12-03T10:15:30Z",
"name": "xyz789",
"nickname": "xyz789",
"currency": Currency,
"isDefaultAccount": false,
"status": "PENDING",
"documents": [VerifiableDocument],
"investingEntity": InvestingEntity
}
}
}
declineInvestingEntityGoverningDocument
Description
Decline an investing entity governing document with an optional reason
Response
Returns an InvestingEntityGoverningDocument!
Arguments
| Name | Description |
|---|---|
form - DeclineInvestingEntityGoverningDocumentInput!
|
Example
Query
mutation declineInvestingEntityGoverningDocument($form: DeclineInvestingEntityGoverningDocumentInput!) {
declineInvestingEntityGoverningDocument(form: $form) {
id
name
updatedAt
file {
...RemoteAssetFragment
}
status
declinedReason
}
}
Variables
{"form": DeclineInvestingEntityGoverningDocumentInput}
Response
{
"data": {
"declineInvestingEntityGoverningDocument": {
"id": 4,
"name": "xyz789",
"updatedAt": "2007-12-03T10:15:30Z",
"file": RemoteAsset,
"status": "PENDING",
"declinedReason": "xyz789"
}
}
}
declinePEPMatch
Description
Decline a PEP Match
Response
Returns a PEPMatch!
Arguments
| Name | Description |
|---|---|
form - DeclinePEPMatchInput!
|
Example
Query
mutation declinePEPMatch($form: DeclinePEPMatchInput!) {
declinePEPMatch(form: $form) {
id
name
associates {
...PEPAssociateFragment
}
dateOfBirth
citizenship {
...CountryFragment
}
gender
confidence
images
notes
roles {
...PEPMatchRoleFragment
}
status
transactionId
checkedOn
statusUpdate {
...PEPMatchStatusUpdateFragment
}
}
}
Variables
{"form": DeclinePEPMatchInput}
Response
{
"data": {
"declinePEPMatch": {
"id": "4",
"name": "abc123",
"associates": [PEPAssociate],
"dateOfBirth": "xyz789",
"citizenship": Country,
"gender": "xyz789",
"confidence": 987.65,
"images": ["xyz789"],
"notes": HTML,
"roles": [PEPMatchRole],
"status": "PENDING",
"transactionId": "xyz789",
"checkedOn": "2007-12-03T10:15:30Z",
"statusUpdate": PEPMatchStatusUpdate
}
}
}
deleteAsset
Description
Delete an existing Asset
Response
Returns an Asset!
Arguments
| Name | Description |
|---|---|
form - DeleteAssetInput!
|
Example
Query
mutation deleteAsset($form: DeleteAssetInput!) {
deleteAsset(form: $form) {
id
name
address
country {
...CountryFragment
}
cardImage {
...RemoteAssetFragment
}
fund {
...FundFragment
}
}
}
Variables
{"form": DeleteAssetInput}
Response
{
"data": {
"deleteAsset": {
"id": "4",
"name": "abc123",
"address": "xyz789",
"country": Country,
"cardImage": RemoteAsset,
"fund": Fund
}
}
}
deleteBeneficialOwner
Description
Delete a beneficial owner
Response
Returns an InvestingEntity!
Arguments
| Name | Description |
|---|---|
form - DeleteBeneficialOwnerInput!
|
Example
Query
mutation deleteBeneficialOwner($form: DeleteBeneficialOwnerInput!) {
deleteBeneficialOwner(form: $form) {
id
created
updated
entityType
entity {
... on IndividualInvestingEntity {
...IndividualInvestingEntityFragment
}
... on CompanyInvestingEntity {
...CompanyInvestingEntityFragment
}
... on TrustInvestingEntity {
...TrustInvestingEntityFragment
}
... on JointIndividualInvestingEntity {
...JointIndividualInvestingEntityFragment
}
... on PartnershipInvestingEntity {
...PartnershipInvestingEntityFragment
}
}
sourceOfFundsVerificationEmailLastSent
relationship
country {
...CountryFragment
}
bankAccounts {
...VerifiableBankAccountFragment
}
bankAccount {
...VerifiableBankAccountFragment
}
accreditationsStandardised {
...InvestingEntityStandardisedAccreditationFragment
}
accreditationCountry {
...CountryFragment
}
wholesaleCertificationStatus
primaryOwner {
...AccountFragment
}
accounts {
...AccountFragment
}
beneficialOwners {
...BeneficialOwnerFragment
}
beneficialOwner {
...BeneficialOwnerFragment
}
lastRequestedBeneficialOwnersContactDetails
lastRequestedWholesaleCertification
allocations {
...AllocationFragment
}
riskProfile {
...RiskProfileFragment
}
holdings {
...HoldingFragment
}
totalPortfolioValue {
...MoneyFragment
}
totalHoldingMarkedValue {
...MoneyFragment
}
totalCapitalContributed {
...MoneyFragment
}
searchActivityFeed {
...ActivityFeedResultsFragment
}
governingDocuments {
...InvestingEntityGoverningDocumentFragment
}
searchTransactionsV2 {
...SearchTransactionsResultsFragment
}
outstandingTaskCount
bankAccountVerificationStatus
sourceOfFundsVerificationStatus
outstandingTasks {
...TaskFragment
}
outstandingNotifications {
...InvestingEntityNotificationFragment
}
associatedAccounts {
...AssociatedAccountFragment
}
tags {
...InvestingEntityTagFragment
}
}
}
Variables
{"form": DeleteBeneficialOwnerInput}
Response
{
"data": {
"deleteBeneficialOwner": {
"id": "4",
"created": "2007-12-03T10:15:30Z",
"updated": "2007-12-03T10:15:30Z",
"entityType": "INDIVIDUAL",
"entity": IndividualInvestingEntity,
"sourceOfFundsVerificationEmailLastSent": "2007-12-03T10:15:30Z",
"relationship": "SHAREHOLDING_VOTING_RIGHTS_GREATER_THAN_25_PERCENT",
"country": Country,
"bankAccounts": [VerifiableBankAccount],
"bankAccount": VerifiableBankAccount,
"accreditationsStandardised": [
InvestingEntityStandardisedAccreditation
],
"accreditationCountry": Country,
"wholesaleCertificationStatus": "AWAITING",
"primaryOwner": Account,
"accounts": [Account],
"beneficialOwners": [BeneficialOwner],
"beneficialOwner": BeneficialOwner,
"lastRequestedBeneficialOwnersContactDetails": "2007-12-03T10:15:30Z",
"lastRequestedWholesaleCertification": "2007-12-03T10:15:30Z",
"allocations": [Allocation],
"riskProfile": RiskProfile,
"holdings": [Holding],
"totalPortfolioValue": Money,
"totalHoldingMarkedValue": Money,
"totalCapitalContributed": Money,
"searchActivityFeed": ActivityFeedResults,
"governingDocuments": [
InvestingEntityGoverningDocument
],
"searchTransactionsV2": SearchTransactionsResults,
"outstandingTaskCount": 123,
"bankAccountVerificationStatus": "PENDING",
"sourceOfFundsVerificationStatus": "COMPLETE",
"outstandingTasks": [Task],
"outstandingNotifications": [
InvestingEntityNotification
],
"associatedAccounts": [AssociatedAccount],
"tags": [InvestingEntityTag]
}
}
}
deleteCapitalCallBatch
Description
Delete a capital call batch
deleteConnection
Description
Delete a connection between two connection profiles
Response
Returns a ConnectionProfile!
Arguments
| Name | Description |
|---|---|
form - DeleteConnectionInput!
|
Example
Query
mutation deleteConnection($form: DeleteConnectionInput!) {
deleteConnection(form: $form) {
... on Prospect {
...ProspectFragment
}
... on Account {
...AccountFragment
}
}
}
Variables
{"form": DeleteConnectionInput}
Response
{"data": {"deleteConnection": Prospect}}
deleteDepositMethod
Description
Delete a deposit method
Response
Returns a Void!
Arguments
| Name | Description |
|---|---|
form - DeleteDepositMethodInput!
|
Example
Query
mutation deleteDepositMethod($form: DeleteDepositMethodInput!) {
deleteDepositMethod(form: $form)
}
Variables
{"form": DeleteDepositMethodInput}
Response
{"data": {"deleteDepositMethod": null}}
deleteDistribution
Description
Delete a draft distribution for a fund
Response
Returns a Void!
Arguments
| Name | Description |
|---|---|
form - DeleteDistributionInput!
|
Example
Query
mutation deleteDistribution($form: DeleteDistributionInput!) {
deleteDistribution(form: $form)
}
Variables
{"form": DeleteDistributionInput}
Response
{"data": {"deleteDistribution": null}}
deleteDocument
Description
Delete an existing Document
Response
Returns a Document!
Arguments
| Name | Description |
|---|---|
form - DeleteDocumentInput!
|
Example
Query
mutation deleteDocument($form: DeleteDocumentInput!) {
deleteDocument(form: $form) {
id
updatedAt
file {
...RemoteAssetFragment
}
modifiedBy {
...AdminUserFragment
}
}
}
Variables
{"form": DeleteDocumentInput}
Response
{
"data": {
"deleteDocument": {
"id": 4,
"updatedAt": "2007-12-03T10:15:30Z",
"file": RemoteAsset,
"modifiedBy": AdminUser
}
}
}
deleteEmailBatch
Description
Delete an email batch and all its messages. A confirmed batch cannot be deleted.
Response
Returns an ID!
Arguments
| Name | Description |
|---|---|
form - DeleteEmailBatchInput!
|
Example
Query
mutation deleteEmailBatch($form: DeleteEmailBatchInput!) {
deleteEmailBatch(form: $form)
}
Variables
{"form": DeleteEmailBatchInput}
Response
{"data": {"deleteEmailBatch": "4"}}
deleteEmailTemplate
Description
Delete an existing email template
Response
Returns a Void!
Arguments
| Name | Description |
|---|---|
form - DeleteEmailTemplateInput!
|
Example
Query
mutation deleteEmailTemplate($form: DeleteEmailTemplateInput!) {
deleteEmailTemplate(form: $form)
}
Variables
{"form": DeleteEmailTemplateInput}
Response
{"data": {"deleteEmailTemplate": null}}
deleteFund
Description
Delete an existing Fund - returns one of the following errors on precondition failure: ErrorAssetsExist, ErrorOffersExist, ErrorHoldingsExist, ErrorFundNotFound
Response
Returns a Fund!
Arguments
| Name | Description |
|---|---|
form - DeleteFundInput!
|
Example
Query
mutation deleteFund($form: DeleteFundInput!) {
deleteFund(form: $form) {
id
createdAt
updatedAt
name
legalName
shortDescription
summary {
...FundSummaryFragment
}
registrationNumber
legalStructure
assetStructure
inception
currency {
...CurrencyFragment
}
country {
...CountryFragment
}
cardImage {
...RemoteAssetFragment
}
totalUnitCountDecimal {
...FixedPointNumberFragment
}
calculatedNetAssetValue {
...MoneyFragment
}
targetCashReturn {
...FractionFragment
}
targetTotalReturn {
...FractionFragment
}
documents {
...FundDocumentFragment
}
assets {
...AssetFragment
}
asset {
...AssetFragment
}
offers {
...OfferFragment
}
distributions {
...DistributionFragment
}
searchDistributions {
...DistributionSearchResultsFragment
}
distribution {
...DistributionFragment
}
distributionV2 {
...DistributionV2Fragment
}
validateDistribution {
... on InvalidBankAccountDistributionAlert {
...InvalidBankAccountDistributionAlertFragment
}
}
secondaryMarket {
...SecondaryMarketFragment
}
sellOrder {
...SellOrderFragment
}
sellOrders {
...SellOrderFragment
}
buyOrder {
...BuyOrderFragment
}
buyOrders {
...BuyOrderFragment
}
offerStatus
investorType
largestOwnershipPercentageV2
numberOfActiveHoldings
fundManagerName
lastDistributionDate
equityRaised {
...MoneyFragment
}
hideDistributionMetrics
searchUnitRedemptionRequests {
...UnitRedemptionRequestSearchResultsFragment
}
unitRedemptionRequest {
...UnitRedemptionRequestFragment
}
unitRedemptionConfiguration {
...FundUnitRedemptionConfigurationFragment
}
unitPrecisionScale
searchUnitClasses {
...UnitClassSearchResultsFragment
}
showHoldingPageOnInvestorPortal
customMetrics {
...CustomMetricFragment
}
investorPortalConfiguration {
...FundInvestorPortalConfigurationFragment
}
unitTransferRequest {
...UnitTransferRequestFragment
}
depositBankAccount {
...BankAccountFragment
}
searchOutgoingBankAccounts {
...FundOutgoingBankAccountSearchResultsFragment
}
}
}
Variables
{"form": DeleteFundInput}
Response
{
"data": {
"deleteFund": {
"id": "4",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"name": "abc123",
"legalName": "xyz789",
"shortDescription": "abc123",
"summary": FundSummary,
"registrationNumber": "xyz789",
"legalStructure": "LIMITED_PARTNERSHIP",
"assetStructure": "SINGLE_ASSET",
"inception": "2007-12-03T10:15:30Z",
"currency": Currency,
"country": Country,
"cardImage": RemoteAsset,
"totalUnitCountDecimal": FixedPointNumber,
"calculatedNetAssetValue": Money,
"targetCashReturn": Fraction,
"targetTotalReturn": Fraction,
"documents": [FundDocument],
"assets": [Asset],
"asset": Asset,
"offers": [Offer],
"distributions": [Distribution],
"searchDistributions": DistributionSearchResults,
"distribution": Distribution,
"distributionV2": DistributionV2,
"validateDistribution": [
InvalidBankAccountDistributionAlert
],
"secondaryMarket": SecondaryMarket,
"sellOrder": SellOrder,
"sellOrders": [SellOrder],
"buyOrder": BuyOrder,
"buyOrders": [BuyOrder],
"offerStatus": "OPEN",
"investorType": "WHOLESALE",
"largestOwnershipPercentageV2": 123.45,
"numberOfActiveHoldings": 123,
"fundManagerName": "xyz789",
"lastDistributionDate": "2007-12-03T10:15:30Z",
"equityRaised": Money,
"hideDistributionMetrics": true,
"searchUnitRedemptionRequests": UnitRedemptionRequestSearchResults,
"unitRedemptionRequest": UnitRedemptionRequest,
"unitRedemptionConfiguration": FundUnitRedemptionConfiguration,
"unitPrecisionScale": 987,
"searchUnitClasses": UnitClassSearchResults,
"showHoldingPageOnInvestorPortal": false,
"customMetrics": [CustomMetric],
"investorPortalConfiguration": FundInvestorPortalConfiguration,
"unitTransferRequest": UnitTransferRequest,
"depositBankAccount": BankAccount,
"searchOutgoingBankAccounts": FundOutgoingBankAccountSearchResults
}
}
}
deleteFundOutgoingBankAccount
Description
Will delete a fund bank account. Will error if the bank account is the default or assigned to a unit class.
Response
Returns a Void
Arguments
| Name | Description |
|---|---|
input - DeleteFundOutgoingBankAccountInput!
|
Example
Query
mutation deleteFundOutgoingBankAccount($input: DeleteFundOutgoingBankAccountInput!) {
deleteFundOutgoingBankAccount(input: $input)
}
Variables
{"input": DeleteFundOutgoingBankAccountInput}
Response
{"data": {"deleteFundOutgoingBankAccount": null}}
deleteImportBatch
Description
Delete an import batch
Response
Returns a Void!
Arguments
| Name | Description |
|---|---|
form - DeleteImportBatchInput!
|
Example
Query
mutation deleteImportBatch($form: DeleteImportBatchInput!) {
deleteImportBatch(form: $form)
}
Variables
{"form": DeleteImportBatchInput}
Response
{"data": {"deleteImportBatch": null}}
deleteManualTask
Description
Delete a 'manual' task
Response
Returns a ManualTask!
Arguments
| Name | Description |
|---|---|
form - DeleteManualTaskInput!
|
Example
Query
mutation deleteManualTask($form: DeleteManualTaskInput!) {
deleteManualTask(form: $form) {
id
created
updated
status
dueAt
assignedAdmin {
...AdminUserFragment
}
notes {
...NoteFragment
}
title
associatedRecord {
... on Account {
...AccountFragment
}
... on Prospect {
...ProspectFragment
}
... on InvestingEntity {
...InvestingEntityFragment
}
... on Fund {
...FundFragment
}
}
documents {
...TaskDocumentFragment
}
priority
relatedTasks {
...TaskFragment
}
assignedTeam
}
}
Variables
{"form": DeleteManualTaskInput}
Response
{
"data": {
"deleteManualTask": {
"id": "4",
"created": "2007-12-03T10:15:30Z",
"updated": "2007-12-03T10:15:30Z",
"status": "OPEN",
"dueAt": "2007-12-03T10:15:30Z",
"assignedAdmin": AdminUser,
"notes": [Note],
"title": "xyz789",
"associatedRecord": Account,
"documents": [TaskDocument],
"priority": "NO_PRIORITY",
"relatedTasks": [Task],
"assignedTeam": "UNASSIGNED"
}
}
}
deleteNote
Description
Delete an existing Note
Response
Returns a Note!
Arguments
| Name | Description |
|---|---|
form - DeleteNoteInput!
|
Example
Query
mutation deleteNote($form: DeleteNoteInput!) {
deleteNote(form: $form) {
id
created
message
lastModifiedDetails {
...NoteLastModifiedDetailsFragment
}
isPinned
}
}
Variables
{"form": DeleteNoteInput}
Response
{
"data": {
"deleteNote": {
"id": "4",
"created": "2007-12-03T10:15:30Z",
"message": "abc123",
"lastModifiedDetails": NoteLastModifiedDetails,
"isPinned": false
}
}
}
deleteOffer
Description
Delete an existing offer - returns one of the following errors on precondition failure: ErrorAllocationsExist, ErrorOfferNotFound
Response
Returns an Offer!
Arguments
| Name | Description |
|---|---|
form - DeleteOfferInput!
|
Example
Query
mutation deleteOffer($form: DeleteOfferInput!) {
deleteOffer(form: $form) {
capitalCallBatches {
...CapitalCallBatchConnectionFragment
}
capitalCallBatch {
...CapitalCallBatchFragment
}
id
displayName
createdAt
updatedAt
pricePerUnit {
...MoneyFragment
}
pricePerUnitV2 {
...HighPrecisionMoneyFragment
}
totalUnitCountDecimal {
...FixedPointNumberFragment
}
minimumUnitCountDecimal {
...FixedPointNumberFragment
}
maximumUnitCountDecimal {
...FixedPointNumberFragment
}
areUnitsIssued
status
openedAt
closedAt
fundsDeadline
settledAt
paymentReferencePrefix
allocations {
...AllocationFragment
}
capitalizationTable {
...CapitalizationTableFragment
}
totalEquity {
...MoneyFragment
}
totalEquityV2 {
...HighPrecisionMoneyFragment
}
registrationsOfInterest {
...RegistrationOfInterestFragment
}
fund {
...FundFragment
}
depositMethods {
...OfferDepositMethodFragment
}
digitalSubscription
slug
dataRoom {
...OfferDataRoomFragment
}
unitClass {
...UnitClassFragment
}
searchAllocations {
...AllocationSearchResultsFragment
}
}
}
Variables
{"form": DeleteOfferInput}
Response
{
"data": {
"deleteOffer": {
"capitalCallBatches": CapitalCallBatchConnection,
"capitalCallBatch": CapitalCallBatch,
"id": "4",
"displayName": "xyz789",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"pricePerUnit": Money,
"pricePerUnitV2": HighPrecisionMoney,
"totalUnitCountDecimal": FixedPointNumber,
"minimumUnitCountDecimal": FixedPointNumber,
"maximumUnitCountDecimal": FixedPointNumber,
"areUnitsIssued": false,
"status": "OPEN",
"openedAt": "2007-12-03T10:15:30Z",
"closedAt": "2007-12-03T10:15:30Z",
"fundsDeadline": "2007-12-03T10:15:30Z",
"settledAt": "2007-12-03T10:15:30Z",
"paymentReferencePrefix": "xyz789",
"allocations": [Allocation],
"capitalizationTable": CapitalizationTable,
"totalEquity": Money,
"totalEquityV2": HighPrecisionMoney,
"registrationsOfInterest": [RegistrationOfInterest],
"fund": Fund,
"depositMethods": [OfferDepositMethod],
"digitalSubscription": "ENABLED",
"slug": "abc123",
"dataRoom": OfferDataRoom,
"unitClass": UnitClass,
"searchAllocations": AllocationSearchResults
}
}
}
deleteOfferDataRoomContentBlock
Description
Delete a content block from an offer's data room
Response
Returns an Offer!
Arguments
| Name | Description |
|---|---|
form - DeleteOfferDataRoomContentBlockInput!
|
Example
Query
mutation deleteOfferDataRoomContentBlock($form: DeleteOfferDataRoomContentBlockInput!) {
deleteOfferDataRoomContentBlock(form: $form) {
capitalCallBatches {
...CapitalCallBatchConnectionFragment
}
capitalCallBatch {
...CapitalCallBatchFragment
}
id
displayName
createdAt
updatedAt
pricePerUnit {
...MoneyFragment
}
pricePerUnitV2 {
...HighPrecisionMoneyFragment
}
totalUnitCountDecimal {
...FixedPointNumberFragment
}
minimumUnitCountDecimal {
...FixedPointNumberFragment
}
maximumUnitCountDecimal {
...FixedPointNumberFragment
}
areUnitsIssued
status
openedAt
closedAt
fundsDeadline
settledAt
paymentReferencePrefix
allocations {
...AllocationFragment
}
capitalizationTable {
...CapitalizationTableFragment
}
totalEquity {
...MoneyFragment
}
totalEquityV2 {
...HighPrecisionMoneyFragment
}
registrationsOfInterest {
...RegistrationOfInterestFragment
}
fund {
...FundFragment
}
depositMethods {
...OfferDepositMethodFragment
}
digitalSubscription
slug
dataRoom {
...OfferDataRoomFragment
}
unitClass {
...UnitClassFragment
}
searchAllocations {
...AllocationSearchResultsFragment
}
}
}
Variables
{"form": DeleteOfferDataRoomContentBlockInput}
Response
{
"data": {
"deleteOfferDataRoomContentBlock": {
"capitalCallBatches": CapitalCallBatchConnection,
"capitalCallBatch": CapitalCallBatch,
"id": "4",
"displayName": "abc123",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"pricePerUnit": Money,
"pricePerUnitV2": HighPrecisionMoney,
"totalUnitCountDecimal": FixedPointNumber,
"minimumUnitCountDecimal": FixedPointNumber,
"maximumUnitCountDecimal": FixedPointNumber,
"areUnitsIssued": true,
"status": "OPEN",
"openedAt": "2007-12-03T10:15:30Z",
"closedAt": "2007-12-03T10:15:30Z",
"fundsDeadline": "2007-12-03T10:15:30Z",
"settledAt": "2007-12-03T10:15:30Z",
"paymentReferencePrefix": "xyz789",
"allocations": [Allocation],
"capitalizationTable": CapitalizationTable,
"totalEquity": Money,
"totalEquityV2": HighPrecisionMoney,
"registrationsOfInterest": [RegistrationOfInterest],
"fund": Fund,
"depositMethods": [OfferDepositMethod],
"digitalSubscription": "ENABLED",
"slug": "xyz789",
"dataRoom": OfferDataRoom,
"unitClass": UnitClass,
"searchAllocations": AllocationSearchResults
}
}
}
deleteOfferDocument
Description
Delete a offer document
Response
Returns an Offer!
Arguments
| Name | Description |
|---|---|
form - DeleteOfferDocumentInput!
|
Example
Query
mutation deleteOfferDocument($form: DeleteOfferDocumentInput!) {
deleteOfferDocument(form: $form) {
capitalCallBatches {
...CapitalCallBatchConnectionFragment
}
capitalCallBatch {
...CapitalCallBatchFragment
}
id
displayName
createdAt
updatedAt
pricePerUnit {
...MoneyFragment
}
pricePerUnitV2 {
...HighPrecisionMoneyFragment
}
totalUnitCountDecimal {
...FixedPointNumberFragment
}
minimumUnitCountDecimal {
...FixedPointNumberFragment
}
maximumUnitCountDecimal {
...FixedPointNumberFragment
}
areUnitsIssued
status
openedAt
closedAt
fundsDeadline
settledAt
paymentReferencePrefix
allocations {
...AllocationFragment
}
capitalizationTable {
...CapitalizationTableFragment
}
totalEquity {
...MoneyFragment
}
totalEquityV2 {
...HighPrecisionMoneyFragment
}
registrationsOfInterest {
...RegistrationOfInterestFragment
}
fund {
...FundFragment
}
depositMethods {
...OfferDepositMethodFragment
}
digitalSubscription
slug
dataRoom {
...OfferDataRoomFragment
}
unitClass {
...UnitClassFragment
}
searchAllocations {
...AllocationSearchResultsFragment
}
}
}
Variables
{"form": DeleteOfferDocumentInput}
Response
{
"data": {
"deleteOfferDocument": {
"capitalCallBatches": CapitalCallBatchConnection,
"capitalCallBatch": CapitalCallBatch,
"id": 4,
"displayName": "abc123",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"pricePerUnit": Money,
"pricePerUnitV2": HighPrecisionMoney,
"totalUnitCountDecimal": FixedPointNumber,
"minimumUnitCountDecimal": FixedPointNumber,
"maximumUnitCountDecimal": FixedPointNumber,
"areUnitsIssued": true,
"status": "OPEN",
"openedAt": "2007-12-03T10:15:30Z",
"closedAt": "2007-12-03T10:15:30Z",
"fundsDeadline": "2007-12-03T10:15:30Z",
"settledAt": "2007-12-03T10:15:30Z",
"paymentReferencePrefix": "xyz789",
"allocations": [Allocation],
"capitalizationTable": CapitalizationTable,
"totalEquity": Money,
"totalEquityV2": HighPrecisionMoney,
"registrationsOfInterest": [RegistrationOfInterest],
"fund": Fund,
"depositMethods": [OfferDepositMethod],
"digitalSubscription": "ENABLED",
"slug": "abc123",
"dataRoom": OfferDataRoom,
"unitClass": UnitClass,
"searchAllocations": AllocationSearchResults
}
}
}
deleteProspect
Response
Returns a Prospect!
Arguments
| Name | Description |
|---|---|
form - DeleteProspectInput!
|
Example
Query
mutation deleteProspect($form: DeleteProspectInput!) {
deleteProspect(form: $form) {
id
created
email
firstName
middleName
lastName
preferredName
dateOfBirth {
...DayMonthYearFragment
}
address {
...AddressFragment
}
phoneNumber {
...PhoneNumberFragment
}
jobTitle
industry
organization
twitterProfileUrl
linkedInProfileUrl
biography
searchActivityFeed {
...ActivityFeedResultsFragment
}
tagsV2 {
...InvestorProfileTagFragment
}
connections {
...ConnectionFragment
}
outstandingTasks {
...TaskFragment
}
}
}
Variables
{"form": DeleteProspectInput}
Response
{
"data": {
"deleteProspect": {
"id": "4",
"created": "2007-12-03T10:15:30Z",
"email": "xyz789",
"firstName": "abc123",
"middleName": "abc123",
"lastName": "abc123",
"preferredName": "xyz789",
"dateOfBirth": DayMonthYear,
"address": Address,
"phoneNumber": PhoneNumber,
"jobTitle": "abc123",
"industry": "xyz789",
"organization": "abc123",
"twitterProfileUrl": "http://www.test.com/",
"linkedInProfileUrl": "http://www.test.com/",
"biography": "abc123",
"searchActivityFeed": ActivityFeedResults,
"tagsV2": [InvestorProfileTag],
"connections": [Connection],
"outstandingTasks": [Task]
}
}
}
deleteStatementBatch
Description
Delete a statement batch
Response
Returns a Void!
Arguments
| Name | Description |
|---|---|
input - DeleteStatementBatchInput!
|
Example
Query
mutation deleteStatementBatch($input: DeleteStatementBatchInput!) {
deleteStatementBatch(input: $input)
}
Variables
{"input": DeleteStatementBatchInput}
Response
{"data": {"deleteStatementBatch": null}}
deleteTag
Description
Delete an existing tag.
Response
Returns a TagV2!
Arguments
| Name | Description |
|---|---|
form - DeleteTagInput!
|
Example
Query
mutation deleteTag($form: DeleteTagInput!) {
deleteTag(form: $form) {
... on InvestingEntityTag {
...InvestingEntityTagFragment
}
... on InvestorProfileTag {
...InvestorProfileTagFragment
}
}
}
Variables
{"form": DeleteTagInput}
Response
{"data": {"deleteTag": InvestingEntityTag}}
deleteUnitClassDistributionRate
Description
Delete an existing distribution rate for a unit class
Response
Returns a Void!
Arguments
| Name | Description |
|---|---|
form - DeleteUnitClassDistributionRateInput!
|
Example
Query
mutation deleteUnitClassDistributionRate($form: DeleteUnitClassDistributionRateInput!) {
deleteUnitClassDistributionRate(form: $form)
}
Variables
{"form": DeleteUnitClassDistributionRateInput}
Response
{"data": {"deleteUnitClassDistributionRate": null}}
deleteUnitClassFee
Description
Delete a unit class fee
Response
Returns a Void!
Arguments
| Name | Description |
|---|---|
form - DeleteUnitClassFeeInput!
|
Example
Query
mutation deleteUnitClassFee($form: DeleteUnitClassFeeInput!) {
deleteUnitClassFee(form: $form)
}
Variables
{"form": DeleteUnitClassFeeInput}
Response
{"data": {"deleteUnitClassFee": null}}
deleteUnitPrice
Description
Delete a class unit value update
Response
Returns a Void!
Arguments
| Name | Description |
|---|---|
form - DeleteUnitPriceInput!
|
Example
Query
mutation deleteUnitPrice($form: DeleteUnitPriceInput!) {
deleteUnitPrice(form: $form)
}
Variables
{"form": DeleteUnitPriceInput}
Response
{"data": {"deleteUnitPrice": null}}
deleteUnreconciledDeposit
Description
Delete an unreconciled deposit
Response
Returns a Void!
Arguments
| Name | Description |
|---|---|
form - DeleteUnreconciledDepositInput!
|
Example
Query
mutation deleteUnreconciledDeposit($form: DeleteUnreconciledDepositInput!) {
deleteUnreconciledDeposit(form: $form)
}
Variables
{"form": DeleteUnreconciledDepositInput}
Response
{"data": {"deleteUnreconciledDeposit": null}}
disableAdminUser
Description
Disable an admin user
Response
Returns an AdminUser!
Arguments
| Name | Description |
|---|---|
form - DisableAdminUserInput!
|
Example
Query
mutation disableAdminUser($form: DisableAdminUserInput!) {
disableAdminUser(form: $form) {
id
email
firstName
lastName
profileImageUrl
status
role {
...AdminRoleFragment
}
jobTitle
phoneNumber {
...PhoneNumberFragment
}
calendlyUrl
team
outstandingTasks
intercomHash
}
}
Variables
{"form": DisableAdminUserInput}
Response
{
"data": {
"disableAdminUser": {
"id": 4,
"email": "xyz789",
"firstName": "xyz789",
"lastName": "abc123",
"profileImageUrl": "abc123",
"status": "ACTIVE",
"role": AdminRole,
"jobTitle": "abc123",
"phoneNumber": PhoneNumber,
"calendlyUrl": "http://www.test.com/",
"team": "INVESTOR_RELATIONS",
"outstandingTasks": 123,
"intercomHash": "abc123"
}
}
}
editAllocation
Response
Returns an Allocation!
Arguments
| Name | Description |
|---|---|
form - EditAllocationInput!
|
Example
Query
mutation editAllocation($form: EditAllocationInput!) {
editAllocation(form: $form) {
id
createdAt
offer {
...OfferFragment
}
ownershipPercentage
investingEntity {
...InvestingEntityFragment
}
associatedContact {
... on InvestingEntity {
...InvestingEntityFragment
}
... on Account {
...AccountFragment
}
... on Prospect {
...ProspectFragment
}
}
status
unitCountDecimal {
...FixedPointNumberFragment
}
pricePerUnit {
...MoneyFragment
}
pricePerUnitV2 {
...HighPrecisionMoneyFragment
}
totalValue {
...MoneyFragment
}
expectedReference
payments {
...ManualAllocationPaymentFragment
}
totalPaid {
...MoneyFragment
}
note
balance {
...MoneyFragment
}
unitsIssued {
...FixedPointNumberFragment
}
issuedHolding {
...HoldingFragment
}
capitalCalled {
...HighPrecisionMoneyFragment
}
customFieldSection {
...CustomFieldSectionFragment
}
}
}
Variables
{"form": EditAllocationInput}
Response
{
"data": {
"editAllocation": {
"id": 4,
"createdAt": "2007-12-03T10:15:30Z",
"offer": Offer,
"ownershipPercentage": "abc123",
"investingEntity": InvestingEntity,
"associatedContact": InvestingEntity,
"status": "INTERESTED",
"unitCountDecimal": FixedPointNumber,
"pricePerUnit": Money,
"pricePerUnitV2": HighPrecisionMoney,
"totalValue": Money,
"expectedReference": "abc123",
"payments": [ManualAllocationPayment],
"totalPaid": Money,
"note": "xyz789",
"balance": Money,
"unitsIssued": FixedPointNumber,
"issuedHolding": Holding,
"capitalCalled": HighPrecisionMoney,
"customFieldSection": [CustomFieldSection]
}
}
}
editAllocationCustomFieldSectionResponse
Description
Set custom field responses for an allocation. You can use this to amend to existing responses or to set new responses. Deletion of existing responses is not supported.
Response
Returns [CustomFieldSection!]
Arguments
| Name | Description |
|---|---|
form - EditAllocationCustomFieldSectionResponseInput
|
Example
Query
mutation editAllocationCustomFieldSectionResponse($form: EditAllocationCustomFieldSectionResponseInput) {
editAllocationCustomFieldSectionResponse(form: $form) {
id
order
name
displayName
description
fields {
... on CustomFieldText {
...CustomFieldTextFragment
}
... on CustomFieldSelect {
...CustomFieldSelectFragment
}
... on CustomFieldMultiSelect {
...CustomFieldMultiSelectFragment
}
... on CustomFieldRadios {
...CustomFieldRadiosFragment
}
... on CustomFieldCheckboxes {
...CustomFieldCheckboxesFragment
}
... on CustomFieldContent {
...CustomFieldContentFragment
}
}
}
}
Variables
{"form": EditAllocationCustomFieldSectionResponseInput}
Response
{
"data": {
"editAllocationCustomFieldSectionResponse": [
{
"id": 4,
"order": 123,
"name": "abc123",
"displayName": "abc123",
"description": "abc123",
"fields": [CustomFieldText]
}
]
}
}
editAllocationNote
Description
Edit allocation note used when we are only updating the note (will work for confirmed allocations)
Response
Returns an Allocation!
Arguments
| Name | Description |
|---|---|
form - EditAllocationNoteInput!
|
Example
Query
mutation editAllocationNote($form: EditAllocationNoteInput!) {
editAllocationNote(form: $form) {
id
createdAt
offer {
...OfferFragment
}
ownershipPercentage
investingEntity {
...InvestingEntityFragment
}
associatedContact {
... on InvestingEntity {
...InvestingEntityFragment
}
... on Account {
...AccountFragment
}
... on Prospect {
...ProspectFragment
}
}
status
unitCountDecimal {
...FixedPointNumberFragment
}
pricePerUnit {
...MoneyFragment
}
pricePerUnitV2 {
...HighPrecisionMoneyFragment
}
totalValue {
...MoneyFragment
}
expectedReference
payments {
...ManualAllocationPaymentFragment
}
totalPaid {
...MoneyFragment
}
note
balance {
...MoneyFragment
}
unitsIssued {
...FixedPointNumberFragment
}
issuedHolding {
...HoldingFragment
}
capitalCalled {
...HighPrecisionMoneyFragment
}
customFieldSection {
...CustomFieldSectionFragment
}
}
}
Variables
{"form": EditAllocationNoteInput}
Response
{
"data": {
"editAllocationNote": {
"id": "4",
"createdAt": "2007-12-03T10:15:30Z",
"offer": Offer,
"ownershipPercentage": "abc123",
"investingEntity": InvestingEntity,
"associatedContact": InvestingEntity,
"status": "INTERESTED",
"unitCountDecimal": FixedPointNumber,
"pricePerUnit": Money,
"pricePerUnitV2": HighPrecisionMoney,
"totalValue": Money,
"expectedReference": "xyz789",
"payments": [ManualAllocationPayment],
"totalPaid": Money,
"note": "xyz789",
"balance": Money,
"unitsIssued": FixedPointNumber,
"issuedHolding": Holding,
"capitalCalled": HighPrecisionMoney,
"customFieldSection": [CustomFieldSection]
}
}
}
editConnection
Description
Update a connection between two connection profiles
Response
Returns a ConnectionProfile!
Arguments
| Name | Description |
|---|---|
form - EditConnectionInput!
|
Example
Query
mutation editConnection($form: EditConnectionInput!) {
editConnection(form: $form) {
... on Prospect {
...ProspectFragment
}
... on Account {
...AccountFragment
}
}
}
Variables
{"form": EditConnectionInput}
Response
{"data": {"editConnection": Prospect}}
enrichStatementBatch
Description
Enrich a statement batch with CSV data.
Response
Returns a StatementBatch!
Arguments
| Name | Description |
|---|---|
input - EnrichStatementBatchInput!
|
Example
Query
mutation enrichStatementBatch($input: EnrichStatementBatchInput!) {
enrichStatementBatch(input: $input) {
id
name
createdAt
status
noData
configuration {
... on InvestorStatementConfig {
...InvestorStatementConfigFragment
}
... on TaxStatementConfig {
...TaxStatementConfigFragment
}
... on HoldingStatementConfig {
...HoldingStatementConfigFragment
}
... on PeriodicStatementConfig {
...PeriodicStatementConfigFragment
}
}
generation {
...StatementGenerationFragment
}
enrichment {
...StatementEnrichmentFragment
}
confirmation {
...StatementConfirmationFragment
}
publication {
...StatementPublicationFragment
}
numberOfStatements
statements {
...StatementConnectionFragment
}
}
}
Variables
{"input": EnrichStatementBatchInput}
Response
{
"data": {
"enrichStatementBatch": {
"id": 4,
"name": "xyz789",
"createdAt": "2007-12-03T10:15:30Z",
"status": "GENERATING",
"noData": false,
"configuration": InvestorStatementConfig,
"generation": StatementGeneration,
"enrichment": StatementEnrichment,
"confirmation": StatementConfirmation,
"publication": StatementPublication,
"numberOfStatements": 987,
"statements": StatementConnection
}
}
}
generateAIIRReport
Description
Generates an AIIR report for a fund for a given Australian financial year. 2006: 2005-07-01 - 2006-06-30
Response
Returns a RemoteAsset!
Arguments
| Name | Description |
|---|---|
form - GenerateAIIRReportInput!
|
Example
Query
mutation generateAIIRReport($form: GenerateAIIRReportInput!) {
generateAIIRReport(form: $form) {
id
created
name
fileName
index
url
contentType
size
}
}
Variables
{"form": GenerateAIIRReportInput}
Response
{
"data": {
"generateAIIRReport": {
"id": 4,
"created": "2007-12-03T10:15:30Z",
"name": "xyz789",
"fileName": "abc123",
"index": 123,
"url": "abc123",
"contentType": "xyz789",
"size": 987
}
}
}
generateAllAllocationsReport
Description
Generates a report for all allocations with their key account
Response
Returns a RemoteAsset!
Example
Query
mutation generateAllAllocationsReport {
generateAllAllocationsReport {
id
created
name
fileName
index
url
contentType
size
}
}
Response
{
"data": {
"generateAllAllocationsReport": {
"id": 4,
"created": "2007-12-03T10:15:30Z",
"name": "xyz789",
"fileName": "abc123",
"index": 987,
"url": "abc123",
"contentType": "abc123",
"size": 123
}
}
}
generateAllHoldingsSensitiveReport
Description
Generates a report for all holdings sensitive from a given period
Response
Returns a RemoteAsset!
Arguments
| Name | Description |
|---|---|
at - DateTime!
|
Example
Query
mutation generateAllHoldingsSensitiveReport($at: DateTime!) {
generateAllHoldingsSensitiveReport(at: $at) {
id
created
name
fileName
index
url
contentType
size
}
}
Variables
{"at": "2007-12-03T10:15:30Z"}
Response
{
"data": {
"generateAllHoldingsSensitiveReport": {
"id": "4",
"created": "2007-12-03T10:15:30Z",
"name": "abc123",
"fileName": "xyz789",
"index": 123,
"url": "xyz789",
"contentType": "xyz789",
"size": 123
}
}
}
generateAllTransactionsReport
Description
Generates a report of all transactions for a given period
Response
Returns a RemoteAsset!
Arguments
| Name | Description |
|---|---|
form - GenerateAllTransactionsReportInput!
|
Example
Query
mutation generateAllTransactionsReport($form: GenerateAllTransactionsReportInput!) {
generateAllTransactionsReport(form: $form) {
id
created
name
fileName
index
url
contentType
size
}
}
Variables
{"form": GenerateAllTransactionsReportInput}
Response
{
"data": {
"generateAllTransactionsReport": {
"id": 4,
"created": "2007-12-03T10:15:30Z",
"name": "xyz789",
"fileName": "xyz789",
"index": 987,
"url": "abc123",
"contentType": "abc123",
"size": 987
}
}
}
generateAuditLogReport
Description
Generates a report for audit log events between specified dates
Response
Returns a RemoteAsset!
Arguments
| Name | Description |
|---|---|
form - GenerateAuditLogReportInput!
|
Example
Query
mutation generateAuditLogReport($form: GenerateAuditLogReportInput!) {
generateAuditLogReport(form: $form) {
id
created
name
fileName
index
url
contentType
size
}
}
Variables
{"form": GenerateAuditLogReportInput}
Response
{
"data": {
"generateAuditLogReport": {
"id": 4,
"created": "2007-12-03T10:15:30Z",
"name": "xyz789",
"fileName": "xyz789",
"index": 987,
"url": "abc123",
"contentType": "abc123",
"size": 123
}
}
}
generateCRSReport
Description
Generates a CRS report for a fund over a given calendar year. 2006-01-01: 2006-01-01 - 2006-12-31
Response
Returns a RemoteAsset!
Arguments
| Name | Description |
|---|---|
form - GenerateCRSReportInput!
|
Example
Query
mutation generateCRSReport($form: GenerateCRSReportInput!) {
generateCRSReport(form: $form) {
id
created
name
fileName
index
url
contentType
size
}
}
Variables
{"form": GenerateCRSReportInput}
Response
{
"data": {
"generateCRSReport": {
"id": "4",
"created": "2007-12-03T10:15:30Z",
"name": "abc123",
"fileName": "abc123",
"index": 987,
"url": "xyz789",
"contentType": "abc123",
"size": 123
}
}
}
generateCapitalCallBatchAuditReport
Description
Generate an audit report for a capital call batch
Response
Returns a RemoteAsset!
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
mutation generateCapitalCallBatchAuditReport($id: ID!) {
generateCapitalCallBatchAuditReport(id: $id) {
id
created
name
fileName
index
url
contentType
size
}
}
Variables
{"id": 4}
Response
{
"data": {
"generateCapitalCallBatchAuditReport": {
"id": "4",
"created": "2007-12-03T10:15:30Z",
"name": "abc123",
"fileName": "xyz789",
"index": 123,
"url": "xyz789",
"contentType": "abc123",
"size": 123
}
}
}
generateDistributionAuditReport
Description
Generates the audit report for the distribution
Response
Returns a RemoteAsset!
Arguments
| Name | Description |
|---|---|
form - GenerateDistributionAuditReportInput!
|
Example
Query
mutation generateDistributionAuditReport($form: GenerateDistributionAuditReportInput!) {
generateDistributionAuditReport(form: $form) {
id
created
name
fileName
index
url
contentType
size
}
}
Variables
{"form": GenerateDistributionAuditReportInput}
Response
{
"data": {
"generateDistributionAuditReport": {
"id": "4",
"created": "2007-12-03T10:15:30Z",
"name": "xyz789",
"fileName": "abc123",
"index": 987,
"url": "abc123",
"contentType": "xyz789",
"size": 123
}
}
}
generateDistributionPaymentFile
Description
Generates the payment file for the distribution
Response
Returns a RemoteAsset!
Arguments
| Name | Description |
|---|---|
form - GenerateDistributionPaymentFileInput!
|
Example
Query
mutation generateDistributionPaymentFile($form: GenerateDistributionPaymentFileInput!) {
generateDistributionPaymentFile(form: $form) {
id
created
name
fileName
index
url
contentType
size
}
}
Variables
{"form": GenerateDistributionPaymentFileInput}
Response
{
"data": {
"generateDistributionPaymentFile": {
"id": 4,
"created": "2007-12-03T10:15:30Z",
"name": "xyz789",
"fileName": "xyz789",
"index": 123,
"url": "abc123",
"contentType": "abc123",
"size": 987
}
}
}
generateDistributionReinvestmentReport
Response
Returns a RemoteAsset!
Arguments
| Name | Description |
|---|---|
form - GenerateDistributionReinvestmentReportInput!
|
Example
Query
mutation generateDistributionReinvestmentReport($form: GenerateDistributionReinvestmentReportInput!) {
generateDistributionReinvestmentReport(form: $form) {
id
created
name
fileName
index
url
contentType
size
}
}
Variables
{"form": GenerateDistributionReinvestmentReportInput}
Response
{
"data": {
"generateDistributionReinvestmentReport": {
"id": 4,
"created": "2007-12-03T10:15:30Z",
"name": "xyz789",
"fileName": "xyz789",
"index": 123,
"url": "abc123",
"contentType": "xyz789",
"size": 987
}
}
}
generateDistributionSummaryReport
Response
Returns a RemoteAsset!
Arguments
| Name | Description |
|---|---|
form - GenerateDistributionSummaryReportInput!
|
Example
Query
mutation generateDistributionSummaryReport($form: GenerateDistributionSummaryReportInput!) {
generateDistributionSummaryReport(form: $form) {
id
created
name
fileName
index
url
contentType
size
}
}
Variables
{"form": GenerateDistributionSummaryReportInput}
Response
{
"data": {
"generateDistributionSummaryReport": {
"id": 4,
"created": "2007-12-03T10:15:30Z",
"name": "xyz789",
"fileName": "xyz789",
"index": 123,
"url": "xyz789",
"contentType": "abc123",
"size": 987
}
}
}
generateEmailBatchMessages
Description
Generates the actual email messages for a batch based on the current saved template. This can be run multiple times to regenerate the messages if the template has changed.
Response
Returns a GenerateEmailBatchMessagesResponse!
Arguments
| Name | Description |
|---|---|
form - GenerateEmailBatchMessagesInput!
|
Example
Query
mutation generateEmailBatchMessages($form: GenerateEmailBatchMessagesInput!) {
generateEmailBatchMessages(form: $form) {
... on EmailBatch {
...EmailBatchFragment
}
}
}
Variables
{"form": GenerateEmailBatchMessagesInput}
Response
{"data": {"generateEmailBatchMessages": EmailBatch}}
generateFATCAReport
Description
Generates a FATCA report for a fund over a given calendar year. 2006-01-01: 2006-01-01 - 2006-12-31
Response
Returns a RemoteAsset!
Arguments
| Name | Description |
|---|---|
form - GenerateFATCAReportInput!
|
Example
Query
mutation generateFATCAReport($form: GenerateFATCAReportInput!) {
generateFATCAReport(form: $form) {
id
created
name
fileName
index
url
contentType
size
}
}
Variables
{"form": GenerateFATCAReportInput}
Response
{
"data": {
"generateFATCAReport": {
"id": 4,
"created": "2007-12-03T10:15:30Z",
"name": "abc123",
"fileName": "abc123",
"index": 987,
"url": "abc123",
"contentType": "abc123",
"size": 987
}
}
}
generateFundHoldingsReport
Description
Generates a pdf report of fund holdings on a specified date
Response
Returns a RemoteAsset!
Arguments
| Name | Description |
|---|---|
form - GenerateFundHoldingsReportInput!
|
Example
Query
mutation generateFundHoldingsReport($form: GenerateFundHoldingsReportInput!) {
generateFundHoldingsReport(form: $form) {
id
created
name
fileName
index
url
contentType
size
}
}
Variables
{"form": GenerateFundHoldingsReportInput}
Response
{
"data": {
"generateFundHoldingsReport": {
"id": 4,
"created": "2007-12-03T10:15:30Z",
"name": "abc123",
"fileName": "xyz789",
"index": 123,
"url": "xyz789",
"contentType": "abc123",
"size": 987
}
}
}
generateManagementFeeReport
Description
Generate a management fee report for a specified period
Response
Returns a RemoteAsset!
Arguments
| Name | Description |
|---|---|
form - GenerateManagementFeeReportInput!
|
Example
Query
mutation generateManagementFeeReport($form: GenerateManagementFeeReportInput!) {
generateManagementFeeReport(form: $form) {
id
created
name
fileName
index
url
contentType
size
}
}
Variables
{"form": GenerateManagementFeeReportInput}
Response
{
"data": {
"generateManagementFeeReport": {
"id": "4",
"created": "2007-12-03T10:15:30Z",
"name": "abc123",
"fileName": "abc123",
"index": 987,
"url": "abc123",
"contentType": "abc123",
"size": 987
}
}
}
generateOfferAllocationsReport
Description
Generates a report for the allocations with their related accounts and beneficial owners for an offer
Response
Returns a RemoteAsset!
Arguments
| Name | Description |
|---|---|
form - GenerateOfferAllocationsReportInput!
|
Example
Query
mutation generateOfferAllocationsReport($form: GenerateOfferAllocationsReportInput!) {
generateOfferAllocationsReport(form: $form) {
id
created
name
fileName
index
url
contentType
size
}
}
Variables
{"form": GenerateOfferAllocationsReportInput}
Response
{
"data": {
"generateOfferAllocationsReport": {
"id": "4",
"created": "2007-12-03T10:15:30Z",
"name": "abc123",
"fileName": "abc123",
"index": 987,
"url": "abc123",
"contentType": "xyz789",
"size": 123
}
}
}
generateStatementBatch
Description
Generate or regenerate a statement batch
Response
Returns a StatementBatch!
Arguments
| Name | Description |
|---|---|
input - GenerateStatementBatchInput!
|
Example
Query
mutation generateStatementBatch($input: GenerateStatementBatchInput!) {
generateStatementBatch(input: $input) {
id
name
createdAt
status
noData
configuration {
... on InvestorStatementConfig {
...InvestorStatementConfigFragment
}
... on TaxStatementConfig {
...TaxStatementConfigFragment
}
... on HoldingStatementConfig {
...HoldingStatementConfigFragment
}
... on PeriodicStatementConfig {
...PeriodicStatementConfigFragment
}
}
generation {
...StatementGenerationFragment
}
enrichment {
...StatementEnrichmentFragment
}
confirmation {
...StatementConfirmationFragment
}
publication {
...StatementPublicationFragment
}
numberOfStatements
statements {
...StatementConnectionFragment
}
}
}
Variables
{"input": GenerateStatementBatchInput}
Response
{
"data": {
"generateStatementBatch": {
"id": "4",
"name": "xyz789",
"createdAt": "2007-12-03T10:15:30Z",
"status": "GENERATING",
"noData": true,
"configuration": InvestorStatementConfig,
"generation": StatementGeneration,
"enrichment": StatementEnrichment,
"confirmation": StatementConfirmation,
"publication": StatementPublication,
"numberOfStatements": 123,
"statements": StatementConnection
}
}
}
generateStatementBatchArchive
Description
Generates a .zip archive of all statements in the batch.
Response
Returns a RemoteAsset!
Arguments
| Name | Description |
|---|---|
input - GenerateStatementBatchArchiveInput!
|
Example
Query
mutation generateStatementBatchArchive($input: GenerateStatementBatchArchiveInput!) {
generateStatementBatchArchive(input: $input) {
id
created
name
fileName
index
url
contentType
size
}
}
Variables
{"input": GenerateStatementBatchArchiveInput}
Response
{
"data": {
"generateStatementBatchArchive": {
"id": 4,
"created": "2007-12-03T10:15:30Z",
"name": "abc123",
"fileName": "xyz789",
"index": 987,
"url": "abc123",
"contentType": "abc123",
"size": 123
}
}
}
generateStaticPaymentReference
Description
Generate a static payment reference for an investing entity to be used with BPAY payments.
Response
Returns a StaticPaymentReference!
Arguments
| Name | Description |
|---|---|
form - GenerateStaticPaymentReferenceInput!
|
Example
Query
mutation generateStaticPaymentReference($form: GenerateStaticPaymentReferenceInput!) {
generateStaticPaymentReference(form: $form) {
... on BankPaymentReference {
...BankPaymentReferenceFragment
}
... on BPAYPaymentReference {
...BPAYPaymentReferenceFragment
}
}
}
Variables
{"form": GenerateStaticPaymentReferenceInput}
Response
{
"data": {
"generateStaticPaymentReference": BankPaymentReference
}
}
getCapitalCallNoticeStatement
Description
Get the notice statement for a capital call
Response
Returns a RemoteAsset!
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
mutation getCapitalCallNoticeStatement($id: ID!) {
getCapitalCallNoticeStatement(id: $id) {
id
created
name
fileName
index
url
contentType
size
}
}
Variables
{"id": 4}
Response
{
"data": {
"getCapitalCallNoticeStatement": {
"id": "4",
"created": "2007-12-03T10:15:30Z",
"name": "xyz789",
"fileName": "xyz789",
"index": 987,
"url": "xyz789",
"contentType": "xyz789",
"size": 987
}
}
}
getImportBatchAuditReport
Description
Get the audit report for the import batch.
Response
Returns a RemoteAsset!
Arguments
| Name | Description |
|---|---|
form - GetImportBatchAuditReportInput!
|
Example
Query
mutation getImportBatchAuditReport($form: GetImportBatchAuditReportInput!) {
getImportBatchAuditReport(form: $form) {
id
created
name
fileName
index
url
contentType
size
}
}
Variables
{"form": GetImportBatchAuditReportInput}
Response
{
"data": {
"getImportBatchAuditReport": {
"id": 4,
"created": "2007-12-03T10:15:30Z",
"name": "xyz789",
"fileName": "xyz789",
"index": 123,
"url": "abc123",
"contentType": "xyz789",
"size": 123
}
}
}
issueAllocationUnits
Description
Issues units for a provided allocation
Response
Returns an Allocation!
Arguments
| Name | Description |
|---|---|
form - IssueAllocationUnitsInput!
|
Example
Query
mutation issueAllocationUnits($form: IssueAllocationUnitsInput!) {
issueAllocationUnits(form: $form) {
id
createdAt
offer {
...OfferFragment
}
ownershipPercentage
investingEntity {
...InvestingEntityFragment
}
associatedContact {
... on InvestingEntity {
...InvestingEntityFragment
}
... on Account {
...AccountFragment
}
... on Prospect {
...ProspectFragment
}
}
status
unitCountDecimal {
...FixedPointNumberFragment
}
pricePerUnit {
...MoneyFragment
}
pricePerUnitV2 {
...HighPrecisionMoneyFragment
}
totalValue {
...MoneyFragment
}
expectedReference
payments {
...ManualAllocationPaymentFragment
}
totalPaid {
...MoneyFragment
}
note
balance {
...MoneyFragment
}
unitsIssued {
...FixedPointNumberFragment
}
issuedHolding {
...HoldingFragment
}
capitalCalled {
...HighPrecisionMoneyFragment
}
customFieldSection {
...CustomFieldSectionFragment
}
}
}
Variables
{"form": IssueAllocationUnitsInput}
Response
{
"data": {
"issueAllocationUnits": {
"id": 4,
"createdAt": "2007-12-03T10:15:30Z",
"offer": Offer,
"ownershipPercentage": "xyz789",
"investingEntity": InvestingEntity,
"associatedContact": InvestingEntity,
"status": "INTERESTED",
"unitCountDecimal": FixedPointNumber,
"pricePerUnit": Money,
"pricePerUnitV2": HighPrecisionMoney,
"totalValue": Money,
"expectedReference": "abc123",
"payments": [ManualAllocationPayment],
"totalPaid": Money,
"note": "abc123",
"balance": Money,
"unitsIssued": FixedPointNumber,
"issuedHolding": Holding,
"capitalCalled": HighPrecisionMoney,
"customFieldSection": [CustomFieldSection]
}
}
}
lockAccount
Description
Locks the specied account - only if its unlocked
Response
Returns an Account!
Arguments
| Name | Description |
|---|---|
form - LockAccountInput!
|
Example
Query
mutation lockAccount($form: LockAccountInput!) {
lockAccount(form: $form) {
id
created
updated
lastLoggedIn
email
hasPasswordSet
activationEmailLastSent
legalName {
...LegalNameFragment
}
preferredName
timeZone
dateOfBirth {
...DayMonthYearFragment
}
termsAgreed
isAccountLocked
accountLockedReason
addresses {
...VerifiableAddressFragment
}
phoneNumber {
...PhoneNumberFragment
}
emailConfirmed
status
setupStatus {
...AccountSetupStatusFragment
}
investingEntities {
...InvestingEntityFragment
}
identityVerifications {
...IdentityVerificationFragment
}
pepSearchResult {
...PEPSearchResultFragment
}
notes {
...NoteFragment
}
searchActivityFeed {
...ActivityFeedResultsFragment
}
totalPortfolioValue {
...MoneyFragment
}
jobTitle
industry
organization
twitterProfileUrl
linkedInProfileUrl
biography
accountManager {
...AdminUserFragment
}
tagsV2 {
...InvestorProfileTagFragment
}
connections {
...ConnectionFragment
}
outstandingTasks {
...TaskFragment
}
outstandingNotifications {
...AccountNotificationFragment
}
identityVerificationStatus
allHoldingsCSVUrl
identityVerificationLastSent
}
}
Variables
{"form": LockAccountInput}
Response
{
"data": {
"lockAccount": {
"id": "4",
"created": "2007-12-03T10:15:30Z",
"updated": "2007-12-03T10:15:30Z",
"lastLoggedIn": "2007-12-03T10:15:30Z",
"email": "abc123",
"hasPasswordSet": true,
"activationEmailLastSent": "2007-12-03T10:15:30Z",
"legalName": LegalName,
"preferredName": "xyz789",
"timeZone": "abc123",
"dateOfBirth": DayMonthYear,
"termsAgreed": false,
"isAccountLocked": true,
"accountLockedReason": "xyz789",
"addresses": [VerifiableAddress],
"phoneNumber": PhoneNumber,
"emailConfirmed": false,
"status": "PENDING",
"setupStatus": AccountSetupStatus,
"investingEntities": [InvestingEntity],
"identityVerifications": [IdentityVerification],
"pepSearchResult": PEPSearchResult,
"notes": [Note],
"searchActivityFeed": ActivityFeedResults,
"totalPortfolioValue": Money,
"jobTitle": "xyz789",
"industry": "xyz789",
"organization": "xyz789",
"twitterProfileUrl": "http://www.test.com/",
"linkedInProfileUrl": "http://www.test.com/",
"biography": "xyz789",
"accountManager": AdminUser,
"tagsV2": [InvestorProfileTag],
"connections": [Connection],
"outstandingTasks": [Task],
"outstandingNotifications": [AccountNotification],
"identityVerificationStatus": "INCOMPLETE",
"allHoldingsCSVUrl": "abc123",
"identityVerificationLastSent": "2007-12-03T10:15:30Z"
}
}
}
logEmail
Description
Log email from outlook add-in to investing entity or account activity feed
Response
Returns a Void!
Arguments
| Name | Description |
|---|---|
form - LogEmailInput!
|
Example
Query
mutation logEmail($form: LogEmailInput!) {
logEmail(form: $form)
}
Variables
{"form": LogEmailInput}
Response
{"data": {"logEmail": null}}
manuallyVerifyAccountAddress
Description
Manually verify account address
Response
Returns an Account!
Arguments
| Name | Description |
|---|---|
form - ManuallyVerifyAccountAddressInput!
|
Example
Query
mutation manuallyVerifyAccountAddress($form: ManuallyVerifyAccountAddressInput!) {
manuallyVerifyAccountAddress(form: $form) {
id
created
updated
lastLoggedIn
email
hasPasswordSet
activationEmailLastSent
legalName {
...LegalNameFragment
}
preferredName
timeZone
dateOfBirth {
...DayMonthYearFragment
}
termsAgreed
isAccountLocked
accountLockedReason
addresses {
...VerifiableAddressFragment
}
phoneNumber {
...PhoneNumberFragment
}
emailConfirmed
status
setupStatus {
...AccountSetupStatusFragment
}
investingEntities {
...InvestingEntityFragment
}
identityVerifications {
...IdentityVerificationFragment
}
pepSearchResult {
...PEPSearchResultFragment
}
notes {
...NoteFragment
}
searchActivityFeed {
...ActivityFeedResultsFragment
}
totalPortfolioValue {
...MoneyFragment
}
jobTitle
industry
organization
twitterProfileUrl
linkedInProfileUrl
biography
accountManager {
...AdminUserFragment
}
tagsV2 {
...InvestorProfileTagFragment
}
connections {
...ConnectionFragment
}
outstandingTasks {
...TaskFragment
}
outstandingNotifications {
...AccountNotificationFragment
}
identityVerificationStatus
allHoldingsCSVUrl
identityVerificationLastSent
}
}
Variables
{"form": ManuallyVerifyAccountAddressInput}
Response
{
"data": {
"manuallyVerifyAccountAddress": {
"id": "4",
"created": "2007-12-03T10:15:30Z",
"updated": "2007-12-03T10:15:30Z",
"lastLoggedIn": "2007-12-03T10:15:30Z",
"email": "xyz789",
"hasPasswordSet": false,
"activationEmailLastSent": "2007-12-03T10:15:30Z",
"legalName": LegalName,
"preferredName": "abc123",
"timeZone": "abc123",
"dateOfBirth": DayMonthYear,
"termsAgreed": true,
"isAccountLocked": true,
"accountLockedReason": "abc123",
"addresses": [VerifiableAddress],
"phoneNumber": PhoneNumber,
"emailConfirmed": true,
"status": "PENDING",
"setupStatus": AccountSetupStatus,
"investingEntities": [InvestingEntity],
"identityVerifications": [IdentityVerification],
"pepSearchResult": PEPSearchResult,
"notes": [Note],
"searchActivityFeed": ActivityFeedResults,
"totalPortfolioValue": Money,
"jobTitle": "abc123",
"industry": "abc123",
"organization": "abc123",
"twitterProfileUrl": "http://www.test.com/",
"linkedInProfileUrl": "http://www.test.com/",
"biography": "abc123",
"accountManager": AdminUser,
"tagsV2": [InvestorProfileTag],
"connections": [Connection],
"outstandingTasks": [Task],
"outstandingNotifications": [AccountNotification],
"identityVerificationStatus": "INCOMPLETE",
"allHoldingsCSVUrl": "abc123",
"identityVerificationLastSent": "2007-12-03T10:15:30Z"
}
}
}
manuallyVerifyAccountIdentity
Description
Manually verify account identity
Response
Returns an Account!
Arguments
| Name | Description |
|---|---|
form - ManuallyVerifyAccountIdentityInput!
|
Example
Query
mutation manuallyVerifyAccountIdentity($form: ManuallyVerifyAccountIdentityInput!) {
manuallyVerifyAccountIdentity(form: $form) {
id
created
updated
lastLoggedIn
email
hasPasswordSet
activationEmailLastSent
legalName {
...LegalNameFragment
}
preferredName
timeZone
dateOfBirth {
...DayMonthYearFragment
}
termsAgreed
isAccountLocked
accountLockedReason
addresses {
...VerifiableAddressFragment
}
phoneNumber {
...PhoneNumberFragment
}
emailConfirmed
status
setupStatus {
...AccountSetupStatusFragment
}
investingEntities {
...InvestingEntityFragment
}
identityVerifications {
...IdentityVerificationFragment
}
pepSearchResult {
...PEPSearchResultFragment
}
notes {
...NoteFragment
}
searchActivityFeed {
...ActivityFeedResultsFragment
}
totalPortfolioValue {
...MoneyFragment
}
jobTitle
industry
organization
twitterProfileUrl
linkedInProfileUrl
biography
accountManager {
...AdminUserFragment
}
tagsV2 {
...InvestorProfileTagFragment
}
connections {
...ConnectionFragment
}
outstandingTasks {
...TaskFragment
}
outstandingNotifications {
...AccountNotificationFragment
}
identityVerificationStatus
allHoldingsCSVUrl
identityVerificationLastSent
}
}
Variables
{"form": ManuallyVerifyAccountIdentityInput}
Response
{
"data": {
"manuallyVerifyAccountIdentity": {
"id": 4,
"created": "2007-12-03T10:15:30Z",
"updated": "2007-12-03T10:15:30Z",
"lastLoggedIn": "2007-12-03T10:15:30Z",
"email": "abc123",
"hasPasswordSet": false,
"activationEmailLastSent": "2007-12-03T10:15:30Z",
"legalName": LegalName,
"preferredName": "xyz789",
"timeZone": "abc123",
"dateOfBirth": DayMonthYear,
"termsAgreed": false,
"isAccountLocked": false,
"accountLockedReason": "xyz789",
"addresses": [VerifiableAddress],
"phoneNumber": PhoneNumber,
"emailConfirmed": true,
"status": "PENDING",
"setupStatus": AccountSetupStatus,
"investingEntities": [InvestingEntity],
"identityVerifications": [IdentityVerification],
"pepSearchResult": PEPSearchResult,
"notes": [Note],
"searchActivityFeed": ActivityFeedResults,
"totalPortfolioValue": Money,
"jobTitle": "abc123",
"industry": "xyz789",
"organization": "abc123",
"twitterProfileUrl": "http://www.test.com/",
"linkedInProfileUrl": "http://www.test.com/",
"biography": "xyz789",
"accountManager": AdminUser,
"tagsV2": [InvestorProfileTag],
"connections": [Connection],
"outstandingTasks": [Task],
"outstandingNotifications": [AccountNotification],
"identityVerificationStatus": "INCOMPLETE",
"allHoldingsCSVUrl": "xyz789",
"identityVerificationLastSent": "2007-12-03T10:15:30Z"
}
}
}
manuallyVerifyBeneficialOwnerAddress
Description
Manually verify beneficial owner's address
Response
Returns a BeneficialOwner!
Arguments
| Name | Description |
|---|---|
form - ManuallyVerifyBeneficialOwnerAddressInput!
|
Example
Query
mutation manuallyVerifyBeneficialOwnerAddress($form: ManuallyVerifyBeneficialOwnerAddressInput!) {
manuallyVerifyBeneficialOwnerAddress(form: $form) {
id
created
relationship
nodes {
...BeneficialOwnerFragment
}
notes {
...NoteFragment
}
activity {
...ActivityMessageFragment
}
uploadedDocuments {
...UploadedDocumentFragment
}
parent {
... on EntityBeneficialOwner {
...EntityBeneficialOwnerFragment
}
... on InvestingEntity {
...InvestingEntityFragment
}
}
}
}
Variables
{"form": ManuallyVerifyBeneficialOwnerAddressInput}
Response
{
"data": {
"manuallyVerifyBeneficialOwnerAddress": {
"id": "4",
"created": "2007-12-03T10:15:30Z",
"relationship": "DIRECTOR",
"nodes": [BeneficialOwner],
"notes": [Note],
"activity": [ActivityMessage],
"uploadedDocuments": [UploadedDocument],
"parent": EntityBeneficialOwner
}
}
}
manuallyVerifyBeneficialOwnerIdentity
Description
Manually verify beneficial owner's identity
Response
Returns a BeneficialOwner!
Arguments
| Name | Description |
|---|---|
form - ManuallyVerifyBeneficialOwnerIdentityInput!
|
Example
Query
mutation manuallyVerifyBeneficialOwnerIdentity($form: ManuallyVerifyBeneficialOwnerIdentityInput!) {
manuallyVerifyBeneficialOwnerIdentity(form: $form) {
id
created
relationship
nodes {
...BeneficialOwnerFragment
}
notes {
...NoteFragment
}
activity {
...ActivityMessageFragment
}
uploadedDocuments {
...UploadedDocumentFragment
}
parent {
... on EntityBeneficialOwner {
...EntityBeneficialOwnerFragment
}
... on InvestingEntity {
...InvestingEntityFragment
}
}
}
}
Variables
{"form": ManuallyVerifyBeneficialOwnerIdentityInput}
Response
{
"data": {
"manuallyVerifyBeneficialOwnerIdentity": {
"id": 4,
"created": "2007-12-03T10:15:30Z",
"relationship": "DIRECTOR",
"nodes": [BeneficialOwner],
"notes": [Note],
"activity": [ActivityMessage],
"uploadedDocuments": [UploadedDocument],
"parent": EntityBeneficialOwner
}
}
}
modifyAccountAddressVerificationStatus
Description
Approve or decline an account address verification
Response
Returns an AddressVerification!
Arguments
| Name | Description |
|---|---|
form - ModifyAccountAddressVerificationStatusInput!
|
Example
Query
mutation modifyAccountAddressVerificationStatus($form: ModifyAccountAddressVerificationStatusInput!) {
modifyAccountAddressVerificationStatus(form: $form) {
id
checkedAt
document {
...RemoteAssetFragment
}
transactionId
databases {
...VerificationDatabaseFragment
}
address {
...AddressFragment
}
currentAddress
status
declinedReason
method
thirdParty
validationDetails {
...NameOrAddressValidationDetailFragment
}
}
}
Variables
{"form": ModifyAccountAddressVerificationStatusInput}
Response
{
"data": {
"modifyAccountAddressVerificationStatus": {
"id": 4,
"checkedAt": "2007-12-03T10:15:30Z",
"document": RemoteAsset,
"transactionId": "xyz789",
"databases": [VerificationDatabase],
"address": Address,
"currentAddress": false,
"status": "PENDING",
"declinedReason": "abc123",
"method": "THIRD_PARTY",
"thirdParty": "VERIFI",
"validationDetails": [NameOrAddressValidationDetail]
}
}
}
modifyBeneficialOwnerAddressVerificationStatus
Description
Approve or decline a beneficial owner address verification
Response
Returns an AddressVerification!
Arguments
| Name | Description |
|---|---|
form - ModifyBeneficialOwnerAddressVerificationStatusInput!
|
Example
Query
mutation modifyBeneficialOwnerAddressVerificationStatus($form: ModifyBeneficialOwnerAddressVerificationStatusInput!) {
modifyBeneficialOwnerAddressVerificationStatus(form: $form) {
id
checkedAt
document {
...RemoteAssetFragment
}
transactionId
databases {
...VerificationDatabaseFragment
}
address {
...AddressFragment
}
currentAddress
status
declinedReason
method
thirdParty
validationDetails {
...NameOrAddressValidationDetailFragment
}
}
}
Variables
{
"form": ModifyBeneficialOwnerAddressVerificationStatusInput
}
Response
{
"data": {
"modifyBeneficialOwnerAddressVerificationStatus": {
"id": "4",
"checkedAt": "2007-12-03T10:15:30Z",
"document": RemoteAsset,
"transactionId": "abc123",
"databases": [VerificationDatabase],
"address": Address,
"currentAddress": false,
"status": "PENDING",
"declinedReason": "abc123",
"method": "THIRD_PARTY",
"thirdParty": "VERIFI",
"validationDetails": [NameOrAddressValidationDetail]
}
}
}
payWithheldDistributions
Description
Pays withheld distributions for a holding
Response
Returns a Holding!
Arguments
| Name | Description |
|---|---|
form - PayWithheldDistributionsInput!
|
Example
Query
mutation payWithheldDistributions($form: PayWithheldDistributionsInput!) {
payWithheldDistributions(form: $form) {
id
createdAt
updatedAt
investingEntity {
...InvestingEntityFragment
}
markedValue {
...MoneyFragment
}
capitalContributed {
...MoneyFragment
}
capitalCommitted {
...MoneyFragment
}
unitCountDecimal {
...FixedPointNumberFragment
}
availableUnitCount {
...FixedPointNumberFragment
}
ownershipPercentage
unitClassOwnershipPercentage
cashDistributions {
...MoneyFragment
}
capitalReturns {
...MoneyFragment
}
bankAccount {
...VerifiableBankAccountFragment
}
redemptionBankAccount {
...VerifiableBankAccountFragment
}
fund {
...FundFragment
}
distributionSettings
distributionsWithheldAmount {
...MoneyFragment
}
withheldDistributions {
...WithheldDistributionFragment
}
unitClass {
...UnitClassFragment
}
reinvestmentUnitClass {
...UnitClassFragment
}
}
}
Variables
{"form": PayWithheldDistributionsInput}
Response
{
"data": {
"payWithheldDistributions": {
"id": "4",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"investingEntity": InvestingEntity,
"markedValue": Money,
"capitalContributed": Money,
"capitalCommitted": Money,
"unitCountDecimal": FixedPointNumber,
"availableUnitCount": FixedPointNumber,
"ownershipPercentage": 123.45,
"unitClassOwnershipPercentage": 987.65,
"cashDistributions": Money,
"capitalReturns": Money,
"bankAccount": VerifiableBankAccount,
"redemptionBankAccount": VerifiableBankAccount,
"fund": Fund,
"distributionSettings": "ENABLED",
"distributionsWithheldAmount": Money,
"withheldDistributions": [WithheldDistribution],
"unitClass": UnitClass,
"reinvestmentUnitClass": UnitClass
}
}
}
recalculateCapitalCallBatch
Description
Recalculate a capital call batch
Response
Returns a CapitalCallBatch!
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
mutation recalculateCapitalCallBatch($id: ID!) {
recalculateCapitalCallBatch(id: $id) {
id
status
calculationConfig {
...CapitalCallBatchCalculationConfigFragment
}
createdAt
noticeDate
paymentDeadline
name
commentary
capitalCommitted {
...HighPrecisionMoneyFragment
}
capitalCalled {
...HighPrecisionMoneyFragment
}
capitalCalledToDate {
...HighPrecisionMoneyFragment
}
capitalRemainingToBeCalled {
...HighPrecisionMoneyFragment
}
capitalCallStatusCounts {
...CapitalCallBatchStatusCountFragment
}
failureMessages {
...CapitalCallBatchFailureFragment
}
capitalCalls {
...CapitalCallConnectionFragment
}
isOutdated
emailNotificationsEnabled
publishNoticeToInvestorPortalEnabled
}
}
Variables
{"id": "4"}
Response
{
"data": {
"recalculateCapitalCallBatch": {
"id": 4,
"status": "GENERATING",
"calculationConfig": CapitalCallBatchCalculationConfig,
"createdAt": "2007-12-03T10:15:30Z",
"noticeDate": "2007-12-03T10:15:30Z",
"paymentDeadline": "2007-12-03T10:15:30Z",
"name": "abc123",
"commentary": "xyz789",
"capitalCommitted": HighPrecisionMoney,
"capitalCalled": HighPrecisionMoney,
"capitalCalledToDate": HighPrecisionMoney,
"capitalRemainingToBeCalled": HighPrecisionMoney,
"capitalCallStatusCounts": [
CapitalCallBatchStatusCount
],
"failureMessages": [CapitalCallBatchFailure],
"capitalCalls": CapitalCallConnection,
"isOutdated": false,
"emailNotificationsEnabled": true,
"publishNoticeToInvestorPortalEnabled": false
}
}
}
recalculateDistribution
Description
Recalculate the values for a distribution
Response
Returns a DistributionV2!
Arguments
| Name | Description |
|---|---|
distributionId - ID!
|
Example
Query
mutation recalculateDistribution($distributionId: ID!) {
recalculateDistribution(distributionId: $distributionId) {
id
status
source
name
fund {
...FundFragment
}
lastCalculated
periodFrom
periodTo
paymentDate
grossDistribution {
...MoneyFragment
}
netDistribution {
...MoneyFragment
}
taxWithheld {
...MoneyFragment
}
totalReinvestment {
...MoneyFragment
}
withheldCount
disabledCount
reinvestmentCount
statementCommentary
components {
... on PercentageDistributionComponent {
...PercentageDistributionComponentFragment
}
... on TotalDollarAmountDistributionComponent {
...TotalDollarAmountDistributionComponentFragment
}
... on CentsPerUnitDistributionComponent {
...CentsPerUnitDistributionComponentFragment
}
... on UnitClassDistributionRatesDistributionComponent {
...UnitClassDistributionRatesDistributionComponentFragment
}
}
summaryForHoldings {
...DistributionSummaryFragment
}
confirmedBy {
...AdminUserFragment
}
confirmedAt
publishedAt
dateOfIssuance
notificationsEnabled
statementsEnabled
reinvestmentRoundingResidual {
...MoneyFragment
}
}
}
Variables
{"distributionId": 4}
Response
{
"data": {
"recalculateDistribution": {
"id": 4,
"status": "DRAFT",
"source": "SYSTEM",
"name": "abc123",
"fund": Fund,
"lastCalculated": "2007-12-03T10:15:30Z",
"periodFrom": "2007-12-03T10:15:30Z",
"periodTo": "2007-12-03T10:15:30Z",
"paymentDate": "2007-12-03T10:15:30Z",
"grossDistribution": Money,
"netDistribution": Money,
"taxWithheld": Money,
"totalReinvestment": Money,
"withheldCount": 987,
"disabledCount": 123,
"reinvestmentCount": 123,
"statementCommentary": "abc123",
"components": [PercentageDistributionComponent],
"summaryForHoldings": [DistributionSummary],
"confirmedBy": AdminUser,
"confirmedAt": "2007-12-03T10:15:30Z",
"publishedAt": "2007-12-03T10:15:30Z",
"dateOfIssuance": "2007-12-03T10:15:30Z",
"notificationsEnabled": false,
"statementsEnabled": true,
"reinvestmentRoundingResidual": Money
}
}
}
reconcileDeposit
Description
Reconcile a deposit against an allocation
Response
Returns a Void!
Arguments
| Name | Description |
|---|---|
form - ReconcileDepositInput!
|
Example
Query
mutation reconcileDeposit($form: ReconcileDepositInput!) {
reconcileDeposit(form: $form)
}
Variables
{"form": ReconcileDepositInput}
Response
{"data": {"reconcileDeposit": null}}
removeInvestingEntityAccountLink
Description
Remove a linked account from an investing entity
Response
Returns an InvestingEntity!
Arguments
| Name | Description |
|---|---|
form - RemoveInvestingEntityAccountLinkInput!
|
Example
Query
mutation removeInvestingEntityAccountLink($form: RemoveInvestingEntityAccountLinkInput!) {
removeInvestingEntityAccountLink(form: $form) {
id
created
updated
entityType
entity {
... on IndividualInvestingEntity {
...IndividualInvestingEntityFragment
}
... on CompanyInvestingEntity {
...CompanyInvestingEntityFragment
}
... on TrustInvestingEntity {
...TrustInvestingEntityFragment
}
... on JointIndividualInvestingEntity {
...JointIndividualInvestingEntityFragment
}
... on PartnershipInvestingEntity {
...PartnershipInvestingEntityFragment
}
}
sourceOfFundsVerificationEmailLastSent
relationship
country {
...CountryFragment
}
bankAccounts {
...VerifiableBankAccountFragment
}
bankAccount {
...VerifiableBankAccountFragment
}
accreditationsStandardised {
...InvestingEntityStandardisedAccreditationFragment
}
accreditationCountry {
...CountryFragment
}
wholesaleCertificationStatus
primaryOwner {
...AccountFragment
}
accounts {
...AccountFragment
}
beneficialOwners {
...BeneficialOwnerFragment
}
beneficialOwner {
...BeneficialOwnerFragment
}
lastRequestedBeneficialOwnersContactDetails
lastRequestedWholesaleCertification
allocations {
...AllocationFragment
}
riskProfile {
...RiskProfileFragment
}
holdings {
...HoldingFragment
}
totalPortfolioValue {
...MoneyFragment
}
totalHoldingMarkedValue {
...MoneyFragment
}
totalCapitalContributed {
...MoneyFragment
}
searchActivityFeed {
...ActivityFeedResultsFragment
}
governingDocuments {
...InvestingEntityGoverningDocumentFragment
}
searchTransactionsV2 {
...SearchTransactionsResultsFragment
}
outstandingTaskCount
bankAccountVerificationStatus
sourceOfFundsVerificationStatus
outstandingTasks {
...TaskFragment
}
outstandingNotifications {
...InvestingEntityNotificationFragment
}
associatedAccounts {
...AssociatedAccountFragment
}
tags {
...InvestingEntityTagFragment
}
}
}
Variables
{"form": RemoveInvestingEntityAccountLinkInput}
Response
{
"data": {
"removeInvestingEntityAccountLink": {
"id": 4,
"created": "2007-12-03T10:15:30Z",
"updated": "2007-12-03T10:15:30Z",
"entityType": "INDIVIDUAL",
"entity": IndividualInvestingEntity,
"sourceOfFundsVerificationEmailLastSent": "2007-12-03T10:15:30Z",
"relationship": "SHAREHOLDING_VOTING_RIGHTS_GREATER_THAN_25_PERCENT",
"country": Country,
"bankAccounts": [VerifiableBankAccount],
"bankAccount": VerifiableBankAccount,
"accreditationsStandardised": [
InvestingEntityStandardisedAccreditation
],
"accreditationCountry": Country,
"wholesaleCertificationStatus": "AWAITING",
"primaryOwner": Account,
"accounts": [Account],
"beneficialOwners": [BeneficialOwner],
"beneficialOwner": BeneficialOwner,
"lastRequestedBeneficialOwnersContactDetails": "2007-12-03T10:15:30Z",
"lastRequestedWholesaleCertification": "2007-12-03T10:15:30Z",
"allocations": [Allocation],
"riskProfile": RiskProfile,
"holdings": [Holding],
"totalPortfolioValue": Money,
"totalHoldingMarkedValue": Money,
"totalCapitalContributed": Money,
"searchActivityFeed": ActivityFeedResults,
"governingDocuments": [
InvestingEntityGoverningDocument
],
"searchTransactionsV2": SearchTransactionsResults,
"outstandingTaskCount": 987,
"bankAccountVerificationStatus": "PENDING",
"sourceOfFundsVerificationStatus": "COMPLETE",
"outstandingTasks": [Task],
"outstandingNotifications": [
InvestingEntityNotification
],
"associatedAccounts": [AssociatedAccount],
"tags": [InvestingEntityTag]
}
}
}
removeRelatedTasks
Description
Remove related tasks from a task
Response
Returns a Task!
Arguments
| Name | Description |
|---|---|
form - RemoveRelatedTasksInput!
|
Example
Query
mutation removeRelatedTasks($form: RemoveRelatedTasksInput!) {
removeRelatedTasks(form: $form) {
id
title
created
updated
dueAt
status
assignedAdmin {
...AdminUserFragment
}
notes {
...NoteFragment
}
documents {
...TaskDocumentFragment
}
priority
relatedTasks {
...TaskFragment
}
assignedTeam
}
}
Variables
{"form": RemoveRelatedTasksInput}
Response
{
"data": {
"removeRelatedTasks": {
"id": 4,
"title": "abc123",
"created": "2007-12-03T10:15:30Z",
"updated": "2007-12-03T10:15:30Z",
"dueAt": "2007-12-03T10:15:30Z",
"status": "OPEN",
"assignedAdmin": AdminUser,
"notes": [Note],
"documents": [TaskDocument],
"priority": "NO_PRIORITY",
"relatedTasks": [Task],
"assignedTeam": "UNASSIGNED"
}
}
}
requestAccountIdentityVerification
Response
Returns an Account!
Arguments
| Name | Description |
|---|---|
form - RequestAccountIdentityVerificationInput!
|
Example
Query
mutation requestAccountIdentityVerification($form: RequestAccountIdentityVerificationInput!) {
requestAccountIdentityVerification(form: $form) {
id
created
updated
lastLoggedIn
email
hasPasswordSet
activationEmailLastSent
legalName {
...LegalNameFragment
}
preferredName
timeZone
dateOfBirth {
...DayMonthYearFragment
}
termsAgreed
isAccountLocked
accountLockedReason
addresses {
...VerifiableAddressFragment
}
phoneNumber {
...PhoneNumberFragment
}
emailConfirmed
status
setupStatus {
...AccountSetupStatusFragment
}
investingEntities {
...InvestingEntityFragment
}
identityVerifications {
...IdentityVerificationFragment
}
pepSearchResult {
...PEPSearchResultFragment
}
notes {
...NoteFragment
}
searchActivityFeed {
...ActivityFeedResultsFragment
}
totalPortfolioValue {
...MoneyFragment
}
jobTitle
industry
organization
twitterProfileUrl
linkedInProfileUrl
biography
accountManager {
...AdminUserFragment
}
tagsV2 {
...InvestorProfileTagFragment
}
connections {
...ConnectionFragment
}
outstandingTasks {
...TaskFragment
}
outstandingNotifications {
...AccountNotificationFragment
}
identityVerificationStatus
allHoldingsCSVUrl
identityVerificationLastSent
}
}
Variables
{"form": RequestAccountIdentityVerificationInput}
Response
{
"data": {
"requestAccountIdentityVerification": {
"id": 4,
"created": "2007-12-03T10:15:30Z",
"updated": "2007-12-03T10:15:30Z",
"lastLoggedIn": "2007-12-03T10:15:30Z",
"email": "abc123",
"hasPasswordSet": true,
"activationEmailLastSent": "2007-12-03T10:15:30Z",
"legalName": LegalName,
"preferredName": "xyz789",
"timeZone": "abc123",
"dateOfBirth": DayMonthYear,
"termsAgreed": true,
"isAccountLocked": true,
"accountLockedReason": "xyz789",
"addresses": [VerifiableAddress],
"phoneNumber": PhoneNumber,
"emailConfirmed": true,
"status": "PENDING",
"setupStatus": AccountSetupStatus,
"investingEntities": [InvestingEntity],
"identityVerifications": [IdentityVerification],
"pepSearchResult": PEPSearchResult,
"notes": [Note],
"searchActivityFeed": ActivityFeedResults,
"totalPortfolioValue": Money,
"jobTitle": "abc123",
"industry": "abc123",
"organization": "abc123",
"twitterProfileUrl": "http://www.test.com/",
"linkedInProfileUrl": "http://www.test.com/",
"biography": "abc123",
"accountManager": AdminUser,
"tagsV2": [InvestorProfileTag],
"connections": [Connection],
"outstandingTasks": [Task],
"outstandingNotifications": [AccountNotification],
"identityVerificationStatus": "INCOMPLETE",
"allHoldingsCSVUrl": "abc123",
"identityVerificationLastSent": "2007-12-03T10:15:30Z"
}
}
}
requestBeneficialOwnerVerification
Description
Request the identity verification for a given beneficial owner - returns ContactInfomationRequired error if contact hasn't been filled out
Response
Returns a BeneficialOwner!
Arguments
| Name | Description |
|---|---|
form - RequestBeneficialOwnerVerificationInput!
|
Example
Query
mutation requestBeneficialOwnerVerification($form: RequestBeneficialOwnerVerificationInput!) {
requestBeneficialOwnerVerification(form: $form) {
id
created
relationship
nodes {
...BeneficialOwnerFragment
}
notes {
...NoteFragment
}
activity {
...ActivityMessageFragment
}
uploadedDocuments {
...UploadedDocumentFragment
}
parent {
... on EntityBeneficialOwner {
...EntityBeneficialOwnerFragment
}
... on InvestingEntity {
...InvestingEntityFragment
}
}
}
}
Variables
{"form": RequestBeneficialOwnerVerificationInput}
Response
{
"data": {
"requestBeneficialOwnerVerification": {
"id": "4",
"created": "2007-12-03T10:15:30Z",
"relationship": "DIRECTOR",
"nodes": [BeneficialOwner],
"notes": [Note],
"activity": [ActivityMessage],
"uploadedDocuments": [UploadedDocument],
"parent": EntityBeneficialOwner
}
}
}
requestBeneficialOwnersContactDetails
Description
Request the contact details of all beneficial owners for a given investing entity
Response
Returns an InvestingEntity!
Arguments
| Name | Description |
|---|---|
form - RequestBeneficialOwnersContactDetailsInput!
|
Example
Query
mutation requestBeneficialOwnersContactDetails($form: RequestBeneficialOwnersContactDetailsInput!) {
requestBeneficialOwnersContactDetails(form: $form) {
id
created
updated
entityType
entity {
... on IndividualInvestingEntity {
...IndividualInvestingEntityFragment
}
... on CompanyInvestingEntity {
...CompanyInvestingEntityFragment
}
... on TrustInvestingEntity {
...TrustInvestingEntityFragment
}
... on JointIndividualInvestingEntity {
...JointIndividualInvestingEntityFragment
}
... on PartnershipInvestingEntity {
...PartnershipInvestingEntityFragment
}
}
sourceOfFundsVerificationEmailLastSent
relationship
country {
...CountryFragment
}
bankAccounts {
...VerifiableBankAccountFragment
}
bankAccount {
...VerifiableBankAccountFragment
}
accreditationsStandardised {
...InvestingEntityStandardisedAccreditationFragment
}
accreditationCountry {
...CountryFragment
}
wholesaleCertificationStatus
primaryOwner {
...AccountFragment
}
accounts {
...AccountFragment
}
beneficialOwners {
...BeneficialOwnerFragment
}
beneficialOwner {
...BeneficialOwnerFragment
}
lastRequestedBeneficialOwnersContactDetails
lastRequestedWholesaleCertification
allocations {
...AllocationFragment
}
riskProfile {
...RiskProfileFragment
}
holdings {
...HoldingFragment
}
totalPortfolioValue {
...MoneyFragment
}
totalHoldingMarkedValue {
...MoneyFragment
}
totalCapitalContributed {
...MoneyFragment
}
searchActivityFeed {
...ActivityFeedResultsFragment
}
governingDocuments {
...InvestingEntityGoverningDocumentFragment
}
searchTransactionsV2 {
...SearchTransactionsResultsFragment
}
outstandingTaskCount
bankAccountVerificationStatus
sourceOfFundsVerificationStatus
outstandingTasks {
...TaskFragment
}
outstandingNotifications {
...InvestingEntityNotificationFragment
}
associatedAccounts {
...AssociatedAccountFragment
}
tags {
...InvestingEntityTagFragment
}
}
}
Variables
{"form": RequestBeneficialOwnersContactDetailsInput}
Response
{
"data": {
"requestBeneficialOwnersContactDetails": {
"id": "4",
"created": "2007-12-03T10:15:30Z",
"updated": "2007-12-03T10:15:30Z",
"entityType": "INDIVIDUAL",
"entity": IndividualInvestingEntity,
"sourceOfFundsVerificationEmailLastSent": "2007-12-03T10:15:30Z",
"relationship": "SHAREHOLDING_VOTING_RIGHTS_GREATER_THAN_25_PERCENT",
"country": Country,
"bankAccounts": [VerifiableBankAccount],
"bankAccount": VerifiableBankAccount,
"accreditationsStandardised": [
InvestingEntityStandardisedAccreditation
],
"accreditationCountry": Country,
"wholesaleCertificationStatus": "AWAITING",
"primaryOwner": Account,
"accounts": [Account],
"beneficialOwners": [BeneficialOwner],
"beneficialOwner": BeneficialOwner,
"lastRequestedBeneficialOwnersContactDetails": "2007-12-03T10:15:30Z",
"lastRequestedWholesaleCertification": "2007-12-03T10:15:30Z",
"allocations": [Allocation],
"riskProfile": RiskProfile,
"holdings": [Holding],
"totalPortfolioValue": Money,
"totalHoldingMarkedValue": Money,
"totalCapitalContributed": Money,
"searchActivityFeed": ActivityFeedResults,
"governingDocuments": [
InvestingEntityGoverningDocument
],
"searchTransactionsV2": SearchTransactionsResults,
"outstandingTaskCount": 987,
"bankAccountVerificationStatus": "PENDING",
"sourceOfFundsVerificationStatus": "COMPLETE",
"outstandingTasks": [Task],
"outstandingNotifications": [
InvestingEntityNotification
],
"associatedAccounts": [AssociatedAccount],
"tags": [InvestingEntityTag]
}
}
}
requestWholesaleCertification
Description
Request a wholesale certificate for an investing entity
Response
Returns an InvestingEntity!
Arguments
| Name | Description |
|---|---|
form - RequestWholesaleCertificationInput!
|
Example
Query
mutation requestWholesaleCertification($form: RequestWholesaleCertificationInput!) {
requestWholesaleCertification(form: $form) {
id
created
updated
entityType
entity {
... on IndividualInvestingEntity {
...IndividualInvestingEntityFragment
}
... on CompanyInvestingEntity {
...CompanyInvestingEntityFragment
}
... on TrustInvestingEntity {
...TrustInvestingEntityFragment
}
... on JointIndividualInvestingEntity {
...JointIndividualInvestingEntityFragment
}
... on PartnershipInvestingEntity {
...PartnershipInvestingEntityFragment
}
}
sourceOfFundsVerificationEmailLastSent
relationship
country {
...CountryFragment
}
bankAccounts {
...VerifiableBankAccountFragment
}
bankAccount {
...VerifiableBankAccountFragment
}
accreditationsStandardised {
...InvestingEntityStandardisedAccreditationFragment
}
accreditationCountry {
...CountryFragment
}
wholesaleCertificationStatus
primaryOwner {
...AccountFragment
}
accounts {
...AccountFragment
}
beneficialOwners {
...BeneficialOwnerFragment
}
beneficialOwner {
...BeneficialOwnerFragment
}
lastRequestedBeneficialOwnersContactDetails
lastRequestedWholesaleCertification
allocations {
...AllocationFragment
}
riskProfile {
...RiskProfileFragment
}
holdings {
...HoldingFragment
}
totalPortfolioValue {
...MoneyFragment
}
totalHoldingMarkedValue {
...MoneyFragment
}
totalCapitalContributed {
...MoneyFragment
}
searchActivityFeed {
...ActivityFeedResultsFragment
}
governingDocuments {
...InvestingEntityGoverningDocumentFragment
}
searchTransactionsV2 {
...SearchTransactionsResultsFragment
}
outstandingTaskCount
bankAccountVerificationStatus
sourceOfFundsVerificationStatus
outstandingTasks {
...TaskFragment
}
outstandingNotifications {
...InvestingEntityNotificationFragment
}
associatedAccounts {
...AssociatedAccountFragment
}
tags {
...InvestingEntityTagFragment
}
}
}
Variables
{"form": RequestWholesaleCertificationInput}
Response
{
"data": {
"requestWholesaleCertification": {
"id": 4,
"created": "2007-12-03T10:15:30Z",
"updated": "2007-12-03T10:15:30Z",
"entityType": "INDIVIDUAL",
"entity": IndividualInvestingEntity,
"sourceOfFundsVerificationEmailLastSent": "2007-12-03T10:15:30Z",
"relationship": "SHAREHOLDING_VOTING_RIGHTS_GREATER_THAN_25_PERCENT",
"country": Country,
"bankAccounts": [VerifiableBankAccount],
"bankAccount": VerifiableBankAccount,
"accreditationsStandardised": [
InvestingEntityStandardisedAccreditation
],
"accreditationCountry": Country,
"wholesaleCertificationStatus": "AWAITING",
"primaryOwner": Account,
"accounts": [Account],
"beneficialOwners": [BeneficialOwner],
"beneficialOwner": BeneficialOwner,
"lastRequestedBeneficialOwnersContactDetails": "2007-12-03T10:15:30Z",
"lastRequestedWholesaleCertification": "2007-12-03T10:15:30Z",
"allocations": [Allocation],
"riskProfile": RiskProfile,
"holdings": [Holding],
"totalPortfolioValue": Money,
"totalHoldingMarkedValue": Money,
"totalCapitalContributed": Money,
"searchActivityFeed": ActivityFeedResults,
"governingDocuments": [
InvestingEntityGoverningDocument
],
"searchTransactionsV2": SearchTransactionsResults,
"outstandingTaskCount": 123,
"bankAccountVerificationStatus": "PENDING",
"sourceOfFundsVerificationStatus": "COMPLETE",
"outstandingTasks": [Task],
"outstandingNotifications": [
InvestingEntityNotification
],
"associatedAccounts": [AssociatedAccount],
"tags": [InvestingEntityTag]
}
}
}
saveEmailBatchTemplate
Description
Save the email template for a batch.
Response
Returns a SaveEmailBatchTemplateResponse!
Arguments
| Name | Description |
|---|---|
form - SaveEmailBatchTemplateInput!
|
Example
Query
mutation saveEmailBatchTemplate($form: SaveEmailBatchTemplateInput!) {
saveEmailBatchTemplate(form: $form) {
... on EmailBatch {
...EmailBatchFragment
}
}
}
Variables
{"form": SaveEmailBatchTemplateInput}
Response
{"data": {"saveEmailBatchTemplate": EmailBatch}}
sendEmailAddressConfirmation
Description
Send email address confirmation email message to the account's current email address
Response
Returns an Account!
Arguments
| Name | Description |
|---|---|
form - SendEmailAddressConfirmationInput!
|
Example
Query
mutation sendEmailAddressConfirmation($form: SendEmailAddressConfirmationInput!) {
sendEmailAddressConfirmation(form: $form) {
id
created
updated
lastLoggedIn
email
hasPasswordSet
activationEmailLastSent
legalName {
...LegalNameFragment
}
preferredName
timeZone
dateOfBirth {
...DayMonthYearFragment
}
termsAgreed
isAccountLocked
accountLockedReason
addresses {
...VerifiableAddressFragment
}
phoneNumber {
...PhoneNumberFragment
}
emailConfirmed
status
setupStatus {
...AccountSetupStatusFragment
}
investingEntities {
...InvestingEntityFragment
}
identityVerifications {
...IdentityVerificationFragment
}
pepSearchResult {
...PEPSearchResultFragment
}
notes {
...NoteFragment
}
searchActivityFeed {
...ActivityFeedResultsFragment
}
totalPortfolioValue {
...MoneyFragment
}
jobTitle
industry
organization
twitterProfileUrl
linkedInProfileUrl
biography
accountManager {
...AdminUserFragment
}
tagsV2 {
...InvestorProfileTagFragment
}
connections {
...ConnectionFragment
}
outstandingTasks {
...TaskFragment
}
outstandingNotifications {
...AccountNotificationFragment
}
identityVerificationStatus
allHoldingsCSVUrl
identityVerificationLastSent
}
}
Variables
{"form": SendEmailAddressConfirmationInput}
Response
{
"data": {
"sendEmailAddressConfirmation": {
"id": 4,
"created": "2007-12-03T10:15:30Z",
"updated": "2007-12-03T10:15:30Z",
"lastLoggedIn": "2007-12-03T10:15:30Z",
"email": "abc123",
"hasPasswordSet": false,
"activationEmailLastSent": "2007-12-03T10:15:30Z",
"legalName": LegalName,
"preferredName": "abc123",
"timeZone": "abc123",
"dateOfBirth": DayMonthYear,
"termsAgreed": true,
"isAccountLocked": false,
"accountLockedReason": "abc123",
"addresses": [VerifiableAddress],
"phoneNumber": PhoneNumber,
"emailConfirmed": true,
"status": "PENDING",
"setupStatus": AccountSetupStatus,
"investingEntities": [InvestingEntity],
"identityVerifications": [IdentityVerification],
"pepSearchResult": PEPSearchResult,
"notes": [Note],
"searchActivityFeed": ActivityFeedResults,
"totalPortfolioValue": Money,
"jobTitle": "xyz789",
"industry": "abc123",
"organization": "abc123",
"twitterProfileUrl": "http://www.test.com/",
"linkedInProfileUrl": "http://www.test.com/",
"biography": "abc123",
"accountManager": AdminUser,
"tagsV2": [InvestorProfileTag],
"connections": [Connection],
"outstandingTasks": [Task],
"outstandingNotifications": [AccountNotification],
"identityVerificationStatus": "INCOMPLETE",
"allHoldingsCSVUrl": "abc123",
"identityVerificationLastSent": "2007-12-03T10:15:30Z"
}
}
}
sendPasswordResetEmail
Description
Send password reset email message to an investor who has previously set a password
Response
Returns an Account!
Arguments
| Name | Description |
|---|---|
form - SendPasswordResetEmailInput!
|
Example
Query
mutation sendPasswordResetEmail($form: SendPasswordResetEmailInput!) {
sendPasswordResetEmail(form: $form) {
id
created
updated
lastLoggedIn
email
hasPasswordSet
activationEmailLastSent
legalName {
...LegalNameFragment
}
preferredName
timeZone
dateOfBirth {
...DayMonthYearFragment
}
termsAgreed
isAccountLocked
accountLockedReason
addresses {
...VerifiableAddressFragment
}
phoneNumber {
...PhoneNumberFragment
}
emailConfirmed
status
setupStatus {
...AccountSetupStatusFragment
}
investingEntities {
...InvestingEntityFragment
}
identityVerifications {
...IdentityVerificationFragment
}
pepSearchResult {
...PEPSearchResultFragment
}
notes {
...NoteFragment
}
searchActivityFeed {
...ActivityFeedResultsFragment
}
totalPortfolioValue {
...MoneyFragment
}
jobTitle
industry
organization
twitterProfileUrl
linkedInProfileUrl
biography
accountManager {
...AdminUserFragment
}
tagsV2 {
...InvestorProfileTagFragment
}
connections {
...ConnectionFragment
}
outstandingTasks {
...TaskFragment
}
outstandingNotifications {
...AccountNotificationFragment
}
identityVerificationStatus
allHoldingsCSVUrl
identityVerificationLastSent
}
}
Variables
{"form": SendPasswordResetEmailInput}
Response
{
"data": {
"sendPasswordResetEmail": {
"id": 4,
"created": "2007-12-03T10:15:30Z",
"updated": "2007-12-03T10:15:30Z",
"lastLoggedIn": "2007-12-03T10:15:30Z",
"email": "xyz789",
"hasPasswordSet": false,
"activationEmailLastSent": "2007-12-03T10:15:30Z",
"legalName": LegalName,
"preferredName": "abc123",
"timeZone": "xyz789",
"dateOfBirth": DayMonthYear,
"termsAgreed": true,
"isAccountLocked": false,
"accountLockedReason": "xyz789",
"addresses": [VerifiableAddress],
"phoneNumber": PhoneNumber,
"emailConfirmed": false,
"status": "PENDING",
"setupStatus": AccountSetupStatus,
"investingEntities": [InvestingEntity],
"identityVerifications": [IdentityVerification],
"pepSearchResult": PEPSearchResult,
"notes": [Note],
"searchActivityFeed": ActivityFeedResults,
"totalPortfolioValue": Money,
"jobTitle": "xyz789",
"industry": "xyz789",
"organization": "abc123",
"twitterProfileUrl": "http://www.test.com/",
"linkedInProfileUrl": "http://www.test.com/",
"biography": "abc123",
"accountManager": AdminUser,
"tagsV2": [InvestorProfileTag],
"connections": [Connection],
"outstandingTasks": [Task],
"outstandingNotifications": [AccountNotification],
"identityVerificationStatus": "INCOMPLETE",
"allHoldingsCSVUrl": "abc123",
"identityVerificationLastSent": "2007-12-03T10:15:30Z"
}
}
}
sendSetPasswordEmail
Description
Send an email to an investor, who has never set a password, to set a password for their account
Response
Returns an Account!
Arguments
| Name | Description |
|---|---|
form - SendSetPasswordEmailInput!
|
Example
Query
mutation sendSetPasswordEmail($form: SendSetPasswordEmailInput!) {
sendSetPasswordEmail(form: $form) {
id
created
updated
lastLoggedIn
email
hasPasswordSet
activationEmailLastSent
legalName {
...LegalNameFragment
}
preferredName
timeZone
dateOfBirth {
...DayMonthYearFragment
}
termsAgreed
isAccountLocked
accountLockedReason
addresses {
...VerifiableAddressFragment
}
phoneNumber {
...PhoneNumberFragment
}
emailConfirmed
status
setupStatus {
...AccountSetupStatusFragment
}
investingEntities {
...InvestingEntityFragment
}
identityVerifications {
...IdentityVerificationFragment
}
pepSearchResult {
...PEPSearchResultFragment
}
notes {
...NoteFragment
}
searchActivityFeed {
...ActivityFeedResultsFragment
}
totalPortfolioValue {
...MoneyFragment
}
jobTitle
industry
organization
twitterProfileUrl
linkedInProfileUrl
biography
accountManager {
...AdminUserFragment
}
tagsV2 {
...InvestorProfileTagFragment
}
connections {
...ConnectionFragment
}
outstandingTasks {
...TaskFragment
}
outstandingNotifications {
...AccountNotificationFragment
}
identityVerificationStatus
allHoldingsCSVUrl
identityVerificationLastSent
}
}
Variables
{"form": SendSetPasswordEmailInput}
Response
{
"data": {
"sendSetPasswordEmail": {
"id": 4,
"created": "2007-12-03T10:15:30Z",
"updated": "2007-12-03T10:15:30Z",
"lastLoggedIn": "2007-12-03T10:15:30Z",
"email": "xyz789",
"hasPasswordSet": false,
"activationEmailLastSent": "2007-12-03T10:15:30Z",
"legalName": LegalName,
"preferredName": "abc123",
"timeZone": "xyz789",
"dateOfBirth": DayMonthYear,
"termsAgreed": true,
"isAccountLocked": true,
"accountLockedReason": "xyz789",
"addresses": [VerifiableAddress],
"phoneNumber": PhoneNumber,
"emailConfirmed": true,
"status": "PENDING",
"setupStatus": AccountSetupStatus,
"investingEntities": [InvestingEntity],
"identityVerifications": [IdentityVerification],
"pepSearchResult": PEPSearchResult,
"notes": [Note],
"searchActivityFeed": ActivityFeedResults,
"totalPortfolioValue": Money,
"jobTitle": "abc123",
"industry": "abc123",
"organization": "xyz789",
"twitterProfileUrl": "http://www.test.com/",
"linkedInProfileUrl": "http://www.test.com/",
"biography": "abc123",
"accountManager": AdminUser,
"tagsV2": [InvestorProfileTag],
"connections": [Connection],
"outstandingTasks": [Task],
"outstandingNotifications": [AccountNotification],
"identityVerificationStatus": "INCOMPLETE",
"allHoldingsCSVUrl": "xyz789",
"identityVerificationLastSent": "2007-12-03T10:15:30Z"
}
}
}
transferUnits
Description
Manually transfer units from an existing holding to another investing entity
Response
Returns a Holding!
Arguments
| Name | Description |
|---|---|
form - TransferUnitsInput!
|
Example
Query
mutation transferUnits($form: TransferUnitsInput!) {
transferUnits(form: $form) {
id
createdAt
updatedAt
investingEntity {
...InvestingEntityFragment
}
markedValue {
...MoneyFragment
}
capitalContributed {
...MoneyFragment
}
capitalCommitted {
...MoneyFragment
}
unitCountDecimal {
...FixedPointNumberFragment
}
availableUnitCount {
...FixedPointNumberFragment
}
ownershipPercentage
unitClassOwnershipPercentage
cashDistributions {
...MoneyFragment
}
capitalReturns {
...MoneyFragment
}
bankAccount {
...VerifiableBankAccountFragment
}
redemptionBankAccount {
...VerifiableBankAccountFragment
}
fund {
...FundFragment
}
distributionSettings
distributionsWithheldAmount {
...MoneyFragment
}
withheldDistributions {
...WithheldDistributionFragment
}
unitClass {
...UnitClassFragment
}
reinvestmentUnitClass {
...UnitClassFragment
}
}
}
Variables
{"form": TransferUnitsInput}
Response
{
"data": {
"transferUnits": {
"id": "4",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"investingEntity": InvestingEntity,
"markedValue": Money,
"capitalContributed": Money,
"capitalCommitted": Money,
"unitCountDecimal": FixedPointNumber,
"availableUnitCount": FixedPointNumber,
"ownershipPercentage": 987.65,
"unitClassOwnershipPercentage": 123.45,
"cashDistributions": Money,
"capitalReturns": Money,
"bankAccount": VerifiableBankAccount,
"redemptionBankAccount": VerifiableBankAccount,
"fund": Fund,
"distributionSettings": "ENABLED",
"distributionsWithheldAmount": Money,
"withheldDistributions": [WithheldDistribution],
"unitClass": UnitClass,
"reinvestmentUnitClass": UnitClass
}
}
}
unlockAccount
Description
Unlocks the specied account - only if its locked
Response
Returns an Account!
Arguments
| Name | Description |
|---|---|
form - UnlockAccountInput!
|
Example
Query
mutation unlockAccount($form: UnlockAccountInput!) {
unlockAccount(form: $form) {
id
created
updated
lastLoggedIn
email
hasPasswordSet
activationEmailLastSent
legalName {
...LegalNameFragment
}
preferredName
timeZone
dateOfBirth {
...DayMonthYearFragment
}
termsAgreed
isAccountLocked
accountLockedReason
addresses {
...VerifiableAddressFragment
}
phoneNumber {
...PhoneNumberFragment
}
emailConfirmed
status
setupStatus {
...AccountSetupStatusFragment
}
investingEntities {
...InvestingEntityFragment
}
identityVerifications {
...IdentityVerificationFragment
}
pepSearchResult {
...PEPSearchResultFragment
}
notes {
...NoteFragment
}
searchActivityFeed {
...ActivityFeedResultsFragment
}
totalPortfolioValue {
...MoneyFragment
}
jobTitle
industry
organization
twitterProfileUrl
linkedInProfileUrl
biography
accountManager {
...AdminUserFragment
}
tagsV2 {
...InvestorProfileTagFragment
}
connections {
...ConnectionFragment
}
outstandingTasks {
...TaskFragment
}
outstandingNotifications {
...AccountNotificationFragment
}
identityVerificationStatus
allHoldingsCSVUrl
identityVerificationLastSent
}
}
Variables
{"form": UnlockAccountInput}
Response
{
"data": {
"unlockAccount": {
"id": "4",
"created": "2007-12-03T10:15:30Z",
"updated": "2007-12-03T10:15:30Z",
"lastLoggedIn": "2007-12-03T10:15:30Z",
"email": "xyz789",
"hasPasswordSet": true,
"activationEmailLastSent": "2007-12-03T10:15:30Z",
"legalName": LegalName,
"preferredName": "xyz789",
"timeZone": "abc123",
"dateOfBirth": DayMonthYear,
"termsAgreed": false,
"isAccountLocked": true,
"accountLockedReason": "xyz789",
"addresses": [VerifiableAddress],
"phoneNumber": PhoneNumber,
"emailConfirmed": true,
"status": "PENDING",
"setupStatus": AccountSetupStatus,
"investingEntities": [InvestingEntity],
"identityVerifications": [IdentityVerification],
"pepSearchResult": PEPSearchResult,
"notes": [Note],
"searchActivityFeed": ActivityFeedResults,
"totalPortfolioValue": Money,
"jobTitle": "abc123",
"industry": "xyz789",
"organization": "abc123",
"twitterProfileUrl": "http://www.test.com/",
"linkedInProfileUrl": "http://www.test.com/",
"biography": "xyz789",
"accountManager": AdminUser,
"tagsV2": [InvestorProfileTag],
"connections": [Connection],
"outstandingTasks": [Task],
"outstandingNotifications": [AccountNotification],
"identityVerificationStatus": "INCOMPLETE",
"allHoldingsCSVUrl": "xyz789",
"identityVerificationLastSent": "2007-12-03T10:15:30Z"
}
}
}
updateAccountProfile
Description
Update a specific account's profile
Response
Returns an Account!
Arguments
| Name | Description |
|---|---|
form - UpdateAccountProfileInput!
|
Example
Query
mutation updateAccountProfile($form: UpdateAccountProfileInput!) {
updateAccountProfile(form: $form) {
id
created
updated
lastLoggedIn
email
hasPasswordSet
activationEmailLastSent
legalName {
...LegalNameFragment
}
preferredName
timeZone
dateOfBirth {
...DayMonthYearFragment
}
termsAgreed
isAccountLocked
accountLockedReason
addresses {
...VerifiableAddressFragment
}
phoneNumber {
...PhoneNumberFragment
}
emailConfirmed
status
setupStatus {
...AccountSetupStatusFragment
}
investingEntities {
...InvestingEntityFragment
}
identityVerifications {
...IdentityVerificationFragment
}
pepSearchResult {
...PEPSearchResultFragment
}
notes {
...NoteFragment
}
searchActivityFeed {
...ActivityFeedResultsFragment
}
totalPortfolioValue {
...MoneyFragment
}
jobTitle
industry
organization
twitterProfileUrl
linkedInProfileUrl
biography
accountManager {
...AdminUserFragment
}
tagsV2 {
...InvestorProfileTagFragment
}
connections {
...ConnectionFragment
}
outstandingTasks {
...TaskFragment
}
outstandingNotifications {
...AccountNotificationFragment
}
identityVerificationStatus
allHoldingsCSVUrl
identityVerificationLastSent
}
}
Variables
{"form": UpdateAccountProfileInput}
Response
{
"data": {
"updateAccountProfile": {
"id": "4",
"created": "2007-12-03T10:15:30Z",
"updated": "2007-12-03T10:15:30Z",
"lastLoggedIn": "2007-12-03T10:15:30Z",
"email": "abc123",
"hasPasswordSet": true,
"activationEmailLastSent": "2007-12-03T10:15:30Z",
"legalName": LegalName,
"preferredName": "abc123",
"timeZone": "abc123",
"dateOfBirth": DayMonthYear,
"termsAgreed": false,
"isAccountLocked": false,
"accountLockedReason": "xyz789",
"addresses": [VerifiableAddress],
"phoneNumber": PhoneNumber,
"emailConfirmed": false,
"status": "PENDING",
"setupStatus": AccountSetupStatus,
"investingEntities": [InvestingEntity],
"identityVerifications": [IdentityVerification],
"pepSearchResult": PEPSearchResult,
"notes": [Note],
"searchActivityFeed": ActivityFeedResults,
"totalPortfolioValue": Money,
"jobTitle": "abc123",
"industry": "xyz789",
"organization": "xyz789",
"twitterProfileUrl": "http://www.test.com/",
"linkedInProfileUrl": "http://www.test.com/",
"biography": "abc123",
"accountManager": AdminUser,
"tagsV2": [InvestorProfileTag],
"connections": [Connection],
"outstandingTasks": [Task],
"outstandingNotifications": [AccountNotification],
"identityVerificationStatus": "INCOMPLETE",
"allHoldingsCSVUrl": "xyz789",
"identityVerificationLastSent": "2007-12-03T10:15:30Z"
}
}
}
updateAccreditationCertificate
Description
Update an existing accreditation certificate with new information
Response
Returns an InvestingEntityStandardisedAccreditation!
Arguments
| Name | Description |
|---|---|
form - UpdateAccreditationCertificateInput!
|
Example
Query
mutation updateAccreditationCertificate($form: UpdateAccreditationCertificateInput!) {
updateAccreditationCertificate(form: $form) {
id
updated
type
approvalStatus
country {
...CountryFragment
}
files {
...RemoteAssetFragment
}
signedAt
declinedReason
}
}
Variables
{"form": UpdateAccreditationCertificateInput}
Response
{
"data": {
"updateAccreditationCertificate": {
"id": "4",
"updated": "2007-12-03T10:15:30Z",
"type": "SAFE_HARBOUR",
"approvalStatus": "PENDING",
"country": Country,
"files": [RemoteAsset],
"signedAt": "2007-12-03T10:15:30Z",
"declinedReason": "abc123"
}
}
}
updateAdminUser
Description
Update admin user
Response
Returns an AdminUser!
Arguments
| Name | Description |
|---|---|
form - UpdateAdminUserInput!
|
Example
Query
mutation updateAdminUser($form: UpdateAdminUserInput!) {
updateAdminUser(form: $form) {
id
email
firstName
lastName
profileImageUrl
status
role {
...AdminRoleFragment
}
jobTitle
phoneNumber {
...PhoneNumberFragment
}
calendlyUrl
team
outstandingTasks
intercomHash
}
}
Variables
{"form": UpdateAdminUserInput}
Response
{
"data": {
"updateAdminUser": {
"id": "4",
"email": "xyz789",
"firstName": "xyz789",
"lastName": "xyz789",
"profileImageUrl": "xyz789",
"status": "ACTIVE",
"role": AdminRole,
"jobTitle": "xyz789",
"phoneNumber": PhoneNumber,
"calendlyUrl": "http://www.test.com/",
"team": "INVESTOR_RELATIONS",
"outstandingTasks": 123,
"intercomHash": "abc123"
}
}
}
updateAsset
Description
Modify an existing Asset
Response
Returns an Asset!
Arguments
| Name | Description |
|---|---|
form - UpdateAssetInput!
|
Example
Query
mutation updateAsset($form: UpdateAssetInput!) {
updateAsset(form: $form) {
id
name
address
country {
...CountryFragment
}
cardImage {
...RemoteAssetFragment
}
fund {
...FundFragment
}
}
}
Variables
{"form": UpdateAssetInput}
Response
{
"data": {
"updateAsset": {
"id": 4,
"name": "abc123",
"address": "abc123",
"country": Country,
"cardImage": RemoteAsset,
"fund": Fund
}
}
}
updateAssociatedAccountPreferences
Description
Update Account Preferences for an Investing Entity
Response
Returns an InvestingEntity!
Arguments
| Name | Description |
|---|---|
form - UpdateAssociatedAccountPreferencesInput!
|
Example
Query
mutation updateAssociatedAccountPreferences($form: UpdateAssociatedAccountPreferencesInput!) {
updateAssociatedAccountPreferences(form: $form) {
id
created
updated
entityType
entity {
... on IndividualInvestingEntity {
...IndividualInvestingEntityFragment
}
... on CompanyInvestingEntity {
...CompanyInvestingEntityFragment
}
... on TrustInvestingEntity {
...TrustInvestingEntityFragment
}
... on JointIndividualInvestingEntity {
...JointIndividualInvestingEntityFragment
}
... on PartnershipInvestingEntity {
...PartnershipInvestingEntityFragment
}
}
sourceOfFundsVerificationEmailLastSent
relationship
country {
...CountryFragment
}
bankAccounts {
...VerifiableBankAccountFragment
}
bankAccount {
...VerifiableBankAccountFragment
}
accreditationsStandardised {
...InvestingEntityStandardisedAccreditationFragment
}
accreditationCountry {
...CountryFragment
}
wholesaleCertificationStatus
primaryOwner {
...AccountFragment
}
accounts {
...AccountFragment
}
beneficialOwners {
...BeneficialOwnerFragment
}
beneficialOwner {
...BeneficialOwnerFragment
}
lastRequestedBeneficialOwnersContactDetails
lastRequestedWholesaleCertification
allocations {
...AllocationFragment
}
riskProfile {
...RiskProfileFragment
}
holdings {
...HoldingFragment
}
totalPortfolioValue {
...MoneyFragment
}
totalHoldingMarkedValue {
...MoneyFragment
}
totalCapitalContributed {
...MoneyFragment
}
searchActivityFeed {
...ActivityFeedResultsFragment
}
governingDocuments {
...InvestingEntityGoverningDocumentFragment
}
searchTransactionsV2 {
...SearchTransactionsResultsFragment
}
outstandingTaskCount
bankAccountVerificationStatus
sourceOfFundsVerificationStatus
outstandingTasks {
...TaskFragment
}
outstandingNotifications {
...InvestingEntityNotificationFragment
}
associatedAccounts {
...AssociatedAccountFragment
}
tags {
...InvestingEntityTagFragment
}
}
}
Variables
{"form": UpdateAssociatedAccountPreferencesInput}
Response
{
"data": {
"updateAssociatedAccountPreferences": {
"id": 4,
"created": "2007-12-03T10:15:30Z",
"updated": "2007-12-03T10:15:30Z",
"entityType": "INDIVIDUAL",
"entity": IndividualInvestingEntity,
"sourceOfFundsVerificationEmailLastSent": "2007-12-03T10:15:30Z",
"relationship": "SHAREHOLDING_VOTING_RIGHTS_GREATER_THAN_25_PERCENT",
"country": Country,
"bankAccounts": [VerifiableBankAccount],
"bankAccount": VerifiableBankAccount,
"accreditationsStandardised": [
InvestingEntityStandardisedAccreditation
],
"accreditationCountry": Country,
"wholesaleCertificationStatus": "AWAITING",
"primaryOwner": Account,
"accounts": [Account],
"beneficialOwners": [BeneficialOwner],
"beneficialOwner": BeneficialOwner,
"lastRequestedBeneficialOwnersContactDetails": "2007-12-03T10:15:30Z",
"lastRequestedWholesaleCertification": "2007-12-03T10:15:30Z",
"allocations": [Allocation],
"riskProfile": RiskProfile,
"holdings": [Holding],
"totalPortfolioValue": Money,
"totalHoldingMarkedValue": Money,
"totalCapitalContributed": Money,
"searchActivityFeed": ActivityFeedResults,
"governingDocuments": [
InvestingEntityGoverningDocument
],
"searchTransactionsV2": SearchTransactionsResults,
"outstandingTaskCount": 123,
"bankAccountVerificationStatus": "PENDING",
"sourceOfFundsVerificationStatus": "COMPLETE",
"outstandingTasks": [Task],
"outstandingNotifications": [
InvestingEntityNotification
],
"associatedAccounts": [AssociatedAccount],
"tags": [InvestingEntityTag]
}
}
}
updateBeneficialOwner
Description
Update fields on a beneficial owner
Response
Returns a BeneficialOwner!
Arguments
| Name | Description |
|---|---|
form - UpdateBeneficialOwnerInput!
|
Example
Query
mutation updateBeneficialOwner($form: UpdateBeneficialOwnerInput!) {
updateBeneficialOwner(form: $form) {
id
created
relationship
nodes {
...BeneficialOwnerFragment
}
notes {
...NoteFragment
}
activity {
...ActivityMessageFragment
}
uploadedDocuments {
...UploadedDocumentFragment
}
parent {
... on EntityBeneficialOwner {
...EntityBeneficialOwnerFragment
}
... on InvestingEntity {
...InvestingEntityFragment
}
}
}
}
Variables
{"form": UpdateBeneficialOwnerInput}
Response
{
"data": {
"updateBeneficialOwner": {
"id": 4,
"created": "2007-12-03T10:15:30Z",
"relationship": "DIRECTOR",
"nodes": [BeneficialOwner],
"notes": [Note],
"activity": [ActivityMessage],
"uploadedDocuments": [UploadedDocument],
"parent": EntityBeneficialOwner
}
}
}
updateBuyOrder
Response
Returns a Fund!
Arguments
| Name | Description |
|---|---|
form - UpdateBuyOrderInput!
|
Example
Query
mutation updateBuyOrder($form: UpdateBuyOrderInput!) {
updateBuyOrder(form: $form) {
id
createdAt
updatedAt
name
legalName
shortDescription
summary {
...FundSummaryFragment
}
registrationNumber
legalStructure
assetStructure
inception
currency {
...CurrencyFragment
}
country {
...CountryFragment
}
cardImage {
...RemoteAssetFragment
}
totalUnitCountDecimal {
...FixedPointNumberFragment
}
calculatedNetAssetValue {
...MoneyFragment
}
targetCashReturn {
...FractionFragment
}
targetTotalReturn {
...FractionFragment
}
documents {
...FundDocumentFragment
}
assets {
...AssetFragment
}
asset {
...AssetFragment
}
offers {
...OfferFragment
}
distributions {
...DistributionFragment
}
searchDistributions {
...DistributionSearchResultsFragment
}
distribution {
...DistributionFragment
}
distributionV2 {
...DistributionV2Fragment
}
validateDistribution {
... on InvalidBankAccountDistributionAlert {
...InvalidBankAccountDistributionAlertFragment
}
}
secondaryMarket {
...SecondaryMarketFragment
}
sellOrder {
...SellOrderFragment
}
sellOrders {
...SellOrderFragment
}
buyOrder {
...BuyOrderFragment
}
buyOrders {
...BuyOrderFragment
}
offerStatus
investorType
largestOwnershipPercentageV2
numberOfActiveHoldings
fundManagerName
lastDistributionDate
equityRaised {
...MoneyFragment
}
hideDistributionMetrics
searchUnitRedemptionRequests {
...UnitRedemptionRequestSearchResultsFragment
}
unitRedemptionRequest {
...UnitRedemptionRequestFragment
}
unitRedemptionConfiguration {
...FundUnitRedemptionConfigurationFragment
}
unitPrecisionScale
searchUnitClasses {
...UnitClassSearchResultsFragment
}
showHoldingPageOnInvestorPortal
customMetrics {
...CustomMetricFragment
}
investorPortalConfiguration {
...FundInvestorPortalConfigurationFragment
}
unitTransferRequest {
...UnitTransferRequestFragment
}
depositBankAccount {
...BankAccountFragment
}
searchOutgoingBankAccounts {
...FundOutgoingBankAccountSearchResultsFragment
}
}
}
Variables
{"form": UpdateBuyOrderInput}
Response
{
"data": {
"updateBuyOrder": {
"id": "4",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"name": "xyz789",
"legalName": "xyz789",
"shortDescription": "abc123",
"summary": FundSummary,
"registrationNumber": "xyz789",
"legalStructure": "LIMITED_PARTNERSHIP",
"assetStructure": "SINGLE_ASSET",
"inception": "2007-12-03T10:15:30Z",
"currency": Currency,
"country": Country,
"cardImage": RemoteAsset,
"totalUnitCountDecimal": FixedPointNumber,
"calculatedNetAssetValue": Money,
"targetCashReturn": Fraction,
"targetTotalReturn": Fraction,
"documents": [FundDocument],
"assets": [Asset],
"asset": Asset,
"offers": [Offer],
"distributions": [Distribution],
"searchDistributions": DistributionSearchResults,
"distribution": Distribution,
"distributionV2": DistributionV2,
"validateDistribution": [
InvalidBankAccountDistributionAlert
],
"secondaryMarket": SecondaryMarket,
"sellOrder": SellOrder,
"sellOrders": [SellOrder],
"buyOrder": BuyOrder,
"buyOrders": [BuyOrder],
"offerStatus": "OPEN",
"investorType": "WHOLESALE",
"largestOwnershipPercentageV2": 987.65,
"numberOfActiveHoldings": 987,
"fundManagerName": "xyz789",
"lastDistributionDate": "2007-12-03T10:15:30Z",
"equityRaised": Money,
"hideDistributionMetrics": false,
"searchUnitRedemptionRequests": UnitRedemptionRequestSearchResults,
"unitRedemptionRequest": UnitRedemptionRequest,
"unitRedemptionConfiguration": FundUnitRedemptionConfiguration,
"unitPrecisionScale": 987,
"searchUnitClasses": UnitClassSearchResults,
"showHoldingPageOnInvestorPortal": true,
"customMetrics": [CustomMetric],
"investorPortalConfiguration": FundInvestorPortalConfiguration,
"unitTransferRequest": UnitTransferRequest,
"depositBankAccount": BankAccount,
"searchOutgoingBankAccounts": FundOutgoingBankAccountSearchResults
}
}
}
updateCapitalCall
Description
Update a capital call
Response
Returns a CapitalCall!
Arguments
| Name | Description |
|---|---|
input - UpdateCapitalCallInput!
|
Example
Query
mutation updateCapitalCall($input: UpdateCapitalCallInput!) {
updateCapitalCall(input: $input) {
id
allocation {
...AllocationFragment
}
capitalCommitted {
...HighPrecisionMoneyFragment
}
capitalCalled {
...HighPrecisionMoneyFragment
}
equalisationAmount {
...HighPrecisionMoneyFragment
}
amountPayable {
...HighPrecisionMoneyFragment
}
capitalCalledToDate {
...HighPrecisionMoneyFragment
}
capitalCalledToDatePercentage
capitalRemainingToBeCalled {
...HighPrecisionMoneyFragment
}
failureMessages {
...CapitalCallFailureFragment
}
status
}
}
Variables
{"input": UpdateCapitalCallInput}
Response
{
"data": {
"updateCapitalCall": {
"id": 4,
"allocation": Allocation,
"capitalCommitted": HighPrecisionMoney,
"capitalCalled": HighPrecisionMoney,
"equalisationAmount": HighPrecisionMoney,
"amountPayable": HighPrecisionMoney,
"capitalCalledToDate": HighPrecisionMoney,
"capitalCalledToDatePercentage": 123.45,
"capitalRemainingToBeCalled": HighPrecisionMoney,
"failureMessages": [CapitalCallFailure],
"status": "GENERATING"
}
}
}
updateCapitalCallBatch
Description
Update a capital call batch
Response
Returns a CapitalCallBatch!
Arguments
| Name | Description |
|---|---|
input - UpdateCapitalCallBatchInput!
|
Example
Query
mutation updateCapitalCallBatch($input: UpdateCapitalCallBatchInput!) {
updateCapitalCallBatch(input: $input) {
id
status
calculationConfig {
...CapitalCallBatchCalculationConfigFragment
}
createdAt
noticeDate
paymentDeadline
name
commentary
capitalCommitted {
...HighPrecisionMoneyFragment
}
capitalCalled {
...HighPrecisionMoneyFragment
}
capitalCalledToDate {
...HighPrecisionMoneyFragment
}
capitalRemainingToBeCalled {
...HighPrecisionMoneyFragment
}
capitalCallStatusCounts {
...CapitalCallBatchStatusCountFragment
}
failureMessages {
...CapitalCallBatchFailureFragment
}
capitalCalls {
...CapitalCallConnectionFragment
}
isOutdated
emailNotificationsEnabled
publishNoticeToInvestorPortalEnabled
}
}
Variables
{"input": UpdateCapitalCallBatchInput}
Response
{
"data": {
"updateCapitalCallBatch": {
"id": "4",
"status": "GENERATING",
"calculationConfig": CapitalCallBatchCalculationConfig,
"createdAt": "2007-12-03T10:15:30Z",
"noticeDate": "2007-12-03T10:15:30Z",
"paymentDeadline": "2007-12-03T10:15:30Z",
"name": "xyz789",
"commentary": "abc123",
"capitalCommitted": HighPrecisionMoney,
"capitalCalled": HighPrecisionMoney,
"capitalCalledToDate": HighPrecisionMoney,
"capitalRemainingToBeCalled": HighPrecisionMoney,
"capitalCallStatusCounts": [
CapitalCallBatchStatusCount
],
"failureMessages": [CapitalCallBatchFailure],
"capitalCalls": CapitalCallConnection,
"isOutdated": true,
"emailNotificationsEnabled": true,
"publishNoticeToInvestorPortalEnabled": false
}
}
}
updateCompanyInvestingEntity
Description
Update an existing company investing entity
Response
Returns an Account!
Arguments
| Name | Description |
|---|---|
form - UpdateCompanyInvestingEntityInput!
|
Example
Query
mutation updateCompanyInvestingEntity($form: UpdateCompanyInvestingEntityInput!) {
updateCompanyInvestingEntity(form: $form) {
id
created
updated
lastLoggedIn
email
hasPasswordSet
activationEmailLastSent
legalName {
...LegalNameFragment
}
preferredName
timeZone
dateOfBirth {
...DayMonthYearFragment
}
termsAgreed
isAccountLocked
accountLockedReason
addresses {
...VerifiableAddressFragment
}
phoneNumber {
...PhoneNumberFragment
}
emailConfirmed
status
setupStatus {
...AccountSetupStatusFragment
}
investingEntities {
...InvestingEntityFragment
}
identityVerifications {
...IdentityVerificationFragment
}
pepSearchResult {
...PEPSearchResultFragment
}
notes {
...NoteFragment
}
searchActivityFeed {
...ActivityFeedResultsFragment
}
totalPortfolioValue {
...MoneyFragment
}
jobTitle
industry
organization
twitterProfileUrl
linkedInProfileUrl
biography
accountManager {
...AdminUserFragment
}
tagsV2 {
...InvestorProfileTagFragment
}
connections {
...ConnectionFragment
}
outstandingTasks {
...TaskFragment
}
outstandingNotifications {
...AccountNotificationFragment
}
identityVerificationStatus
allHoldingsCSVUrl
identityVerificationLastSent
}
}
Variables
{"form": UpdateCompanyInvestingEntityInput}
Response
{
"data": {
"updateCompanyInvestingEntity": {
"id": 4,
"created": "2007-12-03T10:15:30Z",
"updated": "2007-12-03T10:15:30Z",
"lastLoggedIn": "2007-12-03T10:15:30Z",
"email": "abc123",
"hasPasswordSet": false,
"activationEmailLastSent": "2007-12-03T10:15:30Z",
"legalName": LegalName,
"preferredName": "xyz789",
"timeZone": "xyz789",
"dateOfBirth": DayMonthYear,
"termsAgreed": false,
"isAccountLocked": true,
"accountLockedReason": "xyz789",
"addresses": [VerifiableAddress],
"phoneNumber": PhoneNumber,
"emailConfirmed": true,
"status": "PENDING",
"setupStatus": AccountSetupStatus,
"investingEntities": [InvestingEntity],
"identityVerifications": [IdentityVerification],
"pepSearchResult": PEPSearchResult,
"notes": [Note],
"searchActivityFeed": ActivityFeedResults,
"totalPortfolioValue": Money,
"jobTitle": "abc123",
"industry": "abc123",
"organization": "abc123",
"twitterProfileUrl": "http://www.test.com/",
"linkedInProfileUrl": "http://www.test.com/",
"biography": "xyz789",
"accountManager": AdminUser,
"tagsV2": [InvestorProfileTag],
"connections": [Connection],
"outstandingTasks": [Task],
"outstandingNotifications": [AccountNotification],
"identityVerificationStatus": "INCOMPLETE",
"allHoldingsCSVUrl": "xyz789",
"identityVerificationLastSent": "2007-12-03T10:15:30Z"
}
}
}
updateDepositMethod
Description
Update a deposit method
Response
Returns a DepositMethod!
Arguments
| Name | Description |
|---|---|
form - UpdateDepositMethodInput!
|
Example
Query
mutation updateDepositMethod($form: UpdateDepositMethodInput!) {
updateDepositMethod(form: $form) {
id
name
paymentMethod {
... on BankAccountV2 {
...BankAccountV2Fragment
}
... on Cheque {
...ChequeFragment
}
... on Bpay {
...BpayFragment
}
}
isLinked
}
}
Variables
{"form": UpdateDepositMethodInput}
Response
{
"data": {
"updateDepositMethod": {
"id": "4",
"name": "xyz789",
"paymentMethod": BankAccountV2,
"isLinked": true
}
}
}
updateDistribution
Description
Update an existing distribution for a fund
Response
Returns a DistributionV2!
Arguments
| Name | Description |
|---|---|
form - UpdateDistributionInput!
|
Example
Query
mutation updateDistribution($form: UpdateDistributionInput!) {
updateDistribution(form: $form) {
id
status
source
name
fund {
...FundFragment
}
lastCalculated
periodFrom
periodTo
paymentDate
grossDistribution {
...MoneyFragment
}
netDistribution {
...MoneyFragment
}
taxWithheld {
...MoneyFragment
}
totalReinvestment {
...MoneyFragment
}
withheldCount
disabledCount
reinvestmentCount
statementCommentary
components {
... on PercentageDistributionComponent {
...PercentageDistributionComponentFragment
}
... on TotalDollarAmountDistributionComponent {
...TotalDollarAmountDistributionComponentFragment
}
... on CentsPerUnitDistributionComponent {
...CentsPerUnitDistributionComponentFragment
}
... on UnitClassDistributionRatesDistributionComponent {
...UnitClassDistributionRatesDistributionComponentFragment
}
}
summaryForHoldings {
...DistributionSummaryFragment
}
confirmedBy {
...AdminUserFragment
}
confirmedAt
publishedAt
dateOfIssuance
notificationsEnabled
statementsEnabled
reinvestmentRoundingResidual {
...MoneyFragment
}
}
}
Variables
{"form": UpdateDistributionInput}
Response
{
"data": {
"updateDistribution": {
"id": 4,
"status": "DRAFT",
"source": "SYSTEM",
"name": "abc123",
"fund": Fund,
"lastCalculated": "2007-12-03T10:15:30Z",
"periodFrom": "2007-12-03T10:15:30Z",
"periodTo": "2007-12-03T10:15:30Z",
"paymentDate": "2007-12-03T10:15:30Z",
"grossDistribution": Money,
"netDistribution": Money,
"taxWithheld": Money,
"totalReinvestment": Money,
"withheldCount": 987,
"disabledCount": 123,
"reinvestmentCount": 123,
"statementCommentary": "abc123",
"components": [PercentageDistributionComponent],
"summaryForHoldings": [DistributionSummary],
"confirmedBy": AdminUser,
"confirmedAt": "2007-12-03T10:15:30Z",
"publishedAt": "2007-12-03T10:15:30Z",
"dateOfIssuance": "2007-12-03T10:15:30Z",
"notificationsEnabled": true,
"statementsEnabled": false,
"reinvestmentRoundingResidual": Money
}
}
}
updateEmailTemplate
Description
Update an existing email template
Response
Returns an EmailTemplate!
Arguments
| Name | Description |
|---|---|
form - UpdateEmailTemplateInput!
|
Example
Query
mutation updateEmailTemplate($form: UpdateEmailTemplateInput!) {
updateEmailTemplate(form: $form) {
id
createdAt
name
template
fund {
...FundFragment
}
contextLinkTypes
}
}
Variables
{"form": UpdateEmailTemplateInput}
Response
{
"data": {
"updateEmailTemplate": {
"id": 4,
"createdAt": "2007-12-03T10:15:30Z",
"name": "xyz789",
"template": "abc123",
"fund": Fund,
"contextLinkTypes": ["FUND"]
}
}
}
updateFund
Description
Modify an existing Fund
Response
Returns a Fund!
Arguments
| Name | Description |
|---|---|
form - UpdateFundInput!
|
Example
Query
mutation updateFund($form: UpdateFundInput!) {
updateFund(form: $form) {
id
createdAt
updatedAt
name
legalName
shortDescription
summary {
...FundSummaryFragment
}
registrationNumber
legalStructure
assetStructure
inception
currency {
...CurrencyFragment
}
country {
...CountryFragment
}
cardImage {
...RemoteAssetFragment
}
totalUnitCountDecimal {
...FixedPointNumberFragment
}
calculatedNetAssetValue {
...MoneyFragment
}
targetCashReturn {
...FractionFragment
}
targetTotalReturn {
...FractionFragment
}
documents {
...FundDocumentFragment
}
assets {
...AssetFragment
}
asset {
...AssetFragment
}
offers {
...OfferFragment
}
distributions {
...DistributionFragment
}
searchDistributions {
...DistributionSearchResultsFragment
}
distribution {
...DistributionFragment
}
distributionV2 {
...DistributionV2Fragment
}
validateDistribution {
... on InvalidBankAccountDistributionAlert {
...InvalidBankAccountDistributionAlertFragment
}
}
secondaryMarket {
...SecondaryMarketFragment
}
sellOrder {
...SellOrderFragment
}
sellOrders {
...SellOrderFragment
}
buyOrder {
...BuyOrderFragment
}
buyOrders {
...BuyOrderFragment
}
offerStatus
investorType
largestOwnershipPercentageV2
numberOfActiveHoldings
fundManagerName
lastDistributionDate
equityRaised {
...MoneyFragment
}
hideDistributionMetrics
searchUnitRedemptionRequests {
...UnitRedemptionRequestSearchResultsFragment
}
unitRedemptionRequest {
...UnitRedemptionRequestFragment
}
unitRedemptionConfiguration {
...FundUnitRedemptionConfigurationFragment
}
unitPrecisionScale
searchUnitClasses {
...UnitClassSearchResultsFragment
}
showHoldingPageOnInvestorPortal
customMetrics {
...CustomMetricFragment
}
investorPortalConfiguration {
...FundInvestorPortalConfigurationFragment
}
unitTransferRequest {
...UnitTransferRequestFragment
}
depositBankAccount {
...BankAccountFragment
}
searchOutgoingBankAccounts {
...FundOutgoingBankAccountSearchResultsFragment
}
}
}
Variables
{"form": UpdateFundInput}
Response
{
"data": {
"updateFund": {
"id": 4,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"name": "abc123",
"legalName": "xyz789",
"shortDescription": "xyz789",
"summary": FundSummary,
"registrationNumber": "abc123",
"legalStructure": "LIMITED_PARTNERSHIP",
"assetStructure": "SINGLE_ASSET",
"inception": "2007-12-03T10:15:30Z",
"currency": Currency,
"country": Country,
"cardImage": RemoteAsset,
"totalUnitCountDecimal": FixedPointNumber,
"calculatedNetAssetValue": Money,
"targetCashReturn": Fraction,
"targetTotalReturn": Fraction,
"documents": [FundDocument],
"assets": [Asset],
"asset": Asset,
"offers": [Offer],
"distributions": [Distribution],
"searchDistributions": DistributionSearchResults,
"distribution": Distribution,
"distributionV2": DistributionV2,
"validateDistribution": [
InvalidBankAccountDistributionAlert
],
"secondaryMarket": SecondaryMarket,
"sellOrder": SellOrder,
"sellOrders": [SellOrder],
"buyOrder": BuyOrder,
"buyOrders": [BuyOrder],
"offerStatus": "OPEN",
"investorType": "WHOLESALE",
"largestOwnershipPercentageV2": 123.45,
"numberOfActiveHoldings": 987,
"fundManagerName": "abc123",
"lastDistributionDate": "2007-12-03T10:15:30Z",
"equityRaised": Money,
"hideDistributionMetrics": true,
"searchUnitRedemptionRequests": UnitRedemptionRequestSearchResults,
"unitRedemptionRequest": UnitRedemptionRequest,
"unitRedemptionConfiguration": FundUnitRedemptionConfiguration,
"unitPrecisionScale": 123,
"searchUnitClasses": UnitClassSearchResults,
"showHoldingPageOnInvestorPortal": false,
"customMetrics": [CustomMetric],
"investorPortalConfiguration": FundInvestorPortalConfiguration,
"unitTransferRequest": UnitTransferRequest,
"depositBankAccount": BankAccount,
"searchOutgoingBankAccounts": FundOutgoingBankAccountSearchResults
}
}
}
updateFundDocument
Description
Modify a document against a Fund
Response
Returns a Fund!
Arguments
| Name | Description |
|---|---|
form - UpdateFundDocumentInput!
|
Example
Query
mutation updateFundDocument($form: UpdateFundDocumentInput!) {
updateFundDocument(form: $form) {
id
createdAt
updatedAt
name
legalName
shortDescription
summary {
...FundSummaryFragment
}
registrationNumber
legalStructure
assetStructure
inception
currency {
...CurrencyFragment
}
country {
...CountryFragment
}
cardImage {
...RemoteAssetFragment
}
totalUnitCountDecimal {
...FixedPointNumberFragment
}
calculatedNetAssetValue {
...MoneyFragment
}
targetCashReturn {
...FractionFragment
}
targetTotalReturn {
...FractionFragment
}
documents {
...FundDocumentFragment
}
assets {
...AssetFragment
}
asset {
...AssetFragment
}
offers {
...OfferFragment
}
distributions {
...DistributionFragment
}
searchDistributions {
...DistributionSearchResultsFragment
}
distribution {
...DistributionFragment
}
distributionV2 {
...DistributionV2Fragment
}
validateDistribution {
... on InvalidBankAccountDistributionAlert {
...InvalidBankAccountDistributionAlertFragment
}
}
secondaryMarket {
...SecondaryMarketFragment
}
sellOrder {
...SellOrderFragment
}
sellOrders {
...SellOrderFragment
}
buyOrder {
...BuyOrderFragment
}
buyOrders {
...BuyOrderFragment
}
offerStatus
investorType
largestOwnershipPercentageV2
numberOfActiveHoldings
fundManagerName
lastDistributionDate
equityRaised {
...MoneyFragment
}
hideDistributionMetrics
searchUnitRedemptionRequests {
...UnitRedemptionRequestSearchResultsFragment
}
unitRedemptionRequest {
...UnitRedemptionRequestFragment
}
unitRedemptionConfiguration {
...FundUnitRedemptionConfigurationFragment
}
unitPrecisionScale
searchUnitClasses {
...UnitClassSearchResultsFragment
}
showHoldingPageOnInvestorPortal
customMetrics {
...CustomMetricFragment
}
investorPortalConfiguration {
...FundInvestorPortalConfigurationFragment
}
unitTransferRequest {
...UnitTransferRequestFragment
}
depositBankAccount {
...BankAccountFragment
}
searchOutgoingBankAccounts {
...FundOutgoingBankAccountSearchResultsFragment
}
}
}
Variables
{"form": UpdateFundDocumentInput}
Response
{
"data": {
"updateFundDocument": {
"id": "4",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"name": "abc123",
"legalName": "abc123",
"shortDescription": "xyz789",
"summary": FundSummary,
"registrationNumber": "abc123",
"legalStructure": "LIMITED_PARTNERSHIP",
"assetStructure": "SINGLE_ASSET",
"inception": "2007-12-03T10:15:30Z",
"currency": Currency,
"country": Country,
"cardImage": RemoteAsset,
"totalUnitCountDecimal": FixedPointNumber,
"calculatedNetAssetValue": Money,
"targetCashReturn": Fraction,
"targetTotalReturn": Fraction,
"documents": [FundDocument],
"assets": [Asset],
"asset": Asset,
"offers": [Offer],
"distributions": [Distribution],
"searchDistributions": DistributionSearchResults,
"distribution": Distribution,
"distributionV2": DistributionV2,
"validateDistribution": [
InvalidBankAccountDistributionAlert
],
"secondaryMarket": SecondaryMarket,
"sellOrder": SellOrder,
"sellOrders": [SellOrder],
"buyOrder": BuyOrder,
"buyOrders": [BuyOrder],
"offerStatus": "OPEN",
"investorType": "WHOLESALE",
"largestOwnershipPercentageV2": 123.45,
"numberOfActiveHoldings": 987,
"fundManagerName": "abc123",
"lastDistributionDate": "2007-12-03T10:15:30Z",
"equityRaised": Money,
"hideDistributionMetrics": true,
"searchUnitRedemptionRequests": UnitRedemptionRequestSearchResults,
"unitRedemptionRequest": UnitRedemptionRequest,
"unitRedemptionConfiguration": FundUnitRedemptionConfiguration,
"unitPrecisionScale": 987,
"searchUnitClasses": UnitClassSearchResults,
"showHoldingPageOnInvestorPortal": true,
"customMetrics": [CustomMetric],
"investorPortalConfiguration": FundInvestorPortalConfiguration,
"unitTransferRequest": UnitTransferRequest,
"depositBankAccount": BankAccount,
"searchOutgoingBankAccounts": FundOutgoingBankAccountSearchResults
}
}
}
updateFundInvestorPortalConfiguration
Description
Update investor portal configuration for the fund
Response
Returns a Fund!
Arguments
| Name | Description |
|---|---|
form - UpdateFundInvestorPortalConfigurationInput!
|
Example
Query
mutation updateFundInvestorPortalConfiguration($form: UpdateFundInvestorPortalConfigurationInput!) {
updateFundInvestorPortalConfiguration(form: $form) {
id
createdAt
updatedAt
name
legalName
shortDescription
summary {
...FundSummaryFragment
}
registrationNumber
legalStructure
assetStructure
inception
currency {
...CurrencyFragment
}
country {
...CountryFragment
}
cardImage {
...RemoteAssetFragment
}
totalUnitCountDecimal {
...FixedPointNumberFragment
}
calculatedNetAssetValue {
...MoneyFragment
}
targetCashReturn {
...FractionFragment
}
targetTotalReturn {
...FractionFragment
}
documents {
...FundDocumentFragment
}
assets {
...AssetFragment
}
asset {
...AssetFragment
}
offers {
...OfferFragment
}
distributions {
...DistributionFragment
}
searchDistributions {
...DistributionSearchResultsFragment
}
distribution {
...DistributionFragment
}
distributionV2 {
...DistributionV2Fragment
}
validateDistribution {
... on InvalidBankAccountDistributionAlert {
...InvalidBankAccountDistributionAlertFragment
}
}
secondaryMarket {
...SecondaryMarketFragment
}
sellOrder {
...SellOrderFragment
}
sellOrders {
...SellOrderFragment
}
buyOrder {
...BuyOrderFragment
}
buyOrders {
...BuyOrderFragment
}
offerStatus
investorType
largestOwnershipPercentageV2
numberOfActiveHoldings
fundManagerName
lastDistributionDate
equityRaised {
...MoneyFragment
}
hideDistributionMetrics
searchUnitRedemptionRequests {
...UnitRedemptionRequestSearchResultsFragment
}
unitRedemptionRequest {
...UnitRedemptionRequestFragment
}
unitRedemptionConfiguration {
...FundUnitRedemptionConfigurationFragment
}
unitPrecisionScale
searchUnitClasses {
...UnitClassSearchResultsFragment
}
showHoldingPageOnInvestorPortal
customMetrics {
...CustomMetricFragment
}
investorPortalConfiguration {
...FundInvestorPortalConfigurationFragment
}
unitTransferRequest {
...UnitTransferRequestFragment
}
depositBankAccount {
...BankAccountFragment
}
searchOutgoingBankAccounts {
...FundOutgoingBankAccountSearchResultsFragment
}
}
}
Variables
{"form": UpdateFundInvestorPortalConfigurationInput}
Response
{
"data": {
"updateFundInvestorPortalConfiguration": {
"id": "4",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"name": "abc123",
"legalName": "xyz789",
"shortDescription": "xyz789",
"summary": FundSummary,
"registrationNumber": "abc123",
"legalStructure": "LIMITED_PARTNERSHIP",
"assetStructure": "SINGLE_ASSET",
"inception": "2007-12-03T10:15:30Z",
"currency": Currency,
"country": Country,
"cardImage": RemoteAsset,
"totalUnitCountDecimal": FixedPointNumber,
"calculatedNetAssetValue": Money,
"targetCashReturn": Fraction,
"targetTotalReturn": Fraction,
"documents": [FundDocument],
"assets": [Asset],
"asset": Asset,
"offers": [Offer],
"distributions": [Distribution],
"searchDistributions": DistributionSearchResults,
"distribution": Distribution,
"distributionV2": DistributionV2,
"validateDistribution": [
InvalidBankAccountDistributionAlert
],
"secondaryMarket": SecondaryMarket,
"sellOrder": SellOrder,
"sellOrders": [SellOrder],
"buyOrder": BuyOrder,
"buyOrders": [BuyOrder],
"offerStatus": "OPEN",
"investorType": "WHOLESALE",
"largestOwnershipPercentageV2": 123.45,
"numberOfActiveHoldings": 987,
"fundManagerName": "abc123",
"lastDistributionDate": "2007-12-03T10:15:30Z",
"equityRaised": Money,
"hideDistributionMetrics": false,
"searchUnitRedemptionRequests": UnitRedemptionRequestSearchResults,
"unitRedemptionRequest": UnitRedemptionRequest,
"unitRedemptionConfiguration": FundUnitRedemptionConfiguration,
"unitPrecisionScale": 123,
"searchUnitClasses": UnitClassSearchResults,
"showHoldingPageOnInvestorPortal": false,
"customMetrics": [CustomMetric],
"investorPortalConfiguration": FundInvestorPortalConfiguration,
"unitTransferRequest": UnitTransferRequest,
"depositBankAccount": BankAccount,
"searchOutgoingBankAccounts": FundOutgoingBankAccountSearchResults
}
}
}
updateFundOutgoingBankAccount
Response
Returns a FundOutgoingBankAccount!
Arguments
| Name | Description |
|---|---|
input - UpdateFundOutgoingBankAccountInput!
|
Example
Query
mutation updateFundOutgoingBankAccount($input: UpdateFundOutgoingBankAccountInput!) {
updateFundOutgoingBankAccount(input: $input) {
id
created
name
accountNumber
businessIdentifierCode
currency {
...CurrencyFragment
}
bankAccountLocationDetails {
... on AUDBankAccountBankAccountLocationDetails {
...AUDBankAccountBankAccountLocationDetailsFragment
}
... on USDBankAccountBankAccountLocationDetails {
...USDBankAccountBankAccountLocationDetailsFragment
}
... on GBPBankAccountBankAccountLocationDetails {
...GBPBankAccountBankAccountLocationDetailsFragment
}
}
isFundDefault
}
}
Variables
{"input": UpdateFundOutgoingBankAccountInput}
Response
{
"data": {
"updateFundOutgoingBankAccount": {
"id": 4,
"created": "2007-12-03T10:15:30Z",
"name": "abc123",
"accountNumber": "xyz789",
"businessIdentifierCode": "abc123",
"currency": Currency,
"bankAccountLocationDetails": AUDBankAccountBankAccountLocationDetails,
"isFundDefault": true
}
}
}
updateGeneralTenantConfiguration
Response
Returns a TenantConfiguration!
Arguments
| Name | Description |
|---|---|
form - UpdateTenantConfigurationInput!
|
Example
Query
mutation updateGeneralTenantConfiguration($form: UpdateTenantConfigurationInput!) {
updateGeneralTenantConfiguration(form: $form) {
general {
...TenantGeneralConfigurationFragment
}
emails {
...TenantEmailsConfigurationFragment
}
resources {
...TenantResourcesConfigurationFragment
}
links {
...TenantLinksConfigurationFragment
}
logos {
...TenantLogosConfigurationFragment
}
colors {
...TenantColorsConfigurationFragment
}
}
}
Variables
{"form": UpdateTenantConfigurationInput}
Response
{
"data": {
"updateGeneralTenantConfiguration": {
"general": TenantGeneralConfiguration,
"emails": TenantEmailsConfiguration,
"resources": TenantResourcesConfiguration,
"links": TenantLinksConfiguration,
"logos": TenantLogosConfiguration,
"colors": TenantColorsConfiguration
}
}
}
updateHoldingDistributionSettings
Description
Updates holding distribution settings
Response
Returns a Holding!
Arguments
| Name | Description |
|---|---|
form - UpdateHoldingDistributionSettingsInput!
|
Example
Query
mutation updateHoldingDistributionSettings($form: UpdateHoldingDistributionSettingsInput!) {
updateHoldingDistributionSettings(form: $form) {
id
createdAt
updatedAt
investingEntity {
...InvestingEntityFragment
}
markedValue {
...MoneyFragment
}
capitalContributed {
...MoneyFragment
}
capitalCommitted {
...MoneyFragment
}
unitCountDecimal {
...FixedPointNumberFragment
}
availableUnitCount {
...FixedPointNumberFragment
}
ownershipPercentage
unitClassOwnershipPercentage
cashDistributions {
...MoneyFragment
}
capitalReturns {
...MoneyFragment
}
bankAccount {
...VerifiableBankAccountFragment
}
redemptionBankAccount {
...VerifiableBankAccountFragment
}
fund {
...FundFragment
}
distributionSettings
distributionsWithheldAmount {
...MoneyFragment
}
withheldDistributions {
...WithheldDistributionFragment
}
unitClass {
...UnitClassFragment
}
reinvestmentUnitClass {
...UnitClassFragment
}
}
}
Variables
{"form": UpdateHoldingDistributionSettingsInput}
Response
{
"data": {
"updateHoldingDistributionSettings": {
"id": 4,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"investingEntity": InvestingEntity,
"markedValue": Money,
"capitalContributed": Money,
"capitalCommitted": Money,
"unitCountDecimal": FixedPointNumber,
"availableUnitCount": FixedPointNumber,
"ownershipPercentage": 987.65,
"unitClassOwnershipPercentage": 123.45,
"cashDistributions": Money,
"capitalReturns": Money,
"bankAccount": VerifiableBankAccount,
"redemptionBankAccount": VerifiableBankAccount,
"fund": Fund,
"distributionSettings": "ENABLED",
"distributionsWithheldAmount": Money,
"withheldDistributions": [WithheldDistribution],
"unitClass": UnitClass,
"reinvestmentUnitClass": UnitClass
}
}
}
updateImportBatch
Description
Update an import batch
Response
Returns an ImportBatch!
Arguments
| Name | Description |
|---|---|
form - UpdateImportBatchInput!
|
Example
Query
mutation updateImportBatch($form: UpdateImportBatchInput!) {
updateImportBatch(form: $form) {
id
createdAt
updatedAt
type
name
file {
...RemoteAssetFragment
}
createdBy {
...AdminUserFragment
}
confirmedBy {
...AdminUserFragment
}
confirmedAt
status
notificationTime
metadata {
... on UnitIssuanceImportMetadata {
...UnitIssuanceImportMetadataFragment
}
}
validationErrors {
...ImportValidationErrorFragment
}
importJobs {
...ImportJobFragment
}
}
}
Variables
{"form": UpdateImportBatchInput}
Response
{
"data": {
"updateImportBatch": {
"id": 4,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"type": "UNIT_ISSUANCE",
"name": "abc123",
"file": RemoteAsset,
"createdBy": AdminUser,
"confirmedBy": AdminUser,
"confirmedAt": "2007-12-03T10:15:30Z",
"status": "GENERATING",
"notificationTime": "2007-12-03T10:15:30Z",
"metadata": UnitIssuanceImportMetadata,
"validationErrors": [ImportValidationError],
"importJobs": [ImportJob]
}
}
}
updateIndividualInvestingEntity
Description
Update an existing individual investing entity
Response
Returns an Account!
Arguments
| Name | Description |
|---|---|
form - UpdateIndividualInvestingEntityInput!
|
Example
Query
mutation updateIndividualInvestingEntity($form: UpdateIndividualInvestingEntityInput!) {
updateIndividualInvestingEntity(form: $form) {
id
created
updated
lastLoggedIn
email
hasPasswordSet
activationEmailLastSent
legalName {
...LegalNameFragment
}
preferredName
timeZone
dateOfBirth {
...DayMonthYearFragment
}
termsAgreed
isAccountLocked
accountLockedReason
addresses {
...VerifiableAddressFragment
}
phoneNumber {
...PhoneNumberFragment
}
emailConfirmed
status
setupStatus {
...AccountSetupStatusFragment
}
investingEntities {
...InvestingEntityFragment
}
identityVerifications {
...IdentityVerificationFragment
}
pepSearchResult {
...PEPSearchResultFragment
}
notes {
...NoteFragment
}
searchActivityFeed {
...ActivityFeedResultsFragment
}
totalPortfolioValue {
...MoneyFragment
}
jobTitle
industry
organization
twitterProfileUrl
linkedInProfileUrl
biography
accountManager {
...AdminUserFragment
}
tagsV2 {
...InvestorProfileTagFragment
}
connections {
...ConnectionFragment
}
outstandingTasks {
...TaskFragment
}
outstandingNotifications {
...AccountNotificationFragment
}
identityVerificationStatus
allHoldingsCSVUrl
identityVerificationLastSent
}
}
Variables
{"form": UpdateIndividualInvestingEntityInput}
Response
{
"data": {
"updateIndividualInvestingEntity": {
"id": 4,
"created": "2007-12-03T10:15:30Z",
"updated": "2007-12-03T10:15:30Z",
"lastLoggedIn": "2007-12-03T10:15:30Z",
"email": "xyz789",
"hasPasswordSet": true,
"activationEmailLastSent": "2007-12-03T10:15:30Z",
"legalName": LegalName,
"preferredName": "abc123",
"timeZone": "abc123",
"dateOfBirth": DayMonthYear,
"termsAgreed": true,
"isAccountLocked": true,
"accountLockedReason": "abc123",
"addresses": [VerifiableAddress],
"phoneNumber": PhoneNumber,
"emailConfirmed": true,
"status": "PENDING",
"setupStatus": AccountSetupStatus,
"investingEntities": [InvestingEntity],
"identityVerifications": [IdentityVerification],
"pepSearchResult": PEPSearchResult,
"notes": [Note],
"searchActivityFeed": ActivityFeedResults,
"totalPortfolioValue": Money,
"jobTitle": "xyz789",
"industry": "abc123",
"organization": "abc123",
"twitterProfileUrl": "http://www.test.com/",
"linkedInProfileUrl": "http://www.test.com/",
"biography": "abc123",
"accountManager": AdminUser,
"tagsV2": [InvestorProfileTag],
"connections": [Connection],
"outstandingTasks": [Task],
"outstandingNotifications": [AccountNotification],
"identityVerificationStatus": "INCOMPLETE",
"allHoldingsCSVUrl": "xyz789",
"identityVerificationLastSent": "2007-12-03T10:15:30Z"
}
}
}
updateInvestingEntityDefaultBankAccount
Description
Updates the default bank account for an investing entity
Response
Returns an InvestingEntity!
Arguments
| Name | Description |
|---|---|
form - UpdateInvestingEntityDefaultBankAccountInput!
|
Example
Query
mutation updateInvestingEntityDefaultBankAccount($form: UpdateInvestingEntityDefaultBankAccountInput!) {
updateInvestingEntityDefaultBankAccount(form: $form) {
id
created
updated
entityType
entity {
... on IndividualInvestingEntity {
...IndividualInvestingEntityFragment
}
... on CompanyInvestingEntity {
...CompanyInvestingEntityFragment
}
... on TrustInvestingEntity {
...TrustInvestingEntityFragment
}
... on JointIndividualInvestingEntity {
...JointIndividualInvestingEntityFragment
}
... on PartnershipInvestingEntity {
...PartnershipInvestingEntityFragment
}
}
sourceOfFundsVerificationEmailLastSent
relationship
country {
...CountryFragment
}
bankAccounts {
...VerifiableBankAccountFragment
}
bankAccount {
...VerifiableBankAccountFragment
}
accreditationsStandardised {
...InvestingEntityStandardisedAccreditationFragment
}
accreditationCountry {
...CountryFragment
}
wholesaleCertificationStatus
primaryOwner {
...AccountFragment
}
accounts {
...AccountFragment
}
beneficialOwners {
...BeneficialOwnerFragment
}
beneficialOwner {
...BeneficialOwnerFragment
}
lastRequestedBeneficialOwnersContactDetails
lastRequestedWholesaleCertification
allocations {
...AllocationFragment
}
riskProfile {
...RiskProfileFragment
}
holdings {
...HoldingFragment
}
totalPortfolioValue {
...MoneyFragment
}
totalHoldingMarkedValue {
...MoneyFragment
}
totalCapitalContributed {
...MoneyFragment
}
searchActivityFeed {
...ActivityFeedResultsFragment
}
governingDocuments {
...InvestingEntityGoverningDocumentFragment
}
searchTransactionsV2 {
...SearchTransactionsResultsFragment
}
outstandingTaskCount
bankAccountVerificationStatus
sourceOfFundsVerificationStatus
outstandingTasks {
...TaskFragment
}
outstandingNotifications {
...InvestingEntityNotificationFragment
}
associatedAccounts {
...AssociatedAccountFragment
}
tags {
...InvestingEntityTagFragment
}
}
}
Variables
{"form": UpdateInvestingEntityDefaultBankAccountInput}
Response
{
"data": {
"updateInvestingEntityDefaultBankAccount": {
"id": 4,
"created": "2007-12-03T10:15:30Z",
"updated": "2007-12-03T10:15:30Z",
"entityType": "INDIVIDUAL",
"entity": IndividualInvestingEntity,
"sourceOfFundsVerificationEmailLastSent": "2007-12-03T10:15:30Z",
"relationship": "SHAREHOLDING_VOTING_RIGHTS_GREATER_THAN_25_PERCENT",
"country": Country,
"bankAccounts": [VerifiableBankAccount],
"bankAccount": VerifiableBankAccount,
"accreditationsStandardised": [
InvestingEntityStandardisedAccreditation
],
"accreditationCountry": Country,
"wholesaleCertificationStatus": "AWAITING",
"primaryOwner": Account,
"accounts": [Account],
"beneficialOwners": [BeneficialOwner],
"beneficialOwner": BeneficialOwner,
"lastRequestedBeneficialOwnersContactDetails": "2007-12-03T10:15:30Z",
"lastRequestedWholesaleCertification": "2007-12-03T10:15:30Z",
"allocations": [Allocation],
"riskProfile": RiskProfile,
"holdings": [Holding],
"totalPortfolioValue": Money,
"totalHoldingMarkedValue": Money,
"totalCapitalContributed": Money,
"searchActivityFeed": ActivityFeedResults,
"governingDocuments": [
InvestingEntityGoverningDocument
],
"searchTransactionsV2": SearchTransactionsResults,
"outstandingTaskCount": 987,
"bankAccountVerificationStatus": "PENDING",
"sourceOfFundsVerificationStatus": "COMPLETE",
"outstandingTasks": [Task],
"outstandingNotifications": [
InvestingEntityNotification
],
"associatedAccounts": [AssociatedAccount],
"tags": [InvestingEntityTag]
}
}
}
updateInvestingEntityDocument
Description
Update an existing investing entity document
Response
Returns an InvestingEntity!
Arguments
| Name | Description |
|---|---|
form - UpdateInvestingEntityDocumentInput!
|
Example
Query
mutation updateInvestingEntityDocument($form: UpdateInvestingEntityDocumentInput!) {
updateInvestingEntityDocument(form: $form) {
id
created
updated
entityType
entity {
... on IndividualInvestingEntity {
...IndividualInvestingEntityFragment
}
... on CompanyInvestingEntity {
...CompanyInvestingEntityFragment
}
... on TrustInvestingEntity {
...TrustInvestingEntityFragment
}
... on JointIndividualInvestingEntity {
...JointIndividualInvestingEntityFragment
}
... on PartnershipInvestingEntity {
...PartnershipInvestingEntityFragment
}
}
sourceOfFundsVerificationEmailLastSent
relationship
country {
...CountryFragment
}
bankAccounts {
...VerifiableBankAccountFragment
}
bankAccount {
...VerifiableBankAccountFragment
}
accreditationsStandardised {
...InvestingEntityStandardisedAccreditationFragment
}
accreditationCountry {
...CountryFragment
}
wholesaleCertificationStatus
primaryOwner {
...AccountFragment
}
accounts {
...AccountFragment
}
beneficialOwners {
...BeneficialOwnerFragment
}
beneficialOwner {
...BeneficialOwnerFragment
}
lastRequestedBeneficialOwnersContactDetails
lastRequestedWholesaleCertification
allocations {
...AllocationFragment
}
riskProfile {
...RiskProfileFragment
}
holdings {
...HoldingFragment
}
totalPortfolioValue {
...MoneyFragment
}
totalHoldingMarkedValue {
...MoneyFragment
}
totalCapitalContributed {
...MoneyFragment
}
searchActivityFeed {
...ActivityFeedResultsFragment
}
governingDocuments {
...InvestingEntityGoverningDocumentFragment
}
searchTransactionsV2 {
...SearchTransactionsResultsFragment
}
outstandingTaskCount
bankAccountVerificationStatus
sourceOfFundsVerificationStatus
outstandingTasks {
...TaskFragment
}
outstandingNotifications {
...InvestingEntityNotificationFragment
}
associatedAccounts {
...AssociatedAccountFragment
}
tags {
...InvestingEntityTagFragment
}
}
}
Variables
{"form": UpdateInvestingEntityDocumentInput}
Response
{
"data": {
"updateInvestingEntityDocument": {
"id": 4,
"created": "2007-12-03T10:15:30Z",
"updated": "2007-12-03T10:15:30Z",
"entityType": "INDIVIDUAL",
"entity": IndividualInvestingEntity,
"sourceOfFundsVerificationEmailLastSent": "2007-12-03T10:15:30Z",
"relationship": "SHAREHOLDING_VOTING_RIGHTS_GREATER_THAN_25_PERCENT",
"country": Country,
"bankAccounts": [VerifiableBankAccount],
"bankAccount": VerifiableBankAccount,
"accreditationsStandardised": [
InvestingEntityStandardisedAccreditation
],
"accreditationCountry": Country,
"wholesaleCertificationStatus": "AWAITING",
"primaryOwner": Account,
"accounts": [Account],
"beneficialOwners": [BeneficialOwner],
"beneficialOwner": BeneficialOwner,
"lastRequestedBeneficialOwnersContactDetails": "2007-12-03T10:15:30Z",
"lastRequestedWholesaleCertification": "2007-12-03T10:15:30Z",
"allocations": [Allocation],
"riskProfile": RiskProfile,
"holdings": [Holding],
"totalPortfolioValue": Money,
"totalHoldingMarkedValue": Money,
"totalCapitalContributed": Money,
"searchActivityFeed": ActivityFeedResults,
"governingDocuments": [
InvestingEntityGoverningDocument
],
"searchTransactionsV2": SearchTransactionsResults,
"outstandingTaskCount": 987,
"bankAccountVerificationStatus": "PENDING",
"sourceOfFundsVerificationStatus": "COMPLETE",
"outstandingTasks": [Task],
"outstandingNotifications": [
InvestingEntityNotification
],
"associatedAccounts": [AssociatedAccount],
"tags": [InvestingEntityTag]
}
}
}
updateInvestingEntityGoverningDocument
Description
Update an existing investing entity governing document (only the name can be updated)
Response
Returns an InvestingEntityGoverningDocument!
Arguments
| Name | Description |
|---|---|
form - UpdateInvestingEntityGoverningDocumentInput!
|
Example
Query
mutation updateInvestingEntityGoverningDocument($form: UpdateInvestingEntityGoverningDocumentInput!) {
updateInvestingEntityGoverningDocument(form: $form) {
id
name
updatedAt
file {
...RemoteAssetFragment
}
status
declinedReason
}
}
Variables
{"form": UpdateInvestingEntityGoverningDocumentInput}
Response
{
"data": {
"updateInvestingEntityGoverningDocument": {
"id": 4,
"name": "abc123",
"updatedAt": "2007-12-03T10:15:30Z",
"file": RemoteAsset,
"status": "PENDING",
"declinedReason": "abc123"
}
}
}
updateInvestingEntityHoldingBankAccount
use updateHoldingDistributionSettings
Description
Update the bank account used for an investing entity's holding
Response
Returns an InvestingEntity!
Arguments
| Name | Description |
|---|---|
form - UpdateInvestingEntityHoldingBankAccountInput!
|
Example
Query
mutation updateInvestingEntityHoldingBankAccount($form: UpdateInvestingEntityHoldingBankAccountInput!) {
updateInvestingEntityHoldingBankAccount(form: $form) {
id
created
updated
entityType
entity {
... on IndividualInvestingEntity {
...IndividualInvestingEntityFragment
}
... on CompanyInvestingEntity {
...CompanyInvestingEntityFragment
}
... on TrustInvestingEntity {
...TrustInvestingEntityFragment
}
... on JointIndividualInvestingEntity {
...JointIndividualInvestingEntityFragment
}
... on PartnershipInvestingEntity {
...PartnershipInvestingEntityFragment
}
}
sourceOfFundsVerificationEmailLastSent
relationship
country {
...CountryFragment
}
bankAccounts {
...VerifiableBankAccountFragment
}
bankAccount {
...VerifiableBankAccountFragment
}
accreditationsStandardised {
...InvestingEntityStandardisedAccreditationFragment
}
accreditationCountry {
...CountryFragment
}
wholesaleCertificationStatus
primaryOwner {
...AccountFragment
}
accounts {
...AccountFragment
}
beneficialOwners {
...BeneficialOwnerFragment
}
beneficialOwner {
...BeneficialOwnerFragment
}
lastRequestedBeneficialOwnersContactDetails
lastRequestedWholesaleCertification
allocations {
...AllocationFragment
}
riskProfile {
...RiskProfileFragment
}
holdings {
...HoldingFragment
}
totalPortfolioValue {
...MoneyFragment
}
totalHoldingMarkedValue {
...MoneyFragment
}
totalCapitalContributed {
...MoneyFragment
}
searchActivityFeed {
...ActivityFeedResultsFragment
}
governingDocuments {
...InvestingEntityGoverningDocumentFragment
}
searchTransactionsV2 {
...SearchTransactionsResultsFragment
}
outstandingTaskCount
bankAccountVerificationStatus
sourceOfFundsVerificationStatus
outstandingTasks {
...TaskFragment
}
outstandingNotifications {
...InvestingEntityNotificationFragment
}
associatedAccounts {
...AssociatedAccountFragment
}
tags {
...InvestingEntityTagFragment
}
}
}
Variables
{"form": UpdateInvestingEntityHoldingBankAccountInput}
Response
{
"data": {
"updateInvestingEntityHoldingBankAccount": {
"id": "4",
"created": "2007-12-03T10:15:30Z",
"updated": "2007-12-03T10:15:30Z",
"entityType": "INDIVIDUAL",
"entity": IndividualInvestingEntity,
"sourceOfFundsVerificationEmailLastSent": "2007-12-03T10:15:30Z",
"relationship": "SHAREHOLDING_VOTING_RIGHTS_GREATER_THAN_25_PERCENT",
"country": Country,
"bankAccounts": [VerifiableBankAccount],
"bankAccount": VerifiableBankAccount,
"accreditationsStandardised": [
InvestingEntityStandardisedAccreditation
],
"accreditationCountry": Country,
"wholesaleCertificationStatus": "AWAITING",
"primaryOwner": Account,
"accounts": [Account],
"beneficialOwners": [BeneficialOwner],
"beneficialOwner": BeneficialOwner,
"lastRequestedBeneficialOwnersContactDetails": "2007-12-03T10:15:30Z",
"lastRequestedWholesaleCertification": "2007-12-03T10:15:30Z",
"allocations": [Allocation],
"riskProfile": RiskProfile,
"holdings": [Holding],
"totalPortfolioValue": Money,
"totalHoldingMarkedValue": Money,
"totalCapitalContributed": Money,
"searchActivityFeed": ActivityFeedResults,
"governingDocuments": [
InvestingEntityGoverningDocument
],
"searchTransactionsV2": SearchTransactionsResults,
"outstandingTaskCount": 987,
"bankAccountVerificationStatus": "PENDING",
"sourceOfFundsVerificationStatus": "COMPLETE",
"outstandingTasks": [Task],
"outstandingNotifications": [
InvestingEntityNotification
],
"associatedAccounts": [AssociatedAccount],
"tags": [InvestingEntityTag]
}
}
}
updateInvestingEntityKeyAccount
Description
Update Investing Entity Key Account
Response
Returns an InvestingEntity!
Arguments
| Name | Description |
|---|---|
form - UpdateInvestingEntityKeyAccountInput!
|
Example
Query
mutation updateInvestingEntityKeyAccount($form: UpdateInvestingEntityKeyAccountInput!) {
updateInvestingEntityKeyAccount(form: $form) {
id
created
updated
entityType
entity {
... on IndividualInvestingEntity {
...IndividualInvestingEntityFragment
}
... on CompanyInvestingEntity {
...CompanyInvestingEntityFragment
}
... on TrustInvestingEntity {
...TrustInvestingEntityFragment
}
... on JointIndividualInvestingEntity {
...JointIndividualInvestingEntityFragment
}
... on PartnershipInvestingEntity {
...PartnershipInvestingEntityFragment
}
}
sourceOfFundsVerificationEmailLastSent
relationship
country {
...CountryFragment
}
bankAccounts {
...VerifiableBankAccountFragment
}
bankAccount {
...VerifiableBankAccountFragment
}
accreditationsStandardised {
...InvestingEntityStandardisedAccreditationFragment
}
accreditationCountry {
...CountryFragment
}
wholesaleCertificationStatus
primaryOwner {
...AccountFragment
}
accounts {
...AccountFragment
}
beneficialOwners {
...BeneficialOwnerFragment
}
beneficialOwner {
...BeneficialOwnerFragment
}
lastRequestedBeneficialOwnersContactDetails
lastRequestedWholesaleCertification
allocations {
...AllocationFragment
}
riskProfile {
...RiskProfileFragment
}
holdings {
...HoldingFragment
}
totalPortfolioValue {
...MoneyFragment
}
totalHoldingMarkedValue {
...MoneyFragment
}
totalCapitalContributed {
...MoneyFragment
}
searchActivityFeed {
...ActivityFeedResultsFragment
}
governingDocuments {
...InvestingEntityGoverningDocumentFragment
}
searchTransactionsV2 {
...SearchTransactionsResultsFragment
}
outstandingTaskCount
bankAccountVerificationStatus
sourceOfFundsVerificationStatus
outstandingTasks {
...TaskFragment
}
outstandingNotifications {
...InvestingEntityNotificationFragment
}
associatedAccounts {
...AssociatedAccountFragment
}
tags {
...InvestingEntityTagFragment
}
}
}
Variables
{"form": UpdateInvestingEntityKeyAccountInput}
Response
{
"data": {
"updateInvestingEntityKeyAccount": {
"id": "4",
"created": "2007-12-03T10:15:30Z",
"updated": "2007-12-03T10:15:30Z",
"entityType": "INDIVIDUAL",
"entity": IndividualInvestingEntity,
"sourceOfFundsVerificationEmailLastSent": "2007-12-03T10:15:30Z",
"relationship": "SHAREHOLDING_VOTING_RIGHTS_GREATER_THAN_25_PERCENT",
"country": Country,
"bankAccounts": [VerifiableBankAccount],
"bankAccount": VerifiableBankAccount,
"accreditationsStandardised": [
InvestingEntityStandardisedAccreditation
],
"accreditationCountry": Country,
"wholesaleCertificationStatus": "AWAITING",
"primaryOwner": Account,
"accounts": [Account],
"beneficialOwners": [BeneficialOwner],
"beneficialOwner": BeneficialOwner,
"lastRequestedBeneficialOwnersContactDetails": "2007-12-03T10:15:30Z",
"lastRequestedWholesaleCertification": "2007-12-03T10:15:30Z",
"allocations": [Allocation],
"riskProfile": RiskProfile,
"holdings": [Holding],
"totalPortfolioValue": Money,
"totalHoldingMarkedValue": Money,
"totalCapitalContributed": Money,
"searchActivityFeed": ActivityFeedResults,
"governingDocuments": [
InvestingEntityGoverningDocument
],
"searchTransactionsV2": SearchTransactionsResults,
"outstandingTaskCount": 123,
"bankAccountVerificationStatus": "PENDING",
"sourceOfFundsVerificationStatus": "COMPLETE",
"outstandingTasks": [Task],
"outstandingNotifications": [
InvestingEntityNotification
],
"associatedAccounts": [AssociatedAccount],
"tags": [InvestingEntityTag]
}
}
}
updateInvestingEntityRiskProfile
Description
Update Investing Entity Risk Profile rating
Response
Returns a RiskProfile!
Arguments
| Name | Description |
|---|---|
form - UpdateInvestingEntityRiskProfileInput!
|
Example
Query
mutation updateInvestingEntityRiskProfile($form: UpdateInvestingEntityRiskProfileInput!) {
updateInvestingEntityRiskProfile(form: $form) {
id
created
rating
}
}
Variables
{"form": UpdateInvestingEntityRiskProfileInput}
Response
{
"data": {
"updateInvestingEntityRiskProfile": {
"id": "4",
"created": "2007-12-03T10:15:30Z",
"rating": 987
}
}
}
updateInvestorPortalConfiguration
Description
Update the configuration for the investor portal portfolio page
Response
Returns an InvestorPortalConfiguration!
Arguments
| Name | Description |
|---|---|
form - InvestorPortalConfigurationInput!
|
Example
Query
mutation updateInvestorPortalConfiguration($form: InvestorPortalConfigurationInput!) {
updateInvestorPortalConfiguration(form: $form) {
portfolioKeyMetrics {
...PortfolioKeyMetricConfigFragment
}
portfolioGraphs {
...PortfolioGraphConfigFragment
}
portfolioTables {
...PortfolioTableConfigFragment
}
}
}
Variables
{"form": InvestorPortalConfigurationInput}
Response
{
"data": {
"updateInvestorPortalConfiguration": {
"portfolioKeyMetrics": [PortfolioKeyMetricConfig],
"portfolioGraphs": [PortfolioGraphConfig],
"portfolioTables": [PortfolioTableConfig]
}
}
}
updateJointIndividualInvestingEntity
Description
Update an existing joint individual investing entity
Response
Returns an Account!
Arguments
| Name | Description |
|---|---|
form - UpdateJointIndividualInvestingEntityInput!
|
Example
Query
mutation updateJointIndividualInvestingEntity($form: UpdateJointIndividualInvestingEntityInput!) {
updateJointIndividualInvestingEntity(form: $form) {
id
created
updated
lastLoggedIn
email
hasPasswordSet
activationEmailLastSent
legalName {
...LegalNameFragment
}
preferredName
timeZone
dateOfBirth {
...DayMonthYearFragment
}
termsAgreed
isAccountLocked
accountLockedReason
addresses {
...VerifiableAddressFragment
}
phoneNumber {
...PhoneNumberFragment
}
emailConfirmed
status
setupStatus {
...AccountSetupStatusFragment
}
investingEntities {
...InvestingEntityFragment
}
identityVerifications {
...IdentityVerificationFragment
}
pepSearchResult {
...PEPSearchResultFragment
}
notes {
...NoteFragment
}
searchActivityFeed {
...ActivityFeedResultsFragment
}
totalPortfolioValue {
...MoneyFragment
}
jobTitle
industry
organization
twitterProfileUrl
linkedInProfileUrl
biography
accountManager {
...AdminUserFragment
}
tagsV2 {
...InvestorProfileTagFragment
}
connections {
...ConnectionFragment
}
outstandingTasks {
...TaskFragment
}
outstandingNotifications {
...AccountNotificationFragment
}
identityVerificationStatus
allHoldingsCSVUrl
identityVerificationLastSent
}
}
Variables
{"form": UpdateJointIndividualInvestingEntityInput}
Response
{
"data": {
"updateJointIndividualInvestingEntity": {
"id": "4",
"created": "2007-12-03T10:15:30Z",
"updated": "2007-12-03T10:15:30Z",
"lastLoggedIn": "2007-12-03T10:15:30Z",
"email": "abc123",
"hasPasswordSet": false,
"activationEmailLastSent": "2007-12-03T10:15:30Z",
"legalName": LegalName,
"preferredName": "xyz789",
"timeZone": "xyz789",
"dateOfBirth": DayMonthYear,
"termsAgreed": false,
"isAccountLocked": true,
"accountLockedReason": "abc123",
"addresses": [VerifiableAddress],
"phoneNumber": PhoneNumber,
"emailConfirmed": true,
"status": "PENDING",
"setupStatus": AccountSetupStatus,
"investingEntities": [InvestingEntity],
"identityVerifications": [IdentityVerification],
"pepSearchResult": PEPSearchResult,
"notes": [Note],
"searchActivityFeed": ActivityFeedResults,
"totalPortfolioValue": Money,
"jobTitle": "xyz789",
"industry": "abc123",
"organization": "xyz789",
"twitterProfileUrl": "http://www.test.com/",
"linkedInProfileUrl": "http://www.test.com/",
"biography": "abc123",
"accountManager": AdminUser,
"tagsV2": [InvestorProfileTag],
"connections": [Connection],
"outstandingTasks": [Task],
"outstandingNotifications": [AccountNotification],
"identityVerificationStatus": "INCOMPLETE",
"allHoldingsCSVUrl": "abc123",
"identityVerificationLastSent": "2007-12-03T10:15:30Z"
}
}
}
updateManualTask
Description
Modify an existing 'manual' task
Response
Returns a ManualTask!
Arguments
| Name | Description |
|---|---|
form - UpdateManualTaskInput!
|
Example
Query
mutation updateManualTask($form: UpdateManualTaskInput!) {
updateManualTask(form: $form) {
id
created
updated
status
dueAt
assignedAdmin {
...AdminUserFragment
}
notes {
...NoteFragment
}
title
associatedRecord {
... on Account {
...AccountFragment
}
... on Prospect {
...ProspectFragment
}
... on InvestingEntity {
...InvestingEntityFragment
}
... on Fund {
...FundFragment
}
}
documents {
...TaskDocumentFragment
}
priority
relatedTasks {
...TaskFragment
}
assignedTeam
}
}
Variables
{"form": UpdateManualTaskInput}
Response
{
"data": {
"updateManualTask": {
"id": "4",
"created": "2007-12-03T10:15:30Z",
"updated": "2007-12-03T10:15:30Z",
"status": "OPEN",
"dueAt": "2007-12-03T10:15:30Z",
"assignedAdmin": AdminUser,
"notes": [Note],
"title": "xyz789",
"associatedRecord": Account,
"documents": [TaskDocument],
"priority": "NO_PRIORITY",
"relatedTasks": [Task],
"assignedTeam": "UNASSIGNED"
}
}
}
updateNote
Description
Modify an existing Note
Response
Returns a Note!
Arguments
| Name | Description |
|---|---|
form - UpdateNoteInput!
|
Example
Query
mutation updateNote($form: UpdateNoteInput!) {
updateNote(form: $form) {
id
created
message
lastModifiedDetails {
...NoteLastModifiedDetailsFragment
}
isPinned
}
}
Variables
{"form": UpdateNoteInput}
Response
{
"data": {
"updateNote": {
"id": 4,
"created": "2007-12-03T10:15:30Z",
"message": "xyz789",
"lastModifiedDetails": NoteLastModifiedDetails,
"isPinned": false
}
}
}
updateOffer
Description
Update an offer
Response
Returns an Offer!
Arguments
| Name | Description |
|---|---|
form - UpdateOfferInput!
|
Example
Query
mutation updateOffer($form: UpdateOfferInput!) {
updateOffer(form: $form) {
capitalCallBatches {
...CapitalCallBatchConnectionFragment
}
capitalCallBatch {
...CapitalCallBatchFragment
}
id
displayName
createdAt
updatedAt
pricePerUnit {
...MoneyFragment
}
pricePerUnitV2 {
...HighPrecisionMoneyFragment
}
totalUnitCountDecimal {
...FixedPointNumberFragment
}
minimumUnitCountDecimal {
...FixedPointNumberFragment
}
maximumUnitCountDecimal {
...FixedPointNumberFragment
}
areUnitsIssued
status
openedAt
closedAt
fundsDeadline
settledAt
paymentReferencePrefix
allocations {
...AllocationFragment
}
capitalizationTable {
...CapitalizationTableFragment
}
totalEquity {
...MoneyFragment
}
totalEquityV2 {
...HighPrecisionMoneyFragment
}
registrationsOfInterest {
...RegistrationOfInterestFragment
}
fund {
...FundFragment
}
depositMethods {
...OfferDepositMethodFragment
}
digitalSubscription
slug
dataRoom {
...OfferDataRoomFragment
}
unitClass {
...UnitClassFragment
}
searchAllocations {
...AllocationSearchResultsFragment
}
}
}
Variables
{"form": UpdateOfferInput}
Response
{
"data": {
"updateOffer": {
"capitalCallBatches": CapitalCallBatchConnection,
"capitalCallBatch": CapitalCallBatch,
"id": "4",
"displayName": "xyz789",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"pricePerUnit": Money,
"pricePerUnitV2": HighPrecisionMoney,
"totalUnitCountDecimal": FixedPointNumber,
"minimumUnitCountDecimal": FixedPointNumber,
"maximumUnitCountDecimal": FixedPointNumber,
"areUnitsIssued": false,
"status": "OPEN",
"openedAt": "2007-12-03T10:15:30Z",
"closedAt": "2007-12-03T10:15:30Z",
"fundsDeadline": "2007-12-03T10:15:30Z",
"settledAt": "2007-12-03T10:15:30Z",
"paymentReferencePrefix": "xyz789",
"allocations": [Allocation],
"capitalizationTable": CapitalizationTable,
"totalEquity": Money,
"totalEquityV2": HighPrecisionMoney,
"registrationsOfInterest": [RegistrationOfInterest],
"fund": Fund,
"depositMethods": [OfferDepositMethod],
"digitalSubscription": "ENABLED",
"slug": "xyz789",
"dataRoom": OfferDataRoom,
"unitClass": UnitClass,
"searchAllocations": AllocationSearchResults
}
}
}
updateOfferDataRoom
Description
Update the data room for an offer
Response
Returns an Offer!
Arguments
| Name | Description |
|---|---|
form - UpdateOfferDataRoomInput!
|
Example
Query
mutation updateOfferDataRoom($form: UpdateOfferDataRoomInput!) {
updateOfferDataRoom(form: $form) {
capitalCallBatches {
...CapitalCallBatchConnectionFragment
}
capitalCallBatch {
...CapitalCallBatchFragment
}
id
displayName
createdAt
updatedAt
pricePerUnit {
...MoneyFragment
}
pricePerUnitV2 {
...HighPrecisionMoneyFragment
}
totalUnitCountDecimal {
...FixedPointNumberFragment
}
minimumUnitCountDecimal {
...FixedPointNumberFragment
}
maximumUnitCountDecimal {
...FixedPointNumberFragment
}
areUnitsIssued
status
openedAt
closedAt
fundsDeadline
settledAt
paymentReferencePrefix
allocations {
...AllocationFragment
}
capitalizationTable {
...CapitalizationTableFragment
}
totalEquity {
...MoneyFragment
}
totalEquityV2 {
...HighPrecisionMoneyFragment
}
registrationsOfInterest {
...RegistrationOfInterestFragment
}
fund {
...FundFragment
}
depositMethods {
...OfferDepositMethodFragment
}
digitalSubscription
slug
dataRoom {
...OfferDataRoomFragment
}
unitClass {
...UnitClassFragment
}
searchAllocations {
...AllocationSearchResultsFragment
}
}
}
Variables
{"form": UpdateOfferDataRoomInput}
Response
{
"data": {
"updateOfferDataRoom": {
"capitalCallBatches": CapitalCallBatchConnection,
"capitalCallBatch": CapitalCallBatch,
"id": "4",
"displayName": "abc123",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"pricePerUnit": Money,
"pricePerUnitV2": HighPrecisionMoney,
"totalUnitCountDecimal": FixedPointNumber,
"minimumUnitCountDecimal": FixedPointNumber,
"maximumUnitCountDecimal": FixedPointNumber,
"areUnitsIssued": true,
"status": "OPEN",
"openedAt": "2007-12-03T10:15:30Z",
"closedAt": "2007-12-03T10:15:30Z",
"fundsDeadline": "2007-12-03T10:15:30Z",
"settledAt": "2007-12-03T10:15:30Z",
"paymentReferencePrefix": "xyz789",
"allocations": [Allocation],
"capitalizationTable": CapitalizationTable,
"totalEquity": Money,
"totalEquityV2": HighPrecisionMoney,
"registrationsOfInterest": [RegistrationOfInterest],
"fund": Fund,
"depositMethods": [OfferDepositMethod],
"digitalSubscription": "ENABLED",
"slug": "xyz789",
"dataRoom": OfferDataRoom,
"unitClass": UnitClass,
"searchAllocations": AllocationSearchResults
}
}
}
updateOfferDataRoomContentBlock
Description
Update a content block in an offer's data room
Response
Returns an Offer!
Arguments
| Name | Description |
|---|---|
form - UpdateOfferDataRoomContentBlockInput!
|
Example
Query
mutation updateOfferDataRoomContentBlock($form: UpdateOfferDataRoomContentBlockInput!) {
updateOfferDataRoomContentBlock(form: $form) {
capitalCallBatches {
...CapitalCallBatchConnectionFragment
}
capitalCallBatch {
...CapitalCallBatchFragment
}
id
displayName
createdAt
updatedAt
pricePerUnit {
...MoneyFragment
}
pricePerUnitV2 {
...HighPrecisionMoneyFragment
}
totalUnitCountDecimal {
...FixedPointNumberFragment
}
minimumUnitCountDecimal {
...FixedPointNumberFragment
}
maximumUnitCountDecimal {
...FixedPointNumberFragment
}
areUnitsIssued
status
openedAt
closedAt
fundsDeadline
settledAt
paymentReferencePrefix
allocations {
...AllocationFragment
}
capitalizationTable {
...CapitalizationTableFragment
}
totalEquity {
...MoneyFragment
}
totalEquityV2 {
...HighPrecisionMoneyFragment
}
registrationsOfInterest {
...RegistrationOfInterestFragment
}
fund {
...FundFragment
}
depositMethods {
...OfferDepositMethodFragment
}
digitalSubscription
slug
dataRoom {
...OfferDataRoomFragment
}
unitClass {
...UnitClassFragment
}
searchAllocations {
...AllocationSearchResultsFragment
}
}
}
Variables
{"form": UpdateOfferDataRoomContentBlockInput}
Response
{
"data": {
"updateOfferDataRoomContentBlock": {
"capitalCallBatches": CapitalCallBatchConnection,
"capitalCallBatch": CapitalCallBatch,
"id": 4,
"displayName": "xyz789",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"pricePerUnit": Money,
"pricePerUnitV2": HighPrecisionMoney,
"totalUnitCountDecimal": FixedPointNumber,
"minimumUnitCountDecimal": FixedPointNumber,
"maximumUnitCountDecimal": FixedPointNumber,
"areUnitsIssued": true,
"status": "OPEN",
"openedAt": "2007-12-03T10:15:30Z",
"closedAt": "2007-12-03T10:15:30Z",
"fundsDeadline": "2007-12-03T10:15:30Z",
"settledAt": "2007-12-03T10:15:30Z",
"paymentReferencePrefix": "xyz789",
"allocations": [Allocation],
"capitalizationTable": CapitalizationTable,
"totalEquity": Money,
"totalEquityV2": HighPrecisionMoney,
"registrationsOfInterest": [RegistrationOfInterest],
"fund": Fund,
"depositMethods": [OfferDepositMethod],
"digitalSubscription": "ENABLED",
"slug": "abc123",
"dataRoom": OfferDataRoom,
"unitClass": UnitClass,
"searchAllocations": AllocationSearchResults
}
}
}
updateOfferDepositMethods
Description
Set the deposit methods linked to an offer
Response
Returns an Offer!
Arguments
| Name | Description |
|---|---|
form - UpdateOfferDepositMethodsInput!
|
Example
Query
mutation updateOfferDepositMethods($form: UpdateOfferDepositMethodsInput!) {
updateOfferDepositMethods(form: $form) {
capitalCallBatches {
...CapitalCallBatchConnectionFragment
}
capitalCallBatch {
...CapitalCallBatchFragment
}
id
displayName
createdAt
updatedAt
pricePerUnit {
...MoneyFragment
}
pricePerUnitV2 {
...HighPrecisionMoneyFragment
}
totalUnitCountDecimal {
...FixedPointNumberFragment
}
minimumUnitCountDecimal {
...FixedPointNumberFragment
}
maximumUnitCountDecimal {
...FixedPointNumberFragment
}
areUnitsIssued
status
openedAt
closedAt
fundsDeadline
settledAt
paymentReferencePrefix
allocations {
...AllocationFragment
}
capitalizationTable {
...CapitalizationTableFragment
}
totalEquity {
...MoneyFragment
}
totalEquityV2 {
...HighPrecisionMoneyFragment
}
registrationsOfInterest {
...RegistrationOfInterestFragment
}
fund {
...FundFragment
}
depositMethods {
...OfferDepositMethodFragment
}
digitalSubscription
slug
dataRoom {
...OfferDataRoomFragment
}
unitClass {
...UnitClassFragment
}
searchAllocations {
...AllocationSearchResultsFragment
}
}
}
Variables
{"form": UpdateOfferDepositMethodsInput}
Response
{
"data": {
"updateOfferDepositMethods": {
"capitalCallBatches": CapitalCallBatchConnection,
"capitalCallBatch": CapitalCallBatch,
"id": 4,
"displayName": "abc123",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"pricePerUnit": Money,
"pricePerUnitV2": HighPrecisionMoney,
"totalUnitCountDecimal": FixedPointNumber,
"minimumUnitCountDecimal": FixedPointNumber,
"maximumUnitCountDecimal": FixedPointNumber,
"areUnitsIssued": false,
"status": "OPEN",
"openedAt": "2007-12-03T10:15:30Z",
"closedAt": "2007-12-03T10:15:30Z",
"fundsDeadline": "2007-12-03T10:15:30Z",
"settledAt": "2007-12-03T10:15:30Z",
"paymentReferencePrefix": "abc123",
"allocations": [Allocation],
"capitalizationTable": CapitalizationTable,
"totalEquity": Money,
"totalEquityV2": HighPrecisionMoney,
"registrationsOfInterest": [RegistrationOfInterest],
"fund": Fund,
"depositMethods": [OfferDepositMethod],
"digitalSubscription": "ENABLED",
"slug": "xyz789",
"dataRoom": OfferDataRoom,
"unitClass": UnitClass,
"searchAllocations": AllocationSearchResults
}
}
}
updatePartnershipInvestingEntity
Description
Update an existing partnership investing entity
Response
Returns an Account!
Arguments
| Name | Description |
|---|---|
form - UpdatePartnershipInvestingEntityInput!
|
Example
Query
mutation updatePartnershipInvestingEntity($form: UpdatePartnershipInvestingEntityInput!) {
updatePartnershipInvestingEntity(form: $form) {
id
created
updated
lastLoggedIn
email
hasPasswordSet
activationEmailLastSent
legalName {
...LegalNameFragment
}
preferredName
timeZone
dateOfBirth {
...DayMonthYearFragment
}
termsAgreed
isAccountLocked
accountLockedReason
addresses {
...VerifiableAddressFragment
}
phoneNumber {
...PhoneNumberFragment
}
emailConfirmed
status
setupStatus {
...AccountSetupStatusFragment
}
investingEntities {
...InvestingEntityFragment
}
identityVerifications {
...IdentityVerificationFragment
}
pepSearchResult {
...PEPSearchResultFragment
}
notes {
...NoteFragment
}
searchActivityFeed {
...ActivityFeedResultsFragment
}
totalPortfolioValue {
...MoneyFragment
}
jobTitle
industry
organization
twitterProfileUrl
linkedInProfileUrl
biography
accountManager {
...AdminUserFragment
}
tagsV2 {
...InvestorProfileTagFragment
}
connections {
...ConnectionFragment
}
outstandingTasks {
...TaskFragment
}
outstandingNotifications {
...AccountNotificationFragment
}
identityVerificationStatus
allHoldingsCSVUrl
identityVerificationLastSent
}
}
Variables
{"form": UpdatePartnershipInvestingEntityInput}
Response
{
"data": {
"updatePartnershipInvestingEntity": {
"id": 4,
"created": "2007-12-03T10:15:30Z",
"updated": "2007-12-03T10:15:30Z",
"lastLoggedIn": "2007-12-03T10:15:30Z",
"email": "abc123",
"hasPasswordSet": false,
"activationEmailLastSent": "2007-12-03T10:15:30Z",
"legalName": LegalName,
"preferredName": "abc123",
"timeZone": "abc123",
"dateOfBirth": DayMonthYear,
"termsAgreed": false,
"isAccountLocked": true,
"accountLockedReason": "abc123",
"addresses": [VerifiableAddress],
"phoneNumber": PhoneNumber,
"emailConfirmed": false,
"status": "PENDING",
"setupStatus": AccountSetupStatus,
"investingEntities": [InvestingEntity],
"identityVerifications": [IdentityVerification],
"pepSearchResult": PEPSearchResult,
"notes": [Note],
"searchActivityFeed": ActivityFeedResults,
"totalPortfolioValue": Money,
"jobTitle": "abc123",
"industry": "xyz789",
"organization": "abc123",
"twitterProfileUrl": "http://www.test.com/",
"linkedInProfileUrl": "http://www.test.com/",
"biography": "xyz789",
"accountManager": AdminUser,
"tagsV2": [InvestorProfileTag],
"connections": [Connection],
"outstandingTasks": [Task],
"outstandingNotifications": [AccountNotification],
"identityVerificationStatus": "INCOMPLETE",
"allHoldingsCSVUrl": "xyz789",
"identityVerificationLastSent": "2007-12-03T10:15:30Z"
}
}
}
updateProspect
Description
Update a specific prospect
Response
Returns a Prospect!
Arguments
| Name | Description |
|---|---|
form - UpdateProspectInput!
|
Example
Query
mutation updateProspect($form: UpdateProspectInput!) {
updateProspect(form: $form) {
id
created
email
firstName
middleName
lastName
preferredName
dateOfBirth {
...DayMonthYearFragment
}
address {
...AddressFragment
}
phoneNumber {
...PhoneNumberFragment
}
jobTitle
industry
organization
twitterProfileUrl
linkedInProfileUrl
biography
searchActivityFeed {
...ActivityFeedResultsFragment
}
tagsV2 {
...InvestorProfileTagFragment
}
connections {
...ConnectionFragment
}
outstandingTasks {
...TaskFragment
}
}
}
Variables
{"form": UpdateProspectInput}
Response
{
"data": {
"updateProspect": {
"id": "4",
"created": "2007-12-03T10:15:30Z",
"email": "xyz789",
"firstName": "abc123",
"middleName": "xyz789",
"lastName": "xyz789",
"preferredName": "xyz789",
"dateOfBirth": DayMonthYear,
"address": Address,
"phoneNumber": PhoneNumber,
"jobTitle": "abc123",
"industry": "abc123",
"organization": "abc123",
"twitterProfileUrl": "http://www.test.com/",
"linkedInProfileUrl": "http://www.test.com/",
"biography": "xyz789",
"searchActivityFeed": ActivityFeedResults,
"tagsV2": [InvestorProfileTag],
"connections": [Connection],
"outstandingTasks": [Task]
}
}
}
updateRegistrationOfInterest
Registration of Interest will be merged into Allocation
Description
Updates the registration of interest
Response
Returns a RegistrationOfInterest!
Arguments
| Name | Description |
|---|---|
form - UpdateRegistrationOfInterestInput!
|
Example
Query
mutation updateRegistrationOfInterest($form: UpdateRegistrationOfInterestInput!) {
updateRegistrationOfInterest(form: $form) {
id
created
status
interestedParty {
... on Account {
...AccountFragment
}
... on Prospect {
...ProspectFragment
}
}
offer {
...OfferFragment
}
unitCount
unitPrice {
...MoneyFragment
}
ownershipPercentage
amount {
...MoneyFragment
}
note
}
}
Variables
{"form": UpdateRegistrationOfInterestInput}
Response
{
"data": {
"updateRegistrationOfInterest": {
"id": 4,
"created": "2007-12-03T10:15:30Z",
"status": "INTERESTED",
"interestedParty": Account,
"offer": Offer,
"unitCount": 123,
"unitPrice": Money,
"ownershipPercentage": "xyz789",
"amount": Money,
"note": "xyz789"
}
}
}
updateSellOrder
Response
Returns a Fund!
Arguments
| Name | Description |
|---|---|
form - UpdateSellOrderInput!
|
Example
Query
mutation updateSellOrder($form: UpdateSellOrderInput!) {
updateSellOrder(form: $form) {
id
createdAt
updatedAt
name
legalName
shortDescription
summary {
...FundSummaryFragment
}
registrationNumber
legalStructure
assetStructure
inception
currency {
...CurrencyFragment
}
country {
...CountryFragment
}
cardImage {
...RemoteAssetFragment
}
totalUnitCountDecimal {
...FixedPointNumberFragment
}
calculatedNetAssetValue {
...MoneyFragment
}
targetCashReturn {
...FractionFragment
}
targetTotalReturn {
...FractionFragment
}
documents {
...FundDocumentFragment
}
assets {
...AssetFragment
}
asset {
...AssetFragment
}
offers {
...OfferFragment
}
distributions {
...DistributionFragment
}
searchDistributions {
...DistributionSearchResultsFragment
}
distribution {
...DistributionFragment
}
distributionV2 {
...DistributionV2Fragment
}
validateDistribution {
... on InvalidBankAccountDistributionAlert {
...InvalidBankAccountDistributionAlertFragment
}
}
secondaryMarket {
...SecondaryMarketFragment
}
sellOrder {
...SellOrderFragment
}
sellOrders {
...SellOrderFragment
}
buyOrder {
...BuyOrderFragment
}
buyOrders {
...BuyOrderFragment
}
offerStatus
investorType
largestOwnershipPercentageV2
numberOfActiveHoldings
fundManagerName
lastDistributionDate
equityRaised {
...MoneyFragment
}
hideDistributionMetrics
searchUnitRedemptionRequests {
...UnitRedemptionRequestSearchResultsFragment
}
unitRedemptionRequest {
...UnitRedemptionRequestFragment
}
unitRedemptionConfiguration {
...FundUnitRedemptionConfigurationFragment
}
unitPrecisionScale
searchUnitClasses {
...UnitClassSearchResultsFragment
}
showHoldingPageOnInvestorPortal
customMetrics {
...CustomMetricFragment
}
investorPortalConfiguration {
...FundInvestorPortalConfigurationFragment
}
unitTransferRequest {
...UnitTransferRequestFragment
}
depositBankAccount {
...BankAccountFragment
}
searchOutgoingBankAccounts {
...FundOutgoingBankAccountSearchResultsFragment
}
}
}
Variables
{"form": UpdateSellOrderInput}
Response
{
"data": {
"updateSellOrder": {
"id": "4",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"name": "abc123",
"legalName": "abc123",
"shortDescription": "xyz789",
"summary": FundSummary,
"registrationNumber": "abc123",
"legalStructure": "LIMITED_PARTNERSHIP",
"assetStructure": "SINGLE_ASSET",
"inception": "2007-12-03T10:15:30Z",
"currency": Currency,
"country": Country,
"cardImage": RemoteAsset,
"totalUnitCountDecimal": FixedPointNumber,
"calculatedNetAssetValue": Money,
"targetCashReturn": Fraction,
"targetTotalReturn": Fraction,
"documents": [FundDocument],
"assets": [Asset],
"asset": Asset,
"offers": [Offer],
"distributions": [Distribution],
"searchDistributions": DistributionSearchResults,
"distribution": Distribution,
"distributionV2": DistributionV2,
"validateDistribution": [
InvalidBankAccountDistributionAlert
],
"secondaryMarket": SecondaryMarket,
"sellOrder": SellOrder,
"sellOrders": [SellOrder],
"buyOrder": BuyOrder,
"buyOrders": [BuyOrder],
"offerStatus": "OPEN",
"investorType": "WHOLESALE",
"largestOwnershipPercentageV2": 123.45,
"numberOfActiveHoldings": 123,
"fundManagerName": "xyz789",
"lastDistributionDate": "2007-12-03T10:15:30Z",
"equityRaised": Money,
"hideDistributionMetrics": true,
"searchUnitRedemptionRequests": UnitRedemptionRequestSearchResults,
"unitRedemptionRequest": UnitRedemptionRequest,
"unitRedemptionConfiguration": FundUnitRedemptionConfiguration,
"unitPrecisionScale": 987,
"searchUnitClasses": UnitClassSearchResults,
"showHoldingPageOnInvestorPortal": true,
"customMetrics": [CustomMetric],
"investorPortalConfiguration": FundInvestorPortalConfiguration,
"unitTransferRequest": UnitTransferRequest,
"depositBankAccount": BankAccount,
"searchOutgoingBankAccounts": FundOutgoingBankAccountSearchResults
}
}
}
updateSystemTask
Description
Specifically modify an existing system task
Response
Returns a SystemTask!
Arguments
| Name | Description |
|---|---|
form - UpdateSystemTaskInput!
|
Example
Query
mutation updateSystemTask($form: UpdateSystemTaskInput!) {
updateSystemTask(form: $form) {
id
category
title
created
updated
status
dueAt
assignedAdmin {
...AdminUserFragment
}
notes {
...NoteFragment
}
type
pathSegments {
...TaskPathSegmentFragment
}
associatedRecord {
... on Account {
...AccountFragment
}
... on Prospect {
...ProspectFragment
}
... on InvestingEntity {
...InvestingEntityFragment
}
... on Fund {
...FundFragment
}
}
documents {
...TaskDocumentFragment
}
priority
relatedTasks {
...TaskFragment
}
assignedTeam
}
}
Variables
{"form": UpdateSystemTaskInput}
Response
{
"data": {
"updateSystemTask": {
"id": 4,
"category": "COMPLIANCE",
"title": "xyz789",
"created": "2007-12-03T10:15:30Z",
"updated": "2007-12-03T10:15:30Z",
"status": "OPEN",
"dueAt": "2007-12-03T10:15:30Z",
"assignedAdmin": AdminUser,
"notes": [Note],
"type": "ACCOUNT_VERIFY_ADDRESS_DOCUMENT",
"pathSegments": [TaskPathSegment],
"associatedRecord": Account,
"documents": [TaskDocument],
"priority": "NO_PRIORITY",
"relatedTasks": [Task],
"assignedTeam": "UNASSIGNED"
}
}
}
updateTag
Description
Update an existing tag.
Response
Returns a TagV2!
Arguments
| Name | Description |
|---|---|
form - UpdateTagInput!
|
Example
Query
mutation updateTag($form: UpdateTagInput!) {
updateTag(form: $form) {
... on InvestingEntityTag {
...InvestingEntityTagFragment
}
... on InvestorProfileTag {
...InvestorProfileTagFragment
}
}
}
Variables
{"form": UpdateTagInput}
Response
{"data": {"updateTag": InvestingEntityTag}}
updateTagsOnAccount
Description
Update tags on an account.
Response
Returns an Account!
Arguments
| Name | Description |
|---|---|
form - UpdateEntityTagsInput!
|
Example
Query
mutation updateTagsOnAccount($form: UpdateEntityTagsInput!) {
updateTagsOnAccount(form: $form) {
id
created
updated
lastLoggedIn
email
hasPasswordSet
activationEmailLastSent
legalName {
...LegalNameFragment
}
preferredName
timeZone
dateOfBirth {
...DayMonthYearFragment
}
termsAgreed
isAccountLocked
accountLockedReason
addresses {
...VerifiableAddressFragment
}
phoneNumber {
...PhoneNumberFragment
}
emailConfirmed
status
setupStatus {
...AccountSetupStatusFragment
}
investingEntities {
...InvestingEntityFragment
}
identityVerifications {
...IdentityVerificationFragment
}
pepSearchResult {
...PEPSearchResultFragment
}
notes {
...NoteFragment
}
searchActivityFeed {
...ActivityFeedResultsFragment
}
totalPortfolioValue {
...MoneyFragment
}
jobTitle
industry
organization
twitterProfileUrl
linkedInProfileUrl
biography
accountManager {
...AdminUserFragment
}
tagsV2 {
...InvestorProfileTagFragment
}
connections {
...ConnectionFragment
}
outstandingTasks {
...TaskFragment
}
outstandingNotifications {
...AccountNotificationFragment
}
identityVerificationStatus
allHoldingsCSVUrl
identityVerificationLastSent
}
}
Variables
{"form": UpdateEntityTagsInput}
Response
{
"data": {
"updateTagsOnAccount": {
"id": "4",
"created": "2007-12-03T10:15:30Z",
"updated": "2007-12-03T10:15:30Z",
"lastLoggedIn": "2007-12-03T10:15:30Z",
"email": "abc123",
"hasPasswordSet": true,
"activationEmailLastSent": "2007-12-03T10:15:30Z",
"legalName": LegalName,
"preferredName": "abc123",
"timeZone": "xyz789",
"dateOfBirth": DayMonthYear,
"termsAgreed": false,
"isAccountLocked": false,
"accountLockedReason": "abc123",
"addresses": [VerifiableAddress],
"phoneNumber": PhoneNumber,
"emailConfirmed": false,
"status": "PENDING",
"setupStatus": AccountSetupStatus,
"investingEntities": [InvestingEntity],
"identityVerifications": [IdentityVerification],
"pepSearchResult": PEPSearchResult,
"notes": [Note],
"searchActivityFeed": ActivityFeedResults,
"totalPortfolioValue": Money,
"jobTitle": "abc123",
"industry": "abc123",
"organization": "abc123",
"twitterProfileUrl": "http://www.test.com/",
"linkedInProfileUrl": "http://www.test.com/",
"biography": "xyz789",
"accountManager": AdminUser,
"tagsV2": [InvestorProfileTag],
"connections": [Connection],
"outstandingTasks": [Task],
"outstandingNotifications": [AccountNotification],
"identityVerificationStatus": "INCOMPLETE",
"allHoldingsCSVUrl": "xyz789",
"identityVerificationLastSent": "2007-12-03T10:15:30Z"
}
}
}
updateTagsOnInvestingEntity
Description
Update tags on an investing entity.
Response
Returns an InvestingEntity!
Arguments
| Name | Description |
|---|---|
form - UpdateEntityTagsInput!
|
Example
Query
mutation updateTagsOnInvestingEntity($form: UpdateEntityTagsInput!) {
updateTagsOnInvestingEntity(form: $form) {
id
created
updated
entityType
entity {
... on IndividualInvestingEntity {
...IndividualInvestingEntityFragment
}
... on CompanyInvestingEntity {
...CompanyInvestingEntityFragment
}
... on TrustInvestingEntity {
...TrustInvestingEntityFragment
}
... on JointIndividualInvestingEntity {
...JointIndividualInvestingEntityFragment
}
... on PartnershipInvestingEntity {
...PartnershipInvestingEntityFragment
}
}
sourceOfFundsVerificationEmailLastSent
relationship
country {
...CountryFragment
}
bankAccounts {
...VerifiableBankAccountFragment
}
bankAccount {
...VerifiableBankAccountFragment
}
accreditationsStandardised {
...InvestingEntityStandardisedAccreditationFragment
}
accreditationCountry {
...CountryFragment
}
wholesaleCertificationStatus
primaryOwner {
...AccountFragment
}
accounts {
...AccountFragment
}
beneficialOwners {
...BeneficialOwnerFragment
}
beneficialOwner {
...BeneficialOwnerFragment
}
lastRequestedBeneficialOwnersContactDetails
lastRequestedWholesaleCertification
allocations {
...AllocationFragment
}
riskProfile {
...RiskProfileFragment
}
holdings {
...HoldingFragment
}
totalPortfolioValue {
...MoneyFragment
}
totalHoldingMarkedValue {
...MoneyFragment
}
totalCapitalContributed {
...MoneyFragment
}
searchActivityFeed {
...ActivityFeedResultsFragment
}
governingDocuments {
...InvestingEntityGoverningDocumentFragment
}
searchTransactionsV2 {
...SearchTransactionsResultsFragment
}
outstandingTaskCount
bankAccountVerificationStatus
sourceOfFundsVerificationStatus
outstandingTasks {
...TaskFragment
}
outstandingNotifications {
...InvestingEntityNotificationFragment
}
associatedAccounts {
...AssociatedAccountFragment
}
tags {
...InvestingEntityTagFragment
}
}
}
Variables
{"form": UpdateEntityTagsInput}
Response
{
"data": {
"updateTagsOnInvestingEntity": {
"id": "4",
"created": "2007-12-03T10:15:30Z",
"updated": "2007-12-03T10:15:30Z",
"entityType": "INDIVIDUAL",
"entity": IndividualInvestingEntity,
"sourceOfFundsVerificationEmailLastSent": "2007-12-03T10:15:30Z",
"relationship": "SHAREHOLDING_VOTING_RIGHTS_GREATER_THAN_25_PERCENT",
"country": Country,
"bankAccounts": [VerifiableBankAccount],
"bankAccount": VerifiableBankAccount,
"accreditationsStandardised": [
InvestingEntityStandardisedAccreditation
],
"accreditationCountry": Country,
"wholesaleCertificationStatus": "AWAITING",
"primaryOwner": Account,
"accounts": [Account],
"beneficialOwners": [BeneficialOwner],
"beneficialOwner": BeneficialOwner,
"lastRequestedBeneficialOwnersContactDetails": "2007-12-03T10:15:30Z",
"lastRequestedWholesaleCertification": "2007-12-03T10:15:30Z",
"allocations": [Allocation],
"riskProfile": RiskProfile,
"holdings": [Holding],
"totalPortfolioValue": Money,
"totalHoldingMarkedValue": Money,
"totalCapitalContributed": Money,
"searchActivityFeed": ActivityFeedResults,
"governingDocuments": [
InvestingEntityGoverningDocument
],
"searchTransactionsV2": SearchTransactionsResults,
"outstandingTaskCount": 987,
"bankAccountVerificationStatus": "PENDING",
"sourceOfFundsVerificationStatus": "COMPLETE",
"outstandingTasks": [Task],
"outstandingNotifications": [
InvestingEntityNotification
],
"associatedAccounts": [AssociatedAccount],
"tags": [InvestingEntityTag]
}
}
}
updateTagsOnProspect
Description
Update tags on a prospect.
Response
Returns a Prospect!
Arguments
| Name | Description |
|---|---|
form - UpdateEntityTagsInput!
|
Example
Query
mutation updateTagsOnProspect($form: UpdateEntityTagsInput!) {
updateTagsOnProspect(form: $form) {
id
created
email
firstName
middleName
lastName
preferredName
dateOfBirth {
...DayMonthYearFragment
}
address {
...AddressFragment
}
phoneNumber {
...PhoneNumberFragment
}
jobTitle
industry
organization
twitterProfileUrl
linkedInProfileUrl
biography
searchActivityFeed {
...ActivityFeedResultsFragment
}
tagsV2 {
...InvestorProfileTagFragment
}
connections {
...ConnectionFragment
}
outstandingTasks {
...TaskFragment
}
}
}
Variables
{"form": UpdateEntityTagsInput}
Response
{
"data": {
"updateTagsOnProspect": {
"id": "4",
"created": "2007-12-03T10:15:30Z",
"email": "abc123",
"firstName": "abc123",
"middleName": "xyz789",
"lastName": "xyz789",
"preferredName": "abc123",
"dateOfBirth": DayMonthYear,
"address": Address,
"phoneNumber": PhoneNumber,
"jobTitle": "xyz789",
"industry": "xyz789",
"organization": "xyz789",
"twitterProfileUrl": "http://www.test.com/",
"linkedInProfileUrl": "http://www.test.com/",
"biography": "xyz789",
"searchActivityFeed": ActivityFeedResults,
"tagsV2": [InvestorProfileTag],
"connections": [Connection],
"outstandingTasks": [Task]
}
}
}
updateTenantColorsConfiguration
Response
Returns a TenantConfiguration!
Arguments
| Name | Description |
|---|---|
form - UpdateTenantColorsConfigurationInput!
|
Example
Query
mutation updateTenantColorsConfiguration($form: UpdateTenantColorsConfigurationInput!) {
updateTenantColorsConfiguration(form: $form) {
general {
...TenantGeneralConfigurationFragment
}
emails {
...TenantEmailsConfigurationFragment
}
resources {
...TenantResourcesConfigurationFragment
}
links {
...TenantLinksConfigurationFragment
}
logos {
...TenantLogosConfigurationFragment
}
colors {
...TenantColorsConfigurationFragment
}
}
}
Variables
{"form": UpdateTenantColorsConfigurationInput}
Response
{
"data": {
"updateTenantColorsConfiguration": {
"general": TenantGeneralConfiguration,
"emails": TenantEmailsConfiguration,
"resources": TenantResourcesConfiguration,
"links": TenantLinksConfiguration,
"logos": TenantLogosConfiguration,
"colors": TenantColorsConfiguration
}
}
}
updateTenantEmailsConfiguration
Response
Returns a TenantConfiguration!
Arguments
| Name | Description |
|---|---|
form - UpdateTenantEmailsConfigurationInput!
|
Example
Query
mutation updateTenantEmailsConfiguration($form: UpdateTenantEmailsConfigurationInput!) {
updateTenantEmailsConfiguration(form: $form) {
general {
...TenantGeneralConfigurationFragment
}
emails {
...TenantEmailsConfigurationFragment
}
resources {
...TenantResourcesConfigurationFragment
}
links {
...TenantLinksConfigurationFragment
}
logos {
...TenantLogosConfigurationFragment
}
colors {
...TenantColorsConfigurationFragment
}
}
}
Variables
{"form": UpdateTenantEmailsConfigurationInput}
Response
{
"data": {
"updateTenantEmailsConfiguration": {
"general": TenantGeneralConfiguration,
"emails": TenantEmailsConfiguration,
"resources": TenantResourcesConfiguration,
"links": TenantLinksConfiguration,
"logos": TenantLogosConfiguration,
"colors": TenantColorsConfiguration
}
}
}
updateTenantLinksConfiguration
Response
Returns a TenantConfiguration!
Arguments
| Name | Description |
|---|---|
form - UpdateTenantLinksConfigurationInput!
|
Example
Query
mutation updateTenantLinksConfiguration($form: UpdateTenantLinksConfigurationInput!) {
updateTenantLinksConfiguration(form: $form) {
general {
...TenantGeneralConfigurationFragment
}
emails {
...TenantEmailsConfigurationFragment
}
resources {
...TenantResourcesConfigurationFragment
}
links {
...TenantLinksConfigurationFragment
}
logos {
...TenantLogosConfigurationFragment
}
colors {
...TenantColorsConfigurationFragment
}
}
}
Variables
{"form": UpdateTenantLinksConfigurationInput}
Response
{
"data": {
"updateTenantLinksConfiguration": {
"general": TenantGeneralConfiguration,
"emails": TenantEmailsConfiguration,
"resources": TenantResourcesConfiguration,
"links": TenantLinksConfiguration,
"logos": TenantLogosConfiguration,
"colors": TenantColorsConfiguration
}
}
}
updateTenantLogosConfiguration
Response
Returns a TenantConfiguration!
Arguments
| Name | Description |
|---|---|
form - UpdateTenantLogosConfigurationInput!
|
Example
Query
mutation updateTenantLogosConfiguration($form: UpdateTenantLogosConfigurationInput!) {
updateTenantLogosConfiguration(form: $form) {
general {
...TenantGeneralConfigurationFragment
}
emails {
...TenantEmailsConfigurationFragment
}
resources {
...TenantResourcesConfigurationFragment
}
links {
...TenantLinksConfigurationFragment
}
logos {
...TenantLogosConfigurationFragment
}
colors {
...TenantColorsConfigurationFragment
}
}
}
Variables
{"form": UpdateTenantLogosConfigurationInput}
Response
{
"data": {
"updateTenantLogosConfiguration": {
"general": TenantGeneralConfiguration,
"emails": TenantEmailsConfiguration,
"resources": TenantResourcesConfiguration,
"links": TenantLinksConfiguration,
"logos": TenantLogosConfiguration,
"colors": TenantColorsConfiguration
}
}
}
updateTenantResourcesConfiguration
Response
Returns a TenantConfiguration!
Arguments
| Name | Description |
|---|---|
form - UpdateTenantResourcesConfigurationInput!
|
Example
Query
mutation updateTenantResourcesConfiguration($form: UpdateTenantResourcesConfigurationInput!) {
updateTenantResourcesConfiguration(form: $form) {
general {
...TenantGeneralConfigurationFragment
}
emails {
...TenantEmailsConfigurationFragment
}
resources {
...TenantResourcesConfigurationFragment
}
links {
...TenantLinksConfigurationFragment
}
logos {
...TenantLogosConfigurationFragment
}
colors {
...TenantColorsConfigurationFragment
}
}
}
Variables
{"form": UpdateTenantResourcesConfigurationInput}
Response
{
"data": {
"updateTenantResourcesConfiguration": {
"general": TenantGeneralConfiguration,
"emails": TenantEmailsConfiguration,
"resources": TenantResourcesConfiguration,
"links": TenantLinksConfiguration,
"logos": TenantLogosConfiguration,
"colors": TenantColorsConfiguration
}
}
}
updateTrustInvestingEntity
Description
Update an existing trust investing entity
Response
Returns an Account!
Arguments
| Name | Description |
|---|---|
form - UpdateTrustInvestingEntityInput!
|
Example
Query
mutation updateTrustInvestingEntity($form: UpdateTrustInvestingEntityInput!) {
updateTrustInvestingEntity(form: $form) {
id
created
updated
lastLoggedIn
email
hasPasswordSet
activationEmailLastSent
legalName {
...LegalNameFragment
}
preferredName
timeZone
dateOfBirth {
...DayMonthYearFragment
}
termsAgreed
isAccountLocked
accountLockedReason
addresses {
...VerifiableAddressFragment
}
phoneNumber {
...PhoneNumberFragment
}
emailConfirmed
status
setupStatus {
...AccountSetupStatusFragment
}
investingEntities {
...InvestingEntityFragment
}
identityVerifications {
...IdentityVerificationFragment
}
pepSearchResult {
...PEPSearchResultFragment
}
notes {
...NoteFragment
}
searchActivityFeed {
...ActivityFeedResultsFragment
}
totalPortfolioValue {
...MoneyFragment
}
jobTitle
industry
organization
twitterProfileUrl
linkedInProfileUrl
biography
accountManager {
...AdminUserFragment
}
tagsV2 {
...InvestorProfileTagFragment
}
connections {
...ConnectionFragment
}
outstandingTasks {
...TaskFragment
}
outstandingNotifications {
...AccountNotificationFragment
}
identityVerificationStatus
allHoldingsCSVUrl
identityVerificationLastSent
}
}
Variables
{"form": UpdateTrustInvestingEntityInput}
Response
{
"data": {
"updateTrustInvestingEntity": {
"id": "4",
"created": "2007-12-03T10:15:30Z",
"updated": "2007-12-03T10:15:30Z",
"lastLoggedIn": "2007-12-03T10:15:30Z",
"email": "abc123",
"hasPasswordSet": true,
"activationEmailLastSent": "2007-12-03T10:15:30Z",
"legalName": LegalName,
"preferredName": "xyz789",
"timeZone": "abc123",
"dateOfBirth": DayMonthYear,
"termsAgreed": false,
"isAccountLocked": false,
"accountLockedReason": "xyz789",
"addresses": [VerifiableAddress],
"phoneNumber": PhoneNumber,
"emailConfirmed": true,
"status": "PENDING",
"setupStatus": AccountSetupStatus,
"investingEntities": [InvestingEntity],
"identityVerifications": [IdentityVerification],
"pepSearchResult": PEPSearchResult,
"notes": [Note],
"searchActivityFeed": ActivityFeedResults,
"totalPortfolioValue": Money,
"jobTitle": "abc123",
"industry": "abc123",
"organization": "abc123",
"twitterProfileUrl": "http://www.test.com/",
"linkedInProfileUrl": "http://www.test.com/",
"biography": "xyz789",
"accountManager": AdminUser,
"tagsV2": [InvestorProfileTag],
"connections": [Connection],
"outstandingTasks": [Task],
"outstandingNotifications": [AccountNotification],
"identityVerificationStatus": "INCOMPLETE",
"allHoldingsCSVUrl": "abc123",
"identityVerificationLastSent": "2007-12-03T10:15:30Z"
}
}
}
updateUnitClass
Description
Modify an existing Fund unit Class
Response
Returns a UnitClass!
Arguments
| Name | Description |
|---|---|
form - UpdateUnitClassInput!
|
Example
Query
mutation updateUnitClass($form: UpdateUnitClassInput!) {
updateUnitClass(form: $form) {
id
name
code
note
createdAt
unitCount {
...FixedPointNumberFragment
}
holdingCount
unitPrice {
...HighPrecisionMoneyFragment
}
netAssetValue {
...HighPrecisionMoneyFragment
}
outgoingBankAccount {
...FundOutgoingBankAccountFragment
}
managementFees {
...UnitClassFeeFragment
}
unitPrices {
...UnitPriceFragment
}
distributionRates {
...UnitClassDistributionRateFragment
}
}
}
Variables
{"form": UpdateUnitClassInput}
Response
{
"data": {
"updateUnitClass": {
"id": 4,
"name": "abc123",
"code": "abc123",
"note": "abc123",
"createdAt": "2007-12-03T10:15:30Z",
"unitCount": FixedPointNumber,
"holdingCount": 987,
"unitPrice": HighPrecisionMoney,
"netAssetValue": HighPrecisionMoney,
"outgoingBankAccount": FundOutgoingBankAccount,
"managementFees": [UnitClassFee],
"unitPrices": [UnitPrice],
"distributionRates": [UnitClassDistributionRate]
}
}
}
updateUnitClassDistributionRate
Description
Update an existing distribution rate for a unit class
Response
Returns a UnitClassDistributionRate!
Arguments
| Name | Description |
|---|---|
form - UpdateUnitClassDistributionRateInput!
|
Example
Query
mutation updateUnitClassDistributionRate($form: UpdateUnitClassDistributionRateInput!) {
updateUnitClassDistributionRate(form: $form) {
id
createdAt
effectiveFrom
rate {
... on UnitClassAnnualPercentageDistributionRate {
...UnitClassAnnualPercentageDistributionRateFragment
}
... on UnitClassTotalDollarAmountDistributionRate {
...UnitClassTotalDollarAmountDistributionRateFragment
}
... on UnitClassDailyCentsPerUnitDistributionRate {
...UnitClassDailyCentsPerUnitDistributionRateFragment
}
}
note
}
}
Variables
{"form": UpdateUnitClassDistributionRateInput}
Response
{
"data": {
"updateUnitClassDistributionRate": {
"id": 4,
"createdAt": "2007-12-03T10:15:30Z",
"effectiveFrom": "2007-12-03T10:15:30Z",
"rate": UnitClassAnnualPercentageDistributionRate,
"note": "abc123"
}
}
}
updateUnitRedemptionRequest
Description
Update an existing unit redemption request
Response
Returns a UnitRedemptionRequest!
Arguments
| Name | Description |
|---|---|
form - UpdateUnitRedemptionRequestInput!
|
Example
Query
mutation updateUnitRedemptionRequest($form: UpdateUnitRedemptionRequestInput!) {
updateUnitRedemptionRequest(form: $form) {
id
status
holding {
...HoldingFragment
}
unitCountDecimal {
...FixedPointNumberFragment
}
unitPrice {
...MoneyFragment
}
unitPriceV2 {
...HighPrecisionMoneyFragment
}
orderValue {
...MoneyFragment
}
dateReceived
dateOfRedemption
note {
...NoteFragment
}
tags
}
}
Variables
{"form": UpdateUnitRedemptionRequestInput}
Response
{
"data": {
"updateUnitRedemptionRequest": {
"id": "4",
"status": "REQUESTED",
"holding": Holding,
"unitCountDecimal": FixedPointNumber,
"unitPrice": Money,
"unitPriceV2": HighPrecisionMoney,
"orderValue": Money,
"dateReceived": "2007-12-03T10:15:30Z",
"dateOfRedemption": "2007-12-03T10:15:30Z",
"note": Note,
"tags": ["RELATED_PARTY_NCBO"]
}
}
}
updateUnitTransferRequest
Description
Update an existing unit transfer request
Response
Returns a UnitTransferRequest!
Arguments
| Name | Description |
|---|---|
form - UpdateUnitTransferRequestInput!
|
Example
Query
mutation updateUnitTransferRequest($form: UpdateUnitTransferRequestInput!) {
updateUnitTransferRequest(form: $form) {
id
status
fromHolding {
...HoldingFragment
}
toInvestingEntity {
...InvestingEntityFragment
}
unitCount {
...FixedPointNumberFragment
}
unitPrice {
...MoneyFragment
}
totalValue {
...MoneyFragment
}
dateReceived
dateOfTransfer
note {
...NoteFragment
}
tags
}
}
Variables
{"form": UpdateUnitTransferRequestInput}
Response
{
"data": {
"updateUnitTransferRequest": {
"id": "4",
"status": "REQUESTED",
"fromHolding": Holding,
"toInvestingEntity": InvestingEntity,
"unitCount": FixedPointNumber,
"unitPrice": Money,
"totalValue": Money,
"dateReceived": "2007-12-03T10:15:30Z",
"dateOfTransfer": "2007-12-03T10:15:30Z",
"note": Note,
"tags": ["RELATED_PARTY_NCBO"]
}
}
}
updateVerifiableBankAccount
Description
Update a verifiable bank account
Response
Returns a VerifiableBankAccount!
Arguments
| Name | Description |
|---|---|
form - UpdateVerifiableBankAccountInput!
|
Example
Query
mutation updateVerifiableBankAccount($form: UpdateVerifiableBankAccountInput!) {
updateVerifiableBankAccount(form: $form) {
id
created
updated
name
nickname
currency {
...CurrencyFragment
}
isDefaultAccount
status
documents {
...VerifiableDocumentFragment
}
investingEntity {
...InvestingEntityFragment
}
}
}
Variables
{"form": UpdateVerifiableBankAccountInput}
Response
{
"data": {
"updateVerifiableBankAccount": {
"id": "4",
"created": "2007-12-03T10:15:30Z",
"updated": "2007-12-03T10:15:30Z",
"name": "abc123",
"nickname": "xyz789",
"currency": Currency,
"isDefaultAccount": true,
"status": "PENDING",
"documents": [VerifiableDocument],
"investingEntity": InvestingEntity
}
}
}
uploadAccountDocument
Description
Upload a Document belonging to an Account
Response
Returns a Document!
Arguments
| Name | Description |
|---|---|
form - UploadAccountDocumentInput!
|
Example
Query
mutation uploadAccountDocument($form: UploadAccountDocumentInput!) {
uploadAccountDocument(form: $form) {
id
updatedAt
file {
...RemoteAssetFragment
}
modifiedBy {
...AdminUserFragment
}
}
}
Variables
{"form": UploadAccountDocumentInput}
Response
{
"data": {
"uploadAccountDocument": {
"id": 4,
"updatedAt": "2007-12-03T10:15:30Z",
"file": RemoteAsset,
"modifiedBy": AdminUser
}
}
}
uploadAccreditationCertificate
Description
Upload an accreditation certificate. Creates an accreditation against the specified investing entity
Response
Returns an InvestingEntity!
Arguments
| Name | Description |
|---|---|
form - UploadAccreditationCertificateInput!
|
Example
Query
mutation uploadAccreditationCertificate($form: UploadAccreditationCertificateInput!) {
uploadAccreditationCertificate(form: $form) {
id
created
updated
entityType
entity {
... on IndividualInvestingEntity {
...IndividualInvestingEntityFragment
}
... on CompanyInvestingEntity {
...CompanyInvestingEntityFragment
}
... on TrustInvestingEntity {
...TrustInvestingEntityFragment
}
... on JointIndividualInvestingEntity {
...JointIndividualInvestingEntityFragment
}
... on PartnershipInvestingEntity {
...PartnershipInvestingEntityFragment
}
}
sourceOfFundsVerificationEmailLastSent
relationship
country {
...CountryFragment
}
bankAccounts {
...VerifiableBankAccountFragment
}
bankAccount {
...VerifiableBankAccountFragment
}
accreditationsStandardised {
...InvestingEntityStandardisedAccreditationFragment
}
accreditationCountry {
...CountryFragment
}
wholesaleCertificationStatus
primaryOwner {
...AccountFragment
}
accounts {
...AccountFragment
}
beneficialOwners {
...BeneficialOwnerFragment
}
beneficialOwner {
...BeneficialOwnerFragment
}
lastRequestedBeneficialOwnersContactDetails
lastRequestedWholesaleCertification
allocations {
...AllocationFragment
}
riskProfile {
...RiskProfileFragment
}
holdings {
...HoldingFragment
}
totalPortfolioValue {
...MoneyFragment
}
totalHoldingMarkedValue {
...MoneyFragment
}
totalCapitalContributed {
...MoneyFragment
}
searchActivityFeed {
...ActivityFeedResultsFragment
}
governingDocuments {
...InvestingEntityGoverningDocumentFragment
}
searchTransactionsV2 {
...SearchTransactionsResultsFragment
}
outstandingTaskCount
bankAccountVerificationStatus
sourceOfFundsVerificationStatus
outstandingTasks {
...TaskFragment
}
outstandingNotifications {
...InvestingEntityNotificationFragment
}
associatedAccounts {
...AssociatedAccountFragment
}
tags {
...InvestingEntityTagFragment
}
}
}
Variables
{"form": UploadAccreditationCertificateInput}
Response
{
"data": {
"uploadAccreditationCertificate": {
"id": "4",
"created": "2007-12-03T10:15:30Z",
"updated": "2007-12-03T10:15:30Z",
"entityType": "INDIVIDUAL",
"entity": IndividualInvestingEntity,
"sourceOfFundsVerificationEmailLastSent": "2007-12-03T10:15:30Z",
"relationship": "SHAREHOLDING_VOTING_RIGHTS_GREATER_THAN_25_PERCENT",
"country": Country,
"bankAccounts": [VerifiableBankAccount],
"bankAccount": VerifiableBankAccount,
"accreditationsStandardised": [
InvestingEntityStandardisedAccreditation
],
"accreditationCountry": Country,
"wholesaleCertificationStatus": "AWAITING",
"primaryOwner": Account,
"accounts": [Account],
"beneficialOwners": [BeneficialOwner],
"beneficialOwner": BeneficialOwner,
"lastRequestedBeneficialOwnersContactDetails": "2007-12-03T10:15:30Z",
"lastRequestedWholesaleCertification": "2007-12-03T10:15:30Z",
"allocations": [Allocation],
"riskProfile": RiskProfile,
"holdings": [Holding],
"totalPortfolioValue": Money,
"totalHoldingMarkedValue": Money,
"totalCapitalContributed": Money,
"searchActivityFeed": ActivityFeedResults,
"governingDocuments": [
InvestingEntityGoverningDocument
],
"searchTransactionsV2": SearchTransactionsResults,
"outstandingTaskCount": 123,
"bankAccountVerificationStatus": "PENDING",
"sourceOfFundsVerificationStatus": "COMPLETE",
"outstandingTasks": [Task],
"outstandingNotifications": [
InvestingEntityNotification
],
"associatedAccounts": [AssociatedAccount],
"tags": [InvestingEntityTag]
}
}
}
uploadDepositReconciliationBankStatement
Description
Upload a bank statement of deposits to reconcile against orders. Returns number of successfully imported deposits.
Response
Returns an Int!
Arguments
| Name | Description |
|---|---|
form - UploadDepositReconciliationBankStatementInput!
|
Example
Query
mutation uploadDepositReconciliationBankStatement($form: UploadDepositReconciliationBankStatementInput!) {
uploadDepositReconciliationBankStatement(form: $form)
}
Variables
{"form": UploadDepositReconciliationBankStatementInput}
Response
{"data": {"uploadDepositReconciliationBankStatement": 987}}
uploadInvestingEntityGoverningDocument
Description
Upload a new governing document for an investing entity
Response
Returns an InvestingEntityGoverningDocument!
Arguments
| Name | Description |
|---|---|
form - UploadInvestingEntityGoverningDocumentInput!
|
Example
Query
mutation uploadInvestingEntityGoverningDocument($form: UploadInvestingEntityGoverningDocumentInput!) {
uploadInvestingEntityGoverningDocument(form: $form) {
id
name
updatedAt
file {
...RemoteAssetFragment
}
status
declinedReason
}
}
Variables
{"form": UploadInvestingEntityGoverningDocumentInput}
Response
{
"data": {
"uploadInvestingEntityGoverningDocument": {
"id": "4",
"name": "abc123",
"updatedAt": "2007-12-03T10:15:30Z",
"file": RemoteAsset,
"status": "PENDING",
"declinedReason": "xyz789"
}
}
}
uploadOfferDataRoomDocument
Description
Upload a document to an offer's data room
Response
Returns an Offer!
Arguments
| Name | Description |
|---|---|
form - UploadOfferDataRoomDocumentInput!
|
Example
Query
mutation uploadOfferDataRoomDocument($form: UploadOfferDataRoomDocumentInput!) {
uploadOfferDataRoomDocument(form: $form) {
capitalCallBatches {
...CapitalCallBatchConnectionFragment
}
capitalCallBatch {
...CapitalCallBatchFragment
}
id
displayName
createdAt
updatedAt
pricePerUnit {
...MoneyFragment
}
pricePerUnitV2 {
...HighPrecisionMoneyFragment
}
totalUnitCountDecimal {
...FixedPointNumberFragment
}
minimumUnitCountDecimal {
...FixedPointNumberFragment
}
maximumUnitCountDecimal {
...FixedPointNumberFragment
}
areUnitsIssued
status
openedAt
closedAt
fundsDeadline
settledAt
paymentReferencePrefix
allocations {
...AllocationFragment
}
capitalizationTable {
...CapitalizationTableFragment
}
totalEquity {
...MoneyFragment
}
totalEquityV2 {
...HighPrecisionMoneyFragment
}
registrationsOfInterest {
...RegistrationOfInterestFragment
}
fund {
...FundFragment
}
depositMethods {
...OfferDepositMethodFragment
}
digitalSubscription
slug
dataRoom {
...OfferDataRoomFragment
}
unitClass {
...UnitClassFragment
}
searchAllocations {
...AllocationSearchResultsFragment
}
}
}
Variables
{"form": UploadOfferDataRoomDocumentInput}
Response
{
"data": {
"uploadOfferDataRoomDocument": {
"capitalCallBatches": CapitalCallBatchConnection,
"capitalCallBatch": CapitalCallBatch,
"id": 4,
"displayName": "abc123",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"pricePerUnit": Money,
"pricePerUnitV2": HighPrecisionMoney,
"totalUnitCountDecimal": FixedPointNumber,
"minimumUnitCountDecimal": FixedPointNumber,
"maximumUnitCountDecimal": FixedPointNumber,
"areUnitsIssued": false,
"status": "OPEN",
"openedAt": "2007-12-03T10:15:30Z",
"closedAt": "2007-12-03T10:15:30Z",
"fundsDeadline": "2007-12-03T10:15:30Z",
"settledAt": "2007-12-03T10:15:30Z",
"paymentReferencePrefix": "xyz789",
"allocations": [Allocation],
"capitalizationTable": CapitalizationTable,
"totalEquity": Money,
"totalEquityV2": HighPrecisionMoney,
"registrationsOfInterest": [RegistrationOfInterest],
"fund": Fund,
"depositMethods": [OfferDepositMethod],
"digitalSubscription": "ENABLED",
"slug": "xyz789",
"dataRoom": OfferDataRoom,
"unitClass": UnitClass,
"searchAllocations": AllocationSearchResults
}
}
}
uploadProspectDocument
Description
Upload a Document belonging to a Prospect
Response
Returns a Document!
Arguments
| Name | Description |
|---|---|
form - UploadProspectDocumentInput!
|
Example
Query
mutation uploadProspectDocument($form: UploadProspectDocumentInput!) {
uploadProspectDocument(form: $form) {
id
updatedAt
file {
...RemoteAssetFragment
}
modifiedBy {
...AdminUserFragment
}
}
}
Variables
{"form": UploadProspectDocumentInput}
Response
{
"data": {
"uploadProspectDocument": {
"id": "4",
"updatedAt": "2007-12-03T10:15:30Z",
"file": RemoteAsset,
"modifiedBy": AdminUser
}
}
}
uploadTaskDocument
Description
Upload a document related to a task
Response
Returns a Task!
Arguments
| Name | Description |
|---|---|
form - UploadTaskDocumentInput!
|
Example
Query
mutation uploadTaskDocument($form: UploadTaskDocumentInput!) {
uploadTaskDocument(form: $form) {
id
title
created
updated
dueAt
status
assignedAdmin {
...AdminUserFragment
}
notes {
...NoteFragment
}
documents {
...TaskDocumentFragment
}
priority
relatedTasks {
...TaskFragment
}
assignedTeam
}
}
Variables
{"form": UploadTaskDocumentInput}
Response
{
"data": {
"uploadTaskDocument": {
"id": 4,
"title": "abc123",
"created": "2007-12-03T10:15:30Z",
"updated": "2007-12-03T10:15:30Z",
"dueAt": "2007-12-03T10:15:30Z",
"status": "OPEN",
"assignedAdmin": AdminUser,
"notes": [Note],
"documents": [TaskDocument],
"priority": "NO_PRIORITY",
"relatedTasks": [Task],
"assignedTeam": "UNASSIGNED"
}
}
}
verifyAccreditationCertificate
Description
Verify an accreditation certificate, marking it as verified
Response
Returns an InvestingEntityStandardisedAccreditation!
Arguments
| Name | Description |
|---|---|
form - VerifyAccreditationCertificateInput!
|
Example
Query
mutation verifyAccreditationCertificate($form: VerifyAccreditationCertificateInput!) {
verifyAccreditationCertificate(form: $form) {
id
updated
type
approvalStatus
country {
...CountryFragment
}
files {
...RemoteAssetFragment
}
signedAt
declinedReason
}
}
Variables
{"form": VerifyAccreditationCertificateInput}
Response
{
"data": {
"verifyAccreditationCertificate": {
"id": 4,
"updated": "2007-12-03T10:15:30Z",
"type": "SAFE_HARBOUR",
"approvalStatus": "PENDING",
"country": Country,
"files": [RemoteAsset],
"signedAt": "2007-12-03T10:15:30Z",
"declinedReason": "abc123"
}
}
}
verifyBankAccount
Description
Verify a bank account that is pending verification
Response
Returns a VerifiableBankAccount!
Arguments
| Name | Description |
|---|---|
form - VerifyBankAccountInput!
|
Example
Query
mutation verifyBankAccount($form: VerifyBankAccountInput!) {
verifyBankAccount(form: $form) {
id
created
updated
name
nickname
currency {
...CurrencyFragment
}
isDefaultAccount
status
documents {
...VerifiableDocumentFragment
}
investingEntity {
...InvestingEntityFragment
}
}
}
Variables
{"form": VerifyBankAccountInput}
Response
{
"data": {
"verifyBankAccount": {
"id": "4",
"created": "2007-12-03T10:15:30Z",
"updated": "2007-12-03T10:15:30Z",
"name": "xyz789",
"nickname": "abc123",
"currency": Currency,
"isDefaultAccount": true,
"status": "PENDING",
"documents": [VerifiableDocument],
"investingEntity": InvestingEntity
}
}
}
verifyInvestingEntityGoverningDocument
Description
Verify an investing entity governing document, marking it as approved
Response
Returns an InvestingEntityGoverningDocument!
Arguments
| Name | Description |
|---|---|
form - VerifyInvestingEntityGoverningDocumentInput!
|
Example
Query
mutation verifyInvestingEntityGoverningDocument($form: VerifyInvestingEntityGoverningDocumentInput!) {
verifyInvestingEntityGoverningDocument(form: $form) {
id
name
updatedAt
file {
...RemoteAssetFragment
}
status
declinedReason
}
}
Variables
{"form": VerifyInvestingEntityGoverningDocumentInput}
Response
{
"data": {
"verifyInvestingEntityGoverningDocument": {
"id": 4,
"name": "abc123",
"updatedAt": "2007-12-03T10:15:30Z",
"file": RemoteAsset,
"status": "PENDING",
"declinedReason": "xyz789"
}
}
}
Types
AUDBankAccountBankAccountLocationDetails
Fields
| Field Name | Description |
|---|---|
bsbCode - String!
|
BSB code for Australian bank accounts |
Example
{"bsbCode": "xyz789"}
AUDBankAccountInput
Fields
| Input Field | Description |
|---|---|
bsbCode - String!
|
Example
{"bsbCode": "abc123"}
AUDVerifiableBankAccount
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
created - DateTime!
|
|
updated - DateTime!
|
|
name - String!
|
|
nickname - String!
|
|
currency - Currency!
|
|
isDefaultAccount - Boolean!
|
|
status - BankAccountStatus!
|
|
documents - [VerifiableDocument!]!
|
|
accountNumber - String!
|
|
bsbCode - String!
|
|
investingEntity - InvestingEntity!
|
The investing entity that owns this bank account |
Example
{
"id": 4,
"created": "2007-12-03T10:15:30Z",
"updated": "2007-12-03T10:15:30Z",
"name": "abc123",
"nickname": "xyz789",
"currency": Currency,
"isDefaultAccount": false,
"status": "PENDING",
"documents": [VerifiableDocument],
"accountNumber": "xyz789",
"bsbCode": "xyz789",
"investingEntity": InvestingEntity
}
AcceptPEPMatchInput
Account
Description
User information
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
created - DateTime!
|
The time the account was created. NOTE: This only represents a subset of the Account fields. |
updated - DateTime!
|
The last time a field on the account was updated. NOTE: This only represents a subset of the Account fields. |
lastLoggedIn - DateTime
|
|
email - String!
|
|
hasPasswordSet - Boolean!
|
|
activationEmailLastSent - DateTime
|
|
legalName - LegalName!
|
|
preferredName - String
|
|
timeZone - String!
|
|
dateOfBirth - DayMonthYear
|
|
termsAgreed - Boolean!
|
|
isAccountLocked - Boolean!
|
|
accountLockedReason - String!
|
|
addresses - [VerifiableAddress!]!
|
|
phoneNumber - PhoneNumber!
|
|
emailConfirmed - Boolean!
|
|
status - AccountStatus!
|
|
setupStatus - AccountSetupStatus!
|
|
investingEntities - [InvestingEntity!]
|
|
identityVerifications - [IdentityVerification!]!
|
|
pepSearchResult - PEPSearchResult
|
|
notes - [Note!]!
|
|
searchActivityFeed - ActivityFeedResults!
|
|
Arguments |
|
totalPortfolioValue - Money
|
|
jobTitle - String
|
|
industry - String
|
|
organization - String
|
|
twitterProfileUrl - URL
|
|
linkedInProfileUrl - URL
|
|
biography - String
|
|
accountManager - AdminUser!
|
|
tagsV2 - [InvestorProfileTag!]
|
|
connections - [Connection!]
|
|
outstandingTasks - [Task!]
|
|
outstandingNotifications - [AccountNotification!]
|
|
identityVerificationStatus - IdentityVerificationStatus
|
|
allHoldingsCSVUrl - String!
|
|
identityVerificationLastSent - DateTime
|
|
Example
{
"id": 4,
"created": "2007-12-03T10:15:30Z",
"updated": "2007-12-03T10:15:30Z",
"lastLoggedIn": "2007-12-03T10:15:30Z",
"email": "xyz789",
"hasPasswordSet": false,
"activationEmailLastSent": "2007-12-03T10:15:30Z",
"legalName": LegalName,
"preferredName": "xyz789",
"timeZone": "abc123",
"dateOfBirth": DayMonthYear,
"termsAgreed": true,
"isAccountLocked": true,
"accountLockedReason": "abc123",
"addresses": [VerifiableAddress],
"phoneNumber": PhoneNumber,
"emailConfirmed": false,
"status": "PENDING",
"setupStatus": AccountSetupStatus,
"investingEntities": [InvestingEntity],
"identityVerifications": [IdentityVerification],
"pepSearchResult": PEPSearchResult,
"notes": [Note],
"searchActivityFeed": ActivityFeedResults,
"totalPortfolioValue": Money,
"jobTitle": "xyz789",
"industry": "abc123",
"organization": "xyz789",
"twitterProfileUrl": "http://www.test.com/",
"linkedInProfileUrl": "http://www.test.com/",
"biography": "abc123",
"accountManager": AdminUser,
"tagsV2": [InvestorProfileTag],
"connections": [Connection],
"outstandingTasks": [Task],
"outstandingNotifications": [AccountNotification],
"identityVerificationStatus": "INCOMPLETE",
"allHoldingsCSVUrl": "abc123",
"identityVerificationLastSent": "2007-12-03T10:15:30Z"
}
AccountCreatedActivityFeedItem
AccountEmailBatchRecipientConfiguration
Description
Account recipients filter for email batch.
The fields will contain the filter configuration that was selected to create the batch. If allAccountsIncluded is false, one of the other filter fields will be populated.
Fields
| Field Name | Description |
|---|---|
allAccountsIncluded - Boolean!
|
All accounts were selected as recipients of the email batch |
accountsFilter - [Account!]
|
The accounts that were selected in accountIds filter when creating the email batch |
accountTagsFilter - [InvestorProfileTag!]
|
Account tags that were selected as recipients filter of the email batch |
Example
{
"allAccountsIncluded": true,
"accountsFilter": [Account],
"accountTagsFilter": [InvestorProfileTag]
}
AccountEmailBatchRecipientConfigurationInput
Description
Configuration for selecting account recipients for an email batch.
Fields
| Input Field | Description |
|---|---|
allAccounts - Boolean!
|
Send emails to all accounts in the system, if true, other account filters will be ignored. Default = false |
accountIds - [ID!]
|
IDs of the accounts to filter recipients by |
accountTagIds - [ID!]
|
IDs of the tags associated with accounts to filter recipients by |
Example
{
"allAccounts": true,
"accountIds": ["4"],
"accountTagIds": ["4"]
}
AccountLoginActivityFeedItem
AccountNotification
Description
A notification related to an account
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
status - NotificationStatus!
|
|
created - DateTime!
|
Possible Types
| AccountNotification Types |
|---|
Example
{
"id": "4",
"status": "INCOMPLETE",
"created": "2007-12-03T10:15:30Z"
}
AccountPasswordUpdatedActivityFeedItem
AccountSetupStatus
Fields
| Field Name | Description |
|---|---|
emailConfirmationStatus - StepStatus!
|
|
accountDetailsStatus - StepStatus!
|
|
identityDetailsStatus - StepStatus!
|
|
addressDetailsStatus - StepStatus!
|
|
pepCheckStatus - StepStatus!
|
Example
{
"emailConfirmationStatus": "NOT_ACTIONABLE_NO_INFORMATION",
"accountDetailsStatus": "NOT_ACTIONABLE_NO_INFORMATION",
"identityDetailsStatus": "NOT_ACTIONABLE_NO_INFORMATION",
"addressDetailsStatus": "NOT_ACTIONABLE_NO_INFORMATION",
"pepCheckStatus": "NOT_ACTIONABLE_NO_INFORMATION"
}
AccountStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"PENDING"
AccreditationType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"SAFE_HARBOUR"
ActivityFeedEdge
Fields
| Field Name | Description |
|---|---|
cursor - String!
|
|
node - ActivityFeedItem!
|
Example
{
"cursor": "abc123",
"node": ActivityFeedItem
}
ActivityFeedFilter
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"DOCUMENTS"
ActivityFeedItem
Possible Types
| ActivityFeedItem Types |
|---|
Example
{
"id": 4,
"updatedAt": "2007-12-03T10:15:30Z"
}
ActivityFeedResults
Fields
| Field Name | Description |
|---|---|
edges - [ActivityFeedEdge!]!
|
|
pageInfo - PageInfo!
|
Example
{
"edges": [ActivityFeedEdge],
"pageInfo": PageInfo
}
ActivityMessage
ActivityMessageEdge
Fields
| Field Name | Description |
|---|---|
cursor - String!
|
|
node - ActivityMessage
|
Example
{
"cursor": "abc123",
"node": ActivityMessage
}
ActivitySearchResults
Fields
| Field Name | Description |
|---|---|
edges - [ActivityMessageEdge!]!
|
|
pageInfo - PageInfo!
|
Example
{
"edges": [ActivityMessageEdge],
"pageInfo": PageInfo
}
AddAccountNoteInput
AddAdminUsersInput
Fields
| Input Field | Description |
|---|---|
emails - [String!]!
|
Example
{"emails": ["xyz789"]}
AddBankAccountNotification
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
status - NotificationStatus!
|
|
created - DateTime!
|
Example
{
"id": 4,
"status": "INCOMPLETE",
"created": "2007-12-03T10:15:30Z"
}
AddBeneficialOwnerDocumentInput
AddBeneficialOwnerInput
Fields
| Input Field | Description |
|---|---|
investingEntityId - ID!
|
Investing Entity to add beneficial owner to |
parentBeneficialOwnerId - ID
|
Parent beneficial owner of this beneficial owner |
entityType - BeneficialOwnerEntityTypeInput!
|
Investing Entity type of this beneficial owner |
subType - EntitySubType
|
Investing Entity sub-type of this beneficial owner |
relationship - BeneficialOwnerRelationship!
|
Relationship of this beneficial owner to the parent |
email - String
|
Email address to contact this beneficial owner |
callingCode - String
|
Phone number calling code to contact this beneficial owner |
phoneNumber - String
|
Phone number to contact this beneficial owner |
entityName - String
|
Legal name of the beneficial owner (if company/trust/partnership) |
firstName - String
|
Legal first name/s of this beneficial owner |
middleName - String
|
Legal middle name of this beneficial owner |
lastName - String
|
Legal last name of this beneficial owner |
isIdentityVerificationExempt - Boolean
|
Is the beneficial owner exempt from completing identity verification (if individual) |
message - String
|
An optional note to add. Between 1 and 500 characters |
dateOfBirth - DayMonthYearInput
|
Date of birth of this beneficial owner |
Example
{
"investingEntityId": "4",
"parentBeneficialOwnerId": 4,
"entityType": "INDIVIDUAL",
"subType": "LIMITED_COMPANY",
"relationship": "DIRECTOR",
"email": "abc123",
"callingCode": "abc123",
"phoneNumber": "xyz789",
"entityName": "abc123",
"firstName": "abc123",
"middleName": "xyz789",
"lastName": "xyz789",
"isIdentityVerificationExempt": true,
"message": "abc123",
"dateOfBirth": DayMonthYearInput
}
AddDistributionComponentInput
Fields
| Input Field | Description |
|---|---|
calculationMethod - DistributionCalculationMethod!
|
|
label - String
|
|
componentType - DistributionComponentType!
|
|
unitClassId - ID
|
|
percentageCalculation - PercentageDistributionComponentInput
|
Required when calculationMethod is ANNUAL_PERCENTAGE |
totalDollarAmountCalculation - TotalDollarAmountDistributionComponentInput
|
Required when calculationMethod is TOTAL_DOLLAR_AMOUNT |
centsPerUnitCalculation - CentsPerUnitDistributionComponentInput
|
Required when calculationMethod is CENTS_PER_UNIT |
distributionRatesCalculation - DistributionRatesDistributionComponentInput
|
Required when calculationMethod is DISTRIBUTION_RATES |
Example
{
"calculationMethod": "TOTAL_DOLLAR_AMOUNT",
"label": "abc123",
"componentType": "DIVIDENDS",
"unitClassId": "4",
"percentageCalculation": PercentageDistributionComponentInput,
"totalDollarAmountCalculation": TotalDollarAmountDistributionComponentInput,
"centsPerUnitCalculation": CentsPerUnitDistributionComponentInput,
"distributionRatesCalculation": DistributionRatesDistributionComponentInput
}
AddInvestingEntityAccountLinkInput
Fields
| Input Field | Description |
|---|---|
investingEntityId - ID!
|
ID of the Investing entity to link |
accountId - ID!
|
ID of the Account to link to |
access - InvestingEntityAccountAccess!
|
Level of access to the investing entity |
suppressEmailNotification - Boolean
|
Disable email notifications for linked account |
Example
{
"investingEntityId": 4,
"accountId": "4",
"access": "FULL",
"suppressEmailNotification": true
}
AddInvestingEntityBankAccountInput
Fields
| Input Field | Description |
|---|---|
investingEntityId - ID!
|
|
bankAccountInput - BankAccountInput
|
|
verificationDocuments - [Upload!]!
|
Documents used for bank account verification |
Example
{
"investingEntityId": "4",
"bankAccountInput": BankAccountInput,
"verificationDocuments": [Upload]
}
AddInvestingEntityDocumentInput
Fields
| Input Field | Description |
|---|---|
investingEntityId - ID!
|
|
file - Upload!
|
|
name - String!
|
|
category - InvestingEntityDocumentCategory!
|
|
publishDate - DateTime!
|
|
visibility - InvestingEntityDocumentVisibility!
|
|
notifyByEmail - Boolean!
|
|
fundId - ID
|
Example
{
"investingEntityId": 4,
"file": Upload,
"name": "abc123",
"category": "TAX_STATEMENTS",
"publishDate": "2007-12-03T10:15:30Z",
"visibility": "INTERNAL",
"notifyByEmail": false,
"fundId": 4
}
AddInvestingEntityNoteInput
AddInvestingEntityNotification
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
status - NotificationStatus!
|
|
created - DateTime!
|
Example
{
"id": "4",
"status": "INCOMPLETE",
"created": "2007-12-03T10:15:30Z"
}
AddManualAllocationPaymentInput
Fields
| Input Field | Description |
|---|---|
allocationId - ID!
|
ID of the allocation to add the payment to |
amount - MoneyUnit!
|
|
paymentDate - DateTime!
|
|
from - PaymentBankAccount!
|
|
particulars - String
|
|
code - String
|
|
reference - String
|
|
notifyByEmail - Boolean
|
Whether to notify the investor by email |
Example
{
"allocationId": 4,
"amount": MoneyUnit,
"paymentDate": "2007-12-03T10:15:30Z",
"from": PaymentBankAccount,
"particulars": "abc123",
"code": "abc123",
"reference": "abc123",
"notifyByEmail": true
}
AddOfferDataRoomContentBlockInput
Fields
| Input Field | Description |
|---|---|
offerId - ID!
|
|
textBlock - OfferDataRoomTextBlockInput
|
|
tableBlock - OfferDataRoomTableBlockInput
|
Example
{
"offerId": 4,
"textBlock": OfferDataRoomTextBlockInput,
"tableBlock": OfferDataRoomTableBlockInput
}
AddProspectNoteInput
AddRelatedTasksInput
AddTaskNoteInput
Address
Description
Physical location, with full address information
Example
{
"id": 4,
"created": "2007-12-03T10:15:30Z",
"placeId": "xyz789",
"addressLine1": "xyz789",
"addressLine2": "abc123",
"suburb": "abc123",
"city": "abc123",
"postCode": "xyz789",
"country": Country,
"administrativeArea": "xyz789"
}
AddressInput
Fields
| Input Field | Description |
|---|---|
inputType - AddressInputType!
|
Inform the type of address input |
manualAddress - ManualAddressInput
|
Required when inputType is MANUAL and should be null when inputType is AUTO_COMPLETE |
autocompleteAddress - AutocompleteAddressInput
|
Required when inputType is AUTO_COMPLETE and should be null when inputType is MANUAL |
Example
{
"inputType": "AUTO_COMPLETE",
"manualAddress": ManualAddressInput,
"autocompleteAddress": AutocompleteAddressInput
}
AddressInputType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"AUTO_COMPLETE"
AddressSearchResult
AddressSearchResults
Fields
| Field Name | Description |
|---|---|
results - [AddressSearchResult!]!
|
|
sessionToken - String!
|
Example
{
"results": [AddressSearchResult],
"sessionToken": "xyz789"
}
AddressSearchType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"ADDRESS"
AddressVerification
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
checkedAt - DateTime
|
|
document - RemoteAsset
|
|
transactionId - String!
|
|
databases - [VerificationDatabase!]!
|
|
address - Address!
|
|
currentAddress - Boolean!
|
|
status - AddressVerificationStatus!
|
|
declinedReason - String
|
|
method - AddressVerificationMethod!
|
|
thirdParty - AddressVerificationThirdParty
|
|
validationDetails - [NameOrAddressValidationDetail!]
|
Example
{
"id": "4",
"checkedAt": "2007-12-03T10:15:30Z",
"document": RemoteAsset,
"transactionId": "xyz789",
"databases": [VerificationDatabase],
"address": Address,
"currentAddress": false,
"status": "PENDING",
"declinedReason": "xyz789",
"method": "THIRD_PARTY",
"thirdParty": "VERIFI",
"validationDetails": [NameOrAddressValidationDetail]
}
AddressVerificationMethod
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"THIRD_PARTY"
AddressVerificationStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"PENDING"
AddressVerificationStatusInput
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"APPROVED"
AddressVerificationThirdParty
Values
| Enum Value | Description |
|---|---|
|
|
Example
"VERIFI"
AdminManualIdentityVerification
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
dateAttempted - DateTime!
|
|
status - VerifiableIdentityVerificationStatus
|
|
verificationDocuments - [RemoteAsset!]
|
|
identityDocumentDetails - IdentityDocumentFields
|
Example
{
"id": "4",
"dateAttempted": "2007-12-03T10:15:30Z",
"status": "VERIFIED",
"verificationDocuments": [RemoteAsset],
"identityDocumentDetails": IdentityDocumentFields
}
AdminRole
Description
Represents a role in the system with associated permissions
Example
{
"id": "4",
"sequence": 123,
"name": "xyz789",
"description": "abc123"
}
AdminUser
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
email - String!
|
|
firstName - String
|
|
lastName - String
|
|
profileImageUrl - String
|
|
status - AdminUserStatus!
|
|
role - AdminRole!
|
|
jobTitle - String
|
|
phoneNumber - PhoneNumber
|
|
calendlyUrl - URL
|
|
team - AdminUserTeam
|
|
outstandingTasks - Int
|
|
intercomHash - String
|
Example
{
"id": 4,
"email": "xyz789",
"firstName": "abc123",
"lastName": "xyz789",
"profileImageUrl": "abc123",
"status": "ACTIVE",
"role": AdminRole,
"jobTitle": "abc123",
"phoneNumber": PhoneNumber,
"calendlyUrl": "http://www.test.com/",
"team": "INVESTOR_RELATIONS",
"outstandingTasks": 987,
"intercomHash": "abc123"
}
AdminUserStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"ACTIVE"
AdminUserTeam
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"INVESTOR_RELATIONS"
AdminUserTeamInput
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"UNSET"
AgreementDocumentActivityFeedItem
AgreementNoteActivityFeedItem
Allocation
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
createdAt - DateTime!
|
|
offer - Offer!
|
|
ownershipPercentage - String
|
Percentage (0-100) of the offer that this allocation represents |
investingEntity - InvestingEntity!
|
use associatedContact instead |
associatedContact - AllocationAssociatedRecord
|
The contact associated with this allocation |
status - AllocationStatus!
|
|
unitCountDecimal - FixedPointNumber!
|
Number of units in the allocation |
pricePerUnit - Money
|
The unit price of an allocation in 2dp. use pricePerUnitV2 |
pricePerUnitV2 - HighPrecisionMoney
|
The unit price of an allocation in 6dp. |
totalValue - Money!
|
The capital committed for this allocation |
expectedReference - String
|
Payment reference so that a transfer of funds can be attributed to a specific allocation request |
payments - [ManualAllocationPayment!]
|
Payments recorded against allocation after the introduction of manual reconciliation. |
totalPaid - Money!
|
The capital contributed for this allocation. Total amount of payments recorded against this allocation after the introduction of manual reconciliation. |
note - String
|
|
balance - Money!
|
The outstanding balance for this allocation, i.e. the allocation's total value minus the total paid amount |
unitsIssued - FixedPointNumber
|
Number of units that have been issued |
issuedHolding - Holding
|
The holding in which units have been issued via this allocation |
capitalCalled - HighPrecisionMoney
|
The total capital called for this allocation |
customFieldSection - [CustomFieldSection!]
|
Custom field sections responses for the allocation request |
Example
{
"id": 4,
"createdAt": "2007-12-03T10:15:30Z",
"offer": Offer,
"ownershipPercentage": "abc123",
"investingEntity": InvestingEntity,
"associatedContact": InvestingEntity,
"status": "INTERESTED",
"unitCountDecimal": FixedPointNumber,
"pricePerUnit": Money,
"pricePerUnitV2": HighPrecisionMoney,
"totalValue": Money,
"expectedReference": "abc123",
"payments": [ManualAllocationPayment],
"totalPaid": Money,
"note": "xyz789",
"balance": Money,
"unitsIssued": FixedPointNumber,
"issuedHolding": Holding,
"capitalCalled": HighPrecisionMoney,
"customFieldSection": [CustomFieldSection]
}
AllocationActivityFeedItem
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
updatedAt - DateTime!
|
|
allocation - Allocation
|
Possible Types
| AllocationActivityFeedItem Types |
|---|
Example
{
"id": 4,
"updatedAt": "2007-12-03T10:15:30Z",
"allocation": Allocation
}
AllocationAssociatedContactInput
Description
The associated contact to create or update the allocation for
Fields
| Input Field | Description |
|---|---|
type - AllocationAssociatedContactType!
|
|
id - ID!
|
Example
{"type": "ACCOUNT", "id": 4}
AllocationAssociatedContactType
Description
The type of the associated contact
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"ACCOUNT"
AllocationAssociatedRecord
Types
| Union Types |
|---|
Example
InvestingEntity
AllocationCancelledActivityFeedItem
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
updatedAt - DateTime!
|
|
allocation - Allocation
|
Example
{
"id": "4",
"updatedAt": "2007-12-03T10:15:30Z",
"allocation": Allocation
}
AllocationConfirmedActivityFeedItem
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
updatedAt - DateTime!
|
|
allocation - Allocation
|
Example
{
"id": 4,
"updatedAt": "2007-12-03T10:15:30Z",
"allocation": Allocation
}
AllocationDocumentActivityFeedItem
AllocationEdge
Description
An edge in the allocation search results
Fields
| Field Name | Description |
|---|---|
cursor - String!
|
The cursor to continue query from |
node - Allocation!
|
Example
{
"cursor": "abc123",
"node": Allocation
}
AllocationNoteActivityFeedItem
AllocationRequestedActivityFeedItem
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
updatedAt - DateTime!
|
|
allocation - Allocation
|
Example
{
"id": "4",
"updatedAt": "2007-12-03T10:15:30Z",
"allocation": Allocation
}
AllocationSearchResults
Description
Results for searching allocations
Fields
| Field Name | Description |
|---|---|
edges - [AllocationEdge!]!
|
The edges of the allocations |
pageInfo - PageInfo!
|
The page info for the allocations |
Example
{
"edges": [AllocationEdge],
"pageInfo": PageInfo
}
AllocationStatus
Values
| Enum Value | Description |
|---|---|
|
|
Pipeline Stage: Status is only for admin tracking purposes, not logic driven. This stage is typically for investors who have shown interest but haven't engaged meaningfully yet |
|
|
Pipeline Stage: Status is only for admin tracking purposes, not logic driven. This stage is typically for investors who are actively in discussion, reviewing materials, or moving forward in diligence |
|
|
Pipeline Stage: Status is only for admin tracking purposes, not logic driven. This stage is typically for investors who have been screened and meet requirements (e.g. accredited, passed KYC/AML) |
|
|
Pipeline Stage: Status is only for admin tracking purposes, not logic driven. This stage is typically for investors who have expressed an informal commitment (e.g. verbally committed or provided an indication of amount) |
|
|
Pipeline Stage: Status is only for admin tracking purposes, not logic driven. This stage is typically for investors who have given a firm allocation commitment (e.g. signed documents, locked-in commitment amounts) |
|
|
An admin user has been approved the allocation request and the investor is officially in. |
|
|
An admin user has cancelled the allocation request (investor dropped out or was rejected). |
|
|
replaced by one of the pipeline stages |
|
|
replaced by APPROVED |
|
|
replaced by APPROVED |
|
|
replaced by APPROVED |
|
|
replaced by REQUESTED |
Example
"INTERESTED"
AnnualPercentageFee
Description
Annual percentage fees are calculated daily based on: (1) the annual percentage rate effective on that day (2) the unit class NAV on that day
Example
{
"effectiveFrom": "2007-12-03T10:15:30Z",
"annualRate": "abc123"
}
AnnualPercentageFeeInput
Description
Annual percentage fees are calculated daily based on: (1) the annual percentage rate effective on that day (2) the unit class NAV on that day
Example
{
"effectiveFrom": "2007-12-03T10:15:30Z",
"annualRate": "xyz789"
}
Asset
Description
Asset which belongs to a Fund
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Unique identifier of the Asset |
name - String!
|
Common title given to the Asset |
address - String!
|
Describes where the Asset is located |
country - Country!
|
Country where the Asset is located |
cardImage - RemoteAsset
|
Image of the Asset, in card size format |
fund - Fund!
|
Fund that owns this Asset |
Example
{
"id": "4",
"name": "abc123",
"address": "abc123",
"country": Country,
"cardImage": RemoteAsset,
"fund": Fund
}
AssetStructure
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"SINGLE_ASSET"
AssociatedAccount
Fields
| Field Name | Description |
|---|---|
account - Account!
|
|
isKeyAccount - Boolean!
|
|
link - InvestingEntityAccountLink!
|
Example
{
"account": Account,
"isKeyAccount": true,
"link": InvestingEntityAccountLink
}
AuditLogApplicationType
Description
The type of application that the action was taken in
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"ADMIN_APP"
AuditLogAssociatedRecord
Types
| Union Types |
|---|
Example
Account
AuditLogAssociatedRecordType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"ACCOUNT"
AuditLogEntry
Description
An entry in the audit log
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
action - HTML!
|
A human readable description of the action that was taken |
date - DateTime!
|
Date and time the action was taken |
associatedRecord - AuditLogAssociatedRecord
|
The record that was modified |
application - AuditLogApplicationType
|
Type of application that the action was taken in |
modifiedBy - AuditLogModifierRecord
|
The user that took the action |
ipAddress - String
|
The IP address of the user that took the action |
Example
{
"id": "4",
"action": HTML,
"date": "2007-12-03T10:15:30Z",
"associatedRecord": Account,
"application": "ADMIN_APP",
"modifiedBy": Account,
"ipAddress": "xyz789"
}
AuditLogEntryConnection
Description
Represents search results for audit log entries
Fields
| Field Name | Description |
|---|---|
edges - [AuditLogEntryEdge]
|
|
pageInfo - PageInfo!
|
Example
{
"edges": [AuditLogEntryEdge],
"pageInfo": PageInfo
}
AuditLogEntryEdge
Description
Represents a search result for audit log entries
Fields
| Field Name | Description |
|---|---|
cursor - String!
|
|
node - AuditLogEntry!
|
Example
{
"cursor": "xyz789",
"node": AuditLogEntry
}
AuditLogModifierRecord
AutocompleteAddressInput
BPAYPaymentReference
Description
Represents a payment reference for an investor to be used with BPAY payments.
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Identifier for the payment reference |
createdAt - DateTime!
|
Date and time when the payment reference was created |
updatedAt - DateTime!
|
Date and time when the payment reference was last updated |
billerCode - String!
|
The BPAY biller code for the investor |
crn - String!
|
The BPAY CRN (Customer Reference Number) for the investor |
Example
{
"id": 4,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"billerCode": "abc123",
"crn": "xyz789"
}
BSBCodeValidationResponse
Description
Response from a BSB code validation request
Fields
| Field Name | Description |
|---|---|
isValid - Boolean!
|
True if the BSB code is valid |
Example
{"isValid": false}
BankAccount
Description
A bank account used by funds for deposits
Example
{
"id": 4,
"created": "2007-12-03T10:15:30Z",
"name": "xyz789",
"accountNumber": "xyz789",
"bsbCode": "abc123",
"routingNumber": "xyz789",
"ukSortCode": "xyz789",
"currency": Currency,
"businessIdentifierCode": "abc123"
}
BankAccountInput
Fields
| Input Field | Description |
|---|---|
name - String!
|
Name of the bank account holder |
nickname - String
|
Nickname for the bank account |
accountNumber - String!
|
Bank account number, e.g. 123456789 |
currencyCode - String!
|
ISO 4217 currency code for the bank account |
bankAccountLocationDetails - BankAccountLocationDetailsInput
|
Location specific details for the bank account, such as BSB for AUD, routing number for USD, etc. |
businessIdentifierCode - String
|
BIC/SWIFT Code |
Example
{
"name": "abc123",
"nickname": "xyz789",
"accountNumber": "abc123",
"currencyCode": "xyz789",
"bankAccountLocationDetails": BankAccountLocationDetailsInput,
"businessIdentifierCode": "abc123"
}
BankAccountLocationDetails
Example
AUDBankAccountBankAccountLocationDetails
BankAccountLocationDetailsInput
Description
Location specific details for bank accounts, only one of these fields should be provided based on the currencyCode in BankAccountInput
Fields
| Input Field | Description |
|---|---|
audBankAccount - AUDBankAccountInput
|
|
usdBankAccount - USDBankAccountInput
|
|
gbpBankAccount - GBPBankAccountInput
|
Example
{
"audBankAccount": AUDBankAccountInput,
"usdBankAccount": USDBankAccountInput,
"gbpBankAccount": GBPBankAccountInput
}
BankAccountStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"PENDING"
BankAccountV2
Fields
| Field Name | Description |
|---|---|
id - ID!
|
ID of the bank account |
name - String!
|
Name of the bank account holder |
accountNumber - String!
|
Bank account number |
currencyCode - String!
|
ISO 4217 alpha 3 currency code for the bank account |
bankAccountLocationDetails - BankAccountLocationDetails
|
Location specific details for the bank account, such as BSB for AUD, routing number for USD, etc. |
businessIdentifierCode - String
|
BIC/SWIFT Code |
Example
{
"id": 4,
"name": "abc123",
"accountNumber": "abc123",
"currencyCode": "xyz789",
"bankAccountLocationDetails": AUDBankAccountBankAccountLocationDetails,
"businessIdentifierCode": "xyz789"
}
BankPaymentReference
Description
Represents a payment reference for an investor to be used with a bank transfer.
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Identifier for the payment reference |
createdAt - DateTime!
|
Date and time when the payment reference was created |
updatedAt - DateTime!
|
Date and time when the payment reference was last updated |
reference - String!
|
The reference number used when making a wire transfer |
Example
{
"id": 4,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"reference": "abc123"
}
BeneficialOwner
Description
An entity required for AML in association with an investing entity
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
created - DateTime!
|
|
relationship - BeneficialOwnerRelationship!
|
|
nodes - [BeneficialOwner]!
|
|
notes - [Note]!
|
|
activity - [ActivityMessage]!
|
|
uploadedDocuments - [UploadedDocument!]!
|
|
parent - BeneficialOwnerParent
|
Possible Types
| BeneficialOwner Types |
|---|
Example
{
"id": 4,
"created": "2007-12-03T10:15:30Z",
"relationship": "DIRECTOR",
"nodes": [BeneficialOwner],
"notes": [Note],
"activity": [ActivityMessage],
"uploadedDocuments": [UploadedDocument],
"parent": EntityBeneficialOwner
}
BeneficialOwnerEdge
Fields
| Field Name | Description |
|---|---|
cursor - String!
|
|
node - BeneficialOwner!
|
Example
{
"cursor": "xyz789",
"node": BeneficialOwner
}
BeneficialOwnerEntityType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"COMPANY"
BeneficialOwnerEntityTypeInput
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"INDIVIDUAL"
BeneficialOwnerNoteActivityFeedItem
BeneficialOwnerParent
Types
| Union Types |
|---|
Example
EntityBeneficialOwner
BeneficialOwnerRelationship
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"DIRECTOR"
BeneficialOwnerSearchResults
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
|
edges - [BeneficialOwnerEdge!]!
|
Example
{
"pageInfo": PageInfo,
"edges": [BeneficialOwnerEdge]
}
Boolean
Description
The Boolean scalar type represents true or false.
Example
true
Bpay
BpayInput
Fields
| Input Field | Description |
|---|---|
billerCode - String!
|
Example
{"billerCode": "xyz789"}
BuyOrder
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
dateReceived - DateTime!
|
|
status - BuyOrderStatus!
|
|
investingEntity - InvestingEntity!
|
|
unitBidPrice - Money!
|
|
unitCount - Int!
|
Use unitCountDecimal instead |
unitCountDecimal - FixedPointNumber!
|
|
orderValue - Money!
|
|
note - Note!
|
|
sellOrder - SellOrder
|
Example
{
"id": 4,
"dateReceived": "2007-12-03T10:15:30Z",
"status": "REQUESTED",
"investingEntity": InvestingEntity,
"unitBidPrice": Money,
"unitCount": 987,
"unitCountDecimal": FixedPointNumber,
"orderValue": Money,
"note": Note,
"sellOrder": SellOrder
}
BuyOrderStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"REQUESTED"
CallTask
Description
Task to call an investor or potential investor
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
created - DateTime!
|
|
updated - DateTime!
|
|
status - TaskStatus!
|
|
dueAt - DateTime
|
|
assignedAdmin - AdminUser
|
|
notes - [Note!]!
|
|
title - String!
|
|
associatedRecord - TaskAssociatedRecord
|
|
documents - [TaskDocument!]
|
|
priority - TaskPriority
|
|
relatedTasks - [Task!]
|
|
assignedTeam - TaskAssignedTeam
|
Team that the task is assigned to |
Example
{
"id": 4,
"created": "2007-12-03T10:15:30Z",
"updated": "2007-12-03T10:15:30Z",
"status": "OPEN",
"dueAt": "2007-12-03T10:15:30Z",
"assignedAdmin": AdminUser,
"notes": [Note],
"title": "abc123",
"associatedRecord": Account,
"documents": [TaskDocument],
"priority": "NO_PRIORITY",
"relatedTasks": [Task],
"assignedTeam": "UNASSIGNED"
}
CancelAllocationInput
CancelBuyOrderInput
CancelManualAllocationPaymentInput
CancelSellOrderInput
CancelUnitRedemptionRequestInput
Description
Input for cancelling a unit redemption request
Example
{
"id": 4,
"sendEmail": false,
"cancellationReason": "abc123"
}
CancelUnitTransferRequestInput
Example
{
"id": "4",
"notifyByEmail": false,
"cancellationReason": "xyz789"
}
CapitalCall
Description
A capital call
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The ID of the capital call |
allocation - Allocation!
|
The allocation that the capital call is for |
capitalCommitted - HighPrecisionMoney!
|
Snapshot of the capital committed of the allocation at the time of the capital call |
capitalCalled - HighPrecisionMoney!
|
Snapshot of the capital called of the allocation at the time of the capital call. Can be $0.00 if the capital call batch's calculation type is CATCH_UP and the allocation had the highest capital called to date value. |
equalisationAmount - HighPrecisionMoney!
|
Equalisation amount that has been applied to the capital call. Supports both positive and negative values. |
amountPayable - HighPrecisionMoney!
|
Snapshot of the amount payable for the capital call that the investor is required to pay for this capital call. This is derived by summing capitalCalled and equalisationAmount on this capital call. |
capitalCalledToDate - HighPrecisionMoney!
|
Snapshot of the capital called to date of the allocation at the time of the capital call batch. This is the sum of all previous capital calls of the allocation and the current capital call batch's capitalCalled. |
capitalCalledToDatePercentage - Float!
|
Snapshot of the percentage (out of 100) of the capital called to date of the allocation at the time of the capital call |
capitalRemainingToBeCalled - HighPrecisionMoney!
|
Snapshot of the capital remaining to be called of the allocation at the time of the capital call |
failureMessages - [CapitalCallFailure!]
|
The failure messages for the capital call |
status - CapitalCallStatus!
|
The status of the capital call |
Example
{
"id": "4",
"allocation": Allocation,
"capitalCommitted": HighPrecisionMoney,
"capitalCalled": HighPrecisionMoney,
"equalisationAmount": HighPrecisionMoney,
"amountPayable": HighPrecisionMoney,
"capitalCalledToDate": HighPrecisionMoney,
"capitalCalledToDatePercentage": 987.65,
"capitalRemainingToBeCalled": HighPrecisionMoney,
"failureMessages": [CapitalCallFailure],
"status": "GENERATING"
}
CapitalCallBatch
Description
A capital call batch
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The ID of the capital call batch |
status - CapitalCallBatchStatus!
|
The status of the capital call batch |
calculationConfig - CapitalCallBatchCalculationConfig!
|
The calculation configuration for the capital call batch |
createdAt - DateTime!
|
The date and time the capital call batch was created |
noticeDate - DateTime
|
The notice date for the capital call batch |
paymentDeadline - DateTime
|
The payment deadline for the capital call batch |
name - String!
|
The name of the capital call batch |
commentary - String
|
The commentary to show in the capital call statements |
capitalCommitted - HighPrecisionMoney
|
The sum of capital committed for all capital calls in the batch |
capitalCalled - HighPrecisionMoney
|
The sum of capital called for all capital calls in the batch |
capitalCalledToDate - HighPrecisionMoney
|
The sum of capital called to date for all capital calls in the batch |
capitalRemainingToBeCalled - HighPrecisionMoney
|
The sum of capital remaining to be called for all capital calls in the batch |
capitalCallStatusCounts - [CapitalCallBatchStatusCount!]!
|
The counts of capital calls by status |
failureMessages - [CapitalCallBatchFailure!]
|
The failure messages for the capital call batch |
capitalCalls - CapitalCallConnection!
|
Query and return a paginated list of capital calls for this capital call batch |
Arguments |
|
isOutdated - Boolean!
|
Flag to indicate if the details of the batch are outdated and should be recalculated. This will be true if another capital call batch has been confirmed since the last recalculation. |
emailNotificationsEnabled - Boolean
|
Whether email notifications are enabled for the capital call batch |
publishNoticeToInvestorPortalEnabled - Boolean
|
Whether the notice is published to the investor portal for the capital call batch |
Example
{
"id": 4,
"status": "GENERATING",
"calculationConfig": CapitalCallBatchCalculationConfig,
"createdAt": "2007-12-03T10:15:30Z",
"noticeDate": "2007-12-03T10:15:30Z",
"paymentDeadline": "2007-12-03T10:15:30Z",
"name": "abc123",
"commentary": "abc123",
"capitalCommitted": HighPrecisionMoney,
"capitalCalled": HighPrecisionMoney,
"capitalCalledToDate": HighPrecisionMoney,
"capitalRemainingToBeCalled": HighPrecisionMoney,
"capitalCallStatusCounts": [
CapitalCallBatchStatusCount
],
"failureMessages": [CapitalCallBatchFailure],
"capitalCalls": CapitalCallConnection,
"isOutdated": true,
"emailNotificationsEnabled": true,
"publishNoticeToInvestorPortalEnabled": false
}
CapitalCallBatchCalculationConfig
Description
Calculation configuration for the capital call batch
Fields
| Field Name | Description |
|---|---|
calculationType - CapitalCallBatchCalculationType!
|
The type of calculation for the capital call batch |
totalDollarAmount - TotalDollarAmountCapitalCallBatchCalculationConfig
|
Required when calculationType is TOTAL_DOLLAR_AMOUNT |
Example
{
"calculationType": "TOTAL_DOLLAR_AMOUNT",
"totalDollarAmount": TotalDollarAmountCapitalCallBatchCalculationConfig
}
CapitalCallBatchCalculationConfigInput
Description
Input for configuring the calculation of a capital call batch
Fields
| Input Field | Description |
|---|---|
calculationType - CapitalCallBatchCalculationType!
|
Type of calculation for capital call batch |
totalDollarAmount - TotalDollarAmountCapitalCallBatchCalculationConfigInput
|
Required when calculationType is TOTAL_DOLLAR_AMOUNT |
Example
{
"calculationType": "TOTAL_DOLLAR_AMOUNT",
"totalDollarAmount": TotalDollarAmountCapitalCallBatchCalculationConfigInput
}
CapitalCallBatchCalculationType
Description
The different types of calculations for a capital call batch
Values
| Enum Value | Description |
|---|---|
|
|
Calculate the capital call batch to a total dollar amount |
|
|
Calculate the capital call batch to catch up to the latest capital call |
Example
"TOTAL_DOLLAR_AMOUNT"
CapitalCallBatchConnection
Description
Represents results for searching capital call batches
Fields
| Field Name | Description |
|---|---|
edges - [CapitalCallBatchEdge!]!
|
The edges of the capital call batches |
pageInfo - PageInfo!
|
The page info for the results |
Example
{
"edges": [CapitalCallBatchEdge],
"pageInfo": PageInfo
}
CapitalCallBatchEdge
Description
An edge in the capital call batch search results
Fields
| Field Name | Description |
|---|---|
cursor - String!
|
The cursor to continue query from |
node - CapitalCallBatch!
|
The capital call batch |
Example
{
"cursor": "abc123",
"node": CapitalCallBatch
}
CapitalCallBatchFailure
CapitalCallBatchSearchSort
Description
Input for sorting paginated capital call batches queries
Fields
| Input Field | Description |
|---|---|
field - CapitalCallBatchSearchSortField!
|
The field to sort by |
direction - SortDirection!
|
The direction to sort by |
Example
{"field": "NOTICE_DATE", "direction": "ASC"}
CapitalCallBatchSearchSortField
Description
The fields that can be sorted by
Values
| Enum Value | Description |
|---|---|
|
|
Example
"NOTICE_DATE"
CapitalCallBatchStatus
Description
The status of a capital call batch
Values
| Enum Value | Description |
|---|---|
|
|
The capital calls in the batch are currently being generated |
|
|
The capital calls in the batch has been calculated and the batch is ready for confirmation |
|
|
The capital call batch has been confirmed |
|
|
The capital call batch has failed to create. failureMessages on the capital call batch will contain the issues the batch ran into. |
Example
"GENERATING"
CapitalCallBatchStatusCount
Description
A count of capital calls by status
Fields
| Field Name | Description |
|---|---|
status - CapitalCallStatus!
|
The status of the capital calls |
count - Int!
|
The number of capital calls with this status |
Example
{"status": "GENERATING", "count": 123}
CapitalCallConnection
Description
Represents results for searching capital calls
Fields
| Field Name | Description |
|---|---|
edges - [CapitalCallEdge!]!
|
The edges of the capital calls |
pageInfo - PageInfo!
|
The page info for the capital calls |
Example
{
"edges": [CapitalCallEdge],
"pageInfo": PageInfo
}
CapitalCallEdge
Description
An edge in the capital call search results
Fields
| Field Name | Description |
|---|---|
cursor - String!
|
The cursor to continue query from |
node - CapitalCall!
|
The capital call |
Example
{
"cursor": "abc123",
"node": CapitalCall
}
CapitalCallFailure
CapitalCallSearchSort
Description
Input for sorting paginated capital calls queries
Fields
| Input Field | Description |
|---|---|
field - CapitalCallSearchSortField!
|
The field to sort by |
direction - SortDirection!
|
The direction to sort by |
Example
{"field": "ID", "direction": "ASC"}
CapitalCallSearchSortField
Description
The fields that can be sorted by
Values
| Enum Value | Description |
|---|---|
|
|
Example
"ID"
CapitalCallStatus
Description
The status of a capital call
Values
| Enum Value | Description |
|---|---|
|
|
The capital call is currently being calculated or re-calculated |
|
|
The capital call has been created but not yet confirmed |
|
|
The capital call is currently being confirmed. Notices are being generated and emails are scheduled to be sent. |
|
|
The capital call has been successfully processed for confirmation. A capital call will have this status when emails and notices have been sent to the investor (if enabled on the batch). |
|
|
The capital call has failed. failureMessages on the capital call will contain the issues the call ran into. |
|
|
The capital call has no data. No notice or emails will be sent to the investor. This is typically because the investor has no amount payable for this capital call batch. |
Example
"GENERATING"
CapitalizationTable
Fields
| Field Name | Description |
|---|---|
totalRegistrationOfInterestAmount - Money!
|
The sum of all registrations of interests against the offer |
totalRequestedAmount - Money
|
The sum of all allocations in requested |
totalApprovedAmount - Money
|
The sum of all allocations in approved |
totalCapitalCommitted - Money
|
The sum of capital committed of all allocations excluding cancelled |
totalCapitalContributed - Money
|
The sum of capital contributed of all allocations excluding cancelled |
totalAmountToBeRaised - Money
|
The number of units on offer multiplied by unit price |
totalCapitalCalled - HighPrecisionMoney
|
The sum of all confirmed capital called |
totalCapitalRemainingToBeCalled - HighPrecisionMoney
|
The sum of remaining capital to be called |
Example
{
"totalRegistrationOfInterestAmount": Money,
"totalRequestedAmount": Money,
"totalApprovedAmount": Money,
"totalCapitalCommitted": Money,
"totalCapitalContributed": Money,
"totalAmountToBeRaised": Money,
"totalCapitalCalled": HighPrecisionMoney,
"totalCapitalRemainingToBeCalled": HighPrecisionMoney
}
CentsPerUnitDistributionComponent
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
unitClass - UnitClass
|
Unit class that the component is for |
centsPerUnit - Money!
|
Amount of the component |
taxWithholdingMethod - TaxWithholdingMethod!
|
Method used to withhold tax for the component |
componentType - DistributionComponentType!
|
Type of the component |
label - String
|
Label for the component (optional) |
Example
{
"id": 4,
"unitClass": UnitClass,
"centsPerUnit": Money,
"taxWithholdingMethod": "NONE",
"componentType": "DIVIDENDS",
"label": "abc123"
}
CentsPerUnitDistributionComponentInput
Fields
| Input Field | Description |
|---|---|
centsPerUnit - MoneySubUnit!
|
|
taxWithholdingMethod - TaxWithholdingMethod!
|
Example
{
"centsPerUnit": MoneySubUnit,
"taxWithholdingMethod": "NONE"
}
Cheque
ChequeInput
CommunicationQueries
Description
Root queries related to communication features such as email
Fields
| Field Name | Description |
|---|---|
email - EmailQueries!
|
Email related queries |
Example
{"email": EmailQueries}
CompanyInvestingEntity
Fields
| Field Name | Description |
|---|---|
id - ID!
|
ID of the company investing entity |
name - String
|
Legal name of the company |
displayName - String
|
Display name of the company |
companyType - InvestingEntityCompanyType
|
Company type |
registrationNumber - String
|
Company Registration Number |
taxResidency - InvestingEntityTaxResidency
|
Tax residency details for the company |
nzPrescribedInvestorRate - NZPrescribedInvestorRateBasisPoints
|
NZ PIR |
nzPrescribedInvestorTaxDeclarationStatus - TaxDeclarationStatus
|
Declared status of the NZ PIR |
interestResidentWithholdingTax - ResidentWithholdingTaxRateBasisPoints
|
RWT rate on interest |
interestResidentWithholdingTaxDeclarationStatus - TaxDeclarationStatus
|
Declared status of the RWT |
nonResidentWithholdingTaxRate - NonResidentWithholdingTaxRateBasisPoints
|
NRWT rate on interest |
nonResidentWithholdingTaxDeclarationStatus - TaxDeclarationStatus
|
Declared status of the NRWT |
address - Address
|
Registered address of the company |
postalAddress - Address
|
Postal address for the company |
placeOfBusinessAddress - Address
|
Place of business for the company |
natureAndPurposeDetails - NatureAndPurposeDetails
|
Nature and purpose details for the company |
clientReferenceNumber - String
|
Client Reference Number for historical client references |
businessNumber - String
|
Business No. for reference |
paymentReference - String
|
Payment Reference for integration purposes use paymentReferences instead |
paymentReferences - [StaticPaymentReference!]!
|
References to be used by an investing entity when making payments |
Example
{
"id": "4",
"name": "abc123",
"displayName": "xyz789",
"companyType": "LIMITED_COMPANY",
"registrationNumber": "xyz789",
"taxResidency": InvestingEntityTaxResidency,
"nzPrescribedInvestorRate": "UNSET",
"nzPrescribedInvestorTaxDeclarationStatus": "DECLARED",
"interestResidentWithholdingTax": "RATE_0",
"interestResidentWithholdingTaxDeclarationStatus": "DECLARED",
"nonResidentWithholdingTaxRate": "RATE_0",
"nonResidentWithholdingTaxDeclarationStatus": "DECLARED",
"address": Address,
"postalAddress": Address,
"placeOfBusinessAddress": Address,
"natureAndPurposeDetails": NatureAndPurposeDetails,
"clientReferenceNumber": "xyz789",
"businessNumber": "xyz789",
"paymentReference": "abc123",
"paymentReferences": [BankPaymentReference]
}
CompanyResult
CompleteSellOrderInput
ConfirmAccreditationNotification
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
status - NotificationStatus!
|
|
created - DateTime!
|
Example
{
"id": "4",
"status": "INCOMPLETE",
"created": "2007-12-03T10:15:30Z"
}
ConfirmAllocationInput
Fields
| Input Field | Description |
|---|---|
id - ID!
|
|
notifyByEmail - Boolean
|
Whether to notify the investor of the allocation confirmation default is true |
generateCapitalCall - Boolean
|
Whether to generate a capital call and send a notice to the investor |
paymentDeadline - DateTime
|
The payment deadline for the allocation. Payment deadline is ignored if generateCapitalCall is false |
Example
{
"id": 4,
"notifyByEmail": false,
"generateCapitalCall": false,
"paymentDeadline": "2007-12-03T10:15:30Z"
}
ConfirmAustralianAccreditationNotification
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
status - NotificationStatus!
|
|
created - DateTime!
|
Example
{
"id": "4",
"status": "INCOMPLETE",
"created": "2007-12-03T10:15:30Z"
}
ConfirmBuyOrderInput
Fields
| Input Field | Description |
|---|---|
id - ID!
|
|
note - UpdateNoteInput
|
|
notifyByEmail - Boolean
|
Whether to notify the investors of the buy order confirmation, default is true |
Example
{"id": 4, "note": UpdateNoteInput, "notifyByEmail": false}
ConfirmCapitalCallBatchInput
Description
Input for confirming a capital call batch
Fields
| Input Field | Description |
|---|---|
id - ID!
|
ID of the capital call batch to confirm |
noticeDate - DateTime!
|
Notice date for the capital call batch |
notifyByEmail - Boolean!
|
Whether to notify the investor by email |
publishNoticeToInvestorPortal - Boolean!
|
Whether to publish the notice to the investor portal. publishNoticeToInvestorPortal must be true if notifyByEmail is true. |
Example
{
"id": 4,
"noticeDate": "2007-12-03T10:15:30Z",
"notifyByEmail": false,
"publishNoticeToInvestorPortal": true
}
ConfirmDistributionInput
Example
{
"distributionId": "4",
"notifyInvestors": true,
"publishStatementsToInvestorPortal": true,
"publishedAt": "2007-12-03T10:15:30Z",
"dateOfIssuance": "2007-12-03T10:15:30Z"
}
ConfirmEmailAddressNotification
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
status - NotificationStatus!
|
|
created - DateTime!
|
Example
{
"id": 4,
"status": "INCOMPLETE",
"created": "2007-12-03T10:15:30Z"
}
ConfirmEmailBatchInput
Description
Input for confirming and scheduling an email batch for delivery.
Example
{
"batchId": "4",
"scheduledAt": "2007-12-03T10:15:30Z"
}
ConfirmEmailBatchResponse
Types
| Union Types |
|---|
Example
EmailBatch
ConfirmIdentityDocumentDetailsNotification
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
status - NotificationStatus!
|
|
created - DateTime!
|
Example
{
"id": 4,
"status": "INCOMPLETE",
"created": "2007-12-03T10:15:30Z"
}
ConfirmImportBatchInput
ConfirmNewZealandAccreditationNotification
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
status - NotificationStatus!
|
|
created - DateTime!
|
Example
{
"id": "4",
"status": "INCOMPLETE",
"created": "2007-12-03T10:15:30Z"
}
ConfirmSellOrderInput
Fields
| Input Field | Description |
|---|---|
id - ID!
|
|
note - UpdateNoteInput
|
|
notifyByEmail - Boolean
|
Whether to notify the investor of the sell order confirmation, default is true |
Example
{"id": 4, "note": UpdateNoteInput, "notifyByEmail": false}
ConfirmStatementBatchInput
Description
Input for confirming a batch of statements.
Fields
| Input Field | Description |
|---|---|
id - ID!
|
The ID of the batch of statements to confirm. |
publishConfig - PublishStatementBatchInput!
|
Publish configuration for the batch. |
Example
{"id": 4, "publishConfig": PublishStatementBatchInput}
ConfirmUnitRedemptionRequestInput
Description
Input for confirming an existing unit redemption request
Example
{
"id": "4",
"sendEmail": true,
"publishStatementsToInvestorPortal": false,
"dateOfRedemption": "2007-12-03T10:15:30Z"
}
ConfirmUnitTransferRequestInput
Example
{
"id": "4",
"notifyByEmail": true,
"publishStatementsToInvestorPortal": false
}
ConfirmUnsupportedCountryAccreditationNotification
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
status - NotificationStatus!
|
|
created - DateTime!
|
|
country - Country!
|
Example
{
"id": 4,
"status": "INCOMPLETE",
"created": "2007-12-03T10:15:30Z",
"country": Country
}
Connection
Fields
| Field Name | Description |
|---|---|
id - ID!
|
ID of the connection |
dateCreated - DateTime!
|
|
description - String!
|
Description of the connection |
to - ConnectionProfile!
|
Profile of the connected entity |
Example
{
"id": 4,
"dateCreated": "2007-12-03T10:15:30Z",
"description": "abc123",
"to": Prospect
}
ConnectionEntityType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"PROSPECT"
ConnectionInput
Fields
| Input Field | Description |
|---|---|
id - ID!
|
ID of the entity to connect |
type - ConnectionEntityType!
|
Type of the entity to connect |
Example
{"id": 4, "type": "PROSPECT"}
ConnectionProfile
ContextDataLink
Description
Link to data in the system that should be included when rendering emails
Fields
| Input Field | Description |
|---|---|
type - ContextLinkType!
|
The type of link |
id - ID!
|
The id of the entity |
name - String!
|
The name of the data link in the template variables of the email batch. The name must be unique across all data links in the email batch and contain only alphanumeric characters and underscores e.g. "acme_fund" |
Example
{"type": "FUND", "id": 4, "name": "xyz789"}
ContextLinkType
Description
Different entities that can be accessed when composing an email
Values
| Enum Value | Description |
|---|---|
|
|
Include fund data in template variables |
|
|
Include distribution data in template variables. Data of the fund the distribution is in will also be available. DISTRIBUTION ContextLinkType can only be used if recipient configuration is for an investing entity. |
|
|
Include offer data in template variables |
Example
"FUND"
ConvertProspectToAccountInput
Fields
| Input Field | Description |
|---|---|
id - ID!
|
The ID of the prospect to convert |
Example
{"id": 4}
ConvertRegistrationOfInterestInput
Description
Deprecated: Registration of Interest will be merged into Allocation
Fields
| Input Field | Description |
|---|---|
id - ID!
|
|
investingEntityID - ID!
|
The investing entity to create the allocation for. Does not need to be related to the account or prospect |
unitCount - Int
|
If provided: will update the expression of interest and copy that to the allocation |
unitPrice - MoneyUnit
|
The price per unit in the offers currency |
note - String
|
If provided: will update the expression of interest and copy that to the allocation |
notifyByEmail - Boolean!
|
If true, an email will be sent to the investor that an order has been placed |
Example
{
"id": "4",
"investingEntityID": "4",
"unitCount": 987,
"unitPrice": MoneyUnit,
"note": "xyz789",
"notifyByEmail": true
}
Country
Description
Country data source
Example
{
"id": "4",
"name": "New Zealand",
"isoAlpha2": "NZ",
"isoAlpha3": "NZL",
"callingCode": 64
}
CountryFilter
Values
| Enum Value | Description |
|---|---|
|
|
Example
"HAS_CURRENCY"
CreateAllocationInput
Fields
| Input Field | Description |
|---|---|
offerId - ID!
|
ID of the offer to create the allocation request for |
associatedContact - AllocationAssociatedContactInput
|
The associated contact to create the allocation for |
unitCountDecimal - FixedPointNumberInput!
|
Number of units in the allocation request |
pricePerUnit - MoneyUnit
|
Set a 2 decimal unit price for the allocation. When null, the default unit price from the offer will be used. |
pricePerUnitV2 - HighPrecisionMoneyInput
|
Set a 6 decimal unit price for the allocation. When null, the default unit price from the offer will be used. |
note - String
|
The note to associate with the allocation |
notifyByEmail - Boolean
|
Whether to notify the investor of the allocation creation default is true |
Example
{
"offerId": 4,
"associatedContact": AllocationAssociatedContactInput,
"unitCountDecimal": FixedPointNumberInput,
"pricePerUnit": MoneyUnit,
"pricePerUnitV2": HighPrecisionMoneyInput,
"note": "xyz789",
"notifyByEmail": false
}
CreateAnnualPercentageUnitClassFeeInput
Fields
| Input Field | Description |
|---|---|
unitClassId - ID!
|
The ID of the unit class the fee will apply to |
config - AnnualPercentageFeeInput!
|
Fee configuration |
note - String
|
Optional note to include on this fee |
Example
{
"unitClassId": "4",
"config": AnnualPercentageFeeInput,
"note": "abc123"
}
CreateAssetInput
Description
Create a new Asset
Fields
| Input Field | Description |
|---|---|
name - String!
|
Common title given to the Asset |
address - String!
|
Describes where the Asset is located |
countryId - ID!
|
Country where the Asset is located |
cardImage - Upload!
|
Image file upload - to be used on Asset cards. Size: 100MB, accepted files: jpg, png, gif, webp |
fundId - ID
|
The Fund that owns this Asset |
Example
{
"name": "abc123",
"address": "xyz789",
"countryId": 4,
"cardImage": Upload,
"fundId": "4"
}
CreateCapitalCallBatchInput
Description
Input for creating a new capital call batch for an offer
Fields
| Input Field | Description |
|---|---|
offerId - ID!
|
ID of the offer to create the capital call batch for |
name - String!
|
Name of the capital call batch |
calculationConfig - CapitalCallBatchCalculationConfigInput!
|
Configuration for the capital call batch calculation |
paymentDeadline - DateTime
|
Optional payment deadline for the capital call batch |
commentary - String
|
Optional commentary for the capital call batch, this will be included in the notice statement |
Example
{
"offerId": 4,
"name": "abc123",
"calculationConfig": CapitalCallBatchCalculationConfigInput,
"paymentDeadline": "2007-12-03T10:15:30Z",
"commentary": "xyz789"
}
CreateCompanyInvestingEntityInput
Fields
| Input Field | Description |
|---|---|
accountId - ID!
|
ID of the Account to create the Investing Entity for |
companyName - String!
|
legal name of the company |
displayName - String
|
display name of the company |
registeredAddress - AddressInput
|
Registered address of the entity |
postalAddress - AddressInput
|
Postal address of the entity |
placeOfBusinessAddress - AddressInput
|
Place of business details of the entity |
companyType - InvestingEntityCompanyType!
|
Company type |
companyRegistrationNumber - String!
|
Company Registration Number |
taxResidency - TaxResidencyInput
|
Tax residency for the individual |
nzPrescribedInvestorRate - NZPrescribedInvestorRateBasisPoints
|
NZ PIR |
nzPrescribedInvestorTaxDeclarationStatus - TaxDeclarationStatus
|
Declared status of the NZ PIR |
interestResidentWithholdingTax - ResidentWithholdingTaxRateBasisPoints
|
RWT rate on interest |
interestResidentWithholdingTaxDeclarationStatus - TaxDeclarationStatus
|
Declared status of the RWT |
nonResidentWithholdingTaxRate - NonResidentWithholdingTaxRateBasisPoints
|
NRWT rate on interest |
nonResidentWithholdingTaxDeclarationStatus - TaxDeclarationStatus
|
Declared status of the NRWT |
natureAndPurpose - CreateNatureAndPurposeInput!
|
nature and purpose details for the company |
clientReferenceNumber - String
|
Client Reference Number for historical client references |
businessNumber - String
|
Business No. for reference |
paymentReference - String
|
Payment Reference for integration purposes |
Example
{
"accountId": "4",
"companyName": "xyz789",
"displayName": "xyz789",
"registeredAddress": AddressInput,
"postalAddress": AddressInput,
"placeOfBusinessAddress": AddressInput,
"companyType": "LIMITED_COMPANY",
"companyRegistrationNumber": "xyz789",
"taxResidency": TaxResidencyInput,
"nzPrescribedInvestorRate": "UNSET",
"nzPrescribedInvestorTaxDeclarationStatus": "DECLARED",
"interestResidentWithholdingTax": "RATE_0",
"interestResidentWithholdingTaxDeclarationStatus": "DECLARED",
"nonResidentWithholdingTaxRate": "RATE_0",
"nonResidentWithholdingTaxDeclarationStatus": "DECLARED",
"natureAndPurpose": CreateNatureAndPurposeInput,
"clientReferenceNumber": "xyz789",
"businessNumber": "xyz789",
"paymentReference": "xyz789"
}
CreateConnectionInput
Fields
| Input Field | Description |
|---|---|
from - ConnectionInput!
|
|
to - ConnectionInput!
|
|
note - String!
|
Example
{
"from": ConnectionInput,
"to": ConnectionInput,
"note": "abc123"
}
CreateDepositMethodInput
Description
DepositMethod without ID fields
Fields
| Input Field | Description |
|---|---|
name - String!
|
Name of the deposit method, e.g. 'My favorite bank account' |
paymentMethod - PaymentMethodInput!
|
Bank account / cheque / BPAY without an ID |
Example
{
"name": "xyz789",
"paymentMethod": PaymentMethodInput
}
CreateDistributionInput
Example
{
"fundId": 4,
"name": "xyz789",
"periodFrom": "2007-12-03T10:15:30Z",
"periodTo": "2007-12-03T10:15:30Z",
"paymentDate": "2007-12-03T10:15:30Z",
"addComponents": [AddDistributionComponentInput],
"statementCommentary": "abc123"
}
CreateEmailBatchContextConfigurationInput
Description
Configuration for what data to include when rendering the email template. The template will always contain default details about the batch, sender, and recipient. This can be used to add additional context such as fund data, distributions, etc.
Fields
| Input Field | Description |
|---|---|
links - [ContextDataLink!]
|
Links to entities that will be available in the email template as context data. For example, if a FUND link is provided, the email template will be able to access details about the fund in the email template. These links will be validated at email render time. If the link can't be resolved for a recipient an error will be recorded for that recipient/message and the batch would not be able to be sent before this is resolved. |
Example
{"links": [ContextDataLink]}
CreateEmailBatchInput
Description
Input for creating a new email batch with sender, template, and name information.
Fields
| Input Field | Description |
|---|---|
senderId - ID!
|
ID of the sender who will be sending this email batch |
templateId - ID!
|
ID of the template to use as the base for this email batch |
name - String!
|
Human-readable name for this email batch |
recipients - CreateEmailBatchRecipientConfigurationInput!
|
Configuration for selecting recipients for this email batch. The configuration will determine which users receive the emails in the batch. |
context - CreateEmailBatchContextConfigurationInput
|
Configuration for what context to include in the template when editing and rendering the email. If not provided, only default details will be available in the templating editor. |
Example
{
"senderId": "4",
"templateId": "4",
"name": "xyz789",
"recipients": CreateEmailBatchRecipientConfigurationInput,
"context": CreateEmailBatchContextConfigurationInput
}
CreateEmailBatchRecipientConfigurationInput
Description
Configuration for selecting which users will receive emails in a batch.
Fields
| Input Field | Description |
|---|---|
account - AccountEmailBatchRecipientConfigurationInput
|
Configuration for selecting account recipients for this email batch. |
investingEntity - InvestingEntityEmailBatchRecipientConfigurationInput
|
Configuration for selecting investing entity recipients for this email batch. |
Example
{
"account": AccountEmailBatchRecipientConfigurationInput,
"investingEntity": InvestingEntityEmailBatchRecipientConfigurationInput
}
CreateEmailBatchResponse
Types
| Union Types |
|---|
Example
EmailBatch
CreateEmailTemplateInput
Description
Input for creating a new email template
Fields
| Input Field | Description |
|---|---|
name - String!
|
Name of the email template. Maximum allowed length is 255 characters. |
template - String!
|
Template string for the email, may contain placeholders. Maximum allowed length is 100000 characters. |
fundId - ID
|
Optional ID of the fund that the email template is associated with |
Example
{
"name": "abc123",
"template": "abc123",
"fundId": "4"
}
CreateFundDocumentInput
Description
Create a Document against a Fund
Fields
| Input Field | Description |
|---|---|
fundId - ID!
|
Unique identifier of the Fund that will be associated with the Document |
name - String!
|
Descriptive title of the Document |
file - Upload!
|
File to be uploaded |
publishDate - DateTime!
|
Date/Time from which the Document will be available |
visibility - FundDocumentVisibility!
|
Visibility of the Document |
notifyInvestorsByEmail - Boolean!
|
Whether to notify investors in the fund by email when the document is available |
category - FundDocumentCategory!
|
Category to associate with the Document |
unitClassId - ID
|
ID of the unit class to associate with the Document |
Example
{
"fundId": 4,
"name": "xyz789",
"file": Upload,
"publishDate": "2007-12-03T10:15:30Z",
"visibility": "INTERNAL",
"notifyInvestorsByEmail": true,
"category": "OFFER_DOCUMENTS",
"unitClassId": "4"
}
CreateFundInitialOutgoingBankAccountInput
Fields
| Input Field | Description |
|---|---|
name - String!
|
Name of the bank account |
accountNumber - String!
|
Bank account number |
currencyCode - String!
|
ISO 4217 alpha 3 currency code for the bank account |
bankAccountLocationDetails - BankAccountLocationDetailsInput
|
Location specific details for the bank account, such as BSB for AUD, routing number for USD, etc. |
businessIdentifierCode - String
|
BIC/SWIFT Code |
setFundDefault - Boolean
|
Sets the bank account as the default for the fund. Setting all others to false |
Example
{
"name": "xyz789",
"accountNumber": "abc123",
"currencyCode": "abc123",
"bankAccountLocationDetails": BankAccountLocationDetailsInput,
"businessIdentifierCode": "xyz789",
"setFundDefault": true
}
CreateFundInput
Description
Create a new Fund
Fields
| Input Field | Description |
|---|---|
name - String!
|
Common title given to the Fund |
legalName - String!
|
Name of the legal entity |
legalStructure - LegalStructure!
|
Legal structure of the legal entity |
assetStructure - AssetStructure!
|
Asset structure of the Fund |
inception - DateTime!
|
Date that the Fund was created |
countryId - ID!
|
Country where the Fund is operated |
currencyId - ID
|
Currency that the fund operates in |
registrationNumber - String
|
Registration number of the fund (e.g AFSL) |
cardImage - Upload!
|
Image file upload - to be used on fund cards. Size: 100MB, accepted files: jpg, png, gif, webp |
outgoingBankAccount - CreateFundInitialOutgoingBankAccountInput
|
This will create a default outgoing bank account. The provided setFundDefault will be ignored and set to true as single default account is required. |
depositBankAccount - FundBankAccount!
|
|
investorType - InvestorType
|
|
fundManagerName - String!
|
|
secondaryMarket - CreateSecondaryMarketConfigInput
|
|
unitRedemptionRequestConfig - UpdateFundUnitRedemptionRequestConfigInput
|
Create the unit redemption request configuration for the fund |
unitPrecisionScale - Int
|
Unit precision scale for the fund - maximum 9dp |
Example
{
"name": "xyz789",
"legalName": "xyz789",
"legalStructure": "LIMITED_PARTNERSHIP",
"assetStructure": "SINGLE_ASSET",
"inception": "2007-12-03T10:15:30Z",
"countryId": 4,
"currencyId": "4",
"registrationNumber": "abc123",
"cardImage": Upload,
"outgoingBankAccount": CreateFundInitialOutgoingBankAccountInput,
"depositBankAccount": FundBankAccount,
"investorType": "WHOLESALE",
"fundManagerName": "xyz789",
"secondaryMarket": CreateSecondaryMarketConfigInput,
"unitRedemptionRequestConfig": UpdateFundUnitRedemptionRequestConfigInput,
"unitPrecisionScale": 123
}
CreateFundOutgoingBankAccountInput
Fields
| Input Field | Description |
|---|---|
fundId - ID!
|
The ID of the fund to create the bank account against |
name - String!
|
Name of the bank account |
accountNumber - String!
|
Bank account number |
currencyCode - String!
|
ISO 4217 alpha 3 currency code for the bank account |
bankAccountLocationDetails - BankAccountLocationDetailsInput
|
Location specific details for the bank account, such as BSB for AUD, routing number for USD, etc. |
businessIdentifierCode - String
|
BIC/SWIFT Code |
setFundDefault - Boolean
|
Sets the bank account as the default for the fund. Setting all others to false |
Example
{
"fundId": "4",
"name": "abc123",
"accountNumber": "xyz789",
"currencyCode": "abc123",
"bankAccountLocationDetails": BankAccountLocationDetailsInput,
"businessIdentifierCode": "abc123",
"setFundDefault": true
}
CreateImpersonationSessionInput
Fields
| Input Field | Description |
|---|---|
id - ID!
|
ID of the Account to be impersonated |
Example
{"id": "4"}
CreateImportBatchInput
Description
Input for creating a new import batch.
Fields
| Input Field | Description |
|---|---|
type - ImportJobType!
|
The type of import job for this batch. |
name - String!
|
Name of the import batch. |
file - Upload!
|
The file containing the data to import. |
Example
{
"type": "UNIT_ISSUANCE",
"name": "abc123",
"file": Upload
}
CreateIndividual
Fields
| Input Field | Description |
|---|---|
firstName - String!
|
First name of the individual |
middleName - String
|
Middle name of the individual |
lastName - String!
|
Last name of the individual |
displayName - String
|
Display name of the individual - Ignored if CreateIndividual is for creating an investing entity of type JOINT_INDIVIDUAL |
email - String
|
Email address of the individual required if second individual on joint individual |
registeredAddress - AddressInput
|
Registered address of the entity |
postalAddress - AddressInput
|
Postal address of the entity |
placeOfBusinessAddress - AddressInput
|
Place of business details of the entity |
placeOfBirthCity - String
|
Place of birth details of the individual |
placeOfBirthCountry - String
|
|
placeOfBirthPlaceId - String
|
|
placeOfBirthRawSearch - String
|
|
primaryCitizenshipId - ID!
|
Primary citizenship of the individual |
nzPrescribedInvestorRate - NZPrescribedInvestorRateBasisPoints
|
NZ PIR |
nzPrescribedInvestorTaxDeclarationStatus - TaxDeclarationStatus
|
Declared status of the NZ PIR |
taxResidency - TaxResidencyInput
|
Tax residency for the individual |
interestResidentWithholdingTax - ResidentWithholdingTaxRateBasisPoints
|
RWT rate on interest |
interestResidentWithholdingTaxDeclarationStatus - TaxDeclarationStatus
|
Declared status of the RWT |
nonResidentWithholdingTaxRate - NonResidentWithholdingTaxRateBasisPoints
|
NRWT rate on interest |
nonResidentWithholdingTaxDeclarationStatus - TaxDeclarationStatus
|
Declared status of the NRWT |
natureAndPurpose - CreateNatureAndPurposeInput
|
nature and purpose details for the individual |
clientReferenceNumber - String
|
Client Reference Number for historical client references |
paymentReference - String
|
Payment Reference for integration purposes |
Example
{
"firstName": "abc123",
"middleName": "abc123",
"lastName": "abc123",
"displayName": "abc123",
"email": "abc123",
"registeredAddress": AddressInput,
"postalAddress": AddressInput,
"placeOfBusinessAddress": AddressInput,
"placeOfBirthCity": "xyz789",
"placeOfBirthCountry": "xyz789",
"placeOfBirthPlaceId": "abc123",
"placeOfBirthRawSearch": "xyz789",
"primaryCitizenshipId": 4,
"nzPrescribedInvestorRate": "UNSET",
"nzPrescribedInvestorTaxDeclarationStatus": "DECLARED",
"taxResidency": TaxResidencyInput,
"interestResidentWithholdingTax": "RATE_0",
"interestResidentWithholdingTaxDeclarationStatus": "DECLARED",
"nonResidentWithholdingTaxRate": "RATE_0",
"nonResidentWithholdingTaxDeclarationStatus": "DECLARED",
"natureAndPurpose": CreateNatureAndPurposeInput,
"clientReferenceNumber": "xyz789",
"paymentReference": "abc123"
}
CreateIndividualInvestingEntityInput
Fields
| Input Field | Description |
|---|---|
accountId - ID!
|
ID of the Account to create the Investing Entity for |
individual - CreateIndividual!
|
details of the individual |
Example
{
"accountId": "4",
"individual": CreateIndividual
}
CreateJointIndividualInvestingEntityInput
Fields
| Input Field | Description |
|---|---|
accountId - ID!
|
ID of the Account to create the Investing Entity for |
displayName - String
|
Display name of the joint individual |
individualOne - CreateIndividual!
|
individual one |
individualTwo - CreateIndividual!
|
individual two |
Example
{
"accountId": 4,
"displayName": "abc123",
"individualOne": CreateIndividual,
"individualTwo": CreateIndividual
}
CreateManualTaskInput
Fields
| Input Field | Description |
|---|---|
title - String!
|
|
assignedAdminId - ID
|
|
category - TaskCategoryInput!
|
|
associatedInvestorProfileType - ManualTaskAssociatedInvestorProfileInput
|
|
associatedInvestorProfileId - ID
|
|
associatedInvestingEntityId - ID
|
|
dueAt - DateTime
|
|
message - String
|
|
priority - TaskPriority
|
The priority of the task |
assignedTeam - TaskAssignedTeam
|
Example
{
"title": "xyz789",
"assignedAdminId": "4",
"category": "CALL",
"associatedInvestorProfileType": "ACCOUNT",
"associatedInvestorProfileId": "4",
"associatedInvestingEntityId": "4",
"dueAt": "2007-12-03T10:15:30Z",
"message": "abc123",
"priority": "NO_PRIORITY",
"assignedTeam": "UNASSIGNED"
}
CreateNatureAndPurposeInput
Fields
| Input Field | Description |
|---|---|
frequencyOfInvestment - InvestingEntityFrequencyOfInvestment!
|
The frequency of investment expected from the Investing Entity |
sourceOfFunds - SourceOfFundsSource!
|
source of funds |
availableFunds - InvestingEntityAvailableFunds!
|
Estimate of Funds Available for Investment |
reasonForInvesting - InvestingEntityReasonForInvesting!
|
The reason for investing |
Example
{
"frequencyOfInvestment": "ONE_OFF",
"sourceOfFunds": "BUSINESS_INCOME",
"availableFunds": "UNDER_50K",
"reasonForInvesting": "ONGOING_INCOME"
}
CreateOfferInput
Description
Create a new Offer
Fields
| Input Field | Description |
|---|---|
fundId - ID!
|
The Fund that owns this Asset |
displayName - String
|
|
settledAt - DateTime
|
|
fundsDeadline - DateTime
|
|
pricePerUnitAmountV2 - HighPrecisionMoneyInput
|
The price per unit for an offer in 6 decimal places in the fund's currency. Will error if the provided value has more than 6 decimal places. |
totalUnitCountDecimal - FixedPointNumberInput!
|
Total number of units in this offer |
minimumUnitCountDecimal - FixedPointNumberInput!
|
Minimum number of units in this offer an investor can be allocated |
maximumUnitCountDecimal - FixedPointNumberInput!
|
Maximum number of units in this offer an investor can be allocated |
digitalSubscription - OfferDigitalSubscription
|
Whether the offer is available for digital subscription |
unitClassId - ID
|
The ID of the unit class that is associated with this offer |
Example
{
"fundId": 4,
"displayName": "xyz789",
"settledAt": "2007-12-03T10:15:30Z",
"fundsDeadline": "2007-12-03T10:15:30Z",
"pricePerUnitAmountV2": HighPrecisionMoneyInput,
"totalUnitCountDecimal": FixedPointNumberInput,
"minimumUnitCountDecimal": FixedPointNumberInput,
"maximumUnitCountDecimal": FixedPointNumberInput,
"digitalSubscription": "ENABLED",
"unitClassId": 4
}
CreatePartnershipInvestingEntityInput
Fields
| Input Field | Description |
|---|---|
accountId - ID!
|
ID of the Account to create the Investing Entity for |
partnershipName - String!
|
legal name of the partnership |
displayName - String
|
display name of the partnership |
registeredAddress - AddressInput
|
Registered address of the entity |
postalAddress - AddressInput
|
Postal address of the entity |
placeOfBusinessAddress - AddressInput
|
Place of business details of the entity |
partnershipType - InvestingEntityPartnershipType!
|
partnership type |
registrationNumber - String
|
registration number of the partnership (if applicable) |
taxResidency - TaxResidencyInput
|
Tax residency for the partnership |
nzPrescribedInvestorRate - NZPrescribedInvestorRateBasisPoints
|
NZ PIR |
nzPrescribedInvestorTaxDeclarationStatus - TaxDeclarationStatus
|
Declared status of the NZ PIR |
interestResidentWithholdingTax - ResidentWithholdingTaxRateBasisPoints
|
RWT rate on interest |
interestResidentWithholdingTaxDeclarationStatus - TaxDeclarationStatus
|
Declared status of the RWT |
nonResidentWithholdingTaxRate - NonResidentWithholdingTaxRateBasisPoints
|
NRWT rate on interest |
nonResidentWithholdingTaxDeclarationStatus - TaxDeclarationStatus
|
Declared status of the NRWT |
natureAndPurpose - CreateNatureAndPurposeInput!
|
nature and purpose details for the partnership |
partnershipDocuments - [Upload!]!
|
partnership documents |
clientReferenceNumber - String
|
Client Reference Number for historical client references |
businessNumber - String
|
Business No. for reference |
paymentReference - String
|
Payment Reference for integration purposes |
Example
{
"accountId": 4,
"partnershipName": "abc123",
"displayName": "xyz789",
"registeredAddress": AddressInput,
"postalAddress": AddressInput,
"placeOfBusinessAddress": AddressInput,
"partnershipType": "LIMITED_PARTNERSHIP",
"registrationNumber": "abc123",
"taxResidency": TaxResidencyInput,
"nzPrescribedInvestorRate": "UNSET",
"nzPrescribedInvestorTaxDeclarationStatus": "DECLARED",
"interestResidentWithholdingTax": "RATE_0",
"interestResidentWithholdingTaxDeclarationStatus": "DECLARED",
"nonResidentWithholdingTaxRate": "RATE_0",
"nonResidentWithholdingTaxDeclarationStatus": "DECLARED",
"natureAndPurpose": CreateNatureAndPurposeInput,
"partnershipDocuments": [Upload],
"clientReferenceNumber": "xyz789",
"businessNumber": "abc123",
"paymentReference": "abc123"
}
CreateProspectInput
Fields
| Input Field | Description |
|---|---|
email - String!
|
|
legalName - LegalNameInput!
|
|
preferredName - String
|
|
dayOfBirth - Int
|
|
monthOfBirth - Int
|
|
yearOfBirth - Int
|
|
callingCode - String
|
|
phoneNumber - String
|
|
addressPlaceId - String
|
|
addressRawSearch - String
|
|
addressLine1 - String
|
|
addressSuburb - String
|
|
addressCity - String
|
|
addressPostCode - String
|
|
addressCountry - String
|
|
jobTitle - String
|
|
industry - String
|
|
organization - String
|
|
twitterProfileUrl - URL
|
|
linkedInProfileUrl - URL
|
|
biography - String
|
Example
{
"email": "abc123",
"legalName": LegalNameInput,
"preferredName": "xyz789",
"dayOfBirth": 987,
"monthOfBirth": 987,
"yearOfBirth": 123,
"callingCode": "xyz789",
"phoneNumber": "abc123",
"addressPlaceId": "abc123",
"addressRawSearch": "abc123",
"addressLine1": "abc123",
"addressSuburb": "xyz789",
"addressCity": "xyz789",
"addressPostCode": "abc123",
"addressCountry": "abc123",
"jobTitle": "xyz789",
"industry": "abc123",
"organization": "abc123",
"twitterProfileUrl": "http://www.test.com/",
"linkedInProfileUrl": "http://www.test.com/",
"biography": "xyz789"
}
CreateRegistrationOfInterestInput
Description
Deprecated: Registration of Interest will be merged into Allocation
Example
{
"accountID": 4,
"prospectID": 4,
"offerID": 4,
"unitCount": 987,
"unitPrice": MoneyUnit,
"note": "abc123"
}
CreateSecondaryMarketConfigInput
Fields
| Input Field | Description |
|---|---|
status - SecondaryMarketStatus!
|
|
fees - Float!
|
Example
{"status": "OPEN", "fees": 987.65}
CreateSellOrderInput
Fields
| Input Field | Description |
|---|---|
holdingId - ID!
|
|
unitCountDecimal - FixedPointNumberInput!
|
|
unitAskPrice - MoneyUnit!
|
|
flatFee - MoneyUnit
|
|
note - String
|
|
notifyByEmail - Boolean!
|
Whether to notify the investor of the sell order creation |
Example
{
"holdingId": "4",
"unitCountDecimal": FixedPointNumberInput,
"unitAskPrice": MoneyUnit,
"flatFee": MoneyUnit,
"note": "xyz789",
"notifyByEmail": false
}
CreateStatementBatchInput
Description
Input for creating batch of statements.
The investorStatementConfig field is a required input for creating a batch of statements for investors. As we add support for other types of statements and for other entities, we'll add additional configuration types. Please only provide the configuration for the type of statement you are creating.
Fields
| Input Field | Description |
|---|---|
investorStatementConfig - InvestorStatementConfigInput
|
The configuration for an investor's statement. |
taxStatementConfig - TaxStatementConfigInput
|
The configuration for a tax statement. |
holdingStatementConfig - HoldingStatementConfigInput
|
The configuration for a holding statement. |
periodicStatementConfig - PeriodicStatementConfigInput
|
The configuration for a periodic statement. |
Example
{
"investorStatementConfig": InvestorStatementConfigInput,
"taxStatementConfig": TaxStatementConfigInput,
"holdingStatementConfig": HoldingStatementConfigInput,
"periodicStatementConfig": PeriodicStatementConfigInput
}
CreateTagInput
Description
Create a new tag. The tag will be associated with the specified type.
Fields
| Input Field | Description |
|---|---|
displayName - String!
|
|
associatedType - TagAssociationType!
|
The type of entity(s) the tag can be applied to. can be INVESTOR_PROFILE or INVESTING_ENTITY |
Example
{
"displayName": "abc123",
"associatedType": "INVESTOR_PROFILE"
}
CreateTotalDollarUnitClassFeeInput
Fields
| Input Field | Description |
|---|---|
unitClassId - ID!
|
The ID of the unit class the fee will apply to |
config - TotalDollarFeeInput!
|
Fee configuration |
note - String
|
Optional note to include on this fee |
Example
{
"unitClassId": "4",
"config": TotalDollarFeeInput,
"note": "abc123"
}
CreateTrustInvestingEntityInput
Fields
| Input Field | Description |
|---|---|
accountId - ID!
|
ID of the Account to create the Investing Entity for |
trustName - String!
|
legal name of the trust |
displayName - String
|
display name of the trust |
registeredAddress - AddressInput
|
Registered address of the entity |
postalAddress - AddressInput
|
Postal address of the entity |
placeOfBusinessAddress - AddressInput
|
Place of business details of the entity |
trustType - InvestingEntityTrustType!
|
trust type |
registrationNumber - String
|
registration number of the trust (if applicable) |
taxResidency - TaxResidencyInput
|
Tax residency for the trust |
nzPrescribedInvestorRate - NZPrescribedInvestorRateBasisPoints
|
NZ PIR |
nzPrescribedInvestorTaxDeclarationStatus - TaxDeclarationStatus
|
Declared status of the NZ PIR |
interestResidentWithholdingTax - ResidentWithholdingTaxRateBasisPoints
|
RWT rate on interest |
interestResidentWithholdingTaxDeclarationStatus - TaxDeclarationStatus
|
Declared status of the RWT |
nonResidentWithholdingTaxRate - NonResidentWithholdingTaxRateBasisPoints
|
NRWT rate on interest |
nonResidentWithholdingTaxDeclarationStatus - TaxDeclarationStatus
|
Declared status of the NRWT |
natureAndPurpose - CreateNatureAndPurposeInput!
|
nature and purpose details for the trust |
trustDocuments - [Upload!]!
|
trust documents |
clientReferenceNumber - String
|
Client Reference Number for historical client references |
businessNumber - String
|
Business No. for reference |
paymentReference - String
|
Payment Reference for integration purposes |
Example
{
"accountId": "4",
"trustName": "xyz789",
"displayName": "abc123",
"registeredAddress": AddressInput,
"postalAddress": AddressInput,
"placeOfBusinessAddress": AddressInput,
"trustType": "ESTATE",
"registrationNumber": "xyz789",
"taxResidency": TaxResidencyInput,
"nzPrescribedInvestorRate": "UNSET",
"nzPrescribedInvestorTaxDeclarationStatus": "DECLARED",
"interestResidentWithholdingTax": "RATE_0",
"interestResidentWithholdingTaxDeclarationStatus": "DECLARED",
"nonResidentWithholdingTaxRate": "RATE_0",
"nonResidentWithholdingTaxDeclarationStatus": "DECLARED",
"natureAndPurpose": CreateNatureAndPurposeInput,
"trustDocuments": [Upload],
"clientReferenceNumber": "xyz789",
"businessNumber": "xyz789",
"paymentReference": "xyz789"
}
CreateUnitClassDistributionRateInput
Description
Input for creating a distribution rate for a unit class
Fields
| Input Field | Description |
|---|---|
unitClassId - ID!
|
ID of the unit class to create the distribution rate for |
effectiveFrom - DateTime!
|
The date from which the rate is effective - rate will be effective from this date until the next rate is set. Must be later than the active rate's effectiveFrom date. |
value - UnitClassDistributionRateValueInput!
|
The value of the distribution rate |
note - String
|
An optional note for the distribution rate |
Example
{
"unitClassId": "4",
"effectiveFrom": "2007-12-03T10:15:30Z",
"value": UnitClassDistributionRateValueInput,
"note": "xyz789"
}
CreateUnitClassInput
Fields
| Input Field | Description |
|---|---|
fundId - ID!
|
|
name - String!
|
|
unitPrice - HighPrecisionMoneyInput
|
The unit price |
unitPriceEffectiveDate - DateTime
|
The date the price is effective from |
outgoingBankAccountId - ID
|
Assigns the fund outgoing bank account for this unit class. Must be from the unit class's fund. Sending OptionalID with nil will clear the value and fall back to the fund's default account. Sending the default will explicitly assign the fund's default account. |
note - String
|
Example
{
"fundId": "4",
"name": "xyz789",
"unitPrice": HighPrecisionMoneyInput,
"unitPriceEffectiveDate": "2007-12-03T10:15:30Z",
"outgoingBankAccountId": 4,
"note": "abc123"
}
CreateUnitPriceInput
Fields
| Input Field | Description |
|---|---|
unitClassId - ID!
|
|
price - HighPrecisionMoneyInput!
|
The unit price |
effectiveDate - DateTime!
|
The date the unit price is effective from |
note - String
|
Optional note |
Example
{
"unitClassId": "4",
"price": HighPrecisionMoneyInput,
"effectiveDate": "2007-12-03T10:15:30Z",
"note": "xyz789"
}
CreateUnitRedemptionRequestInput
Description
Input for creating a unit redemption request
Fields
| Input Field | Description |
|---|---|
holdingId - ID!
|
the ID of the holding to redeem units from |
unitPrice - MoneyUnit!
|
the unit price for the redemption |
unitCountDecimal - FixedPointNumberInput!
|
the number of units to redeem |
sendEmail - Boolean!
|
whether or not to notify the key account by email |
note - String
|
an optional note to attach to the redemption |
dateOfRedemption - DateTime!
|
tentative date to redeem the units |
tags - [TransactionTag!]
|
list of tags to be associated with the unit redemption request |
Example
{
"holdingId": 4,
"unitPrice": MoneyUnit,
"unitCountDecimal": FixedPointNumberInput,
"sendEmail": false,
"note": "abc123",
"dateOfRedemption": "2007-12-03T10:15:30Z",
"tags": ["RELATED_PARTY_NCBO"]
}
CreateUnitTransferRequestInput
Fields
| Input Field | Description |
|---|---|
fromHoldingId - ID!
|
ID of the holding to transfer units from |
toInvestingEntityId - ID!
|
ID of the investing entity to transfer the units to |
unitCount - FixedPointNumberInput!
|
Number of units to transfer |
unitPrice - MoneyUnit!
|
Price per unit |
transferDate - DateTime!
|
Date of the transfer |
notifyByEmail - Boolean!
|
Whether to notify the investors of the transfer |
note - String
|
Optional note to attach to the unit transfer |
tags - [TransactionTag!]
|
List of tags to be associated with the unit transfer |
Example
{
"fromHoldingId": 4,
"toInvestingEntityId": "4",
"unitCount": FixedPointNumberInput,
"unitPrice": MoneyUnit,
"transferDate": "2007-12-03T10:15:30Z",
"notifyByEmail": true,
"note": "abc123",
"tags": ["RELATED_PARTY_NCBO"]
}
Currency
Description
Currency data source
Fields
| Field Name | Description |
|---|---|
id - ID!
|
ID of the currency |
name - String!
|
Name of the currency |
abbreviation - String!
|
Currency abbreviation |
symbol - String!
|
Currency symbol |
decimalSeparator - String!
|
Character used as the decimal separator |
thousandsSeparator - String!
|
Character used as the thousands separator |
Example
{
"id": 4,
"name": "New Zealand Dollar",
"abbreviation": "NZD",
"symbol": "$",
"decimalSeparator": ".",
"thousandsSeparator": ","
}
Cursor
Description
A opaque and not human readable string representation of a cursor
Example
Cursor
CustomField
Description
Union of all possible custom field types
Example
CustomFieldText
CustomFieldBase
CustomFieldCheckboxes
Description
A checkbox field allowing multiple selections from multiple options
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Unique identifier for the field |
order - Int!
|
Display order within the section (lower numbers appear first) |
label - String!
|
Label displayed to the user |
description - String
|
Optional description providing additional context or instructions |
options - [CustomFieldOption!]!
|
Available options for selection |
required - Boolean!
|
Whether at least one option must be selected before submission |
responses - [CustomFieldResponse!]
|
An investor's response to this custom field |
Example
{
"id": "4",
"order": 987,
"label": "abc123",
"description": "xyz789",
"options": [CustomFieldOption],
"required": true,
"responses": [CustomFieldResponse]
}
CustomFieldContent
Description
A read-only markdown/HTML field for displaying formatted content, instructions, or disclaimers
Example
{"id": 4, "order": 987, "content": "xyz789"}
CustomFieldInput
Description
Input for submitting a single response to a custom field
Example
{
"id": "4",
"responseId": "4",
"value": "abc123"
}
CustomFieldInputBase
Description
Base interface for custom fields that accept user input
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Unique identifier for the field |
order - Int!
|
Display order within the section (lower numbers appear first) |
label - String!
|
Label displayed to the user |
description - String
|
Optional description providing additional context or instructions |
required - Boolean!
|
Whether the field must be completed before submission |
Possible Types
| CustomFieldInputBase Types |
|---|
Example
{
"id": 4,
"order": 123,
"label": "abc123",
"description": "xyz789",
"required": false
}
CustomFieldMultiSelect
Description
A dropdown select field allowing one or more selection from multiple options
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Unique identifier for the field |
order - Int!
|
Display order within the section (lower numbers appear first) |
label - String!
|
Label displayed to the user |
description - String
|
Optional description providing additional context or instructions |
options - [CustomFieldOption!]!
|
Available options for selection |
required - Boolean!
|
Whether the field must be completed before submission |
responses - [CustomFieldResponse!]
|
An investor's responses to this custom field |
Example
{
"id": 4,
"order": 123,
"label": "abc123",
"description": "xyz789",
"options": [CustomFieldOption],
"required": false,
"responses": [CustomFieldResponse]
}
CustomFieldOption
CustomFieldRadios
Description
A radio button field allowing one selection from multiple options
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Unique identifier for the field |
order - Int!
|
Display order within the section (lower numbers appear first) |
label - String!
|
Label displayed to the user |
description - String
|
Optional description providing additional context or instructions |
options - [CustomFieldOption!]!
|
Available options for selection |
required - Boolean!
|
Whether the field must be completed before submission |
response - CustomFieldResponse
|
An investor's response to this custom field |
Example
{
"id": 4,
"order": 123,
"label": "abc123",
"description": "xyz789",
"options": [CustomFieldOption],
"required": true,
"response": CustomFieldResponse
}
CustomFieldResponse
Description
An investor's response to a single custom field
Example
{
"id": 4,
"label": "abc123",
"value": "abc123"
}
CustomFieldSection
Description
A section grouping related custom fields together
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Unique identifier for the section |
order - Int!
|
Display order among sections (lower numbers appear first) |
name - String!
|
Internal name/identifier for the section |
displayName - String!
|
User-facing display name for the section |
description - String
|
Optional description of the section's purpose |
fields - [CustomField!]!
|
Custom fields within this section |
Example
{
"id": "4",
"order": 123,
"name": "abc123",
"displayName": "abc123",
"description": "abc123",
"fields": [CustomFieldText]
}
CustomFieldSectionInput
Fields
| Input Field | Description |
|---|---|
id - ID!
|
ID of the custom field section |
fields - [CustomFieldInput!]!
|
Responses to the fields within this section. Important, for multiple choice fields, you should submit a separate response for each selected option. This means that for checkbox or multi-select dropdown fields, multiple |
Example
{
"id": "4",
"fields": [CustomFieldInput]
}
CustomFieldSelect
Description
A dropdown select field allowing one or more selection from multiple options
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Unique identifier for the field |
order - Int!
|
Display order within the section (lower numbers appear first) |
label - String!
|
Label displayed to the user |
description - String
|
Optional description providing additional context or instructions |
options - [CustomFieldOption!]!
|
Available options for selection |
required - Boolean!
|
Whether the field must be completed before submission |
response - CustomFieldResponse
|
An investor's response to this custom field |
Example
{
"id": 4,
"order": 123,
"label": "xyz789",
"description": "xyz789",
"options": [CustomFieldOption],
"required": true,
"response": CustomFieldResponse
}
CustomFieldText
Description
A text input field for free-form text entry
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Unique identifier for the field |
order - Int!
|
Display order within the section (lower numbers appear first) |
label - String!
|
Label displayed to the user |
placeholder - String
|
Placeholder text shown in the input field |
description - String
|
Optional description providing additional context or instructions |
required - Boolean!
|
Whether the field must be completed before submission |
response - CustomFieldResponse
|
An investor's response to this custom field |
Example
{
"id": 4,
"order": 987,
"label": "xyz789",
"placeholder": "abc123",
"description": "abc123",
"required": false,
"response": CustomFieldResponse
}
CustomMetric
CustomMetricInput
DateRange
Description
Represents a period of time between two dates with time. The start date is inclusive, the end date is exclusive. All dates are in UTC timezone.
Examples:
-
The following date range represents the whole day of 1st April 2025 (UTC timezone) { start: "2025-04-01T00:00:00Z", end: "2025-04-02T00:00:00Z" }
-
The following date range represents the whole day of 1st April 2025 (NZDT timezone) { start: "2025-03-31T11:00:00Z", end: "2025-04-01T11:00:00Z" }
-
The following date range represents the whole day of a period going from NZDT to NZST. Notice that the period is 25 hours long. { start: "2025-04-05T11:00:00Z", end: "2025-04-06T12:00:00Z" }
Example
{
"start": "2007-12-03T10:15:30Z",
"end": "2007-12-03T10:15:30Z"
}
DateRangeInput
DateTime
Description
RFC3339 encoded datetime string i.e 2006-01-02T15:04:05Z07:00
Example
"2007-12-03T10:15:30Z"
DayMonthYear
DayMonthYearInput
DeclineAccreditationCertificateInput
Description
Input for declining an accreditation certificate
Example
{
"accreditationId": 4,
"reason": "xyz789",
"notifyByEmail": true
}
DeclineBankAccountInput
Description
Input for declining a bank account
Example
{
"bankAccountId": 4,
"reason": "abc123",
"notifyByEmail": false
}
DeclineInvestingEntityGoverningDocumentInput
Description
Input for declining an investing entity governing document
Fields
| Input Field | Description |
|---|---|
investingEntityId - ID!
|
The ID of the investing entity that owns this document |
documentId - ID!
|
The ID of the governing document to decline |
reason - String
|
Optional reason for declining the document |
notifyByEmail - Boolean!
|
Whether to notify the account owner by email when the document is declined |
Example
{
"investingEntityId": 4,
"documentId": "4",
"reason": "abc123",
"notifyByEmail": true
}
DeclinePEPMatchInput
DeleteAssetInput
Description
Delete an existing Asset
Fields
| Input Field | Description |
|---|---|
id - ID!
|
Unique identifier of the Asset that will be deleted |
Example
{"id": "4"}
DeleteBeneficialOwnerInput
Fields
| Input Field | Description |
|---|---|
id - ID!
|
ID of the beneficial owner to delete |
Example
{"id": "4"}
DeleteConnectionInput
Fields
| Input Field | Description |
|---|---|
id - ID!
|
ID of the connection to delete |
from - ConnectionInput!
|
The entity that the connection is getting deleted from |
Example
{"id": 4, "from": ConnectionInput}
DeleteDepositMethodInput
Fields
| Input Field | Description |
|---|---|
id - ID!
|
Example
{"id": 4}
DeleteDistributionInput
Fields
| Input Field | Description |
|---|---|
distributionId - ID!
|
Example
{"distributionId": 4}
DeleteDocumentInput
Fields
| Input Field | Description |
|---|---|
id - ID!
|
Example
{"id": 4}
DeleteEmailBatchInput
Description
Input for deleting an email batch and all associated messages.
Fields
| Input Field | Description |
|---|---|
batchId - ID!
|
ID of the email batch to delete |
Example
{"batchId": "4"}
DeleteEmailTemplateInput
Description
Input for deleting an email template
Fields
| Input Field | Description |
|---|---|
emailTemplateId - ID!
|
ID of the email template to delete |
Example
{"emailTemplateId": 4}
DeleteFundInput
Fields
| Input Field | Description |
|---|---|
id - ID!
|
Unique identifier of the Fund that will be deleted |
Example
{"id": 4}
DeleteFundOutgoingBankAccountInput
Fields
| Input Field | Description |
|---|---|
id - ID!
|
ID of the bank account to delete |
Example
{"id": "4"}
DeleteImportBatchInput
Description
Input for deleting an import batch.
Fields
| Input Field | Description |
|---|---|
id - ID!
|
The ID of the import batch to delete. |
Example
{"id": 4}
DeleteManualTaskInput
Fields
| Input Field | Description |
|---|---|
id - ID!
|
Example
{"id": "4"}
DeleteNoteInput
Fields
| Input Field | Description |
|---|---|
id - ID!
|
Example
{"id": 4}
DeleteOfferDataRoomContentBlockInput
DeleteOfferDocumentInput
Fields
| Input Field | Description |
|---|---|
documentId - ID!
|
Example
{"documentId": "4"}
DeleteOfferInput
Description
Delete an existing Offer
Fields
| Input Field | Description |
|---|---|
id - ID!
|
The ID of the Offer to be deleted |
Example
{"id": "4"}
DeleteProspectInput
Fields
| Input Field | Description |
|---|---|
id - ID!
|
Unique identifier of the Prospect that will be deleted |
Example
{"id": "4"}
DeleteStatementBatchInput
Description
Input for deleting a batch of statements.
Fields
| Input Field | Description |
|---|---|
id - ID!
|
The ID of the batch of statements to delete. |
Example
{"id": 4}
DeleteTagInput
Description
Delete a tag.
Fields
| Input Field | Description |
|---|---|
id - ID!
|
|
associatedType - TagAssociationType!
|
The type of entity(s) the tag can be applied to. can be INVESTOR_PROFILE or INVESTING_ENTITY |
Example
{
"id": "4",
"associatedType": "INVESTOR_PROFILE"
}
DeleteUnitClassDistributionRateInput
Description
Input for deleting a distribution rate for a unit class
Fields
| Input Field | Description |
|---|---|
distributionRateId - ID!
|
Example
{"distributionRateId": 4}
DeleteUnitClassFeeInput
Fields
| Input Field | Description |
|---|---|
id - ID!
|
The ID of the unit class fee to delete |
Example
{"id": 4}
DeleteUnitPriceInput
Fields
| Input Field | Description |
|---|---|
id - ID!
|
Example
{"id": 4}
DeleteUnreconciledDepositInput
Description
Delete an unreconciled deposit from the list
Fields
| Input Field | Description |
|---|---|
id - ID!
|
The ID of the deposit to remove |
Example
{"id": 4}
DepositMethod
Fields
| Field Name | Description |
|---|---|
id - ID!
|
ID of the deposit method |
name - String!
|
Name of the deposit method, e.g. 'My favorite bank account' |
paymentMethod - PaymentMethod!
|
Either a bank account, cheque or BPAY |
isLinked - Boolean!
|
Whether the deposit method is linked to another entity (e.g. an offer) |
Example
{
"id": "4",
"name": "abc123",
"paymentMethod": BankAccountV2,
"isLinked": true
}
DepositMethodOrderedLink
DepositReconciliationMatch
Types
| Union Types |
|---|
Example
Allocation
DepositSearchTransaction
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
amount - Money!
|
|
processedAt - DateTime
|
|
fund - Fund
|
|
investingEntity - InvestingEntity
|
|
code - String
|
|
reference - String
|
|
particulars - String
|
|
note - Note
|
|
from - VerifiableBankAccount!
|
|
to - VerifiableBankAccount!
|
|
status - SearchTransactionStatus!
|
|
unitClass - UnitClass
|
Unit class associated with the Transaction |
Example
{
"id": "4",
"amount": Money,
"processedAt": "2007-12-03T10:15:30Z",
"fund": Fund,
"investingEntity": InvestingEntity,
"code": "xyz789",
"reference": "xyz789",
"particulars": "abc123",
"note": Note,
"from": VerifiableBankAccount,
"to": VerifiableBankAccount,
"status": "WITHHELD",
"unitClass": UnitClass
}
DisableAdminUserInput
Fields
| Input Field | Description |
|---|---|
id - ID!
|
Example
{"id": "4"}
Distribution
Description
Deprecated - use DistributionV2
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Unique ID of the distribution |
periodFrom - DateTime!
|
|
periodTo - DateTime!
|
|
paymentDate - DateTime!
|
|
lastCalculated - DateTime!
|
|
netAmountDistributed - Money!
|
|
netAmountDistributedToWallet - Money!
|
|
netAmountReinvested - Money!
|
|
netAmountWithdrawn - Money!
|
|
originalAmount - Money!
|
Original net amount, distributed after any taxes etc. |
hasAmountChanged - Boolean!
|
|
holdingDistributions - [HoldingDistribution!]!
|
|
exchangeRate - Money
|
|
exchangedAt - DateTime
|
|
taxWithheld - Float
|
|
taxWithheldV2 - Money
|
|
status - DistributionStatus!
|
|
taxableIncome - Money
|
|
nonTaxableIncome - Money
|
|
grossDistribution - Money
|
Original gross amount, captured via user input |
adjustedGrossDistribution - Money
|
Gross amount distributed, this is rounded from the original gross amount to avoid over payments |
statementCommentary - String
|
|
withheldCount - Int!
|
|
disabledCount - Int!
|
|
confirmedBy - AdminUser
|
Example
{
"id": 4,
"periodFrom": "2007-12-03T10:15:30Z",
"periodTo": "2007-12-03T10:15:30Z",
"paymentDate": "2007-12-03T10:15:30Z",
"lastCalculated": "2007-12-03T10:15:30Z",
"netAmountDistributed": Money,
"netAmountDistributedToWallet": Money,
"netAmountReinvested": Money,
"netAmountWithdrawn": Money,
"originalAmount": Money,
"hasAmountChanged": false,
"holdingDistributions": [HoldingDistribution],
"exchangeRate": Money,
"exchangedAt": "2007-12-03T10:15:30Z",
"taxWithheld": 123.45,
"taxWithheldV2": Money,
"status": "DRAFT",
"taxableIncome": Money,
"nonTaxableIncome": Money,
"grossDistribution": Money,
"adjustedGrossDistribution": Money,
"statementCommentary": "abc123",
"withheldCount": 987,
"disabledCount": 987,
"confirmedBy": AdminUser
}
DistributionAlert
Description
An alert that should be addressed before confirming a distribution
Types
| Union Types |
|---|
Example
InvalidBankAccountDistributionAlert
DistributionCalculationMethod
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"TOTAL_DOLLAR_AMOUNT"
DistributionComponent
Description
A component that makes up a distribution
Example
PercentageDistributionComponent
DistributionComponentType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"DIVIDENDS"
DistributionEdge
Fields
| Field Name | Description |
|---|---|
cursor - String!
|
|
node - DistributionV2!
|
Example
{
"cursor": "abc123",
"node": DistributionV2
}
DistributionRatesDistributionComponentInput
Fields
| Input Field | Description |
|---|---|
taxWithholdingMethod - TaxWithholdingMethod!
|
Example
{"taxWithholdingMethod": "NONE"}
DistributionReinvestmentSetting
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"ENABLED"
DistributionSearchResults
Fields
| Field Name | Description |
|---|---|
edges - [DistributionEdge!]!
|
|
pageInfo - PageInfo!
|
Example
{
"edges": [DistributionEdge],
"pageInfo": PageInfo
}
DistributionSearchTransaction
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
amount - Money!
|
|
processedAt - DateTime
|
|
fund - Fund
|
|
investingEntity - InvestingEntity
|
|
status - SearchTransactionStatus!
|
|
unitClass - UnitClass
|
Unit class associated with the Transaction |
Example
{
"id": 4,
"amount": Money,
"processedAt": "2007-12-03T10:15:30Z",
"fund": Fund,
"investingEntity": InvestingEntity,
"status": "WITHHELD",
"unitClass": UnitClass
}
DistributionSource
Values
| Enum Value | Description |
|---|---|
|
|
A distribution generated via the system |
|
|
A distribution that has been imported via implementations |
|
|
Legacy distribution that has been migrated over to the current version |
Example
"SYSTEM"
DistributionStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"DRAFT"
DistributionSummary
Fields
| Field Name | Description |
|---|---|
holding - Holding!
|
|
grossDistribution - Money!
|
Amount distributed to the holding |
netDistribution - Money!
|
Net amount distributed to the holding |
taxWithheld - Money!
|
Amount of tax withheld for the holding |
unitCount - FixedPointNumber!
|
Total number of units for the holding |
distributionSettings - HoldingDistributionSettings!
|
Distribution settings for the holding (enabled, withheld, disabled) at the time of distribution |
drpSettings - DistributionReinvestmentSetting!
|
DRP settings for the holding (enabled, disabled) at the time of distribution |
pdfStatementUrl - String!
|
The URL at which the statement can be downloaded |
status - DistributionSummaryStatus!
|
The status of the distribution summary for the holding |
reinvestmentUnitClass - UnitClass
|
The unit class that the holding's distribution is reinvested into For draft distributions, this is the same as the holding's unit class For confirmed distributions, this is the unit class that the distribution was reinvested into |
Example
{
"holding": Holding,
"grossDistribution": Money,
"netDistribution": Money,
"taxWithheld": Money,
"unitCount": FixedPointNumber,
"distributionSettings": "ENABLED",
"drpSettings": "ENABLED",
"pdfStatementUrl": "xyz789",
"status": "DRAFT",
"reinvestmentUnitClass": UnitClass
}
DistributionSummaryStatus
Description
The status of the distribution summary for the holding
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"DRAFT"
DistributionV2
Description
Represents a distribution to investors in a Fund
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
status - DistributionStatus!
|
The status of the distribution |
source - DistributionSource
|
The source of the distribution |
name - String!
|
Name of the distribution |
fund - Fund!
|
Fund that the distribution is for |
lastCalculated - DateTime
|
Date the distribution was last calculated |
periodFrom - DateTime!
|
Period from which the distribution is calculated |
periodTo - DateTime!
|
Period to which the distribution is calculated |
paymentDate - DateTime!
|
Date the distribution is paid |
grossDistribution - Money
|
Gross amount distributed |
netDistribution - Money
|
Net amount distributed |
taxWithheld - Money
|
The amount of tax withheld for the distribution |
totalReinvestment - Money
|
Total amount reinvested |
withheldCount - Int
|
Number of distributions that are withheld |
disabledCount - Int
|
Number of distributions that are disabled |
reinvestmentCount - Int
|
Number of distributions that enabled reinvestment |
statementCommentary - String
|
An optional commentary for the distribution |
components - [DistributionComponent!]!
|
Components that make up the distribution |
summaryForHoldings - [DistributionSummary!]
|
Summary of the distribution for each holding |
confirmedBy - AdminUser
|
The admin user that confirmed the distribution |
confirmedAt - DateTime
|
Date that the distribution was confirmed - null if the distribution hasn't been confirmed yet |
publishedAt - DateTime
|
The time when the distribution was or will be published. Null if the distribution is not confirmed yet |
dateOfIssuance - DateTime
|
The date when the distribution's re-investments were or will be processed. Null if the distribution is not confirmed yet |
notificationsEnabled - Boolean
|
Whether the admin chose to notify investors of the distribution when it was confirmed |
statementsEnabled - Boolean
|
Whether the admin chose to publish the statement for the distribution when it was confirmed |
reinvestmentRoundingResidual - Money
|
Any leftover amount from reinvestment rounding calculations that cannot be reinvested due to unit precision (aggregate for entire distribution) |
Example
{
"id": 4,
"status": "DRAFT",
"source": "SYSTEM",
"name": "abc123",
"fund": Fund,
"lastCalculated": "2007-12-03T10:15:30Z",
"periodFrom": "2007-12-03T10:15:30Z",
"periodTo": "2007-12-03T10:15:30Z",
"paymentDate": "2007-12-03T10:15:30Z",
"grossDistribution": Money,
"netDistribution": Money,
"taxWithheld": Money,
"totalReinvestment": Money,
"withheldCount": 987,
"disabledCount": 123,
"reinvestmentCount": 987,
"statementCommentary": "abc123",
"components": [PercentageDistributionComponent],
"summaryForHoldings": [DistributionSummary],
"confirmedBy": AdminUser,
"confirmedAt": "2007-12-03T10:15:30Z",
"publishedAt": "2007-12-03T10:15:30Z",
"dateOfIssuance": "2007-12-03T10:15:30Z",
"notificationsEnabled": true,
"statementsEnabled": false,
"reinvestmentRoundingResidual": Money
}
Document
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
updatedAt - DateTime!
|
|
file - RemoteAsset!
|
|
modifiedBy - AdminUser
|
A document may be modified by someone who is not an AdminUser, so this is nullable |
Possible Types
| Document Types |
|---|
Example
{
"id": 4,
"updatedAt": "2007-12-03T10:15:30Z",
"file": RemoteAsset,
"modifiedBy": AdminUser
}
DocumentActivityFeedItem
Possible Types
| DocumentActivityFeedItem Types |
|---|
Example
{
"id": 4,
"updatedAt": "2007-12-03T10:15:30Z",
"document": Document
}
DocumentCategoryV2
Description
All possible categories for a document on the platform
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"AUTHORITY"
EURVerifiableBankAccount
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
created - DateTime!
|
|
updated - DateTime!
|
|
name - String!
|
|
nickname - String!
|
|
currency - Currency!
|
|
isDefaultAccount - Boolean!
|
|
status - BankAccountStatus!
|
|
documents - [VerifiableDocument!]!
|
|
accountNumber - String!
|
|
investingEntity - InvestingEntity!
|
The investing entity that owns this bank account |
Example
{
"id": 4,
"created": "2007-12-03T10:15:30Z",
"updated": "2007-12-03T10:15:30Z",
"name": "abc123",
"nickname": "xyz789",
"currency": Currency,
"isDefaultAccount": false,
"status": "PENDING",
"documents": [VerifiableDocument],
"accountNumber": "abc123",
"investingEntity": InvestingEntity
}
EditAllocationCustomFieldSectionResponseInput
Fields
| Input Field | Description |
|---|---|
allocationId - ID!
|
ID of the allocation to set custom field responses for |
section - CustomFieldSectionInput!
|
Responses to custom fields associated with this allocation |
Example
{"allocationId": 4, "section": CustomFieldSectionInput}
EditAllocationInput
Fields
| Input Field | Description |
|---|---|
id - ID!
|
|
unitCountDecimal - FixedPointNumberInput
|
Number of units in the allocation request |
associatedContact - AllocationAssociatedContactInput
|
The associated contact to update the allocation for. Previous associated contact will be cleared if a new one is provided. |
unitPrice - HighPrecisionMoneyInput
|
The price per unit in the offers currency |
status - AllocationStatus
|
Status can only be updated when the allocation is in a pipeline stage. See AllocationStatus for allowed values. To update the status to APPROVED or CANCELLED, use the cancelAllocation or confirmAllocation mutations instead. |
note - String
|
The note to update the allocation with |
Example
{
"id": "4",
"unitCountDecimal": FixedPointNumberInput,
"associatedContact": AllocationAssociatedContactInput,
"unitPrice": HighPrecisionMoneyInput,
"status": "INTERESTED",
"note": "xyz789"
}
EditAllocationNoteInput
EditConnectionInput
Fields
| Input Field | Description |
|---|---|
id - ID!
|
ID of the connection to edit |
note - String!
|
|
from - ConnectionInput!
|
The entity that the connection is connected from |
Example
{
"id": "4",
"note": "xyz789",
"from": ConnectionInput
}
EmailBatch
Description
A batch of emails that can be sent to multiple recipients
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Unique identifier for the email batch |
createdAt - DateTime!
|
Timestamp when the batch was created |
updatedAt - DateTime!
|
Timestamp when the batch was last updated |
scheduledAt - DateTime
|
Timestamp when the batch is scheduled to be sent |
confirmedAt - DateTime
|
Timestamp when the batch was confirmed for sending |
name - String!
|
Human-readable name for the email batch |
sender - EmailSender!
|
The email sender that will be used for this batch |
recipientConfiguration - EmailBatchRecipientConfiguration
|
The recipient configuration for this batch |
template - EmailTemplate!
|
The template used for this batch |
subjectTemplate - String!
|
Template for the email subject line |
bodyTemplate - String!
|
Template for the email body content |
variablesTemplate - JSON!
|
JSON template for variables used in the email. This is the same structure as is sent to the template engine when rendering the email content. It will be returned with fake or placeholder data when previewing the template. |
status - EmailBatchStatus!
|
Current status of the email batch |
confirmedBy - AdminUser
|
The admin user who confirmed this batch |
numberOfMessages - Int!
|
Total number of messages in this batch |
messageCounts - [EmailBatchMessageCount!]!
|
Number of messages grouped by their current status. Adding up the counts should equal the total number of messages in the batch. |
messages - EmailMessageConnection
|
Paginated list of email messages in this batch. If a filter is provided, the same filter should always be used when paginating through the results. |
Arguments |
|
Example
{
"id": 4,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"scheduledAt": "2007-12-03T10:15:30Z",
"confirmedAt": "2007-12-03T10:15:30Z",
"name": "xyz789",
"sender": EmailSender,
"recipientConfiguration": AccountEmailBatchRecipientConfiguration,
"template": EmailTemplate,
"subjectTemplate": "abc123",
"bodyTemplate": "abc123",
"variablesTemplate": {},
"status": "STATUS_INVALID",
"confirmedBy": AdminUser,
"numberOfMessages": 987,
"messageCounts": [EmailBatchMessageCount],
"messages": EmailMessageConnection
}
EmailBatchConnection
Description
A paginated list of email batches
Fields
| Field Name | Description |
|---|---|
edges - [EmailBatchEdge!]!
|
List of edges in the connection |
pageInfo - PageInfo!
|
Pageinfo for the current page of results |
Example
{
"edges": [EmailBatchEdge],
"pageInfo": PageInfo
}
EmailBatchEdge
Description
An edge in the email batch connection
Fields
| Field Name | Description |
|---|---|
cursor - Cursor!
|
Cursor for the edge |
node - EmailBatch!
|
The email batch at the end of the edge |
Example
{
"cursor": Cursor,
"node": EmailBatch
}
EmailBatchMessageCount
Description
Count of email messages in a batch grouped by status
Fields
| Field Name | Description |
|---|---|
status - EmailMessageStatus!
|
Status of the email messages |
count - Int!
|
Number of email messages with this status |
Example
{"status": "STATUS_INVALID", "count": 987}
EmailBatchRecipientConfiguration
Description
The different recipient configurations for email batches.
Example
AccountEmailBatchRecipientConfiguration
EmailBatchStatus
Description
The current status of an email batch
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"STATUS_INVALID"
EmailCommunicationActivityFeedItem
Example
{
"id": 4,
"updatedAt": "2007-12-03T10:15:30Z",
"html": HTML,
"from": "xyz789",
"to": "abc123",
"emailSubject": "xyz789",
"sentWithActiveCampaign": true
}
EmailContext
Description
An entity that provides context for an email
Types
| Union Types |
|---|
Example
Account
EmailLogActivityFeedItem
EmailLogAssociatedRecordInput
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"ACCOUNT"
EmailMessage
Description
An individual email message that is part of an email batch
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Unique identifier for the email message |
createdAt - DateTime!
|
Timestamp when the message was created |
updatedAt - DateTime!
|
Timestamp when the message was last updated |
status - EmailMessageStatus!
|
Current status of the email message |
recipient - EmailRecipient!
|
The recipient who will receive this email message. An email is always anchored to a specific recipient, which is typically an account. |
context - EmailContext!
|
The context of the message. This will hold the entity that the email is related to, such as an account or investing entity. |
subject - String
|
The rendered subject line of the email |
htmlContent - HTML
|
The rendered HTML content of the email body |
textContent - String
|
The rendered plain text content of the email body |
failures - [EmailMessageFailure!]
|
List of failures that occurred when attempting to send this message |
Example
{
"id": "4",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"status": "STATUS_INVALID",
"recipient": EmailRecipient,
"context": Account,
"subject": "xyz789",
"htmlContent": HTML,
"textContent": "xyz789",
"failures": [EmailMessageFailure]
}
EmailMessageConnection
Description
A paginated list of email messages
Fields
| Field Name | Description |
|---|---|
edges - [EmailMessageEdge!]!
|
List of edges on the connection |
pageInfo - PageInfo!
|
Pageinfo for the current page of results |
Example
{
"edges": [EmailMessageEdge],
"pageInfo": PageInfo
}
EmailMessageEdge
Description
An edge in the email message connection
Fields
| Field Name | Description |
|---|---|
cursor - Cursor!
|
Cursor for the edge |
node - EmailMessage!
|
The email message at the end of the edge |
Example
{
"cursor": Cursor,
"node": EmailMessage
}
EmailMessageFailure
EmailMessageFilter
Description
Input for filtering email messages in a batch
Fields
| Input Field | Description |
|---|---|
status - [EmailMessageStatus!]
|
Filter by message statuses |
Example
{"status": ["STATUS_INVALID"]}
EmailMessageStatus
Description
The current status of an email message
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Message has been drafted with recipient details, but content has not been rendered yet |
|
|
Message has been queued for content rendering |
|
|
Message content has been rendered |
|
|
Message has been sent to the recipient |
|
|
Message has failed to be rendered or sent |
Example
"STATUS_INVALID"
EmailQueries
Description
Queries related to email senders, batches, and messages
Fields
| Field Name | Description |
|---|---|
senders - [EmailSender!]!
|
List of all email senders configured in the system |
batches - EmailBatchConnection!
|
Paginated list of email batches in the system |
batch - EmailBatch
|
Fetch a specific email batch by its ID |
Arguments
|
|
templates - [EmailTemplate!]!
|
List of all available email templates |
template - EmailTemplate
|
Fetch a specific email template by its ID |
Arguments
|
|
Example
{
"senders": [EmailSender],
"batches": EmailBatchConnection,
"batch": EmailBatch,
"templates": [EmailTemplate],
"template": EmailTemplate
}
EmailRecipient
Description
An individual who will receive an email. It is linked to an account in the system. The name and email fields represent the recipient's details at the time the email was created, and will not change if the account's details are updated.
Fields
| Field Name | Description |
|---|---|
id - ID!
|
ID of the email recipient |
name - String!
|
Full name of the email recipient at the time the email was created |
email - String!
|
Email address of the recipient at the time the email was created |
account - EmailRecipientAccount!
|
The recipient's account in the system |
Example
{
"id": 4,
"name": "xyz789",
"email": "abc123",
"account": Account
}
EmailRecipientAccount
Description
The recipient of an email
Types
| Union Types |
|---|
Example
Account
EmailSender
EmailTask
Description
Task to email an investor or potential investor
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
created - DateTime!
|
|
updated - DateTime!
|
|
status - TaskStatus!
|
|
dueAt - DateTime
|
|
assignedAdmin - AdminUser
|
|
notes - [Note!]!
|
|
title - String!
|
|
associatedRecord - TaskAssociatedRecord
|
|
documents - [TaskDocument!]
|
|
priority - TaskPriority
|
|
relatedTasks - [Task!]
|
|
assignedTeam - TaskAssignedTeam
|
Team that the task is assigned to |
Example
{
"id": "4",
"created": "2007-12-03T10:15:30Z",
"updated": "2007-12-03T10:15:30Z",
"status": "OPEN",
"dueAt": "2007-12-03T10:15:30Z",
"assignedAdmin": AdminUser,
"notes": [Note],
"title": "abc123",
"associatedRecord": Account,
"documents": [TaskDocument],
"priority": "NO_PRIORITY",
"relatedTasks": [Task],
"assignedTeam": "UNASSIGNED"
}
EmailTemplate
Description
A template for building an email.
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The unique identifier of the email template. |
createdAt - DateTime!
|
The date the email template was created. |
name - String!
|
The name of the email template. |
template - String!
|
The template for building an email. |
fund - Fund
|
The fund associated with the email template. |
contextLinkTypes - [ContextLinkType!]
|
The list of context link types used by the email template |
Example
{
"id": 4,
"createdAt": "2007-12-03T10:15:30Z",
"name": "xyz789",
"template": "xyz789",
"fund": Fund,
"contextLinkTypes": ["FUND"]
}
EnrichStatementBatchInput
Entity
Example
IndividualInvestingEntity
EntityBeneficialOwner
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
created - DateTime!
|
|
relationship - BeneficialOwnerRelationship!
|
|
nodes - [BeneficialOwner]!
|
|
notes - [Note]!
|
|
activity - [ActivityMessage]!
|
|
uploadedDocuments - [UploadedDocument!]!
|
|
parent - BeneficialOwnerParent
|
|
entityType - BeneficialOwnerEntityType!
|
|
subType - EntitySubType!
|
|
name - String!
|
|
associatedInvestingEntity - InvestingEntity
|
|
taxResidency - InvestingEntityTaxResidency
|
Tax residency of entity beneficial owner |
registrationNumber - String
|
Registration number of entity beneficial owner (only populated for company) |
businessNumber - String
|
Business number of entity beneficial owner (only populated for company/trust/partnership) |
Example
{
"id": "4",
"created": "2007-12-03T10:15:30Z",
"relationship": "DIRECTOR",
"nodes": [BeneficialOwner],
"notes": [Note],
"activity": [ActivityMessage],
"uploadedDocuments": [UploadedDocument],
"parent": EntityBeneficialOwner,
"entityType": "COMPANY",
"subType": "LIMITED_COMPANY",
"name": "xyz789",
"associatedInvestingEntity": InvestingEntity,
"taxResidency": InvestingEntityTaxResidency,
"registrationNumber": "abc123",
"businessNumber": "abc123"
}
EntitySubType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"LIMITED_COMPANY"
FeatureFlag
FeeConfig
Types
| Union Types |
|---|
Example
AnnualPercentageFee
FixedPointNumber
FixedPointNumberInput
Float
Description
The Float scalar type represents signed double-precision fractional values as specified by IEEE 754.
Example
123.45
Fraction
Fund
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Unique identifier of the Fund |
createdAt - DateTime
|
Date the fund was created |
updatedAt - DateTime
|
Date the fund was updated |
name - String!
|
Common title given to the Fund |
legalName - String!
|
Name of the legal entity |
shortDescription - String!
|
A short description of the fund to be shown on the opportunity page(s), investor's portfolio(s) use summary |
summary - FundSummary
|
A short summary of the fund to be shown on the investor portal use investorPortalConfiguration.summary |
registrationNumber - String
|
Registration number of the fund (e.g AFSL) |
legalStructure - LegalStructure!
|
Legal structure of the legal entity |
assetStructure - AssetStructure!
|
Asset structure of the Fund |
inception - DateTime!
|
Date that the Fund was created |
currency - Currency!
|
Currency which the Fund operates in |
country - Country!
|
Country where the Fund is operated |
cardImage - RemoteAsset
|
Image of the Fund, in card size format |
totalUnitCountDecimal - FixedPointNumber!
|
Total number of units authorised and held for this Fund |
calculatedNetAssetValue - Money
|
The calculated Net Asset Value of the Fund based on unit prices and ledger values |
targetCashReturn - Fraction
|
Cash return we predict the Fund will provide, if applicable |
targetTotalReturn - Fraction
|
Total return we predict the Fund will provide, if applicable |
documents - [FundDocument!]!
|
Files related to the Fund which can be downloaded by investors |
assets - [Asset!]
|
All Assets owned by this Fund |
asset - Asset
|
Asset on a Fund, by globally unique identifier |
Arguments
|
|
offers - [Offer!]
|
All Offers which are children of this Fund |
distributions - [Distribution!]!
|
The distributions related to this Fund use searchDistributions |
searchDistributions - DistributionSearchResults!
|
|
distribution - Distribution
|
The distribution of this Fund with a specific ID, null if does not exist use distributionV2 |
Arguments
|
|
distributionV2 - DistributionV2
|
The distribution of this Fund with a specific ID, null if does not exist |
Arguments
|
|
validateDistribution - [DistributionAlert!]
|
Validate a distribution with the given ID for this fund. Returns a list of alerts that should be addressed before confirming the distribution |
Arguments
|
|
secondaryMarket - SecondaryMarket
|
Information about the secondary market related to this fund. null if secondary market trading is not relevant for this fund |
sellOrder - SellOrder
|
|
Arguments
|
|
sellOrders - [SellOrder!]
|
|
buyOrder - BuyOrder
|
|
Arguments
|
|
buyOrders - [BuyOrder!]
|
|
offerStatus - FundOfferStatus
|
|
investorType - InvestorType!
|
|
largestOwnershipPercentageV2 - Float
|
|
numberOfActiveHoldings - Int
|
|
fundManagerName - String
|
|
lastDistributionDate - DateTime
|
|
equityRaised - Money!
|
Sum of Capital Contributed for all holdings across the fund |
hideDistributionMetrics - Boolean!
|
replaced by investorPortalConfiguration.holdingKeyMetrics |
searchUnitRedemptionRequests - UnitRedemptionRequestSearchResults!
|
Search unit redemption requests for this fund |
Arguments |
|
unitRedemptionRequest - UnitRedemptionRequest
|
return a specific unit redemption request by id |
Arguments
|
|
unitRedemptionConfiguration - FundUnitRedemptionConfiguration
|
configuration for unit redemptions for this fund |
unitPrecisionScale - Int
|
unit precision scale for the fund - maximum 9dp |
searchUnitClasses - UnitClassSearchResults!
|
Search unit classes for this fund |
showHoldingPageOnInvestorPortal - Boolean
|
When true, an investor with a holding in the fund can view a page with detailed information about their holding use investorPortalConfiguration.showHoldingPageOnInvestorPortal |
customMetrics - [CustomMetric!]
|
Custom metrics for the fund use investorPortalConfiguration.customMetrics |
investorPortalConfiguration - FundInvestorPortalConfiguration
|
Configuration for the holding page on the investor portal |
unitTransferRequest - UnitTransferRequest
|
Query a unit transfer request by ID |
Arguments
|
|
depositBankAccount - BankAccount!
|
Bank account that investment payments must be paid into |
searchOutgoingBankAccounts - FundOutgoingBankAccountSearchResults
|
The outgoing bank accounts that can be assigned to a unit class to pay distributions from |
Example
{
"id": 4,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"name": "abc123",
"legalName": "abc123",
"shortDescription": "abc123",
"summary": FundSummary,
"registrationNumber": "xyz789",
"legalStructure": "LIMITED_PARTNERSHIP",
"assetStructure": "SINGLE_ASSET",
"inception": "2007-12-03T10:15:30Z",
"currency": Currency,
"country": Country,
"cardImage": RemoteAsset,
"totalUnitCountDecimal": FixedPointNumber,
"calculatedNetAssetValue": Money,
"targetCashReturn": Fraction,
"targetTotalReturn": Fraction,
"documents": [FundDocument],
"assets": [Asset],
"asset": Asset,
"offers": [Offer],
"distributions": [Distribution],
"searchDistributions": DistributionSearchResults,
"distribution": Distribution,
"distributionV2": DistributionV2,
"validateDistribution": [
InvalidBankAccountDistributionAlert
],
"secondaryMarket": SecondaryMarket,
"sellOrder": SellOrder,
"sellOrders": [SellOrder],
"buyOrder": BuyOrder,
"buyOrders": [BuyOrder],
"offerStatus": "OPEN",
"investorType": "WHOLESALE",
"largestOwnershipPercentageV2": 123.45,
"numberOfActiveHoldings": 987,
"fundManagerName": "xyz789",
"lastDistributionDate": "2007-12-03T10:15:30Z",
"equityRaised": Money,
"hideDistributionMetrics": true,
"searchUnitRedemptionRequests": UnitRedemptionRequestSearchResults,
"unitRedemptionRequest": UnitRedemptionRequest,
"unitRedemptionConfiguration": FundUnitRedemptionConfiguration,
"unitPrecisionScale": 987,
"searchUnitClasses": UnitClassSearchResults,
"showHoldingPageOnInvestorPortal": false,
"customMetrics": [CustomMetric],
"investorPortalConfiguration": FundInvestorPortalConfiguration,
"unitTransferRequest": UnitTransferRequest,
"depositBankAccount": BankAccount,
"searchOutgoingBankAccounts": FundOutgoingBankAccountSearchResults
}
FundBankAccount
Fields
| Input Field | Description |
|---|---|
businessIdentifierCode - String
|
Otherwise known as SWIFT |
bankAccountInput - BankAccountInput
|
Example
{
"businessIdentifierCode": "xyz789",
"bankAccountInput": BankAccountInput
}
FundDocument
Description
A Document associated with a Fund
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Unique identifier of the Document |
updatedAt - DateTime!
|
|
file - RemoteAsset!
|
|
modifiedBy - AdminUser
|
|
publishDate - DateTime!
|
|
name - String!
|
Descriptive title of the Document |
categoryV2 - FundDocumentCategory
|
Category that the Document exists within |
visibility - FundDocumentVisibility
|
Whether the document should be shown on the investors of the fund |
documentId - ID
|
Unique identifier of the Document used for updating the fund document |
unitClass - UnitClass
|
Unit class associated with the Document |
Example
{
"id": 4,
"updatedAt": "2007-12-03T10:15:30Z",
"file": RemoteAsset,
"modifiedBy": AdminUser,
"publishDate": "2007-12-03T10:15:30Z",
"name": "abc123",
"categoryV2": "OFFER_DOCUMENTS",
"visibility": "INTERNAL",
"documentId": "4",
"unitClass": UnitClass
}
FundDocumentCategory
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"OFFER_DOCUMENTS"
FundDocumentVisibility
Values
| Enum Value | Description |
|---|---|
|
|
Document is visible to all admins |
|
|
Document is visible to all investing entities in the fund |
Example
"INTERNAL"
FundEdge
FundHoldingGraphConfig
Description
Configuration for the graph on the holding page
Fields
| Field Name | Description |
|---|---|
type - FundHoldingPageGraphType!
|
The graph to configure |
isEnabled - Boolean!
|
Whether the graph is visible to the investor |
Example
{"type": "RECENT_DISTRIBUTIONS", "isEnabled": true}
FundHoldingKeyMetricConfig
Description
Configuration for the default key metric on the holding page
Fields
| Field Name | Description |
|---|---|
type - FundHoldingKeyMetricType!
|
The key metric to configure |
isEnabled - Boolean!
|
Whether the key metric is visible to the investor |
Example
{"type": "INVESTED_SINCE", "isEnabled": true}
FundHoldingKeyMetricConfigInput
Description
Input for configuring default key metrics on investor portal holding page
Fields
| Input Field | Description |
|---|---|
type - FundHoldingKeyMetricType!
|
The key metric to configure |
isEnabled - Boolean!
|
Whether the key metric is visible to the investor |
Example
{"type": "INVESTED_SINCE", "isEnabled": true}
FundHoldingKeyMetricType
Description
Default holding key metrics on the investor portal holding page
Values
| Enum Value | Description |
|---|---|
|
|
The date that the first units were issued to the investing entity in the holding. |
|
|
The total number of units the investing entity currently owns in the holding. |
|
|
The total estimated per unit value of the holding, as input by the Fund Manager. |
|
|
The total amount of capital committed to the holding. |
|
|
The total amount of capital deployed to acquire units in the holding. |
|
|
The total amount of income returned to investors from the holding. |
|
|
The total amount of capital returned to investors from the holding. |
|
|
The remaining capital in the holding. |
|
|
The total capital gain/loss of the holding |
|
|
The total estimated value of the holding. |
|
|
The annual % return generated by the holding from income (cash) distributions. |
|
|
The annual rate of return of the holding considering the size and timing of cash flows. |
|
|
The total return multiple on capital invested in the holding. |
|
|
The date of the most recent distribution for the holding. |
Example
"INVESTED_SINCE"
FundHoldingPageGraphConfigInput
Description
Input for configuring graph on investor portal holding page
Fields
| Input Field | Description |
|---|---|
type - FundHoldingPageGraphType!
|
The graph to configure |
isEnabled - Boolean!
|
Whether the graph is visible to the investor |
Example
{"type": "RECENT_DISTRIBUTIONS", "isEnabled": false}
FundHoldingPageGraphType
Description
Graphs on the investor portal holding page
Values
| Enum Value | Description |
|---|---|
|
|
Displays total amount distributed in each of the last six months. |
|
|
Displays total amount distributed at various points since inception. |
|
|
Displays holding value at various points since inception. |
|
|
Displays holding contributed capital vs holding committed capital |
Example
"RECENT_DISTRIBUTIONS"
FundHoldingPageTableConfigInput
Description
Input for configuring table on investor portal holding page
Fields
| Input Field | Description |
|---|---|
type - FundHoldingPageTableType!
|
The table to configure |
isEnabled - Boolean!
|
Whether the table is visible to the investor |
Example
{"type": "RECENT_DOCUMENTS", "isEnabled": false}
FundHoldingPageTableType
Description
Tables on the investor portal holding page
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"RECENT_DOCUMENTS"
FundHoldingTableConfig
Description
Configuration for the table on the holding page
Fields
| Field Name | Description |
|---|---|
type - FundHoldingPageTableType!
|
The table to configure |
isEnabled - Boolean!
|
Whether the table is visible to the investor |
Example
{"type": "RECENT_DOCUMENTS", "isEnabled": true}
FundInvestorPortalConfiguration
Description
Configuration for the holding page on the investor portal
Fields
| Field Name | Description |
|---|---|
showFund - Boolean
|
When true, an investor can view fund's data from the investor portal portfolio and holding reporting |
showHoldingPage - Boolean
|
When true, an investor with a holding in the fund can view a page with detailed information about their holding |
summary - FundSummary
|
A short summary of the fund to be shown on the investor portal |
customMetrics - [CustomMetric!]
|
Custom metrics for the fund |
holdingKeyMetrics - [FundHoldingKeyMetricConfig!]
|
Configuration for which key metrics are shown on the holding page |
holdingGraphs - [FundHoldingGraphConfig!]
|
Configuration for which graphs are shown on the holding page |
holdingTables - [FundHoldingTableConfig!]
|
Configuration for which tables are shown on the holding page |
Example
{
"showFund": true,
"showHoldingPage": true,
"summary": FundSummary,
"customMetrics": [CustomMetric],
"holdingKeyMetrics": [FundHoldingKeyMetricConfig],
"holdingGraphs": [FundHoldingGraphConfig],
"holdingTables": [FundHoldingTableConfig]
}
FundOfferStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"OPEN"
FundOutgoingBankAccount
Description
The bank account that fund + unit class payments are paid from
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The bank account ID |
created - DateTime!
|
When the bank account was created |
name - String!
|
The name of the bank account |
accountNumber - String!
|
The bank account number |
businessIdentifierCode - String
|
The BIC/Swift code |
currency - Currency!
|
The currency of the bank account |
bankAccountLocationDetails - BankAccountLocationDetails
|
The location specific details of the bank account |
isFundDefault - Boolean!
|
If the bank account is the fund's default |
Example
{
"id": "4",
"created": "2007-12-03T10:15:30Z",
"name": "xyz789",
"accountNumber": "abc123",
"businessIdentifierCode": "abc123",
"currency": Currency,
"bankAccountLocationDetails": AUDBankAccountBankAccountLocationDetails,
"isFundDefault": false
}
FundOutgoingBankAccountEdge
Fields
| Field Name | Description |
|---|---|
node - FundOutgoingBankAccount!
|
|
cursor - String!
|
Example
{
"node": FundOutgoingBankAccount,
"cursor": "xyz789"
}
FundOutgoingBankAccountSearchResults
Fields
| Field Name | Description |
|---|---|
edges - [FundOutgoingBankAccountEdge!]!
|
|
pageInfo - PageInfo!
|
Example
{
"edges": [FundOutgoingBankAccountEdge],
"pageInfo": PageInfo
}
FundReportAsset
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Unique identifier of the report asset |
file - RemoteAsset
|
Generated report file in .pdf format |
status - FundReportAssetGenerationStatus!
|
Generation status of the report |
Example
{
"id": "4",
"file": RemoteAsset,
"status": "NOT_STARTED"
}
FundReportAssetGenerationStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"NOT_STARTED"
FundSearchFilters
Fields
| Input Field | Description |
|---|---|
keywords - String
|
|
legalStructures - [LegalStructure!]
|
|
countryIDs - [ID!]
|
|
paidTo - DateTime
|
Example
{
"keywords": "abc123",
"legalStructures": ["LIMITED_PARTNERSHIP"],
"countryIDs": [4],
"paidTo": "2007-12-03T10:15:30Z"
}
FundSearchResults
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
|
edges - [FundEdge!]!
|
Example
{
"pageInfo": PageInfo,
"edges": [FundEdge]
}
FundSearchSort
Fields
| Input Field | Description |
|---|---|
field - FundSearchSortField!
|
|
direction - SortDirection!
|
Example
{"field": "DATE", "direction": "ASC"}
FundSearchSortField
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"DATE"
FundSummary
Description
A summary of the fund to be shown on the investor portal
Example
{
"content": "xyz789",
"showOnSecondaryMarketListing": true,
"showOnHolding": false
}
FundSummaryInput
Description
Input to set a summary of the fund to be shown on the investor portal
Example
{
"content": "abc123",
"showOnSecondaryMarketListing": false,
"showOnHolding": false
}
FundUnitRedemptionConfiguration
Fields
| Field Name | Description |
|---|---|
enabled - Boolean!
|
true if the fund supports unit redemption requests |
Example
{"enabled": false}
GBPBankAccountBankAccountLocationDetails
Fields
| Field Name | Description |
|---|---|
sortCode - String!
|
Sort code for UK bank accounts |
Example
{"sortCode": "xyz789"}
GBPBankAccountInput
Fields
| Input Field | Description |
|---|---|
sortCode - String!
|
Example
{"sortCode": "xyz789"}
GBPVerifiableBankAccount
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
created - DateTime!
|
|
updated - DateTime!
|
|
name - String!
|
|
nickname - String!
|
|
currency - Currency!
|
|
isDefaultAccount - Boolean!
|
|
status - BankAccountStatus!
|
|
documents - [VerifiableDocument!]!
|
|
accountNumber - String!
|
|
sortCode - String!
|
|
investingEntity - InvestingEntity!
|
The investing entity that owns this bank account |
Example
{
"id": "4",
"created": "2007-12-03T10:15:30Z",
"updated": "2007-12-03T10:15:30Z",
"name": "abc123",
"nickname": "abc123",
"currency": Currency,
"isDefaultAccount": false,
"status": "PENDING",
"documents": [VerifiableDocument],
"accountNumber": "xyz789",
"sortCode": "xyz789",
"investingEntity": InvestingEntity
}
GenerateAIIRReportInput
GenerateAllTransactionsReportInput
GenerateAuditLogReportInput
GenerateCRSReportInput
GenerateDistributionAuditReportInput
Fields
| Input Field | Description |
|---|---|
distributionID - ID!
|
Example
{"distributionID": 4}
GenerateDistributionPaymentFileInput
Fields
| Input Field | Description |
|---|---|
distributionID - ID!
|
Example
{"distributionID": "4"}
GenerateDistributionReinvestmentReportInput
Fields
| Input Field | Description |
|---|---|
distributionID - ID!
|
Example
{"distributionID": 4}
GenerateDistributionSummaryReportInput
Fields
| Input Field | Description |
|---|---|
distributionID - ID!
|
Example
{"distributionID": "4"}
GenerateEmailBatchMessagesInput
Description
Input for generating email messages from the current batch template.
Fields
| Input Field | Description |
|---|---|
batchId - ID!
|
ID of the email batch to generate messages for |
Example
{"batchId": "4"}
GenerateEmailBatchMessagesResponse
Types
| Union Types |
|---|
Example
EmailBatch
GenerateFATCAReportInput
GenerateFundHoldingsReportInput
GenerateManagementFeeReportInput
Example
{
"startDate": "2007-12-03T10:15:30Z",
"endDate": "2007-12-03T10:15:30Z",
"fundId": "4",
"unitClassId": "4"
}
GenerateOfferAllocationsReportInput
Fields
| Input Field | Description |
|---|---|
offerId - ID!
|
Example
{"offerId": 4}
GenerateStatementBatchArchiveInput
Fields
| Input Field | Description |
|---|---|
id - ID!
|
The ID of the batch of statements to generate an archive for. |
Example
{"id": 4}
GenerateStatementBatchInput
Description
Input for generating a batch of statements.
Fields
| Input Field | Description |
|---|---|
id - ID!
|
The ID of the batch of statements to generate. |
Example
{"id": "4"}
GenerateStaticPaymentReferenceInput
Description
Input to generate a static payment reference for an investing entity
Fields
| Input Field | Description |
|---|---|
investingEntityId - ID!
|
ID of the investing entity to generate a payment reference for |
type - StaticPaymentReferenceType!
|
Type of the static payment reference to generate |
Example
{"investingEntityId": "4", "type": "BPAY"}
GetImportBatchAuditReportInput
Description
Input for getting the audit report of an import batch.
Fields
| Input Field | Description |
|---|---|
importBatchId - ID!
|
The ID of the import batch to get the audit report for. |
Example
{"importBatchId": 4}
HTML
Description
A scalar html
Example
HTML
HexColorCode
Description
A hex color code https://en.wikipedia.org/wiki/Web_colors
Example
"#7bb1b0"
HighPrecisionMoney
Description
Represents an amount in monetary value in greater precision.
Fields
| Field Name | Description |
|---|---|
amount - MoneyUnit!
|
The monetary value in full unit of the currency (e.g. 1.50, 1.3562). |
currency - Currency!
|
The ISO 4217 3-character alpha code of the monetary value (e.g. NZD, AUD). |
Example
{
"amount": MoneyUnit,
"currency": Currency
}
HighPrecisionMoneyInput
Description
Input an amount in monetary value in greater precision.
Fields
| Input Field | Description |
|---|---|
amount - MoneyUnit!
|
The monetary value in full unit of the currency (e.g. 1.50, 1.3562). |
currencyCode - String!
|
The ISO 4217 3-character alpha code of the monetary value (e.g. NZD, AUD). |
Example
{
"amount": MoneyUnit,
"currencyCode": "abc123"
}
Holding
Description
An ownership in a Fund
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Unique identifier of the Holding |
createdAt - DateTime
|
This is the date of the first ledger item effective date. If there are no ledger items, this will be the created date of the holding. |
updatedAt - DateTime
|
Date the holding was updated |
investingEntity - InvestingEntity!
|
Entity representing the owner/s of this ownership stake in the Fund |
markedValue - Money!
|
The latest marked value based on the NAV of the fund and the proportion of the holding |
capitalContributed - Money
|
The total capital contributed for this holding |
capitalCommitted - Money
|
The total capital committed for this holding |
unitCountDecimal - FixedPointNumber!
|
Number of units held in this holding for this Fund |
availableUnitCount - FixedPointNumber!
|
|
Arguments
|
|
ownershipPercentage - Float
|
Fractional representation of ownership stake in this Fund |
unitClassOwnershipPercentage - Float
|
Fractional representation of ownership stake this holding has in the unit class of the fund |
cashDistributions - Money
|
Total cash distributions for this holding |
capitalReturns - Money
|
Total capital returns for this holding |
bankAccount - VerifiableBankAccount
|
Bank account used for distributions on this holding |
redemptionBankAccount - VerifiableBankAccount
|
Bank account used for redemptions on this holding |
fund - Fund!
|
The Fund for the holding |
distributionSettings - HoldingDistributionSettings!
|
|
distributionsWithheldAmount - Money!
|
|
withheldDistributions - [WithheldDistribution!]
|
|
unitClass - UnitClass!
|
Unit class of the holding |
reinvestmentUnitClass - UnitClass
|
Unit class for distribution reinvestment |
Example
{
"id": 4,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"investingEntity": InvestingEntity,
"markedValue": Money,
"capitalContributed": Money,
"capitalCommitted": Money,
"unitCountDecimal": FixedPointNumber,
"availableUnitCount": FixedPointNumber,
"ownershipPercentage": 987.65,
"unitClassOwnershipPercentage": 123.45,
"cashDistributions": Money,
"capitalReturns": Money,
"bankAccount": VerifiableBankAccount,
"redemptionBankAccount": VerifiableBankAccount,
"fund": Fund,
"distributionSettings": "ENABLED",
"distributionsWithheldAmount": Money,
"withheldDistributions": [WithheldDistribution],
"unitClass": UnitClass,
"reinvestmentUnitClass": UnitClass
}
HoldingAssociatedRecordFilter
Fields
| Input Field | Description |
|---|---|
id - ID!
|
ID of the associated record |
recordType - HoldingAssociatedRecordType!
|
Type of the associated record |
Example
{"id": "4", "recordType": "FUND"}
HoldingAssociatedRecordType
Description
The associated records that search holdings supports
Values
| Enum Value | Description |
|---|---|
|
|
Example
"FUND"
HoldingDistribution
Description
An amount distributed to an investing entity
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Unique ID of the holding distribution |
distributionId - ID!
|
distribution ID |
transactionId - ID
|
transaction ID id of related transaction(note 27 char ksuid) |
investingEntity - InvestingEntity!
|
The investing entity of the holding |
distributionPeriods - [HoldingDistributionPeriod!]!
|
Periods that altogether make up this HoldingDistribution |
statement - FundReportAsset
|
PDF statement of distribution for tax purposes |
status - HoldingDistributionStatus!
|
|
details - HoldingDistributionDetails!
|
|
distributionPaymentDate - DateTime!
|
Payment date of the distribution |
Example
{
"id": "4",
"distributionId": 4,
"transactionId": 4,
"investingEntity": InvestingEntity,
"distributionPeriods": [HoldingDistributionPeriod],
"statement": FundReportAsset,
"status": "ENABLED",
"details": HoldingDistributionDetails,
"distributionPaymentDate": "2007-12-03T10:15:30Z"
}
HoldingDistributionDetails
Example
{
"unitCount": 123,
"ownership": Fraction,
"distribution": Fraction,
"grossDistribution": Money,
"taxWithheld": Money,
"netDistribution": Money
}
HoldingDistributionPeriod
Description
A period where the holding's number of units is the same throughout
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Unique ID of the holding distribution |
periodFrom - DateTime!
|
Start of this period (inclusive) |
periodTo - DateTime!
|
End of this period (inclusive) |
ownership - Fraction!
|
The ownership by this investing entity during this period |
unitCount - Int!
|
The number of units held by this investing entity during this period |
distributionAmount - Money!
|
The amount distributed to this investing entity for this period |
Example
{
"id": 4,
"periodFrom": "2007-12-03T10:15:30Z",
"periodTo": "2007-12-03T10:15:30Z",
"ownership": Fraction,
"unitCount": 987,
"distributionAmount": Money
}
HoldingDistributionSettings
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"ENABLED"
HoldingDistributionStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"ENABLED"
HoldingEdge
HoldingSearchResults
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
|
edges - [HoldingEdge!]!
|
Example
{
"pageInfo": PageInfo,
"edges": [HoldingEdge]
}
HoldingStatementConfig
Fields
| Field Name | Description |
|---|---|
type - HoldingStatementType!
|
The type of the statements. |
category - DocumentCategoryV2!
|
The category of the statements. |
recipients - HoldingStatementRecipients!
|
The recipients of the statements. |
period - DateRange!
|
The period from which the statements are generated. |
commentary - String
|
The commentary added to the statement. |
Example
{
"type": "HOLDING_SUMMARY",
"category": "AUTHORITY",
"recipients": HoldingStatementRecipients,
"period": DateRange,
"commentary": "xyz789"
}
HoldingStatementConfigInput
Fields
| Input Field | Description |
|---|---|
name - String!
|
Name of the batch of statements. |
type - HoldingStatementType!
|
Type of statement to create. |
recipients - HoldingStatementRecipientsInput!
|
The recipients of the statement. |
period - DateRangeInput!
|
The period for the statement. |
publishAt - DateTime
|
The date the statement is scheduled to be published. |
commentary - String
|
A comment to include with the statement. |
Example
{
"name": "abc123",
"type": "HOLDING_SUMMARY",
"recipients": HoldingStatementRecipientsInput,
"period": DateRangeInput,
"publishAt": "2007-12-03T10:15:30Z",
"commentary": "abc123"
}
HoldingStatementRecipients
Description
Recipients filter for batch generation of statements for holding statements.
The fields will contain the objects that are selected for the batch. If nothing was selected on batch creation, the fields will be empty.
Fields
| Field Name | Description |
|---|---|
investingEntities - [InvestingEntity!]
|
Selected investing entities for the batch. |
fund - Fund!
|
Selected fund for the holding statement. |
Example
{
"investingEntities": [InvestingEntity],
"fund": Fund
}
HoldingStatementRecipientsInput
HoldingStatementType
Description
The different types of holding statements that can be generated.
Values
| Enum Value | Description |
|---|---|
|
|
Example
"HOLDING_SUMMARY"
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
IPAddress
Description
An ipv4/6 ip address
Example
IPAddress
IdentityDocumentFields
Fields
| Field Name | Description |
|---|---|
type - IdentityDocumentType
|
|
country - Country
|
|
documentNumber - String
|
Example
{
"type": "PASSPORT",
"country": Country,
"documentNumber": "xyz789"
}
IdentityDocumentFieldsInput
Fields
| Input Field | Description |
|---|---|
type - IdentityDocumentType!
|
|
countryId - ID!
|
|
dateOfBirth - DayMonthYearInput!
|
|
dateOfExpiry - DayMonthYearInput
|
|
documentNumber - String!
|
Example
{
"type": "PASSPORT",
"countryId": "4",
"dateOfBirth": DayMonthYearInput,
"dateOfExpiry": DayMonthYearInput,
"documentNumber": "xyz789"
}
IdentityDocumentType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"PASSPORT"
IdentityVerification
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
dateAttempted - DateTime!
|
|
identityDocumentDetails - IdentityDocumentFields
|
Possible Types
| IdentityVerification Types |
|---|
Example
{
"id": "4",
"dateAttempted": "2007-12-03T10:15:30Z",
"identityDocumentDetails": IdentityDocumentFields
}
IdentityVerificationDocumentActivityFeedItem
IdentityVerificationNoteActivityFeedItem
IdentityVerificationStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"INCOMPLETE"
ImportBatch
Description
All information about an import batch operation.
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The ID of the batch. |
createdAt - DateTime!
|
The date the batch was created. |
updatedAt - DateTime!
|
The date the batch was last updated. |
type - ImportJobType!
|
The type of import job this batch handles. |
name - String!
|
Name of the batch. |
file - RemoteAsset!
|
The uploaded file containing the data to import. |
createdBy - AdminUser!
|
The admin user who created this batch. |
confirmedBy - AdminUser
|
The admin user that confirmed the batch. |
confirmedAt - DateTime
|
The time when the batch was confirmed. |
status - ImportJobStatus!
|
The current status of the batch. |
notificationTime - DateTime
|
The time when the email notification should be sent. |
metadata - ImportJobMetadata
|
Metadata about the job being processed, specific to the job type. |
validationErrors - [ImportValidationError!]
|
Detailed validation errors for CSV data with row and column information. |
importJobs - [ImportJob!]
|
A list of import jobs in the batch. |
Example
{
"id": "4",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"type": "UNIT_ISSUANCE",
"name": "xyz789",
"file": RemoteAsset,
"createdBy": AdminUser,
"confirmedBy": AdminUser,
"confirmedAt": "2007-12-03T10:15:30Z",
"status": "GENERATING",
"notificationTime": "2007-12-03T10:15:30Z",
"metadata": UnitIssuanceImportMetadata,
"validationErrors": [ImportValidationError],
"importJobs": [ImportJob]
}
ImportBatchConnection
Description
Connection type for paginated import batches.
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
|
edges - [ImportBatchEdge!]!
|
Example
{
"pageInfo": PageInfo,
"edges": [ImportBatchEdge]
}
ImportBatchEdge
Description
Edge type for import batch connections.
Fields
| Field Name | Description |
|---|---|
cursor - Cursor!
|
|
node - ImportBatch!
|
Example
{
"cursor": Cursor,
"node": ImportBatch
}
ImportJob
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The ID of the import job. |
status - ImportJobStatus!
|
The status of the import job. |
failureReason - String
|
The failure reason if the job failed. |
config - ImportJobConfig
|
The configuration extended to the specific job type. |
Example
{
"id": 4,
"status": "GENERATING",
"failureReason": "abc123",
"config": UnitIssuanceImportJobConfig
}
ImportJobConfig
Types
| Union Types |
|---|
Example
UnitIssuanceImportJobConfig
ImportJobMetadata
Description
Metadata about the import batch job, specific to the job type.
Types
| Union Types |
|---|
Example
UnitIssuanceImportMetadata
ImportJobStatus
Description
The status of an import batch or individual import job.
Values
| Enum Value | Description |
|---|---|
|
|
The batch is currently being generated/processed. |
|
|
The batch generation failed. |
|
|
The batch has been generated and is ready for confirmation. |
|
|
The batch is currently being confirmed. |
|
|
The batch has been confirmed and processed successfully. |
|
|
The batch processing failed. |
Example
"GENERATING"
ImportJobType
Description
The different types of import jobs that can be processed.
Values
| Enum Value | Description |
|---|---|
|
|
Bulk unit issuance import job |
Example
"UNIT_ISSUANCE"
ImportValidationError
Description
Detailed validation error information for import operations.
Example
{
"row": 987,
"column": "abc123",
"error": "xyz789"
}
IndexedKeyValue
IndexedKeyValueInput
IndividualBeneficialOwner
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
created - DateTime!
|
|
relationship - BeneficialOwnerRelationship!
|
|
nodes - [BeneficialOwner]!
|
|
notes - [Note]!
|
|
activity - [ActivityMessage]!
|
|
uploadedDocuments - [UploadedDocument!]!
|
|
parent - BeneficialOwnerParent
|
|
firstName - String!
|
|
middleName - String
|
|
lastName - String!
|
|
dateOfBirth - DayMonthYear
|
|
phoneNumber - PhoneNumber
|
|
email - String
|
|
status - IndividualBeneficialOwnerVerificationStatus!
|
|
identityVerifications - [IdentityVerification!]!
|
|
pepResults - PEPSearchResult
|
|
addresses - [VerifiableAddress!]!
|
|
associatedInvestingEntity - InvestingEntity
|
|
identityVerificationLastSent - DateTime
|
|
taxResidency - InvestingEntityTaxResidency
|
Tax residency of individual beneficial owner |
Example
{
"id": 4,
"created": "2007-12-03T10:15:30Z",
"relationship": "DIRECTOR",
"nodes": [BeneficialOwner],
"notes": [Note],
"activity": [ActivityMessage],
"uploadedDocuments": [UploadedDocument],
"parent": EntityBeneficialOwner,
"firstName": "abc123",
"middleName": "abc123",
"lastName": "abc123",
"dateOfBirth": DayMonthYear,
"phoneNumber": PhoneNumber,
"email": "xyz789",
"status": "EXEMPT",
"identityVerifications": [IdentityVerification],
"pepResults": PEPSearchResult,
"addresses": [VerifiableAddress],
"associatedInvestingEntity": InvestingEntity,
"identityVerificationLastSent": "2007-12-03T10:15:30Z",
"taxResidency": InvestingEntityTaxResidency
}
IndividualBeneficialOwnerVerificationStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"EXEMPT"
IndividualInvestingEntity
Fields
| Field Name | Description |
|---|---|
id - ID!
|
ID of the individual investing entity |
legalName - LegalName
|
Legal name of the individual |
displayName - String
|
Display name of the individual - not populated if IndividualInvestingEntity is for a JointIndividualInvestingEntity |
email - String
|
Email address of the individual |
placeOfBirth - PlaceOfBirth
|
Place of birth of the individual |
primaryCitizenshipId - Country
|
Primary citizenship of the individual |
phoneNumber - PhoneNumber
|
Phone number of the individual |
taxResidency - InvestingEntityTaxResidency
|
Tax residency details for the individual |
nzPrescribedInvestorRate - NZPrescribedInvestorRateBasisPoints
|
NZ PIR |
nzPrescribedInvestorTaxDeclarationStatus - TaxDeclarationStatus
|
Declared status of the NZ PIR |
interestResidentWithholdingTax - ResidentWithholdingTaxRateBasisPoints
|
RWT rate on interest |
interestResidentWithholdingTaxDeclarationStatus - TaxDeclarationStatus
|
Declared status of the RWT |
nonResidentWithholdingTaxRate - NonResidentWithholdingTaxRateBasisPoints
|
NRWT rate on interest |
nonResidentWithholdingTaxDeclarationStatus - TaxDeclarationStatus
|
Declared status of the NRWT |
address - Address
|
Registered address for the individual |
postalAddress - Address
|
Postal address for the individual |
placeOfBusinessAddress - Address
|
Place of business for the individual |
natureAndPurposeDetails - NatureAndPurposeDetails
|
Nature and purpose details for the individual |
clientReferenceNumber - String
|
Client Reference Number for historical client references |
paymentReference - String
|
Payment Reference for integration purposes use paymentReferences instead |
paymentReferences - [StaticPaymentReference!]!
|
References to be used by an investing entity when making payments |
Example
{
"id": 4,
"legalName": LegalName,
"displayName": "xyz789",
"email": "abc123",
"placeOfBirth": PlaceOfBirth,
"primaryCitizenshipId": Country,
"phoneNumber": PhoneNumber,
"taxResidency": InvestingEntityTaxResidency,
"nzPrescribedInvestorRate": "UNSET",
"nzPrescribedInvestorTaxDeclarationStatus": "DECLARED",
"interestResidentWithholdingTax": "RATE_0",
"interestResidentWithholdingTaxDeclarationStatus": "DECLARED",
"nonResidentWithholdingTaxRate": "RATE_0",
"nonResidentWithholdingTaxDeclarationStatus": "DECLARED",
"address": Address,
"postalAddress": Address,
"placeOfBusinessAddress": Address,
"natureAndPurposeDetails": NatureAndPurposeDetails,
"clientReferenceNumber": "xyz789",
"paymentReference": "xyz789",
"paymentReferences": [BankPaymentReference]
}
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
InvalidBankAccountDistributionAlert
Description
The distribution is missing bank account information for some holdings
Fields
| Field Name | Description |
|---|---|
holdingIds - [ID!]!
|
IDs of the holdings with missing bank account information |
Example
{"holdingIds": [4]}
InvestingEntity
Description
An individual, joint individuals, a company, a trust, or a partnership
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
created - DateTime!
|
|
updated - DateTime!
|
|
entityType - InvestingEntityType!
|
|
entity - Entity
|
|
sourceOfFundsVerificationEmailLastSent - DateTime
|
|
relationship - InvestingEntityRelationship
|
|
country - Country
|
|
bankAccounts - [VerifiableBankAccount]!
|
|
bankAccount - VerifiableBankAccount
|
|
accreditationsStandardised - [InvestingEntityStandardisedAccreditation!]
|
|
accreditationCountry - Country
|
|
wholesaleCertificationStatus - WholesaleCertificationStatus
|
|
primaryOwner - Account
|
|
accounts - [Account]
|
|
beneficialOwners - [BeneficialOwner!]!
|
If this Investing Entity is a joint-individual, the joint-individual second investor details. null if not complete yet or not a joint individual. |
beneficialOwner - BeneficialOwner
|
|
Arguments
|
|
lastRequestedBeneficialOwnersContactDetails - DateTime
|
When beneficial owners contact details were last requested - null if they have never been requested |
lastRequestedWholesaleCertification - DateTime
|
When wholesale certification was last requested - null if it has never been requested |
allocations - [Allocation]
|
|
riskProfile - RiskProfile!
|
|
holdings - [Holding!]
|
|
totalPortfolioValue - Money
|
|
totalHoldingMarkedValue - Money
|
|
totalCapitalContributed - Money
|
The total capital contributed for the investing entity across all holdings |
searchActivityFeed - ActivityFeedResults!
|
|
Arguments |
|
governingDocuments - [InvestingEntityGoverningDocument!]!
|
Governing documents associated with the investing entity |
searchTransactionsV2 - SearchTransactionsResults!
|
Query and return a paginated list of Transactions, where each transaction has either come from or gone to this investing entity |
Arguments
|
|
outstandingTaskCount - Int!
|
|
bankAccountVerificationStatus - BankAccountStatus
|
|
sourceOfFundsVerificationStatus - SourceOfFundsVerificationStatus
|
|
outstandingTasks - [Task!]
|
|
outstandingNotifications - [InvestingEntityNotification!]
|
|
associatedAccounts - [AssociatedAccount!]!
|
|
tags - [InvestingEntityTag!]
|
|
Example
{
"id": 4,
"created": "2007-12-03T10:15:30Z",
"updated": "2007-12-03T10:15:30Z",
"entityType": "INDIVIDUAL",
"entity": IndividualInvestingEntity,
"sourceOfFundsVerificationEmailLastSent": "2007-12-03T10:15:30Z",
"relationship": "SHAREHOLDING_VOTING_RIGHTS_GREATER_THAN_25_PERCENT",
"country": Country,
"bankAccounts": [VerifiableBankAccount],
"bankAccount": VerifiableBankAccount,
"accreditationsStandardised": [
InvestingEntityStandardisedAccreditation
],
"accreditationCountry": Country,
"wholesaleCertificationStatus": "AWAITING",
"primaryOwner": Account,
"accounts": [Account],
"beneficialOwners": [BeneficialOwner],
"beneficialOwner": BeneficialOwner,
"lastRequestedBeneficialOwnersContactDetails": "2007-12-03T10:15:30Z",
"lastRequestedWholesaleCertification": "2007-12-03T10:15:30Z",
"allocations": [Allocation],
"riskProfile": RiskProfile,
"holdings": [Holding],
"totalPortfolioValue": Money,
"totalHoldingMarkedValue": Money,
"totalCapitalContributed": Money,
"searchActivityFeed": ActivityFeedResults,
"governingDocuments": [
InvestingEntityGoverningDocument
],
"searchTransactionsV2": SearchTransactionsResults,
"outstandingTaskCount": 123,
"bankAccountVerificationStatus": "PENDING",
"sourceOfFundsVerificationStatus": "COMPLETE",
"outstandingTasks": [Task],
"outstandingNotifications": [
InvestingEntityNotification
],
"associatedAccounts": [AssociatedAccount],
"tags": [InvestingEntityTag]
}
InvestingEntityAccountAccess
Values
| Enum Value | Description |
|---|---|
|
|
Example
"FULL"
InvestingEntityAccountLink
Fields
| Field Name | Description |
|---|---|
isCommunicationsEnabled - Boolean!
|
|
access - InvestingEntityAccountAccess!
|
Example
{"isCommunicationsEnabled": false, "access": "FULL"}
InvestingEntityAccreditationApprovalStatus
Description
Approval status for accreditation certificates
Values
| Enum Value | Description |
|---|---|
|
|
The accreditation certificate is pending approval |
|
|
The accreditation certificate has been verified and approved |
|
|
The accreditation certificate has expired |
|
|
The accreditation certificate has been declined |
Example
"PENDING"
InvestingEntityActiveHoldingsFilter
Description
used for filtering investing entities by their active holdings
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"ZERO_HOLDINGS"
InvestingEntityAvailableFunds
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"UNDER_50K"
InvestingEntityCompanyType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"LIMITED_COMPANY"
InvestingEntityDocument
Description
A Document associated with an Investing Entity
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
updatedAt - DateTime!
|
|
file - RemoteAsset!
|
|
modifiedBy - AdminUser
|
|
publishDate - DateTime
|
|
name - String
|
Descriptive title of the Document |
category - InvestingEntityDocumentCategory!
|
Category that the Document exists within |
visibility - InvestingEntityDocumentVisibility!
|
Whether the document should be shown on the investor portal |
fund - Fund
|
|
unitClass - UnitClass
|
Unit class associated with the Document |
Example
{
"id": "4",
"updatedAt": "2007-12-03T10:15:30Z",
"file": RemoteAsset,
"modifiedBy": AdminUser,
"publishDate": "2007-12-03T10:15:30Z",
"name": "xyz789",
"category": "TAX_STATEMENTS",
"visibility": "INTERNAL",
"fund": Fund,
"unitClass": UnitClass
}
InvestingEntityDocumentActivityFeedItem
InvestingEntityDocumentCategory
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"TAX_STATEMENTS"
InvestingEntityDocumentVisibility
Values
| Enum Value | Description |
|---|---|
|
|
Document is visible to all admins |
|
|
Document is visible to all admins and the documents investing entity |
Example
"INTERNAL"
InvestingEntityEdge
Fields
| Field Name | Description |
|---|---|
cursor - String!
|
|
node - InvestingEntity
|
Example
{
"cursor": "xyz789",
"node": InvestingEntity
}
InvestingEntityEmailBatchRecipientConfiguration
Description
Investing entity recipients filter for email batch.
The fields will contain the filter configuration that was selected to create the batch. If allInvestingEntitiesIncluded is false, one of the other filter fields will be populated.
Fields
| Field Name | Description |
|---|---|
allInvestingEntitiesIncluded - Boolean!
|
All investing entities were selected as recipients of the email batch |
investingEntitiesFilter - [InvestingEntity!]
|
Investing entities that were selected in investingEntityIds filter when creating the email batch |
investingEntityTagsFilter - [InvestingEntityTag!]
|
Investing entity tags that were selected as recipients filter of the email batch |
distributionFilter - DistributionV2
|
Distribution that was selected as recipients filter of the email batch |
Example
{
"allInvestingEntitiesIncluded": true,
"investingEntitiesFilter": [InvestingEntity],
"investingEntityTagsFilter": [InvestingEntityTag],
"distributionFilter": DistributionV2
}
InvestingEntityEmailBatchRecipientConfigurationInput
Description
Configuration for selecting investing entity recipients for an email batch.
Fields
| Input Field | Description |
|---|---|
allInvestingEntities - Boolean!
|
Send emails to all investing entities in the system, if true, other investing entity filters will be ignored. Default = false |
investingEntityIds - [ID!]
|
IDs of the investing entities to filter recipients by |
investingEntityTagIds - [ID!]
|
IDs of the tags associated with investing entities to filter recipients by |
distributionId - ID
|
Filter to include all investing entity contacts that have an active holding in the distribution with the specified ID. |
Example
{
"allInvestingEntities": false,
"investingEntityIds": ["4"],
"investingEntityTagIds": [4],
"distributionId": "4"
}
InvestingEntityFrequencyOfInvestment
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
This is synonymous to Ongoing Investment |
Example
"ONE_OFF"
InvestingEntityGoverningDocument
Description
A governing document associated with an investing entity
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Unique identifier for the governing document |
name - String!
|
Display name for the governing document |
updatedAt - DateTime!
|
Last time the document was updated |
file - RemoteAsset!
|
The file associated with this governing document |
status - InvestingEntityGoverningDocumentStatus!
|
The current approval status of the governing document |
declinedReason - String
|
Reason why the governing document was declined (only present when status is DECLINED) |
Example
{
"id": 4,
"name": "xyz789",
"updatedAt": "2007-12-03T10:15:30Z",
"file": RemoteAsset,
"status": "PENDING",
"declinedReason": "xyz789"
}
InvestingEntityGoverningDocumentStatus
Description
Approval status for investing entity governing documents
Values
| Enum Value | Description |
|---|---|
|
|
The governing document is pending approval |
|
|
The governing document has been verified and approved |
|
|
The governing document has been declined |
Example
"PENDING"
InvestingEntityKeyAccountUpdateActivityFeedItem
InvestingEntityNotification
Description
A notification related to an investing entity
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
status - NotificationStatus!
|
|
created - DateTime!
|
Possible Types
| InvestingEntityNotification Types |
|---|
Example
{
"id": "4",
"status": "INCOMPLETE",
"created": "2007-12-03T10:15:30Z"
}
InvestingEntityPartnershipType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"LIMITED_PARTNERSHIP"
InvestingEntityReasonForInvesting
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"ONGOING_INCOME"
InvestingEntityRelationship
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"SHAREHOLDING_VOTING_RIGHTS_GREATER_THAN_25_PERCENT"
InvestingEntityRiskProfileFilter
Description
used for filtering investing entities by their risk profile
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"ONE"
InvestingEntitySearchResults
Fields
| Field Name | Description |
|---|---|
edges - [InvestingEntityEdge!]!
|
|
pageInfo - PageInfo!
|
Example
{
"edges": [InvestingEntityEdge],
"pageInfo": PageInfo
}
InvestingEntityStandardisedAccreditation
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
updated - DateTime!
|
|
type - AccreditationType
|
|
approvalStatus - InvestingEntityAccreditationApprovalStatus!
|
The current approval status of the accreditation certificate |
country - Country
|
|
files - [RemoteAsset!]!
|
List of files associated with this accreditation certificate |
signedAt - DateTime
|
|
declinedReason - String
|
Reason why the accreditation certificate was declined (only present when approvalStatus is DECLINED) |
Example
{
"id": "4",
"updated": "2007-12-03T10:15:30Z",
"type": "SAFE_HARBOUR",
"approvalStatus": "PENDING",
"country": Country,
"files": [RemoteAsset],
"signedAt": "2007-12-03T10:15:30Z",
"declinedReason": "abc123"
}
InvestingEntityTag
InvestingEntityTaxResidency
Description
Details for the primary and secondary tax residencies of an investing entity
Fields
| Field Name | Description |
|---|---|
primaryResidency - Country
|
Country where the investing entity is primarily tax resident. This is the country where the entity is considered to have its main tax obligations. |
primaryTaxIdentificationNumber - String
|
Tax identification number for the investing entity in their primary tax residency. This is the identification number used by the tax authorities in the country of primary tax residency. |
secondaryResidency - Country
|
Country where the investing entity is secondarily tax resident. |
secondaryTaxIdentificationNumber - String
|
Tax identification number for the investing entity in their secondary tax residency. |
Example
{
"primaryResidency": Country,
"primaryTaxIdentificationNumber": "xyz789",
"secondaryResidency": Country,
"secondaryTaxIdentificationNumber": "xyz789"
}
InvestingEntityTrustType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"ESTATE"
InvestingEntityType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"INDIVIDUAL"
InvestorPortalConfiguration
Fields
| Field Name | Description |
|---|---|
portfolioKeyMetrics - [PortfolioKeyMetricConfig!]!
|
Configuration for portfolio key metrics |
portfolioGraphs - [PortfolioGraphConfig!]!
|
Configuration for portfolio graphs |
portfolioTables - [PortfolioTableConfig!]!
|
Configuration for portfolio tables |
Example
{
"portfolioKeyMetrics": [PortfolioKeyMetricConfig],
"portfolioGraphs": [PortfolioGraphConfig],
"portfolioTables": [PortfolioTableConfig]
}
InvestorPortalConfigurationInput
Description
Input for updating the configuration for the investor portal portfolio page
Fields
| Input Field | Description |
|---|---|
portfolioKeyMetrics - [PortfolioKeyMetricConfigInput!]
|
Configuration for portfolio key metrics |
portfolioGraphs - [PortfolioGraphConfigInput!]
|
Configuration for portfolio graphs |
portfolioTables - [PortfolioTableConfigInput!]
|
Configuration for portfolio tables |
Example
{
"portfolioKeyMetrics": [PortfolioKeyMetricConfigInput],
"portfolioGraphs": [PortfolioGraphConfigInput],
"portfolioTables": [PortfolioTableConfigInput]
}
InvestorProfile
InvestorProfileEdge
Fields
| Field Name | Description |
|---|---|
cursor - String!
|
|
node - InvestorProfile!
|
Example
{
"cursor": "abc123",
"node": Account
}
InvestorProfileSearchResult
Fields
| Field Name | Description |
|---|---|
edges - [InvestorProfileEdge!]!
|
|
pageInfo - PageInfo!
|
Example
{
"edges": [InvestorProfileEdge],
"pageInfo": PageInfo
}
InvestorProfileStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"ACTIVE"
InvestorProfileTag
InvestorStatementConfig
Fields
| Field Name | Description |
|---|---|
type - InvestorStatementType!
|
The type of the statements. |
category - DocumentCategoryV2!
|
The category of the statements. |
recipients - InvestorStatementRecipients!
|
The recipients of the statements. |
period - DateRange!
|
The period from which the statements are generated. |
commentary - String
|
The commentary added to the statement. |
Example
{
"type": "INVESTOR_SUMMARY",
"category": "AUTHORITY",
"recipients": InvestorStatementRecipients,
"period": DateRange,
"commentary": "abc123"
}
InvestorStatementConfigInput
Description
Input for configuring a batch of statements for investors.
Fields
| Input Field | Description |
|---|---|
name - String!
|
Name of the batch of statements. |
type - InvestorStatementType!
|
Type of statement to create. |
recipients - InvestorStatementRecipientsInput!
|
The recipients of the statement. |
period - DateRangeInput!
|
The period for the statement. |
publishAt - DateTime
|
The date the statement is scheduled to be published. |
commentary - String
|
A comment to include with the statement. |
Example
{
"name": "xyz789",
"type": "INVESTOR_SUMMARY",
"recipients": InvestorStatementRecipientsInput,
"period": DateRangeInput,
"publishAt": "2007-12-03T10:15:30Z",
"commentary": "abc123"
}
InvestorStatementRecipients
Description
Recipients filter for batch generation of statements for investing entities.
The fields will contain the objects that are selected for the batch. If nothing was selected on batch creation, the fields will be empty.
Fields
| Field Name | Description |
|---|---|
investingEntities - [InvestingEntity!]
|
Will return the investing entities selected for the batch. |
investingEntityTags - [TagV2!]
|
Will return the investing entity tags selected for the batch. |
Example
{
"investingEntities": [InvestingEntity],
"investingEntityTags": [InvestingEntityTag]
}
InvestorStatementRecipientsInput
Description
Input for configuring recipients of a batch of statements.
Example
{
"investingEntityIds": [4],
"investingEntityTagIds": ["4"]
}
InvestorStatementType
Description
The different types of statements that can be generated for an investor.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"INVESTOR_SUMMARY"
InvestorType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"WHOLESALE"
IssueAllocationUnitsInput
Fields
| Input Field | Description |
|---|---|
allocationId - ID!
|
ID of the allocation to issue units for |
unitClassId - ID!
|
ID of the fund's unit class |
unitCount - FixedPointNumberInput!
|
Number of units to issue |
pricePerUnit - MoneyUnit!
|
Unit price for the allocation |
issueDate - DateTime!
|
Date the units are issued |
notifyInvestors - Boolean!
|
Whether to notify the investor of the unit issuance |
publishStatementsToInvestorPortal - Boolean!
|
Whether to publish unit issuance statement to the investor portal |
tags - [TransactionTag!]
|
List of tags to be associated with the unit issuance |
Example
{
"allocationId": "4",
"unitClassId": "4",
"unitCount": FixedPointNumberInput,
"pricePerUnit": MoneyUnit,
"issueDate": "2007-12-03T10:15:30Z",
"notifyInvestors": false,
"publishStatementsToInvestorPortal": true,
"tags": ["RELATED_PARTY_NCBO"]
}
JSON
Description
A scalar json
Example
{}
JointIndividualInvestingEntity
Fields
| Field Name | Description |
|---|---|
id - ID!
|
ID of the joint individual investing entity |
name - String
|
Legal name of the joint individual entity |
displayName - String
|
Display name of the joint individual entity |
individualOne - IndividualInvestingEntity!
|
Individual one |
individualTwo - IndividualInvestingEntity!
|
Individual two |
Example
{
"id": 4,
"name": "xyz789",
"displayName": "abc123",
"individualOne": IndividualInvestingEntity,
"individualTwo": IndividualInvestingEntity
}
LegalName
LegalNameInput
LegalStructure
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"LIMITED_PARTNERSHIP"
LockAccountInput
LogEmailInput
Fields
| Input Field | Description |
|---|---|
id - ID!
|
ID of the associated record |
type - EmailLogAssociatedRecordInput!
|
Type of the associated record |
emailSubject - String!
|
Subject of the email |
emailBody - String!
|
Body of the email in HTML format |
from - String!
|
Sender email address |
to - String!
|
Recipient email addresses |
Example
{
"id": 4,
"type": "ACCOUNT",
"emailSubject": "xyz789",
"emailBody": "xyz789",
"from": "xyz789",
"to": "xyz789"
}
ManualAddressInput
Example
{
"addressLine1": "abc123",
"suburb": "xyz789",
"city": "xyz789",
"postCode": "xyz789",
"country": "abc123",
"administrativeArea": "abc123"
}
ManualAllocationPayment
Example
{
"id": 4,
"transactionDate": "2007-12-03T10:15:30Z",
"amount": Money,
"reference": "xyz789",
"particulars": "abc123",
"code": "xyz789",
"payerName": "xyz789",
"bankAccountNumber": "abc123"
}
ManualTask
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
created - DateTime!
|
|
updated - DateTime!
|
|
status - TaskStatus!
|
|
dueAt - DateTime
|
|
assignedAdmin - AdminUser
|
|
notes - [Note!]!
|
|
title - String!
|
|
associatedRecord - TaskAssociatedRecord
|
|
documents - [TaskDocument!]
|
Documents related to the task, added by an admin |
priority - TaskPriority
|
The priority of the task |
relatedTasks - [Task!]
|
|
assignedTeam - TaskAssignedTeam
|
Team that the task is assigned to |
Example
{
"id": "4",
"created": "2007-12-03T10:15:30Z",
"updated": "2007-12-03T10:15:30Z",
"status": "OPEN",
"dueAt": "2007-12-03T10:15:30Z",
"assignedAdmin": AdminUser,
"notes": [Note],
"title": "abc123",
"associatedRecord": Account,
"documents": [TaskDocument],
"priority": "NO_PRIORITY",
"relatedTasks": [Task],
"assignedTeam": "UNASSIGNED"
}
ManualTaskAssociatedInvestorProfileInput
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"ACCOUNT"
ManuallyVerifyAccountAddressInput
Fields
| Input Field | Description |
|---|---|
id - ID!
|
The ID of the account owner to manually verify address |
addressDocument - Upload!
|
|
autocompleteAddress - AutocompleteAddressInput
|
Either autocomplete or manual address is required |
manualAddress - ManualAddressInput
|
Example
{
"id": 4,
"addressDocument": Upload,
"autocompleteAddress": AutocompleteAddressInput,
"manualAddress": ManualAddressInput
}
ManuallyVerifyAccountIdentityInput
Fields
| Input Field | Description |
|---|---|
id - ID!
|
The ID of the account owner to manually verify identity |
identityDocuments - [Upload!]!
|
|
identityDocumentFields - IdentityDocumentFieldsInput
|
Example
{
"id": "4",
"identityDocuments": [Upload],
"identityDocumentFields": IdentityDocumentFieldsInput
}
ManuallyVerifyBeneficialOwnerAddressInput
Fields
| Input Field | Description |
|---|---|
id - ID!
|
The ID of the beneficial owner to manually verify address |
addressDocument - Upload!
|
|
autocompleteAddress - AutocompleteAddressInput
|
Either autocomplete or manual address is required |
manualAddress - ManualAddressInput
|
Example
{
"id": "4",
"addressDocument": Upload,
"autocompleteAddress": AutocompleteAddressInput,
"manualAddress": ManualAddressInput
}
ManuallyVerifyBeneficialOwnerIdentityInput
Fields
| Input Field | Description |
|---|---|
id - ID!
|
The ID of the beneficial owner to manually verify identity |
identityDocuments - [Upload!]!
|
|
identityDocumentFields - IdentityDocumentFieldsInput
|
Example
{
"id": "4",
"identityDocuments": [Upload],
"identityDocumentFields": IdentityDocumentFieldsInput
}
ModifyAccountAddressVerificationStatusInput
Fields
| Input Field | Description |
|---|---|
id - ID!
|
The ID of the address verification on which the status will be modified |
status - AddressVerificationStatusInput!
|
|
message - String
|
Message associated with the status |
Example
{
"id": "4",
"status": "APPROVED",
"message": "xyz789"
}
ModifyBeneficialOwnerAddressVerificationStatusInput
Fields
| Input Field | Description |
|---|---|
id - ID!
|
The ID of the address verification on which the status will be modified |
status - AddressVerificationStatusInput!
|
|
message - String
|
Message associated with the status |
Example
{
"id": 4,
"status": "APPROVED",
"message": "abc123"
}
Money
MoneySubUnit
Description
A scalar representing money in the smallest subunit of the currency (e.g. 150 cents, 1350 dirham).
It is always expected to be in the currency of the fund.
Example
MoneySubUnit
MoneyUnit
Description
A scalar representing money in the full unit of the currency (e.g. 1.50 USD, 1.350 LYD).
It is always expected to be in the currency of the fund.
Example
MoneyUnit
MutationPermission
Fields
| Field Name | Description |
|---|---|
mutation - String!
|
Example
{"mutation": "abc123"}
NZDVerifiableBankAccount
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
created - DateTime!
|
|
updated - DateTime!
|
|
name - String!
|
|
nickname - String!
|
|
currency - Currency!
|
|
isDefaultAccount - Boolean!
|
|
status - BankAccountStatus!
|
|
documents - [VerifiableDocument!]!
|
|
accountNumber - String!
|
|
investingEntity - InvestingEntity!
|
The investing entity that owns this bank account |
Example
{
"id": 4,
"created": "2007-12-03T10:15:30Z",
"updated": "2007-12-03T10:15:30Z",
"name": "xyz789",
"nickname": "abc123",
"currency": Currency,
"isDefaultAccount": false,
"status": "PENDING",
"documents": [VerifiableDocument],
"accountNumber": "12-3048-0295400-051",
"investingEntity": InvestingEntity
}
NZPrescribedInvestorRateBasisPoints
Description
PIR assigned to New Zealand-based Investing Entities, in basis points
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"UNSET"
NameOrAddressValidationDetail
NatureAndPurposeDetails
Fields
| Field Name | Description |
|---|---|
sourceOfFunds - SourceOfFunds!
|
|
frequencyOfInvestment - InvestingEntityFrequencyOfInvestment
|
|
availableFunds - InvestingEntityAvailableFunds
|
|
reasonForInvesting - InvestingEntityReasonForInvesting
|
Example
{
"sourceOfFunds": SourceOfFunds,
"frequencyOfInvestment": "ONE_OFF",
"availableFunds": "UNDER_50K",
"reasonForInvesting": "ONGOING_INCOME"
}
NewInvestmentSearchTransaction
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
amount - Money!
|
|
processedAt - DateTime
|
|
fund - Fund
|
|
investingEntity - InvestingEntity
|
|
unitPrice - Money!
|
|
status - SearchTransactionStatus!
|
|
source - NewInvestmentSearchTransactionSource!
|
|
unitClass - UnitClass
|
Unit class associated with the Transaction |
unitCountDecimal - FixedPointNumber
|
Example
{
"id": "4",
"amount": Money,
"processedAt": "2007-12-03T10:15:30Z",
"fund": Fund,
"investingEntity": InvestingEntity,
"unitPrice": Money,
"status": "WITHHELD",
"source": "ISSUE",
"unitClass": UnitClass,
"unitCountDecimal": FixedPointNumber
}
NewInvestmentSearchTransactionSource
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"ISSUE"
NonResidentWithholdingTaxRateBasisPoints
Description
NRWT assigned to Investing Entities, in basis points
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"RATE_0"
Note
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
created - DateTime!
|
The time the note was created |
message - String!
|
The contents of the note |
lastModifiedDetails - NoteLastModifiedDetails
|
Details about the most recent update of the note |
isPinned - Boolean
|
When true, the note is pinned for quick reference |
Example
{
"id": "4",
"created": "2007-12-03T10:15:30Z",
"message": "abc123",
"lastModifiedDetails": NoteLastModifiedDetails,
"isPinned": false
}
NoteActivityFeedItem
Example
{
"id": "4",
"updatedAt": "2007-12-03T10:15:30Z",
"note": Note
}
NoteAssociatedRecordFilter
Fields
| Input Field | Description |
|---|---|
id - ID!
|
ID of the associated record |
recordType - NoteAssociatedRecordType!
|
Type of the associated record |
isPinned - Boolean
|
If provided, will only return notes for the record with that pinned status |
Example
{
"id": "4",
"recordType": "ACCOUNT",
"isPinned": false
}
NoteAssociatedRecordType
Description
The associated records that search notes supports
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"ACCOUNT"
NoteEdge
NoteLastModifiedDetails
Description
Details about the last modification to a note
Fields
| Field Name | Description |
|---|---|
admin - AdminUser!
|
The admin user who last modified the note |
lastModified - DateTime!
|
The date and time the note was last modified |
Example
{
"admin": AdminUser,
"lastModified": "2007-12-03T10:15:30Z"
}
NoteSearchResults
Fields
| Field Name | Description |
|---|---|
edges - [NoteEdge!]!
|
|
pageInfo - PageInfo!
|
Example
{
"edges": [NoteEdge],
"pageInfo": PageInfo
}
NoteSearchSort
Fields
| Input Field | Description |
|---|---|
field - NoteSearchSortField!
|
The field to sort results by |
direction - SortDirection!
|
Direction to sort results in |
Example
{"field": "CREATED", "direction": "ASC"}
NoteSearchSortField
Values
| Enum Value | Description |
|---|---|
|
|
Example
"CREATED"
Notification
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
status - NotificationStatus!
|
|
created - DateTime!
|
Possible Types
| Notification Types |
|---|
Example
{
"id": "4",
"status": "INCOMPLETE",
"created": "2007-12-03T10:15:30Z"
}
NotificationStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"INCOMPLETE"
OffMarketTransferSearchTransaction
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
fund - Fund
|
|
unitCountDecimal - FixedPointNumber!
|
|
unitPrice - Money!
|
|
processedAt - DateTime
|
|
investingEntity - InvestingEntity
|
|
transactingInvestingEntity - InvestingEntity
|
|
amount - Money!
|
|
status - SearchTransactionStatus!
|
|
unitClass - UnitClass
|
Unit class associated with the Transaction |
Example
{
"id": "4",
"fund": Fund,
"unitCountDecimal": FixedPointNumber,
"unitPrice": Money,
"processedAt": "2007-12-03T10:15:30Z",
"investingEntity": InvestingEntity,
"transactingInvestingEntity": InvestingEntity,
"amount": Money,
"status": "WITHHELD",
"unitClass": UnitClass
}
Offer
Fields
| Field Name | Description |
|---|---|
capitalCallBatches - CapitalCallBatchConnection!
|
Query and return a paginated list of capital call batches for this offer |
Arguments
|
|
capitalCallBatch - CapitalCallBatch
|
|
Arguments
|
|
id - ID!
|
|
displayName - String
|
|
createdAt - DateTime
|
Date the offer was created |
updatedAt - DateTime
|
Date the offer was updated |
pricePerUnit - Money
|
The unit price of the offer in 2 decimal places. use pricePerUnitV2 |
pricePerUnitV2 - HighPrecisionMoney
|
The unit price of the offer in 6 decimal places. |
totalUnitCountDecimal - FixedPointNumber!
|
Total number of units in this offer |
minimumUnitCountDecimal - FixedPointNumber!
|
The minimum number of units in this offer an investor can make an allocation request for |
maximumUnitCountDecimal - FixedPointNumber!
|
The maximum number of units in this offer an investor can be allocated |
areUnitsIssued - Boolean!
|
|
status - OfferStatus!
|
|
openedAt - DateTime
|
Date and time that the Offer opened and allocation requests started becoming accepted |
closedAt - DateTime
|
Date and time that the offer closed |
fundsDeadline - DateTime
|
The date that funds are due |
settledAt - DateTime
|
The date that the offer is settled |
paymentReferencePrefix - String!
|
Payment reference prefix |
allocations - [Allocation]
|
use searchAllocations instead |
capitalizationTable - CapitalizationTable!
|
|
totalEquity - Money
|
The Total Equity of the offer rounded to 2 decimal places. use totalEquityV2 |
totalEquityV2 - HighPrecisionMoney
|
The Total Equity of the offer rounded to 2 decimal places. |
registrationsOfInterest - [RegistrationOfInterest!]!
|
|
fund - Fund!
|
|
depositMethods - [OfferDepositMethod!]!
|
Ordered list of deposit methods linked to this offer |
digitalSubscription - OfferDigitalSubscription!
|
Whether the offer is available for digital subscription |
slug - String
|
|
dataRoom - OfferDataRoom
|
|
unitClass - UnitClass
|
The unit class that is associated with this offer |
searchAllocations - AllocationSearchResults!
|
Query and return a paginated list of Allocations for this offer |
Arguments
|
|
Example
{
"capitalCallBatches": CapitalCallBatchConnection,
"capitalCallBatch": CapitalCallBatch,
"id": "4",
"displayName": "abc123",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"pricePerUnit": Money,
"pricePerUnitV2": HighPrecisionMoney,
"totalUnitCountDecimal": FixedPointNumber,
"minimumUnitCountDecimal": FixedPointNumber,
"maximumUnitCountDecimal": FixedPointNumber,
"areUnitsIssued": true,
"status": "OPEN",
"openedAt": "2007-12-03T10:15:30Z",
"closedAt": "2007-12-03T10:15:30Z",
"fundsDeadline": "2007-12-03T10:15:30Z",
"settledAt": "2007-12-03T10:15:30Z",
"paymentReferencePrefix": "xyz789",
"allocations": [Allocation],
"capitalizationTable": CapitalizationTable,
"totalEquity": Money,
"totalEquityV2": HighPrecisionMoney,
"registrationsOfInterest": [RegistrationOfInterest],
"fund": Fund,
"depositMethods": [OfferDepositMethod],
"digitalSubscription": "ENABLED",
"slug": "xyz789",
"dataRoom": OfferDataRoom,
"unitClass": UnitClass,
"searchAllocations": AllocationSearchResults
}
OfferActivityFeedItem
Possible Types
| OfferActivityFeedItem Types |
|---|
Example
{
"id": "4",
"updatedAt": "2007-12-03T10:15:30Z",
"offer": Offer
}
OfferDataRoom
Fields
| Field Name | Description |
|---|---|
subtitle - String
|
|
overview - String
|
|
details - [IndexedKeyValue!]
|
Key value pairs for the offer |
primaryDocument - RemoteAsset
|
|
image - RemoteAsset
|
|
videoUrl - URL
|
|
documents - [OfferDataRoomDocument!]!
|
|
content - [OfferDataRoomContentBlock!]!
|
|
access - OfferDataRoomAccess
|
Data room access |
selectedAccounts - [Account!]
|
If access is set to SELECTED_ACCOUNTS, this field will contain a list of accounts that have access to the data room |
Example
{
"subtitle": "abc123",
"overview": "abc123",
"details": [IndexedKeyValue],
"primaryDocument": RemoteAsset,
"image": RemoteAsset,
"videoUrl": "http://www.test.com/",
"documents": [OfferDataRoomDocument],
"content": [OfferDataRoomContentBlock],
"access": "HIDDEN",
"selectedAccounts": [Account]
}
OfferDataRoomAccess
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"HIDDEN"
OfferDataRoomContentBlock
Possible Types
| OfferDataRoomContentBlock Types |
|---|
Example
{
"id": "4",
"index": 987,
"title": "xyz789"
}
OfferDataRoomContentBlockOrderInput
OfferDataRoomDocument
Fields
| Field Name | Description |
|---|---|
index - Int!
|
|
document - OfferDocument!
|
Example
{"index": 123, "document": OfferDocument}
OfferDataRoomDocumentOrderInput
OfferDataRoomTableBlock
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
index - Int!
|
|
title - String!
|
|
rows - [OfferDataRoomTableBlockRow!]!
|
Example
{
"id": 4,
"index": 987,
"title": "xyz789",
"rows": [OfferDataRoomTableBlockRow]
}
OfferDataRoomTableBlockInput
Fields
| Input Field | Description |
|---|---|
title - String!
|
|
rows - [OfferDataRoomTableBlockRowInput!]!
|
Example
{
"title": "abc123",
"rows": [OfferDataRoomTableBlockRowInput]
}
OfferDataRoomTableBlockRow
OfferDataRoomTableBlockRowInput
OfferDataRoomTextBlock
OfferDataRoomTextBlockInput
OfferDepositMethod
Fields
| Field Name | Description |
|---|---|
depositMethod - DepositMethod!
|
The deposit method |
index - Int!
|
The index in the ordered list of deposit methods linked to the offer |
Example
{"depositMethod": DepositMethod, "index": 123}
OfferDigitalSubscription
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"ENABLED"
OfferDocument
Description
A Document associated with an Offer
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
updatedAt - DateTime!
|
|
file - RemoteAsset!
|
|
modifiedBy - AdminUser
|
|
publishDate - DateTime
|
|
name - String
|
Descriptive title of the Document |
category - OfferDocumentCategory
|
Category that the Document exists within |
Example
{
"id": 4,
"updatedAt": "2007-12-03T10:15:30Z",
"file": RemoteAsset,
"modifiedBy": AdminUser,
"publishDate": "2007-12-03T10:15:30Z",
"name": "abc123",
"category": OfferDocumentCategory
}
OfferDocumentCategory
OfferDocumentDownloadedActivityFeedItem
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
updatedAt - DateTime!
|
|
offer - Offer
|
|
document - OfferDocument!
|
Example
{
"id": "4",
"updatedAt": "2007-12-03T10:15:30Z",
"offer": Offer,
"document": OfferDocument
}
OfferStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
No longer used |
|
|
No longer used |
|
|
No longer used |
|
|
No longer used |
|
|
No longer used |
Example
"OPEN"
OfferViewedActivityFeedItem
OnfidoIdentityVerification
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
dateAttempted - DateTime!
|
|
status - VerifiableIdentityVerificationStatus!
|
|
verificationDocuments - [RemoteAsset!]!
|
|
identityDocumentDetails - IdentityDocumentFields
|
Example
{
"id": 4,
"dateAttempted": "2007-12-03T10:15:30Z",
"status": "VERIFIED",
"verificationDocuments": [RemoteAsset],
"identityDocumentDetails": IdentityDocumentFields
}
OptionalAddress
Fields
| Input Field | Description |
|---|---|
value - AddressInput
|
Example
{"value": AddressInput}
OptionalDateTime
Description
Input is ignored if it is not provided. Field will be updated to value if value is provided. Field will be cleared if value is nil.
Fields
| Input Field | Description |
|---|---|
value - DateTime
|
Example
{"value": "2007-12-03T10:15:30Z"}
OptionalID
Description
OptionalID not provided, will be ignored. OptionalID and value provided, will be treated as an update. OptionalID and no value provided, will be treated as a delete.
Fields
| Input Field | Description |
|---|---|
value - ID
|
Example
{"value": 4}
OptionalString
Fields
| Input Field | Description |
|---|---|
value - String
|
Example
{"value": "xyz789"}
OptionalUpload
Fields
| Input Field | Description |
|---|---|
value - Upload
|
Example
{"value": Upload}
Order
Types
| Union Types |
|---|
Example
Allocation
OrderAssociatedRecordFilter
Fields
| Input Field | Description |
|---|---|
id - ID!
|
ID of the associated record |
recordType - OrderAssociatedRecordType!
|
Type of the associated record |
Example
{"id": 4, "recordType": "INVESTING_ENTITY"}
OrderAssociatedRecordType
Description
The associated records that search orders supports
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"INVESTING_ENTITY"
OrderEdge
OrderSearchResults
Fields
| Field Name | Description |
|---|---|
edges - [OrderEdge!]!
|
|
pageInfo - PageInfo!
|
Example
{
"edges": [OrderEdge],
"pageInfo": PageInfo
}
OrderSearchSort
Fields
| Input Field | Description |
|---|---|
field - OrderSearchSortField!
|
The field to sort by uses the OrderSearchSortField enum defaults to CREATED |
direction - SortDirection!
|
Example
{"field": "CREATED", "direction": "ASC"}
OrderSearchSortField
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"CREATED"
OrderStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
replaced by APPROVED |
|
|
replaced by APPROVED |
Example
"REQUESTED"
OrderType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"ALLOCATION"
OtherDocumentActivityFeedItem
OtherNoteActivityFeedItem
PEPAssociate
PEPMatch
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
name - String!
|
|
associates - [PEPAssociate!]!
|
|
dateOfBirth - String
|
While these might be DateTime, we see non DateTime strings from Verifi from time to time. |
citizenship - Country
|
|
gender - String
|
|
confidence - Float!
|
|
images - [String!]!
|
Image URLs, note that these URLs may 404 |
notes - HTML
|
|
roles - [PEPMatchRole!]!
|
|
status - PEPMatchStatus!
|
|
transactionId - String!
|
|
checkedOn - DateTime!
|
|
statusUpdate - PEPMatchStatusUpdate
|
Example
{
"id": 4,
"name": "xyz789",
"associates": [PEPAssociate],
"dateOfBirth": "xyz789",
"citizenship": Country,
"gender": "xyz789",
"confidence": 987.65,
"images": ["abc123"],
"notes": HTML,
"roles": [PEPMatchRole],
"status": "PENDING",
"transactionId": "xyz789",
"checkedOn": "2007-12-03T10:15:30Z",
"statusUpdate": PEPMatchStatusUpdate
}
PEPMatchRole
Example
{
"from": "xyz789",
"to": "xyz789",
"title": "xyz789"
}
PEPMatchStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"PENDING"
PEPMatchStatusUpdate
Fields
| Field Name | Description |
|---|---|
user - AdminUser!
|
|
actionedAt - DateTime!
|
|
reason - String
|
Example
{
"user": AdminUser,
"actionedAt": "2007-12-03T10:15:30Z",
"reason": "xyz789"
}
PEPSearchResult
Fields
| Field Name | Description |
|---|---|
matches - [PEPMatch!]!
|
|
searchRanAt - DateTime
|
Example
{
"matches": [PEPMatch],
"searchRanAt": "2007-12-03T10:15:30Z"
}
PageInfo
PartnershipInvestingEntity
Fields
| Field Name | Description |
|---|---|
id - ID!
|
ID of the partnership investing entity |
name - String
|
Legal name of the partnership |
displayName - String
|
Display name of the partnership |
address - Address
|
Registered address of the partnership |
postalAddress - Address
|
Postal address for the partnership |
placeOfBusinessAddress - Address
|
Place of business for the partnership |
partnershipType - InvestingEntityPartnershipType
|
partnership type |
registrationNumber - String
|
Partnership Registration Number |
taxResidency - InvestingEntityTaxResidency
|
Tax residency details for the partnership |
nzPrescribedInvestorRate - NZPrescribedInvestorRateBasisPoints
|
NZ PIR |
nzPrescribedInvestorTaxDeclarationStatus - TaxDeclarationStatus
|
Declared status of the NZ PIR |
interestResidentWithholdingTax - ResidentWithholdingTaxRateBasisPoints
|
RWT rate on interest |
interestResidentWithholdingTaxDeclarationStatus - TaxDeclarationStatus
|
Declared status of the RWT |
nonResidentWithholdingTaxRate - NonResidentWithholdingTaxRateBasisPoints
|
NRWT rate on interest |
nonResidentWithholdingTaxDeclarationStatus - TaxDeclarationStatus
|
Declared status of the NRWT |
natureAndPurposeDetails - NatureAndPurposeDetails
|
Nature and purpose details for the partnership |
clientReferenceNumber - String
|
Client Reference Number for historical client references |
businessNumber - String
|
Business No. for reference |
paymentReference - String
|
Payment Reference for integration purposes use paymentReferences instead |
paymentReferences - [StaticPaymentReference!]!
|
References to be used by an investing entity when making payments |
Example
{
"id": 4,
"name": "abc123",
"displayName": "abc123",
"address": Address,
"postalAddress": Address,
"placeOfBusinessAddress": Address,
"partnershipType": "LIMITED_PARTNERSHIP",
"registrationNumber": "xyz789",
"taxResidency": InvestingEntityTaxResidency,
"nzPrescribedInvestorRate": "UNSET",
"nzPrescribedInvestorTaxDeclarationStatus": "DECLARED",
"interestResidentWithholdingTax": "RATE_0",
"interestResidentWithholdingTaxDeclarationStatus": "DECLARED",
"nonResidentWithholdingTaxRate": "RATE_0",
"nonResidentWithholdingTaxDeclarationStatus": "DECLARED",
"natureAndPurposeDetails": NatureAndPurposeDetails,
"clientReferenceNumber": "xyz789",
"businessNumber": "abc123",
"paymentReference": "xyz789",
"paymentReferences": [BankPaymentReference]
}
PassbaseIdentityVerification
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
dateAttempted - DateTime!
|
|
status - VerifiableIdentityVerificationStatus!
|
|
identityDocumentDetails - IdentityDocumentFields
|
|
passbaseUrl - URL!
|
Example
{
"id": "4",
"dateAttempted": "2007-12-03T10:15:30Z",
"status": "VERIFIED",
"identityDocumentDetails": IdentityDocumentFields,
"passbaseUrl": "http://www.test.com/"
}
PayWithheldDistributionsInput
Fields
| Input Field | Description |
|---|---|
holdingID - ID!
|
Example
{"holdingID": "4"}
PaymentBankAccount
Fields
| Input Field | Description |
|---|---|
bankAccountInput - BankAccountInput
|
Example
{"bankAccountInput": BankAccountInput}
PaymentMethod
Types
| Union Types |
|---|
Example
BankAccountV2
PaymentMethodInput
Description
Provide exactly one bank account / cheque / BPAY
Fields
| Input Field | Description |
|---|---|
bankAccount - BankAccountInput
|
|
cheque - ChequeInput
|
|
bpay - BpayInput
|
Example
{
"bankAccount": BankAccountInput,
"cheque": ChequeInput,
"bpay": BpayInput
}
PaymentReference
Description
Represents a payment reference for an investor, which can be used to identify payments made by the investor.
Possible Types
| PaymentReference Types |
|---|
Example
{
"id": "4",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z"
}
PercentageDistributionComponent
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
unitClass - UnitClass
|
Unit class that the component is for |
percentage - Float!
|
Amount of the component |
taxWithholdingMethod - TaxWithholdingMethod!
|
Method used to withhold tax for the component |
componentType - DistributionComponentType!
|
Type of the component |
label - String
|
Label for the component (optional) |
Example
{
"id": "4",
"unitClass": UnitClass,
"percentage": 123.45,
"taxWithholdingMethod": "NONE",
"componentType": "DIVIDENDS",
"label": "abc123"
}
PercentageDistributionComponentInput
Fields
| Input Field | Description |
|---|---|
percentage - Float!
|
|
taxWithholdingMethod - TaxWithholdingMethod!
|
Example
{"percentage": 123.45, "taxWithholdingMethod": "NONE"}
PeriodicStatementConfig
Fields
| Field Name | Description |
|---|---|
type - PeriodicStatementType!
|
The type of the statements. |
category - DocumentCategoryV2!
|
The category of the statements. |
recipients - PeriodicStatementRecipients!
|
The recipients of the statements. |
period - DateRange!
|
The period for the statement. |
commentary - String
|
The commentary added to the statement. |
Example
{
"type": "INVESTOR_PERIODIC",
"category": "AUTHORITY",
"recipients": PeriodicStatementRecipients,
"period": DateRange,
"commentary": "xyz789"
}
PeriodicStatementConfigInput
Fields
| Input Field | Description |
|---|---|
name - String!
|
Name of the batch of statements. |
type - PeriodicStatementType!
|
Type of statement to create. |
recipients - PeriodicStatementRecipientsInput!
|
The recipients of the statement. |
period - DateRangeInput!
|
The period for the statement. |
publishAt - DateTime
|
The date the statement is scheduled to be published. |
commentary - String
|
A comment to include with the statement. |
Example
{
"name": "xyz789",
"type": "INVESTOR_PERIODIC",
"recipients": PeriodicStatementRecipientsInput,
"period": DateRangeInput,
"publishAt": "2007-12-03T10:15:30Z",
"commentary": "abc123"
}
PeriodicStatementRecipients
Description
Recipients filter for batch generation of statements for periodic statements.
Fields
| Field Name | Description |
|---|---|
investingEntities - [InvestingEntity!]
|
Selected investing entities for the batch. |
fund - Fund!
|
Selected fund for the periodic statement. |
Example
{
"investingEntities": [InvestingEntity],
"fund": Fund
}
PeriodicStatementRecipientsInput
Description
Input for configuring recipients of a batch of periodic statements.
Example
{"investingEntityIds": [4], "fundId": "4"}
PeriodicStatementType
Description
The different types of periodic statements that can be generated.
Values
| Enum Value | Description |
|---|---|
|
|
Example
"INVESTOR_PERIODIC"
Permission
Description
Represents a permission to do certain actions in the system
Example
{
"id": 4,
"identifier": "xyz789",
"description": "xyz789"
}
Permissions
Fields
| Field Name | Description |
|---|---|
mutationPermissions - [MutationPermission!]!
|
|
typePermissions - [TypePermission!]!
|
Example
{
"mutationPermissions": [MutationPermission],
"typePermissions": [TypePermission]
}
PhoneNumber
PhoneNumberInput
PlaceAddress
Fields
| Field Name | Description |
|---|---|
line1 - String
|
Only present on ADDRESS queries |
suburb - String
|
Only present on ADDRESS queries |
postCode - String
|
Only present on ADDRESS queries |
city - String!
|
|
country - String!
|
|
description - String!
|
The human-readable name for this place address |
administrativeArea - String
|
Administrative area of the address (e.g. state, province, region). Only present on ADDRESS queries |
Example
{
"line1": "abc123",
"suburb": "xyz789",
"postCode": "xyz789",
"city": "xyz789",
"country": "xyz789",
"description": "abc123",
"administrativeArea": "abc123"
}
PlaceOfBirth
PortfolioGraphConfig
Description
Configuration for the graph on the portfolio page
Fields
| Field Name | Description |
|---|---|
type - PortfolioGraphType!
|
The graph to configure |
isEnabled - Boolean!
|
Whether the graph is visible to the investor |
Example
{"type": "ALLOCATION", "isEnabled": false}
PortfolioGraphConfigInput
Description
Input for configuring the graph on the portfolio page
Fields
| Input Field | Description |
|---|---|
type - PortfolioGraphType!
|
The graph to configure |
isEnabled - Boolean!
|
Whether the graph is visible to the investor |
Example
{"type": "ALLOCATION", "isEnabled": false}
PortfolioGraphType
Description
Graphs on the investor portal portfolio page
Values
| Enum Value | Description |
|---|---|
|
|
Displays the investor's holdings and amount allocated to each. |
|
|
Displays total amount distributed across all holdings at various points since inception. |
|
|
Displays total value of all holdings at various points since inception. |
|
|
Displays capital contributed vs. capital committed across all holdings. |
|
|
Displays total amount distributed across all holdings in each of the last six months |
Example
"ALLOCATION"
PortfolioKeyMetricConfig
Description
Configuration for the default key metric on the portfolio page
Fields
| Field Name | Description |
|---|---|
type - PortfolioKeyMetricType!
|
The key metric to configure |
isEnabled - Boolean!
|
Whether the key metric is visible to the investor |
Example
{"type": "INVESTED_SINCE", "isEnabled": false}
PortfolioKeyMetricConfigInput
Description
Input for configuring the key metric on the portfolio page
Fields
| Input Field | Description |
|---|---|
type - PortfolioKeyMetricType!
|
The key metric to configure |
isEnabled - Boolean!
|
Whether the key metric is visible to the investor |
Example
{"type": "INVESTED_SINCE", "isEnabled": true}
PortfolioKeyMetricType
Description
Default key metrics on the investor portal portfolio page
Values
| Enum Value | Description |
|---|---|
|
|
The date that the first units were issued to the investing entity across all holdings. |
|
|
The total number of holdings the investing entity has had since inception including all active, sold and completed holdings. |
|
|
The total number of active holdings the investing entity currently has. |
|
|
The total amount of capital committed across all holdings. |
|
|
The total amount of capital deployed to acquire units across all holdings. |
|
|
The total amount of capital returned to investors across all holdings. |
|
|
The total amount of income returned to investors across all holdings. |
|
|
The remaining capital across all holdings. |
|
|
The total estimated value of all holdings. |
|
|
The total capital gain/loss across all holdings. |
|
|
The date of the most recent distribution across all holdings. |
Example
"INVESTED_SINCE"
PortfolioTableConfig
Description
Configuration for the table on the portfolio page
Fields
| Field Name | Description |
|---|---|
type - PortfolioTableType!
|
The table to configure |
isEnabled - Boolean!
|
Whether the table is visible to the investor |
Example
{"type": "HOLDINGS", "isEnabled": true}
PortfolioTableConfigInput
Description
Input for configuring the table on the portfolio page
Fields
| Input Field | Description |
|---|---|
type - PortfolioTableType!
|
The table to configure |
isEnabled - Boolean!
|
Whether the table is visible to the investor |
Example
{"type": "HOLDINGS", "isEnabled": false}
PortfolioTableType
Description
Tables on the investor portal portfolio page
Values
| Enum Value | Description |
|---|---|
|
|
Example
"HOLDINGS"
Prospect
Description
Information about a prospective account
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
created - DateTime!
|
|
email - String!
|
|
firstName - String!
|
|
middleName - String
|
|
lastName - String!
|
|
preferredName - String
|
|
dateOfBirth - DayMonthYear
|
|
address - Address
|
|
phoneNumber - PhoneNumber
|
|
jobTitle - String
|
|
industry - String
|
|
organization - String
|
|
twitterProfileUrl - URL
|
|
linkedInProfileUrl - URL
|
|
biography - String
|
|
searchActivityFeed - ActivityFeedResults!
|
|
Arguments |
|
tagsV2 - [InvestorProfileTag!]
|
|
connections - [Connection!]
|
|
outstandingTasks - [Task!]
|
|
Example
{
"id": "4",
"created": "2007-12-03T10:15:30Z",
"email": "xyz789",
"firstName": "xyz789",
"middleName": "abc123",
"lastName": "xyz789",
"preferredName": "xyz789",
"dateOfBirth": DayMonthYear,
"address": Address,
"phoneNumber": PhoneNumber,
"jobTitle": "xyz789",
"industry": "abc123",
"organization": "xyz789",
"twitterProfileUrl": "http://www.test.com/",
"linkedInProfileUrl": "http://www.test.com/",
"biography": "xyz789",
"searchActivityFeed": ActivityFeedResults,
"tagsV2": [InvestorProfileTag],
"connections": [Connection],
"outstandingTasks": [Task]
}
ProvideBeneficialOwnerContactDetailsNotification
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
status - NotificationStatus!
|
|
created - DateTime!
|
Example
{
"id": 4,
"status": "INCOMPLETE",
"created": "2007-12-03T10:15:30Z"
}
ProvideCityOfBirthNotification
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
status - NotificationStatus!
|
|
created - DateTime!
|
Example
{
"id": "4",
"status": "INCOMPLETE",
"created": "2007-12-03T10:15:30Z"
}
ProvideInvestingEntityDocumentsNotification
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
status - NotificationStatus!
|
|
created - DateTime!
|
Example
{
"id": "4",
"status": "INCOMPLETE",
"created": "2007-12-03T10:15:30Z"
}
ProvideSourceOfFundsNotification
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
status - NotificationStatus!
|
|
created - DateTime!
|
Example
{
"id": 4,
"status": "INCOMPLETE",
"created": "2007-12-03T10:15:30Z"
}
PublishStatementBatchInput
Description
Input for publishing a batch of statements.
Example
{
"publishAt": "2007-12-03T10:15:30Z",
"notificationsEnabled": true,
"portalEnabled": true
}
ReInvestmentSearchTransaction
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
amount - Money!
|
|
processedAt - DateTime
|
|
fund - Fund
|
|
investingEntity - InvestingEntity
|
|
unitCount - Int!
|
Use unitCountDecimal instead |
unitCountDecimal - FixedPointNumber!
|
|
unitPrice - Money!
|
|
status - SearchTransactionStatus!
|
|
unitClass - UnitClass
|
Unit class associated with the Transaction |
Example
{
"id": "4",
"amount": Money,
"processedAt": "2007-12-03T10:15:30Z",
"fund": Fund,
"investingEntity": InvestingEntity,
"unitCount": 987,
"unitCountDecimal": FixedPointNumber,
"unitPrice": Money,
"status": "WITHHELD",
"unitClass": UnitClass
}
ReattemptConfirmAccreditationNotification
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
status - NotificationStatus!
|
|
created - DateTime!
|
Example
{
"id": 4,
"status": "INCOMPLETE",
"created": "2007-12-03T10:15:30Z"
}
ReattemptProvideSourceOfFundsNotification
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
status - NotificationStatus!
|
|
created - DateTime!
|
Example
{
"id": 4,
"status": "INCOMPLETE",
"created": "2007-12-03T10:15:30Z"
}
ReattemptVerifyAddressNotification
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
status - NotificationStatus!
|
|
created - DateTime!
|
Example
{
"id": "4",
"status": "INCOMPLETE",
"created": "2007-12-03T10:15:30Z"
}
ReattemptVerifyBiometricIdentityNotification
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
status - NotificationStatus!
|
|
created - DateTime!
|
Example
{
"id": 4,
"status": "INCOMPLETE",
"created": "2007-12-03T10:15:30Z"
}
ReconcileDepositInput
Description
Reconcile a deposit against an allocation
Example
{
"id": 4,
"allocationId": "4",
"notifyByEmail": true
}
RedemptionSearchTransaction
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
fund - Fund
|
|
unitCountDecimal - FixedPointNumber!
|
|
unitPrice - Money!
|
|
processedAt - DateTime
|
|
investingEntity - InvestingEntity
|
|
amount - Money!
|
|
status - SearchTransactionStatus!
|
|
unitClass - UnitClass
|
Unit class associated with the Transaction |
Example
{
"id": 4,
"fund": Fund,
"unitCountDecimal": FixedPointNumber,
"unitPrice": Money,
"processedAt": "2007-12-03T10:15:30Z",
"investingEntity": InvestingEntity,
"amount": Money,
"status": "WITHHELD",
"unitClass": UnitClass
}
RegistrationOfInterest
Description
Deprecated: Registration of Interest will be merged into Allocation A registration of interest for an offer
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The ID of registration of interest |
created - DateTime!
|
The time at which the registration of interest was submitted |
status - RegistrationOfInterestStatus!
|
The current status of the registration of interest |
interestedParty - InvestorProfile!
|
The account or prospect which registered interest |
offer - Offer!
|
The offer the interest is registered against |
unitCount - Int!
|
The number of units indicated |
unitPrice - Money!
|
The price per unit in the offer currency |
ownershipPercentage - String
|
The ownership indicated |
amount - Money!
|
The value of the indicated units in the offer currency |
note - String
|
The note on the registration of interest |
Example
{
"id": 4,
"created": "2007-12-03T10:15:30Z",
"status": "INTERESTED",
"interestedParty": Account,
"offer": Offer,
"unitCount": 123,
"unitPrice": Money,
"ownershipPercentage": "xyz789",
"amount": Money,
"note": "xyz789"
}
RegistrationOfInterestStatus
Description
Deprecated: Registration of Interest will be merged into Allocation
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"INTERESTED"
RemoteAsset
Example
{
"id": "4",
"created": "2007-12-03T10:15:30Z",
"name": "abc123",
"fileName": "xyz789",
"index": 123,
"url": "abc123",
"contentType": "xyz789",
"size": 987
}
RemoveInvestingEntityAccountLinkInput
RemoveRelatedTasksInput
RenewAccreditationNotification
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
status - NotificationStatus!
|
|
created - DateTime!
|
Example
{
"id": 4,
"status": "INCOMPLETE",
"created": "2007-12-03T10:15:30Z"
}
RenewAustralianAccreditationNotification
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
status - NotificationStatus!
|
|
created - DateTime!
|
Example
{
"id": 4,
"status": "INCOMPLETE",
"created": "2007-12-03T10:15:30Z"
}
RenewNewZealandAccreditationNotification
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
status - NotificationStatus!
|
|
created - DateTime!
|
Example
{
"id": 4,
"status": "INCOMPLETE",
"created": "2007-12-03T10:15:30Z"
}
Reports
Fields
| Field Name | Description |
|---|---|
allAccountsCSVUrl - String!
|
Returns csv url for all accounts report |
allInvestingEntitiesCSVUrl - String!
|
Returns csv url for all investing entities report |
allInvestorPortalActivitiesCSVUrl - String!
|
Returns csv url for all investor portal activities report |
allHoldingsMovementCSVUrl - String!
|
Returns csv url for all holdings movement report for a given period |
allHoldingsCSVUrl - String!
|
Returns csv url for all holdings report from a given period |
Arguments
|
|
allAllocationsCSVUrl - String!
|
Returns csv url for all allocations report |
allPepChecksCSVUrl - String!
|
Returns csv url for all pep checks report for a given period |
allInvestorLifetimeValueCSVUrl - String!
|
Returns csv url for investor LTV report for a given period |
allDepositsReportCSVUrl - String!
|
Returns csv url for all deposits report for a given period |
identityDuplicatesCSVUrl - String!
|
Returns csv url for identity duplicates report |
fundHoldingsCSVUrl - String!
|
Returns csv url for fund holdings report from a given period |
fundHoldingsMovementCSVUrl - String!
|
Returns csv url for fund holdings movement report |
Arguments
|
|
offerAllocationRequestsCSVUrl - String!
|
Returns csv url for offer allocations report |
Arguments
|
|
operationsCSVUrl - String!
|
Returns csv url for operations report for a given period |
apportionmentCSVUrl - String!
|
Returns csv url for apportionment report for a given period |
fundUnitRedemptionsCSVUrl - String!
|
Returns csv url for all redemptions report for a given period and fund |
allTasksReportCSVUrl - String!
|
Returns csv url for all tasks report for a given period |
Example
{
"allAccountsCSVUrl": "abc123",
"allInvestingEntitiesCSVUrl": "abc123",
"allInvestorPortalActivitiesCSVUrl": "xyz789",
"allHoldingsMovementCSVUrl": "abc123",
"allHoldingsCSVUrl": "abc123",
"allAllocationsCSVUrl": "abc123",
"allPepChecksCSVUrl": "abc123",
"allInvestorLifetimeValueCSVUrl": "xyz789",
"allDepositsReportCSVUrl": "xyz789",
"identityDuplicatesCSVUrl": "xyz789",
"fundHoldingsCSVUrl": "xyz789",
"fundHoldingsMovementCSVUrl": "abc123",
"offerAllocationRequestsCSVUrl": "xyz789",
"operationsCSVUrl": "xyz789",
"apportionmentCSVUrl": "abc123",
"fundUnitRedemptionsCSVUrl": "xyz789",
"allTasksReportCSVUrl": "xyz789"
}
RequestAccountIdentityVerificationInput
RequestBeneficialOwnerVerificationInput
RequestBeneficialOwnersContactDetailsInput
Fields
| Input Field | Description |
|---|---|
id - ID!
|
ID of the investing entity to request details |
Example
{"id": 4}
RequestWholesaleCertificationInput
ResidentWithholdingTaxRateBasisPoints
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"RATE_0"
RiskProfile
RiskProfileDocumentActivityFeedItem
RiskProfileNoteActivityFeedItem
Role
Description
Represents a role in the system with associated permissions
Fields
| Field Name | Description |
|---|---|
id - ID!
|
ID of the role |
sequence - Int!
|
A sequence number for ordering roles |
name - String!
|
Human readable name of the role |
description - String
|
Description of the role |
systemRole - Boolean!
|
Whether this role is a system role (cannot be deleted) |
permissions - [Permission!]!
|
List of permissions associated with this role |
Example
{
"id": "4",
"sequence": 987,
"name": "xyz789",
"description": "abc123",
"systemRole": true,
"permissions": [Permission]
}
SaveEmailBatchTemplateInput
Description
Input for saving or updating the email template content for a batch.
Example
{
"batchId": 4,
"subjectTemplate": "xyz789",
"bodyTemplate": "abc123"
}
SaveEmailBatchTemplateResponse
Types
| Union Types |
|---|
Example
EmailBatch
SearchAllocationCapitalCalledFilter
Description
The different types supported for filtering allocations by capital called
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"NONE"
SearchAllocationCapitalContributedFilter
Description
The different types supported for filtering allocations by capital contributed
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"NONE"
SearchAllocationFilter
Description
Input for filtering allocations when searching
Fields
| Input Field | Description |
|---|---|
statuses - [AllocationStatus!]
|
Filter by status |
unitsIssued - [SearchAllocationUnitsIssuedFilter!]
|
Filter by units issued |
capitalContributed - [SearchAllocationCapitalContributedFilter!]
|
Filter by capital contributed |
capitalCalled - [SearchAllocationCapitalCalledFilter!]
|
Filter by capital called |
Example
{
"statuses": ["INTERESTED"],
"unitsIssued": ["NONE"],
"capitalContributed": ["NONE"],
"capitalCalled": ["NONE"]
}
SearchAllocationSort
Description
Input for sorting allocations when searching
Fields
| Input Field | Description |
|---|---|
field - SearchAllocationSortField!
|
|
direction - SortDirection!
|
Example
{"field": "CREATED", "direction": "ASC"}
SearchAllocationSortField
Description
The fields that can be sorted by when searching allocations
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"CREATED"
SearchAllocationUnitsIssuedFilter
Description
The different types supported for filtering allocations by units issued
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"NONE"
SearchTransaction
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
amount - Money!
|
|
processedAt - DateTime
|
|
fund - Fund
|
|
investingEntity - InvestingEntity
|
|
status - SearchTransactionStatus!
|
|
unitClass - UnitClass
|
Unit class associated with the Transaction |
Possible Types
| SearchTransaction Types |
|---|
Example
{
"id": 4,
"amount": Money,
"processedAt": "2007-12-03T10:15:30Z",
"fund": Fund,
"investingEntity": InvestingEntity,
"status": "WITHHELD",
"unitClass": UnitClass
}
SearchTransactionEdge
Fields
| Field Name | Description |
|---|---|
cursor - String!
|
|
node - SearchTransaction!
|
Example
{
"cursor": "abc123",
"node": SearchTransaction
}
SearchTransactionStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"WITHHELD"
SearchTransactionType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NEW_INVESTMENT"
SearchTransactionsResults
Fields
| Field Name | Description |
|---|---|
edges - [SearchTransactionEdge!]!
|
|
pageInfo - PageInfo!
|
Example
{
"edges": [SearchTransactionEdge],
"pageInfo": PageInfo
}
SecondaryMarket
Fields
| Field Name | Description |
|---|---|
status - SecondaryMarketStatus!
|
|
fees - Fraction!
|
Example
{"status": "OPEN", "fees": Fraction}
SecondaryMarketFee
Types
| Union Types |
|---|
Example
SecondaryMarketFlatFee
SecondaryMarketFlatFee
Fields
| Field Name | Description |
|---|---|
amount - Money!
|
Example
{"amount": Money}
SecondaryMarketPercentageFee
SecondaryMarketStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"OPEN"
SecondaryUnitPurchaseSearchTransaction
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
fund - Fund
|
|
unitCount - Int!
|
|
unitCountDecimal - FixedPointNumber!
|
|
unitPrice - Money!
|
|
investingEntity - InvestingEntity
|
|
processedAt - DateTime
|
|
amount - Money!
|
|
status - SearchTransactionStatus!
|
|
unitClass - UnitClass
|
Unit class associated with the Transaction |
Example
{
"id": 4,
"fund": Fund,
"unitCount": 987,
"unitCountDecimal": FixedPointNumber,
"unitPrice": Money,
"investingEntity": InvestingEntity,
"processedAt": "2007-12-03T10:15:30Z",
"amount": Money,
"status": "WITHHELD",
"unitClass": UnitClass
}
SecondaryUnitSaleSearchTransaction
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
fund - Fund
|
|
unitCount - Int!
|
|
unitCountDecimal - FixedPointNumber!
|
|
unitPrice - Money!
|
|
processedAt - DateTime
|
|
investingEntity - InvestingEntity
|
|
amount - Money!
|
|
status - SearchTransactionStatus!
|
|
fees - Money
|
|
unitClass - UnitClass
|
Unit class associated with the Transaction |
Example
{
"id": 4,
"fund": Fund,
"unitCount": 987,
"unitCountDecimal": FixedPointNumber,
"unitPrice": Money,
"processedAt": "2007-12-03T10:15:30Z",
"investingEntity": InvestingEntity,
"amount": Money,
"status": "WITHHELD",
"fees": Money,
"unitClass": UnitClass
}
SellOrder
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
dateReceived - DateTime!
|
|
status - SellOrderStatus!
|
|
unitCount - Int!
|
Use unitCountDecimal instead |
unitCountDecimal - FixedPointNumber!
|
|
unitAskPrice - Money!
|
|
holding - Holding!
|
|
orderValue - Money!
|
|
netProceeds - Money!
|
|
fees - SecondaryMarketFee!
|
|
buyOrders - [BuyOrder!]
|
|
note - Note!
|
Example
{
"id": 4,
"dateReceived": "2007-12-03T10:15:30Z",
"status": "REQUESTED",
"unitCount": 123,
"unitCountDecimal": FixedPointNumber,
"unitAskPrice": Money,
"holding": Holding,
"orderValue": Money,
"netProceeds": Money,
"fees": SecondaryMarketFlatFee,
"buyOrders": [BuyOrder],
"note": Note
}
SellOrderStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"REQUESTED"
SendEmailAddressConfirmationInput
Fields
| Input Field | Description |
|---|---|
accountId - ID!
|
Example
{"accountId": "4"}
SendGridEmailActivityFeedItem
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
updatedAt - DateTime!
|
|
emailSubject - String!
|
|
userAgent - String!
|
|
ipAddress - String!
|
Possible Types
| SendGridEmailActivityFeedItem Types |
|---|
Example
{
"id": "4",
"updatedAt": "2007-12-03T10:15:30Z",
"emailSubject": "abc123",
"userAgent": "abc123",
"ipAddress": "xyz789"
}
SendGridEmailClickedActivityFeedItem
SendGridEmailOpenedActivityFeedItem
SendPasswordResetEmailInput
Fields
| Input Field | Description |
|---|---|
accountId - ID!
|
Example
{"accountId": 4}
SendSetPasswordEmailInput
Fields
| Input Field | Description |
|---|---|
id - ID!
|
The ID of the account to send the set password email for |
Example
{"id": "4"}
SortDirection
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"ASC"
SourceOfFunds
Fields
| Field Name | Description |
|---|---|
documents - [Document!]!
|
|
source - SourceOfFundsSource
|
|
supportingInformation - String
|
Explains how the most recently submitted document(s) provided confirms the source of funds. null info not provided yet, or source of funds completed before this feature. |
hasRequestedVerification - Boolean!
|
Example
{
"documents": [Document],
"source": "BUSINESS_INCOME",
"supportingInformation": "abc123",
"hasRequestedVerification": false
}
SourceOfFundsDocumentActivityFeedItem
SourceOfFundsSource
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
This is synonymous to Sale of Asset |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"BUSINESS_INCOME"
SourceOfFundsVerificationStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"COMPLETE"
Statement
Description
A statement represents a document that is generated for a specific target.
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The ID of the statement. |
createdAt - DateTime!
|
The date the batch was created. |
status - StatementStatus!
|
The status of the statement. |
recipient - StatementRecipient!
|
The recipient of the statement. |
resourceUrl - String!
|
The download url for the statement resource. |
Example
{
"id": "4",
"createdAt": "2007-12-03T10:15:30Z",
"status": "GENERATING",
"recipient": InvestingEntity,
"resourceUrl": "abc123"
}
StatementBatch
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The ID of the batch. |
name - String!
|
Name of the batch. |
createdAt - DateTime!
|
The date the batch was created. |
status - StatementStatus!
|
The status of the batch. |
noData - Boolean!
|
Whether the batch has no data. |
configuration - StatementConfig!
|
Information about the batch's configuration. |
generation - StatementGeneration!
|
Information about the batch's generation step. |
enrichment - StatementEnrichment
|
Information about the batch's enrichment step. |
confirmation - StatementConfirmation
|
Information about the batch's confirmation step. |
publication - StatementPublication
|
Information about the batch's publication step. |
numberOfStatements - Int!
|
Number of statements in the batch. |
statements - StatementConnection!
|
A paginated list of statements in the batch. |
Example
{
"id": "4",
"name": "xyz789",
"createdAt": "2007-12-03T10:15:30Z",
"status": "GENERATING",
"noData": true,
"configuration": InvestorStatementConfig,
"generation": StatementGeneration,
"enrichment": StatementEnrichment,
"confirmation": StatementConfirmation,
"publication": StatementPublication,
"numberOfStatements": 123,
"statements": StatementConnection
}
StatementBatchConnection
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
|
edges - [StatementBatchEdge!]!
|
Example
{
"pageInfo": PageInfo,
"edges": [StatementBatchEdge]
}
StatementBatchEdge
Fields
| Field Name | Description |
|---|---|
cursor - Cursor!
|
|
node - StatementBatch!
|
Example
{
"cursor": Cursor,
"node": StatementBatch
}
StatementConfig
Description
The different configurations for generating statements.
Example
InvestorStatementConfig
StatementConfirmation
Description
All information about the confirmation of a batch of statements.
Fields
| Field Name | Description |
|---|---|
confirmedAt - DateTime!
|
The date the batch was confirmed. |
confirmedBy - AdminUser!
|
The admin user that confirmed the batch. |
Example
{
"confirmedAt": "2007-12-03T10:15:30Z",
"confirmedBy": AdminUser
}
StatementConnection
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
|
edges - [StatementEdge!]!
|
Example
{
"pageInfo": PageInfo,
"edges": [StatementEdge]
}
StatementEdge
Fields
| Field Name | Description |
|---|---|
cursor - Cursor!
|
|
node - Statement!
|
Example
{
"cursor": Cursor,
"node": Statement
}
StatementEnrichment
Description
Information about the provided CSV data used for enrichment of a batch of statements.
Example
{
"csvTemplateDataResourceUrl": "xyz789",
"csvEnrichedDataResourceUrl": "abc123",
"csvDataValidationErrors": ["xyz789"]
}
StatementGeneration
Description
All information about the generation of a batch of statements.
Fields
| Field Name | Description |
|---|---|
generatedAt - DateTime!
|
The date the batch was last generated. |
Example
{"generatedAt": "2007-12-03T10:15:30Z"}
StatementPublication
Description
All information about the publication of a batch of statements.
Example
{
"publishedAt": "2007-12-03T10:15:30Z",
"notificationsEnabled": true,
"portalEnabled": false
}
StatementRecipient
Description
Recipient of a statement.
Types
| Union Types |
|---|
Example
InvestingEntity
StatementStatus
Description
The status of a batch of statements or a single statement.
Values
| Enum Value | Description |
|---|---|
|
|
The batch is currently being generated. |
|
|
The statement batch needs an uploaded CSV from the user with additional data |
|
|
The statement batch is currently checking an uploaded CSV file. |
|
|
The statement batch has been generated and is ready for confirmation. |
|
|
The batch is currently being confirmed. |
|
|
The batch has been confirmed and is ready for publication. |
|
|
The batch generation failed. |
|
|
No data was found for the batch. This is being replaced by the no data flag |
Example
"GENERATING"
StaticPaymentReference
Description
Represents a union of payment references that can be used by an investor.
Types
| Union Types |
|---|
Example
BankPaymentReference
StaticPaymentReferenceType
Description
Static payment reference for an investing entity
Values
| Enum Value | Description |
|---|---|
|
|
Static payment reference for BPAY payments |
Example
"BPAY"
StepStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NOT_ACTIONABLE_NO_INFORMATION"
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
"abc123"
SystemTask
Description
A system generated task, used for compliance or order management.
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
category - SystemTaskCategory!
|
|
title - String!
|
|
created - DateTime!
|
|
updated - DateTime!
|
|
status - TaskStatus!
|
|
dueAt - DateTime
|
|
assignedAdmin - AdminUser
|
|
notes - [Note!]!
|
|
type - TaskType!
|
The type of task |
pathSegments - [TaskPathSegment!]!
|
The relevant IDs to the task |
associatedRecord - TaskAssociatedRecord
|
|
documents - [TaskDocument!]
|
|
priority - TaskPriority
|
|
relatedTasks - [Task!]
|
|
assignedTeam - TaskAssignedTeam
|
Team that the task is assigned to |
Example
{
"id": 4,
"category": "COMPLIANCE",
"title": "xyz789",
"created": "2007-12-03T10:15:30Z",
"updated": "2007-12-03T10:15:30Z",
"status": "OPEN",
"dueAt": "2007-12-03T10:15:30Z",
"assignedAdmin": AdminUser,
"notes": [Note],
"type": "ACCOUNT_VERIFY_ADDRESS_DOCUMENT",
"pathSegments": [TaskPathSegment],
"associatedRecord": Account,
"documents": [TaskDocument],
"priority": "NO_PRIORITY",
"relatedTasks": [Task],
"assignedTeam": "UNASSIGNED"
}
SystemTaskCategory
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"COMPLIANCE"
TagAssociationType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"INVESTOR_PROFILE"
TagV2
Types
| Union Types |
|---|
Example
InvestingEntityTag
Task
Description
A task for the admin to complete
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
title - String!
|
The title of the task |
created - DateTime!
|
Date task was created |
updated - DateTime!
|
Date task was updated |
dueAt - DateTime
|
Date when the task should be completed by - becomes 'overdue' after this time |
status - TaskStatus!
|
Current status of this task |
assignedAdmin - AdminUser
|
Admin user who is assigned to this task |
notes - [Note!]!
|
|
documents - [TaskDocument!]
|
Documents related to the task, added by an admin |
priority - TaskPriority
|
The priority of the task |
relatedTasks - [Task!]
|
The tasks related to this task |
assignedTeam - TaskAssignedTeam
|
Team that the task is assigned to |
Possible Types
| Task Types |
|---|
Example
{
"id": 4,
"title": "abc123",
"created": "2007-12-03T10:15:30Z",
"updated": "2007-12-03T10:15:30Z",
"dueAt": "2007-12-03T10:15:30Z",
"status": "OPEN",
"assignedAdmin": AdminUser,
"notes": [Note],
"documents": [TaskDocument],
"priority": "NO_PRIORITY",
"relatedTasks": [Task],
"assignedTeam": "UNASSIGNED"
}
TaskAssignedTeam
Description
The team that a task is assigned to
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"UNASSIGNED"
TaskAssociatedRecord
Types
| Union Types |
|---|
Example
Account
TaskAssociatedRecordFilter
Description
For filtering task search by the task's associated record
Fields
| Input Field | Description |
|---|---|
type - TaskAssociatedRecordType!
|
Type of the associated record to filter by |
id - ID!
|
The ID of the associated record to filter by |
Example
{"type": "ACCOUNT", "id": "4"}
TaskAssociatedRecordType
Description
Possible types of associated records for a task
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"ACCOUNT"
TaskCategoryInput
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"CALL"
TaskDocument
Description
A Document associated with a task
Example
{
"id": "4",
"name": "abc123",
"updatedAt": "2007-12-03T10:15:30Z",
"file": RemoteAsset,
"modifiedBy": AdminUser,
"uploadedAt": "2007-12-03T10:15:30Z"
}
TaskEdge
TaskPathSegment
Fields
| Field Name | Description |
|---|---|
objectType - TaskPathSegmentObjectType!
|
|
objectId - ID!
|
Example
{"objectType": "ACCOUNT", "objectId": "4"}
TaskPathSegmentObjectType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"ACCOUNT"
TaskPriority
Description
The priority of a task
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NO_PRIORITY"
TaskSearchCategory
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"CALL"
TaskSearchResults
Fields
| Field Name | Description |
|---|---|
edges - [TaskEdge!]!
|
|
pageInfo - PageInfo!
|
Example
{
"edges": [TaskEdge],
"pageInfo": PageInfo
}
TaskSearchSort
Description
For sorting task search results
Fields
| Input Field | Description |
|---|---|
field - TaskSearchSortField!
|
The field to sort by |
direction - SortDirection!
|
The direction to sort in |
Example
{"field": "CREATED", "direction": "ASC"}
TaskSearchSortField
Description
Fields to sort a task search by
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"CREATED"
TaskStatus
Description
The status of a task
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"OPEN"
TaskType
Description
Various types of compliance tasks
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"ACCOUNT_VERIFY_ADDRESS_DOCUMENT"
TaskUpdateStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"OPEN"
TaxAttributionSearchTransaction
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
fund - Fund
|
|
unitCount - Int!
|
|
unitCountDecimal - FixedPointNumber!
|
|
unitPrice - Money!
|
|
processedAt - DateTime
|
|
investingEntity - InvestingEntity
|
|
amount - Money!
|
|
status - SearchTransactionStatus!
|
|
unitClass - UnitClass
|
Unit class associated with the Transaction |
Example
{
"id": "4",
"fund": Fund,
"unitCount": 987,
"unitCountDecimal": FixedPointNumber,
"unitPrice": Money,
"processedAt": "2007-12-03T10:15:30Z",
"investingEntity": InvestingEntity,
"amount": Money,
"status": "WITHHELD",
"unitClass": UnitClass
}
TaxDeclarationStatus
Description
Tax declaration status
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"DECLARED"
TaxResidencyInput
Description
Input to capture tax residency information for investing entities
Fields
| Input Field | Description |
|---|---|
primaryTaxResidencyCountryId - ID
|
ID for the tax residency country |
primaryTaxIdentificationNumber - String
|
The tax identification number (TIN) |
secondaryTaxResidencyCountryId - ID
|
ID for the secondary tax residency country |
secondaryTaxIdentificationNumber - String
|
The secondary tax identification number (TIN) |
Example
{
"primaryTaxResidencyCountryId": "4",
"primaryTaxIdentificationNumber": "abc123",
"secondaryTaxResidencyCountryId": 4,
"secondaryTaxIdentificationNumber": "xyz789"
}
TaxStatementConfig
Fields
| Field Name | Description |
|---|---|
type - TaxStatementType!
|
The type of the statements. |
category - DocumentCategoryV2!
|
The category of the statements. |
recipients - TaxStatementRecipients!
|
The recipients of the statements. |
period - DateRange!
|
The period from which the statements are generated. |
commentary - String
|
The commentary added to the statement. |
Example
{
"type": "NZ_TAX_LIMITED_PARTNERSHIP",
"category": "AUTHORITY",
"recipients": TaxStatementRecipients,
"period": DateRange,
"commentary": "xyz789"
}
TaxStatementConfigInput
Fields
| Input Field | Description |
|---|---|
name - String!
|
Name of the batch of statements. |
type - TaxStatementType!
|
Type of statement to create. |
recipients - TaxStatementRecipientsInput!
|
The recipients of the statement. |
period - DateRangeInput!
|
The period for the statement. |
publishAt - DateTime
|
The date the statement is scheduled to be published. |
commentary - String
|
A comment to include with the statement. |
Example
{
"name": "xyz789",
"type": "NZ_TAX_LIMITED_PARTNERSHIP",
"recipients": TaxStatementRecipientsInput,
"period": DateRangeInput,
"publishAt": "2007-12-03T10:15:30Z",
"commentary": "abc123"
}
TaxStatementRecipients
Description
Recipients filter for batch generation of statements for tax statements.
The fields will contain the objects that are selected for the batch. If nothing was selected on batch creation, the fields will be empty.
Fields
| Field Name | Description |
|---|---|
funds - [Fund!]
|
Funds selected for the batch. |
Example
{"funds": [Fund]}
TaxStatementRecipientsInput
Description
Input for configuring recipients of a batch of tax statements.
Fields
| Input Field | Description |
|---|---|
fundIds - [ID!]
|
Fund IDs to include in the statement. |
Example
{"fundIds": [4]}
TaxStatementType
Description
The different types of tax statements that can be generated for an investor.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NZ_TAX_LIMITED_PARTNERSHIP"
TaxWithholdingMethod
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"NONE"
TenantColorsConfiguration
Fields
| Field Name | Description |
|---|---|
primary - HexColorCode
|
|
secondary - HexColorCode
|
|
background - HexColorCode
|
Example
{
"primary": "#7bb1b0",
"secondary": "#7bb1b0",
"background": "#7bb1b0"
}
TenantConfiguration
Fields
| Field Name | Description |
|---|---|
general - TenantGeneralConfiguration
|
|
emails - TenantEmailsConfiguration
|
|
resources - TenantResourcesConfiguration
|
|
links - TenantLinksConfiguration
|
|
logos - TenantLogosConfiguration
|
|
colors - TenantColorsConfiguration
|
Example
{
"general": TenantGeneralConfiguration,
"emails": TenantEmailsConfiguration,
"resources": TenantResourcesConfiguration,
"links": TenantLinksConfiguration,
"logos": TenantLogosConfiguration,
"colors": TenantColorsConfiguration
}
TenantEmailsConfiguration
Example
{
"supportEmail": "abc123",
"senderEmail": "abc123",
"personalSenderEmail": "abc123",
"personalSenderName": "abc123",
"replyEmail": "abc123",
"bccEmail": "abc123",
"bccIntegrationEmailAddress": "xyz789"
}
TenantGeneralConfiguration
Fields
| Field Name | Description |
|---|---|
displayName - String
|
|
country - Country
|
|
currency - Currency
|
|
timezone - String
|
A timezone value matching the value field from one of https://github.com/dmfilipenko/timezones.json |
Example
{
"displayName": "xyz789",
"country": Country,
"currency": Currency,
"timezone": "abc123"
}
TenantLinksConfiguration
TenantLogosConfiguration
Fields
| Field Name | Description |
|---|---|
defaultLogo - RemoteAsset
|
|
emailAndDocumentLogo - RemoteAsset
|
|
shortcutLogo - RemoteAsset
|
Example
{
"defaultLogo": RemoteAsset,
"emailAndDocumentLogo": RemoteAsset,
"shortcutLogo": RemoteAsset
}
TenantResourcesConfiguration
Fields
| Field Name | Description |
|---|---|
termsAndConditionsUrl - URL
|
|
termsAndConditionsUpload - RemoteAsset
|
|
privacyPolicyUrl - URL
|
|
privacyPolicyUpload - RemoteAsset
|
|
wholesaleCertificationUrl - URL
|
|
wholesaleCertificationUpload - RemoteAsset
|
Example
{
"termsAndConditionsUrl": "http://www.test.com/",
"termsAndConditionsUpload": RemoteAsset,
"privacyPolicyUrl": "http://www.test.com/",
"privacyPolicyUpload": RemoteAsset,
"wholesaleCertificationUrl": "http://www.test.com/",
"wholesaleCertificationUpload": RemoteAsset
}
ToDoTask
Description
Task to do something
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
created - DateTime!
|
|
updated - DateTime!
|
|
status - TaskStatus!
|
|
dueAt - DateTime
|
|
assignedAdmin - AdminUser
|
|
notes - [Note!]!
|
|
title - String!
|
|
associatedRecord - TaskAssociatedRecord
|
|
documents - [TaskDocument!]
|
|
priority - TaskPriority
|
|
relatedTasks - [Task!]
|
|
assignedTeam - TaskAssignedTeam
|
Team that the task is assigned to |
Example
{
"id": "4",
"created": "2007-12-03T10:15:30Z",
"updated": "2007-12-03T10:15:30Z",
"status": "OPEN",
"dueAt": "2007-12-03T10:15:30Z",
"assignedAdmin": AdminUser,
"notes": [Note],
"title": "xyz789",
"associatedRecord": Account,
"documents": [TaskDocument],
"priority": "NO_PRIORITY",
"relatedTasks": [Task],
"assignedTeam": "UNASSIGNED"
}
TotalDollarAmountCapitalCallBatchCalculationConfig
Description
Configuration for the total dollar calculation of a capital call batch
Fields
| Field Name | Description |
|---|---|
amount - HighPrecisionMoney!
|
The amount to calculate the capital call batch to |
Example
{"amount": HighPrecisionMoney}
TotalDollarAmountCapitalCallBatchCalculationConfigInput
Description
Input for configuring the total dollar calculation of a capital call batch
Fields
| Input Field | Description |
|---|---|
amount - HighPrecisionMoneyInput!
|
Example
{"amount": HighPrecisionMoneyInput}
TotalDollarAmountDistributionComponent
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
unitClass - UnitClass
|
Unit class that the component is for |
amount - Money!
|
Dollar amount of the component |
taxWithholdingMethod - TaxWithholdingMethod!
|
Method used to withhold tax for the component |
componentType - DistributionComponentType!
|
Type of the component |
label - String
|
Label for the component (optional) |
Example
{
"id": "4",
"unitClass": UnitClass,
"amount": Money,
"taxWithholdingMethod": "NONE",
"componentType": "DIVIDENDS",
"label": "abc123"
}
TotalDollarAmountDistributionComponentInput
Fields
| Input Field | Description |
|---|---|
amount - MoneyUnit!
|
|
taxWithholdingMethod - TaxWithholdingMethod!
|
Example
{"amount": MoneyUnit, "taxWithholdingMethod": "NONE"}
TotalDollarFee
Description
Total dollar fees are calculated daily based on: (1) the total dollar amount effective for the period (2) the number of days in the period (2) the class unit count on each day in the period
Example
{
"effectiveFrom": "2007-12-03T10:15:30Z",
"dollarAmount": "abc123"
}
TotalDollarFeeInput
Description
Total dollar fees are calculated daily based on: (1) the total dollar amount effective for the period (2) the number of days in the period (2) the class unit count on each day in the period
Example
{
"effectiveFrom": "2007-12-03T10:15:30Z",
"dollarAmount": "abc123"
}
TransactionTag
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"RELATED_PARTY_NCBO"
TransferUnitsInput
Fields
| Input Field | Description |
|---|---|
fromHoldingId - ID!
|
ID of the holding to transfer units from |
toInvestingEntityId - ID!
|
ID of the investing entity to transfer the units to |
unitCountDecimal - FixedPointNumberInput!
|
Number of units to transfer |
unitPrice - MoneyUnit!
|
Price per unit |
transferDate - DateTime!
|
Date of the transfer |
notifyByEmail - Boolean
|
Whether to notify the investors of the transfer, default is true |
publishStatementsToInvestorPortal - Boolean!
|
Whether to publish unit redemption statement to the investor portal |
tags - [TransactionTag!]
|
List of tags to be associated with the unit transfer |
Example
{
"fromHoldingId": "4",
"toInvestingEntityId": 4,
"unitCountDecimal": FixedPointNumberInput,
"unitPrice": MoneyUnit,
"transferDate": "2007-12-03T10:15:30Z",
"notifyByEmail": false,
"publishStatementsToInvestorPortal": true,
"tags": ["RELATED_PARTY_NCBO"]
}
TrustInvestingEntity
Fields
| Field Name | Description |
|---|---|
id - ID!
|
ID of the trust investing entity |
name - String
|
Legal name of the trust |
displayName - String
|
Display name of the trust |
address - Address
|
Registered address of the trust |
postalAddress - Address
|
Postal address for the trust |
placeOfBusinessAddress - Address
|
Place of business for the trust |
trustType - InvestingEntityTrustType
|
trust type |
registrationNumber - String
|
Trust Registration Number |
taxResidency - InvestingEntityTaxResidency
|
Tax residency details for the trust |
nzPrescribedInvestorRate - NZPrescribedInvestorRateBasisPoints
|
NZ PIR |
nzPrescribedInvestorTaxDeclarationStatus - TaxDeclarationStatus
|
Declared status of the NZ PIR |
interestResidentWithholdingTax - ResidentWithholdingTaxRateBasisPoints
|
RWT rate on interest |
interestResidentWithholdingTaxDeclarationStatus - TaxDeclarationStatus
|
Declared status of the RWT |
nonResidentWithholdingTaxRate - NonResidentWithholdingTaxRateBasisPoints
|
NRWT rate on interest |
nonResidentWithholdingTaxDeclarationStatus - TaxDeclarationStatus
|
Declared status of the NRWT |
natureAndPurposeDetails - NatureAndPurposeDetails
|
Nature and purpose details for the trust |
clientReferenceNumber - String
|
Client Reference Number for historical client references |
businessNumber - String
|
Business No. for reference |
paymentReference - String
|
Payment Reference for integration purposes use paymentReferences instead |
paymentReferences - [StaticPaymentReference!]!
|
References to be used by an investing entity when making payments |
Example
{
"id": "4",
"name": "abc123",
"displayName": "xyz789",
"address": Address,
"postalAddress": Address,
"placeOfBusinessAddress": Address,
"trustType": "ESTATE",
"registrationNumber": "abc123",
"taxResidency": InvestingEntityTaxResidency,
"nzPrescribedInvestorRate": "UNSET",
"nzPrescribedInvestorTaxDeclarationStatus": "DECLARED",
"interestResidentWithholdingTax": "RATE_0",
"interestResidentWithholdingTaxDeclarationStatus": "DECLARED",
"nonResidentWithholdingTaxRate": "RATE_0",
"nonResidentWithholdingTaxDeclarationStatus": "DECLARED",
"natureAndPurposeDetails": NatureAndPurposeDetails,
"clientReferenceNumber": "abc123",
"businessNumber": "abc123",
"paymentReference": "xyz789",
"paymentReferences": [BankPaymentReference]
}
TypePermission
Fields
| Field Name | Description |
|---|---|
type - String!
|
Example
{"type": "xyz789"}
URL
Description
A Uniform Resource Locator
Example
"http://www.test.com/"
USDBankAccountBankAccountLocationDetails
Fields
| Field Name | Description |
|---|---|
routingNumber - String!
|
Routing number for US bank accounts |
Example
{"routingNumber": "abc123"}
USDBankAccountInput
Fields
| Input Field | Description |
|---|---|
routingNumber - String!
|
Example
{"routingNumber": "xyz789"}
USDVerifiableBankAccount
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
created - DateTime!
|
|
updated - DateTime!
|
|
name - String!
|
|
nickname - String!
|
|
currency - Currency!
|
|
isDefaultAccount - Boolean!
|
|
status - BankAccountStatus!
|
|
documents - [VerifiableDocument!]!
|
|
accountNumber - String!
|
|
routingNumber - String!
|
|
investingEntity - InvestingEntity!
|
The investing entity that owns this bank account |
Example
{
"id": "4",
"created": "2007-12-03T10:15:30Z",
"updated": "2007-12-03T10:15:30Z",
"name": "abc123",
"nickname": "abc123",
"currency": Currency,
"isDefaultAccount": true,
"status": "PENDING",
"documents": [VerifiableDocument],
"accountNumber": "xyz789",
"routingNumber": "xyz789",
"investingEntity": InvestingEntity
}
UnitClass
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
name - String!
|
The name of the unit class |
code - String!
|
Generated code for the unit class |
note - String
|
an optional note attached to the unit class |
createdAt - DateTime!
|
The date the unit class was created |
unitCount - FixedPointNumber!
|
The number of units in the unit class |
holdingCount - Int!
|
The number of holdings in the unit class |
unitPrice - HighPrecisionMoney!
|
The latest unit price |
netAssetValue - HighPrecisionMoney!
|
The net asset value of the unit class |
outgoingBankAccount - FundOutgoingBankAccount
|
The fund bank account that outgoing payments will be made from. It will be the fund's default unless explicitly set. |
managementFees - [UnitClassFee!]!
|
Management fees sorted by descending 'effective from' date |
unitPrices - [UnitPrice!]!
|
Unit prices sorted by descending 'effective from' date |
distributionRates - [UnitClassDistributionRate!]
|
Distribution rates for the unit class sorted by descending 'effective from' date |
Example
{
"id": "4",
"name": "abc123",
"code": "xyz789",
"note": "abc123",
"createdAt": "2007-12-03T10:15:30Z",
"unitCount": FixedPointNumber,
"holdingCount": 123,
"unitPrice": HighPrecisionMoney,
"netAssetValue": HighPrecisionMoney,
"outgoingBankAccount": FundOutgoingBankAccount,
"managementFees": [UnitClassFee],
"unitPrices": [UnitPrice],
"distributionRates": [UnitClassDistributionRate]
}
UnitClassAnnualPercentageDistributionRate
Description
An annual percentage to distribute relative to each holding's value in the unit class
Fields
| Field Name | Description |
|---|---|
annualPercentage - Float!
|
Annual percentage rate (0-1) |
Example
{"annualPercentage": 123.45}
UnitClassDailyCentsPerUnitDistributionRate
Description
A daily amount in cents to be distributed relative to each holding's value in the unit class
Fields
| Field Name | Description |
|---|---|
dailyCentsPerUnit - HighPrecisionMoney!
|
Daily cents per unit to be applied to distributions for the rate's effective period |
Example
{"dailyCentsPerUnit": HighPrecisionMoney}
UnitClassDistributionRate
Description
A rate that is applied to a distribution for a given time period
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
createdAt - DateTime!
|
Date that the distribution rate was added |
effectiveFrom - DateTime!
|
The date from which the rate is effective - rate will be effective from this date until the next rate is set |
rate - UnitClassDistributionRateValue!
|
The rate's value |
note - String
|
An optional note for this distribution rate |
Example
{
"id": "4",
"createdAt": "2007-12-03T10:15:30Z",
"effectiveFrom": "2007-12-03T10:15:30Z",
"rate": UnitClassAnnualPercentageDistributionRate,
"note": "xyz789"
}
UnitClassDistributionRateValue
Description
Possible types of values for a distribution rate
Example
UnitClassAnnualPercentageDistributionRate
UnitClassDistributionRateValueInput
Description
Possible values for a distribution rate. At least one of the fields must be provided.
TODO: Add @oneOf directive to this type once we support it
Fields
| Input Field | Description |
|---|---|
annualPercentage - Float
|
Annual percentage rate (0-1) |
totalDollarAmount - MoneyUnit
|
Total dollar amount to be applied to distributions for the rate's effective period |
dailyCentsPerUnit - MoneySubUnit
|
Daily cents per unit to be applied to distributions for the rate's effective period |
Example
{
"annualPercentage": 987.65,
"totalDollarAmount": MoneyUnit,
"dailyCentsPerUnit": MoneySubUnit
}
UnitClassDistributionRatesDistributionComponent
Description
This distribution component will use variable distribution rates from the selected unit class (or all unit classes if unitClass is null) for calculating the distribution.
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
unitClass - UnitClass
|
Unit class that the component is for |
taxWithholdingMethod - TaxWithholdingMethod!
|
Method used to withhold tax for the component |
componentType - DistributionComponentType!
|
Type of the component |
label - String
|
Label for the component (optional) |
Example
{
"id": "4",
"unitClass": UnitClass,
"taxWithholdingMethod": "NONE",
"componentType": "DIVIDENDS",
"label": "xyz789"
}
UnitClassEdge
Fields
| Field Name | Description |
|---|---|
cursor - String!
|
|
node - UnitClass!
|
Example
{
"cursor": "abc123",
"node": UnitClass
}
UnitClassFee
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
unitClass - UnitClass!
|
The unit class this fee applies to |
config - FeeConfig!
|
Fee configuration |
note - String
|
Optional note included with this fee on creation |
createdBy - AdminUser
|
The admin user that created this fee |
createdAt - DateTime!
|
The time this fee was created |
Example
{
"id": "4",
"unitClass": UnitClass,
"config": AnnualPercentageFee,
"note": "xyz789",
"createdBy": AdminUser,
"createdAt": "2007-12-03T10:15:30Z"
}
UnitClassSearchResults
Fields
| Field Name | Description |
|---|---|
edges - [UnitClassEdge!]!
|
|
pageInfo - PageInfo!
|
Example
{
"edges": [UnitClassEdge],
"pageInfo": PageInfo
}
UnitClassTotalDollarAmountDistributionRate
Description
A total amount to be distributed relative to each holding's value in the unit class
Fields
| Field Name | Description |
|---|---|
totalDollarAmount - HighPrecisionMoney!
|
Total dollar amount to be applied to distributions for the rate's effective period |
Example
{"totalDollarAmount": HighPrecisionMoney}
UnitIssuanceImportJobConfig
Description
Import job for bulk unit issuance operations.
Fields
| Field Name | Description |
|---|---|
investingEntity - InvestingEntity!
|
The investing entity receiving the unit issuance. |
fund - Fund!
|
The fund for the unit issuance. |
offer - Offer!
|
The offer associated with the unit issuance. |
unitClass - UnitClass!
|
The unit class for the issuance. |
dateOfIssuance - DateTime!
|
The date when the units were issued. |
unitCount - String!
|
The number of units to be issued. |
pricePerUnit - Money!
|
The price per unit for this issuance. |
amount - Money!
|
The total investment amount. |
emailEnabled - Boolean!
|
Whether an email notification should be sent to the investor. |
statementsPublished - Boolean!
|
Whether statements should be published for this issuance. |
Example
{
"investingEntity": InvestingEntity,
"fund": Fund,
"offer": Offer,
"unitClass": UnitClass,
"dateOfIssuance": "2007-12-03T10:15:30Z",
"unitCount": "abc123",
"pricePerUnit": Money,
"amount": Money,
"emailEnabled": true,
"statementsPublished": true
}
UnitIssuanceImportMetadata
Description
Metadata specific to unit issuance import jobs.
Example
{
"numStatements": 123,
"associatedRecords": 987,
"emailsSent": 987,
"totalUnits": "xyz789"
}
UnitPrice
Description
A unit price is associated with a unit class. It is effective from a specific date until a new price is set.
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
unitClass - UnitClass!
|
The unit class |
priceV2 - HighPrecisionMoney!
|
The unit price |
effectiveDate - DateTime!
|
The date the price is effective from |
note - String
|
Optional note |
createdBy - AdminUser
|
The admin user who created this price |
createdAt - DateTime!
|
The time this unit price was created |
Example
{
"id": 4,
"unitClass": UnitClass,
"priceV2": HighPrecisionMoney,
"effectiveDate": "2007-12-03T10:15:30Z",
"note": "xyz789",
"createdBy": AdminUser,
"createdAt": "2007-12-03T10:15:30Z"
}
UnitRedemptionRequest
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
status - UnitRedemptionStatus!
|
The status of the redemption request |
holding - Holding!
|
The holding that the units are being redeemed from |
unitCountDecimal - FixedPointNumber!
|
The number of units to redeem |
unitPrice - Money!
|
The unit price for the redemption in 2dp. use unitPriceV2 |
unitPriceV2 - HighPrecisionMoney
|
The unit price for the redemption in 6dp. |
orderValue - Money!
|
The total value of the redemption |
dateReceived - DateTime!
|
The date the redemption was requested |
dateOfRedemption - DateTime
|
Tentative date the redemption will take affect |
note - Note!
|
An optional note attached to the redemption |
tags - [TransactionTag!]
|
list of tags associated with the unit redemption request |
Example
{
"id": 4,
"status": "REQUESTED",
"holding": Holding,
"unitCountDecimal": FixedPointNumber,
"unitPrice": Money,
"unitPriceV2": HighPrecisionMoney,
"orderValue": Money,
"dateReceived": "2007-12-03T10:15:30Z",
"dateOfRedemption": "2007-12-03T10:15:30Z",
"note": Note,
"tags": ["RELATED_PARTY_NCBO"]
}
UnitRedemptionRequestEdge
Fields
| Field Name | Description |
|---|---|
cursor - String!
|
|
node - UnitRedemptionRequest!
|
Example
{
"cursor": "abc123",
"node": UnitRedemptionRequest
}
UnitRedemptionRequestSearchResults
Fields
| Field Name | Description |
|---|---|
edges - [UnitRedemptionRequestEdge!]!
|
|
pageInfo - PageInfo!
|
Example
{
"edges": [UnitRedemptionRequestEdge],
"pageInfo": PageInfo
}
UnitRedemptionRequestSearchSort
Fields
| Input Field | Description |
|---|---|
field - UnitRedemptionRequestSearchSortField!
|
The field to sort by uses the UnitRedemptionRequestSearchSortField enum defaults to DATE |
direction - SortDirection!
|
Example
{"field": "DATE", "direction": "ASC"}
UnitRedemptionRequestSearchSortField
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"DATE"
UnitRedemptionStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"REQUESTED"
UnitTransferRequest
Description
A request to transfer units
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
status - UnitTransferStatus!
|
The status of the transfer request |
fromHolding - Holding!
|
The holding that the units are being transferred from |
toInvestingEntity - InvestingEntity!
|
The investing entity that the units are being transferred to |
unitCount - FixedPointNumber!
|
The number of units being transferred |
unitPrice - Money!
|
The unit price for the transfer |
totalValue - Money!
|
The total value of the transfer |
dateReceived - DateTime!
|
The date the transfer was requested |
dateOfTransfer - DateTime
|
Tentative date the transfer will take effect |
note - Note
|
An optional note attached to the transfer |
tags - [TransactionTag!]
|
List of tags associated with the unit transfer request |
Example
{
"id": 4,
"status": "REQUESTED",
"fromHolding": Holding,
"toInvestingEntity": InvestingEntity,
"unitCount": FixedPointNumber,
"unitPrice": Money,
"totalValue": Money,
"dateReceived": "2007-12-03T10:15:30Z",
"dateOfTransfer": "2007-12-03T10:15:30Z",
"note": Note,
"tags": ["RELATED_PARTY_NCBO"]
}
UnitTransferStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"REQUESTED"
UnlockAccountInput
Fields
| Input Field | Description |
|---|---|
accountId - ID!
|
Example
{"accountId": "4"}
UnreconciledDeposit
Description
Represents a deposit that is not yet reconciled against any order in the system
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
date - DateTime!
|
The date the deposit was made |
payerName - String!
|
The name of the payer |
bankAccountNumber - String!
|
The bank account number of the payer |
particulars - String
|
The particulars for the deposit |
code - String
|
The code for the deposit |
reference - String
|
The reference for the deposit |
amount - Money!
|
The money amount of the deposit |
suggestedMatch - DepositReconciliationMatch
|
Optionally an allocation is suggested as a match for the deposit |
Example
{
"id": 4,
"date": "2007-12-03T10:15:30Z",
"payerName": "xyz789",
"bankAccountNumber": "abc123",
"particulars": "xyz789",
"code": "abc123",
"reference": "abc123",
"amount": Money,
"suggestedMatch": Allocation
}
UnreconciledDepositEdge
Fields
| Field Name | Description |
|---|---|
cursor - String!
|
|
node - UnreconciledDeposit!
|
Example
{
"cursor": "abc123",
"node": UnreconciledDeposit
}
UnreconciledDepositResults
Fields
| Field Name | Description |
|---|---|
edges - [UnreconciledDepositEdge!]!
|
|
pageInfo - PageInfo!
|
Example
{
"edges": [UnreconciledDepositEdge],
"pageInfo": PageInfo
}
UpdateAccountProfileInput
Fields
| Input Field | Description |
|---|---|
accountId - ID!
|
The ID of the account to update |
accountManagerId - ID
|
|
legalName - UpdateLegalNameInput
|
|
preferredName - String
|
|
email - String
|
|
phoneNumber - PhoneNumberInput
|
|
jobTitle - String
|
|
industry - String
|
|
organization - String
|
|
twitterProfileUrl - URL
|
|
linkedInProfileUrl - URL
|
|
biography - String
|
|
suppressEmailNotification - Boolean
|
Disable welcome email notification to new email address (if changed) |
Example
{
"accountId": 4,
"accountManagerId": "4",
"legalName": UpdateLegalNameInput,
"preferredName": "abc123",
"email": "xyz789",
"phoneNumber": PhoneNumberInput,
"jobTitle": "xyz789",
"industry": "xyz789",
"organization": "xyz789",
"twitterProfileUrl": "http://www.test.com/",
"linkedInProfileUrl": "http://www.test.com/",
"biography": "abc123",
"suppressEmailNotification": false
}
UpdateAccreditationCertificateInput
Description
Input for updating an existing accreditation certificate
Fields
| Input Field | Description |
|---|---|
accreditationId - ID!
|
The ID of the accreditation certificate to update |
accreditationType - AccreditationType
|
Type of accreditation |
countryId - ID
|
Country of accreditation |
signedAt - DateTime
|
The date the accreditation certificate was signed at |
addFiles - [Upload!]
|
Files to add to the accreditation |
removeFiles - [ID!]
|
IDs of files to remove from the accreditation |
Example
{
"accreditationId": "4",
"accreditationType": "SAFE_HARBOUR",
"countryId": 4,
"signedAt": "2007-12-03T10:15:30Z",
"addFiles": [Upload],
"removeFiles": [4]
}
UpdateAdminUserInput
Fields
| Input Field | Description |
|---|---|
id - ID!
|
|
roleId - ID
|
|
team - AdminUserTeamInput
|
Example
{
"id": "4",
"roleId": "4",
"team": "UNSET"
}
UpdateAssetInput
Description
Modify an existing Asset
Fields
| Input Field | Description |
|---|---|
id - ID!
|
The Asset to update |
name - String
|
Common title given to the Asset |
address - String
|
Describes where the Asset is located |
countryId - ID
|
Country where the Asset is operated |
optionalCardImage - OptionalUpload
|
Image file upload - to be used on Asset cards. Size: 100MB, accepted files: jpg, png, gif, webp |
fundId - ID
|
The Fund that owns this Asset |
Example
{
"id": "4",
"name": "xyz789",
"address": "xyz789",
"countryId": 4,
"optionalCardImage": OptionalUpload,
"fundId": "4"
}
UpdateAssociatedAccountPreferencesInput
UpdateBeneficialOwnerInput
Fields
| Input Field | Description |
|---|---|
id - ID!
|
ID of the beneficial owner to update |
relationship - BeneficialOwnerRelationship!
|
Relationship of this beneficial owner to the parent |
email - String
|
Email address to contact this beneficial owner |
callingCode - String
|
Phone number calling code to contact this beneficial owner |
phoneNumber - String
|
Phone number to contact this beneficial owner |
entityName - String
|
Legal name of the beneficial owner (if company/trust/partnership) |
firstName - String
|
Legal first name/s of this beneficial owner |
middleName - String
|
Legal middle name of this beneficial owner |
lastName - String
|
Legal last name of this beneficial owner |
isIdentityVerificationExempt - Boolean
|
Is the beneficial owner exempt from completing identity verification (if individual). May only be set to true if status == 'not-sent' |
message - String
|
An optional note to add. Between 1 and 500 characters |
dateOfBirth - DayMonthYearInput
|
Date of birth of this beneficial owner |
taxResidency - UpdateTaxResidencyInput
|
Tax residency for this beneficial owner |
registrationNumber - String
|
Registration number for this beneficial owner (if company) |
businessNumber - String
|
Business number for this beneficial owner (if company/trust/partnership) |
Example
{
"id": 4,
"relationship": "DIRECTOR",
"email": "abc123",
"callingCode": "xyz789",
"phoneNumber": "xyz789",
"entityName": "xyz789",
"firstName": "xyz789",
"middleName": "xyz789",
"lastName": "xyz789",
"isIdentityVerificationExempt": true,
"message": "xyz789",
"dateOfBirth": DayMonthYearInput,
"taxResidency": UpdateTaxResidencyInput,
"registrationNumber": "abc123",
"businessNumber": "abc123"
}
UpdateBuyOrderInput
Fields
| Input Field | Description |
|---|---|
id - ID!
|
|
unitBidPrice - MoneyUnit
|
|
note - UpdateNoteInput
|
Example
{
"id": "4",
"unitBidPrice": MoneyUnit,
"note": UpdateNoteInput
}
UpdateCapitalCallBatchInput
Description
Input for updating a capital call batch. Capital call batches that are confirmed cannot be updated.
Fields
| Input Field | Description |
|---|---|
id - ID!
|
ID of the capital call batch to update |
name - String
|
Name of the capital call batch |
calculationConfig - CapitalCallBatchCalculationConfigInput
|
Configuration for the capital call batch calculation. If the calculation type is changed, the capital calls in the batch will be re-calculated. The id of capital calls in the batch will be updated but equalisation amount for capital calls is maintained for the allocation in the capital call batch. |
paymentDeadline - OptionalDateTime
|
Payment deadline for the capital call batch |
commentary - OptionalString
|
Commentary for the capital call batch |
Example
{
"id": 4,
"name": "abc123",
"calculationConfig": CapitalCallBatchCalculationConfigInput,
"paymentDeadline": OptionalDateTime,
"commentary": OptionalString
}
UpdateCapitalCallInput
Description
Input for updating a capital call
Fields
| Input Field | Description |
|---|---|
id - ID!
|
ID of the capital call to update |
equalisationAmount - HighPrecisionMoneyInput
|
Optional equalisation amount for the capital call |
Example
{"id": 4, "equalisationAmount": HighPrecisionMoneyInput}
UpdateCompanyInvestingEntityInput
Fields
| Input Field | Description |
|---|---|
id - ID!
|
Investing Entity ID |
companyName - String
|
Name of the company |
displayName - String
|
display name of the company |
registeredAddress - OptionalAddress
|
Registered address of the entity |
postalAddress - OptionalAddress
|
Postal address of the entity |
placeOfBusinessAddress - OptionalAddress
|
Place of business details of the entity |
companyType - InvestingEntityCompanyType
|
Company type |
companyRegistrationNumber - String
|
Company Registration Number |
taxResidency - UpdateTaxResidencyInput
|
Tax residency for the individual |
nzPrescribedInvestorRate - NZPrescribedInvestorRateBasisPoints
|
NZ PIR |
nzPrescribedInvestorTaxDeclarationStatus - TaxDeclarationStatus
|
Declared status of the NZ PIR |
interestResidentWithholdingTax - ResidentWithholdingTaxRateBasisPoints
|
RWT rate on interest |
interestResidentWithholdingTaxDeclarationStatus - TaxDeclarationStatus
|
Declared status of the RWT |
nonResidentWithholdingTaxRate - NonResidentWithholdingTaxRateBasisPoints
|
NRWT rate on interest |
nonResidentWithholdingTaxDeclarationStatus - TaxDeclarationStatus
|
Declared status of the NRWT |
natureAndPurpose - UpdateNatureAndPurposeInput
|
nature and purpose details for the company |
clientReferenceNumber - OptionalString
|
Client Reference Number for historical client references |
businessNumber - OptionalString
|
Business No. for reference |
paymentReference - OptionalString
|
Payment Reference for integration purposes |
Example
{
"id": 4,
"companyName": "xyz789",
"displayName": "xyz789",
"registeredAddress": OptionalAddress,
"postalAddress": OptionalAddress,
"placeOfBusinessAddress": OptionalAddress,
"companyType": "LIMITED_COMPANY",
"companyRegistrationNumber": "xyz789",
"taxResidency": UpdateTaxResidencyInput,
"nzPrescribedInvestorRate": "UNSET",
"nzPrescribedInvestorTaxDeclarationStatus": "DECLARED",
"interestResidentWithholdingTax": "RATE_0",
"interestResidentWithholdingTaxDeclarationStatus": "DECLARED",
"nonResidentWithholdingTaxRate": "RATE_0",
"nonResidentWithholdingTaxDeclarationStatus": "DECLARED",
"natureAndPurpose": UpdateNatureAndPurposeInput,
"clientReferenceNumber": OptionalString,
"businessNumber": OptionalString,
"paymentReference": OptionalString
}
UpdateDepositMethodInput
Fields
| Input Field | Description |
|---|---|
id - ID!
|
ID of the deposit method |
name - String
|
Name of the deposit method, e.g. 'My favorite bank account' |
paymentMethod - PaymentMethodInput
|
Bank account / cheque / BPAY without an ID |
Example
{
"id": 4,
"name": "abc123",
"paymentMethod": PaymentMethodInput
}
UpdateDistributionComponentInput
Fields
| Input Field | Description |
|---|---|
id - ID!
|
|
calculationMethod - DistributionCalculationMethod
|
|
label - String
|
|
componentType - DistributionComponentType
|
|
unitClassId - OptionalID
|
|
percentageCalculation - PercentageDistributionComponentInput
|
Required when calculationMethod is ANNUAL_PERCENTAGE |
totalDollarAmountCalculation - TotalDollarAmountDistributionComponentInput
|
Required when calculationMethod is TOTAL_DOLLAR_AMOUNT |
centsPerUnitCalculation - CentsPerUnitDistributionComponentInput
|
Required when calculationMethod is CENTS_PER_UNIT |
distributionRatesCalculation - DistributionRatesDistributionComponentInput
|
Required when calculationMethod is UNIT_CLASS_DISTRIBUTION_RATES |
Example
{
"id": "4",
"calculationMethod": "TOTAL_DOLLAR_AMOUNT",
"label": "xyz789",
"componentType": "DIVIDENDS",
"unitClassId": OptionalID,
"percentageCalculation": PercentageDistributionComponentInput,
"totalDollarAmountCalculation": TotalDollarAmountDistributionComponentInput,
"centsPerUnitCalculation": CentsPerUnitDistributionComponentInput,
"distributionRatesCalculation": DistributionRatesDistributionComponentInput
}
UpdateDistributionInput
Fields
| Input Field | Description |
|---|---|
distributionId - ID!
|
|
name - String
|
|
periodFrom - DateTime
|
|
periodTo - DateTime
|
|
paymentDate - DateTime
|
|
addComponents - [AddDistributionComponentInput!]
|
|
updateComponents - [UpdateDistributionComponentInput!]
|
|
deleteComponents - [ID!]
|
|
statementCommentary - String
|
Example
{
"distributionId": 4,
"name": "xyz789",
"periodFrom": "2007-12-03T10:15:30Z",
"periodTo": "2007-12-03T10:15:30Z",
"paymentDate": "2007-12-03T10:15:30Z",
"addComponents": [AddDistributionComponentInput],
"updateComponents": [UpdateDistributionComponentInput],
"deleteComponents": ["4"],
"statementCommentary": "abc123"
}
UpdateEmailTemplateInput
Description
Input for updating an existing email template
Fields
| Input Field | Description |
|---|---|
emailTemplateId - ID!
|
ID of the email template to update |
name - String
|
Name of the email template. Maximum allowed length is 255 characters. |
template - String
|
Template string for the email, may contain placeholders. Maximum allowed length is 100000 characters. |
fundId - OptionalID
|
Optional ID of the fund that the email template is associated with |
Example
{
"emailTemplateId": 4,
"name": "abc123",
"template": "xyz789",
"fundId": OptionalID
}
UpdateEntityTagsInput
UpdateFundDocumentInput
Description
Modify a Document against a Fund
Fields
| Input Field | Description |
|---|---|
documentId - ID!
|
Unique identifier of the Document that will be modified |
name - String
|
Descriptive title of the Document |
file - Upload
|
File to be uploaded |
visibility - FundDocumentVisibility
|
Visibility of the Document |
category - FundDocumentCategory
|
Category to associate with the Document |
Example
{
"documentId": "4",
"name": "xyz789",
"file": Upload,
"visibility": "INTERNAL",
"category": "OFFER_DOCUMENTS"
}
UpdateFundInput
Description
Modify an existing Fund
Fields
| Input Field | Description |
|---|---|
id - ID!
|
The fund to update |
name - String
|
Common title given to the Fund |
legalName - String
|
Name of the legal entity |
legalStructure - LegalStructure
|
Legal structure of the legal entity |
assetStructure - AssetStructure
|
Asset structure of the Fund |
inception - DateTime
|
Date that the Fund was created |
countryId - ID
|
Country where the Fund is operated |
currencyId - ID
|
Currency that the fund operates in |
registrationNumber - String
|
Registration number of the fund (e.g AFSL) |
cardImage - Upload
|
Image file upload - to be used on fund cards. Size: 100MB, accepted files: jpg, png, gif, webp |
depositBankAccount - FundBankAccount
|
|
investorType - InvestorType
|
|
fundManagerName - String
|
|
secondaryMarket - UpdateSecondaryMarketConfigInput
|
|
unitRedemptionRequestConfig - UpdateFundUnitRedemptionRequestConfigInput
|
Update the unit redemption request configuration for the fund |
unitPrecisionScale - Int
|
Unit precision scale for the fund - maximum 9dp |
Example
{
"id": 4,
"name": "abc123",
"legalName": "xyz789",
"legalStructure": "LIMITED_PARTNERSHIP",
"assetStructure": "SINGLE_ASSET",
"inception": "2007-12-03T10:15:30Z",
"countryId": "4",
"currencyId": 4,
"registrationNumber": "xyz789",
"cardImage": Upload,
"depositBankAccount": FundBankAccount,
"investorType": "WHOLESALE",
"fundManagerName": "abc123",
"secondaryMarket": UpdateSecondaryMarketConfigInput,
"unitRedemptionRequestConfig": UpdateFundUnitRedemptionRequestConfigInput,
"unitPrecisionScale": 987
}
UpdateFundInvestorPortalConfigurationInput
Description
Input for configuring the holding page on the investor portal
Fields
| Input Field | Description |
|---|---|
id - ID!
|
The fund to update |
showFund - Boolean
|
When true, an investor can view fund's data from the investor portal portfolio and holding reporting |
showHoldingPage - Boolean
|
When true, an investor with a holding in the fund can view a page with detailed information about their holding |
summary - FundSummaryInput
|
A short summary of the fund to be shown on the investor portal |
customMetrics - [CustomMetricInput!]
|
Custom metrics for the fund |
holdingKeyMetrics - [FundHoldingKeyMetricConfigInput!]
|
Configuration for default key metrics on the holding page |
holdingGraphs - [FundHoldingPageGraphConfigInput!]
|
Configuration for graphs on the holding page |
holdingTables - [FundHoldingPageTableConfigInput!]
|
Configuration for tables on the holding page |
Example
{
"id": 4,
"showFund": true,
"showHoldingPage": true,
"summary": FundSummaryInput,
"customMetrics": [CustomMetricInput],
"holdingKeyMetrics": [FundHoldingKeyMetricConfigInput],
"holdingGraphs": [FundHoldingPageGraphConfigInput],
"holdingTables": [FundHoldingPageTableConfigInput]
}
UpdateFundOutgoingBankAccountInput
Fields
| Input Field | Description |
|---|---|
id - ID!
|
ID of the bank account |
name - String
|
Name of the bank account |
accountNumber - String
|
Bank account number |
currencyCode - String
|
ISO 4217 alpha 3 currency code for the bank account |
bankAccountLocationDetails - BankAccountLocationDetailsInput
|
Location specific details for the bank account, such as BSB for AUD, routing number for USD, etc. |
businessIdentifierCode - String
|
BIC/SWIFT Code |
setFundDefault - Boolean
|
Sets this bank account as the default for the fund. Setting the previous default account to false. This will affect all unit classes that do not have a bank account explicitly set. This will not affect unit classes that had the previous default account explicitly assigned to them. Sending false on a default account will not unset it. A single default account is required. |
Example
{
"id": "4",
"name": "abc123",
"accountNumber": "abc123",
"currencyCode": "xyz789",
"bankAccountLocationDetails": BankAccountLocationDetailsInput,
"businessIdentifierCode": "xyz789",
"setFundDefault": true
}
UpdateFundUnitRedemptionRequestConfigInput
Fields
| Input Field | Description |
|---|---|
enabled - Boolean!
|
true if the fund supports unit redemption requests |
Example
{"enabled": false}
UpdateHoldingDistributionSettingsInput
Fields
| Input Field | Description |
|---|---|
holdingID - ID!
|
|
settings - HoldingDistributionSettings
|
|
bankAccountId - ID
|
ID of the bank account for distributions to be paid to for this holding |
redemptionBankAccountId - ID
|
ID of the bank account for redemptions to be paid to for this holding |
unitClassId - OptionalID
|
ID of the unit class for distribution reinvestment. Unit class is always required when reinvestment is enabled |
Example
{
"holdingID": 4,
"settings": "ENABLED",
"bankAccountId": "4",
"redemptionBankAccountId": "4",
"unitClassId": OptionalID
}
UpdateImportBatchInput
Description
Input for updating an existing import batch.
Fields
| Input Field | Description |
|---|---|
id - ID!
|
The ID of the import batch to update. |
type - ImportJobType
|
The type of import job for this batch. |
name - String
|
Name of the import batch. |
file - Upload
|
The file containing the data to import. |
Example
{
"id": "4",
"type": "UNIT_ISSUANCE",
"name": "xyz789",
"file": Upload
}
UpdateIndividual
Fields
| Input Field | Description |
|---|---|
legalName - UpdateLegalNameInput
|
Legal name of the individual |
displayName - String
|
Display name of the individual - Ignored if UpdateIndividual is for updating an investing entity of type JOINT_INDIVIDUAL |
registeredAddress - OptionalAddress
|
Registered address of the entity |
postalAddress - OptionalAddress
|
Postal address of the entity |
placeOfBusinessAddress - OptionalAddress
|
Place of business details of the entity |
placeOfBirthCity - String
|
Place of birth details of the individual |
placeOfBirthCountry - String
|
|
placeOfBirthPlaceId - String
|
|
placeOfBirthRawSearch - String
|
|
primaryCitizenshipId - ID
|
Primary citizenship of the individual |
nzPrescribedInvestorRate - NZPrescribedInvestorRateBasisPoints
|
NZ PIR |
nzPrescribedInvestorTaxDeclarationStatus - TaxDeclarationStatus
|
Declared status of the NZ PIR |
taxResidency - UpdateTaxResidencyInput
|
Tax residency for the individual |
interestResidentWithholdingTax - ResidentWithholdingTaxRateBasisPoints
|
RWT rate on interest |
interestResidentWithholdingTaxDeclarationStatus - TaxDeclarationStatus
|
Declared status of the RWT |
nonResidentWithholdingTaxRate - NonResidentWithholdingTaxRateBasisPoints
|
NRWT rate on interest |
nonResidentWithholdingTaxDeclarationStatus - TaxDeclarationStatus
|
Declared status of the NRWT |
natureAndPurpose - UpdateNatureAndPurposeInput
|
nature and purpose details for the individual |
clientReferenceNumber - OptionalString
|
Client Reference Number for historical client references |
paymentReference - OptionalString
|
Payment Reference for integration purposes |
Example
{
"legalName": UpdateLegalNameInput,
"displayName": "abc123",
"registeredAddress": OptionalAddress,
"postalAddress": OptionalAddress,
"placeOfBusinessAddress": OptionalAddress,
"placeOfBirthCity": "xyz789",
"placeOfBirthCountry": "abc123",
"placeOfBirthPlaceId": "xyz789",
"placeOfBirthRawSearch": "xyz789",
"primaryCitizenshipId": "4",
"nzPrescribedInvestorRate": "UNSET",
"nzPrescribedInvestorTaxDeclarationStatus": "DECLARED",
"taxResidency": UpdateTaxResidencyInput,
"interestResidentWithholdingTax": "RATE_0",
"interestResidentWithholdingTaxDeclarationStatus": "DECLARED",
"nonResidentWithholdingTaxRate": "RATE_0",
"nonResidentWithholdingTaxDeclarationStatus": "DECLARED",
"natureAndPurpose": UpdateNatureAndPurposeInput,
"clientReferenceNumber": OptionalString,
"paymentReference": OptionalString
}
UpdateIndividualInvestingEntityInput
Fields
| Input Field | Description |
|---|---|
id - ID!
|
Investing Entity ID |
individual - UpdateIndividual!
|
updated details of the individual |
Example
{
"id": "4",
"individual": UpdateIndividual
}
UpdateInvestingEntityDefaultBankAccountInput
UpdateInvestingEntityDocumentInput
Description
Update an existing investing entity document
Fields
| Input Field | Description |
|---|---|
documentId - ID!
|
Unique identifier of the Document that will be updated |
name - String
|
Name of the Document |
visibility - InvestingEntityDocumentVisibility
|
Visibility of the Document |
category - InvestingEntityDocumentCategory
|
Category of the Document |
Example
{
"documentId": "4",
"name": "xyz789",
"visibility": "INTERNAL",
"category": "TAX_STATEMENTS"
}
UpdateInvestingEntityGoverningDocumentInput
Description
Input for updating an existing investing entity governing document
Example
{
"investingEntityId": 4,
"documentId": 4,
"name": "abc123"
}
UpdateInvestingEntityHoldingBankAccountInput
Example
{
"holdingId": "4",
"bankAccountId": 4,
"redemptionBankAccountId": 4
}
UpdateInvestingEntityKeyAccountInput
UpdateInvestingEntityRiskProfileInput
UpdateJointIndividualInvestingEntityInput
Fields
| Input Field | Description |
|---|---|
id - ID!
|
Investing Entity ID |
displayName - String
|
Display name of the joint individual entity |
individualOne - UpdateIndividual
|
individual one |
individualTwo - UpdateIndividual
|
individual two |
Example
{
"id": "4",
"displayName": "abc123",
"individualOne": UpdateIndividual,
"individualTwo": UpdateIndividual
}
UpdateLegalNameInput
UpdateManualTaskInput
Fields
| Input Field | Description |
|---|---|
id - ID!
|
|
status - TaskUpdateStatus
|
|
category - TaskCategoryInput
|
|
dueAt - DateTime
|
|
assignedAdminUserId - OptionalID
|
|
title - String
|
|
associatedInvestorProfileType - ManualTaskAssociatedInvestorProfileInput
|
|
associatedInvestorProfileId - ID
|
|
associatedInvestingEntityId - ID
|
|
priority - TaskPriority
|
The priority of the task |
assignedTeam - TaskAssignedTeam
|
Example
{
"id": 4,
"status": "OPEN",
"category": "CALL",
"dueAt": "2007-12-03T10:15:30Z",
"assignedAdminUserId": OptionalID,
"title": "abc123",
"associatedInvestorProfileType": "ACCOUNT",
"associatedInvestorProfileId": 4,
"associatedInvestingEntityId": 4,
"priority": "NO_PRIORITY",
"assignedTeam": "UNASSIGNED"
}
UpdateNatureAndPurposeInput
Fields
| Input Field | Description |
|---|---|
frequencyOfInvestment - InvestingEntityFrequencyOfInvestment
|
The frequency of investment expected from the Investing Entity |
sourceOfFunds - SourceOfFundsSource
|
source of funds |
availableFunds - InvestingEntityAvailableFunds
|
Estimate of Funds Available for Investment |
reasonForInvesting - InvestingEntityReasonForInvesting
|
The reason for investing |
Example
{
"frequencyOfInvestment": "ONE_OFF",
"sourceOfFunds": "BUSINESS_INCOME",
"availableFunds": "UNDER_50K",
"reasonForInvesting": "ONGOING_INCOME"
}
UpdateNoteInput
UpdateOfferDataRoomContentBlockInput
Fields
| Input Field | Description |
|---|---|
offerId - ID!
|
|
contentBlockId - ID!
|
|
textBlock - OfferDataRoomTextBlockInput
|
|
tableBlock - OfferDataRoomTableBlockInput
|
Example
{
"offerId": "4",
"contentBlockId": 4,
"textBlock": OfferDataRoomTextBlockInput,
"tableBlock": OfferDataRoomTableBlockInput
}
UpdateOfferDataRoomInput
Fields
| Input Field | Description |
|---|---|
offerId - ID!
|
|
subtitle - String
|
|
overview - String
|
|
details - [IndexedKeyValueInput!]
|
Key value pairs for the the offer |
primaryDocument - Upload
|
|
image - Upload
|
|
videoUrl - URL
|
|
documentOrder - [OfferDataRoomDocumentOrderInput!]
|
|
contentOrder - [OfferDataRoomContentBlockOrderInput!]
|
|
access - OfferDataRoomAccess
|
|
selectedAccountIds - [ID!]
|
If access is set to SELECTED_ACCOUNTS, this field should contain IDs of the accounts that have access to the data room |
Example
{
"offerId": 4,
"subtitle": "abc123",
"overview": "xyz789",
"details": [IndexedKeyValueInput],
"primaryDocument": Upload,
"image": Upload,
"videoUrl": "http://www.test.com/",
"documentOrder": [OfferDataRoomDocumentOrderInput],
"contentOrder": [OfferDataRoomContentBlockOrderInput],
"access": "HIDDEN",
"selectedAccountIds": ["4"]
}
UpdateOfferDepositMethodsInput
Fields
| Input Field | Description |
|---|---|
offerId - ID!
|
The offer that the listed deposit methods will be linked to |
depositMethodLinks - [DepositMethodOrderedLink!]!
|
The new deposit methods to replace the existing links, e.g. empty list to unlink all |
Example
{
"offerId": 4,
"depositMethodLinks": [DepositMethodOrderedLink]
}
UpdateOfferInput
Description
Update an existing Offer
Fields
| Input Field | Description |
|---|---|
id - ID!
|
|
displayName - String
|
|
status - OfferStatus
|
|
settledAt - DateTime
|
|
fundsDeadline - DateTime
|
|
pricePerUnitAmountV2 - HighPrecisionMoneyInput
|
The price per unit for an offer in 6 decimal places in the fund's currency. Will error if the provided value has more than 6 decimal places. |
totalUnitCountDecimal - FixedPointNumberInput
|
Total number of units in this offer |
minimumUnitCountDecimal - FixedPointNumberInput
|
Minimum number of units in this offer an investor can be allocated |
maximumUnitCountDecimal - FixedPointNumberInput
|
Maximum number of units in this offer an investor can be allocated |
digitalSubscription - OfferDigitalSubscription
|
Whether the offer is available for digital subscription |
unitClassId - OptionalID
|
The ID of the unit class that is associated with this offer |
Example
{
"id": 4,
"displayName": "abc123",
"status": "OPEN",
"settledAt": "2007-12-03T10:15:30Z",
"fundsDeadline": "2007-12-03T10:15:30Z",
"pricePerUnitAmountV2": HighPrecisionMoneyInput,
"totalUnitCountDecimal": FixedPointNumberInput,
"minimumUnitCountDecimal": FixedPointNumberInput,
"maximumUnitCountDecimal": FixedPointNumberInput,
"digitalSubscription": "ENABLED",
"unitClassId": OptionalID
}
UpdatePartnershipInvestingEntityInput
Fields
| Input Field | Description |
|---|---|
id - ID!
|
Investing Entity ID |
partnershipName - String
|
legal name of the partnership |
displayName - String
|
display name of the partnership |
registeredAddress - OptionalAddress
|
Registered address of the entity |
postalAddress - OptionalAddress
|
Postal address of the entity |
placeOfBusinessAddress - OptionalAddress
|
Place of business details of the entity |
partnershipType - InvestingEntityPartnershipType
|
partnership type |
registrationNumber - String
|
registration number of the partnership (if applicable) |
taxResidency - UpdateTaxResidencyInput
|
Tax residency for the individual |
nzPrescribedInvestorRate - NZPrescribedInvestorRateBasisPoints
|
NZ PIR |
nzPrescribedInvestorTaxDeclarationStatus - TaxDeclarationStatus
|
Declared status of the NZ PIR |
interestResidentWithholdingTax - ResidentWithholdingTaxRateBasisPoints
|
RWT rate on interest |
interestResidentWithholdingTaxDeclarationStatus - TaxDeclarationStatus
|
Declared status of the RWT |
nonResidentWithholdingTaxRate - NonResidentWithholdingTaxRateBasisPoints
|
NRWT rate on interest |
nonResidentWithholdingTaxDeclarationStatus - TaxDeclarationStatus
|
Declared status of the NRWT |
natureAndPurpose - UpdateNatureAndPurposeInput
|
nature and purpose details for the partnership |
clientReferenceNumber - OptionalString
|
Client Reference Number for historical client references |
businessNumber - OptionalString
|
Business No. for reference |
paymentReference - OptionalString
|
Payment Reference for integration purposes |
Example
{
"id": "4",
"partnershipName": "abc123",
"displayName": "xyz789",
"registeredAddress": OptionalAddress,
"postalAddress": OptionalAddress,
"placeOfBusinessAddress": OptionalAddress,
"partnershipType": "LIMITED_PARTNERSHIP",
"registrationNumber": "abc123",
"taxResidency": UpdateTaxResidencyInput,
"nzPrescribedInvestorRate": "UNSET",
"nzPrescribedInvestorTaxDeclarationStatus": "DECLARED",
"interestResidentWithholdingTax": "RATE_0",
"interestResidentWithholdingTaxDeclarationStatus": "DECLARED",
"nonResidentWithholdingTaxRate": "RATE_0",
"nonResidentWithholdingTaxDeclarationStatus": "DECLARED",
"natureAndPurpose": UpdateNatureAndPurposeInput,
"clientReferenceNumber": OptionalString,
"businessNumber": OptionalString,
"paymentReference": OptionalString
}
UpdateProspectInput
Fields
| Input Field | Description |
|---|---|
id - ID!
|
|
firstName - String
|
|
middleName - String
|
|
lastName - String
|
|
preferredName - String
|
|
email - String
|
|
dayOfBirth - Int
|
|
monthOfBirth - Int
|
|
yearOfBirth - Int
|
|
callingCode - String
|
|
phoneNumber - String
|
|
addressPlaceId - String
|
|
addressRawSearch - String
|
|
addressLine1 - String
|
|
addressSuburb - String
|
|
addressCity - String
|
|
addressPostCode - String
|
|
addressCountry - String
|
|
jobTitle - String
|
|
industry - String
|
|
organization - String
|
|
twitterProfileUrl - URL
|
|
linkedInProfileUrl - URL
|
|
biography - String
|
Example
{
"id": "4",
"firstName": "abc123",
"middleName": "abc123",
"lastName": "xyz789",
"preferredName": "abc123",
"email": "abc123",
"dayOfBirth": 987,
"monthOfBirth": 987,
"yearOfBirth": 123,
"callingCode": "abc123",
"phoneNumber": "abc123",
"addressPlaceId": "xyz789",
"addressRawSearch": "abc123",
"addressLine1": "abc123",
"addressSuburb": "abc123",
"addressCity": "abc123",
"addressPostCode": "xyz789",
"addressCountry": "abc123",
"jobTitle": "xyz789",
"industry": "xyz789",
"organization": "abc123",
"twitterProfileUrl": "http://www.test.com/",
"linkedInProfileUrl": "http://www.test.com/",
"biography": "abc123"
}
UpdateRegistrationOfInterestInput
Description
Deprecated: Registration of Interest will be merged into Allocation
Fields
| Input Field | Description |
|---|---|
id - ID!
|
|
accountID - ID
|
If provided: prospect ID will be cleared |
prospectID - ID
|
If provided: account ID will be cleared |
unitCount - Int
|
A positive number of units to assign to the record |
unitPrice - MoneyUnit
|
The price per unit in the offers currency |
status - RegistrationOfInterestStatus
|
The status to sent the registration of interest to |
note - String
|
Example
{
"id": "4",
"accountID": "4",
"prospectID": "4",
"unitCount": 987,
"unitPrice": MoneyUnit,
"status": "INTERESTED",
"note": "abc123"
}
UpdateSecondaryMarketConfigInput
Fields
| Input Field | Description |
|---|---|
status - SecondaryMarketStatus
|
|
fees - Float
|
Example
{"status": "OPEN", "fees": 987.65}
UpdateSellOrderInput
Fields
| Input Field | Description |
|---|---|
id - ID!
|
|
unitAskPrice - MoneyUnit
|
|
unitCountDecimal - FixedPointNumberInput
|
|
flatFee - MoneyUnit
|
|
note - UpdateNoteInput
|
Example
{
"id": "4",
"unitAskPrice": MoneyUnit,
"unitCountDecimal": FixedPointNumberInput,
"flatFee": MoneyUnit,
"note": UpdateNoteInput
}
UpdateSystemTaskInput
Fields
| Input Field | Description |
|---|---|
id - ID!
|
|
assignedAdminUserId - OptionalID
|
|
priority - TaskPriority
|
The priority of the task |
assignedTeam - TaskAssignedTeam
|
Example
{
"id": 4,
"assignedAdminUserId": OptionalID,
"priority": "NO_PRIORITY",
"assignedTeam": "UNASSIGNED"
}
UpdateTagInput
Description
Update an existing tag.
Fields
| Input Field | Description |
|---|---|
id - ID!
|
|
displayName - String
|
|
associatedType - TagAssociationType!
|
The type of entity(s) the tag can be applied to. can be INVESTOR_PROFILE or INVESTING_ENTITY |
Example
{
"id": "4",
"displayName": "abc123",
"associatedType": "INVESTOR_PROFILE"
}
UpdateTaxResidencyInput
Description
Input to update tax residency information for investing entities
Fields
| Input Field | Description |
|---|---|
primaryTaxResidencyCountryId - OptionalID
|
ID for the primary tax residency country |
primaryTaxIdentificationNumber - OptionalString
|
The primary tax identification number (TIN) |
secondaryTaxResidencyCountryId - OptionalID
|
ID for the secondary tax residency country |
secondaryTaxIdentificationNumber - OptionalString
|
The secondary tax identification number (TIN) |
Example
{
"primaryTaxResidencyCountryId": OptionalID,
"primaryTaxIdentificationNumber": OptionalString,
"secondaryTaxResidencyCountryId": OptionalID,
"secondaryTaxIdentificationNumber": OptionalString
}
UpdateTenantColorsConfigurationInput
Fields
| Input Field | Description |
|---|---|
primary - HexColorCode
|
|
secondary - HexColorCode
|
|
background - HexColorCode
|
Example
{
"primary": "#7bb1b0",
"secondary": "#7bb1b0",
"background": "#7bb1b0"
}
UpdateTenantConfigurationInput
Fields
| Input Field | Description |
|---|---|
displayName - String
|
|
countryId - ID
|
|
currencyId - ID
|
|
timezone - String
|
A timezone value matching the value field from one of https://github.com/dmfilipenko/timezones.json |
Example
{
"displayName": "abc123",
"countryId": 4,
"currencyId": 4,
"timezone": "abc123"
}
UpdateTenantEmailsConfigurationInput
Example
{
"supportEmail": "abc123",
"senderEmail": "xyz789",
"personalSenderEmail": "abc123",
"personalSenderName": "xyz789",
"replyEmail": "abc123",
"bccEmail": "abc123"
}
UpdateTenantLinksConfigurationInput
UpdateTenantLogosConfigurationInput
UpdateTenantResourcesConfigurationInput
Fields
| Input Field | Description |
|---|---|
termsAndConditionsUrl - UploadOrUrl
|
|
privacyPolicyUrl - UploadOrUrl
|
|
wholesaleCertificationUrl - UploadOrUrl
|
Example
{
"termsAndConditionsUrl": UploadOrUrl,
"privacyPolicyUrl": UploadOrUrl,
"wholesaleCertificationUrl": UploadOrUrl
}
UpdateTrustInvestingEntityInput
Fields
| Input Field | Description |
|---|---|
id - ID!
|
Investing Entity ID |
trustName - String
|
legal name of the trust |
displayName - String
|
display name of the trust |
registeredAddress - OptionalAddress
|
Registered address of the entity |
postalAddress - OptionalAddress
|
Postal address of the entity |
placeOfBusinessAddress - OptionalAddress
|
Place of business details of the entity |
trustType - InvestingEntityTrustType
|
|
registrationNumber - String
|
registration number of the trust (if applicable) |
taxResidency - UpdateTaxResidencyInput
|
Tax residency for the individual |
nzPrescribedInvestorRate - NZPrescribedInvestorRateBasisPoints
|
NZ PIR |
nzPrescribedInvestorTaxDeclarationStatus - TaxDeclarationStatus
|
Declared status of the NZ PIR |
interestResidentWithholdingTax - ResidentWithholdingTaxRateBasisPoints
|
RWT rate on interest |
interestResidentWithholdingTaxDeclarationStatus - TaxDeclarationStatus
|
Declared status of the RWT |
nonResidentWithholdingTaxRate - NonResidentWithholdingTaxRateBasisPoints
|
NRWT rate on interest |
nonResidentWithholdingTaxDeclarationStatus - TaxDeclarationStatus
|
Declared status of the NRWT |
natureAndPurpose - UpdateNatureAndPurposeInput
|
nature and purpose details for the trust |
clientReferenceNumber - OptionalString
|
Client Reference Number for historical client references |
businessNumber - OptionalString
|
Business No. for reference |
paymentReference - OptionalString
|
Payment Reference for integration purposes |
Example
{
"id": 4,
"trustName": "xyz789",
"displayName": "abc123",
"registeredAddress": OptionalAddress,
"postalAddress": OptionalAddress,
"placeOfBusinessAddress": OptionalAddress,
"trustType": "ESTATE",
"registrationNumber": "abc123",
"taxResidency": UpdateTaxResidencyInput,
"nzPrescribedInvestorRate": "UNSET",
"nzPrescribedInvestorTaxDeclarationStatus": "DECLARED",
"interestResidentWithholdingTax": "RATE_0",
"interestResidentWithholdingTaxDeclarationStatus": "DECLARED",
"nonResidentWithholdingTaxRate": "RATE_0",
"nonResidentWithholdingTaxDeclarationStatus": "DECLARED",
"natureAndPurpose": UpdateNatureAndPurposeInput,
"clientReferenceNumber": OptionalString,
"businessNumber": OptionalString,
"paymentReference": OptionalString
}
UpdateUnitClassDistributionRateInput
Description
Input for updating a distribution rate for a unit class
Fields
| Input Field | Description |
|---|---|
distributionRateId - ID!
|
|
effectiveFrom - DateTime
|
The date from which the rate is effective - rate will be effective from this date until either the next rate in the series' effective date or, if this is the most recent date, indefinitely until the next rate is set. Date cannot be the same day as the active rate's effectiveFrom date. |
value - UnitClassDistributionRateValueInput
|
The value of the distribution rate |
note - OptionalString
|
An optional note for the distribution rate |
Example
{
"distributionRateId": 4,
"effectiveFrom": "2007-12-03T10:15:30Z",
"value": UnitClassDistributionRateValueInput,
"note": OptionalString
}
UpdateUnitClassInput
Fields
| Input Field | Description |
|---|---|
id - ID!
|
|
name - String
|
|
note - OptionalString
|
|
outgoingBankAccountId - OptionalID
|
Assigns the fund outgoing bank account for this unit class. Must be from the unit class's fund. Sending OptionalID with nil will clear the value and fall back to the fund's default account. Sending the default will explicitly assign the fund's default account. |
Example
{
"id": 4,
"name": "xyz789",
"note": OptionalString,
"outgoingBankAccountId": OptionalID
}
UpdateUnitRedemptionRequestInput
Description
Input for updating an existing unit redemption request
Fields
| Input Field | Description |
|---|---|
id - ID!
|
|
unitPrice - MoneyUnit
|
update the unit price for the redemption |
unitCountDecimal - FixedPointNumberInput
|
update the number of units to redeem |
note - UpdateNoteInput
|
update the note for the redemption |
dateOfRedemption - DateTime
|
update the tentative date to redeem the units |
tags - [TransactionTag!]
|
update the list of tags to be associated with the unit redemption request |
Example
{
"id": "4",
"unitPrice": MoneyUnit,
"unitCountDecimal": FixedPointNumberInput,
"note": UpdateNoteInput,
"dateOfRedemption": "2007-12-03T10:15:30Z",
"tags": ["RELATED_PARTY_NCBO"]
}
UpdateUnitTransferRequestInput
Fields
| Input Field | Description |
|---|---|
id - ID!
|
ID of the unit transfer request to update |
toInvestingEntityId - ID
|
ID of the investing entity to transfer the units to |
unitCount - FixedPointNumberInput
|
Number of units to transfer |
unitPrice - MoneyUnit
|
Price per unit |
transferDate - DateTime
|
Date of the transfer |
note - UpdateNoteInput
|
Optionally update the note on the transfer |
tags - [TransactionTag!]
|
List of tags to be associated with the unit transfer |
Example
{
"id": 4,
"toInvestingEntityId": "4",
"unitCount": FixedPointNumberInput,
"unitPrice": MoneyUnit,
"transferDate": "2007-12-03T10:15:30Z",
"note": UpdateNoteInput,
"tags": ["RELATED_PARTY_NCBO"]
}
UpdateVerifiableBankAccountInput
Description
Input for updating a verifiable bank account
Fields
| Input Field | Description |
|---|---|
id - ID!
|
The ID of the verifiable bank account to update |
nickname - String
|
The nickname for the verifiable bank account |
addVerificationDocuments - [Upload!]
|
The documents to add to the verifiable bank account |
removeVerificationDocuments - [ID!]
|
The IDs of the documents to remove from the verifiable bank account |
Example
{
"id": 4,
"nickname": "abc123",
"addVerificationDocuments": [Upload],
"removeVerificationDocuments": [4]
}
Upload
Description
A multipart file upload
Example
Upload
UploadAccountDocumentInput
UploadAccreditationCertificateInput
Fields
| Input Field | Description |
|---|---|
id - ID!
|
Id of investing entity |
accreditationType - AccreditationType!
|
Type of accreditation |
countryId - ID!
|
Country of accreditation |
signedAt - DateTime
|
The date the accreditation certificate was signed at |
files - [Upload!]!
|
The files to upload against the accreditation |
Example
{
"id": "4",
"accreditationType": "SAFE_HARBOUR",
"countryId": 4,
"signedAt": "2007-12-03T10:15:30Z",
"files": [Upload]
}
UploadDepositReconciliationBankStatementInput
Description
Upload a bank statement containing deposits to reconcile against orders
Fields
| Input Field | Description |
|---|---|
file - Upload!
|
The file to upload |
Example
{"file": Upload}
UploadInvestingEntityGoverningDocumentInput
Description
Input for uploading a new governing document for an investing entity
Example
{
"investingEntityId": "4",
"name": "xyz789",
"file": Upload
}
UploadOfferDataRoomDocumentInput
UploadOrUrl
UploadProspectDocumentInput
UploadTaskDocumentInput
UploadedDocument
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
updatedAt - DateTime!
|
|
file - RemoteAsset!
|
|
modifiedBy - AdminUser
|
Example
{
"id": "4",
"updatedAt": "2007-12-03T10:15:30Z",
"file": RemoteAsset,
"modifiedBy": AdminUser
}
VerifiIdentityVerification
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
dateAttempted - DateTime!
|
|
status - VerifiableIdentityVerificationStatus!
|
|
databases - [VerificationDatabase!]!
|
|
transactionId - String!
|
|
verificationDocuments - [RemoteAsset!]!
|
|
identityDocumentDetails - IdentityDocumentFields
|
Example
{
"id": "4",
"dateAttempted": "2007-12-03T10:15:30Z",
"status": "VERIFIED",
"databases": [VerificationDatabase],
"transactionId": "xyz789",
"verificationDocuments": [RemoteAsset],
"identityDocumentDetails": IdentityDocumentFields
}
VerifiableAddress
Description
Physical location, full address information that may be verified
Example
{
"id": 4,
"created": "2007-12-03T10:15:30Z",
"placeId": "xyz789",
"addressLine1": "abc123",
"addressLine2": "xyz789",
"suburb": "abc123",
"city": "abc123",
"postCode": "xyz789",
"country": Country,
"isCurrentAddress": true,
"verifications": [AddressVerification],
"status": "PENDING"
}
VerifiableAddressStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"PENDING"
VerifiableBankAccount
Description
A verifiable bank account for an investing entity.
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
created - DateTime!
|
|
updated - DateTime!
|
|
name - String!
|
|
nickname - String!
|
|
currency - Currency!
|
|
isDefaultAccount - Boolean!
|
|
status - BankAccountStatus!
|
|
documents - [VerifiableDocument!]!
|
|
investingEntity - InvestingEntity!
|
The investing entity that owns this bank account |
Possible Types
| VerifiableBankAccount Types |
|---|
Example
{
"id": "4",
"created": "2007-12-03T10:15:30Z",
"updated": "2007-12-03T10:15:30Z",
"name": "xyz789",
"nickname": "xyz789",
"currency": Currency,
"isDefaultAccount": true,
"status": "PENDING",
"documents": [VerifiableDocument],
"investingEntity": InvestingEntity
}
VerifiableBankAccountImpl
Fields
| Field Name | Description |
|---|---|
id - ID!
|
A verifiable bank account. |
created - DateTime!
|
Date and time when the bank account was created |
updated - DateTime!
|
Date and time when the bank account was updated |
name - String!
|
Name of the bank account holder |
nickname - String!
|
Nickname for the bank account, used to identify it in the UI |
currency - Currency!
|
ISO 4217 currency code for the bank account |
isDefaultAccount - Boolean!
|
True if this is the default bank account for the investing entity |
status - BankAccountStatus!
|
Status of the bank account verification |
documents - [VerifiableDocument!]!
|
Documents associated with the bank account, such as verification documents |
investingEntity - InvestingEntity!
|
The investing entity that owns this bank account |
accountNumber - String!
|
Bank account number, e.g. 123456789 |
bankAccountLocationDetails - BankAccountLocationDetails
|
Location specific details for the bank account, such as BSB for AUD, routing number for USD, etc. |
Example
{
"id": 4,
"created": "2007-12-03T10:15:30Z",
"updated": "2007-12-03T10:15:30Z",
"name": "abc123",
"nickname": "abc123",
"currency": Currency,
"isDefaultAccount": true,
"status": "PENDING",
"documents": [VerifiableDocument],
"investingEntity": InvestingEntity,
"accountNumber": "xyz789",
"bankAccountLocationDetails": AUDBankAccountBankAccountLocationDetails
}
VerifiableDocument
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
updatedAt - DateTime!
|
|
file - RemoteAsset!
|
|
modifiedBy - AdminUser
|
|
status - VerifiableDocumentStatus!
|
|
declinedReason - String
|
Example
{
"id": 4,
"updatedAt": "2007-12-03T10:15:30Z",
"file": RemoteAsset,
"modifiedBy": AdminUser,
"status": "PENDING",
"declinedReason": "abc123"
}
VerifiableDocumentStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"PENDING"
VerifiableIdentityVerification
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
dateAttempted - DateTime!
|
|
status - VerifiableIdentityVerificationStatus!
|
Possible Types
| VerifiableIdentityVerification Types |
|---|
Example
{
"id": "4",
"dateAttempted": "2007-12-03T10:15:30Z",
"status": "VERIFIED"
}
VerifiableIdentityVerificationStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"VERIFIED"
VerificationDatabase
VerifyAUDBankAccountNotification
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
status - NotificationStatus!
|
|
created - DateTime!
|
|
bankAccount - AUDVerifiableBankAccount!
|
Example
{
"id": "4",
"status": "INCOMPLETE",
"created": "2007-12-03T10:15:30Z",
"bankAccount": AUDVerifiableBankAccount
}
VerifyAccreditationCertificateInput
Description
Input for verifying an accreditation certificate
Fields
| Input Field | Description |
|---|---|
accreditationId - ID!
|
The ID of the accreditation certificate to verify |
Example
{"accreditationId": "4"}
VerifyAddressNotification
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
status - NotificationStatus!
|
|
created - DateTime!
|
Example
{
"id": "4",
"status": "INCOMPLETE",
"created": "2007-12-03T10:15:30Z"
}
VerifyBankAccountInput
Description
Input for verifying a bank account
Fields
| Input Field | Description |
|---|---|
bankAccountId - ID!
|
Example
{"bankAccountId": "4"}
VerifyBankAccountNotification
Fields
| Field Name | Description |
|---|---|
id - ID!
|
A notification related to a bank account verification |
status - NotificationStatus!
|
Status of the bank account verification notification |
created - DateTime!
|
Date and time when the notification was created |
bankAccount - VerifiableBankAccountImpl!
|
Bank account that is being verified |
Example
{
"id": 4,
"status": "INCOMPLETE",
"created": "2007-12-03T10:15:30Z",
"bankAccount": VerifiableBankAccountImpl
}
VerifyBiometricIdentityNotification
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
status - NotificationStatus!
|
|
created - DateTime!
|
Example
{
"id": "4",
"status": "INCOMPLETE",
"created": "2007-12-03T10:15:30Z"
}
VerifyEURBankAccountNotification
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
status - NotificationStatus!
|
|
created - DateTime!
|
|
bankAccount - EURVerifiableBankAccount!
|
Example
{
"id": "4",
"status": "INCOMPLETE",
"created": "2007-12-03T10:15:30Z",
"bankAccount": EURVerifiableBankAccount
}
VerifyGBPBankAccountNotification
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
status - NotificationStatus!
|
|
created - DateTime!
|
|
bankAccount - GBPVerifiableBankAccount!
|
Example
{
"id": "4",
"status": "INCOMPLETE",
"created": "2007-12-03T10:15:30Z",
"bankAccount": GBPVerifiableBankAccount
}
VerifyInvestingEntityGoverningDocumentInput
VerifyNZDBankAccountNotification
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
status - NotificationStatus!
|
|
created - DateTime!
|
|
bankAccount - NZDVerifiableBankAccount!
|
Example
{
"id": 4,
"status": "INCOMPLETE",
"created": "2007-12-03T10:15:30Z",
"bankAccount": NZDVerifiableBankAccount
}
VerifyUSDBankAccountNotification
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
status - NotificationStatus!
|
|
created - DateTime!
|
|
bankAccount - USDVerifiableBankAccount!
|
Example
{
"id": "4",
"status": "INCOMPLETE",
"created": "2007-12-03T10:15:30Z",
"bankAccount": USDVerifiableBankAccount
}
Void
Description
A type for responses we dont care about
WholesaleCertificationStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"AWAITING"