OneVest Organization API API Reference

This is the OneVest API documentation.

The authorization token to access the API will be provided by OneVest i.e. Authorization-API:"Bearer token".

API Endpoints
Staging:
https://organization-gateway-service.staging.onewealth.io/graphql

User

The object represents a client at OneVest. This can be an individual or a legal entity such as a private company, corporation, sole proprietorship, etc.

With an active user, one can proceeed to create goals and portfolios, make transfers (deposits, withdrawals and account transfers), etc. This is the foundational object among all others.

Possible error codes that may be returned when interacting with the user object:

  1. Failed Validation
    This will be displayed if any of the phone, primary email or sin attributes receive an input that is contrary to the inbuilt validation checks.

  2. 400: Bad Request
    This is a typical response status resulting from errors when invalid syntax is used. A message will be displayed indicating the source of the bad request.
    For example:
    "message": Variable "$input" got invalid value "1972-6-01" at "input.dateOfBirth"; Expected type "Date". Date cannot represent an invalid date-string 1972-6-01.

User

Create User

Create a new user object.

The required fields for a user include data on:PII, special persons details (member of IIROC, owner/officer of public company, etc), employment (status, industry, etc), financial background (income, assets, debt), investment needs (knowledge, risk level), etc.

Include the attribute, 'incompleteFields', to the mutation response to obtain attributes that may have been left out during user creation. Though a user profile can be created with some fields being incomplete, one won't be able to create a sub account later on.

The user ID is a key input parameter in other endpoint calls.

input:

(no description)

Example

Request Content-Types: application/json
Query
mutation createUser($input: CreateUserInput!){
  createUser(input: $input){
  }
}
Variables
{
  "input": {
    "annualDebtPaymentsCents": "object",
    "annualIncomeCents": "object",
    "annualIncomeStr": "string",
    "billingScheduleId": "object",
    "bulkAccountOpening": "boolean",
    "businessIsMemberofIIROC": "boolean",
    "businessPhone": "object",
    "charityRegistrationNumber": "object",
    "citizenships": [
      "object"
    ],
    "closeAssociateOfPEP": "boolean",
    "companyType": "object",
    "complianceIssueSource": "object",
    "complianceState": "string",
    "countryOfRegistration": "object",
    "countryOfTaxResidence": "string",
    "dateOfBirth": "object",
    "dateOfDeath": "object",
    "debtAssociated": [
      "string"
    ],
    "employerCompanyAddress": {
      "city": "object",
      "country": "string",
      "houseNumber": "object",
      "jurisdiction": "string",
      "neighborhood": "object",
      "postal": "object",
      "province": "string",
      "streetName": "object",
      "unitNumber": "object"
    },
    "employerName": "object",
    "employmentSituation": "string",
    "employmentSituationOtherDescription": "object",
    "employmentStatus": "string",
    "entityName": "object",
    "establishedDate": "object",
    "fatcaStatus": "string",
    "fatcaStatusOtherDescription": "object",
    "feeTierId": "object",
    "financialFixedAssetsCents": "object",
    "financialLiquidAssetsCents": "object",
    "firmNumber": "object",
    "firstName": "object",
    "foreignTaxInformation": [
      {
        "foreignTaxCountry": "object",
        "foreignTaxNumber": "object"
      }
    ],
    "gender": "object",
    "headOfInternationalOrganization": "boolean",
    "iDCheckCompleted": "boolean"
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "createUser": {}
  }
}
User

Fetch User

Fetch a list of specified attributes belonging to a user. You will need the user ID as a request parameter in the input.

userId:
object

(no description)

Example

Request Content-Types: application/json
Query
query fetchUser($userId: ObjectID!){
  fetchUser(userId: $userId){
  }
}
Variables
{}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "fetchUser": {}
  }
}
User

Fetch Users

Fetch a list of user based on the specified filters such as date completed, date of birth, organization ID etc.

input:

(no description)

Example

Request Content-Types: application/json
Query
query fetchUsers($input: FetchUsersInput!){
  fetchUsers(input: $input){
    totalCount
  }
}
Variables
{
  "input": {
    "filter": {
      "completedAtAfter": "object",
      "completedAtBefore": "object",
      "complianceState": "string",
      "customFields": [
        {
          "key": "object",
          "value": "object"
        }
      ],
      "dateOfBirthAfter": "object",
      "dateOfBirthBefore": "object",
      "iDCheckCompleted": "boolean",
      "iDVerified": "boolean",
      "isComplete": "boolean",
      "lastSuitabilityReviewAtAfter": "object",
      "lastSuitabilityReviewAtBefore": "object",
      "organizationId": "object",
      "partnerUserId": "object",
      "primaryEmail": "string",
      "searchText": "string",
      "sin": "object",
      "suitabilityReviewDaysPastDue": "number",
      "suitabilityReviewDue": "boolean",
      "types": [
        "string"
      ]
    },
    "pagination": {
      "offSet": "number",
      "perPage": "number",
      "sortDesc": "boolean",
      "sortField": "string"
    }
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "fetchUsers": {
      "totalCount": "integer"
    }
  }
}
User

Update User

Update an existing user by their ID. Include the data to be updated in the input section, this will override the existing data.

The mutation can also be used to add missing fields that were left out during user creation i.e. when the 'incompleteFields' attribute on the createUser mutation returned an array of missing attributes.

input:

(no description)

Example

Request Content-Types: application/json
Query
mutation updateUser($input: UpdateUserInput!){
  updateUser(input: $input){
  }
}
Variables
{
  "input": {
    "annualDebtPaymentsCents": "object",
    "annualIncomeCents": "object",
    "annualIncomeStr": "string",
    "billingScheduleId": "object",
    "bulkAccountOpening": "boolean",
    "businessIsMemberofIIROC": "boolean",
    "businessPhone": "object",
    "charityRegistrationNumber": "object",
    "citizenships": [
      "object"
    ],
    "closeAssociateOfPEP": "boolean",
    "companyType": "object",
    "complianceIssueSource": "object",
    "complianceState": "string",
    "countryOfRegistration": "object",
    "countryOfTaxResidence": "string",
    "customFields": [
      {
        "key": "object",
        "value": "object"
      }
    ],
    "dateOfBirth": "object",
    "dateOfDeath": "object",
    "debtAssociated": [
      "string"
    ],
    "employerCompanyAddress": {
      "city": "object",
      "country": "string",
      "houseNumber": "object",
      "jurisdiction": "string",
      "neighborhood": "object",
      "postal": "object",
      "province": "string",
      "streetName": "object",
      "unitNumber": "object"
    },
    "employerName": "object",
    "employmentSituation": "string",
    "employmentSituationOtherDescription": "object",
    "employmentStatus": "string",
    "entityName": "object",
    "establishedDate": "object",
    "fatcaStatus": "string",
    "fatcaStatusOtherDescription": "object",
    "feeTierId": "object",
    "financialFixedAssetsCents": "object",
    "financialLiquidAssetsCents": "object",
    "firmNumber": "object",
    "firstName": "object",
    "foreignTaxInformation": [
      {
        "foreignTaxCountry": "object"
      }
    ]
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "updateUser": {}
  }
}
User

Fetch User Updates

Fetch updates made to a user's profile an existing user by their ID. Include the data to be updated in the input section, this will override the existing data.

The mutation can also be used to add missing fields that were left out during user creation i.e. when the 'incompleteFields' attribute on the createUser mutation returned an array of missing attributes.

input:

(no description)

Example

Request Content-Types: application/json
Query
query fetchUserUpdates($input: FetchUserUpdatesInput!){
  fetchUserUpdates(input: $input){
    totalCount
  }
}
Variables
{
  "input": {
    "pagination": {
      "offSet": "number",
      "perPage": "number",
      "sortDesc": "boolean"
    },
    "userId": "object"
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "fetchUserUpdates": {
      "totalCount": "integer"
    }
  }
}
User

Transition User

Transition a user's profile state from the default 'active' state to either 'inactive' or 'frozen', or 'frozen' to 'active'. The request parameters include both a user ID and a transition state.

The 'inactive' or 'frozen' states restrict any activity from happening in the user's account such as creating a goal.

input:

(no description)

Example

Request Content-Types: application/json
Query
mutation transitionUser($input: TransitionUserInput!){
  transitionUser(input: $input){
  }
}
Variables
{
  "input": {
    "transition": "string",
    "userId": "object"
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "transitionUser": {}
  }
}
User

Create User ID Verification Information

Create an identity verification record for the user. The data is stored in the 'idVerification' object and is used to update the 'latestIdVerification' array in the user object.

input:

(no description)

Example

Request Content-Types: application/json
Query
mutation createUserIDVerificationInformation($input: CreateUserIDVerificationInformationInput!){
  createUserIDVerificationInformation(input: $input){
  }
}
Variables
{
  "input": {
    "creditFileSource": "object",
    "documentExpiryDate": "object",
    "documentID": "object",
    "documentIssuingJurisdication": "object",
    "documentType": "string",
    "methodOfIDVerification": "string",
    "requestId": "object",
    "secondaryDocumentExpiryDate": "object",
    "secondaryDocumentID": "object",
    "secondaryDocumentIssuingJurisdication": "object",
    "secondaryDocumentType": "string",
    "secondaryDocumentUserName": "object",
    "userId": "object",
    "userName": "object",
    "verifiedDate": "object"
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "createUserIDVerificationInformation": {}
  }
}
User

Fetch User ID Verification

Fetch the ID verification information for a user. Requires the verification ID that was populated at the user ID verification creation mutation.

idVerificationId:
object

(no description)

Example

Request Content-Types: application/json
Query
query fetchUserIdVerification($idVerificationId: ObjectID!){
  fetchUserIdVerification(idVerificationId: $idVerificationId){
  }
}
Variables
{}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "fetchUserIdVerification": {}
  }
}
User

Fetch User ID Verifications

Fetch multiple sources of ID verification information for a user. Requires a user ID.

input:

(no description)

Example

Request Content-Types: application/json
Query
query fetchUserIdVerifications($input: FetchUserIdVerificationsInput!){
  fetchUserIdVerifications(input: $input){
    totalCount
  }
}
Variables
{
  "input": {
    "filter": {
      "methodOfIDVerification": "string",
      "userId": "object",
      "verifiedAtAfter": "object",
      "verifiedAtBefore": "object"
    },
    "pagination": {
      "offSet": "number",
      "perPage": "number",
      "sortDesc": "boolean",
      "sortField": "string"
    }
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "fetchUserIdVerifications": {
      "totalCount": "integer"
    }
  }
}
User

Update User ID Verification Information

Modifiy any existing id verification information using the verification ID populated initially. Any data included in the input section will override the existing data.

input:

(no description)

Example

Request Content-Types: application/json
Query
mutation updateUserIDVerificationInformation($input: UpdateUserIDVerificationInformationInput!){
  updateUserIDVerificationInformation(input: $input){
  }
}
Variables
{
  "input": {
    "creditFileSource": "object",
    "documentExpiryDate": "object",
    "documentID": "object",
    "documentIssuingJurisdication": "object",
    "documentType": "string",
    "idVerificationId": "object",
    "methodOfIDVerification": "string",
    "secondaryDocumentExpiryDate": "object",
    "secondaryDocumentID": "object",
    "secondaryDocumentIssuingJurisdication": "object",
    "secondaryDocumentType": "string",
    "secondaryDocumentUserName": "object",
    "userName": "object",
    "verifiedDate": "object"
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "updateUserIDVerificationInformation": {}
  }
}
User

Create Affiliate

An affiliate is a user who is connected to an account such as beneficiaries, successors, etc. The mutation creates a new user with as few fields as first name and last name. The required fields for affiliates are dependent on the account they are connected to and the relationship to the primary user. Any user created through this mutation has a tag of affiliate only.

input:

(no description)

Example

Request Content-Types: application/json
Query
mutation createAffiliate($input: CreateAffiliateInput!){
  createAffiliate(input: $input){
  }
}
Variables
{
  "input": {
    "citizenships": [
      "object"
    ],
    "closeAssociateOfPEP": "boolean",
    "companyType": "object",
    "countryOfRegistration": "object",
    "dateOfBirth": "object",
    "dateOfDeath": "object",
    "employerCompanyAddress": {
      "city": "object",
      "country": "string",
      "houseNumber": "object",
      "jurisdiction": "string",
      "neighborhood": "object",
      "postal": "object",
      "province": "string",
      "streetName": "object",
      "unitNumber": "object"
    },
    "employerName": "object",
    "employmentStatus": "string",
    "entityName": "object",
    "establishedDate": "object",
    "firstName": "object",
    "foreignTaxInformation": [
      {
        "foreignTaxCountry": "object",
        "foreignTaxNumber": "object"
      }
    ],
    "gender": "object",
    "headOfInternationalOrganization": "boolean",
    "inProvinceSince": "object",
    "isMemberOfIiroc": "boolean",
    "isOfficerOfPublicCompany": "boolean",
    "isOwnerOfPublicCompany": "boolean",
    "issuerExchange": "object",
    "issuerName": "object",
    "issuerTicker": "object",
    "jobTitle": "object",
    "lastName": "object",
    "middleName": "object",
    "organizationId": "object",
    "parentCompanyName": "object",
    "payTaxesOutsideCanada": "boolean",
    "phone": "object",
    "physicalAddress": {
      "city": "object",
      "country": "string",
      "houseNumber": "object",
      "jurisdiction": "string",
      "neighborhood": "object",
      "postal": "object"
    }
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "createAffiliate": {}
  }
}
User

Add Affiliation

Add the created affiliate or an existing user to an account. Required fields include user or affiliate ID, account ID, relationship and account specific validated fields. There is an incomplete fields array that returns any field that should be included but is missing from the input.

input:

(no description)

Example

Request Content-Types: application/json
Query
mutation addAffiliation($input: AddAffiliationInput!){
  addAffiliation(input: $input){
    incompleteFields
  }
}
Variables
{
  "input": {
    "accountId": "object",
    "allocation": "number",
    "relation": "string",
    "requestIpAddress": "string",
    "signatureRequired": "boolean",
    "type": "string",
    "userId": "object"
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "addAffiliation": {
      "incompleteFields": [
        "string"
      ]
    }
  }
}
User

Update Affiliate

Modify existing information on an affiliate. Any new input will override existing information.

input:

(no description)

Example

Request Content-Types: application/json
Query
mutation updateAffiliate($input: UpdateAffiliateInput!){
  updateAffiliate(input: $input){
  }
}
Variables
{
  "input": {
    "citizenships": [
      "object"
    ],
    "closeAssociateOfPEP": "boolean",
    "companyType": "object",
    "countryOfRegistration": "object",
    "dateOfBirth": "object",
    "dateOfDeath": "object",
    "employerCompanyAddress": {
      "city": "object",
      "country": "string",
      "houseNumber": "object",
      "jurisdiction": "string",
      "neighborhood": "object",
      "postal": "object",
      "province": "string",
      "streetName": "object",
      "unitNumber": "object"
    },
    "employerName": "object",
    "employmentStatus": "string",
    "entityName": "object",
    "establishedDate": "object",
    "firstName": "object",
    "foreignTaxInformation": [
      {
        "foreignTaxCountry": "object",
        "foreignTaxNumber": "object"
      }
    ],
    "gender": "object",
    "headOfInternationalOrganization": "boolean",
    "inProvinceSince": "object",
    "isMemberOfIiroc": "boolean",
    "isOfficerOfPublicCompany": "boolean",
    "isOwnerOfPublicCompany": "boolean",
    "issuerExchange": "object",
    "issuerName": "object",
    "issuerTicker": "object",
    "jobTitle": "object",
    "lastName": "object",
    "maritalStatus": "string",
    "middleName": "object",
    "parentCompanyName": "object",
    "payTaxesOutsideCanada": "boolean",
    "phone": "object",
    "physicalAddress": {
      "city": "object",
      "country": "string",
      "houseNumber": "object",
      "jurisdiction": "string",
      "neighborhood": "object",
      "postal": "object"
    }
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "updateAffiliate": {}
  }
}
User

Remove Affiliation

Removes an added affiliate from an account.

input:

(no description)

Example

Request Content-Types: application/json
Query
mutation removeAffiliation($input: RemoveAffiliationInput!){
  removeAffiliation(input: $input){
  }
}
Variables
{
  "input": {
    "accountId": "object",
    "affiliationId": "object"
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "removeAffiliation": {}
  }
}
User

Create Client Group

Create a new client group object.

There are two types of client groups - business and household. The client group contains additional fields that describe the business or household. The required fields for a client group include:name of the group, primary user associated with the client group and the relationships in the group.

Include the attribute, 'incompleteFields', to the mutation response to obtain a list of attributes that are missing for the selected client group.

input:

(no description)

Example

Request Content-Types: application/json
Query
mutation createClientGroup($input: CreateClientGroupInput!){
  createClientGroup(input: $input){
  }
}
Variables
{
  "input": {
    "accountNumber": "object",
    "billingScheduleId": "object",
    "businessIsMemberOfIiroc": "boolean",
    "businessType": "string",
    "corporationCountry": "string",
    "establishedDate": "object",
    "feeTierId": "object",
    "incorporationNumber": "object",
    "integrations": [
      {
        "externalId": "object",
        "groupId": "object",
        "iid": "object",
        "type": "string"
      }
    ],
    "name": "object",
    "organizationId": "object",
    "phone": "object",
    "physicalAddress": {
      "city": "object",
      "country": "string",
      "houseNumber": "object",
      "jurisdiction": "string",
      "neighborhood": "object",
      "postal": "object",
      "province": "string",
      "streetName": "object",
      "unitNumber": "object"
    },
    "primaryEmail": "object",
    "primaryUserId": "object",
    "relationships": [
      {
        "accessType": "string",
        "type": "object",
        "userId": "object"
      }
    ],
    "taxNumber": "object",
    "type": "string"
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "createClientGroup": {}
  }
}
User

Update Client Group

Modify an existing client group. Any new input overrides the existing information.

input:

(no description)

Example

Request Content-Types: application/json
Query
mutation updateClientGroup($input: UpdateClientGroupInput!){
  updateClientGroup(input: $input){
  }
}
Variables
{
  "input": {
    "accountNumber": "object",
    "billingScheduleId": "object",
    "businessIsMemberOfIiroc": "boolean",
    "businessType": "string",
    "clientGroupId": "object",
    "corporationCountry": "string",
    "establishedDate": "object",
    "feeTierId": "object",
    "incorporationNumber": "object",
    "integrations": [
      {
        "externalId": "object",
        "groupId": "object",
        "iid": "object",
        "type": "string"
      }
    ],
    "name": "object",
    "phone": "object",
    "physicalAddress": {
      "city": "object",
      "country": "string",
      "houseNumber": "object",
      "jurisdiction": "string",
      "neighborhood": "object",
      "postal": "object",
      "province": "string",
      "streetName": "object",
      "unitNumber": "object"
    },
    "primaryEmail": "object",
    "primaryUserId": "object",
    "relationships": [
      {
        "accessType": "string",
        "type": "object",
        "userId": "object"
      }
    ],
    "taxNumber": "object",
    "type": "string"
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "updateClientGroup": {}
  }
}
User

Fetch Client Group

Fetch a client group by its ID.

clientGroupId:
object

(no description)

Example

Request Content-Types: application/json
Query
query fetchClientGroup($clientGroupId: ObjectID!){
  fetchClientGroup(clientGroupId: $clientGroupId){
  }
}
Variables
{}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "fetchClientGroup": {}
  }
}
User

Fetch Client Groups

Fetch client groups by their name, organization ID, primary user ID or type.

input:

(no description)

Example

Request Content-Types: application/json
Query
query fetchClientGroups($input: FetchClientGroupsInput!){
  fetchClientGroups(input: $input){
    totalCount
  }
}
Variables
{
  "input": {
    "filter": {
      "name": "string",
      "organizationId": "object",
      "primaryUserId": "object",
      "searchText": "string",
      "states": [
        "string"
      ],
      "type": "string"
    },
    "pagination": {
      "offSet": "number",
      "perPage": "number",
      "sortDesc": "boolean",
      "sortField": "string"
    }
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "fetchClientGroups": {
      "totalCount": "integer"
    }
  }
}
User

Annual Suitability Completed

Complete the annual information update on a user's profile.

userId:
object

(no description)

Example

Request Content-Types: application/json
Query
mutation annualSuitabilityCompleted($userId: ObjectID!){
  annualSuitabilityCompleted(userId: $userId){
  }
}
Variables
{}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "annualSuitabilityCompleted": {}
  }
}

Goal

The goal object represents the intended purpose of the investment account. A user can have multiple goals.

Adding a goal is the next step after creating a user. You would need an existing user ID to create a goal.

Goal

Create Goal

Create a goal associated with the user. Only one goal can be created at a time.

Required fields in goal creation apart from the user ID are time horizon for the investment, and the goal risk level. The mutation will return an error if any of the required fields are missing. The other goal attributes may be left as 'null'.

input:

(no description)

Example

Request Content-Types: application/json
Query
mutation createGoal($input: CreateGoalInput!){
  createGoal(input: $input){
  }
}
Variables
{
  "input": {
    "clientGroupId": "object",
    "customFields": [
      {
        "key": "object",
        "value": "object"
      }
    ],
    "expectedAnnualIncomeCents": "number",
    "financialProductId": "object",
    "householdClientGroupId": "object",
    "integrations": [
      {
        "externalId": "object",
        "groupId": "object",
        "iid": "object",
        "type": "string"
      }
    ],
    "lastUpdatedBy": "object",
    "name": "object",
    "requestId": "object",
    "retirementAge": "number",
    "riskQuestion1": "string",
    "targetAmountCents": "object",
    "targetDate": "object",
    "taxOptimized": "boolean",
    "timeHorizon": "string",
    "tradingProcess": "string",
    "type": "string",
    "userId": "object"
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "createGoal": {}
  }
}
Goal

Fetch Goal

Fetch a specific goal's attributes using its ID.

goalId:
object

(no description)

Example

Request Content-Types: application/json
Query
query fetchGoal($goalId: ObjectID!){
  fetchGoal(goalId: $goalId){
  }
}
Variables
{}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "fetchGoal": {}
  }
}
Goal

Fetch Goals

Fetch all goals as per the specified filters. An empty array will be returned if there are no goals that match the specified criteria. A totalCount of the goals can be returned in the response. To support the bulk fetch, there are pagination parameters.

input:

(no description)

Example

Request Content-Types: application/json
Query
query fetchGoals($input: FetchGoalsInput!){
  fetchGoals(input: $input){
    totalCount
  }
}
Variables
{
  "input": {
    "filter": {
      "clientGroupId": "object",
      "customFields": [
        {
          "key": "object",
          "value": "object"
        }
      ],
      "includeHousehold": "boolean",
      "organizationId": "object",
      "riskQuestion1": "string",
      "state": "string",
      "states": [
        "string"
      ],
      "targetDateAfter": "object",
      "targetDateBefore": "object",
      "timeHorizon": "string",
      "type": "string",
      "userId": "object"
    },
    "pagination": {
      "offSet": "number",
      "perPage": "number",
      "sortDesc": "boolean",
      "sortField": "string"
    }
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "fetchGoals": {
      "totalCount": "integer"
    }
  }
}
Goal

Update Goal

Update an existing goal using its ID. Any new input overrides the existing data.

input:

(no description)

Example

Request Content-Types: application/json
Query
mutation updateGoal($input: UpdateGoalInput!){
  updateGoal(input: $input){
  }
}
Variables
{
  "input": {
    "clientGroupId": "object",
    "customFields": [
      {
        "key": "object",
        "value": "object"
      }
    ],
    "expectedAnnualIncomeCents": "number",
    "financialProductId": "object",
    "goalId": "object",
    "householdClientGroupId": "object",
    "integrations": [
      {
        "externalId": "object",
        "groupId": "object",
        "iid": "object",
        "type": "string"
      }
    ],
    "lastUpdatedBy": "object",
    "name": "object",
    "retirementAge": "number",
    "riskQuestion1": "string",
    "targetAmountCents": "object",
    "targetDate": "object",
    "taxOptimized": "boolean",
    "timeHorizon": "string",
    "tradingProcess": "string",
    "type": "string"
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "updateGoal": {}
  }
}
Goal

Complete Goal

Transition the goal state to 'completed' from 'active' state. All sub-accounts linked to this goal should be in an 'inactive' state prior to making the API call.

input:

(no description)

Example

Request Content-Types: application/json
Query
mutation completeGoal($input: CompleteGoalInput!){
  completeGoal(input: $input){
  }
}
Variables
{
  "input": {
    "goalId": "object",
    "lastUpdatedBy": "object"
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "completeGoal": {}
  }
}
Goal

Archive Goal

Transition the goal state to 'archived' from 'active' state. All sub-accounts linked to this goal should be in an 'inactive' state prior to making the API call.

input:

(no description)

Example

Request Content-Types: application/json
Query
mutation archiveGoal($input: ArchiveGoalInput!){
  archiveGoal(input: $input){
  }
}
Variables
{
  "input": {
    "goalId": "object",
    "lastUpdatedBy": "object"
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "archiveGoal": {}
  }
}
Goal

Re-activate Goal

Transition the goal state to 'active' from 'archived' or 'completed' states.

input:

(no description)

Example

Request Content-Types: application/json
Query
mutation reactivateGoal($input: ReactivateGoalInput!){
  reactivateGoal(input: $input){
  }
}
Variables
{
  "input": {
    "goalId": "object",
    "lastUpdatedBy": "object"
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "reactivateGoal": {}
  }
}
Goal

Fetch Goal Updates

Fetch updates made to a specific goal by providing its ID.

input:

(no description)

Example

Request Content-Types: application/json
Query
query fetchGoalUpdates($input: FetchGoalUpdatesInput!){
  fetchGoalUpdates(input: $input){
    totalCount
  }
}
Variables
{
  "input": {
    "goalId": "object",
    "pagination": {
      "offSet": "number",
      "perPage": "number",
      "sortDesc": "boolean"
    }
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "fetchGoalUpdates": {
      "totalCount": "integer"
    }
  }
}

Account & Sub-Account

A sub-account represents the most granular level at which transactions (transfers and trades) are handled. The object is a combination of a goal and an account. There can be multiple sub-accounts associated with a user based on the combination of goals and accounts held.

The account object represents the vehicle used to hold the funds that are being invested. Some of the account types available are RRSP, TFSA, Personal (Cash account). Transactions belonging to sub-accounts linked to an account can be fetched at the account level as well.

Account & Sub-Account

Create Sub Account

Create a new sub-account that is linked to a goal. The required input parameters are a user ID, goal ID and account type. The mutation will return an error if any of the required fields are missing.

For a sub account to be complete, a theme and financial product have to be assigned to the sub-account as well as the agreements signed. If the financial product ID is not specified, then the acceptable financial product associated with the sub account is null. However, if a financial product that is not appropriate for the sub account based on the suitability score is assigned, then the acceptable financial product is false. To obtain the financial product ID and the theme ID, query the fetchFinancialProducts and the fetchThemes endpoints respectively.

input:

(no description)

Example

Request Content-Types: application/json
Query
mutation createSubAccount($input: CreateSubAccountInput!){
  createSubAccount(input: $input){
  }
}
Variables
{
  "input": {
    "accountId": "object",
    "accountType": "string",
    "allowClientDeposits": "boolean",
    "billingScheduleId": "object",
    "feeTierId": "object",
    "financialProductId": "object",
    "goalId": "object",
    "isPartial": "boolean",
    "lastUpdatedBy": "object",
    "name": "object",
    "requestId": "object",
    "scheduleId": "object",
    "skipIPS": "boolean",
    "themeId": "object",
    "userId": "object"
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "createSubAccount": {}
  }
}
Account & Sub-Account

Fetch Sub Account

Fetch a specific sub-account's attributes using its ID.

subAccountId:
object

(no description)

Example

Request Content-Types: application/json
Query
query fetchSubAccount($subAccountId: ObjectID!){
  fetchSubAccount(subAccountId: $subAccountId){
  }
}
Variables
{}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "fetchSubAccount": {}
  }
}
Account & Sub-Account

Fetch Sub Accounts

Fetch all sub-accounts as per the specified filters. An empty array will be returned if there are no sub-accounts that match the criteria. A totalCount of the fetched goals can be included in the response.

input:

(no description)

Example

Request Content-Types: application/json
Query
query fetchSubAccounts($input: FetchSubAccountsInput!){
  fetchSubAccounts(input: $input){
    totalCount
  }
}
Variables
{
  "input": {
    "filter": {
      "accountId": "object",
      "accountType": "string",
      "clientGroupId": "object",
      "completedAtAfter": "object",
      "completedAtBefore": "object",
      "complianceState": "string",
      "financialProductId": "string",
      "goalId": "object",
      "iDCheckCompleted": "boolean",
      "iDVerified": "boolean",
      "includeHousehold": "boolean",
      "isComplete": "boolean",
      "organizationId": "object",
      "state": "string",
      "userId": "object"
    },
    "pagination": {
      "offSet": "number",
      "perPage": "number",
      "sortDesc": "boolean",
      "sortField": "string"
    }
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "fetchSubAccounts": {
      "totalCount": "integer"
    }
  }
}
Account & Sub-Account

Update Sub Account

Update an existing sub-account using its ID. Any new input overrides the existing data.

input:

(no description)

Example

Request Content-Types: application/json
Query
mutation updateSubAccount($input: UpdateSubAccountInput!){
  updateSubAccount(input: $input){
  }
}
Variables
{
  "input": {
    "allowClientDeposits": "boolean",
    "billingScheduleId": "object",
    "feeTierId": "object",
    "financialProductId": "object",
    "goalId": "object",
    "isPartial": "boolean",
    "lastUpdatedBy": "object",
    "name": "object",
    "skipIPS": "boolean",
    "subAccountId": "object",
    "themeId": "object",
    "tradingProcess": "string"
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "updateSubAccount": {}
  }
}
Account & Sub-Account

Fetch Sub Account Updates

Fetch updates made to an existing sub-account.

input:

(no description)

Example

Request Content-Types: application/json
Query
query fetchSubAccountUpdates($input: FetchSubAccountUpdatesInput!){
  fetchSubAccountUpdates(input: $input){
    totalCount
  }
}
Variables
{
  "input": {
    "pagination": {
      "offSet": "number",
      "perPage": "number",
      "sortDesc": "boolean"
    },
    "subAccountId": "object"
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "fetchSubAccountUpdates": {
      "totalCount": "integer"
    }
  }
}
Account & Sub-Account

Close Sub Account

Transition a sub-account to 'inactive' state from 'active'. The sub-account has to have a zero balance.

input:

(no description)

Example

Request Content-Types: application/json
Query
mutation closeSubAccount($input: CloseSubAccountInput!){
  closeSubAccount(input: $input){
  }
}
Variables
{
  "input": {
    "inactiveReason": "string",
    "shouldCloseAccount": "boolean",
    "subAccountId": "object"
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "closeSubAccount": {}
  }
}
Account & Sub-Account

Transition Sub-account

Transition sub-accounts to active or in-review states.

input:

(no description)

Example

Request Content-Types: application/json
Query
mutation transitionSubAccount($input: TransitionSubAccountInput!){
  transitionSubAccount(input: $input){
  }
}
Variables
{
  "input": {
    "lastUpdatedBy": "object",
    "subAccountId": "object",
    "transition": "string"
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "transitionSubAccount": {}
  }
}
Account & Sub-Account

Update Account

Update an existing account using its ID. Any new input overrides the existing data.

input:

(no description)

Example

Request Content-Types: application/json
Query
mutation updateAccount($input: UpdateAccountInput!){
  updateAccount(input: $input){
  }
}
Variables
{
  "input": {
    "accountId": "object",
    "applyForGovFunds": [
      "string"
    ],
    "availableCurrencies": [
      "string"
    ],
    "baseCurrency": "string",
    "billingScheduleId": "object",
    "clientGroupId": "object",
    "corporationClientGroupId": "object",
    "custodianAccountNumber": "object",
    "custodianConnectionId": "object",
    "custodianSortingOrderPriority": "number",
    "customFields": [
      {
        "key": "object",
        "value": "object"
      }
    ],
    "feePaymentAccountId": "object",
    "feeTierId": "object",
    "forceOpen": "boolean",
    "householdClientGroupId": "object",
    "integrations": [
      {
        "externalId": "object",
        "groupId": "object",
        "iid": "object",
        "type": "string"
      }
    ],
    "jurisdiction": "string",
    "nickName": "object",
    "overrideTaxRank": "number",
    "sourceOfFunds": "string",
    "tlhEnabled": "boolean"
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "updateAccount": {}
  }
}
Account & Sub-Account

Transition Account

Transitions an account to states such as active, ready, requested, frozen or canceled.

input:

(no description)

Example

Request Content-Types: application/json
Query
mutation transitionAccount($input: TransitionAccountInput!){
  transitionAccount(input: $input){
  }
}
Variables
{
  "input": {
    "accountId": "object",
    "lastUpdatedBy": "object",
    "transition": "string"
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "transitionAccount": {}
  }
}
Account & Sub-Account

Fetch Account

Fetch a specific account using its ID.

accountId:
object

(no description)

Example

Request Content-Types: application/json
Query
query fetchAccount($accountId: ObjectID!){
  fetchAccount(accountId: $accountId){
  }
}
Variables
{}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "fetchAccount": {}
  }
}
Account & Sub-Account

Fetch Account Types

Fetch the account types available. Can view the translated names and descriptions.

input:

(no description)

Example

Request Content-Types: application/json
Query
query fetchAccountTypes($input: FetchAccountTypesInput){
  fetchAccountTypes(input: $input){
  }
}
Variables
{
  "input": {
    "filter": {
      "entityId": "object",
      "householdId": "object"
    }
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "fetchAccountTypes": {}
  }
}
Account & Sub-Account

Close Account

Transition an account to 'inactive' state from 'active'. One can only transition an account that has zero balance i.e. all sub-accounts linked to the account should have a zero balance.

input:

(no description)

Example

Request Content-Types: application/json
Query
mutation closeAccount($input: CloseAccountInput!){
  closeAccount(input: $input){
  }
}
Variables
{
  "input": {
    "accountId": "object",
    "inactiveReason": "string"
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "closeAccount": {}
  }
}

Form Agreements

The formAgreements object holds the documents that users are required to sign. The documents are generated during onboarding or whenever users update some key information on the user object e.g. name, SIN, date of birth, citizenship, foreign tax information, etc.

Documents are generated according to the type of account being opened and the citizenship of the user. Note that the documents can be genereated in either English or French. The documents are specified as enums in the API.

Form Agreements

Sign Form Agreements

Generate a newly signed form with an an e-signature and a timestamp. Forms are signed at the sub-account level. Sub-accounts linked to the same account will have some forms with a similar signed date to the first one created.

input:

(no description)

Example

Request Content-Types: application/json
Query
mutation signFormAgreements($input: SignFormAgreementsInput!){
  signFormAgreements(input: $input){
  }
}
Variables
{
  "input": {
    "accountId": "object",
    "clientGroupId": "object",
    "financialProductId": "object",
    "formAgreements": [
      {
        "type": "string",
        "version": "number"
      }
    ],
    "goalId": "object",
    "language": "string",
    "requestIpAddress": "object",
    "scheduledTransferId": "object",
    "signedByUserId": "object",
    "subAccountId": "object",
    "userId": "object"
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "signFormAgreements": {}
  }
}
Form Agreements

Regenerate HTML

Repopulate the html for a form agreement using its ID.

input:

(no description)

Example

Request Content-Types: application/json
Query
mutation regenerateHtml($input: RegenerateHtmlInput!){
  regenerateHtml(input: $input){
    html
  }
}
Variables
{
  "input": {
    "formAgreementId": "object"
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "regenerateHtml": {
      "html": "string"
    }
  }
}
Form Agreements

Render Form Agreements

Process a form in the back end using the form agreement ID so that it can be displayed on browsers.

input:

(no description)

Example

Request Content-Types: application/json
Query
query renderFormAgreement($input: RenderFormAgreementInput!){
  renderFormAgreement(input: $input){
    html
  }
}
Variables
{
  "input": {
    "formAgreementId": "object"
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "renderFormAgreement": {
      "html": "string"
    }
  }
}
Form Agreements

Preview Form Agreements

Enable a form agreement to be viewed before signing.

input:

(no description)

Example

Request Content-Types: application/json
Query
query previewFormAgreement($input: PreviewFormAgreementInput!){
  previewFormAgreement(input: $input){
    html
  }
}
Variables
{
  "input": {
    "accountId": "object",
    "clientGroupId": "object",
    "goalId": "object",
    "language": "string",
    "raw": "boolean",
    "scheduledTransferId": "object",
    "subAccountId": "object",
    "type": "string",
    "userId": "object"
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "previewFormAgreement": {
      "html": "string"
    }
  }
}
Form Agreements

Fetch Required Forms

Fetch a list of required forms associated with an account type.

input:

(no description)

Example

Request Content-Types: application/json
Query
query fetchRequiredForms($input: FetchRequiredFormsInput!){
  fetchRequiredForms(input: $input){
  }
}
Variables
{
  "input": {
    "accountType": "string",
    "hasBeneficiaries": "boolean",
    "isUSPerson": "boolean"
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "fetchRequiredForms": {}
  }
}
Form Agreements

Fetch Form Agreement

Fetch a form agreement by its ID.

input:

(no description)

Example

Request Content-Types: application/json
Query
query fetchFormAgreement($input: FetchFormAgreementInput!){
  fetchFormAgreement(input: $input){
    allUsersSignedAt
    displayName
    id
    language
    signedAt
    signedUrl
    templateUrl
    type
    version
  }
}
Variables
{
  "input": {
    "formAgreementId": "object"
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "fetchFormAgreement": {
      "displayName": "string",
      "signedUrl": "string",
      "templateUrl": "string",
      "version": "integer"
    }
  }
}
Form Agreements

Fetch Form Template

Fetch a form template by its type.

input:

(no description)

type:

(no description)

Example

Request Content-Types: application/json
Query
query fetchFormTemplate($input: FetchFormTemplateInput, $type: FormTypes){
  fetchFormTemplate(input: $input, type: $type){
    digitalSignatureEnabled
    displayName
    id
    minVersion
    state
    templateUrl
    textType
    type
    updatedAt
    uploadedAt
    url
  }
}
Variables
{
  "input": {
    "formTemplateId": "object",
    "type": "string"
  },
  "type": "string"
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "fetchFormTemplate": {
      "digitalSignatureEnabled": "boolean",
      "displayName": "string",
      "minVersion": "integer",
      "templateUrl": "string",
      "url": "string"
    }
  }
}
Form Agreements

Create File Document

Creates a document that is manually uploaded to the system and is associated to a client group, user, account or sub-account. Permissions for viewing the document need to be selected as well as the document type.

input:

(no description)

Example

Request Content-Types: application/json
Query
mutation createFileDocument($input: CreateFileDocumentInput!){
  createFileDocument(input: $input){
  }
}
Variables
{
  "input": {
    "fileName": "object",
    "mediaType": "object",
    "name": "object",
    "objectId": "object",
    "objectType": "string",
    "permissionType": "string",
    "requestId": "object",
    "requestIpAddress": "object",
    "sharedClient": "boolean",
    "sharedCustodian": "boolean",
    "signed": "boolean",
    "sourceId": "object",
    "sourceType": "object",
    "type": "string"
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "createFileDocument": {}
  }
}
Form Agreements

Update File Document

Update a manually uploaded document.

input:

(no description)

Example

Request Content-Types: application/json
Query
mutation updateFileDocument($input: UpdateFileDocumentInput!){
  updateFileDocument(input: $input){
  }
}
Variables
{
  "input": {
    "fileDocumentId": "object",
    "name": "object",
    "permissionType": "string",
    "sharedClient": "boolean",
    "sharedCustodian": "boolean"
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "updateFileDocument": {}
  }
}
Form Agreements

Delete File Document

Delete a manually uploaded document using its ID.

input:

(no description)

Example

Request Content-Types: application/json
Query
mutation deleteFileDocument($input: DeleteFileDocumentInput!){
  deleteFileDocument(input: $input){
  }
}
Variables
{
  "input": {
    "fileDocumentId": "object"
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "deleteFileDocument": {}
  }
}
Form Agreements

Fetch File Upload URL

Fetch the URL of the manually uploaded document. The attributes required include the user ID, document type and whether the document is associated to the client group, user, account or subaccount.

input:

(no description)

Example

Request Content-Types: application/json
Query
query fetchFileUploadUrl($input: FetchFileUploadUrlInput!){
  fetchFileUploadUrl(input: $input){
    temporarySignedURL
  }
}
Variables
{
  "input": {
    "fileName": "string",
    "objectId": "object",
    "objectType": "string",
    "sourceId": "string",
    "type": "string",
    "userId": "object"
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "fetchFileUploadUrl": {
      "temporarySignedURL": "string"
    }
  }
}
Form Agreements

Fetch File Document

Fetch the manually uploaded document using its ID.

fileDocumentId:
object

(no description)

Example

Request Content-Types: application/json
Query
query fetchFileDocument($fileDocumentId: ObjectID!){
  fetchFileDocument(fileDocumentId: $fileDocumentId){
  }
}
Variables
{}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "fetchFileDocument": {}
  }
}
Form Agreements

Fetch File Documents

Fetch manually uploaded documents by the document types, organization ID or user IDs.

input:

(no description)

Example

Request Content-Types: application/json
Query
query fetchFileDocuments($input: FetchFileDocumentsInput!){
  fetchFileDocuments(input: $input){
    totalCount
  }
}
Variables
{
  "input": {
    "filter": {
      "objectIds": [
        "object"
      ],
      "objectTypes": [
        "string"
      ],
      "organizationId": "object",
      "sourceIds": [
        "object"
      ],
      "types": [
        "string"
      ],
      "userIds": [
        "object"
      ]
    },
    "pagination": {
      "offSet": "number",
      "perPage": "number",
      "sortDesc": "boolean",
      "sortField": "string"
    }
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "fetchFileDocuments": {
      "totalCount": "integer"
    }
  }
}
Form Agreements

Trigger Model Portfolio Resign

Makes the agreement type, Investment Policy Statement, require a new signature. The model portfolio ID is required as well as the reason for the update.

input:

(no description)

Example

Request Content-Types: application/json
Query
mutation triggerModelPortfolioResign($input: TriggerModelPortfolioResignInput!){
  triggerModelPortfolioResign(input: $input)
}
Variables
{
  "input": {
    "modelPortfolioId": "object",
    "translatedReasonForUpdate": {
      "en": "object",
      "fr": "object"
    }
  }
}
Try it now
200 OK

Successful operation

type
boolean
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "triggerModelPortfolioResign": "boolean"
  }
}

Statements

The statements object holds all reports resulting from transactions done at the account level within a period of time. This includes monthly statements, annual statements (performance and fee) and tax slips.

Statements

Generate Monthly Account Statement

Create a statement for an account and reference date.

input:

(no description)

Example

Request Content-Types: application/json
Query
mutation generateMonthlyAccountStatement($input: GenerateMonthlyAccountStatementInput!){
  generateMonthlyAccountStatement(input: $input){
    accountId
    accountStatementId
    monthlyAccountStatementId
  }
}
Variables
{
  "input": {
    "accountId": "object",
    "referenceDate": "object",
    "regenerateData": "boolean"
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "generateMonthlyAccountStatement": {}
  }
}
Statements

Generate Annual Performance Report

Create the annual performance report for an account and reference the year.

input:

(no description)

Example

Request Content-Types: application/json
Query
mutation generateAnnualPerformanceReport($input: GenerateAnnualPerformanceReportInput!){
  generateAnnualPerformanceReport(input: $input){
    accountId
    accountStatementId
    annualPerformanceReportId
  }
}
Variables
{
  "input": {
    "accountId": "object",
    "referenceDate": "object",
    "regenerateData": "boolean"
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "generateAnnualPerformanceReport": {}
  }
}
Statements

Transition Account Statement

Transition an account statement to reconciled or failed states.

input:

(no description)

Example

Request Content-Types: application/json
Query
mutation transitionAccountStatement($input: TransitionAccountStatementInput!){
  transitionAccountStatement(input: $input){
  }
}
Variables
{
  "input": {
    "accountStatementId": "object",
    "transition": "string"
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "transitionAccountStatement": {}
  }
}
Statements

Fetch Account Statement

Fetch an account statement using its ID.

accountStatementId:
object

(no description)

Example

Request Content-Types: application/json
Query
query fetchAccountStatement($accountStatementId: ObjectID!){
  fetchAccountStatement(accountStatementId: $accountStatementId){
  }
}
Variables
{}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "fetchAccountStatement": {}
  }
}
Statements

Fetch Account Statements

Fetch all available account statements as per the specified filters. An empty array will be returned if there are no statements that match the criteria. A totalCount of the statements can be included in the response.

input:

(no description)

Example

Request Content-Types: application/json
Query
query fetchAccountStatements($input: FetchAccountStatementsInput!){
  fetchAccountStatements(input: $input){
    totalCount
  }
}
Variables
{
  "input": {
    "filter": {
      "accountId": "string",
      "accountIds": [
        "string"
      ],
      "accountType": "string",
      "afterDate": "object",
      "beforeDate": "object",
      "clientGroupIds": [
        "string"
      ],
      "organizationId": "object",
      "partnerId": "string",
      "state": "string",
      "type": "string",
      "typeGroup": "string",
      "types": [
        "string"
      ],
      "userId": "string",
      "userIds": [
        "string"
      ]
    },
    "pagination": {
      "offSet": "number",
      "perPage": "number",
      "sortDesc": "boolean",
      "sortField": "object"
    }
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "fetchAccountStatements": {
      "totalCount": "integer"
    }
  }
}

Transfers

A transfer represents a transaction that moves money in or out of a sub-account. This can either be through a deposit, withdrawal or a transfer from another investment account into OneVest.

Transfers can be one-time or recurring (scheduled). These are represented as two separate objects.

1. Transfer (one time)

2. Scheduled Transfers

Some of the differences between the two is that the scheduledTransfer object contains a 'frequency' attribute that specifies when the funds should be transferred in or out, an 'endDate' and a 'scheduledDate'.

Transfers

Create Deposit Transfer

Create a one-time deposit from a bank account to a sub-account.

input:

(no description)

Example

Request Content-Types: application/json
Query
mutation createDepositTransfer($input: CreateDepositTransferInput!){
  createDepositTransfer(input: $input){
  }
}
Variables
{
  "input": {
    "amountCents": "object",
    "bankAccountId": "object",
    "currency": "string",
    "fiscalYear": "number",
    "instantInvest": "boolean",
    "requestId": "object",
    "subAccountId": "object"
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "createDepositTransfer": {}
  }
}
Transfers

Cancel Deposit Transfer

Cancel a one-time deposit to a sub-account. This requires a transfer ID.

transferId:
object

(no description)

Example

Request Content-Types: application/json
Query
mutation cancelDepositTransfer($transferId: ObjectID!){
  cancelDepositTransfer(transferId: $transferId){
  }
}
Variables
{}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "cancelDepositTransfer": {}
  }
}
Transfers

Create Withdraw Transfer

Create a one-time withdrawal from a sub-account to a bank account.

input:

(no description)

Example

Request Content-Types: application/json
Query
mutation createWithdrawTransfer($input: CreateWithdrawTransferInput!){
  createWithdrawTransfer(input: $input){
  }
}
Variables
{
  "input": {
    "amountCents": "object",
    "bankAccountId": "object",
    "currency": "string",
    "requestId": "object",
    "subAccountId": "object",
    "withdrawalMode": "string",
    "withdrawalReason": "string",
    "withdrawalReasonDescription": "object"
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "createWithdrawTransfer": {}
  }
}
Transfers

Withdraw All From Sub Account

Transfer out all funds in a sub-account to a bank account.

input:

(no description)

Example

Request Content-Types: application/json
Query
mutation withdrawAllFromSubAccount($input: WithdrawAllSubAccountInput!){
  withdrawAllFromSubAccount(input: $input){
  }
}
Variables
{
  "input": {
    "bankAccountId": "object",
    "requestId": "object",
    "subAccountId": "object"
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "withdrawAllFromSubAccount": {}
  }
}
Transfers

Withdraw All From Account

Transfer out all funds in an account to a bank account. This will trigger a withdraw all from all sub-accounts linked to this account.

input:

(no description)

Example

Request Content-Types: application/json
Query
mutation withdrawAllFromAccount($input: WithdrawAllAccountInput!){
  withdrawAllFromAccount(input: $input){
  }
}
Variables
{
  "input": {
    "accountId": "object",
    "bankAccountId": "object",
    "requestId": "object"
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "withdrawAllFromAccount": {}
  }
}
Transfers

Transfer Between Sub Accounts

Transfer some funds from one sub-account to another within the same account or a different account. All sub-accounts must belong to the same user.

input:

(no description)

Example

Request Content-Types: application/json
Query
mutation transferBetweenSubAccounts($input: TransferBetweenSubAccountsInput!){
  transferBetweenSubAccounts(input: $input){
  }
}
Variables
{
  "input": {
    "amountCents": "object",
    "fromSubAccountId": "object",
    "requestId": "object",
    "toSubAccountId": "object"
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "transferBetweenSubAccounts": {}
  }
}
Transfers

Transfer All Between Sub Accounts

Transfer all funds from one sub-account to another within the same account or a different account. All sub-accounts must belong to the same user.

input:

(no description)

Example

Request Content-Types: application/json
Query
mutation transferAllBetweenSubAccounts($input: TransferAllBetweenSubAccountsInput!){
  transferAllBetweenSubAccounts(input: $input){
  }
}
Variables
{
  "input": {
    "fromSubAccountId": "object",
    "requestId": "object",
    "toSubAccountId": "object"
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "transferAllBetweenSubAccounts": {}
  }
}
Transfers

Fetch Transfer

Fetch a transfer using its ID.

transferId:
object

(no description)

Example

Request Content-Types: application/json
Query
query fetchTransfer($transferId: ObjectID!){
  fetchTransfer(transferId: $transferId){
  }
}
Variables
{}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "fetchTransfer": {}
  }
}
Transfers

Fetch Transfers

Fetch all transfers as per the specified filters. An empty array will be returned if there are no transfers that match the criteria. A totalCount of the transfers can be included in the response.

input:

(no description)

Example

Request Content-Types: application/json
Query
query fetchTransfers($input: FetchTransfersInput!){
  fetchTransfers(input: $input){
    totalCount
  }
}
Variables
{
  "input": {
    "filter": {
      "accountId": "object",
      "accountType": "string",
      "clientGroupId": "object",
      "createdAtAfter": "object",
      "createdAtBefore": "object",
      "goalId": "object",
      "initiatedByRepresentative": "boolean",
      "organizationId": "object",
      "source": "string",
      "state": "string",
      "subAccountId": "object",
      "type": "string",
      "userId": "object",
      "userIds": [
        "object"
      ]
    },
    "pagination": {
      "offSet": "number",
      "perPage": "number",
      "sortDesc": "boolean",
      "sortField": "string"
    }
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "fetchTransfers": {
      "totalCount": "integer"
    }
  }
}
Transfers

Create Bank Account

Create a bank account object that will be used in making transfers. The bank account ID is used as a parameter when transfering funds in and out of sub-accounts.

input:

(no description)

Example

Request Content-Types: application/json
Query
mutation createBankAccount($input: CreateBankAccountInput!){
  createBankAccount(input: $input){
  }
}
Variables
{
  "input": {
    "bankAccountNumber": "object",
    "institutionNumber": "object",
    "name": "object",
    "requestId": "object",
    "transitNumber": "object",
    "userId": "object"
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "createBankAccount": {}
  }
}
Transfers

Fetch Bank Account

Fetch a bank account and its properties.

bankAccountId:
object

(no description)

Example

Request Content-Types: application/json
Query
query fetchBankAccount($bankAccountId: ObjectID!){
  fetchBankAccount(bankAccountId: $bankAccountId){
  }
}
Variables
{}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "fetchBankAccount": {}
  }
}
Transfers

Fetch Bank Accounts

Fetch bank accounts belonginging to a user, belonging to the same institution, under an organization or by the bank states.

input:

(no description)

Example

Request Content-Types: application/json
Query
query fetchBankAccounts($input: FetchBankAccountsInput!){
  fetchBankAccounts(input: $input){
    totalCount
  }
}
Variables
{
  "input": {
    "filter": {
      "institutionNumber": "string",
      "organizationId": "object",
      "state": "string",
      "userId": "object"
    },
    "pagination": {
      "offSet": "number",
      "perPage": "number",
      "sortDesc": "boolean",
      "sortField": "string"
    }
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "fetchBankAccounts": {
      "totalCount": "integer"
    }
  }
}
Transfers

Delete Bank Account

Delete a bank account. Transactions made from the deleted bank account will still be displayed.

bankAccountId:
object

(no description)

Example

Request Content-Types: application/json
Query
mutation deleteBankAccount($bankAccountId: ObjectID!){
  deleteBankAccount(bankAccountId: $bankAccountId){
  }
}
Variables
{}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "deleteBankAccount": {}
  }
}
Transfers

Transition Bank Account

Approve or reject a bank account.

input:

(no description)

Example

Request Content-Types: application/json
Query
mutation transitionBankAccount($input: TransitionBankAccountInput!){
  transitionBankAccount(input: $input){
  }
}
Variables
{
  "input": {
    "bankAccountId": "object",
    "transition": "string"
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "transitionBankAccount": {}
  }
}
Transfers

Fetch Bank Connections

Fetch bank connections that have been made by their state, date or user ID.

input:

(no description)

Example

Request Content-Types: application/json
Query
query fetchBankAccounts($input: FetchBankAccountsInput!){
  fetchBankAccounts(input: $input){
    totalCount
  }
}
Variables
{
  "input": {
    "filter": {
      "institutionNumber": "string",
      "organizationId": "object",
      "state": "string",
      "userId": "object"
    },
    "pagination": {
      "offSet": "number",
      "perPage": "number",
      "sortDesc": "boolean",
      "sortField": "string"
    }
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "fetchBankAccounts": {
      "totalCount": "integer"
    }
  }
}
Transfers

Create Scheduled Deposit Transfer

Create a recurring deposit from a bank account to a sub-account.

input:

(no description)

Example

Request Content-Types: application/json
Query
mutation createScheduledDepositTransfer($input: CreateScheduledDepositTransferInput!){
  createScheduledDepositTransfer(input: $input){
  }
}
Variables
{
  "input": {
    "amountCents": "object",
    "bankAccountId": "object",
    "currency": "string",
    "endDate": "object",
    "frequency": "string",
    "instantInvest": "boolean",
    "requestId": "object",
    "scheduledDate": "object",
    "subAccountId": "object"
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "createScheduledDepositTransfer": {}
  }
}
Transfers

Create Scheduled Withdraw Transfer

Create a recurring withdrawal from a sub-account to a bank account.

input:

(no description)

Example

Request Content-Types: application/json
Query
mutation createScheduledWithdrawTransfer($input: CreateScheduledWithdrawTransferInput!){
  createScheduledWithdrawTransfer(input: $input){
  }
}
Variables
{
  "input": {
    "amountCents": "object",
    "bankAccountId": "object",
    "currency": "string",
    "endDate": "object",
    "frequency": "string",
    "requestId": "object",
    "scheduledDate": "object",
    "subAccountId": "object",
    "withdrawalReason": "string",
    "withdrawalReasonDescription": "object"
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "createScheduledWithdrawTransfer": {}
  }
}
Transfers

Fetch Scheduled Transfers

Fetch all scheduled transfers as per the specified filters. An empty array will be returned if there are no scheduled transfers that match the criteria. A totalCount of the scheduled transfers can be included in the response.

input:

(no description)

Example

Request Content-Types: application/json
Query
query fetchScheduledTransfers($input: FetchScheduledTransfersInput!){
  fetchScheduledTransfers(input: $input){
    totalCount
  }
}
Variables
{
  "input": {
    "filter": {
      "accountId": "object",
      "bankAccountId": "object",
      "clientGroupId": "object",
      "createdAtAfter": "object",
      "createdAtBefore": "object",
      "frequency": "string",
      "goalId": "object",
      "organizationId": "object",
      "scheduledDate": "object",
      "scheduledDateAfter": "object",
      "scheduledDateBefore": "object",
      "state": "string",
      "states": [
        "string"
      ],
      "subAccountId": "object",
      "type": "string",
      "userId": "object",
      "userIds": [
        "object"
      ]
    },
    "pagination": {
      "offSet": "number",
      "perPage": "number",
      "sortDesc": "boolean",
      "sortField": "string"
    }
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "fetchScheduledTransfers": {
      "totalCount": "integer"
    }
  }
}
Transfers

Update Scheduled Transfer

Modify an existing scheduled transfer using its ID. Any new input overrides the existing data.

input:

(no description)

Example

Request Content-Types: application/json
Query
mutation updateScheduledTransfer($input: UpdateScheduledTransferInput!){
  updateScheduledTransfer(input: $input){
  }
}
Variables
{
  "input": {
    "amountCents": "object",
    "bankAccountId": "object",
    "currency": "string",
    "frequency": "string",
    "scheduledDate": "object",
    "scheduledTransferId": "object",
    "withdrawalReason": "string",
    "withdrawalReasonDescription": "object"
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "updateScheduledTransfer": {}
  }
}
Transfers

Cancel Scheduled Transfer

Delete an existing scheduled transfer using its ID.

scheduledTransferId:
object

(no description)

Example

Request Content-Types: application/json
Query
mutation cancelScheduledTransfer($scheduledTransferId: ObjectID!){
  cancelScheduledTransfer(scheduledTransferId: $scheduledTransferId){
  }
}
Variables
{}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "cancelScheduledTransfer": {}
  }
}
Transfers

Create Adjustment Transfer

Create an adjustment transfer (deposit or withdrawal) to a sub-account. An adjustment reason is required.

input:

(no description)

Example

Request Content-Types: application/json
Query
mutation createAdjustmentTransfer($input: CreateAdjustmentTransferInput!){
  createAdjustmentTransfer(input: $input){
  }
}
Variables
{
  "input": {
    "adjustmentReason": "object",
    "amountCents": "object",
    "currency": "string",
    "fiscalYear": "number",
    "requestId": "object",
    "subAccountId": "object",
    "type": "string"
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "createAdjustmentTransfer": {}
  }
}
Transfers

Create Transaction

A transaction represents a reconciled financial activity at the sub-account, account or user level (trades and transfers).

Creates a transaction of any type in a sub-account.

input:

(no description)

Example

Request Content-Types: application/json
Query
mutation createTransaction($input: CreateTransactionInput!){
  createTransaction(input: $input){
  }
}
Variables
{
  "input": {
    "currency": "string",
    "date": "object",
    "description": "object",
    "financialProductId": "object",
    "objectId": "object",
    "objectType": "string",
    "priceCents": "number",
    "quantity": "number",
    "requestId": "object",
    "subAccountId": "object",
    "type": "string",
    "valueCents": "number"
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "createTransaction": {}
  }
}
Transfers

Create Adjustment Transaction

Creates a transaction of type 'adjustment'.

input:

(no description)

Example

Request Content-Types: application/json
Query
mutation createAdjustmentTransaction($input: CreateAdjustmentTransactionInput!){
  createAdjustmentTransaction(input: $input){
  }
}
Variables
{
  "input": {
    "currency": "string",
    "date": "object",
    "description": "object",
    "requestId": "object",
    "subAccountId": "object",
    "valueCents": "number"
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "createAdjustmentTransaction": {}
  }
}
Transfers

Update Transaction

Modify an existing transaction.

input:

(no description)

Example

Request Content-Types: application/json
Query
mutation updateTransaction($input: UpdateTransactionInput!){
  updateTransaction(input: $input){
  }
}
Variables
{
  "input": {
    "currency": "string",
    "date": "object",
    "description": "object",
    "financialProductId": "object",
    "priceCents": "number",
    "quantity": "number",
    "transactionId": "object",
    "valueCents": "number"
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "updateTransaction": {}
  }
}
Transfers

Delete Transaction

Delete an existing transaction using its ID.

transactionId:
object

(no description)

Example

Request Content-Types: application/json
Query
mutation deleteTransaction($transactionId: ObjectID!){
  deleteTransaction(transactionId: $transactionId){
  }
}
Variables
{}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "deleteTransaction": {}
  }
}
Transfers

Fetch Transaction

Fetch a transaction and its properties using the transaction ID.

transactionId:
object

(no description)

Example

Request Content-Types: application/json
Query
query fetchTransaction($transactionId: ObjectID!){
  fetchTransaction(transactionId: $transactionId){
  }
}
Variables
{}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "fetchTransaction": {}
  }
}
Transfers

Fetch Transactions

Fetch a list of transactions and their properties based on type, account type, dates, IDs (financial products, organizations, user, users, goal, sub-accounts).

input:

(no description)

Example

Request Content-Types: application/json
Query
query fetchTransactions($input: FetchTransactionsInput!){
  fetchTransactions(input: $input){
    totalCount
  }
}
Variables
{
  "input": {
    "filter": {
      "accountIds": [
        "object"
      ],
      "accountType": "string",
      "clientGroupId": "object",
      "currency": "string",
      "dateAfter": "object",
      "dateBefore": "object",
      "financialProductIds": [
        "object"
      ],
      "goalIds": [
        "object"
      ],
      "organizationId": "object",
      "subAccountIds": [
        "object"
      ],
      "types": [
        "string"
      ],
      "userId": "object",
      "userIds": [
        "object"
      ]
    },
    "pagination": {
      "offSet": "number",
      "perPage": "number",
      "sortDesc": "boolean",
      "sortField": "string"
    }
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "fetchTransactions": {
      "totalCount": "integer"
    }
  }
}
Transfers

Create External Transfer

Create a transfer from an external investment institution to a sub-account. This is one of the manual process types and not a regular transfer since different variables are required such as relinquishing institution' details (name, address), transfer method, the account type being transferred and the account number.

input:

(no description)

Example

Request Content-Types: application/json
Query
mutation createExternalTransfer($input: CreateExternalTransferInput!){
  createExternalTransfer(input: $input){
  }
}
Variables
{
  "input": {
    "amountCents": "number",
    "bctesgAmountCents": "number",
    "clbAmountCents": "number",
    "createdByUserId": "object",
    "institution": {
      "id": "object",
      "name": "object",
      "physicalAddress": {
        "city": "object",
        "country": "string",
        "houseNumber": "object",
        "jurisdiction": "string",
        "neighborhood": "object",
        "postal": "object",
        "province": "string",
        "streetName": "object",
        "unitNumber": "object"
      }
    },
    "requestIpAddress": "object",
    "subAccountId": "object",
    "transferAccount": "string",
    "transferAccountNumber": "object",
    "transferMethod": "string"
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "createExternalTransfer": {}
  }
}
Transfers

Fetch Manual Process

Fetch a manual process type such as an external transfer or close accounts.

id:
string

(no description)

Example

Request Content-Types: application/json
Query
query fetchManualProcess($id: ID!){
  fetchManualProcess(id: $id){
  }
}
Variables
{
  "id": "string"
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "fetchManualProcess": {}
  }
}
Transfers

Transition Manual Process

Cancel, fail, process or reconcile a manual process.

input:

(no description)

Example

Request Content-Types: application/json
Query
mutation transitionManualProcess($input: TransitionManualProcessInput!){
  transitionManualProcess(input: $input){
  }
}
Variables
{
  "input": {
    "manualProcessId": "object",
    "transition": "string"
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "transitionManualProcess": {}
  }
}
Transfers

Transition Transfer

Transition a transfer to states such as canceled, failed, initiated, processing, ready, reconciled, requesuested or reviewed.

input:

(no description)

Example

Request Content-Types: application/json
Query
mutation transitionTransfer($input: TransitionTransferInput!){
  transitionTransfer(input: $input){
  }
}
Variables
{
  "input": {
    "failReason": "object",
    "transferId": "object",
    "transition": "string"
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "transitionTransfer": {}
  }
}
Transfers

Create Institution

Create an institution that will be used in the external transfer process by providing the name and address.

input:

(no description)

Example

Request Content-Types: application/json
Query
mutation createInstitution($input: CreateInstitutionInput!){
  createInstitution(input: $input){
  }
}
Variables
{
  "input": {
    "isDraft": "boolean",
    "name": "object",
    "physicalAddress": {
      "city": "object",
      "country": "string",
      "houseNumber": "object",
      "jurisdiction": "string",
      "neighborhood": "object",
      "postal": "object",
      "province": "string",
      "streetName": "object",
      "unitNumber": "object"
    }
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "createInstitution": {}
  }
}
Transfers

Update Institution

Modify an existing institution using its ID.

input:

(no description)

Example

Request Content-Types: application/json
Query
mutation updateInstitution($input: UpdateInstitutionInput!){
  updateInstitution(input: $input){
  }
}
Variables
{
  "input": {
    "id": "object",
    "name": "object",
    "physicalAddress": {
      "city": "object",
      "country": "string",
      "houseNumber": "object",
      "neighborhood": "object",
      "postal": "object",
      "province": "string",
      "streetName": "object",
      "unitNumber": "object"
    }
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "updateInstitution": {}
  }
}
Transfers

Delete Institution

Delete an existing institution.

input:

(no description)

Example

Request Content-Types: application/json
Query
mutation deleteInstitution($input: DeleteInstitutionInput!){
  deleteInstitution(input: $input){
  }
}
Variables
{
  "input": {
    "id": "object"
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "deleteInstitution": {}
  }
}
Transfers

Fetch Institution

Fetch the institution used in the creation of an account transfer from an external investment institution.

id:
string

(no description)

Example

Request Content-Types: application/json
Query
query fetchInstitution($id: ID!){
  fetchInstitution(id: $id){
  }
}
Variables
{
  "id": "string"
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "fetchInstitution": {}
  }
}
Transfers

Fetch Institutions

Fetch a list of institutions that can be used in the creation of an account transfer from an external investment institution. One can search for institutions using any string as provided in the input.

input:

(no description)

Example

Request Content-Types: application/json
Query
query fetchInstitutions($input: FetchInstitutionsInput!){
  fetchInstitutions(input: $input){
    totalCount
  }
}
Variables
{
  "input": {
    "filter": {
      "searchText": "string",
      "state": "string"
    },
    "pagination": {
      "offSet": "number",
      "perPage": "number",
      "sortDesc": "boolean",
      "sortField": "string"
    }
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "fetchInstitutions": {
      "totalCount": "integer"
    }
  }
}
Transfers

Fetch Alert Report

The Report object contains transfers that have been flagged as suspicious based on the rules set in the system. Fetch a suspicious transaction by the report ID or transfer ID.

input:

(no description)

Example

Request Content-Types: application/json
Query
query fetchAlertReport($input: FetchAlertReportInput!){
  fetchAlertReport(input: $input){
  }
}
Variables
{
  "input": {
    "reportId": "object",
    "transferId": "object"
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "fetchAlertReport": {}
  }
}
Transfers

Fetch Alert Reports

Fetch a list of suspicious transactions by date, state, transfer types or IDs, or sub-account IDs.

input:

(no description)

Example

Request Content-Types: application/json
Query
query fetchAlertReports($input: FetchAlertReportsInput!){
  fetchAlertReports(input: $input){
    totalCount
  }
}
Variables
{
  "input": {
    "filter": {
      "createdAtAfter": "object",
      "createdAtBefore": "object",
      "organizationId": "object",
      "state": "string",
      "subAccountId": "object",
      "transferId": "object",
      "transferType": "string"
    },
    "pagination": {
      "offSet": "number",
      "perPage": "number",
      "sortDesc": "boolean",
      "sortField": "string"
    }
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "fetchAlertReports": {
      "totalCount": "integer"
    }
  }
}
Transfers

Update Fraud Risk

Modify the risk rating and score of a user. Also need to provide the reason why the fraud risk has been changed.

input:

(no description)

Example

Request Content-Types: application/json
Query
mutation updateFraudRisk($input: UpdateFraudRiskInput!){
  updateFraudRisk(input: $input){
  }
}
Variables
{
  "input": {
    "fraudRiskId": "object",
    "lastUpdatedBy": "object",
    "notes": "object",
    "riskReasons": [
      {
        "name": "string"
      }
    ],
    "score": "number"
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "updateFraudRisk": {}
  }
}
Transfers

Reassess Fraud Risk

Regenerate a user's risk rating and score of a user.

input:

(no description)

Example

Request Content-Types: application/json
Query
mutation reAssessFraudRisk($input: ReAssessFraudRiskInput!){
  reAssessFraudRisk(input: $input){
  }
}
Variables
{
  "input": {
    "userId": "object"
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "reAssessFraudRisk": {}
  }
}
Transfers

Fetch Fraud Risk

Fetch the risk rating and score of a user and the reasons why the risk rating has been applied.

input:

(no description)

Example

Request Content-Types: application/json
Query
query fetchFraudRisk($input: FetchFraudRiskInput!){
  fetchFraudRisk(input: $input){
  }
}
Variables
{
  "input": {
    "fraudRiskId": "object",
    "userId": "object"
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "fetchFraudRisk": {}
  }
}

Investment Products

This represents the various objects used in the portfolio management of accounts.

Investment Products

Create Model Portfolio

A model portfolio represents the bucket in which funds in a sub-account are invested in based on the risk tolerance of a user e.g. high risk core portfolio or low risk halal.

Create a model portfolio and set its properties.

input:

(no description)

Example

Request Content-Types: application/json
Query
mutation createModelPortfolio($input: CreateModelPortfolioInput!){
  createModelPortfolio(input: $input){
  }
}
Variables
{
  "input": {
    "forecastedRateOfReturn": "number",
    "forecastedStandardDeviation": "number",
    "lowThresholdScore": "number",
    "organizationId": "object",
    "riskReturnLevel": "number",
    "scheduleId": "object",
    "suggestable": "boolean",
    "suggestedMaxScore": "number",
    "suggestedMinScore": "number",
    "targetAllocations": [
      {
        "max": "number",
        "min": "number",
        "secondaryAssetClassId": "object"
      }
    ],
    "themeId": "object",
    "translatedInvestmentObjective": {
      "en": "object",
      "fr": "object"
    },
    "translatedLiquidity": {
      "en": "object",
      "fr": "object"
    },
    "translatedName": {
      "en": "object",
      "fr": "object"
    },
    "translatedPortfolioDescription": {
      "en": "object",
      "fr": "object"
    },
    "translatedPortfolioDisclaimer": {
      "en": "object",
      "fr": "object"
    },
    "url": "string"
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "createModelPortfolio": {}
  }
}
Investment Products

Transition Model Portfolio

Activate, archive or return a model portfolio to the draft state.

input:

(no description)

Example

Request Content-Types: application/json
Query
mutation transitionModelPortfolio($input: TransitionModelPortfolioInput!){
  transitionModelPortfolio(input: $input){
  }
}
Variables
{
  "input": {
    "modelPortfolioId": "object",
    "transition": "string"
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "transitionModelPortfolio": {}
  }
}
Investment Products

Update Model Portfolio

Modify a model portfolio

input:

(no description)

Example

Request Content-Types: application/json
Query
mutataion updateModelPortfolio($input: UpdateModelPortfolioInput!){
  updateModelPortfolio(input: $input){
  }
}
Variables
{
  "input": {
    "children": [
      {
        "financialProductId": "object",
        "isCashEquivalent": "boolean",
        "percentage": "number"
      }
    ],
    "forecastedRateOfReturn": "number",
    "forecastedStandardDeviation": "number",
    "lowThresholdScore": "number",
    "modelPortfolioId": "object",
    "reasonForUpdate": "object",
    "riskReturnLevel": "number",
    "scheduleId": "object",
    "suggestable": "boolean",
    "suggestedMaxScore": "number",
    "suggestedMinScore": "number",
    "targetAllocations": [
      {
        "max": "number",
        "min": "number",
        "secondaryAssetClassId": "object"
      }
    ],
    "themeId": "object",
    "translatedInvestmentObjective": {
      "en": "object",
      "fr": "object"
    },
    "translatedLiquidity": {
      "en": "object",
      "fr": "object"
    },
    "translatedName": {
      "en": "object",
      "fr": "object"
    },
    "translatedPortfolioDescription": {
      "en": "object",
      "fr": "object"
    },
    "translatedPortfolioDisclaimer": {
      "en": "object",
      "fr": "object"
    },
    "url": "string"
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "updateModelPortfolio": {}
  }
}
Investment Products

Fetch Model Portfolio

Fetch a model portfolio by its ID.

input:

(no description)

Example

Request Content-Types: application/json
Query
query fetchModelPortfolio($input: FetchModelPortfolioInput!){
  fetchModelPortfolio(input: $input){
  }
}
Variables
{
  "input": {
    "modelPortfolioId": "object"
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "fetchModelPortfolio": {}
  }
}
Investment Products

Fetch Model Portfolios

Fetch a list of model portfolios using the specified filters such as state, those that are suggestable or those available to an organization.

input:

(no description)

Example

Request Content-Types: application/json
Query
query fetchModelPortfolios($input: FetchModelPortfoliosInput!){
  fetchModelPortfolios(input: $input){
    totalCount
  }
}
Variables
{
  "input": {
    "filter": {
      "organizationId": "object",
      "state": "string",
      "suggestable": "boolean",
      "themeId": "object",
      "themeIds": [
        "object"
      ]
    },
    "pagination": {
      "offset": "number",
      "perPage": "number",
      "sortDesc": "boolean",
      "sortField": "string"
    }
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "fetchModelPortfolios": {
      "totalCount": "integer"
    }
  }
}
Investment Products

Create Financial Product

Financial products represent the individual securities that can be traded in a sub-account e.g.iShares Global Real Estate Index ETF.

Create a financial product and set its properties.

input:

(no description)

Example

Request Content-Types: application/json
Query
mutation createFinancialProduct($input: CreateFinancialProductInput!){
  createFinancialProduct(input: $input){
  }
}
Variables
{
  "input": {
    "autoUpdatePrices": "boolean",
    "currency": "string",
    "cusip": "string",
    "exchange": "string",
    "integrations": [
      {
        "externalId": "object",
        "groupId": "object",
        "iid": "object",
        "type": "string"
      }
    ],
    "isPartial": "boolean",
    "isin": "string",
    "organizationId": "object",
    "primaryAssetClassId": "object",
    "ric": "string",
    "riskProfileDescription": {
      "en": "object",
      "fr": "object"
    },
    "riskProfileName": {
      "en": "object",
      "fr": "object"
    },
    "scheduleId": "object",
    "secondaryAssetClassId": "object",
    "settlementDays": "number",
    "substituteFinancialProductId": "object",
    "taxRank": "number",
    "tertiaryAssetClassId": "object",
    "ticker": "object",
    "translatedName": {
      "en": "object",
      "fr": "object"
    },
    "url": "string",
    "volatile": "boolean",
    "waivedFeePercentage": "number"
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "createFinancialProduct": {}
  }
}
Investment Products

Fetch Financial Product

Fetch a financial product and its properties using its ID.

input:

(no description)

Example

Request Content-Types: application/json
Query
query fetchFinancialProduct($input: FetchFinancialProductInput!){
  fetchFinancialProduct(input: $input){
  }
}
Variables
{
  "input": {
    "financialProductId": "object"
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "fetchFinancialProduct": {}
  }
}
Investment Products

Fetch Financial Products

Fetch a list of financial products as per the specified filters.

input:

(no description)

Example

Request Content-Types: application/json
Query
query fetchFinancialProducts($input: FetchFinancialProductsInput!){
  fetchFinancialProducts(input: $input){
    totalCount
  }
}
Variables
{
  "input": {
    "filter": {
      "autoUpdatePrices": "boolean",
      "currency": "string",
      "exchange": "string",
      "hasSubstituteProduct": "boolean",
      "isScheduled": "boolean",
      "name": "string",
      "organizationId": "object",
      "primaryAssetClassId": "object",
      "searchText": "string",
      "secondaryAssetClassId": "object",
      "state": "string",
      "tertiaryAssetClassId": "object",
      "themeId": "object"
    },
    "pagination": {
      "offset": "number",
      "perPage": "number",
      "sortDesc": "boolean",
      "sortField": "string"
    }
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "fetchFinancialProducts": {
      "totalCount": "integer"
    }
  }
}
Investment Products

Transition Financial Product

Activate, archive or return a financial product to the draft state.

input:

(no description)

Example

Request Content-Types: application/json
Query
mutation transitionFinancialProduct($input: TransitionFinancialProductInput!){
  transitionFinancialProduct(input: $input){
  }
}
Variables
{
  "input": {
    "financialProductId": "object",
    "transition": "string"
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "transitionFinancialProduct": {}
  }
}
Investment Products

Update Financial Product

Modify a financial product.

input:

(no description)

Example

Request Content-Types: application/json
Query
mutataion updateFinancialProduct($input: UpdateFinancialProductInput!){
  updateFinancialProduct(input: $input){
  }
}
Variables
{
  "input": {
    "autoUpdatePrices": "boolean",
    "currency": "string",
    "currentPriceCents": "number",
    "cusip": "string",
    "exchange": "string",
    "financialProductId": "object",
    "integrations": [
      {
        "externalId": "object",
        "groupId": "object",
        "iid": "object",
        "type": "string"
      }
    ],
    "isPartial": "boolean",
    "isin": "string",
    "primaryAssetClassId": "object",
    "ric": "string",
    "riskProfileDescription": {
      "en": "object",
      "fr": "object"
    },
    "riskProfileName": {
      "en": "object",
      "fr": "object"
    },
    "scheduleId": "object",
    "secondaryAssetClassId": "object",
    "settlementDays": "number",
    "substituteFinancialProductId": "object",
    "taxRank": "number",
    "tertiaryAssetClassId": "object",
    "ticker": "object",
    "translatedName": {
      "en": "object",
      "fr": "object"
    },
    "url": "string",
    "volatile": "boolean",
    "waivedFeePercentage": "number"
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "updateFinancialProduct": {}
  }
}
Investment Products

Create Theme

The themes object represents the distinct classification of financial products based on users' preferences e.g. Core, Halal. A theme is assigned during the creation of a sub-account. Users can have as many themes as sub-accounts as long as they qualify for them.

Create a theme that can be assigned to sub-accounts in an organization.

input:

(no description)

Example

Request Content-Types: application/json
Query
mutation createTheme($input: CreateThemeInput!){
  createTheme(input: $input){
  }
}
Variables
{
  "input": {
    "core": "boolean",
    "iconKey": "object",
    "key": "object",
    "organizationId": "object",
    "translatedDescription": {
      "en": "object",
      "fr": "object"
    },
    "translatedName": {
      "en": "object",
      "fr": "object"
    },
    "translatedShortDescription": {
      "en": "object",
      "fr": "object"
    }
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "createTheme": {}
  }
}
Investment Products

Update Theme

Modify an existing theme.

input:

(no description)

Example

Request Content-Types: application/json
Query
mutation updateTheme($input: UpdateThemeInput!){
  updateTheme(input: $input){
  }
}
Variables
{
  "input": {
    "core": "boolean",
    "iconKey": "object",
    "key": "object",
    "themeId": "object",
    "translatedDescription": {
      "en": "object",
      "fr": "object"
    },
    "translatedName": {
      "en": "object",
      "fr": "object"
    },
    "translatedShortDescription": {
      "en": "object",
      "fr": "object"
    }
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "updateTheme": {}
  }
}
Investment Products

Fetch Theme

Fetch the theme associated with a sub-account.

themeId:
object

(no description)

Example

Request Content-Types: application/json
Query
query fetchTheme($themeId: ObjectID!){
  fetchTheme(themeId: $themeId){
  }
}
Variables
{}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "fetchTheme": {}
  }
}
Investment Products

Fetch Themes

Fetch all the available themes. A theme ID is required during the creation of a sub-account. If none is provided, then a null theme is returned when creating a sub-account.

input:

(no description)

Example

Request Content-Types: application/json
Query
query fetchThemes($input: FetchThemesInput!){
  fetchThemes(input: $input){
    totalCount
  }
}
Variables
{
  "input": {
    "filter": {
      "core": "boolean",
      "keys": [
        "object"
      ],
      "organizationId": "object"
    },
    "pagination": {
      "offset": "number",
      "perPage": "number",
      "sortDesc": "boolean",
      "sortField": "string"
    }
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "fetchThemes": {
      "totalCount": "integer"
    }
  }
}
Investment Products

Create Asset Class

Creates an asset class that will be available to an organization.

input:

(no description)

Example

Request Content-Types: application/json
Query
mutation createAssetClass($input: CreateAssetClassInput!){
  createAssetClass(input: $input){
  }
}
Variables
{
  "input": {
    "includeCash": "boolean",
    "key": "object",
    "organizationId": "object",
    "translatedDescription": {
      "en": "object",
      "fr": "object"
    },
    "translatedName": {
      "en": "object",
      "fr": "object"
    }
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "createAssetClass": {}
  }
}
Investment Products

Update Asset Classes

Modify an existing asset class.

input:

(no description)

Example

Request Content-Types: application/json
Query
mutation updateAssetClass($input: UpdateAssetClassInput!){
  updateAssetClass(input: $input){
  }
}
Variables
{
  "input": {
    "assetClassId": "object",
    "includeCash": "boolean",
    "key": "object",
    "translatedDescription": {
      "en": "object",
      "fr": "object"
    },
    "translatedName": {
      "en": "object",
      "fr": "object"
    }
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "updateAssetClass": {}
  }
}
Investment Products

Fetch Asset Classes

Fetch the asset classes available to an organization.

input:

(no description)

Example

Request Content-Types: application/json
Query
query fetchAssetClasses($input: FetchAssetClassesInput){
  fetchAssetClasses(input: $input){
  }
}
Variables
{
  "input": {
    "filter": {
      "organizationId": "object"
    }
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "fetchAssetClasses": {}
  }
}
Investment Products

Create Trade

The trades object represents an entry of either buying or selling a security at the account level.

Creates a trade in a sub-account. The required attributes include quantity, trade price and whether it is a buy or sale.

input:

(no description)

Example

Request Content-Types: application/json
Query
mutation createTrade($input: CreateTradeInput!){
  createTrade(input: $input){
  }
}
Variables
{
  "input": {
    "actualQuantity": "number",
    "actualTradePriceCents": "number",
    "createExternalTransfer": "boolean",
    "description": "object",
    "effectiveDate": "object",
    "financialProductId": "object",
    "subAccountId": "object",
    "type": "string"
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "createTrade": {}
  }
}
Investment Products

Transition Trade

Transition a trade to states such as canceled, failed, processing, reconciled or cancel reconciled. If a trade is failed, a fail reason should be provided.

input:

(no description)

Example

Request Content-Types: application/json
Query
mutation transitionTrade($input: TransitionTradeInput!){
  transitionTrade(input: $input){
  }
}
Variables
{
  "input": {
    "failReason": "object",
    "tradeId": "object",
    "transition": "string"
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "transitionTrade": {}
  }
}
Investment Products

Fetch Trades

Fetch all trades that have been attempted as per the specified filters.

input:

(no description)

Example

Request Content-Types: application/json
Query
query fetchTrades($input: FetchTradesInput!){
  fetchTrades(input: $input){
    totalCount
  }
}
Variables
{
  "input": {
    "filter": {
      "accountId": "object",
      "clientGroupId": "object",
      "createdAtAfter": "object",
      "createdAtBefore": "object",
      "financialProductId": "object",
      "organizationId": "object",
      "rebalanceId": "object",
      "tradeState": "string",
      "userId": "object",
      "userIds": [
        "object"
      ]
    },
    "pagination": {
      "offSet": "number",
      "perPage": "number",
      "sortDesc": "boolean",
      "sortField": "string"
    }
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "fetchTrades": {
      "totalCount": "integer"
    }
  }
}
Investment Products

Fetch Sub Trades

The sub trades object represents an entry of either buying or selling a security at the sub-account level. The endpoint fetches all sub-trades that have been attempted as per the specified filters.

input:

(no description)

Example

Request Content-Types: application/json
Query
query fetchSubTrades($input: FetchSubTradesInput!){
  fetchSubTrades(input: $input){
    totalCount
  }
}
Variables
{
  "input": {
    "filter": {
      "clientGroupId": "object",
      "createdAtAfter": "object",
      "createdAtBefore": "object",
      "financialProductId": "object",
      "goalId": "object",
      "organizationId": "object",
      "rebalanceId": "object",
      "subAccountId": "object",
      "subTradeState": "string",
      "tradeId": "object",
      "userId": "object"
    },
    "pagination": {
      "offSet": "number",
      "perPage": "number",
      "sortDesc": "boolean",
      "sortField": "string"
    }
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "fetchSubTrades": {
      "totalCount": "integer"
    }
  }
}
Investment Products

Calculate Withdraw Fees

The withdraw fees object represents the type and amount of fees charged for any withdrawal transactions from the RRSP account. The endpoint fetches the fees to be charged for a withdrawal from an RRSP.

input:

(no description)

Example

Request Content-Types: application/json
Query
query calculateWithdrawFees($input: CalculateWithdrawFeesInput!){
  calculateWithdrawFees(input: $input){
  }
}
Variables
{
  "input": {
    "accountId": "object",
    "amountCents": "number",
    "isfullWithdraw": "boolean",
    "net": "boolean"
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "calculateWithdrawFees": {}
  }
}
Investment Products

Fetch Account Fee

The account fee object represents fees and taxes charged to accounts. Fetch fees by account ID.

accountFeeId:
object

(no description)

Example

Request Content-Types: application/json
Query
query fetchAccountFee($accountFeeId: ObjectID!){
  fetchAccountFee(accountFeeId: $accountFeeId){
  }
}
Variables
{}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "fetchAccountFee": {}
  }
}
Investment Products

Fetch Account Fees

Fetch fees by date, state, organization, account or organization ID.

input:

(no description)

Example

Request Content-Types: application/json
Query
query fetchAccountFees($input: FetchAccountFeesInput!){
  fetchAccountFees(input: $input){
    totalCount
  }
}
Variables
{
  "input": {
    "filter": {
      "accountId": "object",
      "organizationId": "object",
      "referenceDate": "object",
      "referenceDateAfter": "object",
      "referenceDateBefore": "object",
      "state": "string"
    },
    "pagination": {
      "offSet": "number",
      "perPage": "number",
      "sortDesc": "boolean",
      "sortField": "string"
    }
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "fetchAccountFees": {
      "totalCount": "integer"
    }
  }
}
Investment Products

Transition Account Fees

Transition account fees to states such as canceled, failed, reconciled or requested.

input:

(no description)

Example

Request Content-Types: application/json
Query
mutation transitionAccountFee($input: TransitionAccountFeeInput!){
  transitionAccountFee(input: $input){
  }
}
Variables
{
  "input": {
    "accountFeeId": "object",
    "transition": "string"
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "transitionAccountFee": {}
  }
}
Investment Products

Fetch History

Fetch the financial history including the financial products held at the user, goal, sub-account and account level.

input:

(no description)

Example

Request Content-Types: application/json
Query
query fetchHistory($input: FetchHistoryInput!){
  fetchHistory(input: $input){
    history
  }
}
Variables
{
  "input": {
    "afterDate": "object",
    "beforeDate": "object",
    "id": "object",
    "type": "string"
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "fetchHistory": {
      "history": [
        null
      ]
    }
  }
}
Investment Products

Publish History

Manually publish the financial history of a user, goal, sub-account and account.

input:

(no description)

Example

Request Content-Types: application/json
Query
mutation publishHistory($input: PublishHistoryInput!){
  publishHistory(input: $input)
}
Variables
{
  "input": {
    "accountId": "object",
    "endDate": "object",
    "goalId": "object",
    "organizationId": "object",
    "startDate": "object",
    "subAccountId": "object",
    "userId": "object"
  }
}
Try it now
200 OK

Successful operation

type
boolean
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "publishHistory": "boolean"
  }
}
Investment Products

Fetch Stats History

Fetch the daily snapshots of any financial activity that has happened in a user's profile, goal, account or sub-account.

input:

(no description)

Example

Request Content-Types: application/json
Query
query fetchStatsHistory($input: FetchStatsHistoryInput!){
  fetchStatsHistory(input: $input){
    totalCount
  }
}
Variables
{
  "input": {
    "currency": "string",
    "filter": {
      "accountType": "string",
      "afterDate": "object",
      "beforeDate": "object",
      "includeAllHouseholds": "boolean",
      "modelPortfolioId": "object",
      "userId": "object"
    },
    "id": "object",
    "pagination": {
      "offSet": "number",
      "perPage": "number",
      "sortDesc": "boolean",
      "sortField": "string"
    },
    "type": "string"
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "fetchStatsHistory": {
      "totalCount": "integer"
    }
  }
}
Investment Products

Fetch Mismatched Accounts Daily

The accounts daily object contains summarized statistics on an account on a daily basis. Fetch the statistics of any account using the date or the difference in market value.

input:

(no description)

Example

Request Content-Types: application/json
Query
query fetchMismatchedAccountsDaily($input: FetchMismatchedAccountsDailyInput!){
  fetchMismatchedAccountsDaily(input: $input){
  }
}
Variables
{
  "input": {
    "date": "object",
    "marketValueCentsDiff": "number"
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "fetchMismatchedAccountsDaily": {}
  }
}

Trading

This represents the process by which securities are traded.

Trading

Rebalance Sub-Accounts

Rebalance sub-accounts in an organization.

input:

(no description)

Example

Request Content-Types: application/json
Query
mutation rebalanceSubAccounts($input: RebalanceSubAccountsInput){
  rebalanceSubAccounts(input: $input){
  }
}
Variables
{
  "input": {
    "full": "boolean",
    "organizationId": "object",
    "v2": "boolean"
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "rebalanceSubAccounts": {}
  }
}
Trading

Transition Rebalance

Transition an existing rebalance to states such as initiate, cancel or complete.

input:

(no description)

Example

Request Content-Types: application/json
Query
mutation transitionRebalance($input: TransitionRebalanceInput!){
  transitionRebalance(input: $input){
  }
}
Variables
{
  "input": {
    "rebalanceId": "object",
    "transition": "string"
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "transitionRebalance": {}
  }
}
Trading

Trigger Auto Bulk Trades

Auto-generate the bulk trades during rebalancing.

input:

(no description)

Example

Request Content-Types: application/json
Query
mutation triggerAutoBulkTrades($input: TriggerAutoBulkTradesInput!){
  triggerAutoBulkTrades(input: $input){
  }
}
Variables
{
  "input": {
    "rebalanceId": "object"
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "triggerAutoBulkTrades": {}
  }
}
Trading

Update Price and Quantity

Modify the price and quantity of bulk trades during rebalancing.

input:

(no description)

Example

Request Content-Types: application/json
Query
mutation updatePriceAndQuantity($input: UpdatePriceAndQuantityInput!){
  updatePriceAndQuantity(input: $input){
    success
  }
}
Variables
{
  "input": {
    "bulkTrades": [
      {
        "actualPriceCents": "number",
        "financialProductId": "object",
        "totalQuantity": "number"
      }
    ],
    "currencyFallbackConversions": [
      {
        "from": "string",
        "rate": "number",
        "to": "string"
      }
    ],
    "rebalanceId": "object",
    "type": "string"
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "updatePriceAndQuantity": {
      "success": "boolean"
    }
  }
}
Trading

Fetch Rebalance

Fetch any property of a rebalance.

rebalanceId:
object

(no description)

Example

Request Content-Types: application/json
Query
query fetchRebalance($rebalanceId: ObjectID!){
  fetchRebalance(rebalanceId: $rebalanceId){
  }
}
Variables
{}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "fetchRebalance": {}
  }
}
Trading

Fetch Rebalances

Fetch a list of rebalances and their properties based on the organization ID.

input:

(no description)

Example

Request Content-Types: application/json
Query
query fetchRebalances($input: FetchRebalancesInput!){
  fetchRebalances(input: $input){
    totalCount
  }
}
Variables
{
  "input": {
    "filter": {
      "organizationId": "object",
      "state": "string"
    },
    "pagination": {
      "offSet": "number",
      "perPage": "number",
      "sortDesc": "boolean",
      "sortField": "string"
    }
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "fetchRebalances": {
      "totalCount": "integer"
    }
  }
}
Trading

Fetch Rebalance Holding Reports

Fetch the rebalance properties of a subaccount such as value of trade, quantity of securities, the goal/account/user properties the subaccount is associated to.

input:

(no description)

Example

Request Content-Types: application/json
Query
query fetchRebalanceHoldingReports($input: FetchRebalanceHoldingReportsInput!){
  fetchRebalanceHoldingReports(input: $input){
    totalCount
  }
}
Variables
{
  "input": {
    "filter": {
      "subAccountId": "object"
    },
    "pagination": {
      "offSet": "number",
      "perPage": "number",
      "sortDesc": "boolean",
      "sortField": "string"
    }
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "fetchRebalanceHoldingReports": {
      "totalCount": "integer"
    }
  }
}
Trading

Calculate Pre Rebalance Metrics

Calculate the metrics associated with a rebalance before one has been triggered. The organization ID is required.

input:

(no description)

Example

Request Content-Types: application/json
Query
mutation calculatePreRebalanceMetrics($input: CalculatePreRebalanceMetricsInput!){
  calculatePreRebalanceMetrics(input: $input){
  }
}
Variables
{
  "input": {
    "full": "boolean",
    "organizationId": "object"
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "calculatePreRebalanceMetrics": {}
  }
}
Trading

Calculate Post Rebalance Metrics

Calculate the metrics associated with a rebalance after one has been triggered. A rebalance ID is required.

input:

(no description)

Example

Request Content-Types: application/json
Query
mutation calculatePostRebalanceMetrics($input: CalculatePostRebalanceMetricsInput!){
  calculatePostRebalanceMetrics(input: $input){
  }
}
Variables
{
  "input": {
    "rebalanceId": "object"
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "calculatePostRebalanceMetrics": {}
  }
}
Trading

Fetch Rebalance Metrics

Fetch the metrics associated with a rebalance such as number of accounts impacted, quantity of securities to be bought or sold, whether the numbers are generated pre or post a rebalance.

input:

(no description)

Example

Request Content-Types: application/json
Query
query fetchRebalanceMetrics($input: FetchRebalanceMetricsInput!){
  fetchRebalanceMetrics(input: $input){
  }
}
Variables
{
  "input": {
    "rebalanceMetricsId": "object"
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "fetchRebalanceMetrics": {}
  }
}
Trading

Fetch Rebalance Reports

Fetch a rebalancing report based on filters such as account IDs, account type, rebalance type, model portfolios or subaccount IDs.

input:

(no description)

Example

Request Content-Types: application/json
Query
query fetchRebalanceReports($input: FetchRebalanceReportsInput!){
  fetchRebalanceReports(input: $input){
    totalCount
  }
}
Variables
{
  "input": {
    "filter": {
      "accountIds": [
        "object"
      ],
      "accountType": "string",
      "contributionOnly": "boolean",
      "full": "boolean",
      "modelPortfolioIds": [
        "object"
      ],
      "organizationId": "object",
      "rebalanceType": "string",
      "subAccountIds": [
        "object"
      ]
    },
    "pagination": {
      "offSet": "number",
      "perPage": "number",
      "sortDesc": "boolean",
      "sortField": "string"
    }
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "fetchRebalanceReports": {
      "totalCount": "integer"
    }
  }
}
Trading

Create Schedule

Create a schedule to trigger rebalancing at the organization level.

input:

(no description)

Example

Request Content-Types: application/json
Query
mutation createSchedule($input: CreateScheduleInput!){
  createSchedule(input: $input){
  }
}
Variables
{
  "input": {
    "dates": [
      "object"
    ],
    "name": "object",
    "organizationId": "object"
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "createSchedule": {}
  }
}
Trading

Update Schedule

Modify an existing schedule.

input:

(no description)

Example

Request Content-Types: application/json
Query
mutation updateSchedule($input: UpdateScheduleInput!){
  updateSchedule(input: $input){
  }
}
Variables
{
  "input": {
    "dates": [
      "object"
    ],
    "name": "object",
    "scheduleId": "object"
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "updateSchedule": {}
  }
}
Trading

Fetch Schedule

Fetch the schedule properties such as dates and financial products based on its ID.

scheduleId:
object

(no description)

Example

Request Content-Types: application/json
Query
query fetchSchedule($scheduleId: ObjectID!){
  fetchSchedule(scheduleId: $scheduleId){
  }
}
Variables
{}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "fetchSchedule": {}
  }
}
Trading

Fetch Schedules

Fetch a list of schedules in an organization.

input:

(no description)

Example

Request Content-Types: application/json
Query
query fetchSchedules($input: FetchSchedulesInput){
  fetchSchedules(input: $input){
    totalCount
  }
}
Variables
{
  "input": {
    "filter": {
      "organizationId": "object"
    },
    "pagination": {
      "offset": "number",
      "perPage": "number",
      "sortDesc": "boolean",
      "sortField": "string"
    }
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "fetchSchedules": {
      "totalCount": "integer"
    }
  }
}
Trading

Create Bulk Trade Request

Creates a request to make trades in bulk. Need to provide the source and a source id. The available sources include goals, sub-accounts, rebalancing or the portfolio optimizer.

input:

(no description)

Example

Request Content-Types: application/json
Query
mutation createBulkTradeRequest($input: CreateBulkTradeRequestInput!){
  createBulkTradeRequest(input: $input){
  }
}
Variables
{
  "input": {
    "source": "string",
    "sourceId": "object"
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "createBulkTradeRequest": {}
  }
}
Trading

Calculate Trade Request Fills

Calculates the number of trades that need to filled for each financial product i.e. the actual price, total quantity, the type of trade (buy or sell) and the currency involved.

input:

(no description)

Example

Request Content-Types: application/json
Query
mutation calculateTradeRequestFills($input: CalculateTradeRequestFillsInput!){
  calculateTradeRequestFills(input: $input){
    success
  }
}
Variables
{
  "input": {
    "bulkTradeRunId": "object",
    "bulkTrades": [
      {
        "actualPriceCents": "number",
        "financialProductId": "object",
        "totalQuantity": "number"
      }
    ],
    "currencyFallbackConversions": [
      {
        "from": "string",
        "rate": "number",
        "to": "string"
      }
    ],
    "type": "string"
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "calculateTradeRequestFills": {
      "success": "boolean"
    }
  }
}
Trading

Fetch Bulk Trade Request

Fetch a bulk trade request and its properties using its id.

bulkTradeRequestId:
object

(no description)

Example

Request Content-Types: application/json
Query
query fetchBulkTradeRequest($bulkTradeRequestId: ObjectID!){
  fetchBulkTradeRequest(bulkTradeRequestId: $bulkTradeRequestId){
  }
}
Variables
{}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "fetchBulkTradeRequest": {}
  }
}
Trading

Fetch Bulk Trade Requests

Fetch a list of bulk trade requests based on the source or state.

input:

(no description)

Example

Request Content-Types: application/json
Query
query fetchBulkTradeRequests($input: FetchBulkTradeRequestsInput!){
  fetchBulkTradeRequests(input: $input){
    totalCount
  }
}
Variables
{
  "input": {
    "filter": {
      "source": "string",
      "sourceId": "object",
      "state": "string"
    },
    "pagination": {
      "offSet": "number",
      "perPage": "number",
      "sortDesc": "boolean",
      "sortField": "string"
    }
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "fetchBulkTradeRequests": {
      "totalCount": "integer"
    }
  }
}
Trading

Fetch Bulk Trade Run

Fetch a bulk trade that has been triggered to start in an organization based on its current state. States include generating, completed, canceled, bulk trades initiated, allocations initiated etc.

bulkTradeRunId:
object

(no description)

Example

Request Content-Types: application/json
Query
query fetchBulkTradeRun($bulkTradeRunId: ObjectID!){
  fetchBulkTradeRun(bulkTradeRunId: $bulkTradeRunId){
  }
}
Variables
{}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "fetchBulkTradeRun": {}
  }
}
Trading

Fetch Bulk Trade Runs

Fetch a list of bulk trade runs and their properties.

input:

(no description)

Example

Request Content-Types: application/json
Query
query fetchBulkTradeRuns($input: FetchBulkTradeRunsInput!){
  fetchBulkTradeRuns(input: $input){
    totalCount
  }
}
Variables
{
  "input": {
    "filter": {
      "organizationId": "object",
      "state": "string"
    },
    "pagination": {
      "offSet": "number",
      "perPage": "number",
      "sortDesc": "boolean",
      "sortField": "string"
    }
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "fetchBulkTradeRuns": {
      "totalCount": "integer"
    }
  }
}
Trading

Fetch Bulk Trade Run Allocations

Fetch bulk trade run allocations using the bulk trade run id and whether the allocations were in a PTF fund.

input:

(no description)

Example

Request Content-Types: application/json
Query
query fetchBulkTradeRunAllocations($input: FetchBulkTradeRunAllocationsInput!){
  fetchBulkTradeRunAllocations(input: $input){
    totalCount
  }
}
Variables
{
  "input": {
    "filter": {
      "bulkTradeRunId": "object",
      "isPTF": "boolean"
    },
    "pagination": {
      "offSet": "number",
      "perPage": "number"
    }
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "fetchBulkTradeRunAllocations": {
      "totalCount": "integer"
    }
  }
}

Fees and Billing

This represents any data that is associated to the fees and how often the fees are charged.

Fees and Billing

Create Fee Tier

A fee tier represents the amount of fees charged to client groups, users, accounts or sub-accounts in an organization.

input:

(no description)

Example

Request Content-Types: application/json
Query
mutation createFeeTier($input: CreateFeeTierInput!){
  createFeeTier(input: $input){
  }
}
Variables
{
  "input": {
    "blendedGrid": "boolean",
    "chargeForCash": "boolean",
    "chargeForCashOnHold": "boolean",
    "default": "boolean",
    "discountPercentage": "number",
    "flatAnnualFeeBps": "number",
    "grid": [
      {
        "annualFeeBps": "number",
        "annualFeeCents": "object",
        "minMarketValueCents": "object"
      }
    ],
    "gridScopeType": "string",
    "name": "object",
    "organizationId": "object",
    "requestId": "object"
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "createFeeTier": {}
  }
}
Fees and Billing

Transition Fee Tier

Activate, deactivate or archive a fee tier.

input:

(no description)

Example

Request Content-Types: application/json
Query
mutation transitionFeeTier($input: TransitionFeeTierInput!){
  transitionFeeTier(input: $input){
  }
}
Variables
{
  "input": {
    "feeTierId": "object",
    "transition": "string"
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "transitionFeeTier": {}
  }
}
Fees and Billing

Update Fee Tier

Modify an existing fee tier.

input:

(no description)

Example

Request Content-Types: application/json
Query
mutation updateFeeTier($input: UpdateFeeTierInput!){
  updateFeeTier(input: $input){
  }
}
Variables
{
  "input": {
    "blendedGrid": "boolean",
    "chargeForCash": "boolean",
    "chargeForCashOnHold": "boolean",
    "default": "boolean",
    "discountPercentage": "number",
    "feeTierId": "object",
    "flatAnnualFeeBps": "number",
    "grid": [
      {
        "annualFeeBps": "number",
        "annualFeeCents": "object",
        "minMarketValueCents": "object"
      }
    ],
    "gridScopeType": "string",
    "name": "object"
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "updateFeeTier": {}
  }
}
Fees and Billing

Fetch Fee Tier

Fetch an existing fee tiers using the specified filters such as the scope for the fee grid, the organization ID, the fee states or name of the fee tier.

input:

(no description)

Example

Request Content-Types: application/json
Query
query fetchFeeTiers($input: FetchFeeTiersInput!){
  fetchFeeTiers(input: $input){
    totalCount
  }
}
Variables
{
  "input": {
    "filter": {
      "default": "boolean",
      "gridScopeTypes": [
        "string"
      ],
      "hasDiscountPercentage": "boolean",
      "hasFlatAnnualFeeBps": "boolean",
      "hasGrid": "boolean",
      "name": "string",
      "organizationId": "object",
      "states": [
        "string"
      ]
    },
    "pagination": {
      "offSet": "number",
      "perPage": "number",
      "sortDesc": "boolean",
      "sortField": "string"
    }
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "fetchFeeTiers": {
      "totalCount": "integer"
    }
  }
}
Fees and Billing

Create Billing Schedule

Create a billing schedule in an organization.

input:

(no description)

Example

Request Content-Types: application/json
Query
mutation createBillingSchedule($input: CreateBillingScheduleInput!){
  createBillingSchedule(input: $input){
  }
}
Variables
{
  "input": {
    "default": "boolean",
    "endDate": "object",
    "frequency": "string",
    "nextBillingDate": "object",
    "nextCalculationDate": "object",
    "organizationId": "object",
    "requestId": "object",
    "startDate": "object"
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "createBillingSchedule": {}
  }
}
Fees and Billing

Update Billing Schedules

Modify an existing billing schedule.

input:

(no description)

Example

Request Content-Types: application/json
Query
mutation updateBillingSchedule($input: UpdateBillingScheduleInput!){
  updateBillingSchedule(input: $input){
  }
}
Variables
{
  "input": {
    "billingScheduleId": "object",
    "default": "boolean",
    "endDate": "object",
    "frequency": "string",
    "nextBillingDate": "object",
    "nextCalculationDate": "object",
    "startDate": "object"
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "updateBillingSchedule": {}
  }
}
Fees and Billing

Transition Billing Schedules

Activate, deactivate or archive a billing schedule.

input:

(no description)

Example

Request Content-Types: application/json
Query
mutation transitionBillingSchedule($input: TransitionBillingScheduleInput!){
  transitionBillingSchedule(input: $input){
  }
}
Variables
{
  "input": {
    "billingScheduleId": "object",
    "transition": "string"
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "transitionBillingSchedule": {}
  }
}
Fees and Billing

Fetch Billing Cycle

The billing cycle represents the schedule at which accounts in an organization are charged fees. The billing cycle is fetched using its ID.

billingCycleId:
object

(no description)

Example

Request Content-Types: application/json
Query
query fetchBillingCycle($billingCycleId: ObjectID!){
  fetchBillingCycle(billingCycleId: $billingCycleId){
  }
}
Variables
{}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "fetchBillingCycle": {}
  }
}
Fees and Billing

Fetch Billing Cycles

Fetch billing cycles that have been created in an organization either by the organization ID, date source or schedule ID.

input:

(no description)

Example

Request Content-Types: application/json
Query
query fetchBillingCycles($input: FetchBillingCyclesInput!){
  fetchBillingCycles(input: $input){
    totalCount
  }
}
Variables
{
  "input": {
    "filter": {
      "billingDateAfter": "object",
      "billingDateBefore": "object",
      "billingScheduleIds": [
        "object"
      ],
      "organizationId": "object",
      "states": [
        "string"
      ]
    },
    "pagination": {
      "offSet": "number",
      "perPage": "number",
      "sortDesc": "boolean",
      "sortField": "string"
    }
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "fetchBillingCycles": {
      "totalCount": "integer"
    }
  }
}
Fees and Billing

Fetch Billing Schedule

The billing schedule represents when the fees are charged and the frequency. Fetch the billing schedule using its ID.

billingScheduleId:
object

(no description)

Example

Request Content-Types: application/json
Query
query fetchBillingSchedule($billingScheduleId: ObjectID!){
  fetchBillingSchedule(billingScheduleId: $billingScheduleId){
  }
}
Variables
{}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "fetchBillingSchedule": {}
  }
}
Fees and Billing

Fetch Billing Schedules

Fetch billing schedules by the frequencies, dates, states or the organization ID.

input:

(no description)

Example

Request Content-Types: application/json
Query
query fetchBillingSchedules($input: FetchBillingSchedulesInput!){
  fetchBillingSchedules(input: $input){
    totalCount
  }
}
Variables
{
  "input": {
    "filter": {
      "frequencies": [
        "string"
      ],
      "nextBillingDateAfter": "object",
      "nextBillingDateBefore": "object",
      "organizationId": "object",
      "states": [
        "string"
      ]
    },
    "pagination": {
      "offSet": "number",
      "perPage": "number",
      "sortDesc": "boolean",
      "sortField": "string"
    }
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "fetchBillingSchedules": {
      "totalCount": "integer"
    }
  }
}
Fees and Billing

Fetch Grouped Billings

Fetch the billing details for a client group and the affected sub-accounts, accounts and users.

input:

(no description)

Example

Request Content-Types: application/json
Query
query fetchGroupedBillings($input: FetchGroupedBillingsInput!){
  fetchGroupedBillings(input: $input){
    totalCount
  }
}
Variables
{
  "input": {
    "filter": {
      "accountIds": [
        "object"
      ],
      "billingCycleIds": [
        "object"
      ],
      "billingDateAfter": "object",
      "billingDateBefore": "object",
      "billingScheduleIds": [
        "object"
      ],
      "clientGroupIds": [
        "object"
      ],
      "feeTierIds": [
        "object"
      ],
      "organizationId": "object",
      "subAccountIds": [
        "object"
      ],
      "userIds": [
        "object"
      ]
    },
    "pagination": {
      "offSet": "number",
      "perPage": "number"
    }
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "fetchGroupedBillings": {
      "totalCount": "integer"
    }
  }
}
Fees and Billing

Fetch Organization Billings

Fetch details of a billing in an organization.

input:

(no description)

Example

Request Content-Types: application/json
Query
query fetchOrganizationBillings($input: FetchOrganizationBillingsInput!){
  fetchOrganizationBillings(input: $input){
    totalCount
  }
}
Variables
{
  "input": {
    "filter": {
      "accountIds": [
        "object"
      ],
      "billingCycleIds": [
        "object"
      ],
      "billingDateAfter": "object",
      "billingDateBefore": "object",
      "billingScheduleIds": [
        "object"
      ],
      "clientGroupIds": [
        "object"
      ],
      "feeTierIds": [
        "object"
      ],
      "organizationId": "object",
      "subAccountIds": [
        "object"
      ],
      "userIds": [
        "object"
      ]
    },
    "pagination": {
      "offSet": "number",
      "perPage": "number",
      "sortDesc": "boolean",
      "sortField": "string"
    }
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "fetchOrganizationBillings": {
      "totalCount": "integer"
    }
  }
}
Fees and Billing

Fetch Sub Account Billing

Fetch the billing cycle and schedule of a sub-account using the sub account billing ID.

subAccountBillingId:
object

(no description)

Example

Request Content-Types: application/json
Query
query fetchSubAccountBilling($subAccountBillingId: ObjectID!){
  fetchSubAccountBilling(subAccountBillingId: $subAccountBillingId){
  }
}
Variables
{}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "fetchSubAccountBilling": {}
  }
}
Fees and Billing

Fetch Sub Account Billings

Fetch a list of billing cycles and schedules of sub-accounts using the IDs of billing cycles, dates, billing schedules, fee tiers, organizations, client groups, users, accounts and sub-accounts.

input:

(no description)

Example

Request Content-Types: application/json
Query
query fetchSubAccountBillings($input: FetchSubAccountBillingsInput!){
  fetchSubAccountBillings(input: $input){
    totalCount
  }
}
Variables
{
  "input": {
    "filter": {
      "accountIds": [
        "object"
      ],
      "billingCycleIds": [
        "object"
      ],
      "billingDateAfter": "object",
      "billingDateBefore": "object",
      "billingScheduleIds": [
        "object"
      ],
      "clientGroupIds": [
        "object"
      ],
      "feeTierIds": [
        "object"
      ],
      "organizationId": "object",
      "subAccountIds": [
        "object"
      ],
      "userIds": [
        "object"
      ]
    },
    "pagination": {
      "offSet": "number",
      "perPage": "number",
      "sortDesc": "boolean",
      "sortField": "string"
    }
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "fetchSubAccountBillings": {
      "totalCount": "integer"
    }
  }
}
Fees and Billing

Fetch Sub Account Daily Fee

Fetch the fee properties of a sub-account using the sub-account daily fee ID.

subAccountDailyFeeId:
object

(no description)

Example

Request Content-Types: application/json
Query
query fetchSubAccountDailyFee($subAccountDailyFeeId: ObjectID!){
  fetchSubAccountDailyFee(subAccountDailyFeeId: $subAccountDailyFeeId){
  }
}
Variables
{}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "fetchSubAccountDailyFee": {}
  }
}
Fees and Billing

Fetch Sub Account Daily Fees

Fetch a list of fee properties of sub-accounts using the IDs of billing cycles, dates, billing schedules, fee tiers, organizations, client groups, users, accounts and sub-accounts.

input:

(no description)

Example

Request Content-Types: application/json
Query
query fetchSubAccountDailyFees($input: FetchSubAccountDailyFeesInput!){
  fetchSubAccountDailyFees(input: $input){
    totalCount
  }
}
Variables
{
  "input": {
    "filter": {
      "accountIds": [
        "object"
      ],
      "billingCycleIds": [
        "object"
      ],
      "billingScheduleIds": [
        "object"
      ],
      "clientGroupIds": [
        "object"
      ],
      "dateAfter": "object",
      "dateBefore": "object",
      "feeTierIds": [
        "object"
      ],
      "organizationId": "object",
      "state": "string",
      "subAccountBillingIds": [
        "object"
      ],
      "subAccountIds": [
        "object"
      ],
      "userIds": [
        "object"
      ]
    },
    "pagination": {
      "offSet": "number",
      "perPage": "number",
      "sortDesc": "boolean",
      "sortField": "string"
    }
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "fetchSubAccountDailyFees": {
      "totalCount": "integer"
    }
  }
}

Organization

Any partner that uses OneVest's API is referred to as an organization. There can be sub-organizations nested within an organization. The object contains settings such as the financial products, fee tiers, billing schedules, feature flags, permissions etc.

Organization

Create Organization

Create an organization and set its properties.

input:

(no description)

Example

Request Content-Types: application/json
Query
mutation createOrganization($input: CreateOrganizationInput!){
  createOrganization(input: $input){
  }
}
Variables
{
  "input": {
    "accountTypeTaxRanks": [
      {
        "accountType": "string",
        "taxRank": "number"
      }
    ],
    "allowAccessToSubOrganizations": "boolean",
    "allowDirectCommunication": "boolean",
    "allowInstantInvest": "boolean",
    "allowPostOptimizationEditing": "boolean",
    "autoInviteImportedUsers": "boolean",
    "blockSuspiciousTransactions": "boolean",
    "browserTabTitle": "string",
    "cashOnHoldToTradeDays": "number",
    "cashOnHoldToWithdrawDays": "number",
    "databaseAuthConnectionId": "object",
    "databaseAuthConnectionName": "object",
    "defaultAuthenticationConnection": "string",
    "defaultTradingProcess": "string",
    "displayCurrency": "boolean",
    "displayMenuBar": "boolean",
    "enableMultiFactorAuthentication": "boolean",
    "entityName": "object",
    "excludeAdminFeesFromClients": "boolean",
    "externalClientTokenEmailKey": "object",
    "faviconLink": "string",
    "helpCentreUrl": "object",
    "includeExternalClientTokenIntoContext": "boolean",
    "isReferral": "boolean",
    "jurisdictions": {
      "all": "boolean",
      "only": [
        "string"
      ]
    },
    "jwtKeyUrl": "object",
    "localizationId": "object",
    "minInitialDepositCents": "number",
    "minInvestAmountCents": "number",
    "minRecurringDepositCents": "number",
    "name": "object",
    "parentId": "object",
    "permissions": [
      "object"
    ],
    "profileReviewTimeInMonths": "number",
    "repCode": "object",
    "requireManualAccountApproval": "boolean",
    "revenueShareBps": "number",
    "revenueShareTaxes": "number",
    "reviewTransactions": "boolean",
    "subdomain": "object",
    "supportUrl": "object",
    "theme": {
      "authenticationTheme": {}
    }
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "createOrganization": {}
  }
}
Organization

Update Organization

Modify an existing organization.

input:

(no description)

Example

Request Content-Types: application/json
Query
mutation updateOrganization($input: UpdateOrganizationInput!){
  updateOrganization(input: $input){
  }
}
Variables
{
  "input": {
    "accountTypeTaxRanks": [
      {
        "accountType": "string",
        "taxRank": "number"
      }
    ],
    "allowAccessToSubOrganizations": "boolean",
    "allowDirectCommunication": "boolean",
    "allowInactiveUserAdjustments": "boolean",
    "allowInactiveUserFeeCalculation": "boolean",
    "allowInactiveUserRebalancing": "boolean",
    "allowInstantInvest": "boolean",
    "allowPortfolioPerGoal": "boolean",
    "allowPostOptimizationEditing": "boolean",
    "allowViewSubTradeRequestPairs": "boolean",
    "autoInviteImportedUsers": "boolean",
    "blockSuspiciousTransactions": "boolean",
    "browserTabTitle": "string",
    "cashOnHoldToTradeDays": "number",
    "cashOnHoldToWithdrawDays": "number",
    "customUrl": "string",
    "databaseAuthConnectionId": "object",
    "databaseAuthConnectionName": "object",
    "defaultAdvisorRoleId": "object",
    "defaultAuthenticationConnection": "string",
    "defaultClientRoleId": "object",
    "defaultSignUpRoleId": "object",
    "defaultTradingProcess": "string",
    "displayCurrency": "boolean",
    "displayMenuBar": "boolean",
    "enableMultiFactorAuthentication": "boolean",
    "entityName": "object",
    "excludeAdminFeesFromClients": "boolean",
    "externalClientTokenEmailKey": "object",
    "faviconLink": "string",
    "helpCentreUrl": "object",
    "includeExternalClientTokenIntoContext": "boolean",
    "isReferral": "boolean",
    "jurisdictions": {
      "all": "boolean",
      "only": [
        "string"
      ]
    },
    "jwtKeyUrl": "object",
    "localizationId": "object",
    "minInitialDepositCents": "number",
    "minInvestAmountCents": "number",
    "minRecurringDepositCents": "number",
    "name": "object",
    "organizationId": "object",
    "parentId": "object",
    "permissions": [
      "object"
    ]
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "updateOrganization": {}
  }
}
Organization

Fetch Organization

Fetch an organization's properties using its ID.

organizationId:
string

(no description)

Example

Request Content-Types: application/json
Query
query fetchOrganization($organizationId: String!){
  fetchOrganization(organizationId: $organizationId){
  }
}
Variables
{
  "organizationId": "string"
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "fetchOrganization": {}
  }
}
Organization

Fetch Organizations

Fetch a list of organizations and their properties using the child organization IDs or free text.

input:

(no description)

Example

Request Content-Types: application/json
Query
query fetchOrganizations($input: FetchOrganizationsInput!){
  fetchOrganizations(input: $input){
    totalCount
  }
}
Variables
{
  "input": {
    "filter": {
      "childrenFor": "object",
      "searchText": "string"
    },
    "pagination": {
      "offSet": "number",
      "perPage": "number",
      "sortDesc": "boolean",
      "sortField": "string"
    }
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "fetchOrganizations": {
      "totalCount": "integer"
    }
  }
}
Organization

Search Users

Fetch a user in the organization by querying whether the user profile is complete or by use of free text.

input:

(no description)

Example

Request Content-Types: application/json
Query
query searchUsers($input: UserSearchInput!){
  searchUsers(input: $input){
    totalCount
  }
}
Variables
{
  "input": {
    "filter": {
      "affiliateUsersOnly": "boolean",
      "isComplete": "boolean",
      "organizationId": "object",
      "query": "string",
      "types": [
        "string"
      ]
    },
    "pagination": {
      "page": "number",
      "perPage": "number",
      "sortDesc": "boolean",
      "sortField": "string"
    }
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "searchUsers": {
      "totalCount": "integer"
    }
  }
}
Organization

Create Organization User

Create an authorized user who will have access to the organization and set their role in the organization.

input:

(no description)

Example

Request Content-Types: application/json
Query
mutation createOrganizationUser($input: CreateOrganizationUserInput!){
  createOrganizationUser(input: $input){
  }
}
Variables
{
  "input": {
    "accessType": "string",
    "autoInviteUser": "boolean",
    "avatar": "object",
    "email": "object",
    "entities": [
      {
        "entityId": "object",
        "readOnly": "boolean"
      }
    ],
    "firstName": "object",
    "language": "string",
    "lastName": "object",
    "organizationId": "object",
    "phone": "object",
    "roleId": "object"
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "createOrganizationUser": {}
  }
}
Organization

Update Organization User

Modify an existing authorized user in an organization.

input:

(no description)

Example

Request Content-Types: application/json
Query
mutation updateOrganizationUser($input: UpdateOrganizationUserInput!){
  updateOrganizationUser(input: $input){
  }
}
Variables
{
  "input": {
    "accessType": "string",
    "avatar": "object",
    "email": "object",
    "entities": [
      {
        "entityId": "object",
        "readOnly": "boolean"
      }
    ],
    "firstName": "object",
    "language": "string",
    "lastName": "object",
    "organizationUserId": "object",
    "phone": "object",
    "roleId": "object"
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "updateOrganizationUser": {}
  }
}
Organization

Delete Organization User

Delete an authorized user in an organization.

organizationUserId:
object

(no description)

Example

Request Content-Types: application/json
Query
mutation deleteOrganizationUser($organizationUserId: ObjectID!){
  deleteOrganizationUser(organizationUserId: $organizationUserId){
    deleted
  }
}
Variables
{}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "deleteOrganizationUser": {
      "deleted": "boolean"
    }
  }
}
Organization

Fetch Organization User

Fetch an authorized user who has access to the organization using their ID.

organizationUserId:
object

(no description)

Example

Request Content-Types: application/json
Query
query fetchOrganizationUser($organizationUserId: ObjectID!){
  fetchOrganizationUser(organizationUserId: $organizationUserId){
  }
}
Variables
{}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "fetchOrganizationUser": {}
  }
}
Organization

Fetch Organization Users

Fetch a list of authorized users who have access to an organization using the organization ID.

input:

(no description)

Example

Request Content-Types: application/json
Query
query fetchOrganizationUsers($input: FetchOrganizationUsersInput!){
  fetchOrganizationUsers(input: $input){
    totalCount
  }
}
Variables
{
  "input": {
    "filter": {
      "accessType": "string",
      "authAudience": "string",
      "childrenForOrganizationId": "object",
      "organizationId": "object",
      "parentForOrganizationId": "object",
      "roleIds": [
        "object"
      ],
      "roleProfileId": "object",
      "searchText": "object"
    },
    "pagination": {
      "offSet": "number",
      "perPage": "number",
      "sortDesc": "boolean",
      "sortField": "string"
    }
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "fetchOrganizationUsers": {
      "totalCount": "integer"
    }
  }
}
Organization

Fetch Permissions

Fetch the permissions that exist in the system.

Example

Request Content-Types: application/json
Query
query fetchPermissions{
  fetchPermissions{
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "fetchPermissions": {}
  }
}
Organization

Create Role

Create a role in an organization, its permissions and accessible pages.

input:

(no description)

Example

Request Content-Types: application/json
Query
mutation createRole($input: CreateRoleInput!){
  createRole(input: $input){
  }
}
Variables
{
  "input": {
    "accessiblePages": [
      "string"
    ],
    "accountPageConfigurationId": "object",
    "dashboards": [
      "object"
    ],
    "defaultAuthenticationConnection": "string",
    "goalPageConfigurationId": "object",
    "householdPageConfigurationId": "object",
    "individualPageConfigurationId": "object",
    "makeHouseholdDefaultView": "boolean",
    "navigationStyle": "string",
    "nonIndividualPageConfigurationId": "object",
    "organizationId": "object",
    "permissions": [
      "object"
    ],
    "roleProfileId": "object",
    "subAccountPageConfigurationId": "object",
    "translatedDescription": {
      "en": "object",
      "fr": "object"
    },
    "translatedName": {
      "en": "object",
      "fr": "object"
    }
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "createRole": {}
  }
}
Organization

Update Role

Modify an existing role in an organization.

input:

(no description)

Example

Request Content-Types: application/json
Query
mutation updateRole($input: UpdateRoleInput!){
  updateRole(input: $input){
  }
}
Variables
{
  "input": {
    "accessiblePages": [
      "string"
    ],
    "accountPageConfigurationId": "object",
    "dashboards": [
      "object"
    ],
    "defaultAuthenticationConnection": "string",
    "goalPageConfigurationId": "object",
    "householdPageConfigurationId": "object",
    "individualPageConfigurationId": "object",
    "makeHouseholdDefaultView": "boolean",
    "navigationStyle": "string",
    "nonIndividualPageConfigurationId": "object",
    "organizationId": "object",
    "permissions": [
      "object"
    ],
    "roleId": "object",
    "roleProfileId": "object",
    "subAccountPageConfigurationId": "object",
    "translatedDescription": {
      "en": "object",
      "fr": "object"
    },
    "translatedName": {
      "en": "object",
      "fr": "object"
    }
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "updateRole": {}
  }
}
Organization

Delete Role

Delete an existing role in an organization.

roleId:
object

(no description)

Example

Request Content-Types: application/json
Query
mutation deleteRole($roleId: ObjectID!){
  deleteRole(roleId: $roleId){
    deleted
  }
}
Variables
{}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "deleteRole": {
      "deleted": "boolean"
    }
  }
}
Organization

Fetch Role

Fetch a role in an organization and its properties.

roleId:
object

(no description)

Example

Request Content-Types: application/json
Query
query fetchRole($roleId: ObjectID!){
  fetchRole(roleId: $roleId){
  }
}
Variables
{}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "fetchRole": {}
  }
}
Organization

Fetch Roles

Fetch roles and their properties in an organization.

input:

(no description)

Example

Request Content-Types: application/json
Query
query fetchRoles($input: FetchRolesInput!){
  fetchRoles(input: $input){
    totalCount
  }
}
Variables
{
  "input": {
    "filter": {
      "authAudience": "string",
      "organizationId": "object",
      "roleProfileId": "object",
      "searchText": "string"
    },
    "pagination": {
      "offSet": "number",
      "perPage": "number",
      "sortDesc": "boolean",
      "sortField": "string"
    }
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "fetchRoles": {
      "totalCount": "integer"
    }
  }
}
Organization

Create Note

The note object represents manually entered information on a user's profile by an authorized user in an organization.

input:

(no description)

Example

Request Content-Types: application/json
Query
mutation createNote($input: CreateNoteInput!){
  createNote(input: $input){
  }
}
Variables
{
  "input": {
    "content": "object",
    "objectId": "object",
    "objectType": "string",
    "type": "string"
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "createNote": {}
  }
}
Organization

Transition Note

Delete or publish an existing note.

input:

(no description)

Example

Request Content-Types: application/json
Query
mutation transitionNote($input: TransitionNoteInput!){
  transitionNote(input: $input){
  }
}
Variables
{
  "input": {
    "noteId": "object",
    "transition": "string"
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "transitionNote": {}
  }
}
Organization

Update Note

Modify an existing note.

input:

(no description)

Example

Request Content-Types: application/json
Query
mutation updateNote($input: UpdateNoteInput!){
  updateNote(input: $input){
  }
}
Variables
{
  "input": {
    "content": "object",
    "noteId": "object",
    "type": "string"
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "updateNote": {}
  }
}
Organization

Fetch Note

Fetch an existing note and its properties such as state, author, type, organization etc.

noteId:
object

(no description)

Example

Request Content-Types: application/json
Query
query fetchNote($noteId: ObjectID!){
  fetchNote(noteId: $noteId){
  }
}
Variables
{}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "fetchNote": {}
  }
}
Organization

Fetch Notes

Fetch existing notes using specified filters such as organization ID, state, type etc.

input:

(no description)

Example

Request Content-Types: application/json
Query
query fetchNotes($input: FetchNotesInput!){
  fetchNotes(input: $input){
    totalCount
  }
}
Variables
{
  "input": {
    "filter": {
      "objectId": "object",
      "objectIds": [
        "object"
      ],
      "objectType": "string",
      "organizationId": "object",
      "state": "string",
      "type": "string"
    },
    "pagination": {
      "offSet": "number",
      "perPage": "number",
      "sortDesc": "boolean",
      "sortField": "string"
    }
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "fetchNotes": {
      "totalCount": "integer"
    }
  }
}
Organization

Create Report

Create a new custom report at the organization level.

input:

(no description)

Example

Request Content-Types: application/json
Query
mutation createReport($input: CreateReportInput!){
  createReport(input: $input){
  }
}
Variables
{
  "input": {
    "accessType": "string",
    "columns": [
      "object"
    ],
    "filters": [
      {
        "comparison": "string",
        "field": "string",
        "value": "string"
      }
    ],
    "name": "object",
    "organizationId": "object",
    "sortDesc": "boolean",
    "sortField": "object",
    "type": "string"
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "createReport": {}
  }
}
Organization

Transition Report

Approve, deny or review a new custom report.

input:

(no description)

Example

Request Content-Types: application/json
Query
mutation transitionReport($input: TransitionReportInput!){
  transitionReport(input: $input){
  }
}
Variables
{
  "input": {
    "reportId": "object",
    "transition": "string"
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "transitionReport": {}
  }
}
Organization

Update Report

Modify an existing custom report.

input:

(no description)

Example

Request Content-Types: application/json
Query
mutation updateReport($input: UpdateReportInput!){
  updateReport(input: $input){
  }
}
Variables
{
  "input": {
    "accessType": "string",
    "columns": [
      "object"
    ],
    "filters": [
      {
        "comparison": "string",
        "field": "string",
        "value": "string"
      }
    ],
    "name": "object",
    "reportId": "object",
    "sortDesc": "boolean",
    "sortField": "object",
    "type": "string"
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "updateReport": {}
  }
}
Organization

Delete Report

Delete an existing custom report.

input:

(no description)

Example

Request Content-Types: application/json
Query
mutation deleteReport($input: DeleteReportInput!){
  deleteReport(input: $input){
    success
  }
}
Variables
{
  "input": {
    "reportId": "object"
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "deleteReport": {
      "success": "boolean"
    }
  }
}
Organization

Generate Report

Generate an existing custom report by selecting the columns, groupings and data.

input:

(no description)

Example

Request Content-Types: application/json
Query
query generateReport($input: GenerateReportInput!){
  generateReport(input: $input){
    columns
    data
    grouping
    totalCount
  }
}
Variables
{
  "input": {
    "columns": [
      "string"
    ],
    "filters": [
      {
        "comparison": "string",
        "field": "string",
        "value": "string"
      }
    ],
    "grouping": {
      "field": "string",
      "interval": "string",
      "type": "string",
      "valueAggregation": "string",
      "valueField": "string"
    },
    "pagination": {
      "page": "number",
      "perPage": "number"
    },
    "sorting": {
      "sortDesc": "boolean",
      "sortField": "string"
    },
    "type": "string"
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "generateReport": {
      "columns": [
        "string"
      ],
      "data": [
        [
          "string"
        ]
      ],
      "totalCount": "integer"
    }
  }
}
Organization

Fetch Report

Fetch a custom report using the report ID or organization ID.

input:

(no description)

Example

Request Content-Types: application/json
Query
query fetchReport($input: FetchReportInput!){
  fetchReport(input: $input){
  }
}
Variables
{
  "input": {
    "organizationId": "object",
    "reportId": "object"
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "fetchReport": {}
  }
}
Organization

Fetch Export

Fetch a data export and its properties such as file URL, organization user, state, type of report, columns in the report, etc

input:

(no description)

Example

Request Content-Types: application/json
Query
query fetchExport($input: FetchExportInput!){
  fetchExport(input: $input){
  }
}
Variables
{
  "input": {
    "exportId": "object"
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "fetchExport": {}
  }
}
Organization

Fetch Report Options

Fetch the columns available in a custom report and what their values can be compared to using the report type.

input:

(no description)

Example

Request Content-Types: application/json
Query
query fetchReportOptions($input: FetchReportOptionsInput!){
  fetchReportOptions(input: $input){
    columns
  }
}
Variables
{
  "input": {
    "type": "string"
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "fetchReportOptions": {
      "columns": [
        "string"
      ]
    }
  }
}
Organization

Fetch Reports

Fetch a list of custom reports using the report type or organization ID.

input:

(no description)

Example

Request Content-Types: application/json
Query
query fetchReports($input: FetchReportsInput!){
  fetchReports(input: $input){
    totalCount
  }
}
Variables
{
  "input": {
    "filter": {
      "organizationId": "object",
      "type": "string"
    },
    "pagination": {
      "offSet": "number",
      "perPage": "number",
      "sortDesc": "boolean",
      "sortField": "string"
    }
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "fetchReports": {
      "totalCount": "integer"
    }
  }
}
Organization

Export Report

Export a custom report using the specified filters.

input:

(no description)

Example

Request Content-Types: application/json
Query
mutation exportReport($input: ExportReportInput!){
  exportReport(input: $input){
  }
}
Variables
{
  "input": {
    "columns": [
      "object"
    ],
    "filters": [
      {
        "comparison": "string",
        "field": "string",
        "value": "string"
      }
    ],
    "sortDesc": "boolean",
    "sortField": "object",
    "type": "string"
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "exportReport": {}
  }
}
Organization

Update All Holdings and Cash

Update all financial product holdings and cash in an organization.

input:

(no description)

Example

Request Content-Types: application/json
Query
mutation updateAllHoldingsAndCash($input: UpdateAllHoldingsAndCashInput!){
  updateAllHoldingsAndCash(input: $input){
    success
  }
}
Variables
{
  "input": {
    "organizationId": "object"
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "updateAllHoldingsAndCash": {
      "success": "boolean"
    }
  }
}
Organization

Trigger Tax Loss Harvesting Analysis

Trigger a tax loss harvesting analysis in an organization.

input:

(no description)

Example

Request Content-Types: application/json
Query
mutation triggerTLHAnalysis($input: TriggerTLHAnalysisInput){
  triggerTLHAnalysis(input: $input){
  }
}
Variables
{
  "input": {
    "organizationId": "object"
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "triggerTLHAnalysis": {}
  }
}
Organization

Fetch Tax Loss Harvesting Analyses

Fetch the analyses done in a tax loss harvesting job such as the number of events triggered, the state, when the job was created and updated. This information is fetched using the organization ID.

input:

(no description)

Example

Request Content-Types: application/json
Query
query fetchTLHAnalyses($input: FetchTLHAnalysesInput!){
  fetchTLHAnalyses(input: $input){
    totalCount
  }
}
Variables
{
  "input": {
    "organizationId": "object",
    "pagination": {
      "offSet": "number",
      "perPage": "number",
      "sortDesc": "boolean",
      "sortField": "string"
    }
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "fetchTLHAnalyses": {
      "totalCount": "integer"
    }
  }
}
Organization

Fetch Tax Loss Harvesting Events

Fetch the events in a tax loss harvesting job such as the associated account properties, the price and quantity of the securities traded in the event.

input:

(no description)

Example

Request Content-Types: application/json
Query
query fetchTLHEvents($input: FetchTLHEventsInput!){
  fetchTLHEvents(input: $input){
    totalCount
  }
}
Variables
{
  "input": {
    "filter": {
      "organizationId": "object",
      "tlhJob": "object"
    },
    "pagination": {
      "offSet": "number",
      "perPage": "number",
      "sortDesc": "boolean",
      "sortField": "string"
    }
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "fetchTLHEvents": {
      "totalCount": "integer"
    }
  }
}
Organization

Fetch Tax Loss Harvesting Job

Fetch the job that is run to trigger tax loss harvesting.

tlhJob:
object

(no description)

Example

Request Content-Types: application/json
Query
query fetchTLHJob($tlhJob: ObjectID!){
  fetchTLHJob(tlhJob: $tlhJob){
    createdAt
    id
    numEvents
    state
    updatedAt
  }
}
Variables
{}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "fetchTLHJob": {
      "numEvents": "integer"
    }
  }
}
Organization

Fetch Flag

Fetch an account activity that has been flagged by the system e.g. transfers stuck in processing or ready states, account not found etc.

flagId:
string

(no description)

Example

Request Content-Types: application/json
Query
query fetchFlag($flagId: ID!){
  fetchFlag(flagId: $flagId){
  }
}
Variables
{
  "flagId": "string"
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "fetchFlag": {}
  }
}
Organization

Transition Flag

Resolve a flag by selecting whether it was fixed or it is a trivial flag.

input:

(no description)

Example

Request Content-Types: application/json
Query
mutation transitionFlag($input: TransitionFlagInput!){
  transitionFlag(input: $input){
  }
}
Variables
{
  "input": {
    "flagId": "object",
    "transition": "string"
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "transitionFlag": {}
  }
}
Organization

Fetch Flags

Fetch flags using filters such as the organization ID, or flag type.

input:

(no description)

Example

Request Content-Types: application/json
Query
query fetchFlags($input: FetchFlagsInput!){
  fetchFlags(input: $input){
    totalCount
  }
}
Variables
{
  "input": {
    "filter": {
      "accountId": "object",
      "custodianId": "object",
      "objectType": "string",
      "organizationId": "object",
      "state": "string",
      "type": "string"
    },
    "pagination": {
      "offSet": "number",
      "perPage": "number",
      "sortDesc": "boolean",
      "sortField": "string"
    }
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "fetchFlags": {
      "totalCount": "integer"
    }
  }
}
Organization

Bulk transition Flags

Transition the system flags in bulk by providing the flag ID and transition.

input:

(no description)

Example

Request Content-Types: application/json
Query
mutation bulkTransitionFlags($input: BulkTransitionFlagsInput!){
  bulkTransitionFlags(input: $input){
  }
}
Variables
{
  "input": {
    "flagIds": [
      "object"
    ],
    "transition": "string"
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "bulkTransitionFlags": {}
  }
}
Organization

Fetch Feature Flags

Fetch all available feature flags.

Example

Request Content-Types: application/json
Query
query fetchFeatureFlags{
  fetchFeatureFlags{
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "fetchFeatureFlags": {}
  }
}
Organization

Update Organization Feature Flag

Modify an existing feature flag in an organization.

input:

(no description)

Example

Request Content-Types: application/json
Query
mutation updateOrganizationFeatureFlag($input: UpdateOrganizationFeatureFlagInput!){
  updateOrganizationFeatureFlag(input: $input){
  }
}
Variables
{
  "input": {
    "featureFlags": [
      {
        "enabled": "boolean",
        "type": "string"
      }
    ],
    "organizationFeatureFlagId": "object"
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "updateOrganizationFeatureFlag": {}
  }
}
Organization

Fetch Organization Feature Flag

Fetch the feature flags that have been set by or for an organization.

organizationId:
object

(no description)

Example

Request Content-Types: application/json
Query
query fetchOrganizationFeatureFlag($organizationId: ObjectID!){
  fetchOrganizationFeatureFlag(organizationId: $organizationId){
  }
}
Variables
{}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "fetchOrganizationFeatureFlag": {}
  }
}
Organization

Update Custodian

Modify a custodian using its key.

input:

(no description)

Example

Request Content-Types: application/json
Query
mutation updateCustodian($input: UpdateCustodianInput!){
  updateCustodian(input: $input){
  }
}
Variables
{
  "input": {
    "custodianId": "object",
    "customerName": "object",
    "inventoryAccountId": "object",
    "moneyAccountId": "object",
    "name": "object",
    "notificationEmails": [
      "object"
    ],
    "repCode": "object",
    "sftpInBucket": "object",
    "sftpOutBucket": "object"
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "updateCustodian": {}
  }
}
Organization

Fetch Custodian

Fetch a custodian and properties of the accounts in it using the custodianKey.

custodianId:
object

(no description)

Example

Request Content-Types: application/json
Query
query fetchCustodian($custodianId: ObjectID!){
  fetchCustodian(custodianId: $custodianId){
  }
}
Variables
{}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "fetchCustodian": {}
  }
}
Organization

Create Custodian Connection

Add custodians to an organization. The custodians can be read-only, hybrid or full. An organization may also choose not to add any custodian connection.

input:

(no description)

Example

Request Content-Types: application/json
Query
mutation createCustodianConnection($input: CreateCustodianConnectionInput!){
  createCustodianConnection(input: $input){
  }
}
Variables
{
  "input": {
    "accountOpenningSubmissionType": "string",
    "accountTypeSettings": [
      {
        "availableCurrencies": [
          "string"
        ],
        "baseCurrency": "string",
        "isAutoSweepEnabled": "boolean",
        "isMultiCurrencyEnabled": "boolean",
        "type": "string"
      }
    ],
    "allowFractionalTrading": "boolean",
    "allowTransactionCreation": "boolean",
    "baseCurrency": "string",
    "config": "object",
    "custodianActivityImportFilePaths": [
      "object"
    ],
    "custodianSnapshotImportFilePaths": [
      "object"
    ],
    "custodianUsersImportFilePath": "object",
    "customerName": "object",
    "default": "boolean",
    "disabledFlagTypes": [
      "string"
    ],
    "enableAccountOpeningSubmission": "boolean",
    "enableAutoReconcileActivities": "boolean",
    "enableAutoReconcilePositions": "boolean",
    "enableCustodianAccountImport": "boolean",
    "enableCustodianActivityImport": "boolean",
    "enableCustodianOrganizationImport": "boolean",
    "enableCustodianOrganizationUserImport": "boolean",
    "enableCustodianSnapshotImport": "boolean",
    "enableCustodianUserImport": "boolean",
    "enableFetchCustodianAffiliates": "boolean",
    "enableFetchCustodianProjectedIncome": "boolean",
    "enableFetchCustodianSnapshotHistory": "boolean",
    "enableFetchCustodianStatements": "boolean",
    "enableFetchCustodianStatistics": "boolean",
    "enableFetchCustodianSuitability": "boolean",
    "enableFetchCustodianTransactions": "boolean",
    "enableFetchCustodianUpcomingTransactions": "boolean",
    "enableTransferSubmission": "boolean",
    "fetchLivePrices": "boolean",
    "name": "object",
    "notificationEmails": [
      "object"
    ],
    "organizationId": "object",
    "reconciliationType": "string",
    "repCode": "object",
    "requestId": "object",
    "sftpCredentials": {
      "sftpInBucket": "string",
      "sftpInDownloadFile": "boolean"
    }
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "createCustodianConnection": {}
  }
}
Organization

Update Custodian Connection

Modify an existing custodian connection.

input:

(no description)

Example

Request Content-Types: application/json
Query
mutation updateCustodianConnection($input: UpdateCustodianConnectionInput!){
  updateCustodianConnection(input: $input){
  }
}
Variables
{
  "input": {
    "accountOpenningSubmissionType": "string",
    "accountTypeSettings": [
      {
        "availableCurrencies": [
          "string"
        ],
        "baseCurrency": "string",
        "isAutoSweepEnabled": "boolean",
        "isMultiCurrencyEnabled": "boolean",
        "type": "string"
      }
    ],
    "allowFractionalTrading": "boolean",
    "allowTransactionCreation": "boolean",
    "baseCurrency": "string",
    "config": "object",
    "custodianActivityImportFilePaths": [
      "object"
    ],
    "custodianConnectionId": "object",
    "custodianSnapshotImportFilePaths": [
      "object"
    ],
    "custodianUsersImportFilePath": "object",
    "customerName": "object",
    "default": "boolean",
    "disabledFlagTypes": [
      "string"
    ],
    "enableAccountOpeningSubmission": "boolean",
    "enableAutoReconcileActivities": "boolean",
    "enableAutoReconcilePositions": "boolean",
    "enableCustodianAccountImport": "boolean",
    "enableCustodianActivityImport": "boolean",
    "enableCustodianOrganizationImport": "boolean",
    "enableCustodianOrganizationUserImport": "boolean",
    "enableCustodianSnapshotImport": "boolean",
    "enableCustodianUserImport": "boolean",
    "enableFetchCustodianAffiliates": "boolean",
    "enableFetchCustodianCustomFields": "boolean",
    "enableFetchCustodianProjectedIncome": "boolean",
    "enableFetchCustodianSnapshotHistory": "boolean",
    "enableFetchCustodianStatements": "boolean",
    "enableFetchCustodianStatistics": "boolean",
    "enableFetchCustodianSuitability": "boolean",
    "enableFetchCustodianTransactions": "boolean",
    "enableFetchCustodianUpcomingTransactions": "boolean",
    "enableTransferSubmission": "boolean",
    "fetchLivePrices": "boolean",
    "inventoryAccountId": "object",
    "moneyAccountId": "object",
    "name": "object",
    "notificationEmails": [
      "object"
    ],
    "reconciliationType": "string",
    "repCode": "object",
    "sftpCredentials": {}
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "updateCustodianConnection": {}
  }
}
Organization

Fetch Custodian Connection

Fetch custodian connections that have been added to an organization.

custodianConnectionId:
object

(no description)

Example

Request Content-Types: application/json
Query
query fetchCustodianConnection($custodianConnectionId: ObjectID!){
  fetchCustodianConnection(custodianConnectionId: $custodianConnectionId){
  }
}
Variables
{}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "fetchCustodianConnection": {}
  }
}
Organization

Reconcile Custodian Activity

Reconcile any custodian activity.

custodianActivityId:
object

(no description)

Example

Request Content-Types: application/json
Query
mutation reconcileCustodianActivity($custodianActivityId: ObjectID!){
  reconcileCustodianActivity(custodianActivityId: $custodianActivityId){
  }
}
Variables
{}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "reconcileCustodianActivity": {}
  }
}
Organization

Force Reconcile Custodian Activity

Manually reconcile any custodian activity.

custodianActivityId:
object

(no description)

Example

Request Content-Types: application/json
Query
mutation forceReconcileCustodianActivity($custodianActivityId: ObjectID!){
  forceReconcileCustodianActivity(custodianActivityId: $custodianActivityId){
  }
}
Variables
{}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "forceReconcileCustodianActivity": {}
  }
}
Organization

Fetch Custodian Activities

Fetch any custodian activity using by providing an account ID, state or transaction type.

input:

(no description)

Example

Request Content-Types: application/json
Query
query fetchCustodianActivities($input: FetchCustodianActivitiesInput!){
  fetchCustodianActivities(input: $input){
    totalCount
  }
}
Variables
{
  "input": {
    "filter": {
      "accountId": "object",
      "custodianAccountNumber": "string",
      "organizationId": "object",
      "state": "string",
      "symbol": "string",
      "transactionType": "string"
    },
    "pagination": {
      "offSet": "number",
      "perPage": "number",
      "sortDesc": "boolean",
      "sortField": "string"
    }
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "fetchCustodianActivities": {
      "totalCount": "integer"
    }
  }
}
Organization

Fetch External Vendor Usages

Fetch information on existing third party partners used in the system such as the vendor's name, the services they provide, and organization serviced by the vendor.

input:

(no description)

Example

Request Content-Types: application/json
Query
query fetchExternalVendorUsages($input: FetchExternalVendorUsageInput){
  fetchExternalVendorUsages(input: $input){
    totalCount
  }
}
Variables
{
  "input": {
    "filter": {
      "organizationId": "object",
      "provider": "string",
      "type": "string"
    },
    "pagination": {
      "offSet": "number",
      "perPage": "number",
      "sortDesc": "boolean",
      "sortField": "string"
    }
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "fetchExternalVendorUsages": {
      "totalCount": "integer"
    }
  }
}
Organization

Create Workflow

Create configurable steps that can be used by clients and/or advisors to complete a set of tasks e.g. onboarding, goal creation. Default state is draft but an be transitioned to active so that it can be launched. A workflow can be launched manually or automatically through setting up of rules to trigger the workflow.

input:

(no description)

Example

Request Content-Types: application/json
Query
mutation createWorkflow($input: CreateWorkflowInput!){
  createWorkflow(input: $input){
  }
}
Variables
{
  "input": {
    "eventType": "string",
    "name": {
      "en": "object",
      "fr": "object"
    },
    "objectType": "string",
    "organizationId": "object",
    "steps": [
      {
        "name": {
          "en": "object",
          "fr": "object"
        },
        "subSteps": [
          {
            "canGoBack": "boolean",
            "completeableBy": [
              "string"
            ],
            "options": "object",
            "rolesCompleteableBy": [
              "object"
            ],
            "skippable": "boolean",
            "type": "string"
          }
        ]
      }
    ],
    "triggerRules": [
      {
        "comparison": "string",
        "field": "object",
        "value": "object"
      }
    ],
    "triggerType": "string"
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "createWorkflow": {}
  }
}
Organization

Update Workflow

Update an existing workflow that is either in draft or active state. Any active workflow that is in progress will not be impacted by the updates.

input:

(no description)

Example

Request Content-Types: application/json
Query
mutation updateWorkflow($input: UpdateWorkflowInput!){
  updateWorkflow(input: $input){
  }
}
Variables
{
  "input": {
    "eventType": "string",
    "name": {
      "en": "object",
      "fr": "object"
    },
    "objectType": "string",
    "steps": [
      {
        "name": {
          "en": "object",
          "fr": "object"
        },
        "subSteps": [
          {
            "canGoBack": "boolean",
            "completeableBy": [
              "string"
            ],
            "options": "object",
            "rolesCompleteableBy": [
              "object"
            ],
            "skippable": "boolean",
            "type": "string"
          }
        ]
      }
    ],
    "triggerRules": [
      {
        "comparison": "string",
        "field": "object",
        "value": "object"
      }
    ],
    "triggerType": "string",
    "workflowId": "object"
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "updateWorkflow": {}
  }
}
Organization

Fetch Workflow

Fetches existing workflows in an organization.

workflowId:
object

(no description)

Example

Request Content-Types: application/json
Query
query fetchWorkflow($workflowId: ObjectID!){
  fetchWorkflow(workflowId: $workflowId){
  }
}
Variables
{}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "fetchWorkflow": {}
  }
}
Organization

Create Workflow Completion

Creates an active instance of the workflow that is associated with a user. This is triggered when a workflow is launched.

input:

(no description)

Example

Request Content-Types: application/json
Query
mutation createWorkflowCompletion($input: CreateWorkflowCompletionInput!){
  createWorkflowCompletion(input: $input){
  }
}
Variables
{
  "input": {
    "objectId": "string",
    "objectType": "string",
    "organizationId": "object",
    "parentWorkflowCompletionId": "object",
    "workflowId": "object"
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "createWorkflowCompletion": {}
  }
}
Organization

Update Workflow Completion

Update a workflow that has been launched for an user. The workflow starts from the step that was fully completed.

input:

(no description)

Example

Request Content-Types: application/json
Query
mutation updateWorkflowCompletion($input: UpdateWorkflowCompletionInput!){
  updateWorkflowCompletion(input: $input){
  }
}
Variables
{
  "input": {
    "context": "object",
    "workflowCompletionId": "object"
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "updateWorkflowCompletion": {}
  }
}
Organization

Create Notification

Create a notification associated to a role profile as configured in the notification definition.

input:

(no description)

Example

Request Content-Types: application/json
Query
mutation createNotification($input: CreateNotificationInput!){
  createNotification(input: $input){
  }
}
Variables
{
  "input": {
    "body": {
      "en": "object",
      "fr": "object"
    },
    "link": "object",
    "linkText": {
      "en": "object",
      "fr": "object"
    },
    "notificationGroupId": "object",
    "organizationUserId": "object",
    "title": {
      "en": "object",
      "fr": "object"
    }
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "createNotification": {}
  }
}
Organization

Create Notification Group

Create a category of notifications e.g user updates, money transfers.

input:

(no description)

Example

Request Content-Types: application/json
Query
mutation createNotificationGroup($input: CreateNotificationGroupInput!){
  createNotificationGroup(input: $input){
  }
}
Variables
{
  "input": {
    "name": {
      "en": "object",
      "fr": "object"
    },
    "organizationId": "object"
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "createNotificationGroup": {}
  }
}
Organization

Create Notification Definition

Create the body of a notification, what triggers it and the role profiles that should receive it. Other attributes include the title and link template. Each notification definition is associated with a notification group.

input:

(no description)

Example

Request Content-Types: application/json
Query
mutation createNotificationDefinition($input: CreateNotificationDefinitionInput!){
  createNotificationDefinition(input: $input){
  }
}
Variables
{
  "input": {
    "bodyTemplate": {
      "en": "object",
      "fr": "object"
    },
    "linkTemplate": "object",
    "linkText": {
      "en": "object",
      "fr": "object"
    },
    "name": "object",
    "notificationGroupId": "object",
    "organizationId": "object",
    "organizationOnly": "boolean",
    "roleProfileIds": [
      "object"
    ],
    "titleTemplate": {
      "en": "object",
      "fr": "object"
    },
    "triggerEventType": "string",
    "triggerObjectType": "string"
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "createNotificationDefinition": {}
  }
}
Organization

Update Notification Group

Update the name of a notification group.

input:

(no description)

Example

Request Content-Types: application/json
Query
mutation updateNotificationGroup($input: UpdateNotificationGroupInput!){
  updateNotificationGroup(input: $input){
  }
}
Variables
{
  "input": {
    "name": {
      "en": "object",
      "fr": "object"
    },
    "notificationGroupId": "object"
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "updateNotificationGroup": {}
  }
}
Organization

Update Notification Definition

Update the inputs of a notification e.g. name, body, trigger objects, the group etc

input:

(no description)

Example

Request Content-Types: application/json
Query
mutation updateNotificationDefinition($input: UpdateNotificationDefinitionInput!){
  updateNotificationDefinition(input: $input){
  }
}
Variables
{
  "input": {
    "bodyTemplate": {
      "en": "object",
      "fr": "object"
    },
    "linkTemplate": "object",
    "linkText": {
      "en": "object",
      "fr": "object"
    },
    "name": "object",
    "notificationDefinitionId": "object",
    "notificationGroupId": "object",
    "organizationOnly": "boolean",
    "roleProfileIds": [
      "object"
    ],
    "titleTemplate": {
      "en": "object",
      "fr": "object"
    },
    "triggerEventType": "string",
    "triggerObjectType": "string"
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "updateNotificationDefinition": {}
  }
}
Organization

Delete Notification Group

Delete a notification group using its id.

input:

(no description)

Example

Request Content-Types: application/json
Query
mutation deleteNotificationGroup($input: DeleteNotificationGroupInput!){
  deleteNotificationGroup(input: $input)
}
Variables
{
  "input": {
    "notificationGroupId": "object"
  }
}
Try it now
200 OK

Successful operation

type
boolean
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "deleteNotificationGroup": "boolean"
  }
}
Organization

Delete Notification Definition

Delete a notification definition using its id.

input:

(no description)

Example

Request Content-Types: application/json
Query
mutation deleteNotificationDefinition($input: DeleteNotificationDefinitionInput!){
  deleteNotificationDefinition(input: $input)
}
Variables
{
  "input": {
    "notificationDefinitionId": "object"
  }
}
Try it now
200 OK

Successful operation

type
boolean
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "deleteNotificationDefinition": "boolean"
  }
}
Organization

Fetch Notifications

Fetch unread or read notifications.

input:

(no description)

Example

Request Content-Types: application/json
Query
query fetchNotifications($input: FetchNotificationsInput!){
  fetchNotifications(input: $input){
    totalCount
  }
}
Variables
{
  "input": {
    "filter": {
      "read": "boolean"
    },
    "pagination": {
      "offSet": "number",
      "perPage": "number",
      "sortDesc": "boolean",
      "sortField": "string"
    }
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "fetchNotifications": {
      "totalCount": "integer"
    }
  }
}
Organization

Fetch Notification Definition

Fetch a notification definition using its id.

notificationDefinitionId:
object

(no description)

Example

Request Content-Types: application/json
Query
query fetchNotificationDefinition($notificationDefinitionId: ObjectID!){
  fetchNotificationDefinition(notificationDefinitionId: $notificationDefinitionId){
  }
}
Variables
{}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "fetchNotificationDefinition": {}
  }
}
Organization

Fetch Notification Definitions

Fetch a list of notification definitions in an organization.

input:

(no description)

Example

Request Content-Types: application/json
Query
query fetchNotificationDefinitions($input: FetchNotificationDefinitionsInput!){
  fetchNotificationDefinitions(input: $input){
    totalCount
  }
}
Variables
{
  "input": {
    "filter": {
      "organizationId": "object"
    },
    "pagination": {
      "offSet": "number",
      "perPage": "number",
      "sortDesc": "boolean",
      "sortField": "string"
    }
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "fetchNotificationDefinitions": {
      "totalCount": "integer"
    }
  }
}
Organization

Fetch Notification Group

Fetch a notification group using its id.

notificationGroupId:
object

(no description)

Example

Request Content-Types: application/json
Query
query fetchNotificationGroup($notificationGroupId: ObjectID!){
  fetchNotificationGroup(notificationGroupId: $notificationGroupId){
  }
}
Variables
{}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "fetchNotificationGroup": {}
  }
}
Organization

Fetch Notification Groups

Fetch a list of notification groups in an organization.

input:

(no description)

Example

Request Content-Types: application/json
Query
query fetchNotificationGroups($input: FetchNotificationGroupsInput!){
  fetchNotificationGroups(input: $input){
    totalCount
  }
}
Variables
{
  "input": {
    "filter": {
      "organizationId": "object"
    },
    "pagination": {
      "offSet": "number",
      "perPage": "number",
      "sortDesc": "boolean",
      "sortField": "string"
    }
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "fetchNotificationGroups": {
      "totalCount": "integer"
    }
  }
}

Bulk Import

This feature allows organizations to upload their files containing multiple rows of data to the OneVest system where they are imported. The files may contain data on most objects in OneVest such as clients, accounts, goals, affiliates, transactions etc

Bulk Import

Create Bulk Import

Create a bulk import for an organization.

input:

(no description)

Example

Request Content-Types: application/json
Query
mutation createBulkImport($input: CreateBulkImportInput!){
  createBulkImport(input: $input){
  }
}
Variables
{
  "input": {
    "name": "object",
    "organizationId": "object"
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "createBulkImport": {}
  }
}
Bulk Import

Update Bulk Import

Update the name and sequenced files for a bulk import.

input:

(no description)

Example

Request Content-Types: application/json
Query
mutation updateBulkImport($input: UpdateBulkImportInput!){
  updateBulkImport(input: $input){
  }
}
Variables
{
  "input": {
    "bulkImportId": "object",
    "name": "object",
    "sequencedImportFiles": [
      "object"
    ]
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "updateBulkImport": {}
  }
}
Bulk Import

Transition Bulk Import

Transition a bulk import. Available states include cancel, complete, fail and process.

input:

(no description)

Example

Request Content-Types: application/json
Query
mutation transitionBulkImport($input: TransitionBulkImportInput!){
  transitionBulkImport(input: $input){
  }
}
Variables
{
  "input": {
    "bulkImportId": "object",
    "sync": "boolean",
    "transition": "string"
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "transitionBulkImport": {}
  }
}
Bulk Import

Fetch Bulk Import

Fetch a bulk import using its id.

bulkImportId:
object

(no description)

Example

Request Content-Types: application/json
Query
query fetchBulkImport($bulkImportId: ObjectID!){
  fetchBulkImport(bulkImportId: $bulkImportId){
  }
}
Variables
{}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "fetchBulkImport": {}
  }
}
Bulk Import

Fetch Bulk Imports

Fetch bulk imports based on when they were created (before or after a certain date), name, organization they were uploaded in or states.

input:

(no description)

Example

Request Content-Types: application/json
Query
query fetchBulkImports($input: FetchBulkImportsInput!){
  fetchBulkImports(input: $input){
    totalCount
  }
}
Variables
{
  "input": {
    "filter": {
      "createdAtAfter": "object",
      "createdAtBefore": "object",
      "name": "object",
      "organizationId": "object",
      "organizationUserId": "object",
      "states": [
        "string"
      ]
    },
    "pagination": {
      "offSet": "number",
      "perPage": "number",
      "sortDesc": "boolean",
      "sortField": "string"
    }
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "fetchBulkImports": {
      "totalCount": "integer"
    }
  }
}

Integration

Below are a couple of objects used to monitor activities in the system as well as connect to other resources to enable the effective running of the API.

Integration

Fetch Events

The events object represents any external action taken in the API. This could be the creation of users, processing of transfers, etc

input:

(no description)

Example

Request Content-Types: application/json
Query
query fetchEvents($input: FetchEventsInput!){
  fetchEvents(input: $input){
    totalCount
  }
}
Variables
{
  "input": {
    "filter": {
      "createdAtAfter": "object",
      "createdAtBefore": "object",
      "eventType": "string",
      "objectId": "object",
      "objectType": "string",
      "organizationId": "object",
      "userId": "object",
      "webhookId": "object"
    },
    "pagination": {
      "offSet": "number",
      "perPage": "number",
      "sortDesc": "boolean",
      "sortField": "string"
    }
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "fetchEvents": {
      "totalCount": "integer"
    }
  }
}
Integration

Create Webhook

The webhook object enables developers to monitor events and share data from existing objects with external applications. The endpoint can be used to create a webhook.

input:

(no description)

Example

Request Content-Types: application/json
Query
mutation createWebhook($input: CreateWebhookInput!){
  createWebhook(input: $input){
  }
}
Variables
{
  "input": {
    "customHeaders": "object",
    "eventType": "string",
    "gql": "string",
    "mutationInputName": "string",
    "mutationName": "string",
    "objectType": "string",
    "organizationId": "object",
    "url": "string"
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "createWebhook": {}
  }
}
Integration

Create Rest Webhook

Create a REST webhook and set its properties.

input:

(no description)

Example

Request Content-Types: application/json
Query
mutation createRestWebhook($input: CreateRestWebhookInput!){
  createRestWebhook(input: $input){
  }
}
Variables
{
  "input": {
    "customHeaders": "object",
    "customPayloadAttributes": "object",
    "eventType": "string",
    "gql": "string",
    "objectType": "string",
    "organizationId": "object",
    "signedJwtHeader": "string",
    "url": "string"
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "createRestWebhook": {}
  }
}
Integration

Fetch Webhook

Fetch an existing webhook and its properties using its ID.

webhookId:
object

(no description)

Example

Request Content-Types: application/json
Query
query fetchWebhook($webhookId: ObjectID!){
  fetchWebhook(webhookId: $webhookId){
  }
}
Variables
{}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "fetchWebhook": {}
  }
}
Integration

Fetch Webhooks

Fetch existing webhooks.

input:

(no description)

Example

Request Content-Types: application/json
Query
query fetchWebhooks($input: FetchWebhooksInput!){
  fetchWebhooks(input: $input){
    totalCount
  }
}
Variables
{
  "input": {
    "filter": {
      "createdAtAfter": "object",
      "createdAtBefore": "object",
      "eventType": "string",
      "objectType": "string",
      "organizationId": "object",
      "type": "string"
    },
    "pagination": {
      "offSet": "number",
      "perPage": "number",
      "sortDesc": "boolean",
      "sortField": "string"
    }
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "fetchWebhooks": {
      "totalCount": "integer"
    }
  }
}
Integration

Update Webhook

Modify an existing webhook using its ID.

input:

(no description)

Example

Request Content-Types: application/json
Query
mutation updateWebhook($input: UpdateWebhookInput!){
  updateWebhook(input: $input){
  }
}
Variables
{
  "input": {
    "customHeaders": "object",
    "customPayloadAttributes": "object",
    "eventType": "string",
    "gql": "string",
    "mutationInputName": "string",
    "mutationName": "string",
    "objectType": "string",
    "signedJwtHeader": "string",
    "url": "string",
    "webhookId": "object"
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "updateWebhook": {}
  }
}
Integration

Delete Webhook

Delete an existing webhook using its ID.

webhookId:
string

(no description)

Example

Request Content-Types: application/json
Query
mutation deleteWebhook($webhookId: String!){
  deleteWebhook(webhookId: $webhookId){
    message
  }
}
Variables
{
  "webhookId": "string"
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "deleteWebhook": {
      "message": "string"
    }
  }
}
Integration

Fetch EOD Files

Fetch the name and URL of the end of day files by providing the appropriate key.

input:

(no description)

Example

Request Content-Types: application/json
Query
query fetchEodFiles($input: FetchEodFilesInput!){
  fetchEodFiles(input: $input){
  }
}
Variables
{
  "input": {
    "lastKey": "string"
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "fetchEodFiles": {}
  }
}
Integration

Create API token

Creates an API token that will be used to access the organization. The fields required to generate a token include the organization ID and permissions.

input:

(no description)

Example

Request Content-Types: application/json
Query
mutation createApiToken($input: CreateApiTokenInput!){
  createApiToken(input: $input){
  }
}
Variables
{
  "input": {
    "name": "object",
    "organizationId": "object",
    "permissions": [
      "object"
    ],
    "whitelistAddresses": [
      "object"
    ]
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "createApiToken": {}
  }
}
Integration

Transition API token

Deactivate an existing API token.

input:

(no description)

Example

Request Content-Types: application/json
Query
mutation transitionApiToken($input: TransitionApiTokenInput!){
  transitionApiToken(input: $input){
  }
}
Variables
{
  "input": {
    "apiTokenId": "object",
    "transition": "string"
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "transitionApiToken": {}
  }
}
Integration

Update API token

Modify an existing API token.

input:

(no description)

Example

Request Content-Types: application/json
Query
mutation updateApiToken($input: UpdateApiTokenInput!){
  updateApiToken(input: $input){
  }
}
Variables
{
  "input": {
    "apiTokenId": "object",
    "name": "object",
    "permissions": [
      "object"
    ],
    "whitelistAddresses": [
      "object"
    ]
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "updateApiToken": {}
  }
}

Schema Definitions

Account: object

affiliations:
object
return:
Affiliation
arguments:
object
applicableBillingSchedule:
object
return:
arguments:
object
applicableFeeTier:
object
return:
arguments:
object
applyForGovFunds:
object
return:
ApplyForGovFunds
arguments:
object
availableCurrencies:
object
return:
AccountCurrencyTypes
arguments:
object
baseCurrency:
object
return:
arguments:
object
billingSchedule:
object
return:
arguments:
object
clientGroup:
object
return:
arguments:
object
corporationClientGroup:
object
return:
arguments:
object
custodianAccountNumber:
object
return:
arguments:
object
custodianAffiliates:
object
return:
CustodianAffiliate
arguments:
object
custodianConnection:
object
return:
arguments:
object
custodianCustomFields:
object
return:
CustodianCustomField
arguments:
object
custodianSnapshotHistory:
object
return:
CustodianSnapshotHistory
arguments:
object
endDate:
input:
startDate:
custodianSortingOrderPriority:
object
return:
Int
arguments:
object
custodianStatistics:
object
return:
arguments:
object
endDate:
input:
startDate:
custodianUpcomingTransactions:
object
return:
arguments:
object
customFields:
object
return:
CustomFieldValue
arguments:
object
keys:
String
defaultTaxRank:
object
return:
Int
arguments:
object
feePaymentAccount:
object
return:
arguments:
object
feeRedirectionSignedAt:
object
return:
arguments:
object
feeTier:
object
return:
arguments:
object
forceOpen:
object
return:
arguments:
object
householdClientGroup:
object
return:
arguments:
object
id:
object
return:
arguments:
object
incompleteFormAgreements:
object

Lists remaining forms to be signed for this account.

return:
IncompleteFormAgreement
arguments:
object
integrations:
object
return:
AccountIntegration
arguments:
object
jurisdiction:
object
return:
arguments:
object
lastUpdatedBy:
object
return:
arguments:
object
latestFormAgreements:
object

Lists latest signed forms for this account.

return:
FormAgreement
arguments:
object
nickName:
object
return:
arguments:
object
organization:
object
return:
arguments:
object
overrideTaxRank:
object
return:
Int
arguments:
object
requiresFeeRedirectionSigned:
object
return:
arguments:
object
scheduledIncomeFundTransfer:
object
return:
arguments:
object
sourceOfFunds:
object
return:
arguments:
object
state:
object
return:
arguments:
object
stateChanges:
object
return:
StateChanges
arguments:
object
statistics:
object
return:
arguments:
object
input:
stats:
object
return:
arguments:
object
force:

Force cache miss. Re-calculates statistics with current data.

statsV2:
object
return:
arguments:
object
subAccounts:
object
return:
SubAccount
arguments:
object
taxRank:
object
return:
Int
arguments:
object
tlhEnabled:
object
return:
arguments:
object
totalManagementFees:
object
return:
arguments:
object
endDate:
startDate:
type:
object
return:
arguments:
object
user:
object
return:
arguments:
object
Example
{
  "affiliations": {
    "return": [
      {
        "allocation": {
          "return": "number",
          "arguments": {}
        },
        "id": {
          "return": "object",
          "arguments": {}
        },
        "relation": {
          "return": "string",
          "arguments": {}
        },
        "signatureRequired": {
          "return": "boolean",
          "arguments": {}
        },
        "type": {
          "return": "string",
          "arguments": {}
        },
        "user": {
          "return": {
            "accessibleBy": {
              "return": [
                {
                  "displayOptions": {
                    "return": {
                      "hide": {
                        "return": "boolean",
                        "arguments": {}
                      },
                      "order": {
                        "return": "number",
                        "arguments": {}
                      }
                    },
                    "arguments": {}
                  },
                  "organizationUser": {
                    "return": {
                      "accessType": {
                        "return": "string",
                        "arguments": {}
                      },
                      "apiTokens": {
                        "return": [
                          {
                            "id": {
                              "return": "object",
                              "arguments": {}
                            },
                            "jwtToken": {
                              "return": "string",
                              "arguments": {}
                            },
                            "name": {
                              "return": "string",
                              "arguments": {}
                            },
                            "organization": {
                              "return": {
                                "browserTabTitle": {
                                  "return": "string",
                                  "arguments": {}
                                },
                                "faviconLink": {
                                  "return": "string",
                                  "arguments": {}
                                },
                                "id": {
                                  "return": "object",
                                  "arguments": {}
                                },
                                "name": {
                                  "return": "string",
                                  "arguments": {}
                                },
                                "parent": {
                                  "return": {
                                    "browserTabTitle": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "faviconLink": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "id": {
                                      "return": "object"
                                    }
                                  }
                                }
                              }
                            }
                          }
                        ]
                      }
                    }
                  }
                }
              ]
            }
          }
        }
      }
    ]
  }
}

AccountBilling: object

account:
object
return:
arguments:
object
subAccountBillings:
object
return:
SubAccountBilling
arguments:
object
Example
{
  "account": {
    "return": {
      "affiliations": {
        "return": [
          {
            "allocation": {
              "return": "number",
              "arguments": {}
            },
            "id": {
              "return": "object",
              "arguments": {}
            },
            "relation": {
              "return": "string",
              "arguments": {}
            },
            "signatureRequired": {
              "return": "boolean",
              "arguments": {}
            },
            "type": {
              "return": "string",
              "arguments": {}
            },
            "user": {
              "return": {
                "accessibleBy": {
                  "return": [
                    {
                      "displayOptions": {
                        "return": {
                          "hide": {
                            "return": "boolean",
                            "arguments": {}
                          },
                          "order": {
                            "return": "number",
                            "arguments": {}
                          }
                        },
                        "arguments": {}
                      },
                      "organizationUser": {
                        "return": {
                          "accessType": {
                            "return": "string",
                            "arguments": {}
                          },
                          "apiTokens": {
                            "return": [
                              {
                                "id": {
                                  "return": "object",
                                  "arguments": {}
                                },
                                "jwtToken": {
                                  "return": "string",
                                  "arguments": {}
                                },
                                "name": {
                                  "return": "string",
                                  "arguments": {}
                                },
                                "organization": {
                                  "return": {
                                    "browserTabTitle": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "faviconLink": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "id": {
                                      "return": "object",
                                      "arguments": {}
                                    },
                                    "name": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "parent": {
                                      "return": {
                                        "browserTabTitle": {
                                          "return": "string",
                                          "arguments": {}
                                        },
                                        "faviconLink": {
                                          "return": "string",
                                          "arguments": {}
                                        }
                                      }
                                    }
                                  }
                                }
                              }
                            ]
                          }
                        }
                      }
                    }
                  ]
                }
              }
            }
          }
        ]
      }
    }
  }
}

AccountBulkMutualFundTrade: object

currency:
object
return:
arguments:
object
exchange:
object
return:
arguments:
object
id:
object
return:
arguments:
object
moneyAllocatedCents:
object
return:
arguments:
object
ticker:
object
return:
arguments:
object
type:
object
return:
arguments:
object
Example
{
  "currency": {
    "return": "string",
    "arguments": {}
  },
  "exchange": {
    "return": "string",
    "arguments": {}
  },
  "id": {
    "return": "object",
    "arguments": {}
  },
  "moneyAllocatedCents": {
    "return": "number",
    "arguments": {}
  },
  "ticker": {
    "return": "string",
    "arguments": {}
  },
  "type": {
    "return": "string",
    "arguments": {}
  }
}

AccountBulkTrade: object

_id:
object
return:
arguments:
object
currency:
object
return:
arguments:
object
exchange:
object
return:
arguments:
object
expectedPriceCents:
object

in CAD

return:
Int
arguments:
object
expectedPriceInCurrencyCents:
object

in actual currency

return:
Int
arguments:
object
total:
object
return:
Int
arguments:
object
Example
{
  "_id": {
    "return": "string",
    "arguments": {}
  },
  "currency": {
    "return": "string",
    "arguments": {}
  },
  "exchange": {
    "return": "string",
    "arguments": {}
  },
  "expectedPriceCents": {
    "return": "number",
    "arguments": {}
  },
  "expectedPriceInCurrencyCents": {
    "return": "number",
    "arguments": {}
  },
  "total": {
    "return": "number",
    "arguments": {}
  }
}

AccountBulkTradeRequest: object

_id:
object
return:
arguments:
object
actualTotal:
object
return:
arguments:
object
actualTradePriceCents:
object
return:
arguments:
object
actualTradePriceInCurrencyCents:
object
return:
arguments:
object
currency:
object
return:
arguments:
object
exchange:
object
return:
arguments:
object
expectedTradePriceCents:
object

In CAD

return:
arguments:
object
expectedTradePriceInCurrencyCents:
object

In original currency

return:
arguments:
object
total:
object
return:
arguments:
object
Example
{
  "_id": {
    "return": "string",
    "arguments": {}
  },
  "actualTotal": {
    "return": "number",
    "arguments": {}
  },
  "actualTradePriceCents": {
    "return": "number",
    "arguments": {}
  },
  "actualTradePriceInCurrencyCents": {
    "return": "number",
    "arguments": {}
  },
  "currency": {
    "return": "string",
    "arguments": {}
  },
  "exchange": {
    "return": "string",
    "arguments": {}
  },
  "expectedTradePriceCents": {
    "return": "number",
    "arguments": {}
  },
  "expectedTradePriceInCurrencyCents": {
    "return": "number",
    "arguments": {}
  },
  "total": {
    "return": "number",
    "arguments": {}
  }
}

AccountCurrencyTypes: string

object
CAD
object
USD

AccountFee: object

account:
object
return:
arguments:
object
date:
object
return:
arguments:
object
feeCents:
object
return:
arguments:
object
id:
object
return:
arguments:
object
partnerRevShareBps:
object
return:
arguments:
object
redirectedFromAccount:
object
return:
arguments:
object
salesTaxCents:
object
return:
arguments:
object
state:
object
return:
arguments:
object
transactionFeeCents:
object
return:
arguments:
object
Example
{
  "account": {
    "return": {
      "affiliations": {
        "return": [
          {
            "allocation": {
              "return": "number",
              "arguments": {}
            },
            "id": {
              "return": "object",
              "arguments": {}
            },
            "relation": {
              "return": "string",
              "arguments": {}
            },
            "signatureRequired": {
              "return": "boolean",
              "arguments": {}
            },
            "type": {
              "return": "string",
              "arguments": {}
            },
            "user": {
              "return": {
                "accessibleBy": {
                  "return": [
                    {
                      "displayOptions": {
                        "return": {
                          "hide": {
                            "return": "boolean",
                            "arguments": {}
                          },
                          "order": {
                            "return": "number",
                            "arguments": {}
                          }
                        },
                        "arguments": {}
                      },
                      "organizationUser": {
                        "return": {
                          "accessType": {
                            "return": "string",
                            "arguments": {}
                          },
                          "apiTokens": {
                            "return": [
                              {
                                "id": {
                                  "return": "object",
                                  "arguments": {}
                                },
                                "jwtToken": {
                                  "return": "string",
                                  "arguments": {}
                                },
                                "name": {
                                  "return": "string",
                                  "arguments": {}
                                },
                                "organization": {
                                  "return": {
                                    "browserTabTitle": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "faviconLink": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "id": {
                                      "return": "object",
                                      "arguments": {}
                                    },
                                    "name": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "parent": {
                                      "return": {
                                        "browserTabTitle": {
                                          "return": "string",
                                          "arguments": {}
                                        },
                                        "faviconLink": {
                                          "return": "string",
                                          "arguments": {}
                                        }
                                      }
                                    }
                                  }
                                }
                              }
                            ]
                          }
                        }
                      }
                    }
                  ]
                }
              }
            }
          }
        ]
      }
    }
  }
}

AccountFeeStates: string

object
CANCELED
object
FAILED
object
INITIATED
object
READY
object
RECONCILED
object
REQUESTED

AccountFeeTransition: string

object
cancel
object
fail
object
reconcile
object
request

AccountFeesPaginationAndSorting: object

offSet:
Int
perPage:
Int
sortDesc:
sortField:
Example
{
  "offSet": "number",
  "perPage": "number",
  "sortDesc": "boolean",
  "sortField": "string"
}

AccountFeesQueryFilter: object

accountId:
organizationId:
referenceDate:
referenceDateAfter:
referenceDateBefore:
state:
Example
{
  "accountId": "object",
  "organizationId": "object",
  "referenceDate": "object",
  "referenceDateAfter": "object",
  "referenceDateBefore": "object",
  "state": "string"
}

AccountIntegration: object

The integration enum and unique integration id

iid:
object

The id for the entity, in the given specific integration

return:
arguments:
object
type:
object

Enumeration for the integration type

return:
arguments:
object
Example
{
  "iid": {
    "return": "string",
    "arguments": {}
  },
  "type": {
    "return": "string",
    "arguments": {}
  }
}

AccountIntegrationInput: object

Input type for integrations field

externalId:

externalId external source id

groupId:

group id the custodian connection

iid:

iid is the unique identifier for this entity in the given integration

type:

Integrations type derives from enumeration

Example
{
  "externalId": "object",
  "groupId": "object",
  "iid": "object",
  "type": "string"
}

AccountIntegrationTypes: string

Integrations for Account

object
APEX
object
CIBC_MELLON
object
CIIS
object
ENVESTNET
object
FC
object
FUNDSERV
object
IBKR
object
NBIN
object
NO_CONNECTION
object
PERSHING
object
RBC
object
SALESFORCE
object
SCHWAB
object
TEMPLATE

AccountStatement: object

account:
object
return:
arguments:
object
fileName:
object
return:
arguments:
object
id:
object
return:
arguments:
object
referenceDate:
object
return:
arguments:
object
s3Key:
object
return:
arguments:
object
signedUrl:
object
return:
arguments:
object
state:
object
return:
arguments:
object
translatedFileName:
object
return:
arguments:
object
type:
object
return:
arguments:
object
user:
object
return:
arguments:
object
Example
{
  "account": {
    "return": {
      "affiliations": {
        "return": [
          {
            "allocation": {
              "return": "number",
              "arguments": {}
            },
            "id": {
              "return": "object",
              "arguments": {}
            },
            "relation": {
              "return": "string",
              "arguments": {}
            },
            "signatureRequired": {
              "return": "boolean",
              "arguments": {}
            },
            "type": {
              "return": "string",
              "arguments": {}
            },
            "user": {
              "return": {
                "accessibleBy": {
                  "return": [
                    {
                      "displayOptions": {
                        "return": {
                          "hide": {
                            "return": "boolean",
                            "arguments": {}
                          },
                          "order": {
                            "return": "number",
                            "arguments": {}
                          }
                        },
                        "arguments": {}
                      },
                      "organizationUser": {
                        "return": {
                          "accessType": {
                            "return": "string",
                            "arguments": {}
                          },
                          "apiTokens": {
                            "return": [
                              {
                                "id": {
                                  "return": "object",
                                  "arguments": {}
                                },
                                "jwtToken": {
                                  "return": "string",
                                  "arguments": {}
                                },
                                "name": {
                                  "return": "string",
                                  "arguments": {}
                                },
                                "organization": {
                                  "return": {
                                    "browserTabTitle": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "faviconLink": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "id": {
                                      "return": "object",
                                      "arguments": {}
                                    },
                                    "name": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "parent": {
                                      "return": {
                                        "browserTabTitle": {
                                          "return": "string",
                                          "arguments": {}
                                        },
                                        "faviconLink": {
                                          "return": "string",
                                          "arguments": {}
                                        }
                                      }
                                    }
                                  }
                                }
                              }
                            ]
                          }
                        }
                      }
                    }
                  ]
                }
              }
            }
          }
        ]
      }
    }
  }
}

AccountStatementStates: string

AccountStatement states

object
AWAITING_REVIEW
object
FAILED
object
RECONCILED

AccountStatementTransition: string

object
fail
object
reconcile

AccountStates: string

object
ACTIVE
object
CANCELED
object
FAILED
object
FROZEN
object
INACTIVE
object
INITIATED
object
READY
object
REQUESTED

AccountStats: object

account:
object
return:
arguments:
object
availableFundsToWithdrawCents:
object
return:
arguments:
object
capitalGainsAndLossesHistory:
object
return:
CapitalGainsAndLosses
arguments:
object
capitalGainsAndLossesInFiscalYear:
object
return:
arguments:
object
referenceDate:
cashOnHoldToTradeCents:
object
return:
arguments:
object
cashOnHoldToWithdrawCents:
object
return:
arguments:
object
holdings:
object
return:
DailySnapshotHolding
arguments:
object
marketValueCents:
object
return:
arguments:
object
moneyAvailableCents:
object
return:
arguments:
object
moneyWeightedReturn:
object
return:
arguments:
object
endDate:
startDate:
netContributionCents:
object
return:
arguments:
object
netContributionCentsInFiscalYear:
object
return:
arguments:
object
referenceDate:
newContributionCents:
object
return:
arguments:
object
pendingContributionCents:
object
return:
arguments:
object
simpleReturnAmount:
object
return:
arguments:
object
endDate:
startDate:
simpleReturnPercent:
object
return:
arguments:
object
endDate:
startDate:
taxLossHarvestCreditHistory:
object
return:
TaxLossHarvestCredit
arguments:
object
taxLossHarvestCreditInFiscalYear:
object
return:
arguments:
object
year:
timeWeightedReturn:
object
return:
arguments:
object
endDate:
startDate:
Example
{
  "account": {
    "return": "object",
    "arguments": {}
  },
  "availableFundsToWithdrawCents": {
    "return": "object",
    "arguments": {}
  },
  "capitalGainsAndLossesHistory": {
    "return": [
      {
        "account": {
          "return": "object",
          "arguments": {}
        },
        "id": {
          "return": "object",
          "arguments": {}
        },
        "totalCents": {
          "return": "number",
          "arguments": {}
        },
        "year": {
          "return": "number",
          "arguments": {}
        }
      }
    ],
    "arguments": {}
  },
  "capitalGainsAndLossesInFiscalYear": {
    "return": "object",
    "arguments": {
      "referenceDate": "object"
    }
  },
  "cashOnHoldToTradeCents": {
    "return": "object",
    "arguments": {}
  },
  "cashOnHoldToWithdrawCents": {
    "return": "object",
    "arguments": {}
  },
  "holdings": {
    "return": [
      {
        "currentPriceCents": {
          "return": "number",
          "arguments": {}
        },
        "financialProduct": {
          "return": {
            "assignable": {
              "return": "boolean",
              "arguments": {}
            },
            "autoUpdatePrices": {
              "return": "boolean",
              "arguments": {}
            },
            "children": {
              "return": [
                {
                  "financialProduct": {
                    "return": {
                      "assignable": {
                        "return": "boolean",
                        "arguments": {}
                      },
                      "autoUpdatePrices": {
                        "return": "boolean",
                        "arguments": {}
                      },
                      "children": {
                        "return": [
                          {
                            "financialProduct": {
                              "return": {
                                "assignable": {
                                  "return": "boolean",
                                  "arguments": {}
                                },
                                "autoUpdatePrices": {
                                  "return": "boolean",
                                  "arguments": {}
                                },
                                "children": {
                                  "return": [
                                    {
                                      "financialProduct": {
                                        "return": {}
                                      }
                                    }
                                  ]
                                }
                              }
                            }
                          }
                        ]
                      }
                    }
                  }
                }
              ]
            }
          }
        }
      }
    ]
  }
}

AccountTransition: string

object
activate
object
cancel
object
fail
object
freeze
object
ready
object
request

AccountType: object

translatedDescription:
object
return:
arguments:
object
translatedName:
object
return:
arguments:
object
value:
object
return:
arguments:
object
Example
{
  "translatedDescription": {
    "return": {
      "en": {
        "return": "string",
        "arguments": {}
      },
      "fr": {
        "return": "string",
        "arguments": {}
      }
    },
    "arguments": {}
  },
  "translatedName": {
    "return": {
      "en": {
        "return": "string",
        "arguments": {}
      },
      "fr": {
        "return": "string",
        "arguments": {}
      }
    },
    "arguments": {}
  },
  "value": {
    "return": "string",
    "arguments": {}
  }
}

AccountTypeSettings: object

availableCurrencies:
object
return:
CustodianConnectionCurrencyTypes
arguments:
object
baseCurrency:
object
return:
arguments:
object
id:
object
return:
arguments:
object
isAutoSweepEnabled:
object
return:
arguments:
object
isMultiCurrencyEnabled:
object
return:
arguments:
object
type:
object
return:
arguments:
object
Example
{
  "availableCurrencies": {
    "return": [
      "string"
    ],
    "arguments": {}
  },
  "baseCurrency": {
    "return": "string",
    "arguments": {}
  },
  "id": {
    "return": "object",
    "arguments": {}
  },
  "isAutoSweepEnabled": {
    "return": "boolean",
    "arguments": {}
  },
  "isMultiCurrencyEnabled": {
    "return": "boolean",
    "arguments": {}
  },
  "type": {
    "return": "string",
    "arguments": {}
  }
}

AccountTypeSettingsInput: object

availableCurrencies:
CustodianConnectionCurrencyTypes
baseCurrency:
isAutoSweepEnabled:
isMultiCurrencyEnabled:
type:
Example
{
  "availableCurrencies": [
    "string"
  ],
  "baseCurrency": "string",
  "isAutoSweepEnabled": "boolean",
  "isMultiCurrencyEnabled": "boolean",
  "type": "string"
}

AccountTypeTaxRank: object

accountType:
object
return:
arguments:
object
id:
object
return:
arguments:
object
taxRank:
object
return:
Int
arguments:
object
Example
{
  "accountType": {
    "return": "string",
    "arguments": {}
  },
  "id": {
    "return": "object",
    "arguments": {}
  },
  "taxRank": {
    "return": "number",
    "arguments": {}
  }
}

AccountTypeTaxRankInput: object

accountType:
taxRank:
Int
Example
{
  "accountType": "string",
  "taxRank": "number"
}

AccountTypes: string

object
CASH_JOINT
object
CORPORATE_CASH
object
CORPORATE_CHARITY
object
CORPORATE_ESTATE
object
CORPORATE_TRUST
object
FHSA
object
GRSP
object
LIF
object
LIRA
object
LRIF
object
LRSP
object
PERSONAL
object
PRIF
object
RDSP
object
RESP
object
RESP_ADULT
object
RESP_FAMILY
object
RESP_FAMILY_JOINT
object
RESP_SINGLE
object
RESP_SINGLE_JOINT
object
RIF_SPOUSAL
object
RLIF
object
RLSP
object
RRIF
object
RRSP
object
RRSP_SPOUSAL
object
TFSA
object
UK_BROKERAGE
object
UK_CASH_ISA
object
UK_JISA
object
UK_PERSONAL_PENSION
object
UK_SS_ISA
object
USA_401K
object
USA_529
object
USA_BROKERAGE
object
USA_CORPORATE
object
USA_ESA
object
USA_INH_IRA
object
USA_INH_RT_IRA
object
USA_IRA
object
USA_JT_CP
object
USA_JT_JTBE
object
USA_JT_TIC
object
USA_JT_WROS
object
USA_RO_IRA
object
USA_RT_IRA
object
USA_SEP_IRA
object
USA_SOLO_401K
object
USA_TRUST

AccountTypesFilters: string

object
PERSONAL
object
RESP
object
RRSP
object
TFSA

AccountsDaily: object

account:
object
return:
arguments:
object
date:
object
return:
arguments:
object
holdings:
object
return:
Holding
arguments:
object
id:
object
return:
arguments:
object
marketValueCents:
object
return:
arguments:
object
matchingCustodianDaily:
object
return:
arguments:
object
moneyAvailableCents:
object
return:
arguments:
object
netContributionCents:
object
return:
arguments:
object
newContributionCents:
object
return:
arguments:
object
Example
{
  "account": {
    "return": {
      "affiliations": {
        "return": [
          {
            "allocation": {
              "return": "number",
              "arguments": {}
            },
            "id": {
              "return": "object",
              "arguments": {}
            },
            "relation": {
              "return": "string",
              "arguments": {}
            },
            "signatureRequired": {
              "return": "boolean",
              "arguments": {}
            },
            "type": {
              "return": "string",
              "arguments": {}
            },
            "user": {
              "return": {
                "accessibleBy": {
                  "return": [
                    {
                      "displayOptions": {
                        "return": {
                          "hide": {
                            "return": "boolean",
                            "arguments": {}
                          },
                          "order": {
                            "return": "number",
                            "arguments": {}
                          }
                        },
                        "arguments": {}
                      },
                      "organizationUser": {
                        "return": {
                          "accessType": {
                            "return": "string",
                            "arguments": {}
                          },
                          "apiTokens": {
                            "return": [
                              {
                                "id": {
                                  "return": "object",
                                  "arguments": {}
                                },
                                "jwtToken": {
                                  "return": "string",
                                  "arguments": {}
                                },
                                "name": {
                                  "return": "string",
                                  "arguments": {}
                                },
                                "organization": {
                                  "return": {
                                    "browserTabTitle": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "faviconLink": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "id": {
                                      "return": "object",
                                      "arguments": {}
                                    },
                                    "name": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "parent": {
                                      "return": {
                                        "browserTabTitle": {
                                          "return": "string",
                                          "arguments": {}
                                        },
                                        "faviconLink": {
                                          "return": "string",
                                          "arguments": {}
                                        }
                                      }
                                    }
                                  }
                                }
                              }
                            ]
                          }
                        }
                      }
                    }
                  ]
                }
              }
            }
          }
        ]
      }
    }
  }
}

AccountsPaginationAndSorting: object

offSet:
Int
perPage:
Int
sortDesc:
sortField:
Example
{
  "offSet": "number",
  "perPage": "number",
  "sortDesc": "boolean",
  "sortField": "string"
}

AccountsQueryFilter: object

clientGroupId:
customFields:
CustomFieldInput
includeHousehold:
states:
AccountStates
type:
userId:
Example
{
  "clientGroupId": "object",
  "customFields": [
    {
      "key": "object",
      "value": "object"
    }
  ],
  "includeHousehold": "boolean",
  "states": [
    "string"
  ],
  "type": "string",
  "userId": "object"
}

AccountsTaxRanksInput: object

accountId:
overrideTaxRank:
Int
Example
{
  "accountId": "object",
  "overrideTaxRank": "number"
}

AddAffiliationInput: object

accountId:
allocation:
Int
relation:
requestIpAddress:
signatureRequired:
type:
userId:
Example
{
  "accountId": "object",
  "allocation": "number",
  "relation": "string",
  "requestIpAddress": "string",
  "signatureRequired": "boolean",
  "type": "string",
  "userId": "object"
}

AddAffiliationResponse: object

account:
object
return:
arguments:
object
incompleteFields:
object
return:
String
arguments:
object
Example
{
  "account": {
    "return": {
      "affiliations": {
        "return": [
          {
            "allocation": {
              "return": "number",
              "arguments": {}
            },
            "id": {
              "return": "object",
              "arguments": {}
            },
            "relation": {
              "return": "string",
              "arguments": {}
            },
            "signatureRequired": {
              "return": "boolean",
              "arguments": {}
            },
            "type": {
              "return": "string",
              "arguments": {}
            },
            "user": {
              "return": {
                "accessibleBy": {
                  "return": [
                    {
                      "displayOptions": {
                        "return": {
                          "hide": {
                            "return": "boolean",
                            "arguments": {}
                          },
                          "order": {
                            "return": "number",
                            "arguments": {}
                          }
                        },
                        "arguments": {}
                      },
                      "organizationUser": {
                        "return": {
                          "accessType": {
                            "return": "string",
                            "arguments": {}
                          },
                          "apiTokens": {
                            "return": [
                              {
                                "id": {
                                  "return": "object",
                                  "arguments": {}
                                },
                                "jwtToken": {
                                  "return": "string",
                                  "arguments": {}
                                },
                                "name": {
                                  "return": "string",
                                  "arguments": {}
                                },
                                "organization": {
                                  "return": {
                                    "browserTabTitle": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "faviconLink": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "id": {
                                      "return": "object",
                                      "arguments": {}
                                    },
                                    "name": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "parent": {
                                      "return": {
                                        "browserTabTitle": {
                                          "return": "string",
                                          "arguments": {}
                                        },
                                        "faviconLink": {
                                          "return": "string",
                                          "arguments": {}
                                        }
                                      }
                                    }
                                  }
                                }
                              }
                            ]
                          }
                        }
                      }
                    }
                  ]
                }
              }
            }
          }
        ]
      }
    }
  }
}

AddEntityToOrganizationUserInput: object

entityId:
organizationUserId:
readOnly:
relation:
Example
{
  "entityId": "object",
  "organizationUserId": "object",
  "readOnly": "boolean",
  "relation": "string"
}

AddEntityToOrganizationUserResponse: object

organizationUser:
object
return:
arguments:
object
Example
{
  "organizationUser": {
    "return": {
      "accessType": {
        "return": "string",
        "arguments": {}
      },
      "apiTokens": {
        "return": [
          {
            "id": {
              "return": "object",
              "arguments": {}
            },
            "jwtToken": {
              "return": "string",
              "arguments": {}
            },
            "name": {
              "return": "string",
              "arguments": {}
            },
            "organization": {
              "return": {
                "browserTabTitle": {
                  "return": "string",
                  "arguments": {}
                },
                "faviconLink": {
                  "return": "string",
                  "arguments": {}
                },
                "id": {
                  "return": "object",
                  "arguments": {}
                },
                "name": {
                  "return": "string",
                  "arguments": {}
                },
                "parent": {
                  "return": {
                    "browserTabTitle": {
                      "return": "string",
                      "arguments": {}
                    },
                    "faviconLink": {
                      "return": "string",
                      "arguments": {}
                    },
                    "id": {
                      "return": "object",
                      "arguments": {}
                    },
                    "name": {
                      "return": "string",
                      "arguments": {}
                    },
                    "parent": {
                      "return": {
                        "browserTabTitle": {
                          "return": "string",
                          "arguments": {}
                        },
                        "faviconLink": {
                          "return": "string",
                          "arguments": {}
                        },
                        "id": {
                          "return": "object",
                          "arguments": {}
                        },
                        "name": {
                          "return": "string",
                          "arguments": {}
                        },
                        "parent": {
                          "return": {
                            "browserTabTitle": {
                              "return": "string",
                              "arguments": {}
                            },
                            "faviconLink": {
                              "return": "string",
                              "arguments": {}
                            },
                            "id": {
                              "return": "object",
                              "arguments": {}
                            },
                            "name": {
                              "return": "string",
                              "arguments": {}
                            }
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        ]
      }
    }
  }
}

AddImportFileInput: object

bulkImportId:
fileName:
type:
Example
{
  "bulkImportId": "object",
  "fileName": "object",
  "type": "string"
}

AddImportFileResponse: object

importFile:
object
return:
arguments:
object
Example
{
  "importFile": {
    "return": {
      "bulkImport": {
        "return": {
          "createdAt": {
            "return": "object",
            "arguments": {}
          },
          "id": {
            "return": "object",
            "arguments": {}
          },
          "name": {
            "return": "string",
            "arguments": {}
          },
          "organization": {
            "return": {
              "browserTabTitle": {
                "return": "string",
                "arguments": {}
              },
              "faviconLink": {
                "return": "string",
                "arguments": {}
              },
              "id": {
                "return": "object",
                "arguments": {}
              },
              "name": {
                "return": "string",
                "arguments": {}
              },
              "parent": {
                "return": {
                  "browserTabTitle": {
                    "return": "string",
                    "arguments": {}
                  },
                  "faviconLink": {
                    "return": "string",
                    "arguments": {}
                  },
                  "id": {
                    "return": "object",
                    "arguments": {}
                  },
                  "name": {
                    "return": "string",
                    "arguments": {}
                  },
                  "parent": {
                    "return": {
                      "browserTabTitle": {
                        "return": "string",
                        "arguments": {}
                      },
                      "faviconLink": {
                        "return": "string",
                        "arguments": {}
                      },
                      "id": {
                        "return": "object",
                        "arguments": {}
                      },
                      "name": {
                        "return": "string",
                        "arguments": {}
                      },
                      "parent": {
                        "return": {
                          "browserTabTitle": {
                            "return": "string",
                            "arguments": {}
                          },
                          "faviconLink": {
                            "return": "string",
                            "arguments": {}
                          },
                          "id": {
                            "return": "object",
                            "arguments": {}
                          },
                          "name": {
                            "return": "string",
                            "arguments": {}
                          },
                          "parent": {
                            "return": {
                              "browserTabTitle": {}
                            }
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

AddressCountries: string

Countries

object
AD
object
AE
object
AF
object
AG
object
AI
object
AL
object
AM
object
AO
object
AQ
object
AR
object
AS
object
AT
object
AU
object
AW
object
AX
object
AZ
object
BA
object
BB
object
BD
object
BE
object
BF
object
BG
object
BH
object
BI
object
BJ
object
BL
object
BM
object
BN
object
BO
object
BQ
object
BR
object
BS
object
BT
object
BV
object
BW
object
BY
object
BZ
object
CA
object
CC
object
CD
object
CF
object
CG
object
CH
object
CI
object
CK
object
CL
object
CM
object
CN
object
CO
object
CR
object
CU
object
CV
object
CW
object
CX
object
CY
object
CZ
object
DE
object
DJ
object
DK
object
DM
object
DO
object
DZ
object
EC
object
EE
object
EG
object
EH
object
ER
object
ES
object
ET
object
FI
object
FJ
object
FK
object
FM
object
FO
object
FR
object
GA
object
GB
object
GD
object
GE
object
GF
object
GG
object
GH
object
GI
object
GL
object
GM
object
GN
object
GP
object
GQ
object
GR
object
GS
object
GT
object
GU
object
GW
object
GY
object
HK
object
HM
object
HN
object
HR
object
HT
object
HU
object
ID
object
IE
object
IL
object
IM
object
IN
object
IO
object
IQ
object
IR
object
IS
object
IT
object
JE
object
JM
object
JO
object
JP
object
KE
object
KG
object
KH
object
KI
object
KM
object
KN
object
KP
object
KR
object
KW
object
KY
object
KZ
object
LA
object
LB
object
LC
object
LI
object
LK
object
LR
object
LS
object
LT
object
LU
object
LV
object
LY
object
MA
object
MC
object
MD
object
ME
object
MF
object
MG
object
MH
object
MK
object
ML
object
MM
object
MN
object
MO
object
MP
object
MQ
object
MR
object
MS
object
MT
object
MU
object
MV
object
MW
object
MX
object
MY
object
MZ
object
NA
object
NC
object
NE
object
NF
object
NG
object
NI
object
NL
object
NO
object
NP
object
NR
object
NU
object
NZ
object
OM
object
PA
object
PE
object
PF
object
PG
object
PH
object
PK
object
PL
object
PM
object
PN
object
PR
object
PS
object
PT
object
PW
object
PY
object
QA
object
RE
object
RO
object
RS
object
RU
object
RW
object
SA
object
SB
object
SC
object
SD
object
SE
object
SG
object
SH
object
SI
object
SJ
object
SK
object
SL
object
SM
object
SN
object
SO
object
SR
object
SS
object
ST
object
SV
object
SX
object
SY
object
SZ
object
TC
object
TD
object
TF
object
TG
object
TH
object
TJ
object
TK
object
TL
object
TM
object
TN
object
TO
object
TR
object
TT
object
TV
object
TW
object
TZ
object
UA
object
UG
object
UM
object
US
object
UY
object
UZ
object
VA
object
VC
object
VE
object
VG
object
VI
object
VN
object
VU
object
WF
object
WS
object
YE
object
YT
object
ZA
object
ZM
object
ZW

AddressJurisdiction: string

Jurisdictions for User's physical address

object
CA_AB
object
CA_BC
object
CA_MB
object
CA_NB
object
CA_NL
object
CA_NS
object
CA_NT
object
CA_NU
object
CA_ON
object
CA_PE
object
CA_QC
object
CA_SK
object
CA_YT
object
GB_ENG
object
GB_NIR
object
GB_SCT
object
US_AK
object
US_AL
object
US_AR
object
US_AS
object
US_AZ
object
US_CA
object
US_CO
object
US_CT
object
US_DC
object
US_DE
object
US_FL
object
US_GA
object
US_GU
object
US_HI
object
US_IA
object
US_ID
object
US_IL
object
US_IN
object
US_KS
object
US_KY
object
US_LA
object
US_MA
object
US_MD
object
US_ME
object
US_MI
object
US_MN
object
US_MO
object
US_MP
object
US_MS
object
US_MT
object
US_NC
object
US_ND
object
US_NE
object
US_NH
object
US_NJ
object
US_NM
object
US_NV
object
US_NY
object
US_OH
object
US_OK
object
US_OR
object
US_PA
object
US_PR
object
US_RI
object
US_SC
object
US_SD
object
US_TN
object
US_TX
object
US_UM
object
US_UT
object
US_VA
object
US_VI
object
US_VT
object
US_WA
object
US_WI
object
US_WV
object
US_WY

AddressProvince: string

Provinces for User's physical address (deprecated; use Jurisdictions)

object
AB
object
BC
object
FOREIGN
object
MB
object
NB
object
NL
object
NS
object
NT
object
NU
object
ON
object
PE
object
QC
object
SK
object
YT

AdjustmentTransferResponse: object

transfer:
object
return:
arguments:
object
Example
{
  "transfer": {
    "return": {
      "alertReport": {
        "return": {
          "id": {
            "return": "object",
            "arguments": {}
          },
          "reason": {
            "return": "string",
            "arguments": {}
          },
          "rules": {
            "return": [
              {
                "id": {
                  "return": "object",
                  "arguments": {}
                },
                "translatedDescription": {
                  "return": {
                    "en": {
                      "return": "string",
                      "arguments": {}
                    },
                    "fr": {
                      "return": "string",
                      "arguments": {}
                    }
                  },
                  "arguments": {}
                },
                "type": {
                  "return": "string",
                  "arguments": {}
                }
              }
            ],
            "arguments": {}
          },
          "state": {
            "return": "string",
            "arguments": {}
          },
          "transfer": {
            "return": {
              "alertReport": {
                "return": {
                  "id": {
                    "return": "object",
                    "arguments": {}
                  },
                  "reason": {
                    "return": "string",
                    "arguments": {}
                  },
                  "rules": {
                    "return": [
                      {
                        "id": {
                          "return": "object",
                          "arguments": {}
                        },
                        "translatedDescription": {
                          "return": {
                            "en": {
                              "return": "string",
                              "arguments": {}
                            },
                            "fr": {
                              "return": "string",
                              "arguments": {}
                            }
                          },
                          "arguments": {}
                        },
                        "type": {
                          "return": "string",
                          "arguments": {}
                        }
                      }
                    ],
                    "arguments": {}
                  },
                  "state": {
                    "return": "string",
                    "arguments": {}
                  },
                  "transfer": {
                    "return": {
                      "alertReport": {
                        "return": {
                          "id": {
                            "return": "object",
                            "arguments": {}
                          },
                          "reason": {
                            "return": "string"
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

Affiliation: object

allocation:
object
return:
Int
arguments:
object
id:
object
return:
arguments:
object
relation:
object
return:
arguments:
object
signatureRequired:
object
return:
arguments:
object
type:
object
return:
arguments:
object
user:
object
return:
arguments:
object
Example
{
  "allocation": {
    "return": "number",
    "arguments": {}
  },
  "id": {
    "return": "object",
    "arguments": {}
  },
  "relation": {
    "return": "string",
    "arguments": {}
  },
  "signatureRequired": {
    "return": "boolean",
    "arguments": {}
  },
  "type": {
    "return": "string",
    "arguments": {}
  },
  "user": {
    "return": {
      "accessibleBy": {
        "return": [
          {
            "displayOptions": {
              "return": {
                "hide": {
                  "return": "boolean",
                  "arguments": {}
                },
                "order": {
                  "return": "number",
                  "arguments": {}
                }
              },
              "arguments": {}
            },
            "organizationUser": {
              "return": {
                "accessType": {
                  "return": "string",
                  "arguments": {}
                },
                "apiTokens": {
                  "return": [
                    {
                      "id": {
                        "return": "object",
                        "arguments": {}
                      },
                      "jwtToken": {
                        "return": "string",
                        "arguments": {}
                      },
                      "name": {
                        "return": "string",
                        "arguments": {}
                      },
                      "organization": {
                        "return": {
                          "browserTabTitle": {
                            "return": "string",
                            "arguments": {}
                          },
                          "faviconLink": {
                            "return": "string",
                            "arguments": {}
                          },
                          "id": {
                            "return": "object",
                            "arguments": {}
                          },
                          "name": {
                            "return": "string",
                            "arguments": {}
                          },
                          "parent": {
                            "return": {
                              "browserTabTitle": {
                                "return": "string",
                                "arguments": {}
                              },
                              "faviconLink": {
                                "return": "string",
                                "arguments": {}
                              },
                              "id": {
                                "return": "object",
                                "arguments": {}
                              },
                              "name": {
                                "return": "string"
                              }
                            }
                          }
                        }
                      }
                    }
                  ]
                }
              }
            }
          }
        ]
      }
    }
  }
}

AffiliationInput: object

allocation:
Int
id:
relation:
signatureRequired:
type:
userId:
Example
{
  "allocation": "number",
  "id": "object",
  "relation": "string",
  "signatureRequired": "boolean",
  "type": "string",
  "userId": "object"
}

AffiliationRelations: string

object
CHILD
object
COMMON_LAW
object
GRANDCHILD
object
GRANDPARENT
object
GUARDIAN
object
NEPHEW_NIECE
object
OTHER
object
PARENT
object
PRIMARY_CAREGIVER
object
SIBLING
object
SPOUSE

AffiliationTypes: string

object
AUTHORIZED_INDIVIDUAL
object
BENEFICIAL_OWNER
object
CONTINGENT_BENEFICIARY
object
CONTRIBUTOR
object
DECEDENT
object
DIRECTOR
object
GRANTOR
object
JOINT
object
OTHER
object
POWER_OF_ATTORNEY
object
PRIMARY_BENEFICIARY
object
PROTECTOR
object
SETTLOR
object
SUCCESSOR
object
THIRD_PARTY
object
TRUSTEE

AlertReportPaginationAndSorting: object

offSet:
Int
perPage:
Int
sortDesc:
sortField:
Example
{
  "offSet": "number",
  "perPage": "number",
  "sortDesc": "boolean",
  "sortField": "string"
}

AlertReportQueryFilter: object

createdAtAfter:
createdAtBefore:
organizationId:
state:
subAccountId:
transferId:
transferType:
Example
{
  "createdAtAfter": "object",
  "createdAtBefore": "object",
  "organizationId": "object",
  "state": "string",
  "subAccountId": "object",
  "transferId": "object",
  "transferType": "string"
}

AllTranslatedStringsInput: object

en:
fr:
Example
{
  "en": "object",
  "fr": "object"
}

AmountPayableType: string

Scheduled Income Fund Transfer ammount payable types.

object
GROSS
object
NET

AnnualSuitabilityCompletedResponse: object

user:
object
return:
arguments:
object
Example
{
  "user": {
    "return": {
      "accessibleBy": {
        "return": [
          {
            "displayOptions": {
              "return": {
                "hide": {
                  "return": "boolean",
                  "arguments": {}
                },
                "order": {
                  "return": "number",
                  "arguments": {}
                }
              },
              "arguments": {}
            },
            "organizationUser": {
              "return": {
                "accessType": {
                  "return": "string",
                  "arguments": {}
                },
                "apiTokens": {
                  "return": [
                    {
                      "id": {
                        "return": "object",
                        "arguments": {}
                      },
                      "jwtToken": {
                        "return": "string",
                        "arguments": {}
                      },
                      "name": {
                        "return": "string",
                        "arguments": {}
                      },
                      "organization": {
                        "return": {
                          "browserTabTitle": {
                            "return": "string",
                            "arguments": {}
                          },
                          "faviconLink": {
                            "return": "string",
                            "arguments": {}
                          },
                          "id": {
                            "return": "object",
                            "arguments": {}
                          },
                          "name": {
                            "return": "string",
                            "arguments": {}
                          },
                          "parent": {
                            "return": {
                              "browserTabTitle": {
                                "return": "string",
                                "arguments": {}
                              },
                              "faviconLink": {
                                "return": "string",
                                "arguments": {}
                              },
                              "id": {
                                "return": "object",
                                "arguments": {}
                              },
                              "name": {
                                "return": "string",
                                "arguments": {}
                              },
                              "parent": {
                                "return": {
                                  "browserTabTitle": {
                                    "return": "string",
                                    "arguments": {}
                                  },
                                  "faviconLink": {
                                    "return": "string",
                                    "arguments": {}
                                  },
                                  "id": {
                                    "return": "object",
                                    "arguments": {}
                                  },
                                  "name": {
                                    "return": "string",
                                    "arguments": {}
                                  }
                                }
                              }
                            }
                          }
                        }
                      }
                    }
                  ]
                }
              }
            }
          }
        ]
      }
    }
  }
}

ApiExportFormatters: string

object
DIVIDE_BY_100
object
MULTIPLY_BY_100

ApiToken: object

id:
object
return:
arguments:
object
jwtToken:
object
return:
arguments:
object
name:
object
return:
arguments:
object
organization:
object
return:
arguments:
object
organizationUser:
object
return:
arguments:
object
permissions:
object
return:
String
arguments:
object
state:
object
return:
arguments:
object
whitelistAddresses:
object
return:
String
arguments:
object
Example
{
  "id": {
    "return": "object",
    "arguments": {}
  },
  "jwtToken": {
    "return": "string",
    "arguments": {}
  },
  "name": {
    "return": "string",
    "arguments": {}
  },
  "organization": {
    "return": {
      "browserTabTitle": {
        "return": "string",
        "arguments": {}
      },
      "faviconLink": {
        "return": "string",
        "arguments": {}
      },
      "id": {
        "return": "object",
        "arguments": {}
      },
      "name": {
        "return": "string",
        "arguments": {}
      },
      "parent": {
        "return": {
          "browserTabTitle": {
            "return": "string",
            "arguments": {}
          },
          "faviconLink": {
            "return": "string",
            "arguments": {}
          },
          "id": {
            "return": "object",
            "arguments": {}
          },
          "name": {
            "return": "string",
            "arguments": {}
          },
          "parent": {
            "return": {
              "browserTabTitle": {
                "return": "string",
                "arguments": {}
              },
              "faviconLink": {
                "return": "string",
                "arguments": {}
              },
              "id": {
                "return": "object",
                "arguments": {}
              },
              "name": {
                "return": "string",
                "arguments": {}
              },
              "parent": {
                "return": {
                  "browserTabTitle": {
                    "return": "string",
                    "arguments": {}
                  },
                  "faviconLink": {
                    "return": "string",
                    "arguments": {}
                  },
                  "id": {
                    "return": "object",
                    "arguments": {}
                  },
                  "name": {
                    "return": "string",
                    "arguments": {}
                  },
                  "parent": {
                    "return": {
                      "browserTabTitle": {
                        "return": "string",
                        "arguments": {}
                      },
                      "faviconLink": {
                        "return": "string",
                        "arguments": {}
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

ApiTokenStates: string

object
ACTIVE
object
INACTIVE

ApiTokenTransitions: string

object
deactivate

ApplyForGovFunds: string

object
ADDITIONAL_CESG
object
BASIC_CESG
object
CLB

ArchiveGoalInput: object

goalId:
lastUpdatedBy:
Example
{
  "goalId": "object",
  "lastUpdatedBy": "object"
}

ArchiveGoalResponse: object

goal:
object
return:
arguments:
object
Example
{
  "goal": {
    "return": {
      "availableFinancialProducts": {
        "return": [
          {
            "assignable": {
              "return": "boolean",
              "arguments": {}
            },
            "autoUpdatePrices": {
              "return": "boolean",
              "arguments": {}
            },
            "children": {
              "return": [
                {
                  "financialProduct": {
                    "return": {
                      "assignable": {
                        "return": "boolean",
                        "arguments": {}
                      },
                      "autoUpdatePrices": {
                        "return": "boolean",
                        "arguments": {}
                      },
                      "children": {
                        "return": [
                          {
                            "financialProduct": {
                              "return": {
                                "assignable": {
                                  "return": "boolean",
                                  "arguments": {}
                                },
                                "autoUpdatePrices": {
                                  "return": "boolean",
                                  "arguments": {}
                                },
                                "children": {
                                  "return": [
                                    {
                                      "financialProduct": {
                                        "return": {
                                          "assignable": {
                                            "return": "boolean",
                                            "arguments": {}
                                          },
                                          "autoUpdatePrices": {
                                            "return": "boolean",
                                            "arguments": {}
                                          },
                                          "children": {
                                            "return": [
                                              {
                                                "financialProduct": {
                                                  "return": {
                                                    "assignable": {
                                                      "return": "boolean",
                                                      "arguments": {}
                                                    },
                                                    "autoUpdatePrices": {
                                                      "return": "boolean",
                                                      "arguments": {}
                                                    },
                                                    "children": {
                                                      "return": [
                                                        {
                                                          "financialProduct": {
                                                            "return": {
                                                              "assignable": {
                                                                "return": "boolean",
                                                                "arguments": {}
                                                              },
                                                              "autoUpdatePrices": {
                                                                "return": "boolean",
                                                                "arguments": {}
                                                              },
                                                              "children": {
                                                                "return": [
                                                                  {
                                                                    "financialProduct": {
                                                                      "return": {
                                                                        "assignable": {}
                                                                      }
                                                                    }
                                                                  }
                                                                ]
                                                              }
                                                            }
                                                          }
                                                        }
                                                      ]
                                                    }
                                                  }
                                                }
                                              }
                                            ]
                                          }
                                        }
                                      }
                                    }
                                  ]
                                }
                              }
                            }
                          }
                        ]
                      }
                    }
                  }
                }
              ]
            }
          }
        ]
      }
    }
  }
}

Article: object

articleUrl:
object
return:
arguments:
object
createdAt:
object
return:
arguments:
object
createdBy:
object
return:
arguments:
object
id:
object
return:
arguments:
object
imageUrl:
object
return:
arguments:
object
organization:
object
return:
arguments:
object
state:
object
return:
arguments:
object
translatedDescription:
object
return:
arguments:
object
translatedName:
object
return:
arguments:
object
updatedAt:
object
return:
arguments:
object
Example
{
  "articleUrl": {
    "return": "object",
    "arguments": {}
  },
  "createdAt": {
    "return": "object",
    "arguments": {}
  },
  "createdBy": {
    "return": {
      "email": {
        "return": "string",
        "arguments": {}
      },
      "firstName": {
        "return": "string",
        "arguments": {}
      },
      "id": {
        "return": "object",
        "arguments": {}
      },
      "language": {
        "return": "string",
        "arguments": {}
      },
      "lastName": {
        "return": "string",
        "arguments": {}
      },
      "organization": {
        "return": {
          "browserTabTitle": {
            "return": "string",
            "arguments": {}
          },
          "faviconLink": {
            "return": "string",
            "arguments": {}
          },
          "id": {
            "return": "object",
            "arguments": {}
          },
          "name": {
            "return": "string",
            "arguments": {}
          },
          "parent": {
            "return": {
              "browserTabTitle": {
                "return": "string",
                "arguments": {}
              },
              "faviconLink": {
                "return": "string",
                "arguments": {}
              },
              "id": {
                "return": "object",
                "arguments": {}
              },
              "name": {
                "return": "string",
                "arguments": {}
              },
              "parent": {
                "return": {
                  "browserTabTitle": {
                    "return": "string",
                    "arguments": {}
                  },
                  "faviconLink": {
                    "return": "string",
                    "arguments": {}
                  },
                  "id": {
                    "return": "object",
                    "arguments": {}
                  },
                  "name": {
                    "return": "string",
                    "arguments": {}
                  },
                  "parent": {
                    "return": {
                      "browserTabTitle": {
                        "return": "string",
                        "arguments": {}
                      },
                      "faviconLink": {
                        "return": "string",
                        "arguments": {}
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

ArticlePaginationAndSorting: object

offSet:
Int
perPage:
Int
sortDesc:
sortField:
Example
{
  "offSet": "number",
  "perPage": "number",
  "sortDesc": "boolean",
  "sortField": "string"
}

ArticleQueryFilter: object

createdAt:
organizationId:
searchText:
state:
updatedAt:
Example
{
  "createdAt": "object",
  "organizationId": "object",
  "searchText": "string",
  "state": "string",
  "updatedAt": "object"
}

ArticleStates: string

object
ACTIVE
object
DRAFT
object
INACTIVE

ArticleTransition: string

object
activate
object
deactivate
object
review

AssetClass: object

description:
object
return:
arguments:
object
id:
object
return:
arguments:
object
includeCash:
object
return:
arguments:
object
key:
object
return:
arguments:
object
name:
object
return:
arguments:
object
state:
object
return:
arguments:
object
translatedDescription:
object
return:
arguments:
object
translatedName:
object
return:
arguments:
object
Example
{
  "description": {
    "return": "string",
    "arguments": {}
  },
  "id": {
    "return": "object",
    "arguments": {}
  },
  "includeCash": {
    "return": "boolean",
    "arguments": {}
  },
  "key": {
    "return": "string",
    "arguments": {}
  },
  "name": {
    "return": "string",
    "arguments": {}
  },
  "state": {
    "return": "string",
    "arguments": {}
  },
  "translatedDescription": {
    "return": {
      "en": {
        "return": "string",
        "arguments": {}
      },
      "fr": {
        "return": "string",
        "arguments": {}
      }
    },
    "arguments": {}
  },
  "translatedName": {
    "return": {
      "en": {
        "return": "string",
        "arguments": {}
      },
      "fr": {
        "return": "string",
        "arguments": {}
      }
    },
    "arguments": {}
  }
}

AssetClassFilterQuery: object

organizationId:
Example
{
  "organizationId": "object"
}

AssetClassState: string

object
ACTIVE
object
ARCHIVED

AssetClassTransitions: string

object
activate
object
archive

AuthAudienceTypes: string

object
CLIENT
object
ONEHUB

AuthenticationConnections: string

object
EMAIL_AND_PASSWORD
object
EMAIL_OTP
object
ENTERPRISE

BankAccount: object

EftEligibleRatio:
object
return:
arguments:
object
bankAccountNumber:
object
return:
arguments:
object
bankAccountNumberDisclosed:
object
return:
arguments:
object
createdAt:
object
return:
arguments:
object
downloadUrls:
object
return:
String
arguments:
object
id:
object
return:
arguments:
object
institutionNumber:
object
return:
arguments:
object
name:
object
return:
arguments:
object
source:
object
return:
arguments:
object
state:
object
return:
arguments:
object
stateChanges:
object
return:
StateChanges
arguments:
object
transitNumber:
object
return:
arguments:
object
transitNumberDisclosed:
object
return:
arguments:
object
updatedAt:
object
return:
arguments:
object
user:
object
return:
arguments:
object
Example
{
  "EftEligibleRatio": {
    "return": "number",
    "arguments": {}
  },
  "bankAccountNumber": {
    "return": "string",
    "arguments": {}
  },
  "bankAccountNumberDisclosed": {
    "return": "string",
    "arguments": {}
  },
  "createdAt": {
    "return": "object",
    "arguments": {}
  },
  "downloadUrls": {
    "return": [
      "string"
    ],
    "arguments": {}
  },
  "id": {
    "return": "object",
    "arguments": {}
  },
  "institutionNumber": {
    "return": "string",
    "arguments": {}
  },
  "name": {
    "return": "string",
    "arguments": {}
  },
  "source": {
    "return": "string",
    "arguments": {}
  },
  "state": {
    "return": "string",
    "arguments": {}
  },
  "stateChanges": {
    "return": [
      "object"
    ],
    "arguments": {}
  },
  "transitNumber": {
    "return": "string",
    "arguments": {}
  },
  "transitNumberDisclosed": {
    "return": "string",
    "arguments": {}
  },
  "updatedAt": {
    "return": "object",
    "arguments": {}
  },
  "user": {
    "return": {
      "accessibleBy": {
        "return": [
          {
            "displayOptions": {
              "return": {
                "hide": {
                  "return": "boolean",
                  "arguments": {}
                },
                "order": {
                  "return": "number",
                  "arguments": {}
                }
              },
              "arguments": {}
            },
            "organizationUser": {
              "return": {
                "accessType": {
                  "return": "string",
                  "arguments": {}
                },
                "apiTokens": {
                  "return": [
                    {
                      "id": {
                        "return": "object",
                        "arguments": {}
                      },
                      "jwtToken": {
                        "return": "string",
                        "arguments": {}
                      },
                      "name": {
                        "return": "string"
                      }
                    }
                  ]
                }
              }
            }
          }
        ]
      }
    }
  }
}

BankAccountPaginationAndSorting: object

offSet:
Int
perPage:
Int
sortDesc:
sortField:
Example
{
  "offSet": "number",
  "perPage": "number",
  "sortDesc": "boolean",
  "sortField": "string"
}

BankAccountQueryFilter: object

institutionNumber:
organizationId:
state:
userId:
Example
{
  "institutionNumber": "string",
  "organizationId": "object",
  "state": "string",
  "userId": "object"
}

BankAccountSources: string

object
FLINKS
object
USER

BankAccountStates: string

object
APPROVED
object
AWAITING_REVIEW
object
REJECTED

BankAccountTransition: string

object
approve
object
reject

BankConnection: object

bankAccounts:
object
return:
BankAccount
arguments:
object
createdAt:
object
return:
arguments:
object
holderName:
object
return:
arguments:
object
id:
object
return:
arguments:
object
loginId:
object
return:
arguments:
object
state:
object
return:
arguments:
object
updatedAt:
object
return:
arguments:
object
user:
object
return:
arguments:
object
Example
{
  "bankAccounts": {
    "return": [
      {
        "EftEligibleRatio": {
          "return": "number",
          "arguments": {}
        },
        "bankAccountNumber": {
          "return": "string",
          "arguments": {}
        },
        "bankAccountNumberDisclosed": {
          "return": "string",
          "arguments": {}
        },
        "createdAt": {
          "return": "object",
          "arguments": {}
        },
        "downloadUrls": {
          "return": [
            "string"
          ],
          "arguments": {}
        },
        "id": {
          "return": "object",
          "arguments": {}
        },
        "institutionNumber": {
          "return": "string",
          "arguments": {}
        },
        "name": {
          "return": "string",
          "arguments": {}
        },
        "source": {
          "return": "string",
          "arguments": {}
        },
        "state": {
          "return": "string",
          "arguments": {}
        },
        "stateChanges": {
          "return": [
            "object"
          ],
          "arguments": {}
        },
        "transitNumber": {
          "return": "string",
          "arguments": {}
        },
        "transitNumberDisclosed": {
          "return": "string",
          "arguments": {}
        },
        "updatedAt": {
          "return": "object",
          "arguments": {}
        },
        "user": {
          "return": {
            "accessibleBy": {
              "return": [
                {
                  "displayOptions": {
                    "return": {
                      "hide": {
                        "return": "boolean",
                        "arguments": {}
                      },
                      "order": {
                        "return": "number",
                        "arguments": {}
                      }
                    },
                    "arguments": {}
                  },
                  "organizationUser": {
                    "return": {
                      "accessType": {
                        "return": "string",
                        "arguments": {}
                      },
                      "apiTokens": {
                        "return": [
                          {
                            "id": {
                              "return": "object",
                              "arguments": {}
                            },
                            "jwtToken": {
                              "return": "string"
                            }
                          }
                        ]
                      }
                    }
                  }
                }
              ]
            }
          }
        }
      }
    ]
  }
}

BankConnectionPaginationAndSorting: object

offSet:
Int
perPage:
Int
sortDesc:
sortField:
Example
{
  "offSet": "number",
  "perPage": "number",
  "sortDesc": "boolean",
  "sortField": "string"
}

BankConnectionQueryFilter: object

createdAtAfter:
createdAtBefore:
state:
userId:
Example
{
  "createdAtAfter": "object",
  "createdAtBefore": "object",
  "state": "string",
  "userId": "object"
}

BankConnectionStates: string

object
ACTIVE
object
ARCHIVED
object
PENDING

BankingConnectorProvider: object

clientIframeUrl:
object
return:
arguments:
object
customerId:
object
return:
arguments:
object
instanceId:
object
return:
arguments:
object
vendor:
object
return:
arguments:
object
Example
{
  "clientIframeUrl": {
    "return": "string",
    "arguments": {}
  },
  "customerId": {
    "return": "string",
    "arguments": {}
  },
  "instanceId": {
    "return": "string",
    "arguments": {}
  },
  "vendor": {
    "return": "string",
    "arguments": {}
  }
}

BankingConnectorProviderInput: object

clientIframeUrl:
customerId:
instanceId:
vendor:
Example
{
  "clientIframeUrl": "object",
  "customerId": "object",
  "instanceId": "object",
  "vendor": "string"
}

BankingConnectorVendors: string

object
FLINKS

Beneficiary: object

account:
object
return:
arguments:
object
allocation:
object
return:
arguments:
object
id:
object
return:
arguments:
object
name:
object
return:
arguments:
object
relation:
object
return:
arguments:
object
successorAddress:
object
return:
arguments:
object
type:
object
return:
arguments:
object
Example
{
  "account": {
    "return": {
      "affiliations": {
        "return": [
          {
            "allocation": {
              "return": "number",
              "arguments": {}
            },
            "id": {
              "return": "object",
              "arguments": {}
            },
            "relation": {
              "return": "string",
              "arguments": {}
            },
            "signatureRequired": {
              "return": "boolean",
              "arguments": {}
            },
            "type": {
              "return": "string",
              "arguments": {}
            },
            "user": {
              "return": {
                "accessibleBy": {
                  "return": [
                    {
                      "displayOptions": {
                        "return": {
                          "hide": {
                            "return": "boolean",
                            "arguments": {}
                          },
                          "order": {
                            "return": "number",
                            "arguments": {}
                          }
                        },
                        "arguments": {}
                      },
                      "organizationUser": {
                        "return": {
                          "accessType": {
                            "return": "string",
                            "arguments": {}
                          },
                          "apiTokens": {
                            "return": [
                              {
                                "id": {
                                  "return": "object",
                                  "arguments": {}
                                },
                                "jwtToken": {
                                  "return": "string",
                                  "arguments": {}
                                },
                                "name": {
                                  "return": "string",
                                  "arguments": {}
                                },
                                "organization": {
                                  "return": {
                                    "browserTabTitle": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "faviconLink": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "id": {
                                      "return": "object",
                                      "arguments": {}
                                    },
                                    "name": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "parent": {
                                      "return": {
                                        "browserTabTitle": {
                                          "return": "string",
                                          "arguments": {}
                                        },
                                        "faviconLink": {
                                          "return": "string",
                                          "arguments": {}
                                        }
                                      }
                                    }
                                  }
                                }
                              }
                            ]
                          }
                        }
                      }
                    }
                  ]
                }
              }
            }
          }
        ]
      }
    }
  }
}

BeneficiaryPaginationAndSorting: object

offSet:
Int
perPage:
Int
sortDesc:
sortField:
Example
{
  "offSet": "number",
  "perPage": "number",
  "sortDesc": "boolean",
  "sortField": "string"
}

BeneficiaryQueryFilter: object

account:
allocation:
name:
organizationId:
relation:
type:
Example
{
  "account": "object",
  "allocation": "number",
  "name": "string",
  "organizationId": "object",
  "relation": "string",
  "type": "string"
}

BeneficiaryRelation: string

object
CHILD
object
COMMON_LAW
object
FRIEND
object
GRANDPARENT
object
OTHER
object
PARENT
object
SIBLING
object
SPOUSE

BeneficiaryType: string

object
CONTINGENT_BENEFICIARY
object
PRIMARY_BENEFICIARY
object
SUCCESSOR

BillingCycle: object

billingDate:
object
return:
arguments:
object
billingSchedule:
object
return:
arguments:
object
calculatedAt:
object
return:
arguments:
object
calculationDate:
object
return:
arguments:
object
chargeableMarketValueCentsOnLastDay:
object
return:
arguments:
object
endDate:
object
return:
arguments:
object
feeCents:
object
return:
arguments:
object
id:
object
return:
arguments:
object
marketValueCentsOnLastDay:
object
return:
arguments:
object
organization:
object
return:
arguments:
object
projectedFeeAndTaxCents:
object
return:
arguments:
object
reconciledFees:
object
return:
arguments:
object
salesTaxCents:
object
return:
arguments:
object
startDate:
object
return:
arguments:
object
state:
object
return:
arguments:
object
stateChanges:
object
return:
arguments:
object
Example
{
  "billingDate": {
    "return": "object",
    "arguments": {}
  },
  "billingSchedule": {
    "return": {
      "createdAt": {
        "return": "object",
        "arguments": {}
      },
      "default": {
        "return": "boolean",
        "arguments": {}
      },
      "endDate": {
        "return": "object",
        "arguments": {}
      },
      "frequency": {
        "return": "string",
        "arguments": {}
      },
      "id": {
        "return": "object",
        "arguments": {}
      },
      "nextBillingDate": {
        "return": "object",
        "arguments": {}
      },
      "nextCalculationDate": {
        "return": "object",
        "arguments": {}
      },
      "organization": {
        "return": {
          "browserTabTitle": {
            "return": "string",
            "arguments": {}
          },
          "faviconLink": {
            "return": "string",
            "arguments": {}
          },
          "id": {
            "return": "object",
            "arguments": {}
          },
          "name": {
            "return": "string",
            "arguments": {}
          },
          "parent": {
            "return": {
              "browserTabTitle": {
                "return": "string",
                "arguments": {}
              },
              "faviconLink": {
                "return": "string",
                "arguments": {}
              },
              "id": {
                "return": "object",
                "arguments": {}
              },
              "name": {
                "return": "string",
                "arguments": {}
              },
              "parent": {
                "return": {
                  "browserTabTitle": {
                    "return": "string",
                    "arguments": {}
                  },
                  "faviconLink": {
                    "return": "string",
                    "arguments": {}
                  },
                  "id": {
                    "return": "object",
                    "arguments": {}
                  },
                  "name": {
                    "return": "string",
                    "arguments": {}
                  },
                  "parent": {
                    "return": {
                      "browserTabTitle": {
                        "return": "string",
                        "arguments": {}
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

BillingCycleQueryFilter: object

billingDateAfter:
billingDateBefore:
billingScheduleIds:
ObjectID
organizationId:
states:
BillingCycleStates
Example
{
  "billingDateAfter": "object",
  "billingDateBefore": "object",
  "billingScheduleIds": [
    "object"
  ],
  "organizationId": "object",
  "states": [
    "string"
  ]
}

BillingCycleStates: string

object
APPROVED
object
AWAITING_REVIEW
object
CYCLE_COMPLETED
object
CYCLE_IN_PROGRESS
object
PROCESSED

BillingCycleTransition: string

object
approve
object
process

BillingSchedule: object

BillingSchedule defines the schedule on which the fees will be collected.

createdAt:
object
return:
arguments:
object
default:
object

It defines whether this is the default BillingSchedule within its organization. The default BillingSchedule will be used in case there is no specific BillingSchedule assigned to the subAccount, Account, User, or ClientGroup. If the organization does not inherit parent BillingSchedules, there must be one default BillingSchedule, otherwise the default BillingSchedule of the next parent organization will be considered.

return:
arguments:
object
endDate:
object

It is the end date of the current billing period. If not specified, it will be automatically set based on the nextBillingDate and frequency.

return:
arguments:
object
frequency:
object
return:
arguments:
object
id:
object
return:
arguments:
object
nextBillingDate:
object

nextBillingDate is updated at every billing cycle based on the defined frequency until the endDate (if defined).

return:
arguments:
object
nextCalculationDate:
object

nextCalculationDate is updated at every billing cycle based on the defined frequency until the endDate (if defined).

return:
arguments:
object
organization:
object
return:
arguments:
object
requestId:
object
return:
arguments:
object
startDate:
object

It is the start date of the current billing period. If not specified, it will be automatically set based on the nextBillingDate and frequency.

return:
arguments:
object
state:
object
return:
arguments:
object
stateChanges:
object
return:
arguments:
object
updatedAt:
object
return:
arguments:
object
Example
{
  "createdAt": {
    "return": "object",
    "arguments": {}
  },
  "default": {
    "return": "boolean",
    "arguments": {}
  },
  "endDate": {
    "return": "object",
    "arguments": {}
  },
  "frequency": {
    "return": "string",
    "arguments": {}
  },
  "id": {
    "return": "object",
    "arguments": {}
  },
  "nextBillingDate": {
    "return": "object",
    "arguments": {}
  },
  "nextCalculationDate": {
    "return": "object",
    "arguments": {}
  },
  "organization": {
    "return": {
      "browserTabTitle": {
        "return": "string",
        "arguments": {}
      },
      "faviconLink": {
        "return": "string",
        "arguments": {}
      },
      "id": {
        "return": "object",
        "arguments": {}
      },
      "name": {
        "return": "string",
        "arguments": {}
      },
      "parent": {
        "return": {
          "browserTabTitle": {
            "return": "string",
            "arguments": {}
          },
          "faviconLink": {
            "return": "string",
            "arguments": {}
          },
          "id": {
            "return": "object",
            "arguments": {}
          },
          "name": {
            "return": "string",
            "arguments": {}
          },
          "parent": {
            "return": {
              "browserTabTitle": {
                "return": "string",
                "arguments": {}
              },
              "faviconLink": {
                "return": "string",
                "arguments": {}
              },
              "id": {
                "return": "object",
                "arguments": {}
              },
              "name": {
                "return": "string",
                "arguments": {}
              },
              "parent": {
                "return": {
                  "browserTabTitle": {
                    "return": "string",
                    "arguments": {}
                  },
                  "faviconLink": {
                    "return": "string",
                    "arguments": {}
                  },
                  "id": {
                    "return": "object"
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

BillingScheduleFrequencies: string

object
ANNUAL
object
MONTHLY
object
QUARTERLY
object
SEMESTRAL

BillingScheduleQueryFilter: object

frequencies:
BillingScheduleFrequencies
nextBillingDateAfter:
nextBillingDateBefore:
organizationId:
states:
BillingScheduleStates
Example
{
  "frequencies": [
    "string"
  ],
  "nextBillingDateAfter": "object",
  "nextBillingDateBefore": "object",
  "organizationId": "object",
  "states": [
    "string"
  ]
}

BillingScheduleStates: string

object
ACTIVE
object
ARCHIVED
object
INACTIVE

BillingScheduleTransition: string

object
activate
object
archive
object
deactivate

Boolean: boolean

The Boolean scalar type represents true or false.

Example
boolean

Branch: object

financialProduct:
object

The Financial product.

return:
arguments:
object
id:
object

This is the branchId and it is auto-generated by OneVest for each Branch.

return:
arguments:
object
isCashEquivalent:
object
return:
arguments:
object
percentage:
object

This is the percentage allocated to this Branch.

return:
arguments:
object
taxRank:
object
return:
Int
arguments:
object
Example
{
  "financialProduct": {
    "return": {
      "assignable": {
        "return": "boolean",
        "arguments": {}
      },
      "autoUpdatePrices": {
        "return": "boolean",
        "arguments": {}
      },
      "children": {
        "return": [
          {
            "financialProduct": {
              "return": {
                "assignable": {
                  "return": "boolean",
                  "arguments": {}
                },
                "autoUpdatePrices": {
                  "return": "boolean",
                  "arguments": {}
                },
                "children": {
                  "return": [
                    {
                      "financialProduct": {
                        "return": {
                          "assignable": {
                            "return": "boolean",
                            "arguments": {}
                          },
                          "autoUpdatePrices": {
                            "return": "boolean",
                            "arguments": {}
                          },
                          "children": {
                            "return": [
                              {
                                "financialProduct": {
                                  "return": {
                                    "assignable": {
                                      "return": "boolean",
                                      "arguments": {}
                                    },
                                    "autoUpdatePrices": {
                                      "return": "boolean",
                                      "arguments": {}
                                    },
                                    "children": {
                                      "return": [
                                        {
                                          "financialProduct": {
                                            "return": {
                                              "assignable": {
                                                "return": "boolean",
                                                "arguments": {}
                                              },
                                              "autoUpdatePrices": {
                                                "return": "boolean",
                                                "arguments": {}
                                              },
                                              "children": {
                                                "return": [
                                                  {
                                                    "financialProduct": {
                                                      "return": {
                                                        "assignable": {
                                                          "return": "boolean",
                                                          "arguments": {}
                                                        },
                                                        "autoUpdatePrices": {
                                                          "return": "boolean",
                                                          "arguments": {}
                                                        },
                                                        "children": {
                                                          "return": [
                                                            {
                                                              "financialProduct": {
                                                                "return": {
                                                                  "assignable": {
                                                                    "return": "boolean",
                                                                    "arguments": {}
                                                                  },
                                                                  "autoUpdatePrices": {}
                                                                }
                                                              }
                                                            }
                                                          ]
                                                        }
                                                      }
                                                    }
                                                  }
                                                ]
                                              }
                                            }
                                          }
                                        }
                                      ]
                                    }
                                  }
                                }
                              }
                            ]
                          }
                        }
                      }
                    }
                  ]
                }
              }
            }
          }
        ]
      }
    }
  }
}

BranchInput: object

financialProductId:

This is the child financialProductId

isCashEquivalent:
percentage:

This is the percentage allocated to this Branch.

Example
{
  "financialProductId": "object",
  "isCashEquivalent": "boolean",
  "percentage": "number"
}

BulkImport: object

createdAt:
object
return:
arguments:
object
id:
object
return:
arguments:
object
name:
object
return:
arguments:
object
organization:
object
return:
arguments:
object
organizationUser:
object
return:
arguments:
object
state:
object
return:
arguments:
object
updatedAt:
object
return:
arguments:
object
Example
{
  "createdAt": {
    "return": "object",
    "arguments": {}
  },
  "id": {
    "return": "object",
    "arguments": {}
  },
  "name": {
    "return": "string",
    "arguments": {}
  },
  "organization": {
    "return": {
      "browserTabTitle": {
        "return": "string",
        "arguments": {}
      },
      "faviconLink": {
        "return": "string",
        "arguments": {}
      },
      "id": {
        "return": "object",
        "arguments": {}
      },
      "name": {
        "return": "string",
        "arguments": {}
      },
      "parent": {
        "return": {
          "browserTabTitle": {
            "return": "string",
            "arguments": {}
          },
          "faviconLink": {
            "return": "string",
            "arguments": {}
          },
          "id": {
            "return": "object",
            "arguments": {}
          },
          "name": {
            "return": "string",
            "arguments": {}
          },
          "parent": {
            "return": {
              "browserTabTitle": {
                "return": "string",
                "arguments": {}
              },
              "faviconLink": {
                "return": "string",
                "arguments": {}
              },
              "id": {
                "return": "object",
                "arguments": {}
              },
              "name": {
                "return": "string",
                "arguments": {}
              },
              "parent": {
                "return": {
                  "browserTabTitle": {
                    "return": "string",
                    "arguments": {}
                  },
                  "faviconLink": {
                    "return": "string",
                    "arguments": {}
                  },
                  "id": {
                    "return": "object",
                    "arguments": {}
                  },
                  "name": {
                    "return": "string",
                    "arguments": {}
                  },
                  "parent": {
                    "return": {
                      "browserTabTitle": {
                        "return": "string",
                        "arguments": {}
                      },
                      "faviconLink": {
                        "return": "string",
                        "arguments": {}
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

BulkImportQueryFilter: object

createdAtAfter:
createdAtBefore:
name:
organizationId:
organizationUserId:
states:
BulkImportStates
Example
{
  "createdAtAfter": "object",
  "createdAtBefore": "object",
  "name": "object",
  "organizationId": "object",
  "organizationUserId": "object",
  "states": [
    "string"
  ]
}

BulkImportStates: string

object
CANCELED
object
COMPLETED
object
FAILED
object
INITIATED
object
PROCESSING

BulkImportTransition: string

object
cancel
object
complete
object
fail
object
process

BulkTrade: object

actualPriceCents:
financialProductId:
totalQuantity:
Int
Example
{
  "actualPriceCents": "number",
  "financialProductId": "object",
  "totalQuantity": "number"
}

BulkTradeInput: object

actualPriceCents:
financialProductId:
totalQuantity:
Int
Example
{
  "actualPriceCents": "number",
  "financialProductId": "object",
  "totalQuantity": "number"
}

BulkTradePaginationAndSorting: object

offSet:
Int
perPage:
Int
sortDesc:
sortField:
Example
{
  "offSet": "number",
  "perPage": "number",
  "sortDesc": "boolean",
  "sortField": "string"
}

BulkTradeRequest: object

createdAt:
object
return:
arguments:
object
id:
object
return:
arguments:
object
source:
object
return:
arguments:
object
sourceId:
object
return:
arguments:
object
state:
object
return:
arguments:
object
stateChanges:
object
return:
StateChanges
arguments:
object
updatedAt:
object
return:
arguments:
object
Example
{
  "createdAt": {
    "return": "object",
    "arguments": {}
  },
  "id": {
    "return": "object",
    "arguments": {}
  },
  "source": {
    "return": "string",
    "arguments": {}
  },
  "sourceId": {
    "return": "object",
    "arguments": {}
  },
  "state": {
    "return": "string",
    "arguments": {}
  },
  "stateChanges": {
    "return": [
      "object"
    ],
    "arguments": {}
  },
  "updatedAt": {
    "return": "object",
    "arguments": {}
  }
}

BulkTradeRequestQueryFilter: object

source:
sourceId:
state:
Example
{
  "source": "string",
  "sourceId": "object",
  "state": "string"
}

BulkTradeRequestSources: string

object
GOAL
object
PORTFOLIO_OPTIMIZER
object
REBALANCE
object
SUB_ACCOUNT

BulkTradeRequestStates: string

object
CANCELED
object
COMPLETED
object
DRAFT
object
REQUESTED

BulkTradeRequestTransition: string

object
cancel
object
complete
object
draft
object
request

BulkTradeRequestType: object

bulkTrades:
object
return:
AccountBulkTradeRequest
arguments:
object
type:
object
return:
arguments:
object
Example
{
  "bulkTrades": {
    "return": [
      {
        "_id": {
          "return": "string",
          "arguments": {}
        },
        "actualTotal": {
          "return": "number",
          "arguments": {}
        },
        "actualTradePriceCents": {
          "return": "number",
          "arguments": {}
        },
        "actualTradePriceInCurrencyCents": {
          "return": "number",
          "arguments": {}
        },
        "currency": {
          "return": "string",
          "arguments": {}
        },
        "exchange": {
          "return": "string",
          "arguments": {}
        },
        "expectedTradePriceCents": {
          "return": "number",
          "arguments": {}
        },
        "expectedTradePriceInCurrencyCents": {
          "return": "number",
          "arguments": {}
        },
        "total": {
          "return": "number",
          "arguments": {}
        }
      }
    ],
    "arguments": {}
  },
  "type": {
    "return": "string",
    "arguments": {}
  }
}

BulkTradeRun: object

allTradeRequestsByExchange:
object
return:
TotalIncompleteTradeRequests
arguments:
object
allocationFileUrls:
object
return:
String
arguments:
object
autoFillActualQuantity:
object
return:
arguments:
object
bulkMutualFundTrades:
object
return:
AccountBulkMutualFundTrade
arguments:
object
bulkPTFFileUrls:
object
return:
String
arguments:
object
bulkTradeRequests:
object
return:
BulkTradeRequestType
arguments:
object
exchanges:
Exchanges
buyBulkTradeFileUrl:
object
return:
arguments:
object
createdAt:
object
return:
arguments:
object
id:
object
return:
arguments:
object
incompleteTradeRequestsByExchange:
object
return:
TotalIncompleteTradeRequests
arguments:
object
PTF:
mutualFundFileUrl:
object
return:
arguments:
object
organization:
object
return:
arguments:
object
ptfAllocationFileUrls:
object
return:
String
arguments:
object
sellBulkTradeFileUrl:
object
return:
arguments:
object
state:
object
return:
arguments:
object
updatedAt:
object
return:
arguments:
object
Example
{
  "allTradeRequestsByExchange": {
    "return": [
      {
        "exchange": {
          "return": "string",
          "arguments": {}
        },
        "total": {
          "return": "number",
          "arguments": {}
        }
      }
    ],
    "arguments": {}
  },
  "allocationFileUrls": {
    "return": [
      "string"
    ],
    "arguments": {}
  },
  "autoFillActualQuantity": {
    "return": "boolean",
    "arguments": {}
  },
  "bulkMutualFundTrades": {
    "return": [
      {
        "currency": {
          "return": "string",
          "arguments": {}
        },
        "exchange": {
          "return": "string",
          "arguments": {}
        },
        "id": {
          "return": "object",
          "arguments": {}
        },
        "moneyAllocatedCents": {
          "return": "number",
          "arguments": {}
        },
        "ticker": {
          "return": "string",
          "arguments": {}
        },
        "type": {
          "return": "string",
          "arguments": {}
        }
      }
    ],
    "arguments": {}
  },
  "bulkPTFFileUrls": {
    "return": [
      "string"
    ],
    "arguments": {}
  },
  "bulkTradeRequests": {
    "return": [
      {
        "bulkTrades": {
          "return": [
            {
              "_id": {
                "return": "string",
                "arguments": {}
              },
              "actualTotal": {
                "return": "number",
                "arguments": {}
              },
              "actualTradePriceCents": {
                "return": "number",
                "arguments": {}
              },
              "actualTradePriceInCurrencyCents": {
                "return": "number",
                "arguments": {}
              },
              "currency": {
                "return": "string",
                "arguments": {}
              },
              "exchange": {
                "return": "string",
                "arguments": {}
              },
              "expectedTradePriceCents": {
                "return": "number",
                "arguments": {}
              },
              "expectedTradePriceInCurrencyCents": {
                "return": "number",
                "arguments": {}
              },
              "total": {
                "return": "number"
              }
            }
          ]
        }
      }
    ]
  }
}

BulkTradeRunAllocation: object

account:
object
return:
arguments:
object
corporateOffsetAccount:
object
return:
arguments:
object
externalId:
object
return:
arguments:
object
fXRate:
object
return:
arguments:
object
fillPrice:
object
return:
arguments:
object
id:
object
return:
arguments:
object
market:
object
return:
arguments:
object
settlementCurrency:
object
return:
arguments:
object
settlementDate:
object
return:
arguments:
object
shareQuantity:
object
return:
arguments:
object
side:
object
return:
arguments:
object
symbol:
object
return:
arguments:
object
tradeCurrency:
object
return:
arguments:
object
tradeDate:
object
return:
arguments:
object
tradeValue:
object
return:
arguments:
object
Example
{
  "account": {
    "return": "string",
    "arguments": {}
  },
  "corporateOffsetAccount": {
    "return": "string",
    "arguments": {}
  },
  "externalId": {
    "return": "string",
    "arguments": {}
  },
  "fXRate": {
    "return": "number",
    "arguments": {}
  },
  "fillPrice": {
    "return": "number",
    "arguments": {}
  },
  "id": {
    "return": "string",
    "arguments": {}
  },
  "market": {
    "return": "string",
    "arguments": {}
  },
  "settlementCurrency": {
    "return": "string",
    "arguments": {}
  },
  "settlementDate": {
    "return": "object",
    "arguments": {}
  },
  "shareQuantity": {
    "return": "number",
    "arguments": {}
  },
  "side": {
    "return": "string",
    "arguments": {}
  },
  "symbol": {
    "return": "string",
    "arguments": {}
  },
  "tradeCurrency": {
    "return": "string",
    "arguments": {}
  },
  "tradeDate": {
    "return": "object",
    "arguments": {}
  },
  "tradeValue": {
    "return": "number",
    "arguments": {}
  }
}

BulkTradeRunAllocationsFilter: object

bulkTradeRunId:
isPTF:
Example
{
  "bulkTradeRunId": "object",
  "isPTF": "boolean"
}

BulkTradeRunAllocationsPagination: object

offSet:
Int
perPage:
Int
Example
{
  "offSet": "number",
  "perPage": "number"
}

BulkTradeRunPaginationAndSorting: object

offSet:
Int
perPage:
Int
sortDesc:
sortField:
Example
{
  "offSet": "number",
  "perPage": "number",
  "sortDesc": "boolean",
  "sortField": "string"
}

BulkTradeRunQueryFilter: object

organizationId:
state:
Example
{
  "organizationId": "object",
  "state": "string"
}

BulkTradeRunReason: object

id:
object
return:
arguments:
object
reason:
object
return:
arguments:
object
total:
object
return:
Int
arguments:
object
unblockedSince:
object
return:
arguments:
object
Example
{
  "id": {
    "return": "object",
    "arguments": {}
  },
  "reason": {
    "return": "string",
    "arguments": {}
  },
  "total": {
    "return": "number",
    "arguments": {}
  },
  "unblockedSince": {
    "return": "object",
    "arguments": {}
  }
}

BulkTradeRunReasons: string

object
ILLIQUID
object
PAIRED
object
UNBLOCKED_BUYS
object
UNPAIRED

BulkTradeRunStates: string

object
ALLOCATIONS_COMPLETED
object
ALLOCATIONS_INITIATED
object
BULK_TRADES_COMPLETED
object
BULK_TRADES_FILES_GENERATING
object
BULK_TRADES_INITIATED
object
CANCELED
object
COMPLETED
object
COMPLETED_PENDING_PTFS
object
GENERATING

BulkTradeRunTransition: string

object
cancel
object
generateBulkTradeFiles
object
initiateAllocations
object
publishAllocations
object
regenerate
object
resetBulkTrades

BulkTradeType: object

bulkTrades:
object
return:
AccountBulkTrade
arguments:
object
type:
object
return:
arguments:
object
Example
{
  "bulkTrades": {
    "return": [
      {
        "_id": {
          "return": "string",
          "arguments": {}
        },
        "currency": {
          "return": "string",
          "arguments": {}
        },
        "exchange": {
          "return": "string",
          "arguments": {}
        },
        "expectedPriceCents": {
          "return": "number",
          "arguments": {}
        },
        "expectedPriceInCurrencyCents": {
          "return": "number",
          "arguments": {}
        },
        "total": {
          "return": "number",
          "arguments": {}
        }
      }
    ],
    "arguments": {}
  },
  "type": {
    "return": "string",
    "arguments": {}
  }
}

BulkTransitionFlagsInput: object

flagIds:
ObjectID
transition:
Example
{
  "flagIds": [
    "object"
  ],
  "transition": "string"
}

BulkTransitionFlagsResponse: object

flags:
object
return:
Flag
arguments:
object
Example
{
  "flags": {
    "return": [
      {
        "account": {
          "return": {
            "affiliations": {
              "return": [
                {
                  "allocation": {
                    "return": "number",
                    "arguments": {}
                  },
                  "id": {
                    "return": "object",
                    "arguments": {}
                  },
                  "relation": {
                    "return": "string",
                    "arguments": {}
                  },
                  "signatureRequired": {
                    "return": "boolean",
                    "arguments": {}
                  },
                  "type": {
                    "return": "string",
                    "arguments": {}
                  },
                  "user": {
                    "return": {
                      "accessibleBy": {
                        "return": [
                          {
                            "displayOptions": {
                              "return": {
                                "hide": {
                                  "return": "boolean",
                                  "arguments": {}
                                },
                                "order": {
                                  "return": "number",
                                  "arguments": {}
                                }
                              },
                              "arguments": {}
                            },
                            "organizationUser": {
                              "return": {
                                "accessType": {
                                  "return": "string",
                                  "arguments": {}
                                },
                                "apiTokens": {
                                  "return": [
                                    {
                                      "id": {
                                        "return": "object",
                                        "arguments": {}
                                      },
                                      "jwtToken": {
                                        "return": "string",
                                        "arguments": {}
                                      },
                                      "name": {
                                        "return": "string",
                                        "arguments": {}
                                      },
                                      "organization": {
                                        "return": {
                                          "browserTabTitle": {
                                            "return": "string",
                                            "arguments": {}
                                          },
                                          "faviconLink": {
                                            "return": "string",
                                            "arguments": {}
                                          },
                                          "id": {
                                            "return": "object",
                                            "arguments": {}
                                          },
                                          "name": {
                                            "return": "string",
                                            "arguments": {}
                                          },
                                          "parent": {
                                            "return": {
                                              "browserTabTitle": {
                                                "return": "string",
                                                "arguments": {}
                                              }
                                            }
                                          }
                                        }
                                      }
                                    }
                                  ]
                                }
                              }
                            }
                          }
                        ]
                      }
                    }
                  }
                }
              ]
            }
          }
        }
      }
    ]
  }
}

CalculateGoalSuitabilityScoreInput: object

riskQuestion1:
timeHorizon:
Example
{
  "riskQuestion1": "string",
  "timeHorizon": "string"
}

CalculatePostRebalanceMetricsInput: object

rebalanceId:
Example
{
  "rebalanceId": "object"
}

CalculatePostRebalanceMetricsResponse: object

rebalanceMetrics:
object
return:
arguments:
object
Example
{
  "rebalanceMetrics": {
    "return": {
      "accounts": {
        "return": "number",
        "arguments": {}
      },
      "buyQuantity": {
        "return": "number",
        "arguments": {}
      },
      "buyValueCents": {
        "return": "object",
        "arguments": {}
      },
      "full": {
        "return": "boolean",
        "arguments": {}
      },
      "id": {
        "return": "object",
        "arguments": {}
      },
      "screenedAt": {
        "return": "object",
        "arguments": {}
      },
      "sellQuantity": {
        "return": "number",
        "arguments": {}
      },
      "sellValueCents": {
        "return": "object",
        "arguments": {}
      },
      "state": {
        "return": "string",
        "arguments": {}
      },
      "subAccounts": {
        "return": "number",
        "arguments": {}
      },
      "type": {
        "return": "string",
        "arguments": {}
      },
      "users": {
        "return": "number",
        "arguments": {}
      }
    },
    "arguments": {}
  }
}

CalculatePreRebalanceMetricsInput: object

full:
organizationId:
Example
{
  "full": "boolean",
  "organizationId": "object"
}

CalculatePreRebalanceMetricsResponse: object

rebalanceMetrics:
object
return:
arguments:
object
Example
{
  "rebalanceMetrics": {
    "return": {
      "accounts": {
        "return": "number",
        "arguments": {}
      },
      "buyQuantity": {
        "return": "number",
        "arguments": {}
      },
      "buyValueCents": {
        "return": "object",
        "arguments": {}
      },
      "full": {
        "return": "boolean",
        "arguments": {}
      },
      "id": {
        "return": "object",
        "arguments": {}
      },
      "screenedAt": {
        "return": "object",
        "arguments": {}
      },
      "sellQuantity": {
        "return": "number",
        "arguments": {}
      },
      "sellValueCents": {
        "return": "object",
        "arguments": {}
      },
      "state": {
        "return": "string",
        "arguments": {}
      },
      "subAccounts": {
        "return": "number",
        "arguments": {}
      },
      "type": {
        "return": "string",
        "arguments": {}
      },
      "users": {
        "return": "number",
        "arguments": {}
      }
    },
    "arguments": {}
  }
}

CalculateTradeRequestFillsInput: object

bulkTradeRunId:
bulkTrades:
BulkTradeInput
currencyFallbackConversions:
CurrencyFallbackConversion
type:
Example
{
  "bulkTradeRunId": "object",
  "bulkTrades": [
    {
      "actualPriceCents": "number",
      "financialProductId": "object",
      "totalQuantity": "number"
    }
  ],
  "currencyFallbackConversions": [
    {
      "from": "string",
      "rate": "number",
      "to": "string"
    }
  ],
  "type": "string"
}

CalculateTradeRequestFillsResponse: object

success:
object
return:
arguments:
object
Example
{
  "success": {
    "return": "boolean",
    "arguments": {}
  }
}

CalculateWithdrawFeesInput: object

accountId:
amountCents:
Int
isfullWithdraw:
net:

Setting net to true allows you to receive the amount of fees required to have a net value of amountCents

Example
{
  "accountId": "object",
  "amountCents": "number",
  "isfullWithdraw": "boolean",
  "net": "boolean"
}

CalculateWithdrawFeesResponse: object

withdrawFees:
object
return:
WithdrawFee
arguments:
object
Example
{
  "withdrawFees": {
    "return": [
      {
        "amountCents": {
          "return": "number",
          "arguments": {}
        },
        "type": {
          "return": "string",
          "arguments": {}
        }
      }
    ],
    "arguments": {}
  }
}

CancelScheduledTransferResponse: object

scheduledTransfer:
object
return:
arguments:
object
Example
{
  "scheduledTransfer": {
    "return": {
      "amountCents": {
        "return": "object",
        "arguments": {}
      },
      "bankAccount": {
        "return": {
          "EftEligibleRatio": {
            "return": "number",
            "arguments": {}
          },
          "bankAccountNumber": {
            "return": "string",
            "arguments": {}
          },
          "bankAccountNumberDisclosed": {
            "return": "string",
            "arguments": {}
          },
          "createdAt": {
            "return": "object",
            "arguments": {}
          },
          "downloadUrls": {
            "return": [
              "string"
            ],
            "arguments": {}
          },
          "id": {
            "return": "object",
            "arguments": {}
          },
          "institutionNumber": {
            "return": "string",
            "arguments": {}
          },
          "name": {
            "return": "string",
            "arguments": {}
          },
          "source": {
            "return": "string",
            "arguments": {}
          },
          "state": {
            "return": "string",
            "arguments": {}
          },
          "stateChanges": {
            "return": [
              "object"
            ],
            "arguments": {}
          },
          "transitNumber": {
            "return": "string",
            "arguments": {}
          },
          "transitNumberDisclosed": {
            "return": "string",
            "arguments": {}
          },
          "updatedAt": {
            "return": "object",
            "arguments": {}
          },
          "user": {
            "return": {
              "accessibleBy": {
                "return": [
                  {
                    "displayOptions": {
                      "return": {
                        "hide": {
                          "return": "boolean",
                          "arguments": {}
                        },
                        "order": {
                          "return": "number",
                          "arguments": {}
                        }
                      },
                      "arguments": {}
                    },
                    "organizationUser": {
                      "return": {
                        "accessType": {
                          "return": "string",
                          "arguments": {}
                        },
                        "apiTokens": {
                          "return": [
                            {
                              "id": {}
                            }
                          ]
                        }
                      }
                    }
                  }
                ]
              }
            }
          }
        }
      }
    }
  }
}

CancelSubTradeRequestsInput: object

bulkTradeRequestId:
sourceId:
Example
{
  "bulkTradeRequestId": "object",
  "sourceId": "object"
}

CancelTransferResponse: object

transfer:
object
return:
arguments:
object
Example
{
  "transfer": {
    "return": {
      "alertReport": {
        "return": {
          "id": {
            "return": "object",
            "arguments": {}
          },
          "reason": {
            "return": "string",
            "arguments": {}
          },
          "rules": {
            "return": [
              {
                "id": {
                  "return": "object",
                  "arguments": {}
                },
                "translatedDescription": {
                  "return": {
                    "en": {
                      "return": "string",
                      "arguments": {}
                    },
                    "fr": {
                      "return": "string",
                      "arguments": {}
                    }
                  },
                  "arguments": {}
                },
                "type": {
                  "return": "string",
                  "arguments": {}
                }
              }
            ],
            "arguments": {}
          },
          "state": {
            "return": "string",
            "arguments": {}
          },
          "transfer": {
            "return": {
              "alertReport": {
                "return": {
                  "id": {
                    "return": "object",
                    "arguments": {}
                  },
                  "reason": {
                    "return": "string",
                    "arguments": {}
                  },
                  "rules": {
                    "return": [
                      {
                        "id": {
                          "return": "object",
                          "arguments": {}
                        },
                        "translatedDescription": {
                          "return": {
                            "en": {
                              "return": "string",
                              "arguments": {}
                            },
                            "fr": {
                              "return": "string",
                              "arguments": {}
                            }
                          },
                          "arguments": {}
                        },
                        "type": {
                          "return": "string",
                          "arguments": {}
                        }
                      }
                    ],
                    "arguments": {}
                  },
                  "state": {
                    "return": "string",
                    "arguments": {}
                  },
                  "transfer": {
                    "return": {
                      "alertReport": {
                        "return": {
                          "id": {
                            "return": "object",
                            "arguments": {}
                          },
                          "reason": {
                            "return": "string"
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

CapitalGainsAndLosses: object

account:
object
return:
arguments:
object
id:
object
return:
arguments:
object
totalCents:
object
return:
Int
arguments:
object
year:
object
return:
Int
arguments:
object
Example
{
  "account": {
    "return": "object",
    "arguments": {}
  },
  "id": {
    "return": "object",
    "arguments": {}
  },
  "totalCents": {
    "return": "number",
    "arguments": {}
  },
  "year": {
    "return": "number",
    "arguments": {}
  }
}

ChangeTypes: string

object
AFFILIATE_ADDED
object
AFFILIATE_CHANGED
object
AGREEMENT_CHANGE
object
FILE_DOCUMENT_DELETE
object
NEW_SUB_ACCOUNT
object
OTHER
object
PII_UPDATED
object
PORTFOLIO_CHANGE
object
PORTFOLIO_UPDATED
object
SCHEDULED_TRANSFER_UPDATED
object
USERS_REQUIRED_TO_SIGN_UPDATED

ClientGroup: object

ClientGroup

accountNumber:
object
return:
arguments:
object
accounts:
object
return:
Account
arguments:
object
allIncompleteFormAgreements:
object
return:
IncompleteFormAgreement
arguments:
object
allLatestFormAgreements:
object
return:
FormAgreement
arguments:
object
applicableBillingSchedule:
object
return:
arguments:
object
applicableFeeTier:
object
return:
arguments:
object
availableCurrencies:
object
return:
AccountCurrencyTypes
arguments:
object
billingSchedule:
object
return:
arguments:
object
businessIsMemberOfIiroc:
object
return:
arguments:
object
businessType:
object

Coporate Business Type

return:
arguments:
object
completedAt:
object

The date and time the clientGroup was completed

return:
arguments:
object
corporationCountry:
object
return:
arguments:
object
custodianSnapshotHistory:
object
return:
CustodianSnapshotHistory
arguments:
object
endDate:
input:
startDate:
custodianStatistics:
object
return:
arguments:
object
endDate:
input:
startDate:
establishedDate:
object
return:
arguments:
object
feeTier:
object
return:
arguments:
object
goals:
object
return:
Goal
arguments:
object
id:
object

ClientGroupID

return:
arguments:
object
incompleteFields:
object

Fields required to be completed to transition a clientGroup to a completed state

return:
String
arguments:
object
incompleteFormAgreements:
object

Lists remaining forms to be signed for this clientGroup.

return:
IncompleteFormAgreement
arguments:
object
incorporationNumber:
object
return:
arguments:
object
integrations:
object
return:
ClientGroupIntegration
arguments:
object
latestFormAgreements:
object

Lists latest signed forms for this clientGroup.

return:
FormAgreement
arguments:
object
logs:
object
return:
arguments:
object
input:
name:
object
return:
arguments:
object
organization:
object
return:
arguments:
object
phone:
object
return:
arguments:
object
physicalAddress:
object

coporate address

return:
arguments:
object
primaryEmail:
object
return:
arguments:
object
primaryUser:
object

Primary contact user. It needs to be in the relationship list.

return:
arguments:
object
relationships:
object

relationships is a array with relation types and relation user

return:
Relationship
arguments:
object
state:
object
return:
arguments:
object
statistics:
object
return:
arguments:
object
forUserId:
input:
taxNumber:
object

Encrypted corporate Tax number

return:
arguments:
object
taxNumberDisclosed:
object
return:
arguments:
object
type:
object

ClientGroupTypes derived from the ENUM

return:
arguments:
object
Example
{
  "accountNumber": {
    "return": "string",
    "arguments": {}
  },
  "accounts": {
    "return": [
      {
        "affiliations": {
          "return": [
            {
              "allocation": {
                "return": "number",
                "arguments": {}
              },
              "id": {
                "return": "object",
                "arguments": {}
              },
              "relation": {
                "return": "string",
                "arguments": {}
              },
              "signatureRequired": {
                "return": "boolean",
                "arguments": {}
              },
              "type": {
                "return": "string",
                "arguments": {}
              },
              "user": {
                "return": {
                  "accessibleBy": {
                    "return": [
                      {
                        "displayOptions": {
                          "return": {
                            "hide": {
                              "return": "boolean",
                              "arguments": {}
                            },
                            "order": {
                              "return": "number",
                              "arguments": {}
                            }
                          },
                          "arguments": {}
                        },
                        "organizationUser": {
                          "return": {
                            "accessType": {
                              "return": "string",
                              "arguments": {}
                            },
                            "apiTokens": {
                              "return": [
                                {
                                  "id": {
                                    "return": "object",
                                    "arguments": {}
                                  },
                                  "jwtToken": {
                                    "return": "string",
                                    "arguments": {}
                                  },
                                  "name": {
                                    "return": "string",
                                    "arguments": {}
                                  },
                                  "organization": {
                                    "return": {
                                      "browserTabTitle": {
                                        "return": "string",
                                        "arguments": {}
                                      },
                                      "faviconLink": {
                                        "return": "string",
                                        "arguments": {}
                                      },
                                      "id": {
                                        "return": "object",
                                        "arguments": {}
                                      },
                                      "name": {
                                        "return": "string",
                                        "arguments": {}
                                      },
                                      "parent": {
                                        "return": {
                                          "browserTabTitle": {
                                            "return": "string"
                                          }
                                        }
                                      }
                                    }
                                  }
                                }
                              ]
                            }
                          }
                        }
                      }
                    ]
                  }
                }
              }
            }
          ]
        }
      }
    ]
  }
}

ClientGroupIntegration: object

The integration enum and unique integration id

iid:
object

The id for the entity, in the given specific integration

return:
arguments:
object
type:
object

Enumeration for the integration type

return:
arguments:
object
Example
{
  "iid": {
    "return": "string",
    "arguments": {}
  },
  "type": {
    "return": "string",
    "arguments": {}
  }
}

ClientGroupIntegrationInput: object

Input type for integrations field

externalId:

externalId external source id

groupId:

group id the custodian connection

iid:

iid is the unique identifier for this entity in the given integration

type:

Integrations type derives from enumeration

Example
{
  "externalId": "object",
  "groupId": "object",
  "iid": "object",
  "type": "string"
}

ClientGroupIntegrationTypes: string

Integrations for ClientGroup

object
APEX
object
CIBC_MELLON
object
CIIS
object
ENVESTNET
object
FC
object
FUNDSERV
object
IBKR
object
NBIN
object
NO_CONNECTION
object
PERSHING
object
RBC
object
SALESFORCE
object
SCHWAB
object
TEMPLATE

ClientGroupLogsInput: object

filter:
pagination:
Example
{
  "filter": {
    "after": "object",
    "before": "object",
    "clientGroupOnly": "boolean"
  },
  "pagination": {
    "offSet": "number",
    "perPage": "number",
    "sortDesc": "boolean",
    "sortField": "string"
  }
}

ClientGroupLogsQueryFilter: object

after:
before:
clientGroupOnly:
Example
{
  "after": "object",
  "before": "object",
  "clientGroupOnly": "boolean"
}

ClientGroupMemberAccessTypes: string

Client Group Member Access Types

object
EDIT
object
NO_ACCESS
object
VIEW

ClientGroupQueryFilter: object

Input type for filtering Users

name:

name of the clientGroup

organizationId:

organizationId for filter clientGroups

primaryUserId:

primaryUserId for filter clientGroups

searchText:

Allows to search for a specific clientGroup by their first name, and type

states:
ClientGroupStates

Filter by state. Default: anything but ARCHIVED.

type:

type of the clientGroup

Example
{
  "name": "string",
  "organizationId": "object",
  "primaryUserId": "object",
  "searchText": "string",
  "states": [
    "string"
  ],
  "type": "string"
}

ClientGroupStates: string

object
ACTIVE
object
ARCHIVED

ClientGroupTransition: string

object
archive

ClientGroupTypes: string

object
BUSINESS
object
HOUSEHOLD

ClientReport: object

createdAt:
object
return:
arguments:
object
entity:
object
return:
arguments:
object
id:
object
return:
arguments:
object
objectId:
object
return:
arguments:
object
objectType:
object
return:
arguments:
object
organization:
object
return:
arguments:
object
referenceDate:
object
return:
arguments:
object
s3key:
object
return:
arguments:
object
templateParameters:
object
return:
TemplateParameter
arguments:
object
Example
{
  "createdAt": {
    "return": "object",
    "arguments": {}
  },
  "entity": {
    "return": {
      "accessibleBy": {
        "return": [
          {
            "displayOptions": {
              "return": {
                "hide": {
                  "return": "boolean",
                  "arguments": {}
                },
                "order": {
                  "return": "number",
                  "arguments": {}
                }
              },
              "arguments": {}
            },
            "organizationUser": {
              "return": {
                "accessType": {
                  "return": "string",
                  "arguments": {}
                },
                "apiTokens": {
                  "return": [
                    {
                      "id": {
                        "return": "object",
                        "arguments": {}
                      },
                      "jwtToken": {
                        "return": "string",
                        "arguments": {}
                      },
                      "name": {
                        "return": "string",
                        "arguments": {}
                      },
                      "organization": {
                        "return": {
                          "browserTabTitle": {
                            "return": "string",
                            "arguments": {}
                          },
                          "faviconLink": {
                            "return": "string",
                            "arguments": {}
                          },
                          "id": {
                            "return": "object",
                            "arguments": {}
                          },
                          "name": {
                            "return": "string",
                            "arguments": {}
                          },
                          "parent": {
                            "return": {
                              "browserTabTitle": {
                                "return": "string",
                                "arguments": {}
                              },
                              "faviconLink": {
                                "return": "string",
                                "arguments": {}
                              },
                              "id": {
                                "return": "object",
                                "arguments": {}
                              },
                              "name": {
                                "return": "string",
                                "arguments": {}
                              },
                              "parent": {
                                "return": {
                                  "browserTabTitle": {
                                    "return": "string",
                                    "arguments": {}
                                  },
                                  "faviconLink": {
                                    "return": "string",
                                    "arguments": {}
                                  },
                                  "id": {
                                    "return": "object",
                                    "arguments": {}
                                  }
                                }
                              }
                            }
                          }
                        }
                      }
                    }
                  ]
                }
              }
            }
          }
        ]
      }
    }
  }
}

ClientReportComparisonOperators: string

object
EQUALS
object
GREATER_THAN
object
GREATER_THAN_AGO
object
IN
object
INCLUDES
object
LESS_THAN
object
LESS_THAN_AGO
object
NOT_EQUALS
object
NOT_IN
object
NOT_INCLUDES

ClientReportFrequencies: string

object
MONTHLY
object
QUARTERLY
object
WEEKLY
object
YEARLY

ClientReportScheduler: object

dayOfMonthOrWeek:
object

For MONTHLY, day of the following month (1-28) For QUARTERLY and YEARLY, day of the first month following after the term (1-28) For WEEKLY, day of the following week (1-7 Monday to Sunday)

return:
Int
arguments:
object
enableNotification:
object
return:
arguments:
object
frequency:
object

Report generation scheduling period: WEEKLY every week (Monday - Sunday) MONTHLY every month (1st - last day) QUARTERLY every three months (1 Jan - 31 Mar; 1 Apr - 30 Jun; 1 Jul - 30 Sep; 1 Oct - 31 Dec) YEARLY every year (1 Jan - 31 Dec)

return:
arguments:
object
triggerRules:
object
return:
ClientReportTriggerRule
arguments:
object
Example
{
  "dayOfMonthOrWeek": {
    "return": "number",
    "arguments": {}
  },
  "enableNotification": {
    "return": "boolean",
    "arguments": {}
  },
  "frequency": {
    "return": "string",
    "arguments": {}
  },
  "triggerRules": {
    "return": [
      {
        "comparison": {
          "return": "string",
          "arguments": {}
        },
        "field": {
          "return": "object",
          "arguments": {}
        },
        "value": {
          "return": "object",
          "arguments": {}
        }
      }
    ],
    "arguments": {}
  }
}

ClientReportTemplate: object

clientReportTemplatePageConfiguration:
object
return:
arguments:
object
id:
object
return:
arguments:
object
isStatementOfType:
object
return:
arguments:
object
objectType:
object
return:
arguments:
object
organization:
object
return:
arguments:
object
reportType:
object
return:
arguments:
object
s3key:
object
return:
arguments:
object
scheduler:
object
return:
arguments:
object
state:
object
return:
arguments:
object
templateParameters:
object
return:
SafeString
arguments:
object
translatedDescription:
object
return:
arguments:
object
translatedName:
object
return:
arguments:
object
type:
object
return:
arguments:
object
Example
{
  "clientReportTemplatePageConfiguration": {
    "return": {
      "clientReportTemplate": {
        "return": {
          "clientReportTemplatePageConfiguration": {
            "return": {
              "clientReportTemplate": {
                "return": {
                  "clientReportTemplatePageConfiguration": {
                    "return": {
                      "clientReportTemplate": {
                        "return": {
                          "clientReportTemplatePageConfiguration": {
                            "return": {
                              "clientReportTemplate": {
                                "return": {
                                  "clientReportTemplatePageConfiguration": {
                                    "return": {
                                      "clientReportTemplate": {
                                        "return": {
                                          "clientReportTemplatePageConfiguration": {
                                            "return": {
                                              "clientReportTemplate": {
                                                "return": {
                                                  "clientReportTemplatePageConfiguration": {
                                                    "return": {
                                                      "clientReportTemplate": {
                                                        "return": {
                                                          "clientReportTemplatePageConfiguration": {
                                                            "return": {
                                                              "clientReportTemplate": {
                                                                "return": {
                                                                  "clientReportTemplatePageConfiguration": {
                                                                    "return": {
                                                                      "clientReportTemplate": {
                                                                        "return": {
                                                                          "clientReportTemplatePageConfiguration": {
                                                                            "return": {
                                                                              "clientReportTemplate": {
                                                                                "return": {
                                                                                  "clientReportTemplatePageConfiguration": {
                                                                                    "return": {
                                                                                      "clientReportTemplate": {
                                                                                        "return": {
                                                                                          "clientReportTemplatePageConfiguration": {
                                                                                            "return": {
                                                                                              "clientReportTemplate": {
                                                                                                "return": {
                                                                                                  "clientReportTemplatePageConfiguration": {
                                                                                                    "return": {
                                                                                                      "clientReportTemplate": {
                                                                                                        "return": {
                                                                                                          "clientReportTemplatePageConfiguration": {
                                                                                                            "return": {
                                                                                                              "clientReportTemplate": {
                                                                                                                "return": {
                                                                                                                  "clientReportTemplatePageConfiguration": {
                                                                                                                    "return": {
                                                                                                                      "clientReportTemplate": {
                                                                                                                        "return": {
                                                                                                                          "clientReportTemplatePageConfiguration": {
                                                                                                                            "return": {
                                                                                                                              "clientReportTemplate": {
                                                                                                                                "return": {
                                                                                                                                  "clientReportTemplatePageConfiguration": {
                                                                                                                                    "return": {}
                                                                                                                                  }
                                                                                                                                }
                                                                                                                              }
                                                                                                                            }
                                                                                                                          }
                                                                                                                        }
                                                                                                                      }
                                                                                                                    }
                                                                                                                  }
                                                                                                                }
                                                                                                              }
                                                                                                            }
                                                                                                          }
                                                                                                        }
                                                                                                      }
                                                                                                    }
                                                                                                  }
                                                                                                }
                                                                                              }
                                                                                            }
                                                                                          }
                                                                                        }
                                                                                      }
                                                                                    }
                                                                                  }
                                                                                }
                                                                              }
                                                                            }
                                                                          }
                                                                        }
                                                                      }
                                                                    }
                                                                  }
                                                                }
                                                              }
                                                            }
                                                          }
                                                        }
                                                      }
                                                    }
                                                  }
                                                }
                                              }
                                            }
                                          }
                                        }
                                      }
                                    }
                                  }
                                }
                              }
                            }
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

ClientReportTemplateObjectTypes: string

object
ACCOUNT
object
CLIENT_GROUP
object
GOAL
object
SUB_ACCOUNT
object
USER

ClientReportTemplatePageConfiguration: object

clientReportTemplate:
object
return:
arguments:
object
createdAt:
object
return:
arguments:
object
id:
object
return:
arguments:
object
options:
object
return:
arguments:
object
organization:
object
return:
arguments:
object
publicOrganization:
object

Organization with limited attributes that is accessible from sub-organizations.

return:
arguments:
object
type:
object
return:
arguments:
object
updatedAt:
object
return:
arguments:
object
widgets:
object
return:
ClientReportTemplateWidgetConfiguration
arguments:
object
Example
{
  "clientReportTemplate": {
    "return": {
      "clientReportTemplatePageConfiguration": {
        "return": {
          "clientReportTemplate": {
            "return": {
              "clientReportTemplatePageConfiguration": {
                "return": {
                  "clientReportTemplate": {
                    "return": {
                      "clientReportTemplatePageConfiguration": {
                        "return": {
                          "clientReportTemplate": {
                            "return": {
                              "clientReportTemplatePageConfiguration": {
                                "return": {
                                  "clientReportTemplate": {
                                    "return": {
                                      "clientReportTemplatePageConfiguration": {
                                        "return": {
                                          "clientReportTemplate": {
                                            "return": {
                                              "clientReportTemplatePageConfiguration": {
                                                "return": {
                                                  "clientReportTemplate": {
                                                    "return": {
                                                      "clientReportTemplatePageConfiguration": {
                                                        "return": {
                                                          "clientReportTemplate": {
                                                            "return": {
                                                              "clientReportTemplatePageConfiguration": {
                                                                "return": {
                                                                  "clientReportTemplate": {
                                                                    "return": {
                                                                      "clientReportTemplatePageConfiguration": {
                                                                        "return": {
                                                                          "clientReportTemplate": {
                                                                            "return": {
                                                                              "clientReportTemplatePageConfiguration": {
                                                                                "return": {
                                                                                  "clientReportTemplate": {
                                                                                    "return": {
                                                                                      "clientReportTemplatePageConfiguration": {
                                                                                        "return": {
                                                                                          "clientReportTemplate": {
                                                                                            "return": {
                                                                                              "clientReportTemplatePageConfiguration": {
                                                                                                "return": {
                                                                                                  "clientReportTemplate": {
                                                                                                    "return": {
                                                                                                      "clientReportTemplatePageConfiguration": {
                                                                                                        "return": {
                                                                                                          "clientReportTemplate": {
                                                                                                            "return": {
                                                                                                              "clientReportTemplatePageConfiguration": {
                                                                                                                "return": {
                                                                                                                  "clientReportTemplate": {
                                                                                                                    "return": {
                                                                                                                      "clientReportTemplatePageConfiguration": {
                                                                                                                        "return": {
                                                                                                                          "clientReportTemplate": {
                                                                                                                            "return": {
                                                                                                                              "clientReportTemplatePageConfiguration": {
                                                                                                                                "return": {
                                                                                                                                  "clientReportTemplate": {
                                                                                                                                    "return": {}
                                                                                                                                  }
                                                                                                                                }
                                                                                                                              }
                                                                                                                            }
                                                                                                                          }
                                                                                                                        }
                                                                                                                      }
                                                                                                                    }
                                                                                                                  }
                                                                                                                }
                                                                                                              }
                                                                                                            }
                                                                                                          }
                                                                                                        }
                                                                                                      }
                                                                                                    }
                                                                                                  }
                                                                                                }
                                                                                              }
                                                                                            }
                                                                                          }
                                                                                        }
                                                                                      }
                                                                                    }
                                                                                  }
                                                                                }
                                                                              }
                                                                            }
                                                                          }
                                                                        }
                                                                      }
                                                                    }
                                                                  }
                                                                }
                                                              }
                                                            }
                                                          }
                                                        }
                                                      }
                                                    }
                                                  }
                                                }
                                              }
                                            }
                                          }
                                        }
                                      }
                                    }
                                  }
                                }
                              }
                            }
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

ClientReportTemplatePageConfigurationTypes: string

object
ACCOUNT
object
GOAL
object
HOUSEHOLD
object
INDIVIDUAL
object
NON_INDIVIDUAL
object
SUB_ACCOUNT

ClientReportTemplateReportTypes: string

object
HTML
object
PAGE_CONFIGURATION

ClientReportTemplateResponse: object

clientReportTemplate:
object
return:
arguments:
object
Example
{
  "clientReportTemplate": {
    "return": {
      "clientReportTemplatePageConfiguration": {
        "return": {
          "clientReportTemplate": {
            "return": {
              "clientReportTemplatePageConfiguration": {
                "return": {
                  "clientReportTemplate": {
                    "return": {
                      "clientReportTemplatePageConfiguration": {
                        "return": {
                          "clientReportTemplate": {
                            "return": {
                              "clientReportTemplatePageConfiguration": {
                                "return": {
                                  "clientReportTemplate": {
                                    "return": {
                                      "clientReportTemplatePageConfiguration": {
                                        "return": {
                                          "clientReportTemplate": {
                                            "return": {
                                              "clientReportTemplatePageConfiguration": {
                                                "return": {
                                                  "clientReportTemplate": {
                                                    "return": {
                                                      "clientReportTemplatePageConfiguration": {
                                                        "return": {
                                                          "clientReportTemplate": {
                                                            "return": {
                                                              "clientReportTemplatePageConfiguration": {
                                                                "return": {
                                                                  "clientReportTemplate": {
                                                                    "return": {
                                                                      "clientReportTemplatePageConfiguration": {
                                                                        "return": {
                                                                          "clientReportTemplate": {
                                                                            "return": {
                                                                              "clientReportTemplatePageConfiguration": {
                                                                                "return": {
                                                                                  "clientReportTemplate": {
                                                                                    "return": {
                                                                                      "clientReportTemplatePageConfiguration": {
                                                                                        "return": {
                                                                                          "clientReportTemplate": {
                                                                                            "return": {
                                                                                              "clientReportTemplatePageConfiguration": {
                                                                                                "return": {
                                                                                                  "clientReportTemplate": {
                                                                                                    "return": {
                                                                                                      "clientReportTemplatePageConfiguration": {
                                                                                                        "return": {
                                                                                                          "clientReportTemplate": {
                                                                                                            "return": {
                                                                                                              "clientReportTemplatePageConfiguration": {
                                                                                                                "return": {
                                                                                                                  "clientReportTemplate": {
                                                                                                                    "return": {
                                                                                                                      "clientReportTemplatePageConfiguration": {
                                                                                                                        "return": {
                                                                                                                          "clientReportTemplate": {
                                                                                                                            "return": {
                                                                                                                              "clientReportTemplatePageConfiguration": {
                                                                                                                                "return": {
                                                                                                                                  "clientReportTemplate": {
                                                                                                                                    "return": {}
                                                                                                                                  }
                                                                                                                                }
                                                                                                                              }
                                                                                                                            }
                                                                                                                          }
                                                                                                                        }
                                                                                                                      }
                                                                                                                    }
                                                                                                                  }
                                                                                                                }
                                                                                                              }
                                                                                                            }
                                                                                                          }
                                                                                                        }
                                                                                                      }
                                                                                                    }
                                                                                                  }
                                                                                                }
                                                                                              }
                                                                                            }
                                                                                          }
                                                                                        }
                                                                                      }
                                                                                    }
                                                                                  }
                                                                                }
                                                                              }
                                                                            }
                                                                          }
                                                                        }
                                                                      }
                                                                    }
                                                                  }
                                                                }
                                                              }
                                                            }
                                                          }
                                                        }
                                                      }
                                                    }
                                                  }
                                                }
                                              }
                                            }
                                          }
                                        }
                                      }
                                    }
                                  }
                                }
                              }
                            }
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

ClientReportTemplateStates: string

object
ACTIVE
object
DRAFT
object
INACTIVE

ClientReportTemplateTransitions: string

object
activate
object
deactivate
object
review

ClientReportTemplateWidgetConfiguration: object

id:
object
return:
arguments:
object
options:
object
return:
arguments:
object
type:
object
return:
arguments:
object
Example
{
  "id": {
    "return": "object",
    "arguments": {}
  },
  "options": {
    "return": "object",
    "arguments": {}
  },
  "type": {
    "return": "string",
    "arguments": {}
  }
}

ClientReportTemplateWidgetConfigurationInput: object

options:
type:
Example
{
  "options": "object",
  "type": "string"
}

ClientReportTemplateWidgetConfigurationTypes: string

object
ACCOUNTS
object
FEES
object
GOALS
object
HOLDINGS
object
HTML_TEMPLATE
object
LEDGER
object
MARKET_VALUE_CHART
object
PROJECTED_INCOME_REPORT
object
RATE_OF_RETURNS
object
SUB_ACCOUNTS

ClientReportTemplateWidgetOption: object

default:
object
return:
arguments:
object
info:
object
return:
arguments:
object
key:
object
return:
arguments:
object
label:
object
return:
arguments:
object
optionType:
object
return:
arguments:
object
options:
object
return:
arguments:
object
removeFromPages:
object
return:
PageConfigurationTypes
arguments:
object
requiredIf:
object
return:
arguments:
object
showBasedOnCustodianConnection:
object
return:
Object
arguments:
object
showIf:
object
return:
arguments:
object
showWith:
object
return:
arguments:
object
Example
{
  "default": {
    "return": "object",
    "arguments": {}
  },
  "info": {
    "return": {
      "en": {
        "return": "string",
        "arguments": {}
      },
      "fr": {
        "return": "string",
        "arguments": {}
      }
    },
    "arguments": {}
  },
  "key": {
    "return": "string",
    "arguments": {}
  },
  "label": {
    "return": {
      "en": {
        "return": "string",
        "arguments": {}
      },
      "fr": {
        "return": "string",
        "arguments": {}
      }
    },
    "arguments": {}
  },
  "optionType": {
    "return": "string",
    "arguments": {}
  },
  "options": {
    "return": "object",
    "arguments": {}
  },
  "removeFromPages": {
    "return": [
      "string"
    ],
    "arguments": {}
  },
  "requiredIf": {
    "return": "object",
    "arguments": {}
  },
  "showBasedOnCustodianConnection": {
    "return": [
      "object"
    ],
    "arguments": {}
  },
  "showIf": {
    "return": "object",
    "arguments": {}
  },
  "showWith": {
    "return": "string",
    "arguments": {}
  }
}

ClientReportTemplateWidgetOptionTypes: string

object
ARRAY
object
ATTACHMENT
object
BASIC_FIELD
object
BOOLEAN
object
HTML_TEMPLATE
object
OPTIONAL_TRANSLATED_STRING
object
PLAIN_TEXT_FIELD
object
SELECT_FIELD
object
TABLE
object
TRANSLATED_STRING
object
WORKFLOW_SELECT_FIELD

ClientReportTemplatesQueryFilter: object

organizationId:
states:
ClientReportTemplateStates
types:
SafeString
Example
{
  "organizationId": "object",
  "states": [
    "string"
  ],
  "types": [
    "object"
  ]
}

ClientReportTriggerRule: object

comparison:
object
return:
arguments:
object
field:
object
return:
arguments:
object
value:
object
return:
arguments:
object
Example
{
  "comparison": {
    "return": "string",
    "arguments": {}
  },
  "field": {
    "return": "object",
    "arguments": {}
  },
  "value": {
    "return": "object",
    "arguments": {}
  }
}

ClientReportTriggerRuleInput: object

comparison:
field:
value:
Example
{
  "comparison": "string",
  "field": "object",
  "value": "object"
}

ClientReportsQueryFilter: object

clientReportTemplateId:
entityId:
objectId:
objectType:
organizationId:
referenceDateFrom:
referenceDateTo:
Example
{
  "clientReportTemplateId": "object",
  "entityId": "object",
  "objectId": "object",
  "objectType": "string",
  "organizationId": "object",
  "referenceDateFrom": "object",
  "referenceDateTo": "object"
}

CloseAccountInput: object

accountId:
inactiveReason:
Example
{
  "accountId": "object",
  "inactiveReason": "string"
}

CloseAccountResponse: object

account:
object
return:
arguments:
object
Example
{
  "account": {
    "return": {
      "affiliations": {
        "return": [
          {
            "allocation": {
              "return": "number",
              "arguments": {}
            },
            "id": {
              "return": "object",
              "arguments": {}
            },
            "relation": {
              "return": "string",
              "arguments": {}
            },
            "signatureRequired": {
              "return": "boolean",
              "arguments": {}
            },
            "type": {
              "return": "string",
              "arguments": {}
            },
            "user": {
              "return": {
                "accessibleBy": {
                  "return": [
                    {
                      "displayOptions": {
                        "return": {
                          "hide": {
                            "return": "boolean",
                            "arguments": {}
                          },
                          "order": {
                            "return": "number",
                            "arguments": {}
                          }
                        },
                        "arguments": {}
                      },
                      "organizationUser": {
                        "return": {
                          "accessType": {
                            "return": "string",
                            "arguments": {}
                          },
                          "apiTokens": {
                            "return": [
                              {
                                "id": {
                                  "return": "object",
                                  "arguments": {}
                                },
                                "jwtToken": {
                                  "return": "string",
                                  "arguments": {}
                                },
                                "name": {
                                  "return": "string",
                                  "arguments": {}
                                },
                                "organization": {
                                  "return": {
                                    "browserTabTitle": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "faviconLink": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "id": {
                                      "return": "object",
                                      "arguments": {}
                                    },
                                    "name": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "parent": {
                                      "return": {
                                        "browserTabTitle": {
                                          "return": "string",
                                          "arguments": {}
                                        },
                                        "faviconLink": {
                                          "return": "string",
                                          "arguments": {}
                                        }
                                      }
                                    }
                                  }
                                }
                              }
                            ]
                          }
                        }
                      }
                    }
                  ]
                }
              }
            }
          }
        ]
      }
    }
  }
}

CloseSubAccountInput: object

inactiveReason:
shouldCloseAccount:
subAccountId:
Example
{
  "inactiveReason": "string",
  "shouldCloseAccount": "boolean",
  "subAccountId": "object"
}

CloseSubAccountResponse: object

subAccount:
object
return:
arguments:
object
Example
{
  "subAccount": {
    "return": {
      "acceptableFinancialProduct": {
        "return": "boolean",
        "arguments": {}
      },
      "account": {
        "return": {
          "affiliations": {
            "return": [
              {
                "allocation": {
                  "return": "number",
                  "arguments": {}
                },
                "id": {
                  "return": "object",
                  "arguments": {}
                },
                "relation": {
                  "return": "string",
                  "arguments": {}
                },
                "signatureRequired": {
                  "return": "boolean",
                  "arguments": {}
                },
                "type": {
                  "return": "string",
                  "arguments": {}
                },
                "user": {
                  "return": {
                    "accessibleBy": {
                      "return": [
                        {
                          "displayOptions": {
                            "return": {
                              "hide": {
                                "return": "boolean",
                                "arguments": {}
                              },
                              "order": {
                                "return": "number",
                                "arguments": {}
                              }
                            },
                            "arguments": {}
                          },
                          "organizationUser": {
                            "return": {
                              "accessType": {
                                "return": "string",
                                "arguments": {}
                              },
                              "apiTokens": {
                                "return": [
                                  {
                                    "id": {
                                      "return": "object",
                                      "arguments": {}
                                    },
                                    "jwtToken": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "name": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "organization": {
                                      "return": {
                                        "browserTabTitle": {
                                          "return": "string",
                                          "arguments": {}
                                        },
                                        "faviconLink": {
                                          "return": "string",
                                          "arguments": {}
                                        },
                                        "id": {
                                          "return": "object",
                                          "arguments": {}
                                        },
                                        "name": {
                                          "return": "string",
                                          "arguments": {}
                                        },
                                        "parent": {
                                          "return": {
                                            "browserTabTitle": {}
                                          }
                                        }
                                      }
                                    }
                                  }
                                ]
                              }
                            }
                          }
                        }
                      ]
                    }
                  }
                }
              }
            ]
          }
        }
      }
    }
  }
}

CompleteGoalInput: object

goalId:
lastUpdatedBy:
Example
{
  "goalId": "object",
  "lastUpdatedBy": "object"
}

CompleteGoalResponse: object

goal:
object
return:
arguments:
object
Example
{
  "goal": {
    "return": {
      "availableFinancialProducts": {
        "return": [
          {
            "assignable": {
              "return": "boolean",
              "arguments": {}
            },
            "autoUpdatePrices": {
              "return": "boolean",
              "arguments": {}
            },
            "children": {
              "return": [
                {
                  "financialProduct": {
                    "return": {
                      "assignable": {
                        "return": "boolean",
                        "arguments": {}
                      },
                      "autoUpdatePrices": {
                        "return": "boolean",
                        "arguments": {}
                      },
                      "children": {
                        "return": [
                          {
                            "financialProduct": {
                              "return": {
                                "assignable": {
                                  "return": "boolean",
                                  "arguments": {}
                                },
                                "autoUpdatePrices": {
                                  "return": "boolean",
                                  "arguments": {}
                                },
                                "children": {
                                  "return": [
                                    {
                                      "financialProduct": {
                                        "return": {
                                          "assignable": {
                                            "return": "boolean",
                                            "arguments": {}
                                          },
                                          "autoUpdatePrices": {
                                            "return": "boolean",
                                            "arguments": {}
                                          },
                                          "children": {
                                            "return": [
                                              {
                                                "financialProduct": {
                                                  "return": {
                                                    "assignable": {
                                                      "return": "boolean",
                                                      "arguments": {}
                                                    },
                                                    "autoUpdatePrices": {
                                                      "return": "boolean",
                                                      "arguments": {}
                                                    },
                                                    "children": {
                                                      "return": [
                                                        {
                                                          "financialProduct": {
                                                            "return": {
                                                              "assignable": {
                                                                "return": "boolean",
                                                                "arguments": {}
                                                              },
                                                              "autoUpdatePrices": {
                                                                "return": "boolean",
                                                                "arguments": {}
                                                              },
                                                              "children": {
                                                                "return": [
                                                                  {
                                                                    "financialProduct": {
                                                                      "return": {
                                                                        "assignable": {}
                                                                      }
                                                                    }
                                                                  }
                                                                ]
                                                              }
                                                            }
                                                          }
                                                        }
                                                      ]
                                                    }
                                                  }
                                                }
                                              }
                                            ]
                                          }
                                        }
                                      }
                                    }
                                  ]
                                }
                              }
                            }
                          }
                        ]
                      }
                    }
                  }
                }
              ]
            }
          }
        ]
      }
    }
  }
}

ComplianceStates: string

object
APPROVED
object
NEEDS_REVIEW
object
REJECTED

CorporateBusinessTypes: string

object
CORPORATION
object
LLC
object
PARTNERSHIP
object
SOLE_PROPRIETORSHIP

CorporateCountries: string

object
CA
object
USA

CountryCodes: string

object
AD
object
AE
object
AF
object
AG
object
AI
object
AL
object
AM
object
AO
object
AQ
object
AR
object
AS
object
AT
object
AU
object
AW
object
AX
object
AZ
object
BA
object
BB
object
BD
object
BE
object
BF
object
BG
object
BH
object
BI
object
BJ
object
BL
object
BM
object
BN
object
BO
object
BQ
object
BR
object
BS
object
BT
object
BV
object
BW
object
BY
object
BZ
object
CA
object
CC
object
CD
object
CF
object
CG
object
CH
object
CI
object
CK
object
CL
object
CM
object
CN
object
CO
object
CR
object
CU
object
CV
object
CW
object
CX
object
CY
object
CZ
object
DE
object
DJ
object
DK
object
DM
object
DO
object
DZ
object
EC
object
EE
object
EG
object
EH
object
ER
object
ES
object
ET
object
FI
object
FJ
object
FK
object
FM
object
FO
object
FR
object
GA
object
GB
object
GD
object
GE
object
GF
object
GG
object
GH
object
GI
object
GL
object
GM
object
GN
object
GP
object
GQ
object
GR
object
GS
object
GT
object
GU
object
GW
object
GY
object
HK
object
HM
object
HN
object
HR
object
HT
object
HU
object
ID
object
IE
object
IL
object
IM
object
IN
object
IO
object
IQ
object
IR
object
IS
object
IT
object
JE
object
JM
object
JO
object
JP
object
KE
object
KG
object
KH
object
KI
object
KM
object
KN
object
KP
object
KR
object
KW
object
KY
object
KZ
object
LA
object
LB
object
LC
object
LI
object
LK
object
LR
object
LS
object
LT
object
LU
object
LV
object
LY
object
MA
object
MC
object
MD
object
ME
object
MF
object
MG
object
MH
object
MK
object
ML
object
MM
object
MN
object
MO
object
MP
object
MQ
object
MR
object
MS
object
MT
object
MU
object
MV
object
MW
object
MX
object
MY
object
MZ
object
NA
object
NC
object
NE
object
NF
object
NG
object
NI
object
NL
object
NO
object
NP
object
NR
object
NU
object
NZ
object
OM
object
PA
object
PE
object
PF
object
PG
object
PH
object
PK
object
PL
object
PM
object
PN
object
PR
object
PS
object
PT
object
PW
object
PY
object
QA
object
RE
object
RO
object
RS
object
RU
object
RW
object
SA
object
SB
object
SC
object
SD
object
SE
object
SG
object
SH
object
SI
object
SJ
object
SK
object
SL
object
SM
object
SN
object
SO
object
SR
object
SS
object
ST
object
SV
object
SX
object
SY
object
SZ
object
TC
object
TD
object
TF
object
TG
object
TH
object
TJ
object
TK
object
TL
object
TM
object
TN
object
TO
object
TR
object
TT
object
TV
object
TW
object
TZ
object
UA
object
UG
object
UM
object
US
object
UY
object
UZ
object
VA
object
VC
object
VE
object
VG
object
VI
object
VN
object
VU
object
WF
object
WS
object
YE
object
YT
object
ZA
object
ZM
object
ZW

CountryRisk: object

country:
object
return:
arguments:
object
countryCode:
object
return:
arguments:
object
disabled:
object
return:
arguments:
object
id:
object
return:
arguments:
object
riskRating:
object
return:
arguments:
object
Example
{
  "country": {
    "return": "object",
    "arguments": {}
  },
  "countryCode": {
    "return": "object",
    "arguments": {}
  },
  "disabled": {
    "return": "boolean",
    "arguments": {}
  },
  "id": {
    "return": "object",
    "arguments": {}
  },
  "riskRating": {
    "return": "string",
    "arguments": {}
  }
}

CreateAccountInput: object

applyForGovFunds:
ApplyForGovFunds
availableCurrencies:
AccountCurrencyTypes
baseCurrency:
billingScheduleId:
clientGroupId:
corporationClientGroupId:
custodianAccountNumber:
custodianConnectionId:
custodianSortingOrderPriority:
Int
customFields:
CustomFieldInput
feeTierId:
forceOpen:
householdClientGroupId:
integrations:
AccountIntegrationInput
jurisdiction:
nickName:
overrideTaxRank:
Int
requestId:
sourceOfFunds:
tlhEnabled:
type:
userId:
Example
{
  "applyForGovFunds": [
    "string"
  ],
  "availableCurrencies": [
    "string"
  ],
  "baseCurrency": "string",
  "billingScheduleId": "object",
  "clientGroupId": "object",
  "corporationClientGroupId": "object",
  "custodianAccountNumber": "object",
  "custodianConnectionId": "object",
  "custodianSortingOrderPriority": "number",
  "customFields": [
    {
      "key": "object",
      "value": "object"
    }
  ],
  "feeTierId": "object",
  "forceOpen": "boolean",
  "householdClientGroupId": "object",
  "integrations": [
    {
      "externalId": "object",
      "groupId": "object",
      "iid": "object",
      "type": "string"
    }
  ],
  "jurisdiction": "string",
  "nickName": "object",
  "overrideTaxRank": "number",
  "requestId": "object",
  "sourceOfFunds": "string",
  "tlhEnabled": "boolean",
  "type": "string",
  "userId": "object"
}

CreateAccountResponse: object

account:
object
return:
arguments:
object
Example
{
  "account": {
    "return": {
      "affiliations": {
        "return": [
          {
            "allocation": {
              "return": "number",
              "arguments": {}
            },
            "id": {
              "return": "object",
              "arguments": {}
            },
            "relation": {
              "return": "string",
              "arguments": {}
            },
            "signatureRequired": {
              "return": "boolean",
              "arguments": {}
            },
            "type": {
              "return": "string",
              "arguments": {}
            },
            "user": {
              "return": {
                "accessibleBy": {
                  "return": [
                    {
                      "displayOptions": {
                        "return": {
                          "hide": {
                            "return": "boolean",
                            "arguments": {}
                          },
                          "order": {
                            "return": "number",
                            "arguments": {}
                          }
                        },
                        "arguments": {}
                      },
                      "organizationUser": {
                        "return": {
                          "accessType": {
                            "return": "string",
                            "arguments": {}
                          },
                          "apiTokens": {
                            "return": [
                              {
                                "id": {
                                  "return": "object",
                                  "arguments": {}
                                },
                                "jwtToken": {
                                  "return": "string",
                                  "arguments": {}
                                },
                                "name": {
                                  "return": "string",
                                  "arguments": {}
                                },
                                "organization": {
                                  "return": {
                                    "browserTabTitle": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "faviconLink": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "id": {
                                      "return": "object",
                                      "arguments": {}
                                    },
                                    "name": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "parent": {
                                      "return": {
                                        "browserTabTitle": {
                                          "return": "string",
                                          "arguments": {}
                                        },
                                        "faviconLink": {
                                          "return": "string",
                                          "arguments": {}
                                        }
                                      }
                                    }
                                  }
                                }
                              }
                            ]
                          }
                        }
                      }
                    }
                  ]
                }
              }
            }
          }
        ]
      }
    }
  }
}

CreateAdjustmentTransactionInput: object

currency:
date:
description:
requestId:
subAccountId:
valueCents:
Example
{
  "currency": "string",
  "date": "object",
  "description": "object",
  "requestId": "object",
  "subAccountId": "object",
  "valueCents": "number"
}

CreateAdjustmentTransactionResponse: object

transaction:
object
return:
arguments:
object
Example
{
  "transaction": {
    "return": {
      "account": {
        "return": {
          "affiliations": {
            "return": [
              {
                "allocation": {
                  "return": "number",
                  "arguments": {}
                },
                "id": {
                  "return": "object",
                  "arguments": {}
                },
                "relation": {
                  "return": "string",
                  "arguments": {}
                },
                "signatureRequired": {
                  "return": "boolean",
                  "arguments": {}
                },
                "type": {
                  "return": "string",
                  "arguments": {}
                },
                "user": {
                  "return": {
                    "accessibleBy": {
                      "return": [
                        {
                          "displayOptions": {
                            "return": {
                              "hide": {
                                "return": "boolean",
                                "arguments": {}
                              },
                              "order": {
                                "return": "number",
                                "arguments": {}
                              }
                            },
                            "arguments": {}
                          },
                          "organizationUser": {
                            "return": {
                              "accessType": {
                                "return": "string",
                                "arguments": {}
                              },
                              "apiTokens": {
                                "return": [
                                  {
                                    "id": {
                                      "return": "object",
                                      "arguments": {}
                                    },
                                    "jwtToken": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "name": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "organization": {
                                      "return": {
                                        "browserTabTitle": {
                                          "return": "string",
                                          "arguments": {}
                                        },
                                        "faviconLink": {
                                          "return": "string",
                                          "arguments": {}
                                        },
                                        "id": {
                                          "return": "object",
                                          "arguments": {}
                                        },
                                        "name": {
                                          "return": "string",
                                          "arguments": {}
                                        },
                                        "parent": {
                                          "return": {
                                            "browserTabTitle": {
                                              "return": "string",
                                              "arguments": {}
                                            },
                                            "faviconLink": {}
                                          }
                                        }
                                      }
                                    }
                                  }
                                ]
                              }
                            }
                          }
                        }
                      ]
                    }
                  }
                }
              }
            ]
          }
        }
      }
    }
  }
}

CreateAdjustmentTransferInput: object

adjustmentReason:

Adjustment reason.

amountCents:

Transfer amount in cents. Maximum $1 (100)

currency:
fiscalYear:
Int
requestId:

This an ID created by the partner, that is submitted with an transfer request and unique to each request.

subAccountId:

Account that transfer is to be processed in.

type:

Type of transfer

Example
{
  "adjustmentReason": "object",
  "amountCents": "object",
  "currency": "string",
  "fiscalYear": "number",
  "requestId": "object",
  "subAccountId": "object",
  "type": "string"
}

CreateAffiliateInput: object

Input type for creating an affiliate only user

citizenships:
SafeString

User's citizenships

closeAssociateOfPEP:

Is the user a close associate of politically exposed person?

companyType:

The type of company at which the user is employed

countryOfRegistration:
dateOfBirth:

User's date of birth

dateOfDeath:

Decedent's date of death

employerCompanyAddress:
employerName:
employmentStatus:

User's employment status

entityName:
establishedDate:
firstName:

User's first name

foreignTaxInformation:
ForeignTaxInformationInput

The tax information provided by the affiliate if the he pays tax to a foreign country

gender:

User's gender

headOfInternationalOrganization:

Is/Was the User the head of an international organization?

inProvinceSince:
isMemberOfIiroc:

Is the user a member of IIROC? IIROC:Investment Industry Regulatory Organization of Canada

isOfficerOfPublicCompany:

Is the user a high-level management executive of a public company?

isOwnerOfPublicCompany:

Is the user the owner of a public company?

issuerExchange:
issuerName:
issuerTicker:
jobTitle:

User's job title, if user is employed

lastName:

User's last name

middleName:

User's middle name

organizationId:

What the organization should be set to for the new user

parentCompanyName:
payTaxesOutsideCanada:
phone:

User's phone number

physicalAddress:

User's address

politicallyExposedDomesticPerson:

Is the user a politically exposed person in a Canada?

politicallyExposedForeignPerson:

Is the user a politically exposed person in a foreign country?

positionAtEntity:
primaryEmail:

User's email address

registrationNumber:
requestId:

Unique requestID created by partner for each request to create a new user

sin:

User's Social Insurance Number

studentAreaOfStudy:
Example
{
  "citizenships": [
    "object"
  ],
  "closeAssociateOfPEP": "boolean",
  "companyType": "object",
  "countryOfRegistration": "object",
  "dateOfBirth": "object",
  "dateOfDeath": "object",
  "employerCompanyAddress": {
    "city": "object",
    "country": "string",
    "houseNumber": "object",
    "jurisdiction": "string",
    "neighborhood": "object",
    "postal": "object",
    "province": "string",
    "streetName": "object",
    "unitNumber": "object"
  },
  "employerName": "object",
  "employmentStatus": "string",
  "entityName": "object",
  "establishedDate": "object",
  "firstName": "object",
  "foreignTaxInformation": [
    {
      "foreignTaxCountry": "object",
      "foreignTaxNumber": "object"
    }
  ],
  "gender": "object",
  "headOfInternationalOrganization": "boolean",
  "inProvinceSince": "object",
  "isMemberOfIiroc": "boolean",
  "isOfficerOfPublicCompany": "boolean",
  "isOwnerOfPublicCompany": "boolean",
  "issuerExchange": "object",
  "issuerName": "object",
  "issuerTicker": "object",
  "jobTitle": "object",
  "lastName": "object",
  "middleName": "object",
  "organizationId": "object",
  "parentCompanyName": "object",
  "payTaxesOutsideCanada": "boolean",
  "phone": "object",
  "physicalAddress": {
    "city": "object",
    "country": "string",
    "houseNumber": "object",
    "jurisdiction": "string",
    "neighborhood": "object",
    "postal": "object",
    "province": "string"
  }
}

CreateAffiliateResponse: object

Type definition for creating an "affiliate only" user

user:
object

User object

return:
arguments:
object
Example
{
  "user": {
    "return": {
      "accessibleBy": {
        "return": [
          {
            "displayOptions": {
              "return": {
                "hide": {
                  "return": "boolean",
                  "arguments": {}
                },
                "order": {
                  "return": "number",
                  "arguments": {}
                }
              },
              "arguments": {}
            },
            "organizationUser": {
              "return": {
                "accessType": {
                  "return": "string",
                  "arguments": {}
                },
                "apiTokens": {
                  "return": [
                    {
                      "id": {
                        "return": "object",
                        "arguments": {}
                      },
                      "jwtToken": {
                        "return": "string",
                        "arguments": {}
                      },
                      "name": {
                        "return": "string",
                        "arguments": {}
                      },
                      "organization": {
                        "return": {
                          "browserTabTitle": {
                            "return": "string",
                            "arguments": {}
                          },
                          "faviconLink": {
                            "return": "string",
                            "arguments": {}
                          },
                          "id": {
                            "return": "object",
                            "arguments": {}
                          },
                          "name": {
                            "return": "string",
                            "arguments": {}
                          },
                          "parent": {
                            "return": {
                              "browserTabTitle": {
                                "return": "string",
                                "arguments": {}
                              },
                              "faviconLink": {
                                "return": "string",
                                "arguments": {}
                              },
                              "id": {
                                "return": "object",
                                "arguments": {}
                              },
                              "name": {
                                "return": "string",
                                "arguments": {}
                              },
                              "parent": {
                                "return": {
                                  "browserTabTitle": {
                                    "return": "string",
                                    "arguments": {}
                                  },
                                  "faviconLink": {
                                    "return": "string",
                                    "arguments": {}
                                  },
                                  "id": {
                                    "return": "object",
                                    "arguments": {}
                                  },
                                  "name": {
                                    "return": "string",
                                    "arguments": {}
                                  }
                                }
                              }
                            }
                          }
                        }
                      }
                    }
                  ]
                }
              }
            }
          }
        ]
      }
    }
  }
}

CreateApiTokenInput: object

name:
organizationId:
permissions:
SafeString
whitelistAddresses:
SafeString
Example
{
  "name": "object",
  "organizationId": "object",
  "permissions": [
    "object"
  ],
  "whitelistAddresses": [
    "object"
  ]
}

CreateApiTokenResponse: object

apiToken:
object
return:
arguments:
object
Example
{
  "apiToken": {
    "return": {
      "id": {
        "return": "object",
        "arguments": {}
      },
      "jwtToken": {
        "return": "string",
        "arguments": {}
      },
      "name": {
        "return": "string",
        "arguments": {}
      },
      "organization": {
        "return": {
          "browserTabTitle": {
            "return": "string",
            "arguments": {}
          },
          "faviconLink": {
            "return": "string",
            "arguments": {}
          },
          "id": {
            "return": "object",
            "arguments": {}
          },
          "name": {
            "return": "string",
            "arguments": {}
          },
          "parent": {
            "return": {
              "browserTabTitle": {
                "return": "string",
                "arguments": {}
              },
              "faviconLink": {
                "return": "string",
                "arguments": {}
              },
              "id": {
                "return": "object",
                "arguments": {}
              },
              "name": {
                "return": "string",
                "arguments": {}
              },
              "parent": {
                "return": {
                  "browserTabTitle": {
                    "return": "string",
                    "arguments": {}
                  },
                  "faviconLink": {
                    "return": "string",
                    "arguments": {}
                  },
                  "id": {
                    "return": "object",
                    "arguments": {}
                  },
                  "name": {
                    "return": "string",
                    "arguments": {}
                  },
                  "parent": {
                    "return": {
                      "browserTabTitle": {
                        "return": "string",
                        "arguments": {}
                      },
                      "faviconLink": {
                        "return": "string",
                        "arguments": {}
                      },
                      "id": {
                        "return": "object",
                        "arguments": {}
                      },
                      "name": {
                        "return": "string",
                        "arguments": {}
                      },
                      "parent": {
                        "return": {
                          "browserTabTitle": {
                            "return": "string",
                            "arguments": {}
                          },
                          "faviconLink": {}
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

CreateArticleInput: object

articleUrl:
organizationId:
translatedDescription:
translatedName:
Example
{
  "articleUrl": "object",
  "organizationId": "object",
  "translatedDescription": {
    "en": "object",
    "fr": "object"
  },
  "translatedName": {
    "en": "object",
    "fr": "object"
  }
}

CreateArticleResponse: object

article:
object
return:
arguments:
object
Example
{
  "article": {
    "return": {
      "articleUrl": {
        "return": "object",
        "arguments": {}
      },
      "createdAt": {
        "return": "object",
        "arguments": {}
      },
      "createdBy": {
        "return": {
          "email": {
            "return": "string",
            "arguments": {}
          },
          "firstName": {
            "return": "string",
            "arguments": {}
          },
          "id": {
            "return": "object",
            "arguments": {}
          },
          "language": {
            "return": "string",
            "arguments": {}
          },
          "lastName": {
            "return": "string",
            "arguments": {}
          },
          "organization": {
            "return": {
              "browserTabTitle": {
                "return": "string",
                "arguments": {}
              },
              "faviconLink": {
                "return": "string",
                "arguments": {}
              },
              "id": {
                "return": "object",
                "arguments": {}
              },
              "name": {
                "return": "string",
                "arguments": {}
              },
              "parent": {
                "return": {
                  "browserTabTitle": {
                    "return": "string",
                    "arguments": {}
                  },
                  "faviconLink": {
                    "return": "string",
                    "arguments": {}
                  },
                  "id": {
                    "return": "object",
                    "arguments": {}
                  },
                  "name": {
                    "return": "string",
                    "arguments": {}
                  },
                  "parent": {
                    "return": {
                      "browserTabTitle": {
                        "return": "string",
                        "arguments": {}
                      },
                      "faviconLink": {
                        "return": "string",
                        "arguments": {}
                      },
                      "id": {
                        "return": "object",
                        "arguments": {}
                      },
                      "name": {
                        "return": "string",
                        "arguments": {}
                      },
                      "parent": {
                        "return": {
                          "browserTabTitle": {
                            "return": "string",
                            "arguments": {}
                          },
                          "faviconLink": {}
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

CreateAssetClassInput: object

includeCash:
key:
organizationId:
translatedDescription:
translatedName:
Example
{
  "includeCash": "boolean",
  "key": "object",
  "organizationId": "object",
  "translatedDescription": {
    "en": "object",
    "fr": "object"
  },
  "translatedName": {
    "en": "object",
    "fr": "object"
  }
}

CreateAssetClassResponse: object

assetClass:
object
return:
arguments:
object
Example
{
  "assetClass": {
    "return": {
      "description": {
        "return": "string",
        "arguments": {}
      },
      "id": {
        "return": "object",
        "arguments": {}
      },
      "includeCash": {
        "return": "boolean",
        "arguments": {}
      },
      "key": {
        "return": "string",
        "arguments": {}
      },
      "name": {
        "return": "string",
        "arguments": {}
      },
      "state": {
        "return": "string",
        "arguments": {}
      },
      "translatedDescription": {
        "return": {
          "en": {
            "return": "string",
            "arguments": {}
          },
          "fr": {
            "return": "string",
            "arguments": {}
          }
        },
        "arguments": {}
      },
      "translatedName": {
        "return": {
          "en": {
            "return": "string",
            "arguments": {}
          },
          "fr": {
            "return": "string",
            "arguments": {}
          }
        },
        "arguments": {}
      }
    },
    "arguments": {}
  }
}

CreateBankAccountInput: object

bankAccountNumber:

User's bank account number. 7-12 digits

institutionNumber:

User's bank account institution number. 3 digits

name:
requestId:
transitNumber:

User's bank account transit number. 5 digits

userId:
Example
{
  "bankAccountNumber": "object",
  "institutionNumber": "object",
  "name": "object",
  "requestId": "object",
  "transitNumber": "object",
  "userId": "object"
}

CreateBankAccountResponse: object

bankAccount:
object
return:
arguments:
object
Example
{
  "bankAccount": {
    "return": {
      "EftEligibleRatio": {
        "return": "number",
        "arguments": {}
      },
      "bankAccountNumber": {
        "return": "string",
        "arguments": {}
      },
      "bankAccountNumberDisclosed": {
        "return": "string",
        "arguments": {}
      },
      "createdAt": {
        "return": "object",
        "arguments": {}
      },
      "downloadUrls": {
        "return": [
          "string"
        ],
        "arguments": {}
      },
      "id": {
        "return": "object",
        "arguments": {}
      },
      "institutionNumber": {
        "return": "string",
        "arguments": {}
      },
      "name": {
        "return": "string",
        "arguments": {}
      },
      "source": {
        "return": "string",
        "arguments": {}
      },
      "state": {
        "return": "string",
        "arguments": {}
      },
      "stateChanges": {
        "return": [
          "object"
        ],
        "arguments": {}
      },
      "transitNumber": {
        "return": "string",
        "arguments": {}
      },
      "transitNumberDisclosed": {
        "return": "string",
        "arguments": {}
      },
      "updatedAt": {
        "return": "object",
        "arguments": {}
      },
      "user": {
        "return": {
          "accessibleBy": {
            "return": [
              {
                "displayOptions": {
                  "return": {
                    "hide": {
                      "return": "boolean",
                      "arguments": {}
                    },
                    "order": {
                      "return": "number",
                      "arguments": {}
                    }
                  },
                  "arguments": {}
                },
                "organizationUser": {
                  "return": {
                    "accessType": {
                      "return": "string",
                      "arguments": {}
                    },
                    "apiTokens": {
                      "return": [
                        {
                          "id": {
                            "return": "object",
                            "arguments": {}
                          },
                          "jwtToken": {
                            "return": "string",
                            "arguments": {}
                          }
                        }
                      ]
                    }
                  }
                }
              }
            ]
          }
        }
      }
    }
  }
}

CreateBankConnectionInput: object

bankAccountRefId:
loginId:
userId:
Example
{
  "bankAccountRefId": "string",
  "loginId": "string",
  "userId": "object"
}

CreateBankConnectionResponse: object

bankConnection:
object
return:
arguments:
object
Example
{
  "bankConnection": {
    "return": {
      "bankAccounts": {
        "return": [
          {
            "EftEligibleRatio": {
              "return": "number",
              "arguments": {}
            },
            "bankAccountNumber": {
              "return": "string",
              "arguments": {}
            },
            "bankAccountNumberDisclosed": {
              "return": "string",
              "arguments": {}
            },
            "createdAt": {
              "return": "object",
              "arguments": {}
            },
            "downloadUrls": {
              "return": [
                "string"
              ],
              "arguments": {}
            },
            "id": {
              "return": "object",
              "arguments": {}
            },
            "institutionNumber": {
              "return": "string",
              "arguments": {}
            },
            "name": {
              "return": "string",
              "arguments": {}
            },
            "source": {
              "return": "string",
              "arguments": {}
            },
            "state": {
              "return": "string",
              "arguments": {}
            },
            "stateChanges": {
              "return": [
                "object"
              ],
              "arguments": {}
            },
            "transitNumber": {
              "return": "string",
              "arguments": {}
            },
            "transitNumberDisclosed": {
              "return": "string",
              "arguments": {}
            },
            "updatedAt": {
              "return": "object",
              "arguments": {}
            },
            "user": {
              "return": {
                "accessibleBy": {
                  "return": [
                    {
                      "displayOptions": {
                        "return": {
                          "hide": {
                            "return": "boolean",
                            "arguments": {}
                          },
                          "order": {
                            "return": "number",
                            "arguments": {}
                          }
                        },
                        "arguments": {}
                      },
                      "organizationUser": {
                        "return": {
                          "accessType": {
                            "return": "string",
                            "arguments": {}
                          },
                          "apiTokens": {
                            "return": [
                              {
                                "id": {
                                  "return": "object",
                                  "arguments": {}
                                }
                              }
                            ]
                          }
                        }
                      }
                    }
                  ]
                }
              }
            }
          }
        ]
      }
    }
  }
}

CreateBeneficiaryInput: object

accountId:
allocation:
name:
relation:
requestId:
successorAddress:
type:
Example
{
  "accountId": "object",
  "allocation": "number",
  "name": "object",
  "relation": "string",
  "requestId": "object",
  "successorAddress": {
    "city": "object",
    "country": "string",
    "houseNumber": "object",
    "jurisdiction": "string",
    "neighborhood": "object",
    "postal": "object",
    "province": "string",
    "streetName": "object",
    "unitNumber": "object"
  },
  "type": "string"
}

CreateBeneficiaryResponse: object

beneficiary:
object
return:
arguments:
object
Example
{
  "beneficiary": {
    "return": {
      "account": {
        "return": {
          "affiliations": {
            "return": [
              {
                "allocation": {
                  "return": "number",
                  "arguments": {}
                },
                "id": {
                  "return": "object",
                  "arguments": {}
                },
                "relation": {
                  "return": "string",
                  "arguments": {}
                },
                "signatureRequired": {
                  "return": "boolean",
                  "arguments": {}
                },
                "type": {
                  "return": "string",
                  "arguments": {}
                },
                "user": {
                  "return": {
                    "accessibleBy": {
                      "return": [
                        {
                          "displayOptions": {
                            "return": {
                              "hide": {
                                "return": "boolean",
                                "arguments": {}
                              },
                              "order": {
                                "return": "number",
                                "arguments": {}
                              }
                            },
                            "arguments": {}
                          },
                          "organizationUser": {
                            "return": {
                              "accessType": {
                                "return": "string",
                                "arguments": {}
                              },
                              "apiTokens": {
                                "return": [
                                  {
                                    "id": {
                                      "return": "object",
                                      "arguments": {}
                                    },
                                    "jwtToken": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "name": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "organization": {
                                      "return": {
                                        "browserTabTitle": {
                                          "return": "string",
                                          "arguments": {}
                                        },
                                        "faviconLink": {
                                          "return": "string",
                                          "arguments": {}
                                        },
                                        "id": {
                                          "return": "object",
                                          "arguments": {}
                                        },
                                        "name": {
                                          "return": "string",
                                          "arguments": {}
                                        },
                                        "parent": {
                                          "return": {
                                            "browserTabTitle": {
                                              "return": "string",
                                              "arguments": {}
                                            },
                                            "faviconLink": {}
                                          }
                                        }
                                      }
                                    }
                                  }
                                ]
                              }
                            }
                          }
                        }
                      ]
                    }
                  }
                }
              }
            ]
          }
        }
      }
    }
  }
}

CreateBillingScheduleInput: object

default:
endDate:
frequency:
nextBillingDate:
nextCalculationDate:
organizationId:
requestId:
startDate:
Example
{
  "default": "boolean",
  "endDate": "object",
  "frequency": "string",
  "nextBillingDate": "object",
  "nextCalculationDate": "object",
  "organizationId": "object",
  "requestId": "object",
  "startDate": "object"
}

CreateBillingScheduleResponse: object

billingSchedule:
object
return:
arguments:
object
Example
{
  "billingSchedule": {
    "return": {
      "createdAt": {
        "return": "object",
        "arguments": {}
      },
      "default": {
        "return": "boolean",
        "arguments": {}
      },
      "endDate": {
        "return": "object",
        "arguments": {}
      },
      "frequency": {
        "return": "string",
        "arguments": {}
      },
      "id": {
        "return": "object",
        "arguments": {}
      },
      "nextBillingDate": {
        "return": "object",
        "arguments": {}
      },
      "nextCalculationDate": {
        "return": "object",
        "arguments": {}
      },
      "organization": {
        "return": {
          "browserTabTitle": {
            "return": "string",
            "arguments": {}
          },
          "faviconLink": {
            "return": "string",
            "arguments": {}
          },
          "id": {
            "return": "object",
            "arguments": {}
          },
          "name": {
            "return": "string",
            "arguments": {}
          },
          "parent": {
            "return": {
              "browserTabTitle": {
                "return": "string",
                "arguments": {}
              },
              "faviconLink": {
                "return": "string",
                "arguments": {}
              },
              "id": {
                "return": "object",
                "arguments": {}
              },
              "name": {
                "return": "string",
                "arguments": {}
              },
              "parent": {
                "return": {
                  "browserTabTitle": {
                    "return": "string",
                    "arguments": {}
                  },
                  "faviconLink": {
                    "return": "string",
                    "arguments": {}
                  },
                  "id": {
                    "return": "object",
                    "arguments": {}
                  },
                  "name": {
                    "return": "string",
                    "arguments": {}
                  },
                  "parent": {
                    "return": {
                      "browserTabTitle": {
                        "return": "string",
                        "arguments": {}
                      },
                      "faviconLink": {
                        "return": "string",
                        "arguments": {}
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

CreateBulkImportInput: object

name:
organizationId:
Example
{
  "name": "object",
  "organizationId": "object"
}

CreateBulkImportResponse: object

bulkImport:
object
return:
arguments:
object
Example
{
  "bulkImport": {
    "return": {
      "createdAt": {
        "return": "object",
        "arguments": {}
      },
      "id": {
        "return": "object",
        "arguments": {}
      },
      "name": {
        "return": "string",
        "arguments": {}
      },
      "organization": {
        "return": {
          "browserTabTitle": {
            "return": "string",
            "arguments": {}
          },
          "faviconLink": {
            "return": "string",
            "arguments": {}
          },
          "id": {
            "return": "object",
            "arguments": {}
          },
          "name": {
            "return": "string",
            "arguments": {}
          },
          "parent": {
            "return": {
              "browserTabTitle": {
                "return": "string",
                "arguments": {}
              },
              "faviconLink": {
                "return": "string",
                "arguments": {}
              },
              "id": {
                "return": "object",
                "arguments": {}
              },
              "name": {
                "return": "string",
                "arguments": {}
              },
              "parent": {
                "return": {
                  "browserTabTitle": {
                    "return": "string",
                    "arguments": {}
                  },
                  "faviconLink": {
                    "return": "string",
                    "arguments": {}
                  },
                  "id": {
                    "return": "object",
                    "arguments": {}
                  },
                  "name": {
                    "return": "string",
                    "arguments": {}
                  },
                  "parent": {
                    "return": {
                      "browserTabTitle": {
                        "return": "string",
                        "arguments": {}
                      },
                      "faviconLink": {
                        "return": "string",
                        "arguments": {}
                      },
                      "id": {
                        "return": "object",
                        "arguments": {}
                      },
                      "name": {
                        "return": "string",
                        "arguments": {}
                      },
                      "parent": {
                        "return": {
                          "browserTabTitle": {
                            "return": "string",
                            "arguments": {}
                          },
                          "faviconLink": {}
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

CreateBulkTradeRequestInput: object

source:
sourceId:
Example
{
  "source": "string",
  "sourceId": "object"
}

CreateBulkTradeRequestResponse: object

bulkTradeRequest:
object
return:
arguments:
object
Example
{
  "bulkTradeRequest": {
    "return": {
      "createdAt": {
        "return": "object",
        "arguments": {}
      },
      "id": {
        "return": "object",
        "arguments": {}
      },
      "source": {
        "return": "string",
        "arguments": {}
      },
      "sourceId": {
        "return": "object",
        "arguments": {}
      },
      "state": {
        "return": "string",
        "arguments": {}
      },
      "stateChanges": {
        "return": [
          "object"
        ],
        "arguments": {}
      },
      "updatedAt": {
        "return": "object",
        "arguments": {}
      }
    },
    "arguments": {}
  }
}

CreateChequeTransferInput: object

amountCents:
currency:
fiscalYear:
Int
subAccountId:
type:
Example
{
  "amountCents": "object",
  "currency": "string",
  "fiscalYear": "number",
  "subAccountId": "object",
  "type": "string"
}

CreateChequeTransferResponse: object

transfer:
object
return:
arguments:
object
Example
{
  "transfer": {
    "return": {
      "alertReport": {
        "return": {
          "id": {
            "return": "object",
            "arguments": {}
          },
          "reason": {
            "return": "string",
            "arguments": {}
          },
          "rules": {
            "return": [
              {
                "id": {
                  "return": "object",
                  "arguments": {}
                },
                "translatedDescription": {
                  "return": {
                    "en": {
                      "return": "string",
                      "arguments": {}
                    },
                    "fr": {
                      "return": "string",
                      "arguments": {}
                    }
                  },
                  "arguments": {}
                },
                "type": {
                  "return": "string",
                  "arguments": {}
                }
              }
            ],
            "arguments": {}
          },
          "state": {
            "return": "string",
            "arguments": {}
          },
          "transfer": {
            "return": {
              "alertReport": {
                "return": {
                  "id": {
                    "return": "object",
                    "arguments": {}
                  },
                  "reason": {
                    "return": "string",
                    "arguments": {}
                  },
                  "rules": {
                    "return": [
                      {
                        "id": {
                          "return": "object",
                          "arguments": {}
                        },
                        "translatedDescription": {
                          "return": {
                            "en": {
                              "return": "string",
                              "arguments": {}
                            },
                            "fr": {
                              "return": "string",
                              "arguments": {}
                            }
                          },
                          "arguments": {}
                        },
                        "type": {
                          "return": "string",
                          "arguments": {}
                        }
                      }
                    ],
                    "arguments": {}
                  },
                  "state": {
                    "return": "string",
                    "arguments": {}
                  },
                  "transfer": {
                    "return": {
                      "alertReport": {
                        "return": {
                          "id": {
                            "return": "object",
                            "arguments": {}
                          },
                          "reason": {
                            "return": "string"
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

CreateClientGroupInput: object

Input type for ClientGroup

accountNumber:
billingScheduleId:
businessIsMemberOfIiroc:
businessType:

Coporate Business Type

corporationCountry:
establishedDate:
feeTierId:
incorporationNumber:
integrations:
ClientGroupIntegrationInput
name:
organizationId:
phone:
physicalAddress:
primaryEmail:
primaryUserId:

Primary contact user. It needs to be in the relationship list.

relationships:
RelationshipInput

relationship is a array with type and userID values

taxNumber:
type:

clientGroup type derives from ENUM

Example
{
  "accountNumber": "object",
  "billingScheduleId": "object",
  "businessIsMemberOfIiroc": "boolean",
  "businessType": "string",
  "corporationCountry": "string",
  "establishedDate": "object",
  "feeTierId": "object",
  "incorporationNumber": "object",
  "integrations": [
    {
      "externalId": "object",
      "groupId": "object",
      "iid": "object",
      "type": "string"
    }
  ],
  "name": "object",
  "organizationId": "object",
  "phone": "object",
  "physicalAddress": {
    "city": "object",
    "country": "string",
    "houseNumber": "object",
    "jurisdiction": "string",
    "neighborhood": "object",
    "postal": "object",
    "province": "string",
    "streetName": "object",
    "unitNumber": "object"
  },
  "primaryEmail": "object",
  "primaryUserId": "object",
  "relationships": [
    {
      "accessType": "string",
      "type": "object",
      "userId": "object"
    }
  ],
  "taxNumber": "object",
  "type": "string"
}

CreateClientGroupResponse: object

ClientGroup Response

clientGroup:
object

clientGroup object

return:
arguments:
object
Example
{
  "clientGroup": {
    "return": {
      "accountNumber": {
        "return": "string",
        "arguments": {}
      },
      "accounts": {
        "return": [
          {
            "affiliations": {
              "return": [
                {
                  "allocation": {
                    "return": "number",
                    "arguments": {}
                  },
                  "id": {
                    "return": "object",
                    "arguments": {}
                  },
                  "relation": {
                    "return": "string",
                    "arguments": {}
                  },
                  "signatureRequired": {
                    "return": "boolean",
                    "arguments": {}
                  },
                  "type": {
                    "return": "string",
                    "arguments": {}
                  },
                  "user": {
                    "return": {
                      "accessibleBy": {
                        "return": [
                          {
                            "displayOptions": {
                              "return": {
                                "hide": {
                                  "return": "boolean",
                                  "arguments": {}
                                },
                                "order": {
                                  "return": "number",
                                  "arguments": {}
                                }
                              },
                              "arguments": {}
                            },
                            "organizationUser": {
                              "return": {
                                "accessType": {
                                  "return": "string",
                                  "arguments": {}
                                },
                                "apiTokens": {
                                  "return": [
                                    {
                                      "id": {
                                        "return": "object",
                                        "arguments": {}
                                      },
                                      "jwtToken": {
                                        "return": "string",
                                        "arguments": {}
                                      },
                                      "name": {
                                        "return": "string",
                                        "arguments": {}
                                      },
                                      "organization": {
                                        "return": {
                                          "browserTabTitle": {
                                            "return": "string",
                                            "arguments": {}
                                          },
                                          "faviconLink": {
                                            "return": "string",
                                            "arguments": {}
                                          },
                                          "id": {
                                            "return": "object",
                                            "arguments": {}
                                          },
                                          "name": {
                                            "return": "string",
                                            "arguments": {}
                                          },
                                          "parent": {
                                            "return": {}
                                          }
                                        }
                                      }
                                    }
                                  ]
                                }
                              }
                            }
                          }
                        ]
                      }
                    }
                  }
                }
              ]
            }
          }
        ]
      }
    }
  }
}

CreateClientReportTemplateInput: object

isStatementOfType:
objectType:
organizationId:
reportType:
s3key:
schedulerDayOfMonthOrWeek:
Int
schedulerEnableNotification:
schedulerFrequency:
schedulerTriggerRules:
ClientReportTriggerRuleInput
templateParameters:
SafeString
translatedDescription:
translatedName:
type:
Example
{
  "isStatementOfType": "string",
  "objectType": "string",
  "organizationId": "object",
  "reportType": "string",
  "s3key": {
    "en": "object",
    "fr": "object"
  },
  "schedulerDayOfMonthOrWeek": "number",
  "schedulerEnableNotification": "boolean",
  "schedulerFrequency": "string",
  "schedulerTriggerRules": [
    {
      "comparison": "string",
      "field": "object",
      "value": "object"
    }
  ],
  "templateParameters": [
    "object"
  ],
  "translatedDescription": {
    "en": "object",
    "fr": "object"
  },
  "translatedName": {
    "en": "object",
    "fr": "object"
  },
  "type": "object"
}

CreateClientReportTemplatePageConfigurationInput: object

clientReportTemplateId:
options:
type:
widgets:
ClientReportTemplateWidgetConfigurationInput
Example
{
  "clientReportTemplateId": "object",
  "options": "object",
  "type": "string",
  "widgets": [
    {
      "options": "object",
      "type": "string"
    }
  ]
}

CreateClientReportTemplatePageConfigurationResponse: object

clientReportTemplatePageConfiguration:
object
return:
arguments:
object
Example
{
  "clientReportTemplatePageConfiguration": {
    "return": {
      "clientReportTemplate": {
        "return": {
          "clientReportTemplatePageConfiguration": {
            "return": {
              "clientReportTemplate": {
                "return": {
                  "clientReportTemplatePageConfiguration": {
                    "return": {
                      "clientReportTemplate": {
                        "return": {
                          "clientReportTemplatePageConfiguration": {
                            "return": {
                              "clientReportTemplate": {
                                "return": {
                                  "clientReportTemplatePageConfiguration": {
                                    "return": {
                                      "clientReportTemplate": {
                                        "return": {
                                          "clientReportTemplatePageConfiguration": {
                                            "return": {
                                              "clientReportTemplate": {
                                                "return": {
                                                  "clientReportTemplatePageConfiguration": {
                                                    "return": {
                                                      "clientReportTemplate": {
                                                        "return": {
                                                          "clientReportTemplatePageConfiguration": {
                                                            "return": {
                                                              "clientReportTemplate": {
                                                                "return": {
                                                                  "clientReportTemplatePageConfiguration": {
                                                                    "return": {
                                                                      "clientReportTemplate": {
                                                                        "return": {
                                                                          "clientReportTemplatePageConfiguration": {
                                                                            "return": {
                                                                              "clientReportTemplate": {
                                                                                "return": {
                                                                                  "clientReportTemplatePageConfiguration": {
                                                                                    "return": {
                                                                                      "clientReportTemplate": {
                                                                                        "return": {
                                                                                          "clientReportTemplatePageConfiguration": {
                                                                                            "return": {
                                                                                              "clientReportTemplate": {
                                                                                                "return": {
                                                                                                  "clientReportTemplatePageConfiguration": {
                                                                                                    "return": {
                                                                                                      "clientReportTemplate": {
                                                                                                        "return": {
                                                                                                          "clientReportTemplatePageConfiguration": {
                                                                                                            "return": {
                                                                                                              "clientReportTemplate": {
                                                                                                                "return": {
                                                                                                                  "clientReportTemplatePageConfiguration": {
                                                                                                                    "return": {
                                                                                                                      "clientReportTemplate": {
                                                                                                                        "return": {
                                                                                                                          "clientReportTemplatePageConfiguration": {
                                                                                                                            "return": {
                                                                                                                              "clientReportTemplate": {
                                                                                                                                "return": {
                                                                                                                                  "clientReportTemplatePageConfiguration": {
                                                                                                                                    "return": {}
                                                                                                                                  }
                                                                                                                                }
                                                                                                                              }
                                                                                                                            }
                                                                                                                          }
                                                                                                                        }
                                                                                                                      }
                                                                                                                    }
                                                                                                                  }
                                                                                                                }
                                                                                                              }
                                                                                                            }
                                                                                                          }
                                                                                                        }
                                                                                                      }
                                                                                                    }
                                                                                                  }
                                                                                                }
                                                                                              }
                                                                                            }
                                                                                          }
                                                                                        }
                                                                                      }
                                                                                    }
                                                                                  }
                                                                                }
                                                                              }
                                                                            }
                                                                          }
                                                                        }
                                                                      }
                                                                    }
                                                                  }
                                                                }
                                                              }
                                                            }
                                                          }
                                                        }
                                                      }
                                                    }
                                                  }
                                                }
                                              }
                                            }
                                          }
                                        }
                                      }
                                    }
                                  }
                                }
                              }
                            }
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

CreateCountryRiskInput: object

country:
countryCode:
disabled:
riskRating:
Example
{
  "country": "object",
  "countryCode": "object",
  "disabled": "boolean",
  "riskRating": "string"
}

CreateCountryRiskResponse: object

countryRisk:
object
return:
arguments:
object
Example
{
  "countryRisk": {
    "return": {
      "country": {
        "return": "object",
        "arguments": {}
      },
      "countryCode": {
        "return": "object",
        "arguments": {}
      },
      "disabled": {
        "return": "boolean",
        "arguments": {}
      },
      "id": {
        "return": "object",
        "arguments": {}
      },
      "riskRating": {
        "return": "string",
        "arguments": {}
      }
    },
    "arguments": {}
  }
}

CreateCustodianConnectionInput: object

accountOpenningSubmissionType:
accountTypeSettings:
AccountTypeSettingsInput
allowFractionalTrading:
allowTransactionCreation:
baseCurrency:
config:
custodianActivityImportFilePaths:
SafeString
custodianSnapshotImportFilePaths:
SafeString
custodianUsersImportFilePath:
customerName:
default:
disabledFlagTypes:
String
enableAccountOpeningSubmission:
enableAutoReconcileActivities:
enableAutoReconcilePositions:
enableCustodianAccountImport:
enableCustodianActivityImport:
enableCustodianOrganizationImport:
enableCustodianOrganizationUserImport:
enableCustodianSnapshotImport:
enableCustodianUserImport:
enableFetchCustodianAffiliates:
enableFetchCustodianProjectedIncome:
enableFetchCustodianSnapshotHistory:
enableFetchCustodianStatements:
enableFetchCustodianStatistics:
enableFetchCustodianSuitability:
enableFetchCustodianTransactions:
enableFetchCustodianUpcomingTransactions:
enableTransferSubmission:
fetchLivePrices:
name:
notificationEmails:
SafeString
organizationId:
reconciliationType:
repCode:
requestId:
sftpCredentials:
transferSubmissionType:
type:
Example
{
  "accountOpenningSubmissionType": "string",
  "accountTypeSettings": [
    {
      "availableCurrencies": [
        "string"
      ],
      "baseCurrency": "string",
      "isAutoSweepEnabled": "boolean",
      "isMultiCurrencyEnabled": "boolean",
      "type": "string"
    }
  ],
  "allowFractionalTrading": "boolean",
  "allowTransactionCreation": "boolean",
  "baseCurrency": "string",
  "config": "object",
  "custodianActivityImportFilePaths": [
    "object"
  ],
  "custodianSnapshotImportFilePaths": [
    "object"
  ],
  "custodianUsersImportFilePath": "object",
  "customerName": "object",
  "default": "boolean",
  "disabledFlagTypes": [
    "string"
  ],
  "enableAccountOpeningSubmission": "boolean",
  "enableAutoReconcileActivities": "boolean",
  "enableAutoReconcilePositions": "boolean",
  "enableCustodianAccountImport": "boolean",
  "enableCustodianActivityImport": "boolean",
  "enableCustodianOrganizationImport": "boolean",
  "enableCustodianOrganizationUserImport": "boolean",
  "enableCustodianSnapshotImport": "boolean",
  "enableCustodianUserImport": "boolean",
  "enableFetchCustodianAffiliates": "boolean",
  "enableFetchCustodianProjectedIncome": "boolean",
  "enableFetchCustodianSnapshotHistory": "boolean",
  "enableFetchCustodianStatements": "boolean",
  "enableFetchCustodianStatistics": "boolean",
  "enableFetchCustodianSuitability": "boolean",
  "enableFetchCustodianTransactions": "boolean",
  "enableFetchCustodianUpcomingTransactions": "boolean",
  "enableTransferSubmission": "boolean",
  "fetchLivePrices": "boolean",
  "name": "object",
  "notificationEmails": [
    "object"
  ],
  "organizationId": "object",
  "reconciliationType": "string",
  "repCode": "object",
  "requestId": "object",
  "sftpCredentials": {
    "sftpInBucket": "string",
    "sftpInDownloadFile": "boolean",
    "sftpInHost": "string"
  }
}

CreateCustodianConnectionResponse: object

custodianConnection:
object
return:
arguments:
object
Example
{
  "custodianConnection": {
    "return": {
      "accountOpenningSubmissionType": {
        "return": "string",
        "arguments": {}
      },
      "accountTypeSettings": {
        "return": [
          {
            "availableCurrencies": {
              "return": [
                "string"
              ],
              "arguments": {}
            },
            "baseCurrency": {
              "return": "string",
              "arguments": {}
            },
            "id": {
              "return": "object",
              "arguments": {}
            },
            "isAutoSweepEnabled": {
              "return": "boolean",
              "arguments": {}
            },
            "isMultiCurrencyEnabled": {
              "return": "boolean",
              "arguments": {}
            },
            "type": {
              "return": "string",
              "arguments": {}
            }
          }
        ],
        "arguments": {}
      },
      "allowFractionalTrading": {
        "return": "boolean",
        "arguments": {}
      },
      "allowTransactionCreation": {
        "return": "boolean",
        "arguments": {}
      },
      "baseCurrency": {
        "return": "string",
        "arguments": {}
      },
      "config": {
        "return": "object",
        "arguments": {}
      },
      "custodianActivityImportFilePaths": {
        "return": [
          "string"
        ],
        "arguments": {}
      },
      "custodianSnapshotImportFilePaths": {
        "return": [
          "object"
        ],
        "arguments": {}
      },
      "custodianUsersImportFilePath": {
        "return": "object",
        "arguments": {}
      },
      "customerName": {
        "return": "string",
        "arguments": {}
      },
      "default": {
        "return": "boolean",
        "arguments": {}
      },
      "disabledFlagTypes": {
        "return": [
          "string"
        ],
        "arguments": {}
      },
      "enableAccountOpeningSubmission": {
        "return": "boolean",
        "arguments": {}
      },
      "enableAutoReconcileActivities": {
        "return": "boolean",
        "arguments": {}
      },
      "enableAutoReconcilePositions": {
        "return": "boolean",
        "arguments": {}
      },
      "enableCustodianAccountImport": {
        "return": "boolean",
        "arguments": {}
      },
      "enableCustodianActivityImport": {
        "return": "boolean"
      }
    }
  }
}

CreateCustodianInput: object

customerName:
name:
notificationEmails:
SafeString
organizationId:
repCode:
requestId:
sftpInBucket:
sftpOutBucket:
type:
Example
{
  "customerName": "object",
  "name": "object",
  "notificationEmails": [
    "object"
  ],
  "organizationId": "object",
  "repCode": "object",
  "requestId": "object",
  "sftpInBucket": "object",
  "sftpOutBucket": "object",
  "type": "string"
}

CreateCustodianResponse: object

custodian:
object
return:
arguments:
object
Example
{
  "custodian": {
    "return": {
      "customerName": {
        "return": "string",
        "arguments": {}
      },
      "id": {
        "return": "object",
        "arguments": {}
      },
      "inventoryAccount": {
        "return": {
          "affiliations": {
            "return": [
              {
                "allocation": {
                  "return": "number",
                  "arguments": {}
                },
                "id": {
                  "return": "object",
                  "arguments": {}
                },
                "relation": {
                  "return": "string",
                  "arguments": {}
                },
                "signatureRequired": {
                  "return": "boolean",
                  "arguments": {}
                },
                "type": {
                  "return": "string",
                  "arguments": {}
                },
                "user": {
                  "return": {
                    "accessibleBy": {
                      "return": [
                        {
                          "displayOptions": {
                            "return": {
                              "hide": {
                                "return": "boolean",
                                "arguments": {}
                              },
                              "order": {
                                "return": "number",
                                "arguments": {}
                              }
                            },
                            "arguments": {}
                          },
                          "organizationUser": {
                            "return": {
                              "accessType": {
                                "return": "string",
                                "arguments": {}
                              },
                              "apiTokens": {
                                "return": [
                                  {
                                    "id": {
                                      "return": "object",
                                      "arguments": {}
                                    },
                                    "jwtToken": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "name": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "organization": {
                                      "return": {
                                        "browserTabTitle": {
                                          "return": "string",
                                          "arguments": {}
                                        },
                                        "faviconLink": {
                                          "return": "string",
                                          "arguments": {}
                                        },
                                        "id": {
                                          "return": "object",
                                          "arguments": {}
                                        },
                                        "name": {
                                          "return": "string",
                                          "arguments": {}
                                        }
                                      }
                                    }
                                  }
                                ]
                              }
                            }
                          }
                        }
                      ]
                    }
                  }
                }
              }
            ]
          }
        }
      }
    }
  }
}

CreateCustomFieldInput: object

conditionalRules:
CustomFieldConditionalRuleInput
externalField:
format:
key:
objectType:
organizationId:
selectOptions:
CustomFieldSelectOptionInput
translatedDescription:
translatedName:
type:
workflowStep:
Example
{
  "conditionalRules": [
    {
      "comparison": "string",
      "field": "object",
      "value": "object"
    }
  ],
  "externalField": "string",
  "format": "string",
  "key": "object",
  "objectType": "string",
  "organizationId": "object",
  "selectOptions": [
    {
      "displayText": {
        "en": "object",
        "fr": "object"
      },
      "value": "object"
    }
  ],
  "translatedDescription": {
    "en": "object",
    "fr": "object"
  },
  "translatedName": {
    "en": "object",
    "fr": "object"
  },
  "type": "string",
  "workflowStep": "string"
}

CreateCustomFieldResponse: object

customField:
object
return:
arguments:
object
Example
{
  "customField": {
    "return": {
      "conditionalRules": {
        "return": [
          {
            "comparison": {
              "return": "string",
              "arguments": {}
            },
            "field": {
              "return": "string",
              "arguments": {}
            },
            "value": {
              "return": "string",
              "arguments": {}
            }
          }
        ],
        "arguments": {}
      },
      "externalField": {
        "return": "string",
        "arguments": {}
      },
      "format": {
        "return": "string",
        "arguments": {}
      },
      "id": {
        "return": "object",
        "arguments": {}
      },
      "key": {
        "return": "string",
        "arguments": {}
      },
      "objectType": {
        "return": "string",
        "arguments": {}
      },
      "organization": {
        "return": {
          "browserTabTitle": {
            "return": "string",
            "arguments": {}
          },
          "faviconLink": {
            "return": "string",
            "arguments": {}
          },
          "id": {
            "return": "object",
            "arguments": {}
          },
          "name": {
            "return": "string",
            "arguments": {}
          },
          "parent": {
            "return": {
              "browserTabTitle": {
                "return": "string",
                "arguments": {}
              },
              "faviconLink": {
                "return": "string",
                "arguments": {}
              },
              "id": {
                "return": "object",
                "arguments": {}
              },
              "name": {
                "return": "string",
                "arguments": {}
              },
              "parent": {
                "return": {
                  "browserTabTitle": {
                    "return": "string",
                    "arguments": {}
                  },
                  "faviconLink": {
                    "return": "string",
                    "arguments": {}
                  },
                  "id": {
                    "return": "object",
                    "arguments": {}
                  },
                  "name": {
                    "return": "string",
                    "arguments": {}
                  },
                  "parent": {}
                }
              }
            }
          }
        }
      }
    }
  }
}

CreateDepositTransferInput: object

amountCents:
bankAccountId:
currency:
fiscalYear:
Int
instantInvest:

instantInvest skips the holding period before the amount is invested Only available to partners with the certainty of deposits that do not bounce

requestId:
subAccountId:
Example
{
  "amountCents": "object",
  "bankAccountId": "object",
  "currency": "string",
  "fiscalYear": "number",
  "instantInvest": "boolean",
  "requestId": "object",
  "subAccountId": "object"
}

CreateExternalTransferInput: object

amountCents:
Int

ManualProcess's transfer Amount.

bctesgAmountCents:
Int

ManualProcess's transfer bct esg Amount.

clbAmountCents:
Int

ManualProcess's transfer clb Amount.

createdByUserId:

The createdByUserId will be the transfer creating user

institution:

ManualProcess's intitution.

requestIpAddress:

The Requesters IP Address

subAccountId:
ID

ManualProcess's subAccount.

transferAccount:

ManualProcess's transfer Account type.

transferAccountNumber:

ManualProcess's transfer Account number.

transferMethod:

ManualProcess's transferType.

Example
{
  "amountCents": "number",
  "bctesgAmountCents": "number",
  "clbAmountCents": "number",
  "createdByUserId": "object",
  "institution": {
    "id": "object",
    "name": "object",
    "physicalAddress": {
      "city": "object",
      "country": "string",
      "houseNumber": "object",
      "jurisdiction": "string",
      "neighborhood": "object",
      "postal": "object",
      "province": "string",
      "streetName": "object",
      "unitNumber": "object"
    }
  },
  "requestIpAddress": "object",
  "subAccountId": "object",
  "transferAccount": "string",
  "transferAccountNumber": "object",
  "transferMethod": "string"
}

CreateExternalTransferInstitutionInput: object

id:
ID

Institution id

name:

Institution name

physicalAddress:

Institution physical address

Example
{
  "id": "object",
  "name": "object",
  "physicalAddress": {
    "city": "object",
    "country": "string",
    "houseNumber": "object",
    "jurisdiction": "string",
    "neighborhood": "object",
    "postal": "object",
    "province": "string",
    "streetName": "object",
    "unitNumber": "object"
  }
}

CreateExternalTransferResponse: object

manualProcess:
object
return:
arguments:
object
Example
{
  "manualProcess": {
    "return": {
      "account": {
        "return": {
          "affiliations": {
            "return": [
              {
                "allocation": {
                  "return": "number",
                  "arguments": {}
                },
                "id": {
                  "return": "object",
                  "arguments": {}
                },
                "relation": {
                  "return": "string",
                  "arguments": {}
                },
                "signatureRequired": {
                  "return": "boolean",
                  "arguments": {}
                },
                "type": {
                  "return": "string",
                  "arguments": {}
                },
                "user": {
                  "return": {
                    "accessibleBy": {
                      "return": [
                        {
                          "displayOptions": {
                            "return": {
                              "hide": {
                                "return": "boolean",
                                "arguments": {}
                              },
                              "order": {
                                "return": "number",
                                "arguments": {}
                              }
                            },
                            "arguments": {}
                          },
                          "organizationUser": {
                            "return": {
                              "accessType": {
                                "return": "string",
                                "arguments": {}
                              },
                              "apiTokens": {
                                "return": [
                                  {
                                    "id": {
                                      "return": "object",
                                      "arguments": {}
                                    },
                                    "jwtToken": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "name": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "organization": {
                                      "return": {
                                        "browserTabTitle": {
                                          "return": "string",
                                          "arguments": {}
                                        },
                                        "faviconLink": {
                                          "return": "string",
                                          "arguments": {}
                                        },
                                        "id": {
                                          "return": "object",
                                          "arguments": {}
                                        },
                                        "name": {
                                          "return": "string",
                                          "arguments": {}
                                        },
                                        "parent": {
                                          "return": {
                                            "browserTabTitle": {
                                              "return": "string",
                                              "arguments": {}
                                            },
                                            "faviconLink": {}
                                          }
                                        }
                                      }
                                    }
                                  }
                                ]
                              }
                            }
                          }
                        }
                      ]
                    }
                  }
                }
              }
            ]
          }
        }
      }
    }
  }
}

CreateFeeTierInput: object

blendedGrid:
chargeForCash:
chargeForCashOnHold:
default:
discountPercentage:
flatAnnualFeeBps:
grid:
FeeTierGridInput
gridScopeType:
name:
organizationId:
requestId:
Example
{
  "blendedGrid": "boolean",
  "chargeForCash": "boolean",
  "chargeForCashOnHold": "boolean",
  "default": "boolean",
  "discountPercentage": "number",
  "flatAnnualFeeBps": "number",
  "grid": [
    {
      "annualFeeBps": "number",
      "annualFeeCents": "object",
      "minMarketValueCents": "object"
    }
  ],
  "gridScopeType": "string",
  "name": "object",
  "organizationId": "object",
  "requestId": "object"
}

CreateFeeTierResponse: object

feeTier:
object
return:
arguments:
object
Example
{
  "feeTier": {
    "return": {
      "blendedGrid": {
        "return": "boolean",
        "arguments": {}
      },
      "chargeForCash": {
        "return": "boolean",
        "arguments": {}
      },
      "chargeForCashOnHold": {
        "return": "boolean",
        "arguments": {}
      },
      "createdAt": {
        "return": "object",
        "arguments": {}
      },
      "default": {
        "return": "boolean",
        "arguments": {}
      },
      "discountPercentage": {
        "return": "number",
        "arguments": {}
      },
      "flatAnnualFeeBps": {
        "return": "number",
        "arguments": {}
      },
      "grid": {
        "return": [
          {
            "annualFeeBps": {
              "return": "number",
              "arguments": {}
            },
            "annualFeeCents": {
              "return": "object",
              "arguments": {}
            },
            "minMarketValueCents": {
              "return": "object",
              "arguments": {}
            }
          }
        ],
        "arguments": {}
      },
      "gridScopeType": {
        "return": "string",
        "arguments": {}
      },
      "id": {
        "return": "object",
        "arguments": {}
      },
      "name": {
        "return": "string",
        "arguments": {}
      },
      "organization": {
        "return": {
          "browserTabTitle": {
            "return": "string",
            "arguments": {}
          },
          "faviconLink": {
            "return": "string",
            "arguments": {}
          },
          "id": {
            "return": "object",
            "arguments": {}
          },
          "name": {
            "return": "string",
            "arguments": {}
          },
          "parent": {
            "return": {
              "browserTabTitle": {
                "return": "string",
                "arguments": {}
              },
              "faviconLink": {
                "return": "string",
                "arguments": {}
              },
              "id": {
                "return": "object",
                "arguments": {}
              },
              "name": {
                "return": "string",
                "arguments": {}
              },
              "parent": {}
            }
          }
        }
      }
    }
  }
}

CreateFileDocumentInput: object

fileName:
mediaType:
name:
objectId:
objectType:
permissionType:
requestId:
requestIpAddress:
sharedClient:
sharedCustodian:
signed:
sourceId:
sourceType:
type:
Example
{
  "fileName": "object",
  "mediaType": "object",
  "name": "object",
  "objectId": "object",
  "objectType": "string",
  "permissionType": "string",
  "requestId": "object",
  "requestIpAddress": "object",
  "sharedClient": "boolean",
  "sharedCustodian": "boolean",
  "signed": "boolean",
  "sourceId": "object",
  "sourceType": "object",
  "type": "string"
}

CreateFileDocumentResponse: object

File Types

fileDocument:
object
return:
arguments:
object
Example
{
  "fileDocument": {
    "return": {
      "createdAt": {
        "return": "object",
        "arguments": {}
      },
      "creator": {
        "return": {
          "email": {
            "return": "string",
            "arguments": {}
          },
          "firstName": {
            "return": "string",
            "arguments": {}
          },
          "id": {
            "return": "object",
            "arguments": {}
          },
          "language": {
            "return": "string",
            "arguments": {}
          },
          "lastName": {
            "return": "string",
            "arguments": {}
          },
          "organization": {
            "return": {
              "browserTabTitle": {
                "return": "string",
                "arguments": {}
              },
              "faviconLink": {
                "return": "string",
                "arguments": {}
              },
              "id": {
                "return": "object",
                "arguments": {}
              },
              "name": {
                "return": "string",
                "arguments": {}
              },
              "parent": {
                "return": {
                  "browserTabTitle": {
                    "return": "string",
                    "arguments": {}
                  },
                  "faviconLink": {
                    "return": "string",
                    "arguments": {}
                  },
                  "id": {
                    "return": "object",
                    "arguments": {}
                  },
                  "name": {
                    "return": "string",
                    "arguments": {}
                  },
                  "parent": {
                    "return": {
                      "browserTabTitle": {
                        "return": "string",
                        "arguments": {}
                      },
                      "faviconLink": {
                        "return": "string",
                        "arguments": {}
                      },
                      "id": {
                        "return": "object",
                        "arguments": {}
                      },
                      "name": {
                        "return": "string",
                        "arguments": {}
                      },
                      "parent": {
                        "return": {
                          "browserTabTitle": {
                            "return": "string",
                            "arguments": {}
                          },
                          "faviconLink": {
                            "return": "string",
                            "arguments": {}
                          },
                          "id": {}
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

CreateFinancialProductInput: object

autoUpdatePrices:

Auto updates prices using data partner?

currency:

The currency that this Financial product trades in.

cusip:
exchange:

The Stock Exchange that this Financial product trades in.

integrations:
FinancialProductIntegrationInput
isPartial:

When true, allowed to allocate fractional trades.

Defaults to true.

isin:
organizationId:
primaryAssetClassId:

Primary AssetClass of the product

ric:
riskProfileDescription:
riskProfileName:
scheduleId:

financialProduct scheduleID

secondaryAssetClassId:

Secondary AssetClass of the product

settlementDays:
Int
substituteFinancialProductId:

Optional substitute Financial product (used for Tax-Loss Harvesting).

taxRank:
Int

The tax rank of the financial product, to be used for portfolio optimization

tertiaryAssetClassId:

Tertiary AssetClass of the product

ticker:

The trading ticker for this Financial product.

translatedName:

The translated names of the Financial product.

url:
volatile:
waivedFeePercentage:

A discount percentage applied to the corresponding holding amount during fee calculation (0 - 100%).

Example
{
  "autoUpdatePrices": "boolean",
  "currency": "string",
  "cusip": "string",
  "exchange": "string",
  "integrations": [
    {
      "externalId": "object",
      "groupId": "object",
      "iid": "object",
      "type": "string"
    }
  ],
  "isPartial": "boolean",
  "isin": "string",
  "organizationId": "object",
  "primaryAssetClassId": "object",
  "ric": "string",
  "riskProfileDescription": {
    "en": "object",
    "fr": "object"
  },
  "riskProfileName": {
    "en": "object",
    "fr": "object"
  },
  "scheduleId": "object",
  "secondaryAssetClassId": "object",
  "settlementDays": "number",
  "substituteFinancialProductId": "object",
  "taxRank": "number",
  "tertiaryAssetClassId": "object",
  "ticker": "object",
  "translatedName": {
    "en": "object",
    "fr": "object"
  },
  "url": "string",
  "volatile": "boolean",
  "waivedFeePercentage": "number"
}

CreateFinancialProductResponse: object

financialProduct:
object

The Financial product.

return:
arguments:
object
Example
{
  "financialProduct": {
    "return": {
      "assignable": {
        "return": "boolean",
        "arguments": {}
      },
      "autoUpdatePrices": {
        "return": "boolean",
        "arguments": {}
      },
      "children": {
        "return": [
          {
            "financialProduct": {
              "return": {
                "assignable": {
                  "return": "boolean",
                  "arguments": {}
                },
                "autoUpdatePrices": {
                  "return": "boolean",
                  "arguments": {}
                },
                "children": {
                  "return": [
                    {
                      "financialProduct": {
                        "return": {
                          "assignable": {
                            "return": "boolean",
                            "arguments": {}
                          },
                          "autoUpdatePrices": {
                            "return": "boolean",
                            "arguments": {}
                          },
                          "children": {
                            "return": [
                              {
                                "financialProduct": {
                                  "return": {
                                    "assignable": {
                                      "return": "boolean",
                                      "arguments": {}
                                    },
                                    "autoUpdatePrices": {
                                      "return": "boolean",
                                      "arguments": {}
                                    },
                                    "children": {
                                      "return": [
                                        {
                                          "financialProduct": {
                                            "return": {
                                              "assignable": {
                                                "return": "boolean",
                                                "arguments": {}
                                              },
                                              "autoUpdatePrices": {
                                                "return": "boolean",
                                                "arguments": {}
                                              },
                                              "children": {
                                                "return": [
                                                  {
                                                    "financialProduct": {
                                                      "return": {
                                                        "assignable": {
                                                          "return": "boolean",
                                                          "arguments": {}
                                                        },
                                                        "autoUpdatePrices": {
                                                          "return": "boolean",
                                                          "arguments": {}
                                                        },
                                                        "children": {
                                                          "return": [
                                                            {
                                                              "financialProduct": {
                                                                "return": {
                                                                  "assignable": {
                                                                    "return": "boolean",
                                                                    "arguments": {}
                                                                  },
                                                                  "autoUpdatePrices": {}
                                                                }
                                                              }
                                                            }
                                                          ]
                                                        }
                                                      }
                                                    }
                                                  }
                                                ]
                                              }
                                            }
                                          }
                                        }
                                      ]
                                    }
                                  }
                                }
                              }
                            ]
                          }
                        }
                      }
                    }
                  ]
                }
              }
            }
          }
        ]
      }
    }
  }
}

CreateFormTemplateInput: object

digitalSignatureEnabled:
englishMarkdown:
formType:
frenchMarkdown:
minVersion:
Int
organizationId:
Example
{
  "digitalSignatureEnabled": "boolean",
  "englishMarkdown": "string",
  "formType": "string",
  "frenchMarkdown": "string",
  "minVersion": "number",
  "organizationId": "object"
}

CreateFormTemplateResponse: object

formTemplate:
object
return:
arguments:
object
Example
{
  "formTemplate": {
    "return": {
      "digitalSignatureEnabled": {
        "return": "boolean",
        "arguments": {}
      },
      "displayName": {
        "return": "string",
        "arguments": {}
      },
      "id": {
        "return": "object",
        "arguments": {}
      },
      "minVersion": {
        "return": "number",
        "arguments": {}
      },
      "organization": {
        "return": {
          "accountTypeTaxRanks": {
            "return": [
              {
                "accountType": {
                  "return": "string",
                  "arguments": {}
                },
                "id": {
                  "return": "object",
                  "arguments": {}
                },
                "taxRank": {
                  "return": "number",
                  "arguments": {}
                }
              }
            ],
            "arguments": {}
          },
          "allowAccessToSubOrganizations": {
            "return": "boolean",
            "arguments": {}
          },
          "allowDirectCommunication": {
            "return": "boolean",
            "arguments": {}
          },
          "allowInactiveUserAdjustments": {
            "return": "boolean",
            "arguments": {}
          },
          "allowInactiveUserFeeCalculation": {
            "return": "boolean",
            "arguments": {}
          },
          "allowInactiveUserRebalancing": {
            "return": "boolean",
            "arguments": {}
          },
          "allowInstantInvest": {
            "return": "boolean",
            "arguments": {}
          },
          "allowPortfolioPerGoal": {
            "return": "boolean",
            "arguments": {}
          },
          "allowPostOptimizationEditing": {
            "return": "boolean",
            "arguments": {}
          },
          "allowViewSubTradeRequestPairs": {
            "return": "boolean",
            "arguments": {}
          },
          "applicableJurisdictions": {
            "return": {
              "all": {
                "return": "boolean",
                "arguments": {}
              },
              "only": {
                "return": [
                  "string"
                ],
                "arguments": {}
              }
            },
            "arguments": {}
          },
          "applicableLocalization": {
            "return": {
              "countries": {
                "return": [
                  "string"
                ],
                "arguments": {}
              },
              "dateFormat": {
                "return": "string"
              }
            }
          }
        }
      }
    }
  }
}

CreateGoalInput: object

clientGroupId:
customFields:
CustomFieldInput
expectedAnnualIncomeCents:
Int
financialProductId:
householdClientGroupId:
integrations:
GoalIntegrationInput
lastUpdatedBy:
name:
requestId:
retirementAge:
Int
riskQuestion1:
targetAmountCents:
targetDate:
taxOptimized:
timeHorizon:
tradingProcess:
type:
userId:
Example
{
  "clientGroupId": "object",
  "customFields": [
    {
      "key": "object",
      "value": "object"
    }
  ],
  "expectedAnnualIncomeCents": "number",
  "financialProductId": "object",
  "householdClientGroupId": "object",
  "integrations": [
    {
      "externalId": "object",
      "groupId": "object",
      "iid": "object",
      "type": "string"
    }
  ],
  "lastUpdatedBy": "object",
  "name": "object",
  "requestId": "object",
  "retirementAge": "number",
  "riskQuestion1": "string",
  "targetAmountCents": "object",
  "targetDate": "object",
  "taxOptimized": "boolean",
  "timeHorizon": "string",
  "tradingProcess": "string",
  "type": "string",
  "userId": "object"
}

CreateGoalResponse: object

goal:
object
return:
arguments:
object
Example
{
  "goal": {
    "return": {
      "availableFinancialProducts": {
        "return": [
          {
            "assignable": {
              "return": "boolean",
              "arguments": {}
            },
            "autoUpdatePrices": {
              "return": "boolean",
              "arguments": {}
            },
            "children": {
              "return": [
                {
                  "financialProduct": {
                    "return": {
                      "assignable": {
                        "return": "boolean",
                        "arguments": {}
                      },
                      "autoUpdatePrices": {
                        "return": "boolean",
                        "arguments": {}
                      },
                      "children": {
                        "return": [
                          {
                            "financialProduct": {
                              "return": {
                                "assignable": {
                                  "return": "boolean",
                                  "arguments": {}
                                },
                                "autoUpdatePrices": {
                                  "return": "boolean",
                                  "arguments": {}
                                },
                                "children": {
                                  "return": [
                                    {
                                      "financialProduct": {
                                        "return": {
                                          "assignable": {
                                            "return": "boolean",
                                            "arguments": {}
                                          },
                                          "autoUpdatePrices": {
                                            "return": "boolean",
                                            "arguments": {}
                                          },
                                          "children": {
                                            "return": [
                                              {
                                                "financialProduct": {
                                                  "return": {
                                                    "assignable": {
                                                      "return": "boolean",
                                                      "arguments": {}
                                                    },
                                                    "autoUpdatePrices": {
                                                      "return": "boolean",
                                                      "arguments": {}
                                                    },
                                                    "children": {
                                                      "return": [
                                                        {
                                                          "financialProduct": {
                                                            "return": {
                                                              "assignable": {
                                                                "return": "boolean",
                                                                "arguments": {}
                                                              },
                                                              "autoUpdatePrices": {
                                                                "return": "boolean",
                                                                "arguments": {}
                                                              },
                                                              "children": {
                                                                "return": [
                                                                  {
                                                                    "financialProduct": {
                                                                      "return": {
                                                                        "assignable": {}
                                                                      }
                                                                    }
                                                                  }
                                                                ]
                                                              }
                                                            }
                                                          }
                                                        }
                                                      ]
                                                    }
                                                  }
                                                }
                                              }
                                            ]
                                          }
                                        }
                                      }
                                    }
                                  ]
                                }
                              }
                            }
                          }
                        ]
                      }
                    }
                  }
                }
              ]
            }
          }
        ]
      }
    }
  }
}

CreateInstitutionInput: object

isDraft:

Institution isDraft

name:

Institution name

physicalAddress:

Institution Address

Example
{
  "isDraft": "boolean",
  "name": "object",
  "physicalAddress": {
    "city": "object",
    "country": "string",
    "houseNumber": "object",
    "jurisdiction": "string",
    "neighborhood": "object",
    "postal": "object",
    "province": "string",
    "streetName": "object",
    "unitNumber": "object"
  }
}

CreateInstitutionResponse: object

institution:
object
return:
arguments:
object
Example
{
  "institution": {
    "return": {
      "createdAt": {
        "return": "object",
        "arguments": {}
      },
      "id": {
        "return": "object",
        "arguments": {}
      },
      "isDraft": {
        "return": "string",
        "arguments": {}
      },
      "name": {
        "return": "string",
        "arguments": {}
      },
      "physicalAddress": {
        "return": {
          "city": {
            "return": "string",
            "arguments": {}
          },
          "country": {
            "return": "string",
            "arguments": {}
          },
          "houseNumber": {
            "return": "string",
            "arguments": {}
          },
          "jurisdiction": {
            "return": "string",
            "arguments": {}
          },
          "neighborhood": {
            "return": "string",
            "arguments": {}
          },
          "postal": {
            "return": "string",
            "arguments": {}
          },
          "province": {
            "return": "string",
            "arguments": {}
          },
          "streetName": {
            "return": "string",
            "arguments": {}
          },
          "unitNumber": {
            "return": "string",
            "arguments": {}
          }
        },
        "arguments": {}
      },
      "state": {
        "return": "string",
        "arguments": {}
      },
      "stateChanges": {
        "return": [
          "object"
        ],
        "arguments": {}
      },
      "updatedAt": {
        "return": "object",
        "arguments": {}
      }
    },
    "arguments": {}
  }
}

CreateIntegrationInput: object

configuration:
organizationId:
provider:
type:
Example
{
  "configuration": "object",
  "organizationId": "object",
  "provider": "string",
  "type": "string"
}

CreateIntegrationResponse: object

integration:
object
return:
arguments:
object
Example
{
  "integration": {
    "return": {
      "configuration": {
        "return": "object",
        "arguments": {}
      },
      "id": {
        "return": "object",
        "arguments": {}
      },
      "organization": {
        "return": {
          "browserTabTitle": {
            "return": "string",
            "arguments": {}
          },
          "faviconLink": {
            "return": "string",
            "arguments": {}
          },
          "id": {
            "return": "object",
            "arguments": {}
          },
          "name": {
            "return": "string",
            "arguments": {}
          },
          "parent": {
            "return": {
              "browserTabTitle": {
                "return": "string",
                "arguments": {}
              },
              "faviconLink": {
                "return": "string",
                "arguments": {}
              },
              "id": {
                "return": "object",
                "arguments": {}
              },
              "name": {
                "return": "string",
                "arguments": {}
              },
              "parent": {
                "return": {
                  "browserTabTitle": {
                    "return": "string",
                    "arguments": {}
                  },
                  "faviconLink": {
                    "return": "string",
                    "arguments": {}
                  },
                  "id": {
                    "return": "object",
                    "arguments": {}
                  },
                  "name": {
                    "return": "string",
                    "arguments": {}
                  },
                  "parent": {
                    "return": {
                      "browserTabTitle": {
                        "return": "string",
                        "arguments": {}
                      },
                      "faviconLink": {
                        "return": "string",
                        "arguments": {}
                      },
                      "id": {
                        "return": "object",
                        "arguments": {}
                      },
                      "name": {
                        "return": "string",
                        "arguments": {}
                      },
                      "parent": {
                        "return": {
                          "browserTabTitle": {
                            "return": "string",
                            "arguments": {}
                          },
                          "faviconLink": {
                            "return": "string",
                            "arguments": {}
                          },
                          "id": {}
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

CreateJobTitleRiskInput: object

companyType:
disabled:
jobTitle:
riskRating:
Example
{
  "companyType": "object",
  "disabled": "boolean",
  "jobTitle": "object",
  "riskRating": "string"
}

CreateJobTitleRiskResponse: object

jobTitleRisk:
object
return:
arguments:
object
Example
{
  "jobTitleRisk": {
    "return": {
      "companyType": {
        "return": "object",
        "arguments": {}
      },
      "disabled": {
        "return": "boolean",
        "arguments": {}
      },
      "id": {
        "return": "object",
        "arguments": {}
      },
      "jobTitle": {
        "return": "object",
        "arguments": {}
      },
      "riskRating": {
        "return": "string",
        "arguments": {}
      }
    },
    "arguments": {}
  }
}

CreateLocalizationResponse: object

localization:
object
return:
arguments:
object
Example
{
  "localization": {
    "return": {
      "countries": {
        "return": [
          "string"
        ],
        "arguments": {}
      },
      "dateFormat": {
        "return": "string",
        "arguments": {}
      },
      "defaultCurrency": {
        "return": "string",
        "arguments": {}
      },
      "defaultLanguage": {
        "return": "string",
        "arguments": {}
      },
      "id": {
        "return": "object",
        "arguments": {}
      },
      "languages": {
        "return": [
          "string"
        ],
        "arguments": {}
      },
      "name": {
        "return": "string",
        "arguments": {}
      },
      "organization": {
        "return": {
          "browserTabTitle": {
            "return": "string",
            "arguments": {}
          },
          "faviconLink": {
            "return": "string",
            "arguments": {}
          },
          "id": {
            "return": "object",
            "arguments": {}
          },
          "name": {
            "return": "string",
            "arguments": {}
          },
          "parent": {
            "return": {
              "browserTabTitle": {
                "return": "string",
                "arguments": {}
              },
              "faviconLink": {
                "return": "string",
                "arguments": {}
              },
              "id": {
                "return": "object",
                "arguments": {}
              },
              "name": {
                "return": "string",
                "arguments": {}
              },
              "parent": {
                "return": {
                  "browserTabTitle": {
                    "return": "string",
                    "arguments": {}
                  },
                  "faviconLink": {
                    "return": "string",
                    "arguments": {}
                  },
                  "id": {
                    "return": "object",
                    "arguments": {}
                  },
                  "name": {
                    "return": "string",
                    "arguments": {}
                  },
                  "parent": {
                    "return": {
                      "browserTabTitle": {
                        "return": "string",
                        "arguments": {}
                      },
                      "faviconLink": {}
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

CreateModelPortfolioInput: object

forecastedRateOfReturn:
forecastedStandardDeviation:
lowThresholdScore:

Low threshold score for allowing access

organizationId:

The organization to link to the financial product to.

riskReturnLevel:
Int
scheduleId:

Optional schedule (used for illiquid portfolios).

suggestable:

Is this Financial product suggestable?

suggestedMaxScore:

Maximum suitability score to have access to this Financial product.

suggestedMinScore:

Minimum suitability score to have access to this Financial product.

targetAllocations:
TargetAllocationInput

All Target Allocations

themeId:

ID for the theme assigned

translatedInvestmentObjective:

The translated investment objectives of the portfolio

translatedLiquidity:

The translated liquidity of the portfolio

translatedName:

The translated names of the Financial product.

translatedPortfolioDescription:

The translated descriptions of the portfolio

translatedPortfolioDisclaimer:

The translated disclaimers of the portfolio

url:
Example
{
  "forecastedRateOfReturn": "number",
  "forecastedStandardDeviation": "number",
  "lowThresholdScore": "number",
  "organizationId": "object",
  "riskReturnLevel": "number",
  "scheduleId": "object",
  "suggestable": "boolean",
  "suggestedMaxScore": "number",
  "suggestedMinScore": "number",
  "targetAllocations": [
    {
      "max": "number",
      "min": "number",
      "secondaryAssetClassId": "object"
    }
  ],
  "themeId": "object",
  "translatedInvestmentObjective": {
    "en": "object",
    "fr": "object"
  },
  "translatedLiquidity": {
    "en": "object",
    "fr": "object"
  },
  "translatedName": {
    "en": "object",
    "fr": "object"
  },
  "translatedPortfolioDescription": {
    "en": "object",
    "fr": "object"
  },
  "translatedPortfolioDisclaimer": {
    "en": "object",
    "fr": "object"
  },
  "url": "string"
}

CreateModelPortfolioResponse: object

modelPortfolio:
object

The Financial product.

return:
arguments:
object
Example
{
  "modelPortfolio": {
    "return": {
      "assignable": {
        "return": "boolean",
        "arguments": {}
      },
      "autoUpdatePrices": {
        "return": "boolean",
        "arguments": {}
      },
      "children": {
        "return": [
          {
            "financialProduct": {
              "return": {
                "assignable": {
                  "return": "boolean",
                  "arguments": {}
                },
                "autoUpdatePrices": {
                  "return": "boolean",
                  "arguments": {}
                },
                "children": {
                  "return": [
                    {
                      "financialProduct": {
                        "return": {
                          "assignable": {
                            "return": "boolean",
                            "arguments": {}
                          },
                          "autoUpdatePrices": {
                            "return": "boolean",
                            "arguments": {}
                          },
                          "children": {
                            "return": [
                              {
                                "financialProduct": {
                                  "return": {
                                    "assignable": {
                                      "return": "boolean",
                                      "arguments": {}
                                    },
                                    "autoUpdatePrices": {
                                      "return": "boolean",
                                      "arguments": {}
                                    },
                                    "children": {
                                      "return": [
                                        {
                                          "financialProduct": {
                                            "return": {
                                              "assignable": {
                                                "return": "boolean",
                                                "arguments": {}
                                              },
                                              "autoUpdatePrices": {
                                                "return": "boolean",
                                                "arguments": {}
                                              },
                                              "children": {
                                                "return": [
                                                  {
                                                    "financialProduct": {
                                                      "return": {
                                                        "assignable": {
                                                          "return": "boolean",
                                                          "arguments": {}
                                                        },
                                                        "autoUpdatePrices": {
                                                          "return": "boolean",
                                                          "arguments": {}
                                                        },
                                                        "children": {
                                                          "return": [
                                                            {
                                                              "financialProduct": {
                                                                "return": {
                                                                  "assignable": {
                                                                    "return": "boolean",
                                                                    "arguments": {}
                                                                  },
                                                                  "autoUpdatePrices": {}
                                                                }
                                                              }
                                                            }
                                                          ]
                                                        }
                                                      }
                                                    }
                                                  }
                                                ]
                                              }
                                            }
                                          }
                                        }
                                      ]
                                    }
                                  }
                                }
                              }
                            ]
                          }
                        }
                      }
                    }
                  ]
                }
              }
            }
          }
        ]
      }
    }
  }
}

CreateNoteInput: object

content:
objectId:
objectType:
type:
Example
{
  "content": "object",
  "objectId": "object",
  "objectType": "string",
  "type": "string"
}

CreateNoteResponse: object

note:
object
return:
arguments:
object
Example
{
  "note": {
    "return": {
      "author": {
        "return": {
          "email": {
            "return": "string",
            "arguments": {}
          },
          "firstName": {
            "return": "string",
            "arguments": {}
          },
          "id": {
            "return": "object",
            "arguments": {}
          },
          "language": {
            "return": "string",
            "arguments": {}
          },
          "lastName": {
            "return": "string",
            "arguments": {}
          },
          "organization": {
            "return": {
              "browserTabTitle": {
                "return": "string",
                "arguments": {}
              },
              "faviconLink": {
                "return": "string",
                "arguments": {}
              },
              "id": {
                "return": "object",
                "arguments": {}
              },
              "name": {
                "return": "string",
                "arguments": {}
              },
              "parent": {
                "return": {
                  "browserTabTitle": {
                    "return": "string",
                    "arguments": {}
                  },
                  "faviconLink": {
                    "return": "string",
                    "arguments": {}
                  },
                  "id": {
                    "return": "object",
                    "arguments": {}
                  },
                  "name": {
                    "return": "string",
                    "arguments": {}
                  },
                  "parent": {
                    "return": {
                      "browserTabTitle": {
                        "return": "string",
                        "arguments": {}
                      },
                      "faviconLink": {
                        "return": "string",
                        "arguments": {}
                      },
                      "id": {
                        "return": "object",
                        "arguments": {}
                      },
                      "name": {
                        "return": "string",
                        "arguments": {}
                      },
                      "parent": {
                        "return": {
                          "browserTabTitle": {
                            "return": "string",
                            "arguments": {}
                          },
                          "faviconLink": {
                            "return": "string",
                            "arguments": {}
                          },
                          "id": {
                            "return": "object",
                            "arguments": {}
                          },
                          "name": {}
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

CreateNotificationDefinitionInput: object

bodyTemplate:
linkTemplate:
linkText:
name:
notificationGroupId:
organizationId:
organizationOnly:
roleProfileIds:
ObjectID
titleTemplate:
triggerEventType:
triggerObjectType:
Example
{
  "bodyTemplate": {
    "en": "object",
    "fr": "object"
  },
  "linkTemplate": "object",
  "linkText": {
    "en": "object",
    "fr": "object"
  },
  "name": "object",
  "notificationGroupId": "object",
  "organizationId": "object",
  "organizationOnly": "boolean",
  "roleProfileIds": [
    "object"
  ],
  "titleTemplate": {
    "en": "object",
    "fr": "object"
  },
  "triggerEventType": "string",
  "triggerObjectType": "string"
}

CreateNotificationGroupInput: object

name:
organizationId:
Example
{
  "name": {
    "en": "object",
    "fr": "object"
  },
  "organizationId": "object"
}

CreateNotificationGroupResponse: object

notificationGroup:
object
return:
arguments:
object
Example
{
  "notificationGroup": {
    "return": {
      "id": {
        "return": "object",
        "arguments": {}
      },
      "name": {
        "return": {
          "en": {
            "return": "string",
            "arguments": {}
          },
          "fr": {
            "return": "string",
            "arguments": {}
          }
        },
        "arguments": {}
      }
    },
    "arguments": {}
  }
}

CreateNotificationInput: object

body:
link:
linkText:
notificationGroupId:
organizationUserId:
title:
Example
{
  "body": {
    "en": "object",
    "fr": "object"
  },
  "link": "object",
  "linkText": {
    "en": "object",
    "fr": "object"
  },
  "notificationGroupId": "object",
  "organizationUserId": "object",
  "title": {
    "en": "object",
    "fr": "object"
  }
}

CreateNotificationResponse: object

notification:
object
return:
arguments:
object
Example
{
  "notification": {
    "return": {
      "body": {
        "return": {
          "en": {
            "return": "string",
            "arguments": {}
          },
          "fr": {
            "return": "string",
            "arguments": {}
          }
        },
        "arguments": {}
      },
      "createdAt": {
        "return": "object",
        "arguments": {}
      },
      "id": {
        "return": "object",
        "arguments": {}
      },
      "link": {
        "return": "object",
        "arguments": {}
      },
      "linkText": {
        "return": {
          "en": {
            "return": "string",
            "arguments": {}
          },
          "fr": {
            "return": "string",
            "arguments": {}
          }
        },
        "arguments": {}
      },
      "notificationGroup": {
        "return": {
          "id": {
            "return": "object",
            "arguments": {}
          },
          "name": {
            "return": {
              "en": {
                "return": "string",
                "arguments": {}
              },
              "fr": {
                "return": "string",
                "arguments": {}
              }
            },
            "arguments": {}
          }
        },
        "arguments": {}
      },
      "organizationUser": {
        "return": {
          "accessType": {
            "return": "string",
            "arguments": {}
          },
          "apiTokens": {
            "return": [
              {
                "id": {
                  "return": "object",
                  "arguments": {}
                },
                "jwtToken": {
                  "return": "string",
                  "arguments": {}
                },
                "name": {
                  "return": "string",
                  "arguments": {}
                },
                "organization": {
                  "return": {
                    "browserTabTitle": {
                      "return": "string",
                      "arguments": {}
                    },
                    "faviconLink": {
                      "return": "string",
                      "arguments": {}
                    },
                    "id": {
                      "return": "object",
                      "arguments": {}
                    },
                    "name": {}
                  }
                }
              }
            ]
          }
        }
      }
    }
  }
}

CreateOrganizationDashboardInput: object

name:
organizationId:
widgets:
WidgetInputType
Example
{
  "name": "string",
  "organizationId": "object",
  "widgets": [
    {
      "columns": [
        "string"
      ],
      "filters": [
        {
          "comparison": "string",
          "field": "string",
          "value": "string"
        }
      ],
      "format": "string",
      "grouping": {
        "field": "string",
        "interval": "string",
        "type": "string",
        "valueAggregation": "string",
        "valueField": "string"
      },
      "height": "number",
      "reportType": "string",
      "sortDesc": "boolean",
      "sortField": "string",
      "title": "string",
      "type": "string",
      "width": "number",
      "x": "number",
      "y": "number"
    }
  ]
}

CreateOrganizationDashboardResponse: object

dashboard:
object
return:
arguments:
object
Example
{
  "dashboard": {
    "return": {
      "archived": {
        "return": "boolean",
        "arguments": {}
      },
      "id": {
        "return": "object",
        "arguments": {}
      },
      "name": {
        "return": "string",
        "arguments": {}
      },
      "organization": {
        "return": {
          "browserTabTitle": {
            "return": "string",
            "arguments": {}
          },
          "faviconLink": {
            "return": "string",
            "arguments": {}
          },
          "id": {
            "return": "object",
            "arguments": {}
          },
          "name": {
            "return": "string",
            "arguments": {}
          },
          "parent": {
            "return": {
              "browserTabTitle": {
                "return": "string",
                "arguments": {}
              },
              "faviconLink": {
                "return": "string",
                "arguments": {}
              },
              "id": {
                "return": "object",
                "arguments": {}
              },
              "name": {
                "return": "string",
                "arguments": {}
              },
              "parent": {
                "return": {
                  "browserTabTitle": {
                    "return": "string",
                    "arguments": {}
                  },
                  "faviconLink": {
                    "return": "string",
                    "arguments": {}
                  },
                  "id": {
                    "return": "object",
                    "arguments": {}
                  },
                  "name": {
                    "return": "string",
                    "arguments": {}
                  },
                  "parent": {
                    "return": {
                      "browserTabTitle": {
                        "return": "string",
                        "arguments": {}
                      },
                      "faviconLink": {
                        "return": "string",
                        "arguments": {}
                      },
                      "id": {
                        "return": "object",
                        "arguments": {}
                      },
                      "name": {
                        "return": "string",
                        "arguments": {}
                      },
                      "parent": {
                        "return": {
                          "browserTabTitle": {
                            "return": "string",
                            "arguments": {}
                          },
                          "faviconLink": {}
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

CreateOrganizationInput: object

accountTypeTaxRanks:
AccountTypeTaxRankInput
allowAccessToSubOrganizations:
allowDirectCommunication:
allowInstantInvest:
allowPostOptimizationEditing:
autoInviteImportedUsers:
blockSuspiciousTransactions:
browserTabTitle:
cashOnHoldToTradeDays:
Int
cashOnHoldToWithdrawDays:
Int
databaseAuthConnectionId:
databaseAuthConnectionName:
defaultAuthenticationConnection:
defaultTradingProcess:
displayCurrency:
displayMenuBar:
enableMultiFactorAuthentication:
entityName:
excludeAdminFeesFromClients:
externalClientTokenEmailKey:
faviconLink:
helpCentreUrl:
includeExternalClientTokenIntoContext:
isReferral:
jurisdictions:
jwtKeyUrl:
localizationId:
minInitialDepositCents:
Int
minInvestAmountCents:
Int
minRecurringDepositCents:
Int
name:
parentId:
permissions:
SafeString
profileReviewTimeInMonths:
Int
repCode:
requireManualAccountApproval:
revenueShareBps:
revenueShareTaxes:
reviewTransactions:
subdomain:
supportUrl:
theme:
themeTokens:
tokenExchangeValidationType:
useClientOrgAuth0:
useParentArticles:
useParentAssetClasses:
useParentBillingSchedules:
useParentClientReportTemplates:
useParentCustodianConnections:
useParentCustomFields:
useParentDashboards:
useParentFeeTiers:
useParentFormTemplates:
useParentIntegrations:
useParentLocalizations:
useParentModelPortfolios:
useParentNotificationDefinitions:
useParentNotificationGroups:
useParentPageConfigurations:
useParentProductShelf:
useParentRoleProfiles:
useParentSchedules:
useParentThemeTokens:
useParentThemes:
useParentWorkflows:
userManagementFeeBps:
validateUniquenessForSubOrganizations:
Example
{
  "accountTypeTaxRanks": [
    {
      "accountType": "string",
      "taxRank": "number"
    }
  ],
  "allowAccessToSubOrganizations": "boolean",
  "allowDirectCommunication": "boolean",
  "allowInstantInvest": "boolean",
  "allowPostOptimizationEditing": "boolean",
  "autoInviteImportedUsers": "boolean",
  "blockSuspiciousTransactions": "boolean",
  "browserTabTitle": "string",
  "cashOnHoldToTradeDays": "number",
  "cashOnHoldToWithdrawDays": "number",
  "databaseAuthConnectionId": "object",
  "databaseAuthConnectionName": "object",
  "defaultAuthenticationConnection": "string",
  "defaultTradingProcess": "string",
  "displayCurrency": "boolean",
  "displayMenuBar": "boolean",
  "enableMultiFactorAuthentication": "boolean",
  "entityName": "object",
  "excludeAdminFeesFromClients": "boolean",
  "externalClientTokenEmailKey": "object",
  "faviconLink": "string",
  "helpCentreUrl": "object",
  "includeExternalClientTokenIntoContext": "boolean",
  "isReferral": "boolean",
  "jurisdictions": {
    "all": "boolean",
    "only": [
      "string"
    ]
  },
  "jwtKeyUrl": "object",
  "localizationId": "object",
  "minInitialDepositCents": "number",
  "minInvestAmountCents": "number",
  "minRecurringDepositCents": "number",
  "name": "object",
  "parentId": "object",
  "permissions": [
    "object"
  ],
  "profileReviewTimeInMonths": "number",
  "repCode": "object",
  "requireManualAccountApproval": "boolean",
  "revenueShareBps": "number",
  "revenueShareTaxes": "number",
  "reviewTransactions": "boolean",
  "subdomain": "object",
  "supportUrl": "object",
  "theme": {
    "authenticationTheme": {
      "logo": "object"
    }
  }
}

CreateOrganizationResponse: object

organization:
object
return:
arguments:
object
Example
{
  "organization": {
    "return": {
      "accountTypeTaxRanks": {
        "return": [
          {
            "accountType": {
              "return": "string",
              "arguments": {}
            },
            "id": {
              "return": "object",
              "arguments": {}
            },
            "taxRank": {
              "return": "number",
              "arguments": {}
            }
          }
        ],
        "arguments": {}
      },
      "allowAccessToSubOrganizations": {
        "return": "boolean",
        "arguments": {}
      },
      "allowDirectCommunication": {
        "return": "boolean",
        "arguments": {}
      },
      "allowInactiveUserAdjustments": {
        "return": "boolean",
        "arguments": {}
      },
      "allowInactiveUserFeeCalculation": {
        "return": "boolean",
        "arguments": {}
      },
      "allowInactiveUserRebalancing": {
        "return": "boolean",
        "arguments": {}
      },
      "allowInstantInvest": {
        "return": "boolean",
        "arguments": {}
      },
      "allowPortfolioPerGoal": {
        "return": "boolean",
        "arguments": {}
      },
      "allowPostOptimizationEditing": {
        "return": "boolean",
        "arguments": {}
      },
      "allowViewSubTradeRequestPairs": {
        "return": "boolean",
        "arguments": {}
      },
      "applicableJurisdictions": {
        "return": {
          "all": {
            "return": "boolean",
            "arguments": {}
          },
          "only": {
            "return": [
              "string"
            ],
            "arguments": {}
          }
        },
        "arguments": {}
      },
      "applicableLocalization": {
        "return": {
          "countries": {
            "return": [
              "string"
            ],
            "arguments": {}
          },
          "dateFormat": {
            "return": "string",
            "arguments": {}
          },
          "defaultCurrency": {
            "return": "string",
            "arguments": {}
          },
          "defaultLanguage": {
            "return": "string",
            "arguments": {}
          },
          "id": {
            "return": "object",
            "arguments": {}
          },
          "languages": {
            "return": [
              "string"
            ],
            "arguments": {}
          },
          "name": {}
        }
      }
    }
  }
}

CreateOrganizationUserInput: object

accessType:
autoInviteUser:

Automatically sends invitation to the new user (Default to true)

avatar:
email:
entities:
OrganizationUserEntityInput
firstName:
language:
lastName:
organizationId:
phone:
roleId:
Example
{
  "accessType": "string",
  "autoInviteUser": "boolean",
  "avatar": "object",
  "email": "object",
  "entities": [
    {
      "entityId": "object",
      "readOnly": "boolean"
    }
  ],
  "firstName": "object",
  "language": "string",
  "lastName": "object",
  "organizationId": "object",
  "phone": "object",
  "roleId": "object"
}

CreateOrganizationUserResponse: object

organizationUser:
object
return:
arguments:
object
Example
{
  "organizationUser": {
    "return": {
      "accessType": {
        "return": "string",
        "arguments": {}
      },
      "apiTokens": {
        "return": [
          {
            "id": {
              "return": "object",
              "arguments": {}
            },
            "jwtToken": {
              "return": "string",
              "arguments": {}
            },
            "name": {
              "return": "string",
              "arguments": {}
            },
            "organization": {
              "return": {
                "browserTabTitle": {
                  "return": "string",
                  "arguments": {}
                },
                "faviconLink": {
                  "return": "string",
                  "arguments": {}
                },
                "id": {
                  "return": "object",
                  "arguments": {}
                },
                "name": {
                  "return": "string",
                  "arguments": {}
                },
                "parent": {
                  "return": {
                    "browserTabTitle": {
                      "return": "string",
                      "arguments": {}
                    },
                    "faviconLink": {
                      "return": "string",
                      "arguments": {}
                    },
                    "id": {
                      "return": "object",
                      "arguments": {}
                    },
                    "name": {
                      "return": "string",
                      "arguments": {}
                    },
                    "parent": {
                      "return": {
                        "browserTabTitle": {
                          "return": "string",
                          "arguments": {}
                        },
                        "faviconLink": {
                          "return": "string",
                          "arguments": {}
                        },
                        "id": {
                          "return": "object",
                          "arguments": {}
                        },
                        "name": {
                          "return": "string",
                          "arguments": {}
                        },
                        "parent": {
                          "return": {
                            "browserTabTitle": {
                              "return": "string",
                              "arguments": {}
                            },
                            "faviconLink": {
                              "return": "string",
                              "arguments": {}
                            },
                            "id": {
                              "return": "object",
                              "arguments": {}
                            },
                            "name": {
                              "return": "string",
                              "arguments": {}
                            }
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        ]
      }
    }
  }
}

CreatePageConfigurationInput: object

name:
options:
organizationId:
tabs:
TabConfigurationInput
type:
Example
{
  "name": "string",
  "options": "object",
  "organizationId": "object",
  "tabs": [
    {
      "icon": "string",
      "label": {
        "en": "object",
        "fr": "object"
      },
      "url": "string",
      "widgets": [
        {
          "options": "object",
          "type": "string"
        }
      ]
    }
  ],
  "type": "string"
}

CreatePageConfigurationResponse: object

pageConfiguration:
object
return:
arguments:
object
Example
{
  "pageConfiguration": {
    "return": {
      "createdAt": {
        "return": "object",
        "arguments": {}
      },
      "id": {
        "return": "object",
        "arguments": {}
      },
      "name": {
        "return": "string",
        "arguments": {}
      },
      "options": {
        "return": "object",
        "arguments": {}
      },
      "organization": {
        "return": {
          "accountTypeTaxRanks": {
            "return": [
              {
                "accountType": {
                  "return": "string",
                  "arguments": {}
                },
                "id": {
                  "return": "object",
                  "arguments": {}
                },
                "taxRank": {
                  "return": "number",
                  "arguments": {}
                }
              }
            ],
            "arguments": {}
          },
          "allowAccessToSubOrganizations": {
            "return": "boolean",
            "arguments": {}
          },
          "allowDirectCommunication": {
            "return": "boolean",
            "arguments": {}
          },
          "allowInactiveUserAdjustments": {
            "return": "boolean",
            "arguments": {}
          },
          "allowInactiveUserFeeCalculation": {
            "return": "boolean",
            "arguments": {}
          },
          "allowInactiveUserRebalancing": {
            "return": "boolean",
            "arguments": {}
          },
          "allowInstantInvest": {
            "return": "boolean",
            "arguments": {}
          },
          "allowPortfolioPerGoal": {
            "return": "boolean",
            "arguments": {}
          },
          "allowPostOptimizationEditing": {
            "return": "boolean",
            "arguments": {}
          },
          "allowViewSubTradeRequestPairs": {
            "return": "boolean",
            "arguments": {}
          },
          "applicableJurisdictions": {
            "return": {
              "all": {
                "return": "boolean",
                "arguments": {}
              },
              "only": {
                "return": [
                  "string"
                ],
                "arguments": {}
              }
            },
            "arguments": {}
          },
          "applicableLocalization": {
            "return": {
              "countries": {
                "return": [
                  "string"
                ],
                "arguments": {}
              },
              "dateFormat": {
                "return": "string"
              }
            }
          }
        }
      }
    }
  }
}

CreateReportInput: object

accessType:
columns:
SafeString
filters:
ReportFilterInput
name:
organizationId:
sortDesc:
sortField:
type:
Example
{
  "accessType": "string",
  "columns": [
    "object"
  ],
  "filters": [
    {
      "comparison": "string",
      "field": "string",
      "value": "string"
    }
  ],
  "name": "object",
  "organizationId": "object",
  "sortDesc": "boolean",
  "sortField": "object",
  "type": "string"
}

CreateReportResponse: object

report:
object
return:
arguments:
object
Example
{
  "report": {
    "return": {
      "accessType": {
        "return": "string",
        "arguments": {}
      },
      "author": {
        "return": {
          "email": {
            "return": "string",
            "arguments": {}
          },
          "firstName": {
            "return": "string",
            "arguments": {}
          },
          "id": {
            "return": "object",
            "arguments": {}
          },
          "language": {
            "return": "string",
            "arguments": {}
          },
          "lastName": {
            "return": "string",
            "arguments": {}
          },
          "organization": {
            "return": {
              "browserTabTitle": {
                "return": "string",
                "arguments": {}
              },
              "faviconLink": {
                "return": "string",
                "arguments": {}
              },
              "id": {
                "return": "object",
                "arguments": {}
              },
              "name": {
                "return": "string",
                "arguments": {}
              },
              "parent": {
                "return": {
                  "browserTabTitle": {
                    "return": "string",
                    "arguments": {}
                  },
                  "faviconLink": {
                    "return": "string",
                    "arguments": {}
                  },
                  "id": {
                    "return": "object",
                    "arguments": {}
                  },
                  "name": {
                    "return": "string",
                    "arguments": {}
                  },
                  "parent": {
                    "return": {
                      "browserTabTitle": {
                        "return": "string",
                        "arguments": {}
                      },
                      "faviconLink": {
                        "return": "string",
                        "arguments": {}
                      },
                      "id": {
                        "return": "object",
                        "arguments": {}
                      },
                      "name": {
                        "return": "string",
                        "arguments": {}
                      },
                      "parent": {
                        "return": {
                          "browserTabTitle": {
                            "return": "string",
                            "arguments": {}
                          },
                          "faviconLink": {
                            "return": "string",
                            "arguments": {}
                          },
                          "id": {}
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

CreateRestWebhookInput: object

customHeaders:

Any custom headers that may need to be set to be sent with the mutation to the assigned url.

customPayloadAttributes:

Any custom payload that may need to be sent on the body along with the fetched data. If informed, the fetched data will be sent as an object in the 'payload' attribute.

eventType:

The event type on the object that gets actioned to then send off the webhook.

gql:

The graphql query string that would be used to query the OneVest partner gateway usually. The variable of '$id' is used for the actioned object.

objectType:

The type of object you want to listen to, to receive a webhook on.

organizationId:

Organization to which the crated webhook will be linked. If not informed, the organization of the context user will be considered.

signedJwtHeader:

Any custom header through which the signed JWT may need to be sent. If not informed, the signed JWT will be sent in the 'OneVest-Authorization' header.

url:

GraphQL URL in which the webhook will hit.

Example
{
  "customHeaders": "object",
  "customPayloadAttributes": "object",
  "eventType": "string",
  "gql": "string",
  "objectType": "string",
  "organizationId": "object",
  "signedJwtHeader": "string",
  "url": "string"
}

CreateRoleInput: object

accessiblePages:
Pages
accountPageConfigurationId:
dashboards:
SafeString
defaultAuthenticationConnection:
goalPageConfigurationId:
householdPageConfigurationId:
individualPageConfigurationId:
makeHouseholdDefaultView:
navigationStyle:
nonIndividualPageConfigurationId:
organizationId:
permissions:
SafeString
roleProfileId:
subAccountPageConfigurationId:
translatedDescription:
translatedName:
Example
{
  "accessiblePages": [
    "string"
  ],
  "accountPageConfigurationId": "object",
  "dashboards": [
    "object"
  ],
  "defaultAuthenticationConnection": "string",
  "goalPageConfigurationId": "object",
  "householdPageConfigurationId": "object",
  "individualPageConfigurationId": "object",
  "makeHouseholdDefaultView": "boolean",
  "navigationStyle": "string",
  "nonIndividualPageConfigurationId": "object",
  "organizationId": "object",
  "permissions": [
    "object"
  ],
  "roleProfileId": "object",
  "subAccountPageConfigurationId": "object",
  "translatedDescription": {
    "en": "object",
    "fr": "object"
  },
  "translatedName": {
    "en": "object",
    "fr": "object"
  }
}

CreateRoleProfileInput: object

organizationId:
template:
translatedDescription:
translatedName:
Example
{
  "organizationId": "object",
  "template": {
    "accessiblePages": [
      "string"
    ],
    "accountPageConfigurationId": "object",
    "dashboards": [
      "object"
    ],
    "goalPageConfigurationId": "object",
    "householdPageConfigurationId": "object",
    "individualPageConfigurationId": "object",
    "navigationStyle": "string",
    "nonIndividualPageConfigurationId": "object",
    "permissions": [
      "object"
    ],
    "subAccountPageConfigurationId": "object"
  },
  "translatedDescription": {
    "en": "object",
    "fr": "object"
  },
  "translatedName": {
    "en": "object",
    "fr": "object"
  }
}

CreateRoleProfileResponse: object

roleProfile:
object
return:
arguments:
object
Example
{
  "roleProfile": {
    "return": {
      "createdAt": {
        "return": "object",
        "arguments": {}
      },
      "id": {
        "return": "object",
        "arguments": {}
      },
      "organization": {
        "return": {
          "accountTypeTaxRanks": {
            "return": [
              {
                "accountType": {
                  "return": "string",
                  "arguments": {}
                },
                "id": {
                  "return": "object",
                  "arguments": {}
                },
                "taxRank": {
                  "return": "number",
                  "arguments": {}
                }
              }
            ],
            "arguments": {}
          },
          "allowAccessToSubOrganizations": {
            "return": "boolean",
            "arguments": {}
          },
          "allowDirectCommunication": {
            "return": "boolean",
            "arguments": {}
          },
          "allowInactiveUserAdjustments": {
            "return": "boolean",
            "arguments": {}
          },
          "allowInactiveUserFeeCalculation": {
            "return": "boolean",
            "arguments": {}
          },
          "allowInactiveUserRebalancing": {
            "return": "boolean",
            "arguments": {}
          },
          "allowInstantInvest": {
            "return": "boolean",
            "arguments": {}
          },
          "allowPortfolioPerGoal": {
            "return": "boolean",
            "arguments": {}
          },
          "allowPostOptimizationEditing": {
            "return": "boolean",
            "arguments": {}
          },
          "allowViewSubTradeRequestPairs": {
            "return": "boolean",
            "arguments": {}
          },
          "applicableJurisdictions": {
            "return": {
              "all": {
                "return": "boolean",
                "arguments": {}
              },
              "only": {
                "return": [
                  "string"
                ],
                "arguments": {}
              }
            },
            "arguments": {}
          },
          "applicableLocalization": {
            "return": {
              "countries": {
                "return": [
                  "string"
                ],
                "arguments": {}
              },
              "dateFormat": {
                "return": "string",
                "arguments": {}
              },
              "defaultCurrency": {
                "return": "string",
                "arguments": {}
              },
              "defaultLanguage": {
                "return": "string"
              }
            }
          }
        }
      }
    }
  }
}

CreateRoleResponse: object

role:
object
return:
arguments:
object
Example
{
  "role": {
    "return": {
      "accessiblePages": {
        "return": [
          "string"
        ],
        "arguments": {}
      },
      "accountPageConfiguration": {
        "return": {
          "createdAt": {
            "return": "object",
            "arguments": {}
          },
          "id": {
            "return": "object",
            "arguments": {}
          },
          "name": {
            "return": "string",
            "arguments": {}
          },
          "options": {
            "return": "object",
            "arguments": {}
          },
          "organization": {
            "return": {
              "accountTypeTaxRanks": {
                "return": [
                  {
                    "accountType": {
                      "return": "string",
                      "arguments": {}
                    },
                    "id": {
                      "return": "object",
                      "arguments": {}
                    },
                    "taxRank": {
                      "return": "number",
                      "arguments": {}
                    }
                  }
                ],
                "arguments": {}
              },
              "allowAccessToSubOrganizations": {
                "return": "boolean",
                "arguments": {}
              },
              "allowDirectCommunication": {
                "return": "boolean",
                "arguments": {}
              },
              "allowInactiveUserAdjustments": {
                "return": "boolean",
                "arguments": {}
              },
              "allowInactiveUserFeeCalculation": {
                "return": "boolean",
                "arguments": {}
              },
              "allowInactiveUserRebalancing": {
                "return": "boolean",
                "arguments": {}
              },
              "allowInstantInvest": {
                "return": "boolean",
                "arguments": {}
              },
              "allowPortfolioPerGoal": {
                "return": "boolean",
                "arguments": {}
              },
              "allowPostOptimizationEditing": {
                "return": "boolean",
                "arguments": {}
              },
              "allowViewSubTradeRequestPairs": {
                "return": "boolean",
                "arguments": {}
              },
              "applicableJurisdictions": {
                "return": {
                  "all": {
                    "return": "boolean",
                    "arguments": {}
                  },
                  "only": {
                    "return": [
                      "string"
                    ],
                    "arguments": {}
                  }
                },
                "arguments": {}
              },
              "applicableLocalization": {
                "return": {}
              }
            }
          }
        }
      }
    }
  }
}

CreateScheduleInput: object

dates:
Date
name:
organizationId:
Example
{
  "dates": [
    "object"
  ],
  "name": "object",
  "organizationId": "object"
}

CreateScheduleResponse: object

schedule:
object
return:
arguments:
object
Example
{
  "schedule": {
    "return": {
      "associatedFinancialProductsCount": {
        "return": "number",
        "arguments": {}
      },
      "dates": {
        "return": [
          "object"
        ],
        "arguments": {}
      },
      "id": {
        "return": "object",
        "arguments": {}
      },
      "name": {
        "return": "string",
        "arguments": {}
      },
      "nextDate": {
        "return": "object",
        "arguments": {}
      },
      "organization": {
        "return": {
          "browserTabTitle": {
            "return": "string",
            "arguments": {}
          },
          "faviconLink": {
            "return": "string",
            "arguments": {}
          },
          "id": {
            "return": "object",
            "arguments": {}
          },
          "name": {
            "return": "string",
            "arguments": {}
          },
          "parent": {
            "return": {
              "browserTabTitle": {
                "return": "string",
                "arguments": {}
              },
              "faviconLink": {
                "return": "string",
                "arguments": {}
              },
              "id": {
                "return": "object",
                "arguments": {}
              },
              "name": {
                "return": "string",
                "arguments": {}
              },
              "parent": {
                "return": {
                  "browserTabTitle": {
                    "return": "string",
                    "arguments": {}
                  },
                  "faviconLink": {
                    "return": "string",
                    "arguments": {}
                  },
                  "id": {
                    "return": "object",
                    "arguments": {}
                  },
                  "name": {
                    "return": "string",
                    "arguments": {}
                  },
                  "parent": {
                    "return": {
                      "browserTabTitle": {
                        "return": "string",
                        "arguments": {}
                      },
                      "faviconLink": {
                        "return": "string",
                        "arguments": {}
                      },
                      "id": {
                        "return": "object",
                        "arguments": {}
                      },
                      "name": {
                        "return": "string"
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

CreateScheduledDepositTransferInput: object

amountCents:
bankAccountId:
currency:
endDate:
frequency:
instantInvest:

instantInvest skips the holding period before the amount is invested Only available to partners with the certainty of deposits that do not bounce

requestId:
scheduledDate:
subAccountId:
Example
{
  "amountCents": "object",
  "bankAccountId": "object",
  "currency": "string",
  "endDate": "object",
  "frequency": "string",
  "instantInvest": "boolean",
  "requestId": "object",
  "scheduledDate": "object",
  "subAccountId": "object"
}

CreateScheduledIncomeFundTransferInput: object

amountPayableType:
annualAmountCents:
bankAccountId:
currency:
dateOfBirth:
frequency:
scheduledDate:
specialTaxRate:
subAccountId:
taxOption:
transferredAmountCents:
Example
{
  "amountPayableType": "string",
  "annualAmountCents": "object",
  "bankAccountId": "object",
  "currency": "string",
  "dateOfBirth": "object",
  "frequency": "string",
  "scheduledDate": "object",
  "specialTaxRate": "number",
  "subAccountId": "object",
  "taxOption": "string",
  "transferredAmountCents": "object"
}

CreateScheduledIncomeFundTransferResponse: object

scheduledIncomeFundTransfer:
object
return:
arguments:
object
Example
{
  "scheduledIncomeFundTransfer": {
    "return": {
      "amountPayableType": {
        "return": "string",
        "arguments": {}
      },
      "annualAmountCents": {
        "return": "object",
        "arguments": {}
      },
      "bankAccount": {
        "return": {
          "EftEligibleRatio": {
            "return": "number",
            "arguments": {}
          },
          "bankAccountNumber": {
            "return": "string",
            "arguments": {}
          },
          "bankAccountNumberDisclosed": {
            "return": "string",
            "arguments": {}
          },
          "createdAt": {
            "return": "object",
            "arguments": {}
          },
          "downloadUrls": {
            "return": [
              "string"
            ],
            "arguments": {}
          },
          "id": {
            "return": "object",
            "arguments": {}
          },
          "institutionNumber": {
            "return": "string",
            "arguments": {}
          },
          "name": {
            "return": "string",
            "arguments": {}
          },
          "source": {
            "return": "string",
            "arguments": {}
          },
          "state": {
            "return": "string",
            "arguments": {}
          },
          "stateChanges": {
            "return": [
              "object"
            ],
            "arguments": {}
          },
          "transitNumber": {
            "return": "string",
            "arguments": {}
          },
          "transitNumberDisclosed": {
            "return": "string",
            "arguments": {}
          },
          "updatedAt": {
            "return": "object",
            "arguments": {}
          },
          "user": {
            "return": {
              "accessibleBy": {
                "return": [
                  {
                    "displayOptions": {
                      "return": {
                        "hide": {
                          "return": "boolean",
                          "arguments": {}
                        },
                        "order": {
                          "return": "number",
                          "arguments": {}
                        }
                      },
                      "arguments": {}
                    },
                    "organizationUser": {
                      "return": {
                        "accessType": {
                          "return": "string",
                          "arguments": {}
                        },
                        "apiTokens": {}
                      }
                    }
                  }
                ]
              }
            }
          }
        }
      }
    }
  }
}

CreateScheduledTransferBetweenSubAccountsInput: object

amountCents:
Int
frequency:
fromSubAccountId:
scheduledDate:
toSubAccountId:
transferAll:
Example
{
  "amountCents": "number",
  "frequency": "string",
  "fromSubAccountId": "object",
  "scheduledDate": "object",
  "toSubAccountId": "object",
  "transferAll": "boolean"
}

CreateScheduledTransferResponse: object

scheduledTransfer:
object
return:
arguments:
object
Example
{
  "scheduledTransfer": {
    "return": {
      "amountCents": {
        "return": "object",
        "arguments": {}
      },
      "bankAccount": {
        "return": {
          "EftEligibleRatio": {
            "return": "number",
            "arguments": {}
          },
          "bankAccountNumber": {
            "return": "string",
            "arguments": {}
          },
          "bankAccountNumberDisclosed": {
            "return": "string",
            "arguments": {}
          },
          "createdAt": {
            "return": "object",
            "arguments": {}
          },
          "downloadUrls": {
            "return": [
              "string"
            ],
            "arguments": {}
          },
          "id": {
            "return": "object",
            "arguments": {}
          },
          "institutionNumber": {
            "return": "string",
            "arguments": {}
          },
          "name": {
            "return": "string",
            "arguments": {}
          },
          "source": {
            "return": "string",
            "arguments": {}
          },
          "state": {
            "return": "string",
            "arguments": {}
          },
          "stateChanges": {
            "return": [
              "object"
            ],
            "arguments": {}
          },
          "transitNumber": {
            "return": "string",
            "arguments": {}
          },
          "transitNumberDisclosed": {
            "return": "string",
            "arguments": {}
          },
          "updatedAt": {
            "return": "object",
            "arguments": {}
          },
          "user": {
            "return": {
              "accessibleBy": {
                "return": [
                  {
                    "displayOptions": {
                      "return": {
                        "hide": {
                          "return": "boolean",
                          "arguments": {}
                        },
                        "order": {
                          "return": "number",
                          "arguments": {}
                        }
                      },
                      "arguments": {}
                    },
                    "organizationUser": {
                      "return": {
                        "accessType": {
                          "return": "string",
                          "arguments": {}
                        },
                        "apiTokens": {
                          "return": [
                            {
                              "id": {}
                            }
                          ]
                        }
                      }
                    }
                  }
                ]
              }
            }
          }
        }
      }
    }
  }
}

CreateScheduledWithdrawTransferInput: object

amountCents:
bankAccountId:
currency:
endDate:
frequency:
requestId:
scheduledDate:
subAccountId:
withdrawalReason:
withdrawalReasonDescription:
Example
{
  "amountCents": "object",
  "bankAccountId": "object",
  "currency": "string",
  "endDate": "object",
  "frequency": "string",
  "requestId": "object",
  "scheduledDate": "object",
  "subAccountId": "object",
  "withdrawalReason": "string",
  "withdrawalReasonDescription": "object"
}

CreateSftpCredentialsInput: object

sftpInBucket:
sftpInDownloadFile:
sftpInHost:
sftpInPassword:
sftpInPort:
sftpInServerHostKey:
String
sftpInSourceDir:
sftpInTargetPrefix:
sftpInUsername:
sftpOutBucket:
sftpOutHost:
sftpOutPassword:
sftpOutPort:
sftpOutServerHostKey:
String
sftpOutTargetDir:
sftpOutUsername:
Example
{
  "sftpInBucket": "string",
  "sftpInDownloadFile": "boolean",
  "sftpInHost": "string",
  "sftpInPassword": "string",
  "sftpInPort": "string",
  "sftpInServerHostKey": [
    "string"
  ],
  "sftpInSourceDir": "string",
  "sftpInTargetPrefix": "string",
  "sftpInUsername": "string",
  "sftpOutBucket": "string",
  "sftpOutHost": "string",
  "sftpOutPassword": "string",
  "sftpOutPort": "string",
  "sftpOutServerHostKey": [
    "string"
  ],
  "sftpOutTargetDir": "string",
  "sftpOutUsername": "string"
}

CreateStepInput: object

name:
subSteps:
CreateSubStepInput
Example
{
  "name": {
    "en": "object",
    "fr": "object"
  },
  "subSteps": [
    {
      "canGoBack": "boolean",
      "completeableBy": [
        "string"
      ],
      "options": "object",
      "rolesCompleteableBy": [
        "object"
      ],
      "skippable": "boolean",
      "type": "string"
    }
  ]
}

CreateSubAccountInput: object

accountId:
accountType:
allowClientDeposits:
billingScheduleId:
feeTierId:
financialProductId:
goalId:
isPartial:
lastUpdatedBy:
name:
requestId:
scheduleId:

Deprecated. Schedule will be inherited from given FinancialProduct

skipIPS:
themeId:
userId:
Example
{
  "accountId": "object",
  "accountType": "string",
  "allowClientDeposits": "boolean",
  "billingScheduleId": "object",
  "feeTierId": "object",
  "financialProductId": "object",
  "goalId": "object",
  "isPartial": "boolean",
  "lastUpdatedBy": "object",
  "name": "object",
  "requestId": "object",
  "scheduleId": "object",
  "skipIPS": "boolean",
  "themeId": "object",
  "userId": "object"
}

CreateSubAccountResponse: object

subAccount:
object
return:
arguments:
object
Example
{
  "subAccount": {
    "return": {
      "acceptableFinancialProduct": {
        "return": "boolean",
        "arguments": {}
      },
      "account": {
        "return": {
          "affiliations": {
            "return": [
              {
                "allocation": {
                  "return": "number",
                  "arguments": {}
                },
                "id": {
                  "return": "object",
                  "arguments": {}
                },
                "relation": {
                  "return": "string",
                  "arguments": {}
                },
                "signatureRequired": {
                  "return": "boolean",
                  "arguments": {}
                },
                "type": {
                  "return": "string",
                  "arguments": {}
                },
                "user": {
                  "return": {
                    "accessibleBy": {
                      "return": [
                        {
                          "displayOptions": {
                            "return": {
                              "hide": {
                                "return": "boolean",
                                "arguments": {}
                              },
                              "order": {
                                "return": "number",
                                "arguments": {}
                              }
                            },
                            "arguments": {}
                          },
                          "organizationUser": {
                            "return": {
                              "accessType": {
                                "return": "string",
                                "arguments": {}
                              },
                              "apiTokens": {
                                "return": [
                                  {
                                    "id": {
                                      "return": "object",
                                      "arguments": {}
                                    },
                                    "jwtToken": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "name": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "organization": {
                                      "return": {
                                        "browserTabTitle": {
                                          "return": "string",
                                          "arguments": {}
                                        },
                                        "faviconLink": {
                                          "return": "string",
                                          "arguments": {}
                                        },
                                        "id": {
                                          "return": "object",
                                          "arguments": {}
                                        },
                                        "name": {
                                          "return": "string",
                                          "arguments": {}
                                        },
                                        "parent": {
                                          "return": {
                                            "browserTabTitle": {}
                                          }
                                        }
                                      }
                                    }
                                  }
                                ]
                              }
                            }
                          }
                        }
                      ]
                    }
                  }
                }
              }
            ]
          }
        }
      }
    }
  }
}

CreateSubStepInput: object

canGoBack:
completeableBy:
SubStepCompleteableBys
options:
rolesCompleteableBy:
ObjectID
skippable:
type:
Example
{
  "canGoBack": "boolean",
  "completeableBy": [
    "string"
  ],
  "options": "object",
  "rolesCompleteableBy": [
    "object"
  ],
  "skippable": "boolean",
  "type": "string"
}

CreateSubTradeRequestInput: object

actualQuantity:
actualTradePriceCents:
bulkTradeRequestId:
expectedQuantity:
expectedTradePriceCents:
financialProductId:
isSellAll:
maxQuantity:
moneyAllocatedCents:
subAccountId:
type:
Example
{
  "actualQuantity": "number",
  "actualTradePriceCents": "number",
  "bulkTradeRequestId": "object",
  "expectedQuantity": "number",
  "expectedTradePriceCents": "number",
  "financialProductId": "object",
  "isSellAll": "boolean",
  "maxQuantity": "number",
  "moneyAllocatedCents": "number",
  "subAccountId": "object",
  "type": "string"
}

CreateSubTradeRequestInputV2: object

actualQuantity:
actualTradePriceCents:
expectedQuantity:
expectedTradePriceCents:
financialProductId:
isSellAll:
maxQuantity:
moneyAllocatedCents:
sourceId:
subAccountId:
type:
Example
{
  "actualQuantity": "number",
  "actualTradePriceCents": "number",
  "expectedQuantity": "number",
  "expectedTradePriceCents": "number",
  "financialProductId": "object",
  "isSellAll": "boolean",
  "maxQuantity": "number",
  "moneyAllocatedCents": "number",
  "sourceId": "object",
  "subAccountId": "object",
  "type": "string"
}

CreateSubTradeRequestResponse: object

subTradeRequest:
object
return:
arguments:
object
Example
{
  "subTradeRequest": {
    "return": {
      "account": {
        "return": {
          "affiliations": {
            "return": [
              {
                "allocation": {
                  "return": "number",
                  "arguments": {}
                },
                "id": {
                  "return": "object",
                  "arguments": {}
                },
                "relation": {
                  "return": "string",
                  "arguments": {}
                },
                "signatureRequired": {
                  "return": "boolean",
                  "arguments": {}
                },
                "type": {
                  "return": "string",
                  "arguments": {}
                },
                "user": {
                  "return": {
                    "accessibleBy": {
                      "return": [
                        {
                          "displayOptions": {
                            "return": {
                              "hide": {
                                "return": "boolean",
                                "arguments": {}
                              },
                              "order": {
                                "return": "number",
                                "arguments": {}
                              }
                            },
                            "arguments": {}
                          },
                          "organizationUser": {
                            "return": {
                              "accessType": {
                                "return": "string",
                                "arguments": {}
                              },
                              "apiTokens": {
                                "return": [
                                  {
                                    "id": {
                                      "return": "object",
                                      "arguments": {}
                                    },
                                    "jwtToken": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "name": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "organization": {
                                      "return": {
                                        "browserTabTitle": {
                                          "return": "string",
                                          "arguments": {}
                                        },
                                        "faviconLink": {
                                          "return": "string",
                                          "arguments": {}
                                        },
                                        "id": {
                                          "return": "object",
                                          "arguments": {}
                                        },
                                        "name": {
                                          "return": "string",
                                          "arguments": {}
                                        },
                                        "parent": {
                                          "return": {
                                            "browserTabTitle": {
                                              "return": "string",
                                              "arguments": {}
                                            },
                                            "faviconLink": {}
                                          }
                                        }
                                      }
                                    }
                                  }
                                ]
                              }
                            }
                          }
                        }
                      ]
                    }
                  }
                }
              }
            ]
          }
        }
      }
    }
  }
}

CreateSubTradeRequestsInput: object

bulkTradeRequestId:
subTradeRequests:
CreateSubTradeRequestInputV2
Example
{
  "bulkTradeRequestId": "object",
  "subTradeRequests": [
    {
      "actualQuantity": "number",
      "actualTradePriceCents": "number",
      "expectedQuantity": "number",
      "expectedTradePriceCents": "number",
      "financialProductId": "object",
      "isSellAll": "boolean",
      "maxQuantity": "number",
      "moneyAllocatedCents": "number",
      "sourceId": "object",
      "subAccountId": "object",
      "type": "string"
    }
  ]
}

CreateThemeInput: object

core:
iconKey:
key:
organizationId:
translatedDescription:
translatedName:
translatedShortDescription:
Example
{
  "core": "boolean",
  "iconKey": "object",
  "key": "object",
  "organizationId": "object",
  "translatedDescription": {
    "en": "object",
    "fr": "object"
  },
  "translatedName": {
    "en": "object",
    "fr": "object"
  },
  "translatedShortDescription": {
    "en": "object",
    "fr": "object"
  }
}

CreateThemeResponse: object

theme:
object
return:
arguments:
object
Example
{
  "theme": {
    "return": {
      "core": {
        "return": "boolean",
        "arguments": {}
      },
      "description": {
        "return": "string",
        "arguments": {}
      },
      "iconKey": {
        "return": "string",
        "arguments": {}
      },
      "id": {
        "return": "object",
        "arguments": {}
      },
      "key": {
        "return": "string",
        "arguments": {}
      },
      "logs": {
        "return": {
          "logs": {
            "return": [
              {
                "account": {
                  "return": {
                    "affiliations": {
                      "return": [
                        {
                          "allocation": {
                            "return": "number",
                            "arguments": {}
                          },
                          "id": {
                            "return": "object",
                            "arguments": {}
                          },
                          "relation": {
                            "return": "string",
                            "arguments": {}
                          },
                          "signatureRequired": {
                            "return": "boolean",
                            "arguments": {}
                          },
                          "type": {
                            "return": "string",
                            "arguments": {}
                          },
                          "user": {
                            "return": {
                              "accessibleBy": {
                                "return": [
                                  {
                                    "displayOptions": {
                                      "return": {
                                        "hide": {
                                          "return": "boolean",
                                          "arguments": {}
                                        },
                                        "order": {
                                          "return": "number",
                                          "arguments": {}
                                        }
                                      },
                                      "arguments": {}
                                    },
                                    "organizationUser": {
                                      "return": {
                                        "accessType": {
                                          "return": "string",
                                          "arguments": {}
                                        },
                                        "apiTokens": {
                                          "return": [
                                            {
                                              "id": {
                                                "return": "object",
                                                "arguments": {}
                                              },
                                              "jwtToken": {
                                                "return": "string",
                                                "arguments": {}
                                              },
                                              "name": {
                                                "return": "string",
                                                "arguments": {}
                                              }
                                            }
                                          ]
                                        }
                                      }
                                    }
                                  }
                                ]
                              }
                            }
                          }
                        }
                      ]
                    }
                  }
                }
              }
            ]
          }
        }
      }
    }
  }
}

CreateTradeInput: object

actualQuantity:
actualTradePriceCents:
createExternalTransfer:

If createExternalTransfer is true and effectiveDate is informed, a matching EXTERNAL_TRANSFER (IN or OUT) will be created with the same amount (quantity x price) and date.

description:
effectiveDate:

If effectiveDate is informed, the trade will be created as RECONCILED on the informed date. Otherwise, the trade will be created as INITIATED.

financialProductId:
subAccountId:
type:
Example
{
  "actualQuantity": "number",
  "actualTradePriceCents": "number",
  "createExternalTransfer": "boolean",
  "description": "object",
  "effectiveDate": "object",
  "financialProductId": "object",
  "subAccountId": "object",
  "type": "string"
}

CreateTradeResponse: object

trade:
object
return:
arguments:
object
Example
{
  "trade": {
    "return": {
      "account": {
        "return": {
          "affiliations": {
            "return": [
              {
                "allocation": {
                  "return": "number",
                  "arguments": {}
                },
                "id": {
                  "return": "object",
                  "arguments": {}
                },
                "relation": {
                  "return": "string",
                  "arguments": {}
                },
                "signatureRequired": {
                  "return": "boolean",
                  "arguments": {}
                },
                "type": {
                  "return": "string",
                  "arguments": {}
                },
                "user": {
                  "return": {
                    "accessibleBy": {
                      "return": [
                        {
                          "displayOptions": {
                            "return": {
                              "hide": {
                                "return": "boolean",
                                "arguments": {}
                              },
                              "order": {
                                "return": "number",
                                "arguments": {}
                              }
                            },
                            "arguments": {}
                          },
                          "organizationUser": {
                            "return": {
                              "accessType": {
                                "return": "string",
                                "arguments": {}
                              },
                              "apiTokens": {
                                "return": [
                                  {
                                    "id": {
                                      "return": "object",
                                      "arguments": {}
                                    },
                                    "jwtToken": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "name": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "organization": {
                                      "return": {
                                        "browserTabTitle": {
                                          "return": "string",
                                          "arguments": {}
                                        },
                                        "faviconLink": {
                                          "return": "string",
                                          "arguments": {}
                                        },
                                        "id": {
                                          "return": "object",
                                          "arguments": {}
                                        },
                                        "name": {
                                          "return": "string",
                                          "arguments": {}
                                        },
                                        "parent": {
                                          "return": {
                                            "browserTabTitle": {
                                              "return": "string",
                                              "arguments": {}
                                            },
                                            "faviconLink": {}
                                          }
                                        }
                                      }
                                    }
                                  }
                                ]
                              }
                            }
                          }
                        }
                      ]
                    }
                  }
                }
              }
            ]
          }
        }
      }
    }
  }
}

CreateTransactionInput: object

currency:
date:
description:
financialProductId:
objectId:
objectType:
priceCents:
quantity:
requestId:
subAccountId:
type:
valueCents:
Example
{
  "currency": "string",
  "date": "object",
  "description": "object",
  "financialProductId": "object",
  "objectId": "object",
  "objectType": "string",
  "priceCents": "number",
  "quantity": "number",
  "requestId": "object",
  "subAccountId": "object",
  "type": "string",
  "valueCents": "number"
}

CreateTransactionResponse: object

transaction:
object
return:
arguments:
object
Example
{
  "transaction": {
    "return": {
      "account": {
        "return": {
          "affiliations": {
            "return": [
              {
                "allocation": {
                  "return": "number",
                  "arguments": {}
                },
                "id": {
                  "return": "object",
                  "arguments": {}
                },
                "relation": {
                  "return": "string",
                  "arguments": {}
                },
                "signatureRequired": {
                  "return": "boolean",
                  "arguments": {}
                },
                "type": {
                  "return": "string",
                  "arguments": {}
                },
                "user": {
                  "return": {
                    "accessibleBy": {
                      "return": [
                        {
                          "displayOptions": {
                            "return": {
                              "hide": {
                                "return": "boolean",
                                "arguments": {}
                              },
                              "order": {
                                "return": "number",
                                "arguments": {}
                              }
                            },
                            "arguments": {}
                          },
                          "organizationUser": {
                            "return": {
                              "accessType": {
                                "return": "string",
                                "arguments": {}
                              },
                              "apiTokens": {
                                "return": [
                                  {
                                    "id": {
                                      "return": "object",
                                      "arguments": {}
                                    },
                                    "jwtToken": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "name": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "organization": {
                                      "return": {
                                        "browserTabTitle": {
                                          "return": "string",
                                          "arguments": {}
                                        },
                                        "faviconLink": {
                                          "return": "string",
                                          "arguments": {}
                                        },
                                        "id": {
                                          "return": "object",
                                          "arguments": {}
                                        },
                                        "name": {
                                          "return": "string",
                                          "arguments": {}
                                        },
                                        "parent": {
                                          "return": {
                                            "browserTabTitle": {
                                              "return": "string",
                                              "arguments": {}
                                            },
                                            "faviconLink": {}
                                          }
                                        }
                                      }
                                    }
                                  }
                                ]
                              }
                            }
                          }
                        }
                      ]
                    }
                  }
                }
              }
            ]
          }
        }
      }
    }
  }
}

CreateTransferResponse: object

transfer:
object
return:
arguments:
object
Example
{
  "transfer": {
    "return": {
      "alertReport": {
        "return": {
          "id": {
            "return": "object",
            "arguments": {}
          },
          "reason": {
            "return": "string",
            "arguments": {}
          },
          "rules": {
            "return": [
              {
                "id": {
                  "return": "object",
                  "arguments": {}
                },
                "translatedDescription": {
                  "return": {
                    "en": {
                      "return": "string",
                      "arguments": {}
                    },
                    "fr": {
                      "return": "string",
                      "arguments": {}
                    }
                  },
                  "arguments": {}
                },
                "type": {
                  "return": "string",
                  "arguments": {}
                }
              }
            ],
            "arguments": {}
          },
          "state": {
            "return": "string",
            "arguments": {}
          },
          "transfer": {
            "return": {
              "alertReport": {
                "return": {
                  "id": {
                    "return": "object",
                    "arguments": {}
                  },
                  "reason": {
                    "return": "string",
                    "arguments": {}
                  },
                  "rules": {
                    "return": [
                      {
                        "id": {
                          "return": "object",
                          "arguments": {}
                        },
                        "translatedDescription": {
                          "return": {
                            "en": {
                              "return": "string",
                              "arguments": {}
                            },
                            "fr": {
                              "return": "string",
                              "arguments": {}
                            }
                          },
                          "arguments": {}
                        },
                        "type": {
                          "return": "string",
                          "arguments": {}
                        }
                      }
                    ],
                    "arguments": {}
                  },
                  "state": {
                    "return": "string",
                    "arguments": {}
                  },
                  "transfer": {
                    "return": {
                      "alertReport": {
                        "return": {
                          "id": {
                            "return": "object",
                            "arguments": {}
                          },
                          "reason": {
                            "return": "string"
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

CreateUserIDVerificationInformationInput: object

Input type for creating a user's IdVerification

creditFileSource:
documentExpiryDate:

The expiry date of the document (Required for DIGITAL_DOCUMENT_CHECK method)

documentID:

The unique identifying number of the document used (Required for DIGITAL_DOCUMENT_CHECK method)

documentIssuingJurisdication:

The jurisdiction (province or state) and country of issue of the document (Required for DIGITAL_DOCUMENT_CHECK method)

documentType:

Type of the document used in the ID Verification (Required for DIGITAL_DOCUMENT_CHECK method)

methodOfIDVerification:

Method used for ID verification

requestId:

Unique requestID created by partner for each request to create a new userIDVerification request.

secondaryDocumentExpiryDate:
secondaryDocumentID:
secondaryDocumentIssuingJurisdication:
secondaryDocumentType:
secondaryDocumentUserName:
userId:

UserID

userName:

The person's name on the document (Required for DIGITAL_DOCUMENT_CHECK method)

verifiedDate:

Date on which the ID was verified (Required for DIGITAL_DOCUMENT_CHECK method)

Example
{
  "creditFileSource": "object",
  "documentExpiryDate": "object",
  "documentID": "object",
  "documentIssuingJurisdication": "object",
  "documentType": "string",
  "methodOfIDVerification": "string",
  "requestId": "object",
  "secondaryDocumentExpiryDate": "object",
  "secondaryDocumentID": "object",
  "secondaryDocumentIssuingJurisdication": "object",
  "secondaryDocumentType": "string",
  "secondaryDocumentUserName": "object",
  "userId": "object",
  "userName": "object",
  "verifiedDate": "object"
}

CreateUserInput: object

Input type for creating a user

annualDebtPaymentsCents:

The amount in cents that the user pays annually towards debts

annualIncomeCents:

User's annual income in amount cents

annualIncomeStr:

User's annual income in non-numeric form (range, category, etc)

billingScheduleId:
bulkAccountOpening:
businessIsMemberofIIROC:
businessPhone:
charityRegistrationNumber:
citizenships:
SafeString

User's citizenships

closeAssociateOfPEP:

Is the user a close associate of politically exposed person?

companyType:

The type of company at which the user is employed

complianceIssueSource:
complianceState:
countryOfRegistration:
countryOfTaxResidence:
dateOfBirth:

User's date of birth

dateOfDeath:

User's date of death

debtAssociated:
DebtAssociated

The type of debt. Student loan, Mortgage or Credit Card debt, etc.

employerCompanyAddress:
employerName:
employmentSituation:
employmentSituationOtherDescription:
employmentStatus:

User's employment status

entityName:
establishedDate:
fatcaStatus:
fatcaStatusOtherDescription:
feeTierId:
financialFixedAssetsCents:

User's fixed assets in amount cents

financialLiquidAssetsCents:

User's liquid assets in amount cents

firmNumber:
firstName:

User's first name

foreignTaxInformation:
ForeignTaxInformationInput

The tax information provided by the user if the user pays tax to a foreign country

gender:

User's gender.

headOfInternationalOrganization:

Is/Was the User the head of an international organization?

iDCheckCompleted:
iDCheckRetrigger:
identificationType:
inProvinceSince:
insiderSymbols:
SafeString
instructionsFromFinancialEntity:
integrations:
UserIntegrationInput
investmentKnowledge:

What is the user's level of investment knowledge?

isAFinancialEntity:
isAccreditedInvestor:

Is the client an accredited investor?

isAffiliateOfFinancialEntity:
isEntityForProfit:
isEntityRegulated:
isForThirdParty:
isLargeCorporation:
isMemberOfIiroc:

Is the user a member of IIROC? IIROC:Investment Industry Regulatory Organization of Canada

isNonProfit:
isOfficerOfPublicCompany:

Is the user a high-level management executive of a public company?

isOwnerOfEntity:
isOwnerOfPublicCompany:

Is the user the owner of a public company?

isPublicBody:
isRegisteredWithCRA:
isReportingIssuer:
isVulnerablePerson:
issuerExchange:
issuerName:
issuerTicker:
jobTitle:

User's job title, if user is employed

language:

Languages the user communicates in

lastName:

User's last name

maritalStatus:

User's martial status

middleName:

User's middle name

numberOfDependents:
Int

Number of dependents associated with User

organizationId:

What the organization should be set to for the new user

parentCompanyName:
partnerUserId:

User ID on the Partner system that uses the OneVest embedded web-app

payTaxesOutsideCanada:
phone:

User's phone number

physicalAddress:

User's address

politicallyExposedDomesticPerson:

Is the user a politically exposed person in a Canada?

politicallyExposedForeignPerson:

Is the user a politically exposed person in a foreign country?

powerOfAttorneyGranted:

Has the User appointed a Power of Attorney?

preferredMethodOfCommunication:
preferredMethodOfCommunicationOtherDescription:
primaryEmail:

User's email address

readyToSignAgreement:
receivesDonationsFromPublic:
registrationNumber:
regulatorName:
relatedEntities:
RelatedEntityInput
requestId:

Unique requestID created by partner for each request to create a new user

retirementAge:
Int

Expected age the user wishes to retire

riskQuestion1:

User's answer to the first risk question

riskQuestion2:

User's answer to the second risk question

sin:

User's Social Insurance Number

sourceOfFunds:
UserSourceOfFunds
sourceOfFundsOtherDescription:
sourceOfWealth:
UserSourceOfWealth
sourceOfWealthOtherDescription:
spouseAddress:
spouseCompanyType:

User's spouse company type, if employed

spouseDateOfBirth:

User's spouse Date of birth

spouseEmail:
spouseEmployerName:
spouseEmploymentType:
spouseFirstName:

User's spouse first name

spouseJobTitle:

User's spouse job title

spouseLastName:

User's spouse last name

spouseMiddleName:

User's spouse middle name

spouseSin:

User's spouse Social Insurance Number

ssSymbols:
SafeString
studentAreaOfStudy:

Area of study, if user is a student

taxId:

User's Tax ID: SIN/BN (Canada), SSN/ITIN/EIN (United States). See taxIdType.

taxIdType:

Type of taxId value

taxNumber:
timezone:

User's timezone Please use one of the following valid timezone formats:

'America/Blanc-Sablon' 'America/Glace_Bay' 'America/Goose_Bay' 'America/Halifax' 'America/Moncton' 'America/Dawson_Creek' 'America/Creston' 'America/Fort_Nelson' 'America/Cambridge_Bay' 'America/Edmonton' 'America/Inuvik' 'America/Yellowknife' 'America/Atikokan' 'America/Iqaluit' 'America/Nipigon' 'America/Pangnirtung' 'America/Thunder_Bay' 'America/Toronto' 'America/Rainy_River' 'America/Rankin_Inlet' 'America/Resolute' 'America/Winnipeg' 'America/Regina' 'America/Swift_Current' 'America/Dawson' 'America/Vancouver' 'America/Whitehorse'

totalDebtCents:

User's total debt in amount cents

trustedContactPerson:

User's trusted contact person details

type:
uniqueCircumstances:
yearEnd:
Example
{
  "annualDebtPaymentsCents": "object",
  "annualIncomeCents": "object",
  "annualIncomeStr": "string",
  "billingScheduleId": "object",
  "bulkAccountOpening": "boolean",
  "businessIsMemberofIIROC": "boolean",
  "businessPhone": "object",
  "charityRegistrationNumber": "object",
  "citizenships": [
    "object"
  ],
  "closeAssociateOfPEP": "boolean",
  "companyType": "object",
  "complianceIssueSource": "object",
  "complianceState": "string",
  "countryOfRegistration": "object",
  "countryOfTaxResidence": "string",
  "dateOfBirth": "object",
  "dateOfDeath": "object",
  "debtAssociated": [
    "string"
  ],
  "employerCompanyAddress": {
    "city": "object",
    "country": "string",
    "houseNumber": "object",
    "jurisdiction": "string",
    "neighborhood": "object",
    "postal": "object",
    "province": "string",
    "streetName": "object",
    "unitNumber": "object"
  },
  "employerName": "object",
  "employmentSituation": "string",
  "employmentSituationOtherDescription": "object",
  "employmentStatus": "string",
  "entityName": "object",
  "establishedDate": "object",
  "fatcaStatus": "string",
  "fatcaStatusOtherDescription": "object",
  "feeTierId": "object",
  "financialFixedAssetsCents": "object",
  "financialLiquidAssetsCents": "object",
  "firmNumber": "object",
  "firstName": "object",
  "foreignTaxInformation": [
    {
      "foreignTaxCountry": "object",
      "foreignTaxNumber": "object"
    }
  ],
  "gender": "object",
  "headOfInternationalOrganization": "boolean",
  "iDCheckCompleted": "boolean",
  "iDCheckRetrigger": "boolean"
}

CreateUserResponse: object

Type definition for creating a user

user:
object

User object

return:
arguments:
object
Example
{
  "user": {
    "return": {
      "accessibleBy": {
        "return": [
          {
            "displayOptions": {
              "return": {
                "hide": {
                  "return": "boolean",
                  "arguments": {}
                },
                "order": {
                  "return": "number",
                  "arguments": {}
                }
              },
              "arguments": {}
            },
            "organizationUser": {
              "return": {
                "accessType": {
                  "return": "string",
                  "arguments": {}
                },
                "apiTokens": {
                  "return": [
                    {
                      "id": {
                        "return": "object",
                        "arguments": {}
                      },
                      "jwtToken": {
                        "return": "string",
                        "arguments": {}
                      },
                      "name": {
                        "return": "string",
                        "arguments": {}
                      },
                      "organization": {
                        "return": {
                          "browserTabTitle": {
                            "return": "string",
                            "arguments": {}
                          },
                          "faviconLink": {
                            "return": "string",
                            "arguments": {}
                          },
                          "id": {
                            "return": "object",
                            "arguments": {}
                          },
                          "name": {
                            "return": "string",
                            "arguments": {}
                          },
                          "parent": {
                            "return": {
                              "browserTabTitle": {
                                "return": "string",
                                "arguments": {}
                              },
                              "faviconLink": {
                                "return": "string",
                                "arguments": {}
                              },
                              "id": {
                                "return": "object",
                                "arguments": {}
                              },
                              "name": {
                                "return": "string",
                                "arguments": {}
                              },
                              "parent": {
                                "return": {
                                  "browserTabTitle": {
                                    "return": "string",
                                    "arguments": {}
                                  },
                                  "faviconLink": {
                                    "return": "string",
                                    "arguments": {}
                                  },
                                  "id": {
                                    "return": "object",
                                    "arguments": {}
                                  },
                                  "name": {
                                    "return": "string",
                                    "arguments": {}
                                  }
                                }
                              }
                            }
                          }
                        }
                      }
                    }
                  ]
                }
              }
            }
          }
        ]
      }
    }
  }
}

CreateWebhookInput: object

customHeaders:

Any custom headers that may need to be set to be sent with the mutation to the assigned url.

eventType:

The event type on the object that gets actioned to then send off the webhook.

gql:

The graphql query string that would be used to query the OneVest partner gateway usually. The variable of '$id' is used for the actioned object.

mutationInputName:

The name of the input that the webhook will pass, it will always pass as variable 'input'.

mutationName:

The name of the mutation that the webhook will hit.

objectType:

The type of object you want to listen to, to receive a webhook on.

organizationId:

Organization to which the crated webhook will be linked. If not informed, the organization of the context user will be considered.

url:

GraphQL URL in which the webhook will hit.

Example
{
  "customHeaders": "object",
  "eventType": "string",
  "gql": "string",
  "mutationInputName": "string",
  "mutationName": "string",
  "objectType": "string",
  "organizationId": "object",
  "url": "string"
}

CreateWebhookResponse: object

webhook:
object
return:
arguments:
object
Example
{
  "webhook": {
    "return": {
      "customHeaders": {
        "return": "object",
        "arguments": {}
      },
      "customPayloadAttributes": {
        "return": "object",
        "arguments": {}
      },
      "eventType": {
        "return": "string",
        "arguments": {}
      },
      "gql": {
        "return": "string",
        "arguments": {}
      },
      "id": {
        "return": "object",
        "arguments": {}
      },
      "mutationInputName": {
        "return": "string",
        "arguments": {}
      },
      "mutationName": {
        "return": "string",
        "arguments": {}
      },
      "objectType": {
        "return": "string",
        "arguments": {}
      },
      "organization": {
        "return": {
          "accountTypeTaxRanks": {
            "return": [
              {
                "accountType": {
                  "return": "string",
                  "arguments": {}
                },
                "id": {
                  "return": "object",
                  "arguments": {}
                },
                "taxRank": {
                  "return": "number",
                  "arguments": {}
                }
              }
            ],
            "arguments": {}
          },
          "allowAccessToSubOrganizations": {
            "return": "boolean",
            "arguments": {}
          },
          "allowDirectCommunication": {
            "return": "boolean",
            "arguments": {}
          },
          "allowInactiveUserAdjustments": {
            "return": "boolean",
            "arguments": {}
          },
          "allowInactiveUserFeeCalculation": {
            "return": "boolean",
            "arguments": {}
          },
          "allowInactiveUserRebalancing": {
            "return": "boolean",
            "arguments": {}
          },
          "allowInstantInvest": {
            "return": "boolean",
            "arguments": {}
          },
          "allowPortfolioPerGoal": {
            "return": "boolean",
            "arguments": {}
          },
          "allowPostOptimizationEditing": {
            "return": "boolean",
            "arguments": {}
          },
          "allowViewSubTradeRequestPairs": {
            "return": "boolean",
            "arguments": {}
          },
          "applicableJurisdictions": {
            "return": {
              "all": {
                "return": "boolean",
                "arguments": {}
              },
              "only": {}
            }
          }
        }
      }
    }
  }
}

CreateWithdrawTransferInput: object

amountCents:

Transfer amount in cents. Minimum $100 (10000)

bankAccountId:

User' Bank Account ID.

currency:
requestId:

This an ID created by the partner, that is submitted with an transfer request and unique to each request.

subAccountId:

Account that transfer is to be processed in.

withdrawalMode:
withdrawalReason:

Withdrawal reason.

withdrawalReasonDescription:
Example
{
  "amountCents": "object",
  "bankAccountId": "object",
  "currency": "string",
  "requestId": "object",
  "subAccountId": "object",
  "withdrawalMode": "string",
  "withdrawalReason": "string",
  "withdrawalReasonDescription": "object"
}

CreateWorkflowCompletionInput: object

objectId:
objectType:
organizationId:
parentWorkflowCompletionId:
workflowId:
Example
{
  "objectId": "string",
  "objectType": "string",
  "organizationId": "object",
  "parentWorkflowCompletionId": "object",
  "workflowId": "object"
}

CreateWorkflowCompletionResponse: object

workflowCompletion:
object
return:
arguments:
object
Example
{
  "workflowCompletion": {
    "return": {
      "context": {
        "return": "object",
        "arguments": {}
      },
      "createdAt": {
        "return": "object",
        "arguments": {}
      },
      "currentStep": {
        "return": {
          "id": {
            "return": "object",
            "arguments": {}
          },
          "name": {
            "return": {
              "en": {
                "return": "string",
                "arguments": {}
              },
              "fr": {
                "return": "string",
                "arguments": {}
              }
            },
            "arguments": {}
          },
          "subSteps": {
            "return": [
              {
                "canGoBack": {
                  "return": "boolean",
                  "arguments": {}
                },
                "completeableBy": {
                  "return": [
                    "string"
                  ],
                  "arguments": {}
                },
                "id": {
                  "return": "object",
                  "arguments": {}
                },
                "options": {
                  "return": "object",
                  "arguments": {}
                },
                "rolesCompleteableBy": {
                  "return": [
                    {
                      "accessiblePages": {
                        "return": [
                          "string"
                        ],
                        "arguments": {}
                      },
                      "accountPageConfiguration": {
                        "return": {
                          "createdAt": {
                            "return": "object",
                            "arguments": {}
                          },
                          "id": {
                            "return": "object",
                            "arguments": {}
                          },
                          "name": {
                            "return": "string",
                            "arguments": {}
                          },
                          "options": {
                            "return": "object",
                            "arguments": {}
                          },
                          "organization": {
                            "return": {
                              "accountTypeTaxRanks": {
                                "return": [
                                  {
                                    "accountType": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "id": {
                                      "return": "object",
                                      "arguments": {}
                                    },
                                    "taxRank": {
                                      "return": "number",
                                      "arguments": {}
                                    }
                                  }
                                ],
                                "arguments": {}
                              }
                            }
                          }
                        }
                      }
                    }
                  ]
                }
              }
            ]
          }
        }
      }
    }
  }
}

CreateWorkflowInput: object

eventType:
name:
objectType:
organizationId:
steps:
CreateStepInput
triggerRules:
TriggerRuleInput
triggerType:
Example
{
  "eventType": "string",
  "name": {
    "en": "object",
    "fr": "object"
  },
  "objectType": "string",
  "organizationId": "object",
  "steps": [
    {
      "name": {
        "en": "object",
        "fr": "object"
      },
      "subSteps": [
        {
          "canGoBack": "boolean",
          "completeableBy": [
            "string"
          ],
          "options": "object",
          "rolesCompleteableBy": [
            "object"
          ],
          "skippable": "boolean",
          "type": "string"
        }
      ]
    }
  ],
  "triggerRules": [
    {
      "comparison": "string",
      "field": "object",
      "value": "object"
    }
  ],
  "triggerType": "string"
}

CreateWorkflowResponse: object

workflow:
object
return:
arguments:
object
Example
{
  "workflow": {
    "return": {
      "createdAt": {
        "return": "object",
        "arguments": {}
      },
      "eventType": {
        "return": "string",
        "arguments": {}
      },
      "id": {
        "return": "object",
        "arguments": {}
      },
      "name": {
        "return": {
          "en": {
            "return": "string",
            "arguments": {}
          },
          "fr": {
            "return": "string",
            "arguments": {}
          }
        },
        "arguments": {}
      },
      "objectType": {
        "return": "string",
        "arguments": {}
      },
      "organization": {
        "return": {
          "accountTypeTaxRanks": {
            "return": [
              {
                "accountType": {
                  "return": "string",
                  "arguments": {}
                },
                "id": {
                  "return": "object",
                  "arguments": {}
                },
                "taxRank": {
                  "return": "number",
                  "arguments": {}
                }
              }
            ],
            "arguments": {}
          },
          "allowAccessToSubOrganizations": {
            "return": "boolean",
            "arguments": {}
          },
          "allowDirectCommunication": {
            "return": "boolean",
            "arguments": {}
          },
          "allowInactiveUserAdjustments": {
            "return": "boolean",
            "arguments": {}
          },
          "allowInactiveUserFeeCalculation": {
            "return": "boolean",
            "arguments": {}
          },
          "allowInactiveUserRebalancing": {
            "return": "boolean",
            "arguments": {}
          },
          "allowInstantInvest": {
            "return": "boolean",
            "arguments": {}
          },
          "allowPortfolioPerGoal": {
            "return": "boolean",
            "arguments": {}
          },
          "allowPostOptimizationEditing": {
            "return": "boolean",
            "arguments": {}
          },
          "allowViewSubTradeRequestPairs": {
            "return": "boolean",
            "arguments": {}
          },
          "applicableJurisdictions": {
            "return": {
              "all": {
                "return": "boolean",
                "arguments": {}
              },
              "only": {
                "return": [
                  "string"
                ],
                "arguments": {}
              }
            }
          }
        }
      }
    }
  }
}

CreationNotificationDefintionResponse: object

notificationDefinition:
object
return:
arguments:
object
Example
{
  "notificationDefinition": {
    "return": {
      "bodyTemplate": {
        "return": {
          "en": {
            "return": "string",
            "arguments": {}
          },
          "fr": {
            "return": "string",
            "arguments": {}
          }
        },
        "arguments": {}
      },
      "createdAt": {
        "return": "object",
        "arguments": {}
      },
      "id": {
        "return": "object",
        "arguments": {}
      },
      "linkTemplate": {
        "return": "object",
        "arguments": {}
      },
      "linkText": {
        "return": {
          "en": {
            "return": "string",
            "arguments": {}
          },
          "fr": {
            "return": "string",
            "arguments": {}
          }
        },
        "arguments": {}
      },
      "name": {
        "return": "object",
        "arguments": {}
      },
      "notificationGroup": {
        "return": {
          "id": {
            "return": "object",
            "arguments": {}
          },
          "name": {
            "return": {
              "en": {
                "return": "string",
                "arguments": {}
              },
              "fr": {
                "return": "string",
                "arguments": {}
              }
            },
            "arguments": {}
          }
        },
        "arguments": {}
      },
      "organization": {
        "return": {
          "accountTypeTaxRanks": {
            "return": [
              {
                "accountType": {
                  "return": "string",
                  "arguments": {}
                },
                "id": {
                  "return": "object",
                  "arguments": {}
                },
                "taxRank": {
                  "return": "number",
                  "arguments": {}
                }
              }
            ],
            "arguments": {}
          },
          "allowAccessToSubOrganizations": {
            "return": "boolean",
            "arguments": {}
          },
          "allowDirectCommunication": {
            "return": "boolean",
            "arguments": {}
          },
          "allowInactiveUserAdjustments": {
            "return": "boolean",
            "arguments": {}
          },
          "allowInactiveUserFeeCalculation": {
            "return": "boolean",
            "arguments": {}
          }
        }
      }
    }
  }
}

Currencies: string

object
CAD
object
USD

CurrencyCodes: string

object
AED
object
AFN
object
ALL
object
AMD
object
ANG
object
AOA
object
ARS
object
AUD
object
AWG
object
AZN
object
BAM
object
BBD
object
BDT
object
BGN
object
BHD
object
BIF
object
BMD
object
BND
object
BOB
object
BOV
object
BRL
object
BSD
object
BTN
object
BWP
object
BYN
object
BZD
object
CAD
object
CDF
object
CHE
object
CHF
object
CHW
object
CLF
object
CLP
object
CNY
object
COP
object
COU
object
CRC
object
CUC
object
CUP
object
CVE
object
CZK
object
DJF
object
DKK
object
DOP
object
DZD
object
EGP
object
ERN
object
ETB
object
EUR
object
FJD
object
FKP
object
GBP
object
GEL
object
GHS
object
GIP
object
GMD
object
GNF
object
GTQ
object
GYD
object
HKD
object
HNL
object
HTG
object
HUF
object
IDR
object
ILS
object
INR
object
IQD
object
IRR
object
ISK
object
JMD
object
JOD
object
JPY
object
KES
object
KGS
object
KHR
object
KMF
object
KPW
object
KRW
object
KWD
object
KYD
object
KZT
object
LAK
object
LBP
object
LKR
object
LRD
object
LSL
object
LYD
object
MAD
object
MDL
object
MGA
object
MKD
object
MMK
object
MNT
object
MOP
object
MRU
object
MUR
object
MVR
object
MWK
object
MXN
object
MXV
object
MYR
object
MZN
object
NAD
object
NGN
object
NIO
object
NOK
object
NPR
object
NZD
object
OMR
object
PAB
object
PEN
object
PGK
object
PHP
object
PKR
object
PLN
object
PYG
object
QAR
object
RON
object
RSD
object
RUB
object
RWF
object
SAR
object
SBD
object
SCR
object
SDG
object
SEK
object
SGD
object
SHP
object
SLE
object
SLL
object
SOS
object
SRD
object
SSP
object
STN
object
SVC
object
SYP
object
SZL
object
THB
object
TJS
object
TMT
object
TND
object
TOP
object
TRY
object
TTD
object
TWD
object
TZS
object
UAH
object
UGX
object
USD
object
USN
object
UYI
object
UYU
object
UYW
object
UZS
object
VED
object
VES
object
VND
object
VUV
object
WST
object
XAF
object
XAG
object
XAU
object
XBA
object
XBB
object
XBC
object
XBD
object
XCD
object
XDR
object
XOF
object
XPD
object
XPF
object
XPT
object
XSU
object
XTS
object
XUA
object
XXX
object
YER
object
ZAR
object
ZMW
object
ZWL

CurrencyFallbackConversion: object

from:
rate:
to:
Example
{
  "from": "string",
  "rate": "number",
  "to": "string"
}

Custodian: object

customerName:
object
return:
arguments:
object
id:
object
return:
arguments:
object
inventoryAccount:
object
return:
arguments:
object
moneyAccount:
object
return:
arguments:
object
name:
object
return:
arguments:
object
notificationEmails:
object
return:
String
arguments:
object
organization:
object
return:
arguments:
object
repCode:
object
return:
arguments:
object
sftpInBucket:
object
return:
arguments:
object
sftpOutBucket:
object
return:
arguments:
object
type:
object
return:
arguments:
object
Example
{
  "customerName": {
    "return": "string",
    "arguments": {}
  },
  "id": {
    "return": "object",
    "arguments": {}
  },
  "inventoryAccount": {
    "return": {
      "affiliations": {
        "return": [
          {
            "allocation": {
              "return": "number",
              "arguments": {}
            },
            "id": {
              "return": "object",
              "arguments": {}
            },
            "relation": {
              "return": "string",
              "arguments": {}
            },
            "signatureRequired": {
              "return": "boolean",
              "arguments": {}
            },
            "type": {
              "return": "string",
              "arguments": {}
            },
            "user": {
              "return": {
                "accessibleBy": {
                  "return": [
                    {
                      "displayOptions": {
                        "return": {
                          "hide": {
                            "return": "boolean",
                            "arguments": {}
                          },
                          "order": {
                            "return": "number",
                            "arguments": {}
                          }
                        },
                        "arguments": {}
                      },
                      "organizationUser": {
                        "return": {
                          "accessType": {
                            "return": "string",
                            "arguments": {}
                          },
                          "apiTokens": {
                            "return": [
                              {
                                "id": {
                                  "return": "object",
                                  "arguments": {}
                                },
                                "jwtToken": {
                                  "return": "string",
                                  "arguments": {}
                                },
                                "name": {
                                  "return": "string",
                                  "arguments": {}
                                },
                                "organization": {
                                  "return": {
                                    "browserTabTitle": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "faviconLink": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "id": {
                                      "return": "object",
                                      "arguments": {}
                                    },
                                    "name": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "parent": {
                                      "return": {}
                                    }
                                  }
                                }
                              }
                            ]
                          }
                        }
                      }
                    }
                  ]
                }
              }
            }
          }
        ]
      }
    }
  }
}

CustodianAccountOpeningTypes: string

object
BATCH
object
EVENT

CustodianAccountsDaily: object

account:
object
return:
arguments:
object
date:
object
return:
arguments:
object
holdings:
object
return:
Holding
arguments:
object
id:
object
return:
arguments:
object
marketValueCents:
object
return:
Int
arguments:
object
moneyAvailableCents:
object
return:
Int
arguments:
object
Example
{
  "account": {
    "return": {
      "affiliations": {
        "return": [
          {
            "allocation": {
              "return": "number",
              "arguments": {}
            },
            "id": {
              "return": "object",
              "arguments": {}
            },
            "relation": {
              "return": "string",
              "arguments": {}
            },
            "signatureRequired": {
              "return": "boolean",
              "arguments": {}
            },
            "type": {
              "return": "string",
              "arguments": {}
            },
            "user": {
              "return": {
                "accessibleBy": {
                  "return": [
                    {
                      "displayOptions": {
                        "return": {
                          "hide": {
                            "return": "boolean",
                            "arguments": {}
                          },
                          "order": {
                            "return": "number",
                            "arguments": {}
                          }
                        },
                        "arguments": {}
                      },
                      "organizationUser": {
                        "return": {
                          "accessType": {
                            "return": "string",
                            "arguments": {}
                          },
                          "apiTokens": {
                            "return": [
                              {
                                "id": {
                                  "return": "object",
                                  "arguments": {}
                                },
                                "jwtToken": {
                                  "return": "string",
                                  "arguments": {}
                                },
                                "name": {
                                  "return": "string",
                                  "arguments": {}
                                },
                                "organization": {
                                  "return": {
                                    "browserTabTitle": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "faviconLink": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "id": {
                                      "return": "object",
                                      "arguments": {}
                                    },
                                    "name": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "parent": {
                                      "return": {
                                        "browserTabTitle": {
                                          "return": "string",
                                          "arguments": {}
                                        },
                                        "faviconLink": {
                                          "return": "string",
                                          "arguments": {}
                                        }
                                      }
                                    }
                                  }
                                }
                              }
                            ]
                          }
                        }
                      }
                    }
                  ]
                }
              }
            }
          }
        ]
      }
    }
  }
}

CustodianActivity: object

account:
object
return:
arguments:
object
accruedInterest:
object
return:
arguments:
object
amountValueCents:
object
return:
arguments:
object
clientName:
object
return:
arguments:
object
commission:
object
return:
arguments:
object
currency:
object
return:
arguments:
object
cusip:
object
return:
arguments:
object
custodianAccountNumber:
object
return:
arguments:
object
effectiveDate:
object
return:
arguments:
object
id:
object
return:
arguments:
object
priceCents:
object
return:
arguments:
object
processDate:
object
return:
arguments:
object
quantity:
object
return:
arguments:
object
securityType:
object
return:
arguments:
object
settleDate:
object
return:
arguments:
object
state:
object
return:
arguments:
object
subTransactionId:
object
return:
arguments:
object
symbol:
object
return:
arguments:
object
transactionDesc:
object
return:
arguments:
object
transactionId:
object
return:
arguments:
object
transactionType:
object
return:
arguments:
object
Example
{
  "account": {
    "return": {
      "affiliations": {
        "return": [
          {
            "allocation": {
              "return": "number",
              "arguments": {}
            },
            "id": {
              "return": "object",
              "arguments": {}
            },
            "relation": {
              "return": "string",
              "arguments": {}
            },
            "signatureRequired": {
              "return": "boolean",
              "arguments": {}
            },
            "type": {
              "return": "string",
              "arguments": {}
            },
            "user": {
              "return": {
                "accessibleBy": {
                  "return": [
                    {
                      "displayOptions": {
                        "return": {
                          "hide": {
                            "return": "boolean",
                            "arguments": {}
                          },
                          "order": {
                            "return": "number",
                            "arguments": {}
                          }
                        },
                        "arguments": {}
                      },
                      "organizationUser": {
                        "return": {
                          "accessType": {
                            "return": "string",
                            "arguments": {}
                          },
                          "apiTokens": {
                            "return": [
                              {
                                "id": {
                                  "return": "object",
                                  "arguments": {}
                                },
                                "jwtToken": {
                                  "return": "string",
                                  "arguments": {}
                                },
                                "name": {
                                  "return": "string",
                                  "arguments": {}
                                },
                                "organization": {
                                  "return": {
                                    "browserTabTitle": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "faviconLink": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "id": {
                                      "return": "object",
                                      "arguments": {}
                                    },
                                    "name": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "parent": {
                                      "return": {
                                        "browserTabTitle": {
                                          "return": "string",
                                          "arguments": {}
                                        },
                                        "faviconLink": {
                                          "return": "string",
                                          "arguments": {}
                                        }
                                      }
                                    }
                                  }
                                }
                              }
                            ]
                          }
                        }
                      }
                    }
                  ]
                }
              }
            }
          }
        ]
      }
    }
  }
}

CustodianActivityStates: string

object
CREATED
object
RECONCILED

CustodianAffiliate: object

allocation:
object
return:
Int
arguments:
object
relation:
object
return:
arguments:
object
type:
object
return:
arguments:
object
user:
object
return:
arguments:
object
Example
{
  "allocation": {
    "return": "number",
    "arguments": {}
  },
  "relation": {
    "return": "string",
    "arguments": {}
  },
  "type": {
    "return": "string",
    "arguments": {}
  },
  "user": {
    "return": {
      "dateOfBirth": {
        "return": "object",
        "arguments": {}
      },
      "firstName": {
        "return": "string",
        "arguments": {}
      },
      "lastName": {
        "return": "string",
        "arguments": {}
      }
    },
    "arguments": {}
  }
}

CustodianAffiliationRelations: string

object
CHILD
object
COMMON_LAW
object
GRANDCHILD
object
GRANDPARENT
object
GUARDIAN
object
NEPHEW_NIECE
object
OTHER
object
PARENT
object
PRIMARY_CAREGIVER
object
SIBLING
object
SPOUSE

CustodianAffiliationTypes: string

object
AUTHORIZED_INDIVIDUAL
object
BENEFICIAL_OWNER
object
CONTINGENT_BENEFICIARY
object
CONTRIBUTOR
object
DIRECTOR
object
GRANTOR
object
JOINT
object
OTHER
object
POWER_OF_ATTORNEY
object
PRIMARY_BENEFICIARY
object
PROTECTOR
object
SETTLOR
object
SUCCESSOR
object
THIRD_PARTY
object
TRUSTEE

CustodianAssetClass: object

riskLevel:
object
return:
Int
arguments:
object
translatedDescription:
object
return:
arguments:
object
translatedName:
object
return:
arguments:
object
Example
{
  "riskLevel": {
    "return": "number",
    "arguments": {}
  },
  "translatedDescription": {
    "return": {
      "en": {
        "return": "string",
        "arguments": {}
      },
      "fr": {
        "return": "string",
        "arguments": {}
      }
    },
    "arguments": {}
  },
  "translatedName": {
    "return": {
      "en": {
        "return": "string",
        "arguments": {}
      },
      "fr": {
        "return": "string",
        "arguments": {}
      }
    },
    "arguments": {}
  }
}

CustodianBankAccount: object

bankAccountNumber:
object
return:
arguments:
object
institutionNumber:
object
return:
arguments:
object
name:
object
return:
arguments:
object
transitNumber:
object
return:
arguments:
object
Example
{
  "bankAccountNumber": {
    "return": "string",
    "arguments": {}
  },
  "institutionNumber": {
    "return": "string",
    "arguments": {}
  },
  "name": {
    "return": "string",
    "arguments": {}
  },
  "transitNumber": {
    "return": "string",
    "arguments": {}
  }
}

CustodianConnection: object

accountOpenningSubmissionType:
object
return:
arguments:
object
accountTypeSettings:
object
return:
AccountTypeSettings
arguments:
object
allowFractionalTrading:
object
return:
arguments:
object
allowTransactionCreation:
object
return:
arguments:
object
baseCurrency:
object
return:
arguments:
object
config:
object
return:
arguments:
object
custodianActivityImportFilePaths:
object
return:
String
arguments:
object
custodianSnapshotImportFilePaths:
object
return:
SafeString
arguments:
object
custodianUsersImportFilePath:
object
return:
arguments:
object
customerName:
object
return:
arguments:
object
default:
object
return:
arguments:
object
disabledFlagTypes:
object
return:
String
arguments:
object
enableAccountOpeningSubmission:
object
return:
arguments:
object
enableAutoReconcileActivities:
object
return:
arguments:
object
enableAutoReconcilePositions:
object
return:
arguments:
object
enableCustodianAccountImport:
object
return:
arguments:
object
enableCustodianActivityImport:
object
return:
arguments:
object
enableCustodianOrganizationImport:
object
return:
arguments:
object
enableCustodianOrganizationUserImport:
object
return:
arguments:
object
enableCustodianSnapshotImport:
object
return:
arguments:
object
enableCustodianUserImport:
object
return:
arguments:
object
enableFetchCustodianAffiliates:
object
return:
arguments:
object
enableFetchCustodianCustomFields:
object
return:
arguments:
object
enableFetchCustodianProjectedIncome:
object
return:
arguments:
object
enableFetchCustodianSnapshotHistory:
object
return:
arguments:
object
enableFetchCustodianStatements:
object
return:
arguments:
object
enableFetchCustodianStatistics:
object
return:
arguments:
object
enableFetchCustodianSuitability:
object
return:
arguments:
object
enableFetchCustodianTransactions:
object
return:
arguments:
object
enableFetchCustodianUpcomingTransactions:
object
return:
arguments:
object
enableTransferSubmission:
object
return:
arguments:
object
fetchLivePrices:
object
return:
arguments:
object
id:
object
return:
arguments:
object
inventoryAccount:
object
return:
arguments:
object
moneyAccount:
object
return:
arguments:
object
name:
object
return:
arguments:
object
notificationEmails:
object
return:
String
arguments:
object
organization:
object
return:
arguments:
object
reconciliationType:
object
return:
arguments:
object
repCode:
object
return:
arguments:
object
sftpCredentials:
object
return:
arguments:
object
transferSubmissionType:
object
return:
arguments:
object
type:
object
return:
arguments:
object
Example
{
  "accountOpenningSubmissionType": {
    "return": "string",
    "arguments": {}
  },
  "accountTypeSettings": {
    "return": [
      {
        "availableCurrencies": {
          "return": [
            "string"
          ],
          "arguments": {}
        },
        "baseCurrency": {
          "return": "string",
          "arguments": {}
        },
        "id": {
          "return": "object",
          "arguments": {}
        },
        "isAutoSweepEnabled": {
          "return": "boolean",
          "arguments": {}
        },
        "isMultiCurrencyEnabled": {
          "return": "boolean",
          "arguments": {}
        },
        "type": {
          "return": "string",
          "arguments": {}
        }
      }
    ],
    "arguments": {}
  },
  "allowFractionalTrading": {
    "return": "boolean",
    "arguments": {}
  },
  "allowTransactionCreation": {
    "return": "boolean",
    "arguments": {}
  },
  "baseCurrency": {
    "return": "string",
    "arguments": {}
  },
  "config": {
    "return": "object",
    "arguments": {}
  },
  "custodianActivityImportFilePaths": {
    "return": [
      "string"
    ],
    "arguments": {}
  },
  "custodianSnapshotImportFilePaths": {
    "return": [
      "object"
    ],
    "arguments": {}
  },
  "custodianUsersImportFilePath": {
    "return": "object",
    "arguments": {}
  },
  "customerName": {
    "return": "string",
    "arguments": {}
  },
  "default": {
    "return": "boolean",
    "arguments": {}
  },
  "disabledFlagTypes": {
    "return": [
      "string"
    ],
    "arguments": {}
  },
  "enableAccountOpeningSubmission": {
    "return": "boolean",
    "arguments": {}
  },
  "enableAutoReconcileActivities": {
    "return": "boolean",
    "arguments": {}
  },
  "enableAutoReconcilePositions": {
    "return": "boolean",
    "arguments": {}
  },
  "enableCustodianAccountImport": {
    "return": "boolean",
    "arguments": {}
  },
  "enableCustodianActivityImport": {
    "return": "boolean",
    "arguments": {}
  },
  "enableCustodianOrganizationImport": {}
}

CustodianConnectionAccountTypes: string

object
CASH_JOINT
object
CORPORATE_CASH
object
CORPORATE_CHARITY
object
CORPORATE_ESTATE
object
CORPORATE_TRUST
object
FHSA
object
GRSP
object
LIF
object
LIRA
object
LRIF
object
LRSP
object
PERSONAL
object
PRIF
object
RDSP
object
RESP
object
RESP_ADULT
object
RESP_FAMILY
object
RESP_FAMILY_JOINT
object
RESP_SINGLE
object
RESP_SINGLE_JOINT
object
RIF_SPOUSAL
object
RLIF
object
RLSP
object
RRIF
object
RRSP
object
RRSP_SPOUSAL
object
TFSA

CustodianConnectionCurrencyTypes: string

object
CAD
object
USD

CustodianConnectionTypes: string

object
APEX
object
ATB
object
CIBC_MELLON
object
CIIS
object
ENVESTNET
object
FC
object
FUNDSERV
object
IBKR
object
NBIN
object
NO_CONNECTION
object
PERSHING
object
RBC
object
SCHWAB

CustodianConnectionsPaginationAndSorting: object

offSet:
Int
perPage:
Int
sortDesc:
sortField:
Example
{
  "offSet": "number",
  "perPage": "number",
  "sortDesc": "boolean",
  "sortField": "string"
}

CustodianConnectionsQueryFilter: object

accountTypes:
CustodianConnectionAccountTypes
customerName:
default:
inventoryAccount:
moneyAccount:
name:
organizationId:
Example
{
  "accountTypes": [
    "string"
  ],
  "customerName": "string",
  "default": "boolean",
  "inventoryAccount": "object",
  "moneyAccount": "object",
  "name": "string",
  "organizationId": "object"
}

CustodianCustomField: object

Custom Fields processing steps.

key:
object
return:
arguments:
object
value:
object
return:
arguments:
object
Example
{
  "key": {
    "return": "string",
    "arguments": {}
  },
  "value": {
    "return": "string",
    "arguments": {}
  }
}

CustodianExternalTransferTypes: string

object
ALL_IN_CASH
object
ALL_IN_KIND
object
PARTIAL_CASH

CustodianFinancialProduct: object

cusip:
object
return:
arguments:
object
exchangeMic:
object
return:
arguments:
object
isCash:
object
return:
arguments:
object
isin:
object
return:
arguments:
object
primaryAssetClass:
object
return:
arguments:
object
ric:
object
return:
arguments:
object
secondaryAssetClass:
object
return:
arguments:
object
tertiaryAssetClass:
object
return:
arguments:
object
ticker:
object
return:
arguments:
object
translatedName:
object
return:
arguments:
object
Example
{
  "cusip": {
    "return": "string",
    "arguments": {}
  },
  "exchangeMic": {
    "return": "string",
    "arguments": {}
  },
  "isCash": {
    "return": "boolean",
    "arguments": {}
  },
  "isin": {
    "return": "string",
    "arguments": {}
  },
  "primaryAssetClass": {
    "return": {
      "riskLevel": {
        "return": "number",
        "arguments": {}
      },
      "translatedDescription": {
        "return": {
          "en": {
            "return": "string",
            "arguments": {}
          },
          "fr": {
            "return": "string",
            "arguments": {}
          }
        },
        "arguments": {}
      },
      "translatedName": {
        "return": {
          "en": {
            "return": "string",
            "arguments": {}
          },
          "fr": {
            "return": "string",
            "arguments": {}
          }
        },
        "arguments": {}
      }
    },
    "arguments": {}
  },
  "ric": {
    "return": "string",
    "arguments": {}
  },
  "secondaryAssetClass": {
    "return": {
      "riskLevel": {
        "return": "number",
        "arguments": {}
      },
      "translatedDescription": {
        "return": {
          "en": {
            "return": "string",
            "arguments": {}
          },
          "fr": {
            "return": "string",
            "arguments": {}
          }
        },
        "arguments": {}
      },
      "translatedName": {
        "return": {
          "en": {
            "return": "string",
            "arguments": {}
          },
          "fr": {
            "return": "string",
            "arguments": {}
          }
        },
        "arguments": {}
      }
    },
    "arguments": {}
  },
  "tertiaryAssetClass": {
    "return": {
      "riskLevel": {
        "return": "number",
        "arguments": {}
      },
      "translatedDescription": {
        "return": {
          "en": {
            "return": "string",
            "arguments": {}
          },
          "fr": {}
        }
      }
    }
  }
}

CustodianFrequency: string

object
ANNUALLY
object
BI_WEEKLY
object
DAILY
object
MONTHLY
object
QUARTERLY
object
SEMI_ANNUALLY
object
WEEKLY

CustodianInstitution: object

name:
object
return:
arguments:
object
Example
{
  "name": {
    "return": "string",
    "arguments": {}
  }
}

CustodianProjectedIncome: object

amountCents:
object
return:
arguments:
object
currency:
object
return:
arguments:
object
date:
object
return:
arguments:
object
financialProduct:
object
return:
arguments:
object
foreignExchangeRates:
object
return:
CustodianStatisticsForeignExchangeRate
arguments:
object
Example
{
  "amountCents": {
    "return": "object",
    "arguments": {}
  },
  "currency": {
    "return": "string",
    "arguments": {}
  },
  "date": {
    "return": "string",
    "arguments": {}
  },
  "financialProduct": {
    "return": {
      "cusip": {
        "return": "string",
        "arguments": {}
      },
      "exchangeMic": {
        "return": "string",
        "arguments": {}
      },
      "isCash": {
        "return": "boolean",
        "arguments": {}
      },
      "isin": {
        "return": "string",
        "arguments": {}
      },
      "primaryAssetClass": {
        "return": {
          "riskLevel": {
            "return": "number",
            "arguments": {}
          },
          "translatedDescription": {
            "return": {
              "en": {
                "return": "string",
                "arguments": {}
              },
              "fr": {
                "return": "string",
                "arguments": {}
              }
            },
            "arguments": {}
          },
          "translatedName": {
            "return": {
              "en": {
                "return": "string",
                "arguments": {}
              },
              "fr": {
                "return": "string",
                "arguments": {}
              }
            },
            "arguments": {}
          }
        },
        "arguments": {}
      },
      "ric": {
        "return": "string",
        "arguments": {}
      },
      "secondaryAssetClass": {
        "return": {
          "riskLevel": {
            "return": "number",
            "arguments": {}
          },
          "translatedDescription": {
            "return": {
              "en": {
                "return": "string",
                "arguments": {}
              },
              "fr": {
                "return": "string",
                "arguments": {}
              }
            },
            "arguments": {}
          },
          "translatedName": {
            "return": {
              "en": {
                "return": "string",
                "arguments": {}
              },
              "fr": {
                "return": "string",
                "arguments": {}
              }
            },
            "arguments": {}
          }
        },
        "arguments": {}
      }
    }
  }
}

CustodianReconciliationTypes: string

object
FULL
object
HYBRID
object
READ_ONLY

CustodianSnapshotHistory: object

currency:
object
return:
arguments:
object
date:
object
return:
arguments:
object
foreignExchangeRates:
object
return:
CustodianStatisticsForeignExchangeRate
arguments:
object
integrationId:
object
return:
arguments:
object
marketValueCents:
object
return:
arguments:
object
moneyAvailableCents:
object
return:
arguments:
object
netContributionCents:
object
return:
arguments:
object
objectId:
object
return:
arguments:
object
objectType:
object
return:
arguments:
object
Example
{
  "currency": {
    "return": "string",
    "arguments": {}
  },
  "date": {
    "return": "object",
    "arguments": {}
  },
  "foreignExchangeRates": {
    "return": [
      {
        "date": {
          "return": "object",
          "arguments": {}
        },
        "from": {
          "return": "string",
          "arguments": {}
        },
        "rate": {
          "return": "object",
          "arguments": {}
        },
        "to": {
          "return": "string",
          "arguments": {}
        },
        "updatedAt": {
          "return": "object",
          "arguments": {}
        }
      }
    ],
    "arguments": {}
  },
  "integrationId": {
    "return": "string",
    "arguments": {}
  },
  "marketValueCents": {
    "return": "object",
    "arguments": {}
  },
  "moneyAvailableCents": {
    "return": "object",
    "arguments": {}
  },
  "netContributionCents": {
    "return": "object",
    "arguments": {}
  },
  "objectId": {
    "return": "object",
    "arguments": {}
  },
  "objectType": {
    "return": "string",
    "arguments": {}
  }
}

CustodianStatementTypes: string

object
ADMINISTRATIVE_FEES_ANNUAL_REPORT
object
ANNUAL_PERFORMANCE_REPORT
object
MANAGEMENT_FEES_ANNUAL_REPORT
object
MONTHLY_ACCOUNT_STATEMENTS
object
OV_MONTHLY_ACCOUNT_STATEMENTS
object
TAX_SLIPS_FIRST_60_DAYS
object
TAX_SLIPS_LAST_10_MONTHS
object
TAX_SLIPS_NR4
object
TAX_SLIPS_T3_BREAKDOWN
object
TAX_SLIPS_T3_RL16
object
TAX_SLIPS_T4A_RL1
object
TAX_SLIPS_T4RIF_RL2
object
TAX_SLIPS_T4RSP_RL2
object
TAX_SLIPS_T5_RL3
object
TAX_SLIPS_T5008
object
TAX_SLIPS_T5013_RL15
object
TAX_SLIPS_TRADING_SUMMARY
object
TAX_SLIP_GENERAL
object
TRADE_CONFIRMATION

CustodianStatements: object

account:
object
return:
arguments:
object
fileName:
object
return:
arguments:
object
referenceDate:
object
return:
arguments:
object
s3key:
object
return:
arguments:
object
signedUrl:
object
return:
arguments:
object
signedUrlFormat:
object
return:
arguments:
object
translatedFileName:
object
return:
arguments:
object
type:
object
return:
arguments:
object
Example
{
  "account": {
    "return": {
      "affiliations": {
        "return": [
          {
            "allocation": {
              "return": "number",
              "arguments": {}
            },
            "id": {
              "return": "object",
              "arguments": {}
            },
            "relation": {
              "return": "string",
              "arguments": {}
            },
            "signatureRequired": {
              "return": "boolean",
              "arguments": {}
            },
            "type": {
              "return": "string",
              "arguments": {}
            },
            "user": {
              "return": {
                "accessibleBy": {
                  "return": [
                    {
                      "displayOptions": {
                        "return": {
                          "hide": {
                            "return": "boolean",
                            "arguments": {}
                          },
                          "order": {
                            "return": "number",
                            "arguments": {}
                          }
                        },
                        "arguments": {}
                      },
                      "organizationUser": {
                        "return": {
                          "accessType": {
                            "return": "string",
                            "arguments": {}
                          },
                          "apiTokens": {
                            "return": [
                              {
                                "id": {
                                  "return": "object",
                                  "arguments": {}
                                },
                                "jwtToken": {
                                  "return": "string",
                                  "arguments": {}
                                },
                                "name": {
                                  "return": "string",
                                  "arguments": {}
                                },
                                "organization": {
                                  "return": {
                                    "browserTabTitle": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "faviconLink": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "id": {
                                      "return": "object",
                                      "arguments": {}
                                    },
                                    "name": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "parent": {
                                      "return": {
                                        "browserTabTitle": {
                                          "return": "string",
                                          "arguments": {}
                                        },
                                        "faviconLink": {
                                          "return": "string",
                                          "arguments": {}
                                        }
                                      }
                                    }
                                  }
                                }
                              }
                            ]
                          }
                        }
                      }
                    }
                  ]
                }
              }
            }
          }
        ]
      }
    }
  }
}

CustodianStates: string

object
FAILED
object
PROCESSED
object
REQUESTED

CustodianStatistics: object

currency:
object
return:
arguments:
object
depositContributionCents:
object
return:
arguments:
object
eodMarketValueCents:
object
return:
arguments:
object
foreignExchangeRates:
object
return:
CustodianStatisticsForeignExchangeRate
arguments:
object
holdings:
object
return:
CustodianStatisticsHolding
arguments:
object
holdingsMissingRate:
object
return:
CustodianStatisticsHolding
arguments:
object
integrationId:
object
return:
arguments:
object
lastUpdatedAt:
object
return:
arguments:
object
marketValueCents:
object
return:
arguments:
object
maxWithdrawalCents:
object
return:
arguments:
object
minWithdrawalCents:
object
return:
arguments:
object
moneyAvailableCents:
object
return:
arguments:
object
moneyWeightedReturn:
object
return:
arguments:
object
netContributionCents:
object
return:
arguments:
object
objectId:
object
return:
arguments:
object
objectType:
object
return:
arguments:
object
originalCurrencies:
object
return:
CustodianStatisticsOriginalCurrency
arguments:
object
originalCurrenciesMissingRate:
object
return:
CustodianStatisticsOriginalCurrency
arguments:
object
projectedIncome:
object
return:
CustodianProjectedIncome
arguments:
object
endDate:
startDate:
simpleReturnAmountCents:
object
return:
arguments:
object
simpleReturnPercent:
object
return:
arguments:
object
timeWeightedReturn:
object
return:
arguments:
object
withdrawContributionCents:
object
return:
arguments:
object
Example
{
  "currency": {
    "return": "string",
    "arguments": {}
  },
  "depositContributionCents": {
    "return": "number",
    "arguments": {}
  },
  "eodMarketValueCents": {
    "return": "object",
    "arguments": {}
  },
  "foreignExchangeRates": {
    "return": [
      {
        "date": {
          "return": "object",
          "arguments": {}
        },
        "from": {
          "return": "string",
          "arguments": {}
        },
        "rate": {
          "return": "object",
          "arguments": {}
        },
        "to": {
          "return": "string",
          "arguments": {}
        },
        "updatedAt": {
          "return": "object",
          "arguments": {}
        }
      }
    ],
    "arguments": {}
  },
  "holdings": {
    "return": [
      {
        "adjustedCostBaseCents": {
          "return": "object",
          "arguments": {}
        },
        "currency": {
          "return": "string",
          "arguments": {}
        },
        "currentPriceCents": {
          "return": "object",
          "arguments": {}
        },
        "eodPriceCents": {
          "return": "object",
          "arguments": {}
        },
        "eodTotalCents": {
          "return": "object",
          "arguments": {}
        },
        "financialProduct": {
          "return": {
            "cusip": {
              "return": "string",
              "arguments": {}
            },
            "exchangeMic": {
              "return": "string",
              "arguments": {}
            },
            "isCash": {
              "return": "boolean",
              "arguments": {}
            },
            "isin": {
              "return": "string",
              "arguments": {}
            },
            "primaryAssetClass": {
              "return": {
                "riskLevel": {
                  "return": "number",
                  "arguments": {}
                },
                "translatedDescription": {
                  "return": {
                    "en": {
                      "return": "string",
                      "arguments": {}
                    },
                    "fr": {
                      "return": "string",
                      "arguments": {}
                    }
                  },
                  "arguments": {}
                }
              }
            }
          }
        }
      }
    ]
  }
}

CustodianStatisticsCurrencyTypes: string

object
CAD
object
USD

CustodianStatisticsForeignExchangeRate: object

date:
object
return:
arguments:
object
from:
object
return:
arguments:
object
rate:
object
return:
arguments:
object
to:
object
return:
arguments:
object
updatedAt:
object
return:
arguments:
object
Example
{
  "date": {
    "return": "object",
    "arguments": {}
  },
  "from": {
    "return": "string",
    "arguments": {}
  },
  "rate": {
    "return": "object",
    "arguments": {}
  },
  "to": {
    "return": "string",
    "arguments": {}
  },
  "updatedAt": {
    "return": "object",
    "arguments": {}
  }
}

CustodianStatisticsHolding: object

adjustedCostBaseCents:
object
return:
arguments:
object
currency:
object
return:
arguments:
object
currentPriceCents:
object
return:
arguments:
object
eodPriceCents:
object
return:
arguments:
object
eodTotalCents:
object
return:
arguments:
object
financialProduct:
object
return:
arguments:
object
foreignExchangeRate:
object
return:
arguments:
object
lastEodPriceUpdatedAt:
object
return:
arguments:
object
lastPriceUpdatedAt:
object
return:
arguments:
object
originalCurrency:
object
return:
arguments:
object
quantity:
object
return:
arguments:
object
rateOfReturn:
object
return:
arguments:
object
totalCents:
object
return:
arguments:
object
Example
{
  "adjustedCostBaseCents": {
    "return": "object",
    "arguments": {}
  },
  "currency": {
    "return": "string",
    "arguments": {}
  },
  "currentPriceCents": {
    "return": "object",
    "arguments": {}
  },
  "eodPriceCents": {
    "return": "object",
    "arguments": {}
  },
  "eodTotalCents": {
    "return": "object",
    "arguments": {}
  },
  "financialProduct": {
    "return": {
      "cusip": {
        "return": "string",
        "arguments": {}
      },
      "exchangeMic": {
        "return": "string",
        "arguments": {}
      },
      "isCash": {
        "return": "boolean",
        "arguments": {}
      },
      "isin": {
        "return": "string",
        "arguments": {}
      },
      "primaryAssetClass": {
        "return": {
          "riskLevel": {
            "return": "number",
            "arguments": {}
          },
          "translatedDescription": {
            "return": {
              "en": {
                "return": "string",
                "arguments": {}
              },
              "fr": {
                "return": "string",
                "arguments": {}
              }
            },
            "arguments": {}
          },
          "translatedName": {
            "return": {
              "en": {
                "return": "string",
                "arguments": {}
              },
              "fr": {
                "return": "string",
                "arguments": {}
              }
            },
            "arguments": {}
          }
        },
        "arguments": {}
      },
      "ric": {
        "return": "string",
        "arguments": {}
      },
      "secondaryAssetClass": {
        "return": {
          "riskLevel": {
            "return": "number",
            "arguments": {}
          },
          "translatedDescription": {
            "return": {
              "en": {
                "return": "string",
                "arguments": {}
              },
              "fr": {
                "return": "string",
                "arguments": {}
              }
            },
            "arguments": {}
          },
          "translatedName": {
            "return": {
              "en": {}
            }
          }
        }
      }
    }
  }
}

CustodianStatisticsHoldingOriginalCurrency: object

adjustedCostBaseCents:
object
return:
arguments:
object
currency:
object
return:
arguments:
object
currentPriceCents:
object
return:
arguments:
object
eodPriceCents:
object
return:
arguments:
object
totalCents:
object
return:
arguments:
object
Example
{
  "adjustedCostBaseCents": {
    "return": "object",
    "arguments": {}
  },
  "currency": {
    "return": "string",
    "arguments": {}
  },
  "currentPriceCents": {
    "return": "object",
    "arguments": {}
  },
  "eodPriceCents": {
    "return": "object",
    "arguments": {}
  },
  "totalCents": {
    "return": "object",
    "arguments": {}
  }
}

CustodianStatisticsInput: object

currency:
endDate:
startDate:
Example
{
  "currency": "string",
  "endDate": "object",
  "startDate": "object"
}

CustodianStatisticsOriginalCurrency: object

currency:
object
return:
arguments:
object
marketValueCents:
object
return:
arguments:
object
moneyAvailableCents:
object
return:
arguments:
object
netContributionCents:
object
return:
arguments:
object
simpleReturnAmountCents:
object
return:
arguments:
object
Example
{
  "currency": {
    "return": "string",
    "arguments": {}
  },
  "marketValueCents": {
    "return": "object",
    "arguments": {}
  },
  "moneyAvailableCents": {
    "return": "object",
    "arguments": {}
  },
  "netContributionCents": {
    "return": "object",
    "arguments": {}
  },
  "simpleReturnAmountCents": {
    "return": "object",
    "arguments": {}
  }
}

CustodianTransaction: object

account:
object
return:
arguments:
object
bookValueCents:
object
return:
arguments:
object
cashBalance:
object
return:
arguments:
object
currency:
object
return:
arguments:
object
custodianTransactionType:
object
return:
arguments:
object
date:
object
return:
arguments:
object
description:
object
return:
arguments:
object
financialProduct:
object
return:
arguments:
object
priceCents:
object
return:
arguments:
object
quantity:
object
return:
arguments:
object
settleDate:
object
return:
arguments:
object
type:
object
return:
arguments:
object
valueCents:
object
return:
arguments:
object
Example
{
  "account": {
    "return": {
      "affiliations": {
        "return": [
          {
            "allocation": {
              "return": "number",
              "arguments": {}
            },
            "id": {
              "return": "object",
              "arguments": {}
            },
            "relation": {
              "return": "string",
              "arguments": {}
            },
            "signatureRequired": {
              "return": "boolean",
              "arguments": {}
            },
            "type": {
              "return": "string",
              "arguments": {}
            },
            "user": {
              "return": {
                "accessibleBy": {
                  "return": [
                    {
                      "displayOptions": {
                        "return": {
                          "hide": {
                            "return": "boolean",
                            "arguments": {}
                          },
                          "order": {
                            "return": "number",
                            "arguments": {}
                          }
                        },
                        "arguments": {}
                      },
                      "organizationUser": {
                        "return": {
                          "accessType": {
                            "return": "string",
                            "arguments": {}
                          },
                          "apiTokens": {
                            "return": [
                              {
                                "id": {
                                  "return": "object",
                                  "arguments": {}
                                },
                                "jwtToken": {
                                  "return": "string",
                                  "arguments": {}
                                },
                                "name": {
                                  "return": "string",
                                  "arguments": {}
                                },
                                "organization": {
                                  "return": {
                                    "browserTabTitle": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "faviconLink": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "id": {
                                      "return": "object",
                                      "arguments": {}
                                    },
                                    "name": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "parent": {
                                      "return": {
                                        "browserTabTitle": {
                                          "return": "string",
                                          "arguments": {}
                                        },
                                        "faviconLink": {
                                          "return": "string",
                                          "arguments": {}
                                        }
                                      }
                                    }
                                  }
                                }
                              }
                            ]
                          }
                        }
                      }
                    }
                  ]
                }
              }
            }
          }
        ]
      }
    }
  }
}

CustodianTransactionTypes: string

object
ADJUSTMENT
object
BORROW_FEE
object
BUY
object
CANCEL_BUY
object
CANCEL_CORPORATE_ACTION
object
CANCEL_EFT
object
CANCEL_MANAGEMENT_FEE
object
CANCEL_SELL
object
CANCEL_SWITCH_IN
object
CANCEL_SWITCH_OUT
object
CANCEL_TRANSFER
object
CHEQUE
object
CORPORATE_ACTION
object
CUSTODY_FEE
object
DEPOSIT
object
DEPOSIT_BUY
object
DEREGISTRATION_FEE
object
DEREGISTRATION_TAX
object
DISTRIBUTION
object
DISTRIBUTION_REINVESTMENT
object
DIVIDEND
object
EFT
object
EXPENSE
object
EXTERNAL_TRANSFER_IN
object
EXTERNAL_TRANSFER_IN_SECURITY
object
EXTERNAL_TRANSFER_OUT
object
GOV_CONTRIBUTIONS
object
GST
object
HST
object
INCOME
object
INCOME_FUND_TRANSFER
object
INTEREST
object
MANAGEMENT_FEE
object
OTHER
object
RISK_EXPOSURE_FEE
object
SELL
object
SWI_COST
object
SWI_MARKET
object
SWO_COST
object
SWO_MARKET
object
TRANSFER_IN
object
TRANSFER_OUT
object
WITHDRAWAL
object
WITHHOLDING_TAX

CustodianTransfer: object

account:
object
return:
arguments:
object
amountCents:
object
return:
arguments:
object
bankAccount:
object
return:
arguments:
object
createdAt:
object
return:
arguments:
object
financialProduct:
object
return:
arguments:
object
frequency:
object
return:
arguments:
object
scheduledDate:
object
return:
arguments:
object
source:
object
return:
arguments:
object
state:
object
return:
arguments:
object
type:
object
return:
arguments:
object
Example
{
  "account": {
    "return": {
      "affiliations": {
        "return": [
          {
            "allocation": {
              "return": "number",
              "arguments": {}
            },
            "id": {
              "return": "object",
              "arguments": {}
            },
            "relation": {
              "return": "string",
              "arguments": {}
            },
            "signatureRequired": {
              "return": "boolean",
              "arguments": {}
            },
            "type": {
              "return": "string",
              "arguments": {}
            },
            "user": {
              "return": {
                "accessibleBy": {
                  "return": [
                    {
                      "displayOptions": {
                        "return": {
                          "hide": {
                            "return": "boolean",
                            "arguments": {}
                          },
                          "order": {
                            "return": "number",
                            "arguments": {}
                          }
                        },
                        "arguments": {}
                      },
                      "organizationUser": {
                        "return": {
                          "accessType": {
                            "return": "string",
                            "arguments": {}
                          },
                          "apiTokens": {
                            "return": [
                              {
                                "id": {
                                  "return": "object",
                                  "arguments": {}
                                },
                                "jwtToken": {
                                  "return": "string",
                                  "arguments": {}
                                },
                                "name": {
                                  "return": "string",
                                  "arguments": {}
                                },
                                "organization": {
                                  "return": {
                                    "browserTabTitle": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "faviconLink": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "id": {
                                      "return": "object",
                                      "arguments": {}
                                    },
                                    "name": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "parent": {
                                      "return": {
                                        "browserTabTitle": {
                                          "return": "string",
                                          "arguments": {}
                                        },
                                        "faviconLink": {
                                          "return": "string",
                                          "arguments": {}
                                        }
                                      }
                                    }
                                  }
                                }
                              }
                            ]
                          }
                        }
                      }
                    }
                  ]
                }
              }
            }
          }
        ]
      }
    }
  }
}

CustodianTransferState: string

Transfer processing steps.

object
ACTIVE
object
CANCELED
object
FAILED
object
INACTIVE
object
INITIATED
object
PROCESSING
object
READY
object
RECONCILED
object
REQUESTED
object
REVIEWING

CustodianTransferSubmissionTypes: string

object
BATCH
object
EVENT

CustodianTransferType: string

Supported Transfer types.

object
DEPOSIT
object
WITHDRAW

CustodianTypes: string

object
APEX
object
CIBC_MELLON
object
CIIS
object
ENVESTNET
object
FC
object
FUNDSERV
object
IBKR
object
NBIN
object
NO_CONNECTION
object
PERSHING
object
RBC
object
SCHWAB

CustodianUpcomingTransactionsResponse: object

totalTransfersCount:
object
return:
Int
arguments:
object
upcomingTransactions:
object
return:
CustodianTransfer
arguments:
object
Example
{
  "totalTransfersCount": {
    "return": "number",
    "arguments": {}
  },
  "upcomingTransactions": {
    "return": [
      {
        "account": {
          "return": {
            "affiliations": {
              "return": [
                {
                  "allocation": {
                    "return": "number",
                    "arguments": {}
                  },
                  "id": {
                    "return": "object",
                    "arguments": {}
                  },
                  "relation": {
                    "return": "string",
                    "arguments": {}
                  },
                  "signatureRequired": {
                    "return": "boolean",
                    "arguments": {}
                  },
                  "type": {
                    "return": "string",
                    "arguments": {}
                  },
                  "user": {
                    "return": {
                      "accessibleBy": {
                        "return": [
                          {
                            "displayOptions": {
                              "return": {
                                "hide": {
                                  "return": "boolean",
                                  "arguments": {}
                                },
                                "order": {
                                  "return": "number",
                                  "arguments": {}
                                }
                              },
                              "arguments": {}
                            },
                            "organizationUser": {
                              "return": {
                                "accessType": {
                                  "return": "string",
                                  "arguments": {}
                                },
                                "apiTokens": {
                                  "return": [
                                    {
                                      "id": {
                                        "return": "object",
                                        "arguments": {}
                                      },
                                      "jwtToken": {
                                        "return": "string",
                                        "arguments": {}
                                      },
                                      "name": {
                                        "return": "string",
                                        "arguments": {}
                                      },
                                      "organization": {
                                        "return": {
                                          "browserTabTitle": {
                                            "return": "string",
                                            "arguments": {}
                                          },
                                          "faviconLink": {
                                            "return": "string",
                                            "arguments": {}
                                          },
                                          "id": {
                                            "return": "object",
                                            "arguments": {}
                                          },
                                          "name": {
                                            "return": "string",
                                            "arguments": {}
                                          },
                                          "parent": {
                                            "return": {}
                                          }
                                        }
                                      }
                                    }
                                  ]
                                }
                              }
                            }
                          }
                        ]
                      }
                    }
                  }
                }
              ]
            }
          }
        }
      }
    ]
  }
}

CustodianUser: object

dateOfBirth:
object
return:
arguments:
object
firstName:
object
return:
arguments:
object
lastName:
object
return:
arguments:
object
Example
{
  "dateOfBirth": {
    "return": "object",
    "arguments": {}
  },
  "firstName": {
    "return": "string",
    "arguments": {}
  },
  "lastName": {
    "return": "string",
    "arguments": {}
  }
}

CustomField: object

conditionalRules:
object
return:
CustomFieldConditionalRule
arguments:
object
externalField:
object
return:
arguments:
object
format:
object
return:
arguments:
object
id:
object
return:
arguments:
object
key:
object
return:
arguments:
object
objectType:
object
return:
arguments:
object
organization:
object
return:
arguments:
object
selectOptions:
object
return:
CustomFieldSelectOption
arguments:
object
state:
object
return:
arguments:
object
translatedDescription:
object
return:
arguments:
object
translatedName:
object
return:
arguments:
object
type:
object
return:
arguments:
object
workflowStep:
object
return:
arguments:
object
Example
{
  "conditionalRules": {
    "return": [
      {
        "comparison": {
          "return": "string",
          "arguments": {}
        },
        "field": {
          "return": "string",
          "arguments": {}
        },
        "value": {
          "return": "string",
          "arguments": {}
        }
      }
    ],
    "arguments": {}
  },
  "externalField": {
    "return": "string",
    "arguments": {}
  },
  "format": {
    "return": "string",
    "arguments": {}
  },
  "id": {
    "return": "object",
    "arguments": {}
  },
  "key": {
    "return": "string",
    "arguments": {}
  },
  "objectType": {
    "return": "string",
    "arguments": {}
  },
  "organization": {
    "return": {
      "browserTabTitle": {
        "return": "string",
        "arguments": {}
      },
      "faviconLink": {
        "return": "string",
        "arguments": {}
      },
      "id": {
        "return": "object",
        "arguments": {}
      },
      "name": {
        "return": "string",
        "arguments": {}
      },
      "parent": {
        "return": {
          "browserTabTitle": {
            "return": "string",
            "arguments": {}
          },
          "faviconLink": {
            "return": "string",
            "arguments": {}
          },
          "id": {
            "return": "object",
            "arguments": {}
          },
          "name": {
            "return": "string",
            "arguments": {}
          },
          "parent": {
            "return": {
              "browserTabTitle": {
                "return": "string",
                "arguments": {}
              },
              "faviconLink": {
                "return": "string",
                "arguments": {}
              },
              "id": {
                "return": "object",
                "arguments": {}
              },
              "name": {
                "return": "string",
                "arguments": {}
              },
              "parent": {
                "return": {
                  "browserTabTitle": {}
                }
              }
            }
          }
        }
      }
    }
  }
}

CustomFieldConditionalRule: object

comparison:
object
return:
arguments:
object
field:
object
return:
arguments:
object
value:
object
return:
arguments:
object
Example
{
  "comparison": {
    "return": "string",
    "arguments": {}
  },
  "field": {
    "return": "string",
    "arguments": {}
  },
  "value": {
    "return": "string",
    "arguments": {}
  }
}

CustomFieldConditionalRuleInput: object

comparison:
field:
value:
Example
{
  "comparison": "string",
  "field": "object",
  "value": "object"
}

CustomFieldConditionalRulesComparisonTypes: string

object
EQUALS
object
GREATER_THAN
object
GREATER_THAN_AGO
object
IN
object
INCLUDES
object
LESS_THAN
object
LESS_THAN_AGO
object
NOT_EQUALS
object
NOT_IN
object
NOT_INCLUDES

CustomFieldFormats: string

object
CHECKBOX
object
CURRENCY
object
DATE
object
DATE_TIME
object
DROPDOWN_LIST
object
EMAIL
object
NUMBER
object
PHONE
object
PHYSICAL_ADDRESS
object
RADIO_BUTTON
object
SEARCH_LIST
object
SIMPLE_TEXT
object
TEXT_AREA
object
TOGGLE_SWITCH

CustomFieldInput: object

key:
value:
Example
{
  "key": "object",
  "value": "object"
}

CustomFieldObjectTypes: string

object
ACCOUNT
object
ENTITY
object
GOAL
object
HOUSEHOLD
object
SUB_ACCOUNT

CustomFieldQueryFilter: object

keys:
String
objectType:
organizationId:
type:
workflowStep:
Example
{
  "keys": [
    "string"
  ],
  "objectType": "string",
  "organizationId": "object",
  "type": "string",
  "workflowStep": "string"
}

CustomFieldSelectOption: object

displayText:
object
return:
arguments:
object
value:
object
return:
arguments:
object
Example
{
  "displayText": {
    "return": {
      "en": {
        "return": "string",
        "arguments": {}
      },
      "fr": {
        "return": "string",
        "arguments": {}
      }
    },
    "arguments": {}
  },
  "value": {
    "return": "object",
    "arguments": {}
  }
}

CustomFieldSelectOptionInput: object

displayText:
value:
Example
{
  "displayText": {
    "en": "object",
    "fr": "object"
  },
  "value": "object"
}

CustomFieldSelectedOption: object

displayText:
object
return:
arguments:
object
value:
object
return:
arguments:
object
Example
{
  "displayText": {
    "return": {
      "en": {
        "return": "string",
        "arguments": {}
      },
      "fr": {
        "return": "string",
        "arguments": {}
      }
    },
    "arguments": {}
  },
  "value": {
    "return": "object",
    "arguments": {}
  }
}

CustomFieldSource: string

object
CUSTODIAN

CustomFieldStates: string

object
ACTIVE
object
ARCHIVED

CustomFieldTransitions: string

object
archive

CustomFieldTypes: string

object
BOOLEAN
object
CUSTOM_OBJECT
object
DATE
object
DECIMAL
object
INTEGER
object
MULTIPLE_SELECT
object
SINGLE_SELECT
object
TEXT

CustomFieldValue: object

customField:
object
return:
arguments:
object
key:
object
return:
arguments:
object
selectedOptions:
object
return:
CustomFieldSelectedOption
arguments:
object
value:
object
return:
arguments:
object
Example
{
  "customField": {
    "return": {
      "conditionalRules": {
        "return": [
          {
            "comparison": {
              "return": "string",
              "arguments": {}
            },
            "field": {
              "return": "string",
              "arguments": {}
            },
            "value": {
              "return": "string",
              "arguments": {}
            }
          }
        ],
        "arguments": {}
      },
      "externalField": {
        "return": "string",
        "arguments": {}
      },
      "format": {
        "return": "string",
        "arguments": {}
      },
      "id": {
        "return": "object",
        "arguments": {}
      },
      "key": {
        "return": "string",
        "arguments": {}
      },
      "objectType": {
        "return": "string",
        "arguments": {}
      },
      "organization": {
        "return": {
          "browserTabTitle": {
            "return": "string",
            "arguments": {}
          },
          "faviconLink": {
            "return": "string",
            "arguments": {}
          },
          "id": {
            "return": "object",
            "arguments": {}
          },
          "name": {
            "return": "string",
            "arguments": {}
          },
          "parent": {
            "return": {
              "browserTabTitle": {
                "return": "string",
                "arguments": {}
              },
              "faviconLink": {
                "return": "string",
                "arguments": {}
              },
              "id": {
                "return": "object",
                "arguments": {}
              },
              "name": {
                "return": "string",
                "arguments": {}
              },
              "parent": {
                "return": {
                  "browserTabTitle": {
                    "return": "string",
                    "arguments": {}
                  },
                  "faviconLink": {
                    "return": "string",
                    "arguments": {}
                  },
                  "id": {
                    "return": "object",
                    "arguments": {}
                  },
                  "name": {
                    "return": "string",
                    "arguments": {}
                  },
                  "parent": {}
                }
              }
            }
          }
        }
      }
    }
  }
}

CustomFieldWorkflowSteps: string

object
APPROVAL
object
DOCUMENTS
object
EDIT_ACCOUNT
object
EDIT_GOAL
object
EMPLOYMENT_INFORMATION
object
HOUSEHOLD
object
NON_INDIVIDUAL_INFORMATION
object
PERSONAL_INFORMATION
object
PERSONS_OF_INTEREST

DailySnapshot: object

cashOnHoldToTradeCents:
object
return:
arguments:
object
cashOnHoldToWithdrawCents:
object
return:
arguments:
object
currency:
object
return:
arguments:
object
date:
object
return:
arguments:
object
foreignExchangeRates:
object
return:
SnapshotForeignExchangeRate
arguments:
object
holdings:
object
return:
SnapshotHolding
arguments:
object
holdingsMissingRate:
object
return:
SnapshotHolding
arguments:
object
id:
object
return:
arguments:
object
marketValueCents:
object
return:
arguments:
object
moneyAvailableCents:
object
return:
arguments:
object
netContributionCents:
object
return:
arguments:
object
newContributionCents:
object
return:
arguments:
object
objectType:
object
return:
arguments:
object
originalCurrencies:
object
return:
DailySnapshotOriginalCurrency
arguments:
object
originalCurrenciesMissingRate:
object
return:
DailySnapshotOriginalCurrency
arguments:
object
snapshotAt:
object
return:
arguments:
object
Example
{
  "cashOnHoldToTradeCents": {
    "return": "object",
    "arguments": {}
  },
  "cashOnHoldToWithdrawCents": {
    "return": "object",
    "arguments": {}
  },
  "currency": {
    "return": "string",
    "arguments": {}
  },
  "date": {
    "return": "object",
    "arguments": {}
  },
  "foreignExchangeRates": {
    "return": [
      {
        "date": {
          "return": "object",
          "arguments": {}
        },
        "from": {
          "return": "string",
          "arguments": {}
        },
        "organization": {
          "return": "object",
          "arguments": {}
        },
        "rate": {
          "return": "number",
          "arguments": {}
        },
        "to": {
          "return": "string",
          "arguments": {}
        },
        "updatedAt": {
          "return": "object",
          "arguments": {}
        }
      }
    ],
    "arguments": {}
  },
  "holdings": {
    "return": [
      {
        "adjustedCostBaseCents": {
          "return": "number",
          "arguments": {}
        },
        "currency": {
          "return": "string",
          "arguments": {}
        },
        "financialProduct": {
          "return": {
            "assignable": {
              "return": "boolean",
              "arguments": {}
            },
            "autoUpdatePrices": {
              "return": "boolean",
              "arguments": {}
            },
            "children": {
              "return": [
                {
                  "financialProduct": {
                    "return": {
                      "assignable": {
                        "return": "boolean",
                        "arguments": {}
                      },
                      "autoUpdatePrices": {
                        "return": "boolean",
                        "arguments": {}
                      },
                      "children": {
                        "return": [
                          {
                            "financialProduct": {
                              "return": {
                                "assignable": {
                                  "return": "boolean",
                                  "arguments": {}
                                },
                                "autoUpdatePrices": {
                                  "return": "boolean",
                                  "arguments": {}
                                },
                                "children": {}
                              }
                            }
                          }
                        ]
                      }
                    }
                  }
                }
              ]
            }
          }
        }
      }
    ]
  }
}

DailySnapshotHolding: object

currentPriceCents:
object
return:
Int
arguments:
object
financialProduct:
object
return:
arguments:
object
newUnitsBought:
object
return:
arguments:
object
priceCentsPerNewUnit:
object
return:
arguments:
object
quantity:
object
return:
arguments:
object
totalCents:
object
return:
arguments:
object
totalUnitsBought:
object
return:
arguments:
object
Example
{
  "currentPriceCents": {
    "return": "number",
    "arguments": {}
  },
  "financialProduct": {
    "return": {
      "assignable": {
        "return": "boolean",
        "arguments": {}
      },
      "autoUpdatePrices": {
        "return": "boolean",
        "arguments": {}
      },
      "children": {
        "return": [
          {
            "financialProduct": {
              "return": {
                "assignable": {
                  "return": "boolean",
                  "arguments": {}
                },
                "autoUpdatePrices": {
                  "return": "boolean",
                  "arguments": {}
                },
                "children": {
                  "return": [
                    {
                      "financialProduct": {
                        "return": {
                          "assignable": {
                            "return": "boolean",
                            "arguments": {}
                          },
                          "autoUpdatePrices": {
                            "return": "boolean",
                            "arguments": {}
                          },
                          "children": {
                            "return": [
                              {
                                "financialProduct": {
                                  "return": {
                                    "assignable": {
                                      "return": "boolean",
                                      "arguments": {}
                                    },
                                    "autoUpdatePrices": {
                                      "return": "boolean",
                                      "arguments": {}
                                    },
                                    "children": {
                                      "return": [
                                        {
                                          "financialProduct": {
                                            "return": {
                                              "assignable": {
                                                "return": "boolean",
                                                "arguments": {}
                                              },
                                              "autoUpdatePrices": {
                                                "return": "boolean",
                                                "arguments": {}
                                              },
                                              "children": {
                                                "return": [
                                                  {
                                                    "financialProduct": {
                                                      "return": {
                                                        "assignable": {
                                                          "return": "boolean",
                                                          "arguments": {}
                                                        },
                                                        "autoUpdatePrices": {
                                                          "return": "boolean",
                                                          "arguments": {}
                                                        },
                                                        "children": {
                                                          "return": [
                                                            {
                                                              "financialProduct": {
                                                                "return": {
                                                                  "assignable": {}
                                                                }
                                                              }
                                                            }
                                                          ]
                                                        }
                                                      }
                                                    }
                                                  }
                                                ]
                                              }
                                            }
                                          }
                                        }
                                      ]
                                    }
                                  }
                                }
                              }
                            ]
                          }
                        }
                      }
                    }
                  ]
                }
              }
            }
          }
        ]
      }
    }
  }
}

DailySnapshotHoldingV2: object

currentPriceCents:
object
return:
Int
arguments:
object
financialProduct:
object
return:
arguments:
object
quantity:
object
return:
arguments:
object
totalCents:
object
return:
arguments:
object
Example
{
  "currentPriceCents": {
    "return": "number",
    "arguments": {}
  },
  "financialProduct": {
    "return": {
      "assignable": {
        "return": "boolean",
        "arguments": {}
      },
      "autoUpdatePrices": {
        "return": "boolean",
        "arguments": {}
      },
      "children": {
        "return": [
          {
            "financialProduct": {
              "return": {
                "assignable": {
                  "return": "boolean",
                  "arguments": {}
                },
                "autoUpdatePrices": {
                  "return": "boolean",
                  "arguments": {}
                },
                "children": {
                  "return": [
                    {
                      "financialProduct": {
                        "return": {
                          "assignable": {
                            "return": "boolean",
                            "arguments": {}
                          },
                          "autoUpdatePrices": {
                            "return": "boolean",
                            "arguments": {}
                          },
                          "children": {
                            "return": [
                              {
                                "financialProduct": {
                                  "return": {
                                    "assignable": {
                                      "return": "boolean",
                                      "arguments": {}
                                    },
                                    "autoUpdatePrices": {
                                      "return": "boolean",
                                      "arguments": {}
                                    },
                                    "children": {
                                      "return": [
                                        {
                                          "financialProduct": {
                                            "return": {
                                              "assignable": {
                                                "return": "boolean",
                                                "arguments": {}
                                              },
                                              "autoUpdatePrices": {
                                                "return": "boolean",
                                                "arguments": {}
                                              },
                                              "children": {
                                                "return": [
                                                  {
                                                    "financialProduct": {
                                                      "return": {
                                                        "assignable": {
                                                          "return": "boolean",
                                                          "arguments": {}
                                                        },
                                                        "autoUpdatePrices": {
                                                          "return": "boolean",
                                                          "arguments": {}
                                                        },
                                                        "children": {
                                                          "return": [
                                                            {
                                                              "financialProduct": {
                                                                "return": {
                                                                  "assignable": {}
                                                                }
                                                              }
                                                            }
                                                          ]
                                                        }
                                                      }
                                                    }
                                                  }
                                                ]
                                              }
                                            }
                                          }
                                        }
                                      ]
                                    }
                                  }
                                }
                              }
                            ]
                          }
                        }
                      }
                    }
                  ]
                }
              }
            }
          }
        ]
      }
    }
  }
}

DailySnapshotOriginalCurrency: object

cashOnHoldToTradeCents:
object
return:
arguments:
object
cashOnHoldToWithdrawCents:
object
return:
arguments:
object
currency:
object
return:
arguments:
object
marketValueCents:
object
return:
arguments:
object
moneyAvailableCents:
object
return:
arguments:
object
netContributionCents:
object
return:
arguments:
object
newContributionCents:
object
return:
arguments:
object
Example
{
  "cashOnHoldToTradeCents": {
    "return": "object",
    "arguments": {}
  },
  "cashOnHoldToWithdrawCents": {
    "return": "object",
    "arguments": {}
  },
  "currency": {
    "return": "string",
    "arguments": {}
  },
  "marketValueCents": {
    "return": "object",
    "arguments": {}
  },
  "moneyAvailableCents": {
    "return": "object",
    "arguments": {}
  },
  "netContributionCents": {
    "return": "object",
    "arguments": {}
  },
  "newContributionCents": {
    "return": "object",
    "arguments": {}
  }
}

DailyStatsTypes: string

object
ACCOUNTS_DAILY
object
CLIENT_GROUPS_DAILY
object
GOALS_DAILY
object
SUB_ACCOUNTS_DAILY
object
USERS_DAILY

Dashboard: object

archived:
object
return:
arguments:
object
id:
object
return:
arguments:
object
name:
object
return:
arguments:
object
organization:
object
return:
arguments:
object
widgets:
object
return:
Widget
arguments:
object
Example
{
  "archived": {
    "return": "boolean",
    "arguments": {}
  },
  "id": {
    "return": "object",
    "arguments": {}
  },
  "name": {
    "return": "string",
    "arguments": {}
  },
  "organization": {
    "return": {
      "browserTabTitle": {
        "return": "string",
        "arguments": {}
      },
      "faviconLink": {
        "return": "string",
        "arguments": {}
      },
      "id": {
        "return": "object",
        "arguments": {}
      },
      "name": {
        "return": "string",
        "arguments": {}
      },
      "parent": {
        "return": {
          "browserTabTitle": {
            "return": "string",
            "arguments": {}
          },
          "faviconLink": {
            "return": "string",
            "arguments": {}
          },
          "id": {
            "return": "object",
            "arguments": {}
          },
          "name": {
            "return": "string",
            "arguments": {}
          },
          "parent": {
            "return": {
              "browserTabTitle": {
                "return": "string",
                "arguments": {}
              },
              "faviconLink": {
                "return": "string",
                "arguments": {}
              },
              "id": {
                "return": "object",
                "arguments": {}
              },
              "name": {
                "return": "string",
                "arguments": {}
              },
              "parent": {
                "return": {
                  "browserTabTitle": {
                    "return": "string",
                    "arguments": {}
                  },
                  "faviconLink": {
                    "return": "string",
                    "arguments": {}
                  },
                  "id": {
                    "return": "object",
                    "arguments": {}
                  },
                  "name": {
                    "return": "string",
                    "arguments": {}
                  },
                  "parent": {
                    "return": {
                      "browserTabTitle": {
                        "return": "string",
                        "arguments": {}
                      },
                      "faviconLink": {
                        "return": "string",
                        "arguments": {}
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

DashboardPaginationAndSorting: object

offSet:
Int
perPage:
Int
sortDesc:
sortField:
Example
{
  "offSet": "number",
  "perPage": "number",
  "sortDesc": "boolean",
  "sortField": "string"
}

DashboardQueryFilter: object

archived:
organizationId:
Example
{
  "archived": "boolean",
  "organizationId": "object"
}

DataApiExport: object

columns:
object
return:
DataApiExportColumn
arguments:
object
datasetPath:
object
return:
arguments:
object
fileName:
object
return:
arguments:
object
fileUrl:
object
return:
arguments:
object
filter:
object
return:
arguments:
object
id:
object
return:
arguments:
object
organizationUser:
object
return:
arguments:
object
perPage:
object
return:
Int
arguments:
object
progress:
object
return:
arguments:
object
queryPath:
object
return:
arguments:
object
sortDesc:
object
return:
arguments:
object
sortField:
object
return:
arguments:
object
state:
object
return:
arguments:
object
Example
{
  "columns": {
    "return": [
      {
        "formatter": {
          "return": "string",
          "arguments": {}
        },
        "gqlAlias": {
          "return": "string",
          "arguments": {}
        },
        "header": {
          "return": "string",
          "arguments": {}
        }
      }
    ],
    "arguments": {}
  },
  "datasetPath": {
    "return": "string",
    "arguments": {}
  },
  "fileName": {
    "return": "string",
    "arguments": {}
  },
  "fileUrl": {
    "return": "string",
    "arguments": {}
  },
  "filter": {
    "return": "object",
    "arguments": {}
  },
  "id": {
    "return": "object",
    "arguments": {}
  },
  "organizationUser": {
    "return": {
      "email": {
        "return": "string",
        "arguments": {}
      },
      "firstName": {
        "return": "string",
        "arguments": {}
      },
      "id": {
        "return": "object",
        "arguments": {}
      },
      "language": {
        "return": "string",
        "arguments": {}
      },
      "lastName": {
        "return": "string",
        "arguments": {}
      },
      "organization": {
        "return": {
          "browserTabTitle": {
            "return": "string",
            "arguments": {}
          },
          "faviconLink": {
            "return": "string",
            "arguments": {}
          },
          "id": {
            "return": "object",
            "arguments": {}
          },
          "name": {
            "return": "string",
            "arguments": {}
          },
          "parent": {
            "return": {
              "browserTabTitle": {
                "return": "string",
                "arguments": {}
              },
              "faviconLink": {
                "return": "string",
                "arguments": {}
              },
              "id": {
                "return": "object",
                "arguments": {}
              },
              "name": {
                "return": "string",
                "arguments": {}
              },
              "parent": {}
            }
          }
        }
      }
    }
  }
}

DataApiExportColumn: object

formatter:
object
return:
arguments:
object
gqlAlias:
object
return:
arguments:
object
header:
object
return:
arguments:
object
Example
{
  "formatter": {
    "return": "string",
    "arguments": {}
  },
  "gqlAlias": {
    "return": "string",
    "arguments": {}
  },
  "header": {
    "return": "string",
    "arguments": {}
  }
}

DataExport: object

columns:
object
return:
String
arguments:
object
fileUrl:
object
return:
arguments:
object
filters:
object
return:
ReportFilter
arguments:
object
id:
object
return:
arguments:
object
organizationUser:
object
return:
arguments:
object
sortDesc:
object
return:
arguments:
object
sortField:
object
return:
arguments:
object
state:
object
return:
arguments:
object
type:
object
return:
arguments:
object
Example
{
  "columns": {
    "return": [
      "string"
    ],
    "arguments": {}
  },
  "fileUrl": {
    "return": "string",
    "arguments": {}
  },
  "filters": {
    "return": [
      {
        "comparison": {
          "return": "string",
          "arguments": {}
        },
        "field": {
          "return": "string",
          "arguments": {}
        },
        "value": {
          "return": "string",
          "arguments": {}
        }
      }
    ],
    "arguments": {}
  },
  "id": {
    "return": "object",
    "arguments": {}
  },
  "organizationUser": {
    "return": {
      "email": {
        "return": "string",
        "arguments": {}
      },
      "firstName": {
        "return": "string",
        "arguments": {}
      },
      "id": {
        "return": "object",
        "arguments": {}
      },
      "language": {
        "return": "string",
        "arguments": {}
      },
      "lastName": {
        "return": "string",
        "arguments": {}
      },
      "organization": {
        "return": {
          "browserTabTitle": {
            "return": "string",
            "arguments": {}
          },
          "faviconLink": {
            "return": "string",
            "arguments": {}
          },
          "id": {
            "return": "object",
            "arguments": {}
          },
          "name": {
            "return": "string",
            "arguments": {}
          },
          "parent": {
            "return": {
              "browserTabTitle": {
                "return": "string",
                "arguments": {}
              },
              "faviconLink": {
                "return": "string",
                "arguments": {}
              },
              "id": {
                "return": "object",
                "arguments": {}
              },
              "name": {
                "return": "string",
                "arguments": {}
              },
              "parent": {
                "return": {
                  "browserTabTitle": {
                    "return": "string",
                    "arguments": {}
                  },
                  "faviconLink": {}
                }
              }
            }
          }
        }
      }
    }
  }
}

DataExportStates: string

object
COMPLETED
object
FAILED
object
GENERATING

DataReport: object

accessType:
object
return:
arguments:
object
author:
object
return:
arguments:
object
columns:
object
return:
String
arguments:
object
filters:
object
return:
ReportFilter
arguments:
object
id:
object
return:
arguments:
object
name:
object
return:
arguments:
object
organization:
object
return:
arguments:
object
sortDesc:
object
return:
arguments:
object
sortField:
object
return:
arguments:
object
type:
object
return:
arguments:
object
Example
{
  "accessType": {
    "return": "string",
    "arguments": {}
  },
  "author": {
    "return": {
      "email": {
        "return": "string",
        "arguments": {}
      },
      "firstName": {
        "return": "string",
        "arguments": {}
      },
      "id": {
        "return": "object",
        "arguments": {}
      },
      "language": {
        "return": "string",
        "arguments": {}
      },
      "lastName": {
        "return": "string",
        "arguments": {}
      },
      "organization": {
        "return": {
          "browserTabTitle": {
            "return": "string",
            "arguments": {}
          },
          "faviconLink": {
            "return": "string",
            "arguments": {}
          },
          "id": {
            "return": "object",
            "arguments": {}
          },
          "name": {
            "return": "string",
            "arguments": {}
          },
          "parent": {
            "return": {
              "browserTabTitle": {
                "return": "string",
                "arguments": {}
              },
              "faviconLink": {
                "return": "string",
                "arguments": {}
              },
              "id": {
                "return": "object",
                "arguments": {}
              },
              "name": {
                "return": "string",
                "arguments": {}
              },
              "parent": {
                "return": {
                  "browserTabTitle": {
                    "return": "string",
                    "arguments": {}
                  },
                  "faviconLink": {
                    "return": "string",
                    "arguments": {}
                  },
                  "id": {
                    "return": "object",
                    "arguments": {}
                  },
                  "name": {
                    "return": "string",
                    "arguments": {}
                  },
                  "parent": {
                    "return": {
                      "browserTabTitle": {
                        "return": "string",
                        "arguments": {}
                      },
                      "faviconLink": {
                        "return": "string",
                        "arguments": {}
                      },
                      "id": {
                        "return": "object",
                        "arguments": {}
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

Date: object

A date string, such as 2007-12-03, compliant with the full-date format outlined in section 5.6 of the RFC 3339 profile of the ISO 8601 standard for representation of dates and times using the Gregorian calendar.

Example
object

DateTime: object

A date-time string at UTC, such as 2007-12-03T10:15:30Z, compliant with the date-time format outlined in section 5.6 of the RFC 3339 profile of the ISO 8601 standard for representation of dates and times using the Gregorian calendar.

Example
object

DebtAssociated: string

Supported types of debt

object
CREDIT_CARD
object
MORTGAGE
object
STUDENT_LOAN

DeleteArticleImageInput: object

articleId:
Example
{
  "articleId": "object"
}

DeleteArticleImageResponse: object

article:
object
return:
arguments:
object
Example
{
  "article": {
    "return": {
      "articleUrl": {
        "return": "object",
        "arguments": {}
      },
      "createdAt": {
        "return": "object",
        "arguments": {}
      },
      "createdBy": {
        "return": {
          "email": {
            "return": "string",
            "arguments": {}
          },
          "firstName": {
            "return": "string",
            "arguments": {}
          },
          "id": {
            "return": "object",
            "arguments": {}
          },
          "language": {
            "return": "string",
            "arguments": {}
          },
          "lastName": {
            "return": "string",
            "arguments": {}
          },
          "organization": {
            "return": {
              "browserTabTitle": {
                "return": "string",
                "arguments": {}
              },
              "faviconLink": {
                "return": "string",
                "arguments": {}
              },
              "id": {
                "return": "object",
                "arguments": {}
              },
              "name": {
                "return": "string",
                "arguments": {}
              },
              "parent": {
                "return": {
                  "browserTabTitle": {
                    "return": "string",
                    "arguments": {}
                  },
                  "faviconLink": {
                    "return": "string",
                    "arguments": {}
                  },
                  "id": {
                    "return": "object",
                    "arguments": {}
                  },
                  "name": {
                    "return": "string",
                    "arguments": {}
                  },
                  "parent": {
                    "return": {
                      "browserTabTitle": {
                        "return": "string",
                        "arguments": {}
                      },
                      "faviconLink": {
                        "return": "string",
                        "arguments": {}
                      },
                      "id": {
                        "return": "object",
                        "arguments": {}
                      },
                      "name": {
                        "return": "string",
                        "arguments": {}
                      },
                      "parent": {
                        "return": {
                          "browserTabTitle": {
                            "return": "string",
                            "arguments": {}
                          },
                          "faviconLink": {}
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

DeleteArticleResponse: object

deleted:
object
return:
arguments:
object
Example
{
  "deleted": {
    "return": "boolean",
    "arguments": {}
  }
}

DeleteBankAccountResponse: object

bankAccount:
object
return:
arguments:
object
Example
{
  "bankAccount": {
    "return": {
      "EftEligibleRatio": {
        "return": "number",
        "arguments": {}
      },
      "bankAccountNumber": {
        "return": "string",
        "arguments": {}
      },
      "bankAccountNumberDisclosed": {
        "return": "string",
        "arguments": {}
      },
      "createdAt": {
        "return": "object",
        "arguments": {}
      },
      "downloadUrls": {
        "return": [
          "string"
        ],
        "arguments": {}
      },
      "id": {
        "return": "object",
        "arguments": {}
      },
      "institutionNumber": {
        "return": "string",
        "arguments": {}
      },
      "name": {
        "return": "string",
        "arguments": {}
      },
      "source": {
        "return": "string",
        "arguments": {}
      },
      "state": {
        "return": "string",
        "arguments": {}
      },
      "stateChanges": {
        "return": [
          "object"
        ],
        "arguments": {}
      },
      "transitNumber": {
        "return": "string",
        "arguments": {}
      },
      "transitNumberDisclosed": {
        "return": "string",
        "arguments": {}
      },
      "updatedAt": {
        "return": "object",
        "arguments": {}
      },
      "user": {
        "return": {
          "accessibleBy": {
            "return": [
              {
                "displayOptions": {
                  "return": {
                    "hide": {
                      "return": "boolean",
                      "arguments": {}
                    },
                    "order": {
                      "return": "number",
                      "arguments": {}
                    }
                  },
                  "arguments": {}
                },
                "organizationUser": {
                  "return": {
                    "accessType": {
                      "return": "string",
                      "arguments": {}
                    },
                    "apiTokens": {
                      "return": [
                        {
                          "id": {
                            "return": "object",
                            "arguments": {}
                          },
                          "jwtToken": {
                            "return": "string",
                            "arguments": {}
                          }
                        }
                      ]
                    }
                  }
                }
              }
            ]
          }
        }
      }
    }
  }
}

DeleteFileDocumentInput: object

fileDocumentId:

fileDocumentId associated with the note which is updating

Example
{
  "fileDocumentId": "object"
}

DeleteFileDocumentResponse: object

fileDocument:
object
return:
arguments:
object
Example
{
  "fileDocument": {
    "return": {
      "createdAt": {
        "return": "object",
        "arguments": {}
      },
      "creator": {
        "return": {
          "email": {
            "return": "string",
            "arguments": {}
          },
          "firstName": {
            "return": "string",
            "arguments": {}
          },
          "id": {
            "return": "object",
            "arguments": {}
          },
          "language": {
            "return": "string",
            "arguments": {}
          },
          "lastName": {
            "return": "string",
            "arguments": {}
          },
          "organization": {
            "return": {
              "browserTabTitle": {
                "return": "string",
                "arguments": {}
              },
              "faviconLink": {
                "return": "string",
                "arguments": {}
              },
              "id": {
                "return": "object",
                "arguments": {}
              },
              "name": {
                "return": "string",
                "arguments": {}
              },
              "parent": {
                "return": {
                  "browserTabTitle": {
                    "return": "string",
                    "arguments": {}
                  },
                  "faviconLink": {
                    "return": "string",
                    "arguments": {}
                  },
                  "id": {
                    "return": "object",
                    "arguments": {}
                  },
                  "name": {
                    "return": "string",
                    "arguments": {}
                  },
                  "parent": {
                    "return": {
                      "browserTabTitle": {
                        "return": "string",
                        "arguments": {}
                      },
                      "faviconLink": {
                        "return": "string",
                        "arguments": {}
                      },
                      "id": {
                        "return": "object",
                        "arguments": {}
                      },
                      "name": {
                        "return": "string",
                        "arguments": {}
                      },
                      "parent": {
                        "return": {
                          "browserTabTitle": {
                            "return": "string",
                            "arguments": {}
                          },
                          "faviconLink": {
                            "return": "string",
                            "arguments": {}
                          },
                          "id": {}
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

DeleteImportFileInput: object

importFileId:
Example
{
  "importFileId": "object"
}

DeleteImportFileResponse: object

importFile:
object
return:
arguments:
object
Example
{
  "importFile": {
    "return": {
      "bulkImport": {
        "return": {
          "createdAt": {
            "return": "object",
            "arguments": {}
          },
          "id": {
            "return": "object",
            "arguments": {}
          },
          "name": {
            "return": "string",
            "arguments": {}
          },
          "organization": {
            "return": {
              "browserTabTitle": {
                "return": "string",
                "arguments": {}
              },
              "faviconLink": {
                "return": "string",
                "arguments": {}
              },
              "id": {
                "return": "object",
                "arguments": {}
              },
              "name": {
                "return": "string",
                "arguments": {}
              },
              "parent": {
                "return": {
                  "browserTabTitle": {
                    "return": "string",
                    "arguments": {}
                  },
                  "faviconLink": {
                    "return": "string",
                    "arguments": {}
                  },
                  "id": {
                    "return": "object",
                    "arguments": {}
                  },
                  "name": {
                    "return": "string",
                    "arguments": {}
                  },
                  "parent": {
                    "return": {
                      "browserTabTitle": {
                        "return": "string",
                        "arguments": {}
                      },
                      "faviconLink": {
                        "return": "string",
                        "arguments": {}
                      },
                      "id": {
                        "return": "object",
                        "arguments": {}
                      },
                      "name": {
                        "return": "string",
                        "arguments": {}
                      },
                      "parent": {
                        "return": {
                          "browserTabTitle": {
                            "return": "string",
                            "arguments": {}
                          },
                          "faviconLink": {
                            "return": "string",
                            "arguments": {}
                          },
                          "id": {
                            "return": "object",
                            "arguments": {}
                          },
                          "name": {
                            "return": "string",
                            "arguments": {}
                          },
                          "parent": {
                            "return": {
                              "browserTabTitle": {}
                            }
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

DeleteInstitutionInput: object

id:
ID

This an ID created by the partner, that is submitted with a request to create a new Institution and unique to each request.

Example
{
  "id": "object"
}

DeleteInstitutionResponse: object

institution:
object
return:
arguments:
object
Example
{
  "institution": {
    "return": {
      "createdAt": {
        "return": "object",
        "arguments": {}
      },
      "id": {
        "return": "object",
        "arguments": {}
      },
      "isDraft": {
        "return": "string",
        "arguments": {}
      },
      "name": {
        "return": "string",
        "arguments": {}
      },
      "physicalAddress": {
        "return": {
          "city": {
            "return": "string",
            "arguments": {}
          },
          "country": {
            "return": "string",
            "arguments": {}
          },
          "houseNumber": {
            "return": "string",
            "arguments": {}
          },
          "jurisdiction": {
            "return": "string",
            "arguments": {}
          },
          "neighborhood": {
            "return": "string",
            "arguments": {}
          },
          "postal": {
            "return": "string",
            "arguments": {}
          },
          "province": {
            "return": "string",
            "arguments": {}
          },
          "streetName": {
            "return": "string",
            "arguments": {}
          },
          "unitNumber": {
            "return": "string",
            "arguments": {}
          }
        },
        "arguments": {}
      },
      "state": {
        "return": "string",
        "arguments": {}
      },
      "stateChanges": {
        "return": [
          "object"
        ],
        "arguments": {}
      },
      "updatedAt": {
        "return": "object",
        "arguments": {}
      }
    },
    "arguments": {}
  }
}

DeleteNotificationDefinitionInput: object

notificationDefinitionId:
Example
{
  "notificationDefinitionId": "object"
}

DeleteNotificationGroupInput: object

notificationGroupId:
Example
{
  "notificationGroupId": "object"
}

DeleteOrganizationDashboardInput: object

dashboardId:
Example
{
  "dashboardId": "object"
}

DeleteOrganizationDashboardResponse: object

dashboard:
object
return:
arguments:
object
Example
{
  "dashboard": {
    "return": {
      "archived": {
        "return": "boolean",
        "arguments": {}
      },
      "id": {
        "return": "object",
        "arguments": {}
      },
      "name": {
        "return": "string",
        "arguments": {}
      },
      "organization": {
        "return": {
          "browserTabTitle": {
            "return": "string",
            "arguments": {}
          },
          "faviconLink": {
            "return": "string",
            "arguments": {}
          },
          "id": {
            "return": "object",
            "arguments": {}
          },
          "name": {
            "return": "string",
            "arguments": {}
          },
          "parent": {
            "return": {
              "browserTabTitle": {
                "return": "string",
                "arguments": {}
              },
              "faviconLink": {
                "return": "string",
                "arguments": {}
              },
              "id": {
                "return": "object",
                "arguments": {}
              },
              "name": {
                "return": "string",
                "arguments": {}
              },
              "parent": {
                "return": {
                  "browserTabTitle": {
                    "return": "string",
                    "arguments": {}
                  },
                  "faviconLink": {
                    "return": "string",
                    "arguments": {}
                  },
                  "id": {
                    "return": "object",
                    "arguments": {}
                  },
                  "name": {
                    "return": "string",
                    "arguments": {}
                  },
                  "parent": {
                    "return": {
                      "browserTabTitle": {
                        "return": "string",
                        "arguments": {}
                      },
                      "faviconLink": {
                        "return": "string",
                        "arguments": {}
                      },
                      "id": {
                        "return": "object",
                        "arguments": {}
                      },
                      "name": {
                        "return": "string",
                        "arguments": {}
                      },
                      "parent": {
                        "return": {
                          "browserTabTitle": {
                            "return": "string",
                            "arguments": {}
                          },
                          "faviconLink": {}
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

DeleteOrganizationUserResponse: object

deleted:
object
return:
arguments:
object
Example
{
  "deleted": {
    "return": "boolean",
    "arguments": {}
  }
}

DeleteReportInput: object

reportId:
Example
{
  "reportId": "object"
}

DeleteReportResponse: object

success:
object
return:
arguments:
object
Example
{
  "success": {
    "return": "boolean",
    "arguments": {}
  }
}

DeleteRoleResponse: object

deleted:
object
return:
arguments:
object
Example
{
  "deleted": {
    "return": "boolean",
    "arguments": {}
  }
}

DeleteTransactionResponse: object

transaction:
object
return:
arguments:
object
Example
{
  "transaction": {
    "return": {
      "account": {
        "return": {
          "affiliations": {
            "return": [
              {
                "allocation": {
                  "return": "number",
                  "arguments": {}
                },
                "id": {
                  "return": "object",
                  "arguments": {}
                },
                "relation": {
                  "return": "string",
                  "arguments": {}
                },
                "signatureRequired": {
                  "return": "boolean",
                  "arguments": {}
                },
                "type": {
                  "return": "string",
                  "arguments": {}
                },
                "user": {
                  "return": {
                    "accessibleBy": {
                      "return": [
                        {
                          "displayOptions": {
                            "return": {
                              "hide": {
                                "return": "boolean",
                                "arguments": {}
                              },
                              "order": {
                                "return": "number",
                                "arguments": {}
                              }
                            },
                            "arguments": {}
                          },
                          "organizationUser": {
                            "return": {
                              "accessType": {
                                "return": "string",
                                "arguments": {}
                              },
                              "apiTokens": {
                                "return": [
                                  {
                                    "id": {
                                      "return": "object",
                                      "arguments": {}
                                    },
                                    "jwtToken": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "name": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "organization": {
                                      "return": {
                                        "browserTabTitle": {
                                          "return": "string",
                                          "arguments": {}
                                        },
                                        "faviconLink": {
                                          "return": "string",
                                          "arguments": {}
                                        },
                                        "id": {
                                          "return": "object",
                                          "arguments": {}
                                        },
                                        "name": {
                                          "return": "string",
                                          "arguments": {}
                                        },
                                        "parent": {
                                          "return": {
                                            "browserTabTitle": {
                                              "return": "string",
                                              "arguments": {}
                                            },
                                            "faviconLink": {}
                                          }
                                        }
                                      }
                                    }
                                  }
                                ]
                              }
                            }
                          }
                        }
                      ]
                    }
                  }
                }
              }
            ]
          }
        }
      }
    }
  }
}

DeleteWebhookResponse: object

message:
object
return:
arguments:
object
webhook:
object
return:
arguments:
object
Example
{
  "message": {
    "return": "string",
    "arguments": {}
  },
  "webhook": {
    "return": {
      "customHeaders": {
        "return": "object",
        "arguments": {}
      },
      "customPayloadAttributes": {
        "return": "object",
        "arguments": {}
      },
      "eventType": {
        "return": "string",
        "arguments": {}
      },
      "gql": {
        "return": "string",
        "arguments": {}
      },
      "id": {
        "return": "object",
        "arguments": {}
      },
      "mutationInputName": {
        "return": "string",
        "arguments": {}
      },
      "mutationName": {
        "return": "string",
        "arguments": {}
      },
      "objectType": {
        "return": "string",
        "arguments": {}
      },
      "organization": {
        "return": {
          "accountTypeTaxRanks": {
            "return": [
              {
                "accountType": {
                  "return": "string",
                  "arguments": {}
                },
                "id": {
                  "return": "object",
                  "arguments": {}
                },
                "taxRank": {
                  "return": "number",
                  "arguments": {}
                }
              }
            ],
            "arguments": {}
          },
          "allowAccessToSubOrganizations": {
            "return": "boolean",
            "arguments": {}
          },
          "allowDirectCommunication": {
            "return": "boolean",
            "arguments": {}
          },
          "allowInactiveUserAdjustments": {
            "return": "boolean",
            "arguments": {}
          },
          "allowInactiveUserFeeCalculation": {
            "return": "boolean",
            "arguments": {}
          },
          "allowInactiveUserRebalancing": {
            "return": "boolean",
            "arguments": {}
          },
          "allowInstantInvest": {
            "return": "boolean",
            "arguments": {}
          },
          "allowPortfolioPerGoal": {
            "return": "boolean",
            "arguments": {}
          },
          "allowPostOptimizationEditing": {
            "return": "boolean",
            "arguments": {}
          },
          "allowViewSubTradeRequestPairs": {
            "return": "boolean",
            "arguments": {}
          },
          "applicableJurisdictions": {
            "return": {
              "all": {}
            }
          }
        }
      }
    }
  }
}

EmploymentSituation: string

object
OTHER
object
SOMEWHAT_STABLE
object
STABLE_AND_SECURE
object
STABLE_BUT_MAY_CHANGE_IN_FUTURE
object
UNEMPLOYED_BUT_LOOKING

EmploymentStatus: string

Supported employment statuses

object
EMPLOYED
object
RETIRED
object
SELF_EMPLOYED
object
STAY_AT_HOME_PARENT
object
STUDENT
object
UNEMPLOYED

EnabledJurisdictions: object

all:
object

If set, all jurisdictions are enabled, the "only" attribute does not apply.

return:
arguments:
object
only:
object

List of enabled jurisdictions. Applicable when all=false. Example: [CA_AB, CA_BC] or [US_WY] (ISO 3166-2 Subdivision Codes).

return:
JurisdictionCodes
arguments:
object
Example
{
  "all": {
    "return": "boolean",
    "arguments": {}
  },
  "only": {
    "return": [
      "string"
    ],
    "arguments": {}
  }
}

EnabledJurisdictionsInput: object

all:

If set, all jurisdictions are enabled, the "only" attribute does not apply.

only:
JurisdictionCodes

List of enabled jurisdictions. Applicable when all=false. Example: [CA_AB, CA_BC] or [US_WY] (ISO 3166-2 Subdivision Codes).

Example
{
  "all": "boolean",
  "only": [
    "string"
  ]
}

EndLiquidationInput: object

subAccountId:
Example
{
  "subAccountId": "object"
}

EndLiquidationResponse: object

subAccount:
object
return:
arguments:
object
Example
{
  "subAccount": {
    "return": {
      "acceptableFinancialProduct": {
        "return": "boolean",
        "arguments": {}
      },
      "account": {
        "return": {
          "affiliations": {
            "return": [
              {
                "allocation": {
                  "return": "number",
                  "arguments": {}
                },
                "id": {
                  "return": "object",
                  "arguments": {}
                },
                "relation": {
                  "return": "string",
                  "arguments": {}
                },
                "signatureRequired": {
                  "return": "boolean",
                  "arguments": {}
                },
                "type": {
                  "return": "string",
                  "arguments": {}
                },
                "user": {
                  "return": {
                    "accessibleBy": {
                      "return": [
                        {
                          "displayOptions": {
                            "return": {
                              "hide": {
                                "return": "boolean",
                                "arguments": {}
                              },
                              "order": {
                                "return": "number",
                                "arguments": {}
                              }
                            },
                            "arguments": {}
                          },
                          "organizationUser": {
                            "return": {
                              "accessType": {
                                "return": "string",
                                "arguments": {}
                              },
                              "apiTokens": {
                                "return": [
                                  {
                                    "id": {
                                      "return": "object",
                                      "arguments": {}
                                    },
                                    "jwtToken": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "name": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "organization": {
                                      "return": {
                                        "browserTabTitle": {
                                          "return": "string",
                                          "arguments": {}
                                        },
                                        "faviconLink": {
                                          "return": "string",
                                          "arguments": {}
                                        },
                                        "id": {
                                          "return": "object",
                                          "arguments": {}
                                        },
                                        "name": {
                                          "return": "string",
                                          "arguments": {}
                                        },
                                        "parent": {
                                          "return": {
                                            "browserTabTitle": {}
                                          }
                                        }
                                      }
                                    }
                                  }
                                ]
                              }
                            }
                          }
                        }
                      ]
                    }
                  }
                }
              }
            ]
          }
        }
      }
    }
  }
}

EntityOrganizationUser: object

displayOptions:
object
return:
arguments:
object
organizationUser:
object
return:
arguments:
object
readOnly:
object
return:
arguments:
object
relation:
object
return:
arguments:
object
Example
{
  "displayOptions": {
    "return": {
      "hide": {
        "return": "boolean",
        "arguments": {}
      },
      "order": {
        "return": "number",
        "arguments": {}
      }
    },
    "arguments": {}
  },
  "organizationUser": {
    "return": {
      "accessType": {
        "return": "string",
        "arguments": {}
      },
      "apiTokens": {
        "return": [
          {
            "id": {
              "return": "object",
              "arguments": {}
            },
            "jwtToken": {
              "return": "string",
              "arguments": {}
            },
            "name": {
              "return": "string",
              "arguments": {}
            },
            "organization": {
              "return": {
                "browserTabTitle": {
                  "return": "string",
                  "arguments": {}
                },
                "faviconLink": {
                  "return": "string",
                  "arguments": {}
                },
                "id": {
                  "return": "object",
                  "arguments": {}
                },
                "name": {
                  "return": "string",
                  "arguments": {}
                },
                "parent": {
                  "return": {
                    "browserTabTitle": {
                      "return": "string",
                      "arguments": {}
                    },
                    "faviconLink": {
                      "return": "string",
                      "arguments": {}
                    },
                    "id": {
                      "return": "object",
                      "arguments": {}
                    },
                    "name": {
                      "return": "string",
                      "arguments": {}
                    },
                    "parent": {
                      "return": {
                        "browserTabTitle": {
                          "return": "string",
                          "arguments": {}
                        },
                        "faviconLink": {
                          "return": "string",
                          "arguments": {}
                        },
                        "id": {
                          "return": "object",
                          "arguments": {}
                        },
                        "name": {
                          "return": "string",
                          "arguments": {}
                        },
                        "parent": {
                          "return": {
                            "browserTabTitle": {
                              "return": "string",
                              "arguments": {}
                            }
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        ]
      }
    }
  }
}

EntityOrganizationUserDisplayOptions: object

hide:
object
return:
arguments:
object
order:
object
return:
Int
arguments:
object
Example
{
  "hide": {
    "return": "boolean",
    "arguments": {}
  },
  "order": {
    "return": "number",
    "arguments": {}
  }
}

EntityTypes: string

object
INDIVIDUAL
object
INVESTMENT_FUND
object
OTHER
object
PARTNERSHIP
object
PRIVATE_COMPANY
object
PUBLICLY_LISTED_ENTITY
object
REGULATED_ENTITY
object
SOLE_PROPRIETORSHIP
object
TRUST

EodFile: object

name:
object
return:
arguments:
object
url:
object
return:
arguments:
object
Example
{
  "name": {
    "return": "string",
    "arguments": {}
  },
  "url": {
    "return": "string",
    "arguments": {}
  }
}

Event: object

createdAt:
object

The date the Event was created.

return:
arguments:
object
eventType:
object

The type of the Event.

return:
arguments:
object
extraData:
object
return:
arguments:
object
id:
object

This is the Event ID and it is auto-generated by OneVest for each Event.

return:
arguments:
object
objectId:
object

The ID of the Account, User, Transfer or Order related to this Event.

return:
arguments:
object
objectPayload:
object

Custom payload

return:
arguments:
object
objectType:
object

The object of the Event. Account, User, Transfer or Order.

return:
arguments:
object
Example
{
  "createdAt": {
    "return": "object",
    "arguments": {}
  },
  "eventType": {
    "return": "string",
    "arguments": {}
  },
  "extraData": {
    "return": "string",
    "arguments": {}
  },
  "id": {
    "return": "object",
    "arguments": {}
  },
  "objectId": {
    "return": "object",
    "arguments": {}
  },
  "objectPayload": {
    "return": "object",
    "arguments": {}
  },
  "objectType": {
    "return": "string",
    "arguments": {}
  }
}

EventObject: string

Possible objects of an Event.

object
Account
object
AccountStatement
object
AdministrativeAnnualFeeReport
object
Job
object
ManagementAnnualFeeReport
object
ScheduledTransfer
object
SubAccount
object
TaxSlip
object
Transfer
object
User

EventPaginationAndSorting: object

offSet:
Int
perPage:
Int
sortDesc:
sortField:
Example
{
  "offSet": "number",
  "perPage": "number",
  "sortDesc": "boolean",
  "sortField": "string"
}

EventType: string

Possible Event types.

object
ACTIVE
object
APPROVED
object
AWAITING_APPROVAL
object
AWAITING_REVIEW
object
CANCELED
object
COMPLETED
object
CREATED
object
DELETED
object
FAILED
object
FROZEN
object
INACTIVE
object
INITIATED
object
INTEGRATION_UPDATE
object
LOGIN_CREDENTIALS_UPDATED
object
OTHER
object
PERSONAL_ACCOUNT_INFORMATION_UPDATED
object
PERSONAL_INFORMATION_UPDATED
object
PROCESSING
object
READY
object
RECONCILED
object
RECONCILIATION
object
REQUESTED
object
RESIGNED
object
REVIEWING
object
SIGNED
object
SUBMITTED
object
SUITABILITY_REVIEW_DUE
object
SUITABILITY_SCORE_UPDATED
object
UPDATED
object
USER_ID_CHECK_UPDATED

EventsQueryFilter: object

createdAtAfter:
createdAtBefore:
eventType:
objectId:
objectType:
organizationId:
userId:
webhookId:
Example
{
  "createdAtAfter": "object",
  "createdAtBefore": "object",
  "eventType": "string",
  "objectId": "object",
  "objectType": "string",
  "organizationId": "object",
  "userId": "object",
  "webhookId": "object"
}

ExchangeClientTokenInput: object

externalClientRefreshToken:
externalClientToken:
organizationId:

Organization ID or subdomain

Example
{
  "externalClientRefreshToken": "object",
  "externalClientToken": "object",
  "organizationId": "object"
}

ExchangeClientTokenResponse: object

accessToken:
object
return:
arguments:
object
Example
{
  "accessToken": {
    "return": "string",
    "arguments": {}
  }
}

Exchanges: string

object
CANNEX
object
CBOE
object
CHX
object
CME
object
FUNDSERV
object
ISE
object
MS4X
object
NASDAQ
object
NYSE
object
PHLX
object
PRIVATE_SECURITY
object
PTF
object
TSX
object
TSX_V

ExpectedPrimaryAssetClassHoldings: object

assetClass:
object

This is the primary asset class of the model portfolio

return:
arguments:
object
expectedSecondaryAssetClassHoldings:
object

This is the secondary asset class list of this primary asset class

return:
ExpectedSecondaryAssetClassHoldings
arguments:
object
percentage:
object

This is the primary asset class percentage

return:
arguments:
object
Example
{
  "assetClass": {
    "return": {
      "description": {
        "return": "string",
        "arguments": {}
      },
      "id": {
        "return": "object",
        "arguments": {}
      },
      "includeCash": {
        "return": "boolean",
        "arguments": {}
      },
      "key": {
        "return": "string",
        "arguments": {}
      },
      "name": {
        "return": "string",
        "arguments": {}
      },
      "state": {
        "return": "string",
        "arguments": {}
      },
      "translatedDescription": {
        "return": {
          "en": {
            "return": "string",
            "arguments": {}
          },
          "fr": {
            "return": "string",
            "arguments": {}
          }
        },
        "arguments": {}
      },
      "translatedName": {
        "return": {
          "en": {
            "return": "string",
            "arguments": {}
          },
          "fr": {
            "return": "string",
            "arguments": {}
          }
        },
        "arguments": {}
      }
    },
    "arguments": {}
  },
  "expectedSecondaryAssetClassHoldings": {
    "return": [
      {
        "assetClass": {
          "return": {
            "description": {
              "return": "string",
              "arguments": {}
            },
            "id": {
              "return": "object",
              "arguments": {}
            },
            "includeCash": {
              "return": "boolean",
              "arguments": {}
            },
            "key": {
              "return": "string",
              "arguments": {}
            },
            "name": {
              "return": "string",
              "arguments": {}
            },
            "state": {
              "return": "string",
              "arguments": {}
            },
            "translatedDescription": {
              "return": {
                "en": {
                  "return": "string",
                  "arguments": {}
                },
                "fr": {
                  "return": "string",
                  "arguments": {}
                }
              },
              "arguments": {}
            },
            "translatedName": {
              "return": {
                "en": {}
              }
            }
          }
        }
      }
    ]
  }
}

ExpectedSecondaryAssetClassHoldings: object

assetClass:
object

This is the secondary asset class of a certain primary asset class

return:
arguments:
object
expectedSecurityHoldings:
object

This is the security holdings list of this secondary asset class

return:
ExpectedSecurityHoldings
arguments:
object
percentage:
object

This is the secondary asset class percentage

return:
arguments:
object
Example
{
  "assetClass": {
    "return": {
      "description": {
        "return": "string",
        "arguments": {}
      },
      "id": {
        "return": "object",
        "arguments": {}
      },
      "includeCash": {
        "return": "boolean",
        "arguments": {}
      },
      "key": {
        "return": "string",
        "arguments": {}
      },
      "name": {
        "return": "string",
        "arguments": {}
      },
      "state": {
        "return": "string",
        "arguments": {}
      },
      "translatedDescription": {
        "return": {
          "en": {
            "return": "string",
            "arguments": {}
          },
          "fr": {
            "return": "string",
            "arguments": {}
          }
        },
        "arguments": {}
      },
      "translatedName": {
        "return": {
          "en": {
            "return": "string",
            "arguments": {}
          },
          "fr": {
            "return": "string",
            "arguments": {}
          }
        },
        "arguments": {}
      }
    },
    "arguments": {}
  },
  "expectedSecurityHoldings": {
    "return": [
      {
        "financialProduct": {
          "return": {
            "assignable": {
              "return": "boolean",
              "arguments": {}
            },
            "autoUpdatePrices": {
              "return": "boolean",
              "arguments": {}
            },
            "children": {
              "return": [
                {
                  "financialProduct": {
                    "return": {
                      "assignable": {
                        "return": "boolean",
                        "arguments": {}
                      },
                      "autoUpdatePrices": {
                        "return": "boolean",
                        "arguments": {}
                      },
                      "children": {
                        "return": [
                          {
                            "financialProduct": {
                              "return": {
                                "assignable": {
                                  "return": "boolean",
                                  "arguments": {}
                                },
                                "autoUpdatePrices": {
                                  "return": "boolean",
                                  "arguments": {}
                                },
                                "children": {
                                  "return": [
                                    null
                                  ]
                                }
                              }
                            }
                          }
                        ]
                      }
                    }
                  }
                }
              ]
            }
          }
        }
      }
    ]
  }
}

ExpectedSecurityHoldings: object

financialProduct:
object

This is the financial product related to this security holding

return:
arguments:
object
percentage:
object

This is the percentage allocated to this security holding

return:
arguments:
object
Example
{
  "financialProduct": {
    "return": {
      "assignable": {
        "return": "boolean",
        "arguments": {}
      },
      "autoUpdatePrices": {
        "return": "boolean",
        "arguments": {}
      },
      "children": {
        "return": [
          {
            "financialProduct": {
              "return": {
                "assignable": {
                  "return": "boolean",
                  "arguments": {}
                },
                "autoUpdatePrices": {
                  "return": "boolean",
                  "arguments": {}
                },
                "children": {
                  "return": [
                    {
                      "financialProduct": {
                        "return": {
                          "assignable": {
                            "return": "boolean",
                            "arguments": {}
                          },
                          "autoUpdatePrices": {
                            "return": "boolean",
                            "arguments": {}
                          },
                          "children": {
                            "return": [
                              {
                                "financialProduct": {
                                  "return": {
                                    "assignable": {
                                      "return": "boolean",
                                      "arguments": {}
                                    },
                                    "autoUpdatePrices": {
                                      "return": "boolean",
                                      "arguments": {}
                                    },
                                    "children": {
                                      "return": [
                                        {
                                          "financialProduct": {
                                            "return": {
                                              "assignable": {
                                                "return": "boolean",
                                                "arguments": {}
                                              },
                                              "autoUpdatePrices": {
                                                "return": "boolean",
                                                "arguments": {}
                                              },
                                              "children": {
                                                "return": [
                                                  {
                                                    "financialProduct": {
                                                      "return": {
                                                        "assignable": {
                                                          "return": "boolean",
                                                          "arguments": {}
                                                        },
                                                        "autoUpdatePrices": {
                                                          "return": "boolean",
                                                          "arguments": {}
                                                        },
                                                        "children": {
                                                          "return": [
                                                            {
                                                              "financialProduct": {
                                                                "return": {
                                                                  "assignable": {
                                                                    "return": "boolean",
                                                                    "arguments": {}
                                                                  },
                                                                  "autoUpdatePrices": {}
                                                                }
                                                              }
                                                            }
                                                          ]
                                                        }
                                                      }
                                                    }
                                                  }
                                                ]
                                              }
                                            }
                                          }
                                        }
                                      ]
                                    }
                                  }
                                }
                              }
                            ]
                          }
                        }
                      }
                    }
                  ]
                }
              }
            }
          }
        ]
      }
    }
  }
}

ExportApiReportColumnInput: object

formatter:
gqlAlias:
header:
Example
{
  "formatter": "string",
  "gqlAlias": "object",
  "header": "object"
}

ExportApiReportInput: object

columns:
ExportApiReportColumnInput
datasetPath:
fileName:
filter:
gql:
perPage:
Int
queryPath:
sortDesc:
sortField:
Example
{
  "columns": [
    {
      "formatter": "string",
      "gqlAlias": "object",
      "header": "object"
    }
  ],
  "datasetPath": "object",
  "fileName": "object",
  "filter": "object",
  "gql": "object",
  "perPage": "number",
  "queryPath": "object",
  "sortDesc": "boolean",
  "sortField": "object"
}

ExportApiReportResponse: object

apiExport:
object
return:
arguments:
object
Example
{
  "apiExport": {
    "return": {
      "columns": {
        "return": [
          {
            "formatter": {
              "return": "string",
              "arguments": {}
            },
            "gqlAlias": {
              "return": "string",
              "arguments": {}
            },
            "header": {
              "return": "string",
              "arguments": {}
            }
          }
        ],
        "arguments": {}
      },
      "datasetPath": {
        "return": "string",
        "arguments": {}
      },
      "fileName": {
        "return": "string",
        "arguments": {}
      },
      "fileUrl": {
        "return": "string",
        "arguments": {}
      },
      "filter": {
        "return": "object",
        "arguments": {}
      },
      "id": {
        "return": "object",
        "arguments": {}
      },
      "organizationUser": {
        "return": {
          "email": {
            "return": "string",
            "arguments": {}
          },
          "firstName": {
            "return": "string",
            "arguments": {}
          },
          "id": {
            "return": "object",
            "arguments": {}
          },
          "language": {
            "return": "string",
            "arguments": {}
          },
          "lastName": {
            "return": "string",
            "arguments": {}
          },
          "organization": {
            "return": {
              "browserTabTitle": {
                "return": "string",
                "arguments": {}
              },
              "faviconLink": {
                "return": "string",
                "arguments": {}
              },
              "id": {
                "return": "object",
                "arguments": {}
              },
              "name": {
                "return": "string",
                "arguments": {}
              },
              "parent": {
                "return": {
                  "browserTabTitle": {
                    "return": "string",
                    "arguments": {}
                  },
                  "faviconLink": {
                    "return": "string",
                    "arguments": {}
                  },
                  "id": {
                    "return": "object",
                    "arguments": {}
                  },
                  "name": {}
                }
              }
            }
          }
        }
      }
    }
  }
}

ExportReportInput: object

columns:
SafeString
filters:
ReportFilterInput
sortDesc:
sortField:
type:
Example
{
  "columns": [
    "object"
  ],
  "filters": [
    {
      "comparison": "string",
      "field": "string",
      "value": "string"
    }
  ],
  "sortDesc": "boolean",
  "sortField": "object",
  "type": "string"
}

ExportReportResponse: object

export:
object
return:
arguments:
object
Example
{
  "export": {
    "return": {
      "columns": {
        "return": [
          "string"
        ],
        "arguments": {}
      },
      "fileUrl": {
        "return": "string",
        "arguments": {}
      },
      "filters": {
        "return": [
          {
            "comparison": {
              "return": "string",
              "arguments": {}
            },
            "field": {
              "return": "string",
              "arguments": {}
            },
            "value": {
              "return": "string",
              "arguments": {}
            }
          }
        ],
        "arguments": {}
      },
      "id": {
        "return": "object",
        "arguments": {}
      },
      "organizationUser": {
        "return": {
          "email": {
            "return": "string",
            "arguments": {}
          },
          "firstName": {
            "return": "string",
            "arguments": {}
          },
          "id": {
            "return": "object",
            "arguments": {}
          },
          "language": {
            "return": "string",
            "arguments": {}
          },
          "lastName": {
            "return": "string",
            "arguments": {}
          },
          "organization": {
            "return": {
              "browserTabTitle": {
                "return": "string",
                "arguments": {}
              },
              "faviconLink": {
                "return": "string",
                "arguments": {}
              },
              "id": {
                "return": "object",
                "arguments": {}
              },
              "name": {
                "return": "string",
                "arguments": {}
              },
              "parent": {
                "return": {
                  "browserTabTitle": {
                    "return": "string",
                    "arguments": {}
                  },
                  "faviconLink": {
                    "return": "string",
                    "arguments": {}
                  },
                  "id": {
                    "return": "object",
                    "arguments": {}
                  },
                  "name": {
                    "return": "string",
                    "arguments": {}
                  },
                  "parent": {
                    "return": {
                      "browserTabTitle": {}
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

ExportSubTradeRequestsInput: object

bulkTradeRequestId:
sourceId:
Example
{
  "bulkTradeRequestId": "object",
  "sourceId": "object"
}

ExternalProvider: object

bankingConnectorProvider:
object
return:
arguments:
object
id:
object
return:
arguments:
object
idVerificationProvider:
object
return:
arguments:
object
organization:
object
return:
arguments:
object
Example
{
  "bankingConnectorProvider": {
    "return": {
      "clientIframeUrl": {
        "return": "string",
        "arguments": {}
      },
      "customerId": {
        "return": "string",
        "arguments": {}
      },
      "instanceId": {
        "return": "string",
        "arguments": {}
      },
      "vendor": {
        "return": "string",
        "arguments": {}
      }
    },
    "arguments": {}
  },
  "id": {
    "return": "object",
    "arguments": {}
  },
  "idVerificationProvider": {
    "return": {
      "templateId": {
        "return": "string",
        "arguments": {}
      },
      "vendor": {
        "return": "string",
        "arguments": {}
      }
    },
    "arguments": {}
  },
  "organization": {
    "return": {
      "accountTypeTaxRanks": {
        "return": [
          {
            "accountType": {
              "return": "string",
              "arguments": {}
            },
            "id": {
              "return": "object",
              "arguments": {}
            },
            "taxRank": {
              "return": "number",
              "arguments": {}
            }
          }
        ],
        "arguments": {}
      },
      "allowAccessToSubOrganizations": {
        "return": "boolean",
        "arguments": {}
      },
      "allowDirectCommunication": {
        "return": "boolean",
        "arguments": {}
      },
      "allowInactiveUserAdjustments": {
        "return": "boolean",
        "arguments": {}
      },
      "allowInactiveUserFeeCalculation": {
        "return": "boolean",
        "arguments": {}
      },
      "allowInactiveUserRebalancing": {
        "return": "boolean",
        "arguments": {}
      },
      "allowInstantInvest": {
        "return": "boolean",
        "arguments": {}
      },
      "allowPortfolioPerGoal": {
        "return": "boolean",
        "arguments": {}
      },
      "allowPostOptimizationEditing": {
        "return": "boolean",
        "arguments": {}
      },
      "allowViewSubTradeRequestPairs": {
        "return": "boolean",
        "arguments": {}
      },
      "applicableJurisdictions": {
        "return": {
          "all": {
            "return": "boolean",
            "arguments": {}
          }
        }
      }
    }
  }
}

ExternalProviderType: string

object
BANK_ACCOUNT_CHECK
object
CREDIT_FILE_CHECK
object
ID_CHECK

ExternalProviders: string

object
FLINKS
object
PERSONA

ExternalTransferTypes: string

object
ALL_IN_CASH
object
ALL_IN_KIND
object
PARTIAL_CASH

ExternalVendorUsage: object

id:
object
return:
arguments:
object
organization:
object

Organization that the user belongs to

return:
arguments:
object
provider:
object

External API provider

return:
arguments:
object
type:
object

Type of usage

return:
arguments:
object
Example
{
  "id": {
    "return": "object",
    "arguments": {}
  },
  "organization": {
    "return": {
      "accountTypeTaxRanks": {
        "return": [
          {
            "accountType": {
              "return": "string",
              "arguments": {}
            },
            "id": {
              "return": "object",
              "arguments": {}
            },
            "taxRank": {
              "return": "number",
              "arguments": {}
            }
          }
        ],
        "arguments": {}
      },
      "allowAccessToSubOrganizations": {
        "return": "boolean",
        "arguments": {}
      },
      "allowDirectCommunication": {
        "return": "boolean",
        "arguments": {}
      },
      "allowInactiveUserAdjustments": {
        "return": "boolean",
        "arguments": {}
      },
      "allowInactiveUserFeeCalculation": {
        "return": "boolean",
        "arguments": {}
      },
      "allowInactiveUserRebalancing": {
        "return": "boolean",
        "arguments": {}
      },
      "allowInstantInvest": {
        "return": "boolean",
        "arguments": {}
      },
      "allowPortfolioPerGoal": {
        "return": "boolean",
        "arguments": {}
      },
      "allowPostOptimizationEditing": {
        "return": "boolean",
        "arguments": {}
      },
      "allowViewSubTradeRequestPairs": {
        "return": "boolean",
        "arguments": {}
      },
      "applicableJurisdictions": {
        "return": {
          "all": {
            "return": "boolean",
            "arguments": {}
          },
          "only": {
            "return": [
              "string"
            ],
            "arguments": {}
          }
        },
        "arguments": {}
      },
      "applicableLocalization": {
        "return": {
          "countries": {
            "return": [
              "string"
            ],
            "arguments": {}
          },
          "dateFormat": {
            "return": "string",
            "arguments": {}
          },
          "defaultCurrency": {
            "return": "string",
            "arguments": {}
          },
          "defaultLanguage": {
            "return": "string",
            "arguments": {}
          },
          "id": {
            "return": "object",
            "arguments": {}
          },
          "languages": {
            "return": [
              null
            ]
          }
        }
      }
    }
  }
}

ExternalVendorUsageFilter: object

organizationId:

Organization ID that you would to filter users under

provider:

External API provider

type:

External api usage type

Example
{
  "organizationId": "object",
  "provider": "string",
  "type": "string"
}

ExternalVendorUsageFilterPaginationAndSorting: object

offSet:
Int
perPage:
Int
sortDesc:
sortField:
Example
{
  "offSet": "number",
  "perPage": "number",
  "sortDesc": "boolean",
  "sortField": "string"
}

FATCAStatus: string

Supported FATCAStatus types

object
ACTIVE_NFFE
object
CENTRAL_BANK
object
GOVERNMENT
object
INTERNATIONAL_ORGANIZATION
object
OTHER
object
PASSIVE_NFFE
object
PUBLICLY_TRADED_NFFE

FeatureFlag: object

group:
object
return:
arguments:
object
translatedDescription:
object
return:
arguments:
object
value:
object
return:
arguments:
object
Example
{
  "group": {
    "return": "string",
    "arguments": {}
  },
  "translatedDescription": {
    "return": {
      "en": {
        "return": "string",
        "arguments": {}
      },
      "fr": {
        "return": "string",
        "arguments": {}
      }
    },
    "arguments": {}
  },
  "value": {
    "return": "string",
    "arguments": {}
  }
}

FeatureFlagGroupTypes: string

object
ACCOUNT_MANAGEMENT
object
ACCOUNT_TYPES
object
ACCOUNT_TYPES_UK
object
ACCOUNT_TYPES_USA
object
DOCUMENTS_AND_STATEMENTS
object
PROFILE
object
TEMPORARY_FLAGS
object
TRADING
object
TRANSFERS

FeatureFlagOption: object

enabled:
object
return:
arguments:
object
type:
object
return:
arguments:
object
Example
{
  "enabled": {
    "return": "boolean",
    "arguments": {}
  },
  "type": {
    "return": "string",
    "arguments": {}
  }
}

FeatureFlagOptionInput: object

enabled:
type:
Example
{
  "enabled": "boolean",
  "type": "string"
}

FeatureFlagTypes: string

object
ACCOUNT_TO_ACCOUNT_DEPOSIT
object
ADVISOR_APPROVAL_REQUIRED_FOR_CLIENTS_TO_SIGN_AGREEMENTS
object
ALLOW_ADDING_A_NEW_PROFILE
object
ANNUAL_INFORMATION_UPDATE
object
ASSET_CLASSES
object
AUTHORIZED_ACCOUNT_ACCESS
object
AUTOMATED_BANK_ACCOUNT_LINKING
object
AUTO_INVESTMENTS
object
BLOCK_CLIENT_ONBOARDING_MOBILE_APP
object
BLOCK_CLIENT_SIGN_UP
object
BYPASS_ID_VERIFICATION
object
CASH_JOINT
object
CLOSE_ACCOUNT
object
CLOSE_GOAL
object
CLOSE_SUB_ACCOUNT
object
CONFIGURABLE_CLIENT_REPORTS
object
CORPORATE_ACCOUNTS
object
CREATE_NEW_GOALS
object
CREATE_NEW_SUB_ACCOUNTS
object
CUSTODIAN_STATEMENT
object
DEPOSITS
object
DOCUMENTS
object
ENABLE_ONEVEST_AGREEMENTS
object
FHSA
object
FIX_TRADING
object
GRSP
object
HOUSEHOLD
object
ID_VERIFICATION
object
IN_KIND_TRANSFERS
object
LIF
object
LIRA
object
LRIF
object
LRSP
object
MANUALLY_ADD_BANK_ACCOUNT
object
ONEVEST_STATEMENT
object
PAD_AGREEMENTS
object
PERSONAL
object
PRIF
object
RDSP
object
RESP
object
RESP_ADULT
object
RESP_FAMILY
object
RESP_FAMILY_JOINT
object
RESP_SINGLE
object
RESP_SINGLE_JOINT
object
RIF_SPOUSAL
object
RLIF
object
RLSP
object
RRIF
object
RRSP
object
RRSP_SPOUSAL
object
SUITABILITY_REVIEW_DUE_NOTIFICATIONS
object
SUITABILITY_REVIEW_OVERDUE_BLOCK_TRANSFERS
object
TAX_LOSS_HARVESTING
object
TFSA
object
UK_BROKERAGE
object
UK_CASH_ISA
object
UK_JISA
object
UK_PERSONAL_PENSION
object
UK_SS_ISA
object
UPDATE_GOAL
object
UPDATE_PERSONAL_DETAILS
object
UPDATE_SUB_ACCOUNT
object
USA_401K
object
USA_529
object
USA_BROKERAGE
object
USA_CORPORATE
object
USA_ESA
object
USA_INH_IRA
object
USA_INH_RT_IRA
object
USA_IRA
object
USA_JT_CP
object
USA_JT_JTBE
object
USA_JT_TIC
object
USA_JT_WROS
object
USA_RO_IRA
object
USA_RT_IRA
object
USA_SEP_IRA
object
USA_SOLO_401K
object
USA_TRUST
object
VIEW_AGREEMENTS
object
VIEW_HELP_CENTER
object
VIEW_STATEMENTS
object
VIEW_TAX_DOCUMENTS
object
WITHDRAWALS

FeeGrid: object

annualFeeBps:
object

This is the annual BPS, which means the daily BPS will be calculated and applied on each day of the billing frequency.

return:
arguments:
object
annualFeeCents:
object

This is a fixed fee amount cents that would applied for this grid range. If annualFeeBps is defined, the annualFeeCents will be added to the annualFeeBps calculated fee.

return:
arguments:
object
minMarketValueCents:
object

Minimum value for the total marketValueCents to be considered in this grid range. The maximum value will be defined by the next minMarketValueCents in the grid list.

return:
arguments:
object
Example
{
  "annualFeeBps": {
    "return": "number",
    "arguments": {}
  },
  "annualFeeCents": {
    "return": "object",
    "arguments": {}
  },
  "minMarketValueCents": {
    "return": "object",
    "arguments": {}
  }
}

FeeGridScopeTypes: string

object
ACCOUNT
object
CLIENT_GROUP
object
SUB_ACCOUNT
object
USER

FeePagination: object

offSet:
Int
perPage:
Int
Example
{
  "offSet": "number",
  "perPage": "number"
}

FeeTier: object

FeeTier defines how the subAccount fee should be calculated. It is defined at the Organization level, but can be applied to specific SubAccounts, Accounts, Users, or ClientGroups. The fee calculation will identify the first FeeTier applicable for the subAccount following this hierarchical order: SubAccount -> Account -> User -> ClientGroup -> Organization.

blendedGrid:
object

When a grid is blended the total fee will be a combination of each rate applied to its range. Otherwise, the corresponding rate will be applied to the total amount.

return:
arguments:
object
chargeForCash:
object
return:
arguments:
object
chargeForCashOnHold:
object
return:
arguments:
object
createdAt:
object
return:
arguments:
object
default:
object

It defines whether this is the default FeeTier within its organization. The default FeeTier will be used in case there is no specific FeeTier assigned to the subAccount, Account, User, or ClientGroup. If the organization does not inherit parent FeeTiers, there must be one default FeeTier, otherwise the default FeeTier of the next parent organization will be considered.

return:
arguments:
object
discountPercentage:
object

A discount percentage applied to the calculated fee (0 - 100%). If this FeeTier does not have a grid or a flatAnnualFeeBps configuration, this discount will be applied on top of the calculated fee based on the next FeeTier in the hierarchical order.

return:
arguments:
object
flatAnnualFeeBps:
object

A flat fee that will be applied regardless of the total marketValueCents. It can not be defined when the grid is defined. This is the annual BPS, which means the daily BPS will be calculated and applied on each day of the billing frequency.

return:
arguments:
object
grid:
object
return:
FeeGrid
arguments:
object
gridScopeType:
object

It defines the scope in which the marketValueCents will be accumulated to identify the applicable fee grid.

return:
arguments:
object
id:
object
return:
arguments:
object
name:
object
return:
arguments:
object
organization:
object
return:
arguments:
object
requestId:
object
return:
arguments:
object
state:
object
return:
arguments:
object
stateChanges:
object
return:
arguments:
object
updatedAt:
object
return:
arguments:
object
Example
{
  "blendedGrid": {
    "return": "boolean",
    "arguments": {}
  },
  "chargeForCash": {
    "return": "boolean",
    "arguments": {}
  },
  "chargeForCashOnHold": {
    "return": "boolean",
    "arguments": {}
  },
  "createdAt": {
    "return": "object",
    "arguments": {}
  },
  "default": {
    "return": "boolean",
    "arguments": {}
  },
  "discountPercentage": {
    "return": "number",
    "arguments": {}
  },
  "flatAnnualFeeBps": {
    "return": "number",
    "arguments": {}
  },
  "grid": {
    "return": [
      {
        "annualFeeBps": {
          "return": "number",
          "arguments": {}
        },
        "annualFeeCents": {
          "return": "object",
          "arguments": {}
        },
        "minMarketValueCents": {
          "return": "object",
          "arguments": {}
        }
      }
    ],
    "arguments": {}
  },
  "gridScopeType": {
    "return": "string",
    "arguments": {}
  },
  "id": {
    "return": "object",
    "arguments": {}
  },
  "name": {
    "return": "string",
    "arguments": {}
  },
  "organization": {
    "return": {
      "browserTabTitle": {
        "return": "string",
        "arguments": {}
      },
      "faviconLink": {
        "return": "string",
        "arguments": {}
      },
      "id": {
        "return": "object",
        "arguments": {}
      },
      "name": {
        "return": "string",
        "arguments": {}
      },
      "parent": {
        "return": {
          "browserTabTitle": {
            "return": "string",
            "arguments": {}
          },
          "faviconLink": {
            "return": "string",
            "arguments": {}
          },
          "id": {
            "return": "object",
            "arguments": {}
          },
          "name": {
            "return": "string",
            "arguments": {}
          },
          "parent": {
            "return": {
              "browserTabTitle": {}
            }
          }
        }
      }
    }
  }
}

FeeTierGridInput: object

annualFeeBps:
annualFeeCents:
minMarketValueCents:
Example
{
  "annualFeeBps": "number",
  "annualFeeCents": "object",
  "minMarketValueCents": "object"
}

FeeTierQueryFilter: object

default:
gridScopeTypes:
FeeGridScopeTypes
hasDiscountPercentage:
hasFlatAnnualFeeBps:
hasGrid:
name:
organizationId:
states:
FeeTierStates
Example
{
  "default": "boolean",
  "gridScopeTypes": [
    "string"
  ],
  "hasDiscountPercentage": "boolean",
  "hasFlatAnnualFeeBps": "boolean",
  "hasGrid": "boolean",
  "name": "string",
  "organizationId": "object",
  "states": [
    "string"
  ]
}

FeeTierStates: string

object
ACTIVE
object
ARCHIVED
object
INACTIVE

FeeTierTransition: string

object
activate
object
archive
object
deactivate

FetchAccountFeeResponse: object

accountFee:
object
return:
arguments:
object
Example
{
  "accountFee": {
    "return": {
      "account": {
        "return": {
          "affiliations": {
            "return": [
              {
                "allocation": {
                  "return": "number",
                  "arguments": {}
                },
                "id": {
                  "return": "object",
                  "arguments": {}
                },
                "relation": {
                  "return": "string",
                  "arguments": {}
                },
                "signatureRequired": {
                  "return": "boolean",
                  "arguments": {}
                },
                "type": {
                  "return": "string",
                  "arguments": {}
                },
                "user": {
                  "return": {
                    "accessibleBy": {
                      "return": [
                        {
                          "displayOptions": {
                            "return": {
                              "hide": {
                                "return": "boolean",
                                "arguments": {}
                              },
                              "order": {
                                "return": "number",
                                "arguments": {}
                              }
                            },
                            "arguments": {}
                          },
                          "organizationUser": {
                            "return": {
                              "accessType": {
                                "return": "string",
                                "arguments": {}
                              },
                              "apiTokens": {
                                "return": [
                                  {
                                    "id": {
                                      "return": "object",
                                      "arguments": {}
                                    },
                                    "jwtToken": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "name": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "organization": {
                                      "return": {
                                        "browserTabTitle": {
                                          "return": "string",
                                          "arguments": {}
                                        },
                                        "faviconLink": {
                                          "return": "string",
                                          "arguments": {}
                                        },
                                        "id": {
                                          "return": "object",
                                          "arguments": {}
                                        },
                                        "name": {
                                          "return": "string",
                                          "arguments": {}
                                        },
                                        "parent": {
                                          "return": {
                                            "browserTabTitle": {
                                              "return": "string",
                                              "arguments": {}
                                            },
                                            "faviconLink": {}
                                          }
                                        }
                                      }
                                    }
                                  }
                                ]
                              }
                            }
                          }
                        }
                      ]
                    }
                  }
                }
              }
            ]
          }
        }
      }
    }
  }
}

FetchAccountFeesInput: object

filter:
pagination:
Example
{
  "filter": {
    "accountId": "object",
    "organizationId": "object",
    "referenceDate": "object",
    "referenceDateAfter": "object",
    "referenceDateBefore": "object",
    "state": "string"
  },
  "pagination": {
    "offSet": "number",
    "perPage": "number",
    "sortDesc": "boolean",
    "sortField": "string"
  }
}

FetchAccountFeesResponse: object

accountFees:
object
return:
AccountFee
arguments:
object
totalCount:
object
return:
Int
arguments:
object
Example
{
  "accountFees": {
    "return": [
      {
        "account": {
          "return": {
            "affiliations": {
              "return": [
                {
                  "allocation": {
                    "return": "number",
                    "arguments": {}
                  },
                  "id": {
                    "return": "object",
                    "arguments": {}
                  },
                  "relation": {
                    "return": "string",
                    "arguments": {}
                  },
                  "signatureRequired": {
                    "return": "boolean",
                    "arguments": {}
                  },
                  "type": {
                    "return": "string",
                    "arguments": {}
                  },
                  "user": {
                    "return": {
                      "accessibleBy": {
                        "return": [
                          {
                            "displayOptions": {
                              "return": {
                                "hide": {
                                  "return": "boolean",
                                  "arguments": {}
                                },
                                "order": {
                                  "return": "number",
                                  "arguments": {}
                                }
                              },
                              "arguments": {}
                            },
                            "organizationUser": {
                              "return": {
                                "accessType": {
                                  "return": "string",
                                  "arguments": {}
                                },
                                "apiTokens": {
                                  "return": [
                                    {
                                      "id": {
                                        "return": "object",
                                        "arguments": {}
                                      },
                                      "jwtToken": {
                                        "return": "string",
                                        "arguments": {}
                                      },
                                      "name": {
                                        "return": "string",
                                        "arguments": {}
                                      },
                                      "organization": {
                                        "return": {
                                          "browserTabTitle": {
                                            "return": "string",
                                            "arguments": {}
                                          },
                                          "faviconLink": {
                                            "return": "string",
                                            "arguments": {}
                                          },
                                          "id": {
                                            "return": "object",
                                            "arguments": {}
                                          },
                                          "name": {
                                            "return": "string",
                                            "arguments": {}
                                          },
                                          "parent": {
                                            "return": {
                                              "browserTabTitle": {
                                                "return": "string",
                                                "arguments": {}
                                              }
                                            }
                                          }
                                        }
                                      }
                                    }
                                  ]
                                }
                              }
                            }
                          }
                        ]
                      }
                    }
                  }
                }
              ]
            }
          }
        }
      }
    ]
  }
}

FetchAccountResponse: object

account:
object
return:
arguments:
object
Example
{
  "account": {
    "return": {
      "affiliations": {
        "return": [
          {
            "allocation": {
              "return": "number",
              "arguments": {}
            },
            "id": {
              "return": "object",
              "arguments": {}
            },
            "relation": {
              "return": "string",
              "arguments": {}
            },
            "signatureRequired": {
              "return": "boolean",
              "arguments": {}
            },
            "type": {
              "return": "string",
              "arguments": {}
            },
            "user": {
              "return": {
                "accessibleBy": {
                  "return": [
                    {
                      "displayOptions": {
                        "return": {
                          "hide": {
                            "return": "boolean",
                            "arguments": {}
                          },
                          "order": {
                            "return": "number",
                            "arguments": {}
                          }
                        },
                        "arguments": {}
                      },
                      "organizationUser": {
                        "return": {
                          "accessType": {
                            "return": "string",
                            "arguments": {}
                          },
                          "apiTokens": {
                            "return": [
                              {
                                "id": {
                                  "return": "object",
                                  "arguments": {}
                                },
                                "jwtToken": {
                                  "return": "string",
                                  "arguments": {}
                                },
                                "name": {
                                  "return": "string",
                                  "arguments": {}
                                },
                                "organization": {
                                  "return": {
                                    "browserTabTitle": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "faviconLink": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "id": {
                                      "return": "object",
                                      "arguments": {}
                                    },
                                    "name": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "parent": {
                                      "return": {
                                        "browserTabTitle": {
                                          "return": "string",
                                          "arguments": {}
                                        },
                                        "faviconLink": {
                                          "return": "string",
                                          "arguments": {}
                                        }
                                      }
                                    }
                                  }
                                }
                              }
                            ]
                          }
                        }
                      }
                    }
                  ]
                }
              }
            }
          }
        ]
      }
    }
  }
}

FetchAccountStatementResponse: object

accountStatement:
object
return:
arguments:
object
Example
{
  "accountStatement": {
    "return": {
      "account": {
        "return": {
          "affiliations": {
            "return": [
              {
                "allocation": {
                  "return": "number",
                  "arguments": {}
                },
                "id": {
                  "return": "object",
                  "arguments": {}
                },
                "relation": {
                  "return": "string",
                  "arguments": {}
                },
                "signatureRequired": {
                  "return": "boolean",
                  "arguments": {}
                },
                "type": {
                  "return": "string",
                  "arguments": {}
                },
                "user": {
                  "return": {
                    "accessibleBy": {
                      "return": [
                        {
                          "displayOptions": {
                            "return": {
                              "hide": {
                                "return": "boolean",
                                "arguments": {}
                              },
                              "order": {
                                "return": "number",
                                "arguments": {}
                              }
                            },
                            "arguments": {}
                          },
                          "organizationUser": {
                            "return": {
                              "accessType": {
                                "return": "string",
                                "arguments": {}
                              },
                              "apiTokens": {
                                "return": [
                                  {
                                    "id": {
                                      "return": "object",
                                      "arguments": {}
                                    },
                                    "jwtToken": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "name": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "organization": {
                                      "return": {
                                        "browserTabTitle": {
                                          "return": "string",
                                          "arguments": {}
                                        },
                                        "faviconLink": {
                                          "return": "string",
                                          "arguments": {}
                                        },
                                        "id": {
                                          "return": "object",
                                          "arguments": {}
                                        },
                                        "name": {
                                          "return": "string",
                                          "arguments": {}
                                        },
                                        "parent": {
                                          "return": {
                                            "browserTabTitle": {
                                              "return": "string",
                                              "arguments": {}
                                            },
                                            "faviconLink": {}
                                          }
                                        }
                                      }
                                    }
                                  }
                                ]
                              }
                            }
                          }
                        }
                      ]
                    }
                  }
                }
              }
            ]
          }
        }
      }
    }
  }
}

FetchAccountStatementsInput: object

filter:
pagination:
Example
{
  "filter": {
    "accountId": "string",
    "accountIds": [
      "string"
    ],
    "accountType": "string",
    "afterDate": "object",
    "beforeDate": "object",
    "clientGroupIds": [
      "string"
    ],
    "organizationId": "object",
    "partnerId": "string",
    "state": "string",
    "type": "string",
    "typeGroup": "string",
    "types": [
      "string"
    ],
    "userId": "string",
    "userIds": [
      "string"
    ]
  },
  "pagination": {
    "offSet": "number",
    "perPage": "number",
    "sortDesc": "boolean",
    "sortField": "object"
  }
}

FetchAccountStatementsResponse: object

accountStatements:
object
return:
AccountStatement
arguments:
object
totalCount:
object
return:
Int
arguments:
object
Example
{
  "accountStatements": {
    "return": [
      {
        "account": {
          "return": {
            "affiliations": {
              "return": [
                {
                  "allocation": {
                    "return": "number",
                    "arguments": {}
                  },
                  "id": {
                    "return": "object",
                    "arguments": {}
                  },
                  "relation": {
                    "return": "string",
                    "arguments": {}
                  },
                  "signatureRequired": {
                    "return": "boolean",
                    "arguments": {}
                  },
                  "type": {
                    "return": "string",
                    "arguments": {}
                  },
                  "user": {
                    "return": {
                      "accessibleBy": {
                        "return": [
                          {
                            "displayOptions": {
                              "return": {
                                "hide": {
                                  "return": "boolean",
                                  "arguments": {}
                                },
                                "order": {
                                  "return": "number",
                                  "arguments": {}
                                }
                              },
                              "arguments": {}
                            },
                            "organizationUser": {
                              "return": {
                                "accessType": {
                                  "return": "string",
                                  "arguments": {}
                                },
                                "apiTokens": {
                                  "return": [
                                    {
                                      "id": {
                                        "return": "object",
                                        "arguments": {}
                                      },
                                      "jwtToken": {
                                        "return": "string",
                                        "arguments": {}
                                      },
                                      "name": {
                                        "return": "string",
                                        "arguments": {}
                                      },
                                      "organization": {
                                        "return": {
                                          "browserTabTitle": {
                                            "return": "string",
                                            "arguments": {}
                                          },
                                          "faviconLink": {
                                            "return": "string",
                                            "arguments": {}
                                          },
                                          "id": {
                                            "return": "object",
                                            "arguments": {}
                                          },
                                          "name": {
                                            "return": "string",
                                            "arguments": {}
                                          },
                                          "parent": {
                                            "return": {
                                              "browserTabTitle": {
                                                "return": "string",
                                                "arguments": {}
                                              }
                                            }
                                          }
                                        }
                                      }
                                    }
                                  ]
                                }
                              }
                            }
                          }
                        ]
                      }
                    }
                  }
                }
              ]
            }
          }
        }
      }
    ]
  }
}

FetchAccountTypesInput: object

filter:
Example
{
  "filter": {
    "entityId": "object",
    "householdId": "object"
  }
}

FetchAccountTypesQueryFilter: object

entityId:
householdId:
Example
{
  "entityId": "object",
  "householdId": "object"
}

FetchAccountTypesResponse: object

accountTypes:
object
return:
AccountType
arguments:
object
Example
{
  "accountTypes": {
    "return": [
      {
        "translatedDescription": {
          "return": {
            "en": {
              "return": "string",
              "arguments": {}
            },
            "fr": {
              "return": "string",
              "arguments": {}
            }
          },
          "arguments": {}
        },
        "translatedName": {
          "return": {
            "en": {
              "return": "string",
              "arguments": {}
            },
            "fr": {
              "return": "string",
              "arguments": {}
            }
          },
          "arguments": {}
        },
        "value": {
          "return": "string",
          "arguments": {}
        }
      }
    ],
    "arguments": {}
  }
}

FetchAccountsInput: object

filter:
pagination:
Example
{
  "filter": {
    "clientGroupId": "object",
    "customFields": [
      {
        "key": "object",
        "value": "object"
      }
    ],
    "includeHousehold": "boolean",
    "states": [
      "string"
    ],
    "type": "string",
    "userId": "object"
  },
  "pagination": {
    "offSet": "number",
    "perPage": "number",
    "sortDesc": "boolean",
    "sortField": "string"
  }
}

FetchAccountsResponse: object

accounts:
object
return:
Account
arguments:
object
totalCount:
object
return:
Int
arguments:
object
Example
{
  "accounts": {
    "return": [
      {
        "affiliations": {
          "return": [
            {
              "allocation": {
                "return": "number",
                "arguments": {}
              },
              "id": {
                "return": "object",
                "arguments": {}
              },
              "relation": {
                "return": "string",
                "arguments": {}
              },
              "signatureRequired": {
                "return": "boolean",
                "arguments": {}
              },
              "type": {
                "return": "string",
                "arguments": {}
              },
              "user": {
                "return": {
                  "accessibleBy": {
                    "return": [
                      {
                        "displayOptions": {
                          "return": {
                            "hide": {
                              "return": "boolean",
                              "arguments": {}
                            },
                            "order": {
                              "return": "number",
                              "arguments": {}
                            }
                          },
                          "arguments": {}
                        },
                        "organizationUser": {
                          "return": {
                            "accessType": {
                              "return": "string",
                              "arguments": {}
                            },
                            "apiTokens": {
                              "return": [
                                {
                                  "id": {
                                    "return": "object",
                                    "arguments": {}
                                  },
                                  "jwtToken": {
                                    "return": "string",
                                    "arguments": {}
                                  },
                                  "name": {
                                    "return": "string",
                                    "arguments": {}
                                  },
                                  "organization": {
                                    "return": {
                                      "browserTabTitle": {
                                        "return": "string",
                                        "arguments": {}
                                      },
                                      "faviconLink": {
                                        "return": "string",
                                        "arguments": {}
                                      },
                                      "id": {
                                        "return": "object",
                                        "arguments": {}
                                      },
                                      "name": {
                                        "return": "string",
                                        "arguments": {}
                                      },
                                      "parent": {
                                        "return": {
                                          "browserTabTitle": {
                                            "return": "string",
                                            "arguments": {}
                                          },
                                          "faviconLink": {
                                            "return": "string"
                                          }
                                        }
                                      }
                                    }
                                  }
                                }
                              ]
                            }
                          }
                        }
                      }
                    ]
                  }
                }
              }
            }
          ]
        }
      }
    ]
  }
}

FetchAlertReportInput: object

reportId:
transferId:
Example
{
  "reportId": "object",
  "transferId": "object"
}

FetchAlertReportResponse: object

report:
object
return:
arguments:
object
Example
{
  "report": {
    "return": {
      "id": {
        "return": "object",
        "arguments": {}
      },
      "reason": {
        "return": "string",
        "arguments": {}
      },
      "rules": {
        "return": [
          {
            "id": {
              "return": "object",
              "arguments": {}
            },
            "translatedDescription": {
              "return": {
                "en": {
                  "return": "string",
                  "arguments": {}
                },
                "fr": {
                  "return": "string",
                  "arguments": {}
                }
              },
              "arguments": {}
            },
            "type": {
              "return": "string",
              "arguments": {}
            }
          }
        ],
        "arguments": {}
      },
      "state": {
        "return": "string",
        "arguments": {}
      },
      "transfer": {
        "return": {
          "alertReport": {
            "return": {
              "id": {
                "return": "object",
                "arguments": {}
              },
              "reason": {
                "return": "string",
                "arguments": {}
              },
              "rules": {
                "return": [
                  {
                    "id": {
                      "return": "object",
                      "arguments": {}
                    },
                    "translatedDescription": {
                      "return": {
                        "en": {
                          "return": "string",
                          "arguments": {}
                        },
                        "fr": {
                          "return": "string",
                          "arguments": {}
                        }
                      },
                      "arguments": {}
                    },
                    "type": {
                      "return": "string",
                      "arguments": {}
                    }
                  }
                ],
                "arguments": {}
              },
              "state": {
                "return": "string",
                "arguments": {}
              },
              "transfer": {
                "return": {
                  "alertReport": {
                    "return": {
                      "id": {
                        "return": "object",
                        "arguments": {}
                      },
                      "reason": {
                        "return": "string",
                        "arguments": {}
                      },
                      "rules": {
                        "return": [
                          null
                        ]
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

FetchAlertReportsInput: object

filter:
pagination:
Example
{
  "filter": {
    "createdAtAfter": "object",
    "createdAtBefore": "object",
    "organizationId": "object",
    "state": "string",
    "subAccountId": "object",
    "transferId": "object",
    "transferType": "string"
  },
  "pagination": {
    "offSet": "number",
    "perPage": "number",
    "sortDesc": "boolean",
    "sortField": "string"
  }
}

FetchAlertReportsResponse: object

reports:
object
return:
Report
arguments:
object
totalCount:
object
return:
Int
arguments:
object
Example
{
  "reports": {
    "return": [
      {
        "id": {
          "return": "object",
          "arguments": {}
        },
        "reason": {
          "return": "string",
          "arguments": {}
        },
        "rules": {
          "return": [
            {
              "id": {
                "return": "object",
                "arguments": {}
              },
              "translatedDescription": {
                "return": {
                  "en": {
                    "return": "string",
                    "arguments": {}
                  },
                  "fr": {
                    "return": "string",
                    "arguments": {}
                  }
                },
                "arguments": {}
              },
              "type": {
                "return": "string",
                "arguments": {}
              }
            }
          ],
          "arguments": {}
        },
        "state": {
          "return": "string",
          "arguments": {}
        },
        "transfer": {
          "return": {
            "alertReport": {
              "return": {
                "id": {
                  "return": "object",
                  "arguments": {}
                },
                "reason": {
                  "return": "string",
                  "arguments": {}
                },
                "rules": {
                  "return": [
                    {
                      "id": {
                        "return": "object",
                        "arguments": {}
                      },
                      "translatedDescription": {
                        "return": {
                          "en": {
                            "return": "string",
                            "arguments": {}
                          },
                          "fr": {
                            "return": "string",
                            "arguments": {}
                          }
                        },
                        "arguments": {}
                      },
                      "type": {
                        "return": "string",
                        "arguments": {}
                      }
                    }
                  ],
                  "arguments": {}
                },
                "state": {
                  "return": "string",
                  "arguments": {}
                },
                "transfer": {
                  "return": {
                    "alertReport": {
                      "return": {
                        "id": {
                          "return": "object",
                          "arguments": {}
                        },
                        "reason": {
                          "return": "string",
                          "arguments": {}
                        },
                        "rules": {}
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    ]
  }
}

FetchApiExportInput: object

apiExportId:
Example
{
  "apiExportId": "object"
}

FetchApiExportResponse: object

apiExport:
object
return:
arguments:
object
Example
{
  "apiExport": {
    "return": {
      "columns": {
        "return": [
          {
            "formatter": {
              "return": "string",
              "arguments": {}
            },
            "gqlAlias": {
              "return": "string",
              "arguments": {}
            },
            "header": {
              "return": "string",
              "arguments": {}
            }
          }
        ],
        "arguments": {}
      },
      "datasetPath": {
        "return": "string",
        "arguments": {}
      },
      "fileName": {
        "return": "string",
        "arguments": {}
      },
      "fileUrl": {
        "return": "string",
        "arguments": {}
      },
      "filter": {
        "return": "object",
        "arguments": {}
      },
      "id": {
        "return": "object",
        "arguments": {}
      },
      "organizationUser": {
        "return": {
          "email": {
            "return": "string",
            "arguments": {}
          },
          "firstName": {
            "return": "string",
            "arguments": {}
          },
          "id": {
            "return": "object",
            "arguments": {}
          },
          "language": {
            "return": "string",
            "arguments": {}
          },
          "lastName": {
            "return": "string",
            "arguments": {}
          },
          "organization": {
            "return": {
              "browserTabTitle": {
                "return": "string",
                "arguments": {}
              },
              "faviconLink": {
                "return": "string",
                "arguments": {}
              },
              "id": {
                "return": "object",
                "arguments": {}
              },
              "name": {
                "return": "string",
                "arguments": {}
              },
              "parent": {
                "return": {
                  "browserTabTitle": {
                    "return": "string",
                    "arguments": {}
                  },
                  "faviconLink": {
                    "return": "string",
                    "arguments": {}
                  },
                  "id": {
                    "return": "object",
                    "arguments": {}
                  },
                  "name": {}
                }
              }
            }
          }
        }
      }
    }
  }
}

FetchArticleResponse: object

article:
object
return:
arguments:
object
Example
{
  "article": {
    "return": {
      "articleUrl": {
        "return": "object",
        "arguments": {}
      },
      "createdAt": {
        "return": "object",
        "arguments": {}
      },
      "createdBy": {
        "return": {
          "email": {
            "return": "string",
            "arguments": {}
          },
          "firstName": {
            "return": "string",
            "arguments": {}
          },
          "id": {
            "return": "object",
            "arguments": {}
          },
          "language": {
            "return": "string",
            "arguments": {}
          },
          "lastName": {
            "return": "string",
            "arguments": {}
          },
          "organization": {
            "return": {
              "browserTabTitle": {
                "return": "string",
                "arguments": {}
              },
              "faviconLink": {
                "return": "string",
                "arguments": {}
              },
              "id": {
                "return": "object",
                "arguments": {}
              },
              "name": {
                "return": "string",
                "arguments": {}
              },
              "parent": {
                "return": {
                  "browserTabTitle": {
                    "return": "string",
                    "arguments": {}
                  },
                  "faviconLink": {
                    "return": "string",
                    "arguments": {}
                  },
                  "id": {
                    "return": "object",
                    "arguments": {}
                  },
                  "name": {
                    "return": "string",
                    "arguments": {}
                  },
                  "parent": {
                    "return": {
                      "browserTabTitle": {
                        "return": "string",
                        "arguments": {}
                      },
                      "faviconLink": {
                        "return": "string",
                        "arguments": {}
                      },
                      "id": {
                        "return": "object",
                        "arguments": {}
                      },
                      "name": {
                        "return": "string",
                        "arguments": {}
                      },
                      "parent": {
                        "return": {
                          "browserTabTitle": {
                            "return": "string",
                            "arguments": {}
                          },
                          "faviconLink": {}
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

FetchArticlesInput: object

filter:
pagination:
Example
{
  "filter": {
    "createdAt": "object",
    "organizationId": "object",
    "searchText": "string",
    "state": "string",
    "updatedAt": "object"
  },
  "pagination": {
    "offSet": "number",
    "perPage": "number",
    "sortDesc": "boolean",
    "sortField": "string"
  }
}

FetchArticlesResponse: object

articles:
object
return:
Article
arguments:
object
totalCount:
object
return:
Int
arguments:
object
Example
{
  "articles": {
    "return": [
      {
        "articleUrl": {
          "return": "object",
          "arguments": {}
        },
        "createdAt": {
          "return": "object",
          "arguments": {}
        },
        "createdBy": {
          "return": {
            "email": {
              "return": "string",
              "arguments": {}
            },
            "firstName": {
              "return": "string",
              "arguments": {}
            },
            "id": {
              "return": "object",
              "arguments": {}
            },
            "language": {
              "return": "string",
              "arguments": {}
            },
            "lastName": {
              "return": "string",
              "arguments": {}
            },
            "organization": {
              "return": {
                "browserTabTitle": {
                  "return": "string",
                  "arguments": {}
                },
                "faviconLink": {
                  "return": "string",
                  "arguments": {}
                },
                "id": {
                  "return": "object",
                  "arguments": {}
                },
                "name": {
                  "return": "string",
                  "arguments": {}
                },
                "parent": {
                  "return": {
                    "browserTabTitle": {
                      "return": "string",
                      "arguments": {}
                    },
                    "faviconLink": {
                      "return": "string",
                      "arguments": {}
                    },
                    "id": {
                      "return": "object",
                      "arguments": {}
                    },
                    "name": {
                      "return": "string",
                      "arguments": {}
                    },
                    "parent": {
                      "return": {
                        "browserTabTitle": {
                          "return": "string",
                          "arguments": {}
                        },
                        "faviconLink": {
                          "return": "string",
                          "arguments": {}
                        },
                        "id": {
                          "return": "object",
                          "arguments": {}
                        },
                        "name": {
                          "return": "string",
                          "arguments": {}
                        },
                        "parent": {
                          "return": {
                            "browserTabTitle": {
                              "return": "string",
                              "arguments": {}
                            }
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    ]
  }
}

FetchAssetClassesInput: object

filter:
Example
{
  "filter": {
    "organizationId": "object"
  }
}

FetchAssetClassesResponse: object

assetClasses:
object
return:
AssetClass
arguments:
object
Example
{
  "assetClasses": {
    "return": [
      {
        "description": {
          "return": "string",
          "arguments": {}
        },
        "id": {
          "return": "object",
          "arguments": {}
        },
        "includeCash": {
          "return": "boolean",
          "arguments": {}
        },
        "key": {
          "return": "string",
          "arguments": {}
        },
        "name": {
          "return": "string",
          "arguments": {}
        },
        "state": {
          "return": "string",
          "arguments": {}
        },
        "translatedDescription": {
          "return": {
            "en": {
              "return": "string",
              "arguments": {}
            },
            "fr": {
              "return": "string",
              "arguments": {}
            }
          },
          "arguments": {}
        },
        "translatedName": {
          "return": {
            "en": {
              "return": "string",
              "arguments": {}
            },
            "fr": {
              "return": "string",
              "arguments": {}
            }
          },
          "arguments": {}
        }
      }
    ],
    "arguments": {}
  }
}

FetchAvailableReportVariablesInput: object

objectType:
Example
{
  "objectType": "string"
}

FetchAvailableReportVariablesResponse: object

availableVariables:
object
return:
ReportVariableMeta
arguments:
object
Example
{
  "availableVariables": {
    "return": [
      {
        "description": {
          "return": "string",
          "arguments": {}
        },
        "name": {
          "return": "string",
          "arguments": {}
        },
        "type": {
          "return": "string",
          "arguments": {}
        }
      }
    ],
    "arguments": {}
  }
}

FetchAvailableThemesInput: object

organizationId:
suitabilityScore:
Int
Example
{
  "organizationId": "object",
  "suitabilityScore": "number"
}

FetchAvailableThemesResponse: object

themes:
object
return:
Theme
arguments:
object
totalCount:
object
return:
Int
arguments:
object
Example
{
  "themes": {
    "return": [
      {
        "core": {
          "return": "boolean",
          "arguments": {}
        },
        "description": {
          "return": "string",
          "arguments": {}
        },
        "iconKey": {
          "return": "string",
          "arguments": {}
        },
        "id": {
          "return": "object",
          "arguments": {}
        },
        "key": {
          "return": "string",
          "arguments": {}
        },
        "logs": {
          "return": {
            "logs": {
              "return": [
                {
                  "account": {
                    "return": {
                      "affiliations": {
                        "return": [
                          {
                            "allocation": {
                              "return": "number",
                              "arguments": {}
                            },
                            "id": {
                              "return": "object",
                              "arguments": {}
                            },
                            "relation": {
                              "return": "string",
                              "arguments": {}
                            },
                            "signatureRequired": {
                              "return": "boolean",
                              "arguments": {}
                            },
                            "type": {
                              "return": "string",
                              "arguments": {}
                            },
                            "user": {
                              "return": {
                                "accessibleBy": {
                                  "return": [
                                    {
                                      "displayOptions": {
                                        "return": {
                                          "hide": {
                                            "return": "boolean",
                                            "arguments": {}
                                          },
                                          "order": {
                                            "return": "number",
                                            "arguments": {}
                                          }
                                        },
                                        "arguments": {}
                                      },
                                      "organizationUser": {
                                        "return": {
                                          "accessType": {
                                            "return": "string",
                                            "arguments": {}
                                          },
                                          "apiTokens": {
                                            "return": [
                                              {
                                                "id": {
                                                  "return": "object",
                                                  "arguments": {}
                                                },
                                                "jwtToken": {
                                                  "return": "string",
                                                  "arguments": {}
                                                },
                                                "name": {
                                                  "return": "string"
                                                }
                                              }
                                            ]
                                          }
                                        }
                                      }
                                    }
                                  ]
                                }
                              }
                            }
                          }
                        ]
                      }
                    }
                  }
                }
              ]
            }
          }
        }
      }
    ]
  }
}

FetchBankAccountResponse: object

bankAccount:
object
return:
arguments:
object
Example
{
  "bankAccount": {
    "return": {
      "EftEligibleRatio": {
        "return": "number",
        "arguments": {}
      },
      "bankAccountNumber": {
        "return": "string",
        "arguments": {}
      },
      "bankAccountNumberDisclosed": {
        "return": "string",
        "arguments": {}
      },
      "createdAt": {
        "return": "object",
        "arguments": {}
      },
      "downloadUrls": {
        "return": [
          "string"
        ],
        "arguments": {}
      },
      "id": {
        "return": "object",
        "arguments": {}
      },
      "institutionNumber": {
        "return": "string",
        "arguments": {}
      },
      "name": {
        "return": "string",
        "arguments": {}
      },
      "source": {
        "return": "string",
        "arguments": {}
      },
      "state": {
        "return": "string",
        "arguments": {}
      },
      "stateChanges": {
        "return": [
          "object"
        ],
        "arguments": {}
      },
      "transitNumber": {
        "return": "string",
        "arguments": {}
      },
      "transitNumberDisclosed": {
        "return": "string",
        "arguments": {}
      },
      "updatedAt": {
        "return": "object",
        "arguments": {}
      },
      "user": {
        "return": {
          "accessibleBy": {
            "return": [
              {
                "displayOptions": {
                  "return": {
                    "hide": {
                      "return": "boolean",
                      "arguments": {}
                    },
                    "order": {
                      "return": "number",
                      "arguments": {}
                    }
                  },
                  "arguments": {}
                },
                "organizationUser": {
                  "return": {
                    "accessType": {
                      "return": "string",
                      "arguments": {}
                    },
                    "apiTokens": {
                      "return": [
                        {
                          "id": {
                            "return": "object",
                            "arguments": {}
                          },
                          "jwtToken": {
                            "return": "string",
                            "arguments": {}
                          }
                        }
                      ]
                    }
                  }
                }
              }
            ]
          }
        }
      }
    }
  }
}

FetchBankAccountsInput: object

filter:
pagination:
Example
{
  "filter": {
    "institutionNumber": "string",
    "organizationId": "object",
    "state": "string",
    "userId": "object"
  },
  "pagination": {
    "offSet": "number",
    "perPage": "number",
    "sortDesc": "boolean",
    "sortField": "string"
  }
}

FetchBankAccountsResponse: object

bankAccounts:
object
return:
BankAccount
arguments:
object
totalCount:
object
return:
Int
arguments:
object
Example
{
  "bankAccounts": {
    "return": [
      {
        "EftEligibleRatio": {
          "return": "number",
          "arguments": {}
        },
        "bankAccountNumber": {
          "return": "string",
          "arguments": {}
        },
        "bankAccountNumberDisclosed": {
          "return": "string",
          "arguments": {}
        },
        "createdAt": {
          "return": "object",
          "arguments": {}
        },
        "downloadUrls": {
          "return": [
            "string"
          ],
          "arguments": {}
        },
        "id": {
          "return": "object",
          "arguments": {}
        },
        "institutionNumber": {
          "return": "string",
          "arguments": {}
        },
        "name": {
          "return": "string",
          "arguments": {}
        },
        "source": {
          "return": "string",
          "arguments": {}
        },
        "state": {
          "return": "string",
          "arguments": {}
        },
        "stateChanges": {
          "return": [
            "object"
          ],
          "arguments": {}
        },
        "transitNumber": {
          "return": "string",
          "arguments": {}
        },
        "transitNumberDisclosed": {
          "return": "string",
          "arguments": {}
        },
        "updatedAt": {
          "return": "object",
          "arguments": {}
        },
        "user": {
          "return": {
            "accessibleBy": {
              "return": [
                {
                  "displayOptions": {
                    "return": {
                      "hide": {
                        "return": "boolean",
                        "arguments": {}
                      },
                      "order": {
                        "return": "number",
                        "arguments": {}
                      }
                    },
                    "arguments": {}
                  },
                  "organizationUser": {
                    "return": {
                      "accessType": {
                        "return": "string",
                        "arguments": {}
                      },
                      "apiTokens": {
                        "return": [
                          {
                            "id": {
                              "return": "object",
                              "arguments": {}
                            },
                            "jwtToken": {
                              "return": "string"
                            }
                          }
                        ]
                      }
                    }
                  }
                }
              ]
            }
          }
        }
      }
    ]
  }
}

FetchBankConnectionsInput: object

filter:
pagination:
Example
{
  "filter": {
    "createdAtAfter": "object",
    "createdAtBefore": "object",
    "state": "string",
    "userId": "object"
  },
  "pagination": {
    "offSet": "number",
    "perPage": "number",
    "sortDesc": "boolean",
    "sortField": "string"
  }
}

FetchBankConnectionsResponse: object

bankConnections:
object
return:
BankConnection
arguments:
object
totalCount:
object
return:
Int
arguments:
object
Example
{
  "bankConnections": {
    "return": [
      {
        "bankAccounts": {
          "return": [
            {
              "EftEligibleRatio": {
                "return": "number",
                "arguments": {}
              },
              "bankAccountNumber": {
                "return": "string",
                "arguments": {}
              },
              "bankAccountNumberDisclosed": {
                "return": "string",
                "arguments": {}
              },
              "createdAt": {
                "return": "object",
                "arguments": {}
              },
              "downloadUrls": {
                "return": [
                  "string"
                ],
                "arguments": {}
              },
              "id": {
                "return": "object",
                "arguments": {}
              },
              "institutionNumber": {
                "return": "string",
                "arguments": {}
              },
              "name": {
                "return": "string",
                "arguments": {}
              },
              "source": {
                "return": "string",
                "arguments": {}
              },
              "state": {
                "return": "string",
                "arguments": {}
              },
              "stateChanges": {
                "return": [
                  "object"
                ],
                "arguments": {}
              },
              "transitNumber": {
                "return": "string",
                "arguments": {}
              },
              "transitNumberDisclosed": {
                "return": "string",
                "arguments": {}
              },
              "updatedAt": {
                "return": "object",
                "arguments": {}
              },
              "user": {
                "return": {
                  "accessibleBy": {
                    "return": [
                      {
                        "displayOptions": {
                          "return": {
                            "hide": {
                              "return": "boolean",
                              "arguments": {}
                            },
                            "order": {
                              "return": "number",
                              "arguments": {}
                            }
                          },
                          "arguments": {}
                        },
                        "organizationUser": {
                          "return": {
                            "accessType": {
                              "return": "string",
                              "arguments": {}
                            },
                            "apiTokens": {
                              "return": [
                                {
                                  "id": {
                                    "return": "object"
                                  }
                                }
                              ]
                            }
                          }
                        }
                      }
                    ]
                  }
                }
              }
            }
          ]
        }
      }
    ]
  }
}

FetchBeneficiariesInput: object

filter:
pagination:
Example
{
  "filter": {
    "account": "object",
    "allocation": "number",
    "name": "string",
    "organizationId": "object",
    "relation": "string",
    "type": "string"
  },
  "pagination": {
    "offSet": "number",
    "perPage": "number",
    "sortDesc": "boolean",
    "sortField": "string"
  }
}

FetchBeneficiariesResponse: object

beneficiaries:
object
return:
Beneficiary
arguments:
object
totalCount:
object
return:
Int
arguments:
object
Example
{
  "beneficiaries": {
    "return": [
      {
        "account": {
          "return": {
            "affiliations": {
              "return": [
                {
                  "allocation": {
                    "return": "number",
                    "arguments": {}
                  },
                  "id": {
                    "return": "object",
                    "arguments": {}
                  },
                  "relation": {
                    "return": "string",
                    "arguments": {}
                  },
                  "signatureRequired": {
                    "return": "boolean",
                    "arguments": {}
                  },
                  "type": {
                    "return": "string",
                    "arguments": {}
                  },
                  "user": {
                    "return": {
                      "accessibleBy": {
                        "return": [
                          {
                            "displayOptions": {
                              "return": {
                                "hide": {
                                  "return": "boolean",
                                  "arguments": {}
                                },
                                "order": {
                                  "return": "number",
                                  "arguments": {}
                                }
                              },
                              "arguments": {}
                            },
                            "organizationUser": {
                              "return": {
                                "accessType": {
                                  "return": "string",
                                  "arguments": {}
                                },
                                "apiTokens": {
                                  "return": [
                                    {
                                      "id": {
                                        "return": "object",
                                        "arguments": {}
                                      },
                                      "jwtToken": {
                                        "return": "string",
                                        "arguments": {}
                                      },
                                      "name": {
                                        "return": "string",
                                        "arguments": {}
                                      },
                                      "organization": {
                                        "return": {
                                          "browserTabTitle": {
                                            "return": "string",
                                            "arguments": {}
                                          },
                                          "faviconLink": {
                                            "return": "string",
                                            "arguments": {}
                                          },
                                          "id": {
                                            "return": "object",
                                            "arguments": {}
                                          },
                                          "name": {
                                            "return": "string",
                                            "arguments": {}
                                          },
                                          "parent": {
                                            "return": {
                                              "browserTabTitle": {
                                                "return": "string",
                                                "arguments": {}
                                              }
                                            }
                                          }
                                        }
                                      }
                                    }
                                  ]
                                }
                              }
                            }
                          }
                        ]
                      }
                    }
                  }
                }
              ]
            }
          }
        }
      }
    ]
  }
}

FetchBeneficiaryResponse: object

beneficiary:
object
return:
arguments:
object
Example
{
  "beneficiary": {
    "return": {
      "account": {
        "return": {
          "affiliations": {
            "return": [
              {
                "allocation": {
                  "return": "number",
                  "arguments": {}
                },
                "id": {
                  "return": "object",
                  "arguments": {}
                },
                "relation": {
                  "return": "string",
                  "arguments": {}
                },
                "signatureRequired": {
                  "return": "boolean",
                  "arguments": {}
                },
                "type": {
                  "return": "string",
                  "arguments": {}
                },
                "user": {
                  "return": {
                    "accessibleBy": {
                      "return": [
                        {
                          "displayOptions": {
                            "return": {
                              "hide": {
                                "return": "boolean",
                                "arguments": {}
                              },
                              "order": {
                                "return": "number",
                                "arguments": {}
                              }
                            },
                            "arguments": {}
                          },
                          "organizationUser": {
                            "return": {
                              "accessType": {
                                "return": "string",
                                "arguments": {}
                              },
                              "apiTokens": {
                                "return": [
                                  {
                                    "id": {
                                      "return": "object",
                                      "arguments": {}
                                    },
                                    "jwtToken": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "name": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "organization": {
                                      "return": {
                                        "browserTabTitle": {
                                          "return": "string",
                                          "arguments": {}
                                        },
                                        "faviconLink": {
                                          "return": "string",
                                          "arguments": {}
                                        },
                                        "id": {
                                          "return": "object",
                                          "arguments": {}
                                        },
                                        "name": {
                                          "return": "string",
                                          "arguments": {}
                                        },
                                        "parent": {
                                          "return": {
                                            "browserTabTitle": {
                                              "return": "string",
                                              "arguments": {}
                                            },
                                            "faviconLink": {}
                                          }
                                        }
                                      }
                                    }
                                  }
                                ]
                              }
                            }
                          }
                        }
                      ]
                    }
                  }
                }
              }
            ]
          }
        }
      }
    }
  }
}

FetchBillingCycleResponse: object

billingCycle:
object
return:
arguments:
object
Example
{
  "billingCycle": {
    "return": {
      "billingDate": {
        "return": "object",
        "arguments": {}
      },
      "billingSchedule": {
        "return": {
          "createdAt": {
            "return": "object",
            "arguments": {}
          },
          "default": {
            "return": "boolean",
            "arguments": {}
          },
          "endDate": {
            "return": "object",
            "arguments": {}
          },
          "frequency": {
            "return": "string",
            "arguments": {}
          },
          "id": {
            "return": "object",
            "arguments": {}
          },
          "nextBillingDate": {
            "return": "object",
            "arguments": {}
          },
          "nextCalculationDate": {
            "return": "object",
            "arguments": {}
          },
          "organization": {
            "return": {
              "browserTabTitle": {
                "return": "string",
                "arguments": {}
              },
              "faviconLink": {
                "return": "string",
                "arguments": {}
              },
              "id": {
                "return": "object",
                "arguments": {}
              },
              "name": {
                "return": "string",
                "arguments": {}
              },
              "parent": {
                "return": {
                  "browserTabTitle": {
                    "return": "string",
                    "arguments": {}
                  },
                  "faviconLink": {
                    "return": "string",
                    "arguments": {}
                  },
                  "id": {
                    "return": "object",
                    "arguments": {}
                  },
                  "name": {
                    "return": "string",
                    "arguments": {}
                  },
                  "parent": {
                    "return": {
                      "browserTabTitle": {
                        "return": "string",
                        "arguments": {}
                      },
                      "faviconLink": {
                        "return": "string",
                        "arguments": {}
                      },
                      "id": {
                        "return": "object",
                        "arguments": {}
                      },
                      "name": {
                        "return": "string",
                        "arguments": {}
                      },
                      "parent": {
                        "return": {
                          "browserTabTitle": {}
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

FetchBillingCyclesInput: object

filter:
pagination:
Example
{
  "filter": {
    "billingDateAfter": "object",
    "billingDateBefore": "object",
    "billingScheduleIds": [
      "object"
    ],
    "organizationId": "object",
    "states": [
      "string"
    ]
  },
  "pagination": {
    "offSet": "number",
    "perPage": "number",
    "sortDesc": "boolean",
    "sortField": "string"
  }
}

FetchBillingCyclesResponse: object

billingCycles:
object
return:
BillingCycle
arguments:
object
totalCount:
object
return:
Int
arguments:
object
Example
{
  "billingCycles": {
    "return": [
      {
        "billingDate": {
          "return": "object",
          "arguments": {}
        },
        "billingSchedule": {
          "return": {
            "createdAt": {
              "return": "object",
              "arguments": {}
            },
            "default": {
              "return": "boolean",
              "arguments": {}
            },
            "endDate": {
              "return": "object",
              "arguments": {}
            },
            "frequency": {
              "return": "string",
              "arguments": {}
            },
            "id": {
              "return": "object",
              "arguments": {}
            },
            "nextBillingDate": {
              "return": "object",
              "arguments": {}
            },
            "nextCalculationDate": {
              "return": "object",
              "arguments": {}
            },
            "organization": {
              "return": {
                "browserTabTitle": {
                  "return": "string",
                  "arguments": {}
                },
                "faviconLink": {
                  "return": "string",
                  "arguments": {}
                },
                "id": {
                  "return": "object",
                  "arguments": {}
                },
                "name": {
                  "return": "string",
                  "arguments": {}
                },
                "parent": {
                  "return": {
                    "browserTabTitle": {
                      "return": "string",
                      "arguments": {}
                    },
                    "faviconLink": {
                      "return": "string",
                      "arguments": {}
                    },
                    "id": {
                      "return": "object",
                      "arguments": {}
                    },
                    "name": {
                      "return": "string",
                      "arguments": {}
                    },
                    "parent": {
                      "return": {
                        "browserTabTitle": {
                          "return": "string",
                          "arguments": {}
                        },
                        "faviconLink": {
                          "return": "string",
                          "arguments": {}
                        },
                        "id": {
                          "return": "object",
                          "arguments": {}
                        },
                        "name": {
                          "return": "string",
                          "arguments": {}
                        },
                        "parent": {
                          "return": {}
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    ]
  }
}

FetchBillingScheduleResponse: object

billingSchedule:
object
return:
arguments:
object
Example
{
  "billingSchedule": {
    "return": {
      "createdAt": {
        "return": "object",
        "arguments": {}
      },
      "default": {
        "return": "boolean",
        "arguments": {}
      },
      "endDate": {
        "return": "object",
        "arguments": {}
      },
      "frequency": {
        "return": "string",
        "arguments": {}
      },
      "id": {
        "return": "object",
        "arguments": {}
      },
      "nextBillingDate": {
        "return": "object",
        "arguments": {}
      },
      "nextCalculationDate": {
        "return": "object",
        "arguments": {}
      },
      "organization": {
        "return": {
          "browserTabTitle": {
            "return": "string",
            "arguments": {}
          },
          "faviconLink": {
            "return": "string",
            "arguments": {}
          },
          "id": {
            "return": "object",
            "arguments": {}
          },
          "name": {
            "return": "string",
            "arguments": {}
          },
          "parent": {
            "return": {
              "browserTabTitle": {
                "return": "string",
                "arguments": {}
              },
              "faviconLink": {
                "return": "string",
                "arguments": {}
              },
              "id": {
                "return": "object",
                "arguments": {}
              },
              "name": {
                "return": "string",
                "arguments": {}
              },
              "parent": {
                "return": {
                  "browserTabTitle": {
                    "return": "string",
                    "arguments": {}
                  },
                  "faviconLink": {
                    "return": "string",
                    "arguments": {}
                  },
                  "id": {
                    "return": "object",
                    "arguments": {}
                  },
                  "name": {
                    "return": "string",
                    "arguments": {}
                  },
                  "parent": {
                    "return": {
                      "browserTabTitle": {
                        "return": "string",
                        "arguments": {}
                      },
                      "faviconLink": {
                        "return": "string",
                        "arguments": {}
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

FetchBillingSchedulesInput: object

filter:
pagination:
Example
{
  "filter": {
    "frequencies": [
      "string"
    ],
    "nextBillingDateAfter": "object",
    "nextBillingDateBefore": "object",
    "organizationId": "object",
    "states": [
      "string"
    ]
  },
  "pagination": {
    "offSet": "number",
    "perPage": "number",
    "sortDesc": "boolean",
    "sortField": "string"
  }
}

FetchBillingSchedulesResponse: object

billingSchedules:
object
return:
BillingSchedule
arguments:
object
totalCount:
object
return:
Int
arguments:
object
Example
{
  "billingSchedules": {
    "return": [
      {
        "createdAt": {
          "return": "object",
          "arguments": {}
        },
        "default": {
          "return": "boolean",
          "arguments": {}
        },
        "endDate": {
          "return": "object",
          "arguments": {}
        },
        "frequency": {
          "return": "string",
          "arguments": {}
        },
        "id": {
          "return": "object",
          "arguments": {}
        },
        "nextBillingDate": {
          "return": "object",
          "arguments": {}
        },
        "nextCalculationDate": {
          "return": "object",
          "arguments": {}
        },
        "organization": {
          "return": {
            "browserTabTitle": {
              "return": "string",
              "arguments": {}
            },
            "faviconLink": {
              "return": "string",
              "arguments": {}
            },
            "id": {
              "return": "object",
              "arguments": {}
            },
            "name": {
              "return": "string",
              "arguments": {}
            },
            "parent": {
              "return": {
                "browserTabTitle": {
                  "return": "string",
                  "arguments": {}
                },
                "faviconLink": {
                  "return": "string",
                  "arguments": {}
                },
                "id": {
                  "return": "object",
                  "arguments": {}
                },
                "name": {
                  "return": "string",
                  "arguments": {}
                },
                "parent": {
                  "return": {
                    "browserTabTitle": {
                      "return": "string",
                      "arguments": {}
                    },
                    "faviconLink": {
                      "return": "string",
                      "arguments": {}
                    },
                    "id": {
                      "return": "object",
                      "arguments": {}
                    },
                    "name": {
                      "return": "string",
                      "arguments": {}
                    },
                    "parent": {
                      "return": {
                        "browserTabTitle": {
                          "return": "string",
                          "arguments": {}
                        },
                        "faviconLink": {
                          "return": "string"
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    ]
  }
}

FetchBulkImportResponse: object

bulkImport:
object
return:
arguments:
object
Example
{
  "bulkImport": {
    "return": {
      "createdAt": {
        "return": "object",
        "arguments": {}
      },
      "id": {
        "return": "object",
        "arguments": {}
      },
      "name": {
        "return": "string",
        "arguments": {}
      },
      "organization": {
        "return": {
          "browserTabTitle": {
            "return": "string",
            "arguments": {}
          },
          "faviconLink": {
            "return": "string",
            "arguments": {}
          },
          "id": {
            "return": "object",
            "arguments": {}
          },
          "name": {
            "return": "string",
            "arguments": {}
          },
          "parent": {
            "return": {
              "browserTabTitle": {
                "return": "string",
                "arguments": {}
              },
              "faviconLink": {
                "return": "string",
                "arguments": {}
              },
              "id": {
                "return": "object",
                "arguments": {}
              },
              "name": {
                "return": "string",
                "arguments": {}
              },
              "parent": {
                "return": {
                  "browserTabTitle": {
                    "return": "string",
                    "arguments": {}
                  },
                  "faviconLink": {
                    "return": "string",
                    "arguments": {}
                  },
                  "id": {
                    "return": "object",
                    "arguments": {}
                  },
                  "name": {
                    "return": "string",
                    "arguments": {}
                  },
                  "parent": {
                    "return": {
                      "browserTabTitle": {
                        "return": "string",
                        "arguments": {}
                      },
                      "faviconLink": {
                        "return": "string",
                        "arguments": {}
                      },
                      "id": {
                        "return": "object",
                        "arguments": {}
                      },
                      "name": {
                        "return": "string",
                        "arguments": {}
                      },
                      "parent": {
                        "return": {
                          "browserTabTitle": {
                            "return": "string",
                            "arguments": {}
                          },
                          "faviconLink": {}
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

FetchBulkImportsInput: object

filter:
pagination:
Example
{
  "filter": {
    "createdAtAfter": "object",
    "createdAtBefore": "object",
    "name": "object",
    "organizationId": "object",
    "organizationUserId": "object",
    "states": [
      "string"
    ]
  },
  "pagination": {
    "offSet": "number",
    "perPage": "number",
    "sortDesc": "boolean",
    "sortField": "string"
  }
}

FetchBulkImportsResponse: object

bulkImports:
object
return:
BulkImport
arguments:
object
totalCount:
object
return:
Int
arguments:
object
Example
{
  "bulkImports": {
    "return": [
      {
        "createdAt": {
          "return": "object",
          "arguments": {}
        },
        "id": {
          "return": "object",
          "arguments": {}
        },
        "name": {
          "return": "string",
          "arguments": {}
        },
        "organization": {
          "return": {
            "browserTabTitle": {
              "return": "string",
              "arguments": {}
            },
            "faviconLink": {
              "return": "string",
              "arguments": {}
            },
            "id": {
              "return": "object",
              "arguments": {}
            },
            "name": {
              "return": "string",
              "arguments": {}
            },
            "parent": {
              "return": {
                "browserTabTitle": {
                  "return": "string",
                  "arguments": {}
                },
                "faviconLink": {
                  "return": "string",
                  "arguments": {}
                },
                "id": {
                  "return": "object",
                  "arguments": {}
                },
                "name": {
                  "return": "string",
                  "arguments": {}
                },
                "parent": {
                  "return": {
                    "browserTabTitle": {
                      "return": "string",
                      "arguments": {}
                    },
                    "faviconLink": {
                      "return": "string",
                      "arguments": {}
                    },
                    "id": {
                      "return": "object",
                      "arguments": {}
                    },
                    "name": {
                      "return": "string",
                      "arguments": {}
                    },
                    "parent": {
                      "return": {
                        "browserTabTitle": {
                          "return": "string",
                          "arguments": {}
                        },
                        "faviconLink": {
                          "return": "string",
                          "arguments": {}
                        },
                        "id": {
                          "return": "object",
                          "arguments": {}
                        },
                        "name": {
                          "return": "string",
                          "arguments": {}
                        },
                        "parent": {
                          "return": {
                            "browserTabTitle": {
                              "return": "string",
                              "arguments": {}
                            }
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    ]
  }
}

FetchBulkTradeRequestResponse: object

bulkTradeRequest:
object
return:
arguments:
object
Example
{
  "bulkTradeRequest": {
    "return": {
      "createdAt": {
        "return": "object",
        "arguments": {}
      },
      "id": {
        "return": "object",
        "arguments": {}
      },
      "source": {
        "return": "string",
        "arguments": {}
      },
      "sourceId": {
        "return": "object",
        "arguments": {}
      },
      "state": {
        "return": "string",
        "arguments": {}
      },
      "stateChanges": {
        "return": [
          "object"
        ],
        "arguments": {}
      },
      "updatedAt": {
        "return": "object",
        "arguments": {}
      }
    },
    "arguments": {}
  }
}

FetchBulkTradeRequestsInput: object

filter:
pagination:
Example
{
  "filter": {
    "source": "string",
    "sourceId": "object",
    "state": "string"
  },
  "pagination": {
    "offSet": "number",
    "perPage": "number",
    "sortDesc": "boolean",
    "sortField": "string"
  }
}

FetchBulkTradeRequestsResponse: object

bulkTradeRequests:
object
return:
BulkTradeRequest
arguments:
object
totalCount:
object
return:
Int
arguments:
object
Example
{
  "bulkTradeRequests": {
    "return": [
      {
        "createdAt": {
          "return": "object",
          "arguments": {}
        },
        "id": {
          "return": "object",
          "arguments": {}
        },
        "source": {
          "return": "string",
          "arguments": {}
        },
        "sourceId": {
          "return": "object",
          "arguments": {}
        },
        "state": {
          "return": "string",
          "arguments": {}
        },
        "stateChanges": {
          "return": [
            "object"
          ],
          "arguments": {}
        },
        "updatedAt": {
          "return": "object",
          "arguments": {}
        }
      }
    ],
    "arguments": {}
  },
  "totalCount": {
    "return": "number",
    "arguments": {}
  }
}

FetchBulkTradeRunAllocationsInput: object

filter:
pagination:
Example
{
  "filter": {
    "bulkTradeRunId": "object",
    "isPTF": "boolean"
  },
  "pagination": {
    "offSet": "number",
    "perPage": "number"
  }
}

FetchBulkTradeRunAllocationsResponse: object

bulkTradeRunAllocations:
object
return:
BulkTradeRunAllocation
arguments:
object
totalCount:
object
return:
Int
arguments:
object
Example
{
  "bulkTradeRunAllocations": {
    "return": [
      {
        "account": {
          "return": "string",
          "arguments": {}
        },
        "corporateOffsetAccount": {
          "return": "string",
          "arguments": {}
        },
        "externalId": {
          "return": "string",
          "arguments": {}
        },
        "fXRate": {
          "return": "number",
          "arguments": {}
        },
        "fillPrice": {
          "return": "number",
          "arguments": {}
        },
        "id": {
          "return": "string",
          "arguments": {}
        },
        "market": {
          "return": "string",
          "arguments": {}
        },
        "settlementCurrency": {
          "return": "string",
          "arguments": {}
        },
        "settlementDate": {
          "return": "object",
          "arguments": {}
        },
        "shareQuantity": {
          "return": "number",
          "arguments": {}
        },
        "side": {
          "return": "string",
          "arguments": {}
        },
        "symbol": {
          "return": "string",
          "arguments": {}
        },
        "tradeCurrency": {
          "return": "string",
          "arguments": {}
        },
        "tradeDate": {
          "return": "object",
          "arguments": {}
        },
        "tradeValue": {
          "return": "number",
          "arguments": {}
        }
      }
    ],
    "arguments": {}
  },
  "totalCount": {
    "return": "number",
    "arguments": {}
  }
}

FetchBulkTradeRunResponse: object

bulkTradeRun:
object
return:
arguments:
object
Example
{
  "bulkTradeRun": {
    "return": {
      "allTradeRequestsByExchange": {
        "return": [
          {
            "exchange": {
              "return": "string",
              "arguments": {}
            },
            "total": {
              "return": "number",
              "arguments": {}
            }
          }
        ],
        "arguments": {}
      },
      "allocationFileUrls": {
        "return": [
          "string"
        ],
        "arguments": {}
      },
      "autoFillActualQuantity": {
        "return": "boolean",
        "arguments": {}
      },
      "bulkMutualFundTrades": {
        "return": [
          {
            "currency": {
              "return": "string",
              "arguments": {}
            },
            "exchange": {
              "return": "string",
              "arguments": {}
            },
            "id": {
              "return": "object",
              "arguments": {}
            },
            "moneyAllocatedCents": {
              "return": "number",
              "arguments": {}
            },
            "ticker": {
              "return": "string",
              "arguments": {}
            },
            "type": {
              "return": "string",
              "arguments": {}
            }
          }
        ],
        "arguments": {}
      },
      "bulkPTFFileUrls": {
        "return": [
          "string"
        ],
        "arguments": {}
      },
      "bulkTradeRequests": {
        "return": [
          {
            "bulkTrades": {
              "return": [
                {
                  "_id": {
                    "return": "string",
                    "arguments": {}
                  },
                  "actualTotal": {
                    "return": "number",
                    "arguments": {}
                  },
                  "actualTradePriceCents": {
                    "return": "number",
                    "arguments": {}
                  },
                  "actualTradePriceInCurrencyCents": {
                    "return": "number",
                    "arguments": {}
                  },
                  "currency": {
                    "return": "string",
                    "arguments": {}
                  },
                  "exchange": {
                    "return": "string",
                    "arguments": {}
                  },
                  "expectedTradePriceCents": {
                    "return": "number",
                    "arguments": {}
                  },
                  "expectedTradePriceInCurrencyCents": {
                    "return": "number",
                    "arguments": {}
                  }
                }
              ]
            }
          }
        ]
      }
    }
  }
}

FetchBulkTradeRunsInput: object

filter:
pagination:
Example
{
  "filter": {
    "organizationId": "object",
    "state": "string"
  },
  "pagination": {
    "offSet": "number",
    "perPage": "number",
    "sortDesc": "boolean",
    "sortField": "string"
  }
}

FetchBulkTradeRunsResponse: object

bulkTradeRuns:
object
return:
BulkTradeRun
arguments:
object
totalCount:
object
return:
Int
arguments:
object
Example
{
  "bulkTradeRuns": {
    "return": [
      {
        "allTradeRequestsByExchange": {
          "return": [
            {
              "exchange": {
                "return": "string",
                "arguments": {}
              },
              "total": {
                "return": "number",
                "arguments": {}
              }
            }
          ],
          "arguments": {}
        },
        "allocationFileUrls": {
          "return": [
            "string"
          ],
          "arguments": {}
        },
        "autoFillActualQuantity": {
          "return": "boolean",
          "arguments": {}
        },
        "bulkMutualFundTrades": {
          "return": [
            {
              "currency": {
                "return": "string",
                "arguments": {}
              },
              "exchange": {
                "return": "string",
                "arguments": {}
              },
              "id": {
                "return": "object",
                "arguments": {}
              },
              "moneyAllocatedCents": {
                "return": "number",
                "arguments": {}
              },
              "ticker": {
                "return": "string",
                "arguments": {}
              },
              "type": {
                "return": "string",
                "arguments": {}
              }
            }
          ],
          "arguments": {}
        },
        "bulkPTFFileUrls": {
          "return": [
            "string"
          ],
          "arguments": {}
        },
        "bulkTradeRequests": {
          "return": [
            {
              "bulkTrades": {
                "return": [
                  {
                    "_id": {
                      "return": "string",
                      "arguments": {}
                    },
                    "actualTotal": {
                      "return": "number",
                      "arguments": {}
                    },
                    "actualTradePriceCents": {
                      "return": "number",
                      "arguments": {}
                    },
                    "actualTradePriceInCurrencyCents": {
                      "return": "number",
                      "arguments": {}
                    },
                    "currency": {
                      "return": "string",
                      "arguments": {}
                    },
                    "exchange": {
                      "return": "string",
                      "arguments": {}
                    },
                    "expectedTradePriceCents": {
                      "return": "number",
                      "arguments": {}
                    },
                    "expectedTradePriceInCurrencyCents": {
                      "return": "number"
                    }
                  }
                ]
              }
            }
          ]
        }
      }
    ]
  }
}

FetchClientGroupResponse: object

ClientGroup Response

clientGroup:
object

clientGroup object

return:
arguments:
object
Example
{
  "clientGroup": {
    "return": {
      "accountNumber": {
        "return": "string",
        "arguments": {}
      },
      "accounts": {
        "return": [
          {
            "affiliations": {
              "return": [
                {
                  "allocation": {
                    "return": "number",
                    "arguments": {}
                  },
                  "id": {
                    "return": "object",
                    "arguments": {}
                  },
                  "relation": {
                    "return": "string",
                    "arguments": {}
                  },
                  "signatureRequired": {
                    "return": "boolean",
                    "arguments": {}
                  },
                  "type": {
                    "return": "string",
                    "arguments": {}
                  },
                  "user": {
                    "return": {
                      "accessibleBy": {
                        "return": [
                          {
                            "displayOptions": {
                              "return": {
                                "hide": {
                                  "return": "boolean",
                                  "arguments": {}
                                },
                                "order": {
                                  "return": "number",
                                  "arguments": {}
                                }
                              },
                              "arguments": {}
                            },
                            "organizationUser": {
                              "return": {
                                "accessType": {
                                  "return": "string",
                                  "arguments": {}
                                },
                                "apiTokens": {
                                  "return": [
                                    {
                                      "id": {
                                        "return": "object",
                                        "arguments": {}
                                      },
                                      "jwtToken": {
                                        "return": "string",
                                        "arguments": {}
                                      },
                                      "name": {
                                        "return": "string",
                                        "arguments": {}
                                      },
                                      "organization": {
                                        "return": {
                                          "browserTabTitle": {
                                            "return": "string",
                                            "arguments": {}
                                          },
                                          "faviconLink": {
                                            "return": "string",
                                            "arguments": {}
                                          },
                                          "id": {
                                            "return": "object",
                                            "arguments": {}
                                          },
                                          "name": {
                                            "return": "string",
                                            "arguments": {}
                                          },
                                          "parent": {
                                            "return": {}
                                          }
                                        }
                                      }
                                    }
                                  ]
                                }
                              }
                            }
                          }
                        ]
                      }
                    }
                  }
                }
              ]
            }
          }
        ]
      }
    }
  }
}

FetchClientGroupsInput: object

Input type for fetching ClientGroups

filter:

To filter the clientGroups

pagination:

To organize the response as per the pagination fields

Example
{
  "filter": {
    "name": "string",
    "organizationId": "object",
    "primaryUserId": "object",
    "searchText": "string",
    "states": [
      "string"
    ],
    "type": "string"
  },
  "pagination": {
    "offSet": "number",
    "perPage": "number",
    "sortDesc": "boolean",
    "sortField": "string"
  }
}

FetchClientGroupsResponse: object

Type definition for fetching clientGroups

clientGroups:
object

Returns an array of clientGroup objects

return:
ClientGroup
arguments:
object
totalCount:
object

Total number of the clientGroup records that satisfies a specified filter

return:
Int
arguments:
object
Example
{
  "clientGroups": {
    "return": [
      {
        "accountNumber": {
          "return": "string",
          "arguments": {}
        },
        "accounts": {
          "return": [
            {
              "affiliations": {
                "return": [
                  {
                    "allocation": {
                      "return": "number",
                      "arguments": {}
                    },
                    "id": {
                      "return": "object",
                      "arguments": {}
                    },
                    "relation": {
                      "return": "string",
                      "arguments": {}
                    },
                    "signatureRequired": {
                      "return": "boolean",
                      "arguments": {}
                    },
                    "type": {
                      "return": "string",
                      "arguments": {}
                    },
                    "user": {
                      "return": {
                        "accessibleBy": {
                          "return": [
                            {
                              "displayOptions": {
                                "return": {
                                  "hide": {
                                    "return": "boolean",
                                    "arguments": {}
                                  },
                                  "order": {
                                    "return": "number",
                                    "arguments": {}
                                  }
                                },
                                "arguments": {}
                              },
                              "organizationUser": {
                                "return": {
                                  "accessType": {
                                    "return": "string",
                                    "arguments": {}
                                  },
                                  "apiTokens": {
                                    "return": [
                                      {
                                        "id": {
                                          "return": "object",
                                          "arguments": {}
                                        },
                                        "jwtToken": {
                                          "return": "string",
                                          "arguments": {}
                                        },
                                        "name": {
                                          "return": "string",
                                          "arguments": {}
                                        },
                                        "organization": {
                                          "return": {
                                            "browserTabTitle": {
                                              "return": "string",
                                              "arguments": {}
                                            },
                                            "faviconLink": {
                                              "return": "string",
                                              "arguments": {}
                                            },
                                            "id": {
                                              "return": "object",
                                              "arguments": {}
                                            },
                                            "name": {
                                              "return": "string",
                                              "arguments": {}
                                            },
                                            "parent": {}
                                          }
                                        }
                                      }
                                    ]
                                  }
                                }
                              }
                            }
                          ]
                        }
                      }
                    }
                  }
                ]
              }
            }
          ]
        }
      }
    ]
  }
}

FetchClientReportResponse: object

clientReport:
object
return:
arguments:
object
Example
{
  "clientReport": {
    "return": {
      "createdAt": {
        "return": "object",
        "arguments": {}
      },
      "entity": {
        "return": {
          "accessibleBy": {
            "return": [
              {
                "displayOptions": {
                  "return": {
                    "hide": {
                      "return": "boolean",
                      "arguments": {}
                    },
                    "order": {
                      "return": "number",
                      "arguments": {}
                    }
                  },
                  "arguments": {}
                },
                "organizationUser": {
                  "return": {
                    "accessType": {
                      "return": "string",
                      "arguments": {}
                    },
                    "apiTokens": {
                      "return": [
                        {
                          "id": {
                            "return": "object",
                            "arguments": {}
                          },
                          "jwtToken": {
                            "return": "string",
                            "arguments": {}
                          },
                          "name": {
                            "return": "string",
                            "arguments": {}
                          },
                          "organization": {
                            "return": {
                              "browserTabTitle": {
                                "return": "string",
                                "arguments": {}
                              },
                              "faviconLink": {
                                "return": "string",
                                "arguments": {}
                              },
                              "id": {
                                "return": "object",
                                "arguments": {}
                              },
                              "name": {
                                "return": "string",
                                "arguments": {}
                              },
                              "parent": {
                                "return": {
                                  "browserTabTitle": {
                                    "return": "string",
                                    "arguments": {}
                                  },
                                  "faviconLink": {
                                    "return": "string",
                                    "arguments": {}
                                  },
                                  "id": {
                                    "return": "object",
                                    "arguments": {}
                                  },
                                  "name": {
                                    "return": "string",
                                    "arguments": {}
                                  },
                                  "parent": {
                                    "return": {
                                      "browserTabTitle": {
                                        "return": "string",
                                        "arguments": {}
                                      },
                                      "faviconLink": {
                                        "return": "string",
                                        "arguments": {}
                                      },
                                      "id": {}
                                    }
                                  }
                                }
                              }
                            }
                          }
                        }
                      ]
                    }
                  }
                }
              }
            ]
          }
        }
      }
    }
  }
}

FetchClientReportTemplateResponse: object

clientReportTemplate:
object
return:
arguments:
object
Example
{
  "clientReportTemplate": {
    "return": {
      "clientReportTemplatePageConfiguration": {
        "return": {
          "clientReportTemplate": {
            "return": {
              "clientReportTemplatePageConfiguration": {
                "return": {
                  "clientReportTemplate": {
                    "return": {
                      "clientReportTemplatePageConfiguration": {
                        "return": {
                          "clientReportTemplate": {
                            "return": {
                              "clientReportTemplatePageConfiguration": {
                                "return": {
                                  "clientReportTemplate": {
                                    "return": {
                                      "clientReportTemplatePageConfiguration": {
                                        "return": {
                                          "clientReportTemplate": {
                                            "return": {
                                              "clientReportTemplatePageConfiguration": {
                                                "return": {
                                                  "clientReportTemplate": {
                                                    "return": {
                                                      "clientReportTemplatePageConfiguration": {
                                                        "return": {
                                                          "clientReportTemplate": {
                                                            "return": {
                                                              "clientReportTemplatePageConfiguration": {
                                                                "return": {
                                                                  "clientReportTemplate": {
                                                                    "return": {
                                                                      "clientReportTemplatePageConfiguration": {
                                                                        "return": {
                                                                          "clientReportTemplate": {
                                                                            "return": {
                                                                              "clientReportTemplatePageConfiguration": {
                                                                                "return": {
                                                                                  "clientReportTemplate": {
                                                                                    "return": {
                                                                                      "clientReportTemplatePageConfiguration": {
                                                                                        "return": {
                                                                                          "clientReportTemplate": {
                                                                                            "return": {
                                                                                              "clientReportTemplatePageConfiguration": {
                                                                                                "return": {
                                                                                                  "clientReportTemplate": {
                                                                                                    "return": {
                                                                                                      "clientReportTemplatePageConfiguration": {
                                                                                                        "return": {
                                                                                                          "clientReportTemplate": {
                                                                                                            "return": {
                                                                                                              "clientReportTemplatePageConfiguration": {
                                                                                                                "return": {
                                                                                                                  "clientReportTemplate": {
                                                                                                                    "return": {
                                                                                                                      "clientReportTemplatePageConfiguration": {
                                                                                                                        "return": {
                                                                                                                          "clientReportTemplate": {
                                                                                                                            "return": {
                                                                                                                              "clientReportTemplatePageConfiguration": {
                                                                                                                                "return": {
                                                                                                                                  "clientReportTemplate": {
                                                                                                                                    "return": {}
                                                                                                                                  }
                                                                                                                                }
                                                                                                                              }
                                                                                                                            }
                                                                                                                          }
                                                                                                                        }
                                                                                                                      }
                                                                                                                    }
                                                                                                                  }
                                                                                                                }
                                                                                                              }
                                                                                                            }
                                                                                                          }
                                                                                                        }
                                                                                                      }
                                                                                                    }
                                                                                                  }
                                                                                                }
                                                                                              }
                                                                                            }
                                                                                          }
                                                                                        }
                                                                                      }
                                                                                    }
                                                                                  }
                                                                                }
                                                                              }
                                                                            }
                                                                          }
                                                                        }
                                                                      }
                                                                    }
                                                                  }
                                                                }
                                                              }
                                                            }
                                                          }
                                                        }
                                                      }
                                                    }
                                                  }
                                                }
                                              }
                                            }
                                          }
                                        }
                                      }
                                    }
                                  }
                                }
                              }
                            }
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

FetchClientReportTemplateWidgetOptionsResponse: object

widgetOptions:
object
return:
ClientReportTemplateWidgetOption
arguments:
object
Example
{
  "widgetOptions": {
    "return": [
      {
        "default": {
          "return": "object",
          "arguments": {}
        },
        "info": {
          "return": {
            "en": {
              "return": "string",
              "arguments": {}
            },
            "fr": {
              "return": "string",
              "arguments": {}
            }
          },
          "arguments": {}
        },
        "key": {
          "return": "string",
          "arguments": {}
        },
        "label": {
          "return": {
            "en": {
              "return": "string",
              "arguments": {}
            },
            "fr": {
              "return": "string",
              "arguments": {}
            }
          },
          "arguments": {}
        },
        "optionType": {
          "return": "string",
          "arguments": {}
        },
        "options": {
          "return": "object",
          "arguments": {}
        },
        "removeFromPages": {
          "return": [
            "string"
          ],
          "arguments": {}
        },
        "requiredIf": {
          "return": "object",
          "arguments": {}
        },
        "showBasedOnCustodianConnection": {
          "return": [
            "object"
          ],
          "arguments": {}
        },
        "showIf": {
          "return": "object",
          "arguments": {}
        },
        "showWith": {
          "return": "string",
          "arguments": {}
        }
      }
    ],
    "arguments": {}
  }
}

FetchClientReportTemplatesInput: object

filter:
pagination:
Example
{
  "filter": {
    "organizationId": "object",
    "states": [
      "string"
    ],
    "types": [
      "object"
    ]
  },
  "pagination": {
    "offSet": "number",
    "perPage": "number",
    "sortDesc": "boolean",
    "sortField": "object"
  }
}

FetchClientReportTemplatesResponse: object

clientReportTemplates:
object
return:
ClientReportTemplate
arguments:
object
totalCount:
object
return:
Int
arguments:
object
Example
{
  "clientReportTemplates": {
    "return": [
      {
        "clientReportTemplatePageConfiguration": {
          "return": {
            "clientReportTemplate": {
              "return": {
                "clientReportTemplatePageConfiguration": {
                  "return": {
                    "clientReportTemplate": {
                      "return": {
                        "clientReportTemplatePageConfiguration": {
                          "return": {
                            "clientReportTemplate": {
                              "return": {
                                "clientReportTemplatePageConfiguration": {
                                  "return": {
                                    "clientReportTemplate": {
                                      "return": {
                                        "clientReportTemplatePageConfiguration": {
                                          "return": {
                                            "clientReportTemplate": {
                                              "return": {
                                                "clientReportTemplatePageConfiguration": {
                                                  "return": {
                                                    "clientReportTemplate": {
                                                      "return": {
                                                        "clientReportTemplatePageConfiguration": {
                                                          "return": {
                                                            "clientReportTemplate": {
                                                              "return": {
                                                                "clientReportTemplatePageConfiguration": {
                                                                  "return": {
                                                                    "clientReportTemplate": {
                                                                      "return": {
                                                                        "clientReportTemplatePageConfiguration": {
                                                                          "return": {
                                                                            "clientReportTemplate": {
                                                                              "return": {
                                                                                "clientReportTemplatePageConfiguration": {
                                                                                  "return": {
                                                                                    "clientReportTemplate": {
                                                                                      "return": {
                                                                                        "clientReportTemplatePageConfiguration": {
                                                                                          "return": {
                                                                                            "clientReportTemplate": {
                                                                                              "return": {
                                                                                                "clientReportTemplatePageConfiguration": {
                                                                                                  "return": {
                                                                                                    "clientReportTemplate": {
                                                                                                      "return": {
                                                                                                        "clientReportTemplatePageConfiguration": {
                                                                                                          "return": {
                                                                                                            "clientReportTemplate": {
                                                                                                              "return": {
                                                                                                                "clientReportTemplatePageConfiguration": {
                                                                                                                  "return": {
                                                                                                                    "clientReportTemplate": {
                                                                                                                      "return": {
                                                                                                                        "clientReportTemplatePageConfiguration": {
                                                                                                                          "return": {
                                                                                                                            "clientReportTemplate": {
                                                                                                                              "return": {
                                                                                                                                "clientReportTemplatePageConfiguration": {
                                                                                                                                  "return": {
                                                                                                                                    "clientReportTemplate": {}
                                                                                                                                  }
                                                                                                                                }
                                                                                                                              }
                                                                                                                            }
                                                                                                                          }
                                                                                                                        }
                                                                                                                      }
                                                                                                                    }
                                                                                                                  }
                                                                                                                }
                                                                                                              }
                                                                                                            }
                                                                                                          }
                                                                                                        }
                                                                                                      }
                                                                                                    }
                                                                                                  }
                                                                                                }
                                                                                              }
                                                                                            }
                                                                                          }
                                                                                        }
                                                                                      }
                                                                                    }
                                                                                  }
                                                                                }
                                                                              }
                                                                            }
                                                                          }
                                                                        }
                                                                      }
                                                                    }
                                                                  }
                                                                }
                                                              }
                                                            }
                                                          }
                                                        }
                                                      }
                                                    }
                                                  }
                                                }
                                              }
                                            }
                                          }
                                        }
                                      }
                                    }
                                  }
                                }
                              }
                            }
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    ]
  }
}

FetchClientReportsInput: object

filter:
pagination:
Example
{
  "filter": {
    "clientReportTemplateId": "object",
    "entityId": "object",
    "objectId": "object",
    "objectType": "string",
    "organizationId": "object",
    "referenceDateFrom": "object",
    "referenceDateTo": "object"
  },
  "pagination": {
    "offSet": "number",
    "perPage": "number",
    "sortDesc": "boolean",
    "sortField": "object"
  }
}

FetchClientReportsResponse: object

clientReports:
object
return:
ClientReport
arguments:
object
totalCount:
object
return:
Int
arguments:
object
Example
{
  "clientReports": {
    "return": [
      {
        "createdAt": {
          "return": "object",
          "arguments": {}
        },
        "entity": {
          "return": {
            "accessibleBy": {
              "return": [
                {
                  "displayOptions": {
                    "return": {
                      "hide": {
                        "return": "boolean",
                        "arguments": {}
                      },
                      "order": {
                        "return": "number",
                        "arguments": {}
                      }
                    },
                    "arguments": {}
                  },
                  "organizationUser": {
                    "return": {
                      "accessType": {
                        "return": "string",
                        "arguments": {}
                      },
                      "apiTokens": {
                        "return": [
                          {
                            "id": {
                              "return": "object",
                              "arguments": {}
                            },
                            "jwtToken": {
                              "return": "string",
                              "arguments": {}
                            },
                            "name": {
                              "return": "string",
                              "arguments": {}
                            },
                            "organization": {
                              "return": {
                                "browserTabTitle": {
                                  "return": "string",
                                  "arguments": {}
                                },
                                "faviconLink": {
                                  "return": "string",
                                  "arguments": {}
                                },
                                "id": {
                                  "return": "object",
                                  "arguments": {}
                                },
                                "name": {
                                  "return": "string",
                                  "arguments": {}
                                },
                                "parent": {
                                  "return": {
                                    "browserTabTitle": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "faviconLink": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "id": {
                                      "return": "object",
                                      "arguments": {}
                                    },
                                    "name": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "parent": {
                                      "return": {
                                        "browserTabTitle": {
                                          "return": "string",
                                          "arguments": {}
                                        },
                                        "faviconLink": {
                                          "return": "string",
                                          "arguments": {}
                                        }
                                      }
                                    }
                                  }
                                }
                              }
                            }
                          }
                        ]
                      }
                    }
                  }
                }
              ]
            }
          }
        }
      }
    ]
  }
}

FetchCountryRiskInput: object

countryRiskId:
Example
{
  "countryRiskId": "object"
}

FetchCountryRiskResponse: object

countryRisk:
object
return:
arguments:
object
Example
{
  "countryRisk": {
    "return": {
      "country": {
        "return": "object",
        "arguments": {}
      },
      "countryCode": {
        "return": "object",
        "arguments": {}
      },
      "disabled": {
        "return": "boolean",
        "arguments": {}
      },
      "id": {
        "return": "object",
        "arguments": {}
      },
      "riskRating": {
        "return": "string",
        "arguments": {}
      }
    },
    "arguments": {}
  }
}

FetchCustodianActivitiesFilter: object

accountId:
custodianAccountNumber:
organizationId:
state:
symbol:
transactionType:
Example
{
  "accountId": "object",
  "custodianAccountNumber": "string",
  "organizationId": "object",
  "state": "string",
  "symbol": "string",
  "transactionType": "string"
}

FetchCustodianActivitiesInput: object

filter:
pagination:
Example
{
  "filter": {
    "accountId": "object",
    "custodianAccountNumber": "string",
    "organizationId": "object",
    "state": "string",
    "symbol": "string",
    "transactionType": "string"
  },
  "pagination": {
    "offSet": "number",
    "perPage": "number",
    "sortDesc": "boolean",
    "sortField": "string"
  }
}

FetchCustodianActivitiesResponse: object

custodianActivities:
object
return:
CustodianActivity
arguments:
object
totalCount:
object
return:
Int
arguments:
object
Example
{
  "custodianActivities": {
    "return": [
      {
        "account": {
          "return": {
            "affiliations": {
              "return": [
                {
                  "allocation": {
                    "return": "number",
                    "arguments": {}
                  },
                  "id": {
                    "return": "object",
                    "arguments": {}
                  },
                  "relation": {
                    "return": "string",
                    "arguments": {}
                  },
                  "signatureRequired": {
                    "return": "boolean",
                    "arguments": {}
                  },
                  "type": {
                    "return": "string",
                    "arguments": {}
                  },
                  "user": {
                    "return": {
                      "accessibleBy": {
                        "return": [
                          {
                            "displayOptions": {
                              "return": {
                                "hide": {
                                  "return": "boolean",
                                  "arguments": {}
                                },
                                "order": {
                                  "return": "number",
                                  "arguments": {}
                                }
                              },
                              "arguments": {}
                            },
                            "organizationUser": {
                              "return": {
                                "accessType": {
                                  "return": "string",
                                  "arguments": {}
                                },
                                "apiTokens": {
                                  "return": [
                                    {
                                      "id": {
                                        "return": "object",
                                        "arguments": {}
                                      },
                                      "jwtToken": {
                                        "return": "string",
                                        "arguments": {}
                                      },
                                      "name": {
                                        "return": "string",
                                        "arguments": {}
                                      },
                                      "organization": {
                                        "return": {
                                          "browserTabTitle": {
                                            "return": "string",
                                            "arguments": {}
                                          },
                                          "faviconLink": {
                                            "return": "string",
                                            "arguments": {}
                                          },
                                          "id": {
                                            "return": "object",
                                            "arguments": {}
                                          },
                                          "name": {
                                            "return": "string",
                                            "arguments": {}
                                          },
                                          "parent": {
                                            "return": {
                                              "browserTabTitle": {
                                                "return": "string",
                                                "arguments": {}
                                              }
                                            }
                                          }
                                        }
                                      }
                                    }
                                  ]
                                }
                              }
                            }
                          }
                        ]
                      }
                    }
                  }
                }
              ]
            }
          }
        }
      }
    ]
  }
}

FetchCustodianConnectionResponse: object

custodianConnection:
object
return:
arguments:
object
Example
{
  "custodianConnection": {
    "return": {
      "accountOpenningSubmissionType": {
        "return": "string",
        "arguments": {}
      },
      "accountTypeSettings": {
        "return": [
          {
            "availableCurrencies": {
              "return": [
                "string"
              ],
              "arguments": {}
            },
            "baseCurrency": {
              "return": "string",
              "arguments": {}
            },
            "id": {
              "return": "object",
              "arguments": {}
            },
            "isAutoSweepEnabled": {
              "return": "boolean",
              "arguments": {}
            },
            "isMultiCurrencyEnabled": {
              "return": "boolean",
              "arguments": {}
            },
            "type": {
              "return": "string",
              "arguments": {}
            }
          }
        ],
        "arguments": {}
      },
      "allowFractionalTrading": {
        "return": "boolean",
        "arguments": {}
      },
      "allowTransactionCreation": {
        "return": "boolean",
        "arguments": {}
      },
      "baseCurrency": {
        "return": "string",
        "arguments": {}
      },
      "config": {
        "return": "object",
        "arguments": {}
      },
      "custodianActivityImportFilePaths": {
        "return": [
          "string"
        ],
        "arguments": {}
      },
      "custodianSnapshotImportFilePaths": {
        "return": [
          "object"
        ],
        "arguments": {}
      },
      "custodianUsersImportFilePath": {
        "return": "object",
        "arguments": {}
      },
      "customerName": {
        "return": "string",
        "arguments": {}
      },
      "default": {
        "return": "boolean",
        "arguments": {}
      },
      "disabledFlagTypes": {
        "return": [
          "string"
        ],
        "arguments": {}
      },
      "enableAccountOpeningSubmission": {
        "return": "boolean",
        "arguments": {}
      },
      "enableAutoReconcileActivities": {
        "return": "boolean",
        "arguments": {}
      },
      "enableAutoReconcilePositions": {
        "return": "boolean",
        "arguments": {}
      },
      "enableCustodianAccountImport": {
        "return": "boolean",
        "arguments": {}
      },
      "enableCustodianActivityImport": {
        "return": "boolean"
      }
    }
  }
}

FetchCustodianConnectionsInput: object

filter:
pagination:
Example
{
  "filter": {
    "accountTypes": [
      "string"
    ],
    "customerName": "string",
    "default": "boolean",
    "inventoryAccount": "object",
    "moneyAccount": "object",
    "name": "string",
    "organizationId": "object"
  },
  "pagination": {
    "offSet": "number",
    "perPage": "number",
    "sortDesc": "boolean",
    "sortField": "string"
  }
}

FetchCustodianConnectionsResponse: object

custodianConnections:
object
return:
CustodianConnection
arguments:
object
totalCount:
object
return:
Int
arguments:
object
Example
{
  "custodianConnections": {
    "return": [
      {
        "accountOpenningSubmissionType": {
          "return": "string",
          "arguments": {}
        },
        "accountTypeSettings": {
          "return": [
            {
              "availableCurrencies": {
                "return": [
                  "string"
                ],
                "arguments": {}
              },
              "baseCurrency": {
                "return": "string",
                "arguments": {}
              },
              "id": {
                "return": "object",
                "arguments": {}
              },
              "isAutoSweepEnabled": {
                "return": "boolean",
                "arguments": {}
              },
              "isMultiCurrencyEnabled": {
                "return": "boolean",
                "arguments": {}
              },
              "type": {
                "return": "string",
                "arguments": {}
              }
            }
          ],
          "arguments": {}
        },
        "allowFractionalTrading": {
          "return": "boolean",
          "arguments": {}
        },
        "allowTransactionCreation": {
          "return": "boolean",
          "arguments": {}
        },
        "baseCurrency": {
          "return": "string",
          "arguments": {}
        },
        "config": {
          "return": "object",
          "arguments": {}
        },
        "custodianActivityImportFilePaths": {
          "return": [
            "string"
          ],
          "arguments": {}
        },
        "custodianSnapshotImportFilePaths": {
          "return": [
            "object"
          ],
          "arguments": {}
        },
        "custodianUsersImportFilePath": {
          "return": "object",
          "arguments": {}
        },
        "customerName": {
          "return": "string",
          "arguments": {}
        },
        "default": {
          "return": "boolean",
          "arguments": {}
        },
        "disabledFlagTypes": {
          "return": [
            "string"
          ],
          "arguments": {}
        },
        "enableAccountOpeningSubmission": {
          "return": "boolean",
          "arguments": {}
        },
        "enableAutoReconcileActivities": {
          "return": "boolean",
          "arguments": {}
        },
        "enableAutoReconcilePositions": {
          "return": "boolean",
          "arguments": {}
        },
        "enableCustodianAccountImport": {
          "return": "boolean",
          "arguments": {}
        },
        "enableCustodianActivityImport": {}
      }
    ]
  }
}

FetchCustodianResponse: object

custodian:
object
return:
arguments:
object
Example
{
  "custodian": {
    "return": {
      "customerName": {
        "return": "string",
        "arguments": {}
      },
      "id": {
        "return": "object",
        "arguments": {}
      },
      "inventoryAccount": {
        "return": {
          "affiliations": {
            "return": [
              {
                "allocation": {
                  "return": "number",
                  "arguments": {}
                },
                "id": {
                  "return": "object",
                  "arguments": {}
                },
                "relation": {
                  "return": "string",
                  "arguments": {}
                },
                "signatureRequired": {
                  "return": "boolean",
                  "arguments": {}
                },
                "type": {
                  "return": "string",
                  "arguments": {}
                },
                "user": {
                  "return": {
                    "accessibleBy": {
                      "return": [
                        {
                          "displayOptions": {
                            "return": {
                              "hide": {
                                "return": "boolean",
                                "arguments": {}
                              },
                              "order": {
                                "return": "number",
                                "arguments": {}
                              }
                            },
                            "arguments": {}
                          },
                          "organizationUser": {
                            "return": {
                              "accessType": {
                                "return": "string",
                                "arguments": {}
                              },
                              "apiTokens": {
                                "return": [
                                  {
                                    "id": {
                                      "return": "object",
                                      "arguments": {}
                                    },
                                    "jwtToken": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "name": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "organization": {
                                      "return": {
                                        "browserTabTitle": {
                                          "return": "string",
                                          "arguments": {}
                                        },
                                        "faviconLink": {
                                          "return": "string",
                                          "arguments": {}
                                        },
                                        "id": {
                                          "return": "object",
                                          "arguments": {}
                                        },
                                        "name": {
                                          "return": "string",
                                          "arguments": {}
                                        }
                                      }
                                    }
                                  }
                                ]
                              }
                            }
                          }
                        }
                      ]
                    }
                  }
                }
              }
            ]
          }
        }
      }
    }
  }
}

FetchCustodianStatementsFilter: object

accountIds:
ObjectID
dateAfter:
dateBefore:
types:
CustodianStatementTypes
userId:
Example
{
  "accountIds": [
    "object"
  ],
  "dateAfter": "object",
  "dateBefore": "object",
  "types": [
    "string"
  ],
  "userId": "object"
}

FetchCustodianStatementsInput: object

filter:
pagination:
Example
{
  "filter": {
    "accountIds": [
      "object"
    ],
    "dateAfter": "object",
    "dateBefore": "object",
    "types": [
      "string"
    ],
    "userId": "object"
  },
  "pagination": {
    "offSet": "number",
    "perPage": "number",
    "sortDesc": "boolean",
    "sortField": "string"
  }
}

FetchCustodianStatementsPagination: object

offSet:
Int
perPage:
Int
sortDesc:
sortField:
Example
{
  "offSet": "number",
  "perPage": "number",
  "sortDesc": "boolean",
  "sortField": "string"
}

FetchCustodianStatementsResponse: object

statements:
object
return:
CustodianStatements
arguments:
object
totalCount:
object
return:
Int
arguments:
object
Example
{
  "statements": {
    "return": [
      {
        "account": {
          "return": {
            "affiliations": {
              "return": [
                {
                  "allocation": {
                    "return": "number",
                    "arguments": {}
                  },
                  "id": {
                    "return": "object",
                    "arguments": {}
                  },
                  "relation": {
                    "return": "string",
                    "arguments": {}
                  },
                  "signatureRequired": {
                    "return": "boolean",
                    "arguments": {}
                  },
                  "type": {
                    "return": "string",
                    "arguments": {}
                  },
                  "user": {
                    "return": {
                      "accessibleBy": {
                        "return": [
                          {
                            "displayOptions": {
                              "return": {
                                "hide": {
                                  "return": "boolean",
                                  "arguments": {}
                                },
                                "order": {
                                  "return": "number",
                                  "arguments": {}
                                }
                              },
                              "arguments": {}
                            },
                            "organizationUser": {
                              "return": {
                                "accessType": {
                                  "return": "string",
                                  "arguments": {}
                                },
                                "apiTokens": {
                                  "return": [
                                    {
                                      "id": {
                                        "return": "object",
                                        "arguments": {}
                                      },
                                      "jwtToken": {
                                        "return": "string",
                                        "arguments": {}
                                      },
                                      "name": {
                                        "return": "string",
                                        "arguments": {}
                                      },
                                      "organization": {
                                        "return": {
                                          "browserTabTitle": {
                                            "return": "string",
                                            "arguments": {}
                                          },
                                          "faviconLink": {
                                            "return": "string",
                                            "arguments": {}
                                          },
                                          "id": {
                                            "return": "object",
                                            "arguments": {}
                                          },
                                          "name": {
                                            "return": "string",
                                            "arguments": {}
                                          },
                                          "parent": {
                                            "return": {
                                              "browserTabTitle": {
                                                "return": "string",
                                                "arguments": {}
                                              }
                                            }
                                          }
                                        }
                                      }
                                    }
                                  ]
                                }
                              }
                            }
                          }
                        ]
                      }
                    }
                  }
                }
              ]
            }
          }
        }
      }
    ]
  }
}

FetchCustodianTransactionsFilter: object

accountIds:
ObjectID
clientGroupId:
dateAfter:
dateBefore:
organizationId:
types:
CustodianTransactionTypes
userId:
Example
{
  "accountIds": [
    "object"
  ],
  "clientGroupId": "object",
  "dateAfter": "object",
  "dateBefore": "object",
  "organizationId": "object",
  "types": [
    "string"
  ],
  "userId": "object"
}

FetchCustodianTransactionsInput: object

filter:
pagination:
Example
{
  "filter": {
    "accountIds": [
      "object"
    ],
    "clientGroupId": "object",
    "dateAfter": "object",
    "dateBefore": "object",
    "organizationId": "object",
    "types": [
      "string"
    ],
    "userId": "object"
  },
  "pagination": {
    "offSet": "number",
    "perPage": "number",
    "sortDesc": "boolean",
    "sortField": "string"
  }
}

FetchCustodianTransactionsPagination: object

offSet:
Int
perPage:
Int
sortDesc:
sortField:
Example
{
  "offSet": "number",
  "perPage": "number",
  "sortDesc": "boolean",
  "sortField": "string"
}

FetchCustodianTransactionsResponse: object

totalCount:
object
return:
Int
arguments:
object
transactions:
object
return:
CustodianTransaction
arguments:
object
Example
{
  "totalCount": {
    "return": "number",
    "arguments": {}
  },
  "transactions": {
    "return": [
      {
        "account": {
          "return": {
            "affiliations": {
              "return": [
                {
                  "allocation": {
                    "return": "number",
                    "arguments": {}
                  },
                  "id": {
                    "return": "object",
                    "arguments": {}
                  },
                  "relation": {
                    "return": "string",
                    "arguments": {}
                  },
                  "signatureRequired": {
                    "return": "boolean",
                    "arguments": {}
                  },
                  "type": {
                    "return": "string",
                    "arguments": {}
                  },
                  "user": {
                    "return": {
                      "accessibleBy": {
                        "return": [
                          {
                            "displayOptions": {
                              "return": {
                                "hide": {
                                  "return": "boolean",
                                  "arguments": {}
                                },
                                "order": {
                                  "return": "number",
                                  "arguments": {}
                                }
                              },
                              "arguments": {}
                            },
                            "organizationUser": {
                              "return": {
                                "accessType": {
                                  "return": "string",
                                  "arguments": {}
                                },
                                "apiTokens": {
                                  "return": [
                                    {
                                      "id": {
                                        "return": "object",
                                        "arguments": {}
                                      },
                                      "jwtToken": {
                                        "return": "string",
                                        "arguments": {}
                                      },
                                      "name": {
                                        "return": "string",
                                        "arguments": {}
                                      },
                                      "organization": {
                                        "return": {
                                          "browserTabTitle": {
                                            "return": "string",
                                            "arguments": {}
                                          },
                                          "faviconLink": {
                                            "return": "string",
                                            "arguments": {}
                                          },
                                          "id": {
                                            "return": "object",
                                            "arguments": {}
                                          },
                                          "name": {
                                            "return": "string",
                                            "arguments": {}
                                          },
                                          "parent": {
                                            "return": {}
                                          }
                                        }
                                      }
                                    }
                                  ]
                                }
                              }
                            }
                          }
                        ]
                      }
                    }
                  }
                }
              ]
            }
          }
        }
      }
    ]
  }
}

FetchCustomFieldResponse: object

customField:
object
return:
arguments:
object
Example
{
  "customField": {
    "return": {
      "conditionalRules": {
        "return": [
          {
            "comparison": {
              "return": "string",
              "arguments": {}
            },
            "field": {
              "return": "string",
              "arguments": {}
            },
            "value": {
              "return": "string",
              "arguments": {}
            }
          }
        ],
        "arguments": {}
      },
      "externalField": {
        "return": "string",
        "arguments": {}
      },
      "format": {
        "return": "string",
        "arguments": {}
      },
      "id": {
        "return": "object",
        "arguments": {}
      },
      "key": {
        "return": "string",
        "arguments": {}
      },
      "objectType": {
        "return": "string",
        "arguments": {}
      },
      "organization": {
        "return": {
          "browserTabTitle": {
            "return": "string",
            "arguments": {}
          },
          "faviconLink": {
            "return": "string",
            "arguments": {}
          },
          "id": {
            "return": "object",
            "arguments": {}
          },
          "name": {
            "return": "string",
            "arguments": {}
          },
          "parent": {
            "return": {
              "browserTabTitle": {
                "return": "string",
                "arguments": {}
              },
              "faviconLink": {
                "return": "string",
                "arguments": {}
              },
              "id": {
                "return": "object",
                "arguments": {}
              },
              "name": {
                "return": "string",
                "arguments": {}
              },
              "parent": {
                "return": {
                  "browserTabTitle": {
                    "return": "string",
                    "arguments": {}
                  },
                  "faviconLink": {
                    "return": "string",
                    "arguments": {}
                  },
                  "id": {
                    "return": "object",
                    "arguments": {}
                  },
                  "name": {
                    "return": "string",
                    "arguments": {}
                  },
                  "parent": {}
                }
              }
            }
          }
        }
      }
    }
  }
}

FetchCustomFieldsInput: object

filter:
pagination:
Example
{
  "filter": {
    "keys": [
      "string"
    ],
    "objectType": "string",
    "organizationId": "object",
    "type": "string",
    "workflowStep": "string"
  },
  "pagination": {
    "offSet": "number",
    "perPage": "number",
    "sortDesc": "boolean",
    "sortField": "string"
  }
}

FetchCustomFieldsResponse: object

customFields:
object
return:
CustomField
arguments:
object
totalCount:
object
return:
Int
arguments:
object
Example
{
  "customFields": {
    "return": [
      {
        "conditionalRules": {
          "return": [
            {
              "comparison": {
                "return": "string",
                "arguments": {}
              },
              "field": {
                "return": "string",
                "arguments": {}
              },
              "value": {
                "return": "string",
                "arguments": {}
              }
            }
          ],
          "arguments": {}
        },
        "externalField": {
          "return": "string",
          "arguments": {}
        },
        "format": {
          "return": "string",
          "arguments": {}
        },
        "id": {
          "return": "object",
          "arguments": {}
        },
        "key": {
          "return": "string",
          "arguments": {}
        },
        "objectType": {
          "return": "string",
          "arguments": {}
        },
        "organization": {
          "return": {
            "browserTabTitle": {
              "return": "string",
              "arguments": {}
            },
            "faviconLink": {
              "return": "string",
              "arguments": {}
            },
            "id": {
              "return": "object",
              "arguments": {}
            },
            "name": {
              "return": "string",
              "arguments": {}
            },
            "parent": {
              "return": {
                "browserTabTitle": {
                  "return": "string",
                  "arguments": {}
                },
                "faviconLink": {
                  "return": "string",
                  "arguments": {}
                },
                "id": {
                  "return": "object",
                  "arguments": {}
                },
                "name": {
                  "return": "string",
                  "arguments": {}
                },
                "parent": {
                  "return": {
                    "browserTabTitle": {
                      "return": "string",
                      "arguments": {}
                    },
                    "faviconLink": {
                      "return": "string",
                      "arguments": {}
                    },
                    "id": {
                      "return": "object",
                      "arguments": {}
                    },
                    "name": {
                      "return": "string",
                      "arguments": {}
                    },
                    "parent": {}
                  }
                }
              }
            }
          }
        }
      }
    ]
  }
}

FetchDashboardsResponse: object

dashboards:
object
return:
Dashboard
arguments:
object
Example
{
  "dashboards": {
    "return": [
      {
        "archived": {
          "return": "boolean",
          "arguments": {}
        },
        "id": {
          "return": "object",
          "arguments": {}
        },
        "name": {
          "return": "string",
          "arguments": {}
        },
        "organization": {
          "return": {
            "browserTabTitle": {
              "return": "string",
              "arguments": {}
            },
            "faviconLink": {
              "return": "string",
              "arguments": {}
            },
            "id": {
              "return": "object",
              "arguments": {}
            },
            "name": {
              "return": "string",
              "arguments": {}
            },
            "parent": {
              "return": {
                "browserTabTitle": {
                  "return": "string",
                  "arguments": {}
                },
                "faviconLink": {
                  "return": "string",
                  "arguments": {}
                },
                "id": {
                  "return": "object",
                  "arguments": {}
                },
                "name": {
                  "return": "string",
                  "arguments": {}
                },
                "parent": {
                  "return": {
                    "browserTabTitle": {
                      "return": "string",
                      "arguments": {}
                    },
                    "faviconLink": {
                      "return": "string",
                      "arguments": {}
                    },
                    "id": {
                      "return": "object",
                      "arguments": {}
                    },
                    "name": {
                      "return": "string",
                      "arguments": {}
                    },
                    "parent": {
                      "return": {
                        "browserTabTitle": {
                          "return": "string",
                          "arguments": {}
                        },
                        "faviconLink": {
                          "return": "string",
                          "arguments": {}
                        },
                        "id": {
                          "return": "object",
                          "arguments": {}
                        },
                        "name": {
                          "return": "string",
                          "arguments": {}
                        },
                        "parent": {
                          "return": {
                            "browserTabTitle": {
                              "return": "string",
                              "arguments": {}
                            }
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    ]
  }
}

FetchEodFilesInput: object

lastKey:
Example
{
  "lastKey": "string"
}

FetchEodFilesResponse: object

eodFiles:
object
return:
EodFile
arguments:
object
Example
{
  "eodFiles": {
    "return": [
      {
        "name": {
          "return": "string",
          "arguments": {}
        },
        "url": {
          "return": "string",
          "arguments": {}
        }
      }
    ],
    "arguments": {}
  }
}

FetchEventsInput: object

filter:
pagination:
Example
{
  "filter": {
    "createdAtAfter": "object",
    "createdAtBefore": "object",
    "eventType": "string",
    "objectId": "object",
    "objectType": "string",
    "organizationId": "object",
    "userId": "object",
    "webhookId": "object"
  },
  "pagination": {
    "offSet": "number",
    "perPage": "number",
    "sortDesc": "boolean",
    "sortField": "string"
  }
}

FetchEventsResponse: object

events:
object
return:
Event
arguments:
object
totalCount:
object
return:
Int
arguments:
object
Example
{
  "events": {
    "return": [
      {
        "createdAt": {
          "return": "object",
          "arguments": {}
        },
        "eventType": {
          "return": "string",
          "arguments": {}
        },
        "extraData": {
          "return": "string",
          "arguments": {}
        },
        "id": {
          "return": "object",
          "arguments": {}
        },
        "objectId": {
          "return": "object",
          "arguments": {}
        },
        "objectPayload": {
          "return": "object",
          "arguments": {}
        },
        "objectType": {
          "return": "string",
          "arguments": {}
        }
      }
    ],
    "arguments": {}
  },
  "totalCount": {
    "return": "number",
    "arguments": {}
  }
}

FetchExportInput: object

exportId:
Example
{
  "exportId": "object"
}

FetchExportResponse: object

export:
object
return:
arguments:
object
Example
{
  "export": {
    "return": {
      "columns": {
        "return": [
          "string"
        ],
        "arguments": {}
      },
      "fileUrl": {
        "return": "string",
        "arguments": {}
      },
      "filters": {
        "return": [
          {
            "comparison": {
              "return": "string",
              "arguments": {}
            },
            "field": {
              "return": "string",
              "arguments": {}
            },
            "value": {
              "return": "string",
              "arguments": {}
            }
          }
        ],
        "arguments": {}
      },
      "id": {
        "return": "object",
        "arguments": {}
      },
      "organizationUser": {
        "return": {
          "email": {
            "return": "string",
            "arguments": {}
          },
          "firstName": {
            "return": "string",
            "arguments": {}
          },
          "id": {
            "return": "object",
            "arguments": {}
          },
          "language": {
            "return": "string",
            "arguments": {}
          },
          "lastName": {
            "return": "string",
            "arguments": {}
          },
          "organization": {
            "return": {
              "browserTabTitle": {
                "return": "string",
                "arguments": {}
              },
              "faviconLink": {
                "return": "string",
                "arguments": {}
              },
              "id": {
                "return": "object",
                "arguments": {}
              },
              "name": {
                "return": "string",
                "arguments": {}
              },
              "parent": {
                "return": {
                  "browserTabTitle": {
                    "return": "string",
                    "arguments": {}
                  },
                  "faviconLink": {
                    "return": "string",
                    "arguments": {}
                  },
                  "id": {
                    "return": "object",
                    "arguments": {}
                  },
                  "name": {
                    "return": "string",
                    "arguments": {}
                  },
                  "parent": {
                    "return": {
                      "browserTabTitle": {}
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

FetchExternalVendorUsageInput: object

filter:
pagination:
Example
{
  "filter": {
    "organizationId": "object",
    "provider": "string",
    "type": "string"
  },
  "pagination": {
    "offSet": "number",
    "perPage": "number",
    "sortDesc": "boolean",
    "sortField": "string"
  }
}

FetchExternalVendorUsagesResponse: object

externalVendorUsages:
object
return:
ExternalVendorUsage
arguments:
object
totalCount:
object
return:
Int
arguments:
object
Example
{
  "externalVendorUsages": {
    "return": [
      {
        "id": {
          "return": "object",
          "arguments": {}
        },
        "organization": {
          "return": {
            "accountTypeTaxRanks": {
              "return": [
                {
                  "accountType": {
                    "return": "string",
                    "arguments": {}
                  },
                  "id": {
                    "return": "object",
                    "arguments": {}
                  },
                  "taxRank": {
                    "return": "number",
                    "arguments": {}
                  }
                }
              ],
              "arguments": {}
            },
            "allowAccessToSubOrganizations": {
              "return": "boolean",
              "arguments": {}
            },
            "allowDirectCommunication": {
              "return": "boolean",
              "arguments": {}
            },
            "allowInactiveUserAdjustments": {
              "return": "boolean",
              "arguments": {}
            },
            "allowInactiveUserFeeCalculation": {
              "return": "boolean",
              "arguments": {}
            },
            "allowInactiveUserRebalancing": {
              "return": "boolean",
              "arguments": {}
            },
            "allowInstantInvest": {
              "return": "boolean",
              "arguments": {}
            },
            "allowPortfolioPerGoal": {
              "return": "boolean",
              "arguments": {}
            },
            "allowPostOptimizationEditing": {
              "return": "boolean",
              "arguments": {}
            },
            "allowViewSubTradeRequestPairs": {
              "return": "boolean",
              "arguments": {}
            },
            "applicableJurisdictions": {
              "return": {
                "all": {
                  "return": "boolean",
                  "arguments": {}
                },
                "only": {
                  "return": [
                    "string"
                  ],
                  "arguments": {}
                }
              },
              "arguments": {}
            },
            "applicableLocalization": {
              "return": {
                "countries": {
                  "return": [
                    "string"
                  ],
                  "arguments": {}
                },
                "dateFormat": {
                  "return": "string",
                  "arguments": {}
                },
                "defaultCurrency": {
                  "return": "string",
                  "arguments": {}
                },
                "defaultLanguage": {
                  "return": "string",
                  "arguments": {}
                },
                "id": {}
              }
            }
          }
        }
      }
    ]
  }
}

FetchFeatureFlagsResponse: object

featureFlags:
object
return:
FeatureFlag
arguments:
object
Example
{
  "featureFlags": {
    "return": [
      {
        "group": {
          "return": "string",
          "arguments": {}
        },
        "translatedDescription": {
          "return": {
            "en": {
              "return": "string",
              "arguments": {}
            },
            "fr": {
              "return": "string",
              "arguments": {}
            }
          },
          "arguments": {}
        },
        "value": {
          "return": "string",
          "arguments": {}
        }
      }
    ],
    "arguments": {}
  }
}

FetchFeeTierResponse: object

feeTier:
object
return:
arguments:
object
Example
{
  "feeTier": {
    "return": {
      "blendedGrid": {
        "return": "boolean",
        "arguments": {}
      },
      "chargeForCash": {
        "return": "boolean",
        "arguments": {}
      },
      "chargeForCashOnHold": {
        "return": "boolean",
        "arguments": {}
      },
      "createdAt": {
        "return": "object",
        "arguments": {}
      },
      "default": {
        "return": "boolean",
        "arguments": {}
      },
      "discountPercentage": {
        "return": "number",
        "arguments": {}
      },
      "flatAnnualFeeBps": {
        "return": "number",
        "arguments": {}
      },
      "grid": {
        "return": [
          {
            "annualFeeBps": {
              "return": "number",
              "arguments": {}
            },
            "annualFeeCents": {
              "return": "object",
              "arguments": {}
            },
            "minMarketValueCents": {
              "return": "object",
              "arguments": {}
            }
          }
        ],
        "arguments": {}
      },
      "gridScopeType": {
        "return": "string",
        "arguments": {}
      },
      "id": {
        "return": "object",
        "arguments": {}
      },
      "name": {
        "return": "string",
        "arguments": {}
      },
      "organization": {
        "return": {
          "browserTabTitle": {
            "return": "string",
            "arguments": {}
          },
          "faviconLink": {
            "return": "string",
            "arguments": {}
          },
          "id": {
            "return": "object",
            "arguments": {}
          },
          "name": {
            "return": "string",
            "arguments": {}
          },
          "parent": {
            "return": {
              "browserTabTitle": {
                "return": "string",
                "arguments": {}
              },
              "faviconLink": {
                "return": "string",
                "arguments": {}
              },
              "id": {
                "return": "object",
                "arguments": {}
              },
              "name": {
                "return": "string",
                "arguments": {}
              },
              "parent": {}
            }
          }
        }
      }
    }
  }
}

FetchFeeTiersInput: object

filter:
pagination:
Example
{
  "filter": {
    "default": "boolean",
    "gridScopeTypes": [
      "string"
    ],
    "hasDiscountPercentage": "boolean",
    "hasFlatAnnualFeeBps": "boolean",
    "hasGrid": "boolean",
    "name": "string",
    "organizationId": "object",
    "states": [
      "string"
    ]
  },
  "pagination": {
    "offSet": "number",
    "perPage": "number",
    "sortDesc": "boolean",
    "sortField": "string"
  }
}

FetchFeeTiersResponse: object

feeTiers:
object
return:
FeeTier
arguments:
object
totalCount:
object
return:
Int
arguments:
object
Example
{
  "feeTiers": {
    "return": [
      {
        "blendedGrid": {
          "return": "boolean",
          "arguments": {}
        },
        "chargeForCash": {
          "return": "boolean",
          "arguments": {}
        },
        "chargeForCashOnHold": {
          "return": "boolean",
          "arguments": {}
        },
        "createdAt": {
          "return": "object",
          "arguments": {}
        },
        "default": {
          "return": "boolean",
          "arguments": {}
        },
        "discountPercentage": {
          "return": "number",
          "arguments": {}
        },
        "flatAnnualFeeBps": {
          "return": "number",
          "arguments": {}
        },
        "grid": {
          "return": [
            {
              "annualFeeBps": {
                "return": "number",
                "arguments": {}
              },
              "annualFeeCents": {
                "return": "object",
                "arguments": {}
              },
              "minMarketValueCents": {
                "return": "object",
                "arguments": {}
              }
            }
          ],
          "arguments": {}
        },
        "gridScopeType": {
          "return": "string",
          "arguments": {}
        },
        "id": {
          "return": "object",
          "arguments": {}
        },
        "name": {
          "return": "string",
          "arguments": {}
        },
        "organization": {
          "return": {
            "browserTabTitle": {
              "return": "string",
              "arguments": {}
            },
            "faviconLink": {
              "return": "string",
              "arguments": {}
            },
            "id": {
              "return": "object",
              "arguments": {}
            },
            "name": {
              "return": "string",
              "arguments": {}
            },
            "parent": {
              "return": {
                "browserTabTitle": {
                  "return": "string",
                  "arguments": {}
                },
                "faviconLink": {
                  "return": "string",
                  "arguments": {}
                },
                "id": {
                  "return": "object",
                  "arguments": {}
                },
                "name": {
                  "return": "string",
                  "arguments": {}
                }
              }
            }
          }
        }
      }
    ]
  }
}

FetchFileDocumentResponse: object

fileDocument:
object
return:
arguments:
object
Example
{
  "fileDocument": {
    "return": {
      "createdAt": {
        "return": "object",
        "arguments": {}
      },
      "creator": {
        "return": {
          "email": {
            "return": "string",
            "arguments": {}
          },
          "firstName": {
            "return": "string",
            "arguments": {}
          },
          "id": {
            "return": "object",
            "arguments": {}
          },
          "language": {
            "return": "string",
            "arguments": {}
          },
          "lastName": {
            "return": "string",
            "arguments": {}
          },
          "organization": {
            "return": {
              "browserTabTitle": {
                "return": "string",
                "arguments": {}
              },
              "faviconLink": {
                "return": "string",
                "arguments": {}
              },
              "id": {
                "return": "object",
                "arguments": {}
              },
              "name": {
                "return": "string",
                "arguments": {}
              },
              "parent": {
                "return": {
                  "browserTabTitle": {
                    "return": "string",
                    "arguments": {}
                  },
                  "faviconLink": {
                    "return": "string",
                    "arguments": {}
                  },
                  "id": {
                    "return": "object",
                    "arguments": {}
                  },
                  "name": {
                    "return": "string",
                    "arguments": {}
                  },
                  "parent": {
                    "return": {
                      "browserTabTitle": {
                        "return": "string",
                        "arguments": {}
                      },
                      "faviconLink": {
                        "return": "string",
                        "arguments": {}
                      },
                      "id": {
                        "return": "object",
                        "arguments": {}
                      },
                      "name": {
                        "return": "string",
                        "arguments": {}
                      },
                      "parent": {
                        "return": {
                          "browserTabTitle": {
                            "return": "string",
                            "arguments": {}
                          },
                          "faviconLink": {
                            "return": "string",
                            "arguments": {}
                          },
                          "id": {}
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

FetchFileDocumentsInput: object

Input type for fetching fileDocuments

filter:

To filter the fileDocuments

pagination:

To organize the response as per the pagination fields

Example
{
  "filter": {
    "objectIds": [
      "object"
    ],
    "objectTypes": [
      "string"
    ],
    "organizationId": "object",
    "sourceIds": [
      "object"
    ],
    "types": [
      "string"
    ],
    "userIds": [
      "object"
    ]
  },
  "pagination": {
    "offSet": "number",
    "perPage": "number",
    "sortDesc": "boolean",
    "sortField": "string"
  }
}

FetchFileDocumentsResponse: object

Type definition for fetching fileDocuments

fileDocuments:
object

Returns an array of fileDocuments objects

return:
FileDocument
arguments:
object
totalCount:
object

Total number of the fileDocuments records that satisfies a specified filter

return:
Int
arguments:
object
Example
{
  "fileDocuments": {
    "return": [
      {
        "createdAt": {
          "return": "object",
          "arguments": {}
        },
        "creator": {
          "return": {
            "email": {
              "return": "string",
              "arguments": {}
            },
            "firstName": {
              "return": "string",
              "arguments": {}
            },
            "id": {
              "return": "object",
              "arguments": {}
            },
            "language": {
              "return": "string",
              "arguments": {}
            },
            "lastName": {
              "return": "string",
              "arguments": {}
            },
            "organization": {
              "return": {
                "browserTabTitle": {
                  "return": "string",
                  "arguments": {}
                },
                "faviconLink": {
                  "return": "string",
                  "arguments": {}
                },
                "id": {
                  "return": "object",
                  "arguments": {}
                },
                "name": {
                  "return": "string",
                  "arguments": {}
                },
                "parent": {
                  "return": {
                    "browserTabTitle": {
                      "return": "string",
                      "arguments": {}
                    },
                    "faviconLink": {
                      "return": "string",
                      "arguments": {}
                    },
                    "id": {
                      "return": "object",
                      "arguments": {}
                    },
                    "name": {
                      "return": "string",
                      "arguments": {}
                    },
                    "parent": {
                      "return": {
                        "browserTabTitle": {
                          "return": "string",
                          "arguments": {}
                        },
                        "faviconLink": {
                          "return": "string",
                          "arguments": {}
                        },
                        "id": {
                          "return": "object",
                          "arguments": {}
                        },
                        "name": {
                          "return": "string",
                          "arguments": {}
                        },
                        "parent": {
                          "return": {
                            "browserTabTitle": {
                              "return": "string",
                              "arguments": {}
                            },
                            "faviconLink": {
                              "return": "string",
                              "arguments": {}
                            }
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    ]
  }
}

FetchFileUploadUrlInput: object

fileName:
objectId:
objectType:
sourceId:
type:
userId:
Example
{
  "fileName": "string",
  "objectId": "object",
  "objectType": "string",
  "sourceId": "string",
  "type": "string",
  "userId": "object"
}

FetchFileUploadUrlResponse: object

temporarySignedURL:
object
return:
arguments:
object
Example
{
  "temporarySignedURL": {
    "return": "string",
    "arguments": {}
  }
}

FetchFinancialProductInput: object

financialProductId:

This is the financialProductId and it is auto-generated by OneVest for each Financial Product.

Example
{
  "financialProductId": "object"
}

FetchFinancialProductResponse: object

financialProduct:
object

The Financial product.

return:
arguments:
object
Example
{
  "financialProduct": {
    "return": {
      "assignable": {
        "return": "boolean",
        "arguments": {}
      },
      "autoUpdatePrices": {
        "return": "boolean",
        "arguments": {}
      },
      "children": {
        "return": [
          {
            "financialProduct": {
              "return": {
                "assignable": {
                  "return": "boolean",
                  "arguments": {}
                },
                "autoUpdatePrices": {
                  "return": "boolean",
                  "arguments": {}
                },
                "children": {
                  "return": [
                    {
                      "financialProduct": {
                        "return": {
                          "assignable": {
                            "return": "boolean",
                            "arguments": {}
                          },
                          "autoUpdatePrices": {
                            "return": "boolean",
                            "arguments": {}
                          },
                          "children": {
                            "return": [
                              {
                                "financialProduct": {
                                  "return": {
                                    "assignable": {
                                      "return": "boolean",
                                      "arguments": {}
                                    },
                                    "autoUpdatePrices": {
                                      "return": "boolean",
                                      "arguments": {}
                                    },
                                    "children": {
                                      "return": [
                                        {
                                          "financialProduct": {
                                            "return": {
                                              "assignable": {
                                                "return": "boolean",
                                                "arguments": {}
                                              },
                                              "autoUpdatePrices": {
                                                "return": "boolean",
                                                "arguments": {}
                                              },
                                              "children": {
                                                "return": [
                                                  {
                                                    "financialProduct": {
                                                      "return": {
                                                        "assignable": {
                                                          "return": "boolean",
                                                          "arguments": {}
                                                        },
                                                        "autoUpdatePrices": {
                                                          "return": "boolean",
                                                          "arguments": {}
                                                        },
                                                        "children": {
                                                          "return": [
                                                            {
                                                              "financialProduct": {
                                                                "return": {
                                                                  "assignable": {
                                                                    "return": "boolean",
                                                                    "arguments": {}
                                                                  },
                                                                  "autoUpdatePrices": {}
                                                                }
                                                              }
                                                            }
                                                          ]
                                                        }
                                                      }
                                                    }
                                                  }
                                                ]
                                              }
                                            }
                                          }
                                        }
                                      ]
                                    }
                                  }
                                }
                              }
                            ]
                          }
                        }
                      }
                    }
                  ]
                }
              }
            }
          }
        ]
      }
    }
  }
}

FetchFinancialProductsInput: object

filter:
pagination:
Example
{
  "filter": {
    "autoUpdatePrices": "boolean",
    "currency": "string",
    "exchange": "string",
    "hasSubstituteProduct": "boolean",
    "isScheduled": "boolean",
    "name": "string",
    "organizationId": "object",
    "primaryAssetClassId": "object",
    "searchText": "string",
    "secondaryAssetClassId": "object",
    "state": "string",
    "tertiaryAssetClassId": "object",
    "themeId": "object"
  },
  "pagination": {
    "offset": "number",
    "perPage": "number",
    "sortDesc": "boolean",
    "sortField": "string"
  }
}

FetchFinancialProductsResponse: object

financialProducts:
object

The Financial products.

return:
FinancialProduct
arguments:
object
totalCount:
object

The number of financial products.

return:
Int
arguments:
object
Example
{
  "financialProducts": {
    "return": [
      {
        "assignable": {
          "return": "boolean",
          "arguments": {}
        },
        "autoUpdatePrices": {
          "return": "boolean",
          "arguments": {}
        },
        "children": {
          "return": [
            {
              "financialProduct": {
                "return": {
                  "assignable": {
                    "return": "boolean",
                    "arguments": {}
                  },
                  "autoUpdatePrices": {
                    "return": "boolean",
                    "arguments": {}
                  },
                  "children": {
                    "return": [
                      {
                        "financialProduct": {
                          "return": {
                            "assignable": {
                              "return": "boolean",
                              "arguments": {}
                            },
                            "autoUpdatePrices": {
                              "return": "boolean",
                              "arguments": {}
                            },
                            "children": {
                              "return": [
                                {
                                  "financialProduct": {
                                    "return": {
                                      "assignable": {
                                        "return": "boolean",
                                        "arguments": {}
                                      },
                                      "autoUpdatePrices": {
                                        "return": "boolean",
                                        "arguments": {}
                                      },
                                      "children": {
                                        "return": [
                                          {
                                            "financialProduct": {
                                              "return": {
                                                "assignable": {
                                                  "return": "boolean",
                                                  "arguments": {}
                                                },
                                                "autoUpdatePrices": {
                                                  "return": "boolean",
                                                  "arguments": {}
                                                },
                                                "children": {
                                                  "return": [
                                                    {
                                                      "financialProduct": {
                                                        "return": {
                                                          "assignable": {
                                                            "return": "boolean",
                                                            "arguments": {}
                                                          },
                                                          "autoUpdatePrices": {
                                                            "return": "boolean",
                                                            "arguments": {}
                                                          },
                                                          "children": {
                                                            "return": [
                                                              {
                                                                "financialProduct": {
                                                                  "return": {
                                                                    "assignable": {
                                                                      "return": "boolean",
                                                                      "arguments": {}
                                                                    },
                                                                    "autoUpdatePrices": {}
                                                                  }
                                                                }
                                                              }
                                                            ]
                                                          }
                                                        }
                                                      }
                                                    }
                                                  ]
                                                }
                                              }
                                            }
                                          }
                                        ]
                                      }
                                    }
                                  }
                                }
                              ]
                            }
                          }
                        }
                      }
                    ]
                  }
                }
              }
            }
          ]
        }
      }
    ]
  }
}

FetchFlagResponse: object

flag:
object
return:
arguments:
object
Example
{
  "flag": {
    "return": {
      "account": {
        "return": {
          "affiliations": {
            "return": [
              {
                "allocation": {
                  "return": "number",
                  "arguments": {}
                },
                "id": {
                  "return": "object",
                  "arguments": {}
                },
                "relation": {
                  "return": "string",
                  "arguments": {}
                },
                "signatureRequired": {
                  "return": "boolean",
                  "arguments": {}
                },
                "type": {
                  "return": "string",
                  "arguments": {}
                },
                "user": {
                  "return": {
                    "accessibleBy": {
                      "return": [
                        {
                          "displayOptions": {
                            "return": {
                              "hide": {
                                "return": "boolean",
                                "arguments": {}
                              },
                              "order": {
                                "return": "number",
                                "arguments": {}
                              }
                            },
                            "arguments": {}
                          },
                          "organizationUser": {
                            "return": {
                              "accessType": {
                                "return": "string",
                                "arguments": {}
                              },
                              "apiTokens": {
                                "return": [
                                  {
                                    "id": {
                                      "return": "object",
                                      "arguments": {}
                                    },
                                    "jwtToken": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "name": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "organization": {
                                      "return": {
                                        "browserTabTitle": {
                                          "return": "string",
                                          "arguments": {}
                                        },
                                        "faviconLink": {
                                          "return": "string",
                                          "arguments": {}
                                        },
                                        "id": {
                                          "return": "object",
                                          "arguments": {}
                                        },
                                        "name": {
                                          "return": "string",
                                          "arguments": {}
                                        },
                                        "parent": {
                                          "return": {
                                            "browserTabTitle": {
                                              "return": "string",
                                              "arguments": {}
                                            },
                                            "faviconLink": {}
                                          }
                                        }
                                      }
                                    }
                                  }
                                ]
                              }
                            }
                          }
                        }
                      ]
                    }
                  }
                }
              }
            ]
          }
        }
      }
    }
  }
}

FetchFlagsInput: object

filter:
pagination:
Example
{
  "filter": {
    "accountId": "object",
    "custodianId": "object",
    "objectType": "string",
    "organizationId": "object",
    "state": "string",
    "type": "string"
  },
  "pagination": {
    "offSet": "number",
    "perPage": "number",
    "sortDesc": "boolean",
    "sortField": "string"
  }
}

FetchFlagsResponse: object

flags:
object
return:
Flag
arguments:
object
totalCount:
object
return:
Int
arguments:
object
Example
{
  "flags": {
    "return": [
      {
        "account": {
          "return": {
            "affiliations": {
              "return": [
                {
                  "allocation": {
                    "return": "number",
                    "arguments": {}
                  },
                  "id": {
                    "return": "object",
                    "arguments": {}
                  },
                  "relation": {
                    "return": "string",
                    "arguments": {}
                  },
                  "signatureRequired": {
                    "return": "boolean",
                    "arguments": {}
                  },
                  "type": {
                    "return": "string",
                    "arguments": {}
                  },
                  "user": {
                    "return": {
                      "accessibleBy": {
                        "return": [
                          {
                            "displayOptions": {
                              "return": {
                                "hide": {
                                  "return": "boolean",
                                  "arguments": {}
                                },
                                "order": {
                                  "return": "number",
                                  "arguments": {}
                                }
                              },
                              "arguments": {}
                            },
                            "organizationUser": {
                              "return": {
                                "accessType": {
                                  "return": "string",
                                  "arguments": {}
                                },
                                "apiTokens": {
                                  "return": [
                                    {
                                      "id": {
                                        "return": "object",
                                        "arguments": {}
                                      },
                                      "jwtToken": {
                                        "return": "string",
                                        "arguments": {}
                                      },
                                      "name": {
                                        "return": "string",
                                        "arguments": {}
                                      },
                                      "organization": {
                                        "return": {
                                          "browserTabTitle": {
                                            "return": "string",
                                            "arguments": {}
                                          },
                                          "faviconLink": {
                                            "return": "string",
                                            "arguments": {}
                                          },
                                          "id": {
                                            "return": "object",
                                            "arguments": {}
                                          },
                                          "name": {
                                            "return": "string",
                                            "arguments": {}
                                          },
                                          "parent": {
                                            "return": {
                                              "browserTabTitle": {
                                                "return": "string",
                                                "arguments": {}
                                              }
                                            }
                                          }
                                        }
                                      }
                                    }
                                  ]
                                }
                              }
                            }
                          }
                        ]
                      }
                    }
                  }
                }
              ]
            }
          }
        }
      }
    ]
  }
}

FetchForeignExchangeRateInput: object

from:
organizationId:
to:
Example
{
  "from": "string",
  "organizationId": "object",
  "to": "string"
}

FetchForeignExchangeRateResponse: object

rate:
object
return:
arguments:
object
Example
{
  "rate": {
    "return": "number",
    "arguments": {}
  }
}

FetchForeignExchangeSnapshotsInput: object

filter:
pagination:
Example
{
  "filter": {
    "dateAfter": "object",
    "dateBefore": "object",
    "from": "string",
    "organizationId": "object",
    "to": "string"
  },
  "pagination": {
    "offSet": "number",
    "perPage": "number",
    "sortDesc": "boolean",
    "sortField": "string"
  }
}

FetchForeignExchangeSnapshotsResponse: object

foreignExchangeSnapshots:
object
return:
ForeignExchangeSnapshot
arguments:
object
totalCount:
object
return:
Int
arguments:
object
Example
{
  "foreignExchangeSnapshots": {
    "return": [
      {
        "date": {
          "return": "object",
          "arguments": {}
        },
        "from": {
          "return": "string",
          "arguments": {}
        },
        "id": {
          "return": "object",
          "arguments": {}
        },
        "rate": {
          "return": "number",
          "arguments": {}
        },
        "to": {
          "return": "string",
          "arguments": {}
        }
      }
    ],
    "arguments": {}
  },
  "totalCount": {
    "return": "number",
    "arguments": {}
  }
}

FetchFormAgreementInput: object

formAgreementId:
Example
{
  "formAgreementId": "object"
}

FetchFormTemplateInput: object

formTemplateId:
type:
Example
{
  "formTemplateId": "object",
  "type": "string"
}

FetchFormTemplatesInput: object

filter:
pagination:
Example
{
  "filter": {
    "formType": "string",
    "minVersion": "number",
    "name": "string",
    "organizationId": "object",
    "states": [
      "string"
    ]
  },
  "pagination": {
    "offSet": "number",
    "perPage": "number",
    "sortDesc": "boolean",
    "sortField": "string"
  }
}

FetchFormTemplatesResponse: object

formTemplates:
object
return:
FormTemplate
arguments:
object
totalCount:
object
return:
Int
arguments:
object
Example
{
  "formTemplates": {
    "return": [
      {
        "digitalSignatureEnabled": {
          "return": "boolean",
          "arguments": {}
        },
        "displayName": {
          "return": "string",
          "arguments": {}
        },
        "id": {
          "return": "object",
          "arguments": {}
        },
        "minVersion": {
          "return": "number",
          "arguments": {}
        },
        "organization": {
          "return": {
            "accountTypeTaxRanks": {
              "return": [
                {
                  "accountType": {
                    "return": "string",
                    "arguments": {}
                  },
                  "id": {
                    "return": "object",
                    "arguments": {}
                  },
                  "taxRank": {
                    "return": "number",
                    "arguments": {}
                  }
                }
              ],
              "arguments": {}
            },
            "allowAccessToSubOrganizations": {
              "return": "boolean",
              "arguments": {}
            },
            "allowDirectCommunication": {
              "return": "boolean",
              "arguments": {}
            },
            "allowInactiveUserAdjustments": {
              "return": "boolean",
              "arguments": {}
            },
            "allowInactiveUserFeeCalculation": {
              "return": "boolean",
              "arguments": {}
            },
            "allowInactiveUserRebalancing": {
              "return": "boolean",
              "arguments": {}
            },
            "allowInstantInvest": {
              "return": "boolean",
              "arguments": {}
            },
            "allowPortfolioPerGoal": {
              "return": "boolean",
              "arguments": {}
            },
            "allowPostOptimizationEditing": {
              "return": "boolean",
              "arguments": {}
            },
            "allowViewSubTradeRequestPairs": {
              "return": "boolean",
              "arguments": {}
            },
            "applicableJurisdictions": {
              "return": {
                "all": {
                  "return": "boolean",
                  "arguments": {}
                },
                "only": {
                  "return": [
                    "string"
                  ],
                  "arguments": {}
                }
              },
              "arguments": {}
            },
            "applicableLocalization": {
              "return": {
                "countries": {
                  "return": [
                    "string"
                  ],
                  "arguments": {}
                },
                "dateFormat": {}
              }
            }
          }
        }
      }
    ]
  }
}

FetchFraudRiskInput: object

fraudRiskId:
userId:
Example
{
  "fraudRiskId": "object",
  "userId": "object"
}

FetchFraudRiskResponse: object

fraudRisk:
object
return:
arguments:
object
Example
{
  "fraudRisk": {
    "return": {
      "id": {
        "return": "object",
        "arguments": {}
      },
      "lastUpdatedBy": {
        "return": "string",
        "arguments": {}
      },
      "notes": {
        "return": "string",
        "arguments": {}
      },
      "riskReasons": {
        "return": [
          {
            "countryRisk": {
              "return": {
                "country": {
                  "return": "object",
                  "arguments": {}
                },
                "countryCode": {
                  "return": "object",
                  "arguments": {}
                },
                "disabled": {
                  "return": "boolean",
                  "arguments": {}
                },
                "id": {
                  "return": "object",
                  "arguments": {}
                },
                "riskRating": {
                  "return": "string",
                  "arguments": {}
                }
              },
              "arguments": {}
            },
            "id": {
              "return": "object",
              "arguments": {}
            },
            "jobTitleRisk": {
              "return": {
                "companyType": {
                  "return": "object",
                  "arguments": {}
                },
                "disabled": {
                  "return": "boolean",
                  "arguments": {}
                },
                "id": {
                  "return": "object",
                  "arguments": {}
                },
                "jobTitle": {
                  "return": "object",
                  "arguments": {}
                },
                "riskRating": {
                  "return": "string",
                  "arguments": {}
                }
              },
              "arguments": {}
            },
            "name": {
              "return": "string",
              "arguments": {}
            },
            "riskRating": {
              "return": "string",
              "arguments": {}
            },
            "translatedDescription": {
              "return": {
                "en": {
                  "return": "string",
                  "arguments": {}
                },
                "fr": {
                  "return": "string",
                  "arguments": {}
                }
              },
              "arguments": {}
            },
            "translatedDisplayName": {
              "return": {
                "en": {
                  "return": "string",
                  "arguments": {}
                },
                "fr": {}
              }
            }
          }
        ]
      }
    }
  }
}

FetchGoalResponse: object

goal:
object
return:
arguments:
object
Example
{
  "goal": {
    "return": {
      "availableFinancialProducts": {
        "return": [
          {
            "assignable": {
              "return": "boolean",
              "arguments": {}
            },
            "autoUpdatePrices": {
              "return": "boolean",
              "arguments": {}
            },
            "children": {
              "return": [
                {
                  "financialProduct": {
                    "return": {
                      "assignable": {
                        "return": "boolean",
                        "arguments": {}
                      },
                      "autoUpdatePrices": {
                        "return": "boolean",
                        "arguments": {}
                      },
                      "children": {
                        "return": [
                          {
                            "financialProduct": {
                              "return": {
                                "assignable": {
                                  "return": "boolean",
                                  "arguments": {}
                                },
                                "autoUpdatePrices": {
                                  "return": "boolean",
                                  "arguments": {}
                                },
                                "children": {
                                  "return": [
                                    {
                                      "financialProduct": {
                                        "return": {
                                          "assignable": {
                                            "return": "boolean",
                                            "arguments": {}
                                          },
                                          "autoUpdatePrices": {
                                            "return": "boolean",
                                            "arguments": {}
                                          },
                                          "children": {
                                            "return": [
                                              {
                                                "financialProduct": {
                                                  "return": {
                                                    "assignable": {
                                                      "return": "boolean",
                                                      "arguments": {}
                                                    },
                                                    "autoUpdatePrices": {
                                                      "return": "boolean",
                                                      "arguments": {}
                                                    },
                                                    "children": {
                                                      "return": [
                                                        {
                                                          "financialProduct": {
                                                            "return": {
                                                              "assignable": {
                                                                "return": "boolean",
                                                                "arguments": {}
                                                              },
                                                              "autoUpdatePrices": {
                                                                "return": "boolean",
                                                                "arguments": {}
                                                              },
                                                              "children": {
                                                                "return": [
                                                                  {
                                                                    "financialProduct": {
                                                                      "return": {
                                                                        "assignable": {}
                                                                      }
                                                                    }
                                                                  }
                                                                ]
                                                              }
                                                            }
                                                          }
                                                        }
                                                      ]
                                                    }
                                                  }
                                                }
                                              }
                                            ]
                                          }
                                        }
                                      }
                                    }
                                  ]
                                }
                              }
                            }
                          }
                        ]
                      }
                    }
                  }
                }
              ]
            }
          }
        ]
      }
    }
  }
}

FetchGoalUpdatesInput: object

goalId:
pagination:
Example
{
  "goalId": "object",
  "pagination": {
    "offSet": "number",
    "perPage": "number",
    "sortDesc": "boolean"
  }
}

FetchGoalUpdatesResponse: object

goalUpdates:
object
return:
GoalUpdate
arguments:
object
totalCount:
object
return:
Int
arguments:
object
Example
{
  "goalUpdates": {
    "return": [
      {
        "d": {
          "return": "string",
          "arguments": {}
        },
        "id": {
          "return": "object",
          "arguments": {}
        },
        "o": {
          "return": "string",
          "arguments": {}
        },
        "t": {
          "return": "object",
          "arguments": {}
        }
      }
    ],
    "arguments": {}
  },
  "totalCount": {
    "return": "number",
    "arguments": {}
  }
}

FetchGoalsInput: object

filter:
pagination:
Example
{
  "filter": {
    "clientGroupId": "object",
    "customFields": [
      {
        "key": "object",
        "value": "object"
      }
    ],
    "includeHousehold": "boolean",
    "organizationId": "object",
    "riskQuestion1": "string",
    "state": "string",
    "states": [
      "string"
    ],
    "targetDateAfter": "object",
    "targetDateBefore": "object",
    "timeHorizon": "string",
    "type": "string",
    "userId": "object"
  },
  "pagination": {
    "offSet": "number",
    "perPage": "number",
    "sortDesc": "boolean",
    "sortField": "string"
  }
}

FetchGoalsResponse: object

goals:
object
return:
Goal
arguments:
object
totalCount:
object
return:
Int
arguments:
object
Example
{
  "goals": {
    "return": [
      {
        "availableFinancialProducts": {
          "return": [
            {
              "assignable": {
                "return": "boolean",
                "arguments": {}
              },
              "autoUpdatePrices": {
                "return": "boolean",
                "arguments": {}
              },
              "children": {
                "return": [
                  {
                    "financialProduct": {
                      "return": {
                        "assignable": {
                          "return": "boolean",
                          "arguments": {}
                        },
                        "autoUpdatePrices": {
                          "return": "boolean",
                          "arguments": {}
                        },
                        "children": {
                          "return": [
                            {
                              "financialProduct": {
                                "return": {
                                  "assignable": {
                                    "return": "boolean",
                                    "arguments": {}
                                  },
                                  "autoUpdatePrices": {
                                    "return": "boolean",
                                    "arguments": {}
                                  },
                                  "children": {
                                    "return": [
                                      {
                                        "financialProduct": {
                                          "return": {
                                            "assignable": {
                                              "return": "boolean",
                                              "arguments": {}
                                            },
                                            "autoUpdatePrices": {
                                              "return": "boolean",
                                              "arguments": {}
                                            },
                                            "children": {
                                              "return": [
                                                {
                                                  "financialProduct": {
                                                    "return": {
                                                      "assignable": {
                                                        "return": "boolean",
                                                        "arguments": {}
                                                      },
                                                      "autoUpdatePrices": {
                                                        "return": "boolean",
                                                        "arguments": {}
                                                      },
                                                      "children": {
                                                        "return": [
                                                          {
                                                            "financialProduct": {
                                                              "return": {
                                                                "assignable": {
                                                                  "return": "boolean",
                                                                  "arguments": {}
                                                                },
                                                                "autoUpdatePrices": {
                                                                  "return": "boolean",
                                                                  "arguments": {}
                                                                },
                                                                "children": {
                                                                  "return": [
                                                                    {
                                                                      "financialProduct": {
                                                                        "return": {
                                                                          "assignable": {}
                                                                        }
                                                                      }
                                                                    }
                                                                  ]
                                                                }
                                                              }
                                                            }
                                                          }
                                                        ]
                                                      }
                                                    }
                                                  }
                                                }
                                              ]
                                            }
                                          }
                                        }
                                      }
                                    ]
                                  }
                                }
                              }
                            }
                          ]
                        }
                      }
                    }
                  }
                ]
              }
            }
          ]
        }
      }
    ]
  }
}

FetchGroupedBillingsInput: object

filter:
pagination:
Example
{
  "filter": {
    "accountIds": [
      "object"
    ],
    "billingCycleIds": [
      "object"
    ],
    "billingDateAfter": "object",
    "billingDateBefore": "object",
    "billingScheduleIds": [
      "object"
    ],
    "clientGroupIds": [
      "object"
    ],
    "feeTierIds": [
      "object"
    ],
    "organizationId": "object",
    "subAccountIds": [
      "object"
    ],
    "userIds": [
      "object"
    ]
  },
  "pagination": {
    "offSet": "number",
    "perPage": "number"
  }
}

FetchGroupedBillingsResponse: object

groupedBillings:
object
return:
GroupedBilling
arguments:
object
totalCount:
object
return:
Int
arguments:
object
Example
{
  "groupedBillings": {
    "return": [
      {
        "accounts": {
          "return": [
            {
              "account": {
                "return": {
                  "affiliations": {
                    "return": [
                      {
                        "allocation": {
                          "return": "number",
                          "arguments": {}
                        },
                        "id": {
                          "return": "object",
                          "arguments": {}
                        },
                        "relation": {
                          "return": "string",
                          "arguments": {}
                        },
                        "signatureRequired": {
                          "return": "boolean",
                          "arguments": {}
                        },
                        "type": {
                          "return": "string",
                          "arguments": {}
                        },
                        "user": {
                          "return": {
                            "accessibleBy": {
                              "return": [
                                {
                                  "displayOptions": {
                                    "return": {
                                      "hide": {
                                        "return": "boolean",
                                        "arguments": {}
                                      },
                                      "order": {
                                        "return": "number",
                                        "arguments": {}
                                      }
                                    },
                                    "arguments": {}
                                  },
                                  "organizationUser": {
                                    "return": {
                                      "accessType": {
                                        "return": "string",
                                        "arguments": {}
                                      },
                                      "apiTokens": {
                                        "return": [
                                          {
                                            "id": {
                                              "return": "object",
                                              "arguments": {}
                                            },
                                            "jwtToken": {
                                              "return": "string",
                                              "arguments": {}
                                            },
                                            "name": {
                                              "return": "string",
                                              "arguments": {}
                                            },
                                            "organization": {
                                              "return": {
                                                "browserTabTitle": {
                                                  "return": "string",
                                                  "arguments": {}
                                                },
                                                "faviconLink": {
                                                  "return": "string",
                                                  "arguments": {}
                                                },
                                                "id": {
                                                  "return": "object",
                                                  "arguments": {}
                                                },
                                                "name": {
                                                  "return": "string",
                                                  "arguments": {}
                                                },
                                                "parent": {
                                                  "return": {}
                                                }
                                              }
                                            }
                                          }
                                        ]
                                      }
                                    }
                                  }
                                }
                              ]
                            }
                          }
                        }
                      }
                    ]
                  }
                }
              }
            }
          ]
        }
      }
    ]
  }
}

FetchHistoryInput: object

afterDate:
beforeDate:
id:
type:
Example
{
  "afterDate": "object",
  "beforeDate": "object",
  "id": "object",
  "type": "string"
}

FetchHistoryResponse: object

history:
object
return:
object[]
arguments:
object
Example
{
  "history": {
    "return": [
      null
    ],
    "arguments": {}
  }
}

FetchImportFileLineItemResponse: object

importFileLineItem:
object
return:
arguments:
object
Example
{
  "importFileLineItem": {
    "return": {
      "createdAt": {
        "return": "object",
        "arguments": {}
      },
      "externalId": {
        "return": "string",
        "arguments": {}
      },
      "id": {
        "return": "object",
        "arguments": {}
      },
      "importFile": {
        "return": {
          "bulkImport": {
            "return": {
              "createdAt": {
                "return": "object",
                "arguments": {}
              },
              "id": {
                "return": "object",
                "arguments": {}
              },
              "name": {
                "return": "string",
                "arguments": {}
              },
              "organization": {
                "return": {
                  "browserTabTitle": {
                    "return": "string",
                    "arguments": {}
                  },
                  "faviconLink": {
                    "return": "string",
                    "arguments": {}
                  },
                  "id": {
                    "return": "object",
                    "arguments": {}
                  },
                  "name": {
                    "return": "string",
                    "arguments": {}
                  },
                  "parent": {
                    "return": {
                      "browserTabTitle": {
                        "return": "string",
                        "arguments": {}
                      },
                      "faviconLink": {
                        "return": "string",
                        "arguments": {}
                      },
                      "id": {
                        "return": "object",
                        "arguments": {}
                      },
                      "name": {
                        "return": "string",
                        "arguments": {}
                      },
                      "parent": {
                        "return": {
                          "browserTabTitle": {
                            "return": "string",
                            "arguments": {}
                          },
                          "faviconLink": {
                            "return": "string",
                            "arguments": {}
                          },
                          "id": {
                            "return": "object",
                            "arguments": {}
                          },
                          "name": {
                            "return": "string",
                            "arguments": {}
                          },
                          "parent": {
                            "return": {
                              "browserTabTitle": {
                                "return": "string",
                                "arguments": {}
                              },
                              "faviconLink": {}
                            }
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

FetchImportFileLineItemsInput: object

filter:
pagination:
Example
{
  "filter": {
    "errorCode": "string",
    "externalId": "string",
    "importFileId": "object",
    "oneVestId": "object",
    "states": [
      "string"
    ]
  },
  "pagination": {
    "offSet": "number",
    "perPage": "number",
    "sortDesc": "boolean",
    "sortField": "string"
  }
}

FetchImportFileLineItemsResponse: object

importFileLineItems:
object
return:
ImportFileLineItem
arguments:
object
totalCount:
object
return:
Int
arguments:
object
Example
{
  "importFileLineItems": {
    "return": [
      {
        "createdAt": {
          "return": "object",
          "arguments": {}
        },
        "externalId": {
          "return": "string",
          "arguments": {}
        },
        "id": {
          "return": "object",
          "arguments": {}
        },
        "importFile": {
          "return": {
            "bulkImport": {
              "return": {
                "createdAt": {
                  "return": "object",
                  "arguments": {}
                },
                "id": {
                  "return": "object",
                  "arguments": {}
                },
                "name": {
                  "return": "string",
                  "arguments": {}
                },
                "organization": {
                  "return": {
                    "browserTabTitle": {
                      "return": "string",
                      "arguments": {}
                    },
                    "faviconLink": {
                      "return": "string",
                      "arguments": {}
                    },
                    "id": {
                      "return": "object",
                      "arguments": {}
                    },
                    "name": {
                      "return": "string",
                      "arguments": {}
                    },
                    "parent": {
                      "return": {
                        "browserTabTitle": {
                          "return": "string",
                          "arguments": {}
                        },
                        "faviconLink": {
                          "return": "string",
                          "arguments": {}
                        },
                        "id": {
                          "return": "object",
                          "arguments": {}
                        },
                        "name": {
                          "return": "string",
                          "arguments": {}
                        },
                        "parent": {
                          "return": {
                            "browserTabTitle": {
                              "return": "string",
                              "arguments": {}
                            },
                            "faviconLink": {
                              "return": "string",
                              "arguments": {}
                            },
                            "id": {
                              "return": "object",
                              "arguments": {}
                            },
                            "name": {
                              "return": "string",
                              "arguments": {}
                            },
                            "parent": {
                              "return": {
                                "browserTabTitle": {
                                  "return": "string",
                                  "arguments": {}
                                },
                                "faviconLink": {}
                              }
                            }
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    ]
  }
}

FetchImportFileResponse: object

importFile:
object
return:
arguments:
object
Example
{
  "importFile": {
    "return": {
      "bulkImport": {
        "return": {
          "createdAt": {
            "return": "object",
            "arguments": {}
          },
          "id": {
            "return": "object",
            "arguments": {}
          },
          "name": {
            "return": "string",
            "arguments": {}
          },
          "organization": {
            "return": {
              "browserTabTitle": {
                "return": "string",
                "arguments": {}
              },
              "faviconLink": {
                "return": "string",
                "arguments": {}
              },
              "id": {
                "return": "object",
                "arguments": {}
              },
              "name": {
                "return": "string",
                "arguments": {}
              },
              "parent": {
                "return": {
                  "browserTabTitle": {
                    "return": "string",
                    "arguments": {}
                  },
                  "faviconLink": {
                    "return": "string",
                    "arguments": {}
                  },
                  "id": {
                    "return": "object",
                    "arguments": {}
                  },
                  "name": {
                    "return": "string",
                    "arguments": {}
                  },
                  "parent": {
                    "return": {
                      "browserTabTitle": {
                        "return": "string",
                        "arguments": {}
                      },
                      "faviconLink": {
                        "return": "string",
                        "arguments": {}
                      },
                      "id": {
                        "return": "object",
                        "arguments": {}
                      },
                      "name": {
                        "return": "string",
                        "arguments": {}
                      },
                      "parent": {
                        "return": {
                          "browserTabTitle": {
                            "return": "string",
                            "arguments": {}
                          },
                          "faviconLink": {
                            "return": "string",
                            "arguments": {}
                          },
                          "id": {
                            "return": "object",
                            "arguments": {}
                          },
                          "name": {
                            "return": "string",
                            "arguments": {}
                          },
                          "parent": {
                            "return": {
                              "browserTabTitle": {}
                            }
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

FetchImportFileTemplateResponse: object

downloadUrl:
object
return:
arguments:
object
type:
object
return:
arguments:
object
Example
{
  "downloadUrl": {
    "return": "string",
    "arguments": {}
  },
  "type": {
    "return": "string",
    "arguments": {}
  }
}

FetchImportFilesInput: object

filter:
pagination:
Example
{
  "filter": {
    "bulkImportId": "object",
    "createdAtAfter": "object",
    "createdAtBefore": "object",
    "organizationId": "object",
    "states": [
      "string"
    ],
    "types": [
      "string"
    ]
  },
  "pagination": {
    "offSet": "number",
    "perPage": "number",
    "sortDesc": "boolean",
    "sortField": "string"
  }
}

FetchImportFilesResponse: object

importFiles:
object
return:
ImportFile
arguments:
object
totalCount:
object
return:
Int
arguments:
object
Example
{
  "importFiles": {
    "return": [
      {
        "bulkImport": {
          "return": {
            "createdAt": {
              "return": "object",
              "arguments": {}
            },
            "id": {
              "return": "object",
              "arguments": {}
            },
            "name": {
              "return": "string",
              "arguments": {}
            },
            "organization": {
              "return": {
                "browserTabTitle": {
                  "return": "string",
                  "arguments": {}
                },
                "faviconLink": {
                  "return": "string",
                  "arguments": {}
                },
                "id": {
                  "return": "object",
                  "arguments": {}
                },
                "name": {
                  "return": "string",
                  "arguments": {}
                },
                "parent": {
                  "return": {
                    "browserTabTitle": {
                      "return": "string",
                      "arguments": {}
                    },
                    "faviconLink": {
                      "return": "string",
                      "arguments": {}
                    },
                    "id": {
                      "return": "object",
                      "arguments": {}
                    },
                    "name": {
                      "return": "string",
                      "arguments": {}
                    },
                    "parent": {
                      "return": {
                        "browserTabTitle": {
                          "return": "string",
                          "arguments": {}
                        },
                        "faviconLink": {
                          "return": "string",
                          "arguments": {}
                        },
                        "id": {
                          "return": "object",
                          "arguments": {}
                        },
                        "name": {
                          "return": "string",
                          "arguments": {}
                        },
                        "parent": {
                          "return": {
                            "browserTabTitle": {
                              "return": "string",
                              "arguments": {}
                            },
                            "faviconLink": {
                              "return": "string",
                              "arguments": {}
                            },
                            "id": {
                              "return": "object",
                              "arguments": {}
                            },
                            "name": {
                              "return": "string",
                              "arguments": {}
                            },
                            "parent": {
                              "return": {
                                "browserTabTitle": {}
                              }
                            }
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    ]
  }
}

FetchInstitutionResponse: object

institution:
object
return:
arguments:
object
Example
{
  "institution": {
    "return": {
      "createdAt": {
        "return": "object",
        "arguments": {}
      },
      "id": {
        "return": "object",
        "arguments": {}
      },
      "isDraft": {
        "return": "string",
        "arguments": {}
      },
      "name": {
        "return": "string",
        "arguments": {}
      },
      "physicalAddress": {
        "return": {
          "city": {
            "return": "string",
            "arguments": {}
          },
          "country": {
            "return": "string",
            "arguments": {}
          },
          "houseNumber": {
            "return": "string",
            "arguments": {}
          },
          "jurisdiction": {
            "return": "string",
            "arguments": {}
          },
          "neighborhood": {
            "return": "string",
            "arguments": {}
          },
          "postal": {
            "return": "string",
            "arguments": {}
          },
          "province": {
            "return": "string",
            "arguments": {}
          },
          "streetName": {
            "return": "string",
            "arguments": {}
          },
          "unitNumber": {
            "return": "string",
            "arguments": {}
          }
        },
        "arguments": {}
      },
      "state": {
        "return": "string",
        "arguments": {}
      },
      "stateChanges": {
        "return": [
          "object"
        ],
        "arguments": {}
      },
      "updatedAt": {
        "return": "object",
        "arguments": {}
      }
    },
    "arguments": {}
  }
}

FetchInstitutionsInput: object

filter:
pagination:
Example
{
  "filter": {
    "searchText": "string",
    "state": "string"
  },
  "pagination": {
    "offSet": "number",
    "perPage": "number",
    "sortDesc": "boolean",
    "sortField": "string"
  }
}

FetchInstitutionsResponse: object

institutions:
object
return:
Institution
arguments:
object
totalCount:
object
return:
Int
arguments:
object
Example
{
  "institutions": {
    "return": [
      {
        "createdAt": {
          "return": "object",
          "arguments": {}
        },
        "id": {
          "return": "object",
          "arguments": {}
        },
        "isDraft": {
          "return": "string",
          "arguments": {}
        },
        "name": {
          "return": "string",
          "arguments": {}
        },
        "physicalAddress": {
          "return": {
            "city": {
              "return": "string",
              "arguments": {}
            },
            "country": {
              "return": "string",
              "arguments": {}
            },
            "houseNumber": {
              "return": "string",
              "arguments": {}
            },
            "jurisdiction": {
              "return": "string",
              "arguments": {}
            },
            "neighborhood": {
              "return": "string",
              "arguments": {}
            },
            "postal": {
              "return": "string",
              "arguments": {}
            },
            "province": {
              "return": "string",
              "arguments": {}
            },
            "streetName": {
              "return": "string",
              "arguments": {}
            },
            "unitNumber": {
              "return": "string",
              "arguments": {}
            }
          },
          "arguments": {}
        },
        "state": {
          "return": "string",
          "arguments": {}
        },
        "stateChanges": {
          "return": [
            "object"
          ],
          "arguments": {}
        },
        "updatedAt": {
          "return": "object",
          "arguments": {}
        }
      }
    ],
    "arguments": {}
  },
  "totalCount": {
    "return": "number",
    "arguments": {}
  }
}

FetchIntegrationResponse: object

integration:
object
return:
arguments:
object
Example
{
  "integration": {
    "return": {
      "configuration": {
        "return": "object",
        "arguments": {}
      },
      "id": {
        "return": "object",
        "arguments": {}
      },
      "organization": {
        "return": {
          "browserTabTitle": {
            "return": "string",
            "arguments": {}
          },
          "faviconLink": {
            "return": "string",
            "arguments": {}
          },
          "id": {
            "return": "object",
            "arguments": {}
          },
          "name": {
            "return": "string",
            "arguments": {}
          },
          "parent": {
            "return": {
              "browserTabTitle": {
                "return": "string",
                "arguments": {}
              },
              "faviconLink": {
                "return": "string",
                "arguments": {}
              },
              "id": {
                "return": "object",
                "arguments": {}
              },
              "name": {
                "return": "string",
                "arguments": {}
              },
              "parent": {
                "return": {
                  "browserTabTitle": {
                    "return": "string",
                    "arguments": {}
                  },
                  "faviconLink": {
                    "return": "string",
                    "arguments": {}
                  },
                  "id": {
                    "return": "object",
                    "arguments": {}
                  },
                  "name": {
                    "return": "string",
                    "arguments": {}
                  },
                  "parent": {
                    "return": {
                      "browserTabTitle": {
                        "return": "string",
                        "arguments": {}
                      },
                      "faviconLink": {
                        "return": "string",
                        "arguments": {}
                      },
                      "id": {
                        "return": "object",
                        "arguments": {}
                      },
                      "name": {
                        "return": "string",
                        "arguments": {}
                      },
                      "parent": {
                        "return": {
                          "browserTabTitle": {
                            "return": "string",
                            "arguments": {}
                          },
                          "faviconLink": {
                            "return": "string",
                            "arguments": {}
                          },
                          "id": {}
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

FetchIntegrationsInput: object

filter:
pagination:
Example
{
  "filter": {
    "organizationId": "object",
    "state": "string",
    "type": "string"
  },
  "pagination": {
    "offSet": "number",
    "perPage": "number",
    "sortDesc": "boolean",
    "sortField": "string"
  }
}

FetchIntegrationsResponse: object

integrations:
object
return:
Integration
arguments:
object
totalCount:
object
return:
Int
arguments:
object
Example
{
  "integrations": {
    "return": [
      {
        "configuration": {
          "return": "object",
          "arguments": {}
        },
        "id": {
          "return": "object",
          "arguments": {}
        },
        "organization": {
          "return": {
            "browserTabTitle": {
              "return": "string",
              "arguments": {}
            },
            "faviconLink": {
              "return": "string",
              "arguments": {}
            },
            "id": {
              "return": "object",
              "arguments": {}
            },
            "name": {
              "return": "string",
              "arguments": {}
            },
            "parent": {
              "return": {
                "browserTabTitle": {
                  "return": "string",
                  "arguments": {}
                },
                "faviconLink": {
                  "return": "string",
                  "arguments": {}
                },
                "id": {
                  "return": "object",
                  "arguments": {}
                },
                "name": {
                  "return": "string",
                  "arguments": {}
                },
                "parent": {
                  "return": {
                    "browserTabTitle": {
                      "return": "string",
                      "arguments": {}
                    },
                    "faviconLink": {
                      "return": "string",
                      "arguments": {}
                    },
                    "id": {
                      "return": "object",
                      "arguments": {}
                    },
                    "name": {
                      "return": "string",
                      "arguments": {}
                    },
                    "parent": {
                      "return": {
                        "browserTabTitle": {
                          "return": "string",
                          "arguments": {}
                        },
                        "faviconLink": {
                          "return": "string",
                          "arguments": {}
                        },
                        "id": {
                          "return": "object",
                          "arguments": {}
                        },
                        "name": {
                          "return": "string",
                          "arguments": {}
                        },
                        "parent": {
                          "return": {
                            "browserTabTitle": {
                              "return": "string",
                              "arguments": {}
                            },
                            "faviconLink": {
                              "return": "string",
                              "arguments": {}
                            }
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    ]
  }
}

FetchJobTitleRiskInput: object

jobTitleRiskId:
Example
{
  "jobTitleRiskId": "object"
}

FetchJobTitleRiskResponse: object

jobTitleRisk:
object
return:
arguments:
object
Example
{
  "jobTitleRisk": {
    "return": {
      "companyType": {
        "return": "object",
        "arguments": {}
      },
      "disabled": {
        "return": "boolean",
        "arguments": {}
      },
      "id": {
        "return": "object",
        "arguments": {}
      },
      "jobTitle": {
        "return": "object",
        "arguments": {}
      },
      "riskRating": {
        "return": "string",
        "arguments": {}
      }
    },
    "arguments": {}
  }
}

FetchLocalizationResponse: object

localization:
object
return:
arguments:
object
Example
{
  "localization": {
    "return": {
      "countries": {
        "return": [
          "string"
        ],
        "arguments": {}
      },
      "dateFormat": {
        "return": "string",
        "arguments": {}
      },
      "defaultCurrency": {
        "return": "string",
        "arguments": {}
      },
      "defaultLanguage": {
        "return": "string",
        "arguments": {}
      },
      "id": {
        "return": "object",
        "arguments": {}
      },
      "languages": {
        "return": [
          "string"
        ],
        "arguments": {}
      },
      "name": {
        "return": "string",
        "arguments": {}
      },
      "organization": {
        "return": {
          "browserTabTitle": {
            "return": "string",
            "arguments": {}
          },
          "faviconLink": {
            "return": "string",
            "arguments": {}
          },
          "id": {
            "return": "object",
            "arguments": {}
          },
          "name": {
            "return": "string",
            "arguments": {}
          },
          "parent": {
            "return": {
              "browserTabTitle": {
                "return": "string",
                "arguments": {}
              },
              "faviconLink": {
                "return": "string",
                "arguments": {}
              },
              "id": {
                "return": "object",
                "arguments": {}
              },
              "name": {
                "return": "string",
                "arguments": {}
              },
              "parent": {
                "return": {
                  "browserTabTitle": {
                    "return": "string",
                    "arguments": {}
                  },
                  "faviconLink": {
                    "return": "string",
                    "arguments": {}
                  },
                  "id": {
                    "return": "object",
                    "arguments": {}
                  },
                  "name": {
                    "return": "string",
                    "arguments": {}
                  },
                  "parent": {
                    "return": {
                      "browserTabTitle": {
                        "return": "string",
                        "arguments": {}
                      },
                      "faviconLink": {}
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

FetchLocalizationsInput: object

filter:
pagination:
Example
{
  "filter": {
    "organizationId": "object"
  },
  "pagination": {
    "offSet": "number",
    "perPage": "number",
    "sortDesc": "boolean",
    "sortField": "string"
  }
}

FetchLocalizationsResponse: object

localizations:
object
return:
Localization
arguments:
object
totalCount:
object
return:
Int
arguments:
object
Example
{
  "localizations": {
    "return": [
      {
        "countries": {
          "return": [
            "string"
          ],
          "arguments": {}
        },
        "dateFormat": {
          "return": "string",
          "arguments": {}
        },
        "defaultCurrency": {
          "return": "string",
          "arguments": {}
        },
        "defaultLanguage": {
          "return": "string",
          "arguments": {}
        },
        "id": {
          "return": "object",
          "arguments": {}
        },
        "languages": {
          "return": [
            "string"
          ],
          "arguments": {}
        },
        "name": {
          "return": "string",
          "arguments": {}
        },
        "organization": {
          "return": {
            "browserTabTitle": {
              "return": "string",
              "arguments": {}
            },
            "faviconLink": {
              "return": "string",
              "arguments": {}
            },
            "id": {
              "return": "object",
              "arguments": {}
            },
            "name": {
              "return": "string",
              "arguments": {}
            },
            "parent": {
              "return": {
                "browserTabTitle": {
                  "return": "string",
                  "arguments": {}
                },
                "faviconLink": {
                  "return": "string",
                  "arguments": {}
                },
                "id": {
                  "return": "object",
                  "arguments": {}
                },
                "name": {
                  "return": "string",
                  "arguments": {}
                },
                "parent": {
                  "return": {
                    "browserTabTitle": {
                      "return": "string",
                      "arguments": {}
                    },
                    "faviconLink": {
                      "return": "string",
                      "arguments": {}
                    },
                    "id": {
                      "return": "object",
                      "arguments": {}
                    },
                    "name": {
                      "return": "string",
                      "arguments": {}
                    },
                    "parent": {
                      "return": {
                        "browserTabTitle": {
                          "return": "string",
                          "arguments": {}
                        },
                        "faviconLink": {}
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    ]
  }
}

FetchLsegSamlRequestInput: object

organizationId:
Example
{
  "organizationId": "object"
}

FetchLsegSamlRequestResponse: object

samlRequest:
object
return:
arguments:
object
Example
{
  "samlRequest": {
    "return": "string",
    "arguments": {}
  }
}

FetchManualProcessResponse: object

manualProcess:
object
return:
arguments:
object
Example
{
  "manualProcess": {
    "return": {
      "account": {
        "return": {
          "affiliations": {
            "return": [
              {
                "allocation": {
                  "return": "number",
                  "arguments": {}
                },
                "id": {
                  "return": "object",
                  "arguments": {}
                },
                "relation": {
                  "return": "string",
                  "arguments": {}
                },
                "signatureRequired": {
                  "return": "boolean",
                  "arguments": {}
                },
                "type": {
                  "return": "string",
                  "arguments": {}
                },
                "user": {
                  "return": {
                    "accessibleBy": {
                      "return": [
                        {
                          "displayOptions": {
                            "return": {
                              "hide": {
                                "return": "boolean",
                                "arguments": {}
                              },
                              "order": {
                                "return": "number",
                                "arguments": {}
                              }
                            },
                            "arguments": {}
                          },
                          "organizationUser": {
                            "return": {
                              "accessType": {
                                "return": "string",
                                "arguments": {}
                              },
                              "apiTokens": {
                                "return": [
                                  {
                                    "id": {
                                      "return": "object",
                                      "arguments": {}
                                    },
                                    "jwtToken": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "name": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "organization": {
                                      "return": {
                                        "browserTabTitle": {
                                          "return": "string",
                                          "arguments": {}
                                        },
                                        "faviconLink": {
                                          "return": "string",
                                          "arguments": {}
                                        },
                                        "id": {
                                          "return": "object",
                                          "arguments": {}
                                        },
                                        "name": {
                                          "return": "string",
                                          "arguments": {}
                                        },
                                        "parent": {
                                          "return": {
                                            "browserTabTitle": {
                                              "return": "string",
                                              "arguments": {}
                                            },
                                            "faviconLink": {}
                                          }
                                        }
                                      }
                                    }
                                  }
                                ]
                              }
                            }
                          }
                        }
                      ]
                    }
                  }
                }
              }
            ]
          }
        }
      }
    }
  }
}

FetchManualProcessesInput: object

filter:
pagination:
Example
{
  "filter": {
    "id": [
      "object"
    ]
  },
  "pagination": {
    "offSet": "number",
    "perPage": "number",
    "sortDesc": "boolean",
    "sortField": "string"
  }
}

FetchMismatchedAccountsDailyInput: object

date:
marketValueCentsDiff:
Int
Example
{
  "date": "object",
  "marketValueCentsDiff": "number"
}

FetchMismatchedAccountsDailyResponse: object

accountsDaily:
object
return:
AccountsDaily
arguments:
object
Example
{
  "accountsDaily": {
    "return": [
      {
        "account": {
          "return": {
            "affiliations": {
              "return": [
                {
                  "allocation": {
                    "return": "number",
                    "arguments": {}
                  },
                  "id": {
                    "return": "object",
                    "arguments": {}
                  },
                  "relation": {
                    "return": "string",
                    "arguments": {}
                  },
                  "signatureRequired": {
                    "return": "boolean",
                    "arguments": {}
                  },
                  "type": {
                    "return": "string",
                    "arguments": {}
                  },
                  "user": {
                    "return": {
                      "accessibleBy": {
                        "return": [
                          {
                            "displayOptions": {
                              "return": {
                                "hide": {
                                  "return": "boolean",
                                  "arguments": {}
                                },
                                "order": {
                                  "return": "number",
                                  "arguments": {}
                                }
                              },
                              "arguments": {}
                            },
                            "organizationUser": {
                              "return": {
                                "accessType": {
                                  "return": "string",
                                  "arguments": {}
                                },
                                "apiTokens": {
                                  "return": [
                                    {
                                      "id": {
                                        "return": "object",
                                        "arguments": {}
                                      },
                                      "jwtToken": {
                                        "return": "string",
                                        "arguments": {}
                                      },
                                      "name": {
                                        "return": "string",
                                        "arguments": {}
                                      },
                                      "organization": {
                                        "return": {
                                          "browserTabTitle": {
                                            "return": "string",
                                            "arguments": {}
                                          },
                                          "faviconLink": {
                                            "return": "string",
                                            "arguments": {}
                                          },
                                          "id": {
                                            "return": "object",
                                            "arguments": {}
                                          },
                                          "name": {
                                            "return": "string",
                                            "arguments": {}
                                          },
                                          "parent": {
                                            "return": {
                                              "browserTabTitle": {
                                                "return": "string",
                                                "arguments": {}
                                              }
                                            }
                                          }
                                        }
                                      }
                                    }
                                  ]
                                }
                              }
                            }
                          }
                        ]
                      }
                    }
                  }
                }
              ]
            }
          }
        }
      }
    ]
  }
}

FetchModelPortfolioInput: object

modelPortfolioId:

This is the financialProductId and it is auto-generated by OneVest for each Financial Product.

Example
{
  "modelPortfolioId": "object"
}

FetchModelPortfolioResponse: object

modelPortfolio:
object

The Financial product.

return:
arguments:
object
Example
{
  "modelPortfolio": {
    "return": {
      "assignable": {
        "return": "boolean",
        "arguments": {}
      },
      "autoUpdatePrices": {
        "return": "boolean",
        "arguments": {}
      },
      "children": {
        "return": [
          {
            "financialProduct": {
              "return": {
                "assignable": {
                  "return": "boolean",
                  "arguments": {}
                },
                "autoUpdatePrices": {
                  "return": "boolean",
                  "arguments": {}
                },
                "children": {
                  "return": [
                    {
                      "financialProduct": {
                        "return": {
                          "assignable": {
                            "return": "boolean",
                            "arguments": {}
                          },
                          "autoUpdatePrices": {
                            "return": "boolean",
                            "arguments": {}
                          },
                          "children": {
                            "return": [
                              {
                                "financialProduct": {
                                  "return": {
                                    "assignable": {
                                      "return": "boolean",
                                      "arguments": {}
                                    },
                                    "autoUpdatePrices": {
                                      "return": "boolean",
                                      "arguments": {}
                                    },
                                    "children": {
                                      "return": [
                                        {
                                          "financialProduct": {
                                            "return": {
                                              "assignable": {
                                                "return": "boolean",
                                                "arguments": {}
                                              },
                                              "autoUpdatePrices": {
                                                "return": "boolean",
                                                "arguments": {}
                                              },
                                              "children": {
                                                "return": [
                                                  {
                                                    "financialProduct": {
                                                      "return": {
                                                        "assignable": {
                                                          "return": "boolean",
                                                          "arguments": {}
                                                        },
                                                        "autoUpdatePrices": {
                                                          "return": "boolean",
                                                          "arguments": {}
                                                        },
                                                        "children": {
                                                          "return": [
                                                            {
                                                              "financialProduct": {
                                                                "return": {
                                                                  "assignable": {
                                                                    "return": "boolean",
                                                                    "arguments": {}
                                                                  },
                                                                  "autoUpdatePrices": {}
                                                                }
                                                              }
                                                            }
                                                          ]
                                                        }
                                                      }
                                                    }
                                                  }
                                                ]
                                              }
                                            }
                                          }
                                        }
                                      ]
                                    }
                                  }
                                }
                              }
                            ]
                          }
                        }
                      }
                    }
                  ]
                }
              }
            }
          }
        ]
      }
    }
  }
}

FetchModelPortfoliosInput: object

filter:
pagination:
Example
{
  "filter": {
    "organizationId": "object",
    "state": "string",
    "suggestable": "boolean",
    "themeId": "object",
    "themeIds": [
      "object"
    ]
  },
  "pagination": {
    "offset": "number",
    "perPage": "number",
    "sortDesc": "boolean",
    "sortField": "string"
  }
}

FetchModelPortfoliosResponse: object

modelPortfolios:
object

The Financial products.

return:
FinancialProduct
arguments:
object
totalCount:
object

The number of financial products.

return:
Int
arguments:
object
Example
{
  "modelPortfolios": {
    "return": [
      {
        "assignable": {
          "return": "boolean",
          "arguments": {}
        },
        "autoUpdatePrices": {
          "return": "boolean",
          "arguments": {}
        },
        "children": {
          "return": [
            {
              "financialProduct": {
                "return": {
                  "assignable": {
                    "return": "boolean",
                    "arguments": {}
                  },
                  "autoUpdatePrices": {
                    "return": "boolean",
                    "arguments": {}
                  },
                  "children": {
                    "return": [
                      {
                        "financialProduct": {
                          "return": {
                            "assignable": {
                              "return": "boolean",
                              "arguments": {}
                            },
                            "autoUpdatePrices": {
                              "return": "boolean",
                              "arguments": {}
                            },
                            "children": {
                              "return": [
                                {
                                  "financialProduct": {
                                    "return": {
                                      "assignable": {
                                        "return": "boolean",
                                        "arguments": {}
                                      },
                                      "autoUpdatePrices": {
                                        "return": "boolean",
                                        "arguments": {}
                                      },
                                      "children": {
                                        "return": [
                                          {
                                            "financialProduct": {
                                              "return": {
                                                "assignable": {
                                                  "return": "boolean",
                                                  "arguments": {}
                                                },
                                                "autoUpdatePrices": {
                                                  "return": "boolean",
                                                  "arguments": {}
                                                },
                                                "children": {
                                                  "return": [
                                                    {
                                                      "financialProduct": {
                                                        "return": {
                                                          "assignable": {
                                                            "return": "boolean",
                                                            "arguments": {}
                                                          },
                                                          "autoUpdatePrices": {
                                                            "return": "boolean",
                                                            "arguments": {}
                                                          },
                                                          "children": {
                                                            "return": [
                                                              {
                                                                "financialProduct": {
                                                                  "return": {
                                                                    "assignable": {
                                                                      "return": "boolean",
                                                                      "arguments": {}
                                                                    },
                                                                    "autoUpdatePrices": {}
                                                                  }
                                                                }
                                                              }
                                                            ]
                                                          }
                                                        }
                                                      }
                                                    }
                                                  ]
                                                }
                                              }
                                            }
                                          }
                                        ]
                                      }
                                    }
                                  }
                                }
                              ]
                            }
                          }
                        }
                      }
                    ]
                  }
                }
              }
            }
          ]
        }
      }
    ]
  }
}

FetchNoteResponse: object

note:
object
return:
arguments:
object
Example
{
  "note": {
    "return": {
      "author": {
        "return": {
          "email": {
            "return": "string",
            "arguments": {}
          },
          "firstName": {
            "return": "string",
            "arguments": {}
          },
          "id": {
            "return": "object",
            "arguments": {}
          },
          "language": {
            "return": "string",
            "arguments": {}
          },
          "lastName": {
            "return": "string",
            "arguments": {}
          },
          "organization": {
            "return": {
              "browserTabTitle": {
                "return": "string",
                "arguments": {}
              },
              "faviconLink": {
                "return": "string",
                "arguments": {}
              },
              "id": {
                "return": "object",
                "arguments": {}
              },
              "name": {
                "return": "string",
                "arguments": {}
              },
              "parent": {
                "return": {
                  "browserTabTitle": {
                    "return": "string",
                    "arguments": {}
                  },
                  "faviconLink": {
                    "return": "string",
                    "arguments": {}
                  },
                  "id": {
                    "return": "object",
                    "arguments": {}
                  },
                  "name": {
                    "return": "string",
                    "arguments": {}
                  },
                  "parent": {
                    "return": {
                      "browserTabTitle": {
                        "return": "string",
                        "arguments": {}
                      },
                      "faviconLink": {
                        "return": "string",
                        "arguments": {}
                      },
                      "id": {
                        "return": "object",
                        "arguments": {}
                      },
                      "name": {
                        "return": "string",
                        "arguments": {}
                      },
                      "parent": {
                        "return": {
                          "browserTabTitle": {
                            "return": "string",
                            "arguments": {}
                          },
                          "faviconLink": {
                            "return": "string",
                            "arguments": {}
                          },
                          "id": {
                            "return": "object",
                            "arguments": {}
                          },
                          "name": {}
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

FetchNotesInput: object

Input type for fetching notes

filter:

To filter the notes

pagination:

To organize the response as per the pagination fields

Example
{
  "filter": {
    "objectId": "object",
    "objectIds": [
      "object"
    ],
    "objectType": "string",
    "organizationId": "object",
    "state": "string",
    "type": "string"
  },
  "pagination": {
    "offSet": "number",
    "perPage": "number",
    "sortDesc": "boolean",
    "sortField": "string"
  }
}

FetchNotesResponse: object

Type definition for fetching notes

notes:
object

Returns an array of notes objects

return:
Note
arguments:
object
totalCount:
object

Total number of the notes records that satisfies a specified filter

return:
Int
arguments:
object
Example
{
  "notes": {
    "return": [
      {
        "author": {
          "return": {
            "email": {
              "return": "string",
              "arguments": {}
            },
            "firstName": {
              "return": "string",
              "arguments": {}
            },
            "id": {
              "return": "object",
              "arguments": {}
            },
            "language": {
              "return": "string",
              "arguments": {}
            },
            "lastName": {
              "return": "string",
              "arguments": {}
            },
            "organization": {
              "return": {
                "browserTabTitle": {
                  "return": "string",
                  "arguments": {}
                },
                "faviconLink": {
                  "return": "string",
                  "arguments": {}
                },
                "id": {
                  "return": "object",
                  "arguments": {}
                },
                "name": {
                  "return": "string",
                  "arguments": {}
                },
                "parent": {
                  "return": {
                    "browserTabTitle": {
                      "return": "string",
                      "arguments": {}
                    },
                    "faviconLink": {
                      "return": "string",
                      "arguments": {}
                    },
                    "id": {
                      "return": "object",
                      "arguments": {}
                    },
                    "name": {
                      "return": "string",
                      "arguments": {}
                    },
                    "parent": {
                      "return": {
                        "browserTabTitle": {
                          "return": "string",
                          "arguments": {}
                        },
                        "faviconLink": {
                          "return": "string",
                          "arguments": {}
                        },
                        "id": {
                          "return": "object",
                          "arguments": {}
                        },
                        "name": {
                          "return": "string",
                          "arguments": {}
                        },
                        "parent": {
                          "return": {
                            "browserTabTitle": {
                              "return": "string",
                              "arguments": {}
                            },
                            "faviconLink": {
                              "return": "string",
                              "arguments": {}
                            },
                            "id": {
                              "return": "object",
                              "arguments": {}
                            }
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    ]
  }
}

FetchNotificationDefinitionResponse: object

notificationDefinition:
object
return:
arguments:
object
Example
{
  "notificationDefinition": {
    "return": {
      "bodyTemplate": {
        "return": {
          "en": {
            "return": "string",
            "arguments": {}
          },
          "fr": {
            "return": "string",
            "arguments": {}
          }
        },
        "arguments": {}
      },
      "createdAt": {
        "return": "object",
        "arguments": {}
      },
      "id": {
        "return": "object",
        "arguments": {}
      },
      "linkTemplate": {
        "return": "object",
        "arguments": {}
      },
      "linkText": {
        "return": {
          "en": {
            "return": "string",
            "arguments": {}
          },
          "fr": {
            "return": "string",
            "arguments": {}
          }
        },
        "arguments": {}
      },
      "name": {
        "return": "object",
        "arguments": {}
      },
      "notificationGroup": {
        "return": {
          "id": {
            "return": "object",
            "arguments": {}
          },
          "name": {
            "return": {
              "en": {
                "return": "string",
                "arguments": {}
              },
              "fr": {
                "return": "string",
                "arguments": {}
              }
            },
            "arguments": {}
          }
        },
        "arguments": {}
      },
      "organization": {
        "return": {
          "accountTypeTaxRanks": {
            "return": [
              {
                "accountType": {
                  "return": "string",
                  "arguments": {}
                },
                "id": {
                  "return": "object",
                  "arguments": {}
                },
                "taxRank": {
                  "return": "number",
                  "arguments": {}
                }
              }
            ],
            "arguments": {}
          },
          "allowAccessToSubOrganizations": {
            "return": "boolean",
            "arguments": {}
          },
          "allowDirectCommunication": {
            "return": "boolean",
            "arguments": {}
          },
          "allowInactiveUserAdjustments": {
            "return": "boolean",
            "arguments": {}
          },
          "allowInactiveUserFeeCalculation": {
            "return": "boolean",
            "arguments": {}
          }
        }
      }
    }
  }
}

FetchNotificationDefinitionsInput: object

filter:
pagination:
Example
{
  "filter": {
    "organizationId": "object"
  },
  "pagination": {
    "offSet": "number",
    "perPage": "number",
    "sortDesc": "boolean",
    "sortField": "string"
  }
}

FetchNotificationDefinitionsResponse: object

notificationDefinitions:
object
return:
NotificationDefinition
arguments:
object
totalCount:
object
return:
Int
arguments:
object
Example
{
  "notificationDefinitions": {
    "return": [
      {
        "bodyTemplate": {
          "return": {
            "en": {
              "return": "string",
              "arguments": {}
            },
            "fr": {
              "return": "string",
              "arguments": {}
            }
          },
          "arguments": {}
        },
        "createdAt": {
          "return": "object",
          "arguments": {}
        },
        "id": {
          "return": "object",
          "arguments": {}
        },
        "linkTemplate": {
          "return": "object",
          "arguments": {}
        },
        "linkText": {
          "return": {
            "en": {
              "return": "string",
              "arguments": {}
            },
            "fr": {
              "return": "string",
              "arguments": {}
            }
          },
          "arguments": {}
        },
        "name": {
          "return": "object",
          "arguments": {}
        },
        "notificationGroup": {
          "return": {
            "id": {
              "return": "object",
              "arguments": {}
            },
            "name": {
              "return": {
                "en": {
                  "return": "string",
                  "arguments": {}
                },
                "fr": {
                  "return": "string",
                  "arguments": {}
                }
              },
              "arguments": {}
            }
          },
          "arguments": {}
        },
        "organization": {
          "return": {
            "accountTypeTaxRanks": {
              "return": [
                {
                  "accountType": {
                    "return": "string",
                    "arguments": {}
                  },
                  "id": {
                    "return": "object",
                    "arguments": {}
                  },
                  "taxRank": {
                    "return": "number",
                    "arguments": {}
                  }
                }
              ],
              "arguments": {}
            },
            "allowAccessToSubOrganizations": {
              "return": "boolean",
              "arguments": {}
            },
            "allowDirectCommunication": {
              "return": "boolean",
              "arguments": {}
            },
            "allowInactiveUserAdjustments": {
              "return": "boolean",
              "arguments": {}
            },
            "allowInactiveUserFeeCalculation": {
              "return": "boolean"
            }
          }
        }
      }
    ]
  }
}

FetchNotificationGroupResponse: object

notificationGroup:
object
return:
arguments:
object
Example
{
  "notificationGroup": {
    "return": {
      "id": {
        "return": "object",
        "arguments": {}
      },
      "name": {
        "return": {
          "en": {
            "return": "string",
            "arguments": {}
          },
          "fr": {
            "return": "string",
            "arguments": {}
          }
        },
        "arguments": {}
      }
    },
    "arguments": {}
  }
}

FetchNotificationGroupsInput: object

filter:
pagination:
Example
{
  "filter": {
    "organizationId": "object"
  },
  "pagination": {
    "offSet": "number",
    "perPage": "number",
    "sortDesc": "boolean",
    "sortField": "string"
  }
}

FetchNotificationGroupsResponse: object

notificationGroups:
object
return:
NotificationGroup
arguments:
object
totalCount:
object
return:
Int
arguments:
object
Example
{
  "notificationGroups": {
    "return": [
      {
        "id": {
          "return": "object",
          "arguments": {}
        },
        "name": {
          "return": {
            "en": {
              "return": "string",
              "arguments": {}
            },
            "fr": {
              "return": "string",
              "arguments": {}
            }
          },
          "arguments": {}
        }
      }
    ],
    "arguments": {}
  },
  "totalCount": {
    "return": "number",
    "arguments": {}
  }
}

FetchNotificationsInput: object

filter:
pagination:
Example
{
  "filter": {
    "read": "boolean"
  },
  "pagination": {
    "offSet": "number",
    "perPage": "number",
    "sortDesc": "boolean",
    "sortField": "string"
  }
}

FetchNotificationsResponse: object

notifications:
object
return:
Notification
arguments:
object
totalCount:
object
return:
Int
arguments:
object
Example
{
  "notifications": {
    "return": [
      {
        "body": {
          "return": {
            "en": {
              "return": "string",
              "arguments": {}
            },
            "fr": {
              "return": "string",
              "arguments": {}
            }
          },
          "arguments": {}
        },
        "createdAt": {
          "return": "object",
          "arguments": {}
        },
        "id": {
          "return": "object",
          "arguments": {}
        },
        "link": {
          "return": "object",
          "arguments": {}
        },
        "linkText": {
          "return": {
            "en": {
              "return": "string",
              "arguments": {}
            },
            "fr": {
              "return": "string",
              "arguments": {}
            }
          },
          "arguments": {}
        },
        "notificationGroup": {
          "return": {
            "id": {
              "return": "object",
              "arguments": {}
            },
            "name": {
              "return": {
                "en": {
                  "return": "string",
                  "arguments": {}
                },
                "fr": {
                  "return": "string",
                  "arguments": {}
                }
              },
              "arguments": {}
            }
          },
          "arguments": {}
        },
        "organizationUser": {
          "return": {
            "accessType": {
              "return": "string",
              "arguments": {}
            },
            "apiTokens": {
              "return": [
                {
                  "id": {
                    "return": "object",
                    "arguments": {}
                  },
                  "jwtToken": {
                    "return": "string",
                    "arguments": {}
                  },
                  "name": {
                    "return": "string",
                    "arguments": {}
                  },
                  "organization": {
                    "return": {
                      "browserTabTitle": {
                        "return": "string",
                        "arguments": {}
                      },
                      "faviconLink": {
                        "return": "string",
                        "arguments": {}
                      },
                      "id": {
                        "return": "object",
                        "arguments": {}
                      },
                      "name": {}
                    }
                  }
                }
              ]
            }
          }
        }
      }
    ]
  }
}

FetchOptimizedPortfolioReportsInput: object

organizationId:
pagination:
portfolioOptimizerId:
Example
{
  "organizationId": "object",
  "pagination": {
    "offSet": "number",
    "perPage": "number"
  },
  "portfolioOptimizerId": "object"
}

FetchOptimizedPortfolioReportsResponse: object

portfolioReports:
object
return:
PortfolioReport
arguments:
object
totalCount:
object
return:
Int
arguments:
object
Example
{
  "portfolioReports": {
    "return": [
      {
        "bulkTradeRunReasons": {
          "return": [
            {
              "id": {
                "return": "object",
                "arguments": {}
              },
              "reason": {
                "return": "string",
                "arguments": {}
              },
              "total": {
                "return": "number",
                "arguments": {}
              },
              "unblockedSince": {
                "return": "object",
                "arguments": {}
              }
            }
          ],
          "arguments": {}
        },
        "cashAvailableForTradeCents": {
          "return": "object",
          "arguments": {}
        },
        "cashCents": {
          "return": "object",
          "arguments": {}
        },
        "driftRebalanceRequired": {
          "return": "boolean",
          "arguments": {}
        },
        "expectedCashCents": {
          "return": "object",
          "arguments": {}
        },
        "holdings": {
          "return": [
            {
              "actualPercentage": {
                "return": "number",
                "arguments": {}
              },
              "expectedPercentage": {
                "return": "number",
                "arguments": {}
              },
              "expectedValueCents": {
                "return": "number",
                "arguments": {}
              },
              "financialProduct": {
                "return": {
                  "assignable": {
                    "return": "boolean",
                    "arguments": {}
                  },
                  "autoUpdatePrices": {
                    "return": "boolean",
                    "arguments": {}
                  },
                  "children": {
                    "return": [
                      {
                        "financialProduct": {
                          "return": {
                            "assignable": {
                              "return": "boolean",
                              "arguments": {}
                            },
                            "autoUpdatePrices": {
                              "return": "boolean",
                              "arguments": {}
                            },
                            "children": {
                              "return": [
                                {
                                  "financialProduct": {
                                    "return": {
                                      "assignable": {
                                        "return": "boolean",
                                        "arguments": {}
                                      },
                                      "autoUpdatePrices": {
                                        "return": "boolean",
                                        "arguments": {}
                                      },
                                      "children": {}
                                    }
                                  }
                                }
                              ]
                            }
                          }
                        }
                      }
                    ]
                  }
                }
              }
            }
          ]
        }
      }
    ]
  }
}

FetchOrganizationBillingsInput: object

filter:
pagination:
Example
{
  "filter": {
    "accountIds": [
      "object"
    ],
    "billingCycleIds": [
      "object"
    ],
    "billingDateAfter": "object",
    "billingDateBefore": "object",
    "billingScheduleIds": [
      "object"
    ],
    "clientGroupIds": [
      "object"
    ],
    "feeTierIds": [
      "object"
    ],
    "organizationId": "object",
    "subAccountIds": [
      "object"
    ],
    "userIds": [
      "object"
    ]
  },
  "pagination": {
    "offSet": "number",
    "perPage": "number",
    "sortDesc": "boolean",
    "sortField": "string"
  }
}

FetchOrganizationBillingsResponse: object

organizationBillings:
object
return:
OrganizationBilling
arguments:
object
totalCount:
object
return:
Int
arguments:
object
Example
{
  "organizationBillings": {
    "return": [
      {
        "chargeableMarketValueCentsOnLastDay": {
          "return": "number",
          "arguments": {}
        },
        "feeCents": {
          "return": "number",
          "arguments": {}
        },
        "id": {
          "return": "object",
          "arguments": {}
        },
        "marketValueCentsOnLastDay": {
          "return": "number",
          "arguments": {}
        },
        "organization": {
          "return": {
            "accountTypeTaxRanks": {
              "return": [
                {
                  "accountType": {
                    "return": "string",
                    "arguments": {}
                  },
                  "id": {
                    "return": "object",
                    "arguments": {}
                  },
                  "taxRank": {
                    "return": "number",
                    "arguments": {}
                  }
                }
              ],
              "arguments": {}
            },
            "allowAccessToSubOrganizations": {
              "return": "boolean",
              "arguments": {}
            },
            "allowDirectCommunication": {
              "return": "boolean",
              "arguments": {}
            },
            "allowInactiveUserAdjustments": {
              "return": "boolean",
              "arguments": {}
            },
            "allowInactiveUserFeeCalculation": {
              "return": "boolean",
              "arguments": {}
            },
            "allowInactiveUserRebalancing": {
              "return": "boolean",
              "arguments": {}
            },
            "allowInstantInvest": {
              "return": "boolean",
              "arguments": {}
            },
            "allowPortfolioPerGoal": {
              "return": "boolean",
              "arguments": {}
            },
            "allowPostOptimizationEditing": {
              "return": "boolean",
              "arguments": {}
            },
            "allowViewSubTradeRequestPairs": {
              "return": "boolean",
              "arguments": {}
            },
            "applicableJurisdictions": {
              "return": {
                "all": {
                  "return": "boolean",
                  "arguments": {}
                },
                "only": {
                  "return": [
                    "string"
                  ],
                  "arguments": {}
                }
              },
              "arguments": {}
            },
            "applicableLocalization": {
              "return": {
                "countries": {
                  "return": [
                    "string"
                  ],
                  "arguments": {}
                },
                "dateFormat": {}
              }
            }
          }
        }
      }
    ]
  }
}

FetchOrganizationDashboardResponse: object

dashboard:
object
return:
arguments:
object
Example
{
  "dashboard": {
    "return": {
      "archived": {
        "return": "boolean",
        "arguments": {}
      },
      "id": {
        "return": "object",
        "arguments": {}
      },
      "name": {
        "return": "string",
        "arguments": {}
      },
      "organization": {
        "return": {
          "browserTabTitle": {
            "return": "string",
            "arguments": {}
          },
          "faviconLink": {
            "return": "string",
            "arguments": {}
          },
          "id": {
            "return": "object",
            "arguments": {}
          },
          "name": {
            "return": "string",
            "arguments": {}
          },
          "parent": {
            "return": {
              "browserTabTitle": {
                "return": "string",
                "arguments": {}
              },
              "faviconLink": {
                "return": "string",
                "arguments": {}
              },
              "id": {
                "return": "object",
                "arguments": {}
              },
              "name": {
                "return": "string",
                "arguments": {}
              },
              "parent": {
                "return": {
                  "browserTabTitle": {
                    "return": "string",
                    "arguments": {}
                  },
                  "faviconLink": {
                    "return": "string",
                    "arguments": {}
                  },
                  "id": {
                    "return": "object",
                    "arguments": {}
                  },
                  "name": {
                    "return": "string",
                    "arguments": {}
                  },
                  "parent": {
                    "return": {
                      "browserTabTitle": {
                        "return": "string",
                        "arguments": {}
                      },
                      "faviconLink": {
                        "return": "string",
                        "arguments": {}
                      },
                      "id": {
                        "return": "object",
                        "arguments": {}
                      },
                      "name": {
                        "return": "string",
                        "arguments": {}
                      },
                      "parent": {
                        "return": {
                          "browserTabTitle": {
                            "return": "string",
                            "arguments": {}
                          },
                          "faviconLink": {}
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

FetchOrganizationDashboardsInput: object

filter:
pagination:
Example
{
  "filter": {
    "archived": "boolean",
    "organizationId": "object"
  },
  "pagination": {
    "offSet": "number",
    "perPage": "number",
    "sortDesc": "boolean",
    "sortField": "string"
  }
}

FetchOrganizationDashboardsResponse: object

dashboards:
object
return:
Dashboard
arguments:
object
totalCount:
object
return:
Int
arguments:
object
Example
{
  "dashboards": {
    "return": [
      {
        "archived": {
          "return": "boolean",
          "arguments": {}
        },
        "id": {
          "return": "object",
          "arguments": {}
        },
        "name": {
          "return": "string",
          "arguments": {}
        },
        "organization": {
          "return": {
            "browserTabTitle": {
              "return": "string",
              "arguments": {}
            },
            "faviconLink": {
              "return": "string",
              "arguments": {}
            },
            "id": {
              "return": "object",
              "arguments": {}
            },
            "name": {
              "return": "string",
              "arguments": {}
            },
            "parent": {
              "return": {
                "browserTabTitle": {
                  "return": "string",
                  "arguments": {}
                },
                "faviconLink": {
                  "return": "string",
                  "arguments": {}
                },
                "id": {
                  "return": "object",
                  "arguments": {}
                },
                "name": {
                  "return": "string",
                  "arguments": {}
                },
                "parent": {
                  "return": {
                    "browserTabTitle": {
                      "return": "string",
                      "arguments": {}
                    },
                    "faviconLink": {
                      "return": "string",
                      "arguments": {}
                    },
                    "id": {
                      "return": "object",
                      "arguments": {}
                    },
                    "name": {
                      "return": "string",
                      "arguments": {}
                    },
                    "parent": {
                      "return": {
                        "browserTabTitle": {
                          "return": "string",
                          "arguments": {}
                        },
                        "faviconLink": {
                          "return": "string",
                          "arguments": {}
                        },
                        "id": {
                          "return": "object",
                          "arguments": {}
                        },
                        "name": {
                          "return": "string",
                          "arguments": {}
                        },
                        "parent": {
                          "return": {
                            "browserTabTitle": {
                              "return": "string",
                              "arguments": {}
                            }
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    ]
  }
}

FetchOrganizationFeatureFlagResponse: object

organizationFeatureFlag:
object
return:
arguments:
object
Example
{
  "organizationFeatureFlag": {
    "return": {
      "featureFlags": {
        "return": [
          {
            "enabled": {
              "return": "boolean",
              "arguments": {}
            },
            "type": {
              "return": "string",
              "arguments": {}
            }
          }
        ],
        "arguments": {}
      },
      "id": {
        "return": "object",
        "arguments": {}
      }
    },
    "arguments": {}
  }
}

FetchOrganizationPublicSettingsInput: object

customUrl:
subdomain:
Example
{
  "customUrl": "string",
  "subdomain": "string"
}

FetchOrganizationPublicSettingsResponse: object

browserTabTitle:
object
return:
arguments:
object
faviconLink:
object
return:
arguments:
object
subdomain:
object
return:
arguments:
object
Example
{
  "browserTabTitle": {
    "return": "string",
    "arguments": {}
  },
  "faviconLink": {
    "return": "string",
    "arguments": {}
  },
  "subdomain": {
    "return": "string",
    "arguments": {}
  }
}

FetchOrganizationResponse: object

organization:
object
return:
arguments:
object
Example
{
  "organization": {
    "return": {
      "accountTypeTaxRanks": {
        "return": [
          {
            "accountType": {
              "return": "string",
              "arguments": {}
            },
            "id": {
              "return": "object",
              "arguments": {}
            },
            "taxRank": {
              "return": "number",
              "arguments": {}
            }
          }
        ],
        "arguments": {}
      },
      "allowAccessToSubOrganizations": {
        "return": "boolean",
        "arguments": {}
      },
      "allowDirectCommunication": {
        "return": "boolean",
        "arguments": {}
      },
      "allowInactiveUserAdjustments": {
        "return": "boolean",
        "arguments": {}
      },
      "allowInactiveUserFeeCalculation": {
        "return": "boolean",
        "arguments": {}
      },
      "allowInactiveUserRebalancing": {
        "return": "boolean",
        "arguments": {}
      },
      "allowInstantInvest": {
        "return": "boolean",
        "arguments": {}
      },
      "allowPortfolioPerGoal": {
        "return": "boolean",
        "arguments": {}
      },
      "allowPostOptimizationEditing": {
        "return": "boolean",
        "arguments": {}
      },
      "allowViewSubTradeRequestPairs": {
        "return": "boolean",
        "arguments": {}
      },
      "applicableJurisdictions": {
        "return": {
          "all": {
            "return": "boolean",
            "arguments": {}
          },
          "only": {
            "return": [
              "string"
            ],
            "arguments": {}
          }
        },
        "arguments": {}
      },
      "applicableLocalization": {
        "return": {
          "countries": {
            "return": [
              "string"
            ],
            "arguments": {}
          },
          "dateFormat": {
            "return": "string",
            "arguments": {}
          },
          "defaultCurrency": {
            "return": "string",
            "arguments": {}
          },
          "defaultLanguage": {
            "return": "string",
            "arguments": {}
          },
          "id": {
            "return": "object",
            "arguments": {}
          },
          "languages": {
            "return": [
              "string"
            ],
            "arguments": {}
          },
          "name": {}
        }
      }
    }
  }
}

FetchOrganizationSubdomainInput: object

customUrl:
Example
{
  "customUrl": "string"
}

FetchOrganizationSubdomainResponse: object

subdomain:
object
return:
arguments:
object
Example
{
  "subdomain": {
    "return": "string",
    "arguments": {}
  }
}

FetchOrganizationUserResponse: object

organizationUser:
object
return:
arguments:
object
Example
{
  "organizationUser": {
    "return": {
      "accessType": {
        "return": "string",
        "arguments": {}
      },
      "apiTokens": {
        "return": [
          {
            "id": {
              "return": "object",
              "arguments": {}
            },
            "jwtToken": {
              "return": "string",
              "arguments": {}
            },
            "name": {
              "return": "string",
              "arguments": {}
            },
            "organization": {
              "return": {
                "browserTabTitle": {
                  "return": "string",
                  "arguments": {}
                },
                "faviconLink": {
                  "return": "string",
                  "arguments": {}
                },
                "id": {
                  "return": "object",
                  "arguments": {}
                },
                "name": {
                  "return": "string",
                  "arguments": {}
                },
                "parent": {
                  "return": {
                    "browserTabTitle": {
                      "return": "string",
                      "arguments": {}
                    },
                    "faviconLink": {
                      "return": "string",
                      "arguments": {}
                    },
                    "id": {
                      "return": "object",
                      "arguments": {}
                    },
                    "name": {
                      "return": "string",
                      "arguments": {}
                    },
                    "parent": {
                      "return": {
                        "browserTabTitle": {
                          "return": "string",
                          "arguments": {}
                        },
                        "faviconLink": {
                          "return": "string",
                          "arguments": {}
                        },
                        "id": {
                          "return": "object",
                          "arguments": {}
                        },
                        "name": {
                          "return": "string",
                          "arguments": {}
                        },
                        "parent": {
                          "return": {
                            "browserTabTitle": {
                              "return": "string",
                              "arguments": {}
                            },
                            "faviconLink": {
                              "return": "string",
                              "arguments": {}
                            },
                            "id": {
                              "return": "object",
                              "arguments": {}
                            },
                            "name": {
                              "return": "string",
                              "arguments": {}
                            }
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        ]
      }
    }
  }
}

FetchOrganizationUsersInput: object

filter:
pagination:
Example
{
  "filter": {
    "accessType": "string",
    "authAudience": "string",
    "childrenForOrganizationId": "object",
    "organizationId": "object",
    "parentForOrganizationId": "object",
    "roleIds": [
      "object"
    ],
    "roleProfileId": "object",
    "searchText": "object"
  },
  "pagination": {
    "offSet": "number",
    "perPage": "number",
    "sortDesc": "boolean",
    "sortField": "string"
  }
}

FetchOrganizationUsersResponse: object

organizationUsers:
object
return:
OrganizationUser
arguments:
object
totalCount:
object
return:
Int
arguments:
object
Example
{
  "organizationUsers": {
    "return": [
      {
        "accessType": {
          "return": "string",
          "arguments": {}
        },
        "apiTokens": {
          "return": [
            {
              "id": {
                "return": "object",
                "arguments": {}
              },
              "jwtToken": {
                "return": "string",
                "arguments": {}
              },
              "name": {
                "return": "string",
                "arguments": {}
              },
              "organization": {
                "return": {
                  "browserTabTitle": {
                    "return": "string",
                    "arguments": {}
                  },
                  "faviconLink": {
                    "return": "string",
                    "arguments": {}
                  },
                  "id": {
                    "return": "object",
                    "arguments": {}
                  },
                  "name": {
                    "return": "string",
                    "arguments": {}
                  },
                  "parent": {
                    "return": {
                      "browserTabTitle": {
                        "return": "string",
                        "arguments": {}
                      },
                      "faviconLink": {
                        "return": "string",
                        "arguments": {}
                      },
                      "id": {
                        "return": "object",
                        "arguments": {}
                      },
                      "name": {
                        "return": "string",
                        "arguments": {}
                      },
                      "parent": {
                        "return": {
                          "browserTabTitle": {
                            "return": "string",
                            "arguments": {}
                          },
                          "faviconLink": {
                            "return": "string",
                            "arguments": {}
                          },
                          "id": {
                            "return": "object",
                            "arguments": {}
                          },
                          "name": {
                            "return": "string",
                            "arguments": {}
                          },
                          "parent": {
                            "return": {
                              "browserTabTitle": {
                                "return": "string",
                                "arguments": {}
                              },
                              "faviconLink": {
                                "return": "string",
                                "arguments": {}
                              },
                              "id": {
                                "return": "object",
                                "arguments": {}
                              },
                              "name": {
                                "return": "string"
                              }
                            }
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          ]
        }
      }
    ]
  }
}

FetchOrganizationsInput: object

filter:
pagination:
Example
{
  "filter": {
    "childrenFor": "object",
    "searchText": "string"
  },
  "pagination": {
    "offSet": "number",
    "perPage": "number",
    "sortDesc": "boolean",
    "sortField": "string"
  }
}

FetchOrganizationsResponse: object

organizations:
object
return:
Organization
arguments:
object
totalCount:
object
return:
Int
arguments:
object
Example
{
  "organizations": {
    "return": [
      {
        "accountTypeTaxRanks": {
          "return": [
            {
              "accountType": {
                "return": "string",
                "arguments": {}
              },
              "id": {
                "return": "object",
                "arguments": {}
              },
              "taxRank": {
                "return": "number",
                "arguments": {}
              }
            }
          ],
          "arguments": {}
        },
        "allowAccessToSubOrganizations": {
          "return": "boolean",
          "arguments": {}
        },
        "allowDirectCommunication": {
          "return": "boolean",
          "arguments": {}
        },
        "allowInactiveUserAdjustments": {
          "return": "boolean",
          "arguments": {}
        },
        "allowInactiveUserFeeCalculation": {
          "return": "boolean",
          "arguments": {}
        },
        "allowInactiveUserRebalancing": {
          "return": "boolean",
          "arguments": {}
        },
        "allowInstantInvest": {
          "return": "boolean",
          "arguments": {}
        },
        "allowPortfolioPerGoal": {
          "return": "boolean",
          "arguments": {}
        },
        "allowPostOptimizationEditing": {
          "return": "boolean",
          "arguments": {}
        },
        "allowViewSubTradeRequestPairs": {
          "return": "boolean",
          "arguments": {}
        },
        "applicableJurisdictions": {
          "return": {
            "all": {
              "return": "boolean",
              "arguments": {}
            },
            "only": {
              "return": [
                "string"
              ],
              "arguments": {}
            }
          },
          "arguments": {}
        },
        "applicableLocalization": {
          "return": {
            "countries": {
              "return": [
                "string"
              ],
              "arguments": {}
            },
            "dateFormat": {
              "return": "string",
              "arguments": {}
            },
            "defaultCurrency": {
              "return": "string",
              "arguments": {}
            },
            "defaultLanguage": {
              "return": "string",
              "arguments": {}
            },
            "id": {
              "return": "object",
              "arguments": {}
            },
            "languages": {
              "return": [
                "string"
              ],
              "arguments": {}
            }
          }
        }
      }
    ]
  }
}

FetchPageConfigurationResponse: object

pageConfiguration:
object
return:
arguments:
object
Example
{
  "pageConfiguration": {
    "return": {
      "createdAt": {
        "return": "object",
        "arguments": {}
      },
      "id": {
        "return": "object",
        "arguments": {}
      },
      "name": {
        "return": "string",
        "arguments": {}
      },
      "options": {
        "return": "object",
        "arguments": {}
      },
      "organization": {
        "return": {
          "accountTypeTaxRanks": {
            "return": [
              {
                "accountType": {
                  "return": "string",
                  "arguments": {}
                },
                "id": {
                  "return": "object",
                  "arguments": {}
                },
                "taxRank": {
                  "return": "number",
                  "arguments": {}
                }
              }
            ],
            "arguments": {}
          },
          "allowAccessToSubOrganizations": {
            "return": "boolean",
            "arguments": {}
          },
          "allowDirectCommunication": {
            "return": "boolean",
            "arguments": {}
          },
          "allowInactiveUserAdjustments": {
            "return": "boolean",
            "arguments": {}
          },
          "allowInactiveUserFeeCalculation": {
            "return": "boolean",
            "arguments": {}
          },
          "allowInactiveUserRebalancing": {
            "return": "boolean",
            "arguments": {}
          },
          "allowInstantInvest": {
            "return": "boolean",
            "arguments": {}
          },
          "allowPortfolioPerGoal": {
            "return": "boolean",
            "arguments": {}
          },
          "allowPostOptimizationEditing": {
            "return": "boolean",
            "arguments": {}
          },
          "allowViewSubTradeRequestPairs": {
            "return": "boolean",
            "arguments": {}
          },
          "applicableJurisdictions": {
            "return": {
              "all": {
                "return": "boolean",
                "arguments": {}
              },
              "only": {
                "return": [
                  "string"
                ],
                "arguments": {}
              }
            },
            "arguments": {}
          },
          "applicableLocalization": {
            "return": {
              "countries": {
                "return": [
                  "string"
                ],
                "arguments": {}
              },
              "dateFormat": {
                "return": "string"
              }
            }
          }
        }
      }
    }
  }
}

FetchPageConfigurationsInput: object

filter:
pagination:
Example
{
  "filter": {
    "organizationId": "object",
    "type": "string"
  },
  "pagination": {
    "offSet": "number",
    "perPage": "number",
    "sortDesc": "boolean",
    "sortField": "string"
  }
}

FetchPageConfigurationsResponse: object

pageConfigurations:
object
return:
PageConfiguration
arguments:
object
totalCount:
object
return:
Int
arguments:
object
Example
{
  "pageConfigurations": {
    "return": [
      {
        "createdAt": {
          "return": "object",
          "arguments": {}
        },
        "id": {
          "return": "object",
          "arguments": {}
        },
        "name": {
          "return": "string",
          "arguments": {}
        },
        "options": {
          "return": "object",
          "arguments": {}
        },
        "organization": {
          "return": {
            "accountTypeTaxRanks": {
              "return": [
                {
                  "accountType": {
                    "return": "string",
                    "arguments": {}
                  },
                  "id": {
                    "return": "object",
                    "arguments": {}
                  },
                  "taxRank": {
                    "return": "number",
                    "arguments": {}
                  }
                }
              ],
              "arguments": {}
            },
            "allowAccessToSubOrganizations": {
              "return": "boolean",
              "arguments": {}
            },
            "allowDirectCommunication": {
              "return": "boolean",
              "arguments": {}
            },
            "allowInactiveUserAdjustments": {
              "return": "boolean",
              "arguments": {}
            },
            "allowInactiveUserFeeCalculation": {
              "return": "boolean",
              "arguments": {}
            },
            "allowInactiveUserRebalancing": {
              "return": "boolean",
              "arguments": {}
            },
            "allowInstantInvest": {
              "return": "boolean",
              "arguments": {}
            },
            "allowPortfolioPerGoal": {
              "return": "boolean",
              "arguments": {}
            },
            "allowPostOptimizationEditing": {
              "return": "boolean",
              "arguments": {}
            },
            "allowViewSubTradeRequestPairs": {
              "return": "boolean",
              "arguments": {}
            },
            "applicableJurisdictions": {
              "return": {
                "all": {
                  "return": "boolean",
                  "arguments": {}
                },
                "only": {
                  "return": [
                    "string"
                  ],
                  "arguments": {}
                }
              },
              "arguments": {}
            },
            "applicableLocalization": {
              "return": {
                "countries": {
                  "return": [
                    "string"
                  ],
                  "arguments": {}
                },
                "dateFormat": {}
              }
            }
          }
        }
      }
    ]
  }
}

FetchPermissionsResponse: object

permissions:
object
return:
Permission
arguments:
object
Example
{
  "permissions": {
    "return": [
      {
        "clientEnabled": {
          "return": "boolean",
          "arguments": {}
        },
        "translatedDescription": {
          "return": {
            "en": {
              "return": "string",
              "arguments": {}
            },
            "fr": {
              "return": "string",
              "arguments": {}
            }
          },
          "arguments": {}
        },
        "value": {
          "return": "string",
          "arguments": {}
        }
      }
    ],
    "arguments": {}
  }
}

FetchPortfolioOptimizerInput: object

portfolioOptimizerId:
Example
{
  "portfolioOptimizerId": "object"
}

FetchPortfolioOptimizerResponse: object

portfolioOptimizer:
object
return:
arguments:
object
Example
{
  "portfolioOptimizer": {
    "return": {
      "createdAt": {
        "return": "object",
        "arguments": {}
      },
      "expectedTotalSubTradeRequests": {
        "return": "number",
        "arguments": {}
      },
      "id": {
        "return": "object",
        "arguments": {}
      },
      "numPortfolios": {
        "return": "number",
        "arguments": {}
      },
      "organization": {
        "return": {
          "browserTabTitle": {
            "return": "string",
            "arguments": {}
          },
          "faviconLink": {
            "return": "string",
            "arguments": {}
          },
          "id": {
            "return": "object",
            "arguments": {}
          },
          "name": {
            "return": "string",
            "arguments": {}
          },
          "parent": {
            "return": {
              "browserTabTitle": {
                "return": "string",
                "arguments": {}
              },
              "faviconLink": {
                "return": "string",
                "arguments": {}
              },
              "id": {
                "return": "object",
                "arguments": {}
              },
              "name": {
                "return": "string",
                "arguments": {}
              },
              "parent": {
                "return": {
                  "browserTabTitle": {
                    "return": "string",
                    "arguments": {}
                  },
                  "faviconLink": {
                    "return": "string",
                    "arguments": {}
                  },
                  "id": {
                    "return": "object",
                    "arguments": {}
                  },
                  "name": {
                    "return": "string",
                    "arguments": {}
                  },
                  "parent": {
                    "return": {
                      "browserTabTitle": {
                        "return": "string",
                        "arguments": {}
                      },
                      "faviconLink": {
                        "return": "string",
                        "arguments": {}
                      },
                      "id": {
                        "return": "object",
                        "arguments": {}
                      },
                      "name": {
                        "return": "string",
                        "arguments": {}
                      },
                      "parent": {
                        "return": {
                          "browserTabTitle": {}
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

FetchPortfolioOptimizersInput: object

filter:
pagination:
Example
{
  "filter": {
    "createdAt": "object",
    "numPortfolios": "number",
    "organizationId": "object",
    "state": "string",
    "type": "string"
  },
  "pagination": {
    "offSet": "number",
    "perPage": "number",
    "sortDesc": "boolean",
    "sortField": "string"
  }
}

FetchPortfolioOptimizersResponse: object

portfolioOptimizers:
object
return:
PortfolioOptimizer
arguments:
object
totalCount:
object
return:
Int
arguments:
object
Example
{
  "portfolioOptimizers": {
    "return": [
      {
        "createdAt": {
          "return": "object",
          "arguments": {}
        },
        "expectedTotalSubTradeRequests": {
          "return": "number",
          "arguments": {}
        },
        "id": {
          "return": "object",
          "arguments": {}
        },
        "numPortfolios": {
          "return": "number",
          "arguments": {}
        },
        "organization": {
          "return": {
            "browserTabTitle": {
              "return": "string",
              "arguments": {}
            },
            "faviconLink": {
              "return": "string",
              "arguments": {}
            },
            "id": {
              "return": "object",
              "arguments": {}
            },
            "name": {
              "return": "string",
              "arguments": {}
            },
            "parent": {
              "return": {
                "browserTabTitle": {
                  "return": "string",
                  "arguments": {}
                },
                "faviconLink": {
                  "return": "string",
                  "arguments": {}
                },
                "id": {
                  "return": "object",
                  "arguments": {}
                },
                "name": {
                  "return": "string",
                  "arguments": {}
                },
                "parent": {
                  "return": {
                    "browserTabTitle": {
                      "return": "string",
                      "arguments": {}
                    },
                    "faviconLink": {
                      "return": "string",
                      "arguments": {}
                    },
                    "id": {
                      "return": "object",
                      "arguments": {}
                    },
                    "name": {
                      "return": "string",
                      "arguments": {}
                    },
                    "parent": {
                      "return": {
                        "browserTabTitle": {
                          "return": "string",
                          "arguments": {}
                        },
                        "faviconLink": {
                          "return": "string",
                          "arguments": {}
                        },
                        "id": {
                          "return": "object",
                          "arguments": {}
                        },
                        "name": {
                          "return": "string",
                          "arguments": {}
                        },
                        "parent": {
                          "return": {}
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    ]
  }
}

FetchPortfolioReportsInput: object

filter:
pagination:
Example
{
  "filter": {
    "anyRebalanceRequired": "boolean",
    "bulkTradeRequiredReason": "string",
    "cashTrigger": "boolean",
    "driftRebalanceRequired": "boolean",
    "driftTrigger": "boolean",
    "goalId": "object",
    "lastOptimizedBy": "object",
    "liquidateRebalanceRequired": "boolean",
    "modelPortfolioId": "object",
    "modelPortfolioType": "string",
    "organizationId": "object",
    "pendingSubTradeRequests": "boolean",
    "subAccountId": "object",
    "transferRebalanceRequired": "boolean"
  },
  "pagination": {
    "offSet": "number",
    "perPage": "number",
    "sortDesc": "boolean",
    "sortField": "string"
  }
}

FetchPortfolioReportsResponse: object

portfolioReports:
object
return:
PortfolioReport
arguments:
object
totalCount:
object
return:
Int
arguments:
object
Example
{
  "portfolioReports": {
    "return": [
      {
        "bulkTradeRunReasons": {
          "return": [
            {
              "id": {
                "return": "object",
                "arguments": {}
              },
              "reason": {
                "return": "string",
                "arguments": {}
              },
              "total": {
                "return": "number",
                "arguments": {}
              },
              "unblockedSince": {
                "return": "object",
                "arguments": {}
              }
            }
          ],
          "arguments": {}
        },
        "cashAvailableForTradeCents": {
          "return": "object",
          "arguments": {}
        },
        "cashCents": {
          "return": "object",
          "arguments": {}
        },
        "driftRebalanceRequired": {
          "return": "boolean",
          "arguments": {}
        },
        "expectedCashCents": {
          "return": "object",
          "arguments": {}
        },
        "holdings": {
          "return": [
            {
              "actualPercentage": {
                "return": "number",
                "arguments": {}
              },
              "expectedPercentage": {
                "return": "number",
                "arguments": {}
              },
              "expectedValueCents": {
                "return": "number",
                "arguments": {}
              },
              "financialProduct": {
                "return": {
                  "assignable": {
                    "return": "boolean",
                    "arguments": {}
                  },
                  "autoUpdatePrices": {
                    "return": "boolean",
                    "arguments": {}
                  },
                  "children": {
                    "return": [
                      {
                        "financialProduct": {
                          "return": {
                            "assignable": {
                              "return": "boolean",
                              "arguments": {}
                            },
                            "autoUpdatePrices": {
                              "return": "boolean",
                              "arguments": {}
                            },
                            "children": {
                              "return": [
                                {
                                  "financialProduct": {
                                    "return": {
                                      "assignable": {
                                        "return": "boolean",
                                        "arguments": {}
                                      },
                                      "autoUpdatePrices": {
                                        "return": "boolean",
                                        "arguments": {}
                                      },
                                      "children": {}
                                    }
                                  }
                                }
                              ]
                            }
                          }
                        }
                      }
                    ]
                  }
                }
              }
            }
          ]
        }
      }
    ]
  }
}

FetchPublicOrganizationsInput: object

filter:
pagination:
Example
{
  "filter": {
    "childrenFor": "object",
    "referenceIds": [
      "string"
    ],
    "searchText": "string"
  },
  "pagination": {
    "offSet": "number",
    "perPage": "number",
    "sortDesc": "boolean",
    "sortField": "string"
  }
}

FetchPublicOrganizationsResponse: object

organizations:
object
return:
PublicOrganization
arguments:
object
totalCount:
object
return:
Int
arguments:
object
Example
{
  "organizations": {
    "return": [
      {
        "browserTabTitle": {
          "return": "string",
          "arguments": {}
        },
        "faviconLink": {
          "return": "string",
          "arguments": {}
        },
        "id": {
          "return": "object",
          "arguments": {}
        },
        "name": {
          "return": "string",
          "arguments": {}
        },
        "parent": {
          "return": {
            "browserTabTitle": {
              "return": "string",
              "arguments": {}
            },
            "faviconLink": {
              "return": "string",
              "arguments": {}
            },
            "id": {
              "return": "object",
              "arguments": {}
            },
            "name": {
              "return": "string",
              "arguments": {}
            },
            "parent": {
              "return": {
                "browserTabTitle": {
                  "return": "string",
                  "arguments": {}
                },
                "faviconLink": {
                  "return": "string",
                  "arguments": {}
                },
                "id": {
                  "return": "object",
                  "arguments": {}
                },
                "name": {
                  "return": "string",
                  "arguments": {}
                },
                "parent": {
                  "return": {
                    "browserTabTitle": {
                      "return": "string",
                      "arguments": {}
                    },
                    "faviconLink": {
                      "return": "string",
                      "arguments": {}
                    },
                    "id": {
                      "return": "object",
                      "arguments": {}
                    },
                    "name": {
                      "return": "string",
                      "arguments": {}
                    },
                    "parent": {
                      "return": {
                        "browserTabTitle": {
                          "return": "string",
                          "arguments": {}
                        },
                        "faviconLink": {
                          "return": "string",
                          "arguments": {}
                        },
                        "id": {
                          "return": "object",
                          "arguments": {}
                        },
                        "name": {
                          "return": "string",
                          "arguments": {}
                        },
                        "parent": {
                          "return": {}
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    ]
  }
}

FetchRebalanceHoldingReportsInput: object

filter:
pagination:
Example
{
  "filter": {
    "subAccountId": "object"
  },
  "pagination": {
    "offSet": "number",
    "perPage": "number",
    "sortDesc": "boolean",
    "sortField": "string"
  }
}

FetchRebalanceHoldingReportsResponse: object

rebalanceHoldingReports:
object
return:
RebalanceHoldingReport
arguments:
object
totalCount:
object
return:
Int
arguments:
object
Example
{
  "rebalanceHoldingReports": {
    "return": [
      {
        "account": {
          "return": {
            "affiliations": {
              "return": [
                {
                  "allocation": {
                    "return": "number",
                    "arguments": {}
                  },
                  "id": {
                    "return": "object",
                    "arguments": {}
                  },
                  "relation": {
                    "return": "string",
                    "arguments": {}
                  },
                  "signatureRequired": {
                    "return": "boolean",
                    "arguments": {}
                  },
                  "type": {
                    "return": "string",
                    "arguments": {}
                  },
                  "user": {
                    "return": {
                      "accessibleBy": {
                        "return": [
                          {
                            "displayOptions": {
                              "return": {
                                "hide": {
                                  "return": "boolean",
                                  "arguments": {}
                                },
                                "order": {
                                  "return": "number",
                                  "arguments": {}
                                }
                              },
                              "arguments": {}
                            },
                            "organizationUser": {
                              "return": {
                                "accessType": {
                                  "return": "string",
                                  "arguments": {}
                                },
                                "apiTokens": {
                                  "return": [
                                    {
                                      "id": {
                                        "return": "object",
                                        "arguments": {}
                                      },
                                      "jwtToken": {
                                        "return": "string",
                                        "arguments": {}
                                      },
                                      "name": {
                                        "return": "string",
                                        "arguments": {}
                                      },
                                      "organization": {
                                        "return": {
                                          "browserTabTitle": {
                                            "return": "string",
                                            "arguments": {}
                                          },
                                          "faviconLink": {
                                            "return": "string",
                                            "arguments": {}
                                          },
                                          "id": {
                                            "return": "object",
                                            "arguments": {}
                                          },
                                          "name": {
                                            "return": "string",
                                            "arguments": {}
                                          },
                                          "parent": {
                                            "return": {
                                              "browserTabTitle": {
                                                "return": "string",
                                                "arguments": {}
                                              }
                                            }
                                          }
                                        }
                                      }
                                    }
                                  ]
                                }
                              }
                            }
                          }
                        ]
                      }
                    }
                  }
                }
              ]
            }
          }
        }
      }
    ]
  }
}

FetchRebalanceMetricsInput: object

rebalanceMetricsId:
Example
{
  "rebalanceMetricsId": "object"
}

FetchRebalanceMetricsResponse: object

rebalanceMetrics:
object
return:
arguments:
object
Example
{
  "rebalanceMetrics": {
    "return": {
      "accounts": {
        "return": "number",
        "arguments": {}
      },
      "buyQuantity": {
        "return": "number",
        "arguments": {}
      },
      "buyValueCents": {
        "return": "object",
        "arguments": {}
      },
      "full": {
        "return": "boolean",
        "arguments": {}
      },
      "id": {
        "return": "object",
        "arguments": {}
      },
      "screenedAt": {
        "return": "object",
        "arguments": {}
      },
      "sellQuantity": {
        "return": "number",
        "arguments": {}
      },
      "sellValueCents": {
        "return": "object",
        "arguments": {}
      },
      "state": {
        "return": "string",
        "arguments": {}
      },
      "subAccounts": {
        "return": "number",
        "arguments": {}
      },
      "type": {
        "return": "string",
        "arguments": {}
      },
      "users": {
        "return": "number",
        "arguments": {}
      }
    },
    "arguments": {}
  }
}

FetchRebalanceReportsInput: object

filter:
pagination:
Example
{
  "filter": {
    "accountIds": [
      "object"
    ],
    "accountType": "string",
    "contributionOnly": "boolean",
    "full": "boolean",
    "modelPortfolioIds": [
      "object"
    ],
    "organizationId": "object",
    "rebalanceType": "string",
    "subAccountIds": [
      "object"
    ]
  },
  "pagination": {
    "offSet": "number",
    "perPage": "number",
    "sortDesc": "boolean",
    "sortField": "string"
  }
}

FetchRebalanceReportsResponse: object

rebalanceReports:
object
return:
RebalanceReport
arguments:
object
totalCount:
object
return:
Int
arguments:
object
Example
{
  "rebalanceReports": {
    "return": [
      {
        "account": {
          "return": {
            "affiliations": {
              "return": [
                {
                  "allocation": {
                    "return": "number",
                    "arguments": {}
                  },
                  "id": {
                    "return": "object",
                    "arguments": {}
                  },
                  "relation": {
                    "return": "string",
                    "arguments": {}
                  },
                  "signatureRequired": {
                    "return": "boolean",
                    "arguments": {}
                  },
                  "type": {
                    "return": "string",
                    "arguments": {}
                  },
                  "user": {
                    "return": {
                      "accessibleBy": {
                        "return": [
                          {
                            "displayOptions": {
                              "return": {
                                "hide": {
                                  "return": "boolean",
                                  "arguments": {}
                                },
                                "order": {
                                  "return": "number",
                                  "arguments": {}
                                }
                              },
                              "arguments": {}
                            },
                            "organizationUser": {
                              "return": {
                                "accessType": {
                                  "return": "string",
                                  "arguments": {}
                                },
                                "apiTokens": {
                                  "return": [
                                    {
                                      "id": {
                                        "return": "object",
                                        "arguments": {}
                                      },
                                      "jwtToken": {
                                        "return": "string",
                                        "arguments": {}
                                      },
                                      "name": {
                                        "return": "string",
                                        "arguments": {}
                                      },
                                      "organization": {
                                        "return": {
                                          "browserTabTitle": {
                                            "return": "string",
                                            "arguments": {}
                                          },
                                          "faviconLink": {
                                            "return": "string",
                                            "arguments": {}
                                          },
                                          "id": {
                                            "return": "object",
                                            "arguments": {}
                                          },
                                          "name": {
                                            "return": "string",
                                            "arguments": {}
                                          },
                                          "parent": {
                                            "return": {
                                              "browserTabTitle": {
                                                "return": "string",
                                                "arguments": {}
                                              }
                                            }
                                          }
                                        }
                                      }
                                    }
                                  ]
                                }
                              }
                            }
                          }
                        ]
                      }
                    }
                  }
                }
              ]
            }
          }
        }
      }
    ]
  }
}

FetchRebalanceResponse: object

rebalance:
object
return:
arguments:
object
Example
{
  "rebalance": {
    "return": {
      "actualQuantitiesSet": {
        "return": "boolean",
        "arguments": {}
      },
      "allocationFileUrl": {
        "return": "string",
        "arguments": {}
      },
      "allocationFileUrls": {
        "return": [
          "string"
        ],
        "arguments": {}
      },
      "bulkTrades": {
        "return": [
          {
            "bulkTrades": {
              "return": [
                {
                  "_id": {
                    "return": "string",
                    "arguments": {}
                  },
                  "currency": {
                    "return": "string",
                    "arguments": {}
                  },
                  "exchange": {
                    "return": "string",
                    "arguments": {}
                  },
                  "expectedPriceCents": {
                    "return": "number",
                    "arguments": {}
                  },
                  "expectedPriceInCurrencyCents": {
                    "return": "number",
                    "arguments": {}
                  },
                  "total": {
                    "return": "number",
                    "arguments": {}
                  }
                }
              ],
              "arguments": {}
            },
            "type": {
              "return": "string",
              "arguments": {}
            }
          }
        ],
        "arguments": {}
      },
      "buyBulkTradeFileUrl": {
        "return": "string",
        "arguments": {}
      },
      "createdAt": {
        "return": "object",
        "arguments": {}
      },
      "id": {
        "return": "object",
        "arguments": {}
      },
      "mutualFundFileUrl": {
        "return": "string",
        "arguments": {}
      },
      "organization": {
        "return": {
          "browserTabTitle": {
            "return": "string",
            "arguments": {}
          },
          "faviconLink": {
            "return": "string",
            "arguments": {}
          },
          "id": {
            "return": "object",
            "arguments": {}
          },
          "name": {
            "return": "string",
            "arguments": {}
          },
          "parent": {
            "return": {
              "browserTabTitle": {
                "return": "string",
                "arguments": {}
              },
              "faviconLink": {
                "return": "string"
              }
            }
          }
        }
      }
    }
  }
}

FetchRebalancesInput: object

filter:
pagination:
Example
{
  "filter": {
    "organizationId": "object",
    "state": "string"
  },
  "pagination": {
    "offSet": "number",
    "perPage": "number",
    "sortDesc": "boolean",
    "sortField": "string"
  }
}

FetchRebalancesResponse: object

rebalances:
object
return:
Rebalance
arguments:
object
totalCount:
object
return:
Int
arguments:
object
Example
{
  "rebalances": {
    "return": [
      {
        "actualQuantitiesSet": {
          "return": "boolean",
          "arguments": {}
        },
        "allocationFileUrl": {
          "return": "string",
          "arguments": {}
        },
        "allocationFileUrls": {
          "return": [
            "string"
          ],
          "arguments": {}
        },
        "bulkTrades": {
          "return": [
            {
              "bulkTrades": {
                "return": [
                  {
                    "_id": {
                      "return": "string",
                      "arguments": {}
                    },
                    "currency": {
                      "return": "string",
                      "arguments": {}
                    },
                    "exchange": {
                      "return": "string",
                      "arguments": {}
                    },
                    "expectedPriceCents": {
                      "return": "number",
                      "arguments": {}
                    },
                    "expectedPriceInCurrencyCents": {
                      "return": "number",
                      "arguments": {}
                    },
                    "total": {
                      "return": "number",
                      "arguments": {}
                    }
                  }
                ],
                "arguments": {}
              },
              "type": {
                "return": "string",
                "arguments": {}
              }
            }
          ],
          "arguments": {}
        },
        "buyBulkTradeFileUrl": {
          "return": "string",
          "arguments": {}
        },
        "createdAt": {
          "return": "object",
          "arguments": {}
        },
        "id": {
          "return": "object",
          "arguments": {}
        },
        "mutualFundFileUrl": {
          "return": "string",
          "arguments": {}
        },
        "organization": {
          "return": {
            "browserTabTitle": {
              "return": "string",
              "arguments": {}
            },
            "faviconLink": {
              "return": "string",
              "arguments": {}
            },
            "id": {
              "return": "object",
              "arguments": {}
            },
            "name": {
              "return": "string",
              "arguments": {}
            },
            "parent": {
              "return": {
                "browserTabTitle": {
                  "return": "string",
                  "arguments": {}
                },
                "faviconLink": {}
              }
            }
          }
        }
      }
    ]
  }
}

FetchReportInput: object

organizationId:
reportId:
Example
{
  "organizationId": "object",
  "reportId": "object"
}

FetchReportOptionsInput: object

type:
Example
{
  "type": "string"
}

FetchReportOptionsResponse: object

columns:
object
return:
String
arguments:
object
filters:
object
return:
ReportFilterOptions
arguments:
object
Example
{
  "columns": {
    "return": [
      "string"
    ],
    "arguments": {}
  },
  "filters": {
    "return": [
      {
        "comparisons": {
          "return": [
            {
              "comparison": {
                "return": "string",
                "arguments": {}
              },
              "options": {
                "return": [
                  "string"
                ],
                "arguments": {}
              },
              "valueTypes": {
                "return": "string",
                "arguments": {}
              }
            }
          ],
          "arguments": {}
        },
        "field": {
          "return": "string",
          "arguments": {}
        }
      }
    ],
    "arguments": {}
  }
}

FetchReportResponse: object

report:
object
return:
arguments:
object
Example
{
  "report": {
    "return": {
      "accessType": {
        "return": "string",
        "arguments": {}
      },
      "author": {
        "return": {
          "email": {
            "return": "string",
            "arguments": {}
          },
          "firstName": {
            "return": "string",
            "arguments": {}
          },
          "id": {
            "return": "object",
            "arguments": {}
          },
          "language": {
            "return": "string",
            "arguments": {}
          },
          "lastName": {
            "return": "string",
            "arguments": {}
          },
          "organization": {
            "return": {
              "browserTabTitle": {
                "return": "string",
                "arguments": {}
              },
              "faviconLink": {
                "return": "string",
                "arguments": {}
              },
              "id": {
                "return": "object",
                "arguments": {}
              },
              "name": {
                "return": "string",
                "arguments": {}
              },
              "parent": {
                "return": {
                  "browserTabTitle": {
                    "return": "string",
                    "arguments": {}
                  },
                  "faviconLink": {
                    "return": "string",
                    "arguments": {}
                  },
                  "id": {
                    "return": "object",
                    "arguments": {}
                  },
                  "name": {
                    "return": "string",
                    "arguments": {}
                  },
                  "parent": {
                    "return": {
                      "browserTabTitle": {
                        "return": "string",
                        "arguments": {}
                      },
                      "faviconLink": {
                        "return": "string",
                        "arguments": {}
                      },
                      "id": {
                        "return": "object",
                        "arguments": {}
                      },
                      "name": {
                        "return": "string",
                        "arguments": {}
                      },
                      "parent": {
                        "return": {
                          "browserTabTitle": {
                            "return": "string",
                            "arguments": {}
                          },
                          "faviconLink": {
                            "return": "string",
                            "arguments": {}
                          },
                          "id": {}
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

FetchReportsFilterInput: object

organizationId:
type:
Example
{
  "organizationId": "object",
  "type": "string"
}

FetchReportsInput: object

filter:
pagination:
Example
{
  "filter": {
    "organizationId": "object",
    "type": "string"
  },
  "pagination": {
    "offSet": "number",
    "perPage": "number",
    "sortDesc": "boolean",
    "sortField": "string"
  }
}

FetchReportsPaginationInput: object

offSet:
Int
perPage:
Int
sortDesc:
sortField:
Example
{
  "offSet": "number",
  "perPage": "number",
  "sortDesc": "boolean",
  "sortField": "string"
}

FetchReportsResponse: object

reports:
object
return:
DataReport
arguments:
object
totalCount:
object
return:
Int
arguments:
object
Example
{
  "reports": {
    "return": [
      {
        "accessType": {
          "return": "string",
          "arguments": {}
        },
        "author": {
          "return": {
            "email": {
              "return": "string",
              "arguments": {}
            },
            "firstName": {
              "return": "string",
              "arguments": {}
            },
            "id": {
              "return": "object",
              "arguments": {}
            },
            "language": {
              "return": "string",
              "arguments": {}
            },
            "lastName": {
              "return": "string",
              "arguments": {}
            },
            "organization": {
              "return": {
                "browserTabTitle": {
                  "return": "string",
                  "arguments": {}
                },
                "faviconLink": {
                  "return": "string",
                  "arguments": {}
                },
                "id": {
                  "return": "object",
                  "arguments": {}
                },
                "name": {
                  "return": "string",
                  "arguments": {}
                },
                "parent": {
                  "return": {
                    "browserTabTitle": {
                      "return": "string",
                      "arguments": {}
                    },
                    "faviconLink": {
                      "return": "string",
                      "arguments": {}
                    },
                    "id": {
                      "return": "object",
                      "arguments": {}
                    },
                    "name": {
                      "return": "string",
                      "arguments": {}
                    },
                    "parent": {
                      "return": {
                        "browserTabTitle": {
                          "return": "string",
                          "arguments": {}
                        },
                        "faviconLink": {
                          "return": "string",
                          "arguments": {}
                        },
                        "id": {
                          "return": "object",
                          "arguments": {}
                        },
                        "name": {
                          "return": "string",
                          "arguments": {}
                        },
                        "parent": {
                          "return": {
                            "browserTabTitle": {
                              "return": "string",
                              "arguments": {}
                            },
                            "faviconLink": {
                              "return": "string",
                              "arguments": {}
                            }
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    ]
  }
}

FetchRequiredFormsInput: object

accountType:
hasBeneficiaries:
isUSPerson:
Example
{
  "accountType": "string",
  "hasBeneficiaries": "boolean",
  "isUSPerson": "boolean"
}

FetchRequiredFormsResponse: object

forms:
object
return:
FormTemplate
arguments:
object
Example
{
  "forms": {
    "return": [
      {
        "digitalSignatureEnabled": {
          "return": "boolean",
          "arguments": {}
        },
        "displayName": {
          "return": "string",
          "arguments": {}
        },
        "id": {
          "return": "object",
          "arguments": {}
        },
        "minVersion": {
          "return": "number",
          "arguments": {}
        },
        "organization": {
          "return": {
            "accountTypeTaxRanks": {
              "return": [
                {
                  "accountType": {
                    "return": "string",
                    "arguments": {}
                  },
                  "id": {
                    "return": "object",
                    "arguments": {}
                  },
                  "taxRank": {
                    "return": "number",
                    "arguments": {}
                  }
                }
              ],
              "arguments": {}
            },
            "allowAccessToSubOrganizations": {
              "return": "boolean",
              "arguments": {}
            },
            "allowDirectCommunication": {
              "return": "boolean",
              "arguments": {}
            },
            "allowInactiveUserAdjustments": {
              "return": "boolean",
              "arguments": {}
            },
            "allowInactiveUserFeeCalculation": {
              "return": "boolean",
              "arguments": {}
            },
            "allowInactiveUserRebalancing": {
              "return": "boolean",
              "arguments": {}
            },
            "allowInstantInvest": {
              "return": "boolean",
              "arguments": {}
            },
            "allowPortfolioPerGoal": {
              "return": "boolean",
              "arguments": {}
            },
            "allowPostOptimizationEditing": {
              "return": "boolean",
              "arguments": {}
            },
            "allowViewSubTradeRequestPairs": {
              "return": "boolean",
              "arguments": {}
            },
            "applicableJurisdictions": {
              "return": {
                "all": {
                  "return": "boolean",
                  "arguments": {}
                },
                "only": {
                  "return": [
                    "string"
                  ],
                  "arguments": {}
                }
              },
              "arguments": {}
            },
            "applicableLocalization": {
              "return": {
                "countries": {
                  "return": [
                    "string"
                  ],
                  "arguments": {}
                },
                "dateFormat": {}
              }
            }
          }
        }
      }
    ]
  }
}

FetchRoleProfileResponse: object

roleProfile:
object
return:
arguments:
object
Example
{
  "roleProfile": {
    "return": {
      "createdAt": {
        "return": "object",
        "arguments": {}
      },
      "id": {
        "return": "object",
        "arguments": {}
      },
      "organization": {
        "return": {
          "accountTypeTaxRanks": {
            "return": [
              {
                "accountType": {
                  "return": "string",
                  "arguments": {}
                },
                "id": {
                  "return": "object",
                  "arguments": {}
                },
                "taxRank": {
                  "return": "number",
                  "arguments": {}
                }
              }
            ],
            "arguments": {}
          },
          "allowAccessToSubOrganizations": {
            "return": "boolean",
            "arguments": {}
          },
          "allowDirectCommunication": {
            "return": "boolean",
            "arguments": {}
          },
          "allowInactiveUserAdjustments": {
            "return": "boolean",
            "arguments": {}
          },
          "allowInactiveUserFeeCalculation": {
            "return": "boolean",
            "arguments": {}
          },
          "allowInactiveUserRebalancing": {
            "return": "boolean",
            "arguments": {}
          },
          "allowInstantInvest": {
            "return": "boolean",
            "arguments": {}
          },
          "allowPortfolioPerGoal": {
            "return": "boolean",
            "arguments": {}
          },
          "allowPostOptimizationEditing": {
            "return": "boolean",
            "arguments": {}
          },
          "allowViewSubTradeRequestPairs": {
            "return": "boolean",
            "arguments": {}
          },
          "applicableJurisdictions": {
            "return": {
              "all": {
                "return": "boolean",
                "arguments": {}
              },
              "only": {
                "return": [
                  "string"
                ],
                "arguments": {}
              }
            },
            "arguments": {}
          },
          "applicableLocalization": {
            "return": {
              "countries": {
                "return": [
                  "string"
                ],
                "arguments": {}
              },
              "dateFormat": {
                "return": "string",
                "arguments": {}
              },
              "defaultCurrency": {
                "return": "string",
                "arguments": {}
              },
              "defaultLanguage": {
                "return": "string"
              }
            }
          }
        }
      }
    }
  }
}

FetchRoleProfilesInput: object

filter:
pagination:
Example
{
  "filter": {
    "name": "object",
    "organizationId": "object"
  },
  "pagination": {
    "offSet": "number",
    "perPage": "number",
    "sortDesc": "boolean",
    "sortField": "string"
  }
}

FetchRoleProfilesResponse: object

roleProfiles:
object
return:
RoleProfile
arguments:
object
totalCount:
object
return:
Int
arguments:
object
Example
{
  "roleProfiles": {
    "return": [
      {
        "createdAt": {
          "return": "object",
          "arguments": {}
        },
        "id": {
          "return": "object",
          "arguments": {}
        },
        "organization": {
          "return": {
            "accountTypeTaxRanks": {
              "return": [
                {
                  "accountType": {
                    "return": "string",
                    "arguments": {}
                  },
                  "id": {
                    "return": "object",
                    "arguments": {}
                  },
                  "taxRank": {
                    "return": "number",
                    "arguments": {}
                  }
                }
              ],
              "arguments": {}
            },
            "allowAccessToSubOrganizations": {
              "return": "boolean",
              "arguments": {}
            },
            "allowDirectCommunication": {
              "return": "boolean",
              "arguments": {}
            },
            "allowInactiveUserAdjustments": {
              "return": "boolean",
              "arguments": {}
            },
            "allowInactiveUserFeeCalculation": {
              "return": "boolean",
              "arguments": {}
            },
            "allowInactiveUserRebalancing": {
              "return": "boolean",
              "arguments": {}
            },
            "allowInstantInvest": {
              "return": "boolean",
              "arguments": {}
            },
            "allowPortfolioPerGoal": {
              "return": "boolean",
              "arguments": {}
            },
            "allowPostOptimizationEditing": {
              "return": "boolean",
              "arguments": {}
            },
            "allowViewSubTradeRequestPairs": {
              "return": "boolean",
              "arguments": {}
            },
            "applicableJurisdictions": {
              "return": {
                "all": {
                  "return": "boolean",
                  "arguments": {}
                },
                "only": {
                  "return": [
                    "string"
                  ],
                  "arguments": {}
                }
              },
              "arguments": {}
            },
            "applicableLocalization": {
              "return": {
                "countries": {
                  "return": [
                    "string"
                  ],
                  "arguments": {}
                },
                "dateFormat": {
                  "return": "string",
                  "arguments": {}
                },
                "defaultCurrency": {
                  "return": "string",
                  "arguments": {}
                },
                "defaultLanguage": {}
              }
            }
          }
        }
      }
    ]
  }
}

FetchRoleResponse: object

role:
object
return:
arguments:
object
Example
{
  "role": {
    "return": {
      "accessiblePages": {
        "return": [
          "string"
        ],
        "arguments": {}
      },
      "accountPageConfiguration": {
        "return": {
          "createdAt": {
            "return": "object",
            "arguments": {}
          },
          "id": {
            "return": "object",
            "arguments": {}
          },
          "name": {
            "return": "string",
            "arguments": {}
          },
          "options": {
            "return": "object",
            "arguments": {}
          },
          "organization": {
            "return": {
              "accountTypeTaxRanks": {
                "return": [
                  {
                    "accountType": {
                      "return": "string",
                      "arguments": {}
                    },
                    "id": {
                      "return": "object",
                      "arguments": {}
                    },
                    "taxRank": {
                      "return": "number",
                      "arguments": {}
                    }
                  }
                ],
                "arguments": {}
              },
              "allowAccessToSubOrganizations": {
                "return": "boolean",
                "arguments": {}
              },
              "allowDirectCommunication": {
                "return": "boolean",
                "arguments": {}
              },
              "allowInactiveUserAdjustments": {
                "return": "boolean",
                "arguments": {}
              },
              "allowInactiveUserFeeCalculation": {
                "return": "boolean",
                "arguments": {}
              },
              "allowInactiveUserRebalancing": {
                "return": "boolean",
                "arguments": {}
              },
              "allowInstantInvest": {
                "return": "boolean",
                "arguments": {}
              },
              "allowPortfolioPerGoal": {
                "return": "boolean",
                "arguments": {}
              },
              "allowPostOptimizationEditing": {
                "return": "boolean",
                "arguments": {}
              },
              "allowViewSubTradeRequestPairs": {
                "return": "boolean",
                "arguments": {}
              },
              "applicableJurisdictions": {
                "return": {
                  "all": {
                    "return": "boolean",
                    "arguments": {}
                  },
                  "only": {
                    "return": [
                      "string"
                    ],
                    "arguments": {}
                  }
                },
                "arguments": {}
              },
              "applicableLocalization": {
                "return": {}
              }
            }
          }
        }
      }
    }
  }
}

FetchRolesInput: object

filter:
pagination:
Example
{
  "filter": {
    "authAudience": "string",
    "organizationId": "object",
    "roleProfileId": "object",
    "searchText": "string"
  },
  "pagination": {
    "offSet": "number",
    "perPage": "number",
    "sortDesc": "boolean",
    "sortField": "string"
  }
}

FetchRolesResponse: object

roles:
object
return:
Role
arguments:
object
totalCount:
object
return:
Int
arguments:
object
Example
{
  "roles": {
    "return": [
      {
        "accessiblePages": {
          "return": [
            "string"
          ],
          "arguments": {}
        },
        "accountPageConfiguration": {
          "return": {
            "createdAt": {
              "return": "object",
              "arguments": {}
            },
            "id": {
              "return": "object",
              "arguments": {}
            },
            "name": {
              "return": "string",
              "arguments": {}
            },
            "options": {
              "return": "object",
              "arguments": {}
            },
            "organization": {
              "return": {
                "accountTypeTaxRanks": {
                  "return": [
                    {
                      "accountType": {
                        "return": "string",
                        "arguments": {}
                      },
                      "id": {
                        "return": "object",
                        "arguments": {}
                      },
                      "taxRank": {
                        "return": "number",
                        "arguments": {}
                      }
                    }
                  ],
                  "arguments": {}
                },
                "allowAccessToSubOrganizations": {
                  "return": "boolean",
                  "arguments": {}
                },
                "allowDirectCommunication": {
                  "return": "boolean",
                  "arguments": {}
                },
                "allowInactiveUserAdjustments": {
                  "return": "boolean",
                  "arguments": {}
                },
                "allowInactiveUserFeeCalculation": {
                  "return": "boolean",
                  "arguments": {}
                },
                "allowInactiveUserRebalancing": {
                  "return": "boolean",
                  "arguments": {}
                },
                "allowInstantInvest": {
                  "return": "boolean",
                  "arguments": {}
                },
                "allowPortfolioPerGoal": {
                  "return": "boolean",
                  "arguments": {}
                },
                "allowPostOptimizationEditing": {
                  "return": "boolean",
                  "arguments": {}
                },
                "allowViewSubTradeRequestPairs": {
                  "return": "boolean",
                  "arguments": {}
                },
                "applicableJurisdictions": {
                  "return": {
                    "all": {
                      "return": "boolean",
                      "arguments": {}
                    },
                    "only": {
                      "return": [
                        "string"
                      ],
                      "arguments": {}
                    }
                  },
                  "arguments": {}
                },
                "applicableLocalization": {}
              }
            }
          }
        }
      }
    ]
  }
}

FetchScheduleResponse: object

schedule:
object

The Schedule.

return:
arguments:
object
Example
{
  "schedule": {
    "return": {
      "associatedFinancialProductsCount": {
        "return": "number",
        "arguments": {}
      },
      "dates": {
        "return": [
          "object"
        ],
        "arguments": {}
      },
      "id": {
        "return": "object",
        "arguments": {}
      },
      "name": {
        "return": "string",
        "arguments": {}
      },
      "nextDate": {
        "return": "object",
        "arguments": {}
      },
      "organization": {
        "return": {
          "browserTabTitle": {
            "return": "string",
            "arguments": {}
          },
          "faviconLink": {
            "return": "string",
            "arguments": {}
          },
          "id": {
            "return": "object",
            "arguments": {}
          },
          "name": {
            "return": "string",
            "arguments": {}
          },
          "parent": {
            "return": {
              "browserTabTitle": {
                "return": "string",
                "arguments": {}
              },
              "faviconLink": {
                "return": "string",
                "arguments": {}
              },
              "id": {
                "return": "object",
                "arguments": {}
              },
              "name": {
                "return": "string",
                "arguments": {}
              },
              "parent": {
                "return": {
                  "browserTabTitle": {
                    "return": "string",
                    "arguments": {}
                  },
                  "faviconLink": {
                    "return": "string",
                    "arguments": {}
                  },
                  "id": {
                    "return": "object",
                    "arguments": {}
                  },
                  "name": {
                    "return": "string",
                    "arguments": {}
                  },
                  "parent": {
                    "return": {
                      "browserTabTitle": {
                        "return": "string",
                        "arguments": {}
                      },
                      "faviconLink": {
                        "return": "string",
                        "arguments": {}
                      },
                      "id": {
                        "return": "object",
                        "arguments": {}
                      },
                      "name": {
                        "return": "string"
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

FetchScheduledTransfersInput: object

filter:
pagination:
Example
{
  "filter": {
    "accountId": "object",
    "bankAccountId": "object",
    "clientGroupId": "object",
    "createdAtAfter": "object",
    "createdAtBefore": "object",
    "frequency": "string",
    "goalId": "object",
    "organizationId": "object",
    "scheduledDate": "object",
    "scheduledDateAfter": "object",
    "scheduledDateBefore": "object",
    "state": "string",
    "states": [
      "string"
    ],
    "subAccountId": "object",
    "type": "string",
    "userId": "object",
    "userIds": [
      "object"
    ]
  },
  "pagination": {
    "offSet": "number",
    "perPage": "number",
    "sortDesc": "boolean",
    "sortField": "string"
  }
}

FetchScheduledTransfersResponse: object

scheduledTransfers:
object
return:
ScheduledTransfer
arguments:
object
totalCount:
object
return:
Int
arguments:
object
Example
{
  "scheduledTransfers": {
    "return": [
      {
        "amountCents": {
          "return": "object",
          "arguments": {}
        },
        "bankAccount": {
          "return": {
            "EftEligibleRatio": {
              "return": "number",
              "arguments": {}
            },
            "bankAccountNumber": {
              "return": "string",
              "arguments": {}
            },
            "bankAccountNumberDisclosed": {
              "return": "string",
              "arguments": {}
            },
            "createdAt": {
              "return": "object",
              "arguments": {}
            },
            "downloadUrls": {
              "return": [
                "string"
              ],
              "arguments": {}
            },
            "id": {
              "return": "object",
              "arguments": {}
            },
            "institutionNumber": {
              "return": "string",
              "arguments": {}
            },
            "name": {
              "return": "string",
              "arguments": {}
            },
            "source": {
              "return": "string",
              "arguments": {}
            },
            "state": {
              "return": "string",
              "arguments": {}
            },
            "stateChanges": {
              "return": [
                "object"
              ],
              "arguments": {}
            },
            "transitNumber": {
              "return": "string",
              "arguments": {}
            },
            "transitNumberDisclosed": {
              "return": "string",
              "arguments": {}
            },
            "updatedAt": {
              "return": "object",
              "arguments": {}
            },
            "user": {
              "return": {
                "accessibleBy": {
                  "return": [
                    {
                      "displayOptions": {
                        "return": {
                          "hide": {
                            "return": "boolean",
                            "arguments": {}
                          },
                          "order": {
                            "return": "number",
                            "arguments": {}
                          }
                        },
                        "arguments": {}
                      },
                      "organizationUser": {
                        "return": {
                          "accessType": {
                            "return": "string",
                            "arguments": {}
                          },
                          "apiTokens": {
                            "return": [
                              {}
                            ]
                          }
                        }
                      }
                    }
                  ]
                }
              }
            }
          }
        }
      }
    ]
  }
}

FetchSchedulesInput: object

filter:
pagination:
Example
{
  "filter": {
    "organizationId": "object"
  },
  "pagination": {
    "offset": "number",
    "perPage": "number",
    "sortDesc": "boolean",
    "sortField": "string"
  }
}

FetchSchedulesResponse: object

schedules:
object
return:
Schedule
arguments:
object
totalCount:
object
return:
Int
arguments:
object
Example
{
  "schedules": {
    "return": [
      {
        "associatedFinancialProductsCount": {
          "return": "number",
          "arguments": {}
        },
        "dates": {
          "return": [
            "object"
          ],
          "arguments": {}
        },
        "id": {
          "return": "object",
          "arguments": {}
        },
        "name": {
          "return": "string",
          "arguments": {}
        },
        "nextDate": {
          "return": "object",
          "arguments": {}
        },
        "organization": {
          "return": {
            "browserTabTitle": {
              "return": "string",
              "arguments": {}
            },
            "faviconLink": {
              "return": "string",
              "arguments": {}
            },
            "id": {
              "return": "object",
              "arguments": {}
            },
            "name": {
              "return": "string",
              "arguments": {}
            },
            "parent": {
              "return": {
                "browserTabTitle": {
                  "return": "string",
                  "arguments": {}
                },
                "faviconLink": {
                  "return": "string",
                  "arguments": {}
                },
                "id": {
                  "return": "object",
                  "arguments": {}
                },
                "name": {
                  "return": "string",
                  "arguments": {}
                },
                "parent": {
                  "return": {
                    "browserTabTitle": {
                      "return": "string",
                      "arguments": {}
                    },
                    "faviconLink": {
                      "return": "string",
                      "arguments": {}
                    },
                    "id": {
                      "return": "object",
                      "arguments": {}
                    },
                    "name": {
                      "return": "string",
                      "arguments": {}
                    },
                    "parent": {
                      "return": {
                        "browserTabTitle": {
                          "return": "string",
                          "arguments": {}
                        },
                        "faviconLink": {
                          "return": "string",
                          "arguments": {}
                        },
                        "id": {
                          "return": "object",
                          "arguments": {}
                        },
                        "name": {}
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    ]
  }
}

FetchStatsHistoryFilter: object

accountType:
afterDate:
beforeDate:
includeAllHouseholds:
modelPortfolioId:
userId:
Example
{
  "accountType": "string",
  "afterDate": "object",
  "beforeDate": "object",
  "includeAllHouseholds": "boolean",
  "modelPortfolioId": "object",
  "userId": "object"
}

FetchStatsHistoryInput: object

currency:
filter:
id:
pagination:
type:
Example
{
  "currency": "string",
  "filter": {
    "accountType": "string",
    "afterDate": "object",
    "beforeDate": "object",
    "includeAllHouseholds": "boolean",
    "modelPortfolioId": "object",
    "userId": "object"
  },
  "id": "object",
  "pagination": {
    "offSet": "number",
    "perPage": "number",
    "sortDesc": "boolean",
    "sortField": "string"
  },
  "type": "string"
}

FetchStatsHistoryResponse: object

snapshots:
object
return:
DailySnapshot
arguments:
object
totalCount:
object
return:
Int
arguments:
object
Example
{
  "snapshots": {
    "return": [
      {
        "cashOnHoldToTradeCents": {
          "return": "object",
          "arguments": {}
        },
        "cashOnHoldToWithdrawCents": {
          "return": "object",
          "arguments": {}
        },
        "currency": {
          "return": "string",
          "arguments": {}
        },
        "date": {
          "return": "object",
          "arguments": {}
        },
        "foreignExchangeRates": {
          "return": [
            {
              "date": {
                "return": "object",
                "arguments": {}
              },
              "from": {
                "return": "string",
                "arguments": {}
              },
              "organization": {
                "return": "object",
                "arguments": {}
              },
              "rate": {
                "return": "number",
                "arguments": {}
              },
              "to": {
                "return": "string",
                "arguments": {}
              },
              "updatedAt": {
                "return": "object",
                "arguments": {}
              }
            }
          ],
          "arguments": {}
        },
        "holdings": {
          "return": [
            {
              "adjustedCostBaseCents": {
                "return": "number",
                "arguments": {}
              },
              "currency": {
                "return": "string",
                "arguments": {}
              },
              "financialProduct": {
                "return": {
                  "assignable": {
                    "return": "boolean",
                    "arguments": {}
                  },
                  "autoUpdatePrices": {
                    "return": "boolean",
                    "arguments": {}
                  },
                  "children": {
                    "return": [
                      {
                        "financialProduct": {
                          "return": {
                            "assignable": {
                              "return": "boolean",
                              "arguments": {}
                            },
                            "autoUpdatePrices": {
                              "return": "boolean",
                              "arguments": {}
                            },
                            "children": {
                              "return": [
                                {
                                  "financialProduct": {
                                    "return": {
                                      "assignable": {
                                        "return": "boolean",
                                        "arguments": {}
                                      },
                                      "autoUpdatePrices": {}
                                    }
                                  }
                                }
                              ]
                            }
                          }
                        }
                      }
                    ]
                  }
                }
              }
            }
          ]
        }
      }
    ]
  }
}

FetchSubAccountBillingResponse: object

subAccountBilling:
object
return:
arguments:
object
Example
{
  "subAccountBilling": {
    "return": {
      "account": {
        "return": {
          "affiliations": {
            "return": [
              {
                "allocation": {
                  "return": "number",
                  "arguments": {}
                },
                "id": {
                  "return": "object",
                  "arguments": {}
                },
                "relation": {
                  "return": "string",
                  "arguments": {}
                },
                "signatureRequired": {
                  "return": "boolean",
                  "arguments": {}
                },
                "type": {
                  "return": "string",
                  "arguments": {}
                },
                "user": {
                  "return": {
                    "accessibleBy": {
                      "return": [
                        {
                          "displayOptions": {
                            "return": {
                              "hide": {
                                "return": "boolean",
                                "arguments": {}
                              },
                              "order": {
                                "return": "number",
                                "arguments": {}
                              }
                            },
                            "arguments": {}
                          },
                          "organizationUser": {
                            "return": {
                              "accessType": {
                                "return": "string",
                                "arguments": {}
                              },
                              "apiTokens": {
                                "return": [
                                  {
                                    "id": {
                                      "return": "object",
                                      "arguments": {}
                                    },
                                    "jwtToken": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "name": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "organization": {
                                      "return": {
                                        "browserTabTitle": {
                                          "return": "string",
                                          "arguments": {}
                                        },
                                        "faviconLink": {
                                          "return": "string",
                                          "arguments": {}
                                        },
                                        "id": {
                                          "return": "object",
                                          "arguments": {}
                                        },
                                        "name": {
                                          "return": "string",
                                          "arguments": {}
                                        },
                                        "parent": {
                                          "return": {
                                            "browserTabTitle": {
                                              "return": "string",
                                              "arguments": {}
                                            },
                                            "faviconLink": {}
                                          }
                                        }
                                      }
                                    }
                                  }
                                ]
                              }
                            }
                          }
                        }
                      ]
                    }
                  }
                }
              }
            ]
          }
        }
      }
    }
  }
}

FetchSubAccountBillingsInput: object

filter:
pagination:
Example
{
  "filter": {
    "accountIds": [
      "object"
    ],
    "billingCycleIds": [
      "object"
    ],
    "billingDateAfter": "object",
    "billingDateBefore": "object",
    "billingScheduleIds": [
      "object"
    ],
    "clientGroupIds": [
      "object"
    ],
    "feeTierIds": [
      "object"
    ],
    "organizationId": "object",
    "subAccountIds": [
      "object"
    ],
    "userIds": [
      "object"
    ]
  },
  "pagination": {
    "offSet": "number",
    "perPage": "number",
    "sortDesc": "boolean",
    "sortField": "string"
  }
}

FetchSubAccountBillingsResponse: object

subAccountBillings:
object
return:
SubAccountBilling
arguments:
object
totalCount:
object
return:
Int
arguments:
object
Example
{
  "subAccountBillings": {
    "return": [
      {
        "account": {
          "return": {
            "affiliations": {
              "return": [
                {
                  "allocation": {
                    "return": "number",
                    "arguments": {}
                  },
                  "id": {
                    "return": "object",
                    "arguments": {}
                  },
                  "relation": {
                    "return": "string",
                    "arguments": {}
                  },
                  "signatureRequired": {
                    "return": "boolean",
                    "arguments": {}
                  },
                  "type": {
                    "return": "string",
                    "arguments": {}
                  },
                  "user": {
                    "return": {
                      "accessibleBy": {
                        "return": [
                          {
                            "displayOptions": {
                              "return": {
                                "hide": {
                                  "return": "boolean",
                                  "arguments": {}
                                },
                                "order": {
                                  "return": "number",
                                  "arguments": {}
                                }
                              },
                              "arguments": {}
                            },
                            "organizationUser": {
                              "return": {
                                "accessType": {
                                  "return": "string",
                                  "arguments": {}
                                },
                                "apiTokens": {
                                  "return": [
                                    {
                                      "id": {
                                        "return": "object",
                                        "arguments": {}
                                      },
                                      "jwtToken": {
                                        "return": "string",
                                        "arguments": {}
                                      },
                                      "name": {
                                        "return": "string",
                                        "arguments": {}
                                      },
                                      "organization": {
                                        "return": {
                                          "browserTabTitle": {
                                            "return": "string",
                                            "arguments": {}
                                          },
                                          "faviconLink": {
                                            "return": "string",
                                            "arguments": {}
                                          },
                                          "id": {
                                            "return": "object",
                                            "arguments": {}
                                          },
                                          "name": {
                                            "return": "string",
                                            "arguments": {}
                                          },
                                          "parent": {
                                            "return": {
                                              "browserTabTitle": {
                                                "return": "string",
                                                "arguments": {}
                                              }
                                            }
                                          }
                                        }
                                      }
                                    }
                                  ]
                                }
                              }
                            }
                          }
                        ]
                      }
                    }
                  }
                }
              ]
            }
          }
        }
      }
    ]
  }
}

FetchSubAccountDailyFeeResponse: object

subAccountDailyFee:
object
return:
arguments:
object
Example
{
  "subAccountDailyFee": {
    "return": {
      "account": {
        "return": {
          "affiliations": {
            "return": [
              {
                "allocation": {
                  "return": "number",
                  "arguments": {}
                },
                "id": {
                  "return": "object",
                  "arguments": {}
                },
                "relation": {
                  "return": "string",
                  "arguments": {}
                },
                "signatureRequired": {
                  "return": "boolean",
                  "arguments": {}
                },
                "type": {
                  "return": "string",
                  "arguments": {}
                },
                "user": {
                  "return": {
                    "accessibleBy": {
                      "return": [
                        {
                          "displayOptions": {
                            "return": {
                              "hide": {
                                "return": "boolean",
                                "arguments": {}
                              },
                              "order": {
                                "return": "number",
                                "arguments": {}
                              }
                            },
                            "arguments": {}
                          },
                          "organizationUser": {
                            "return": {
                              "accessType": {
                                "return": "string",
                                "arguments": {}
                              },
                              "apiTokens": {
                                "return": [
                                  {
                                    "id": {
                                      "return": "object",
                                      "arguments": {}
                                    },
                                    "jwtToken": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "name": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "organization": {
                                      "return": {
                                        "browserTabTitle": {
                                          "return": "string",
                                          "arguments": {}
                                        },
                                        "faviconLink": {
                                          "return": "string",
                                          "arguments": {}
                                        },
                                        "id": {
                                          "return": "object",
                                          "arguments": {}
                                        },
                                        "name": {
                                          "return": "string",
                                          "arguments": {}
                                        },
                                        "parent": {
                                          "return": {
                                            "browserTabTitle": {
                                              "return": "string",
                                              "arguments": {}
                                            },
                                            "faviconLink": {}
                                          }
                                        }
                                      }
                                    }
                                  }
                                ]
                              }
                            }
                          }
                        }
                      ]
                    }
                  }
                }
              }
            ]
          }
        }
      }
    }
  }
}

FetchSubAccountDailyFeesInput: object

filter:
pagination:
Example
{
  "filter": {
    "accountIds": [
      "object"
    ],
    "billingCycleIds": [
      "object"
    ],
    "billingScheduleIds": [
      "object"
    ],
    "clientGroupIds": [
      "object"
    ],
    "dateAfter": "object",
    "dateBefore": "object",
    "feeTierIds": [
      "object"
    ],
    "organizationId": "object",
    "state": "string",
    "subAccountBillingIds": [
      "object"
    ],
    "subAccountIds": [
      "object"
    ],
    "userIds": [
      "object"
    ]
  },
  "pagination": {
    "offSet": "number",
    "perPage": "number",
    "sortDesc": "boolean",
    "sortField": "string"
  }
}

FetchSubAccountDailyFeesResponse: object

subAccountDailyFees:
object
return:
SubAccountDailyFee
arguments:
object
totalCount:
object
return:
Int
arguments:
object
Example
{
  "subAccountDailyFees": {
    "return": [
      {
        "account": {
          "return": {
            "affiliations": {
              "return": [
                {
                  "allocation": {
                    "return": "number",
                    "arguments": {}
                  },
                  "id": {
                    "return": "object",
                    "arguments": {}
                  },
                  "relation": {
                    "return": "string",
                    "arguments": {}
                  },
                  "signatureRequired": {
                    "return": "boolean",
                    "arguments": {}
                  },
                  "type": {
                    "return": "string",
                    "arguments": {}
                  },
                  "user": {
                    "return": {
                      "accessibleBy": {
                        "return": [
                          {
                            "displayOptions": {
                              "return": {
                                "hide": {
                                  "return": "boolean",
                                  "arguments": {}
                                },
                                "order": {
                                  "return": "number",
                                  "arguments": {}
                                }
                              },
                              "arguments": {}
                            },
                            "organizationUser": {
                              "return": {
                                "accessType": {
                                  "return": "string",
                                  "arguments": {}
                                },
                                "apiTokens": {
                                  "return": [
                                    {
                                      "id": {
                                        "return": "object",
                                        "arguments": {}
                                      },
                                      "jwtToken": {
                                        "return": "string",
                                        "arguments": {}
                                      },
                                      "name": {
                                        "return": "string",
                                        "arguments": {}
                                      },
                                      "organization": {
                                        "return": {
                                          "browserTabTitle": {
                                            "return": "string",
                                            "arguments": {}
                                          },
                                          "faviconLink": {
                                            "return": "string",
                                            "arguments": {}
                                          },
                                          "id": {
                                            "return": "object",
                                            "arguments": {}
                                          },
                                          "name": {
                                            "return": "string",
                                            "arguments": {}
                                          },
                                          "parent": {
                                            "return": {
                                              "browserTabTitle": {
                                                "return": "string",
                                                "arguments": {}
                                              }
                                            }
                                          }
                                        }
                                      }
                                    }
                                  ]
                                }
                              }
                            }
                          }
                        ]
                      }
                    }
                  }
                }
              ]
            }
          }
        }
      }
    ]
  }
}

FetchSubAccountResponse: object

subAccount:
object
return:
arguments:
object
Example
{
  "subAccount": {
    "return": {
      "acceptableFinancialProduct": {
        "return": "boolean",
        "arguments": {}
      },
      "account": {
        "return": {
          "affiliations": {
            "return": [
              {
                "allocation": {
                  "return": "number",
                  "arguments": {}
                },
                "id": {
                  "return": "object",
                  "arguments": {}
                },
                "relation": {
                  "return": "string",
                  "arguments": {}
                },
                "signatureRequired": {
                  "return": "boolean",
                  "arguments": {}
                },
                "type": {
                  "return": "string",
                  "arguments": {}
                },
                "user": {
                  "return": {
                    "accessibleBy": {
                      "return": [
                        {
                          "displayOptions": {
                            "return": {
                              "hide": {
                                "return": "boolean",
                                "arguments": {}
                              },
                              "order": {
                                "return": "number",
                                "arguments": {}
                              }
                            },
                            "arguments": {}
                          },
                          "organizationUser": {
                            "return": {
                              "accessType": {
                                "return": "string",
                                "arguments": {}
                              },
                              "apiTokens": {
                                "return": [
                                  {
                                    "id": {
                                      "return": "object",
                                      "arguments": {}
                                    },
                                    "jwtToken": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "name": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "organization": {
                                      "return": {
                                        "browserTabTitle": {
                                          "return": "string",
                                          "arguments": {}
                                        },
                                        "faviconLink": {
                                          "return": "string",
                                          "arguments": {}
                                        },
                                        "id": {
                                          "return": "object",
                                          "arguments": {}
                                        },
                                        "name": {
                                          "return": "string",
                                          "arguments": {}
                                        },
                                        "parent": {
                                          "return": {
                                            "browserTabTitle": {}
                                          }
                                        }
                                      }
                                    }
                                  }
                                ]
                              }
                            }
                          }
                        }
                      ]
                    }
                  }
                }
              }
            ]
          }
        }
      }
    }
  }
}

FetchSubAccountUpdatesInput: object

pagination:
subAccountId:
Example
{
  "pagination": {
    "offSet": "number",
    "perPage": "number",
    "sortDesc": "boolean"
  },
  "subAccountId": "object"
}

FetchSubAccountUpdatesResponse: object

subAccountUpdates:
object
return:
SubAccountUpdate
arguments:
object
totalCount:
object
return:
Int
arguments:
object
Example
{
  "subAccountUpdates": {
    "return": [
      {
        "d": {
          "return": "string",
          "arguments": {}
        },
        "id": {
          "return": "object",
          "arguments": {}
        },
        "o": {
          "return": "string",
          "arguments": {}
        },
        "t": {
          "return": "object",
          "arguments": {}
        }
      }
    ],
    "arguments": {}
  },
  "totalCount": {
    "return": "number",
    "arguments": {}
  }
}

FetchSubAccountsInput: object

filter:
pagination:
Example
{
  "filter": {
    "accountId": "object",
    "accountType": "string",
    "clientGroupId": "object",
    "completedAtAfter": "object",
    "completedAtBefore": "object",
    "complianceState": "string",
    "financialProductId": "string",
    "goalId": "object",
    "iDCheckCompleted": "boolean",
    "iDVerified": "boolean",
    "includeHousehold": "boolean",
    "isComplete": "boolean",
    "organizationId": "object",
    "state": "string",
    "userId": "object"
  },
  "pagination": {
    "offSet": "number",
    "perPage": "number",
    "sortDesc": "boolean",
    "sortField": "string"
  }
}

FetchSubAccountsResponse: object

subAccounts:
object
return:
SubAccount
arguments:
object
totalCount:
object
return:
Int
arguments:
object
Example
{
  "subAccounts": {
    "return": [
      {
        "acceptableFinancialProduct": {
          "return": "boolean",
          "arguments": {}
        },
        "account": {
          "return": {
            "affiliations": {
              "return": [
                {
                  "allocation": {
                    "return": "number",
                    "arguments": {}
                  },
                  "id": {
                    "return": "object",
                    "arguments": {}
                  },
                  "relation": {
                    "return": "string",
                    "arguments": {}
                  },
                  "signatureRequired": {
                    "return": "boolean",
                    "arguments": {}
                  },
                  "type": {
                    "return": "string",
                    "arguments": {}
                  },
                  "user": {
                    "return": {
                      "accessibleBy": {
                        "return": [
                          {
                            "displayOptions": {
                              "return": {
                                "hide": {
                                  "return": "boolean",
                                  "arguments": {}
                                },
                                "order": {
                                  "return": "number",
                                  "arguments": {}
                                }
                              },
                              "arguments": {}
                            },
                            "organizationUser": {
                              "return": {
                                "accessType": {
                                  "return": "string",
                                  "arguments": {}
                                },
                                "apiTokens": {
                                  "return": [
                                    {
                                      "id": {
                                        "return": "object",
                                        "arguments": {}
                                      },
                                      "jwtToken": {
                                        "return": "string",
                                        "arguments": {}
                                      },
                                      "name": {
                                        "return": "string",
                                        "arguments": {}
                                      },
                                      "organization": {
                                        "return": {
                                          "browserTabTitle": {
                                            "return": "string",
                                            "arguments": {}
                                          },
                                          "faviconLink": {
                                            "return": "string",
                                            "arguments": {}
                                          },
                                          "id": {
                                            "return": "object",
                                            "arguments": {}
                                          },
                                          "name": {
                                            "return": "string",
                                            "arguments": {}
                                          },
                                          "parent": {
                                            "return": {}
                                          }
                                        }
                                      }
                                    }
                                  ]
                                }
                              }
                            }
                          }
                        ]
                      }
                    }
                  }
                }
              ]
            }
          }
        }
      }
    ]
  }
}

FetchSubStepOptionsResponse: object

subStepOptions:
object
return:
SubStepOption
arguments:
object
Example
{
  "subStepOptions": {
    "return": [
      {
        "default": {
          "return": "object",
          "arguments": {}
        },
        "key": {
          "return": "string",
          "arguments": {}
        },
        "label": {
          "return": {
            "en": {
              "return": "string",
              "arguments": {}
            },
            "fr": {
              "return": "string",
              "arguments": {}
            }
          },
          "arguments": {}
        },
        "optionType": {
          "return": "string",
          "arguments": {}
        },
        "options": {
          "return": "object",
          "arguments": {}
        },
        "showIf": {
          "return": "object",
          "arguments": {}
        }
      }
    ],
    "arguments": {}
  }
}

FetchSubTradeRequestResponse: object

subTradeRequest:
object
return:
arguments:
object
Example
{
  "subTradeRequest": {
    "return": {
      "account": {
        "return": {
          "affiliations": {
            "return": [
              {
                "allocation": {
                  "return": "number",
                  "arguments": {}
                },
                "id": {
                  "return": "object",
                  "arguments": {}
                },
                "relation": {
                  "return": "string",
                  "arguments": {}
                },
                "signatureRequired": {
                  "return": "boolean",
                  "arguments": {}
                },
                "type": {
                  "return": "string",
                  "arguments": {}
                },
                "user": {
                  "return": {
                    "accessibleBy": {
                      "return": [
                        {
                          "displayOptions": {
                            "return": {
                              "hide": {
                                "return": "boolean",
                                "arguments": {}
                              },
                              "order": {
                                "return": "number",
                                "arguments": {}
                              }
                            },
                            "arguments": {}
                          },
                          "organizationUser": {
                            "return": {
                              "accessType": {
                                "return": "string",
                                "arguments": {}
                              },
                              "apiTokens": {
                                "return": [
                                  {
                                    "id": {
                                      "return": "object",
                                      "arguments": {}
                                    },
                                    "jwtToken": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "name": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "organization": {
                                      "return": {
                                        "browserTabTitle": {
                                          "return": "string",
                                          "arguments": {}
                                        },
                                        "faviconLink": {
                                          "return": "string",
                                          "arguments": {}
                                        },
                                        "id": {
                                          "return": "object",
                                          "arguments": {}
                                        },
                                        "name": {
                                          "return": "string",
                                          "arguments": {}
                                        },
                                        "parent": {
                                          "return": {
                                            "browserTabTitle": {
                                              "return": "string",
                                              "arguments": {}
                                            },
                                            "faviconLink": {}
                                          }
                                        }
                                      }
                                    }
                                  }
                                ]
                              }
                            }
                          }
                        }
                      ]
                    }
                  }
                }
              }
            ]
          }
        }
      }
    }
  }
}

FetchSubTradeRequestsInput: object

filter:
pagination:
Example
{
  "filter": {
    "bulkTradeRequestId": "object",
    "financialProductId": "object",
    "showSplits": "boolean",
    "sourceId": "object",
    "state": "string",
    "subAccountId": "object",
    "type": "string"
  },
  "pagination": {
    "offSet": "number",
    "perPage": "number",
    "sortDesc": "boolean",
    "sortField": "string"
  }
}

FetchSubTradeRequestsResponse: object

subTradeRequests:
object
return:
SubTradeRequest
arguments:
object
totalCount:
object
return:
Int
arguments:
object
Example
{
  "subTradeRequests": {
    "return": [
      {
        "account": {
          "return": {
            "affiliations": {
              "return": [
                {
                  "allocation": {
                    "return": "number",
                    "arguments": {}
                  },
                  "id": {
                    "return": "object",
                    "arguments": {}
                  },
                  "relation": {
                    "return": "string",
                    "arguments": {}
                  },
                  "signatureRequired": {
                    "return": "boolean",
                    "arguments": {}
                  },
                  "type": {
                    "return": "string",
                    "arguments": {}
                  },
                  "user": {
                    "return": {
                      "accessibleBy": {
                        "return": [
                          {
                            "displayOptions": {
                              "return": {
                                "hide": {
                                  "return": "boolean",
                                  "arguments": {}
                                },
                                "order": {
                                  "return": "number",
                                  "arguments": {}
                                }
                              },
                              "arguments": {}
                            },
                            "organizationUser": {
                              "return": {
                                "accessType": {
                                  "return": "string",
                                  "arguments": {}
                                },
                                "apiTokens": {
                                  "return": [
                                    {
                                      "id": {
                                        "return": "object",
                                        "arguments": {}
                                      },
                                      "jwtToken": {
                                        "return": "string",
                                        "arguments": {}
                                      },
                                      "name": {
                                        "return": "string",
                                        "arguments": {}
                                      },
                                      "organization": {
                                        "return": {
                                          "browserTabTitle": {
                                            "return": "string",
                                            "arguments": {}
                                          },
                                          "faviconLink": {
                                            "return": "string",
                                            "arguments": {}
                                          },
                                          "id": {
                                            "return": "object",
                                            "arguments": {}
                                          },
                                          "name": {
                                            "return": "string",
                                            "arguments": {}
                                          },
                                          "parent": {
                                            "return": {
                                              "browserTabTitle": {
                                                "return": "string",
                                                "arguments": {}
                                              }
                                            }
                                          }
                                        }
                                      }
                                    }
                                  ]
                                }
                              }
                            }
                          }
                        ]
                      }
                    }
                  }
                }
              ]
            }
          }
        }
      }
    ]
  }
}

FetchSubTradesInput: object

filter:
pagination:
Example
{
  "filter": {
    "clientGroupId": "object",
    "createdAtAfter": "object",
    "createdAtBefore": "object",
    "financialProductId": "object",
    "goalId": "object",
    "organizationId": "object",
    "rebalanceId": "object",
    "subAccountId": "object",
    "subTradeState": "string",
    "tradeId": "object",
    "userId": "object"
  },
  "pagination": {
    "offSet": "number",
    "perPage": "number",
    "sortDesc": "boolean",
    "sortField": "string"
  }
}

FetchSubTradesResponse: object

subTrades:
object
return:
SubTrade
arguments:
object
totalCount:
object
return:
Int
arguments:
object
Example
{
  "subTrades": {
    "return": [
      {
        "actualQuantity": {
          "return": "number",
          "arguments": {}
        },
        "actualTradePriceCents": {
          "return": "number",
          "arguments": {}
        },
        "createdAt": {
          "return": "object",
          "arguments": {}
        },
        "expectedQuantity": {
          "return": "number",
          "arguments": {}
        },
        "expectedTradePriceCents": {
          "return": "number",
          "arguments": {}
        },
        "failReason": {
          "return": "string",
          "arguments": {}
        },
        "financialProduct": {
          "return": {
            "assignable": {
              "return": "boolean",
              "arguments": {}
            },
            "autoUpdatePrices": {
              "return": "boolean",
              "arguments": {}
            },
            "children": {
              "return": [
                {
                  "financialProduct": {
                    "return": {
                      "assignable": {
                        "return": "boolean",
                        "arguments": {}
                      },
                      "autoUpdatePrices": {
                        "return": "boolean",
                        "arguments": {}
                      },
                      "children": {
                        "return": [
                          {
                            "financialProduct": {
                              "return": {
                                "assignable": {
                                  "return": "boolean",
                                  "arguments": {}
                                },
                                "autoUpdatePrices": {
                                  "return": "boolean",
                                  "arguments": {}
                                },
                                "children": {
                                  "return": [
                                    {
                                      "financialProduct": {
                                        "return": {
                                          "assignable": {
                                            "return": "boolean",
                                            "arguments": {}
                                          },
                                          "autoUpdatePrices": {
                                            "return": "boolean",
                                            "arguments": {}
                                          },
                                          "children": {
                                            "return": [
                                              {
                                                "financialProduct": {
                                                  "return": {
                                                    "assignable": {
                                                      "return": "boolean",
                                                      "arguments": {}
                                                    },
                                                    "autoUpdatePrices": {
                                                      "return": "boolean",
                                                      "arguments": {}
                                                    }
                                                  }
                                                }
                                              }
                                            ]
                                          }
                                        }
                                      }
                                    }
                                  ]
                                }
                              }
                            }
                          }
                        ]
                      }
                    }
                  }
                }
              ]
            }
          }
        }
      }
    ]
  }
}

FetchTLHAnalysesInput: object

organizationId:
pagination:
Example
{
  "organizationId": "object",
  "pagination": {
    "offSet": "number",
    "perPage": "number",
    "sortDesc": "boolean",
    "sortField": "string"
  }
}

FetchTLHAnalysesResponse: object

analyses:
object
return:
TLHAnalysisJob
arguments:
object
totalCount:
object
return:
Int
arguments:
object
Example
{
  "analyses": {
    "return": [
      {
        "createdAt": {
          "return": "object",
          "arguments": {}
        },
        "id": {
          "return": "object",
          "arguments": {}
        },
        "numEvents": {
          "return": "number",
          "arguments": {}
        },
        "organization": {
          "return": {
            "browserTabTitle": {
              "return": "string",
              "arguments": {}
            },
            "faviconLink": {
              "return": "string",
              "arguments": {}
            },
            "id": {
              "return": "object",
              "arguments": {}
            },
            "name": {
              "return": "string",
              "arguments": {}
            },
            "parent": {
              "return": {
                "browserTabTitle": {
                  "return": "string",
                  "arguments": {}
                },
                "faviconLink": {
                  "return": "string",
                  "arguments": {}
                },
                "id": {
                  "return": "object",
                  "arguments": {}
                },
                "name": {
                  "return": "string",
                  "arguments": {}
                },
                "parent": {
                  "return": {
                    "browserTabTitle": {
                      "return": "string",
                      "arguments": {}
                    },
                    "faviconLink": {
                      "return": "string",
                      "arguments": {}
                    },
                    "id": {
                      "return": "object",
                      "arguments": {}
                    },
                    "name": {
                      "return": "string",
                      "arguments": {}
                    },
                    "parent": {
                      "return": {
                        "browserTabTitle": {
                          "return": "string",
                          "arguments": {}
                        },
                        "faviconLink": {
                          "return": "string",
                          "arguments": {}
                        },
                        "id": {
                          "return": "object",
                          "arguments": {}
                        },
                        "name": {
                          "return": "string",
                          "arguments": {}
                        },
                        "parent": {
                          "return": {
                            "browserTabTitle": {
                              "return": "string",
                              "arguments": {}
                            }
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    ]
  }
}

FetchTLHEventsFilter: object

organizationId:
tlhJob:
Example
{
  "organizationId": "object",
  "tlhJob": "object"
}

FetchTLHEventsInput: object

filter:
pagination:
Example
{
  "filter": {
    "organizationId": "object",
    "tlhJob": "object"
  },
  "pagination": {
    "offSet": "number",
    "perPage": "number",
    "sortDesc": "boolean",
    "sortField": "string"
  }
}

FetchTLHEventsResponse: object

events:
object
return:
TLHEvent
arguments:
object
totalCount:
object
return:
Int
arguments:
object
Example
{
  "events": {
    "return": [
      {
        "account": {
          "return": {
            "affiliations": {
              "return": [
                {
                  "allocation": {
                    "return": "number",
                    "arguments": {}
                  },
                  "id": {
                    "return": "object",
                    "arguments": {}
                  },
                  "relation": {
                    "return": "string",
                    "arguments": {}
                  },
                  "signatureRequired": {
                    "return": "boolean",
                    "arguments": {}
                  },
                  "type": {
                    "return": "string",
                    "arguments": {}
                  },
                  "user": {
                    "return": {
                      "accessibleBy": {
                        "return": [
                          {
                            "displayOptions": {
                              "return": {
                                "hide": {
                                  "return": "boolean",
                                  "arguments": {}
                                },
                                "order": {
                                  "return": "number",
                                  "arguments": {}
                                }
                              },
                              "arguments": {}
                            },
                            "organizationUser": {
                              "return": {
                                "accessType": {
                                  "return": "string",
                                  "arguments": {}
                                },
                                "apiTokens": {
                                  "return": [
                                    {
                                      "id": {
                                        "return": "object",
                                        "arguments": {}
                                      },
                                      "jwtToken": {
                                        "return": "string",
                                        "arguments": {}
                                      },
                                      "name": {
                                        "return": "string",
                                        "arguments": {}
                                      },
                                      "organization": {
                                        "return": {
                                          "browserTabTitle": {
                                            "return": "string",
                                            "arguments": {}
                                          },
                                          "faviconLink": {
                                            "return": "string",
                                            "arguments": {}
                                          },
                                          "id": {
                                            "return": "object",
                                            "arguments": {}
                                          },
                                          "name": {
                                            "return": "string",
                                            "arguments": {}
                                          },
                                          "parent": {
                                            "return": {
                                              "browserTabTitle": {
                                                "return": "string",
                                                "arguments": {}
                                              }
                                            }
                                          }
                                        }
                                      }
                                    }
                                  ]
                                }
                              }
                            }
                          }
                        ]
                      }
                    }
                  }
                }
              ]
            }
          }
        }
      }
    ]
  }
}

FetchThemeResponse: object

theme:
object
return:
arguments:
object
Example
{
  "theme": {
    "return": {
      "core": {
        "return": "boolean",
        "arguments": {}
      },
      "description": {
        "return": "string",
        "arguments": {}
      },
      "iconKey": {
        "return": "string",
        "arguments": {}
      },
      "id": {
        "return": "object",
        "arguments": {}
      },
      "key": {
        "return": "string",
        "arguments": {}
      },
      "logs": {
        "return": {
          "logs": {
            "return": [
              {
                "account": {
                  "return": {
                    "affiliations": {
                      "return": [
                        {
                          "allocation": {
                            "return": "number",
                            "arguments": {}
                          },
                          "id": {
                            "return": "object",
                            "arguments": {}
                          },
                          "relation": {
                            "return": "string",
                            "arguments": {}
                          },
                          "signatureRequired": {
                            "return": "boolean",
                            "arguments": {}
                          },
                          "type": {
                            "return": "string",
                            "arguments": {}
                          },
                          "user": {
                            "return": {
                              "accessibleBy": {
                                "return": [
                                  {
                                    "displayOptions": {
                                      "return": {
                                        "hide": {
                                          "return": "boolean",
                                          "arguments": {}
                                        },
                                        "order": {
                                          "return": "number",
                                          "arguments": {}
                                        }
                                      },
                                      "arguments": {}
                                    },
                                    "organizationUser": {
                                      "return": {
                                        "accessType": {
                                          "return": "string",
                                          "arguments": {}
                                        },
                                        "apiTokens": {
                                          "return": [
                                            {
                                              "id": {
                                                "return": "object",
                                                "arguments": {}
                                              },
                                              "jwtToken": {
                                                "return": "string",
                                                "arguments": {}
                                              },
                                              "name": {
                                                "return": "string",
                                                "arguments": {}
                                              }
                                            }
                                          ]
                                        }
                                      }
                                    }
                                  }
                                ]
                              }
                            }
                          }
                        }
                      ]
                    }
                  }
                }
              }
            ]
          }
        }
      }
    }
  }
}

FetchThemesInput: object

filter:
pagination:
Example
{
  "filter": {
    "core": "boolean",
    "keys": [
      "object"
    ],
    "organizationId": "object"
  },
  "pagination": {
    "offset": "number",
    "perPage": "number",
    "sortDesc": "boolean",
    "sortField": "string"
  }
}

FetchThemesResponse: object

themes:
object
return:
Theme
arguments:
object
totalCount:
object
return:
Int
arguments:
object
Example
{
  "themes": {
    "return": [
      {
        "core": {
          "return": "boolean",
          "arguments": {}
        },
        "description": {
          "return": "string",
          "arguments": {}
        },
        "iconKey": {
          "return": "string",
          "arguments": {}
        },
        "id": {
          "return": "object",
          "arguments": {}
        },
        "key": {
          "return": "string",
          "arguments": {}
        },
        "logs": {
          "return": {
            "logs": {
              "return": [
                {
                  "account": {
                    "return": {
                      "affiliations": {
                        "return": [
                          {
                            "allocation": {
                              "return": "number",
                              "arguments": {}
                            },
                            "id": {
                              "return": "object",
                              "arguments": {}
                            },
                            "relation": {
                              "return": "string",
                              "arguments": {}
                            },
                            "signatureRequired": {
                              "return": "boolean",
                              "arguments": {}
                            },
                            "type": {
                              "return": "string",
                              "arguments": {}
                            },
                            "user": {
                              "return": {
                                "accessibleBy": {
                                  "return": [
                                    {
                                      "displayOptions": {
                                        "return": {
                                          "hide": {
                                            "return": "boolean",
                                            "arguments": {}
                                          },
                                          "order": {
                                            "return": "number",
                                            "arguments": {}
                                          }
                                        },
                                        "arguments": {}
                                      },
                                      "organizationUser": {
                                        "return": {
                                          "accessType": {
                                            "return": "string",
                                            "arguments": {}
                                          },
                                          "apiTokens": {
                                            "return": [
                                              {
                                                "id": {
                                                  "return": "object",
                                                  "arguments": {}
                                                },
                                                "jwtToken": {
                                                  "return": "string",
                                                  "arguments": {}
                                                },
                                                "name": {
                                                  "return": "string"
                                                }
                                              }
                                            ]
                                          }
                                        }
                                      }
                                    }
                                  ]
                                }
                              }
                            }
                          }
                        ]
                      }
                    }
                  }
                }
              ]
            }
          }
        }
      }
    ]
  }
}

FetchTradeRequestResponse: object

tradeRequest:
object
return:
arguments:
object
Example
{
  "tradeRequest": {
    "return": {
      "account": {
        "return": {
          "affiliations": {
            "return": [
              {
                "allocation": {
                  "return": "number",
                  "arguments": {}
                },
                "id": {
                  "return": "object",
                  "arguments": {}
                },
                "relation": {
                  "return": "string",
                  "arguments": {}
                },
                "signatureRequired": {
                  "return": "boolean",
                  "arguments": {}
                },
                "type": {
                  "return": "string",
                  "arguments": {}
                },
                "user": {
                  "return": {
                    "accessibleBy": {
                      "return": [
                        {
                          "displayOptions": {
                            "return": {
                              "hide": {
                                "return": "boolean",
                                "arguments": {}
                              },
                              "order": {
                                "return": "number",
                                "arguments": {}
                              }
                            },
                            "arguments": {}
                          },
                          "organizationUser": {
                            "return": {
                              "accessType": {
                                "return": "string",
                                "arguments": {}
                              },
                              "apiTokens": {
                                "return": [
                                  {
                                    "id": {
                                      "return": "object",
                                      "arguments": {}
                                    },
                                    "jwtToken": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "name": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "organization": {
                                      "return": {
                                        "browserTabTitle": {
                                          "return": "string",
                                          "arguments": {}
                                        },
                                        "faviconLink": {
                                          "return": "string",
                                          "arguments": {}
                                        },
                                        "id": {
                                          "return": "object",
                                          "arguments": {}
                                        },
                                        "name": {
                                          "return": "string",
                                          "arguments": {}
                                        },
                                        "parent": {
                                          "return": {
                                            "browserTabTitle": {
                                              "return": "string",
                                              "arguments": {}
                                            },
                                            "faviconLink": {}
                                          }
                                        }
                                      }
                                    }
                                  }
                                ]
                              }
                            }
                          }
                        }
                      ]
                    }
                  }
                }
              }
            ]
          }
        }
      }
    }
  }
}

FetchTradeRequestsInput: object

filter:
pagination:
Example
{
  "filter": {
    "accountId": "object",
    "bulkTradeRunId": "object",
    "financialProductId": "object",
    "state": "string",
    "type": "string"
  },
  "pagination": {
    "offSet": "number",
    "perPage": "number",
    "sortDesc": "boolean",
    "sortField": "string"
  }
}

FetchTradeRequestsResponse: object

totalCount:
object
return:
Int
arguments:
object
tradeRequests:
object
return:
TradeRequest
arguments:
object
Example
{
  "totalCount": {
    "return": "number",
    "arguments": {}
  },
  "tradeRequests": {
    "return": [
      {
        "account": {
          "return": {
            "affiliations": {
              "return": [
                {
                  "allocation": {
                    "return": "number",
                    "arguments": {}
                  },
                  "id": {
                    "return": "object",
                    "arguments": {}
                  },
                  "relation": {
                    "return": "string",
                    "arguments": {}
                  },
                  "signatureRequired": {
                    "return": "boolean",
                    "arguments": {}
                  },
                  "type": {
                    "return": "string",
                    "arguments": {}
                  },
                  "user": {
                    "return": {
                      "accessibleBy": {
                        "return": [
                          {
                            "displayOptions": {
                              "return": {
                                "hide": {
                                  "return": "boolean",
                                  "arguments": {}
                                },
                                "order": {
                                  "return": "number",
                                  "arguments": {}
                                }
                              },
                              "arguments": {}
                            },
                            "organizationUser": {
                              "return": {
                                "accessType": {
                                  "return": "string",
                                  "arguments": {}
                                },
                                "apiTokens": {
                                  "return": [
                                    {
                                      "id": {
                                        "return": "object",
                                        "arguments": {}
                                      },
                                      "jwtToken": {
                                        "return": "string",
                                        "arguments": {}
                                      },
                                      "name": {
                                        "return": "string",
                                        "arguments": {}
                                      },
                                      "organization": {
                                        "return": {
                                          "browserTabTitle": {
                                            "return": "string",
                                            "arguments": {}
                                          },
                                          "faviconLink": {
                                            "return": "string",
                                            "arguments": {}
                                          },
                                          "id": {
                                            "return": "object",
                                            "arguments": {}
                                          },
                                          "name": {
                                            "return": "string",
                                            "arguments": {}
                                          },
                                          "parent": {
                                            "return": {}
                                          }
                                        }
                                      }
                                    }
                                  ]
                                }
                              }
                            }
                          }
                        ]
                      }
                    }
                  }
                }
              ]
            }
          }
        }
      }
    ]
  }
}

FetchTradesInput: object

filter:
pagination:
Example
{
  "filter": {
    "accountId": "object",
    "clientGroupId": "object",
    "createdAtAfter": "object",
    "createdAtBefore": "object",
    "financialProductId": "object",
    "organizationId": "object",
    "rebalanceId": "object",
    "tradeState": "string",
    "userId": "object",
    "userIds": [
      "object"
    ]
  },
  "pagination": {
    "offSet": "number",
    "perPage": "number",
    "sortDesc": "boolean",
    "sortField": "string"
  }
}

FetchTradesResponse: object

totalCount:
object
return:
Int
arguments:
object
trades:
object
return:
Trade
arguments:
object
Example
{
  "totalCount": {
    "return": "number",
    "arguments": {}
  },
  "trades": {
    "return": [
      {
        "account": {
          "return": {
            "affiliations": {
              "return": [
                {
                  "allocation": {
                    "return": "number",
                    "arguments": {}
                  },
                  "id": {
                    "return": "object",
                    "arguments": {}
                  },
                  "relation": {
                    "return": "string",
                    "arguments": {}
                  },
                  "signatureRequired": {
                    "return": "boolean",
                    "arguments": {}
                  },
                  "type": {
                    "return": "string",
                    "arguments": {}
                  },
                  "user": {
                    "return": {
                      "accessibleBy": {
                        "return": [
                          {
                            "displayOptions": {
                              "return": {
                                "hide": {
                                  "return": "boolean",
                                  "arguments": {}
                                },
                                "order": {
                                  "return": "number",
                                  "arguments": {}
                                }
                              },
                              "arguments": {}
                            },
                            "organizationUser": {
                              "return": {
                                "accessType": {
                                  "return": "string",
                                  "arguments": {}
                                },
                                "apiTokens": {
                                  "return": [
                                    {
                                      "id": {
                                        "return": "object",
                                        "arguments": {}
                                      },
                                      "jwtToken": {
                                        "return": "string",
                                        "arguments": {}
                                      },
                                      "name": {
                                        "return": "string",
                                        "arguments": {}
                                      },
                                      "organization": {
                                        "return": {
                                          "browserTabTitle": {
                                            "return": "string",
                                            "arguments": {}
                                          },
                                          "faviconLink": {
                                            "return": "string",
                                            "arguments": {}
                                          },
                                          "id": {
                                            "return": "object",
                                            "arguments": {}
                                          },
                                          "name": {
                                            "return": "string",
                                            "arguments": {}
                                          },
                                          "parent": {
                                            "return": {}
                                          }
                                        }
                                      }
                                    }
                                  ]
                                }
                              }
                            }
                          }
                        ]
                      }
                    }
                  }
                }
              ]
            }
          }
        }
      }
    ]
  }
}

FetchTransactionResponse: object

transaction:
object
return:
arguments:
object
Example
{
  "transaction": {
    "return": {
      "account": {
        "return": {
          "affiliations": {
            "return": [
              {
                "allocation": {
                  "return": "number",
                  "arguments": {}
                },
                "id": {
                  "return": "object",
                  "arguments": {}
                },
                "relation": {
                  "return": "string",
                  "arguments": {}
                },
                "signatureRequired": {
                  "return": "boolean",
                  "arguments": {}
                },
                "type": {
                  "return": "string",
                  "arguments": {}
                },
                "user": {
                  "return": {
                    "accessibleBy": {
                      "return": [
                        {
                          "displayOptions": {
                            "return": {
                              "hide": {
                                "return": "boolean",
                                "arguments": {}
                              },
                              "order": {
                                "return": "number",
                                "arguments": {}
                              }
                            },
                            "arguments": {}
                          },
                          "organizationUser": {
                            "return": {
                              "accessType": {
                                "return": "string",
                                "arguments": {}
                              },
                              "apiTokens": {
                                "return": [
                                  {
                                    "id": {
                                      "return": "object",
                                      "arguments": {}
                                    },
                                    "jwtToken": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "name": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "organization": {
                                      "return": {
                                        "browserTabTitle": {
                                          "return": "string",
                                          "arguments": {}
                                        },
                                        "faviconLink": {
                                          "return": "string",
                                          "arguments": {}
                                        },
                                        "id": {
                                          "return": "object",
                                          "arguments": {}
                                        },
                                        "name": {
                                          "return": "string",
                                          "arguments": {}
                                        },
                                        "parent": {
                                          "return": {
                                            "browserTabTitle": {
                                              "return": "string",
                                              "arguments": {}
                                            },
                                            "faviconLink": {}
                                          }
                                        }
                                      }
                                    }
                                  }
                                ]
                              }
                            }
                          }
                        }
                      ]
                    }
                  }
                }
              }
            ]
          }
        }
      }
    }
  }
}

FetchTransactionsInput: object

filter:
pagination:
Example
{
  "filter": {
    "accountIds": [
      "object"
    ],
    "accountType": "string",
    "clientGroupId": "object",
    "currency": "string",
    "dateAfter": "object",
    "dateBefore": "object",
    "financialProductIds": [
      "object"
    ],
    "goalIds": [
      "object"
    ],
    "organizationId": "object",
    "subAccountIds": [
      "object"
    ],
    "types": [
      "string"
    ],
    "userId": "object",
    "userIds": [
      "object"
    ]
  },
  "pagination": {
    "offSet": "number",
    "perPage": "number",
    "sortDesc": "boolean",
    "sortField": "string"
  }
}

FetchTransactionsResponse: object

totalCount:
object
return:
Int
arguments:
object
transactions:
object
return:
Transaction
arguments:
object
Example
{
  "totalCount": {
    "return": "number",
    "arguments": {}
  },
  "transactions": {
    "return": [
      {
        "account": {
          "return": {
            "affiliations": {
              "return": [
                {
                  "allocation": {
                    "return": "number",
                    "arguments": {}
                  },
                  "id": {
                    "return": "object",
                    "arguments": {}
                  },
                  "relation": {
                    "return": "string",
                    "arguments": {}
                  },
                  "signatureRequired": {
                    "return": "boolean",
                    "arguments": {}
                  },
                  "type": {
                    "return": "string",
                    "arguments": {}
                  },
                  "user": {
                    "return": {
                      "accessibleBy": {
                        "return": [
                          {
                            "displayOptions": {
                              "return": {
                                "hide": {
                                  "return": "boolean",
                                  "arguments": {}
                                },
                                "order": {
                                  "return": "number",
                                  "arguments": {}
                                }
                              },
                              "arguments": {}
                            },
                            "organizationUser": {
                              "return": {
                                "accessType": {
                                  "return": "string",
                                  "arguments": {}
                                },
                                "apiTokens": {
                                  "return": [
                                    {
                                      "id": {
                                        "return": "object",
                                        "arguments": {}
                                      },
                                      "jwtToken": {
                                        "return": "string",
                                        "arguments": {}
                                      },
                                      "name": {
                                        "return": "string",
                                        "arguments": {}
                                      },
                                      "organization": {
                                        "return": {
                                          "browserTabTitle": {
                                            "return": "string",
                                            "arguments": {}
                                          },
                                          "faviconLink": {
                                            "return": "string",
                                            "arguments": {}
                                          },
                                          "id": {
                                            "return": "object",
                                            "arguments": {}
                                          },
                                          "name": {
                                            "return": "string",
                                            "arguments": {}
                                          },
                                          "parent": {
                                            "return": {}
                                          }
                                        }
                                      }
                                    }
                                  ]
                                }
                              }
                            }
                          }
                        ]
                      }
                    }
                  }
                }
              ]
            }
          }
        }
      }
    ]
  }
}

FetchTransferResponse: object

transfer:
object
return:
arguments:
object
Example
{
  "transfer": {
    "return": {
      "alertReport": {
        "return": {
          "id": {
            "return": "object",
            "arguments": {}
          },
          "reason": {
            "return": "string",
            "arguments": {}
          },
          "rules": {
            "return": [
              {
                "id": {
                  "return": "object",
                  "arguments": {}
                },
                "translatedDescription": {
                  "return": {
                    "en": {
                      "return": "string",
                      "arguments": {}
                    },
                    "fr": {
                      "return": "string",
                      "arguments": {}
                    }
                  },
                  "arguments": {}
                },
                "type": {
                  "return": "string",
                  "arguments": {}
                }
              }
            ],
            "arguments": {}
          },
          "state": {
            "return": "string",
            "arguments": {}
          },
          "transfer": {
            "return": {
              "alertReport": {
                "return": {
                  "id": {
                    "return": "object",
                    "arguments": {}
                  },
                  "reason": {
                    "return": "string",
                    "arguments": {}
                  },
                  "rules": {
                    "return": [
                      {
                        "id": {
                          "return": "object",
                          "arguments": {}
                        },
                        "translatedDescription": {
                          "return": {
                            "en": {
                              "return": "string",
                              "arguments": {}
                            },
                            "fr": {
                              "return": "string",
                              "arguments": {}
                            }
                          },
                          "arguments": {}
                        },
                        "type": {
                          "return": "string",
                          "arguments": {}
                        }
                      }
                    ],
                    "arguments": {}
                  },
                  "state": {
                    "return": "string",
                    "arguments": {}
                  },
                  "transfer": {
                    "return": {
                      "alertReport": {
                        "return": {
                          "id": {
                            "return": "object",
                            "arguments": {}
                          },
                          "reason": {
                            "return": "string"
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

FetchTransfersInput: object

filter:
pagination:
Example
{
  "filter": {
    "accountId": "object",
    "accountType": "string",
    "clientGroupId": "object",
    "createdAtAfter": "object",
    "createdAtBefore": "object",
    "goalId": "object",
    "initiatedByRepresentative": "boolean",
    "organizationId": "object",
    "source": "string",
    "state": "string",
    "subAccountId": "object",
    "type": "string",
    "userId": "object",
    "userIds": [
      "object"
    ]
  },
  "pagination": {
    "offSet": "number",
    "perPage": "number",
    "sortDesc": "boolean",
    "sortField": "string"
  }
}

FetchTransfersResponse: object

totalCount:
object
return:
Int
arguments:
object
transfers:
object
return:
Transfer
arguments:
object
Example
{
  "totalCount": {
    "return": "number",
    "arguments": {}
  },
  "transfers": {
    "return": [
      {
        "alertReport": {
          "return": {
            "id": {
              "return": "object",
              "arguments": {}
            },
            "reason": {
              "return": "string",
              "arguments": {}
            },
            "rules": {
              "return": [
                {
                  "id": {
                    "return": "object",
                    "arguments": {}
                  },
                  "translatedDescription": {
                    "return": {
                      "en": {
                        "return": "string",
                        "arguments": {}
                      },
                      "fr": {
                        "return": "string",
                        "arguments": {}
                      }
                    },
                    "arguments": {}
                  },
                  "type": {
                    "return": "string",
                    "arguments": {}
                  }
                }
              ],
              "arguments": {}
            },
            "state": {
              "return": "string",
              "arguments": {}
            },
            "transfer": {
              "return": {
                "alertReport": {
                  "return": {
                    "id": {
                      "return": "object",
                      "arguments": {}
                    },
                    "reason": {
                      "return": "string",
                      "arguments": {}
                    },
                    "rules": {
                      "return": [
                        {
                          "id": {
                            "return": "object",
                            "arguments": {}
                          },
                          "translatedDescription": {
                            "return": {
                              "en": {
                                "return": "string",
                                "arguments": {}
                              },
                              "fr": {
                                "return": "string",
                                "arguments": {}
                              }
                            },
                            "arguments": {}
                          },
                          "type": {
                            "return": "string",
                            "arguments": {}
                          }
                        }
                      ],
                      "arguments": {}
                    },
                    "state": {
                      "return": "string",
                      "arguments": {}
                    },
                    "transfer": {
                      "return": {
                        "alertReport": {
                          "return": {
                            "id": {}
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    ]
  }
}

FetchUserIdVerificationsInput: object

Input type for fetching userIdVerifications

filter:

To filter the userIds

pagination:

To organize the response as per the pagination fields

Example
{
  "filter": {
    "methodOfIDVerification": "string",
    "userId": "object",
    "verifiedAtAfter": "object",
    "verifiedAtBefore": "object"
  },
  "pagination": {
    "offSet": "number",
    "perPage": "number",
    "sortDesc": "boolean",
    "sortField": "string"
  }
}

FetchUserIdVerificationsResponse: object

Type definition for fetching userIdVerifications

idVerifications:
object

Returns an array of objects for idVerifications

return:
IdVerification
arguments:
object
totalCount:
object

Total number of the records that satisfies a specified filter; for example, a filter is set for methodOfIdVerification, then it will return a number of verifiedIds associated to that methodOfIdVerification

return:
Int
arguments:
object
Example
{
  "idVerifications": {
    "return": [
      {
        "creditFileSource": {
          "return": "object",
          "arguments": {}
        },
        "documentExpiryDate": {
          "return": "object",
          "arguments": {}
        },
        "documentID": {
          "return": "string",
          "arguments": {}
        },
        "documentIssuingJurisdication": {
          "return": "string",
          "arguments": {}
        },
        "documentType": {
          "return": "string",
          "arguments": {}
        },
        "id": {
          "return": "object",
          "arguments": {}
        },
        "methodOfIDVerification": {
          "return": "string",
          "arguments": {}
        },
        "secondaryDocumentExpiryDate": {
          "return": "object",
          "arguments": {}
        },
        "secondaryDocumentID": {
          "return": "string",
          "arguments": {}
        },
        "secondaryDocumentIssuingJurisdication": {
          "return": "string",
          "arguments": {}
        },
        "secondaryDocumentType": {
          "return": "string",
          "arguments": {}
        },
        "secondaryDocumentUserName": {
          "return": "object",
          "arguments": {}
        },
        "state": {
          "return": "string",
          "arguments": {}
        },
        "user": {
          "return": {
            "accessibleBy": {
              "return": [
                {
                  "displayOptions": {
                    "return": {
                      "hide": {
                        "return": "boolean",
                        "arguments": {}
                      },
                      "order": {
                        "return": "number",
                        "arguments": {}
                      }
                    },
                    "arguments": {}
                  },
                  "organizationUser": {
                    "return": {
                      "accessType": {
                        "return": "string",
                        "arguments": {}
                      },
                      "apiTokens": {
                        "return": [
                          {
                            "id": {
                              "return": "object",
                              "arguments": {}
                            },
                            "jwtToken": {
                              "return": "string",
                              "arguments": {}
                            },
                            "name": {
                              "return": "string",
                              "arguments": {}
                            },
                            "organization": {}
                          }
                        ]
                      }
                    }
                  }
                }
              ]
            }
          }
        }
      }
    ]
  }
}

FetchUserResponse: object

Type definition for fetching a user

user:
object

Returns a user object

return:
arguments:
object
Example
{
  "user": {
    "return": {
      "accessibleBy": {
        "return": [
          {
            "displayOptions": {
              "return": {
                "hide": {
                  "return": "boolean",
                  "arguments": {}
                },
                "order": {
                  "return": "number",
                  "arguments": {}
                }
              },
              "arguments": {}
            },
            "organizationUser": {
              "return": {
                "accessType": {
                  "return": "string",
                  "arguments": {}
                },
                "apiTokens": {
                  "return": [
                    {
                      "id": {
                        "return": "object",
                        "arguments": {}
                      },
                      "jwtToken": {
                        "return": "string",
                        "arguments": {}
                      },
                      "name": {
                        "return": "string",
                        "arguments": {}
                      },
                      "organization": {
                        "return": {
                          "browserTabTitle": {
                            "return": "string",
                            "arguments": {}
                          },
                          "faviconLink": {
                            "return": "string",
                            "arguments": {}
                          },
                          "id": {
                            "return": "object",
                            "arguments": {}
                          },
                          "name": {
                            "return": "string",
                            "arguments": {}
                          },
                          "parent": {
                            "return": {
                              "browserTabTitle": {
                                "return": "string",
                                "arguments": {}
                              },
                              "faviconLink": {
                                "return": "string",
                                "arguments": {}
                              },
                              "id": {
                                "return": "object",
                                "arguments": {}
                              },
                              "name": {
                                "return": "string",
                                "arguments": {}
                              },
                              "parent": {
                                "return": {
                                  "browserTabTitle": {
                                    "return": "string",
                                    "arguments": {}
                                  },
                                  "faviconLink": {
                                    "return": "string",
                                    "arguments": {}
                                  },
                                  "id": {
                                    "return": "object",
                                    "arguments": {}
                                  },
                                  "name": {
                                    "return": "string",
                                    "arguments": {}
                                  }
                                }
                              }
                            }
                          }
                        }
                      }
                    }
                  ]
                }
              }
            }
          }
        ]
      }
    }
  }
}

FetchUserUpdatesInput: object

pagination:
userId:
Example
{
  "pagination": {
    "offSet": "number",
    "perPage": "number",
    "sortDesc": "boolean"
  },
  "userId": "object"
}

FetchUserUpdatesResponse: object

totalCount:
object
return:
Int
arguments:
object
userUpdates:
object
return:
UserUpdate
arguments:
object
Example
{
  "totalCount": {
    "return": "number",
    "arguments": {}
  },
  "userUpdates": {
    "return": [
      {
        "d": {
          "return": "string",
          "arguments": {}
        },
        "id": {
          "return": "object",
          "arguments": {}
        },
        "o": {
          "return": "string",
          "arguments": {}
        },
        "t": {
          "return": "object",
          "arguments": {}
        }
      }
    ],
    "arguments": {}
  }
}

FetchUsersInput: object

Input type for fetching Users

filter:

To filter the Users

pagination:

To organize the response as per the pagination fields

Example
{
  "filter": {
    "completedAtAfter": "object",
    "completedAtBefore": "object",
    "complianceState": "string",
    "customFields": [
      {
        "key": "object",
        "value": "object"
      }
    ],
    "dateOfBirthAfter": "object",
    "dateOfBirthBefore": "object",
    "iDCheckCompleted": "boolean",
    "iDVerified": "boolean",
    "isComplete": "boolean",
    "lastSuitabilityReviewAtAfter": "object",
    "lastSuitabilityReviewAtBefore": "object",
    "organizationId": "object",
    "partnerUserId": "object",
    "primaryEmail": "string",
    "searchText": "string",
    "sin": "object",
    "suitabilityReviewDaysPastDue": "number",
    "suitabilityReviewDue": "boolean",
    "types": [
      "string"
    ]
  },
  "pagination": {
    "offSet": "number",
    "perPage": "number",
    "sortDesc": "boolean",
    "sortField": "string"
  }
}

FetchUsersResponse: object

Type definition for fetching users

totalCount:
object

Total number of the records that satisfies a specified filter; for example, a filter is set for an verifiedAtAfter, then it will return a number of users associated to that filter

return:
Int
arguments:
object
users:
object

Returns an array of objects for users

return:
User
arguments:
object
Example
{
  "totalCount": {
    "return": "number",
    "arguments": {}
  },
  "users": {
    "return": [
      {
        "accessibleBy": {
          "return": [
            {
              "displayOptions": {
                "return": {
                  "hide": {
                    "return": "boolean",
                    "arguments": {}
                  },
                  "order": {
                    "return": "number",
                    "arguments": {}
                  }
                },
                "arguments": {}
              },
              "organizationUser": {
                "return": {
                  "accessType": {
                    "return": "string",
                    "arguments": {}
                  },
                  "apiTokens": {
                    "return": [
                      {
                        "id": {
                          "return": "object",
                          "arguments": {}
                        },
                        "jwtToken": {
                          "return": "string",
                          "arguments": {}
                        },
                        "name": {
                          "return": "string",
                          "arguments": {}
                        },
                        "organization": {
                          "return": {
                            "browserTabTitle": {
                              "return": "string",
                              "arguments": {}
                            },
                            "faviconLink": {
                              "return": "string",
                              "arguments": {}
                            },
                            "id": {
                              "return": "object",
                              "arguments": {}
                            },
                            "name": {
                              "return": "string",
                              "arguments": {}
                            },
                            "parent": {
                              "return": {
                                "browserTabTitle": {
                                  "return": "string",
                                  "arguments": {}
                                },
                                "faviconLink": {
                                  "return": "string",
                                  "arguments": {}
                                },
                                "id": {
                                  "return": "object",
                                  "arguments": {}
                                },
                                "name": {
                                  "return": "string",
                                  "arguments": {}
                                },
                                "parent": {
                                  "return": {
                                    "browserTabTitle": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "faviconLink": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "id": {
                                      "return": "object"
                                    }
                                  }
                                }
                              }
                            }
                          }
                        }
                      }
                    ]
                  }
                }
              }
            }
          ]
        }
      }
    ]
  }
}

FetchWebhookResponse: object

webhook:
object
return:
arguments:
object
Example
{
  "webhook": {
    "return": {
      "customHeaders": {
        "return": "object",
        "arguments": {}
      },
      "customPayloadAttributes": {
        "return": "object",
        "arguments": {}
      },
      "eventType": {
        "return": "string",
        "arguments": {}
      },
      "gql": {
        "return": "string",
        "arguments": {}
      },
      "id": {
        "return": "object",
        "arguments": {}
      },
      "mutationInputName": {
        "return": "string",
        "arguments": {}
      },
      "mutationName": {
        "return": "string",
        "arguments": {}
      },
      "objectType": {
        "return": "string",
        "arguments": {}
      },
      "organization": {
        "return": {
          "accountTypeTaxRanks": {
            "return": [
              {
                "accountType": {
                  "return": "string",
                  "arguments": {}
                },
                "id": {
                  "return": "object",
                  "arguments": {}
                },
                "taxRank": {
                  "return": "number",
                  "arguments": {}
                }
              }
            ],
            "arguments": {}
          },
          "allowAccessToSubOrganizations": {
            "return": "boolean",
            "arguments": {}
          },
          "allowDirectCommunication": {
            "return": "boolean",
            "arguments": {}
          },
          "allowInactiveUserAdjustments": {
            "return": "boolean",
            "arguments": {}
          },
          "allowInactiveUserFeeCalculation": {
            "return": "boolean",
            "arguments": {}
          },
          "allowInactiveUserRebalancing": {
            "return": "boolean",
            "arguments": {}
          },
          "allowInstantInvest": {
            "return": "boolean",
            "arguments": {}
          },
          "allowPortfolioPerGoal": {
            "return": "boolean",
            "arguments": {}
          },
          "allowPostOptimizationEditing": {
            "return": "boolean",
            "arguments": {}
          },
          "allowViewSubTradeRequestPairs": {
            "return": "boolean",
            "arguments": {}
          },
          "applicableJurisdictions": {
            "return": {
              "all": {
                "return": "boolean",
                "arguments": {}
              },
              "only": {}
            }
          }
        }
      }
    }
  }
}

FetchWebhooksInput: object

filter:
pagination:
Example
{
  "filter": {
    "createdAtAfter": "object",
    "createdAtBefore": "object",
    "eventType": "string",
    "objectType": "string",
    "organizationId": "object",
    "type": "string"
  },
  "pagination": {
    "offSet": "number",
    "perPage": "number",
    "sortDesc": "boolean",
    "sortField": "string"
  }
}

FetchWebhooksResponse: object

totalCount:
object
return:
Int
arguments:
object
webhooks:
object
return:
Webhook
arguments:
object
Example
{
  "totalCount": {
    "return": "number",
    "arguments": {}
  },
  "webhooks": {
    "return": [
      {
        "customHeaders": {
          "return": "object",
          "arguments": {}
        },
        "customPayloadAttributes": {
          "return": "object",
          "arguments": {}
        },
        "eventType": {
          "return": "string",
          "arguments": {}
        },
        "gql": {
          "return": "string",
          "arguments": {}
        },
        "id": {
          "return": "object",
          "arguments": {}
        },
        "mutationInputName": {
          "return": "string",
          "arguments": {}
        },
        "mutationName": {
          "return": "string",
          "arguments": {}
        },
        "objectType": {
          "return": "string",
          "arguments": {}
        },
        "organization": {
          "return": {
            "accountTypeTaxRanks": {
              "return": [
                {
                  "accountType": {
                    "return": "string",
                    "arguments": {}
                  },
                  "id": {
                    "return": "object",
                    "arguments": {}
                  },
                  "taxRank": {
                    "return": "number",
                    "arguments": {}
                  }
                }
              ],
              "arguments": {}
            },
            "allowAccessToSubOrganizations": {
              "return": "boolean",
              "arguments": {}
            },
            "allowDirectCommunication": {
              "return": "boolean",
              "arguments": {}
            },
            "allowInactiveUserAdjustments": {
              "return": "boolean",
              "arguments": {}
            },
            "allowInactiveUserFeeCalculation": {
              "return": "boolean",
              "arguments": {}
            },
            "allowInactiveUserRebalancing": {
              "return": "boolean",
              "arguments": {}
            },
            "allowInstantInvest": {
              "return": "boolean",
              "arguments": {}
            },
            "allowPortfolioPerGoal": {
              "return": "boolean",
              "arguments": {}
            },
            "allowPostOptimizationEditing": {
              "return": "boolean",
              "arguments": {}
            },
            "allowViewSubTradeRequestPairs": {
              "return": "boolean",
              "arguments": {}
            },
            "applicableJurisdictions": {
              "return": {}
            }
          }
        }
      }
    ]
  }
}

FetchWidgetOptionsResponse: object

widgetOptions:
object
return:
WidgetOption
arguments:
object
Example
{
  "widgetOptions": {
    "return": [
      {
        "customFieldFilter": {
          "return": "object",
          "arguments": {}
        },
        "default": {
          "return": "object",
          "arguments": {}
        },
        "info": {
          "return": {
            "en": {
              "return": "string",
              "arguments": {}
            },
            "fr": {
              "return": "string",
              "arguments": {}
            }
          },
          "arguments": {}
        },
        "key": {
          "return": "string",
          "arguments": {}
        },
        "label": {
          "return": {
            "en": {
              "return": "string",
              "arguments": {}
            },
            "fr": {
              "return": "string",
              "arguments": {}
            }
          },
          "arguments": {}
        },
        "optionType": {
          "return": "string",
          "arguments": {}
        },
        "options": {
          "return": "object",
          "arguments": {}
        },
        "removeFromPages": {
          "return": [
            "string"
          ],
          "arguments": {}
        },
        "requiredIf": {
          "return": "object",
          "arguments": {}
        },
        "showBasedOnCustodianConnection": {
          "return": [
            "object"
          ],
          "arguments": {}
        },
        "showCustomField": {
          "return": "boolean",
          "arguments": {}
        },
        "showIf": {
          "return": "object",
          "arguments": {}
        },
        "showWith": {
          "return": "string",
          "arguments": {}
        }
      }
    ],
    "arguments": {}
  }
}

FetchWorkflowCompletionsInput: object

filter:
pagination:
Example
{
  "filter": {
    "objectType": "string",
    "organizationId": "object",
    "state": "string"
  },
  "pagination": {
    "offSet": "number",
    "perPage": "number",
    "sortDesc": "boolean",
    "sortField": "string"
  }
}

FetchWorkflowCompletionsResponse: object

totalCount:
object
return:
Int
arguments:
object
workflowCompletions:
object
return:
WorkflowCompletion
arguments:
object
Example
{
  "totalCount": {
    "return": "number",
    "arguments": {}
  },
  "workflowCompletions": {
    "return": [
      {
        "context": {
          "return": "object",
          "arguments": {}
        },
        "createdAt": {
          "return": "object",
          "arguments": {}
        },
        "currentStep": {
          "return": {
            "id": {
              "return": "object",
              "arguments": {}
            },
            "name": {
              "return": {
                "en": {
                  "return": "string",
                  "arguments": {}
                },
                "fr": {
                  "return": "string",
                  "arguments": {}
                }
              },
              "arguments": {}
            },
            "subSteps": {
              "return": [
                {
                  "canGoBack": {
                    "return": "boolean",
                    "arguments": {}
                  },
                  "completeableBy": {
                    "return": [
                      "string"
                    ],
                    "arguments": {}
                  },
                  "id": {
                    "return": "object",
                    "arguments": {}
                  },
                  "options": {
                    "return": "object",
                    "arguments": {}
                  },
                  "rolesCompleteableBy": {
                    "return": [
                      {
                        "accessiblePages": {
                          "return": [
                            "string"
                          ],
                          "arguments": {}
                        },
                        "accountPageConfiguration": {
                          "return": {
                            "createdAt": {
                              "return": "object",
                              "arguments": {}
                            },
                            "id": {
                              "return": "object",
                              "arguments": {}
                            },
                            "name": {
                              "return": "string",
                              "arguments": {}
                            },
                            "options": {
                              "return": "object",
                              "arguments": {}
                            },
                            "organization": {
                              "return": {
                                "accountTypeTaxRanks": {
                                  "return": [
                                    {
                                      "accountType": {
                                        "return": "string",
                                        "arguments": {}
                                      },
                                      "id": {
                                        "return": "object",
                                        "arguments": {}
                                      }
                                    }
                                  ]
                                }
                              }
                            }
                          }
                        }
                      }
                    ]
                  }
                }
              ]
            }
          }
        }
      }
    ]
  }
}

FetchWorkflowResponse: object

workflow:
object
return:
arguments:
object
Example
{
  "workflow": {
    "return": {
      "createdAt": {
        "return": "object",
        "arguments": {}
      },
      "eventType": {
        "return": "string",
        "arguments": {}
      },
      "id": {
        "return": "object",
        "arguments": {}
      },
      "name": {
        "return": {
          "en": {
            "return": "string",
            "arguments": {}
          },
          "fr": {
            "return": "string",
            "arguments": {}
          }
        },
        "arguments": {}
      },
      "objectType": {
        "return": "string",
        "arguments": {}
      },
      "organization": {
        "return": {
          "accountTypeTaxRanks": {
            "return": [
              {
                "accountType": {
                  "return": "string",
                  "arguments": {}
                },
                "id": {
                  "return": "object",
                  "arguments": {}
                },
                "taxRank": {
                  "return": "number",
                  "arguments": {}
                }
              }
            ],
            "arguments": {}
          },
          "allowAccessToSubOrganizations": {
            "return": "boolean",
            "arguments": {}
          },
          "allowDirectCommunication": {
            "return": "boolean",
            "arguments": {}
          },
          "allowInactiveUserAdjustments": {
            "return": "boolean",
            "arguments": {}
          },
          "allowInactiveUserFeeCalculation": {
            "return": "boolean",
            "arguments": {}
          },
          "allowInactiveUserRebalancing": {
            "return": "boolean",
            "arguments": {}
          },
          "allowInstantInvest": {
            "return": "boolean",
            "arguments": {}
          },
          "allowPortfolioPerGoal": {
            "return": "boolean",
            "arguments": {}
          },
          "allowPostOptimizationEditing": {
            "return": "boolean",
            "arguments": {}
          },
          "allowViewSubTradeRequestPairs": {
            "return": "boolean",
            "arguments": {}
          },
          "applicableJurisdictions": {
            "return": {
              "all": {
                "return": "boolean",
                "arguments": {}
              },
              "only": {
                "return": [
                  "string"
                ],
                "arguments": {}
              }
            }
          }
        }
      }
    }
  }
}

FetchWorkflowsInput: object

filter:
pagination:
Example
{
  "filter": {
    "objectType": "string",
    "organizationId": "object",
    "state": "string",
    "states": [
      "string"
    ]
  },
  "pagination": {
    "offSet": "number",
    "perPage": "number",
    "sortDesc": "boolean",
    "sortField": "string"
  }
}

FetchWorkflowsResponse: object

totalCount:
object
return:
Int
arguments:
object
workflows:
object
return:
Workflow
arguments:
object
Example
{
  "totalCount": {
    "return": "number",
    "arguments": {}
  },
  "workflows": {
    "return": [
      {
        "createdAt": {
          "return": "object",
          "arguments": {}
        },
        "eventType": {
          "return": "string",
          "arguments": {}
        },
        "id": {
          "return": "object",
          "arguments": {}
        },
        "name": {
          "return": {
            "en": {
              "return": "string",
              "arguments": {}
            },
            "fr": {
              "return": "string",
              "arguments": {}
            }
          },
          "arguments": {}
        },
        "objectType": {
          "return": "string",
          "arguments": {}
        },
        "organization": {
          "return": {
            "accountTypeTaxRanks": {
              "return": [
                {
                  "accountType": {
                    "return": "string",
                    "arguments": {}
                  },
                  "id": {
                    "return": "object",
                    "arguments": {}
                  },
                  "taxRank": {
                    "return": "number",
                    "arguments": {}
                  }
                }
              ],
              "arguments": {}
            },
            "allowAccessToSubOrganizations": {
              "return": "boolean",
              "arguments": {}
            },
            "allowDirectCommunication": {
              "return": "boolean",
              "arguments": {}
            },
            "allowInactiveUserAdjustments": {
              "return": "boolean",
              "arguments": {}
            },
            "allowInactiveUserFeeCalculation": {
              "return": "boolean",
              "arguments": {}
            },
            "allowInactiveUserRebalancing": {
              "return": "boolean",
              "arguments": {}
            },
            "allowInstantInvest": {
              "return": "boolean",
              "arguments": {}
            },
            "allowPortfolioPerGoal": {
              "return": "boolean",
              "arguments": {}
            },
            "allowPostOptimizationEditing": {
              "return": "boolean",
              "arguments": {}
            },
            "allowViewSubTradeRequestPairs": {
              "return": "boolean",
              "arguments": {}
            },
            "applicableJurisdictions": {
              "return": {
                "all": {
                  "return": "boolean",
                  "arguments": {}
                }
              }
            }
          }
        }
      }
    ]
  }
}

FileDocument: object

File type

createdAt:
object

The date and time this File was created

return:
arguments:
object
creator:
object

OrganizationUser is the author of the File

return:
arguments:
object
creatorOrganization:
object

Organization of the Files creator

return:
arguments:
object
downloadUrl:
object
return:
arguments:
object
fileName:
object

Operating System file name as uploaded, ie. "the statement scan (1).png"

return:
arguments:
object
id:
object

Unique identifier, a 24 character hexadecimal string

return:
arguments:
object
mediaType:
object

A media type (also known as MIME type) according to RFC6838, ie. "image/png"

return:
arguments:
object
name:
object

User editable file name, free text, ie. "Greg's RBC bank statement Jun 2026"

return:
arguments:
object
objectId:
object

objectId of the designated documentType

return:
arguments:
object
objectType:
object

FileDocumentObjectTypes derived from the ENUM

return:
arguments:
object
organization:
object

Organization belongs to the document file

return:
arguments:
object
permissionType:
object

permissionType derived from the ENUM

return:
arguments:
object
requestId:
object

requestId of fileDocument

return:
arguments:
object
requestIpAddress:
object
return:
arguments:
object
s3Key:
object
return:
arguments:
object
sharedClient:
object
return:
arguments:
object
sharedCustodian:
object
return:
arguments:
object
signed:
object
return:
arguments:
object
sourceId:
object

File Type SourceId

return:
arguments:
object
sourceType:
object
return:
arguments:
object
type:
object

FileDocumentTypes derived from the ENUM

return:
arguments:
object
updatedAt:
object

The date and time this File's information was last updated

return:
arguments:
object
uploadedAt:
object

The date and time this File was uploaded

return:
arguments:
object
user:
object

Optional destination user from organization

return:
arguments:
object
Example
{
  "createdAt": {
    "return": "object",
    "arguments": {}
  },
  "creator": {
    "return": {
      "email": {
        "return": "string",
        "arguments": {}
      },
      "firstName": {
        "return": "string",
        "arguments": {}
      },
      "id": {
        "return": "object",
        "arguments": {}
      },
      "language": {
        "return": "string",
        "arguments": {}
      },
      "lastName": {
        "return": "string",
        "arguments": {}
      },
      "organization": {
        "return": {
          "browserTabTitle": {
            "return": "string",
            "arguments": {}
          },
          "faviconLink": {
            "return": "string",
            "arguments": {}
          },
          "id": {
            "return": "object",
            "arguments": {}
          },
          "name": {
            "return": "string",
            "arguments": {}
          },
          "parent": {
            "return": {
              "browserTabTitle": {
                "return": "string",
                "arguments": {}
              },
              "faviconLink": {
                "return": "string",
                "arguments": {}
              },
              "id": {
                "return": "object",
                "arguments": {}
              },
              "name": {
                "return": "string",
                "arguments": {}
              },
              "parent": {
                "return": {
                  "browserTabTitle": {
                    "return": "string",
                    "arguments": {}
                  },
                  "faviconLink": {
                    "return": "string",
                    "arguments": {}
                  },
                  "id": {
                    "return": "object",
                    "arguments": {}
                  },
                  "name": {
                    "return": "string",
                    "arguments": {}
                  },
                  "parent": {
                    "return": {
                      "browserTabTitle": {
                        "return": "string",
                        "arguments": {}
                      },
                      "faviconLink": {
                        "return": "string",
                        "arguments": {}
                      },
                      "id": {
                        "return": "object",
                        "arguments": {}
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

FileDocumentObjectTypes: string

File ENUMS

object
ACCOUNT
object
ARTICLE
object
BULK_IMPORT
object
CLIENTGROUP
object
GOAL
object
ORGANIZATION
object
ORGANIZATION_USER
object
SCHEDULED_TRANSFER
object
SUBACCOUNT
object
USER

FileDocumentPaginationAndSorting: object

Input fields options to manage pagination and sorting for fileDocument Object

offSet:
Int

The number of records to skip per page from the beginning of the elements per page

perPage:
Int

Elements per page

sortDesc:

To sort in descending order or not

sortField:

To sort the list by the fields for the fileDocument Object

Example
{
  "offSet": "number",
  "perPage": "number",
  "sortDesc": "boolean",
  "sortField": "string"
}

FileDocumentPermissionTypes: string

object
ORGANIZATIONAL
object
PRIVATE
object
PUBLIC

FileDocumentQueryFilter: object

Input type for filtering FileDocuments

objectIds:
ObjectID

objectId for filter FileDocuments

objectTypes:
FileDocumentObjectTypes

FileDocumentObjectTypes derived from the ENUM

organizationId:

organizationId for filter FileDocuments

sourceIds:
ObjectID
types:
FileDocumentTypes

type of the FileDocument

userIds:
ObjectID

userId for filter FileDocuments

Example
{
  "objectIds": [
    "object"
  ],
  "objectTypes": [
    "string"
  ],
  "organizationId": "object",
  "sourceIds": [
    "object"
  ],
  "types": [
    "string"
  ],
  "userIds": [
    "object"
  ]
}

FileDocumentTypes: string

object
ARTICLE
object
AVATAR
object
BANKING
object
BULK_IMPORT
object
CLIENT_REPORT
object
CLIENT_REPORT_TEMPLATE
object
FORM
object
ID_VERIFICATION
object
INVOICE
object
LOGO
object
NOTES
object
OTHER
object
STATEMENT
object
TEMPLATE
object
WORKFLOW

FinancialProduct: object

assignable:
object

Is this Financial product assignable?

return:
arguments:
object
autoUpdatePrices:
object

Auto updates prices using data partner?

return:
arguments:
object
children:
object

The branches of this Financial product.

return:
Branch
arguments:
object
currency:
object

The currency that this Financial product trades in.

return:
arguments:
object
currentPriceCents:
object

The current price of the stock

return:
arguments:
object
cusip:
object
return:
arguments:
object
exchange:
object

The Stock Exchange that this Financial product trades in.

return:
arguments:
object
expectedPrimaryAssetClassHoldings:
object

This is the primary asset class holdings list of this financial product

return:
ExpectedPrimaryAssetClassHoldings
arguments:
object
forecastedRateOfReturn:
object

The forecasted rate of return for this product

return:
arguments:
object
forecastedStandardDeviation:
object

The forecasted standard deviation for this product

return:
arguments:
object
foreignExchangeRate:
object
return:
arguments:
object
id:
object

This is the financialProductId and it is auto-generated by OneVest for each Financial Product.

return:
arguments:
object
integrations:
object
return:
FinancialProductIntegration
arguments:
object
investmentObjective:
object

Objective of the portfolio

return:
arguments:
object
isCash:
object

Denotes if this financial product is cash

return:
arguments:
object
isPartial:
object

When true, allowed to allocate fractional trades.

Defaults to true.

return:
arguments:
object
isin:
object
return:
arguments:
object
lowThresholdScore:
object

Low threshold score for allowing access

return:
arguments:
object
modelPortfolioLogs:
object
return:
arguments:
object
input:
name:
object

Name of the Financial product.

return:
arguments:
object
originalCurrency:
object

The original (not converted) currency that this Financial product trades in.

return:
arguments:
object
originalCurrentPriceCents:
object

The original (not converted) current price of the stock

return:
arguments:
object
portfolioDescription:
object

Description of the portfolio

return:
arguments:
object
portfolioDisclaimer:
object

Disclaimer of the portfolio

return:
arguments:
object
priceHistoryUrl:
object

URL to download a csv containing the Financial Product's historical prices.

return:
arguments:
object
primaryAssetClass:
object

Primary Asset Class of the product

return:
arguments:
object
reasonForUpdate:
object

This will be used to describe why form agreements need to be re-signed when a portfolio's secondaryAssetClass, description, and/or targetAllocations have changed.

return:
arguments:
object
ric:
object
return:
arguments:
object
riskProfileDescription:
object
return:
arguments:
object
riskProfileName:
object
return:
arguments:
object
riskReturnLevel:
object
return:
Int
arguments:
object
schedule:
object

Optional schedule (used for illiquid portfolios).

return:
arguments:
object
secondaryAssetClass:
object

Secondary Asset Class of the product

return:
arguments:
object
settlementDays:
object
return:
Int
arguments:
object
state:
object

State of the Financial product.

return:
arguments:
object
substituteFinancialProduct:
object

Optional substitute Financial product (used for Tax-Loss Harvesting).

return:
arguments:
object
suggestable:
object

Is this Financial product suggestable?

return:
arguments:
object
suggestedMaxScore:
object

Maximum suitability score to have access to this Financial product.

return:
arguments:
object
suggestedMinScore:
object

Minimum suitability score to have access to this Financial product.

return:
arguments:
object
targetAllocations:
object

All Target Allocations

return:
TargetAllocation
arguments:
object
taxRank:
object

The tax rank of the financial product, to be used for portfolio optimization

return:
Int
arguments:
object
tertiaryAssetClass:
object

Tertiary Asset Class of the product

return:
arguments:
object
theme:
object

The theme of the product

return:
arguments:
object
ticker:
object

The trading ticker for this Financial product.

return:
arguments:
object
tradeable:
object

Is this Financial product tradeable?

return:
arguments:
object
translatedInvestmentObjective:
object

The translated investment objectives of the portfolio

return:
arguments:
object
translatedLiquidity:
object

The translated liquidity of the portfolio

return:
arguments:
object
translatedName:
object

Translated name of the Financial product.

return:
arguments:
object
translatedPortfolioDescription:
object

The translated descriptions of the portfolio

return:
arguments:
object
translatedPortfolioDisclaimer:
object

The translated disclaimers of the portfolio

return:
arguments:
object
translatedReasonForUpdate:
object

This will be used to describe translated reason why form agreements need to be re-signed when a portfolio's secondaryAssetClass, description, and/or targetAllocations have changed.

return:
arguments:
object
updatedAt:
object

The last time the product was updated

return:
arguments:
object
url:
object

A URL to an external site for more details on the product

return:
arguments:
object
volatile:
object
return:
arguments:
object
waivedFeePercentage:
object

A discount percentage applied to the corresponding holding amount during fee calculation (0 - 100%).

return:
arguments:
object
Example
{
  "assignable": {
    "return": "boolean",
    "arguments": {}
  },
  "autoUpdatePrices": {
    "return": "boolean",
    "arguments": {}
  },
  "children": {
    "return": [
      {
        "financialProduct": {
          "return": {
            "assignable": {
              "return": "boolean",
              "arguments": {}
            },
            "autoUpdatePrices": {
              "return": "boolean",
              "arguments": {}
            },
            "children": {
              "return": [
                {
                  "financialProduct": {
                    "return": {
                      "assignable": {
                        "return": "boolean",
                        "arguments": {}
                      },
                      "autoUpdatePrices": {
                        "return": "boolean",
                        "arguments": {}
                      },
                      "children": {
                        "return": [
                          {
                            "financialProduct": {
                              "return": {
                                "assignable": {
                                  "return": "boolean",
                                  "arguments": {}
                                },
                                "autoUpdatePrices": {
                                  "return": "boolean",
                                  "arguments": {}
                                },
                                "children": {
                                  "return": [
                                    {
                                      "financialProduct": {
                                        "return": {
                                          "assignable": {
                                            "return": "boolean",
                                            "arguments": {}
                                          },
                                          "autoUpdatePrices": {
                                            "return": "boolean",
                                            "arguments": {}
                                          },
                                          "children": {
                                            "return": [
                                              {
                                                "financialProduct": {
                                                  "return": {
                                                    "assignable": {
                                                      "return": "boolean",
                                                      "arguments": {}
                                                    },
                                                    "autoUpdatePrices": {
                                                      "return": "boolean",
                                                      "arguments": {}
                                                    },
                                                    "children": {
                                                      "return": [
                                                        {
                                                          "financialProduct": {
                                                            "return": {
                                                              "assignable": {
                                                                "return": "boolean",
                                                                "arguments": {}
                                                              },
                                                              "autoUpdatePrices": {
                                                                "return": "boolean",
                                                                "arguments": {}
                                                              },
                                                              "children": {}
                                                            }
                                                          }
                                                        }
                                                      ]
                                                    }
                                                  }
                                                }
                                              }
                                            ]
                                          }
                                        }
                                      }
                                    }
                                  ]
                                }
                              }
                            }
                          }
                        ]
                      }
                    }
                  }
                }
              ]
            }
          }
        }
      }
    ]
  }
}

FinancialProductIntegration: object

The integration enum and unique integration id

iid:
object

The id for the entity, in the given specific integration

return:
arguments:
object
type:
object

Enumeration for the integration type

return:
arguments:
object
Example
{
  "iid": {
    "return": "string",
    "arguments": {}
  },
  "type": {
    "return": "string",
    "arguments": {}
  }
}

FinancialProductIntegrationInput: object

Input type for integrations field

externalId:

externalId external source id

groupId:

group id the custodian connection

iid:

iid is the unique identifier for this entity in the given integration

type:

Integrations type derives from enumeration

Example
{
  "externalId": "object",
  "groupId": "object",
  "iid": "object",
  "type": "string"
}

FinancialProductIntegrationTypes: string

Integrations for FinancialProduct

object
APEX
object
CIBC_MELLON
object
CIIS
object
ENVESTNET
object
FC
object
FUNDSERV
object
IBKR
object
NBIN
object
NO_CONNECTION
object
PERSHING
object
RBC
object
SALESFORCE
object
SCHWAB
object
TEMPLATE

FinancialProductPaginationAndSorting: object

offset:
Int
perPage:
Int
sortDesc:
sortField:
Example
{
  "offset": "number",
  "perPage": "number",
  "sortDesc": "boolean",
  "sortField": "string"
}

FinancialProductQueryFilter: object

autoUpdatePrices:
currency:
exchange:
hasSubstituteProduct:
isScheduled:
name:
organizationId:
primaryAssetClassId:
searchText:
secondaryAssetClassId:
state:
tertiaryAssetClassId:
themeId:
Example
{
  "autoUpdatePrices": "boolean",
  "currency": "string",
  "exchange": "string",
  "hasSubstituteProduct": "boolean",
  "isScheduled": "boolean",
  "name": "string",
  "organizationId": "object",
  "primaryAssetClassId": "object",
  "searchText": "string",
  "secondaryAssetClassId": "object",
  "state": "string",
  "tertiaryAssetClassId": "object",
  "themeId": "object"
}

FinancialProductState: string

object
ACTIVE
object
ARCHIVED
object
DRAFT

FinancialProductTransitions: string

object
activate
object
archive
object
draft

Flag: object

account:
object
return:
arguments:
object
createdAt:
object
return:
arguments:
object
custodian:
object
return:
arguments:
object
details:
object
return:
arguments:
object
id:
object
return:
arguments:
object
message:
object
return:
arguments:
object
objectId:
object
return:
arguments:
object
objectType:
object
return:
arguments:
object
organization:
object
return:
arguments:
object
state:
object
return:
arguments:
object
type:
object
return:
arguments:
object
Example
{
  "account": {
    "return": {
      "affiliations": {
        "return": [
          {
            "allocation": {
              "return": "number",
              "arguments": {}
            },
            "id": {
              "return": "object",
              "arguments": {}
            },
            "relation": {
              "return": "string",
              "arguments": {}
            },
            "signatureRequired": {
              "return": "boolean",
              "arguments": {}
            },
            "type": {
              "return": "string",
              "arguments": {}
            },
            "user": {
              "return": {
                "accessibleBy": {
                  "return": [
                    {
                      "displayOptions": {
                        "return": {
                          "hide": {
                            "return": "boolean",
                            "arguments": {}
                          },
                          "order": {
                            "return": "number",
                            "arguments": {}
                          }
                        },
                        "arguments": {}
                      },
                      "organizationUser": {
                        "return": {
                          "accessType": {
                            "return": "string",
                            "arguments": {}
                          },
                          "apiTokens": {
                            "return": [
                              {
                                "id": {
                                  "return": "object",
                                  "arguments": {}
                                },
                                "jwtToken": {
                                  "return": "string",
                                  "arguments": {}
                                },
                                "name": {
                                  "return": "string",
                                  "arguments": {}
                                },
                                "organization": {
                                  "return": {
                                    "browserTabTitle": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "faviconLink": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "id": {
                                      "return": "object",
                                      "arguments": {}
                                    },
                                    "name": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "parent": {
                                      "return": {
                                        "browserTabTitle": {
                                          "return": "string",
                                          "arguments": {}
                                        },
                                        "faviconLink": {
                                          "return": "string",
                                          "arguments": {}
                                        }
                                      }
                                    }
                                  }
                                }
                              }
                            ]
                          }
                        }
                      }
                    }
                  ]
                }
              }
            }
          }
        ]
      }
    }
  }
}

FlagObjects: string

object
Account
object
AccountStatement
object
Activity
object
Cash
object
Dividend
object
Fee
object
FinancialProduct
object
Holding
object
Product
object
SubAccount
object
SubAccountDailyStats
object
Trade
object
Transfer

FlagPaginationAndSorting: object

offSet:
Int
perPage:
Int
sortDesc:
sortField:
Example
{
  "offSet": "number",
  "perPage": "number",
  "sortDesc": "boolean",
  "sortField": "string"
}

FlagQueryFilter: object

accountId:
custodianId:
objectType:
organizationId:
state:
type:
Example
{
  "accountId": "object",
  "custodianId": "object",
  "objectType": "string",
  "organizationId": "object",
  "state": "string",
  "type": "string"
}

FlagStates: string

object
FIXED
object
FLAGGED
object
TRIVIAL

FlagTransition: string

object
fixed
object
trivial

FlagTypes: string

object
ACCOUNT_NOT_FOUND
object
CASH_NOT_FOUND
object
DIFFERENT_HOLDINGS
object
DIFFERENT_HOLDINGS_V2
object
EXTERNAL_TRANSFER_IN_KIND
object
FAILED_ACCOUNT
object
FAILED_CUSTODIAN_OPENING
object
FEE_AMOUNT_DIFFERENT
object
FEE_NOT_FOUND
object
FINANCIAL_PRODUCT_NOT_FOUND
object
HOLDING_NOT_FOUND
object
MAPPING_ACTUAL_HOLDINGS
object
MAPPING_FILE_HOLDINGS
object
MONEY_AVAILABLE_VALUE_INCORRECT
object
MONEY_AVAILABLE_VALUE_INCORRECT_V2
object
NEGATIVE_CASH
object
NEGATIVE_HOLDING
object
NOT_CORPORATE_ACCOUNT
object
NOT_ENOUGH_MONEY_AVAILABLE_IN_ACCOUNT
object
NO_SNAPSHOTS_RECEIVED
object
PRODUCT_SYMBOL_DIFFERENT
object
PUBLISHING_DIFF_HOLDINGS
object
SNAPSHOT_ANOMALY
object
SNAPSHOT_MISSING
object
SNAPSHOT_PRICE_NOT_FOUND
object
STATEMENT_NOT_FOUND
object
TOO_MANY_EXTERNAL_TRANSFER_IN_CANDIDATES_FOUND
object
TOTAL_MARKET_VALUE_INCORRECT
object
TRADE_NOT_FOUND
object
TRANSFER_AMOUNT_DIFFERENT
object
TRANSFER_IMPORT_FAILED
object
TRANSFER_NOT_FOUND
object
TRANSFER_STUCK_INITIATED
object
TRANSFER_STUCK_PROCESSING
object
TRANSFER_STUCK_READY
object
UNKNOWN_ACTIVITY_TYPE

Float: number

The Float scalar type represents signed double-precision fractional values as specified by IEEE 754.

Example
number

ForceReconcileCustodianActivityResponse: object

custodianActivity:
object
return:
arguments:
object
Example
{
  "custodianActivity": {
    "return": {
      "account": {
        "return": {
          "affiliations": {
            "return": [
              {
                "allocation": {
                  "return": "number",
                  "arguments": {}
                },
                "id": {
                  "return": "object",
                  "arguments": {}
                },
                "relation": {
                  "return": "string",
                  "arguments": {}
                },
                "signatureRequired": {
                  "return": "boolean",
                  "arguments": {}
                },
                "type": {
                  "return": "string",
                  "arguments": {}
                },
                "user": {
                  "return": {
                    "accessibleBy": {
                      "return": [
                        {
                          "displayOptions": {
                            "return": {
                              "hide": {
                                "return": "boolean",
                                "arguments": {}
                              },
                              "order": {
                                "return": "number",
                                "arguments": {}
                              }
                            },
                            "arguments": {}
                          },
                          "organizationUser": {
                            "return": {
                              "accessType": {
                                "return": "string",
                                "arguments": {}
                              },
                              "apiTokens": {
                                "return": [
                                  {
                                    "id": {
                                      "return": "object",
                                      "arguments": {}
                                    },
                                    "jwtToken": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "name": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "organization": {
                                      "return": {
                                        "browserTabTitle": {
                                          "return": "string",
                                          "arguments": {}
                                        },
                                        "faviconLink": {
                                          "return": "string",
                                          "arguments": {}
                                        },
                                        "id": {
                                          "return": "object",
                                          "arguments": {}
                                        },
                                        "name": {
                                          "return": "string",
                                          "arguments": {}
                                        },
                                        "parent": {
                                          "return": {
                                            "browserTabTitle": {
                                              "return": "string",
                                              "arguments": {}
                                            },
                                            "faviconLink": {}
                                          }
                                        }
                                      }
                                    }
                                  }
                                ]
                              }
                            }
                          }
                        }
                      ]
                    }
                  }
                }
              }
            ]
          }
        }
      }
    }
  }
}

ForeignExchangeSnapshot: object

date:
object
return:
arguments:
object
from:
object
return:
arguments:
object
id:
object
return:
arguments:
object
rate:
object
return:
arguments:
object
to:
object
return:
arguments:
object
Example
{
  "date": {
    "return": "object",
    "arguments": {}
  },
  "from": {
    "return": "string",
    "arguments": {}
  },
  "id": {
    "return": "object",
    "arguments": {}
  },
  "rate": {
    "return": "number",
    "arguments": {}
  },
  "to": {
    "return": "string",
    "arguments": {}
  }
}

ForeignExchangeSnapshotQueryFilter: object

dateAfter:
dateBefore:
from:
organizationId:
to:
Example
{
  "dateAfter": "object",
  "dateBefore": "object",
  "from": "string",
  "organizationId": "object",
  "to": "string"
}

ForeignTaxInformation: object

Type detail for user's foreignTaxInformation

foreignTaxCountry:
object

Foreign Country for Tax

return:
arguments:
object
foreignTaxNumber:
object

Foreign Tax Number

return:
arguments:
object
Example
{
  "foreignTaxCountry": {
    "return": "string",
    "arguments": {}
  },
  "foreignTaxNumber": {
    "return": "string",
    "arguments": {}
  }
}

ForeignTaxInformationInput: object

Input Type for User's foreignTaxInformation

foreignTaxCountry:

Foreign Tax Country

foreignTaxNumber:

Foreign Tax Number

Example
{
  "foreignTaxCountry": "object",
  "foreignTaxNumber": "object"
}

FormAccountTypes: string

object
CASH_JOINT
object
CORPORATE_CASH
object
CORPORATE_CHARITY
object
CORPORATE_ESTATE
object
CORPORATE_TRUST
object
FHSA
object
GRSP
object
LIF
object
LIRA
object
LRIF
object
LRSP
object
PERSONAL
object
PRIF
object
RDSP
object
RESP
object
RESP_ADULT
object
RESP_FAMILY
object
RESP_FAMILY_JOINT
object
RESP_SINGLE
object
RESP_SINGLE_JOINT
object
RIF_SPOUSAL
object
RLIF
object
RLSP
object
RRIF
object
RRSP
object
RRSP_SPOUSAL
object
TFSA

FormAgreement: object

account:
object
return:
arguments:
object
allUsersSignedAt:
object
return:
arguments:
object
clientGroup:
object
return:
arguments:
object
displayName:
object
return:
arguments:
object
financialProduct:
object
return:
arguments:
object
goal:
object
return:
arguments:
object
id:
object
return:
arguments:
object
language:
object
return:
arguments:
object
scheduledTransfer:
object
return:
arguments:
object
signedAt:
object
return:
arguments:
object
signedUrl:
object
return:
arguments:
object
subAccount:
object
return:
arguments:
object
templateUrl:
object
return:
arguments:
object
translatedDisplayName:
object
return:
arguments:
object
type:
object
return:
arguments:
object
user:
object
return:
arguments:
object
usersRequiredToSign:
object
return:
UserRequiredToSign
arguments:
object
version:
object
return:
Int
arguments:
object
Example
{
  "account": {
    "return": {
      "affiliations": {
        "return": [
          {
            "allocation": {
              "return": "number",
              "arguments": {}
            },
            "id": {
              "return": "object",
              "arguments": {}
            },
            "relation": {
              "return": "string",
              "arguments": {}
            },
            "signatureRequired": {
              "return": "boolean",
              "arguments": {}
            },
            "type": {
              "return": "string",
              "arguments": {}
            },
            "user": {
              "return": {
                "accessibleBy": {
                  "return": [
                    {
                      "displayOptions": {
                        "return": {
                          "hide": {
                            "return": "boolean",
                            "arguments": {}
                          },
                          "order": {
                            "return": "number",
                            "arguments": {}
                          }
                        },
                        "arguments": {}
                      },
                      "organizationUser": {
                        "return": {
                          "accessType": {
                            "return": "string",
                            "arguments": {}
                          },
                          "apiTokens": {
                            "return": [
                              {
                                "id": {
                                  "return": "object",
                                  "arguments": {}
                                },
                                "jwtToken": {
                                  "return": "string",
                                  "arguments": {}
                                },
                                "name": {
                                  "return": "string",
                                  "arguments": {}
                                },
                                "organization": {
                                  "return": {
                                    "browserTabTitle": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "faviconLink": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "id": {
                                      "return": "object",
                                      "arguments": {}
                                    },
                                    "name": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "parent": {
                                      "return": {
                                        "browserTabTitle": {
                                          "return": "string",
                                          "arguments": {}
                                        },
                                        "faviconLink": {
                                          "return": "string",
                                          "arguments": {}
                                        }
                                      }
                                    }
                                  }
                                }
                              }
                            ]
                          }
                        }
                      }
                    }
                  ]
                }
              }
            }
          }
        ]
      }
    }
  }
}

FormAgreementInput: object

type:
version:
Int
Example
{
  "type": "string",
  "version": "number"
}

FormTemplate: object

digitalSignatureEnabled:
object
return:
arguments:
object
displayName:
object
return:
arguments:
object
id:
object
return:
arguments:
object
minVersion:
object
return:
Int
arguments:
object
organization:
object
return:
arguments:
object
state:
object
return:
arguments:
object
templateUrl:
object
return:
arguments:
object
textType:
object
return:
arguments:
object
translatedDisplayName:
object
return:
arguments:
object
translatedHtml:
object
return:
arguments:
object
translatedMarkdown:
object
return:
arguments:
object
type:
object
return:
arguments:
object
updatedAt:
object
return:
arguments:
object
uploadedAt:
object
return:
arguments:
object
url:
object
return:
arguments:
object
Example
{
  "digitalSignatureEnabled": {
    "return": "boolean",
    "arguments": {}
  },
  "displayName": {
    "return": "string",
    "arguments": {}
  },
  "id": {
    "return": "object",
    "arguments": {}
  },
  "minVersion": {
    "return": "number",
    "arguments": {}
  },
  "organization": {
    "return": {
      "accountTypeTaxRanks": {
        "return": [
          {
            "accountType": {
              "return": "string",
              "arguments": {}
            },
            "id": {
              "return": "object",
              "arguments": {}
            },
            "taxRank": {
              "return": "number",
              "arguments": {}
            }
          }
        ],
        "arguments": {}
      },
      "allowAccessToSubOrganizations": {
        "return": "boolean",
        "arguments": {}
      },
      "allowDirectCommunication": {
        "return": "boolean",
        "arguments": {}
      },
      "allowInactiveUserAdjustments": {
        "return": "boolean",
        "arguments": {}
      },
      "allowInactiveUserFeeCalculation": {
        "return": "boolean",
        "arguments": {}
      },
      "allowInactiveUserRebalancing": {
        "return": "boolean",
        "arguments": {}
      },
      "allowInstantInvest": {
        "return": "boolean",
        "arguments": {}
      },
      "allowPortfolioPerGoal": {
        "return": "boolean",
        "arguments": {}
      },
      "allowPostOptimizationEditing": {
        "return": "boolean",
        "arguments": {}
      },
      "allowViewSubTradeRequestPairs": {
        "return": "boolean",
        "arguments": {}
      },
      "applicableJurisdictions": {
        "return": {
          "all": {
            "return": "boolean",
            "arguments": {}
          },
          "only": {
            "return": [
              "string"
            ],
            "arguments": {}
          }
        },
        "arguments": {}
      },
      "applicableLocalization": {
        "return": {
          "countries": {
            "return": [
              "string"
            ],
            "arguments": {}
          },
          "dateFormat": {
            "return": "string",
            "arguments": {}
          },
          "defaultCurrency": {}
        }
      }
    }
  }
}

FormTemplateStates: string

object
ACTIVE
object
ARCHIVED
object
DRAFT

FormTemplatesPaginationAndSorting: object

offSet:
Int
perPage:
Int
sortDesc:
sortField:
Example
{
  "offSet": "number",
  "perPage": "number",
  "sortDesc": "boolean",
  "sortField": "string"
}

FormTemplatesQueryFilter: object

formType:
minVersion:
Int
name:
organizationId:
states:
FormTemplateStates
Example
{
  "formType": "string",
  "minVersion": "number",
  "name": "string",
  "organizationId": "object",
  "states": [
    "string"
  ]
}

FormTypes: string

object
ARTICLES_OF_INCORPORATION_OR_EQUIVALENT
object
BENEFICIARY_DESIGNATION_FORM
object
BENEFICIARY_RRSP
object
BENEFICIARY_TFSA
object
CLB_FOR_ADULTS
object
CLIENT_ACCOUNT_AGREEMENT
object
CORPORATE_ACCOUNT_AGREEMENT
object
CORPORATE_RESOLUTION
object
DEATH_CERTIFICATE
object
DECLARATION_OF_TAX_DISCLOSURE
object
DECLARATION_OF_TAX_DISCLOSURE_E
object
DISCRETIONARY_MANAGEMENT_AGREEMENT
object
EDUCATION_SAVINGS_GRANTS_APPLICATION
object
ELECTRONIC_DELIVERY_AGREEMENT
object
EXTERNAL_TRANSFER_TO_NON_REGISTERED_ACCOUNTS
object
EXTERNAL_TRANSFER_TO_REGISTERED_ACCOUNTS
object
FEE_REDIRECTION
object
FHSA
object
GOAL_INVESTMENT_POLICY_STATEMENT
object
INVESTMENT_POLICY_STATEMENT
object
JOINT_CLIENT_ACCOUNT_AGREEMENT
object
LAST_WILL
object
LIF
object
LIF_ADDENDUM
object
LIRA
object
LIRA_ADDENDUM
object
LOD_QESI
object
LRIF
object
LRIF_ADDENDUM
object
LRSP
object
LRSP_ADDENDUM
object
NON_INDIVIDUAL_ENTITY_ACCOUNT_AGREEMENT
object
ONEVEST_RELATIONSHIP_DISCLOSURE_BROCHURE
object
PAD_AGREEMENT
object
PRIF
object
PRIF_ADDENDUM
object
RESP_FAMILY_PLAN
object
RESP_SINGLE_PLAN
object
RIF_SPOUSAL
object
RLIF
object
RLIF_ADDENDUM
object
RLSP
object
RLSP_ADDENDUM
object
RRIF
object
RRSP
object
RRSP_SPOUSAL
object
SWP_AGREEMENT
object
TFSA
object
TRUST_AGREEMENT
object
TRUST_DEED
object
TRUST_PARTICIPANT_IDENTIFICATION_FORM
object
W8BEN
object
W9
object
WAIVER_OF_CONFIDENTIALITY
object
W_8BEN_E
object
W_8IMY

FraudRisk: object

id:
object
return:
arguments:
object
lastUpdatedBy:
object
return:
arguments:
object
notes:
object
return:
arguments:
object
riskReasons:
object
return:
RiskReason
arguments:
object
score:
object
return:
Int
arguments:
object
user:
object
return:
arguments:
object
Example
{
  "id": {
    "return": "object",
    "arguments": {}
  },
  "lastUpdatedBy": {
    "return": "string",
    "arguments": {}
  },
  "notes": {
    "return": "string",
    "arguments": {}
  },
  "riskReasons": {
    "return": [
      {
        "countryRisk": {
          "return": {
            "country": {
              "return": "object",
              "arguments": {}
            },
            "countryCode": {
              "return": "object",
              "arguments": {}
            },
            "disabled": {
              "return": "boolean",
              "arguments": {}
            },
            "id": {
              "return": "object",
              "arguments": {}
            },
            "riskRating": {
              "return": "string",
              "arguments": {}
            }
          },
          "arguments": {}
        },
        "id": {
          "return": "object",
          "arguments": {}
        },
        "jobTitleRisk": {
          "return": {
            "companyType": {
              "return": "object",
              "arguments": {}
            },
            "disabled": {
              "return": "boolean",
              "arguments": {}
            },
            "id": {
              "return": "object",
              "arguments": {}
            },
            "jobTitle": {
              "return": "object",
              "arguments": {}
            },
            "riskRating": {
              "return": "string",
              "arguments": {}
            }
          },
          "arguments": {}
        },
        "name": {
          "return": "string",
          "arguments": {}
        },
        "riskRating": {
          "return": "string",
          "arguments": {}
        },
        "translatedDescription": {
          "return": {
            "en": {
              "return": "string",
              "arguments": {}
            },
            "fr": {
              "return": "string",
              "arguments": {}
            }
          },
          "arguments": {}
        },
        "translatedDisplayName": {
          "return": {
            "en": {
              "return": "string",
              "arguments": {}
            },
            "fr": {
              "return": "string",
              "arguments": {}
            }
          }
        }
      }
    ]
  }
}

Frequency: string

object
BI_WEEKLY
object
DAILY
object
LAST_DAY_OF_THE_MONTH
object
MONTHLY
object
ONE_TIME
object
QUARTERLY
object
SEMI_MONTHLY
object
WEEKLY

GenerateAnnualPerformanceReportInput: object

accountId:
referenceDate:
regenerateData:
Example
{
  "accountId": "object",
  "referenceDate": "object",
  "regenerateData": "boolean"
}

GenerateAnnualPerformanceReportResponse: object

accountId:
object
return:
arguments:
object
accountStatementId:
object
return:
arguments:
object
annualPerformanceReportId:
object
return:
arguments:
object
Example
{
  "accountId": {
    "return": "object",
    "arguments": {}
  },
  "accountStatementId": {
    "return": "object",
    "arguments": {}
  },
  "annualPerformanceReportId": {
    "return": "object",
    "arguments": {}
  }
}

GenerateBulkTradesInput: object

autoFillActualQuantity:
forceActualQuantityFUNDSERV:
organizationId:
portfolioOptimizerId:
Example
{
  "autoFillActualQuantity": "boolean",
  "forceActualQuantityFUNDSERV": "boolean",
  "organizationId": "object",
  "portfolioOptimizerId": "object"
}

GenerateBulkTradesResponse: object

bulkTradeRun:
object
return:
arguments:
object
Example
{
  "bulkTradeRun": {
    "return": {
      "allTradeRequestsByExchange": {
        "return": [
          {
            "exchange": {
              "return": "string",
              "arguments": {}
            },
            "total": {
              "return": "number",
              "arguments": {}
            }
          }
        ],
        "arguments": {}
      },
      "allocationFileUrls": {
        "return": [
          "string"
        ],
        "arguments": {}
      },
      "autoFillActualQuantity": {
        "return": "boolean",
        "arguments": {}
      },
      "bulkMutualFundTrades": {
        "return": [
          {
            "currency": {
              "return": "string",
              "arguments": {}
            },
            "exchange": {
              "return": "string",
              "arguments": {}
            },
            "id": {
              "return": "object",
              "arguments": {}
            },
            "moneyAllocatedCents": {
              "return": "number",
              "arguments": {}
            },
            "ticker": {
              "return": "string",
              "arguments": {}
            },
            "type": {
              "return": "string",
              "arguments": {}
            }
          }
        ],
        "arguments": {}
      },
      "bulkPTFFileUrls": {
        "return": [
          "string"
        ],
        "arguments": {}
      },
      "bulkTradeRequests": {
        "return": [
          {
            "bulkTrades": {
              "return": [
                {
                  "_id": {
                    "return": "string",
                    "arguments": {}
                  },
                  "actualTotal": {
                    "return": "number",
                    "arguments": {}
                  },
                  "actualTradePriceCents": {
                    "return": "number",
                    "arguments": {}
                  },
                  "actualTradePriceInCurrencyCents": {
                    "return": "number",
                    "arguments": {}
                  },
                  "currency": {
                    "return": "string",
                    "arguments": {}
                  },
                  "exchange": {
                    "return": "string",
                    "arguments": {}
                  },
                  "expectedTradePriceCents": {
                    "return": "number",
                    "arguments": {}
                  },
                  "expectedTradePriceInCurrencyCents": {
                    "return": "number",
                    "arguments": {}
                  }
                }
              ]
            }
          }
        ]
      }
    }
  }
}

GenerateClientReportInput: object

objectId:
referenceDate:
templateId:
Example
{
  "objectId": "object",
  "referenceDate": "object",
  "templateId": "object"
}

GenerateClientReportResponse: object

clientReport:
object
return:
arguments:
object
Example
{
  "clientReport": {
    "return": {
      "createdAt": {
        "return": "object",
        "arguments": {}
      },
      "entity": {
        "return": {
          "accessibleBy": {
            "return": [
              {
                "displayOptions": {
                  "return": {
                    "hide": {
                      "return": "boolean",
                      "arguments": {}
                    },
                    "order": {
                      "return": "number",
                      "arguments": {}
                    }
                  },
                  "arguments": {}
                },
                "organizationUser": {
                  "return": {
                    "accessType": {
                      "return": "string",
                      "arguments": {}
                    },
                    "apiTokens": {
                      "return": [
                        {
                          "id": {
                            "return": "object",
                            "arguments": {}
                          },
                          "jwtToken": {
                            "return": "string",
                            "arguments": {}
                          },
                          "name": {
                            "return": "string",
                            "arguments": {}
                          },
                          "organization": {
                            "return": {
                              "browserTabTitle": {
                                "return": "string",
                                "arguments": {}
                              },
                              "faviconLink": {
                                "return": "string",
                                "arguments": {}
                              },
                              "id": {
                                "return": "object",
                                "arguments": {}
                              },
                              "name": {
                                "return": "string",
                                "arguments": {}
                              },
                              "parent": {
                                "return": {
                                  "browserTabTitle": {
                                    "return": "string",
                                    "arguments": {}
                                  },
                                  "faviconLink": {
                                    "return": "string",
                                    "arguments": {}
                                  },
                                  "id": {
                                    "return": "object",
                                    "arguments": {}
                                  },
                                  "name": {
                                    "return": "string",
                                    "arguments": {}
                                  },
                                  "parent": {
                                    "return": {
                                      "browserTabTitle": {
                                        "return": "string",
                                        "arguments": {}
                                      },
                                      "faviconLink": {
                                        "return": "string",
                                        "arguments": {}
                                      },
                                      "id": {}
                                    }
                                  }
                                }
                              }
                            }
                          }
                        }
                      ]
                    }
                  }
                }
              }
            ]
          }
        }
      }
    }
  }
}

GenerateMonthlyAccountStatementInput: object

accountId:
referenceDate:
regenerateData:
Example
{
  "accountId": "object",
  "referenceDate": "object",
  "regenerateData": "boolean"
}

GenerateMonthlyAccountStatementResponse: object

accountId:
object
return:
arguments:
object
accountStatementId:
object
return:
arguments:
object
monthlyAccountStatementId:
object
return:
arguments:
object
Example
{
  "accountId": {
    "return": "object",
    "arguments": {}
  },
  "accountStatementId": {
    "return": "object",
    "arguments": {}
  },
  "monthlyAccountStatementId": {
    "return": "object",
    "arguments": {}
  }
}

GenerateReportInput: object

columns:
String
filters:
ReportFilterInput
grouping:
pagination:
sorting:
type:
Example
{
  "columns": [
    "string"
  ],
  "filters": [
    {
      "comparison": "string",
      "field": "string",
      "value": "string"
    }
  ],
  "grouping": {
    "field": "string",
    "interval": "string",
    "type": "string",
    "valueAggregation": "string",
    "valueField": "string"
  },
  "pagination": {
    "page": "number",
    "perPage": "number"
  },
  "sorting": {
    "sortDesc": "boolean",
    "sortField": "string"
  },
  "type": "string"
}

GenerateReportResponse: object

columns:
object
return:
String
arguments:
object
data:
object
return:
object[][]
arguments:
object
grouping:
object
return:
arguments:
object
totalCount:
object
return:
Int
arguments:
object
Example
{
  "columns": {
    "return": [
      "string"
    ],
    "arguments": {}
  },
  "data": {
    "return": [
      [
        "string"
      ]
    ],
    "arguments": {}
  },
  "grouping": {
    "return": "object",
    "arguments": {}
  },
  "totalCount": {
    "return": "number",
    "arguments": {}
  }
}

GoToSubStepInput: object

subStepId:
workflowCompletionId:
Example
{
  "subStepId": "object",
  "workflowCompletionId": "object"
}

GoToSubStepResponse: object

workflowCompletion:
object
return:
arguments:
object
Example
{
  "workflowCompletion": {
    "return": {
      "context": {
        "return": "object",
        "arguments": {}
      },
      "createdAt": {
        "return": "object",
        "arguments": {}
      },
      "currentStep": {
        "return": {
          "id": {
            "return": "object",
            "arguments": {}
          },
          "name": {
            "return": {
              "en": {
                "return": "string",
                "arguments": {}
              },
              "fr": {
                "return": "string",
                "arguments": {}
              }
            },
            "arguments": {}
          },
          "subSteps": {
            "return": [
              {
                "canGoBack": {
                  "return": "boolean",
                  "arguments": {}
                },
                "completeableBy": {
                  "return": [
                    "string"
                  ],
                  "arguments": {}
                },
                "id": {
                  "return": "object",
                  "arguments": {}
                },
                "options": {
                  "return": "object",
                  "arguments": {}
                },
                "rolesCompleteableBy": {
                  "return": [
                    {
                      "accessiblePages": {
                        "return": [
                          "string"
                        ],
                        "arguments": {}
                      },
                      "accountPageConfiguration": {
                        "return": {
                          "createdAt": {
                            "return": "object",
                            "arguments": {}
                          },
                          "id": {
                            "return": "object",
                            "arguments": {}
                          },
                          "name": {
                            "return": "string",
                            "arguments": {}
                          },
                          "options": {
                            "return": "object",
                            "arguments": {}
                          },
                          "organization": {
                            "return": {
                              "accountTypeTaxRanks": {
                                "return": [
                                  {
                                    "accountType": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "id": {
                                      "return": "object",
                                      "arguments": {}
                                    },
                                    "taxRank": {
                                      "return": "number",
                                      "arguments": {}
                                    }
                                  }
                                ],
                                "arguments": {}
                              }
                            }
                          }
                        }
                      }
                    }
                  ]
                }
              }
            ]
          }
        }
      }
    }
  }
}

Goal: object

availableFinancialProducts:
object
return:
FinancialProduct
arguments:
object
availableThemes:
object
return:
Theme
arguments:
object
calculatedSuitabilityScore:
object

The lower of the user and goal suitability score.

return:
Int
arguments:
object
clientGroup:
object
return:
arguments:
object
custodianSuitabilityScore:
object
return:
arguments:
object
customFields:
object
return:
CustomFieldValue
arguments:
object
keys:
String
expectedAnnualIncomeCents:
object
return:
arguments:
object
financialProduct:
object
return:
arguments:
object
householdClientGroup:
object
return:
arguments:
object
id:
object
return:
arguments:
object
incompleteFormAgreements:
object

Lists remaining forms to be signed for this goal.

return:
IncompleteFormAgreement
arguments:
object
integrations:
object
return:
GoalIntegration
arguments:
object
lastUpdatedBy:
object
return:
arguments:
object
latestFormAgreements:
object

Lists latest signed forms for this goal.

return:
FormAgreement
arguments:
object
name:
object
return:
arguments:
object
organization:
object
return:
arguments:
object
pendingAgreementSignature:
object

Indicates whether there is a pending agreement to be signed.

return:
arguments:
object
retirementAge:
object
return:
Int
arguments:
object
riskQuestion1:
object
return:
arguments:
object
state:
object
return:
arguments:
object
statistics:
object
return:
arguments:
object
forUserId:
input:
stats:
object
return:
arguments:
object
force:

Force cache miss. Re-calculates statistics with current data.

statsV2:
object
return:
arguments:
object
subAccounts:
object
return:
SubAccount
arguments:
object
suggestedFinancialProduct:
object
return:
arguments:
object
themeId:
suitabilityScore:
object
return:
Int
arguments:
object
targetAmountCents:
object
return:
arguments:
object
targetDate:
object
return:
arguments:
object
taxOptimized:
object
return:
arguments:
object
timeHorizon:
object
return:
arguments:
object
tradingProcess:
object
return:
arguments:
object
type:
object
return:
arguments:
object
user:
object
return:
arguments:
object
Example
{
  "availableFinancialProducts": {
    "return": [
      {
        "assignable": {
          "return": "boolean",
          "arguments": {}
        },
        "autoUpdatePrices": {
          "return": "boolean",
          "arguments": {}
        },
        "children": {
          "return": [
            {
              "financialProduct": {
                "return": {
                  "assignable": {
                    "return": "boolean",
                    "arguments": {}
                  },
                  "autoUpdatePrices": {
                    "return": "boolean",
                    "arguments": {}
                  },
                  "children": {
                    "return": [
                      {
                        "financialProduct": {
                          "return": {
                            "assignable": {
                              "return": "boolean",
                              "arguments": {}
                            },
                            "autoUpdatePrices": {
                              "return": "boolean",
                              "arguments": {}
                            },
                            "children": {
                              "return": [
                                {
                                  "financialProduct": {
                                    "return": {
                                      "assignable": {
                                        "return": "boolean",
                                        "arguments": {}
                                      },
                                      "autoUpdatePrices": {
                                        "return": "boolean",
                                        "arguments": {}
                                      },
                                      "children": {
                                        "return": [
                                          {
                                            "financialProduct": {
                                              "return": {
                                                "assignable": {
                                                  "return": "boolean",
                                                  "arguments": {}
                                                },
                                                "autoUpdatePrices": {
                                                  "return": "boolean",
                                                  "arguments": {}
                                                },
                                                "children": {
                                                  "return": [
                                                    {
                                                      "financialProduct": {
                                                        "return": {
                                                          "assignable": {
                                                            "return": "boolean",
                                                            "arguments": {}
                                                          },
                                                          "autoUpdatePrices": {
                                                            "return": "boolean",
                                                            "arguments": {}
                                                          },
                                                          "children": {
                                                            "return": [
                                                              {
                                                                "financialProduct": {
                                                                  "return": {
                                                                    "assignable": {
                                                                      "return": "boolean",
                                                                      "arguments": {}
                                                                    },
                                                                    "autoUpdatePrices": {}
                                                                  }
                                                                }
                                                              }
                                                            ]
                                                          }
                                                        }
                                                      }
                                                    }
                                                  ]
                                                }
                                              }
                                            }
                                          }
                                        ]
                                      }
                                    }
                                  }
                                }
                              ]
                            }
                          }
                        }
                      }
                    ]
                  }
                }
              }
            }
          ]
        }
      }
    ]
  }
}

GoalIntegration: object

The integration enum and unique integration id

iid:
object

The id for the entity, in the given specific integration

return:
arguments:
object
type:
object

Enumeration for the integration type

return:
arguments:
object
Example
{
  "iid": {
    "return": "string",
    "arguments": {}
  },
  "type": {
    "return": "string",
    "arguments": {}
  }
}

GoalIntegrationInput: object

Input type for integrations field

externalId:

externalId external source id

groupId:

group id the custodian connection

iid:

iid is the unique identifier for this entity in the given integration

type:

Integrations type derives from enumeration

Example
{
  "externalId": "object",
  "groupId": "object",
  "iid": "object",
  "type": "string"
}

GoalIntegrationTypes: string

Integrations for Goal

object
APEX
object
CIBC_MELLON
object
CIIS
object
ENVESTNET
object
FC
object
FUNDSERV
object
IBKR
object
NBIN
object
NO_CONNECTION
object
PERSHING
object
RBC
object
SALESFORCE
object
SCHWAB
object
TEMPLATE

GoalPaginationAndSorting: object

offSet:
Int
perPage:
Int
sortDesc:
sortField:
Example
{
  "offSet": "number",
  "perPage": "number",
  "sortDesc": "boolean",
  "sortField": "string"
}

GoalQueryFilter: object

clientGroupId:
customFields:
CustomFieldInput
includeHousehold:
organizationId:
riskQuestion1:
state:
states:
GoalStates
targetDateAfter:
targetDateBefore:
timeHorizon:
type:
userId:
Example
{
  "clientGroupId": "object",
  "customFields": [
    {
      "key": "object",
      "value": "object"
    }
  ],
  "includeHousehold": "boolean",
  "organizationId": "object",
  "riskQuestion1": "string",
  "state": "string",
  "states": [
    "string"
  ],
  "targetDateAfter": "object",
  "targetDateBefore": "object",
  "timeHorizon": "string",
  "type": "string",
  "userId": "object"
}

GoalRiskLevels: string

object
LEVEL_1
object
LEVEL_2
object
LEVEL_3
object
LEVEL_4
object
LEVEL_5

GoalStates: string

object
ACTIVE
object
ARCHIVED
object
COMPLETED

GoalStats: object

availableFundsToWithdrawCents:
object
return:
arguments:
object
cashOnHoldToTradeCents:
object
return:
arguments:
object
cashOnHoldToWithdrawCents:
object
return:
arguments:
object
goal:
object
return:
arguments:
object
holdings:
object
return:
DailySnapshotHolding
arguments:
object
marketValueCents:
object
return:
arguments:
object
moneyAvailableCents:
object
return:
arguments:
object
moneyWeightedReturn:
object
return:
arguments:
object
endDate:
startDate:
netContributionCents:
object
return:
arguments:
object
newContributionCents:
object
return:
arguments:
object
pendingContributionCents:
object
return:
arguments:
object
simpleReturnAmount:
object
return:
arguments:
object
endDate:
startDate:
simpleReturnPercent:
object
return:
arguments:
object
endDate:
startDate:
timeWeightedReturn:
object
return:
arguments:
object
endDate:
startDate:
Example
{
  "availableFundsToWithdrawCents": {
    "return": "object",
    "arguments": {}
  },
  "cashOnHoldToTradeCents": {
    "return": "object",
    "arguments": {}
  },
  "cashOnHoldToWithdrawCents": {
    "return": "object",
    "arguments": {}
  },
  "goal": {
    "return": "object",
    "arguments": {}
  },
  "holdings": {
    "return": [
      {
        "currentPriceCents": {
          "return": "number",
          "arguments": {}
        },
        "financialProduct": {
          "return": {
            "assignable": {
              "return": "boolean",
              "arguments": {}
            },
            "autoUpdatePrices": {
              "return": "boolean",
              "arguments": {}
            },
            "children": {
              "return": [
                {
                  "financialProduct": {
                    "return": {
                      "assignable": {
                        "return": "boolean",
                        "arguments": {}
                      },
                      "autoUpdatePrices": {
                        "return": "boolean",
                        "arguments": {}
                      },
                      "children": {
                        "return": [
                          {
                            "financialProduct": {
                              "return": {
                                "assignable": {
                                  "return": "boolean",
                                  "arguments": {}
                                },
                                "autoUpdatePrices": {
                                  "return": "boolean",
                                  "arguments": {}
                                },
                                "children": {
                                  "return": [
                                    {
                                      "financialProduct": {
                                        "return": {
                                          "assignable": {
                                            "return": "boolean",
                                            "arguments": {}
                                          },
                                          "autoUpdatePrices": {
                                            "return": "boolean",
                                            "arguments": {}
                                          },
                                          "children": {
                                            "return": [
                                              {
                                                "financialProduct": {
                                                  "return": {
                                                    "assignable": {
                                                      "return": "boolean",
                                                      "arguments": {}
                                                    },
                                                    "autoUpdatePrices": {
                                                      "return": "boolean",
                                                      "arguments": {}
                                                    },
                                                    "children": {
                                                      "return": [
                                                        {}
                                                      ]
                                                    }
                                                  }
                                                }
                                              }
                                            ]
                                          }
                                        }
                                      }
                                    }
                                  ]
                                }
                              }
                            }
                          }
                        ]
                      }
                    }
                  }
                }
              ]
            }
          }
        }
      }
    ]
  }
}

GoalTimeHorizons: string

object
LONG_TERM
object
MID_TERM
object
SHORT_TERM
object
VERY_LONG_TERM
object
VERY_SHORT_TERM

GoalTradingProcesses: string

object
NO_AUTOMATION
object
PORTFOLIO_OPTIMIZER

GoalTypes: string

object
BUILD_WEALTH
object
CAR
object
CASH_RESERVE
object
EDUCATION
object
GROUP
object
HOUSE
object
LEGACY
object
MAJOR_PURCHASE
object
OTHER
object
PARENTAL_LEAVE
object
RETIREMENT
object
RETIREMENT_INCOME
object
SAFETY_NET
object
START_A_BUSINESS
object
VACATION
object
WEDDING

GoalUpdate: object

d:
object
return:
arguments:
object
id:
object
return:
arguments:
object
o:
object
return:
arguments:
object
t:
object
return:
arguments:
object
Example
{
  "d": {
    "return": "string",
    "arguments": {}
  },
  "id": {
    "return": "object",
    "arguments": {}
  },
  "o": {
    "return": "string",
    "arguments": {}
  },
  "t": {
    "return": "object",
    "arguments": {}
  }
}

GoalUpdatePaginationAndSorting: object

offSet:
Int
perPage:
Int
sortDesc:
Example
{
  "offSet": "number",
  "perPage": "number",
  "sortDesc": "boolean"
}

GoalsDaily: object

date:
object
return:
arguments:
object
goal:
object
return:
arguments:
object
holdings:
object
return:
Holding
arguments:
object
id:
object
return:
arguments:
object
marketValueCents:
object
return:
arguments:
object
moneyAvailableCents:
object
return:
arguments:
object
netContributionCents:
object
return:
arguments:
object
newContributionCents:
object
return:
arguments:
object
Example
{
  "date": {
    "return": "object",
    "arguments": {}
  },
  "goal": {
    "return": {
      "availableFinancialProducts": {
        "return": [
          {
            "assignable": {
              "return": "boolean",
              "arguments": {}
            },
            "autoUpdatePrices": {
              "return": "boolean",
              "arguments": {}
            },
            "children": {
              "return": [
                {
                  "financialProduct": {
                    "return": {
                      "assignable": {
                        "return": "boolean",
                        "arguments": {}
                      },
                      "autoUpdatePrices": {
                        "return": "boolean",
                        "arguments": {}
                      },
                      "children": {
                        "return": [
                          {
                            "financialProduct": {
                              "return": {
                                "assignable": {
                                  "return": "boolean",
                                  "arguments": {}
                                },
                                "autoUpdatePrices": {
                                  "return": "boolean",
                                  "arguments": {}
                                },
                                "children": {
                                  "return": [
                                    {
                                      "financialProduct": {
                                        "return": {
                                          "assignable": {
                                            "return": "boolean",
                                            "arguments": {}
                                          },
                                          "autoUpdatePrices": {
                                            "return": "boolean",
                                            "arguments": {}
                                          },
                                          "children": {
                                            "return": [
                                              {
                                                "financialProduct": {
                                                  "return": {
                                                    "assignable": {
                                                      "return": "boolean",
                                                      "arguments": {}
                                                    },
                                                    "autoUpdatePrices": {
                                                      "return": "boolean",
                                                      "arguments": {}
                                                    },
                                                    "children": {
                                                      "return": [
                                                        {
                                                          "financialProduct": {
                                                            "return": {
                                                              "assignable": {
                                                                "return": "boolean",
                                                                "arguments": {}
                                                              },
                                                              "autoUpdatePrices": {
                                                                "return": "boolean",
                                                                "arguments": {}
                                                              },
                                                              "children": {
                                                                "return": [
                                                                  {
                                                                    "financialProduct": {}
                                                                  }
                                                                ]
                                                              }
                                                            }
                                                          }
                                                        }
                                                      ]
                                                    }
                                                  }
                                                }
                                              }
                                            ]
                                          }
                                        }
                                      }
                                    }
                                  ]
                                }
                              }
                            }
                          }
                        ]
                      }
                    }
                  }
                }
              ]
            }
          }
        ]
      }
    }
  }
}

GroupedBilling: object

accounts:
object
return:
AccountBilling
arguments:
object
clientGroup:
object
return:
arguments:
object
id:
object
return:
arguments:
object
user:
object
return:
arguments:
object
users:
object
return:
UserBilling
arguments:
object
Example
{
  "accounts": {
    "return": [
      {
        "account": {
          "return": {
            "affiliations": {
              "return": [
                {
                  "allocation": {
                    "return": "number",
                    "arguments": {}
                  },
                  "id": {
                    "return": "object",
                    "arguments": {}
                  },
                  "relation": {
                    "return": "string",
                    "arguments": {}
                  },
                  "signatureRequired": {
                    "return": "boolean",
                    "arguments": {}
                  },
                  "type": {
                    "return": "string",
                    "arguments": {}
                  },
                  "user": {
                    "return": {
                      "accessibleBy": {
                        "return": [
                          {
                            "displayOptions": {
                              "return": {
                                "hide": {
                                  "return": "boolean",
                                  "arguments": {}
                                },
                                "order": {
                                  "return": "number",
                                  "arguments": {}
                                }
                              },
                              "arguments": {}
                            },
                            "organizationUser": {
                              "return": {
                                "accessType": {
                                  "return": "string",
                                  "arguments": {}
                                },
                                "apiTokens": {
                                  "return": [
                                    {
                                      "id": {
                                        "return": "object",
                                        "arguments": {}
                                      },
                                      "jwtToken": {
                                        "return": "string",
                                        "arguments": {}
                                      },
                                      "name": {
                                        "return": "string",
                                        "arguments": {}
                                      },
                                      "organization": {
                                        "return": {
                                          "browserTabTitle": {
                                            "return": "string",
                                            "arguments": {}
                                          },
                                          "faviconLink": {
                                            "return": "string",
                                            "arguments": {}
                                          },
                                          "id": {
                                            "return": "object",
                                            "arguments": {}
                                          },
                                          "name": {
                                            "return": "string",
                                            "arguments": {}
                                          },
                                          "parent": {
                                            "return": {
                                              "browserTabTitle": {
                                                "return": "string",
                                                "arguments": {}
                                              }
                                            }
                                          }
                                        }
                                      }
                                    }
                                  ]
                                }
                              }
                            }
                          }
                        ]
                      }
                    }
                  }
                }
              ]
            }
          }
        }
      }
    ]
  }
}

GroupingInterval: string

object
DAY
object
MONTH
object
WEEK
object
YEAR

GroupingType: string

object
DATE
object
FIRST_DATE_IN_INTERVAL
object
GROUPING
object
SINGLE_VALUE

GroupingValueAggregation: string

object
AVG
object
MAX
object
MIN
object
SUM
object
VALUE_COUNT

HistoryAccountType: string

object
CASH_JOINT
object
CORPORATE_CASH
object
CORPORATE_CHARITY
object
CORPORATE_ESTATE
object
CORPORATE_TRUST
object
GRSP
object
LIF
object
LIRA
object
LRIF
object
LRSP
object
PERSONAL
object
PRIF
object
RDSP
object
RESP
object
RESP_ADULT
object
RESP_FAMILY
object
RESP_SINGLE
object
RIF_SPOUSAL
object
RLIF
object
RLSP
object
RRIF
object
RRSP
object
RRSP_SPOUSAL
object
TFSA

HistoryResponse:

Example

Holding: object

currentPriceCents:
object
return:
Int
arguments:
object
financialProduct:
object
return:
arguments:
object
id:
object
return:
arguments:
object
quantity:
object
return:
arguments:
object
Example
{
  "currentPriceCents": {
    "return": "number",
    "arguments": {}
  },
  "financialProduct": {
    "return": {
      "assignable": {
        "return": "boolean",
        "arguments": {}
      },
      "autoUpdatePrices": {
        "return": "boolean",
        "arguments": {}
      },
      "children": {
        "return": [
          {
            "financialProduct": {
              "return": {
                "assignable": {
                  "return": "boolean",
                  "arguments": {}
                },
                "autoUpdatePrices": {
                  "return": "boolean",
                  "arguments": {}
                },
                "children": {
                  "return": [
                    {
                      "financialProduct": {
                        "return": {
                          "assignable": {
                            "return": "boolean",
                            "arguments": {}
                          },
                          "autoUpdatePrices": {
                            "return": "boolean",
                            "arguments": {}
                          },
                          "children": {
                            "return": [
                              {
                                "financialProduct": {
                                  "return": {
                                    "assignable": {
                                      "return": "boolean",
                                      "arguments": {}
                                    },
                                    "autoUpdatePrices": {
                                      "return": "boolean",
                                      "arguments": {}
                                    },
                                    "children": {
                                      "return": [
                                        {
                                          "financialProduct": {
                                            "return": {
                                              "assignable": {
                                                "return": "boolean",
                                                "arguments": {}
                                              },
                                              "autoUpdatePrices": {
                                                "return": "boolean",
                                                "arguments": {}
                                              },
                                              "children": {
                                                "return": [
                                                  {
                                                    "financialProduct": {
                                                      "return": {
                                                        "assignable": {
                                                          "return": "boolean",
                                                          "arguments": {}
                                                        },
                                                        "autoUpdatePrices": {
                                                          "return": "boolean",
                                                          "arguments": {}
                                                        },
                                                        "children": {
                                                          "return": [
                                                            {
                                                              "financialProduct": {
                                                                "return": {
                                                                  "assignable": {}
                                                                }
                                                              }
                                                            }
                                                          ]
                                                        }
                                                      }
                                                    }
                                                  }
                                                ]
                                              }
                                            }
                                          }
                                        }
                                      ]
                                    }
                                  }
                                }
                              }
                            ]
                          }
                        }
                      }
                    }
                  ]
                }
              }
            }
          }
        ]
      }
    }
  }
}

HoldingAccountTypes: string

object
CASH_JOINT
object
CORPORATE_CASH
object
CORPORATE_CHARITY
object
CORPORATE_ESTATE
object
CORPORATE_TRUST
object
GRSP
object
LIF
object
LIRA
object
LRIF
object
LRSP
object
PERSONAL
object
PRIF
object
RDSP
object
RESP
object
RESP_ADULT
object
RESP_FAMILY
object
RESP_FAMILY_JOINT
object
RESP_SINGLE
object
RESP_SINGLE_JOINT
object
RIF_SPOUSAL
object
RLIF
object
RLSP
object
RRIF
object
RRSP
object
RRSP_SPOUSAL
object
TFSA

HoldingReport: object

actualPercentage:
object
return:
arguments:
object
expectedPercentage:
object
return:
arguments:
object
expectedValueCents:
object
return:
Int
arguments:
object
financialProduct:
object
return:
arguments:
object
isPartial:
object
return:
arguments:
object
quantity:
object
return:
arguments:
object
ticker:
object
return:
arguments:
object
valueCents:
object
return:
Int
arguments:
object
Example
{
  "actualPercentage": {
    "return": "number",
    "arguments": {}
  },
  "expectedPercentage": {
    "return": "number",
    "arguments": {}
  },
  "expectedValueCents": {
    "return": "number",
    "arguments": {}
  },
  "financialProduct": {
    "return": {
      "assignable": {
        "return": "boolean",
        "arguments": {}
      },
      "autoUpdatePrices": {
        "return": "boolean",
        "arguments": {}
      },
      "children": {
        "return": [
          {
            "financialProduct": {
              "return": {
                "assignable": {
                  "return": "boolean",
                  "arguments": {}
                },
                "autoUpdatePrices": {
                  "return": "boolean",
                  "arguments": {}
                },
                "children": {
                  "return": [
                    {
                      "financialProduct": {
                        "return": {
                          "assignable": {
                            "return": "boolean",
                            "arguments": {}
                          },
                          "autoUpdatePrices": {
                            "return": "boolean",
                            "arguments": {}
                          },
                          "children": {
                            "return": [
                              {
                                "financialProduct": {
                                  "return": {
                                    "assignable": {
                                      "return": "boolean",
                                      "arguments": {}
                                    },
                                    "autoUpdatePrices": {
                                      "return": "boolean",
                                      "arguments": {}
                                    },
                                    "children": {
                                      "return": [
                                        {
                                          "financialProduct": {
                                            "return": {
                                              "assignable": {
                                                "return": "boolean",
                                                "arguments": {}
                                              },
                                              "autoUpdatePrices": {
                                                "return": "boolean",
                                                "arguments": {}
                                              },
                                              "children": {
                                                "return": [
                                                  {
                                                    "financialProduct": {
                                                      "return": {
                                                        "assignable": {
                                                          "return": "boolean",
                                                          "arguments": {}
                                                        },
                                                        "autoUpdatePrices": {
                                                          "return": "boolean",
                                                          "arguments": {}
                                                        },
                                                        "children": {}
                                                      }
                                                    }
                                                  }
                                                ]
                                              }
                                            }
                                          }
                                        }
                                      ]
                                    }
                                  }
                                }
                              }
                            ]
                          }
                        }
                      }
                    }
                  ]
                }
              }
            }
          }
        ]
      }
    }
  }
}

ID: object

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
object

IdDocumentTypes: string

Indicates the Document type for the DIGITAL_DOCUMENT_CHECK method

object
BANK_STATEMENT
object
BENEFITS_STATEMENT
object
BIRTH_CERTIFICATE
object
CAD_CREDIT_BUREAU_PRODUCT
object
CANADA_411
object
CITIZENSHIP_CARD
object
CITIZENSHIP_CERTIFICATE
object
CONFIRMATION_FROM_FINANCIAL_ENTITY
object
CREDIT_CARD_STATEMENT
object
CREDIT_FILE
object
DIVORCE_DOCUMENTATION
object
DRIVERS_LICENSE
object
GLOBAL_ENTRY_CARD
object
GOV_ISSUED_CPP_STATEMENT
object
GOV_ISSUED_VEHICLE_REGISTRATION
object
HEALTH_CARD
object
ID
object
INDIAN_STATUS_CARD
object
INSURANCE_DOCUMENT
object
INVESTMENT_ACCOUNT_STATEMENT
object
LOAN_ACCOUNT_STATEMENT
object
MARRIAGE_LICENCE
object
MICRO_DEPOSIT
object
MILITARY_ID
object
NEXUS
object
OTHER
object
PASSPORT
object
PERMANENT_RESIDENT_CARD
object
PROCESSED_CHEQUE
object
PROPERTY_TAX_ASSESSMENT
object
PROVINCIAL_ID
object
RECORD_OF_EMPLOYMENT
object
SCHOOL_DOCUMENT
object
SOCIAL_SECURITY_CARD
object
STATE_ID
object
TRAVEL_VISA
object
UTILITY_STATEMENT

IdVerification: object

Type definition for user ID verification

creditFileSource:
object
return:
arguments:
object
documentExpiryDate:
object

The expiry date of the document

return:
arguments:
object
documentID:
object

The unique identifying number of the document used

return:
arguments:
object
documentIssuingJurisdication:
object

The jurisdiction (province or state) and country of issue of the document

return:
arguments:
object
documentType:
object

Type of the document used in the ID Verification

return:
arguments:
object
id:
object

Internal Id of the ID verification record

return:
arguments:
object
methodOfIDVerification:
object

Method used for ID verification

return:
arguments:
object
secondaryDocumentExpiryDate:
object
return:
arguments:
object
secondaryDocumentID:
object
return:
arguments:
object
secondaryDocumentIssuingJurisdication:
object
return:
arguments:
object
secondaryDocumentType:
object
return:
arguments:
object
secondaryDocumentUserName:
object
return:
arguments:
object
state:
object
return:
arguments:
object
user:
object

User object

return:
arguments:
object
userName:
object

The person's name on the document

return:
arguments:
object
verifiedDate:
object

Date on which the ID was verified

return:
arguments:
object
Example
{
  "creditFileSource": {
    "return": "object",
    "arguments": {}
  },
  "documentExpiryDate": {
    "return": "object",
    "arguments": {}
  },
  "documentID": {
    "return": "string",
    "arguments": {}
  },
  "documentIssuingJurisdication": {
    "return": "string",
    "arguments": {}
  },
  "documentType": {
    "return": "string",
    "arguments": {}
  },
  "id": {
    "return": "object",
    "arguments": {}
  },
  "methodOfIDVerification": {
    "return": "string",
    "arguments": {}
  },
  "secondaryDocumentExpiryDate": {
    "return": "object",
    "arguments": {}
  },
  "secondaryDocumentID": {
    "return": "string",
    "arguments": {}
  },
  "secondaryDocumentIssuingJurisdication": {
    "return": "string",
    "arguments": {}
  },
  "secondaryDocumentType": {
    "return": "string",
    "arguments": {}
  },
  "secondaryDocumentUserName": {
    "return": "object",
    "arguments": {}
  },
  "state": {
    "return": "string",
    "arguments": {}
  },
  "user": {
    "return": {
      "accessibleBy": {
        "return": [
          {
            "displayOptions": {
              "return": {
                "hide": {
                  "return": "boolean",
                  "arguments": {}
                },
                "order": {
                  "return": "number",
                  "arguments": {}
                }
              },
              "arguments": {}
            },
            "organizationUser": {
              "return": {
                "accessType": {
                  "return": "string",
                  "arguments": {}
                },
                "apiTokens": {
                  "return": [
                    {
                      "id": {
                        "return": "object",
                        "arguments": {}
                      },
                      "jwtToken": {
                        "return": "string",
                        "arguments": {}
                      },
                      "name": {
                        "return": "string",
                        "arguments": {}
                      },
                      "organization": {
                        "return": {
                          "browserTabTitle": {}
                        }
                      }
                    }
                  ]
                }
              }
            }
          }
        ]
      }
    }
  }
}

IdVerificationMethods: string

Supported methods of ID verification

object
CONFIRMATION_OF_EXISTENCE
object
CREDIT_CHECK
object
DIGITAL_DOCUMENT_CHECK
object
DUAL_METHOD
object
IN_PERSON_VALIDATION

IdVerificationProvider: object

templateId:
object
return:
arguments:
object
vendor:
object
return:
arguments:
object
Example
{
  "templateId": {
    "return": "string",
    "arguments": {}
  },
  "vendor": {
    "return": "string",
    "arguments": {}
  }
}

IdVerificationProviderInput: object

templateId:
vendor:
Example
{
  "templateId": "object",
  "vendor": "string"
}

IdVerificationStates: string

ID verification States

object
ACTIVE
object
ARCHIVED

IdVerificationTransition: string

Transition states for user's idVerification

object
archive

IdVerificationVendors: string

object
PERSONA

ImportFile: object

bulkImport:
object
return:
arguments:
object
createdAt:
object
return:
arguments:
object
failedLineItemsCount:
object
return:
Int
arguments:
object
fileDocument:
object
return:
arguments:
object
id:
object
return:
arguments:
object
order:
object
return:
Int
arguments:
object
organization:
object
return:
arguments:
object
processedLineItemsCount:
object
return:
Int
arguments:
object
queuedLineItemsCount:
object
return:
Int
arguments:
object
state:
object
return:
arguments:
object
type:
object
return:
arguments:
object
updatedAt:
object
return:
arguments:
object
Example
{
  "bulkImport": {
    "return": {
      "createdAt": {
        "return": "object",
        "arguments": {}
      },
      "id": {
        "return": "object",
        "arguments": {}
      },
      "name": {
        "return": "string",
        "arguments": {}
      },
      "organization": {
        "return": {
          "browserTabTitle": {
            "return": "string",
            "arguments": {}
          },
          "faviconLink": {
            "return": "string",
            "arguments": {}
          },
          "id": {
            "return": "object",
            "arguments": {}
          },
          "name": {
            "return": "string",
            "arguments": {}
          },
          "parent": {
            "return": {
              "browserTabTitle": {
                "return": "string",
                "arguments": {}
              },
              "faviconLink": {
                "return": "string",
                "arguments": {}
              },
              "id": {
                "return": "object",
                "arguments": {}
              },
              "name": {
                "return": "string",
                "arguments": {}
              },
              "parent": {
                "return": {
                  "browserTabTitle": {
                    "return": "string",
                    "arguments": {}
                  },
                  "faviconLink": {
                    "return": "string",
                    "arguments": {}
                  },
                  "id": {
                    "return": "object",
                    "arguments": {}
                  },
                  "name": {
                    "return": "string",
                    "arguments": {}
                  },
                  "parent": {
                    "return": {
                      "browserTabTitle": {
                        "return": "string",
                        "arguments": {}
                      },
                      "faviconLink": {
                        "return": "string",
                        "arguments": {}
                      },
                      "id": {
                        "return": "object",
                        "arguments": {}
                      },
                      "name": {
                        "return": "string",
                        "arguments": {}
                      },
                      "parent": {
                        "return": {
                          "browserTabTitle": {
                            "return": "string",
                            "arguments": {}
                          },
                          "faviconLink": {}
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

ImportFileLineItem: object

createdAt:
object
return:
arguments:
object
externalId:
object
return:
arguments:
object
id:
object
return:
arguments:
object
importFile:
object
return:
arguments:
object
oneVestId:
object
return:
arguments:
object
outputErrors:
object
return:
ImportOutputError
arguments:
object
rawData:
object
return:
arguments:
object
state:
object
return:
arguments:
object
updatedAt:
object
return:
arguments:
object
Example
{
  "createdAt": {
    "return": "object",
    "arguments": {}
  },
  "externalId": {
    "return": "string",
    "arguments": {}
  },
  "id": {
    "return": "object",
    "arguments": {}
  },
  "importFile": {
    "return": {
      "bulkImport": {
        "return": {
          "createdAt": {
            "return": "object",
            "arguments": {}
          },
          "id": {
            "return": "object",
            "arguments": {}
          },
          "name": {
            "return": "string",
            "arguments": {}
          },
          "organization": {
            "return": {
              "browserTabTitle": {
                "return": "string",
                "arguments": {}
              },
              "faviconLink": {
                "return": "string",
                "arguments": {}
              },
              "id": {
                "return": "object",
                "arguments": {}
              },
              "name": {
                "return": "string",
                "arguments": {}
              },
              "parent": {
                "return": {
                  "browserTabTitle": {
                    "return": "string",
                    "arguments": {}
                  },
                  "faviconLink": {
                    "return": "string",
                    "arguments": {}
                  },
                  "id": {
                    "return": "object",
                    "arguments": {}
                  },
                  "name": {
                    "return": "string",
                    "arguments": {}
                  },
                  "parent": {
                    "return": {
                      "browserTabTitle": {
                        "return": "string",
                        "arguments": {}
                      },
                      "faviconLink": {
                        "return": "string",
                        "arguments": {}
                      },
                      "id": {
                        "return": "object",
                        "arguments": {}
                      },
                      "name": {
                        "return": "string",
                        "arguments": {}
                      },
                      "parent": {
                        "return": {
                          "browserTabTitle": {
                            "return": "string",
                            "arguments": {}
                          },
                          "faviconLink": {
                            "return": "string",
                            "arguments": {}
                          },
                          "id": {}
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

ImportFileLineItemQueryFilter: object

errorCode:
externalId:
importFileId:
oneVestId:
states:
ImportFileLineItemStates
Example
{
  "errorCode": "string",
  "externalId": "string",
  "importFileId": "object",
  "oneVestId": "object",
  "states": [
    "string"
  ]
}

ImportFileLineItemStates: string

object
FAILED
object
PROCESSED
object
QUEUED

ImportFileLineItemTransition: string

object
fail
object
process
object
retry

ImportFileQueryFilter: object

bulkImportId:
createdAtAfter:
createdAtBefore:
organizationId:
states:
ImportFileStates
types:
ImportFileTypes
Example
{
  "bulkImportId": "object",
  "createdAtAfter": "object",
  "createdAtBefore": "object",
  "organizationId": "object",
  "states": [
    "string"
  ],
  "types": [
    "string"
  ]
}

ImportFileStates: string

object
CANCELED
object
COMPLETED
object
FAILED
object
PARTIALLY_FAILED
object
PROCESSING
object
QUEUED

ImportFileTransition: string

object
cancel
object
complete
object
fail
object
partiallyFail
object
process

ImportFileTypes: string

object
ACCOUNT
object
ACCOUNT_AFFILIATE
object
FOREIGN_EXCHANGE_RATE
object
GOAL
object
PRODUCT_SHELF
object
SECURITY_PRICE
object
TRANSACTION
object
USER

ImportOutputError: object

code:
object
return:
arguments:
object
description:
object
return:
arguments:
object
field:
object
return:
arguments:
object
Example
{
  "code": {
    "return": "string",
    "arguments": {}
  },
  "description": {
    "return": "string",
    "arguments": {}
  },
  "field": {
    "return": "string",
    "arguments": {}
  }
}

IncomeFundFrequency: string

Scheduled Income Fund Transfer Frequency.

object
ANNUALLY
object
MONTHLY
object
QUARTERLY
object
SEMI_ANNUALLY

IncompleteAffiliation: object

id:
object
return:
arguments:
object
incompleteFields:
object
return:
String
arguments:
object
relation:
object
return:
arguments:
object
type:
object
return:
arguments:
object
user:
object
return:
arguments:
object
Example
{
  "id": {
    "return": "object",
    "arguments": {}
  },
  "incompleteFields": {
    "return": [
      "string"
    ],
    "arguments": {}
  },
  "relation": {
    "return": "string",
    "arguments": {}
  },
  "type": {
    "return": "string",
    "arguments": {}
  },
  "user": {
    "return": {
      "accessibleBy": {
        "return": [
          {
            "displayOptions": {
              "return": {
                "hide": {
                  "return": "boolean",
                  "arguments": {}
                },
                "order": {
                  "return": "number",
                  "arguments": {}
                }
              },
              "arguments": {}
            },
            "organizationUser": {
              "return": {
                "accessType": {
                  "return": "string",
                  "arguments": {}
                },
                "apiTokens": {
                  "return": [
                    {
                      "id": {
                        "return": "object",
                        "arguments": {}
                      },
                      "jwtToken": {
                        "return": "string",
                        "arguments": {}
                      },
                      "name": {
                        "return": "string",
                        "arguments": {}
                      },
                      "organization": {
                        "return": {
                          "browserTabTitle": {
                            "return": "string",
                            "arguments": {}
                          },
                          "faviconLink": {
                            "return": "string",
                            "arguments": {}
                          },
                          "id": {
                            "return": "object",
                            "arguments": {}
                          },
                          "name": {
                            "return": "string",
                            "arguments": {}
                          },
                          "parent": {
                            "return": {
                              "browserTabTitle": {
                                "return": "string",
                                "arguments": {}
                              },
                              "faviconLink": {
                                "return": "string",
                                "arguments": {}
                              },
                              "id": {
                                "return": "object",
                                "arguments": {}
                              },
                              "name": {
                                "return": "string",
                                "arguments": {}
                              },
                              "parent": {}
                            }
                          }
                        }
                      }
                    }
                  ]
                }
              }
            }
          }
        ]
      }
    }
  }
}

IncompleteFormAgreement: object

account:
object
return:
arguments:
object
changeReason:
object
return:
arguments:
object
changeType:
object
return:
arguments:
object
clientGroup:
object
return:
arguments:
object
digitalSignatureEnabled:
object
return:
arguments:
object
goal:
object
return:
arguments:
object
hasPdfTemplate:
object
return:
arguments:
object
id:
object
return:
arguments:
object
isPrefilledPdfEnabled:
object
return:
arguments:
object
minVersion:
object
return:
Int
arguments:
object
scheduledTransfer:
object
return:
arguments:
object
subAccount:
object
return:
arguments:
object
templateUrl:
object
return:
arguments:
object
translatedChangeReason:
object
return:
arguments:
object
translatedDisplayName:
object
return:
arguments:
object
type:
object
return:
arguments:
object
user:
object
return:
arguments:
object
usersRequiredToSign:
object
return:
UserRequiredToSign
arguments:
object
Example
{
  "account": {
    "return": {
      "affiliations": {
        "return": [
          {
            "allocation": {
              "return": "number",
              "arguments": {}
            },
            "id": {
              "return": "object",
              "arguments": {}
            },
            "relation": {
              "return": "string",
              "arguments": {}
            },
            "signatureRequired": {
              "return": "boolean",
              "arguments": {}
            },
            "type": {
              "return": "string",
              "arguments": {}
            },
            "user": {
              "return": {
                "accessibleBy": {
                  "return": [
                    {
                      "displayOptions": {
                        "return": {
                          "hide": {
                            "return": "boolean",
                            "arguments": {}
                          },
                          "order": {
                            "return": "number",
                            "arguments": {}
                          }
                        },
                        "arguments": {}
                      },
                      "organizationUser": {
                        "return": {
                          "accessType": {
                            "return": "string",
                            "arguments": {}
                          },
                          "apiTokens": {
                            "return": [
                              {
                                "id": {
                                  "return": "object",
                                  "arguments": {}
                                },
                                "jwtToken": {
                                  "return": "string",
                                  "arguments": {}
                                },
                                "name": {
                                  "return": "string",
                                  "arguments": {}
                                },
                                "organization": {
                                  "return": {
                                    "browserTabTitle": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "faviconLink": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "id": {
                                      "return": "object",
                                      "arguments": {}
                                    },
                                    "name": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "parent": {
                                      "return": {
                                        "browserTabTitle": {
                                          "return": "string",
                                          "arguments": {}
                                        },
                                        "faviconLink": {
                                          "return": "string",
                                          "arguments": {}
                                        }
                                      }
                                    }
                                  }
                                }
                              }
                            ]
                          }
                        }
                      }
                    }
                  ]
                }
              }
            }
          }
        ]
      }
    }
  }
}

Initiator: string

object
API_TOKEN
object
CLIENT
object
ORGANIZATION_USER
object
PARTNER
object
SYSTEM

Institution: object

createdAt:
object
return:
arguments:
object
id:
object

Institution ID

return:
arguments:
object
isDraft:
object

institution isDraft or not

return:
arguments:
object
name:
object

institution name

return:
arguments:
object
physicalAddress:
object

The institution address

return:
arguments:
object
state:
object
return:
arguments:
object
stateChanges:
object
return:
StateChanges
arguments:
object
updatedAt:
object
return:
arguments:
object
Example
{
  "createdAt": {
    "return": "object",
    "arguments": {}
  },
  "id": {
    "return": "object",
    "arguments": {}
  },
  "isDraft": {
    "return": "string",
    "arguments": {}
  },
  "name": {
    "return": "string",
    "arguments": {}
  },
  "physicalAddress": {
    "return": {
      "city": {
        "return": "string",
        "arguments": {}
      },
      "country": {
        "return": "string",
        "arguments": {}
      },
      "houseNumber": {
        "return": "string",
        "arguments": {}
      },
      "jurisdiction": {
        "return": "string",
        "arguments": {}
      },
      "neighborhood": {
        "return": "string",
        "arguments": {}
      },
      "postal": {
        "return": "string",
        "arguments": {}
      },
      "province": {
        "return": "string",
        "arguments": {}
      },
      "streetName": {
        "return": "string",
        "arguments": {}
      },
      "unitNumber": {
        "return": "string",
        "arguments": {}
      }
    },
    "arguments": {}
  },
  "state": {
    "return": "string",
    "arguments": {}
  },
  "stateChanges": {
    "return": [
      "object"
    ],
    "arguments": {}
  },
  "updatedAt": {
    "return": "object",
    "arguments": {}
  }
}

InstitutionPaginationAndSorting: object

offSet:
Int
perPage:
Int
sortDesc:
sortField:
Example
{
  "offSet": "number",
  "perPage": "number",
  "sortDesc": "boolean",
  "sortField": "string"
}

InstitutionPhysicalAddress: object

city:
object
return:
arguments:
object
country:
object
return:
arguments:
object
houseNumber:
object
return:
arguments:
object
jurisdiction:
object
return:
arguments:
object
neighborhood:
object
return:
arguments:
object
postal:
object
return:
arguments:
object
province:
object
return:
arguments:
object
streetName:
object
return:
arguments:
object
unitNumber:
object
return:
arguments:
object
Example
{
  "city": {
    "return": "string",
    "arguments": {}
  },
  "country": {
    "return": "string",
    "arguments": {}
  },
  "houseNumber": {
    "return": "string",
    "arguments": {}
  },
  "jurisdiction": {
    "return": "string",
    "arguments": {}
  },
  "neighborhood": {
    "return": "string",
    "arguments": {}
  },
  "postal": {
    "return": "string",
    "arguments": {}
  },
  "province": {
    "return": "string",
    "arguments": {}
  },
  "streetName": {
    "return": "string",
    "arguments": {}
  },
  "unitNumber": {
    "return": "string",
    "arguments": {}
  }
}

InstitutionPhysicalAddressInput: object

city:
country:
houseNumber:
jurisdiction:
neighborhood:
postal:
province:
streetName:
unitNumber:
Example
{
  "city": "object",
  "country": "string",
  "houseNumber": "object",
  "jurisdiction": "string",
  "neighborhood": "object",
  "postal": "object",
  "province": "string",
  "streetName": "object",
  "unitNumber": "object"
}

InstitutionPhysicalAddressUpdateInput: object

city:
country:
houseNumber:
neighborhood:
postal:
province:
streetName:
unitNumber:
Example
{
  "city": "object",
  "country": "string",
  "houseNumber": "object",
  "neighborhood": "object",
  "postal": "object",
  "province": "string",
  "streetName": "object",
  "unitNumber": "object"
}

InstitutionQueryFilter: object

searchText:
state:
Example
{
  "searchText": "string",
  "state": "string"
}

InstitutionStates: string

Transfer processing steps.

object
APPROVED
object
AWAITING_REVIEW
object
REJECTED

InstitutionTransition: string

object
approve
object
reject

Int: number

The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.

Example
number

Integration: object

configuration:
object

Configuration

return:
arguments:
object
id:
object
return:
arguments:
object
organization:
object

Organization with limited attributes that is accessible from sub-organizations.

return:
arguments:
object
provider:
object

Integration provides

return:
arguments:
object
state:
object

Integration State

return:
arguments:
object
type:
object

Integration types

return:
arguments:
object
Example
{
  "configuration": {
    "return": "object",
    "arguments": {}
  },
  "id": {
    "return": "object",
    "arguments": {}
  },
  "organization": {
    "return": {
      "browserTabTitle": {
        "return": "string",
        "arguments": {}
      },
      "faviconLink": {
        "return": "string",
        "arguments": {}
      },
      "id": {
        "return": "object",
        "arguments": {}
      },
      "name": {
        "return": "string",
        "arguments": {}
      },
      "parent": {
        "return": {
          "browserTabTitle": {
            "return": "string",
            "arguments": {}
          },
          "faviconLink": {
            "return": "string",
            "arguments": {}
          },
          "id": {
            "return": "object",
            "arguments": {}
          },
          "name": {
            "return": "string",
            "arguments": {}
          },
          "parent": {
            "return": {
              "browserTabTitle": {
                "return": "string",
                "arguments": {}
              },
              "faviconLink": {
                "return": "string",
                "arguments": {}
              },
              "id": {
                "return": "object",
                "arguments": {}
              },
              "name": {
                "return": "string",
                "arguments": {}
              },
              "parent": {
                "return": {
                  "browserTabTitle": {
                    "return": "string",
                    "arguments": {}
                  },
                  "faviconLink": {
                    "return": "string",
                    "arguments": {}
                  },
                  "id": {
                    "return": "object",
                    "arguments": {}
                  },
                  "name": {
                    "return": "string",
                    "arguments": {}
                  },
                  "parent": {
                    "return": {
                      "browserTabTitle": {
                        "return": "string",
                        "arguments": {}
                      },
                      "faviconLink": {
                        "return": "string",
                        "arguments": {}
                      },
                      "id": {
                        "return": "object",
                        "arguments": {}
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

IntegrationProviders: string

object
CANADA_POST
object
FIREBASE
object
FLINKS
object
GOOGLE
object
IEX_CLOUD
object
LSEG
object
MIXPANEL
object
PERSONA

IntegrationQueryFilter: object

organizationId:
state:
type:
Example
{
  "organizationId": "object",
  "state": "string",
  "type": "string"
}

IntegrationStates: string

object
ACTIVE
object
ARCHIVED
object
INACTIVE

IntegrationTransitionStates: string

object
activate
object
archive
object
deactivate

IntegrationTypes: string

object
ADDRESS
object
ANALYTICS
object
BANKING
object
FINANCIAL_DATA_WIDGETS
object
ID_VERIFICATION
object
MARKET_DATA

InvestmentKnowledge: string

User's investment knowledge level

object
EXPERT
object
LIMITED
object
NONE
object
SOME

InviteOrganizationUsersInput: object

organizationId:
organizationUserId:
Example
{
  "organizationId": "object",
  "organizationUserId": "object"
}

InviteOrganizationUsersResponse: object

success:
object
return:
arguments:
object
Example
{
  "success": {
    "return": "boolean",
    "arguments": {}
  }
}

JSON: object

Example
object

JobTitleRisk: object

companyType:
object
return:
arguments:
object
disabled:
object
return:
arguments:
object
id:
object
return:
arguments:
object
jobTitle:
object
return:
arguments:
object
riskRating:
object
return:
arguments:
object
Example
{
  "companyType": {
    "return": "object",
    "arguments": {}
  },
  "disabled": {
    "return": "boolean",
    "arguments": {}
  },
  "id": {
    "return": "object",
    "arguments": {}
  },
  "jobTitle": {
    "return": "object",
    "arguments": {}
  },
  "riskRating": {
    "return": "string",
    "arguments": {}
  }
}

Jurisdiction: string

object
AB
object
BC
object
FEDERAL
object
MB
object
NB
object
NL
object
NS
object
ON
object
PE
object
QC
object
SK

JurisdictionCodes: string

object
CA_AB
object
CA_BC
object
CA_MB
object
CA_NB
object
CA_NL
object
CA_NS
object
CA_NT
object
CA_NU
object
CA_ON
object
CA_PE
object
CA_QC
object
CA_SK
object
CA_YT
object
GB_ENG
object
GB_NIR
object
GB_SCT
object
US_AK
object
US_AL
object
US_AR
object
US_AS
object
US_AZ
object
US_CA
object
US_CO
object
US_CT
object
US_DC
object
US_DE
object
US_FL
object
US_GA
object
US_GU
object
US_HI
object
US_IA
object
US_ID
object
US_IL
object
US_IN
object
US_KS
object
US_KY
object
US_LA
object
US_MA
object
US_MD
object
US_ME
object
US_MI
object
US_MN
object
US_MO
object
US_MP
object
US_MS
object
US_MT
object
US_NC
object
US_ND
object
US_NE
object
US_NH
object
US_NJ
object
US_NM
object
US_NV
object
US_NY
object
US_OH
object
US_OK
object
US_OR
object
US_PA
object
US_PR
object
US_RI
object
US_SC
object
US_SD
object
US_TN
object
US_TX
object
US_UM
object
US_UT
object
US_VA
object
US_VI
object
US_VT
object
US_WA
object
US_WI
object
US_WV
object
US_WY

Language: string

object
EN
object
FR

Languages: string

object
ENGLISH
object
FRENCH

Localization: object

countries:
object
return:
CountryCodes
arguments:
object
dateFormat:
object
return:
arguments:
object
defaultCurrency:
object
return:
arguments:
object
defaultLanguage:
object
return:
arguments:
object
id:
object
return:
arguments:
object
languages:
object
return:
LocalizationLanguages
arguments:
object
name:
object
return:
arguments:
object
organization:
object
return:
arguments:
object
Example
{
  "countries": {
    "return": [
      "string"
    ],
    "arguments": {}
  },
  "dateFormat": {
    "return": "string",
    "arguments": {}
  },
  "defaultCurrency": {
    "return": "string",
    "arguments": {}
  },
  "defaultLanguage": {
    "return": "string",
    "arguments": {}
  },
  "id": {
    "return": "object",
    "arguments": {}
  },
  "languages": {
    "return": [
      "string"
    ],
    "arguments": {}
  },
  "name": {
    "return": "string",
    "arguments": {}
  },
  "organization": {
    "return": {
      "browserTabTitle": {
        "return": "string",
        "arguments": {}
      },
      "faviconLink": {
        "return": "string",
        "arguments": {}
      },
      "id": {
        "return": "object",
        "arguments": {}
      },
      "name": {
        "return": "string",
        "arguments": {}
      },
      "parent": {
        "return": {
          "browserTabTitle": {
            "return": "string",
            "arguments": {}
          },
          "faviconLink": {
            "return": "string",
            "arguments": {}
          },
          "id": {
            "return": "object",
            "arguments": {}
          },
          "name": {
            "return": "string",
            "arguments": {}
          },
          "parent": {
            "return": {
              "browserTabTitle": {
                "return": "string",
                "arguments": {}
              },
              "faviconLink": {
                "return": "string",
                "arguments": {}
              },
              "id": {
                "return": "object",
                "arguments": {}
              },
              "name": {
                "return": "string",
                "arguments": {}
              },
              "parent": {
                "return": {
                  "browserTabTitle": {
                    "return": "string",
                    "arguments": {}
                  },
                  "faviconLink": {
                    "return": "string",
                    "arguments": {}
                  },
                  "id": {}
                }
              }
            }
          }
        }
      }
    }
  }
}

LocalizationInput: object

countries:
CountryCodes
dateFormat:
defaultCurrency:
defaultLanguage:
languages:
LocalizationLanguages
name:
Example
{
  "countries": [
    "string"
  ],
  "dateFormat": "string",
  "defaultCurrency": "string",
  "defaultLanguage": "string",
  "languages": [
    "string"
  ],
  "name": "string"
}

LocalizationLanguages: string

object
en
object
fr

LocalizationPaginationAndSorting: object

offSet:
Int
perPage:
Int
sortDesc:
sortField:
Example
{
  "offSet": "number",
  "perPage": "number",
  "sortDesc": "boolean",
  "sortField": "string"
}

LocalizationQueryFilter: object

organizationId:
Example
{
  "organizationId": "object"
}

Log: object

account:
object
return:
arguments:
object
apiToken:
object
return:
arguments:
object
changes:
object
return:
arguments:
object
clientGroup:
object
return:
arguments:
object
id:
object
return:
arguments:
object
initiator:
object
return:
arguments:
object
newDocument:
object
return:
arguments:
object
objectId:
object
return:
arguments:
object
objectType:
object
return:
arguments:
object
organizationUser:
object
return:
arguments:
object
originalDocument:
object
return:
arguments:
object
reason:
object
return:
arguments:
object
subAccount:
object
return:
arguments:
object
timestamp:
object
return:
arguments:
object
traceId:
object
return:
arguments:
object
type:
object
return:
arguments:
object
user:
object
return:
arguments:
object
Example
{
  "account": {
    "return": {
      "affiliations": {
        "return": [
          {
            "allocation": {
              "return": "number",
              "arguments": {}
            },
            "id": {
              "return": "object",
              "arguments": {}
            },
            "relation": {
              "return": "string",
              "arguments": {}
            },
            "signatureRequired": {
              "return": "boolean",
              "arguments": {}
            },
            "type": {
              "return": "string",
              "arguments": {}
            },
            "user": {
              "return": {
                "accessibleBy": {
                  "return": [
                    {
                      "displayOptions": {
                        "return": {
                          "hide": {
                            "return": "boolean",
                            "arguments": {}
                          },
                          "order": {
                            "return": "number",
                            "arguments": {}
                          }
                        },
                        "arguments": {}
                      },
                      "organizationUser": {
                        "return": {
                          "accessType": {
                            "return": "string",
                            "arguments": {}
                          },
                          "apiTokens": {
                            "return": [
                              {
                                "id": {
                                  "return": "object",
                                  "arguments": {}
                                },
                                "jwtToken": {
                                  "return": "string",
                                  "arguments": {}
                                },
                                "name": {
                                  "return": "string",
                                  "arguments": {}
                                },
                                "organization": {
                                  "return": {
                                    "browserTabTitle": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "faviconLink": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "id": {
                                      "return": "object",
                                      "arguments": {}
                                    },
                                    "name": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "parent": {
                                      "return": {
                                        "browserTabTitle": {
                                          "return": "string",
                                          "arguments": {}
                                        },
                                        "faviconLink": {
                                          "return": "string",
                                          "arguments": {}
                                        }
                                      }
                                    }
                                  }
                                }
                              }
                            ]
                          }
                        }
                      }
                    }
                  ]
                }
              }
            }
          }
        ]
      }
    }
  }
}

LogTypes: string

object
CREATE
object
DELETE
object
UPDATE

LogsResponse: object

logs:
object
return:
Log
arguments:
object
totalCount:
object
return:
Int
arguments:
object
Example
{
  "logs": {
    "return": [
      {
        "account": {
          "return": {
            "affiliations": {
              "return": [
                {
                  "allocation": {
                    "return": "number",
                    "arguments": {}
                  },
                  "id": {
                    "return": "object",
                    "arguments": {}
                  },
                  "relation": {
                    "return": "string",
                    "arguments": {}
                  },
                  "signatureRequired": {
                    "return": "boolean",
                    "arguments": {}
                  },
                  "type": {
                    "return": "string",
                    "arguments": {}
                  },
                  "user": {
                    "return": {
                      "accessibleBy": {
                        "return": [
                          {
                            "displayOptions": {
                              "return": {
                                "hide": {
                                  "return": "boolean",
                                  "arguments": {}
                                },
                                "order": {
                                  "return": "number",
                                  "arguments": {}
                                }
                              },
                              "arguments": {}
                            },
                            "organizationUser": {
                              "return": {
                                "accessType": {
                                  "return": "string",
                                  "arguments": {}
                                },
                                "apiTokens": {
                                  "return": [
                                    {
                                      "id": {
                                        "return": "object",
                                        "arguments": {}
                                      },
                                      "jwtToken": {
                                        "return": "string",
                                        "arguments": {}
                                      },
                                      "name": {
                                        "return": "string",
                                        "arguments": {}
                                      },
                                      "organization": {
                                        "return": {
                                          "browserTabTitle": {
                                            "return": "string",
                                            "arguments": {}
                                          },
                                          "faviconLink": {
                                            "return": "string",
                                            "arguments": {}
                                          },
                                          "id": {
                                            "return": "object",
                                            "arguments": {}
                                          },
                                          "name": {
                                            "return": "string",
                                            "arguments": {}
                                          },
                                          "parent": {
                                            "return": {
                                              "browserTabTitle": {
                                                "return": "string",
                                                "arguments": {}
                                              }
                                            }
                                          }
                                        }
                                      }
                                    }
                                  ]
                                }
                              }
                            }
                          }
                        ]
                      }
                    }
                  }
                }
              ]
            }
          }
        }
      }
    ]
  }
}

Long: object

Example
object

ManagementFees: object

feeCents:
object
return:
Int
arguments:
object
salesTaxCents:
object
return:
arguments:
object
totalFeeCents:
object

totalFeeCents = feeCents + salesTaxCents

return:
arguments:
object
Example
{
  "feeCents": {
    "return": "number",
    "arguments": {}
  },
  "salesTaxCents": {
    "return": "number",
    "arguments": {}
  },
  "totalFeeCents": {
    "return": "number",
    "arguments": {}
  }
}

ManualProcess: object

account:
object
return:
arguments:
object
createdAt:
object
return:
arguments:
object
id:
object
return:
arguments:
object
institution:
object
return:
arguments:
object
signedUrl:
object
return:
arguments:
object
state:
object
return:
arguments:
object
stateChanges:
object
return:
StateChanges
arguments:
object
subAccount:
object
return:
arguments:
object
transferAccount:
object
return:
arguments:
object
transferAccountNumber:
object
return:
arguments:
object
transferMethod:
object
return:
arguments:
object
type:
object
return:
arguments:
object
user:
object
return:
arguments:
object
Example
{
  "account": {
    "return": {
      "affiliations": {
        "return": [
          {
            "allocation": {
              "return": "number",
              "arguments": {}
            },
            "id": {
              "return": "object",
              "arguments": {}
            },
            "relation": {
              "return": "string",
              "arguments": {}
            },
            "signatureRequired": {
              "return": "boolean",
              "arguments": {}
            },
            "type": {
              "return": "string",
              "arguments": {}
            },
            "user": {
              "return": {
                "accessibleBy": {
                  "return": [
                    {
                      "displayOptions": {
                        "return": {
                          "hide": {
                            "return": "boolean",
                            "arguments": {}
                          },
                          "order": {
                            "return": "number",
                            "arguments": {}
                          }
                        },
                        "arguments": {}
                      },
                      "organizationUser": {
                        "return": {
                          "accessType": {
                            "return": "string",
                            "arguments": {}
                          },
                          "apiTokens": {
                            "return": [
                              {
                                "id": {
                                  "return": "object",
                                  "arguments": {}
                                },
                                "jwtToken": {
                                  "return": "string",
                                  "arguments": {}
                                },
                                "name": {
                                  "return": "string",
                                  "arguments": {}
                                },
                                "organization": {
                                  "return": {
                                    "browserTabTitle": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "faviconLink": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "id": {
                                      "return": "object",
                                      "arguments": {}
                                    },
                                    "name": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "parent": {
                                      "return": {
                                        "browserTabTitle": {
                                          "return": "string",
                                          "arguments": {}
                                        },
                                        "faviconLink": {
                                          "return": "string",
                                          "arguments": {}
                                        }
                                      }
                                    }
                                  }
                                }
                              }
                            ]
                          }
                        }
                      }
                    }
                  ]
                }
              }
            }
          }
        ]
      }
    }
  }
}

ManualProcessStates: string

Transfer processing steps.

object
CANCELED
object
FAILED
object
INITIATED
object
PROCESSING
object
RECONCILED

ManualProcessTransition: string

object
cancel
object
fail
object
process
object
reconcile

ManualProcessTypes: string

object
CLOSE_ACCOUNT
object
TRANSFER_FROM_OUTSIDE_ACCOUNT

ManualProcessesPaginationAndSorting: object

offSet:
Int
perPage:
Int
sortDesc:
sortField:
Example
{
  "offSet": "number",
  "perPage": "number",
  "sortDesc": "boolean",
  "sortField": "string"
}

ManualProcessesQueryFilter: object

id:
ObjectID
Example
{
  "id": [
    "object"
  ]
}

ManualServiceAccountTypes: string

object
CASH_JOINT
object
CORPORATE_CASH
object
CORPORATE_CHARITY
object
CORPORATE_ESTATE
object
CORPORATE_TRUST
object
FHSA
object
GRSP
object
LIF
object
LIRA
object
LRIF
object
LRSP
object
PERSONAL
object
PRIF
object
RDSP
object
RESP
object
RESP_ADULT
object
RESP_FAMILY
object
RESP_FAMILY_JOINT
object
RESP_SINGLE
object
RESP_SINGLE_JOINT
object
RIF_SPOUSAL
object
RLIF
object
RLSP
object
RRIF
object
RRSP
object
RRSP_SPOUSAL
object
TFSA

MaritalStatus: string

User's martial status

object
COMMON_LAW
object
DIVORCED
object
MARRIED
object
SEPARATED
object
SINGLE
object
WIDOWED

MarkNotificationAsReadInput: object

notificationId:
Example
{
  "notificationId": "object"
}

MethodOfCommunication: string

object
EMAIL
object
OTHER
object
PHONE
object
TEXT

ModelPortfolioLogsInput: object

filter:
pagination:
Example
{
  "filter": {
    "after": "object",
    "before": "object"
  },
  "pagination": {
    "offSet": "number",
    "perPage": "number",
    "sortDesc": "boolean",
    "sortField": "string"
  }
}

ModelPortfolioLogsQueryFilter: object

after:
before:
Example
{
  "after": "object",
  "before": "object"
}

ModelPortfolioPaginationAndSorting: object

offset:
Int
perPage:
Int
sortDesc:
sortField:
Example
{
  "offset": "number",
  "perPage": "number",
  "sortDesc": "boolean",
  "sortField": "string"
}

ModelPortfolioQueryFilter: object

organizationId:
state:
suggestable:
themeId:
themeIds:
ObjectID
Example
{
  "organizationId": "object",
  "state": "string",
  "suggestable": "boolean",
  "themeId": "object",
  "themeIds": [
    "object"
  ]
}

ModelPortfolioTypes: string

object
GOAL
object
SUB_ACCOUNT

NavigationStyles: string

object
FULL
object
SIMPLE

NextSubStepInput: object

workflowCompletionId:
Example
{
  "workflowCompletionId": "object"
}

NextSubStepResponse: object

workflowCompletion:
object
return:
arguments:
object
Example
{
  "workflowCompletion": {
    "return": {
      "context": {
        "return": "object",
        "arguments": {}
      },
      "createdAt": {
        "return": "object",
        "arguments": {}
      },
      "currentStep": {
        "return": {
          "id": {
            "return": "object",
            "arguments": {}
          },
          "name": {
            "return": {
              "en": {
                "return": "string",
                "arguments": {}
              },
              "fr": {
                "return": "string",
                "arguments": {}
              }
            },
            "arguments": {}
          },
          "subSteps": {
            "return": [
              {
                "canGoBack": {
                  "return": "boolean",
                  "arguments": {}
                },
                "completeableBy": {
                  "return": [
                    "string"
                  ],
                  "arguments": {}
                },
                "id": {
                  "return": "object",
                  "arguments": {}
                },
                "options": {
                  "return": "object",
                  "arguments": {}
                },
                "rolesCompleteableBy": {
                  "return": [
                    {
                      "accessiblePages": {
                        "return": [
                          "string"
                        ],
                        "arguments": {}
                      },
                      "accountPageConfiguration": {
                        "return": {
                          "createdAt": {
                            "return": "object",
                            "arguments": {}
                          },
                          "id": {
                            "return": "object",
                            "arguments": {}
                          },
                          "name": {
                            "return": "string",
                            "arguments": {}
                          },
                          "options": {
                            "return": "object",
                            "arguments": {}
                          },
                          "organization": {
                            "return": {
                              "accountTypeTaxRanks": {
                                "return": [
                                  {
                                    "accountType": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "id": {
                                      "return": "object",
                                      "arguments": {}
                                    },
                                    "taxRank": {
                                      "return": "number",
                                      "arguments": {}
                                    }
                                  }
                                ],
                                "arguments": {}
                              }
                            }
                          }
                        }
                      }
                    }
                  ]
                }
              }
            ]
          }
        }
      }
    }
  }
}

Note: object

Note type

author:
object

OrganizationUser is the author of the note

return:
arguments:
object
content:
object
return:
arguments:
object
createdAt:
object

The date and time this Note was created

return:
arguments:
object
id:
object

NoteId

return:
arguments:
object
objectId:
object

User is the designated note user

return:
arguments:
object
objectType:
object

NoteObjectTypes derived from the ENUM

return:
arguments:
object
organization:
object

Organization of the notes creator

return:
arguments:
object
state:
object

NoteStates derived from the ENUM

return:
arguments:
object
type:
object

NoteTypes derived from the ENUM

return:
arguments:
object
updatedAt:
object

The date and time this Note's information was last updated

return:
arguments:
object
Example
{
  "author": {
    "return": {
      "email": {
        "return": "string",
        "arguments": {}
      },
      "firstName": {
        "return": "string",
        "arguments": {}
      },
      "id": {
        "return": "object",
        "arguments": {}
      },
      "language": {
        "return": "string",
        "arguments": {}
      },
      "lastName": {
        "return": "string",
        "arguments": {}
      },
      "organization": {
        "return": {
          "browserTabTitle": {
            "return": "string",
            "arguments": {}
          },
          "faviconLink": {
            "return": "string",
            "arguments": {}
          },
          "id": {
            "return": "object",
            "arguments": {}
          },
          "name": {
            "return": "string",
            "arguments": {}
          },
          "parent": {
            "return": {
              "browserTabTitle": {
                "return": "string",
                "arguments": {}
              },
              "faviconLink": {
                "return": "string",
                "arguments": {}
              },
              "id": {
                "return": "object",
                "arguments": {}
              },
              "name": {
                "return": "string",
                "arguments": {}
              },
              "parent": {
                "return": {
                  "browserTabTitle": {
                    "return": "string",
                    "arguments": {}
                  },
                  "faviconLink": {
                    "return": "string",
                    "arguments": {}
                  },
                  "id": {
                    "return": "object",
                    "arguments": {}
                  },
                  "name": {
                    "return": "string",
                    "arguments": {}
                  },
                  "parent": {
                    "return": {
                      "browserTabTitle": {
                        "return": "string",
                        "arguments": {}
                      },
                      "faviconLink": {
                        "return": "string",
                        "arguments": {}
                      },
                      "id": {
                        "return": "object",
                        "arguments": {}
                      },
                      "name": {
                        "return": "string",
                        "arguments": {}
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

NoteObjectTypes: string

Note Types

object
CLIENT_GROUP
object
USER

NotePaginationAndSorting: object

Input fields options to manage pagination and sorting for note Object

offSet:
Int

The number of records to skip per page from the beginning of the elements per page

perPage:
Int

Elements per page

sortDesc:

To sort in descending order or not

sortField:

To sort the list by the fields for the note Object

Example
{
  "offSet": "number",
  "perPage": "number",
  "sortDesc": "boolean",
  "sortField": "string"
}

NoteQueryFilter: object

Input type for filtering Notes

objectId:

One Id of an object of given type, see objectType

objectIds:
ObjectID

A list of Id's of the objects of given type, see objectType

objectType:

noteObjectType for filter notes

organizationId:

organizationId for filter clientGroups

state:

state of the Note

type:

type of the note

Example
{
  "objectId": "object",
  "objectIds": [
    "object"
  ],
  "objectType": "string",
  "organizationId": "object",
  "state": "string",
  "type": "string"
}

NoteStates: string

object
DELETED
object
DRAFT
object
PUBLISHED

NoteTransition: string

object
delete
object
publish

NoteTypes: string

object
ORGANIZATIONAL
object
PRIVATE
object
PUBLIC

Notification: object

body:
object
return:
arguments:
object
createdAt:
object
return:
arguments:
object
id:
object
return:
arguments:
object
link:
object
return:
arguments:
object
linkText:
object
return:
arguments:
object
notificationGroup:
object
return:
arguments:
object
organizationUser:
object
return:
arguments:
object
read:
object
return:
arguments:
object
title:
object
return:
arguments:
object
updatedAt:
object
return:
arguments:
object
Example
{
  "body": {
    "return": {
      "en": {
        "return": "string",
        "arguments": {}
      },
      "fr": {
        "return": "string",
        "arguments": {}
      }
    },
    "arguments": {}
  },
  "createdAt": {
    "return": "object",
    "arguments": {}
  },
  "id": {
    "return": "object",
    "arguments": {}
  },
  "link": {
    "return": "object",
    "arguments": {}
  },
  "linkText": {
    "return": {
      "en": {
        "return": "string",
        "arguments": {}
      },
      "fr": {
        "return": "string",
        "arguments": {}
      }
    },
    "arguments": {}
  },
  "notificationGroup": {
    "return": {
      "id": {
        "return": "object",
        "arguments": {}
      },
      "name": {
        "return": {
          "en": {
            "return": "string",
            "arguments": {}
          },
          "fr": {
            "return": "string",
            "arguments": {}
          }
        },
        "arguments": {}
      }
    },
    "arguments": {}
  },
  "organizationUser": {
    "return": {
      "accessType": {
        "return": "string",
        "arguments": {}
      },
      "apiTokens": {
        "return": [
          {
            "id": {
              "return": "object",
              "arguments": {}
            },
            "jwtToken": {
              "return": "string",
              "arguments": {}
            },
            "name": {
              "return": "string",
              "arguments": {}
            },
            "organization": {
              "return": {
                "browserTabTitle": {
                  "return": "string",
                  "arguments": {}
                },
                "faviconLink": {
                  "return": "string",
                  "arguments": {}
                },
                "id": {
                  "return": "object",
                  "arguments": {}
                },
                "name": {
                  "return": "string",
                  "arguments": {}
                },
                "parent": {}
              }
            }
          }
        ]
      }
    }
  }
}

NotificationDefinition: object

bodyTemplate:
object
return:
arguments:
object
createdAt:
object
return:
arguments:
object
id:
object
return:
arguments:
object
linkTemplate:
object
return:
arguments:
object
linkText:
object
return:
arguments:
object
name:
object
return:
arguments:
object
notificationGroup:
object
return:
arguments:
object
organization:
object
return:
arguments:
object
organizationOnly:
object
return:
arguments:
object
roleProfiles:
object
return:
RoleProfile
arguments:
object
titleTemplate:
object
return:
arguments:
object
triggerEventType:
object
return:
arguments:
object
triggerObjectType:
object
return:
arguments:
object
updatedAt:
object
return:
arguments:
object
Example
{
  "bodyTemplate": {
    "return": {
      "en": {
        "return": "string",
        "arguments": {}
      },
      "fr": {
        "return": "string",
        "arguments": {}
      }
    },
    "arguments": {}
  },
  "createdAt": {
    "return": "object",
    "arguments": {}
  },
  "id": {
    "return": "object",
    "arguments": {}
  },
  "linkTemplate": {
    "return": "object",
    "arguments": {}
  },
  "linkText": {
    "return": {
      "en": {
        "return": "string",
        "arguments": {}
      },
      "fr": {
        "return": "string",
        "arguments": {}
      }
    },
    "arguments": {}
  },
  "name": {
    "return": "object",
    "arguments": {}
  },
  "notificationGroup": {
    "return": {
      "id": {
        "return": "object",
        "arguments": {}
      },
      "name": {
        "return": {
          "en": {
            "return": "string",
            "arguments": {}
          },
          "fr": {
            "return": "string",
            "arguments": {}
          }
        },
        "arguments": {}
      }
    },
    "arguments": {}
  },
  "organization": {
    "return": {
      "accountTypeTaxRanks": {
        "return": [
          {
            "accountType": {
              "return": "string",
              "arguments": {}
            },
            "id": {
              "return": "object",
              "arguments": {}
            },
            "taxRank": {
              "return": "number",
              "arguments": {}
            }
          }
        ],
        "arguments": {}
      },
      "allowAccessToSubOrganizations": {
        "return": "boolean",
        "arguments": {}
      },
      "allowDirectCommunication": {
        "return": "boolean",
        "arguments": {}
      },
      "allowInactiveUserAdjustments": {
        "return": "boolean",
        "arguments": {}
      },
      "allowInactiveUserFeeCalculation": {
        "return": "boolean",
        "arguments": {}
      },
      "allowInactiveUserRebalancing": {
        "return": "boolean"
      }
    }
  }
}

NotificationDefinitionPaginationAndSorting: object

offSet:
Int
perPage:
Int
sortDesc:
sortField:
Example
{
  "offSet": "number",
  "perPage": "number",
  "sortDesc": "boolean",
  "sortField": "string"
}

NotificationDefinitionQueryFilter: object

organizationId:
Example
{
  "organizationId": "object"
}

NotificationGroup: object

id:
object
return:
arguments:
object
name:
object
return:
arguments:
object
Example
{
  "id": {
    "return": "object",
    "arguments": {}
  },
  "name": {
    "return": {
      "en": {
        "return": "string",
        "arguments": {}
      },
      "fr": {
        "return": "string",
        "arguments": {}
      }
    },
    "arguments": {}
  }
}

NotificationGroupPaginationAndSorting: object

offSet:
Int
perPage:
Int
sortDesc:
sortField:
Example
{
  "offSet": "number",
  "perPage": "number",
  "sortDesc": "boolean",
  "sortField": "string"
}

NotificationGroupQueryFilter: object

organizationId:
Example
{
  "organizationId": "object"
}

NotificationPaginationAndSorting: object

offSet:
Int
perPage:
Int
sortDesc:
sortField:
Example
{
  "offSet": "number",
  "perPage": "number",
  "sortDesc": "boolean",
  "sortField": "string"
}

NotificationQueryFilter: object

read:
Example
{
  "read": "boolean"
}

Object: object

Example
object

ObjectID: object

BSON Object ID

Example
object

OrgSubAccountTradingProcesses: string

object
INHERITED_FROM_PARENT
object
NO_AUTOMATION
object
PORTFOLIO_OPTIMIZER
object
REBALANCE_V1
object
REBALANCE_V2

Organization: object

accountTypeTaxRanks:
object
return:
AccountTypeTaxRank
arguments:
object
allowAccessToSubOrganizations:
object
return:
arguments:
object
allowDirectCommunication:
object
return:
arguments:
object
allowInactiveUserAdjustments:
object
return:
arguments:
object
allowInactiveUserFeeCalculation:
object
return:
arguments:
object
allowInactiveUserRebalancing:
object
return:
arguments:
object
allowInstantInvest:
object
return:
arguments:
object
allowPortfolioPerGoal:
object
return:
arguments:
object
allowPostOptimizationEditing:
object
return:
arguments:
object
allowViewSubTradeRequestPairs:
object
return:
arguments:
object
applicableJurisdictions:
object

Applicable list of jurisdictions (may be inherited from parent orgs).

return:
arguments:
object
applicableLocalization:
object

Applicable localization settings (this org or inherited from parent orgs)

return:
arguments:
object
autoInviteImportedUsers:
object

When true, imported users will be automatically invited to the platform

return:
arguments:
object
availableFeatureFlags:
object
return:
FeatureFlagTypes
arguments:
object
blockSuspiciousTransactions:
object
return:
arguments:
object
browserTabTitle:
object

The browserTabTitle of the organization used as website title

return:
arguments:
object
cashOnHoldToTradeDays:
object
return:
Int
arguments:
object
cashOnHoldToWithdrawDays:
object
return:
Int
arguments:
object
children:
object

All children directly related to the organization

return:
Organization
arguments:
object
custodian:
object
return:
arguments:
object
customUrl:
object
return:
arguments:
object
databaseAuthConnectionId:
object
return:
arguments:
object
databaseAuthConnectionName:
object
return:
arguments:
object
defaultAccountTypeTaxRanks:
object
return:
AccountTypeTaxRank
arguments:
object
defaultAdvisorRole:
object
return:
arguments:
object
defaultAuthenticationConnection:
object
return:
arguments:
object
defaultBillingSchedule:
object
return:
arguments:
object
defaultClientRole:
object
return:
arguments:
object
defaultCustodianConnection:
object
return:
arguments:
object
defaultFeeTier:
object
return:
arguments:
object
defaultSignUpRole:
object
return:
arguments:
object
defaultTradingProcess:
object
return:
arguments:
object
displayCurrency:
object
return:
arguments:
object
displayMenuBar:
object
return:
arguments:
object
embeddedExperienceLogoUrl:
object
return:
arguments:
object
enableMultiFactorAuthentication:
object
return:
arguments:
object
entityName:
object
return:
arguments:
object
excludeAdminFeesFromClients:
object
return:
arguments:
object
externalClientTokenEmailKey:
object
return:
arguments:
object
externalProvider:
object
return:
arguments:
object
faviconLink:
object

The faviconLink of the organization will display on the browser tab

return:
arguments:
object
helpCentreUrl:
object
return:
arguments:
object
id:
object
return:
arguments:
object
includeExternalClientTokenIntoContext:
object
return:
arguments:
object
isReferral:
object
return:
arguments:
object
jurisdictions:
object

This organization's enabled jurisdictions settings. If unset (=null), then inheritance apply.

return:
arguments:
object
jwtKeyUrl:
object

JWK url used to validate the partner-authorization token sent for M2M token exchange (used when tokenExchangeValidationType is JWK)

return:
arguments:
object
localization:
object

This organization's localization settings (countries, languages, currencies, date format)

return:
arguments:
object
logs:
object
return:
arguments:
object
input:
minInitialDepositCents:
object
return:
Int
arguments:
object
minInvestAmountCents:
object

Minimum amount needed to invest

return:
Int
arguments:
object
minRecurringDepositCents:
object
return:
Int
arguments:
object
name:
object

The name of the organization

return:
arguments:
object
parent:
object

The parent organization

return:
arguments:
object
parents:
object

All parent organizations

return:
Organization
arguments:
object
pendingInvitationsCount:
object

Indicates whether there are users that have not been invited yet or with an expired invitation

return:
Int
arguments:
object
permissions:
object

List of permissions that the organization has access to

return:
String
arguments:
object
profileReviewTimeInMonths:
object
return:
Int
arguments:
object
publicParent:
object

The parent organization with limited attributes that is accessible from sub-organizations.

return:
arguments:
object
repCode:
object

Custodian representative code

return:
arguments:
object
requireFeeApproval:
object
return:
arguments:
object
requireManualAccountApproval:
object
return:
arguments:
object
requireSubTradeRequestApproval:
object
return:
arguments:
object
revenueShareBps:
object
return:
arguments:
object
revenueShareTaxes:
object
return:
arguments:
object
reviewTransactions:
object
return:
arguments:
object
subdomain:
object

The subdomain of the organization used for logging in

return:
arguments:
object
supportUrl:
object
return:
arguments:
object
theme:
object
return:
arguments:
object
themeTokens:
object
return:
arguments:
object
tokenExchangeValidationType:
object
return:
arguments:
object
useClientOrgAuth0:
object
return:
arguments:
object
useParentArticles:
object
return:
arguments:
object
useParentAssetClasses:
object
return:
arguments:
object
useParentBillingSchedules:
object
return:
arguments:
object
useParentClientReportTemplates:
object
return:
arguments:
object
useParentCustodianConnections:
object
return:
arguments:
object
useParentCustomFields:
object
return:
arguments:
object
useParentDashboards:
object

Inherit parent organizations dashboards

return:
arguments:
object
useParentFeeTiers:
object
return:
arguments:
object
useParentFormTemplates:
object

Inherit parent organizations form templates

return:
arguments:
object
useParentIntegrations:
object
return:
arguments:
object
useParentLocalizations:
object
return:
arguments:
object
useParentModelPortfolios:
object
return:
arguments:
object
useParentNotificationDefinitions:
object
return:
arguments:
object
useParentNotificationGroups:
object
return:
arguments:
object
useParentPageConfigurations:
object
return:
arguments:
object
useParentProductShelf:
object
return:
arguments:
object
useParentRoleProfiles:
object
return:
arguments:
object
useParentSchedules:
object
return:
arguments:
object
useParentThemeTokens:
object
return:
arguments:
object
useParentThemes:
object
return:
arguments:
object
useParentWorkflows:
object
return:
arguments:
object
userManagementFeeBps:
object
return:
arguments:
object
validateUniquenessForSubOrganizations:
object
return:
arguments:
object
Example
{
  "accountTypeTaxRanks": {
    "return": [
      {
        "accountType": {
          "return": "string",
          "arguments": {}
        },
        "id": {
          "return": "object",
          "arguments": {}
        },
        "taxRank": {
          "return": "number",
          "arguments": {}
        }
      }
    ],
    "arguments": {}
  },
  "allowAccessToSubOrganizations": {
    "return": "boolean",
    "arguments": {}
  },
  "allowDirectCommunication": {
    "return": "boolean",
    "arguments": {}
  },
  "allowInactiveUserAdjustments": {
    "return": "boolean",
    "arguments": {}
  },
  "allowInactiveUserFeeCalculation": {
    "return": "boolean",
    "arguments": {}
  },
  "allowInactiveUserRebalancing": {
    "return": "boolean",
    "arguments": {}
  },
  "allowInstantInvest": {
    "return": "boolean",
    "arguments": {}
  },
  "allowPortfolioPerGoal": {
    "return": "boolean",
    "arguments": {}
  },
  "allowPostOptimizationEditing": {
    "return": "boolean",
    "arguments": {}
  },
  "allowViewSubTradeRequestPairs": {
    "return": "boolean",
    "arguments": {}
  },
  "applicableJurisdictions": {
    "return": {
      "all": {
        "return": "boolean",
        "arguments": {}
      },
      "only": {
        "return": [
          "string"
        ],
        "arguments": {}
      }
    },
    "arguments": {}
  },
  "applicableLocalization": {
    "return": {
      "countries": {
        "return": [
          "string"
        ],
        "arguments": {}
      },
      "dateFormat": {
        "return": "string",
        "arguments": {}
      },
      "defaultCurrency": {
        "return": "string",
        "arguments": {}
      },
      "defaultLanguage": {
        "return": "string",
        "arguments": {}
      },
      "id": {
        "return": "object",
        "arguments": {}
      },
      "languages": {
        "return": [
          "string"
        ],
        "arguments": {}
      },
      "name": {
        "return": "string",
        "arguments": {}
      }
    }
  }
}

OrganizationAuthenticationTheme: object

logo:
object
return:
arguments:
object
pageBackgroundColor:
object
return:
arguments:
object
primaryColor:
object
return:
arguments:
object
Example
{
  "logo": {
    "return": "string",
    "arguments": {}
  },
  "pageBackgroundColor": {
    "return": "string",
    "arguments": {}
  },
  "primaryColor": {
    "return": "string",
    "arguments": {}
  }
}

OrganizationAuthenticationThemeInput: object

logo:
pageBackgroundColor:
primaryColor:
Example
{
  "logo": "object",
  "pageBackgroundColor": "object",
  "primaryColor": "object"
}

OrganizationBilling: object

chargeableMarketValueCentsOnLastDay:
object
return:
arguments:
object
feeCents:
object
return:
arguments:
object
id:
object
return:
arguments:
object
marketValueCentsOnLastDay:
object
return:
arguments:
object
organization:
object
return:
arguments:
object
revenueShareCents:
object
return:
arguments:
object
revenueShareTaxCents:
object
return:
arguments:
object
salesTaxCents:
object
return:
arguments:
object
userManagementFeeCents:
object
return:
arguments:
object
Example
{
  "chargeableMarketValueCentsOnLastDay": {
    "return": "number",
    "arguments": {}
  },
  "feeCents": {
    "return": "number",
    "arguments": {}
  },
  "id": {
    "return": "object",
    "arguments": {}
  },
  "marketValueCentsOnLastDay": {
    "return": "number",
    "arguments": {}
  },
  "organization": {
    "return": {
      "accountTypeTaxRanks": {
        "return": [
          {
            "accountType": {
              "return": "string",
              "arguments": {}
            },
            "id": {
              "return": "object",
              "arguments": {}
            },
            "taxRank": {
              "return": "number",
              "arguments": {}
            }
          }
        ],
        "arguments": {}
      },
      "allowAccessToSubOrganizations": {
        "return": "boolean",
        "arguments": {}
      },
      "allowDirectCommunication": {
        "return": "boolean",
        "arguments": {}
      },
      "allowInactiveUserAdjustments": {
        "return": "boolean",
        "arguments": {}
      },
      "allowInactiveUserFeeCalculation": {
        "return": "boolean",
        "arguments": {}
      },
      "allowInactiveUserRebalancing": {
        "return": "boolean",
        "arguments": {}
      },
      "allowInstantInvest": {
        "return": "boolean",
        "arguments": {}
      },
      "allowPortfolioPerGoal": {
        "return": "boolean",
        "arguments": {}
      },
      "allowPostOptimizationEditing": {
        "return": "boolean",
        "arguments": {}
      },
      "allowViewSubTradeRequestPairs": {
        "return": "boolean",
        "arguments": {}
      },
      "applicableJurisdictions": {
        "return": {
          "all": {
            "return": "boolean",
            "arguments": {}
          },
          "only": {
            "return": [
              "string"
            ],
            "arguments": {}
          }
        },
        "arguments": {}
      },
      "applicableLocalization": {
        "return": {
          "countries": {
            "return": [
              "string"
            ],
            "arguments": {}
          },
          "dateFormat": {
            "return": "string",
            "arguments": {}
          },
          "defaultCurrency": {}
        }
      }
    }
  }
}

OrganizationFeatureFlag: object

featureFlags:
object
return:
FeatureFlagOption
arguments:
object
id:
object
return:
arguments:
object
Example
{
  "featureFlags": {
    "return": [
      {
        "enabled": {
          "return": "boolean",
          "arguments": {}
        },
        "type": {
          "return": "string",
          "arguments": {}
        }
      }
    ],
    "arguments": {}
  },
  "id": {
    "return": "object",
    "arguments": {}
  }
}

OrganizationLogsInput: object

filter:
pagination:
Example
{
  "filter": {
    "after": "object",
    "before": "object"
  },
  "pagination": {
    "offSet": "number",
    "perPage": "number",
    "sortDesc": "boolean",
    "sortField": "string"
  }
}

OrganizationLogsQueryFilter: object

after:
before:
Example
{
  "after": "object",
  "before": "object"
}

OrganizationPaginationAndSorting: object

offSet:
Int
perPage:
Int
sortDesc:
sortField:
Example
{
  "offSet": "number",
  "perPage": "number",
  "sortDesc": "boolean",
  "sortField": "string"
}

OrganizationQueryFilter: object

childrenFor:

Organization ID that you would to filter to only organizations under

searchText:

Text used to search the names of the organizations

Example
{
  "childrenFor": "object",
  "searchText": "string"
}

OrganizationRevenueShare: object

organization:
object
return:
arguments:
object
parent:
object
return:
arguments:
object
revenueShareBps:
object
return:
arguments:
object
revenueShareTaxes:
object
return:
arguments:
object
userManagementFeeBps:
object
return:
arguments:
object
Example
{
  "organization": {
    "return": {
      "accountTypeTaxRanks": {
        "return": [
          {
            "accountType": {
              "return": "string",
              "arguments": {}
            },
            "id": {
              "return": "object",
              "arguments": {}
            },
            "taxRank": {
              "return": "number",
              "arguments": {}
            }
          }
        ],
        "arguments": {}
      },
      "allowAccessToSubOrganizations": {
        "return": "boolean",
        "arguments": {}
      },
      "allowDirectCommunication": {
        "return": "boolean",
        "arguments": {}
      },
      "allowInactiveUserAdjustments": {
        "return": "boolean",
        "arguments": {}
      },
      "allowInactiveUserFeeCalculation": {
        "return": "boolean",
        "arguments": {}
      },
      "allowInactiveUserRebalancing": {
        "return": "boolean",
        "arguments": {}
      },
      "allowInstantInvest": {
        "return": "boolean",
        "arguments": {}
      },
      "allowPortfolioPerGoal": {
        "return": "boolean",
        "arguments": {}
      },
      "allowPostOptimizationEditing": {
        "return": "boolean",
        "arguments": {}
      },
      "allowViewSubTradeRequestPairs": {
        "return": "boolean",
        "arguments": {}
      },
      "applicableJurisdictions": {
        "return": {
          "all": {
            "return": "boolean",
            "arguments": {}
          },
          "only": {
            "return": [
              "string"
            ],
            "arguments": {}
          }
        },
        "arguments": {}
      },
      "applicableLocalization": {
        "return": {
          "countries": {
            "return": [
              "string"
            ],
            "arguments": {}
          },
          "dateFormat": {
            "return": "string",
            "arguments": {}
          },
          "defaultCurrency": {
            "return": "string",
            "arguments": {}
          },
          "defaultLanguage": {
            "return": "string",
            "arguments": {}
          },
          "id": {
            "return": "object",
            "arguments": {}
          },
          "languages": {
            "return": [
              "string"
            ],
            "arguments": {}
          },
          "name": {}
        }
      }
    }
  }
}

OrganizationTheme: object

authenticationTheme:
object
return:
arguments:
object
embeddedExperienceTheme:
object
return:
arguments:
object
logo:
object
return:
arguments:
object
sideBarColor:
object
return:
arguments:
object
Example
{
  "authenticationTheme": {
    "return": {
      "logo": {
        "return": "string",
        "arguments": {}
      },
      "pageBackgroundColor": {
        "return": "string",
        "arguments": {}
      },
      "primaryColor": {
        "return": "string",
        "arguments": {}
      }
    },
    "arguments": {}
  },
  "embeddedExperienceTheme": {
    "return": "object",
    "arguments": {}
  },
  "logo": {
    "return": "string",
    "arguments": {}
  },
  "sideBarColor": {
    "return": "string",
    "arguments": {}
  }
}

OrganizationThemeInput: object

authenticationTheme:
embeddedExperienceTheme:
logo:
sideBarColor:
Example
{
  "authenticationTheme": {
    "logo": "object",
    "pageBackgroundColor": "object",
    "primaryColor": "object"
  },
  "embeddedExperienceTheme": "object",
  "logo": "object",
  "sideBarColor": "object"
}

OrganizationUser: object

accessType:
object

Access type

return:
arguments:
object
apiTokens:
object

API Tokens related to the user

return:
ApiToken
arguments:
object
auth0invitationExpiresAt:
object

Auth0 Invitation expiration datetime

return:
arguments:
object
auth0invitationId:
object

Auth0 Invitation ID

return:
arguments:
object
authAudience:
object

Auth0 Audience type

return:
arguments:
object
authConnectionId:
object
return:
arguments:
object
authConnectionName:
object

Auth0 Connection name

return:
arguments:
object
authConnectionType:
object

Auth0 Connection type

return:
arguments:
object
avatar:
object
return:
arguments:
object
createdAt:
object
return:
arguments:
object
email:
object

Email of the organization user

return:
arguments:
object
entities:
object

Accessible entities (when accessType is ENTITY)

return:
OrganizationUserEntity
arguments:
object
firstName:
object

First Name of the organization user

return:
arguments:
object
id:
object
return:
arguments:
object
language:
object

Language of the organization user

return:
arguments:
object
lastLoggedInAt:
object

Last time the user has logged in

return:
arguments:
object
lastName:
object

Last Name of the organization user

return:
arguments:
object
mfaEnrollmentId:
object
return:
arguments:
object
organization:
object

Organization that the user belongs to

return:
arguments:
object
phone:
object

Phone of the organization user (MFA)

return:
arguments:
object
referenceId:
object

Auth0 Reference ID

return:
arguments:
object
role:
object

Role that the user has

return:
arguments:
object
unreadNotificationCount:
object
return:
Int
arguments:
object
updatedAt:
object
return:
arguments:
object
Example
{
  "accessType": {
    "return": "string",
    "arguments": {}
  },
  "apiTokens": {
    "return": [
      {
        "id": {
          "return": "object",
          "arguments": {}
        },
        "jwtToken": {
          "return": "string",
          "arguments": {}
        },
        "name": {
          "return": "string",
          "arguments": {}
        },
        "organization": {
          "return": {
            "browserTabTitle": {
              "return": "string",
              "arguments": {}
            },
            "faviconLink": {
              "return": "string",
              "arguments": {}
            },
            "id": {
              "return": "object",
              "arguments": {}
            },
            "name": {
              "return": "string",
              "arguments": {}
            },
            "parent": {
              "return": {
                "browserTabTitle": {
                  "return": "string",
                  "arguments": {}
                },
                "faviconLink": {
                  "return": "string",
                  "arguments": {}
                },
                "id": {
                  "return": "object",
                  "arguments": {}
                },
                "name": {
                  "return": "string",
                  "arguments": {}
                },
                "parent": {
                  "return": {
                    "browserTabTitle": {
                      "return": "string",
                      "arguments": {}
                    },
                    "faviconLink": {
                      "return": "string",
                      "arguments": {}
                    },
                    "id": {
                      "return": "object",
                      "arguments": {}
                    },
                    "name": {
                      "return": "string",
                      "arguments": {}
                    },
                    "parent": {
                      "return": {
                        "browserTabTitle": {
                          "return": "string",
                          "arguments": {}
                        },
                        "faviconLink": {
                          "return": "string",
                          "arguments": {}
                        },
                        "id": {
                          "return": "object",
                          "arguments": {}
                        },
                        "name": {
                          "return": "string",
                          "arguments": {}
                        },
                        "parent": {
                          "return": {}
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    ]
  }
}

OrganizationUserAccessTypes: string

object
ENTITY
object
ORGANIZATION

OrganizationUserDisplayOptions: object

hide:
order:
Int
organizationUserId:
Example
{
  "hide": "boolean",
  "order": "number",
  "organizationUserId": "object"
}

OrganizationUserEntity: object

entity:
object
return:
arguments:
object
readOnly:
object
return:
arguments:
object
relation:
object
return:
arguments:
object
Example
{
  "entity": {
    "return": {
      "accessibleBy": {
        "return": [
          {
            "displayOptions": {
              "return": {
                "hide": {
                  "return": "boolean",
                  "arguments": {}
                },
                "order": {
                  "return": "number",
                  "arguments": {}
                }
              },
              "arguments": {}
            },
            "organizationUser": {
              "return": {
                "accessType": {
                  "return": "string",
                  "arguments": {}
                },
                "apiTokens": {
                  "return": [
                    {
                      "id": {
                        "return": "object",
                        "arguments": {}
                      },
                      "jwtToken": {
                        "return": "string",
                        "arguments": {}
                      },
                      "name": {
                        "return": "string",
                        "arguments": {}
                      },
                      "organization": {
                        "return": {
                          "browserTabTitle": {
                            "return": "string",
                            "arguments": {}
                          },
                          "faviconLink": {
                            "return": "string",
                            "arguments": {}
                          },
                          "id": {
                            "return": "object",
                            "arguments": {}
                          },
                          "name": {
                            "return": "string",
                            "arguments": {}
                          },
                          "parent": {
                            "return": {
                              "browserTabTitle": {
                                "return": "string",
                                "arguments": {}
                              },
                              "faviconLink": {
                                "return": "string",
                                "arguments": {}
                              },
                              "id": {
                                "return": "object",
                                "arguments": {}
                              },
                              "name": {
                                "return": "string",
                                "arguments": {}
                              },
                              "parent": {
                                "return": {
                                  "browserTabTitle": {
                                    "return": "string",
                                    "arguments": {}
                                  },
                                  "faviconLink": {
                                    "return": "string",
                                    "arguments": {}
                                  },
                                  "id": {
                                    "return": "object",
                                    "arguments": {}
                                  },
                                  "name": {
                                    "return": "string",
                                    "arguments": {}
                                  }
                                }
                              }
                            }
                          }
                        }
                      }
                    }
                  ]
                }
              }
            }
          }
        ]
      }
    }
  }
}

OrganizationUserEntityInput: object

entityId:
readOnly:
Example
{
  "entityId": "object",
  "readOnly": "boolean"
}

OrganizationUserEntityRelationTypes: string

object
ADVISOR
object
OTHER
object
OWNER
object
POWER_OF_ATTORNEY

OrganizationUserPaginationAndSorting: object

offSet:
Int
perPage:
Int
sortDesc:
sortField:
Example
{
  "offSet": "number",
  "perPage": "number",
  "sortDesc": "boolean",
  "sortField": "string"
}

OrganizationUserQueryFilter: object

accessType:
authAudience:
childrenForOrganizationId:
organizationId:

Organization ID that you would to filter users under

parentForOrganizationId:
roleIds:
ObjectID
roleProfileId:
searchText:

Text used to search the names of the organizations

Example
{
  "accessType": "string",
  "authAudience": "string",
  "childrenForOrganizationId": "object",
  "organizationId": "object",
  "parentForOrganizationId": "object",
  "roleIds": [
    "object"
  ],
  "roleProfileId": "object",
  "searchText": "object"
}

OverrideAccountsTaxRanksInput: object

accountsTaxRanks:
AccountsTaxRanksInput
Example
{
  "accountsTaxRanks": [
    {
      "accountId": "object",
      "overrideTaxRank": "number"
    }
  ]
}

PageConfiguration: object

createdAt:
object
return:
arguments:
object
id:
object
return:
arguments:
object
name:
object
return:
arguments:
object
options:
object
return:
arguments:
object
organization:
object
return:
arguments:
object
publicOrganization:
object

Organization with limited attributes that is accessible from sub-organizations.

return:
arguments:
object
tabs:
object
return:
TabConfiguration
arguments:
object
type:
object
return:
arguments:
object
updatedAt:
object
return:
arguments:
object
Example
{
  "createdAt": {
    "return": "object",
    "arguments": {}
  },
  "id": {
    "return": "object",
    "arguments": {}
  },
  "name": {
    "return": "string",
    "arguments": {}
  },
  "options": {
    "return": "object",
    "arguments": {}
  },
  "organization": {
    "return": {
      "accountTypeTaxRanks": {
        "return": [
          {
            "accountType": {
              "return": "string",
              "arguments": {}
            },
            "id": {
              "return": "object",
              "arguments": {}
            },
            "taxRank": {
              "return": "number",
              "arguments": {}
            }
          }
        ],
        "arguments": {}
      },
      "allowAccessToSubOrganizations": {
        "return": "boolean",
        "arguments": {}
      },
      "allowDirectCommunication": {
        "return": "boolean",
        "arguments": {}
      },
      "allowInactiveUserAdjustments": {
        "return": "boolean",
        "arguments": {}
      },
      "allowInactiveUserFeeCalculation": {
        "return": "boolean",
        "arguments": {}
      },
      "allowInactiveUserRebalancing": {
        "return": "boolean",
        "arguments": {}
      },
      "allowInstantInvest": {
        "return": "boolean",
        "arguments": {}
      },
      "allowPortfolioPerGoal": {
        "return": "boolean",
        "arguments": {}
      },
      "allowPostOptimizationEditing": {
        "return": "boolean",
        "arguments": {}
      },
      "allowViewSubTradeRequestPairs": {
        "return": "boolean",
        "arguments": {}
      },
      "applicableJurisdictions": {
        "return": {
          "all": {
            "return": "boolean",
            "arguments": {}
          },
          "only": {
            "return": [
              "string"
            ],
            "arguments": {}
          }
        },
        "arguments": {}
      },
      "applicableLocalization": {
        "return": {
          "countries": {
            "return": [
              "string"
            ],
            "arguments": {}
          },
          "dateFormat": {
            "return": "string",
            "arguments": {}
          },
          "defaultCurrency": {}
        }
      }
    }
  }
}

PageConfigurationQueryFilter: object

organizationId:
type:
Example
{
  "organizationId": "object",
  "type": "string"
}

PageConfigurationTypes: string

object
ACCOUNT
object
GOAL
object
HOUSEHOLD
object
INDIVIDUAL
object
NON_INDIVIDUAL
object
SUB_ACCOUNT

Pages: string

object
ACCOUNTS_DETAIL
object
ACCOUNTS_REVIEW
object
ANNUAL_SUITABILITY_REVIEW
object
ASSET_CLASSES
object
BANK_ACCOUNTS_TO_REVIEW
object
BILLING_MANAGEMENT
object
BILLING_SCHEDULES
object
BUILD_MODELS
object
BULK_IMPORT
object
BULK_TRADER
object
CLIENTS
object
COMPLIANCE_REVIEW
object
CONFIGURE_MODELS
object
CORPORATIONS
object
DEVELOPER_SETTINGS
object
ELDERLY_CLIENTS
object
FEE_GRIDS
object
FEE_REPORT
object
GOALS_DETAIL
object
HOME
object
HOUSEHOLDS
object
INCURRED_FEES
object
INDIVIDUAL_CLIENTS
object
INSTITUTIONS_TO_REVIEW
object
MODEL_PORTFOLIOS
object
NEWS_AND_INSIGHT
object
NON_INDIVIDUAL_CLIENTS
object
ORGANIZATION_REVENUE_SHARE
object
ORGANIZATION_SETTINGS
object
PORTFOLIO_OPTIMIZER
object
PRODUCT_SHELF
object
REBALANCE_REPORT
object
REBALANCING
object
RECONCILIATION
object
REPORTS
object
SCHEDULES
object
STATEMENTS_REVIEW
object
SUB_ACCOUNTS_DETAIL
object
SUSPICIOUS_TRANSACTIONS
object
TAX_LOSS_HARVESTING
object
TRANSACTIONS
object
WORKFLOWS

PaginationAndSorting: object

offSet:
Int
perPage:
Int
sortDesc:
sortField:
Example
{
  "offSet": "number",
  "perPage": "number",
  "sortDesc": "boolean",
  "sortField": "string"
}

PaginationInput: object

page:
Int
perPage:
Int
sortDesc:
sortField:
Example
{
  "page": "number",
  "perPage": "number",
  "sortDesc": "boolean",
  "sortField": "string"
}

PairSubTradeRequestsInput: object

bulkTradeRequestId:
Example
{
  "bulkTradeRequestId": "object"
}

Permission: object

clientEnabled:
object

Whether or not the permission is accessible in the Client App

return:
arguments:
object
translatedDescription:
object

The description of the permission

return:
arguments:
object
value:
object

The key of the permissions

return:
arguments:
object
Example
{
  "clientEnabled": {
    "return": "boolean",
    "arguments": {}
  },
  "translatedDescription": {
    "return": {
      "en": {
        "return": "string",
        "arguments": {}
      },
      "fr": {
        "return": "string",
        "arguments": {}
      }
    },
    "arguments": {}
  },
  "value": {
    "return": "string",
    "arguments": {}
  }
}

PhysicalAddress: object

User's physical address

city:
object

City

return:
arguments:
object
country:
object

Country

return:
arguments:
object
houseNumber:
object

House number

return:
arguments:
object
jurisdiction:
object

Jurisdiction

return:
arguments:
object
neighborhood:
object

Neighbourhood

return:
arguments:
object
postal:
object

Postal code

return:
arguments:
object
province:
object

Province; deprecated

return:
arguments:
object
streetName:
object

Street name

return:
arguments:
object
unitNumber:
object

Unit number

return:
arguments:
object
Example
{
  "city": {
    "return": "string",
    "arguments": {}
  },
  "country": {
    "return": "string",
    "arguments": {}
  },
  "houseNumber": {
    "return": "string",
    "arguments": {}
  },
  "jurisdiction": {
    "return": "string",
    "arguments": {}
  },
  "neighborhood": {
    "return": "string",
    "arguments": {}
  },
  "postal": {
    "return": "string",
    "arguments": {}
  },
  "province": {
    "return": "string",
    "arguments": {}
  },
  "streetName": {
    "return": "string",
    "arguments": {}
  },
  "unitNumber": {
    "return": "string",
    "arguments": {}
  }
}

PhysicalAddressInput: object

User's physical address

city:

City

country:

Country

houseNumber:

House number

jurisdiction:

Jurisdiction

neighborhood:

Neighbourhood

postal:

Postal code

province:

Province

streetName:

Street name

unitNumber:

Unit number

Example
{
  "city": "object",
  "country": "string",
  "houseNumber": "object",
  "jurisdiction": "string",
  "neighborhood": "object",
  "postal": "object",
  "province": "string",
  "streetName": "object",
  "unitNumber": "object"
}

PortfolioOptimizer: object

createdAt:
object
return:
arguments:
object
expectedTotalSubTradeRequests:
object
return:
Int
arguments:
object
id:
object
return:
arguments:
object
numPortfolios:
object
return:
Int
arguments:
object
organization:
object
return:
arguments:
object
pauseAt:
object
return:
arguments:
object
state:
object
return:
arguments:
object
subTradeRequestsCreated:
object
return:
Int
arguments:
object
type:
object
return:
arguments:
object
Example
{
  "createdAt": {
    "return": "object",
    "arguments": {}
  },
  "expectedTotalSubTradeRequests": {
    "return": "number",
    "arguments": {}
  },
  "id": {
    "return": "object",
    "arguments": {}
  },
  "numPortfolios": {
    "return": "number",
    "arguments": {}
  },
  "organization": {
    "return": {
      "browserTabTitle": {
        "return": "string",
        "arguments": {}
      },
      "faviconLink": {
        "return": "string",
        "arguments": {}
      },
      "id": {
        "return": "object",
        "arguments": {}
      },
      "name": {
        "return": "string",
        "arguments": {}
      },
      "parent": {
        "return": {
          "browserTabTitle": {
            "return": "string",
            "arguments": {}
          },
          "faviconLink": {
            "return": "string",
            "arguments": {}
          },
          "id": {
            "return": "object",
            "arguments": {}
          },
          "name": {
            "return": "string",
            "arguments": {}
          },
          "parent": {
            "return": {
              "browserTabTitle": {
                "return": "string",
                "arguments": {}
              },
              "faviconLink": {
                "return": "string",
                "arguments": {}
              },
              "id": {
                "return": "object",
                "arguments": {}
              },
              "name": {
                "return": "string",
                "arguments": {}
              },
              "parent": {
                "return": {
                  "browserTabTitle": {
                    "return": "string",
                    "arguments": {}
                  },
                  "faviconLink": {
                    "return": "string",
                    "arguments": {}
                  },
                  "id": {
                    "return": "object",
                    "arguments": {}
                  },
                  "name": {
                    "return": "string",
                    "arguments": {}
                  },
                  "parent": {
                    "return": {
                      "browserTabTitle": {
                        "return": "string",
                        "arguments": {}
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

PortfolioOptimizerPausableStates: string

object
OPTIMAL_PORTFOLIOS_GENERATED
object
PURCHASES_SOLVED
object
REBALANCED
object
REDEMPTIONS_SOLVED
object
TAX_OPTIMIZED

PortfolioOptimizerQueryFilter: object

createdAt:
numPortfolios:
Int
organizationId:
state:
type:
Example
{
  "createdAt": "object",
  "numPortfolios": "number",
  "organizationId": "object",
  "state": "string",
  "type": "string"
}

PortfolioOptimizerStates: string

object
CANCELED
object
COMPLETED
object
GENERATING_ALLOCATIONS
object
INITIATED
object
OPTIMAL_PORTFOLIOS_GENERATED
object
OPTIMAL_PORTFOLIOS_GENERATING
object
PURCHASES_SOLVED
object
REBALANCED
object
REBALANCING
object
REDEMPTIONS_SOLVED
object
SOLVING_FOR_PURCHASES
object
SOLVING_FOR_REDEMPTIONS
object
TAX_OPTIMIZED
object
TAX_OPTIMIZING

PortfolioOptimizerTransition: string

object
cancel
object
complete

PortfolioOptimizerTypes: string

object
DRIFT
object
TRANSFER

PortfolioReport: object

bulkTradeRunReasons:
object
return:
BulkTradeRunReason
arguments:
object
cashAvailableForTradeCents:
object
return:
arguments:
object
cashCents:
object
return:
arguments:
object
driftRebalanceRequired:
object
return:
arguments:
object
expectedCashCents:
object
return:
arguments:
object
holdings:
object
return:
HoldingReport
arguments:
object
id:
object
return:
arguments:
object
lastOptimizedBy:
object
return:
arguments:
object
liquidateRebalanceRequired:
object
return:
arguments:
object
modelPortfolio:
object
return:
arguments:
object
modelPortfolioType:
object
return:
arguments:
object
object:
object
return:
object
arguments:
object
pendingSubTradeRequests:
object
return:
Int
arguments:
object
subAccounts:
object
return:
SubAccountReport
arguments:
object
transferRebalanceRequired:
object
return:
arguments:
object
Example
{
  "bulkTradeRunReasons": {
    "return": [
      {
        "id": {
          "return": "object",
          "arguments": {}
        },
        "reason": {
          "return": "string",
          "arguments": {}
        },
        "total": {
          "return": "number",
          "arguments": {}
        },
        "unblockedSince": {
          "return": "object",
          "arguments": {}
        }
      }
    ],
    "arguments": {}
  },
  "cashAvailableForTradeCents": {
    "return": "object",
    "arguments": {}
  },
  "cashCents": {
    "return": "object",
    "arguments": {}
  },
  "driftRebalanceRequired": {
    "return": "boolean",
    "arguments": {}
  },
  "expectedCashCents": {
    "return": "object",
    "arguments": {}
  },
  "holdings": {
    "return": [
      {
        "actualPercentage": {
          "return": "number",
          "arguments": {}
        },
        "expectedPercentage": {
          "return": "number",
          "arguments": {}
        },
        "expectedValueCents": {
          "return": "number",
          "arguments": {}
        },
        "financialProduct": {
          "return": {
            "assignable": {
              "return": "boolean",
              "arguments": {}
            },
            "autoUpdatePrices": {
              "return": "boolean",
              "arguments": {}
            },
            "children": {
              "return": [
                {
                  "financialProduct": {
                    "return": {
                      "assignable": {
                        "return": "boolean",
                        "arguments": {}
                      },
                      "autoUpdatePrices": {
                        "return": "boolean",
                        "arguments": {}
                      },
                      "children": {
                        "return": [
                          {
                            "financialProduct": {
                              "return": {
                                "assignable": {
                                  "return": "boolean",
                                  "arguments": {}
                                },
                                "autoUpdatePrices": {
                                  "return": "boolean",
                                  "arguments": {}
                                },
                                "children": {
                                  "return": [
                                    {
                                      "financialProduct": {}
                                    }
                                  ]
                                }
                              }
                            }
                          }
                        ]
                      }
                    }
                  }
                }
              ]
            }
          }
        }
      }
    ]
  }
}

PortfolioReportObject:

Example

PortfolioReportQueryFilter: object

anyRebalanceRequired:
bulkTradeRequiredReason:
cashTrigger:
driftRebalanceRequired:
driftTrigger:
goalId:
lastOptimizedBy:
liquidateRebalanceRequired:
modelPortfolioId:
modelPortfolioType:
organizationId:
pendingSubTradeRequests:
subAccountId:
transferRebalanceRequired:
Example
{
  "anyRebalanceRequired": "boolean",
  "bulkTradeRequiredReason": "string",
  "cashTrigger": "boolean",
  "driftRebalanceRequired": "boolean",
  "driftTrigger": "boolean",
  "goalId": "object",
  "lastOptimizedBy": "object",
  "liquidateRebalanceRequired": "boolean",
  "modelPortfolioId": "object",
  "modelPortfolioType": "string",
  "organizationId": "object",
  "pendingSubTradeRequests": "boolean",
  "subAccountId": "object",
  "transferRebalanceRequired": "boolean"
}

PortfolioReportsPagination: object

offSet:
Int
perPage:
Int
Example
{
  "offSet": "number",
  "perPage": "number"
}

PreviewClientReportResponse: object

html:
object
return:
arguments:
object
Example
{
  "html": {
    "return": "string",
    "arguments": {}
  }
}

PreviewFilledPdfInput: object

accountId:
clientGroupId:
goalId:
scheduledTransferId:
subAccountId:
type:
userId:
Example
{
  "accountId": "object",
  "clientGroupId": "object",
  "goalId": "object",
  "scheduledTransferId": "object",
  "subAccountId": "object",
  "type": "string",
  "userId": "object"
}

PreviewFilledPdfResponse: object

url:
object
return:
arguments:
object
Example
{
  "url": {
    "return": "string",
    "arguments": {}
  }
}

PreviewFormAgreementInput: object

accountId:
clientGroupId:
goalId:
language:
raw:
scheduledTransferId:
subAccountId:
type:
userId:
Example
{
  "accountId": "object",
  "clientGroupId": "object",
  "goalId": "object",
  "language": "string",
  "raw": "boolean",
  "scheduledTransferId": "object",
  "subAccountId": "object",
  "type": "string",
  "userId": "object"
}

PreviewFormAgreementResponse: object

html:
object
return:
arguments:
object
Example
{
  "html": {
    "return": "string",
    "arguments": {}
  }
}

PreviousSubStepInput: object

workflowCompletionId:
Example
{
  "workflowCompletionId": "object"
}

PreviousSubStepResponse: object

workflowCompletion:
object
return:
arguments:
object
Example
{
  "workflowCompletion": {
    "return": {
      "context": {
        "return": "object",
        "arguments": {}
      },
      "createdAt": {
        "return": "object",
        "arguments": {}
      },
      "currentStep": {
        "return": {
          "id": {
            "return": "object",
            "arguments": {}
          },
          "name": {
            "return": {
              "en": {
                "return": "string",
                "arguments": {}
              },
              "fr": {
                "return": "string",
                "arguments": {}
              }
            },
            "arguments": {}
          },
          "subSteps": {
            "return": [
              {
                "canGoBack": {
                  "return": "boolean",
                  "arguments": {}
                },
                "completeableBy": {
                  "return": [
                    "string"
                  ],
                  "arguments": {}
                },
                "id": {
                  "return": "object",
                  "arguments": {}
                },
                "options": {
                  "return": "object",
                  "arguments": {}
                },
                "rolesCompleteableBy": {
                  "return": [
                    {
                      "accessiblePages": {
                        "return": [
                          "string"
                        ],
                        "arguments": {}
                      },
                      "accountPageConfiguration": {
                        "return": {
                          "createdAt": {
                            "return": "object",
                            "arguments": {}
                          },
                          "id": {
                            "return": "object",
                            "arguments": {}
                          },
                          "name": {
                            "return": "string",
                            "arguments": {}
                          },
                          "options": {
                            "return": "object",
                            "arguments": {}
                          },
                          "organization": {
                            "return": {
                              "accountTypeTaxRanks": {
                                "return": [
                                  {
                                    "accountType": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "id": {
                                      "return": "object",
                                      "arguments": {}
                                    },
                                    "taxRank": {
                                      "return": "number",
                                      "arguments": {}
                                    }
                                  }
                                ],
                                "arguments": {}
                              }
                            }
                          }
                        }
                      }
                    }
                  ]
                }
              }
            ]
          }
        }
      }
    }
  }
}

PrimaryAssetClassHoldings: object

assetClass:
object
return:
arguments:
object
percentage:
object
return:
arguments:
object
secondaryAssetClassHoldings:
object
return:
SecondaryAssetClassHoldings
arguments:
object
totalCents:
object
return:
arguments:
object
Example
{
  "assetClass": {
    "return": {
      "description": {
        "return": "string",
        "arguments": {}
      },
      "id": {
        "return": "object",
        "arguments": {}
      },
      "includeCash": {
        "return": "boolean",
        "arguments": {}
      },
      "key": {
        "return": "string",
        "arguments": {}
      },
      "name": {
        "return": "string",
        "arguments": {}
      },
      "state": {
        "return": "string",
        "arguments": {}
      },
      "translatedDescription": {
        "return": {
          "en": {
            "return": "string",
            "arguments": {}
          },
          "fr": {
            "return": "string",
            "arguments": {}
          }
        },
        "arguments": {}
      },
      "translatedName": {
        "return": {
          "en": {
            "return": "string",
            "arguments": {}
          },
          "fr": {
            "return": "string",
            "arguments": {}
          }
        },
        "arguments": {}
      }
    },
    "arguments": {}
  },
  "percentage": {
    "return": "number",
    "arguments": {}
  },
  "secondaryAssetClassHoldings": {
    "return": [
      {
        "assetClass": {
          "return": {
            "description": {
              "return": "string",
              "arguments": {}
            },
            "id": {
              "return": "object",
              "arguments": {}
            },
            "includeCash": {
              "return": "boolean",
              "arguments": {}
            },
            "key": {
              "return": "string",
              "arguments": {}
            },
            "name": {
              "return": "string",
              "arguments": {}
            },
            "state": {
              "return": "string",
              "arguments": {}
            },
            "translatedDescription": {
              "return": {
                "en": {
                  "return": "string",
                  "arguments": {}
                },
                "fr": {
                  "return": "string",
                  "arguments": {}
                }
              },
              "arguments": {}
            }
          }
        }
      }
    ]
  }
}

ProductMarketData: object

country:
object
return:
arguments:
object
currency:
object
return:
arguments:
object
exchange:
object
return:
arguments:
object
isin:
object
return:
arguments:
object
name:
object
return:
arguments:
object
ric:
object
return:
arguments:
object
ticker:
object
return:
arguments:
object
type:
object
return:
arguments:
object
Example
{
  "country": {
    "return": "string",
    "arguments": {}
  },
  "currency": {
    "return": "string",
    "arguments": {}
  },
  "exchange": {
    "return": "string",
    "arguments": {}
  },
  "isin": {
    "return": "string",
    "arguments": {}
  },
  "name": {
    "return": "string",
    "arguments": {}
  },
  "ric": {
    "return": "string",
    "arguments": {}
  },
  "ticker": {
    "return": "string",
    "arguments": {}
  },
  "type": {
    "return": "string",
    "arguments": {}
  }
}

PublicOrganization: object

Organization with limited attributes that is accessible from sub-organizations.

browserTabTitle:
object

The browserTabTitle of the organization used as website title

return:
arguments:
object
faviconLink:
object

The faviconLink of the organization will display on the browser tab

return:
arguments:
object
id:
object
return:
arguments:
object
name:
object

The name of the organization

return:
arguments:
object
parent:
object

The parent organization

return:
arguments:
object
subdomain:
object

The subdomain of the organization used for logging in

return:
arguments:
object
theme:
object
return:
arguments:
object
Example
{
  "browserTabTitle": {
    "return": "string",
    "arguments": {}
  },
  "faviconLink": {
    "return": "string",
    "arguments": {}
  },
  "id": {
    "return": "object",
    "arguments": {}
  },
  "name": {
    "return": "string",
    "arguments": {}
  },
  "parent": {
    "return": {
      "browserTabTitle": {
        "return": "string",
        "arguments": {}
      },
      "faviconLink": {
        "return": "string",
        "arguments": {}
      },
      "id": {
        "return": "object",
        "arguments": {}
      },
      "name": {
        "return": "string",
        "arguments": {}
      },
      "parent": {
        "return": {
          "browserTabTitle": {
            "return": "string",
            "arguments": {}
          },
          "faviconLink": {
            "return": "string",
            "arguments": {}
          },
          "id": {
            "return": "object",
            "arguments": {}
          },
          "name": {
            "return": "string",
            "arguments": {}
          },
          "parent": {
            "return": {
              "browserTabTitle": {
                "return": "string",
                "arguments": {}
              },
              "faviconLink": {
                "return": "string",
                "arguments": {}
              },
              "id": {
                "return": "object",
                "arguments": {}
              },
              "name": {
                "return": "string",
                "arguments": {}
              },
              "parent": {
                "return": {
                  "browserTabTitle": {
                    "return": "string",
                    "arguments": {}
                  },
                  "faviconLink": {
                    "return": "string",
                    "arguments": {}
                  },
                  "id": {
                    "return": "object",
                    "arguments": {}
                  },
                  "name": {
                    "return": "string",
                    "arguments": {}
                  },
                  "parent": {
                    "return": {
                      "browserTabTitle": {
                        "return": "string",
                        "arguments": {}
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

PublicOrganizationQueryFilter: object

childrenFor:

Organization ID that you would to filter to only organizations under

referenceIds:
String

List of Organization referenceIds

searchText:

Text used to search the names of the organizations

Example
{
  "childrenFor": "object",
  "referenceIds": [
    "string"
  ],
  "searchText": "string"
}

PublicOrganizationUser: object

OrganizationUser with limited attributes that is accessible from sub-organizations.

email:
object

Email of the organization user

return:
arguments:
object
firstName:
object

First Name of the organization user

return:
arguments:
object
id:
object
return:
arguments:
object
language:
object

Language of the organization user

return:
arguments:
object
lastName:
object

Last Name of the organization user

return:
arguments:
object
organization:
object

Organization that the user belongs to

return:
arguments:
object
referenceId:
object

Auth0 Reference ID

return:
arguments:
object
role:
object

Role that the user has

return:
arguments:
object
Example
{
  "email": {
    "return": "string",
    "arguments": {}
  },
  "firstName": {
    "return": "string",
    "arguments": {}
  },
  "id": {
    "return": "object",
    "arguments": {}
  },
  "language": {
    "return": "string",
    "arguments": {}
  },
  "lastName": {
    "return": "string",
    "arguments": {}
  },
  "organization": {
    "return": {
      "browserTabTitle": {
        "return": "string",
        "arguments": {}
      },
      "faviconLink": {
        "return": "string",
        "arguments": {}
      },
      "id": {
        "return": "object",
        "arguments": {}
      },
      "name": {
        "return": "string",
        "arguments": {}
      },
      "parent": {
        "return": {
          "browserTabTitle": {
            "return": "string",
            "arguments": {}
          },
          "faviconLink": {
            "return": "string",
            "arguments": {}
          },
          "id": {
            "return": "object",
            "arguments": {}
          },
          "name": {
            "return": "string",
            "arguments": {}
          },
          "parent": {
            "return": {
              "browserTabTitle": {
                "return": "string",
                "arguments": {}
              },
              "faviconLink": {
                "return": "string",
                "arguments": {}
              },
              "id": {
                "return": "object",
                "arguments": {}
              },
              "name": {
                "return": "string",
                "arguments": {}
              },
              "parent": {
                "return": {
                  "browserTabTitle": {
                    "return": "string",
                    "arguments": {}
                  },
                  "faviconLink": {
                    "return": "string",
                    "arguments": {}
                  },
                  "id": {
                    "return": "object",
                    "arguments": {}
                  },
                  "name": {
                    "return": "string",
                    "arguments": {}
                  },
                  "parent": {
                    "return": {}
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

PublicRole: object

Role with limited attributes that is accessible from sub-organizations.

id:
object
return:
arguments:
object
organization:
object

Organization that owns the role

return:
arguments:
object
roleProfile:
object

Role Profile

return:
arguments:
object
translatedDescription:
object

The description of the role

return:
arguments:
object
translatedName:
object

The name of the role

return:
arguments:
object
Example
{
  "id": {
    "return": "object",
    "arguments": {}
  },
  "organization": {
    "return": {
      "browserTabTitle": {
        "return": "string",
        "arguments": {}
      },
      "faviconLink": {
        "return": "string",
        "arguments": {}
      },
      "id": {
        "return": "object",
        "arguments": {}
      },
      "name": {
        "return": "string",
        "arguments": {}
      },
      "parent": {
        "return": {
          "browserTabTitle": {
            "return": "string",
            "arguments": {}
          },
          "faviconLink": {
            "return": "string",
            "arguments": {}
          },
          "id": {
            "return": "object",
            "arguments": {}
          },
          "name": {
            "return": "string",
            "arguments": {}
          },
          "parent": {
            "return": {
              "browserTabTitle": {
                "return": "string",
                "arguments": {}
              },
              "faviconLink": {
                "return": "string",
                "arguments": {}
              },
              "id": {
                "return": "object",
                "arguments": {}
              },
              "name": {
                "return": "string",
                "arguments": {}
              },
              "parent": {
                "return": {
                  "browserTabTitle": {
                    "return": "string",
                    "arguments": {}
                  },
                  "faviconLink": {
                    "return": "string",
                    "arguments": {}
                  },
                  "id": {
                    "return": "object",
                    "arguments": {}
                  },
                  "name": {
                    "return": "string",
                    "arguments": {}
                  },
                  "parent": {
                    "return": {
                      "browserTabTitle": {
                        "return": "string",
                        "arguments": {}
                      },
                      "faviconLink": {
                        "return": "string",
                        "arguments": {}
                      },
                      "id": {
                        "return": "object",
                        "arguments": {}
                      },
                      "name": {
                        "return": "string",
                        "arguments": {}
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

PublicRoleProfile: object

RoleProfile with limited attributes that is accessible from sub-organizations.

id:
object
return:
arguments:
object
organization:
object
return:
arguments:
object
translatedDescription:
object
return:
arguments:
object
translatedName:
object
return:
arguments:
object
Example
{
  "id": {
    "return": "object",
    "arguments": {}
  },
  "organization": {
    "return": {
      "browserTabTitle": {
        "return": "string",
        "arguments": {}
      },
      "faviconLink": {
        "return": "string",
        "arguments": {}
      },
      "id": {
        "return": "object",
        "arguments": {}
      },
      "name": {
        "return": "string",
        "arguments": {}
      },
      "parent": {
        "return": {
          "browserTabTitle": {
            "return": "string",
            "arguments": {}
          },
          "faviconLink": {
            "return": "string",
            "arguments": {}
          },
          "id": {
            "return": "object",
            "arguments": {}
          },
          "name": {
            "return": "string",
            "arguments": {}
          },
          "parent": {
            "return": {
              "browserTabTitle": {
                "return": "string",
                "arguments": {}
              },
              "faviconLink": {
                "return": "string",
                "arguments": {}
              },
              "id": {
                "return": "object",
                "arguments": {}
              },
              "name": {
                "return": "string",
                "arguments": {}
              },
              "parent": {
                "return": {
                  "browserTabTitle": {
                    "return": "string",
                    "arguments": {}
                  },
                  "faviconLink": {
                    "return": "string",
                    "arguments": {}
                  },
                  "id": {
                    "return": "object",
                    "arguments": {}
                  },
                  "name": {
                    "return": "string",
                    "arguments": {}
                  },
                  "parent": {
                    "return": {
                      "browserTabTitle": {
                        "return": "string",
                        "arguments": {}
                      },
                      "faviconLink": {
                        "return": "string",
                        "arguments": {}
                      },
                      "id": {
                        "return": "object",
                        "arguments": {}
                      },
                      "name": {
                        "return": "string",
                        "arguments": {}
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

PublishHistoryInput: object

accountId:
endDate:
goalId:
organizationId:
startDate:
subAccountId:
userId:
Example
{
  "accountId": "object",
  "endDate": "object",
  "goalId": "object",
  "organizationId": "object",
  "startDate": "object",
  "subAccountId": "object",
  "userId": "object"
}

PublishPendingSubTradeRequestTotalsInput: object

subAccountId:
Example
{
  "subAccountId": "object"
}

QueryFilter: object

accountId:
accountType:
clientGroupId:
createdAtAfter:
createdAtBefore:
goalId:
initiatedByRepresentative:
organizationId:
source:
state:
subAccountId:
type:
userId:
userIds:
ObjectID
Example
{
  "accountId": "object",
  "accountType": "string",
  "clientGroupId": "object",
  "createdAtAfter": "object",
  "createdAtBefore": "object",
  "goalId": "object",
  "initiatedByRepresentative": "boolean",
  "organizationId": "object",
  "source": "string",
  "state": "string",
  "subAccountId": "object",
  "type": "string",
  "userId": "object",
  "userIds": [
    "object"
  ]
}

ReAssessFraudRiskInput: object

userId:
Example
{
  "userId": "object"
}

ReAssessFraudRiskResponse: object

fraudRisk:
object
return:
arguments:
object
Example
{
  "fraudRisk": {
    "return": {
      "id": {
        "return": "object",
        "arguments": {}
      },
      "lastUpdatedBy": {
        "return": "string",
        "arguments": {}
      },
      "notes": {
        "return": "string",
        "arguments": {}
      },
      "riskReasons": {
        "return": [
          {
            "countryRisk": {
              "return": {
                "country": {
                  "return": "object",
                  "arguments": {}
                },
                "countryCode": {
                  "return": "object",
                  "arguments": {}
                },
                "disabled": {
                  "return": "boolean",
                  "arguments": {}
                },
                "id": {
                  "return": "object",
                  "arguments": {}
                },
                "riskRating": {
                  "return": "string",
                  "arguments": {}
                }
              },
              "arguments": {}
            },
            "id": {
              "return": "object",
              "arguments": {}
            },
            "jobTitleRisk": {
              "return": {
                "companyType": {
                  "return": "object",
                  "arguments": {}
                },
                "disabled": {
                  "return": "boolean",
                  "arguments": {}
                },
                "id": {
                  "return": "object",
                  "arguments": {}
                },
                "jobTitle": {
                  "return": "object",
                  "arguments": {}
                },
                "riskRating": {
                  "return": "string",
                  "arguments": {}
                }
              },
              "arguments": {}
            },
            "name": {
              "return": "string",
              "arguments": {}
            },
            "riskRating": {
              "return": "string",
              "arguments": {}
            },
            "translatedDescription": {
              "return": {
                "en": {
                  "return": "string",
                  "arguments": {}
                },
                "fr": {
                  "return": "string",
                  "arguments": {}
                }
              },
              "arguments": {}
            },
            "translatedDisplayName": {
              "return": {
                "en": {
                  "return": "string",
                  "arguments": {}
                },
                "fr": {}
              }
            }
          }
        ]
      }
    }
  }
}

ReactivateGoalInput: object

goalId:
lastUpdatedBy:
Example
{
  "goalId": "object",
  "lastUpdatedBy": "object"
}

ReactivateGoalResponse: object

goal:
object
return:
arguments:
object
Example
{
  "goal": {
    "return": {
      "availableFinancialProducts": {
        "return": [
          {
            "assignable": {
              "return": "boolean",
              "arguments": {}
            },
            "autoUpdatePrices": {
              "return": "boolean",
              "arguments": {}
            },
            "children": {
              "return": [
                {
                  "financialProduct": {
                    "return": {
                      "assignable": {
                        "return": "boolean",
                        "arguments": {}
                      },
                      "autoUpdatePrices": {
                        "return": "boolean",
                        "arguments": {}
                      },
                      "children": {
                        "return": [
                          {
                            "financialProduct": {
                              "return": {
                                "assignable": {
                                  "return": "boolean",
                                  "arguments": {}
                                },
                                "autoUpdatePrices": {
                                  "return": "boolean",
                                  "arguments": {}
                                },
                                "children": {
                                  "return": [
                                    {
                                      "financialProduct": {
                                        "return": {
                                          "assignable": {
                                            "return": "boolean",
                                            "arguments": {}
                                          },
                                          "autoUpdatePrices": {
                                            "return": "boolean",
                                            "arguments": {}
                                          },
                                          "children": {
                                            "return": [
                                              {
                                                "financialProduct": {
                                                  "return": {
                                                    "assignable": {
                                                      "return": "boolean",
                                                      "arguments": {}
                                                    },
                                                    "autoUpdatePrices": {
                                                      "return": "boolean",
                                                      "arguments": {}
                                                    },
                                                    "children": {
                                                      "return": [
                                                        {
                                                          "financialProduct": {
                                                            "return": {
                                                              "assignable": {
                                                                "return": "boolean",
                                                                "arguments": {}
                                                              },
                                                              "autoUpdatePrices": {
                                                                "return": "boolean",
                                                                "arguments": {}
                                                              },
                                                              "children": {
                                                                "return": [
                                                                  {
                                                                    "financialProduct": {
                                                                      "return": {
                                                                        "assignable": {}
                                                                      }
                                                                    }
                                                                  }
                                                                ]
                                                              }
                                                            }
                                                          }
                                                        }
                                                      ]
                                                    }
                                                  }
                                                }
                                              }
                                            ]
                                          }
                                        }
                                      }
                                    }
                                  ]
                                }
                              }
                            }
                          }
                        ]
                      }
                    }
                  }
                }
              ]
            }
          }
        ]
      }
    }
  }
}

ReasonNames: string

object
CITIZENSHIP_RISK
object
FOREIGN_PEP
object
FOREIGN_TAX_RISK
object
INCOME_ASSETS_MISMATCH
object
JOB_RISK
object
LARGE_INCOME_TO_NETWORTH
object
LARGE_NSFS
object
LOW_INCOME_LOW_AGE
object
NO_INVESTMENT_KNOWLEDGE
object
SEVERAL_NSFS
object
SPECIAL_PERSONS
object
YOUNG_WITH_LARGE_INCOME
object
ZERO_ASSETS

Rebalance: object

actualQuantitiesSet:
object

Will return whether or not all the actualQuantity fields have been set on the trades

return:
arguments:
object
allocationFileUrl:
object
return:
arguments:
object
allocationFileUrls:
object
return:
String
arguments:
object
bulkTrades:
object
return:
BulkTradeType
arguments:
object
buyBulkTradeFileUrl:
object
return:
arguments:
object
createdAt:
object
return:
arguments:
object
id:
object
return:
arguments:
object
mutualFundFileUrl:
object
return:
arguments:
object
organization:
object
return:
arguments:
object
ptfBulkTradeFileUrl:
object
return:
arguments:
object
sellBulkTradeFileUrl:
object
return:
arguments:
object
state:
object
return:
arguments:
object
stateChanges:
object
return:
StateChanges
arguments:
object
Example
{
  "actualQuantitiesSet": {
    "return": "boolean",
    "arguments": {}
  },
  "allocationFileUrl": {
    "return": "string",
    "arguments": {}
  },
  "allocationFileUrls": {
    "return": [
      "string"
    ],
    "arguments": {}
  },
  "bulkTrades": {
    "return": [
      {
        "bulkTrades": {
          "return": [
            {
              "_id": {
                "return": "string",
                "arguments": {}
              },
              "currency": {
                "return": "string",
                "arguments": {}
              },
              "exchange": {
                "return": "string",
                "arguments": {}
              },
              "expectedPriceCents": {
                "return": "number",
                "arguments": {}
              },
              "expectedPriceInCurrencyCents": {
                "return": "number",
                "arguments": {}
              },
              "total": {
                "return": "number",
                "arguments": {}
              }
            }
          ],
          "arguments": {}
        },
        "type": {
          "return": "string",
          "arguments": {}
        }
      }
    ],
    "arguments": {}
  },
  "buyBulkTradeFileUrl": {
    "return": "string",
    "arguments": {}
  },
  "createdAt": {
    "return": "object",
    "arguments": {}
  },
  "id": {
    "return": "object",
    "arguments": {}
  },
  "mutualFundFileUrl": {
    "return": "string",
    "arguments": {}
  },
  "organization": {
    "return": {
      "browserTabTitle": {
        "return": "string",
        "arguments": {}
      },
      "faviconLink": {
        "return": "string",
        "arguments": {}
      },
      "id": {
        "return": "object",
        "arguments": {}
      },
      "name": {
        "return": "string",
        "arguments": {}
      },
      "parent": {
        "return": {
          "browserTabTitle": {
            "return": "string",
            "arguments": {}
          },
          "faviconLink": {
            "return": "string",
            "arguments": {}
          },
          "id": {}
        }
      }
    }
  }
}

RebalanceHoldingReport: object

account:
object
return:
arguments:
object
driftRebalanceRequired:
object
return:
arguments:
object
expectedPercentage:
object
return:
arguments:
object
expectedValueCents:
object
return:
Int
arguments:
object
financialProduct:
object
return:
arguments:
object
goal:
object
return:
arguments:
object
id:
object
return:
arguments:
object
lastReconciledAt:
object
return:
arguments:
object
liquidateRebalanceRequired:
object
return:
arguments:
object
quantity:
object
return:
arguments:
object
subAccount:
object
return:
arguments:
object
ticker:
object
return:
arguments:
object
user:
object
return:
arguments:
object
valueCents:
object
return:
Int
arguments:
object
Example
{
  "account": {
    "return": {
      "affiliations": {
        "return": [
          {
            "allocation": {
              "return": "number",
              "arguments": {}
            },
            "id": {
              "return": "object",
              "arguments": {}
            },
            "relation": {
              "return": "string",
              "arguments": {}
            },
            "signatureRequired": {
              "return": "boolean",
              "arguments": {}
            },
            "type": {
              "return": "string",
              "arguments": {}
            },
            "user": {
              "return": {
                "accessibleBy": {
                  "return": [
                    {
                      "displayOptions": {
                        "return": {
                          "hide": {
                            "return": "boolean",
                            "arguments": {}
                          },
                          "order": {
                            "return": "number",
                            "arguments": {}
                          }
                        },
                        "arguments": {}
                      },
                      "organizationUser": {
                        "return": {
                          "accessType": {
                            "return": "string",
                            "arguments": {}
                          },
                          "apiTokens": {
                            "return": [
                              {
                                "id": {
                                  "return": "object",
                                  "arguments": {}
                                },
                                "jwtToken": {
                                  "return": "string",
                                  "arguments": {}
                                },
                                "name": {
                                  "return": "string",
                                  "arguments": {}
                                },
                                "organization": {
                                  "return": {
                                    "browserTabTitle": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "faviconLink": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "id": {
                                      "return": "object",
                                      "arguments": {}
                                    },
                                    "name": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "parent": {
                                      "return": {
                                        "browserTabTitle": {
                                          "return": "string",
                                          "arguments": {}
                                        },
                                        "faviconLink": {
                                          "return": "string",
                                          "arguments": {}
                                        }
                                      }
                                    }
                                  }
                                }
                              }
                            ]
                          }
                        }
                      }
                    }
                  ]
                }
              }
            }
          }
        ]
      }
    }
  }
}

RebalanceHoldingReportQueryFilter: object

subAccountId:
Example
{
  "subAccountId": "object"
}

RebalanceMetrics: object

accounts:
object
return:
Int
arguments:
object
buyQuantity:
object
return:
arguments:
object
buyValueCents:
object
return:
arguments:
object
full:
object
return:
arguments:
object
id:
object
return:
arguments:
object
screenedAt:
object
return:
arguments:
object
sellQuantity:
object
return:
arguments:
object
sellValueCents:
object
return:
arguments:
object
state:
object
return:
arguments:
object
subAccounts:
object
return:
Int
arguments:
object
type:
object
return:
arguments:
object
users:
object
return:
Int
arguments:
object
Example
{
  "accounts": {
    "return": "number",
    "arguments": {}
  },
  "buyQuantity": {
    "return": "number",
    "arguments": {}
  },
  "buyValueCents": {
    "return": "object",
    "arguments": {}
  },
  "full": {
    "return": "boolean",
    "arguments": {}
  },
  "id": {
    "return": "object",
    "arguments": {}
  },
  "screenedAt": {
    "return": "object",
    "arguments": {}
  },
  "sellQuantity": {
    "return": "number",
    "arguments": {}
  },
  "sellValueCents": {
    "return": "object",
    "arguments": {}
  },
  "state": {
    "return": "string",
    "arguments": {}
  },
  "subAccounts": {
    "return": "number",
    "arguments": {}
  },
  "type": {
    "return": "string",
    "arguments": {}
  },
  "users": {
    "return": "number",
    "arguments": {}
  }
}

RebalanceMetricsStates: string

object
COMPLETED
object
GENERATING

RebalanceMetricsTypes: string

object
POST
object
PRE

RebalanceQueryFilter: object

organizationId:
state:
Example
{
  "organizationId": "object",
  "state": "string"
}

RebalanceReport: object

account:
object
return:
arguments:
object
cashCents:
object
return:
Int
arguments:
object
cashOnHoldToTradeCents:
object
return:
Int
arguments:
object
contributionRebalanceRequired:
object
return:
arguments:
object
driftRebalanceRequired:
object
return:
arguments:
object
expectedCashCents:
object
return:
Int
arguments:
object
expectedPercentage:
object
return:
arguments:
object
goal:
object
return:
arguments:
object
id:
object
return:
arguments:
object
lastRebalancedAt:
object
return:
arguments:
object
lastReconciledAt:
object
return:
arguments:
object
liquidateRebalanceRequired:
object
return:
arguments:
object
marketValueCents:
object
return:
Int
arguments:
object
subAccount:
object
return:
arguments:
object
user:
object
return:
arguments:
object
Example
{
  "account": {
    "return": {
      "affiliations": {
        "return": [
          {
            "allocation": {
              "return": "number",
              "arguments": {}
            },
            "id": {
              "return": "object",
              "arguments": {}
            },
            "relation": {
              "return": "string",
              "arguments": {}
            },
            "signatureRequired": {
              "return": "boolean",
              "arguments": {}
            },
            "type": {
              "return": "string",
              "arguments": {}
            },
            "user": {
              "return": {
                "accessibleBy": {
                  "return": [
                    {
                      "displayOptions": {
                        "return": {
                          "hide": {
                            "return": "boolean",
                            "arguments": {}
                          },
                          "order": {
                            "return": "number",
                            "arguments": {}
                          }
                        },
                        "arguments": {}
                      },
                      "organizationUser": {
                        "return": {
                          "accessType": {
                            "return": "string",
                            "arguments": {}
                          },
                          "apiTokens": {
                            "return": [
                              {
                                "id": {
                                  "return": "object",
                                  "arguments": {}
                                },
                                "jwtToken": {
                                  "return": "string",
                                  "arguments": {}
                                },
                                "name": {
                                  "return": "string",
                                  "arguments": {}
                                },
                                "organization": {
                                  "return": {
                                    "browserTabTitle": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "faviconLink": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "id": {
                                      "return": "object",
                                      "arguments": {}
                                    },
                                    "name": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "parent": {
                                      "return": {
                                        "browserTabTitle": {
                                          "return": "string",
                                          "arguments": {}
                                        },
                                        "faviconLink": {
                                          "return": "string",
                                          "arguments": {}
                                        }
                                      }
                                    }
                                  }
                                }
                              }
                            ]
                          }
                        }
                      }
                    }
                  ]
                }
              }
            }
          }
        ]
      }
    }
  }
}

RebalanceReportQueryFilter: object

accountIds:
ObjectID
accountType:
contributionOnly:
full:
modelPortfolioIds:
ObjectID
organizationId:
rebalanceType:
subAccountIds:
ObjectID
Example
{
  "accountIds": [
    "object"
  ],
  "accountType": "string",
  "contributionOnly": "boolean",
  "full": "boolean",
  "modelPortfolioIds": [
    "object"
  ],
  "organizationId": "object",
  "rebalanceType": "string",
  "subAccountIds": [
    "object"
  ]
}

RebalanceStates: string

object
ALLOCATION_COMPLETED
object
ALLOCATION_INITIATED
object
BULK_TRADE_COMPLETED
object
BULK_TRADE_INITIATED
object
CANCELED
object
COMPLETED
object
FIX_TRADE_COMPLETED
object
FIX_TRADE_INITIATED
object
GENERATING
object
INITIATED

RebalanceSubAccountsInput: object

full:
organizationId:
v2:

Temporary - test rebalancing v2

Example
{
  "full": "boolean",
  "organizationId": "object",
  "v2": "boolean"
}

RebalanceSubAccountsResponse: object

rebalance:
object
return:
arguments:
object
Example
{
  "rebalance": {
    "return": {
      "actualQuantitiesSet": {
        "return": "boolean",
        "arguments": {}
      },
      "allocationFileUrl": {
        "return": "string",
        "arguments": {}
      },
      "allocationFileUrls": {
        "return": [
          "string"
        ],
        "arguments": {}
      },
      "bulkTrades": {
        "return": [
          {
            "bulkTrades": {
              "return": [
                {
                  "_id": {
                    "return": "string",
                    "arguments": {}
                  },
                  "currency": {
                    "return": "string",
                    "arguments": {}
                  },
                  "exchange": {
                    "return": "string",
                    "arguments": {}
                  },
                  "expectedPriceCents": {
                    "return": "number",
                    "arguments": {}
                  },
                  "expectedPriceInCurrencyCents": {
                    "return": "number",
                    "arguments": {}
                  },
                  "total": {
                    "return": "number",
                    "arguments": {}
                  }
                }
              ],
              "arguments": {}
            },
            "type": {
              "return": "string",
              "arguments": {}
            }
          }
        ],
        "arguments": {}
      },
      "buyBulkTradeFileUrl": {
        "return": "string",
        "arguments": {}
      },
      "createdAt": {
        "return": "object",
        "arguments": {}
      },
      "id": {
        "return": "object",
        "arguments": {}
      },
      "mutualFundFileUrl": {
        "return": "string",
        "arguments": {}
      },
      "organization": {
        "return": {
          "browserTabTitle": {
            "return": "string",
            "arguments": {}
          },
          "faviconLink": {
            "return": "string",
            "arguments": {}
          },
          "id": {
            "return": "object",
            "arguments": {}
          },
          "name": {
            "return": "string",
            "arguments": {}
          },
          "parent": {
            "return": {
              "browserTabTitle": {
                "return": "string",
                "arguments": {}
              },
              "faviconLink": {
                "return": "string"
              }
            }
          }
        }
      }
    }
  }
}

RebalanceTransition: string

object
cancel
object
complete
object
completeAllocation
object
completeBulkTrade
object
initiateAllocation
object
initiateBulkTrade
object
initiateFixTrade

RebalanceType: string

object
CONTRIBUTION
object
DRIFT
object
FULL

ReconcileCustodianActivityResponse: object

custodianActivity:
object
return:
arguments:
object
Example
{
  "custodianActivity": {
    "return": {
      "account": {
        "return": {
          "affiliations": {
            "return": [
              {
                "allocation": {
                  "return": "number",
                  "arguments": {}
                },
                "id": {
                  "return": "object",
                  "arguments": {}
                },
                "relation": {
                  "return": "string",
                  "arguments": {}
                },
                "signatureRequired": {
                  "return": "boolean",
                  "arguments": {}
                },
                "type": {
                  "return": "string",
                  "arguments": {}
                },
                "user": {
                  "return": {
                    "accessibleBy": {
                      "return": [
                        {
                          "displayOptions": {
                            "return": {
                              "hide": {
                                "return": "boolean",
                                "arguments": {}
                              },
                              "order": {
                                "return": "number",
                                "arguments": {}
                              }
                            },
                            "arguments": {}
                          },
                          "organizationUser": {
                            "return": {
                              "accessType": {
                                "return": "string",
                                "arguments": {}
                              },
                              "apiTokens": {
                                "return": [
                                  {
                                    "id": {
                                      "return": "object",
                                      "arguments": {}
                                    },
                                    "jwtToken": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "name": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "organization": {
                                      "return": {
                                        "browserTabTitle": {
                                          "return": "string",
                                          "arguments": {}
                                        },
                                        "faviconLink": {
                                          "return": "string",
                                          "arguments": {}
                                        },
                                        "id": {
                                          "return": "object",
                                          "arguments": {}
                                        },
                                        "name": {
                                          "return": "string",
                                          "arguments": {}
                                        },
                                        "parent": {
                                          "return": {
                                            "browserTabTitle": {
                                              "return": "string",
                                              "arguments": {}
                                            },
                                            "faviconLink": {}
                                          }
                                        }
                                      }
                                    }
                                  }
                                ]
                              }
                            }
                          }
                        }
                      ]
                    }
                  }
                }
              }
            ]
          }
        }
      }
    }
  }
}

ReconciledFees: object

feeCents:
object
return:
arguments:
object
salesTaxCents:
object
return:
arguments:
object
Example
{
  "feeCents": {
    "return": "number",
    "arguments": {}
  },
  "salesTaxCents": {
    "return": "number",
    "arguments": {}
  }
}

RegenerateExternalTransferPdfInput: object

manualProcessId:
Example
{
  "manualProcessId": "object"
}

RegenerateExternalTransferPdfResponse: object

manualProcess:
object
return:
arguments:
object
Example
{
  "manualProcess": {
    "return": {
      "account": {
        "return": {
          "affiliations": {
            "return": [
              {
                "allocation": {
                  "return": "number",
                  "arguments": {}
                },
                "id": {
                  "return": "object",
                  "arguments": {}
                },
                "relation": {
                  "return": "string",
                  "arguments": {}
                },
                "signatureRequired": {
                  "return": "boolean",
                  "arguments": {}
                },
                "type": {
                  "return": "string",
                  "arguments": {}
                },
                "user": {
                  "return": {
                    "accessibleBy": {
                      "return": [
                        {
                          "displayOptions": {
                            "return": {
                              "hide": {
                                "return": "boolean",
                                "arguments": {}
                              },
                              "order": {
                                "return": "number",
                                "arguments": {}
                              }
                            },
                            "arguments": {}
                          },
                          "organizationUser": {
                            "return": {
                              "accessType": {
                                "return": "string",
                                "arguments": {}
                              },
                              "apiTokens": {
                                "return": [
                                  {
                                    "id": {
                                      "return": "object",
                                      "arguments": {}
                                    },
                                    "jwtToken": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "name": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "organization": {
                                      "return": {
                                        "browserTabTitle": {
                                          "return": "string",
                                          "arguments": {}
                                        },
                                        "faviconLink": {
                                          "return": "string",
                                          "arguments": {}
                                        },
                                        "id": {
                                          "return": "object",
                                          "arguments": {}
                                        },
                                        "name": {
                                          "return": "string",
                                          "arguments": {}
                                        },
                                        "parent": {
                                          "return": {
                                            "browserTabTitle": {
                                              "return": "string",
                                              "arguments": {}
                                            },
                                            "faviconLink": {}
                                          }
                                        }
                                      }
                                    }
                                  }
                                ]
                              }
                            }
                          }
                        }
                      ]
                    }
                  }
                }
              }
            ]
          }
        }
      }
    }
  }
}

RegenerateHtmlInput: object

formAgreementId:
Example
{
  "formAgreementId": "object"
}

RegenerateHtmlResponse: object

html:
object
return:
arguments:
object
Example
{
  "html": {
    "return": "string",
    "arguments": {}
  }
}

RegeneratePdfInput: object

formAgreementId:
Example
{
  "formAgreementId": "object"
}

RegeneratePdfResponse: object

formAgreement:
object
return:
arguments:
object
Example
{
  "formAgreement": {
    "return": {
      "account": {
        "return": {
          "affiliations": {
            "return": [
              {
                "allocation": {
                  "return": "number",
                  "arguments": {}
                },
                "id": {
                  "return": "object",
                  "arguments": {}
                },
                "relation": {
                  "return": "string",
                  "arguments": {}
                },
                "signatureRequired": {
                  "return": "boolean",
                  "arguments": {}
                },
                "type": {
                  "return": "string",
                  "arguments": {}
                },
                "user": {
                  "return": {
                    "accessibleBy": {
                      "return": [
                        {
                          "displayOptions": {
                            "return": {
                              "hide": {
                                "return": "boolean",
                                "arguments": {}
                              },
                              "order": {
                                "return": "number",
                                "arguments": {}
                              }
                            },
                            "arguments": {}
                          },
                          "organizationUser": {
                            "return": {
                              "accessType": {
                                "return": "string",
                                "arguments": {}
                              },
                              "apiTokens": {
                                "return": [
                                  {
                                    "id": {
                                      "return": "object",
                                      "arguments": {}
                                    },
                                    "jwtToken": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "name": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "organization": {
                                      "return": {
                                        "browserTabTitle": {
                                          "return": "string",
                                          "arguments": {}
                                        },
                                        "faviconLink": {
                                          "return": "string",
                                          "arguments": {}
                                        },
                                        "id": {
                                          "return": "object",
                                          "arguments": {}
                                        },
                                        "name": {
                                          "return": "string",
                                          "arguments": {}
                                        },
                                        "parent": {
                                          "return": {
                                            "browserTabTitle": {
                                              "return": "string",
                                              "arguments": {}
                                            },
                                            "faviconLink": {}
                                          }
                                        }
                                      }
                                    }
                                  }
                                ]
                              }
                            }
                          }
                        }
                      ]
                    }
                  }
                }
              }
            ]
          }
        }
      }
    }
  }
}

RelatedEntity: object

The integration enum and unique id for that integration to identify this user's profile

entity:
object

User object as an relation entity

return:
arguments:
object
relation:
object

Enumeration value from RelatedEntityTypes

return:
arguments:
object
Example
{
  "entity": {
    "return": {
      "accessibleBy": {
        "return": [
          {
            "displayOptions": {
              "return": {
                "hide": {
                  "return": "boolean",
                  "arguments": {}
                },
                "order": {
                  "return": "number",
                  "arguments": {}
                }
              },
              "arguments": {}
            },
            "organizationUser": {
              "return": {
                "accessType": {
                  "return": "string",
                  "arguments": {}
                },
                "apiTokens": {
                  "return": [
                    {
                      "id": {
                        "return": "object",
                        "arguments": {}
                      },
                      "jwtToken": {
                        "return": "string",
                        "arguments": {}
                      },
                      "name": {
                        "return": "string",
                        "arguments": {}
                      },
                      "organization": {
                        "return": {
                          "browserTabTitle": {
                            "return": "string",
                            "arguments": {}
                          },
                          "faviconLink": {
                            "return": "string",
                            "arguments": {}
                          },
                          "id": {
                            "return": "object",
                            "arguments": {}
                          },
                          "name": {
                            "return": "string",
                            "arguments": {}
                          },
                          "parent": {
                            "return": {
                              "browserTabTitle": {
                                "return": "string",
                                "arguments": {}
                              },
                              "faviconLink": {
                                "return": "string",
                                "arguments": {}
                              },
                              "id": {
                                "return": "object",
                                "arguments": {}
                              },
                              "name": {
                                "return": "string",
                                "arguments": {}
                              },
                              "parent": {
                                "return": {
                                  "browserTabTitle": {
                                    "return": "string",
                                    "arguments": {}
                                  },
                                  "faviconLink": {
                                    "return": "string",
                                    "arguments": {}
                                  },
                                  "id": {
                                    "return": "object",
                                    "arguments": {}
                                  },
                                  "name": {
                                    "return": "string",
                                    "arguments": {}
                                  }
                                }
                              }
                            }
                          }
                        }
                      }
                    }
                  ]
                }
              }
            }
          }
        ]
      }
    }
  }
}

RelatedEntityInput: object

Input type for RelatedEntity field

entityId:

entity UserId

relation:

RelatedEntity relation ENUM

Example
{
  "entityId": "object",
  "relation": "string"
}

RelatedEntityTypes: string

Related Entity types for a user

object
AUTHORIZED_INDIVIDUAL
object
BENEFICIAL_OWNER
object
CHILD
object
DIRECTOR
object
FRIEND
object
GRANDCHILD
object
GRANDPARENT
object
GRANTOR
object
NIECE_NEPHEW
object
OTHER
object
PARENT
object
POWER_OF_ATTORNEY
object
PROTECTOR
object
SETTLOR
object
SIBLING
object
SPOUSE
object
THIRD_PARTY
object
TRUSTED_CONTACT
object
TRUSTEE

Relation: string

Supported relationships between User and beneficiary or trustedContactPerson

object
CHILD
object
FRIEND
object
GRANDPARENT
object
OTHER
object
PARENT
object
SIBLING
object
SPOUSE

Relationship: object

Type detail for clientGroup's relationship

accessType:
object

client access type in the ClientGroup

return:
arguments:
object
type:
object

type of the relationship

return:
arguments:
object
user:
object

user defined in the relationship object

return:
arguments:
object
Example
{
  "accessType": {
    "return": "string",
    "arguments": {}
  },
  "type": {
    "return": "string",
    "arguments": {}
  },
  "user": {
    "return": {
      "accessibleBy": {
        "return": [
          {
            "displayOptions": {
              "return": {
                "hide": {
                  "return": "boolean",
                  "arguments": {}
                },
                "order": {
                  "return": "number",
                  "arguments": {}
                }
              },
              "arguments": {}
            },
            "organizationUser": {
              "return": {
                "accessType": {
                  "return": "string",
                  "arguments": {}
                },
                "apiTokens": {
                  "return": [
                    {
                      "id": {
                        "return": "object",
                        "arguments": {}
                      },
                      "jwtToken": {
                        "return": "string",
                        "arguments": {}
                      },
                      "name": {
                        "return": "string",
                        "arguments": {}
                      },
                      "organization": {
                        "return": {
                          "browserTabTitle": {
                            "return": "string",
                            "arguments": {}
                          },
                          "faviconLink": {
                            "return": "string",
                            "arguments": {}
                          },
                          "id": {
                            "return": "object",
                            "arguments": {}
                          },
                          "name": {
                            "return": "string",
                            "arguments": {}
                          },
                          "parent": {
                            "return": {
                              "browserTabTitle": {
                                "return": "string",
                                "arguments": {}
                              },
                              "faviconLink": {
                                "return": "string",
                                "arguments": {}
                              },
                              "id": {
                                "return": "object",
                                "arguments": {}
                              },
                              "name": {
                                "return": "string",
                                "arguments": {}
                              },
                              "parent": {
                                "return": {
                                  "browserTabTitle": {
                                    "return": "string",
                                    "arguments": {}
                                  },
                                  "faviconLink": {
                                    "return": "string",
                                    "arguments": {}
                                  }
                                }
                              }
                            }
                          }
                        }
                      }
                    }
                  ]
                }
              }
            }
          }
        ]
      }
    }
  }
}

RelationshipInput: object

Relationship Input

accessType:

client access type in the ClientGroup

type:

relationship type of the person

userId:

userId of the person who is in this relationship

Example
{
  "accessType": "string",
  "type": "object",
  "userId": "object"
}

RemoveAffiliationInput: object

accountId:
affiliationId:
Example
{
  "accountId": "object",
  "affiliationId": "object"
}

RemoveAffiliationResponse: object

account:
object
return:
arguments:
object
Example
{
  "account": {
    "return": {
      "affiliations": {
        "return": [
          {
            "allocation": {
              "return": "number",
              "arguments": {}
            },
            "id": {
              "return": "object",
              "arguments": {}
            },
            "relation": {
              "return": "string",
              "arguments": {}
            },
            "signatureRequired": {
              "return": "boolean",
              "arguments": {}
            },
            "type": {
              "return": "string",
              "arguments": {}
            },
            "user": {
              "return": {
                "accessibleBy": {
                  "return": [
                    {
                      "displayOptions": {
                        "return": {
                          "hide": {
                            "return": "boolean",
                            "arguments": {}
                          },
                          "order": {
                            "return": "number",
                            "arguments": {}
                          }
                        },
                        "arguments": {}
                      },
                      "organizationUser": {
                        "return": {
                          "accessType": {
                            "return": "string",
                            "arguments": {}
                          },
                          "apiTokens": {
                            "return": [
                              {
                                "id": {
                                  "return": "object",
                                  "arguments": {}
                                },
                                "jwtToken": {
                                  "return": "string",
                                  "arguments": {}
                                },
                                "name": {
                                  "return": "string",
                                  "arguments": {}
                                },
                                "organization": {
                                  "return": {
                                    "browserTabTitle": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "faviconLink": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "id": {
                                      "return": "object",
                                      "arguments": {}
                                    },
                                    "name": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "parent": {
                                      "return": {
                                        "browserTabTitle": {
                                          "return": "string",
                                          "arguments": {}
                                        },
                                        "faviconLink": {
                                          "return": "string",
                                          "arguments": {}
                                        }
                                      }
                                    }
                                  }
                                }
                              }
                            ]
                          }
                        }
                      }
                    }
                  ]
                }
              }
            }
          }
        ]
      }
    }
  }
}

RemoveBulkTradeResponse: object

success:
object
return:
arguments:
object
Example
{
  "success": {
    "return": "boolean",
    "arguments": {}
  }
}

RemoveEntityFromOrganizationUserInput: object

entityId:
organizationUserId:
Example
{
  "entityId": "object",
  "organizationUserId": "object"
}

RemoveEntityFromOrganizationUserResponse: object

organizationUser:
object
return:
arguments:
object
Example
{
  "organizationUser": {
    "return": {
      "accessType": {
        "return": "string",
        "arguments": {}
      },
      "apiTokens": {
        "return": [
          {
            "id": {
              "return": "object",
              "arguments": {}
            },
            "jwtToken": {
              "return": "string",
              "arguments": {}
            },
            "name": {
              "return": "string",
              "arguments": {}
            },
            "organization": {
              "return": {
                "browserTabTitle": {
                  "return": "string",
                  "arguments": {}
                },
                "faviconLink": {
                  "return": "string",
                  "arguments": {}
                },
                "id": {
                  "return": "object",
                  "arguments": {}
                },
                "name": {
                  "return": "string",
                  "arguments": {}
                },
                "parent": {
                  "return": {
                    "browserTabTitle": {
                      "return": "string",
                      "arguments": {}
                    },
                    "faviconLink": {
                      "return": "string",
                      "arguments": {}
                    },
                    "id": {
                      "return": "object",
                      "arguments": {}
                    },
                    "name": {
                      "return": "string",
                      "arguments": {}
                    },
                    "parent": {
                      "return": {
                        "browserTabTitle": {
                          "return": "string",
                          "arguments": {}
                        },
                        "faviconLink": {
                          "return": "string",
                          "arguments": {}
                        },
                        "id": {
                          "return": "object",
                          "arguments": {}
                        },
                        "name": {
                          "return": "string",
                          "arguments": {}
                        },
                        "parent": {
                          "return": {
                            "browserTabTitle": {
                              "return": "string",
                              "arguments": {}
                            },
                            "faviconLink": {
                              "return": "string",
                              "arguments": {}
                            },
                            "id": {
                              "return": "object",
                              "arguments": {}
                            },
                            "name": {
                              "return": "string",
                              "arguments": {}
                            }
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        ]
      }
    }
  }
}

RenderFormAgreementInput: object

formAgreementId:
Example
{
  "formAgreementId": "object"
}

RenderFormAgreementResponse: object

html:
object
return:
arguments:
object
Example
{
  "html": {
    "return": "string",
    "arguments": {}
  }
}

RepairSnapshotsInput: object

endDate:
startDate:
subAccountId:
Example
{
  "endDate": "object",
  "startDate": "object",
  "subAccountId": "object"
}

RepairSnapshotsResponse: object

success:
object
return:
arguments:
object
Example
{
  "success": {
    "return": "boolean",
    "arguments": {}
  }
}

Report: object

id:
object
return:
arguments:
object
reason:
object
return:
arguments:
object
rules:
object
return:
Rule
arguments:
object
state:
object
return:
arguments:
object
transfer:
object
return:
arguments:
object
Example
{
  "id": {
    "return": "object",
    "arguments": {}
  },
  "reason": {
    "return": "string",
    "arguments": {}
  },
  "rules": {
    "return": [
      {
        "id": {
          "return": "object",
          "arguments": {}
        },
        "translatedDescription": {
          "return": {
            "en": {
              "return": "string",
              "arguments": {}
            },
            "fr": {
              "return": "string",
              "arguments": {}
            }
          },
          "arguments": {}
        },
        "type": {
          "return": "string",
          "arguments": {}
        }
      }
    ],
    "arguments": {}
  },
  "state": {
    "return": "string",
    "arguments": {}
  },
  "transfer": {
    "return": {
      "alertReport": {
        "return": {
          "id": {
            "return": "object",
            "arguments": {}
          },
          "reason": {
            "return": "string",
            "arguments": {}
          },
          "rules": {
            "return": [
              {
                "id": {
                  "return": "object",
                  "arguments": {}
                },
                "translatedDescription": {
                  "return": {
                    "en": {
                      "return": "string",
                      "arguments": {}
                    },
                    "fr": {
                      "return": "string",
                      "arguments": {}
                    }
                  },
                  "arguments": {}
                },
                "type": {
                  "return": "string",
                  "arguments": {}
                }
              }
            ],
            "arguments": {}
          },
          "state": {
            "return": "string",
            "arguments": {}
          },
          "transfer": {
            "return": {
              "alertReport": {
                "return": {
                  "id": {
                    "return": "object",
                    "arguments": {}
                  },
                  "reason": {
                    "return": "string",
                    "arguments": {}
                  },
                  "rules": {
                    "return": [
                      {
                        "id": {}
                      }
                    ]
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

ReportAccessType: string

object
ORGANIZATIONAL
object
PRIVATE
object
PUBLIC

ReportComparison: string

object
EQUALS
object
GREATER_THAN
object
GREATER_THAN_AGO
object
INCLUDES
object
LESS_THAN
object
LESS_THAN_AGO
object
NOT_EQUALS
object
NOT_INCLUDES
object
NOT_TEXT_SEARCH
object
TEXT_SEARCH

ReportFilter: object

comparison:
object

The comparison for the field

return:
arguments:
object
field:
object

The field you are filtering on

return:
arguments:
object
value:
object

The value to be compared to the field

return:
arguments:
object
Example
{
  "comparison": {
    "return": "string",
    "arguments": {}
  },
  "field": {
    "return": "string",
    "arguments": {}
  },
  "value": {
    "return": "string",
    "arguments": {}
  }
}

ReportFilterComparisons: object

comparison:
object
return:
arguments:
object
options:
object
return:
String
arguments:
object
valueTypes:
object
return:
arguments:
object
Example
{
  "comparison": {
    "return": "string",
    "arguments": {}
  },
  "options": {
    "return": [
      "string"
    ],
    "arguments": {}
  },
  "valueTypes": {
    "return": "string",
    "arguments": {}
  }
}

ReportFilterInput: object

Structure for a filter for a report

comparison:

The comparison for the field

field:

The field you are filtering on

value:

The value to be compared to the field

Example
{
  "comparison": "string",
  "field": "string",
  "value": "string"
}

ReportFilterOptions: object

comparisons:
object
return:
ReportFilterComparisons
arguments:
object
field:
object
return:
arguments:
object
Example
{
  "comparisons": {
    "return": [
      {
        "comparison": {
          "return": "string",
          "arguments": {}
        },
        "options": {
          "return": [
            "string"
          ],
          "arguments": {}
        },
        "valueTypes": {
          "return": "string",
          "arguments": {}
        }
      }
    ],
    "arguments": {}
  },
  "field": {
    "return": "string",
    "arguments": {}
  }
}

ReportGroupingInput: object

field:
interval:
type:
valueAggregation:
valueField:
Example
{
  "field": "string",
  "interval": "string",
  "type": "string",
  "valueAggregation": "string",
  "valueField": "string"
}

ReportPaginationInput: object

page:
Int
perPage:
Int
Example
{
  "page": "number",
  "perPage": "number"
}

ReportSortingInput: object

sortDesc:
sortField:
Example
{
  "sortDesc": "boolean",
  "sortField": "string"
}

ReportStates: string

object
APPROVED
object
DENIED
object
INITIATED
object
REVIEW

ReportTransitions: string

object
approved
object
denied
object
review

ReportType: string

object
ACCOUNT
object
CLIENT_GROUP
object
DAILY_STATS
object
GOAL
object
SUB_ACCOUNT
object
TRADE
object
TRANSACTION
object
TRANSFER
object
USER

ReportValueType: string

object
DATE
object
DATETIME
object
MULTI_SELECT
object
NUMBER
object
SINGLE_SELECT
object
TEXT

ReportVariableMeta: object

description:
object
return:
arguments:
object
name:
object
return:
arguments:
object
type:
object
return:
arguments:
object
Example
{
  "description": {
    "return": "string",
    "arguments": {}
  },
  "name": {
    "return": "string",
    "arguments": {}
  },
  "type": {
    "return": "string",
    "arguments": {}
  }
}

ResetOrganizationUserMultifactorInput: object

organizationUserId:
Example
{
  "organizationUserId": "object"
}

ResetOrganizationUserMultifactorResponse: object

organizationUser:
object
return:
arguments:
object
Example
{
  "organizationUser": {
    "return": {
      "accessType": {
        "return": "string",
        "arguments": {}
      },
      "apiTokens": {
        "return": [
          {
            "id": {
              "return": "object",
              "arguments": {}
            },
            "jwtToken": {
              "return": "string",
              "arguments": {}
            },
            "name": {
              "return": "string",
              "arguments": {}
            },
            "organization": {
              "return": {
                "browserTabTitle": {
                  "return": "string",
                  "arguments": {}
                },
                "faviconLink": {
                  "return": "string",
                  "arguments": {}
                },
                "id": {
                  "return": "object",
                  "arguments": {}
                },
                "name": {
                  "return": "string",
                  "arguments": {}
                },
                "parent": {
                  "return": {
                    "browserTabTitle": {
                      "return": "string",
                      "arguments": {}
                    },
                    "faviconLink": {
                      "return": "string",
                      "arguments": {}
                    },
                    "id": {
                      "return": "object",
                      "arguments": {}
                    },
                    "name": {
                      "return": "string",
                      "arguments": {}
                    },
                    "parent": {
                      "return": {
                        "browserTabTitle": {
                          "return": "string",
                          "arguments": {}
                        },
                        "faviconLink": {
                          "return": "string",
                          "arguments": {}
                        },
                        "id": {
                          "return": "object",
                          "arguments": {}
                        },
                        "name": {
                          "return": "string",
                          "arguments": {}
                        },
                        "parent": {
                          "return": {
                            "browserTabTitle": {
                              "return": "string",
                              "arguments": {}
                            },
                            "faviconLink": {
                              "return": "string",
                              "arguments": {}
                            },
                            "id": {
                              "return": "object",
                              "arguments": {}
                            },
                            "name": {
                              "return": "string",
                              "arguments": {}
                            }
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        ]
      }
    }
  }
}

RiskLevels: string

Risk level based on User's answer to risk questions

object
LEVEL_1
object
LEVEL_2
object
LEVEL_3
object
LEVEL_4
object
LEVEL_5

RiskRatings: string

object
HIGH
object
HIGH_RISK_COUNTRY_OR_OCCUPATION
object
LOW
object
MEDIUM

RiskReason: object

countryRisk:
object
return:
arguments:
object
id:
object
return:
arguments:
object
jobTitleRisk:
object
return:
arguments:
object
name:
object
return:
arguments:
object
riskRating:
object
return:
arguments:
object
translatedDescription:
object
return:
arguments:
object
translatedDisplayName:
object
return:
arguments:
object
Example
{
  "countryRisk": {
    "return": {
      "country": {
        "return": "object",
        "arguments": {}
      },
      "countryCode": {
        "return": "object",
        "arguments": {}
      },
      "disabled": {
        "return": "boolean",
        "arguments": {}
      },
      "id": {
        "return": "object",
        "arguments": {}
      },
      "riskRating": {
        "return": "string",
        "arguments": {}
      }
    },
    "arguments": {}
  },
  "id": {
    "return": "object",
    "arguments": {}
  },
  "jobTitleRisk": {
    "return": {
      "companyType": {
        "return": "object",
        "arguments": {}
      },
      "disabled": {
        "return": "boolean",
        "arguments": {}
      },
      "id": {
        "return": "object",
        "arguments": {}
      },
      "jobTitle": {
        "return": "object",
        "arguments": {}
      },
      "riskRating": {
        "return": "string",
        "arguments": {}
      }
    },
    "arguments": {}
  },
  "name": {
    "return": "string",
    "arguments": {}
  },
  "riskRating": {
    "return": "string",
    "arguments": {}
  },
  "translatedDescription": {
    "return": {
      "en": {
        "return": "string",
        "arguments": {}
      },
      "fr": {
        "return": "string",
        "arguments": {}
      }
    },
    "arguments": {}
  },
  "translatedDisplayName": {
    "return": {
      "en": {
        "return": "string",
        "arguments": {}
      },
      "fr": {
        "return": "string",
        "arguments": {}
      }
    },
    "arguments": {}
  }
}

RiskReasonInput: object

name:
Example
{
  "name": "string"
}

Role: object

accessiblePages:
object

List of accessible pages for the role

return:
Pages
arguments:
object
accountPageConfiguration:
object

Page configuration for accounts

return:
arguments:
object
authAudience:
object

Auth0 Audience type

return:
arguments:
object
dashboards:
object

List of dashboards this role has access to

return:
Dashboard
arguments:
object
defaultAuthenticationConnection:
object
return:
arguments:
object
goalPageConfiguration:
object

Page configuration for goals

return:
arguments:
object
householdPageConfiguration:
object

Page configuration for households

return:
arguments:
object
id:
object
return:
arguments:
object
individualPageConfiguration:
object

Page configuration for individuals

return:
arguments:
object
makeHouseholdDefaultView:
object

Sets household view as default

return:
arguments:
object
navigationStyle:
object

Navigation Style option

return:
arguments:
object
nonIndividualPageConfiguration:
object

Page configuration for non-individuals

return:
arguments:
object
organization:
object

Organization that owns the role

return:
arguments:
object
permissions:
object

List of permissions that the role has access to

return:
String
arguments:
object
publicRoleProfile:
object

Role Profile with limited attributes that is accessible from sub-organizations.

return:
arguments:
object
roleProfile:
object

Role Profile

return:
arguments:
object
subAccountPageConfiguration:
object

Page configuration for sub accounts

return:
arguments:
object
translatedDescription:
object

The description of the role

return:
arguments:
object
translatedName:
object

The name of the role

return:
arguments:
object
Example
{
  "accessiblePages": {
    "return": [
      "string"
    ],
    "arguments": {}
  },
  "accountPageConfiguration": {
    "return": {
      "createdAt": {
        "return": "object",
        "arguments": {}
      },
      "id": {
        "return": "object",
        "arguments": {}
      },
      "name": {
        "return": "string",
        "arguments": {}
      },
      "options": {
        "return": "object",
        "arguments": {}
      },
      "organization": {
        "return": {
          "accountTypeTaxRanks": {
            "return": [
              {
                "accountType": {
                  "return": "string",
                  "arguments": {}
                },
                "id": {
                  "return": "object",
                  "arguments": {}
                },
                "taxRank": {
                  "return": "number",
                  "arguments": {}
                }
              }
            ],
            "arguments": {}
          },
          "allowAccessToSubOrganizations": {
            "return": "boolean",
            "arguments": {}
          },
          "allowDirectCommunication": {
            "return": "boolean",
            "arguments": {}
          },
          "allowInactiveUserAdjustments": {
            "return": "boolean",
            "arguments": {}
          },
          "allowInactiveUserFeeCalculation": {
            "return": "boolean",
            "arguments": {}
          },
          "allowInactiveUserRebalancing": {
            "return": "boolean",
            "arguments": {}
          },
          "allowInstantInvest": {
            "return": "boolean",
            "arguments": {}
          },
          "allowPortfolioPerGoal": {
            "return": "boolean",
            "arguments": {}
          },
          "allowPostOptimizationEditing": {
            "return": "boolean",
            "arguments": {}
          },
          "allowViewSubTradeRequestPairs": {
            "return": "boolean",
            "arguments": {}
          },
          "applicableJurisdictions": {
            "return": {
              "all": {
                "return": "boolean",
                "arguments": {}
              },
              "only": {
                "return": [
                  "string"
                ],
                "arguments": {}
              }
            },
            "arguments": {}
          },
          "applicableLocalization": {
            "return": {
              "countries": {
                "return": [
                  null
                ]
              }
            }
          }
        }
      }
    }
  }
}

RolePaginationAndSorting: object

offSet:
Int
perPage:
Int
sortDesc:
sortField:
Example
{
  "offSet": "number",
  "perPage": "number",
  "sortDesc": "boolean",
  "sortField": "string"
}

RoleProfile: object

createdAt:
object
return:
arguments:
object
id:
object
return:
arguments:
object
organization:
object
return:
arguments:
object
publicOrganization:
object

Organization with limited attributes that is accessible from sub-organizations.

return:
arguments:
object
roleCount:
object

Number of roles using this role profile

return:
Int
arguments:
object
state:
object
return:
arguments:
object
template:
object
return:
arguments:
object
translatedDescription:
object
return:
arguments:
object
translatedName:
object
return:
arguments:
object
updatedAt:
object
return:
arguments:
object
Example
{
  "createdAt": {
    "return": "object",
    "arguments": {}
  },
  "id": {
    "return": "object",
    "arguments": {}
  },
  "organization": {
    "return": {
      "accountTypeTaxRanks": {
        "return": [
          {
            "accountType": {
              "return": "string",
              "arguments": {}
            },
            "id": {
              "return": "object",
              "arguments": {}
            },
            "taxRank": {
              "return": "number",
              "arguments": {}
            }
          }
        ],
        "arguments": {}
      },
      "allowAccessToSubOrganizations": {
        "return": "boolean",
        "arguments": {}
      },
      "allowDirectCommunication": {
        "return": "boolean",
        "arguments": {}
      },
      "allowInactiveUserAdjustments": {
        "return": "boolean",
        "arguments": {}
      },
      "allowInactiveUserFeeCalculation": {
        "return": "boolean",
        "arguments": {}
      },
      "allowInactiveUserRebalancing": {
        "return": "boolean",
        "arguments": {}
      },
      "allowInstantInvest": {
        "return": "boolean",
        "arguments": {}
      },
      "allowPortfolioPerGoal": {
        "return": "boolean",
        "arguments": {}
      },
      "allowPostOptimizationEditing": {
        "return": "boolean",
        "arguments": {}
      },
      "allowViewSubTradeRequestPairs": {
        "return": "boolean",
        "arguments": {}
      },
      "applicableJurisdictions": {
        "return": {
          "all": {
            "return": "boolean",
            "arguments": {}
          },
          "only": {
            "return": [
              "string"
            ],
            "arguments": {}
          }
        },
        "arguments": {}
      },
      "applicableLocalization": {
        "return": {
          "countries": {
            "return": [
              "string"
            ],
            "arguments": {}
          },
          "dateFormat": {
            "return": "string",
            "arguments": {}
          },
          "defaultCurrency": {
            "return": "string",
            "arguments": {}
          },
          "defaultLanguage": {
            "return": "string",
            "arguments": {}
          },
          "id": {}
        }
      }
    }
  }
}

RoleProfileQueryFilter: object

name:
organizationId:
Example
{
  "name": "object",
  "organizationId": "object"
}

RoleProfileStates: string

object
ACTIVE
object
ARCHIVED

RoleProfileTemplate: object

accessiblePages:
object
return:
Pages
arguments:
object
accountPageConfiguration:
object

Page configuration for accounts

return:
arguments:
object
dashboards:
object
return:
Dashboard
arguments:
object
goalPageConfiguration:
object

Page configuration for goals

return:
arguments:
object
householdPageConfiguration:
object

Page configuration for households

return:
arguments:
object
individualPageConfiguration:
object

Page configuration for individuals

return:
arguments:
object
makeHouseholdDefaultView:
object

Sets household view as default

return:
arguments:
object
navigationStyle:
object

Navigation Style option

return:
arguments:
object
nonIndividualPageConfiguration:
object

Page configuration for non-individuals

return:
arguments:
object
permissions:
object
return:
String
arguments:
object
subAccountPageConfiguration:
object

Page configuration for sub accounts

return:
arguments:
object
Example
{
  "accessiblePages": {
    "return": [
      "string"
    ],
    "arguments": {}
  },
  "accountPageConfiguration": {
    "return": {
      "createdAt": {
        "return": "object",
        "arguments": {}
      },
      "id": {
        "return": "object",
        "arguments": {}
      },
      "name": {
        "return": "string",
        "arguments": {}
      },
      "options": {
        "return": "object",
        "arguments": {}
      },
      "organization": {
        "return": {
          "accountTypeTaxRanks": {
            "return": [
              {
                "accountType": {
                  "return": "string",
                  "arguments": {}
                },
                "id": {
                  "return": "object",
                  "arguments": {}
                },
                "taxRank": {
                  "return": "number",
                  "arguments": {}
                }
              }
            ],
            "arguments": {}
          },
          "allowAccessToSubOrganizations": {
            "return": "boolean",
            "arguments": {}
          },
          "allowDirectCommunication": {
            "return": "boolean",
            "arguments": {}
          },
          "allowInactiveUserAdjustments": {
            "return": "boolean",
            "arguments": {}
          },
          "allowInactiveUserFeeCalculation": {
            "return": "boolean",
            "arguments": {}
          },
          "allowInactiveUserRebalancing": {
            "return": "boolean",
            "arguments": {}
          },
          "allowInstantInvest": {
            "return": "boolean",
            "arguments": {}
          },
          "allowPortfolioPerGoal": {
            "return": "boolean",
            "arguments": {}
          },
          "allowPostOptimizationEditing": {
            "return": "boolean",
            "arguments": {}
          },
          "allowViewSubTradeRequestPairs": {
            "return": "boolean",
            "arguments": {}
          },
          "applicableJurisdictions": {
            "return": {
              "all": {
                "return": "boolean",
                "arguments": {}
              },
              "only": {
                "return": [
                  "string"
                ],
                "arguments": {}
              }
            },
            "arguments": {}
          },
          "applicableLocalization": {
            "return": {
              "countries": {
                "return": [
                  null
                ]
              }
            }
          }
        }
      }
    }
  }
}

RoleProfileTemplateInput: object

accessiblePages:
Pages
accountPageConfigurationId:
dashboards:
SafeString
goalPageConfigurationId:
householdPageConfigurationId:
individualPageConfigurationId:
navigationStyle:
nonIndividualPageConfigurationId:
permissions:
SafeString
subAccountPageConfigurationId:
Example
{
  "accessiblePages": [
    "string"
  ],
  "accountPageConfigurationId": "object",
  "dashboards": [
    "object"
  ],
  "goalPageConfigurationId": "object",
  "householdPageConfigurationId": "object",
  "individualPageConfigurationId": "object",
  "navigationStyle": "string",
  "nonIndividualPageConfigurationId": "object",
  "permissions": [
    "object"
  ],
  "subAccountPageConfigurationId": "object"
}

RoleProfileTransition: string

object
archive

RoleQueryFilter: object

authAudience:
organizationId:

Role ID that you would to filter organization

roleProfileId:
searchText:

Text used to search the names of the roles

Example
{
  "authAudience": "string",
  "organizationId": "object",
  "roleProfileId": "object",
  "searchText": "string"
}

Rule: object

id:
object
return:
arguments:
object
translatedDescription:
object
return:
arguments:
object
type:
object
return:
arguments:
object
Example
{
  "id": {
    "return": "object",
    "arguments": {}
  },
  "translatedDescription": {
    "return": {
      "en": {
        "return": "string",
        "arguments": {}
      },
      "fr": {
        "return": "string",
        "arguments": {}
      }
    },
    "arguments": {}
  },
  "type": {
    "return": "string",
    "arguments": {}
  }
}

RuleTypes: string

object
ABOVE_LIQUIDITY
object
ABOVE_NETWORTH
object
ADVERSE_NEWS
object
DEPOSIT_IN_SAME_TIMEFRAME
object
DORMANT_ACCOUNT
object
FOR_ACCOUNT_PURPOSE
object
HAS_MULTIPLE_LARGE_DEPOSITS
object
HAS_MULTIPLE_LARGE_WITHDRAWALS
object
HIGH_RISK_USER
object
LARGE_DEPOSIT
object
LARGE_EXTERNAL_TRANSFER
object
LARGE_WITHDRAWAL
object
LARGE_WITHDRAW_IN_SHORT_TIME
object
MULTIPLE_DEPOSIT_IN_SHORT_TIME
object
NAMES_DO_NOT_MATCH
object
WITHDRAWAL_TO_NEW_BANK_ACCOUNT

RunPortfolioOptimizerInput: object

organizationId:
pauseAt:
type:
Example
{
  "organizationId": "object",
  "pauseAt": "string",
  "type": "string"
}

RunPortfolioOptimizerResponse: object

portfolioOptimizer:
object
return:
arguments:
object
Example
{
  "portfolioOptimizer": {
    "return": {
      "createdAt": {
        "return": "object",
        "arguments": {}
      },
      "expectedTotalSubTradeRequests": {
        "return": "number",
        "arguments": {}
      },
      "id": {
        "return": "object",
        "arguments": {}
      },
      "numPortfolios": {
        "return": "number",
        "arguments": {}
      },
      "organization": {
        "return": {
          "browserTabTitle": {
            "return": "string",
            "arguments": {}
          },
          "faviconLink": {
            "return": "string",
            "arguments": {}
          },
          "id": {
            "return": "object",
            "arguments": {}
          },
          "name": {
            "return": "string",
            "arguments": {}
          },
          "parent": {
            "return": {
              "browserTabTitle": {
                "return": "string",
                "arguments": {}
              },
              "faviconLink": {
                "return": "string",
                "arguments": {}
              },
              "id": {
                "return": "object",
                "arguments": {}
              },
              "name": {
                "return": "string",
                "arguments": {}
              },
              "parent": {
                "return": {
                  "browserTabTitle": {
                    "return": "string",
                    "arguments": {}
                  },
                  "faviconLink": {
                    "return": "string",
                    "arguments": {}
                  },
                  "id": {
                    "return": "object",
                    "arguments": {}
                  },
                  "name": {
                    "return": "string",
                    "arguments": {}
                  },
                  "parent": {
                    "return": {
                      "browserTabTitle": {
                        "return": "string",
                        "arguments": {}
                      },
                      "faviconLink": {
                        "return": "string",
                        "arguments": {}
                      },
                      "id": {
                        "return": "object",
                        "arguments": {}
                      },
                      "name": {
                        "return": "string",
                        "arguments": {}
                      },
                      "parent": {
                        "return": {
                          "browserTabTitle": {}
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

SafeString: object

Safe string input

Example
object

Schedule: object

associatedFinancialProductsCount:
object

attached finanacial products

return:
Int
arguments:
object
dates:
object

List of scheduled dates in descending order.

return:
Date
arguments:
object
id:
object

This is the scheduleId and it is auto-generated by OneVest for each Schedule.

return:
arguments:
object
name:
object

Name of the Schedule.

return:
arguments:
object
nextDate:
object

Next scheduled date based on list of dates.

**UTC and inclusive of today.

return:
arguments:
object
organization:
object
return:
arguments:
object
Example
{
  "associatedFinancialProductsCount": {
    "return": "number",
    "arguments": {}
  },
  "dates": {
    "return": [
      "object"
    ],
    "arguments": {}
  },
  "id": {
    "return": "object",
    "arguments": {}
  },
  "name": {
    "return": "string",
    "arguments": {}
  },
  "nextDate": {
    "return": "object",
    "arguments": {}
  },
  "organization": {
    "return": {
      "browserTabTitle": {
        "return": "string",
        "arguments": {}
      },
      "faviconLink": {
        "return": "string",
        "arguments": {}
      },
      "id": {
        "return": "object",
        "arguments": {}
      },
      "name": {
        "return": "string",
        "arguments": {}
      },
      "parent": {
        "return": {
          "browserTabTitle": {
            "return": "string",
            "arguments": {}
          },
          "faviconLink": {
            "return": "string",
            "arguments": {}
          },
          "id": {
            "return": "object",
            "arguments": {}
          },
          "name": {
            "return": "string",
            "arguments": {}
          },
          "parent": {
            "return": {
              "browserTabTitle": {
                "return": "string",
                "arguments": {}
              },
              "faviconLink": {
                "return": "string",
                "arguments": {}
              },
              "id": {
                "return": "object",
                "arguments": {}
              },
              "name": {
                "return": "string",
                "arguments": {}
              },
              "parent": {
                "return": {
                  "browserTabTitle": {
                    "return": "string",
                    "arguments": {}
                  },
                  "faviconLink": {
                    "return": "string",
                    "arguments": {}
                  },
                  "id": {
                    "return": "object",
                    "arguments": {}
                  },
                  "name": {
                    "return": "string",
                    "arguments": {}
                  },
                  "parent": {}
                }
              }
            }
          }
        }
      }
    }
  }
}

ScheduleFilterQuery: object

organizationId:
Example
{
  "organizationId": "object"
}

ScheduledIncomeFundTransfer: object

amountPayableType:
object
return:
arguments:
object
annualAmountCents:
object
return:
arguments:
object
bankAccount:
object
return:
arguments:
object
currency:
object
return:
arguments:
object
dateOfBirth:
object
return:
arguments:
object
frequency:
object
return:
arguments:
object
id:
object

Auto-generated ID for this Transfer.

return:
arguments:
object
minimumAnnualAmountCents:
object
return:
arguments:
object
scheduledDate:
object

Set date to schedule an Transfer for a future date.

return:
arguments:
object
specialTaxRate:
object
return:
arguments:
object
state:
object
return:
arguments:
object
subAccount:
object
return:
arguments:
object
taxOption:
object
return:
arguments:
object
Example
{
  "amountPayableType": {
    "return": "string",
    "arguments": {}
  },
  "annualAmountCents": {
    "return": "object",
    "arguments": {}
  },
  "bankAccount": {
    "return": {
      "EftEligibleRatio": {
        "return": "number",
        "arguments": {}
      },
      "bankAccountNumber": {
        "return": "string",
        "arguments": {}
      },
      "bankAccountNumberDisclosed": {
        "return": "string",
        "arguments": {}
      },
      "createdAt": {
        "return": "object",
        "arguments": {}
      },
      "downloadUrls": {
        "return": [
          "string"
        ],
        "arguments": {}
      },
      "id": {
        "return": "object",
        "arguments": {}
      },
      "institutionNumber": {
        "return": "string",
        "arguments": {}
      },
      "name": {
        "return": "string",
        "arguments": {}
      },
      "source": {
        "return": "string",
        "arguments": {}
      },
      "state": {
        "return": "string",
        "arguments": {}
      },
      "stateChanges": {
        "return": [
          "object"
        ],
        "arguments": {}
      },
      "transitNumber": {
        "return": "string",
        "arguments": {}
      },
      "transitNumberDisclosed": {
        "return": "string",
        "arguments": {}
      },
      "updatedAt": {
        "return": "object",
        "arguments": {}
      },
      "user": {
        "return": {
          "accessibleBy": {
            "return": [
              {
                "displayOptions": {
                  "return": {
                    "hide": {
                      "return": "boolean",
                      "arguments": {}
                    },
                    "order": {
                      "return": "number",
                      "arguments": {}
                    }
                  },
                  "arguments": {}
                },
                "organizationUser": {
                  "return": {
                    "accessType": {
                      "return": "string",
                      "arguments": {}
                    },
                    "apiTokens": {
                      "return": [
                        {}
                      ]
                    }
                  }
                }
              }
            ]
          }
        }
      }
    }
  }
}

ScheduledIncomeFundTransferStates: string

Scheduled Income Fund Transfer States.

object
ACTIVE
object
ARCHIVED
object
CANCELED
object
INITIATED
object
REVIEWING

ScheduledIncomeFundTransferTransferTransition: string

object
archive

ScheduledTransfer: object

amountCents:
object

Transfer amount in cents. Minimum $100 (10000)

return:
arguments:
object
bankAccount:
object
return:
arguments:
object
createdAt:
object
return:
arguments:
object
currency:
object
return:
arguments:
object
endDate:
object

Date on which the scheduled Transfer will end

return:
arguments:
object
frequency:
object

Is this a one_time Transfer request or daily, weekly, semi_monthly or monthly recurring Transfer request?

return:
arguments:
object
id:
object

Auto-generated ID for this Transfer.

return:
arguments:
object
instantInvest:
object

instantInvest skips the holding period before the amount is invested Only available to partners with the certainty of deposits that do not bounce

return:
arguments:
object
representative:
object
return:
arguments:
object
requestId:
object

This an ID created by the partner, that is submitted with an Transfer request and unique to each request.

return:
arguments:
object
scheduledDate:
object

Set date to schedule an Transfer for a future date.

return:
arguments:
object
state:
object
return:
arguments:
object
subAccount:
object

Account that Transfer is processed in. For scheduled transfers between portfolios, this is the subAccount from where funds will be transferred.

return:
arguments:
object
toSubAccount:
object
return:
arguments:
object
transferAll:
object
return:
arguments:
object
type:
object

Type of Transfer request. DEPOSIT: depositTransfer WITHDRAW: withdrawTransfer

return:
arguments:
object
withdrawalReason:
object
return:
arguments:
object
withdrawalReasonDescription:
object
return:
arguments:
object
Example
{
  "amountCents": {
    "return": "object",
    "arguments": {}
  },
  "bankAccount": {
    "return": {
      "EftEligibleRatio": {
        "return": "number",
        "arguments": {}
      },
      "bankAccountNumber": {
        "return": "string",
        "arguments": {}
      },
      "bankAccountNumberDisclosed": {
        "return": "string",
        "arguments": {}
      },
      "createdAt": {
        "return": "object",
        "arguments": {}
      },
      "downloadUrls": {
        "return": [
          "string"
        ],
        "arguments": {}
      },
      "id": {
        "return": "object",
        "arguments": {}
      },
      "institutionNumber": {
        "return": "string",
        "arguments": {}
      },
      "name": {
        "return": "string",
        "arguments": {}
      },
      "source": {
        "return": "string",
        "arguments": {}
      },
      "state": {
        "return": "string",
        "arguments": {}
      },
      "stateChanges": {
        "return": [
          "object"
        ],
        "arguments": {}
      },
      "transitNumber": {
        "return": "string",
        "arguments": {}
      },
      "transitNumberDisclosed": {
        "return": "string",
        "arguments": {}
      },
      "updatedAt": {
        "return": "object",
        "arguments": {}
      },
      "user": {
        "return": {
          "accessibleBy": {
            "return": [
              {
                "displayOptions": {
                  "return": {
                    "hide": {
                      "return": "boolean",
                      "arguments": {}
                    },
                    "order": {
                      "return": "number",
                      "arguments": {}
                    }
                  },
                  "arguments": {}
                },
                "organizationUser": {
                  "return": {
                    "accessType": {
                      "return": "string",
                      "arguments": {}
                    },
                    "apiTokens": {
                      "return": [
                        {
                          "id": {
                            "return": "object",
                            "arguments": {}
                          }
                        }
                      ]
                    }
                  }
                }
              }
            ]
          }
        }
      }
    }
  }
}

ScheduledTransferQueryFilter: object

accountId:
bankAccountId:
clientGroupId:
createdAtAfter:
createdAtBefore:
frequency:
goalId:
organizationId:
scheduledDate:
scheduledDateAfter:
scheduledDateBefore:
state:
states:
ScheduledTransferStates
subAccountId:
type:
userId:
userIds:
ObjectID
Example
{
  "accountId": "object",
  "bankAccountId": "object",
  "clientGroupId": "object",
  "createdAtAfter": "object",
  "createdAtBefore": "object",
  "frequency": "string",
  "goalId": "object",
  "organizationId": "object",
  "scheduledDate": "object",
  "scheduledDateAfter": "object",
  "scheduledDateBefore": "object",
  "state": "string",
  "states": [
    "string"
  ],
  "subAccountId": "object",
  "type": "string",
  "userId": "object",
  "userIds": [
    "object"
  ]
}

ScheduledTransferStates: string

object
ACTIVE
object
CANCELED
object
DRAFT

ScreenPortfoliosInput: object

goalId:
Example
{
  "goalId": "object"
}

ScreenPortfoliosResponse: object

portfolioReport:
object
return:
arguments:
object
Example
{
  "portfolioReport": {
    "return": {
      "bulkTradeRunReasons": {
        "return": [
          {
            "id": {
              "return": "object",
              "arguments": {}
            },
            "reason": {
              "return": "string",
              "arguments": {}
            },
            "total": {
              "return": "number",
              "arguments": {}
            },
            "unblockedSince": {
              "return": "object",
              "arguments": {}
            }
          }
        ],
        "arguments": {}
      },
      "cashAvailableForTradeCents": {
        "return": "object",
        "arguments": {}
      },
      "cashCents": {
        "return": "object",
        "arguments": {}
      },
      "driftRebalanceRequired": {
        "return": "boolean",
        "arguments": {}
      },
      "expectedCashCents": {
        "return": "object",
        "arguments": {}
      },
      "holdings": {
        "return": [
          {
            "actualPercentage": {
              "return": "number",
              "arguments": {}
            },
            "expectedPercentage": {
              "return": "number",
              "arguments": {}
            },
            "expectedValueCents": {
              "return": "number",
              "arguments": {}
            },
            "financialProduct": {
              "return": {
                "assignable": {
                  "return": "boolean",
                  "arguments": {}
                },
                "autoUpdatePrices": {
                  "return": "boolean",
                  "arguments": {}
                },
                "children": {
                  "return": [
                    {
                      "financialProduct": {
                        "return": {
                          "assignable": {
                            "return": "boolean",
                            "arguments": {}
                          },
                          "autoUpdatePrices": {
                            "return": "boolean",
                            "arguments": {}
                          },
                          "children": {
                            "return": [
                              {
                                "financialProduct": {
                                  "return": {
                                    "assignable": {
                                      "return": "boolean",
                                      "arguments": {}
                                    },
                                    "autoUpdatePrices": {
                                      "return": "boolean",
                                      "arguments": {}
                                    },
                                    "children": {
                                      "return": [
                                        null
                                      ]
                                    }
                                  }
                                }
                              }
                            ]
                          }
                        }
                      }
                    }
                  ]
                }
              }
            }
          }
        ]
      }
    }
  }
}

SearchProductsInProviderInput: object

organizationId:
searchText:
Example
{
  "organizationId": "object",
  "searchText": "string"
}

SearchProductsInProviderResponse: object

searchSuggestions:
object
return:
ProductMarketData
arguments:
object
Example
{
  "searchSuggestions": {
    "return": [
      {
        "country": {
          "return": "string",
          "arguments": {}
        },
        "currency": {
          "return": "string",
          "arguments": {}
        },
        "exchange": {
          "return": "string",
          "arguments": {}
        },
        "isin": {
          "return": "string",
          "arguments": {}
        },
        "name": {
          "return": "string",
          "arguments": {}
        },
        "ric": {
          "return": "string",
          "arguments": {}
        },
        "ticker": {
          "return": "string",
          "arguments": {}
        },
        "type": {
          "return": "string",
          "arguments": {}
        }
      }
    ],
    "arguments": {}
  }
}

SecondaryAssetClassHoldings: object

assetClass:
object
return:
arguments:
object
percentage:
object
return:
arguments:
object
securityHoldings:
object
return:
SecurityHoldings
arguments:
object
totalCents:
object
return:
arguments:
object
Example
{
  "assetClass": {
    "return": {
      "description": {
        "return": "string",
        "arguments": {}
      },
      "id": {
        "return": "object",
        "arguments": {}
      },
      "includeCash": {
        "return": "boolean",
        "arguments": {}
      },
      "key": {
        "return": "string",
        "arguments": {}
      },
      "name": {
        "return": "string",
        "arguments": {}
      },
      "state": {
        "return": "string",
        "arguments": {}
      },
      "translatedDescription": {
        "return": {
          "en": {
            "return": "string",
            "arguments": {}
          },
          "fr": {
            "return": "string",
            "arguments": {}
          }
        },
        "arguments": {}
      },
      "translatedName": {
        "return": {
          "en": {
            "return": "string",
            "arguments": {}
          },
          "fr": {
            "return": "string",
            "arguments": {}
          }
        },
        "arguments": {}
      }
    },
    "arguments": {}
  },
  "percentage": {
    "return": "number",
    "arguments": {}
  },
  "securityHoldings": {
    "return": [
      {
        "financialProduct": {
          "return": {
            "assignable": {
              "return": "boolean",
              "arguments": {}
            },
            "autoUpdatePrices": {
              "return": "boolean",
              "arguments": {}
            },
            "children": {
              "return": [
                {
                  "financialProduct": {
                    "return": {
                      "assignable": {
                        "return": "boolean",
                        "arguments": {}
                      },
                      "autoUpdatePrices": {
                        "return": "boolean",
                        "arguments": {}
                      },
                      "children": {
                        "return": [
                          {
                            "financialProduct": {
                              "return": {
                                "assignable": {
                                  "return": "boolean",
                                  "arguments": {}
                                },
                                "autoUpdatePrices": {}
                              }
                            }
                          }
                        ]
                      }
                    }
                  }
                }
              ]
            }
          }
        }
      }
    ]
  }
}

SecurityHoldings: object

financialProduct:
object
return:
arguments:
object
percentage:
object
return:
arguments:
object
quantity:
object
return:
arguments:
object
totalCents:
object
return:
arguments:
object
Example
{
  "financialProduct": {
    "return": {
      "assignable": {
        "return": "boolean",
        "arguments": {}
      },
      "autoUpdatePrices": {
        "return": "boolean",
        "arguments": {}
      },
      "children": {
        "return": [
          {
            "financialProduct": {
              "return": {
                "assignable": {
                  "return": "boolean",
                  "arguments": {}
                },
                "autoUpdatePrices": {
                  "return": "boolean",
                  "arguments": {}
                },
                "children": {
                  "return": [
                    {
                      "financialProduct": {
                        "return": {
                          "assignable": {
                            "return": "boolean",
                            "arguments": {}
                          },
                          "autoUpdatePrices": {
                            "return": "boolean",
                            "arguments": {}
                          },
                          "children": {
                            "return": [
                              {
                                "financialProduct": {
                                  "return": {
                                    "assignable": {
                                      "return": "boolean",
                                      "arguments": {}
                                    },
                                    "autoUpdatePrices": {
                                      "return": "boolean",
                                      "arguments": {}
                                    },
                                    "children": {
                                      "return": [
                                        {
                                          "financialProduct": {
                                            "return": {
                                              "assignable": {
                                                "return": "boolean",
                                                "arguments": {}
                                              },
                                              "autoUpdatePrices": {
                                                "return": "boolean",
                                                "arguments": {}
                                              },
                                              "children": {
                                                "return": [
                                                  {
                                                    "financialProduct": {
                                                      "return": {
                                                        "assignable": {
                                                          "return": "boolean",
                                                          "arguments": {}
                                                        },
                                                        "autoUpdatePrices": {
                                                          "return": "boolean",
                                                          "arguments": {}
                                                        },
                                                        "children": {
                                                          "return": [
                                                            {
                                                              "financialProduct": {
                                                                "return": {
                                                                  "assignable": {
                                                                    "return": "boolean",
                                                                    "arguments": {}
                                                                  },
                                                                  "autoUpdatePrices": {}
                                                                }
                                                              }
                                                            }
                                                          ]
                                                        }
                                                      }
                                                    }
                                                  }
                                                ]
                                              }
                                            }
                                          }
                                        }
                                      ]
                                    }
                                  }
                                }
                              }
                            ]
                          }
                        }
                      }
                    }
                  ]
                }
              }
            }
          }
        ]
      }
    }
  }
}

SftpCredentials: object

id:
object
return:
arguments:
object
sftpInBucket:
object
return:
arguments:
object
sftpInDownloadFile:
object
return:
arguments:
object
sftpInHost:
object
return:
arguments:
object
sftpInPassword:
object
return:
arguments:
object
sftpInPort:
object
return:
arguments:
object
sftpInServerHostKey:
object
return:
String
arguments:
object
sftpInSourceDir:
object
return:
arguments:
object
sftpInTargetPrefix:
object
return:
arguments:
object
sftpInUsername:
object
return:
arguments:
object
sftpOutBucket:
object
return:
arguments:
object
sftpOutHost:
object
return:
arguments:
object
sftpOutPassword:
object
return:
arguments:
object
sftpOutPort:
object
return:
arguments:
object
sftpOutServerHostKey:
object
return:
String
arguments:
object
sftpOutTargetDir:
object
return:
arguments:
object
sftpOutUsername:
object
return:
arguments:
object
Example
{
  "id": {
    "return": "object",
    "arguments": {}
  },
  "sftpInBucket": {
    "return": "string",
    "arguments": {}
  },
  "sftpInDownloadFile": {
    "return": "boolean",
    "arguments": {}
  },
  "sftpInHost": {
    "return": "string",
    "arguments": {}
  },
  "sftpInPassword": {
    "return": "string",
    "arguments": {}
  },
  "sftpInPort": {
    "return": "string",
    "arguments": {}
  },
  "sftpInServerHostKey": {
    "return": [
      "string"
    ],
    "arguments": {}
  },
  "sftpInSourceDir": {
    "return": "string",
    "arguments": {}
  },
  "sftpInTargetPrefix": {
    "return": "string",
    "arguments": {}
  },
  "sftpInUsername": {
    "return": "string",
    "arguments": {}
  },
  "sftpOutBucket": {
    "return": "string",
    "arguments": {}
  },
  "sftpOutHost": {
    "return": "string",
    "arguments": {}
  },
  "sftpOutPassword": {
    "return": "string",
    "arguments": {}
  },
  "sftpOutPort": {
    "return": "string",
    "arguments": {}
  },
  "sftpOutServerHostKey": {
    "return": [
      "string"
    ],
    "arguments": {}
  },
  "sftpOutTargetDir": {
    "return": "string",
    "arguments": {}
  },
  "sftpOutUsername": {
    "return": "string",
    "arguments": {}
  }
}

SignFormAgreementsInput: object

accountId:
clientGroupId:
financialProductId:
formAgreements:
FormAgreementInput
goalId:
language:
requestIpAddress:
scheduledTransferId:
signedByUserId:

UserId of the client that will be signing the form in case multiple signatures are required

subAccountId:
userId:
Example
{
  "accountId": "object",
  "clientGroupId": "object",
  "financialProductId": "object",
  "formAgreements": [
    {
      "type": "string",
      "version": "number"
    }
  ],
  "goalId": "object",
  "language": "string",
  "requestIpAddress": "object",
  "scheduledTransferId": "object",
  "signedByUserId": "object",
  "subAccountId": "object",
  "userId": "object"
}

SignFormAgreementsResponse: object

formAgreements:
object
return:
FormAgreement
arguments:
object
Example
{
  "formAgreements": {
    "return": [
      {
        "account": {
          "return": {
            "affiliations": {
              "return": [
                {
                  "allocation": {
                    "return": "number",
                    "arguments": {}
                  },
                  "id": {
                    "return": "object",
                    "arguments": {}
                  },
                  "relation": {
                    "return": "string",
                    "arguments": {}
                  },
                  "signatureRequired": {
                    "return": "boolean",
                    "arguments": {}
                  },
                  "type": {
                    "return": "string",
                    "arguments": {}
                  },
                  "user": {
                    "return": {
                      "accessibleBy": {
                        "return": [
                          {
                            "displayOptions": {
                              "return": {
                                "hide": {
                                  "return": "boolean",
                                  "arguments": {}
                                },
                                "order": {
                                  "return": "number",
                                  "arguments": {}
                                }
                              },
                              "arguments": {}
                            },
                            "organizationUser": {
                              "return": {
                                "accessType": {
                                  "return": "string",
                                  "arguments": {}
                                },
                                "apiTokens": {
                                  "return": [
                                    {
                                      "id": {
                                        "return": "object",
                                        "arguments": {}
                                      },
                                      "jwtToken": {
                                        "return": "string",
                                        "arguments": {}
                                      },
                                      "name": {
                                        "return": "string",
                                        "arguments": {}
                                      },
                                      "organization": {
                                        "return": {
                                          "browserTabTitle": {
                                            "return": "string",
                                            "arguments": {}
                                          },
                                          "faviconLink": {
                                            "return": "string",
                                            "arguments": {}
                                          },
                                          "id": {
                                            "return": "object",
                                            "arguments": {}
                                          },
                                          "name": {
                                            "return": "string",
                                            "arguments": {}
                                          },
                                          "parent": {
                                            "return": {
                                              "browserTabTitle": {
                                                "return": "string",
                                                "arguments": {}
                                              }
                                            }
                                          }
                                        }
                                      }
                                    }
                                  ]
                                }
                              }
                            }
                          }
                        ]
                      }
                    }
                  }
                }
              ]
            }
          }
        }
      }
    ]
  }
}

SignedUrlDocumentFormat: string

object
ENCODED_PDF

SnapshotCurrencies: string

object
CAD
object
USD

SnapshotForeignExchangeRate: object

date:
object
return:
arguments:
object
from:
object
return:
arguments:
object
organization:
object
return:
arguments:
object
rate:
object
return:
arguments:
object
to:
object
return:
arguments:
object
updatedAt:
object
return:
arguments:
object
Example
{
  "date": {
    "return": "object",
    "arguments": {}
  },
  "from": {
    "return": "string",
    "arguments": {}
  },
  "organization": {
    "return": "object",
    "arguments": {}
  },
  "rate": {
    "return": "number",
    "arguments": {}
  },
  "to": {
    "return": "string",
    "arguments": {}
  },
  "updatedAt": {
    "return": "object",
    "arguments": {}
  }
}

SnapshotHolding: object

adjustedCostBaseCents:
object
return:
Int
arguments:
object
currency:
object
return:
arguments:
object
financialProduct:
object
return:
arguments:
object
foreignExchangeRate:
object
return:
arguments:
object
id:
object
return:
arguments:
object
originalCurrency:
object
return:
arguments:
object
priceCents:
object
return:
Int
arguments:
object
quantity:
object
return:
arguments:
object
ticker:
object
return:
arguments:
object
totalCents:
object
return:
arguments:
object
Example
{
  "adjustedCostBaseCents": {
    "return": "number",
    "arguments": {}
  },
  "currency": {
    "return": "string",
    "arguments": {}
  },
  "financialProduct": {
    "return": {
      "assignable": {
        "return": "boolean",
        "arguments": {}
      },
      "autoUpdatePrices": {
        "return": "boolean",
        "arguments": {}
      },
      "children": {
        "return": [
          {
            "financialProduct": {
              "return": {
                "assignable": {
                  "return": "boolean",
                  "arguments": {}
                },
                "autoUpdatePrices": {
                  "return": "boolean",
                  "arguments": {}
                },
                "children": {
                  "return": [
                    {
                      "financialProduct": {
                        "return": {
                          "assignable": {
                            "return": "boolean",
                            "arguments": {}
                          },
                          "autoUpdatePrices": {
                            "return": "boolean",
                            "arguments": {}
                          },
                          "children": {
                            "return": [
                              {
                                "financialProduct": {
                                  "return": {
                                    "assignable": {
                                      "return": "boolean",
                                      "arguments": {}
                                    },
                                    "autoUpdatePrices": {
                                      "return": "boolean",
                                      "arguments": {}
                                    },
                                    "children": {
                                      "return": [
                                        {
                                          "financialProduct": {
                                            "return": {
                                              "assignable": {
                                                "return": "boolean",
                                                "arguments": {}
                                              },
                                              "autoUpdatePrices": {
                                                "return": "boolean",
                                                "arguments": {}
                                              },
                                              "children": {
                                                "return": [
                                                  {
                                                    "financialProduct": {
                                                      "return": {
                                                        "assignable": {
                                                          "return": "boolean",
                                                          "arguments": {}
                                                        },
                                                        "autoUpdatePrices": {
                                                          "return": "boolean",
                                                          "arguments": {}
                                                        },
                                                        "children": {
                                                          "return": [
                                                            {
                                                              "financialProduct": {}
                                                            }
                                                          ]
                                                        }
                                                      }
                                                    }
                                                  }
                                                ]
                                              }
                                            }
                                          }
                                        }
                                      ]
                                    }
                                  }
                                }
                              }
                            ]
                          }
                        }
                      }
                    }
                  ]
                }
              }
            }
          }
        ]
      }
    }
  }
}

SnapshotHoldingOriginalCurrency: object

adjustedCostBaseCents:
object
return:
arguments:
object
currency:
object
return:
arguments:
object
priceCents:
object
return:
Int
arguments:
object
quantity:
object
return:
arguments:
object
totalCents:
object
return:
arguments:
object
Example
{
  "adjustedCostBaseCents": {
    "return": "number",
    "arguments": {}
  },
  "currency": {
    "return": "string",
    "arguments": {}
  },
  "priceCents": {
    "return": "number",
    "arguments": {}
  },
  "quantity": {
    "return": "number",
    "arguments": {}
  },
  "totalCents": {
    "return": "number",
    "arguments": {}
  }
}

SourceOfFunds: string

object
SELF
object
SPOUSE
object
USA_EMPLOYMENT_WAGES
object
USA_GIFT
object
USA_INHERITANCE_TRUST
object
USA_INVESTMENTS
object
USA_LEGAL_SETTLEMENT
object
USA_LOTTERY_GAMING
object
USA_OTHER
object
USA_RETIREMENT_FUNDS
object
USA_SAVINGS
object
USA_SPOUSAL_PARENTAL_SUPPORT
object
USA_UNEMPLOYMENT_DISABILITY

StateChanges: object

GraphQLObject Type

Example
object

StatementPaginationAndSorting: object

offSet:
Int
perPage:
Int
sortDesc:
sortField:
Example
{
  "offSet": "number",
  "perPage": "number",
  "sortDesc": "boolean",
  "sortField": "object"
}

StatementQueryFilter: object

accountId:

This field will be deprecated, use accountIds instead that can accept multiple entries

accountIds:
String
accountType:
afterDate:
beforeDate:
clientGroupIds:
String
organizationId:
partnerId:
state:
type:

This field will be deprecated, use types instead that can accept multiple entries

typeGroup:
types:
StatementTypes
userId:
userIds:
String
Example
{
  "accountId": "string",
  "accountIds": [
    "string"
  ],
  "accountType": "string",
  "afterDate": "object",
  "beforeDate": "object",
  "clientGroupIds": [
    "string"
  ],
  "organizationId": "object",
  "partnerId": "string",
  "state": "string",
  "type": "string",
  "typeGroup": "string",
  "types": [
    "string"
  ],
  "userId": "string",
  "userIds": [
    "string"
  ]
}

StatementTypes: string

object
ADMINISTRATIVE_FEES_ANNUAL_REPORT
object
ANNUAL_PERFORMANCE_REPORT
object
MANAGEMENT_FEES_ANNUAL_REPORT
object
MONTHLY_ACCOUNT_STATEMENTS
object
OV_MONTHLY_ACCOUNT_STATEMENTS
object
TAX_SLIPS_FIRST_60_DAYS
object
TAX_SLIPS_LAST_10_MONTHS
object
TAX_SLIPS_NR4
object
TAX_SLIPS_T3_BREAKDOWN
object
TAX_SLIPS_T3_RL16
object
TAX_SLIPS_T4A_RL1
object
TAX_SLIPS_T4RIF_RL2
object
TAX_SLIPS_T4RSP_RL2
object
TAX_SLIPS_T5_RL3
object
TAX_SLIPS_T5008
object
TAX_SLIPS_T5013_RL15
object
TAX_SLIPS_TRADING_SUMMARY
object
TAX_SLIP_GENERAL
object
TRADE_CONFIRMATION

StatisticForeignExchangeRate: object

date:
object
return:
arguments:
object
from:
object
return:
arguments:
object
organization:
object
return:
arguments:
object
rate:
object
return:
arguments:
object
to:
object
return:
arguments:
object
updatedAt:
object
return:
arguments:
object
Example
{
  "date": {
    "return": "object",
    "arguments": {}
  },
  "from": {
    "return": "string",
    "arguments": {}
  },
  "organization": {
    "return": "object",
    "arguments": {}
  },
  "rate": {
    "return": "number",
    "arguments": {}
  },
  "to": {
    "return": "string",
    "arguments": {}
  },
  "updatedAt": {
    "return": "object",
    "arguments": {}
  }
}

StatisticHolding: object

adjustedCostBaseCents:
object
return:
arguments:
object
currency:
object
return:
arguments:
object
currentPriceCents:
object
return:
Int
arguments:
object
expectedTotalCents:
object
return:
arguments:
object
financialProduct:
object
return:
arguments:
object
foreignExchangeRate:
object
return:
arguments:
object
originalCurrency:
object
return:
arguments:
object
quantity:
object
return:
arguments:
object
totalCents:
object
return:
arguments:
object
Example
{
  "adjustedCostBaseCents": {
    "return": "number",
    "arguments": {}
  },
  "currency": {
    "return": "string",
    "arguments": {}
  },
  "currentPriceCents": {
    "return": "number",
    "arguments": {}
  },
  "expectedTotalCents": {
    "return": "number",
    "arguments": {}
  },
  "financialProduct": {
    "return": {
      "assignable": {
        "return": "boolean",
        "arguments": {}
      },
      "autoUpdatePrices": {
        "return": "boolean",
        "arguments": {}
      },
      "children": {
        "return": [
          {
            "financialProduct": {
              "return": {
                "assignable": {
                  "return": "boolean",
                  "arguments": {}
                },
                "autoUpdatePrices": {
                  "return": "boolean",
                  "arguments": {}
                },
                "children": {
                  "return": [
                    {
                      "financialProduct": {
                        "return": {
                          "assignable": {
                            "return": "boolean",
                            "arguments": {}
                          },
                          "autoUpdatePrices": {
                            "return": "boolean",
                            "arguments": {}
                          },
                          "children": {
                            "return": [
                              {
                                "financialProduct": {
                                  "return": {
                                    "assignable": {
                                      "return": "boolean",
                                      "arguments": {}
                                    },
                                    "autoUpdatePrices": {
                                      "return": "boolean",
                                      "arguments": {}
                                    },
                                    "children": {
                                      "return": [
                                        {
                                          "financialProduct": {
                                            "return": {
                                              "assignable": {
                                                "return": "boolean",
                                                "arguments": {}
                                              },
                                              "autoUpdatePrices": {
                                                "return": "boolean",
                                                "arguments": {}
                                              },
                                              "children": {
                                                "return": [
                                                  {
                                                    "financialProduct": {
                                                      "return": {
                                                        "assignable": {
                                                          "return": "boolean",
                                                          "arguments": {}
                                                        },
                                                        "autoUpdatePrices": {}
                                                      }
                                                    }
                                                  }
                                                ]
                                              }
                                            }
                                          }
                                        }
                                      ]
                                    }
                                  }
                                }
                              }
                            ]
                          }
                        }
                      }
                    }
                  ]
                }
              }
            }
          }
        ]
      }
    }
  }
}

StatisticHoldingOriginalCurrency: object

adjustedCostBaseCents:
object
return:
arguments:
object
currency:
object
return:
arguments:
object
currentPriceCents:
object
return:
Int
arguments:
object
expectedTotalCents:
object
return:
arguments:
object
quantity:
object
return:
arguments:
object
totalCents:
object
return:
arguments:
object
Example
{
  "adjustedCostBaseCents": {
    "return": "number",
    "arguments": {}
  },
  "currency": {
    "return": "string",
    "arguments": {}
  },
  "currentPriceCents": {
    "return": "number",
    "arguments": {}
  },
  "expectedTotalCents": {
    "return": "number",
    "arguments": {}
  },
  "quantity": {
    "return": "number",
    "arguments": {}
  },
  "totalCents": {
    "return": "number",
    "arguments": {}
  }
}

StatisticOriginalCurrency: object

cashOnHoldToTradeCents:
object
return:
arguments:
object
cashOnHoldToWithdrawCents:
object
return:
arguments:
object
currency:
object
return:
arguments:
object
expectedMoneyAvailableCents:
object
return:
arguments:
object
moneyAvailableCents:
object
return:
arguments:
object
netContributionCents:
object
return:
arguments:
object
newContributionCents:
object
return:
arguments:
object
pendingContributionCents:
object
return:
arguments:
object
pendingWithdrawCents:
object
return:
arguments:
object
Example
{
  "cashOnHoldToTradeCents": {
    "return": "object",
    "arguments": {}
  },
  "cashOnHoldToWithdrawCents": {
    "return": "object",
    "arguments": {}
  },
  "currency": {
    "return": "string",
    "arguments": {}
  },
  "expectedMoneyAvailableCents": {
    "return": "object",
    "arguments": {}
  },
  "moneyAvailableCents": {
    "return": "object",
    "arguments": {}
  },
  "netContributionCents": {
    "return": "object",
    "arguments": {}
  },
  "newContributionCents": {
    "return": "object",
    "arguments": {}
  },
  "pendingContributionCents": {
    "return": "object",
    "arguments": {}
  },
  "pendingWithdrawCents": {
    "return": "object",
    "arguments": {}
  }
}

Statistics: object

availableFundsToWithdrawCents:
object
return:
arguments:
object
capitalGainsAndLossesHistory:
object
return:
CapitalGainsAndLosses
arguments:
object
capitalGainsAndLossesInFiscalYear:
object
return:
arguments:
object
referenceDate:
cashOnHoldToTradeCents:
object
return:
arguments:
object
cashOnHoldToWithdrawCents:
object
return:
arguments:
object
currency:
object
return:
arguments:
object
depositContributionCents:
object
return:
arguments:
object
endDate:
startDate:
types:
TransactionTypes
useFiscalDate:
expectedMoneyAvailableCents:
object
return:
arguments:
object
forUserId:
object
return:
arguments:
object
foreignExchangeRates:
object
return:
StatisticForeignExchangeRate
arguments:
object
historySnapshot:
object
return:
arguments:
object
date:
holdings:
object
return:
StatisticHolding
arguments:
object
holdingsMissingRate:
object
return:
StatisticHolding
arguments:
object
id:
object
return:
arguments:
object
marketValueCents:
object
return:
arguments:
object
moneyAvailableCents:
object
return:
arguments:
object
moneyWeightedReturn:
object
return:
arguments:
object
endDate:
startDate:
netContributionCents:
object
return:
arguments:
object
netContributionCentsInFiscalYear:
object

Net contribution in fiscal year. Only returns the value for statistics object in Account Type.

return:
arguments:
object
referenceDate:
newContributionCents:
object
return:
arguments:
object
objectType:
object
return:
arguments:
object
originalCurrencies:
object
return:
StatisticOriginalCurrency
arguments:
object
originalCurrenciesMissingRate:
object
return:
StatisticOriginalCurrency
arguments:
object
pendingContributionCents:
object
return:
arguments:
object
primaryAssetClassHoldings:
object
return:
PrimaryAssetClassHoldings
arguments:
object
simpleReturnAmount:
object
return:
arguments:
object
endDate:
startDate:
simpleReturnPercent:
object
return:
arguments:
object
endDate:
startDate:
taxLossHarvestCreditHistory:
object
return:
TaxLossHarvestCredit
arguments:
object
taxLossHarvestCreditInFiscalYear:
object
return:
arguments:
object
year:
timeWeightedReturn:
object
return:
arguments:
object
endDate:
startDate:
withdrawContributionCents:
object
return:
arguments:
object
endDate:
startDate:
types:
TransactionTypes
useFiscalDate:
Example
{
  "availableFundsToWithdrawCents": {
    "return": "object",
    "arguments": {}
  },
  "capitalGainsAndLossesHistory": {
    "return": [
      {
        "account": {
          "return": "object",
          "arguments": {}
        },
        "id": {
          "return": "object",
          "arguments": {}
        },
        "totalCents": {
          "return": "number",
          "arguments": {}
        },
        "year": {
          "return": "number",
          "arguments": {}
        }
      }
    ],
    "arguments": {}
  },
  "capitalGainsAndLossesInFiscalYear": {
    "return": "object",
    "arguments": {
      "referenceDate": "object"
    }
  },
  "cashOnHoldToTradeCents": {
    "return": "object",
    "arguments": {}
  },
  "cashOnHoldToWithdrawCents": {
    "return": "object",
    "arguments": {}
  },
  "currency": {
    "return": "string",
    "arguments": {}
  },
  "depositContributionCents": {
    "return": "object",
    "arguments": {
      "endDate": "object",
      "startDate": "object",
      "types": [
        "string"
      ],
      "useFiscalDate": "boolean"
    }
  },
  "expectedMoneyAvailableCents": {
    "return": "object",
    "arguments": {}
  },
  "forUserId": {
    "return": "object",
    "arguments": {}
  },
  "foreignExchangeRates": {
    "return": [
      {
        "date": {
          "return": "object",
          "arguments": {}
        },
        "from": {
          "return": "string",
          "arguments": {}
        },
        "organization": {
          "return": "object",
          "arguments": {}
        },
        "rate": {
          "return": "number",
          "arguments": {}
        },
        "to": {
          "return": "string",
          "arguments": {}
        },
        "updatedAt": {
          "return": "object",
          "arguments": {}
        }
      }
    ],
    "arguments": {}
  },
  "historySnapshot": {
    "return": {
      "cashOnHoldToTradeCents": {
        "return": "object"
      }
    }
  }
}

StatisticsCurrencyTypes: string

object
CAD
object
USD

StatisticsInput: object

currency:
forUserId:
Example
{
  "currency": "string",
  "forUserId": "object"
}

StatsV2: object

availableFundsToWithdrawCents:
object
return:
arguments:
object
cashOnHoldToTradeCents:
object
return:
arguments:
object
cashOnHoldToWithdrawCents:
object
return:
arguments:
object
holdings:
object
return:
DailySnapshotHoldingV2
arguments:
object
marketValueCents:
object
return:
arguments:
object
moneyAvailableCents:
object
return:
arguments:
object
netContributionCents:
object
return:
arguments:
object
newContributionCents:
object
return:
arguments:
object
pendingContributionCents:
object
return:
arguments:
object
Example
{
  "availableFundsToWithdrawCents": {
    "return": "object",
    "arguments": {}
  },
  "cashOnHoldToTradeCents": {
    "return": "object",
    "arguments": {}
  },
  "cashOnHoldToWithdrawCents": {
    "return": "object",
    "arguments": {}
  },
  "holdings": {
    "return": [
      {
        "currentPriceCents": {
          "return": "number",
          "arguments": {}
        },
        "financialProduct": {
          "return": {
            "assignable": {
              "return": "boolean",
              "arguments": {}
            },
            "autoUpdatePrices": {
              "return": "boolean",
              "arguments": {}
            },
            "children": {
              "return": [
                {
                  "financialProduct": {
                    "return": {
                      "assignable": {
                        "return": "boolean",
                        "arguments": {}
                      },
                      "autoUpdatePrices": {
                        "return": "boolean",
                        "arguments": {}
                      },
                      "children": {
                        "return": [
                          {
                            "financialProduct": {
                              "return": {
                                "assignable": {
                                  "return": "boolean",
                                  "arguments": {}
                                },
                                "autoUpdatePrices": {
                                  "return": "boolean",
                                  "arguments": {}
                                },
                                "children": {
                                  "return": [
                                    {
                                      "financialProduct": {
                                        "return": {
                                          "assignable": {
                                            "return": "boolean",
                                            "arguments": {}
                                          },
                                          "autoUpdatePrices": {
                                            "return": "boolean",
                                            "arguments": {}
                                          },
                                          "children": {
                                            "return": [
                                              {
                                                "financialProduct": {
                                                  "return": {
                                                    "assignable": {
                                                      "return": "boolean",
                                                      "arguments": {}
                                                    },
                                                    "autoUpdatePrices": {
                                                      "return": "boolean",
                                                      "arguments": {}
                                                    },
                                                    "children": {
                                                      "return": [
                                                        {
                                                          "financialProduct": {
                                                            "return": {
                                                              "assignable": {}
                                                            }
                                                          }
                                                        }
                                                      ]
                                                    }
                                                  }
                                                }
                                              }
                                            ]
                                          }
                                        }
                                      }
                                    }
                                  ]
                                }
                              }
                            }
                          }
                        ]
                      }
                    }
                  }
                }
              ]
            }
          }
        }
      }
    ]
  }
}

Step: object

id:
object
return:
arguments:
object
name:
object
return:
arguments:
object
subSteps:
object
return:
SubStep
arguments:
object
Example
{
  "id": {
    "return": "object",
    "arguments": {}
  },
  "name": {
    "return": {
      "en": {
        "return": "string",
        "arguments": {}
      },
      "fr": {
        "return": "string",
        "arguments": {}
      }
    },
    "arguments": {}
  },
  "subSteps": {
    "return": [
      {
        "canGoBack": {
          "return": "boolean",
          "arguments": {}
        },
        "completeableBy": {
          "return": [
            "string"
          ],
          "arguments": {}
        },
        "id": {
          "return": "object",
          "arguments": {}
        },
        "options": {
          "return": "object",
          "arguments": {}
        },
        "rolesCompleteableBy": {
          "return": [
            {
              "accessiblePages": {
                "return": [
                  "string"
                ],
                "arguments": {}
              },
              "accountPageConfiguration": {
                "return": {
                  "createdAt": {
                    "return": "object",
                    "arguments": {}
                  },
                  "id": {
                    "return": "object",
                    "arguments": {}
                  },
                  "name": {
                    "return": "string",
                    "arguments": {}
                  },
                  "options": {
                    "return": "object",
                    "arguments": {}
                  },
                  "organization": {
                    "return": {
                      "accountTypeTaxRanks": {
                        "return": [
                          {
                            "accountType": {
                              "return": "string",
                              "arguments": {}
                            },
                            "id": {
                              "return": "object",
                              "arguments": {}
                            },
                            "taxRank": {
                              "return": "number",
                              "arguments": {}
                            }
                          }
                        ],
                        "arguments": {}
                      },
                      "allowAccessToSubOrganizations": {
                        "return": "boolean",
                        "arguments": {}
                      },
                      "allowDirectCommunication": {
                        "return": "boolean",
                        "arguments": {}
                      },
                      "allowInactiveUserAdjustments": {
                        "return": "boolean",
                        "arguments": {}
                      },
                      "allowInactiveUserFeeCalculation": {}
                    }
                  }
                }
              }
            }
          ]
        }
      }
    ]
  }
}

String: string

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.

SubAccount: object

acceptableFinancialProduct:
object
return:
arguments:
object
account:
object
return:
arguments:
object
allIncompleteFormAgreements:
object

Lists remaining forms to be signed for this subAccount plus forms for associated account and user.

return:
IncompleteFormAgreement
arguments:
object
allLatestFormAgreements:
object

Lists latest signed forms for this subAccount plus forms for associated account and user.

return:
FormAgreement
arguments:
object
allowClientDeposits:
object
return:
arguments:
object
applicableBillingSchedule:
object
return:
arguments:
object
applicableFeeTier:
object
return:
arguments:
object
approvedAt:
object
return:
arguments:
object
availableFinancialProducts:
object
return:
FinancialProduct
arguments:
object
availableThemes:
object
return:
Theme
arguments:
object
billingSchedule:
object
return:
arguments:
object
calculatedSuitabilityScore:
object
return:
Int
arguments:
object
completedAt:
object
return:
arguments:
object
createdAt:
object
return:
arguments:
object
custodianSuitabilityScore:
object
return:
arguments:
object
feeTier:
object
return:
arguments:
object
financialProduct:
object
return:
arguments:
object
financialProductId:
object
return:
arguments:
object
goal:
object
return:
arguments:
object
id:
object
return:
arguments:
object
incompleteFields:
object
return:
String
arguments:
object
incompleteFormAgreements:
object

Lists remaining forms to be signed for this subAccount.

return:
IncompleteFormAgreement
arguments:
object
isPartial:
object
return:
arguments:
object
lastUpdatedBy:
object
return:
arguments:
object
latestFormAgreements:
object

Lists latest signed forms for this subAccount.

return:
FormAgreement
arguments:
object
liquidated:
object

a subAccount is considered 'liquidated' after a withdraw-all transfer is requested and until a client initiated deposit is reconciled

return:
arguments:
object
name:
object
return:
arguments:
object
netContributionsHistoryCents:
object
return:
TimeValue
arguments:
object
organization:
object
return:
arguments:
object
pendingWithdrawAll:
object
return:
arguments:
object
schedule:
object
return:
arguments:
object
signedAllFormsAt:
object
return:
arguments:
object
skipIPS:
object
return:
arguments:
object
state:
object
return:
arguments:
object
stateChanges:
object
return:
StateChanges
arguments:
object
statistics:
object
return:
arguments:
object
input:
stats:
object
return:
arguments:
object
force:

Force cache miss. Re-calculates statistics with current data.

statsV2:
object
return:
arguments:
object
suggestedFinancialProduct:
object
return:
arguments:
object
themeId:
suitabilityScore:
object
return:
Int
arguments:
object
theme:
object
return:
arguments:
object
tradingProcess:
object
return:
arguments:
object
transfers:
object
return:
Transfer
arguments:
object
Example
{
  "acceptableFinancialProduct": {
    "return": "boolean",
    "arguments": {}
  },
  "account": {
    "return": {
      "affiliations": {
        "return": [
          {
            "allocation": {
              "return": "number",
              "arguments": {}
            },
            "id": {
              "return": "object",
              "arguments": {}
            },
            "relation": {
              "return": "string",
              "arguments": {}
            },
            "signatureRequired": {
              "return": "boolean",
              "arguments": {}
            },
            "type": {
              "return": "string",
              "arguments": {}
            },
            "user": {
              "return": {
                "accessibleBy": {
                  "return": [
                    {
                      "displayOptions": {
                        "return": {
                          "hide": {
                            "return": "boolean",
                            "arguments": {}
                          },
                          "order": {
                            "return": "number",
                            "arguments": {}
                          }
                        },
                        "arguments": {}
                      },
                      "organizationUser": {
                        "return": {
                          "accessType": {
                            "return": "string",
                            "arguments": {}
                          },
                          "apiTokens": {
                            "return": [
                              {
                                "id": {
                                  "return": "object",
                                  "arguments": {}
                                },
                                "jwtToken": {
                                  "return": "string",
                                  "arguments": {}
                                },
                                "name": {
                                  "return": "string",
                                  "arguments": {}
                                },
                                "organization": {
                                  "return": {
                                    "browserTabTitle": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "faviconLink": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "id": {
                                      "return": "object",
                                      "arguments": {}
                                    },
                                    "name": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "parent": {
                                      "return": {
                                        "browserTabTitle": {
                                          "return": "string",
                                          "arguments": {}
                                        }
                                      }
                                    }
                                  }
                                }
                              }
                            ]
                          }
                        }
                      }
                    }
                  ]
                }
              }
            }
          }
        ]
      }
    }
  }
}

SubAccountBilling: object

account:
object
return:
arguments:
object
adjustedFeeCents:
object
return:
arguments:
object
adjustedSalesTaxCents:
object
return:
arguments:
object
billingCycle:
object
return:
arguments:
object
billingDate:
object
return:
arguments:
object
billingSchedule:
object
return:
arguments:
object
calculatedAt:
object
return:
arguments:
object
chargeableMarketValueCentsOnLastDay:
object
return:
arguments:
object
clientGroup:
object
return:
arguments:
object
endDate:
object
return:
arguments:
object
feeCents:
object
return:
arguments:
object
feePaymentAccount:
object
return:
arguments:
object
feeTier:
object
return:
arguments:
object
id:
object
return:
arguments:
object
marketValueCentsOnLastDay:
object
return:
arguments:
object
notes:
object
return:
arguments:
object
organization:
object
return:
arguments:
object
organizationRevenueShares:
object
return:
OrganizationRevenueShare
arguments:
object
projectedFeeAndTaxCents:
object
return:
arguments:
object
salesTaxCents:
object
return:
arguments:
object
startDate:
object
return:
arguments:
object
subAccount:
object
return:
arguments:
object
user:
object
return:
arguments:
object
withdrawAll:
object
return:
arguments:
object
Example
{
  "account": {
    "return": {
      "affiliations": {
        "return": [
          {
            "allocation": {
              "return": "number",
              "arguments": {}
            },
            "id": {
              "return": "object",
              "arguments": {}
            },
            "relation": {
              "return": "string",
              "arguments": {}
            },
            "signatureRequired": {
              "return": "boolean",
              "arguments": {}
            },
            "type": {
              "return": "string",
              "arguments": {}
            },
            "user": {
              "return": {
                "accessibleBy": {
                  "return": [
                    {
                      "displayOptions": {
                        "return": {
                          "hide": {
                            "return": "boolean",
                            "arguments": {}
                          },
                          "order": {
                            "return": "number",
                            "arguments": {}
                          }
                        },
                        "arguments": {}
                      },
                      "organizationUser": {
                        "return": {
                          "accessType": {
                            "return": "string",
                            "arguments": {}
                          },
                          "apiTokens": {
                            "return": [
                              {
                                "id": {
                                  "return": "object",
                                  "arguments": {}
                                },
                                "jwtToken": {
                                  "return": "string",
                                  "arguments": {}
                                },
                                "name": {
                                  "return": "string",
                                  "arguments": {}
                                },
                                "organization": {
                                  "return": {
                                    "browserTabTitle": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "faviconLink": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "id": {
                                      "return": "object",
                                      "arguments": {}
                                    },
                                    "name": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "parent": {
                                      "return": {
                                        "browserTabTitle": {
                                          "return": "string",
                                          "arguments": {}
                                        },
                                        "faviconLink": {
                                          "return": "string",
                                          "arguments": {}
                                        }
                                      }
                                    }
                                  }
                                }
                              }
                            ]
                          }
                        }
                      }
                    }
                  ]
                }
              }
            }
          }
        ]
      }
    }
  }
}

SubAccountBillingQueryFilter: object

accountIds:
ObjectID
billingCycleIds:
ObjectID
billingDateAfter:
billingDateBefore:
billingScheduleIds:
ObjectID
clientGroupIds:
ObjectID
feeTierIds:
ObjectID
organizationId:
subAccountIds:
ObjectID
userIds:
ObjectID
Example
{
  "accountIds": [
    "object"
  ],
  "billingCycleIds": [
    "object"
  ],
  "billingDateAfter": "object",
  "billingDateBefore": "object",
  "billingScheduleIds": [
    "object"
  ],
  "clientGroupIds": [
    "object"
  ],
  "feeTierIds": [
    "object"
  ],
  "organizationId": "object",
  "subAccountIds": [
    "object"
  ],
  "userIds": [
    "object"
  ]
}

SubAccountDailyFee: object

account:
object
return:
arguments:
object
annualFeeBps:
object
return:
arguments:
object
billingCycle:
object
return:
arguments:
object
billingSchedule:
object
return:
arguments:
object
cashOnHoldToTradeCents:
object
return:
arguments:
object
chargeableMarketValueCents:
object

It is the amount considered to calculate fees, which ignores the waived fee percentage from holdings. Depending on the FeeTier chargeForCashOnHold and chargeForCash, it may also ignore cash on hold and/or the cash left in the portfolio.

return:
arguments:
object
clientGroup:
object
return:
arguments:
object
createdAt:
object
return:
arguments:
object
dailyFeeBps:
object
return:
arguments:
object
dailyFixedFeeCents:
object
return:
arguments:
object
date:
object
return:
arguments:
object
discountPercentage:
object

A discount percentage applied to the calculated fee (0 - 100%).

return:
arguments:
object
feeTier:
object
return:
arguments:
object
gridScopeTotalMarketValueCents:
object

It is the amount considered to identify the fee tier.

return:
arguments:
object
gridScopeType:
object
return:
arguments:
object
id:
object
return:
arguments:
object
marketValueCents:
object
return:
arguments:
object
moneyAvailableCents:
object
return:
arguments:
object
organization:
object
return:
arguments:
object
state:
object
return:
arguments:
object
subAccount:
object
return:
arguments:
object
totalDailyFeeCents:
object
return:
arguments:
object
totalWaivedFeeHoldingCents:
object

Total amount removed from marketValueCents based on the waived fee percentages defined for each FinancialProduct holding.

return:
arguments:
object
updatedAt:
object
return:
arguments:
object
user:
object
return:
arguments:
object
Example
{
  "account": {
    "return": {
      "affiliations": {
        "return": [
          {
            "allocation": {
              "return": "number",
              "arguments": {}
            },
            "id": {
              "return": "object",
              "arguments": {}
            },
            "relation": {
              "return": "string",
              "arguments": {}
            },
            "signatureRequired": {
              "return": "boolean",
              "arguments": {}
            },
            "type": {
              "return": "string",
              "arguments": {}
            },
            "user": {
              "return": {
                "accessibleBy": {
                  "return": [
                    {
                      "displayOptions": {
                        "return": {
                          "hide": {
                            "return": "boolean",
                            "arguments": {}
                          },
                          "order": {
                            "return": "number",
                            "arguments": {}
                          }
                        },
                        "arguments": {}
                      },
                      "organizationUser": {
                        "return": {
                          "accessType": {
                            "return": "string",
                            "arguments": {}
                          },
                          "apiTokens": {
                            "return": [
                              {
                                "id": {
                                  "return": "object",
                                  "arguments": {}
                                },
                                "jwtToken": {
                                  "return": "string",
                                  "arguments": {}
                                },
                                "name": {
                                  "return": "string",
                                  "arguments": {}
                                },
                                "organization": {
                                  "return": {
                                    "browserTabTitle": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "faviconLink": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "id": {
                                      "return": "object",
                                      "arguments": {}
                                    },
                                    "name": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "parent": {
                                      "return": {
                                        "browserTabTitle": {
                                          "return": "string",
                                          "arguments": {}
                                        },
                                        "faviconLink": {
                                          "return": "string",
                                          "arguments": {}
                                        }
                                      }
                                    }
                                  }
                                }
                              }
                            ]
                          }
                        }
                      }
                    }
                  ]
                }
              }
            }
          }
        ]
      }
    }
  }
}

SubAccountDailyFeeQueryFilter: object

accountIds:
ObjectID
billingCycleIds:
ObjectID
billingScheduleIds:
ObjectID
clientGroupIds:
ObjectID
dateAfter:
dateBefore:
feeTierIds:
ObjectID
organizationId:
state:
subAccountBillingIds:
ObjectID
subAccountIds:
ObjectID
userIds:
ObjectID
Example
{
  "accountIds": [
    "object"
  ],
  "billingCycleIds": [
    "object"
  ],
  "billingScheduleIds": [
    "object"
  ],
  "clientGroupIds": [
    "object"
  ],
  "dateAfter": "object",
  "dateBefore": "object",
  "feeTierIds": [
    "object"
  ],
  "organizationId": "object",
  "state": "string",
  "subAccountBillingIds": [
    "object"
  ],
  "subAccountIds": [
    "object"
  ],
  "userIds": [
    "object"
  ]
}

SubAccountDailyFeeStates: string

object
COMPLETED
object
IN_PROGRESS

SubAccountInactiveReasons: string

Inactive subAccount reasons.

object
CAR
object
DISSATISFIED_WITH_ONEVEST
object
EDUCATION
object
EMERGENCY
object
HOUSE
object
INVESTING_IS_NOT_FOR_ME
object
MAJOR_PURCHASE
object
OTHER
object
PARENTAL_LEAVE
object
POOR_RETURNS
object
RETIREMENT_INCOME
object
START_A_BUSINESS
object
VACATION
object
WEDDING

SubAccountPaginationAndSorting: object

offSet:
Int
perPage:
Int
sortDesc:
sortField:
Example
{
  "offSet": "number",
  "perPage": "number",
  "sortDesc": "boolean",
  "sortField": "string"
}

SubAccountQueryFilter: object

accountId:
accountType:
clientGroupId:
completedAtAfter:
completedAtBefore:
complianceState:
financialProductId:
goalId:
iDCheckCompleted:
iDVerified:
includeHousehold:
isComplete:
organizationId:
state:
userId:
Example
{
  "accountId": "object",
  "accountType": "string",
  "clientGroupId": "object",
  "completedAtAfter": "object",
  "completedAtBefore": "object",
  "complianceState": "string",
  "financialProductId": "string",
  "goalId": "object",
  "iDCheckCompleted": "boolean",
  "iDVerified": "boolean",
  "includeHousehold": "boolean",
  "isComplete": "boolean",
  "organizationId": "object",
  "state": "string",
  "userId": "object"
}

SubAccountReport: object

cashAvailableForTradeCents:
object
return:
arguments:
object
cashCents:
object
return:
arguments:
object
expectedCashCents:
object
return:
arguments:
object
id:
object
return:
arguments:
object
marketValueCents:
object
return:
arguments:
object
pendingWithdrawCents:
object
return:
arguments:
object
subAccount:
object
return:
arguments:
object
Example
{
  "cashAvailableForTradeCents": {
    "return": "object",
    "arguments": {}
  },
  "cashCents": {
    "return": "object",
    "arguments": {}
  },
  "expectedCashCents": {
    "return": "object",
    "arguments": {}
  },
  "id": {
    "return": "object",
    "arguments": {}
  },
  "marketValueCents": {
    "return": "object",
    "arguments": {}
  },
  "pendingWithdrawCents": {
    "return": "object",
    "arguments": {}
  },
  "subAccount": {
    "return": {
      "acceptableFinancialProduct": {
        "return": "boolean",
        "arguments": {}
      },
      "account": {
        "return": {
          "affiliations": {
            "return": [
              {
                "allocation": {
                  "return": "number",
                  "arguments": {}
                },
                "id": {
                  "return": "object",
                  "arguments": {}
                },
                "relation": {
                  "return": "string",
                  "arguments": {}
                },
                "signatureRequired": {
                  "return": "boolean",
                  "arguments": {}
                },
                "type": {
                  "return": "string",
                  "arguments": {}
                },
                "user": {
                  "return": {
                    "accessibleBy": {
                      "return": [
                        {
                          "displayOptions": {
                            "return": {
                              "hide": {
                                "return": "boolean",
                                "arguments": {}
                              },
                              "order": {
                                "return": "number",
                                "arguments": {}
                              }
                            },
                            "arguments": {}
                          },
                          "organizationUser": {
                            "return": {
                              "accessType": {
                                "return": "string",
                                "arguments": {}
                              },
                              "apiTokens": {
                                "return": [
                                  {
                                    "id": {
                                      "return": "object",
                                      "arguments": {}
                                    },
                                    "jwtToken": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "name": {
                                      "return": "string"
                                    }
                                  }
                                ]
                              }
                            }
                          }
                        }
                      ]
                    }
                  }
                }
              }
            ]
          }
        }
      }
    }
  }
}

SubAccountStates: string

object
ACTIVE
object
AWAITING_APPROVAL
object
INACTIVE

SubAccountStats: object

availableFundsToWithdrawCents:
object
return:
arguments:
object
cashOnHoldToTradeCents:
object
return:
arguments:
object
cashOnHoldToWithdrawCents:
object
return:
arguments:
object
holdings:
object
return:
DailySnapshotHolding
arguments:
object
marketValueCents:
object
return:
arguments:
object
moneyAvailableCents:
object
return:
arguments:
object
moneyWeightedReturn:
object
return:
arguments:
object
endDate:
startDate:
netContributionCents:
object
return:
arguments:
object
newContributionCents:
object
return:
arguments:
object
pendingContributionCents:
object
return:
arguments:
object
simpleReturnAmount:
object
return:
arguments:
object
endDate:
startDate:
simpleReturnPercent:
object
return:
arguments:
object
endDate:
startDate:
subAccount:
object
return:
arguments:
object
timeWeightedReturn:
object
return:
arguments:
object
endDate:
startDate:
Example
{
  "availableFundsToWithdrawCents": {
    "return": "object",
    "arguments": {}
  },
  "cashOnHoldToTradeCents": {
    "return": "object",
    "arguments": {}
  },
  "cashOnHoldToWithdrawCents": {
    "return": "object",
    "arguments": {}
  },
  "holdings": {
    "return": [
      {
        "currentPriceCents": {
          "return": "number",
          "arguments": {}
        },
        "financialProduct": {
          "return": {
            "assignable": {
              "return": "boolean",
              "arguments": {}
            },
            "autoUpdatePrices": {
              "return": "boolean",
              "arguments": {}
            },
            "children": {
              "return": [
                {
                  "financialProduct": {
                    "return": {
                      "assignable": {
                        "return": "boolean",
                        "arguments": {}
                      },
                      "autoUpdatePrices": {
                        "return": "boolean",
                        "arguments": {}
                      },
                      "children": {
                        "return": [
                          {
                            "financialProduct": {
                              "return": {
                                "assignable": {
                                  "return": "boolean",
                                  "arguments": {}
                                },
                                "autoUpdatePrices": {
                                  "return": "boolean",
                                  "arguments": {}
                                },
                                "children": {
                                  "return": [
                                    {
                                      "financialProduct": {
                                        "return": {
                                          "assignable": {
                                            "return": "boolean",
                                            "arguments": {}
                                          },
                                          "autoUpdatePrices": {
                                            "return": "boolean",
                                            "arguments": {}
                                          },
                                          "children": {
                                            "return": [
                                              {
                                                "financialProduct": {
                                                  "return": {
                                                    "assignable": {
                                                      "return": "boolean",
                                                      "arguments": {}
                                                    },
                                                    "autoUpdatePrices": {
                                                      "return": "boolean",
                                                      "arguments": {}
                                                    },
                                                    "children": {
                                                      "return": [
                                                        {
                                                          "financialProduct": {
                                                            "return": {
                                                              "assignable": {}
                                                            }
                                                          }
                                                        }
                                                      ]
                                                    }
                                                  }
                                                }
                                              }
                                            ]
                                          }
                                        }
                                      }
                                    }
                                  ]
                                }
                              }
                            }
                          }
                        ]
                      }
                    }
                  }
                }
              ]
            }
          }
        }
      }
    ]
  }
}

SubAccountSuggestedFinancialProductInput: object

subAccountId:
Example
{
  "subAccountId": "object"
}

SubAccountTradingProcesses: string

object
NO_AUTOMATION
object
PORTFOLIO_OPTIMIZER
object
REBALANCE_V1
object
REBALANCE_V2

SubAccountTransition: string

object
activate
object
deactivate
object
review

SubAccountUpdate: object

d:
object
return:
arguments:
object
id:
object
return:
arguments:
object
o:
object
return:
arguments:
object
t:
object
return:
arguments:
object
Example
{
  "d": {
    "return": "string",
    "arguments": {}
  },
  "id": {
    "return": "object",
    "arguments": {}
  },
  "o": {
    "return": "string",
    "arguments": {}
  },
  "t": {
    "return": "object",
    "arguments": {}
  }
}

SubAccountUpdatePaginationAndSorting: object

offSet:
Int
perPage:
Int
sortDesc:
Example
{
  "offSet": "number",
  "perPage": "number",
  "sortDesc": "boolean"
}

SubAccountsDaily: object

date:
object
return:
arguments:
object
holdings:
object
return:
Holding
arguments:
object
id:
object
return:
arguments:
object
marketValueCents:
object
return:
arguments:
object
moneyAvailableCents:
object
return:
arguments:
object
netContributionCents:
object
return:
arguments:
object
newContributionCents:
object
return:
arguments:
object
subAccount:
object
return:
arguments:
object
Example
{
  "date": {
    "return": "object",
    "arguments": {}
  },
  "holdings": {
    "return": [
      {
        "currentPriceCents": {
          "return": "number",
          "arguments": {}
        },
        "financialProduct": {
          "return": {
            "assignable": {
              "return": "boolean",
              "arguments": {}
            },
            "autoUpdatePrices": {
              "return": "boolean",
              "arguments": {}
            },
            "children": {
              "return": [
                {
                  "financialProduct": {
                    "return": {
                      "assignable": {
                        "return": "boolean",
                        "arguments": {}
                      },
                      "autoUpdatePrices": {
                        "return": "boolean",
                        "arguments": {}
                      },
                      "children": {
                        "return": [
                          {
                            "financialProduct": {
                              "return": {
                                "assignable": {
                                  "return": "boolean",
                                  "arguments": {}
                                },
                                "autoUpdatePrices": {
                                  "return": "boolean",
                                  "arguments": {}
                                },
                                "children": {
                                  "return": [
                                    {
                                      "financialProduct": {
                                        "return": {
                                          "assignable": {
                                            "return": "boolean",
                                            "arguments": {}
                                          },
                                          "autoUpdatePrices": {
                                            "return": "boolean",
                                            "arguments": {}
                                          },
                                          "children": {
                                            "return": [
                                              {
                                                "financialProduct": {
                                                  "return": {
                                                    "assignable": {
                                                      "return": "boolean",
                                                      "arguments": {}
                                                    },
                                                    "autoUpdatePrices": {
                                                      "return": "boolean",
                                                      "arguments": {}
                                                    },
                                                    "children": {
                                                      "return": [
                                                        {
                                                          "financialProduct": {
                                                            "return": {
                                                              "assignable": {
                                                                "return": "boolean",
                                                                "arguments": {}
                                                              },
                                                              "autoUpdatePrices": {
                                                                "return": "boolean",
                                                                "arguments": {}
                                                              },
                                                              "children": {}
                                                            }
                                                          }
                                                        }
                                                      ]
                                                    }
                                                  }
                                                }
                                              }
                                            ]
                                          }
                                        }
                                      }
                                    }
                                  ]
                                }
                              }
                            }
                          }
                        ]
                      }
                    }
                  }
                }
              ]
            }
          }
        }
      }
    ]
  }
}

SubStep: object

canGoBack:
object
return:
arguments:
object
completeableBy:
object
return:
SubStepCompleteableBys
arguments:
object
id:
object
return:
arguments:
object
options:
object
return:
arguments:
object
rolesCompleteableBy:
object
return:
Role
arguments:
object
skippable:
object
return:
arguments:
object
type:
object
return:
arguments:
object
Example
{
  "canGoBack": {
    "return": "boolean",
    "arguments": {}
  },
  "completeableBy": {
    "return": [
      "string"
    ],
    "arguments": {}
  },
  "id": {
    "return": "object",
    "arguments": {}
  },
  "options": {
    "return": "object",
    "arguments": {}
  },
  "rolesCompleteableBy": {
    "return": [
      {
        "accessiblePages": {
          "return": [
            "string"
          ],
          "arguments": {}
        },
        "accountPageConfiguration": {
          "return": {
            "createdAt": {
              "return": "object",
              "arguments": {}
            },
            "id": {
              "return": "object",
              "arguments": {}
            },
            "name": {
              "return": "string",
              "arguments": {}
            },
            "options": {
              "return": "object",
              "arguments": {}
            },
            "organization": {
              "return": {
                "accountTypeTaxRanks": {
                  "return": [
                    {
                      "accountType": {
                        "return": "string",
                        "arguments": {}
                      },
                      "id": {
                        "return": "object",
                        "arguments": {}
                      },
                      "taxRank": {
                        "return": "number",
                        "arguments": {}
                      }
                    }
                  ],
                  "arguments": {}
                },
                "allowAccessToSubOrganizations": {
                  "return": "boolean",
                  "arguments": {}
                },
                "allowDirectCommunication": {
                  "return": "boolean",
                  "arguments": {}
                },
                "allowInactiveUserAdjustments": {
                  "return": "boolean",
                  "arguments": {}
                },
                "allowInactiveUserFeeCalculation": {
                  "return": "boolean",
                  "arguments": {}
                },
                "allowInactiveUserRebalancing": {
                  "return": "boolean",
                  "arguments": {}
                },
                "allowInstantInvest": {
                  "return": "boolean",
                  "arguments": {}
                },
                "allowPortfolioPerGoal": {
                  "return": "boolean",
                  "arguments": {}
                },
                "allowPostOptimizationEditing": {
                  "return": "boolean",
                  "arguments": {}
                },
                "allowViewSubTradeRequestPairs": {}
              }
            }
          }
        }
      }
    ]
  }
}

SubStepCompleteableBys: string

object
ORGANIZATION_USER
object
USER

SubStepOption: object

default:
object
return:
arguments:
object
key:
object
return:
arguments:
object
label:
object
return:
arguments:
object
optionType:
object
return:
arguments:
object
options:
object
return:
arguments:
object
showIf:
object
return:
arguments:
object
Example
{
  "default": {
    "return": "object",
    "arguments": {}
  },
  "key": {
    "return": "string",
    "arguments": {}
  },
  "label": {
    "return": {
      "en": {
        "return": "string",
        "arguments": {}
      },
      "fr": {
        "return": "string",
        "arguments": {}
      }
    },
    "arguments": {}
  },
  "optionType": {
    "return": "string",
    "arguments": {}
  },
  "options": {
    "return": "object",
    "arguments": {}
  },
  "showIf": {
    "return": "object",
    "arguments": {}
  }
}

SubStepOptionTypes: string

object
ATTACHMENT
object
AUTOMATED_BANKING_SELECTED
object
BASIC_FIELD
object
BASIC_OR_SELECT_FIELD
object
BOOLEAN
object
COUNTRY_SPECIFIC_TAX_ID
object
DATA_FIELDS
object
DEPOSIT_TYPE_SELECT_FIELD
object
EXTENDED_BOOLEAN
object
INVESTMENT_KNOWLEDGE_OPTIONS
object
LIST_TILE
object
OPTIONAL_TRANSLATED_STRING
object
RISK_QUESTION_OPTIONS
object
SCHEDULE_FREQUENCY_OPTIONS
object
SELECT_CUSTOM_FIELDS
object
SELECT_FIELD
object
TIME_HORIZON_OPTIONS
object
TRANSLATED_STRING
object
WORKFLOW_SELECT_FIELD

SubStepTypes: string

object
ACCOUNTS
object
ACTION_ACTIVATE_ALL_SUB_ACCOUNTS
object
ACTION_NOTIFY
object
ACTION_UPDATE_USER
object
APPROVAL
object
ASSIGN_PORTFOLIO_TO_SUB_ACCOUNT
object
BANK_ACCOUNT_INFORMATION
object
CREATE_ACCOUNT_FOR_GOAL
object
CREATE_GOAL
object
DEPOSIT_FORM
object
DEPOSIT_REVIEW
object
DEPOSIT_TYPE
object
DOCUMENTS
object
EDIT_ACCOUNT
object
EDIT_GOAL
object
EMPLOYMENT_INFORMATION
object
FINANCIAL_PROJECTIONS
object
GOALS
object
GOAL_RISK_QUESTION_1
object
HOUSEHOLD
object
ID_VERIFICATION
object
INCOME_ASSETS_AND_DEBTS
object
INVESTMENT_KNOWLEDGE
object
NON_INDIVIDUAL_INFORMATION
object
NON_INDIVIDUAL_SETUP
object
PERSONAL_INFORMATION
object
PERSONS_OF_INTEREST
object
PROJECTIONS
object
RELATED_ENTITIES
object
RELATIONSHIP_INFORMATION
object
RESIDENCY_INFORMATION
object
REVIEW
object
REVIEW_ACCOUNT
object
REVIEW_BANK_ACCOUNT_INFORMATION
object
REVIEW_GOAL
object
REVIEW_PORTFOLIO_CHANGES
object
RISK_PROFILE
object
RISK_QUESTION_1
object
RISK_QUESTION_2
object
SUB_ACCOUNTS
object
TRANSFERS

SubTrade: object

actualQuantity:
object
return:
arguments:
object
actualTradePriceCents:
object
return:
arguments:
object
createdAt:
object
return:
arguments:
object
expectedQuantity:
object
return:
arguments:
object
expectedTradePriceCents:
object
return:
arguments:
object
failReason:
object
return:
arguments:
object
financialProduct:
object
return:
arguments:
object
id:
object
return:
arguments:
object
moneyAllocatedCents:
object
return:
arguments:
object
percentageFilled:
object
return:
Int
arguments:
object
rebalance:
object
return:
arguments:
object
reconciledAt:
object
return:
arguments:
object
state:
object
return:
arguments:
object
stateChanges:
object
return:
StateChanges
arguments:
object
subAccount:
object
return:
arguments:
object
trade:
object
return:
arguments:
object
type:
object
return:
arguments:
object
Example
{
  "actualQuantity": {
    "return": "number",
    "arguments": {}
  },
  "actualTradePriceCents": {
    "return": "number",
    "arguments": {}
  },
  "createdAt": {
    "return": "object",
    "arguments": {}
  },
  "expectedQuantity": {
    "return": "number",
    "arguments": {}
  },
  "expectedTradePriceCents": {
    "return": "number",
    "arguments": {}
  },
  "failReason": {
    "return": "string",
    "arguments": {}
  },
  "financialProduct": {
    "return": {
      "assignable": {
        "return": "boolean",
        "arguments": {}
      },
      "autoUpdatePrices": {
        "return": "boolean",
        "arguments": {}
      },
      "children": {
        "return": [
          {
            "financialProduct": {
              "return": {
                "assignable": {
                  "return": "boolean",
                  "arguments": {}
                },
                "autoUpdatePrices": {
                  "return": "boolean",
                  "arguments": {}
                },
                "children": {
                  "return": [
                    {
                      "financialProduct": {
                        "return": {
                          "assignable": {
                            "return": "boolean",
                            "arguments": {}
                          },
                          "autoUpdatePrices": {
                            "return": "boolean",
                            "arguments": {}
                          },
                          "children": {
                            "return": [
                              {
                                "financialProduct": {
                                  "return": {
                                    "assignable": {
                                      "return": "boolean",
                                      "arguments": {}
                                    },
                                    "autoUpdatePrices": {
                                      "return": "boolean",
                                      "arguments": {}
                                    },
                                    "children": {
                                      "return": [
                                        {
                                          "financialProduct": {
                                            "return": {
                                              "assignable": {
                                                "return": "boolean",
                                                "arguments": {}
                                              },
                                              "autoUpdatePrices": {
                                                "return": "boolean",
                                                "arguments": {}
                                              },
                                              "children": {
                                                "return": [
                                                  {}
                                                ]
                                              }
                                            }
                                          }
                                        }
                                      ]
                                    }
                                  }
                                }
                              }
                            ]
                          }
                        }
                      }
                    }
                  ]
                }
              }
            }
          }
        ]
      }
    }
  }
}

SubTradeQueryFilter: object

clientGroupId:
createdAtAfter:
createdAtBefore:
financialProductId:
goalId:
organizationId:
rebalanceId:
subAccountId:
subTradeState:
tradeId:
userId:
Example
{
  "clientGroupId": "object",
  "createdAtAfter": "object",
  "createdAtBefore": "object",
  "financialProductId": "object",
  "goalId": "object",
  "organizationId": "object",
  "rebalanceId": "object",
  "subAccountId": "object",
  "subTradeState": "string",
  "tradeId": "object",
  "userId": "object"
}

SubTradeRequest: object

account:
object
return:
arguments:
object
actualQuantity:
object
return:
arguments:
object
actualTradePriceCents:
object
return:
arguments:
object
blockedUntil:
object
return:
arguments:
object
blockedUntilPairActualTradePriceCents:
object
return:
Int
arguments:
object
bulkTradeRequest:
object
return:
arguments:
object
bulkTradeRun:
object
return:
arguments:
object
createdAt:
object
return:
arguments:
object
exchange:
object
return:
arguments:
object
expectedQuantity:
object
return:
arguments:
object
expectedTradePriceCents:
object
return:
arguments:
object
financialProduct:
object
return:
arguments:
object
id:
object
return:
arguments:
object
isPartial:
object
return:
arguments:
object
isProcessedForPair:
object
return:
arguments:
object
isSellAll:
object
return:
arguments:
object
maxQuantity:
object
return:
arguments:
object
moneyAllocatedCents:
object
return:
arguments:
object
pair:
object
return:
arguments:
object
preSplitMoneyAllocatedCents:
object
return:
arguments:
object
schedule:
object
return:
arguments:
object
settlementDate:
object
return:
arguments:
object
settlementDays:
object
return:
Int
arguments:
object
sourceId:
object
return:
arguments:
object
splitFrom:
object
return:
arguments:
object
splitTo:
object
return:
arguments:
object
splits:
object
return:
SubTradeRequest
arguments:
object
state:
object
return:
arguments:
object
stateChanges:
object
return:
StateChanges
arguments:
object
subAccount:
object
return:
arguments:
object
ticker:
object
return:
arguments:
object
tradeRequest:
object
return:
arguments:
object
type:
object
return:
arguments:
object
updatedAt:
object
return:
arguments:
object
user:
object
return:
arguments:
object
verifiedAt:
object
return:
arguments:
object
verifiedBy:
object
return:
arguments:
object
volatile:
object
return:
arguments:
object
Example
{
  "account": {
    "return": {
      "affiliations": {
        "return": [
          {
            "allocation": {
              "return": "number",
              "arguments": {}
            },
            "id": {
              "return": "object",
              "arguments": {}
            },
            "relation": {
              "return": "string",
              "arguments": {}
            },
            "signatureRequired": {
              "return": "boolean",
              "arguments": {}
            },
            "type": {
              "return": "string",
              "arguments": {}
            },
            "user": {
              "return": {
                "accessibleBy": {
                  "return": [
                    {
                      "displayOptions": {
                        "return": {
                          "hide": {
                            "return": "boolean",
                            "arguments": {}
                          },
                          "order": {
                            "return": "number",
                            "arguments": {}
                          }
                        },
                        "arguments": {}
                      },
                      "organizationUser": {
                        "return": {
                          "accessType": {
                            "return": "string",
                            "arguments": {}
                          },
                          "apiTokens": {
                            "return": [
                              {
                                "id": {
                                  "return": "object",
                                  "arguments": {}
                                },
                                "jwtToken": {
                                  "return": "string",
                                  "arguments": {}
                                },
                                "name": {
                                  "return": "string",
                                  "arguments": {}
                                },
                                "organization": {
                                  "return": {
                                    "browserTabTitle": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "faviconLink": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "id": {
                                      "return": "object",
                                      "arguments": {}
                                    },
                                    "name": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "parent": {
                                      "return": {
                                        "browserTabTitle": {
                                          "return": "string",
                                          "arguments": {}
                                        },
                                        "faviconLink": {
                                          "return": "string",
                                          "arguments": {}
                                        }
                                      }
                                    }
                                  }
                                }
                              }
                            ]
                          }
                        }
                      }
                    }
                  ]
                }
              }
            }
          }
        ]
      }
    }
  }
}

SubTradeRequestPaginationAndSorting: object

offSet:
Int
perPage:
Int
sortDesc:
sortField:
Example
{
  "offSet": "number",
  "perPage": "number",
  "sortDesc": "boolean",
  "sortField": "string"
}

SubTradeRequestQueryFilter: object

bulkTradeRequestId:
financialProductId:
showSplits:
sourceId:
state:
subAccountId:
type:
Example
{
  "bulkTradeRequestId": "object",
  "financialProductId": "object",
  "showSplits": "boolean",
  "sourceId": "object",
  "state": "string",
  "subAccountId": "object",
  "type": "string"
}

SubTradeRequestStates: string

object
CANCELED
object
INITIATED
object
READY
object
RECONCILED
object
REQUESTED

SubTradeRequestTransition: string

object
cancel

SubTradeRequestTypes: string

object
BUY
object
SELL

SubTradeStates: string

object
CANCELED
object
FAILED
object
INITIATED
object
PROCESSING
object
RECONCILED

SubTradeType: string

object
BUY
object
SELL

SubmitCustodianAccountOpeningInput: object

accountId:
Example
{
  "accountId": "object"
}

SubmitCustodianAccountOpeningResponse: object

account:
object
return:
arguments:
object
custodianAccountId:
object
return:
arguments:
object
custodianUserId:
object
return:
arguments:
object
state:
object
return:
arguments:
object
Example
{
  "account": {
    "return": {
      "affiliations": {
        "return": [
          {
            "allocation": {
              "return": "number",
              "arguments": {}
            },
            "id": {
              "return": "object",
              "arguments": {}
            },
            "relation": {
              "return": "string",
              "arguments": {}
            },
            "signatureRequired": {
              "return": "boolean",
              "arguments": {}
            },
            "type": {
              "return": "string",
              "arguments": {}
            },
            "user": {
              "return": {
                "accessibleBy": {
                  "return": [
                    {
                      "displayOptions": {
                        "return": {
                          "hide": {
                            "return": "boolean",
                            "arguments": {}
                          },
                          "order": {
                            "return": "number",
                            "arguments": {}
                          }
                        },
                        "arguments": {}
                      },
                      "organizationUser": {
                        "return": {
                          "accessType": {
                            "return": "string",
                            "arguments": {}
                          },
                          "apiTokens": {
                            "return": [
                              {
                                "id": {
                                  "return": "object",
                                  "arguments": {}
                                },
                                "jwtToken": {
                                  "return": "string",
                                  "arguments": {}
                                },
                                "name": {
                                  "return": "string",
                                  "arguments": {}
                                },
                                "organization": {
                                  "return": {
                                    "browserTabTitle": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "faviconLink": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "id": {
                                      "return": "object",
                                      "arguments": {}
                                    },
                                    "name": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "parent": {
                                      "return": {
                                        "browserTabTitle": {
                                          "return": "string",
                                          "arguments": {}
                                        },
                                        "faviconLink": {
                                          "return": "string",
                                          "arguments": {}
                                        }
                                      }
                                    }
                                  }
                                }
                              }
                            ]
                          }
                        }
                      }
                    }
                  ]
                }
              }
            }
          }
        ]
      }
    }
  }
}

SuccessorPhysicalAddress: object

city:
object
return:
arguments:
object
country:
object
return:
arguments:
object
houseNumber:
object
return:
arguments:
object
jurisdiction:
object
return:
arguments:
object
neighborhood:
object
return:
arguments:
object
postal:
object
return:
arguments:
object
province:
object
return:
arguments:
object
streetName:
object
return:
arguments:
object
unitNumber:
object
return:
arguments:
object
Example
{
  "city": {
    "return": "string",
    "arguments": {}
  },
  "country": {
    "return": "string",
    "arguments": {}
  },
  "houseNumber": {
    "return": "string",
    "arguments": {}
  },
  "jurisdiction": {
    "return": "string",
    "arguments": {}
  },
  "neighborhood": {
    "return": "string",
    "arguments": {}
  },
  "postal": {
    "return": "string",
    "arguments": {}
  },
  "province": {
    "return": "string",
    "arguments": {}
  },
  "streetName": {
    "return": "string",
    "arguments": {}
  },
  "unitNumber": {
    "return": "string",
    "arguments": {}
  }
}

SuccessorPhysicalAddressInput: object

city:
country:
houseNumber:
jurisdiction:
neighborhood:
postal:
province:
streetName:
unitNumber:
Example
{
  "city": "object",
  "country": "string",
  "houseNumber": "object",
  "jurisdiction": "string",
  "neighborhood": "object",
  "postal": "object",
  "province": "string",
  "streetName": "object",
  "unitNumber": "object"
}

SuggestFinancialProductInput: object

organizationId:
suitabilityScore:
Int
themeId:
Example
{
  "organizationId": "object",
  "suitabilityScore": "number",
  "themeId": "object"
}

SuggestFinancialProductResponse: object

financialProduct:
object
return:
arguments:
object
Example
{
  "financialProduct": {
    "return": {
      "assignable": {
        "return": "boolean",
        "arguments": {}
      },
      "autoUpdatePrices": {
        "return": "boolean",
        "arguments": {}
      },
      "children": {
        "return": [
          {
            "financialProduct": {
              "return": {
                "assignable": {
                  "return": "boolean",
                  "arguments": {}
                },
                "autoUpdatePrices": {
                  "return": "boolean",
                  "arguments": {}
                },
                "children": {
                  "return": [
                    {
                      "financialProduct": {
                        "return": {
                          "assignable": {
                            "return": "boolean",
                            "arguments": {}
                          },
                          "autoUpdatePrices": {
                            "return": "boolean",
                            "arguments": {}
                          },
                          "children": {
                            "return": [
                              {
                                "financialProduct": {
                                  "return": {
                                    "assignable": {
                                      "return": "boolean",
                                      "arguments": {}
                                    },
                                    "autoUpdatePrices": {
                                      "return": "boolean",
                                      "arguments": {}
                                    },
                                    "children": {
                                      "return": [
                                        {
                                          "financialProduct": {
                                            "return": {
                                              "assignable": {
                                                "return": "boolean",
                                                "arguments": {}
                                              },
                                              "autoUpdatePrices": {
                                                "return": "boolean",
                                                "arguments": {}
                                              },
                                              "children": {
                                                "return": [
                                                  {
                                                    "financialProduct": {
                                                      "return": {
                                                        "assignable": {
                                                          "return": "boolean",
                                                          "arguments": {}
                                                        },
                                                        "autoUpdatePrices": {
                                                          "return": "boolean",
                                                          "arguments": {}
                                                        },
                                                        "children": {
                                                          "return": [
                                                            {
                                                              "financialProduct": {
                                                                "return": {
                                                                  "assignable": {
                                                                    "return": "boolean",
                                                                    "arguments": {}
                                                                  },
                                                                  "autoUpdatePrices": {}
                                                                }
                                                              }
                                                            }
                                                          ]
                                                        }
                                                      }
                                                    }
                                                  }
                                                ]
                                              }
                                            }
                                          }
                                        }
                                      ]
                                    }
                                  }
                                }
                              }
                            ]
                          }
                        }
                      }
                    }
                  ]
                }
              }
            }
          }
        ]
      }
    }
  }
}

SwitchEquitiesAtCostInput: object

date:
description:
financialProductInId:
financialProductOutId:
isExistingHolding:
priceCents:
quantity:
subAccountId:
switchInPriceCents:
valueCents:
Example
{
  "date": "object",
  "description": "object",
  "financialProductInId": "object",
  "financialProductOutId": "object",
  "isExistingHolding": "boolean",
  "priceCents": "number",
  "quantity": "number",
  "subAccountId": "object",
  "switchInPriceCents": "number",
  "valueCents": "number"
}

SwitchEquitiesAtCostResponse: object

transactions:
object
return:
Transaction
arguments:
object
Example
{
  "transactions": {
    "return": [
      {
        "account": {
          "return": {
            "affiliations": {
              "return": [
                {
                  "allocation": {
                    "return": "number",
                    "arguments": {}
                  },
                  "id": {
                    "return": "object",
                    "arguments": {}
                  },
                  "relation": {
                    "return": "string",
                    "arguments": {}
                  },
                  "signatureRequired": {
                    "return": "boolean",
                    "arguments": {}
                  },
                  "type": {
                    "return": "string",
                    "arguments": {}
                  },
                  "user": {
                    "return": {
                      "accessibleBy": {
                        "return": [
                          {
                            "displayOptions": {
                              "return": {
                                "hide": {
                                  "return": "boolean",
                                  "arguments": {}
                                },
                                "order": {
                                  "return": "number",
                                  "arguments": {}
                                }
                              },
                              "arguments": {}
                            },
                            "organizationUser": {
                              "return": {
                                "accessType": {
                                  "return": "string",
                                  "arguments": {}
                                },
                                "apiTokens": {
                                  "return": [
                                    {
                                      "id": {
                                        "return": "object",
                                        "arguments": {}
                                      },
                                      "jwtToken": {
                                        "return": "string",
                                        "arguments": {}
                                      },
                                      "name": {
                                        "return": "string",
                                        "arguments": {}
                                      },
                                      "organization": {
                                        "return": {
                                          "browserTabTitle": {
                                            "return": "string",
                                            "arguments": {}
                                          },
                                          "faviconLink": {
                                            "return": "string",
                                            "arguments": {}
                                          },
                                          "id": {
                                            "return": "object",
                                            "arguments": {}
                                          },
                                          "name": {
                                            "return": "string",
                                            "arguments": {}
                                          },
                                          "parent": {
                                            "return": {
                                              "browserTabTitle": {
                                                "return": "string",
                                                "arguments": {}
                                              }
                                            }
                                          }
                                        }
                                      }
                                    }
                                  ]
                                }
                              }
                            }
                          }
                        ]
                      }
                    }
                  }
                }
              ]
            }
          }
        }
      }
    ]
  }
}

SwitchEquitiesAtMarketInput: object

date:
description:
financialProductInId:
financialProductOutId:
isExistingHolding:
priceCents:
quantity:
subAccountId:
switchInPriceCents:
valueCents:
Example
{
  "date": "object",
  "description": "object",
  "financialProductInId": "object",
  "financialProductOutId": "object",
  "isExistingHolding": "boolean",
  "priceCents": "number",
  "quantity": "number",
  "subAccountId": "object",
  "switchInPriceCents": "number",
  "valueCents": "number"
}

SwitchEquitiesAtMarketResponse: object

transactions:
object
return:
Transaction
arguments:
object
Example
{
  "transactions": {
    "return": [
      {
        "account": {
          "return": {
            "affiliations": {
              "return": [
                {
                  "allocation": {
                    "return": "number",
                    "arguments": {}
                  },
                  "id": {
                    "return": "object",
                    "arguments": {}
                  },
                  "relation": {
                    "return": "string",
                    "arguments": {}
                  },
                  "signatureRequired": {
                    "return": "boolean",
                    "arguments": {}
                  },
                  "type": {
                    "return": "string",
                    "arguments": {}
                  },
                  "user": {
                    "return": {
                      "accessibleBy": {
                        "return": [
                          {
                            "displayOptions": {
                              "return": {
                                "hide": {
                                  "return": "boolean",
                                  "arguments": {}
                                },
                                "order": {
                                  "return": "number",
                                  "arguments": {}
                                }
                              },
                              "arguments": {}
                            },
                            "organizationUser": {
                              "return": {
                                "accessType": {
                                  "return": "string",
                                  "arguments": {}
                                },
                                "apiTokens": {
                                  "return": [
                                    {
                                      "id": {
                                        "return": "object",
                                        "arguments": {}
                                      },
                                      "jwtToken": {
                                        "return": "string",
                                        "arguments": {}
                                      },
                                      "name": {
                                        "return": "string",
                                        "arguments": {}
                                      },
                                      "organization": {
                                        "return": {
                                          "browserTabTitle": {
                                            "return": "string",
                                            "arguments": {}
                                          },
                                          "faviconLink": {
                                            "return": "string",
                                            "arguments": {}
                                          },
                                          "id": {
                                            "return": "object",
                                            "arguments": {}
                                          },
                                          "name": {
                                            "return": "string",
                                            "arguments": {}
                                          },
                                          "parent": {
                                            "return": {
                                              "browserTabTitle": {
                                                "return": "string",
                                                "arguments": {}
                                              }
                                            }
                                          }
                                        }
                                      }
                                    }
                                  ]
                                }
                              }
                            }
                          }
                        ]
                      }
                    }
                  }
                }
              ]
            }
          }
        }
      }
    ]
  }
}

TLHAnalysisJob: object

createdAt:
object
return:
arguments:
object
id:
object
return:
arguments:
object
numEvents:
object
return:
Int
arguments:
object
organization:
object
return:
arguments:
object
state:
object
return:
arguments:
object
updatedAt:
object
return:
arguments:
object
Example
{
  "createdAt": {
    "return": "object",
    "arguments": {}
  },
  "id": {
    "return": "object",
    "arguments": {}
  },
  "numEvents": {
    "return": "number",
    "arguments": {}
  },
  "organization": {
    "return": {
      "browserTabTitle": {
        "return": "string",
        "arguments": {}
      },
      "faviconLink": {
        "return": "string",
        "arguments": {}
      },
      "id": {
        "return": "object",
        "arguments": {}
      },
      "name": {
        "return": "string",
        "arguments": {}
      },
      "parent": {
        "return": {
          "browserTabTitle": {
            "return": "string",
            "arguments": {}
          },
          "faviconLink": {
            "return": "string",
            "arguments": {}
          },
          "id": {
            "return": "object",
            "arguments": {}
          },
          "name": {
            "return": "string",
            "arguments": {}
          },
          "parent": {
            "return": {
              "browserTabTitle": {
                "return": "string",
                "arguments": {}
              },
              "faviconLink": {
                "return": "string",
                "arguments": {}
              },
              "id": {
                "return": "object",
                "arguments": {}
              },
              "name": {
                "return": "string",
                "arguments": {}
              },
              "parent": {
                "return": {
                  "browserTabTitle": {
                    "return": "string",
                    "arguments": {}
                  },
                  "faviconLink": {
                    "return": "string",
                    "arguments": {}
                  },
                  "id": {
                    "return": "object",
                    "arguments": {}
                  },
                  "name": {
                    "return": "string",
                    "arguments": {}
                  },
                  "parent": {
                    "return": {
                      "browserTabTitle": {
                        "return": "string",
                        "arguments": {}
                      },
                      "faviconLink": {
                        "return": "string",
                        "arguments": {}
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

TLHEvent: object

account:
object
return:
arguments:
object
adjustedCostBaseCents:
object
return:
Int
arguments:
object
currentPriceCents:
object
return:
Int
arguments:
object
financialProduct:
object
return:
arguments:
object
id:
object
return:
arguments:
object
quotient:
object
return:
arguments:
object
sellQuantity:
object
return:
arguments:
object
substituteFinancialProduct:
object
return:
arguments:
object
Example
{
  "account": {
    "return": {
      "affiliations": {
        "return": [
          {
            "allocation": {
              "return": "number",
              "arguments": {}
            },
            "id": {
              "return": "object",
              "arguments": {}
            },
            "relation": {
              "return": "string",
              "arguments": {}
            },
            "signatureRequired": {
              "return": "boolean",
              "arguments": {}
            },
            "type": {
              "return": "string",
              "arguments": {}
            },
            "user": {
              "return": {
                "accessibleBy": {
                  "return": [
                    {
                      "displayOptions": {
                        "return": {
                          "hide": {
                            "return": "boolean",
                            "arguments": {}
                          },
                          "order": {
                            "return": "number",
                            "arguments": {}
                          }
                        },
                        "arguments": {}
                      },
                      "organizationUser": {
                        "return": {
                          "accessType": {
                            "return": "string",
                            "arguments": {}
                          },
                          "apiTokens": {
                            "return": [
                              {
                                "id": {
                                  "return": "object",
                                  "arguments": {}
                                },
                                "jwtToken": {
                                  "return": "string",
                                  "arguments": {}
                                },
                                "name": {
                                  "return": "string",
                                  "arguments": {}
                                },
                                "organization": {
                                  "return": {
                                    "browserTabTitle": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "faviconLink": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "id": {
                                      "return": "object",
                                      "arguments": {}
                                    },
                                    "name": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "parent": {
                                      "return": {
                                        "browserTabTitle": {
                                          "return": "string",
                                          "arguments": {}
                                        },
                                        "faviconLink": {
                                          "return": "string",
                                          "arguments": {}
                                        }
                                      }
                                    }
                                  }
                                }
                              }
                            ]
                          }
                        }
                      }
                    }
                  ]
                }
              }
            }
          }
        ]
      }
    }
  }
}

TLHJobStates: string

object
CANCELLED
object
COMPLETE
object
GENERATING

TabConfiguration: object

icon:
object
return:
arguments:
object
id:
object
return:
arguments:
object
label:
object
return:
arguments:
object
url:
object
return:
arguments:
object
widgets:
object
return:
WidgetConfiguration
arguments:
object
Example
{
  "icon": {
    "return": "string",
    "arguments": {}
  },
  "id": {
    "return": "object",
    "arguments": {}
  },
  "label": {
    "return": {
      "en": {
        "return": "string",
        "arguments": {}
      },
      "fr": {
        "return": "string",
        "arguments": {}
      }
    },
    "arguments": {}
  },
  "url": {
    "return": "string",
    "arguments": {}
  },
  "widgets": {
    "return": [
      {
        "id": {
          "return": "object",
          "arguments": {}
        },
        "options": {
          "return": "object",
          "arguments": {}
        },
        "type": {
          "return": "string",
          "arguments": {}
        }
      }
    ],
    "arguments": {}
  }
}

TabConfigurationInput: object

icon:
label:
url:
widgets:
WidgetConfigurationInput
Example
{
  "icon": "string",
  "label": {
    "en": "object",
    "fr": "object"
  },
  "url": "string",
  "widgets": [
    {
      "options": "object",
      "type": "string"
    }
  ]
}

TargetAllocation: object

max:
object

Maximum percentage for this target allocation

return:
Int
arguments:
object
min:
object

Minimum percentage for this target allocation

return:
Int
arguments:
object
secondaryAssetClass:
object

Secondary Asset Class associated with the portfolio

return:
arguments:
object
Example
{
  "max": {
    "return": "number",
    "arguments": {}
  },
  "min": {
    "return": "number",
    "arguments": {}
  },
  "secondaryAssetClass": {
    "return": {
      "description": {
        "return": "string",
        "arguments": {}
      },
      "id": {
        "return": "object",
        "arguments": {}
      },
      "includeCash": {
        "return": "boolean",
        "arguments": {}
      },
      "key": {
        "return": "string",
        "arguments": {}
      },
      "name": {
        "return": "string",
        "arguments": {}
      },
      "state": {
        "return": "string",
        "arguments": {}
      },
      "translatedDescription": {
        "return": {
          "en": {
            "return": "string",
            "arguments": {}
          },
          "fr": {
            "return": "string",
            "arguments": {}
          }
        },
        "arguments": {}
      },
      "translatedName": {
        "return": {
          "en": {
            "return": "string",
            "arguments": {}
          },
          "fr": {
            "return": "string",
            "arguments": {}
          }
        },
        "arguments": {}
      }
    },
    "arguments": {}
  }
}

TargetAllocationInput: object

max:
Int

Maximum percentage for this target allocation

min:
Int

Minimum percentage for this target allocation

secondaryAssetClassId:

Secondary AssetClass associated with the portfolio

Example
{
  "max": "number",
  "min": "number",
  "secondaryAssetClassId": "object"
}

TaxIdTypes: string

User's Tax ID Type

object
BN
object
EIN
object
ITIN
object
SIN
object
SSN

TaxLossHarvestCredit: object

account:
object
return:
arguments:
object
creditsCents:
object
return:
Int
arguments:
object
id:
object
return:
arguments:
object
year:
object
return:
Int
arguments:
object
Example
{
  "account": {
    "return": "object",
    "arguments": {}
  },
  "creditsCents": {
    "return": "number",
    "arguments": {}
  },
  "id": {
    "return": "object",
    "arguments": {}
  },
  "year": {
    "return": "number",
    "arguments": {}
  }
}

TaxOptionType: string

Scheduled Income Fund Transfer tax option.

object
NO_TAX_ON_MINIMUM
object
SPECIAL_TAX_RATE
object
TAX_ON_FULL

TaxRankAccountTypes: string

object
CASH_JOINT
object
CORPORATE_CASH
object
CORPORATE_CHARITY
object
CORPORATE_ESTATE
object
CORPORATE_TRUST
object
FHSA
object
GRSP
object
LIF
object
LIRA
object
LRIF
object
LRSP
object
PERSONAL
object
PRIF
object
RDSP
object
RESP
object
RESP_ADULT
object
RESP_FAMILY
object
RESP_FAMILY_JOINT
object
RESP_SINGLE
object
RESP_SINGLE_JOINT
object
RIF_SPOUSAL
object
RLIF
object
RLSP
object
RRIF
object
RRSP
object
RRSP_SPOUSAL
object
TFSA

TemplateParameter: object

key:
object
return:
arguments:
object
value:
object
return:
arguments:
object
Example
{
  "key": {
    "return": "object",
    "arguments": {}
  },
  "value": {
    "return": "object",
    "arguments": {}
  }
}

TestClientReportTemplateInput: object

frequency:
objectId:
objectType:
referenceDate:
templateHtml:
Example
{
  "frequency": "string",
  "objectId": "object",
  "objectType": "string",
  "referenceDate": "object",
  "templateHtml": "string"
}

TestClientReportTemplateResponse: object

html:
object
return:
arguments:
object
Example
{
  "html": {
    "return": "string",
    "arguments": {}
  }
}

TextTypes: string

object
HTML
object
MARKDOWN

Theme: object

core:
object
return:
arguments:
object
description:
object

The description of the Theme.

return:
arguments:
object
iconKey:
object

A key to select default Icon from organization assets.

return:
arguments:
object
id:
object

This is the ID and it is auto-generated by OneVest for each Theme.

return:
arguments:
object
key:
object

A key that can be used by front ends so that the name can change.

return:
arguments:
object
logs:
object
return:
arguments:
object
input:
name:
object

The name of the Theme.

return:
arguments:
object
state:
object

State of the Theme.

return:
arguments:
object
translatedDescription:
object
return:
arguments:
object
translatedName:
object
return:
arguments:
object
translatedShortDescription:
object
return:
arguments:
object
Example
{
  "core": {
    "return": "boolean",
    "arguments": {}
  },
  "description": {
    "return": "string",
    "arguments": {}
  },
  "iconKey": {
    "return": "string",
    "arguments": {}
  },
  "id": {
    "return": "object",
    "arguments": {}
  },
  "key": {
    "return": "string",
    "arguments": {}
  },
  "logs": {
    "return": {
      "logs": {
        "return": [
          {
            "account": {
              "return": {
                "affiliations": {
                  "return": [
                    {
                      "allocation": {
                        "return": "number",
                        "arguments": {}
                      },
                      "id": {
                        "return": "object",
                        "arguments": {}
                      },
                      "relation": {
                        "return": "string",
                        "arguments": {}
                      },
                      "signatureRequired": {
                        "return": "boolean",
                        "arguments": {}
                      },
                      "type": {
                        "return": "string",
                        "arguments": {}
                      },
                      "user": {
                        "return": {
                          "accessibleBy": {
                            "return": [
                              {
                                "displayOptions": {
                                  "return": {
                                    "hide": {
                                      "return": "boolean",
                                      "arguments": {}
                                    },
                                    "order": {
                                      "return": "number",
                                      "arguments": {}
                                    }
                                  },
                                  "arguments": {}
                                },
                                "organizationUser": {
                                  "return": {
                                    "accessType": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "apiTokens": {
                                      "return": [
                                        {
                                          "id": {
                                            "return": "object",
                                            "arguments": {}
                                          },
                                          "jwtToken": {
                                            "return": "string",
                                            "arguments": {}
                                          },
                                          "name": {
                                            "return": "string",
                                            "arguments": {}
                                          },
                                          "organization": {
                                            "return": {}
                                          }
                                        }
                                      ]
                                    }
                                  }
                                }
                              }
                            ]
                          }
                        }
                      }
                    }
                  ]
                }
              }
            }
          }
        ]
      }
    }
  }
}

ThemeLogsInput: object

filter:
pagination:
Example
{
  "filter": {
    "after": "object",
    "before": "object"
  },
  "pagination": {
    "offSet": "number",
    "perPage": "number",
    "sortDesc": "boolean",
    "sortField": "string"
  }
}

ThemeLogsQueryFilter: object

after:
before:
Example
{
  "after": "object",
  "before": "object"
}

ThemePaginationAndSorting: object

offset:
Int
perPage:
Int
sortDesc:
sortField:
Example
{
  "offset": "number",
  "perPage": "number",
  "sortDesc": "boolean",
  "sortField": "string"
}

ThemeQueryFilter: object

core:
keys:
SafeString
organizationId:
Example
{
  "core": "boolean",
  "keys": [
    "object"
  ],
  "organizationId": "object"
}

ThemeState: string

object
ACTIVE
object
ARCHIVED
object
DRAFT

ThemeTransitions: string

object
activate
object
archive
object
draft

TimeValue: object

amountCents:
object
return:
Int
arguments:
object
date:
object
return:
arguments:
object
Example
{
  "amountCents": {
    "return": "number",
    "arguments": {}
  },
  "date": {
    "return": "string",
    "arguments": {}
  }
}

TokenExchangeValidationTypes: string

object
JWK

TotalIncompleteTradeRequests: object

exchange:
object
return:
arguments:
object
total:
object
return:
Int
arguments:
object
Example
{
  "exchange": {
    "return": "string",
    "arguments": {}
  },
  "total": {
    "return": "number",
    "arguments": {}
  }
}

Trade: object

account:
object
return:
arguments:
object
actualQuantity:
object
return:
arguments:
object
actualTradePriceCents:
object
return:
arguments:
object
createdAt:
object
return:
arguments:
object
expectedQuantity:
object
return:
arguments:
object
expectedTradePriceCents:
object
return:
arguments:
object
failReason:
object
return:
arguments:
object
financialProduct:
object
return:
arguments:
object
id:
object
return:
arguments:
object
moneyAllocatedCents:
object
return:
arguments:
object
percentageFilled:
object
return:
Int
arguments:
object
rebalance:
object
return:
arguments:
object
reconciledAt:
object
return:
arguments:
object
state:
object
return:
arguments:
object
stateChanges:
object
return:
StateChanges
arguments:
object
type:
object
return:
arguments:
object
Example
{
  "account": {
    "return": {
      "affiliations": {
        "return": [
          {
            "allocation": {
              "return": "number",
              "arguments": {}
            },
            "id": {
              "return": "object",
              "arguments": {}
            },
            "relation": {
              "return": "string",
              "arguments": {}
            },
            "signatureRequired": {
              "return": "boolean",
              "arguments": {}
            },
            "type": {
              "return": "string",
              "arguments": {}
            },
            "user": {
              "return": {
                "accessibleBy": {
                  "return": [
                    {
                      "displayOptions": {
                        "return": {
                          "hide": {
                            "return": "boolean",
                            "arguments": {}
                          },
                          "order": {
                            "return": "number",
                            "arguments": {}
                          }
                        },
                        "arguments": {}
                      },
                      "organizationUser": {
                        "return": {
                          "accessType": {
                            "return": "string",
                            "arguments": {}
                          },
                          "apiTokens": {
                            "return": [
                              {
                                "id": {
                                  "return": "object",
                                  "arguments": {}
                                },
                                "jwtToken": {
                                  "return": "string",
                                  "arguments": {}
                                },
                                "name": {
                                  "return": "string",
                                  "arguments": {}
                                },
                                "organization": {
                                  "return": {
                                    "browserTabTitle": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "faviconLink": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "id": {
                                      "return": "object",
                                      "arguments": {}
                                    },
                                    "name": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "parent": {
                                      "return": {
                                        "browserTabTitle": {
                                          "return": "string",
                                          "arguments": {}
                                        },
                                        "faviconLink": {
                                          "return": "string",
                                          "arguments": {}
                                        }
                                      }
                                    }
                                  }
                                }
                              }
                            ]
                          }
                        }
                      }
                    }
                  ]
                }
              }
            }
          }
        ]
      }
    }
  }
}

TradeQueryFilter: object

accountId:
clientGroupId:
createdAtAfter:
createdAtBefore:
financialProductId:
organizationId:
rebalanceId:
tradeState:
userId:
userIds:
ObjectID
Example
{
  "accountId": "object",
  "clientGroupId": "object",
  "createdAtAfter": "object",
  "createdAtBefore": "object",
  "financialProductId": "object",
  "organizationId": "object",
  "rebalanceId": "object",
  "tradeState": "string",
  "userId": "object",
  "userIds": [
    "object"
  ]
}

TradeRequest: object

account:
object
return:
arguments:
object
actualQuantity:
object
return:
arguments:
object
actualTradePriceCents:
object
return:
arguments:
object
bulkTradeRun:
object
return:
arguments:
object
createdAt:
object
return:
arguments:
object
exchange:
object
return:
arguments:
object
expectedQuantity:
object
return:
arguments:
object
expectedTradePriceCents:
object
return:
arguments:
object
financialProduct:
object
return:
arguments:
object
id:
object
return:
arguments:
object
isPartial:
object
return:
arguments:
object
isSellAll:
object
return:
arguments:
object
maxQuantity:
object
return:
arguments:
object
moneyAllocatedCents:
object
return:
arguments:
object
state:
object
return:
arguments:
object
stateChanges:
object
return:
StateChanges
arguments:
object
ticker:
object
return:
arguments:
object
type:
object
return:
arguments:
object
updatedAt:
object
return:
arguments:
object
user:
object
return:
arguments:
object
Example
{
  "account": {
    "return": {
      "affiliations": {
        "return": [
          {
            "allocation": {
              "return": "number",
              "arguments": {}
            },
            "id": {
              "return": "object",
              "arguments": {}
            },
            "relation": {
              "return": "string",
              "arguments": {}
            },
            "signatureRequired": {
              "return": "boolean",
              "arguments": {}
            },
            "type": {
              "return": "string",
              "arguments": {}
            },
            "user": {
              "return": {
                "accessibleBy": {
                  "return": [
                    {
                      "displayOptions": {
                        "return": {
                          "hide": {
                            "return": "boolean",
                            "arguments": {}
                          },
                          "order": {
                            "return": "number",
                            "arguments": {}
                          }
                        },
                        "arguments": {}
                      },
                      "organizationUser": {
                        "return": {
                          "accessType": {
                            "return": "string",
                            "arguments": {}
                          },
                          "apiTokens": {
                            "return": [
                              {
                                "id": {
                                  "return": "object",
                                  "arguments": {}
                                },
                                "jwtToken": {
                                  "return": "string",
                                  "arguments": {}
                                },
                                "name": {
                                  "return": "string",
                                  "arguments": {}
                                },
                                "organization": {
                                  "return": {
                                    "browserTabTitle": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "faviconLink": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "id": {
                                      "return": "object",
                                      "arguments": {}
                                    },
                                    "name": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "parent": {
                                      "return": {
                                        "browserTabTitle": {
                                          "return": "string",
                                          "arguments": {}
                                        },
                                        "faviconLink": {
                                          "return": "string",
                                          "arguments": {}
                                        }
                                      }
                                    }
                                  }
                                }
                              }
                            ]
                          }
                        }
                      }
                    }
                  ]
                }
              }
            }
          }
        ]
      }
    }
  }
}

TradeRequestPaginationAndSorting: object

offSet:
Int
perPage:
Int
sortDesc:
sortField:
Example
{
  "offSet": "number",
  "perPage": "number",
  "sortDesc": "boolean",
  "sortField": "string"
}

TradeRequestQueryFilter: object

accountId:
bulkTradeRunId:
financialProductId:
state:
type:
Example
{
  "accountId": "object",
  "bulkTradeRunId": "object",
  "financialProductId": "object",
  "state": "string",
  "type": "string"
}

TradeRequestStates: string

object
CANCELED
object
INITIATED
object
READY
object
RECONCILED
object
REQUESTED

TradeRequestTypes: string

object
BUY
object
SELL

TradeStates: string

object
CANCELED
object
FAILED
object
INITIATED
object
PROCESSING
object
RECONCILED

TradeTransition: string

object
cancel
object
cancelReconciled
object
fail
object
forceCancel
object
process
object
reconcile

TradeType: string

object
BUY
object
SELL

Transaction: object

account:
object
return:
arguments:
object
bookValueCents:
object
return:
arguments:
object
currency:
object
return:
arguments:
object
date:
object
return:
arguments:
object
description:
object
return:
arguments:
object
endOfDayPriceCents:
object

The DEPOSIT_BUY and EXTERNAL_TRANSFER_IN_SECURITY transaction types use the endOfDayPriceCents to calculate the valueCents as the priceCents in this case is the book cost (ACB/unit). This value will be automatically set based on the security price snapshots.

return:
arguments:
object
financialProduct:
object
return:
arguments:
object
fiscalDate:
object
return:
arguments:
object
goal:
object
return:
arguments:
object
id:
object
return:
arguments:
object
objectId:
object
return:
arguments:
object
objectType:
object
return:
arguments:
object
organization:
object
return:
arguments:
object
priceCents:
object
return:
arguments:
object
quantity:
object
return:
arguments:
object
requestId:
object
return:
arguments:
object
settleDate:
object
return:
arguments:
object
settleDateToWithdraw:
object
return:
arguments:
object
subAccount:
object
return:
arguments:
object
type:
object
return:
arguments:
object
user:
object
return:
arguments:
object
valueCents:
object
return:
arguments:
object
Example
{
  "account": {
    "return": {
      "affiliations": {
        "return": [
          {
            "allocation": {
              "return": "number",
              "arguments": {}
            },
            "id": {
              "return": "object",
              "arguments": {}
            },
            "relation": {
              "return": "string",
              "arguments": {}
            },
            "signatureRequired": {
              "return": "boolean",
              "arguments": {}
            },
            "type": {
              "return": "string",
              "arguments": {}
            },
            "user": {
              "return": {
                "accessibleBy": {
                  "return": [
                    {
                      "displayOptions": {
                        "return": {
                          "hide": {
                            "return": "boolean",
                            "arguments": {}
                          },
                          "order": {
                            "return": "number",
                            "arguments": {}
                          }
                        },
                        "arguments": {}
                      },
                      "organizationUser": {
                        "return": {
                          "accessType": {
                            "return": "string",
                            "arguments": {}
                          },
                          "apiTokens": {
                            "return": [
                              {
                                "id": {
                                  "return": "object",
                                  "arguments": {}
                                },
                                "jwtToken": {
                                  "return": "string",
                                  "arguments": {}
                                },
                                "name": {
                                  "return": "string",
                                  "arguments": {}
                                },
                                "organization": {
                                  "return": {
                                    "browserTabTitle": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "faviconLink": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "id": {
                                      "return": "object",
                                      "arguments": {}
                                    },
                                    "name": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "parent": {
                                      "return": {
                                        "browserTabTitle": {
                                          "return": "string",
                                          "arguments": {}
                                        },
                                        "faviconLink": {
                                          "return": "string",
                                          "arguments": {}
                                        }
                                      }
                                    }
                                  }
                                }
                              }
                            ]
                          }
                        }
                      }
                    }
                  ]
                }
              }
            }
          }
        ]
      }
    }
  }
}

TransactionObjectTypes: string

object
Adjustment
object
BulkImport
object
CustodianActivity
object
SubTrade
object
Transfer

TransactionQueryFilter: object

accountIds:
ObjectID
accountType:
clientGroupId:
currency:
dateAfter:
dateBefore:
financialProductIds:
ObjectID
goalIds:
ObjectID
organizationId:
subAccountIds:
ObjectID
types:
TransactionTypes
userId:
userIds:
ObjectID
Example
{
  "accountIds": [
    "object"
  ],
  "accountType": "string",
  "clientGroupId": "object",
  "currency": "string",
  "dateAfter": "object",
  "dateBefore": "object",
  "financialProductIds": [
    "object"
  ],
  "goalIds": [
    "object"
  ],
  "organizationId": "object",
  "subAccountIds": [
    "object"
  ],
  "types": [
    "string"
  ],
  "userId": "object",
  "userIds": [
    "object"
  ]
}

TransactionTypes: string

object
ADJUSTMENT
object
BORROW_FEE
object
BUY
object
CANCEL_BUY
object
CANCEL_CORPORATE_ACTION
object
CANCEL_EFT
object
CANCEL_MANAGEMENT_FEE
object
CANCEL_SELL
object
CANCEL_SWITCH_IN
object
CANCEL_SWITCH_OUT
object
CANCEL_TRANSFER
object
CHEQUE
object
CORPORATE_ACTION
object
CUSTODY_FEE
object
DEPOSIT_BUY
object
DEREGISTRATION_FEE
object
DEREGISTRATION_TAX
object
DISTRIBUTION
object
DISTRIBUTION_REINVESTMENT
object
DIVIDEND
object
EFT
object
EXTERNAL_TRANSFER_IN
object
EXTERNAL_TRANSFER_IN_SECURITY
object
EXTERNAL_TRANSFER_OUT
object
GOV_CONTRIBUTIONS
object
GST
object
HST
object
INCOME_FUND_TRANSFER
object
INTEREST
object
MANAGEMENT_FEE
object
RISK_EXPOSURE_FEE
object
SELL
object
SWITCH_IN
object
SWITCH_OUT
object
SWI_COST
object
SWI_MARKET
object
SWO_COST
object
SWO_MARKET
object
TRANSFER_IN
object
TRANSFER_OUT
object
WITHHOLDING_TAX

Transfer: object

alertReport:
object
return:
arguments:
object
amountCents:
object

Transfer amount in cents.

return:
arguments:
object
bankAccount:
object
return:
arguments:
object
createdAt:
object
return:
arguments:
object
currency:
object
return:
arguments:
object
dividendFor:
object

The financial product the dividend was paid out for

return:
arguments:
object
failReason:
object

Reason why the TransitionTransfer has failed

return:
arguments:
object
fiscalDate:
object
return:
arguments:
object
fromSubAccount:
object

Account that Transfer is processed in.

return:
arguments:
object
id:
object

Auto-generated ID for this Transfer.

return:
arguments:
object
initiatedByRepresentative:
object
return:
arguments:
object
instantInvest:
object

instantInvest skips the holding period before the amount is invested Only available to partners with the certainty of deposits that do not bounce

return:
arguments:
object
isRecurring:
object
return:
arguments:
object
isSuspicious:
object
return:
arguments:
object
isWithdrawAll:
object
return:
arguments:
object
manualProcess:
object
return:
arguments:
object
reconciledAt:
object
return:
arguments:
object
requestId:
object

This an ID created by the partner, that is submitted with an Transfer request and unique to each request.

return:
arguments:
object
source:
object

Source of Transfer.

return:
arguments:
object
sourceId:
object

ID of source if exists

return:
arguments:
object
state:
object

Current Transfer processing step that this request is at.

return:
arguments:
object
stateChanges:
object
return:
StateChanges
arguments:
object
subAccount:
object

Account that Transfer is processed in.

return:
arguments:
object
type:
object

Type of Transfer request. DEPOSIT: depositTransfer WITHDRAW: withdrawTransfer

return:
arguments:
object
withdrawalMode:
object
return:
arguments:
object
withdrawalReason:
object

Withdrawal Reasons

return:
arguments:
object
withdrawalReasonDescription:
object
return:
arguments:
object
Example
{
  "alertReport": {
    "return": {
      "id": {
        "return": "object",
        "arguments": {}
      },
      "reason": {
        "return": "string",
        "arguments": {}
      },
      "rules": {
        "return": [
          {
            "id": {
              "return": "object",
              "arguments": {}
            },
            "translatedDescription": {
              "return": {
                "en": {
                  "return": "string",
                  "arguments": {}
                },
                "fr": {
                  "return": "string",
                  "arguments": {}
                }
              },
              "arguments": {}
            },
            "type": {
              "return": "string",
              "arguments": {}
            }
          }
        ],
        "arguments": {}
      },
      "state": {
        "return": "string",
        "arguments": {}
      },
      "transfer": {
        "return": {
          "alertReport": {
            "return": {
              "id": {
                "return": "object",
                "arguments": {}
              },
              "reason": {
                "return": "string",
                "arguments": {}
              },
              "rules": {
                "return": [
                  {
                    "id": {
                      "return": "object",
                      "arguments": {}
                    },
                    "translatedDescription": {
                      "return": {
                        "en": {
                          "return": "string",
                          "arguments": {}
                        },
                        "fr": {
                          "return": "string",
                          "arguments": {}
                        }
                      },
                      "arguments": {}
                    },
                    "type": {
                      "return": "string",
                      "arguments": {}
                    }
                  }
                ],
                "arguments": {}
              },
              "state": {
                "return": "string",
                "arguments": {}
              },
              "transfer": {
                "return": {
                  "alertReport": {
                    "return": {
                      "id": {
                        "return": "object",
                        "arguments": {}
                      },
                      "reason": {
                        "return": "string",
                        "arguments": {}
                      },
                      "rules": {
                        "return": [
                          null
                        ]
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

TransferAllBetweenSubAccountsInput: object

fromSubAccountId:
requestId:
toSubAccountId:
Example
{
  "fromSubAccountId": "object",
  "requestId": "object",
  "toSubAccountId": "object"
}

TransferAllBetweenSubAccountsResponse: object

transfer:
object
return:
arguments:
object
Example
{
  "transfer": {
    "return": {
      "alertReport": {
        "return": {
          "id": {
            "return": "object",
            "arguments": {}
          },
          "reason": {
            "return": "string",
            "arguments": {}
          },
          "rules": {
            "return": [
              {
                "id": {
                  "return": "object",
                  "arguments": {}
                },
                "translatedDescription": {
                  "return": {
                    "en": {
                      "return": "string",
                      "arguments": {}
                    },
                    "fr": {
                      "return": "string",
                      "arguments": {}
                    }
                  },
                  "arguments": {}
                },
                "type": {
                  "return": "string",
                  "arguments": {}
                }
              }
            ],
            "arguments": {}
          },
          "state": {
            "return": "string",
            "arguments": {}
          },
          "transfer": {
            "return": {
              "alertReport": {
                "return": {
                  "id": {
                    "return": "object",
                    "arguments": {}
                  },
                  "reason": {
                    "return": "string",
                    "arguments": {}
                  },
                  "rules": {
                    "return": [
                      {
                        "id": {
                          "return": "object",
                          "arguments": {}
                        },
                        "translatedDescription": {
                          "return": {
                            "en": {
                              "return": "string",
                              "arguments": {}
                            },
                            "fr": {
                              "return": "string",
                              "arguments": {}
                            }
                          },
                          "arguments": {}
                        },
                        "type": {
                          "return": "string",
                          "arguments": {}
                        }
                      }
                    ],
                    "arguments": {}
                  },
                  "state": {
                    "return": "string",
                    "arguments": {}
                  },
                  "transfer": {
                    "return": {
                      "alertReport": {
                        "return": {
                          "id": {
                            "return": "object",
                            "arguments": {}
                          },
                          "reason": {
                            "return": "string"
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

TransferBetweenSubAccountsInput: object

amountCents:
fromSubAccountId:
requestId:
toSubAccountId:
Example
{
  "amountCents": "object",
  "fromSubAccountId": "object",
  "requestId": "object",
  "toSubAccountId": "object"
}

TransferBetweenSubAccountsResponse: object

transfer:
object
return:
arguments:
object
Example
{
  "transfer": {
    "return": {
      "alertReport": {
        "return": {
          "id": {
            "return": "object",
            "arguments": {}
          },
          "reason": {
            "return": "string",
            "arguments": {}
          },
          "rules": {
            "return": [
              {
                "id": {
                  "return": "object",
                  "arguments": {}
                },
                "translatedDescription": {
                  "return": {
                    "en": {
                      "return": "string",
                      "arguments": {}
                    },
                    "fr": {
                      "return": "string",
                      "arguments": {}
                    }
                  },
                  "arguments": {}
                },
                "type": {
                  "return": "string",
                  "arguments": {}
                }
              }
            ],
            "arguments": {}
          },
          "state": {
            "return": "string",
            "arguments": {}
          },
          "transfer": {
            "return": {
              "alertReport": {
                "return": {
                  "id": {
                    "return": "object",
                    "arguments": {}
                  },
                  "reason": {
                    "return": "string",
                    "arguments": {}
                  },
                  "rules": {
                    "return": [
                      {
                        "id": {
                          "return": "object",
                          "arguments": {}
                        },
                        "translatedDescription": {
                          "return": {
                            "en": {
                              "return": "string",
                              "arguments": {}
                            },
                            "fr": {
                              "return": "string",
                              "arguments": {}
                            }
                          },
                          "arguments": {}
                        },
                        "type": {
                          "return": "string",
                          "arguments": {}
                        }
                      }
                    ],
                    "arguments": {}
                  },
                  "state": {
                    "return": "string",
                    "arguments": {}
                  },
                  "transfer": {
                    "return": {
                      "alertReport": {
                        "return": {
                          "id": {
                            "return": "object",
                            "arguments": {}
                          },
                          "reason": {
                            "return": "string"
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

TransferEquityBetweenSubAccountsInput: object

financialProductId:
fromSubAccountId:
quantity:
toSubAccountId:
Example
{
  "financialProductId": "object",
  "fromSubAccountId": "object",
  "quantity": "number",
  "toSubAccountId": "object"
}

TransferEquityBetweenSubAccountsResponse: object

buy:
object
return:
arguments:
object
deposit:
object
return:
arguments:
object
sell:
object
return:
arguments:
object
withdraw:
object
return:
arguments:
object
Example
{
  "buy": {
    "return": {
      "actualQuantity": {
        "return": "number",
        "arguments": {}
      },
      "actualTradePriceCents": {
        "return": "number",
        "arguments": {}
      },
      "createdAt": {
        "return": "object",
        "arguments": {}
      },
      "expectedQuantity": {
        "return": "number",
        "arguments": {}
      },
      "expectedTradePriceCents": {
        "return": "number",
        "arguments": {}
      },
      "failReason": {
        "return": "string",
        "arguments": {}
      },
      "financialProduct": {
        "return": {
          "assignable": {
            "return": "boolean",
            "arguments": {}
          },
          "autoUpdatePrices": {
            "return": "boolean",
            "arguments": {}
          },
          "children": {
            "return": [
              {
                "financialProduct": {
                  "return": {
                    "assignable": {
                      "return": "boolean",
                      "arguments": {}
                    },
                    "autoUpdatePrices": {
                      "return": "boolean",
                      "arguments": {}
                    },
                    "children": {
                      "return": [
                        {
                          "financialProduct": {
                            "return": {
                              "assignable": {
                                "return": "boolean",
                                "arguments": {}
                              },
                              "autoUpdatePrices": {
                                "return": "boolean",
                                "arguments": {}
                              },
                              "children": {
                                "return": [
                                  {
                                    "financialProduct": {
                                      "return": {
                                        "assignable": {
                                          "return": "boolean",
                                          "arguments": {}
                                        },
                                        "autoUpdatePrices": {
                                          "return": "boolean",
                                          "arguments": {}
                                        },
                                        "children": {
                                          "return": [
                                            {
                                              "financialProduct": {
                                                "return": {
                                                  "assignable": {
                                                    "return": "boolean",
                                                    "arguments": {}
                                                  },
                                                  "autoUpdatePrices": {
                                                    "return": "boolean",
                                                    "arguments": {}
                                                  },
                                                  "children": {}
                                                }
                                              }
                                            }
                                          ]
                                        }
                                      }
                                    }
                                  }
                                ]
                              }
                            }
                          }
                        }
                      ]
                    }
                  }
                }
              }
            ]
          }
        }
      }
    }
  }
}

TransferSources: string

Supported Transfer sources.

object
ADJUSTMENT
object
CHEQUE
object
CUSTODIAN_ACTIVITY
object
DEREGISTRATION
object
DEREGISTRATION_TAX
object
DISTRIBUTION
object
DIVIDEND
object
EXTERNAL_TRANSFER_IN
object
EXTERNAL_TRANSFER_OUT
object
FEE
object
FROM_ACCOUNT
object
FROM_SUB_ACCOUNT
object
GOV_CONTRIBUTIONS
object
INCOME_FUND_TRANSFER
object
TO_ACCOUNT
object
TO_SUB_ACCOUNT
object
USER
object
WITHHOLDING_TAX

TransferState: string

Transfer processing steps.

object
CANCELED
object
FAILED
object
INITIATED
object
PROCESSING
object
READY
object
RECONCILED
object
REQUESTED
object
REVIEWING

TransferTransition: string

object
cancel
object
cancelReconciled
object
fail
object
initiate
object
process
object
ready
object
reconcile
object
request
object
review

TransferType: string

Supported Transfer types.

object
DEPOSIT
object
WITHDRAW

TransferTypes: string

object
DEPOSIT
object
WITHDRAW

TransitionAccountFeeInput: object

accountFeeId:
transition:
Example
{
  "accountFeeId": "object",
  "transition": "string"
}

TransitionAccountFeeResponse: object

accountFee:
object
return:
arguments:
object
Example
{
  "accountFee": {
    "return": {
      "account": {
        "return": {
          "affiliations": {
            "return": [
              {
                "allocation": {
                  "return": "number",
                  "arguments": {}
                },
                "id": {
                  "return": "object",
                  "arguments": {}
                },
                "relation": {
                  "return": "string",
                  "arguments": {}
                },
                "signatureRequired": {
                  "return": "boolean",
                  "arguments": {}
                },
                "type": {
                  "return": "string",
                  "arguments": {}
                },
                "user": {
                  "return": {
                    "accessibleBy": {
                      "return": [
                        {
                          "displayOptions": {
                            "return": {
                              "hide": {
                                "return": "boolean",
                                "arguments": {}
                              },
                              "order": {
                                "return": "number",
                                "arguments": {}
                              }
                            },
                            "arguments": {}
                          },
                          "organizationUser": {
                            "return": {
                              "accessType": {
                                "return": "string",
                                "arguments": {}
                              },
                              "apiTokens": {
                                "return": [
                                  {
                                    "id": {
                                      "return": "object",
                                      "arguments": {}
                                    },
                                    "jwtToken": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "name": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "organization": {
                                      "return": {
                                        "browserTabTitle": {
                                          "return": "string",
                                          "arguments": {}
                                        },
                                        "faviconLink": {
                                          "return": "string",
                                          "arguments": {}
                                        },
                                        "id": {
                                          "return": "object",
                                          "arguments": {}
                                        },
                                        "name": {
                                          "return": "string",
                                          "arguments": {}
                                        },
                                        "parent": {
                                          "return": {
                                            "browserTabTitle": {
                                              "return": "string",
                                              "arguments": {}
                                            },
                                            "faviconLink": {}
                                          }
                                        }
                                      }
                                    }
                                  }
                                ]
                              }
                            }
                          }
                        }
                      ]
                    }
                  }
                }
              }
            ]
          }
        }
      }
    }
  }
}

TransitionAccountInput: object

accountId:
lastUpdatedBy:
transition:
Example
{
  "accountId": "object",
  "lastUpdatedBy": "object",
  "transition": "string"
}

TransitionAccountResponse: object

account:
object
return:
arguments:
object
Example
{
  "account": {
    "return": {
      "affiliations": {
        "return": [
          {
            "allocation": {
              "return": "number",
              "arguments": {}
            },
            "id": {
              "return": "object",
              "arguments": {}
            },
            "relation": {
              "return": "string",
              "arguments": {}
            },
            "signatureRequired": {
              "return": "boolean",
              "arguments": {}
            },
            "type": {
              "return": "string",
              "arguments": {}
            },
            "user": {
              "return": {
                "accessibleBy": {
                  "return": [
                    {
                      "displayOptions": {
                        "return": {
                          "hide": {
                            "return": "boolean",
                            "arguments": {}
                          },
                          "order": {
                            "return": "number",
                            "arguments": {}
                          }
                        },
                        "arguments": {}
                      },
                      "organizationUser": {
                        "return": {
                          "accessType": {
                            "return": "string",
                            "arguments": {}
                          },
                          "apiTokens": {
                            "return": [
                              {
                                "id": {
                                  "return": "object",
                                  "arguments": {}
                                },
                                "jwtToken": {
                                  "return": "string",
                                  "arguments": {}
                                },
                                "name": {
                                  "return": "string",
                                  "arguments": {}
                                },
                                "organization": {
                                  "return": {
                                    "browserTabTitle": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "faviconLink": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "id": {
                                      "return": "object",
                                      "arguments": {}
                                    },
                                    "name": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "parent": {
                                      "return": {
                                        "browserTabTitle": {
                                          "return": "string",
                                          "arguments": {}
                                        },
                                        "faviconLink": {
                                          "return": "string",
                                          "arguments": {}
                                        }
                                      }
                                    }
                                  }
                                }
                              }
                            ]
                          }
                        }
                      }
                    }
                  ]
                }
              }
            }
          }
        ]
      }
    }
  }
}

TransitionAccountStatementInput: object

accountStatementId:
transition:
Example
{
  "accountStatementId": "object",
  "transition": "string"
}

TransitionAccountStatementResponse: object

accountStatement:
object
return:
arguments:
object
Example
{
  "accountStatement": {
    "return": {
      "account": {
        "return": {
          "affiliations": {
            "return": [
              {
                "allocation": {
                  "return": "number",
                  "arguments": {}
                },
                "id": {
                  "return": "object",
                  "arguments": {}
                },
                "relation": {
                  "return": "string",
                  "arguments": {}
                },
                "signatureRequired": {
                  "return": "boolean",
                  "arguments": {}
                },
                "type": {
                  "return": "string",
                  "arguments": {}
                },
                "user": {
                  "return": {
                    "accessibleBy": {
                      "return": [
                        {
                          "displayOptions": {
                            "return": {
                              "hide": {
                                "return": "boolean",
                                "arguments": {}
                              },
                              "order": {
                                "return": "number",
                                "arguments": {}
                              }
                            },
                            "arguments": {}
                          },
                          "organizationUser": {
                            "return": {
                              "accessType": {
                                "return": "string",
                                "arguments": {}
                              },
                              "apiTokens": {
                                "return": [
                                  {
                                    "id": {
                                      "return": "object",
                                      "arguments": {}
                                    },
                                    "jwtToken": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "name": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "organization": {
                                      "return": {
                                        "browserTabTitle": {
                                          "return": "string",
                                          "arguments": {}
                                        },
                                        "faviconLink": {
                                          "return": "string",
                                          "arguments": {}
                                        },
                                        "id": {
                                          "return": "object",
                                          "arguments": {}
                                        },
                                        "name": {
                                          "return": "string",
                                          "arguments": {}
                                        },
                                        "parent": {
                                          "return": {
                                            "browserTabTitle": {
                                              "return": "string",
                                              "arguments": {}
                                            },
                                            "faviconLink": {}
                                          }
                                        }
                                      }
                                    }
                                  }
                                ]
                              }
                            }
                          }
                        }
                      ]
                    }
                  }
                }
              }
            ]
          }
        }
      }
    }
  }
}

TransitionApiTokenInput: object

apiTokenId:
transition:
Example
{
  "apiTokenId": "object",
  "transition": "string"
}

TransitionApiTokenResponse: object

apiToken:
object
return:
arguments:
object
Example
{
  "apiToken": {
    "return": {
      "id": {
        "return": "object",
        "arguments": {}
      },
      "jwtToken": {
        "return": "string",
        "arguments": {}
      },
      "name": {
        "return": "string",
        "arguments": {}
      },
      "organization": {
        "return": {
          "browserTabTitle": {
            "return": "string",
            "arguments": {}
          },
          "faviconLink": {
            "return": "string",
            "arguments": {}
          },
          "id": {
            "return": "object",
            "arguments": {}
          },
          "name": {
            "return": "string",
            "arguments": {}
          },
          "parent": {
            "return": {
              "browserTabTitle": {
                "return": "string",
                "arguments": {}
              },
              "faviconLink": {
                "return": "string",
                "arguments": {}
              },
              "id": {
                "return": "object",
                "arguments": {}
              },
              "name": {
                "return": "string",
                "arguments": {}
              },
              "parent": {
                "return": {
                  "browserTabTitle": {
                    "return": "string",
                    "arguments": {}
                  },
                  "faviconLink": {
                    "return": "string",
                    "arguments": {}
                  },
                  "id": {
                    "return": "object",
                    "arguments": {}
                  },
                  "name": {
                    "return": "string",
                    "arguments": {}
                  },
                  "parent": {
                    "return": {
                      "browserTabTitle": {
                        "return": "string",
                        "arguments": {}
                      },
                      "faviconLink": {
                        "return": "string",
                        "arguments": {}
                      },
                      "id": {
                        "return": "object",
                        "arguments": {}
                      },
                      "name": {
                        "return": "string",
                        "arguments": {}
                      },
                      "parent": {
                        "return": {
                          "browserTabTitle": {
                            "return": "string",
                            "arguments": {}
                          },
                          "faviconLink": {}
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

TransitionArticleInput: object

articleId:
transition:
Example
{
  "articleId": "object",
  "transition": "string"
}

TransitionArticleResponse: object

article:
object
return:
arguments:
object
Example
{
  "article": {
    "return": {
      "articleUrl": {
        "return": "object",
        "arguments": {}
      },
      "createdAt": {
        "return": "object",
        "arguments": {}
      },
      "createdBy": {
        "return": {
          "email": {
            "return": "string",
            "arguments": {}
          },
          "firstName": {
            "return": "string",
            "arguments": {}
          },
          "id": {
            "return": "object",
            "arguments": {}
          },
          "language": {
            "return": "string",
            "arguments": {}
          },
          "lastName": {
            "return": "string",
            "arguments": {}
          },
          "organization": {
            "return": {
              "browserTabTitle": {
                "return": "string",
                "arguments": {}
              },
              "faviconLink": {
                "return": "string",
                "arguments": {}
              },
              "id": {
                "return": "object",
                "arguments": {}
              },
              "name": {
                "return": "string",
                "arguments": {}
              },
              "parent": {
                "return": {
                  "browserTabTitle": {
                    "return": "string",
                    "arguments": {}
                  },
                  "faviconLink": {
                    "return": "string",
                    "arguments": {}
                  },
                  "id": {
                    "return": "object",
                    "arguments": {}
                  },
                  "name": {
                    "return": "string",
                    "arguments": {}
                  },
                  "parent": {
                    "return": {
                      "browserTabTitle": {
                        "return": "string",
                        "arguments": {}
                      },
                      "faviconLink": {
                        "return": "string",
                        "arguments": {}
                      },
                      "id": {
                        "return": "object",
                        "arguments": {}
                      },
                      "name": {
                        "return": "string",
                        "arguments": {}
                      },
                      "parent": {
                        "return": {
                          "browserTabTitle": {
                            "return": "string",
                            "arguments": {}
                          },
                          "faviconLink": {}
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

TransitionAssetClassInput: object

assetClassId:
transition:
Example
{
  "assetClassId": "object",
  "transition": "string"
}

TransitionAssetClassResponse: object

assetClass:
object
return:
arguments:
object
Example
{
  "assetClass": {
    "return": {
      "description": {
        "return": "string",
        "arguments": {}
      },
      "id": {
        "return": "object",
        "arguments": {}
      },
      "includeCash": {
        "return": "boolean",
        "arguments": {}
      },
      "key": {
        "return": "string",
        "arguments": {}
      },
      "name": {
        "return": "string",
        "arguments": {}
      },
      "state": {
        "return": "string",
        "arguments": {}
      },
      "translatedDescription": {
        "return": {
          "en": {
            "return": "string",
            "arguments": {}
          },
          "fr": {
            "return": "string",
            "arguments": {}
          }
        },
        "arguments": {}
      },
      "translatedName": {
        "return": {
          "en": {
            "return": "string",
            "arguments": {}
          },
          "fr": {
            "return": "string",
            "arguments": {}
          }
        },
        "arguments": {}
      }
    },
    "arguments": {}
  }
}

TransitionBankAccountInput: object

bankAccountId:
transition:
Example
{
  "bankAccountId": "object",
  "transition": "string"
}

TransitionBankAccountResponse: object

bankAccount:
object
return:
arguments:
object
Example
{
  "bankAccount": {
    "return": {
      "EftEligibleRatio": {
        "return": "number",
        "arguments": {}
      },
      "bankAccountNumber": {
        "return": "string",
        "arguments": {}
      },
      "bankAccountNumberDisclosed": {
        "return": "string",
        "arguments": {}
      },
      "createdAt": {
        "return": "object",
        "arguments": {}
      },
      "downloadUrls": {
        "return": [
          "string"
        ],
        "arguments": {}
      },
      "id": {
        "return": "object",
        "arguments": {}
      },
      "institutionNumber": {
        "return": "string",
        "arguments": {}
      },
      "name": {
        "return": "string",
        "arguments": {}
      },
      "source": {
        "return": "string",
        "arguments": {}
      },
      "state": {
        "return": "string",
        "arguments": {}
      },
      "stateChanges": {
        "return": [
          "object"
        ],
        "arguments": {}
      },
      "transitNumber": {
        "return": "string",
        "arguments": {}
      },
      "transitNumberDisclosed": {
        "return": "string",
        "arguments": {}
      },
      "updatedAt": {
        "return": "object",
        "arguments": {}
      },
      "user": {
        "return": {
          "accessibleBy": {
            "return": [
              {
                "displayOptions": {
                  "return": {
                    "hide": {
                      "return": "boolean",
                      "arguments": {}
                    },
                    "order": {
                      "return": "number",
                      "arguments": {}
                    }
                  },
                  "arguments": {}
                },
                "organizationUser": {
                  "return": {
                    "accessType": {
                      "return": "string",
                      "arguments": {}
                    },
                    "apiTokens": {
                      "return": [
                        {
                          "id": {
                            "return": "object",
                            "arguments": {}
                          },
                          "jwtToken": {
                            "return": "string",
                            "arguments": {}
                          }
                        }
                      ]
                    }
                  }
                }
              }
            ]
          }
        }
      }
    }
  }
}

TransitionBillingCycleInput: object

billingCycleId:
transition:
Example
{
  "billingCycleId": "object",
  "transition": "string"
}

TransitionBillingCycleResponse: object

billingCycle:
object
return:
arguments:
object
Example
{
  "billingCycle": {
    "return": {
      "billingDate": {
        "return": "object",
        "arguments": {}
      },
      "billingSchedule": {
        "return": {
          "createdAt": {
            "return": "object",
            "arguments": {}
          },
          "default": {
            "return": "boolean",
            "arguments": {}
          },
          "endDate": {
            "return": "object",
            "arguments": {}
          },
          "frequency": {
            "return": "string",
            "arguments": {}
          },
          "id": {
            "return": "object",
            "arguments": {}
          },
          "nextBillingDate": {
            "return": "object",
            "arguments": {}
          },
          "nextCalculationDate": {
            "return": "object",
            "arguments": {}
          },
          "organization": {
            "return": {
              "browserTabTitle": {
                "return": "string",
                "arguments": {}
              },
              "faviconLink": {
                "return": "string",
                "arguments": {}
              },
              "id": {
                "return": "object",
                "arguments": {}
              },
              "name": {
                "return": "string",
                "arguments": {}
              },
              "parent": {
                "return": {
                  "browserTabTitle": {
                    "return": "string",
                    "arguments": {}
                  },
                  "faviconLink": {
                    "return": "string",
                    "arguments": {}
                  },
                  "id": {
                    "return": "object",
                    "arguments": {}
                  },
                  "name": {
                    "return": "string",
                    "arguments": {}
                  },
                  "parent": {
                    "return": {
                      "browserTabTitle": {
                        "return": "string",
                        "arguments": {}
                      },
                      "faviconLink": {
                        "return": "string",
                        "arguments": {}
                      },
                      "id": {
                        "return": "object",
                        "arguments": {}
                      },
                      "name": {
                        "return": "string",
                        "arguments": {}
                      },
                      "parent": {
                        "return": {
                          "browserTabTitle": {}
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

TransitionBillingScheduleInput: object

billingScheduleId:
transition:
Example
{
  "billingScheduleId": "object",
  "transition": "string"
}

TransitionBillingScheduleResponse: object

billingSchedule:
object
return:
arguments:
object
Example
{
  "billingSchedule": {
    "return": {
      "createdAt": {
        "return": "object",
        "arguments": {}
      },
      "default": {
        "return": "boolean",
        "arguments": {}
      },
      "endDate": {
        "return": "object",
        "arguments": {}
      },
      "frequency": {
        "return": "string",
        "arguments": {}
      },
      "id": {
        "return": "object",
        "arguments": {}
      },
      "nextBillingDate": {
        "return": "object",
        "arguments": {}
      },
      "nextCalculationDate": {
        "return": "object",
        "arguments": {}
      },
      "organization": {
        "return": {
          "browserTabTitle": {
            "return": "string",
            "arguments": {}
          },
          "faviconLink": {
            "return": "string",
            "arguments": {}
          },
          "id": {
            "return": "object",
            "arguments": {}
          },
          "name": {
            "return": "string",
            "arguments": {}
          },
          "parent": {
            "return": {
              "browserTabTitle": {
                "return": "string",
                "arguments": {}
              },
              "faviconLink": {
                "return": "string",
                "arguments": {}
              },
              "id": {
                "return": "object",
                "arguments": {}
              },
              "name": {
                "return": "string",
                "arguments": {}
              },
              "parent": {
                "return": {
                  "browserTabTitle": {
                    "return": "string",
                    "arguments": {}
                  },
                  "faviconLink": {
                    "return": "string",
                    "arguments": {}
                  },
                  "id": {
                    "return": "object",
                    "arguments": {}
                  },
                  "name": {
                    "return": "string",
                    "arguments": {}
                  },
                  "parent": {
                    "return": {
                      "browserTabTitle": {
                        "return": "string",
                        "arguments": {}
                      },
                      "faviconLink": {
                        "return": "string",
                        "arguments": {}
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

TransitionBulkImportInput: object

bulkImportId:
sync:
transition:
Example
{
  "bulkImportId": "object",
  "sync": "boolean",
  "transition": "string"
}

TransitionBulkImportResponse: object

bulkImport:
object
return:
arguments:
object
Example
{
  "bulkImport": {
    "return": {
      "createdAt": {
        "return": "object",
        "arguments": {}
      },
      "id": {
        "return": "object",
        "arguments": {}
      },
      "name": {
        "return": "string",
        "arguments": {}
      },
      "organization": {
        "return": {
          "browserTabTitle": {
            "return": "string",
            "arguments": {}
          },
          "faviconLink": {
            "return": "string",
            "arguments": {}
          },
          "id": {
            "return": "object",
            "arguments": {}
          },
          "name": {
            "return": "string",
            "arguments": {}
          },
          "parent": {
            "return": {
              "browserTabTitle": {
                "return": "string",
                "arguments": {}
              },
              "faviconLink": {
                "return": "string",
                "arguments": {}
              },
              "id": {
                "return": "object",
                "arguments": {}
              },
              "name": {
                "return": "string",
                "arguments": {}
              },
              "parent": {
                "return": {
                  "browserTabTitle": {
                    "return": "string",
                    "arguments": {}
                  },
                  "faviconLink": {
                    "return": "string",
                    "arguments": {}
                  },
                  "id": {
                    "return": "object",
                    "arguments": {}
                  },
                  "name": {
                    "return": "string",
                    "arguments": {}
                  },
                  "parent": {
                    "return": {
                      "browserTabTitle": {
                        "return": "string",
                        "arguments": {}
                      },
                      "faviconLink": {
                        "return": "string",
                        "arguments": {}
                      },
                      "id": {
                        "return": "object",
                        "arguments": {}
                      },
                      "name": {
                        "return": "string",
                        "arguments": {}
                      },
                      "parent": {
                        "return": {
                          "browserTabTitle": {
                            "return": "string",
                            "arguments": {}
                          },
                          "faviconLink": {}
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

TransitionBulkTradeRequestInput: object

bulkTradeRequestId:
transition:
Example
{
  "bulkTradeRequestId": "object",
  "transition": "string"
}

TransitionBulkTradeRequestResponse: object

bulkTradeRequest:
object
return:
arguments:
object
Example
{
  "bulkTradeRequest": {
    "return": {
      "createdAt": {
        "return": "object",
        "arguments": {}
      },
      "id": {
        "return": "object",
        "arguments": {}
      },
      "source": {
        "return": "string",
        "arguments": {}
      },
      "sourceId": {
        "return": "object",
        "arguments": {}
      },
      "state": {
        "return": "string",
        "arguments": {}
      },
      "stateChanges": {
        "return": [
          "object"
        ],
        "arguments": {}
      },
      "updatedAt": {
        "return": "object",
        "arguments": {}
      }
    },
    "arguments": {}
  }
}

TransitionBulkTradeRunInput: object

bulkTradeRunId:
transition:
Example
{
  "bulkTradeRunId": "object",
  "transition": "string"
}

TransitionBulkTradeRunResponse: object

bulkTradeRun:
object
return:
arguments:
object
Example
{
  "bulkTradeRun": {
    "return": {
      "allTradeRequestsByExchange": {
        "return": [
          {
            "exchange": {
              "return": "string",
              "arguments": {}
            },
            "total": {
              "return": "number",
              "arguments": {}
            }
          }
        ],
        "arguments": {}
      },
      "allocationFileUrls": {
        "return": [
          "string"
        ],
        "arguments": {}
      },
      "autoFillActualQuantity": {
        "return": "boolean",
        "arguments": {}
      },
      "bulkMutualFundTrades": {
        "return": [
          {
            "currency": {
              "return": "string",
              "arguments": {}
            },
            "exchange": {
              "return": "string",
              "arguments": {}
            },
            "id": {
              "return": "object",
              "arguments": {}
            },
            "moneyAllocatedCents": {
              "return": "number",
              "arguments": {}
            },
            "ticker": {
              "return": "string",
              "arguments": {}
            },
            "type": {
              "return": "string",
              "arguments": {}
            }
          }
        ],
        "arguments": {}
      },
      "bulkPTFFileUrls": {
        "return": [
          "string"
        ],
        "arguments": {}
      },
      "bulkTradeRequests": {
        "return": [
          {
            "bulkTrades": {
              "return": [
                {
                  "_id": {
                    "return": "string",
                    "arguments": {}
                  },
                  "actualTotal": {
                    "return": "number",
                    "arguments": {}
                  },
                  "actualTradePriceCents": {
                    "return": "number",
                    "arguments": {}
                  },
                  "actualTradePriceInCurrencyCents": {
                    "return": "number",
                    "arguments": {}
                  },
                  "currency": {
                    "return": "string",
                    "arguments": {}
                  },
                  "exchange": {
                    "return": "string",
                    "arguments": {}
                  },
                  "expectedTradePriceCents": {
                    "return": "number",
                    "arguments": {}
                  },
                  "expectedTradePriceInCurrencyCents": {
                    "return": "number",
                    "arguments": {}
                  }
                }
              ]
            }
          }
        ]
      }
    }
  }
}

TransitionClientGroupInput: object

clientGroupId:
transition:
Example
{
  "clientGroupId": "object",
  "transition": "string"
}

TransitionClientGroupResponse: object

clientGroup:
object
return:
arguments:
object
Example
{
  "clientGroup": {
    "return": {
      "accountNumber": {
        "return": "string",
        "arguments": {}
      },
      "accounts": {
        "return": [
          {
            "affiliations": {
              "return": [
                {
                  "allocation": {
                    "return": "number",
                    "arguments": {}
                  },
                  "id": {
                    "return": "object",
                    "arguments": {}
                  },
                  "relation": {
                    "return": "string",
                    "arguments": {}
                  },
                  "signatureRequired": {
                    "return": "boolean",
                    "arguments": {}
                  },
                  "type": {
                    "return": "string",
                    "arguments": {}
                  },
                  "user": {
                    "return": {
                      "accessibleBy": {
                        "return": [
                          {
                            "displayOptions": {
                              "return": {
                                "hide": {
                                  "return": "boolean",
                                  "arguments": {}
                                },
                                "order": {
                                  "return": "number",
                                  "arguments": {}
                                }
                              },
                              "arguments": {}
                            },
                            "organizationUser": {
                              "return": {
                                "accessType": {
                                  "return": "string",
                                  "arguments": {}
                                },
                                "apiTokens": {
                                  "return": [
                                    {
                                      "id": {
                                        "return": "object",
                                        "arguments": {}
                                      },
                                      "jwtToken": {
                                        "return": "string",
                                        "arguments": {}
                                      },
                                      "name": {
                                        "return": "string",
                                        "arguments": {}
                                      },
                                      "organization": {
                                        "return": {
                                          "browserTabTitle": {
                                            "return": "string",
                                            "arguments": {}
                                          },
                                          "faviconLink": {
                                            "return": "string",
                                            "arguments": {}
                                          },
                                          "id": {
                                            "return": "object",
                                            "arguments": {}
                                          },
                                          "name": {
                                            "return": "string",
                                            "arguments": {}
                                          },
                                          "parent": {
                                            "return": {}
                                          }
                                        }
                                      }
                                    }
                                  ]
                                }
                              }
                            }
                          }
                        ]
                      }
                    }
                  }
                }
              ]
            }
          }
        ]
      }
    }
  }
}

TransitionCustomFieldInput: object

customFieldId:
transition:
Example
{
  "customFieldId": "object",
  "transition": "string"
}

TransitionCustomFieldResponse: object

customField:
object
return:
arguments:
object
Example
{
  "customField": {
    "return": {
      "conditionalRules": {
        "return": [
          {
            "comparison": {
              "return": "string",
              "arguments": {}
            },
            "field": {
              "return": "string",
              "arguments": {}
            },
            "value": {
              "return": "string",
              "arguments": {}
            }
          }
        ],
        "arguments": {}
      },
      "externalField": {
        "return": "string",
        "arguments": {}
      },
      "format": {
        "return": "string",
        "arguments": {}
      },
      "id": {
        "return": "object",
        "arguments": {}
      },
      "key": {
        "return": "string",
        "arguments": {}
      },
      "objectType": {
        "return": "string",
        "arguments": {}
      },
      "organization": {
        "return": {
          "browserTabTitle": {
            "return": "string",
            "arguments": {}
          },
          "faviconLink": {
            "return": "string",
            "arguments": {}
          },
          "id": {
            "return": "object",
            "arguments": {}
          },
          "name": {
            "return": "string",
            "arguments": {}
          },
          "parent": {
            "return": {
              "browserTabTitle": {
                "return": "string",
                "arguments": {}
              },
              "faviconLink": {
                "return": "string",
                "arguments": {}
              },
              "id": {
                "return": "object",
                "arguments": {}
              },
              "name": {
                "return": "string",
                "arguments": {}
              },
              "parent": {
                "return": {
                  "browserTabTitle": {
                    "return": "string",
                    "arguments": {}
                  },
                  "faviconLink": {
                    "return": "string",
                    "arguments": {}
                  },
                  "id": {
                    "return": "object",
                    "arguments": {}
                  },
                  "name": {
                    "return": "string",
                    "arguments": {}
                  },
                  "parent": {}
                }
              }
            }
          }
        }
      }
    }
  }
}

TransitionFeeTierInput: object

feeTierId:
transition:
Example
{
  "feeTierId": "object",
  "transition": "string"
}

TransitionFeeTierResponse: object

feeTier:
object
return:
arguments:
object
Example
{
  "feeTier": {
    "return": {
      "blendedGrid": {
        "return": "boolean",
        "arguments": {}
      },
      "chargeForCash": {
        "return": "boolean",
        "arguments": {}
      },
      "chargeForCashOnHold": {
        "return": "boolean",
        "arguments": {}
      },
      "createdAt": {
        "return": "object",
        "arguments": {}
      },
      "default": {
        "return": "boolean",
        "arguments": {}
      },
      "discountPercentage": {
        "return": "number",
        "arguments": {}
      },
      "flatAnnualFeeBps": {
        "return": "number",
        "arguments": {}
      },
      "grid": {
        "return": [
          {
            "annualFeeBps": {
              "return": "number",
              "arguments": {}
            },
            "annualFeeCents": {
              "return": "object",
              "arguments": {}
            },
            "minMarketValueCents": {
              "return": "object",
              "arguments": {}
            }
          }
        ],
        "arguments": {}
      },
      "gridScopeType": {
        "return": "string",
        "arguments": {}
      },
      "id": {
        "return": "object",
        "arguments": {}
      },
      "name": {
        "return": "string",
        "arguments": {}
      },
      "organization": {
        "return": {
          "browserTabTitle": {
            "return": "string",
            "arguments": {}
          },
          "faviconLink": {
            "return": "string",
            "arguments": {}
          },
          "id": {
            "return": "object",
            "arguments": {}
          },
          "name": {
            "return": "string",
            "arguments": {}
          },
          "parent": {
            "return": {
              "browserTabTitle": {
                "return": "string",
                "arguments": {}
              },
              "faviconLink": {
                "return": "string",
                "arguments": {}
              },
              "id": {
                "return": "object",
                "arguments": {}
              },
              "name": {
                "return": "string",
                "arguments": {}
              },
              "parent": {}
            }
          }
        }
      }
    }
  }
}

TransitionFinancialProductInput: object

financialProductId:
transition:
Example
{
  "financialProductId": "object",
  "transition": "string"
}

TransitionFinancialProductResponse: object

financialProduct:
object
return:
arguments:
object
Example
{
  "financialProduct": {
    "return": {
      "assignable": {
        "return": "boolean",
        "arguments": {}
      },
      "autoUpdatePrices": {
        "return": "boolean",
        "arguments": {}
      },
      "children": {
        "return": [
          {
            "financialProduct": {
              "return": {
                "assignable": {
                  "return": "boolean",
                  "arguments": {}
                },
                "autoUpdatePrices": {
                  "return": "boolean",
                  "arguments": {}
                },
                "children": {
                  "return": [
                    {
                      "financialProduct": {
                        "return": {
                          "assignable": {
                            "return": "boolean",
                            "arguments": {}
                          },
                          "autoUpdatePrices": {
                            "return": "boolean",
                            "arguments": {}
                          },
                          "children": {
                            "return": [
                              {
                                "financialProduct": {
                                  "return": {
                                    "assignable": {
                                      "return": "boolean",
                                      "arguments": {}
                                    },
                                    "autoUpdatePrices": {
                                      "return": "boolean",
                                      "arguments": {}
                                    },
                                    "children": {
                                      "return": [
                                        {
                                          "financialProduct": {
                                            "return": {
                                              "assignable": {
                                                "return": "boolean",
                                                "arguments": {}
                                              },
                                              "autoUpdatePrices": {
                                                "return": "boolean",
                                                "arguments": {}
                                              },
                                              "children": {
                                                "return": [
                                                  {
                                                    "financialProduct": {
                                                      "return": {
                                                        "assignable": {
                                                          "return": "boolean",
                                                          "arguments": {}
                                                        },
                                                        "autoUpdatePrices": {
                                                          "return": "boolean",
                                                          "arguments": {}
                                                        },
                                                        "children": {
                                                          "return": [
                                                            {
                                                              "financialProduct": {
                                                                "return": {
                                                                  "assignable": {
                                                                    "return": "boolean",
                                                                    "arguments": {}
                                                                  },
                                                                  "autoUpdatePrices": {}
                                                                }
                                                              }
                                                            }
                                                          ]
                                                        }
                                                      }
                                                    }
                                                  }
                                                ]
                                              }
                                            }
                                          }
                                        }
                                      ]
                                    }
                                  }
                                }
                              }
                            ]
                          }
                        }
                      }
                    }
                  ]
                }
              }
            }
          }
        ]
      }
    }
  }
}

TransitionFlagInput: object

flagId:
transition:
Example
{
  "flagId": "object",
  "transition": "string"
}

TransitionFlagResponse: object

flag:
object
return:
arguments:
object
Example
{
  "flag": {
    "return": {
      "account": {
        "return": {
          "affiliations": {
            "return": [
              {
                "allocation": {
                  "return": "number",
                  "arguments": {}
                },
                "id": {
                  "return": "object",
                  "arguments": {}
                },
                "relation": {
                  "return": "string",
                  "arguments": {}
                },
                "signatureRequired": {
                  "return": "boolean",
                  "arguments": {}
                },
                "type": {
                  "return": "string",
                  "arguments": {}
                },
                "user": {
                  "return": {
                    "accessibleBy": {
                      "return": [
                        {
                          "displayOptions": {
                            "return": {
                              "hide": {
                                "return": "boolean",
                                "arguments": {}
                              },
                              "order": {
                                "return": "number",
                                "arguments": {}
                              }
                            },
                            "arguments": {}
                          },
                          "organizationUser": {
                            "return": {
                              "accessType": {
                                "return": "string",
                                "arguments": {}
                              },
                              "apiTokens": {
                                "return": [
                                  {
                                    "id": {
                                      "return": "object",
                                      "arguments": {}
                                    },
                                    "jwtToken": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "name": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "organization": {
                                      "return": {
                                        "browserTabTitle": {
                                          "return": "string",
                                          "arguments": {}
                                        },
                                        "faviconLink": {
                                          "return": "string",
                                          "arguments": {}
                                        },
                                        "id": {
                                          "return": "object",
                                          "arguments": {}
                                        },
                                        "name": {
                                          "return": "string",
                                          "arguments": {}
                                        },
                                        "parent": {
                                          "return": {
                                            "browserTabTitle": {
                                              "return": "string",
                                              "arguments": {}
                                            },
                                            "faviconLink": {}
                                          }
                                        }
                                      }
                                    }
                                  }
                                ]
                              }
                            }
                          }
                        }
                      ]
                    }
                  }
                }
              }
            ]
          }
        }
      }
    }
  }
}

TransitionImportFileInput: object

importFileId:
sync:
transition:
Example
{
  "importFileId": "object",
  "sync": "boolean",
  "transition": "string"
}

TransitionImportFileResponse: object

importFile:
object
return:
arguments:
object
Example
{
  "importFile": {
    "return": {
      "bulkImport": {
        "return": {
          "createdAt": {
            "return": "object",
            "arguments": {}
          },
          "id": {
            "return": "object",
            "arguments": {}
          },
          "name": {
            "return": "string",
            "arguments": {}
          },
          "organization": {
            "return": {
              "browserTabTitle": {
                "return": "string",
                "arguments": {}
              },
              "faviconLink": {
                "return": "string",
                "arguments": {}
              },
              "id": {
                "return": "object",
                "arguments": {}
              },
              "name": {
                "return": "string",
                "arguments": {}
              },
              "parent": {
                "return": {
                  "browserTabTitle": {
                    "return": "string",
                    "arguments": {}
                  },
                  "faviconLink": {
                    "return": "string",
                    "arguments": {}
                  },
                  "id": {
                    "return": "object",
                    "arguments": {}
                  },
                  "name": {
                    "return": "string",
                    "arguments": {}
                  },
                  "parent": {
                    "return": {
                      "browserTabTitle": {
                        "return": "string",
                        "arguments": {}
                      },
                      "faviconLink": {
                        "return": "string",
                        "arguments": {}
                      },
                      "id": {
                        "return": "object",
                        "arguments": {}
                      },
                      "name": {
                        "return": "string",
                        "arguments": {}
                      },
                      "parent": {
                        "return": {
                          "browserTabTitle": {
                            "return": "string",
                            "arguments": {}
                          },
                          "faviconLink": {
                            "return": "string",
                            "arguments": {}
                          },
                          "id": {
                            "return": "object",
                            "arguments": {}
                          },
                          "name": {
                            "return": "string",
                            "arguments": {}
                          },
                          "parent": {
                            "return": {
                              "browserTabTitle": {}
                            }
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

TransitionInstitutionInput: object

institutionId:
transition:
Example
{
  "institutionId": "object",
  "transition": "string"
}

TransitionInstitutionResponse: object

institution:
object
return:
arguments:
object
Example
{
  "institution": {
    "return": {
      "createdAt": {
        "return": "object",
        "arguments": {}
      },
      "id": {
        "return": "object",
        "arguments": {}
      },
      "isDraft": {
        "return": "string",
        "arguments": {}
      },
      "name": {
        "return": "string",
        "arguments": {}
      },
      "physicalAddress": {
        "return": {
          "city": {
            "return": "string",
            "arguments": {}
          },
          "country": {
            "return": "string",
            "arguments": {}
          },
          "houseNumber": {
            "return": "string",
            "arguments": {}
          },
          "jurisdiction": {
            "return": "string",
            "arguments": {}
          },
          "neighborhood": {
            "return": "string",
            "arguments": {}
          },
          "postal": {
            "return": "string",
            "arguments": {}
          },
          "province": {
            "return": "string",
            "arguments": {}
          },
          "streetName": {
            "return": "string",
            "arguments": {}
          },
          "unitNumber": {
            "return": "string",
            "arguments": {}
          }
        },
        "arguments": {}
      },
      "state": {
        "return": "string",
        "arguments": {}
      },
      "stateChanges": {
        "return": [
          "object"
        ],
        "arguments": {}
      },
      "updatedAt": {
        "return": "object",
        "arguments": {}
      }
    },
    "arguments": {}
  }
}

TransitionIntegrationInput: object

integrationId:
transition:
Example
{
  "integrationId": "object",
  "transition": "string"
}

TransitionIntegrationResponse: object

integration:
object
return:
arguments:
object
Example
{
  "integration": {
    "return": {
      "configuration": {
        "return": "object",
        "arguments": {}
      },
      "id": {
        "return": "object",
        "arguments": {}
      },
      "organization": {
        "return": {
          "browserTabTitle": {
            "return": "string",
            "arguments": {}
          },
          "faviconLink": {
            "return": "string",
            "arguments": {}
          },
          "id": {
            "return": "object",
            "arguments": {}
          },
          "name": {
            "return": "string",
            "arguments": {}
          },
          "parent": {
            "return": {
              "browserTabTitle": {
                "return": "string",
                "arguments": {}
              },
              "faviconLink": {
                "return": "string",
                "arguments": {}
              },
              "id": {
                "return": "object",
                "arguments": {}
              },
              "name": {
                "return": "string",
                "arguments": {}
              },
              "parent": {
                "return": {
                  "browserTabTitle": {
                    "return": "string",
                    "arguments": {}
                  },
                  "faviconLink": {
                    "return": "string",
                    "arguments": {}
                  },
                  "id": {
                    "return": "object",
                    "arguments": {}
                  },
                  "name": {
                    "return": "string",
                    "arguments": {}
                  },
                  "parent": {
                    "return": {
                      "browserTabTitle": {
                        "return": "string",
                        "arguments": {}
                      },
                      "faviconLink": {
                        "return": "string",
                        "arguments": {}
                      },
                      "id": {
                        "return": "object",
                        "arguments": {}
                      },
                      "name": {
                        "return": "string",
                        "arguments": {}
                      },
                      "parent": {
                        "return": {
                          "browserTabTitle": {
                            "return": "string",
                            "arguments": {}
                          },
                          "faviconLink": {
                            "return": "string",
                            "arguments": {}
                          },
                          "id": {}
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

TransitionManualProcessInput: object

manualProcessId:
transition:
Example
{
  "manualProcessId": "object",
  "transition": "string"
}

TransitionManualProcessResponse: object

manualProcess:
object
return:
arguments:
object
Example
{
  "manualProcess": {
    "return": {
      "account": {
        "return": {
          "affiliations": {
            "return": [
              {
                "allocation": {
                  "return": "number",
                  "arguments": {}
                },
                "id": {
                  "return": "object",
                  "arguments": {}
                },
                "relation": {
                  "return": "string",
                  "arguments": {}
                },
                "signatureRequired": {
                  "return": "boolean",
                  "arguments": {}
                },
                "type": {
                  "return": "string",
                  "arguments": {}
                },
                "user": {
                  "return": {
                    "accessibleBy": {
                      "return": [
                        {
                          "displayOptions": {
                            "return": {
                              "hide": {
                                "return": "boolean",
                                "arguments": {}
                              },
                              "order": {
                                "return": "number",
                                "arguments": {}
                              }
                            },
                            "arguments": {}
                          },
                          "organizationUser": {
                            "return": {
                              "accessType": {
                                "return": "string",
                                "arguments": {}
                              },
                              "apiTokens": {
                                "return": [
                                  {
                                    "id": {
                                      "return": "object",
                                      "arguments": {}
                                    },
                                    "jwtToken": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "name": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "organization": {
                                      "return": {
                                        "browserTabTitle": {
                                          "return": "string",
                                          "arguments": {}
                                        },
                                        "faviconLink": {
                                          "return": "string",
                                          "arguments": {}
                                        },
                                        "id": {
                                          "return": "object",
                                          "arguments": {}
                                        },
                                        "name": {
                                          "return": "string",
                                          "arguments": {}
                                        },
                                        "parent": {
                                          "return": {
                                            "browserTabTitle": {
                                              "return": "string",
                                              "arguments": {}
                                            },
                                            "faviconLink": {}
                                          }
                                        }
                                      }
                                    }
                                  }
                                ]
                              }
                            }
                          }
                        }
                      ]
                    }
                  }
                }
              }
            ]
          }
        }
      }
    }
  }
}

TransitionModelPortfolioInput: object

modelPortfolioId:
transition:
Example
{
  "modelPortfolioId": "object",
  "transition": "string"
}

TransitionModelPortfolioResponse: object

modelPortfolio:
object
return:
arguments:
object
Example
{
  "modelPortfolio": {
    "return": {
      "assignable": {
        "return": "boolean",
        "arguments": {}
      },
      "autoUpdatePrices": {
        "return": "boolean",
        "arguments": {}
      },
      "children": {
        "return": [
          {
            "financialProduct": {
              "return": {
                "assignable": {
                  "return": "boolean",
                  "arguments": {}
                },
                "autoUpdatePrices": {
                  "return": "boolean",
                  "arguments": {}
                },
                "children": {
                  "return": [
                    {
                      "financialProduct": {
                        "return": {
                          "assignable": {
                            "return": "boolean",
                            "arguments": {}
                          },
                          "autoUpdatePrices": {
                            "return": "boolean",
                            "arguments": {}
                          },
                          "children": {
                            "return": [
                              {
                                "financialProduct": {
                                  "return": {
                                    "assignable": {
                                      "return": "boolean",
                                      "arguments": {}
                                    },
                                    "autoUpdatePrices": {
                                      "return": "boolean",
                                      "arguments": {}
                                    },
                                    "children": {
                                      "return": [
                                        {
                                          "financialProduct": {
                                            "return": {
                                              "assignable": {
                                                "return": "boolean",
                                                "arguments": {}
                                              },
                                              "autoUpdatePrices": {
                                                "return": "boolean",
                                                "arguments": {}
                                              },
                                              "children": {
                                                "return": [
                                                  {
                                                    "financialProduct": {
                                                      "return": {
                                                        "assignable": {
                                                          "return": "boolean",
                                                          "arguments": {}
                                                        },
                                                        "autoUpdatePrices": {
                                                          "return": "boolean",
                                                          "arguments": {}
                                                        },
                                                        "children": {
                                                          "return": [
                                                            {
                                                              "financialProduct": {
                                                                "return": {
                                                                  "assignable": {
                                                                    "return": "boolean",
                                                                    "arguments": {}
                                                                  },
                                                                  "autoUpdatePrices": {}
                                                                }
                                                              }
                                                            }
                                                          ]
                                                        }
                                                      }
                                                    }
                                                  }
                                                ]
                                              }
                                            }
                                          }
                                        }
                                      ]
                                    }
                                  }
                                }
                              }
                            ]
                          }
                        }
                      }
                    }
                  ]
                }
              }
            }
          }
        ]
      }
    }
  }
}

TransitionNoteInput: object

noteId:
transition:
Example
{
  "noteId": "object",
  "transition": "string"
}

TransitionNoteResponse: object

note:
object
return:
arguments:
object
Example
{
  "note": {
    "return": {
      "author": {
        "return": {
          "email": {
            "return": "string",
            "arguments": {}
          },
          "firstName": {
            "return": "string",
            "arguments": {}
          },
          "id": {
            "return": "object",
            "arguments": {}
          },
          "language": {
            "return": "string",
            "arguments": {}
          },
          "lastName": {
            "return": "string",
            "arguments": {}
          },
          "organization": {
            "return": {
              "browserTabTitle": {
                "return": "string",
                "arguments": {}
              },
              "faviconLink": {
                "return": "string",
                "arguments": {}
              },
              "id": {
                "return": "object",
                "arguments": {}
              },
              "name": {
                "return": "string",
                "arguments": {}
              },
              "parent": {
                "return": {
                  "browserTabTitle": {
                    "return": "string",
                    "arguments": {}
                  },
                  "faviconLink": {
                    "return": "string",
                    "arguments": {}
                  },
                  "id": {
                    "return": "object",
                    "arguments": {}
                  },
                  "name": {
                    "return": "string",
                    "arguments": {}
                  },
                  "parent": {
                    "return": {
                      "browserTabTitle": {
                        "return": "string",
                        "arguments": {}
                      },
                      "faviconLink": {
                        "return": "string",
                        "arguments": {}
                      },
                      "id": {
                        "return": "object",
                        "arguments": {}
                      },
                      "name": {
                        "return": "string",
                        "arguments": {}
                      },
                      "parent": {
                        "return": {
                          "browserTabTitle": {
                            "return": "string",
                            "arguments": {}
                          },
                          "faviconLink": {
                            "return": "string",
                            "arguments": {}
                          },
                          "id": {
                            "return": "object",
                            "arguments": {}
                          },
                          "name": {}
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

TransitionPortfolioOptimizerInput: object

portfolioOptimizerId:
transition:
Example
{
  "portfolioOptimizerId": "object",
  "transition": "string"
}

TransitionPortfolioOptimizerResponse: object

portfolioOptimizer:
object
return:
arguments:
object
Example
{
  "portfolioOptimizer": {
    "return": {
      "createdAt": {
        "return": "object",
        "arguments": {}
      },
      "expectedTotalSubTradeRequests": {
        "return": "number",
        "arguments": {}
      },
      "id": {
        "return": "object",
        "arguments": {}
      },
      "numPortfolios": {
        "return": "number",
        "arguments": {}
      },
      "organization": {
        "return": {
          "browserTabTitle": {
            "return": "string",
            "arguments": {}
          },
          "faviconLink": {
            "return": "string",
            "arguments": {}
          },
          "id": {
            "return": "object",
            "arguments": {}
          },
          "name": {
            "return": "string",
            "arguments": {}
          },
          "parent": {
            "return": {
              "browserTabTitle": {
                "return": "string",
                "arguments": {}
              },
              "faviconLink": {
                "return": "string",
                "arguments": {}
              },
              "id": {
                "return": "object",
                "arguments": {}
              },
              "name": {
                "return": "string",
                "arguments": {}
              },
              "parent": {
                "return": {
                  "browserTabTitle": {
                    "return": "string",
                    "arguments": {}
                  },
                  "faviconLink": {
                    "return": "string",
                    "arguments": {}
                  },
                  "id": {
                    "return": "object",
                    "arguments": {}
                  },
                  "name": {
                    "return": "string",
                    "arguments": {}
                  },
                  "parent": {
                    "return": {
                      "browserTabTitle": {
                        "return": "string",
                        "arguments": {}
                      },
                      "faviconLink": {
                        "return": "string",
                        "arguments": {}
                      },
                      "id": {
                        "return": "object",
                        "arguments": {}
                      },
                      "name": {
                        "return": "string",
                        "arguments": {}
                      },
                      "parent": {
                        "return": {
                          "browserTabTitle": {}
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

TransitionRebalanceInput: object

rebalanceId:
transition:
Example
{
  "rebalanceId": "object",
  "transition": "string"
}

TransitionRebalanceResponse: object

rebalance:
object
return:
arguments:
object
Example
{
  "rebalance": {
    "return": {
      "actualQuantitiesSet": {
        "return": "boolean",
        "arguments": {}
      },
      "allocationFileUrl": {
        "return": "string",
        "arguments": {}
      },
      "allocationFileUrls": {
        "return": [
          "string"
        ],
        "arguments": {}
      },
      "bulkTrades": {
        "return": [
          {
            "bulkTrades": {
              "return": [
                {
                  "_id": {
                    "return": "string",
                    "arguments": {}
                  },
                  "currency": {
                    "return": "string",
                    "arguments": {}
                  },
                  "exchange": {
                    "return": "string",
                    "arguments": {}
                  },
                  "expectedPriceCents": {
                    "return": "number",
                    "arguments": {}
                  },
                  "expectedPriceInCurrencyCents": {
                    "return": "number",
                    "arguments": {}
                  },
                  "total": {
                    "return": "number",
                    "arguments": {}
                  }
                }
              ],
              "arguments": {}
            },
            "type": {
              "return": "string",
              "arguments": {}
            }
          }
        ],
        "arguments": {}
      },
      "buyBulkTradeFileUrl": {
        "return": "string",
        "arguments": {}
      },
      "createdAt": {
        "return": "object",
        "arguments": {}
      },
      "id": {
        "return": "object",
        "arguments": {}
      },
      "mutualFundFileUrl": {
        "return": "string",
        "arguments": {}
      },
      "organization": {
        "return": {
          "browserTabTitle": {
            "return": "string",
            "arguments": {}
          },
          "faviconLink": {
            "return": "string",
            "arguments": {}
          },
          "id": {
            "return": "object",
            "arguments": {}
          },
          "name": {
            "return": "string",
            "arguments": {}
          },
          "parent": {
            "return": {
              "browserTabTitle": {
                "return": "string",
                "arguments": {}
              },
              "faviconLink": {
                "return": "string"
              }
            }
          }
        }
      }
    }
  }
}

TransitionReportInput: object

reportId:
transition:
Example
{
  "reportId": "object",
  "transition": "string"
}

TransitionReportResponse: object

report:
object
return:
arguments:
object
Example
{
  "report": {
    "return": {
      "id": {
        "return": "object",
        "arguments": {}
      },
      "reason": {
        "return": "string",
        "arguments": {}
      },
      "rules": {
        "return": [
          {
            "id": {
              "return": "object",
              "arguments": {}
            },
            "translatedDescription": {
              "return": {
                "en": {
                  "return": "string",
                  "arguments": {}
                },
                "fr": {
                  "return": "string",
                  "arguments": {}
                }
              },
              "arguments": {}
            },
            "type": {
              "return": "string",
              "arguments": {}
            }
          }
        ],
        "arguments": {}
      },
      "state": {
        "return": "string",
        "arguments": {}
      },
      "transfer": {
        "return": {
          "alertReport": {
            "return": {
              "id": {
                "return": "object",
                "arguments": {}
              },
              "reason": {
                "return": "string",
                "arguments": {}
              },
              "rules": {
                "return": [
                  {
                    "id": {
                      "return": "object",
                      "arguments": {}
                    },
                    "translatedDescription": {
                      "return": {
                        "en": {
                          "return": "string",
                          "arguments": {}
                        },
                        "fr": {
                          "return": "string",
                          "arguments": {}
                        }
                      },
                      "arguments": {}
                    },
                    "type": {
                      "return": "string",
                      "arguments": {}
                    }
                  }
                ],
                "arguments": {}
              },
              "state": {
                "return": "string",
                "arguments": {}
              },
              "transfer": {
                "return": {
                  "alertReport": {
                    "return": {
                      "id": {
                        "return": "object",
                        "arguments": {}
                      },
                      "reason": {
                        "return": "string",
                        "arguments": {}
                      },
                      "rules": {
                        "return": [
                          null
                        ]
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

TransitionRoleProfileInput: object

roleProfileId:
transition:
Example
{
  "roleProfileId": "object",
  "transition": "string"
}

TransitionRoleProfileResponse: object

roleProfile:
object
return:
arguments:
object
Example
{
  "roleProfile": {
    "return": {
      "createdAt": {
        "return": "object",
        "arguments": {}
      },
      "id": {
        "return": "object",
        "arguments": {}
      },
      "organization": {
        "return": {
          "accountTypeTaxRanks": {
            "return": [
              {
                "accountType": {
                  "return": "string",
                  "arguments": {}
                },
                "id": {
                  "return": "object",
                  "arguments": {}
                },
                "taxRank": {
                  "return": "number",
                  "arguments": {}
                }
              }
            ],
            "arguments": {}
          },
          "allowAccessToSubOrganizations": {
            "return": "boolean",
            "arguments": {}
          },
          "allowDirectCommunication": {
            "return": "boolean",
            "arguments": {}
          },
          "allowInactiveUserAdjustments": {
            "return": "boolean",
            "arguments": {}
          },
          "allowInactiveUserFeeCalculation": {
            "return": "boolean",
            "arguments": {}
          },
          "allowInactiveUserRebalancing": {
            "return": "boolean",
            "arguments": {}
          },
          "allowInstantInvest": {
            "return": "boolean",
            "arguments": {}
          },
          "allowPortfolioPerGoal": {
            "return": "boolean",
            "arguments": {}
          },
          "allowPostOptimizationEditing": {
            "return": "boolean",
            "arguments": {}
          },
          "allowViewSubTradeRequestPairs": {
            "return": "boolean",
            "arguments": {}
          },
          "applicableJurisdictions": {
            "return": {
              "all": {
                "return": "boolean",
                "arguments": {}
              },
              "only": {
                "return": [
                  "string"
                ],
                "arguments": {}
              }
            },
            "arguments": {}
          },
          "applicableLocalization": {
            "return": {
              "countries": {
                "return": [
                  "string"
                ],
                "arguments": {}
              },
              "dateFormat": {
                "return": "string",
                "arguments": {}
              },
              "defaultCurrency": {
                "return": "string",
                "arguments": {}
              },
              "defaultLanguage": {
                "return": "string"
              }
            }
          }
        }
      }
    }
  }
}

TransitionScheduledIncomeFundTransferInput: object

scheduledIncomeFundTransferId:
transition:
Example
{
  "scheduledIncomeFundTransferId": "object",
  "transition": "string"
}

TransitionScheduledIncomeFundTransferResponse: object

scheduledIncomeFundTransfer:
object
return:
arguments:
object
Example
{
  "scheduledIncomeFundTransfer": {
    "return": {
      "amountPayableType": {
        "return": "string",
        "arguments": {}
      },
      "annualAmountCents": {
        "return": "object",
        "arguments": {}
      },
      "bankAccount": {
        "return": {
          "EftEligibleRatio": {
            "return": "number",
            "arguments": {}
          },
          "bankAccountNumber": {
            "return": "string",
            "arguments": {}
          },
          "bankAccountNumberDisclosed": {
            "return": "string",
            "arguments": {}
          },
          "createdAt": {
            "return": "object",
            "arguments": {}
          },
          "downloadUrls": {
            "return": [
              "string"
            ],
            "arguments": {}
          },
          "id": {
            "return": "object",
            "arguments": {}
          },
          "institutionNumber": {
            "return": "string",
            "arguments": {}
          },
          "name": {
            "return": "string",
            "arguments": {}
          },
          "source": {
            "return": "string",
            "arguments": {}
          },
          "state": {
            "return": "string",
            "arguments": {}
          },
          "stateChanges": {
            "return": [
              "object"
            ],
            "arguments": {}
          },
          "transitNumber": {
            "return": "string",
            "arguments": {}
          },
          "transitNumberDisclosed": {
            "return": "string",
            "arguments": {}
          },
          "updatedAt": {
            "return": "object",
            "arguments": {}
          },
          "user": {
            "return": {
              "accessibleBy": {
                "return": [
                  {
                    "displayOptions": {
                      "return": {
                        "hide": {
                          "return": "boolean",
                          "arguments": {}
                        },
                        "order": {
                          "return": "number",
                          "arguments": {}
                        }
                      },
                      "arguments": {}
                    },
                    "organizationUser": {
                      "return": {
                        "accessType": {
                          "return": "string",
                          "arguments": {}
                        },
                        "apiTokens": {}
                      }
                    }
                  }
                ]
              }
            }
          }
        }
      }
    }
  }
}

TransitionSubAccountInput: object

lastUpdatedBy:
subAccountId:
transition:
Example
{
  "lastUpdatedBy": "object",
  "subAccountId": "object",
  "transition": "string"
}

TransitionSubAccountResponse: object

subAccount:
object
return:
arguments:
object
Example
{
  "subAccount": {
    "return": {
      "acceptableFinancialProduct": {
        "return": "boolean",
        "arguments": {}
      },
      "account": {
        "return": {
          "affiliations": {
            "return": [
              {
                "allocation": {
                  "return": "number",
                  "arguments": {}
                },
                "id": {
                  "return": "object",
                  "arguments": {}
                },
                "relation": {
                  "return": "string",
                  "arguments": {}
                },
                "signatureRequired": {
                  "return": "boolean",
                  "arguments": {}
                },
                "type": {
                  "return": "string",
                  "arguments": {}
                },
                "user": {
                  "return": {
                    "accessibleBy": {
                      "return": [
                        {
                          "displayOptions": {
                            "return": {
                              "hide": {
                                "return": "boolean",
                                "arguments": {}
                              },
                              "order": {
                                "return": "number",
                                "arguments": {}
                              }
                            },
                            "arguments": {}
                          },
                          "organizationUser": {
                            "return": {
                              "accessType": {
                                "return": "string",
                                "arguments": {}
                              },
                              "apiTokens": {
                                "return": [
                                  {
                                    "id": {
                                      "return": "object",
                                      "arguments": {}
                                    },
                                    "jwtToken": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "name": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "organization": {
                                      "return": {
                                        "browserTabTitle": {
                                          "return": "string",
                                          "arguments": {}
                                        },
                                        "faviconLink": {
                                          "return": "string",
                                          "arguments": {}
                                        },
                                        "id": {
                                          "return": "object",
                                          "arguments": {}
                                        },
                                        "name": {
                                          "return": "string",
                                          "arguments": {}
                                        },
                                        "parent": {
                                          "return": {
                                            "browserTabTitle": {}
                                          }
                                        }
                                      }
                                    }
                                  }
                                ]
                              }
                            }
                          }
                        }
                      ]
                    }
                  }
                }
              }
            ]
          }
        }
      }
    }
  }
}

TransitionSubTradeRequestInput: object

subTradeRequestId:
transition:
Example
{
  "subTradeRequestId": "object",
  "transition": "string"
}

TransitionSubTradeRequestResponse: object

subTradeRequest:
object
return:
arguments:
object
Example
{
  "subTradeRequest": {
    "return": {
      "account": {
        "return": {
          "affiliations": {
            "return": [
              {
                "allocation": {
                  "return": "number",
                  "arguments": {}
                },
                "id": {
                  "return": "object",
                  "arguments": {}
                },
                "relation": {
                  "return": "string",
                  "arguments": {}
                },
                "signatureRequired": {
                  "return": "boolean",
                  "arguments": {}
                },
                "type": {
                  "return": "string",
                  "arguments": {}
                },
                "user": {
                  "return": {
                    "accessibleBy": {
                      "return": [
                        {
                          "displayOptions": {
                            "return": {
                              "hide": {
                                "return": "boolean",
                                "arguments": {}
                              },
                              "order": {
                                "return": "number",
                                "arguments": {}
                              }
                            },
                            "arguments": {}
                          },
                          "organizationUser": {
                            "return": {
                              "accessType": {
                                "return": "string",
                                "arguments": {}
                              },
                              "apiTokens": {
                                "return": [
                                  {
                                    "id": {
                                      "return": "object",
                                      "arguments": {}
                                    },
                                    "jwtToken": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "name": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "organization": {
                                      "return": {
                                        "browserTabTitle": {
                                          "return": "string",
                                          "arguments": {}
                                        },
                                        "faviconLink": {
                                          "return": "string",
                                          "arguments": {}
                                        },
                                        "id": {
                                          "return": "object",
                                          "arguments": {}
                                        },
                                        "name": {
                                          "return": "string",
                                          "arguments": {}
                                        },
                                        "parent": {
                                          "return": {
                                            "browserTabTitle": {
                                              "return": "string",
                                              "arguments": {}
                                            },
                                            "faviconLink": {}
                                          }
                                        }
                                      }
                                    }
                                  }
                                ]
                              }
                            }
                          }
                        }
                      ]
                    }
                  }
                }
              }
            ]
          }
        }
      }
    }
  }
}

TransitionThemeInput: object

themeId:
transition:
Example
{
  "themeId": "object",
  "transition": "string"
}

TransitionThemeResponse: object

theme:
object
return:
arguments:
object
Example
{
  "theme": {
    "return": {
      "core": {
        "return": "boolean",
        "arguments": {}
      },
      "description": {
        "return": "string",
        "arguments": {}
      },
      "iconKey": {
        "return": "string",
        "arguments": {}
      },
      "id": {
        "return": "object",
        "arguments": {}
      },
      "key": {
        "return": "string",
        "arguments": {}
      },
      "logs": {
        "return": {
          "logs": {
            "return": [
              {
                "account": {
                  "return": {
                    "affiliations": {
                      "return": [
                        {
                          "allocation": {
                            "return": "number",
                            "arguments": {}
                          },
                          "id": {
                            "return": "object",
                            "arguments": {}
                          },
                          "relation": {
                            "return": "string",
                            "arguments": {}
                          },
                          "signatureRequired": {
                            "return": "boolean",
                            "arguments": {}
                          },
                          "type": {
                            "return": "string",
                            "arguments": {}
                          },
                          "user": {
                            "return": {
                              "accessibleBy": {
                                "return": [
                                  {
                                    "displayOptions": {
                                      "return": {
                                        "hide": {
                                          "return": "boolean",
                                          "arguments": {}
                                        },
                                        "order": {
                                          "return": "number",
                                          "arguments": {}
                                        }
                                      },
                                      "arguments": {}
                                    },
                                    "organizationUser": {
                                      "return": {
                                        "accessType": {
                                          "return": "string",
                                          "arguments": {}
                                        },
                                        "apiTokens": {
                                          "return": [
                                            {
                                              "id": {
                                                "return": "object",
                                                "arguments": {}
                                              },
                                              "jwtToken": {
                                                "return": "string",
                                                "arguments": {}
                                              },
                                              "name": {
                                                "return": "string",
                                                "arguments": {}
                                              }
                                            }
                                          ]
                                        }
                                      }
                                    }
                                  }
                                ]
                              }
                            }
                          }
                        }
                      ]
                    }
                  }
                }
              }
            ]
          }
        }
      }
    }
  }
}

TransitionTradeInput: object

failReason:
tradeId:
transition:
Example
{
  "failReason": "object",
  "tradeId": "object",
  "transition": "string"
}

TransitionTradeResponse: object

trade:
object
return:
arguments:
object
Example
{
  "trade": {
    "return": {
      "account": {
        "return": {
          "affiliations": {
            "return": [
              {
                "allocation": {
                  "return": "number",
                  "arguments": {}
                },
                "id": {
                  "return": "object",
                  "arguments": {}
                },
                "relation": {
                  "return": "string",
                  "arguments": {}
                },
                "signatureRequired": {
                  "return": "boolean",
                  "arguments": {}
                },
                "type": {
                  "return": "string",
                  "arguments": {}
                },
                "user": {
                  "return": {
                    "accessibleBy": {
                      "return": [
                        {
                          "displayOptions": {
                            "return": {
                              "hide": {
                                "return": "boolean",
                                "arguments": {}
                              },
                              "order": {
                                "return": "number",
                                "arguments": {}
                              }
                            },
                            "arguments": {}
                          },
                          "organizationUser": {
                            "return": {
                              "accessType": {
                                "return": "string",
                                "arguments": {}
                              },
                              "apiTokens": {
                                "return": [
                                  {
                                    "id": {
                                      "return": "object",
                                      "arguments": {}
                                    },
                                    "jwtToken": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "name": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "organization": {
                                      "return": {
                                        "browserTabTitle": {
                                          "return": "string",
                                          "arguments": {}
                                        },
                                        "faviconLink": {
                                          "return": "string",
                                          "arguments": {}
                                        },
                                        "id": {
                                          "return": "object",
                                          "arguments": {}
                                        },
                                        "name": {
                                          "return": "string",
                                          "arguments": {}
                                        },
                                        "parent": {
                                          "return": {
                                            "browserTabTitle": {
                                              "return": "string",
                                              "arguments": {}
                                            },
                                            "faviconLink": {}
                                          }
                                        }
                                      }
                                    }
                                  }
                                ]
                              }
                            }
                          }
                        }
                      ]
                    }
                  }
                }
              }
            ]
          }
        }
      }
    }
  }
}

TransitionTransferInput: object

failReason:
transferId:
transition:
Example
{
  "failReason": "object",
  "transferId": "object",
  "transition": "string"
}

TransitionTransferResponse: object

transfer:
object
return:
arguments:
object
Example
{
  "transfer": {
    "return": {
      "alertReport": {
        "return": {
          "id": {
            "return": "object",
            "arguments": {}
          },
          "reason": {
            "return": "string",
            "arguments": {}
          },
          "rules": {
            "return": [
              {
                "id": {
                  "return": "object",
                  "arguments": {}
                },
                "translatedDescription": {
                  "return": {
                    "en": {
                      "return": "string",
                      "arguments": {}
                    },
                    "fr": {
                      "return": "string",
                      "arguments": {}
                    }
                  },
                  "arguments": {}
                },
                "type": {
                  "return": "string",
                  "arguments": {}
                }
              }
            ],
            "arguments": {}
          },
          "state": {
            "return": "string",
            "arguments": {}
          },
          "transfer": {
            "return": {
              "alertReport": {
                "return": {
                  "id": {
                    "return": "object",
                    "arguments": {}
                  },
                  "reason": {
                    "return": "string",
                    "arguments": {}
                  },
                  "rules": {
                    "return": [
                      {
                        "id": {
                          "return": "object",
                          "arguments": {}
                        },
                        "translatedDescription": {
                          "return": {
                            "en": {
                              "return": "string",
                              "arguments": {}
                            },
                            "fr": {
                              "return": "string",
                              "arguments": {}
                            }
                          },
                          "arguments": {}
                        },
                        "type": {
                          "return": "string",
                          "arguments": {}
                        }
                      }
                    ],
                    "arguments": {}
                  },
                  "state": {
                    "return": "string",
                    "arguments": {}
                  },
                  "transfer": {
                    "return": {
                      "alertReport": {
                        "return": {
                          "id": {
                            "return": "object",
                            "arguments": {}
                          },
                          "reason": {
                            "return": "string"
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

TransitionUserIdVerificationInput: object

idVerificationId:
transition:
Example
{
  "idVerificationId": "object",
  "transition": "string"
}

TransitionUserIdVerificationResponse: object

idVerification:
object
return:
arguments:
object
Example
{
  "idVerification": {
    "return": {
      "creditFileSource": {
        "return": "object",
        "arguments": {}
      },
      "documentExpiryDate": {
        "return": "object",
        "arguments": {}
      },
      "documentID": {
        "return": "string",
        "arguments": {}
      },
      "documentIssuingJurisdication": {
        "return": "string",
        "arguments": {}
      },
      "documentType": {
        "return": "string",
        "arguments": {}
      },
      "id": {
        "return": "object",
        "arguments": {}
      },
      "methodOfIDVerification": {
        "return": "string",
        "arguments": {}
      },
      "secondaryDocumentExpiryDate": {
        "return": "object",
        "arguments": {}
      },
      "secondaryDocumentID": {
        "return": "string",
        "arguments": {}
      },
      "secondaryDocumentIssuingJurisdication": {
        "return": "string",
        "arguments": {}
      },
      "secondaryDocumentType": {
        "return": "string",
        "arguments": {}
      },
      "secondaryDocumentUserName": {
        "return": "object",
        "arguments": {}
      },
      "state": {
        "return": "string",
        "arguments": {}
      },
      "user": {
        "return": {
          "accessibleBy": {
            "return": [
              {
                "displayOptions": {
                  "return": {
                    "hide": {
                      "return": "boolean",
                      "arguments": {}
                    },
                    "order": {
                      "return": "number",
                      "arguments": {}
                    }
                  },
                  "arguments": {}
                },
                "organizationUser": {
                  "return": {
                    "accessType": {
                      "return": "string",
                      "arguments": {}
                    },
                    "apiTokens": {
                      "return": [
                        {
                          "id": {
                            "return": "object",
                            "arguments": {}
                          },
                          "jwtToken": {
                            "return": "string",
                            "arguments": {}
                          },
                          "name": {
                            "return": "string",
                            "arguments": {}
                          },
                          "organization": {}
                        }
                      ]
                    }
                  }
                }
              }
            ]
          }
        }
      }
    }
  }
}

TransitionUserInput: object

Input type for Transitioning a user

transition:

User's profile transition

userId:

UserID

Example
{
  "transition": "string",
  "userId": "object"
}

TransitionUserResponse: object

Type definition for user's transition

user:
object

User object

return:
arguments:
object
Example
{
  "user": {
    "return": {
      "accessibleBy": {
        "return": [
          {
            "displayOptions": {
              "return": {
                "hide": {
                  "return": "boolean",
                  "arguments": {}
                },
                "order": {
                  "return": "number",
                  "arguments": {}
                }
              },
              "arguments": {}
            },
            "organizationUser": {
              "return": {
                "accessType": {
                  "return": "string",
                  "arguments": {}
                },
                "apiTokens": {
                  "return": [
                    {
                      "id": {
                        "return": "object",
                        "arguments": {}
                      },
                      "jwtToken": {
                        "return": "string",
                        "arguments": {}
                      },
                      "name": {
                        "return": "string",
                        "arguments": {}
                      },
                      "organization": {
                        "return": {
                          "browserTabTitle": {
                            "return": "string",
                            "arguments": {}
                          },
                          "faviconLink": {
                            "return": "string",
                            "arguments": {}
                          },
                          "id": {
                            "return": "object",
                            "arguments": {}
                          },
                          "name": {
                            "return": "string",
                            "arguments": {}
                          },
                          "parent": {
                            "return": {
                              "browserTabTitle": {
                                "return": "string",
                                "arguments": {}
                              },
                              "faviconLink": {
                                "return": "string",
                                "arguments": {}
                              },
                              "id": {
                                "return": "object",
                                "arguments": {}
                              },
                              "name": {
                                "return": "string",
                                "arguments": {}
                              },
                              "parent": {
                                "return": {
                                  "browserTabTitle": {
                                    "return": "string",
                                    "arguments": {}
                                  },
                                  "faviconLink": {
                                    "return": "string",
                                    "arguments": {}
                                  },
                                  "id": {
                                    "return": "object",
                                    "arguments": {}
                                  },
                                  "name": {
                                    "return": "string",
                                    "arguments": {}
                                  }
                                }
                              }
                            }
                          }
                        }
                      }
                    }
                  ]
                }
              }
            }
          }
        ]
      }
    }
  }
}

TransitionWorkflowCompletionInput: object

transition:
workflowCompletionId:
Example
{
  "transition": "string",
  "workflowCompletionId": "object"
}

TransitionWorkflowCompletionResponse: object

workflowCompletion:
object
return:
arguments:
object
Example
{
  "workflowCompletion": {
    "return": {
      "context": {
        "return": "object",
        "arguments": {}
      },
      "createdAt": {
        "return": "object",
        "arguments": {}
      },
      "currentStep": {
        "return": {
          "id": {
            "return": "object",
            "arguments": {}
          },
          "name": {
            "return": {
              "en": {
                "return": "string",
                "arguments": {}
              },
              "fr": {
                "return": "string",
                "arguments": {}
              }
            },
            "arguments": {}
          },
          "subSteps": {
            "return": [
              {
                "canGoBack": {
                  "return": "boolean",
                  "arguments": {}
                },
                "completeableBy": {
                  "return": [
                    "string"
                  ],
                  "arguments": {}
                },
                "id": {
                  "return": "object",
                  "arguments": {}
                },
                "options": {
                  "return": "object",
                  "arguments": {}
                },
                "rolesCompleteableBy": {
                  "return": [
                    {
                      "accessiblePages": {
                        "return": [
                          "string"
                        ],
                        "arguments": {}
                      },
                      "accountPageConfiguration": {
                        "return": {
                          "createdAt": {
                            "return": "object",
                            "arguments": {}
                          },
                          "id": {
                            "return": "object",
                            "arguments": {}
                          },
                          "name": {
                            "return": "string",
                            "arguments": {}
                          },
                          "options": {
                            "return": "object",
                            "arguments": {}
                          },
                          "organization": {
                            "return": {
                              "accountTypeTaxRanks": {
                                "return": [
                                  {
                                    "accountType": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "id": {
                                      "return": "object",
                                      "arguments": {}
                                    },
                                    "taxRank": {
                                      "return": "number",
                                      "arguments": {}
                                    }
                                  }
                                ],
                                "arguments": {}
                              }
                            }
                          }
                        }
                      }
                    }
                  ]
                }
              }
            ]
          }
        }
      }
    }
  }
}

TransitionWorkflowInput: object

transition:
workflowId:
Example
{
  "transition": "string",
  "workflowId": "object"
}

TransitionWorkflowResponse: object

workflow:
object
return:
arguments:
object
Example
{
  "workflow": {
    "return": {
      "createdAt": {
        "return": "object",
        "arguments": {}
      },
      "eventType": {
        "return": "string",
        "arguments": {}
      },
      "id": {
        "return": "object",
        "arguments": {}
      },
      "name": {
        "return": {
          "en": {
            "return": "string",
            "arguments": {}
          },
          "fr": {
            "return": "string",
            "arguments": {}
          }
        },
        "arguments": {}
      },
      "objectType": {
        "return": "string",
        "arguments": {}
      },
      "organization": {
        "return": {
          "accountTypeTaxRanks": {
            "return": [
              {
                "accountType": {
                  "return": "string",
                  "arguments": {}
                },
                "id": {
                  "return": "object",
                  "arguments": {}
                },
                "taxRank": {
                  "return": "number",
                  "arguments": {}
                }
              }
            ],
            "arguments": {}
          },
          "allowAccessToSubOrganizations": {
            "return": "boolean",
            "arguments": {}
          },
          "allowDirectCommunication": {
            "return": "boolean",
            "arguments": {}
          },
          "allowInactiveUserAdjustments": {
            "return": "boolean",
            "arguments": {}
          },
          "allowInactiveUserFeeCalculation": {
            "return": "boolean",
            "arguments": {}
          },
          "allowInactiveUserRebalancing": {
            "return": "boolean",
            "arguments": {}
          },
          "allowInstantInvest": {
            "return": "boolean",
            "arguments": {}
          },
          "allowPortfolioPerGoal": {
            "return": "boolean",
            "arguments": {}
          },
          "allowPostOptimizationEditing": {
            "return": "boolean",
            "arguments": {}
          },
          "allowViewSubTradeRequestPairs": {
            "return": "boolean",
            "arguments": {}
          },
          "applicableJurisdictions": {
            "return": {
              "all": {
                "return": "boolean",
                "arguments": {}
              },
              "only": {
                "return": [
                  "string"
                ],
                "arguments": {}
              }
            }
          }
        }
      }
    }
  }
}

TranslatedString: object

en:
object
return:
arguments:
object
fr:
object
return:
arguments:
object
Example
{
  "en": {
    "return": "string",
    "arguments": {}
  },
  "fr": {
    "return": "string",
    "arguments": {}
  }
}

TranslatedStringInput: object

en:
fr:
Example
{
  "en": "object",
  "fr": "object"
}

TriggerAutoBulkTradesInput: object

rebalanceId:
Example
{
  "rebalanceId": "object"
}

TriggerAutoBulkTradesResponse: object

rebalance:
object
return:
arguments:
object
Example
{
  "rebalance": {
    "return": {
      "actualQuantitiesSet": {
        "return": "boolean",
        "arguments": {}
      },
      "allocationFileUrl": {
        "return": "string",
        "arguments": {}
      },
      "allocationFileUrls": {
        "return": [
          "string"
        ],
        "arguments": {}
      },
      "bulkTrades": {
        "return": [
          {
            "bulkTrades": {
              "return": [
                {
                  "_id": {
                    "return": "string",
                    "arguments": {}
                  },
                  "currency": {
                    "return": "string",
                    "arguments": {}
                  },
                  "exchange": {
                    "return": "string",
                    "arguments": {}
                  },
                  "expectedPriceCents": {
                    "return": "number",
                    "arguments": {}
                  },
                  "expectedPriceInCurrencyCents": {
                    "return": "number",
                    "arguments": {}
                  },
                  "total": {
                    "return": "number",
                    "arguments": {}
                  }
                }
              ],
              "arguments": {}
            },
            "type": {
              "return": "string",
              "arguments": {}
            }
          }
        ],
        "arguments": {}
      },
      "buyBulkTradeFileUrl": {
        "return": "string",
        "arguments": {}
      },
      "createdAt": {
        "return": "object",
        "arguments": {}
      },
      "id": {
        "return": "object",
        "arguments": {}
      },
      "mutualFundFileUrl": {
        "return": "string",
        "arguments": {}
      },
      "organization": {
        "return": {
          "browserTabTitle": {
            "return": "string",
            "arguments": {}
          },
          "faviconLink": {
            "return": "string",
            "arguments": {}
          },
          "id": {
            "return": "object",
            "arguments": {}
          },
          "name": {
            "return": "string",
            "arguments": {}
          },
          "parent": {
            "return": {
              "browserTabTitle": {
                "return": "string",
                "arguments": {}
              },
              "faviconLink": {
                "return": "string"
              }
            }
          }
        }
      }
    }
  }
}

TriggerModelPortfolioResignInput: object

modelPortfolioId:
translatedReasonForUpdate:

This will be used to describe why form agreements need to be re-signed (e.g. when a portfolio's secondaryAssetClass, description, and/or targetAllocations have changed).

Example
{
  "modelPortfolioId": "object",
  "translatedReasonForUpdate": {
    "en": "object",
    "fr": "object"
  }
}

TriggerObjectTypes: string

object
Account
object
Goal
object
SubAccount
object
Transfer
object
User

TriggerRule: object

comparison:
object
return:
arguments:
object
field:
object
return:
arguments:
object
value:
object
return:
arguments:
object
Example
{
  "comparison": {
    "return": "string",
    "arguments": {}
  },
  "field": {
    "return": "string",
    "arguments": {}
  },
  "value": {
    "return": "string",
    "arguments": {}
  }
}

TriggerRuleComparisonTypes: string

object
EQUALS
object
GREATER_THAN
object
GREATER_THAN_AGO
object
IN
object
INCLUDES
object
LESS_THAN
object
LESS_THAN_AGO
object
NOT_EQUALS
object
NOT_IN
object
NOT_INCLUDES

TriggerRuleInput: object

comparison:
field:
value:
Example
{
  "comparison": "string",
  "field": "object",
  "value": "object"
}

TriggerTLHAnalysisInput: object

organizationId (optional): Tax Loss Harvesting will run only on accounts of that organization and its sub-organizations.

organizationId:
Example
{
  "organizationId": "object"
}

TriggerTLHAnalysisResponse: object

job:
object
return:
arguments:
object
Example
{
  "job": {
    "return": {
      "createdAt": {
        "return": "object",
        "arguments": {}
      },
      "id": {
        "return": "object",
        "arguments": {}
      },
      "numEvents": {
        "return": "number",
        "arguments": {}
      },
      "organization": {
        "return": {
          "browserTabTitle": {
            "return": "string",
            "arguments": {}
          },
          "faviconLink": {
            "return": "string",
            "arguments": {}
          },
          "id": {
            "return": "object",
            "arguments": {}
          },
          "name": {
            "return": "string",
            "arguments": {}
          },
          "parent": {
            "return": {
              "browserTabTitle": {
                "return": "string",
                "arguments": {}
              },
              "faviconLink": {
                "return": "string",
                "arguments": {}
              },
              "id": {
                "return": "object",
                "arguments": {}
              },
              "name": {
                "return": "string",
                "arguments": {}
              },
              "parent": {
                "return": {
                  "browserTabTitle": {
                    "return": "string",
                    "arguments": {}
                  },
                  "faviconLink": {
                    "return": "string",
                    "arguments": {}
                  },
                  "id": {
                    "return": "object",
                    "arguments": {}
                  },
                  "name": {
                    "return": "string",
                    "arguments": {}
                  },
                  "parent": {
                    "return": {
                      "browserTabTitle": {
                        "return": "string",
                        "arguments": {}
                      },
                      "faviconLink": {
                        "return": "string",
                        "arguments": {}
                      },
                      "id": {
                        "return": "object",
                        "arguments": {}
                      },
                      "name": {
                        "return": "string",
                        "arguments": {}
                      },
                      "parent": {
                        "return": {
                          "browserTabTitle": {
                            "return": "string",
                            "arguments": {}
                          },
                          "faviconLink": {}
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

TriggerTypes: string

object
EVENT
object
MANUAL

TrustedContactPerson: object

User's Trusted Contact Person

email:
object

Email of trusted contact person

return:
arguments:
object
name:
object

Full name of the trusted contact person

return:
arguments:
object
phone:
object
return:
arguments:
object
physicalAddress:
object
return:
arguments:
object
relation:
object

The relationship between the user and the trusted contact person

return:
arguments:
object
Example
{
  "email": {
    "return": "string",
    "arguments": {}
  },
  "name": {
    "return": "string",
    "arguments": {}
  },
  "phone": {
    "return": "string",
    "arguments": {}
  },
  "physicalAddress": {
    "return": {
      "city": {
        "return": "string",
        "arguments": {}
      },
      "country": {
        "return": "string",
        "arguments": {}
      },
      "houseNumber": {
        "return": "string",
        "arguments": {}
      },
      "jurisdiction": {
        "return": "string",
        "arguments": {}
      },
      "neighborhood": {
        "return": "string",
        "arguments": {}
      },
      "postal": {
        "return": "string",
        "arguments": {}
      },
      "province": {
        "return": "string",
        "arguments": {}
      },
      "streetName": {
        "return": "string",
        "arguments": {}
      },
      "unitNumber": {
        "return": "string",
        "arguments": {}
      }
    },
    "arguments": {}
  },
  "relation": {
    "return": "string",
    "arguments": {}
  }
}

TrustedContactPersonInput: object

Input Type for user's trusted contact person details

email:

Trusted contact person's email

name:

Trusted contact person's legal full name

phone:
physicalAddress:
relation:

Relationship between the user and the trusted contact person

Example
{
  "email": "object",
  "name": "object",
  "phone": "object",
  "physicalAddress": {
    "city": "object",
    "country": "string",
    "houseNumber": "object",
    "jurisdiction": "string",
    "neighborhood": "object",
    "postal": "object",
    "province": "string",
    "streetName": "object",
    "unitNumber": "object"
  },
  "relation": "string"
}

TypeGroup: string

object
MANAGEMENT_FEES
object
STATEMENTS
object
TAX

URLString: object

URL String input

Example
object

UnlinkPhoneMultifactorResponse: object

user:
object
return:
arguments:
object
Example
{
  "user": {
    "return": {
      "accessibleBy": {
        "return": [
          {
            "displayOptions": {
              "return": {
                "hide": {
                  "return": "boolean",
                  "arguments": {}
                },
                "order": {
                  "return": "number",
                  "arguments": {}
                }
              },
              "arguments": {}
            },
            "organizationUser": {
              "return": {
                "accessType": {
                  "return": "string",
                  "arguments": {}
                },
                "apiTokens": {
                  "return": [
                    {
                      "id": {
                        "return": "object",
                        "arguments": {}
                      },
                      "jwtToken": {
                        "return": "string",
                        "arguments": {}
                      },
                      "name": {
                        "return": "string",
                        "arguments": {}
                      },
                      "organization": {
                        "return": {
                          "browserTabTitle": {
                            "return": "string",
                            "arguments": {}
                          },
                          "faviconLink": {
                            "return": "string",
                            "arguments": {}
                          },
                          "id": {
                            "return": "object",
                            "arguments": {}
                          },
                          "name": {
                            "return": "string",
                            "arguments": {}
                          },
                          "parent": {
                            "return": {
                              "browserTabTitle": {
                                "return": "string",
                                "arguments": {}
                              },
                              "faviconLink": {
                                "return": "string",
                                "arguments": {}
                              },
                              "id": {
                                "return": "object",
                                "arguments": {}
                              },
                              "name": {
                                "return": "string",
                                "arguments": {}
                              },
                              "parent": {
                                "return": {
                                  "browserTabTitle": {
                                    "return": "string",
                                    "arguments": {}
                                  },
                                  "faviconLink": {
                                    "return": "string",
                                    "arguments": {}
                                  },
                                  "id": {
                                    "return": "object",
                                    "arguments": {}
                                  },
                                  "name": {
                                    "return": "string",
                                    "arguments": {}
                                  }
                                }
                              }
                            }
                          }
                        }
                      }
                    }
                  ]
                }
              }
            }
          }
        ]
      }
    }
  }
}

UpdateAccountInput: object

accountId:
applyForGovFunds:
ApplyForGovFunds
availableCurrencies:
AccountCurrencyTypes
baseCurrency:
billingScheduleId:
clientGroupId:
corporationClientGroupId:
custodianAccountNumber:
custodianConnectionId:
custodianSortingOrderPriority:
Int
customFields:
CustomFieldInput
feePaymentAccountId:
feeTierId:
forceOpen:
householdClientGroupId:
integrations:
AccountIntegrationInput
jurisdiction:
nickName:
overrideTaxRank:
Int
sourceOfFunds:
tlhEnabled:

Enables Tax-Loss Harvesting. Only allowed on PERSONAL, CASH_JOINT and CORPORATE account types.

Example
{
  "accountId": "object",
  "applyForGovFunds": [
    "string"
  ],
  "availableCurrencies": [
    "string"
  ],
  "baseCurrency": "string",
  "billingScheduleId": "object",
  "clientGroupId": "object",
  "corporationClientGroupId": "object",
  "custodianAccountNumber": "object",
  "custodianConnectionId": "object",
  "custodianSortingOrderPriority": "number",
  "customFields": [
    {
      "key": "object",
      "value": "object"
    }
  ],
  "feePaymentAccountId": "object",
  "feeTierId": "object",
  "forceOpen": "boolean",
  "householdClientGroupId": "object",
  "integrations": [
    {
      "externalId": "object",
      "groupId": "object",
      "iid": "object",
      "type": "string"
    }
  ],
  "jurisdiction": "string",
  "nickName": "object",
  "overrideTaxRank": "number",
  "sourceOfFunds": "string",
  "tlhEnabled": "boolean"
}

UpdateAccountResponse: object

account:
object
return:
arguments:
object
Example
{
  "account": {
    "return": {
      "affiliations": {
        "return": [
          {
            "allocation": {
              "return": "number",
              "arguments": {}
            },
            "id": {
              "return": "object",
              "arguments": {}
            },
            "relation": {
              "return": "string",
              "arguments": {}
            },
            "signatureRequired": {
              "return": "boolean",
              "arguments": {}
            },
            "type": {
              "return": "string",
              "arguments": {}
            },
            "user": {
              "return": {
                "accessibleBy": {
                  "return": [
                    {
                      "displayOptions": {
                        "return": {
                          "hide": {
                            "return": "boolean",
                            "arguments": {}
                          },
                          "order": {
                            "return": "number",
                            "arguments": {}
                          }
                        },
                        "arguments": {}
                      },
                      "organizationUser": {
                        "return": {
                          "accessType": {
                            "return": "string",
                            "arguments": {}
                          },
                          "apiTokens": {
                            "return": [
                              {
                                "id": {
                                  "return": "object",
                                  "arguments": {}
                                },
                                "jwtToken": {
                                  "return": "string",
                                  "arguments": {}
                                },
                                "name": {
                                  "return": "string",
                                  "arguments": {}
                                },
                                "organization": {
                                  "return": {
                                    "browserTabTitle": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "faviconLink": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "id": {
                                      "return": "object",
                                      "arguments": {}
                                    },
                                    "name": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "parent": {
                                      "return": {
                                        "browserTabTitle": {
                                          "return": "string",
                                          "arguments": {}
                                        },
                                        "faviconLink": {
                                          "return": "string",
                                          "arguments": {}
                                        }
                                      }
                                    }
                                  }
                                }
                              }
                            ]
                          }
                        }
                      }
                    }
                  ]
                }
              }
            }
          }
        ]
      }
    }
  }
}

UpdateAffiliateInput: object

Input type for updating an affiliate only user

citizenships:
SafeString

User's citizenships

closeAssociateOfPEP:

Is the user a close associate of politically exposed person?

companyType:

The type of company at which the user is employed

countryOfRegistration:
dateOfBirth:

User's date of birth

dateOfDeath:

Decedent's date of death

employerCompanyAddress:
employerName:
employmentStatus:

User's employment status

entityName:
establishedDate:
firstName:

User's first name

foreignTaxInformation:
ForeignTaxInformationInput

The tax information provided by the affiliate if the he pays tax to a foreign country

gender:

User's gender

headOfInternationalOrganization:

Is/Was the User the head of an international organization?

inProvinceSince:
isMemberOfIiroc:

Is the user a member of IIROC? IIROC:Investment Industry Regulatory Organization of Canada

isOfficerOfPublicCompany:

Is the user a high-level management executive of a public company?

isOwnerOfPublicCompany:

Is the user the owner of a public company?

issuerExchange:
issuerName:
issuerTicker:
jobTitle:

User's job title, if user is employed

lastName:

User's last name

maritalStatus:

User's martial status

middleName:

User's middle name

parentCompanyName:
payTaxesOutsideCanada:
phone:

User's phone number

physicalAddress:

User's address

politicallyExposedDomesticPerson:

Is the user a politically exposed person in a Canada?

politicallyExposedForeignPerson:

Is the user a politically exposed person in a foreign country?

positionAtEntity:
primaryEmail:

User's email address

registrationNumber:
requestId:

Unique requestID created by partner for each request to create a new user

sin:

User's Social Insurance Number

userId:
ID

UserID associated with the user

Example
{
  "citizenships": [
    "object"
  ],
  "closeAssociateOfPEP": "boolean",
  "companyType": "object",
  "countryOfRegistration": "object",
  "dateOfBirth": "object",
  "dateOfDeath": "object",
  "employerCompanyAddress": {
    "city": "object",
    "country": "string",
    "houseNumber": "object",
    "jurisdiction": "string",
    "neighborhood": "object",
    "postal": "object",
    "province": "string",
    "streetName": "object",
    "unitNumber": "object"
  },
  "employerName": "object",
  "employmentStatus": "string",
  "entityName": "object",
  "establishedDate": "object",
  "firstName": "object",
  "foreignTaxInformation": [
    {
      "foreignTaxCountry": "object",
      "foreignTaxNumber": "object"
    }
  ],
  "gender": "object",
  "headOfInternationalOrganization": "boolean",
  "inProvinceSince": "object",
  "isMemberOfIiroc": "boolean",
  "isOfficerOfPublicCompany": "boolean",
  "isOwnerOfPublicCompany": "boolean",
  "issuerExchange": "object",
  "issuerName": "object",
  "issuerTicker": "object",
  "jobTitle": "object",
  "lastName": "object",
  "maritalStatus": "string",
  "middleName": "object",
  "parentCompanyName": "object",
  "payTaxesOutsideCanada": "boolean",
  "phone": "object",
  "physicalAddress": {
    "city": "object",
    "country": "string",
    "houseNumber": "object",
    "jurisdiction": "string",
    "neighborhood": "object",
    "postal": "object",
    "province": "string"
  }
}

UpdateAffiliateResponse: object

Type definition for updating an "affiliate only" user

user:
object

User object

return:
arguments:
object
Example
{
  "user": {
    "return": {
      "accessibleBy": {
        "return": [
          {
            "displayOptions": {
              "return": {
                "hide": {
                  "return": "boolean",
                  "arguments": {}
                },
                "order": {
                  "return": "number",
                  "arguments": {}
                }
              },
              "arguments": {}
            },
            "organizationUser": {
              "return": {
                "accessType": {
                  "return": "string",
                  "arguments": {}
                },
                "apiTokens": {
                  "return": [
                    {
                      "id": {
                        "return": "object",
                        "arguments": {}
                      },
                      "jwtToken": {
                        "return": "string",
                        "arguments": {}
                      },
                      "name": {
                        "return": "string",
                        "arguments": {}
                      },
                      "organization": {
                        "return": {
                          "browserTabTitle": {
                            "return": "string",
                            "arguments": {}
                          },
                          "faviconLink": {
                            "return": "string",
                            "arguments": {}
                          },
                          "id": {
                            "return": "object",
                            "arguments": {}
                          },
                          "name": {
                            "return": "string",
                            "arguments": {}
                          },
                          "parent": {
                            "return": {
                              "browserTabTitle": {
                                "return": "string",
                                "arguments": {}
                              },
                              "faviconLink": {
                                "return": "string",
                                "arguments": {}
                              },
                              "id": {
                                "return": "object",
                                "arguments": {}
                              },
                              "name": {
                                "return": "string",
                                "arguments": {}
                              },
                              "parent": {
                                "return": {
                                  "browserTabTitle": {
                                    "return": "string",
                                    "arguments": {}
                                  },
                                  "faviconLink": {
                                    "return": "string",
                                    "arguments": {}
                                  },
                                  "id": {
                                    "return": "object",
                                    "arguments": {}
                                  },
                                  "name": {
                                    "return": "string",
                                    "arguments": {}
                                  }
                                }
                              }
                            }
                          }
                        }
                      }
                    }
                  ]
                }
              }
            }
          }
        ]
      }
    }
  }
}

UpdateAffiliationsInput: object

accountId:
affiliations:
AffiliationInput
Example
{
  "accountId": "object",
  "affiliations": [
    {
      "allocation": "number",
      "id": "object",
      "relation": "string",
      "signatureRequired": "boolean",
      "type": "string",
      "userId": "object"
    }
  ]
}

UpdateAffiliationsResponse: object

account:
object
return:
arguments:
object
incompleteAffiliations:
object
return:
IncompleteAffiliation
arguments:
object
Example
{
  "account": {
    "return": {
      "affiliations": {
        "return": [
          {
            "allocation": {
              "return": "number",
              "arguments": {}
            },
            "id": {
              "return": "object",
              "arguments": {}
            },
            "relation": {
              "return": "string",
              "arguments": {}
            },
            "signatureRequired": {
              "return": "boolean",
              "arguments": {}
            },
            "type": {
              "return": "string",
              "arguments": {}
            },
            "user": {
              "return": {
                "accessibleBy": {
                  "return": [
                    {
                      "displayOptions": {
                        "return": {
                          "hide": {
                            "return": "boolean",
                            "arguments": {}
                          },
                          "order": {
                            "return": "number",
                            "arguments": {}
                          }
                        },
                        "arguments": {}
                      },
                      "organizationUser": {
                        "return": {
                          "accessType": {
                            "return": "string",
                            "arguments": {}
                          },
                          "apiTokens": {
                            "return": [
                              {
                                "id": {
                                  "return": "object",
                                  "arguments": {}
                                },
                                "jwtToken": {
                                  "return": "string",
                                  "arguments": {}
                                },
                                "name": {
                                  "return": "string",
                                  "arguments": {}
                                },
                                "organization": {
                                  "return": {
                                    "browserTabTitle": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "faviconLink": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "id": {
                                      "return": "object",
                                      "arguments": {}
                                    },
                                    "name": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "parent": {
                                      "return": {
                                        "browserTabTitle": {
                                          "return": "string",
                                          "arguments": {}
                                        },
                                        "faviconLink": {
                                          "return": "string",
                                          "arguments": {}
                                        }
                                      }
                                    }
                                  }
                                }
                              }
                            ]
                          }
                        }
                      }
                    }
                  ]
                }
              }
            }
          }
        ]
      }
    }
  }
}

UpdateAllHoldingsAndCashInput: object

organizationId:
Example
{
  "organizationId": "object"
}

UpdateAllHoldingsAndCashResponse: object

success:
object
return:
arguments:
object
Example
{
  "success": {
    "return": "boolean",
    "arguments": {}
  }
}

UpdateApiTokenInput: object

apiTokenId:
name:
permissions:
SafeString
whitelistAddresses:
SafeString
Example
{
  "apiTokenId": "object",
  "name": "object",
  "permissions": [
    "object"
  ],
  "whitelistAddresses": [
    "object"
  ]
}

UpdateApiTokenResponse: object

apiToken:
object
return:
arguments:
object
Example
{
  "apiToken": {
    "return": {
      "id": {
        "return": "object",
        "arguments": {}
      },
      "jwtToken": {
        "return": "string",
        "arguments": {}
      },
      "name": {
        "return": "string",
        "arguments": {}
      },
      "organization": {
        "return": {
          "browserTabTitle": {
            "return": "string",
            "arguments": {}
          },
          "faviconLink": {
            "return": "string",
            "arguments": {}
          },
          "id": {
            "return": "object",
            "arguments": {}
          },
          "name": {
            "return": "string",
            "arguments": {}
          },
          "parent": {
            "return": {
              "browserTabTitle": {
                "return": "string",
                "arguments": {}
              },
              "faviconLink": {
                "return": "string",
                "arguments": {}
              },
              "id": {
                "return": "object",
                "arguments": {}
              },
              "name": {
                "return": "string",
                "arguments": {}
              },
              "parent": {
                "return": {
                  "browserTabTitle": {
                    "return": "string",
                    "arguments": {}
                  },
                  "faviconLink": {
                    "return": "string",
                    "arguments": {}
                  },
                  "id": {
                    "return": "object",
                    "arguments": {}
                  },
                  "name": {
                    "return": "string",
                    "arguments": {}
                  },
                  "parent": {
                    "return": {
                      "browserTabTitle": {
                        "return": "string",
                        "arguments": {}
                      },
                      "faviconLink": {
                        "return": "string",
                        "arguments": {}
                      },
                      "id": {
                        "return": "object",
                        "arguments": {}
                      },
                      "name": {
                        "return": "string",
                        "arguments": {}
                      },
                      "parent": {
                        "return": {
                          "browserTabTitle": {
                            "return": "string",
                            "arguments": {}
                          },
                          "faviconLink": {}
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

UpdateArticleInput: object

articleId:
articleUrl:
translatedDescription:
translatedName:
Example
{
  "articleId": "object",
  "articleUrl": "object",
  "translatedDescription": {
    "en": "object",
    "fr": "object"
  },
  "translatedName": {
    "en": "object",
    "fr": "object"
  }
}

UpdateArticleResponse: object

article:
object
return:
arguments:
object
Example
{
  "article": {
    "return": {
      "articleUrl": {
        "return": "object",
        "arguments": {}
      },
      "createdAt": {
        "return": "object",
        "arguments": {}
      },
      "createdBy": {
        "return": {
          "email": {
            "return": "string",
            "arguments": {}
          },
          "firstName": {
            "return": "string",
            "arguments": {}
          },
          "id": {
            "return": "object",
            "arguments": {}
          },
          "language": {
            "return": "string",
            "arguments": {}
          },
          "lastName": {
            "return": "string",
            "arguments": {}
          },
          "organization": {
            "return": {
              "browserTabTitle": {
                "return": "string",
                "arguments": {}
              },
              "faviconLink": {
                "return": "string",
                "arguments": {}
              },
              "id": {
                "return": "object",
                "arguments": {}
              },
              "name": {
                "return": "string",
                "arguments": {}
              },
              "parent": {
                "return": {
                  "browserTabTitle": {
                    "return": "string",
                    "arguments": {}
                  },
                  "faviconLink": {
                    "return": "string",
                    "arguments": {}
                  },
                  "id": {
                    "return": "object",
                    "arguments": {}
                  },
                  "name": {
                    "return": "string",
                    "arguments": {}
                  },
                  "parent": {
                    "return": {
                      "browserTabTitle": {
                        "return": "string",
                        "arguments": {}
                      },
                      "faviconLink": {
                        "return": "string",
                        "arguments": {}
                      },
                      "id": {
                        "return": "object",
                        "arguments": {}
                      },
                      "name": {
                        "return": "string",
                        "arguments": {}
                      },
                      "parent": {
                        "return": {
                          "browserTabTitle": {
                            "return": "string",
                            "arguments": {}
                          },
                          "faviconLink": {}
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

UpdateAssetClassInput: object

assetClassId:
includeCash:
key:
translatedDescription:
translatedName:
Example
{
  "assetClassId": "object",
  "includeCash": "boolean",
  "key": "object",
  "translatedDescription": {
    "en": "object",
    "fr": "object"
  },
  "translatedName": {
    "en": "object",
    "fr": "object"
  }
}

UpdateAssetClassResponse: object

assetClass:
object
return:
arguments:
object
Example
{
  "assetClass": {
    "return": {
      "description": {
        "return": "string",
        "arguments": {}
      },
      "id": {
        "return": "object",
        "arguments": {}
      },
      "includeCash": {
        "return": "boolean",
        "arguments": {}
      },
      "key": {
        "return": "string",
        "arguments": {}
      },
      "name": {
        "return": "string",
        "arguments": {}
      },
      "state": {
        "return": "string",
        "arguments": {}
      },
      "translatedDescription": {
        "return": {
          "en": {
            "return": "string",
            "arguments": {}
          },
          "fr": {
            "return": "string",
            "arguments": {}
          }
        },
        "arguments": {}
      },
      "translatedName": {
        "return": {
          "en": {
            "return": "string",
            "arguments": {}
          },
          "fr": {
            "return": "string",
            "arguments": {}
          }
        },
        "arguments": {}
      }
    },
    "arguments": {}
  }
}

UpdateBankAccountInput: object

bankAccountId:
name:
Example
{
  "bankAccountId": "object",
  "name": "string"
}

UpdateBankAccountResponse: object

bankAccount:
object
return:
arguments:
object
Example
{
  "bankAccount": {
    "return": {
      "EftEligibleRatio": {
        "return": "number",
        "arguments": {}
      },
      "bankAccountNumber": {
        "return": "string",
        "arguments": {}
      },
      "bankAccountNumberDisclosed": {
        "return": "string",
        "arguments": {}
      },
      "createdAt": {
        "return": "object",
        "arguments": {}
      },
      "downloadUrls": {
        "return": [
          "string"
        ],
        "arguments": {}
      },
      "id": {
        "return": "object",
        "arguments": {}
      },
      "institutionNumber": {
        "return": "string",
        "arguments": {}
      },
      "name": {
        "return": "string",
        "arguments": {}
      },
      "source": {
        "return": "string",
        "arguments": {}
      },
      "state": {
        "return": "string",
        "arguments": {}
      },
      "stateChanges": {
        "return": [
          "object"
        ],
        "arguments": {}
      },
      "transitNumber": {
        "return": "string",
        "arguments": {}
      },
      "transitNumberDisclosed": {
        "return": "string",
        "arguments": {}
      },
      "updatedAt": {
        "return": "object",
        "arguments": {}
      },
      "user": {
        "return": {
          "accessibleBy": {
            "return": [
              {
                "displayOptions": {
                  "return": {
                    "hide": {
                      "return": "boolean",
                      "arguments": {}
                    },
                    "order": {
                      "return": "number",
                      "arguments": {}
                    }
                  },
                  "arguments": {}
                },
                "organizationUser": {
                  "return": {
                    "accessType": {
                      "return": "string",
                      "arguments": {}
                    },
                    "apiTokens": {
                      "return": [
                        {
                          "id": {
                            "return": "object",
                            "arguments": {}
                          },
                          "jwtToken": {
                            "return": "string",
                            "arguments": {}
                          }
                        }
                      ]
                    }
                  }
                }
              }
            ]
          }
        }
      }
    }
  }
}

UpdateBeneficiaryInput: object

allocation:
beneficiaryId:
name:
relation:
successorAddress:
type:
Example
{
  "allocation": "number",
  "beneficiaryId": "object",
  "name": "object",
  "relation": "string",
  "successorAddress": {
    "city": "object",
    "country": "string",
    "houseNumber": "object",
    "neighborhood": "object",
    "postal": "object",
    "province": "string",
    "streetName": "object",
    "unitNumber": "object"
  },
  "type": "string"
}

UpdateBeneficiaryResponse: object

beneficiary:
object
return:
arguments:
object
Example
{
  "beneficiary": {
    "return": {
      "account": {
        "return": {
          "affiliations": {
            "return": [
              {
                "allocation": {
                  "return": "number",
                  "arguments": {}
                },
                "id": {
                  "return": "object",
                  "arguments": {}
                },
                "relation": {
                  "return": "string",
                  "arguments": {}
                },
                "signatureRequired": {
                  "return": "boolean",
                  "arguments": {}
                },
                "type": {
                  "return": "string",
                  "arguments": {}
                },
                "user": {
                  "return": {
                    "accessibleBy": {
                      "return": [
                        {
                          "displayOptions": {
                            "return": {
                              "hide": {
                                "return": "boolean",
                                "arguments": {}
                              },
                              "order": {
                                "return": "number",
                                "arguments": {}
                              }
                            },
                            "arguments": {}
                          },
                          "organizationUser": {
                            "return": {
                              "accessType": {
                                "return": "string",
                                "arguments": {}
                              },
                              "apiTokens": {
                                "return": [
                                  {
                                    "id": {
                                      "return": "object",
                                      "arguments": {}
                                    },
                                    "jwtToken": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "name": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "organization": {
                                      "return": {
                                        "browserTabTitle": {
                                          "return": "string",
                                          "arguments": {}
                                        },
                                        "faviconLink": {
                                          "return": "string",
                                          "arguments": {}
                                        },
                                        "id": {
                                          "return": "object",
                                          "arguments": {}
                                        },
                                        "name": {
                                          "return": "string",
                                          "arguments": {}
                                        },
                                        "parent": {
                                          "return": {
                                            "browserTabTitle": {
                                              "return": "string",
                                              "arguments": {}
                                            },
                                            "faviconLink": {}
                                          }
                                        }
                                      }
                                    }
                                  }
                                ]
                              }
                            }
                          }
                        }
                      ]
                    }
                  }
                }
              }
            ]
          }
        }
      }
    }
  }
}

UpdateBillingScheduleInput: object

billingScheduleId:
default:
endDate:
frequency:
nextBillingDate:
nextCalculationDate:
startDate:
Example
{
  "billingScheduleId": "object",
  "default": "boolean",
  "endDate": "object",
  "frequency": "string",
  "nextBillingDate": "object",
  "nextCalculationDate": "object",
  "startDate": "object"
}

UpdateBillingScheduleResponse: object

billingSchedule:
object
return:
arguments:
object
Example
{
  "billingSchedule": {
    "return": {
      "createdAt": {
        "return": "object",
        "arguments": {}
      },
      "default": {
        "return": "boolean",
        "arguments": {}
      },
      "endDate": {
        "return": "object",
        "arguments": {}
      },
      "frequency": {
        "return": "string",
        "arguments": {}
      },
      "id": {
        "return": "object",
        "arguments": {}
      },
      "nextBillingDate": {
        "return": "object",
        "arguments": {}
      },
      "nextCalculationDate": {
        "return": "object",
        "arguments": {}
      },
      "organization": {
        "return": {
          "browserTabTitle": {
            "return": "string",
            "arguments": {}
          },
          "faviconLink": {
            "return": "string",
            "arguments": {}
          },
          "id": {
            "return": "object",
            "arguments": {}
          },
          "name": {
            "return": "string",
            "arguments": {}
          },
          "parent": {
            "return": {
              "browserTabTitle": {
                "return": "string",
                "arguments": {}
              },
              "faviconLink": {
                "return": "string",
                "arguments": {}
              },
              "id": {
                "return": "object",
                "arguments": {}
              },
              "name": {
                "return": "string",
                "arguments": {}
              },
              "parent": {
                "return": {
                  "browserTabTitle": {
                    "return": "string",
                    "arguments": {}
                  },
                  "faviconLink": {
                    "return": "string",
                    "arguments": {}
                  },
                  "id": {
                    "return": "object",
                    "arguments": {}
                  },
                  "name": {
                    "return": "string",
                    "arguments": {}
                  },
                  "parent": {
                    "return": {
                      "browserTabTitle": {
                        "return": "string",
                        "arguments": {}
                      },
                      "faviconLink": {
                        "return": "string",
                        "arguments": {}
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

UpdateBulkImportInput: object

bulkImportId:
name:
sequencedImportFiles:
ObjectID
Example
{
  "bulkImportId": "object",
  "name": "object",
  "sequencedImportFiles": [
    "object"
  ]
}

UpdateBulkImportResponse: object

bulkImport:
object
return:
arguments:
object
Example
{
  "bulkImport": {
    "return": {
      "createdAt": {
        "return": "object",
        "arguments": {}
      },
      "id": {
        "return": "object",
        "arguments": {}
      },
      "name": {
        "return": "string",
        "arguments": {}
      },
      "organization": {
        "return": {
          "browserTabTitle": {
            "return": "string",
            "arguments": {}
          },
          "faviconLink": {
            "return": "string",
            "arguments": {}
          },
          "id": {
            "return": "object",
            "arguments": {}
          },
          "name": {
            "return": "string",
            "arguments": {}
          },
          "parent": {
            "return": {
              "browserTabTitle": {
                "return": "string",
                "arguments": {}
              },
              "faviconLink": {
                "return": "string",
                "arguments": {}
              },
              "id": {
                "return": "object",
                "arguments": {}
              },
              "name": {
                "return": "string",
                "arguments": {}
              },
              "parent": {
                "return": {
                  "browserTabTitle": {
                    "return": "string",
                    "arguments": {}
                  },
                  "faviconLink": {
                    "return": "string",
                    "arguments": {}
                  },
                  "id": {
                    "return": "object",
                    "arguments": {}
                  },
                  "name": {
                    "return": "string",
                    "arguments": {}
                  },
                  "parent": {
                    "return": {
                      "browserTabTitle": {
                        "return": "string",
                        "arguments": {}
                      },
                      "faviconLink": {
                        "return": "string",
                        "arguments": {}
                      },
                      "id": {
                        "return": "object",
                        "arguments": {}
                      },
                      "name": {
                        "return": "string",
                        "arguments": {}
                      },
                      "parent": {
                        "return": {
                          "browserTabTitle": {
                            "return": "string",
                            "arguments": {}
                          },
                          "faviconLink": {}
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

UpdateBulkTradeRequestInput: object

bulkTradeRequestId:
source:
sourceId:
Example
{
  "bulkTradeRequestId": "object",
  "source": "string",
  "sourceId": "object"
}

UpdateBulkTradeRequestResponse: object

bulkTradeRequest:
object
return:
arguments:
object
Example
{
  "bulkTradeRequest": {
    "return": {
      "createdAt": {
        "return": "object",
        "arguments": {}
      },
      "id": {
        "return": "object",
        "arguments": {}
      },
      "source": {
        "return": "string",
        "arguments": {}
      },
      "sourceId": {
        "return": "object",
        "arguments": {}
      },
      "state": {
        "return": "string",
        "arguments": {}
      },
      "stateChanges": {
        "return": [
          "object"
        ],
        "arguments": {}
      },
      "updatedAt": {
        "return": "object",
        "arguments": {}
      }
    },
    "arguments": {}
  }
}

UpdateClientGroupInput: object

accountNumber:
billingScheduleId:
businessIsMemberOfIiroc:
businessType:

Corporate Business Type

clientGroupId:

ClientGroupId associated with the ClientGroup which is updating

corporationCountry:
establishedDate:
feeTierId:
incorporationNumber:
integrations:
ClientGroupIntegrationInput
name:

ClientGroup name to be update

phone:
physicalAddress:
primaryEmail:
primaryUserId:
relationships:
RelationshipInput

clientGroup relationships

taxNumber:
type:

ClientGroup type to be update

Example
{
  "accountNumber": "object",
  "billingScheduleId": "object",
  "businessIsMemberOfIiroc": "boolean",
  "businessType": "string",
  "clientGroupId": "object",
  "corporationCountry": "string",
  "establishedDate": "object",
  "feeTierId": "object",
  "incorporationNumber": "object",
  "integrations": [
    {
      "externalId": "object",
      "groupId": "object",
      "iid": "object",
      "type": "string"
    }
  ],
  "name": "object",
  "phone": "object",
  "physicalAddress": {
    "city": "object",
    "country": "string",
    "houseNumber": "object",
    "jurisdiction": "string",
    "neighborhood": "object",
    "postal": "object",
    "province": "string",
    "streetName": "object",
    "unitNumber": "object"
  },
  "primaryEmail": "object",
  "primaryUserId": "object",
  "relationships": [
    {
      "accessType": "string",
      "type": "object",
      "userId": "object"
    }
  ],
  "taxNumber": "object",
  "type": "string"
}

UpdateClientGroupOrganizationInput: object

Input type for Updating a clientGroup Organization

clientGroupId:

ClientGroupID

newOrganizationId:

New OrganizationID

Example
{
  "clientGroupId": "object",
  "newOrganizationId": "object"
}

UpdateClientGroupOrganizationResponse: object

clientGroup:
object
return:
arguments:
object
Example
{
  "clientGroup": {
    "return": {
      "accountNumber": {
        "return": "string",
        "arguments": {}
      },
      "accounts": {
        "return": [
          {
            "affiliations": {
              "return": [
                {
                  "allocation": {
                    "return": "number",
                    "arguments": {}
                  },
                  "id": {
                    "return": "object",
                    "arguments": {}
                  },
                  "relation": {
                    "return": "string",
                    "arguments": {}
                  },
                  "signatureRequired": {
                    "return": "boolean",
                    "arguments": {}
                  },
                  "type": {
                    "return": "string",
                    "arguments": {}
                  },
                  "user": {
                    "return": {
                      "accessibleBy": {
                        "return": [
                          {
                            "displayOptions": {
                              "return": {
                                "hide": {
                                  "return": "boolean",
                                  "arguments": {}
                                },
                                "order": {
                                  "return": "number",
                                  "arguments": {}
                                }
                              },
                              "arguments": {}
                            },
                            "organizationUser": {
                              "return": {
                                "accessType": {
                                  "return": "string",
                                  "arguments": {}
                                },
                                "apiTokens": {
                                  "return": [
                                    {
                                      "id": {
                                        "return": "object",
                                        "arguments": {}
                                      },
                                      "jwtToken": {
                                        "return": "string",
                                        "arguments": {}
                                      },
                                      "name": {
                                        "return": "string",
                                        "arguments": {}
                                      },
                                      "organization": {
                                        "return": {
                                          "browserTabTitle": {
                                            "return": "string",
                                            "arguments": {}
                                          },
                                          "faviconLink": {
                                            "return": "string",
                                            "arguments": {}
                                          },
                                          "id": {
                                            "return": "object",
                                            "arguments": {}
                                          },
                                          "name": {
                                            "return": "string",
                                            "arguments": {}
                                          },
                                          "parent": {
                                            "return": {}
                                          }
                                        }
                                      }
                                    }
                                  ]
                                }
                              }
                            }
                          }
                        ]
                      }
                    }
                  }
                }
              ]
            }
          }
        ]
      }
    }
  }
}

UpdateClientGroupResponse: object

UpdateClientGroup Response

clientGroup:
object

clientGroup object

return:
arguments:
object
Example
{
  "clientGroup": {
    "return": {
      "accountNumber": {
        "return": "string",
        "arguments": {}
      },
      "accounts": {
        "return": [
          {
            "affiliations": {
              "return": [
                {
                  "allocation": {
                    "return": "number",
                    "arguments": {}
                  },
                  "id": {
                    "return": "object",
                    "arguments": {}
                  },
                  "relation": {
                    "return": "string",
                    "arguments": {}
                  },
                  "signatureRequired": {
                    "return": "boolean",
                    "arguments": {}
                  },
                  "type": {
                    "return": "string",
                    "arguments": {}
                  },
                  "user": {
                    "return": {
                      "accessibleBy": {
                        "return": [
                          {
                            "displayOptions": {
                              "return": {
                                "hide": {
                                  "return": "boolean",
                                  "arguments": {}
                                },
                                "order": {
                                  "return": "number",
                                  "arguments": {}
                                }
                              },
                              "arguments": {}
                            },
                            "organizationUser": {
                              "return": {
                                "accessType": {
                                  "return": "string",
                                  "arguments": {}
                                },
                                "apiTokens": {
                                  "return": [
                                    {
                                      "id": {
                                        "return": "object",
                                        "arguments": {}
                                      },
                                      "jwtToken": {
                                        "return": "string",
                                        "arguments": {}
                                      },
                                      "name": {
                                        "return": "string",
                                        "arguments": {}
                                      },
                                      "organization": {
                                        "return": {
                                          "browserTabTitle": {
                                            "return": "string",
                                            "arguments": {}
                                          },
                                          "faviconLink": {
                                            "return": "string",
                                            "arguments": {}
                                          },
                                          "id": {
                                            "return": "object",
                                            "arguments": {}
                                          },
                                          "name": {
                                            "return": "string",
                                            "arguments": {}
                                          },
                                          "parent": {
                                            "return": {}
                                          }
                                        }
                                      }
                                    }
                                  ]
                                }
                              }
                            }
                          }
                        ]
                      }
                    }
                  }
                }
              ]
            }
          }
        ]
      }
    }
  }
}

UpdateClientReportTemplateInput: object

isStatementOfType:
objectType:
reportType:
s3key:
schedulerDayOfMonthOrWeek:
Int
schedulerEnableNotification:
schedulerFrequency:
schedulerTriggerRules:
ClientReportTriggerRuleInput
templateParameters:
SafeString
translatedDescription:
translatedName:
type:
Example
{
  "isStatementOfType": "string",
  "objectType": "string",
  "reportType": "string",
  "s3key": {
    "en": "object",
    "fr": "object"
  },
  "schedulerDayOfMonthOrWeek": "number",
  "schedulerEnableNotification": "boolean",
  "schedulerFrequency": "string",
  "schedulerTriggerRules": [
    {
      "comparison": "string",
      "field": "object",
      "value": "object"
    }
  ],
  "templateParameters": [
    "object"
  ],
  "translatedDescription": {
    "en": "object",
    "fr": "object"
  },
  "translatedName": {
    "en": "object",
    "fr": "object"
  },
  "type": "object"
}

UpdateClientReportTemplatePageConfigurationInput: object

clientReportTemplatePageConfigurationId:
options:
widgets:
ClientReportTemplateWidgetConfigurationInput
Example
{
  "clientReportTemplatePageConfigurationId": "object",
  "options": "object",
  "widgets": [
    {
      "options": "object",
      "type": "string"
    }
  ]
}

UpdateClientReportTemplatePageConfigurationResponse: object

clientReportTemplatePageConfiguration:
object
return:
arguments:
object
Example
{
  "clientReportTemplatePageConfiguration": {
    "return": {
      "clientReportTemplate": {
        "return": {
          "clientReportTemplatePageConfiguration": {
            "return": {
              "clientReportTemplate": {
                "return": {
                  "clientReportTemplatePageConfiguration": {
                    "return": {
                      "clientReportTemplate": {
                        "return": {
                          "clientReportTemplatePageConfiguration": {
                            "return": {
                              "clientReportTemplate": {
                                "return": {
                                  "clientReportTemplatePageConfiguration": {
                                    "return": {
                                      "clientReportTemplate": {
                                        "return": {
                                          "clientReportTemplatePageConfiguration": {
                                            "return": {
                                              "clientReportTemplate": {
                                                "return": {
                                                  "clientReportTemplatePageConfiguration": {
                                                    "return": {
                                                      "clientReportTemplate": {
                                                        "return": {
                                                          "clientReportTemplatePageConfiguration": {
                                                            "return": {
                                                              "clientReportTemplate": {
                                                                "return": {
                                                                  "clientReportTemplatePageConfiguration": {
                                                                    "return": {
                                                                      "clientReportTemplate": {
                                                                        "return": {
                                                                          "clientReportTemplatePageConfiguration": {
                                                                            "return": {
                                                                              "clientReportTemplate": {
                                                                                "return": {
                                                                                  "clientReportTemplatePageConfiguration": {
                                                                                    "return": {
                                                                                      "clientReportTemplate": {
                                                                                        "return": {
                                                                                          "clientReportTemplatePageConfiguration": {
                                                                                            "return": {
                                                                                              "clientReportTemplate": {
                                                                                                "return": {
                                                                                                  "clientReportTemplatePageConfiguration": {
                                                                                                    "return": {
                                                                                                      "clientReportTemplate": {
                                                                                                        "return": {
                                                                                                          "clientReportTemplatePageConfiguration": {
                                                                                                            "return": {
                                                                                                              "clientReportTemplate": {
                                                                                                                "return": {
                                                                                                                  "clientReportTemplatePageConfiguration": {
                                                                                                                    "return": {
                                                                                                                      "clientReportTemplate": {
                                                                                                                        "return": {
                                                                                                                          "clientReportTemplatePageConfiguration": {
                                                                                                                            "return": {
                                                                                                                              "clientReportTemplate": {
                                                                                                                                "return": {
                                                                                                                                  "clientReportTemplatePageConfiguration": {
                                                                                                                                    "return": {}
                                                                                                                                  }
                                                                                                                                }
                                                                                                                              }
                                                                                                                            }
                                                                                                                          }
                                                                                                                        }
                                                                                                                      }
                                                                                                                    }
                                                                                                                  }
                                                                                                                }
                                                                                                              }
                                                                                                            }
                                                                                                          }
                                                                                                        }
                                                                                                      }
                                                                                                    }
                                                                                                  }
                                                                                                }
                                                                                              }
                                                                                            }
                                                                                          }
                                                                                        }
                                                                                      }
                                                                                    }
                                                                                  }
                                                                                }
                                                                              }
                                                                            }
                                                                          }
                                                                        }
                                                                      }
                                                                    }
                                                                  }
                                                                }
                                                              }
                                                            }
                                                          }
                                                        }
                                                      }
                                                    }
                                                  }
                                                }
                                              }
                                            }
                                          }
                                        }
                                      }
                                    }
                                  }
                                }
                              }
                            }
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

UpdateCountryRiskInput: object

country:
countryCode:
countryRiskId:
disabled:
riskRating:
Example
{
  "country": "object",
  "countryCode": "object",
  "countryRiskId": "object",
  "disabled": "boolean",
  "riskRating": "string"
}

UpdateCountryRiskResponse: object

countryRisk:
object
return:
arguments:
object
Example
{
  "countryRisk": {
    "return": {
      "country": {
        "return": "object",
        "arguments": {}
      },
      "countryCode": {
        "return": "object",
        "arguments": {}
      },
      "disabled": {
        "return": "boolean",
        "arguments": {}
      },
      "id": {
        "return": "object",
        "arguments": {}
      },
      "riskRating": {
        "return": "string",
        "arguments": {}
      }
    },
    "arguments": {}
  }
}

UpdateCustodianConnectionInput: object

accountOpenningSubmissionType:
accountTypeSettings:
AccountTypeSettingsInput
allowFractionalTrading:
allowTransactionCreation:
baseCurrency:
config:
custodianActivityImportFilePaths:
SafeString
custodianConnectionId:
custodianSnapshotImportFilePaths:
SafeString
custodianUsersImportFilePath:
customerName:
default:
disabledFlagTypes:
String
enableAccountOpeningSubmission:
enableAutoReconcileActivities:
enableAutoReconcilePositions:
enableCustodianAccountImport:
enableCustodianActivityImport:
enableCustodianOrganizationImport:
enableCustodianOrganizationUserImport:
enableCustodianSnapshotImport:
enableCustodianUserImport:
enableFetchCustodianAffiliates:
enableFetchCustodianCustomFields:
enableFetchCustodianProjectedIncome:
enableFetchCustodianSnapshotHistory:
enableFetchCustodianStatements:
enableFetchCustodianStatistics:
enableFetchCustodianSuitability:
enableFetchCustodianTransactions:
enableFetchCustodianUpcomingTransactions:
enableTransferSubmission:
fetchLivePrices:
inventoryAccountId:
moneyAccountId:
name:
notificationEmails:
SafeString
reconciliationType:
repCode:
sftpCredentials:
transferSubmissionType:
Example
{
  "accountOpenningSubmissionType": "string",
  "accountTypeSettings": [
    {
      "availableCurrencies": [
        "string"
      ],
      "baseCurrency": "string",
      "isAutoSweepEnabled": "boolean",
      "isMultiCurrencyEnabled": "boolean",
      "type": "string"
    }
  ],
  "allowFractionalTrading": "boolean",
  "allowTransactionCreation": "boolean",
  "baseCurrency": "string",
  "config": "object",
  "custodianActivityImportFilePaths": [
    "object"
  ],
  "custodianConnectionId": "object",
  "custodianSnapshotImportFilePaths": [
    "object"
  ],
  "custodianUsersImportFilePath": "object",
  "customerName": "object",
  "default": "boolean",
  "disabledFlagTypes": [
    "string"
  ],
  "enableAccountOpeningSubmission": "boolean",
  "enableAutoReconcileActivities": "boolean",
  "enableAutoReconcilePositions": "boolean",
  "enableCustodianAccountImport": "boolean",
  "enableCustodianActivityImport": "boolean",
  "enableCustodianOrganizationImport": "boolean",
  "enableCustodianOrganizationUserImport": "boolean",
  "enableCustodianSnapshotImport": "boolean",
  "enableCustodianUserImport": "boolean",
  "enableFetchCustodianAffiliates": "boolean",
  "enableFetchCustodianCustomFields": "boolean",
  "enableFetchCustodianProjectedIncome": "boolean",
  "enableFetchCustodianSnapshotHistory": "boolean",
  "enableFetchCustodianStatements": "boolean",
  "enableFetchCustodianStatistics": "boolean",
  "enableFetchCustodianSuitability": "boolean",
  "enableFetchCustodianTransactions": "boolean",
  "enableFetchCustodianUpcomingTransactions": "boolean",
  "enableTransferSubmission": "boolean",
  "fetchLivePrices": "boolean",
  "inventoryAccountId": "object",
  "moneyAccountId": "object",
  "name": "object",
  "notificationEmails": [
    "object"
  ],
  "reconciliationType": "string",
  "repCode": "object",
  "sftpCredentials": {
    "sftpInBucket": "string"
  }
}

UpdateCustodianConnectionResponse: object

custodianConnection:
object
return:
arguments:
object
Example
{
  "custodianConnection": {
    "return": {
      "accountOpenningSubmissionType": {
        "return": "string",
        "arguments": {}
      },
      "accountTypeSettings": {
        "return": [
          {
            "availableCurrencies": {
              "return": [
                "string"
              ],
              "arguments": {}
            },
            "baseCurrency": {
              "return": "string",
              "arguments": {}
            },
            "id": {
              "return": "object",
              "arguments": {}
            },
            "isAutoSweepEnabled": {
              "return": "boolean",
              "arguments": {}
            },
            "isMultiCurrencyEnabled": {
              "return": "boolean",
              "arguments": {}
            },
            "type": {
              "return": "string",
              "arguments": {}
            }
          }
        ],
        "arguments": {}
      },
      "allowFractionalTrading": {
        "return": "boolean",
        "arguments": {}
      },
      "allowTransactionCreation": {
        "return": "boolean",
        "arguments": {}
      },
      "baseCurrency": {
        "return": "string",
        "arguments": {}
      },
      "config": {
        "return": "object",
        "arguments": {}
      },
      "custodianActivityImportFilePaths": {
        "return": [
          "string"
        ],
        "arguments": {}
      },
      "custodianSnapshotImportFilePaths": {
        "return": [
          "object"
        ],
        "arguments": {}
      },
      "custodianUsersImportFilePath": {
        "return": "object",
        "arguments": {}
      },
      "customerName": {
        "return": "string",
        "arguments": {}
      },
      "default": {
        "return": "boolean",
        "arguments": {}
      },
      "disabledFlagTypes": {
        "return": [
          "string"
        ],
        "arguments": {}
      },
      "enableAccountOpeningSubmission": {
        "return": "boolean",
        "arguments": {}
      },
      "enableAutoReconcileActivities": {
        "return": "boolean",
        "arguments": {}
      },
      "enableAutoReconcilePositions": {
        "return": "boolean",
        "arguments": {}
      },
      "enableCustodianAccountImport": {
        "return": "boolean",
        "arguments": {}
      },
      "enableCustodianActivityImport": {
        "return": "boolean"
      }
    }
  }
}

UpdateCustodianInput: object

custodianId:
customerName:
inventoryAccountId:
moneyAccountId:
name:
notificationEmails:
SafeString
repCode:
sftpInBucket:
sftpOutBucket:
Example
{
  "custodianId": "object",
  "customerName": "object",
  "inventoryAccountId": "object",
  "moneyAccountId": "object",
  "name": "object",
  "notificationEmails": [
    "object"
  ],
  "repCode": "object",
  "sftpInBucket": "object",
  "sftpOutBucket": "object"
}

UpdateCustodianResponse: object

custodian:
object
return:
arguments:
object
Example
{
  "custodian": {
    "return": {
      "customerName": {
        "return": "string",
        "arguments": {}
      },
      "id": {
        "return": "object",
        "arguments": {}
      },
      "inventoryAccount": {
        "return": {
          "affiliations": {
            "return": [
              {
                "allocation": {
                  "return": "number",
                  "arguments": {}
                },
                "id": {
                  "return": "object",
                  "arguments": {}
                },
                "relation": {
                  "return": "string",
                  "arguments": {}
                },
                "signatureRequired": {
                  "return": "boolean",
                  "arguments": {}
                },
                "type": {
                  "return": "string",
                  "arguments": {}
                },
                "user": {
                  "return": {
                    "accessibleBy": {
                      "return": [
                        {
                          "displayOptions": {
                            "return": {
                              "hide": {
                                "return": "boolean",
                                "arguments": {}
                              },
                              "order": {
                                "return": "number",
                                "arguments": {}
                              }
                            },
                            "arguments": {}
                          },
                          "organizationUser": {
                            "return": {
                              "accessType": {
                                "return": "string",
                                "arguments": {}
                              },
                              "apiTokens": {
                                "return": [
                                  {
                                    "id": {
                                      "return": "object",
                                      "arguments": {}
                                    },
                                    "jwtToken": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "name": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "organization": {
                                      "return": {
                                        "browserTabTitle": {
                                          "return": "string",
                                          "arguments": {}
                                        },
                                        "faviconLink": {
                                          "return": "string",
                                          "arguments": {}
                                        },
                                        "id": {
                                          "return": "object",
                                          "arguments": {}
                                        },
                                        "name": {
                                          "return": "string",
                                          "arguments": {}
                                        }
                                      }
                                    }
                                  }
                                ]
                              }
                            }
                          }
                        }
                      ]
                    }
                  }
                }
              }
            ]
          }
        }
      }
    }
  }
}

UpdateCustomFieldInput: object

conditionalRules:
CustomFieldConditionalRuleInput
customFieldId:
format:
selectOptions:
CustomFieldSelectOptionInput
translatedDescription:
translatedName:
workflowStep:
Example
{
  "conditionalRules": [
    {
      "comparison": "string",
      "field": "object",
      "value": "object"
    }
  ],
  "customFieldId": "object",
  "format": "string",
  "selectOptions": [
    {
      "displayText": {
        "en": "object",
        "fr": "object"
      },
      "value": "object"
    }
  ],
  "translatedDescription": {
    "en": "object",
    "fr": "object"
  },
  "translatedName": {
    "en": "object",
    "fr": "object"
  },
  "workflowStep": "string"
}

UpdateCustomFieldResponse: object

customField:
object
return:
arguments:
object
Example
{
  "customField": {
    "return": {
      "conditionalRules": {
        "return": [
          {
            "comparison": {
              "return": "string",
              "arguments": {}
            },
            "field": {
              "return": "string",
              "arguments": {}
            },
            "value": {
              "return": "string",
              "arguments": {}
            }
          }
        ],
        "arguments": {}
      },
      "externalField": {
        "return": "string",
        "arguments": {}
      },
      "format": {
        "return": "string",
        "arguments": {}
      },
      "id": {
        "return": "object",
        "arguments": {}
      },
      "key": {
        "return": "string",
        "arguments": {}
      },
      "objectType": {
        "return": "string",
        "arguments": {}
      },
      "organization": {
        "return": {
          "browserTabTitle": {
            "return": "string",
            "arguments": {}
          },
          "faviconLink": {
            "return": "string",
            "arguments": {}
          },
          "id": {
            "return": "object",
            "arguments": {}
          },
          "name": {
            "return": "string",
            "arguments": {}
          },
          "parent": {
            "return": {
              "browserTabTitle": {
                "return": "string",
                "arguments": {}
              },
              "faviconLink": {
                "return": "string",
                "arguments": {}
              },
              "id": {
                "return": "object",
                "arguments": {}
              },
              "name": {
                "return": "string",
                "arguments": {}
              },
              "parent": {
                "return": {
                  "browserTabTitle": {
                    "return": "string",
                    "arguments": {}
                  },
                  "faviconLink": {
                    "return": "string",
                    "arguments": {}
                  },
                  "id": {
                    "return": "object",
                    "arguments": {}
                  },
                  "name": {
                    "return": "string",
                    "arguments": {}
                  },
                  "parent": {}
                }
              }
            }
          }
        }
      }
    }
  }
}

UpdateExternalProvidersInput: object

bankingConnectorProvider:
idVerificationProvider:
organizationId:
Example
{
  "bankingConnectorProvider": {
    "clientIframeUrl": "object",
    "customerId": "object",
    "instanceId": "object",
    "vendor": "string"
  },
  "idVerificationProvider": {
    "templateId": "object",
    "vendor": "string"
  },
  "organizationId": "object"
}

UpdateExternalProvidersResponse: object

externalProvider:
object
return:
arguments:
object
Example
{
  "externalProvider": {
    "return": {
      "bankingConnectorProvider": {
        "return": {
          "clientIframeUrl": {
            "return": "string",
            "arguments": {}
          },
          "customerId": {
            "return": "string",
            "arguments": {}
          },
          "instanceId": {
            "return": "string",
            "arguments": {}
          },
          "vendor": {
            "return": "string",
            "arguments": {}
          }
        },
        "arguments": {}
      },
      "id": {
        "return": "object",
        "arguments": {}
      },
      "idVerificationProvider": {
        "return": {
          "templateId": {
            "return": "string",
            "arguments": {}
          },
          "vendor": {
            "return": "string",
            "arguments": {}
          }
        },
        "arguments": {}
      },
      "organization": {
        "return": {
          "accountTypeTaxRanks": {
            "return": [
              {
                "accountType": {
                  "return": "string",
                  "arguments": {}
                },
                "id": {
                  "return": "object",
                  "arguments": {}
                },
                "taxRank": {
                  "return": "number",
                  "arguments": {}
                }
              }
            ],
            "arguments": {}
          },
          "allowAccessToSubOrganizations": {
            "return": "boolean",
            "arguments": {}
          },
          "allowDirectCommunication": {
            "return": "boolean",
            "arguments": {}
          },
          "allowInactiveUserAdjustments": {
            "return": "boolean",
            "arguments": {}
          },
          "allowInactiveUserFeeCalculation": {
            "return": "boolean",
            "arguments": {}
          },
          "allowInactiveUserRebalancing": {
            "return": "boolean",
            "arguments": {}
          },
          "allowInstantInvest": {
            "return": "boolean",
            "arguments": {}
          },
          "allowPortfolioPerGoal": {
            "return": "boolean",
            "arguments": {}
          },
          "allowPostOptimizationEditing": {
            "return": "boolean",
            "arguments": {}
          },
          "allowViewSubTradeRequestPairs": {
            "return": "boolean",
            "arguments": {}
          },
          "applicableJurisdictions": {
            "return": {
              "all": {}
            }
          }
        }
      }
    }
  }
}

UpdateFeeTierInput: object

blendedGrid:
chargeForCash:
chargeForCashOnHold:
default:
discountPercentage:
feeTierId:
flatAnnualFeeBps:
grid:
FeeTierGridInput
gridScopeType:
name:
Example
{
  "blendedGrid": "boolean",
  "chargeForCash": "boolean",
  "chargeForCashOnHold": "boolean",
  "default": "boolean",
  "discountPercentage": "number",
  "feeTierId": "object",
  "flatAnnualFeeBps": "number",
  "grid": [
    {
      "annualFeeBps": "number",
      "annualFeeCents": "object",
      "minMarketValueCents": "object"
    }
  ],
  "gridScopeType": "string",
  "name": "object"
}

UpdateFeeTierResponse: object

feeTier:
object
return:
arguments:
object
Example
{
  "feeTier": {
    "return": {
      "blendedGrid": {
        "return": "boolean",
        "arguments": {}
      },
      "chargeForCash": {
        "return": "boolean",
        "arguments": {}
      },
      "chargeForCashOnHold": {
        "return": "boolean",
        "arguments": {}
      },
      "createdAt": {
        "return": "object",
        "arguments": {}
      },
      "default": {
        "return": "boolean",
        "arguments": {}
      },
      "discountPercentage": {
        "return": "number",
        "arguments": {}
      },
      "flatAnnualFeeBps": {
        "return": "number",
        "arguments": {}
      },
      "grid": {
        "return": [
          {
            "annualFeeBps": {
              "return": "number",
              "arguments": {}
            },
            "annualFeeCents": {
              "return": "object",
              "arguments": {}
            },
            "minMarketValueCents": {
              "return": "object",
              "arguments": {}
            }
          }
        ],
        "arguments": {}
      },
      "gridScopeType": {
        "return": "string",
        "arguments": {}
      },
      "id": {
        "return": "object",
        "arguments": {}
      },
      "name": {
        "return": "string",
        "arguments": {}
      },
      "organization": {
        "return": {
          "browserTabTitle": {
            "return": "string",
            "arguments": {}
          },
          "faviconLink": {
            "return": "string",
            "arguments": {}
          },
          "id": {
            "return": "object",
            "arguments": {}
          },
          "name": {
            "return": "string",
            "arguments": {}
          },
          "parent": {
            "return": {
              "browserTabTitle": {
                "return": "string",
                "arguments": {}
              },
              "faviconLink": {
                "return": "string",
                "arguments": {}
              },
              "id": {
                "return": "object",
                "arguments": {}
              },
              "name": {
                "return": "string",
                "arguments": {}
              },
              "parent": {}
            }
          }
        }
      }
    }
  }
}

UpdateFileDocumentInput: object

fileDocumentId:

fileDocumentId associated with the note which is updating

name:
permissionType:
sharedClient:
sharedCustodian:
Example
{
  "fileDocumentId": "object",
  "name": "object",
  "permissionType": "string",
  "sharedClient": "boolean",
  "sharedCustodian": "boolean"
}

UpdateFileDocumentResponse: object

fileDocument:
object
return:
arguments:
object
Example
{
  "fileDocument": {
    "return": {
      "createdAt": {
        "return": "object",
        "arguments": {}
      },
      "creator": {
        "return": {
          "email": {
            "return": "string",
            "arguments": {}
          },
          "firstName": {
            "return": "string",
            "arguments": {}
          },
          "id": {
            "return": "object",
            "arguments": {}
          },
          "language": {
            "return": "string",
            "arguments": {}
          },
          "lastName": {
            "return": "string",
            "arguments": {}
          },
          "organization": {
            "return": {
              "browserTabTitle": {
                "return": "string",
                "arguments": {}
              },
              "faviconLink": {
                "return": "string",
                "arguments": {}
              },
              "id": {
                "return": "object",
                "arguments": {}
              },
              "name": {
                "return": "string",
                "arguments": {}
              },
              "parent": {
                "return": {
                  "browserTabTitle": {
                    "return": "string",
                    "arguments": {}
                  },
                  "faviconLink": {
                    "return": "string",
                    "arguments": {}
                  },
                  "id": {
                    "return": "object",
                    "arguments": {}
                  },
                  "name": {
                    "return": "string",
                    "arguments": {}
                  },
                  "parent": {
                    "return": {
                      "browserTabTitle": {
                        "return": "string",
                        "arguments": {}
                      },
                      "faviconLink": {
                        "return": "string",
                        "arguments": {}
                      },
                      "id": {
                        "return": "object",
                        "arguments": {}
                      },
                      "name": {
                        "return": "string",
                        "arguments": {}
                      },
                      "parent": {
                        "return": {
                          "browserTabTitle": {
                            "return": "string",
                            "arguments": {}
                          },
                          "faviconLink": {
                            "return": "string",
                            "arguments": {}
                          },
                          "id": {}
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

UpdateFinancialProductInput: object

autoUpdatePrices:

Auto updates prices using data partner?

currency:

The currency that this Financial product trades in.

currentPriceCents:
cusip:
exchange:

The Stock Exchange that this Financial product trades in.

financialProductId:
integrations:
FinancialProductIntegrationInput
isPartial:

When true, allowed to allocate fractional trades.

Defaults to true.

isin:
primaryAssetClassId:

Primary Asset Class of the product

ric:
riskProfileDescription:
riskProfileName:
scheduleId:

financialProduct scheduleID

secondaryAssetClassId:

Secondary Asset Class of the product

settlementDays:
Int
substituteFinancialProductId:

Optional substitute Financial product (used for Tax-Loss Harvesting).

taxRank:
Int

The tax rank of the financial product, to be used for portfolio optimization

tertiaryAssetClassId:

Tertiary Asset Class of the product

ticker:

The trading ticker for this Financial product.

translatedName:

The translated names of the Financial product.

url:
volatile:
waivedFeePercentage:

A discount percentage applied to the corresponding holding amount during fee calculation (0 - 100%).

Example
{
  "autoUpdatePrices": "boolean",
  "currency": "string",
  "currentPriceCents": "number",
  "cusip": "string",
  "exchange": "string",
  "financialProductId": "object",
  "integrations": [
    {
      "externalId": "object",
      "groupId": "object",
      "iid": "object",
      "type": "string"
    }
  ],
  "isPartial": "boolean",
  "isin": "string",
  "primaryAssetClassId": "object",
  "ric": "string",
  "riskProfileDescription": {
    "en": "object",
    "fr": "object"
  },
  "riskProfileName": {
    "en": "object",
    "fr": "object"
  },
  "scheduleId": "object",
  "secondaryAssetClassId": "object",
  "settlementDays": "number",
  "substituteFinancialProductId": "object",
  "taxRank": "number",
  "tertiaryAssetClassId": "object",
  "ticker": "object",
  "translatedName": {
    "en": "object",
    "fr": "object"
  },
  "url": "string",
  "volatile": "boolean",
  "waivedFeePercentage": "number"
}

UpdateFinancialProductResponse: object

financialProduct:
object

The Financial product.

return:
arguments:
object
Example
{
  "financialProduct": {
    "return": {
      "assignable": {
        "return": "boolean",
        "arguments": {}
      },
      "autoUpdatePrices": {
        "return": "boolean",
        "arguments": {}
      },
      "children": {
        "return": [
          {
            "financialProduct": {
              "return": {
                "assignable": {
                  "return": "boolean",
                  "arguments": {}
                },
                "autoUpdatePrices": {
                  "return": "boolean",
                  "arguments": {}
                },
                "children": {
                  "return": [
                    {
                      "financialProduct": {
                        "return": {
                          "assignable": {
                            "return": "boolean",
                            "arguments": {}
                          },
                          "autoUpdatePrices": {
                            "return": "boolean",
                            "arguments": {}
                          },
                          "children": {
                            "return": [
                              {
                                "financialProduct": {
                                  "return": {
                                    "assignable": {
                                      "return": "boolean",
                                      "arguments": {}
                                    },
                                    "autoUpdatePrices": {
                                      "return": "boolean",
                                      "arguments": {}
                                    },
                                    "children": {
                                      "return": [
                                        {
                                          "financialProduct": {
                                            "return": {
                                              "assignable": {
                                                "return": "boolean",
                                                "arguments": {}
                                              },
                                              "autoUpdatePrices": {
                                                "return": "boolean",
                                                "arguments": {}
                                              },
                                              "children": {
                                                "return": [
                                                  {
                                                    "financialProduct": {
                                                      "return": {
                                                        "assignable": {
                                                          "return": "boolean",
                                                          "arguments": {}
                                                        },
                                                        "autoUpdatePrices": {
                                                          "return": "boolean",
                                                          "arguments": {}
                                                        },
                                                        "children": {
                                                          "return": [
                                                            {
                                                              "financialProduct": {
                                                                "return": {
                                                                  "assignable": {
                                                                    "return": "boolean",
                                                                    "arguments": {}
                                                                  },
                                                                  "autoUpdatePrices": {}
                                                                }
                                                              }
                                                            }
                                                          ]
                                                        }
                                                      }
                                                    }
                                                  }
                                                ]
                                              }
                                            }
                                          }
                                        }
                                      ]
                                    }
                                  }
                                }
                              }
                            ]
                          }
                        }
                      }
                    }
                  ]
                }
              }
            }
          }
        ]
      }
    }
  }
}

UpdateFormTemplateInput: object

digitalSignatureEnabled:
englishMarkdown:
formTemplateId:
frenchMarkdown:
minVersion:
Int
state:
Example
{
  "digitalSignatureEnabled": "boolean",
  "englishMarkdown": "string",
  "formTemplateId": "object",
  "frenchMarkdown": "string",
  "minVersion": "number",
  "state": "string"
}

UpdateFormTemplateResponse: object

formTemplate:
object
return:
arguments:
object
Example
{
  "formTemplate": {
    "return": {
      "digitalSignatureEnabled": {
        "return": "boolean",
        "arguments": {}
      },
      "displayName": {
        "return": "string",
        "arguments": {}
      },
      "id": {
        "return": "object",
        "arguments": {}
      },
      "minVersion": {
        "return": "number",
        "arguments": {}
      },
      "organization": {
        "return": {
          "accountTypeTaxRanks": {
            "return": [
              {
                "accountType": {
                  "return": "string",
                  "arguments": {}
                },
                "id": {
                  "return": "object",
                  "arguments": {}
                },
                "taxRank": {
                  "return": "number",
                  "arguments": {}
                }
              }
            ],
            "arguments": {}
          },
          "allowAccessToSubOrganizations": {
            "return": "boolean",
            "arguments": {}
          },
          "allowDirectCommunication": {
            "return": "boolean",
            "arguments": {}
          },
          "allowInactiveUserAdjustments": {
            "return": "boolean",
            "arguments": {}
          },
          "allowInactiveUserFeeCalculation": {
            "return": "boolean",
            "arguments": {}
          },
          "allowInactiveUserRebalancing": {
            "return": "boolean",
            "arguments": {}
          },
          "allowInstantInvest": {
            "return": "boolean",
            "arguments": {}
          },
          "allowPortfolioPerGoal": {
            "return": "boolean",
            "arguments": {}
          },
          "allowPostOptimizationEditing": {
            "return": "boolean",
            "arguments": {}
          },
          "allowViewSubTradeRequestPairs": {
            "return": "boolean",
            "arguments": {}
          },
          "applicableJurisdictions": {
            "return": {
              "all": {
                "return": "boolean",
                "arguments": {}
              },
              "only": {
                "return": [
                  "string"
                ],
                "arguments": {}
              }
            },
            "arguments": {}
          },
          "applicableLocalization": {
            "return": {
              "countries": {
                "return": [
                  "string"
                ],
                "arguments": {}
              },
              "dateFormat": {
                "return": "string"
              }
            }
          }
        }
      }
    }
  }
}

UpdateFraudRiskInput: object

fraudRiskId:
lastUpdatedBy:
notes:
riskReasons:
RiskReasonInput
score:
Int
Example
{
  "fraudRiskId": "object",
  "lastUpdatedBy": "object",
  "notes": "object",
  "riskReasons": [
    {
      "name": "string"
    }
  ],
  "score": "number"
}

UpdateFraudRiskResponse: object

fraudRisk:
object
return:
arguments:
object
Example
{
  "fraudRisk": {
    "return": {
      "id": {
        "return": "object",
        "arguments": {}
      },
      "lastUpdatedBy": {
        "return": "string",
        "arguments": {}
      },
      "notes": {
        "return": "string",
        "arguments": {}
      },
      "riskReasons": {
        "return": [
          {
            "countryRisk": {
              "return": {
                "country": {
                  "return": "object",
                  "arguments": {}
                },
                "countryCode": {
                  "return": "object",
                  "arguments": {}
                },
                "disabled": {
                  "return": "boolean",
                  "arguments": {}
                },
                "id": {
                  "return": "object",
                  "arguments": {}
                },
                "riskRating": {
                  "return": "string",
                  "arguments": {}
                }
              },
              "arguments": {}
            },
            "id": {
              "return": "object",
              "arguments": {}
            },
            "jobTitleRisk": {
              "return": {
                "companyType": {
                  "return": "object",
                  "arguments": {}
                },
                "disabled": {
                  "return": "boolean",
                  "arguments": {}
                },
                "id": {
                  "return": "object",
                  "arguments": {}
                },
                "jobTitle": {
                  "return": "object",
                  "arguments": {}
                },
                "riskRating": {
                  "return": "string",
                  "arguments": {}
                }
              },
              "arguments": {}
            },
            "name": {
              "return": "string",
              "arguments": {}
            },
            "riskRating": {
              "return": "string",
              "arguments": {}
            },
            "translatedDescription": {
              "return": {
                "en": {
                  "return": "string",
                  "arguments": {}
                },
                "fr": {
                  "return": "string",
                  "arguments": {}
                }
              },
              "arguments": {}
            },
            "translatedDisplayName": {
              "return": {
                "en": {
                  "return": "string",
                  "arguments": {}
                },
                "fr": {}
              }
            }
          }
        ]
      }
    }
  }
}

UpdateGoalInput: object

clientGroupId:
customFields:
CustomFieldInput
expectedAnnualIncomeCents:
Int
financialProductId:
goalId:
householdClientGroupId:
integrations:
GoalIntegrationInput
lastUpdatedBy:
name:
retirementAge:
Int
riskQuestion1:
targetAmountCents:
targetDate:
taxOptimized:
timeHorizon:
tradingProcess:
type:
Example
{
  "clientGroupId": "object",
  "customFields": [
    {
      "key": "object",
      "value": "object"
    }
  ],
  "expectedAnnualIncomeCents": "number",
  "financialProductId": "object",
  "goalId": "object",
  "householdClientGroupId": "object",
  "integrations": [
    {
      "externalId": "object",
      "groupId": "object",
      "iid": "object",
      "type": "string"
    }
  ],
  "lastUpdatedBy": "object",
  "name": "object",
  "retirementAge": "number",
  "riskQuestion1": "string",
  "targetAmountCents": "object",
  "targetDate": "object",
  "taxOptimized": "boolean",
  "timeHorizon": "string",
  "tradingProcess": "string",
  "type": "string"
}

UpdateGoalResponse: object

goal:
object
return:
arguments:
object
Example
{
  "goal": {
    "return": {
      "availableFinancialProducts": {
        "return": [
          {
            "assignable": {
              "return": "boolean",
              "arguments": {}
            },
            "autoUpdatePrices": {
              "return": "boolean",
              "arguments": {}
            },
            "children": {
              "return": [
                {
                  "financialProduct": {
                    "return": {
                      "assignable": {
                        "return": "boolean",
                        "arguments": {}
                      },
                      "autoUpdatePrices": {
                        "return": "boolean",
                        "arguments": {}
                      },
                      "children": {
                        "return": [
                          {
                            "financialProduct": {
                              "return": {
                                "assignable": {
                                  "return": "boolean",
                                  "arguments": {}
                                },
                                "autoUpdatePrices": {
                                  "return": "boolean",
                                  "arguments": {}
                                },
                                "children": {
                                  "return": [
                                    {
                                      "financialProduct": {
                                        "return": {
                                          "assignable": {
                                            "return": "boolean",
                                            "arguments": {}
                                          },
                                          "autoUpdatePrices": {
                                            "return": "boolean",
                                            "arguments": {}
                                          },
                                          "children": {
                                            "return": [
                                              {
                                                "financialProduct": {
                                                  "return": {
                                                    "assignable": {
                                                      "return": "boolean",
                                                      "arguments": {}
                                                    },
                                                    "autoUpdatePrices": {
                                                      "return": "boolean",
                                                      "arguments": {}
                                                    },
                                                    "children": {
                                                      "return": [
                                                        {
                                                          "financialProduct": {
                                                            "return": {
                                                              "assignable": {
                                                                "return": "boolean",
                                                                "arguments": {}
                                                              },
                                                              "autoUpdatePrices": {
                                                                "return": "boolean",
                                                                "arguments": {}
                                                              },
                                                              "children": {
                                                                "return": [
                                                                  {
                                                                    "financialProduct": {
                                                                      "return": {
                                                                        "assignable": {}
                                                                      }
                                                                    }
                                                                  }
                                                                ]
                                                              }
                                                            }
                                                          }
                                                        }
                                                      ]
                                                    }
                                                  }
                                                }
                                              }
                                            ]
                                          }
                                        }
                                      }
                                    }
                                  ]
                                }
                              }
                            }
                          }
                        ]
                      }
                    }
                  }
                }
              ]
            }
          }
        ]
      }
    }
  }
}

UpdateImportFileLineItemInput: object

importFileLineItemId:
rawData:
Example
{
  "importFileLineItemId": "object",
  "rawData": "object"
}

UpdateImportFileLineItemResponse: object

importFileLineItem:
object
return:
arguments:
object
Example
{
  "importFileLineItem": {
    "return": {
      "createdAt": {
        "return": "object",
        "arguments": {}
      },
      "externalId": {
        "return": "string",
        "arguments": {}
      },
      "id": {
        "return": "object",
        "arguments": {}
      },
      "importFile": {
        "return": {
          "bulkImport": {
            "return": {
              "createdAt": {
                "return": "object",
                "arguments": {}
              },
              "id": {
                "return": "object",
                "arguments": {}
              },
              "name": {
                "return": "string",
                "arguments": {}
              },
              "organization": {
                "return": {
                  "browserTabTitle": {
                    "return": "string",
                    "arguments": {}
                  },
                  "faviconLink": {
                    "return": "string",
                    "arguments": {}
                  },
                  "id": {
                    "return": "object",
                    "arguments": {}
                  },
                  "name": {
                    "return": "string",
                    "arguments": {}
                  },
                  "parent": {
                    "return": {
                      "browserTabTitle": {
                        "return": "string",
                        "arguments": {}
                      },
                      "faviconLink": {
                        "return": "string",
                        "arguments": {}
                      },
                      "id": {
                        "return": "object",
                        "arguments": {}
                      },
                      "name": {
                        "return": "string",
                        "arguments": {}
                      },
                      "parent": {
                        "return": {
                          "browserTabTitle": {
                            "return": "string",
                            "arguments": {}
                          },
                          "faviconLink": {
                            "return": "string",
                            "arguments": {}
                          },
                          "id": {
                            "return": "object",
                            "arguments": {}
                          },
                          "name": {
                            "return": "string",
                            "arguments": {}
                          },
                          "parent": {
                            "return": {
                              "browserTabTitle": {
                                "return": "string",
                                "arguments": {}
                              },
                              "faviconLink": {}
                            }
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

UpdateInstitutionInput: object

id:
ID

This an ID created by the partner, that is submitted with a request to create a new Institution and unique to each request.

name:

Institution name

physicalAddress:

Institution Address

Example
{
  "id": "object",
  "name": "object",
  "physicalAddress": {
    "city": "object",
    "country": "string",
    "houseNumber": "object",
    "neighborhood": "object",
    "postal": "object",
    "province": "string",
    "streetName": "object",
    "unitNumber": "object"
  }
}

UpdateInstitutionResponse: object

institution:
object
return:
arguments:
object
Example
{
  "institution": {
    "return": {
      "createdAt": {
        "return": "object",
        "arguments": {}
      },
      "id": {
        "return": "object",
        "arguments": {}
      },
      "isDraft": {
        "return": "string",
        "arguments": {}
      },
      "name": {
        "return": "string",
        "arguments": {}
      },
      "physicalAddress": {
        "return": {
          "city": {
            "return": "string",
            "arguments": {}
          },
          "country": {
            "return": "string",
            "arguments": {}
          },
          "houseNumber": {
            "return": "string",
            "arguments": {}
          },
          "jurisdiction": {
            "return": "string",
            "arguments": {}
          },
          "neighborhood": {
            "return": "string",
            "arguments": {}
          },
          "postal": {
            "return": "string",
            "arguments": {}
          },
          "province": {
            "return": "string",
            "arguments": {}
          },
          "streetName": {
            "return": "string",
            "arguments": {}
          },
          "unitNumber": {
            "return": "string",
            "arguments": {}
          }
        },
        "arguments": {}
      },
      "state": {
        "return": "string",
        "arguments": {}
      },
      "stateChanges": {
        "return": [
          "object"
        ],
        "arguments": {}
      },
      "updatedAt": {
        "return": "object",
        "arguments": {}
      }
    },
    "arguments": {}
  }
}

UpdateIntegrationInput: object

configuration:
integrationId:
Example
{
  "configuration": "object",
  "integrationId": "object"
}

UpdateIntegrationResponse: object

integration:
object
return:
arguments:
object
Example
{
  "integration": {
    "return": {
      "configuration": {
        "return": "object",
        "arguments": {}
      },
      "id": {
        "return": "object",
        "arguments": {}
      },
      "organization": {
        "return": {
          "browserTabTitle": {
            "return": "string",
            "arguments": {}
          },
          "faviconLink": {
            "return": "string",
            "arguments": {}
          },
          "id": {
            "return": "object",
            "arguments": {}
          },
          "name": {
            "return": "string",
            "arguments": {}
          },
          "parent": {
            "return": {
              "browserTabTitle": {
                "return": "string",
                "arguments": {}
              },
              "faviconLink": {
                "return": "string",
                "arguments": {}
              },
              "id": {
                "return": "object",
                "arguments": {}
              },
              "name": {
                "return": "string",
                "arguments": {}
              },
              "parent": {
                "return": {
                  "browserTabTitle": {
                    "return": "string",
                    "arguments": {}
                  },
                  "faviconLink": {
                    "return": "string",
                    "arguments": {}
                  },
                  "id": {
                    "return": "object",
                    "arguments": {}
                  },
                  "name": {
                    "return": "string",
                    "arguments": {}
                  },
                  "parent": {
                    "return": {
                      "browserTabTitle": {
                        "return": "string",
                        "arguments": {}
                      },
                      "faviconLink": {
                        "return": "string",
                        "arguments": {}
                      },
                      "id": {
                        "return": "object",
                        "arguments": {}
                      },
                      "name": {
                        "return": "string",
                        "arguments": {}
                      },
                      "parent": {
                        "return": {
                          "browserTabTitle": {
                            "return": "string",
                            "arguments": {}
                          },
                          "faviconLink": {
                            "return": "string",
                            "arguments": {}
                          },
                          "id": {}
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

UpdateJobTitleRiskInput: object

companyType:
disabled:
jobTitle:
jobTitleRiskId:
riskRating:
Example
{
  "companyType": "object",
  "disabled": "boolean",
  "jobTitle": "object",
  "jobTitleRiskId": "object",
  "riskRating": "string"
}

UpdateJobTitleRiskResponse: object

jobTitleRisk:
object
return:
arguments:
object
Example
{
  "jobTitleRisk": {
    "return": {
      "companyType": {
        "return": "object",
        "arguments": {}
      },
      "disabled": {
        "return": "boolean",
        "arguments": {}
      },
      "id": {
        "return": "object",
        "arguments": {}
      },
      "jobTitle": {
        "return": "object",
        "arguments": {}
      },
      "riskRating": {
        "return": "string",
        "arguments": {}
      }
    },
    "arguments": {}
  }
}

UpdateLocalizationResponse: object

localization:
object
return:
arguments:
object
Example
{
  "localization": {
    "return": {
      "countries": {
        "return": [
          "string"
        ],
        "arguments": {}
      },
      "dateFormat": {
        "return": "string",
        "arguments": {}
      },
      "defaultCurrency": {
        "return": "string",
        "arguments": {}
      },
      "defaultLanguage": {
        "return": "string",
        "arguments": {}
      },
      "id": {
        "return": "object",
        "arguments": {}
      },
      "languages": {
        "return": [
          "string"
        ],
        "arguments": {}
      },
      "name": {
        "return": "string",
        "arguments": {}
      },
      "organization": {
        "return": {
          "browserTabTitle": {
            "return": "string",
            "arguments": {}
          },
          "faviconLink": {
            "return": "string",
            "arguments": {}
          },
          "id": {
            "return": "object",
            "arguments": {}
          },
          "name": {
            "return": "string",
            "arguments": {}
          },
          "parent": {
            "return": {
              "browserTabTitle": {
                "return": "string",
                "arguments": {}
              },
              "faviconLink": {
                "return": "string",
                "arguments": {}
              },
              "id": {
                "return": "object",
                "arguments": {}
              },
              "name": {
                "return": "string",
                "arguments": {}
              },
              "parent": {
                "return": {
                  "browserTabTitle": {
                    "return": "string",
                    "arguments": {}
                  },
                  "faviconLink": {
                    "return": "string",
                    "arguments": {}
                  },
                  "id": {
                    "return": "object",
                    "arguments": {}
                  },
                  "name": {
                    "return": "string",
                    "arguments": {}
                  },
                  "parent": {
                    "return": {
                      "browserTabTitle": {
                        "return": "string",
                        "arguments": {}
                      },
                      "faviconLink": {}
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

UpdateModelPortfolioInput: object

children:
BranchInput

Allocation branches

forecastedRateOfReturn:
forecastedStandardDeviation:
lowThresholdScore:

Low threshold score for allowing access

modelPortfolioId:
reasonForUpdate:
riskReturnLevel:
Int
scheduleId:

Optional schedule (used for illiquid portfolios).

suggestable:

Is this Financial product suggestable?

suggestedMaxScore:

Maximum suitability score to have access to this Financial product.

suggestedMinScore:

Minimum suitability score to have access to this Financial product.

targetAllocations:
TargetAllocationInput

All Target Allocations

themeId:

ID for the theme assigned

translatedInvestmentObjective:

The translated investment objectives of the portfolio

translatedLiquidity:

The translated liquidity of the portfolio

translatedName:

The translated names of the Financial product.

translatedPortfolioDescription:

The translated descriptions of the portfolio

translatedPortfolioDisclaimer:

The translated disclaimers of the portfolio

url:
Example
{
  "children": [
    {
      "financialProductId": "object",
      "isCashEquivalent": "boolean",
      "percentage": "number"
    }
  ],
  "forecastedRateOfReturn": "number",
  "forecastedStandardDeviation": "number",
  "lowThresholdScore": "number",
  "modelPortfolioId": "object",
  "reasonForUpdate": "object",
  "riskReturnLevel": "number",
  "scheduleId": "object",
  "suggestable": "boolean",
  "suggestedMaxScore": "number",
  "suggestedMinScore": "number",
  "targetAllocations": [
    {
      "max": "number",
      "min": "number",
      "secondaryAssetClassId": "object"
    }
  ],
  "themeId": "object",
  "translatedInvestmentObjective": {
    "en": "object",
    "fr": "object"
  },
  "translatedLiquidity": {
    "en": "object",
    "fr": "object"
  },
  "translatedName": {
    "en": "object",
    "fr": "object"
  },
  "translatedPortfolioDescription": {
    "en": "object",
    "fr": "object"
  },
  "translatedPortfolioDisclaimer": {
    "en": "object",
    "fr": "object"
  },
  "url": "string"
}

UpdateModelPortfolioResponse: object

modelPortfolio:
object

The Financial product.

return:
arguments:
object
Example
{
  "modelPortfolio": {
    "return": {
      "assignable": {
        "return": "boolean",
        "arguments": {}
      },
      "autoUpdatePrices": {
        "return": "boolean",
        "arguments": {}
      },
      "children": {
        "return": [
          {
            "financialProduct": {
              "return": {
                "assignable": {
                  "return": "boolean",
                  "arguments": {}
                },
                "autoUpdatePrices": {
                  "return": "boolean",
                  "arguments": {}
                },
                "children": {
                  "return": [
                    {
                      "financialProduct": {
                        "return": {
                          "assignable": {
                            "return": "boolean",
                            "arguments": {}
                          },
                          "autoUpdatePrices": {
                            "return": "boolean",
                            "arguments": {}
                          },
                          "children": {
                            "return": [
                              {
                                "financialProduct": {
                                  "return": {
                                    "assignable": {
                                      "return": "boolean",
                                      "arguments": {}
                                    },
                                    "autoUpdatePrices": {
                                      "return": "boolean",
                                      "arguments": {}
                                    },
                                    "children": {
                                      "return": [
                                        {
                                          "financialProduct": {
                                            "return": {
                                              "assignable": {
                                                "return": "boolean",
                                                "arguments": {}
                                              },
                                              "autoUpdatePrices": {
                                                "return": "boolean",
                                                "arguments": {}
                                              },
                                              "children": {
                                                "return": [
                                                  {
                                                    "financialProduct": {
                                                      "return": {
                                                        "assignable": {
                                                          "return": "boolean",
                                                          "arguments": {}
                                                        },
                                                        "autoUpdatePrices": {
                                                          "return": "boolean",
                                                          "arguments": {}
                                                        },
                                                        "children": {
                                                          "return": [
                                                            {
                                                              "financialProduct": {
                                                                "return": {
                                                                  "assignable": {
                                                                    "return": "boolean",
                                                                    "arguments": {}
                                                                  },
                                                                  "autoUpdatePrices": {}
                                                                }
                                                              }
                                                            }
                                                          ]
                                                        }
                                                      }
                                                    }
                                                  }
                                                ]
                                              }
                                            }
                                          }
                                        }
                                      ]
                                    }
                                  }
                                }
                              }
                            ]
                          }
                        }
                      }
                    }
                  ]
                }
              }
            }
          }
        ]
      }
    }
  }
}

UpdateNoteInput: object

content:
noteId:

noteId associated with the note which is updating

type:
Example
{
  "content": "object",
  "noteId": "object",
  "type": "string"
}

UpdateNoteResponse: object

note:
object
return:
arguments:
object
Example
{
  "note": {
    "return": {
      "author": {
        "return": {
          "email": {
            "return": "string",
            "arguments": {}
          },
          "firstName": {
            "return": "string",
            "arguments": {}
          },
          "id": {
            "return": "object",
            "arguments": {}
          },
          "language": {
            "return": "string",
            "arguments": {}
          },
          "lastName": {
            "return": "string",
            "arguments": {}
          },
          "organization": {
            "return": {
              "browserTabTitle": {
                "return": "string",
                "arguments": {}
              },
              "faviconLink": {
                "return": "string",
                "arguments": {}
              },
              "id": {
                "return": "object",
                "arguments": {}
              },
              "name": {
                "return": "string",
                "arguments": {}
              },
              "parent": {
                "return": {
                  "browserTabTitle": {
                    "return": "string",
                    "arguments": {}
                  },
                  "faviconLink": {
                    "return": "string",
                    "arguments": {}
                  },
                  "id": {
                    "return": "object",
                    "arguments": {}
                  },
                  "name": {
                    "return": "string",
                    "arguments": {}
                  },
                  "parent": {
                    "return": {
                      "browserTabTitle": {
                        "return": "string",
                        "arguments": {}
                      },
                      "faviconLink": {
                        "return": "string",
                        "arguments": {}
                      },
                      "id": {
                        "return": "object",
                        "arguments": {}
                      },
                      "name": {
                        "return": "string",
                        "arguments": {}
                      },
                      "parent": {
                        "return": {
                          "browserTabTitle": {
                            "return": "string",
                            "arguments": {}
                          },
                          "faviconLink": {
                            "return": "string",
                            "arguments": {}
                          },
                          "id": {
                            "return": "object",
                            "arguments": {}
                          },
                          "name": {}
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

UpdateNotificationDefinitionInput: object

bodyTemplate:
linkTemplate:
linkText:
name:
notificationDefinitionId:
notificationGroupId:
organizationOnly:
roleProfileIds:
ObjectID
titleTemplate:
triggerEventType:
triggerObjectType:
Example
{
  "bodyTemplate": {
    "en": "object",
    "fr": "object"
  },
  "linkTemplate": "object",
  "linkText": {
    "en": "object",
    "fr": "object"
  },
  "name": "object",
  "notificationDefinitionId": "object",
  "notificationGroupId": "object",
  "organizationOnly": "boolean",
  "roleProfileIds": [
    "object"
  ],
  "titleTemplate": {
    "en": "object",
    "fr": "object"
  },
  "triggerEventType": "string",
  "triggerObjectType": "string"
}

UpdateNotificationDefintionResponse: object

notificationDefinition:
object
return:
arguments:
object
Example
{
  "notificationDefinition": {
    "return": {
      "bodyTemplate": {
        "return": {
          "en": {
            "return": "string",
            "arguments": {}
          },
          "fr": {
            "return": "string",
            "arguments": {}
          }
        },
        "arguments": {}
      },
      "createdAt": {
        "return": "object",
        "arguments": {}
      },
      "id": {
        "return": "object",
        "arguments": {}
      },
      "linkTemplate": {
        "return": "object",
        "arguments": {}
      },
      "linkText": {
        "return": {
          "en": {
            "return": "string",
            "arguments": {}
          },
          "fr": {
            "return": "string",
            "arguments": {}
          }
        },
        "arguments": {}
      },
      "name": {
        "return": "object",
        "arguments": {}
      },
      "notificationGroup": {
        "return": {
          "id": {
            "return": "object",
            "arguments": {}
          },
          "name": {
            "return": {
              "en": {
                "return": "string",
                "arguments": {}
              },
              "fr": {
                "return": "string",
                "arguments": {}
              }
            },
            "arguments": {}
          }
        },
        "arguments": {}
      },
      "organization": {
        "return": {
          "accountTypeTaxRanks": {
            "return": [
              {
                "accountType": {
                  "return": "string",
                  "arguments": {}
                },
                "id": {
                  "return": "object",
                  "arguments": {}
                },
                "taxRank": {
                  "return": "number",
                  "arguments": {}
                }
              }
            ],
            "arguments": {}
          },
          "allowAccessToSubOrganizations": {
            "return": "boolean",
            "arguments": {}
          },
          "allowDirectCommunication": {
            "return": "boolean",
            "arguments": {}
          },
          "allowInactiveUserAdjustments": {
            "return": "boolean",
            "arguments": {}
          },
          "allowInactiveUserFeeCalculation": {
            "return": "boolean",
            "arguments": {}
          }
        }
      }
    }
  }
}

UpdateNotificationGroupInput: object

name:
notificationGroupId:
Example
{
  "name": {
    "en": "object",
    "fr": "object"
  },
  "notificationGroupId": "object"
}

UpdateNotificationGroupResponse: object

notificationGroup:
object
return:
arguments:
object
Example
{
  "notificationGroup": {
    "return": {
      "id": {
        "return": "object",
        "arguments": {}
      },
      "name": {
        "return": {
          "en": {
            "return": "string",
            "arguments": {}
          },
          "fr": {
            "return": "string",
            "arguments": {}
          }
        },
        "arguments": {}
      }
    },
    "arguments": {}
  }
}

UpdateOrganizationDashboardInput: object

dashboardId:
name:
widgets:
WidgetInputType
Example
{
  "dashboardId": "object",
  "name": "string",
  "widgets": [
    {
      "columns": [
        "string"
      ],
      "filters": [
        {
          "comparison": "string",
          "field": "string",
          "value": "string"
        }
      ],
      "format": "string",
      "grouping": {
        "field": "string",
        "interval": "string",
        "type": "string",
        "valueAggregation": "string",
        "valueField": "string"
      },
      "height": "number",
      "reportType": "string",
      "sortDesc": "boolean",
      "sortField": "string",
      "title": "string",
      "type": "string",
      "width": "number",
      "x": "number",
      "y": "number"
    }
  ]
}

UpdateOrganizationDashboardResponse: object

dashboard:
object
return:
arguments:
object
Example
{
  "dashboard": {
    "return": {
      "archived": {
        "return": "boolean",
        "arguments": {}
      },
      "id": {
        "return": "object",
        "arguments": {}
      },
      "name": {
        "return": "string",
        "arguments": {}
      },
      "organization": {
        "return": {
          "browserTabTitle": {
            "return": "string",
            "arguments": {}
          },
          "faviconLink": {
            "return": "string",
            "arguments": {}
          },
          "id": {
            "return": "object",
            "arguments": {}
          },
          "name": {
            "return": "string",
            "arguments": {}
          },
          "parent": {
            "return": {
              "browserTabTitle": {
                "return": "string",
                "arguments": {}
              },
              "faviconLink": {
                "return": "string",
                "arguments": {}
              },
              "id": {
                "return": "object",
                "arguments": {}
              },
              "name": {
                "return": "string",
                "arguments": {}
              },
              "parent": {
                "return": {
                  "browserTabTitle": {
                    "return": "string",
                    "arguments": {}
                  },
                  "faviconLink": {
                    "return": "string",
                    "arguments": {}
                  },
                  "id": {
                    "return": "object",
                    "arguments": {}
                  },
                  "name": {
                    "return": "string",
                    "arguments": {}
                  },
                  "parent": {
                    "return": {
                      "browserTabTitle": {
                        "return": "string",
                        "arguments": {}
                      },
                      "faviconLink": {
                        "return": "string",
                        "arguments": {}
                      },
                      "id": {
                        "return": "object",
                        "arguments": {}
                      },
                      "name": {
                        "return": "string",
                        "arguments": {}
                      },
                      "parent": {
                        "return": {
                          "browserTabTitle": {
                            "return": "string",
                            "arguments": {}
                          },
                          "faviconLink": {}
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

UpdateOrganizationFeatureFlagInput: object

featureFlags:
FeatureFlagOptionInput
organizationFeatureFlagId:
Example
{
  "featureFlags": [
    {
      "enabled": "boolean",
      "type": "string"
    }
  ],
  "organizationFeatureFlagId": "object"
}

UpdateOrganizationFeatureFlagResponse: object

organizationFeatureFlag:
object
return:
arguments:
object
Example
{
  "organizationFeatureFlag": {
    "return": {
      "featureFlags": {
        "return": [
          {
            "enabled": {
              "return": "boolean",
              "arguments": {}
            },
            "type": {
              "return": "string",
              "arguments": {}
            }
          }
        ],
        "arguments": {}
      },
      "id": {
        "return": "object",
        "arguments": {}
      }
    },
    "arguments": {}
  }
}

UpdateOrganizationInput: object

accountTypeTaxRanks:
AccountTypeTaxRankInput
allowAccessToSubOrganizations:
allowDirectCommunication:
allowInactiveUserAdjustments:
allowInactiveUserFeeCalculation:
allowInactiveUserRebalancing:
allowInstantInvest:
allowPortfolioPerGoal:
allowPostOptimizationEditing:
allowViewSubTradeRequestPairs:
autoInviteImportedUsers:
blockSuspiciousTransactions:
browserTabTitle:
cashOnHoldToTradeDays:
Int
cashOnHoldToWithdrawDays:
Int
customUrl:

This field relies on the CNAME value in our host settings. Mapping needs to be previously done by the CloudOps team.

databaseAuthConnectionId:
databaseAuthConnectionName:
defaultAdvisorRoleId:
defaultAuthenticationConnection:
defaultClientRoleId:
defaultSignUpRoleId:
defaultTradingProcess:
displayCurrency:
displayMenuBar:
enableMultiFactorAuthentication:
entityName:
excludeAdminFeesFromClients:
externalClientTokenEmailKey:
faviconLink:
helpCentreUrl:
includeExternalClientTokenIntoContext:
isReferral:
jurisdictions:
jwtKeyUrl:
localizationId:
minInitialDepositCents:
Int
minInvestAmountCents:
Int
minRecurringDepositCents:
Int
name:
organizationId:
parentId:
permissions:
SafeString
profileReviewTimeInMonths:
Int
repCode:
requireFeeApproval:
requireManualAccountApproval:
requireSubTradeRequestApproval:
revenueShareBps:
revenueShareTaxes:
reviewTransactions:
supportUrl:
theme:
themeTokens:
tokenExchangeValidationType:
useClientOrgAuth0:
useParentArticles:
useParentAssetClasses:
useParentBillingSchedules:
useParentClientReportTemplates:
useParentCustodianConnections:
useParentCustomFields:
useParentDashboards:
useParentFeeTiers:
useParentFormTemplates:
useParentIntegrations:
useParentLocalizations:
useParentModelPortfolios:
useParentNotificationDefinitions:
useParentNotificationGroups:
useParentPageConfigurations:
useParentProductShelf:
useParentRoleProfiles:
useParentSchedules:
useParentThemeTokens:
useParentThemes:
useParentWorkflows:
userManagementFeeBps:
validateUniquenessForSubOrganizations:
Example
{
  "accountTypeTaxRanks": [
    {
      "accountType": "string",
      "taxRank": "number"
    }
  ],
  "allowAccessToSubOrganizations": "boolean",
  "allowDirectCommunication": "boolean",
  "allowInactiveUserAdjustments": "boolean",
  "allowInactiveUserFeeCalculation": "boolean",
  "allowInactiveUserRebalancing": "boolean",
  "allowInstantInvest": "boolean",
  "allowPortfolioPerGoal": "boolean",
  "allowPostOptimizationEditing": "boolean",
  "allowViewSubTradeRequestPairs": "boolean",
  "autoInviteImportedUsers": "boolean",
  "blockSuspiciousTransactions": "boolean",
  "browserTabTitle": "string",
  "cashOnHoldToTradeDays": "number",
  "cashOnHoldToWithdrawDays": "number",
  "customUrl": "string",
  "databaseAuthConnectionId": "object",
  "databaseAuthConnectionName": "object",
  "defaultAdvisorRoleId": "object",
  "defaultAuthenticationConnection": "string",
  "defaultClientRoleId": "object",
  "defaultSignUpRoleId": "object",
  "defaultTradingProcess": "string",
  "displayCurrency": "boolean",
  "displayMenuBar": "boolean",
  "enableMultiFactorAuthentication": "boolean",
  "entityName": "object",
  "excludeAdminFeesFromClients": "boolean",
  "externalClientTokenEmailKey": "object",
  "faviconLink": "string",
  "helpCentreUrl": "object",
  "includeExternalClientTokenIntoContext": "boolean",
  "isReferral": "boolean",
  "jurisdictions": {
    "all": "boolean",
    "only": [
      "string"
    ]
  },
  "jwtKeyUrl": "object",
  "localizationId": "object",
  "minInitialDepositCents": "number",
  "minInvestAmountCents": "number",
  "minRecurringDepositCents": "number",
  "name": "object",
  "organizationId": "object",
  "parentId": "object",
  "permissions": [
    "object"
  ],
  "profileReviewTimeInMonths": "number"
}

UpdateOrganizationResponse: object

organization:
object
return:
arguments:
object
Example
{
  "organization": {
    "return": {
      "accountTypeTaxRanks": {
        "return": [
          {
            "accountType": {
              "return": "string",
              "arguments": {}
            },
            "id": {
              "return": "object",
              "arguments": {}
            },
            "taxRank": {
              "return": "number",
              "arguments": {}
            }
          }
        ],
        "arguments": {}
      },
      "allowAccessToSubOrganizations": {
        "return": "boolean",
        "arguments": {}
      },
      "allowDirectCommunication": {
        "return": "boolean",
        "arguments": {}
      },
      "allowInactiveUserAdjustments": {
        "return": "boolean",
        "arguments": {}
      },
      "allowInactiveUserFeeCalculation": {
        "return": "boolean",
        "arguments": {}
      },
      "allowInactiveUserRebalancing": {
        "return": "boolean",
        "arguments": {}
      },
      "allowInstantInvest": {
        "return": "boolean",
        "arguments": {}
      },
      "allowPortfolioPerGoal": {
        "return": "boolean",
        "arguments": {}
      },
      "allowPostOptimizationEditing": {
        "return": "boolean",
        "arguments": {}
      },
      "allowViewSubTradeRequestPairs": {
        "return": "boolean",
        "arguments": {}
      },
      "applicableJurisdictions": {
        "return": {
          "all": {
            "return": "boolean",
            "arguments": {}
          },
          "only": {
            "return": [
              "string"
            ],
            "arguments": {}
          }
        },
        "arguments": {}
      },
      "applicableLocalization": {
        "return": {
          "countries": {
            "return": [
              "string"
            ],
            "arguments": {}
          },
          "dateFormat": {
            "return": "string",
            "arguments": {}
          },
          "defaultCurrency": {
            "return": "string",
            "arguments": {}
          },
          "defaultLanguage": {
            "return": "string",
            "arguments": {}
          },
          "id": {
            "return": "object",
            "arguments": {}
          },
          "languages": {
            "return": [
              "string"
            ],
            "arguments": {}
          },
          "name": {}
        }
      }
    }
  }
}

UpdateOrganizationUserInput: object

accessType:
avatar:
email:
entities:
OrganizationUserEntityInput
firstName:
language:
lastName:
organizationUserId:
phone:
roleId:
Example
{
  "accessType": "string",
  "avatar": "object",
  "email": "object",
  "entities": [
    {
      "entityId": "object",
      "readOnly": "boolean"
    }
  ],
  "firstName": "object",
  "language": "string",
  "lastName": "object",
  "organizationUserId": "object",
  "phone": "object",
  "roleId": "object"
}

UpdateOrganizationUserProfileInput: object

avatar:
email:
firstName:
language:
lastName:
Example
{
  "avatar": "object",
  "email": "object",
  "firstName": "object",
  "language": "string",
  "lastName": "object"
}

UpdateOrganizationUserProfileResponse: object

organizationUser:
object
return:
arguments:
object
Example
{
  "organizationUser": {
    "return": {
      "accessType": {
        "return": "string",
        "arguments": {}
      },
      "apiTokens": {
        "return": [
          {
            "id": {
              "return": "object",
              "arguments": {}
            },
            "jwtToken": {
              "return": "string",
              "arguments": {}
            },
            "name": {
              "return": "string",
              "arguments": {}
            },
            "organization": {
              "return": {
                "browserTabTitle": {
                  "return": "string",
                  "arguments": {}
                },
                "faviconLink": {
                  "return": "string",
                  "arguments": {}
                },
                "id": {
                  "return": "object",
                  "arguments": {}
                },
                "name": {
                  "return": "string",
                  "arguments": {}
                },
                "parent": {
                  "return": {
                    "browserTabTitle": {
                      "return": "string",
                      "arguments": {}
                    },
                    "faviconLink": {
                      "return": "string",
                      "arguments": {}
                    },
                    "id": {
                      "return": "object",
                      "arguments": {}
                    },
                    "name": {
                      "return": "string",
                      "arguments": {}
                    },
                    "parent": {
                      "return": {
                        "browserTabTitle": {
                          "return": "string",
                          "arguments": {}
                        },
                        "faviconLink": {
                          "return": "string",
                          "arguments": {}
                        },
                        "id": {
                          "return": "object",
                          "arguments": {}
                        },
                        "name": {
                          "return": "string",
                          "arguments": {}
                        },
                        "parent": {
                          "return": {
                            "browserTabTitle": {
                              "return": "string",
                              "arguments": {}
                            },
                            "faviconLink": {
                              "return": "string",
                              "arguments": {}
                            },
                            "id": {
                              "return": "object",
                              "arguments": {}
                            },
                            "name": {
                              "return": "string",
                              "arguments": {}
                            }
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        ]
      }
    }
  }
}

UpdateOrganizationUserResponse: object

organizationUser:
object
return:
arguments:
object
Example
{
  "organizationUser": {
    "return": {
      "accessType": {
        "return": "string",
        "arguments": {}
      },
      "apiTokens": {
        "return": [
          {
            "id": {
              "return": "object",
              "arguments": {}
            },
            "jwtToken": {
              "return": "string",
              "arguments": {}
            },
            "name": {
              "return": "string",
              "arguments": {}
            },
            "organization": {
              "return": {
                "browserTabTitle": {
                  "return": "string",
                  "arguments": {}
                },
                "faviconLink": {
                  "return": "string",
                  "arguments": {}
                },
                "id": {
                  "return": "object",
                  "arguments": {}
                },
                "name": {
                  "return": "string",
                  "arguments": {}
                },
                "parent": {
                  "return": {
                    "browserTabTitle": {
                      "return": "string",
                      "arguments": {}
                    },
                    "faviconLink": {
                      "return": "string",
                      "arguments": {}
                    },
                    "id": {
                      "return": "object",
                      "arguments": {}
                    },
                    "name": {
                      "return": "string",
                      "arguments": {}
                    },
                    "parent": {
                      "return": {
                        "browserTabTitle": {
                          "return": "string",
                          "arguments": {}
                        },
                        "faviconLink": {
                          "return": "string",
                          "arguments": {}
                        },
                        "id": {
                          "return": "object",
                          "arguments": {}
                        },
                        "name": {
                          "return": "string",
                          "arguments": {}
                        },
                        "parent": {
                          "return": {
                            "browserTabTitle": {
                              "return": "string",
                              "arguments": {}
                            },
                            "faviconLink": {
                              "return": "string",
                              "arguments": {}
                            },
                            "id": {
                              "return": "object",
                              "arguments": {}
                            },
                            "name": {
                              "return": "string",
                              "arguments": {}
                            }
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        ]
      }
    }
  }
}

UpdatePageConfigurationInput: object

name:
options:
pageConfigurationId:
tabs:
TabConfigurationInput
Example
{
  "name": "string",
  "options": "object",
  "pageConfigurationId": "object",
  "tabs": [
    {
      "icon": "string",
      "label": {
        "en": "object",
        "fr": "object"
      },
      "url": "string",
      "widgets": [
        {
          "options": "object",
          "type": "string"
        }
      ]
    }
  ]
}

UpdatePageConfigurationResponse: object

pageConfiguration:
object
return:
arguments:
object
Example
{
  "pageConfiguration": {
    "return": {
      "createdAt": {
        "return": "object",
        "arguments": {}
      },
      "id": {
        "return": "object",
        "arguments": {}
      },
      "name": {
        "return": "string",
        "arguments": {}
      },
      "options": {
        "return": "object",
        "arguments": {}
      },
      "organization": {
        "return": {
          "accountTypeTaxRanks": {
            "return": [
              {
                "accountType": {
                  "return": "string",
                  "arguments": {}
                },
                "id": {
                  "return": "object",
                  "arguments": {}
                },
                "taxRank": {
                  "return": "number",
                  "arguments": {}
                }
              }
            ],
            "arguments": {}
          },
          "allowAccessToSubOrganizations": {
            "return": "boolean",
            "arguments": {}
          },
          "allowDirectCommunication": {
            "return": "boolean",
            "arguments": {}
          },
          "allowInactiveUserAdjustments": {
            "return": "boolean",
            "arguments": {}
          },
          "allowInactiveUserFeeCalculation": {
            "return": "boolean",
            "arguments": {}
          },
          "allowInactiveUserRebalancing": {
            "return": "boolean",
            "arguments": {}
          },
          "allowInstantInvest": {
            "return": "boolean",
            "arguments": {}
          },
          "allowPortfolioPerGoal": {
            "return": "boolean",
            "arguments": {}
          },
          "allowPostOptimizationEditing": {
            "return": "boolean",
            "arguments": {}
          },
          "allowViewSubTradeRequestPairs": {
            "return": "boolean",
            "arguments": {}
          },
          "applicableJurisdictions": {
            "return": {
              "all": {
                "return": "boolean",
                "arguments": {}
              },
              "only": {
                "return": [
                  "string"
                ],
                "arguments": {}
              }
            },
            "arguments": {}
          },
          "applicableLocalization": {
            "return": {
              "countries": {
                "return": [
                  "string"
                ],
                "arguments": {}
              },
              "dateFormat": {
                "return": "string"
              }
            }
          }
        }
      }
    }
  }
}

UpdatePriceAndQuantityInput: object

bulkTrades:
BulkTrade
currencyFallbackConversions:
CurrencyFallbackConversion
rebalanceId:
type:
Example
{
  "bulkTrades": [
    {
      "actualPriceCents": "number",
      "financialProductId": "object",
      "totalQuantity": "number"
    }
  ],
  "currencyFallbackConversions": [
    {
      "from": "string",
      "rate": "number",
      "to": "string"
    }
  ],
  "rebalanceId": "object",
  "type": "string"
}

UpdatePriceAndQuantityResponse: object

success:
object
return:
arguments:
object
Example
{
  "success": {
    "return": "boolean",
    "arguments": {}
  }
}

UpdateReportInput: object

accessType:
columns:
SafeString
filters:
ReportFilterInput
name:
reportId:
sortDesc:
sortField:
type:
Example
{
  "accessType": "string",
  "columns": [
    "object"
  ],
  "filters": [
    {
      "comparison": "string",
      "field": "string",
      "value": "string"
    }
  ],
  "name": "object",
  "reportId": "object",
  "sortDesc": "boolean",
  "sortField": "object",
  "type": "string"
}

UpdateReportResponse: object

report:
object
return:
arguments:
object
Example
{
  "report": {
    "return": {
      "accessType": {
        "return": "string",
        "arguments": {}
      },
      "author": {
        "return": {
          "email": {
            "return": "string",
            "arguments": {}
          },
          "firstName": {
            "return": "string",
            "arguments": {}
          },
          "id": {
            "return": "object",
            "arguments": {}
          },
          "language": {
            "return": "string",
            "arguments": {}
          },
          "lastName": {
            "return": "string",
            "arguments": {}
          },
          "organization": {
            "return": {
              "browserTabTitle": {
                "return": "string",
                "arguments": {}
              },
              "faviconLink": {
                "return": "string",
                "arguments": {}
              },
              "id": {
                "return": "object",
                "arguments": {}
              },
              "name": {
                "return": "string",
                "arguments": {}
              },
              "parent": {
                "return": {
                  "browserTabTitle": {
                    "return": "string",
                    "arguments": {}
                  },
                  "faviconLink": {
                    "return": "string",
                    "arguments": {}
                  },
                  "id": {
                    "return": "object",
                    "arguments": {}
                  },
                  "name": {
                    "return": "string",
                    "arguments": {}
                  },
                  "parent": {
                    "return": {
                      "browserTabTitle": {
                        "return": "string",
                        "arguments": {}
                      },
                      "faviconLink": {
                        "return": "string",
                        "arguments": {}
                      },
                      "id": {
                        "return": "object",
                        "arguments": {}
                      },
                      "name": {
                        "return": "string",
                        "arguments": {}
                      },
                      "parent": {
                        "return": {
                          "browserTabTitle": {
                            "return": "string",
                            "arguments": {}
                          },
                          "faviconLink": {
                            "return": "string",
                            "arguments": {}
                          },
                          "id": {}
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

UpdateRoleInput: object

accessiblePages:
Pages
accountPageConfigurationId:
dashboards:
SafeString
defaultAuthenticationConnection:
goalPageConfigurationId:
householdPageConfigurationId:
individualPageConfigurationId:
makeHouseholdDefaultView:
navigationStyle:
nonIndividualPageConfigurationId:
organizationId:
permissions:
SafeString
roleId:
roleProfileId:
subAccountPageConfigurationId:
translatedDescription:
translatedName:
Example
{
  "accessiblePages": [
    "string"
  ],
  "accountPageConfigurationId": "object",
  "dashboards": [
    "object"
  ],
  "defaultAuthenticationConnection": "string",
  "goalPageConfigurationId": "object",
  "householdPageConfigurationId": "object",
  "individualPageConfigurationId": "object",
  "makeHouseholdDefaultView": "boolean",
  "navigationStyle": "string",
  "nonIndividualPageConfigurationId": "object",
  "organizationId": "object",
  "permissions": [
    "object"
  ],
  "roleId": "object",
  "roleProfileId": "object",
  "subAccountPageConfigurationId": "object",
  "translatedDescription": {
    "en": "object",
    "fr": "object"
  },
  "translatedName": {
    "en": "object",
    "fr": "object"
  }
}

UpdateRoleProfileInput: object

roleProfileId:
template:
translatedDescription:
translatedName:
updateAllRoles:
Example
{
  "roleProfileId": "object",
  "template": {
    "accessiblePages": [
      "string"
    ],
    "accountPageConfigurationId": "object",
    "dashboards": [
      "object"
    ],
    "goalPageConfigurationId": "object",
    "householdPageConfigurationId": "object",
    "individualPageConfigurationId": "object",
    "navigationStyle": "string",
    "nonIndividualPageConfigurationId": "object",
    "permissions": [
      "object"
    ],
    "subAccountPageConfigurationId": "object"
  },
  "translatedDescription": {
    "en": "object",
    "fr": "object"
  },
  "translatedName": {
    "en": "object",
    "fr": "object"
  },
  "updateAllRoles": "boolean"
}

UpdateRoleProfileResponse: object

roleProfile:
object
return:
arguments:
object
Example
{
  "roleProfile": {
    "return": {
      "createdAt": {
        "return": "object",
        "arguments": {}
      },
      "id": {
        "return": "object",
        "arguments": {}
      },
      "organization": {
        "return": {
          "accountTypeTaxRanks": {
            "return": [
              {
                "accountType": {
                  "return": "string",
                  "arguments": {}
                },
                "id": {
                  "return": "object",
                  "arguments": {}
                },
                "taxRank": {
                  "return": "number",
                  "arguments": {}
                }
              }
            ],
            "arguments": {}
          },
          "allowAccessToSubOrganizations": {
            "return": "boolean",
            "arguments": {}
          },
          "allowDirectCommunication": {
            "return": "boolean",
            "arguments": {}
          },
          "allowInactiveUserAdjustments": {
            "return": "boolean",
            "arguments": {}
          },
          "allowInactiveUserFeeCalculation": {
            "return": "boolean",
            "arguments": {}
          },
          "allowInactiveUserRebalancing": {
            "return": "boolean",
            "arguments": {}
          },
          "allowInstantInvest": {
            "return": "boolean",
            "arguments": {}
          },
          "allowPortfolioPerGoal": {
            "return": "boolean",
            "arguments": {}
          },
          "allowPostOptimizationEditing": {
            "return": "boolean",
            "arguments": {}
          },
          "allowViewSubTradeRequestPairs": {
            "return": "boolean",
            "arguments": {}
          },
          "applicableJurisdictions": {
            "return": {
              "all": {
                "return": "boolean",
                "arguments": {}
              },
              "only": {
                "return": [
                  "string"
                ],
                "arguments": {}
              }
            },
            "arguments": {}
          },
          "applicableLocalization": {
            "return": {
              "countries": {
                "return": [
                  "string"
                ],
                "arguments": {}
              },
              "dateFormat": {
                "return": "string",
                "arguments": {}
              },
              "defaultCurrency": {
                "return": "string",
                "arguments": {}
              },
              "defaultLanguage": {
                "return": "string"
              }
            }
          }
        }
      }
    }
  }
}

UpdateRoleResponse: object

role:
object
return:
arguments:
object
Example
{
  "role": {
    "return": {
      "accessiblePages": {
        "return": [
          "string"
        ],
        "arguments": {}
      },
      "accountPageConfiguration": {
        "return": {
          "createdAt": {
            "return": "object",
            "arguments": {}
          },
          "id": {
            "return": "object",
            "arguments": {}
          },
          "name": {
            "return": "string",
            "arguments": {}
          },
          "options": {
            "return": "object",
            "arguments": {}
          },
          "organization": {
            "return": {
              "accountTypeTaxRanks": {
                "return": [
                  {
                    "accountType": {
                      "return": "string",
                      "arguments": {}
                    },
                    "id": {
                      "return": "object",
                      "arguments": {}
                    },
                    "taxRank": {
                      "return": "number",
                      "arguments": {}
                    }
                  }
                ],
                "arguments": {}
              },
              "allowAccessToSubOrganizations": {
                "return": "boolean",
                "arguments": {}
              },
              "allowDirectCommunication": {
                "return": "boolean",
                "arguments": {}
              },
              "allowInactiveUserAdjustments": {
                "return": "boolean",
                "arguments": {}
              },
              "allowInactiveUserFeeCalculation": {
                "return": "boolean",
                "arguments": {}
              },
              "allowInactiveUserRebalancing": {
                "return": "boolean",
                "arguments": {}
              },
              "allowInstantInvest": {
                "return": "boolean",
                "arguments": {}
              },
              "allowPortfolioPerGoal": {
                "return": "boolean",
                "arguments": {}
              },
              "allowPostOptimizationEditing": {
                "return": "boolean",
                "arguments": {}
              },
              "allowViewSubTradeRequestPairs": {
                "return": "boolean",
                "arguments": {}
              },
              "applicableJurisdictions": {
                "return": {
                  "all": {
                    "return": "boolean",
                    "arguments": {}
                  },
                  "only": {
                    "return": [
                      "string"
                    ],
                    "arguments": {}
                  }
                },
                "arguments": {}
              },
              "applicableLocalization": {
                "return": {}
              }
            }
          }
        }
      }
    }
  }
}

UpdateScheduleInput: object

dates:
Date
name:
scheduleId:
Example
{
  "dates": [
    "object"
  ],
  "name": "object",
  "scheduleId": "object"
}

UpdateScheduleResponse: object

schedule:
object
return:
arguments:
object
Example
{
  "schedule": {
    "return": {
      "associatedFinancialProductsCount": {
        "return": "number",
        "arguments": {}
      },
      "dates": {
        "return": [
          "object"
        ],
        "arguments": {}
      },
      "id": {
        "return": "object",
        "arguments": {}
      },
      "name": {
        "return": "string",
        "arguments": {}
      },
      "nextDate": {
        "return": "object",
        "arguments": {}
      },
      "organization": {
        "return": {
          "browserTabTitle": {
            "return": "string",
            "arguments": {}
          },
          "faviconLink": {
            "return": "string",
            "arguments": {}
          },
          "id": {
            "return": "object",
            "arguments": {}
          },
          "name": {
            "return": "string",
            "arguments": {}
          },
          "parent": {
            "return": {
              "browserTabTitle": {
                "return": "string",
                "arguments": {}
              },
              "faviconLink": {
                "return": "string",
                "arguments": {}
              },
              "id": {
                "return": "object",
                "arguments": {}
              },
              "name": {
                "return": "string",
                "arguments": {}
              },
              "parent": {
                "return": {
                  "browserTabTitle": {
                    "return": "string",
                    "arguments": {}
                  },
                  "faviconLink": {
                    "return": "string",
                    "arguments": {}
                  },
                  "id": {
                    "return": "object",
                    "arguments": {}
                  },
                  "name": {
                    "return": "string",
                    "arguments": {}
                  },
                  "parent": {
                    "return": {
                      "browserTabTitle": {
                        "return": "string",
                        "arguments": {}
                      },
                      "faviconLink": {
                        "return": "string",
                        "arguments": {}
                      },
                      "id": {
                        "return": "object",
                        "arguments": {}
                      },
                      "name": {
                        "return": "string"
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

UpdateScheduledIncomeFundTransferInput: object

amountPayableType:
annualAmountCents:
bankAccountId:
currency:
dateOfBirth:
frequency:
minimumAnnualAmountCents:
scheduledDate:
scheduledIncomeFundTransferId:
specialTaxRate:
subAccountId:
taxOption:
transferredAmountCents:
Example
{
  "amountPayableType": "string",
  "annualAmountCents": "object",
  "bankAccountId": "object",
  "currency": "string",
  "dateOfBirth": "object",
  "frequency": "string",
  "minimumAnnualAmountCents": "object",
  "scheduledDate": "object",
  "scheduledIncomeFundTransferId": "object",
  "specialTaxRate": "number",
  "subAccountId": "object",
  "taxOption": "string",
  "transferredAmountCents": "object"
}

UpdateScheduledIncomeFundTransferResponse: object

scheduledIncomeFundTransfer:
object
return:
arguments:
object
Example
{
  "scheduledIncomeFundTransfer": {
    "return": {
      "amountPayableType": {
        "return": "string",
        "arguments": {}
      },
      "annualAmountCents": {
        "return": "object",
        "arguments": {}
      },
      "bankAccount": {
        "return": {
          "EftEligibleRatio": {
            "return": "number",
            "arguments": {}
          },
          "bankAccountNumber": {
            "return": "string",
            "arguments": {}
          },
          "bankAccountNumberDisclosed": {
            "return": "string",
            "arguments": {}
          },
          "createdAt": {
            "return": "object",
            "arguments": {}
          },
          "downloadUrls": {
            "return": [
              "string"
            ],
            "arguments": {}
          },
          "id": {
            "return": "object",
            "arguments": {}
          },
          "institutionNumber": {
            "return": "string",
            "arguments": {}
          },
          "name": {
            "return": "string",
            "arguments": {}
          },
          "source": {
            "return": "string",
            "arguments": {}
          },
          "state": {
            "return": "string",
            "arguments": {}
          },
          "stateChanges": {
            "return": [
              "object"
            ],
            "arguments": {}
          },
          "transitNumber": {
            "return": "string",
            "arguments": {}
          },
          "transitNumberDisclosed": {
            "return": "string",
            "arguments": {}
          },
          "updatedAt": {
            "return": "object",
            "arguments": {}
          },
          "user": {
            "return": {
              "accessibleBy": {
                "return": [
                  {
                    "displayOptions": {
                      "return": {
                        "hide": {
                          "return": "boolean",
                          "arguments": {}
                        },
                        "order": {
                          "return": "number",
                          "arguments": {}
                        }
                      },
                      "arguments": {}
                    },
                    "organizationUser": {
                      "return": {
                        "accessType": {
                          "return": "string",
                          "arguments": {}
                        },
                        "apiTokens": {}
                      }
                    }
                  }
                ]
              }
            }
          }
        }
      }
    }
  }
}

UpdateScheduledTransferInput: object

amountCents:
bankAccountId:
currency:
frequency:
scheduledDate:
scheduledTransferId:
withdrawalReason:
withdrawalReasonDescription:
Example
{
  "amountCents": "object",
  "bankAccountId": "object",
  "currency": "string",
  "frequency": "string",
  "scheduledDate": "object",
  "scheduledTransferId": "object",
  "withdrawalReason": "string",
  "withdrawalReasonDescription": "object"
}

UpdateScheduledTransferResponse: object

scheduledTransfer:
object
return:
arguments:
object
Example
{
  "scheduledTransfer": {
    "return": {
      "amountCents": {
        "return": "object",
        "arguments": {}
      },
      "bankAccount": {
        "return": {
          "EftEligibleRatio": {
            "return": "number",
            "arguments": {}
          },
          "bankAccountNumber": {
            "return": "string",
            "arguments": {}
          },
          "bankAccountNumberDisclosed": {
            "return": "string",
            "arguments": {}
          },
          "createdAt": {
            "return": "object",
            "arguments": {}
          },
          "downloadUrls": {
            "return": [
              "string"
            ],
            "arguments": {}
          },
          "id": {
            "return": "object",
            "arguments": {}
          },
          "institutionNumber": {
            "return": "string",
            "arguments": {}
          },
          "name": {
            "return": "string",
            "arguments": {}
          },
          "source": {
            "return": "string",
            "arguments": {}
          },
          "state": {
            "return": "string",
            "arguments": {}
          },
          "stateChanges": {
            "return": [
              "object"
            ],
            "arguments": {}
          },
          "transitNumber": {
            "return": "string",
            "arguments": {}
          },
          "transitNumberDisclosed": {
            "return": "string",
            "arguments": {}
          },
          "updatedAt": {
            "return": "object",
            "arguments": {}
          },
          "user": {
            "return": {
              "accessibleBy": {
                "return": [
                  {
                    "displayOptions": {
                      "return": {
                        "hide": {
                          "return": "boolean",
                          "arguments": {}
                        },
                        "order": {
                          "return": "number",
                          "arguments": {}
                        }
                      },
                      "arguments": {}
                    },
                    "organizationUser": {
                      "return": {
                        "accessType": {
                          "return": "string",
                          "arguments": {}
                        },
                        "apiTokens": {
                          "return": [
                            {
                              "id": {}
                            }
                          ]
                        }
                      }
                    }
                  }
                ]
              }
            }
          }
        }
      }
    }
  }
}

UpdateSftpCredentialsInput: object

sftpInBucket:
sftpInDownloadFile:
sftpInHost:
sftpInPassword:
sftpInPort:
sftpInServerHostKey:
String
sftpInSourceDir:
sftpInTargetPrefix:
sftpInUsername:
sftpOutBucket:
sftpOutHost:
sftpOutPassword:
sftpOutPort:
sftpOutServerHostKey:
String
sftpOutTargetDir:
sftpOutUsername:
Example
{
  "sftpInBucket": "string",
  "sftpInDownloadFile": "boolean",
  "sftpInHost": "string",
  "sftpInPassword": "string",
  "sftpInPort": "string",
  "sftpInServerHostKey": [
    "string"
  ],
  "sftpInSourceDir": "string",
  "sftpInTargetPrefix": "string",
  "sftpInUsername": "string",
  "sftpOutBucket": "string",
  "sftpOutHost": "string",
  "sftpOutPassword": "string",
  "sftpOutPort": "string",
  "sftpOutServerHostKey": [
    "string"
  ],
  "sftpOutTargetDir": "string",
  "sftpOutUsername": "string"
}

UpdateStepInput: object

name:
subSteps:
CreateSubStepInput
Example
{
  "name": {
    "en": "object",
    "fr": "object"
  },
  "subSteps": [
    {
      "canGoBack": "boolean",
      "completeableBy": [
        "string"
      ],
      "options": "object",
      "rolesCompleteableBy": [
        "object"
      ],
      "skippable": "boolean",
      "type": "string"
    }
  ]
}

UpdateSubAccountBillingInput: object

adjustedFeeCents:
adjustedSalesTaxCents:
notes:
subAccountBillingId:
Example
{
  "adjustedFeeCents": "object",
  "adjustedSalesTaxCents": "object",
  "notes": "string",
  "subAccountBillingId": "object"
}

UpdateSubAccountBillingResponse: object

subAccountBilling:
object
return:
arguments:
object
Example
{
  "subAccountBilling": {
    "return": {
      "account": {
        "return": {
          "affiliations": {
            "return": [
              {
                "allocation": {
                  "return": "number",
                  "arguments": {}
                },
                "id": {
                  "return": "object",
                  "arguments": {}
                },
                "relation": {
                  "return": "string",
                  "arguments": {}
                },
                "signatureRequired": {
                  "return": "boolean",
                  "arguments": {}
                },
                "type": {
                  "return": "string",
                  "arguments": {}
                },
                "user": {
                  "return": {
                    "accessibleBy": {
                      "return": [
                        {
                          "displayOptions": {
                            "return": {
                              "hide": {
                                "return": "boolean",
                                "arguments": {}
                              },
                              "order": {
                                "return": "number",
                                "arguments": {}
                              }
                            },
                            "arguments": {}
                          },
                          "organizationUser": {
                            "return": {
                              "accessType": {
                                "return": "string",
                                "arguments": {}
                              },
                              "apiTokens": {
                                "return": [
                                  {
                                    "id": {
                                      "return": "object",
                                      "arguments": {}
                                    },
                                    "jwtToken": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "name": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "organization": {
                                      "return": {
                                        "browserTabTitle": {
                                          "return": "string",
                                          "arguments": {}
                                        },
                                        "faviconLink": {
                                          "return": "string",
                                          "arguments": {}
                                        },
                                        "id": {
                                          "return": "object",
                                          "arguments": {}
                                        },
                                        "name": {
                                          "return": "string",
                                          "arguments": {}
                                        },
                                        "parent": {
                                          "return": {
                                            "browserTabTitle": {
                                              "return": "string",
                                              "arguments": {}
                                            },
                                            "faviconLink": {}
                                          }
                                        }
                                      }
                                    }
                                  }
                                ]
                              }
                            }
                          }
                        }
                      ]
                    }
                  }
                }
              }
            ]
          }
        }
      }
    }
  }
}

UpdateSubAccountInput: object

allowClientDeposits:
billingScheduleId:
feeTierId:
financialProductId:
goalId:
isPartial:
lastUpdatedBy:
name:
skipIPS:
subAccountId:
themeId:
tradingProcess:
Example
{
  "allowClientDeposits": "boolean",
  "billingScheduleId": "object",
  "feeTierId": "object",
  "financialProductId": "object",
  "goalId": "object",
  "isPartial": "boolean",
  "lastUpdatedBy": "object",
  "name": "object",
  "skipIPS": "boolean",
  "subAccountId": "object",
  "themeId": "object",
  "tradingProcess": "string"
}

UpdateSubAccountResponse: object

subAccount:
object
return:
arguments:
object
Example
{
  "subAccount": {
    "return": {
      "acceptableFinancialProduct": {
        "return": "boolean",
        "arguments": {}
      },
      "account": {
        "return": {
          "affiliations": {
            "return": [
              {
                "allocation": {
                  "return": "number",
                  "arguments": {}
                },
                "id": {
                  "return": "object",
                  "arguments": {}
                },
                "relation": {
                  "return": "string",
                  "arguments": {}
                },
                "signatureRequired": {
                  "return": "boolean",
                  "arguments": {}
                },
                "type": {
                  "return": "string",
                  "arguments": {}
                },
                "user": {
                  "return": {
                    "accessibleBy": {
                      "return": [
                        {
                          "displayOptions": {
                            "return": {
                              "hide": {
                                "return": "boolean",
                                "arguments": {}
                              },
                              "order": {
                                "return": "number",
                                "arguments": {}
                              }
                            },
                            "arguments": {}
                          },
                          "organizationUser": {
                            "return": {
                              "accessType": {
                                "return": "string",
                                "arguments": {}
                              },
                              "apiTokens": {
                                "return": [
                                  {
                                    "id": {
                                      "return": "object",
                                      "arguments": {}
                                    },
                                    "jwtToken": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "name": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "organization": {
                                      "return": {
                                        "browserTabTitle": {
                                          "return": "string",
                                          "arguments": {}
                                        },
                                        "faviconLink": {
                                          "return": "string",
                                          "arguments": {}
                                        },
                                        "id": {
                                          "return": "object",
                                          "arguments": {}
                                        },
                                        "name": {
                                          "return": "string",
                                          "arguments": {}
                                        },
                                        "parent": {
                                          "return": {
                                            "browserTabTitle": {}
                                          }
                                        }
                                      }
                                    }
                                  }
                                ]
                              }
                            }
                          }
                        }
                      ]
                    }
                  }
                }
              }
            ]
          }
        }
      }
    }
  }
}

UpdateSubStepInput: object

canGoBack:
completeableBy:
SubStepCompleteableBys
options:
rolesCompleteableBy:
ObjectID
skippable:
Example
{
  "canGoBack": "boolean",
  "completeableBy": [
    "string"
  ],
  "options": "object",
  "rolesCompleteableBy": [
    "object"
  ],
  "skippable": "boolean"
}

UpdateSubTradeRequestInput: object

actualQuantity:
actualTradePriceCents:
expectedQuantity:
expectedTradePriceCents:
isSellAll:
maxQuantity:
moneyAllocatedCents:
subTradeRequestId:
type:
Example
{
  "actualQuantity": "number",
  "actualTradePriceCents": "number",
  "expectedQuantity": "number",
  "expectedTradePriceCents": "number",
  "isSellAll": "boolean",
  "maxQuantity": "number",
  "moneyAllocatedCents": "number",
  "subTradeRequestId": "object",
  "type": "string"
}

UpdateSubTradeRequestResponse: object

subTradeRequest:
object
return:
arguments:
object
Example
{
  "subTradeRequest": {
    "return": {
      "account": {
        "return": {
          "affiliations": {
            "return": [
              {
                "allocation": {
                  "return": "number",
                  "arguments": {}
                },
                "id": {
                  "return": "object",
                  "arguments": {}
                },
                "relation": {
                  "return": "string",
                  "arguments": {}
                },
                "signatureRequired": {
                  "return": "boolean",
                  "arguments": {}
                },
                "type": {
                  "return": "string",
                  "arguments": {}
                },
                "user": {
                  "return": {
                    "accessibleBy": {
                      "return": [
                        {
                          "displayOptions": {
                            "return": {
                              "hide": {
                                "return": "boolean",
                                "arguments": {}
                              },
                              "order": {
                                "return": "number",
                                "arguments": {}
                              }
                            },
                            "arguments": {}
                          },
                          "organizationUser": {
                            "return": {
                              "accessType": {
                                "return": "string",
                                "arguments": {}
                              },
                              "apiTokens": {
                                "return": [
                                  {
                                    "id": {
                                      "return": "object",
                                      "arguments": {}
                                    },
                                    "jwtToken": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "name": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "organization": {
                                      "return": {
                                        "browserTabTitle": {
                                          "return": "string",
                                          "arguments": {}
                                        },
                                        "faviconLink": {
                                          "return": "string",
                                          "arguments": {}
                                        },
                                        "id": {
                                          "return": "object",
                                          "arguments": {}
                                        },
                                        "name": {
                                          "return": "string",
                                          "arguments": {}
                                        },
                                        "parent": {
                                          "return": {
                                            "browserTabTitle": {
                                              "return": "string",
                                              "arguments": {}
                                            },
                                            "faviconLink": {}
                                          }
                                        }
                                      }
                                    }
                                  }
                                ]
                              }
                            }
                          }
                        }
                      ]
                    }
                  }
                }
              }
            ]
          }
        }
      }
    }
  }
}

UpdateSubTradeRequestsInput: object

subTradeRequests:
UpdateSubTradeRequestInput
Example
{
  "subTradeRequests": [
    {
      "actualQuantity": "number",
      "actualTradePriceCents": "number",
      "expectedQuantity": "number",
      "expectedTradePriceCents": "number",
      "isSellAll": "boolean",
      "maxQuantity": "number",
      "moneyAllocatedCents": "number",
      "subTradeRequestId": "object",
      "type": "string"
    }
  ]
}

UpdateSuccessorPhysicalAddressInput: object

city:
country:
houseNumber:
neighborhood:
postal:
province:
streetName:
unitNumber:
Example
{
  "city": "object",
  "country": "string",
  "houseNumber": "object",
  "neighborhood": "object",
  "postal": "object",
  "province": "string",
  "streetName": "object",
  "unitNumber": "object"
}

UpdateThemeInput: object

core:
iconKey:
key:
themeId:
translatedDescription:
translatedName:
translatedShortDescription:
Example
{
  "core": "boolean",
  "iconKey": "object",
  "key": "object",
  "themeId": "object",
  "translatedDescription": {
    "en": "object",
    "fr": "object"
  },
  "translatedName": {
    "en": "object",
    "fr": "object"
  },
  "translatedShortDescription": {
    "en": "object",
    "fr": "object"
  }
}

UpdateThemeResponse: object

theme:
object
return:
arguments:
object
Example
{
  "theme": {
    "return": {
      "core": {
        "return": "boolean",
        "arguments": {}
      },
      "description": {
        "return": "string",
        "arguments": {}
      },
      "iconKey": {
        "return": "string",
        "arguments": {}
      },
      "id": {
        "return": "object",
        "arguments": {}
      },
      "key": {
        "return": "string",
        "arguments": {}
      },
      "logs": {
        "return": {
          "logs": {
            "return": [
              {
                "account": {
                  "return": {
                    "affiliations": {
                      "return": [
                        {
                          "allocation": {
                            "return": "number",
                            "arguments": {}
                          },
                          "id": {
                            "return": "object",
                            "arguments": {}
                          },
                          "relation": {
                            "return": "string",
                            "arguments": {}
                          },
                          "signatureRequired": {
                            "return": "boolean",
                            "arguments": {}
                          },
                          "type": {
                            "return": "string",
                            "arguments": {}
                          },
                          "user": {
                            "return": {
                              "accessibleBy": {
                                "return": [
                                  {
                                    "displayOptions": {
                                      "return": {
                                        "hide": {
                                          "return": "boolean",
                                          "arguments": {}
                                        },
                                        "order": {
                                          "return": "number",
                                          "arguments": {}
                                        }
                                      },
                                      "arguments": {}
                                    },
                                    "organizationUser": {
                                      "return": {
                                        "accessType": {
                                          "return": "string",
                                          "arguments": {}
                                        },
                                        "apiTokens": {
                                          "return": [
                                            {
                                              "id": {
                                                "return": "object",
                                                "arguments": {}
                                              },
                                              "jwtToken": {
                                                "return": "string",
                                                "arguments": {}
                                              },
                                              "name": {
                                                "return": "string",
                                                "arguments": {}
                                              }
                                            }
                                          ]
                                        }
                                      }
                                    }
                                  }
                                ]
                              }
                            }
                          }
                        }
                      ]
                    }
                  }
                }
              }
            ]
          }
        }
      }
    }
  }
}

UpdateTransactionInput: object

currency:
date:
description:
financialProductId:
priceCents:
quantity:
transactionId:
valueCents:
Example
{
  "currency": "string",
  "date": "object",
  "description": "object",
  "financialProductId": "object",
  "priceCents": "number",
  "quantity": "number",
  "transactionId": "object",
  "valueCents": "number"
}

UpdateTransactionResponse: object

transaction:
object
return:
arguments:
object
Example
{
  "transaction": {
    "return": {
      "account": {
        "return": {
          "affiliations": {
            "return": [
              {
                "allocation": {
                  "return": "number",
                  "arguments": {}
                },
                "id": {
                  "return": "object",
                  "arguments": {}
                },
                "relation": {
                  "return": "string",
                  "arguments": {}
                },
                "signatureRequired": {
                  "return": "boolean",
                  "arguments": {}
                },
                "type": {
                  "return": "string",
                  "arguments": {}
                },
                "user": {
                  "return": {
                    "accessibleBy": {
                      "return": [
                        {
                          "displayOptions": {
                            "return": {
                              "hide": {
                                "return": "boolean",
                                "arguments": {}
                              },
                              "order": {
                                "return": "number",
                                "arguments": {}
                              }
                            },
                            "arguments": {}
                          },
                          "organizationUser": {
                            "return": {
                              "accessType": {
                                "return": "string",
                                "arguments": {}
                              },
                              "apiTokens": {
                                "return": [
                                  {
                                    "id": {
                                      "return": "object",
                                      "arguments": {}
                                    },
                                    "jwtToken": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "name": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "organization": {
                                      "return": {
                                        "browserTabTitle": {
                                          "return": "string",
                                          "arguments": {}
                                        },
                                        "faviconLink": {
                                          "return": "string",
                                          "arguments": {}
                                        },
                                        "id": {
                                          "return": "object",
                                          "arguments": {}
                                        },
                                        "name": {
                                          "return": "string",
                                          "arguments": {}
                                        },
                                        "parent": {
                                          "return": {
                                            "browserTabTitle": {
                                              "return": "string",
                                              "arguments": {}
                                            },
                                            "faviconLink": {}
                                          }
                                        }
                                      }
                                    }
                                  }
                                ]
                              }
                            }
                          }
                        }
                      ]
                    }
                  }
                }
              }
            ]
          }
        }
      }
    }
  }
}

UpdateTransferInput: object

amountCents:
bankAccountId:
currency:
source:
sourceId:
transferId:
type:
Example
{
  "amountCents": "object",
  "bankAccountId": "object",
  "currency": "string",
  "source": "string",
  "sourceId": "object",
  "transferId": "object",
  "type": "string"
}

UpdateTransferResponse: object

transfer:
object
return:
arguments:
object
Example
{
  "transfer": {
    "return": {
      "alertReport": {
        "return": {
          "id": {
            "return": "object",
            "arguments": {}
          },
          "reason": {
            "return": "string",
            "arguments": {}
          },
          "rules": {
            "return": [
              {
                "id": {
                  "return": "object",
                  "arguments": {}
                },
                "translatedDescription": {
                  "return": {
                    "en": {
                      "return": "string",
                      "arguments": {}
                    },
                    "fr": {
                      "return": "string",
                      "arguments": {}
                    }
                  },
                  "arguments": {}
                },
                "type": {
                  "return": "string",
                  "arguments": {}
                }
              }
            ],
            "arguments": {}
          },
          "state": {
            "return": "string",
            "arguments": {}
          },
          "transfer": {
            "return": {
              "alertReport": {
                "return": {
                  "id": {
                    "return": "object",
                    "arguments": {}
                  },
                  "reason": {
                    "return": "string",
                    "arguments": {}
                  },
                  "rules": {
                    "return": [
                      {
                        "id": {
                          "return": "object",
                          "arguments": {}
                        },
                        "translatedDescription": {
                          "return": {
                            "en": {
                              "return": "string",
                              "arguments": {}
                            },
                            "fr": {
                              "return": "string",
                              "arguments": {}
                            }
                          },
                          "arguments": {}
                        },
                        "type": {
                          "return": "string",
                          "arguments": {}
                        }
                      }
                    ],
                    "arguments": {}
                  },
                  "state": {
                    "return": "string",
                    "arguments": {}
                  },
                  "transfer": {
                    "return": {
                      "alertReport": {
                        "return": {
                          "id": {
                            "return": "object",
                            "arguments": {}
                          },
                          "reason": {
                            "return": "string"
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

UpdateUserIDVerificationInformationInput: object

Input type for updating a user's IdVerification

creditFileSource:
documentExpiryDate:

The expiry date of the document (Required for DIGITAL_DOCUMENT_CHECK method)

documentID:

The unique identifying number of the document used (Required for DIGITAL_DOCUMENT_CHECK method)

documentIssuingJurisdication:

The jurisdiction (province or state) and country of issue of the document (Required for DIGITAL_DOCUMENT_CHECK method)

documentType:

Type of the document used in the ID Verification (Required for DIGITAL_DOCUMENT_CHECK method)

idVerificationId:

idVerificationID

methodOfIDVerification:

Method used for ID verification.

secondaryDocumentExpiryDate:
secondaryDocumentID:
secondaryDocumentIssuingJurisdication:
secondaryDocumentType:
secondaryDocumentUserName:
userName:

The person's name on the document (Required for DIGITAL_DOCUMENT_CHECK method)

verifiedDate:

Date on which the ID was verified (Required for DIGITAL_DOCUMENT_CHECK method)

Example
{
  "creditFileSource": "object",
  "documentExpiryDate": "object",
  "documentID": "object",
  "documentIssuingJurisdication": "object",
  "documentType": "string",
  "idVerificationId": "object",
  "methodOfIDVerification": "string",
  "secondaryDocumentExpiryDate": "object",
  "secondaryDocumentID": "object",
  "secondaryDocumentIssuingJurisdication": "object",
  "secondaryDocumentType": "string",
  "secondaryDocumentUserName": "object",
  "userName": "object",
  "verifiedDate": "object"
}

UpdateUserInput: object

annualDebtPaymentsCents:

The amount in cents, that the user pays annually towards debts

annualIncomeCents:

User's annual income in amount cents

annualIncomeStr:

User's annual income in non-numeric form (range, category, etc)

billingScheduleId:
bulkAccountOpening:
businessIsMemberofIIROC:
businessPhone:
charityRegistrationNumber:
citizenships:
SafeString

Citizenships of the user

closeAssociateOfPEP:

Is the user a close associate of a politically exposed person?

companyType:

The type of company at which the user is employed

complianceIssueSource:
complianceState:
countryOfRegistration:
countryOfTaxResidence:
customFields:
CustomFieldInput
dateOfBirth:

User's Date of birth

dateOfDeath:

User's Date of death

debtAssociated:
DebtAssociated

The type of debt. Student loan, Mortgage or Credit Card debt, etc.

employerCompanyAddress:
employerName:
employmentSituation:
employmentSituationOtherDescription:
employmentStatus:

User's employment status

entityName:
establishedDate:
fatcaStatus:
fatcaStatusOtherDescription:
feeTierId:
financialFixedAssetsCents:

User's fixed assets in amount cents

financialLiquidAssetsCents:

User's liquid assets in amount cents

firmNumber:
firstName:

User's first name

foreignTaxInformation:
ForeignTaxInformationInput

The tax information provided by the user if the user pays tax to a foreign country

gender:

User's gender.

hasCheckedPolicyAndCondition:
headOfInternationalOrganization:

Is/Was the User the head of an international organization?

iDCheckCompleted:
iDCheckRetrigger:
identificationType:
inProvinceSince:
insiderSymbols:
SafeString
instructionsFromFinancialEntity:
integrations:
UserIntegrationInput
investmentKnowledge:

What is the user's level of investment knowledge?

isAFinancialEntity:
isAccreditedInvestor:

Is the client an accredited investor?

isAffiliateOfFinancialEntity:
isEntityForProfit:
isEntityRegulated:
isForThirdParty:
isLargeCorporation:
isMemberOfIiroc:

Is the user a member of IIROC? IIROC:Investment Industry Regulatory Organization of Canada

isNonProfit:
isOfficerOfPublicCompany:

Is the user a high-level management executive of a public company?

isOwnerOfEntity:
isOwnerOfPublicCompany:

Is the user the owner of a public company?

isPublicBody:
isRegisteredWithCRA:
isReportingIssuer:
isVulnerablePerson:
issuerExchange:
issuerName:
issuerTicker:
jobTitle:

User's job title, if employed

language:

Languages the user communicates in

lastName:

User's last name

lastSuitabilityReviewAt:
maritalStatus:

User's martial status

middleName:

User's middle name

numberOfDependents:
Int

Number of dependents associated with User

parentCompanyName:
payTaxesOutsideCanada:
phone:

User's phone number

physicalAddress:

User's address

politicallyExposedDomesticPerson:

Is the user a politically exposed person in Canada?

politicallyExposedForeignPerson:

Is the user a politically exposed person in a foreign country?

powerOfAttorneyGranted:

Has the User appointed a Power of Attorney?

preferredMethodOfCommunication:
preferredMethodOfCommunicationOtherDescription:
primaryEmail:

User's email address

readyToSignAgreement:
receivesDonationsFromPublic:
registrationNumber:
regulatorName:
relatedEntities:
RelatedEntityInput
retirementAge:
Int

Expected age the user wishes to retire

riskQuestion1:

User's answer to the first risk question

riskQuestion2:

User's answer to the second risk question

sin:

User's Social Insurance Number

sourceOfFunds:
UserSourceOfFunds
sourceOfFundsOtherDescription:
sourceOfWealth:
UserSourceOfWealth
sourceOfWealthOtherDescription:
spouseAddress:
spouseCompanyType:

User's spouse company type, if employed

spouseDateOfBirth:

User's spouse date of birth

spouseEmail:
spouseEmployerName:
spouseEmploymentType:
spouseFirstName:

User's spouse first name

spouseJobTitle:

User's spouse job title

spouseLastName:

User's spouse last name

spouseMiddleName:

User's spouse middle name

spouseSin:

User's spouse Social Insurance Number

ssSymbols:
SafeString
studentAreaOfStudy:

Area of study, if user is a student

taxId:

User's Tax ID: SIN/BN (Canada), SSN/ITIN/EIN (United States). See taxIdType.

taxIdType:

Type of taxId value

taxNumber:
timezone:

User's timezone Please use one of the following valid timezone formats:

'America/Blanc-Sablon' 'America/Glace_Bay' 'America/Goose_Bay' 'America/Halifax' 'America/Moncton' 'America/Dawson_Creek' 'America/Creston' 'America/Fort_Nelson' 'America/Cambridge_Bay' 'America/Edmonton' 'America/Inuvik' 'America/Yellowknife' 'America/Atikokan' 'America/Iqaluit' 'America/Nipigon' 'America/Pangnirtung' 'America/Thunder_Bay' 'America/Toronto' 'America/Rainy_River' 'America/Rankin_Inlet' 'America/Resolute' 'America/Winnipeg' 'America/Regina' 'America/Swift_Current' 'America/Dawson' 'America/Vancouver' 'America/Whitehorse'

totalDebtCents:

User's total debt in amount cents

trustedContactPerson:

User's trusted contact person

type:
uniqueCircumstances:
userId:
ID

UserID associated with the user

yearEnd:
Example
{
  "annualDebtPaymentsCents": "object",
  "annualIncomeCents": "object",
  "annualIncomeStr": "string",
  "billingScheduleId": "object",
  "bulkAccountOpening": "boolean",
  "businessIsMemberofIIROC": "boolean",
  "businessPhone": "object",
  "charityRegistrationNumber": "object",
  "citizenships": [
    "object"
  ],
  "closeAssociateOfPEP": "boolean",
  "companyType": "object",
  "complianceIssueSource": "object",
  "complianceState": "string",
  "countryOfRegistration": "object",
  "countryOfTaxResidence": "string",
  "customFields": [
    {
      "key": "object",
      "value": "object"
    }
  ],
  "dateOfBirth": "object",
  "dateOfDeath": "object",
  "debtAssociated": [
    "string"
  ],
  "employerCompanyAddress": {
    "city": "object",
    "country": "string",
    "houseNumber": "object",
    "jurisdiction": "string",
    "neighborhood": "object",
    "postal": "object",
    "province": "string",
    "streetName": "object",
    "unitNumber": "object"
  },
  "employerName": "object",
  "employmentSituation": "string",
  "employmentSituationOtherDescription": "object",
  "employmentStatus": "string",
  "entityName": "object",
  "establishedDate": "object",
  "fatcaStatus": "string",
  "fatcaStatusOtherDescription": "object",
  "feeTierId": "object",
  "financialFixedAssetsCents": "object",
  "financialLiquidAssetsCents": "object",
  "firmNumber": "object",
  "firstName": "object",
  "foreignTaxInformation": [
    {
      "foreignTaxCountry": "object",
      "foreignTaxNumber": "object"
    }
  ]
}

UpdateUserOrganizationInput: object

Input type for Updating a user Organization

newOrganizationId:

New OrganizationID

userId:

UserID

Example
{
  "newOrganizationId": "object",
  "userId": "object"
}

UpdateUserOrganizationResponse: object

user:
object
return:
arguments:
object
Example
{
  "user": {
    "return": {
      "accessibleBy": {
        "return": [
          {
            "displayOptions": {
              "return": {
                "hide": {
                  "return": "boolean",
                  "arguments": {}
                },
                "order": {
                  "return": "number",
                  "arguments": {}
                }
              },
              "arguments": {}
            },
            "organizationUser": {
              "return": {
                "accessType": {
                  "return": "string",
                  "arguments": {}
                },
                "apiTokens": {
                  "return": [
                    {
                      "id": {
                        "return": "object",
                        "arguments": {}
                      },
                      "jwtToken": {
                        "return": "string",
                        "arguments": {}
                      },
                      "name": {
                        "return": "string",
                        "arguments": {}
                      },
                      "organization": {
                        "return": {
                          "browserTabTitle": {
                            "return": "string",
                            "arguments": {}
                          },
                          "faviconLink": {
                            "return": "string",
                            "arguments": {}
                          },
                          "id": {
                            "return": "object",
                            "arguments": {}
                          },
                          "name": {
                            "return": "string",
                            "arguments": {}
                          },
                          "parent": {
                            "return": {
                              "browserTabTitle": {
                                "return": "string",
                                "arguments": {}
                              },
                              "faviconLink": {
                                "return": "string",
                                "arguments": {}
                              },
                              "id": {
                                "return": "object",
                                "arguments": {}
                              },
                              "name": {
                                "return": "string",
                                "arguments": {}
                              },
                              "parent": {
                                "return": {
                                  "browserTabTitle": {
                                    "return": "string",
                                    "arguments": {}
                                  },
                                  "faviconLink": {
                                    "return": "string",
                                    "arguments": {}
                                  },
                                  "id": {
                                    "return": "object",
                                    "arguments": {}
                                  },
                                  "name": {
                                    "return": "string",
                                    "arguments": {}
                                  }
                                }
                              }
                            }
                          }
                        }
                      }
                    }
                  ]
                }
              }
            }
          }
        ]
      }
    }
  }
}

UpdateUserOrganizationUserDisplayOptionsInput: object

displayOptions:
OrganizationUserDisplayOptions
userId:
Example
{
  "displayOptions": [
    {
      "hide": "boolean",
      "order": "number",
      "organizationUserId": "object"
    }
  ],
  "userId": "object"
}

UpdateUserOrganizationUserDisplayOptionsResponse: object

userOrganizationUserDisplayOptions:
object
return:
UserOrganizationUserDisplayOptions
arguments:
object
Example
{
  "userOrganizationUserDisplayOptions": {
    "return": [
      {
        "hide": {
          "return": "boolean",
          "arguments": {}
        },
        "id": {
          "return": "object",
          "arguments": {}
        },
        "order": {
          "return": "number",
          "arguments": {}
        },
        "organizationUser": {
          "return": {
            "accessType": {
              "return": "string",
              "arguments": {}
            },
            "apiTokens": {
              "return": [
                {
                  "id": {
                    "return": "object",
                    "arguments": {}
                  },
                  "jwtToken": {
                    "return": "string",
                    "arguments": {}
                  },
                  "name": {
                    "return": "string",
                    "arguments": {}
                  },
                  "organization": {
                    "return": {
                      "browserTabTitle": {
                        "return": "string",
                        "arguments": {}
                      },
                      "faviconLink": {
                        "return": "string",
                        "arguments": {}
                      },
                      "id": {
                        "return": "object",
                        "arguments": {}
                      },
                      "name": {
                        "return": "string",
                        "arguments": {}
                      },
                      "parent": {
                        "return": {
                          "browserTabTitle": {
                            "return": "string",
                            "arguments": {}
                          },
                          "faviconLink": {
                            "return": "string",
                            "arguments": {}
                          },
                          "id": {
                            "return": "object",
                            "arguments": {}
                          },
                          "name": {
                            "return": "string",
                            "arguments": {}
                          },
                          "parent": {
                            "return": {
                              "browserTabTitle": {
                                "return": "string",
                                "arguments": {}
                              },
                              "faviconLink": {
                                "return": "string",
                                "arguments": {}
                              },
                              "id": {
                                "return": "object",
                                "arguments": {}
                              },
                              "name": {
                                "return": "string",
                                "arguments": {}
                              },
                              "parent": {
                                "return": {}
                              }
                            }
                          }
                        }
                      }
                    }
                  }
                }
              ]
            }
          }
        }
      }
    ]
  }
}

UpdateUserResponse: object

Type definition for updating the user's information

user:
object

User object

return:
arguments:
object
Example
{
  "user": {
    "return": {
      "accessibleBy": {
        "return": [
          {
            "displayOptions": {
              "return": {
                "hide": {
                  "return": "boolean",
                  "arguments": {}
                },
                "order": {
                  "return": "number",
                  "arguments": {}
                }
              },
              "arguments": {}
            },
            "organizationUser": {
              "return": {
                "accessType": {
                  "return": "string",
                  "arguments": {}
                },
                "apiTokens": {
                  "return": [
                    {
                      "id": {
                        "return": "object",
                        "arguments": {}
                      },
                      "jwtToken": {
                        "return": "string",
                        "arguments": {}
                      },
                      "name": {
                        "return": "string",
                        "arguments": {}
                      },
                      "organization": {
                        "return": {
                          "browserTabTitle": {
                            "return": "string",
                            "arguments": {}
                          },
                          "faviconLink": {
                            "return": "string",
                            "arguments": {}
                          },
                          "id": {
                            "return": "object",
                            "arguments": {}
                          },
                          "name": {
                            "return": "string",
                            "arguments": {}
                          },
                          "parent": {
                            "return": {
                              "browserTabTitle": {
                                "return": "string",
                                "arguments": {}
                              },
                              "faviconLink": {
                                "return": "string",
                                "arguments": {}
                              },
                              "id": {
                                "return": "object",
                                "arguments": {}
                              },
                              "name": {
                                "return": "string",
                                "arguments": {}
                              },
                              "parent": {
                                "return": {
                                  "browserTabTitle": {
                                    "return": "string",
                                    "arguments": {}
                                  },
                                  "faviconLink": {
                                    "return": "string",
                                    "arguments": {}
                                  },
                                  "id": {
                                    "return": "object",
                                    "arguments": {}
                                  },
                                  "name": {
                                    "return": "string",
                                    "arguments": {}
                                  }
                                }
                              }
                            }
                          }
                        }
                      }
                    }
                  ]
                }
              }
            }
          }
        ]
      }
    }
  }
}

UpdateWebhookInput: object

customHeaders:

Any custom headers that may need to be set to be sent with the mutation to the assigned url.

customPayloadAttributes:

Any custom payload that may need to be sent on the body along with the fetched data (REST type only). If informed, the fetched data will be sent as an object in the 'payload' attribute.

eventType:

The event type on the object that gets actioned to then send off the webhook.

gql:

The graphql query string that would be used to query the OneVest partner gateway usually. The variable of '$id' is used for the actioned object.

mutationInputName:

The name of the input that the webhook will pass, it will always pass as variable 'input' (GRAPHQL type only).

mutationName:

The name of the mutation that the webhook will hit (GRAPHQL type only).

objectType:

The type of object you want to listen to, to receive a webhook on.

signedJwtHeader:

Any custom header through which the signed JWT may need to be sent (REST type only). If not informed, the signed JWT will be sent in the 'OneVest-Authorization' header.

url:

GraphQL URL in which the webhook will hit.

webhookId:
Example
{
  "customHeaders": "object",
  "customPayloadAttributes": "object",
  "eventType": "string",
  "gql": "string",
  "mutationInputName": "string",
  "mutationName": "string",
  "objectType": "string",
  "signedJwtHeader": "string",
  "url": "string",
  "webhookId": "object"
}

UpdateWebhookResponse: object

webhook:
object
return:
arguments:
object
Example
{
  "webhook": {
    "return": {
      "customHeaders": {
        "return": "object",
        "arguments": {}
      },
      "customPayloadAttributes": {
        "return": "object",
        "arguments": {}
      },
      "eventType": {
        "return": "string",
        "arguments": {}
      },
      "gql": {
        "return": "string",
        "arguments": {}
      },
      "id": {
        "return": "object",
        "arguments": {}
      },
      "mutationInputName": {
        "return": "string",
        "arguments": {}
      },
      "mutationName": {
        "return": "string",
        "arguments": {}
      },
      "objectType": {
        "return": "string",
        "arguments": {}
      },
      "organization": {
        "return": {
          "accountTypeTaxRanks": {
            "return": [
              {
                "accountType": {
                  "return": "string",
                  "arguments": {}
                },
                "id": {
                  "return": "object",
                  "arguments": {}
                },
                "taxRank": {
                  "return": "number",
                  "arguments": {}
                }
              }
            ],
            "arguments": {}
          },
          "allowAccessToSubOrganizations": {
            "return": "boolean",
            "arguments": {}
          },
          "allowDirectCommunication": {
            "return": "boolean",
            "arguments": {}
          },
          "allowInactiveUserAdjustments": {
            "return": "boolean",
            "arguments": {}
          },
          "allowInactiveUserFeeCalculation": {
            "return": "boolean",
            "arguments": {}
          },
          "allowInactiveUserRebalancing": {
            "return": "boolean",
            "arguments": {}
          },
          "allowInstantInvest": {
            "return": "boolean",
            "arguments": {}
          },
          "allowPortfolioPerGoal": {
            "return": "boolean",
            "arguments": {}
          },
          "allowPostOptimizationEditing": {
            "return": "boolean",
            "arguments": {}
          },
          "allowViewSubTradeRequestPairs": {
            "return": "boolean",
            "arguments": {}
          },
          "applicableJurisdictions": {
            "return": {
              "all": {
                "return": "boolean",
                "arguments": {}
              },
              "only": {}
            }
          }
        }
      }
    }
  }
}

UpdateWorkflowCompletionInput: object

context:
workflowCompletionId:
Example
{
  "context": "object",
  "workflowCompletionId": "object"
}

UpdateWorkflowCompletionResponse: object

workflowCompletion:
object
return:
arguments:
object
Example
{
  "workflowCompletion": {
    "return": {
      "context": {
        "return": "object",
        "arguments": {}
      },
      "createdAt": {
        "return": "object",
        "arguments": {}
      },
      "currentStep": {
        "return": {
          "id": {
            "return": "object",
            "arguments": {}
          },
          "name": {
            "return": {
              "en": {
                "return": "string",
                "arguments": {}
              },
              "fr": {
                "return": "string",
                "arguments": {}
              }
            },
            "arguments": {}
          },
          "subSteps": {
            "return": [
              {
                "canGoBack": {
                  "return": "boolean",
                  "arguments": {}
                },
                "completeableBy": {
                  "return": [
                    "string"
                  ],
                  "arguments": {}
                },
                "id": {
                  "return": "object",
                  "arguments": {}
                },
                "options": {
                  "return": "object",
                  "arguments": {}
                },
                "rolesCompleteableBy": {
                  "return": [
                    {
                      "accessiblePages": {
                        "return": [
                          "string"
                        ],
                        "arguments": {}
                      },
                      "accountPageConfiguration": {
                        "return": {
                          "createdAt": {
                            "return": "object",
                            "arguments": {}
                          },
                          "id": {
                            "return": "object",
                            "arguments": {}
                          },
                          "name": {
                            "return": "string",
                            "arguments": {}
                          },
                          "options": {
                            "return": "object",
                            "arguments": {}
                          },
                          "organization": {
                            "return": {
                              "accountTypeTaxRanks": {
                                "return": [
                                  {
                                    "accountType": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "id": {
                                      "return": "object",
                                      "arguments": {}
                                    },
                                    "taxRank": {
                                      "return": "number",
                                      "arguments": {}
                                    }
                                  }
                                ],
                                "arguments": {}
                              }
                            }
                          }
                        }
                      }
                    }
                  ]
                }
              }
            ]
          }
        }
      }
    }
  }
}

UpdateWorkflowInput: object

eventType:
name:
objectType:
steps:
UpdateStepInput
triggerRules:
TriggerRuleInput
triggerType:
workflowId:
Example
{
  "eventType": "string",
  "name": {
    "en": "object",
    "fr": "object"
  },
  "objectType": "string",
  "steps": [
    {
      "name": {
        "en": "object",
        "fr": "object"
      },
      "subSteps": [
        {
          "canGoBack": "boolean",
          "completeableBy": [
            "string"
          ],
          "options": "object",
          "rolesCompleteableBy": [
            "object"
          ],
          "skippable": "boolean",
          "type": "string"
        }
      ]
    }
  ],
  "triggerRules": [
    {
      "comparison": "string",
      "field": "object",
      "value": "object"
    }
  ],
  "triggerType": "string",
  "workflowId": "object"
}

UpdateWorkflowResponse: object

workflow:
object
return:
arguments:
object
Example
{
  "workflow": {
    "return": {
      "createdAt": {
        "return": "object",
        "arguments": {}
      },
      "eventType": {
        "return": "string",
        "arguments": {}
      },
      "id": {
        "return": "object",
        "arguments": {}
      },
      "name": {
        "return": {
          "en": {
            "return": "string",
            "arguments": {}
          },
          "fr": {
            "return": "string",
            "arguments": {}
          }
        },
        "arguments": {}
      },
      "objectType": {
        "return": "string",
        "arguments": {}
      },
      "organization": {
        "return": {
          "accountTypeTaxRanks": {
            "return": [
              {
                "accountType": {
                  "return": "string",
                  "arguments": {}
                },
                "id": {
                  "return": "object",
                  "arguments": {}
                },
                "taxRank": {
                  "return": "number",
                  "arguments": {}
                }
              }
            ],
            "arguments": {}
          },
          "allowAccessToSubOrganizations": {
            "return": "boolean",
            "arguments": {}
          },
          "allowDirectCommunication": {
            "return": "boolean",
            "arguments": {}
          },
          "allowInactiveUserAdjustments": {
            "return": "boolean",
            "arguments": {}
          },
          "allowInactiveUserFeeCalculation": {
            "return": "boolean",
            "arguments": {}
          },
          "allowInactiveUserRebalancing": {
            "return": "boolean",
            "arguments": {}
          },
          "allowInstantInvest": {
            "return": "boolean",
            "arguments": {}
          },
          "allowPortfolioPerGoal": {
            "return": "boolean",
            "arguments": {}
          },
          "allowPostOptimizationEditing": {
            "return": "boolean",
            "arguments": {}
          },
          "allowViewSubTradeRequestPairs": {
            "return": "boolean",
            "arguments": {}
          },
          "applicableJurisdictions": {
            "return": {
              "all": {
                "return": "boolean",
                "arguments": {}
              },
              "only": {
                "return": [
                  "string"
                ],
                "arguments": {}
              }
            }
          }
        }
      }
    }
  }
}

User: object

Type definition for User

accessibleBy:
object

OrganizationUsers allowed to access this entity

return:
EntityOrganizationUser
arguments:
object
accounts:
object
return:
Account
arguments:
object
activeWorkflowCompletions:
object
return:
WorkflowCompletion
arguments:
object
affiliateOnly:
object
return:
arguments:
object
allIncompleteFormAgreements:
object
return:
IncompleteFormAgreement
arguments:
object
allLatestFormAgreements:
object
return:
FormAgreement
arguments:
object
annualDebtPaymentsCents:
object

The amount in cents, that the user pays annually, towards debts

return:
arguments:
object
annualIncomeCents:
object

User's annual income in amount cents

return:
arguments:
object
annualIncomeStr:
object

User's annual income in non-numeric form (range, category, etc)

return:
arguments:
object
applicableBillingSchedule:
object
return:
arguments:
object
applicableFeeTier:
object
return:
arguments:
object
availableCurrencies:
object
return:
AccountCurrencyTypes
arguments:
object
availableFinancialProducts:
object
return:
FinancialProduct
arguments:
object
bankAccounts:
object
return:
BankAccount
arguments:
object
billingSchedule:
object
return:
arguments:
object
bulkAccountOpening:
object
return:
arguments:
object
businessIsMemberofIIROC:
object
return:
arguments:
object
businessPhone:
object
return:
arguments:
object
charityRegistrationNumber:
object
return:
arguments:
object
citizenships:
object

Citizenships of the User

return:
String
arguments:
object
closeAssociateOfPEP:
object

Is the user a close associate of politically exposed person?

return:
arguments:
object
companyType:
object

The type of company at which the User is employed

return:
arguments:
object
completedAt:
object

The date and time the user profile was completed

return:
arguments:
object
complianceIssueSource:
object
return:
arguments:
object
complianceState:
object
return:
arguments:
object
countryOfRegistration:
object
return:
arguments:
object
countryOfTaxResidence:
object
return:
arguments:
object
createdAt:
object

The date and time this User was created

return:
arguments:
object
custodianCustomFields:
object
return:
CustodianCustomField
arguments:
object
custodianSnapshotHistory:
object
return:
CustodianSnapshotHistory
arguments:
object
endDate:
input:
startDate:
custodianStatistics:
object
return:
arguments:
object
endDate:
input:
startDate:
custodianSuitabilityScore:
object
return:
arguments:
object
customFields:
object
return:
CustomFieldValue
arguments:
object
keys:
String
dateOfBirth:
object

User's date of birth

return:
arguments:
object
dateOfDeath:
object

Decedent's date of death

return:
arguments:
object
debtAssociated:
object

The type of debt. Student loan, Mortgage or Credit Card debt, etc.

return:
DebtAssociated
arguments:
object
employerCompanyAddress:
object
return:
arguments:
object
employerName:
object
return:
arguments:
object
employmentSituation:
object
return:
arguments:
object
employmentSituationOtherDescription:
object
return:
arguments:
object
employmentStatus:
object

User's employment status

return:
arguments:
object
entityName:
object
return:
arguments:
object
establishedDate:
object
return:
arguments:
object
fatcaStatus:
object
return:
arguments:
object
fatcaStatusOtherDescription:
object
return:
arguments:
object
feeTier:
object
return:
arguments:
object
financialFixedAssetsCents:
object

User's fixed assets in amount cents

return:
arguments:
object
financialLiquidAssetsCents:
object

User's liquid assets in amount cents

return:
arguments:
object
firmNumber:
object
return:
arguments:
object
firstName:
object

User's first name

return:
arguments:
object
foreignTaxInformation:
object

The tax information provided by the user if the user pays tax to a foreign country

return:
ForeignTaxInformation
arguments:
object
fraudRisk:
object
return:
arguments:
object
gender:
object

User's gender

return:
arguments:
object
goals:
object
return:
Goal
arguments:
object
hasCheckedPolicyAndCondition:
object
return:
arguments:
object
headOfInternationalOrganization:
object

Is/Was the User the head of an international organization?

return:
arguments:
object
household:
object
return:
arguments:
object
households:
object
return:
ClientGroup
arguments:
object
iDCheckCompleted:
object
return:
arguments:
object
iDCheckRetrigger:
object
return:
arguments:
object
iDVerified:
object
return:
arguments:
object
id:
object

UserID

return:
arguments:
object
identificationType:
object
return:
arguments:
object
inProvinceSince:
object
return:
arguments:
object
incompleteFields:
object

Fields required to be completed to transition a user profile to a complete UserState

return:
String
arguments:
object
incompleteFormAgreements:
object

Lists remaining forms to be signed for this user.

return:
IncompleteFormAgreement
arguments:
object
insiderSymbols:
object
return:
String
arguments:
object
instructionsFromFinancialEntity:
object
return:
arguments:
object
integrations:
object
return:
UserIntegration
arguments:
object
investmentKnowledge:
object

What is the user's level of investment knowledge?

return:
arguments:
object
isAFinancialEntity:
object
return:
arguments:
object
isAccreditedInvestor:
object

Is the client an accredited investor?

return:
arguments:
object
isAffiliateOfFinancialEntity:
object
return:
arguments:
object
isEntityForProfit:
object
return:
arguments:
object
isEntityRegulated:
object
return:
arguments:
object
isForThirdParty:
object
return:
arguments:
object
isLargeCorporation:
object
return:
arguments:
object
isMemberOfIiroc:
object

Is the user a member of IIROC? IIROC:Investment Industry Regulatory Organization of Canada

return:
arguments:
object
isNonProfit:
object
return:
arguments:
object
isOfficerOfPublicCompany:
object

Is the user a high-level management executive of a public company?

return:
arguments:
object
isOwnerOfEntity:
object
return:
arguments:
object
isOwnerOfPublicCompany:
object

Is the user the owner of a public company?

return:
arguments:
object
isPublicBody:
object
return:
arguments:
object
isRegisteredWithCRA:
object
return:
arguments:
object
isReportingIssuer:
object
return:
arguments:
object
isVulnerablePerson:
object
return:
arguments:
object
issuerExchange:
object
return:
arguments:
object
issuerName:
object
return:
arguments:
object
issuerTicker:
object
return:
arguments:
object
jobTitle:
object

User's job title, if employed

return:
arguments:
object
language:
object

Languages the user communicates in

return:
arguments:
object
lastName:
object

User's last name

return:
arguments:
object
lastSuitabilityReviewAt:
object
return:
arguments:
object
lastUpdatedBy:
object
return:
arguments:
object
latestFormAgreements:
object

Lists latest signed forms for this user.

return:
FormAgreement
arguments:
object
latestIdVerification:
object

User latest ID verification

return:
arguments:
object
latestNsfs:
object
return:
Int
arguments:
object
logs:
object
return:
arguments:
object
input:
maritalStatus:
object

User's martial status

return:
arguments:
object
middleName:
object

User's middle name

return:
arguments:
object
numberOfDependents:
object

Number of dependents associated with User

return:
Int
arguments:
object
organization:
object
return:
arguments:
object
parentCompanyName:
object
return:
arguments:
object
payTaxesOutsideCanada:
object
return:
arguments:
object
phone:
object

User's phone number

return:
arguments:
object
physicalAddress:
object

User's address

return:
arguments:
object
politicallyExposedDomesticPerson:
object

Is the user a politically exposed person in a Canada?

return:
arguments:
object
politicallyExposedForeignPerson:
object

Is the user a politically exposed person in a foreign country?

return:
arguments:
object
positionAtEntity:
object
return:
arguments:
object
powerOfAttorneyGranted:
object

Has the User appointed a Power of Attorney?

return:
arguments:
object
preferredMethodOfCommunication:
object
return:
arguments:
object
preferredMethodOfCommunicationOtherDescription:
object
return:
arguments:
object
primaryEmail:
object

User's email address

return:
arguments:
object
readyToSignAgreement:
object
return:
arguments:
object
receivesDonationsFromPublic:
object
return:
arguments:
object
registrationNumber:
object
return:
arguments:
object
regulatorName:
object
return:
arguments:
object
relatedEntities:
object
return:
RelatedEntity
arguments:
object
retirementAge:
object

The age at which the User expects to retire

return:
Int
arguments:
object
riskQuestion1:
object

User's answer to the first risk question

return:
arguments:
object
riskQuestion2:
object

User's answer to the second risk question

return:
arguments:
object
sinExists:
object

Has the social insurance number (SIN) been informed?

return:
arguments:
object
sourceOfFunds:
object
return:
UserSourceOfFunds
arguments:
object
sourceOfFundsOtherDescription:
object
return:
arguments:
object
sourceOfWealth:
object
return:
UserSourceOfWealth
arguments:
object
sourceOfWealthOtherDescription:
object
return:
arguments:
object
spouseAddress:
object
return:
arguments:
object
spouseCompanyType:
object

User's spouse company type

return:
arguments:
object
spouseDateOfBirth:
object

User's spouse date of birth

return:
arguments:
object
spouseEmail:
object
return:
arguments:
object
spouseEmployerName:
object
return:
arguments:
object
spouseEmploymentType:
object
return:
arguments:
object
spouseFirstName:
object

User's spouse first name

return:
arguments:
object
spouseJobTitle:
object

User's spouse job title, if employed

return:
arguments:
object
spouseLastName:
object

User's spouse last name

return:
arguments:
object
spouseMiddleName:
object

User's spouse middle name

return:
arguments:
object
spouseSin:
object

User's spouse Social Insurance Number

return:
arguments:
object
ssSymbols:
object
return:
String
arguments:
object
state:
object

This transitions to COMPLETE if all the required fields for a user profile has been filled in. Check User's "incompleteFields" to see what fields need to be completed

return:
arguments:
object
stateChanges:
object

List of all state changes

return:
StateChanges
arguments:
object
statistics:
object
return:
arguments:
object
input:
stats:
object
return:
arguments:
object
force:

Force cache miss. Re-calculates statistics with current data.

statsV2:
object
return:
arguments:
object
studentAreaOfStudy:
object

Area of study, if User is a student

return:
arguments:
object
subAccounts:
object
return:
SubAccount
arguments:
object
suggestedFinancialProduct:
object
return:
arguments:
object
suitabilityReviewOverdue:
object
return:
arguments:
object
suitabilityScore:
object

User's suitability score

return:
Int
arguments:
object
taxId:
object

Tax identification number: SIN/BN (Canada), SSN/ITIN/EIN (United States). See taxIdType.

return:
arguments:
object
taxIdExists:
object

Has the taxId been informed?

return:
arguments:
object
taxIdType:
object
return:
arguments:
object
taxNumber:
object
return:
arguments:
object
timezone:
object

The User's timezone

return:
arguments:
object
totalDebtCents:
object

User's total debt in amount cents

return:
arguments:
object
trustedContactPerson:
object

User's trusted contact person

return:
arguments:
object
type:
object
return:
arguments:
object
uniqueCircumstances:
object
return:
arguments:
object
updatedAt:
object

The date and time this User's information was last updated

return:
arguments:
object
yearEnd:
object
return:
arguments:
object
Example
{
  "accessibleBy": {
    "return": [
      {
        "displayOptions": {
          "return": {
            "hide": {
              "return": "boolean",
              "arguments": {}
            },
            "order": {
              "return": "number",
              "arguments": {}
            }
          },
          "arguments": {}
        },
        "organizationUser": {
          "return": {
            "accessType": {
              "return": "string",
              "arguments": {}
            },
            "apiTokens": {
              "return": [
                {
                  "id": {
                    "return": "object",
                    "arguments": {}
                  },
                  "jwtToken": {
                    "return": "string",
                    "arguments": {}
                  },
                  "name": {
                    "return": "string",
                    "arguments": {}
                  },
                  "organization": {
                    "return": {
                      "browserTabTitle": {
                        "return": "string",
                        "arguments": {}
                      },
                      "faviconLink": {
                        "return": "string",
                        "arguments": {}
                      },
                      "id": {
                        "return": "object",
                        "arguments": {}
                      },
                      "name": {
                        "return": "string",
                        "arguments": {}
                      },
                      "parent": {
                        "return": {
                          "browserTabTitle": {
                            "return": "string",
                            "arguments": {}
                          },
                          "faviconLink": {
                            "return": "string",
                            "arguments": {}
                          },
                          "id": {
                            "return": "object",
                            "arguments": {}
                          },
                          "name": {
                            "return": "string",
                            "arguments": {}
                          },
                          "parent": {
                            "return": {
                              "browserTabTitle": {
                                "return": "string",
                                "arguments": {}
                              },
                              "faviconLink": {
                                "return": "string",
                                "arguments": {}
                              },
                              "id": {
                                "return": "object",
                                "arguments": {}
                              },
                              "name": {
                                "return": "string",
                                "arguments": {}
                              },
                              "parent": {
                                "return": {}
                              }
                            }
                          }
                        }
                      }
                    }
                  }
                }
              ]
            }
          }
        }
      }
    ]
  }
}

UserBilling: object

accounts:
object
return:
AccountBilling
arguments:
object
user:
object
return:
arguments:
object
Example
{
  "accounts": {
    "return": [
      {
        "account": {
          "return": {
            "affiliations": {
              "return": [
                {
                  "allocation": {
                    "return": "number",
                    "arguments": {}
                  },
                  "id": {
                    "return": "object",
                    "arguments": {}
                  },
                  "relation": {
                    "return": "string",
                    "arguments": {}
                  },
                  "signatureRequired": {
                    "return": "boolean",
                    "arguments": {}
                  },
                  "type": {
                    "return": "string",
                    "arguments": {}
                  },
                  "user": {
                    "return": {
                      "accessibleBy": {
                        "return": [
                          {
                            "displayOptions": {
                              "return": {
                                "hide": {
                                  "return": "boolean",
                                  "arguments": {}
                                },
                                "order": {
                                  "return": "number",
                                  "arguments": {}
                                }
                              },
                              "arguments": {}
                            },
                            "organizationUser": {
                              "return": {
                                "accessType": {
                                  "return": "string",
                                  "arguments": {}
                                },
                                "apiTokens": {
                                  "return": [
                                    {
                                      "id": {
                                        "return": "object",
                                        "arguments": {}
                                      },
                                      "jwtToken": {
                                        "return": "string",
                                        "arguments": {}
                                      },
                                      "name": {
                                        "return": "string",
                                        "arguments": {}
                                      },
                                      "organization": {
                                        "return": {
                                          "browserTabTitle": {
                                            "return": "string",
                                            "arguments": {}
                                          },
                                          "faviconLink": {
                                            "return": "string",
                                            "arguments": {}
                                          },
                                          "id": {
                                            "return": "object",
                                            "arguments": {}
                                          },
                                          "name": {
                                            "return": "string",
                                            "arguments": {}
                                          },
                                          "parent": {
                                            "return": {
                                              "browserTabTitle": {
                                                "return": "string",
                                                "arguments": {}
                                              }
                                            }
                                          }
                                        }
                                      }
                                    }
                                  ]
                                }
                              }
                            }
                          }
                        ]
                      }
                    }
                  }
                }
              ]
            }
          }
        }
      }
    ]
  }
}

UserFilterInput: object

affiliateUsersOnly:
isComplete:
organizationId:
query:
types:
EntityTypes

limits search to specific entity types

Example
{
  "affiliateUsersOnly": "boolean",
  "isComplete": "boolean",
  "organizationId": "object",
  "query": "string",
  "types": [
    "string"
  ]
}

UserIDVerificationResponse: object

Type definition for user's IdVerification

idVerification:
object

idVerification Object

return:
arguments:
object
Example
{
  "idVerification": {
    "return": {
      "creditFileSource": {
        "return": "object",
        "arguments": {}
      },
      "documentExpiryDate": {
        "return": "object",
        "arguments": {}
      },
      "documentID": {
        "return": "string",
        "arguments": {}
      },
      "documentIssuingJurisdication": {
        "return": "string",
        "arguments": {}
      },
      "documentType": {
        "return": "string",
        "arguments": {}
      },
      "id": {
        "return": "object",
        "arguments": {}
      },
      "methodOfIDVerification": {
        "return": "string",
        "arguments": {}
      },
      "secondaryDocumentExpiryDate": {
        "return": "object",
        "arguments": {}
      },
      "secondaryDocumentID": {
        "return": "string",
        "arguments": {}
      },
      "secondaryDocumentIssuingJurisdication": {
        "return": "string",
        "arguments": {}
      },
      "secondaryDocumentType": {
        "return": "string",
        "arguments": {}
      },
      "secondaryDocumentUserName": {
        "return": "object",
        "arguments": {}
      },
      "state": {
        "return": "string",
        "arguments": {}
      },
      "user": {
        "return": {
          "accessibleBy": {
            "return": [
              {
                "displayOptions": {
                  "return": {
                    "hide": {
                      "return": "boolean",
                      "arguments": {}
                    },
                    "order": {
                      "return": "number",
                      "arguments": {}
                    }
                  },
                  "arguments": {}
                },
                "organizationUser": {
                  "return": {
                    "accessType": {
                      "return": "string",
                      "arguments": {}
                    },
                    "apiTokens": {
                      "return": [
                        {
                          "id": {
                            "return": "object",
                            "arguments": {}
                          },
                          "jwtToken": {
                            "return": "string",
                            "arguments": {}
                          },
                          "name": {
                            "return": "string",
                            "arguments": {}
                          },
                          "organization": {}
                        }
                      ]
                    }
                  }
                }
              }
            ]
          }
        }
      }
    }
  }
}

UserIdVerificationPaginationAndSorting: object

Input fields options to manage pagination and sorting for userIdVerfication Object

offSet:
Int

The number of records to skip per page from the beginning of the elements per page

perPage:
Int

Elements per page

sortDesc:

To sort in descending order or not

sortField:

To sort the list by the fields for the userIdVerfication object

Example
{
  "offSet": "number",
  "perPage": "number",
  "sortDesc": "boolean",
  "sortField": "string"
}

UserIdVerificationQueryFilter: object

Input type for userId verification filters

methodOfIDVerification:

Method of ID verification

userId:

UserID

verifiedAtAfter:

Date the ID was verified on. It allows filtering dates on the calender after a selected date

verifiedAtBefore:

Date the ID was verified on. It allows filtering dates on the calender before a selected date

Example
{
  "methodOfIDVerification": "string",
  "userId": "object",
  "verifiedAtAfter": "object",
  "verifiedAtBefore": "object"
}

UserIntegration: object

The integration enum and unique integration id

iid:
object

The id for the entity, in the given specific integration

return:
arguments:
object
type:
object

Enumeration for the integration type

return:
arguments:
object
Example
{
  "iid": {
    "return": "string",
    "arguments": {}
  },
  "type": {
    "return": "string",
    "arguments": {}
  }
}

UserIntegrationInput: object

Input type for integrations field

externalId:

externalId external source id

groupId:

group id the custodian connection

iid:

iid is the unique identifier for this entity in the given integration

type:

Integrations type derives from enumeration

Example
{
  "externalId": "object",
  "groupId": "object",
  "iid": "object",
  "type": "string"
}

UserIntegrationTypes: string

Integrations for User

object
APEX
object
CIBC_MELLON
object
CIIS
object
ENVESTNET
object
FC
object
FUNDSERV
object
IBKR
object
NBIN
object
NO_CONNECTION
object
PERSHING
object
RBC
object
SALESFORCE
object
SCHWAB
object
TEMPLATE

UserLogsInput: object

filter:
pagination:
Example
{
  "filter": {
    "after": "object",
    "before": "object",
    "userOnly": "boolean"
  },
  "pagination": {
    "offSet": "number",
    "perPage": "number",
    "sortDesc": "boolean",
    "sortField": "string"
  }
}

UserLogsQueryFilter: object

after:
before:
userOnly:
Example
{
  "after": "object",
  "before": "object",
  "userOnly": "boolean"
}

UserOrganizationUserDisplayOptions: object

hide:
object
return:
arguments:
object
id:
object
return:
arguments:
object
order:
object
return:
Int
arguments:
object
organizationUser:
object
return:
arguments:
object
user:
object
return:
arguments:
object
Example
{
  "hide": {
    "return": "boolean",
    "arguments": {}
  },
  "id": {
    "return": "object",
    "arguments": {}
  },
  "order": {
    "return": "number",
    "arguments": {}
  },
  "organizationUser": {
    "return": {
      "accessType": {
        "return": "string",
        "arguments": {}
      },
      "apiTokens": {
        "return": [
          {
            "id": {
              "return": "object",
              "arguments": {}
            },
            "jwtToken": {
              "return": "string",
              "arguments": {}
            },
            "name": {
              "return": "string",
              "arguments": {}
            },
            "organization": {
              "return": {
                "browserTabTitle": {
                  "return": "string",
                  "arguments": {}
                },
                "faviconLink": {
                  "return": "string",
                  "arguments": {}
                },
                "id": {
                  "return": "object",
                  "arguments": {}
                },
                "name": {
                  "return": "string",
                  "arguments": {}
                },
                "parent": {
                  "return": {
                    "browserTabTitle": {
                      "return": "string",
                      "arguments": {}
                    },
                    "faviconLink": {
                      "return": "string",
                      "arguments": {}
                    },
                    "id": {
                      "return": "object",
                      "arguments": {}
                    },
                    "name": {
                      "return": "string",
                      "arguments": {}
                    },
                    "parent": {
                      "return": {
                        "browserTabTitle": {
                          "return": "string",
                          "arguments": {}
                        },
                        "faviconLink": {
                          "return": "string",
                          "arguments": {}
                        },
                        "id": {
                          "return": "object",
                          "arguments": {}
                        },
                        "name": {
                          "return": "string",
                          "arguments": {}
                        },
                        "parent": {
                          "return": {
                            "browserTabTitle": {
                              "return": "string",
                              "arguments": {}
                            }
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        ]
      }
    }
  }
}

UserPaginationAndSorting: object

Input fields options to manage pagination and sorting for user Object

offSet:
Int

The number of records to skip per page from the beginning of the elements per page

perPage:
Int

Elements per page

sortDesc:

To sort in descending order or not

sortField:

To sort the list by the fields for the user Object

Example
{
  "offSet": "number",
  "perPage": "number",
  "sortDesc": "boolean",
  "sortField": "string"
}

UserQueryFilter: object

Input type for filtering Users

completedAtAfter:

Date the user profile was completed It allows filtering dates on the calender after a selected date

completedAtBefore:

Date the user profile was completed It allows filtering dates on the calender before a selected date

complianceState:
customFields:
CustomFieldInput
dateOfBirthAfter:

Date of birth of the user It allows filtering dates on the calender after a selected date

dateOfBirthBefore:

Date of birth of the user It allows filtering dates on the calender before a selected date

iDCheckCompleted:
iDVerified:
isComplete:

Is the User profile complete?

lastSuitabilityReviewAtAfter:
lastSuitabilityReviewAtBefore:
organizationId:
partnerUserId:

User ID on the Partner system that uses the OneVest embedded web-app

primaryEmail:

Allows to search for email

searchText:

Allows to search for a specific user by their first name, last name or email

sin:

User's Social Insurance Number

suitabilityReviewDaysPastDue:
Int
suitabilityReviewDue:
types:
EntityTypes

allows search users among different entity types

Example
{
  "completedAtAfter": "object",
  "completedAtBefore": "object",
  "complianceState": "string",
  "customFields": [
    {
      "key": "object",
      "value": "object"
    }
  ],
  "dateOfBirthAfter": "object",
  "dateOfBirthBefore": "object",
  "iDCheckCompleted": "boolean",
  "iDVerified": "boolean",
  "isComplete": "boolean",
  "lastSuitabilityReviewAtAfter": "object",
  "lastSuitabilityReviewAtBefore": "object",
  "organizationId": "object",
  "partnerUserId": "object",
  "primaryEmail": "string",
  "searchText": "string",
  "sin": "object",
  "suitabilityReviewDaysPastDue": "number",
  "suitabilityReviewDue": "boolean",
  "types": [
    "string"
  ]
}

UserRequiredToSign: object

id:
object
return:
arguments:
object
signedAt:
object
return:
arguments:
object
user:
object
return:
arguments:
object
Example
{
  "id": {
    "return": "object",
    "arguments": {}
  },
  "signedAt": {
    "return": "object",
    "arguments": {}
  },
  "user": {
    "return": {
      "accessibleBy": {
        "return": [
          {
            "displayOptions": {
              "return": {
                "hide": {
                  "return": "boolean",
                  "arguments": {}
                },
                "order": {
                  "return": "number",
                  "arguments": {}
                }
              },
              "arguments": {}
            },
            "organizationUser": {
              "return": {
                "accessType": {
                  "return": "string",
                  "arguments": {}
                },
                "apiTokens": {
                  "return": [
                    {
                      "id": {
                        "return": "object",
                        "arguments": {}
                      },
                      "jwtToken": {
                        "return": "string",
                        "arguments": {}
                      },
                      "name": {
                        "return": "string",
                        "arguments": {}
                      },
                      "organization": {
                        "return": {
                          "browserTabTitle": {
                            "return": "string",
                            "arguments": {}
                          },
                          "faviconLink": {
                            "return": "string",
                            "arguments": {}
                          },
                          "id": {
                            "return": "object",
                            "arguments": {}
                          },
                          "name": {
                            "return": "string",
                            "arguments": {}
                          },
                          "parent": {
                            "return": {
                              "browserTabTitle": {
                                "return": "string",
                                "arguments": {}
                              },
                              "faviconLink": {
                                "return": "string",
                                "arguments": {}
                              },
                              "id": {
                                "return": "object",
                                "arguments": {}
                              },
                              "name": {
                                "return": "string",
                                "arguments": {}
                              },
                              "parent": {
                                "return": {
                                  "browserTabTitle": {
                                    "return": "string",
                                    "arguments": {}
                                  },
                                  "faviconLink": {
                                    "return": "string",
                                    "arguments": {}
                                  }
                                }
                              }
                            }
                          }
                        }
                      }
                    }
                  ]
                }
              }
            }
          }
        ]
      }
    }
  }
}

UserSearchInput: object

filter:
pagination:
Example
{
  "filter": {
    "affiliateUsersOnly": "boolean",
    "isComplete": "boolean",
    "organizationId": "object",
    "query": "string",
    "types": [
      "string"
    ]
  },
  "pagination": {
    "page": "number",
    "perPage": "number",
    "sortDesc": "boolean",
    "sortField": "string"
  }
}

UserSearchResult: object

totalCount:
object
return:
Int
arguments:
object
users:
object
return:
User
arguments:
object
Example
{
  "totalCount": {
    "return": "number",
    "arguments": {}
  },
  "users": {
    "return": [
      {
        "accessibleBy": {
          "return": [
            {
              "displayOptions": {
                "return": {
                  "hide": {
                    "return": "boolean",
                    "arguments": {}
                  },
                  "order": {
                    "return": "number",
                    "arguments": {}
                  }
                },
                "arguments": {}
              },
              "organizationUser": {
                "return": {
                  "accessType": {
                    "return": "string",
                    "arguments": {}
                  },
                  "apiTokens": {
                    "return": [
                      {
                        "id": {
                          "return": "object",
                          "arguments": {}
                        },
                        "jwtToken": {
                          "return": "string",
                          "arguments": {}
                        },
                        "name": {
                          "return": "string",
                          "arguments": {}
                        },
                        "organization": {
                          "return": {
                            "browserTabTitle": {
                              "return": "string",
                              "arguments": {}
                            },
                            "faviconLink": {
                              "return": "string",
                              "arguments": {}
                            },
                            "id": {
                              "return": "object",
                              "arguments": {}
                            },
                            "name": {
                              "return": "string",
                              "arguments": {}
                            },
                            "parent": {
                              "return": {
                                "browserTabTitle": {
                                  "return": "string",
                                  "arguments": {}
                                },
                                "faviconLink": {
                                  "return": "string",
                                  "arguments": {}
                                },
                                "id": {
                                  "return": "object",
                                  "arguments": {}
                                },
                                "name": {
                                  "return": "string",
                                  "arguments": {}
                                },
                                "parent": {
                                  "return": {
                                    "browserTabTitle": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "faviconLink": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "id": {
                                      "return": "object"
                                    }
                                  }
                                }
                              }
                            }
                          }
                        }
                      }
                    ]
                  }
                }
              }
            }
          ]
        }
      }
    ]
  }
}

UserSourceOfFunds: string

object
CONTRIBUTIONS
object
DEBT
object
DONATIONS
object
EMPLOYMENT_INCOME
object
INCOME_OR_WORKING_CAPITAL
object
INHERITANCES_AND_GIFT
object
LOTTERY_WINNING
object
OTHER
object
PENSION_RELEASE
object
PERSONAL_SAVINGS
object
PROCEEDS_FROM_INVESTMENTS
object
PROPERTY_SALE
object
SALE_OF_LARGE_ASSET
object
SHARES_SALES_AND_DIVIDENDS

UserSourceOfWealth: string

object
BUSINESS_OWNERSHIP_INTEREST
object
DEBT
object
EMPLOYMENT_INCOME
object
FAMILY_ESTATE
object
INHERITANCE
object
INVESTMENT
object
LOTTERY_WINNING
object
OTHER
object
PROPERTY_SALE
object
SALE_OF_LARGE_ASSET

UserState: string

User profile state, it indicates if user has it's required fields completed

object
ACTIVE
object
FROZEN
object
INACTIVE

UserStats: object

availableFundsToWithdrawCents:
object
return:
arguments:
object
cashOnHoldToTradeCents:
object
return:
arguments:
object
cashOnHoldToWithdrawCents:
object
return:
arguments:
object
holdings:
object
return:
DailySnapshotHolding
arguments:
object
marketValueCents:
object
return:
arguments:
object
moneyAvailableCents:
object
return:
arguments:
object
moneyWeightedReturn:
object
return:
arguments:
object
endDate:
startDate:
netContributionCents:
object
return:
arguments:
object
newContributionCents:
object
return:
arguments:
object
pendingContributionCents:
object
return:
arguments:
object
simpleReturnAmount:
object
return:
arguments:
object
endDate:
startDate:
simpleReturnPercent:
object
return:
arguments:
object
endDate:
startDate:
timeWeightedReturn:
object
return:
arguments:
object
endDate:
startDate:
user:
object
return:
arguments:
object
Example
{
  "availableFundsToWithdrawCents": {
    "return": "object",
    "arguments": {}
  },
  "cashOnHoldToTradeCents": {
    "return": "object",
    "arguments": {}
  },
  "cashOnHoldToWithdrawCents": {
    "return": "object",
    "arguments": {}
  },
  "holdings": {
    "return": [
      {
        "currentPriceCents": {
          "return": "number",
          "arguments": {}
        },
        "financialProduct": {
          "return": {
            "assignable": {
              "return": "boolean",
              "arguments": {}
            },
            "autoUpdatePrices": {
              "return": "boolean",
              "arguments": {}
            },
            "children": {
              "return": [
                {
                  "financialProduct": {
                    "return": {
                      "assignable": {
                        "return": "boolean",
                        "arguments": {}
                      },
                      "autoUpdatePrices": {
                        "return": "boolean",
                        "arguments": {}
                      },
                      "children": {
                        "return": [
                          {
                            "financialProduct": {
                              "return": {
                                "assignable": {
                                  "return": "boolean",
                                  "arguments": {}
                                },
                                "autoUpdatePrices": {
                                  "return": "boolean",
                                  "arguments": {}
                                },
                                "children": {
                                  "return": [
                                    {
                                      "financialProduct": {
                                        "return": {
                                          "assignable": {
                                            "return": "boolean",
                                            "arguments": {}
                                          },
                                          "autoUpdatePrices": {
                                            "return": "boolean",
                                            "arguments": {}
                                          },
                                          "children": {
                                            "return": [
                                              {
                                                "financialProduct": {
                                                  "return": {
                                                    "assignable": {
                                                      "return": "boolean",
                                                      "arguments": {}
                                                    },
                                                    "autoUpdatePrices": {
                                                      "return": "boolean",
                                                      "arguments": {}
                                                    },
                                                    "children": {
                                                      "return": [
                                                        {
                                                          "financialProduct": {
                                                            "return": {
                                                              "assignable": {}
                                                            }
                                                          }
                                                        }
                                                      ]
                                                    }
                                                  }
                                                }
                                              }
                                            ]
                                          }
                                        }
                                      }
                                    }
                                  ]
                                }
                              }
                            }
                          }
                        ]
                      }
                    }
                  }
                }
              ]
            }
          }
        }
      }
    ]
  }
}

UserTransition: string

Transition states for user's profile

object
activate
object
deactivate
object
freeze

UserUpdate: object

d:
object
return:
arguments:
object
id:
object
return:
arguments:
object
o:
object
return:
arguments:
object
t:
object
return:
arguments:
object
Example
{
  "d": {
    "return": "string",
    "arguments": {}
  },
  "id": {
    "return": "object",
    "arguments": {}
  },
  "o": {
    "return": "string",
    "arguments": {}
  },
  "t": {
    "return": "object",
    "arguments": {}
  }
}

UserUpdatePaginationAndSorting: object

offSet:
Int
perPage:
Int
sortDesc:
Example
{
  "offSet": "number",
  "perPage": "number",
  "sortDesc": "boolean"
}

UsersDaily: object

date:
object
return:
arguments:
object
holdings:
object
return:
Holding
arguments:
object
id:
object
return:
arguments:
object
marketValueCents:
object
return:
arguments:
object
moneyAvailableCents:
object
return:
arguments:
object
netContributionCents:
object
return:
arguments:
object
newContributionCents:
object
return:
arguments:
object
user:
object
return:
arguments:
object
Example
{
  "date": {
    "return": "object",
    "arguments": {}
  },
  "holdings": {
    "return": [
      {
        "currentPriceCents": {
          "return": "number",
          "arguments": {}
        },
        "financialProduct": {
          "return": {
            "assignable": {
              "return": "boolean",
              "arguments": {}
            },
            "autoUpdatePrices": {
              "return": "boolean",
              "arguments": {}
            },
            "children": {
              "return": [
                {
                  "financialProduct": {
                    "return": {
                      "assignable": {
                        "return": "boolean",
                        "arguments": {}
                      },
                      "autoUpdatePrices": {
                        "return": "boolean",
                        "arguments": {}
                      },
                      "children": {
                        "return": [
                          {
                            "financialProduct": {
                              "return": {
                                "assignable": {
                                  "return": "boolean",
                                  "arguments": {}
                                },
                                "autoUpdatePrices": {
                                  "return": "boolean",
                                  "arguments": {}
                                },
                                "children": {
                                  "return": [
                                    {
                                      "financialProduct": {
                                        "return": {
                                          "assignable": {
                                            "return": "boolean",
                                            "arguments": {}
                                          },
                                          "autoUpdatePrices": {
                                            "return": "boolean",
                                            "arguments": {}
                                          },
                                          "children": {
                                            "return": [
                                              {
                                                "financialProduct": {
                                                  "return": {
                                                    "assignable": {
                                                      "return": "boolean",
                                                      "arguments": {}
                                                    },
                                                    "autoUpdatePrices": {
                                                      "return": "boolean",
                                                      "arguments": {}
                                                    },
                                                    "children": {
                                                      "return": [
                                                        {
                                                          "financialProduct": {
                                                            "return": {
                                                              "assignable": {
                                                                "return": "boolean",
                                                                "arguments": {}
                                                              },
                                                              "autoUpdatePrices": {
                                                                "return": "boolean",
                                                                "arguments": {}
                                                              },
                                                              "children": {}
                                                            }
                                                          }
                                                        }
                                                      ]
                                                    }
                                                  }
                                                }
                                              }
                                            ]
                                          }
                                        }
                                      }
                                    }
                                  ]
                                }
                              }
                            }
                          }
                        ]
                      }
                    }
                  }
                }
              ]
            }
          }
        }
      }
    ]
  }
}

VerifySubTradeRequestsInput: object

organizationId:
subTradeRequestIds:
ObjectID
Example
{
  "organizationId": "object",
  "subTradeRequestIds": [
    "object"
  ]
}

Webhook: object

customHeaders:
object

Any custom headers that may need to be set to be sent with the mutation to the assigned url.

return:
arguments:
object
customPayloadAttributes:
object

Any custom payload that may need to be sent on the body along with the fetched data (REST type only). If informed, the fetched data will be sent as an object in the 'payload' attribute.

return:
arguments:
object
eventType:
object

The event type on the object that gets actioned to then send off the webhook.

return:
arguments:
object
gql:
object

The graphql query string that would be used to query the OneVest partner gateway usually. The variable of '$id' is used for the actioned object.

return:
arguments:
object
id:
object
return:
arguments:
object
mutationInputName:
object

The name of the input that the webhook will pass, it will always pass as variable 'input' (GRAPHQL type only).

return:
arguments:
object
mutationName:
object

The name of the mutation that the webhook will hit (GRAPHQL type only).

return:
arguments:
object
objectType:
object

The type of object you want to listen to, to receive a webhook on.

return:
arguments:
object
organization:
object
return:
arguments:
object
signedJwtHeader:
object

Any custom header through which the signed JWT may need to be sent (REST type only). If not informed, the signed JWT will be sent in the 'OneVest-Authorization' header.

return:
arguments:
object
type:
object

Webhook type (GRAPHQL or REST)

return:
arguments:
object
url:
object

GraphQL URL in which the webhook will hit.

return:
arguments:
object
Example
{
  "customHeaders": {
    "return": "object",
    "arguments": {}
  },
  "customPayloadAttributes": {
    "return": "object",
    "arguments": {}
  },
  "eventType": {
    "return": "string",
    "arguments": {}
  },
  "gql": {
    "return": "string",
    "arguments": {}
  },
  "id": {
    "return": "object",
    "arguments": {}
  },
  "mutationInputName": {
    "return": "string",
    "arguments": {}
  },
  "mutationName": {
    "return": "string",
    "arguments": {}
  },
  "objectType": {
    "return": "string",
    "arguments": {}
  },
  "organization": {
    "return": {
      "accountTypeTaxRanks": {
        "return": [
          {
            "accountType": {
              "return": "string",
              "arguments": {}
            },
            "id": {
              "return": "object",
              "arguments": {}
            },
            "taxRank": {
              "return": "number",
              "arguments": {}
            }
          }
        ],
        "arguments": {}
      },
      "allowAccessToSubOrganizations": {
        "return": "boolean",
        "arguments": {}
      },
      "allowDirectCommunication": {
        "return": "boolean",
        "arguments": {}
      },
      "allowInactiveUserAdjustments": {
        "return": "boolean",
        "arguments": {}
      },
      "allowInactiveUserFeeCalculation": {
        "return": "boolean",
        "arguments": {}
      },
      "allowInactiveUserRebalancing": {
        "return": "boolean",
        "arguments": {}
      },
      "allowInstantInvest": {
        "return": "boolean",
        "arguments": {}
      },
      "allowPortfolioPerGoal": {
        "return": "boolean",
        "arguments": {}
      },
      "allowPostOptimizationEditing": {
        "return": "boolean",
        "arguments": {}
      },
      "allowViewSubTradeRequestPairs": {
        "return": "boolean",
        "arguments": {}
      },
      "applicableJurisdictions": {
        "return": {
          "all": {
            "return": "boolean",
            "arguments": {}
          },
          "only": {
            "return": [
              "string"
            ]
          }
        }
      }
    }
  }
}

WebhookQueryFilter: object

createdAtAfter:
createdAtBefore:
eventType:
objectType:
organizationId:
type:
Example
{
  "createdAtAfter": "object",
  "createdAtBefore": "object",
  "eventType": "string",
  "objectType": "string",
  "organizationId": "object",
  "type": "string"
}

WebhookTypes: string

Defines whether the data will sent as a Graphql request to a given mutationName or as REST POST request.

object
GRAPHQL
object
REST

Widget: object

columns:
object
return:
String
arguments:
object
filters:
object
return:
WidgetFilter
arguments:
object
format:
object
return:
arguments:
object
grouping:
object
return:
arguments:
object
height:
object
return:
Int
arguments:
object
reportType:
object
return:
arguments:
object
sortDesc:
object
return:
arguments:
object
sortField:
object
return:
arguments:
object
title:
object
return:
arguments:
object
type:
object
return:
arguments:
object
width:
object
return:
Int
arguments:
object
x:
object
return:
Int
arguments:
object
y:
object
return:
Int
arguments:
object
Example
{
  "columns": {
    "return": [
      "string"
    ],
    "arguments": {}
  },
  "filters": {
    "return": [
      {
        "comparison": {
          "return": "string",
          "arguments": {}
        },
        "field": {
          "return": "string",
          "arguments": {}
        },
        "value": {
          "return": "string",
          "arguments": {}
        }
      }
    ],
    "arguments": {}
  },
  "format": {
    "return": "string",
    "arguments": {}
  },
  "grouping": {
    "return": {
      "field": {
        "return": "string",
        "arguments": {}
      },
      "interval": {
        "return": "string",
        "arguments": {}
      },
      "type": {
        "return": "string",
        "arguments": {}
      },
      "valueAggregation": {
        "return": "string",
        "arguments": {}
      },
      "valueField": {
        "return": "string",
        "arguments": {}
      }
    },
    "arguments": {}
  },
  "height": {
    "return": "number",
    "arguments": {}
  },
  "reportType": {
    "return": "string",
    "arguments": {}
  },
  "sortDesc": {
    "return": "boolean",
    "arguments": {}
  },
  "sortField": {
    "return": "string",
    "arguments": {}
  },
  "title": {
    "return": "string",
    "arguments": {}
  },
  "type": {
    "return": "string",
    "arguments": {}
  },
  "width": {
    "return": "number",
    "arguments": {}
  },
  "x": {
    "return": "number",
    "arguments": {}
  },
  "y": {
    "return": "number",
    "arguments": {}
  }
}

WidgetChartTypes: string

object
BAR
object
LINE
object
NUMBER
object
PIE

WidgetConfiguration: object

id:
object
return:
arguments:
object
options:
object
return:
arguments:
object
type:
object
return:
arguments:
object
Example
{
  "id": {
    "return": "object",
    "arguments": {}
  },
  "options": {
    "return": "object",
    "arguments": {}
  },
  "type": {
    "return": "string",
    "arguments": {}
  }
}

WidgetConfigurationInput: object

options:
type:
Example
{
  "options": "object",
  "type": "string"
}

WidgetConfigurationTypes: string

object
ACCESS
object
ACCOUNTS
object
ADVISOR_CONTACT_INFORMATION
object
AUDIT_LOG
object
CLIENT_NAME
object
COMPLIANCE
object
CONTACTS
object
DOCUMENTS
object
EDIT_ACCOUNT
object
EMPLOYMENT_INFORMATION
object
EXPOSURE
object
FEE_DETAILS
object
GOALS
object
GOALS_AND_ACCOUNTS
object
GOAL_SUITABILITY
object
HOLDINGS
object
HOUSE_HOLD_MEMBERS
object
ID_VERIFICATION
object
INCOME_ASSETS_AND_DEBTS
object
INITIATE_TRANSFER
object
LEDGER
object
MARKET_VALUE_CHART
object
NEWS_AND_INSIGHTS
object
NON_INDIVIDUAL_INFORMATION
object
NOTES
object
PERSONAL_INFORMATION
object
PERSONS_OF_INTEREST
object
PORTFOLIO
object
PROJECTED_INCOME_REPORT
object
RECENT_TRANSACTIONS
object
REFINITIV
object
RELATIONSHIPS
object
RELATIONSHIP_INFORMATION
object
RESIDENCY_INFORMATION
object
REVIEW_BANK_ACCOUNT_INFORMATION
object
SCHEDULED_TRANSFERS
object
SUB_ACCOUNTS
object
SUITABILITY
object
TRADE_ORDERS
object
TRANSFERS
object
UPCOMING_TRANSACTIONS

WidgetFilter: object

comparison:
object
return:
arguments:
object
field:
object
return:
arguments:
object
value:
object
return:
arguments:
object
Example
{
  "comparison": {
    "return": "string",
    "arguments": {}
  },
  "field": {
    "return": "string",
    "arguments": {}
  },
  "value": {
    "return": "string",
    "arguments": {}
  }
}

WidgetFormatTypes: string

object
CENTS
object
FLOAT

WidgetGrouping: object

field:
object
return:
arguments:
object
interval:
object
return:
arguments:
object
type:
object
return:
arguments:
object
valueAggregation:
object
return:
arguments:
object
valueField:
object
return:
arguments:
object
Example
{
  "field": {
    "return": "string",
    "arguments": {}
  },
  "interval": {
    "return": "string",
    "arguments": {}
  },
  "type": {
    "return": "string",
    "arguments": {}
  },
  "valueAggregation": {
    "return": "string",
    "arguments": {}
  },
  "valueField": {
    "return": "string",
    "arguments": {}
  }
}

WidgetGroupingType: string

object
DATE
object
FIRST_DATE_IN_INTERVAL
object
GROUPING
object
SINGLE_VALUE

WidgetInputFilter: object

comparison:
field:
value:
Example
{
  "comparison": "string",
  "field": "string",
  "value": "string"
}

WidgetInputGrouping: object

field:
interval:
type:
valueAggregation:
valueField:
Example
{
  "field": "string",
  "interval": "string",
  "type": "string",
  "valueAggregation": "string",
  "valueField": "string"
}

WidgetInputType: object

columns:
String
filters:
WidgetInputFilter
format:
grouping:
height:
Int
reportType:
sortDesc:
sortField:
title:
type:
width:
Int
x:
Int
y:
Int
Example
{
  "columns": [
    "string"
  ],
  "filters": [
    {
      "comparison": "string",
      "field": "string",
      "value": "string"
    }
  ],
  "format": "string",
  "grouping": {
    "field": "string",
    "interval": "string",
    "type": "string",
    "valueAggregation": "string",
    "valueField": "string"
  },
  "height": "number",
  "reportType": "string",
  "sortDesc": "boolean",
  "sortField": "string",
  "title": "string",
  "type": "string",
  "width": "number",
  "x": "number",
  "y": "number"
}

WidgetInterval: string

object
DAY
object
MONTH
object
WEEK
object
YEAR

WidgetOption: object

customFieldFilter:
object
return:
arguments:
object
default:
object
return:
arguments:
object
info:
object
return:
arguments:
object
key:
object
return:
arguments:
object
label:
object
return:
arguments:
object
optionType:
object
return:
arguments:
object
options:
object
return:
arguments:
object
removeFromPages:
object
return:
PageConfigurationTypes
arguments:
object
requiredIf:
object
return:
arguments:
object
showBasedOnCustodianConnection:
object
return:
Object
arguments:
object
showCustomField:
object
return:
arguments:
object
showIf:
object
return:
arguments:
object
showWith:
object
return:
arguments:
object
Example
{
  "customFieldFilter": {
    "return": "object",
    "arguments": {}
  },
  "default": {
    "return": "object",
    "arguments": {}
  },
  "info": {
    "return": {
      "en": {
        "return": "string",
        "arguments": {}
      },
      "fr": {
        "return": "string",
        "arguments": {}
      }
    },
    "arguments": {}
  },
  "key": {
    "return": "string",
    "arguments": {}
  },
  "label": {
    "return": {
      "en": {
        "return": "string",
        "arguments": {}
      },
      "fr": {
        "return": "string",
        "arguments": {}
      }
    },
    "arguments": {}
  },
  "optionType": {
    "return": "string",
    "arguments": {}
  },
  "options": {
    "return": "object",
    "arguments": {}
  },
  "removeFromPages": {
    "return": [
      "string"
    ],
    "arguments": {}
  },
  "requiredIf": {
    "return": "object",
    "arguments": {}
  },
  "showBasedOnCustodianConnection": {
    "return": [
      "object"
    ],
    "arguments": {}
  },
  "showCustomField": {
    "return": "boolean",
    "arguments": {}
  },
  "showIf": {
    "return": "object",
    "arguments": {}
  },
  "showWith": {
    "return": "string",
    "arguments": {}
  }
}

WidgetOptionTypes: string

object
ARRAY
object
ATTACHMENT
object
BASIC_FIELD
object
BOOLEAN
object
HTML_TEMPLATE
object
OPTIONAL_TRANSLATED_STRING
object
PLAIN_TEXT_FIELD
object
SELECT_FIELD
object
TABLE
object
TRANSLATED_STRING
object
WORKFLOW_SELECT_FIELD

WidgetReportTypes: string

object
ACCOUNT
object
CLIENT_GROUP
object
DAILY_STATS
object
GOAL
object
SUB_ACCOUNT
object
TRADE
object
TRANSACTION
object
TRANSFER
object
USER

WidgetValueAggregation: string

object
AVG
object
SUM
object
VALUE_COUNT

WithdrawAllAccountInput: object

accountId:
bankAccountId:
requestId:
Example
{
  "accountId": "object",
  "bankAccountId": "object",
  "requestId": "object"
}

WithdrawAllAccountResponse: object

transfers:
object
return:
Transfer
arguments:
object
Example
{
  "transfers": {
    "return": [
      {
        "alertReport": {
          "return": {
            "id": {
              "return": "object",
              "arguments": {}
            },
            "reason": {
              "return": "string",
              "arguments": {}
            },
            "rules": {
              "return": [
                {
                  "id": {
                    "return": "object",
                    "arguments": {}
                  },
                  "translatedDescription": {
                    "return": {
                      "en": {
                        "return": "string",
                        "arguments": {}
                      },
                      "fr": {
                        "return": "string",
                        "arguments": {}
                      }
                    },
                    "arguments": {}
                  },
                  "type": {
                    "return": "string",
                    "arguments": {}
                  }
                }
              ],
              "arguments": {}
            },
            "state": {
              "return": "string",
              "arguments": {}
            },
            "transfer": {
              "return": {
                "alertReport": {
                  "return": {
                    "id": {
                      "return": "object",
                      "arguments": {}
                    },
                    "reason": {
                      "return": "string",
                      "arguments": {}
                    },
                    "rules": {
                      "return": [
                        {
                          "id": {
                            "return": "object",
                            "arguments": {}
                          },
                          "translatedDescription": {
                            "return": {
                              "en": {
                                "return": "string",
                                "arguments": {}
                              },
                              "fr": {
                                "return": "string",
                                "arguments": {}
                              }
                            },
                            "arguments": {}
                          },
                          "type": {
                            "return": "string",
                            "arguments": {}
                          }
                        }
                      ],
                      "arguments": {}
                    },
                    "state": {
                      "return": "string",
                      "arguments": {}
                    },
                    "transfer": {
                      "return": {
                        "alertReport": {
                          "return": {
                            "id": {
                              "return": "object",
                              "arguments": {}
                            },
                            "reason": {}
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    ]
  }
}

WithdrawAllSubAccountInput: object

bankAccountId:
requestId:
subAccountId:
Example
{
  "bankAccountId": "object",
  "requestId": "object",
  "subAccountId": "object"
}

WithdrawAllSubAccountResponse: object

transfer:
object
return:
arguments:
object
Example
{
  "transfer": {
    "return": {
      "alertReport": {
        "return": {
          "id": {
            "return": "object",
            "arguments": {}
          },
          "reason": {
            "return": "string",
            "arguments": {}
          },
          "rules": {
            "return": [
              {
                "id": {
                  "return": "object",
                  "arguments": {}
                },
                "translatedDescription": {
                  "return": {
                    "en": {
                      "return": "string",
                      "arguments": {}
                    },
                    "fr": {
                      "return": "string",
                      "arguments": {}
                    }
                  },
                  "arguments": {}
                },
                "type": {
                  "return": "string",
                  "arguments": {}
                }
              }
            ],
            "arguments": {}
          },
          "state": {
            "return": "string",
            "arguments": {}
          },
          "transfer": {
            "return": {
              "alertReport": {
                "return": {
                  "id": {
                    "return": "object",
                    "arguments": {}
                  },
                  "reason": {
                    "return": "string",
                    "arguments": {}
                  },
                  "rules": {
                    "return": [
                      {
                        "id": {
                          "return": "object",
                          "arguments": {}
                        },
                        "translatedDescription": {
                          "return": {
                            "en": {
                              "return": "string",
                              "arguments": {}
                            },
                            "fr": {
                              "return": "string",
                              "arguments": {}
                            }
                          },
                          "arguments": {}
                        },
                        "type": {
                          "return": "string",
                          "arguments": {}
                        }
                      }
                    ],
                    "arguments": {}
                  },
                  "state": {
                    "return": "string",
                    "arguments": {}
                  },
                  "transfer": {
                    "return": {
                      "alertReport": {
                        "return": {
                          "id": {
                            "return": "object",
                            "arguments": {}
                          },
                          "reason": {
                            "return": "string"
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

WithdrawFee: object

amountCents:
object
return:
Int
arguments:
object
type:
object
return:
arguments:
object
Example
{
  "amountCents": {
    "return": "number",
    "arguments": {}
  },
  "type": {
    "return": "string",
    "arguments": {}
  }
}

WithdrawFeeTypes: string

object
DEREGISTRATION
object
DEREGISTRATION_TAX
object
WITHHOLDING_TAX

WithdrawalMode: string

object
GROSS
object
NET

WithdrawalReason: string

Withdrawal reasons.

object
CAR
object
COMPLETED_MY_GOAL
object
DISSATISFIED_WITH_ONEVEST
object
EDUCATION
object
EMERGENCY
object
HOME_BUYERS_PLAN
object
HOUSE
object
INVESTING_IS_NOT_FOR_ME
object
LIFELONG_LEARNING_PLAN
object
MAJOR_PURCHASE
object
OTHER
object
PARENTAL_LEAVE
object
POOR_RETURNS
object
RETIREMENT_INCOME
object
START_A_BUSINESS
object
VACATION
object
WEDDING

Workflow: object

createdAt:
object
return:
arguments:
object
eventType:
object
return:
arguments:
object
id:
object
return:
arguments:
object
name:
object
return:
arguments:
object
objectType:
object
return:
arguments:
object
organization:
object
return:
arguments:
object
state:
object
return:
arguments:
object
steps:
object
return:
Step
arguments:
object
triggerRules:
object
return:
TriggerRule
arguments:
object
triggerType:
object
return:
arguments:
object
updatedAt:
object
return:
arguments:
object
version:
object
return:
Int
arguments:
object
Example
{
  "createdAt": {
    "return": "object",
    "arguments": {}
  },
  "eventType": {
    "return": "string",
    "arguments": {}
  },
  "id": {
    "return": "object",
    "arguments": {}
  },
  "name": {
    "return": {
      "en": {
        "return": "string",
        "arguments": {}
      },
      "fr": {
        "return": "string",
        "arguments": {}
      }
    },
    "arguments": {}
  },
  "objectType": {
    "return": "string",
    "arguments": {}
  },
  "organization": {
    "return": {
      "accountTypeTaxRanks": {
        "return": [
          {
            "accountType": {
              "return": "string",
              "arguments": {}
            },
            "id": {
              "return": "object",
              "arguments": {}
            },
            "taxRank": {
              "return": "number",
              "arguments": {}
            }
          }
        ],
        "arguments": {}
      },
      "allowAccessToSubOrganizations": {
        "return": "boolean",
        "arguments": {}
      },
      "allowDirectCommunication": {
        "return": "boolean",
        "arguments": {}
      },
      "allowInactiveUserAdjustments": {
        "return": "boolean",
        "arguments": {}
      },
      "allowInactiveUserFeeCalculation": {
        "return": "boolean",
        "arguments": {}
      },
      "allowInactiveUserRebalancing": {
        "return": "boolean",
        "arguments": {}
      },
      "allowInstantInvest": {
        "return": "boolean",
        "arguments": {}
      },
      "allowPortfolioPerGoal": {
        "return": "boolean",
        "arguments": {}
      },
      "allowPostOptimizationEditing": {
        "return": "boolean",
        "arguments": {}
      },
      "allowViewSubTradeRequestPairs": {
        "return": "boolean",
        "arguments": {}
      },
      "applicableJurisdictions": {
        "return": {
          "all": {
            "return": "boolean",
            "arguments": {}
          },
          "only": {
            "return": [
              "string"
            ],
            "arguments": {}
          }
        },
        "arguments": {}
      },
      "applicableLocalization": {}
    }
  }
}

WorkflowCompletion: object

context:
object
return:
arguments:
object
createdAt:
object
return:
arguments:
object
currentStep:
object
return:
arguments:
object
currentStepId:
object
return:
arguments:
object
currentSubStep:
object
return:
arguments:
object
currentSubStepId:
object
return:
arguments:
object
id:
object
return:
arguments:
object
object:
object
return:
arguments:
object
objectId:
object
return:
arguments:
object
objectType:
object
return:
arguments:
object
organization:
object
return:
arguments:
object
parentWorkflowCompletionId:
object
return:
arguments:
object
state:
object
return:
arguments:
object
updatedAt:
object
return:
arguments:
object
workflow:
object
return:
arguments:
object
Example
{
  "context": {
    "return": "object",
    "arguments": {}
  },
  "createdAt": {
    "return": "object",
    "arguments": {}
  },
  "currentStep": {
    "return": {
      "id": {
        "return": "object",
        "arguments": {}
      },
      "name": {
        "return": {
          "en": {
            "return": "string",
            "arguments": {}
          },
          "fr": {
            "return": "string",
            "arguments": {}
          }
        },
        "arguments": {}
      },
      "subSteps": {
        "return": [
          {
            "canGoBack": {
              "return": "boolean",
              "arguments": {}
            },
            "completeableBy": {
              "return": [
                "string"
              ],
              "arguments": {}
            },
            "id": {
              "return": "object",
              "arguments": {}
            },
            "options": {
              "return": "object",
              "arguments": {}
            },
            "rolesCompleteableBy": {
              "return": [
                {
                  "accessiblePages": {
                    "return": [
                      "string"
                    ],
                    "arguments": {}
                  },
                  "accountPageConfiguration": {
                    "return": {
                      "createdAt": {
                        "return": "object",
                        "arguments": {}
                      },
                      "id": {
                        "return": "object",
                        "arguments": {}
                      },
                      "name": {
                        "return": "string",
                        "arguments": {}
                      },
                      "options": {
                        "return": "object",
                        "arguments": {}
                      },
                      "organization": {
                        "return": {
                          "accountTypeTaxRanks": {
                            "return": [
                              {
                                "accountType": {
                                  "return": "string",
                                  "arguments": {}
                                },
                                "id": {
                                  "return": "object",
                                  "arguments": {}
                                },
                                "taxRank": {
                                  "return": "number",
                                  "arguments": {}
                                }
                              }
                            ],
                            "arguments": {}
                          },
                          "allowAccessToSubOrganizations": {
                            "return": "boolean"
                          }
                        }
                      }
                    }
                  }
                }
              ]
            }
          }
        ]
      }
    }
  }
}

WorkflowCompletionPaginationAndSorting: object

offSet:
Int
perPage:
Int
sortDesc:
sortField:
Example
{
  "offSet": "number",
  "perPage": "number",
  "sortDesc": "boolean",
  "sortField": "string"
}

WorkflowCompletionQueryFilter: object

objectType:
organizationId:
state:
Example
{
  "objectType": "string",
  "organizationId": "object",
  "state": "string"
}

WorkflowCompletionStates: string

object
ACTIVE
object
CANCELED
object
COMPLETED

WorkflowCompletionTransition: string

object
cancel
object
complete

WorkflowObjectTypes: string

object
ACCOUNT
object
GOAL
object
HOUSEHOLD
object
USER

WorkflowPaginationAndSorting: object

offSet:
Int
perPage:
Int
sortDesc:
sortField:
Example
{
  "offSet": "number",
  "perPage": "number",
  "sortDesc": "boolean",
  "sortField": "string"
}

WorkflowQueryFilter: object

objectType:
organizationId:
state:
states:
WorkflowStates
Example
{
  "objectType": "string",
  "organizationId": "object",
  "state": "string",
  "states": [
    "string"
  ]
}

WorkflowStates: string

object
ACTIVE
object
ARCHIVED
object
DRAFT

WorkflowTransition: string

object
activate
object
archive
object
draft
Documentation by DociQL