Vertalo GraphQL API
Documentation for the Vertalo GraphQL API
API Endpoints
https://sandbox.vertalo.com/token/api/v2/graphqlQueries
account
Description
Reads a single Account using its globally unique ID.
Response
Returns an Account
Arguments
| Name | Description |
|---|---|
nodeId - ID!
|
The globally unique ID to be used in selecting a single Account. |
Example
Query
query account($nodeId: ID!) {
account(nodeId: $nodeId) {
nodeId
type
company
name
jurisdiction
email
url
slug
twitterHandle
supportEmail
newId
setup
entity
oldId
id
createdOn
investorType
formationDate
externalEmail
useReal
auxAccountByType {
...AuxAccountFragment
}
companyByCompany {
...CompanyFragment
}
countryByJurisdiction {
...CountryFragment
}
investorAccountTypeByInvestorType {
...InvestorAccountTypeFragment
}
customersByVendorId {
...CustomersConnectionFragment
}
customersByInvestorId {
...CustomersConnectionFragment
}
usersAccountsByAccountId {
...UsersAccountsConnectionFragment
}
accountsBlockchainAddressesByAccountId {
...AccountsBlockchainAddressesConnectionFragment
}
blockchainRegistrationsByAccountId {
...BlockchainRegistrationsConnectionFragment
}
assetsByIssuerId {
...AssetsConnectionFragment
}
assetArchivesByAccountId {
...AssetArchivesConnectionFragment
}
allocationsByOwnerId {
...AllocationsConnectionFragment
}
allocationsByIssuerId {
...AllocationsConnectionFragment
}
allocationArchivesByAccountId {
...AllocationArchivesConnectionFragment
}
brokerAllocationsByBrokerId {
...BrokerAllocationsConnectionFragment
}
distributionsByInvestorId {
...DistributionsConnectionFragment
}
transactionsByBrokerId {
...TransactionsConnectionFragment
}
ledgersByInvestorId {
...LedgersConnectionFragment
}
distributionAnnotationsByAccountId {
...DistributionAnnotationsConnectionFragment
}
assetAnnotationsByAccountId {
...AssetAnnotationsConnectionFragment
}
allocationAnnotationsByAccountId {
...AllocationAnnotationsConnectionFragment
}
transactionAnnotationsByAccountId {
...TransactionAnnotationsConnectionFragment
}
managedAccountsByManagerId {
...ManagedAccountsConnectionFragment
}
managedAccountsByEntityId {
...ManagedAccountsConnectionFragment
}
accountIntegrationsByAccountId {
...AccountIntegrationsConnectionFragment
}
vendorQualificationsByAccountId {
...VendorQualificationsConnectionFragment
}
stepsByOwnedBy {
...StepsConnectionFragment
}
stepsByExecuteBy {
...StepsConnectionFragment
}
distributionCustomFieldsByCreatedBy {
...DistributionCustomFieldsConnectionFragment
}
signingAccountsByAccountId {
...SigningAccountsConnectionFragment
}
signingTemplatesByAccountId {
...SigningTemplatesConnectionFragment
}
mappedSigningTemplatesByAccountId {
...MappedSigningTemplatesConnectionFragment
}
sentSigningDocumentsBySentTo {
...SentSigningDocumentsConnectionFragment
}
allocationOfferingLinksByCreatedBy {
...AllocationOfferingLinksConnectionFragment
}
allocationOfferingLinksByAgentId {
...AllocationOfferingLinksConnectionFragment
}
accountPhoneNumbersByAccountId {
...AccountPhoneNumbersConnectionFragment
}
accountRegDStatusByAccountId {
...AccountRegDStatusFragment
}
accountRegDStatusesByAccountId {
...AccountRegDStatusesConnectionFragment
}
accountTaxInformationsByAccountId {
...AccountTaxInformationsConnectionFragment
}
onboardingQuestionSetsByAccountId {
...OnboardingQuestionSetsConnectionFragment
}
onboardingQuestionsByAccountId {
...OnboardingQuestionsConnectionFragment
}
instancedAccountInformationsByAccountId {
...InstancedAccountInformationsConnectionFragment
}
instancedAccountInformationsByVendorAccountId {
...InstancedAccountInformationsConnectionFragment
}
instancedMappingFieldsByAccountId {
...InstancedMappingFieldsConnectionFragment
}
vendorDefaultEmailPreferenceByAccountId {
...VendorDefaultEmailPreferenceFragment
}
vendorDefaultEmailPreferencesByAccountId {
...VendorDefaultEmailPreferencesConnectionFragment
}
allocationEmailPreferencesByAccountId {
...AllocationEmailPreferencesConnectionFragment
}
securitiesByIssuerId {
...SecuritiesConnectionFragment
}
securitiesByTaId {
...SecuritiesConnectionFragment
}
holdingsByInvestorId {
...HoldingsConnectionFragment
}
issuanceEventsByInvestorId {
...IssuanceEventsConnectionFragment
}
issuanceEventsByIssuerId {
...IssuanceEventsConnectionFragment
}
vendorAgentsByAgentId {
...VendorAgentsConnectionFragment
}
vendorAgentsByVendorId {
...VendorAgentsConnectionFragment
}
securityListingsByIssuerId {
...SecurityListingsConnectionFragment
}
securityListingsByAtsId {
...SecurityListingsConnectionFragment
}
documentsByUploadedBy {
...DocumentsConnectionFragment
}
accountDocumentsByFromAccountId {
...AccountDocumentsConnectionFragment
}
accountDocumentsByToAccountId {
...AccountDocumentsConnectionFragment
}
documentSharingsByUploaderId {
...DocumentSharingsConnectionFragment
}
accountRestrictionsByAccountId {
...AccountRestrictionsConnectionFragment
}
accountRestrictionsByCreatorAccountId {
...AccountRestrictionsConnectionFragment
}
paymentAccountsByAccountId {
...PaymentAccountsConnectionFragment
}
paymentMethodsByAccountId {
...PaymentMethodsConnectionFragment
}
paymentIssuersByIssuerId {
...PaymentIssuersConnectionFragment
}
paymentIssuersByAccountId {
...PaymentIssuersConnectionFragment
}
omnibusHoldingsByAccountId {
...OmnibusHoldingsConnectionFragment
}
omnibusInvestorsByInvestorId {
...OmnibusInvestorsConnectionFragment
}
omnibusInvestorsByAccountId {
...OmnibusInvestorsConnectionFragment
}
webhookConfigurationsByAccountId {
...WebhookConfigurationsConnectionFragment
}
customerPartiesByCreatorAccountId {
...CustomerPartiesConnectionFragment
}
customerAddressesByCreatorAccountId {
...CustomerAddressesConnectionFragment
}
customerPartyAddressesByCreatorAccountId {
...CustomerPartyAddressesConnectionFragment
}
blockchainAddressSourcesByVendorId {
...BlockchainAddressSourcesConnectionFragment
}
blockchainAddressSourcesByInvestorId {
...BlockchainAddressSourcesConnectionFragment
}
blockchainAddressSourcesByCreatorAccountId {
...BlockchainAddressSourcesConnectionFragment
}
taRequestsByVendorId {
...TaRequestsConnectionFragment
}
taRequestsByInvestorId {
...TaRequestsConnectionFragment
}
taRequestsByCreatorAccountId {
...TaRequestsConnectionFragment
}
accountAddressesByAccountId {
...AccountAddressesConnectionFragment
}
atsTagsByAccountId {
...AtsTagsConnectionFragment
}
idempotentsByAtsId {
...IdempotentsConnectionFragment
}
partiesByAccountId {
...PartiesConnectionFragment
}
partyAddressesByAccountId {
...PartyAddressesConnectionFragment
}
requestsByAccountId {
...RequestsConnectionFragment
}
stagedBalanceTransfersByToAccountId {
...StagedBalanceTransfersConnectionFragment
}
stagedBalanceTransfersByFromAccountId {
...StagedBalanceTransfersConnectionFragment
}
stagedTransfersByAccountId {
...StagedTransfersConnectionFragment
}
tradesByAtsId {
...TradesConnectionFragment
}
tradesByFromAccountId {
...TradesConnectionFragment
}
tradesByToAccountId {
...TradesConnectionFragment
}
transfersByAtsId {
...TransfersConnectionFragment
}
transfersByFromAccountId {
...TransfersConnectionFragment
}
transfersByToAccountId {
...TransfersConnectionFragment
}
contactName
holdings
taxShort
}
}
Variables
{"nodeId": 4}
Response
{
"data": {
"account": {
"nodeId": "4",
"type": "xyz789",
"company": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"name": "abc123",
"jurisdiction": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"email": "abc123",
"url": "abc123",
"slug": "abc123",
"twitterHandle": "xyz789",
"supportEmail": "xyz789",
"newId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"setup": false,
"entity": true,
"oldId": 123,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"createdOn": Datetime,
"investorType": "abc123",
"formationDate": "2007-12-03",
"externalEmail": "xyz789",
"useReal": true,
"auxAccountByType": AuxAccount,
"companyByCompany": Company,
"countryByJurisdiction": Country,
"investorAccountTypeByInvestorType": InvestorAccountType,
"customersByVendorId": CustomersConnection,
"customersByInvestorId": CustomersConnection,
"usersAccountsByAccountId": UsersAccountsConnection,
"accountsBlockchainAddressesByAccountId": AccountsBlockchainAddressesConnection,
"blockchainRegistrationsByAccountId": BlockchainRegistrationsConnection,
"assetsByIssuerId": AssetsConnection,
"assetArchivesByAccountId": AssetArchivesConnection,
"allocationsByOwnerId": AllocationsConnection,
"allocationsByIssuerId": AllocationsConnection,
"allocationArchivesByAccountId": AllocationArchivesConnection,
"brokerAllocationsByBrokerId": BrokerAllocationsConnection,
"distributionsByInvestorId": DistributionsConnection,
"transactionsByBrokerId": TransactionsConnection,
"ledgersByInvestorId": LedgersConnection,
"distributionAnnotationsByAccountId": DistributionAnnotationsConnection,
"assetAnnotationsByAccountId": AssetAnnotationsConnection,
"allocationAnnotationsByAccountId": AllocationAnnotationsConnection,
"transactionAnnotationsByAccountId": TransactionAnnotationsConnection,
"managedAccountsByManagerId": ManagedAccountsConnection,
"managedAccountsByEntityId": ManagedAccountsConnection,
"accountIntegrationsByAccountId": AccountIntegrationsConnection,
"vendorQualificationsByAccountId": VendorQualificationsConnection,
"stepsByOwnedBy": StepsConnection,
"stepsByExecuteBy": StepsConnection,
"distributionCustomFieldsByCreatedBy": DistributionCustomFieldsConnection,
"signingAccountsByAccountId": SigningAccountsConnection,
"signingTemplatesByAccountId": SigningTemplatesConnection,
"mappedSigningTemplatesByAccountId": MappedSigningTemplatesConnection,
"sentSigningDocumentsBySentTo": SentSigningDocumentsConnection,
"allocationOfferingLinksByCreatedBy": AllocationOfferingLinksConnection,
"allocationOfferingLinksByAgentId": AllocationOfferingLinksConnection,
"accountPhoneNumbersByAccountId": AccountPhoneNumbersConnection,
"accountRegDStatusByAccountId": AccountRegDStatus,
"accountRegDStatusesByAccountId": AccountRegDStatusesConnection,
"accountTaxInformationsByAccountId": AccountTaxInformationsConnection,
"onboardingQuestionSetsByAccountId": OnboardingQuestionSetsConnection,
"onboardingQuestionsByAccountId": OnboardingQuestionsConnection,
"instancedAccountInformationsByAccountId": InstancedAccountInformationsConnection,
"instancedAccountInformationsByVendorAccountId": InstancedAccountInformationsConnection,
"instancedMappingFieldsByAccountId": InstancedMappingFieldsConnection,
"vendorDefaultEmailPreferenceByAccountId": VendorDefaultEmailPreference,
"vendorDefaultEmailPreferencesByAccountId": VendorDefaultEmailPreferencesConnection,
"allocationEmailPreferencesByAccountId": AllocationEmailPreferencesConnection,
"securitiesByIssuerId": SecuritiesConnection,
"securitiesByTaId": SecuritiesConnection,
"holdingsByInvestorId": HoldingsConnection,
"issuanceEventsByInvestorId": IssuanceEventsConnection,
"issuanceEventsByIssuerId": IssuanceEventsConnection,
"vendorAgentsByAgentId": VendorAgentsConnection,
"vendorAgentsByVendorId": VendorAgentsConnection,
"securityListingsByIssuerId": SecurityListingsConnection,
"securityListingsByAtsId": SecurityListingsConnection,
"documentsByUploadedBy": DocumentsConnection,
"accountDocumentsByFromAccountId": AccountDocumentsConnection,
"accountDocumentsByToAccountId": AccountDocumentsConnection,
"documentSharingsByUploaderId": DocumentSharingsConnection,
"accountRestrictionsByAccountId": AccountRestrictionsConnection,
"accountRestrictionsByCreatorAccountId": AccountRestrictionsConnection,
"paymentAccountsByAccountId": PaymentAccountsConnection,
"paymentMethodsByAccountId": PaymentMethodsConnection,
"paymentIssuersByIssuerId": PaymentIssuersConnection,
"paymentIssuersByAccountId": PaymentIssuersConnection,
"omnibusHoldingsByAccountId": OmnibusHoldingsConnection,
"omnibusInvestorsByInvestorId": OmnibusInvestorsConnection,
"omnibusInvestorsByAccountId": OmnibusInvestorsConnection,
"webhookConfigurationsByAccountId": WebhookConfigurationsConnection,
"customerPartiesByCreatorAccountId": CustomerPartiesConnection,
"customerAddressesByCreatorAccountId": CustomerAddressesConnection,
"customerPartyAddressesByCreatorAccountId": CustomerPartyAddressesConnection,
"blockchainAddressSourcesByVendorId": BlockchainAddressSourcesConnection,
"blockchainAddressSourcesByInvestorId": BlockchainAddressSourcesConnection,
"blockchainAddressSourcesByCreatorAccountId": BlockchainAddressSourcesConnection,
"taRequestsByVendorId": TaRequestsConnection,
"taRequestsByInvestorId": TaRequestsConnection,
"taRequestsByCreatorAccountId": TaRequestsConnection,
"accountAddressesByAccountId": AccountAddressesConnection,
"atsTagsByAccountId": AtsTagsConnection,
"idempotentsByAtsId": IdempotentsConnection,
"partiesByAccountId": PartiesConnection,
"partyAddressesByAccountId": PartyAddressesConnection,
"requestsByAccountId": RequestsConnection,
"stagedBalanceTransfersByToAccountId": StagedBalanceTransfersConnection,
"stagedBalanceTransfersByFromAccountId": StagedBalanceTransfersConnection,
"stagedTransfersByAccountId": StagedTransfersConnection,
"tradesByAtsId": TradesConnection,
"tradesByFromAccountId": TradesConnection,
"tradesByToAccountId": TradesConnection,
"transfersByAtsId": TransfersConnection,
"transfersByFromAccountId": TransfersConnection,
"transfersByToAccountId": TransfersConnection,
"contactName": "abc123",
"holdings": BigFloat,
"taxShort": "xyz789"
}
}
}
accountById
Example
Query
query accountById($id: UUID!) {
accountById(id: $id) {
nodeId
type
company
name
jurisdiction
email
url
slug
twitterHandle
supportEmail
newId
setup
entity
oldId
id
createdOn
investorType
formationDate
externalEmail
useReal
auxAccountByType {
...AuxAccountFragment
}
companyByCompany {
...CompanyFragment
}
countryByJurisdiction {
...CountryFragment
}
investorAccountTypeByInvestorType {
...InvestorAccountTypeFragment
}
customersByVendorId {
...CustomersConnectionFragment
}
customersByInvestorId {
...CustomersConnectionFragment
}
usersAccountsByAccountId {
...UsersAccountsConnectionFragment
}
accountsBlockchainAddressesByAccountId {
...AccountsBlockchainAddressesConnectionFragment
}
blockchainRegistrationsByAccountId {
...BlockchainRegistrationsConnectionFragment
}
assetsByIssuerId {
...AssetsConnectionFragment
}
assetArchivesByAccountId {
...AssetArchivesConnectionFragment
}
allocationsByOwnerId {
...AllocationsConnectionFragment
}
allocationsByIssuerId {
...AllocationsConnectionFragment
}
allocationArchivesByAccountId {
...AllocationArchivesConnectionFragment
}
brokerAllocationsByBrokerId {
...BrokerAllocationsConnectionFragment
}
distributionsByInvestorId {
...DistributionsConnectionFragment
}
transactionsByBrokerId {
...TransactionsConnectionFragment
}
ledgersByInvestorId {
...LedgersConnectionFragment
}
distributionAnnotationsByAccountId {
...DistributionAnnotationsConnectionFragment
}
assetAnnotationsByAccountId {
...AssetAnnotationsConnectionFragment
}
allocationAnnotationsByAccountId {
...AllocationAnnotationsConnectionFragment
}
transactionAnnotationsByAccountId {
...TransactionAnnotationsConnectionFragment
}
managedAccountsByManagerId {
...ManagedAccountsConnectionFragment
}
managedAccountsByEntityId {
...ManagedAccountsConnectionFragment
}
accountIntegrationsByAccountId {
...AccountIntegrationsConnectionFragment
}
vendorQualificationsByAccountId {
...VendorQualificationsConnectionFragment
}
stepsByOwnedBy {
...StepsConnectionFragment
}
stepsByExecuteBy {
...StepsConnectionFragment
}
distributionCustomFieldsByCreatedBy {
...DistributionCustomFieldsConnectionFragment
}
signingAccountsByAccountId {
...SigningAccountsConnectionFragment
}
signingTemplatesByAccountId {
...SigningTemplatesConnectionFragment
}
mappedSigningTemplatesByAccountId {
...MappedSigningTemplatesConnectionFragment
}
sentSigningDocumentsBySentTo {
...SentSigningDocumentsConnectionFragment
}
allocationOfferingLinksByCreatedBy {
...AllocationOfferingLinksConnectionFragment
}
allocationOfferingLinksByAgentId {
...AllocationOfferingLinksConnectionFragment
}
accountPhoneNumbersByAccountId {
...AccountPhoneNumbersConnectionFragment
}
accountRegDStatusByAccountId {
...AccountRegDStatusFragment
}
accountRegDStatusesByAccountId {
...AccountRegDStatusesConnectionFragment
}
accountTaxInformationsByAccountId {
...AccountTaxInformationsConnectionFragment
}
onboardingQuestionSetsByAccountId {
...OnboardingQuestionSetsConnectionFragment
}
onboardingQuestionsByAccountId {
...OnboardingQuestionsConnectionFragment
}
instancedAccountInformationsByAccountId {
...InstancedAccountInformationsConnectionFragment
}
instancedAccountInformationsByVendorAccountId {
...InstancedAccountInformationsConnectionFragment
}
instancedMappingFieldsByAccountId {
...InstancedMappingFieldsConnectionFragment
}
vendorDefaultEmailPreferenceByAccountId {
...VendorDefaultEmailPreferenceFragment
}
vendorDefaultEmailPreferencesByAccountId {
...VendorDefaultEmailPreferencesConnectionFragment
}
allocationEmailPreferencesByAccountId {
...AllocationEmailPreferencesConnectionFragment
}
securitiesByIssuerId {
...SecuritiesConnectionFragment
}
securitiesByTaId {
...SecuritiesConnectionFragment
}
holdingsByInvestorId {
...HoldingsConnectionFragment
}
issuanceEventsByInvestorId {
...IssuanceEventsConnectionFragment
}
issuanceEventsByIssuerId {
...IssuanceEventsConnectionFragment
}
vendorAgentsByAgentId {
...VendorAgentsConnectionFragment
}
vendorAgentsByVendorId {
...VendorAgentsConnectionFragment
}
securityListingsByIssuerId {
...SecurityListingsConnectionFragment
}
securityListingsByAtsId {
...SecurityListingsConnectionFragment
}
documentsByUploadedBy {
...DocumentsConnectionFragment
}
accountDocumentsByFromAccountId {
...AccountDocumentsConnectionFragment
}
accountDocumentsByToAccountId {
...AccountDocumentsConnectionFragment
}
documentSharingsByUploaderId {
...DocumentSharingsConnectionFragment
}
accountRestrictionsByAccountId {
...AccountRestrictionsConnectionFragment
}
accountRestrictionsByCreatorAccountId {
...AccountRestrictionsConnectionFragment
}
paymentAccountsByAccountId {
...PaymentAccountsConnectionFragment
}
paymentMethodsByAccountId {
...PaymentMethodsConnectionFragment
}
paymentIssuersByIssuerId {
...PaymentIssuersConnectionFragment
}
paymentIssuersByAccountId {
...PaymentIssuersConnectionFragment
}
omnibusHoldingsByAccountId {
...OmnibusHoldingsConnectionFragment
}
omnibusInvestorsByInvestorId {
...OmnibusInvestorsConnectionFragment
}
omnibusInvestorsByAccountId {
...OmnibusInvestorsConnectionFragment
}
webhookConfigurationsByAccountId {
...WebhookConfigurationsConnectionFragment
}
customerPartiesByCreatorAccountId {
...CustomerPartiesConnectionFragment
}
customerAddressesByCreatorAccountId {
...CustomerAddressesConnectionFragment
}
customerPartyAddressesByCreatorAccountId {
...CustomerPartyAddressesConnectionFragment
}
blockchainAddressSourcesByVendorId {
...BlockchainAddressSourcesConnectionFragment
}
blockchainAddressSourcesByInvestorId {
...BlockchainAddressSourcesConnectionFragment
}
blockchainAddressSourcesByCreatorAccountId {
...BlockchainAddressSourcesConnectionFragment
}
taRequestsByVendorId {
...TaRequestsConnectionFragment
}
taRequestsByInvestorId {
...TaRequestsConnectionFragment
}
taRequestsByCreatorAccountId {
...TaRequestsConnectionFragment
}
accountAddressesByAccountId {
...AccountAddressesConnectionFragment
}
atsTagsByAccountId {
...AtsTagsConnectionFragment
}
idempotentsByAtsId {
...IdempotentsConnectionFragment
}
partiesByAccountId {
...PartiesConnectionFragment
}
partyAddressesByAccountId {
...PartyAddressesConnectionFragment
}
requestsByAccountId {
...RequestsConnectionFragment
}
stagedBalanceTransfersByToAccountId {
...StagedBalanceTransfersConnectionFragment
}
stagedBalanceTransfersByFromAccountId {
...StagedBalanceTransfersConnectionFragment
}
stagedTransfersByAccountId {
...StagedTransfersConnectionFragment
}
tradesByAtsId {
...TradesConnectionFragment
}
tradesByFromAccountId {
...TradesConnectionFragment
}
tradesByToAccountId {
...TradesConnectionFragment
}
transfersByAtsId {
...TransfersConnectionFragment
}
transfersByFromAccountId {
...TransfersConnectionFragment
}
transfersByToAccountId {
...TransfersConnectionFragment
}
contactName
holdings
taxShort
}
}
Variables
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
Response
{
"data": {
"accountById": {
"nodeId": 4,
"type": "xyz789",
"company": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"name": "xyz789",
"jurisdiction": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"email": "xyz789",
"url": "xyz789",
"slug": "xyz789",
"twitterHandle": "abc123",
"supportEmail": "abc123",
"newId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"setup": true,
"entity": false,
"oldId": 987,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"createdOn": Datetime,
"investorType": "xyz789",
"formationDate": "2007-12-03",
"externalEmail": "xyz789",
"useReal": false,
"auxAccountByType": AuxAccount,
"companyByCompany": Company,
"countryByJurisdiction": Country,
"investorAccountTypeByInvestorType": InvestorAccountType,
"customersByVendorId": CustomersConnection,
"customersByInvestorId": CustomersConnection,
"usersAccountsByAccountId": UsersAccountsConnection,
"accountsBlockchainAddressesByAccountId": AccountsBlockchainAddressesConnection,
"blockchainRegistrationsByAccountId": BlockchainRegistrationsConnection,
"assetsByIssuerId": AssetsConnection,
"assetArchivesByAccountId": AssetArchivesConnection,
"allocationsByOwnerId": AllocationsConnection,
"allocationsByIssuerId": AllocationsConnection,
"allocationArchivesByAccountId": AllocationArchivesConnection,
"brokerAllocationsByBrokerId": BrokerAllocationsConnection,
"distributionsByInvestorId": DistributionsConnection,
"transactionsByBrokerId": TransactionsConnection,
"ledgersByInvestorId": LedgersConnection,
"distributionAnnotationsByAccountId": DistributionAnnotationsConnection,
"assetAnnotationsByAccountId": AssetAnnotationsConnection,
"allocationAnnotationsByAccountId": AllocationAnnotationsConnection,
"transactionAnnotationsByAccountId": TransactionAnnotationsConnection,
"managedAccountsByManagerId": ManagedAccountsConnection,
"managedAccountsByEntityId": ManagedAccountsConnection,
"accountIntegrationsByAccountId": AccountIntegrationsConnection,
"vendorQualificationsByAccountId": VendorQualificationsConnection,
"stepsByOwnedBy": StepsConnection,
"stepsByExecuteBy": StepsConnection,
"distributionCustomFieldsByCreatedBy": DistributionCustomFieldsConnection,
"signingAccountsByAccountId": SigningAccountsConnection,
"signingTemplatesByAccountId": SigningTemplatesConnection,
"mappedSigningTemplatesByAccountId": MappedSigningTemplatesConnection,
"sentSigningDocumentsBySentTo": SentSigningDocumentsConnection,
"allocationOfferingLinksByCreatedBy": AllocationOfferingLinksConnection,
"allocationOfferingLinksByAgentId": AllocationOfferingLinksConnection,
"accountPhoneNumbersByAccountId": AccountPhoneNumbersConnection,
"accountRegDStatusByAccountId": AccountRegDStatus,
"accountRegDStatusesByAccountId": AccountRegDStatusesConnection,
"accountTaxInformationsByAccountId": AccountTaxInformationsConnection,
"onboardingQuestionSetsByAccountId": OnboardingQuestionSetsConnection,
"onboardingQuestionsByAccountId": OnboardingQuestionsConnection,
"instancedAccountInformationsByAccountId": InstancedAccountInformationsConnection,
"instancedAccountInformationsByVendorAccountId": InstancedAccountInformationsConnection,
"instancedMappingFieldsByAccountId": InstancedMappingFieldsConnection,
"vendorDefaultEmailPreferenceByAccountId": VendorDefaultEmailPreference,
"vendorDefaultEmailPreferencesByAccountId": VendorDefaultEmailPreferencesConnection,
"allocationEmailPreferencesByAccountId": AllocationEmailPreferencesConnection,
"securitiesByIssuerId": SecuritiesConnection,
"securitiesByTaId": SecuritiesConnection,
"holdingsByInvestorId": HoldingsConnection,
"issuanceEventsByInvestorId": IssuanceEventsConnection,
"issuanceEventsByIssuerId": IssuanceEventsConnection,
"vendorAgentsByAgentId": VendorAgentsConnection,
"vendorAgentsByVendorId": VendorAgentsConnection,
"securityListingsByIssuerId": SecurityListingsConnection,
"securityListingsByAtsId": SecurityListingsConnection,
"documentsByUploadedBy": DocumentsConnection,
"accountDocumentsByFromAccountId": AccountDocumentsConnection,
"accountDocumentsByToAccountId": AccountDocumentsConnection,
"documentSharingsByUploaderId": DocumentSharingsConnection,
"accountRestrictionsByAccountId": AccountRestrictionsConnection,
"accountRestrictionsByCreatorAccountId": AccountRestrictionsConnection,
"paymentAccountsByAccountId": PaymentAccountsConnection,
"paymentMethodsByAccountId": PaymentMethodsConnection,
"paymentIssuersByIssuerId": PaymentIssuersConnection,
"paymentIssuersByAccountId": PaymentIssuersConnection,
"omnibusHoldingsByAccountId": OmnibusHoldingsConnection,
"omnibusInvestorsByInvestorId": OmnibusInvestorsConnection,
"omnibusInvestorsByAccountId": OmnibusInvestorsConnection,
"webhookConfigurationsByAccountId": WebhookConfigurationsConnection,
"customerPartiesByCreatorAccountId": CustomerPartiesConnection,
"customerAddressesByCreatorAccountId": CustomerAddressesConnection,
"customerPartyAddressesByCreatorAccountId": CustomerPartyAddressesConnection,
"blockchainAddressSourcesByVendorId": BlockchainAddressSourcesConnection,
"blockchainAddressSourcesByInvestorId": BlockchainAddressSourcesConnection,
"blockchainAddressSourcesByCreatorAccountId": BlockchainAddressSourcesConnection,
"taRequestsByVendorId": TaRequestsConnection,
"taRequestsByInvestorId": TaRequestsConnection,
"taRequestsByCreatorAccountId": TaRequestsConnection,
"accountAddressesByAccountId": AccountAddressesConnection,
"atsTagsByAccountId": AtsTagsConnection,
"idempotentsByAtsId": IdempotentsConnection,
"partiesByAccountId": PartiesConnection,
"partyAddressesByAccountId": PartyAddressesConnection,
"requestsByAccountId": RequestsConnection,
"stagedBalanceTransfersByToAccountId": StagedBalanceTransfersConnection,
"stagedBalanceTransfersByFromAccountId": StagedBalanceTransfersConnection,
"stagedTransfersByAccountId": StagedTransfersConnection,
"tradesByAtsId": TradesConnection,
"tradesByFromAccountId": TradesConnection,
"tradesByToAccountId": TradesConnection,
"transfersByAtsId": TransfersConnection,
"transfersByFromAccountId": TransfersConnection,
"transfersByToAccountId": TransfersConnection,
"contactName": "abc123",
"holdings": BigFloat,
"taxShort": "abc123"
}
}
}
accountBySupportEmail
Example
Query
query accountBySupportEmail($supportEmail: String!) {
accountBySupportEmail(supportEmail: $supportEmail) {
nodeId
type
company
name
jurisdiction
email
url
slug
twitterHandle
supportEmail
newId
setup
entity
oldId
id
createdOn
investorType
formationDate
externalEmail
useReal
auxAccountByType {
...AuxAccountFragment
}
companyByCompany {
...CompanyFragment
}
countryByJurisdiction {
...CountryFragment
}
investorAccountTypeByInvestorType {
...InvestorAccountTypeFragment
}
customersByVendorId {
...CustomersConnectionFragment
}
customersByInvestorId {
...CustomersConnectionFragment
}
usersAccountsByAccountId {
...UsersAccountsConnectionFragment
}
accountsBlockchainAddressesByAccountId {
...AccountsBlockchainAddressesConnectionFragment
}
blockchainRegistrationsByAccountId {
...BlockchainRegistrationsConnectionFragment
}
assetsByIssuerId {
...AssetsConnectionFragment
}
assetArchivesByAccountId {
...AssetArchivesConnectionFragment
}
allocationsByOwnerId {
...AllocationsConnectionFragment
}
allocationsByIssuerId {
...AllocationsConnectionFragment
}
allocationArchivesByAccountId {
...AllocationArchivesConnectionFragment
}
brokerAllocationsByBrokerId {
...BrokerAllocationsConnectionFragment
}
distributionsByInvestorId {
...DistributionsConnectionFragment
}
transactionsByBrokerId {
...TransactionsConnectionFragment
}
ledgersByInvestorId {
...LedgersConnectionFragment
}
distributionAnnotationsByAccountId {
...DistributionAnnotationsConnectionFragment
}
assetAnnotationsByAccountId {
...AssetAnnotationsConnectionFragment
}
allocationAnnotationsByAccountId {
...AllocationAnnotationsConnectionFragment
}
transactionAnnotationsByAccountId {
...TransactionAnnotationsConnectionFragment
}
managedAccountsByManagerId {
...ManagedAccountsConnectionFragment
}
managedAccountsByEntityId {
...ManagedAccountsConnectionFragment
}
accountIntegrationsByAccountId {
...AccountIntegrationsConnectionFragment
}
vendorQualificationsByAccountId {
...VendorQualificationsConnectionFragment
}
stepsByOwnedBy {
...StepsConnectionFragment
}
stepsByExecuteBy {
...StepsConnectionFragment
}
distributionCustomFieldsByCreatedBy {
...DistributionCustomFieldsConnectionFragment
}
signingAccountsByAccountId {
...SigningAccountsConnectionFragment
}
signingTemplatesByAccountId {
...SigningTemplatesConnectionFragment
}
mappedSigningTemplatesByAccountId {
...MappedSigningTemplatesConnectionFragment
}
sentSigningDocumentsBySentTo {
...SentSigningDocumentsConnectionFragment
}
allocationOfferingLinksByCreatedBy {
...AllocationOfferingLinksConnectionFragment
}
allocationOfferingLinksByAgentId {
...AllocationOfferingLinksConnectionFragment
}
accountPhoneNumbersByAccountId {
...AccountPhoneNumbersConnectionFragment
}
accountRegDStatusByAccountId {
...AccountRegDStatusFragment
}
accountRegDStatusesByAccountId {
...AccountRegDStatusesConnectionFragment
}
accountTaxInformationsByAccountId {
...AccountTaxInformationsConnectionFragment
}
onboardingQuestionSetsByAccountId {
...OnboardingQuestionSetsConnectionFragment
}
onboardingQuestionsByAccountId {
...OnboardingQuestionsConnectionFragment
}
instancedAccountInformationsByAccountId {
...InstancedAccountInformationsConnectionFragment
}
instancedAccountInformationsByVendorAccountId {
...InstancedAccountInformationsConnectionFragment
}
instancedMappingFieldsByAccountId {
...InstancedMappingFieldsConnectionFragment
}
vendorDefaultEmailPreferenceByAccountId {
...VendorDefaultEmailPreferenceFragment
}
vendorDefaultEmailPreferencesByAccountId {
...VendorDefaultEmailPreferencesConnectionFragment
}
allocationEmailPreferencesByAccountId {
...AllocationEmailPreferencesConnectionFragment
}
securitiesByIssuerId {
...SecuritiesConnectionFragment
}
securitiesByTaId {
...SecuritiesConnectionFragment
}
holdingsByInvestorId {
...HoldingsConnectionFragment
}
issuanceEventsByInvestorId {
...IssuanceEventsConnectionFragment
}
issuanceEventsByIssuerId {
...IssuanceEventsConnectionFragment
}
vendorAgentsByAgentId {
...VendorAgentsConnectionFragment
}
vendorAgentsByVendorId {
...VendorAgentsConnectionFragment
}
securityListingsByIssuerId {
...SecurityListingsConnectionFragment
}
securityListingsByAtsId {
...SecurityListingsConnectionFragment
}
documentsByUploadedBy {
...DocumentsConnectionFragment
}
accountDocumentsByFromAccountId {
...AccountDocumentsConnectionFragment
}
accountDocumentsByToAccountId {
...AccountDocumentsConnectionFragment
}
documentSharingsByUploaderId {
...DocumentSharingsConnectionFragment
}
accountRestrictionsByAccountId {
...AccountRestrictionsConnectionFragment
}
accountRestrictionsByCreatorAccountId {
...AccountRestrictionsConnectionFragment
}
paymentAccountsByAccountId {
...PaymentAccountsConnectionFragment
}
paymentMethodsByAccountId {
...PaymentMethodsConnectionFragment
}
paymentIssuersByIssuerId {
...PaymentIssuersConnectionFragment
}
paymentIssuersByAccountId {
...PaymentIssuersConnectionFragment
}
omnibusHoldingsByAccountId {
...OmnibusHoldingsConnectionFragment
}
omnibusInvestorsByInvestorId {
...OmnibusInvestorsConnectionFragment
}
omnibusInvestorsByAccountId {
...OmnibusInvestorsConnectionFragment
}
webhookConfigurationsByAccountId {
...WebhookConfigurationsConnectionFragment
}
customerPartiesByCreatorAccountId {
...CustomerPartiesConnectionFragment
}
customerAddressesByCreatorAccountId {
...CustomerAddressesConnectionFragment
}
customerPartyAddressesByCreatorAccountId {
...CustomerPartyAddressesConnectionFragment
}
blockchainAddressSourcesByVendorId {
...BlockchainAddressSourcesConnectionFragment
}
blockchainAddressSourcesByInvestorId {
...BlockchainAddressSourcesConnectionFragment
}
blockchainAddressSourcesByCreatorAccountId {
...BlockchainAddressSourcesConnectionFragment
}
taRequestsByVendorId {
...TaRequestsConnectionFragment
}
taRequestsByInvestorId {
...TaRequestsConnectionFragment
}
taRequestsByCreatorAccountId {
...TaRequestsConnectionFragment
}
accountAddressesByAccountId {
...AccountAddressesConnectionFragment
}
atsTagsByAccountId {
...AtsTagsConnectionFragment
}
idempotentsByAtsId {
...IdempotentsConnectionFragment
}
partiesByAccountId {
...PartiesConnectionFragment
}
partyAddressesByAccountId {
...PartyAddressesConnectionFragment
}
requestsByAccountId {
...RequestsConnectionFragment
}
stagedBalanceTransfersByToAccountId {
...StagedBalanceTransfersConnectionFragment
}
stagedBalanceTransfersByFromAccountId {
...StagedBalanceTransfersConnectionFragment
}
stagedTransfersByAccountId {
...StagedTransfersConnectionFragment
}
tradesByAtsId {
...TradesConnectionFragment
}
tradesByFromAccountId {
...TradesConnectionFragment
}
tradesByToAccountId {
...TradesConnectionFragment
}
transfersByAtsId {
...TransfersConnectionFragment
}
transfersByFromAccountId {
...TransfersConnectionFragment
}
transfersByToAccountId {
...TransfersConnectionFragment
}
contactName
holdings
taxShort
}
}
Variables
{"supportEmail": "xyz789"}
Response
{
"data": {
"accountBySupportEmail": {
"nodeId": "4",
"type": "abc123",
"company": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"name": "abc123",
"jurisdiction": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"email": "abc123",
"url": "xyz789",
"slug": "xyz789",
"twitterHandle": "abc123",
"supportEmail": "abc123",
"newId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"setup": false,
"entity": false,
"oldId": 987,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"createdOn": Datetime,
"investorType": "xyz789",
"formationDate": "2007-12-03",
"externalEmail": "xyz789",
"useReal": true,
"auxAccountByType": AuxAccount,
"companyByCompany": Company,
"countryByJurisdiction": Country,
"investorAccountTypeByInvestorType": InvestorAccountType,
"customersByVendorId": CustomersConnection,
"customersByInvestorId": CustomersConnection,
"usersAccountsByAccountId": UsersAccountsConnection,
"accountsBlockchainAddressesByAccountId": AccountsBlockchainAddressesConnection,
"blockchainRegistrationsByAccountId": BlockchainRegistrationsConnection,
"assetsByIssuerId": AssetsConnection,
"assetArchivesByAccountId": AssetArchivesConnection,
"allocationsByOwnerId": AllocationsConnection,
"allocationsByIssuerId": AllocationsConnection,
"allocationArchivesByAccountId": AllocationArchivesConnection,
"brokerAllocationsByBrokerId": BrokerAllocationsConnection,
"distributionsByInvestorId": DistributionsConnection,
"transactionsByBrokerId": TransactionsConnection,
"ledgersByInvestorId": LedgersConnection,
"distributionAnnotationsByAccountId": DistributionAnnotationsConnection,
"assetAnnotationsByAccountId": AssetAnnotationsConnection,
"allocationAnnotationsByAccountId": AllocationAnnotationsConnection,
"transactionAnnotationsByAccountId": TransactionAnnotationsConnection,
"managedAccountsByManagerId": ManagedAccountsConnection,
"managedAccountsByEntityId": ManagedAccountsConnection,
"accountIntegrationsByAccountId": AccountIntegrationsConnection,
"vendorQualificationsByAccountId": VendorQualificationsConnection,
"stepsByOwnedBy": StepsConnection,
"stepsByExecuteBy": StepsConnection,
"distributionCustomFieldsByCreatedBy": DistributionCustomFieldsConnection,
"signingAccountsByAccountId": SigningAccountsConnection,
"signingTemplatesByAccountId": SigningTemplatesConnection,
"mappedSigningTemplatesByAccountId": MappedSigningTemplatesConnection,
"sentSigningDocumentsBySentTo": SentSigningDocumentsConnection,
"allocationOfferingLinksByCreatedBy": AllocationOfferingLinksConnection,
"allocationOfferingLinksByAgentId": AllocationOfferingLinksConnection,
"accountPhoneNumbersByAccountId": AccountPhoneNumbersConnection,
"accountRegDStatusByAccountId": AccountRegDStatus,
"accountRegDStatusesByAccountId": AccountRegDStatusesConnection,
"accountTaxInformationsByAccountId": AccountTaxInformationsConnection,
"onboardingQuestionSetsByAccountId": OnboardingQuestionSetsConnection,
"onboardingQuestionsByAccountId": OnboardingQuestionsConnection,
"instancedAccountInformationsByAccountId": InstancedAccountInformationsConnection,
"instancedAccountInformationsByVendorAccountId": InstancedAccountInformationsConnection,
"instancedMappingFieldsByAccountId": InstancedMappingFieldsConnection,
"vendorDefaultEmailPreferenceByAccountId": VendorDefaultEmailPreference,
"vendorDefaultEmailPreferencesByAccountId": VendorDefaultEmailPreferencesConnection,
"allocationEmailPreferencesByAccountId": AllocationEmailPreferencesConnection,
"securitiesByIssuerId": SecuritiesConnection,
"securitiesByTaId": SecuritiesConnection,
"holdingsByInvestorId": HoldingsConnection,
"issuanceEventsByInvestorId": IssuanceEventsConnection,
"issuanceEventsByIssuerId": IssuanceEventsConnection,
"vendorAgentsByAgentId": VendorAgentsConnection,
"vendorAgentsByVendorId": VendorAgentsConnection,
"securityListingsByIssuerId": SecurityListingsConnection,
"securityListingsByAtsId": SecurityListingsConnection,
"documentsByUploadedBy": DocumentsConnection,
"accountDocumentsByFromAccountId": AccountDocumentsConnection,
"accountDocumentsByToAccountId": AccountDocumentsConnection,
"documentSharingsByUploaderId": DocumentSharingsConnection,
"accountRestrictionsByAccountId": AccountRestrictionsConnection,
"accountRestrictionsByCreatorAccountId": AccountRestrictionsConnection,
"paymentAccountsByAccountId": PaymentAccountsConnection,
"paymentMethodsByAccountId": PaymentMethodsConnection,
"paymentIssuersByIssuerId": PaymentIssuersConnection,
"paymentIssuersByAccountId": PaymentIssuersConnection,
"omnibusHoldingsByAccountId": OmnibusHoldingsConnection,
"omnibusInvestorsByInvestorId": OmnibusInvestorsConnection,
"omnibusInvestorsByAccountId": OmnibusInvestorsConnection,
"webhookConfigurationsByAccountId": WebhookConfigurationsConnection,
"customerPartiesByCreatorAccountId": CustomerPartiesConnection,
"customerAddressesByCreatorAccountId": CustomerAddressesConnection,
"customerPartyAddressesByCreatorAccountId": CustomerPartyAddressesConnection,
"blockchainAddressSourcesByVendorId": BlockchainAddressSourcesConnection,
"blockchainAddressSourcesByInvestorId": BlockchainAddressSourcesConnection,
"blockchainAddressSourcesByCreatorAccountId": BlockchainAddressSourcesConnection,
"taRequestsByVendorId": TaRequestsConnection,
"taRequestsByInvestorId": TaRequestsConnection,
"taRequestsByCreatorAccountId": TaRequestsConnection,
"accountAddressesByAccountId": AccountAddressesConnection,
"atsTagsByAccountId": AtsTagsConnection,
"idempotentsByAtsId": IdempotentsConnection,
"partiesByAccountId": PartiesConnection,
"partyAddressesByAccountId": PartyAddressesConnection,
"requestsByAccountId": RequestsConnection,
"stagedBalanceTransfersByToAccountId": StagedBalanceTransfersConnection,
"stagedBalanceTransfersByFromAccountId": StagedBalanceTransfersConnection,
"stagedTransfersByAccountId": StagedTransfersConnection,
"tradesByAtsId": TradesConnection,
"tradesByFromAccountId": TradesConnection,
"tradesByToAccountId": TradesConnection,
"transfersByAtsId": TransfersConnection,
"transfersByFromAccountId": TransfersConnection,
"transfersByToAccountId": TransfersConnection,
"contactName": "xyz789",
"holdings": BigFloat,
"taxShort": "xyz789"
}
}
}
accountByTypeAndEmail
Example
Query
query accountByTypeAndEmail(
$type: String!,
$email: String!
) {
accountByTypeAndEmail(
type: $type,
email: $email
) {
nodeId
type
company
name
jurisdiction
email
url
slug
twitterHandle
supportEmail
newId
setup
entity
oldId
id
createdOn
investorType
formationDate
externalEmail
useReal
auxAccountByType {
...AuxAccountFragment
}
companyByCompany {
...CompanyFragment
}
countryByJurisdiction {
...CountryFragment
}
investorAccountTypeByInvestorType {
...InvestorAccountTypeFragment
}
customersByVendorId {
...CustomersConnectionFragment
}
customersByInvestorId {
...CustomersConnectionFragment
}
usersAccountsByAccountId {
...UsersAccountsConnectionFragment
}
accountsBlockchainAddressesByAccountId {
...AccountsBlockchainAddressesConnectionFragment
}
blockchainRegistrationsByAccountId {
...BlockchainRegistrationsConnectionFragment
}
assetsByIssuerId {
...AssetsConnectionFragment
}
assetArchivesByAccountId {
...AssetArchivesConnectionFragment
}
allocationsByOwnerId {
...AllocationsConnectionFragment
}
allocationsByIssuerId {
...AllocationsConnectionFragment
}
allocationArchivesByAccountId {
...AllocationArchivesConnectionFragment
}
brokerAllocationsByBrokerId {
...BrokerAllocationsConnectionFragment
}
distributionsByInvestorId {
...DistributionsConnectionFragment
}
transactionsByBrokerId {
...TransactionsConnectionFragment
}
ledgersByInvestorId {
...LedgersConnectionFragment
}
distributionAnnotationsByAccountId {
...DistributionAnnotationsConnectionFragment
}
assetAnnotationsByAccountId {
...AssetAnnotationsConnectionFragment
}
allocationAnnotationsByAccountId {
...AllocationAnnotationsConnectionFragment
}
transactionAnnotationsByAccountId {
...TransactionAnnotationsConnectionFragment
}
managedAccountsByManagerId {
...ManagedAccountsConnectionFragment
}
managedAccountsByEntityId {
...ManagedAccountsConnectionFragment
}
accountIntegrationsByAccountId {
...AccountIntegrationsConnectionFragment
}
vendorQualificationsByAccountId {
...VendorQualificationsConnectionFragment
}
stepsByOwnedBy {
...StepsConnectionFragment
}
stepsByExecuteBy {
...StepsConnectionFragment
}
distributionCustomFieldsByCreatedBy {
...DistributionCustomFieldsConnectionFragment
}
signingAccountsByAccountId {
...SigningAccountsConnectionFragment
}
signingTemplatesByAccountId {
...SigningTemplatesConnectionFragment
}
mappedSigningTemplatesByAccountId {
...MappedSigningTemplatesConnectionFragment
}
sentSigningDocumentsBySentTo {
...SentSigningDocumentsConnectionFragment
}
allocationOfferingLinksByCreatedBy {
...AllocationOfferingLinksConnectionFragment
}
allocationOfferingLinksByAgentId {
...AllocationOfferingLinksConnectionFragment
}
accountPhoneNumbersByAccountId {
...AccountPhoneNumbersConnectionFragment
}
accountRegDStatusByAccountId {
...AccountRegDStatusFragment
}
accountRegDStatusesByAccountId {
...AccountRegDStatusesConnectionFragment
}
accountTaxInformationsByAccountId {
...AccountTaxInformationsConnectionFragment
}
onboardingQuestionSetsByAccountId {
...OnboardingQuestionSetsConnectionFragment
}
onboardingQuestionsByAccountId {
...OnboardingQuestionsConnectionFragment
}
instancedAccountInformationsByAccountId {
...InstancedAccountInformationsConnectionFragment
}
instancedAccountInformationsByVendorAccountId {
...InstancedAccountInformationsConnectionFragment
}
instancedMappingFieldsByAccountId {
...InstancedMappingFieldsConnectionFragment
}
vendorDefaultEmailPreferenceByAccountId {
...VendorDefaultEmailPreferenceFragment
}
vendorDefaultEmailPreferencesByAccountId {
...VendorDefaultEmailPreferencesConnectionFragment
}
allocationEmailPreferencesByAccountId {
...AllocationEmailPreferencesConnectionFragment
}
securitiesByIssuerId {
...SecuritiesConnectionFragment
}
securitiesByTaId {
...SecuritiesConnectionFragment
}
holdingsByInvestorId {
...HoldingsConnectionFragment
}
issuanceEventsByInvestorId {
...IssuanceEventsConnectionFragment
}
issuanceEventsByIssuerId {
...IssuanceEventsConnectionFragment
}
vendorAgentsByAgentId {
...VendorAgentsConnectionFragment
}
vendorAgentsByVendorId {
...VendorAgentsConnectionFragment
}
securityListingsByIssuerId {
...SecurityListingsConnectionFragment
}
securityListingsByAtsId {
...SecurityListingsConnectionFragment
}
documentsByUploadedBy {
...DocumentsConnectionFragment
}
accountDocumentsByFromAccountId {
...AccountDocumentsConnectionFragment
}
accountDocumentsByToAccountId {
...AccountDocumentsConnectionFragment
}
documentSharingsByUploaderId {
...DocumentSharingsConnectionFragment
}
accountRestrictionsByAccountId {
...AccountRestrictionsConnectionFragment
}
accountRestrictionsByCreatorAccountId {
...AccountRestrictionsConnectionFragment
}
paymentAccountsByAccountId {
...PaymentAccountsConnectionFragment
}
paymentMethodsByAccountId {
...PaymentMethodsConnectionFragment
}
paymentIssuersByIssuerId {
...PaymentIssuersConnectionFragment
}
paymentIssuersByAccountId {
...PaymentIssuersConnectionFragment
}
omnibusHoldingsByAccountId {
...OmnibusHoldingsConnectionFragment
}
omnibusInvestorsByInvestorId {
...OmnibusInvestorsConnectionFragment
}
omnibusInvestorsByAccountId {
...OmnibusInvestorsConnectionFragment
}
webhookConfigurationsByAccountId {
...WebhookConfigurationsConnectionFragment
}
customerPartiesByCreatorAccountId {
...CustomerPartiesConnectionFragment
}
customerAddressesByCreatorAccountId {
...CustomerAddressesConnectionFragment
}
customerPartyAddressesByCreatorAccountId {
...CustomerPartyAddressesConnectionFragment
}
blockchainAddressSourcesByVendorId {
...BlockchainAddressSourcesConnectionFragment
}
blockchainAddressSourcesByInvestorId {
...BlockchainAddressSourcesConnectionFragment
}
blockchainAddressSourcesByCreatorAccountId {
...BlockchainAddressSourcesConnectionFragment
}
taRequestsByVendorId {
...TaRequestsConnectionFragment
}
taRequestsByInvestorId {
...TaRequestsConnectionFragment
}
taRequestsByCreatorAccountId {
...TaRequestsConnectionFragment
}
accountAddressesByAccountId {
...AccountAddressesConnectionFragment
}
atsTagsByAccountId {
...AtsTagsConnectionFragment
}
idempotentsByAtsId {
...IdempotentsConnectionFragment
}
partiesByAccountId {
...PartiesConnectionFragment
}
partyAddressesByAccountId {
...PartyAddressesConnectionFragment
}
requestsByAccountId {
...RequestsConnectionFragment
}
stagedBalanceTransfersByToAccountId {
...StagedBalanceTransfersConnectionFragment
}
stagedBalanceTransfersByFromAccountId {
...StagedBalanceTransfersConnectionFragment
}
stagedTransfersByAccountId {
...StagedTransfersConnectionFragment
}
tradesByAtsId {
...TradesConnectionFragment
}
tradesByFromAccountId {
...TradesConnectionFragment
}
tradesByToAccountId {
...TradesConnectionFragment
}
transfersByAtsId {
...TransfersConnectionFragment
}
transfersByFromAccountId {
...TransfersConnectionFragment
}
transfersByToAccountId {
...TransfersConnectionFragment
}
contactName
holdings
taxShort
}
}
Variables
{
"type": "abc123",
"email": "abc123"
}
Response
{
"data": {
"accountByTypeAndEmail": {
"nodeId": "4",
"type": "abc123",
"company": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"name": "xyz789",
"jurisdiction": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"email": "xyz789",
"url": "abc123",
"slug": "xyz789",
"twitterHandle": "abc123",
"supportEmail": "abc123",
"newId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"setup": true,
"entity": false,
"oldId": 123,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"createdOn": Datetime,
"investorType": "xyz789",
"formationDate": "2007-12-03",
"externalEmail": "abc123",
"useReal": true,
"auxAccountByType": AuxAccount,
"companyByCompany": Company,
"countryByJurisdiction": Country,
"investorAccountTypeByInvestorType": InvestorAccountType,
"customersByVendorId": CustomersConnection,
"customersByInvestorId": CustomersConnection,
"usersAccountsByAccountId": UsersAccountsConnection,
"accountsBlockchainAddressesByAccountId": AccountsBlockchainAddressesConnection,
"blockchainRegistrationsByAccountId": BlockchainRegistrationsConnection,
"assetsByIssuerId": AssetsConnection,
"assetArchivesByAccountId": AssetArchivesConnection,
"allocationsByOwnerId": AllocationsConnection,
"allocationsByIssuerId": AllocationsConnection,
"allocationArchivesByAccountId": AllocationArchivesConnection,
"brokerAllocationsByBrokerId": BrokerAllocationsConnection,
"distributionsByInvestorId": DistributionsConnection,
"transactionsByBrokerId": TransactionsConnection,
"ledgersByInvestorId": LedgersConnection,
"distributionAnnotationsByAccountId": DistributionAnnotationsConnection,
"assetAnnotationsByAccountId": AssetAnnotationsConnection,
"allocationAnnotationsByAccountId": AllocationAnnotationsConnection,
"transactionAnnotationsByAccountId": TransactionAnnotationsConnection,
"managedAccountsByManagerId": ManagedAccountsConnection,
"managedAccountsByEntityId": ManagedAccountsConnection,
"accountIntegrationsByAccountId": AccountIntegrationsConnection,
"vendorQualificationsByAccountId": VendorQualificationsConnection,
"stepsByOwnedBy": StepsConnection,
"stepsByExecuteBy": StepsConnection,
"distributionCustomFieldsByCreatedBy": DistributionCustomFieldsConnection,
"signingAccountsByAccountId": SigningAccountsConnection,
"signingTemplatesByAccountId": SigningTemplatesConnection,
"mappedSigningTemplatesByAccountId": MappedSigningTemplatesConnection,
"sentSigningDocumentsBySentTo": SentSigningDocumentsConnection,
"allocationOfferingLinksByCreatedBy": AllocationOfferingLinksConnection,
"allocationOfferingLinksByAgentId": AllocationOfferingLinksConnection,
"accountPhoneNumbersByAccountId": AccountPhoneNumbersConnection,
"accountRegDStatusByAccountId": AccountRegDStatus,
"accountRegDStatusesByAccountId": AccountRegDStatusesConnection,
"accountTaxInformationsByAccountId": AccountTaxInformationsConnection,
"onboardingQuestionSetsByAccountId": OnboardingQuestionSetsConnection,
"onboardingQuestionsByAccountId": OnboardingQuestionsConnection,
"instancedAccountInformationsByAccountId": InstancedAccountInformationsConnection,
"instancedAccountInformationsByVendorAccountId": InstancedAccountInformationsConnection,
"instancedMappingFieldsByAccountId": InstancedMappingFieldsConnection,
"vendorDefaultEmailPreferenceByAccountId": VendorDefaultEmailPreference,
"vendorDefaultEmailPreferencesByAccountId": VendorDefaultEmailPreferencesConnection,
"allocationEmailPreferencesByAccountId": AllocationEmailPreferencesConnection,
"securitiesByIssuerId": SecuritiesConnection,
"securitiesByTaId": SecuritiesConnection,
"holdingsByInvestorId": HoldingsConnection,
"issuanceEventsByInvestorId": IssuanceEventsConnection,
"issuanceEventsByIssuerId": IssuanceEventsConnection,
"vendorAgentsByAgentId": VendorAgentsConnection,
"vendorAgentsByVendorId": VendorAgentsConnection,
"securityListingsByIssuerId": SecurityListingsConnection,
"securityListingsByAtsId": SecurityListingsConnection,
"documentsByUploadedBy": DocumentsConnection,
"accountDocumentsByFromAccountId": AccountDocumentsConnection,
"accountDocumentsByToAccountId": AccountDocumentsConnection,
"documentSharingsByUploaderId": DocumentSharingsConnection,
"accountRestrictionsByAccountId": AccountRestrictionsConnection,
"accountRestrictionsByCreatorAccountId": AccountRestrictionsConnection,
"paymentAccountsByAccountId": PaymentAccountsConnection,
"paymentMethodsByAccountId": PaymentMethodsConnection,
"paymentIssuersByIssuerId": PaymentIssuersConnection,
"paymentIssuersByAccountId": PaymentIssuersConnection,
"omnibusHoldingsByAccountId": OmnibusHoldingsConnection,
"omnibusInvestorsByInvestorId": OmnibusInvestorsConnection,
"omnibusInvestorsByAccountId": OmnibusInvestorsConnection,
"webhookConfigurationsByAccountId": WebhookConfigurationsConnection,
"customerPartiesByCreatorAccountId": CustomerPartiesConnection,
"customerAddressesByCreatorAccountId": CustomerAddressesConnection,
"customerPartyAddressesByCreatorAccountId": CustomerPartyAddressesConnection,
"blockchainAddressSourcesByVendorId": BlockchainAddressSourcesConnection,
"blockchainAddressSourcesByInvestorId": BlockchainAddressSourcesConnection,
"blockchainAddressSourcesByCreatorAccountId": BlockchainAddressSourcesConnection,
"taRequestsByVendorId": TaRequestsConnection,
"taRequestsByInvestorId": TaRequestsConnection,
"taRequestsByCreatorAccountId": TaRequestsConnection,
"accountAddressesByAccountId": AccountAddressesConnection,
"atsTagsByAccountId": AtsTagsConnection,
"idempotentsByAtsId": IdempotentsConnection,
"partiesByAccountId": PartiesConnection,
"partyAddressesByAccountId": PartyAddressesConnection,
"requestsByAccountId": RequestsConnection,
"stagedBalanceTransfersByToAccountId": StagedBalanceTransfersConnection,
"stagedBalanceTransfersByFromAccountId": StagedBalanceTransfersConnection,
"stagedTransfersByAccountId": StagedTransfersConnection,
"tradesByAtsId": TradesConnection,
"tradesByFromAccountId": TradesConnection,
"tradesByToAccountId": TradesConnection,
"transfersByAtsId": TransfersConnection,
"transfersByFromAccountId": TransfersConnection,
"transfersByToAccountId": TransfersConnection,
"contactName": "abc123",
"holdings": BigFloat,
"taxShort": "abc123"
}
}
}
accountDocument
Description
Reads a single AccountDocument using its globally unique ID.
Response
Returns an AccountDocument
Arguments
| Name | Description |
|---|---|
nodeId - ID!
|
The globally unique ID to be used in selecting a single AccountDocument. |
Example
Query
query accountDocument($nodeId: ID!) {
accountDocument(nodeId: $nodeId) {
nodeId
id
documentId
fromAccountId
toAccountId
createdOn
createdBy
documentByDocumentId {
...DocumentFragment
}
accountByFromAccountId {
...AccountFragment
}
accountByToAccountId {
...AccountFragment
}
userByCreatedBy {
...UserFragment
}
}
}
Variables
{"nodeId": 4}
Response
{
"data": {
"accountDocument": {
"nodeId": 4,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"documentId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"fromAccountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"toAccountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"createdOn": Datetime,
"createdBy": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"documentByDocumentId": Document,
"accountByFromAccountId": Account,
"accountByToAccountId": Account,
"userByCreatedBy": User
}
}
}
accountDocumentByDocumentIdAndToAccountId
Response
Returns an AccountDocument
Example
Query
query accountDocumentByDocumentIdAndToAccountId(
$documentId: UUID!,
$toAccountId: UUID!
) {
accountDocumentByDocumentIdAndToAccountId(
documentId: $documentId,
toAccountId: $toAccountId
) {
nodeId
id
documentId
fromAccountId
toAccountId
createdOn
createdBy
documentByDocumentId {
...DocumentFragment
}
accountByFromAccountId {
...AccountFragment
}
accountByToAccountId {
...AccountFragment
}
userByCreatedBy {
...UserFragment
}
}
}
Variables
{
"documentId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"toAccountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
Response
{
"data": {
"accountDocumentByDocumentIdAndToAccountId": {
"nodeId": "4",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"documentId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"fromAccountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"toAccountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"createdOn": Datetime,
"createdBy": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"documentByDocumentId": Document,
"accountByFromAccountId": Account,
"accountByToAccountId": Account,
"userByCreatedBy": User
}
}
}
accountDocumentById
Response
Returns an AccountDocument
Arguments
| Name | Description |
|---|---|
id - UUID!
|
Example
Query
query accountDocumentById($id: UUID!) {
accountDocumentById(id: $id) {
nodeId
id
documentId
fromAccountId
toAccountId
createdOn
createdBy
documentByDocumentId {
...DocumentFragment
}
accountByFromAccountId {
...AccountFragment
}
accountByToAccountId {
...AccountFragment
}
userByCreatedBy {
...UserFragment
}
}
}
Variables
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
Response
{
"data": {
"accountDocumentById": {
"nodeId": 4,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"documentId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"fromAccountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"toAccountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"createdOn": Datetime,
"createdBy": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"documentByDocumentId": Document,
"accountByFromAccountId": Account,
"accountByToAccountId": Account,
"userByCreatedBy": User
}
}
}
accountIntegration
Description
Reads a single AccountIntegration using its globally unique ID.
Response
Returns an AccountIntegration
Arguments
| Name | Description |
|---|---|
nodeId - ID!
|
The globally unique ID to be used in selecting a single AccountIntegration. |
Example
Query
query accountIntegration($nodeId: ID!) {
accountIntegration(nodeId: $nodeId) {
nodeId
id
integrationId
accountId
stepId
integrationByIntegrationId {
...IntegrationFragment
}
accountByAccountId {
...AccountFragment
}
stepByStepId {
...StepFragment
}
}
}
Variables
{"nodeId": "4"}
Response
{
"data": {
"accountIntegration": {
"nodeId": "4",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"integrationId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"stepId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"integrationByIntegrationId": Integration,
"accountByAccountId": Account,
"stepByStepId": Step
}
}
}
accountIntegrationById
Response
Returns an AccountIntegration
Arguments
| Name | Description |
|---|---|
id - UUID!
|
Example
Query
query accountIntegrationById($id: UUID!) {
accountIntegrationById(id: $id) {
nodeId
id
integrationId
accountId
stepId
integrationByIntegrationId {
...IntegrationFragment
}
accountByAccountId {
...AccountFragment
}
stepByStepId {
...StepFragment
}
}
}
Variables
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
Response
{
"data": {
"accountIntegrationById": {
"nodeId": 4,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"integrationId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"stepId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"integrationByIntegrationId": Integration,
"accountByAccountId": Account,
"stepByStepId": Step
}
}
}
accountIntegrationByIntegrationIdAndAccountId
Response
Returns an AccountIntegration
Example
Query
query accountIntegrationByIntegrationIdAndAccountId(
$integrationId: UUID!,
$accountId: UUID!
) {
accountIntegrationByIntegrationIdAndAccountId(
integrationId: $integrationId,
accountId: $accountId
) {
nodeId
id
integrationId
accountId
stepId
integrationByIntegrationId {
...IntegrationFragment
}
accountByAccountId {
...AccountFragment
}
stepByStepId {
...StepFragment
}
}
}
Variables
{
"integrationId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
Response
{
"data": {
"accountIntegrationByIntegrationIdAndAccountId": {
"nodeId": "4",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"integrationId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"stepId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"integrationByIntegrationId": Integration,
"accountByAccountId": Account,
"stepByStepId": Step
}
}
}
accountIntegrationByStepId
Response
Returns an AccountIntegration
Arguments
| Name | Description |
|---|---|
stepId - UUID!
|
Example
Query
query accountIntegrationByStepId($stepId: UUID!) {
accountIntegrationByStepId(stepId: $stepId) {
nodeId
id
integrationId
accountId
stepId
integrationByIntegrationId {
...IntegrationFragment
}
accountByAccountId {
...AccountFragment
}
stepByStepId {
...StepFragment
}
}
}
Variables
{
"stepId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
Response
{
"data": {
"accountIntegrationByStepId": {
"nodeId": "4",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"integrationId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"stepId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"integrationByIntegrationId": Integration,
"accountByAccountId": Account,
"stepByStepId": Step
}
}
}
accountPhoneNumber
Description
Reads a single AccountPhoneNumber using its globally unique ID.
Response
Returns an AccountPhoneNumber
Arguments
| Name | Description |
|---|---|
nodeId - ID!
|
The globally unique ID to be used in selecting a single AccountPhoneNumber. |
Example
Query
query accountPhoneNumber($nodeId: ID!) {
accountPhoneNumber(nodeId: $nodeId) {
nodeId
id
accountId
phoneNumber
type
accountByAccountId {
...AccountFragment
}
phoneNumberTypeByType {
...PhoneNumberTypeFragment
}
}
}
Variables
{"nodeId": 4}
Response
{
"data": {
"accountPhoneNumber": {
"nodeId": 4,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"phoneNumber": "xyz789",
"type": "abc123",
"accountByAccountId": Account,
"phoneNumberTypeByType": PhoneNumberType
}
}
}
accountPhoneNumberByAccountIdAndType
Response
Returns an AccountPhoneNumber
Example
Query
query accountPhoneNumberByAccountIdAndType(
$accountId: UUID!,
$type: String!
) {
accountPhoneNumberByAccountIdAndType(
accountId: $accountId,
type: $type
) {
nodeId
id
accountId
phoneNumber
type
accountByAccountId {
...AccountFragment
}
phoneNumberTypeByType {
...PhoneNumberTypeFragment
}
}
}
Variables
{
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"type": "xyz789"
}
Response
{
"data": {
"accountPhoneNumberByAccountIdAndType": {
"nodeId": "4",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"phoneNumber": "xyz789",
"type": "xyz789",
"accountByAccountId": Account,
"phoneNumberTypeByType": PhoneNumberType
}
}
}
accountPhoneNumberById
Response
Returns an AccountPhoneNumber
Arguments
| Name | Description |
|---|---|
id - UUID!
|
Example
Query
query accountPhoneNumberById($id: UUID!) {
accountPhoneNumberById(id: $id) {
nodeId
id
accountId
phoneNumber
type
accountByAccountId {
...AccountFragment
}
phoneNumberTypeByType {
...PhoneNumberTypeFragment
}
}
}
Variables
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
Response
{
"data": {
"accountPhoneNumberById": {
"nodeId": 4,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"phoneNumber": "abc123",
"type": "abc123",
"accountByAccountId": Account,
"phoneNumberTypeByType": PhoneNumberType
}
}
}
accountRegDStatus
Description
Reads a single AccountRegDStatus using its globally unique ID.
Response
Returns an AccountRegDStatus
Arguments
| Name | Description |
|---|---|
nodeId - ID!
|
The globally unique ID to be used in selecting a single AccountRegDStatus. |
Example
Query
query accountRegDStatus($nodeId: ID!) {
accountRegDStatus(nodeId: $nodeId) {
nodeId
id
accountId
usCitizen
usFileTax
usResidence
canRegD
accountByAccountId {
...AccountFragment
}
}
}
Variables
{"nodeId": "4"}
Response
{
"data": {
"accountRegDStatus": {
"nodeId": "4",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"usCitizen": false,
"usFileTax": true,
"usResidence": true,
"canRegD": true,
"accountByAccountId": Account
}
}
}
accountRegDStatusByAccountId
Response
Returns an AccountRegDStatus
Arguments
| Name | Description |
|---|---|
accountId - UUID!
|
Example
Query
query accountRegDStatusByAccountId($accountId: UUID!) {
accountRegDStatusByAccountId(accountId: $accountId) {
nodeId
id
accountId
usCitizen
usFileTax
usResidence
canRegD
accountByAccountId {
...AccountFragment
}
}
}
Variables
{
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
Response
{
"data": {
"accountRegDStatusByAccountId": {
"nodeId": "4",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"usCitizen": true,
"usFileTax": false,
"usResidence": false,
"canRegD": false,
"accountByAccountId": Account
}
}
}
accountRegDStatusById
Response
Returns an AccountRegDStatus
Arguments
| Name | Description |
|---|---|
id - UUID!
|
Example
Query
query accountRegDStatusById($id: UUID!) {
accountRegDStatusById(id: $id) {
nodeId
id
accountId
usCitizen
usFileTax
usResidence
canRegD
accountByAccountId {
...AccountFragment
}
}
}
Variables
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
Response
{
"data": {
"accountRegDStatusById": {
"nodeId": 4,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"usCitizen": true,
"usFileTax": true,
"usResidence": false,
"canRegD": false,
"accountByAccountId": Account
}
}
}
accountRestriction
Description
Reads a single AccountRestriction using its globally unique ID.
Response
Returns an AccountRestriction
Arguments
| Name | Description |
|---|---|
nodeId - ID!
|
The globally unique ID to be used in selecting a single AccountRestriction. |
Example
Query
query accountRestriction($nodeId: ID!) {
accountRestriction(nodeId: $nodeId) {
nodeId
id
accountId
reasonId
creatorUserId
creatorAccountId
createdOn
accountByAccountId {
...AccountFragment
}
restrictionReasonByReasonId {
...RestrictionReasonFragment
}
userByCreatorUserId {
...UserFragment
}
accountByCreatorAccountId {
...AccountFragment
}
}
}
Variables
{"nodeId": "4"}
Response
{
"data": {
"accountRestriction": {
"nodeId": "4",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"reasonId": 123,
"creatorUserId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"creatorAccountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"createdOn": Datetime,
"accountByAccountId": Account,
"restrictionReasonByReasonId": RestrictionReason,
"userByCreatorUserId": User,
"accountByCreatorAccountId": Account
}
}
}
accountRestrictionByAccountIdAndReasonId
Response
Returns an AccountRestriction
Example
Query
query accountRestrictionByAccountIdAndReasonId(
$accountId: UUID!,
$reasonId: Int!
) {
accountRestrictionByAccountIdAndReasonId(
accountId: $accountId,
reasonId: $reasonId
) {
nodeId
id
accountId
reasonId
creatorUserId
creatorAccountId
createdOn
accountByAccountId {
...AccountFragment
}
restrictionReasonByReasonId {
...RestrictionReasonFragment
}
userByCreatorUserId {
...UserFragment
}
accountByCreatorAccountId {
...AccountFragment
}
}
}
Variables
{
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"reasonId": 123
}
Response
{
"data": {
"accountRestrictionByAccountIdAndReasonId": {
"nodeId": "4",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"reasonId": 987,
"creatorUserId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"creatorAccountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"createdOn": Datetime,
"accountByAccountId": Account,
"restrictionReasonByReasonId": RestrictionReason,
"userByCreatorUserId": User,
"accountByCreatorAccountId": Account
}
}
}
accountRestrictionById
Response
Returns an AccountRestriction
Arguments
| Name | Description |
|---|---|
id - UUID!
|
Example
Query
query accountRestrictionById($id: UUID!) {
accountRestrictionById(id: $id) {
nodeId
id
accountId
reasonId
creatorUserId
creatorAccountId
createdOn
accountByAccountId {
...AccountFragment
}
restrictionReasonByReasonId {
...RestrictionReasonFragment
}
userByCreatorUserId {
...UserFragment
}
accountByCreatorAccountId {
...AccountFragment
}
}
}
Variables
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
Response
{
"data": {
"accountRestrictionById": {
"nodeId": 4,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"reasonId": 987,
"creatorUserId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"creatorAccountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"createdOn": Datetime,
"accountByAccountId": Account,
"restrictionReasonByReasonId": RestrictionReason,
"userByCreatorUserId": User,
"accountByCreatorAccountId": Account
}
}
}
accountTaxInformation
Description
Reads a single AccountTaxInformation using its globally unique ID.
Response
Returns an AccountTaxInformation
Arguments
| Name | Description |
|---|---|
nodeId - ID!
|
The globally unique ID to be used in selecting a single AccountTaxInformation. |
Example
Query
query accountTaxInformation($nodeId: ID!) {
accountTaxInformation(nodeId: $nodeId) {
nodeId
id
accountId
taxRegionId
lastFour
accountByAccountId {
...AccountFragment
}
taxRegionByTaxRegionId {
...TaxRegionFragment
}
}
}
Variables
{"nodeId": 4}
Response
{
"data": {
"accountTaxInformation": {
"nodeId": "4",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"taxRegionId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"lastFour": "abc123",
"accountByAccountId": Account,
"taxRegionByTaxRegionId": TaxRegion
}
}
}
accountTaxInformationById
Response
Returns an AccountTaxInformation
Arguments
| Name | Description |
|---|---|
id - UUID!
|
Example
Query
query accountTaxInformationById($id: UUID!) {
accountTaxInformationById(id: $id) {
nodeId
id
accountId
taxRegionId
lastFour
accountByAccountId {
...AccountFragment
}
taxRegionByTaxRegionId {
...TaxRegionFragment
}
}
}
Variables
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
Response
{
"data": {
"accountTaxInformationById": {
"nodeId": 4,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"taxRegionId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"lastFour": "xyz789",
"accountByAccountId": Account,
"taxRegionByTaxRegionId": TaxRegion
}
}
}
accountingType
Description
Reads a single AccountingType using its globally unique ID.
Response
Returns an AccountingType
Arguments
| Name | Description |
|---|---|
nodeId - ID!
|
The globally unique ID to be used in selecting a single AccountingType. |
Example
Query
query accountingType($nodeId: ID!) {
accountingType(nodeId: $nodeId) {
nodeId
type
assetTypesByAccountingType {
...AssetTypesConnectionFragment
}
ledgersByType {
...LedgersConnectionFragment
}
}
}
Variables
{"nodeId": "4"}
Response
{
"data": {
"accountingType": {
"nodeId": 4,
"type": "xyz789",
"assetTypesByAccountingType": AssetTypesConnection,
"ledgersByType": LedgersConnection
}
}
}
accountingTypeByType
Response
Returns an AccountingType
Arguments
| Name | Description |
|---|---|
type - String!
|
Example
Query
query accountingTypeByType($type: String!) {
accountingTypeByType(type: $type) {
nodeId
type
assetTypesByAccountingType {
...AssetTypesConnectionFragment
}
ledgersByType {
...LedgersConnectionFragment
}
}
}
Variables
{"type": "abc123"}
Response
{
"data": {
"accountingTypeByType": {
"nodeId": 4,
"type": "xyz789",
"assetTypesByAccountingType": AssetTypesConnection,
"ledgersByType": LedgersConnection
}
}
}
accountsBlockchainAddress
Description
Reads a single AccountsBlockchainAddress using its globally unique ID.
Response
Returns an AccountsBlockchainAddress
Arguments
| Name | Description |
|---|---|
nodeId - ID!
|
The globally unique ID to be used in selecting a single AccountsBlockchainAddress. |
Example
Query
query accountsBlockchainAddress($nodeId: ID!) {
accountsBlockchainAddress(nodeId: $nodeId) {
nodeId
accountId
blockchainAddressId
blockchainAddressGroupId
name
id
accountByAccountId {
...AccountFragment
}
blockchainAddressByBlockchainAddressId {
...BlockchainAddressFragment
}
blockchainAddressGroupByBlockchainAddressGroupId {
...BlockchainAddressGroupFragment
}
}
}
Variables
{"nodeId": 4}
Response
{
"data": {
"accountsBlockchainAddress": {
"nodeId": 4,
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"blockchainAddressId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"blockchainAddressGroupId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"name": "xyz789",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountByAccountId": Account,
"blockchainAddressByBlockchainAddressId": BlockchainAddress,
"blockchainAddressGroupByBlockchainAddressGroupId": BlockchainAddressGroup
}
}
}
accountsBlockchainAddressByAccountIdAndBlockchainAddressId
Response
Returns an AccountsBlockchainAddress
Example
Query
query accountsBlockchainAddressByAccountIdAndBlockchainAddressId(
$accountId: UUID!,
$blockchainAddressId: UUID!
) {
accountsBlockchainAddressByAccountIdAndBlockchainAddressId(
accountId: $accountId,
blockchainAddressId: $blockchainAddressId
) {
nodeId
accountId
blockchainAddressId
blockchainAddressGroupId
name
id
accountByAccountId {
...AccountFragment
}
blockchainAddressByBlockchainAddressId {
...BlockchainAddressFragment
}
blockchainAddressGroupByBlockchainAddressGroupId {
...BlockchainAddressGroupFragment
}
}
}
Variables
{
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"blockchainAddressId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
Response
{
"data": {
"accountsBlockchainAddressByAccountIdAndBlockchainAddressId": {
"nodeId": 4,
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"blockchainAddressId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"blockchainAddressGroupId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"name": "xyz789",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountByAccountId": Account,
"blockchainAddressByBlockchainAddressId": BlockchainAddress,
"blockchainAddressGroupByBlockchainAddressGroupId": BlockchainAddressGroup
}
}
}
accountsBlockchainAddressById
Response
Returns an AccountsBlockchainAddress
Arguments
| Name | Description |
|---|---|
id - UUID!
|
Example
Query
query accountsBlockchainAddressById($id: UUID!) {
accountsBlockchainAddressById(id: $id) {
nodeId
accountId
blockchainAddressId
blockchainAddressGroupId
name
id
accountByAccountId {
...AccountFragment
}
blockchainAddressByBlockchainAddressId {
...BlockchainAddressFragment
}
blockchainAddressGroupByBlockchainAddressGroupId {
...BlockchainAddressGroupFragment
}
}
}
Variables
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
Response
{
"data": {
"accountsBlockchainAddressById": {
"nodeId": 4,
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"blockchainAddressId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"blockchainAddressGroupId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"name": "abc123",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountByAccountId": Account,
"blockchainAddressByBlockchainAddressId": BlockchainAddress,
"blockchainAddressGroupByBlockchainAddressGroupId": BlockchainAddressGroup
}
}
}
address
Description
Reads a single Address using its globally unique ID.
Response
Returns an Address
Arguments
| Name | Description |
|---|---|
nodeId - ID!
|
The globally unique ID to be used in selecting a single Address. |
Example
Query
query address($nodeId: ID!) {
address(nodeId: $nodeId) {
nodeId
country
lineOne
lineTwo
lineThree
lineFour
city
postalCode
province
other
id
countryByCountry {
...CountryFragment
}
customerAddressByAddressId {
...CustomerAddressFragment
}
customerAddressesByAddressId {
...CustomerAddressesConnectionFragment
}
customerPartyAddressByAddressId {
...CustomerPartyAddressFragment
}
customerPartyAddressesByAddressId {
...CustomerPartyAddressesConnectionFragment
}
accountAddressesByAddressId {
...AccountAddressesConnectionFragment
}
partyAddressesByAddressId {
...PartyAddressesConnectionFragment
}
}
}
Variables
{"nodeId": "4"}
Response
{
"data": {
"address": {
"nodeId": 4,
"country": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"lineOne": "xyz789",
"lineTwo": "xyz789",
"lineThree": "xyz789",
"lineFour": "xyz789",
"city": "abc123",
"postalCode": "abc123",
"province": "xyz789",
"other": "abc123",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"countryByCountry": Country,
"customerAddressByAddressId": CustomerAddress,
"customerAddressesByAddressId": CustomerAddressesConnection,
"customerPartyAddressByAddressId": CustomerPartyAddress,
"customerPartyAddressesByAddressId": CustomerPartyAddressesConnection,
"accountAddressesByAddressId": AccountAddressesConnection,
"partyAddressesByAddressId": PartyAddressesConnection
}
}
}
addressById
Example
Query
query addressById($id: UUID!) {
addressById(id: $id) {
nodeId
country
lineOne
lineTwo
lineThree
lineFour
city
postalCode
province
other
id
countryByCountry {
...CountryFragment
}
customerAddressByAddressId {
...CustomerAddressFragment
}
customerAddressesByAddressId {
...CustomerAddressesConnectionFragment
}
customerPartyAddressByAddressId {
...CustomerPartyAddressFragment
}
customerPartyAddressesByAddressId {
...CustomerPartyAddressesConnectionFragment
}
accountAddressesByAddressId {
...AccountAddressesConnectionFragment
}
partyAddressesByAddressId {
...PartyAddressesConnectionFragment
}
}
}
Variables
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
Response
{
"data": {
"addressById": {
"nodeId": "4",
"country": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"lineOne": "xyz789",
"lineTwo": "xyz789",
"lineThree": "xyz789",
"lineFour": "abc123",
"city": "abc123",
"postalCode": "xyz789",
"province": "xyz789",
"other": "abc123",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"countryByCountry": Country,
"customerAddressByAddressId": CustomerAddress,
"customerAddressesByAddressId": CustomerAddressesConnection,
"customerPartyAddressByAddressId": CustomerPartyAddress,
"customerPartyAddressesByAddressId": CustomerPartyAddressesConnection,
"accountAddressesByAddressId": AccountAddressesConnection,
"partyAddressesByAddressId": PartyAddressesConnection
}
}
}
addressType
Description
Reads a single AddressType using its globally unique ID.
Response
Returns an AddressType
Arguments
| Name | Description |
|---|---|
nodeId - ID!
|
The globally unique ID to be used in selecting a single AddressType. |
Example
Query
query addressType($nodeId: ID!) {
addressType(nodeId: $nodeId) {
nodeId
type
customerAddressesByType {
...CustomerAddressesConnectionFragment
}
customerPartyAddressesByType {
...CustomerPartyAddressesConnectionFragment
}
accountAddressesByType {
...AccountAddressesConnectionFragment
}
partyAddressesByType {
...PartyAddressesConnectionFragment
}
}
}
Variables
{"nodeId": "4"}
Response
{
"data": {
"addressType": {
"nodeId": 4,
"type": "xyz789",
"customerAddressesByType": CustomerAddressesConnection,
"customerPartyAddressesByType": CustomerPartyAddressesConnection,
"accountAddressesByType": AccountAddressesConnection,
"partyAddressesByType": PartyAddressesConnection
}
}
}
addressTypeByType
Response
Returns an AddressType
Arguments
| Name | Description |
|---|---|
type - String!
|
Example
Query
query addressTypeByType($type: String!) {
addressTypeByType(type: $type) {
nodeId
type
customerAddressesByType {
...CustomerAddressesConnectionFragment
}
customerPartyAddressesByType {
...CustomerPartyAddressesConnectionFragment
}
accountAddressesByType {
...AccountAddressesConnectionFragment
}
partyAddressesByType {
...PartyAddressesConnectionFragment
}
}
}
Variables
{"type": "xyz789"}
Response
{
"data": {
"addressTypeByType": {
"nodeId": 4,
"type": "xyz789",
"customerAddressesByType": CustomerAddressesConnection,
"customerPartyAddressesByType": CustomerPartyAddressesConnection,
"accountAddressesByType": AccountAddressesConnection,
"partyAddressesByType": PartyAddressesConnection
}
}
}
allAccountAddresses
Description
Reads and enables pagination through a set of AccountAddress.
Response
Returns an AccountAddressesConnection
Arguments
| Name | Description |
|---|---|
first - Int
|
Only read the first n values of the set. |
last - Int
|
Only read the last n values of the set. |
offset - Int
|
Skip the first n values from our after cursor, an alternative to cursor based pagination. May not be used with last. |
before - Cursor
|
Read all values in the set before (above) this cursor. |
after - Cursor
|
Read all values in the set after (below) this cursor. |
orderBy - [AccountAddressesOrderBy!]
|
The method to use when ordering AccountAddress. Default = [NATURAL] |
condition - AccountAddressCondition
|
A condition to be used in determining which values should be returned by the collection. |
filter - AccountAddressFilter
|
A filter to be used in determining which values should be returned by the collection. |
Example
Query
query allAccountAddresses(
$first: Int,
$last: Int,
$offset: Int,
$before: Cursor,
$after: Cursor,
$orderBy: [AccountAddressesOrderBy!],
$condition: AccountAddressCondition,
$filter: AccountAddressFilter
) {
allAccountAddresses(
first: $first,
last: $last,
offset: $offset,
before: $before,
after: $after,
orderBy: $orderBy,
condition: $condition,
filter: $filter
) {
nodes {
...AccountAddressFragment
}
edges {
...AccountAddressesEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"first": 123,
"last": 123,
"offset": 123,
"before": Cursor,
"after": Cursor,
"orderBy": ["NATURAL"],
"condition": AccountAddressCondition,
"filter": AccountAddressFilter
}
Response
{
"data": {
"allAccountAddresses": {
"nodes": [AccountAddress],
"edges": [AccountAddressesEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
}
}
allAccountDocuments
Description
Reads and enables pagination through a set of AccountDocument.
Response
Returns an AccountDocumentsConnection
Arguments
| Name | Description |
|---|---|
first - Int
|
Only read the first n values of the set. |
last - Int
|
Only read the last n values of the set. |
offset - Int
|
Skip the first n values from our after cursor, an alternative to cursor based pagination. May not be used with last. |
before - Cursor
|
Read all values in the set before (above) this cursor. |
after - Cursor
|
Read all values in the set after (below) this cursor. |
orderBy - [AccountDocumentsOrderBy!]
|
The method to use when ordering AccountDocument. Default = [PRIMARY_KEY_ASC] |
condition - AccountDocumentCondition
|
A condition to be used in determining which values should be returned by the collection. |
filter - AccountDocumentFilter
|
A filter to be used in determining which values should be returned by the collection. |
Example
Query
query allAccountDocuments(
$first: Int,
$last: Int,
$offset: Int,
$before: Cursor,
$after: Cursor,
$orderBy: [AccountDocumentsOrderBy!],
$condition: AccountDocumentCondition,
$filter: AccountDocumentFilter
) {
allAccountDocuments(
first: $first,
last: $last,
offset: $offset,
before: $before,
after: $after,
orderBy: $orderBy,
condition: $condition,
filter: $filter
) {
nodes {
...AccountDocumentFragment
}
edges {
...AccountDocumentsEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"first": 987,
"last": 987,
"offset": 987,
"before": Cursor,
"after": Cursor,
"orderBy": ["PRIMARY_KEY_ASC"],
"condition": AccountDocumentCondition,
"filter": AccountDocumentFilter
}
Response
{
"data": {
"allAccountDocuments": {
"nodes": [AccountDocument],
"edges": [AccountDocumentsEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
}
}
allAccountIntegrations
Description
Reads and enables pagination through a set of AccountIntegration.
Response
Returns an AccountIntegrationsConnection
Arguments
| Name | Description |
|---|---|
first - Int
|
Only read the first n values of the set. |
last - Int
|
Only read the last n values of the set. |
offset - Int
|
Skip the first n values from our after cursor, an alternative to cursor based pagination. May not be used with last. |
before - Cursor
|
Read all values in the set before (above) this cursor. |
after - Cursor
|
Read all values in the set after (below) this cursor. |
orderBy - [AccountIntegrationsOrderBy!]
|
The method to use when ordering AccountIntegration. Default = [PRIMARY_KEY_ASC] |
condition - AccountIntegrationCondition
|
A condition to be used in determining which values should be returned by the collection. |
filter - AccountIntegrationFilter
|
A filter to be used in determining which values should be returned by the collection. |
Example
Query
query allAccountIntegrations(
$first: Int,
$last: Int,
$offset: Int,
$before: Cursor,
$after: Cursor,
$orderBy: [AccountIntegrationsOrderBy!],
$condition: AccountIntegrationCondition,
$filter: AccountIntegrationFilter
) {
allAccountIntegrations(
first: $first,
last: $last,
offset: $offset,
before: $before,
after: $after,
orderBy: $orderBy,
condition: $condition,
filter: $filter
) {
nodes {
...AccountIntegrationFragment
}
edges {
...AccountIntegrationsEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"first": 123,
"last": 123,
"offset": 987,
"before": Cursor,
"after": Cursor,
"orderBy": ["PRIMARY_KEY_ASC"],
"condition": AccountIntegrationCondition,
"filter": AccountIntegrationFilter
}
Response
{
"data": {
"allAccountIntegrations": {
"nodes": [AccountIntegration],
"edges": [AccountIntegrationsEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
}
}
allAccountPhoneNumbers
Description
Reads and enables pagination through a set of AccountPhoneNumber.
Response
Returns an AccountPhoneNumbersConnection
Arguments
| Name | Description |
|---|---|
first - Int
|
Only read the first n values of the set. |
last - Int
|
Only read the last n values of the set. |
offset - Int
|
Skip the first n values from our after cursor, an alternative to cursor based pagination. May not be used with last. |
before - Cursor
|
Read all values in the set before (above) this cursor. |
after - Cursor
|
Read all values in the set after (below) this cursor. |
orderBy - [AccountPhoneNumbersOrderBy!]
|
The method to use when ordering AccountPhoneNumber. Default = [PRIMARY_KEY_ASC] |
condition - AccountPhoneNumberCondition
|
A condition to be used in determining which values should be returned by the collection. |
filter - AccountPhoneNumberFilter
|
A filter to be used in determining which values should be returned by the collection. |
Example
Query
query allAccountPhoneNumbers(
$first: Int,
$last: Int,
$offset: Int,
$before: Cursor,
$after: Cursor,
$orderBy: [AccountPhoneNumbersOrderBy!],
$condition: AccountPhoneNumberCondition,
$filter: AccountPhoneNumberFilter
) {
allAccountPhoneNumbers(
first: $first,
last: $last,
offset: $offset,
before: $before,
after: $after,
orderBy: $orderBy,
condition: $condition,
filter: $filter
) {
nodes {
...AccountPhoneNumberFragment
}
edges {
...AccountPhoneNumbersEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"first": 123,
"last": 123,
"offset": 987,
"before": Cursor,
"after": Cursor,
"orderBy": ["PRIMARY_KEY_ASC"],
"condition": AccountPhoneNumberCondition,
"filter": AccountPhoneNumberFilter
}
Response
{
"data": {
"allAccountPhoneNumbers": {
"nodes": [AccountPhoneNumber],
"edges": [AccountPhoneNumbersEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
}
}
allAccountRegDStatuses
Description
Reads and enables pagination through a set of AccountRegDStatus.
Response
Returns an AccountRegDStatusesConnection
Arguments
| Name | Description |
|---|---|
first - Int
|
Only read the first n values of the set. |
last - Int
|
Only read the last n values of the set. |
offset - Int
|
Skip the first n values from our after cursor, an alternative to cursor based pagination. May not be used with last. |
before - Cursor
|
Read all values in the set before (above) this cursor. |
after - Cursor
|
Read all values in the set after (below) this cursor. |
orderBy - [AccountRegDStatusesOrderBy!]
|
The method to use when ordering AccountRegDStatus. Default = [PRIMARY_KEY_ASC] |
condition - AccountRegDStatusCondition
|
A condition to be used in determining which values should be returned by the collection. |
filter - AccountRegDStatusFilter
|
A filter to be used in determining which values should be returned by the collection. |
Example
Query
query allAccountRegDStatuses(
$first: Int,
$last: Int,
$offset: Int,
$before: Cursor,
$after: Cursor,
$orderBy: [AccountRegDStatusesOrderBy!],
$condition: AccountRegDStatusCondition,
$filter: AccountRegDStatusFilter
) {
allAccountRegDStatuses(
first: $first,
last: $last,
offset: $offset,
before: $before,
after: $after,
orderBy: $orderBy,
condition: $condition,
filter: $filter
) {
nodes {
...AccountRegDStatusFragment
}
edges {
...AccountRegDStatusesEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"first": 987,
"last": 123,
"offset": 987,
"before": Cursor,
"after": Cursor,
"orderBy": ["PRIMARY_KEY_ASC"],
"condition": AccountRegDStatusCondition,
"filter": AccountRegDStatusFilter
}
Response
{
"data": {
"allAccountRegDStatuses": {
"nodes": [AccountRegDStatus],
"edges": [AccountRegDStatusesEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
}
}
allAccountRestrictions
Description
Reads and enables pagination through a set of AccountRestriction.
Response
Returns an AccountRestrictionsConnection
Arguments
| Name | Description |
|---|---|
first - Int
|
Only read the first n values of the set. |
last - Int
|
Only read the last n values of the set. |
offset - Int
|
Skip the first n values from our after cursor, an alternative to cursor based pagination. May not be used with last. |
before - Cursor
|
Read all values in the set before (above) this cursor. |
after - Cursor
|
Read all values in the set after (below) this cursor. |
orderBy - [AccountRestrictionsOrderBy!]
|
The method to use when ordering AccountRestriction. Default = [PRIMARY_KEY_ASC] |
condition - AccountRestrictionCondition
|
A condition to be used in determining which values should be returned by the collection. |
filter - AccountRestrictionFilter
|
A filter to be used in determining which values should be returned by the collection. |
Example
Query
query allAccountRestrictions(
$first: Int,
$last: Int,
$offset: Int,
$before: Cursor,
$after: Cursor,
$orderBy: [AccountRestrictionsOrderBy!],
$condition: AccountRestrictionCondition,
$filter: AccountRestrictionFilter
) {
allAccountRestrictions(
first: $first,
last: $last,
offset: $offset,
before: $before,
after: $after,
orderBy: $orderBy,
condition: $condition,
filter: $filter
) {
nodes {
...AccountRestrictionFragment
}
edges {
...AccountRestrictionsEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"first": 987,
"last": 123,
"offset": 987,
"before": Cursor,
"after": Cursor,
"orderBy": ["PRIMARY_KEY_ASC"],
"condition": AccountRestrictionCondition,
"filter": AccountRestrictionFilter
}
Response
{
"data": {
"allAccountRestrictions": {
"nodes": [AccountRestriction],
"edges": [AccountRestrictionsEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
}
}
allAccountTaxInformations
Description
Reads and enables pagination through a set of AccountTaxInformation.
Response
Returns an AccountTaxInformationsConnection
Arguments
| Name | Description |
|---|---|
first - Int
|
Only read the first n values of the set. |
last - Int
|
Only read the last n values of the set. |
offset - Int
|
Skip the first n values from our after cursor, an alternative to cursor based pagination. May not be used with last. |
before - Cursor
|
Read all values in the set before (above) this cursor. |
after - Cursor
|
Read all values in the set after (below) this cursor. |
orderBy - [AccountTaxInformationsOrderBy!]
|
The method to use when ordering AccountTaxInformation. Default = [PRIMARY_KEY_ASC] |
condition - AccountTaxInformationCondition
|
A condition to be used in determining which values should be returned by the collection. |
filter - AccountTaxInformationFilter
|
A filter to be used in determining which values should be returned by the collection. |
Example
Query
query allAccountTaxInformations(
$first: Int,
$last: Int,
$offset: Int,
$before: Cursor,
$after: Cursor,
$orderBy: [AccountTaxInformationsOrderBy!],
$condition: AccountTaxInformationCondition,
$filter: AccountTaxInformationFilter
) {
allAccountTaxInformations(
first: $first,
last: $last,
offset: $offset,
before: $before,
after: $after,
orderBy: $orderBy,
condition: $condition,
filter: $filter
) {
nodes {
...AccountTaxInformationFragment
}
edges {
...AccountTaxInformationsEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"first": 123,
"last": 987,
"offset": 987,
"before": Cursor,
"after": Cursor,
"orderBy": ["PRIMARY_KEY_ASC"],
"condition": AccountTaxInformationCondition,
"filter": AccountTaxInformationFilter
}
Response
{
"data": {
"allAccountTaxInformations": {
"nodes": [AccountTaxInformation],
"edges": [AccountTaxInformationsEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
}
}
allAccountingTypes
Description
Reads and enables pagination through a set of AccountingType.
Response
Returns an AccountingTypesConnection
Arguments
| Name | Description |
|---|---|
first - Int
|
Only read the first n values of the set. |
last - Int
|
Only read the last n values of the set. |
offset - Int
|
Skip the first n values from our after cursor, an alternative to cursor based pagination. May not be used with last. |
before - Cursor
|
Read all values in the set before (above) this cursor. |
after - Cursor
|
Read all values in the set after (below) this cursor. |
orderBy - [AccountingTypesOrderBy!]
|
The method to use when ordering AccountingType. Default = [PRIMARY_KEY_ASC] |
condition - AccountingTypeCondition
|
A condition to be used in determining which values should be returned by the collection. |
filter - AccountingTypeFilter
|
A filter to be used in determining which values should be returned by the collection. |
Example
Query
query allAccountingTypes(
$first: Int,
$last: Int,
$offset: Int,
$before: Cursor,
$after: Cursor,
$orderBy: [AccountingTypesOrderBy!],
$condition: AccountingTypeCondition,
$filter: AccountingTypeFilter
) {
allAccountingTypes(
first: $first,
last: $last,
offset: $offset,
before: $before,
after: $after,
orderBy: $orderBy,
condition: $condition,
filter: $filter
) {
nodes {
...AccountingTypeFragment
}
edges {
...AccountingTypesEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"first": 987,
"last": 123,
"offset": 987,
"before": Cursor,
"after": Cursor,
"orderBy": ["PRIMARY_KEY_ASC"],
"condition": AccountingTypeCondition,
"filter": AccountingTypeFilter
}
Response
{
"data": {
"allAccountingTypes": {
"nodes": [AccountingType],
"edges": [AccountingTypesEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
}
}
allAccounts
Description
Reads and enables pagination through a set of Account.
Response
Returns an AccountsConnection
Arguments
| Name | Description |
|---|---|
first - Int
|
Only read the first n values of the set. |
last - Int
|
Only read the last n values of the set. |
offset - Int
|
Skip the first n values from our after cursor, an alternative to cursor based pagination. May not be used with last. |
before - Cursor
|
Read all values in the set before (above) this cursor. |
after - Cursor
|
Read all values in the set after (below) this cursor. |
orderBy - [AccountsOrderBy!]
|
The method to use when ordering Account. Default = [PRIMARY_KEY_ASC] |
condition - AccountCondition
|
A condition to be used in determining which values should be returned by the collection. |
filter - AccountFilter
|
A filter to be used in determining which values should be returned by the collection. |
Example
Query
query allAccounts(
$first: Int,
$last: Int,
$offset: Int,
$before: Cursor,
$after: Cursor,
$orderBy: [AccountsOrderBy!],
$condition: AccountCondition,
$filter: AccountFilter
) {
allAccounts(
first: $first,
last: $last,
offset: $offset,
before: $before,
after: $after,
orderBy: $orderBy,
condition: $condition,
filter: $filter
) {
nodes {
...AccountFragment
}
edges {
...AccountsEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"first": 123,
"last": 987,
"offset": 987,
"before": Cursor,
"after": Cursor,
"orderBy": ["PRIMARY_KEY_ASC"],
"condition": AccountCondition,
"filter": AccountFilter
}
Response
{
"data": {
"allAccounts": {
"nodes": [Account],
"edges": [AccountsEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
}
}
allAccountsBlockchainAddresses
Description
Reads and enables pagination through a set of AccountsBlockchainAddress.
Response
Returns an AccountsBlockchainAddressesConnection
Arguments
| Name | Description |
|---|---|
first - Int
|
Only read the first n values of the set. |
last - Int
|
Only read the last n values of the set. |
offset - Int
|
Skip the first n values from our after cursor, an alternative to cursor based pagination. May not be used with last. |
before - Cursor
|
Read all values in the set before (above) this cursor. |
after - Cursor
|
Read all values in the set after (below) this cursor. |
orderBy - [AccountsBlockchainAddressesOrderBy!]
|
The method to use when ordering AccountsBlockchainAddress. Default = [PRIMARY_KEY_ASC] |
condition - AccountsBlockchainAddressCondition
|
A condition to be used in determining which values should be returned by the collection. |
filter - AccountsBlockchainAddressFilter
|
A filter to be used in determining which values should be returned by the collection. |
Example
Query
query allAccountsBlockchainAddresses(
$first: Int,
$last: Int,
$offset: Int,
$before: Cursor,
$after: Cursor,
$orderBy: [AccountsBlockchainAddressesOrderBy!],
$condition: AccountsBlockchainAddressCondition,
$filter: AccountsBlockchainAddressFilter
) {
allAccountsBlockchainAddresses(
first: $first,
last: $last,
offset: $offset,
before: $before,
after: $after,
orderBy: $orderBy,
condition: $condition,
filter: $filter
) {
nodes {
...AccountsBlockchainAddressFragment
}
edges {
...AccountsBlockchainAddressesEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"first": 123,
"last": 987,
"offset": 987,
"before": Cursor,
"after": Cursor,
"orderBy": ["PRIMARY_KEY_ASC"],
"condition": AccountsBlockchainAddressCondition,
"filter": AccountsBlockchainAddressFilter
}
Response
{
"data": {
"allAccountsBlockchainAddresses": {
"nodes": [AccountsBlockchainAddress],
"edges": [AccountsBlockchainAddressesEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
}
}
allActiveUsers
Description
Reads and enables pagination through a set of ActiveUser.
Response
Returns an ActiveUsersConnection
Arguments
| Name | Description |
|---|---|
first - Int
|
Only read the first n values of the set. |
last - Int
|
Only read the last n values of the set. |
offset - Int
|
Skip the first n values from our after cursor, an alternative to cursor based pagination. May not be used with last. |
before - Cursor
|
Read all values in the set before (above) this cursor. |
after - Cursor
|
Read all values in the set after (below) this cursor. |
orderBy - [ActiveUsersOrderBy!]
|
The method to use when ordering ActiveUser. Default = [NATURAL] |
condition - ActiveUserCondition
|
A condition to be used in determining which values should be returned by the collection. |
filter - ActiveUserFilter
|
A filter to be used in determining which values should be returned by the collection. |
Example
Query
query allActiveUsers(
$first: Int,
$last: Int,
$offset: Int,
$before: Cursor,
$after: Cursor,
$orderBy: [ActiveUsersOrderBy!],
$condition: ActiveUserCondition,
$filter: ActiveUserFilter
) {
allActiveUsers(
first: $first,
last: $last,
offset: $offset,
before: $before,
after: $after,
orderBy: $orderBy,
condition: $condition,
filter: $filter
) {
nodes {
...ActiveUserFragment
}
edges {
...ActiveUsersEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"first": 987,
"last": 987,
"offset": 123,
"before": Cursor,
"after": Cursor,
"orderBy": ["NATURAL"],
"condition": ActiveUserCondition,
"filter": ActiveUserFilter
}
Response
{
"data": {
"allActiveUsers": {
"nodes": [ActiveUser],
"edges": [ActiveUsersEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
}
}
allAddressTypes
Description
Reads and enables pagination through a set of AddressType.
Response
Returns an AddressTypesConnection
Arguments
| Name | Description |
|---|---|
first - Int
|
Only read the first n values of the set. |
last - Int
|
Only read the last n values of the set. |
offset - Int
|
Skip the first n values from our after cursor, an alternative to cursor based pagination. May not be used with last. |
before - Cursor
|
Read all values in the set before (above) this cursor. |
after - Cursor
|
Read all values in the set after (below) this cursor. |
orderBy - [AddressTypesOrderBy!]
|
The method to use when ordering AddressType. Default = [PRIMARY_KEY_ASC] |
condition - AddressTypeCondition
|
A condition to be used in determining which values should be returned by the collection. |
filter - AddressTypeFilter
|
A filter to be used in determining which values should be returned by the collection. |
Example
Query
query allAddressTypes(
$first: Int,
$last: Int,
$offset: Int,
$before: Cursor,
$after: Cursor,
$orderBy: [AddressTypesOrderBy!],
$condition: AddressTypeCondition,
$filter: AddressTypeFilter
) {
allAddressTypes(
first: $first,
last: $last,
offset: $offset,
before: $before,
after: $after,
orderBy: $orderBy,
condition: $condition,
filter: $filter
) {
nodes {
...AddressTypeFragment
}
edges {
...AddressTypesEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"first": 123,
"last": 987,
"offset": 123,
"before": Cursor,
"after": Cursor,
"orderBy": ["PRIMARY_KEY_ASC"],
"condition": AddressTypeCondition,
"filter": AddressTypeFilter
}
Response
{
"data": {
"allAddressTypes": {
"nodes": [AddressType],
"edges": [AddressTypesEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
}
}
allAddresses
Description
Reads and enables pagination through a set of Address.
Response
Returns an AddressesConnection
Arguments
| Name | Description |
|---|---|
first - Int
|
Only read the first n values of the set. |
last - Int
|
Only read the last n values of the set. |
offset - Int
|
Skip the first n values from our after cursor, an alternative to cursor based pagination. May not be used with last. |
before - Cursor
|
Read all values in the set before (above) this cursor. |
after - Cursor
|
Read all values in the set after (below) this cursor. |
orderBy - [AddressesOrderBy!]
|
The method to use when ordering Address. Default = [PRIMARY_KEY_ASC] |
condition - AddressCondition
|
A condition to be used in determining which values should be returned by the collection. |
filter - AddressFilter
|
A filter to be used in determining which values should be returned by the collection. |
Example
Query
query allAddresses(
$first: Int,
$last: Int,
$offset: Int,
$before: Cursor,
$after: Cursor,
$orderBy: [AddressesOrderBy!],
$condition: AddressCondition,
$filter: AddressFilter
) {
allAddresses(
first: $first,
last: $last,
offset: $offset,
before: $before,
after: $after,
orderBy: $orderBy,
condition: $condition,
filter: $filter
) {
nodes {
...AddressFragment
}
edges {
...AddressesEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"first": 987,
"last": 123,
"offset": 987,
"before": Cursor,
"after": Cursor,
"orderBy": ["PRIMARY_KEY_ASC"],
"condition": AddressCondition,
"filter": AddressFilter
}
Response
{
"data": {
"allAddresses": {
"nodes": [Address],
"edges": [AddressesEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
}
}
allAllocationAnnotations
Description
Reads and enables pagination through a set of AllocationAnnotation.
Response
Returns an AllocationAnnotationsConnection
Arguments
| Name | Description |
|---|---|
first - Int
|
Only read the first n values of the set. |
last - Int
|
Only read the last n values of the set. |
offset - Int
|
Skip the first n values from our after cursor, an alternative to cursor based pagination. May not be used with last. |
before - Cursor
|
Read all values in the set before (above) this cursor. |
after - Cursor
|
Read all values in the set after (below) this cursor. |
orderBy - [AllocationAnnotationsOrderBy!]
|
The method to use when ordering AllocationAnnotation. Default = [PRIMARY_KEY_ASC] |
condition - AllocationAnnotationCondition
|
A condition to be used in determining which values should be returned by the collection. |
filter - AllocationAnnotationFilter
|
A filter to be used in determining which values should be returned by the collection. |
Example
Query
query allAllocationAnnotations(
$first: Int,
$last: Int,
$offset: Int,
$before: Cursor,
$after: Cursor,
$orderBy: [AllocationAnnotationsOrderBy!],
$condition: AllocationAnnotationCondition,
$filter: AllocationAnnotationFilter
) {
allAllocationAnnotations(
first: $first,
last: $last,
offset: $offset,
before: $before,
after: $after,
orderBy: $orderBy,
condition: $condition,
filter: $filter
) {
nodes {
...AllocationAnnotationFragment
}
edges {
...AllocationAnnotationsEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"first": 123,
"last": 123,
"offset": 987,
"before": Cursor,
"after": Cursor,
"orderBy": ["PRIMARY_KEY_ASC"],
"condition": AllocationAnnotationCondition,
"filter": AllocationAnnotationFilter
}
Response
{
"data": {
"allAllocationAnnotations": {
"nodes": [AllocationAnnotation],
"edges": [AllocationAnnotationsEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
}
}
allAllocationArchives
Description
Reads and enables pagination through a set of AllocationArchive.
Response
Returns an AllocationArchivesConnection
Arguments
| Name | Description |
|---|---|
first - Int
|
Only read the first n values of the set. |
last - Int
|
Only read the last n values of the set. |
offset - Int
|
Skip the first n values from our after cursor, an alternative to cursor based pagination. May not be used with last. |
before - Cursor
|
Read all values in the set before (above) this cursor. |
after - Cursor
|
Read all values in the set after (below) this cursor. |
orderBy - [AllocationArchivesOrderBy!]
|
The method to use when ordering AllocationArchive. Default = [PRIMARY_KEY_ASC] |
condition - AllocationArchiveCondition
|
A condition to be used in determining which values should be returned by the collection. |
filter - AllocationArchiveFilter
|
A filter to be used in determining which values should be returned by the collection. |
Example
Query
query allAllocationArchives(
$first: Int,
$last: Int,
$offset: Int,
$before: Cursor,
$after: Cursor,
$orderBy: [AllocationArchivesOrderBy!],
$condition: AllocationArchiveCondition,
$filter: AllocationArchiveFilter
) {
allAllocationArchives(
first: $first,
last: $last,
offset: $offset,
before: $before,
after: $after,
orderBy: $orderBy,
condition: $condition,
filter: $filter
) {
nodes {
...AllocationArchiveFragment
}
edges {
...AllocationArchivesEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"first": 987,
"last": 123,
"offset": 987,
"before": Cursor,
"after": Cursor,
"orderBy": ["PRIMARY_KEY_ASC"],
"condition": AllocationArchiveCondition,
"filter": AllocationArchiveFilter
}
Response
{
"data": {
"allAllocationArchives": {
"nodes": [AllocationArchive],
"edges": [AllocationArchivesEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
}
}
allAllocationEmailPreferences
Description
Reads and enables pagination through a set of AllocationEmailPreference.
Response
Returns an AllocationEmailPreferencesConnection
Arguments
| Name | Description |
|---|---|
first - Int
|
Only read the first n values of the set. |
last - Int
|
Only read the last n values of the set. |
offset - Int
|
Skip the first n values from our after cursor, an alternative to cursor based pagination. May not be used with last. |
before - Cursor
|
Read all values in the set before (above) this cursor. |
after - Cursor
|
Read all values in the set after (below) this cursor. |
orderBy - [AllocationEmailPreferencesOrderBy!]
|
The method to use when ordering AllocationEmailPreference. Default = [PRIMARY_KEY_ASC] |
condition - AllocationEmailPreferenceCondition
|
A condition to be used in determining which values should be returned by the collection. |
filter - AllocationEmailPreferenceFilter
|
A filter to be used in determining which values should be returned by the collection. |
Example
Query
query allAllocationEmailPreferences(
$first: Int,
$last: Int,
$offset: Int,
$before: Cursor,
$after: Cursor,
$orderBy: [AllocationEmailPreferencesOrderBy!],
$condition: AllocationEmailPreferenceCondition,
$filter: AllocationEmailPreferenceFilter
) {
allAllocationEmailPreferences(
first: $first,
last: $last,
offset: $offset,
before: $before,
after: $after,
orderBy: $orderBy,
condition: $condition,
filter: $filter
) {
nodes {
...AllocationEmailPreferenceFragment
}
edges {
...AllocationEmailPreferencesEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"first": 987,
"last": 123,
"offset": 123,
"before": Cursor,
"after": Cursor,
"orderBy": ["PRIMARY_KEY_ASC"],
"condition": AllocationEmailPreferenceCondition,
"filter": AllocationEmailPreferenceFilter
}
Response
{
"data": {
"allAllocationEmailPreferences": {
"nodes": [AllocationEmailPreference],
"edges": [AllocationEmailPreferencesEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
}
}
allAllocationOfferingLinks
Description
Reads and enables pagination through a set of AllocationOfferingLink.
Response
Returns an AllocationOfferingLinksConnection
Arguments
| Name | Description |
|---|---|
first - Int
|
Only read the first n values of the set. |
last - Int
|
Only read the last n values of the set. |
offset - Int
|
Skip the first n values from our after cursor, an alternative to cursor based pagination. May not be used with last. |
before - Cursor
|
Read all values in the set before (above) this cursor. |
after - Cursor
|
Read all values in the set after (below) this cursor. |
orderBy - [AllocationOfferingLinksOrderBy!]
|
The method to use when ordering AllocationOfferingLink. Default = [PRIMARY_KEY_ASC] |
condition - AllocationOfferingLinkCondition
|
A condition to be used in determining which values should be returned by the collection. |
filter - AllocationOfferingLinkFilter
|
A filter to be used in determining which values should be returned by the collection. |
Example
Query
query allAllocationOfferingLinks(
$first: Int,
$last: Int,
$offset: Int,
$before: Cursor,
$after: Cursor,
$orderBy: [AllocationOfferingLinksOrderBy!],
$condition: AllocationOfferingLinkCondition,
$filter: AllocationOfferingLinkFilter
) {
allAllocationOfferingLinks(
first: $first,
last: $last,
offset: $offset,
before: $before,
after: $after,
orderBy: $orderBy,
condition: $condition,
filter: $filter
) {
nodes {
...AllocationOfferingLinkFragment
}
edges {
...AllocationOfferingLinksEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"first": 987,
"last": 123,
"offset": 123,
"before": Cursor,
"after": Cursor,
"orderBy": ["PRIMARY_KEY_ASC"],
"condition": AllocationOfferingLinkCondition,
"filter": AllocationOfferingLinkFilter
}
Response
{
"data": {
"allAllocationOfferingLinks": {
"nodes": [AllocationOfferingLink],
"edges": [AllocationOfferingLinksEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
}
}
allAllocationQualifications
Description
Reads and enables pagination through a set of AllocationQualification.
Response
Returns an AllocationQualificationsConnection
Arguments
| Name | Description |
|---|---|
first - Int
|
Only read the first n values of the set. |
last - Int
|
Only read the last n values of the set. |
offset - Int
|
Skip the first n values from our after cursor, an alternative to cursor based pagination. May not be used with last. |
before - Cursor
|
Read all values in the set before (above) this cursor. |
after - Cursor
|
Read all values in the set after (below) this cursor. |
orderBy - [AllocationQualificationsOrderBy!]
|
The method to use when ordering AllocationQualification. Default = [PRIMARY_KEY_ASC] |
condition - AllocationQualificationCondition
|
A condition to be used in determining which values should be returned by the collection. |
filter - AllocationQualificationFilter
|
A filter to be used in determining which values should be returned by the collection. |
Example
Query
query allAllocationQualifications(
$first: Int,
$last: Int,
$offset: Int,
$before: Cursor,
$after: Cursor,
$orderBy: [AllocationQualificationsOrderBy!],
$condition: AllocationQualificationCondition,
$filter: AllocationQualificationFilter
) {
allAllocationQualifications(
first: $first,
last: $last,
offset: $offset,
before: $before,
after: $after,
orderBy: $orderBy,
condition: $condition,
filter: $filter
) {
nodes {
...AllocationQualificationFragment
}
edges {
...AllocationQualificationsEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"first": 123,
"last": 123,
"offset": 123,
"before": Cursor,
"after": Cursor,
"orderBy": ["PRIMARY_KEY_ASC"],
"condition": AllocationQualificationCondition,
"filter": AllocationQualificationFilter
}
Response
{
"data": {
"allAllocationQualifications": {
"nodes": [AllocationQualification],
"edges": [AllocationQualificationsEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
}
}
allAllocations
Description
Reads and enables pagination through a set of Allocation.
Response
Returns an AllocationsConnection
Arguments
| Name | Description |
|---|---|
first - Int
|
Only read the first n values of the set. |
last - Int
|
Only read the last n values of the set. |
offset - Int
|
Skip the first n values from our after cursor, an alternative to cursor based pagination. May not be used with last. |
before - Cursor
|
Read all values in the set before (above) this cursor. |
after - Cursor
|
Read all values in the set after (below) this cursor. |
orderBy - [AllocationsOrderBy!]
|
The method to use when ordering Allocation. Default = [PRIMARY_KEY_ASC] |
condition - AllocationCondition
|
A condition to be used in determining which values should be returned by the collection. |
filter - AllocationFilter
|
A filter to be used in determining which values should be returned by the collection. |
Example
Query
query allAllocations(
$first: Int,
$last: Int,
$offset: Int,
$before: Cursor,
$after: Cursor,
$orderBy: [AllocationsOrderBy!],
$condition: AllocationCondition,
$filter: AllocationFilter
) {
allAllocations(
first: $first,
last: $last,
offset: $offset,
before: $before,
after: $after,
orderBy: $orderBy,
condition: $condition,
filter: $filter
) {
nodes {
...AllocationFragment
}
edges {
...AllocationsEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"first": 987,
"last": 123,
"offset": 123,
"before": Cursor,
"after": Cursor,
"orderBy": ["PRIMARY_KEY_ASC"],
"condition": AllocationCondition,
"filter": AllocationFilter
}
Response
{
"data": {
"allAllocations": {
"nodes": [Allocation],
"edges": [AllocationsEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
}
}
allAllocationsVestingSchedules
Description
Reads and enables pagination through a set of AllocationsVestingSchedule.
Response
Returns an AllocationsVestingSchedulesConnection
Arguments
| Name | Description |
|---|---|
first - Int
|
Only read the first n values of the set. |
last - Int
|
Only read the last n values of the set. |
offset - Int
|
Skip the first n values from our after cursor, an alternative to cursor based pagination. May not be used with last. |
before - Cursor
|
Read all values in the set before (above) this cursor. |
after - Cursor
|
Read all values in the set after (below) this cursor. |
orderBy - [AllocationsVestingSchedulesOrderBy!]
|
The method to use when ordering AllocationsVestingSchedule. Default = [PRIMARY_KEY_ASC] |
condition - AllocationsVestingScheduleCondition
|
A condition to be used in determining which values should be returned by the collection. |
filter - AllocationsVestingScheduleFilter
|
A filter to be used in determining which values should be returned by the collection. |
Example
Query
query allAllocationsVestingSchedules(
$first: Int,
$last: Int,
$offset: Int,
$before: Cursor,
$after: Cursor,
$orderBy: [AllocationsVestingSchedulesOrderBy!],
$condition: AllocationsVestingScheduleCondition,
$filter: AllocationsVestingScheduleFilter
) {
allAllocationsVestingSchedules(
first: $first,
last: $last,
offset: $offset,
before: $before,
after: $after,
orderBy: $orderBy,
condition: $condition,
filter: $filter
) {
nodes {
...AllocationsVestingScheduleFragment
}
edges {
...AllocationsVestingSchedulesEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"first": 123,
"last": 123,
"offset": 123,
"before": Cursor,
"after": Cursor,
"orderBy": ["PRIMARY_KEY_ASC"],
"condition": AllocationsVestingScheduleCondition,
"filter": AllocationsVestingScheduleFilter
}
Response
{
"data": {
"allAllocationsVestingSchedules": {
"nodes": [AllocationsVestingSchedule],
"edges": [AllocationsVestingSchedulesEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
}
}
allAssetAnnotations
Description
Reads and enables pagination through a set of AssetAnnotation.
Response
Returns an AssetAnnotationsConnection
Arguments
| Name | Description |
|---|---|
first - Int
|
Only read the first n values of the set. |
last - Int
|
Only read the last n values of the set. |
offset - Int
|
Skip the first n values from our after cursor, an alternative to cursor based pagination. May not be used with last. |
before - Cursor
|
Read all values in the set before (above) this cursor. |
after - Cursor
|
Read all values in the set after (below) this cursor. |
orderBy - [AssetAnnotationsOrderBy!]
|
The method to use when ordering AssetAnnotation. Default = [PRIMARY_KEY_ASC] |
condition - AssetAnnotationCondition
|
A condition to be used in determining which values should be returned by the collection. |
filter - AssetAnnotationFilter
|
A filter to be used in determining which values should be returned by the collection. |
Example
Query
query allAssetAnnotations(
$first: Int,
$last: Int,
$offset: Int,
$before: Cursor,
$after: Cursor,
$orderBy: [AssetAnnotationsOrderBy!],
$condition: AssetAnnotationCondition,
$filter: AssetAnnotationFilter
) {
allAssetAnnotations(
first: $first,
last: $last,
offset: $offset,
before: $before,
after: $after,
orderBy: $orderBy,
condition: $condition,
filter: $filter
) {
nodes {
...AssetAnnotationFragment
}
edges {
...AssetAnnotationsEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"first": 123,
"last": 987,
"offset": 987,
"before": Cursor,
"after": Cursor,
"orderBy": ["PRIMARY_KEY_ASC"],
"condition": AssetAnnotationCondition,
"filter": AssetAnnotationFilter
}
Response
{
"data": {
"allAssetAnnotations": {
"nodes": [AssetAnnotation],
"edges": [AssetAnnotationsEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
}
}
allAssetArchives
Description
Reads and enables pagination through a set of AssetArchive.
Response
Returns an AssetArchivesConnection
Arguments
| Name | Description |
|---|---|
first - Int
|
Only read the first n values of the set. |
last - Int
|
Only read the last n values of the set. |
offset - Int
|
Skip the first n values from our after cursor, an alternative to cursor based pagination. May not be used with last. |
before - Cursor
|
Read all values in the set before (above) this cursor. |
after - Cursor
|
Read all values in the set after (below) this cursor. |
orderBy - [AssetArchivesOrderBy!]
|
The method to use when ordering AssetArchive. Default = [PRIMARY_KEY_ASC] |
condition - AssetArchiveCondition
|
A condition to be used in determining which values should be returned by the collection. |
filter - AssetArchiveFilter
|
A filter to be used in determining which values should be returned by the collection. |
Example
Query
query allAssetArchives(
$first: Int,
$last: Int,
$offset: Int,
$before: Cursor,
$after: Cursor,
$orderBy: [AssetArchivesOrderBy!],
$condition: AssetArchiveCondition,
$filter: AssetArchiveFilter
) {
allAssetArchives(
first: $first,
last: $last,
offset: $offset,
before: $before,
after: $after,
orderBy: $orderBy,
condition: $condition,
filter: $filter
) {
nodes {
...AssetArchiveFragment
}
edges {
...AssetArchivesEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"first": 987,
"last": 123,
"offset": 123,
"before": Cursor,
"after": Cursor,
"orderBy": ["PRIMARY_KEY_ASC"],
"condition": AssetArchiveCondition,
"filter": AssetArchiveFilter
}
Response
{
"data": {
"allAssetArchives": {
"nodes": [AssetArchive],
"edges": [AssetArchivesEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
}
}
allAssetStatuses
Description
Reads and enables pagination through a set of AssetStatus.
Response
Returns an AssetStatusesConnection
Arguments
| Name | Description |
|---|---|
first - Int
|
Only read the first n values of the set. |
last - Int
|
Only read the last n values of the set. |
offset - Int
|
Skip the first n values from our after cursor, an alternative to cursor based pagination. May not be used with last. |
before - Cursor
|
Read all values in the set before (above) this cursor. |
after - Cursor
|
Read all values in the set after (below) this cursor. |
orderBy - [AssetStatusesOrderBy!]
|
The method to use when ordering AssetStatus. Default = [PRIMARY_KEY_ASC] |
condition - AssetStatusCondition
|
A condition to be used in determining which values should be returned by the collection. |
filter - AssetStatusFilter
|
A filter to be used in determining which values should be returned by the collection. |
Example
Query
query allAssetStatuses(
$first: Int,
$last: Int,
$offset: Int,
$before: Cursor,
$after: Cursor,
$orderBy: [AssetStatusesOrderBy!],
$condition: AssetStatusCondition,
$filter: AssetStatusFilter
) {
allAssetStatuses(
first: $first,
last: $last,
offset: $offset,
before: $before,
after: $after,
orderBy: $orderBy,
condition: $condition,
filter: $filter
) {
nodes {
...AssetStatusFragment
}
edges {
...AssetStatusesEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"first": 987,
"last": 123,
"offset": 123,
"before": Cursor,
"after": Cursor,
"orderBy": ["PRIMARY_KEY_ASC"],
"condition": AssetStatusCondition,
"filter": AssetStatusFilter
}
Response
{
"data": {
"allAssetStatuses": {
"nodes": [AssetStatus],
"edges": [AssetStatusesEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
}
}
allAssetTypes
Description
Reads and enables pagination through a set of AssetType.
Response
Returns an AssetTypesConnection
Arguments
| Name | Description |
|---|---|
first - Int
|
Only read the first n values of the set. |
last - Int
|
Only read the last n values of the set. |
offset - Int
|
Skip the first n values from our after cursor, an alternative to cursor based pagination. May not be used with last. |
before - Cursor
|
Read all values in the set before (above) this cursor. |
after - Cursor
|
Read all values in the set after (below) this cursor. |
orderBy - [AssetTypesOrderBy!]
|
The method to use when ordering AssetType. Default = [PRIMARY_KEY_ASC] |
condition - AssetTypeCondition
|
A condition to be used in determining which values should be returned by the collection. |
filter - AssetTypeFilter
|
A filter to be used in determining which values should be returned by the collection. |
Example
Query
query allAssetTypes(
$first: Int,
$last: Int,
$offset: Int,
$before: Cursor,
$after: Cursor,
$orderBy: [AssetTypesOrderBy!],
$condition: AssetTypeCondition,
$filter: AssetTypeFilter
) {
allAssetTypes(
first: $first,
last: $last,
offset: $offset,
before: $before,
after: $after,
orderBy: $orderBy,
condition: $condition,
filter: $filter
) {
nodes {
...AssetTypeFragment
}
edges {
...AssetTypesEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"first": 987,
"last": 123,
"offset": 123,
"before": Cursor,
"after": Cursor,
"orderBy": ["PRIMARY_KEY_ASC"],
"condition": AssetTypeCondition,
"filter": AssetTypeFilter
}
Response
{
"data": {
"allAssetTypes": {
"nodes": [AssetType],
"edges": [AssetTypesEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
}
}
allAssets
Description
Reads and enables pagination through a set of Asset.
Response
Returns an AssetsConnection
Arguments
| Name | Description |
|---|---|
first - Int
|
Only read the first n values of the set. |
last - Int
|
Only read the last n values of the set. |
offset - Int
|
Skip the first n values from our after cursor, an alternative to cursor based pagination. May not be used with last. |
before - Cursor
|
Read all values in the set before (above) this cursor. |
after - Cursor
|
Read all values in the set after (below) this cursor. |
orderBy - [AssetsOrderBy!]
|
The method to use when ordering Asset. Default = [PRIMARY_KEY_ASC] |
condition - AssetCondition
|
A condition to be used in determining which values should be returned by the collection. |
filter - AssetFilter
|
A filter to be used in determining which values should be returned by the collection. |
Example
Query
query allAssets(
$first: Int,
$last: Int,
$offset: Int,
$before: Cursor,
$after: Cursor,
$orderBy: [AssetsOrderBy!],
$condition: AssetCondition,
$filter: AssetFilter
) {
allAssets(
first: $first,
last: $last,
offset: $offset,
before: $before,
after: $after,
orderBy: $orderBy,
condition: $condition,
filter: $filter
) {
nodes {
...AssetFragment
}
edges {
...AssetsEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"first": 123,
"last": 987,
"offset": 987,
"before": Cursor,
"after": Cursor,
"orderBy": ["PRIMARY_KEY_ASC"],
"condition": AssetCondition,
"filter": AssetFilter
}
Response
{
"data": {
"allAssets": {
"nodes": [Asset],
"edges": [AssetsEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
}
}
allAtsTags
Description
Reads and enables pagination through a set of AtsTag.
Response
Returns an AtsTagsConnection
Arguments
| Name | Description |
|---|---|
first - Int
|
Only read the first n values of the set. |
last - Int
|
Only read the last n values of the set. |
offset - Int
|
Skip the first n values from our after cursor, an alternative to cursor based pagination. May not be used with last. |
before - Cursor
|
Read all values in the set before (above) this cursor. |
after - Cursor
|
Read all values in the set after (below) this cursor. |
orderBy - [AtsTagsOrderBy!]
|
The method to use when ordering AtsTag. Default = [NATURAL] |
condition - AtsTagCondition
|
A condition to be used in determining which values should be returned by the collection. |
filter - AtsTagFilter
|
A filter to be used in determining which values should be returned by the collection. |
Example
Query
query allAtsTags(
$first: Int,
$last: Int,
$offset: Int,
$before: Cursor,
$after: Cursor,
$orderBy: [AtsTagsOrderBy!],
$condition: AtsTagCondition,
$filter: AtsTagFilter
) {
allAtsTags(
first: $first,
last: $last,
offset: $offset,
before: $before,
after: $after,
orderBy: $orderBy,
condition: $condition,
filter: $filter
) {
nodes {
...AtsTagFragment
}
edges {
...AtsTagsEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"first": 987,
"last": 987,
"offset": 123,
"before": Cursor,
"after": Cursor,
"orderBy": ["NATURAL"],
"condition": AtsTagCondition,
"filter": AtsTagFilter
}
Response
{
"data": {
"allAtsTags": {
"nodes": [AtsTag],
"edges": [AtsTagsEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
}
}
allAuxAccounts
Description
Reads and enables pagination through a set of AuxAccount.
Response
Returns an AuxAccountsConnection
Arguments
| Name | Description |
|---|---|
first - Int
|
Only read the first n values of the set. |
last - Int
|
Only read the last n values of the set. |
offset - Int
|
Skip the first n values from our after cursor, an alternative to cursor based pagination. May not be used with last. |
before - Cursor
|
Read all values in the set before (above) this cursor. |
after - Cursor
|
Read all values in the set after (below) this cursor. |
orderBy - [AuxAccountsOrderBy!]
|
The method to use when ordering AuxAccount. Default = [PRIMARY_KEY_ASC] |
condition - AuxAccountCondition
|
A condition to be used in determining which values should be returned by the collection. |
filter - AuxAccountFilter
|
A filter to be used in determining which values should be returned by the collection. |
Example
Query
query allAuxAccounts(
$first: Int,
$last: Int,
$offset: Int,
$before: Cursor,
$after: Cursor,
$orderBy: [AuxAccountsOrderBy!],
$condition: AuxAccountCondition,
$filter: AuxAccountFilter
) {
allAuxAccounts(
first: $first,
last: $last,
offset: $offset,
before: $before,
after: $after,
orderBy: $orderBy,
condition: $condition,
filter: $filter
) {
nodes {
...AuxAccountFragment
}
edges {
...AuxAccountsEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"first": 123,
"last": 987,
"offset": 123,
"before": Cursor,
"after": Cursor,
"orderBy": ["PRIMARY_KEY_ASC"],
"condition": AuxAccountCondition,
"filter": AuxAccountFilter
}
Response
{
"data": {
"allAuxAccounts": {
"nodes": [AuxAccount],
"edges": [AuxAccountsEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
}
}
allAuxRoles
Description
Reads and enables pagination through a set of AuxRole.
Response
Returns an AuxRolesConnection
Arguments
| Name | Description |
|---|---|
first - Int
|
Only read the first n values of the set. |
last - Int
|
Only read the last n values of the set. |
offset - Int
|
Skip the first n values from our after cursor, an alternative to cursor based pagination. May not be used with last. |
before - Cursor
|
Read all values in the set before (above) this cursor. |
after - Cursor
|
Read all values in the set after (below) this cursor. |
orderBy - [AuxRolesOrderBy!]
|
The method to use when ordering AuxRole. Default = [PRIMARY_KEY_ASC] |
condition - AuxRoleCondition
|
A condition to be used in determining which values should be returned by the collection. |
filter - AuxRoleFilter
|
A filter to be used in determining which values should be returned by the collection. |
Example
Query
query allAuxRoles(
$first: Int,
$last: Int,
$offset: Int,
$before: Cursor,
$after: Cursor,
$orderBy: [AuxRolesOrderBy!],
$condition: AuxRoleCondition,
$filter: AuxRoleFilter
) {
allAuxRoles(
first: $first,
last: $last,
offset: $offset,
before: $before,
after: $after,
orderBy: $orderBy,
condition: $condition,
filter: $filter
) {
nodes {
...AuxRoleFragment
}
edges {
...AuxRolesEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"first": 123,
"last": 123,
"offset": 987,
"before": Cursor,
"after": Cursor,
"orderBy": ["PRIMARY_KEY_ASC"],
"condition": AuxRoleCondition,
"filter": AuxRoleFilter
}
Response
{
"data": {
"allAuxRoles": {
"nodes": [AuxRole],
"edges": [AuxRolesEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
}
}
allBlockchainAddressGroups
Description
Reads and enables pagination through a set of BlockchainAddressGroup.
Response
Returns a BlockchainAddressGroupsConnection
Arguments
| Name | Description |
|---|---|
first - Int
|
Only read the first n values of the set. |
last - Int
|
Only read the last n values of the set. |
offset - Int
|
Skip the first n values from our after cursor, an alternative to cursor based pagination. May not be used with last. |
before - Cursor
|
Read all values in the set before (above) this cursor. |
after - Cursor
|
Read all values in the set after (below) this cursor. |
orderBy - [BlockchainAddressGroupsOrderBy!]
|
The method to use when ordering BlockchainAddressGroup. Default = [PRIMARY_KEY_ASC] |
condition - BlockchainAddressGroupCondition
|
A condition to be used in determining which values should be returned by the collection. |
filter - BlockchainAddressGroupFilter
|
A filter to be used in determining which values should be returned by the collection. |
Example
Query
query allBlockchainAddressGroups(
$first: Int,
$last: Int,
$offset: Int,
$before: Cursor,
$after: Cursor,
$orderBy: [BlockchainAddressGroupsOrderBy!],
$condition: BlockchainAddressGroupCondition,
$filter: BlockchainAddressGroupFilter
) {
allBlockchainAddressGroups(
first: $first,
last: $last,
offset: $offset,
before: $before,
after: $after,
orderBy: $orderBy,
condition: $condition,
filter: $filter
) {
nodes {
...BlockchainAddressGroupFragment
}
edges {
...BlockchainAddressGroupsEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"first": 987,
"last": 987,
"offset": 123,
"before": Cursor,
"after": Cursor,
"orderBy": ["PRIMARY_KEY_ASC"],
"condition": BlockchainAddressGroupCondition,
"filter": BlockchainAddressGroupFilter
}
Response
{
"data": {
"allBlockchainAddressGroups": {
"nodes": [BlockchainAddressGroup],
"edges": [BlockchainAddressGroupsEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
}
}
allBlockchainAddressSources
Description
Reads and enables pagination through a set of BlockchainAddressSource.
Response
Returns a BlockchainAddressSourcesConnection
Arguments
| Name | Description |
|---|---|
first - Int
|
Only read the first n values of the set. |
last - Int
|
Only read the last n values of the set. |
offset - Int
|
Skip the first n values from our after cursor, an alternative to cursor based pagination. May not be used with last. |
before - Cursor
|
Read all values in the set before (above) this cursor. |
after - Cursor
|
Read all values in the set after (below) this cursor. |
orderBy - [BlockchainAddressSourcesOrderBy!]
|
The method to use when ordering BlockchainAddressSource. Default = [PRIMARY_KEY_ASC] |
condition - BlockchainAddressSourceCondition
|
A condition to be used in determining which values should be returned by the collection. |
filter - BlockchainAddressSourceFilter
|
A filter to be used in determining which values should be returned by the collection. |
Example
Query
query allBlockchainAddressSources(
$first: Int,
$last: Int,
$offset: Int,
$before: Cursor,
$after: Cursor,
$orderBy: [BlockchainAddressSourcesOrderBy!],
$condition: BlockchainAddressSourceCondition,
$filter: BlockchainAddressSourceFilter
) {
allBlockchainAddressSources(
first: $first,
last: $last,
offset: $offset,
before: $before,
after: $after,
orderBy: $orderBy,
condition: $condition,
filter: $filter
) {
nodes {
...BlockchainAddressSourceFragment
}
edges {
...BlockchainAddressSourcesEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"first": 987,
"last": 123,
"offset": 123,
"before": Cursor,
"after": Cursor,
"orderBy": ["PRIMARY_KEY_ASC"],
"condition": BlockchainAddressSourceCondition,
"filter": BlockchainAddressSourceFilter
}
Response
{
"data": {
"allBlockchainAddressSources": {
"nodes": [BlockchainAddressSource],
"edges": [BlockchainAddressSourcesEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
}
}
allBlockchainAddresses
Description
Reads and enables pagination through a set of BlockchainAddress.
Response
Returns a BlockchainAddressesConnection
Arguments
| Name | Description |
|---|---|
first - Int
|
Only read the first n values of the set. |
last - Int
|
Only read the last n values of the set. |
offset - Int
|
Skip the first n values from our after cursor, an alternative to cursor based pagination. May not be used with last. |
before - Cursor
|
Read all values in the set before (above) this cursor. |
after - Cursor
|
Read all values in the set after (below) this cursor. |
orderBy - [BlockchainAddressesOrderBy!]
|
The method to use when ordering BlockchainAddress. Default = [PRIMARY_KEY_ASC] |
condition - BlockchainAddressCondition
|
A condition to be used in determining which values should be returned by the collection. |
filter - BlockchainAddressFilter
|
A filter to be used in determining which values should be returned by the collection. |
Example
Query
query allBlockchainAddresses(
$first: Int,
$last: Int,
$offset: Int,
$before: Cursor,
$after: Cursor,
$orderBy: [BlockchainAddressesOrderBy!],
$condition: BlockchainAddressCondition,
$filter: BlockchainAddressFilter
) {
allBlockchainAddresses(
first: $first,
last: $last,
offset: $offset,
before: $before,
after: $after,
orderBy: $orderBy,
condition: $condition,
filter: $filter
) {
nodes {
...BlockchainAddressFragment
}
edges {
...BlockchainAddressesEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"first": 987,
"last": 123,
"offset": 987,
"before": Cursor,
"after": Cursor,
"orderBy": ["PRIMARY_KEY_ASC"],
"condition": BlockchainAddressCondition,
"filter": BlockchainAddressFilter
}
Response
{
"data": {
"allBlockchainAddresses": {
"nodes": [BlockchainAddress],
"edges": [BlockchainAddressesEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
}
}
allBlockchainRegistrations
Description
Reads and enables pagination through a set of BlockchainRegistration.
Response
Returns a BlockchainRegistrationsConnection
Arguments
| Name | Description |
|---|---|
first - Int
|
Only read the first n values of the set. |
last - Int
|
Only read the last n values of the set. |
offset - Int
|
Skip the first n values from our after cursor, an alternative to cursor based pagination. May not be used with last. |
before - Cursor
|
Read all values in the set before (above) this cursor. |
after - Cursor
|
Read all values in the set after (below) this cursor. |
orderBy - [BlockchainRegistrationsOrderBy!]
|
The method to use when ordering BlockchainRegistration. Default = [PRIMARY_KEY_ASC] |
condition - BlockchainRegistrationCondition
|
A condition to be used in determining which values should be returned by the collection. |
filter - BlockchainRegistrationFilter
|
A filter to be used in determining which values should be returned by the collection. |
Example
Query
query allBlockchainRegistrations(
$first: Int,
$last: Int,
$offset: Int,
$before: Cursor,
$after: Cursor,
$orderBy: [BlockchainRegistrationsOrderBy!],
$condition: BlockchainRegistrationCondition,
$filter: BlockchainRegistrationFilter
) {
allBlockchainRegistrations(
first: $first,
last: $last,
offset: $offset,
before: $before,
after: $after,
orderBy: $orderBy,
condition: $condition,
filter: $filter
) {
nodes {
...BlockchainRegistrationFragment
}
edges {
...BlockchainRegistrationsEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"first": 123,
"last": 987,
"offset": 987,
"before": Cursor,
"after": Cursor,
"orderBy": ["PRIMARY_KEY_ASC"],
"condition": BlockchainRegistrationCondition,
"filter": BlockchainRegistrationFilter
}
Response
{
"data": {
"allBlockchainRegistrations": {
"nodes": [BlockchainRegistration],
"edges": [BlockchainRegistrationsEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
}
}
allBrokerAllocations
Description
Reads and enables pagination through a set of BrokerAllocation.
Response
Returns a BrokerAllocationsConnection
Arguments
| Name | Description |
|---|---|
first - Int
|
Only read the first n values of the set. |
last - Int
|
Only read the last n values of the set. |
offset - Int
|
Skip the first n values from our after cursor, an alternative to cursor based pagination. May not be used with last. |
before - Cursor
|
Read all values in the set before (above) this cursor. |
after - Cursor
|
Read all values in the set after (below) this cursor. |
orderBy - [BrokerAllocationsOrderBy!]
|
The method to use when ordering BrokerAllocation. Default = [PRIMARY_KEY_ASC] |
condition - BrokerAllocationCondition
|
A condition to be used in determining which values should be returned by the collection. |
filter - BrokerAllocationFilter
|
A filter to be used in determining which values should be returned by the collection. |
Example
Query
query allBrokerAllocations(
$first: Int,
$last: Int,
$offset: Int,
$before: Cursor,
$after: Cursor,
$orderBy: [BrokerAllocationsOrderBy!],
$condition: BrokerAllocationCondition,
$filter: BrokerAllocationFilter
) {
allBrokerAllocations(
first: $first,
last: $last,
offset: $offset,
before: $before,
after: $after,
orderBy: $orderBy,
condition: $condition,
filter: $filter
) {
nodes {
...BrokerAllocationFragment
}
edges {
...BrokerAllocationsEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"first": 123,
"last": 123,
"offset": 123,
"before": Cursor,
"after": Cursor,
"orderBy": ["PRIMARY_KEY_ASC"],
"condition": BrokerAllocationCondition,
"filter": BrokerAllocationFilter
}
Response
{
"data": {
"allBrokerAllocations": {
"nodes": [BrokerAllocation],
"edges": [BrokerAllocationsEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
}
}
allCapTables
Description
Reads and enables pagination through a set of CapTable.
Response
Returns a CapTablesConnection
Arguments
| Name | Description |
|---|---|
first - Int
|
Only read the first n values of the set. |
last - Int
|
Only read the last n values of the set. |
offset - Int
|
Skip the first n values from our after cursor, an alternative to cursor based pagination. May not be used with last. |
before - Cursor
|
Read all values in the set before (above) this cursor. |
after - Cursor
|
Read all values in the set after (below) this cursor. |
orderBy - [CapTablesOrderBy!]
|
The method to use when ordering CapTable. Default = [PRIMARY_KEY_ASC] |
condition - CapTableCondition
|
A condition to be used in determining which values should be returned by the collection. |
filter - CapTableFilter
|
A filter to be used in determining which values should be returned by the collection. |
Example
Query
query allCapTables(
$first: Int,
$last: Int,
$offset: Int,
$before: Cursor,
$after: Cursor,
$orderBy: [CapTablesOrderBy!],
$condition: CapTableCondition,
$filter: CapTableFilter
) {
allCapTables(
first: $first,
last: $last,
offset: $offset,
before: $before,
after: $after,
orderBy: $orderBy,
condition: $condition,
filter: $filter
) {
nodes {
...CapTableFragment
}
edges {
...CapTablesEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"first": 987,
"last": 123,
"offset": 123,
"before": Cursor,
"after": Cursor,
"orderBy": ["PRIMARY_KEY_ASC"],
"condition": CapTableCondition,
"filter": CapTableFilter
}
Response
{
"data": {
"allCapTables": {
"nodes": [CapTable],
"edges": [CapTablesEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
}
}
allCapitalDeployments
Description
Reads and enables pagination through a set of CapitalDeployment.
Response
Returns a CapitalDeploymentsConnection
Arguments
| Name | Description |
|---|---|
first - Int
|
Only read the first n values of the set. |
last - Int
|
Only read the last n values of the set. |
offset - Int
|
Skip the first n values from our after cursor, an alternative to cursor based pagination. May not be used with last. |
before - Cursor
|
Read all values in the set before (above) this cursor. |
after - Cursor
|
Read all values in the set after (below) this cursor. |
orderBy - [CapitalDeploymentsOrderBy!]
|
The method to use when ordering CapitalDeployment. Default = [PRIMARY_KEY_ASC] |
condition - CapitalDeploymentCondition
|
A condition to be used in determining which values should be returned by the collection. |
filter - CapitalDeploymentFilter
|
A filter to be used in determining which values should be returned by the collection. |
Example
Query
query allCapitalDeployments(
$first: Int,
$last: Int,
$offset: Int,
$before: Cursor,
$after: Cursor,
$orderBy: [CapitalDeploymentsOrderBy!],
$condition: CapitalDeploymentCondition,
$filter: CapitalDeploymentFilter
) {
allCapitalDeployments(
first: $first,
last: $last,
offset: $offset,
before: $before,
after: $after,
orderBy: $orderBy,
condition: $condition,
filter: $filter
) {
nodes {
...CapitalDeploymentFragment
}
edges {
...CapitalDeploymentsEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"first": 123,
"last": 987,
"offset": 987,
"before": Cursor,
"after": Cursor,
"orderBy": ["PRIMARY_KEY_ASC"],
"condition": CapitalDeploymentCondition,
"filter": CapitalDeploymentFilter
}
Response
{
"data": {
"allCapitalDeployments": {
"nodes": [CapitalDeployment],
"edges": [CapitalDeploymentsEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
}
}
allChains
Description
Reads and enables pagination through a set of Chain.
Response
Returns a ChainsConnection
Arguments
| Name | Description |
|---|---|
first - Int
|
Only read the first n values of the set. |
last - Int
|
Only read the last n values of the set. |
offset - Int
|
Skip the first n values from our after cursor, an alternative to cursor based pagination. May not be used with last. |
before - Cursor
|
Read all values in the set before (above) this cursor. |
after - Cursor
|
Read all values in the set after (below) this cursor. |
orderBy - [ChainsOrderBy!]
|
The method to use when ordering Chain. Default = [PRIMARY_KEY_ASC] |
condition - ChainCondition
|
A condition to be used in determining which values should be returned by the collection. |
filter - ChainFilter
|
A filter to be used in determining which values should be returned by the collection. |
Example
Query
query allChains(
$first: Int,
$last: Int,
$offset: Int,
$before: Cursor,
$after: Cursor,
$orderBy: [ChainsOrderBy!],
$condition: ChainCondition,
$filter: ChainFilter
) {
allChains(
first: $first,
last: $last,
offset: $offset,
before: $before,
after: $after,
orderBy: $orderBy,
condition: $condition,
filter: $filter
) {
nodes {
...ChainFragment
}
edges {
...ChainsEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"first": 123,
"last": 987,
"offset": 123,
"before": Cursor,
"after": Cursor,
"orderBy": ["PRIMARY_KEY_ASC"],
"condition": ChainCondition,
"filter": ChainFilter
}
Response
{
"data": {
"allChains": {
"nodes": [Chain],
"edges": [ChainsEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
}
}
allCompanies
Description
Reads and enables pagination through a set of Company.
Response
Returns a CompaniesConnection
Arguments
| Name | Description |
|---|---|
first - Int
|
Only read the first n values of the set. |
last - Int
|
Only read the last n values of the set. |
offset - Int
|
Skip the first n values from our after cursor, an alternative to cursor based pagination. May not be used with last. |
before - Cursor
|
Read all values in the set before (above) this cursor. |
after - Cursor
|
Read all values in the set after (below) this cursor. |
orderBy - [CompaniesOrderBy!]
|
The method to use when ordering Company. Default = [PRIMARY_KEY_ASC] |
condition - CompanyCondition
|
A condition to be used in determining which values should be returned by the collection. |
filter - CompanyFilter
|
A filter to be used in determining which values should be returned by the collection. |
Example
Query
query allCompanies(
$first: Int,
$last: Int,
$offset: Int,
$before: Cursor,
$after: Cursor,
$orderBy: [CompaniesOrderBy!],
$condition: CompanyCondition,
$filter: CompanyFilter
) {
allCompanies(
first: $first,
last: $last,
offset: $offset,
before: $before,
after: $after,
orderBy: $orderBy,
condition: $condition,
filter: $filter
) {
nodes {
...CompanyFragment
}
edges {
...CompaniesEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"first": 987,
"last": 987,
"offset": 987,
"before": Cursor,
"after": Cursor,
"orderBy": ["PRIMARY_KEY_ASC"],
"condition": CompanyCondition,
"filter": CompanyFilter
}
Response
{
"data": {
"allCompanies": {
"nodes": [Company],
"edges": [CompaniesEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
}
}
allContractStatuses
Description
Reads and enables pagination through a set of ContractStatus.
Response
Returns a ContractStatusesConnection
Arguments
| Name | Description |
|---|---|
first - Int
|
Only read the first n values of the set. |
last - Int
|
Only read the last n values of the set. |
offset - Int
|
Skip the first n values from our after cursor, an alternative to cursor based pagination. May not be used with last. |
before - Cursor
|
Read all values in the set before (above) this cursor. |
after - Cursor
|
Read all values in the set after (below) this cursor. |
orderBy - [ContractStatusesOrderBy!]
|
The method to use when ordering ContractStatus. Default = [PRIMARY_KEY_ASC] |
condition - ContractStatusCondition
|
A condition to be used in determining which values should be returned by the collection. |
filter - ContractStatusFilter
|
A filter to be used in determining which values should be returned by the collection. |
Example
Query
query allContractStatuses(
$first: Int,
$last: Int,
$offset: Int,
$before: Cursor,
$after: Cursor,
$orderBy: [ContractStatusesOrderBy!],
$condition: ContractStatusCondition,
$filter: ContractStatusFilter
) {
allContractStatuses(
first: $first,
last: $last,
offset: $offset,
before: $before,
after: $after,
orderBy: $orderBy,
condition: $condition,
filter: $filter
) {
nodes {
...ContractStatusFragment
}
edges {
...ContractStatusesEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"first": 123,
"last": 123,
"offset": 987,
"before": Cursor,
"after": Cursor,
"orderBy": ["PRIMARY_KEY_ASC"],
"condition": ContractStatusCondition,
"filter": ContractStatusFilter
}
Response
{
"data": {
"allContractStatuses": {
"nodes": [ContractStatus],
"edges": [ContractStatusesEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
}
}
allContracts
Description
Reads and enables pagination through a set of Contract.
Response
Returns a ContractsConnection
Arguments
| Name | Description |
|---|---|
first - Int
|
Only read the first n values of the set. |
last - Int
|
Only read the last n values of the set. |
offset - Int
|
Skip the first n values from our after cursor, an alternative to cursor based pagination. May not be used with last. |
before - Cursor
|
Read all values in the set before (above) this cursor. |
after - Cursor
|
Read all values in the set after (below) this cursor. |
orderBy - [ContractsOrderBy!]
|
The method to use when ordering Contract. Default = [PRIMARY_KEY_ASC] |
condition - ContractCondition
|
A condition to be used in determining which values should be returned by the collection. |
filter - ContractFilter
|
A filter to be used in determining which values should be returned by the collection. |
Example
Query
query allContracts(
$first: Int,
$last: Int,
$offset: Int,
$before: Cursor,
$after: Cursor,
$orderBy: [ContractsOrderBy!],
$condition: ContractCondition,
$filter: ContractFilter
) {
allContracts(
first: $first,
last: $last,
offset: $offset,
before: $before,
after: $after,
orderBy: $orderBy,
condition: $condition,
filter: $filter
) {
nodes {
...ContractFragment
}
edges {
...ContractsEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"first": 123,
"last": 987,
"offset": 987,
"before": Cursor,
"after": Cursor,
"orderBy": ["PRIMARY_KEY_ASC"],
"condition": ContractCondition,
"filter": ContractFilter
}
Response
{
"data": {
"allContracts": {
"nodes": [Contract],
"edges": [ContractsEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
}
}
allCountries
Description
Reads and enables pagination through a set of Country.
Response
Returns a CountriesConnection
Arguments
| Name | Description |
|---|---|
first - Int
|
Only read the first n values of the set. |
last - Int
|
Only read the last n values of the set. |
offset - Int
|
Skip the first n values from our after cursor, an alternative to cursor based pagination. May not be used with last. |
before - Cursor
|
Read all values in the set before (above) this cursor. |
after - Cursor
|
Read all values in the set after (below) this cursor. |
orderBy - [CountriesOrderBy!]
|
The method to use when ordering Country. Default = [PRIMARY_KEY_ASC] |
condition - CountryCondition
|
A condition to be used in determining which values should be returned by the collection. |
filter - CountryFilter
|
A filter to be used in determining which values should be returned by the collection. |
Example
Query
query allCountries(
$first: Int,
$last: Int,
$offset: Int,
$before: Cursor,
$after: Cursor,
$orderBy: [CountriesOrderBy!],
$condition: CountryCondition,
$filter: CountryFilter
) {
allCountries(
first: $first,
last: $last,
offset: $offset,
before: $before,
after: $after,
orderBy: $orderBy,
condition: $condition,
filter: $filter
) {
nodes {
...CountryFragment
}
edges {
...CountriesEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"first": 987,
"last": 987,
"offset": 123,
"before": Cursor,
"after": Cursor,
"orderBy": ["PRIMARY_KEY_ASC"],
"condition": CountryCondition,
"filter": CountryFilter
}
Response
{
"data": {
"allCountries": {
"nodes": [Country],
"edges": [CountriesEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
}
}
allCountryProvinces
Description
Reads and enables pagination through a set of CountryProvince.
Response
Returns a CountryProvincesConnection
Arguments
| Name | Description |
|---|---|
first - Int
|
Only read the first n values of the set. |
last - Int
|
Only read the last n values of the set. |
offset - Int
|
Skip the first n values from our after cursor, an alternative to cursor based pagination. May not be used with last. |
before - Cursor
|
Read all values in the set before (above) this cursor. |
after - Cursor
|
Read all values in the set after (below) this cursor. |
orderBy - [CountryProvincesOrderBy!]
|
The method to use when ordering CountryProvince. Default = [PRIMARY_KEY_ASC] |
condition - CountryProvinceCondition
|
A condition to be used in determining which values should be returned by the collection. |
filter - CountryProvinceFilter
|
A filter to be used in determining which values should be returned by the collection. |
Example
Query
query allCountryProvinces(
$first: Int,
$last: Int,
$offset: Int,
$before: Cursor,
$after: Cursor,
$orderBy: [CountryProvincesOrderBy!],
$condition: CountryProvinceCondition,
$filter: CountryProvinceFilter
) {
allCountryProvinces(
first: $first,
last: $last,
offset: $offset,
before: $before,
after: $after,
orderBy: $orderBy,
condition: $condition,
filter: $filter
) {
nodes {
...CountryProvinceFragment
}
edges {
...CountryProvincesEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"first": 987,
"last": 123,
"offset": 123,
"before": Cursor,
"after": Cursor,
"orderBy": ["PRIMARY_KEY_ASC"],
"condition": CountryProvinceCondition,
"filter": CountryProvinceFilter
}
Response
{
"data": {
"allCountryProvinces": {
"nodes": [CountryProvince],
"edges": [CountryProvincesEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
}
}
allCurrencies
Description
Reads and enables pagination through a set of Currency.
Response
Returns a CurrenciesConnection
Arguments
| Name | Description |
|---|---|
first - Int
|
Only read the first n values of the set. |
last - Int
|
Only read the last n values of the set. |
offset - Int
|
Skip the first n values from our after cursor, an alternative to cursor based pagination. May not be used with last. |
before - Cursor
|
Read all values in the set before (above) this cursor. |
after - Cursor
|
Read all values in the set after (below) this cursor. |
orderBy - [CurrenciesOrderBy!]
|
The method to use when ordering Currency. Default = [PRIMARY_KEY_ASC] |
condition - CurrencyCondition
|
A condition to be used in determining which values should be returned by the collection. |
filter - CurrencyFilter
|
A filter to be used in determining which values should be returned by the collection. |
Example
Query
query allCurrencies(
$first: Int,
$last: Int,
$offset: Int,
$before: Cursor,
$after: Cursor,
$orderBy: [CurrenciesOrderBy!],
$condition: CurrencyCondition,
$filter: CurrencyFilter
) {
allCurrencies(
first: $first,
last: $last,
offset: $offset,
before: $before,
after: $after,
orderBy: $orderBy,
condition: $condition,
filter: $filter
) {
nodes {
...CurrencyFragment
}
edges {
...CurrenciesEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"first": 987,
"last": 987,
"offset": 123,
"before": Cursor,
"after": Cursor,
"orderBy": ["PRIMARY_KEY_ASC"],
"condition": CurrencyCondition,
"filter": CurrencyFilter
}
Response
{
"data": {
"allCurrencies": {
"nodes": [Currency],
"edges": [CurrenciesEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
}
}
allCurrencyTypes
Description
Reads and enables pagination through a set of CurrencyType.
Response
Returns a CurrencyTypesConnection
Arguments
| Name | Description |
|---|---|
first - Int
|
Only read the first n values of the set. |
last - Int
|
Only read the last n values of the set. |
offset - Int
|
Skip the first n values from our after cursor, an alternative to cursor based pagination. May not be used with last. |
before - Cursor
|
Read all values in the set before (above) this cursor. |
after - Cursor
|
Read all values in the set after (below) this cursor. |
orderBy - [CurrencyTypesOrderBy!]
|
The method to use when ordering CurrencyType. Default = [PRIMARY_KEY_ASC] |
condition - CurrencyTypeCondition
|
A condition to be used in determining which values should be returned by the collection. |
filter - CurrencyTypeFilter
|
A filter to be used in determining which values should be returned by the collection. |
Example
Query
query allCurrencyTypes(
$first: Int,
$last: Int,
$offset: Int,
$before: Cursor,
$after: Cursor,
$orderBy: [CurrencyTypesOrderBy!],
$condition: CurrencyTypeCondition,
$filter: CurrencyTypeFilter
) {
allCurrencyTypes(
first: $first,
last: $last,
offset: $offset,
before: $before,
after: $after,
orderBy: $orderBy,
condition: $condition,
filter: $filter
) {
nodes {
...CurrencyTypeFragment
}
edges {
...CurrencyTypesEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"first": 123,
"last": 987,
"offset": 987,
"before": Cursor,
"after": Cursor,
"orderBy": ["PRIMARY_KEY_ASC"],
"condition": CurrencyTypeCondition,
"filter": CurrencyTypeFilter
}
Response
{
"data": {
"allCurrencyTypes": {
"nodes": [CurrencyType],
"edges": [CurrencyTypesEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
}
}
allCustomerAddresses
Description
Reads and enables pagination through a set of CustomerAddress.
Response
Returns a CustomerAddressesConnection
Arguments
| Name | Description |
|---|---|
first - Int
|
Only read the first n values of the set. |
last - Int
|
Only read the last n values of the set. |
offset - Int
|
Skip the first n values from our after cursor, an alternative to cursor based pagination. May not be used with last. |
before - Cursor
|
Read all values in the set before (above) this cursor. |
after - Cursor
|
Read all values in the set after (below) this cursor. |
orderBy - [CustomerAddressesOrderBy!]
|
The method to use when ordering CustomerAddress. Default = [PRIMARY_KEY_ASC] |
condition - CustomerAddressCondition
|
A condition to be used in determining which values should be returned by the collection. |
filter - CustomerAddressFilter
|
A filter to be used in determining which values should be returned by the collection. |
Example
Query
query allCustomerAddresses(
$first: Int,
$last: Int,
$offset: Int,
$before: Cursor,
$after: Cursor,
$orderBy: [CustomerAddressesOrderBy!],
$condition: CustomerAddressCondition,
$filter: CustomerAddressFilter
) {
allCustomerAddresses(
first: $first,
last: $last,
offset: $offset,
before: $before,
after: $after,
orderBy: $orderBy,
condition: $condition,
filter: $filter
) {
nodes {
...CustomerAddressFragment
}
edges {
...CustomerAddressesEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"first": 123,
"last": 123,
"offset": 123,
"before": Cursor,
"after": Cursor,
"orderBy": ["PRIMARY_KEY_ASC"],
"condition": CustomerAddressCondition,
"filter": CustomerAddressFilter
}
Response
{
"data": {
"allCustomerAddresses": {
"nodes": [CustomerAddress],
"edges": [CustomerAddressesEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
}
}
allCustomerParties
Description
Reads and enables pagination through a set of CustomerParty.
Response
Returns a CustomerPartiesConnection
Arguments
| Name | Description |
|---|---|
first - Int
|
Only read the first n values of the set. |
last - Int
|
Only read the last n values of the set. |
offset - Int
|
Skip the first n values from our after cursor, an alternative to cursor based pagination. May not be used with last. |
before - Cursor
|
Read all values in the set before (above) this cursor. |
after - Cursor
|
Read all values in the set after (below) this cursor. |
orderBy - [CustomerPartiesOrderBy!]
|
The method to use when ordering CustomerParty. Default = [PRIMARY_KEY_ASC] |
condition - CustomerPartyCondition
|
A condition to be used in determining which values should be returned by the collection. |
filter - CustomerPartyFilter
|
A filter to be used in determining which values should be returned by the collection. |
Example
Query
query allCustomerParties(
$first: Int,
$last: Int,
$offset: Int,
$before: Cursor,
$after: Cursor,
$orderBy: [CustomerPartiesOrderBy!],
$condition: CustomerPartyCondition,
$filter: CustomerPartyFilter
) {
allCustomerParties(
first: $first,
last: $last,
offset: $offset,
before: $before,
after: $after,
orderBy: $orderBy,
condition: $condition,
filter: $filter
) {
nodes {
...CustomerPartyFragment
}
edges {
...CustomerPartiesEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"first": 123,
"last": 987,
"offset": 987,
"before": Cursor,
"after": Cursor,
"orderBy": ["PRIMARY_KEY_ASC"],
"condition": CustomerPartyCondition,
"filter": CustomerPartyFilter
}
Response
{
"data": {
"allCustomerParties": {
"nodes": [CustomerParty],
"edges": [CustomerPartiesEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
}
}
allCustomerPartyAddresses
Description
Reads and enables pagination through a set of CustomerPartyAddress.
Response
Returns a CustomerPartyAddressesConnection
Arguments
| Name | Description |
|---|---|
first - Int
|
Only read the first n values of the set. |
last - Int
|
Only read the last n values of the set. |
offset - Int
|
Skip the first n values from our after cursor, an alternative to cursor based pagination. May not be used with last. |
before - Cursor
|
Read all values in the set before (above) this cursor. |
after - Cursor
|
Read all values in the set after (below) this cursor. |
orderBy - [CustomerPartyAddressesOrderBy!]
|
The method to use when ordering CustomerPartyAddress. Default = [PRIMARY_KEY_ASC] |
condition - CustomerPartyAddressCondition
|
A condition to be used in determining which values should be returned by the collection. |
filter - CustomerPartyAddressFilter
|
A filter to be used in determining which values should be returned by the collection. |
Example
Query
query allCustomerPartyAddresses(
$first: Int,
$last: Int,
$offset: Int,
$before: Cursor,
$after: Cursor,
$orderBy: [CustomerPartyAddressesOrderBy!],
$condition: CustomerPartyAddressCondition,
$filter: CustomerPartyAddressFilter
) {
allCustomerPartyAddresses(
first: $first,
last: $last,
offset: $offset,
before: $before,
after: $after,
orderBy: $orderBy,
condition: $condition,
filter: $filter
) {
nodes {
...CustomerPartyAddressFragment
}
edges {
...CustomerPartyAddressesEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"first": 987,
"last": 987,
"offset": 123,
"before": Cursor,
"after": Cursor,
"orderBy": ["PRIMARY_KEY_ASC"],
"condition": CustomerPartyAddressCondition,
"filter": CustomerPartyAddressFilter
}
Response
{
"data": {
"allCustomerPartyAddresses": {
"nodes": [CustomerPartyAddress],
"edges": [CustomerPartyAddressesEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
}
}
allCustomers
Description
Reads and enables pagination through a set of Customer.
Response
Returns a CustomersConnection
Arguments
| Name | Description |
|---|---|
first - Int
|
Only read the first n values of the set. |
last - Int
|
Only read the last n values of the set. |
offset - Int
|
Skip the first n values from our after cursor, an alternative to cursor based pagination. May not be used with last. |
before - Cursor
|
Read all values in the set before (above) this cursor. |
after - Cursor
|
Read all values in the set after (below) this cursor. |
orderBy - [CustomersOrderBy!]
|
The method to use when ordering Customer. Default = [PRIMARY_KEY_ASC] |
condition - CustomerCondition
|
A condition to be used in determining which values should be returned by the collection. |
filter - CustomerFilter
|
A filter to be used in determining which values should be returned by the collection. |
Example
Query
query allCustomers(
$first: Int,
$last: Int,
$offset: Int,
$before: Cursor,
$after: Cursor,
$orderBy: [CustomersOrderBy!],
$condition: CustomerCondition,
$filter: CustomerFilter
) {
allCustomers(
first: $first,
last: $last,
offset: $offset,
before: $before,
after: $after,
orderBy: $orderBy,
condition: $condition,
filter: $filter
) {
nodes {
...CustomerFragment
}
edges {
...CustomersEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"first": 987,
"last": 123,
"offset": 987,
"before": Cursor,
"after": Cursor,
"orderBy": ["PRIMARY_KEY_ASC"],
"condition": CustomerCondition,
"filter": CustomerFilter
}
Response
{
"data": {
"allCustomers": {
"nodes": [Customer],
"edges": [CustomersEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
}
}
allDefaultMappingFields
Description
Reads and enables pagination through a set of DefaultMappingField.
Response
Returns a DefaultMappingFieldsConnection
Arguments
| Name | Description |
|---|---|
first - Int
|
Only read the first n values of the set. |
last - Int
|
Only read the last n values of the set. |
offset - Int
|
Skip the first n values from our after cursor, an alternative to cursor based pagination. May not be used with last. |
before - Cursor
|
Read all values in the set before (above) this cursor. |
after - Cursor
|
Read all values in the set after (below) this cursor. |
orderBy - [DefaultMappingFieldsOrderBy!]
|
The method to use when ordering DefaultMappingField. Default = [PRIMARY_KEY_ASC] |
condition - DefaultMappingFieldCondition
|
A condition to be used in determining which values should be returned by the collection. |
filter - DefaultMappingFieldFilter
|
A filter to be used in determining which values should be returned by the collection. |
Example
Query
query allDefaultMappingFields(
$first: Int,
$last: Int,
$offset: Int,
$before: Cursor,
$after: Cursor,
$orderBy: [DefaultMappingFieldsOrderBy!],
$condition: DefaultMappingFieldCondition,
$filter: DefaultMappingFieldFilter
) {
allDefaultMappingFields(
first: $first,
last: $last,
offset: $offset,
before: $before,
after: $after,
orderBy: $orderBy,
condition: $condition,
filter: $filter
) {
nodes {
...DefaultMappingFieldFragment
}
edges {
...DefaultMappingFieldsEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"first": 123,
"last": 123,
"offset": 987,
"before": Cursor,
"after": Cursor,
"orderBy": ["PRIMARY_KEY_ASC"],
"condition": DefaultMappingFieldCondition,
"filter": DefaultMappingFieldFilter
}
Response
{
"data": {
"allDefaultMappingFields": {
"nodes": [DefaultMappingField],
"edges": [DefaultMappingFieldsEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
}
}
allDistributionAnnotations
Description
Reads and enables pagination through a set of DistributionAnnotation.
Response
Returns a DistributionAnnotationsConnection
Arguments
| Name | Description |
|---|---|
first - Int
|
Only read the first n values of the set. |
last - Int
|
Only read the last n values of the set. |
offset - Int
|
Skip the first n values from our after cursor, an alternative to cursor based pagination. May not be used with last. |
before - Cursor
|
Read all values in the set before (above) this cursor. |
after - Cursor
|
Read all values in the set after (below) this cursor. |
orderBy - [DistributionAnnotationsOrderBy!]
|
The method to use when ordering DistributionAnnotation. Default = [PRIMARY_KEY_ASC] |
condition - DistributionAnnotationCondition
|
A condition to be used in determining which values should be returned by the collection. |
filter - DistributionAnnotationFilter
|
A filter to be used in determining which values should be returned by the collection. |
Example
Query
query allDistributionAnnotations(
$first: Int,
$last: Int,
$offset: Int,
$before: Cursor,
$after: Cursor,
$orderBy: [DistributionAnnotationsOrderBy!],
$condition: DistributionAnnotationCondition,
$filter: DistributionAnnotationFilter
) {
allDistributionAnnotations(
first: $first,
last: $last,
offset: $offset,
before: $before,
after: $after,
orderBy: $orderBy,
condition: $condition,
filter: $filter
) {
nodes {
...DistributionAnnotationFragment
}
edges {
...DistributionAnnotationsEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"first": 123,
"last": 987,
"offset": 987,
"before": Cursor,
"after": Cursor,
"orderBy": ["PRIMARY_KEY_ASC"],
"condition": DistributionAnnotationCondition,
"filter": DistributionAnnotationFilter
}
Response
{
"data": {
"allDistributionAnnotations": {
"nodes": [DistributionAnnotation],
"edges": [DistributionAnnotationsEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
}
}
allDistributionCustomFields
Description
Reads and enables pagination through a set of DistributionCustomField.
Response
Returns a DistributionCustomFieldsConnection
Arguments
| Name | Description |
|---|---|
first - Int
|
Only read the first n values of the set. |
last - Int
|
Only read the last n values of the set. |
offset - Int
|
Skip the first n values from our after cursor, an alternative to cursor based pagination. May not be used with last. |
before - Cursor
|
Read all values in the set before (above) this cursor. |
after - Cursor
|
Read all values in the set after (below) this cursor. |
orderBy - [DistributionCustomFieldsOrderBy!]
|
The method to use when ordering DistributionCustomField. Default = [PRIMARY_KEY_ASC] |
condition - DistributionCustomFieldCondition
|
A condition to be used in determining which values should be returned by the collection. |
filter - DistributionCustomFieldFilter
|
A filter to be used in determining which values should be returned by the collection. |
Example
Query
query allDistributionCustomFields(
$first: Int,
$last: Int,
$offset: Int,
$before: Cursor,
$after: Cursor,
$orderBy: [DistributionCustomFieldsOrderBy!],
$condition: DistributionCustomFieldCondition,
$filter: DistributionCustomFieldFilter
) {
allDistributionCustomFields(
first: $first,
last: $last,
offset: $offset,
before: $before,
after: $after,
orderBy: $orderBy,
condition: $condition,
filter: $filter
) {
nodes {
...DistributionCustomFieldFragment
}
edges {
...DistributionCustomFieldsEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"first": 123,
"last": 123,
"offset": 987,
"before": Cursor,
"after": Cursor,
"orderBy": ["PRIMARY_KEY_ASC"],
"condition": DistributionCustomFieldCondition,
"filter": DistributionCustomFieldFilter
}
Response
{
"data": {
"allDistributionCustomFields": {
"nodes": [DistributionCustomField],
"edges": [DistributionCustomFieldsEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
}
}
allDistributionPaymentStatuses
Description
Reads and enables pagination through a set of DistributionPaymentStatus.
Response
Returns a DistributionPaymentStatusesConnection
Arguments
| Name | Description |
|---|---|
first - Int
|
Only read the first n values of the set. |
last - Int
|
Only read the last n values of the set. |
offset - Int
|
Skip the first n values from our after cursor, an alternative to cursor based pagination. May not be used with last. |
before - Cursor
|
Read all values in the set before (above) this cursor. |
after - Cursor
|
Read all values in the set after (below) this cursor. |
orderBy - [DistributionPaymentStatusesOrderBy!]
|
The method to use when ordering DistributionPaymentStatus. Default = [PRIMARY_KEY_ASC] |
condition - DistributionPaymentStatusCondition
|
A condition to be used in determining which values should be returned by the collection. |
filter - DistributionPaymentStatusFilter
|
A filter to be used in determining which values should be returned by the collection. |
Example
Query
query allDistributionPaymentStatuses(
$first: Int,
$last: Int,
$offset: Int,
$before: Cursor,
$after: Cursor,
$orderBy: [DistributionPaymentStatusesOrderBy!],
$condition: DistributionPaymentStatusCondition,
$filter: DistributionPaymentStatusFilter
) {
allDistributionPaymentStatuses(
first: $first,
last: $last,
offset: $offset,
before: $before,
after: $after,
orderBy: $orderBy,
condition: $condition,
filter: $filter
) {
nodes {
...DistributionPaymentStatusFragment
}
edges {
...DistributionPaymentStatusesEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"first": 123,
"last": 123,
"offset": 123,
"before": Cursor,
"after": Cursor,
"orderBy": ["PRIMARY_KEY_ASC"],
"condition": DistributionPaymentStatusCondition,
"filter": DistributionPaymentStatusFilter
}
Response
{
"data": {
"allDistributionPaymentStatuses": {
"nodes": [DistributionPaymentStatus],
"edges": [DistributionPaymentStatusesEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
}
}
allDistributionPayments
Description
Reads and enables pagination through a set of DistributionPayment.
Response
Returns a DistributionPaymentsConnection
Arguments
| Name | Description |
|---|---|
first - Int
|
Only read the first n values of the set. |
last - Int
|
Only read the last n values of the set. |
offset - Int
|
Skip the first n values from our after cursor, an alternative to cursor based pagination. May not be used with last. |
before - Cursor
|
Read all values in the set before (above) this cursor. |
after - Cursor
|
Read all values in the set after (below) this cursor. |
orderBy - [DistributionPaymentsOrderBy!]
|
The method to use when ordering DistributionPayment. Default = [PRIMARY_KEY_ASC] |
condition - DistributionPaymentCondition
|
A condition to be used in determining which values should be returned by the collection. |
filter - DistributionPaymentFilter
|
A filter to be used in determining which values should be returned by the collection. |
Example
Query
query allDistributionPayments(
$first: Int,
$last: Int,
$offset: Int,
$before: Cursor,
$after: Cursor,
$orderBy: [DistributionPaymentsOrderBy!],
$condition: DistributionPaymentCondition,
$filter: DistributionPaymentFilter
) {
allDistributionPayments(
first: $first,
last: $last,
offset: $offset,
before: $before,
after: $after,
orderBy: $orderBy,
condition: $condition,
filter: $filter
) {
nodes {
...DistributionPaymentFragment
}
edges {
...DistributionPaymentsEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"first": 123,
"last": 987,
"offset": 987,
"before": Cursor,
"after": Cursor,
"orderBy": ["PRIMARY_KEY_ASC"],
"condition": DistributionPaymentCondition,
"filter": DistributionPaymentFilter
}
Response
{
"data": {
"allDistributionPayments": {
"nodes": [DistributionPayment],
"edges": [DistributionPaymentsEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
}
}
allDistributionPrices
Description
Reads and enables pagination through a set of DistributionPrice.
Response
Returns a DistributionPricesConnection
Arguments
| Name | Description |
|---|---|
first - Int
|
Only read the first n values of the set. |
last - Int
|
Only read the last n values of the set. |
offset - Int
|
Skip the first n values from our after cursor, an alternative to cursor based pagination. May not be used with last. |
before - Cursor
|
Read all values in the set before (above) this cursor. |
after - Cursor
|
Read all values in the set after (below) this cursor. |
orderBy - [DistributionPricesOrderBy!]
|
The method to use when ordering DistributionPrice. Default = [PRIMARY_KEY_ASC] |
condition - DistributionPriceCondition
|
A condition to be used in determining which values should be returned by the collection. |
filter - DistributionPriceFilter
|
A filter to be used in determining which values should be returned by the collection. |
Example
Query
query allDistributionPrices(
$first: Int,
$last: Int,
$offset: Int,
$before: Cursor,
$after: Cursor,
$orderBy: [DistributionPricesOrderBy!],
$condition: DistributionPriceCondition,
$filter: DistributionPriceFilter
) {
allDistributionPrices(
first: $first,
last: $last,
offset: $offset,
before: $before,
after: $after,
orderBy: $orderBy,
condition: $condition,
filter: $filter
) {
nodes {
...DistributionPriceFragment
}
edges {
...DistributionPricesEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"first": 123,
"last": 123,
"offset": 987,
"before": Cursor,
"after": Cursor,
"orderBy": ["PRIMARY_KEY_ASC"],
"condition": DistributionPriceCondition,
"filter": DistributionPriceFilter
}
Response
{
"data": {
"allDistributionPrices": {
"nodes": [DistributionPrice],
"edges": [DistributionPricesEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
}
}
allDistributionQualifications
Description
Reads and enables pagination through a set of DistributionQualification.
Response
Returns a DistributionQualificationsConnection
Arguments
| Name | Description |
|---|---|
first - Int
|
Only read the first n values of the set. |
last - Int
|
Only read the last n values of the set. |
offset - Int
|
Skip the first n values from our after cursor, an alternative to cursor based pagination. May not be used with last. |
before - Cursor
|
Read all values in the set before (above) this cursor. |
after - Cursor
|
Read all values in the set after (below) this cursor. |
orderBy - [DistributionQualificationsOrderBy!]
|
The method to use when ordering DistributionQualification. Default = [PRIMARY_KEY_ASC] |
condition - DistributionQualificationCondition
|
A condition to be used in determining which values should be returned by the collection. |
filter - DistributionQualificationFilter
|
A filter to be used in determining which values should be returned by the collection. |
Example
Query
query allDistributionQualifications(
$first: Int,
$last: Int,
$offset: Int,
$before: Cursor,
$after: Cursor,
$orderBy: [DistributionQualificationsOrderBy!],
$condition: DistributionQualificationCondition,
$filter: DistributionQualificationFilter
) {
allDistributionQualifications(
first: $first,
last: $last,
offset: $offset,
before: $before,
after: $after,
orderBy: $orderBy,
condition: $condition,
filter: $filter
) {
nodes {
...DistributionQualificationFragment
}
edges {
...DistributionQualificationsEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"first": 123,
"last": 123,
"offset": 987,
"before": Cursor,
"after": Cursor,
"orderBy": ["PRIMARY_KEY_ASC"],
"condition": DistributionQualificationCondition,
"filter": DistributionQualificationFilter
}
Response
{
"data": {
"allDistributionQualifications": {
"nodes": [DistributionQualification],
"edges": [DistributionQualificationsEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
}
}
allDistributionStatuses
Description
Reads and enables pagination through a set of DistributionStatus.
Response
Returns a DistributionStatusesConnection
Arguments
| Name | Description |
|---|---|
first - Int
|
Only read the first n values of the set. |
last - Int
|
Only read the last n values of the set. |
offset - Int
|
Skip the first n values from our after cursor, an alternative to cursor based pagination. May not be used with last. |
before - Cursor
|
Read all values in the set before (above) this cursor. |
after - Cursor
|
Read all values in the set after (below) this cursor. |
orderBy - [DistributionStatusesOrderBy!]
|
The method to use when ordering DistributionStatus. Default = [PRIMARY_KEY_ASC] |
condition - DistributionStatusCondition
|
A condition to be used in determining which values should be returned by the collection. |
filter - DistributionStatusFilter
|
A filter to be used in determining which values should be returned by the collection. |
Example
Query
query allDistributionStatuses(
$first: Int,
$last: Int,
$offset: Int,
$before: Cursor,
$after: Cursor,
$orderBy: [DistributionStatusesOrderBy!],
$condition: DistributionStatusCondition,
$filter: DistributionStatusFilter
) {
allDistributionStatuses(
first: $first,
last: $last,
offset: $offset,
before: $before,
after: $after,
orderBy: $orderBy,
condition: $condition,
filter: $filter
) {
nodes {
...DistributionStatusFragment
}
edges {
...DistributionStatusesEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"first": 123,
"last": 123,
"offset": 987,
"before": Cursor,
"after": Cursor,
"orderBy": ["PRIMARY_KEY_ASC"],
"condition": DistributionStatusCondition,
"filter": DistributionStatusFilter
}
Response
{
"data": {
"allDistributionStatuses": {
"nodes": [DistributionStatus],
"edges": [DistributionStatusesEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
}
}
allDistributions
Description
Reads and enables pagination through a set of Distribution.
Response
Returns a DistributionsConnection
Arguments
| Name | Description |
|---|---|
first - Int
|
Only read the first n values of the set. |
last - Int
|
Only read the last n values of the set. |
offset - Int
|
Skip the first n values from our after cursor, an alternative to cursor based pagination. May not be used with last. |
before - Cursor
|
Read all values in the set before (above) this cursor. |
after - Cursor
|
Read all values in the set after (below) this cursor. |
orderBy - [DistributionsOrderBy!]
|
The method to use when ordering Distribution. Default = [PRIMARY_KEY_ASC] |
condition - DistributionCondition
|
A condition to be used in determining which values should be returned by the collection. |
filter - DistributionFilter
|
A filter to be used in determining which values should be returned by the collection. |
Example
Query
query allDistributions(
$first: Int,
$last: Int,
$offset: Int,
$before: Cursor,
$after: Cursor,
$orderBy: [DistributionsOrderBy!],
$condition: DistributionCondition,
$filter: DistributionFilter
) {
allDistributions(
first: $first,
last: $last,
offset: $offset,
before: $before,
after: $after,
orderBy: $orderBy,
condition: $condition,
filter: $filter
) {
nodes {
...DistributionFragment
}
edges {
...DistributionsEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"first": 123,
"last": 123,
"offset": 123,
"before": Cursor,
"after": Cursor,
"orderBy": ["PRIMARY_KEY_ASC"],
"condition": DistributionCondition,
"filter": DistributionFilter
}
Response
{
"data": {
"allDistributions": {
"nodes": [Distribution],
"edges": [DistributionsEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
}
}
allDocumentSharingRoles
Description
Reads and enables pagination through a set of DocumentSharingRole.
Response
Returns a DocumentSharingRolesConnection
Arguments
| Name | Description |
|---|---|
first - Int
|
Only read the first n values of the set. |
last - Int
|
Only read the last n values of the set. |
offset - Int
|
Skip the first n values from our after cursor, an alternative to cursor based pagination. May not be used with last. |
before - Cursor
|
Read all values in the set before (above) this cursor. |
after - Cursor
|
Read all values in the set after (below) this cursor. |
orderBy - [DocumentSharingRolesOrderBy!]
|
The method to use when ordering DocumentSharingRole. Default = [PRIMARY_KEY_ASC] |
condition - DocumentSharingRoleCondition
|
A condition to be used in determining which values should be returned by the collection. |
filter - DocumentSharingRoleFilter
|
A filter to be used in determining which values should be returned by the collection. |
Example
Query
query allDocumentSharingRoles(
$first: Int,
$last: Int,
$offset: Int,
$before: Cursor,
$after: Cursor,
$orderBy: [DocumentSharingRolesOrderBy!],
$condition: DocumentSharingRoleCondition,
$filter: DocumentSharingRoleFilter
) {
allDocumentSharingRoles(
first: $first,
last: $last,
offset: $offset,
before: $before,
after: $after,
orderBy: $orderBy,
condition: $condition,
filter: $filter
) {
nodes {
...DocumentSharingRoleFragment
}
edges {
...DocumentSharingRolesEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"first": 123,
"last": 987,
"offset": 123,
"before": Cursor,
"after": Cursor,
"orderBy": ["PRIMARY_KEY_ASC"],
"condition": DocumentSharingRoleCondition,
"filter": DocumentSharingRoleFilter
}
Response
{
"data": {
"allDocumentSharingRoles": {
"nodes": [DocumentSharingRole],
"edges": [DocumentSharingRolesEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
}
}
allDocumentSharings
Description
Reads and enables pagination through a set of DocumentSharing.
Response
Returns a DocumentSharingsConnection
Arguments
| Name | Description |
|---|---|
first - Int
|
Only read the first n values of the set. |
last - Int
|
Only read the last n values of the set. |
offset - Int
|
Skip the first n values from our after cursor, an alternative to cursor based pagination. May not be used with last. |
before - Cursor
|
Read all values in the set before (above) this cursor. |
after - Cursor
|
Read all values in the set after (below) this cursor. |
orderBy - [DocumentSharingsOrderBy!]
|
The method to use when ordering DocumentSharing. Default = [PRIMARY_KEY_ASC] |
condition - DocumentSharingCondition
|
A condition to be used in determining which values should be returned by the collection. |
filter - DocumentSharingFilter
|
A filter to be used in determining which values should be returned by the collection. |
Example
Query
query allDocumentSharings(
$first: Int,
$last: Int,
$offset: Int,
$before: Cursor,
$after: Cursor,
$orderBy: [DocumentSharingsOrderBy!],
$condition: DocumentSharingCondition,
$filter: DocumentSharingFilter
) {
allDocumentSharings(
first: $first,
last: $last,
offset: $offset,
before: $before,
after: $after,
orderBy: $orderBy,
condition: $condition,
filter: $filter
) {
nodes {
...DocumentSharingFragment
}
edges {
...DocumentSharingsEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"first": 987,
"last": 123,
"offset": 123,
"before": Cursor,
"after": Cursor,
"orderBy": ["PRIMARY_KEY_ASC"],
"condition": DocumentSharingCondition,
"filter": DocumentSharingFilter
}
Response
{
"data": {
"allDocumentSharings": {
"nodes": [DocumentSharing],
"edges": [DocumentSharingsEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
}
}
allDocumentStatuses
Description
Reads and enables pagination through a set of DocumentStatus.
Response
Returns a DocumentStatusesConnection
Arguments
| Name | Description |
|---|---|
first - Int
|
Only read the first n values of the set. |
last - Int
|
Only read the last n values of the set. |
offset - Int
|
Skip the first n values from our after cursor, an alternative to cursor based pagination. May not be used with last. |
before - Cursor
|
Read all values in the set before (above) this cursor. |
after - Cursor
|
Read all values in the set after (below) this cursor. |
orderBy - [DocumentStatusesOrderBy!]
|
The method to use when ordering DocumentStatus. Default = [PRIMARY_KEY_ASC] |
condition - DocumentStatusCondition
|
A condition to be used in determining which values should be returned by the collection. |
filter - DocumentStatusFilter
|
A filter to be used in determining which values should be returned by the collection. |
Example
Query
query allDocumentStatuses(
$first: Int,
$last: Int,
$offset: Int,
$before: Cursor,
$after: Cursor,
$orderBy: [DocumentStatusesOrderBy!],
$condition: DocumentStatusCondition,
$filter: DocumentStatusFilter
) {
allDocumentStatuses(
first: $first,
last: $last,
offset: $offset,
before: $before,
after: $after,
orderBy: $orderBy,
condition: $condition,
filter: $filter
) {
nodes {
...DocumentStatusFragment
}
edges {
...DocumentStatusesEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"first": 123,
"last": 987,
"offset": 987,
"before": Cursor,
"after": Cursor,
"orderBy": ["PRIMARY_KEY_ASC"],
"condition": DocumentStatusCondition,
"filter": DocumentStatusFilter
}
Response
{
"data": {
"allDocumentStatuses": {
"nodes": [DocumentStatus],
"edges": [DocumentStatusesEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
}
}
allDocumentTypes
Description
Reads and enables pagination through a set of DocumentType.
Response
Returns a DocumentTypesConnection
Arguments
| Name | Description |
|---|---|
first - Int
|
Only read the first n values of the set. |
last - Int
|
Only read the last n values of the set. |
offset - Int
|
Skip the first n values from our after cursor, an alternative to cursor based pagination. May not be used with last. |
before - Cursor
|
Read all values in the set before (above) this cursor. |
after - Cursor
|
Read all values in the set after (below) this cursor. |
orderBy - [DocumentTypesOrderBy!]
|
The method to use when ordering DocumentType. Default = [PRIMARY_KEY_ASC] |
condition - DocumentTypeCondition
|
A condition to be used in determining which values should be returned by the collection. |
filter - DocumentTypeFilter
|
A filter to be used in determining which values should be returned by the collection. |
Example
Query
query allDocumentTypes(
$first: Int,
$last: Int,
$offset: Int,
$before: Cursor,
$after: Cursor,
$orderBy: [DocumentTypesOrderBy!],
$condition: DocumentTypeCondition,
$filter: DocumentTypeFilter
) {
allDocumentTypes(
first: $first,
last: $last,
offset: $offset,
before: $before,
after: $after,
orderBy: $orderBy,
condition: $condition,
filter: $filter
) {
nodes {
...DocumentTypeFragment
}
edges {
...DocumentTypesEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"first": 123,
"last": 123,
"offset": 123,
"before": Cursor,
"after": Cursor,
"orderBy": ["PRIMARY_KEY_ASC"],
"condition": DocumentTypeCondition,
"filter": DocumentTypeFilter
}
Response
{
"data": {
"allDocumentTypes": {
"nodes": [DocumentType],
"edges": [DocumentTypesEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
}
}
allDocuments
Description
Reads and enables pagination through a set of Document.
Response
Returns a DocumentsConnection
Arguments
| Name | Description |
|---|---|
first - Int
|
Only read the first n values of the set. |
last - Int
|
Only read the last n values of the set. |
offset - Int
|
Skip the first n values from our after cursor, an alternative to cursor based pagination. May not be used with last. |
before - Cursor
|
Read all values in the set before (above) this cursor. |
after - Cursor
|
Read all values in the set after (below) this cursor. |
orderBy - [DocumentsOrderBy!]
|
The method to use when ordering Document. Default = [PRIMARY_KEY_ASC] |
condition - DocumentCondition
|
A condition to be used in determining which values should be returned by the collection. |
filter - DocumentFilter
|
A filter to be used in determining which values should be returned by the collection. |
Example
Query
query allDocuments(
$first: Int,
$last: Int,
$offset: Int,
$before: Cursor,
$after: Cursor,
$orderBy: [DocumentsOrderBy!],
$condition: DocumentCondition,
$filter: DocumentFilter
) {
allDocuments(
first: $first,
last: $last,
offset: $offset,
before: $before,
after: $after,
orderBy: $orderBy,
condition: $condition,
filter: $filter
) {
nodes {
...DocumentFragment
}
edges {
...DocumentsEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"first": 123,
"last": 987,
"offset": 987,
"before": Cursor,
"after": Cursor,
"orderBy": ["PRIMARY_KEY_ASC"],
"condition": DocumentCondition,
"filter": DocumentFilter
}
Response
{
"data": {
"allDocuments": {
"nodes": [Document],
"edges": [DocumentsEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
}
}
allEmailTemplateTos
Description
Reads and enables pagination through a set of EmailTemplateTo.
Response
Returns an EmailTemplateTosConnection
Arguments
| Name | Description |
|---|---|
first - Int
|
Only read the first n values of the set. |
last - Int
|
Only read the last n values of the set. |
offset - Int
|
Skip the first n values from our after cursor, an alternative to cursor based pagination. May not be used with last. |
before - Cursor
|
Read all values in the set before (above) this cursor. |
after - Cursor
|
Read all values in the set after (below) this cursor. |
orderBy - [EmailTemplateTosOrderBy!]
|
The method to use when ordering EmailTemplateTo. Default = [PRIMARY_KEY_ASC] |
condition - EmailTemplateToCondition
|
A condition to be used in determining which values should be returned by the collection. |
filter - EmailTemplateToFilter
|
A filter to be used in determining which values should be returned by the collection. |
Example
Query
query allEmailTemplateTos(
$first: Int,
$last: Int,
$offset: Int,
$before: Cursor,
$after: Cursor,
$orderBy: [EmailTemplateTosOrderBy!],
$condition: EmailTemplateToCondition,
$filter: EmailTemplateToFilter
) {
allEmailTemplateTos(
first: $first,
last: $last,
offset: $offset,
before: $before,
after: $after,
orderBy: $orderBy,
condition: $condition,
filter: $filter
) {
nodes {
...EmailTemplateToFragment
}
edges {
...EmailTemplateTosEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"first": 123,
"last": 123,
"offset": 123,
"before": Cursor,
"after": Cursor,
"orderBy": ["PRIMARY_KEY_ASC"],
"condition": EmailTemplateToCondition,
"filter": EmailTemplateToFilter
}
Response
{
"data": {
"allEmailTemplateTos": {
"nodes": [EmailTemplateTo],
"edges": [EmailTemplateTosEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
}
}
allEmails
Description
Reads and enables pagination through a set of Email.
Response
Returns an EmailsConnection
Arguments
| Name | Description |
|---|---|
first - Int
|
Only read the first n values of the set. |
last - Int
|
Only read the last n values of the set. |
offset - Int
|
Skip the first n values from our after cursor, an alternative to cursor based pagination. May not be used with last. |
before - Cursor
|
Read all values in the set before (above) this cursor. |
after - Cursor
|
Read all values in the set after (below) this cursor. |
orderBy - [EmailsOrderBy!]
|
The method to use when ordering Email. Default = [PRIMARY_KEY_ASC] |
condition - EmailCondition
|
A condition to be used in determining which values should be returned by the collection. |
filter - EmailFilter
|
A filter to be used in determining which values should be returned by the collection. |
Example
Query
query allEmails(
$first: Int,
$last: Int,
$offset: Int,
$before: Cursor,
$after: Cursor,
$orderBy: [EmailsOrderBy!],
$condition: EmailCondition,
$filter: EmailFilter
) {
allEmails(
first: $first,
last: $last,
offset: $offset,
before: $before,
after: $after,
orderBy: $orderBy,
condition: $condition,
filter: $filter
) {
nodes {
...EmailFragment
}
edges {
...EmailsEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"first": 987,
"last": 123,
"offset": 987,
"before": Cursor,
"after": Cursor,
"orderBy": ["PRIMARY_KEY_ASC"],
"condition": EmailCondition,
"filter": EmailFilter
}
Response
{
"data": {
"allEmails": {
"nodes": [Email],
"edges": [EmailsEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
}
}
allFullHoldings
Description
Reads and enables pagination through a set of FullHolding.
Response
Returns a FullHoldingsConnection
Arguments
| Name | Description |
|---|---|
first - Int
|
Only read the first n values of the set. |
last - Int
|
Only read the last n values of the set. |
offset - Int
|
Skip the first n values from our after cursor, an alternative to cursor based pagination. May not be used with last. |
before - Cursor
|
Read all values in the set before (above) this cursor. |
after - Cursor
|
Read all values in the set after (below) this cursor. |
orderBy - [FullHoldingsOrderBy!]
|
The method to use when ordering FullHolding. Default = [NATURAL] |
condition - FullHoldingCondition
|
A condition to be used in determining which values should be returned by the collection. |
filter - FullHoldingFilter
|
A filter to be used in determining which values should be returned by the collection. |
Example
Query
query allFullHoldings(
$first: Int,
$last: Int,
$offset: Int,
$before: Cursor,
$after: Cursor,
$orderBy: [FullHoldingsOrderBy!],
$condition: FullHoldingCondition,
$filter: FullHoldingFilter
) {
allFullHoldings(
first: $first,
last: $last,
offset: $offset,
before: $before,
after: $after,
orderBy: $orderBy,
condition: $condition,
filter: $filter
) {
nodes {
...FullHoldingFragment
}
edges {
...FullHoldingsEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"first": 123,
"last": 987,
"offset": 123,
"before": Cursor,
"after": Cursor,
"orderBy": ["NATURAL"],
"condition": FullHoldingCondition,
"filter": FullHoldingFilter
}
Response
{
"data": {
"allFullHoldings": {
"nodes": [FullHolding],
"edges": [FullHoldingsEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
}
}
allHoldingBlockchainAddressStatuses
Description
Reads and enables pagination through a set of HoldingBlockchainAddressStatus.
Response
Arguments
| Name | Description |
|---|---|
first - Int
|
Only read the first n values of the set. |
last - Int
|
Only read the last n values of the set. |
offset - Int
|
Skip the first n values from our after cursor, an alternative to cursor based pagination. May not be used with last. |
before - Cursor
|
Read all values in the set before (above) this cursor. |
after - Cursor
|
Read all values in the set after (below) this cursor. |
orderBy - [HoldingBlockchainAddressStatusesOrderBy!]
|
The method to use when ordering HoldingBlockchainAddressStatus. Default = [PRIMARY_KEY_ASC] |
condition - HoldingBlockchainAddressStatusCondition
|
A condition to be used in determining which values should be returned by the collection. |
filter - HoldingBlockchainAddressStatusFilter
|
A filter to be used in determining which values should be returned by the collection. |
Example
Query
query allHoldingBlockchainAddressStatuses(
$first: Int,
$last: Int,
$offset: Int,
$before: Cursor,
$after: Cursor,
$orderBy: [HoldingBlockchainAddressStatusesOrderBy!],
$condition: HoldingBlockchainAddressStatusCondition,
$filter: HoldingBlockchainAddressStatusFilter
) {
allHoldingBlockchainAddressStatuses(
first: $first,
last: $last,
offset: $offset,
before: $before,
after: $after,
orderBy: $orderBy,
condition: $condition,
filter: $filter
) {
nodes {
...HoldingBlockchainAddressStatusFragment
}
edges {
...HoldingBlockchainAddressStatusesEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"first": 987,
"last": 987,
"offset": 123,
"before": Cursor,
"after": Cursor,
"orderBy": ["PRIMARY_KEY_ASC"],
"condition": HoldingBlockchainAddressStatusCondition,
"filter": HoldingBlockchainAddressStatusFilter
}
Response
{
"data": {
"allHoldingBlockchainAddressStatuses": {
"nodes": [HoldingBlockchainAddressStatus],
"edges": [HoldingBlockchainAddressStatusesEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
}
}
allHoldingBlockchainAddresses
Description
Reads and enables pagination through a set of HoldingBlockchainAddress.
Response
Returns a HoldingBlockchainAddressesConnection
Arguments
| Name | Description |
|---|---|
first - Int
|
Only read the first n values of the set. |
last - Int
|
Only read the last n values of the set. |
offset - Int
|
Skip the first n values from our after cursor, an alternative to cursor based pagination. May not be used with last. |
before - Cursor
|
Read all values in the set before (above) this cursor. |
after - Cursor
|
Read all values in the set after (below) this cursor. |
orderBy - [HoldingBlockchainAddressesOrderBy!]
|
The method to use when ordering HoldingBlockchainAddress. Default = [PRIMARY_KEY_ASC] |
condition - HoldingBlockchainAddressCondition
|
A condition to be used in determining which values should be returned by the collection. |
filter - HoldingBlockchainAddressFilter
|
A filter to be used in determining which values should be returned by the collection. |
Example
Query
query allHoldingBlockchainAddresses(
$first: Int,
$last: Int,
$offset: Int,
$before: Cursor,
$after: Cursor,
$orderBy: [HoldingBlockchainAddressesOrderBy!],
$condition: HoldingBlockchainAddressCondition,
$filter: HoldingBlockchainAddressFilter
) {
allHoldingBlockchainAddresses(
first: $first,
last: $last,
offset: $offset,
before: $before,
after: $after,
orderBy: $orderBy,
condition: $condition,
filter: $filter
) {
nodes {
...HoldingBlockchainAddressFragment
}
edges {
...HoldingBlockchainAddressesEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"first": 987,
"last": 987,
"offset": 123,
"before": Cursor,
"after": Cursor,
"orderBy": ["PRIMARY_KEY_ASC"],
"condition": HoldingBlockchainAddressCondition,
"filter": HoldingBlockchainAddressFilter
}
Response
{
"data": {
"allHoldingBlockchainAddresses": {
"nodes": [HoldingBlockchainAddress],
"edges": [HoldingBlockchainAddressesEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
}
}
allHoldingDocuments
Description
Reads and enables pagination through a set of HoldingDocument.
Response
Returns a HoldingDocumentsConnection
Arguments
| Name | Description |
|---|---|
first - Int
|
Only read the first n values of the set. |
last - Int
|
Only read the last n values of the set. |
offset - Int
|
Skip the first n values from our after cursor, an alternative to cursor based pagination. May not be used with last. |
before - Cursor
|
Read all values in the set before (above) this cursor. |
after - Cursor
|
Read all values in the set after (below) this cursor. |
orderBy - [HoldingDocumentsOrderBy!]
|
The method to use when ordering HoldingDocument. Default = [PRIMARY_KEY_ASC] |
condition - HoldingDocumentCondition
|
A condition to be used in determining which values should be returned by the collection. |
filter - HoldingDocumentFilter
|
A filter to be used in determining which values should be returned by the collection. |
Example
Query
query allHoldingDocuments(
$first: Int,
$last: Int,
$offset: Int,
$before: Cursor,
$after: Cursor,
$orderBy: [HoldingDocumentsOrderBy!],
$condition: HoldingDocumentCondition,
$filter: HoldingDocumentFilter
) {
allHoldingDocuments(
first: $first,
last: $last,
offset: $offset,
before: $before,
after: $after,
orderBy: $orderBy,
condition: $condition,
filter: $filter
) {
nodes {
...HoldingDocumentFragment
}
edges {
...HoldingDocumentsEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"first": 987,
"last": 987,
"offset": 987,
"before": Cursor,
"after": Cursor,
"orderBy": ["PRIMARY_KEY_ASC"],
"condition": HoldingDocumentCondition,
"filter": HoldingDocumentFilter
}
Response
{
"data": {
"allHoldingDocuments": {
"nodes": [HoldingDocument],
"edges": [HoldingDocumentsEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
}
}
allHoldings
Description
Reads and enables pagination through a set of Holding.
Response
Returns a HoldingsConnection
Arguments
| Name | Description |
|---|---|
first - Int
|
Only read the first n values of the set. |
last - Int
|
Only read the last n values of the set. |
offset - Int
|
Skip the first n values from our after cursor, an alternative to cursor based pagination. May not be used with last. |
before - Cursor
|
Read all values in the set before (above) this cursor. |
after - Cursor
|
Read all values in the set after (below) this cursor. |
orderBy - [HoldingsOrderBy!]
|
The method to use when ordering Holding. Default = [PRIMARY_KEY_ASC] |
condition - HoldingCondition
|
A condition to be used in determining which values should be returned by the collection. |
filter - HoldingFilter
|
A filter to be used in determining which values should be returned by the collection. |
Example
Query
query allHoldings(
$first: Int,
$last: Int,
$offset: Int,
$before: Cursor,
$after: Cursor,
$orderBy: [HoldingsOrderBy!],
$condition: HoldingCondition,
$filter: HoldingFilter
) {
allHoldings(
first: $first,
last: $last,
offset: $offset,
before: $before,
after: $after,
orderBy: $orderBy,
condition: $condition,
filter: $filter
) {
nodes {
...HoldingFragment
}
edges {
...HoldingsEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"first": 987,
"last": 987,
"offset": 987,
"before": Cursor,
"after": Cursor,
"orderBy": ["PRIMARY_KEY_ASC"],
"condition": HoldingCondition,
"filter": HoldingFilter
}
Response
{
"data": {
"allHoldings": {
"nodes": [Holding],
"edges": [HoldingsEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
}
}
allIdempotentTypes
Description
Reads and enables pagination through a set of IdempotentType.
Response
Returns an IdempotentTypesConnection
Arguments
| Name | Description |
|---|---|
first - Int
|
Only read the first n values of the set. |
last - Int
|
Only read the last n values of the set. |
offset - Int
|
Skip the first n values from our after cursor, an alternative to cursor based pagination. May not be used with last. |
before - Cursor
|
Read all values in the set before (above) this cursor. |
after - Cursor
|
Read all values in the set after (below) this cursor. |
orderBy - [IdempotentTypesOrderBy!]
|
The method to use when ordering IdempotentType. Default = [NATURAL] |
condition - IdempotentTypeCondition
|
A condition to be used in determining which values should be returned by the collection. |
filter - IdempotentTypeFilter
|
A filter to be used in determining which values should be returned by the collection. |
Example
Query
query allIdempotentTypes(
$first: Int,
$last: Int,
$offset: Int,
$before: Cursor,
$after: Cursor,
$orderBy: [IdempotentTypesOrderBy!],
$condition: IdempotentTypeCondition,
$filter: IdempotentTypeFilter
) {
allIdempotentTypes(
first: $first,
last: $last,
offset: $offset,
before: $before,
after: $after,
orderBy: $orderBy,
condition: $condition,
filter: $filter
) {
nodes {
...IdempotentTypeFragment
}
edges {
...IdempotentTypesEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"first": 123,
"last": 987,
"offset": 987,
"before": Cursor,
"after": Cursor,
"orderBy": ["NATURAL"],
"condition": IdempotentTypeCondition,
"filter": IdempotentTypeFilter
}
Response
{
"data": {
"allIdempotentTypes": {
"nodes": [IdempotentType],
"edges": [IdempotentTypesEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
}
}
allIdempotents
Description
Reads and enables pagination through a set of Idempotent.
Response
Returns an IdempotentsConnection
Arguments
| Name | Description |
|---|---|
first - Int
|
Only read the first n values of the set. |
last - Int
|
Only read the last n values of the set. |
offset - Int
|
Skip the first n values from our after cursor, an alternative to cursor based pagination. May not be used with last. |
before - Cursor
|
Read all values in the set before (above) this cursor. |
after - Cursor
|
Read all values in the set after (below) this cursor. |
orderBy - [IdempotentsOrderBy!]
|
The method to use when ordering Idempotent. Default = [NATURAL] |
condition - IdempotentCondition
|
A condition to be used in determining which values should be returned by the collection. |
filter - IdempotentFilter
|
A filter to be used in determining which values should be returned by the collection. |
Example
Query
query allIdempotents(
$first: Int,
$last: Int,
$offset: Int,
$before: Cursor,
$after: Cursor,
$orderBy: [IdempotentsOrderBy!],
$condition: IdempotentCondition,
$filter: IdempotentFilter
) {
allIdempotents(
first: $first,
last: $last,
offset: $offset,
before: $before,
after: $after,
orderBy: $orderBy,
condition: $condition,
filter: $filter
) {
nodes {
...IdempotentFragment
}
edges {
...IdempotentsEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"first": 987,
"last": 123,
"offset": 123,
"before": Cursor,
"after": Cursor,
"orderBy": ["NATURAL"],
"condition": IdempotentCondition,
"filter": IdempotentFilter
}
Response
{
"data": {
"allIdempotents": {
"nodes": [Idempotent],
"edges": [IdempotentsEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
}
}
allInstancedAccountInformations
Description
Reads and enables pagination through a set of InstancedAccountInformation.
Response
Returns an InstancedAccountInformationsConnection
Arguments
| Name | Description |
|---|---|
first - Int
|
Only read the first n values of the set. |
last - Int
|
Only read the last n values of the set. |
offset - Int
|
Skip the first n values from our after cursor, an alternative to cursor based pagination. May not be used with last. |
before - Cursor
|
Read all values in the set before (above) this cursor. |
after - Cursor
|
Read all values in the set after (below) this cursor. |
orderBy - [InstancedAccountInformationsOrderBy!]
|
The method to use when ordering InstancedAccountInformation. Default = [PRIMARY_KEY_ASC] |
condition - InstancedAccountInformationCondition
|
A condition to be used in determining which values should be returned by the collection. |
filter - InstancedAccountInformationFilter
|
A filter to be used in determining which values should be returned by the collection. |
Example
Query
query allInstancedAccountInformations(
$first: Int,
$last: Int,
$offset: Int,
$before: Cursor,
$after: Cursor,
$orderBy: [InstancedAccountInformationsOrderBy!],
$condition: InstancedAccountInformationCondition,
$filter: InstancedAccountInformationFilter
) {
allInstancedAccountInformations(
first: $first,
last: $last,
offset: $offset,
before: $before,
after: $after,
orderBy: $orderBy,
condition: $condition,
filter: $filter
) {
nodes {
...InstancedAccountInformationFragment
}
edges {
...InstancedAccountInformationsEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"first": 987,
"last": 987,
"offset": 123,
"before": Cursor,
"after": Cursor,
"orderBy": ["PRIMARY_KEY_ASC"],
"condition": InstancedAccountInformationCondition,
"filter": InstancedAccountInformationFilter
}
Response
{
"data": {
"allInstancedAccountInformations": {
"nodes": [InstancedAccountInformation],
"edges": [InstancedAccountInformationsEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
}
}
allInstancedMappingFields
Description
Reads and enables pagination through a set of InstancedMappingField.
Response
Returns an InstancedMappingFieldsConnection
Arguments
| Name | Description |
|---|---|
first - Int
|
Only read the first n values of the set. |
last - Int
|
Only read the last n values of the set. |
offset - Int
|
Skip the first n values from our after cursor, an alternative to cursor based pagination. May not be used with last. |
before - Cursor
|
Read all values in the set before (above) this cursor. |
after - Cursor
|
Read all values in the set after (below) this cursor. |
orderBy - [InstancedMappingFieldsOrderBy!]
|
The method to use when ordering InstancedMappingField. Default = [PRIMARY_KEY_ASC] |
condition - InstancedMappingFieldCondition
|
A condition to be used in determining which values should be returned by the collection. |
filter - InstancedMappingFieldFilter
|
A filter to be used in determining which values should be returned by the collection. |
Example
Query
query allInstancedMappingFields(
$first: Int,
$last: Int,
$offset: Int,
$before: Cursor,
$after: Cursor,
$orderBy: [InstancedMappingFieldsOrderBy!],
$condition: InstancedMappingFieldCondition,
$filter: InstancedMappingFieldFilter
) {
allInstancedMappingFields(
first: $first,
last: $last,
offset: $offset,
before: $before,
after: $after,
orderBy: $orderBy,
condition: $condition,
filter: $filter
) {
nodes {
...InstancedMappingFieldFragment
}
edges {
...InstancedMappingFieldsEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"first": 987,
"last": 987,
"offset": 123,
"before": Cursor,
"after": Cursor,
"orderBy": ["PRIMARY_KEY_ASC"],
"condition": InstancedMappingFieldCondition,
"filter": InstancedMappingFieldFilter
}
Response
{
"data": {
"allInstancedMappingFields": {
"nodes": [InstancedMappingField],
"edges": [InstancedMappingFieldsEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
}
}
allIntegrationPartners
Description
Reads and enables pagination through a set of IntegrationPartner.
Response
Returns an IntegrationPartnersConnection
Arguments
| Name | Description |
|---|---|
first - Int
|
Only read the first n values of the set. |
last - Int
|
Only read the last n values of the set. |
offset - Int
|
Skip the first n values from our after cursor, an alternative to cursor based pagination. May not be used with last. |
before - Cursor
|
Read all values in the set before (above) this cursor. |
after - Cursor
|
Read all values in the set after (below) this cursor. |
orderBy - [IntegrationPartnersOrderBy!]
|
The method to use when ordering IntegrationPartner. Default = [PRIMARY_KEY_ASC] |
condition - IntegrationPartnerCondition
|
A condition to be used in determining which values should be returned by the collection. |
filter - IntegrationPartnerFilter
|
A filter to be used in determining which values should be returned by the collection. |
Example
Query
query allIntegrationPartners(
$first: Int,
$last: Int,
$offset: Int,
$before: Cursor,
$after: Cursor,
$orderBy: [IntegrationPartnersOrderBy!],
$condition: IntegrationPartnerCondition,
$filter: IntegrationPartnerFilter
) {
allIntegrationPartners(
first: $first,
last: $last,
offset: $offset,
before: $before,
after: $after,
orderBy: $orderBy,
condition: $condition,
filter: $filter
) {
nodes {
...IntegrationPartnerFragment
}
edges {
...IntegrationPartnersEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"first": 123,
"last": 987,
"offset": 123,
"before": Cursor,
"after": Cursor,
"orderBy": ["PRIMARY_KEY_ASC"],
"condition": IntegrationPartnerCondition,
"filter": IntegrationPartnerFilter
}
Response
{
"data": {
"allIntegrationPartners": {
"nodes": [IntegrationPartner],
"edges": [IntegrationPartnersEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
}
}
allIntegrationTypes
Description
Reads and enables pagination through a set of IntegrationType.
Response
Returns an IntegrationTypesConnection
Arguments
| Name | Description |
|---|---|
first - Int
|
Only read the first n values of the set. |
last - Int
|
Only read the last n values of the set. |
offset - Int
|
Skip the first n values from our after cursor, an alternative to cursor based pagination. May not be used with last. |
before - Cursor
|
Read all values in the set before (above) this cursor. |
after - Cursor
|
Read all values in the set after (below) this cursor. |
orderBy - [IntegrationTypesOrderBy!]
|
The method to use when ordering IntegrationType. Default = [PRIMARY_KEY_ASC] |
condition - IntegrationTypeCondition
|
A condition to be used in determining which values should be returned by the collection. |
filter - IntegrationTypeFilter
|
A filter to be used in determining which values should be returned by the collection. |
Example
Query
query allIntegrationTypes(
$first: Int,
$last: Int,
$offset: Int,
$before: Cursor,
$after: Cursor,
$orderBy: [IntegrationTypesOrderBy!],
$condition: IntegrationTypeCondition,
$filter: IntegrationTypeFilter
) {
allIntegrationTypes(
first: $first,
last: $last,
offset: $offset,
before: $before,
after: $after,
orderBy: $orderBy,
condition: $condition,
filter: $filter
) {
nodes {
...IntegrationTypeFragment
}
edges {
...IntegrationTypesEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"first": 987,
"last": 123,
"offset": 123,
"before": Cursor,
"after": Cursor,
"orderBy": ["PRIMARY_KEY_ASC"],
"condition": IntegrationTypeCondition,
"filter": IntegrationTypeFilter
}
Response
{
"data": {
"allIntegrationTypes": {
"nodes": [IntegrationType],
"edges": [IntegrationTypesEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
}
}
allIntegrations
Description
Reads and enables pagination through a set of Integration.
Response
Returns an IntegrationsConnection
Arguments
| Name | Description |
|---|---|
first - Int
|
Only read the first n values of the set. |
last - Int
|
Only read the last n values of the set. |
offset - Int
|
Skip the first n values from our after cursor, an alternative to cursor based pagination. May not be used with last. |
before - Cursor
|
Read all values in the set before (above) this cursor. |
after - Cursor
|
Read all values in the set after (below) this cursor. |
orderBy - [IntegrationsOrderBy!]
|
The method to use when ordering Integration. Default = [PRIMARY_KEY_ASC] |
condition - IntegrationCondition
|
A condition to be used in determining which values should be returned by the collection. |
filter - IntegrationFilter
|
A filter to be used in determining which values should be returned by the collection. |
Example
Query
query allIntegrations(
$first: Int,
$last: Int,
$offset: Int,
$before: Cursor,
$after: Cursor,
$orderBy: [IntegrationsOrderBy!],
$condition: IntegrationCondition,
$filter: IntegrationFilter
) {
allIntegrations(
first: $first,
last: $last,
offset: $offset,
before: $before,
after: $after,
orderBy: $orderBy,
condition: $condition,
filter: $filter
) {
nodes {
...IntegrationFragment
}
edges {
...IntegrationsEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"first": 123,
"last": 987,
"offset": 987,
"before": Cursor,
"after": Cursor,
"orderBy": ["PRIMARY_KEY_ASC"],
"condition": IntegrationCondition,
"filter": IntegrationFilter
}
Response
{
"data": {
"allIntegrations": {
"nodes": [Integration],
"edges": [IntegrationsEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
}
}
allInvestorAccountTypes
Description
Reads and enables pagination through a set of InvestorAccountType.
Response
Returns an InvestorAccountTypesConnection
Arguments
| Name | Description |
|---|---|
first - Int
|
Only read the first n values of the set. |
last - Int
|
Only read the last n values of the set. |
offset - Int
|
Skip the first n values from our after cursor, an alternative to cursor based pagination. May not be used with last. |
before - Cursor
|
Read all values in the set before (above) this cursor. |
after - Cursor
|
Read all values in the set after (below) this cursor. |
orderBy - [InvestorAccountTypesOrderBy!]
|
The method to use when ordering InvestorAccountType. Default = [PRIMARY_KEY_ASC] |
condition - InvestorAccountTypeCondition
|
A condition to be used in determining which values should be returned by the collection. |
filter - InvestorAccountTypeFilter
|
A filter to be used in determining which values should be returned by the collection. |
Example
Query
query allInvestorAccountTypes(
$first: Int,
$last: Int,
$offset: Int,
$before: Cursor,
$after: Cursor,
$orderBy: [InvestorAccountTypesOrderBy!],
$condition: InvestorAccountTypeCondition,
$filter: InvestorAccountTypeFilter
) {
allInvestorAccountTypes(
first: $first,
last: $last,
offset: $offset,
before: $before,
after: $after,
orderBy: $orderBy,
condition: $condition,
filter: $filter
) {
nodes {
...InvestorAccountTypeFragment
}
edges {
...InvestorAccountTypesEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"first": 987,
"last": 123,
"offset": 123,
"before": Cursor,
"after": Cursor,
"orderBy": ["PRIMARY_KEY_ASC"],
"condition": InvestorAccountTypeCondition,
"filter": InvestorAccountTypeFilter
}
Response
{
"data": {
"allInvestorAccountTypes": {
"nodes": [InvestorAccountType],
"edges": [InvestorAccountTypesEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
}
}
allInvitationStatuses
Description
Reads and enables pagination through a set of InvitationStatus.
Response
Returns an InvitationStatusesConnection
Arguments
| Name | Description |
|---|---|
first - Int
|
Only read the first n values of the set. |
last - Int
|
Only read the last n values of the set. |
offset - Int
|
Skip the first n values from our after cursor, an alternative to cursor based pagination. May not be used with last. |
before - Cursor
|
Read all values in the set before (above) this cursor. |
after - Cursor
|
Read all values in the set after (below) this cursor. |
orderBy - [InvitationStatusesOrderBy!]
|
The method to use when ordering InvitationStatus. Default = [PRIMARY_KEY_ASC] |
condition - InvitationStatusCondition
|
A condition to be used in determining which values should be returned by the collection. |
filter - InvitationStatusFilter
|
A filter to be used in determining which values should be returned by the collection. |
Example
Query
query allInvitationStatuses(
$first: Int,
$last: Int,
$offset: Int,
$before: Cursor,
$after: Cursor,
$orderBy: [InvitationStatusesOrderBy!],
$condition: InvitationStatusCondition,
$filter: InvitationStatusFilter
) {
allInvitationStatuses(
first: $first,
last: $last,
offset: $offset,
before: $before,
after: $after,
orderBy: $orderBy,
condition: $condition,
filter: $filter
) {
nodes {
...InvitationStatusFragment
}
edges {
...InvitationStatusesEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"first": 123,
"last": 987,
"offset": 987,
"before": Cursor,
"after": Cursor,
"orderBy": ["PRIMARY_KEY_ASC"],
"condition": InvitationStatusCondition,
"filter": InvitationStatusFilter
}
Response
{
"data": {
"allInvitationStatuses": {
"nodes": [InvitationStatus],
"edges": [InvitationStatusesEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
}
}
allIssuanceEvents
Description
Reads and enables pagination through a set of IssuanceEvent.
Response
Returns an IssuanceEventsConnection
Arguments
| Name | Description |
|---|---|
first - Int
|
Only read the first n values of the set. |
last - Int
|
Only read the last n values of the set. |
offset - Int
|
Skip the first n values from our after cursor, an alternative to cursor based pagination. May not be used with last. |
before - Cursor
|
Read all values in the set before (above) this cursor. |
after - Cursor
|
Read all values in the set after (below) this cursor. |
orderBy - [IssuanceEventsOrderBy!]
|
The method to use when ordering IssuanceEvent. Default = [PRIMARY_KEY_ASC] |
condition - IssuanceEventCondition
|
A condition to be used in determining which values should be returned by the collection. |
filter - IssuanceEventFilter
|
A filter to be used in determining which values should be returned by the collection. |
Example
Query
query allIssuanceEvents(
$first: Int,
$last: Int,
$offset: Int,
$before: Cursor,
$after: Cursor,
$orderBy: [IssuanceEventsOrderBy!],
$condition: IssuanceEventCondition,
$filter: IssuanceEventFilter
) {
allIssuanceEvents(
first: $first,
last: $last,
offset: $offset,
before: $before,
after: $after,
orderBy: $orderBy,
condition: $condition,
filter: $filter
) {
nodes {
...IssuanceEventFragment
}
edges {
...IssuanceEventsEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"first": 987,
"last": 123,
"offset": 987,
"before": Cursor,
"after": Cursor,
"orderBy": ["PRIMARY_KEY_ASC"],
"condition": IssuanceEventCondition,
"filter": IssuanceEventFilter
}
Response
{
"data": {
"allIssuanceEvents": {
"nodes": [IssuanceEvent],
"edges": [IssuanceEventsEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
}
}
allLedgers
Description
Reads and enables pagination through a set of Ledger.
Response
Returns a LedgersConnection
Arguments
| Name | Description |
|---|---|
first - Int
|
Only read the first n values of the set. |
last - Int
|
Only read the last n values of the set. |
offset - Int
|
Skip the first n values from our after cursor, an alternative to cursor based pagination. May not be used with last. |
before - Cursor
|
Read all values in the set before (above) this cursor. |
after - Cursor
|
Read all values in the set after (below) this cursor. |
orderBy - [LedgersOrderBy!]
|
The method to use when ordering Ledger. Default = [PRIMARY_KEY_ASC] |
condition - LedgerCondition
|
A condition to be used in determining which values should be returned by the collection. |
filter - LedgerFilter
|
A filter to be used in determining which values should be returned by the collection. |
Example
Query
query allLedgers(
$first: Int,
$last: Int,
$offset: Int,
$before: Cursor,
$after: Cursor,
$orderBy: [LedgersOrderBy!],
$condition: LedgerCondition,
$filter: LedgerFilter
) {
allLedgers(
first: $first,
last: $last,
offset: $offset,
before: $before,
after: $after,
orderBy: $orderBy,
condition: $condition,
filter: $filter
) {
nodes {
...LedgerFragment
}
edges {
...LedgersEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"first": 987,
"last": 987,
"offset": 987,
"before": Cursor,
"after": Cursor,
"orderBy": ["PRIMARY_KEY_ASC"],
"condition": LedgerCondition,
"filter": LedgerFilter
}
Response
{
"data": {
"allLedgers": {
"nodes": [Ledger],
"edges": [LedgersEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
}
}
allManagedAccounts
Description
Reads and enables pagination through a set of ManagedAccount.
Response
Returns a ManagedAccountsConnection
Arguments
| Name | Description |
|---|---|
first - Int
|
Only read the first n values of the set. |
last - Int
|
Only read the last n values of the set. |
offset - Int
|
Skip the first n values from our after cursor, an alternative to cursor based pagination. May not be used with last. |
before - Cursor
|
Read all values in the set before (above) this cursor. |
after - Cursor
|
Read all values in the set after (below) this cursor. |
orderBy - [ManagedAccountsOrderBy!]
|
The method to use when ordering ManagedAccount. Default = [PRIMARY_KEY_ASC] |
condition - ManagedAccountCondition
|
A condition to be used in determining which values should be returned by the collection. |
filter - ManagedAccountFilter
|
A filter to be used in determining which values should be returned by the collection. |
Example
Query
query allManagedAccounts(
$first: Int,
$last: Int,
$offset: Int,
$before: Cursor,
$after: Cursor,
$orderBy: [ManagedAccountsOrderBy!],
$condition: ManagedAccountCondition,
$filter: ManagedAccountFilter
) {
allManagedAccounts(
first: $first,
last: $last,
offset: $offset,
before: $before,
after: $after,
orderBy: $orderBy,
condition: $condition,
filter: $filter
) {
nodes {
...ManagedAccountFragment
}
edges {
...ManagedAccountsEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"first": 987,
"last": 123,
"offset": 987,
"before": Cursor,
"after": Cursor,
"orderBy": ["PRIMARY_KEY_ASC"],
"condition": ManagedAccountCondition,
"filter": ManagedAccountFilter
}
Response
{
"data": {
"allManagedAccounts": {
"nodes": [ManagedAccount],
"edges": [ManagedAccountsEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
}
}
allMappedSigningTemplateQuestionSets
Description
Reads and enables pagination through a set of MappedSigningTemplateQuestionSet.
Response
Arguments
| Name | Description |
|---|---|
first - Int
|
Only read the first n values of the set. |
last - Int
|
Only read the last n values of the set. |
offset - Int
|
Skip the first n values from our after cursor, an alternative to cursor based pagination. May not be used with last. |
before - Cursor
|
Read all values in the set before (above) this cursor. |
after - Cursor
|
Read all values in the set after (below) this cursor. |
orderBy - [MappedSigningTemplateQuestionSetsOrderBy!]
|
The method to use when ordering MappedSigningTemplateQuestionSet. Default = [PRIMARY_KEY_ASC] |
condition - MappedSigningTemplateQuestionSetCondition
|
A condition to be used in determining which values should be returned by the collection. |
filter - MappedSigningTemplateQuestionSetFilter
|
A filter to be used in determining which values should be returned by the collection. |
Example
Query
query allMappedSigningTemplateQuestionSets(
$first: Int,
$last: Int,
$offset: Int,
$before: Cursor,
$after: Cursor,
$orderBy: [MappedSigningTemplateQuestionSetsOrderBy!],
$condition: MappedSigningTemplateQuestionSetCondition,
$filter: MappedSigningTemplateQuestionSetFilter
) {
allMappedSigningTemplateQuestionSets(
first: $first,
last: $last,
offset: $offset,
before: $before,
after: $after,
orderBy: $orderBy,
condition: $condition,
filter: $filter
) {
nodes {
...MappedSigningTemplateQuestionSetFragment
}
edges {
...MappedSigningTemplateQuestionSetsEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"first": 987,
"last": 123,
"offset": 987,
"before": Cursor,
"after": Cursor,
"orderBy": ["PRIMARY_KEY_ASC"],
"condition": MappedSigningTemplateQuestionSetCondition,
"filter": MappedSigningTemplateQuestionSetFilter
}
Response
{
"data": {
"allMappedSigningTemplateQuestionSets": {
"nodes": [MappedSigningTemplateQuestionSet],
"edges": [MappedSigningTemplateQuestionSetsEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
}
}
allMappedSigningTemplates
Description
Reads and enables pagination through a set of MappedSigningTemplate.
Response
Returns a MappedSigningTemplatesConnection
Arguments
| Name | Description |
|---|---|
first - Int
|
Only read the first n values of the set. |
last - Int
|
Only read the last n values of the set. |
offset - Int
|
Skip the first n values from our after cursor, an alternative to cursor based pagination. May not be used with last. |
before - Cursor
|
Read all values in the set before (above) this cursor. |
after - Cursor
|
Read all values in the set after (below) this cursor. |
orderBy - [MappedSigningTemplatesOrderBy!]
|
The method to use when ordering MappedSigningTemplate. Default = [PRIMARY_KEY_ASC] |
condition - MappedSigningTemplateCondition
|
A condition to be used in determining which values should be returned by the collection. |
filter - MappedSigningTemplateFilter
|
A filter to be used in determining which values should be returned by the collection. |
Example
Query
query allMappedSigningTemplates(
$first: Int,
$last: Int,
$offset: Int,
$before: Cursor,
$after: Cursor,
$orderBy: [MappedSigningTemplatesOrderBy!],
$condition: MappedSigningTemplateCondition,
$filter: MappedSigningTemplateFilter
) {
allMappedSigningTemplates(
first: $first,
last: $last,
offset: $offset,
before: $before,
after: $after,
orderBy: $orderBy,
condition: $condition,
filter: $filter
) {
nodes {
...MappedSigningTemplateFragment
}
edges {
...MappedSigningTemplatesEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"first": 123,
"last": 987,
"offset": 123,
"before": Cursor,
"after": Cursor,
"orderBy": ["PRIMARY_KEY_ASC"],
"condition": MappedSigningTemplateCondition,
"filter": MappedSigningTemplateFilter
}
Response
{
"data": {
"allMappedSigningTemplates": {
"nodes": [MappedSigningTemplate],
"edges": [MappedSigningTemplatesEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
}
}
allMappingRoleTypes
Description
Reads and enables pagination through a set of MappingRoleType.
Response
Returns a MappingRoleTypesConnection
Arguments
| Name | Description |
|---|---|
first - Int
|
Only read the first n values of the set. |
last - Int
|
Only read the last n values of the set. |
offset - Int
|
Skip the first n values from our after cursor, an alternative to cursor based pagination. May not be used with last. |
before - Cursor
|
Read all values in the set before (above) this cursor. |
after - Cursor
|
Read all values in the set after (below) this cursor. |
orderBy - [MappingRoleTypesOrderBy!]
|
The method to use when ordering MappingRoleType. Default = [PRIMARY_KEY_ASC] |
condition - MappingRoleTypeCondition
|
A condition to be used in determining which values should be returned by the collection. |
filter - MappingRoleTypeFilter
|
A filter to be used in determining which values should be returned by the collection. |
Example
Query
query allMappingRoleTypes(
$first: Int,
$last: Int,
$offset: Int,
$before: Cursor,
$after: Cursor,
$orderBy: [MappingRoleTypesOrderBy!],
$condition: MappingRoleTypeCondition,
$filter: MappingRoleTypeFilter
) {
allMappingRoleTypes(
first: $first,
last: $last,
offset: $offset,
before: $before,
after: $after,
orderBy: $orderBy,
condition: $condition,
filter: $filter
) {
nodes {
...MappingRoleTypeFragment
}
edges {
...MappingRoleTypesEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"first": 987,
"last": 987,
"offset": 987,
"before": Cursor,
"after": Cursor,
"orderBy": ["PRIMARY_KEY_ASC"],
"condition": MappingRoleTypeCondition,
"filter": MappingRoleTypeFilter
}
Response
{
"data": {
"allMappingRoleTypes": {
"nodes": [MappingRoleType],
"edges": [MappingRoleTypesEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
}
}
allMappingRoles
Description
Reads and enables pagination through a set of MappingRole.
Response
Returns a MappingRolesConnection
Arguments
| Name | Description |
|---|---|
first - Int
|
Only read the first n values of the set. |
last - Int
|
Only read the last n values of the set. |
offset - Int
|
Skip the first n values from our after cursor, an alternative to cursor based pagination. May not be used with last. |
before - Cursor
|
Read all values in the set before (above) this cursor. |
after - Cursor
|
Read all values in the set after (below) this cursor. |
orderBy - [MappingRolesOrderBy!]
|
The method to use when ordering MappingRole. Default = [PRIMARY_KEY_ASC] |
condition - MappingRoleCondition
|
A condition to be used in determining which values should be returned by the collection. |
filter - MappingRoleFilter
|
A filter to be used in determining which values should be returned by the collection. |
Example
Query
query allMappingRoles(
$first: Int,
$last: Int,
$offset: Int,
$before: Cursor,
$after: Cursor,
$orderBy: [MappingRolesOrderBy!],
$condition: MappingRoleCondition,
$filter: MappingRoleFilter
) {
allMappingRoles(
first: $first,
last: $last,
offset: $offset,
before: $before,
after: $after,
orderBy: $orderBy,
condition: $condition,
filter: $filter
) {
nodes {
...MappingRoleFragment
}
edges {
...MappingRolesEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"first": 987,
"last": 123,
"offset": 987,
"before": Cursor,
"after": Cursor,
"orderBy": ["PRIMARY_KEY_ASC"],
"condition": MappingRoleCondition,
"filter": MappingRoleFilter
}
Response
{
"data": {
"allMappingRoles": {
"nodes": [MappingRole],
"edges": [MappingRolesEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
}
}
allOmnibusHoldings
Description
Reads and enables pagination through a set of OmnibusHolding.
Response
Returns an OmnibusHoldingsConnection
Arguments
| Name | Description |
|---|---|
first - Int
|
Only read the first n values of the set. |
last - Int
|
Only read the last n values of the set. |
offset - Int
|
Skip the first n values from our after cursor, an alternative to cursor based pagination. May not be used with last. |
before - Cursor
|
Read all values in the set before (above) this cursor. |
after - Cursor
|
Read all values in the set after (below) this cursor. |
orderBy - [OmnibusHoldingsOrderBy!]
|
The method to use when ordering OmnibusHolding. Default = [PRIMARY_KEY_ASC] |
condition - OmnibusHoldingCondition
|
A condition to be used in determining which values should be returned by the collection. |
filter - OmnibusHoldingFilter
|
A filter to be used in determining which values should be returned by the collection. |
Example
Query
query allOmnibusHoldings(
$first: Int,
$last: Int,
$offset: Int,
$before: Cursor,
$after: Cursor,
$orderBy: [OmnibusHoldingsOrderBy!],
$condition: OmnibusHoldingCondition,
$filter: OmnibusHoldingFilter
) {
allOmnibusHoldings(
first: $first,
last: $last,
offset: $offset,
before: $before,
after: $after,
orderBy: $orderBy,
condition: $condition,
filter: $filter
) {
nodes {
...OmnibusHoldingFragment
}
edges {
...OmnibusHoldingsEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"first": 987,
"last": 123,
"offset": 123,
"before": Cursor,
"after": Cursor,
"orderBy": ["PRIMARY_KEY_ASC"],
"condition": OmnibusHoldingCondition,
"filter": OmnibusHoldingFilter
}
Response
{
"data": {
"allOmnibusHoldings": {
"nodes": [OmnibusHolding],
"edges": [OmnibusHoldingsEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
}
}
allOmnibusInvestors
Description
Reads and enables pagination through a set of OmnibusInvestor.
Response
Returns an OmnibusInvestorsConnection
Arguments
| Name | Description |
|---|---|
first - Int
|
Only read the first n values of the set. |
last - Int
|
Only read the last n values of the set. |
offset - Int
|
Skip the first n values from our after cursor, an alternative to cursor based pagination. May not be used with last. |
before - Cursor
|
Read all values in the set before (above) this cursor. |
after - Cursor
|
Read all values in the set after (below) this cursor. |
orderBy - [OmnibusInvestorsOrderBy!]
|
The method to use when ordering OmnibusInvestor. Default = [PRIMARY_KEY_ASC] |
condition - OmnibusInvestorCondition
|
A condition to be used in determining which values should be returned by the collection. |
filter - OmnibusInvestorFilter
|
A filter to be used in determining which values should be returned by the collection. |
Example
Query
query allOmnibusInvestors(
$first: Int,
$last: Int,
$offset: Int,
$before: Cursor,
$after: Cursor,
$orderBy: [OmnibusInvestorsOrderBy!],
$condition: OmnibusInvestorCondition,
$filter: OmnibusInvestorFilter
) {
allOmnibusInvestors(
first: $first,
last: $last,
offset: $offset,
before: $before,
after: $after,
orderBy: $orderBy,
condition: $condition,
filter: $filter
) {
nodes {
...OmnibusInvestorFragment
}
edges {
...OmnibusInvestorsEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"first": 987,
"last": 987,
"offset": 987,
"before": Cursor,
"after": Cursor,
"orderBy": ["PRIMARY_KEY_ASC"],
"condition": OmnibusInvestorCondition,
"filter": OmnibusInvestorFilter
}
Response
{
"data": {
"allOmnibusInvestors": {
"nodes": [OmnibusInvestor],
"edges": [OmnibusInvestorsEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
}
}
allOnboardingQuestionJoins
Description
Reads and enables pagination through a set of OnboardingQuestionJoin.
Response
Returns an OnboardingQuestionJoinsConnection
Arguments
| Name | Description |
|---|---|
first - Int
|
Only read the first n values of the set. |
last - Int
|
Only read the last n values of the set. |
offset - Int
|
Skip the first n values from our after cursor, an alternative to cursor based pagination. May not be used with last. |
before - Cursor
|
Read all values in the set before (above) this cursor. |
after - Cursor
|
Read all values in the set after (below) this cursor. |
orderBy - [OnboardingQuestionJoinsOrderBy!]
|
The method to use when ordering OnboardingQuestionJoin. Default = [PRIMARY_KEY_ASC] |
condition - OnboardingQuestionJoinCondition
|
A condition to be used in determining which values should be returned by the collection. |
filter - OnboardingQuestionJoinFilter
|
A filter to be used in determining which values should be returned by the collection. |
Example
Query
query allOnboardingQuestionJoins(
$first: Int,
$last: Int,
$offset: Int,
$before: Cursor,
$after: Cursor,
$orderBy: [OnboardingQuestionJoinsOrderBy!],
$condition: OnboardingQuestionJoinCondition,
$filter: OnboardingQuestionJoinFilter
) {
allOnboardingQuestionJoins(
first: $first,
last: $last,
offset: $offset,
before: $before,
after: $after,
orderBy: $orderBy,
condition: $condition,
filter: $filter
) {
nodes {
...OnboardingQuestionJoinFragment
}
edges {
...OnboardingQuestionJoinsEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"first": 987,
"last": 123,
"offset": 123,
"before": Cursor,
"after": Cursor,
"orderBy": ["PRIMARY_KEY_ASC"],
"condition": OnboardingQuestionJoinCondition,
"filter": OnboardingQuestionJoinFilter
}
Response
{
"data": {
"allOnboardingQuestionJoins": {
"nodes": [OnboardingQuestionJoin],
"edges": [OnboardingQuestionJoinsEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
}
}
allOnboardingQuestionSets
Description
Reads and enables pagination through a set of OnboardingQuestionSet.
Response
Returns an OnboardingQuestionSetsConnection
Arguments
| Name | Description |
|---|---|
first - Int
|
Only read the first n values of the set. |
last - Int
|
Only read the last n values of the set. |
offset - Int
|
Skip the first n values from our after cursor, an alternative to cursor based pagination. May not be used with last. |
before - Cursor
|
Read all values in the set before (above) this cursor. |
after - Cursor
|
Read all values in the set after (below) this cursor. |
orderBy - [OnboardingQuestionSetsOrderBy!]
|
The method to use when ordering OnboardingQuestionSet. Default = [PRIMARY_KEY_ASC] |
condition - OnboardingQuestionSetCondition
|
A condition to be used in determining which values should be returned by the collection. |
filter - OnboardingQuestionSetFilter
|
A filter to be used in determining which values should be returned by the collection. |
Example
Query
query allOnboardingQuestionSets(
$first: Int,
$last: Int,
$offset: Int,
$before: Cursor,
$after: Cursor,
$orderBy: [OnboardingQuestionSetsOrderBy!],
$condition: OnboardingQuestionSetCondition,
$filter: OnboardingQuestionSetFilter
) {
allOnboardingQuestionSets(
first: $first,
last: $last,
offset: $offset,
before: $before,
after: $after,
orderBy: $orderBy,
condition: $condition,
filter: $filter
) {
nodes {
...OnboardingQuestionSetFragment
}
edges {
...OnboardingQuestionSetsEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"first": 123,
"last": 987,
"offset": 987,
"before": Cursor,
"after": Cursor,
"orderBy": ["PRIMARY_KEY_ASC"],
"condition": OnboardingQuestionSetCondition,
"filter": OnboardingQuestionSetFilter
}
Response
{
"data": {
"allOnboardingQuestionSets": {
"nodes": [OnboardingQuestionSet],
"edges": [OnboardingQuestionSetsEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
}
}
allOnboardingQuestionTypes
Description
Reads and enables pagination through a set of OnboardingQuestionType.
Response
Returns an OnboardingQuestionTypesConnection
Arguments
| Name | Description |
|---|---|
first - Int
|
Only read the first n values of the set. |
last - Int
|
Only read the last n values of the set. |
offset - Int
|
Skip the first n values from our after cursor, an alternative to cursor based pagination. May not be used with last. |
before - Cursor
|
Read all values in the set before (above) this cursor. |
after - Cursor
|
Read all values in the set after (below) this cursor. |
orderBy - [OnboardingQuestionTypesOrderBy!]
|
The method to use when ordering OnboardingQuestionType. Default = [PRIMARY_KEY_ASC] |
condition - OnboardingQuestionTypeCondition
|
A condition to be used in determining which values should be returned by the collection. |
filter - OnboardingQuestionTypeFilter
|
A filter to be used in determining which values should be returned by the collection. |
Example
Query
query allOnboardingQuestionTypes(
$first: Int,
$last: Int,
$offset: Int,
$before: Cursor,
$after: Cursor,
$orderBy: [OnboardingQuestionTypesOrderBy!],
$condition: OnboardingQuestionTypeCondition,
$filter: OnboardingQuestionTypeFilter
) {
allOnboardingQuestionTypes(
first: $first,
last: $last,
offset: $offset,
before: $before,
after: $after,
orderBy: $orderBy,
condition: $condition,
filter: $filter
) {
nodes {
...OnboardingQuestionTypeFragment
}
edges {
...OnboardingQuestionTypesEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"first": 987,
"last": 987,
"offset": 123,
"before": Cursor,
"after": Cursor,
"orderBy": ["PRIMARY_KEY_ASC"],
"condition": OnboardingQuestionTypeCondition,
"filter": OnboardingQuestionTypeFilter
}
Response
{
"data": {
"allOnboardingQuestionTypes": {
"nodes": [OnboardingQuestionType],
"edges": [OnboardingQuestionTypesEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
}
}
allOnboardingQuestions
Description
Reads and enables pagination through a set of OnboardingQuestion.
Response
Returns an OnboardingQuestionsConnection
Arguments
| Name | Description |
|---|---|
first - Int
|
Only read the first n values of the set. |
last - Int
|
Only read the last n values of the set. |
offset - Int
|
Skip the first n values from our after cursor, an alternative to cursor based pagination. May not be used with last. |
before - Cursor
|
Read all values in the set before (above) this cursor. |
after - Cursor
|
Read all values in the set after (below) this cursor. |
orderBy - [OnboardingQuestionsOrderBy!]
|
The method to use when ordering OnboardingQuestion. Default = [PRIMARY_KEY_ASC] |
condition - OnboardingQuestionCondition
|
A condition to be used in determining which values should be returned by the collection. |
filter - OnboardingQuestionFilter
|
A filter to be used in determining which values should be returned by the collection. |
Example
Query
query allOnboardingQuestions(
$first: Int,
$last: Int,
$offset: Int,
$before: Cursor,
$after: Cursor,
$orderBy: [OnboardingQuestionsOrderBy!],
$condition: OnboardingQuestionCondition,
$filter: OnboardingQuestionFilter
) {
allOnboardingQuestions(
first: $first,
last: $last,
offset: $offset,
before: $before,
after: $after,
orderBy: $orderBy,
condition: $condition,
filter: $filter
) {
nodes {
...OnboardingQuestionFragment
}
edges {
...OnboardingQuestionsEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"first": 123,
"last": 123,
"offset": 987,
"before": Cursor,
"after": Cursor,
"orderBy": ["PRIMARY_KEY_ASC"],
"condition": OnboardingQuestionCondition,
"filter": OnboardingQuestionFilter
}
Response
{
"data": {
"allOnboardingQuestions": {
"nodes": [OnboardingQuestion],
"edges": [OnboardingQuestionsEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
}
}
allParties
Description
Reads and enables pagination through a set of Party.
Response
Returns a PartiesConnection
Arguments
| Name | Description |
|---|---|
first - Int
|
Only read the first n values of the set. |
last - Int
|
Only read the last n values of the set. |
offset - Int
|
Skip the first n values from our after cursor, an alternative to cursor based pagination. May not be used with last. |
before - Cursor
|
Read all values in the set before (above) this cursor. |
after - Cursor
|
Read all values in the set after (below) this cursor. |
orderBy - [PartiesOrderBy!]
|
The method to use when ordering Party. Default = [NATURAL] |
condition - PartyCondition
|
A condition to be used in determining which values should be returned by the collection. |
filter - PartyFilter
|
A filter to be used in determining which values should be returned by the collection. |
Example
Query
query allParties(
$first: Int,
$last: Int,
$offset: Int,
$before: Cursor,
$after: Cursor,
$orderBy: [PartiesOrderBy!],
$condition: PartyCondition,
$filter: PartyFilter
) {
allParties(
first: $first,
last: $last,
offset: $offset,
before: $before,
after: $after,
orderBy: $orderBy,
condition: $condition,
filter: $filter
) {
nodes {
...PartyFragment
}
edges {
...PartiesEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"first": 123,
"last": 123,
"offset": 987,
"before": Cursor,
"after": Cursor,
"orderBy": ["NATURAL"],
"condition": PartyCondition,
"filter": PartyFilter
}
Response
{
"data": {
"allParties": {
"nodes": [Party],
"edges": [PartiesEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
}
}
allPartyAddresses
Description
Reads and enables pagination through a set of PartyAddress.
Response
Returns a PartyAddressesConnection
Arguments
| Name | Description |
|---|---|
first - Int
|
Only read the first n values of the set. |
last - Int
|
Only read the last n values of the set. |
offset - Int
|
Skip the first n values from our after cursor, an alternative to cursor based pagination. May not be used with last. |
before - Cursor
|
Read all values in the set before (above) this cursor. |
after - Cursor
|
Read all values in the set after (below) this cursor. |
orderBy - [PartyAddressesOrderBy!]
|
The method to use when ordering PartyAddress. Default = [NATURAL] |
condition - PartyAddressCondition
|
A condition to be used in determining which values should be returned by the collection. |
filter - PartyAddressFilter
|
A filter to be used in determining which values should be returned by the collection. |
Example
Query
query allPartyAddresses(
$first: Int,
$last: Int,
$offset: Int,
$before: Cursor,
$after: Cursor,
$orderBy: [PartyAddressesOrderBy!],
$condition: PartyAddressCondition,
$filter: PartyAddressFilter
) {
allPartyAddresses(
first: $first,
last: $last,
offset: $offset,
before: $before,
after: $after,
orderBy: $orderBy,
condition: $condition,
filter: $filter
) {
nodes {
...PartyAddressFragment
}
edges {
...PartyAddressesEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"first": 987,
"last": 123,
"offset": 123,
"before": Cursor,
"after": Cursor,
"orderBy": ["NATURAL"],
"condition": PartyAddressCondition,
"filter": PartyAddressFilter
}
Response
{
"data": {
"allPartyAddresses": {
"nodes": [PartyAddress],
"edges": [PartyAddressesEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
}
}
allPartyRoles
Description
Reads and enables pagination through a set of PartyRole.
Response
Returns a PartyRolesConnection
Arguments
| Name | Description |
|---|---|
first - Int
|
Only read the first n values of the set. |
last - Int
|
Only read the last n values of the set. |
offset - Int
|
Skip the first n values from our after cursor, an alternative to cursor based pagination. May not be used with last. |
before - Cursor
|
Read all values in the set before (above) this cursor. |
after - Cursor
|
Read all values in the set after (below) this cursor. |
orderBy - [PartyRolesOrderBy!]
|
The method to use when ordering PartyRole. Default = [PRIMARY_KEY_ASC] |
condition - PartyRoleCondition
|
A condition to be used in determining which values should be returned by the collection. |
filter - PartyRoleFilter
|
A filter to be used in determining which values should be returned by the collection. |
Example
Query
query allPartyRoles(
$first: Int,
$last: Int,
$offset: Int,
$before: Cursor,
$after: Cursor,
$orderBy: [PartyRolesOrderBy!],
$condition: PartyRoleCondition,
$filter: PartyRoleFilter
) {
allPartyRoles(
first: $first,
last: $last,
offset: $offset,
before: $before,
after: $after,
orderBy: $orderBy,
condition: $condition,
filter: $filter
) {
nodes {
...PartyRoleFragment
}
edges {
...PartyRolesEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"first": 123,
"last": 987,
"offset": 123,
"before": Cursor,
"after": Cursor,
"orderBy": ["PRIMARY_KEY_ASC"],
"condition": PartyRoleCondition,
"filter": PartyRoleFilter
}
Response
{
"data": {
"allPartyRoles": {
"nodes": [PartyRole],
"edges": [PartyRolesEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
}
}
allPaymentAccounts
Description
Reads and enables pagination through a set of PaymentAccount.
Response
Returns a PaymentAccountsConnection
Arguments
| Name | Description |
|---|---|
first - Int
|
Only read the first n values of the set. |
last - Int
|
Only read the last n values of the set. |
offset - Int
|
Skip the first n values from our after cursor, an alternative to cursor based pagination. May not be used with last. |
before - Cursor
|
Read all values in the set before (above) this cursor. |
after - Cursor
|
Read all values in the set after (below) this cursor. |
orderBy - [PaymentAccountsOrderBy!]
|
The method to use when ordering PaymentAccount. Default = [PRIMARY_KEY_ASC] |
condition - PaymentAccountCondition
|
A condition to be used in determining which values should be returned by the collection. |
filter - PaymentAccountFilter
|
A filter to be used in determining which values should be returned by the collection. |
Example
Query
query allPaymentAccounts(
$first: Int,
$last: Int,
$offset: Int,
$before: Cursor,
$after: Cursor,
$orderBy: [PaymentAccountsOrderBy!],
$condition: PaymentAccountCondition,
$filter: PaymentAccountFilter
) {
allPaymentAccounts(
first: $first,
last: $last,
offset: $offset,
before: $before,
after: $after,
orderBy: $orderBy,
condition: $condition,
filter: $filter
) {
nodes {
...PaymentAccountFragment
}
edges {
...PaymentAccountsEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"first": 987,
"last": 987,
"offset": 123,
"before": Cursor,
"after": Cursor,
"orderBy": ["PRIMARY_KEY_ASC"],
"condition": PaymentAccountCondition,
"filter": PaymentAccountFilter
}
Response
{
"data": {
"allPaymentAccounts": {
"nodes": [PaymentAccount],
"edges": [PaymentAccountsEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
}
}
allPaymentInstruments
Description
Reads and enables pagination through a set of PaymentInstrument.
Response
Returns a PaymentInstrumentsConnection
Arguments
| Name | Description |
|---|---|
first - Int
|
Only read the first n values of the set. |
last - Int
|
Only read the last n values of the set. |
offset - Int
|
Skip the first n values from our after cursor, an alternative to cursor based pagination. May not be used with last. |
before - Cursor
|
Read all values in the set before (above) this cursor. |
after - Cursor
|
Read all values in the set after (below) this cursor. |
orderBy - [PaymentInstrumentsOrderBy!]
|
The method to use when ordering PaymentInstrument. Default = [PRIMARY_KEY_ASC] |
condition - PaymentInstrumentCondition
|
A condition to be used in determining which values should be returned by the collection. |
filter - PaymentInstrumentFilter
|
A filter to be used in determining which values should be returned by the collection. |
Example
Query
query allPaymentInstruments(
$first: Int,
$last: Int,
$offset: Int,
$before: Cursor,
$after: Cursor,
$orderBy: [PaymentInstrumentsOrderBy!],
$condition: PaymentInstrumentCondition,
$filter: PaymentInstrumentFilter
) {
allPaymentInstruments(
first: $first,
last: $last,
offset: $offset,
before: $before,
after: $after,
orderBy: $orderBy,
condition: $condition,
filter: $filter
) {
nodes {
...PaymentInstrumentFragment
}
edges {
...PaymentInstrumentsEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"first": 123,
"last": 987,
"offset": 123,
"before": Cursor,
"after": Cursor,
"orderBy": ["PRIMARY_KEY_ASC"],
"condition": PaymentInstrumentCondition,
"filter": PaymentInstrumentFilter
}
Response
{
"data": {
"allPaymentInstruments": {
"nodes": [PaymentInstrument],
"edges": [PaymentInstrumentsEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
}
}
allPaymentIssuers
Description
Reads and enables pagination through a set of PaymentIssuer.
Response
Returns a PaymentIssuersConnection
Arguments
| Name | Description |
|---|---|
first - Int
|
Only read the first n values of the set. |
last - Int
|
Only read the last n values of the set. |
offset - Int
|
Skip the first n values from our after cursor, an alternative to cursor based pagination. May not be used with last. |
before - Cursor
|
Read all values in the set before (above) this cursor. |
after - Cursor
|
Read all values in the set after (below) this cursor. |
orderBy - [PaymentIssuersOrderBy!]
|
The method to use when ordering PaymentIssuer. Default = [PRIMARY_KEY_ASC] |
condition - PaymentIssuerCondition
|
A condition to be used in determining which values should be returned by the collection. |
filter - PaymentIssuerFilter
|
A filter to be used in determining which values should be returned by the collection. |
Example
Query
query allPaymentIssuers(
$first: Int,
$last: Int,
$offset: Int,
$before: Cursor,
$after: Cursor,
$orderBy: [PaymentIssuersOrderBy!],
$condition: PaymentIssuerCondition,
$filter: PaymentIssuerFilter
) {
allPaymentIssuers(
first: $first,
last: $last,
offset: $offset,
before: $before,
after: $after,
orderBy: $orderBy,
condition: $condition,
filter: $filter
) {
nodes {
...PaymentIssuerFragment
}
edges {
...PaymentIssuersEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"first": 123,
"last": 123,
"offset": 987,
"before": Cursor,
"after": Cursor,
"orderBy": ["PRIMARY_KEY_ASC"],
"condition": PaymentIssuerCondition,
"filter": PaymentIssuerFilter
}
Response
{
"data": {
"allPaymentIssuers": {
"nodes": [PaymentIssuer],
"edges": [PaymentIssuersEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
}
}
allPaymentMethodTypes
Description
Reads and enables pagination through a set of PaymentMethodType.
Response
Returns a PaymentMethodTypesConnection
Arguments
| Name | Description |
|---|---|
first - Int
|
Only read the first n values of the set. |
last - Int
|
Only read the last n values of the set. |
offset - Int
|
Skip the first n values from our after cursor, an alternative to cursor based pagination. May not be used with last. |
before - Cursor
|
Read all values in the set before (above) this cursor. |
after - Cursor
|
Read all values in the set after (below) this cursor. |
orderBy - [PaymentMethodTypesOrderBy!]
|
The method to use when ordering PaymentMethodType. Default = [PRIMARY_KEY_ASC] |
condition - PaymentMethodTypeCondition
|
A condition to be used in determining which values should be returned by the collection. |
filter - PaymentMethodTypeFilter
|
A filter to be used in determining which values should be returned by the collection. |
Example
Query
query allPaymentMethodTypes(
$first: Int,
$last: Int,
$offset: Int,
$before: Cursor,
$after: Cursor,
$orderBy: [PaymentMethodTypesOrderBy!],
$condition: PaymentMethodTypeCondition,
$filter: PaymentMethodTypeFilter
) {
allPaymentMethodTypes(
first: $first,
last: $last,
offset: $offset,
before: $before,
after: $after,
orderBy: $orderBy,
condition: $condition,
filter: $filter
) {
nodes {
...PaymentMethodTypeFragment
}
edges {
...PaymentMethodTypesEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"first": 987,
"last": 123,
"offset": 123,
"before": Cursor,
"after": Cursor,
"orderBy": ["PRIMARY_KEY_ASC"],
"condition": PaymentMethodTypeCondition,
"filter": PaymentMethodTypeFilter
}
Response
{
"data": {
"allPaymentMethodTypes": {
"nodes": [PaymentMethodType],
"edges": [PaymentMethodTypesEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
}
}
allPaymentMethods
Description
Reads and enables pagination through a set of PaymentMethod.
Response
Returns a PaymentMethodsConnection
Arguments
| Name | Description |
|---|---|
first - Int
|
Only read the first n values of the set. |
last - Int
|
Only read the last n values of the set. |
offset - Int
|
Skip the first n values from our after cursor, an alternative to cursor based pagination. May not be used with last. |
before - Cursor
|
Read all values in the set before (above) this cursor. |
after - Cursor
|
Read all values in the set after (below) this cursor. |
orderBy - [PaymentMethodsOrderBy!]
|
The method to use when ordering PaymentMethod. Default = [PRIMARY_KEY_ASC] |
condition - PaymentMethodCondition
|
A condition to be used in determining which values should be returned by the collection. |
filter - PaymentMethodFilter
|
A filter to be used in determining which values should be returned by the collection. |
Example
Query
query allPaymentMethods(
$first: Int,
$last: Int,
$offset: Int,
$before: Cursor,
$after: Cursor,
$orderBy: [PaymentMethodsOrderBy!],
$condition: PaymentMethodCondition,
$filter: PaymentMethodFilter
) {
allPaymentMethods(
first: $first,
last: $last,
offset: $offset,
before: $before,
after: $after,
orderBy: $orderBy,
condition: $condition,
filter: $filter
) {
nodes {
...PaymentMethodFragment
}
edges {
...PaymentMethodsEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"first": 123,
"last": 987,
"offset": 123,
"before": Cursor,
"after": Cursor,
"orderBy": ["PRIMARY_KEY_ASC"],
"condition": PaymentMethodCondition,
"filter": PaymentMethodFilter
}
Response
{
"data": {
"allPaymentMethods": {
"nodes": [PaymentMethod],
"edges": [PaymentMethodsEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
}
}
allPaymentStepTypes
Description
Reads and enables pagination through a set of PaymentStepType.
Response
Returns a PaymentStepTypesConnection
Arguments
| Name | Description |
|---|---|
first - Int
|
Only read the first n values of the set. |
last - Int
|
Only read the last n values of the set. |
offset - Int
|
Skip the first n values from our after cursor, an alternative to cursor based pagination. May not be used with last. |
before - Cursor
|
Read all values in the set before (above) this cursor. |
after - Cursor
|
Read all values in the set after (below) this cursor. |
orderBy - [PaymentStepTypesOrderBy!]
|
The method to use when ordering PaymentStepType. Default = [PRIMARY_KEY_ASC] |
condition - PaymentStepTypeCondition
|
A condition to be used in determining which values should be returned by the collection. |
filter - PaymentStepTypeFilter
|
A filter to be used in determining which values should be returned by the collection. |
Example
Query
query allPaymentStepTypes(
$first: Int,
$last: Int,
$offset: Int,
$before: Cursor,
$after: Cursor,
$orderBy: [PaymentStepTypesOrderBy!],
$condition: PaymentStepTypeCondition,
$filter: PaymentStepTypeFilter
) {
allPaymentStepTypes(
first: $first,
last: $last,
offset: $offset,
before: $before,
after: $after,
orderBy: $orderBy,
condition: $condition,
filter: $filter
) {
nodes {
...PaymentStepTypeFragment
}
edges {
...PaymentStepTypesEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"first": 987,
"last": 987,
"offset": 123,
"before": Cursor,
"after": Cursor,
"orderBy": ["PRIMARY_KEY_ASC"],
"condition": PaymentStepTypeCondition,
"filter": PaymentStepTypeFilter
}
Response
{
"data": {
"allPaymentStepTypes": {
"nodes": [PaymentStepType],
"edges": [PaymentStepTypesEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
}
}
allPhoneNumberTypes
Description
Reads and enables pagination through a set of PhoneNumberType.
Response
Returns a PhoneNumberTypesConnection
Arguments
| Name | Description |
|---|---|
first - Int
|
Only read the first n values of the set. |
last - Int
|
Only read the last n values of the set. |
offset - Int
|
Skip the first n values from our after cursor, an alternative to cursor based pagination. May not be used with last. |
before - Cursor
|
Read all values in the set before (above) this cursor. |
after - Cursor
|
Read all values in the set after (below) this cursor. |
orderBy - [PhoneNumberTypesOrderBy!]
|
The method to use when ordering PhoneNumberType. Default = [PRIMARY_KEY_ASC] |
condition - PhoneNumberTypeCondition
|
A condition to be used in determining which values should be returned by the collection. |
filter - PhoneNumberTypeFilter
|
A filter to be used in determining which values should be returned by the collection. |
Example
Query
query allPhoneNumberTypes(
$first: Int,
$last: Int,
$offset: Int,
$before: Cursor,
$after: Cursor,
$orderBy: [PhoneNumberTypesOrderBy!],
$condition: PhoneNumberTypeCondition,
$filter: PhoneNumberTypeFilter
) {
allPhoneNumberTypes(
first: $first,
last: $last,
offset: $offset,
before: $before,
after: $after,
orderBy: $orderBy,
condition: $condition,
filter: $filter
) {
nodes {
...PhoneNumberTypeFragment
}
edges {
...PhoneNumberTypesEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"first": 987,
"last": 987,
"offset": 123,
"before": Cursor,
"after": Cursor,
"orderBy": ["PRIMARY_KEY_ASC"],
"condition": PhoneNumberTypeCondition,
"filter": PhoneNumberTypeFilter
}
Response
{
"data": {
"allPhoneNumberTypes": {
"nodes": [PhoneNumberType],
"edges": [PhoneNumberTypesEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
}
}
allQualificationStatuses
Description
Reads and enables pagination through a set of QualificationStatus.
Response
Returns a QualificationStatusesConnection
Arguments
| Name | Description |
|---|---|
first - Int
|
Only read the first n values of the set. |
last - Int
|
Only read the last n values of the set. |
offset - Int
|
Skip the first n values from our after cursor, an alternative to cursor based pagination. May not be used with last. |
before - Cursor
|
Read all values in the set before (above) this cursor. |
after - Cursor
|
Read all values in the set after (below) this cursor. |
orderBy - [QualificationStatusesOrderBy!]
|
The method to use when ordering QualificationStatus. Default = [PRIMARY_KEY_ASC] |
condition - QualificationStatusCondition
|
A condition to be used in determining which values should be returned by the collection. |
filter - QualificationStatusFilter
|
A filter to be used in determining which values should be returned by the collection. |
Example
Query
query allQualificationStatuses(
$first: Int,
$last: Int,
$offset: Int,
$before: Cursor,
$after: Cursor,
$orderBy: [QualificationStatusesOrderBy!],
$condition: QualificationStatusCondition,
$filter: QualificationStatusFilter
) {
allQualificationStatuses(
first: $first,
last: $last,
offset: $offset,
before: $before,
after: $after,
orderBy: $orderBy,
condition: $condition,
filter: $filter
) {
nodes {
...QualificationStatusFragment
}
edges {
...QualificationStatusesEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"first": 123,
"last": 123,
"offset": 987,
"before": Cursor,
"after": Cursor,
"orderBy": ["PRIMARY_KEY_ASC"],
"condition": QualificationStatusCondition,
"filter": QualificationStatusFilter
}
Response
{
"data": {
"allQualificationStatuses": {
"nodes": [QualificationStatus],
"edges": [QualificationStatusesEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
}
}
allRegistrationMethods
Description
Reads and enables pagination through a set of RegistrationMethod.
Response
Returns a RegistrationMethodsConnection
Arguments
| Name | Description |
|---|---|
first - Int
|
Only read the first n values of the set. |
last - Int
|
Only read the last n values of the set. |
offset - Int
|
Skip the first n values from our after cursor, an alternative to cursor based pagination. May not be used with last. |
before - Cursor
|
Read all values in the set before (above) this cursor. |
after - Cursor
|
Read all values in the set after (below) this cursor. |
orderBy - [RegistrationMethodsOrderBy!]
|
The method to use when ordering RegistrationMethod. Default = [PRIMARY_KEY_ASC] |
condition - RegistrationMethodCondition
|
A condition to be used in determining which values should be returned by the collection. |
filter - RegistrationMethodFilter
|
A filter to be used in determining which values should be returned by the collection. |
Example
Query
query allRegistrationMethods(
$first: Int,
$last: Int,
$offset: Int,
$before: Cursor,
$after: Cursor,
$orderBy: [RegistrationMethodsOrderBy!],
$condition: RegistrationMethodCondition,
$filter: RegistrationMethodFilter
) {
allRegistrationMethods(
first: $first,
last: $last,
offset: $offset,
before: $before,
after: $after,
orderBy: $orderBy,
condition: $condition,
filter: $filter
) {
nodes {
...RegistrationMethodFragment
}
edges {
...RegistrationMethodsEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"first": 987,
"last": 123,
"offset": 987,
"before": Cursor,
"after": Cursor,
"orderBy": ["PRIMARY_KEY_ASC"],
"condition": RegistrationMethodCondition,
"filter": RegistrationMethodFilter
}
Response
{
"data": {
"allRegistrationMethods": {
"nodes": [RegistrationMethod],
"edges": [RegistrationMethodsEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
}
}
allRegistrationStatuses
Description
Reads and enables pagination through a set of RegistrationStatus.
Response
Returns a RegistrationStatusesConnection
Arguments
| Name | Description |
|---|---|
first - Int
|
Only read the first n values of the set. |
last - Int
|
Only read the last n values of the set. |
offset - Int
|
Skip the first n values from our after cursor, an alternative to cursor based pagination. May not be used with last. |
before - Cursor
|
Read all values in the set before (above) this cursor. |
after - Cursor
|
Read all values in the set after (below) this cursor. |
orderBy - [RegistrationStatusesOrderBy!]
|
The method to use when ordering RegistrationStatus. Default = [PRIMARY_KEY_ASC] |
condition - RegistrationStatusCondition
|
A condition to be used in determining which values should be returned by the collection. |
filter - RegistrationStatusFilter
|
A filter to be used in determining which values should be returned by the collection. |
Example
Query
query allRegistrationStatuses(
$first: Int,
$last: Int,
$offset: Int,
$before: Cursor,
$after: Cursor,
$orderBy: [RegistrationStatusesOrderBy!],
$condition: RegistrationStatusCondition,
$filter: RegistrationStatusFilter
) {
allRegistrationStatuses(
first: $first,
last: $last,
offset: $offset,
before: $before,
after: $after,
orderBy: $orderBy,
condition: $condition,
filter: $filter
) {
nodes {
...RegistrationStatusFragment
}
edges {
...RegistrationStatusesEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"first": 987,
"last": 123,
"offset": 123,
"before": Cursor,
"after": Cursor,
"orderBy": ["PRIMARY_KEY_ASC"],
"condition": RegistrationStatusCondition,
"filter": RegistrationStatusFilter
}
Response
{
"data": {
"allRegistrationStatuses": {
"nodes": [RegistrationStatus],
"edges": [RegistrationStatusesEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
}
}
allRequestTypes
Description
Reads and enables pagination through a set of RequestType.
Response
Returns a RequestTypesConnection
Arguments
| Name | Description |
|---|---|
first - Int
|
Only read the first n values of the set. |
last - Int
|
Only read the last n values of the set. |
offset - Int
|
Skip the first n values from our after cursor, an alternative to cursor based pagination. May not be used with last. |
before - Cursor
|
Read all values in the set before (above) this cursor. |
after - Cursor
|
Read all values in the set after (below) this cursor. |
orderBy - [RequestTypesOrderBy!]
|
The method to use when ordering RequestType. Default = [NATURAL] |
condition - RequestTypeCondition
|
A condition to be used in determining which values should be returned by the collection. |
filter - RequestTypeFilter
|
A filter to be used in determining which values should be returned by the collection. |
Example
Query
query allRequestTypes(
$first: Int,
$last: Int,
$offset: Int,
$before: Cursor,
$after: Cursor,
$orderBy: [RequestTypesOrderBy!],
$condition: RequestTypeCondition,
$filter: RequestTypeFilter
) {
allRequestTypes(
first: $first,
last: $last,
offset: $offset,
before: $before,
after: $after,
orderBy: $orderBy,
condition: $condition,
filter: $filter
) {
nodes {
...RequestTypeFragment
}
edges {
...RequestTypesEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"first": 987,
"last": 123,
"offset": 123,
"before": Cursor,
"after": Cursor,
"orderBy": ["NATURAL"],
"condition": RequestTypeCondition,
"filter": RequestTypeFilter
}
Response
{
"data": {
"allRequestTypes": {
"nodes": [RequestType],
"edges": [RequestTypesEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
}
}
allRequests
Description
Reads and enables pagination through a set of Request.
Response
Returns a RequestsConnection
Arguments
| Name | Description |
|---|---|
first - Int
|
Only read the first n values of the set. |
last - Int
|
Only read the last n values of the set. |
offset - Int
|
Skip the first n values from our after cursor, an alternative to cursor based pagination. May not be used with last. |
before - Cursor
|
Read all values in the set before (above) this cursor. |
after - Cursor
|
Read all values in the set after (below) this cursor. |
orderBy - [RequestsOrderBy!]
|
The method to use when ordering Request. Default = [NATURAL] |
condition - RequestCondition
|
A condition to be used in determining which values should be returned by the collection. |
filter - RequestFilter
|
A filter to be used in determining which values should be returned by the collection. |
Example
Query
query allRequests(
$first: Int,
$last: Int,
$offset: Int,
$before: Cursor,
$after: Cursor,
$orderBy: [RequestsOrderBy!],
$condition: RequestCondition,
$filter: RequestFilter
) {
allRequests(
first: $first,
last: $last,
offset: $offset,
before: $before,
after: $after,
orderBy: $orderBy,
condition: $condition,
filter: $filter
) {
nodes {
...RequestFragment
}
edges {
...RequestsEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"first": 123,
"last": 123,
"offset": 123,
"before": Cursor,
"after": Cursor,
"orderBy": ["NATURAL"],
"condition": RequestCondition,
"filter": RequestFilter
}
Response
{
"data": {
"allRequests": {
"nodes": [Request],
"edges": [RequestsEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
}
}
allRestrictionCategories
Description
Reads and enables pagination through a set of RestrictionCategory.
Response
Returns a RestrictionCategoriesConnection
Arguments
| Name | Description |
|---|---|
first - Int
|
Only read the first n values of the set. |
last - Int
|
Only read the last n values of the set. |
offset - Int
|
Skip the first n values from our after cursor, an alternative to cursor based pagination. May not be used with last. |
before - Cursor
|
Read all values in the set before (above) this cursor. |
after - Cursor
|
Read all values in the set after (below) this cursor. |
orderBy - [RestrictionCategoriesOrderBy!]
|
The method to use when ordering RestrictionCategory. Default = [PRIMARY_KEY_ASC] |
condition - RestrictionCategoryCondition
|
A condition to be used in determining which values should be returned by the collection. |
filter - RestrictionCategoryFilter
|
A filter to be used in determining which values should be returned by the collection. |
Example
Query
query allRestrictionCategories(
$first: Int,
$last: Int,
$offset: Int,
$before: Cursor,
$after: Cursor,
$orderBy: [RestrictionCategoriesOrderBy!],
$condition: RestrictionCategoryCondition,
$filter: RestrictionCategoryFilter
) {
allRestrictionCategories(
first: $first,
last: $last,
offset: $offset,
before: $before,
after: $after,
orderBy: $orderBy,
condition: $condition,
filter: $filter
) {
nodes {
...RestrictionCategoryFragment
}
edges {
...RestrictionCategoriesEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"first": 123,
"last": 123,
"offset": 123,
"before": Cursor,
"after": Cursor,
"orderBy": ["PRIMARY_KEY_ASC"],
"condition": RestrictionCategoryCondition,
"filter": RestrictionCategoryFilter
}
Response
{
"data": {
"allRestrictionCategories": {
"nodes": [RestrictionCategory],
"edges": [RestrictionCategoriesEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
}
}
allRestrictionReasons
Description
Reads and enables pagination through a set of RestrictionReason.
Response
Returns a RestrictionReasonsConnection
Arguments
| Name | Description |
|---|---|
first - Int
|
Only read the first n values of the set. |
last - Int
|
Only read the last n values of the set. |
offset - Int
|
Skip the first n values from our after cursor, an alternative to cursor based pagination. May not be used with last. |
before - Cursor
|
Read all values in the set before (above) this cursor. |
after - Cursor
|
Read all values in the set after (below) this cursor. |
orderBy - [RestrictionReasonsOrderBy!]
|
The method to use when ordering RestrictionReason. Default = [PRIMARY_KEY_ASC] |
condition - RestrictionReasonCondition
|
A condition to be used in determining which values should be returned by the collection. |
filter - RestrictionReasonFilter
|
A filter to be used in determining which values should be returned by the collection. |
Example
Query
query allRestrictionReasons(
$first: Int,
$last: Int,
$offset: Int,
$before: Cursor,
$after: Cursor,
$orderBy: [RestrictionReasonsOrderBy!],
$condition: RestrictionReasonCondition,
$filter: RestrictionReasonFilter
) {
allRestrictionReasons(
first: $first,
last: $last,
offset: $offset,
before: $before,
after: $after,
orderBy: $orderBy,
condition: $condition,
filter: $filter
) {
nodes {
...RestrictionReasonFragment
}
edges {
...RestrictionReasonsEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"first": 123,
"last": 123,
"offset": 123,
"before": Cursor,
"after": Cursor,
"orderBy": ["PRIMARY_KEY_ASC"],
"condition": RestrictionReasonCondition,
"filter": RestrictionReasonFilter
}
Response
{
"data": {
"allRestrictionReasons": {
"nodes": [RestrictionReason],
"edges": [RestrictionReasonsEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
}
}
allRounds
Description
Reads and enables pagination through a set of Round.
Response
Returns a RoundsConnection
Arguments
| Name | Description |
|---|---|
first - Int
|
Only read the first n values of the set. |
last - Int
|
Only read the last n values of the set. |
offset - Int
|
Skip the first n values from our after cursor, an alternative to cursor based pagination. May not be used with last. |
before - Cursor
|
Read all values in the set before (above) this cursor. |
after - Cursor
|
Read all values in the set after (below) this cursor. |
orderBy - [RoundsOrderBy!]
|
The method to use when ordering Round. Default = [PRIMARY_KEY_ASC] |
condition - RoundCondition
|
A condition to be used in determining which values should be returned by the collection. |
filter - RoundFilter
|
A filter to be used in determining which values should be returned by the collection. |
Example
Query
query allRounds(
$first: Int,
$last: Int,
$offset: Int,
$before: Cursor,
$after: Cursor,
$orderBy: [RoundsOrderBy!],
$condition: RoundCondition,
$filter: RoundFilter
) {
allRounds(
first: $first,
last: $last,
offset: $offset,
before: $before,
after: $after,
orderBy: $orderBy,
condition: $condition,
filter: $filter
) {
nodes {
...RoundFragment
}
edges {
...RoundsEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"first": 987,
"last": 987,
"offset": 987,
"before": Cursor,
"after": Cursor,
"orderBy": ["PRIMARY_KEY_ASC"],
"condition": RoundCondition,
"filter": RoundFilter
}
Response
{
"data": {
"allRounds": {
"nodes": [Round],
"edges": [RoundsEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
}
}
allSecurities
Description
Reads and enables pagination through a set of Security.
Response
Returns a SecuritiesConnection
Arguments
| Name | Description |
|---|---|
first - Int
|
Only read the first n values of the set. |
last - Int
|
Only read the last n values of the set. |
offset - Int
|
Skip the first n values from our after cursor, an alternative to cursor based pagination. May not be used with last. |
before - Cursor
|
Read all values in the set before (above) this cursor. |
after - Cursor
|
Read all values in the set after (below) this cursor. |
orderBy - [SecuritiesOrderBy!]
|
The method to use when ordering Security. Default = [PRIMARY_KEY_ASC] |
condition - SecurityCondition
|
A condition to be used in determining which values should be returned by the collection. |
filter - SecurityFilter
|
A filter to be used in determining which values should be returned by the collection. |
Example
Query
query allSecurities(
$first: Int,
$last: Int,
$offset: Int,
$before: Cursor,
$after: Cursor,
$orderBy: [SecuritiesOrderBy!],
$condition: SecurityCondition,
$filter: SecurityFilter
) {
allSecurities(
first: $first,
last: $last,
offset: $offset,
before: $before,
after: $after,
orderBy: $orderBy,
condition: $condition,
filter: $filter
) {
nodes {
...SecurityFragment
}
edges {
...SecuritiesEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"first": 987,
"last": 123,
"offset": 123,
"before": Cursor,
"after": Cursor,
"orderBy": ["PRIMARY_KEY_ASC"],
"condition": SecurityCondition,
"filter": SecurityFilter
}
Response
{
"data": {
"allSecurities": {
"nodes": [Security],
"edges": [SecuritiesEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
}
}
allSecurityDocuments
Description
Reads and enables pagination through a set of SecurityDocument.
Response
Returns a SecurityDocumentsConnection
Arguments
| Name | Description |
|---|---|
first - Int
|
Only read the first n values of the set. |
last - Int
|
Only read the last n values of the set. |
offset - Int
|
Skip the first n values from our after cursor, an alternative to cursor based pagination. May not be used with last. |
before - Cursor
|
Read all values in the set before (above) this cursor. |
after - Cursor
|
Read all values in the set after (below) this cursor. |
orderBy - [SecurityDocumentsOrderBy!]
|
The method to use when ordering SecurityDocument. Default = [PRIMARY_KEY_ASC] |
condition - SecurityDocumentCondition
|
A condition to be used in determining which values should be returned by the collection. |
filter - SecurityDocumentFilter
|
A filter to be used in determining which values should be returned by the collection. |
Example
Query
query allSecurityDocuments(
$first: Int,
$last: Int,
$offset: Int,
$before: Cursor,
$after: Cursor,
$orderBy: [SecurityDocumentsOrderBy!],
$condition: SecurityDocumentCondition,
$filter: SecurityDocumentFilter
) {
allSecurityDocuments(
first: $first,
last: $last,
offset: $offset,
before: $before,
after: $after,
orderBy: $orderBy,
condition: $condition,
filter: $filter
) {
nodes {
...SecurityDocumentFragment
}
edges {
...SecurityDocumentsEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"first": 123,
"last": 123,
"offset": 123,
"before": Cursor,
"after": Cursor,
"orderBy": ["PRIMARY_KEY_ASC"],
"condition": SecurityDocumentCondition,
"filter": SecurityDocumentFilter
}
Response
{
"data": {
"allSecurityDocuments": {
"nodes": [SecurityDocument],
"edges": [SecurityDocumentsEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
}
}
allSecurityListings
Description
Reads and enables pagination through a set of SecurityListing.
Response
Returns a SecurityListingsConnection
Arguments
| Name | Description |
|---|---|
first - Int
|
Only read the first n values of the set. |
last - Int
|
Only read the last n values of the set. |
offset - Int
|
Skip the first n values from our after cursor, an alternative to cursor based pagination. May not be used with last. |
before - Cursor
|
Read all values in the set before (above) this cursor. |
after - Cursor
|
Read all values in the set after (below) this cursor. |
orderBy - [SecurityListingsOrderBy!]
|
The method to use when ordering SecurityListing. Default = [PRIMARY_KEY_ASC] |
condition - SecurityListingCondition
|
A condition to be used in determining which values should be returned by the collection. |
filter - SecurityListingFilter
|
A filter to be used in determining which values should be returned by the collection. |
Example
Query
query allSecurityListings(
$first: Int,
$last: Int,
$offset: Int,
$before: Cursor,
$after: Cursor,
$orderBy: [SecurityListingsOrderBy!],
$condition: SecurityListingCondition,
$filter: SecurityListingFilter
) {
allSecurityListings(
first: $first,
last: $last,
offset: $offset,
before: $before,
after: $after,
orderBy: $orderBy,
condition: $condition,
filter: $filter
) {
nodes {
...SecurityListingFragment
}
edges {
...SecurityListingsEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"first": 987,
"last": 987,
"offset": 987,
"before": Cursor,
"after": Cursor,
"orderBy": ["PRIMARY_KEY_ASC"],
"condition": SecurityListingCondition,
"filter": SecurityListingFilter
}
Response
{
"data": {
"allSecurityListings": {
"nodes": [SecurityListing],
"edges": [SecurityListingsEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
}
}
allSentSigningDocumentStatuses
Description
Reads and enables pagination through a set of SentSigningDocumentStatus.
Response
Returns a SentSigningDocumentStatusesConnection
Arguments
| Name | Description |
|---|---|
first - Int
|
Only read the first n values of the set. |
last - Int
|
Only read the last n values of the set. |
offset - Int
|
Skip the first n values from our after cursor, an alternative to cursor based pagination. May not be used with last. |
before - Cursor
|
Read all values in the set before (above) this cursor. |
after - Cursor
|
Read all values in the set after (below) this cursor. |
orderBy - [SentSigningDocumentStatusesOrderBy!]
|
The method to use when ordering SentSigningDocumentStatus. Default = [PRIMARY_KEY_ASC] |
condition - SentSigningDocumentStatusCondition
|
A condition to be used in determining which values should be returned by the collection. |
filter - SentSigningDocumentStatusFilter
|
A filter to be used in determining which values should be returned by the collection. |
Example
Query
query allSentSigningDocumentStatuses(
$first: Int,
$last: Int,
$offset: Int,
$before: Cursor,
$after: Cursor,
$orderBy: [SentSigningDocumentStatusesOrderBy!],
$condition: SentSigningDocumentStatusCondition,
$filter: SentSigningDocumentStatusFilter
) {
allSentSigningDocumentStatuses(
first: $first,
last: $last,
offset: $offset,
before: $before,
after: $after,
orderBy: $orderBy,
condition: $condition,
filter: $filter
) {
nodes {
...SentSigningDocumentStatusFragment
}
edges {
...SentSigningDocumentStatusesEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"first": 987,
"last": 123,
"offset": 123,
"before": Cursor,
"after": Cursor,
"orderBy": ["PRIMARY_KEY_ASC"],
"condition": SentSigningDocumentStatusCondition,
"filter": SentSigningDocumentStatusFilter
}
Response
{
"data": {
"allSentSigningDocumentStatuses": {
"nodes": [SentSigningDocumentStatus],
"edges": [SentSigningDocumentStatusesEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
}
}
allSentSigningDocuments
Description
Reads and enables pagination through a set of SentSigningDocument.
Response
Returns a SentSigningDocumentsConnection
Arguments
| Name | Description |
|---|---|
first - Int
|
Only read the first n values of the set. |
last - Int
|
Only read the last n values of the set. |
offset - Int
|
Skip the first n values from our after cursor, an alternative to cursor based pagination. May not be used with last. |
before - Cursor
|
Read all values in the set before (above) this cursor. |
after - Cursor
|
Read all values in the set after (below) this cursor. |
orderBy - [SentSigningDocumentsOrderBy!]
|
The method to use when ordering SentSigningDocument. Default = [PRIMARY_KEY_ASC] |
condition - SentSigningDocumentCondition
|
A condition to be used in determining which values should be returned by the collection. |
filter - SentSigningDocumentFilter
|
A filter to be used in determining which values should be returned by the collection. |
Example
Query
query allSentSigningDocuments(
$first: Int,
$last: Int,
$offset: Int,
$before: Cursor,
$after: Cursor,
$orderBy: [SentSigningDocumentsOrderBy!],
$condition: SentSigningDocumentCondition,
$filter: SentSigningDocumentFilter
) {
allSentSigningDocuments(
first: $first,
last: $last,
offset: $offset,
before: $before,
after: $after,
orderBy: $orderBy,
condition: $condition,
filter: $filter
) {
nodes {
...SentSigningDocumentFragment
}
edges {
...SentSigningDocumentsEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"first": 987,
"last": 123,
"offset": 123,
"before": Cursor,
"after": Cursor,
"orderBy": ["PRIMARY_KEY_ASC"],
"condition": SentSigningDocumentCondition,
"filter": SentSigningDocumentFilter
}
Response
{
"data": {
"allSentSigningDocuments": {
"nodes": [SentSigningDocument],
"edges": [SentSigningDocumentsEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
}
}
allSigningAccounts
Description
Reads and enables pagination through a set of SigningAccount.
Response
Returns a SigningAccountsConnection
Arguments
| Name | Description |
|---|---|
first - Int
|
Only read the first n values of the set. |
last - Int
|
Only read the last n values of the set. |
offset - Int
|
Skip the first n values from our after cursor, an alternative to cursor based pagination. May not be used with last. |
before - Cursor
|
Read all values in the set before (above) this cursor. |
after - Cursor
|
Read all values in the set after (below) this cursor. |
orderBy - [SigningAccountsOrderBy!]
|
The method to use when ordering SigningAccount. Default = [PRIMARY_KEY_ASC] |
condition - SigningAccountCondition
|
A condition to be used in determining which values should be returned by the collection. |
filter - SigningAccountFilter
|
A filter to be used in determining which values should be returned by the collection. |
Example
Query
query allSigningAccounts(
$first: Int,
$last: Int,
$offset: Int,
$before: Cursor,
$after: Cursor,
$orderBy: [SigningAccountsOrderBy!],
$condition: SigningAccountCondition,
$filter: SigningAccountFilter
) {
allSigningAccounts(
first: $first,
last: $last,
offset: $offset,
before: $before,
after: $after,
orderBy: $orderBy,
condition: $condition,
filter: $filter
) {
nodes {
...SigningAccountFragment
}
edges {
...SigningAccountsEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"first": 987,
"last": 987,
"offset": 123,
"before": Cursor,
"after": Cursor,
"orderBy": ["PRIMARY_KEY_ASC"],
"condition": SigningAccountCondition,
"filter": SigningAccountFilter
}
Response
{
"data": {
"allSigningAccounts": {
"nodes": [SigningAccount],
"edges": [SigningAccountsEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
}
}
allSigningDocuments
Description
Reads and enables pagination through a set of SigningDocument.
Response
Returns a SigningDocumentsConnection
Arguments
| Name | Description |
|---|---|
first - Int
|
Only read the first n values of the set. |
last - Int
|
Only read the last n values of the set. |
offset - Int
|
Skip the first n values from our after cursor, an alternative to cursor based pagination. May not be used with last. |
before - Cursor
|
Read all values in the set before (above) this cursor. |
after - Cursor
|
Read all values in the set after (below) this cursor. |
orderBy - [SigningDocumentsOrderBy!]
|
The method to use when ordering SigningDocument. Default = [PRIMARY_KEY_ASC] |
condition - SigningDocumentCondition
|
A condition to be used in determining which values should be returned by the collection. |
filter - SigningDocumentFilter
|
A filter to be used in determining which values should be returned by the collection. |
Example
Query
query allSigningDocuments(
$first: Int,
$last: Int,
$offset: Int,
$before: Cursor,
$after: Cursor,
$orderBy: [SigningDocumentsOrderBy!],
$condition: SigningDocumentCondition,
$filter: SigningDocumentFilter
) {
allSigningDocuments(
first: $first,
last: $last,
offset: $offset,
before: $before,
after: $after,
orderBy: $orderBy,
condition: $condition,
filter: $filter
) {
nodes {
...SigningDocumentFragment
}
edges {
...SigningDocumentsEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"first": 987,
"last": 123,
"offset": 987,
"before": Cursor,
"after": Cursor,
"orderBy": ["PRIMARY_KEY_ASC"],
"condition": SigningDocumentCondition,
"filter": SigningDocumentFilter
}
Response
{
"data": {
"allSigningDocuments": {
"nodes": [SigningDocument],
"edges": [SigningDocumentsEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
}
}
allSigningFields
Description
Reads and enables pagination through a set of SigningField.
Response
Returns a SigningFieldsConnection
Arguments
| Name | Description |
|---|---|
first - Int
|
Only read the first n values of the set. |
last - Int
|
Only read the last n values of the set. |
offset - Int
|
Skip the first n values from our after cursor, an alternative to cursor based pagination. May not be used with last. |
before - Cursor
|
Read all values in the set before (above) this cursor. |
after - Cursor
|
Read all values in the set after (below) this cursor. |
orderBy - [SigningFieldsOrderBy!]
|
The method to use when ordering SigningField. Default = [PRIMARY_KEY_ASC] |
condition - SigningFieldCondition
|
A condition to be used in determining which values should be returned by the collection. |
filter - SigningFieldFilter
|
A filter to be used in determining which values should be returned by the collection. |
Example
Query
query allSigningFields(
$first: Int,
$last: Int,
$offset: Int,
$before: Cursor,
$after: Cursor,
$orderBy: [SigningFieldsOrderBy!],
$condition: SigningFieldCondition,
$filter: SigningFieldFilter
) {
allSigningFields(
first: $first,
last: $last,
offset: $offset,
before: $before,
after: $after,
orderBy: $orderBy,
condition: $condition,
filter: $filter
) {
nodes {
...SigningFieldFragment
}
edges {
...SigningFieldsEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"first": 987,
"last": 123,
"offset": 987,
"before": Cursor,
"after": Cursor,
"orderBy": ["PRIMARY_KEY_ASC"],
"condition": SigningFieldCondition,
"filter": SigningFieldFilter
}
Response
{
"data": {
"allSigningFields": {
"nodes": [SigningField],
"edges": [SigningFieldsEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
}
}
allSigningRoles
Description
Reads and enables pagination through a set of SigningRole.
Response
Returns a SigningRolesConnection
Arguments
| Name | Description |
|---|---|
first - Int
|
Only read the first n values of the set. |
last - Int
|
Only read the last n values of the set. |
offset - Int
|
Skip the first n values from our after cursor, an alternative to cursor based pagination. May not be used with last. |
before - Cursor
|
Read all values in the set before (above) this cursor. |
after - Cursor
|
Read all values in the set after (below) this cursor. |
orderBy - [SigningRolesOrderBy!]
|
The method to use when ordering SigningRole. Default = [PRIMARY_KEY_ASC] |
condition - SigningRoleCondition
|
A condition to be used in determining which values should be returned by the collection. |
filter - SigningRoleFilter
|
A filter to be used in determining which values should be returned by the collection. |
Example
Query
query allSigningRoles(
$first: Int,
$last: Int,
$offset: Int,
$before: Cursor,
$after: Cursor,
$orderBy: [SigningRolesOrderBy!],
$condition: SigningRoleCondition,
$filter: SigningRoleFilter
) {
allSigningRoles(
first: $first,
last: $last,
offset: $offset,
before: $before,
after: $after,
orderBy: $orderBy,
condition: $condition,
filter: $filter
) {
nodes {
...SigningRoleFragment
}
edges {
...SigningRolesEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"first": 987,
"last": 123,
"offset": 987,
"before": Cursor,
"after": Cursor,
"orderBy": ["PRIMARY_KEY_ASC"],
"condition": SigningRoleCondition,
"filter": SigningRoleFilter
}
Response
{
"data": {
"allSigningRoles": {
"nodes": [SigningRole],
"edges": [SigningRolesEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
}
}
allSigningStepTypes
Description
Reads and enables pagination through a set of SigningStepType.
Response
Returns a SigningStepTypesConnection
Arguments
| Name | Description |
|---|---|
first - Int
|
Only read the first n values of the set. |
last - Int
|
Only read the last n values of the set. |
offset - Int
|
Skip the first n values from our after cursor, an alternative to cursor based pagination. May not be used with last. |
before - Cursor
|
Read all values in the set before (above) this cursor. |
after - Cursor
|
Read all values in the set after (below) this cursor. |
orderBy - [SigningStepTypesOrderBy!]
|
The method to use when ordering SigningStepType. Default = [PRIMARY_KEY_ASC] |
condition - SigningStepTypeCondition
|
A condition to be used in determining which values should be returned by the collection. |
filter - SigningStepTypeFilter
|
A filter to be used in determining which values should be returned by the collection. |
Example
Query
query allSigningStepTypes(
$first: Int,
$last: Int,
$offset: Int,
$before: Cursor,
$after: Cursor,
$orderBy: [SigningStepTypesOrderBy!],
$condition: SigningStepTypeCondition,
$filter: SigningStepTypeFilter
) {
allSigningStepTypes(
first: $first,
last: $last,
offset: $offset,
before: $before,
after: $after,
orderBy: $orderBy,
condition: $condition,
filter: $filter
) {
nodes {
...SigningStepTypeFragment
}
edges {
...SigningStepTypesEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"first": 987,
"last": 123,
"offset": 987,
"before": Cursor,
"after": Cursor,
"orderBy": ["PRIMARY_KEY_ASC"],
"condition": SigningStepTypeCondition,
"filter": SigningStepTypeFilter
}
Response
{
"data": {
"allSigningStepTypes": {
"nodes": [SigningStepType],
"edges": [SigningStepTypesEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
}
}
allSigningTemplates
Description
Reads and enables pagination through a set of SigningTemplate.
Response
Returns a SigningTemplatesConnection
Arguments
| Name | Description |
|---|---|
first - Int
|
Only read the first n values of the set. |
last - Int
|
Only read the last n values of the set. |
offset - Int
|
Skip the first n values from our after cursor, an alternative to cursor based pagination. May not be used with last. |
before - Cursor
|
Read all values in the set before (above) this cursor. |
after - Cursor
|
Read all values in the set after (below) this cursor. |
orderBy - [SigningTemplatesOrderBy!]
|
The method to use when ordering SigningTemplate. Default = [PRIMARY_KEY_ASC] |
condition - SigningTemplateCondition
|
A condition to be used in determining which values should be returned by the collection. |
filter - SigningTemplateFilter
|
A filter to be used in determining which values should be returned by the collection. |
Example
Query
query allSigningTemplates(
$first: Int,
$last: Int,
$offset: Int,
$before: Cursor,
$after: Cursor,
$orderBy: [SigningTemplatesOrderBy!],
$condition: SigningTemplateCondition,
$filter: SigningTemplateFilter
) {
allSigningTemplates(
first: $first,
last: $last,
offset: $offset,
before: $before,
after: $after,
orderBy: $orderBy,
condition: $condition,
filter: $filter
) {
nodes {
...SigningTemplateFragment
}
edges {
...SigningTemplatesEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"first": 123,
"last": 987,
"offset": 987,
"before": Cursor,
"after": Cursor,
"orderBy": ["PRIMARY_KEY_ASC"],
"condition": SigningTemplateCondition,
"filter": SigningTemplateFilter
}
Response
{
"data": {
"allSigningTemplates": {
"nodes": [SigningTemplate],
"edges": [SigningTemplatesEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
}
}
allStagedBalanceTransfers
Description
Reads and enables pagination through a set of StagedBalanceTransfer.
Response
Returns a StagedBalanceTransfersConnection
Arguments
| Name | Description |
|---|---|
first - Int
|
Only read the first n values of the set. |
last - Int
|
Only read the last n values of the set. |
offset - Int
|
Skip the first n values from our after cursor, an alternative to cursor based pagination. May not be used with last. |
before - Cursor
|
Read all values in the set before (above) this cursor. |
after - Cursor
|
Read all values in the set after (below) this cursor. |
orderBy - [StagedBalanceTransfersOrderBy!]
|
The method to use when ordering StagedBalanceTransfer. Default = [NATURAL] |
condition - StagedBalanceTransferCondition
|
A condition to be used in determining which values should be returned by the collection. |
filter - StagedBalanceTransferFilter
|
A filter to be used in determining which values should be returned by the collection. |
Example
Query
query allStagedBalanceTransfers(
$first: Int,
$last: Int,
$offset: Int,
$before: Cursor,
$after: Cursor,
$orderBy: [StagedBalanceTransfersOrderBy!],
$condition: StagedBalanceTransferCondition,
$filter: StagedBalanceTransferFilter
) {
allStagedBalanceTransfers(
first: $first,
last: $last,
offset: $offset,
before: $before,
after: $after,
orderBy: $orderBy,
condition: $condition,
filter: $filter
) {
nodes {
...StagedBalanceTransferFragment
}
edges {
...StagedBalanceTransfersEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"first": 123,
"last": 987,
"offset": 123,
"before": Cursor,
"after": Cursor,
"orderBy": ["NATURAL"],
"condition": StagedBalanceTransferCondition,
"filter": StagedBalanceTransferFilter
}
Response
{
"data": {
"allStagedBalanceTransfers": {
"nodes": [StagedBalanceTransfer],
"edges": [StagedBalanceTransfersEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
}
}
allStagedTransferAtsTags
Description
Reads and enables pagination through a set of StagedTransferAtsTag.
Response
Returns a StagedTransferAtsTagsConnection
Arguments
| Name | Description |
|---|---|
first - Int
|
Only read the first n values of the set. |
last - Int
|
Only read the last n values of the set. |
offset - Int
|
Skip the first n values from our after cursor, an alternative to cursor based pagination. May not be used with last. |
before - Cursor
|
Read all values in the set before (above) this cursor. |
after - Cursor
|
Read all values in the set after (below) this cursor. |
orderBy - [StagedTransferAtsTagsOrderBy!]
|
The method to use when ordering StagedTransferAtsTag. Default = [NATURAL] |
condition - StagedTransferAtsTagCondition
|
A condition to be used in determining which values should be returned by the collection. |
filter - StagedTransferAtsTagFilter
|
A filter to be used in determining which values should be returned by the collection. |
Example
Query
query allStagedTransferAtsTags(
$first: Int,
$last: Int,
$offset: Int,
$before: Cursor,
$after: Cursor,
$orderBy: [StagedTransferAtsTagsOrderBy!],
$condition: StagedTransferAtsTagCondition,
$filter: StagedTransferAtsTagFilter
) {
allStagedTransferAtsTags(
first: $first,
last: $last,
offset: $offset,
before: $before,
after: $after,
orderBy: $orderBy,
condition: $condition,
filter: $filter
) {
nodes {
...StagedTransferAtsTagFragment
}
edges {
...StagedTransferAtsTagsEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"first": 123,
"last": 123,
"offset": 123,
"before": Cursor,
"after": Cursor,
"orderBy": ["NATURAL"],
"condition": StagedTransferAtsTagCondition,
"filter": StagedTransferAtsTagFilter
}
Response
{
"data": {
"allStagedTransferAtsTags": {
"nodes": [StagedTransferAtsTag],
"edges": [StagedTransferAtsTagsEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
}
}
allStagedTransferStatuses
Description
Reads and enables pagination through a set of StagedTransferStatus.
Response
Returns a StagedTransferStatusesConnection
Arguments
| Name | Description |
|---|---|
first - Int
|
Only read the first n values of the set. |
last - Int
|
Only read the last n values of the set. |
offset - Int
|
Skip the first n values from our after cursor, an alternative to cursor based pagination. May not be used with last. |
before - Cursor
|
Read all values in the set before (above) this cursor. |
after - Cursor
|
Read all values in the set after (below) this cursor. |
orderBy - [StagedTransferStatusesOrderBy!]
|
The method to use when ordering StagedTransferStatus. Default = [NATURAL] |
condition - StagedTransferStatusCondition
|
A condition to be used in determining which values should be returned by the collection. |
filter - StagedTransferStatusFilter
|
A filter to be used in determining which values should be returned by the collection. |
Example
Query
query allStagedTransferStatuses(
$first: Int,
$last: Int,
$offset: Int,
$before: Cursor,
$after: Cursor,
$orderBy: [StagedTransferStatusesOrderBy!],
$condition: StagedTransferStatusCondition,
$filter: StagedTransferStatusFilter
) {
allStagedTransferStatuses(
first: $first,
last: $last,
offset: $offset,
before: $before,
after: $after,
orderBy: $orderBy,
condition: $condition,
filter: $filter
) {
nodes {
...StagedTransferStatusFragment
}
edges {
...StagedTransferStatusesEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"first": 987,
"last": 987,
"offset": 123,
"before": Cursor,
"after": Cursor,
"orderBy": ["NATURAL"],
"condition": StagedTransferStatusCondition,
"filter": StagedTransferStatusFilter
}
Response
{
"data": {
"allStagedTransferStatuses": {
"nodes": [StagedTransferStatus],
"edges": [StagedTransferStatusesEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
}
}
allStagedTransfers
Description
Reads and enables pagination through a set of StagedTransfer.
Response
Returns a StagedTransfersConnection
Arguments
| Name | Description |
|---|---|
first - Int
|
Only read the first n values of the set. |
last - Int
|
Only read the last n values of the set. |
offset - Int
|
Skip the first n values from our after cursor, an alternative to cursor based pagination. May not be used with last. |
before - Cursor
|
Read all values in the set before (above) this cursor. |
after - Cursor
|
Read all values in the set after (below) this cursor. |
orderBy - [StagedTransfersOrderBy!]
|
The method to use when ordering StagedTransfer. Default = [NATURAL] |
condition - StagedTransferCondition
|
A condition to be used in determining which values should be returned by the collection. |
filter - StagedTransferFilter
|
A filter to be used in determining which values should be returned by the collection. |
Example
Query
query allStagedTransfers(
$first: Int,
$last: Int,
$offset: Int,
$before: Cursor,
$after: Cursor,
$orderBy: [StagedTransfersOrderBy!],
$condition: StagedTransferCondition,
$filter: StagedTransferFilter
) {
allStagedTransfers(
first: $first,
last: $last,
offset: $offset,
before: $before,
after: $after,
orderBy: $orderBy,
condition: $condition,
filter: $filter
) {
nodes {
...StagedTransferFragment
}
edges {
...StagedTransfersEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"first": 987,
"last": 987,
"offset": 987,
"before": Cursor,
"after": Cursor,
"orderBy": ["NATURAL"],
"condition": StagedTransferCondition,
"filter": StagedTransferFilter
}
Response
{
"data": {
"allStagedTransfers": {
"nodes": [StagedTransfer],
"edges": [StagedTransfersEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
}
}
allStepStatuses
Description
Reads and enables pagination through a set of StepStatus.
Response
Returns a StepStatusesConnection
Arguments
| Name | Description |
|---|---|
first - Int
|
Only read the first n values of the set. |
last - Int
|
Only read the last n values of the set. |
offset - Int
|
Skip the first n values from our after cursor, an alternative to cursor based pagination. May not be used with last. |
before - Cursor
|
Read all values in the set before (above) this cursor. |
after - Cursor
|
Read all values in the set after (below) this cursor. |
orderBy - [StepStatusesOrderBy!]
|
The method to use when ordering StepStatus. Default = [PRIMARY_KEY_ASC] |
condition - StepStatusCondition
|
A condition to be used in determining which values should be returned by the collection. |
filter - StepStatusFilter
|
A filter to be used in determining which values should be returned by the collection. |
Example
Query
query allStepStatuses(
$first: Int,
$last: Int,
$offset: Int,
$before: Cursor,
$after: Cursor,
$orderBy: [StepStatusesOrderBy!],
$condition: StepStatusCondition,
$filter: StepStatusFilter
) {
allStepStatuses(
first: $first,
last: $last,
offset: $offset,
before: $before,
after: $after,
orderBy: $orderBy,
condition: $condition,
filter: $filter
) {
nodes {
...StepStatusFragment
}
edges {
...StepStatusesEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"first": 123,
"last": 987,
"offset": 123,
"before": Cursor,
"after": Cursor,
"orderBy": ["PRIMARY_KEY_ASC"],
"condition": StepStatusCondition,
"filter": StepStatusFilter
}
Response
{
"data": {
"allStepStatuses": {
"nodes": [StepStatus],
"edges": [StepStatusesEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
}
}
allStepTypes
Description
Reads and enables pagination through a set of StepType.
Response
Returns a StepTypesConnection
Arguments
| Name | Description |
|---|---|
first - Int
|
Only read the first n values of the set. |
last - Int
|
Only read the last n values of the set. |
offset - Int
|
Skip the first n values from our after cursor, an alternative to cursor based pagination. May not be used with last. |
before - Cursor
|
Read all values in the set before (above) this cursor. |
after - Cursor
|
Read all values in the set after (below) this cursor. |
orderBy - [StepTypesOrderBy!]
|
The method to use when ordering StepType. Default = [PRIMARY_KEY_ASC] |
condition - StepTypeCondition
|
A condition to be used in determining which values should be returned by the collection. |
filter - StepTypeFilter
|
A filter to be used in determining which values should be returned by the collection. |
Example
Query
query allStepTypes(
$first: Int,
$last: Int,
$offset: Int,
$before: Cursor,
$after: Cursor,
$orderBy: [StepTypesOrderBy!],
$condition: StepTypeCondition,
$filter: StepTypeFilter
) {
allStepTypes(
first: $first,
last: $last,
offset: $offset,
before: $before,
after: $after,
orderBy: $orderBy,
condition: $condition,
filter: $filter
) {
nodes {
...StepTypeFragment
}
edges {
...StepTypesEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"first": 987,
"last": 987,
"offset": 987,
"before": Cursor,
"after": Cursor,
"orderBy": ["PRIMARY_KEY_ASC"],
"condition": StepTypeCondition,
"filter": StepTypeFilter
}
Response
{
"data": {
"allStepTypes": {
"nodes": [StepType],
"edges": [StepTypesEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
}
}
allSteps
Description
Reads and enables pagination through a set of Step.
Response
Returns a StepsConnection
Arguments
| Name | Description |
|---|---|
first - Int
|
Only read the first n values of the set. |
last - Int
|
Only read the last n values of the set. |
offset - Int
|
Skip the first n values from our after cursor, an alternative to cursor based pagination. May not be used with last. |
before - Cursor
|
Read all values in the set before (above) this cursor. |
after - Cursor
|
Read all values in the set after (below) this cursor. |
orderBy - [StepsOrderBy!]
|
The method to use when ordering Step. Default = [PRIMARY_KEY_ASC] |
condition - StepCondition
|
A condition to be used in determining which values should be returned by the collection. |
filter - StepFilter
|
A filter to be used in determining which values should be returned by the collection. |
Example
Query
query allSteps(
$first: Int,
$last: Int,
$offset: Int,
$before: Cursor,
$after: Cursor,
$orderBy: [StepsOrderBy!],
$condition: StepCondition,
$filter: StepFilter
) {
allSteps(
first: $first,
last: $last,
offset: $offset,
before: $before,
after: $after,
orderBy: $orderBy,
condition: $condition,
filter: $filter
) {
nodes {
...StepFragment
}
edges {
...StepsEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"first": 987,
"last": 123,
"offset": 123,
"before": Cursor,
"after": Cursor,
"orderBy": ["PRIMARY_KEY_ASC"],
"condition": StepCondition,
"filter": StepFilter
}
Response
{
"data": {
"allSteps": {
"nodes": [Step],
"edges": [StepsEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
}
}
allTaRequestBlockchainLocations
Description
Reads and enables pagination through a set of TaRequestBlockchainLocation.
Response
Returns a TaRequestBlockchainLocationsConnection
Arguments
| Name | Description |
|---|---|
first - Int
|
Only read the first n values of the set. |
last - Int
|
Only read the last n values of the set. |
offset - Int
|
Skip the first n values from our after cursor, an alternative to cursor based pagination. May not be used with last. |
before - Cursor
|
Read all values in the set before (above) this cursor. |
after - Cursor
|
Read all values in the set after (below) this cursor. |
orderBy - [TaRequestBlockchainLocationsOrderBy!]
|
The method to use when ordering TaRequestBlockchainLocation. Default = [PRIMARY_KEY_ASC] |
condition - TaRequestBlockchainLocationCondition
|
A condition to be used in determining which values should be returned by the collection. |
filter - TaRequestBlockchainLocationFilter
|
A filter to be used in determining which values should be returned by the collection. |
Example
Query
query allTaRequestBlockchainLocations(
$first: Int,
$last: Int,
$offset: Int,
$before: Cursor,
$after: Cursor,
$orderBy: [TaRequestBlockchainLocationsOrderBy!],
$condition: TaRequestBlockchainLocationCondition,
$filter: TaRequestBlockchainLocationFilter
) {
allTaRequestBlockchainLocations(
first: $first,
last: $last,
offset: $offset,
before: $before,
after: $after,
orderBy: $orderBy,
condition: $condition,
filter: $filter
) {
nodes {
...TaRequestBlockchainLocationFragment
}
edges {
...TaRequestBlockchainLocationsEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"first": 123,
"last": 123,
"offset": 123,
"before": Cursor,
"after": Cursor,
"orderBy": ["PRIMARY_KEY_ASC"],
"condition": TaRequestBlockchainLocationCondition,
"filter": TaRequestBlockchainLocationFilter
}
Response
{
"data": {
"allTaRequestBlockchainLocations": {
"nodes": [TaRequestBlockchainLocation],
"edges": [TaRequestBlockchainLocationsEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
}
}
allTaRequestStatuses
Description
Reads and enables pagination through a set of TaRequestStatus.
Response
Returns a TaRequestStatusesConnection
Arguments
| Name | Description |
|---|---|
first - Int
|
Only read the first n values of the set. |
last - Int
|
Only read the last n values of the set. |
offset - Int
|
Skip the first n values from our after cursor, an alternative to cursor based pagination. May not be used with last. |
before - Cursor
|
Read all values in the set before (above) this cursor. |
after - Cursor
|
Read all values in the set after (below) this cursor. |
orderBy - [TaRequestStatusesOrderBy!]
|
The method to use when ordering TaRequestStatus. Default = [PRIMARY_KEY_ASC] |
condition - TaRequestStatusCondition
|
A condition to be used in determining which values should be returned by the collection. |
filter - TaRequestStatusFilter
|
A filter to be used in determining which values should be returned by the collection. |
Example
Query
query allTaRequestStatuses(
$first: Int,
$last: Int,
$offset: Int,
$before: Cursor,
$after: Cursor,
$orderBy: [TaRequestStatusesOrderBy!],
$condition: TaRequestStatusCondition,
$filter: TaRequestStatusFilter
) {
allTaRequestStatuses(
first: $first,
last: $last,
offset: $offset,
before: $before,
after: $after,
orderBy: $orderBy,
condition: $condition,
filter: $filter
) {
nodes {
...TaRequestStatusFragment
}
edges {
...TaRequestStatusesEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"first": 123,
"last": 987,
"offset": 123,
"before": Cursor,
"after": Cursor,
"orderBy": ["PRIMARY_KEY_ASC"],
"condition": TaRequestStatusCondition,
"filter": TaRequestStatusFilter
}
Response
{
"data": {
"allTaRequestStatuses": {
"nodes": [TaRequestStatus],
"edges": [TaRequestStatusesEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
}
}
allTaRequestTypes
Description
Reads and enables pagination through a set of TaRequestType.
Response
Returns a TaRequestTypesConnection
Arguments
| Name | Description |
|---|---|
first - Int
|
Only read the first n values of the set. |
last - Int
|
Only read the last n values of the set. |
offset - Int
|
Skip the first n values from our after cursor, an alternative to cursor based pagination. May not be used with last. |
before - Cursor
|
Read all values in the set before (above) this cursor. |
after - Cursor
|
Read all values in the set after (below) this cursor. |
orderBy - [TaRequestTypesOrderBy!]
|
The method to use when ordering TaRequestType. Default = [PRIMARY_KEY_ASC] |
condition - TaRequestTypeCondition
|
A condition to be used in determining which values should be returned by the collection. |
filter - TaRequestTypeFilter
|
A filter to be used in determining which values should be returned by the collection. |
Example
Query
query allTaRequestTypes(
$first: Int,
$last: Int,
$offset: Int,
$before: Cursor,
$after: Cursor,
$orderBy: [TaRequestTypesOrderBy!],
$condition: TaRequestTypeCondition,
$filter: TaRequestTypeFilter
) {
allTaRequestTypes(
first: $first,
last: $last,
offset: $offset,
before: $before,
after: $after,
orderBy: $orderBy,
condition: $condition,
filter: $filter
) {
nodes {
...TaRequestTypeFragment
}
edges {
...TaRequestTypesEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"first": 987,
"last": 987,
"offset": 987,
"before": Cursor,
"after": Cursor,
"orderBy": ["PRIMARY_KEY_ASC"],
"condition": TaRequestTypeCondition,
"filter": TaRequestTypeFilter
}
Response
{
"data": {
"allTaRequestTypes": {
"nodes": [TaRequestType],
"edges": [TaRequestTypesEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
}
}
allTaRequests
Description
Reads and enables pagination through a set of TaRequest.
Response
Returns a TaRequestsConnection
Arguments
| Name | Description |
|---|---|
first - Int
|
Only read the first n values of the set. |
last - Int
|
Only read the last n values of the set. |
offset - Int
|
Skip the first n values from our after cursor, an alternative to cursor based pagination. May not be used with last. |
before - Cursor
|
Read all values in the set before (above) this cursor. |
after - Cursor
|
Read all values in the set after (below) this cursor. |
orderBy - [TaRequestsOrderBy!]
|
The method to use when ordering TaRequest. Default = [PRIMARY_KEY_ASC] |
condition - TaRequestCondition
|
A condition to be used in determining which values should be returned by the collection. |
filter - TaRequestFilter
|
A filter to be used in determining which values should be returned by the collection. |
Example
Query
query allTaRequests(
$first: Int,
$last: Int,
$offset: Int,
$before: Cursor,
$after: Cursor,
$orderBy: [TaRequestsOrderBy!],
$condition: TaRequestCondition,
$filter: TaRequestFilter
) {
allTaRequests(
first: $first,
last: $last,
offset: $offset,
before: $before,
after: $after,
orderBy: $orderBy,
condition: $condition,
filter: $filter
) {
nodes {
...TaRequestFragment
}
edges {
...TaRequestsEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"first": 987,
"last": 987,
"offset": 123,
"before": Cursor,
"after": Cursor,
"orderBy": ["PRIMARY_KEY_ASC"],
"condition": TaRequestCondition,
"filter": TaRequestFilter
}
Response
{
"data": {
"allTaRequests": {
"nodes": [TaRequest],
"edges": [TaRequestsEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
}
}
allTaxRegions
Description
Reads and enables pagination through a set of TaxRegion.
Response
Returns a TaxRegionsConnection
Arguments
| Name | Description |
|---|---|
first - Int
|
Only read the first n values of the set. |
last - Int
|
Only read the last n values of the set. |
offset - Int
|
Skip the first n values from our after cursor, an alternative to cursor based pagination. May not be used with last. |
before - Cursor
|
Read all values in the set before (above) this cursor. |
after - Cursor
|
Read all values in the set after (below) this cursor. |
orderBy - [TaxRegionsOrderBy!]
|
The method to use when ordering TaxRegion. Default = [PRIMARY_KEY_ASC] |
condition - TaxRegionCondition
|
A condition to be used in determining which values should be returned by the collection. |
filter - TaxRegionFilter
|
A filter to be used in determining which values should be returned by the collection. |
Example
Query
query allTaxRegions(
$first: Int,
$last: Int,
$offset: Int,
$before: Cursor,
$after: Cursor,
$orderBy: [TaxRegionsOrderBy!],
$condition: TaxRegionCondition,
$filter: TaxRegionFilter
) {
allTaxRegions(
first: $first,
last: $last,
offset: $offset,
before: $before,
after: $after,
orderBy: $orderBy,
condition: $condition,
filter: $filter
) {
nodes {
...TaxRegionFragment
}
edges {
...TaxRegionsEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"first": 123,
"last": 987,
"offset": 123,
"before": Cursor,
"after": Cursor,
"orderBy": ["PRIMARY_KEY_ASC"],
"condition": TaxRegionCondition,
"filter": TaxRegionFilter
}
Response
{
"data": {
"allTaxRegions": {
"nodes": [TaxRegion],
"edges": [TaxRegionsEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
}
}
allTermsOfServiceTypes
Description
Reads and enables pagination through a set of TermsOfServiceType.
Response
Returns a TermsOfServiceTypesConnection
Arguments
| Name | Description |
|---|---|
first - Int
|
Only read the first n values of the set. |
last - Int
|
Only read the last n values of the set. |
offset - Int
|
Skip the first n values from our after cursor, an alternative to cursor based pagination. May not be used with last. |
before - Cursor
|
Read all values in the set before (above) this cursor. |
after - Cursor
|
Read all values in the set after (below) this cursor. |
orderBy - [TermsOfServiceTypesOrderBy!]
|
The method to use when ordering TermsOfServiceType. Default = [PRIMARY_KEY_ASC] |
condition - TermsOfServiceTypeCondition
|
A condition to be used in determining which values should be returned by the collection. |
filter - TermsOfServiceTypeFilter
|
A filter to be used in determining which values should be returned by the collection. |
Example
Query
query allTermsOfServiceTypes(
$first: Int,
$last: Int,
$offset: Int,
$before: Cursor,
$after: Cursor,
$orderBy: [TermsOfServiceTypesOrderBy!],
$condition: TermsOfServiceTypeCondition,
$filter: TermsOfServiceTypeFilter
) {
allTermsOfServiceTypes(
first: $first,
last: $last,
offset: $offset,
before: $before,
after: $after,
orderBy: $orderBy,
condition: $condition,
filter: $filter
) {
nodes {
...TermsOfServiceTypeFragment
}
edges {
...TermsOfServiceTypesEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"first": 987,
"last": 123,
"offset": 123,
"before": Cursor,
"after": Cursor,
"orderBy": ["PRIMARY_KEY_ASC"],
"condition": TermsOfServiceTypeCondition,
"filter": TermsOfServiceTypeFilter
}
Response
{
"data": {
"allTermsOfServiceTypes": {
"nodes": [TermsOfServiceType],
"edges": [TermsOfServiceTypesEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
}
}
allTermsOfServices
Description
Reads and enables pagination through a set of TermsOfService.
Response
Returns a TermsOfServicesConnection
Arguments
| Name | Description |
|---|---|
first - Int
|
Only read the first n values of the set. |
last - Int
|
Only read the last n values of the set. |
offset - Int
|
Skip the first n values from our after cursor, an alternative to cursor based pagination. May not be used with last. |
before - Cursor
|
Read all values in the set before (above) this cursor. |
after - Cursor
|
Read all values in the set after (below) this cursor. |
orderBy - [TermsOfServicesOrderBy!]
|
The method to use when ordering TermsOfService. Default = [PRIMARY_KEY_ASC] |
condition - TermsOfServiceCondition
|
A condition to be used in determining which values should be returned by the collection. |
filter - TermsOfServiceFilter
|
A filter to be used in determining which values should be returned by the collection. |
Example
Query
query allTermsOfServices(
$first: Int,
$last: Int,
$offset: Int,
$before: Cursor,
$after: Cursor,
$orderBy: [TermsOfServicesOrderBy!],
$condition: TermsOfServiceCondition,
$filter: TermsOfServiceFilter
) {
allTermsOfServices(
first: $first,
last: $last,
offset: $offset,
before: $before,
after: $after,
orderBy: $orderBy,
condition: $condition,
filter: $filter
) {
nodes {
...TermsOfServiceFragment
}
edges {
...TermsOfServicesEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"first": 123,
"last": 987,
"offset": 123,
"before": Cursor,
"after": Cursor,
"orderBy": ["PRIMARY_KEY_ASC"],
"condition": TermsOfServiceCondition,
"filter": TermsOfServiceFilter
}
Response
{
"data": {
"allTermsOfServices": {
"nodes": [TermsOfService],
"edges": [TermsOfServicesEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
}
}
allTokenStatuses
Description
Reads and enables pagination through a set of TokenStatus.
Response
Returns a TokenStatusesConnection
Arguments
| Name | Description |
|---|---|
first - Int
|
Only read the first n values of the set. |
last - Int
|
Only read the last n values of the set. |
offset - Int
|
Skip the first n values from our after cursor, an alternative to cursor based pagination. May not be used with last. |
before - Cursor
|
Read all values in the set before (above) this cursor. |
after - Cursor
|
Read all values in the set after (below) this cursor. |
orderBy - [TokenStatusesOrderBy!]
|
The method to use when ordering TokenStatus. Default = [PRIMARY_KEY_ASC] |
condition - TokenStatusCondition
|
A condition to be used in determining which values should be returned by the collection. |
filter - TokenStatusFilter
|
A filter to be used in determining which values should be returned by the collection. |
Example
Query
query allTokenStatuses(
$first: Int,
$last: Int,
$offset: Int,
$before: Cursor,
$after: Cursor,
$orderBy: [TokenStatusesOrderBy!],
$condition: TokenStatusCondition,
$filter: TokenStatusFilter
) {
allTokenStatuses(
first: $first,
last: $last,
offset: $offset,
before: $before,
after: $after,
orderBy: $orderBy,
condition: $condition,
filter: $filter
) {
nodes {
...TokenStatusFragment
}
edges {
...TokenStatusesEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"first": 123,
"last": 987,
"offset": 123,
"before": Cursor,
"after": Cursor,
"orderBy": ["PRIMARY_KEY_ASC"],
"condition": TokenStatusCondition,
"filter": TokenStatusFilter
}
Response
{
"data": {
"allTokenStatuses": {
"nodes": [TokenStatus],
"edges": [TokenStatusesEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
}
}
allTokenTypes
Description
Reads and enables pagination through a set of TokenType.
Response
Returns a TokenTypesConnection
Arguments
| Name | Description |
|---|---|
first - Int
|
Only read the first n values of the set. |
last - Int
|
Only read the last n values of the set. |
offset - Int
|
Skip the first n values from our after cursor, an alternative to cursor based pagination. May not be used with last. |
before - Cursor
|
Read all values in the set before (above) this cursor. |
after - Cursor
|
Read all values in the set after (below) this cursor. |
orderBy - [TokenTypesOrderBy!]
|
The method to use when ordering TokenType. Default = [PRIMARY_KEY_ASC] |
condition - TokenTypeCondition
|
A condition to be used in determining which values should be returned by the collection. |
filter - TokenTypeFilter
|
A filter to be used in determining which values should be returned by the collection. |
Example
Query
query allTokenTypes(
$first: Int,
$last: Int,
$offset: Int,
$before: Cursor,
$after: Cursor,
$orderBy: [TokenTypesOrderBy!],
$condition: TokenTypeCondition,
$filter: TokenTypeFilter
) {
allTokenTypes(
first: $first,
last: $last,
offset: $offset,
before: $before,
after: $after,
orderBy: $orderBy,
condition: $condition,
filter: $filter
) {
nodes {
...TokenTypeFragment
}
edges {
...TokenTypesEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"first": 123,
"last": 123,
"offset": 987,
"before": Cursor,
"after": Cursor,
"orderBy": ["PRIMARY_KEY_ASC"],
"condition": TokenTypeCondition,
"filter": TokenTypeFilter
}
Response
{
"data": {
"allTokenTypes": {
"nodes": [TokenType],
"edges": [TokenTypesEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
}
}
allTokens
Description
Reads and enables pagination through a set of Token.
Response
Returns a TokensConnection
Arguments
| Name | Description |
|---|---|
first - Int
|
Only read the first n values of the set. |
last - Int
|
Only read the last n values of the set. |
offset - Int
|
Skip the first n values from our after cursor, an alternative to cursor based pagination. May not be used with last. |
before - Cursor
|
Read all values in the set before (above) this cursor. |
after - Cursor
|
Read all values in the set after (below) this cursor. |
orderBy - [TokensOrderBy!]
|
The method to use when ordering Token. Default = [PRIMARY_KEY_ASC] |
condition - TokenCondition
|
A condition to be used in determining which values should be returned by the collection. |
filter - TokenFilter
|
A filter to be used in determining which values should be returned by the collection. |
Example
Query
query allTokens(
$first: Int,
$last: Int,
$offset: Int,
$before: Cursor,
$after: Cursor,
$orderBy: [TokensOrderBy!],
$condition: TokenCondition,
$filter: TokenFilter
) {
allTokens(
first: $first,
last: $last,
offset: $offset,
before: $before,
after: $after,
orderBy: $orderBy,
condition: $condition,
filter: $filter
) {
nodes {
...TokenFragment
}
edges {
...TokensEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"first": 123,
"last": 123,
"offset": 123,
"before": Cursor,
"after": Cursor,
"orderBy": ["PRIMARY_KEY_ASC"],
"condition": TokenCondition,
"filter": TokenFilter
}
Response
{
"data": {
"allTokens": {
"nodes": [Token],
"edges": [TokensEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
}
}
allTrades
Description
Reads and enables pagination through a set of Trade.
Response
Returns a TradesConnection
Arguments
| Name | Description |
|---|---|
first - Int
|
Only read the first n values of the set. |
last - Int
|
Only read the last n values of the set. |
offset - Int
|
Skip the first n values from our after cursor, an alternative to cursor based pagination. May not be used with last. |
before - Cursor
|
Read all values in the set before (above) this cursor. |
after - Cursor
|
Read all values in the set after (below) this cursor. |
orderBy - [TradesOrderBy!]
|
The method to use when ordering Trade. Default = [NATURAL] |
condition - TradeCondition
|
A condition to be used in determining which values should be returned by the collection. |
filter - TradeFilter
|
A filter to be used in determining which values should be returned by the collection. |
Example
Query
query allTrades(
$first: Int,
$last: Int,
$offset: Int,
$before: Cursor,
$after: Cursor,
$orderBy: [TradesOrderBy!],
$condition: TradeCondition,
$filter: TradeFilter
) {
allTrades(
first: $first,
last: $last,
offset: $offset,
before: $before,
after: $after,
orderBy: $orderBy,
condition: $condition,
filter: $filter
) {
nodes {
...TradeFragment
}
edges {
...TradesEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"first": 123,
"last": 987,
"offset": 987,
"before": Cursor,
"after": Cursor,
"orderBy": ["NATURAL"],
"condition": TradeCondition,
"filter": TradeFilter
}
Response
{
"data": {
"allTrades": {
"nodes": [Trade],
"edges": [TradesEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
}
}
allTrancheBondData
Description
Reads and enables pagination through a set of TrancheBondDatum.
Response
Returns a TrancheBondDataConnection
Arguments
| Name | Description |
|---|---|
first - Int
|
Only read the first n values of the set. |
last - Int
|
Only read the last n values of the set. |
offset - Int
|
Skip the first n values from our after cursor, an alternative to cursor based pagination. May not be used with last. |
before - Cursor
|
Read all values in the set before (above) this cursor. |
after - Cursor
|
Read all values in the set after (below) this cursor. |
orderBy - [TrancheBondDataOrderBy!]
|
The method to use when ordering TrancheBondDatum. Default = [PRIMARY_KEY_ASC] |
condition - TrancheBondDatumCondition
|
A condition to be used in determining which values should be returned by the collection. |
filter - TrancheBondDatumFilter
|
A filter to be used in determining which values should be returned by the collection. |
Example
Query
query allTrancheBondData(
$first: Int,
$last: Int,
$offset: Int,
$before: Cursor,
$after: Cursor,
$orderBy: [TrancheBondDataOrderBy!],
$condition: TrancheBondDatumCondition,
$filter: TrancheBondDatumFilter
) {
allTrancheBondData(
first: $first,
last: $last,
offset: $offset,
before: $before,
after: $after,
orderBy: $orderBy,
condition: $condition,
filter: $filter
) {
nodes {
...TrancheBondDatumFragment
}
edges {
...TrancheBondDataEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"first": 987,
"last": 123,
"offset": 987,
"before": Cursor,
"after": Cursor,
"orderBy": ["PRIMARY_KEY_ASC"],
"condition": TrancheBondDatumCondition,
"filter": TrancheBondDatumFilter
}
Response
{
"data": {
"allTrancheBondData": {
"nodes": [TrancheBondDatum],
"edges": [TrancheBondDataEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
}
}
allTransactionAnnotations
Description
Reads and enables pagination through a set of TransactionAnnotation.
Response
Returns a TransactionAnnotationsConnection
Arguments
| Name | Description |
|---|---|
first - Int
|
Only read the first n values of the set. |
last - Int
|
Only read the last n values of the set. |
offset - Int
|
Skip the first n values from our after cursor, an alternative to cursor based pagination. May not be used with last. |
before - Cursor
|
Read all values in the set before (above) this cursor. |
after - Cursor
|
Read all values in the set after (below) this cursor. |
orderBy - [TransactionAnnotationsOrderBy!]
|
The method to use when ordering TransactionAnnotation. Default = [PRIMARY_KEY_ASC] |
condition - TransactionAnnotationCondition
|
A condition to be used in determining which values should be returned by the collection. |
filter - TransactionAnnotationFilter
|
A filter to be used in determining which values should be returned by the collection. |
Example
Query
query allTransactionAnnotations(
$first: Int,
$last: Int,
$offset: Int,
$before: Cursor,
$after: Cursor,
$orderBy: [TransactionAnnotationsOrderBy!],
$condition: TransactionAnnotationCondition,
$filter: TransactionAnnotationFilter
) {
allTransactionAnnotations(
first: $first,
last: $last,
offset: $offset,
before: $before,
after: $after,
orderBy: $orderBy,
condition: $condition,
filter: $filter
) {
nodes {
...TransactionAnnotationFragment
}
edges {
...TransactionAnnotationsEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"first": 987,
"last": 123,
"offset": 987,
"before": Cursor,
"after": Cursor,
"orderBy": ["PRIMARY_KEY_ASC"],
"condition": TransactionAnnotationCondition,
"filter": TransactionAnnotationFilter
}
Response
{
"data": {
"allTransactionAnnotations": {
"nodes": [TransactionAnnotation],
"edges": [TransactionAnnotationsEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
}
}
allTransactionGroupTypes
Description
Reads and enables pagination through a set of TransactionGroupType.
Response
Returns a TransactionGroupTypesConnection
Arguments
| Name | Description |
|---|---|
first - Int
|
Only read the first n values of the set. |
last - Int
|
Only read the last n values of the set. |
offset - Int
|
Skip the first n values from our after cursor, an alternative to cursor based pagination. May not be used with last. |
before - Cursor
|
Read all values in the set before (above) this cursor. |
after - Cursor
|
Read all values in the set after (below) this cursor. |
orderBy - [TransactionGroupTypesOrderBy!]
|
The method to use when ordering TransactionGroupType. Default = [PRIMARY_KEY_ASC] |
condition - TransactionGroupTypeCondition
|
A condition to be used in determining which values should be returned by the collection. |
filter - TransactionGroupTypeFilter
|
A filter to be used in determining which values should be returned by the collection. |
Example
Query
query allTransactionGroupTypes(
$first: Int,
$last: Int,
$offset: Int,
$before: Cursor,
$after: Cursor,
$orderBy: [TransactionGroupTypesOrderBy!],
$condition: TransactionGroupTypeCondition,
$filter: TransactionGroupTypeFilter
) {
allTransactionGroupTypes(
first: $first,
last: $last,
offset: $offset,
before: $before,
after: $after,
orderBy: $orderBy,
condition: $condition,
filter: $filter
) {
nodes {
...TransactionGroupTypeFragment
}
edges {
...TransactionGroupTypesEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"first": 987,
"last": 123,
"offset": 123,
"before": Cursor,
"after": Cursor,
"orderBy": ["PRIMARY_KEY_ASC"],
"condition": TransactionGroupTypeCondition,
"filter": TransactionGroupTypeFilter
}
Response
{
"data": {
"allTransactionGroupTypes": {
"nodes": [TransactionGroupType],
"edges": [TransactionGroupTypesEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
}
}
allTransactions
Description
Reads and enables pagination through a set of Transaction.
Response
Returns a TransactionsConnection
Arguments
| Name | Description |
|---|---|
first - Int
|
Only read the first n values of the set. |
last - Int
|
Only read the last n values of the set. |
offset - Int
|
Skip the first n values from our after cursor, an alternative to cursor based pagination. May not be used with last. |
before - Cursor
|
Read all values in the set before (above) this cursor. |
after - Cursor
|
Read all values in the set after (below) this cursor. |
orderBy - [TransactionsOrderBy!]
|
The method to use when ordering Transaction. Default = [PRIMARY_KEY_ASC] |
condition - TransactionCondition
|
A condition to be used in determining which values should be returned by the collection. |
filter - TransactionFilter
|
A filter to be used in determining which values should be returned by the collection. |
Example
Query
query allTransactions(
$first: Int,
$last: Int,
$offset: Int,
$before: Cursor,
$after: Cursor,
$orderBy: [TransactionsOrderBy!],
$condition: TransactionCondition,
$filter: TransactionFilter
) {
allTransactions(
first: $first,
last: $last,
offset: $offset,
before: $before,
after: $after,
orderBy: $orderBy,
condition: $condition,
filter: $filter
) {
nodes {
...TransactionFragment
}
edges {
...TransactionsEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"first": 987,
"last": 987,
"offset": 987,
"before": Cursor,
"after": Cursor,
"orderBy": ["PRIMARY_KEY_ASC"],
"condition": TransactionCondition,
"filter": TransactionFilter
}
Response
{
"data": {
"allTransactions": {
"nodes": [Transaction],
"edges": [TransactionsEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
}
}
allTransferTypes
Description
Reads and enables pagination through a set of TransferType.
Response
Returns a TransferTypesConnection
Arguments
| Name | Description |
|---|---|
first - Int
|
Only read the first n values of the set. |
last - Int
|
Only read the last n values of the set. |
offset - Int
|
Skip the first n values from our after cursor, an alternative to cursor based pagination. May not be used with last. |
before - Cursor
|
Read all values in the set before (above) this cursor. |
after - Cursor
|
Read all values in the set after (below) this cursor. |
orderBy - [TransferTypesOrderBy!]
|
The method to use when ordering TransferType. Default = [NATURAL] |
condition - TransferTypeCondition
|
A condition to be used in determining which values should be returned by the collection. |
filter - TransferTypeFilter
|
A filter to be used in determining which values should be returned by the collection. |
Example
Query
query allTransferTypes(
$first: Int,
$last: Int,
$offset: Int,
$before: Cursor,
$after: Cursor,
$orderBy: [TransferTypesOrderBy!],
$condition: TransferTypeCondition,
$filter: TransferTypeFilter
) {
allTransferTypes(
first: $first,
last: $last,
offset: $offset,
before: $before,
after: $after,
orderBy: $orderBy,
condition: $condition,
filter: $filter
) {
nodes {
...TransferTypeFragment
}
edges {
...TransferTypesEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"first": 123,
"last": 123,
"offset": 123,
"before": Cursor,
"after": Cursor,
"orderBy": ["NATURAL"],
"condition": TransferTypeCondition,
"filter": TransferTypeFilter
}
Response
{
"data": {
"allTransferTypes": {
"nodes": [TransferType],
"edges": [TransferTypesEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
}
}
allTransfers
Description
Reads and enables pagination through a set of Transfer.
Response
Returns a TransfersConnection
Arguments
| Name | Description |
|---|---|
first - Int
|
Only read the first n values of the set. |
last - Int
|
Only read the last n values of the set. |
offset - Int
|
Skip the first n values from our after cursor, an alternative to cursor based pagination. May not be used with last. |
before - Cursor
|
Read all values in the set before (above) this cursor. |
after - Cursor
|
Read all values in the set after (below) this cursor. |
orderBy - [TransfersOrderBy!]
|
The method to use when ordering Transfer. Default = [NATURAL] |
condition - TransferCondition
|
A condition to be used in determining which values should be returned by the collection. |
filter - TransferFilter
|
A filter to be used in determining which values should be returned by the collection. |
Example
Query
query allTransfers(
$first: Int,
$last: Int,
$offset: Int,
$before: Cursor,
$after: Cursor,
$orderBy: [TransfersOrderBy!],
$condition: TransferCondition,
$filter: TransferFilter
) {
allTransfers(
first: $first,
last: $last,
offset: $offset,
before: $before,
after: $after,
orderBy: $orderBy,
condition: $condition,
filter: $filter
) {
nodes {
...TransferFragment
}
edges {
...TransfersEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"first": 987,
"last": 987,
"offset": 123,
"before": Cursor,
"after": Cursor,
"orderBy": ["NATURAL"],
"condition": TransferCondition,
"filter": TransferFilter
}
Response
{
"data": {
"allTransfers": {
"nodes": [Transfer],
"edges": [TransfersEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
}
}
allUserStatuses
Description
Reads and enables pagination through a set of UserStatus.
Response
Returns a UserStatusesConnection
Arguments
| Name | Description |
|---|---|
first - Int
|
Only read the first n values of the set. |
last - Int
|
Only read the last n values of the set. |
offset - Int
|
Skip the first n values from our after cursor, an alternative to cursor based pagination. May not be used with last. |
before - Cursor
|
Read all values in the set before (above) this cursor. |
after - Cursor
|
Read all values in the set after (below) this cursor. |
orderBy - [UserStatusesOrderBy!]
|
The method to use when ordering UserStatus. Default = [PRIMARY_KEY_ASC] |
condition - UserStatusCondition
|
A condition to be used in determining which values should be returned by the collection. |
filter - UserStatusFilter
|
A filter to be used in determining which values should be returned by the collection. |
Example
Query
query allUserStatuses(
$first: Int,
$last: Int,
$offset: Int,
$before: Cursor,
$after: Cursor,
$orderBy: [UserStatusesOrderBy!],
$condition: UserStatusCondition,
$filter: UserStatusFilter
) {
allUserStatuses(
first: $first,
last: $last,
offset: $offset,
before: $before,
after: $after,
orderBy: $orderBy,
condition: $condition,
filter: $filter
) {
nodes {
...UserStatusFragment
}
edges {
...UserStatusesEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"first": 123,
"last": 987,
"offset": 987,
"before": Cursor,
"after": Cursor,
"orderBy": ["PRIMARY_KEY_ASC"],
"condition": UserStatusCondition,
"filter": UserStatusFilter
}
Response
{
"data": {
"allUserStatuses": {
"nodes": [UserStatus],
"edges": [UserStatusesEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
}
}
allUserTermsOfServices
Description
Reads and enables pagination through a set of UserTermsOfService.
Response
Returns a UserTermsOfServicesConnection
Arguments
| Name | Description |
|---|---|
first - Int
|
Only read the first n values of the set. |
last - Int
|
Only read the last n values of the set. |
offset - Int
|
Skip the first n values from our after cursor, an alternative to cursor based pagination. May not be used with last. |
before - Cursor
|
Read all values in the set before (above) this cursor. |
after - Cursor
|
Read all values in the set after (below) this cursor. |
orderBy - [UserTermsOfServicesOrderBy!]
|
The method to use when ordering UserTermsOfService. Default = [PRIMARY_KEY_ASC] |
condition - UserTermsOfServiceCondition
|
A condition to be used in determining which values should be returned by the collection. |
filter - UserTermsOfServiceFilter
|
A filter to be used in determining which values should be returned by the collection. |
Example
Query
query allUserTermsOfServices(
$first: Int,
$last: Int,
$offset: Int,
$before: Cursor,
$after: Cursor,
$orderBy: [UserTermsOfServicesOrderBy!],
$condition: UserTermsOfServiceCondition,
$filter: UserTermsOfServiceFilter
) {
allUserTermsOfServices(
first: $first,
last: $last,
offset: $offset,
before: $before,
after: $after,
orderBy: $orderBy,
condition: $condition,
filter: $filter
) {
nodes {
...UserTermsOfServiceFragment
}
edges {
...UserTermsOfServicesEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"first": 123,
"last": 987,
"offset": 123,
"before": Cursor,
"after": Cursor,
"orderBy": ["PRIMARY_KEY_ASC"],
"condition": UserTermsOfServiceCondition,
"filter": UserTermsOfServiceFilter
}
Response
{
"data": {
"allUserTermsOfServices": {
"nodes": [UserTermsOfService],
"edges": [UserTermsOfServicesEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
}
}
allUsers
Description
Reads and enables pagination through a set of User.
Response
Returns a UsersConnection
Arguments
| Name | Description |
|---|---|
first - Int
|
Only read the first n values of the set. |
last - Int
|
Only read the last n values of the set. |
offset - Int
|
Skip the first n values from our after cursor, an alternative to cursor based pagination. May not be used with last. |
before - Cursor
|
Read all values in the set before (above) this cursor. |
after - Cursor
|
Read all values in the set after (below) this cursor. |
orderBy - [UsersOrderBy!]
|
The method to use when ordering User. Default = [PRIMARY_KEY_ASC] |
condition - UserCondition
|
A condition to be used in determining which values should be returned by the collection. |
filter - UserFilter
|
A filter to be used in determining which values should be returned by the collection. |
Example
Query
query allUsers(
$first: Int,
$last: Int,
$offset: Int,
$before: Cursor,
$after: Cursor,
$orderBy: [UsersOrderBy!],
$condition: UserCondition,
$filter: UserFilter
) {
allUsers(
first: $first,
last: $last,
offset: $offset,
before: $before,
after: $after,
orderBy: $orderBy,
condition: $condition,
filter: $filter
) {
nodes {
...UserFragment
}
edges {
...UsersEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"first": 987,
"last": 987,
"offset": 987,
"before": Cursor,
"after": Cursor,
"orderBy": ["PRIMARY_KEY_ASC"],
"condition": UserCondition,
"filter": UserFilter
}
Response
{
"data": {
"allUsers": {
"nodes": [User],
"edges": [UsersEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
}
}
allUsersAccounts
Description
Reads and enables pagination through a set of UsersAccount.
Response
Returns a UsersAccountsConnection
Arguments
| Name | Description |
|---|---|
first - Int
|
Only read the first n values of the set. |
last - Int
|
Only read the last n values of the set. |
offset - Int
|
Skip the first n values from our after cursor, an alternative to cursor based pagination. May not be used with last. |
before - Cursor
|
Read all values in the set before (above) this cursor. |
after - Cursor
|
Read all values in the set after (below) this cursor. |
orderBy - [UsersAccountsOrderBy!]
|
The method to use when ordering UsersAccount. Default = [PRIMARY_KEY_ASC] |
condition - UsersAccountCondition
|
A condition to be used in determining which values should be returned by the collection. |
filter - UsersAccountFilter
|
A filter to be used in determining which values should be returned by the collection. |
Example
Query
query allUsersAccounts(
$first: Int,
$last: Int,
$offset: Int,
$before: Cursor,
$after: Cursor,
$orderBy: [UsersAccountsOrderBy!],
$condition: UsersAccountCondition,
$filter: UsersAccountFilter
) {
allUsersAccounts(
first: $first,
last: $last,
offset: $offset,
before: $before,
after: $after,
orderBy: $orderBy,
condition: $condition,
filter: $filter
) {
nodes {
...UsersAccountFragment
}
edges {
...UsersAccountsEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"first": 123,
"last": 123,
"offset": 987,
"before": Cursor,
"after": Cursor,
"orderBy": ["PRIMARY_KEY_ASC"],
"condition": UsersAccountCondition,
"filter": UsersAccountFilter
}
Response
{
"data": {
"allUsersAccounts": {
"nodes": [UsersAccount],
"edges": [UsersAccountsEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
}
}
allVendorAgents
Description
Reads and enables pagination through a set of VendorAgent.
Response
Returns a VendorAgentsConnection
Arguments
| Name | Description |
|---|---|
first - Int
|
Only read the first n values of the set. |
last - Int
|
Only read the last n values of the set. |
offset - Int
|
Skip the first n values from our after cursor, an alternative to cursor based pagination. May not be used with last. |
before - Cursor
|
Read all values in the set before (above) this cursor. |
after - Cursor
|
Read all values in the set after (below) this cursor. |
orderBy - [VendorAgentsOrderBy!]
|
The method to use when ordering VendorAgent. Default = [PRIMARY_KEY_ASC] |
condition - VendorAgentCondition
|
A condition to be used in determining which values should be returned by the collection. |
filter - VendorAgentFilter
|
A filter to be used in determining which values should be returned by the collection. |
Example
Query
query allVendorAgents(
$first: Int,
$last: Int,
$offset: Int,
$before: Cursor,
$after: Cursor,
$orderBy: [VendorAgentsOrderBy!],
$condition: VendorAgentCondition,
$filter: VendorAgentFilter
) {
allVendorAgents(
first: $first,
last: $last,
offset: $offset,
before: $before,
after: $after,
orderBy: $orderBy,
condition: $condition,
filter: $filter
) {
nodes {
...VendorAgentFragment
}
edges {
...VendorAgentsEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"first": 987,
"last": 987,
"offset": 987,
"before": Cursor,
"after": Cursor,
"orderBy": ["PRIMARY_KEY_ASC"],
"condition": VendorAgentCondition,
"filter": VendorAgentFilter
}
Response
{
"data": {
"allVendorAgents": {
"nodes": [VendorAgent],
"edges": [VendorAgentsEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
}
}
allVendorDefaultEmailPreferences
Description
Reads and enables pagination through a set of VendorDefaultEmailPreference.
Response
Returns a VendorDefaultEmailPreferencesConnection
Arguments
| Name | Description |
|---|---|
first - Int
|
Only read the first n values of the set. |
last - Int
|
Only read the last n values of the set. |
offset - Int
|
Skip the first n values from our after cursor, an alternative to cursor based pagination. May not be used with last. |
before - Cursor
|
Read all values in the set before (above) this cursor. |
after - Cursor
|
Read all values in the set after (below) this cursor. |
orderBy - [VendorDefaultEmailPreferencesOrderBy!]
|
The method to use when ordering VendorDefaultEmailPreference. Default = [PRIMARY_KEY_ASC] |
condition - VendorDefaultEmailPreferenceCondition
|
A condition to be used in determining which values should be returned by the collection. |
filter - VendorDefaultEmailPreferenceFilter
|
A filter to be used in determining which values should be returned by the collection. |
Example
Query
query allVendorDefaultEmailPreferences(
$first: Int,
$last: Int,
$offset: Int,
$before: Cursor,
$after: Cursor,
$orderBy: [VendorDefaultEmailPreferencesOrderBy!],
$condition: VendorDefaultEmailPreferenceCondition,
$filter: VendorDefaultEmailPreferenceFilter
) {
allVendorDefaultEmailPreferences(
first: $first,
last: $last,
offset: $offset,
before: $before,
after: $after,
orderBy: $orderBy,
condition: $condition,
filter: $filter
) {
nodes {
...VendorDefaultEmailPreferenceFragment
}
edges {
...VendorDefaultEmailPreferencesEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"first": 123,
"last": 123,
"offset": 987,
"before": Cursor,
"after": Cursor,
"orderBy": ["PRIMARY_KEY_ASC"],
"condition": VendorDefaultEmailPreferenceCondition,
"filter": VendorDefaultEmailPreferenceFilter
}
Response
{
"data": {
"allVendorDefaultEmailPreferences": {
"nodes": [VendorDefaultEmailPreference],
"edges": [VendorDefaultEmailPreferencesEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
}
}
allVendorIntegrationStatuses
Description
Reads and enables pagination through a set of VendorIntegrationStatus.
Response
Returns a VendorIntegrationStatusesConnection
Arguments
| Name | Description |
|---|---|
first - Int
|
Only read the first n values of the set. |
last - Int
|
Only read the last n values of the set. |
offset - Int
|
Skip the first n values from our after cursor, an alternative to cursor based pagination. May not be used with last. |
before - Cursor
|
Read all values in the set before (above) this cursor. |
after - Cursor
|
Read all values in the set after (below) this cursor. |
orderBy - [VendorIntegrationStatusesOrderBy!]
|
The method to use when ordering VendorIntegrationStatus. Default = [PRIMARY_KEY_ASC] |
condition - VendorIntegrationStatusCondition
|
A condition to be used in determining which values should be returned by the collection. |
filter - VendorIntegrationStatusFilter
|
A filter to be used in determining which values should be returned by the collection. |
Example
Query
query allVendorIntegrationStatuses(
$first: Int,
$last: Int,
$offset: Int,
$before: Cursor,
$after: Cursor,
$orderBy: [VendorIntegrationStatusesOrderBy!],
$condition: VendorIntegrationStatusCondition,
$filter: VendorIntegrationStatusFilter
) {
allVendorIntegrationStatuses(
first: $first,
last: $last,
offset: $offset,
before: $before,
after: $after,
orderBy: $orderBy,
condition: $condition,
filter: $filter
) {
nodes {
...VendorIntegrationStatusFragment
}
edges {
...VendorIntegrationStatusesEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"first": 987,
"last": 987,
"offset": 987,
"before": Cursor,
"after": Cursor,
"orderBy": ["PRIMARY_KEY_ASC"],
"condition": VendorIntegrationStatusCondition,
"filter": VendorIntegrationStatusFilter
}
Response
{
"data": {
"allVendorIntegrationStatuses": {
"nodes": [VendorIntegrationStatus],
"edges": [VendorIntegrationStatusesEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
}
}
allVendorQualificationConstraints
Description
Reads and enables pagination through a set of VendorQualificationConstraint.
Response
Returns a VendorQualificationConstraintsConnection
Arguments
| Name | Description |
|---|---|
first - Int
|
Only read the first n values of the set. |
last - Int
|
Only read the last n values of the set. |
offset - Int
|
Skip the first n values from our after cursor, an alternative to cursor based pagination. May not be used with last. |
before - Cursor
|
Read all values in the set before (above) this cursor. |
after - Cursor
|
Read all values in the set after (below) this cursor. |
orderBy - [VendorQualificationConstraintsOrderBy!]
|
The method to use when ordering VendorQualificationConstraint. Default = [PRIMARY_KEY_ASC] |
condition - VendorQualificationConstraintCondition
|
A condition to be used in determining which values should be returned by the collection. |
filter - VendorQualificationConstraintFilter
|
A filter to be used in determining which values should be returned by the collection. |
Example
Query
query allVendorQualificationConstraints(
$first: Int,
$last: Int,
$offset: Int,
$before: Cursor,
$after: Cursor,
$orderBy: [VendorQualificationConstraintsOrderBy!],
$condition: VendorQualificationConstraintCondition,
$filter: VendorQualificationConstraintFilter
) {
allVendorQualificationConstraints(
first: $first,
last: $last,
offset: $offset,
before: $before,
after: $after,
orderBy: $orderBy,
condition: $condition,
filter: $filter
) {
nodes {
...VendorQualificationConstraintFragment
}
edges {
...VendorQualificationConstraintsEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"first": 123,
"last": 987,
"offset": 123,
"before": Cursor,
"after": Cursor,
"orderBy": ["PRIMARY_KEY_ASC"],
"condition": VendorQualificationConstraintCondition,
"filter": VendorQualificationConstraintFilter
}
Response
{
"data": {
"allVendorQualificationConstraints": {
"nodes": [VendorQualificationConstraint],
"edges": [VendorQualificationConstraintsEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
}
}
allVendorQualificationStepTypes
Description
Reads and enables pagination through a set of VendorQualificationStepType.
Response
Returns a VendorQualificationStepTypesConnection
Arguments
| Name | Description |
|---|---|
first - Int
|
Only read the first n values of the set. |
last - Int
|
Only read the last n values of the set. |
offset - Int
|
Skip the first n values from our after cursor, an alternative to cursor based pagination. May not be used with last. |
before - Cursor
|
Read all values in the set before (above) this cursor. |
after - Cursor
|
Read all values in the set after (below) this cursor. |
orderBy - [VendorQualificationStepTypesOrderBy!]
|
The method to use when ordering VendorQualificationStepType. Default = [PRIMARY_KEY_ASC] |
condition - VendorQualificationStepTypeCondition
|
A condition to be used in determining which values should be returned by the collection. |
filter - VendorQualificationStepTypeFilter
|
A filter to be used in determining which values should be returned by the collection. |
Example
Query
query allVendorQualificationStepTypes(
$first: Int,
$last: Int,
$offset: Int,
$before: Cursor,
$after: Cursor,
$orderBy: [VendorQualificationStepTypesOrderBy!],
$condition: VendorQualificationStepTypeCondition,
$filter: VendorQualificationStepTypeFilter
) {
allVendorQualificationStepTypes(
first: $first,
last: $last,
offset: $offset,
before: $before,
after: $after,
orderBy: $orderBy,
condition: $condition,
filter: $filter
) {
nodes {
...VendorQualificationStepTypeFragment
}
edges {
...VendorQualificationStepTypesEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"first": 123,
"last": 123,
"offset": 123,
"before": Cursor,
"after": Cursor,
"orderBy": ["PRIMARY_KEY_ASC"],
"condition": VendorQualificationStepTypeCondition,
"filter": VendorQualificationStepTypeFilter
}
Response
{
"data": {
"allVendorQualificationStepTypes": {
"nodes": [VendorQualificationStepType],
"edges": [VendorQualificationStepTypesEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
}
}
allVendorQualifications
Description
Reads and enables pagination through a set of VendorQualification.
Response
Returns a VendorQualificationsConnection
Arguments
| Name | Description |
|---|---|
first - Int
|
Only read the first n values of the set. |
last - Int
|
Only read the last n values of the set. |
offset - Int
|
Skip the first n values from our after cursor, an alternative to cursor based pagination. May not be used with last. |
before - Cursor
|
Read all values in the set before (above) this cursor. |
after - Cursor
|
Read all values in the set after (below) this cursor. |
orderBy - [VendorQualificationsOrderBy!]
|
The method to use when ordering VendorQualification. Default = [PRIMARY_KEY_ASC] |
condition - VendorQualificationCondition
|
A condition to be used in determining which values should be returned by the collection. |
filter - VendorQualificationFilter
|
A filter to be used in determining which values should be returned by the collection. |
Example
Query
query allVendorQualifications(
$first: Int,
$last: Int,
$offset: Int,
$before: Cursor,
$after: Cursor,
$orderBy: [VendorQualificationsOrderBy!],
$condition: VendorQualificationCondition,
$filter: VendorQualificationFilter
) {
allVendorQualifications(
first: $first,
last: $last,
offset: $offset,
before: $before,
after: $after,
orderBy: $orderBy,
condition: $condition,
filter: $filter
) {
nodes {
...VendorQualificationFragment
}
edges {
...VendorQualificationsEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"first": 123,
"last": 123,
"offset": 123,
"before": Cursor,
"after": Cursor,
"orderBy": ["PRIMARY_KEY_ASC"],
"condition": VendorQualificationCondition,
"filter": VendorQualificationFilter
}
Response
{
"data": {
"allVendorQualifications": {
"nodes": [VendorQualification],
"edges": [VendorQualificationsEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
}
}
allVestingDurations
Description
Reads and enables pagination through a set of VestingDuration.
Response
Returns a VestingDurationsConnection
Arguments
| Name | Description |
|---|---|
first - Int
|
Only read the first n values of the set. |
last - Int
|
Only read the last n values of the set. |
offset - Int
|
Skip the first n values from our after cursor, an alternative to cursor based pagination. May not be used with last. |
before - Cursor
|
Read all values in the set before (above) this cursor. |
after - Cursor
|
Read all values in the set after (below) this cursor. |
orderBy - [VestingDurationsOrderBy!]
|
The method to use when ordering VestingDuration. Default = [PRIMARY_KEY_ASC] |
condition - VestingDurationCondition
|
A condition to be used in determining which values should be returned by the collection. |
filter - VestingDurationFilter
|
A filter to be used in determining which values should be returned by the collection. |
Example
Query
query allVestingDurations(
$first: Int,
$last: Int,
$offset: Int,
$before: Cursor,
$after: Cursor,
$orderBy: [VestingDurationsOrderBy!],
$condition: VestingDurationCondition,
$filter: VestingDurationFilter
) {
allVestingDurations(
first: $first,
last: $last,
offset: $offset,
before: $before,
after: $after,
orderBy: $orderBy,
condition: $condition,
filter: $filter
) {
nodes {
...VestingDurationFragment
}
edges {
...VestingDurationsEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"first": 123,
"last": 987,
"offset": 123,
"before": Cursor,
"after": Cursor,
"orderBy": ["PRIMARY_KEY_ASC"],
"condition": VestingDurationCondition,
"filter": VestingDurationFilter
}
Response
{
"data": {
"allVestingDurations": {
"nodes": [VestingDuration],
"edges": [VestingDurationsEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
}
}
allVestingEvents
Description
Reads and enables pagination through a set of VestingEvent.
Response
Returns a VestingEventsConnection
Arguments
| Name | Description |
|---|---|
first - Int
|
Only read the first n values of the set. |
last - Int
|
Only read the last n values of the set. |
offset - Int
|
Skip the first n values from our after cursor, an alternative to cursor based pagination. May not be used with last. |
before - Cursor
|
Read all values in the set before (above) this cursor. |
after - Cursor
|
Read all values in the set after (below) this cursor. |
orderBy - [VestingEventsOrderBy!]
|
The method to use when ordering VestingEvent. Default = [PRIMARY_KEY_ASC] |
condition - VestingEventCondition
|
A condition to be used in determining which values should be returned by the collection. |
filter - VestingEventFilter
|
A filter to be used in determining which values should be returned by the collection. |
Example
Query
query allVestingEvents(
$first: Int,
$last: Int,
$offset: Int,
$before: Cursor,
$after: Cursor,
$orderBy: [VestingEventsOrderBy!],
$condition: VestingEventCondition,
$filter: VestingEventFilter
) {
allVestingEvents(
first: $first,
last: $last,
offset: $offset,
before: $before,
after: $after,
orderBy: $orderBy,
condition: $condition,
filter: $filter
) {
nodes {
...VestingEventFragment
}
edges {
...VestingEventsEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"first": 987,
"last": 123,
"offset": 987,
"before": Cursor,
"after": Cursor,
"orderBy": ["PRIMARY_KEY_ASC"],
"condition": VestingEventCondition,
"filter": VestingEventFilter
}
Response
{
"data": {
"allVestingEvents": {
"nodes": [VestingEvent],
"edges": [VestingEventsEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
}
}
allVestingSchedules
Description
Reads and enables pagination through a set of VestingSchedule.
Response
Returns a VestingSchedulesConnection
Arguments
| Name | Description |
|---|---|
first - Int
|
Only read the first n values of the set. |
last - Int
|
Only read the last n values of the set. |
offset - Int
|
Skip the first n values from our after cursor, an alternative to cursor based pagination. May not be used with last. |
before - Cursor
|
Read all values in the set before (above) this cursor. |
after - Cursor
|
Read all values in the set after (below) this cursor. |
orderBy - [VestingSchedulesOrderBy!]
|
The method to use when ordering VestingSchedule. Default = [PRIMARY_KEY_ASC] |
condition - VestingScheduleCondition
|
A condition to be used in determining which values should be returned by the collection. |
filter - VestingScheduleFilter
|
A filter to be used in determining which values should be returned by the collection. |
Example
Query
query allVestingSchedules(
$first: Int,
$last: Int,
$offset: Int,
$before: Cursor,
$after: Cursor,
$orderBy: [VestingSchedulesOrderBy!],
$condition: VestingScheduleCondition,
$filter: VestingScheduleFilter
) {
allVestingSchedules(
first: $first,
last: $last,
offset: $offset,
before: $before,
after: $after,
orderBy: $orderBy,
condition: $condition,
filter: $filter
) {
nodes {
...VestingScheduleFragment
}
edges {
...VestingSchedulesEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"first": 987,
"last": 987,
"offset": 987,
"before": Cursor,
"after": Cursor,
"orderBy": ["PRIMARY_KEY_ASC"],
"condition": VestingScheduleCondition,
"filter": VestingScheduleFilter
}
Response
{
"data": {
"allVestingSchedules": {
"nodes": [VestingSchedule],
"edges": [VestingSchedulesEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
}
}
allWalletAssignments
Description
Reads and enables pagination through a set of WalletAssignment.
Response
Returns a WalletAssignmentsConnection
Arguments
| Name | Description |
|---|---|
first - Int
|
Only read the first n values of the set. |
last - Int
|
Only read the last n values of the set. |
offset - Int
|
Skip the first n values from our after cursor, an alternative to cursor based pagination. May not be used with last. |
before - Cursor
|
Read all values in the set before (above) this cursor. |
after - Cursor
|
Read all values in the set after (below) this cursor. |
orderBy - [WalletAssignmentsOrderBy!]
|
The method to use when ordering WalletAssignment. Default = [PRIMARY_KEY_ASC] |
condition - WalletAssignmentCondition
|
A condition to be used in determining which values should be returned by the collection. |
filter - WalletAssignmentFilter
|
A filter to be used in determining which values should be returned by the collection. |
Example
Query
query allWalletAssignments(
$first: Int,
$last: Int,
$offset: Int,
$before: Cursor,
$after: Cursor,
$orderBy: [WalletAssignmentsOrderBy!],
$condition: WalletAssignmentCondition,
$filter: WalletAssignmentFilter
) {
allWalletAssignments(
first: $first,
last: $last,
offset: $offset,
before: $before,
after: $after,
orderBy: $orderBy,
condition: $condition,
filter: $filter
) {
nodes {
...WalletAssignmentFragment
}
edges {
...WalletAssignmentsEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"first": 987,
"last": 987,
"offset": 123,
"before": Cursor,
"after": Cursor,
"orderBy": ["PRIMARY_KEY_ASC"],
"condition": WalletAssignmentCondition,
"filter": WalletAssignmentFilter
}
Response
{
"data": {
"allWalletAssignments": {
"nodes": [WalletAssignment],
"edges": [WalletAssignmentsEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
}
}
allWebhookConfigurations
Description
Reads and enables pagination through a set of WebhookConfiguration.
Response
Returns a WebhookConfigurationsConnection
Arguments
| Name | Description |
|---|---|
first - Int
|
Only read the first n values of the set. |
last - Int
|
Only read the last n values of the set. |
offset - Int
|
Skip the first n values from our after cursor, an alternative to cursor based pagination. May not be used with last. |
before - Cursor
|
Read all values in the set before (above) this cursor. |
after - Cursor
|
Read all values in the set after (below) this cursor. |
orderBy - [WebhookConfigurationsOrderBy!]
|
The method to use when ordering WebhookConfiguration. Default = [PRIMARY_KEY_ASC] |
condition - WebhookConfigurationCondition
|
A condition to be used in determining which values should be returned by the collection. |
filter - WebhookConfigurationFilter
|
A filter to be used in determining which values should be returned by the collection. |
Example
Query
query allWebhookConfigurations(
$first: Int,
$last: Int,
$offset: Int,
$before: Cursor,
$after: Cursor,
$orderBy: [WebhookConfigurationsOrderBy!],
$condition: WebhookConfigurationCondition,
$filter: WebhookConfigurationFilter
) {
allWebhookConfigurations(
first: $first,
last: $last,
offset: $offset,
before: $before,
after: $after,
orderBy: $orderBy,
condition: $condition,
filter: $filter
) {
nodes {
...WebhookConfigurationFragment
}
edges {
...WebhookConfigurationsEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"first": 987,
"last": 987,
"offset": 987,
"before": Cursor,
"after": Cursor,
"orderBy": ["PRIMARY_KEY_ASC"],
"condition": WebhookConfigurationCondition,
"filter": WebhookConfigurationFilter
}
Response
{
"data": {
"allWebhookConfigurations": {
"nodes": [WebhookConfiguration],
"edges": [WebhookConfigurationsEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
}
}
allWebhookLevels
Description
Reads and enables pagination through a set of WebhookLevel.
Response
Returns a WebhookLevelsConnection
Arguments
| Name | Description |
|---|---|
first - Int
|
Only read the first n values of the set. |
last - Int
|
Only read the last n values of the set. |
offset - Int
|
Skip the first n values from our after cursor, an alternative to cursor based pagination. May not be used with last. |
before - Cursor
|
Read all values in the set before (above) this cursor. |
after - Cursor
|
Read all values in the set after (below) this cursor. |
orderBy - [WebhookLevelsOrderBy!]
|
The method to use when ordering WebhookLevel. Default = [PRIMARY_KEY_ASC] |
condition - WebhookLevelCondition
|
A condition to be used in determining which values should be returned by the collection. |
filter - WebhookLevelFilter
|
A filter to be used in determining which values should be returned by the collection. |
Example
Query
query allWebhookLevels(
$first: Int,
$last: Int,
$offset: Int,
$before: Cursor,
$after: Cursor,
$orderBy: [WebhookLevelsOrderBy!],
$condition: WebhookLevelCondition,
$filter: WebhookLevelFilter
) {
allWebhookLevels(
first: $first,
last: $last,
offset: $offset,
before: $before,
after: $after,
orderBy: $orderBy,
condition: $condition,
filter: $filter
) {
nodes {
...WebhookLevelFragment
}
edges {
...WebhookLevelsEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"first": 123,
"last": 123,
"offset": 123,
"before": Cursor,
"after": Cursor,
"orderBy": ["PRIMARY_KEY_ASC"],
"condition": WebhookLevelCondition,
"filter": WebhookLevelFilter
}
Response
{
"data": {
"allWebhookLevels": {
"nodes": [WebhookLevel],
"edges": [WebhookLevelsEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
}
}
allocation
Description
Reads a single Allocation using its globally unique ID.
Response
Returns an Allocation
Arguments
| Name | Description |
|---|---|
nodeId - ID!
|
The globally unique ID to be used in selecting a single Allocation. |
Example
Query
query allocation($nodeId: ID!) {
allocation(nodeId: $nodeId) {
nodeId
ownerId
blockchainAddressId
issuerId
name
createdOn
opensOn
closesOn
status
roundId
id
accountByOwnerId {
...AccountFragment
}
blockchainAddressByBlockchainAddressId {
...BlockchainAddressFragment
}
accountByIssuerId {
...AccountFragment
}
assetStatusByStatus {
...AssetStatusFragment
}
roundByRoundId {
...RoundFragment
}
allocationArchivesByAllocationId {
...AllocationArchivesConnectionFragment
}
distributionsByAllocationId {
...DistributionsConnectionFragment
}
allocationAnnotationsByAllocationId {
...AllocationAnnotationsConnectionFragment
}
allocationsVestingScheduleByAllocationId {
...AllocationsVestingScheduleFragment
}
allocationsVestingSchedulesByAllocationId {
...AllocationsVestingSchedulesConnectionFragment
}
allocationQualificationsByAllocationId {
...AllocationQualificationsConnectionFragment
}
allocationOfferingLinksByAllocationId {
...AllocationOfferingLinksConnectionFragment
}
allocationEmailPreferenceByAllocationId {
...AllocationEmailPreferenceFragment
}
allocationEmailPreferencesByAllocationId {
...AllocationEmailPreferencesConnectionFragment
}
managedUnits
}
}
Variables
{"nodeId": "4"}
Response
{
"data": {
"allocation": {
"nodeId": 4,
"ownerId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"blockchainAddressId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"issuerId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"name": "abc123",
"createdOn": Datetime,
"opensOn": Datetime,
"closesOn": Datetime,
"status": "xyz789",
"roundId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountByOwnerId": Account,
"blockchainAddressByBlockchainAddressId": BlockchainAddress,
"accountByIssuerId": Account,
"assetStatusByStatus": AssetStatus,
"roundByRoundId": Round,
"allocationArchivesByAllocationId": AllocationArchivesConnection,
"distributionsByAllocationId": DistributionsConnection,
"allocationAnnotationsByAllocationId": AllocationAnnotationsConnection,
"allocationsVestingScheduleByAllocationId": AllocationsVestingSchedule,
"allocationsVestingSchedulesByAllocationId": AllocationsVestingSchedulesConnection,
"allocationQualificationsByAllocationId": AllocationQualificationsConnection,
"allocationOfferingLinksByAllocationId": AllocationOfferingLinksConnection,
"allocationEmailPreferenceByAllocationId": AllocationEmailPreference,
"allocationEmailPreferencesByAllocationId": AllocationEmailPreferencesConnection,
"managedUnits": BigFloat
}
}
}
allocationAnnotation
Description
Reads a single AllocationAnnotation using its globally unique ID.
Response
Returns an AllocationAnnotation
Arguments
| Name | Description |
|---|---|
nodeId - ID!
|
The globally unique ID to be used in selecting a single AllocationAnnotation. |
Example
Query
query allocationAnnotation($nodeId: ID!) {
allocationAnnotation(nodeId: $nodeId) {
nodeId
allocationId
writtenBy
accountId
annotation
archive
createdOn
id
allocationByAllocationId {
...AllocationFragment
}
userByWrittenBy {
...UserFragment
}
accountByAccountId {
...AccountFragment
}
}
}
Variables
{"nodeId": "4"}
Response
{
"data": {
"allocationAnnotation": {
"nodeId": "4",
"allocationId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"writtenBy": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"annotation": "abc123",
"archive": false,
"createdOn": Datetime,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"allocationByAllocationId": Allocation,
"userByWrittenBy": User,
"accountByAccountId": Account
}
}
}
allocationAnnotationById
Response
Returns an AllocationAnnotation
Arguments
| Name | Description |
|---|---|
id - UUID!
|
Example
Query
query allocationAnnotationById($id: UUID!) {
allocationAnnotationById(id: $id) {
nodeId
allocationId
writtenBy
accountId
annotation
archive
createdOn
id
allocationByAllocationId {
...AllocationFragment
}
userByWrittenBy {
...UserFragment
}
accountByAccountId {
...AccountFragment
}
}
}
Variables
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
Response
{
"data": {
"allocationAnnotationById": {
"nodeId": 4,
"allocationId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"writtenBy": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"annotation": "xyz789",
"archive": false,
"createdOn": Datetime,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"allocationByAllocationId": Allocation,
"userByWrittenBy": User,
"accountByAccountId": Account
}
}
}
allocationArchive
Description
Reads a single AllocationArchive using its globally unique ID.
Response
Returns an AllocationArchive
Arguments
| Name | Description |
|---|---|
nodeId - ID!
|
The globally unique ID to be used in selecting a single AllocationArchive. |
Example
Query
query allocationArchive($nodeId: ID!) {
allocationArchive(nodeId: $nodeId) {
nodeId
allocationId
accountId
archive
displayOrder
id
allocationByAllocationId {
...AllocationFragment
}
accountByAccountId {
...AccountFragment
}
}
}
Variables
{"nodeId": "4"}
Response
{
"data": {
"allocationArchive": {
"nodeId": 4,
"allocationId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"archive": false,
"displayOrder": 987,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"allocationByAllocationId": Allocation,
"accountByAccountId": Account
}
}
}
allocationArchiveByAllocationIdAndAccountId
Response
Returns an AllocationArchive
Example
Query
query allocationArchiveByAllocationIdAndAccountId(
$allocationId: UUID!,
$accountId: UUID!
) {
allocationArchiveByAllocationIdAndAccountId(
allocationId: $allocationId,
accountId: $accountId
) {
nodeId
allocationId
accountId
archive
displayOrder
id
allocationByAllocationId {
...AllocationFragment
}
accountByAccountId {
...AccountFragment
}
}
}
Variables
{
"allocationId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
Response
{
"data": {
"allocationArchiveByAllocationIdAndAccountId": {
"nodeId": "4",
"allocationId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"archive": false,
"displayOrder": 123,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"allocationByAllocationId": Allocation,
"accountByAccountId": Account
}
}
}
allocationArchiveById
Response
Returns an AllocationArchive
Arguments
| Name | Description |
|---|---|
id - UUID!
|
Example
Query
query allocationArchiveById($id: UUID!) {
allocationArchiveById(id: $id) {
nodeId
allocationId
accountId
archive
displayOrder
id
allocationByAllocationId {
...AllocationFragment
}
accountByAccountId {
...AccountFragment
}
}
}
Variables
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
Response
{
"data": {
"allocationArchiveById": {
"nodeId": "4",
"allocationId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"archive": true,
"displayOrder": 123,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"allocationByAllocationId": Allocation,
"accountByAccountId": Account
}
}
}
allocationById
Response
Returns an Allocation
Arguments
| Name | Description |
|---|---|
id - UUID!
|
Example
Query
query allocationById($id: UUID!) {
allocationById(id: $id) {
nodeId
ownerId
blockchainAddressId
issuerId
name
createdOn
opensOn
closesOn
status
roundId
id
accountByOwnerId {
...AccountFragment
}
blockchainAddressByBlockchainAddressId {
...BlockchainAddressFragment
}
accountByIssuerId {
...AccountFragment
}
assetStatusByStatus {
...AssetStatusFragment
}
roundByRoundId {
...RoundFragment
}
allocationArchivesByAllocationId {
...AllocationArchivesConnectionFragment
}
distributionsByAllocationId {
...DistributionsConnectionFragment
}
allocationAnnotationsByAllocationId {
...AllocationAnnotationsConnectionFragment
}
allocationsVestingScheduleByAllocationId {
...AllocationsVestingScheduleFragment
}
allocationsVestingSchedulesByAllocationId {
...AllocationsVestingSchedulesConnectionFragment
}
allocationQualificationsByAllocationId {
...AllocationQualificationsConnectionFragment
}
allocationOfferingLinksByAllocationId {
...AllocationOfferingLinksConnectionFragment
}
allocationEmailPreferenceByAllocationId {
...AllocationEmailPreferenceFragment
}
allocationEmailPreferencesByAllocationId {
...AllocationEmailPreferencesConnectionFragment
}
managedUnits
}
}
Variables
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
Response
{
"data": {
"allocationById": {
"nodeId": "4",
"ownerId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"blockchainAddressId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"issuerId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"name": "abc123",
"createdOn": Datetime,
"opensOn": Datetime,
"closesOn": Datetime,
"status": "abc123",
"roundId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountByOwnerId": Account,
"blockchainAddressByBlockchainAddressId": BlockchainAddress,
"accountByIssuerId": Account,
"assetStatusByStatus": AssetStatus,
"roundByRoundId": Round,
"allocationArchivesByAllocationId": AllocationArchivesConnection,
"distributionsByAllocationId": DistributionsConnection,
"allocationAnnotationsByAllocationId": AllocationAnnotationsConnection,
"allocationsVestingScheduleByAllocationId": AllocationsVestingSchedule,
"allocationsVestingSchedulesByAllocationId": AllocationsVestingSchedulesConnection,
"allocationQualificationsByAllocationId": AllocationQualificationsConnection,
"allocationOfferingLinksByAllocationId": AllocationOfferingLinksConnection,
"allocationEmailPreferenceByAllocationId": AllocationEmailPreference,
"allocationEmailPreferencesByAllocationId": AllocationEmailPreferencesConnection,
"managedUnits": BigFloat
}
}
}
allocationEmailPreference
Description
Reads a single AllocationEmailPreference using its globally unique ID.
Response
Returns an AllocationEmailPreference
Arguments
| Name | Description |
|---|---|
nodeId - ID!
|
The globally unique ID to be used in selecting a single AllocationEmailPreference. |
Example
Query
query allocationEmailPreference($nodeId: ID!) {
allocationEmailPreference(nodeId: $nodeId) {
nodeId
id
accountId
allocationId
sendDistribution
accountByAccountId {
...AccountFragment
}
allocationByAllocationId {
...AllocationFragment
}
}
}
Variables
{"nodeId": 4}
Response
{
"data": {
"allocationEmailPreference": {
"nodeId": "4",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"allocationId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"sendDistribution": true,
"accountByAccountId": Account,
"allocationByAllocationId": Allocation
}
}
}
allocationEmailPreferenceByAllocationId
Response
Returns an AllocationEmailPreference
Arguments
| Name | Description |
|---|---|
allocationId - UUID!
|
Example
Query
query allocationEmailPreferenceByAllocationId($allocationId: UUID!) {
allocationEmailPreferenceByAllocationId(allocationId: $allocationId) {
nodeId
id
accountId
allocationId
sendDistribution
accountByAccountId {
...AccountFragment
}
allocationByAllocationId {
...AllocationFragment
}
}
}
Variables
{
"allocationId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
Response
{
"data": {
"allocationEmailPreferenceByAllocationId": {
"nodeId": "4",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"allocationId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"sendDistribution": true,
"accountByAccountId": Account,
"allocationByAllocationId": Allocation
}
}
}
allocationEmailPreferenceById
Response
Returns an AllocationEmailPreference
Arguments
| Name | Description |
|---|---|
id - UUID!
|
Example
Query
query allocationEmailPreferenceById($id: UUID!) {
allocationEmailPreferenceById(id: $id) {
nodeId
id
accountId
allocationId
sendDistribution
accountByAccountId {
...AccountFragment
}
allocationByAllocationId {
...AllocationFragment
}
}
}
Variables
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
Response
{
"data": {
"allocationEmailPreferenceById": {
"nodeId": "4",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"allocationId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"sendDistribution": false,
"accountByAccountId": Account,
"allocationByAllocationId": Allocation
}
}
}
allocationOfferingLink
Description
Reads a single AllocationOfferingLink using its globally unique ID.
Response
Returns an AllocationOfferingLink
Arguments
| Name | Description |
|---|---|
nodeId - ID!
|
The globally unique ID to be used in selecting a single AllocationOfferingLink. |
Example
Query
query allocationOfferingLink($nodeId: ID!) {
allocationOfferingLink(nodeId: $nodeId) {
nodeId
id
allocationId
authorizedLink
unauthorizedLink
name
createdBy
createdOn
agentId
allocationByAllocationId {
...AllocationFragment
}
accountByCreatedBy {
...AccountFragment
}
accountByAgentId {
...AccountFragment
}
}
}
Variables
{"nodeId": 4}
Response
{
"data": {
"allocationOfferingLink": {
"nodeId": 4,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"allocationId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"authorizedLink": "xyz789",
"unauthorizedLink": "abc123",
"name": "abc123",
"createdBy": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"createdOn": Datetime,
"agentId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"allocationByAllocationId": Allocation,
"accountByCreatedBy": Account,
"accountByAgentId": Account
}
}
}
allocationOfferingLinkById
Response
Returns an AllocationOfferingLink
Arguments
| Name | Description |
|---|---|
id - UUID!
|
Example
Query
query allocationOfferingLinkById($id: UUID!) {
allocationOfferingLinkById(id: $id) {
nodeId
id
allocationId
authorizedLink
unauthorizedLink
name
createdBy
createdOn
agentId
allocationByAllocationId {
...AllocationFragment
}
accountByCreatedBy {
...AccountFragment
}
accountByAgentId {
...AccountFragment
}
}
}
Variables
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
Response
{
"data": {
"allocationOfferingLinkById": {
"nodeId": 4,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"allocationId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"authorizedLink": "abc123",
"unauthorizedLink": "abc123",
"name": "xyz789",
"createdBy": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"createdOn": Datetime,
"agentId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"allocationByAllocationId": Allocation,
"accountByCreatedBy": Account,
"accountByAgentId": Account
}
}
}
allocationQualification
Description
Reads a single AllocationQualification using its globally unique ID.
Response
Returns an AllocationQualification
Arguments
| Name | Description |
|---|---|
nodeId - ID!
|
The globally unique ID to be used in selecting a single AllocationQualification. |
Example
Query
query allocationQualification($nodeId: ID!) {
allocationQualification(nodeId: $nodeId) {
nodeId
id
allocationId
vendorQualificationId
executeOrder
allocationByAllocationId {
...AllocationFragment
}
vendorQualificationByVendorQualificationId {
...VendorQualificationFragment
}
}
}
Variables
{"nodeId": "4"}
Response
{
"data": {
"allocationQualification": {
"nodeId": 4,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"allocationId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"vendorQualificationId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"executeOrder": 987,
"allocationByAllocationId": Allocation,
"vendorQualificationByVendorQualificationId": VendorQualification
}
}
}
allocationQualificationByAllocationIdAndVendorQualificationId
Response
Returns an AllocationQualification
Example
Query
query allocationQualificationByAllocationIdAndVendorQualificationId(
$allocationId: UUID!,
$vendorQualificationId: UUID!
) {
allocationQualificationByAllocationIdAndVendorQualificationId(
allocationId: $allocationId,
vendorQualificationId: $vendorQualificationId
) {
nodeId
id
allocationId
vendorQualificationId
executeOrder
allocationByAllocationId {
...AllocationFragment
}
vendorQualificationByVendorQualificationId {
...VendorQualificationFragment
}
}
}
Variables
{
"allocationId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"vendorQualificationId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
Response
{
"data": {
"allocationQualificationByAllocationIdAndVendorQualificationId": {
"nodeId": "4",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"allocationId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"vendorQualificationId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"executeOrder": 123,
"allocationByAllocationId": Allocation,
"vendorQualificationByVendorQualificationId": VendorQualification
}
}
}
allocationQualificationById
Response
Returns an AllocationQualification
Arguments
| Name | Description |
|---|---|
id - UUID!
|
Example
Query
query allocationQualificationById($id: UUID!) {
allocationQualificationById(id: $id) {
nodeId
id
allocationId
vendorQualificationId
executeOrder
allocationByAllocationId {
...AllocationFragment
}
vendorQualificationByVendorQualificationId {
...VendorQualificationFragment
}
}
}
Variables
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
Response
{
"data": {
"allocationQualificationById": {
"nodeId": 4,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"allocationId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"vendorQualificationId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"executeOrder": 987,
"allocationByAllocationId": Allocation,
"vendorQualificationByVendorQualificationId": VendorQualification
}
}
}
allocationsVestingSchedule
Description
Reads a single AllocationsVestingSchedule using its globally unique ID.
Response
Returns an AllocationsVestingSchedule
Arguments
| Name | Description |
|---|---|
nodeId - ID!
|
The globally unique ID to be used in selecting a single AllocationsVestingSchedule. |
Example
Query
query allocationsVestingSchedule($nodeId: ID!) {
allocationsVestingSchedule(nodeId: $nodeId) {
nodeId
allocationId
duration
cliff
periods
startsOn
automatic
id
allocationByAllocationId {
...AllocationFragment
}
vestingDurationByDuration {
...VestingDurationFragment
}
}
}
Variables
{"nodeId": "4"}
Response
{
"data": {
"allocationsVestingSchedule": {
"nodeId": "4",
"allocationId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"duration": "abc123",
"cliff": 123,
"periods": 123,
"startsOn": Datetime,
"automatic": true,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"allocationByAllocationId": Allocation,
"vestingDurationByDuration": VestingDuration
}
}
}
allocationsVestingScheduleByAllocationId
Response
Returns an AllocationsVestingSchedule
Arguments
| Name | Description |
|---|---|
allocationId - UUID!
|
Example
Query
query allocationsVestingScheduleByAllocationId($allocationId: UUID!) {
allocationsVestingScheduleByAllocationId(allocationId: $allocationId) {
nodeId
allocationId
duration
cliff
periods
startsOn
automatic
id
allocationByAllocationId {
...AllocationFragment
}
vestingDurationByDuration {
...VestingDurationFragment
}
}
}
Variables
{
"allocationId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
Response
{
"data": {
"allocationsVestingScheduleByAllocationId": {
"nodeId": "4",
"allocationId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"duration": "xyz789",
"cliff": 123,
"periods": 987,
"startsOn": Datetime,
"automatic": true,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"allocationByAllocationId": Allocation,
"vestingDurationByDuration": VestingDuration
}
}
}
allocationsVestingScheduleById
Response
Returns an AllocationsVestingSchedule
Arguments
| Name | Description |
|---|---|
id - UUID!
|
Example
Query
query allocationsVestingScheduleById($id: UUID!) {
allocationsVestingScheduleById(id: $id) {
nodeId
allocationId
duration
cliff
periods
startsOn
automatic
id
allocationByAllocationId {
...AllocationFragment
}
vestingDurationByDuration {
...VestingDurationFragment
}
}
}
Variables
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
Response
{
"data": {
"allocationsVestingScheduleById": {
"nodeId": 4,
"allocationId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"duration": "abc123",
"cliff": 987,
"periods": 987,
"startsOn": Datetime,
"automatic": false,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"allocationByAllocationId": Allocation,
"vestingDurationByDuration": VestingDuration
}
}
}
asset
Description
Reads a single Asset using its globally unique ID.
Response
Returns an Asset
Arguments
| Name | Description |
|---|---|
nodeId - ID!
|
The globally unique ID to be used in selecting a single Asset. |
Example
Query
query asset($nodeId: ID!) {
asset(nodeId: $nodeId) {
nodeId
issuerId
type
name
authorizedTotal
createdOn
status
id
accountByIssuerId {
...AccountFragment
}
assetTypeByType {
...AssetTypeFragment
}
assetStatusByStatus {
...AssetStatusFragment
}
assetArchivesByAssetId {
...AssetArchivesConnectionFragment
}
roundsByAssetId {
...RoundsConnectionFragment
}
assetAnnotationsByAssetId {
...AssetAnnotationsConnectionFragment
}
issuanceEventsByAssetId {
...IssuanceEventsConnectionFragment
}
holdings
}
}
Variables
{"nodeId": 4}
Response
{
"data": {
"asset": {
"nodeId": "4",
"issuerId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"type": "abc123",
"name": "xyz789",
"authorizedTotal": BigFloat,
"createdOn": Datetime,
"status": "abc123",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountByIssuerId": Account,
"assetTypeByType": AssetType,
"assetStatusByStatus": AssetStatus,
"assetArchivesByAssetId": AssetArchivesConnection,
"roundsByAssetId": RoundsConnection,
"assetAnnotationsByAssetId": AssetAnnotationsConnection,
"issuanceEventsByAssetId": IssuanceEventsConnection,
"holdings": BigFloat
}
}
}
assetAnnotation
Description
Reads a single AssetAnnotation using its globally unique ID.
Response
Returns an AssetAnnotation
Arguments
| Name | Description |
|---|---|
nodeId - ID!
|
The globally unique ID to be used in selecting a single AssetAnnotation. |
Example
Query
query assetAnnotation($nodeId: ID!) {
assetAnnotation(nodeId: $nodeId) {
nodeId
assetId
writtenBy
accountId
annotation
archive
createdOn
id
assetByAssetId {
...AssetFragment
}
userByWrittenBy {
...UserFragment
}
accountByAccountId {
...AccountFragment
}
}
}
Variables
{"nodeId": 4}
Response
{
"data": {
"assetAnnotation": {
"nodeId": 4,
"assetId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"writtenBy": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"annotation": "abc123",
"archive": true,
"createdOn": Datetime,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"assetByAssetId": Asset,
"userByWrittenBy": User,
"accountByAccountId": Account
}
}
}
assetAnnotationById
Response
Returns an AssetAnnotation
Arguments
| Name | Description |
|---|---|
id - UUID!
|
Example
Query
query assetAnnotationById($id: UUID!) {
assetAnnotationById(id: $id) {
nodeId
assetId
writtenBy
accountId
annotation
archive
createdOn
id
assetByAssetId {
...AssetFragment
}
userByWrittenBy {
...UserFragment
}
accountByAccountId {
...AccountFragment
}
}
}
Variables
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
Response
{
"data": {
"assetAnnotationById": {
"nodeId": 4,
"assetId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"writtenBy": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"annotation": "xyz789",
"archive": false,
"createdOn": Datetime,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"assetByAssetId": Asset,
"userByWrittenBy": User,
"accountByAccountId": Account
}
}
}
assetArchive
Description
Reads a single AssetArchive using its globally unique ID.
Response
Returns an AssetArchive
Arguments
| Name | Description |
|---|---|
nodeId - ID!
|
The globally unique ID to be used in selecting a single AssetArchive. |
Example
Query
query assetArchive($nodeId: ID!) {
assetArchive(nodeId: $nodeId) {
nodeId
assetId
accountId
archive
displayOrder
id
assetByAssetId {
...AssetFragment
}
accountByAccountId {
...AccountFragment
}
}
}
Variables
{"nodeId": 4}
Response
{
"data": {
"assetArchive": {
"nodeId": 4,
"assetId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"archive": true,
"displayOrder": 987,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"assetByAssetId": Asset,
"accountByAccountId": Account
}
}
}
assetArchiveByAssetIdAndAccountId
Response
Returns an AssetArchive
Example
Query
query assetArchiveByAssetIdAndAccountId(
$assetId: UUID!,
$accountId: UUID!
) {
assetArchiveByAssetIdAndAccountId(
assetId: $assetId,
accountId: $accountId
) {
nodeId
assetId
accountId
archive
displayOrder
id
assetByAssetId {
...AssetFragment
}
accountByAccountId {
...AccountFragment
}
}
}
Variables
{
"assetId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
Response
{
"data": {
"assetArchiveByAssetIdAndAccountId": {
"nodeId": "4",
"assetId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"archive": true,
"displayOrder": 987,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"assetByAssetId": Asset,
"accountByAccountId": Account
}
}
}
assetArchiveById
Response
Returns an AssetArchive
Arguments
| Name | Description |
|---|---|
id - UUID!
|
Example
Query
query assetArchiveById($id: UUID!) {
assetArchiveById(id: $id) {
nodeId
assetId
accountId
archive
displayOrder
id
assetByAssetId {
...AssetFragment
}
accountByAccountId {
...AccountFragment
}
}
}
Variables
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
Response
{
"data": {
"assetArchiveById": {
"nodeId": "4",
"assetId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"archive": true,
"displayOrder": 987,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"assetByAssetId": Asset,
"accountByAccountId": Account
}
}
}
assetById
Example
Query
query assetById($id: UUID!) {
assetById(id: $id) {
nodeId
issuerId
type
name
authorizedTotal
createdOn
status
id
accountByIssuerId {
...AccountFragment
}
assetTypeByType {
...AssetTypeFragment
}
assetStatusByStatus {
...AssetStatusFragment
}
assetArchivesByAssetId {
...AssetArchivesConnectionFragment
}
roundsByAssetId {
...RoundsConnectionFragment
}
assetAnnotationsByAssetId {
...AssetAnnotationsConnectionFragment
}
issuanceEventsByAssetId {
...IssuanceEventsConnectionFragment
}
holdings
}
}
Variables
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
Response
{
"data": {
"assetById": {
"nodeId": "4",
"issuerId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"type": "abc123",
"name": "abc123",
"authorizedTotal": BigFloat,
"createdOn": Datetime,
"status": "abc123",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountByIssuerId": Account,
"assetTypeByType": AssetType,
"assetStatusByStatus": AssetStatus,
"assetArchivesByAssetId": AssetArchivesConnection,
"roundsByAssetId": RoundsConnection,
"assetAnnotationsByAssetId": AssetAnnotationsConnection,
"issuanceEventsByAssetId": IssuanceEventsConnection,
"holdings": BigFloat
}
}
}
assetStatus
Description
Reads a single AssetStatus using its globally unique ID.
Response
Returns an AssetStatus
Arguments
| Name | Description |
|---|---|
nodeId - ID!
|
The globally unique ID to be used in selecting a single AssetStatus. |
Example
Query
query assetStatus($nodeId: ID!) {
assetStatus(nodeId: $nodeId) {
nodeId
status
assetsByStatus {
...AssetsConnectionFragment
}
roundsByStatus {
...RoundsConnectionFragment
}
allocationsByStatus {
...AllocationsConnectionFragment
}
}
}
Variables
{"nodeId": "4"}
Response
{
"data": {
"assetStatus": {
"nodeId": 4,
"status": "abc123",
"assetsByStatus": AssetsConnection,
"roundsByStatus": RoundsConnection,
"allocationsByStatus": AllocationsConnection
}
}
}
assetStatusByStatus
Response
Returns an AssetStatus
Arguments
| Name | Description |
|---|---|
status - String!
|
Example
Query
query assetStatusByStatus($status: String!) {
assetStatusByStatus(status: $status) {
nodeId
status
assetsByStatus {
...AssetsConnectionFragment
}
roundsByStatus {
...RoundsConnectionFragment
}
allocationsByStatus {
...AllocationsConnectionFragment
}
}
}
Variables
{"status": "xyz789"}
Response
{
"data": {
"assetStatusByStatus": {
"nodeId": 4,
"status": "xyz789",
"assetsByStatus": AssetsConnection,
"roundsByStatus": RoundsConnection,
"allocationsByStatus": AllocationsConnection
}
}
}
assetType
Description
Reads a single AssetType using its globally unique ID.
Response
Returns an AssetType
Arguments
| Name | Description |
|---|---|
nodeId - ID!
|
The globally unique ID to be used in selecting a single AssetType. |
Example
Query
query assetType($nodeId: ID!) {
assetType(nodeId: $nodeId) {
nodeId
type
accountingType
accountingTypeByAccountingType {
...AccountingTypeFragment
}
assetsByType {
...AssetsConnectionFragment
}
}
}
Variables
{"nodeId": 4}
Response
{
"data": {
"assetType": {
"nodeId": "4",
"type": "xyz789",
"accountingType": "abc123",
"accountingTypeByAccountingType": AccountingType,
"assetsByType": AssetsConnection
}
}
}
assetTypeByType
Example
Query
query assetTypeByType($type: String!) {
assetTypeByType(type: $type) {
nodeId
type
accountingType
accountingTypeByAccountingType {
...AccountingTypeFragment
}
assetsByType {
...AssetsConnectionFragment
}
}
}
Variables
{"type": "abc123"}
Response
{
"data": {
"assetTypeByType": {
"nodeId": 4,
"type": "xyz789",
"accountingType": "xyz789",
"accountingTypeByAccountingType": AccountingType,
"assetsByType": AssetsConnection
}
}
}
auxAccount
Description
Reads a single AuxAccount using its globally unique ID.
Response
Returns an AuxAccount
Arguments
| Name | Description |
|---|---|
nodeId - ID!
|
The globally unique ID to be used in selecting a single AuxAccount. |
Example
Query
query auxAccount($nodeId: ID!) {
auxAccount(nodeId: $nodeId) {
nodeId
type
accountsByType {
...AccountsConnectionFragment
}
documentSharingAllowedSharesByFromAccountType {
...DocumentSharingAllowedSharesConnectionFragment
}
}
}
Variables
{"nodeId": 4}
Response
{
"data": {
"auxAccount": {
"nodeId": 4,
"type": "abc123",
"accountsByType": AccountsConnection,
"documentSharingAllowedSharesByFromAccountType": DocumentSharingAllowedSharesConnection
}
}
}
auxAccountByType
Response
Returns an AuxAccount
Arguments
| Name | Description |
|---|---|
type - String!
|
Example
Query
query auxAccountByType($type: String!) {
auxAccountByType(type: $type) {
nodeId
type
accountsByType {
...AccountsConnectionFragment
}
documentSharingAllowedSharesByFromAccountType {
...DocumentSharingAllowedSharesConnectionFragment
}
}
}
Variables
{"type": "xyz789"}
Response
{
"data": {
"auxAccountByType": {
"nodeId": "4",
"type": "abc123",
"accountsByType": AccountsConnection,
"documentSharingAllowedSharesByFromAccountType": DocumentSharingAllowedSharesConnection
}
}
}
auxRole
Description
Reads a single AuxRole using its globally unique ID.
Response
Returns an AuxRole
Arguments
| Name | Description |
|---|---|
nodeId - ID!
|
The globally unique ID to be used in selecting a single AuxRole. |
Example
Query
query auxRole($nodeId: ID!) {
auxRole(nodeId: $nodeId) {
nodeId
role
usersAccountsByRole {
...UsersAccountsConnectionFragment
}
}
}
Variables
{"nodeId": "4"}
Response
{
"data": {
"auxRole": {
"nodeId": "4",
"role": "abc123",
"usersAccountsByRole": UsersAccountsConnection
}
}
}
auxRoleByRole
Example
Query
query auxRoleByRole($role: String!) {
auxRoleByRole(role: $role) {
nodeId
role
usersAccountsByRole {
...UsersAccountsConnectionFragment
}
}
}
Variables
{"role": "abc123"}
Response
{
"data": {
"auxRoleByRole": {
"nodeId": 4,
"role": "abc123",
"usersAccountsByRole": UsersAccountsConnection
}
}
}
blockchainAddress
Description
Reads a single BlockchainAddress using its globally unique ID.
Response
Returns a BlockchainAddress
Arguments
| Name | Description |
|---|---|
nodeId - ID!
|
The globally unique ID to be used in selecting a single BlockchainAddress. |
Example
Query
query blockchainAddress($nodeId: ID!) {
blockchainAddress(nodeId: $nodeId) {
nodeId
chain
address
createdOn
id
chainByChain {
...ChainFragment
}
capTablesByBlockchainAddressId {
...CapTablesConnectionFragment
}
accountsBlockchainAddressesByBlockchainAddressId {
...AccountsBlockchainAddressesConnectionFragment
}
blockchainRegistrationsByBlockchainAddressId {
...BlockchainRegistrationsConnectionFragment
}
roundByBlockchainAddressId {
...RoundFragment
}
roundsByBlockchainAddressId {
...RoundsConnectionFragment
}
allocationsByBlockchainAddressId {
...AllocationsConnectionFragment
}
walletAssignmentsByBlockchainAddressId {
...WalletAssignmentsConnectionFragment
}
ledgersByBlockchainAddressId {
...LedgersConnectionFragment
}
securityByBlockchainAddressId {
...SecurityFragment
}
securitiesByBlockchainAddressId {
...SecuritiesConnectionFragment
}
holdingBlockchainAddressByBlockchainAddressId {
...HoldingBlockchainAddressFragment
}
holdingBlockchainAddressesByBlockchainAddressId {
...HoldingBlockchainAddressesConnectionFragment
}
blockchainAddressSourcesByBlockchainAddressId {
...BlockchainAddressSourcesConnectionFragment
}
taRequestsByFromBlockchainAddressId {
...TaRequestsConnectionFragment
}
taRequestsByToBlockchainAddressId {
...TaRequestsConnectionFragment
}
}
}
Variables
{"nodeId": 4}
Response
{
"data": {
"blockchainAddress": {
"nodeId": 4,
"chain": "abc123",
"address": "abc123",
"createdOn": Datetime,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"chainByChain": Chain,
"capTablesByBlockchainAddressId": CapTablesConnection,
"accountsBlockchainAddressesByBlockchainAddressId": AccountsBlockchainAddressesConnection,
"blockchainRegistrationsByBlockchainAddressId": BlockchainRegistrationsConnection,
"roundByBlockchainAddressId": Round,
"roundsByBlockchainAddressId": RoundsConnection,
"allocationsByBlockchainAddressId": AllocationsConnection,
"walletAssignmentsByBlockchainAddressId": WalletAssignmentsConnection,
"ledgersByBlockchainAddressId": LedgersConnection,
"securityByBlockchainAddressId": Security,
"securitiesByBlockchainAddressId": SecuritiesConnection,
"holdingBlockchainAddressByBlockchainAddressId": HoldingBlockchainAddress,
"holdingBlockchainAddressesByBlockchainAddressId": HoldingBlockchainAddressesConnection,
"blockchainAddressSourcesByBlockchainAddressId": BlockchainAddressSourcesConnection,
"taRequestsByFromBlockchainAddressId": TaRequestsConnection,
"taRequestsByToBlockchainAddressId": TaRequestsConnection
}
}
}
blockchainAddressByChainAndAddress
Response
Returns a BlockchainAddress
Example
Query
query blockchainAddressByChainAndAddress(
$chain: String!,
$address: String!
) {
blockchainAddressByChainAndAddress(
chain: $chain,
address: $address
) {
nodeId
chain
address
createdOn
id
chainByChain {
...ChainFragment
}
capTablesByBlockchainAddressId {
...CapTablesConnectionFragment
}
accountsBlockchainAddressesByBlockchainAddressId {
...AccountsBlockchainAddressesConnectionFragment
}
blockchainRegistrationsByBlockchainAddressId {
...BlockchainRegistrationsConnectionFragment
}
roundByBlockchainAddressId {
...RoundFragment
}
roundsByBlockchainAddressId {
...RoundsConnectionFragment
}
allocationsByBlockchainAddressId {
...AllocationsConnectionFragment
}
walletAssignmentsByBlockchainAddressId {
...WalletAssignmentsConnectionFragment
}
ledgersByBlockchainAddressId {
...LedgersConnectionFragment
}
securityByBlockchainAddressId {
...SecurityFragment
}
securitiesByBlockchainAddressId {
...SecuritiesConnectionFragment
}
holdingBlockchainAddressByBlockchainAddressId {
...HoldingBlockchainAddressFragment
}
holdingBlockchainAddressesByBlockchainAddressId {
...HoldingBlockchainAddressesConnectionFragment
}
blockchainAddressSourcesByBlockchainAddressId {
...BlockchainAddressSourcesConnectionFragment
}
taRequestsByFromBlockchainAddressId {
...TaRequestsConnectionFragment
}
taRequestsByToBlockchainAddressId {
...TaRequestsConnectionFragment
}
}
}
Variables
{
"chain": "abc123",
"address": "xyz789"
}
Response
{
"data": {
"blockchainAddressByChainAndAddress": {
"nodeId": "4",
"chain": "xyz789",
"address": "xyz789",
"createdOn": Datetime,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"chainByChain": Chain,
"capTablesByBlockchainAddressId": CapTablesConnection,
"accountsBlockchainAddressesByBlockchainAddressId": AccountsBlockchainAddressesConnection,
"blockchainRegistrationsByBlockchainAddressId": BlockchainRegistrationsConnection,
"roundByBlockchainAddressId": Round,
"roundsByBlockchainAddressId": RoundsConnection,
"allocationsByBlockchainAddressId": AllocationsConnection,
"walletAssignmentsByBlockchainAddressId": WalletAssignmentsConnection,
"ledgersByBlockchainAddressId": LedgersConnection,
"securityByBlockchainAddressId": Security,
"securitiesByBlockchainAddressId": SecuritiesConnection,
"holdingBlockchainAddressByBlockchainAddressId": HoldingBlockchainAddress,
"holdingBlockchainAddressesByBlockchainAddressId": HoldingBlockchainAddressesConnection,
"blockchainAddressSourcesByBlockchainAddressId": BlockchainAddressSourcesConnection,
"taRequestsByFromBlockchainAddressId": TaRequestsConnection,
"taRequestsByToBlockchainAddressId": TaRequestsConnection
}
}
}
blockchainAddressById
Response
Returns a BlockchainAddress
Arguments
| Name | Description |
|---|---|
id - UUID!
|
Example
Query
query blockchainAddressById($id: UUID!) {
blockchainAddressById(id: $id) {
nodeId
chain
address
createdOn
id
chainByChain {
...ChainFragment
}
capTablesByBlockchainAddressId {
...CapTablesConnectionFragment
}
accountsBlockchainAddressesByBlockchainAddressId {
...AccountsBlockchainAddressesConnectionFragment
}
blockchainRegistrationsByBlockchainAddressId {
...BlockchainRegistrationsConnectionFragment
}
roundByBlockchainAddressId {
...RoundFragment
}
roundsByBlockchainAddressId {
...RoundsConnectionFragment
}
allocationsByBlockchainAddressId {
...AllocationsConnectionFragment
}
walletAssignmentsByBlockchainAddressId {
...WalletAssignmentsConnectionFragment
}
ledgersByBlockchainAddressId {
...LedgersConnectionFragment
}
securityByBlockchainAddressId {
...SecurityFragment
}
securitiesByBlockchainAddressId {
...SecuritiesConnectionFragment
}
holdingBlockchainAddressByBlockchainAddressId {
...HoldingBlockchainAddressFragment
}
holdingBlockchainAddressesByBlockchainAddressId {
...HoldingBlockchainAddressesConnectionFragment
}
blockchainAddressSourcesByBlockchainAddressId {
...BlockchainAddressSourcesConnectionFragment
}
taRequestsByFromBlockchainAddressId {
...TaRequestsConnectionFragment
}
taRequestsByToBlockchainAddressId {
...TaRequestsConnectionFragment
}
}
}
Variables
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
Response
{
"data": {
"blockchainAddressById": {
"nodeId": 4,
"chain": "abc123",
"address": "abc123",
"createdOn": Datetime,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"chainByChain": Chain,
"capTablesByBlockchainAddressId": CapTablesConnection,
"accountsBlockchainAddressesByBlockchainAddressId": AccountsBlockchainAddressesConnection,
"blockchainRegistrationsByBlockchainAddressId": BlockchainRegistrationsConnection,
"roundByBlockchainAddressId": Round,
"roundsByBlockchainAddressId": RoundsConnection,
"allocationsByBlockchainAddressId": AllocationsConnection,
"walletAssignmentsByBlockchainAddressId": WalletAssignmentsConnection,
"ledgersByBlockchainAddressId": LedgersConnection,
"securityByBlockchainAddressId": Security,
"securitiesByBlockchainAddressId": SecuritiesConnection,
"holdingBlockchainAddressByBlockchainAddressId": HoldingBlockchainAddress,
"holdingBlockchainAddressesByBlockchainAddressId": HoldingBlockchainAddressesConnection,
"blockchainAddressSourcesByBlockchainAddressId": BlockchainAddressSourcesConnection,
"taRequestsByFromBlockchainAddressId": TaRequestsConnection,
"taRequestsByToBlockchainAddressId": TaRequestsConnection
}
}
}
blockchainAddressGroup
Description
Reads a single BlockchainAddressGroup using its globally unique ID.
Response
Returns a BlockchainAddressGroup
Arguments
| Name | Description |
|---|---|
nodeId - ID!
|
The globally unique ID to be used in selecting a single BlockchainAddressGroup. |
Example
Query
query blockchainAddressGroup($nodeId: ID!) {
blockchainAddressGroup(nodeId: $nodeId) {
nodeId
id
accountsBlockchainAddressesByBlockchainAddressGroupId {
...AccountsBlockchainAddressesConnectionFragment
}
}
}
Variables
{"nodeId": "4"}
Response
{
"data": {
"blockchainAddressGroup": {
"nodeId": "4",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountsBlockchainAddressesByBlockchainAddressGroupId": AccountsBlockchainAddressesConnection
}
}
}
blockchainAddressGroupById
Response
Returns a BlockchainAddressGroup
Arguments
| Name | Description |
|---|---|
id - UUID!
|
Example
Query
query blockchainAddressGroupById($id: UUID!) {
blockchainAddressGroupById(id: $id) {
nodeId
id
accountsBlockchainAddressesByBlockchainAddressGroupId {
...AccountsBlockchainAddressesConnectionFragment
}
}
}
Variables
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
Response
{
"data": {
"blockchainAddressGroupById": {
"nodeId": 4,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountsBlockchainAddressesByBlockchainAddressGroupId": AccountsBlockchainAddressesConnection
}
}
}
blockchainAddressSource
Description
Reads a single BlockchainAddressSource using its globally unique ID.
Response
Returns a BlockchainAddressSource
Arguments
| Name | Description |
|---|---|
nodeId - ID!
|
The globally unique ID to be used in selecting a single BlockchainAddressSource. |
Example
Query
query blockchainAddressSource($nodeId: ID!) {
blockchainAddressSource(nodeId: $nodeId) {
nodeId
id
blockchainAddressId
vendorId
investorId
creatorAccountId
creatorUserId
createdOn
blockchainAddressByBlockchainAddressId {
...BlockchainAddressFragment
}
accountByVendorId {
...AccountFragment
}
accountByInvestorId {
...AccountFragment
}
accountByCreatorAccountId {
...AccountFragment
}
userByCreatorUserId {
...UserFragment
}
}
}
Variables
{"nodeId": "4"}
Response
{
"data": {
"blockchainAddressSource": {
"nodeId": 4,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"blockchainAddressId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"vendorId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"investorId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"creatorAccountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"creatorUserId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"createdOn": Datetime,
"blockchainAddressByBlockchainAddressId": BlockchainAddress,
"accountByVendorId": Account,
"accountByInvestorId": Account,
"accountByCreatorAccountId": Account,
"userByCreatorUserId": User
}
}
}
blockchainAddressSourceById
Response
Returns a BlockchainAddressSource
Arguments
| Name | Description |
|---|---|
id - UUID!
|
Example
Query
query blockchainAddressSourceById($id: UUID!) {
blockchainAddressSourceById(id: $id) {
nodeId
id
blockchainAddressId
vendorId
investorId
creatorAccountId
creatorUserId
createdOn
blockchainAddressByBlockchainAddressId {
...BlockchainAddressFragment
}
accountByVendorId {
...AccountFragment
}
accountByInvestorId {
...AccountFragment
}
accountByCreatorAccountId {
...AccountFragment
}
userByCreatorUserId {
...UserFragment
}
}
}
Variables
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
Response
{
"data": {
"blockchainAddressSourceById": {
"nodeId": 4,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"blockchainAddressId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"vendorId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"investorId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"creatorAccountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"creatorUserId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"createdOn": Datetime,
"blockchainAddressByBlockchainAddressId": BlockchainAddress,
"accountByVendorId": Account,
"accountByInvestorId": Account,
"accountByCreatorAccountId": Account,
"userByCreatorUserId": User
}
}
}
blockchainAddressSourceByVendorIdAndBlockchainAddressId
Response
Returns a BlockchainAddressSource
Example
Query
query blockchainAddressSourceByVendorIdAndBlockchainAddressId(
$vendorId: UUID!,
$blockchainAddressId: UUID!
) {
blockchainAddressSourceByVendorIdAndBlockchainAddressId(
vendorId: $vendorId,
blockchainAddressId: $blockchainAddressId
) {
nodeId
id
blockchainAddressId
vendorId
investorId
creatorAccountId
creatorUserId
createdOn
blockchainAddressByBlockchainAddressId {
...BlockchainAddressFragment
}
accountByVendorId {
...AccountFragment
}
accountByInvestorId {
...AccountFragment
}
accountByCreatorAccountId {
...AccountFragment
}
userByCreatorUserId {
...UserFragment
}
}
}
Variables
{
"vendorId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"blockchainAddressId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
Response
{
"data": {
"blockchainAddressSourceByVendorIdAndBlockchainAddressId": {
"nodeId": 4,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"blockchainAddressId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"vendorId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"investorId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"creatorAccountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"creatorUserId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"createdOn": Datetime,
"blockchainAddressByBlockchainAddressId": BlockchainAddress,
"accountByVendorId": Account,
"accountByInvestorId": Account,
"accountByCreatorAccountId": Account,
"userByCreatorUserId": User
}
}
}
blockchainRegistration
Description
Reads a single BlockchainRegistration using its globally unique ID.
Response
Returns a BlockchainRegistration
Arguments
| Name | Description |
|---|---|
nodeId - ID!
|
The globally unique ID to be used in selecting a single BlockchainRegistration. |
Example
Query
query blockchainRegistration($nodeId: ID!) {
blockchainRegistration(nodeId: $nodeId) {
nodeId
blockchainAddressId
accountId
usersAccountId
status
chain
method
rawAddress
toAddress
amount
createdOn
startedOn
completedOn
nonce
chainData
id
blockchainAddressByBlockchainAddressId {
...BlockchainAddressFragment
}
accountByAccountId {
...AccountFragment
}
usersAccountByUsersAccountId {
...UsersAccountFragment
}
registrationStatusByStatus {
...RegistrationStatusFragment
}
chainByChain {
...ChainFragment
}
registrationMethodByMethod {
...RegistrationMethodFragment
}
}
}
Variables
{"nodeId": 4}
Response
{
"data": {
"blockchainRegistration": {
"nodeId": "4",
"blockchainAddressId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"usersAccountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"status": "xyz789",
"chain": "xyz789",
"method": "abc123",
"rawAddress": "xyz789",
"toAddress": "abc123",
"amount": BigFloat,
"createdOn": Datetime,
"startedOn": Datetime,
"completedOn": Datetime,
"nonce": "abc123",
"chainData": {},
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"blockchainAddressByBlockchainAddressId": BlockchainAddress,
"accountByAccountId": Account,
"usersAccountByUsersAccountId": UsersAccount,
"registrationStatusByStatus": RegistrationStatus,
"chainByChain": Chain,
"registrationMethodByMethod": RegistrationMethod
}
}
}
blockchainRegistrationById
Response
Returns a BlockchainRegistration
Arguments
| Name | Description |
|---|---|
id - UUID!
|
Example
Query
query blockchainRegistrationById($id: UUID!) {
blockchainRegistrationById(id: $id) {
nodeId
blockchainAddressId
accountId
usersAccountId
status
chain
method
rawAddress
toAddress
amount
createdOn
startedOn
completedOn
nonce
chainData
id
blockchainAddressByBlockchainAddressId {
...BlockchainAddressFragment
}
accountByAccountId {
...AccountFragment
}
usersAccountByUsersAccountId {
...UsersAccountFragment
}
registrationStatusByStatus {
...RegistrationStatusFragment
}
chainByChain {
...ChainFragment
}
registrationMethodByMethod {
...RegistrationMethodFragment
}
}
}
Variables
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
Response
{
"data": {
"blockchainRegistrationById": {
"nodeId": "4",
"blockchainAddressId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"usersAccountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"status": "xyz789",
"chain": "xyz789",
"method": "abc123",
"rawAddress": "xyz789",
"toAddress": "abc123",
"amount": BigFloat,
"createdOn": Datetime,
"startedOn": Datetime,
"completedOn": Datetime,
"nonce": "xyz789",
"chainData": {},
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"blockchainAddressByBlockchainAddressId": BlockchainAddress,
"accountByAccountId": Account,
"usersAccountByUsersAccountId": UsersAccount,
"registrationStatusByStatus": RegistrationStatus,
"chainByChain": Chain,
"registrationMethodByMethod": RegistrationMethod
}
}
}
blockchainRegistrationByNonce
Response
Returns a BlockchainRegistration
Arguments
| Name | Description |
|---|---|
nonce - String!
|
Example
Query
query blockchainRegistrationByNonce($nonce: String!) {
blockchainRegistrationByNonce(nonce: $nonce) {
nodeId
blockchainAddressId
accountId
usersAccountId
status
chain
method
rawAddress
toAddress
amount
createdOn
startedOn
completedOn
nonce
chainData
id
blockchainAddressByBlockchainAddressId {
...BlockchainAddressFragment
}
accountByAccountId {
...AccountFragment
}
usersAccountByUsersAccountId {
...UsersAccountFragment
}
registrationStatusByStatus {
...RegistrationStatusFragment
}
chainByChain {
...ChainFragment
}
registrationMethodByMethod {
...RegistrationMethodFragment
}
}
}
Variables
{"nonce": "xyz789"}
Response
{
"data": {
"blockchainRegistrationByNonce": {
"nodeId": "4",
"blockchainAddressId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"usersAccountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"status": "xyz789",
"chain": "xyz789",
"method": "abc123",
"rawAddress": "xyz789",
"toAddress": "xyz789",
"amount": BigFloat,
"createdOn": Datetime,
"startedOn": Datetime,
"completedOn": Datetime,
"nonce": "abc123",
"chainData": {},
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"blockchainAddressByBlockchainAddressId": BlockchainAddress,
"accountByAccountId": Account,
"usersAccountByUsersAccountId": UsersAccount,
"registrationStatusByStatus": RegistrationStatus,
"chainByChain": Chain,
"registrationMethodByMethod": RegistrationMethod
}
}
}
brokerAllocation
Description
Reads a single BrokerAllocation using its globally unique ID.
Response
Returns a BrokerAllocation
Arguments
| Name | Description |
|---|---|
nodeId - ID!
|
The globally unique ID to be used in selecting a single BrokerAllocation. |
Example
Query
query brokerAllocation($nodeId: ID!) {
brokerAllocation(nodeId: $nodeId) {
nodeId
brokerId
status
name
roundId
id
accountByBrokerId {
...AccountFragment
}
invitationStatusByStatus {
...InvitationStatusFragment
}
roundByRoundId {
...RoundFragment
}
managedUnits
}
}
Variables
{"nodeId": "4"}
Response
{
"data": {
"brokerAllocation": {
"nodeId": 4,
"brokerId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"status": "xyz789",
"name": "xyz789",
"roundId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountByBrokerId": Account,
"invitationStatusByStatus": InvitationStatus,
"roundByRoundId": Round,
"managedUnits": BigFloat
}
}
}
brokerAllocationById
Response
Returns a BrokerAllocation
Arguments
| Name | Description |
|---|---|
id - UUID!
|
Example
Query
query brokerAllocationById($id: UUID!) {
brokerAllocationById(id: $id) {
nodeId
brokerId
status
name
roundId
id
accountByBrokerId {
...AccountFragment
}
invitationStatusByStatus {
...InvitationStatusFragment
}
roundByRoundId {
...RoundFragment
}
managedUnits
}
}
Variables
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
Response
{
"data": {
"brokerAllocationById": {
"nodeId": "4",
"brokerId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"status": "abc123",
"name": "abc123",
"roundId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountByBrokerId": Account,
"invitationStatusByStatus": InvitationStatus,
"roundByRoundId": Round,
"managedUnits": BigFloat
}
}
}
brokerTypeahead
Description
Reads and enables pagination through a set of Account.
Response
Returns an AccountsConnection
Arguments
| Name | Description |
|---|---|
accountName - String
|
|
first - Int
|
Only read the first n values of the set. |
last - Int
|
Only read the last n values of the set. |
offset - Int
|
Skip the first n values from our after cursor, an alternative to cursor based pagination. May not be used with last. |
before - Cursor
|
Read all values in the set before (above) this cursor. |
after - Cursor
|
Read all values in the set after (below) this cursor. |
filter - AccountFilter
|
A filter to be used in determining which values should be returned by the collection. |
Example
Query
query brokerTypeahead(
$accountName: String,
$first: Int,
$last: Int,
$offset: Int,
$before: Cursor,
$after: Cursor,
$filter: AccountFilter
) {
brokerTypeahead(
accountName: $accountName,
first: $first,
last: $last,
offset: $offset,
before: $before,
after: $after,
filter: $filter
) {
nodes {
...AccountFragment
}
edges {
...AccountsEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"accountName": "xyz789",
"first": 123,
"last": 987,
"offset": 123,
"before": Cursor,
"after": Cursor,
"filter": AccountFilter
}
Response
{
"data": {
"brokerTypeahead": {
"nodes": [Account],
"edges": [AccountsEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
}
}
capTable
Description
Reads a single CapTable using its globally unique ID.
Response
Returns a CapTable
Arguments
| Name | Description |
|---|---|
nodeId - ID!
|
The globally unique ID to be used in selecting a single CapTable. |
Example
Query
query capTable($nodeId: ID!) {
capTable(nodeId: $nodeId) {
nodeId
blockchainAddressId
tokenId
amount
id
blockchainAddressByBlockchainAddressId {
...BlockchainAddressFragment
}
tokenByTokenId {
...TokenFragment
}
}
}
Variables
{"nodeId": "4"}
Response
{
"data": {
"capTable": {
"nodeId": "4",
"blockchainAddressId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"tokenId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"amount": BigFloat,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"blockchainAddressByBlockchainAddressId": BlockchainAddress,
"tokenByTokenId": Token
}
}
}
capTableByBlockchainAddressIdAndTokenId
Example
Query
query capTableByBlockchainAddressIdAndTokenId(
$blockchainAddressId: UUID!,
$tokenId: UUID!
) {
capTableByBlockchainAddressIdAndTokenId(
blockchainAddressId: $blockchainAddressId,
tokenId: $tokenId
) {
nodeId
blockchainAddressId
tokenId
amount
id
blockchainAddressByBlockchainAddressId {
...BlockchainAddressFragment
}
tokenByTokenId {
...TokenFragment
}
}
}
Variables
{
"blockchainAddressId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"tokenId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
Response
{
"data": {
"capTableByBlockchainAddressIdAndTokenId": {
"nodeId": 4,
"blockchainAddressId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"tokenId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"amount": BigFloat,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"blockchainAddressByBlockchainAddressId": BlockchainAddress,
"tokenByTokenId": Token
}
}
}
capTableById
Example
Query
query capTableById($id: UUID!) {
capTableById(id: $id) {
nodeId
blockchainAddressId
tokenId
amount
id
blockchainAddressByBlockchainAddressId {
...BlockchainAddressFragment
}
tokenByTokenId {
...TokenFragment
}
}
}
Variables
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
Response
{
"data": {
"capTableById": {
"nodeId": "4",
"blockchainAddressId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"tokenId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"amount": BigFloat,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"blockchainAddressByBlockchainAddressId": BlockchainAddress,
"tokenByTokenId": Token
}
}
}
capitalDeployment
Description
Reads a single CapitalDeployment using its globally unique ID.
Response
Returns a CapitalDeployment
Arguments
| Name | Description |
|---|---|
nodeId - ID!
|
The globally unique ID to be used in selecting a single CapitalDeployment. |
Example
Query
query capitalDeployment($nodeId: ID!) {
capitalDeployment(nodeId: $nodeId) {
nodeId
id
note
amount
paidOn
currency
createdOn
transactionGroupId
roundId
currencyByCurrency {
...CurrencyFragment
}
roundByRoundId {
...RoundFragment
}
}
}
Variables
{"nodeId": 4}
Response
{
"data": {
"capitalDeployment": {
"nodeId": "4",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"note": "abc123",
"amount": BigFloat,
"paidOn": Datetime,
"currency": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"createdOn": Datetime,
"transactionGroupId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"roundId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"currencyByCurrency": Currency,
"roundByRoundId": Round
}
}
}
capitalDeploymentById
Response
Returns a CapitalDeployment
Arguments
| Name | Description |
|---|---|
id - UUID!
|
Example
Query
query capitalDeploymentById($id: UUID!) {
capitalDeploymentById(id: $id) {
nodeId
id
note
amount
paidOn
currency
createdOn
transactionGroupId
roundId
currencyByCurrency {
...CurrencyFragment
}
roundByRoundId {
...RoundFragment
}
}
}
Variables
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
Response
{
"data": {
"capitalDeploymentById": {
"nodeId": 4,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"note": "abc123",
"amount": BigFloat,
"paidOn": Datetime,
"currency": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"createdOn": Datetime,
"transactionGroupId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"roundId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"currencyByCurrency": Currency,
"roundByRoundId": Round
}
}
}
capitalDeploymentByTransactionGroupId
Response
Returns a CapitalDeployment
Arguments
| Name | Description |
|---|---|
transactionGroupId - UUID!
|
Example
Query
query capitalDeploymentByTransactionGroupId($transactionGroupId: UUID!) {
capitalDeploymentByTransactionGroupId(transactionGroupId: $transactionGroupId) {
nodeId
id
note
amount
paidOn
currency
createdOn
transactionGroupId
roundId
currencyByCurrency {
...CurrencyFragment
}
roundByRoundId {
...RoundFragment
}
}
}
Variables
{
"transactionGroupId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
Response
{
"data": {
"capitalDeploymentByTransactionGroupId": {
"nodeId": "4",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"note": "abc123",
"amount": BigFloat,
"paidOn": Datetime,
"currency": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"createdOn": Datetime,
"transactionGroupId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"roundId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"currencyByCurrency": Currency,
"roundByRoundId": Round
}
}
}
chain
Description
Reads a single Chain using its globally unique ID.
Response
Returns a Chain
Arguments
| Name | Description |
|---|---|
nodeId - ID!
|
The globally unique ID to be used in selecting a single Chain. |
Example
Query
query chain($nodeId: ID!) {
chain(nodeId: $nodeId) {
nodeId
chain
integrationsByChain {
...IntegrationsConnectionFragment
}
blockchainAddressesByChain {
...BlockchainAddressesConnectionFragment
}
blockchainRegistrationsByChain {
...BlockchainRegistrationsConnectionFragment
}
contractsByChain {
...ContractsConnectionFragment
}
}
}
Variables
{"nodeId": 4}
Response
{
"data": {
"chain": {
"nodeId": 4,
"chain": "abc123",
"integrationsByChain": IntegrationsConnection,
"blockchainAddressesByChain": BlockchainAddressesConnection,
"blockchainRegistrationsByChain": BlockchainRegistrationsConnection,
"contractsByChain": ContractsConnection
}
}
}
chainByChain
Example
Query
query chainByChain($chain: String!) {
chainByChain(chain: $chain) {
nodeId
chain
integrationsByChain {
...IntegrationsConnectionFragment
}
blockchainAddressesByChain {
...BlockchainAddressesConnectionFragment
}
blockchainRegistrationsByChain {
...BlockchainRegistrationsConnectionFragment
}
contractsByChain {
...ContractsConnectionFragment
}
}
}
Variables
{"chain": "xyz789"}
Response
{
"data": {
"chainByChain": {
"nodeId": "4",
"chain": "xyz789",
"integrationsByChain": IntegrationsConnection,
"blockchainAddressesByChain": BlockchainAddressesConnection,
"blockchainRegistrationsByChain": BlockchainRegistrationsConnection,
"contractsByChain": ContractsConnection
}
}
}
company
Description
Reads a single Company using its globally unique ID.
Response
Returns a Company
Arguments
| Name | Description |
|---|---|
nodeId - ID!
|
The globally unique ID to be used in selecting a single Company. |
Example
Query
query company($nodeId: ID!) {
company(nodeId: $nodeId) {
nodeId
id
accountsByCompany {
...AccountsConnectionFragment
}
}
}
Variables
{"nodeId": 4}
Response
{
"data": {
"company": {
"nodeId": 4,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountsByCompany": AccountsConnection
}
}
}
companyById
Example
Query
query companyById($id: UUID!) {
companyById(id: $id) {
nodeId
id
accountsByCompany {
...AccountsConnectionFragment
}
}
}
Variables
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
Response
{
"data": {
"companyById": {
"nodeId": "4",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountsByCompany": AccountsConnection
}
}
}
contract
Description
Reads a single Contract using its globally unique ID.
Response
Returns a Contract
Arguments
| Name | Description |
|---|---|
nodeId - ID!
|
The globally unique ID to be used in selecting a single Contract. |
Example
Query
query contract($nodeId: ID!) {
contract(nodeId: $nodeId) {
nodeId
tokenId
chain
status
contractAddress
custodianId
issuancePlatformId
id
tokenByTokenId {
...TokenFragment
}
chainByChain {
...ChainFragment
}
contractStatusByStatus {
...ContractStatusFragment
}
integrationByCustodianId {
...IntegrationFragment
}
integrationByIssuancePlatformId {
...IntegrationFragment
}
}
}
Variables
{"nodeId": "4"}
Response
{
"data": {
"contract": {
"nodeId": 4,
"tokenId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"chain": "xyz789",
"status": "abc123",
"contractAddress": "abc123",
"custodianId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"issuancePlatformId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"tokenByTokenId": Token,
"chainByChain": Chain,
"contractStatusByStatus": ContractStatus,
"integrationByCustodianId": Integration,
"integrationByIssuancePlatformId": Integration
}
}
}
contractByContractAddressAndChain
Example
Query
query contractByContractAddressAndChain(
$contractAddress: String!,
$chain: String!
) {
contractByContractAddressAndChain(
contractAddress: $contractAddress,
chain: $chain
) {
nodeId
tokenId
chain
status
contractAddress
custodianId
issuancePlatformId
id
tokenByTokenId {
...TokenFragment
}
chainByChain {
...ChainFragment
}
contractStatusByStatus {
...ContractStatusFragment
}
integrationByCustodianId {
...IntegrationFragment
}
integrationByIssuancePlatformId {
...IntegrationFragment
}
}
}
Variables
{
"contractAddress": "xyz789",
"chain": "abc123"
}
Response
{
"data": {
"contractByContractAddressAndChain": {
"nodeId": 4,
"tokenId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"chain": "xyz789",
"status": "abc123",
"contractAddress": "xyz789",
"custodianId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"issuancePlatformId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"tokenByTokenId": Token,
"chainByChain": Chain,
"contractStatusByStatus": ContractStatus,
"integrationByCustodianId": Integration,
"integrationByIssuancePlatformId": Integration
}
}
}
contractById
Example
Query
query contractById($id: UUID!) {
contractById(id: $id) {
nodeId
tokenId
chain
status
contractAddress
custodianId
issuancePlatformId
id
tokenByTokenId {
...TokenFragment
}
chainByChain {
...ChainFragment
}
contractStatusByStatus {
...ContractStatusFragment
}
integrationByCustodianId {
...IntegrationFragment
}
integrationByIssuancePlatformId {
...IntegrationFragment
}
}
}
Variables
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
Response
{
"data": {
"contractById": {
"nodeId": "4",
"tokenId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"chain": "abc123",
"status": "abc123",
"contractAddress": "xyz789",
"custodianId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"issuancePlatformId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"tokenByTokenId": Token,
"chainByChain": Chain,
"contractStatusByStatus": ContractStatus,
"integrationByCustodianId": Integration,
"integrationByIssuancePlatformId": Integration
}
}
}
contractStatus
Description
Reads a single ContractStatus using its globally unique ID.
Response
Returns a ContractStatus
Arguments
| Name | Description |
|---|---|
nodeId - ID!
|
The globally unique ID to be used in selecting a single ContractStatus. |
Example
Query
query contractStatus($nodeId: ID!) {
contractStatus(nodeId: $nodeId) {
nodeId
status
contractsByStatus {
...ContractsConnectionFragment
}
}
}
Variables
{"nodeId": "4"}
Response
{
"data": {
"contractStatus": {
"nodeId": 4,
"status": "xyz789",
"contractsByStatus": ContractsConnection
}
}
}
contractStatusByStatus
Response
Returns a ContractStatus
Arguments
| Name | Description |
|---|---|
status - String!
|
Example
Query
query contractStatusByStatus($status: String!) {
contractStatusByStatus(status: $status) {
nodeId
status
contractsByStatus {
...ContractsConnectionFragment
}
}
}
Variables
{"status": "xyz789"}
Response
{
"data": {
"contractStatusByStatus": {
"nodeId": 4,
"status": "abc123",
"contractsByStatus": ContractsConnection
}
}
}
country
Description
Reads a single Country using its globally unique ID.
Response
Returns a Country
Arguments
| Name | Description |
|---|---|
nodeId - ID!
|
The globally unique ID to be used in selecting a single Country. |
Example
Query
query country($nodeId: ID!) {
country(nodeId: $nodeId) {
nodeId
name
alpha2
alpha3
num
id
accountsByJurisdiction {
...AccountsConnectionFragment
}
addressesByCountry {
...AddressesConnectionFragment
}
customersByJurisdiction {
...CustomersConnectionFragment
}
taxRegionsByCountryId {
...TaxRegionsConnectionFragment
}
countryProvincesByCountryId {
...CountryProvincesConnectionFragment
}
}
}
Variables
{"nodeId": "4"}
Response
{
"data": {
"country": {
"nodeId": 4,
"name": "abc123",
"alpha2": "xyz789",
"alpha3": "abc123",
"num": "xyz789",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountsByJurisdiction": AccountsConnection,
"addressesByCountry": AddressesConnection,
"customersByJurisdiction": CustomersConnection,
"taxRegionsByCountryId": TaxRegionsConnection,
"countryProvincesByCountryId": CountryProvincesConnection
}
}
}
countryById
Example
Query
query countryById($id: UUID!) {
countryById(id: $id) {
nodeId
name
alpha2
alpha3
num
id
accountsByJurisdiction {
...AccountsConnectionFragment
}
addressesByCountry {
...AddressesConnectionFragment
}
customersByJurisdiction {
...CustomersConnectionFragment
}
taxRegionsByCountryId {
...TaxRegionsConnectionFragment
}
countryProvincesByCountryId {
...CountryProvincesConnectionFragment
}
}
}
Variables
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
Response
{
"data": {
"countryById": {
"nodeId": "4",
"name": "xyz789",
"alpha2": "abc123",
"alpha3": "abc123",
"num": "abc123",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountsByJurisdiction": AccountsConnection,
"addressesByCountry": AddressesConnection,
"customersByJurisdiction": CustomersConnection,
"taxRegionsByCountryId": TaxRegionsConnection,
"countryProvincesByCountryId": CountryProvincesConnection
}
}
}
countryProvince
Description
Reads a single CountryProvince using its globally unique ID.
Response
Returns a CountryProvince
Arguments
| Name | Description |
|---|---|
nodeId - ID!
|
The globally unique ID to be used in selecting a single CountryProvince. |
Example
Query
query countryProvince($nodeId: ID!) {
countryProvince(nodeId: $nodeId) {
nodeId
id
countryId
name
code
countryByCountryId {
...CountryFragment
}
}
}
Variables
{"nodeId": 4}
Response
{
"data": {
"countryProvince": {
"nodeId": "4",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"countryId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"name": "abc123",
"code": "abc123",
"countryByCountryId": Country
}
}
}
countryProvinceByCountryIdAndName
Response
Returns a CountryProvince
Example
Query
query countryProvinceByCountryIdAndName(
$countryId: UUID!,
$name: String!
) {
countryProvinceByCountryIdAndName(
countryId: $countryId,
name: $name
) {
nodeId
id
countryId
name
code
countryByCountryId {
...CountryFragment
}
}
}
Variables
{
"countryId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"name": "xyz789"
}
Response
{
"data": {
"countryProvinceByCountryIdAndName": {
"nodeId": 4,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"countryId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"name": "abc123",
"code": "xyz789",
"countryByCountryId": Country
}
}
}
countryProvinceById
Response
Returns a CountryProvince
Arguments
| Name | Description |
|---|---|
id - UUID!
|
Example
Query
query countryProvinceById($id: UUID!) {
countryProvinceById(id: $id) {
nodeId
id
countryId
name
code
countryByCountryId {
...CountryFragment
}
}
}
Variables
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
Response
{
"data": {
"countryProvinceById": {
"nodeId": "4",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"countryId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"name": "abc123",
"code": "xyz789",
"countryByCountryId": Country
}
}
}
currency
Description
Reads a single Currency using its globally unique ID.
Response
Returns a Currency
Arguments
| Name | Description |
|---|---|
nodeId - ID!
|
The globally unique ID to be used in selecting a single Currency. |
Example
Query
query currency($nodeId: ID!) {
currency(nodeId: $nodeId) {
nodeId
type
name
code
num
precision
tokenId
id
currencyTypeByType {
...CurrencyTypeFragment
}
tokenByTokenId {
...TokenFragment
}
distributionPricesByCurrency {
...DistributionPricesConnectionFragment
}
distributionPaymentsByCurrency {
...DistributionPaymentsConnectionFragment
}
capitalDeploymentsByCurrency {
...CapitalDeploymentsConnectionFragment
}
holdingsByPurchaseCurrency {
...HoldingsConnectionFragment
}
}
}
Variables
{"nodeId": 4}
Response
{
"data": {
"currency": {
"nodeId": 4,
"type": "abc123",
"name": "abc123",
"code": "abc123",
"num": "xyz789",
"precision": 123,
"tokenId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"currencyTypeByType": CurrencyType,
"tokenByTokenId": Token,
"distributionPricesByCurrency": DistributionPricesConnection,
"distributionPaymentsByCurrency": DistributionPaymentsConnection,
"capitalDeploymentsByCurrency": CapitalDeploymentsConnection,
"holdingsByPurchaseCurrency": HoldingsConnection
}
}
}
currencyById
Example
Query
query currencyById($id: UUID!) {
currencyById(id: $id) {
nodeId
type
name
code
num
precision
tokenId
id
currencyTypeByType {
...CurrencyTypeFragment
}
tokenByTokenId {
...TokenFragment
}
distributionPricesByCurrency {
...DistributionPricesConnectionFragment
}
distributionPaymentsByCurrency {
...DistributionPaymentsConnectionFragment
}
capitalDeploymentsByCurrency {
...CapitalDeploymentsConnectionFragment
}
holdingsByPurchaseCurrency {
...HoldingsConnectionFragment
}
}
}
Variables
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
Response
{
"data": {
"currencyById": {
"nodeId": 4,
"type": "abc123",
"name": "abc123",
"code": "abc123",
"num": "abc123",
"precision": 123,
"tokenId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"currencyTypeByType": CurrencyType,
"tokenByTokenId": Token,
"distributionPricesByCurrency": DistributionPricesConnection,
"distributionPaymentsByCurrency": DistributionPaymentsConnection,
"capitalDeploymentsByCurrency": CapitalDeploymentsConnection,
"holdingsByPurchaseCurrency": HoldingsConnection
}
}
}
currencyType
Description
Reads a single CurrencyType using its globally unique ID.
Response
Returns a CurrencyType
Arguments
| Name | Description |
|---|---|
nodeId - ID!
|
The globally unique ID to be used in selecting a single CurrencyType. |
Example
Query
query currencyType($nodeId: ID!) {
currencyType(nodeId: $nodeId) {
nodeId
type
currenciesByType {
...CurrenciesConnectionFragment
}
}
}
Variables
{"nodeId": 4}
Response
{
"data": {
"currencyType": {
"nodeId": 4,
"type": "abc123",
"currenciesByType": CurrenciesConnection
}
}
}
currencyTypeByType
Response
Returns a CurrencyType
Arguments
| Name | Description |
|---|---|
type - String!
|
Example
Query
query currencyTypeByType($type: String!) {
currencyTypeByType(type: $type) {
nodeId
type
currenciesByType {
...CurrenciesConnectionFragment
}
}
}
Variables
{"type": "xyz789"}
Response
{
"data": {
"currencyTypeByType": {
"nodeId": "4",
"type": "xyz789",
"currenciesByType": CurrenciesConnection
}
}
}
customer
Description
Reads a single Customer using its globally unique ID.
Response
Returns a Customer
Arguments
| Name | Description |
|---|---|
nodeId - ID!
|
The globally unique ID to be used in selecting a single Customer. |
Example
Query
query customer($nodeId: ID!) {
customer(nodeId: $nodeId) {
nodeId
vendorId
investorId
status
name
id
setup
formationDate
investorType
jurisdiction
accountByVendorId {
...AccountFragment
}
accountByInvestorId {
...AccountFragment
}
invitationStatusByStatus {
...InvitationStatusFragment
}
investorAccountTypeByInvestorType {
...InvestorAccountTypeFragment
}
countryByJurisdiction {
...CountryFragment
}
customerPartiesByCustomerId {
...CustomerPartiesConnectionFragment
}
customerAddressesByCustomerId {
...CustomerAddressesConnectionFragment
}
}
}
Variables
{"nodeId": "4"}
Response
{
"data": {
"customer": {
"nodeId": 4,
"vendorId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"investorId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"status": "abc123",
"name": "xyz789",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"setup": false,
"formationDate": "2007-12-03",
"investorType": "abc123",
"jurisdiction": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountByVendorId": Account,
"accountByInvestorId": Account,
"invitationStatusByStatus": InvitationStatus,
"investorAccountTypeByInvestorType": InvestorAccountType,
"countryByJurisdiction": Country,
"customerPartiesByCustomerId": CustomerPartiesConnection,
"customerAddressesByCustomerId": CustomerAddressesConnection
}
}
}
customerAddress
Description
Reads a single CustomerAddress using its globally unique ID.
Response
Returns a CustomerAddress
Arguments
| Name | Description |
|---|---|
nodeId - ID!
|
The globally unique ID to be used in selecting a single CustomerAddress. |
Example
Query
query customerAddress($nodeId: ID!) {
customerAddress(nodeId: $nodeId) {
nodeId
id
addressId
customerId
type
createdOn
creatorUserId
creatorAccountId
addressByAddressId {
...AddressFragment
}
customerByCustomerId {
...CustomerFragment
}
addressTypeByType {
...AddressTypeFragment
}
userByCreatorUserId {
...UserFragment
}
accountByCreatorAccountId {
...AccountFragment
}
}
}
Variables
{"nodeId": "4"}
Response
{
"data": {
"customerAddress": {
"nodeId": 4,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"addressId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"customerId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"type": "abc123",
"createdOn": Datetime,
"creatorUserId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"creatorAccountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"addressByAddressId": Address,
"customerByCustomerId": Customer,
"addressTypeByType": AddressType,
"userByCreatorUserId": User,
"accountByCreatorAccountId": Account
}
}
}
customerAddressByAddressId
Response
Returns a CustomerAddress
Arguments
| Name | Description |
|---|---|
addressId - UUID!
|
Example
Query
query customerAddressByAddressId($addressId: UUID!) {
customerAddressByAddressId(addressId: $addressId) {
nodeId
id
addressId
customerId
type
createdOn
creatorUserId
creatorAccountId
addressByAddressId {
...AddressFragment
}
customerByCustomerId {
...CustomerFragment
}
addressTypeByType {
...AddressTypeFragment
}
userByCreatorUserId {
...UserFragment
}
accountByCreatorAccountId {
...AccountFragment
}
}
}
Variables
{
"addressId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
Response
{
"data": {
"customerAddressByAddressId": {
"nodeId": "4",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"addressId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"customerId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"type": "abc123",
"createdOn": Datetime,
"creatorUserId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"creatorAccountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"addressByAddressId": Address,
"customerByCustomerId": Customer,
"addressTypeByType": AddressType,
"userByCreatorUserId": User,
"accountByCreatorAccountId": Account
}
}
}
customerAddressByCustomerIdAndType
Response
Returns a CustomerAddress
Example
Query
query customerAddressByCustomerIdAndType(
$customerId: UUID!,
$type: String!
) {
customerAddressByCustomerIdAndType(
customerId: $customerId,
type: $type
) {
nodeId
id
addressId
customerId
type
createdOn
creatorUserId
creatorAccountId
addressByAddressId {
...AddressFragment
}
customerByCustomerId {
...CustomerFragment
}
addressTypeByType {
...AddressTypeFragment
}
userByCreatorUserId {
...UserFragment
}
accountByCreatorAccountId {
...AccountFragment
}
}
}
Variables
{
"customerId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"type": "xyz789"
}
Response
{
"data": {
"customerAddressByCustomerIdAndType": {
"nodeId": 4,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"addressId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"customerId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"type": "abc123",
"createdOn": Datetime,
"creatorUserId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"creatorAccountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"addressByAddressId": Address,
"customerByCustomerId": Customer,
"addressTypeByType": AddressType,
"userByCreatorUserId": User,
"accountByCreatorAccountId": Account
}
}
}
customerAddressById
Response
Returns a CustomerAddress
Arguments
| Name | Description |
|---|---|
id - UUID!
|
Example
Query
query customerAddressById($id: UUID!) {
customerAddressById(id: $id) {
nodeId
id
addressId
customerId
type
createdOn
creatorUserId
creatorAccountId
addressByAddressId {
...AddressFragment
}
customerByCustomerId {
...CustomerFragment
}
addressTypeByType {
...AddressTypeFragment
}
userByCreatorUserId {
...UserFragment
}
accountByCreatorAccountId {
...AccountFragment
}
}
}
Variables
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
Response
{
"data": {
"customerAddressById": {
"nodeId": 4,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"addressId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"customerId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"type": "abc123",
"createdOn": Datetime,
"creatorUserId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"creatorAccountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"addressByAddressId": Address,
"customerByCustomerId": Customer,
"addressTypeByType": AddressType,
"userByCreatorUserId": User,
"accountByCreatorAccountId": Account
}
}
}
customerById
Example
Query
query customerById($id: UUID!) {
customerById(id: $id) {
nodeId
vendorId
investorId
status
name
id
setup
formationDate
investorType
jurisdiction
accountByVendorId {
...AccountFragment
}
accountByInvestorId {
...AccountFragment
}
invitationStatusByStatus {
...InvitationStatusFragment
}
investorAccountTypeByInvestorType {
...InvestorAccountTypeFragment
}
countryByJurisdiction {
...CountryFragment
}
customerPartiesByCustomerId {
...CustomerPartiesConnectionFragment
}
customerAddressesByCustomerId {
...CustomerAddressesConnectionFragment
}
}
}
Variables
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
Response
{
"data": {
"customerById": {
"nodeId": "4",
"vendorId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"investorId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"status": "abc123",
"name": "xyz789",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"setup": false,
"formationDate": "2007-12-03",
"investorType": "abc123",
"jurisdiction": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountByVendorId": Account,
"accountByInvestorId": Account,
"invitationStatusByStatus": InvitationStatus,
"investorAccountTypeByInvestorType": InvestorAccountType,
"countryByJurisdiction": Country,
"customerPartiesByCustomerId": CustomerPartiesConnection,
"customerAddressesByCustomerId": CustomerAddressesConnection
}
}
}
customerByVendorIdAndInvestorId
Example
Query
query customerByVendorIdAndInvestorId(
$vendorId: UUID!,
$investorId: UUID!
) {
customerByVendorIdAndInvestorId(
vendorId: $vendorId,
investorId: $investorId
) {
nodeId
vendorId
investorId
status
name
id
setup
formationDate
investorType
jurisdiction
accountByVendorId {
...AccountFragment
}
accountByInvestorId {
...AccountFragment
}
invitationStatusByStatus {
...InvitationStatusFragment
}
investorAccountTypeByInvestorType {
...InvestorAccountTypeFragment
}
countryByJurisdiction {
...CountryFragment
}
customerPartiesByCustomerId {
...CustomerPartiesConnectionFragment
}
customerAddressesByCustomerId {
...CustomerAddressesConnectionFragment
}
}
}
Variables
{
"vendorId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"investorId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
Response
{
"data": {
"customerByVendorIdAndInvestorId": {
"nodeId": "4",
"vendorId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"investorId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"status": "abc123",
"name": "xyz789",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"setup": false,
"formationDate": "2007-12-03",
"investorType": "xyz789",
"jurisdiction": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountByVendorId": Account,
"accountByInvestorId": Account,
"invitationStatusByStatus": InvitationStatus,
"investorAccountTypeByInvestorType": InvestorAccountType,
"countryByJurisdiction": Country,
"customerPartiesByCustomerId": CustomerPartiesConnection,
"customerAddressesByCustomerId": CustomerAddressesConnection
}
}
}
customerParty
Description
Reads a single CustomerParty using its globally unique ID.
Response
Returns a CustomerParty
Arguments
| Name | Description |
|---|---|
nodeId - ID!
|
The globally unique ID to be used in selecting a single CustomerParty. |
Example
Query
query customerParty($nodeId: ID!) {
customerParty(nodeId: $nodeId) {
nodeId
id
customerId
userId
role
dateOfBirth
usCitizen
isPrimary
createdOn
creatorUserId
creatorAccountId
customerByCustomerId {
...CustomerFragment
}
userByUserId {
...UserFragment
}
partyRoleByRole {
...PartyRoleFragment
}
userByCreatorUserId {
...UserFragment
}
accountByCreatorAccountId {
...AccountFragment
}
customerPartyAddressesByCustomerPartyId {
...CustomerPartyAddressesConnectionFragment
}
}
}
Variables
{"nodeId": 4}
Response
{
"data": {
"customerParty": {
"nodeId": "4",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"customerId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"userId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"role": "xyz789",
"dateOfBirth": "2007-12-03",
"usCitizen": true,
"isPrimary": false,
"createdOn": Datetime,
"creatorUserId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"creatorAccountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"customerByCustomerId": Customer,
"userByUserId": User,
"partyRoleByRole": PartyRole,
"userByCreatorUserId": User,
"accountByCreatorAccountId": Account,
"customerPartyAddressesByCustomerPartyId": CustomerPartyAddressesConnection
}
}
}
customerPartyAddress
Description
Reads a single CustomerPartyAddress using its globally unique ID.
Response
Returns a CustomerPartyAddress
Arguments
| Name | Description |
|---|---|
nodeId - ID!
|
The globally unique ID to be used in selecting a single CustomerPartyAddress. |
Example
Query
query customerPartyAddress($nodeId: ID!) {
customerPartyAddress(nodeId: $nodeId) {
nodeId
id
addressId
customerPartyId
type
createdOn
creatorUserId
creatorAccountId
addressByAddressId {
...AddressFragment
}
customerPartyByCustomerPartyId {
...CustomerPartyFragment
}
addressTypeByType {
...AddressTypeFragment
}
userByCreatorUserId {
...UserFragment
}
accountByCreatorAccountId {
...AccountFragment
}
}
}
Variables
{"nodeId": "4"}
Response
{
"data": {
"customerPartyAddress": {
"nodeId": "4",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"addressId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"customerPartyId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"type": "abc123",
"createdOn": Datetime,
"creatorUserId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"creatorAccountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"addressByAddressId": Address,
"customerPartyByCustomerPartyId": CustomerParty,
"addressTypeByType": AddressType,
"userByCreatorUserId": User,
"accountByCreatorAccountId": Account
}
}
}
customerPartyAddressByAddressId
Response
Returns a CustomerPartyAddress
Arguments
| Name | Description |
|---|---|
addressId - UUID!
|
Example
Query
query customerPartyAddressByAddressId($addressId: UUID!) {
customerPartyAddressByAddressId(addressId: $addressId) {
nodeId
id
addressId
customerPartyId
type
createdOn
creatorUserId
creatorAccountId
addressByAddressId {
...AddressFragment
}
customerPartyByCustomerPartyId {
...CustomerPartyFragment
}
addressTypeByType {
...AddressTypeFragment
}
userByCreatorUserId {
...UserFragment
}
accountByCreatorAccountId {
...AccountFragment
}
}
}
Variables
{
"addressId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
Response
{
"data": {
"customerPartyAddressByAddressId": {
"nodeId": 4,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"addressId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"customerPartyId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"type": "abc123",
"createdOn": Datetime,
"creatorUserId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"creatorAccountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"addressByAddressId": Address,
"customerPartyByCustomerPartyId": CustomerParty,
"addressTypeByType": AddressType,
"userByCreatorUserId": User,
"accountByCreatorAccountId": Account
}
}
}
customerPartyAddressByCustomerPartyIdAndType
Response
Returns a CustomerPartyAddress
Example
Query
query customerPartyAddressByCustomerPartyIdAndType(
$customerPartyId: UUID!,
$type: String!
) {
customerPartyAddressByCustomerPartyIdAndType(
customerPartyId: $customerPartyId,
type: $type
) {
nodeId
id
addressId
customerPartyId
type
createdOn
creatorUserId
creatorAccountId
addressByAddressId {
...AddressFragment
}
customerPartyByCustomerPartyId {
...CustomerPartyFragment
}
addressTypeByType {
...AddressTypeFragment
}
userByCreatorUserId {
...UserFragment
}
accountByCreatorAccountId {
...AccountFragment
}
}
}
Variables
{
"customerPartyId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"type": "xyz789"
}
Response
{
"data": {
"customerPartyAddressByCustomerPartyIdAndType": {
"nodeId": 4,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"addressId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"customerPartyId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"type": "abc123",
"createdOn": Datetime,
"creatorUserId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"creatorAccountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"addressByAddressId": Address,
"customerPartyByCustomerPartyId": CustomerParty,
"addressTypeByType": AddressType,
"userByCreatorUserId": User,
"accountByCreatorAccountId": Account
}
}
}
customerPartyAddressById
Response
Returns a CustomerPartyAddress
Arguments
| Name | Description |
|---|---|
id - UUID!
|
Example
Query
query customerPartyAddressById($id: UUID!) {
customerPartyAddressById(id: $id) {
nodeId
id
addressId
customerPartyId
type
createdOn
creatorUserId
creatorAccountId
addressByAddressId {
...AddressFragment
}
customerPartyByCustomerPartyId {
...CustomerPartyFragment
}
addressTypeByType {
...AddressTypeFragment
}
userByCreatorUserId {
...UserFragment
}
accountByCreatorAccountId {
...AccountFragment
}
}
}
Variables
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
Response
{
"data": {
"customerPartyAddressById": {
"nodeId": 4,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"addressId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"customerPartyId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"type": "xyz789",
"createdOn": Datetime,
"creatorUserId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"creatorAccountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"addressByAddressId": Address,
"customerPartyByCustomerPartyId": CustomerParty,
"addressTypeByType": AddressType,
"userByCreatorUserId": User,
"accountByCreatorAccountId": Account
}
}
}
customerPartyById
Response
Returns a CustomerParty
Arguments
| Name | Description |
|---|---|
id - UUID!
|
Example
Query
query customerPartyById($id: UUID!) {
customerPartyById(id: $id) {
nodeId
id
customerId
userId
role
dateOfBirth
usCitizen
isPrimary
createdOn
creatorUserId
creatorAccountId
customerByCustomerId {
...CustomerFragment
}
userByUserId {
...UserFragment
}
partyRoleByRole {
...PartyRoleFragment
}
userByCreatorUserId {
...UserFragment
}
accountByCreatorAccountId {
...AccountFragment
}
customerPartyAddressesByCustomerPartyId {
...CustomerPartyAddressesConnectionFragment
}
}
}
Variables
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
Response
{
"data": {
"customerPartyById": {
"nodeId": "4",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"customerId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"userId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"role": "xyz789",
"dateOfBirth": "2007-12-03",
"usCitizen": true,
"isPrimary": true,
"createdOn": Datetime,
"creatorUserId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"creatorAccountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"customerByCustomerId": Customer,
"userByUserId": User,
"partyRoleByRole": PartyRole,
"userByCreatorUserId": User,
"accountByCreatorAccountId": Account,
"customerPartyAddressesByCustomerPartyId": CustomerPartyAddressesConnection
}
}
}
defaultMappingField
Description
Reads a single DefaultMappingField using its globally unique ID.
Response
Returns a DefaultMappingField
Arguments
| Name | Description |
|---|---|
nodeId - ID!
|
The globally unique ID to be used in selecting a single DefaultMappingField. |
Example
Query
query defaultMappingField($nodeId: ID!) {
defaultMappingField(nodeId: $nodeId) {
nodeId
id
field
description
}
}
Variables
{"nodeId": 4}
Response
{
"data": {
"defaultMappingField": {
"nodeId": "4",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"field": "xyz789",
"description": "xyz789"
}
}
}
defaultMappingFieldByField
Response
Returns a DefaultMappingField
Arguments
| Name | Description |
|---|---|
field - String!
|
Example
Query
query defaultMappingFieldByField($field: String!) {
defaultMappingFieldByField(field: $field) {
nodeId
id
field
description
}
}
Variables
{"field": "xyz789"}
Response
{
"data": {
"defaultMappingFieldByField": {
"nodeId": 4,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"field": "abc123",
"description": "abc123"
}
}
}
defaultMappingFieldById
Response
Returns a DefaultMappingField
Arguments
| Name | Description |
|---|---|
id - UUID!
|
Example
Query
query defaultMappingFieldById($id: UUID!) {
defaultMappingFieldById(id: $id) {
nodeId
id
field
description
}
}
Variables
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
Response
{
"data": {
"defaultMappingFieldById": {
"nodeId": 4,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"field": "xyz789",
"description": "abc123"
}
}
}
distribution
Description
Reads a single Distribution using its globally unique ID.
Response
Returns a Distribution
Arguments
| Name | Description |
|---|---|
nodeId - ID!
|
The globally unique ID to be used in selecting a single Distribution. |
Example
Query
query distribution($nodeId: ID!) {
distribution(nodeId: $nodeId) {
nodeId
allocationId
investorId
status
amount
stepId
newId
draftedBlockchainId
openBlockchainId
closedBlockchainId
lockedBlockchainId
transactionGroupId
triggerArgs
oldId
id
createdOn
locked
roundId
allocationByAllocationId {
...AllocationFragment
}
accountByInvestorId {
...AccountFragment
}
distributionStatusByStatus {
...DistributionStatusFragment
}
stepByStepId {
...StepFragment
}
distributionPricesByDistributionId {
...DistributionPricesConnectionFragment
}
vestingScheduleByDistributionId {
...VestingScheduleFragment
}
vestingSchedulesByDistributionId {
...VestingSchedulesConnectionFragment
}
distributionPaymentsByDistributionId {
...DistributionPaymentsConnectionFragment
}
walletAssignmentByDistributionId {
...WalletAssignmentFragment
}
walletAssignmentsByDistributionId {
...WalletAssignmentsConnectionFragment
}
distributionAnnotationsByDistributionId {
...DistributionAnnotationsConnectionFragment
}
distributionQualificationsByDistributionId {
...DistributionQualificationsConnectionFragment
}
distributionCustomFieldsByDistributionId {
...DistributionCustomFieldsConnectionFragment
}
issuanceEventByDistributionId {
...IssuanceEventFragment
}
issuanceEventsByDistributionId {
...IssuanceEventsConnectionFragment
}
issuanceStatus
paidInCapital
purchasePrice {
...DistributionPriceFragment
}
qualificationsComplete
}
}
Variables
{"nodeId": "4"}
Response
{
"data": {
"distribution": {
"nodeId": "4",
"allocationId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"investorId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"status": "abc123",
"amount": BigFloat,
"stepId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"newId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"draftedBlockchainId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"openBlockchainId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"closedBlockchainId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"lockedBlockchainId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"transactionGroupId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"triggerArgs": {},
"oldId": 987,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"createdOn": Datetime,
"locked": true,
"roundId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"allocationByAllocationId": Allocation,
"accountByInvestorId": Account,
"distributionStatusByStatus": DistributionStatus,
"stepByStepId": Step,
"distributionPricesByDistributionId": DistributionPricesConnection,
"vestingScheduleByDistributionId": VestingSchedule,
"vestingSchedulesByDistributionId": VestingSchedulesConnection,
"distributionPaymentsByDistributionId": DistributionPaymentsConnection,
"walletAssignmentByDistributionId": WalletAssignment,
"walletAssignmentsByDistributionId": WalletAssignmentsConnection,
"distributionAnnotationsByDistributionId": DistributionAnnotationsConnection,
"distributionQualificationsByDistributionId": DistributionQualificationsConnection,
"distributionCustomFieldsByDistributionId": DistributionCustomFieldsConnection,
"issuanceEventByDistributionId": IssuanceEvent,
"issuanceEventsByDistributionId": IssuanceEventsConnection,
"issuanceStatus": "xyz789",
"paidInCapital": BigFloat,
"purchasePrice": DistributionPrice,
"qualificationsComplete": false
}
}
}
distributionAnnotation
Description
Reads a single DistributionAnnotation using its globally unique ID.
Response
Returns a DistributionAnnotation
Arguments
| Name | Description |
|---|---|
nodeId - ID!
|
The globally unique ID to be used in selecting a single DistributionAnnotation. |
Example
Query
query distributionAnnotation($nodeId: ID!) {
distributionAnnotation(nodeId: $nodeId) {
nodeId
distributionId
writtenBy
accountId
annotation
archive
createdOn
id
distributionByDistributionId {
...DistributionFragment
}
userByWrittenBy {
...UserFragment
}
accountByAccountId {
...AccountFragment
}
}
}
Variables
{"nodeId": 4}
Response
{
"data": {
"distributionAnnotation": {
"nodeId": "4",
"distributionId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"writtenBy": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"annotation": "abc123",
"archive": true,
"createdOn": Datetime,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"distributionByDistributionId": Distribution,
"userByWrittenBy": User,
"accountByAccountId": Account
}
}
}
distributionAnnotationById
Response
Returns a DistributionAnnotation
Arguments
| Name | Description |
|---|---|
id - UUID!
|
Example
Query
query distributionAnnotationById($id: UUID!) {
distributionAnnotationById(id: $id) {
nodeId
distributionId
writtenBy
accountId
annotation
archive
createdOn
id
distributionByDistributionId {
...DistributionFragment
}
userByWrittenBy {
...UserFragment
}
accountByAccountId {
...AccountFragment
}
}
}
Variables
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
Response
{
"data": {
"distributionAnnotationById": {
"nodeId": 4,
"distributionId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"writtenBy": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"annotation": "abc123",
"archive": false,
"createdOn": Datetime,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"distributionByDistributionId": Distribution,
"userByWrittenBy": User,
"accountByAccountId": Account
}
}
}
distributionByClosedBlockchainId
Response
Returns a Distribution
Arguments
| Name | Description |
|---|---|
closedBlockchainId - UUID!
|
Example
Query
query distributionByClosedBlockchainId($closedBlockchainId: UUID!) {
distributionByClosedBlockchainId(closedBlockchainId: $closedBlockchainId) {
nodeId
allocationId
investorId
status
amount
stepId
newId
draftedBlockchainId
openBlockchainId
closedBlockchainId
lockedBlockchainId
transactionGroupId
triggerArgs
oldId
id
createdOn
locked
roundId
allocationByAllocationId {
...AllocationFragment
}
accountByInvestorId {
...AccountFragment
}
distributionStatusByStatus {
...DistributionStatusFragment
}
stepByStepId {
...StepFragment
}
distributionPricesByDistributionId {
...DistributionPricesConnectionFragment
}
vestingScheduleByDistributionId {
...VestingScheduleFragment
}
vestingSchedulesByDistributionId {
...VestingSchedulesConnectionFragment
}
distributionPaymentsByDistributionId {
...DistributionPaymentsConnectionFragment
}
walletAssignmentByDistributionId {
...WalletAssignmentFragment
}
walletAssignmentsByDistributionId {
...WalletAssignmentsConnectionFragment
}
distributionAnnotationsByDistributionId {
...DistributionAnnotationsConnectionFragment
}
distributionQualificationsByDistributionId {
...DistributionQualificationsConnectionFragment
}
distributionCustomFieldsByDistributionId {
...DistributionCustomFieldsConnectionFragment
}
issuanceEventByDistributionId {
...IssuanceEventFragment
}
issuanceEventsByDistributionId {
...IssuanceEventsConnectionFragment
}
issuanceStatus
paidInCapital
purchasePrice {
...DistributionPriceFragment
}
qualificationsComplete
}
}
Variables
{
"closedBlockchainId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
Response
{
"data": {
"distributionByClosedBlockchainId": {
"nodeId": "4",
"allocationId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"investorId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"status": "abc123",
"amount": BigFloat,
"stepId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"newId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"draftedBlockchainId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"openBlockchainId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"closedBlockchainId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"lockedBlockchainId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"transactionGroupId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"triggerArgs": {},
"oldId": 123,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"createdOn": Datetime,
"locked": false,
"roundId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"allocationByAllocationId": Allocation,
"accountByInvestorId": Account,
"distributionStatusByStatus": DistributionStatus,
"stepByStepId": Step,
"distributionPricesByDistributionId": DistributionPricesConnection,
"vestingScheduleByDistributionId": VestingSchedule,
"vestingSchedulesByDistributionId": VestingSchedulesConnection,
"distributionPaymentsByDistributionId": DistributionPaymentsConnection,
"walletAssignmentByDistributionId": WalletAssignment,
"walletAssignmentsByDistributionId": WalletAssignmentsConnection,
"distributionAnnotationsByDistributionId": DistributionAnnotationsConnection,
"distributionQualificationsByDistributionId": DistributionQualificationsConnection,
"distributionCustomFieldsByDistributionId": DistributionCustomFieldsConnection,
"issuanceEventByDistributionId": IssuanceEvent,
"issuanceEventsByDistributionId": IssuanceEventsConnection,
"issuanceStatus": "xyz789",
"paidInCapital": BigFloat,
"purchasePrice": DistributionPrice,
"qualificationsComplete": false
}
}
}
distributionByDraftedBlockchainId
Response
Returns a Distribution
Arguments
| Name | Description |
|---|---|
draftedBlockchainId - UUID!
|
Example
Query
query distributionByDraftedBlockchainId($draftedBlockchainId: UUID!) {
distributionByDraftedBlockchainId(draftedBlockchainId: $draftedBlockchainId) {
nodeId
allocationId
investorId
status
amount
stepId
newId
draftedBlockchainId
openBlockchainId
closedBlockchainId
lockedBlockchainId
transactionGroupId
triggerArgs
oldId
id
createdOn
locked
roundId
allocationByAllocationId {
...AllocationFragment
}
accountByInvestorId {
...AccountFragment
}
distributionStatusByStatus {
...DistributionStatusFragment
}
stepByStepId {
...StepFragment
}
distributionPricesByDistributionId {
...DistributionPricesConnectionFragment
}
vestingScheduleByDistributionId {
...VestingScheduleFragment
}
vestingSchedulesByDistributionId {
...VestingSchedulesConnectionFragment
}
distributionPaymentsByDistributionId {
...DistributionPaymentsConnectionFragment
}
walletAssignmentByDistributionId {
...WalletAssignmentFragment
}
walletAssignmentsByDistributionId {
...WalletAssignmentsConnectionFragment
}
distributionAnnotationsByDistributionId {
...DistributionAnnotationsConnectionFragment
}
distributionQualificationsByDistributionId {
...DistributionQualificationsConnectionFragment
}
distributionCustomFieldsByDistributionId {
...DistributionCustomFieldsConnectionFragment
}
issuanceEventByDistributionId {
...IssuanceEventFragment
}
issuanceEventsByDistributionId {
...IssuanceEventsConnectionFragment
}
issuanceStatus
paidInCapital
purchasePrice {
...DistributionPriceFragment
}
qualificationsComplete
}
}
Variables
{
"draftedBlockchainId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
Response
{
"data": {
"distributionByDraftedBlockchainId": {
"nodeId": "4",
"allocationId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"investorId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"status": "xyz789",
"amount": BigFloat,
"stepId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"newId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"draftedBlockchainId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"openBlockchainId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"closedBlockchainId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"lockedBlockchainId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"transactionGroupId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"triggerArgs": {},
"oldId": 987,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"createdOn": Datetime,
"locked": false,
"roundId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"allocationByAllocationId": Allocation,
"accountByInvestorId": Account,
"distributionStatusByStatus": DistributionStatus,
"stepByStepId": Step,
"distributionPricesByDistributionId": DistributionPricesConnection,
"vestingScheduleByDistributionId": VestingSchedule,
"vestingSchedulesByDistributionId": VestingSchedulesConnection,
"distributionPaymentsByDistributionId": DistributionPaymentsConnection,
"walletAssignmentByDistributionId": WalletAssignment,
"walletAssignmentsByDistributionId": WalletAssignmentsConnection,
"distributionAnnotationsByDistributionId": DistributionAnnotationsConnection,
"distributionQualificationsByDistributionId": DistributionQualificationsConnection,
"distributionCustomFieldsByDistributionId": DistributionCustomFieldsConnection,
"issuanceEventByDistributionId": IssuanceEvent,
"issuanceEventsByDistributionId": IssuanceEventsConnection,
"issuanceStatus": "abc123",
"paidInCapital": BigFloat,
"purchasePrice": DistributionPrice,
"qualificationsComplete": true
}
}
}
distributionById
Response
Returns a Distribution
Arguments
| Name | Description |
|---|---|
id - UUID!
|
Example
Query
query distributionById($id: UUID!) {
distributionById(id: $id) {
nodeId
allocationId
investorId
status
amount
stepId
newId
draftedBlockchainId
openBlockchainId
closedBlockchainId
lockedBlockchainId
transactionGroupId
triggerArgs
oldId
id
createdOn
locked
roundId
allocationByAllocationId {
...AllocationFragment
}
accountByInvestorId {
...AccountFragment
}
distributionStatusByStatus {
...DistributionStatusFragment
}
stepByStepId {
...StepFragment
}
distributionPricesByDistributionId {
...DistributionPricesConnectionFragment
}
vestingScheduleByDistributionId {
...VestingScheduleFragment
}
vestingSchedulesByDistributionId {
...VestingSchedulesConnectionFragment
}
distributionPaymentsByDistributionId {
...DistributionPaymentsConnectionFragment
}
walletAssignmentByDistributionId {
...WalletAssignmentFragment
}
walletAssignmentsByDistributionId {
...WalletAssignmentsConnectionFragment
}
distributionAnnotationsByDistributionId {
...DistributionAnnotationsConnectionFragment
}
distributionQualificationsByDistributionId {
...DistributionQualificationsConnectionFragment
}
distributionCustomFieldsByDistributionId {
...DistributionCustomFieldsConnectionFragment
}
issuanceEventByDistributionId {
...IssuanceEventFragment
}
issuanceEventsByDistributionId {
...IssuanceEventsConnectionFragment
}
issuanceStatus
paidInCapital
purchasePrice {
...DistributionPriceFragment
}
qualificationsComplete
}
}
Variables
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
Response
{
"data": {
"distributionById": {
"nodeId": "4",
"allocationId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"investorId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"status": "abc123",
"amount": BigFloat,
"stepId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"newId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"draftedBlockchainId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"openBlockchainId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"closedBlockchainId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"lockedBlockchainId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"transactionGroupId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"triggerArgs": {},
"oldId": 123,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"createdOn": Datetime,
"locked": true,
"roundId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"allocationByAllocationId": Allocation,
"accountByInvestorId": Account,
"distributionStatusByStatus": DistributionStatus,
"stepByStepId": Step,
"distributionPricesByDistributionId": DistributionPricesConnection,
"vestingScheduleByDistributionId": VestingSchedule,
"vestingSchedulesByDistributionId": VestingSchedulesConnection,
"distributionPaymentsByDistributionId": DistributionPaymentsConnection,
"walletAssignmentByDistributionId": WalletAssignment,
"walletAssignmentsByDistributionId": WalletAssignmentsConnection,
"distributionAnnotationsByDistributionId": DistributionAnnotationsConnection,
"distributionQualificationsByDistributionId": DistributionQualificationsConnection,
"distributionCustomFieldsByDistributionId": DistributionCustomFieldsConnection,
"issuanceEventByDistributionId": IssuanceEvent,
"issuanceEventsByDistributionId": IssuanceEventsConnection,
"issuanceStatus": "xyz789",
"paidInCapital": BigFloat,
"purchasePrice": DistributionPrice,
"qualificationsComplete": false
}
}
}
distributionByLockedBlockchainId
Response
Returns a Distribution
Arguments
| Name | Description |
|---|---|
lockedBlockchainId - UUID!
|
Example
Query
query distributionByLockedBlockchainId($lockedBlockchainId: UUID!) {
distributionByLockedBlockchainId(lockedBlockchainId: $lockedBlockchainId) {
nodeId
allocationId
investorId
status
amount
stepId
newId
draftedBlockchainId
openBlockchainId
closedBlockchainId
lockedBlockchainId
transactionGroupId
triggerArgs
oldId
id
createdOn
locked
roundId
allocationByAllocationId {
...AllocationFragment
}
accountByInvestorId {
...AccountFragment
}
distributionStatusByStatus {
...DistributionStatusFragment
}
stepByStepId {
...StepFragment
}
distributionPricesByDistributionId {
...DistributionPricesConnectionFragment
}
vestingScheduleByDistributionId {
...VestingScheduleFragment
}
vestingSchedulesByDistributionId {
...VestingSchedulesConnectionFragment
}
distributionPaymentsByDistributionId {
...DistributionPaymentsConnectionFragment
}
walletAssignmentByDistributionId {
...WalletAssignmentFragment
}
walletAssignmentsByDistributionId {
...WalletAssignmentsConnectionFragment
}
distributionAnnotationsByDistributionId {
...DistributionAnnotationsConnectionFragment
}
distributionQualificationsByDistributionId {
...DistributionQualificationsConnectionFragment
}
distributionCustomFieldsByDistributionId {
...DistributionCustomFieldsConnectionFragment
}
issuanceEventByDistributionId {
...IssuanceEventFragment
}
issuanceEventsByDistributionId {
...IssuanceEventsConnectionFragment
}
issuanceStatus
paidInCapital
purchasePrice {
...DistributionPriceFragment
}
qualificationsComplete
}
}
Variables
{
"lockedBlockchainId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
Response
{
"data": {
"distributionByLockedBlockchainId": {
"nodeId": 4,
"allocationId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"investorId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"status": "xyz789",
"amount": BigFloat,
"stepId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"newId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"draftedBlockchainId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"openBlockchainId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"closedBlockchainId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"lockedBlockchainId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"transactionGroupId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"triggerArgs": {},
"oldId": 987,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"createdOn": Datetime,
"locked": false,
"roundId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"allocationByAllocationId": Allocation,
"accountByInvestorId": Account,
"distributionStatusByStatus": DistributionStatus,
"stepByStepId": Step,
"distributionPricesByDistributionId": DistributionPricesConnection,
"vestingScheduleByDistributionId": VestingSchedule,
"vestingSchedulesByDistributionId": VestingSchedulesConnection,
"distributionPaymentsByDistributionId": DistributionPaymentsConnection,
"walletAssignmentByDistributionId": WalletAssignment,
"walletAssignmentsByDistributionId": WalletAssignmentsConnection,
"distributionAnnotationsByDistributionId": DistributionAnnotationsConnection,
"distributionQualificationsByDistributionId": DistributionQualificationsConnection,
"distributionCustomFieldsByDistributionId": DistributionCustomFieldsConnection,
"issuanceEventByDistributionId": IssuanceEvent,
"issuanceEventsByDistributionId": IssuanceEventsConnection,
"issuanceStatus": "xyz789",
"paidInCapital": BigFloat,
"purchasePrice": DistributionPrice,
"qualificationsComplete": false
}
}
}
distributionByNewId
Response
Returns a Distribution
Arguments
| Name | Description |
|---|---|
newId - UUID!
|
Example
Query
query distributionByNewId($newId: UUID!) {
distributionByNewId(newId: $newId) {
nodeId
allocationId
investorId
status
amount
stepId
newId
draftedBlockchainId
openBlockchainId
closedBlockchainId
lockedBlockchainId
transactionGroupId
triggerArgs
oldId
id
createdOn
locked
roundId
allocationByAllocationId {
...AllocationFragment
}
accountByInvestorId {
...AccountFragment
}
distributionStatusByStatus {
...DistributionStatusFragment
}
stepByStepId {
...StepFragment
}
distributionPricesByDistributionId {
...DistributionPricesConnectionFragment
}
vestingScheduleByDistributionId {
...VestingScheduleFragment
}
vestingSchedulesByDistributionId {
...VestingSchedulesConnectionFragment
}
distributionPaymentsByDistributionId {
...DistributionPaymentsConnectionFragment
}
walletAssignmentByDistributionId {
...WalletAssignmentFragment
}
walletAssignmentsByDistributionId {
...WalletAssignmentsConnectionFragment
}
distributionAnnotationsByDistributionId {
...DistributionAnnotationsConnectionFragment
}
distributionQualificationsByDistributionId {
...DistributionQualificationsConnectionFragment
}
distributionCustomFieldsByDistributionId {
...DistributionCustomFieldsConnectionFragment
}
issuanceEventByDistributionId {
...IssuanceEventFragment
}
issuanceEventsByDistributionId {
...IssuanceEventsConnectionFragment
}
issuanceStatus
paidInCapital
purchasePrice {
...DistributionPriceFragment
}
qualificationsComplete
}
}
Variables
{
"newId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
Response
{
"data": {
"distributionByNewId": {
"nodeId": "4",
"allocationId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"investorId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"status": "abc123",
"amount": BigFloat,
"stepId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"newId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"draftedBlockchainId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"openBlockchainId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"closedBlockchainId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"lockedBlockchainId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"transactionGroupId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"triggerArgs": {},
"oldId": 987,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"createdOn": Datetime,
"locked": true,
"roundId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"allocationByAllocationId": Allocation,
"accountByInvestorId": Account,
"distributionStatusByStatus": DistributionStatus,
"stepByStepId": Step,
"distributionPricesByDistributionId": DistributionPricesConnection,
"vestingScheduleByDistributionId": VestingSchedule,
"vestingSchedulesByDistributionId": VestingSchedulesConnection,
"distributionPaymentsByDistributionId": DistributionPaymentsConnection,
"walletAssignmentByDistributionId": WalletAssignment,
"walletAssignmentsByDistributionId": WalletAssignmentsConnection,
"distributionAnnotationsByDistributionId": DistributionAnnotationsConnection,
"distributionQualificationsByDistributionId": DistributionQualificationsConnection,
"distributionCustomFieldsByDistributionId": DistributionCustomFieldsConnection,
"issuanceEventByDistributionId": IssuanceEvent,
"issuanceEventsByDistributionId": IssuanceEventsConnection,
"issuanceStatus": "xyz789",
"paidInCapital": BigFloat,
"purchasePrice": DistributionPrice,
"qualificationsComplete": true
}
}
}
distributionByOpenBlockchainId
Response
Returns a Distribution
Arguments
| Name | Description |
|---|---|
openBlockchainId - UUID!
|
Example
Query
query distributionByOpenBlockchainId($openBlockchainId: UUID!) {
distributionByOpenBlockchainId(openBlockchainId: $openBlockchainId) {
nodeId
allocationId
investorId
status
amount
stepId
newId
draftedBlockchainId
openBlockchainId
closedBlockchainId
lockedBlockchainId
transactionGroupId
triggerArgs
oldId
id
createdOn
locked
roundId
allocationByAllocationId {
...AllocationFragment
}
accountByInvestorId {
...AccountFragment
}
distributionStatusByStatus {
...DistributionStatusFragment
}
stepByStepId {
...StepFragment
}
distributionPricesByDistributionId {
...DistributionPricesConnectionFragment
}
vestingScheduleByDistributionId {
...VestingScheduleFragment
}
vestingSchedulesByDistributionId {
...VestingSchedulesConnectionFragment
}
distributionPaymentsByDistributionId {
...DistributionPaymentsConnectionFragment
}
walletAssignmentByDistributionId {
...WalletAssignmentFragment
}
walletAssignmentsByDistributionId {
...WalletAssignmentsConnectionFragment
}
distributionAnnotationsByDistributionId {
...DistributionAnnotationsConnectionFragment
}
distributionQualificationsByDistributionId {
...DistributionQualificationsConnectionFragment
}
distributionCustomFieldsByDistributionId {
...DistributionCustomFieldsConnectionFragment
}
issuanceEventByDistributionId {
...IssuanceEventFragment
}
issuanceEventsByDistributionId {
...IssuanceEventsConnectionFragment
}
issuanceStatus
paidInCapital
purchasePrice {
...DistributionPriceFragment
}
qualificationsComplete
}
}
Variables
{
"openBlockchainId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
Response
{
"data": {
"distributionByOpenBlockchainId": {
"nodeId": 4,
"allocationId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"investorId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"status": "abc123",
"amount": BigFloat,
"stepId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"newId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"draftedBlockchainId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"openBlockchainId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"closedBlockchainId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"lockedBlockchainId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"transactionGroupId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"triggerArgs": {},
"oldId": 987,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"createdOn": Datetime,
"locked": false,
"roundId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"allocationByAllocationId": Allocation,
"accountByInvestorId": Account,
"distributionStatusByStatus": DistributionStatus,
"stepByStepId": Step,
"distributionPricesByDistributionId": DistributionPricesConnection,
"vestingScheduleByDistributionId": VestingSchedule,
"vestingSchedulesByDistributionId": VestingSchedulesConnection,
"distributionPaymentsByDistributionId": DistributionPaymentsConnection,
"walletAssignmentByDistributionId": WalletAssignment,
"walletAssignmentsByDistributionId": WalletAssignmentsConnection,
"distributionAnnotationsByDistributionId": DistributionAnnotationsConnection,
"distributionQualificationsByDistributionId": DistributionQualificationsConnection,
"distributionCustomFieldsByDistributionId": DistributionCustomFieldsConnection,
"issuanceEventByDistributionId": IssuanceEvent,
"issuanceEventsByDistributionId": IssuanceEventsConnection,
"issuanceStatus": "xyz789",
"paidInCapital": BigFloat,
"purchasePrice": DistributionPrice,
"qualificationsComplete": false
}
}
}
distributionByStepId
Response
Returns a Distribution
Arguments
| Name | Description |
|---|---|
stepId - UUID!
|
Example
Query
query distributionByStepId($stepId: UUID!) {
distributionByStepId(stepId: $stepId) {
nodeId
allocationId
investorId
status
amount
stepId
newId
draftedBlockchainId
openBlockchainId
closedBlockchainId
lockedBlockchainId
transactionGroupId
triggerArgs
oldId
id
createdOn
locked
roundId
allocationByAllocationId {
...AllocationFragment
}
accountByInvestorId {
...AccountFragment
}
distributionStatusByStatus {
...DistributionStatusFragment
}
stepByStepId {
...StepFragment
}
distributionPricesByDistributionId {
...DistributionPricesConnectionFragment
}
vestingScheduleByDistributionId {
...VestingScheduleFragment
}
vestingSchedulesByDistributionId {
...VestingSchedulesConnectionFragment
}
distributionPaymentsByDistributionId {
...DistributionPaymentsConnectionFragment
}
walletAssignmentByDistributionId {
...WalletAssignmentFragment
}
walletAssignmentsByDistributionId {
...WalletAssignmentsConnectionFragment
}
distributionAnnotationsByDistributionId {
...DistributionAnnotationsConnectionFragment
}
distributionQualificationsByDistributionId {
...DistributionQualificationsConnectionFragment
}
distributionCustomFieldsByDistributionId {
...DistributionCustomFieldsConnectionFragment
}
issuanceEventByDistributionId {
...IssuanceEventFragment
}
issuanceEventsByDistributionId {
...IssuanceEventsConnectionFragment
}
issuanceStatus
paidInCapital
purchasePrice {
...DistributionPriceFragment
}
qualificationsComplete
}
}
Variables
{
"stepId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
Response
{
"data": {
"distributionByStepId": {
"nodeId": "4",
"allocationId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"investorId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"status": "xyz789",
"amount": BigFloat,
"stepId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"newId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"draftedBlockchainId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"openBlockchainId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"closedBlockchainId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"lockedBlockchainId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"transactionGroupId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"triggerArgs": {},
"oldId": 987,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"createdOn": Datetime,
"locked": true,
"roundId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"allocationByAllocationId": Allocation,
"accountByInvestorId": Account,
"distributionStatusByStatus": DistributionStatus,
"stepByStepId": Step,
"distributionPricesByDistributionId": DistributionPricesConnection,
"vestingScheduleByDistributionId": VestingSchedule,
"vestingSchedulesByDistributionId": VestingSchedulesConnection,
"distributionPaymentsByDistributionId": DistributionPaymentsConnection,
"walletAssignmentByDistributionId": WalletAssignment,
"walletAssignmentsByDistributionId": WalletAssignmentsConnection,
"distributionAnnotationsByDistributionId": DistributionAnnotationsConnection,
"distributionQualificationsByDistributionId": DistributionQualificationsConnection,
"distributionCustomFieldsByDistributionId": DistributionCustomFieldsConnection,
"issuanceEventByDistributionId": IssuanceEvent,
"issuanceEventsByDistributionId": IssuanceEventsConnection,
"issuanceStatus": "xyz789",
"paidInCapital": BigFloat,
"purchasePrice": DistributionPrice,
"qualificationsComplete": true
}
}
}
distributionCustomField
Description
Reads a single DistributionCustomField using its globally unique ID.
Response
Returns a DistributionCustomField
Arguments
| Name | Description |
|---|---|
nodeId - ID!
|
The globally unique ID to be used in selecting a single DistributionCustomField. |
Example
Query
query distributionCustomField($nodeId: ID!) {
distributionCustomField(nodeId: $nodeId) {
nodeId
id
createdBy
distributionId
name
value
accountByCreatedBy {
...AccountFragment
}
distributionByDistributionId {
...DistributionFragment
}
}
}
Variables
{"nodeId": "4"}
Response
{
"data": {
"distributionCustomField": {
"nodeId": 4,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"createdBy": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"distributionId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"name": "abc123",
"value": "abc123",
"accountByCreatedBy": Account,
"distributionByDistributionId": Distribution
}
}
}
distributionCustomFieldById
Response
Returns a DistributionCustomField
Arguments
| Name | Description |
|---|---|
id - UUID!
|
Example
Query
query distributionCustomFieldById($id: UUID!) {
distributionCustomFieldById(id: $id) {
nodeId
id
createdBy
distributionId
name
value
accountByCreatedBy {
...AccountFragment
}
distributionByDistributionId {
...DistributionFragment
}
}
}
Variables
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
Response
{
"data": {
"distributionCustomFieldById": {
"nodeId": 4,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"createdBy": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"distributionId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"name": "abc123",
"value": "xyz789",
"accountByCreatedBy": Account,
"distributionByDistributionId": Distribution
}
}
}
distributionPayment
Description
Reads a single DistributionPayment using its globally unique ID.
Response
Returns a DistributionPayment
Arguments
| Name | Description |
|---|---|
nodeId - ID!
|
The globally unique ID to be used in selecting a single DistributionPayment. |
Example
Query
query distributionPayment($nodeId: ID!) {
distributionPayment(nodeId: $nodeId) {
nodeId
distributionId
currency
amount
paidOn
id
transactionGroupId
note
status
distributionByDistributionId {
...DistributionFragment
}
currencyByCurrency {
...CurrencyFragment
}
distributionPaymentStatusByStatus {
...DistributionPaymentStatusFragment
}
}
}
Variables
{"nodeId": 4}
Response
{
"data": {
"distributionPayment": {
"nodeId": 4,
"distributionId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"currency": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"amount": BigFloat,
"paidOn": Datetime,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"transactionGroupId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"note": "abc123",
"status": "abc123",
"distributionByDistributionId": Distribution,
"currencyByCurrency": Currency,
"distributionPaymentStatusByStatus": DistributionPaymentStatus
}
}
}
distributionPaymentById
Response
Returns a DistributionPayment
Arguments
| Name | Description |
|---|---|
id - UUID!
|
Example
Query
query distributionPaymentById($id: UUID!) {
distributionPaymentById(id: $id) {
nodeId
distributionId
currency
amount
paidOn
id
transactionGroupId
note
status
distributionByDistributionId {
...DistributionFragment
}
currencyByCurrency {
...CurrencyFragment
}
distributionPaymentStatusByStatus {
...DistributionPaymentStatusFragment
}
}
}
Variables
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
Response
{
"data": {
"distributionPaymentById": {
"nodeId": "4",
"distributionId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"currency": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"amount": BigFloat,
"paidOn": Datetime,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"transactionGroupId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"note": "abc123",
"status": "abc123",
"distributionByDistributionId": Distribution,
"currencyByCurrency": Currency,
"distributionPaymentStatusByStatus": DistributionPaymentStatus
}
}
}
distributionPaymentStatus
Description
Reads a single DistributionPaymentStatus using its globally unique ID.
Response
Returns a DistributionPaymentStatus
Arguments
| Name | Description |
|---|---|
nodeId - ID!
|
The globally unique ID to be used in selecting a single DistributionPaymentStatus. |
Example
Query
query distributionPaymentStatus($nodeId: ID!) {
distributionPaymentStatus(nodeId: $nodeId) {
nodeId
status
distributionPaymentsByStatus {
...DistributionPaymentsConnectionFragment
}
}
}
Variables
{"nodeId": "4"}
Response
{
"data": {
"distributionPaymentStatus": {
"nodeId": 4,
"status": "xyz789",
"distributionPaymentsByStatus": DistributionPaymentsConnection
}
}
}
distributionPaymentStatusByStatus
Response
Returns a DistributionPaymentStatus
Arguments
| Name | Description |
|---|---|
status - String!
|
Example
Query
query distributionPaymentStatusByStatus($status: String!) {
distributionPaymentStatusByStatus(status: $status) {
nodeId
status
distributionPaymentsByStatus {
...DistributionPaymentsConnectionFragment
}
}
}
Variables
{"status": "abc123"}
Response
{
"data": {
"distributionPaymentStatusByStatus": {
"nodeId": "4",
"status": "abc123",
"distributionPaymentsByStatus": DistributionPaymentsConnection
}
}
}
distributionPrice
Description
Reads a single DistributionPrice using its globally unique ID.
Response
Returns a DistributionPrice
Arguments
| Name | Description |
|---|---|
nodeId - ID!
|
The globally unique ID to be used in selecting a single DistributionPrice. |
Example
Query
query distributionPrice($nodeId: ID!) {
distributionPrice(nodeId: $nodeId) {
nodeId
distributionId
currency
price
id
isPurchase
locked
distributionByDistributionId {
...DistributionFragment
}
currencyByCurrency {
...CurrencyFragment
}
}
}
Variables
{"nodeId": 4}
Response
{
"data": {
"distributionPrice": {
"nodeId": "4",
"distributionId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"currency": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"price": BigFloat,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"isPurchase": true,
"locked": false,
"distributionByDistributionId": Distribution,
"currencyByCurrency": Currency
}
}
}
distributionPriceById
Response
Returns a DistributionPrice
Arguments
| Name | Description |
|---|---|
id - UUID!
|
Example
Query
query distributionPriceById($id: UUID!) {
distributionPriceById(id: $id) {
nodeId
distributionId
currency
price
id
isPurchase
locked
distributionByDistributionId {
...DistributionFragment
}
currencyByCurrency {
...CurrencyFragment
}
}
}
Variables
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
Response
{
"data": {
"distributionPriceById": {
"nodeId": "4",
"distributionId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"currency": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"price": BigFloat,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"isPurchase": false,
"locked": false,
"distributionByDistributionId": Distribution,
"currencyByCurrency": Currency
}
}
}
distributionQualification
Description
Reads a single DistributionQualification using its globally unique ID.
Response
Returns a DistributionQualification
Arguments
| Name | Description |
|---|---|
nodeId - ID!
|
The globally unique ID to be used in selecting a single DistributionQualification. |
Example
Query
query distributionQualification($nodeId: ID!) {
distributionQualification(nodeId: $nodeId) {
nodeId
id
vendorQualificationId
distributionId
integrationId
stepId
executeOrder
locked
vendorQualificationByVendorQualificationId {
...VendorQualificationFragment
}
distributionByDistributionId {
...DistributionFragment
}
integrationByIntegrationId {
...IntegrationFragment
}
stepByStepId {
...StepFragment
}
status
}
}
Variables
{"nodeId": "4"}
Response
{
"data": {
"distributionQualification": {
"nodeId": "4",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"vendorQualificationId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"distributionId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"integrationId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"stepId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"executeOrder": 987,
"locked": true,
"vendorQualificationByVendorQualificationId": VendorQualification,
"distributionByDistributionId": Distribution,
"integrationByIntegrationId": Integration,
"stepByStepId": Step,
"status": "abc123"
}
}
}
distributionQualificationByDistributionIdAndVendorQualificationId
Response
Returns a DistributionQualification
Example
Query
query distributionQualificationByDistributionIdAndVendorQualificationId(
$distributionId: UUID!,
$vendorQualificationId: UUID!
) {
distributionQualificationByDistributionIdAndVendorQualificationId(
distributionId: $distributionId,
vendorQualificationId: $vendorQualificationId
) {
nodeId
id
vendorQualificationId
distributionId
integrationId
stepId
executeOrder
locked
vendorQualificationByVendorQualificationId {
...VendorQualificationFragment
}
distributionByDistributionId {
...DistributionFragment
}
integrationByIntegrationId {
...IntegrationFragment
}
stepByStepId {
...StepFragment
}
status
}
}
Variables
{
"distributionId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"vendorQualificationId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
Response
{
"data": {
"distributionQualificationByDistributionIdAndVendorQualificationId": {
"nodeId": 4,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"vendorQualificationId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"distributionId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"integrationId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"stepId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"executeOrder": 123,
"locked": true,
"vendorQualificationByVendorQualificationId": VendorQualification,
"distributionByDistributionId": Distribution,
"integrationByIntegrationId": Integration,
"stepByStepId": Step,
"status": "abc123"
}
}
}
distributionQualificationById
Response
Returns a DistributionQualification
Arguments
| Name | Description |
|---|---|
id - UUID!
|
Example
Query
query distributionQualificationById($id: UUID!) {
distributionQualificationById(id: $id) {
nodeId
id
vendorQualificationId
distributionId
integrationId
stepId
executeOrder
locked
vendorQualificationByVendorQualificationId {
...VendorQualificationFragment
}
distributionByDistributionId {
...DistributionFragment
}
integrationByIntegrationId {
...IntegrationFragment
}
stepByStepId {
...StepFragment
}
status
}
}
Variables
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
Response
{
"data": {
"distributionQualificationById": {
"nodeId": "4",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"vendorQualificationId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"distributionId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"integrationId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"stepId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"executeOrder": 987,
"locked": false,
"vendorQualificationByVendorQualificationId": VendorQualification,
"distributionByDistributionId": Distribution,
"integrationByIntegrationId": Integration,
"stepByStepId": Step,
"status": "xyz789"
}
}
}
distributionStatus
Description
Reads a single DistributionStatus using its globally unique ID.
Response
Returns a DistributionStatus
Arguments
| Name | Description |
|---|---|
nodeId - ID!
|
The globally unique ID to be used in selecting a single DistributionStatus. |
Example
Query
query distributionStatus($nodeId: ID!) {
distributionStatus(nodeId: $nodeId) {
nodeId
status
distributionsByStatus {
...DistributionsConnectionFragment
}
}
}
Variables
{"nodeId": "4"}
Response
{
"data": {
"distributionStatus": {
"nodeId": "4",
"status": "abc123",
"distributionsByStatus": DistributionsConnection
}
}
}
distributionStatusByStatus
Response
Returns a DistributionStatus
Arguments
| Name | Description |
|---|---|
status - String!
|
Example
Query
query distributionStatusByStatus($status: String!) {
distributionStatusByStatus(status: $status) {
nodeId
status
distributionsByStatus {
...DistributionsConnectionFragment
}
}
}
Variables
{"status": "xyz789"}
Response
{
"data": {
"distributionStatusByStatus": {
"nodeId": 4,
"status": "xyz789",
"distributionsByStatus": DistributionsConnection
}
}
}
document
Description
Reads a single Document using its globally unique ID.
Response
Returns a Document
Arguments
| Name | Description |
|---|---|
nodeId - ID!
|
The globally unique ID to be used in selecting a single Document. |
Example
Query
query document($nodeId: ID!) {
document(nodeId: $nodeId) {
nodeId
id
name
extension
uploadEnd
createdOn
uploadStatus
uploadedBy
type
documentStatusByUploadStatus {
...DocumentStatusFragment
}
accountByUploadedBy {
...AccountFragment
}
documentTypeByType {
...DocumentTypeFragment
}
holdingDocumentsByDocumentId {
...HoldingDocumentsConnectionFragment
}
accountDocumentsByDocumentId {
...AccountDocumentsConnectionFragment
}
documentSharingsByDocumentId {
...DocumentSharingsConnectionFragment
}
securityDocumentsByDocumentId {
...SecurityDocumentsConnectionFragment
}
downloadUrl
}
}
Variables
{"nodeId": "4"}
Response
{
"data": {
"document": {
"nodeId": "4",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"name": "xyz789",
"extension": "abc123",
"uploadEnd": Datetime,
"createdOn": Datetime,
"uploadStatus": "abc123",
"uploadedBy": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"type": "xyz789",
"documentStatusByUploadStatus": DocumentStatus,
"accountByUploadedBy": Account,
"documentTypeByType": DocumentType,
"holdingDocumentsByDocumentId": HoldingDocumentsConnection,
"accountDocumentsByDocumentId": AccountDocumentsConnection,
"documentSharingsByDocumentId": DocumentSharingsConnection,
"securityDocumentsByDocumentId": SecurityDocumentsConnection,
"downloadUrl": "xyz789"
}
}
}
documentById
Example
Query
query documentById($id: UUID!) {
documentById(id: $id) {
nodeId
id
name
extension
uploadEnd
createdOn
uploadStatus
uploadedBy
type
documentStatusByUploadStatus {
...DocumentStatusFragment
}
accountByUploadedBy {
...AccountFragment
}
documentTypeByType {
...DocumentTypeFragment
}
holdingDocumentsByDocumentId {
...HoldingDocumentsConnectionFragment
}
accountDocumentsByDocumentId {
...AccountDocumentsConnectionFragment
}
documentSharingsByDocumentId {
...DocumentSharingsConnectionFragment
}
securityDocumentsByDocumentId {
...SecurityDocumentsConnectionFragment
}
downloadUrl
}
}
Variables
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
Response
{
"data": {
"documentById": {
"nodeId": "4",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"name": "xyz789",
"extension": "abc123",
"uploadEnd": Datetime,
"createdOn": Datetime,
"uploadStatus": "xyz789",
"uploadedBy": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"type": "xyz789",
"documentStatusByUploadStatus": DocumentStatus,
"accountByUploadedBy": Account,
"documentTypeByType": DocumentType,
"holdingDocumentsByDocumentId": HoldingDocumentsConnection,
"accountDocumentsByDocumentId": AccountDocumentsConnection,
"documentSharingsByDocumentId": DocumentSharingsConnection,
"securityDocumentsByDocumentId": SecurityDocumentsConnection,
"downloadUrl": "xyz789"
}
}
}
documentSharing
Description
Reads a single DocumentSharing using its globally unique ID.
Response
Returns a DocumentSharing
Arguments
| Name | Description |
|---|---|
nodeId - ID!
|
The globally unique ID to be used in selecting a single DocumentSharing. |
Example
Query
query documentSharing($nodeId: ID!) {
documentSharing(nodeId: $nodeId) {
nodeId
id
documentId
uploaderId
toRole
createdBy
documentSharingAllowedShareId
name
documentByDocumentId {
...DocumentFragment
}
accountByUploaderId {
...AccountFragment
}
documentSharingRoleByToRole {
...DocumentSharingRoleFragment
}
userByCreatedBy {
...UserFragment
}
}
}
Variables
{"nodeId": 4}
Response
{
"data": {
"documentSharing": {
"nodeId": "4",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"documentId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"uploaderId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"toRole": "abc123",
"createdBy": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"documentSharingAllowedShareId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"name": "xyz789",
"documentByDocumentId": Document,
"accountByUploaderId": Account,
"documentSharingRoleByToRole": DocumentSharingRole,
"userByCreatedBy": User
}
}
}
documentSharingById
Response
Returns a DocumentSharing
Arguments
| Name | Description |
|---|---|
id - UUID!
|
Example
Query
query documentSharingById($id: UUID!) {
documentSharingById(id: $id) {
nodeId
id
documentId
uploaderId
toRole
createdBy
documentSharingAllowedShareId
name
documentByDocumentId {
...DocumentFragment
}
accountByUploaderId {
...AccountFragment
}
documentSharingRoleByToRole {
...DocumentSharingRoleFragment
}
userByCreatedBy {
...UserFragment
}
}
}
Variables
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
Response
{
"data": {
"documentSharingById": {
"nodeId": 4,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"documentId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"uploaderId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"toRole": "xyz789",
"createdBy": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"documentSharingAllowedShareId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"name": "xyz789",
"documentByDocumentId": Document,
"accountByUploaderId": Account,
"documentSharingRoleByToRole": DocumentSharingRole,
"userByCreatedBy": User
}
}
}
documentSharingRole
Description
Reads a single DocumentSharingRole using its globally unique ID.
Response
Returns a DocumentSharingRole
Arguments
| Name | Description |
|---|---|
nodeId - ID!
|
The globally unique ID to be used in selecting a single DocumentSharingRole. |
Example
Query
query documentSharingRole($nodeId: ID!) {
documentSharingRole(nodeId: $nodeId) {
nodeId
role
documentSharingAllowedSharesByToRole {
...DocumentSharingAllowedSharesConnectionFragment
}
documentSharingsByToRole {
...DocumentSharingsConnectionFragment
}
}
}
Variables
{"nodeId": "4"}
Response
{
"data": {
"documentSharingRole": {
"nodeId": 4,
"role": "xyz789",
"documentSharingAllowedSharesByToRole": DocumentSharingAllowedSharesConnection,
"documentSharingsByToRole": DocumentSharingsConnection
}
}
}
documentSharingRoleByRole
Response
Returns a DocumentSharingRole
Arguments
| Name | Description |
|---|---|
role - String!
|
Example
Query
query documentSharingRoleByRole($role: String!) {
documentSharingRoleByRole(role: $role) {
nodeId
role
documentSharingAllowedSharesByToRole {
...DocumentSharingAllowedSharesConnectionFragment
}
documentSharingsByToRole {
...DocumentSharingsConnectionFragment
}
}
}
Variables
{"role": "abc123"}
Response
{
"data": {
"documentSharingRoleByRole": {
"nodeId": "4",
"role": "xyz789",
"documentSharingAllowedSharesByToRole": DocumentSharingAllowedSharesConnection,
"documentSharingsByToRole": DocumentSharingsConnection
}
}
}
documentStatus
Description
Reads a single DocumentStatus using its globally unique ID.
Response
Returns a DocumentStatus
Arguments
| Name | Description |
|---|---|
nodeId - ID!
|
The globally unique ID to be used in selecting a single DocumentStatus. |
Example
Query
query documentStatus($nodeId: ID!) {
documentStatus(nodeId: $nodeId) {
nodeId
status
documentsByUploadStatus {
...DocumentsConnectionFragment
}
}
}
Variables
{"nodeId": 4}
Response
{
"data": {
"documentStatus": {
"nodeId": "4",
"status": "xyz789",
"documentsByUploadStatus": DocumentsConnection
}
}
}
documentStatusByStatus
Response
Returns a DocumentStatus
Arguments
| Name | Description |
|---|---|
status - String!
|
Example
Query
query documentStatusByStatus($status: String!) {
documentStatusByStatus(status: $status) {
nodeId
status
documentsByUploadStatus {
...DocumentsConnectionFragment
}
}
}
Variables
{"status": "xyz789"}
Response
{
"data": {
"documentStatusByStatus": {
"nodeId": 4,
"status": "abc123",
"documentsByUploadStatus": DocumentsConnection
}
}
}
documentType
Description
Reads a single DocumentType using its globally unique ID.
Response
Returns a DocumentType
Arguments
| Name | Description |
|---|---|
nodeId - ID!
|
The globally unique ID to be used in selecting a single DocumentType. |
Example
Query
query documentType($nodeId: ID!) {
documentType(nodeId: $nodeId) {
nodeId
type
documentsByType {
...DocumentsConnectionFragment
}
}
}
Variables
{"nodeId": 4}
Response
{
"data": {
"documentType": {
"nodeId": 4,
"type": "abc123",
"documentsByType": DocumentsConnection
}
}
}
documentTypeByType
Response
Returns a DocumentType
Arguments
| Name | Description |
|---|---|
type - String!
|
Example
Query
query documentTypeByType($type: String!) {
documentTypeByType(type: $type) {
nodeId
type
documentsByType {
...DocumentsConnectionFragment
}
}
}
Variables
{"type": "abc123"}
Response
{
"data": {
"documentTypeByType": {
"nodeId": "4",
"type": "abc123",
"documentsByType": DocumentsConnection
}
}
}
email
Description
Reads a single Email using its globally unique ID.
Response
Returns an Email
Arguments
| Name | Description |
|---|---|
nodeId - ID!
|
The globally unique ID to be used in selecting a single Email. |
Example
Query
query email($nodeId: ID!) {
email(nodeId: $nodeId) {
nodeId
userId
email
createdOn
id
userByUserId {
...UserFragment
}
}
}
Variables
{"nodeId": 4}
Response
{
"data": {
"email": {
"nodeId": 4,
"userId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"email": "abc123",
"createdOn": Datetime,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"userByUserId": User
}
}
}
emailByEmail
Example
Query
query emailByEmail($email: String!) {
emailByEmail(email: $email) {
nodeId
userId
email
createdOn
id
userByUserId {
...UserFragment
}
}
}
Variables
{"email": "abc123"}
Response
{
"data": {
"emailByEmail": {
"nodeId": "4",
"userId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"email": "abc123",
"createdOn": Datetime,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"userByUserId": User
}
}
}
emailById
Example
Query
query emailById($id: UUID!) {
emailById(id: $id) {
nodeId
userId
email
createdOn
id
userByUserId {
...UserFragment
}
}
}
Variables
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
Response
{
"data": {
"emailById": {
"nodeId": 4,
"userId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"email": "xyz789",
"createdOn": Datetime,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"userByUserId": User
}
}
}
emailTemplateTo
Description
Reads a single EmailTemplateTo using its globally unique ID.
Response
Returns an EmailTemplateTo
Arguments
| Name | Description |
|---|---|
nodeId - ID!
|
The globally unique ID to be used in selecting a single EmailTemplateTo. |
Example
Query
query emailTemplateTo($nodeId: ID!) {
emailTemplateTo(nodeId: $nodeId) {
nodeId
to
}
}
Variables
{"nodeId": 4}
Response
{
"data": {
"emailTemplateTo": {
"nodeId": "4",
"to": "abc123"
}
}
}
emailTemplateToByTo
Response
Returns an EmailTemplateTo
Arguments
| Name | Description |
|---|---|
to - String!
|
Example
Query
query emailTemplateToByTo($to: String!) {
emailTemplateToByTo(to: $to) {
nodeId
to
}
}
Variables
{"to": "abc123"}
Response
{
"data": {
"emailTemplateToByTo": {
"nodeId": 4,
"to": "abc123"
}
}
}
getUsersData
Response
Returns a GetUsersDataRecord
Example
Query
query getUsersData {
getUsersData {
user
userAccount
account
}
}
Response
{"data": {"getUsersData": {"user": {}, "userAccount": {}, "account": {}}}}
holding
Description
Reads a single Holding using its globally unique ID.
Response
Returns a Holding
Arguments
| Name | Description |
|---|---|
nodeId - ID!
|
The globally unique ID to be used in selecting a single Holding. |
Example
Query
query holding($nodeId: ID!) {
holding(nodeId: $nodeId) {
nodeId
id
investorId
securityId
amount
purchasePrice
purchaseCurrency
createdOn
issuedOn
staging
accountByInvestorId {
...AccountFragment
}
securityBySecurityId {
...SecurityFragment
}
currencyByPurchaseCurrency {
...CurrencyFragment
}
holdingBlockchainAddressesByHoldingId {
...HoldingBlockchainAddressesConnectionFragment
}
issuanceEventsByHoldingId {
...IssuanceEventsConnectionFragment
}
holdingDocumentsByHoldingId {
...HoldingDocumentsConnectionFragment
}
omnibusHoldingsByHoldingId {
...OmnibusHoldingsConnectionFragment
}
stagedBalanceTransfersByToHoldingId {
...StagedBalanceTransfersConnectionFragment
}
stagedBalanceTransfersByFromHoldingId {
...StagedBalanceTransfersConnectionFragment
}
transfersByFromHoldingId {
...TransfersConnectionFragment
}
transfersByToHoldingId {
...TransfersConnectionFragment
}
costBasis
lotPrice
percentOfSecurityTotal
}
}
Variables
{"nodeId": 4}
Response
{
"data": {
"holding": {
"nodeId": "4",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"investorId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"securityId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"amount": BigFloat,
"purchasePrice": BigFloat,
"purchaseCurrency": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"createdOn": Datetime,
"issuedOn": Datetime,
"staging": true,
"accountByInvestorId": Account,
"securityBySecurityId": Security,
"currencyByPurchaseCurrency": Currency,
"holdingBlockchainAddressesByHoldingId": HoldingBlockchainAddressesConnection,
"issuanceEventsByHoldingId": IssuanceEventsConnection,
"holdingDocumentsByHoldingId": HoldingDocumentsConnection,
"omnibusHoldingsByHoldingId": OmnibusHoldingsConnection,
"stagedBalanceTransfersByToHoldingId": StagedBalanceTransfersConnection,
"stagedBalanceTransfersByFromHoldingId": StagedBalanceTransfersConnection,
"transfersByFromHoldingId": TransfersConnection,
"transfersByToHoldingId": TransfersConnection,
"costBasis": BigFloat,
"lotPrice": BigFloat,
"percentOfSecurityTotal": BigFloat
}
}
}
holdingBlockchainAddress
Description
Reads a single HoldingBlockchainAddress using its globally unique ID.
Response
Returns a HoldingBlockchainAddress
Arguments
| Name | Description |
|---|---|
nodeId - ID!
|
The globally unique ID to be used in selecting a single HoldingBlockchainAddress. |
Example
Query
query holdingBlockchainAddress($nodeId: ID!) {
holdingBlockchainAddress(nodeId: $nodeId) {
nodeId
id
blockchainAddressId
holdingId
status
createdOn
blockchainAddressByBlockchainAddressId {
...BlockchainAddressFragment
}
holdingByHoldingId {
...HoldingFragment
}
holdingBlockchainAddressStatusByStatus {
...HoldingBlockchainAddressStatusFragment
}
}
}
Variables
{"nodeId": "4"}
Response
{
"data": {
"holdingBlockchainAddress": {
"nodeId": 4,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"blockchainAddressId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"holdingId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"status": "abc123",
"createdOn": Datetime,
"blockchainAddressByBlockchainAddressId": BlockchainAddress,
"holdingByHoldingId": Holding,
"holdingBlockchainAddressStatusByStatus": HoldingBlockchainAddressStatus
}
}
}
holdingBlockchainAddressByBlockchainAddressId
Response
Returns a HoldingBlockchainAddress
Arguments
| Name | Description |
|---|---|
blockchainAddressId - UUID!
|
Example
Query
query holdingBlockchainAddressByBlockchainAddressId($blockchainAddressId: UUID!) {
holdingBlockchainAddressByBlockchainAddressId(blockchainAddressId: $blockchainAddressId) {
nodeId
id
blockchainAddressId
holdingId
status
createdOn
blockchainAddressByBlockchainAddressId {
...BlockchainAddressFragment
}
holdingByHoldingId {
...HoldingFragment
}
holdingBlockchainAddressStatusByStatus {
...HoldingBlockchainAddressStatusFragment
}
}
}
Variables
{
"blockchainAddressId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
Response
{
"data": {
"holdingBlockchainAddressByBlockchainAddressId": {
"nodeId": "4",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"blockchainAddressId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"holdingId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"status": "abc123",
"createdOn": Datetime,
"blockchainAddressByBlockchainAddressId": BlockchainAddress,
"holdingByHoldingId": Holding,
"holdingBlockchainAddressStatusByStatus": HoldingBlockchainAddressStatus
}
}
}
holdingBlockchainAddressById
Response
Returns a HoldingBlockchainAddress
Arguments
| Name | Description |
|---|---|
id - UUID!
|
Example
Query
query holdingBlockchainAddressById($id: UUID!) {
holdingBlockchainAddressById(id: $id) {
nodeId
id
blockchainAddressId
holdingId
status
createdOn
blockchainAddressByBlockchainAddressId {
...BlockchainAddressFragment
}
holdingByHoldingId {
...HoldingFragment
}
holdingBlockchainAddressStatusByStatus {
...HoldingBlockchainAddressStatusFragment
}
}
}
Variables
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
Response
{
"data": {
"holdingBlockchainAddressById": {
"nodeId": "4",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"blockchainAddressId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"holdingId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"status": "abc123",
"createdOn": Datetime,
"blockchainAddressByBlockchainAddressId": BlockchainAddress,
"holdingByHoldingId": Holding,
"holdingBlockchainAddressStatusByStatus": HoldingBlockchainAddressStatus
}
}
}
holdingBlockchainAddressStatus
Description
Reads a single HoldingBlockchainAddressStatus using its globally unique ID.
Response
Returns a HoldingBlockchainAddressStatus
Arguments
| Name | Description |
|---|---|
nodeId - ID!
|
The globally unique ID to be used in selecting a single HoldingBlockchainAddressStatus. |
Example
Query
query holdingBlockchainAddressStatus($nodeId: ID!) {
holdingBlockchainAddressStatus(nodeId: $nodeId) {
nodeId
status
holdingBlockchainAddressesByStatus {
...HoldingBlockchainAddressesConnectionFragment
}
}
}
Variables
{"nodeId": 4}
Response
{
"data": {
"holdingBlockchainAddressStatus": {
"nodeId": 4,
"status": "xyz789",
"holdingBlockchainAddressesByStatus": HoldingBlockchainAddressesConnection
}
}
}
holdingBlockchainAddressStatusByStatus
Response
Returns a HoldingBlockchainAddressStatus
Arguments
| Name | Description |
|---|---|
status - String!
|
Example
Query
query holdingBlockchainAddressStatusByStatus($status: String!) {
holdingBlockchainAddressStatusByStatus(status: $status) {
nodeId
status
holdingBlockchainAddressesByStatus {
...HoldingBlockchainAddressesConnectionFragment
}
}
}
Variables
{"status": "xyz789"}
Response
{
"data": {
"holdingBlockchainAddressStatusByStatus": {
"nodeId": 4,
"status": "xyz789",
"holdingBlockchainAddressesByStatus": HoldingBlockchainAddressesConnection
}
}
}
holdingById
Example
Query
query holdingById($id: UUID!) {
holdingById(id: $id) {
nodeId
id
investorId
securityId
amount
purchasePrice
purchaseCurrency
createdOn
issuedOn
staging
accountByInvestorId {
...AccountFragment
}
securityBySecurityId {
...SecurityFragment
}
currencyByPurchaseCurrency {
...CurrencyFragment
}
holdingBlockchainAddressesByHoldingId {
...HoldingBlockchainAddressesConnectionFragment
}
issuanceEventsByHoldingId {
...IssuanceEventsConnectionFragment
}
holdingDocumentsByHoldingId {
...HoldingDocumentsConnectionFragment
}
omnibusHoldingsByHoldingId {
...OmnibusHoldingsConnectionFragment
}
stagedBalanceTransfersByToHoldingId {
...StagedBalanceTransfersConnectionFragment
}
stagedBalanceTransfersByFromHoldingId {
...StagedBalanceTransfersConnectionFragment
}
transfersByFromHoldingId {
...TransfersConnectionFragment
}
transfersByToHoldingId {
...TransfersConnectionFragment
}
costBasis
lotPrice
percentOfSecurityTotal
}
}
Variables
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
Response
{
"data": {
"holdingById": {
"nodeId": "4",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"investorId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"securityId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"amount": BigFloat,
"purchasePrice": BigFloat,
"purchaseCurrency": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"createdOn": Datetime,
"issuedOn": Datetime,
"staging": false,
"accountByInvestorId": Account,
"securityBySecurityId": Security,
"currencyByPurchaseCurrency": Currency,
"holdingBlockchainAddressesByHoldingId": HoldingBlockchainAddressesConnection,
"issuanceEventsByHoldingId": IssuanceEventsConnection,
"holdingDocumentsByHoldingId": HoldingDocumentsConnection,
"omnibusHoldingsByHoldingId": OmnibusHoldingsConnection,
"stagedBalanceTransfersByToHoldingId": StagedBalanceTransfersConnection,
"stagedBalanceTransfersByFromHoldingId": StagedBalanceTransfersConnection,
"transfersByFromHoldingId": TransfersConnection,
"transfersByToHoldingId": TransfersConnection,
"costBasis": BigFloat,
"lotPrice": BigFloat,
"percentOfSecurityTotal": BigFloat
}
}
}
holdingCapTable
Description
Reads and enables pagination through a set of CapTable.
Response
Returns a CapTablesConnection
Arguments
| Name | Description |
|---|---|
first - Int
|
Only read the first n values of the set. |
last - Int
|
Only read the last n values of the set. |
offset - Int
|
Skip the first n values from our after cursor, an alternative to cursor based pagination. May not be used with last. |
before - Cursor
|
Read all values in the set before (above) this cursor. |
after - Cursor
|
Read all values in the set after (below) this cursor. |
filter - CapTableFilter
|
A filter to be used in determining which values should be returned by the collection. |
Example
Query
query holdingCapTable(
$first: Int,
$last: Int,
$offset: Int,
$before: Cursor,
$after: Cursor,
$filter: CapTableFilter
) {
holdingCapTable(
first: $first,
last: $last,
offset: $offset,
before: $before,
after: $after,
filter: $filter
) {
nodes {
...CapTableFragment
}
edges {
...CapTablesEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"first": 987,
"last": 123,
"offset": 987,
"before": Cursor,
"after": Cursor,
"filter": CapTableFilter
}
Response
{
"data": {
"holdingCapTable": {
"nodes": [CapTable],
"edges": [CapTablesEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
}
}
holdingDocument
Description
Reads a single HoldingDocument using its globally unique ID.
Response
Returns a HoldingDocument
Arguments
| Name | Description |
|---|---|
nodeId - ID!
|
The globally unique ID to be used in selecting a single HoldingDocument. |
Example
Query
query holdingDocument($nodeId: ID!) {
holdingDocument(nodeId: $nodeId) {
nodeId
id
documentId
holdingId
createdOn
documentByDocumentId {
...DocumentFragment
}
holdingByHoldingId {
...HoldingFragment
}
}
}
Variables
{"nodeId": 4}
Response
{
"data": {
"holdingDocument": {
"nodeId": "4",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"documentId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"holdingId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"createdOn": Datetime,
"documentByDocumentId": Document,
"holdingByHoldingId": Holding
}
}
}
holdingDocumentByDocumentIdAndHoldingId
Response
Returns a HoldingDocument
Example
Query
query holdingDocumentByDocumentIdAndHoldingId(
$documentId: UUID!,
$holdingId: UUID!
) {
holdingDocumentByDocumentIdAndHoldingId(
documentId: $documentId,
holdingId: $holdingId
) {
nodeId
id
documentId
holdingId
createdOn
documentByDocumentId {
...DocumentFragment
}
holdingByHoldingId {
...HoldingFragment
}
}
}
Variables
{
"documentId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"holdingId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
Response
{
"data": {
"holdingDocumentByDocumentIdAndHoldingId": {
"nodeId": "4",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"documentId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"holdingId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"createdOn": Datetime,
"documentByDocumentId": Document,
"holdingByHoldingId": Holding
}
}
}
holdingDocumentById
Response
Returns a HoldingDocument
Arguments
| Name | Description |
|---|---|
id - UUID!
|
Example
Query
query holdingDocumentById($id: UUID!) {
holdingDocumentById(id: $id) {
nodeId
id
documentId
holdingId
createdOn
documentByDocumentId {
...DocumentFragment
}
holdingByHoldingId {
...HoldingFragment
}
}
}
Variables
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
Response
{
"data": {
"holdingDocumentById": {
"nodeId": "4",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"documentId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"holdingId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"createdOn": Datetime,
"documentByDocumentId": Document,
"holdingByHoldingId": Holding
}
}
}
instancedAccountInformation
Description
Reads a single InstancedAccountInformation using its globally unique ID.
Response
Returns an InstancedAccountInformation
Arguments
| Name | Description |
|---|---|
nodeId - ID!
|
The globally unique ID to be used in selecting a single InstancedAccountInformation. |
Example
Query
query instancedAccountInformation($nodeId: ID!) {
instancedAccountInformation(nodeId: $nodeId) {
nodeId
id
accountId
vendorAccountId
field
value
permissionMask
accountByAccountId {
...AccountFragment
}
accountByVendorAccountId {
...AccountFragment
}
instancedAccountInformationHistoriesByRecordId {
...InstancedAccountInformationHistoriesConnectionFragment
}
}
}
Variables
{"nodeId": "4"}
Response
{
"data": {
"instancedAccountInformation": {
"nodeId": 4,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"vendorAccountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"field": "abc123",
"value": "xyz789",
"permissionMask": BitString,
"accountByAccountId": Account,
"accountByVendorAccountId": Account,
"instancedAccountInformationHistoriesByRecordId": InstancedAccountInformationHistoriesConnection
}
}
}
instancedAccountInformationById
Response
Returns an InstancedAccountInformation
Arguments
| Name | Description |
|---|---|
id - UUID!
|
Example
Query
query instancedAccountInformationById($id: UUID!) {
instancedAccountInformationById(id: $id) {
nodeId
id
accountId
vendorAccountId
field
value
permissionMask
accountByAccountId {
...AccountFragment
}
accountByVendorAccountId {
...AccountFragment
}
instancedAccountInformationHistoriesByRecordId {
...InstancedAccountInformationHistoriesConnectionFragment
}
}
}
Variables
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
Response
{
"data": {
"instancedAccountInformationById": {
"nodeId": "4",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"vendorAccountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"field": "xyz789",
"value": "abc123",
"permissionMask": BitString,
"accountByAccountId": Account,
"accountByVendorAccountId": Account,
"instancedAccountInformationHistoriesByRecordId": InstancedAccountInformationHistoriesConnection
}
}
}
instancedAccountInformationByVendorAccountIdAndAccountIdAndField
Response
Returns an InstancedAccountInformation
Example
Query
query instancedAccountInformationByVendorAccountIdAndAccountIdAndField(
$vendorAccountId: UUID!,
$accountId: UUID!,
$field: String!
) {
instancedAccountInformationByVendorAccountIdAndAccountIdAndField(
vendorAccountId: $vendorAccountId,
accountId: $accountId,
field: $field
) {
nodeId
id
accountId
vendorAccountId
field
value
permissionMask
accountByAccountId {
...AccountFragment
}
accountByVendorAccountId {
...AccountFragment
}
instancedAccountInformationHistoriesByRecordId {
...InstancedAccountInformationHistoriesConnectionFragment
}
}
}
Variables
{
"vendorAccountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"field": "abc123"
}
Response
{
"data": {
"instancedAccountInformationByVendorAccountIdAndAccountIdAndField": {
"nodeId": 4,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"vendorAccountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"field": "abc123",
"value": "xyz789",
"permissionMask": BitString,
"accountByAccountId": Account,
"accountByVendorAccountId": Account,
"instancedAccountInformationHistoriesByRecordId": InstancedAccountInformationHistoriesConnection
}
}
}
instancedAccountInformationHistory
Description
Reads a single InstancedAccountInformationHistory using its globally unique ID.
Response
Returns an InstancedAccountInformationHistory
Arguments
| Name | Description |
|---|---|
nodeId - ID!
|
The globally unique ID to be used in selecting a single InstancedAccountInformationHistory. |
Example
Query
query instancedAccountInformationHistory($nodeId: ID!) {
instancedAccountInformationHistory(nodeId: $nodeId) {
nodeId
id
recordId
accountId
vendorAccountId
field
value
permissionMask
updatedOn
updatedUserId
updatedAccountId
instancedAccountInformationByRecordId {
...InstancedAccountInformationFragment
}
}
}
Variables
{"nodeId": 4}
Response
{
"data": {
"instancedAccountInformationHistory": {
"nodeId": "4",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"recordId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"vendorAccountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"field": "abc123",
"value": "xyz789",
"permissionMask": BitString,
"updatedOn": Datetime,
"updatedUserId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"updatedAccountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"instancedAccountInformationByRecordId": InstancedAccountInformation
}
}
}
instancedAccountInformationHistoryById
Response
Returns an InstancedAccountInformationHistory
Arguments
| Name | Description |
|---|---|
id - UUID!
|
Example
Query
query instancedAccountInformationHistoryById($id: UUID!) {
instancedAccountInformationHistoryById(id: $id) {
nodeId
id
recordId
accountId
vendorAccountId
field
value
permissionMask
updatedOn
updatedUserId
updatedAccountId
instancedAccountInformationByRecordId {
...InstancedAccountInformationFragment
}
}
}
Variables
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
Response
{
"data": {
"instancedAccountInformationHistoryById": {
"nodeId": "4",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"recordId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"vendorAccountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"field": "xyz789",
"value": "xyz789",
"permissionMask": BitString,
"updatedOn": Datetime,
"updatedUserId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"updatedAccountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"instancedAccountInformationByRecordId": InstancedAccountInformation
}
}
}
instancedMappingField
Description
Reads a single InstancedMappingField using its globally unique ID.
Response
Returns an InstancedMappingField
Arguments
| Name | Description |
|---|---|
nodeId - ID!
|
The globally unique ID to be used in selecting a single InstancedMappingField. |
Example
Query
query instancedMappingField($nodeId: ID!) {
instancedMappingField(nodeId: $nodeId) {
nodeId
id
accountId
mappedSigningTemplateId
onboardingQuestionId
field
description
accountByAccountId {
...AccountFragment
}
mappedSigningTemplateByMappedSigningTemplateId {
...MappedSigningTemplateFragment
}
onboardingQuestionByOnboardingQuestionId {
...OnboardingQuestionFragment
}
}
}
Variables
{"nodeId": 4}
Response
{
"data": {
"instancedMappingField": {
"nodeId": "4",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"mappedSigningTemplateId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"onboardingQuestionId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"field": "xyz789",
"description": "xyz789",
"accountByAccountId": Account,
"mappedSigningTemplateByMappedSigningTemplateId": MappedSigningTemplate,
"onboardingQuestionByOnboardingQuestionId": OnboardingQuestion
}
}
}
instancedMappingFieldByAccountIdAndOnboardingQuestionIdAndMappedSigningTemplateId
Response
Returns an InstancedMappingField
Example
Query
query instancedMappingFieldByAccountIdAndOnboardingQuestionIdAndMappedSigningTemplateId(
$accountId: UUID!,
$onboardingQuestionId: UUID!,
$mappedSigningTemplateId: UUID!
) {
instancedMappingFieldByAccountIdAndOnboardingQuestionIdAndMappedSigningTemplateId(
accountId: $accountId,
onboardingQuestionId: $onboardingQuestionId,
mappedSigningTemplateId: $mappedSigningTemplateId
) {
nodeId
id
accountId
mappedSigningTemplateId
onboardingQuestionId
field
description
accountByAccountId {
...AccountFragment
}
mappedSigningTemplateByMappedSigningTemplateId {
...MappedSigningTemplateFragment
}
onboardingQuestionByOnboardingQuestionId {
...OnboardingQuestionFragment
}
}
}
Variables
{
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"onboardingQuestionId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"mappedSigningTemplateId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
Response
{
"data": {
"instancedMappingFieldByAccountIdAndOnboardingQuestionIdAndMappedSigningTemplateId": {
"nodeId": 4,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"mappedSigningTemplateId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"onboardingQuestionId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"field": "xyz789",
"description": "xyz789",
"accountByAccountId": Account,
"mappedSigningTemplateByMappedSigningTemplateId": MappedSigningTemplate,
"onboardingQuestionByOnboardingQuestionId": OnboardingQuestion
}
}
}
instancedMappingFieldById
Response
Returns an InstancedMappingField
Arguments
| Name | Description |
|---|---|
id - UUID!
|
Example
Query
query instancedMappingFieldById($id: UUID!) {
instancedMappingFieldById(id: $id) {
nodeId
id
accountId
mappedSigningTemplateId
onboardingQuestionId
field
description
accountByAccountId {
...AccountFragment
}
mappedSigningTemplateByMappedSigningTemplateId {
...MappedSigningTemplateFragment
}
onboardingQuestionByOnboardingQuestionId {
...OnboardingQuestionFragment
}
}
}
Variables
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
Response
{
"data": {
"instancedMappingFieldById": {
"nodeId": "4",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"mappedSigningTemplateId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"onboardingQuestionId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"field": "abc123",
"description": "xyz789",
"accountByAccountId": Account,
"mappedSigningTemplateByMappedSigningTemplateId": MappedSigningTemplate,
"onboardingQuestionByOnboardingQuestionId": OnboardingQuestion
}
}
}
integration
Description
Reads a single Integration using its globally unique ID.
Response
Returns an Integration
Arguments
| Name | Description |
|---|---|
nodeId - ID!
|
The globally unique ID to be used in selecting a single Integration. |
Example
Query
query integration($nodeId: ID!) {
integration(nodeId: $nodeId) {
nodeId
type
service
chain
partnerId
description
mask
id
integrationTypeByType {
...IntegrationTypeFragment
}
chainByChain {
...ChainFragment
}
integrationPartnerByPartnerId {
...IntegrationPartnerFragment
}
contractsByCustodianId {
...ContractsConnectionFragment
}
contractsByIssuancePlatformId {
...ContractsConnectionFragment
}
accountIntegrationsByIntegrationId {
...AccountIntegrationsConnectionFragment
}
vendorQualificationsByIntegrationId {
...VendorQualificationsConnectionFragment
}
distributionQualificationsByIntegrationId {
...DistributionQualificationsConnectionFragment
}
signingAccountsByIntegrationId {
...SigningAccountsConnectionFragment
}
paymentAccountsByIntegrationId {
...PaymentAccountsConnectionFragment
}
paymentMethodsByIntegrationId {
...PaymentMethodsConnectionFragment
}
accountIntegrationByIntegrationId {
...AccountIntegrationFragment
}
}
}
Variables
{"nodeId": "4"}
Response
{
"data": {
"integration": {
"nodeId": "4",
"type": "abc123",
"service": "xyz789",
"chain": "xyz789",
"partnerId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"description": "abc123",
"mask": BitString,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"integrationTypeByType": IntegrationType,
"chainByChain": Chain,
"integrationPartnerByPartnerId": IntegrationPartner,
"contractsByCustodianId": ContractsConnection,
"contractsByIssuancePlatformId": ContractsConnection,
"accountIntegrationsByIntegrationId": AccountIntegrationsConnection,
"vendorQualificationsByIntegrationId": VendorQualificationsConnection,
"distributionQualificationsByIntegrationId": DistributionQualificationsConnection,
"signingAccountsByIntegrationId": SigningAccountsConnection,
"paymentAccountsByIntegrationId": PaymentAccountsConnection,
"paymentMethodsByIntegrationId": PaymentMethodsConnection,
"accountIntegrationByIntegrationId": AccountIntegration
}
}
}
integrationById
Response
Returns an Integration
Arguments
| Name | Description |
|---|---|
id - UUID!
|
Example
Query
query integrationById($id: UUID!) {
integrationById(id: $id) {
nodeId
type
service
chain
partnerId
description
mask
id
integrationTypeByType {
...IntegrationTypeFragment
}
chainByChain {
...ChainFragment
}
integrationPartnerByPartnerId {
...IntegrationPartnerFragment
}
contractsByCustodianId {
...ContractsConnectionFragment
}
contractsByIssuancePlatformId {
...ContractsConnectionFragment
}
accountIntegrationsByIntegrationId {
...AccountIntegrationsConnectionFragment
}
vendorQualificationsByIntegrationId {
...VendorQualificationsConnectionFragment
}
distributionQualificationsByIntegrationId {
...DistributionQualificationsConnectionFragment
}
signingAccountsByIntegrationId {
...SigningAccountsConnectionFragment
}
paymentAccountsByIntegrationId {
...PaymentAccountsConnectionFragment
}
paymentMethodsByIntegrationId {
...PaymentMethodsConnectionFragment
}
accountIntegrationByIntegrationId {
...AccountIntegrationFragment
}
}
}
Variables
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
Response
{
"data": {
"integrationById": {
"nodeId": "4",
"type": "xyz789",
"service": "xyz789",
"chain": "abc123",
"partnerId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"description": "xyz789",
"mask": BitString,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"integrationTypeByType": IntegrationType,
"chainByChain": Chain,
"integrationPartnerByPartnerId": IntegrationPartner,
"contractsByCustodianId": ContractsConnection,
"contractsByIssuancePlatformId": ContractsConnection,
"accountIntegrationsByIntegrationId": AccountIntegrationsConnection,
"vendorQualificationsByIntegrationId": VendorQualificationsConnection,
"distributionQualificationsByIntegrationId": DistributionQualificationsConnection,
"signingAccountsByIntegrationId": SigningAccountsConnection,
"paymentAccountsByIntegrationId": PaymentAccountsConnection,
"paymentMethodsByIntegrationId": PaymentMethodsConnection,
"accountIntegrationByIntegrationId": AccountIntegration
}
}
}
integrationPartner
Description
Reads a single IntegrationPartner using its globally unique ID.
Response
Returns an IntegrationPartner
Arguments
| Name | Description |
|---|---|
nodeId - ID!
|
The globally unique ID to be used in selecting a single IntegrationPartner. |
Example
Query
query integrationPartner($nodeId: ID!) {
integrationPartner(nodeId: $nodeId) {
nodeId
id
name
url
logo
integrationsByPartnerId {
...IntegrationsConnectionFragment
}
}
}
Variables
{"nodeId": "4"}
Response
{
"data": {
"integrationPartner": {
"nodeId": 4,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"name": "xyz789",
"url": "abc123",
"logo": "xyz789",
"integrationsByPartnerId": IntegrationsConnection
}
}
}
integrationPartnerById
Response
Returns an IntegrationPartner
Arguments
| Name | Description |
|---|---|
id - UUID!
|
Example
Query
query integrationPartnerById($id: UUID!) {
integrationPartnerById(id: $id) {
nodeId
id
name
url
logo
integrationsByPartnerId {
...IntegrationsConnectionFragment
}
}
}
Variables
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
Response
{
"data": {
"integrationPartnerById": {
"nodeId": "4",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"name": "abc123",
"url": "abc123",
"logo": "xyz789",
"integrationsByPartnerId": IntegrationsConnection
}
}
}
integrationPartnerByName
Response
Returns an IntegrationPartner
Arguments
| Name | Description |
|---|---|
name - String!
|
Example
Query
query integrationPartnerByName($name: String!) {
integrationPartnerByName(name: $name) {
nodeId
id
name
url
logo
integrationsByPartnerId {
...IntegrationsConnectionFragment
}
}
}
Variables
{"name": "abc123"}
Response
{
"data": {
"integrationPartnerByName": {
"nodeId": "4",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"name": "xyz789",
"url": "xyz789",
"logo": "abc123",
"integrationsByPartnerId": IntegrationsConnection
}
}
}
integrationType
Description
Reads a single IntegrationType using its globally unique ID.
Response
Returns an IntegrationType
Arguments
| Name | Description |
|---|---|
nodeId - ID!
|
The globally unique ID to be used in selecting a single IntegrationType. |
Example
Query
query integrationType($nodeId: ID!) {
integrationType(nodeId: $nodeId) {
nodeId
type
integrationsByType {
...IntegrationsConnectionFragment
}
}
}
Variables
{"nodeId": "4"}
Response
{
"data": {
"integrationType": {
"nodeId": 4,
"type": "xyz789",
"integrationsByType": IntegrationsConnection
}
}
}
integrationTypeByType
Response
Returns an IntegrationType
Arguments
| Name | Description |
|---|---|
type - String!
|
Example
Query
query integrationTypeByType($type: String!) {
integrationTypeByType(type: $type) {
nodeId
type
integrationsByType {
...IntegrationsConnectionFragment
}
}
}
Variables
{"type": "xyz789"}
Response
{
"data": {
"integrationTypeByType": {
"nodeId": 4,
"type": "abc123",
"integrationsByType": IntegrationsConnection
}
}
}
investorAccountType
Description
Reads a single InvestorAccountType using its globally unique ID.
Response
Returns an InvestorAccountType
Arguments
| Name | Description |
|---|---|
nodeId - ID!
|
The globally unique ID to be used in selecting a single InvestorAccountType. |
Example
Query
query investorAccountType($nodeId: ID!) {
investorAccountType(nodeId: $nodeId) {
nodeId
type
accountsByInvestorType {
...AccountsConnectionFragment
}
customersByInvestorType {
...CustomersConnectionFragment
}
}
}
Variables
{"nodeId": "4"}
Response
{
"data": {
"investorAccountType": {
"nodeId": "4",
"type": "abc123",
"accountsByInvestorType": AccountsConnection,
"customersByInvestorType": CustomersConnection
}
}
}
investorAccountTypeByType
Response
Returns an InvestorAccountType
Arguments
| Name | Description |
|---|---|
type - String!
|
Example
Query
query investorAccountTypeByType($type: String!) {
investorAccountTypeByType(type: $type) {
nodeId
type
accountsByInvestorType {
...AccountsConnectionFragment
}
customersByInvestorType {
...CustomersConnectionFragment
}
}
}
Variables
{"type": "xyz789"}
Response
{
"data": {
"investorAccountTypeByType": {
"nodeId": "4",
"type": "xyz789",
"accountsByInvestorType": AccountsConnection,
"customersByInvestorType": CustomersConnection
}
}
}
investorOfferingDetailsById
Response
Returns an InvestorOfferingDetail
Arguments
| Name | Description |
|---|---|
id - UUID!
|
Example
Query
query investorOfferingDetailsById($id: UUID!) {
investorOfferingDetailsById(id: $id) {
id
issuerName
sellerName
assetName
className
classPrice
}
}
Variables
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
Response
{
"data": {
"investorOfferingDetailsById": {
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"issuerName": "abc123",
"sellerName": "abc123",
"assetName": "abc123",
"className": "xyz789",
"classPrice": BigFloat
}
}
}
invitationStatus
Description
Reads a single InvitationStatus using its globally unique ID.
Response
Returns an InvitationStatus
Arguments
| Name | Description |
|---|---|
nodeId - ID!
|
The globally unique ID to be used in selecting a single InvitationStatus. |
Example
Query
query invitationStatus($nodeId: ID!) {
invitationStatus(nodeId: $nodeId) {
nodeId
status
customersByStatus {
...CustomersConnectionFragment
}
brokerAllocationsByStatus {
...BrokerAllocationsConnectionFragment
}
vendorAgentsByStatus {
...VendorAgentsConnectionFragment
}
securityListingsByStatus {
...SecurityListingsConnectionFragment
}
}
}
Variables
{"nodeId": "4"}
Response
{
"data": {
"invitationStatus": {
"nodeId": "4",
"status": "xyz789",
"customersByStatus": CustomersConnection,
"brokerAllocationsByStatus": BrokerAllocationsConnection,
"vendorAgentsByStatus": VendorAgentsConnection,
"securityListingsByStatus": SecurityListingsConnection
}
}
}
invitationStatusByStatus
Response
Returns an InvitationStatus
Arguments
| Name | Description |
|---|---|
status - String!
|
Example
Query
query invitationStatusByStatus($status: String!) {
invitationStatusByStatus(status: $status) {
nodeId
status
customersByStatus {
...CustomersConnectionFragment
}
brokerAllocationsByStatus {
...BrokerAllocationsConnectionFragment
}
vendorAgentsByStatus {
...VendorAgentsConnectionFragment
}
securityListingsByStatus {
...SecurityListingsConnectionFragment
}
}
}
Variables
{"status": "abc123"}
Response
{
"data": {
"invitationStatusByStatus": {
"nodeId": 4,
"status": "xyz789",
"customersByStatus": CustomersConnection,
"brokerAllocationsByStatus": BrokerAllocationsConnection,
"vendorAgentsByStatus": VendorAgentsConnection,
"securityListingsByStatus": SecurityListingsConnection
}
}
}
issuanceEvent
Description
Reads a single IssuanceEvent using its globally unique ID.
Response
Returns an IssuanceEvent
Arguments
| Name | Description |
|---|---|
nodeId - ID!
|
The globally unique ID to be used in selecting a single IssuanceEvent. |
Example
Query
query issuanceEvent($nodeId: ID!) {
issuanceEvent(nodeId: $nodeId) {
nodeId
id
assetId
assetClassId
distributionId
investorId
issuerId
securityId
holdingId
createdOn
createdBy
assetByAssetId {
...AssetFragment
}
roundByAssetClassId {
...RoundFragment
}
distributionByDistributionId {
...DistributionFragment
}
accountByInvestorId {
...AccountFragment
}
accountByIssuerId {
...AccountFragment
}
securityBySecurityId {
...SecurityFragment
}
holdingByHoldingId {
...HoldingFragment
}
userByCreatedBy {
...UserFragment
}
}
}
Variables
{"nodeId": "4"}
Response
{
"data": {
"issuanceEvent": {
"nodeId": "4",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"assetId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"assetClassId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"distributionId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"investorId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"issuerId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"securityId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"holdingId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"createdOn": Datetime,
"createdBy": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"assetByAssetId": Asset,
"roundByAssetClassId": Round,
"distributionByDistributionId": Distribution,
"accountByInvestorId": Account,
"accountByIssuerId": Account,
"securityBySecurityId": Security,
"holdingByHoldingId": Holding,
"userByCreatedBy": User
}
}
}
issuanceEventByDistributionId
Response
Returns an IssuanceEvent
Arguments
| Name | Description |
|---|---|
distributionId - UUID!
|
Example
Query
query issuanceEventByDistributionId($distributionId: UUID!) {
issuanceEventByDistributionId(distributionId: $distributionId) {
nodeId
id
assetId
assetClassId
distributionId
investorId
issuerId
securityId
holdingId
createdOn
createdBy
assetByAssetId {
...AssetFragment
}
roundByAssetClassId {
...RoundFragment
}
distributionByDistributionId {
...DistributionFragment
}
accountByInvestorId {
...AccountFragment
}
accountByIssuerId {
...AccountFragment
}
securityBySecurityId {
...SecurityFragment
}
holdingByHoldingId {
...HoldingFragment
}
userByCreatedBy {
...UserFragment
}
}
}
Variables
{
"distributionId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
Response
{
"data": {
"issuanceEventByDistributionId": {
"nodeId": 4,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"assetId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"assetClassId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"distributionId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"investorId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"issuerId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"securityId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"holdingId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"createdOn": Datetime,
"createdBy": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"assetByAssetId": Asset,
"roundByAssetClassId": Round,
"distributionByDistributionId": Distribution,
"accountByInvestorId": Account,
"accountByIssuerId": Account,
"securityBySecurityId": Security,
"holdingByHoldingId": Holding,
"userByCreatedBy": User
}
}
}
issuanceEventById
Response
Returns an IssuanceEvent
Arguments
| Name | Description |
|---|---|
id - UUID!
|
Example
Query
query issuanceEventById($id: UUID!) {
issuanceEventById(id: $id) {
nodeId
id
assetId
assetClassId
distributionId
investorId
issuerId
securityId
holdingId
createdOn
createdBy
assetByAssetId {
...AssetFragment
}
roundByAssetClassId {
...RoundFragment
}
distributionByDistributionId {
...DistributionFragment
}
accountByInvestorId {
...AccountFragment
}
accountByIssuerId {
...AccountFragment
}
securityBySecurityId {
...SecurityFragment
}
holdingByHoldingId {
...HoldingFragment
}
userByCreatedBy {
...UserFragment
}
}
}
Variables
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
Response
{
"data": {
"issuanceEventById": {
"nodeId": 4,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"assetId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"assetClassId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"distributionId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"investorId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"issuerId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"securityId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"holdingId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"createdOn": Datetime,
"createdBy": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"assetByAssetId": Asset,
"roundByAssetClassId": Round,
"distributionByDistributionId": Distribution,
"accountByInvestorId": Account,
"accountByIssuerId": Account,
"securityBySecurityId": Security,
"holdingByHoldingId": Holding,
"userByCreatedBy": User
}
}
}
ledger
Description
Reads a single Ledger using its globally unique ID.
Response
Returns a Ledger
Arguments
| Name | Description |
|---|---|
nodeId - ID!
|
The globally unique ID to be used in selecting a single Ledger. |
Example
Query
query ledger($nodeId: ID!) {
ledger(nodeId: $nodeId) {
nodeId
type
tokenId
blockchainAddressId
investorId
transactionId
amount
createdOn
id
accountingTypeByType {
...AccountingTypeFragment
}
tokenByTokenId {
...TokenFragment
}
blockchainAddressByBlockchainAddressId {
...BlockchainAddressFragment
}
accountByInvestorId {
...AccountFragment
}
transactionByTransactionId {
...TransactionFragment
}
}
}
Variables
{"nodeId": 4}
Response
{
"data": {
"ledger": {
"nodeId": 4,
"type": "xyz789",
"tokenId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"blockchainAddressId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"investorId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"transactionId": "abc123",
"amount": BigFloat,
"createdOn": Datetime,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountingTypeByType": AccountingType,
"tokenByTokenId": Token,
"blockchainAddressByBlockchainAddressId": BlockchainAddress,
"accountByInvestorId": Account,
"transactionByTransactionId": Transaction
}
}
}
ledgerById
Example
Query
query ledgerById($id: UUID!) {
ledgerById(id: $id) {
nodeId
type
tokenId
blockchainAddressId
investorId
transactionId
amount
createdOn
id
accountingTypeByType {
...AccountingTypeFragment
}
tokenByTokenId {
...TokenFragment
}
blockchainAddressByBlockchainAddressId {
...BlockchainAddressFragment
}
accountByInvestorId {
...AccountFragment
}
transactionByTransactionId {
...TransactionFragment
}
}
}
Variables
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
Response
{
"data": {
"ledgerById": {
"nodeId": 4,
"type": "xyz789",
"tokenId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"blockchainAddressId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"investorId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"transactionId": "xyz789",
"amount": BigFloat,
"createdOn": Datetime,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountingTypeByType": AccountingType,
"tokenByTokenId": Token,
"blockchainAddressByBlockchainAddressId": BlockchainAddress,
"accountByInvestorId": Account,
"transactionByTransactionId": Transaction
}
}
}
managedAccount
Description
Reads a single ManagedAccount using its globally unique ID.
Response
Returns a ManagedAccount
Arguments
| Name | Description |
|---|---|
nodeId - ID!
|
The globally unique ID to be used in selecting a single ManagedAccount. |
Example
Query
query managedAccount($nodeId: ID!) {
managedAccount(nodeId: $nodeId) {
nodeId
managerId
entityId
createdBy
createdOn
id
accountByManagerId {
...AccountFragment
}
accountByEntityId {
...AccountFragment
}
userByCreatedBy {
...UserFragment
}
}
}
Variables
{"nodeId": 4}
Response
{
"data": {
"managedAccount": {
"nodeId": 4,
"managerId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"entityId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"createdBy": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"createdOn": Datetime,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountByManagerId": Account,
"accountByEntityId": Account,
"userByCreatedBy": User
}
}
}
managedAccountById
Response
Returns a ManagedAccount
Arguments
| Name | Description |
|---|---|
id - UUID!
|
Example
Query
query managedAccountById($id: UUID!) {
managedAccountById(id: $id) {
nodeId
managerId
entityId
createdBy
createdOn
id
accountByManagerId {
...AccountFragment
}
accountByEntityId {
...AccountFragment
}
userByCreatedBy {
...UserFragment
}
}
}
Variables
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
Response
{
"data": {
"managedAccountById": {
"nodeId": "4",
"managerId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"entityId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"createdBy": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"createdOn": Datetime,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountByManagerId": Account,
"accountByEntityId": Account,
"userByCreatedBy": User
}
}
}
managedAccountByManagerIdAndEntityId
Response
Returns a ManagedAccount
Example
Query
query managedAccountByManagerIdAndEntityId(
$managerId: UUID!,
$entityId: UUID!
) {
managedAccountByManagerIdAndEntityId(
managerId: $managerId,
entityId: $entityId
) {
nodeId
managerId
entityId
createdBy
createdOn
id
accountByManagerId {
...AccountFragment
}
accountByEntityId {
...AccountFragment
}
userByCreatedBy {
...UserFragment
}
}
}
Variables
{
"managerId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"entityId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
Response
{
"data": {
"managedAccountByManagerIdAndEntityId": {
"nodeId": "4",
"managerId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"entityId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"createdBy": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"createdOn": Datetime,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountByManagerId": Account,
"accountByEntityId": Account,
"userByCreatedBy": User
}
}
}
mappedSigningTemplate
Description
Reads a single MappedSigningTemplate using its globally unique ID.
Response
Returns a MappedSigningTemplate
Arguments
| Name | Description |
|---|---|
nodeId - ID!
|
The globally unique ID to be used in selecting a single MappedSigningTemplate. |
Example
Query
query mappedSigningTemplate($nodeId: ID!) {
mappedSigningTemplate(nodeId: $nodeId) {
nodeId
id
accountId
signingTemplateId
stepId
vendorQualificationId
name
templateCopyOn
templateUpdatedOn
deleted
locked
active
templateUri
qualificationStepType
accountByAccountId {
...AccountFragment
}
signingTemplateBySigningTemplateId {
...SigningTemplateFragment
}
stepByStepId {
...StepFragment
}
vendorQualificationByVendorQualificationId {
...VendorQualificationFragment
}
signingStepTypeByQualificationStepType {
...SigningStepTypeFragment
}
signingRolesByMappedSigningTemplateId {
...SigningRolesConnectionFragment
}
signingDocumentsByMappedSigningTemplateId {
...SigningDocumentsConnectionFragment
}
signingFieldsByMappedSigningTemplateId {
...SigningFieldsConnectionFragment
}
sentSigningDocumentsByMappedSigningTemplateId {
...SentSigningDocumentsConnectionFragment
}
instancedMappingFieldsByMappedSigningTemplateId {
...InstancedMappingFieldsConnectionFragment
}
mappedSigningTemplateQuestionSetsByMappedSigningTemplateId {
...MappedSigningTemplateQuestionSetsConnectionFragment
}
mappingFields {
...MappingFieldsConnectionFragment
}
}
}
Variables
{"nodeId": 4}
Response
{
"data": {
"mappedSigningTemplate": {
"nodeId": 4,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"signingTemplateId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"stepId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"vendorQualificationId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"name": "xyz789",
"templateCopyOn": Datetime,
"templateUpdatedOn": Datetime,
"deleted": true,
"locked": true,
"active": false,
"templateUri": "xyz789",
"qualificationStepType": "xyz789",
"accountByAccountId": Account,
"signingTemplateBySigningTemplateId": SigningTemplate,
"stepByStepId": Step,
"vendorQualificationByVendorQualificationId": VendorQualification,
"signingStepTypeByQualificationStepType": SigningStepType,
"signingRolesByMappedSigningTemplateId": SigningRolesConnection,
"signingDocumentsByMappedSigningTemplateId": SigningDocumentsConnection,
"signingFieldsByMappedSigningTemplateId": SigningFieldsConnection,
"sentSigningDocumentsByMappedSigningTemplateId": SentSigningDocumentsConnection,
"instancedMappingFieldsByMappedSigningTemplateId": InstancedMappingFieldsConnection,
"mappedSigningTemplateQuestionSetsByMappedSigningTemplateId": MappedSigningTemplateQuestionSetsConnection,
"mappingFields": MappingFieldsConnection
}
}
}
mappedSigningTemplateByAccountIdAndName
Response
Returns a MappedSigningTemplate
Example
Query
query mappedSigningTemplateByAccountIdAndName(
$accountId: UUID!,
$name: String!
) {
mappedSigningTemplateByAccountIdAndName(
accountId: $accountId,
name: $name
) {
nodeId
id
accountId
signingTemplateId
stepId
vendorQualificationId
name
templateCopyOn
templateUpdatedOn
deleted
locked
active
templateUri
qualificationStepType
accountByAccountId {
...AccountFragment
}
signingTemplateBySigningTemplateId {
...SigningTemplateFragment
}
stepByStepId {
...StepFragment
}
vendorQualificationByVendorQualificationId {
...VendorQualificationFragment
}
signingStepTypeByQualificationStepType {
...SigningStepTypeFragment
}
signingRolesByMappedSigningTemplateId {
...SigningRolesConnectionFragment
}
signingDocumentsByMappedSigningTemplateId {
...SigningDocumentsConnectionFragment
}
signingFieldsByMappedSigningTemplateId {
...SigningFieldsConnectionFragment
}
sentSigningDocumentsByMappedSigningTemplateId {
...SentSigningDocumentsConnectionFragment
}
instancedMappingFieldsByMappedSigningTemplateId {
...InstancedMappingFieldsConnectionFragment
}
mappedSigningTemplateQuestionSetsByMappedSigningTemplateId {
...MappedSigningTemplateQuestionSetsConnectionFragment
}
mappingFields {
...MappingFieldsConnectionFragment
}
}
}
Variables
{
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"name": "xyz789"
}
Response
{
"data": {
"mappedSigningTemplateByAccountIdAndName": {
"nodeId": "4",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"signingTemplateId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"stepId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"vendorQualificationId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"name": "abc123",
"templateCopyOn": Datetime,
"templateUpdatedOn": Datetime,
"deleted": false,
"locked": true,
"active": false,
"templateUri": "abc123",
"qualificationStepType": "xyz789",
"accountByAccountId": Account,
"signingTemplateBySigningTemplateId": SigningTemplate,
"stepByStepId": Step,
"vendorQualificationByVendorQualificationId": VendorQualification,
"signingStepTypeByQualificationStepType": SigningStepType,
"signingRolesByMappedSigningTemplateId": SigningRolesConnection,
"signingDocumentsByMappedSigningTemplateId": SigningDocumentsConnection,
"signingFieldsByMappedSigningTemplateId": SigningFieldsConnection,
"sentSigningDocumentsByMappedSigningTemplateId": SentSigningDocumentsConnection,
"instancedMappingFieldsByMappedSigningTemplateId": InstancedMappingFieldsConnection,
"mappedSigningTemplateQuestionSetsByMappedSigningTemplateId": MappedSigningTemplateQuestionSetsConnection,
"mappingFields": MappingFieldsConnection
}
}
}
mappedSigningTemplateById
Response
Returns a MappedSigningTemplate
Arguments
| Name | Description |
|---|---|
id - UUID!
|
Example
Query
query mappedSigningTemplateById($id: UUID!) {
mappedSigningTemplateById(id: $id) {
nodeId
id
accountId
signingTemplateId
stepId
vendorQualificationId
name
templateCopyOn
templateUpdatedOn
deleted
locked
active
templateUri
qualificationStepType
accountByAccountId {
...AccountFragment
}
signingTemplateBySigningTemplateId {
...SigningTemplateFragment
}
stepByStepId {
...StepFragment
}
vendorQualificationByVendorQualificationId {
...VendorQualificationFragment
}
signingStepTypeByQualificationStepType {
...SigningStepTypeFragment
}
signingRolesByMappedSigningTemplateId {
...SigningRolesConnectionFragment
}
signingDocumentsByMappedSigningTemplateId {
...SigningDocumentsConnectionFragment
}
signingFieldsByMappedSigningTemplateId {
...SigningFieldsConnectionFragment
}
sentSigningDocumentsByMappedSigningTemplateId {
...SentSigningDocumentsConnectionFragment
}
instancedMappingFieldsByMappedSigningTemplateId {
...InstancedMappingFieldsConnectionFragment
}
mappedSigningTemplateQuestionSetsByMappedSigningTemplateId {
...MappedSigningTemplateQuestionSetsConnectionFragment
}
mappingFields {
...MappingFieldsConnectionFragment
}
}
}
Variables
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
Response
{
"data": {
"mappedSigningTemplateById": {
"nodeId": 4,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"signingTemplateId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"stepId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"vendorQualificationId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"name": "xyz789",
"templateCopyOn": Datetime,
"templateUpdatedOn": Datetime,
"deleted": false,
"locked": false,
"active": false,
"templateUri": "xyz789",
"qualificationStepType": "abc123",
"accountByAccountId": Account,
"signingTemplateBySigningTemplateId": SigningTemplate,
"stepByStepId": Step,
"vendorQualificationByVendorQualificationId": VendorQualification,
"signingStepTypeByQualificationStepType": SigningStepType,
"signingRolesByMappedSigningTemplateId": SigningRolesConnection,
"signingDocumentsByMappedSigningTemplateId": SigningDocumentsConnection,
"signingFieldsByMappedSigningTemplateId": SigningFieldsConnection,
"sentSigningDocumentsByMappedSigningTemplateId": SentSigningDocumentsConnection,
"instancedMappingFieldsByMappedSigningTemplateId": InstancedMappingFieldsConnection,
"mappedSigningTemplateQuestionSetsByMappedSigningTemplateId": MappedSigningTemplateQuestionSetsConnection,
"mappingFields": MappingFieldsConnection
}
}
}
mappedSigningTemplateByStepId
Response
Returns a MappedSigningTemplate
Arguments
| Name | Description |
|---|---|
stepId - UUID!
|
Example
Query
query mappedSigningTemplateByStepId($stepId: UUID!) {
mappedSigningTemplateByStepId(stepId: $stepId) {
nodeId
id
accountId
signingTemplateId
stepId
vendorQualificationId
name
templateCopyOn
templateUpdatedOn
deleted
locked
active
templateUri
qualificationStepType
accountByAccountId {
...AccountFragment
}
signingTemplateBySigningTemplateId {
...SigningTemplateFragment
}
stepByStepId {
...StepFragment
}
vendorQualificationByVendorQualificationId {
...VendorQualificationFragment
}
signingStepTypeByQualificationStepType {
...SigningStepTypeFragment
}
signingRolesByMappedSigningTemplateId {
...SigningRolesConnectionFragment
}
signingDocumentsByMappedSigningTemplateId {
...SigningDocumentsConnectionFragment
}
signingFieldsByMappedSigningTemplateId {
...SigningFieldsConnectionFragment
}
sentSigningDocumentsByMappedSigningTemplateId {
...SentSigningDocumentsConnectionFragment
}
instancedMappingFieldsByMappedSigningTemplateId {
...InstancedMappingFieldsConnectionFragment
}
mappedSigningTemplateQuestionSetsByMappedSigningTemplateId {
...MappedSigningTemplateQuestionSetsConnectionFragment
}
mappingFields {
...MappingFieldsConnectionFragment
}
}
}
Variables
{
"stepId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
Response
{
"data": {
"mappedSigningTemplateByStepId": {
"nodeId": 4,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"signingTemplateId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"stepId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"vendorQualificationId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"name": "abc123",
"templateCopyOn": Datetime,
"templateUpdatedOn": Datetime,
"deleted": true,
"locked": false,
"active": true,
"templateUri": "xyz789",
"qualificationStepType": "abc123",
"accountByAccountId": Account,
"signingTemplateBySigningTemplateId": SigningTemplate,
"stepByStepId": Step,
"vendorQualificationByVendorQualificationId": VendorQualification,
"signingStepTypeByQualificationStepType": SigningStepType,
"signingRolesByMappedSigningTemplateId": SigningRolesConnection,
"signingDocumentsByMappedSigningTemplateId": SigningDocumentsConnection,
"signingFieldsByMappedSigningTemplateId": SigningFieldsConnection,
"sentSigningDocumentsByMappedSigningTemplateId": SentSigningDocumentsConnection,
"instancedMappingFieldsByMappedSigningTemplateId": InstancedMappingFieldsConnection,
"mappedSigningTemplateQuestionSetsByMappedSigningTemplateId": MappedSigningTemplateQuestionSetsConnection,
"mappingFields": MappingFieldsConnection
}
}
}
mappedSigningTemplateByVendorQualificationId
Response
Returns a MappedSigningTemplate
Arguments
| Name | Description |
|---|---|
vendorQualificationId - UUID!
|
Example
Query
query mappedSigningTemplateByVendorQualificationId($vendorQualificationId: UUID!) {
mappedSigningTemplateByVendorQualificationId(vendorQualificationId: $vendorQualificationId) {
nodeId
id
accountId
signingTemplateId
stepId
vendorQualificationId
name
templateCopyOn
templateUpdatedOn
deleted
locked
active
templateUri
qualificationStepType
accountByAccountId {
...AccountFragment
}
signingTemplateBySigningTemplateId {
...SigningTemplateFragment
}
stepByStepId {
...StepFragment
}
vendorQualificationByVendorQualificationId {
...VendorQualificationFragment
}
signingStepTypeByQualificationStepType {
...SigningStepTypeFragment
}
signingRolesByMappedSigningTemplateId {
...SigningRolesConnectionFragment
}
signingDocumentsByMappedSigningTemplateId {
...SigningDocumentsConnectionFragment
}
signingFieldsByMappedSigningTemplateId {
...SigningFieldsConnectionFragment
}
sentSigningDocumentsByMappedSigningTemplateId {
...SentSigningDocumentsConnectionFragment
}
instancedMappingFieldsByMappedSigningTemplateId {
...InstancedMappingFieldsConnectionFragment
}
mappedSigningTemplateQuestionSetsByMappedSigningTemplateId {
...MappedSigningTemplateQuestionSetsConnectionFragment
}
mappingFields {
...MappingFieldsConnectionFragment
}
}
}
Variables
{
"vendorQualificationId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
Response
{
"data": {
"mappedSigningTemplateByVendorQualificationId": {
"nodeId": "4",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"signingTemplateId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"stepId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"vendorQualificationId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"name": "abc123",
"templateCopyOn": Datetime,
"templateUpdatedOn": Datetime,
"deleted": false,
"locked": true,
"active": false,
"templateUri": "xyz789",
"qualificationStepType": "abc123",
"accountByAccountId": Account,
"signingTemplateBySigningTemplateId": SigningTemplate,
"stepByStepId": Step,
"vendorQualificationByVendorQualificationId": VendorQualification,
"signingStepTypeByQualificationStepType": SigningStepType,
"signingRolesByMappedSigningTemplateId": SigningRolesConnection,
"signingDocumentsByMappedSigningTemplateId": SigningDocumentsConnection,
"signingFieldsByMappedSigningTemplateId": SigningFieldsConnection,
"sentSigningDocumentsByMappedSigningTemplateId": SentSigningDocumentsConnection,
"instancedMappingFieldsByMappedSigningTemplateId": InstancedMappingFieldsConnection,
"mappedSigningTemplateQuestionSetsByMappedSigningTemplateId": MappedSigningTemplateQuestionSetsConnection,
"mappingFields": MappingFieldsConnection
}
}
}
mappedSigningTemplateQuestionSet
Description
Reads a single MappedSigningTemplateQuestionSet using its globally unique ID.
Response
Returns a MappedSigningTemplateQuestionSet
Arguments
| Name | Description |
|---|---|
nodeId - ID!
|
The globally unique ID to be used in selecting a single MappedSigningTemplateQuestionSet. |
Example
Query
query mappedSigningTemplateQuestionSet($nodeId: ID!) {
mappedSigningTemplateQuestionSet(nodeId: $nodeId) {
nodeId
id
onboardingQuestionSetId
mappedSigningTemplateId
onboardingQuestionSetByOnboardingQuestionSetId {
...OnboardingQuestionSetFragment
}
mappedSigningTemplateByMappedSigningTemplateId {
...MappedSigningTemplateFragment
}
}
}
Variables
{"nodeId": "4"}
Response
{
"data": {
"mappedSigningTemplateQuestionSet": {
"nodeId": "4",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"onboardingQuestionSetId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"mappedSigningTemplateId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"onboardingQuestionSetByOnboardingQuestionSetId": OnboardingQuestionSet,
"mappedSigningTemplateByMappedSigningTemplateId": MappedSigningTemplate
}
}
}
mappedSigningTemplateQuestionSetById
Response
Returns a MappedSigningTemplateQuestionSet
Arguments
| Name | Description |
|---|---|
id - UUID!
|
Example
Query
query mappedSigningTemplateQuestionSetById($id: UUID!) {
mappedSigningTemplateQuestionSetById(id: $id) {
nodeId
id
onboardingQuestionSetId
mappedSigningTemplateId
onboardingQuestionSetByOnboardingQuestionSetId {
...OnboardingQuestionSetFragment
}
mappedSigningTemplateByMappedSigningTemplateId {
...MappedSigningTemplateFragment
}
}
}
Variables
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
Response
{
"data": {
"mappedSigningTemplateQuestionSetById": {
"nodeId": "4",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"onboardingQuestionSetId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"mappedSigningTemplateId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"onboardingQuestionSetByOnboardingQuestionSetId": OnboardingQuestionSet,
"mappedSigningTemplateByMappedSigningTemplateId": MappedSigningTemplate
}
}
}
mappedSigningTemplateQuestionSetByOnboardingQuestionSetIdAndMappedSigningTemplateId
Response
Returns a MappedSigningTemplateQuestionSet
Example
Query
query mappedSigningTemplateQuestionSetByOnboardingQuestionSetIdAndMappedSigningTemplateId(
$onboardingQuestionSetId: UUID!,
$mappedSigningTemplateId: UUID!
) {
mappedSigningTemplateQuestionSetByOnboardingQuestionSetIdAndMappedSigningTemplateId(
onboardingQuestionSetId: $onboardingQuestionSetId,
mappedSigningTemplateId: $mappedSigningTemplateId
) {
nodeId
id
onboardingQuestionSetId
mappedSigningTemplateId
onboardingQuestionSetByOnboardingQuestionSetId {
...OnboardingQuestionSetFragment
}
mappedSigningTemplateByMappedSigningTemplateId {
...MappedSigningTemplateFragment
}
}
}
Variables
{
"onboardingQuestionSetId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"mappedSigningTemplateId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
Response
{
"data": {
"mappedSigningTemplateQuestionSetByOnboardingQuestionSetIdAndMappedSigningTemplateId": {
"nodeId": "4",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"onboardingQuestionSetId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"mappedSigningTemplateId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"onboardingQuestionSetByOnboardingQuestionSetId": OnboardingQuestionSet,
"mappedSigningTemplateByMappedSigningTemplateId": MappedSigningTemplate
}
}
}
mappingRole
Description
Reads a single MappingRole using its globally unique ID.
Response
Returns a MappingRole
Arguments
| Name | Description |
|---|---|
nodeId - ID!
|
The globally unique ID to be used in selecting a single MappingRole. |
Example
Query
query mappingRole($nodeId: ID!) {
mappingRole(nodeId: $nodeId) {
nodeId
id
description
signingRolesByMapTo {
...SigningRolesConnectionFragment
}
}
}
Variables
{"nodeId": "4"}
Response
{
"data": {
"mappingRole": {
"nodeId": 4,
"id": "xyz789",
"description": "xyz789",
"signingRolesByMapTo": SigningRolesConnection
}
}
}
mappingRoleById
Response
Returns a MappingRole
Arguments
| Name | Description |
|---|---|
id - String!
|
Example
Query
query mappingRoleById($id: String!) {
mappingRoleById(id: $id) {
nodeId
id
description
signingRolesByMapTo {
...SigningRolesConnectionFragment
}
}
}
Variables
{"id": "abc123"}
Response
{
"data": {
"mappingRoleById": {
"nodeId": 4,
"id": "abc123",
"description": "xyz789",
"signingRolesByMapTo": SigningRolesConnection
}
}
}
mappingRoleType
Description
Reads a single MappingRoleType using its globally unique ID.
Response
Returns a MappingRoleType
Arguments
| Name | Description |
|---|---|
nodeId - ID!
|
The globally unique ID to be used in selecting a single MappingRoleType. |
Example
Query
query mappingRoleType($nodeId: ID!) {
mappingRoleType(nodeId: $nodeId) {
nodeId
type
signingRolesByType {
...SigningRolesConnectionFragment
}
}
}
Variables
{"nodeId": 4}
Response
{
"data": {
"mappingRoleType": {
"nodeId": 4,
"type": "xyz789",
"signingRolesByType": SigningRolesConnection
}
}
}
mappingRoleTypeByType
Response
Returns a MappingRoleType
Arguments
| Name | Description |
|---|---|
type - String!
|
Example
Query
query mappingRoleTypeByType($type: String!) {
mappingRoleTypeByType(type: $type) {
nodeId
type
signingRolesByType {
...SigningRolesConnectionFragment
}
}
}
Variables
{"type": "abc123"}
Response
{
"data": {
"mappingRoleTypeByType": {
"nodeId": 4,
"type": "abc123",
"signingRolesByType": SigningRolesConnection
}
}
}
node
Description
Fetches an object given its globally unique ID.
nodeId
Description
The root query type must be a Node to work well with Relay 1 mutations. This just resolves to query.
Response
Returns an ID!
Example
Query
query nodeId {
nodeId
}
Response
{"data": {"nodeId": "4"}}
omnibusHolding
Description
Reads a single OmnibusHolding using its globally unique ID.
Response
Returns an OmnibusHolding
Arguments
| Name | Description |
|---|---|
nodeId - ID!
|
The globally unique ID to be used in selecting a single OmnibusHolding. |
Example
Query
query omnibusHolding($nodeId: ID!) {
omnibusHolding(nodeId: $nodeId) {
nodeId
id
securityId
holdingId
accountId
securityBySecurityId {
...SecurityFragment
}
holdingByHoldingId {
...HoldingFragment
}
accountByAccountId {
...AccountFragment
}
}
}
Variables
{"nodeId": "4"}
Response
{
"data": {
"omnibusHolding": {
"nodeId": "4",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"securityId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"holdingId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"securityBySecurityId": Security,
"holdingByHoldingId": Holding,
"accountByAccountId": Account
}
}
}
omnibusHoldingById
Response
Returns an OmnibusHolding
Arguments
| Name | Description |
|---|---|
id - UUID!
|
Example
Query
query omnibusHoldingById($id: UUID!) {
omnibusHoldingById(id: $id) {
nodeId
id
securityId
holdingId
accountId
securityBySecurityId {
...SecurityFragment
}
holdingByHoldingId {
...HoldingFragment
}
accountByAccountId {
...AccountFragment
}
}
}
Variables
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
Response
{
"data": {
"omnibusHoldingById": {
"nodeId": "4",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"securityId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"holdingId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"securityBySecurityId": Security,
"holdingByHoldingId": Holding,
"accountByAccountId": Account
}
}
}
omnibusHoldingBySecurityIdAndHoldingId
Response
Returns an OmnibusHolding
Example
Query
query omnibusHoldingBySecurityIdAndHoldingId(
$securityId: UUID!,
$holdingId: UUID!
) {
omnibusHoldingBySecurityIdAndHoldingId(
securityId: $securityId,
holdingId: $holdingId
) {
nodeId
id
securityId
holdingId
accountId
securityBySecurityId {
...SecurityFragment
}
holdingByHoldingId {
...HoldingFragment
}
accountByAccountId {
...AccountFragment
}
}
}
Variables
{
"securityId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"holdingId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
Response
{
"data": {
"omnibusHoldingBySecurityIdAndHoldingId": {
"nodeId": "4",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"securityId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"holdingId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"securityBySecurityId": Security,
"holdingByHoldingId": Holding,
"accountByAccountId": Account
}
}
}
omnibusInvestor
Description
Reads a single OmnibusInvestor using its globally unique ID.
Response
Returns an OmnibusInvestor
Arguments
| Name | Description |
|---|---|
nodeId - ID!
|
The globally unique ID to be used in selecting a single OmnibusInvestor. |
Example
Query
query omnibusInvestor($nodeId: ID!) {
omnibusInvestor(nodeId: $nodeId) {
nodeId
id
securityId
investorId
accountId
securityBySecurityId {
...SecurityFragment
}
accountByInvestorId {
...AccountFragment
}
accountByAccountId {
...AccountFragment
}
}
}
Variables
{"nodeId": 4}
Response
{
"data": {
"omnibusInvestor": {
"nodeId": "4",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"securityId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"investorId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"securityBySecurityId": Security,
"accountByInvestorId": Account,
"accountByAccountId": Account
}
}
}
omnibusInvestorById
Response
Returns an OmnibusInvestor
Arguments
| Name | Description |
|---|---|
id - UUID!
|
Example
Query
query omnibusInvestorById($id: UUID!) {
omnibusInvestorById(id: $id) {
nodeId
id
securityId
investorId
accountId
securityBySecurityId {
...SecurityFragment
}
accountByInvestorId {
...AccountFragment
}
accountByAccountId {
...AccountFragment
}
}
}
Variables
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
Response
{
"data": {
"omnibusInvestorById": {
"nodeId": "4",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"securityId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"investorId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"securityBySecurityId": Security,
"accountByInvestorId": Account,
"accountByAccountId": Account
}
}
}
omnibusInvestorBySecurityIdAndInvestorId
Response
Returns an OmnibusInvestor
Example
Query
query omnibusInvestorBySecurityIdAndInvestorId(
$securityId: UUID!,
$investorId: UUID!
) {
omnibusInvestorBySecurityIdAndInvestorId(
securityId: $securityId,
investorId: $investorId
) {
nodeId
id
securityId
investorId
accountId
securityBySecurityId {
...SecurityFragment
}
accountByInvestorId {
...AccountFragment
}
accountByAccountId {
...AccountFragment
}
}
}
Variables
{
"securityId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"investorId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
Response
{
"data": {
"omnibusInvestorBySecurityIdAndInvestorId": {
"nodeId": 4,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"securityId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"investorId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"securityBySecurityId": Security,
"accountByInvestorId": Account,
"accountByAccountId": Account
}
}
}
onboardingQuestion
Description
Reads a single OnboardingQuestion using its globally unique ID.
Response
Returns an OnboardingQuestion
Arguments
| Name | Description |
|---|---|
nodeId - ID!
|
The globally unique ID to be used in selecting a single OnboardingQuestion. |
Example
Query
query onboardingQuestion($nodeId: ID!) {
onboardingQuestion(nodeId: $nodeId) {
nodeId
id
accountId
type
name
description
errorMessage
accountByAccountId {
...AccountFragment
}
onboardingQuestionTypeByType {
...OnboardingQuestionTypeFragment
}
onboardingQuestionJoinsByOnboardingQuestionId {
...OnboardingQuestionJoinsConnectionFragment
}
instancedMappingFieldsByOnboardingQuestionId {
...InstancedMappingFieldsConnectionFragment
}
}
}
Variables
{"nodeId": 4}
Response
{
"data": {
"onboardingQuestion": {
"nodeId": "4",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"type": "xyz789",
"name": "abc123",
"description": "xyz789",
"errorMessage": "xyz789",
"accountByAccountId": Account,
"onboardingQuestionTypeByType": OnboardingQuestionType,
"onboardingQuestionJoinsByOnboardingQuestionId": OnboardingQuestionJoinsConnection,
"instancedMappingFieldsByOnboardingQuestionId": InstancedMappingFieldsConnection
}
}
}
onboardingQuestionByAccountIdAndName
Response
Returns an OnboardingQuestion
Example
Query
query onboardingQuestionByAccountIdAndName(
$accountId: UUID!,
$name: String!
) {
onboardingQuestionByAccountIdAndName(
accountId: $accountId,
name: $name
) {
nodeId
id
accountId
type
name
description
errorMessage
accountByAccountId {
...AccountFragment
}
onboardingQuestionTypeByType {
...OnboardingQuestionTypeFragment
}
onboardingQuestionJoinsByOnboardingQuestionId {
...OnboardingQuestionJoinsConnectionFragment
}
instancedMappingFieldsByOnboardingQuestionId {
...InstancedMappingFieldsConnectionFragment
}
}
}
Variables
{
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"name": "abc123"
}
Response
{
"data": {
"onboardingQuestionByAccountIdAndName": {
"nodeId": "4",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"type": "xyz789",
"name": "abc123",
"description": "abc123",
"errorMessage": "abc123",
"accountByAccountId": Account,
"onboardingQuestionTypeByType": OnboardingQuestionType,
"onboardingQuestionJoinsByOnboardingQuestionId": OnboardingQuestionJoinsConnection,
"instancedMappingFieldsByOnboardingQuestionId": InstancedMappingFieldsConnection
}
}
}
onboardingQuestionById
Response
Returns an OnboardingQuestion
Arguments
| Name | Description |
|---|---|
id - UUID!
|
Example
Query
query onboardingQuestionById($id: UUID!) {
onboardingQuestionById(id: $id) {
nodeId
id
accountId
type
name
description
errorMessage
accountByAccountId {
...AccountFragment
}
onboardingQuestionTypeByType {
...OnboardingQuestionTypeFragment
}
onboardingQuestionJoinsByOnboardingQuestionId {
...OnboardingQuestionJoinsConnectionFragment
}
instancedMappingFieldsByOnboardingQuestionId {
...InstancedMappingFieldsConnectionFragment
}
}
}
Variables
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
Response
{
"data": {
"onboardingQuestionById": {
"nodeId": "4",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"type": "xyz789",
"name": "xyz789",
"description": "xyz789",
"errorMessage": "abc123",
"accountByAccountId": Account,
"onboardingQuestionTypeByType": OnboardingQuestionType,
"onboardingQuestionJoinsByOnboardingQuestionId": OnboardingQuestionJoinsConnection,
"instancedMappingFieldsByOnboardingQuestionId": InstancedMappingFieldsConnection
}
}
}
onboardingQuestionJoin
Description
Reads a single OnboardingQuestionJoin using its globally unique ID.
Response
Returns an OnboardingQuestionJoin
Arguments
| Name | Description |
|---|---|
nodeId - ID!
|
The globally unique ID to be used in selecting a single OnboardingQuestionJoin. |
Example
Query
query onboardingQuestionJoin($nodeId: ID!) {
onboardingQuestionJoin(nodeId: $nodeId) {
nodeId
id
onboardingQuestionSetId
onboardingQuestionId
executeOrder
onboardingQuestionSetByOnboardingQuestionSetId {
...OnboardingQuestionSetFragment
}
onboardingQuestionByOnboardingQuestionId {
...OnboardingQuestionFragment
}
}
}
Variables
{"nodeId": "4"}
Response
{
"data": {
"onboardingQuestionJoin": {
"nodeId": 4,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"onboardingQuestionSetId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"onboardingQuestionId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"executeOrder": 987,
"onboardingQuestionSetByOnboardingQuestionSetId": OnboardingQuestionSet,
"onboardingQuestionByOnboardingQuestionId": OnboardingQuestion
}
}
}
onboardingQuestionJoinById
Response
Returns an OnboardingQuestionJoin
Arguments
| Name | Description |
|---|---|
id - UUID!
|
Example
Query
query onboardingQuestionJoinById($id: UUID!) {
onboardingQuestionJoinById(id: $id) {
nodeId
id
onboardingQuestionSetId
onboardingQuestionId
executeOrder
onboardingQuestionSetByOnboardingQuestionSetId {
...OnboardingQuestionSetFragment
}
onboardingQuestionByOnboardingQuestionId {
...OnboardingQuestionFragment
}
}
}
Variables
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
Response
{
"data": {
"onboardingQuestionJoinById": {
"nodeId": "4",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"onboardingQuestionSetId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"onboardingQuestionId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"executeOrder": 123,
"onboardingQuestionSetByOnboardingQuestionSetId": OnboardingQuestionSet,
"onboardingQuestionByOnboardingQuestionId": OnboardingQuestion
}
}
}
onboardingQuestionJoinByOnboardingQuestionSetIdAndOnboardingQuestionId
Response
Returns an OnboardingQuestionJoin
Example
Query
query onboardingQuestionJoinByOnboardingQuestionSetIdAndOnboardingQuestionId(
$onboardingQuestionSetId: UUID!,
$onboardingQuestionId: UUID!
) {
onboardingQuestionJoinByOnboardingQuestionSetIdAndOnboardingQuestionId(
onboardingQuestionSetId: $onboardingQuestionSetId,
onboardingQuestionId: $onboardingQuestionId
) {
nodeId
id
onboardingQuestionSetId
onboardingQuestionId
executeOrder
onboardingQuestionSetByOnboardingQuestionSetId {
...OnboardingQuestionSetFragment
}
onboardingQuestionByOnboardingQuestionId {
...OnboardingQuestionFragment
}
}
}
Variables
{
"onboardingQuestionSetId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"onboardingQuestionId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
Response
{
"data": {
"onboardingQuestionJoinByOnboardingQuestionSetIdAndOnboardingQuestionId": {
"nodeId": "4",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"onboardingQuestionSetId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"onboardingQuestionId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"executeOrder": 123,
"onboardingQuestionSetByOnboardingQuestionSetId": OnboardingQuestionSet,
"onboardingQuestionByOnboardingQuestionId": OnboardingQuestion
}
}
}
onboardingQuestionSet
Description
Reads a single OnboardingQuestionSet using its globally unique ID.
Response
Returns an OnboardingQuestionSet
Arguments
| Name | Description |
|---|---|
nodeId - ID!
|
The globally unique ID to be used in selecting a single OnboardingQuestionSet. |
Example
Query
query onboardingQuestionSet($nodeId: ID!) {
onboardingQuestionSet(nodeId: $nodeId) {
nodeId
id
accountId
name
locked
active
vendorQualificationId
accountByAccountId {
...AccountFragment
}
vendorQualificationByVendorQualificationId {
...VendorQualificationFragment
}
onboardingQuestionJoinsByOnboardingQuestionSetId {
...OnboardingQuestionJoinsConnectionFragment
}
mappedSigningTemplateQuestionSetsByOnboardingQuestionSetId {
...MappedSigningTemplateQuestionSetsConnectionFragment
}
}
}
Variables
{"nodeId": "4"}
Response
{
"data": {
"onboardingQuestionSet": {
"nodeId": "4",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"name": "xyz789",
"locked": false,
"active": true,
"vendorQualificationId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountByAccountId": Account,
"vendorQualificationByVendorQualificationId": VendorQualification,
"onboardingQuestionJoinsByOnboardingQuestionSetId": OnboardingQuestionJoinsConnection,
"mappedSigningTemplateQuestionSetsByOnboardingQuestionSetId": MappedSigningTemplateQuestionSetsConnection
}
}
}
onboardingQuestionSetByAccountIdAndName
Response
Returns an OnboardingQuestionSet
Example
Query
query onboardingQuestionSetByAccountIdAndName(
$accountId: UUID!,
$name: String!
) {
onboardingQuestionSetByAccountIdAndName(
accountId: $accountId,
name: $name
) {
nodeId
id
accountId
name
locked
active
vendorQualificationId
accountByAccountId {
...AccountFragment
}
vendorQualificationByVendorQualificationId {
...VendorQualificationFragment
}
onboardingQuestionJoinsByOnboardingQuestionSetId {
...OnboardingQuestionJoinsConnectionFragment
}
mappedSigningTemplateQuestionSetsByOnboardingQuestionSetId {
...MappedSigningTemplateQuestionSetsConnectionFragment
}
}
}
Variables
{
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"name": "abc123"
}
Response
{
"data": {
"onboardingQuestionSetByAccountIdAndName": {
"nodeId": "4",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"name": "abc123",
"locked": false,
"active": false,
"vendorQualificationId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountByAccountId": Account,
"vendorQualificationByVendorQualificationId": VendorQualification,
"onboardingQuestionJoinsByOnboardingQuestionSetId": OnboardingQuestionJoinsConnection,
"mappedSigningTemplateQuestionSetsByOnboardingQuestionSetId": MappedSigningTemplateQuestionSetsConnection
}
}
}
onboardingQuestionSetById
Response
Returns an OnboardingQuestionSet
Arguments
| Name | Description |
|---|---|
id - UUID!
|
Example
Query
query onboardingQuestionSetById($id: UUID!) {
onboardingQuestionSetById(id: $id) {
nodeId
id
accountId
name
locked
active
vendorQualificationId
accountByAccountId {
...AccountFragment
}
vendorQualificationByVendorQualificationId {
...VendorQualificationFragment
}
onboardingQuestionJoinsByOnboardingQuestionSetId {
...OnboardingQuestionJoinsConnectionFragment
}
mappedSigningTemplateQuestionSetsByOnboardingQuestionSetId {
...MappedSigningTemplateQuestionSetsConnectionFragment
}
}
}
Variables
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
Response
{
"data": {
"onboardingQuestionSetById": {
"nodeId": "4",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"name": "abc123",
"locked": true,
"active": false,
"vendorQualificationId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountByAccountId": Account,
"vendorQualificationByVendorQualificationId": VendorQualification,
"onboardingQuestionJoinsByOnboardingQuestionSetId": OnboardingQuestionJoinsConnection,
"mappedSigningTemplateQuestionSetsByOnboardingQuestionSetId": MappedSigningTemplateQuestionSetsConnection
}
}
}
onboardingQuestionSetByVendorQualificationId
Response
Returns an OnboardingQuestionSet
Arguments
| Name | Description |
|---|---|
vendorQualificationId - UUID!
|
Example
Query
query onboardingQuestionSetByVendorQualificationId($vendorQualificationId: UUID!) {
onboardingQuestionSetByVendorQualificationId(vendorQualificationId: $vendorQualificationId) {
nodeId
id
accountId
name
locked
active
vendorQualificationId
accountByAccountId {
...AccountFragment
}
vendorQualificationByVendorQualificationId {
...VendorQualificationFragment
}
onboardingQuestionJoinsByOnboardingQuestionSetId {
...OnboardingQuestionJoinsConnectionFragment
}
mappedSigningTemplateQuestionSetsByOnboardingQuestionSetId {
...MappedSigningTemplateQuestionSetsConnectionFragment
}
}
}
Variables
{
"vendorQualificationId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
Response
{
"data": {
"onboardingQuestionSetByVendorQualificationId": {
"nodeId": "4",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"name": "abc123",
"locked": true,
"active": false,
"vendorQualificationId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountByAccountId": Account,
"vendorQualificationByVendorQualificationId": VendorQualification,
"onboardingQuestionJoinsByOnboardingQuestionSetId": OnboardingQuestionJoinsConnection,
"mappedSigningTemplateQuestionSetsByOnboardingQuestionSetId": MappedSigningTemplateQuestionSetsConnection
}
}
}
onboardingQuestionType
Description
Reads a single OnboardingQuestionType using its globally unique ID.
Response
Returns an OnboardingQuestionType
Arguments
| Name | Description |
|---|---|
nodeId - ID!
|
The globally unique ID to be used in selecting a single OnboardingQuestionType. |
Example
Query
query onboardingQuestionType($nodeId: ID!) {
onboardingQuestionType(nodeId: $nodeId) {
nodeId
type
regex
internalType
onboardingQuestionsByType {
...OnboardingQuestionsConnectionFragment
}
}
}
Variables
{"nodeId": "4"}
Response
{
"data": {
"onboardingQuestionType": {
"nodeId": "4",
"type": "abc123",
"regex": "xyz789",
"internalType": "xyz789",
"onboardingQuestionsByType": OnboardingQuestionsConnection
}
}
}
onboardingQuestionTypeByType
Response
Returns an OnboardingQuestionType
Arguments
| Name | Description |
|---|---|
type - String!
|
Example
Query
query onboardingQuestionTypeByType($type: String!) {
onboardingQuestionTypeByType(type: $type) {
nodeId
type
regex
internalType
onboardingQuestionsByType {
...OnboardingQuestionsConnectionFragment
}
}
}
Variables
{"type": "xyz789"}
Response
{
"data": {
"onboardingQuestionTypeByType": {
"nodeId": "4",
"type": "xyz789",
"regex": "xyz789",
"internalType": "abc123",
"onboardingQuestionsByType": OnboardingQuestionsConnection
}
}
}
partyRole
Description
Reads a single PartyRole using its globally unique ID.
Response
Returns a PartyRole
Arguments
| Name | Description |
|---|---|
nodeId - ID!
|
The globally unique ID to be used in selecting a single PartyRole. |
Example
Query
query partyRole($nodeId: ID!) {
partyRole(nodeId: $nodeId) {
nodeId
role
customerPartiesByRole {
...CustomerPartiesConnectionFragment
}
}
}
Variables
{"nodeId": "4"}
Response
{
"data": {
"partyRole": {
"nodeId": 4,
"role": "abc123",
"customerPartiesByRole": CustomerPartiesConnection
}
}
}
partyRoleByRole
Example
Query
query partyRoleByRole($role: String!) {
partyRoleByRole(role: $role) {
nodeId
role
customerPartiesByRole {
...CustomerPartiesConnectionFragment
}
}
}
Variables
{"role": "xyz789"}
Response
{
"data": {
"partyRoleByRole": {
"nodeId": "4",
"role": "abc123",
"customerPartiesByRole": CustomerPartiesConnection
}
}
}
paymentAccount
Description
Reads a single PaymentAccount using its globally unique ID.
Response
Returns a PaymentAccount
Arguments
| Name | Description |
|---|---|
nodeId - ID!
|
The globally unique ID to be used in selecting a single PaymentAccount. |
Example
Query
query paymentAccount($nodeId: ID!) {
paymentAccount(nodeId: $nodeId) {
nodeId
id
integrationId
accountId
syncedOn
integrationByIntegrationId {
...IntegrationFragment
}
accountByAccountId {
...AccountFragment
}
paymentIssuersByPaymentAccountId {
...PaymentIssuersConnectionFragment
}
}
}
Variables
{"nodeId": "4"}
Response
{
"data": {
"paymentAccount": {
"nodeId": 4,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"integrationId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"syncedOn": Datetime,
"integrationByIntegrationId": Integration,
"accountByAccountId": Account,
"paymentIssuersByPaymentAccountId": PaymentIssuersConnection
}
}
}
paymentAccountById
Response
Returns a PaymentAccount
Arguments
| Name | Description |
|---|---|
id - UUID!
|
Example
Query
query paymentAccountById($id: UUID!) {
paymentAccountById(id: $id) {
nodeId
id
integrationId
accountId
syncedOn
integrationByIntegrationId {
...IntegrationFragment
}
accountByAccountId {
...AccountFragment
}
paymentIssuersByPaymentAccountId {
...PaymentIssuersConnectionFragment
}
}
}
Variables
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
Response
{
"data": {
"paymentAccountById": {
"nodeId": 4,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"integrationId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"syncedOn": Datetime,
"integrationByIntegrationId": Integration,
"accountByAccountId": Account,
"paymentIssuersByPaymentAccountId": PaymentIssuersConnection
}
}
}
paymentInstrument
Description
Reads a single PaymentInstrument using its globally unique ID.
Response
Returns a PaymentInstrument
Arguments
| Name | Description |
|---|---|
nodeId - ID!
|
The globally unique ID to be used in selecting a single PaymentInstrument. |
Example
Query
query paymentInstrument($nodeId: ID!) {
paymentInstrument(nodeId: $nodeId) {
nodeId
id
paymentIssuerId
roundId
stepId
name
stepType
vendorQualificationId
createdOn
paymentIssuerByPaymentIssuerId {
...PaymentIssuerFragment
}
roundByRoundId {
...RoundFragment
}
stepByStepId {
...StepFragment
}
paymentStepTypeByStepType {
...PaymentStepTypeFragment
}
vendorQualificationByVendorQualificationId {
...VendorQualificationFragment
}
}
}
Variables
{"nodeId": 4}
Response
{
"data": {
"paymentInstrument": {
"nodeId": 4,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"paymentIssuerId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"roundId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"stepId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"name": "xyz789",
"stepType": "xyz789",
"vendorQualificationId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"createdOn": Datetime,
"paymentIssuerByPaymentIssuerId": PaymentIssuer,
"roundByRoundId": Round,
"stepByStepId": Step,
"paymentStepTypeByStepType": PaymentStepType,
"vendorQualificationByVendorQualificationId": VendorQualification
}
}
}
paymentInstrumentById
Response
Returns a PaymentInstrument
Arguments
| Name | Description |
|---|---|
id - UUID!
|
Example
Query
query paymentInstrumentById($id: UUID!) {
paymentInstrumentById(id: $id) {
nodeId
id
paymentIssuerId
roundId
stepId
name
stepType
vendorQualificationId
createdOn
paymentIssuerByPaymentIssuerId {
...PaymentIssuerFragment
}
roundByRoundId {
...RoundFragment
}
stepByStepId {
...StepFragment
}
paymentStepTypeByStepType {
...PaymentStepTypeFragment
}
vendorQualificationByVendorQualificationId {
...VendorQualificationFragment
}
}
}
Variables
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
Response
{
"data": {
"paymentInstrumentById": {
"nodeId": 4,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"paymentIssuerId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"roundId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"stepId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"name": "abc123",
"stepType": "abc123",
"vendorQualificationId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"createdOn": Datetime,
"paymentIssuerByPaymentIssuerId": PaymentIssuer,
"roundByRoundId": Round,
"stepByStepId": Step,
"paymentStepTypeByStepType": PaymentStepType,
"vendorQualificationByVendorQualificationId": VendorQualification
}
}
}
paymentIssuer
Description
Reads a single PaymentIssuer using its globally unique ID.
Response
Returns a PaymentIssuer
Arguments
| Name | Description |
|---|---|
nodeId - ID!
|
The globally unique ID to be used in selecting a single PaymentIssuer. |
Example
Query
query paymentIssuer($nodeId: ID!) {
paymentIssuer(nodeId: $nodeId) {
nodeId
id
issuerId
accountId
paymentAccountId
stepId
name
email
createdOn
archive
stepType
accountByIssuerId {
...AccountFragment
}
accountByAccountId {
...AccountFragment
}
paymentAccountByPaymentAccountId {
...PaymentAccountFragment
}
stepByStepId {
...StepFragment
}
paymentStepTypeByStepType {
...PaymentStepTypeFragment
}
paymentInstrumentsByPaymentIssuerId {
...PaymentInstrumentsConnectionFragment
}
}
}
Variables
{"nodeId": 4}
Response
{
"data": {
"paymentIssuer": {
"nodeId": "4",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"issuerId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"paymentAccountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"stepId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"name": "xyz789",
"email": "xyz789",
"createdOn": Datetime,
"archive": true,
"stepType": "xyz789",
"accountByIssuerId": Account,
"accountByAccountId": Account,
"paymentAccountByPaymentAccountId": PaymentAccount,
"stepByStepId": Step,
"paymentStepTypeByStepType": PaymentStepType,
"paymentInstrumentsByPaymentIssuerId": PaymentInstrumentsConnection
}
}
}
paymentIssuerById
Response
Returns a PaymentIssuer
Arguments
| Name | Description |
|---|---|
id - UUID!
|
Example
Query
query paymentIssuerById($id: UUID!) {
paymentIssuerById(id: $id) {
nodeId
id
issuerId
accountId
paymentAccountId
stepId
name
email
createdOn
archive
stepType
accountByIssuerId {
...AccountFragment
}
accountByAccountId {
...AccountFragment
}
paymentAccountByPaymentAccountId {
...PaymentAccountFragment
}
stepByStepId {
...StepFragment
}
paymentStepTypeByStepType {
...PaymentStepTypeFragment
}
paymentInstrumentsByPaymentIssuerId {
...PaymentInstrumentsConnectionFragment
}
}
}
Variables
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
Response
{
"data": {
"paymentIssuerById": {
"nodeId": 4,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"issuerId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"paymentAccountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"stepId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"name": "xyz789",
"email": "abc123",
"createdOn": Datetime,
"archive": false,
"stepType": "xyz789",
"accountByIssuerId": Account,
"accountByAccountId": Account,
"paymentAccountByPaymentAccountId": PaymentAccount,
"stepByStepId": Step,
"paymentStepTypeByStepType": PaymentStepType,
"paymentInstrumentsByPaymentIssuerId": PaymentInstrumentsConnection
}
}
}
paymentIssuerByIssuerIdAndPaymentAccountId
Response
Returns a PaymentIssuer
Example
Query
query paymentIssuerByIssuerIdAndPaymentAccountId(
$issuerId: UUID!,
$paymentAccountId: UUID!
) {
paymentIssuerByIssuerIdAndPaymentAccountId(
issuerId: $issuerId,
paymentAccountId: $paymentAccountId
) {
nodeId
id
issuerId
accountId
paymentAccountId
stepId
name
email
createdOn
archive
stepType
accountByIssuerId {
...AccountFragment
}
accountByAccountId {
...AccountFragment
}
paymentAccountByPaymentAccountId {
...PaymentAccountFragment
}
stepByStepId {
...StepFragment
}
paymentStepTypeByStepType {
...PaymentStepTypeFragment
}
paymentInstrumentsByPaymentIssuerId {
...PaymentInstrumentsConnectionFragment
}
}
}
Variables
{
"issuerId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"paymentAccountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
Response
{
"data": {
"paymentIssuerByIssuerIdAndPaymentAccountId": {
"nodeId": "4",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"issuerId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"paymentAccountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"stepId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"name": "xyz789",
"email": "abc123",
"createdOn": Datetime,
"archive": false,
"stepType": "xyz789",
"accountByIssuerId": Account,
"accountByAccountId": Account,
"paymentAccountByPaymentAccountId": PaymentAccount,
"stepByStepId": Step,
"paymentStepTypeByStepType": PaymentStepType,
"paymentInstrumentsByPaymentIssuerId": PaymentInstrumentsConnection
}
}
}
paymentMethod
Description
Reads a single PaymentMethod using its globally unique ID.
Response
Returns a PaymentMethod
Arguments
| Name | Description |
|---|---|
nodeId - ID!
|
The globally unique ID to be used in selecting a single PaymentMethod. |
Example
Query
query paymentMethod($nodeId: ID!) {
paymentMethod(nodeId: $nodeId) {
nodeId
id
accountId
integrationId
name
hash
unlockHash
encryptedRecordId
type
accountByAccountId {
...AccountFragment
}
integrationByIntegrationId {
...IntegrationFragment
}
paymentMethodTypeByType {
...PaymentMethodTypeFragment
}
}
}
Variables
{"nodeId": 4}
Response
{
"data": {
"paymentMethod": {
"nodeId": 4,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"integrationId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"name": "abc123",
"hash": "xyz789",
"unlockHash": "abc123",
"encryptedRecordId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"type": "abc123",
"accountByAccountId": Account,
"integrationByIntegrationId": Integration,
"paymentMethodTypeByType": PaymentMethodType
}
}
}
paymentMethodByAccountIdAndName
Response
Returns a PaymentMethod
Example
Query
query paymentMethodByAccountIdAndName(
$accountId: UUID!,
$name: String!
) {
paymentMethodByAccountIdAndName(
accountId: $accountId,
name: $name
) {
nodeId
id
accountId
integrationId
name
hash
unlockHash
encryptedRecordId
type
accountByAccountId {
...AccountFragment
}
integrationByIntegrationId {
...IntegrationFragment
}
paymentMethodTypeByType {
...PaymentMethodTypeFragment
}
}
}
Variables
{
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"name": "xyz789"
}
Response
{
"data": {
"paymentMethodByAccountIdAndName": {
"nodeId": 4,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"integrationId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"name": "xyz789",
"hash": "xyz789",
"unlockHash": "abc123",
"encryptedRecordId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"type": "abc123",
"accountByAccountId": Account,
"integrationByIntegrationId": Integration,
"paymentMethodTypeByType": PaymentMethodType
}
}
}
paymentMethodByEncryptedRecordId
Response
Returns a PaymentMethod
Arguments
| Name | Description |
|---|---|
encryptedRecordId - UUID!
|
Example
Query
query paymentMethodByEncryptedRecordId($encryptedRecordId: UUID!) {
paymentMethodByEncryptedRecordId(encryptedRecordId: $encryptedRecordId) {
nodeId
id
accountId
integrationId
name
hash
unlockHash
encryptedRecordId
type
accountByAccountId {
...AccountFragment
}
integrationByIntegrationId {
...IntegrationFragment
}
paymentMethodTypeByType {
...PaymentMethodTypeFragment
}
}
}
Variables
{
"encryptedRecordId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
Response
{
"data": {
"paymentMethodByEncryptedRecordId": {
"nodeId": 4,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"integrationId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"name": "xyz789",
"hash": "xyz789",
"unlockHash": "xyz789",
"encryptedRecordId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"type": "xyz789",
"accountByAccountId": Account,
"integrationByIntegrationId": Integration,
"paymentMethodTypeByType": PaymentMethodType
}
}
}
paymentMethodById
Response
Returns a PaymentMethod
Arguments
| Name | Description |
|---|---|
id - UUID!
|
Example
Query
query paymentMethodById($id: UUID!) {
paymentMethodById(id: $id) {
nodeId
id
accountId
integrationId
name
hash
unlockHash
encryptedRecordId
type
accountByAccountId {
...AccountFragment
}
integrationByIntegrationId {
...IntegrationFragment
}
paymentMethodTypeByType {
...PaymentMethodTypeFragment
}
}
}
Variables
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
Response
{
"data": {
"paymentMethodById": {
"nodeId": 4,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"integrationId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"name": "xyz789",
"hash": "abc123",
"unlockHash": "xyz789",
"encryptedRecordId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"type": "abc123",
"accountByAccountId": Account,
"integrationByIntegrationId": Integration,
"paymentMethodTypeByType": PaymentMethodType
}
}
}
paymentMethodType
Description
Reads a single PaymentMethodType using its globally unique ID.
Response
Returns a PaymentMethodType
Arguments
| Name | Description |
|---|---|
nodeId - ID!
|
The globally unique ID to be used in selecting a single PaymentMethodType. |
Example
Query
query paymentMethodType($nodeId: ID!) {
paymentMethodType(nodeId: $nodeId) {
nodeId
type
paymentMethodsByType {
...PaymentMethodsConnectionFragment
}
}
}
Variables
{"nodeId": "4"}
Response
{
"data": {
"paymentMethodType": {
"nodeId": 4,
"type": "abc123",
"paymentMethodsByType": PaymentMethodsConnection
}
}
}
paymentMethodTypeByType
Response
Returns a PaymentMethodType
Arguments
| Name | Description |
|---|---|
type - String!
|
Example
Query
query paymentMethodTypeByType($type: String!) {
paymentMethodTypeByType(type: $type) {
nodeId
type
paymentMethodsByType {
...PaymentMethodsConnectionFragment
}
}
}
Variables
{"type": "xyz789"}
Response
{
"data": {
"paymentMethodTypeByType": {
"nodeId": 4,
"type": "xyz789",
"paymentMethodsByType": PaymentMethodsConnection
}
}
}
paymentStepType
Description
Reads a single PaymentStepType using its globally unique ID.
Response
Returns a PaymentStepType
Arguments
| Name | Description |
|---|---|
nodeId - ID!
|
The globally unique ID to be used in selecting a single PaymentStepType. |
Example
Query
query paymentStepType($nodeId: ID!) {
paymentStepType(nodeId: $nodeId) {
nodeId
type
paymentIssuersByStepType {
...PaymentIssuersConnectionFragment
}
paymentInstrumentsByStepType {
...PaymentInstrumentsConnectionFragment
}
}
}
Variables
{"nodeId": 4}
Response
{
"data": {
"paymentStepType": {
"nodeId": "4",
"type": "xyz789",
"paymentIssuersByStepType": PaymentIssuersConnection,
"paymentInstrumentsByStepType": PaymentInstrumentsConnection
}
}
}
paymentStepTypeByType
Response
Returns a PaymentStepType
Arguments
| Name | Description |
|---|---|
type - String!
|
Example
Query
query paymentStepTypeByType($type: String!) {
paymentStepTypeByType(type: $type) {
nodeId
type
paymentIssuersByStepType {
...PaymentIssuersConnectionFragment
}
paymentInstrumentsByStepType {
...PaymentInstrumentsConnectionFragment
}
}
}
Variables
{"type": "abc123"}
Response
{
"data": {
"paymentStepTypeByType": {
"nodeId": "4",
"type": "xyz789",
"paymentIssuersByStepType": PaymentIssuersConnection,
"paymentInstrumentsByStepType": PaymentInstrumentsConnection
}
}
}
phoneNumberType
Description
Reads a single PhoneNumberType using its globally unique ID.
Response
Returns a PhoneNumberType
Arguments
| Name | Description |
|---|---|
nodeId - ID!
|
The globally unique ID to be used in selecting a single PhoneNumberType. |
Example
Query
query phoneNumberType($nodeId: ID!) {
phoneNumberType(nodeId: $nodeId) {
nodeId
type
accountPhoneNumbersByType {
...AccountPhoneNumbersConnectionFragment
}
}
}
Variables
{"nodeId": "4"}
Response
{
"data": {
"phoneNumberType": {
"nodeId": 4,
"type": "abc123",
"accountPhoneNumbersByType": AccountPhoneNumbersConnection
}
}
}
phoneNumberTypeByType
Response
Returns a PhoneNumberType
Arguments
| Name | Description |
|---|---|
type - String!
|
Example
Query
query phoneNumberTypeByType($type: String!) {
phoneNumberTypeByType(type: $type) {
nodeId
type
accountPhoneNumbersByType {
...AccountPhoneNumbersConnectionFragment
}
}
}
Variables
{"type": "abc123"}
Response
{
"data": {
"phoneNumberTypeByType": {
"nodeId": 4,
"type": "abc123",
"accountPhoneNumbersByType": AccountPhoneNumbersConnection
}
}
}
qualificationStatus
Description
Reads a single QualificationStatus using its globally unique ID.
Response
Returns a QualificationStatus
Arguments
| Name | Description |
|---|---|
nodeId - ID!
|
The globally unique ID to be used in selecting a single QualificationStatus. |
Example
Query
query qualificationStatus($nodeId: ID!) {
qualificationStatus(nodeId: $nodeId) {
nodeId
status
}
}
Variables
{"nodeId": 4}
Response
{
"data": {
"qualificationStatus": {
"nodeId": "4",
"status": "xyz789"
}
}
}
qualificationStatusByStatus
Response
Returns a QualificationStatus
Arguments
| Name | Description |
|---|---|
status - String!
|
Example
Query
query qualificationStatusByStatus($status: String!) {
qualificationStatusByStatus(status: $status) {
nodeId
status
}
}
Variables
{"status": "xyz789"}
Response
{
"data": {
"qualificationStatusByStatus": {
"nodeId": "4",
"status": "abc123"
}
}
}
query
Description
Exposes the root query type nested one level down. This is helpful for Relay 1 which can only query top level fields if they are in a particular form.
Response
Returns a Query!
Example
Query
query query {
query {
query {
...QueryFragment
}
nodeId
node {
...NodeFragment
}
allAccountAddresses {
...AccountAddressesConnectionFragment
}
allAccountDocuments {
...AccountDocumentsConnectionFragment
}
allAccountIntegrations {
...AccountIntegrationsConnectionFragment
}
allAccountPhoneNumbers {
...AccountPhoneNumbersConnectionFragment
}
allAccountRegDStatuses {
...AccountRegDStatusesConnectionFragment
}
allAccountRestrictions {
...AccountRestrictionsConnectionFragment
}
allAccountTaxInformations {
...AccountTaxInformationsConnectionFragment
}
allAuxAccounts {
...AuxAccountsConnectionFragment
}
allAccountingTypes {
...AccountingTypesConnectionFragment
}
allAccounts {
...AccountsConnectionFragment
}
allAccountsBlockchainAddresses {
...AccountsBlockchainAddressesConnectionFragment
}
allActiveUsers {
...ActiveUsersConnectionFragment
}
allAddressTypes {
...AddressTypesConnectionFragment
}
allAddresses {
...AddressesConnectionFragment
}
allAllocationAnnotations {
...AllocationAnnotationsConnectionFragment
}
allAllocationArchives {
...AllocationArchivesConnectionFragment
}
allAllocationEmailPreferences {
...AllocationEmailPreferencesConnectionFragment
}
allAllocationOfferingLinks {
...AllocationOfferingLinksConnectionFragment
}
allAllocationQualifications {
...AllocationQualificationsConnectionFragment
}
allAllocations {
...AllocationsConnectionFragment
}
allAllocationsVestingSchedules {
...AllocationsVestingSchedulesConnectionFragment
}
allAssetAnnotations {
...AssetAnnotationsConnectionFragment
}
allAssetArchives {
...AssetArchivesConnectionFragment
}
allAssetStatuses {
...AssetStatusesConnectionFragment
}
allAssetTypes {
...AssetTypesConnectionFragment
}
allAssets {
...AssetsConnectionFragment
}
allAtsTags {
...AtsTagsConnectionFragment
}
allBlockchainAddressGroups {
...BlockchainAddressGroupsConnectionFragment
}
allBlockchainAddressSources {
...BlockchainAddressSourcesConnectionFragment
}
allBlockchainAddresses {
...BlockchainAddressesConnectionFragment
}
allBlockchainRegistrations {
...BlockchainRegistrationsConnectionFragment
}
allBrokerAllocations {
...BrokerAllocationsConnectionFragment
}
allCapTables {
...CapTablesConnectionFragment
}
allCapitalDeployments {
...CapitalDeploymentsConnectionFragment
}
allChains {
...ChainsConnectionFragment
}
allCompanies {
...CompaniesConnectionFragment
}
allContractStatuses {
...ContractStatusesConnectionFragment
}
allContracts {
...ContractsConnectionFragment
}
allCountries {
...CountriesConnectionFragment
}
allCountryProvinces {
...CountryProvincesConnectionFragment
}
allCurrencies {
...CurrenciesConnectionFragment
}
allCurrencyTypes {
...CurrencyTypesConnectionFragment
}
allCustomerAddresses {
...CustomerAddressesConnectionFragment
}
allCustomerParties {
...CustomerPartiesConnectionFragment
}
allCustomerPartyAddresses {
...CustomerPartyAddressesConnectionFragment
}
allCustomers {
...CustomersConnectionFragment
}
allDefaultMappingFields {
...DefaultMappingFieldsConnectionFragment
}
allDistributionAnnotations {
...DistributionAnnotationsConnectionFragment
}
allDistributionCustomFields {
...DistributionCustomFieldsConnectionFragment
}
allDistributionPaymentStatuses {
...DistributionPaymentStatusesConnectionFragment
}
allDistributionPayments {
...DistributionPaymentsConnectionFragment
}
allDistributionPrices {
...DistributionPricesConnectionFragment
}
allDistributionQualifications {
...DistributionQualificationsConnectionFragment
}
allDistributionStatuses {
...DistributionStatusesConnectionFragment
}
allDistributions {
...DistributionsConnectionFragment
}
allDocumentSharings {
...DocumentSharingsConnectionFragment
}
allDocumentSharingAllowedShares {
...DocumentSharingAllowedSharesConnectionFragment
}
allDocumentSharingRoles {
...DocumentSharingRolesConnectionFragment
}
allDocumentStatuses {
...DocumentStatusesConnectionFragment
}
allDocumentTypes {
...DocumentTypesConnectionFragment
}
allDocuments {
...DocumentsConnectionFragment
}
allEmailTemplateTos {
...EmailTemplateTosConnectionFragment
}
allEmails {
...EmailsConnectionFragment
}
allFullHoldings {
...FullHoldingsConnectionFragment
}
allHoldingBlockchainAddressStatuses {
...HoldingBlockchainAddressStatusesConnectionFragment
}
allHoldingBlockchainAddresses {
...HoldingBlockchainAddressesConnectionFragment
}
allHoldingDocuments {
...HoldingDocumentsConnectionFragment
}
allHoldings {
...HoldingsConnectionFragment
}
allIdempotents {
...IdempotentsConnectionFragment
}
allIdempotentTypes {
...IdempotentTypesConnectionFragment
}
allInstancedAccountInformations {
...InstancedAccountInformationsConnectionFragment
}
allInstancedMappingFields {
...InstancedMappingFieldsConnectionFragment
}
allRounds {
...RoundsConnectionFragment
}
allIntegrationPartners {
...IntegrationPartnersConnectionFragment
}
allIntegrationTypes {
...IntegrationTypesConnectionFragment
}
allIntegrations {
...IntegrationsConnectionFragment
}
allInvestorAccountTypes {
...InvestorAccountTypesConnectionFragment
}
allInvitationStatuses {
...InvitationStatusesConnectionFragment
}
allIssuanceEvents {
...IssuanceEventsConnectionFragment
}
allLedgers {
...LedgersConnectionFragment
}
allManagedAccounts {
...ManagedAccountsConnectionFragment
}
allMappedSigningTemplateQuestionSets {
...MappedSigningTemplateQuestionSetsConnectionFragment
}
allMappedSigningTemplates {
...MappedSigningTemplatesConnectionFragment
}
allMappingRoleTypes {
...MappingRoleTypesConnectionFragment
}
allMappingRoles {
...MappingRolesConnectionFragment
}
allOmnibusHoldings {
...OmnibusHoldingsConnectionFragment
}
allOmnibusInvestors {
...OmnibusInvestorsConnectionFragment
}
allOnboardingQuestionJoins {
...OnboardingQuestionJoinsConnectionFragment
}
allOnboardingQuestionSets {
...OnboardingQuestionSetsConnectionFragment
}
allOnboardingQuestionTypes {
...OnboardingQuestionTypesConnectionFragment
}
allOnboardingQuestions {
...OnboardingQuestionsConnectionFragment
}
allParties {
...PartiesConnectionFragment
}
allPartyAddresses {
...PartyAddressesConnectionFragment
}
allPartyRoles {
...PartyRolesConnectionFragment
}
allPaymentAccounts {
...PaymentAccountsConnectionFragment
}
allPaymentInstruments {
...PaymentInstrumentsConnectionFragment
}
allPaymentIssuers {
...PaymentIssuersConnectionFragment
}
allPaymentMethodTypes {
...PaymentMethodTypesConnectionFragment
}
allPaymentMethods {
...PaymentMethodsConnectionFragment
}
allPaymentStepTypes {
...PaymentStepTypesConnectionFragment
}
allPhoneNumberTypes {
...PhoneNumberTypesConnectionFragment
}
allQualificationStatuses {
...QualificationStatusesConnectionFragment
}
allRegistrationMethods {
...RegistrationMethodsConnectionFragment
}
allRegistrationStatuses {
...RegistrationStatusesConnectionFragment
}
allRequestTypes {
...RequestTypesConnectionFragment
}
allRequests {
...RequestsConnectionFragment
}
allRestrictionCategories {
...RestrictionCategoriesConnectionFragment
}
allRestrictionReasons {
...RestrictionReasonsConnectionFragment
}
allAuxRoles {
...AuxRolesConnectionFragment
}
allSecurities {
...SecuritiesConnectionFragment
}
allSecurityDocuments {
...SecurityDocumentsConnectionFragment
}
allSecurityListings {
...SecurityListingsConnectionFragment
}
allSentSigningDocumentStatuses {
...SentSigningDocumentStatusesConnectionFragment
}
allSentSigningDocuments {
...SentSigningDocumentsConnectionFragment
}
allSigningAccounts {
...SigningAccountsConnectionFragment
}
allSigningDocuments {
...SigningDocumentsConnectionFragment
}
allSigningFields {
...SigningFieldsConnectionFragment
}
allSigningRoles {
...SigningRolesConnectionFragment
}
allSigningStepTypes {
...SigningStepTypesConnectionFragment
}
allSigningTemplates {
...SigningTemplatesConnectionFragment
}
allStagedBalanceTransfers {
...StagedBalanceTransfersConnectionFragment
}
allStagedTransferAtsTags {
...StagedTransferAtsTagsConnectionFragment
}
allStagedTransferStatuses {
...StagedTransferStatusesConnectionFragment
}
allStagedTransfers {
...StagedTransfersConnectionFragment
}
allStepStatuses {
...StepStatusesConnectionFragment
}
allStepTypes {
...StepTypesConnectionFragment
}
allSteps {
...StepsConnectionFragment
}
allTaRequestBlockchainLocations {
...TaRequestBlockchainLocationsConnectionFragment
}
allTaRequestStatuses {
...TaRequestStatusesConnectionFragment
}
allTaRequestTypes {
...TaRequestTypesConnectionFragment
}
allTaRequests {
...TaRequestsConnectionFragment
}
allTaxRegions {
...TaxRegionsConnectionFragment
}
allTermsOfServices {
...TermsOfServicesConnectionFragment
}
allTermsOfServiceTypes {
...TermsOfServiceTypesConnectionFragment
}
allTokenStatuses {
...TokenStatusesConnectionFragment
}
allTokenTypes {
...TokenTypesConnectionFragment
}
allTokens {
...TokensConnectionFragment
}
allTrades {
...TradesConnectionFragment
}
allTrancheBondData {
...TrancheBondDataConnectionFragment
}
allTransactionAnnotations {
...TransactionAnnotationsConnectionFragment
}
allTransactionGroupTypes {
...TransactionGroupTypesConnectionFragment
}
allTransactions {
...TransactionsConnectionFragment
}
allTransferTypes {
...TransferTypesConnectionFragment
}
allTransfers {
...TransfersConnectionFragment
}
allUserStatuses {
...UserStatusesConnectionFragment
}
allUserTermsOfServices {
...UserTermsOfServicesConnectionFragment
}
allUsers {
...UsersConnectionFragment
}
allUsersAccounts {
...UsersAccountsConnectionFragment
}
allVendorAgents {
...VendorAgentsConnectionFragment
}
allVendorDefaultEmailPreferences {
...VendorDefaultEmailPreferencesConnectionFragment
}
allVendorIntegrationStatuses {
...VendorIntegrationStatusesConnectionFragment
}
allVendorQualificationConstraints {
...VendorQualificationConstraintsConnectionFragment
}
allVendorQualificationStepTypes {
...VendorQualificationStepTypesConnectionFragment
}
allVendorQualifications {
...VendorQualificationsConnectionFragment
}
allVestingDurations {
...VestingDurationsConnectionFragment
}
allVestingEvents {
...VestingEventsConnectionFragment
}
allVestingSchedules {
...VestingSchedulesConnectionFragment
}
allWalletAssignments {
...WalletAssignmentsConnectionFragment
}
allWebhookConfigurations {
...WebhookConfigurationsConnectionFragment
}
allWebhookLevels {
...WebhookLevelsConnectionFragment
}
accountDocumentById {
...AccountDocumentFragment
}
accountDocumentByDocumentIdAndToAccountId {
...AccountDocumentFragment
}
accountIntegrationById {
...AccountIntegrationFragment
}
accountIntegrationByIntegrationIdAndAccountId {
...AccountIntegrationFragment
}
accountIntegrationByStepId {
...AccountIntegrationFragment
}
accountPhoneNumberById {
...AccountPhoneNumberFragment
}
accountPhoneNumberByAccountIdAndType {
...AccountPhoneNumberFragment
}
accountRegDStatusById {
...AccountRegDStatusFragment
}
accountRegDStatusByAccountId {
...AccountRegDStatusFragment
}
accountRestrictionById {
...AccountRestrictionFragment
}
accountRestrictionByAccountIdAndReasonId {
...AccountRestrictionFragment
}
accountTaxInformationById {
...AccountTaxInformationFragment
}
auxAccountByType {
...AuxAccountFragment
}
accountingTypeByType {
...AccountingTypeFragment
}
accountByTypeAndEmail {
...AccountFragment
}
accountBySupportEmail {
...AccountFragment
}
accountById {
...AccountFragment
}
accountsBlockchainAddressByAccountIdAndBlockchainAddressId {
...AccountsBlockchainAddressFragment
}
accountsBlockchainAddressById {
...AccountsBlockchainAddressFragment
}
addressTypeByType {
...AddressTypeFragment
}
addressById {
...AddressFragment
}
allocationAnnotationById {
...AllocationAnnotationFragment
}
allocationArchiveByAllocationIdAndAccountId {
...AllocationArchiveFragment
}
allocationArchiveById {
...AllocationArchiveFragment
}
allocationEmailPreferenceById {
...AllocationEmailPreferenceFragment
}
allocationEmailPreferenceByAllocationId {
...AllocationEmailPreferenceFragment
}
allocationOfferingLinkById {
...AllocationOfferingLinkFragment
}
allocationQualificationById {
...AllocationQualificationFragment
}
allocationQualificationByAllocationIdAndVendorQualificationId {
...AllocationQualificationFragment
}
allocationById {
...AllocationFragment
}
allocationsVestingScheduleByAllocationId {
...AllocationsVestingScheduleFragment
}
allocationsVestingScheduleById {
...AllocationsVestingScheduleFragment
}
assetAnnotationById {
...AssetAnnotationFragment
}
assetArchiveByAssetIdAndAccountId {
...AssetArchiveFragment
}
assetArchiveById {
...AssetArchiveFragment
}
assetStatusByStatus {
...AssetStatusFragment
}
assetTypeByType {
...AssetTypeFragment
}
assetById {
...AssetFragment
}
blockchainAddressGroupById {
...BlockchainAddressGroupFragment
}
blockchainAddressSourceById {
...BlockchainAddressSourceFragment
}
blockchainAddressSourceByVendorIdAndBlockchainAddressId {
...BlockchainAddressSourceFragment
}
blockchainAddressByChainAndAddress {
...BlockchainAddressFragment
}
blockchainAddressById {
...BlockchainAddressFragment
}
blockchainRegistrationByNonce {
...BlockchainRegistrationFragment
}
blockchainRegistrationById {
...BlockchainRegistrationFragment
}
brokerAllocationById {
...BrokerAllocationFragment
}
capTableByBlockchainAddressIdAndTokenId {
...CapTableFragment
}
capTableById {
...CapTableFragment
}
capitalDeploymentById {
...CapitalDeploymentFragment
}
capitalDeploymentByTransactionGroupId {
...CapitalDeploymentFragment
}
chainByChain {
...ChainFragment
}
companyById {
...CompanyFragment
}
contractStatusByStatus {
...ContractStatusFragment
}
contractByContractAddressAndChain {
...ContractFragment
}
contractById {
...ContractFragment
}
countryById {
...CountryFragment
}
countryProvinceById {
...CountryProvinceFragment
}
countryProvinceByCountryIdAndName {
...CountryProvinceFragment
}
currencyById {
...CurrencyFragment
}
currencyTypeByType {
...CurrencyTypeFragment
}
customerAddressById {
...CustomerAddressFragment
}
customerAddressByAddressId {
...CustomerAddressFragment
}
customerAddressByCustomerIdAndType {
...CustomerAddressFragment
}
customerPartyById {
...CustomerPartyFragment
}
customerPartyAddressById {
...CustomerPartyAddressFragment
}
customerPartyAddressByAddressId {
...CustomerPartyAddressFragment
}
customerPartyAddressByCustomerPartyIdAndType {
...CustomerPartyAddressFragment
}
customerByVendorIdAndInvestorId {
...CustomerFragment
}
customerById {
...CustomerFragment
}
defaultMappingFieldById {
...DefaultMappingFieldFragment
}
defaultMappingFieldByField {
...DefaultMappingFieldFragment
}
distributionAnnotationById {
...DistributionAnnotationFragment
}
distributionCustomFieldById {
...DistributionCustomFieldFragment
}
distributionPaymentStatusByStatus {
...DistributionPaymentStatusFragment
}
distributionPaymentById {
...DistributionPaymentFragment
}
distributionPriceById {
...DistributionPriceFragment
}
distributionQualificationById {
...DistributionQualificationFragment
}
distributionQualificationByDistributionIdAndVendorQualificationId {
...DistributionQualificationFragment
}
distributionStatusByStatus {
...DistributionStatusFragment
}
distributionByStepId {
...DistributionFragment
}
distributionByNewId {
...DistributionFragment
}
distributionByDraftedBlockchainId {
...DistributionFragment
}
distributionByOpenBlockchainId {
...DistributionFragment
}
distributionByClosedBlockchainId {
...DistributionFragment
}
distributionByLockedBlockchainId {
...DistributionFragment
}
distributionById {
...DistributionFragment
}
documentSharingById {
...DocumentSharingFragment
}
documentSharingAllowedShareById {
...DocumentSharingAllowedShareFragment
}
documentSharingAllowedShareByToRoleAndFromAccountTypeAndType {
...DocumentSharingAllowedShareFragment
}
documentSharingRoleByRole {
...DocumentSharingRoleFragment
}
documentStatusByStatus {
...DocumentStatusFragment
}
documentTypeByType {
...DocumentTypeFragment
}
documentById {
...DocumentFragment
}
emailTemplateToByTo {
...EmailTemplateToFragment
}
emailByEmail {
...EmailFragment
}
emailById {
...EmailFragment
}
holdingBlockchainAddressStatusByStatus {
...HoldingBlockchainAddressStatusFragment
}
holdingBlockchainAddressById {
...HoldingBlockchainAddressFragment
}
holdingBlockchainAddressByBlockchainAddressId {
...HoldingBlockchainAddressFragment
}
holdingDocumentById {
...HoldingDocumentFragment
}
holdingDocumentByDocumentIdAndHoldingId {
...HoldingDocumentFragment
}
holdingById {
...HoldingFragment
}
instancedAccountInformationById {
...InstancedAccountInformationFragment
}
instancedAccountInformationByVendorAccountIdAndAccountIdAndField {
...InstancedAccountInformationFragment
}
instancedAccountInformationHistoryById {
...InstancedAccountInformationHistoryFragment
}
instancedMappingFieldById {
...InstancedMappingFieldFragment
}
instancedMappingFieldByAccountIdAndOnboardingQuestionIdAndMappedSigningTemplateId {
...InstancedMappingFieldFragment
}
roundByTokenId {
...RoundFragment
}
roundByBlockchainAddressId {
...RoundFragment
}
roundById {
...RoundFragment
}
integrationPartnerById {
...IntegrationPartnerFragment
}
integrationPartnerByName {
...IntegrationPartnerFragment
}
integrationTypeByType {
...IntegrationTypeFragment
}
integrationById {
...IntegrationFragment
}
investorAccountTypeByType {
...InvestorAccountTypeFragment
}
invitationStatusByStatus {
...InvitationStatusFragment
}
issuanceEventById {
...IssuanceEventFragment
}
issuanceEventByDistributionId {
...IssuanceEventFragment
}
ledgerById {
...LedgerFragment
}
managedAccountByManagerIdAndEntityId {
...ManagedAccountFragment
}
managedAccountById {
...ManagedAccountFragment
}
mappedSigningTemplateQuestionSetById {
...MappedSigningTemplateQuestionSetFragment
}
mappedSigningTemplateQuestionSetByOnboardingQuestionSetIdAndMappedSigningTemplateId {
...MappedSigningTemplateQuestionSetFragment
}
mappedSigningTemplateById {
...MappedSigningTemplateFragment
}
mappedSigningTemplateByAccountIdAndName {
...MappedSigningTemplateFragment
}
mappedSigningTemplateByStepId {
...MappedSigningTemplateFragment
}
mappedSigningTemplateByVendorQualificationId {
...MappedSigningTemplateFragment
}
mappingRoleTypeByType {
...MappingRoleTypeFragment
}
mappingRoleById {
...MappingRoleFragment
}
omnibusHoldingById {
...OmnibusHoldingFragment
}
omnibusHoldingBySecurityIdAndHoldingId {
...OmnibusHoldingFragment
}
omnibusInvestorById {
...OmnibusInvestorFragment
}
omnibusInvestorBySecurityIdAndInvestorId {
...OmnibusInvestorFragment
}
onboardingQuestionJoinById {
...OnboardingQuestionJoinFragment
}
onboardingQuestionJoinByOnboardingQuestionSetIdAndOnboardingQuestionId {
...OnboardingQuestionJoinFragment
}
onboardingQuestionSetById {
...OnboardingQuestionSetFragment
}
onboardingQuestionSetByAccountIdAndName {
...OnboardingQuestionSetFragment
}
onboardingQuestionSetByVendorQualificationId {
...OnboardingQuestionSetFragment
}
onboardingQuestionTypeByType {
...OnboardingQuestionTypeFragment
}
onboardingQuestionById {
...OnboardingQuestionFragment
}
onboardingQuestionByAccountIdAndName {
...OnboardingQuestionFragment
}
partyRoleByRole {
...PartyRoleFragment
}
paymentAccountById {
...PaymentAccountFragment
}
paymentInstrumentById {
...PaymentInstrumentFragment
}
paymentIssuerById {
...PaymentIssuerFragment
}
paymentIssuerByIssuerIdAndPaymentAccountId {
...PaymentIssuerFragment
}
paymentMethodTypeByType {
...PaymentMethodTypeFragment
}
paymentMethodById {
...PaymentMethodFragment
}
paymentMethodByAccountIdAndName {
...PaymentMethodFragment
}
paymentMethodByEncryptedRecordId {
...PaymentMethodFragment
}
paymentStepTypeByType {
...PaymentStepTypeFragment
}
phoneNumberTypeByType {
...PhoneNumberTypeFragment
}
qualificationStatusByStatus {
...QualificationStatusFragment
}
registrationMethodByMethod {
...RegistrationMethodFragment
}
registrationStatusByStatus {
...RegistrationStatusFragment
}
restrictionCategoryByCategory {
...RestrictionCategoryFragment
}
restrictionReasonById {
...RestrictionReasonFragment
}
restrictionReasonByReason {
...RestrictionReasonFragment
}
auxRoleByRole {
...AuxRoleFragment
}
securityById {
...SecurityFragment
}
securityByBlockchainAddressId {
...SecurityFragment
}
securityDocumentById {
...SecurityDocumentFragment
}
securityDocumentByDocumentIdAndSecurityId {
...SecurityDocumentFragment
}
securityListingById {
...SecurityListingFragment
}
securityListingBySecurityId {
...SecurityListingFragment
}
sentSigningDocumentStatusByStatus {
...SentSigningDocumentStatusFragment
}
sentSigningDocumentById {
...SentSigningDocumentFragment
}
sentSigningDocumentByMappedSigningTemplateIdAndDocumentId {
...SentSigningDocumentFragment
}
signingAccountById {
...SigningAccountFragment
}
signingDocumentById {
...SigningDocumentFragment
}
signingFieldById {
...SigningFieldFragment
}
signingRoleById {
...SigningRoleFragment
}
signingStepTypeByType {
...SigningStepTypeFragment
}
signingTemplateById {
...SigningTemplateFragment
}
stepStatusByStatus {
...StepStatusFragment
}
stepTypeByType {
...StepTypeFragment
}
stepById {
...StepFragment
}
taRequestBlockchainLocationByLocation {
...TaRequestBlockchainLocationFragment
}
taRequestStatusByStatus {
...TaRequestStatusFragment
}
taRequestTypeByType {
...TaRequestTypeFragment
}
taRequestById {
...TaRequestFragment
}
taxRegionById {
...TaxRegionFragment
}
termsOfServiceById {
...TermsOfServiceFragment
}
termsOfServiceTypeByType {
...TermsOfServiceTypeFragment
}
tokenStatusByStatus {
...TokenStatusFragment
}
tokenTypeByType {
...TokenTypeFragment
}
tokenById {
...TokenFragment
}
trancheBondDatumById {
...TrancheBondDatumFragment
}
trancheBondDatumByRoundId {
...TrancheBondDatumFragment
}
transactionAnnotationById {
...TransactionAnnotationFragment
}
transactionGroupTypeByType {
...TransactionGroupTypeFragment
}
transactionById {
...TransactionFragment
}
userStatusByStatus {
...UserStatusFragment
}
userTermsOfServiceById {
...UserTermsOfServiceFragment
}
userById {
...UserFragment
}
usersAccountByUserIdAndAccountId {
...UsersAccountFragment
}
usersAccountById {
...UsersAccountFragment
}
vendorAgentById {
...VendorAgentFragment
}
vendorAgentByAgentIdAndVendorId {
...VendorAgentFragment
}
vendorDefaultEmailPreferenceById {
...VendorDefaultEmailPreferenceFragment
}
vendorDefaultEmailPreferenceByAccountId {
...VendorDefaultEmailPreferenceFragment
}
vendorIntegrationStatusByStatus {
...VendorIntegrationStatusFragment
}
vendorQualificationConstraintById {
...VendorQualificationConstraintFragment
}
vendorQualificationStepTypeByType {
...VendorQualificationStepTypeFragment
}
vendorQualificationById {
...VendorQualificationFragment
}
vestingDurationByDuration {
...VestingDurationFragment
}
vestingEventById {
...VestingEventFragment
}
vestingScheduleByDistributionId {
...VestingScheduleFragment
}
vestingScheduleById {
...VestingScheduleFragment
}
walletAssignmentByDistributionId {
...WalletAssignmentFragment
}
walletAssignmentById {
...WalletAssignmentFragment
}
webhookConfigurationById {
...WebhookConfigurationFragment
}
webhookConfigurationByLevelAndAccountId {
...WebhookConfigurationFragment
}
webhookLevelByLevel {
...WebhookLevelFragment
}
brokerTypeahead {
...AccountsConnectionFragment
}
getUsersData {
...GetUsersDataRecordFragment
}
holdingCapTable {
...CapTablesConnectionFragment
}
investorOfferingDetailsById {
...InvestorOfferingDetailFragment
}
role
userId
accountDocument {
...AccountDocumentFragment
}
accountIntegration {
...AccountIntegrationFragment
}
accountPhoneNumber {
...AccountPhoneNumberFragment
}
accountRegDStatus {
...AccountRegDStatusFragment
}
accountRestriction {
...AccountRestrictionFragment
}
accountTaxInformation {
...AccountTaxInformationFragment
}
auxAccount {
...AuxAccountFragment
}
accountingType {
...AccountingTypeFragment
}
account {
...AccountFragment
}
accountsBlockchainAddress {
...AccountsBlockchainAddressFragment
}
addressType {
...AddressTypeFragment
}
address {
...AddressFragment
}
allocationAnnotation {
...AllocationAnnotationFragment
}
allocationArchive {
...AllocationArchiveFragment
}
allocationEmailPreference {
...AllocationEmailPreferenceFragment
}
allocationOfferingLink {
...AllocationOfferingLinkFragment
}
allocationQualification {
...AllocationQualificationFragment
}
allocation {
...AllocationFragment
}
allocationsVestingSchedule {
...AllocationsVestingScheduleFragment
}
assetAnnotation {
...AssetAnnotationFragment
}
assetArchive {
...AssetArchiveFragment
}
assetStatus {
...AssetStatusFragment
}
assetType {
...AssetTypeFragment
}
asset {
...AssetFragment
}
blockchainAddressGroup {
...BlockchainAddressGroupFragment
}
blockchainAddressSource {
...BlockchainAddressSourceFragment
}
blockchainAddress {
...BlockchainAddressFragment
}
blockchainRegistration {
...BlockchainRegistrationFragment
}
brokerAllocation {
...BrokerAllocationFragment
}
capTable {
...CapTableFragment
}
capitalDeployment {
...CapitalDeploymentFragment
}
chain {
...ChainFragment
}
company {
...CompanyFragment
}
contractStatus {
...ContractStatusFragment
}
contract {
...ContractFragment
}
country {
...CountryFragment
}
countryProvince {
...CountryProvinceFragment
}
currency {
...CurrencyFragment
}
currencyType {
...CurrencyTypeFragment
}
customerAddress {
...CustomerAddressFragment
}
customerParty {
...CustomerPartyFragment
}
customerPartyAddress {
...CustomerPartyAddressFragment
}
customer {
...CustomerFragment
}
defaultMappingField {
...DefaultMappingFieldFragment
}
distributionAnnotation {
...DistributionAnnotationFragment
}
distributionCustomField {
...DistributionCustomFieldFragment
}
distributionPaymentStatus {
...DistributionPaymentStatusFragment
}
distributionPayment {
...DistributionPaymentFragment
}
distributionPrice {
...DistributionPriceFragment
}
distributionQualification {
...DistributionQualificationFragment
}
distributionStatus {
...DistributionStatusFragment
}
distribution {
...DistributionFragment
}
documentSharing {
...DocumentSharingFragment
}
documentSharingAllowedShare {
...DocumentSharingAllowedShareFragment
}
documentSharingRole {
...DocumentSharingRoleFragment
}
documentStatus {
...DocumentStatusFragment
}
documentType {
...DocumentTypeFragment
}
document {
...DocumentFragment
}
emailTemplateTo {
...EmailTemplateToFragment
}
email {
...EmailFragment
}
holdingBlockchainAddressStatus {
...HoldingBlockchainAddressStatusFragment
}
holdingBlockchainAddress {
...HoldingBlockchainAddressFragment
}
holdingDocument {
...HoldingDocumentFragment
}
holding {
...HoldingFragment
}
instancedAccountInformation {
...InstancedAccountInformationFragment
}
instancedAccountInformationHistory {
...InstancedAccountInformationHistoryFragment
}
instancedMappingField {
...InstancedMappingFieldFragment
}
round {
...RoundFragment
}
integrationPartner {
...IntegrationPartnerFragment
}
integrationType {
...IntegrationTypeFragment
}
integration {
...IntegrationFragment
}
investorAccountType {
...InvestorAccountTypeFragment
}
invitationStatus {
...InvitationStatusFragment
}
issuanceEvent {
...IssuanceEventFragment
}
ledger {
...LedgerFragment
}
managedAccount {
...ManagedAccountFragment
}
mappedSigningTemplateQuestionSet {
...MappedSigningTemplateQuestionSetFragment
}
mappedSigningTemplate {
...MappedSigningTemplateFragment
}
mappingRoleType {
...MappingRoleTypeFragment
}
mappingRole {
...MappingRoleFragment
}
omnibusHolding {
...OmnibusHoldingFragment
}
omnibusInvestor {
...OmnibusInvestorFragment
}
onboardingQuestionJoin {
...OnboardingQuestionJoinFragment
}
onboardingQuestionSet {
...OnboardingQuestionSetFragment
}
onboardingQuestionType {
...OnboardingQuestionTypeFragment
}
onboardingQuestion {
...OnboardingQuestionFragment
}
partyRole {
...PartyRoleFragment
}
paymentAccount {
...PaymentAccountFragment
}
paymentInstrument {
...PaymentInstrumentFragment
}
paymentIssuer {
...PaymentIssuerFragment
}
paymentMethodType {
...PaymentMethodTypeFragment
}
paymentMethod {
...PaymentMethodFragment
}
paymentStepType {
...PaymentStepTypeFragment
}
phoneNumberType {
...PhoneNumberTypeFragment
}
qualificationStatus {
...QualificationStatusFragment
}
registrationMethod {
...RegistrationMethodFragment
}
registrationStatus {
...RegistrationStatusFragment
}
restrictionCategory {
...RestrictionCategoryFragment
}
restrictionReason {
...RestrictionReasonFragment
}
auxRole {
...AuxRoleFragment
}
security {
...SecurityFragment
}
securityDocument {
...SecurityDocumentFragment
}
securityListing {
...SecurityListingFragment
}
sentSigningDocumentStatus {
...SentSigningDocumentStatusFragment
}
sentSigningDocument {
...SentSigningDocumentFragment
}
signingAccount {
...SigningAccountFragment
}
signingDocument {
...SigningDocumentFragment
}
signingField {
...SigningFieldFragment
}
signingRole {
...SigningRoleFragment
}
signingStepType {
...SigningStepTypeFragment
}
signingTemplate {
...SigningTemplateFragment
}
stepStatus {
...StepStatusFragment
}
stepType {
...StepTypeFragment
}
step {
...StepFragment
}
taRequestBlockchainLocation {
...TaRequestBlockchainLocationFragment
}
taRequestStatus {
...TaRequestStatusFragment
}
taRequestType {
...TaRequestTypeFragment
}
taRequest {
...TaRequestFragment
}
taxRegion {
...TaxRegionFragment
}
termsOfService {
...TermsOfServiceFragment
}
termsOfServiceType {
...TermsOfServiceTypeFragment
}
tokenStatus {
...TokenStatusFragment
}
tokenType {
...TokenTypeFragment
}
token {
...TokenFragment
}
trancheBondDatum {
...TrancheBondDatumFragment
}
transactionAnnotation {
...TransactionAnnotationFragment
}
transactionGroupType {
...TransactionGroupTypeFragment
}
transaction {
...TransactionFragment
}
userStatus {
...UserStatusFragment
}
userTermsOfService {
...UserTermsOfServiceFragment
}
user {
...UserFragment
}
usersAccount {
...UsersAccountFragment
}
vendorAgent {
...VendorAgentFragment
}
vendorDefaultEmailPreference {
...VendorDefaultEmailPreferenceFragment
}
vendorIntegrationStatus {
...VendorIntegrationStatusFragment
}
vendorQualificationConstraint {
...VendorQualificationConstraintFragment
}
vendorQualificationStepType {
...VendorQualificationStepTypeFragment
}
vendorQualification {
...VendorQualificationFragment
}
vestingDuration {
...VestingDurationFragment
}
vestingEvent {
...VestingEventFragment
}
vestingSchedule {
...VestingScheduleFragment
}
walletAssignment {
...WalletAssignmentFragment
}
webhookConfiguration {
...WebhookConfigurationFragment
}
webhookLevel {
...WebhookLevelFragment
}
}
}
Response
{
"data": {
"query": {
"query": Query,
"nodeId": "4",
"node": Node,
"allAccountAddresses": AccountAddressesConnection,
"allAccountDocuments": AccountDocumentsConnection,
"allAccountIntegrations": AccountIntegrationsConnection,
"allAccountPhoneNumbers": AccountPhoneNumbersConnection,
"allAccountRegDStatuses": AccountRegDStatusesConnection,
"allAccountRestrictions": AccountRestrictionsConnection,
"allAccountTaxInformations": AccountTaxInformationsConnection,
"allAuxAccounts": AuxAccountsConnection,
"allAccountingTypes": AccountingTypesConnection,
"allAccounts": AccountsConnection,
"allAccountsBlockchainAddresses": AccountsBlockchainAddressesConnection,
"allActiveUsers": ActiveUsersConnection,
"allAddressTypes": AddressTypesConnection,
"allAddresses": AddressesConnection,
"allAllocationAnnotations": AllocationAnnotationsConnection,
"allAllocationArchives": AllocationArchivesConnection,
"allAllocationEmailPreferences": AllocationEmailPreferencesConnection,
"allAllocationOfferingLinks": AllocationOfferingLinksConnection,
"allAllocationQualifications": AllocationQualificationsConnection,
"allAllocations": AllocationsConnection,
"allAllocationsVestingSchedules": AllocationsVestingSchedulesConnection,
"allAssetAnnotations": AssetAnnotationsConnection,
"allAssetArchives": AssetArchivesConnection,
"allAssetStatuses": AssetStatusesConnection,
"allAssetTypes": AssetTypesConnection,
"allAssets": AssetsConnection,
"allAtsTags": AtsTagsConnection,
"allBlockchainAddressGroups": BlockchainAddressGroupsConnection,
"allBlockchainAddressSources": BlockchainAddressSourcesConnection,
"allBlockchainAddresses": BlockchainAddressesConnection,
"allBlockchainRegistrations": BlockchainRegistrationsConnection,
"allBrokerAllocations": BrokerAllocationsConnection,
"allCapTables": CapTablesConnection,
"allCapitalDeployments": CapitalDeploymentsConnection,
"allChains": ChainsConnection,
"allCompanies": CompaniesConnection,
"allContractStatuses": ContractStatusesConnection,
"allContracts": ContractsConnection,
"allCountries": CountriesConnection,
"allCountryProvinces": CountryProvincesConnection,
"allCurrencies": CurrenciesConnection,
"allCurrencyTypes": CurrencyTypesConnection,
"allCustomerAddresses": CustomerAddressesConnection,
"allCustomerParties": CustomerPartiesConnection,
"allCustomerPartyAddresses": CustomerPartyAddressesConnection,
"allCustomers": CustomersConnection,
"allDefaultMappingFields": DefaultMappingFieldsConnection,
"allDistributionAnnotations": DistributionAnnotationsConnection,
"allDistributionCustomFields": DistributionCustomFieldsConnection,
"allDistributionPaymentStatuses": DistributionPaymentStatusesConnection,
"allDistributionPayments": DistributionPaymentsConnection,
"allDistributionPrices": DistributionPricesConnection,
"allDistributionQualifications": DistributionQualificationsConnection,
"allDistributionStatuses": DistributionStatusesConnection,
"allDistributions": DistributionsConnection,
"allDocumentSharings": DocumentSharingsConnection,
"allDocumentSharingAllowedShares": DocumentSharingAllowedSharesConnection,
"allDocumentSharingRoles": DocumentSharingRolesConnection,
"allDocumentStatuses": DocumentStatusesConnection,
"allDocumentTypes": DocumentTypesConnection,
"allDocuments": DocumentsConnection,
"allEmailTemplateTos": EmailTemplateTosConnection,
"allEmails": EmailsConnection,
"allFullHoldings": FullHoldingsConnection,
"allHoldingBlockchainAddressStatuses": HoldingBlockchainAddressStatusesConnection,
"allHoldingBlockchainAddresses": HoldingBlockchainAddressesConnection,
"allHoldingDocuments": HoldingDocumentsConnection,
"allHoldings": HoldingsConnection,
"allIdempotents": IdempotentsConnection,
"allIdempotentTypes": IdempotentTypesConnection,
"allInstancedAccountInformations": InstancedAccountInformationsConnection,
"allInstancedMappingFields": InstancedMappingFieldsConnection,
"allRounds": RoundsConnection,
"allIntegrationPartners": IntegrationPartnersConnection,
"allIntegrationTypes": IntegrationTypesConnection,
"allIntegrations": IntegrationsConnection,
"allInvestorAccountTypes": InvestorAccountTypesConnection,
"allInvitationStatuses": InvitationStatusesConnection,
"allIssuanceEvents": IssuanceEventsConnection,
"allLedgers": LedgersConnection,
"allManagedAccounts": ManagedAccountsConnection,
"allMappedSigningTemplateQuestionSets": MappedSigningTemplateQuestionSetsConnection,
"allMappedSigningTemplates": MappedSigningTemplatesConnection,
"allMappingRoleTypes": MappingRoleTypesConnection,
"allMappingRoles": MappingRolesConnection,
"allOmnibusHoldings": OmnibusHoldingsConnection,
"allOmnibusInvestors": OmnibusInvestorsConnection,
"allOnboardingQuestionJoins": OnboardingQuestionJoinsConnection,
"allOnboardingQuestionSets": OnboardingQuestionSetsConnection,
"allOnboardingQuestionTypes": OnboardingQuestionTypesConnection,
"allOnboardingQuestions": OnboardingQuestionsConnection,
"allParties": PartiesConnection,
"allPartyAddresses": PartyAddressesConnection,
"allPartyRoles": PartyRolesConnection,
"allPaymentAccounts": PaymentAccountsConnection,
"allPaymentInstruments": PaymentInstrumentsConnection,
"allPaymentIssuers": PaymentIssuersConnection,
"allPaymentMethodTypes": PaymentMethodTypesConnection,
"allPaymentMethods": PaymentMethodsConnection,
"allPaymentStepTypes": PaymentStepTypesConnection,
"allPhoneNumberTypes": PhoneNumberTypesConnection,
"allQualificationStatuses": QualificationStatusesConnection,
"allRegistrationMethods": RegistrationMethodsConnection,
"allRegistrationStatuses": RegistrationStatusesConnection,
"allRequestTypes": RequestTypesConnection,
"allRequests": RequestsConnection,
"allRestrictionCategories": RestrictionCategoriesConnection,
"allRestrictionReasons": RestrictionReasonsConnection,
"allAuxRoles": AuxRolesConnection,
"allSecurities": SecuritiesConnection,
"allSecurityDocuments": SecurityDocumentsConnection,
"allSecurityListings": SecurityListingsConnection,
"allSentSigningDocumentStatuses": SentSigningDocumentStatusesConnection,
"allSentSigningDocuments": SentSigningDocumentsConnection,
"allSigningAccounts": SigningAccountsConnection,
"allSigningDocuments": SigningDocumentsConnection,
"allSigningFields": SigningFieldsConnection,
"allSigningRoles": SigningRolesConnection,
"allSigningStepTypes": SigningStepTypesConnection,
"allSigningTemplates": SigningTemplatesConnection,
"allStagedBalanceTransfers": StagedBalanceTransfersConnection,
"allStagedTransferAtsTags": StagedTransferAtsTagsConnection,
"allStagedTransferStatuses": StagedTransferStatusesConnection,
"allStagedTransfers": StagedTransfersConnection,
"allStepStatuses": StepStatusesConnection,
"allStepTypes": StepTypesConnection,
"allSteps": StepsConnection,
"allTaRequestBlockchainLocations": TaRequestBlockchainLocationsConnection,
"allTaRequestStatuses": TaRequestStatusesConnection,
"allTaRequestTypes": TaRequestTypesConnection,
"allTaRequests": TaRequestsConnection,
"allTaxRegions": TaxRegionsConnection,
"allTermsOfServices": TermsOfServicesConnection,
"allTermsOfServiceTypes": TermsOfServiceTypesConnection,
"allTokenStatuses": TokenStatusesConnection,
"allTokenTypes": TokenTypesConnection,
"allTokens": TokensConnection,
"allTrades": TradesConnection,
"allTrancheBondData": TrancheBondDataConnection,
"allTransactionAnnotations": TransactionAnnotationsConnection,
"allTransactionGroupTypes": TransactionGroupTypesConnection,
"allTransactions": TransactionsConnection,
"allTransferTypes": TransferTypesConnection,
"allTransfers": TransfersConnection,
"allUserStatuses": UserStatusesConnection,
"allUserTermsOfServices": UserTermsOfServicesConnection,
"allUsers": UsersConnection,
"allUsersAccounts": UsersAccountsConnection,
"allVendorAgents": VendorAgentsConnection,
"allVendorDefaultEmailPreferences": VendorDefaultEmailPreferencesConnection,
"allVendorIntegrationStatuses": VendorIntegrationStatusesConnection,
"allVendorQualificationConstraints": VendorQualificationConstraintsConnection,
"allVendorQualificationStepTypes": VendorQualificationStepTypesConnection,
"allVendorQualifications": VendorQualificationsConnection,
"allVestingDurations": VestingDurationsConnection,
"allVestingEvents": VestingEventsConnection,
"allVestingSchedules": VestingSchedulesConnection,
"allWalletAssignments": WalletAssignmentsConnection,
"allWebhookConfigurations": WebhookConfigurationsConnection,
"allWebhookLevels": WebhookLevelsConnection,
"accountDocumentById": AccountDocument,
"accountDocumentByDocumentIdAndToAccountId": AccountDocument,
"accountIntegrationById": AccountIntegration,
"accountIntegrationByIntegrationIdAndAccountId": AccountIntegration,
"accountIntegrationByStepId": AccountIntegration,
"accountPhoneNumberById": AccountPhoneNumber,
"accountPhoneNumberByAccountIdAndType": AccountPhoneNumber,
"accountRegDStatusById": AccountRegDStatus,
"accountRegDStatusByAccountId": AccountRegDStatus,
"accountRestrictionById": AccountRestriction,
"accountRestrictionByAccountIdAndReasonId": AccountRestriction,
"accountTaxInformationById": AccountTaxInformation,
"auxAccountByType": AuxAccount,
"accountingTypeByType": AccountingType,
"accountByTypeAndEmail": Account,
"accountBySupportEmail": Account,
"accountById": Account,
"accountsBlockchainAddressByAccountIdAndBlockchainAddressId": AccountsBlockchainAddress,
"accountsBlockchainAddressById": AccountsBlockchainAddress,
"addressTypeByType": AddressType,
"addressById": Address,
"allocationAnnotationById": AllocationAnnotation,
"allocationArchiveByAllocationIdAndAccountId": AllocationArchive,
"allocationArchiveById": AllocationArchive,
"allocationEmailPreferenceById": AllocationEmailPreference,
"allocationEmailPreferenceByAllocationId": AllocationEmailPreference,
"allocationOfferingLinkById": AllocationOfferingLink,
"allocationQualificationById": AllocationQualification,
"allocationQualificationByAllocationIdAndVendorQualificationId": AllocationQualification,
"allocationById": Allocation,
"allocationsVestingScheduleByAllocationId": AllocationsVestingSchedule,
"allocationsVestingScheduleById": AllocationsVestingSchedule,
"assetAnnotationById": AssetAnnotation,
"assetArchiveByAssetIdAndAccountId": AssetArchive,
"assetArchiveById": AssetArchive,
"assetStatusByStatus": AssetStatus,
"assetTypeByType": AssetType,
"assetById": Asset,
"blockchainAddressGroupById": BlockchainAddressGroup,
"blockchainAddressSourceById": BlockchainAddressSource,
"blockchainAddressSourceByVendorIdAndBlockchainAddressId": BlockchainAddressSource,
"blockchainAddressByChainAndAddress": BlockchainAddress,
"blockchainAddressById": BlockchainAddress,
"blockchainRegistrationByNonce": BlockchainRegistration,
"blockchainRegistrationById": BlockchainRegistration,
"brokerAllocationById": BrokerAllocation,
"capTableByBlockchainAddressIdAndTokenId": CapTable,
"capTableById": CapTable,
"capitalDeploymentById": CapitalDeployment,
"capitalDeploymentByTransactionGroupId": CapitalDeployment,
"chainByChain": Chain,
"companyById": Company,
"contractStatusByStatus": ContractStatus,
"contractByContractAddressAndChain": Contract,
"contractById": Contract,
"countryById": Country,
"countryProvinceById": CountryProvince,
"countryProvinceByCountryIdAndName": CountryProvince,
"currencyById": Currency,
"currencyTypeByType": CurrencyType,
"customerAddressById": CustomerAddress,
"customerAddressByAddressId": CustomerAddress,
"customerAddressByCustomerIdAndType": CustomerAddress,
"customerPartyById": CustomerParty,
"customerPartyAddressById": CustomerPartyAddress,
"customerPartyAddressByAddressId": CustomerPartyAddress,
"customerPartyAddressByCustomerPartyIdAndType": CustomerPartyAddress,
"customerByVendorIdAndInvestorId": Customer,
"customerById": Customer,
"defaultMappingFieldById": DefaultMappingField,
"defaultMappingFieldByField": DefaultMappingField,
"distributionAnnotationById": DistributionAnnotation,
"distributionCustomFieldById": DistributionCustomField,
"distributionPaymentStatusByStatus": DistributionPaymentStatus,
"distributionPaymentById": DistributionPayment,
"distributionPriceById": DistributionPrice,
"distributionQualificationById": DistributionQualification,
"distributionQualificationByDistributionIdAndVendorQualificationId": DistributionQualification,
"distributionStatusByStatus": DistributionStatus,
"distributionByStepId": Distribution,
"distributionByNewId": Distribution,
"distributionByDraftedBlockchainId": Distribution,
"distributionByOpenBlockchainId": Distribution,
"distributionByClosedBlockchainId": Distribution,
"distributionByLockedBlockchainId": Distribution,
"distributionById": Distribution,
"documentSharingById": DocumentSharing,
"documentSharingAllowedShareById": DocumentSharingAllowedShare,
"documentSharingAllowedShareByToRoleAndFromAccountTypeAndType": DocumentSharingAllowedShare,
"documentSharingRoleByRole": DocumentSharingRole,
"documentStatusByStatus": DocumentStatus,
"documentTypeByType": DocumentType,
"documentById": Document,
"emailTemplateToByTo": EmailTemplateTo,
"emailByEmail": Email,
"emailById": Email,
"holdingBlockchainAddressStatusByStatus": HoldingBlockchainAddressStatus,
"holdingBlockchainAddressById": HoldingBlockchainAddress,
"holdingBlockchainAddressByBlockchainAddressId": HoldingBlockchainAddress,
"holdingDocumentById": HoldingDocument,
"holdingDocumentByDocumentIdAndHoldingId": HoldingDocument,
"holdingById": Holding,
"instancedAccountInformationById": InstancedAccountInformation,
"instancedAccountInformationByVendorAccountIdAndAccountIdAndField": InstancedAccountInformation,
"instancedAccountInformationHistoryById": InstancedAccountInformationHistory,
"instancedMappingFieldById": InstancedMappingField,
"instancedMappingFieldByAccountIdAndOnboardingQuestionIdAndMappedSigningTemplateId": InstancedMappingField,
"roundByTokenId": Round,
"roundByBlockchainAddressId": Round,
"roundById": Round,
"integrationPartnerById": IntegrationPartner,
"integrationPartnerByName": IntegrationPartner,
"integrationTypeByType": IntegrationType,
"integrationById": Integration,
"investorAccountTypeByType": InvestorAccountType,
"invitationStatusByStatus": InvitationStatus,
"issuanceEventById": IssuanceEvent,
"issuanceEventByDistributionId": IssuanceEvent,
"ledgerById": Ledger,
"managedAccountByManagerIdAndEntityId": ManagedAccount,
"managedAccountById": ManagedAccount,
"mappedSigningTemplateQuestionSetById": MappedSigningTemplateQuestionSet,
"mappedSigningTemplateQuestionSetByOnboardingQuestionSetIdAndMappedSigningTemplateId": MappedSigningTemplateQuestionSet,
"mappedSigningTemplateById": MappedSigningTemplate,
"mappedSigningTemplateByAccountIdAndName": MappedSigningTemplate,
"mappedSigningTemplateByStepId": MappedSigningTemplate,
"mappedSigningTemplateByVendorQualificationId": MappedSigningTemplate,
"mappingRoleTypeByType": MappingRoleType,
"mappingRoleById": MappingRole,
"omnibusHoldingById": OmnibusHolding,
"omnibusHoldingBySecurityIdAndHoldingId": OmnibusHolding,
"omnibusInvestorById": OmnibusInvestor,
"omnibusInvestorBySecurityIdAndInvestorId": OmnibusInvestor,
"onboardingQuestionJoinById": OnboardingQuestionJoin,
"onboardingQuestionJoinByOnboardingQuestionSetIdAndOnboardingQuestionId": OnboardingQuestionJoin,
"onboardingQuestionSetById": OnboardingQuestionSet,
"onboardingQuestionSetByAccountIdAndName": OnboardingQuestionSet,
"onboardingQuestionSetByVendorQualificationId": OnboardingQuestionSet,
"onboardingQuestionTypeByType": OnboardingQuestionType,
"onboardingQuestionById": OnboardingQuestion,
"onboardingQuestionByAccountIdAndName": OnboardingQuestion,
"partyRoleByRole": PartyRole,
"paymentAccountById": PaymentAccount,
"paymentInstrumentById": PaymentInstrument,
"paymentIssuerById": PaymentIssuer,
"paymentIssuerByIssuerIdAndPaymentAccountId": PaymentIssuer,
"paymentMethodTypeByType": PaymentMethodType,
"paymentMethodById": PaymentMethod,
"paymentMethodByAccountIdAndName": PaymentMethod,
"paymentMethodByEncryptedRecordId": PaymentMethod,
"paymentStepTypeByType": PaymentStepType,
"phoneNumberTypeByType": PhoneNumberType,
"qualificationStatusByStatus": QualificationStatus,
"registrationMethodByMethod": RegistrationMethod,
"registrationStatusByStatus": RegistrationStatus,
"restrictionCategoryByCategory": RestrictionCategory,
"restrictionReasonById": RestrictionReason,
"restrictionReasonByReason": RestrictionReason,
"auxRoleByRole": AuxRole,
"securityById": Security,
"securityByBlockchainAddressId": Security,
"securityDocumentById": SecurityDocument,
"securityDocumentByDocumentIdAndSecurityId": SecurityDocument,
"securityListingById": SecurityListing,
"securityListingBySecurityId": SecurityListing,
"sentSigningDocumentStatusByStatus": SentSigningDocumentStatus,
"sentSigningDocumentById": SentSigningDocument,
"sentSigningDocumentByMappedSigningTemplateIdAndDocumentId": SentSigningDocument,
"signingAccountById": SigningAccount,
"signingDocumentById": SigningDocument,
"signingFieldById": SigningField,
"signingRoleById": SigningRole,
"signingStepTypeByType": SigningStepType,
"signingTemplateById": SigningTemplate,
"stepStatusByStatus": StepStatus,
"stepTypeByType": StepType,
"stepById": Step,
"taRequestBlockchainLocationByLocation": TaRequestBlockchainLocation,
"taRequestStatusByStatus": TaRequestStatus,
"taRequestTypeByType": TaRequestType,
"taRequestById": TaRequest,
"taxRegionById": TaxRegion,
"termsOfServiceById": TermsOfService,
"termsOfServiceTypeByType": TermsOfServiceType,
"tokenStatusByStatus": TokenStatus,
"tokenTypeByType": TokenType,
"tokenById": Token,
"trancheBondDatumById": TrancheBondDatum,
"trancheBondDatumByRoundId": TrancheBondDatum,
"transactionAnnotationById": TransactionAnnotation,
"transactionGroupTypeByType": TransactionGroupType,
"transactionById": Transaction,
"userStatusByStatus": UserStatus,
"userTermsOfServiceById": UserTermsOfService,
"userById": User,
"usersAccountByUserIdAndAccountId": UsersAccount,
"usersAccountById": UsersAccount,
"vendorAgentById": VendorAgent,
"vendorAgentByAgentIdAndVendorId": VendorAgent,
"vendorDefaultEmailPreferenceById": VendorDefaultEmailPreference,
"vendorDefaultEmailPreferenceByAccountId": VendorDefaultEmailPreference,
"vendorIntegrationStatusByStatus": VendorIntegrationStatus,
"vendorQualificationConstraintById": VendorQualificationConstraint,
"vendorQualificationStepTypeByType": VendorQualificationStepType,
"vendorQualificationById": VendorQualification,
"vestingDurationByDuration": VestingDuration,
"vestingEventById": VestingEvent,
"vestingScheduleByDistributionId": VestingSchedule,
"vestingScheduleById": VestingSchedule,
"walletAssignmentByDistributionId": WalletAssignment,
"walletAssignmentById": WalletAssignment,
"webhookConfigurationById": WebhookConfiguration,
"webhookConfigurationByLevelAndAccountId": WebhookConfiguration,
"webhookLevelByLevel": WebhookLevel,
"brokerTypeahead": AccountsConnection,
"getUsersData": GetUsersDataRecord,
"holdingCapTable": CapTablesConnection,
"investorOfferingDetailsById": InvestorOfferingDetail,
"role": "xyz789",
"userId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountDocument": AccountDocument,
"accountIntegration": AccountIntegration,
"accountPhoneNumber": AccountPhoneNumber,
"accountRegDStatus": AccountRegDStatus,
"accountRestriction": AccountRestriction,
"accountTaxInformation": AccountTaxInformation,
"auxAccount": AuxAccount,
"accountingType": AccountingType,
"account": Account,
"accountsBlockchainAddress": AccountsBlockchainAddress,
"addressType": AddressType,
"address": Address,
"allocationAnnotation": AllocationAnnotation,
"allocationArchive": AllocationArchive,
"allocationEmailPreference": AllocationEmailPreference,
"allocationOfferingLink": AllocationOfferingLink,
"allocationQualification": AllocationQualification,
"allocation": Allocation,
"allocationsVestingSchedule": AllocationsVestingSchedule,
"assetAnnotation": AssetAnnotation,
"assetArchive": AssetArchive,
"assetStatus": AssetStatus,
"assetType": AssetType,
"asset": Asset,
"blockchainAddressGroup": BlockchainAddressGroup,
"blockchainAddressSource": BlockchainAddressSource,
"blockchainAddress": BlockchainAddress,
"blockchainRegistration": BlockchainRegistration,
"brokerAllocation": BrokerAllocation,
"capTable": CapTable,
"capitalDeployment": CapitalDeployment,
"chain": Chain,
"company": Company,
"contractStatus": ContractStatus,
"contract": Contract,
"country": Country,
"countryProvince": CountryProvince,
"currency": Currency,
"currencyType": CurrencyType,
"customerAddress": CustomerAddress,
"customerParty": CustomerParty,
"customerPartyAddress": CustomerPartyAddress,
"customer": Customer,
"defaultMappingField": DefaultMappingField,
"distributionAnnotation": DistributionAnnotation,
"distributionCustomField": DistributionCustomField,
"distributionPaymentStatus": DistributionPaymentStatus,
"distributionPayment": DistributionPayment,
"distributionPrice": DistributionPrice,
"distributionQualification": DistributionQualification,
"distributionStatus": DistributionStatus,
"distribution": Distribution,
"documentSharing": DocumentSharing,
"documentSharingAllowedShare": DocumentSharingAllowedShare,
"documentSharingRole": DocumentSharingRole,
"documentStatus": DocumentStatus,
"documentType": DocumentType,
"document": Document,
"emailTemplateTo": EmailTemplateTo,
"email": Email,
"holdingBlockchainAddressStatus": HoldingBlockchainAddressStatus,
"holdingBlockchainAddress": HoldingBlockchainAddress,
"holdingDocument": HoldingDocument,
"holding": Holding,
"instancedAccountInformation": InstancedAccountInformation,
"instancedAccountInformationHistory": InstancedAccountInformationHistory,
"instancedMappingField": InstancedMappingField,
"round": Round,
"integrationPartner": IntegrationPartner,
"integrationType": IntegrationType,
"integration": Integration,
"investorAccountType": InvestorAccountType,
"invitationStatus": InvitationStatus,
"issuanceEvent": IssuanceEvent,
"ledger": Ledger,
"managedAccount": ManagedAccount,
"mappedSigningTemplateQuestionSet": MappedSigningTemplateQuestionSet,
"mappedSigningTemplate": MappedSigningTemplate,
"mappingRoleType": MappingRoleType,
"mappingRole": MappingRole,
"omnibusHolding": OmnibusHolding,
"omnibusInvestor": OmnibusInvestor,
"onboardingQuestionJoin": OnboardingQuestionJoin,
"onboardingQuestionSet": OnboardingQuestionSet,
"onboardingQuestionType": OnboardingQuestionType,
"onboardingQuestion": OnboardingQuestion,
"partyRole": PartyRole,
"paymentAccount": PaymentAccount,
"paymentInstrument": PaymentInstrument,
"paymentIssuer": PaymentIssuer,
"paymentMethodType": PaymentMethodType,
"paymentMethod": PaymentMethod,
"paymentStepType": PaymentStepType,
"phoneNumberType": PhoneNumberType,
"qualificationStatus": QualificationStatus,
"registrationMethod": RegistrationMethod,
"registrationStatus": RegistrationStatus,
"restrictionCategory": RestrictionCategory,
"restrictionReason": RestrictionReason,
"auxRole": AuxRole,
"security": Security,
"securityDocument": SecurityDocument,
"securityListing": SecurityListing,
"sentSigningDocumentStatus": SentSigningDocumentStatus,
"sentSigningDocument": SentSigningDocument,
"signingAccount": SigningAccount,
"signingDocument": SigningDocument,
"signingField": SigningField,
"signingRole": SigningRole,
"signingStepType": SigningStepType,
"signingTemplate": SigningTemplate,
"stepStatus": StepStatus,
"stepType": StepType,
"step": Step,
"taRequestBlockchainLocation": TaRequestBlockchainLocation,
"taRequestStatus": TaRequestStatus,
"taRequestType": TaRequestType,
"taRequest": TaRequest,
"taxRegion": TaxRegion,
"termsOfService": TermsOfService,
"termsOfServiceType": TermsOfServiceType,
"tokenStatus": TokenStatus,
"tokenType": TokenType,
"token": Token,
"trancheBondDatum": TrancheBondDatum,
"transactionAnnotation": TransactionAnnotation,
"transactionGroupType": TransactionGroupType,
"transaction": Transaction,
"userStatus": UserStatus,
"userTermsOfService": UserTermsOfService,
"user": User,
"usersAccount": UsersAccount,
"vendorAgent": VendorAgent,
"vendorDefaultEmailPreference": VendorDefaultEmailPreference,
"vendorIntegrationStatus": VendorIntegrationStatus,
"vendorQualificationConstraint": VendorQualificationConstraint,
"vendorQualificationStepType": VendorQualificationStepType,
"vendorQualification": VendorQualification,
"vestingDuration": VestingDuration,
"vestingEvent": VestingEvent,
"vestingSchedule": VestingSchedule,
"walletAssignment": WalletAssignment,
"webhookConfiguration": WebhookConfiguration,
"webhookLevel": WebhookLevel
}
}
}
registrationMethod
Description
Reads a single RegistrationMethod using its globally unique ID.
Response
Returns a RegistrationMethod
Arguments
| Name | Description |
|---|---|
nodeId - ID!
|
The globally unique ID to be used in selecting a single RegistrationMethod. |
Example
Query
query registrationMethod($nodeId: ID!) {
registrationMethod(nodeId: $nodeId) {
nodeId
method
blockchainRegistrationsByMethod {
...BlockchainRegistrationsConnectionFragment
}
}
}
Variables
{"nodeId": 4}
Response
{
"data": {
"registrationMethod": {
"nodeId": "4",
"method": "abc123",
"blockchainRegistrationsByMethod": BlockchainRegistrationsConnection
}
}
}
registrationMethodByMethod
Response
Returns a RegistrationMethod
Arguments
| Name | Description |
|---|---|
method - String!
|
Example
Query
query registrationMethodByMethod($method: String!) {
registrationMethodByMethod(method: $method) {
nodeId
method
blockchainRegistrationsByMethod {
...BlockchainRegistrationsConnectionFragment
}
}
}
Variables
{"method": "abc123"}
Response
{
"data": {
"registrationMethodByMethod": {
"nodeId": 4,
"method": "xyz789",
"blockchainRegistrationsByMethod": BlockchainRegistrationsConnection
}
}
}
registrationStatus
Description
Reads a single RegistrationStatus using its globally unique ID.
Response
Returns a RegistrationStatus
Arguments
| Name | Description |
|---|---|
nodeId - ID!
|
The globally unique ID to be used in selecting a single RegistrationStatus. |
Example
Query
query registrationStatus($nodeId: ID!) {
registrationStatus(nodeId: $nodeId) {
nodeId
status
blockchainRegistrationsByStatus {
...BlockchainRegistrationsConnectionFragment
}
}
}
Variables
{"nodeId": 4}
Response
{
"data": {
"registrationStatus": {
"nodeId": 4,
"status": "xyz789",
"blockchainRegistrationsByStatus": BlockchainRegistrationsConnection
}
}
}
registrationStatusByStatus
Response
Returns a RegistrationStatus
Arguments
| Name | Description |
|---|---|
status - String!
|
Example
Query
query registrationStatusByStatus($status: String!) {
registrationStatusByStatus(status: $status) {
nodeId
status
blockchainRegistrationsByStatus {
...BlockchainRegistrationsConnectionFragment
}
}
}
Variables
{"status": "abc123"}
Response
{
"data": {
"registrationStatusByStatus": {
"nodeId": "4",
"status": "abc123",
"blockchainRegistrationsByStatus": BlockchainRegistrationsConnection
}
}
}
restrictionCategory
Description
Reads a single RestrictionCategory using its globally unique ID.
Response
Returns a RestrictionCategory
Arguments
| Name | Description |
|---|---|
nodeId - ID!
|
The globally unique ID to be used in selecting a single RestrictionCategory. |
Example
Query
query restrictionCategory($nodeId: ID!) {
restrictionCategory(nodeId: $nodeId) {
nodeId
category
restrictionReasonsByCategory {
...RestrictionReasonsConnectionFragment
}
}
}
Variables
{"nodeId": "4"}
Response
{
"data": {
"restrictionCategory": {
"nodeId": "4",
"category": "abc123",
"restrictionReasonsByCategory": RestrictionReasonsConnection
}
}
}
restrictionCategoryByCategory
Response
Returns a RestrictionCategory
Arguments
| Name | Description |
|---|---|
category - String!
|
Example
Query
query restrictionCategoryByCategory($category: String!) {
restrictionCategoryByCategory(category: $category) {
nodeId
category
restrictionReasonsByCategory {
...RestrictionReasonsConnectionFragment
}
}
}
Variables
{"category": "xyz789"}
Response
{
"data": {
"restrictionCategoryByCategory": {
"nodeId": "4",
"category": "xyz789",
"restrictionReasonsByCategory": RestrictionReasonsConnection
}
}
}
restrictionReason
Description
Reads a single RestrictionReason using its globally unique ID.
Response
Returns a RestrictionReason
Arguments
| Name | Description |
|---|---|
nodeId - ID!
|
The globally unique ID to be used in selecting a single RestrictionReason. |
Example
Query
query restrictionReason($nodeId: ID!) {
restrictionReason(nodeId: $nodeId) {
nodeId
id
category
reason
status
restrictionCategoryByCategory {
...RestrictionCategoryFragment
}
accountRestrictionsByReasonId {
...AccountRestrictionsConnectionFragment
}
}
}
Variables
{"nodeId": 4}
Response
{
"data": {
"restrictionReason": {
"nodeId": "4",
"id": 987,
"category": "xyz789",
"reason": "abc123",
"status": "xyz789",
"restrictionCategoryByCategory": RestrictionCategory,
"accountRestrictionsByReasonId": AccountRestrictionsConnection
}
}
}
restrictionReasonById
Response
Returns a RestrictionReason
Arguments
| Name | Description |
|---|---|
id - Int!
|
Example
Query
query restrictionReasonById($id: Int!) {
restrictionReasonById(id: $id) {
nodeId
id
category
reason
status
restrictionCategoryByCategory {
...RestrictionCategoryFragment
}
accountRestrictionsByReasonId {
...AccountRestrictionsConnectionFragment
}
}
}
Variables
{"id": 123}
Response
{
"data": {
"restrictionReasonById": {
"nodeId": 4,
"id": 123,
"category": "abc123",
"reason": "abc123",
"status": "abc123",
"restrictionCategoryByCategory": RestrictionCategory,
"accountRestrictionsByReasonId": AccountRestrictionsConnection
}
}
}
restrictionReasonByReason
Response
Returns a RestrictionReason
Arguments
| Name | Description |
|---|---|
reason - String!
|
Example
Query
query restrictionReasonByReason($reason: String!) {
restrictionReasonByReason(reason: $reason) {
nodeId
id
category
reason
status
restrictionCategoryByCategory {
...RestrictionCategoryFragment
}
accountRestrictionsByReasonId {
...AccountRestrictionsConnectionFragment
}
}
}
Variables
{"reason": "abc123"}
Response
{
"data": {
"restrictionReasonByReason": {
"nodeId": "4",
"id": 987,
"category": "xyz789",
"reason": "abc123",
"status": "xyz789",
"restrictionCategoryByCategory": RestrictionCategory,
"accountRestrictionsByReasonId": AccountRestrictionsConnection
}
}
}
role
Response
Returns a String
Example
Query
query role {
role
}
Response
{"data": {"role": "abc123"}}
round
Description
Reads a single Round using its globally unique ID.
Response
Returns a Round
Arguments
| Name | Description |
|---|---|
nodeId - ID!
|
The globally unique ID to be used in selecting a single Round. |
Example
Query
query round($nodeId: ID!) {
round(nodeId: $nodeId) {
nodeId
assetId
tokenId
name
termsUrl
price
opensOn
closesOn
status
total
blockchainAddressId
id
securityId
assetByAssetId {
...AssetFragment
}
tokenByTokenId {
...TokenFragment
}
assetStatusByStatus {
...AssetStatusFragment
}
blockchainAddressByBlockchainAddressId {
...BlockchainAddressFragment
}
securityBySecurityId {
...SecurityFragment
}
allocationsByRoundId {
...AllocationsConnectionFragment
}
brokerAllocationsByRoundId {
...BrokerAllocationsConnectionFragment
}
capitalDeploymentsByRoundId {
...CapitalDeploymentsConnectionFragment
}
issuanceEventsByAssetClassId {
...IssuanceEventsConnectionFragment
}
trancheBondDatumByRoundId {
...TrancheBondDatumFragment
}
trancheBondDataByRoundId {
...TrancheBondDataConnectionFragment
}
paymentInstrumentsByRoundId {
...PaymentInstrumentsConnectionFragment
}
vendorQualificationConstraintsByRoundId {
...VendorQualificationConstraintsConnectionFragment
}
holdings
managedUnits
totalCapitalDeployed
unitValue
}
}
Variables
{"nodeId": 4}
Response
{
"data": {
"round": {
"nodeId": 4,
"assetId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"tokenId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"name": "xyz789",
"termsUrl": "abc123",
"price": BigFloat,
"opensOn": Datetime,
"closesOn": Datetime,
"status": "abc123",
"total": BigFloat,
"blockchainAddressId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"securityId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"assetByAssetId": Asset,
"tokenByTokenId": Token,
"assetStatusByStatus": AssetStatus,
"blockchainAddressByBlockchainAddressId": BlockchainAddress,
"securityBySecurityId": Security,
"allocationsByRoundId": AllocationsConnection,
"brokerAllocationsByRoundId": BrokerAllocationsConnection,
"capitalDeploymentsByRoundId": CapitalDeploymentsConnection,
"issuanceEventsByAssetClassId": IssuanceEventsConnection,
"trancheBondDatumByRoundId": TrancheBondDatum,
"trancheBondDataByRoundId": TrancheBondDataConnection,
"paymentInstrumentsByRoundId": PaymentInstrumentsConnection,
"vendorQualificationConstraintsByRoundId": VendorQualificationConstraintsConnection,
"holdings": BigFloat,
"managedUnits": BigFloat,
"totalCapitalDeployed": BigFloat,
"unitValue": BigFloat
}
}
}
roundByBlockchainAddressId
Example
Query
query roundByBlockchainAddressId($blockchainAddressId: UUID!) {
roundByBlockchainAddressId(blockchainAddressId: $blockchainAddressId) {
nodeId
assetId
tokenId
name
termsUrl
price
opensOn
closesOn
status
total
blockchainAddressId
id
securityId
assetByAssetId {
...AssetFragment
}
tokenByTokenId {
...TokenFragment
}
assetStatusByStatus {
...AssetStatusFragment
}
blockchainAddressByBlockchainAddressId {
...BlockchainAddressFragment
}
securityBySecurityId {
...SecurityFragment
}
allocationsByRoundId {
...AllocationsConnectionFragment
}
brokerAllocationsByRoundId {
...BrokerAllocationsConnectionFragment
}
capitalDeploymentsByRoundId {
...CapitalDeploymentsConnectionFragment
}
issuanceEventsByAssetClassId {
...IssuanceEventsConnectionFragment
}
trancheBondDatumByRoundId {
...TrancheBondDatumFragment
}
trancheBondDataByRoundId {
...TrancheBondDataConnectionFragment
}
paymentInstrumentsByRoundId {
...PaymentInstrumentsConnectionFragment
}
vendorQualificationConstraintsByRoundId {
...VendorQualificationConstraintsConnectionFragment
}
holdings
managedUnits
totalCapitalDeployed
unitValue
}
}
Variables
{
"blockchainAddressId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
Response
{
"data": {
"roundByBlockchainAddressId": {
"nodeId": "4",
"assetId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"tokenId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"name": "xyz789",
"termsUrl": "xyz789",
"price": BigFloat,
"opensOn": Datetime,
"closesOn": Datetime,
"status": "abc123",
"total": BigFloat,
"blockchainAddressId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"securityId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"assetByAssetId": Asset,
"tokenByTokenId": Token,
"assetStatusByStatus": AssetStatus,
"blockchainAddressByBlockchainAddressId": BlockchainAddress,
"securityBySecurityId": Security,
"allocationsByRoundId": AllocationsConnection,
"brokerAllocationsByRoundId": BrokerAllocationsConnection,
"capitalDeploymentsByRoundId": CapitalDeploymentsConnection,
"issuanceEventsByAssetClassId": IssuanceEventsConnection,
"trancheBondDatumByRoundId": TrancheBondDatum,
"trancheBondDataByRoundId": TrancheBondDataConnection,
"paymentInstrumentsByRoundId": PaymentInstrumentsConnection,
"vendorQualificationConstraintsByRoundId": VendorQualificationConstraintsConnection,
"holdings": BigFloat,
"managedUnits": BigFloat,
"totalCapitalDeployed": BigFloat,
"unitValue": BigFloat
}
}
}
roundById
Example
Query
query roundById($id: UUID!) {
roundById(id: $id) {
nodeId
assetId
tokenId
name
termsUrl
price
opensOn
closesOn
status
total
blockchainAddressId
id
securityId
assetByAssetId {
...AssetFragment
}
tokenByTokenId {
...TokenFragment
}
assetStatusByStatus {
...AssetStatusFragment
}
blockchainAddressByBlockchainAddressId {
...BlockchainAddressFragment
}
securityBySecurityId {
...SecurityFragment
}
allocationsByRoundId {
...AllocationsConnectionFragment
}
brokerAllocationsByRoundId {
...BrokerAllocationsConnectionFragment
}
capitalDeploymentsByRoundId {
...CapitalDeploymentsConnectionFragment
}
issuanceEventsByAssetClassId {
...IssuanceEventsConnectionFragment
}
trancheBondDatumByRoundId {
...TrancheBondDatumFragment
}
trancheBondDataByRoundId {
...TrancheBondDataConnectionFragment
}
paymentInstrumentsByRoundId {
...PaymentInstrumentsConnectionFragment
}
vendorQualificationConstraintsByRoundId {
...VendorQualificationConstraintsConnectionFragment
}
holdings
managedUnits
totalCapitalDeployed
unitValue
}
}
Variables
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
Response
{
"data": {
"roundById": {
"nodeId": "4",
"assetId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"tokenId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"name": "xyz789",
"termsUrl": "abc123",
"price": BigFloat,
"opensOn": Datetime,
"closesOn": Datetime,
"status": "abc123",
"total": BigFloat,
"blockchainAddressId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"securityId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"assetByAssetId": Asset,
"tokenByTokenId": Token,
"assetStatusByStatus": AssetStatus,
"blockchainAddressByBlockchainAddressId": BlockchainAddress,
"securityBySecurityId": Security,
"allocationsByRoundId": AllocationsConnection,
"brokerAllocationsByRoundId": BrokerAllocationsConnection,
"capitalDeploymentsByRoundId": CapitalDeploymentsConnection,
"issuanceEventsByAssetClassId": IssuanceEventsConnection,
"trancheBondDatumByRoundId": TrancheBondDatum,
"trancheBondDataByRoundId": TrancheBondDataConnection,
"paymentInstrumentsByRoundId": PaymentInstrumentsConnection,
"vendorQualificationConstraintsByRoundId": VendorQualificationConstraintsConnection,
"holdings": BigFloat,
"managedUnits": BigFloat,
"totalCapitalDeployed": BigFloat,
"unitValue": BigFloat
}
}
}
roundByTokenId
Example
Query
query roundByTokenId($tokenId: UUID!) {
roundByTokenId(tokenId: $tokenId) {
nodeId
assetId
tokenId
name
termsUrl
price
opensOn
closesOn
status
total
blockchainAddressId
id
securityId
assetByAssetId {
...AssetFragment
}
tokenByTokenId {
...TokenFragment
}
assetStatusByStatus {
...AssetStatusFragment
}
blockchainAddressByBlockchainAddressId {
...BlockchainAddressFragment
}
securityBySecurityId {
...SecurityFragment
}
allocationsByRoundId {
...AllocationsConnectionFragment
}
brokerAllocationsByRoundId {
...BrokerAllocationsConnectionFragment
}
capitalDeploymentsByRoundId {
...CapitalDeploymentsConnectionFragment
}
issuanceEventsByAssetClassId {
...IssuanceEventsConnectionFragment
}
trancheBondDatumByRoundId {
...TrancheBondDatumFragment
}
trancheBondDataByRoundId {
...TrancheBondDataConnectionFragment
}
paymentInstrumentsByRoundId {
...PaymentInstrumentsConnectionFragment
}
vendorQualificationConstraintsByRoundId {
...VendorQualificationConstraintsConnectionFragment
}
holdings
managedUnits
totalCapitalDeployed
unitValue
}
}
Variables
{
"tokenId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
Response
{
"data": {
"roundByTokenId": {
"nodeId": "4",
"assetId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"tokenId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"name": "abc123",
"termsUrl": "abc123",
"price": BigFloat,
"opensOn": Datetime,
"closesOn": Datetime,
"status": "xyz789",
"total": BigFloat,
"blockchainAddressId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"securityId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"assetByAssetId": Asset,
"tokenByTokenId": Token,
"assetStatusByStatus": AssetStatus,
"blockchainAddressByBlockchainAddressId": BlockchainAddress,
"securityBySecurityId": Security,
"allocationsByRoundId": AllocationsConnection,
"brokerAllocationsByRoundId": BrokerAllocationsConnection,
"capitalDeploymentsByRoundId": CapitalDeploymentsConnection,
"issuanceEventsByAssetClassId": IssuanceEventsConnection,
"trancheBondDatumByRoundId": TrancheBondDatum,
"trancheBondDataByRoundId": TrancheBondDataConnection,
"paymentInstrumentsByRoundId": PaymentInstrumentsConnection,
"vendorQualificationConstraintsByRoundId": VendorQualificationConstraintsConnection,
"holdings": BigFloat,
"managedUnits": BigFloat,
"totalCapitalDeployed": BigFloat,
"unitValue": BigFloat
}
}
}
security
Description
Reads a single Security using its globally unique ID.
Response
Returns a Security
Arguments
| Name | Description |
|---|---|
nodeId - ID!
|
The globally unique ID to be used in selecting a single Security. |
Example
Query
query security($nodeId: ID!) {
security(nodeId: $nodeId) {
nodeId
id
issuerId
unitValue
name
ticker
total
blockchainAddressId
taId
accountByIssuerId {
...AccountFragment
}
blockchainAddressByBlockchainAddressId {
...BlockchainAddressFragment
}
accountByTaId {
...AccountFragment
}
roundsBySecurityId {
...RoundsConnectionFragment
}
holdingsBySecurityId {
...HoldingsConnectionFragment
}
issuanceEventsBySecurityId {
...IssuanceEventsConnectionFragment
}
securityListingBySecurityId {
...SecurityListingFragment
}
securityListingsBySecurityId {
...SecurityListingsConnectionFragment
}
securityDocumentsBySecurityId {
...SecurityDocumentsConnectionFragment
}
omnibusHoldingsBySecurityId {
...OmnibusHoldingsConnectionFragment
}
omnibusInvestorsBySecurityId {
...OmnibusInvestorsConnectionFragment
}
stagedBalanceTransfersBySecurityId {
...StagedBalanceTransfersConnectionFragment
}
stagedTransfersBySecurityId {
...StagedTransfersConnectionFragment
}
tradesBySecurityId {
...TradesConnectionFragment
}
transfersBySecurityId {
...TransfersConnectionFragment
}
}
}
Variables
{"nodeId": 4}
Response
{
"data": {
"security": {
"nodeId": "4",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"issuerId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"unitValue": BigFloat,
"name": "xyz789",
"ticker": "abc123",
"total": BigFloat,
"blockchainAddressId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"taId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountByIssuerId": Account,
"blockchainAddressByBlockchainAddressId": BlockchainAddress,
"accountByTaId": Account,
"roundsBySecurityId": RoundsConnection,
"holdingsBySecurityId": HoldingsConnection,
"issuanceEventsBySecurityId": IssuanceEventsConnection,
"securityListingBySecurityId": SecurityListing,
"securityListingsBySecurityId": SecurityListingsConnection,
"securityDocumentsBySecurityId": SecurityDocumentsConnection,
"omnibusHoldingsBySecurityId": OmnibusHoldingsConnection,
"omnibusInvestorsBySecurityId": OmnibusInvestorsConnection,
"stagedBalanceTransfersBySecurityId": StagedBalanceTransfersConnection,
"stagedTransfersBySecurityId": StagedTransfersConnection,
"tradesBySecurityId": TradesConnection,
"transfersBySecurityId": TransfersConnection
}
}
}
securityByBlockchainAddressId
Example
Query
query securityByBlockchainAddressId($blockchainAddressId: UUID!) {
securityByBlockchainAddressId(blockchainAddressId: $blockchainAddressId) {
nodeId
id
issuerId
unitValue
name
ticker
total
blockchainAddressId
taId
accountByIssuerId {
...AccountFragment
}
blockchainAddressByBlockchainAddressId {
...BlockchainAddressFragment
}
accountByTaId {
...AccountFragment
}
roundsBySecurityId {
...RoundsConnectionFragment
}
holdingsBySecurityId {
...HoldingsConnectionFragment
}
issuanceEventsBySecurityId {
...IssuanceEventsConnectionFragment
}
securityListingBySecurityId {
...SecurityListingFragment
}
securityListingsBySecurityId {
...SecurityListingsConnectionFragment
}
securityDocumentsBySecurityId {
...SecurityDocumentsConnectionFragment
}
omnibusHoldingsBySecurityId {
...OmnibusHoldingsConnectionFragment
}
omnibusInvestorsBySecurityId {
...OmnibusInvestorsConnectionFragment
}
stagedBalanceTransfersBySecurityId {
...StagedBalanceTransfersConnectionFragment
}
stagedTransfersBySecurityId {
...StagedTransfersConnectionFragment
}
tradesBySecurityId {
...TradesConnectionFragment
}
transfersBySecurityId {
...TransfersConnectionFragment
}
}
}
Variables
{
"blockchainAddressId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
Response
{
"data": {
"securityByBlockchainAddressId": {
"nodeId": 4,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"issuerId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"unitValue": BigFloat,
"name": "abc123",
"ticker": "abc123",
"total": BigFloat,
"blockchainAddressId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"taId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountByIssuerId": Account,
"blockchainAddressByBlockchainAddressId": BlockchainAddress,
"accountByTaId": Account,
"roundsBySecurityId": RoundsConnection,
"holdingsBySecurityId": HoldingsConnection,
"issuanceEventsBySecurityId": IssuanceEventsConnection,
"securityListingBySecurityId": SecurityListing,
"securityListingsBySecurityId": SecurityListingsConnection,
"securityDocumentsBySecurityId": SecurityDocumentsConnection,
"omnibusHoldingsBySecurityId": OmnibusHoldingsConnection,
"omnibusInvestorsBySecurityId": OmnibusInvestorsConnection,
"stagedBalanceTransfersBySecurityId": StagedBalanceTransfersConnection,
"stagedTransfersBySecurityId": StagedTransfersConnection,
"tradesBySecurityId": TradesConnection,
"transfersBySecurityId": TransfersConnection
}
}
}
securityById
Example
Query
query securityById($id: UUID!) {
securityById(id: $id) {
nodeId
id
issuerId
unitValue
name
ticker
total
blockchainAddressId
taId
accountByIssuerId {
...AccountFragment
}
blockchainAddressByBlockchainAddressId {
...BlockchainAddressFragment
}
accountByTaId {
...AccountFragment
}
roundsBySecurityId {
...RoundsConnectionFragment
}
holdingsBySecurityId {
...HoldingsConnectionFragment
}
issuanceEventsBySecurityId {
...IssuanceEventsConnectionFragment
}
securityListingBySecurityId {
...SecurityListingFragment
}
securityListingsBySecurityId {
...SecurityListingsConnectionFragment
}
securityDocumentsBySecurityId {
...SecurityDocumentsConnectionFragment
}
omnibusHoldingsBySecurityId {
...OmnibusHoldingsConnectionFragment
}
omnibusInvestorsBySecurityId {
...OmnibusInvestorsConnectionFragment
}
stagedBalanceTransfersBySecurityId {
...StagedBalanceTransfersConnectionFragment
}
stagedTransfersBySecurityId {
...StagedTransfersConnectionFragment
}
tradesBySecurityId {
...TradesConnectionFragment
}
transfersBySecurityId {
...TransfersConnectionFragment
}
}
}
Variables
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
Response
{
"data": {
"securityById": {
"nodeId": 4,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"issuerId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"unitValue": BigFloat,
"name": "abc123",
"ticker": "abc123",
"total": BigFloat,
"blockchainAddressId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"taId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountByIssuerId": Account,
"blockchainAddressByBlockchainAddressId": BlockchainAddress,
"accountByTaId": Account,
"roundsBySecurityId": RoundsConnection,
"holdingsBySecurityId": HoldingsConnection,
"issuanceEventsBySecurityId": IssuanceEventsConnection,
"securityListingBySecurityId": SecurityListing,
"securityListingsBySecurityId": SecurityListingsConnection,
"securityDocumentsBySecurityId": SecurityDocumentsConnection,
"omnibusHoldingsBySecurityId": OmnibusHoldingsConnection,
"omnibusInvestorsBySecurityId": OmnibusInvestorsConnection,
"stagedBalanceTransfersBySecurityId": StagedBalanceTransfersConnection,
"stagedTransfersBySecurityId": StagedTransfersConnection,
"tradesBySecurityId": TradesConnection,
"transfersBySecurityId": TransfersConnection
}
}
}
securityDocument
Description
Reads a single SecurityDocument using its globally unique ID.
Response
Returns a SecurityDocument
Arguments
| Name | Description |
|---|---|
nodeId - ID!
|
The globally unique ID to be used in selecting a single SecurityDocument. |
Example
Query
query securityDocument($nodeId: ID!) {
securityDocument(nodeId: $nodeId) {
nodeId
id
documentId
securityId
createdOn
documentByDocumentId {
...DocumentFragment
}
securityBySecurityId {
...SecurityFragment
}
}
}
Variables
{"nodeId": "4"}
Response
{
"data": {
"securityDocument": {
"nodeId": 4,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"documentId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"securityId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"createdOn": Datetime,
"documentByDocumentId": Document,
"securityBySecurityId": Security
}
}
}
securityDocumentByDocumentIdAndSecurityId
Response
Returns a SecurityDocument
Example
Query
query securityDocumentByDocumentIdAndSecurityId(
$documentId: UUID!,
$securityId: UUID!
) {
securityDocumentByDocumentIdAndSecurityId(
documentId: $documentId,
securityId: $securityId
) {
nodeId
id
documentId
securityId
createdOn
documentByDocumentId {
...DocumentFragment
}
securityBySecurityId {
...SecurityFragment
}
}
}
Variables
{
"documentId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"securityId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
Response
{
"data": {
"securityDocumentByDocumentIdAndSecurityId": {
"nodeId": 4,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"documentId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"securityId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"createdOn": Datetime,
"documentByDocumentId": Document,
"securityBySecurityId": Security
}
}
}
securityDocumentById
Response
Returns a SecurityDocument
Arguments
| Name | Description |
|---|---|
id - UUID!
|
Example
Query
query securityDocumentById($id: UUID!) {
securityDocumentById(id: $id) {
nodeId
id
documentId
securityId
createdOn
documentByDocumentId {
...DocumentFragment
}
securityBySecurityId {
...SecurityFragment
}
}
}
Variables
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
Response
{
"data": {
"securityDocumentById": {
"nodeId": 4,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"documentId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"securityId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"createdOn": Datetime,
"documentByDocumentId": Document,
"securityBySecurityId": Security
}
}
}
securityListing
Description
Reads a single SecurityListing using its globally unique ID.
Response
Returns a SecurityListing
Arguments
| Name | Description |
|---|---|
nodeId - ID!
|
The globally unique ID to be used in selecting a single SecurityListing. |
Example
Query
query securityListing($nodeId: ID!) {
securityListing(nodeId: $nodeId) {
nodeId
id
securityId
issuerId
atsId
status
securityBySecurityId {
...SecurityFragment
}
accountByIssuerId {
...AccountFragment
}
accountByAtsId {
...AccountFragment
}
invitationStatusByStatus {
...InvitationStatusFragment
}
}
}
Variables
{"nodeId": 4}
Response
{
"data": {
"securityListing": {
"nodeId": 4,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"securityId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"issuerId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"atsId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"status": "abc123",
"securityBySecurityId": Security,
"accountByIssuerId": Account,
"accountByAtsId": Account,
"invitationStatusByStatus": InvitationStatus
}
}
}
securityListingById
Response
Returns a SecurityListing
Arguments
| Name | Description |
|---|---|
id - UUID!
|
Example
Query
query securityListingById($id: UUID!) {
securityListingById(id: $id) {
nodeId
id
securityId
issuerId
atsId
status
securityBySecurityId {
...SecurityFragment
}
accountByIssuerId {
...AccountFragment
}
accountByAtsId {
...AccountFragment
}
invitationStatusByStatus {
...InvitationStatusFragment
}
}
}
Variables
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
Response
{
"data": {
"securityListingById": {
"nodeId": "4",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"securityId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"issuerId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"atsId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"status": "xyz789",
"securityBySecurityId": Security,
"accountByIssuerId": Account,
"accountByAtsId": Account,
"invitationStatusByStatus": InvitationStatus
}
}
}
securityListingBySecurityId
Response
Returns a SecurityListing
Arguments
| Name | Description |
|---|---|
securityId - UUID!
|
Example
Query
query securityListingBySecurityId($securityId: UUID!) {
securityListingBySecurityId(securityId: $securityId) {
nodeId
id
securityId
issuerId
atsId
status
securityBySecurityId {
...SecurityFragment
}
accountByIssuerId {
...AccountFragment
}
accountByAtsId {
...AccountFragment
}
invitationStatusByStatus {
...InvitationStatusFragment
}
}
}
Variables
{
"securityId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
Response
{
"data": {
"securityListingBySecurityId": {
"nodeId": "4",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"securityId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"issuerId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"atsId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"status": "abc123",
"securityBySecurityId": Security,
"accountByIssuerId": Account,
"accountByAtsId": Account,
"invitationStatusByStatus": InvitationStatus
}
}
}
sentSigningDocument
Description
Reads a single SentSigningDocument using its globally unique ID.
Response
Returns a SentSigningDocument
Arguments
| Name | Description |
|---|---|
nodeId - ID!
|
The globally unique ID to be used in selecting a single SentSigningDocument. |
Example
Query
query sentSigningDocument($nodeId: ID!) {
sentSigningDocument(nodeId: $nodeId) {
nodeId
id
mappedSigningTemplateId
stepId
sentTo
status
documentUri
documentId
sentOn
completeOn
mappedSigningTemplateByMappedSigningTemplateId {
...MappedSigningTemplateFragment
}
stepByStepId {
...StepFragment
}
accountBySentTo {
...AccountFragment
}
sentSigningDocumentStatusByStatus {
...SentSigningDocumentStatusFragment
}
}
}
Variables
{"nodeId": "4"}
Response
{
"data": {
"sentSigningDocument": {
"nodeId": "4",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"mappedSigningTemplateId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"stepId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"sentTo": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"status": "xyz789",
"documentUri": "xyz789",
"documentId": "xyz789",
"sentOn": Datetime,
"completeOn": Datetime,
"mappedSigningTemplateByMappedSigningTemplateId": MappedSigningTemplate,
"stepByStepId": Step,
"accountBySentTo": Account,
"sentSigningDocumentStatusByStatus": SentSigningDocumentStatus
}
}
}
sentSigningDocumentById
Response
Returns a SentSigningDocument
Arguments
| Name | Description |
|---|---|
id - UUID!
|
Example
Query
query sentSigningDocumentById($id: UUID!) {
sentSigningDocumentById(id: $id) {
nodeId
id
mappedSigningTemplateId
stepId
sentTo
status
documentUri
documentId
sentOn
completeOn
mappedSigningTemplateByMappedSigningTemplateId {
...MappedSigningTemplateFragment
}
stepByStepId {
...StepFragment
}
accountBySentTo {
...AccountFragment
}
sentSigningDocumentStatusByStatus {
...SentSigningDocumentStatusFragment
}
}
}
Variables
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
Response
{
"data": {
"sentSigningDocumentById": {
"nodeId": 4,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"mappedSigningTemplateId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"stepId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"sentTo": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"status": "xyz789",
"documentUri": "xyz789",
"documentId": "abc123",
"sentOn": Datetime,
"completeOn": Datetime,
"mappedSigningTemplateByMappedSigningTemplateId": MappedSigningTemplate,
"stepByStepId": Step,
"accountBySentTo": Account,
"sentSigningDocumentStatusByStatus": SentSigningDocumentStatus
}
}
}
sentSigningDocumentByMappedSigningTemplateIdAndDocumentId
Response
Returns a SentSigningDocument
Example
Query
query sentSigningDocumentByMappedSigningTemplateIdAndDocumentId(
$mappedSigningTemplateId: UUID!,
$documentId: String!
) {
sentSigningDocumentByMappedSigningTemplateIdAndDocumentId(
mappedSigningTemplateId: $mappedSigningTemplateId,
documentId: $documentId
) {
nodeId
id
mappedSigningTemplateId
stepId
sentTo
status
documentUri
documentId
sentOn
completeOn
mappedSigningTemplateByMappedSigningTemplateId {
...MappedSigningTemplateFragment
}
stepByStepId {
...StepFragment
}
accountBySentTo {
...AccountFragment
}
sentSigningDocumentStatusByStatus {
...SentSigningDocumentStatusFragment
}
}
}
Variables
{
"mappedSigningTemplateId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"documentId": "xyz789"
}
Response
{
"data": {
"sentSigningDocumentByMappedSigningTemplateIdAndDocumentId": {
"nodeId": "4",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"mappedSigningTemplateId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"stepId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"sentTo": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"status": "abc123",
"documentUri": "xyz789",
"documentId": "xyz789",
"sentOn": Datetime,
"completeOn": Datetime,
"mappedSigningTemplateByMappedSigningTemplateId": MappedSigningTemplate,
"stepByStepId": Step,
"accountBySentTo": Account,
"sentSigningDocumentStatusByStatus": SentSigningDocumentStatus
}
}
}
sentSigningDocumentStatus
Description
Reads a single SentSigningDocumentStatus using its globally unique ID.
Response
Returns a SentSigningDocumentStatus
Arguments
| Name | Description |
|---|---|
nodeId - ID!
|
The globally unique ID to be used in selecting a single SentSigningDocumentStatus. |
Example
Query
query sentSigningDocumentStatus($nodeId: ID!) {
sentSigningDocumentStatus(nodeId: $nodeId) {
nodeId
status
sentSigningDocumentsByStatus {
...SentSigningDocumentsConnectionFragment
}
}
}
Variables
{"nodeId": 4}
Response
{
"data": {
"sentSigningDocumentStatus": {
"nodeId": "4",
"status": "xyz789",
"sentSigningDocumentsByStatus": SentSigningDocumentsConnection
}
}
}
sentSigningDocumentStatusByStatus
Response
Returns a SentSigningDocumentStatus
Arguments
| Name | Description |
|---|---|
status - String!
|
Example
Query
query sentSigningDocumentStatusByStatus($status: String!) {
sentSigningDocumentStatusByStatus(status: $status) {
nodeId
status
sentSigningDocumentsByStatus {
...SentSigningDocumentsConnectionFragment
}
}
}
Variables
{"status": "xyz789"}
Response
{
"data": {
"sentSigningDocumentStatusByStatus": {
"nodeId": 4,
"status": "xyz789",
"sentSigningDocumentsByStatus": SentSigningDocumentsConnection
}
}
}
signingAccount
Description
Reads a single SigningAccount using its globally unique ID.
Response
Returns a SigningAccount
Arguments
| Name | Description |
|---|---|
nodeId - ID!
|
The globally unique ID to be used in selecting a single SigningAccount. |
Example
Query
query signingAccount($nodeId: ID!) {
signingAccount(nodeId: $nodeId) {
nodeId
id
accountId
integrationId
name
syncedOn
accountByAccountId {
...AccountFragment
}
integrationByIntegrationId {
...IntegrationFragment
}
signingTemplatesBySigningAccountId {
...SigningTemplatesConnectionFragment
}
}
}
Variables
{"nodeId": "4"}
Response
{
"data": {
"signingAccount": {
"nodeId": 4,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"integrationId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"name": "abc123",
"syncedOn": Datetime,
"accountByAccountId": Account,
"integrationByIntegrationId": Integration,
"signingTemplatesBySigningAccountId": SigningTemplatesConnection
}
}
}
signingAccountById
Response
Returns a SigningAccount
Arguments
| Name | Description |
|---|---|
id - UUID!
|
Example
Query
query signingAccountById($id: UUID!) {
signingAccountById(id: $id) {
nodeId
id
accountId
integrationId
name
syncedOn
accountByAccountId {
...AccountFragment
}
integrationByIntegrationId {
...IntegrationFragment
}
signingTemplatesBySigningAccountId {
...SigningTemplatesConnectionFragment
}
}
}
Variables
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
Response
{
"data": {
"signingAccountById": {
"nodeId": "4",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"integrationId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"name": "abc123",
"syncedOn": Datetime,
"accountByAccountId": Account,
"integrationByIntegrationId": Integration,
"signingTemplatesBySigningAccountId": SigningTemplatesConnection
}
}
}
signingDocument
Description
Reads a single SigningDocument using its globally unique ID.
Response
Returns a SigningDocument
Arguments
| Name | Description |
|---|---|
nodeId - ID!
|
The globally unique ID to be used in selecting a single SigningDocument. |
Example
Query
query signingDocument($nodeId: ID!) {
signingDocument(nodeId: $nodeId) {
nodeId
id
mappedSigningTemplateId
name
documentUri
mappedSigningTemplateByMappedSigningTemplateId {
...MappedSigningTemplateFragment
}
signingFieldsBySigningDocumentId {
...SigningFieldsConnectionFragment
}
}
}
Variables
{"nodeId": 4}
Response
{
"data": {
"signingDocument": {
"nodeId": 4,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"mappedSigningTemplateId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"name": "abc123",
"documentUri": "abc123",
"mappedSigningTemplateByMappedSigningTemplateId": MappedSigningTemplate,
"signingFieldsBySigningDocumentId": SigningFieldsConnection
}
}
}
signingDocumentById
Response
Returns a SigningDocument
Arguments
| Name | Description |
|---|---|
id - UUID!
|
Example
Query
query signingDocumentById($id: UUID!) {
signingDocumentById(id: $id) {
nodeId
id
mappedSigningTemplateId
name
documentUri
mappedSigningTemplateByMappedSigningTemplateId {
...MappedSigningTemplateFragment
}
signingFieldsBySigningDocumentId {
...SigningFieldsConnectionFragment
}
}
}
Variables
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
Response
{
"data": {
"signingDocumentById": {
"nodeId": 4,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"mappedSigningTemplateId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"name": "abc123",
"documentUri": "abc123",
"mappedSigningTemplateByMappedSigningTemplateId": MappedSigningTemplate,
"signingFieldsBySigningDocumentId": SigningFieldsConnection
}
}
}
signingField
Description
Reads a single SigningField using its globally unique ID.
Response
Returns a SigningField
Arguments
| Name | Description |
|---|---|
nodeId - ID!
|
The globally unique ID to be used in selecting a single SigningField. |
Example
Query
query signingField($nodeId: ID!) {
signingField(nodeId: $nodeId) {
nodeId
id
mappedSigningTemplateId
signingDocumentId
signingRoleId
type
name
value
valueVariable
mapTo
mappedSigningTemplateByMappedSigningTemplateId {
...MappedSigningTemplateFragment
}
signingDocumentBySigningDocumentId {
...SigningDocumentFragment
}
signingRoleBySigningRoleId {
...SigningRoleFragment
}
mappingFieldByMapTo {
...MappingFieldFragment
}
}
}
Variables
{"nodeId": 4}
Response
{
"data": {
"signingField": {
"nodeId": 4,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"mappedSigningTemplateId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"signingDocumentId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"signingRoleId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"type": "xyz789",
"name": "xyz789",
"value": "abc123",
"valueVariable": "abc123",
"mapTo": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"mappedSigningTemplateByMappedSigningTemplateId": MappedSigningTemplate,
"signingDocumentBySigningDocumentId": SigningDocument,
"signingRoleBySigningRoleId": SigningRole,
"mappingFieldByMapTo": MappingField
}
}
}
signingFieldById
Response
Returns a SigningField
Arguments
| Name | Description |
|---|---|
id - UUID!
|
Example
Query
query signingFieldById($id: UUID!) {
signingFieldById(id: $id) {
nodeId
id
mappedSigningTemplateId
signingDocumentId
signingRoleId
type
name
value
valueVariable
mapTo
mappedSigningTemplateByMappedSigningTemplateId {
...MappedSigningTemplateFragment
}
signingDocumentBySigningDocumentId {
...SigningDocumentFragment
}
signingRoleBySigningRoleId {
...SigningRoleFragment
}
mappingFieldByMapTo {
...MappingFieldFragment
}
}
}
Variables
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
Response
{
"data": {
"signingFieldById": {
"nodeId": 4,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"mappedSigningTemplateId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"signingDocumentId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"signingRoleId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"type": "abc123",
"name": "abc123",
"value": "abc123",
"valueVariable": "xyz789",
"mapTo": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"mappedSigningTemplateByMappedSigningTemplateId": MappedSigningTemplate,
"signingDocumentBySigningDocumentId": SigningDocument,
"signingRoleBySigningRoleId": SigningRole,
"mappingFieldByMapTo": MappingField
}
}
}
signingRole
Description
Reads a single SigningRole using its globally unique ID.
Response
Returns a SigningRole
Arguments
| Name | Description |
|---|---|
nodeId - ID!
|
The globally unique ID to be used in selecting a single SigningRole. |
Example
Query
query signingRole($nodeId: ID!) {
signingRole(nodeId: $nodeId) {
nodeId
id
mappedSigningTemplateId
mapTo
type
name
toEmail
toName
mappedSigningTemplateByMappedSigningTemplateId {
...MappedSigningTemplateFragment
}
mappingRoleByMapTo {
...MappingRoleFragment
}
mappingRoleTypeByType {
...MappingRoleTypeFragment
}
signingFieldsBySigningRoleId {
...SigningFieldsConnectionFragment
}
}
}
Variables
{"nodeId": "4"}
Response
{
"data": {
"signingRole": {
"nodeId": 4,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"mappedSigningTemplateId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"mapTo": "xyz789",
"type": "abc123",
"name": "xyz789",
"toEmail": "abc123",
"toName": "xyz789",
"mappedSigningTemplateByMappedSigningTemplateId": MappedSigningTemplate,
"mappingRoleByMapTo": MappingRole,
"mappingRoleTypeByType": MappingRoleType,
"signingFieldsBySigningRoleId": SigningFieldsConnection
}
}
}
signingRoleById
Response
Returns a SigningRole
Arguments
| Name | Description |
|---|---|
id - UUID!
|
Example
Query
query signingRoleById($id: UUID!) {
signingRoleById(id: $id) {
nodeId
id
mappedSigningTemplateId
mapTo
type
name
toEmail
toName
mappedSigningTemplateByMappedSigningTemplateId {
...MappedSigningTemplateFragment
}
mappingRoleByMapTo {
...MappingRoleFragment
}
mappingRoleTypeByType {
...MappingRoleTypeFragment
}
signingFieldsBySigningRoleId {
...SigningFieldsConnectionFragment
}
}
}
Variables
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
Response
{
"data": {
"signingRoleById": {
"nodeId": 4,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"mappedSigningTemplateId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"mapTo": "abc123",
"type": "xyz789",
"name": "xyz789",
"toEmail": "abc123",
"toName": "abc123",
"mappedSigningTemplateByMappedSigningTemplateId": MappedSigningTemplate,
"mappingRoleByMapTo": MappingRole,
"mappingRoleTypeByType": MappingRoleType,
"signingFieldsBySigningRoleId": SigningFieldsConnection
}
}
}
signingStepType
Description
Reads a single SigningStepType using its globally unique ID.
Response
Returns a SigningStepType
Arguments
| Name | Description |
|---|---|
nodeId - ID!
|
The globally unique ID to be used in selecting a single SigningStepType. |
Example
Query
query signingStepType($nodeId: ID!) {
signingStepType(nodeId: $nodeId) {
nodeId
type
mappedSigningTemplatesByQualificationStepType {
...MappedSigningTemplatesConnectionFragment
}
}
}
Variables
{"nodeId": "4"}
Response
{
"data": {
"signingStepType": {
"nodeId": "4",
"type": "abc123",
"mappedSigningTemplatesByQualificationStepType": MappedSigningTemplatesConnection
}
}
}
signingStepTypeByType
Response
Returns a SigningStepType
Arguments
| Name | Description |
|---|---|
type - String!
|
Example
Query
query signingStepTypeByType($type: String!) {
signingStepTypeByType(type: $type) {
nodeId
type
mappedSigningTemplatesByQualificationStepType {
...MappedSigningTemplatesConnectionFragment
}
}
}
Variables
{"type": "xyz789"}
Response
{
"data": {
"signingStepTypeByType": {
"nodeId": 4,
"type": "xyz789",
"mappedSigningTemplatesByQualificationStepType": MappedSigningTemplatesConnection
}
}
}
signingTemplate
Description
Reads a single SigningTemplate using its globally unique ID.
Response
Returns a SigningTemplate
Arguments
| Name | Description |
|---|---|
nodeId - ID!
|
The globally unique ID to be used in selecting a single SigningTemplate. |
Example
Query
query signingTemplate($nodeId: ID!) {
signingTemplate(nodeId: $nodeId) {
nodeId
id
signingAccountId
accountId
name
description
updatedOn
syncedOn
deleted
templateUri
signingAccountBySigningAccountId {
...SigningAccountFragment
}
accountByAccountId {
...AccountFragment
}
mappedSigningTemplatesBySigningTemplateId {
...MappedSigningTemplatesConnectionFragment
}
}
}
Variables
{"nodeId": "4"}
Response
{
"data": {
"signingTemplate": {
"nodeId": "4",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"signingAccountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"name": "abc123",
"description": "xyz789",
"updatedOn": Datetime,
"syncedOn": Datetime,
"deleted": true,
"templateUri": "abc123",
"signingAccountBySigningAccountId": SigningAccount,
"accountByAccountId": Account,
"mappedSigningTemplatesBySigningTemplateId": MappedSigningTemplatesConnection
}
}
}
signingTemplateById
Response
Returns a SigningTemplate
Arguments
| Name | Description |
|---|---|
id - UUID!
|
Example
Query
query signingTemplateById($id: UUID!) {
signingTemplateById(id: $id) {
nodeId
id
signingAccountId
accountId
name
description
updatedOn
syncedOn
deleted
templateUri
signingAccountBySigningAccountId {
...SigningAccountFragment
}
accountByAccountId {
...AccountFragment
}
mappedSigningTemplatesBySigningTemplateId {
...MappedSigningTemplatesConnectionFragment
}
}
}
Variables
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
Response
{
"data": {
"signingTemplateById": {
"nodeId": "4",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"signingAccountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"name": "abc123",
"description": "xyz789",
"updatedOn": Datetime,
"syncedOn": Datetime,
"deleted": false,
"templateUri": "abc123",
"signingAccountBySigningAccountId": SigningAccount,
"accountByAccountId": Account,
"mappedSigningTemplatesBySigningTemplateId": MappedSigningTemplatesConnection
}
}
}
step
Description
Reads a single Step using its globally unique ID.
Response
Returns a Step
Arguments
| Name | Description |
|---|---|
nodeId - ID!
|
The globally unique ID to be used in selecting a single Step. |
Example
Query
query step($nodeId: ID!) {
step(nodeId: $nodeId) {
nodeId
id
ownedBy
executeBy
status
type
schema
inputData
outputData
valid
retry
templateId
rootStepId
completeState
state
createdOn
accountByOwnedBy {
...AccountFragment
}
accountByExecuteBy {
...AccountFragment
}
stepStatusByStatus {
...StepStatusFragment
}
stepTypeByType {
...StepTypeFragment
}
distributionByStepId {
...DistributionFragment
}
distributionsByStepId {
...DistributionsConnectionFragment
}
accountIntegrationByStepId {
...AccountIntegrationFragment
}
accountIntegrationsByStepId {
...AccountIntegrationsConnectionFragment
}
distributionQualificationsByStepId {
...DistributionQualificationsConnectionFragment
}
mappedSigningTemplateByStepId {
...MappedSigningTemplateFragment
}
mappedSigningTemplatesByStepId {
...MappedSigningTemplatesConnectionFragment
}
sentSigningDocumentsByStepId {
...SentSigningDocumentsConnectionFragment
}
paymentIssuersByStepId {
...PaymentIssuersConnectionFragment
}
paymentInstrumentsByStepId {
...PaymentInstrumentsConnectionFragment
}
currentStep {
...CurrentStepFragment
}
renderAttribute
shortSteps {
...ShortStepsConnectionFragment
}
}
}
Variables
{"nodeId": 4}
Response
{
"data": {
"step": {
"nodeId": "4",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"ownedBy": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"executeBy": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"status": "xyz789",
"type": "abc123",
"schema": {},
"inputData": {},
"outputData": {},
"valid": false,
"retry": 987,
"templateId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"rootStepId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"completeState": BitString,
"state": BitString,
"createdOn": Datetime,
"accountByOwnedBy": Account,
"accountByExecuteBy": Account,
"stepStatusByStatus": StepStatus,
"stepTypeByType": StepType,
"distributionByStepId": Distribution,
"distributionsByStepId": DistributionsConnection,
"accountIntegrationByStepId": AccountIntegration,
"accountIntegrationsByStepId": AccountIntegrationsConnection,
"distributionQualificationsByStepId": DistributionQualificationsConnection,
"mappedSigningTemplateByStepId": MappedSigningTemplate,
"mappedSigningTemplatesByStepId": MappedSigningTemplatesConnection,
"sentSigningDocumentsByStepId": SentSigningDocumentsConnection,
"paymentIssuersByStepId": PaymentIssuersConnection,
"paymentInstrumentsByStepId": PaymentInstrumentsConnection,
"currentStep": CurrentStep,
"renderAttribute": {},
"shortSteps": ShortStepsConnection
}
}
}
stepById
Example
Query
query stepById($id: UUID!) {
stepById(id: $id) {
nodeId
id
ownedBy
executeBy
status
type
schema
inputData
outputData
valid
retry
templateId
rootStepId
completeState
state
createdOn
accountByOwnedBy {
...AccountFragment
}
accountByExecuteBy {
...AccountFragment
}
stepStatusByStatus {
...StepStatusFragment
}
stepTypeByType {
...StepTypeFragment
}
distributionByStepId {
...DistributionFragment
}
distributionsByStepId {
...DistributionsConnectionFragment
}
accountIntegrationByStepId {
...AccountIntegrationFragment
}
accountIntegrationsByStepId {
...AccountIntegrationsConnectionFragment
}
distributionQualificationsByStepId {
...DistributionQualificationsConnectionFragment
}
mappedSigningTemplateByStepId {
...MappedSigningTemplateFragment
}
mappedSigningTemplatesByStepId {
...MappedSigningTemplatesConnectionFragment
}
sentSigningDocumentsByStepId {
...SentSigningDocumentsConnectionFragment
}
paymentIssuersByStepId {
...PaymentIssuersConnectionFragment
}
paymentInstrumentsByStepId {
...PaymentInstrumentsConnectionFragment
}
currentStep {
...CurrentStepFragment
}
renderAttribute
shortSteps {
...ShortStepsConnectionFragment
}
}
}
Variables
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
Response
{
"data": {
"stepById": {
"nodeId": "4",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"ownedBy": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"executeBy": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"status": "xyz789",
"type": "abc123",
"schema": {},
"inputData": {},
"outputData": {},
"valid": true,
"retry": 123,
"templateId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"rootStepId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"completeState": BitString,
"state": BitString,
"createdOn": Datetime,
"accountByOwnedBy": Account,
"accountByExecuteBy": Account,
"stepStatusByStatus": StepStatus,
"stepTypeByType": StepType,
"distributionByStepId": Distribution,
"distributionsByStepId": DistributionsConnection,
"accountIntegrationByStepId": AccountIntegration,
"accountIntegrationsByStepId": AccountIntegrationsConnection,
"distributionQualificationsByStepId": DistributionQualificationsConnection,
"mappedSigningTemplateByStepId": MappedSigningTemplate,
"mappedSigningTemplatesByStepId": MappedSigningTemplatesConnection,
"sentSigningDocumentsByStepId": SentSigningDocumentsConnection,
"paymentIssuersByStepId": PaymentIssuersConnection,
"paymentInstrumentsByStepId": PaymentInstrumentsConnection,
"currentStep": CurrentStep,
"renderAttribute": {},
"shortSteps": ShortStepsConnection
}
}
}
stepStatus
Description
Reads a single StepStatus using its globally unique ID.
Response
Returns a StepStatus
Arguments
| Name | Description |
|---|---|
nodeId - ID!
|
The globally unique ID to be used in selecting a single StepStatus. |
Example
Query
query stepStatus($nodeId: ID!) {
stepStatus(nodeId: $nodeId) {
nodeId
status
stepsByStatus {
...StepsConnectionFragment
}
}
}
Variables
{"nodeId": 4}
Response
{
"data": {
"stepStatus": {
"nodeId": 4,
"status": "abc123",
"stepsByStatus": StepsConnection
}
}
}
stepStatusByStatus
Response
Returns a StepStatus
Arguments
| Name | Description |
|---|---|
status - String!
|
Example
Query
query stepStatusByStatus($status: String!) {
stepStatusByStatus(status: $status) {
nodeId
status
stepsByStatus {
...StepsConnectionFragment
}
}
}
Variables
{"status": "xyz789"}
Response
{
"data": {
"stepStatusByStatus": {
"nodeId": "4",
"status": "abc123",
"stepsByStatus": StepsConnection
}
}
}
stepType
Description
Reads a single StepType using its globally unique ID.
Response
Returns a StepType
Arguments
| Name | Description |
|---|---|
nodeId - ID!
|
The globally unique ID to be used in selecting a single StepType. |
Example
Query
query stepType($nodeId: ID!) {
stepType(nodeId: $nodeId) {
nodeId
type
stepsByType {
...StepsConnectionFragment
}
}
}
Variables
{"nodeId": 4}
Response
{
"data": {
"stepType": {
"nodeId": 4,
"type": "abc123",
"stepsByType": StepsConnection
}
}
}
stepTypeByType
Example
Query
query stepTypeByType($type: String!) {
stepTypeByType(type: $type) {
nodeId
type
stepsByType {
...StepsConnectionFragment
}
}
}
Variables
{"type": "abc123"}
Response
{
"data": {
"stepTypeByType": {
"nodeId": 4,
"type": "xyz789",
"stepsByType": StepsConnection
}
}
}
taRequest
Description
Reads a single TaRequest using its globally unique ID.
Response
Returns a TaRequest
Arguments
| Name | Description |
|---|---|
nodeId - ID!
|
The globally unique ID to be used in selecting a single TaRequest. |
Example
Query
query taRequest($nodeId: ID!) {
taRequest(nodeId: $nodeId) {
nodeId
id
vendorId
investorId
type
status
fromBlockchainAddressLocation
fromBlockchainAddressId
toBlockchainAddressLocation
toBlockchainAddressId
creatorAccountId
creatorUserId
createdOn
stagedTransferId
distributionId
accountByVendorId {
...AccountFragment
}
accountByInvestorId {
...AccountFragment
}
taRequestTypeByType {
...TaRequestTypeFragment
}
taRequestStatusByStatus {
...TaRequestStatusFragment
}
taRequestBlockchainLocationByFromBlockchainAddressLocation {
...TaRequestBlockchainLocationFragment
}
blockchainAddressByFromBlockchainAddressId {
...BlockchainAddressFragment
}
taRequestBlockchainLocationByToBlockchainAddressLocation {
...TaRequestBlockchainLocationFragment
}
blockchainAddressByToBlockchainAddressId {
...BlockchainAddressFragment
}
accountByCreatorAccountId {
...AccountFragment
}
userByCreatorUserId {
...UserFragment
}
}
}
Variables
{"nodeId": 4}
Response
{
"data": {
"taRequest": {
"nodeId": 4,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"vendorId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"investorId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"type": "abc123",
"status": "xyz789",
"fromBlockchainAddressLocation": "abc123",
"fromBlockchainAddressId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"toBlockchainAddressLocation": "abc123",
"toBlockchainAddressId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"creatorAccountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"creatorUserId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"createdOn": Datetime,
"stagedTransferId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"distributionId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountByVendorId": Account,
"accountByInvestorId": Account,
"taRequestTypeByType": TaRequestType,
"taRequestStatusByStatus": TaRequestStatus,
"taRequestBlockchainLocationByFromBlockchainAddressLocation": TaRequestBlockchainLocation,
"blockchainAddressByFromBlockchainAddressId": BlockchainAddress,
"taRequestBlockchainLocationByToBlockchainAddressLocation": TaRequestBlockchainLocation,
"blockchainAddressByToBlockchainAddressId": BlockchainAddress,
"accountByCreatorAccountId": Account,
"userByCreatorUserId": User
}
}
}
taRequestBlockchainLocation
Description
Reads a single TaRequestBlockchainLocation using its globally unique ID.
Response
Returns a TaRequestBlockchainLocation
Arguments
| Name | Description |
|---|---|
nodeId - ID!
|
The globally unique ID to be used in selecting a single TaRequestBlockchainLocation. |
Example
Query
query taRequestBlockchainLocation($nodeId: ID!) {
taRequestBlockchainLocation(nodeId: $nodeId) {
nodeId
location
taRequestsByFromBlockchainAddressLocation {
...TaRequestsConnectionFragment
}
taRequestsByToBlockchainAddressLocation {
...TaRequestsConnectionFragment
}
}
}
Variables
{"nodeId": 4}
Response
{
"data": {
"taRequestBlockchainLocation": {
"nodeId": "4",
"location": "xyz789",
"taRequestsByFromBlockchainAddressLocation": TaRequestsConnection,
"taRequestsByToBlockchainAddressLocation": TaRequestsConnection
}
}
}
taRequestBlockchainLocationByLocation
Response
Returns a TaRequestBlockchainLocation
Arguments
| Name | Description |
|---|---|
location - String!
|
Example
Query
query taRequestBlockchainLocationByLocation($location: String!) {
taRequestBlockchainLocationByLocation(location: $location) {
nodeId
location
taRequestsByFromBlockchainAddressLocation {
...TaRequestsConnectionFragment
}
taRequestsByToBlockchainAddressLocation {
...TaRequestsConnectionFragment
}
}
}
Variables
{"location": "abc123"}
Response
{
"data": {
"taRequestBlockchainLocationByLocation": {
"nodeId": 4,
"location": "abc123",
"taRequestsByFromBlockchainAddressLocation": TaRequestsConnection,
"taRequestsByToBlockchainAddressLocation": TaRequestsConnection
}
}
}
taRequestById
Example
Query
query taRequestById($id: UUID!) {
taRequestById(id: $id) {
nodeId
id
vendorId
investorId
type
status
fromBlockchainAddressLocation
fromBlockchainAddressId
toBlockchainAddressLocation
toBlockchainAddressId
creatorAccountId
creatorUserId
createdOn
stagedTransferId
distributionId
accountByVendorId {
...AccountFragment
}
accountByInvestorId {
...AccountFragment
}
taRequestTypeByType {
...TaRequestTypeFragment
}
taRequestStatusByStatus {
...TaRequestStatusFragment
}
taRequestBlockchainLocationByFromBlockchainAddressLocation {
...TaRequestBlockchainLocationFragment
}
blockchainAddressByFromBlockchainAddressId {
...BlockchainAddressFragment
}
taRequestBlockchainLocationByToBlockchainAddressLocation {
...TaRequestBlockchainLocationFragment
}
blockchainAddressByToBlockchainAddressId {
...BlockchainAddressFragment
}
accountByCreatorAccountId {
...AccountFragment
}
userByCreatorUserId {
...UserFragment
}
}
}
Variables
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
Response
{
"data": {
"taRequestById": {
"nodeId": 4,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"vendorId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"investorId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"type": "abc123",
"status": "abc123",
"fromBlockchainAddressLocation": "abc123",
"fromBlockchainAddressId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"toBlockchainAddressLocation": "abc123",
"toBlockchainAddressId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"creatorAccountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"creatorUserId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"createdOn": Datetime,
"stagedTransferId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"distributionId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountByVendorId": Account,
"accountByInvestorId": Account,
"taRequestTypeByType": TaRequestType,
"taRequestStatusByStatus": TaRequestStatus,
"taRequestBlockchainLocationByFromBlockchainAddressLocation": TaRequestBlockchainLocation,
"blockchainAddressByFromBlockchainAddressId": BlockchainAddress,
"taRequestBlockchainLocationByToBlockchainAddressLocation": TaRequestBlockchainLocation,
"blockchainAddressByToBlockchainAddressId": BlockchainAddress,
"accountByCreatorAccountId": Account,
"userByCreatorUserId": User
}
}
}
taRequestStatus
Description
Reads a single TaRequestStatus using its globally unique ID.
Response
Returns a TaRequestStatus
Arguments
| Name | Description |
|---|---|
nodeId - ID!
|
The globally unique ID to be used in selecting a single TaRequestStatus. |
Example
Query
query taRequestStatus($nodeId: ID!) {
taRequestStatus(nodeId: $nodeId) {
nodeId
status
taRequestsByStatus {
...TaRequestsConnectionFragment
}
}
}
Variables
{"nodeId": 4}
Response
{
"data": {
"taRequestStatus": {
"nodeId": 4,
"status": "abc123",
"taRequestsByStatus": TaRequestsConnection
}
}
}
taRequestStatusByStatus
Response
Returns a TaRequestStatus
Arguments
| Name | Description |
|---|---|
status - String!
|
Example
Query
query taRequestStatusByStatus($status: String!) {
taRequestStatusByStatus(status: $status) {
nodeId
status
taRequestsByStatus {
...TaRequestsConnectionFragment
}
}
}
Variables
{"status": "abc123"}
Response
{
"data": {
"taRequestStatusByStatus": {
"nodeId": "4",
"status": "xyz789",
"taRequestsByStatus": TaRequestsConnection
}
}
}
taRequestType
Description
Reads a single TaRequestType using its globally unique ID.
Response
Returns a TaRequestType
Arguments
| Name | Description |
|---|---|
nodeId - ID!
|
The globally unique ID to be used in selecting a single TaRequestType. |
Example
Query
query taRequestType($nodeId: ID!) {
taRequestType(nodeId: $nodeId) {
nodeId
type
taRequestsByType {
...TaRequestsConnectionFragment
}
}
}
Variables
{"nodeId": 4}
Response
{
"data": {
"taRequestType": {
"nodeId": 4,
"type": "xyz789",
"taRequestsByType": TaRequestsConnection
}
}
}
taRequestTypeByType
Response
Returns a TaRequestType
Arguments
| Name | Description |
|---|---|
type - String!
|
Example
Query
query taRequestTypeByType($type: String!) {
taRequestTypeByType(type: $type) {
nodeId
type
taRequestsByType {
...TaRequestsConnectionFragment
}
}
}
Variables
{"type": "xyz789"}
Response
{
"data": {
"taRequestTypeByType": {
"nodeId": "4",
"type": "abc123",
"taRequestsByType": TaRequestsConnection
}
}
}
taxRegion
Description
Reads a single TaxRegion using its globally unique ID.
Response
Returns a TaxRegion
Arguments
| Name | Description |
|---|---|
nodeId - ID!
|
The globally unique ID to be used in selecting a single TaxRegion. |
Example
Query
query taxRegion($nodeId: ID!) {
taxRegion(nodeId: $nodeId) {
nodeId
id
name
countryId
regex
format
countryByCountryId {
...CountryFragment
}
accountTaxInformationsByTaxRegionId {
...AccountTaxInformationsConnectionFragment
}
}
}
Variables
{"nodeId": "4"}
Response
{
"data": {
"taxRegion": {
"nodeId": "4",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"name": "abc123",
"countryId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"regex": "xyz789",
"format": "abc123",
"countryByCountryId": Country,
"accountTaxInformationsByTaxRegionId": AccountTaxInformationsConnection
}
}
}
taxRegionById
Example
Query
query taxRegionById($id: UUID!) {
taxRegionById(id: $id) {
nodeId
id
name
countryId
regex
format
countryByCountryId {
...CountryFragment
}
accountTaxInformationsByTaxRegionId {
...AccountTaxInformationsConnectionFragment
}
}
}
Variables
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
Response
{
"data": {
"taxRegionById": {
"nodeId": 4,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"name": "abc123",
"countryId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"regex": "abc123",
"format": "xyz789",
"countryByCountryId": Country,
"accountTaxInformationsByTaxRegionId": AccountTaxInformationsConnection
}
}
}
termsOfService
Description
Reads a single TermsOfService using its globally unique ID.
Response
Returns a TermsOfService
Arguments
| Name | Description |
|---|---|
nodeId - ID!
|
The globally unique ID to be used in selecting a single TermsOfService. |
Example
Query
query termsOfService($nodeId: ID!) {
termsOfService(nodeId: $nodeId) {
nodeId
id
type
agreement
createdOn
termsOfServiceTypeByType {
...TermsOfServiceTypeFragment
}
userTermsOfServicesByTermsOfServiceId {
...UserTermsOfServicesConnectionFragment
}
}
}
Variables
{"nodeId": 4}
Response
{
"data": {
"termsOfService": {
"nodeId": "4",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"type": "xyz789",
"agreement": "abc123",
"createdOn": Datetime,
"termsOfServiceTypeByType": TermsOfServiceType,
"userTermsOfServicesByTermsOfServiceId": UserTermsOfServicesConnection
}
}
}
termsOfServiceById
Response
Returns a TermsOfService
Arguments
| Name | Description |
|---|---|
id - UUID!
|
Example
Query
query termsOfServiceById($id: UUID!) {
termsOfServiceById(id: $id) {
nodeId
id
type
agreement
createdOn
termsOfServiceTypeByType {
...TermsOfServiceTypeFragment
}
userTermsOfServicesByTermsOfServiceId {
...UserTermsOfServicesConnectionFragment
}
}
}
Variables
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
Response
{
"data": {
"termsOfServiceById": {
"nodeId": "4",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"type": "abc123",
"agreement": "abc123",
"createdOn": Datetime,
"termsOfServiceTypeByType": TermsOfServiceType,
"userTermsOfServicesByTermsOfServiceId": UserTermsOfServicesConnection
}
}
}
termsOfServiceType
Description
Reads a single TermsOfServiceType using its globally unique ID.
Response
Returns a TermsOfServiceType
Arguments
| Name | Description |
|---|---|
nodeId - ID!
|
The globally unique ID to be used in selecting a single TermsOfServiceType. |
Example
Query
query termsOfServiceType($nodeId: ID!) {
termsOfServiceType(nodeId: $nodeId) {
nodeId
type
termsOfServicesByType {
...TermsOfServicesConnectionFragment
}
}
}
Variables
{"nodeId": "4"}
Response
{
"data": {
"termsOfServiceType": {
"nodeId": "4",
"type": "abc123",
"termsOfServicesByType": TermsOfServicesConnection
}
}
}
termsOfServiceTypeByType
Response
Returns a TermsOfServiceType
Arguments
| Name | Description |
|---|---|
type - String!
|
Example
Query
query termsOfServiceTypeByType($type: String!) {
termsOfServiceTypeByType(type: $type) {
nodeId
type
termsOfServicesByType {
...TermsOfServicesConnectionFragment
}
}
}
Variables
{"type": "xyz789"}
Response
{
"data": {
"termsOfServiceTypeByType": {
"nodeId": 4,
"type": "abc123",
"termsOfServicesByType": TermsOfServicesConnection
}
}
}
token
Description
Reads a single Token using its globally unique ID.
Response
Returns a Token
Arguments
| Name | Description |
|---|---|
nodeId - ID!
|
The globally unique ID to be used in selecting a single Token. |
Example
Query
query token($nodeId: ID!) {
token(nodeId: $nodeId) {
nodeId
status
type
name
symbol
precision
total
chainData
id
tokenStatusByStatus {
...TokenStatusFragment
}
tokenTypeByType {
...TokenTypeFragment
}
currenciesByTokenId {
...CurrenciesConnectionFragment
}
capTablesByTokenId {
...CapTablesConnectionFragment
}
roundByTokenId {
...RoundFragment
}
roundsByTokenId {
...RoundsConnectionFragment
}
ledgersByTokenId {
...LedgersConnectionFragment
}
contractsByTokenId {
...ContractsConnectionFragment
}
coinbaseBuyPriceUSD
coinbaseSellPriceUSD
coinbaseSpotPriceUSD
}
}
Variables
{"nodeId": 4}
Response
{
"data": {
"token": {
"nodeId": 4,
"status": "abc123",
"type": "abc123",
"name": "abc123",
"symbol": "abc123",
"precision": 123,
"total": BigFloat,
"chainData": {},
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"tokenStatusByStatus": TokenStatus,
"tokenTypeByType": TokenType,
"currenciesByTokenId": CurrenciesConnection,
"capTablesByTokenId": CapTablesConnection,
"roundByTokenId": Round,
"roundsByTokenId": RoundsConnection,
"ledgersByTokenId": LedgersConnection,
"contractsByTokenId": ContractsConnection,
"coinbaseBuyPriceUSD": 987.65,
"coinbaseSellPriceUSD": 123.45,
"coinbaseSpotPriceUSD": 987.65
}
}
}
tokenById
Example
Query
query tokenById($id: UUID!) {
tokenById(id: $id) {
nodeId
status
type
name
symbol
precision
total
chainData
id
tokenStatusByStatus {
...TokenStatusFragment
}
tokenTypeByType {
...TokenTypeFragment
}
currenciesByTokenId {
...CurrenciesConnectionFragment
}
capTablesByTokenId {
...CapTablesConnectionFragment
}
roundByTokenId {
...RoundFragment
}
roundsByTokenId {
...RoundsConnectionFragment
}
ledgersByTokenId {
...LedgersConnectionFragment
}
contractsByTokenId {
...ContractsConnectionFragment
}
coinbaseBuyPriceUSD
coinbaseSellPriceUSD
coinbaseSpotPriceUSD
}
}
Variables
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
Response
{
"data": {
"tokenById": {
"nodeId": "4",
"status": "xyz789",
"type": "xyz789",
"name": "xyz789",
"symbol": "xyz789",
"precision": 123,
"total": BigFloat,
"chainData": {},
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"tokenStatusByStatus": TokenStatus,
"tokenTypeByType": TokenType,
"currenciesByTokenId": CurrenciesConnection,
"capTablesByTokenId": CapTablesConnection,
"roundByTokenId": Round,
"roundsByTokenId": RoundsConnection,
"ledgersByTokenId": LedgersConnection,
"contractsByTokenId": ContractsConnection,
"coinbaseBuyPriceUSD": 987.65,
"coinbaseSellPriceUSD": 987.65,
"coinbaseSpotPriceUSD": 987.65
}
}
}
tokenStatus
Description
Reads a single TokenStatus using its globally unique ID.
Response
Returns a TokenStatus
Arguments
| Name | Description |
|---|---|
nodeId - ID!
|
The globally unique ID to be used in selecting a single TokenStatus. |
Example
Query
query tokenStatus($nodeId: ID!) {
tokenStatus(nodeId: $nodeId) {
nodeId
status
tokensByStatus {
...TokensConnectionFragment
}
}
}
Variables
{"nodeId": 4}
Response
{
"data": {
"tokenStatus": {
"nodeId": 4,
"status": "abc123",
"tokensByStatus": TokensConnection
}
}
}
tokenStatusByStatus
Response
Returns a TokenStatus
Arguments
| Name | Description |
|---|---|
status - String!
|
Example
Query
query tokenStatusByStatus($status: String!) {
tokenStatusByStatus(status: $status) {
nodeId
status
tokensByStatus {
...TokensConnectionFragment
}
}
}
Variables
{"status": "abc123"}
Response
{
"data": {
"tokenStatusByStatus": {
"nodeId": "4",
"status": "xyz789",
"tokensByStatus": TokensConnection
}
}
}
tokenType
Description
Reads a single TokenType using its globally unique ID.
Response
Returns a TokenType
Arguments
| Name | Description |
|---|---|
nodeId - ID!
|
The globally unique ID to be used in selecting a single TokenType. |
Example
Query
query tokenType($nodeId: ID!) {
tokenType(nodeId: $nodeId) {
nodeId
type
tokensByType {
...TokensConnectionFragment
}
}
}
Variables
{"nodeId": 4}
Response
{
"data": {
"tokenType": {
"nodeId": 4,
"type": "abc123",
"tokensByType": TokensConnection
}
}
}
tokenTypeByType
Example
Query
query tokenTypeByType($type: String!) {
tokenTypeByType(type: $type) {
nodeId
type
tokensByType {
...TokensConnectionFragment
}
}
}
Variables
{"type": "xyz789"}
Response
{
"data": {
"tokenTypeByType": {
"nodeId": 4,
"type": "abc123",
"tokensByType": TokensConnection
}
}
}
trancheBondDatum
Description
Reads a single TrancheBondDatum using its globally unique ID.
Response
Returns a TrancheBondDatum
Arguments
| Name | Description |
|---|---|
nodeId - ID!
|
The globally unique ID to be used in selecting a single TrancheBondDatum. |
Example
Query
query trancheBondDatum($nodeId: ID!) {
trancheBondDatum(nodeId: $nodeId) {
nodeId
id
roundId
coupon
term
createdOn
roundByRoundId {
...RoundFragment
}
}
}
Variables
{"nodeId": "4"}
Response
{
"data": {
"trancheBondDatum": {
"nodeId": "4",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"roundId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"coupon": BigFloat,
"term": BigFloat,
"createdOn": Datetime,
"roundByRoundId": Round
}
}
}
trancheBondDatumById
Response
Returns a TrancheBondDatum
Arguments
| Name | Description |
|---|---|
id - UUID!
|
Example
Query
query trancheBondDatumById($id: UUID!) {
trancheBondDatumById(id: $id) {
nodeId
id
roundId
coupon
term
createdOn
roundByRoundId {
...RoundFragment
}
}
}
Variables
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
Response
{
"data": {
"trancheBondDatumById": {
"nodeId": "4",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"roundId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"coupon": BigFloat,
"term": BigFloat,
"createdOn": Datetime,
"roundByRoundId": Round
}
}
}
trancheBondDatumByRoundId
Response
Returns a TrancheBondDatum
Arguments
| Name | Description |
|---|---|
roundId - UUID!
|
Example
Query
query trancheBondDatumByRoundId($roundId: UUID!) {
trancheBondDatumByRoundId(roundId: $roundId) {
nodeId
id
roundId
coupon
term
createdOn
roundByRoundId {
...RoundFragment
}
}
}
Variables
{
"roundId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
Response
{
"data": {
"trancheBondDatumByRoundId": {
"nodeId": 4,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"roundId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"coupon": BigFloat,
"term": BigFloat,
"createdOn": Datetime,
"roundByRoundId": Round
}
}
}
transaction
Description
Reads a single Transaction using its globally unique ID.
Response
Returns a Transaction
Arguments
| Name | Description |
|---|---|
nodeId - ID!
|
The globally unique ID to be used in selecting a single Transaction. |
Example
Query
query transaction($nodeId: ID!) {
transaction(nodeId: $nodeId) {
nodeId
id
brokerId
blockTimestamp
chainData
accountByBrokerId {
...AccountFragment
}
vestingEventsByTransactionId {
...VestingEventsConnectionFragment
}
ledgersByTransactionId {
...LedgersConnectionFragment
}
transactionAnnotationsByTransactionId {
...TransactionAnnotationsConnectionFragment
}
}
}
Variables
{"nodeId": "4"}
Response
{
"data": {
"transaction": {
"nodeId": 4,
"id": "xyz789",
"brokerId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"blockTimestamp": Datetime,
"chainData": {},
"accountByBrokerId": Account,
"vestingEventsByTransactionId": VestingEventsConnection,
"ledgersByTransactionId": LedgersConnection,
"transactionAnnotationsByTransactionId": TransactionAnnotationsConnection
}
}
}
transactionAnnotation
Description
Reads a single TransactionAnnotation using its globally unique ID.
Response
Returns a TransactionAnnotation
Arguments
| Name | Description |
|---|---|
nodeId - ID!
|
The globally unique ID to be used in selecting a single TransactionAnnotation. |
Example
Query
query transactionAnnotation($nodeId: ID!) {
transactionAnnotation(nodeId: $nodeId) {
nodeId
transactionId
writtenBy
accountId
annotation
archive
createdOn
id
transactionByTransactionId {
...TransactionFragment
}
userByWrittenBy {
...UserFragment
}
accountByAccountId {
...AccountFragment
}
}
}
Variables
{"nodeId": "4"}
Response
{
"data": {
"transactionAnnotation": {
"nodeId": 4,
"transactionId": "abc123",
"writtenBy": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"annotation": "xyz789",
"archive": true,
"createdOn": Datetime,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"transactionByTransactionId": Transaction,
"userByWrittenBy": User,
"accountByAccountId": Account
}
}
}
transactionAnnotationById
Response
Returns a TransactionAnnotation
Arguments
| Name | Description |
|---|---|
id - UUID!
|
Example
Query
query transactionAnnotationById($id: UUID!) {
transactionAnnotationById(id: $id) {
nodeId
transactionId
writtenBy
accountId
annotation
archive
createdOn
id
transactionByTransactionId {
...TransactionFragment
}
userByWrittenBy {
...UserFragment
}
accountByAccountId {
...AccountFragment
}
}
}
Variables
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
Response
{
"data": {
"transactionAnnotationById": {
"nodeId": "4",
"transactionId": "xyz789",
"writtenBy": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"annotation": "abc123",
"archive": false,
"createdOn": Datetime,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"transactionByTransactionId": Transaction,
"userByWrittenBy": User,
"accountByAccountId": Account
}
}
}
transactionById
Response
Returns a Transaction
Arguments
| Name | Description |
|---|---|
id - String!
|
Example
Query
query transactionById($id: String!) {
transactionById(id: $id) {
nodeId
id
brokerId
blockTimestamp
chainData
accountByBrokerId {
...AccountFragment
}
vestingEventsByTransactionId {
...VestingEventsConnectionFragment
}
ledgersByTransactionId {
...LedgersConnectionFragment
}
transactionAnnotationsByTransactionId {
...TransactionAnnotationsConnectionFragment
}
}
}
Variables
{"id": "xyz789"}
Response
{
"data": {
"transactionById": {
"nodeId": "4",
"id": "abc123",
"brokerId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"blockTimestamp": Datetime,
"chainData": {},
"accountByBrokerId": Account,
"vestingEventsByTransactionId": VestingEventsConnection,
"ledgersByTransactionId": LedgersConnection,
"transactionAnnotationsByTransactionId": TransactionAnnotationsConnection
}
}
}
transactionGroupType
Description
Reads a single TransactionGroupType using its globally unique ID.
Response
Returns a TransactionGroupType
Arguments
| Name | Description |
|---|---|
nodeId - ID!
|
The globally unique ID to be used in selecting a single TransactionGroupType. |
Example
Query
query transactionGroupType($nodeId: ID!) {
transactionGroupType(nodeId: $nodeId) {
nodeId
type
}
}
Variables
{"nodeId": "4"}
Response
{
"data": {
"transactionGroupType": {
"nodeId": "4",
"type": "xyz789"
}
}
}
transactionGroupTypeByType
Response
Returns a TransactionGroupType
Arguments
| Name | Description |
|---|---|
type - String!
|
Example
Query
query transactionGroupTypeByType($type: String!) {
transactionGroupTypeByType(type: $type) {
nodeId
type
}
}
Variables
{"type": "abc123"}
Response
{
"data": {
"transactionGroupTypeByType": {
"nodeId": 4,
"type": "xyz789"
}
}
}
user
Description
Reads a single User using its globally unique ID.
Response
Returns a User
Arguments
| Name | Description |
|---|---|
nodeId - ID!
|
The globally unique ID to be used in selecting a single User. |
Example
Query
query user($nodeId: ID!) {
user(nodeId: $nodeId) {
nodeId
status
firstName
lastName
createdOn
hasInvestorAccount
id
userStatusByStatus {
...UserStatusFragment
}
emailsByUserId {
...EmailsConnectionFragment
}
usersAccountsByUserId {
...UsersAccountsConnectionFragment
}
distributionAnnotationsByWrittenBy {
...DistributionAnnotationsConnectionFragment
}
assetAnnotationsByWrittenBy {
...AssetAnnotationsConnectionFragment
}
allocationAnnotationsByWrittenBy {
...AllocationAnnotationsConnectionFragment
}
transactionAnnotationsByWrittenBy {
...TransactionAnnotationsConnectionFragment
}
managedAccountsByCreatedBy {
...ManagedAccountsConnectionFragment
}
userTermsOfServicesByUserId {
...UserTermsOfServicesConnectionFragment
}
issuanceEventsByCreatedBy {
...IssuanceEventsConnectionFragment
}
accountDocumentsByCreatedBy {
...AccountDocumentsConnectionFragment
}
documentSharingsByCreatedBy {
...DocumentSharingsConnectionFragment
}
accountRestrictionsByCreatorUserId {
...AccountRestrictionsConnectionFragment
}
customerPartiesByUserId {
...CustomerPartiesConnectionFragment
}
customerPartiesByCreatorUserId {
...CustomerPartiesConnectionFragment
}
customerAddressesByCreatorUserId {
...CustomerAddressesConnectionFragment
}
customerPartyAddressesByCreatorUserId {
...CustomerPartyAddressesConnectionFragment
}
blockchainAddressSourcesByCreatorUserId {
...BlockchainAddressSourcesConnectionFragment
}
taRequestsByCreatorUserId {
...TaRequestsConnectionFragment
}
partiesByUserId {
...PartiesConnectionFragment
}
pendingTermsOfService {
...TermsOfServiceFragment
}
}
}
Variables
{"nodeId": "4"}
Response
{
"data": {
"user": {
"nodeId": "4",
"status": "xyz789",
"firstName": "xyz789",
"lastName": "abc123",
"createdOn": Datetime,
"hasInvestorAccount": true,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"userStatusByStatus": UserStatus,
"emailsByUserId": EmailsConnection,
"usersAccountsByUserId": UsersAccountsConnection,
"distributionAnnotationsByWrittenBy": DistributionAnnotationsConnection,
"assetAnnotationsByWrittenBy": AssetAnnotationsConnection,
"allocationAnnotationsByWrittenBy": AllocationAnnotationsConnection,
"transactionAnnotationsByWrittenBy": TransactionAnnotationsConnection,
"managedAccountsByCreatedBy": ManagedAccountsConnection,
"userTermsOfServicesByUserId": UserTermsOfServicesConnection,
"issuanceEventsByCreatedBy": IssuanceEventsConnection,
"accountDocumentsByCreatedBy": AccountDocumentsConnection,
"documentSharingsByCreatedBy": DocumentSharingsConnection,
"accountRestrictionsByCreatorUserId": AccountRestrictionsConnection,
"customerPartiesByUserId": CustomerPartiesConnection,
"customerPartiesByCreatorUserId": CustomerPartiesConnection,
"customerAddressesByCreatorUserId": CustomerAddressesConnection,
"customerPartyAddressesByCreatorUserId": CustomerPartyAddressesConnection,
"blockchainAddressSourcesByCreatorUserId": BlockchainAddressSourcesConnection,
"taRequestsByCreatorUserId": TaRequestsConnection,
"partiesByUserId": PartiesConnection,
"pendingTermsOfService": TermsOfService
}
}
}
userById
Example
Query
query userById($id: UUID!) {
userById(id: $id) {
nodeId
status
firstName
lastName
createdOn
hasInvestorAccount
id
userStatusByStatus {
...UserStatusFragment
}
emailsByUserId {
...EmailsConnectionFragment
}
usersAccountsByUserId {
...UsersAccountsConnectionFragment
}
distributionAnnotationsByWrittenBy {
...DistributionAnnotationsConnectionFragment
}
assetAnnotationsByWrittenBy {
...AssetAnnotationsConnectionFragment
}
allocationAnnotationsByWrittenBy {
...AllocationAnnotationsConnectionFragment
}
transactionAnnotationsByWrittenBy {
...TransactionAnnotationsConnectionFragment
}
managedAccountsByCreatedBy {
...ManagedAccountsConnectionFragment
}
userTermsOfServicesByUserId {
...UserTermsOfServicesConnectionFragment
}
issuanceEventsByCreatedBy {
...IssuanceEventsConnectionFragment
}
accountDocumentsByCreatedBy {
...AccountDocumentsConnectionFragment
}
documentSharingsByCreatedBy {
...DocumentSharingsConnectionFragment
}
accountRestrictionsByCreatorUserId {
...AccountRestrictionsConnectionFragment
}
customerPartiesByUserId {
...CustomerPartiesConnectionFragment
}
customerPartiesByCreatorUserId {
...CustomerPartiesConnectionFragment
}
customerAddressesByCreatorUserId {
...CustomerAddressesConnectionFragment
}
customerPartyAddressesByCreatorUserId {
...CustomerPartyAddressesConnectionFragment
}
blockchainAddressSourcesByCreatorUserId {
...BlockchainAddressSourcesConnectionFragment
}
taRequestsByCreatorUserId {
...TaRequestsConnectionFragment
}
partiesByUserId {
...PartiesConnectionFragment
}
pendingTermsOfService {
...TermsOfServiceFragment
}
}
}
Variables
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
Response
{
"data": {
"userById": {
"nodeId": "4",
"status": "abc123",
"firstName": "abc123",
"lastName": "abc123",
"createdOn": Datetime,
"hasInvestorAccount": true,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"userStatusByStatus": UserStatus,
"emailsByUserId": EmailsConnection,
"usersAccountsByUserId": UsersAccountsConnection,
"distributionAnnotationsByWrittenBy": DistributionAnnotationsConnection,
"assetAnnotationsByWrittenBy": AssetAnnotationsConnection,
"allocationAnnotationsByWrittenBy": AllocationAnnotationsConnection,
"transactionAnnotationsByWrittenBy": TransactionAnnotationsConnection,
"managedAccountsByCreatedBy": ManagedAccountsConnection,
"userTermsOfServicesByUserId": UserTermsOfServicesConnection,
"issuanceEventsByCreatedBy": IssuanceEventsConnection,
"accountDocumentsByCreatedBy": AccountDocumentsConnection,
"documentSharingsByCreatedBy": DocumentSharingsConnection,
"accountRestrictionsByCreatorUserId": AccountRestrictionsConnection,
"customerPartiesByUserId": CustomerPartiesConnection,
"customerPartiesByCreatorUserId": CustomerPartiesConnection,
"customerAddressesByCreatorUserId": CustomerAddressesConnection,
"customerPartyAddressesByCreatorUserId": CustomerPartyAddressesConnection,
"blockchainAddressSourcesByCreatorUserId": BlockchainAddressSourcesConnection,
"taRequestsByCreatorUserId": TaRequestsConnection,
"partiesByUserId": PartiesConnection,
"pendingTermsOfService": TermsOfService
}
}
}
userId
Response
Returns a UUID
Example
Query
query userId {
userId
}
Response
{
"data": {
"userId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
}
userStatus
Description
Reads a single UserStatus using its globally unique ID.
Response
Returns a UserStatus
Arguments
| Name | Description |
|---|---|
nodeId - ID!
|
The globally unique ID to be used in selecting a single UserStatus. |
Example
Query
query userStatus($nodeId: ID!) {
userStatus(nodeId: $nodeId) {
nodeId
status
usersByStatus {
...UsersConnectionFragment
}
usersAccountsByStatus {
...UsersAccountsConnectionFragment
}
}
}
Variables
{"nodeId": 4}
Response
{
"data": {
"userStatus": {
"nodeId": "4",
"status": "abc123",
"usersByStatus": UsersConnection,
"usersAccountsByStatus": UsersAccountsConnection
}
}
}
userStatusByStatus
Response
Returns a UserStatus
Arguments
| Name | Description |
|---|---|
status - String!
|
Example
Query
query userStatusByStatus($status: String!) {
userStatusByStatus(status: $status) {
nodeId
status
usersByStatus {
...UsersConnectionFragment
}
usersAccountsByStatus {
...UsersAccountsConnectionFragment
}
}
}
Variables
{"status": "abc123"}
Response
{
"data": {
"userStatusByStatus": {
"nodeId": "4",
"status": "xyz789",
"usersByStatus": UsersConnection,
"usersAccountsByStatus": UsersAccountsConnection
}
}
}
userTermsOfService
Description
Reads a single UserTermsOfService using its globally unique ID.
Response
Returns a UserTermsOfService
Arguments
| Name | Description |
|---|---|
nodeId - ID!
|
The globally unique ID to be used in selecting a single UserTermsOfService. |
Example
Query
query userTermsOfService($nodeId: ID!) {
userTermsOfService(nodeId: $nodeId) {
nodeId
id
userId
termsOfServiceId
createdOn
userByUserId {
...UserFragment
}
termsOfServiceByTermsOfServiceId {
...TermsOfServiceFragment
}
}
}
Variables
{"nodeId": 4}
Response
{
"data": {
"userTermsOfService": {
"nodeId": "4",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"userId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"termsOfServiceId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"createdOn": Datetime,
"userByUserId": User,
"termsOfServiceByTermsOfServiceId": TermsOfService
}
}
}
userTermsOfServiceById
Response
Returns a UserTermsOfService
Arguments
| Name | Description |
|---|---|
id - UUID!
|
Example
Query
query userTermsOfServiceById($id: UUID!) {
userTermsOfServiceById(id: $id) {
nodeId
id
userId
termsOfServiceId
createdOn
userByUserId {
...UserFragment
}
termsOfServiceByTermsOfServiceId {
...TermsOfServiceFragment
}
}
}
Variables
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
Response
{
"data": {
"userTermsOfServiceById": {
"nodeId": "4",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"userId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"termsOfServiceId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"createdOn": Datetime,
"userByUserId": User,
"termsOfServiceByTermsOfServiceId": TermsOfService
}
}
}
usersAccount
Description
Reads a single UsersAccount using its globally unique ID.
Response
Returns a UsersAccount
Arguments
| Name | Description |
|---|---|
nodeId - ID!
|
The globally unique ID to be used in selecting a single UsersAccount. |
Example
Query
query usersAccount($nodeId: ID!) {
usersAccount(nodeId: $nodeId) {
nodeId
userId
accountId
role
status
id
userByUserId {
...UserFragment
}
accountByAccountId {
...AccountFragment
}
auxRoleByRole {
...AuxRoleFragment
}
userStatusByStatus {
...UserStatusFragment
}
blockchainRegistrationsByUsersAccountId {
...BlockchainRegistrationsConnectionFragment
}
}
}
Variables
{"nodeId": 4}
Response
{
"data": {
"usersAccount": {
"nodeId": "4",
"userId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"role": "abc123",
"status": "abc123",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"userByUserId": User,
"accountByAccountId": Account,
"auxRoleByRole": AuxRole,
"userStatusByStatus": UserStatus,
"blockchainRegistrationsByUsersAccountId": BlockchainRegistrationsConnection
}
}
}
usersAccountById
Response
Returns a UsersAccount
Arguments
| Name | Description |
|---|---|
id - UUID!
|
Example
Query
query usersAccountById($id: UUID!) {
usersAccountById(id: $id) {
nodeId
userId
accountId
role
status
id
userByUserId {
...UserFragment
}
accountByAccountId {
...AccountFragment
}
auxRoleByRole {
...AuxRoleFragment
}
userStatusByStatus {
...UserStatusFragment
}
blockchainRegistrationsByUsersAccountId {
...BlockchainRegistrationsConnectionFragment
}
}
}
Variables
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
Response
{
"data": {
"usersAccountById": {
"nodeId": 4,
"userId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"role": "abc123",
"status": "xyz789",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"userByUserId": User,
"accountByAccountId": Account,
"auxRoleByRole": AuxRole,
"userStatusByStatus": UserStatus,
"blockchainRegistrationsByUsersAccountId": BlockchainRegistrationsConnection
}
}
}
usersAccountByUserIdAndAccountId
Response
Returns a UsersAccount
Example
Query
query usersAccountByUserIdAndAccountId(
$userId: UUID!,
$accountId: UUID!
) {
usersAccountByUserIdAndAccountId(
userId: $userId,
accountId: $accountId
) {
nodeId
userId
accountId
role
status
id
userByUserId {
...UserFragment
}
accountByAccountId {
...AccountFragment
}
auxRoleByRole {
...AuxRoleFragment
}
userStatusByStatus {
...UserStatusFragment
}
blockchainRegistrationsByUsersAccountId {
...BlockchainRegistrationsConnectionFragment
}
}
}
Variables
{
"userId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
Response
{
"data": {
"usersAccountByUserIdAndAccountId": {
"nodeId": "4",
"userId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"role": "xyz789",
"status": "abc123",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"userByUserId": User,
"accountByAccountId": Account,
"auxRoleByRole": AuxRole,
"userStatusByStatus": UserStatus,
"blockchainRegistrationsByUsersAccountId": BlockchainRegistrationsConnection
}
}
}
vendorAgent
Description
Reads a single VendorAgent using its globally unique ID.
Response
Returns a VendorAgent
Arguments
| Name | Description |
|---|---|
nodeId - ID!
|
The globally unique ID to be used in selecting a single VendorAgent. |
Example
Query
query vendorAgent($nodeId: ID!) {
vendorAgent(nodeId: $nodeId) {
nodeId
id
agentId
vendorId
status
name
accountByAgentId {
...AccountFragment
}
accountByVendorId {
...AccountFragment
}
invitationStatusByStatus {
...InvitationStatusFragment
}
}
}
Variables
{"nodeId": "4"}
Response
{
"data": {
"vendorAgent": {
"nodeId": 4,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"agentId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"vendorId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"status": "xyz789",
"name": "abc123",
"accountByAgentId": Account,
"accountByVendorId": Account,
"invitationStatusByStatus": InvitationStatus
}
}
}
vendorAgentByAgentIdAndVendorId
Response
Returns a VendorAgent
Example
Query
query vendorAgentByAgentIdAndVendorId(
$agentId: UUID!,
$vendorId: UUID!
) {
vendorAgentByAgentIdAndVendorId(
agentId: $agentId,
vendorId: $vendorId
) {
nodeId
id
agentId
vendorId
status
name
accountByAgentId {
...AccountFragment
}
accountByVendorId {
...AccountFragment
}
invitationStatusByStatus {
...InvitationStatusFragment
}
}
}
Variables
{
"agentId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"vendorId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
Response
{
"data": {
"vendorAgentByAgentIdAndVendorId": {
"nodeId": "4",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"agentId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"vendorId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"status": "abc123",
"name": "abc123",
"accountByAgentId": Account,
"accountByVendorId": Account,
"invitationStatusByStatus": InvitationStatus
}
}
}
vendorAgentById
Response
Returns a VendorAgent
Arguments
| Name | Description |
|---|---|
id - UUID!
|
Example
Query
query vendorAgentById($id: UUID!) {
vendorAgentById(id: $id) {
nodeId
id
agentId
vendorId
status
name
accountByAgentId {
...AccountFragment
}
accountByVendorId {
...AccountFragment
}
invitationStatusByStatus {
...InvitationStatusFragment
}
}
}
Variables
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
Response
{
"data": {
"vendorAgentById": {
"nodeId": 4,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"agentId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"vendorId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"status": "xyz789",
"name": "xyz789",
"accountByAgentId": Account,
"accountByVendorId": Account,
"invitationStatusByStatus": InvitationStatus
}
}
}
vendorDefaultEmailPreference
Description
Reads a single VendorDefaultEmailPreference using its globally unique ID.
Response
Returns a VendorDefaultEmailPreference
Arguments
| Name | Description |
|---|---|
nodeId - ID!
|
The globally unique ID to be used in selecting a single VendorDefaultEmailPreference. |
Example
Query
query vendorDefaultEmailPreference($nodeId: ID!) {
vendorDefaultEmailPreference(nodeId: $nodeId) {
nodeId
id
accountId
sendDistribution
accountByAccountId {
...AccountFragment
}
}
}
Variables
{"nodeId": 4}
Response
{
"data": {
"vendorDefaultEmailPreference": {
"nodeId": 4,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"sendDistribution": true,
"accountByAccountId": Account
}
}
}
vendorDefaultEmailPreferenceByAccountId
Response
Returns a VendorDefaultEmailPreference
Arguments
| Name | Description |
|---|---|
accountId - UUID!
|
Example
Query
query vendorDefaultEmailPreferenceByAccountId($accountId: UUID!) {
vendorDefaultEmailPreferenceByAccountId(accountId: $accountId) {
nodeId
id
accountId
sendDistribution
accountByAccountId {
...AccountFragment
}
}
}
Variables
{
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
Response
{
"data": {
"vendorDefaultEmailPreferenceByAccountId": {
"nodeId": 4,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"sendDistribution": false,
"accountByAccountId": Account
}
}
}
vendorDefaultEmailPreferenceById
Response
Returns a VendorDefaultEmailPreference
Arguments
| Name | Description |
|---|---|
id - UUID!
|
Example
Query
query vendorDefaultEmailPreferenceById($id: UUID!) {
vendorDefaultEmailPreferenceById(id: $id) {
nodeId
id
accountId
sendDistribution
accountByAccountId {
...AccountFragment
}
}
}
Variables
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
Response
{
"data": {
"vendorDefaultEmailPreferenceById": {
"nodeId": "4",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"sendDistribution": true,
"accountByAccountId": Account
}
}
}
vendorIntegrationStatus
Description
Reads a single VendorIntegrationStatus using its globally unique ID.
Response
Returns a VendorIntegrationStatus
Arguments
| Name | Description |
|---|---|
nodeId - ID!
|
The globally unique ID to be used in selecting a single VendorIntegrationStatus. |
Example
Query
query vendorIntegrationStatus($nodeId: ID!) {
vendorIntegrationStatus(nodeId: $nodeId) {
nodeId
status
}
}
Variables
{"nodeId": 4}
Response
{
"data": {
"vendorIntegrationStatus": {
"nodeId": 4,
"status": "xyz789"
}
}
}
vendorIntegrationStatusByStatus
Response
Returns a VendorIntegrationStatus
Arguments
| Name | Description |
|---|---|
status - String!
|
Example
Query
query vendorIntegrationStatusByStatus($status: String!) {
vendorIntegrationStatusByStatus(status: $status) {
nodeId
status
}
}
Variables
{"status": "abc123"}
Response
{
"data": {
"vendorIntegrationStatusByStatus": {
"nodeId": "4",
"status": "abc123"
}
}
}
vendorQualification
Description
Reads a single VendorQualification using its globally unique ID.
Response
Returns a VendorQualification
Arguments
| Name | Description |
|---|---|
nodeId - ID!
|
The globally unique ID to be used in selecting a single VendorQualification. |
Example
Query
query vendorQualification($nodeId: ID!) {
vendorQualification(nodeId: $nodeId) {
nodeId
id
accountId
integrationId
name
active
constrained
stepType
accountByAccountId {
...AccountFragment
}
integrationByIntegrationId {
...IntegrationFragment
}
vendorQualificationStepTypeByStepType {
...VendorQualificationStepTypeFragment
}
distributionQualificationsByVendorQualificationId {
...DistributionQualificationsConnectionFragment
}
allocationQualificationsByVendorQualificationId {
...AllocationQualificationsConnectionFragment
}
mappedSigningTemplateByVendorQualificationId {
...MappedSigningTemplateFragment
}
mappedSigningTemplatesByVendorQualificationId {
...MappedSigningTemplatesConnectionFragment
}
onboardingQuestionSetByVendorQualificationId {
...OnboardingQuestionSetFragment
}
onboardingQuestionSetsByVendorQualificationId {
...OnboardingQuestionSetsConnectionFragment
}
paymentInstrumentsByVendorQualificationId {
...PaymentInstrumentsConnectionFragment
}
vendorQualificationConstraintsByVendorQualificationId {
...VendorQualificationConstraintsConnectionFragment
}
}
}
Variables
{"nodeId": 4}
Response
{
"data": {
"vendorQualification": {
"nodeId": 4,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"integrationId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"name": "abc123",
"active": true,
"constrained": false,
"stepType": "xyz789",
"accountByAccountId": Account,
"integrationByIntegrationId": Integration,
"vendorQualificationStepTypeByStepType": VendorQualificationStepType,
"distributionQualificationsByVendorQualificationId": DistributionQualificationsConnection,
"allocationQualificationsByVendorQualificationId": AllocationQualificationsConnection,
"mappedSigningTemplateByVendorQualificationId": MappedSigningTemplate,
"mappedSigningTemplatesByVendorQualificationId": MappedSigningTemplatesConnection,
"onboardingQuestionSetByVendorQualificationId": OnboardingQuestionSet,
"onboardingQuestionSetsByVendorQualificationId": OnboardingQuestionSetsConnection,
"paymentInstrumentsByVendorQualificationId": PaymentInstrumentsConnection,
"vendorQualificationConstraintsByVendorQualificationId": VendorQualificationConstraintsConnection
}
}
}
vendorQualificationById
Response
Returns a VendorQualification
Arguments
| Name | Description |
|---|---|
id - UUID!
|
Example
Query
query vendorQualificationById($id: UUID!) {
vendorQualificationById(id: $id) {
nodeId
id
accountId
integrationId
name
active
constrained
stepType
accountByAccountId {
...AccountFragment
}
integrationByIntegrationId {
...IntegrationFragment
}
vendorQualificationStepTypeByStepType {
...VendorQualificationStepTypeFragment
}
distributionQualificationsByVendorQualificationId {
...DistributionQualificationsConnectionFragment
}
allocationQualificationsByVendorQualificationId {
...AllocationQualificationsConnectionFragment
}
mappedSigningTemplateByVendorQualificationId {
...MappedSigningTemplateFragment
}
mappedSigningTemplatesByVendorQualificationId {
...MappedSigningTemplatesConnectionFragment
}
onboardingQuestionSetByVendorQualificationId {
...OnboardingQuestionSetFragment
}
onboardingQuestionSetsByVendorQualificationId {
...OnboardingQuestionSetsConnectionFragment
}
paymentInstrumentsByVendorQualificationId {
...PaymentInstrumentsConnectionFragment
}
vendorQualificationConstraintsByVendorQualificationId {
...VendorQualificationConstraintsConnectionFragment
}
}
}
Variables
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
Response
{
"data": {
"vendorQualificationById": {
"nodeId": "4",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"integrationId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"name": "abc123",
"active": true,
"constrained": false,
"stepType": "abc123",
"accountByAccountId": Account,
"integrationByIntegrationId": Integration,
"vendorQualificationStepTypeByStepType": VendorQualificationStepType,
"distributionQualificationsByVendorQualificationId": DistributionQualificationsConnection,
"allocationQualificationsByVendorQualificationId": AllocationQualificationsConnection,
"mappedSigningTemplateByVendorQualificationId": MappedSigningTemplate,
"mappedSigningTemplatesByVendorQualificationId": MappedSigningTemplatesConnection,
"onboardingQuestionSetByVendorQualificationId": OnboardingQuestionSet,
"onboardingQuestionSetsByVendorQualificationId": OnboardingQuestionSetsConnection,
"paymentInstrumentsByVendorQualificationId": PaymentInstrumentsConnection,
"vendorQualificationConstraintsByVendorQualificationId": VendorQualificationConstraintsConnection
}
}
}
vendorQualificationConstraint
Description
Reads a single VendorQualificationConstraint using its globally unique ID.
Response
Returns a VendorQualificationConstraint
Arguments
| Name | Description |
|---|---|
nodeId - ID!
|
The globally unique ID to be used in selecting a single VendorQualificationConstraint. |
Example
Query
query vendorQualificationConstraint($nodeId: ID!) {
vendorQualificationConstraint(nodeId: $nodeId) {
nodeId
id
vendorQualificationId
roundId
vendorQualificationByVendorQualificationId {
...VendorQualificationFragment
}
roundByRoundId {
...RoundFragment
}
}
}
Variables
{"nodeId": "4"}
Response
{
"data": {
"vendorQualificationConstraint": {
"nodeId": "4",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"vendorQualificationId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"roundId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"vendorQualificationByVendorQualificationId": VendorQualification,
"roundByRoundId": Round
}
}
}
vendorQualificationConstraintById
Response
Returns a VendorQualificationConstraint
Arguments
| Name | Description |
|---|---|
id - UUID!
|
Example
Query
query vendorQualificationConstraintById($id: UUID!) {
vendorQualificationConstraintById(id: $id) {
nodeId
id
vendorQualificationId
roundId
vendorQualificationByVendorQualificationId {
...VendorQualificationFragment
}
roundByRoundId {
...RoundFragment
}
}
}
Variables
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
Response
{
"data": {
"vendorQualificationConstraintById": {
"nodeId": 4,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"vendorQualificationId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"roundId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"vendorQualificationByVendorQualificationId": VendorQualification,
"roundByRoundId": Round
}
}
}
vendorQualificationStepType
Description
Reads a single VendorQualificationStepType using its globally unique ID.
Response
Returns a VendorQualificationStepType
Arguments
| Name | Description |
|---|---|
nodeId - ID!
|
The globally unique ID to be used in selecting a single VendorQualificationStepType. |
Example
Query
query vendorQualificationStepType($nodeId: ID!) {
vendorQualificationStepType(nodeId: $nodeId) {
nodeId
type
vendorQualificationsByStepType {
...VendorQualificationsConnectionFragment
}
}
}
Variables
{"nodeId": 4}
Response
{
"data": {
"vendorQualificationStepType": {
"nodeId": 4,
"type": "xyz789",
"vendorQualificationsByStepType": VendorQualificationsConnection
}
}
}
vendorQualificationStepTypeByType
Response
Returns a VendorQualificationStepType
Arguments
| Name | Description |
|---|---|
type - String!
|
Example
Query
query vendorQualificationStepTypeByType($type: String!) {
vendorQualificationStepTypeByType(type: $type) {
nodeId
type
vendorQualificationsByStepType {
...VendorQualificationsConnectionFragment
}
}
}
Variables
{"type": "abc123"}
Response
{
"data": {
"vendorQualificationStepTypeByType": {
"nodeId": "4",
"type": "xyz789",
"vendorQualificationsByStepType": VendorQualificationsConnection
}
}
}
vestingDuration
Description
Reads a single VestingDuration using its globally unique ID.
Response
Returns a VestingDuration
Arguments
| Name | Description |
|---|---|
nodeId - ID!
|
The globally unique ID to be used in selecting a single VestingDuration. |
Example
Query
query vestingDuration($nodeId: ID!) {
vestingDuration(nodeId: $nodeId) {
nodeId
duration
vestingSchedulesByDuration {
...VestingSchedulesConnectionFragment
}
allocationsVestingSchedulesByDuration {
...AllocationsVestingSchedulesConnectionFragment
}
}
}
Variables
{"nodeId": "4"}
Response
{
"data": {
"vestingDuration": {
"nodeId": "4",
"duration": "xyz789",
"vestingSchedulesByDuration": VestingSchedulesConnection,
"allocationsVestingSchedulesByDuration": AllocationsVestingSchedulesConnection
}
}
}
vestingDurationByDuration
Response
Returns a VestingDuration
Arguments
| Name | Description |
|---|---|
duration - String!
|
Example
Query
query vestingDurationByDuration($duration: String!) {
vestingDurationByDuration(duration: $duration) {
nodeId
duration
vestingSchedulesByDuration {
...VestingSchedulesConnectionFragment
}
allocationsVestingSchedulesByDuration {
...AllocationsVestingSchedulesConnectionFragment
}
}
}
Variables
{"duration": "xyz789"}
Response
{
"data": {
"vestingDurationByDuration": {
"nodeId": "4",
"duration": "xyz789",
"vestingSchedulesByDuration": VestingSchedulesConnection,
"allocationsVestingSchedulesByDuration": AllocationsVestingSchedulesConnection
}
}
}
vestingEvent
Description
Reads a single VestingEvent using its globally unique ID.
Response
Returns a VestingEvent
Arguments
| Name | Description |
|---|---|
nodeId - ID!
|
The globally unique ID to be used in selecting a single VestingEvent. |
Example
Query
query vestingEvent($nodeId: ID!) {
vestingEvent(nodeId: $nodeId) {
nodeId
vestingScheduleId
transactionId
startPeriod
endPeriod
id
vestingScheduleByVestingScheduleId {
...VestingScheduleFragment
}
transactionByTransactionId {
...TransactionFragment
}
}
}
Variables
{"nodeId": 4}
Response
{
"data": {
"vestingEvent": {
"nodeId": "4",
"vestingScheduleId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"transactionId": "xyz789",
"startPeriod": 123,
"endPeriod": 987,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"vestingScheduleByVestingScheduleId": VestingSchedule,
"transactionByTransactionId": Transaction
}
}
}
vestingEventById
Response
Returns a VestingEvent
Arguments
| Name | Description |
|---|---|
id - UUID!
|
Example
Query
query vestingEventById($id: UUID!) {
vestingEventById(id: $id) {
nodeId
vestingScheduleId
transactionId
startPeriod
endPeriod
id
vestingScheduleByVestingScheduleId {
...VestingScheduleFragment
}
transactionByTransactionId {
...TransactionFragment
}
}
}
Variables
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
Response
{
"data": {
"vestingEventById": {
"nodeId": 4,
"vestingScheduleId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"transactionId": "xyz789",
"startPeriod": 123,
"endPeriod": 987,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"vestingScheduleByVestingScheduleId": VestingSchedule,
"transactionByTransactionId": Transaction
}
}
}
vestingSchedule
Description
Reads a single VestingSchedule using its globally unique ID.
Response
Returns a VestingSchedule
Arguments
| Name | Description |
|---|---|
nodeId - ID!
|
The globally unique ID to be used in selecting a single VestingSchedule. |
Example
Query
query vestingSchedule($nodeId: ID!) {
vestingSchedule(nodeId: $nodeId) {
nodeId
distributionId
duration
cliff
periods
startsOn
currentPeriod
automatic
id
distributionByDistributionId {
...DistributionFragment
}
vestingDurationByDuration {
...VestingDurationFragment
}
vestingEventsByVestingScheduleId {
...VestingEventsConnectionFragment
}
}
}
Variables
{"nodeId": "4"}
Response
{
"data": {
"vestingSchedule": {
"nodeId": 4,
"distributionId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"duration": "abc123",
"cliff": 123,
"periods": 123,
"startsOn": Datetime,
"currentPeriod": 987,
"automatic": true,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"distributionByDistributionId": Distribution,
"vestingDurationByDuration": VestingDuration,
"vestingEventsByVestingScheduleId": VestingEventsConnection
}
}
}
vestingScheduleByDistributionId
Response
Returns a VestingSchedule
Arguments
| Name | Description |
|---|---|
distributionId - UUID!
|
Example
Query
query vestingScheduleByDistributionId($distributionId: UUID!) {
vestingScheduleByDistributionId(distributionId: $distributionId) {
nodeId
distributionId
duration
cliff
periods
startsOn
currentPeriod
automatic
id
distributionByDistributionId {
...DistributionFragment
}
vestingDurationByDuration {
...VestingDurationFragment
}
vestingEventsByVestingScheduleId {
...VestingEventsConnectionFragment
}
}
}
Variables
{
"distributionId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
Response
{
"data": {
"vestingScheduleByDistributionId": {
"nodeId": 4,
"distributionId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"duration": "xyz789",
"cliff": 123,
"periods": 123,
"startsOn": Datetime,
"currentPeriod": 987,
"automatic": true,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"distributionByDistributionId": Distribution,
"vestingDurationByDuration": VestingDuration,
"vestingEventsByVestingScheduleId": VestingEventsConnection
}
}
}
vestingScheduleById
Response
Returns a VestingSchedule
Arguments
| Name | Description |
|---|---|
id - UUID!
|
Example
Query
query vestingScheduleById($id: UUID!) {
vestingScheduleById(id: $id) {
nodeId
distributionId
duration
cliff
periods
startsOn
currentPeriod
automatic
id
distributionByDistributionId {
...DistributionFragment
}
vestingDurationByDuration {
...VestingDurationFragment
}
vestingEventsByVestingScheduleId {
...VestingEventsConnectionFragment
}
}
}
Variables
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
Response
{
"data": {
"vestingScheduleById": {
"nodeId": "4",
"distributionId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"duration": "xyz789",
"cliff": 987,
"periods": 987,
"startsOn": Datetime,
"currentPeriod": 987,
"automatic": false,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"distributionByDistributionId": Distribution,
"vestingDurationByDuration": VestingDuration,
"vestingEventsByVestingScheduleId": VestingEventsConnection
}
}
}
walletAssignment
Description
Reads a single WalletAssignment using its globally unique ID.
Response
Returns a WalletAssignment
Arguments
| Name | Description |
|---|---|
nodeId - ID!
|
The globally unique ID to be used in selecting a single WalletAssignment. |
Example
Query
query walletAssignment($nodeId: ID!) {
walletAssignment(nodeId: $nodeId) {
nodeId
distributionId
blockchainAddressId
id
distributionByDistributionId {
...DistributionFragment
}
blockchainAddressByBlockchainAddressId {
...BlockchainAddressFragment
}
}
}
Variables
{"nodeId": 4}
Response
{
"data": {
"walletAssignment": {
"nodeId": 4,
"distributionId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"blockchainAddressId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"distributionByDistributionId": Distribution,
"blockchainAddressByBlockchainAddressId": BlockchainAddress
}
}
}
walletAssignmentByDistributionId
Response
Returns a WalletAssignment
Arguments
| Name | Description |
|---|---|
distributionId - UUID!
|
Example
Query
query walletAssignmentByDistributionId($distributionId: UUID!) {
walletAssignmentByDistributionId(distributionId: $distributionId) {
nodeId
distributionId
blockchainAddressId
id
distributionByDistributionId {
...DistributionFragment
}
blockchainAddressByBlockchainAddressId {
...BlockchainAddressFragment
}
}
}
Variables
{
"distributionId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
Response
{
"data": {
"walletAssignmentByDistributionId": {
"nodeId": "4",
"distributionId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"blockchainAddressId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"distributionByDistributionId": Distribution,
"blockchainAddressByBlockchainAddressId": BlockchainAddress
}
}
}
walletAssignmentById
Response
Returns a WalletAssignment
Arguments
| Name | Description |
|---|---|
id - UUID!
|
Example
Query
query walletAssignmentById($id: UUID!) {
walletAssignmentById(id: $id) {
nodeId
distributionId
blockchainAddressId
id
distributionByDistributionId {
...DistributionFragment
}
blockchainAddressByBlockchainAddressId {
...BlockchainAddressFragment
}
}
}
Variables
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
Response
{
"data": {
"walletAssignmentById": {
"nodeId": "4",
"distributionId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"blockchainAddressId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"distributionByDistributionId": Distribution,
"blockchainAddressByBlockchainAddressId": BlockchainAddress
}
}
}
webhookConfiguration
Description
Reads a single WebhookConfiguration using its globally unique ID.
Response
Returns a WebhookConfiguration
Arguments
| Name | Description |
|---|---|
nodeId - ID!
|
The globally unique ID to be used in selecting a single WebhookConfiguration. |
Example
Query
query webhookConfiguration($nodeId: ID!) {
webhookConfiguration(nodeId: $nodeId) {
nodeId
id
level
accountId
url
enabled
createdOn
secretKeyName
webhookLevelByLevel {
...WebhookLevelFragment
}
accountByAccountId {
...AccountFragment
}
}
}
Variables
{"nodeId": 4}
Response
{
"data": {
"webhookConfiguration": {
"nodeId": 4,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"level": "abc123",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"url": "xyz789",
"enabled": true,
"createdOn": Datetime,
"secretKeyName": "abc123",
"webhookLevelByLevel": WebhookLevel,
"accountByAccountId": Account
}
}
}
webhookConfigurationById
Response
Returns a WebhookConfiguration
Arguments
| Name | Description |
|---|---|
id - UUID!
|
Example
Query
query webhookConfigurationById($id: UUID!) {
webhookConfigurationById(id: $id) {
nodeId
id
level
accountId
url
enabled
createdOn
secretKeyName
webhookLevelByLevel {
...WebhookLevelFragment
}
accountByAccountId {
...AccountFragment
}
}
}
Variables
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
Response
{
"data": {
"webhookConfigurationById": {
"nodeId": "4",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"level": "xyz789",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"url": "abc123",
"enabled": false,
"createdOn": Datetime,
"secretKeyName": "xyz789",
"webhookLevelByLevel": WebhookLevel,
"accountByAccountId": Account
}
}
}
webhookConfigurationByLevelAndAccountId
Response
Returns a WebhookConfiguration
Example
Query
query webhookConfigurationByLevelAndAccountId(
$level: String!,
$accountId: UUID!
) {
webhookConfigurationByLevelAndAccountId(
level: $level,
accountId: $accountId
) {
nodeId
id
level
accountId
url
enabled
createdOn
secretKeyName
webhookLevelByLevel {
...WebhookLevelFragment
}
accountByAccountId {
...AccountFragment
}
}
}
Variables
{
"level": "abc123",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
Response
{
"data": {
"webhookConfigurationByLevelAndAccountId": {
"nodeId": 4,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"level": "abc123",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"url": "xyz789",
"enabled": true,
"createdOn": Datetime,
"secretKeyName": "abc123",
"webhookLevelByLevel": WebhookLevel,
"accountByAccountId": Account
}
}
}
webhookLevel
Description
Reads a single WebhookLevel using its globally unique ID.
Response
Returns a WebhookLevel
Arguments
| Name | Description |
|---|---|
nodeId - ID!
|
The globally unique ID to be used in selecting a single WebhookLevel. |
Example
Query
query webhookLevel($nodeId: ID!) {
webhookLevel(nodeId: $nodeId) {
nodeId
level
webhookConfigurationsByLevel {
...WebhookConfigurationsConnectionFragment
}
}
}
Variables
{"nodeId": 4}
Response
{
"data": {
"webhookLevel": {
"nodeId": "4",
"level": "xyz789",
"webhookConfigurationsByLevel": WebhookConfigurationsConnection
}
}
}
webhookLevelByLevel
Response
Returns a WebhookLevel
Arguments
| Name | Description |
|---|---|
level - String!
|
Example
Query
query webhookLevelByLevel($level: String!) {
webhookLevelByLevel(level: $level) {
nodeId
level
webhookConfigurationsByLevel {
...WebhookConfigurationsConnectionFragment
}
}
}
Variables
{"level": "xyz789"}
Response
{
"data": {
"webhookLevelByLevel": {
"nodeId": 4,
"level": "xyz789",
"webhookConfigurationsByLevel": WebhookConfigurationsConnection
}
}
}
Mutations
acceptTerms
Response
Returns an AcceptTermsPayload
Arguments
| Name | Description |
|---|---|
input - AcceptTermsInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation acceptTerms($input: AcceptTermsInput!) {
acceptTerms(input: $input) {
clientMutationId
termsOfService {
...TermsOfServiceFragment
}
query {
...QueryFragment
}
termsOfServiceTypeByType {
...TermsOfServiceTypeFragment
}
termsOfServiceEdge {
...TermsOfServicesEdgeFragment
}
}
}
Variables
{"input": AcceptTermsInput}
Response
{
"data": {
"acceptTerms": {
"clientMutationId": "xyz789",
"termsOfService": TermsOfService,
"query": Query,
"termsOfServiceTypeByType": TermsOfServiceType,
"termsOfServiceEdge": TermsOfServicesEdge
}
}
}
accountId
Response
Returns an AccountIdPayload
Arguments
| Name | Description |
|---|---|
input - AccountIdInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation accountId($input: AccountIdInput!) {
accountId(input: $input) {
clientMutationId
uuid
query {
...QueryFragment
}
}
}
Variables
{"input": AccountIdInput}
Response
{
"data": {
"accountId": {
"clientMutationId": "abc123",
"uuid": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"query": Query
}
}
}
batchTransfer
Response
Returns [StagedTransfer]
Arguments
| Name | Description |
|---|---|
input - BatchTransferInput
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation batchTransfer($input: BatchTransferInput) {
batchTransfer(input: $input) {
id
accountId
securityId
type
status
requestId
webhookId
data
createdOn
executedOn
order
securityBySecurityId {
...SecurityFragment
}
accountByAccountId {
...AccountFragment
}
requestByRequestId {
...RequestFragment
}
stagedTransferStatusByStatus {
...StagedTransferStatusFragment
}
transferTypeByType {
...TransferTypeFragment
}
stagedBalanceTransfersByTransferId {
...StagedBalanceTransfersConnectionFragment
}
stagedTransferAtsTagsByStagedTransferId {
...StagedTransferAtsTagsConnectionFragment
}
}
}
Variables
{"input": BatchTransferInput}
Response
{
"data": {
"batchTransfer": [
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"securityId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"type": "abc123",
"status": "abc123",
"requestId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"webhookId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"data": {},
"createdOn": Datetime,
"executedOn": Datetime,
"order": 123,
"securityBySecurityId": Security,
"accountByAccountId": Account,
"requestByRequestId": Request,
"stagedTransferStatusByStatus": StagedTransferStatus,
"transferTypeByType": TransferType,
"stagedBalanceTransfersByTransferId": StagedBalanceTransfersConnection,
"stagedTransferAtsTagsByStagedTransferId": StagedTransferAtsTagsConnection
}
]
}
}
bulkAllocation
Response
Returns an Allocation!
Example
Query
mutation bulkAllocation(
$fileName: String!,
$allocationId: UUID!
) {
bulkAllocation(
fileName: $fileName,
allocationId: $allocationId
) {
nodeId
ownerId
blockchainAddressId
issuerId
name
createdOn
opensOn
closesOn
status
roundId
id
accountByOwnerId {
...AccountFragment
}
blockchainAddressByBlockchainAddressId {
...BlockchainAddressFragment
}
accountByIssuerId {
...AccountFragment
}
assetStatusByStatus {
...AssetStatusFragment
}
roundByRoundId {
...RoundFragment
}
allocationArchivesByAllocationId {
...AllocationArchivesConnectionFragment
}
distributionsByAllocationId {
...DistributionsConnectionFragment
}
allocationAnnotationsByAllocationId {
...AllocationAnnotationsConnectionFragment
}
allocationsVestingScheduleByAllocationId {
...AllocationsVestingScheduleFragment
}
allocationsVestingSchedulesByAllocationId {
...AllocationsVestingSchedulesConnectionFragment
}
allocationQualificationsByAllocationId {
...AllocationQualificationsConnectionFragment
}
allocationOfferingLinksByAllocationId {
...AllocationOfferingLinksConnectionFragment
}
allocationEmailPreferenceByAllocationId {
...AllocationEmailPreferenceFragment
}
allocationEmailPreferencesByAllocationId {
...AllocationEmailPreferencesConnectionFragment
}
managedUnits
}
}
Variables
{
"fileName": "xyz789",
"allocationId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
Response
{
"data": {
"bulkAllocation": {
"nodeId": 4,
"ownerId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"blockchainAddressId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"issuerId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"name": "abc123",
"createdOn": Datetime,
"opensOn": Datetime,
"closesOn": Datetime,
"status": "abc123",
"roundId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountByOwnerId": Account,
"blockchainAddressByBlockchainAddressId": BlockchainAddress,
"accountByIssuerId": Account,
"assetStatusByStatus": AssetStatus,
"roundByRoundId": Round,
"allocationArchivesByAllocationId": AllocationArchivesConnection,
"distributionsByAllocationId": DistributionsConnection,
"allocationAnnotationsByAllocationId": AllocationAnnotationsConnection,
"allocationsVestingScheduleByAllocationId": AllocationsVestingSchedule,
"allocationsVestingSchedulesByAllocationId": AllocationsVestingSchedulesConnection,
"allocationQualificationsByAllocationId": AllocationQualificationsConnection,
"allocationOfferingLinksByAllocationId": AllocationOfferingLinksConnection,
"allocationEmailPreferenceByAllocationId": AllocationEmailPreference,
"allocationEmailPreferencesByAllocationId": AllocationEmailPreferencesConnection,
"managedUnits": BigFloat
}
}
}
bulkCustomers
Response
Returns [Customer]!
Arguments
| Name | Description |
|---|---|
fileName - String!
|
Example
Query
mutation bulkCustomers($fileName: String!) {
bulkCustomers(fileName: $fileName) {
nodeId
vendorId
investorId
status
name
id
setup
formationDate
investorType
jurisdiction
accountByVendorId {
...AccountFragment
}
accountByInvestorId {
...AccountFragment
}
invitationStatusByStatus {
...InvitationStatusFragment
}
investorAccountTypeByInvestorType {
...InvestorAccountTypeFragment
}
countryByJurisdiction {
...CountryFragment
}
customerPartiesByCustomerId {
...CustomerPartiesConnectionFragment
}
customerAddressesByCustomerId {
...CustomerAddressesConnectionFragment
}
}
}
Variables
{"fileName": "abc123"}
Response
{
"data": {
"bulkCustomers": [
{
"nodeId": 4,
"vendorId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"investorId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"status": "xyz789",
"name": "xyz789",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"setup": true,
"formationDate": "2007-12-03",
"investorType": "xyz789",
"jurisdiction": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountByVendorId": Account,
"accountByInvestorId": Account,
"invitationStatusByStatus": InvitationStatus,
"investorAccountTypeByInvestorType": InvestorAccountType,
"countryByJurisdiction": Country,
"customerPartiesByCustomerId": CustomerPartiesConnection,
"customerAddressesByCustomerId": CustomerAddressesConnection
}
]
}
}
bulkDeposit
Response
Returns [StagedTransfer]
Arguments
| Name | Description |
|---|---|
input - BulkDepositInput
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation bulkDeposit($input: BulkDepositInput) {
bulkDeposit(input: $input) {
id
accountId
securityId
type
status
requestId
webhookId
data
createdOn
executedOn
order
securityBySecurityId {
...SecurityFragment
}
accountByAccountId {
...AccountFragment
}
requestByRequestId {
...RequestFragment
}
stagedTransferStatusByStatus {
...StagedTransferStatusFragment
}
transferTypeByType {
...TransferTypeFragment
}
stagedBalanceTransfersByTransferId {
...StagedBalanceTransfersConnectionFragment
}
stagedTransferAtsTagsByStagedTransferId {
...StagedTransferAtsTagsConnectionFragment
}
}
}
Variables
{"input": BulkDepositInput}
Response
{
"data": {
"bulkDeposit": [
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"securityId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"type": "abc123",
"status": "abc123",
"requestId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"webhookId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"data": {},
"createdOn": Datetime,
"executedOn": Datetime,
"order": 987,
"securityBySecurityId": Security,
"accountByAccountId": Account,
"requestByRequestId": Request,
"stagedTransferStatusByStatus": StagedTransferStatus,
"transferTypeByType": TransferType,
"stagedBalanceTransfersByTransferId": StagedBalanceTransfersConnection,
"stagedTransferAtsTagsByStagedTransferId": StagedTransferAtsTagsConnection
}
]
}
}
bulkRound
Example
Query
mutation bulkRound(
$fileName: String!,
$roundId: UUID!
) {
bulkRound(
fileName: $fileName,
roundId: $roundId
)
}
Variables
{
"fileName": "xyz789",
"roundId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
Response
{"data": {"bulkRound": "abc123"}}
changeAllocationArchives
Response
Returns a ChangeAllocationArchivesPayload
Arguments
| Name | Description |
|---|---|
input - ChangeAllocationArchivesInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation changeAllocationArchives($input: ChangeAllocationArchivesInput!) {
changeAllocationArchives(input: $input) {
clientMutationId
allocationArchives {
...AllocationArchiveFragment
}
query {
...QueryFragment
}
}
}
Variables
{"input": ChangeAllocationArchivesInput}
Response
{
"data": {
"changeAllocationArchives": {
"clientMutationId": "xyz789",
"allocationArchives": [AllocationArchive],
"query": Query
}
}
}
changeAssetArchives
Response
Returns a ChangeAssetArchivesPayload
Arguments
| Name | Description |
|---|---|
input - ChangeAssetArchivesInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation changeAssetArchives($input: ChangeAssetArchivesInput!) {
changeAssetArchives(input: $input) {
clientMutationId
assetArchives {
...AssetArchiveFragment
}
query {
...QueryFragment
}
}
}
Variables
{"input": ChangeAssetArchivesInput}
Response
{
"data": {
"changeAssetArchives": {
"clientMutationId": "xyz789",
"assetArchives": [AssetArchive],
"query": Query
}
}
}
completeAccountIntegrationStep
Response
Returns a CompleteAccountIntegrationStepPayload
Arguments
| Name | Description |
|---|---|
input - CompleteAccountIntegrationStepInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation completeAccountIntegrationStep($input: CompleteAccountIntegrationStepInput!) {
completeAccountIntegrationStep(input: $input) {
clientMutationId
accountIntegration {
...AccountIntegrationFragment
}
query {
...QueryFragment
}
integrationByIntegrationId {
...IntegrationFragment
}
accountByAccountId {
...AccountFragment
}
stepByStepId {
...StepFragment
}
accountIntegrationEdge {
...AccountIntegrationsEdgeFragment
}
}
}
Variables
{"input": CompleteAccountIntegrationStepInput}
Response
{
"data": {
"completeAccountIntegrationStep": {
"clientMutationId": "abc123",
"accountIntegration": AccountIntegration,
"query": Query,
"integrationByIntegrationId": Integration,
"accountByAccountId": Account,
"stepByStepId": Step,
"accountIntegrationEdge": AccountIntegrationsEdge
}
}
}
completeDistributionStep
Response
Returns a CompleteDistributionStepPayload
Arguments
| Name | Description |
|---|---|
input - CompleteDistributionStepInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation completeDistributionStep($input: CompleteDistributionStepInput!) {
completeDistributionStep(input: $input) {
clientMutationId
distribution {
...DistributionFragment
}
query {
...QueryFragment
}
allocationByAllocationId {
...AllocationFragment
}
accountByInvestorId {
...AccountFragment
}
distributionStatusByStatus {
...DistributionStatusFragment
}
stepByStepId {
...StepFragment
}
distributionEdge {
...DistributionsEdgeFragment
}
}
}
Variables
{"input": CompleteDistributionStepInput}
Response
{
"data": {
"completeDistributionStep": {
"clientMutationId": "abc123",
"distribution": Distribution,
"query": Query,
"allocationByAllocationId": Allocation,
"accountByInvestorId": Account,
"distributionStatusByStatus": DistributionStatus,
"stepByStepId": Step,
"distributionEdge": DistributionsEdge
}
}
}
completeStep
Response
Returns a CompleteStepPayload
Arguments
| Name | Description |
|---|---|
input - CompleteStepInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation completeStep($input: CompleteStepInput!) {
completeStep(input: $input) {
clientMutationId
step {
...StepFragment
}
query {
...QueryFragment
}
accountByOwnedBy {
...AccountFragment
}
accountByExecuteBy {
...AccountFragment
}
stepStatusByStatus {
...StepStatusFragment
}
stepTypeByType {
...StepTypeFragment
}
stepEdge {
...StepsEdgeFragment
}
}
}
Variables
{"input": CompleteStepInput}
Response
{
"data": {
"completeStep": {
"clientMutationId": "abc123",
"step": Step,
"query": Query,
"accountByOwnedBy": Account,
"accountByExecuteBy": Account,
"stepStatusByStatus": StepStatus,
"stepTypeByType": StepType,
"stepEdge": StepsEdge
}
}
}
createAccountIntegration
Description
Creates a single AccountIntegration.
Response
Returns a CreateAccountIntegrationPayload
Arguments
| Name | Description |
|---|---|
input - CreateAccountIntegrationInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation createAccountIntegration($input: CreateAccountIntegrationInput!) {
createAccountIntegration(input: $input) {
clientMutationId
accountIntegration {
...AccountIntegrationFragment
}
query {
...QueryFragment
}
integrationByIntegrationId {
...IntegrationFragment
}
accountByAccountId {
...AccountFragment
}
stepByStepId {
...StepFragment
}
accountIntegrationEdge {
...AccountIntegrationsEdgeFragment
}
}
}
Variables
{"input": CreateAccountIntegrationInput}
Response
{
"data": {
"createAccountIntegration": {
"clientMutationId": "xyz789",
"accountIntegration": AccountIntegration,
"query": Query,
"integrationByIntegrationId": Integration,
"accountByAccountId": Account,
"stepByStepId": Step,
"accountIntegrationEdge": AccountIntegrationsEdge
}
}
}
createAccountPhoneNumber
Description
Creates a single AccountPhoneNumber.
Response
Returns a CreateAccountPhoneNumberPayload
Arguments
| Name | Description |
|---|---|
input - CreateAccountPhoneNumberInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation createAccountPhoneNumber($input: CreateAccountPhoneNumberInput!) {
createAccountPhoneNumber(input: $input) {
clientMutationId
accountPhoneNumber {
...AccountPhoneNumberFragment
}
query {
...QueryFragment
}
accountByAccountId {
...AccountFragment
}
phoneNumberTypeByType {
...PhoneNumberTypeFragment
}
accountPhoneNumberEdge {
...AccountPhoneNumbersEdgeFragment
}
}
}
Variables
{"input": CreateAccountPhoneNumberInput}
Response
{
"data": {
"createAccountPhoneNumber": {
"clientMutationId": "abc123",
"accountPhoneNumber": AccountPhoneNumber,
"query": Query,
"accountByAccountId": Account,
"phoneNumberTypeByType": PhoneNumberType,
"accountPhoneNumberEdge": AccountPhoneNumbersEdge
}
}
}
createAccountRegDStatus
Description
Creates a single AccountRegDStatus.
Response
Returns a CreateAccountRegDStatusPayload
Arguments
| Name | Description |
|---|---|
input - CreateAccountRegDStatusInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation createAccountRegDStatus($input: CreateAccountRegDStatusInput!) {
createAccountRegDStatus(input: $input) {
clientMutationId
accountRegDStatus {
...AccountRegDStatusFragment
}
query {
...QueryFragment
}
accountByAccountId {
...AccountFragment
}
accountRegDStatusEdge {
...AccountRegDStatusesEdgeFragment
}
}
}
Variables
{"input": CreateAccountRegDStatusInput}
Response
{
"data": {
"createAccountRegDStatus": {
"clientMutationId": "abc123",
"accountRegDStatus": AccountRegDStatus,
"query": Query,
"accountByAccountId": Account,
"accountRegDStatusEdge": AccountRegDStatusesEdge
}
}
}
createAccountRestriction
Description
Creates a single AccountRestriction.
Response
Returns a CreateAccountRestrictionPayload
Arguments
| Name | Description |
|---|---|
input - CreateAccountRestrictionInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation createAccountRestriction($input: CreateAccountRestrictionInput!) {
createAccountRestriction(input: $input) {
clientMutationId
accountRestriction {
...AccountRestrictionFragment
}
query {
...QueryFragment
}
accountByAccountId {
...AccountFragment
}
restrictionReasonByReasonId {
...RestrictionReasonFragment
}
userByCreatorUserId {
...UserFragment
}
accountByCreatorAccountId {
...AccountFragment
}
accountRestrictionEdge {
...AccountRestrictionsEdgeFragment
}
}
}
Variables
{"input": CreateAccountRestrictionInput}
Response
{
"data": {
"createAccountRestriction": {
"clientMutationId": "abc123",
"accountRestriction": AccountRestriction,
"query": Query,
"accountByAccountId": Account,
"restrictionReasonByReasonId": RestrictionReason,
"userByCreatorUserId": User,
"accountByCreatorAccountId": Account,
"accountRestrictionEdge": AccountRestrictionsEdge
}
}
}
createAllocation
Description
Creates a single Allocation.
Response
Returns a CreateAllocationPayload
Arguments
| Name | Description |
|---|---|
input - CreateAllocationInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation createAllocation($input: CreateAllocationInput!) {
createAllocation(input: $input) {
clientMutationId
allocation {
...AllocationFragment
}
query {
...QueryFragment
}
accountByOwnerId {
...AccountFragment
}
blockchainAddressByBlockchainAddressId {
...BlockchainAddressFragment
}
accountByIssuerId {
...AccountFragment
}
assetStatusByStatus {
...AssetStatusFragment
}
roundByRoundId {
...RoundFragment
}
allocationEdge {
...AllocationsEdgeFragment
}
}
}
Variables
{"input": CreateAllocationInput}
Response
{
"data": {
"createAllocation": {
"clientMutationId": "abc123",
"allocation": Allocation,
"query": Query,
"accountByOwnerId": Account,
"blockchainAddressByBlockchainAddressId": BlockchainAddress,
"accountByIssuerId": Account,
"assetStatusByStatus": AssetStatus,
"roundByRoundId": Round,
"allocationEdge": AllocationsEdge
}
}
}
createAllocationAnnotation
Description
Creates a single AllocationAnnotation.
Response
Returns a CreateAllocationAnnotationPayload
Arguments
| Name | Description |
|---|---|
input - CreateAllocationAnnotationInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation createAllocationAnnotation($input: CreateAllocationAnnotationInput!) {
createAllocationAnnotation(input: $input) {
clientMutationId
allocationAnnotation {
...AllocationAnnotationFragment
}
query {
...QueryFragment
}
allocationByAllocationId {
...AllocationFragment
}
userByWrittenBy {
...UserFragment
}
accountByAccountId {
...AccountFragment
}
allocationAnnotationEdge {
...AllocationAnnotationsEdgeFragment
}
}
}
Variables
{"input": CreateAllocationAnnotationInput}
Response
{
"data": {
"createAllocationAnnotation": {
"clientMutationId": "abc123",
"allocationAnnotation": AllocationAnnotation,
"query": Query,
"allocationByAllocationId": Allocation,
"userByWrittenBy": User,
"accountByAccountId": Account,
"allocationAnnotationEdge": AllocationAnnotationsEdge
}
}
}
createAllocationQualification
Description
Creates a single AllocationQualification.
Response
Returns a CreateAllocationQualificationPayload
Arguments
| Name | Description |
|---|---|
input - CreateAllocationQualificationInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation createAllocationQualification($input: CreateAllocationQualificationInput!) {
createAllocationQualification(input: $input) {
clientMutationId
allocationQualification {
...AllocationQualificationFragment
}
query {
...QueryFragment
}
allocationByAllocationId {
...AllocationFragment
}
vendorQualificationByVendorQualificationId {
...VendorQualificationFragment
}
allocationQualificationEdge {
...AllocationQualificationsEdgeFragment
}
}
}
Variables
{"input": CreateAllocationQualificationInput}
Response
{
"data": {
"createAllocationQualification": {
"clientMutationId": "xyz789",
"allocationQualification": AllocationQualification,
"query": Query,
"allocationByAllocationId": Allocation,
"vendorQualificationByVendorQualificationId": VendorQualification,
"allocationQualificationEdge": AllocationQualificationsEdge
}
}
}
createAllocationsVestingSchedule
Description
Creates a single AllocationsVestingSchedule.
Response
Returns a CreateAllocationsVestingSchedulePayload
Arguments
| Name | Description |
|---|---|
input - CreateAllocationsVestingScheduleInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation createAllocationsVestingSchedule($input: CreateAllocationsVestingScheduleInput!) {
createAllocationsVestingSchedule(input: $input) {
clientMutationId
allocationsVestingSchedule {
...AllocationsVestingScheduleFragment
}
query {
...QueryFragment
}
allocationByAllocationId {
...AllocationFragment
}
vestingDurationByDuration {
...VestingDurationFragment
}
allocationsVestingScheduleEdge {
...AllocationsVestingSchedulesEdgeFragment
}
}
}
Variables
{"input": CreateAllocationsVestingScheduleInput}
Response
{
"data": {
"createAllocationsVestingSchedule": {
"clientMutationId": "abc123",
"allocationsVestingSchedule": AllocationsVestingSchedule,
"query": Query,
"allocationByAllocationId": Allocation,
"vestingDurationByDuration": VestingDuration,
"allocationsVestingScheduleEdge": AllocationsVestingSchedulesEdge
}
}
}
createAsset
Description
Creates a single Asset.
Response
Returns a CreateAssetPayload
Arguments
| Name | Description |
|---|---|
input - CreateAssetInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation createAsset($input: CreateAssetInput!) {
createAsset(input: $input) {
clientMutationId
asset {
...AssetFragment
}
query {
...QueryFragment
}
accountByIssuerId {
...AccountFragment
}
assetTypeByType {
...AssetTypeFragment
}
assetStatusByStatus {
...AssetStatusFragment
}
assetEdge {
...AssetsEdgeFragment
}
}
}
Variables
{"input": CreateAssetInput}
Response
{
"data": {
"createAsset": {
"clientMutationId": "abc123",
"asset": Asset,
"query": Query,
"accountByIssuerId": Account,
"assetTypeByType": AssetType,
"assetStatusByStatus": AssetStatus,
"assetEdge": AssetsEdge
}
}
}
createAssetAnnotation
Description
Creates a single AssetAnnotation.
Response
Returns a CreateAssetAnnotationPayload
Arguments
| Name | Description |
|---|---|
input - CreateAssetAnnotationInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation createAssetAnnotation($input: CreateAssetAnnotationInput!) {
createAssetAnnotation(input: $input) {
clientMutationId
assetAnnotation {
...AssetAnnotationFragment
}
query {
...QueryFragment
}
assetByAssetId {
...AssetFragment
}
userByWrittenBy {
...UserFragment
}
accountByAccountId {
...AccountFragment
}
assetAnnotationEdge {
...AssetAnnotationsEdgeFragment
}
}
}
Variables
{"input": CreateAssetAnnotationInput}
Response
{
"data": {
"createAssetAnnotation": {
"clientMutationId": "abc123",
"assetAnnotation": AssetAnnotation,
"query": Query,
"assetByAssetId": Asset,
"userByWrittenBy": User,
"accountByAccountId": Account,
"assetAnnotationEdge": AssetAnnotationsEdge
}
}
}
createAuxAccount
Description
Creates a single AuxAccount.
Response
Returns a CreateAuxAccountPayload
Arguments
| Name | Description |
|---|---|
input - CreateAuxAccountInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation createAuxAccount($input: CreateAuxAccountInput!) {
createAuxAccount(input: $input) {
clientMutationId
auxAccount {
...AuxAccountFragment
}
query {
...QueryFragment
}
auxAccountEdge {
...AuxAccountsEdgeFragment
}
}
}
Variables
{"input": CreateAuxAccountInput}
Response
{
"data": {
"createAuxAccount": {
"clientMutationId": "abc123",
"auxAccount": AuxAccount,
"query": Query,
"auxAccountEdge": AuxAccountsEdge
}
}
}
createAuxRole
Description
Creates a single AuxRole.
Response
Returns a CreateAuxRolePayload
Arguments
| Name | Description |
|---|---|
input - CreateAuxRoleInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation createAuxRole($input: CreateAuxRoleInput!) {
createAuxRole(input: $input) {
clientMutationId
auxRole {
...AuxRoleFragment
}
query {
...QueryFragment
}
auxRoleEdge {
...AuxRolesEdgeFragment
}
}
}
Variables
{"input": CreateAuxRoleInput}
Response
{
"data": {
"createAuxRole": {
"clientMutationId": "xyz789",
"auxRole": AuxRole,
"query": Query,
"auxRoleEdge": AuxRolesEdge
}
}
}
createBrokerAllocation
Description
Creates a single BrokerAllocation.
Response
Returns a CreateBrokerAllocationPayload
Arguments
| Name | Description |
|---|---|
input - CreateBrokerAllocationInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation createBrokerAllocation($input: CreateBrokerAllocationInput!) {
createBrokerAllocation(input: $input) {
clientMutationId
brokerAllocation {
...BrokerAllocationFragment
}
query {
...QueryFragment
}
accountByBrokerId {
...AccountFragment
}
invitationStatusByStatus {
...InvitationStatusFragment
}
roundByRoundId {
...RoundFragment
}
brokerAllocationEdge {
...BrokerAllocationsEdgeFragment
}
}
}
Variables
{"input": CreateBrokerAllocationInput}
Response
{
"data": {
"createBrokerAllocation": {
"clientMutationId": "abc123",
"brokerAllocation": BrokerAllocation,
"query": Query,
"accountByBrokerId": Account,
"invitationStatusByStatus": InvitationStatus,
"roundByRoundId": Round,
"brokerAllocationEdge": BrokerAllocationsEdge
}
}
}
createCapitalDeployment
Description
Creates a single CapitalDeployment.
Response
Returns a CreateCapitalDeploymentPayload
Arguments
| Name | Description |
|---|---|
input - CreateCapitalDeploymentInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation createCapitalDeployment($input: CreateCapitalDeploymentInput!) {
createCapitalDeployment(input: $input) {
clientMutationId
capitalDeployment {
...CapitalDeploymentFragment
}
query {
...QueryFragment
}
currencyByCurrency {
...CurrencyFragment
}
roundByRoundId {
...RoundFragment
}
capitalDeploymentEdge {
...CapitalDeploymentsEdgeFragment
}
}
}
Variables
{"input": CreateCapitalDeploymentInput}
Response
{
"data": {
"createCapitalDeployment": {
"clientMutationId": "abc123",
"capitalDeployment": CapitalDeployment,
"query": Query,
"currencyByCurrency": Currency,
"roundByRoundId": Round,
"capitalDeploymentEdge": CapitalDeploymentsEdge
}
}
}
createDistribution
Description
Creates a single Distribution.
Response
Returns a CreateDistributionPayload
Arguments
| Name | Description |
|---|---|
input - CreateDistributionInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation createDistribution($input: CreateDistributionInput!) {
createDistribution(input: $input) {
clientMutationId
distribution {
...DistributionFragment
}
query {
...QueryFragment
}
allocationByAllocationId {
...AllocationFragment
}
accountByInvestorId {
...AccountFragment
}
distributionStatusByStatus {
...DistributionStatusFragment
}
stepByStepId {
...StepFragment
}
distributionEdge {
...DistributionsEdgeFragment
}
}
}
Variables
{"input": CreateDistributionInput}
Response
{
"data": {
"createDistribution": {
"clientMutationId": "xyz789",
"distribution": Distribution,
"query": Query,
"allocationByAllocationId": Allocation,
"accountByInvestorId": Account,
"distributionStatusByStatus": DistributionStatus,
"stepByStepId": Step,
"distributionEdge": DistributionsEdge
}
}
}
createDistributionAnnotation
Description
Creates a single DistributionAnnotation.
Response
Returns a CreateDistributionAnnotationPayload
Arguments
| Name | Description |
|---|---|
input - CreateDistributionAnnotationInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation createDistributionAnnotation($input: CreateDistributionAnnotationInput!) {
createDistributionAnnotation(input: $input) {
clientMutationId
distributionAnnotation {
...DistributionAnnotationFragment
}
query {
...QueryFragment
}
distributionByDistributionId {
...DistributionFragment
}
userByWrittenBy {
...UserFragment
}
accountByAccountId {
...AccountFragment
}
distributionAnnotationEdge {
...DistributionAnnotationsEdgeFragment
}
}
}
Variables
{"input": CreateDistributionAnnotationInput}
Response
{
"data": {
"createDistributionAnnotation": {
"clientMutationId": "xyz789",
"distributionAnnotation": DistributionAnnotation,
"query": Query,
"distributionByDistributionId": Distribution,
"userByWrittenBy": User,
"accountByAccountId": Account,
"distributionAnnotationEdge": DistributionAnnotationsEdge
}
}
}
createDistributionCustomField
Description
Creates a single DistributionCustomField.
Response
Returns a CreateDistributionCustomFieldPayload
Arguments
| Name | Description |
|---|---|
input - CreateDistributionCustomFieldInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation createDistributionCustomField($input: CreateDistributionCustomFieldInput!) {
createDistributionCustomField(input: $input) {
clientMutationId
distributionCustomField {
...DistributionCustomFieldFragment
}
query {
...QueryFragment
}
accountByCreatedBy {
...AccountFragment
}
distributionByDistributionId {
...DistributionFragment
}
distributionCustomFieldEdge {
...DistributionCustomFieldsEdgeFragment
}
}
}
Variables
{"input": CreateDistributionCustomFieldInput}
Response
{
"data": {
"createDistributionCustomField": {
"clientMutationId": "abc123",
"distributionCustomField": DistributionCustomField,
"query": Query,
"accountByCreatedBy": Account,
"distributionByDistributionId": Distribution,
"distributionCustomFieldEdge": DistributionCustomFieldsEdge
}
}
}
createDistributionPayment
Description
Creates a single DistributionPayment.
Response
Returns a CreateDistributionPaymentPayload
Arguments
| Name | Description |
|---|---|
input - CreateDistributionPaymentInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation createDistributionPayment($input: CreateDistributionPaymentInput!) {
createDistributionPayment(input: $input) {
clientMutationId
distributionPayment {
...DistributionPaymentFragment
}
query {
...QueryFragment
}
distributionByDistributionId {
...DistributionFragment
}
currencyByCurrency {
...CurrencyFragment
}
distributionPaymentStatusByStatus {
...DistributionPaymentStatusFragment
}
distributionPaymentEdge {
...DistributionPaymentsEdgeFragment
}
}
}
Variables
{"input": CreateDistributionPaymentInput}
Response
{
"data": {
"createDistributionPayment": {
"clientMutationId": "xyz789",
"distributionPayment": DistributionPayment,
"query": Query,
"distributionByDistributionId": Distribution,
"currencyByCurrency": Currency,
"distributionPaymentStatusByStatus": DistributionPaymentStatus,
"distributionPaymentEdge": DistributionPaymentsEdge
}
}
}
createDistributionPrice
Description
Creates a single DistributionPrice.
Response
Returns a CreateDistributionPricePayload
Arguments
| Name | Description |
|---|---|
input - CreateDistributionPriceInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation createDistributionPrice($input: CreateDistributionPriceInput!) {
createDistributionPrice(input: $input) {
clientMutationId
distributionPrice {
...DistributionPriceFragment
}
query {
...QueryFragment
}
distributionByDistributionId {
...DistributionFragment
}
currencyByCurrency {
...CurrencyFragment
}
distributionPriceEdge {
...DistributionPricesEdgeFragment
}
}
}
Variables
{"input": CreateDistributionPriceInput}
Response
{
"data": {
"createDistributionPrice": {
"clientMutationId": "abc123",
"distributionPrice": DistributionPrice,
"query": Query,
"distributionByDistributionId": Distribution,
"currencyByCurrency": Currency,
"distributionPriceEdge": DistributionPricesEdge
}
}
}
createEmailTemplateTo
Description
Creates a single EmailTemplateTo.
Response
Returns a CreateEmailTemplateToPayload
Arguments
| Name | Description |
|---|---|
input - CreateEmailTemplateToInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation createEmailTemplateTo($input: CreateEmailTemplateToInput!) {
createEmailTemplateTo(input: $input) {
clientMutationId
emailTemplateTo {
...EmailTemplateToFragment
}
query {
...QueryFragment
}
emailTemplateToEdge {
...EmailTemplateTosEdgeFragment
}
}
}
Variables
{"input": CreateEmailTemplateToInput}
Response
{
"data": {
"createEmailTemplateTo": {
"clientMutationId": "abc123",
"emailTemplateTo": EmailTemplateTo,
"query": Query,
"emailTemplateToEdge": EmailTemplateTosEdge
}
}
}
createIdempotentType
Description
Creates a single IdempotentType.
Response
Returns a CreateIdempotentTypePayload
Arguments
| Name | Description |
|---|---|
input - CreateIdempotentTypeInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation createIdempotentType($input: CreateIdempotentTypeInput!) {
createIdempotentType(input: $input) {
clientMutationId
idempotentType {
...IdempotentTypeFragment
}
query {
...QueryFragment
}
idempotentTypeEdge {
...IdempotentTypesEdgeFragment
}
}
}
Variables
{"input": CreateIdempotentTypeInput}
Response
{
"data": {
"createIdempotentType": {
"clientMutationId": "xyz789",
"idempotentType": IdempotentType,
"query": Query,
"idempotentTypeEdge": IdempotentTypesEdge
}
}
}
createInstancedAccountInformationHistory
Description
Creates a single InstancedAccountInformationHistory.
Response
Arguments
| Name | Description |
|---|---|
input - CreateInstancedAccountInformationHistoryInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation createInstancedAccountInformationHistory($input: CreateInstancedAccountInformationHistoryInput!) {
createInstancedAccountInformationHistory(input: $input) {
clientMutationId
instancedAccountInformationHistory {
...InstancedAccountInformationHistoryFragment
}
query {
...QueryFragment
}
instancedAccountInformationByRecordId {
...InstancedAccountInformationFragment
}
instancedAccountInformationHistoryEdge {
...InstancedAccountInformationHistoriesEdgeFragment
}
}
}
Variables
{"input": CreateInstancedAccountInformationHistoryInput}
Response
{
"data": {
"createInstancedAccountInformationHistory": {
"clientMutationId": "xyz789",
"instancedAccountInformationHistory": InstancedAccountInformationHistory,
"query": Query,
"instancedAccountInformationByRecordId": InstancedAccountInformation,
"instancedAccountInformationHistoryEdge": InstancedAccountInformationHistoriesEdge
}
}
}
createMappedSigningTemplate
Description
Creates a single MappedSigningTemplate.
Response
Returns a CreateMappedSigningTemplatePayload
Arguments
| Name | Description |
|---|---|
input - CreateMappedSigningTemplateInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation createMappedSigningTemplate($input: CreateMappedSigningTemplateInput!) {
createMappedSigningTemplate(input: $input) {
clientMutationId
mappedSigningTemplate {
...MappedSigningTemplateFragment
}
query {
...QueryFragment
}
accountByAccountId {
...AccountFragment
}
signingTemplateBySigningTemplateId {
...SigningTemplateFragment
}
stepByStepId {
...StepFragment
}
vendorQualificationByVendorQualificationId {
...VendorQualificationFragment
}
signingStepTypeByQualificationStepType {
...SigningStepTypeFragment
}
mappedSigningTemplateEdge {
...MappedSigningTemplatesEdgeFragment
}
}
}
Variables
{"input": CreateMappedSigningTemplateInput}
Response
{
"data": {
"createMappedSigningTemplate": {
"clientMutationId": "abc123",
"mappedSigningTemplate": MappedSigningTemplate,
"query": Query,
"accountByAccountId": Account,
"signingTemplateBySigningTemplateId": SigningTemplate,
"stepByStepId": Step,
"vendorQualificationByVendorQualificationId": VendorQualification,
"signingStepTypeByQualificationStepType": SigningStepType,
"mappedSigningTemplateEdge": MappedSigningTemplatesEdge
}
}
}
createMappedSigningTemplateQuestionSet
Description
Creates a single MappedSigningTemplateQuestionSet.
Response
Arguments
| Name | Description |
|---|---|
input - CreateMappedSigningTemplateQuestionSetInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation createMappedSigningTemplateQuestionSet($input: CreateMappedSigningTemplateQuestionSetInput!) {
createMappedSigningTemplateQuestionSet(input: $input) {
clientMutationId
mappedSigningTemplateQuestionSet {
...MappedSigningTemplateQuestionSetFragment
}
query {
...QueryFragment
}
onboardingQuestionSetByOnboardingQuestionSetId {
...OnboardingQuestionSetFragment
}
mappedSigningTemplateByMappedSigningTemplateId {
...MappedSigningTemplateFragment
}
mappedSigningTemplateQuestionSetEdge {
...MappedSigningTemplateQuestionSetsEdgeFragment
}
}
}
Variables
{"input": CreateMappedSigningTemplateQuestionSetInput}
Response
{
"data": {
"createMappedSigningTemplateQuestionSet": {
"clientMutationId": "xyz789",
"mappedSigningTemplateQuestionSet": MappedSigningTemplateQuestionSet,
"query": Query,
"onboardingQuestionSetByOnboardingQuestionSetId": OnboardingQuestionSet,
"mappedSigningTemplateByMappedSigningTemplateId": MappedSigningTemplate,
"mappedSigningTemplateQuestionSetEdge": MappedSigningTemplateQuestionSetsEdge
}
}
}
createOnboardingQuestion
Description
Creates a single OnboardingQuestion.
Response
Returns a CreateOnboardingQuestionPayload
Arguments
| Name | Description |
|---|---|
input - CreateOnboardingQuestionInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation createOnboardingQuestion($input: CreateOnboardingQuestionInput!) {
createOnboardingQuestion(input: $input) {
clientMutationId
onboardingQuestion {
...OnboardingQuestionFragment
}
query {
...QueryFragment
}
accountByAccountId {
...AccountFragment
}
onboardingQuestionTypeByType {
...OnboardingQuestionTypeFragment
}
onboardingQuestionEdge {
...OnboardingQuestionsEdgeFragment
}
}
}
Variables
{"input": CreateOnboardingQuestionInput}
Response
{
"data": {
"createOnboardingQuestion": {
"clientMutationId": "abc123",
"onboardingQuestion": OnboardingQuestion,
"query": Query,
"accountByAccountId": Account,
"onboardingQuestionTypeByType": OnboardingQuestionType,
"onboardingQuestionEdge": OnboardingQuestionsEdge
}
}
}
createOnboardingQuestionJoin
Description
Creates a single OnboardingQuestionJoin.
Response
Returns a CreateOnboardingQuestionJoinPayload
Arguments
| Name | Description |
|---|---|
input - CreateOnboardingQuestionJoinInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation createOnboardingQuestionJoin($input: CreateOnboardingQuestionJoinInput!) {
createOnboardingQuestionJoin(input: $input) {
clientMutationId
onboardingQuestionJoin {
...OnboardingQuestionJoinFragment
}
query {
...QueryFragment
}
onboardingQuestionSetByOnboardingQuestionSetId {
...OnboardingQuestionSetFragment
}
onboardingQuestionByOnboardingQuestionId {
...OnboardingQuestionFragment
}
onboardingQuestionJoinEdge {
...OnboardingQuestionJoinsEdgeFragment
}
}
}
Variables
{"input": CreateOnboardingQuestionJoinInput}
Response
{
"data": {
"createOnboardingQuestionJoin": {
"clientMutationId": "xyz789",
"onboardingQuestionJoin": OnboardingQuestionJoin,
"query": Query,
"onboardingQuestionSetByOnboardingQuestionSetId": OnboardingQuestionSet,
"onboardingQuestionByOnboardingQuestionId": OnboardingQuestion,
"onboardingQuestionJoinEdge": OnboardingQuestionJoinsEdge
}
}
}
createOnboardingQuestionSet
Description
Creates a single OnboardingQuestionSet.
Response
Returns a CreateOnboardingQuestionSetPayload
Arguments
| Name | Description |
|---|---|
input - CreateOnboardingQuestionSetInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation createOnboardingQuestionSet($input: CreateOnboardingQuestionSetInput!) {
createOnboardingQuestionSet(input: $input) {
clientMutationId
onboardingQuestionSet {
...OnboardingQuestionSetFragment
}
query {
...QueryFragment
}
accountByAccountId {
...AccountFragment
}
vendorQualificationByVendorQualificationId {
...VendorQualificationFragment
}
onboardingQuestionSetEdge {
...OnboardingQuestionSetsEdgeFragment
}
}
}
Variables
{"input": CreateOnboardingQuestionSetInput}
Response
{
"data": {
"createOnboardingQuestionSet": {
"clientMutationId": "abc123",
"onboardingQuestionSet": OnboardingQuestionSet,
"query": Query,
"accountByAccountId": Account,
"vendorQualificationByVendorQualificationId": VendorQualification,
"onboardingQuestionSetEdge": OnboardingQuestionSetsEdge
}
}
}
createPaymentMethod
Description
Creates a single PaymentMethod.
Response
Returns a CreatePaymentMethodPayload
Arguments
| Name | Description |
|---|---|
input - CreatePaymentMethodInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation createPaymentMethod($input: CreatePaymentMethodInput!) {
createPaymentMethod(input: $input) {
clientMutationId
paymentMethod {
...PaymentMethodFragment
}
query {
...QueryFragment
}
accountByAccountId {
...AccountFragment
}
integrationByIntegrationId {
...IntegrationFragment
}
paymentMethodTypeByType {
...PaymentMethodTypeFragment
}
paymentMethodEdge {
...PaymentMethodsEdgeFragment
}
}
}
Variables
{"input": CreatePaymentMethodInput}
Response
{
"data": {
"createPaymentMethod": {
"clientMutationId": "abc123",
"paymentMethod": PaymentMethod,
"query": Query,
"accountByAccountId": Account,
"integrationByIntegrationId": Integration,
"paymentMethodTypeByType": PaymentMethodType,
"paymentMethodEdge": PaymentMethodsEdge
}
}
}
createPaymentMethodType
Description
Creates a single PaymentMethodType.
Response
Returns a CreatePaymentMethodTypePayload
Arguments
| Name | Description |
|---|---|
input - CreatePaymentMethodTypeInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation createPaymentMethodType($input: CreatePaymentMethodTypeInput!) {
createPaymentMethodType(input: $input) {
clientMutationId
paymentMethodType {
...PaymentMethodTypeFragment
}
query {
...QueryFragment
}
paymentMethodTypeEdge {
...PaymentMethodTypesEdgeFragment
}
}
}
Variables
{"input": CreatePaymentMethodTypeInput}
Response
{
"data": {
"createPaymentMethodType": {
"clientMutationId": "abc123",
"paymentMethodType": PaymentMethodType,
"query": Query,
"paymentMethodTypeEdge": PaymentMethodTypesEdge
}
}
}
createPaymentStepType
Description
Creates a single PaymentStepType.
Response
Returns a CreatePaymentStepTypePayload
Arguments
| Name | Description |
|---|---|
input - CreatePaymentStepTypeInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation createPaymentStepType($input: CreatePaymentStepTypeInput!) {
createPaymentStepType(input: $input) {
clientMutationId
paymentStepType {
...PaymentStepTypeFragment
}
query {
...QueryFragment
}
paymentStepTypeEdge {
...PaymentStepTypesEdgeFragment
}
}
}
Variables
{"input": CreatePaymentStepTypeInput}
Response
{
"data": {
"createPaymentStepType": {
"clientMutationId": "xyz789",
"paymentStepType": PaymentStepType,
"query": Query,
"paymentStepTypeEdge": PaymentStepTypesEdge
}
}
}
createRequestType
Description
Creates a single RequestType.
Response
Returns a CreateRequestTypePayload
Arguments
| Name | Description |
|---|---|
input - CreateRequestTypeInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation createRequestType($input: CreateRequestTypeInput!) {
createRequestType(input: $input) {
clientMutationId
requestType {
...RequestTypeFragment
}
query {
...QueryFragment
}
requestTypeEdge {
...RequestTypesEdgeFragment
}
}
}
Variables
{"input": CreateRequestTypeInput}
Response
{
"data": {
"createRequestType": {
"clientMutationId": "xyz789",
"requestType": RequestType,
"query": Query,
"requestTypeEdge": RequestTypesEdge
}
}
}
createRestrictionCategory
Description
Creates a single RestrictionCategory.
Response
Returns a CreateRestrictionCategoryPayload
Arguments
| Name | Description |
|---|---|
input - CreateRestrictionCategoryInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation createRestrictionCategory($input: CreateRestrictionCategoryInput!) {
createRestrictionCategory(input: $input) {
clientMutationId
restrictionCategory {
...RestrictionCategoryFragment
}
query {
...QueryFragment
}
restrictionCategoryEdge {
...RestrictionCategoriesEdgeFragment
}
}
}
Variables
{"input": CreateRestrictionCategoryInput}
Response
{
"data": {
"createRestrictionCategory": {
"clientMutationId": "abc123",
"restrictionCategory": RestrictionCategory,
"query": Query,
"restrictionCategoryEdge": RestrictionCategoriesEdge
}
}
}
createRestrictionReason
Description
Creates a single RestrictionReason.
Response
Returns a CreateRestrictionReasonPayload
Arguments
| Name | Description |
|---|---|
input - CreateRestrictionReasonInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation createRestrictionReason($input: CreateRestrictionReasonInput!) {
createRestrictionReason(input: $input) {
clientMutationId
restrictionReason {
...RestrictionReasonFragment
}
query {
...QueryFragment
}
restrictionCategoryByCategory {
...RestrictionCategoryFragment
}
restrictionReasonEdge {
...RestrictionReasonsEdgeFragment
}
}
}
Variables
{"input": CreateRestrictionReasonInput}
Response
{
"data": {
"createRestrictionReason": {
"clientMutationId": "xyz789",
"restrictionReason": RestrictionReason,
"query": Query,
"restrictionCategoryByCategory": RestrictionCategory,
"restrictionReasonEdge": RestrictionReasonsEdge
}
}
}
createRound
Description
Creates a single Round.
Response
Returns a CreateRoundPayload
Arguments
| Name | Description |
|---|---|
input - CreateRoundInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation createRound($input: CreateRoundInput!) {
createRound(input: $input) {
clientMutationId
round {
...RoundFragment
}
query {
...QueryFragment
}
assetByAssetId {
...AssetFragment
}
tokenByTokenId {
...TokenFragment
}
assetStatusByStatus {
...AssetStatusFragment
}
blockchainAddressByBlockchainAddressId {
...BlockchainAddressFragment
}
securityBySecurityId {
...SecurityFragment
}
roundEdge {
...RoundsEdgeFragment
}
}
}
Variables
{"input": CreateRoundInput}
Response
{
"data": {
"createRound": {
"clientMutationId": "abc123",
"round": Round,
"query": Query,
"assetByAssetId": Asset,
"tokenByTokenId": Token,
"assetStatusByStatus": AssetStatus,
"blockchainAddressByBlockchainAddressId": BlockchainAddress,
"securityBySecurityId": Security,
"roundEdge": RoundsEdge
}
}
}
createSigningField
Description
Creates a single SigningField.
Response
Returns a CreateSigningFieldPayload
Arguments
| Name | Description |
|---|---|
input - CreateSigningFieldInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation createSigningField($input: CreateSigningFieldInput!) {
createSigningField(input: $input) {
clientMutationId
signingField {
...SigningFieldFragment
}
query {
...QueryFragment
}
mappedSigningTemplateByMappedSigningTemplateId {
...MappedSigningTemplateFragment
}
signingDocumentBySigningDocumentId {
...SigningDocumentFragment
}
signingRoleBySigningRoleId {
...SigningRoleFragment
}
signingFieldEdge {
...SigningFieldsEdgeFragment
}
}
}
Variables
{"input": CreateSigningFieldInput}
Response
{
"data": {
"createSigningField": {
"clientMutationId": "abc123",
"signingField": SigningField,
"query": Query,
"mappedSigningTemplateByMappedSigningTemplateId": MappedSigningTemplate,
"signingDocumentBySigningDocumentId": SigningDocument,
"signingRoleBySigningRoleId": SigningRole,
"signingFieldEdge": SigningFieldsEdge
}
}
}
createStagedTransferStatus
Description
Creates a single StagedTransferStatus.
Response
Returns a CreateStagedTransferStatusPayload
Arguments
| Name | Description |
|---|---|
input - CreateStagedTransferStatusInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation createStagedTransferStatus($input: CreateStagedTransferStatusInput!) {
createStagedTransferStatus(input: $input) {
clientMutationId
stagedTransferStatus {
...StagedTransferStatusFragment
}
query {
...QueryFragment
}
stagedTransferStatusEdge {
...StagedTransferStatusesEdgeFragment
}
}
}
Variables
{"input": CreateStagedTransferStatusInput}
Response
{
"data": {
"createStagedTransferStatus": {
"clientMutationId": "xyz789",
"stagedTransferStatus": StagedTransferStatus,
"query": Query,
"stagedTransferStatusEdge": StagedTransferStatusesEdge
}
}
}
createTransactionAnnotation
Description
Creates a single TransactionAnnotation.
Response
Returns a CreateTransactionAnnotationPayload
Arguments
| Name | Description |
|---|---|
input - CreateTransactionAnnotationInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation createTransactionAnnotation($input: CreateTransactionAnnotationInput!) {
createTransactionAnnotation(input: $input) {
clientMutationId
transactionAnnotation {
...TransactionAnnotationFragment
}
query {
...QueryFragment
}
transactionByTransactionId {
...TransactionFragment
}
userByWrittenBy {
...UserFragment
}
accountByAccountId {
...AccountFragment
}
transactionAnnotationEdge {
...TransactionAnnotationsEdgeFragment
}
}
}
Variables
{"input": CreateTransactionAnnotationInput}
Response
{
"data": {
"createTransactionAnnotation": {
"clientMutationId": "xyz789",
"transactionAnnotation": TransactionAnnotation,
"query": Query,
"transactionByTransactionId": Transaction,
"userByWrittenBy": User,
"accountByAccountId": Account,
"transactionAnnotationEdge": TransactionAnnotationsEdge
}
}
}
createTransferType
Description
Creates a single TransferType.
Response
Returns a CreateTransferTypePayload
Arguments
| Name | Description |
|---|---|
input - CreateTransferTypeInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation createTransferType($input: CreateTransferTypeInput!) {
createTransferType(input: $input) {
clientMutationId
transferType {
...TransferTypeFragment
}
query {
...QueryFragment
}
transferTypeEdge {
...TransferTypesEdgeFragment
}
}
}
Variables
{"input": CreateTransferTypeInput}
Response
{
"data": {
"createTransferType": {
"clientMutationId": "xyz789",
"transferType": TransferType,
"query": Query,
"transferTypeEdge": TransferTypesEdge
}
}
}
createVendorIntegrationStatus
Description
Creates a single VendorIntegrationStatus.
Response
Returns a CreateVendorIntegrationStatusPayload
Arguments
| Name | Description |
|---|---|
input - CreateVendorIntegrationStatusInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation createVendorIntegrationStatus($input: CreateVendorIntegrationStatusInput!) {
createVendorIntegrationStatus(input: $input) {
clientMutationId
vendorIntegrationStatus {
...VendorIntegrationStatusFragment
}
query {
...QueryFragment
}
vendorIntegrationStatusEdge {
...VendorIntegrationStatusesEdgeFragment
}
}
}
Variables
{"input": CreateVendorIntegrationStatusInput}
Response
{
"data": {
"createVendorIntegrationStatus": {
"clientMutationId": "xyz789",
"vendorIntegrationStatus": VendorIntegrationStatus,
"query": Query,
"vendorIntegrationStatusEdge": VendorIntegrationStatusesEdge
}
}
}
createVestingEvent
Description
Creates a single VestingEvent.
Response
Returns a CreateVestingEventPayload
Arguments
| Name | Description |
|---|---|
input - CreateVestingEventInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation createVestingEvent($input: CreateVestingEventInput!) {
createVestingEvent(input: $input) {
clientMutationId
vestingEvent {
...VestingEventFragment
}
query {
...QueryFragment
}
vestingScheduleByVestingScheduleId {
...VestingScheduleFragment
}
transactionByTransactionId {
...TransactionFragment
}
vestingEventEdge {
...VestingEventsEdgeFragment
}
}
}
Variables
{"input": CreateVestingEventInput}
Response
{
"data": {
"createVestingEvent": {
"clientMutationId": "abc123",
"vestingEvent": VestingEvent,
"query": Query,
"vestingScheduleByVestingScheduleId": VestingSchedule,
"transactionByTransactionId": Transaction,
"vestingEventEdge": VestingEventsEdge
}
}
}
createVestingSchedule
Description
Creates a single VestingSchedule.
Response
Returns a CreateVestingSchedulePayload
Arguments
| Name | Description |
|---|---|
input - CreateVestingScheduleInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation createVestingSchedule($input: CreateVestingScheduleInput!) {
createVestingSchedule(input: $input) {
clientMutationId
vestingSchedule {
...VestingScheduleFragment
}
query {
...QueryFragment
}
distributionByDistributionId {
...DistributionFragment
}
vestingDurationByDuration {
...VestingDurationFragment
}
vestingScheduleEdge {
...VestingSchedulesEdgeFragment
}
}
}
Variables
{"input": CreateVestingScheduleInput}
Response
{
"data": {
"createVestingSchedule": {
"clientMutationId": "xyz789",
"vestingSchedule": VestingSchedule,
"query": Query,
"distributionByDistributionId": Distribution,
"vestingDurationByDuration": VestingDuration,
"vestingScheduleEdge": VestingSchedulesEdge
}
}
}
createWalletAssignment
Description
Creates a single WalletAssignment.
Response
Returns a CreateWalletAssignmentPayload
Arguments
| Name | Description |
|---|---|
input - CreateWalletAssignmentInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation createWalletAssignment($input: CreateWalletAssignmentInput!) {
createWalletAssignment(input: $input) {
clientMutationId
walletAssignment {
...WalletAssignmentFragment
}
query {
...QueryFragment
}
distributionByDistributionId {
...DistributionFragment
}
blockchainAddressByBlockchainAddressId {
...BlockchainAddressFragment
}
walletAssignmentEdge {
...WalletAssignmentsEdgeFragment
}
}
}
Variables
{"input": CreateWalletAssignmentInput}
Response
{
"data": {
"createWalletAssignment": {
"clientMutationId": "xyz789",
"walletAssignment": WalletAssignment,
"query": Query,
"distributionByDistributionId": Distribution,
"blockchainAddressByBlockchainAddressId": BlockchainAddress,
"walletAssignmentEdge": WalletAssignmentsEdge
}
}
}
createWebhookConfiguration
Description
Creates a single WebhookConfiguration.
Response
Returns a CreateWebhookConfigurationPayload
Arguments
| Name | Description |
|---|---|
input - CreateWebhookConfigurationInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation createWebhookConfiguration($input: CreateWebhookConfigurationInput!) {
createWebhookConfiguration(input: $input) {
clientMutationId
webhookConfiguration {
...WebhookConfigurationFragment
}
query {
...QueryFragment
}
webhookLevelByLevel {
...WebhookLevelFragment
}
accountByAccountId {
...AccountFragment
}
webhookConfigurationEdge {
...WebhookConfigurationsEdgeFragment
}
}
}
Variables
{"input": CreateWebhookConfigurationInput}
Response
{
"data": {
"createWebhookConfiguration": {
"clientMutationId": "abc123",
"webhookConfiguration": WebhookConfiguration,
"query": Query,
"webhookLevelByLevel": WebhookLevel,
"accountByAccountId": Account,
"webhookConfigurationEdge": WebhookConfigurationsEdge
}
}
}
deleteAccountPhoneNumber
Description
Deletes a single AccountPhoneNumber using its globally unique id.
Response
Returns a DeleteAccountPhoneNumberPayload
Arguments
| Name | Description |
|---|---|
input - DeleteAccountPhoneNumberInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation deleteAccountPhoneNumber($input: DeleteAccountPhoneNumberInput!) {
deleteAccountPhoneNumber(input: $input) {
clientMutationId
accountPhoneNumber {
...AccountPhoneNumberFragment
}
deletedAccountPhoneNumberId
query {
...QueryFragment
}
accountByAccountId {
...AccountFragment
}
phoneNumberTypeByType {
...PhoneNumberTypeFragment
}
accountPhoneNumberEdge {
...AccountPhoneNumbersEdgeFragment
}
}
}
Variables
{"input": DeleteAccountPhoneNumberInput}
Response
{
"data": {
"deleteAccountPhoneNumber": {
"clientMutationId": "xyz789",
"accountPhoneNumber": AccountPhoneNumber,
"deletedAccountPhoneNumberId": 4,
"query": Query,
"accountByAccountId": Account,
"phoneNumberTypeByType": PhoneNumberType,
"accountPhoneNumberEdge": AccountPhoneNumbersEdge
}
}
}
deleteAccountPhoneNumberByAccountIdAndType
Description
Deletes a single AccountPhoneNumber using a unique key.
Response
Returns a DeleteAccountPhoneNumberPayload
Arguments
| Name | Description |
|---|---|
input - DeleteAccountPhoneNumberByAccountIdAndTypeInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation deleteAccountPhoneNumberByAccountIdAndType($input: DeleteAccountPhoneNumberByAccountIdAndTypeInput!) {
deleteAccountPhoneNumberByAccountIdAndType(input: $input) {
clientMutationId
accountPhoneNumber {
...AccountPhoneNumberFragment
}
deletedAccountPhoneNumberId
query {
...QueryFragment
}
accountByAccountId {
...AccountFragment
}
phoneNumberTypeByType {
...PhoneNumberTypeFragment
}
accountPhoneNumberEdge {
...AccountPhoneNumbersEdgeFragment
}
}
}
Variables
{"input": DeleteAccountPhoneNumberByAccountIdAndTypeInput}
Response
{
"data": {
"deleteAccountPhoneNumberByAccountIdAndType": {
"clientMutationId": "xyz789",
"accountPhoneNumber": AccountPhoneNumber,
"deletedAccountPhoneNumberId": 4,
"query": Query,
"accountByAccountId": Account,
"phoneNumberTypeByType": PhoneNumberType,
"accountPhoneNumberEdge": AccountPhoneNumbersEdge
}
}
}
deleteAccountPhoneNumberById
Description
Deletes a single AccountPhoneNumber using a unique key.
Response
Returns a DeleteAccountPhoneNumberPayload
Arguments
| Name | Description |
|---|---|
input - DeleteAccountPhoneNumberByIdInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation deleteAccountPhoneNumberById($input: DeleteAccountPhoneNumberByIdInput!) {
deleteAccountPhoneNumberById(input: $input) {
clientMutationId
accountPhoneNumber {
...AccountPhoneNumberFragment
}
deletedAccountPhoneNumberId
query {
...QueryFragment
}
accountByAccountId {
...AccountFragment
}
phoneNumberTypeByType {
...PhoneNumberTypeFragment
}
accountPhoneNumberEdge {
...AccountPhoneNumbersEdgeFragment
}
}
}
Variables
{"input": DeleteAccountPhoneNumberByIdInput}
Response
{
"data": {
"deleteAccountPhoneNumberById": {
"clientMutationId": "abc123",
"accountPhoneNumber": AccountPhoneNumber,
"deletedAccountPhoneNumberId": 4,
"query": Query,
"accountByAccountId": Account,
"phoneNumberTypeByType": PhoneNumberType,
"accountPhoneNumberEdge": AccountPhoneNumbersEdge
}
}
}
deleteAccountRestriction
Description
Deletes a single AccountRestriction using its globally unique id.
Response
Returns a DeleteAccountRestrictionPayload
Arguments
| Name | Description |
|---|---|
input - DeleteAccountRestrictionInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation deleteAccountRestriction($input: DeleteAccountRestrictionInput!) {
deleteAccountRestriction(input: $input) {
clientMutationId
accountRestriction {
...AccountRestrictionFragment
}
deletedAccountRestrictionId
query {
...QueryFragment
}
accountByAccountId {
...AccountFragment
}
restrictionReasonByReasonId {
...RestrictionReasonFragment
}
userByCreatorUserId {
...UserFragment
}
accountByCreatorAccountId {
...AccountFragment
}
accountRestrictionEdge {
...AccountRestrictionsEdgeFragment
}
}
}
Variables
{"input": DeleteAccountRestrictionInput}
Response
{
"data": {
"deleteAccountRestriction": {
"clientMutationId": "abc123",
"accountRestriction": AccountRestriction,
"deletedAccountRestrictionId": "4",
"query": Query,
"accountByAccountId": Account,
"restrictionReasonByReasonId": RestrictionReason,
"userByCreatorUserId": User,
"accountByCreatorAccountId": Account,
"accountRestrictionEdge": AccountRestrictionsEdge
}
}
}
deleteAccountRestrictionByAccountIdAndReasonId
Description
Deletes a single AccountRestriction using a unique key.
Response
Returns a DeleteAccountRestrictionPayload
Arguments
| Name | Description |
|---|---|
input - DeleteAccountRestrictionByAccountIdAndReasonIdInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation deleteAccountRestrictionByAccountIdAndReasonId($input: DeleteAccountRestrictionByAccountIdAndReasonIdInput!) {
deleteAccountRestrictionByAccountIdAndReasonId(input: $input) {
clientMutationId
accountRestriction {
...AccountRestrictionFragment
}
deletedAccountRestrictionId
query {
...QueryFragment
}
accountByAccountId {
...AccountFragment
}
restrictionReasonByReasonId {
...RestrictionReasonFragment
}
userByCreatorUserId {
...UserFragment
}
accountByCreatorAccountId {
...AccountFragment
}
accountRestrictionEdge {
...AccountRestrictionsEdgeFragment
}
}
}
Variables
{
"input": DeleteAccountRestrictionByAccountIdAndReasonIdInput
}
Response
{
"data": {
"deleteAccountRestrictionByAccountIdAndReasonId": {
"clientMutationId": "xyz789",
"accountRestriction": AccountRestriction,
"deletedAccountRestrictionId": 4,
"query": Query,
"accountByAccountId": Account,
"restrictionReasonByReasonId": RestrictionReason,
"userByCreatorUserId": User,
"accountByCreatorAccountId": Account,
"accountRestrictionEdge": AccountRestrictionsEdge
}
}
}
deleteAccountRestrictionById
Description
Deletes a single AccountRestriction using a unique key.
Response
Returns a DeleteAccountRestrictionPayload
Arguments
| Name | Description |
|---|---|
input - DeleteAccountRestrictionByIdInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation deleteAccountRestrictionById($input: DeleteAccountRestrictionByIdInput!) {
deleteAccountRestrictionById(input: $input) {
clientMutationId
accountRestriction {
...AccountRestrictionFragment
}
deletedAccountRestrictionId
query {
...QueryFragment
}
accountByAccountId {
...AccountFragment
}
restrictionReasonByReasonId {
...RestrictionReasonFragment
}
userByCreatorUserId {
...UserFragment
}
accountByCreatorAccountId {
...AccountFragment
}
accountRestrictionEdge {
...AccountRestrictionsEdgeFragment
}
}
}
Variables
{"input": DeleteAccountRestrictionByIdInput}
Response
{
"data": {
"deleteAccountRestrictionById": {
"clientMutationId": "xyz789",
"accountRestriction": AccountRestriction,
"deletedAccountRestrictionId": "4",
"query": Query,
"accountByAccountId": Account,
"restrictionReasonByReasonId": RestrictionReason,
"userByCreatorUserId": User,
"accountByCreatorAccountId": Account,
"accountRestrictionEdge": AccountRestrictionsEdge
}
}
}
deleteAllocationAnnotation
Description
Deletes a single AllocationAnnotation using its globally unique id.
Response
Returns a DeleteAllocationAnnotationPayload
Arguments
| Name | Description |
|---|---|
input - DeleteAllocationAnnotationInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation deleteAllocationAnnotation($input: DeleteAllocationAnnotationInput!) {
deleteAllocationAnnotation(input: $input) {
clientMutationId
allocationAnnotation {
...AllocationAnnotationFragment
}
deletedAllocationAnnotationId
query {
...QueryFragment
}
allocationByAllocationId {
...AllocationFragment
}
userByWrittenBy {
...UserFragment
}
accountByAccountId {
...AccountFragment
}
allocationAnnotationEdge {
...AllocationAnnotationsEdgeFragment
}
}
}
Variables
{"input": DeleteAllocationAnnotationInput}
Response
{
"data": {
"deleteAllocationAnnotation": {
"clientMutationId": "abc123",
"allocationAnnotation": AllocationAnnotation,
"deletedAllocationAnnotationId": "4",
"query": Query,
"allocationByAllocationId": Allocation,
"userByWrittenBy": User,
"accountByAccountId": Account,
"allocationAnnotationEdge": AllocationAnnotationsEdge
}
}
}
deleteAllocationAnnotationById
Description
Deletes a single AllocationAnnotation using a unique key.
Response
Returns a DeleteAllocationAnnotationPayload
Arguments
| Name | Description |
|---|---|
input - DeleteAllocationAnnotationByIdInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation deleteAllocationAnnotationById($input: DeleteAllocationAnnotationByIdInput!) {
deleteAllocationAnnotationById(input: $input) {
clientMutationId
allocationAnnotation {
...AllocationAnnotationFragment
}
deletedAllocationAnnotationId
query {
...QueryFragment
}
allocationByAllocationId {
...AllocationFragment
}
userByWrittenBy {
...UserFragment
}
accountByAccountId {
...AccountFragment
}
allocationAnnotationEdge {
...AllocationAnnotationsEdgeFragment
}
}
}
Variables
{"input": DeleteAllocationAnnotationByIdInput}
Response
{
"data": {
"deleteAllocationAnnotationById": {
"clientMutationId": "abc123",
"allocationAnnotation": AllocationAnnotation,
"deletedAllocationAnnotationId": 4,
"query": Query,
"allocationByAllocationId": Allocation,
"userByWrittenBy": User,
"accountByAccountId": Account,
"allocationAnnotationEdge": AllocationAnnotationsEdge
}
}
}
deleteAllocationQualification
Description
Deletes a single AllocationQualification using its globally unique id.
Response
Returns a DeleteAllocationQualificationPayload
Arguments
| Name | Description |
|---|---|
input - DeleteAllocationQualificationInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation deleteAllocationQualification($input: DeleteAllocationQualificationInput!) {
deleteAllocationQualification(input: $input) {
clientMutationId
allocationQualification {
...AllocationQualificationFragment
}
deletedAllocationQualificationId
query {
...QueryFragment
}
allocationByAllocationId {
...AllocationFragment
}
vendorQualificationByVendorQualificationId {
...VendorQualificationFragment
}
allocationQualificationEdge {
...AllocationQualificationsEdgeFragment
}
}
}
Variables
{"input": DeleteAllocationQualificationInput}
Response
{
"data": {
"deleteAllocationQualification": {
"clientMutationId": "xyz789",
"allocationQualification": AllocationQualification,
"deletedAllocationQualificationId": "4",
"query": Query,
"allocationByAllocationId": Allocation,
"vendorQualificationByVendorQualificationId": VendorQualification,
"allocationQualificationEdge": AllocationQualificationsEdge
}
}
}
deleteAllocationQualificationByAllocationIdAndVendorQualificationId
Description
Deletes a single AllocationQualification using a unique key.
Response
Returns a DeleteAllocationQualificationPayload
Arguments
| Name | Description |
|---|---|
input - DeleteAllocationQualificationByAllocationIdAndVendorQualificationIdInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation deleteAllocationQualificationByAllocationIdAndVendorQualificationId($input: DeleteAllocationQualificationByAllocationIdAndVendorQualificationIdInput!) {
deleteAllocationQualificationByAllocationIdAndVendorQualificationId(input: $input) {
clientMutationId
allocationQualification {
...AllocationQualificationFragment
}
deletedAllocationQualificationId
query {
...QueryFragment
}
allocationByAllocationId {
...AllocationFragment
}
vendorQualificationByVendorQualificationId {
...VendorQualificationFragment
}
allocationQualificationEdge {
...AllocationQualificationsEdgeFragment
}
}
}
Variables
{
"input": DeleteAllocationQualificationByAllocationIdAndVendorQualificationIdInput
}
Response
{
"data": {
"deleteAllocationQualificationByAllocationIdAndVendorQualificationId": {
"clientMutationId": "abc123",
"allocationQualification": AllocationQualification,
"deletedAllocationQualificationId": "4",
"query": Query,
"allocationByAllocationId": Allocation,
"vendorQualificationByVendorQualificationId": VendorQualification,
"allocationQualificationEdge": AllocationQualificationsEdge
}
}
}
deleteAllocationQualificationById
Description
Deletes a single AllocationQualification using a unique key.
Response
Returns a DeleteAllocationQualificationPayload
Arguments
| Name | Description |
|---|---|
input - DeleteAllocationQualificationByIdInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation deleteAllocationQualificationById($input: DeleteAllocationQualificationByIdInput!) {
deleteAllocationQualificationById(input: $input) {
clientMutationId
allocationQualification {
...AllocationQualificationFragment
}
deletedAllocationQualificationId
query {
...QueryFragment
}
allocationByAllocationId {
...AllocationFragment
}
vendorQualificationByVendorQualificationId {
...VendorQualificationFragment
}
allocationQualificationEdge {
...AllocationQualificationsEdgeFragment
}
}
}
Variables
{"input": DeleteAllocationQualificationByIdInput}
Response
{
"data": {
"deleteAllocationQualificationById": {
"clientMutationId": "xyz789",
"allocationQualification": AllocationQualification,
"deletedAllocationQualificationId": "4",
"query": Query,
"allocationByAllocationId": Allocation,
"vendorQualificationByVendorQualificationId": VendorQualification,
"allocationQualificationEdge": AllocationQualificationsEdge
}
}
}
deleteAllocationsVestingSchedule
Description
Deletes a single AllocationsVestingSchedule using its globally unique id.
Response
Returns a DeleteAllocationsVestingSchedulePayload
Arguments
| Name | Description |
|---|---|
input - DeleteAllocationsVestingScheduleInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation deleteAllocationsVestingSchedule($input: DeleteAllocationsVestingScheduleInput!) {
deleteAllocationsVestingSchedule(input: $input) {
clientMutationId
allocationsVestingSchedule {
...AllocationsVestingScheduleFragment
}
deletedAllocationsVestingScheduleId
query {
...QueryFragment
}
allocationByAllocationId {
...AllocationFragment
}
vestingDurationByDuration {
...VestingDurationFragment
}
allocationsVestingScheduleEdge {
...AllocationsVestingSchedulesEdgeFragment
}
}
}
Variables
{"input": DeleteAllocationsVestingScheduleInput}
Response
{
"data": {
"deleteAllocationsVestingSchedule": {
"clientMutationId": "abc123",
"allocationsVestingSchedule": AllocationsVestingSchedule,
"deletedAllocationsVestingScheduleId": "4",
"query": Query,
"allocationByAllocationId": Allocation,
"vestingDurationByDuration": VestingDuration,
"allocationsVestingScheduleEdge": AllocationsVestingSchedulesEdge
}
}
}
deleteAllocationsVestingScheduleByAllocationId
Description
Deletes a single AllocationsVestingSchedule using a unique key.
Response
Returns a DeleteAllocationsVestingSchedulePayload
Arguments
| Name | Description |
|---|---|
input - DeleteAllocationsVestingScheduleByAllocationIdInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation deleteAllocationsVestingScheduleByAllocationId($input: DeleteAllocationsVestingScheduleByAllocationIdInput!) {
deleteAllocationsVestingScheduleByAllocationId(input: $input) {
clientMutationId
allocationsVestingSchedule {
...AllocationsVestingScheduleFragment
}
deletedAllocationsVestingScheduleId
query {
...QueryFragment
}
allocationByAllocationId {
...AllocationFragment
}
vestingDurationByDuration {
...VestingDurationFragment
}
allocationsVestingScheduleEdge {
...AllocationsVestingSchedulesEdgeFragment
}
}
}
Variables
{
"input": DeleteAllocationsVestingScheduleByAllocationIdInput
}
Response
{
"data": {
"deleteAllocationsVestingScheduleByAllocationId": {
"clientMutationId": "xyz789",
"allocationsVestingSchedule": AllocationsVestingSchedule,
"deletedAllocationsVestingScheduleId": "4",
"query": Query,
"allocationByAllocationId": Allocation,
"vestingDurationByDuration": VestingDuration,
"allocationsVestingScheduleEdge": AllocationsVestingSchedulesEdge
}
}
}
deleteAllocationsVestingScheduleById
Description
Deletes a single AllocationsVestingSchedule using a unique key.
Response
Returns a DeleteAllocationsVestingSchedulePayload
Arguments
| Name | Description |
|---|---|
input - DeleteAllocationsVestingScheduleByIdInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation deleteAllocationsVestingScheduleById($input: DeleteAllocationsVestingScheduleByIdInput!) {
deleteAllocationsVestingScheduleById(input: $input) {
clientMutationId
allocationsVestingSchedule {
...AllocationsVestingScheduleFragment
}
deletedAllocationsVestingScheduleId
query {
...QueryFragment
}
allocationByAllocationId {
...AllocationFragment
}
vestingDurationByDuration {
...VestingDurationFragment
}
allocationsVestingScheduleEdge {
...AllocationsVestingSchedulesEdgeFragment
}
}
}
Variables
{"input": DeleteAllocationsVestingScheduleByIdInput}
Response
{
"data": {
"deleteAllocationsVestingScheduleById": {
"clientMutationId": "abc123",
"allocationsVestingSchedule": AllocationsVestingSchedule,
"deletedAllocationsVestingScheduleId": 4,
"query": Query,
"allocationByAllocationId": Allocation,
"vestingDurationByDuration": VestingDuration,
"allocationsVestingScheduleEdge": AllocationsVestingSchedulesEdge
}
}
}
deleteAssetAnnotation
Description
Deletes a single AssetAnnotation using its globally unique id.
Response
Returns a DeleteAssetAnnotationPayload
Arguments
| Name | Description |
|---|---|
input - DeleteAssetAnnotationInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation deleteAssetAnnotation($input: DeleteAssetAnnotationInput!) {
deleteAssetAnnotation(input: $input) {
clientMutationId
assetAnnotation {
...AssetAnnotationFragment
}
deletedAssetAnnotationId
query {
...QueryFragment
}
assetByAssetId {
...AssetFragment
}
userByWrittenBy {
...UserFragment
}
accountByAccountId {
...AccountFragment
}
assetAnnotationEdge {
...AssetAnnotationsEdgeFragment
}
}
}
Variables
{"input": DeleteAssetAnnotationInput}
Response
{
"data": {
"deleteAssetAnnotation": {
"clientMutationId": "abc123",
"assetAnnotation": AssetAnnotation,
"deletedAssetAnnotationId": "4",
"query": Query,
"assetByAssetId": Asset,
"userByWrittenBy": User,
"accountByAccountId": Account,
"assetAnnotationEdge": AssetAnnotationsEdge
}
}
}
deleteAssetAnnotationById
Description
Deletes a single AssetAnnotation using a unique key.
Response
Returns a DeleteAssetAnnotationPayload
Arguments
| Name | Description |
|---|---|
input - DeleteAssetAnnotationByIdInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation deleteAssetAnnotationById($input: DeleteAssetAnnotationByIdInput!) {
deleteAssetAnnotationById(input: $input) {
clientMutationId
assetAnnotation {
...AssetAnnotationFragment
}
deletedAssetAnnotationId
query {
...QueryFragment
}
assetByAssetId {
...AssetFragment
}
userByWrittenBy {
...UserFragment
}
accountByAccountId {
...AccountFragment
}
assetAnnotationEdge {
...AssetAnnotationsEdgeFragment
}
}
}
Variables
{"input": DeleteAssetAnnotationByIdInput}
Response
{
"data": {
"deleteAssetAnnotationById": {
"clientMutationId": "abc123",
"assetAnnotation": AssetAnnotation,
"deletedAssetAnnotationId": 4,
"query": Query,
"assetByAssetId": Asset,
"userByWrittenBy": User,
"accountByAccountId": Account,
"assetAnnotationEdge": AssetAnnotationsEdge
}
}
}
deleteAuxAccount
Description
Deletes a single AuxAccount using its globally unique id.
Response
Returns a DeleteAuxAccountPayload
Arguments
| Name | Description |
|---|---|
input - DeleteAuxAccountInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation deleteAuxAccount($input: DeleteAuxAccountInput!) {
deleteAuxAccount(input: $input) {
clientMutationId
auxAccount {
...AuxAccountFragment
}
deletedAccountTypeId
query {
...QueryFragment
}
auxAccountEdge {
...AuxAccountsEdgeFragment
}
}
}
Variables
{"input": DeleteAuxAccountInput}
Response
{
"data": {
"deleteAuxAccount": {
"clientMutationId": "abc123",
"auxAccount": AuxAccount,
"deletedAccountTypeId": 4,
"query": Query,
"auxAccountEdge": AuxAccountsEdge
}
}
}
deleteAuxAccountByType
Description
Deletes a single AuxAccount using a unique key.
Response
Returns a DeleteAuxAccountPayload
Arguments
| Name | Description |
|---|---|
input - DeleteAuxAccountByTypeInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation deleteAuxAccountByType($input: DeleteAuxAccountByTypeInput!) {
deleteAuxAccountByType(input: $input) {
clientMutationId
auxAccount {
...AuxAccountFragment
}
deletedAccountTypeId
query {
...QueryFragment
}
auxAccountEdge {
...AuxAccountsEdgeFragment
}
}
}
Variables
{"input": DeleteAuxAccountByTypeInput}
Response
{
"data": {
"deleteAuxAccountByType": {
"clientMutationId": "abc123",
"auxAccount": AuxAccount,
"deletedAccountTypeId": 4,
"query": Query,
"auxAccountEdge": AuxAccountsEdge
}
}
}
deleteAuxRole
Description
Deletes a single AuxRole using its globally unique id.
Response
Returns a DeleteAuxRolePayload
Arguments
| Name | Description |
|---|---|
input - DeleteAuxRoleInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation deleteAuxRole($input: DeleteAuxRoleInput!) {
deleteAuxRole(input: $input) {
clientMutationId
auxRole {
...AuxRoleFragment
}
deletedRoleId
query {
...QueryFragment
}
auxRoleEdge {
...AuxRolesEdgeFragment
}
}
}
Variables
{"input": DeleteAuxRoleInput}
Response
{
"data": {
"deleteAuxRole": {
"clientMutationId": "abc123",
"auxRole": AuxRole,
"deletedRoleId": 4,
"query": Query,
"auxRoleEdge": AuxRolesEdge
}
}
}
deleteAuxRoleByRole
Description
Deletes a single AuxRole using a unique key.
Response
Returns a DeleteAuxRolePayload
Arguments
| Name | Description |
|---|---|
input - DeleteAuxRoleByRoleInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation deleteAuxRoleByRole($input: DeleteAuxRoleByRoleInput!) {
deleteAuxRoleByRole(input: $input) {
clientMutationId
auxRole {
...AuxRoleFragment
}
deletedRoleId
query {
...QueryFragment
}
auxRoleEdge {
...AuxRolesEdgeFragment
}
}
}
Variables
{"input": DeleteAuxRoleByRoleInput}
Response
{
"data": {
"deleteAuxRoleByRole": {
"clientMutationId": "xyz789",
"auxRole": AuxRole,
"deletedRoleId": 4,
"query": Query,
"auxRoleEdge": AuxRolesEdge
}
}
}
deleteCustomer
Description
Deletes a single Customer using its globally unique id.
Response
Returns a DeleteCustomerPayload
Arguments
| Name | Description |
|---|---|
input - DeleteCustomerInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation deleteCustomer($input: DeleteCustomerInput!) {
deleteCustomer(input: $input) {
clientMutationId
customer {
...CustomerFragment
}
deletedCustomerId
query {
...QueryFragment
}
accountByVendorId {
...AccountFragment
}
accountByInvestorId {
...AccountFragment
}
invitationStatusByStatus {
...InvitationStatusFragment
}
investorAccountTypeByInvestorType {
...InvestorAccountTypeFragment
}
countryByJurisdiction {
...CountryFragment
}
customerEdge {
...CustomersEdgeFragment
}
}
}
Variables
{"input": DeleteCustomerInput}
Response
{
"data": {
"deleteCustomer": {
"clientMutationId": "abc123",
"customer": Customer,
"deletedCustomerId": "4",
"query": Query,
"accountByVendorId": Account,
"accountByInvestorId": Account,
"invitationStatusByStatus": InvitationStatus,
"investorAccountTypeByInvestorType": InvestorAccountType,
"countryByJurisdiction": Country,
"customerEdge": CustomersEdge
}
}
}
deleteCustomerById
Description
Deletes a single Customer using a unique key.
Response
Returns a DeleteCustomerPayload
Arguments
| Name | Description |
|---|---|
input - DeleteCustomerByIdInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation deleteCustomerById($input: DeleteCustomerByIdInput!) {
deleteCustomerById(input: $input) {
clientMutationId
customer {
...CustomerFragment
}
deletedCustomerId
query {
...QueryFragment
}
accountByVendorId {
...AccountFragment
}
accountByInvestorId {
...AccountFragment
}
invitationStatusByStatus {
...InvitationStatusFragment
}
investorAccountTypeByInvestorType {
...InvestorAccountTypeFragment
}
countryByJurisdiction {
...CountryFragment
}
customerEdge {
...CustomersEdgeFragment
}
}
}
Variables
{"input": DeleteCustomerByIdInput}
Response
{
"data": {
"deleteCustomerById": {
"clientMutationId": "xyz789",
"customer": Customer,
"deletedCustomerId": 4,
"query": Query,
"accountByVendorId": Account,
"accountByInvestorId": Account,
"invitationStatusByStatus": InvitationStatus,
"investorAccountTypeByInvestorType": InvestorAccountType,
"countryByJurisdiction": Country,
"customerEdge": CustomersEdge
}
}
}
deleteCustomerByVendorIdAndInvestorId
Description
Deletes a single Customer using a unique key.
Response
Returns a DeleteCustomerPayload
Arguments
| Name | Description |
|---|---|
input - DeleteCustomerByVendorIdAndInvestorIdInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation deleteCustomerByVendorIdAndInvestorId($input: DeleteCustomerByVendorIdAndInvestorIdInput!) {
deleteCustomerByVendorIdAndInvestorId(input: $input) {
clientMutationId
customer {
...CustomerFragment
}
deletedCustomerId
query {
...QueryFragment
}
accountByVendorId {
...AccountFragment
}
accountByInvestorId {
...AccountFragment
}
invitationStatusByStatus {
...InvitationStatusFragment
}
investorAccountTypeByInvestorType {
...InvestorAccountTypeFragment
}
countryByJurisdiction {
...CountryFragment
}
customerEdge {
...CustomersEdgeFragment
}
}
}
Variables
{"input": DeleteCustomerByVendorIdAndInvestorIdInput}
Response
{
"data": {
"deleteCustomerByVendorIdAndInvestorId": {
"clientMutationId": "abc123",
"customer": Customer,
"deletedCustomerId": 4,
"query": Query,
"accountByVendorId": Account,
"accountByInvestorId": Account,
"invitationStatusByStatus": InvitationStatus,
"investorAccountTypeByInvestorType": InvestorAccountType,
"countryByJurisdiction": Country,
"customerEdge": CustomersEdge
}
}
}
deleteDistribution
Description
Deletes a single Distribution using its globally unique id.
Response
Returns a DeleteDistributionPayload
Arguments
| Name | Description |
|---|---|
input - DeleteDistributionInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation deleteDistribution($input: DeleteDistributionInput!) {
deleteDistribution(input: $input) {
clientMutationId
distribution {
...DistributionFragment
}
deletedDistributionId
query {
...QueryFragment
}
allocationByAllocationId {
...AllocationFragment
}
accountByInvestorId {
...AccountFragment
}
distributionStatusByStatus {
...DistributionStatusFragment
}
stepByStepId {
...StepFragment
}
distributionEdge {
...DistributionsEdgeFragment
}
}
}
Variables
{"input": DeleteDistributionInput}
Response
{
"data": {
"deleteDistribution": {
"clientMutationId": "abc123",
"distribution": Distribution,
"deletedDistributionId": "4",
"query": Query,
"allocationByAllocationId": Allocation,
"accountByInvestorId": Account,
"distributionStatusByStatus": DistributionStatus,
"stepByStepId": Step,
"distributionEdge": DistributionsEdge
}
}
}
deleteDistributionAnnotation
Description
Deletes a single DistributionAnnotation using its globally unique id.
Response
Returns a DeleteDistributionAnnotationPayload
Arguments
| Name | Description |
|---|---|
input - DeleteDistributionAnnotationInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation deleteDistributionAnnotation($input: DeleteDistributionAnnotationInput!) {
deleteDistributionAnnotation(input: $input) {
clientMutationId
distributionAnnotation {
...DistributionAnnotationFragment
}
deletedDistributionAnnotationId
query {
...QueryFragment
}
distributionByDistributionId {
...DistributionFragment
}
userByWrittenBy {
...UserFragment
}
accountByAccountId {
...AccountFragment
}
distributionAnnotationEdge {
...DistributionAnnotationsEdgeFragment
}
}
}
Variables
{"input": DeleteDistributionAnnotationInput}
Response
{
"data": {
"deleteDistributionAnnotation": {
"clientMutationId": "abc123",
"distributionAnnotation": DistributionAnnotation,
"deletedDistributionAnnotationId": "4",
"query": Query,
"distributionByDistributionId": Distribution,
"userByWrittenBy": User,
"accountByAccountId": Account,
"distributionAnnotationEdge": DistributionAnnotationsEdge
}
}
}
deleteDistributionAnnotationById
Description
Deletes a single DistributionAnnotation using a unique key.
Response
Returns a DeleteDistributionAnnotationPayload
Arguments
| Name | Description |
|---|---|
input - DeleteDistributionAnnotationByIdInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation deleteDistributionAnnotationById($input: DeleteDistributionAnnotationByIdInput!) {
deleteDistributionAnnotationById(input: $input) {
clientMutationId
distributionAnnotation {
...DistributionAnnotationFragment
}
deletedDistributionAnnotationId
query {
...QueryFragment
}
distributionByDistributionId {
...DistributionFragment
}
userByWrittenBy {
...UserFragment
}
accountByAccountId {
...AccountFragment
}
distributionAnnotationEdge {
...DistributionAnnotationsEdgeFragment
}
}
}
Variables
{"input": DeleteDistributionAnnotationByIdInput}
Response
{
"data": {
"deleteDistributionAnnotationById": {
"clientMutationId": "xyz789",
"distributionAnnotation": DistributionAnnotation,
"deletedDistributionAnnotationId": 4,
"query": Query,
"distributionByDistributionId": Distribution,
"userByWrittenBy": User,
"accountByAccountId": Account,
"distributionAnnotationEdge": DistributionAnnotationsEdge
}
}
}
deleteDistributionByClosedBlockchainId
Description
Deletes a single Distribution using a unique key.
Response
Returns a DeleteDistributionPayload
Arguments
| Name | Description |
|---|---|
input - DeleteDistributionByClosedBlockchainIdInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation deleteDistributionByClosedBlockchainId($input: DeleteDistributionByClosedBlockchainIdInput!) {
deleteDistributionByClosedBlockchainId(input: $input) {
clientMutationId
distribution {
...DistributionFragment
}
deletedDistributionId
query {
...QueryFragment
}
allocationByAllocationId {
...AllocationFragment
}
accountByInvestorId {
...AccountFragment
}
distributionStatusByStatus {
...DistributionStatusFragment
}
stepByStepId {
...StepFragment
}
distributionEdge {
...DistributionsEdgeFragment
}
}
}
Variables
{"input": DeleteDistributionByClosedBlockchainIdInput}
Response
{
"data": {
"deleteDistributionByClosedBlockchainId": {
"clientMutationId": "abc123",
"distribution": Distribution,
"deletedDistributionId": 4,
"query": Query,
"allocationByAllocationId": Allocation,
"accountByInvestorId": Account,
"distributionStatusByStatus": DistributionStatus,
"stepByStepId": Step,
"distributionEdge": DistributionsEdge
}
}
}
deleteDistributionByDraftedBlockchainId
Description
Deletes a single Distribution using a unique key.
Response
Returns a DeleteDistributionPayload
Arguments
| Name | Description |
|---|---|
input - DeleteDistributionByDraftedBlockchainIdInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation deleteDistributionByDraftedBlockchainId($input: DeleteDistributionByDraftedBlockchainIdInput!) {
deleteDistributionByDraftedBlockchainId(input: $input) {
clientMutationId
distribution {
...DistributionFragment
}
deletedDistributionId
query {
...QueryFragment
}
allocationByAllocationId {
...AllocationFragment
}
accountByInvestorId {
...AccountFragment
}
distributionStatusByStatus {
...DistributionStatusFragment
}
stepByStepId {
...StepFragment
}
distributionEdge {
...DistributionsEdgeFragment
}
}
}
Variables
{"input": DeleteDistributionByDraftedBlockchainIdInput}
Response
{
"data": {
"deleteDistributionByDraftedBlockchainId": {
"clientMutationId": "abc123",
"distribution": Distribution,
"deletedDistributionId": "4",
"query": Query,
"allocationByAllocationId": Allocation,
"accountByInvestorId": Account,
"distributionStatusByStatus": DistributionStatus,
"stepByStepId": Step,
"distributionEdge": DistributionsEdge
}
}
}
deleteDistributionById
Description
Deletes a single Distribution using a unique key.
Response
Returns a DeleteDistributionPayload
Arguments
| Name | Description |
|---|---|
input - DeleteDistributionByIdInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation deleteDistributionById($input: DeleteDistributionByIdInput!) {
deleteDistributionById(input: $input) {
clientMutationId
distribution {
...DistributionFragment
}
deletedDistributionId
query {
...QueryFragment
}
allocationByAllocationId {
...AllocationFragment
}
accountByInvestorId {
...AccountFragment
}
distributionStatusByStatus {
...DistributionStatusFragment
}
stepByStepId {
...StepFragment
}
distributionEdge {
...DistributionsEdgeFragment
}
}
}
Variables
{"input": DeleteDistributionByIdInput}
Response
{
"data": {
"deleteDistributionById": {
"clientMutationId": "abc123",
"distribution": Distribution,
"deletedDistributionId": 4,
"query": Query,
"allocationByAllocationId": Allocation,
"accountByInvestorId": Account,
"distributionStatusByStatus": DistributionStatus,
"stepByStepId": Step,
"distributionEdge": DistributionsEdge
}
}
}
deleteDistributionByLockedBlockchainId
Description
Deletes a single Distribution using a unique key.
Response
Returns a DeleteDistributionPayload
Arguments
| Name | Description |
|---|---|
input - DeleteDistributionByLockedBlockchainIdInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation deleteDistributionByLockedBlockchainId($input: DeleteDistributionByLockedBlockchainIdInput!) {
deleteDistributionByLockedBlockchainId(input: $input) {
clientMutationId
distribution {
...DistributionFragment
}
deletedDistributionId
query {
...QueryFragment
}
allocationByAllocationId {
...AllocationFragment
}
accountByInvestorId {
...AccountFragment
}
distributionStatusByStatus {
...DistributionStatusFragment
}
stepByStepId {
...StepFragment
}
distributionEdge {
...DistributionsEdgeFragment
}
}
}
Variables
{"input": DeleteDistributionByLockedBlockchainIdInput}
Response
{
"data": {
"deleteDistributionByLockedBlockchainId": {
"clientMutationId": "abc123",
"distribution": Distribution,
"deletedDistributionId": "4",
"query": Query,
"allocationByAllocationId": Allocation,
"accountByInvestorId": Account,
"distributionStatusByStatus": DistributionStatus,
"stepByStepId": Step,
"distributionEdge": DistributionsEdge
}
}
}
deleteDistributionByNewId
Description
Deletes a single Distribution using a unique key.
Response
Returns a DeleteDistributionPayload
Arguments
| Name | Description |
|---|---|
input - DeleteDistributionByNewIdInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation deleteDistributionByNewId($input: DeleteDistributionByNewIdInput!) {
deleteDistributionByNewId(input: $input) {
clientMutationId
distribution {
...DistributionFragment
}
deletedDistributionId
query {
...QueryFragment
}
allocationByAllocationId {
...AllocationFragment
}
accountByInvestorId {
...AccountFragment
}
distributionStatusByStatus {
...DistributionStatusFragment
}
stepByStepId {
...StepFragment
}
distributionEdge {
...DistributionsEdgeFragment
}
}
}
Variables
{"input": DeleteDistributionByNewIdInput}
Response
{
"data": {
"deleteDistributionByNewId": {
"clientMutationId": "abc123",
"distribution": Distribution,
"deletedDistributionId": "4",
"query": Query,
"allocationByAllocationId": Allocation,
"accountByInvestorId": Account,
"distributionStatusByStatus": DistributionStatus,
"stepByStepId": Step,
"distributionEdge": DistributionsEdge
}
}
}
deleteDistributionByOpenBlockchainId
Description
Deletes a single Distribution using a unique key.
Response
Returns a DeleteDistributionPayload
Arguments
| Name | Description |
|---|---|
input - DeleteDistributionByOpenBlockchainIdInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation deleteDistributionByOpenBlockchainId($input: DeleteDistributionByOpenBlockchainIdInput!) {
deleteDistributionByOpenBlockchainId(input: $input) {
clientMutationId
distribution {
...DistributionFragment
}
deletedDistributionId
query {
...QueryFragment
}
allocationByAllocationId {
...AllocationFragment
}
accountByInvestorId {
...AccountFragment
}
distributionStatusByStatus {
...DistributionStatusFragment
}
stepByStepId {
...StepFragment
}
distributionEdge {
...DistributionsEdgeFragment
}
}
}
Variables
{"input": DeleteDistributionByOpenBlockchainIdInput}
Response
{
"data": {
"deleteDistributionByOpenBlockchainId": {
"clientMutationId": "abc123",
"distribution": Distribution,
"deletedDistributionId": 4,
"query": Query,
"allocationByAllocationId": Allocation,
"accountByInvestorId": Account,
"distributionStatusByStatus": DistributionStatus,
"stepByStepId": Step,
"distributionEdge": DistributionsEdge
}
}
}
deleteDistributionByStepId
Description
Deletes a single Distribution using a unique key.
Response
Returns a DeleteDistributionPayload
Arguments
| Name | Description |
|---|---|
input - DeleteDistributionByStepIdInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation deleteDistributionByStepId($input: DeleteDistributionByStepIdInput!) {
deleteDistributionByStepId(input: $input) {
clientMutationId
distribution {
...DistributionFragment
}
deletedDistributionId
query {
...QueryFragment
}
allocationByAllocationId {
...AllocationFragment
}
accountByInvestorId {
...AccountFragment
}
distributionStatusByStatus {
...DistributionStatusFragment
}
stepByStepId {
...StepFragment
}
distributionEdge {
...DistributionsEdgeFragment
}
}
}
Variables
{"input": DeleteDistributionByStepIdInput}
Response
{
"data": {
"deleteDistributionByStepId": {
"clientMutationId": "xyz789",
"distribution": Distribution,
"deletedDistributionId": "4",
"query": Query,
"allocationByAllocationId": Allocation,
"accountByInvestorId": Account,
"distributionStatusByStatus": DistributionStatus,
"stepByStepId": Step,
"distributionEdge": DistributionsEdge
}
}
}
deleteDistributionCustomField
Description
Deletes a single DistributionCustomField using its globally unique id.
Response
Returns a DeleteDistributionCustomFieldPayload
Arguments
| Name | Description |
|---|---|
input - DeleteDistributionCustomFieldInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation deleteDistributionCustomField($input: DeleteDistributionCustomFieldInput!) {
deleteDistributionCustomField(input: $input) {
clientMutationId
distributionCustomField {
...DistributionCustomFieldFragment
}
deletedDistributionCustomFieldId
query {
...QueryFragment
}
accountByCreatedBy {
...AccountFragment
}
distributionByDistributionId {
...DistributionFragment
}
distributionCustomFieldEdge {
...DistributionCustomFieldsEdgeFragment
}
}
}
Variables
{"input": DeleteDistributionCustomFieldInput}
Response
{
"data": {
"deleteDistributionCustomField": {
"clientMutationId": "xyz789",
"distributionCustomField": DistributionCustomField,
"deletedDistributionCustomFieldId": 4,
"query": Query,
"accountByCreatedBy": Account,
"distributionByDistributionId": Distribution,
"distributionCustomFieldEdge": DistributionCustomFieldsEdge
}
}
}
deleteDistributionCustomFieldById
Description
Deletes a single DistributionCustomField using a unique key.
Response
Returns a DeleteDistributionCustomFieldPayload
Arguments
| Name | Description |
|---|---|
input - DeleteDistributionCustomFieldByIdInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation deleteDistributionCustomFieldById($input: DeleteDistributionCustomFieldByIdInput!) {
deleteDistributionCustomFieldById(input: $input) {
clientMutationId
distributionCustomField {
...DistributionCustomFieldFragment
}
deletedDistributionCustomFieldId
query {
...QueryFragment
}
accountByCreatedBy {
...AccountFragment
}
distributionByDistributionId {
...DistributionFragment
}
distributionCustomFieldEdge {
...DistributionCustomFieldsEdgeFragment
}
}
}
Variables
{"input": DeleteDistributionCustomFieldByIdInput}
Response
{
"data": {
"deleteDistributionCustomFieldById": {
"clientMutationId": "xyz789",
"distributionCustomField": DistributionCustomField,
"deletedDistributionCustomFieldId": 4,
"query": Query,
"accountByCreatedBy": Account,
"distributionByDistributionId": Distribution,
"distributionCustomFieldEdge": DistributionCustomFieldsEdge
}
}
}
deleteDistributionPayment
Description
Deletes a single DistributionPayment using its globally unique id.
Response
Returns a DeleteDistributionPaymentPayload
Arguments
| Name | Description |
|---|---|
input - DeleteDistributionPaymentInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation deleteDistributionPayment($input: DeleteDistributionPaymentInput!) {
deleteDistributionPayment(input: $input) {
clientMutationId
distributionPayment {
...DistributionPaymentFragment
}
deletedDistributionPaymentId
query {
...QueryFragment
}
distributionByDistributionId {
...DistributionFragment
}
currencyByCurrency {
...CurrencyFragment
}
distributionPaymentStatusByStatus {
...DistributionPaymentStatusFragment
}
distributionPaymentEdge {
...DistributionPaymentsEdgeFragment
}
}
}
Variables
{"input": DeleteDistributionPaymentInput}
Response
{
"data": {
"deleteDistributionPayment": {
"clientMutationId": "xyz789",
"distributionPayment": DistributionPayment,
"deletedDistributionPaymentId": "4",
"query": Query,
"distributionByDistributionId": Distribution,
"currencyByCurrency": Currency,
"distributionPaymentStatusByStatus": DistributionPaymentStatus,
"distributionPaymentEdge": DistributionPaymentsEdge
}
}
}
deleteDistributionPaymentById
Description
Deletes a single DistributionPayment using a unique key.
Response
Returns a DeleteDistributionPaymentPayload
Arguments
| Name | Description |
|---|---|
input - DeleteDistributionPaymentByIdInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation deleteDistributionPaymentById($input: DeleteDistributionPaymentByIdInput!) {
deleteDistributionPaymentById(input: $input) {
clientMutationId
distributionPayment {
...DistributionPaymentFragment
}
deletedDistributionPaymentId
query {
...QueryFragment
}
distributionByDistributionId {
...DistributionFragment
}
currencyByCurrency {
...CurrencyFragment
}
distributionPaymentStatusByStatus {
...DistributionPaymentStatusFragment
}
distributionPaymentEdge {
...DistributionPaymentsEdgeFragment
}
}
}
Variables
{"input": DeleteDistributionPaymentByIdInput}
Response
{
"data": {
"deleteDistributionPaymentById": {
"clientMutationId": "abc123",
"distributionPayment": DistributionPayment,
"deletedDistributionPaymentId": 4,
"query": Query,
"distributionByDistributionId": Distribution,
"currencyByCurrency": Currency,
"distributionPaymentStatusByStatus": DistributionPaymentStatus,
"distributionPaymentEdge": DistributionPaymentsEdge
}
}
}
deleteDistributionQualification
Description
Deletes a single DistributionQualification using its globally unique id.
Response
Returns a DeleteDistributionQualificationPayload
Arguments
| Name | Description |
|---|---|
input - DeleteDistributionQualificationInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation deleteDistributionQualification($input: DeleteDistributionQualificationInput!) {
deleteDistributionQualification(input: $input) {
clientMutationId
distributionQualification {
...DistributionQualificationFragment
}
deletedDistributionQualificationId
query {
...QueryFragment
}
vendorQualificationByVendorQualificationId {
...VendorQualificationFragment
}
distributionByDistributionId {
...DistributionFragment
}
integrationByIntegrationId {
...IntegrationFragment
}
stepByStepId {
...StepFragment
}
distributionQualificationEdge {
...DistributionQualificationsEdgeFragment
}
}
}
Variables
{"input": DeleteDistributionQualificationInput}
Response
{
"data": {
"deleteDistributionQualification": {
"clientMutationId": "abc123",
"distributionQualification": DistributionQualification,
"deletedDistributionQualificationId": 4,
"query": Query,
"vendorQualificationByVendorQualificationId": VendorQualification,
"distributionByDistributionId": Distribution,
"integrationByIntegrationId": Integration,
"stepByStepId": Step,
"distributionQualificationEdge": DistributionQualificationsEdge
}
}
}
deleteDistributionQualificationByDistributionIdAndVendorQualificationId
Description
Deletes a single DistributionQualification using a unique key.
Response
Returns a DeleteDistributionQualificationPayload
Arguments
| Name | Description |
|---|---|
input - DeleteDistributionQualificationByDistributionIdAndVendorQualificationIdInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation deleteDistributionQualificationByDistributionIdAndVendorQualificationId($input: DeleteDistributionQualificationByDistributionIdAndVendorQualificationIdInput!) {
deleteDistributionQualificationByDistributionIdAndVendorQualificationId(input: $input) {
clientMutationId
distributionQualification {
...DistributionQualificationFragment
}
deletedDistributionQualificationId
query {
...QueryFragment
}
vendorQualificationByVendorQualificationId {
...VendorQualificationFragment
}
distributionByDistributionId {
...DistributionFragment
}
integrationByIntegrationId {
...IntegrationFragment
}
stepByStepId {
...StepFragment
}
distributionQualificationEdge {
...DistributionQualificationsEdgeFragment
}
}
}
Variables
{
"input": DeleteDistributionQualificationByDistributionIdAndVendorQualificationIdInput
}
Response
{
"data": {
"deleteDistributionQualificationByDistributionIdAndVendorQualificationId": {
"clientMutationId": "xyz789",
"distributionQualification": DistributionQualification,
"deletedDistributionQualificationId": 4,
"query": Query,
"vendorQualificationByVendorQualificationId": VendorQualification,
"distributionByDistributionId": Distribution,
"integrationByIntegrationId": Integration,
"stepByStepId": Step,
"distributionQualificationEdge": DistributionQualificationsEdge
}
}
}
deleteDistributionQualificationById
Description
Deletes a single DistributionQualification using a unique key.
Response
Returns a DeleteDistributionQualificationPayload
Arguments
| Name | Description |
|---|---|
input - DeleteDistributionQualificationByIdInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation deleteDistributionQualificationById($input: DeleteDistributionQualificationByIdInput!) {
deleteDistributionQualificationById(input: $input) {
clientMutationId
distributionQualification {
...DistributionQualificationFragment
}
deletedDistributionQualificationId
query {
...QueryFragment
}
vendorQualificationByVendorQualificationId {
...VendorQualificationFragment
}
distributionByDistributionId {
...DistributionFragment
}
integrationByIntegrationId {
...IntegrationFragment
}
stepByStepId {
...StepFragment
}
distributionQualificationEdge {
...DistributionQualificationsEdgeFragment
}
}
}
Variables
{"input": DeleteDistributionQualificationByIdInput}
Response
{
"data": {
"deleteDistributionQualificationById": {
"clientMutationId": "xyz789",
"distributionQualification": DistributionQualification,
"deletedDistributionQualificationId": 4,
"query": Query,
"vendorQualificationByVendorQualificationId": VendorQualification,
"distributionByDistributionId": Distribution,
"integrationByIntegrationId": Integration,
"stepByStepId": Step,
"distributionQualificationEdge": DistributionQualificationsEdge
}
}
}
deleteDocumentSharing
Description
Deletes a single DocumentSharing using its globally unique id.
Response
Returns a DeleteDocumentSharingPayload
Arguments
| Name | Description |
|---|---|
input - DeleteDocumentSharingInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation deleteDocumentSharing($input: DeleteDocumentSharingInput!) {
deleteDocumentSharing(input: $input) {
clientMutationId
documentSharing {
...DocumentSharingFragment
}
deletedDocumentSharingId
query {
...QueryFragment
}
documentByDocumentId {
...DocumentFragment
}
accountByUploaderId {
...AccountFragment
}
documentSharingRoleByToRole {
...DocumentSharingRoleFragment
}
userByCreatedBy {
...UserFragment
}
documentSharingEdge {
...DocumentSharingsEdgeFragment
}
}
}
Variables
{"input": DeleteDocumentSharingInput}
Response
{
"data": {
"deleteDocumentSharing": {
"clientMutationId": "abc123",
"documentSharing": DocumentSharing,
"deletedDocumentSharingId": "4",
"query": Query,
"documentByDocumentId": Document,
"accountByUploaderId": Account,
"documentSharingRoleByToRole": DocumentSharingRole,
"userByCreatedBy": User,
"documentSharingEdge": DocumentSharingsEdge
}
}
}
deleteDocumentSharingById
Description
Deletes a single DocumentSharing using a unique key.
Response
Returns a DeleteDocumentSharingPayload
Arguments
| Name | Description |
|---|---|
input - DeleteDocumentSharingByIdInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation deleteDocumentSharingById($input: DeleteDocumentSharingByIdInput!) {
deleteDocumentSharingById(input: $input) {
clientMutationId
documentSharing {
...DocumentSharingFragment
}
deletedDocumentSharingId
query {
...QueryFragment
}
documentByDocumentId {
...DocumentFragment
}
accountByUploaderId {
...AccountFragment
}
documentSharingRoleByToRole {
...DocumentSharingRoleFragment
}
userByCreatedBy {
...UserFragment
}
documentSharingEdge {
...DocumentSharingsEdgeFragment
}
}
}
Variables
{"input": DeleteDocumentSharingByIdInput}
Response
{
"data": {
"deleteDocumentSharingById": {
"clientMutationId": "xyz789",
"documentSharing": DocumentSharing,
"deletedDocumentSharingId": "4",
"query": Query,
"documentByDocumentId": Document,
"accountByUploaderId": Account,
"documentSharingRoleByToRole": DocumentSharingRole,
"userByCreatedBy": User,
"documentSharingEdge": DocumentSharingsEdge
}
}
}
deleteEmailTemplateTo
Description
Deletes a single EmailTemplateTo using its globally unique id.
Response
Returns a DeleteEmailTemplateToPayload
Arguments
| Name | Description |
|---|---|
input - DeleteEmailTemplateToInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation deleteEmailTemplateTo($input: DeleteEmailTemplateToInput!) {
deleteEmailTemplateTo(input: $input) {
clientMutationId
emailTemplateTo {
...EmailTemplateToFragment
}
deletedEmailTemplateToId
query {
...QueryFragment
}
emailTemplateToEdge {
...EmailTemplateTosEdgeFragment
}
}
}
Variables
{"input": DeleteEmailTemplateToInput}
Response
{
"data": {
"deleteEmailTemplateTo": {
"clientMutationId": "xyz789",
"emailTemplateTo": EmailTemplateTo,
"deletedEmailTemplateToId": 4,
"query": Query,
"emailTemplateToEdge": EmailTemplateTosEdge
}
}
}
deleteEmailTemplateToByTo
Description
Deletes a single EmailTemplateTo using a unique key.
Response
Returns a DeleteEmailTemplateToPayload
Arguments
| Name | Description |
|---|---|
input - DeleteEmailTemplateToByToInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation deleteEmailTemplateToByTo($input: DeleteEmailTemplateToByToInput!) {
deleteEmailTemplateToByTo(input: $input) {
clientMutationId
emailTemplateTo {
...EmailTemplateToFragment
}
deletedEmailTemplateToId
query {
...QueryFragment
}
emailTemplateToEdge {
...EmailTemplateTosEdgeFragment
}
}
}
Variables
{"input": DeleteEmailTemplateToByToInput}
Response
{
"data": {
"deleteEmailTemplateToByTo": {
"clientMutationId": "xyz789",
"emailTemplateTo": EmailTemplateTo,
"deletedEmailTemplateToId": 4,
"query": Query,
"emailTemplateToEdge": EmailTemplateTosEdge
}
}
}
deleteHoldingDocument
Response
Returns a DeleteHoldingDocumentPayload
Arguments
| Name | Description |
|---|---|
input - DeleteHoldingDocumentInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation deleteHoldingDocument($input: DeleteHoldingDocumentInput!) {
deleteHoldingDocument(input: $input) {
clientMutationId
holdingDocument {
...HoldingDocumentFragment
}
query {
...QueryFragment
}
documentByDocumentId {
...DocumentFragment
}
holdingByHoldingId {
...HoldingFragment
}
holdingDocumentEdge {
...HoldingDocumentsEdgeFragment
}
}
}
Variables
{"input": DeleteHoldingDocumentInput}
Response
{
"data": {
"deleteHoldingDocument": {
"clientMutationId": "xyz789",
"holdingDocument": HoldingDocument,
"query": Query,
"documentByDocumentId": Document,
"holdingByHoldingId": Holding,
"holdingDocumentEdge": HoldingDocumentsEdge
}
}
}
deleteInstancedAccountInformationHistory
Description
Deletes a single InstancedAccountInformationHistory using its globally unique id.
Response
Arguments
| Name | Description |
|---|---|
input - DeleteInstancedAccountInformationHistoryInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation deleteInstancedAccountInformationHistory($input: DeleteInstancedAccountInformationHistoryInput!) {
deleteInstancedAccountInformationHistory(input: $input) {
clientMutationId
instancedAccountInformationHistory {
...InstancedAccountInformationHistoryFragment
}
deletedInstancedAccountInformationHistoryId
query {
...QueryFragment
}
instancedAccountInformationByRecordId {
...InstancedAccountInformationFragment
}
instancedAccountInformationHistoryEdge {
...InstancedAccountInformationHistoriesEdgeFragment
}
}
}
Variables
{"input": DeleteInstancedAccountInformationHistoryInput}
Response
{
"data": {
"deleteInstancedAccountInformationHistory": {
"clientMutationId": "abc123",
"instancedAccountInformationHistory": InstancedAccountInformationHistory,
"deletedInstancedAccountInformationHistoryId": 4,
"query": Query,
"instancedAccountInformationByRecordId": InstancedAccountInformation,
"instancedAccountInformationHistoryEdge": InstancedAccountInformationHistoriesEdge
}
}
}
deleteInstancedAccountInformationHistoryById
Description
Deletes a single InstancedAccountInformationHistory using a unique key.
Response
Arguments
| Name | Description |
|---|---|
input - DeleteInstancedAccountInformationHistoryByIdInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation deleteInstancedAccountInformationHistoryById($input: DeleteInstancedAccountInformationHistoryByIdInput!) {
deleteInstancedAccountInformationHistoryById(input: $input) {
clientMutationId
instancedAccountInformationHistory {
...InstancedAccountInformationHistoryFragment
}
deletedInstancedAccountInformationHistoryId
query {
...QueryFragment
}
instancedAccountInformationByRecordId {
...InstancedAccountInformationFragment
}
instancedAccountInformationHistoryEdge {
...InstancedAccountInformationHistoriesEdgeFragment
}
}
}
Variables
{
"input": DeleteInstancedAccountInformationHistoryByIdInput
}
Response
{
"data": {
"deleteInstancedAccountInformationHistoryById": {
"clientMutationId": "abc123",
"instancedAccountInformationHistory": InstancedAccountInformationHistory,
"deletedInstancedAccountInformationHistoryId": "4",
"query": Query,
"instancedAccountInformationByRecordId": InstancedAccountInformation,
"instancedAccountInformationHistoryEdge": InstancedAccountInformationHistoriesEdge
}
}
}
deleteMappedSigningTemplateQuestionSet
Description
Deletes a single MappedSigningTemplateQuestionSet using its globally unique id.
Response
Arguments
| Name | Description |
|---|---|
input - DeleteMappedSigningTemplateQuestionSetInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation deleteMappedSigningTemplateQuestionSet($input: DeleteMappedSigningTemplateQuestionSetInput!) {
deleteMappedSigningTemplateQuestionSet(input: $input) {
clientMutationId
mappedSigningTemplateQuestionSet {
...MappedSigningTemplateQuestionSetFragment
}
deletedMappedSigningTemplateQuestionSetId
query {
...QueryFragment
}
onboardingQuestionSetByOnboardingQuestionSetId {
...OnboardingQuestionSetFragment
}
mappedSigningTemplateByMappedSigningTemplateId {
...MappedSigningTemplateFragment
}
mappedSigningTemplateQuestionSetEdge {
...MappedSigningTemplateQuestionSetsEdgeFragment
}
}
}
Variables
{"input": DeleteMappedSigningTemplateQuestionSetInput}
Response
{
"data": {
"deleteMappedSigningTemplateQuestionSet": {
"clientMutationId": "xyz789",
"mappedSigningTemplateQuestionSet": MappedSigningTemplateQuestionSet,
"deletedMappedSigningTemplateQuestionSetId": 4,
"query": Query,
"onboardingQuestionSetByOnboardingQuestionSetId": OnboardingQuestionSet,
"mappedSigningTemplateByMappedSigningTemplateId": MappedSigningTemplate,
"mappedSigningTemplateQuestionSetEdge": MappedSigningTemplateQuestionSetsEdge
}
}
}
deleteMappedSigningTemplateQuestionSetById
Description
Deletes a single MappedSigningTemplateQuestionSet using a unique key.
Response
Arguments
| Name | Description |
|---|---|
input - DeleteMappedSigningTemplateQuestionSetByIdInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation deleteMappedSigningTemplateQuestionSetById($input: DeleteMappedSigningTemplateQuestionSetByIdInput!) {
deleteMappedSigningTemplateQuestionSetById(input: $input) {
clientMutationId
mappedSigningTemplateQuestionSet {
...MappedSigningTemplateQuestionSetFragment
}
deletedMappedSigningTemplateQuestionSetId
query {
...QueryFragment
}
onboardingQuestionSetByOnboardingQuestionSetId {
...OnboardingQuestionSetFragment
}
mappedSigningTemplateByMappedSigningTemplateId {
...MappedSigningTemplateFragment
}
mappedSigningTemplateQuestionSetEdge {
...MappedSigningTemplateQuestionSetsEdgeFragment
}
}
}
Variables
{"input": DeleteMappedSigningTemplateQuestionSetByIdInput}
Response
{
"data": {
"deleteMappedSigningTemplateQuestionSetById": {
"clientMutationId": "abc123",
"mappedSigningTemplateQuestionSet": MappedSigningTemplateQuestionSet,
"deletedMappedSigningTemplateQuestionSetId": "4",
"query": Query,
"onboardingQuestionSetByOnboardingQuestionSetId": OnboardingQuestionSet,
"mappedSigningTemplateByMappedSigningTemplateId": MappedSigningTemplate,
"mappedSigningTemplateQuestionSetEdge": MappedSigningTemplateQuestionSetsEdge
}
}
}
deleteMappedSigningTemplateQuestionSetByOnboardingQuestionSetIdAndMappedSigningTemplateId
Description
Deletes a single MappedSigningTemplateQuestionSet using a unique key.
Response
Arguments
| Name | Description |
|---|---|
input - DeleteMappedSigningTemplateQuestionSetByOnboardingQuestionSetIdAndMappedSigningTemplateIdInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation deleteMappedSigningTemplateQuestionSetByOnboardingQuestionSetIdAndMappedSigningTemplateId($input: DeleteMappedSigningTemplateQuestionSetByOnboardingQuestionSetIdAndMappedSigningTemplateIdInput!) {
deleteMappedSigningTemplateQuestionSetByOnboardingQuestionSetIdAndMappedSigningTemplateId(input: $input) {
clientMutationId
mappedSigningTemplateQuestionSet {
...MappedSigningTemplateQuestionSetFragment
}
deletedMappedSigningTemplateQuestionSetId
query {
...QueryFragment
}
onboardingQuestionSetByOnboardingQuestionSetId {
...OnboardingQuestionSetFragment
}
mappedSigningTemplateByMappedSigningTemplateId {
...MappedSigningTemplateFragment
}
mappedSigningTemplateQuestionSetEdge {
...MappedSigningTemplateQuestionSetsEdgeFragment
}
}
}
Variables
{
"input": DeleteMappedSigningTemplateQuestionSetByOnboardingQuestionSetIdAndMappedSigningTemplateIdInput
}
Response
{
"data": {
"deleteMappedSigningTemplateQuestionSetByOnboardingQuestionSetIdAndMappedSigningTemplateId": {
"clientMutationId": "abc123",
"mappedSigningTemplateQuestionSet": MappedSigningTemplateQuestionSet,
"deletedMappedSigningTemplateQuestionSetId": 4,
"query": Query,
"onboardingQuestionSetByOnboardingQuestionSetId": OnboardingQuestionSet,
"mappedSigningTemplateByMappedSigningTemplateId": MappedSigningTemplate,
"mappedSigningTemplateQuestionSetEdge": MappedSigningTemplateQuestionSetsEdge
}
}
}
deleteOnboardingQuestion
Description
Deletes a single OnboardingQuestion using its globally unique id.
Response
Returns a DeleteOnboardingQuestionPayload
Arguments
| Name | Description |
|---|---|
input - DeleteOnboardingQuestionInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation deleteOnboardingQuestion($input: DeleteOnboardingQuestionInput!) {
deleteOnboardingQuestion(input: $input) {
clientMutationId
onboardingQuestion {
...OnboardingQuestionFragment
}
deletedOnboardingQuestionId
query {
...QueryFragment
}
accountByAccountId {
...AccountFragment
}
onboardingQuestionTypeByType {
...OnboardingQuestionTypeFragment
}
onboardingQuestionEdge {
...OnboardingQuestionsEdgeFragment
}
}
}
Variables
{"input": DeleteOnboardingQuestionInput}
Response
{
"data": {
"deleteOnboardingQuestion": {
"clientMutationId": "abc123",
"onboardingQuestion": OnboardingQuestion,
"deletedOnboardingQuestionId": "4",
"query": Query,
"accountByAccountId": Account,
"onboardingQuestionTypeByType": OnboardingQuestionType,
"onboardingQuestionEdge": OnboardingQuestionsEdge
}
}
}
deleteOnboardingQuestionByAccountIdAndName
Description
Deletes a single OnboardingQuestion using a unique key.
Response
Returns a DeleteOnboardingQuestionPayload
Arguments
| Name | Description |
|---|---|
input - DeleteOnboardingQuestionByAccountIdAndNameInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation deleteOnboardingQuestionByAccountIdAndName($input: DeleteOnboardingQuestionByAccountIdAndNameInput!) {
deleteOnboardingQuestionByAccountIdAndName(input: $input) {
clientMutationId
onboardingQuestion {
...OnboardingQuestionFragment
}
deletedOnboardingQuestionId
query {
...QueryFragment
}
accountByAccountId {
...AccountFragment
}
onboardingQuestionTypeByType {
...OnboardingQuestionTypeFragment
}
onboardingQuestionEdge {
...OnboardingQuestionsEdgeFragment
}
}
}
Variables
{"input": DeleteOnboardingQuestionByAccountIdAndNameInput}
Response
{
"data": {
"deleteOnboardingQuestionByAccountIdAndName": {
"clientMutationId": "abc123",
"onboardingQuestion": OnboardingQuestion,
"deletedOnboardingQuestionId": "4",
"query": Query,
"accountByAccountId": Account,
"onboardingQuestionTypeByType": OnboardingQuestionType,
"onboardingQuestionEdge": OnboardingQuestionsEdge
}
}
}
deleteOnboardingQuestionById
Description
Deletes a single OnboardingQuestion using a unique key.
Response
Returns a DeleteOnboardingQuestionPayload
Arguments
| Name | Description |
|---|---|
input - DeleteOnboardingQuestionByIdInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation deleteOnboardingQuestionById($input: DeleteOnboardingQuestionByIdInput!) {
deleteOnboardingQuestionById(input: $input) {
clientMutationId
onboardingQuestion {
...OnboardingQuestionFragment
}
deletedOnboardingQuestionId
query {
...QueryFragment
}
accountByAccountId {
...AccountFragment
}
onboardingQuestionTypeByType {
...OnboardingQuestionTypeFragment
}
onboardingQuestionEdge {
...OnboardingQuestionsEdgeFragment
}
}
}
Variables
{"input": DeleteOnboardingQuestionByIdInput}
Response
{
"data": {
"deleteOnboardingQuestionById": {
"clientMutationId": "abc123",
"onboardingQuestion": OnboardingQuestion,
"deletedOnboardingQuestionId": 4,
"query": Query,
"accountByAccountId": Account,
"onboardingQuestionTypeByType": OnboardingQuestionType,
"onboardingQuestionEdge": OnboardingQuestionsEdge
}
}
}
deleteOnboardingQuestionJoin
Description
Deletes a single OnboardingQuestionJoin using its globally unique id.
Response
Returns a DeleteOnboardingQuestionJoinPayload
Arguments
| Name | Description |
|---|---|
input - DeleteOnboardingQuestionJoinInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation deleteOnboardingQuestionJoin($input: DeleteOnboardingQuestionJoinInput!) {
deleteOnboardingQuestionJoin(input: $input) {
clientMutationId
onboardingQuestionJoin {
...OnboardingQuestionJoinFragment
}
deletedOnboardingQuestionJoinId
query {
...QueryFragment
}
onboardingQuestionSetByOnboardingQuestionSetId {
...OnboardingQuestionSetFragment
}
onboardingQuestionByOnboardingQuestionId {
...OnboardingQuestionFragment
}
onboardingQuestionJoinEdge {
...OnboardingQuestionJoinsEdgeFragment
}
}
}
Variables
{"input": DeleteOnboardingQuestionJoinInput}
Response
{
"data": {
"deleteOnboardingQuestionJoin": {
"clientMutationId": "xyz789",
"onboardingQuestionJoin": OnboardingQuestionJoin,
"deletedOnboardingQuestionJoinId": 4,
"query": Query,
"onboardingQuestionSetByOnboardingQuestionSetId": OnboardingQuestionSet,
"onboardingQuestionByOnboardingQuestionId": OnboardingQuestion,
"onboardingQuestionJoinEdge": OnboardingQuestionJoinsEdge
}
}
}
deleteOnboardingQuestionJoinById
Description
Deletes a single OnboardingQuestionJoin using a unique key.
Response
Returns a DeleteOnboardingQuestionJoinPayload
Arguments
| Name | Description |
|---|---|
input - DeleteOnboardingQuestionJoinByIdInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation deleteOnboardingQuestionJoinById($input: DeleteOnboardingQuestionJoinByIdInput!) {
deleteOnboardingQuestionJoinById(input: $input) {
clientMutationId
onboardingQuestionJoin {
...OnboardingQuestionJoinFragment
}
deletedOnboardingQuestionJoinId
query {
...QueryFragment
}
onboardingQuestionSetByOnboardingQuestionSetId {
...OnboardingQuestionSetFragment
}
onboardingQuestionByOnboardingQuestionId {
...OnboardingQuestionFragment
}
onboardingQuestionJoinEdge {
...OnboardingQuestionJoinsEdgeFragment
}
}
}
Variables
{"input": DeleteOnboardingQuestionJoinByIdInput}
Response
{
"data": {
"deleteOnboardingQuestionJoinById": {
"clientMutationId": "xyz789",
"onboardingQuestionJoin": OnboardingQuestionJoin,
"deletedOnboardingQuestionJoinId": 4,
"query": Query,
"onboardingQuestionSetByOnboardingQuestionSetId": OnboardingQuestionSet,
"onboardingQuestionByOnboardingQuestionId": OnboardingQuestion,
"onboardingQuestionJoinEdge": OnboardingQuestionJoinsEdge
}
}
}
deleteOnboardingQuestionJoinByOnboardingQuestionSetIdAndOnboardingQuestionId
Description
Deletes a single OnboardingQuestionJoin using a unique key.
Response
Returns a DeleteOnboardingQuestionJoinPayload
Arguments
| Name | Description |
|---|---|
input - DeleteOnboardingQuestionJoinByOnboardingQuestionSetIdAndOnboardingQuestionIdInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation deleteOnboardingQuestionJoinByOnboardingQuestionSetIdAndOnboardingQuestionId($input: DeleteOnboardingQuestionJoinByOnboardingQuestionSetIdAndOnboardingQuestionIdInput!) {
deleteOnboardingQuestionJoinByOnboardingQuestionSetIdAndOnboardingQuestionId(input: $input) {
clientMutationId
onboardingQuestionJoin {
...OnboardingQuestionJoinFragment
}
deletedOnboardingQuestionJoinId
query {
...QueryFragment
}
onboardingQuestionSetByOnboardingQuestionSetId {
...OnboardingQuestionSetFragment
}
onboardingQuestionByOnboardingQuestionId {
...OnboardingQuestionFragment
}
onboardingQuestionJoinEdge {
...OnboardingQuestionJoinsEdgeFragment
}
}
}
Variables
{
"input": DeleteOnboardingQuestionJoinByOnboardingQuestionSetIdAndOnboardingQuestionIdInput
}
Response
{
"data": {
"deleteOnboardingQuestionJoinByOnboardingQuestionSetIdAndOnboardingQuestionId": {
"clientMutationId": "xyz789",
"onboardingQuestionJoin": OnboardingQuestionJoin,
"deletedOnboardingQuestionJoinId": 4,
"query": Query,
"onboardingQuestionSetByOnboardingQuestionSetId": OnboardingQuestionSet,
"onboardingQuestionByOnboardingQuestionId": OnboardingQuestion,
"onboardingQuestionJoinEdge": OnboardingQuestionJoinsEdge
}
}
}
deleteOnboardingQuestionSet
Description
Deletes a single OnboardingQuestionSet using its globally unique id.
Response
Returns a DeleteOnboardingQuestionSetPayload
Arguments
| Name | Description |
|---|---|
input - DeleteOnboardingQuestionSetInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation deleteOnboardingQuestionSet($input: DeleteOnboardingQuestionSetInput!) {
deleteOnboardingQuestionSet(input: $input) {
clientMutationId
onboardingQuestionSet {
...OnboardingQuestionSetFragment
}
deletedOnboardingQuestionSetId
query {
...QueryFragment
}
accountByAccountId {
...AccountFragment
}
vendorQualificationByVendorQualificationId {
...VendorQualificationFragment
}
onboardingQuestionSetEdge {
...OnboardingQuestionSetsEdgeFragment
}
}
}
Variables
{"input": DeleteOnboardingQuestionSetInput}
Response
{
"data": {
"deleteOnboardingQuestionSet": {
"clientMutationId": "abc123",
"onboardingQuestionSet": OnboardingQuestionSet,
"deletedOnboardingQuestionSetId": 4,
"query": Query,
"accountByAccountId": Account,
"vendorQualificationByVendorQualificationId": VendorQualification,
"onboardingQuestionSetEdge": OnboardingQuestionSetsEdge
}
}
}
deleteOnboardingQuestionSetByAccountIdAndName
Description
Deletes a single OnboardingQuestionSet using a unique key.
Response
Returns a DeleteOnboardingQuestionSetPayload
Arguments
| Name | Description |
|---|---|
input - DeleteOnboardingQuestionSetByAccountIdAndNameInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation deleteOnboardingQuestionSetByAccountIdAndName($input: DeleteOnboardingQuestionSetByAccountIdAndNameInput!) {
deleteOnboardingQuestionSetByAccountIdAndName(input: $input) {
clientMutationId
onboardingQuestionSet {
...OnboardingQuestionSetFragment
}
deletedOnboardingQuestionSetId
query {
...QueryFragment
}
accountByAccountId {
...AccountFragment
}
vendorQualificationByVendorQualificationId {
...VendorQualificationFragment
}
onboardingQuestionSetEdge {
...OnboardingQuestionSetsEdgeFragment
}
}
}
Variables
{
"input": DeleteOnboardingQuestionSetByAccountIdAndNameInput
}
Response
{
"data": {
"deleteOnboardingQuestionSetByAccountIdAndName": {
"clientMutationId": "xyz789",
"onboardingQuestionSet": OnboardingQuestionSet,
"deletedOnboardingQuestionSetId": 4,
"query": Query,
"accountByAccountId": Account,
"vendorQualificationByVendorQualificationId": VendorQualification,
"onboardingQuestionSetEdge": OnboardingQuestionSetsEdge
}
}
}
deleteOnboardingQuestionSetById
Description
Deletes a single OnboardingQuestionSet using a unique key.
Response
Returns a DeleteOnboardingQuestionSetPayload
Arguments
| Name | Description |
|---|---|
input - DeleteOnboardingQuestionSetByIdInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation deleteOnboardingQuestionSetById($input: DeleteOnboardingQuestionSetByIdInput!) {
deleteOnboardingQuestionSetById(input: $input) {
clientMutationId
onboardingQuestionSet {
...OnboardingQuestionSetFragment
}
deletedOnboardingQuestionSetId
query {
...QueryFragment
}
accountByAccountId {
...AccountFragment
}
vendorQualificationByVendorQualificationId {
...VendorQualificationFragment
}
onboardingQuestionSetEdge {
...OnboardingQuestionSetsEdgeFragment
}
}
}
Variables
{"input": DeleteOnboardingQuestionSetByIdInput}
Response
{
"data": {
"deleteOnboardingQuestionSetById": {
"clientMutationId": "xyz789",
"onboardingQuestionSet": OnboardingQuestionSet,
"deletedOnboardingQuestionSetId": "4",
"query": Query,
"accountByAccountId": Account,
"vendorQualificationByVendorQualificationId": VendorQualification,
"onboardingQuestionSetEdge": OnboardingQuestionSetsEdge
}
}
}
deleteOnboardingQuestionSetByVendorQualificationId
Description
Deletes a single OnboardingQuestionSet using a unique key.
Response
Returns a DeleteOnboardingQuestionSetPayload
Arguments
| Name | Description |
|---|---|
input - DeleteOnboardingQuestionSetByVendorQualificationIdInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation deleteOnboardingQuestionSetByVendorQualificationId($input: DeleteOnboardingQuestionSetByVendorQualificationIdInput!) {
deleteOnboardingQuestionSetByVendorQualificationId(input: $input) {
clientMutationId
onboardingQuestionSet {
...OnboardingQuestionSetFragment
}
deletedOnboardingQuestionSetId
query {
...QueryFragment
}
accountByAccountId {
...AccountFragment
}
vendorQualificationByVendorQualificationId {
...VendorQualificationFragment
}
onboardingQuestionSetEdge {
...OnboardingQuestionSetsEdgeFragment
}
}
}
Variables
{
"input": DeleteOnboardingQuestionSetByVendorQualificationIdInput
}
Response
{
"data": {
"deleteOnboardingQuestionSetByVendorQualificationId": {
"clientMutationId": "xyz789",
"onboardingQuestionSet": OnboardingQuestionSet,
"deletedOnboardingQuestionSetId": "4",
"query": Query,
"accountByAccountId": Account,
"vendorQualificationByVendorQualificationId": VendorQualification,
"onboardingQuestionSetEdge": OnboardingQuestionSetsEdge
}
}
}
deletePaymentMethod
Description
Deletes a single PaymentMethod using its globally unique id.
Response
Returns a DeletePaymentMethodPayload
Arguments
| Name | Description |
|---|---|
input - DeletePaymentMethodInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation deletePaymentMethod($input: DeletePaymentMethodInput!) {
deletePaymentMethod(input: $input) {
clientMutationId
paymentMethod {
...PaymentMethodFragment
}
deletedPaymentMethodId
query {
...QueryFragment
}
accountByAccountId {
...AccountFragment
}
integrationByIntegrationId {
...IntegrationFragment
}
paymentMethodTypeByType {
...PaymentMethodTypeFragment
}
paymentMethodEdge {
...PaymentMethodsEdgeFragment
}
}
}
Variables
{"input": DeletePaymentMethodInput}
Response
{
"data": {
"deletePaymentMethod": {
"clientMutationId": "xyz789",
"paymentMethod": PaymentMethod,
"deletedPaymentMethodId": 4,
"query": Query,
"accountByAccountId": Account,
"integrationByIntegrationId": Integration,
"paymentMethodTypeByType": PaymentMethodType,
"paymentMethodEdge": PaymentMethodsEdge
}
}
}
deletePaymentMethodByAccountIdAndName
Description
Deletes a single PaymentMethod using a unique key.
Response
Returns a DeletePaymentMethodPayload
Arguments
| Name | Description |
|---|---|
input - DeletePaymentMethodByAccountIdAndNameInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation deletePaymentMethodByAccountIdAndName($input: DeletePaymentMethodByAccountIdAndNameInput!) {
deletePaymentMethodByAccountIdAndName(input: $input) {
clientMutationId
paymentMethod {
...PaymentMethodFragment
}
deletedPaymentMethodId
query {
...QueryFragment
}
accountByAccountId {
...AccountFragment
}
integrationByIntegrationId {
...IntegrationFragment
}
paymentMethodTypeByType {
...PaymentMethodTypeFragment
}
paymentMethodEdge {
...PaymentMethodsEdgeFragment
}
}
}
Variables
{"input": DeletePaymentMethodByAccountIdAndNameInput}
Response
{
"data": {
"deletePaymentMethodByAccountIdAndName": {
"clientMutationId": "xyz789",
"paymentMethod": PaymentMethod,
"deletedPaymentMethodId": "4",
"query": Query,
"accountByAccountId": Account,
"integrationByIntegrationId": Integration,
"paymentMethodTypeByType": PaymentMethodType,
"paymentMethodEdge": PaymentMethodsEdge
}
}
}
deletePaymentMethodByEncryptedRecordId
Description
Deletes a single PaymentMethod using a unique key.
Response
Returns a DeletePaymentMethodPayload
Arguments
| Name | Description |
|---|---|
input - DeletePaymentMethodByEncryptedRecordIdInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation deletePaymentMethodByEncryptedRecordId($input: DeletePaymentMethodByEncryptedRecordIdInput!) {
deletePaymentMethodByEncryptedRecordId(input: $input) {
clientMutationId
paymentMethod {
...PaymentMethodFragment
}
deletedPaymentMethodId
query {
...QueryFragment
}
accountByAccountId {
...AccountFragment
}
integrationByIntegrationId {
...IntegrationFragment
}
paymentMethodTypeByType {
...PaymentMethodTypeFragment
}
paymentMethodEdge {
...PaymentMethodsEdgeFragment
}
}
}
Variables
{"input": DeletePaymentMethodByEncryptedRecordIdInput}
Response
{
"data": {
"deletePaymentMethodByEncryptedRecordId": {
"clientMutationId": "abc123",
"paymentMethod": PaymentMethod,
"deletedPaymentMethodId": "4",
"query": Query,
"accountByAccountId": Account,
"integrationByIntegrationId": Integration,
"paymentMethodTypeByType": PaymentMethodType,
"paymentMethodEdge": PaymentMethodsEdge
}
}
}
deletePaymentMethodById
Description
Deletes a single PaymentMethod using a unique key.
Response
Returns a DeletePaymentMethodPayload
Arguments
| Name | Description |
|---|---|
input - DeletePaymentMethodByIdInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation deletePaymentMethodById($input: DeletePaymentMethodByIdInput!) {
deletePaymentMethodById(input: $input) {
clientMutationId
paymentMethod {
...PaymentMethodFragment
}
deletedPaymentMethodId
query {
...QueryFragment
}
accountByAccountId {
...AccountFragment
}
integrationByIntegrationId {
...IntegrationFragment
}
paymentMethodTypeByType {
...PaymentMethodTypeFragment
}
paymentMethodEdge {
...PaymentMethodsEdgeFragment
}
}
}
Variables
{"input": DeletePaymentMethodByIdInput}
Response
{
"data": {
"deletePaymentMethodById": {
"clientMutationId": "abc123",
"paymentMethod": PaymentMethod,
"deletedPaymentMethodId": 4,
"query": Query,
"accountByAccountId": Account,
"integrationByIntegrationId": Integration,
"paymentMethodTypeByType": PaymentMethodType,
"paymentMethodEdge": PaymentMethodsEdge
}
}
}
deletePaymentMethodType
Description
Deletes a single PaymentMethodType using its globally unique id.
Response
Returns a DeletePaymentMethodTypePayload
Arguments
| Name | Description |
|---|---|
input - DeletePaymentMethodTypeInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation deletePaymentMethodType($input: DeletePaymentMethodTypeInput!) {
deletePaymentMethodType(input: $input) {
clientMutationId
paymentMethodType {
...PaymentMethodTypeFragment
}
deletedPaymentMethodTypeId
query {
...QueryFragment
}
paymentMethodTypeEdge {
...PaymentMethodTypesEdgeFragment
}
}
}
Variables
{"input": DeletePaymentMethodTypeInput}
Response
{
"data": {
"deletePaymentMethodType": {
"clientMutationId": "abc123",
"paymentMethodType": PaymentMethodType,
"deletedPaymentMethodTypeId": "4",
"query": Query,
"paymentMethodTypeEdge": PaymentMethodTypesEdge
}
}
}
deletePaymentMethodTypeByType
Description
Deletes a single PaymentMethodType using a unique key.
Response
Returns a DeletePaymentMethodTypePayload
Arguments
| Name | Description |
|---|---|
input - DeletePaymentMethodTypeByTypeInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation deletePaymentMethodTypeByType($input: DeletePaymentMethodTypeByTypeInput!) {
deletePaymentMethodTypeByType(input: $input) {
clientMutationId
paymentMethodType {
...PaymentMethodTypeFragment
}
deletedPaymentMethodTypeId
query {
...QueryFragment
}
paymentMethodTypeEdge {
...PaymentMethodTypesEdgeFragment
}
}
}
Variables
{"input": DeletePaymentMethodTypeByTypeInput}
Response
{
"data": {
"deletePaymentMethodTypeByType": {
"clientMutationId": "xyz789",
"paymentMethodType": PaymentMethodType,
"deletedPaymentMethodTypeId": "4",
"query": Query,
"paymentMethodTypeEdge": PaymentMethodTypesEdge
}
}
}
deletePaymentStepType
Description
Deletes a single PaymentStepType using its globally unique id.
Response
Returns a DeletePaymentStepTypePayload
Arguments
| Name | Description |
|---|---|
input - DeletePaymentStepTypeInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation deletePaymentStepType($input: DeletePaymentStepTypeInput!) {
deletePaymentStepType(input: $input) {
clientMutationId
paymentStepType {
...PaymentStepTypeFragment
}
deletedPaymentStepTypeId
query {
...QueryFragment
}
paymentStepTypeEdge {
...PaymentStepTypesEdgeFragment
}
}
}
Variables
{"input": DeletePaymentStepTypeInput}
Response
{
"data": {
"deletePaymentStepType": {
"clientMutationId": "xyz789",
"paymentStepType": PaymentStepType,
"deletedPaymentStepTypeId": 4,
"query": Query,
"paymentStepTypeEdge": PaymentStepTypesEdge
}
}
}
deletePaymentStepTypeByType
Description
Deletes a single PaymentStepType using a unique key.
Response
Returns a DeletePaymentStepTypePayload
Arguments
| Name | Description |
|---|---|
input - DeletePaymentStepTypeByTypeInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation deletePaymentStepTypeByType($input: DeletePaymentStepTypeByTypeInput!) {
deletePaymentStepTypeByType(input: $input) {
clientMutationId
paymentStepType {
...PaymentStepTypeFragment
}
deletedPaymentStepTypeId
query {
...QueryFragment
}
paymentStepTypeEdge {
...PaymentStepTypesEdgeFragment
}
}
}
Variables
{"input": DeletePaymentStepTypeByTypeInput}
Response
{
"data": {
"deletePaymentStepTypeByType": {
"clientMutationId": "xyz789",
"paymentStepType": PaymentStepType,
"deletedPaymentStepTypeId": "4",
"query": Query,
"paymentStepTypeEdge": PaymentStepTypesEdge
}
}
}
deleteRestrictionCategory
Description
Deletes a single RestrictionCategory using its globally unique id.
Response
Returns a DeleteRestrictionCategoryPayload
Arguments
| Name | Description |
|---|---|
input - DeleteRestrictionCategoryInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation deleteRestrictionCategory($input: DeleteRestrictionCategoryInput!) {
deleteRestrictionCategory(input: $input) {
clientMutationId
restrictionCategory {
...RestrictionCategoryFragment
}
deletedRestrictionCategoryId
query {
...QueryFragment
}
restrictionCategoryEdge {
...RestrictionCategoriesEdgeFragment
}
}
}
Variables
{"input": DeleteRestrictionCategoryInput}
Response
{
"data": {
"deleteRestrictionCategory": {
"clientMutationId": "abc123",
"restrictionCategory": RestrictionCategory,
"deletedRestrictionCategoryId": 4,
"query": Query,
"restrictionCategoryEdge": RestrictionCategoriesEdge
}
}
}
deleteRestrictionCategoryByCategory
Description
Deletes a single RestrictionCategory using a unique key.
Response
Returns a DeleteRestrictionCategoryPayload
Arguments
| Name | Description |
|---|---|
input - DeleteRestrictionCategoryByCategoryInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation deleteRestrictionCategoryByCategory($input: DeleteRestrictionCategoryByCategoryInput!) {
deleteRestrictionCategoryByCategory(input: $input) {
clientMutationId
restrictionCategory {
...RestrictionCategoryFragment
}
deletedRestrictionCategoryId
query {
...QueryFragment
}
restrictionCategoryEdge {
...RestrictionCategoriesEdgeFragment
}
}
}
Variables
{"input": DeleteRestrictionCategoryByCategoryInput}
Response
{
"data": {
"deleteRestrictionCategoryByCategory": {
"clientMutationId": "abc123",
"restrictionCategory": RestrictionCategory,
"deletedRestrictionCategoryId": "4",
"query": Query,
"restrictionCategoryEdge": RestrictionCategoriesEdge
}
}
}
deleteRestrictionReason
Description
Deletes a single RestrictionReason using its globally unique id.
Response
Returns a DeleteRestrictionReasonPayload
Arguments
| Name | Description |
|---|---|
input - DeleteRestrictionReasonInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation deleteRestrictionReason($input: DeleteRestrictionReasonInput!) {
deleteRestrictionReason(input: $input) {
clientMutationId
restrictionReason {
...RestrictionReasonFragment
}
deletedRestrictionReasonId
query {
...QueryFragment
}
restrictionCategoryByCategory {
...RestrictionCategoryFragment
}
restrictionReasonEdge {
...RestrictionReasonsEdgeFragment
}
}
}
Variables
{"input": DeleteRestrictionReasonInput}
Response
{
"data": {
"deleteRestrictionReason": {
"clientMutationId": "xyz789",
"restrictionReason": RestrictionReason,
"deletedRestrictionReasonId": "4",
"query": Query,
"restrictionCategoryByCategory": RestrictionCategory,
"restrictionReasonEdge": RestrictionReasonsEdge
}
}
}
deleteRestrictionReasonById
Description
Deletes a single RestrictionReason using a unique key.
Response
Returns a DeleteRestrictionReasonPayload
Arguments
| Name | Description |
|---|---|
input - DeleteRestrictionReasonByIdInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation deleteRestrictionReasonById($input: DeleteRestrictionReasonByIdInput!) {
deleteRestrictionReasonById(input: $input) {
clientMutationId
restrictionReason {
...RestrictionReasonFragment
}
deletedRestrictionReasonId
query {
...QueryFragment
}
restrictionCategoryByCategory {
...RestrictionCategoryFragment
}
restrictionReasonEdge {
...RestrictionReasonsEdgeFragment
}
}
}
Variables
{"input": DeleteRestrictionReasonByIdInput}
Response
{
"data": {
"deleteRestrictionReasonById": {
"clientMutationId": "xyz789",
"restrictionReason": RestrictionReason,
"deletedRestrictionReasonId": 4,
"query": Query,
"restrictionCategoryByCategory": RestrictionCategory,
"restrictionReasonEdge": RestrictionReasonsEdge
}
}
}
deleteRestrictionReasonByReason
Description
Deletes a single RestrictionReason using a unique key.
Response
Returns a DeleteRestrictionReasonPayload
Arguments
| Name | Description |
|---|---|
input - DeleteRestrictionReasonByReasonInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation deleteRestrictionReasonByReason($input: DeleteRestrictionReasonByReasonInput!) {
deleteRestrictionReasonByReason(input: $input) {
clientMutationId
restrictionReason {
...RestrictionReasonFragment
}
deletedRestrictionReasonId
query {
...QueryFragment
}
restrictionCategoryByCategory {
...RestrictionCategoryFragment
}
restrictionReasonEdge {
...RestrictionReasonsEdgeFragment
}
}
}
Variables
{"input": DeleteRestrictionReasonByReasonInput}
Response
{
"data": {
"deleteRestrictionReasonByReason": {
"clientMutationId": "xyz789",
"restrictionReason": RestrictionReason,
"deletedRestrictionReasonId": 4,
"query": Query,
"restrictionCategoryByCategory": RestrictionCategory,
"restrictionReasonEdge": RestrictionReasonsEdge
}
}
}
deleteSecurityDocument
Response
Returns a DeleteSecurityDocumentPayload
Arguments
| Name | Description |
|---|---|
input - DeleteSecurityDocumentInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation deleteSecurityDocument($input: DeleteSecurityDocumentInput!) {
deleteSecurityDocument(input: $input) {
clientMutationId
securityDocument {
...SecurityDocumentFragment
}
query {
...QueryFragment
}
documentByDocumentId {
...DocumentFragment
}
securityBySecurityId {
...SecurityFragment
}
securityDocumentEdge {
...SecurityDocumentsEdgeFragment
}
}
}
Variables
{"input": DeleteSecurityDocumentInput}
Response
{
"data": {
"deleteSecurityDocument": {
"clientMutationId": "abc123",
"securityDocument": SecurityDocument,
"query": Query,
"documentByDocumentId": Document,
"securityBySecurityId": Security,
"securityDocumentEdge": SecurityDocumentsEdge
}
}
}
deleteSigningField
Description
Deletes a single SigningField using its globally unique id.
Response
Returns a DeleteSigningFieldPayload
Arguments
| Name | Description |
|---|---|
input - DeleteSigningFieldInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation deleteSigningField($input: DeleteSigningFieldInput!) {
deleteSigningField(input: $input) {
clientMutationId
signingField {
...SigningFieldFragment
}
deletedSigningFieldId
query {
...QueryFragment
}
mappedSigningTemplateByMappedSigningTemplateId {
...MappedSigningTemplateFragment
}
signingDocumentBySigningDocumentId {
...SigningDocumentFragment
}
signingRoleBySigningRoleId {
...SigningRoleFragment
}
signingFieldEdge {
...SigningFieldsEdgeFragment
}
}
}
Variables
{"input": DeleteSigningFieldInput}
Response
{
"data": {
"deleteSigningField": {
"clientMutationId": "xyz789",
"signingField": SigningField,
"deletedSigningFieldId": 4,
"query": Query,
"mappedSigningTemplateByMappedSigningTemplateId": MappedSigningTemplate,
"signingDocumentBySigningDocumentId": SigningDocument,
"signingRoleBySigningRoleId": SigningRole,
"signingFieldEdge": SigningFieldsEdge
}
}
}
deleteSigningFieldById
Description
Deletes a single SigningField using a unique key.
Response
Returns a DeleteSigningFieldPayload
Arguments
| Name | Description |
|---|---|
input - DeleteSigningFieldByIdInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation deleteSigningFieldById($input: DeleteSigningFieldByIdInput!) {
deleteSigningFieldById(input: $input) {
clientMutationId
signingField {
...SigningFieldFragment
}
deletedSigningFieldId
query {
...QueryFragment
}
mappedSigningTemplateByMappedSigningTemplateId {
...MappedSigningTemplateFragment
}
signingDocumentBySigningDocumentId {
...SigningDocumentFragment
}
signingRoleBySigningRoleId {
...SigningRoleFragment
}
signingFieldEdge {
...SigningFieldsEdgeFragment
}
}
}
Variables
{"input": DeleteSigningFieldByIdInput}
Response
{
"data": {
"deleteSigningFieldById": {
"clientMutationId": "abc123",
"signingField": SigningField,
"deletedSigningFieldId": "4",
"query": Query,
"mappedSigningTemplateByMappedSigningTemplateId": MappedSigningTemplate,
"signingDocumentBySigningDocumentId": SigningDocument,
"signingRoleBySigningRoleId": SigningRole,
"signingFieldEdge": SigningFieldsEdge
}
}
}
deleteTransactionAnnotation
Description
Deletes a single TransactionAnnotation using its globally unique id.
Response
Returns a DeleteTransactionAnnotationPayload
Arguments
| Name | Description |
|---|---|
input - DeleteTransactionAnnotationInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation deleteTransactionAnnotation($input: DeleteTransactionAnnotationInput!) {
deleteTransactionAnnotation(input: $input) {
clientMutationId
transactionAnnotation {
...TransactionAnnotationFragment
}
deletedTransactionAnnotationId
query {
...QueryFragment
}
transactionByTransactionId {
...TransactionFragment
}
userByWrittenBy {
...UserFragment
}
accountByAccountId {
...AccountFragment
}
transactionAnnotationEdge {
...TransactionAnnotationsEdgeFragment
}
}
}
Variables
{"input": DeleteTransactionAnnotationInput}
Response
{
"data": {
"deleteTransactionAnnotation": {
"clientMutationId": "abc123",
"transactionAnnotation": TransactionAnnotation,
"deletedTransactionAnnotationId": 4,
"query": Query,
"transactionByTransactionId": Transaction,
"userByWrittenBy": User,
"accountByAccountId": Account,
"transactionAnnotationEdge": TransactionAnnotationsEdge
}
}
}
deleteTransactionAnnotationById
Description
Deletes a single TransactionAnnotation using a unique key.
Response
Returns a DeleteTransactionAnnotationPayload
Arguments
| Name | Description |
|---|---|
input - DeleteTransactionAnnotationByIdInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation deleteTransactionAnnotationById($input: DeleteTransactionAnnotationByIdInput!) {
deleteTransactionAnnotationById(input: $input) {
clientMutationId
transactionAnnotation {
...TransactionAnnotationFragment
}
deletedTransactionAnnotationId
query {
...QueryFragment
}
transactionByTransactionId {
...TransactionFragment
}
userByWrittenBy {
...UserFragment
}
accountByAccountId {
...AccountFragment
}
transactionAnnotationEdge {
...TransactionAnnotationsEdgeFragment
}
}
}
Variables
{"input": DeleteTransactionAnnotationByIdInput}
Response
{
"data": {
"deleteTransactionAnnotationById": {
"clientMutationId": "abc123",
"transactionAnnotation": TransactionAnnotation,
"deletedTransactionAnnotationId": "4",
"query": Query,
"transactionByTransactionId": Transaction,
"userByWrittenBy": User,
"accountByAccountId": Account,
"transactionAnnotationEdge": TransactionAnnotationsEdge
}
}
}
deleteVendorIntegrationStatus
Description
Deletes a single VendorIntegrationStatus using its globally unique id.
Response
Returns a DeleteVendorIntegrationStatusPayload
Arguments
| Name | Description |
|---|---|
input - DeleteVendorIntegrationStatusInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation deleteVendorIntegrationStatus($input: DeleteVendorIntegrationStatusInput!) {
deleteVendorIntegrationStatus(input: $input) {
clientMutationId
vendorIntegrationStatus {
...VendorIntegrationStatusFragment
}
deletedVendorIntegrationStatusId
query {
...QueryFragment
}
vendorIntegrationStatusEdge {
...VendorIntegrationStatusesEdgeFragment
}
}
}
Variables
{"input": DeleteVendorIntegrationStatusInput}
Response
{
"data": {
"deleteVendorIntegrationStatus": {
"clientMutationId": "abc123",
"vendorIntegrationStatus": VendorIntegrationStatus,
"deletedVendorIntegrationStatusId": "4",
"query": Query,
"vendorIntegrationStatusEdge": VendorIntegrationStatusesEdge
}
}
}
deleteVendorIntegrationStatusByStatus
Description
Deletes a single VendorIntegrationStatus using a unique key.
Response
Returns a DeleteVendorIntegrationStatusPayload
Arguments
| Name | Description |
|---|---|
input - DeleteVendorIntegrationStatusByStatusInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation deleteVendorIntegrationStatusByStatus($input: DeleteVendorIntegrationStatusByStatusInput!) {
deleteVendorIntegrationStatusByStatus(input: $input) {
clientMutationId
vendorIntegrationStatus {
...VendorIntegrationStatusFragment
}
deletedVendorIntegrationStatusId
query {
...QueryFragment
}
vendorIntegrationStatusEdge {
...VendorIntegrationStatusesEdgeFragment
}
}
}
Variables
{"input": DeleteVendorIntegrationStatusByStatusInput}
Response
{
"data": {
"deleteVendorIntegrationStatusByStatus": {
"clientMutationId": "xyz789",
"vendorIntegrationStatus": VendorIntegrationStatus,
"deletedVendorIntegrationStatusId": "4",
"query": Query,
"vendorIntegrationStatusEdge": VendorIntegrationStatusesEdge
}
}
}
deleteVestingEvent
Description
Deletes a single VestingEvent using its globally unique id.
Response
Returns a DeleteVestingEventPayload
Arguments
| Name | Description |
|---|---|
input - DeleteVestingEventInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation deleteVestingEvent($input: DeleteVestingEventInput!) {
deleteVestingEvent(input: $input) {
clientMutationId
vestingEvent {
...VestingEventFragment
}
deletedVestingEventId
query {
...QueryFragment
}
vestingScheduleByVestingScheduleId {
...VestingScheduleFragment
}
transactionByTransactionId {
...TransactionFragment
}
vestingEventEdge {
...VestingEventsEdgeFragment
}
}
}
Variables
{"input": DeleteVestingEventInput}
Response
{
"data": {
"deleteVestingEvent": {
"clientMutationId": "abc123",
"vestingEvent": VestingEvent,
"deletedVestingEventId": 4,
"query": Query,
"vestingScheduleByVestingScheduleId": VestingSchedule,
"transactionByTransactionId": Transaction,
"vestingEventEdge": VestingEventsEdge
}
}
}
deleteVestingEventById
Description
Deletes a single VestingEvent using a unique key.
Response
Returns a DeleteVestingEventPayload
Arguments
| Name | Description |
|---|---|
input - DeleteVestingEventByIdInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation deleteVestingEventById($input: DeleteVestingEventByIdInput!) {
deleteVestingEventById(input: $input) {
clientMutationId
vestingEvent {
...VestingEventFragment
}
deletedVestingEventId
query {
...QueryFragment
}
vestingScheduleByVestingScheduleId {
...VestingScheduleFragment
}
transactionByTransactionId {
...TransactionFragment
}
vestingEventEdge {
...VestingEventsEdgeFragment
}
}
}
Variables
{"input": DeleteVestingEventByIdInput}
Response
{
"data": {
"deleteVestingEventById": {
"clientMutationId": "xyz789",
"vestingEvent": VestingEvent,
"deletedVestingEventId": "4",
"query": Query,
"vestingScheduleByVestingScheduleId": VestingSchedule,
"transactionByTransactionId": Transaction,
"vestingEventEdge": VestingEventsEdge
}
}
}
deleteWalletAssignment
Description
Deletes a single WalletAssignment using its globally unique id.
Response
Returns a DeleteWalletAssignmentPayload
Arguments
| Name | Description |
|---|---|
input - DeleteWalletAssignmentInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation deleteWalletAssignment($input: DeleteWalletAssignmentInput!) {
deleteWalletAssignment(input: $input) {
clientMutationId
walletAssignment {
...WalletAssignmentFragment
}
deletedWalletAssignmentId
query {
...QueryFragment
}
distributionByDistributionId {
...DistributionFragment
}
blockchainAddressByBlockchainAddressId {
...BlockchainAddressFragment
}
walletAssignmentEdge {
...WalletAssignmentsEdgeFragment
}
}
}
Variables
{"input": DeleteWalletAssignmentInput}
Response
{
"data": {
"deleteWalletAssignment": {
"clientMutationId": "abc123",
"walletAssignment": WalletAssignment,
"deletedWalletAssignmentId": "4",
"query": Query,
"distributionByDistributionId": Distribution,
"blockchainAddressByBlockchainAddressId": BlockchainAddress,
"walletAssignmentEdge": WalletAssignmentsEdge
}
}
}
deleteWalletAssignmentByDistributionId
Description
Deletes a single WalletAssignment using a unique key.
Response
Returns a DeleteWalletAssignmentPayload
Arguments
| Name | Description |
|---|---|
input - DeleteWalletAssignmentByDistributionIdInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation deleteWalletAssignmentByDistributionId($input: DeleteWalletAssignmentByDistributionIdInput!) {
deleteWalletAssignmentByDistributionId(input: $input) {
clientMutationId
walletAssignment {
...WalletAssignmentFragment
}
deletedWalletAssignmentId
query {
...QueryFragment
}
distributionByDistributionId {
...DistributionFragment
}
blockchainAddressByBlockchainAddressId {
...BlockchainAddressFragment
}
walletAssignmentEdge {
...WalletAssignmentsEdgeFragment
}
}
}
Variables
{"input": DeleteWalletAssignmentByDistributionIdInput}
Response
{
"data": {
"deleteWalletAssignmentByDistributionId": {
"clientMutationId": "abc123",
"walletAssignment": WalletAssignment,
"deletedWalletAssignmentId": 4,
"query": Query,
"distributionByDistributionId": Distribution,
"blockchainAddressByBlockchainAddressId": BlockchainAddress,
"walletAssignmentEdge": WalletAssignmentsEdge
}
}
}
deleteWalletAssignmentById
Description
Deletes a single WalletAssignment using a unique key.
Response
Returns a DeleteWalletAssignmentPayload
Arguments
| Name | Description |
|---|---|
input - DeleteWalletAssignmentByIdInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation deleteWalletAssignmentById($input: DeleteWalletAssignmentByIdInput!) {
deleteWalletAssignmentById(input: $input) {
clientMutationId
walletAssignment {
...WalletAssignmentFragment
}
deletedWalletAssignmentId
query {
...QueryFragment
}
distributionByDistributionId {
...DistributionFragment
}
blockchainAddressByBlockchainAddressId {
...BlockchainAddressFragment
}
walletAssignmentEdge {
...WalletAssignmentsEdgeFragment
}
}
}
Variables
{"input": DeleteWalletAssignmentByIdInput}
Response
{
"data": {
"deleteWalletAssignmentById": {
"clientMutationId": "abc123",
"walletAssignment": WalletAssignment,
"deletedWalletAssignmentId": "4",
"query": Query,
"distributionByDistributionId": Distribution,
"blockchainAddressByBlockchainAddressId": BlockchainAddress,
"walletAssignmentEdge": WalletAssignmentsEdge
}
}
}
deployContract
Response
Returns a DeployContractPayload
Arguments
| Name | Description |
|---|---|
input - DeployContractInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation deployContract($input: DeployContractInput!) {
deployContract(input: $input) {
clientMutationId
contract {
...ContractFragment
}
query {
...QueryFragment
}
tokenByTokenId {
...TokenFragment
}
chainByChain {
...ChainFragment
}
contractStatusByStatus {
...ContractStatusFragment
}
integrationByCustodianId {
...IntegrationFragment
}
integrationByIssuancePlatformId {
...IntegrationFragment
}
contractEdge {
...ContractsEdgeFragment
}
}
}
Variables
{"input": DeployContractInput}
Response
{
"data": {
"deployContract": {
"clientMutationId": "abc123",
"contract": Contract,
"query": Query,
"tokenByTokenId": Token,
"chainByChain": Chain,
"contractStatusByStatus": ContractStatus,
"integrationByCustodianId": Integration,
"integrationByIssuancePlatformId": Integration,
"contractEdge": ContractsEdge
}
}
}
docusignSyncTemplateList
Response
Returns a SigningAccount!
Arguments
| Name | Description |
|---|---|
id - UUID!
|
Example
Query
mutation docusignSyncTemplateList($id: UUID!) {
docusignSyncTemplateList(id: $id) {
nodeId
id
accountId
integrationId
name
syncedOn
accountByAccountId {
...AccountFragment
}
integrationByIntegrationId {
...IntegrationFragment
}
signingTemplatesBySigningAccountId {
...SigningTemplatesConnectionFragment
}
}
}
Variables
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
Response
{
"data": {
"docusignSyncTemplateList": {
"nodeId": 4,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"integrationId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"name": "xyz789",
"syncedOn": Datetime,
"accountByAccountId": Account,
"integrationByIntegrationId": Integration,
"signingTemplatesBySigningAccountId": SigningTemplatesConnection
}
}
}
getAddress
Response
Returns a GetAddressPayload
Arguments
| Name | Description |
|---|---|
input - GetAddressInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation getAddress($input: GetAddressInput!) {
getAddress(input: $input) {
clientMutationId
uuid
query {
...QueryFragment
}
}
}
Variables
{"input": GetAddressInput}
Response
{
"data": {
"getAddress": {
"clientMutationId": "xyz789",
"uuid": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"query": Query
}
}
}
investorMakeDistribution
Response
Returns an InvestorMakeDistributionPayload
Arguments
| Name | Description |
|---|---|
input - InvestorMakeDistributionInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation investorMakeDistribution($input: InvestorMakeDistributionInput!) {
investorMakeDistribution(input: $input) {
clientMutationId
distribution {
...DistributionFragment
}
query {
...QueryFragment
}
allocationByAllocationId {
...AllocationFragment
}
accountByInvestorId {
...AccountFragment
}
distributionStatusByStatus {
...DistributionStatusFragment
}
stepByStepId {
...StepFragment
}
distributionEdge {
...DistributionsEdgeFragment
}
}
}
Variables
{"input": InvestorMakeDistributionInput}
Response
{
"data": {
"investorMakeDistribution": {
"clientMutationId": "xyz789",
"distribution": Distribution,
"query": Query,
"allocationByAllocationId": Allocation,
"accountByInvestorId": Account,
"distributionStatusByStatus": DistributionStatus,
"stepByStepId": Step,
"distributionEdge": DistributionsEdge
}
}
}
issueAllocations
Response
Returns an IssueAllocationsPayload
Arguments
| Name | Description |
|---|---|
input - IssueAllocationsInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation issueAllocations($input: IssueAllocationsInput!) {
issueAllocations(input: $input) {
clientMutationId
allocations {
...AllocationFragment
}
query {
...QueryFragment
}
}
}
Variables
{"input": IssueAllocationsInput}
Response
{
"data": {
"issueAllocations": {
"clientMutationId": "abc123",
"allocations": [Allocation],
"query": Query
}
}
}
issueDistributions
Response
Returns an IssueDistributionsPayload
Arguments
| Name | Description |
|---|---|
input - IssueDistributionsInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation issueDistributions($input: IssueDistributionsInput!) {
issueDistributions(input: $input) {
clientMutationId
issuanceEvents {
...IssuanceEventFragment
}
query {
...QueryFragment
}
}
}
Variables
{"input": IssueDistributionsInput}
Response
{
"data": {
"issueDistributions": {
"clientMutationId": "abc123",
"issuanceEvents": [IssuanceEvent],
"query": Query
}
}
}
makeAllocationOfferingLink
Response
Returns a MakeAllocationOfferingLinkPayload
Arguments
| Name | Description |
|---|---|
input - MakeAllocationOfferingLinkInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation makeAllocationOfferingLink($input: MakeAllocationOfferingLinkInput!) {
makeAllocationOfferingLink(input: $input) {
clientMutationId
allocationOfferingLink {
...AllocationOfferingLinkFragment
}
query {
...QueryFragment
}
allocationByAllocationId {
...AllocationFragment
}
accountByCreatedBy {
...AccountFragment
}
accountByAgentId {
...AccountFragment
}
allocationOfferingLinkEdge {
...AllocationOfferingLinksEdgeFragment
}
}
}
Variables
{"input": MakeAllocationOfferingLinkInput}
Response
{
"data": {
"makeAllocationOfferingLink": {
"clientMutationId": "xyz789",
"allocationOfferingLink": AllocationOfferingLink,
"query": Query,
"allocationByAllocationId": Allocation,
"accountByCreatedBy": Account,
"accountByAgentId": Account,
"allocationOfferingLinkEdge": AllocationOfferingLinksEdge
}
}
}
makeBlockchainAddress
Response
Returns a MakeBlockchainAddressPayload
Arguments
| Name | Description |
|---|---|
input - MakeBlockchainAddressInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation makeBlockchainAddress($input: MakeBlockchainAddressInput!) {
makeBlockchainAddress(input: $input) {
clientMutationId
blockchainAddress {
...BlockchainAddressFragment
}
query {
...QueryFragment
}
chainByChain {
...ChainFragment
}
blockchainAddressEdge {
...BlockchainAddressesEdgeFragment
}
}
}
Variables
{"input": MakeBlockchainAddressInput}
Response
{
"data": {
"makeBlockchainAddress": {
"clientMutationId": "xyz789",
"blockchainAddress": BlockchainAddress,
"query": Query,
"chainByChain": Chain,
"blockchainAddressEdge": BlockchainAddressesEdge
}
}
}
makeCustomer
Response
Returns a MakeCustomerPayload
Arguments
| Name | Description |
|---|---|
input - MakeCustomerInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation makeCustomer($input: MakeCustomerInput!) {
makeCustomer(input: $input) {
clientMutationId
customer {
...CustomerFragment
}
query {
...QueryFragment
}
accountByVendorId {
...AccountFragment
}
accountByInvestorId {
...AccountFragment
}
invitationStatusByStatus {
...InvitationStatusFragment
}
investorAccountTypeByInvestorType {
...InvestorAccountTypeFragment
}
countryByJurisdiction {
...CountryFragment
}
customerEdge {
...CustomersEdgeFragment
}
}
}
Variables
{"input": MakeCustomerInput}
Response
{
"data": {
"makeCustomer": {
"clientMutationId": "abc123",
"customer": Customer,
"query": Query,
"accountByVendorId": Account,
"accountByInvestorId": Account,
"invitationStatusByStatus": InvitationStatus,
"investorAccountTypeByInvestorType": InvestorAccountType,
"countryByJurisdiction": Country,
"customerEdge": CustomersEdge
}
}
}
makeDelegate
Response
Returns a MakeDelegatePayload
Arguments
| Name | Description |
|---|---|
input - MakeDelegateInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation makeDelegate($input: MakeDelegateInput!) {
makeDelegate(input: $input) {
clientMutationId
usersAccount {
...UsersAccountFragment
}
query {
...QueryFragment
}
userByUserId {
...UserFragment
}
accountByAccountId {
...AccountFragment
}
auxRoleByRole {
...AuxRoleFragment
}
userStatusByStatus {
...UserStatusFragment
}
usersAccountEdge {
...UsersAccountsEdgeFragment
}
}
}
Variables
{"input": MakeDelegateInput}
Response
{
"data": {
"makeDelegate": {
"clientMutationId": "xyz789",
"usersAccount": UsersAccount,
"query": Query,
"userByUserId": User,
"accountByAccountId": Account,
"auxRoleByRole": AuxRole,
"userStatusByStatus": UserStatus,
"usersAccountEdge": UsersAccountsEdge
}
}
}
makeDistribution
Response
Returns a MakeDistributionPayload
Arguments
| Name | Description |
|---|---|
input - MakeDistributionInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation makeDistribution($input: MakeDistributionInput!) {
makeDistribution(input: $input) {
clientMutationId
distribution {
...DistributionFragment
}
query {
...QueryFragment
}
allocationByAllocationId {
...AllocationFragment
}
accountByInvestorId {
...AccountFragment
}
distributionStatusByStatus {
...DistributionStatusFragment
}
stepByStepId {
...StepFragment
}
distributionEdge {
...DistributionsEdgeFragment
}
}
}
Variables
{"input": MakeDistributionInput}
Response
{
"data": {
"makeDistribution": {
"clientMutationId": "xyz789",
"distribution": Distribution,
"query": Query,
"allocationByAllocationId": Allocation,
"accountByInvestorId": Account,
"distributionStatusByStatus": DistributionStatus,
"stepByStepId": Step,
"distributionEdge": DistributionsEdge
}
}
}
makeDistributionQualifications
Response
Returns a MakeDistributionQualificationsPayload
Arguments
| Name | Description |
|---|---|
input - MakeDistributionQualificationsInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation makeDistributionQualifications($input: MakeDistributionQualificationsInput!) {
makeDistributionQualifications(input: $input) {
clientMutationId
distributionQualifications {
...DistributionQualificationFragment
}
query {
...QueryFragment
}
}
}
Variables
{"input": MakeDistributionQualificationsInput}
Response
{
"data": {
"makeDistributionQualifications": {
"clientMutationId": "abc123",
"distributionQualifications": [
DistributionQualification
],
"query": Query
}
}
}
makeExternalBlockchainAddress
Response
Returns a MakeExternalBlockchainAddressPayload
Arguments
| Name | Description |
|---|---|
input - MakeExternalBlockchainAddressInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation makeExternalBlockchainAddress($input: MakeExternalBlockchainAddressInput!) {
makeExternalBlockchainAddress(input: $input) {
clientMutationId
blockchainAddress {
...BlockchainAddressFragment
}
query {
...QueryFragment
}
chainByChain {
...ChainFragment
}
blockchainAddressEdge {
...BlockchainAddressesEdgeFragment
}
}
}
Variables
{"input": MakeExternalBlockchainAddressInput}
Response
{
"data": {
"makeExternalBlockchainAddress": {
"clientMutationId": "xyz789",
"blockchainAddress": BlockchainAddress,
"query": Query,
"chainByChain": Chain,
"blockchainAddressEdge": BlockchainAddressesEdge
}
}
}
makeFileLocation
makeHoldingDocument
Response
Returns a HoldingDocumentUpload!
Arguments
| Name | Description |
|---|---|
input - MakeHoldingDocumentInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation makeHoldingDocument($input: MakeHoldingDocumentInput!) {
makeHoldingDocument(input: $input) {
uploadInfo
holdingDocumentId
accountDocumentId
documentId
holdingDocumentByHoldingDocumentId {
...HoldingDocumentFragment
}
accountDocumentByAccountDocumentId {
...AccountDocumentFragment
}
documentByDocumentId {
...DocumentFragment
}
}
}
Variables
{"input": MakeHoldingDocumentInput}
Response
{
"data": {
"makeHoldingDocument": {
"uploadInfo": {},
"holdingDocumentId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountDocumentId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"documentId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"holdingDocumentByHoldingDocumentId": HoldingDocument,
"accountDocumentByAccountDocumentId": AccountDocument,
"documentByDocumentId": Document
}
}
}
makeInvestor
Description
This resolver is usable by ats accounts, and will be moved to a new route along with the ats graphql schema.
Response
Returns a MakeInvestorPayload
Arguments
| Name | Description |
|---|---|
input - MakeInvestorInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation makeInvestor($input: MakeInvestorInput!) {
makeInvestor(input: $input) {
clientMutationId
account {
...AccountFragment
}
query {
...QueryFragment
}
auxAccountByType {
...AuxAccountFragment
}
companyByCompany {
...CompanyFragment
}
countryByJurisdiction {
...CountryFragment
}
investorAccountTypeByInvestorType {
...InvestorAccountTypeFragment
}
accountEdge {
...AccountsEdgeFragment
}
}
}
Variables
{"input": MakeInvestorInput}
Response
{
"data": {
"makeInvestor": {
"clientMutationId": "abc123",
"account": Account,
"query": Query,
"auxAccountByType": AuxAccount,
"companyByCompany": Company,
"countryByJurisdiction": Country,
"investorAccountTypeByInvestorType": InvestorAccountType,
"accountEdge": AccountsEdge
}
}
}
makeIssuerAccount
Response
Returns a MakeIssuerAccountPayload
Arguments
| Name | Description |
|---|---|
input - MakeIssuerAccountInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation makeIssuerAccount($input: MakeIssuerAccountInput!) {
makeIssuerAccount(input: $input) {
clientMutationId
account {
...AccountFragment
}
query {
...QueryFragment
}
auxAccountByType {
...AuxAccountFragment
}
companyByCompany {
...CompanyFragment
}
countryByJurisdiction {
...CountryFragment
}
investorAccountTypeByInvestorType {
...InvestorAccountTypeFragment
}
accountEdge {
...AccountsEdgeFragment
}
}
}
Variables
{"input": MakeIssuerAccountInput}
Response
{
"data": {
"makeIssuerAccount": {
"clientMutationId": "abc123",
"account": Account,
"query": Query,
"auxAccountByType": AuxAccount,
"companyByCompany": Company,
"countryByJurisdiction": Country,
"investorAccountTypeByInvestorType": InvestorAccountType,
"accountEdge": AccountsEdge
}
}
}
makeRealCustomer
Response
Returns a MakeRealCustomerPayload
Arguments
| Name | Description |
|---|---|
input - MakeRealCustomerInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation makeRealCustomer($input: MakeRealCustomerInput!) {
makeRealCustomer(input: $input) {
clientMutationId
customer {
...CustomerFragment
}
query {
...QueryFragment
}
accountByVendorId {
...AccountFragment
}
accountByInvestorId {
...AccountFragment
}
invitationStatusByStatus {
...InvitationStatusFragment
}
investorAccountTypeByInvestorType {
...InvestorAccountTypeFragment
}
countryByJurisdiction {
...CountryFragment
}
customerEdge {
...CustomersEdgeFragment
}
}
}
Variables
{"input": MakeRealCustomerInput}
Response
{
"data": {
"makeRealCustomer": {
"clientMutationId": "abc123",
"customer": Customer,
"query": Query,
"accountByVendorId": Account,
"accountByInvestorId": Account,
"invitationStatusByStatus": InvitationStatus,
"investorAccountTypeByInvestorType": InvestorAccountType,
"countryByJurisdiction": Country,
"customerEdge": CustomersEdge
}
}
}
makeRealDistribution
Response
Returns a MakeRealDistributionPayload
Arguments
| Name | Description |
|---|---|
input - MakeRealDistributionInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation makeRealDistribution($input: MakeRealDistributionInput!) {
makeRealDistribution(input: $input) {
clientMutationId
distribution {
...DistributionFragment
}
query {
...QueryFragment
}
allocationByAllocationId {
...AllocationFragment
}
accountByInvestorId {
...AccountFragment
}
distributionStatusByStatus {
...DistributionStatusFragment
}
stepByStepId {
...StepFragment
}
distributionEdge {
...DistributionsEdgeFragment
}
}
}
Variables
{"input": MakeRealDistributionInput}
Response
{
"data": {
"makeRealDistribution": {
"clientMutationId": "abc123",
"distribution": Distribution,
"query": Query,
"allocationByAllocationId": Allocation,
"accountByInvestorId": Account,
"distributionStatusByStatus": DistributionStatus,
"stepByStepId": Step,
"distributionEdge": DistributionsEdge
}
}
}
makeRound
Response
Returns a MakeRoundPayload
Arguments
| Name | Description |
|---|---|
input - MakeRoundInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation makeRound($input: MakeRoundInput!) {
makeRound(input: $input) {
clientMutationId
round {
...RoundFragment
}
query {
...QueryFragment
}
assetByAssetId {
...AssetFragment
}
tokenByTokenId {
...TokenFragment
}
assetStatusByStatus {
...AssetStatusFragment
}
blockchainAddressByBlockchainAddressId {
...BlockchainAddressFragment
}
securityBySecurityId {
...SecurityFragment
}
roundEdge {
...RoundsEdgeFragment
}
}
}
Variables
{"input": MakeRoundInput}
Response
{
"data": {
"makeRound": {
"clientMutationId": "xyz789",
"round": Round,
"query": Query,
"assetByAssetId": Asset,
"tokenByTokenId": Token,
"assetStatusByStatus": AssetStatus,
"blockchainAddressByBlockchainAddressId": BlockchainAddress,
"securityBySecurityId": Security,
"roundEdge": RoundsEdge
}
}
}
makeSecurityDocument
Response
Returns a SecurityDocumentUpload!
Arguments
| Name | Description |
|---|---|
input - MakeSecurityDocumentInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation makeSecurityDocument($input: MakeSecurityDocumentInput!) {
makeSecurityDocument(input: $input) {
uploadInfo
securityDocumentId
accountDocumentId
documentId
securityDocumentBySecurityDocumentId {
...SecurityDocumentFragment
}
accountDocumentByAccountDocumentId {
...AccountDocumentFragment
}
documentByDocumentId {
...DocumentFragment
}
}
}
Variables
{"input": MakeSecurityDocumentInput}
Response
{
"data": {
"makeSecurityDocument": {
"uploadInfo": {},
"securityDocumentId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountDocumentId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"documentId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"securityDocumentBySecurityDocumentId": SecurityDocument,
"accountDocumentByAccountDocumentId": AccountDocument,
"documentByDocumentId": Document
}
}
}
makeShadowCustomer
Response
Returns a MakeShadowCustomerPayload!
Arguments
| Name | Description |
|---|---|
input - MakeShadowCustomerInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation makeShadowCustomer($input: MakeShadowCustomerInput!) {
makeShadowCustomer(input: $input) {
query {
...QueryFragment
}
customer {
...CustomerFragment
}
clientMutationId
}
}
Variables
{"input": MakeShadowCustomerInput}
Response
{
"data": {
"makeShadowCustomer": {
"query": Query,
"customer": Customer,
"clientMutationId": "abc123"
}
}
}
makeShadowDistribution
Response
Returns a MakeShadowDistributionPayload!
Arguments
| Name | Description |
|---|---|
input - MakeShadowDistributionInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation makeShadowDistribution($input: MakeShadowDistributionInput!) {
makeShadowDistribution(input: $input) {
query {
...QueryFragment
}
distribution {
...DistributionFragment
}
clientMutationId
}
}
Variables
{"input": MakeShadowDistributionInput}
Response
{
"data": {
"makeShadowDistribution": {
"query": Query,
"distribution": Distribution,
"clientMutationId": "abc123"
}
}
}
makeTaRequestDistributionIssuance
Response
Returns a MakeTaRequestDistributionIssuancePayload
Arguments
| Name | Description |
|---|---|
input - MakeTaRequestDistributionIssuanceInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation makeTaRequestDistributionIssuance($input: MakeTaRequestDistributionIssuanceInput!) {
makeTaRequestDistributionIssuance(input: $input) {
clientMutationId
taRequest {
...TaRequestFragment
}
query {
...QueryFragment
}
accountByVendorId {
...AccountFragment
}
accountByInvestorId {
...AccountFragment
}
taRequestTypeByType {
...TaRequestTypeFragment
}
taRequestStatusByStatus {
...TaRequestStatusFragment
}
taRequestBlockchainLocationByFromBlockchainAddressLocation {
...TaRequestBlockchainLocationFragment
}
blockchainAddressByFromBlockchainAddressId {
...BlockchainAddressFragment
}
taRequestBlockchainLocationByToBlockchainAddressLocation {
...TaRequestBlockchainLocationFragment
}
blockchainAddressByToBlockchainAddressId {
...BlockchainAddressFragment
}
accountByCreatorAccountId {
...AccountFragment
}
userByCreatorUserId {
...UserFragment
}
taRequestEdge {
...TaRequestsEdgeFragment
}
}
}
Variables
{"input": MakeTaRequestDistributionIssuanceInput}
Response
{
"data": {
"makeTaRequestDistributionIssuance": {
"clientMutationId": "xyz789",
"taRequest": TaRequest,
"query": Query,
"accountByVendorId": Account,
"accountByInvestorId": Account,
"taRequestTypeByType": TaRequestType,
"taRequestStatusByStatus": TaRequestStatus,
"taRequestBlockchainLocationByFromBlockchainAddressLocation": TaRequestBlockchainLocation,
"blockchainAddressByFromBlockchainAddressId": BlockchainAddress,
"taRequestBlockchainLocationByToBlockchainAddressLocation": TaRequestBlockchainLocation,
"blockchainAddressByToBlockchainAddressId": BlockchainAddress,
"accountByCreatorAccountId": Account,
"userByCreatorUserId": User,
"taRequestEdge": TaRequestsEdge
}
}
}
makeTaRequestDistributionIssuances
Response
Arguments
| Name | Description |
|---|---|
input - MakeTaRequestDistributionIssuancesInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation makeTaRequestDistributionIssuances($input: MakeTaRequestDistributionIssuancesInput!) {
makeTaRequestDistributionIssuances(input: $input) {
clientMutationId
taRequests {
...TaRequestFragment
}
query {
...QueryFragment
}
}
}
Variables
{"input": MakeTaRequestDistributionIssuancesInput}
Response
{
"data": {
"makeTaRequestDistributionIssuances": {
"clientMutationId": "abc123",
"taRequests": [TaRequest],
"query": Query
}
}
}
makeTaRequestIssuance
Response
Returns a MakeTaRequestIssuancePayload
Arguments
| Name | Description |
|---|---|
input - MakeTaRequestIssuanceInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation makeTaRequestIssuance($input: MakeTaRequestIssuanceInput!) {
makeTaRequestIssuance(input: $input) {
clientMutationId
taRequest {
...TaRequestFragment
}
query {
...QueryFragment
}
accountByVendorId {
...AccountFragment
}
accountByInvestorId {
...AccountFragment
}
taRequestTypeByType {
...TaRequestTypeFragment
}
taRequestStatusByStatus {
...TaRequestStatusFragment
}
taRequestBlockchainLocationByFromBlockchainAddressLocation {
...TaRequestBlockchainLocationFragment
}
blockchainAddressByFromBlockchainAddressId {
...BlockchainAddressFragment
}
taRequestBlockchainLocationByToBlockchainAddressLocation {
...TaRequestBlockchainLocationFragment
}
blockchainAddressByToBlockchainAddressId {
...BlockchainAddressFragment
}
accountByCreatorAccountId {
...AccountFragment
}
userByCreatorUserId {
...UserFragment
}
taRequestEdge {
...TaRequestsEdgeFragment
}
}
}
Variables
{"input": MakeTaRequestIssuanceInput}
Response
{
"data": {
"makeTaRequestIssuance": {
"clientMutationId": "abc123",
"taRequest": TaRequest,
"query": Query,
"accountByVendorId": Account,
"accountByInvestorId": Account,
"taRequestTypeByType": TaRequestType,
"taRequestStatusByStatus": TaRequestStatus,
"taRequestBlockchainLocationByFromBlockchainAddressLocation": TaRequestBlockchainLocation,
"blockchainAddressByFromBlockchainAddressId": BlockchainAddress,
"taRequestBlockchainLocationByToBlockchainAddressLocation": TaRequestBlockchainLocation,
"blockchainAddressByToBlockchainAddressId": BlockchainAddress,
"accountByCreatorAccountId": Account,
"userByCreatorUserId": User,
"taRequestEdge": TaRequestsEdge
}
}
}
makeToken
Response
Returns a MakeTokenPayload
Arguments
| Name | Description |
|---|---|
input - MakeTokenInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation makeToken($input: MakeTokenInput!) {
makeToken(input: $input) {
clientMutationId
token {
...TokenFragment
}
query {
...QueryFragment
}
tokenStatusByStatus {
...TokenStatusFragment
}
tokenTypeByType {
...TokenTypeFragment
}
tokenEdge {
...TokensEdgeFragment
}
}
}
Variables
{"input": MakeTokenInput}
Response
{
"data": {
"makeToken": {
"clientMutationId": "abc123",
"token": Token,
"query": Query,
"tokenStatusByStatus": TokenStatus,
"tokenTypeByType": TokenType,
"tokenEdge": TokensEdge
}
}
}
makeTranche
Response
Returns a MakeTranchePayload
Arguments
| Name | Description |
|---|---|
input - MakeTrancheInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation makeTranche($input: MakeTrancheInput!) {
makeTranche(input: $input) {
clientMutationId
round {
...RoundFragment
}
query {
...QueryFragment
}
assetByAssetId {
...AssetFragment
}
tokenByTokenId {
...TokenFragment
}
assetStatusByStatus {
...AssetStatusFragment
}
blockchainAddressByBlockchainAddressId {
...BlockchainAddressFragment
}
securityBySecurityId {
...SecurityFragment
}
roundEdge {
...RoundsEdgeFragment
}
}
}
Variables
{"input": MakeTrancheInput}
Response
{
"data": {
"makeTranche": {
"clientMutationId": "xyz789",
"round": Round,
"query": Query,
"assetByAssetId": Asset,
"tokenByTokenId": Token,
"assetStatusByStatus": AssetStatus,
"blockchainAddressByBlockchainAddressId": BlockchainAddress,
"securityBySecurityId": Security,
"roundEdge": RoundsEdge
}
}
}
northCapitalSync
Response
Returns a PaymentAccount!
Arguments
| Name | Description |
|---|---|
input - UUID!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation northCapitalSync($input: UUID!) {
northCapitalSync(input: $input) {
nodeId
id
integrationId
accountId
syncedOn
integrationByIntegrationId {
...IntegrationFragment
}
accountByAccountId {
...AccountFragment
}
paymentIssuersByPaymentAccountId {
...PaymentIssuersConnectionFragment
}
}
}
Variables
{
"input": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
Response
{
"data": {
"northCapitalSync": {
"nodeId": 4,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"integrationId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"syncedOn": Datetime,
"integrationByIntegrationId": Integration,
"accountByAccountId": Account,
"paymentIssuersByPaymentAccountId": PaymentIssuersConnection
}
}
}
pauseHoldings
Response
Returns a PauseHoldingsPayload
Arguments
| Name | Description |
|---|---|
input - PauseHoldingsInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation pauseHoldings($input: PauseHoldingsInput!) {
pauseHoldings(input: $input) {
clientMutationId
holdings {
...HoldingFragment
}
query {
...QueryFragment
}
}
}
Variables
{"input": PauseHoldingsInput}
Response
{
"data": {
"pauseHoldings": {
"clientMutationId": "abc123",
"holdings": [Holding],
"query": Query
}
}
}
resendClaimedEmail
Response
Returns a String!
Arguments
| Name | Description |
|---|---|
input - ResendClaimEmailInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation resendClaimedEmail($input: ResendClaimEmailInput!) {
resendClaimedEmail(input: $input)
}
Variables
{"input": ResendClaimEmailInput}
Response
{"data": {"resendClaimedEmail": "abc123"}}
resendEmail
Response
Returns a ResendEmailPayload
Arguments
| Name | Description |
|---|---|
input - ResendEmailInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation resendEmail($input: ResendEmailInput!) {
resendEmail(input: $input) {
clientMutationId
query {
...QueryFragment
}
}
}
Variables
{"input": ResendEmailInput}
Response
{
"data": {
"resendEmail": {
"clientMutationId": "xyz789",
"query": Query
}
}
}
resendExpiredClaimEmail
Response
Returns a String!
Arguments
| Name | Description |
|---|---|
input - ResendExpiredClaimEmailInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation resendExpiredClaimEmail($input: ResendExpiredClaimEmailInput!) {
resendExpiredClaimEmail(input: $input)
}
Variables
{"input": ResendExpiredClaimEmailInput}
Response
{
"data": {
"resendExpiredClaimEmail": "xyz789"
}
}
sendClaimAccountEmail
Response
Returns a SendClaimAccountEmailPayload
Arguments
| Name | Description |
|---|---|
input - SendClaimAccountEmailInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation sendClaimAccountEmail($input: SendClaimAccountEmailInput!) {
sendClaimAccountEmail(input: $input) {
clientMutationId
query {
...QueryFragment
}
}
}
Variables
{"input": SendClaimAccountEmailInput}
Response
{
"data": {
"sendClaimAccountEmail": {
"clientMutationId": "abc123",
"query": Query
}
}
}
setupAccount
Response
Returns an Account!
Arguments
| Name | Description |
|---|---|
input - SetupAccountInput
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation setupAccount($input: SetupAccountInput) {
setupAccount(input: $input) {
nodeId
type
company
name
jurisdiction
email
url
slug
twitterHandle
supportEmail
newId
setup
entity
oldId
id
createdOn
investorType
formationDate
externalEmail
useReal
auxAccountByType {
...AuxAccountFragment
}
companyByCompany {
...CompanyFragment
}
countryByJurisdiction {
...CountryFragment
}
investorAccountTypeByInvestorType {
...InvestorAccountTypeFragment
}
customersByVendorId {
...CustomersConnectionFragment
}
customersByInvestorId {
...CustomersConnectionFragment
}
usersAccountsByAccountId {
...UsersAccountsConnectionFragment
}
accountsBlockchainAddressesByAccountId {
...AccountsBlockchainAddressesConnectionFragment
}
blockchainRegistrationsByAccountId {
...BlockchainRegistrationsConnectionFragment
}
assetsByIssuerId {
...AssetsConnectionFragment
}
assetArchivesByAccountId {
...AssetArchivesConnectionFragment
}
allocationsByOwnerId {
...AllocationsConnectionFragment
}
allocationsByIssuerId {
...AllocationsConnectionFragment
}
allocationArchivesByAccountId {
...AllocationArchivesConnectionFragment
}
brokerAllocationsByBrokerId {
...BrokerAllocationsConnectionFragment
}
distributionsByInvestorId {
...DistributionsConnectionFragment
}
transactionsByBrokerId {
...TransactionsConnectionFragment
}
ledgersByInvestorId {
...LedgersConnectionFragment
}
distributionAnnotationsByAccountId {
...DistributionAnnotationsConnectionFragment
}
assetAnnotationsByAccountId {
...AssetAnnotationsConnectionFragment
}
allocationAnnotationsByAccountId {
...AllocationAnnotationsConnectionFragment
}
transactionAnnotationsByAccountId {
...TransactionAnnotationsConnectionFragment
}
managedAccountsByManagerId {
...ManagedAccountsConnectionFragment
}
managedAccountsByEntityId {
...ManagedAccountsConnectionFragment
}
accountIntegrationsByAccountId {
...AccountIntegrationsConnectionFragment
}
vendorQualificationsByAccountId {
...VendorQualificationsConnectionFragment
}
stepsByOwnedBy {
...StepsConnectionFragment
}
stepsByExecuteBy {
...StepsConnectionFragment
}
distributionCustomFieldsByCreatedBy {
...DistributionCustomFieldsConnectionFragment
}
signingAccountsByAccountId {
...SigningAccountsConnectionFragment
}
signingTemplatesByAccountId {
...SigningTemplatesConnectionFragment
}
mappedSigningTemplatesByAccountId {
...MappedSigningTemplatesConnectionFragment
}
sentSigningDocumentsBySentTo {
...SentSigningDocumentsConnectionFragment
}
allocationOfferingLinksByCreatedBy {
...AllocationOfferingLinksConnectionFragment
}
allocationOfferingLinksByAgentId {
...AllocationOfferingLinksConnectionFragment
}
accountPhoneNumbersByAccountId {
...AccountPhoneNumbersConnectionFragment
}
accountRegDStatusByAccountId {
...AccountRegDStatusFragment
}
accountRegDStatusesByAccountId {
...AccountRegDStatusesConnectionFragment
}
accountTaxInformationsByAccountId {
...AccountTaxInformationsConnectionFragment
}
onboardingQuestionSetsByAccountId {
...OnboardingQuestionSetsConnectionFragment
}
onboardingQuestionsByAccountId {
...OnboardingQuestionsConnectionFragment
}
instancedAccountInformationsByAccountId {
...InstancedAccountInformationsConnectionFragment
}
instancedAccountInformationsByVendorAccountId {
...InstancedAccountInformationsConnectionFragment
}
instancedMappingFieldsByAccountId {
...InstancedMappingFieldsConnectionFragment
}
vendorDefaultEmailPreferenceByAccountId {
...VendorDefaultEmailPreferenceFragment
}
vendorDefaultEmailPreferencesByAccountId {
...VendorDefaultEmailPreferencesConnectionFragment
}
allocationEmailPreferencesByAccountId {
...AllocationEmailPreferencesConnectionFragment
}
securitiesByIssuerId {
...SecuritiesConnectionFragment
}
securitiesByTaId {
...SecuritiesConnectionFragment
}
holdingsByInvestorId {
...HoldingsConnectionFragment
}
issuanceEventsByInvestorId {
...IssuanceEventsConnectionFragment
}
issuanceEventsByIssuerId {
...IssuanceEventsConnectionFragment
}
vendorAgentsByAgentId {
...VendorAgentsConnectionFragment
}
vendorAgentsByVendorId {
...VendorAgentsConnectionFragment
}
securityListingsByIssuerId {
...SecurityListingsConnectionFragment
}
securityListingsByAtsId {
...SecurityListingsConnectionFragment
}
documentsByUploadedBy {
...DocumentsConnectionFragment
}
accountDocumentsByFromAccountId {
...AccountDocumentsConnectionFragment
}
accountDocumentsByToAccountId {
...AccountDocumentsConnectionFragment
}
documentSharingsByUploaderId {
...DocumentSharingsConnectionFragment
}
accountRestrictionsByAccountId {
...AccountRestrictionsConnectionFragment
}
accountRestrictionsByCreatorAccountId {
...AccountRestrictionsConnectionFragment
}
paymentAccountsByAccountId {
...PaymentAccountsConnectionFragment
}
paymentMethodsByAccountId {
...PaymentMethodsConnectionFragment
}
paymentIssuersByIssuerId {
...PaymentIssuersConnectionFragment
}
paymentIssuersByAccountId {
...PaymentIssuersConnectionFragment
}
omnibusHoldingsByAccountId {
...OmnibusHoldingsConnectionFragment
}
omnibusInvestorsByInvestorId {
...OmnibusInvestorsConnectionFragment
}
omnibusInvestorsByAccountId {
...OmnibusInvestorsConnectionFragment
}
webhookConfigurationsByAccountId {
...WebhookConfigurationsConnectionFragment
}
customerPartiesByCreatorAccountId {
...CustomerPartiesConnectionFragment
}
customerAddressesByCreatorAccountId {
...CustomerAddressesConnectionFragment
}
customerPartyAddressesByCreatorAccountId {
...CustomerPartyAddressesConnectionFragment
}
blockchainAddressSourcesByVendorId {
...BlockchainAddressSourcesConnectionFragment
}
blockchainAddressSourcesByInvestorId {
...BlockchainAddressSourcesConnectionFragment
}
blockchainAddressSourcesByCreatorAccountId {
...BlockchainAddressSourcesConnectionFragment
}
taRequestsByVendorId {
...TaRequestsConnectionFragment
}
taRequestsByInvestorId {
...TaRequestsConnectionFragment
}
taRequestsByCreatorAccountId {
...TaRequestsConnectionFragment
}
accountAddressesByAccountId {
...AccountAddressesConnectionFragment
}
atsTagsByAccountId {
...AtsTagsConnectionFragment
}
idempotentsByAtsId {
...IdempotentsConnectionFragment
}
partiesByAccountId {
...PartiesConnectionFragment
}
partyAddressesByAccountId {
...PartyAddressesConnectionFragment
}
requestsByAccountId {
...RequestsConnectionFragment
}
stagedBalanceTransfersByToAccountId {
...StagedBalanceTransfersConnectionFragment
}
stagedBalanceTransfersByFromAccountId {
...StagedBalanceTransfersConnectionFragment
}
stagedTransfersByAccountId {
...StagedTransfersConnectionFragment
}
tradesByAtsId {
...TradesConnectionFragment
}
tradesByFromAccountId {
...TradesConnectionFragment
}
tradesByToAccountId {
...TradesConnectionFragment
}
transfersByAtsId {
...TransfersConnectionFragment
}
transfersByFromAccountId {
...TransfersConnectionFragment
}
transfersByToAccountId {
...TransfersConnectionFragment
}
contactName
holdings
taxShort
}
}
Variables
{"input": SetupAccountInput}
Response
{
"data": {
"setupAccount": {
"nodeId": "4",
"type": "xyz789",
"company": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"name": "abc123",
"jurisdiction": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"email": "abc123",
"url": "xyz789",
"slug": "abc123",
"twitterHandle": "xyz789",
"supportEmail": "xyz789",
"newId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"setup": true,
"entity": false,
"oldId": 123,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"createdOn": Datetime,
"investorType": "abc123",
"formationDate": "2007-12-03",
"externalEmail": "xyz789",
"useReal": true,
"auxAccountByType": AuxAccount,
"companyByCompany": Company,
"countryByJurisdiction": Country,
"investorAccountTypeByInvestorType": InvestorAccountType,
"customersByVendorId": CustomersConnection,
"customersByInvestorId": CustomersConnection,
"usersAccountsByAccountId": UsersAccountsConnection,
"accountsBlockchainAddressesByAccountId": AccountsBlockchainAddressesConnection,
"blockchainRegistrationsByAccountId": BlockchainRegistrationsConnection,
"assetsByIssuerId": AssetsConnection,
"assetArchivesByAccountId": AssetArchivesConnection,
"allocationsByOwnerId": AllocationsConnection,
"allocationsByIssuerId": AllocationsConnection,
"allocationArchivesByAccountId": AllocationArchivesConnection,
"brokerAllocationsByBrokerId": BrokerAllocationsConnection,
"distributionsByInvestorId": DistributionsConnection,
"transactionsByBrokerId": TransactionsConnection,
"ledgersByInvestorId": LedgersConnection,
"distributionAnnotationsByAccountId": DistributionAnnotationsConnection,
"assetAnnotationsByAccountId": AssetAnnotationsConnection,
"allocationAnnotationsByAccountId": AllocationAnnotationsConnection,
"transactionAnnotationsByAccountId": TransactionAnnotationsConnection,
"managedAccountsByManagerId": ManagedAccountsConnection,
"managedAccountsByEntityId": ManagedAccountsConnection,
"accountIntegrationsByAccountId": AccountIntegrationsConnection,
"vendorQualificationsByAccountId": VendorQualificationsConnection,
"stepsByOwnedBy": StepsConnection,
"stepsByExecuteBy": StepsConnection,
"distributionCustomFieldsByCreatedBy": DistributionCustomFieldsConnection,
"signingAccountsByAccountId": SigningAccountsConnection,
"signingTemplatesByAccountId": SigningTemplatesConnection,
"mappedSigningTemplatesByAccountId": MappedSigningTemplatesConnection,
"sentSigningDocumentsBySentTo": SentSigningDocumentsConnection,
"allocationOfferingLinksByCreatedBy": AllocationOfferingLinksConnection,
"allocationOfferingLinksByAgentId": AllocationOfferingLinksConnection,
"accountPhoneNumbersByAccountId": AccountPhoneNumbersConnection,
"accountRegDStatusByAccountId": AccountRegDStatus,
"accountRegDStatusesByAccountId": AccountRegDStatusesConnection,
"accountTaxInformationsByAccountId": AccountTaxInformationsConnection,
"onboardingQuestionSetsByAccountId": OnboardingQuestionSetsConnection,
"onboardingQuestionsByAccountId": OnboardingQuestionsConnection,
"instancedAccountInformationsByAccountId": InstancedAccountInformationsConnection,
"instancedAccountInformationsByVendorAccountId": InstancedAccountInformationsConnection,
"instancedMappingFieldsByAccountId": InstancedMappingFieldsConnection,
"vendorDefaultEmailPreferenceByAccountId": VendorDefaultEmailPreference,
"vendorDefaultEmailPreferencesByAccountId": VendorDefaultEmailPreferencesConnection,
"allocationEmailPreferencesByAccountId": AllocationEmailPreferencesConnection,
"securitiesByIssuerId": SecuritiesConnection,
"securitiesByTaId": SecuritiesConnection,
"holdingsByInvestorId": HoldingsConnection,
"issuanceEventsByInvestorId": IssuanceEventsConnection,
"issuanceEventsByIssuerId": IssuanceEventsConnection,
"vendorAgentsByAgentId": VendorAgentsConnection,
"vendorAgentsByVendorId": VendorAgentsConnection,
"securityListingsByIssuerId": SecurityListingsConnection,
"securityListingsByAtsId": SecurityListingsConnection,
"documentsByUploadedBy": DocumentsConnection,
"accountDocumentsByFromAccountId": AccountDocumentsConnection,
"accountDocumentsByToAccountId": AccountDocumentsConnection,
"documentSharingsByUploaderId": DocumentSharingsConnection,
"accountRestrictionsByAccountId": AccountRestrictionsConnection,
"accountRestrictionsByCreatorAccountId": AccountRestrictionsConnection,
"paymentAccountsByAccountId": PaymentAccountsConnection,
"paymentMethodsByAccountId": PaymentMethodsConnection,
"paymentIssuersByIssuerId": PaymentIssuersConnection,
"paymentIssuersByAccountId": PaymentIssuersConnection,
"omnibusHoldingsByAccountId": OmnibusHoldingsConnection,
"omnibusInvestorsByInvestorId": OmnibusInvestorsConnection,
"omnibusInvestorsByAccountId": OmnibusInvestorsConnection,
"webhookConfigurationsByAccountId": WebhookConfigurationsConnection,
"customerPartiesByCreatorAccountId": CustomerPartiesConnection,
"customerAddressesByCreatorAccountId": CustomerAddressesConnection,
"customerPartyAddressesByCreatorAccountId": CustomerPartyAddressesConnection,
"blockchainAddressSourcesByVendorId": BlockchainAddressSourcesConnection,
"blockchainAddressSourcesByInvestorId": BlockchainAddressSourcesConnection,
"blockchainAddressSourcesByCreatorAccountId": BlockchainAddressSourcesConnection,
"taRequestsByVendorId": TaRequestsConnection,
"taRequestsByInvestorId": TaRequestsConnection,
"taRequestsByCreatorAccountId": TaRequestsConnection,
"accountAddressesByAccountId": AccountAddressesConnection,
"atsTagsByAccountId": AtsTagsConnection,
"idempotentsByAtsId": IdempotentsConnection,
"partiesByAccountId": PartiesConnection,
"partyAddressesByAccountId": PartyAddressesConnection,
"requestsByAccountId": RequestsConnection,
"stagedBalanceTransfersByToAccountId": StagedBalanceTransfersConnection,
"stagedBalanceTransfersByFromAccountId": StagedBalanceTransfersConnection,
"stagedTransfersByAccountId": StagedTransfersConnection,
"tradesByAtsId": TradesConnection,
"tradesByFromAccountId": TradesConnection,
"tradesByToAccountId": TradesConnection,
"transfersByAtsId": TransfersConnection,
"transfersByFromAccountId": TransfersConnection,
"transfersByToAccountId": TransfersConnection,
"contactName": "abc123",
"holdings": BigFloat,
"taxShort": "abc123"
}
}
}
setupCustomer
Response
Returns a SetupCustomerPayload!
Arguments
| Name | Description |
|---|---|
input - SetupCustomerInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation setupCustomer($input: SetupCustomerInput!) {
setupCustomer(input: $input) {
query {
...QueryFragment
}
customer {
...CustomerFragment
}
clientMutationId
}
}
Variables
{"input": SetupCustomerInput}
Response
{
"data": {
"setupCustomer": {
"query": Query,
"customer": Customer,
"clientMutationId": "xyz789"
}
}
}
tokenizeHoldings
Response
Returns a TokenizeHoldingsPayload
Arguments
| Name | Description |
|---|---|
input - TokenizeHoldingsInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation tokenizeHoldings($input: TokenizeHoldingsInput!) {
tokenizeHoldings(input: $input) {
clientMutationId
holdings {
...HoldingFragment
}
query {
...QueryFragment
}
}
}
Variables
{"input": TokenizeHoldingsInput}
Response
{
"data": {
"tokenizeHoldings": {
"clientMutationId": "xyz789",
"holdings": [Holding],
"query": Query
}
}
}
transferOwnership
Response
Returns a TransferOwnershipPayload
Arguments
| Name | Description |
|---|---|
input - TransferOwnershipInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation transferOwnership($input: TransferOwnershipInput!) {
transferOwnership(input: $input) {
clientMutationId
usersAccounts {
...UsersAccountFragment
}
query {
...QueryFragment
}
}
}
Variables
{"input": TransferOwnershipInput}
Response
{
"data": {
"transferOwnership": {
"clientMutationId": "xyz789",
"usersAccounts": [UsersAccount],
"query": Query
}
}
}
unpauseHoldings
Response
Returns an UnpauseHoldingsPayload
Arguments
| Name | Description |
|---|---|
input - UnpauseHoldingsInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation unpauseHoldings($input: UnpauseHoldingsInput!) {
unpauseHoldings(input: $input) {
clientMutationId
holdings {
...HoldingFragment
}
query {
...QueryFragment
}
}
}
Variables
{"input": UnpauseHoldingsInput}
Response
{
"data": {
"unpauseHoldings": {
"clientMutationId": "abc123",
"holdings": [Holding],
"query": Query
}
}
}
updateAccount
Description
Updates a single Account using its globally unique id and a patch.
Response
Returns an UpdateAccountPayload
Arguments
| Name | Description |
|---|---|
input - UpdateAccountInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation updateAccount($input: UpdateAccountInput!) {
updateAccount(input: $input) {
clientMutationId
account {
...AccountFragment
}
query {
...QueryFragment
}
auxAccountByType {
...AuxAccountFragment
}
companyByCompany {
...CompanyFragment
}
countryByJurisdiction {
...CountryFragment
}
investorAccountTypeByInvestorType {
...InvestorAccountTypeFragment
}
accountEdge {
...AccountsEdgeFragment
}
}
}
Variables
{"input": UpdateAccountInput}
Response
{
"data": {
"updateAccount": {
"clientMutationId": "xyz789",
"account": Account,
"query": Query,
"auxAccountByType": AuxAccount,
"companyByCompany": Company,
"countryByJurisdiction": Country,
"investorAccountTypeByInvestorType": InvestorAccountType,
"accountEdge": AccountsEdge
}
}
}
updateAccountById
Description
Updates a single Account using a unique key and a patch.
Response
Returns an UpdateAccountPayload
Arguments
| Name | Description |
|---|---|
input - UpdateAccountByIdInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation updateAccountById($input: UpdateAccountByIdInput!) {
updateAccountById(input: $input) {
clientMutationId
account {
...AccountFragment
}
query {
...QueryFragment
}
auxAccountByType {
...AuxAccountFragment
}
companyByCompany {
...CompanyFragment
}
countryByJurisdiction {
...CountryFragment
}
investorAccountTypeByInvestorType {
...InvestorAccountTypeFragment
}
accountEdge {
...AccountsEdgeFragment
}
}
}
Variables
{"input": UpdateAccountByIdInput}
Response
{
"data": {
"updateAccountById": {
"clientMutationId": "xyz789",
"account": Account,
"query": Query,
"auxAccountByType": AuxAccount,
"companyByCompany": Company,
"countryByJurisdiction": Country,
"investorAccountTypeByInvestorType": InvestorAccountType,
"accountEdge": AccountsEdge
}
}
}
updateAccountBySupportEmail
Description
Updates a single Account using a unique key and a patch.
Response
Returns an UpdateAccountPayload
Arguments
| Name | Description |
|---|---|
input - UpdateAccountBySupportEmailInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation updateAccountBySupportEmail($input: UpdateAccountBySupportEmailInput!) {
updateAccountBySupportEmail(input: $input) {
clientMutationId
account {
...AccountFragment
}
query {
...QueryFragment
}
auxAccountByType {
...AuxAccountFragment
}
companyByCompany {
...CompanyFragment
}
countryByJurisdiction {
...CountryFragment
}
investorAccountTypeByInvestorType {
...InvestorAccountTypeFragment
}
accountEdge {
...AccountsEdgeFragment
}
}
}
Variables
{"input": UpdateAccountBySupportEmailInput}
Response
{
"data": {
"updateAccountBySupportEmail": {
"clientMutationId": "xyz789",
"account": Account,
"query": Query,
"auxAccountByType": AuxAccount,
"companyByCompany": Company,
"countryByJurisdiction": Country,
"investorAccountTypeByInvestorType": InvestorAccountType,
"accountEdge": AccountsEdge
}
}
}
updateAccountByTypeAndEmail
Description
Updates a single Account using a unique key and a patch.
Response
Returns an UpdateAccountPayload
Arguments
| Name | Description |
|---|---|
input - UpdateAccountByTypeAndEmailInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation updateAccountByTypeAndEmail($input: UpdateAccountByTypeAndEmailInput!) {
updateAccountByTypeAndEmail(input: $input) {
clientMutationId
account {
...AccountFragment
}
query {
...QueryFragment
}
auxAccountByType {
...AuxAccountFragment
}
companyByCompany {
...CompanyFragment
}
countryByJurisdiction {
...CountryFragment
}
investorAccountTypeByInvestorType {
...InvestorAccountTypeFragment
}
accountEdge {
...AccountsEdgeFragment
}
}
}
Variables
{"input": UpdateAccountByTypeAndEmailInput}
Response
{
"data": {
"updateAccountByTypeAndEmail": {
"clientMutationId": "abc123",
"account": Account,
"query": Query,
"auxAccountByType": AuxAccount,
"companyByCompany": Company,
"countryByJurisdiction": Country,
"investorAccountTypeByInvestorType": InvestorAccountType,
"accountEdge": AccountsEdge
}
}
}
updateAccountPhoneNumber
Description
Updates a single AccountPhoneNumber using its globally unique id and a patch.
Response
Returns an UpdateAccountPhoneNumberPayload
Arguments
| Name | Description |
|---|---|
input - UpdateAccountPhoneNumberInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation updateAccountPhoneNumber($input: UpdateAccountPhoneNumberInput!) {
updateAccountPhoneNumber(input: $input) {
clientMutationId
accountPhoneNumber {
...AccountPhoneNumberFragment
}
query {
...QueryFragment
}
accountByAccountId {
...AccountFragment
}
phoneNumberTypeByType {
...PhoneNumberTypeFragment
}
accountPhoneNumberEdge {
...AccountPhoneNumbersEdgeFragment
}
}
}
Variables
{"input": UpdateAccountPhoneNumberInput}
Response
{
"data": {
"updateAccountPhoneNumber": {
"clientMutationId": "xyz789",
"accountPhoneNumber": AccountPhoneNumber,
"query": Query,
"accountByAccountId": Account,
"phoneNumberTypeByType": PhoneNumberType,
"accountPhoneNumberEdge": AccountPhoneNumbersEdge
}
}
}
updateAccountPhoneNumberByAccountIdAndType
Description
Updates a single AccountPhoneNumber using a unique key and a patch.
Response
Returns an UpdateAccountPhoneNumberPayload
Arguments
| Name | Description |
|---|---|
input - UpdateAccountPhoneNumberByAccountIdAndTypeInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation updateAccountPhoneNumberByAccountIdAndType($input: UpdateAccountPhoneNumberByAccountIdAndTypeInput!) {
updateAccountPhoneNumberByAccountIdAndType(input: $input) {
clientMutationId
accountPhoneNumber {
...AccountPhoneNumberFragment
}
query {
...QueryFragment
}
accountByAccountId {
...AccountFragment
}
phoneNumberTypeByType {
...PhoneNumberTypeFragment
}
accountPhoneNumberEdge {
...AccountPhoneNumbersEdgeFragment
}
}
}
Variables
{"input": UpdateAccountPhoneNumberByAccountIdAndTypeInput}
Response
{
"data": {
"updateAccountPhoneNumberByAccountIdAndType": {
"clientMutationId": "abc123",
"accountPhoneNumber": AccountPhoneNumber,
"query": Query,
"accountByAccountId": Account,
"phoneNumberTypeByType": PhoneNumberType,
"accountPhoneNumberEdge": AccountPhoneNumbersEdge
}
}
}
updateAccountPhoneNumberById
Description
Updates a single AccountPhoneNumber using a unique key and a patch.
Response
Returns an UpdateAccountPhoneNumberPayload
Arguments
| Name | Description |
|---|---|
input - UpdateAccountPhoneNumberByIdInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation updateAccountPhoneNumberById($input: UpdateAccountPhoneNumberByIdInput!) {
updateAccountPhoneNumberById(input: $input) {
clientMutationId
accountPhoneNumber {
...AccountPhoneNumberFragment
}
query {
...QueryFragment
}
accountByAccountId {
...AccountFragment
}
phoneNumberTypeByType {
...PhoneNumberTypeFragment
}
accountPhoneNumberEdge {
...AccountPhoneNumbersEdgeFragment
}
}
}
Variables
{"input": UpdateAccountPhoneNumberByIdInput}
Response
{
"data": {
"updateAccountPhoneNumberById": {
"clientMutationId": "xyz789",
"accountPhoneNumber": AccountPhoneNumber,
"query": Query,
"accountByAccountId": Account,
"phoneNumberTypeByType": PhoneNumberType,
"accountPhoneNumberEdge": AccountPhoneNumbersEdge
}
}
}
updateAccountRegDStatus
Description
Updates a single AccountRegDStatus using its globally unique id and a patch.
Response
Returns an UpdateAccountRegDStatusPayload
Arguments
| Name | Description |
|---|---|
input - UpdateAccountRegDStatusInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation updateAccountRegDStatus($input: UpdateAccountRegDStatusInput!) {
updateAccountRegDStatus(input: $input) {
clientMutationId
accountRegDStatus {
...AccountRegDStatusFragment
}
query {
...QueryFragment
}
accountByAccountId {
...AccountFragment
}
accountRegDStatusEdge {
...AccountRegDStatusesEdgeFragment
}
}
}
Variables
{"input": UpdateAccountRegDStatusInput}
Response
{
"data": {
"updateAccountRegDStatus": {
"clientMutationId": "abc123",
"accountRegDStatus": AccountRegDStatus,
"query": Query,
"accountByAccountId": Account,
"accountRegDStatusEdge": AccountRegDStatusesEdge
}
}
}
updateAccountRegDStatusByAccountId
Description
Updates a single AccountRegDStatus using a unique key and a patch.
Response
Returns an UpdateAccountRegDStatusPayload
Arguments
| Name | Description |
|---|---|
input - UpdateAccountRegDStatusByAccountIdInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation updateAccountRegDStatusByAccountId($input: UpdateAccountRegDStatusByAccountIdInput!) {
updateAccountRegDStatusByAccountId(input: $input) {
clientMutationId
accountRegDStatus {
...AccountRegDStatusFragment
}
query {
...QueryFragment
}
accountByAccountId {
...AccountFragment
}
accountRegDStatusEdge {
...AccountRegDStatusesEdgeFragment
}
}
}
Variables
{"input": UpdateAccountRegDStatusByAccountIdInput}
Response
{
"data": {
"updateAccountRegDStatusByAccountId": {
"clientMutationId": "xyz789",
"accountRegDStatus": AccountRegDStatus,
"query": Query,
"accountByAccountId": Account,
"accountRegDStatusEdge": AccountRegDStatusesEdge
}
}
}
updateAccountRegDStatusById
Description
Updates a single AccountRegDStatus using a unique key and a patch.
Response
Returns an UpdateAccountRegDStatusPayload
Arguments
| Name | Description |
|---|---|
input - UpdateAccountRegDStatusByIdInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation updateAccountRegDStatusById($input: UpdateAccountRegDStatusByIdInput!) {
updateAccountRegDStatusById(input: $input) {
clientMutationId
accountRegDStatus {
...AccountRegDStatusFragment
}
query {
...QueryFragment
}
accountByAccountId {
...AccountFragment
}
accountRegDStatusEdge {
...AccountRegDStatusesEdgeFragment
}
}
}
Variables
{"input": UpdateAccountRegDStatusByIdInput}
Response
{
"data": {
"updateAccountRegDStatusById": {
"clientMutationId": "xyz789",
"accountRegDStatus": AccountRegDStatus,
"query": Query,
"accountByAccountId": Account,
"accountRegDStatusEdge": AccountRegDStatusesEdge
}
}
}
updateAccountRestriction
Description
Updates a single AccountRestriction using its globally unique id and a patch.
Response
Returns an UpdateAccountRestrictionPayload
Arguments
| Name | Description |
|---|---|
input - UpdateAccountRestrictionInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation updateAccountRestriction($input: UpdateAccountRestrictionInput!) {
updateAccountRestriction(input: $input) {
clientMutationId
accountRestriction {
...AccountRestrictionFragment
}
query {
...QueryFragment
}
accountByAccountId {
...AccountFragment
}
restrictionReasonByReasonId {
...RestrictionReasonFragment
}
userByCreatorUserId {
...UserFragment
}
accountByCreatorAccountId {
...AccountFragment
}
accountRestrictionEdge {
...AccountRestrictionsEdgeFragment
}
}
}
Variables
{"input": UpdateAccountRestrictionInput}
Response
{
"data": {
"updateAccountRestriction": {
"clientMutationId": "xyz789",
"accountRestriction": AccountRestriction,
"query": Query,
"accountByAccountId": Account,
"restrictionReasonByReasonId": RestrictionReason,
"userByCreatorUserId": User,
"accountByCreatorAccountId": Account,
"accountRestrictionEdge": AccountRestrictionsEdge
}
}
}
updateAccountRestrictionByAccountIdAndReasonId
Description
Updates a single AccountRestriction using a unique key and a patch.
Response
Returns an UpdateAccountRestrictionPayload
Arguments
| Name | Description |
|---|---|
input - UpdateAccountRestrictionByAccountIdAndReasonIdInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation updateAccountRestrictionByAccountIdAndReasonId($input: UpdateAccountRestrictionByAccountIdAndReasonIdInput!) {
updateAccountRestrictionByAccountIdAndReasonId(input: $input) {
clientMutationId
accountRestriction {
...AccountRestrictionFragment
}
query {
...QueryFragment
}
accountByAccountId {
...AccountFragment
}
restrictionReasonByReasonId {
...RestrictionReasonFragment
}
userByCreatorUserId {
...UserFragment
}
accountByCreatorAccountId {
...AccountFragment
}
accountRestrictionEdge {
...AccountRestrictionsEdgeFragment
}
}
}
Variables
{
"input": UpdateAccountRestrictionByAccountIdAndReasonIdInput
}
Response
{
"data": {
"updateAccountRestrictionByAccountIdAndReasonId": {
"clientMutationId": "abc123",
"accountRestriction": AccountRestriction,
"query": Query,
"accountByAccountId": Account,
"restrictionReasonByReasonId": RestrictionReason,
"userByCreatorUserId": User,
"accountByCreatorAccountId": Account,
"accountRestrictionEdge": AccountRestrictionsEdge
}
}
}
updateAccountRestrictionById
Description
Updates a single AccountRestriction using a unique key and a patch.
Response
Returns an UpdateAccountRestrictionPayload
Arguments
| Name | Description |
|---|---|
input - UpdateAccountRestrictionByIdInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation updateAccountRestrictionById($input: UpdateAccountRestrictionByIdInput!) {
updateAccountRestrictionById(input: $input) {
clientMutationId
accountRestriction {
...AccountRestrictionFragment
}
query {
...QueryFragment
}
accountByAccountId {
...AccountFragment
}
restrictionReasonByReasonId {
...RestrictionReasonFragment
}
userByCreatorUserId {
...UserFragment
}
accountByCreatorAccountId {
...AccountFragment
}
accountRestrictionEdge {
...AccountRestrictionsEdgeFragment
}
}
}
Variables
{"input": UpdateAccountRestrictionByIdInput}
Response
{
"data": {
"updateAccountRestrictionById": {
"clientMutationId": "abc123",
"accountRestriction": AccountRestriction,
"query": Query,
"accountByAccountId": Account,
"restrictionReasonByReasonId": RestrictionReason,
"userByCreatorUserId": User,
"accountByCreatorAccountId": Account,
"accountRestrictionEdge": AccountRestrictionsEdge
}
}
}
updateAddress
Description
Updates a single Address using its globally unique id and a patch.
Response
Returns an UpdateAddressPayload
Arguments
| Name | Description |
|---|---|
input - UpdateAddressInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation updateAddress($input: UpdateAddressInput!) {
updateAddress(input: $input) {
clientMutationId
address {
...AddressFragment
}
query {
...QueryFragment
}
countryByCountry {
...CountryFragment
}
addressEdge {
...AddressesEdgeFragment
}
}
}
Variables
{"input": UpdateAddressInput}
Response
{
"data": {
"updateAddress": {
"clientMutationId": "abc123",
"address": Address,
"query": Query,
"countryByCountry": Country,
"addressEdge": AddressesEdge
}
}
}
updateAddressById
Description
Updates a single Address using a unique key and a patch.
Response
Returns an UpdateAddressPayload
Arguments
| Name | Description |
|---|---|
input - UpdateAddressByIdInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation updateAddressById($input: UpdateAddressByIdInput!) {
updateAddressById(input: $input) {
clientMutationId
address {
...AddressFragment
}
query {
...QueryFragment
}
countryByCountry {
...CountryFragment
}
addressEdge {
...AddressesEdgeFragment
}
}
}
Variables
{"input": UpdateAddressByIdInput}
Response
{
"data": {
"updateAddressById": {
"clientMutationId": "abc123",
"address": Address,
"query": Query,
"countryByCountry": Country,
"addressEdge": AddressesEdge
}
}
}
updateAllocation
Description
Updates a single Allocation using its globally unique id and a patch.
Response
Returns an UpdateAllocationPayload
Arguments
| Name | Description |
|---|---|
input - UpdateAllocationInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation updateAllocation($input: UpdateAllocationInput!) {
updateAllocation(input: $input) {
clientMutationId
allocation {
...AllocationFragment
}
query {
...QueryFragment
}
accountByOwnerId {
...AccountFragment
}
blockchainAddressByBlockchainAddressId {
...BlockchainAddressFragment
}
accountByIssuerId {
...AccountFragment
}
assetStatusByStatus {
...AssetStatusFragment
}
roundByRoundId {
...RoundFragment
}
allocationEdge {
...AllocationsEdgeFragment
}
}
}
Variables
{"input": UpdateAllocationInput}
Response
{
"data": {
"updateAllocation": {
"clientMutationId": "abc123",
"allocation": Allocation,
"query": Query,
"accountByOwnerId": Account,
"blockchainAddressByBlockchainAddressId": BlockchainAddress,
"accountByIssuerId": Account,
"assetStatusByStatus": AssetStatus,
"roundByRoundId": Round,
"allocationEdge": AllocationsEdge
}
}
}
updateAllocationAnnotation
Description
Updates a single AllocationAnnotation using its globally unique id and a patch.
Response
Returns an UpdateAllocationAnnotationPayload
Arguments
| Name | Description |
|---|---|
input - UpdateAllocationAnnotationInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation updateAllocationAnnotation($input: UpdateAllocationAnnotationInput!) {
updateAllocationAnnotation(input: $input) {
clientMutationId
allocationAnnotation {
...AllocationAnnotationFragment
}
query {
...QueryFragment
}
allocationByAllocationId {
...AllocationFragment
}
userByWrittenBy {
...UserFragment
}
accountByAccountId {
...AccountFragment
}
allocationAnnotationEdge {
...AllocationAnnotationsEdgeFragment
}
}
}
Variables
{"input": UpdateAllocationAnnotationInput}
Response
{
"data": {
"updateAllocationAnnotation": {
"clientMutationId": "xyz789",
"allocationAnnotation": AllocationAnnotation,
"query": Query,
"allocationByAllocationId": Allocation,
"userByWrittenBy": User,
"accountByAccountId": Account,
"allocationAnnotationEdge": AllocationAnnotationsEdge
}
}
}
updateAllocationAnnotationById
Description
Updates a single AllocationAnnotation using a unique key and a patch.
Response
Returns an UpdateAllocationAnnotationPayload
Arguments
| Name | Description |
|---|---|
input - UpdateAllocationAnnotationByIdInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation updateAllocationAnnotationById($input: UpdateAllocationAnnotationByIdInput!) {
updateAllocationAnnotationById(input: $input) {
clientMutationId
allocationAnnotation {
...AllocationAnnotationFragment
}
query {
...QueryFragment
}
allocationByAllocationId {
...AllocationFragment
}
userByWrittenBy {
...UserFragment
}
accountByAccountId {
...AccountFragment
}
allocationAnnotationEdge {
...AllocationAnnotationsEdgeFragment
}
}
}
Variables
{"input": UpdateAllocationAnnotationByIdInput}
Response
{
"data": {
"updateAllocationAnnotationById": {
"clientMutationId": "abc123",
"allocationAnnotation": AllocationAnnotation,
"query": Query,
"allocationByAllocationId": Allocation,
"userByWrittenBy": User,
"accountByAccountId": Account,
"allocationAnnotationEdge": AllocationAnnotationsEdge
}
}
}
updateAllocationById
Description
Updates a single Allocation using a unique key and a patch.
Response
Returns an UpdateAllocationPayload
Arguments
| Name | Description |
|---|---|
input - UpdateAllocationByIdInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation updateAllocationById($input: UpdateAllocationByIdInput!) {
updateAllocationById(input: $input) {
clientMutationId
allocation {
...AllocationFragment
}
query {
...QueryFragment
}
accountByOwnerId {
...AccountFragment
}
blockchainAddressByBlockchainAddressId {
...BlockchainAddressFragment
}
accountByIssuerId {
...AccountFragment
}
assetStatusByStatus {
...AssetStatusFragment
}
roundByRoundId {
...RoundFragment
}
allocationEdge {
...AllocationsEdgeFragment
}
}
}
Variables
{"input": UpdateAllocationByIdInput}
Response
{
"data": {
"updateAllocationById": {
"clientMutationId": "abc123",
"allocation": Allocation,
"query": Query,
"accountByOwnerId": Account,
"blockchainAddressByBlockchainAddressId": BlockchainAddress,
"accountByIssuerId": Account,
"assetStatusByStatus": AssetStatus,
"roundByRoundId": Round,
"allocationEdge": AllocationsEdge
}
}
}
updateAllocationEmailPreference
Description
Updates a single AllocationEmailPreference using its globally unique id and a patch.
Response
Returns an UpdateAllocationEmailPreferencePayload
Arguments
| Name | Description |
|---|---|
input - UpdateAllocationEmailPreferenceInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation updateAllocationEmailPreference($input: UpdateAllocationEmailPreferenceInput!) {
updateAllocationEmailPreference(input: $input) {
clientMutationId
allocationEmailPreference {
...AllocationEmailPreferenceFragment
}
query {
...QueryFragment
}
accountByAccountId {
...AccountFragment
}
allocationByAllocationId {
...AllocationFragment
}
allocationEmailPreferenceEdge {
...AllocationEmailPreferencesEdgeFragment
}
}
}
Variables
{"input": UpdateAllocationEmailPreferenceInput}
Response
{
"data": {
"updateAllocationEmailPreference": {
"clientMutationId": "abc123",
"allocationEmailPreference": AllocationEmailPreference,
"query": Query,
"accountByAccountId": Account,
"allocationByAllocationId": Allocation,
"allocationEmailPreferenceEdge": AllocationEmailPreferencesEdge
}
}
}
updateAllocationEmailPreferenceByAllocationId
Description
Updates a single AllocationEmailPreference using a unique key and a patch.
Response
Returns an UpdateAllocationEmailPreferencePayload
Arguments
| Name | Description |
|---|---|
input - UpdateAllocationEmailPreferenceByAllocationIdInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation updateAllocationEmailPreferenceByAllocationId($input: UpdateAllocationEmailPreferenceByAllocationIdInput!) {
updateAllocationEmailPreferenceByAllocationId(input: $input) {
clientMutationId
allocationEmailPreference {
...AllocationEmailPreferenceFragment
}
query {
...QueryFragment
}
accountByAccountId {
...AccountFragment
}
allocationByAllocationId {
...AllocationFragment
}
allocationEmailPreferenceEdge {
...AllocationEmailPreferencesEdgeFragment
}
}
}
Variables
{
"input": UpdateAllocationEmailPreferenceByAllocationIdInput
}
Response
{
"data": {
"updateAllocationEmailPreferenceByAllocationId": {
"clientMutationId": "xyz789",
"allocationEmailPreference": AllocationEmailPreference,
"query": Query,
"accountByAccountId": Account,
"allocationByAllocationId": Allocation,
"allocationEmailPreferenceEdge": AllocationEmailPreferencesEdge
}
}
}
updateAllocationEmailPreferenceById
Description
Updates a single AllocationEmailPreference using a unique key and a patch.
Response
Returns an UpdateAllocationEmailPreferencePayload
Arguments
| Name | Description |
|---|---|
input - UpdateAllocationEmailPreferenceByIdInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation updateAllocationEmailPreferenceById($input: UpdateAllocationEmailPreferenceByIdInput!) {
updateAllocationEmailPreferenceById(input: $input) {
clientMutationId
allocationEmailPreference {
...AllocationEmailPreferenceFragment
}
query {
...QueryFragment
}
accountByAccountId {
...AccountFragment
}
allocationByAllocationId {
...AllocationFragment
}
allocationEmailPreferenceEdge {
...AllocationEmailPreferencesEdgeFragment
}
}
}
Variables
{"input": UpdateAllocationEmailPreferenceByIdInput}
Response
{
"data": {
"updateAllocationEmailPreferenceById": {
"clientMutationId": "abc123",
"allocationEmailPreference": AllocationEmailPreference,
"query": Query,
"accountByAccountId": Account,
"allocationByAllocationId": Allocation,
"allocationEmailPreferenceEdge": AllocationEmailPreferencesEdge
}
}
}
updateAllocationOfferingLink
Description
Updates a single AllocationOfferingLink using its globally unique id and a patch.
Response
Returns an UpdateAllocationOfferingLinkPayload
Arguments
| Name | Description |
|---|---|
input - UpdateAllocationOfferingLinkInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation updateAllocationOfferingLink($input: UpdateAllocationOfferingLinkInput!) {
updateAllocationOfferingLink(input: $input) {
clientMutationId
allocationOfferingLink {
...AllocationOfferingLinkFragment
}
query {
...QueryFragment
}
allocationByAllocationId {
...AllocationFragment
}
accountByCreatedBy {
...AccountFragment
}
accountByAgentId {
...AccountFragment
}
allocationOfferingLinkEdge {
...AllocationOfferingLinksEdgeFragment
}
}
}
Variables
{"input": UpdateAllocationOfferingLinkInput}
Response
{
"data": {
"updateAllocationOfferingLink": {
"clientMutationId": "xyz789",
"allocationOfferingLink": AllocationOfferingLink,
"query": Query,
"allocationByAllocationId": Allocation,
"accountByCreatedBy": Account,
"accountByAgentId": Account,
"allocationOfferingLinkEdge": AllocationOfferingLinksEdge
}
}
}
updateAllocationOfferingLinkById
Description
Updates a single AllocationOfferingLink using a unique key and a patch.
Response
Returns an UpdateAllocationOfferingLinkPayload
Arguments
| Name | Description |
|---|---|
input - UpdateAllocationOfferingLinkByIdInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation updateAllocationOfferingLinkById($input: UpdateAllocationOfferingLinkByIdInput!) {
updateAllocationOfferingLinkById(input: $input) {
clientMutationId
allocationOfferingLink {
...AllocationOfferingLinkFragment
}
query {
...QueryFragment
}
allocationByAllocationId {
...AllocationFragment
}
accountByCreatedBy {
...AccountFragment
}
accountByAgentId {
...AccountFragment
}
allocationOfferingLinkEdge {
...AllocationOfferingLinksEdgeFragment
}
}
}
Variables
{"input": UpdateAllocationOfferingLinkByIdInput}
Response
{
"data": {
"updateAllocationOfferingLinkById": {
"clientMutationId": "xyz789",
"allocationOfferingLink": AllocationOfferingLink,
"query": Query,
"allocationByAllocationId": Allocation,
"accountByCreatedBy": Account,
"accountByAgentId": Account,
"allocationOfferingLinkEdge": AllocationOfferingLinksEdge
}
}
}
updateAllocationQualification
Description
Updates a single AllocationQualification using its globally unique id and a patch.
Response
Returns an UpdateAllocationQualificationPayload
Arguments
| Name | Description |
|---|---|
input - UpdateAllocationQualificationInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation updateAllocationQualification($input: UpdateAllocationQualificationInput!) {
updateAllocationQualification(input: $input) {
clientMutationId
allocationQualification {
...AllocationQualificationFragment
}
query {
...QueryFragment
}
allocationByAllocationId {
...AllocationFragment
}
vendorQualificationByVendorQualificationId {
...VendorQualificationFragment
}
allocationQualificationEdge {
...AllocationQualificationsEdgeFragment
}
}
}
Variables
{"input": UpdateAllocationQualificationInput}
Response
{
"data": {
"updateAllocationQualification": {
"clientMutationId": "xyz789",
"allocationQualification": AllocationQualification,
"query": Query,
"allocationByAllocationId": Allocation,
"vendorQualificationByVendorQualificationId": VendorQualification,
"allocationQualificationEdge": AllocationQualificationsEdge
}
}
}
updateAllocationQualificationByAllocationIdAndVendorQualificationId
Description
Updates a single AllocationQualification using a unique key and a patch.
Response
Returns an UpdateAllocationQualificationPayload
Arguments
| Name | Description |
|---|---|
input - UpdateAllocationQualificationByAllocationIdAndVendorQualificationIdInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation updateAllocationQualificationByAllocationIdAndVendorQualificationId($input: UpdateAllocationQualificationByAllocationIdAndVendorQualificationIdInput!) {
updateAllocationQualificationByAllocationIdAndVendorQualificationId(input: $input) {
clientMutationId
allocationQualification {
...AllocationQualificationFragment
}
query {
...QueryFragment
}
allocationByAllocationId {
...AllocationFragment
}
vendorQualificationByVendorQualificationId {
...VendorQualificationFragment
}
allocationQualificationEdge {
...AllocationQualificationsEdgeFragment
}
}
}
Variables
{
"input": UpdateAllocationQualificationByAllocationIdAndVendorQualificationIdInput
}
Response
{
"data": {
"updateAllocationQualificationByAllocationIdAndVendorQualificationId": {
"clientMutationId": "xyz789",
"allocationQualification": AllocationQualification,
"query": Query,
"allocationByAllocationId": Allocation,
"vendorQualificationByVendorQualificationId": VendorQualification,
"allocationQualificationEdge": AllocationQualificationsEdge
}
}
}
updateAllocationQualificationById
Description
Updates a single AllocationQualification using a unique key and a patch.
Response
Returns an UpdateAllocationQualificationPayload
Arguments
| Name | Description |
|---|---|
input - UpdateAllocationQualificationByIdInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation updateAllocationQualificationById($input: UpdateAllocationQualificationByIdInput!) {
updateAllocationQualificationById(input: $input) {
clientMutationId
allocationQualification {
...AllocationQualificationFragment
}
query {
...QueryFragment
}
allocationByAllocationId {
...AllocationFragment
}
vendorQualificationByVendorQualificationId {
...VendorQualificationFragment
}
allocationQualificationEdge {
...AllocationQualificationsEdgeFragment
}
}
}
Variables
{"input": UpdateAllocationQualificationByIdInput}
Response
{
"data": {
"updateAllocationQualificationById": {
"clientMutationId": "abc123",
"allocationQualification": AllocationQualification,
"query": Query,
"allocationByAllocationId": Allocation,
"vendorQualificationByVendorQualificationId": VendorQualification,
"allocationQualificationEdge": AllocationQualificationsEdge
}
}
}
updateAllocationsVestingSchedule
Description
Updates a single AllocationsVestingSchedule using its globally unique id and a patch.
Response
Returns an UpdateAllocationsVestingSchedulePayload
Arguments
| Name | Description |
|---|---|
input - UpdateAllocationsVestingScheduleInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation updateAllocationsVestingSchedule($input: UpdateAllocationsVestingScheduleInput!) {
updateAllocationsVestingSchedule(input: $input) {
clientMutationId
allocationsVestingSchedule {
...AllocationsVestingScheduleFragment
}
query {
...QueryFragment
}
allocationByAllocationId {
...AllocationFragment
}
vestingDurationByDuration {
...VestingDurationFragment
}
allocationsVestingScheduleEdge {
...AllocationsVestingSchedulesEdgeFragment
}
}
}
Variables
{"input": UpdateAllocationsVestingScheduleInput}
Response
{
"data": {
"updateAllocationsVestingSchedule": {
"clientMutationId": "abc123",
"allocationsVestingSchedule": AllocationsVestingSchedule,
"query": Query,
"allocationByAllocationId": Allocation,
"vestingDurationByDuration": VestingDuration,
"allocationsVestingScheduleEdge": AllocationsVestingSchedulesEdge
}
}
}
updateAllocationsVestingScheduleByAllocationId
Description
Updates a single AllocationsVestingSchedule using a unique key and a patch.
Response
Returns an UpdateAllocationsVestingSchedulePayload
Arguments
| Name | Description |
|---|---|
input - UpdateAllocationsVestingScheduleByAllocationIdInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation updateAllocationsVestingScheduleByAllocationId($input: UpdateAllocationsVestingScheduleByAllocationIdInput!) {
updateAllocationsVestingScheduleByAllocationId(input: $input) {
clientMutationId
allocationsVestingSchedule {
...AllocationsVestingScheduleFragment
}
query {
...QueryFragment
}
allocationByAllocationId {
...AllocationFragment
}
vestingDurationByDuration {
...VestingDurationFragment
}
allocationsVestingScheduleEdge {
...AllocationsVestingSchedulesEdgeFragment
}
}
}
Variables
{
"input": UpdateAllocationsVestingScheduleByAllocationIdInput
}
Response
{
"data": {
"updateAllocationsVestingScheduleByAllocationId": {
"clientMutationId": "xyz789",
"allocationsVestingSchedule": AllocationsVestingSchedule,
"query": Query,
"allocationByAllocationId": Allocation,
"vestingDurationByDuration": VestingDuration,
"allocationsVestingScheduleEdge": AllocationsVestingSchedulesEdge
}
}
}
updateAllocationsVestingScheduleById
Description
Updates a single AllocationsVestingSchedule using a unique key and a patch.
Response
Returns an UpdateAllocationsVestingSchedulePayload
Arguments
| Name | Description |
|---|---|
input - UpdateAllocationsVestingScheduleByIdInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation updateAllocationsVestingScheduleById($input: UpdateAllocationsVestingScheduleByIdInput!) {
updateAllocationsVestingScheduleById(input: $input) {
clientMutationId
allocationsVestingSchedule {
...AllocationsVestingScheduleFragment
}
query {
...QueryFragment
}
allocationByAllocationId {
...AllocationFragment
}
vestingDurationByDuration {
...VestingDurationFragment
}
allocationsVestingScheduleEdge {
...AllocationsVestingSchedulesEdgeFragment
}
}
}
Variables
{"input": UpdateAllocationsVestingScheduleByIdInput}
Response
{
"data": {
"updateAllocationsVestingScheduleById": {
"clientMutationId": "abc123",
"allocationsVestingSchedule": AllocationsVestingSchedule,
"query": Query,
"allocationByAllocationId": Allocation,
"vestingDurationByDuration": VestingDuration,
"allocationsVestingScheduleEdge": AllocationsVestingSchedulesEdge
}
}
}
updateAsset
Description
Updates a single Asset using its globally unique id and a patch.
Response
Returns an UpdateAssetPayload
Arguments
| Name | Description |
|---|---|
input - UpdateAssetInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation updateAsset($input: UpdateAssetInput!) {
updateAsset(input: $input) {
clientMutationId
asset {
...AssetFragment
}
query {
...QueryFragment
}
accountByIssuerId {
...AccountFragment
}
assetTypeByType {
...AssetTypeFragment
}
assetStatusByStatus {
...AssetStatusFragment
}
assetEdge {
...AssetsEdgeFragment
}
}
}
Variables
{"input": UpdateAssetInput}
Response
{
"data": {
"updateAsset": {
"clientMutationId": "xyz789",
"asset": Asset,
"query": Query,
"accountByIssuerId": Account,
"assetTypeByType": AssetType,
"assetStatusByStatus": AssetStatus,
"assetEdge": AssetsEdge
}
}
}
updateAssetAnnotation
Description
Updates a single AssetAnnotation using its globally unique id and a patch.
Response
Returns an UpdateAssetAnnotationPayload
Arguments
| Name | Description |
|---|---|
input - UpdateAssetAnnotationInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation updateAssetAnnotation($input: UpdateAssetAnnotationInput!) {
updateAssetAnnotation(input: $input) {
clientMutationId
assetAnnotation {
...AssetAnnotationFragment
}
query {
...QueryFragment
}
assetByAssetId {
...AssetFragment
}
userByWrittenBy {
...UserFragment
}
accountByAccountId {
...AccountFragment
}
assetAnnotationEdge {
...AssetAnnotationsEdgeFragment
}
}
}
Variables
{"input": UpdateAssetAnnotationInput}
Response
{
"data": {
"updateAssetAnnotation": {
"clientMutationId": "xyz789",
"assetAnnotation": AssetAnnotation,
"query": Query,
"assetByAssetId": Asset,
"userByWrittenBy": User,
"accountByAccountId": Account,
"assetAnnotationEdge": AssetAnnotationsEdge
}
}
}
updateAssetAnnotationById
Description
Updates a single AssetAnnotation using a unique key and a patch.
Response
Returns an UpdateAssetAnnotationPayload
Arguments
| Name | Description |
|---|---|
input - UpdateAssetAnnotationByIdInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation updateAssetAnnotationById($input: UpdateAssetAnnotationByIdInput!) {
updateAssetAnnotationById(input: $input) {
clientMutationId
assetAnnotation {
...AssetAnnotationFragment
}
query {
...QueryFragment
}
assetByAssetId {
...AssetFragment
}
userByWrittenBy {
...UserFragment
}
accountByAccountId {
...AccountFragment
}
assetAnnotationEdge {
...AssetAnnotationsEdgeFragment
}
}
}
Variables
{"input": UpdateAssetAnnotationByIdInput}
Response
{
"data": {
"updateAssetAnnotationById": {
"clientMutationId": "xyz789",
"assetAnnotation": AssetAnnotation,
"query": Query,
"assetByAssetId": Asset,
"userByWrittenBy": User,
"accountByAccountId": Account,
"assetAnnotationEdge": AssetAnnotationsEdge
}
}
}
updateAssetById
Description
Updates a single Asset using a unique key and a patch.
Response
Returns an UpdateAssetPayload
Arguments
| Name | Description |
|---|---|
input - UpdateAssetByIdInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation updateAssetById($input: UpdateAssetByIdInput!) {
updateAssetById(input: $input) {
clientMutationId
asset {
...AssetFragment
}
query {
...QueryFragment
}
accountByIssuerId {
...AccountFragment
}
assetTypeByType {
...AssetTypeFragment
}
assetStatusByStatus {
...AssetStatusFragment
}
assetEdge {
...AssetsEdgeFragment
}
}
}
Variables
{"input": UpdateAssetByIdInput}
Response
{
"data": {
"updateAssetById": {
"clientMutationId": "abc123",
"asset": Asset,
"query": Query,
"accountByIssuerId": Account,
"assetTypeByType": AssetType,
"assetStatusByStatus": AssetStatus,
"assetEdge": AssetsEdge
}
}
}
updateAuxAccount
Description
Updates a single AuxAccount using its globally unique id and a patch.
Response
Returns an UpdateAuxAccountPayload
Arguments
| Name | Description |
|---|---|
input - UpdateAuxAccountInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation updateAuxAccount($input: UpdateAuxAccountInput!) {
updateAuxAccount(input: $input) {
clientMutationId
auxAccount {
...AuxAccountFragment
}
query {
...QueryFragment
}
auxAccountEdge {
...AuxAccountsEdgeFragment
}
}
}
Variables
{"input": UpdateAuxAccountInput}
Response
{
"data": {
"updateAuxAccount": {
"clientMutationId": "xyz789",
"auxAccount": AuxAccount,
"query": Query,
"auxAccountEdge": AuxAccountsEdge
}
}
}
updateAuxAccountByType
Description
Updates a single AuxAccount using a unique key and a patch.
Response
Returns an UpdateAuxAccountPayload
Arguments
| Name | Description |
|---|---|
input - UpdateAuxAccountByTypeInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation updateAuxAccountByType($input: UpdateAuxAccountByTypeInput!) {
updateAuxAccountByType(input: $input) {
clientMutationId
auxAccount {
...AuxAccountFragment
}
query {
...QueryFragment
}
auxAccountEdge {
...AuxAccountsEdgeFragment
}
}
}
Variables
{"input": UpdateAuxAccountByTypeInput}
Response
{
"data": {
"updateAuxAccountByType": {
"clientMutationId": "xyz789",
"auxAccount": AuxAccount,
"query": Query,
"auxAccountEdge": AuxAccountsEdge
}
}
}
updateAuxRole
Description
Updates a single AuxRole using its globally unique id and a patch.
Response
Returns an UpdateAuxRolePayload
Arguments
| Name | Description |
|---|---|
input - UpdateAuxRoleInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation updateAuxRole($input: UpdateAuxRoleInput!) {
updateAuxRole(input: $input) {
clientMutationId
auxRole {
...AuxRoleFragment
}
query {
...QueryFragment
}
auxRoleEdge {
...AuxRolesEdgeFragment
}
}
}
Variables
{"input": UpdateAuxRoleInput}
Response
{
"data": {
"updateAuxRole": {
"clientMutationId": "abc123",
"auxRole": AuxRole,
"query": Query,
"auxRoleEdge": AuxRolesEdge
}
}
}
updateAuxRoleByRole
Description
Updates a single AuxRole using a unique key and a patch.
Response
Returns an UpdateAuxRolePayload
Arguments
| Name | Description |
|---|---|
input - UpdateAuxRoleByRoleInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation updateAuxRoleByRole($input: UpdateAuxRoleByRoleInput!) {
updateAuxRoleByRole(input: $input) {
clientMutationId
auxRole {
...AuxRoleFragment
}
query {
...QueryFragment
}
auxRoleEdge {
...AuxRolesEdgeFragment
}
}
}
Variables
{"input": UpdateAuxRoleByRoleInput}
Response
{
"data": {
"updateAuxRoleByRole": {
"clientMutationId": "abc123",
"auxRole": AuxRole,
"query": Query,
"auxRoleEdge": AuxRolesEdge
}
}
}
updateBlockchainRegistration
Description
Updates a single BlockchainRegistration using its globally unique id and a patch.
Response
Returns an UpdateBlockchainRegistrationPayload
Arguments
| Name | Description |
|---|---|
input - UpdateBlockchainRegistrationInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation updateBlockchainRegistration($input: UpdateBlockchainRegistrationInput!) {
updateBlockchainRegistration(input: $input) {
clientMutationId
blockchainRegistration {
...BlockchainRegistrationFragment
}
query {
...QueryFragment
}
blockchainAddressByBlockchainAddressId {
...BlockchainAddressFragment
}
accountByAccountId {
...AccountFragment
}
usersAccountByUsersAccountId {
...UsersAccountFragment
}
registrationStatusByStatus {
...RegistrationStatusFragment
}
chainByChain {
...ChainFragment
}
registrationMethodByMethod {
...RegistrationMethodFragment
}
blockchainRegistrationEdge {
...BlockchainRegistrationsEdgeFragment
}
}
}
Variables
{"input": UpdateBlockchainRegistrationInput}
Response
{
"data": {
"updateBlockchainRegistration": {
"clientMutationId": "abc123",
"blockchainRegistration": BlockchainRegistration,
"query": Query,
"blockchainAddressByBlockchainAddressId": BlockchainAddress,
"accountByAccountId": Account,
"usersAccountByUsersAccountId": UsersAccount,
"registrationStatusByStatus": RegistrationStatus,
"chainByChain": Chain,
"registrationMethodByMethod": RegistrationMethod,
"blockchainRegistrationEdge": BlockchainRegistrationsEdge
}
}
}
updateBlockchainRegistrationById
Description
Updates a single BlockchainRegistration using a unique key and a patch.
Response
Returns an UpdateBlockchainRegistrationPayload
Arguments
| Name | Description |
|---|---|
input - UpdateBlockchainRegistrationByIdInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation updateBlockchainRegistrationById($input: UpdateBlockchainRegistrationByIdInput!) {
updateBlockchainRegistrationById(input: $input) {
clientMutationId
blockchainRegistration {
...BlockchainRegistrationFragment
}
query {
...QueryFragment
}
blockchainAddressByBlockchainAddressId {
...BlockchainAddressFragment
}
accountByAccountId {
...AccountFragment
}
usersAccountByUsersAccountId {
...UsersAccountFragment
}
registrationStatusByStatus {
...RegistrationStatusFragment
}
chainByChain {
...ChainFragment
}
registrationMethodByMethod {
...RegistrationMethodFragment
}
blockchainRegistrationEdge {
...BlockchainRegistrationsEdgeFragment
}
}
}
Variables
{"input": UpdateBlockchainRegistrationByIdInput}
Response
{
"data": {
"updateBlockchainRegistrationById": {
"clientMutationId": "xyz789",
"blockchainRegistration": BlockchainRegistration,
"query": Query,
"blockchainAddressByBlockchainAddressId": BlockchainAddress,
"accountByAccountId": Account,
"usersAccountByUsersAccountId": UsersAccount,
"registrationStatusByStatus": RegistrationStatus,
"chainByChain": Chain,
"registrationMethodByMethod": RegistrationMethod,
"blockchainRegistrationEdge": BlockchainRegistrationsEdge
}
}
}
updateBlockchainRegistrationByNonce
Description
Updates a single BlockchainRegistration using a unique key and a patch.
Response
Returns an UpdateBlockchainRegistrationPayload
Arguments
| Name | Description |
|---|---|
input - UpdateBlockchainRegistrationByNonceInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation updateBlockchainRegistrationByNonce($input: UpdateBlockchainRegistrationByNonceInput!) {
updateBlockchainRegistrationByNonce(input: $input) {
clientMutationId
blockchainRegistration {
...BlockchainRegistrationFragment
}
query {
...QueryFragment
}
blockchainAddressByBlockchainAddressId {
...BlockchainAddressFragment
}
accountByAccountId {
...AccountFragment
}
usersAccountByUsersAccountId {
...UsersAccountFragment
}
registrationStatusByStatus {
...RegistrationStatusFragment
}
chainByChain {
...ChainFragment
}
registrationMethodByMethod {
...RegistrationMethodFragment
}
blockchainRegistrationEdge {
...BlockchainRegistrationsEdgeFragment
}
}
}
Variables
{"input": UpdateBlockchainRegistrationByNonceInput}
Response
{
"data": {
"updateBlockchainRegistrationByNonce": {
"clientMutationId": "abc123",
"blockchainRegistration": BlockchainRegistration,
"query": Query,
"blockchainAddressByBlockchainAddressId": BlockchainAddress,
"accountByAccountId": Account,
"usersAccountByUsersAccountId": UsersAccount,
"registrationStatusByStatus": RegistrationStatus,
"chainByChain": Chain,
"registrationMethodByMethod": RegistrationMethod,
"blockchainRegistrationEdge": BlockchainRegistrationsEdge
}
}
}
updateBrokerAllocation
Description
Updates a single BrokerAllocation using its globally unique id and a patch.
Response
Returns an UpdateBrokerAllocationPayload
Arguments
| Name | Description |
|---|---|
input - UpdateBrokerAllocationInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation updateBrokerAllocation($input: UpdateBrokerAllocationInput!) {
updateBrokerAllocation(input: $input) {
clientMutationId
brokerAllocation {
...BrokerAllocationFragment
}
query {
...QueryFragment
}
accountByBrokerId {
...AccountFragment
}
invitationStatusByStatus {
...InvitationStatusFragment
}
roundByRoundId {
...RoundFragment
}
brokerAllocationEdge {
...BrokerAllocationsEdgeFragment
}
}
}
Variables
{"input": UpdateBrokerAllocationInput}
Response
{
"data": {
"updateBrokerAllocation": {
"clientMutationId": "abc123",
"brokerAllocation": BrokerAllocation,
"query": Query,
"accountByBrokerId": Account,
"invitationStatusByStatus": InvitationStatus,
"roundByRoundId": Round,
"brokerAllocationEdge": BrokerAllocationsEdge
}
}
}
updateBrokerAllocationById
Description
Updates a single BrokerAllocation using a unique key and a patch.
Response
Returns an UpdateBrokerAllocationPayload
Arguments
| Name | Description |
|---|---|
input - UpdateBrokerAllocationByIdInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation updateBrokerAllocationById($input: UpdateBrokerAllocationByIdInput!) {
updateBrokerAllocationById(input: $input) {
clientMutationId
brokerAllocation {
...BrokerAllocationFragment
}
query {
...QueryFragment
}
accountByBrokerId {
...AccountFragment
}
invitationStatusByStatus {
...InvitationStatusFragment
}
roundByRoundId {
...RoundFragment
}
brokerAllocationEdge {
...BrokerAllocationsEdgeFragment
}
}
}
Variables
{"input": UpdateBrokerAllocationByIdInput}
Response
{
"data": {
"updateBrokerAllocationById": {
"clientMutationId": "abc123",
"brokerAllocation": BrokerAllocation,
"query": Query,
"accountByBrokerId": Account,
"invitationStatusByStatus": InvitationStatus,
"roundByRoundId": Round,
"brokerAllocationEdge": BrokerAllocationsEdge
}
}
}
updateCapitalDeployment
Description
Updates a single CapitalDeployment using its globally unique id and a patch.
Response
Returns an UpdateCapitalDeploymentPayload
Arguments
| Name | Description |
|---|---|
input - UpdateCapitalDeploymentInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation updateCapitalDeployment($input: UpdateCapitalDeploymentInput!) {
updateCapitalDeployment(input: $input) {
clientMutationId
capitalDeployment {
...CapitalDeploymentFragment
}
query {
...QueryFragment
}
currencyByCurrency {
...CurrencyFragment
}
roundByRoundId {
...RoundFragment
}
capitalDeploymentEdge {
...CapitalDeploymentsEdgeFragment
}
}
}
Variables
{"input": UpdateCapitalDeploymentInput}
Response
{
"data": {
"updateCapitalDeployment": {
"clientMutationId": "xyz789",
"capitalDeployment": CapitalDeployment,
"query": Query,
"currencyByCurrency": Currency,
"roundByRoundId": Round,
"capitalDeploymentEdge": CapitalDeploymentsEdge
}
}
}
updateCapitalDeploymentById
Description
Updates a single CapitalDeployment using a unique key and a patch.
Response
Returns an UpdateCapitalDeploymentPayload
Arguments
| Name | Description |
|---|---|
input - UpdateCapitalDeploymentByIdInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation updateCapitalDeploymentById($input: UpdateCapitalDeploymentByIdInput!) {
updateCapitalDeploymentById(input: $input) {
clientMutationId
capitalDeployment {
...CapitalDeploymentFragment
}
query {
...QueryFragment
}
currencyByCurrency {
...CurrencyFragment
}
roundByRoundId {
...RoundFragment
}
capitalDeploymentEdge {
...CapitalDeploymentsEdgeFragment
}
}
}
Variables
{"input": UpdateCapitalDeploymentByIdInput}
Response
{
"data": {
"updateCapitalDeploymentById": {
"clientMutationId": "xyz789",
"capitalDeployment": CapitalDeployment,
"query": Query,
"currencyByCurrency": Currency,
"roundByRoundId": Round,
"capitalDeploymentEdge": CapitalDeploymentsEdge
}
}
}
updateCapitalDeploymentByTransactionGroupId
Description
Updates a single CapitalDeployment using a unique key and a patch.
Response
Returns an UpdateCapitalDeploymentPayload
Arguments
| Name | Description |
|---|---|
input - UpdateCapitalDeploymentByTransactionGroupIdInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation updateCapitalDeploymentByTransactionGroupId($input: UpdateCapitalDeploymentByTransactionGroupIdInput!) {
updateCapitalDeploymentByTransactionGroupId(input: $input) {
clientMutationId
capitalDeployment {
...CapitalDeploymentFragment
}
query {
...QueryFragment
}
currencyByCurrency {
...CurrencyFragment
}
roundByRoundId {
...RoundFragment
}
capitalDeploymentEdge {
...CapitalDeploymentsEdgeFragment
}
}
}
Variables
{
"input": UpdateCapitalDeploymentByTransactionGroupIdInput
}
Response
{
"data": {
"updateCapitalDeploymentByTransactionGroupId": {
"clientMutationId": "xyz789",
"capitalDeployment": CapitalDeployment,
"query": Query,
"currencyByCurrency": Currency,
"roundByRoundId": Round,
"capitalDeploymentEdge": CapitalDeploymentsEdge
}
}
}
updateCustomer
Description
Updates a single Customer using its globally unique id and a patch.
Response
Returns an UpdateCustomerPayload
Arguments
| Name | Description |
|---|---|
input - UpdateCustomerInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation updateCustomer($input: UpdateCustomerInput!) {
updateCustomer(input: $input) {
clientMutationId
customer {
...CustomerFragment
}
query {
...QueryFragment
}
accountByVendorId {
...AccountFragment
}
accountByInvestorId {
...AccountFragment
}
invitationStatusByStatus {
...InvitationStatusFragment
}
investorAccountTypeByInvestorType {
...InvestorAccountTypeFragment
}
countryByJurisdiction {
...CountryFragment
}
customerEdge {
...CustomersEdgeFragment
}
}
}
Variables
{"input": UpdateCustomerInput}
Response
{
"data": {
"updateCustomer": {
"clientMutationId": "xyz789",
"customer": Customer,
"query": Query,
"accountByVendorId": Account,
"accountByInvestorId": Account,
"invitationStatusByStatus": InvitationStatus,
"investorAccountTypeByInvestorType": InvestorAccountType,
"countryByJurisdiction": Country,
"customerEdge": CustomersEdge
}
}
}
updateCustomerById
Description
Updates a single Customer using a unique key and a patch.
Response
Returns an UpdateCustomerPayload
Arguments
| Name | Description |
|---|---|
input - UpdateCustomerByIdInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation updateCustomerById($input: UpdateCustomerByIdInput!) {
updateCustomerById(input: $input) {
clientMutationId
customer {
...CustomerFragment
}
query {
...QueryFragment
}
accountByVendorId {
...AccountFragment
}
accountByInvestorId {
...AccountFragment
}
invitationStatusByStatus {
...InvitationStatusFragment
}
investorAccountTypeByInvestorType {
...InvestorAccountTypeFragment
}
countryByJurisdiction {
...CountryFragment
}
customerEdge {
...CustomersEdgeFragment
}
}
}
Variables
{"input": UpdateCustomerByIdInput}
Response
{
"data": {
"updateCustomerById": {
"clientMutationId": "xyz789",
"customer": Customer,
"query": Query,
"accountByVendorId": Account,
"accountByInvestorId": Account,
"invitationStatusByStatus": InvitationStatus,
"investorAccountTypeByInvestorType": InvestorAccountType,
"countryByJurisdiction": Country,
"customerEdge": CustomersEdge
}
}
}
updateCustomerByVendorIdAndInvestorId
Description
Updates a single Customer using a unique key and a patch.
Response
Returns an UpdateCustomerPayload
Arguments
| Name | Description |
|---|---|
input - UpdateCustomerByVendorIdAndInvestorIdInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation updateCustomerByVendorIdAndInvestorId($input: UpdateCustomerByVendorIdAndInvestorIdInput!) {
updateCustomerByVendorIdAndInvestorId(input: $input) {
clientMutationId
customer {
...CustomerFragment
}
query {
...QueryFragment
}
accountByVendorId {
...AccountFragment
}
accountByInvestorId {
...AccountFragment
}
invitationStatusByStatus {
...InvitationStatusFragment
}
investorAccountTypeByInvestorType {
...InvestorAccountTypeFragment
}
countryByJurisdiction {
...CountryFragment
}
customerEdge {
...CustomersEdgeFragment
}
}
}
Variables
{"input": UpdateCustomerByVendorIdAndInvestorIdInput}
Response
{
"data": {
"updateCustomerByVendorIdAndInvestorId": {
"clientMutationId": "abc123",
"customer": Customer,
"query": Query,
"accountByVendorId": Account,
"accountByInvestorId": Account,
"invitationStatusByStatus": InvitationStatus,
"investorAccountTypeByInvestorType": InvestorAccountType,
"countryByJurisdiction": Country,
"customerEdge": CustomersEdge
}
}
}
updateDistribution
Description
Updates a single Distribution using its globally unique id and a patch.
Response
Returns an UpdateDistributionPayload
Arguments
| Name | Description |
|---|---|
input - UpdateDistributionInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation updateDistribution($input: UpdateDistributionInput!) {
updateDistribution(input: $input) {
clientMutationId
distribution {
...DistributionFragment
}
query {
...QueryFragment
}
allocationByAllocationId {
...AllocationFragment
}
accountByInvestorId {
...AccountFragment
}
distributionStatusByStatus {
...DistributionStatusFragment
}
stepByStepId {
...StepFragment
}
distributionEdge {
...DistributionsEdgeFragment
}
}
}
Variables
{"input": UpdateDistributionInput}
Response
{
"data": {
"updateDistribution": {
"clientMutationId": "abc123",
"distribution": Distribution,
"query": Query,
"allocationByAllocationId": Allocation,
"accountByInvestorId": Account,
"distributionStatusByStatus": DistributionStatus,
"stepByStepId": Step,
"distributionEdge": DistributionsEdge
}
}
}
updateDistributionAnnotation
Description
Updates a single DistributionAnnotation using its globally unique id and a patch.
Response
Returns an UpdateDistributionAnnotationPayload
Arguments
| Name | Description |
|---|---|
input - UpdateDistributionAnnotationInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation updateDistributionAnnotation($input: UpdateDistributionAnnotationInput!) {
updateDistributionAnnotation(input: $input) {
clientMutationId
distributionAnnotation {
...DistributionAnnotationFragment
}
query {
...QueryFragment
}
distributionByDistributionId {
...DistributionFragment
}
userByWrittenBy {
...UserFragment
}
accountByAccountId {
...AccountFragment
}
distributionAnnotationEdge {
...DistributionAnnotationsEdgeFragment
}
}
}
Variables
{"input": UpdateDistributionAnnotationInput}
Response
{
"data": {
"updateDistributionAnnotation": {
"clientMutationId": "xyz789",
"distributionAnnotation": DistributionAnnotation,
"query": Query,
"distributionByDistributionId": Distribution,
"userByWrittenBy": User,
"accountByAccountId": Account,
"distributionAnnotationEdge": DistributionAnnotationsEdge
}
}
}
updateDistributionAnnotationById
Description
Updates a single DistributionAnnotation using a unique key and a patch.
Response
Returns an UpdateDistributionAnnotationPayload
Arguments
| Name | Description |
|---|---|
input - UpdateDistributionAnnotationByIdInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation updateDistributionAnnotationById($input: UpdateDistributionAnnotationByIdInput!) {
updateDistributionAnnotationById(input: $input) {
clientMutationId
distributionAnnotation {
...DistributionAnnotationFragment
}
query {
...QueryFragment
}
distributionByDistributionId {
...DistributionFragment
}
userByWrittenBy {
...UserFragment
}
accountByAccountId {
...AccountFragment
}
distributionAnnotationEdge {
...DistributionAnnotationsEdgeFragment
}
}
}
Variables
{"input": UpdateDistributionAnnotationByIdInput}
Response
{
"data": {
"updateDistributionAnnotationById": {
"clientMutationId": "xyz789",
"distributionAnnotation": DistributionAnnotation,
"query": Query,
"distributionByDistributionId": Distribution,
"userByWrittenBy": User,
"accountByAccountId": Account,
"distributionAnnotationEdge": DistributionAnnotationsEdge
}
}
}
updateDistributionByClosedBlockchainId
Description
Updates a single Distribution using a unique key and a patch.
Response
Returns an UpdateDistributionPayload
Arguments
| Name | Description |
|---|---|
input - UpdateDistributionByClosedBlockchainIdInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation updateDistributionByClosedBlockchainId($input: UpdateDistributionByClosedBlockchainIdInput!) {
updateDistributionByClosedBlockchainId(input: $input) {
clientMutationId
distribution {
...DistributionFragment
}
query {
...QueryFragment
}
allocationByAllocationId {
...AllocationFragment
}
accountByInvestorId {
...AccountFragment
}
distributionStatusByStatus {
...DistributionStatusFragment
}
stepByStepId {
...StepFragment
}
distributionEdge {
...DistributionsEdgeFragment
}
}
}
Variables
{"input": UpdateDistributionByClosedBlockchainIdInput}
Response
{
"data": {
"updateDistributionByClosedBlockchainId": {
"clientMutationId": "abc123",
"distribution": Distribution,
"query": Query,
"allocationByAllocationId": Allocation,
"accountByInvestorId": Account,
"distributionStatusByStatus": DistributionStatus,
"stepByStepId": Step,
"distributionEdge": DistributionsEdge
}
}
}
updateDistributionByDraftedBlockchainId
Description
Updates a single Distribution using a unique key and a patch.
Response
Returns an UpdateDistributionPayload
Arguments
| Name | Description |
|---|---|
input - UpdateDistributionByDraftedBlockchainIdInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation updateDistributionByDraftedBlockchainId($input: UpdateDistributionByDraftedBlockchainIdInput!) {
updateDistributionByDraftedBlockchainId(input: $input) {
clientMutationId
distribution {
...DistributionFragment
}
query {
...QueryFragment
}
allocationByAllocationId {
...AllocationFragment
}
accountByInvestorId {
...AccountFragment
}
distributionStatusByStatus {
...DistributionStatusFragment
}
stepByStepId {
...StepFragment
}
distributionEdge {
...DistributionsEdgeFragment
}
}
}
Variables
{"input": UpdateDistributionByDraftedBlockchainIdInput}
Response
{
"data": {
"updateDistributionByDraftedBlockchainId": {
"clientMutationId": "abc123",
"distribution": Distribution,
"query": Query,
"allocationByAllocationId": Allocation,
"accountByInvestorId": Account,
"distributionStatusByStatus": DistributionStatus,
"stepByStepId": Step,
"distributionEdge": DistributionsEdge
}
}
}
updateDistributionById
Description
Updates a single Distribution using a unique key and a patch.
Response
Returns an UpdateDistributionPayload
Arguments
| Name | Description |
|---|---|
input - UpdateDistributionByIdInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation updateDistributionById($input: UpdateDistributionByIdInput!) {
updateDistributionById(input: $input) {
clientMutationId
distribution {
...DistributionFragment
}
query {
...QueryFragment
}
allocationByAllocationId {
...AllocationFragment
}
accountByInvestorId {
...AccountFragment
}
distributionStatusByStatus {
...DistributionStatusFragment
}
stepByStepId {
...StepFragment
}
distributionEdge {
...DistributionsEdgeFragment
}
}
}
Variables
{"input": UpdateDistributionByIdInput}
Response
{
"data": {
"updateDistributionById": {
"clientMutationId": "xyz789",
"distribution": Distribution,
"query": Query,
"allocationByAllocationId": Allocation,
"accountByInvestorId": Account,
"distributionStatusByStatus": DistributionStatus,
"stepByStepId": Step,
"distributionEdge": DistributionsEdge
}
}
}
updateDistributionByLockedBlockchainId
Description
Updates a single Distribution using a unique key and a patch.
Response
Returns an UpdateDistributionPayload
Arguments
| Name | Description |
|---|---|
input - UpdateDistributionByLockedBlockchainIdInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation updateDistributionByLockedBlockchainId($input: UpdateDistributionByLockedBlockchainIdInput!) {
updateDistributionByLockedBlockchainId(input: $input) {
clientMutationId
distribution {
...DistributionFragment
}
query {
...QueryFragment
}
allocationByAllocationId {
...AllocationFragment
}
accountByInvestorId {
...AccountFragment
}
distributionStatusByStatus {
...DistributionStatusFragment
}
stepByStepId {
...StepFragment
}
distributionEdge {
...DistributionsEdgeFragment
}
}
}
Variables
{"input": UpdateDistributionByLockedBlockchainIdInput}
Response
{
"data": {
"updateDistributionByLockedBlockchainId": {
"clientMutationId": "xyz789",
"distribution": Distribution,
"query": Query,
"allocationByAllocationId": Allocation,
"accountByInvestorId": Account,
"distributionStatusByStatus": DistributionStatus,
"stepByStepId": Step,
"distributionEdge": DistributionsEdge
}
}
}
updateDistributionByNewId
Description
Updates a single Distribution using a unique key and a patch.
Response
Returns an UpdateDistributionPayload
Arguments
| Name | Description |
|---|---|
input - UpdateDistributionByNewIdInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation updateDistributionByNewId($input: UpdateDistributionByNewIdInput!) {
updateDistributionByNewId(input: $input) {
clientMutationId
distribution {
...DistributionFragment
}
query {
...QueryFragment
}
allocationByAllocationId {
...AllocationFragment
}
accountByInvestorId {
...AccountFragment
}
distributionStatusByStatus {
...DistributionStatusFragment
}
stepByStepId {
...StepFragment
}
distributionEdge {
...DistributionsEdgeFragment
}
}
}
Variables
{"input": UpdateDistributionByNewIdInput}
Response
{
"data": {
"updateDistributionByNewId": {
"clientMutationId": "xyz789",
"distribution": Distribution,
"query": Query,
"allocationByAllocationId": Allocation,
"accountByInvestorId": Account,
"distributionStatusByStatus": DistributionStatus,
"stepByStepId": Step,
"distributionEdge": DistributionsEdge
}
}
}
updateDistributionByOpenBlockchainId
Description
Updates a single Distribution using a unique key and a patch.
Response
Returns an UpdateDistributionPayload
Arguments
| Name | Description |
|---|---|
input - UpdateDistributionByOpenBlockchainIdInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation updateDistributionByOpenBlockchainId($input: UpdateDistributionByOpenBlockchainIdInput!) {
updateDistributionByOpenBlockchainId(input: $input) {
clientMutationId
distribution {
...DistributionFragment
}
query {
...QueryFragment
}
allocationByAllocationId {
...AllocationFragment
}
accountByInvestorId {
...AccountFragment
}
distributionStatusByStatus {
...DistributionStatusFragment
}
stepByStepId {
...StepFragment
}
distributionEdge {
...DistributionsEdgeFragment
}
}
}
Variables
{"input": UpdateDistributionByOpenBlockchainIdInput}
Response
{
"data": {
"updateDistributionByOpenBlockchainId": {
"clientMutationId": "xyz789",
"distribution": Distribution,
"query": Query,
"allocationByAllocationId": Allocation,
"accountByInvestorId": Account,
"distributionStatusByStatus": DistributionStatus,
"stepByStepId": Step,
"distributionEdge": DistributionsEdge
}
}
}
updateDistributionByStepId
Description
Updates a single Distribution using a unique key and a patch.
Response
Returns an UpdateDistributionPayload
Arguments
| Name | Description |
|---|---|
input - UpdateDistributionByStepIdInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation updateDistributionByStepId($input: UpdateDistributionByStepIdInput!) {
updateDistributionByStepId(input: $input) {
clientMutationId
distribution {
...DistributionFragment
}
query {
...QueryFragment
}
allocationByAllocationId {
...AllocationFragment
}
accountByInvestorId {
...AccountFragment
}
distributionStatusByStatus {
...DistributionStatusFragment
}
stepByStepId {
...StepFragment
}
distributionEdge {
...DistributionsEdgeFragment
}
}
}
Variables
{"input": UpdateDistributionByStepIdInput}
Response
{
"data": {
"updateDistributionByStepId": {
"clientMutationId": "xyz789",
"distribution": Distribution,
"query": Query,
"allocationByAllocationId": Allocation,
"accountByInvestorId": Account,
"distributionStatusByStatus": DistributionStatus,
"stepByStepId": Step,
"distributionEdge": DistributionsEdge
}
}
}
updateDistributionCustomField
Description
Updates a single DistributionCustomField using its globally unique id and a patch.
Response
Returns an UpdateDistributionCustomFieldPayload
Arguments
| Name | Description |
|---|---|
input - UpdateDistributionCustomFieldInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation updateDistributionCustomField($input: UpdateDistributionCustomFieldInput!) {
updateDistributionCustomField(input: $input) {
clientMutationId
distributionCustomField {
...DistributionCustomFieldFragment
}
query {
...QueryFragment
}
accountByCreatedBy {
...AccountFragment
}
distributionByDistributionId {
...DistributionFragment
}
distributionCustomFieldEdge {
...DistributionCustomFieldsEdgeFragment
}
}
}
Variables
{"input": UpdateDistributionCustomFieldInput}
Response
{
"data": {
"updateDistributionCustomField": {
"clientMutationId": "xyz789",
"distributionCustomField": DistributionCustomField,
"query": Query,
"accountByCreatedBy": Account,
"distributionByDistributionId": Distribution,
"distributionCustomFieldEdge": DistributionCustomFieldsEdge
}
}
}
updateDistributionCustomFieldById
Description
Updates a single DistributionCustomField using a unique key and a patch.
Response
Returns an UpdateDistributionCustomFieldPayload
Arguments
| Name | Description |
|---|---|
input - UpdateDistributionCustomFieldByIdInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation updateDistributionCustomFieldById($input: UpdateDistributionCustomFieldByIdInput!) {
updateDistributionCustomFieldById(input: $input) {
clientMutationId
distributionCustomField {
...DistributionCustomFieldFragment
}
query {
...QueryFragment
}
accountByCreatedBy {
...AccountFragment
}
distributionByDistributionId {
...DistributionFragment
}
distributionCustomFieldEdge {
...DistributionCustomFieldsEdgeFragment
}
}
}
Variables
{"input": UpdateDistributionCustomFieldByIdInput}
Response
{
"data": {
"updateDistributionCustomFieldById": {
"clientMutationId": "abc123",
"distributionCustomField": DistributionCustomField,
"query": Query,
"accountByCreatedBy": Account,
"distributionByDistributionId": Distribution,
"distributionCustomFieldEdge": DistributionCustomFieldsEdge
}
}
}
updateDistributionPayment
Description
Updates a single DistributionPayment using its globally unique id and a patch.
Response
Returns an UpdateDistributionPaymentPayload
Arguments
| Name | Description |
|---|---|
input - UpdateDistributionPaymentInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation updateDistributionPayment($input: UpdateDistributionPaymentInput!) {
updateDistributionPayment(input: $input) {
clientMutationId
distributionPayment {
...DistributionPaymentFragment
}
query {
...QueryFragment
}
distributionByDistributionId {
...DistributionFragment
}
currencyByCurrency {
...CurrencyFragment
}
distributionPaymentStatusByStatus {
...DistributionPaymentStatusFragment
}
distributionPaymentEdge {
...DistributionPaymentsEdgeFragment
}
}
}
Variables
{"input": UpdateDistributionPaymentInput}
Response
{
"data": {
"updateDistributionPayment": {
"clientMutationId": "xyz789",
"distributionPayment": DistributionPayment,
"query": Query,
"distributionByDistributionId": Distribution,
"currencyByCurrency": Currency,
"distributionPaymentStatusByStatus": DistributionPaymentStatus,
"distributionPaymentEdge": DistributionPaymentsEdge
}
}
}
updateDistributionPaymentById
Description
Updates a single DistributionPayment using a unique key and a patch.
Response
Returns an UpdateDistributionPaymentPayload
Arguments
| Name | Description |
|---|---|
input - UpdateDistributionPaymentByIdInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation updateDistributionPaymentById($input: UpdateDistributionPaymentByIdInput!) {
updateDistributionPaymentById(input: $input) {
clientMutationId
distributionPayment {
...DistributionPaymentFragment
}
query {
...QueryFragment
}
distributionByDistributionId {
...DistributionFragment
}
currencyByCurrency {
...CurrencyFragment
}
distributionPaymentStatusByStatus {
...DistributionPaymentStatusFragment
}
distributionPaymentEdge {
...DistributionPaymentsEdgeFragment
}
}
}
Variables
{"input": UpdateDistributionPaymentByIdInput}
Response
{
"data": {
"updateDistributionPaymentById": {
"clientMutationId": "abc123",
"distributionPayment": DistributionPayment,
"query": Query,
"distributionByDistributionId": Distribution,
"currencyByCurrency": Currency,
"distributionPaymentStatusByStatus": DistributionPaymentStatus,
"distributionPaymentEdge": DistributionPaymentsEdge
}
}
}
updateDistributionPrice
Description
Updates a single DistributionPrice using its globally unique id and a patch.
Response
Returns an UpdateDistributionPricePayload
Arguments
| Name | Description |
|---|---|
input - UpdateDistributionPriceInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation updateDistributionPrice($input: UpdateDistributionPriceInput!) {
updateDistributionPrice(input: $input) {
clientMutationId
distributionPrice {
...DistributionPriceFragment
}
query {
...QueryFragment
}
distributionByDistributionId {
...DistributionFragment
}
currencyByCurrency {
...CurrencyFragment
}
distributionPriceEdge {
...DistributionPricesEdgeFragment
}
}
}
Variables
{"input": UpdateDistributionPriceInput}
Response
{
"data": {
"updateDistributionPrice": {
"clientMutationId": "abc123",
"distributionPrice": DistributionPrice,
"query": Query,
"distributionByDistributionId": Distribution,
"currencyByCurrency": Currency,
"distributionPriceEdge": DistributionPricesEdge
}
}
}
updateDistributionPriceById
Description
Updates a single DistributionPrice using a unique key and a patch.
Response
Returns an UpdateDistributionPricePayload
Arguments
| Name | Description |
|---|---|
input - UpdateDistributionPriceByIdInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation updateDistributionPriceById($input: UpdateDistributionPriceByIdInput!) {
updateDistributionPriceById(input: $input) {
clientMutationId
distributionPrice {
...DistributionPriceFragment
}
query {
...QueryFragment
}
distributionByDistributionId {
...DistributionFragment
}
currencyByCurrency {
...CurrencyFragment
}
distributionPriceEdge {
...DistributionPricesEdgeFragment
}
}
}
Variables
{"input": UpdateDistributionPriceByIdInput}
Response
{
"data": {
"updateDistributionPriceById": {
"clientMutationId": "abc123",
"distributionPrice": DistributionPrice,
"query": Query,
"distributionByDistributionId": Distribution,
"currencyByCurrency": Currency,
"distributionPriceEdge": DistributionPricesEdge
}
}
}
updateDistributionQualificationOrder
Response
Returns an UpdateDistributionQualificationOrderPayload
Arguments
| Name | Description |
|---|---|
input - UpdateDistributionQualificationOrderInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation updateDistributionQualificationOrder($input: UpdateDistributionQualificationOrderInput!) {
updateDistributionQualificationOrder(input: $input) {
clientMutationId
distribution {
...DistributionFragment
}
query {
...QueryFragment
}
allocationByAllocationId {
...AllocationFragment
}
accountByInvestorId {
...AccountFragment
}
distributionStatusByStatus {
...DistributionStatusFragment
}
stepByStepId {
...StepFragment
}
distributionEdge {
...DistributionsEdgeFragment
}
}
}
Variables
{"input": UpdateDistributionQualificationOrderInput}
Response
{
"data": {
"updateDistributionQualificationOrder": {
"clientMutationId": "xyz789",
"distribution": Distribution,
"query": Query,
"allocationByAllocationId": Allocation,
"accountByInvestorId": Account,
"distributionStatusByStatus": DistributionStatus,
"stepByStepId": Step,
"distributionEdge": DistributionsEdge
}
}
}
updateDocumentStatus
Description
Updates a single DocumentStatus using its globally unique id and a patch.
Response
Returns an UpdateDocumentStatusPayload
Arguments
| Name | Description |
|---|---|
input - UpdateDocumentStatusInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation updateDocumentStatus($input: UpdateDocumentStatusInput!) {
updateDocumentStatus(input: $input) {
clientMutationId
documentStatus {
...DocumentStatusFragment
}
query {
...QueryFragment
}
documentStatusEdge {
...DocumentStatusesEdgeFragment
}
}
}
Variables
{"input": UpdateDocumentStatusInput}
Response
{
"data": {
"updateDocumentStatus": {
"clientMutationId": "abc123",
"documentStatus": DocumentStatus,
"query": Query,
"documentStatusEdge": DocumentStatusesEdge
}
}
}
updateDocumentStatusByStatus
Description
Updates a single DocumentStatus using a unique key and a patch.
Response
Returns an UpdateDocumentStatusPayload
Arguments
| Name | Description |
|---|---|
input - UpdateDocumentStatusByStatusInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation updateDocumentStatusByStatus($input: UpdateDocumentStatusByStatusInput!) {
updateDocumentStatusByStatus(input: $input) {
clientMutationId
documentStatus {
...DocumentStatusFragment
}
query {
...QueryFragment
}
documentStatusEdge {
...DocumentStatusesEdgeFragment
}
}
}
Variables
{"input": UpdateDocumentStatusByStatusInput}
Response
{
"data": {
"updateDocumentStatusByStatus": {
"clientMutationId": "xyz789",
"documentStatus": DocumentStatus,
"query": Query,
"documentStatusEdge": DocumentStatusesEdge
}
}
}
updateEmailTemplateTo
Description
Updates a single EmailTemplateTo using its globally unique id and a patch.
Response
Returns an UpdateEmailTemplateToPayload
Arguments
| Name | Description |
|---|---|
input - UpdateEmailTemplateToInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation updateEmailTemplateTo($input: UpdateEmailTemplateToInput!) {
updateEmailTemplateTo(input: $input) {
clientMutationId
emailTemplateTo {
...EmailTemplateToFragment
}
query {
...QueryFragment
}
emailTemplateToEdge {
...EmailTemplateTosEdgeFragment
}
}
}
Variables
{"input": UpdateEmailTemplateToInput}
Response
{
"data": {
"updateEmailTemplateTo": {
"clientMutationId": "xyz789",
"emailTemplateTo": EmailTemplateTo,
"query": Query,
"emailTemplateToEdge": EmailTemplateTosEdge
}
}
}
updateEmailTemplateToByTo
Description
Updates a single EmailTemplateTo using a unique key and a patch.
Response
Returns an UpdateEmailTemplateToPayload
Arguments
| Name | Description |
|---|---|
input - UpdateEmailTemplateToByToInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation updateEmailTemplateToByTo($input: UpdateEmailTemplateToByToInput!) {
updateEmailTemplateToByTo(input: $input) {
clientMutationId
emailTemplateTo {
...EmailTemplateToFragment
}
query {
...QueryFragment
}
emailTemplateToEdge {
...EmailTemplateTosEdgeFragment
}
}
}
Variables
{"input": UpdateEmailTemplateToByToInput}
Response
{
"data": {
"updateEmailTemplateToByTo": {
"clientMutationId": "xyz789",
"emailTemplateTo": EmailTemplateTo,
"query": Query,
"emailTemplateToEdge": EmailTemplateTosEdge
}
}
}
updateInstancedAccountInformationHistory
Description
Updates a single InstancedAccountInformationHistory using its globally unique id and a patch.
Response
Arguments
| Name | Description |
|---|---|
input - UpdateInstancedAccountInformationHistoryInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation updateInstancedAccountInformationHistory($input: UpdateInstancedAccountInformationHistoryInput!) {
updateInstancedAccountInformationHistory(input: $input) {
clientMutationId
instancedAccountInformationHistory {
...InstancedAccountInformationHistoryFragment
}
query {
...QueryFragment
}
instancedAccountInformationByRecordId {
...InstancedAccountInformationFragment
}
instancedAccountInformationHistoryEdge {
...InstancedAccountInformationHistoriesEdgeFragment
}
}
}
Variables
{"input": UpdateInstancedAccountInformationHistoryInput}
Response
{
"data": {
"updateInstancedAccountInformationHistory": {
"clientMutationId": "xyz789",
"instancedAccountInformationHistory": InstancedAccountInformationHistory,
"query": Query,
"instancedAccountInformationByRecordId": InstancedAccountInformation,
"instancedAccountInformationHistoryEdge": InstancedAccountInformationHistoriesEdge
}
}
}
updateInstancedAccountInformationHistoryById
Description
Updates a single InstancedAccountInformationHistory using a unique key and a patch.
Response
Arguments
| Name | Description |
|---|---|
input - UpdateInstancedAccountInformationHistoryByIdInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation updateInstancedAccountInformationHistoryById($input: UpdateInstancedAccountInformationHistoryByIdInput!) {
updateInstancedAccountInformationHistoryById(input: $input) {
clientMutationId
instancedAccountInformationHistory {
...InstancedAccountInformationHistoryFragment
}
query {
...QueryFragment
}
instancedAccountInformationByRecordId {
...InstancedAccountInformationFragment
}
instancedAccountInformationHistoryEdge {
...InstancedAccountInformationHistoriesEdgeFragment
}
}
}
Variables
{
"input": UpdateInstancedAccountInformationHistoryByIdInput
}
Response
{
"data": {
"updateInstancedAccountInformationHistoryById": {
"clientMutationId": "abc123",
"instancedAccountInformationHistory": InstancedAccountInformationHistory,
"query": Query,
"instancedAccountInformationByRecordId": InstancedAccountInformation,
"instancedAccountInformationHistoryEdge": InstancedAccountInformationHistoriesEdge
}
}
}
updateMappedSigningTemplate
Description
Updates a single MappedSigningTemplate using its globally unique id and a patch.
Response
Returns an UpdateMappedSigningTemplatePayload
Arguments
| Name | Description |
|---|---|
input - UpdateMappedSigningTemplateInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation updateMappedSigningTemplate($input: UpdateMappedSigningTemplateInput!) {
updateMappedSigningTemplate(input: $input) {
clientMutationId
mappedSigningTemplate {
...MappedSigningTemplateFragment
}
query {
...QueryFragment
}
accountByAccountId {
...AccountFragment
}
signingTemplateBySigningTemplateId {
...SigningTemplateFragment
}
stepByStepId {
...StepFragment
}
vendorQualificationByVendorQualificationId {
...VendorQualificationFragment
}
signingStepTypeByQualificationStepType {
...SigningStepTypeFragment
}
mappedSigningTemplateEdge {
...MappedSigningTemplatesEdgeFragment
}
}
}
Variables
{"input": UpdateMappedSigningTemplateInput}
Response
{
"data": {
"updateMappedSigningTemplate": {
"clientMutationId": "abc123",
"mappedSigningTemplate": MappedSigningTemplate,
"query": Query,
"accountByAccountId": Account,
"signingTemplateBySigningTemplateId": SigningTemplate,
"stepByStepId": Step,
"vendorQualificationByVendorQualificationId": VendorQualification,
"signingStepTypeByQualificationStepType": SigningStepType,
"mappedSigningTemplateEdge": MappedSigningTemplatesEdge
}
}
}
updateMappedSigningTemplateByAccountIdAndName
Description
Updates a single MappedSigningTemplate using a unique key and a patch.
Response
Returns an UpdateMappedSigningTemplatePayload
Arguments
| Name | Description |
|---|---|
input - UpdateMappedSigningTemplateByAccountIdAndNameInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation updateMappedSigningTemplateByAccountIdAndName($input: UpdateMappedSigningTemplateByAccountIdAndNameInput!) {
updateMappedSigningTemplateByAccountIdAndName(input: $input) {
clientMutationId
mappedSigningTemplate {
...MappedSigningTemplateFragment
}
query {
...QueryFragment
}
accountByAccountId {
...AccountFragment
}
signingTemplateBySigningTemplateId {
...SigningTemplateFragment
}
stepByStepId {
...StepFragment
}
vendorQualificationByVendorQualificationId {
...VendorQualificationFragment
}
signingStepTypeByQualificationStepType {
...SigningStepTypeFragment
}
mappedSigningTemplateEdge {
...MappedSigningTemplatesEdgeFragment
}
}
}
Variables
{
"input": UpdateMappedSigningTemplateByAccountIdAndNameInput
}
Response
{
"data": {
"updateMappedSigningTemplateByAccountIdAndName": {
"clientMutationId": "xyz789",
"mappedSigningTemplate": MappedSigningTemplate,
"query": Query,
"accountByAccountId": Account,
"signingTemplateBySigningTemplateId": SigningTemplate,
"stepByStepId": Step,
"vendorQualificationByVendorQualificationId": VendorQualification,
"signingStepTypeByQualificationStepType": SigningStepType,
"mappedSigningTemplateEdge": MappedSigningTemplatesEdge
}
}
}
updateMappedSigningTemplateById
Description
Updates a single MappedSigningTemplate using a unique key and a patch.
Response
Returns an UpdateMappedSigningTemplatePayload
Arguments
| Name | Description |
|---|---|
input - UpdateMappedSigningTemplateByIdInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation updateMappedSigningTemplateById($input: UpdateMappedSigningTemplateByIdInput!) {
updateMappedSigningTemplateById(input: $input) {
clientMutationId
mappedSigningTemplate {
...MappedSigningTemplateFragment
}
query {
...QueryFragment
}
accountByAccountId {
...AccountFragment
}
signingTemplateBySigningTemplateId {
...SigningTemplateFragment
}
stepByStepId {
...StepFragment
}
vendorQualificationByVendorQualificationId {
...VendorQualificationFragment
}
signingStepTypeByQualificationStepType {
...SigningStepTypeFragment
}
mappedSigningTemplateEdge {
...MappedSigningTemplatesEdgeFragment
}
}
}
Variables
{"input": UpdateMappedSigningTemplateByIdInput}
Response
{
"data": {
"updateMappedSigningTemplateById": {
"clientMutationId": "abc123",
"mappedSigningTemplate": MappedSigningTemplate,
"query": Query,
"accountByAccountId": Account,
"signingTemplateBySigningTemplateId": SigningTemplate,
"stepByStepId": Step,
"vendorQualificationByVendorQualificationId": VendorQualification,
"signingStepTypeByQualificationStepType": SigningStepType,
"mappedSigningTemplateEdge": MappedSigningTemplatesEdge
}
}
}
updateMappedSigningTemplateByStepId
Description
Updates a single MappedSigningTemplate using a unique key and a patch.
Response
Returns an UpdateMappedSigningTemplatePayload
Arguments
| Name | Description |
|---|---|
input - UpdateMappedSigningTemplateByStepIdInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation updateMappedSigningTemplateByStepId($input: UpdateMappedSigningTemplateByStepIdInput!) {
updateMappedSigningTemplateByStepId(input: $input) {
clientMutationId
mappedSigningTemplate {
...MappedSigningTemplateFragment
}
query {
...QueryFragment
}
accountByAccountId {
...AccountFragment
}
signingTemplateBySigningTemplateId {
...SigningTemplateFragment
}
stepByStepId {
...StepFragment
}
vendorQualificationByVendorQualificationId {
...VendorQualificationFragment
}
signingStepTypeByQualificationStepType {
...SigningStepTypeFragment
}
mappedSigningTemplateEdge {
...MappedSigningTemplatesEdgeFragment
}
}
}
Variables
{"input": UpdateMappedSigningTemplateByStepIdInput}
Response
{
"data": {
"updateMappedSigningTemplateByStepId": {
"clientMutationId": "xyz789",
"mappedSigningTemplate": MappedSigningTemplate,
"query": Query,
"accountByAccountId": Account,
"signingTemplateBySigningTemplateId": SigningTemplate,
"stepByStepId": Step,
"vendorQualificationByVendorQualificationId": VendorQualification,
"signingStepTypeByQualificationStepType": SigningStepType,
"mappedSigningTemplateEdge": MappedSigningTemplatesEdge
}
}
}
updateMappedSigningTemplateByVendorQualificationId
Description
Updates a single MappedSigningTemplate using a unique key and a patch.
Response
Returns an UpdateMappedSigningTemplatePayload
Arguments
| Name | Description |
|---|---|
input - UpdateMappedSigningTemplateByVendorQualificationIdInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation updateMappedSigningTemplateByVendorQualificationId($input: UpdateMappedSigningTemplateByVendorQualificationIdInput!) {
updateMappedSigningTemplateByVendorQualificationId(input: $input) {
clientMutationId
mappedSigningTemplate {
...MappedSigningTemplateFragment
}
query {
...QueryFragment
}
accountByAccountId {
...AccountFragment
}
signingTemplateBySigningTemplateId {
...SigningTemplateFragment
}
stepByStepId {
...StepFragment
}
vendorQualificationByVendorQualificationId {
...VendorQualificationFragment
}
signingStepTypeByQualificationStepType {
...SigningStepTypeFragment
}
mappedSigningTemplateEdge {
...MappedSigningTemplatesEdgeFragment
}
}
}
Variables
{
"input": UpdateMappedSigningTemplateByVendorQualificationIdInput
}
Response
{
"data": {
"updateMappedSigningTemplateByVendorQualificationId": {
"clientMutationId": "abc123",
"mappedSigningTemplate": MappedSigningTemplate,
"query": Query,
"accountByAccountId": Account,
"signingTemplateBySigningTemplateId": SigningTemplate,
"stepByStepId": Step,
"vendorQualificationByVendorQualificationId": VendorQualification,
"signingStepTypeByQualificationStepType": SigningStepType,
"mappedSigningTemplateEdge": MappedSigningTemplatesEdge
}
}
}
updateMappedSigningTemplateQuestionSet
Description
Updates a single MappedSigningTemplateQuestionSet using its globally unique id and a patch.
Response
Arguments
| Name | Description |
|---|---|
input - UpdateMappedSigningTemplateQuestionSetInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation updateMappedSigningTemplateQuestionSet($input: UpdateMappedSigningTemplateQuestionSetInput!) {
updateMappedSigningTemplateQuestionSet(input: $input) {
clientMutationId
mappedSigningTemplateQuestionSet {
...MappedSigningTemplateQuestionSetFragment
}
query {
...QueryFragment
}
onboardingQuestionSetByOnboardingQuestionSetId {
...OnboardingQuestionSetFragment
}
mappedSigningTemplateByMappedSigningTemplateId {
...MappedSigningTemplateFragment
}
mappedSigningTemplateQuestionSetEdge {
...MappedSigningTemplateQuestionSetsEdgeFragment
}
}
}
Variables
{"input": UpdateMappedSigningTemplateQuestionSetInput}
Response
{
"data": {
"updateMappedSigningTemplateQuestionSet": {
"clientMutationId": "abc123",
"mappedSigningTemplateQuestionSet": MappedSigningTemplateQuestionSet,
"query": Query,
"onboardingQuestionSetByOnboardingQuestionSetId": OnboardingQuestionSet,
"mappedSigningTemplateByMappedSigningTemplateId": MappedSigningTemplate,
"mappedSigningTemplateQuestionSetEdge": MappedSigningTemplateQuestionSetsEdge
}
}
}
updateMappedSigningTemplateQuestionSetById
Description
Updates a single MappedSigningTemplateQuestionSet using a unique key and a patch.
Response
Arguments
| Name | Description |
|---|---|
input - UpdateMappedSigningTemplateQuestionSetByIdInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation updateMappedSigningTemplateQuestionSetById($input: UpdateMappedSigningTemplateQuestionSetByIdInput!) {
updateMappedSigningTemplateQuestionSetById(input: $input) {
clientMutationId
mappedSigningTemplateQuestionSet {
...MappedSigningTemplateQuestionSetFragment
}
query {
...QueryFragment
}
onboardingQuestionSetByOnboardingQuestionSetId {
...OnboardingQuestionSetFragment
}
mappedSigningTemplateByMappedSigningTemplateId {
...MappedSigningTemplateFragment
}
mappedSigningTemplateQuestionSetEdge {
...MappedSigningTemplateQuestionSetsEdgeFragment
}
}
}
Variables
{"input": UpdateMappedSigningTemplateQuestionSetByIdInput}
Response
{
"data": {
"updateMappedSigningTemplateQuestionSetById": {
"clientMutationId": "xyz789",
"mappedSigningTemplateQuestionSet": MappedSigningTemplateQuestionSet,
"query": Query,
"onboardingQuestionSetByOnboardingQuestionSetId": OnboardingQuestionSet,
"mappedSigningTemplateByMappedSigningTemplateId": MappedSigningTemplate,
"mappedSigningTemplateQuestionSetEdge": MappedSigningTemplateQuestionSetsEdge
}
}
}
updateMappedSigningTemplateQuestionSetByOnboardingQuestionSetIdAndMappedSigningTemplateId
Description
Updates a single MappedSigningTemplateQuestionSet using a unique key and a patch.
Response
Arguments
| Name | Description |
|---|---|
input - UpdateMappedSigningTemplateQuestionSetByOnboardingQuestionSetIdAndMappedSigningTemplateIdInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation updateMappedSigningTemplateQuestionSetByOnboardingQuestionSetIdAndMappedSigningTemplateId($input: UpdateMappedSigningTemplateQuestionSetByOnboardingQuestionSetIdAndMappedSigningTemplateIdInput!) {
updateMappedSigningTemplateQuestionSetByOnboardingQuestionSetIdAndMappedSigningTemplateId(input: $input) {
clientMutationId
mappedSigningTemplateQuestionSet {
...MappedSigningTemplateQuestionSetFragment
}
query {
...QueryFragment
}
onboardingQuestionSetByOnboardingQuestionSetId {
...OnboardingQuestionSetFragment
}
mappedSigningTemplateByMappedSigningTemplateId {
...MappedSigningTemplateFragment
}
mappedSigningTemplateQuestionSetEdge {
...MappedSigningTemplateQuestionSetsEdgeFragment
}
}
}
Variables
{
"input": UpdateMappedSigningTemplateQuestionSetByOnboardingQuestionSetIdAndMappedSigningTemplateIdInput
}
Response
{
"data": {
"updateMappedSigningTemplateQuestionSetByOnboardingQuestionSetIdAndMappedSigningTemplateId": {
"clientMutationId": "abc123",
"mappedSigningTemplateQuestionSet": MappedSigningTemplateQuestionSet,
"query": Query,
"onboardingQuestionSetByOnboardingQuestionSetId": OnboardingQuestionSet,
"mappedSigningTemplateByMappedSigningTemplateId": MappedSigningTemplate,
"mappedSigningTemplateQuestionSetEdge": MappedSigningTemplateQuestionSetsEdge
}
}
}
updateOnboardingQuestion
Description
Updates a single OnboardingQuestion using its globally unique id and a patch.
Response
Returns an UpdateOnboardingQuestionPayload
Arguments
| Name | Description |
|---|---|
input - UpdateOnboardingQuestionInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation updateOnboardingQuestion($input: UpdateOnboardingQuestionInput!) {
updateOnboardingQuestion(input: $input) {
clientMutationId
onboardingQuestion {
...OnboardingQuestionFragment
}
query {
...QueryFragment
}
accountByAccountId {
...AccountFragment
}
onboardingQuestionTypeByType {
...OnboardingQuestionTypeFragment
}
onboardingQuestionEdge {
...OnboardingQuestionsEdgeFragment
}
}
}
Variables
{"input": UpdateOnboardingQuestionInput}
Response
{
"data": {
"updateOnboardingQuestion": {
"clientMutationId": "abc123",
"onboardingQuestion": OnboardingQuestion,
"query": Query,
"accountByAccountId": Account,
"onboardingQuestionTypeByType": OnboardingQuestionType,
"onboardingQuestionEdge": OnboardingQuestionsEdge
}
}
}
updateOnboardingQuestionByAccountIdAndName
Description
Updates a single OnboardingQuestion using a unique key and a patch.
Response
Returns an UpdateOnboardingQuestionPayload
Arguments
| Name | Description |
|---|---|
input - UpdateOnboardingQuestionByAccountIdAndNameInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation updateOnboardingQuestionByAccountIdAndName($input: UpdateOnboardingQuestionByAccountIdAndNameInput!) {
updateOnboardingQuestionByAccountIdAndName(input: $input) {
clientMutationId
onboardingQuestion {
...OnboardingQuestionFragment
}
query {
...QueryFragment
}
accountByAccountId {
...AccountFragment
}
onboardingQuestionTypeByType {
...OnboardingQuestionTypeFragment
}
onboardingQuestionEdge {
...OnboardingQuestionsEdgeFragment
}
}
}
Variables
{"input": UpdateOnboardingQuestionByAccountIdAndNameInput}
Response
{
"data": {
"updateOnboardingQuestionByAccountIdAndName": {
"clientMutationId": "abc123",
"onboardingQuestion": OnboardingQuestion,
"query": Query,
"accountByAccountId": Account,
"onboardingQuestionTypeByType": OnboardingQuestionType,
"onboardingQuestionEdge": OnboardingQuestionsEdge
}
}
}
updateOnboardingQuestionById
Description
Updates a single OnboardingQuestion using a unique key and a patch.
Response
Returns an UpdateOnboardingQuestionPayload
Arguments
| Name | Description |
|---|---|
input - UpdateOnboardingQuestionByIdInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation updateOnboardingQuestionById($input: UpdateOnboardingQuestionByIdInput!) {
updateOnboardingQuestionById(input: $input) {
clientMutationId
onboardingQuestion {
...OnboardingQuestionFragment
}
query {
...QueryFragment
}
accountByAccountId {
...AccountFragment
}
onboardingQuestionTypeByType {
...OnboardingQuestionTypeFragment
}
onboardingQuestionEdge {
...OnboardingQuestionsEdgeFragment
}
}
}
Variables
{"input": UpdateOnboardingQuestionByIdInput}
Response
{
"data": {
"updateOnboardingQuestionById": {
"clientMutationId": "abc123",
"onboardingQuestion": OnboardingQuestion,
"query": Query,
"accountByAccountId": Account,
"onboardingQuestionTypeByType": OnboardingQuestionType,
"onboardingQuestionEdge": OnboardingQuestionsEdge
}
}
}
updateOnboardingQuestionSet
Description
Updates a single OnboardingQuestionSet using its globally unique id and a patch.
Response
Returns an UpdateOnboardingQuestionSetPayload
Arguments
| Name | Description |
|---|---|
input - UpdateOnboardingQuestionSetInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation updateOnboardingQuestionSet($input: UpdateOnboardingQuestionSetInput!) {
updateOnboardingQuestionSet(input: $input) {
clientMutationId
onboardingQuestionSet {
...OnboardingQuestionSetFragment
}
query {
...QueryFragment
}
accountByAccountId {
...AccountFragment
}
vendorQualificationByVendorQualificationId {
...VendorQualificationFragment
}
onboardingQuestionSetEdge {
...OnboardingQuestionSetsEdgeFragment
}
}
}
Variables
{"input": UpdateOnboardingQuestionSetInput}
Response
{
"data": {
"updateOnboardingQuestionSet": {
"clientMutationId": "abc123",
"onboardingQuestionSet": OnboardingQuestionSet,
"query": Query,
"accountByAccountId": Account,
"vendorQualificationByVendorQualificationId": VendorQualification,
"onboardingQuestionSetEdge": OnboardingQuestionSetsEdge
}
}
}
updateOnboardingQuestionSetByAccountIdAndName
Description
Updates a single OnboardingQuestionSet using a unique key and a patch.
Response
Returns an UpdateOnboardingQuestionSetPayload
Arguments
| Name | Description |
|---|---|
input - UpdateOnboardingQuestionSetByAccountIdAndNameInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation updateOnboardingQuestionSetByAccountIdAndName($input: UpdateOnboardingQuestionSetByAccountIdAndNameInput!) {
updateOnboardingQuestionSetByAccountIdAndName(input: $input) {
clientMutationId
onboardingQuestionSet {
...OnboardingQuestionSetFragment
}
query {
...QueryFragment
}
accountByAccountId {
...AccountFragment
}
vendorQualificationByVendorQualificationId {
...VendorQualificationFragment
}
onboardingQuestionSetEdge {
...OnboardingQuestionSetsEdgeFragment
}
}
}
Variables
{
"input": UpdateOnboardingQuestionSetByAccountIdAndNameInput
}
Response
{
"data": {
"updateOnboardingQuestionSetByAccountIdAndName": {
"clientMutationId": "xyz789",
"onboardingQuestionSet": OnboardingQuestionSet,
"query": Query,
"accountByAccountId": Account,
"vendorQualificationByVendorQualificationId": VendorQualification,
"onboardingQuestionSetEdge": OnboardingQuestionSetsEdge
}
}
}
updateOnboardingQuestionSetById
Description
Updates a single OnboardingQuestionSet using a unique key and a patch.
Response
Returns an UpdateOnboardingQuestionSetPayload
Arguments
| Name | Description |
|---|---|
input - UpdateOnboardingQuestionSetByIdInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation updateOnboardingQuestionSetById($input: UpdateOnboardingQuestionSetByIdInput!) {
updateOnboardingQuestionSetById(input: $input) {
clientMutationId
onboardingQuestionSet {
...OnboardingQuestionSetFragment
}
query {
...QueryFragment
}
accountByAccountId {
...AccountFragment
}
vendorQualificationByVendorQualificationId {
...VendorQualificationFragment
}
onboardingQuestionSetEdge {
...OnboardingQuestionSetsEdgeFragment
}
}
}
Variables
{"input": UpdateOnboardingQuestionSetByIdInput}
Response
{
"data": {
"updateOnboardingQuestionSetById": {
"clientMutationId": "xyz789",
"onboardingQuestionSet": OnboardingQuestionSet,
"query": Query,
"accountByAccountId": Account,
"vendorQualificationByVendorQualificationId": VendorQualification,
"onboardingQuestionSetEdge": OnboardingQuestionSetsEdge
}
}
}
updateOnboardingQuestionSetByVendorQualificationId
Description
Updates a single OnboardingQuestionSet using a unique key and a patch.
Response
Returns an UpdateOnboardingQuestionSetPayload
Arguments
| Name | Description |
|---|---|
input - UpdateOnboardingQuestionSetByVendorQualificationIdInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation updateOnboardingQuestionSetByVendorQualificationId($input: UpdateOnboardingQuestionSetByVendorQualificationIdInput!) {
updateOnboardingQuestionSetByVendorQualificationId(input: $input) {
clientMutationId
onboardingQuestionSet {
...OnboardingQuestionSetFragment
}
query {
...QueryFragment
}
accountByAccountId {
...AccountFragment
}
vendorQualificationByVendorQualificationId {
...VendorQualificationFragment
}
onboardingQuestionSetEdge {
...OnboardingQuestionSetsEdgeFragment
}
}
}
Variables
{
"input": UpdateOnboardingQuestionSetByVendorQualificationIdInput
}
Response
{
"data": {
"updateOnboardingQuestionSetByVendorQualificationId": {
"clientMutationId": "xyz789",
"onboardingQuestionSet": OnboardingQuestionSet,
"query": Query,
"accountByAccountId": Account,
"vendorQualificationByVendorQualificationId": VendorQualification,
"onboardingQuestionSetEdge": OnboardingQuestionSetsEdge
}
}
}
updatePaymentMethod
Description
Updates a single PaymentMethod using its globally unique id and a patch.
Response
Returns an UpdatePaymentMethodPayload
Arguments
| Name | Description |
|---|---|
input - UpdatePaymentMethodInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation updatePaymentMethod($input: UpdatePaymentMethodInput!) {
updatePaymentMethod(input: $input) {
clientMutationId
paymentMethod {
...PaymentMethodFragment
}
query {
...QueryFragment
}
accountByAccountId {
...AccountFragment
}
integrationByIntegrationId {
...IntegrationFragment
}
paymentMethodTypeByType {
...PaymentMethodTypeFragment
}
paymentMethodEdge {
...PaymentMethodsEdgeFragment
}
}
}
Variables
{"input": UpdatePaymentMethodInput}
Response
{
"data": {
"updatePaymentMethod": {
"clientMutationId": "xyz789",
"paymentMethod": PaymentMethod,
"query": Query,
"accountByAccountId": Account,
"integrationByIntegrationId": Integration,
"paymentMethodTypeByType": PaymentMethodType,
"paymentMethodEdge": PaymentMethodsEdge
}
}
}
updatePaymentMethodByAccountIdAndName
Description
Updates a single PaymentMethod using a unique key and a patch.
Response
Returns an UpdatePaymentMethodPayload
Arguments
| Name | Description |
|---|---|
input - UpdatePaymentMethodByAccountIdAndNameInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation updatePaymentMethodByAccountIdAndName($input: UpdatePaymentMethodByAccountIdAndNameInput!) {
updatePaymentMethodByAccountIdAndName(input: $input) {
clientMutationId
paymentMethod {
...PaymentMethodFragment
}
query {
...QueryFragment
}
accountByAccountId {
...AccountFragment
}
integrationByIntegrationId {
...IntegrationFragment
}
paymentMethodTypeByType {
...PaymentMethodTypeFragment
}
paymentMethodEdge {
...PaymentMethodsEdgeFragment
}
}
}
Variables
{"input": UpdatePaymentMethodByAccountIdAndNameInput}
Response
{
"data": {
"updatePaymentMethodByAccountIdAndName": {
"clientMutationId": "abc123",
"paymentMethod": PaymentMethod,
"query": Query,
"accountByAccountId": Account,
"integrationByIntegrationId": Integration,
"paymentMethodTypeByType": PaymentMethodType,
"paymentMethodEdge": PaymentMethodsEdge
}
}
}
updatePaymentMethodByEncryptedRecordId
Description
Updates a single PaymentMethod using a unique key and a patch.
Response
Returns an UpdatePaymentMethodPayload
Arguments
| Name | Description |
|---|---|
input - UpdatePaymentMethodByEncryptedRecordIdInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation updatePaymentMethodByEncryptedRecordId($input: UpdatePaymentMethodByEncryptedRecordIdInput!) {
updatePaymentMethodByEncryptedRecordId(input: $input) {
clientMutationId
paymentMethod {
...PaymentMethodFragment
}
query {
...QueryFragment
}
accountByAccountId {
...AccountFragment
}
integrationByIntegrationId {
...IntegrationFragment
}
paymentMethodTypeByType {
...PaymentMethodTypeFragment
}
paymentMethodEdge {
...PaymentMethodsEdgeFragment
}
}
}
Variables
{"input": UpdatePaymentMethodByEncryptedRecordIdInput}
Response
{
"data": {
"updatePaymentMethodByEncryptedRecordId": {
"clientMutationId": "xyz789",
"paymentMethod": PaymentMethod,
"query": Query,
"accountByAccountId": Account,
"integrationByIntegrationId": Integration,
"paymentMethodTypeByType": PaymentMethodType,
"paymentMethodEdge": PaymentMethodsEdge
}
}
}
updatePaymentMethodById
Description
Updates a single PaymentMethod using a unique key and a patch.
Response
Returns an UpdatePaymentMethodPayload
Arguments
| Name | Description |
|---|---|
input - UpdatePaymentMethodByIdInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation updatePaymentMethodById($input: UpdatePaymentMethodByIdInput!) {
updatePaymentMethodById(input: $input) {
clientMutationId
paymentMethod {
...PaymentMethodFragment
}
query {
...QueryFragment
}
accountByAccountId {
...AccountFragment
}
integrationByIntegrationId {
...IntegrationFragment
}
paymentMethodTypeByType {
...PaymentMethodTypeFragment
}
paymentMethodEdge {
...PaymentMethodsEdgeFragment
}
}
}
Variables
{"input": UpdatePaymentMethodByIdInput}
Response
{
"data": {
"updatePaymentMethodById": {
"clientMutationId": "abc123",
"paymentMethod": PaymentMethod,
"query": Query,
"accountByAccountId": Account,
"integrationByIntegrationId": Integration,
"paymentMethodTypeByType": PaymentMethodType,
"paymentMethodEdge": PaymentMethodsEdge
}
}
}
updatePaymentMethodType
Description
Updates a single PaymentMethodType using its globally unique id and a patch.
Response
Returns an UpdatePaymentMethodTypePayload
Arguments
| Name | Description |
|---|---|
input - UpdatePaymentMethodTypeInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation updatePaymentMethodType($input: UpdatePaymentMethodTypeInput!) {
updatePaymentMethodType(input: $input) {
clientMutationId
paymentMethodType {
...PaymentMethodTypeFragment
}
query {
...QueryFragment
}
paymentMethodTypeEdge {
...PaymentMethodTypesEdgeFragment
}
}
}
Variables
{"input": UpdatePaymentMethodTypeInput}
Response
{
"data": {
"updatePaymentMethodType": {
"clientMutationId": "abc123",
"paymentMethodType": PaymentMethodType,
"query": Query,
"paymentMethodTypeEdge": PaymentMethodTypesEdge
}
}
}
updatePaymentMethodTypeByType
Description
Updates a single PaymentMethodType using a unique key and a patch.
Response
Returns an UpdatePaymentMethodTypePayload
Arguments
| Name | Description |
|---|---|
input - UpdatePaymentMethodTypeByTypeInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation updatePaymentMethodTypeByType($input: UpdatePaymentMethodTypeByTypeInput!) {
updatePaymentMethodTypeByType(input: $input) {
clientMutationId
paymentMethodType {
...PaymentMethodTypeFragment
}
query {
...QueryFragment
}
paymentMethodTypeEdge {
...PaymentMethodTypesEdgeFragment
}
}
}
Variables
{"input": UpdatePaymentMethodTypeByTypeInput}
Response
{
"data": {
"updatePaymentMethodTypeByType": {
"clientMutationId": "abc123",
"paymentMethodType": PaymentMethodType,
"query": Query,
"paymentMethodTypeEdge": PaymentMethodTypesEdge
}
}
}
updatePaymentStepType
Description
Updates a single PaymentStepType using its globally unique id and a patch.
Response
Returns an UpdatePaymentStepTypePayload
Arguments
| Name | Description |
|---|---|
input - UpdatePaymentStepTypeInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation updatePaymentStepType($input: UpdatePaymentStepTypeInput!) {
updatePaymentStepType(input: $input) {
clientMutationId
paymentStepType {
...PaymentStepTypeFragment
}
query {
...QueryFragment
}
paymentStepTypeEdge {
...PaymentStepTypesEdgeFragment
}
}
}
Variables
{"input": UpdatePaymentStepTypeInput}
Response
{
"data": {
"updatePaymentStepType": {
"clientMutationId": "abc123",
"paymentStepType": PaymentStepType,
"query": Query,
"paymentStepTypeEdge": PaymentStepTypesEdge
}
}
}
updatePaymentStepTypeByType
Description
Updates a single PaymentStepType using a unique key and a patch.
Response
Returns an UpdatePaymentStepTypePayload
Arguments
| Name | Description |
|---|---|
input - UpdatePaymentStepTypeByTypeInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation updatePaymentStepTypeByType($input: UpdatePaymentStepTypeByTypeInput!) {
updatePaymentStepTypeByType(input: $input) {
clientMutationId
paymentStepType {
...PaymentStepTypeFragment
}
query {
...QueryFragment
}
paymentStepTypeEdge {
...PaymentStepTypesEdgeFragment
}
}
}
Variables
{"input": UpdatePaymentStepTypeByTypeInput}
Response
{
"data": {
"updatePaymentStepTypeByType": {
"clientMutationId": "abc123",
"paymentStepType": PaymentStepType,
"query": Query,
"paymentStepTypeEdge": PaymentStepTypesEdge
}
}
}
updateRestrictionCategory
Description
Updates a single RestrictionCategory using its globally unique id and a patch.
Response
Returns an UpdateRestrictionCategoryPayload
Arguments
| Name | Description |
|---|---|
input - UpdateRestrictionCategoryInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation updateRestrictionCategory($input: UpdateRestrictionCategoryInput!) {
updateRestrictionCategory(input: $input) {
clientMutationId
restrictionCategory {
...RestrictionCategoryFragment
}
query {
...QueryFragment
}
restrictionCategoryEdge {
...RestrictionCategoriesEdgeFragment
}
}
}
Variables
{"input": UpdateRestrictionCategoryInput}
Response
{
"data": {
"updateRestrictionCategory": {
"clientMutationId": "abc123",
"restrictionCategory": RestrictionCategory,
"query": Query,
"restrictionCategoryEdge": RestrictionCategoriesEdge
}
}
}
updateRestrictionCategoryByCategory
Description
Updates a single RestrictionCategory using a unique key and a patch.
Response
Returns an UpdateRestrictionCategoryPayload
Arguments
| Name | Description |
|---|---|
input - UpdateRestrictionCategoryByCategoryInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation updateRestrictionCategoryByCategory($input: UpdateRestrictionCategoryByCategoryInput!) {
updateRestrictionCategoryByCategory(input: $input) {
clientMutationId
restrictionCategory {
...RestrictionCategoryFragment
}
query {
...QueryFragment
}
restrictionCategoryEdge {
...RestrictionCategoriesEdgeFragment
}
}
}
Variables
{"input": UpdateRestrictionCategoryByCategoryInput}
Response
{
"data": {
"updateRestrictionCategoryByCategory": {
"clientMutationId": "xyz789",
"restrictionCategory": RestrictionCategory,
"query": Query,
"restrictionCategoryEdge": RestrictionCategoriesEdge
}
}
}
updateRestrictionReason
Description
Updates a single RestrictionReason using its globally unique id and a patch.
Response
Returns an UpdateRestrictionReasonPayload
Arguments
| Name | Description |
|---|---|
input - UpdateRestrictionReasonInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation updateRestrictionReason($input: UpdateRestrictionReasonInput!) {
updateRestrictionReason(input: $input) {
clientMutationId
restrictionReason {
...RestrictionReasonFragment
}
query {
...QueryFragment
}
restrictionCategoryByCategory {
...RestrictionCategoryFragment
}
restrictionReasonEdge {
...RestrictionReasonsEdgeFragment
}
}
}
Variables
{"input": UpdateRestrictionReasonInput}
Response
{
"data": {
"updateRestrictionReason": {
"clientMutationId": "xyz789",
"restrictionReason": RestrictionReason,
"query": Query,
"restrictionCategoryByCategory": RestrictionCategory,
"restrictionReasonEdge": RestrictionReasonsEdge
}
}
}
updateRestrictionReasonById
Description
Updates a single RestrictionReason using a unique key and a patch.
Response
Returns an UpdateRestrictionReasonPayload
Arguments
| Name | Description |
|---|---|
input - UpdateRestrictionReasonByIdInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation updateRestrictionReasonById($input: UpdateRestrictionReasonByIdInput!) {
updateRestrictionReasonById(input: $input) {
clientMutationId
restrictionReason {
...RestrictionReasonFragment
}
query {
...QueryFragment
}
restrictionCategoryByCategory {
...RestrictionCategoryFragment
}
restrictionReasonEdge {
...RestrictionReasonsEdgeFragment
}
}
}
Variables
{"input": UpdateRestrictionReasonByIdInput}
Response
{
"data": {
"updateRestrictionReasonById": {
"clientMutationId": "abc123",
"restrictionReason": RestrictionReason,
"query": Query,
"restrictionCategoryByCategory": RestrictionCategory,
"restrictionReasonEdge": RestrictionReasonsEdge
}
}
}
updateRestrictionReasonByReason
Description
Updates a single RestrictionReason using a unique key and a patch.
Response
Returns an UpdateRestrictionReasonPayload
Arguments
| Name | Description |
|---|---|
input - UpdateRestrictionReasonByReasonInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation updateRestrictionReasonByReason($input: UpdateRestrictionReasonByReasonInput!) {
updateRestrictionReasonByReason(input: $input) {
clientMutationId
restrictionReason {
...RestrictionReasonFragment
}
query {
...QueryFragment
}
restrictionCategoryByCategory {
...RestrictionCategoryFragment
}
restrictionReasonEdge {
...RestrictionReasonsEdgeFragment
}
}
}
Variables
{"input": UpdateRestrictionReasonByReasonInput}
Response
{
"data": {
"updateRestrictionReasonByReason": {
"clientMutationId": "abc123",
"restrictionReason": RestrictionReason,
"query": Query,
"restrictionCategoryByCategory": RestrictionCategory,
"restrictionReasonEdge": RestrictionReasonsEdge
}
}
}
updateRound
Description
Updates a single Round using its globally unique id and a patch.
Response
Returns an UpdateRoundPayload
Arguments
| Name | Description |
|---|---|
input - UpdateRoundInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation updateRound($input: UpdateRoundInput!) {
updateRound(input: $input) {
clientMutationId
round {
...RoundFragment
}
query {
...QueryFragment
}
assetByAssetId {
...AssetFragment
}
tokenByTokenId {
...TokenFragment
}
assetStatusByStatus {
...AssetStatusFragment
}
blockchainAddressByBlockchainAddressId {
...BlockchainAddressFragment
}
securityBySecurityId {
...SecurityFragment
}
roundEdge {
...RoundsEdgeFragment
}
}
}
Variables
{"input": UpdateRoundInput}
Response
{
"data": {
"updateRound": {
"clientMutationId": "abc123",
"round": Round,
"query": Query,
"assetByAssetId": Asset,
"tokenByTokenId": Token,
"assetStatusByStatus": AssetStatus,
"blockchainAddressByBlockchainAddressId": BlockchainAddress,
"securityBySecurityId": Security,
"roundEdge": RoundsEdge
}
}
}
updateRoundByBlockchainAddressId
Description
Updates a single Round using a unique key and a patch.
Response
Returns an UpdateRoundPayload
Arguments
| Name | Description |
|---|---|
input - UpdateRoundByBlockchainAddressIdInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation updateRoundByBlockchainAddressId($input: UpdateRoundByBlockchainAddressIdInput!) {
updateRoundByBlockchainAddressId(input: $input) {
clientMutationId
round {
...RoundFragment
}
query {
...QueryFragment
}
assetByAssetId {
...AssetFragment
}
tokenByTokenId {
...TokenFragment
}
assetStatusByStatus {
...AssetStatusFragment
}
blockchainAddressByBlockchainAddressId {
...BlockchainAddressFragment
}
securityBySecurityId {
...SecurityFragment
}
roundEdge {
...RoundsEdgeFragment
}
}
}
Variables
{"input": UpdateRoundByBlockchainAddressIdInput}
Response
{
"data": {
"updateRoundByBlockchainAddressId": {
"clientMutationId": "abc123",
"round": Round,
"query": Query,
"assetByAssetId": Asset,
"tokenByTokenId": Token,
"assetStatusByStatus": AssetStatus,
"blockchainAddressByBlockchainAddressId": BlockchainAddress,
"securityBySecurityId": Security,
"roundEdge": RoundsEdge
}
}
}
updateRoundById
Description
Updates a single Round using a unique key and a patch.
Response
Returns an UpdateRoundPayload
Arguments
| Name | Description |
|---|---|
input - UpdateRoundByIdInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation updateRoundById($input: UpdateRoundByIdInput!) {
updateRoundById(input: $input) {
clientMutationId
round {
...RoundFragment
}
query {
...QueryFragment
}
assetByAssetId {
...AssetFragment
}
tokenByTokenId {
...TokenFragment
}
assetStatusByStatus {
...AssetStatusFragment
}
blockchainAddressByBlockchainAddressId {
...BlockchainAddressFragment
}
securityBySecurityId {
...SecurityFragment
}
roundEdge {
...RoundsEdgeFragment
}
}
}
Variables
{"input": UpdateRoundByIdInput}
Response
{
"data": {
"updateRoundById": {
"clientMutationId": "abc123",
"round": Round,
"query": Query,
"assetByAssetId": Asset,
"tokenByTokenId": Token,
"assetStatusByStatus": AssetStatus,
"blockchainAddressByBlockchainAddressId": BlockchainAddress,
"securityBySecurityId": Security,
"roundEdge": RoundsEdge
}
}
}
updateRoundByTokenId
Description
Updates a single Round using a unique key and a patch.
Response
Returns an UpdateRoundPayload
Arguments
| Name | Description |
|---|---|
input - UpdateRoundByTokenIdInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation updateRoundByTokenId($input: UpdateRoundByTokenIdInput!) {
updateRoundByTokenId(input: $input) {
clientMutationId
round {
...RoundFragment
}
query {
...QueryFragment
}
assetByAssetId {
...AssetFragment
}
tokenByTokenId {
...TokenFragment
}
assetStatusByStatus {
...AssetStatusFragment
}
blockchainAddressByBlockchainAddressId {
...BlockchainAddressFragment
}
securityBySecurityId {
...SecurityFragment
}
roundEdge {
...RoundsEdgeFragment
}
}
}
Variables
{"input": UpdateRoundByTokenIdInput}
Response
{
"data": {
"updateRoundByTokenId": {
"clientMutationId": "xyz789",
"round": Round,
"query": Query,
"assetByAssetId": Asset,
"tokenByTokenId": Token,
"assetStatusByStatus": AssetStatus,
"blockchainAddressByBlockchainAddressId": BlockchainAddress,
"securityBySecurityId": Security,
"roundEdge": RoundsEdge
}
}
}
updateSecurity
Description
Updates a single Security using its globally unique id and a patch.
Response
Returns an UpdateSecurityPayload
Arguments
| Name | Description |
|---|---|
input - UpdateSecurityInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation updateSecurity($input: UpdateSecurityInput!) {
updateSecurity(input: $input) {
clientMutationId
security {
...SecurityFragment
}
query {
...QueryFragment
}
accountByIssuerId {
...AccountFragment
}
blockchainAddressByBlockchainAddressId {
...BlockchainAddressFragment
}
accountByTaId {
...AccountFragment
}
securityEdge {
...SecuritiesEdgeFragment
}
}
}
Variables
{"input": UpdateSecurityInput}
Response
{
"data": {
"updateSecurity": {
"clientMutationId": "abc123",
"security": Security,
"query": Query,
"accountByIssuerId": Account,
"blockchainAddressByBlockchainAddressId": BlockchainAddress,
"accountByTaId": Account,
"securityEdge": SecuritiesEdge
}
}
}
updateSecurityByBlockchainAddressId
Description
Updates a single Security using a unique key and a patch.
Response
Returns an UpdateSecurityPayload
Arguments
| Name | Description |
|---|---|
input - UpdateSecurityByBlockchainAddressIdInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation updateSecurityByBlockchainAddressId($input: UpdateSecurityByBlockchainAddressIdInput!) {
updateSecurityByBlockchainAddressId(input: $input) {
clientMutationId
security {
...SecurityFragment
}
query {
...QueryFragment
}
accountByIssuerId {
...AccountFragment
}
blockchainAddressByBlockchainAddressId {
...BlockchainAddressFragment
}
accountByTaId {
...AccountFragment
}
securityEdge {
...SecuritiesEdgeFragment
}
}
}
Variables
{"input": UpdateSecurityByBlockchainAddressIdInput}
Response
{
"data": {
"updateSecurityByBlockchainAddressId": {
"clientMutationId": "xyz789",
"security": Security,
"query": Query,
"accountByIssuerId": Account,
"blockchainAddressByBlockchainAddressId": BlockchainAddress,
"accountByTaId": Account,
"securityEdge": SecuritiesEdge
}
}
}
updateSecurityById
Description
Updates a single Security using a unique key and a patch.
Response
Returns an UpdateSecurityPayload
Arguments
| Name | Description |
|---|---|
input - UpdateSecurityByIdInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation updateSecurityById($input: UpdateSecurityByIdInput!) {
updateSecurityById(input: $input) {
clientMutationId
security {
...SecurityFragment
}
query {
...QueryFragment
}
accountByIssuerId {
...AccountFragment
}
blockchainAddressByBlockchainAddressId {
...BlockchainAddressFragment
}
accountByTaId {
...AccountFragment
}
securityEdge {
...SecuritiesEdgeFragment
}
}
}
Variables
{"input": UpdateSecurityByIdInput}
Response
{
"data": {
"updateSecurityById": {
"clientMutationId": "xyz789",
"security": Security,
"query": Query,
"accountByIssuerId": Account,
"blockchainAddressByBlockchainAddressId": BlockchainAddress,
"accountByTaId": Account,
"securityEdge": SecuritiesEdge
}
}
}
updateSigningField
Description
Updates a single SigningField using its globally unique id and a patch.
Response
Returns an UpdateSigningFieldPayload
Arguments
| Name | Description |
|---|---|
input - UpdateSigningFieldInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation updateSigningField($input: UpdateSigningFieldInput!) {
updateSigningField(input: $input) {
clientMutationId
signingField {
...SigningFieldFragment
}
query {
...QueryFragment
}
mappedSigningTemplateByMappedSigningTemplateId {
...MappedSigningTemplateFragment
}
signingDocumentBySigningDocumentId {
...SigningDocumentFragment
}
signingRoleBySigningRoleId {
...SigningRoleFragment
}
signingFieldEdge {
...SigningFieldsEdgeFragment
}
}
}
Variables
{"input": UpdateSigningFieldInput}
Response
{
"data": {
"updateSigningField": {
"clientMutationId": "abc123",
"signingField": SigningField,
"query": Query,
"mappedSigningTemplateByMappedSigningTemplateId": MappedSigningTemplate,
"signingDocumentBySigningDocumentId": SigningDocument,
"signingRoleBySigningRoleId": SigningRole,
"signingFieldEdge": SigningFieldsEdge
}
}
}
updateSigningFieldById
Description
Updates a single SigningField using a unique key and a patch.
Response
Returns an UpdateSigningFieldPayload
Arguments
| Name | Description |
|---|---|
input - UpdateSigningFieldByIdInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation updateSigningFieldById($input: UpdateSigningFieldByIdInput!) {
updateSigningFieldById(input: $input) {
clientMutationId
signingField {
...SigningFieldFragment
}
query {
...QueryFragment
}
mappedSigningTemplateByMappedSigningTemplateId {
...MappedSigningTemplateFragment
}
signingDocumentBySigningDocumentId {
...SigningDocumentFragment
}
signingRoleBySigningRoleId {
...SigningRoleFragment
}
signingFieldEdge {
...SigningFieldsEdgeFragment
}
}
}
Variables
{"input": UpdateSigningFieldByIdInput}
Response
{
"data": {
"updateSigningFieldById": {
"clientMutationId": "abc123",
"signingField": SigningField,
"query": Query,
"mappedSigningTemplateByMappedSigningTemplateId": MappedSigningTemplate,
"signingDocumentBySigningDocumentId": SigningDocument,
"signingRoleBySigningRoleId": SigningRole,
"signingFieldEdge": SigningFieldsEdge
}
}
}
updateSigningRole
Description
Updates a single SigningRole using its globally unique id and a patch.
Response
Returns an UpdateSigningRolePayload
Arguments
| Name | Description |
|---|---|
input - UpdateSigningRoleInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation updateSigningRole($input: UpdateSigningRoleInput!) {
updateSigningRole(input: $input) {
clientMutationId
signingRole {
...SigningRoleFragment
}
query {
...QueryFragment
}
mappedSigningTemplateByMappedSigningTemplateId {
...MappedSigningTemplateFragment
}
mappingRoleByMapTo {
...MappingRoleFragment
}
mappingRoleTypeByType {
...MappingRoleTypeFragment
}
signingRoleEdge {
...SigningRolesEdgeFragment
}
}
}
Variables
{"input": UpdateSigningRoleInput}
Response
{
"data": {
"updateSigningRole": {
"clientMutationId": "xyz789",
"signingRole": SigningRole,
"query": Query,
"mappedSigningTemplateByMappedSigningTemplateId": MappedSigningTemplate,
"mappingRoleByMapTo": MappingRole,
"mappingRoleTypeByType": MappingRoleType,
"signingRoleEdge": SigningRolesEdge
}
}
}
updateSigningRoleById
Description
Updates a single SigningRole using a unique key and a patch.
Response
Returns an UpdateSigningRolePayload
Arguments
| Name | Description |
|---|---|
input - UpdateSigningRoleByIdInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation updateSigningRoleById($input: UpdateSigningRoleByIdInput!) {
updateSigningRoleById(input: $input) {
clientMutationId
signingRole {
...SigningRoleFragment
}
query {
...QueryFragment
}
mappedSigningTemplateByMappedSigningTemplateId {
...MappedSigningTemplateFragment
}
mappingRoleByMapTo {
...MappingRoleFragment
}
mappingRoleTypeByType {
...MappingRoleTypeFragment
}
signingRoleEdge {
...SigningRolesEdgeFragment
}
}
}
Variables
{"input": UpdateSigningRoleByIdInput}
Response
{
"data": {
"updateSigningRoleById": {
"clientMutationId": "abc123",
"signingRole": SigningRole,
"query": Query,
"mappedSigningTemplateByMappedSigningTemplateId": MappedSigningTemplate,
"mappingRoleByMapTo": MappingRole,
"mappingRoleTypeByType": MappingRoleType,
"signingRoleEdge": SigningRolesEdge
}
}
}
updateTrancheBondDatum
Description
Updates a single TrancheBondDatum using its globally unique id and a patch.
Response
Returns an UpdateTrancheBondDatumPayload
Arguments
| Name | Description |
|---|---|
input - UpdateTrancheBondDatumInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation updateTrancheBondDatum($input: UpdateTrancheBondDatumInput!) {
updateTrancheBondDatum(input: $input) {
clientMutationId
trancheBondDatum {
...TrancheBondDatumFragment
}
query {
...QueryFragment
}
roundByRoundId {
...RoundFragment
}
trancheBondDatumEdge {
...TrancheBondDataEdgeFragment
}
}
}
Variables
{"input": UpdateTrancheBondDatumInput}
Response
{
"data": {
"updateTrancheBondDatum": {
"clientMutationId": "abc123",
"trancheBondDatum": TrancheBondDatum,
"query": Query,
"roundByRoundId": Round,
"trancheBondDatumEdge": TrancheBondDataEdge
}
}
}
updateTrancheBondDatumById
Description
Updates a single TrancheBondDatum using a unique key and a patch.
Response
Returns an UpdateTrancheBondDatumPayload
Arguments
| Name | Description |
|---|---|
input - UpdateTrancheBondDatumByIdInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation updateTrancheBondDatumById($input: UpdateTrancheBondDatumByIdInput!) {
updateTrancheBondDatumById(input: $input) {
clientMutationId
trancheBondDatum {
...TrancheBondDatumFragment
}
query {
...QueryFragment
}
roundByRoundId {
...RoundFragment
}
trancheBondDatumEdge {
...TrancheBondDataEdgeFragment
}
}
}
Variables
{"input": UpdateTrancheBondDatumByIdInput}
Response
{
"data": {
"updateTrancheBondDatumById": {
"clientMutationId": "abc123",
"trancheBondDatum": TrancheBondDatum,
"query": Query,
"roundByRoundId": Round,
"trancheBondDatumEdge": TrancheBondDataEdge
}
}
}
updateTrancheBondDatumByRoundId
Description
Updates a single TrancheBondDatum using a unique key and a patch.
Response
Returns an UpdateTrancheBondDatumPayload
Arguments
| Name | Description |
|---|---|
input - UpdateTrancheBondDatumByRoundIdInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation updateTrancheBondDatumByRoundId($input: UpdateTrancheBondDatumByRoundIdInput!) {
updateTrancheBondDatumByRoundId(input: $input) {
clientMutationId
trancheBondDatum {
...TrancheBondDatumFragment
}
query {
...QueryFragment
}
roundByRoundId {
...RoundFragment
}
trancheBondDatumEdge {
...TrancheBondDataEdgeFragment
}
}
}
Variables
{"input": UpdateTrancheBondDatumByRoundIdInput}
Response
{
"data": {
"updateTrancheBondDatumByRoundId": {
"clientMutationId": "abc123",
"trancheBondDatum": TrancheBondDatum,
"query": Query,
"roundByRoundId": Round,
"trancheBondDatumEdge": TrancheBondDataEdge
}
}
}
updateTransactionAnnotation
Description
Updates a single TransactionAnnotation using its globally unique id and a patch.
Response
Returns an UpdateTransactionAnnotationPayload
Arguments
| Name | Description |
|---|---|
input - UpdateTransactionAnnotationInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation updateTransactionAnnotation($input: UpdateTransactionAnnotationInput!) {
updateTransactionAnnotation(input: $input) {
clientMutationId
transactionAnnotation {
...TransactionAnnotationFragment
}
query {
...QueryFragment
}
transactionByTransactionId {
...TransactionFragment
}
userByWrittenBy {
...UserFragment
}
accountByAccountId {
...AccountFragment
}
transactionAnnotationEdge {
...TransactionAnnotationsEdgeFragment
}
}
}
Variables
{"input": UpdateTransactionAnnotationInput}
Response
{
"data": {
"updateTransactionAnnotation": {
"clientMutationId": "xyz789",
"transactionAnnotation": TransactionAnnotation,
"query": Query,
"transactionByTransactionId": Transaction,
"userByWrittenBy": User,
"accountByAccountId": Account,
"transactionAnnotationEdge": TransactionAnnotationsEdge
}
}
}
updateTransactionAnnotationById
Description
Updates a single TransactionAnnotation using a unique key and a patch.
Response
Returns an UpdateTransactionAnnotationPayload
Arguments
| Name | Description |
|---|---|
input - UpdateTransactionAnnotationByIdInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation updateTransactionAnnotationById($input: UpdateTransactionAnnotationByIdInput!) {
updateTransactionAnnotationById(input: $input) {
clientMutationId
transactionAnnotation {
...TransactionAnnotationFragment
}
query {
...QueryFragment
}
transactionByTransactionId {
...TransactionFragment
}
userByWrittenBy {
...UserFragment
}
accountByAccountId {
...AccountFragment
}
transactionAnnotationEdge {
...TransactionAnnotationsEdgeFragment
}
}
}
Variables
{"input": UpdateTransactionAnnotationByIdInput}
Response
{
"data": {
"updateTransactionAnnotationById": {
"clientMutationId": "xyz789",
"transactionAnnotation": TransactionAnnotation,
"query": Query,
"transactionByTransactionId": Transaction,
"userByWrittenBy": User,
"accountByAccountId": Account,
"transactionAnnotationEdge": TransactionAnnotationsEdge
}
}
}
updateTransactionGroupType
Description
Updates a single TransactionGroupType using its globally unique id and a patch.
Response
Returns an UpdateTransactionGroupTypePayload
Arguments
| Name | Description |
|---|---|
input - UpdateTransactionGroupTypeInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation updateTransactionGroupType($input: UpdateTransactionGroupTypeInput!) {
updateTransactionGroupType(input: $input) {
clientMutationId
transactionGroupType {
...TransactionGroupTypeFragment
}
query {
...QueryFragment
}
transactionGroupTypeEdge {
...TransactionGroupTypesEdgeFragment
}
}
}
Variables
{"input": UpdateTransactionGroupTypeInput}
Response
{
"data": {
"updateTransactionGroupType": {
"clientMutationId": "abc123",
"transactionGroupType": TransactionGroupType,
"query": Query,
"transactionGroupTypeEdge": TransactionGroupTypesEdge
}
}
}
updateTransactionGroupTypeByType
Description
Updates a single TransactionGroupType using a unique key and a patch.
Response
Returns an UpdateTransactionGroupTypePayload
Arguments
| Name | Description |
|---|---|
input - UpdateTransactionGroupTypeByTypeInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation updateTransactionGroupTypeByType($input: UpdateTransactionGroupTypeByTypeInput!) {
updateTransactionGroupTypeByType(input: $input) {
clientMutationId
transactionGroupType {
...TransactionGroupTypeFragment
}
query {
...QueryFragment
}
transactionGroupTypeEdge {
...TransactionGroupTypesEdgeFragment
}
}
}
Variables
{"input": UpdateTransactionGroupTypeByTypeInput}
Response
{
"data": {
"updateTransactionGroupTypeByType": {
"clientMutationId": "xyz789",
"transactionGroupType": TransactionGroupType,
"query": Query,
"transactionGroupTypeEdge": TransactionGroupTypesEdge
}
}
}
updateUsersAccount
Description
Updates a single UsersAccount using its globally unique id and a patch.
Response
Returns an UpdateUsersAccountPayload
Arguments
| Name | Description |
|---|---|
input - UpdateUsersAccountInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation updateUsersAccount($input: UpdateUsersAccountInput!) {
updateUsersAccount(input: $input) {
clientMutationId
usersAccount {
...UsersAccountFragment
}
query {
...QueryFragment
}
userByUserId {
...UserFragment
}
accountByAccountId {
...AccountFragment
}
auxRoleByRole {
...AuxRoleFragment
}
userStatusByStatus {
...UserStatusFragment
}
usersAccountEdge {
...UsersAccountsEdgeFragment
}
}
}
Variables
{"input": UpdateUsersAccountInput}
Response
{
"data": {
"updateUsersAccount": {
"clientMutationId": "abc123",
"usersAccount": UsersAccount,
"query": Query,
"userByUserId": User,
"accountByAccountId": Account,
"auxRoleByRole": AuxRole,
"userStatusByStatus": UserStatus,
"usersAccountEdge": UsersAccountsEdge
}
}
}
updateUsersAccountById
Description
Updates a single UsersAccount using a unique key and a patch.
Response
Returns an UpdateUsersAccountPayload
Arguments
| Name | Description |
|---|---|
input - UpdateUsersAccountByIdInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation updateUsersAccountById($input: UpdateUsersAccountByIdInput!) {
updateUsersAccountById(input: $input) {
clientMutationId
usersAccount {
...UsersAccountFragment
}
query {
...QueryFragment
}
userByUserId {
...UserFragment
}
accountByAccountId {
...AccountFragment
}
auxRoleByRole {
...AuxRoleFragment
}
userStatusByStatus {
...UserStatusFragment
}
usersAccountEdge {
...UsersAccountsEdgeFragment
}
}
}
Variables
{"input": UpdateUsersAccountByIdInput}
Response
{
"data": {
"updateUsersAccountById": {
"clientMutationId": "xyz789",
"usersAccount": UsersAccount,
"query": Query,
"userByUserId": User,
"accountByAccountId": Account,
"auxRoleByRole": AuxRole,
"userStatusByStatus": UserStatus,
"usersAccountEdge": UsersAccountsEdge
}
}
}
updateUsersAccountByUserIdAndAccountId
Description
Updates a single UsersAccount using a unique key and a patch.
Response
Returns an UpdateUsersAccountPayload
Arguments
| Name | Description |
|---|---|
input - UpdateUsersAccountByUserIdAndAccountIdInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation updateUsersAccountByUserIdAndAccountId($input: UpdateUsersAccountByUserIdAndAccountIdInput!) {
updateUsersAccountByUserIdAndAccountId(input: $input) {
clientMutationId
usersAccount {
...UsersAccountFragment
}
query {
...QueryFragment
}
userByUserId {
...UserFragment
}
accountByAccountId {
...AccountFragment
}
auxRoleByRole {
...AuxRoleFragment
}
userStatusByStatus {
...UserStatusFragment
}
usersAccountEdge {
...UsersAccountsEdgeFragment
}
}
}
Variables
{"input": UpdateUsersAccountByUserIdAndAccountIdInput}
Response
{
"data": {
"updateUsersAccountByUserIdAndAccountId": {
"clientMutationId": "xyz789",
"usersAccount": UsersAccount,
"query": Query,
"userByUserId": User,
"accountByAccountId": Account,
"auxRoleByRole": AuxRole,
"userStatusByStatus": UserStatus,
"usersAccountEdge": UsersAccountsEdge
}
}
}
updateVendorAgent
Description
Updates a single VendorAgent using its globally unique id and a patch.
Response
Returns an UpdateVendorAgentPayload
Arguments
| Name | Description |
|---|---|
input - UpdateVendorAgentInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation updateVendorAgent($input: UpdateVendorAgentInput!) {
updateVendorAgent(input: $input) {
clientMutationId
vendorAgent {
...VendorAgentFragment
}
query {
...QueryFragment
}
accountByAgentId {
...AccountFragment
}
accountByVendorId {
...AccountFragment
}
invitationStatusByStatus {
...InvitationStatusFragment
}
vendorAgentEdge {
...VendorAgentsEdgeFragment
}
}
}
Variables
{"input": UpdateVendorAgentInput}
Response
{
"data": {
"updateVendorAgent": {
"clientMutationId": "abc123",
"vendorAgent": VendorAgent,
"query": Query,
"accountByAgentId": Account,
"accountByVendorId": Account,
"invitationStatusByStatus": InvitationStatus,
"vendorAgentEdge": VendorAgentsEdge
}
}
}
updateVendorAgentByAgentIdAndVendorId
Description
Updates a single VendorAgent using a unique key and a patch.
Response
Returns an UpdateVendorAgentPayload
Arguments
| Name | Description |
|---|---|
input - UpdateVendorAgentByAgentIdAndVendorIdInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation updateVendorAgentByAgentIdAndVendorId($input: UpdateVendorAgentByAgentIdAndVendorIdInput!) {
updateVendorAgentByAgentIdAndVendorId(input: $input) {
clientMutationId
vendorAgent {
...VendorAgentFragment
}
query {
...QueryFragment
}
accountByAgentId {
...AccountFragment
}
accountByVendorId {
...AccountFragment
}
invitationStatusByStatus {
...InvitationStatusFragment
}
vendorAgentEdge {
...VendorAgentsEdgeFragment
}
}
}
Variables
{"input": UpdateVendorAgentByAgentIdAndVendorIdInput}
Response
{
"data": {
"updateVendorAgentByAgentIdAndVendorId": {
"clientMutationId": "xyz789",
"vendorAgent": VendorAgent,
"query": Query,
"accountByAgentId": Account,
"accountByVendorId": Account,
"invitationStatusByStatus": InvitationStatus,
"vendorAgentEdge": VendorAgentsEdge
}
}
}
updateVendorAgentById
Description
Updates a single VendorAgent using a unique key and a patch.
Response
Returns an UpdateVendorAgentPayload
Arguments
| Name | Description |
|---|---|
input - UpdateVendorAgentByIdInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation updateVendorAgentById($input: UpdateVendorAgentByIdInput!) {
updateVendorAgentById(input: $input) {
clientMutationId
vendorAgent {
...VendorAgentFragment
}
query {
...QueryFragment
}
accountByAgentId {
...AccountFragment
}
accountByVendorId {
...AccountFragment
}
invitationStatusByStatus {
...InvitationStatusFragment
}
vendorAgentEdge {
...VendorAgentsEdgeFragment
}
}
}
Variables
{"input": UpdateVendorAgentByIdInput}
Response
{
"data": {
"updateVendorAgentById": {
"clientMutationId": "abc123",
"vendorAgent": VendorAgent,
"query": Query,
"accountByAgentId": Account,
"accountByVendorId": Account,
"invitationStatusByStatus": InvitationStatus,
"vendorAgentEdge": VendorAgentsEdge
}
}
}
updateVendorDefaultEmailPreference
Description
Updates a single VendorDefaultEmailPreference using its globally unique id and a patch.
Response
Returns an UpdateVendorDefaultEmailPreferencePayload
Arguments
| Name | Description |
|---|---|
input - UpdateVendorDefaultEmailPreferenceInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation updateVendorDefaultEmailPreference($input: UpdateVendorDefaultEmailPreferenceInput!) {
updateVendorDefaultEmailPreference(input: $input) {
clientMutationId
vendorDefaultEmailPreference {
...VendorDefaultEmailPreferenceFragment
}
query {
...QueryFragment
}
accountByAccountId {
...AccountFragment
}
vendorDefaultEmailPreferenceEdge {
...VendorDefaultEmailPreferencesEdgeFragment
}
}
}
Variables
{"input": UpdateVendorDefaultEmailPreferenceInput}
Response
{
"data": {
"updateVendorDefaultEmailPreference": {
"clientMutationId": "abc123",
"vendorDefaultEmailPreference": VendorDefaultEmailPreference,
"query": Query,
"accountByAccountId": Account,
"vendorDefaultEmailPreferenceEdge": VendorDefaultEmailPreferencesEdge
}
}
}
updateVendorDefaultEmailPreferenceByAccountId
Description
Updates a single VendorDefaultEmailPreference using a unique key and a patch.
Response
Returns an UpdateVendorDefaultEmailPreferencePayload
Arguments
| Name | Description |
|---|---|
input - UpdateVendorDefaultEmailPreferenceByAccountIdInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation updateVendorDefaultEmailPreferenceByAccountId($input: UpdateVendorDefaultEmailPreferenceByAccountIdInput!) {
updateVendorDefaultEmailPreferenceByAccountId(input: $input) {
clientMutationId
vendorDefaultEmailPreference {
...VendorDefaultEmailPreferenceFragment
}
query {
...QueryFragment
}
accountByAccountId {
...AccountFragment
}
vendorDefaultEmailPreferenceEdge {
...VendorDefaultEmailPreferencesEdgeFragment
}
}
}
Variables
{
"input": UpdateVendorDefaultEmailPreferenceByAccountIdInput
}
Response
{
"data": {
"updateVendorDefaultEmailPreferenceByAccountId": {
"clientMutationId": "xyz789",
"vendorDefaultEmailPreference": VendorDefaultEmailPreference,
"query": Query,
"accountByAccountId": Account,
"vendorDefaultEmailPreferenceEdge": VendorDefaultEmailPreferencesEdge
}
}
}
updateVendorDefaultEmailPreferenceById
Description
Updates a single VendorDefaultEmailPreference using a unique key and a patch.
Response
Returns an UpdateVendorDefaultEmailPreferencePayload
Arguments
| Name | Description |
|---|---|
input - UpdateVendorDefaultEmailPreferenceByIdInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation updateVendorDefaultEmailPreferenceById($input: UpdateVendorDefaultEmailPreferenceByIdInput!) {
updateVendorDefaultEmailPreferenceById(input: $input) {
clientMutationId
vendorDefaultEmailPreference {
...VendorDefaultEmailPreferenceFragment
}
query {
...QueryFragment
}
accountByAccountId {
...AccountFragment
}
vendorDefaultEmailPreferenceEdge {
...VendorDefaultEmailPreferencesEdgeFragment
}
}
}
Variables
{"input": UpdateVendorDefaultEmailPreferenceByIdInput}
Response
{
"data": {
"updateVendorDefaultEmailPreferenceById": {
"clientMutationId": "xyz789",
"vendorDefaultEmailPreference": VendorDefaultEmailPreference,
"query": Query,
"accountByAccountId": Account,
"vendorDefaultEmailPreferenceEdge": VendorDefaultEmailPreferencesEdge
}
}
}
updateVendorIntegrationStatus
Description
Updates a single VendorIntegrationStatus using its globally unique id and a patch.
Response
Returns an UpdateVendorIntegrationStatusPayload
Arguments
| Name | Description |
|---|---|
input - UpdateVendorIntegrationStatusInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation updateVendorIntegrationStatus($input: UpdateVendorIntegrationStatusInput!) {
updateVendorIntegrationStatus(input: $input) {
clientMutationId
vendorIntegrationStatus {
...VendorIntegrationStatusFragment
}
query {
...QueryFragment
}
vendorIntegrationStatusEdge {
...VendorIntegrationStatusesEdgeFragment
}
}
}
Variables
{"input": UpdateVendorIntegrationStatusInput}
Response
{
"data": {
"updateVendorIntegrationStatus": {
"clientMutationId": "abc123",
"vendorIntegrationStatus": VendorIntegrationStatus,
"query": Query,
"vendorIntegrationStatusEdge": VendorIntegrationStatusesEdge
}
}
}
updateVendorIntegrationStatusByStatus
Description
Updates a single VendorIntegrationStatus using a unique key and a patch.
Response
Returns an UpdateVendorIntegrationStatusPayload
Arguments
| Name | Description |
|---|---|
input - UpdateVendorIntegrationStatusByStatusInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation updateVendorIntegrationStatusByStatus($input: UpdateVendorIntegrationStatusByStatusInput!) {
updateVendorIntegrationStatusByStatus(input: $input) {
clientMutationId
vendorIntegrationStatus {
...VendorIntegrationStatusFragment
}
query {
...QueryFragment
}
vendorIntegrationStatusEdge {
...VendorIntegrationStatusesEdgeFragment
}
}
}
Variables
{"input": UpdateVendorIntegrationStatusByStatusInput}
Response
{
"data": {
"updateVendorIntegrationStatusByStatus": {
"clientMutationId": "xyz789",
"vendorIntegrationStatus": VendorIntegrationStatus,
"query": Query,
"vendorIntegrationStatusEdge": VendorIntegrationStatusesEdge
}
}
}
updateVestingEvent
Description
Updates a single VestingEvent using its globally unique id and a patch.
Response
Returns an UpdateVestingEventPayload
Arguments
| Name | Description |
|---|---|
input - UpdateVestingEventInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation updateVestingEvent($input: UpdateVestingEventInput!) {
updateVestingEvent(input: $input) {
clientMutationId
vestingEvent {
...VestingEventFragment
}
query {
...QueryFragment
}
vestingScheduleByVestingScheduleId {
...VestingScheduleFragment
}
transactionByTransactionId {
...TransactionFragment
}
vestingEventEdge {
...VestingEventsEdgeFragment
}
}
}
Variables
{"input": UpdateVestingEventInput}
Response
{
"data": {
"updateVestingEvent": {
"clientMutationId": "xyz789",
"vestingEvent": VestingEvent,
"query": Query,
"vestingScheduleByVestingScheduleId": VestingSchedule,
"transactionByTransactionId": Transaction,
"vestingEventEdge": VestingEventsEdge
}
}
}
updateVestingEventById
Description
Updates a single VestingEvent using a unique key and a patch.
Response
Returns an UpdateVestingEventPayload
Arguments
| Name | Description |
|---|---|
input - UpdateVestingEventByIdInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation updateVestingEventById($input: UpdateVestingEventByIdInput!) {
updateVestingEventById(input: $input) {
clientMutationId
vestingEvent {
...VestingEventFragment
}
query {
...QueryFragment
}
vestingScheduleByVestingScheduleId {
...VestingScheduleFragment
}
transactionByTransactionId {
...TransactionFragment
}
vestingEventEdge {
...VestingEventsEdgeFragment
}
}
}
Variables
{"input": UpdateVestingEventByIdInput}
Response
{
"data": {
"updateVestingEventById": {
"clientMutationId": "abc123",
"vestingEvent": VestingEvent,
"query": Query,
"vestingScheduleByVestingScheduleId": VestingSchedule,
"transactionByTransactionId": Transaction,
"vestingEventEdge": VestingEventsEdge
}
}
}
updateVestingSchedule
Description
Updates a single VestingSchedule using its globally unique id and a patch.
Response
Returns an UpdateVestingSchedulePayload
Arguments
| Name | Description |
|---|---|
input - UpdateVestingScheduleInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation updateVestingSchedule($input: UpdateVestingScheduleInput!) {
updateVestingSchedule(input: $input) {
clientMutationId
vestingSchedule {
...VestingScheduleFragment
}
query {
...QueryFragment
}
distributionByDistributionId {
...DistributionFragment
}
vestingDurationByDuration {
...VestingDurationFragment
}
vestingScheduleEdge {
...VestingSchedulesEdgeFragment
}
}
}
Variables
{"input": UpdateVestingScheduleInput}
Response
{
"data": {
"updateVestingSchedule": {
"clientMutationId": "abc123",
"vestingSchedule": VestingSchedule,
"query": Query,
"distributionByDistributionId": Distribution,
"vestingDurationByDuration": VestingDuration,
"vestingScheduleEdge": VestingSchedulesEdge
}
}
}
updateVestingScheduleByDistributionId
Description
Updates a single VestingSchedule using a unique key and a patch.
Response
Returns an UpdateVestingSchedulePayload
Arguments
| Name | Description |
|---|---|
input - UpdateVestingScheduleByDistributionIdInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation updateVestingScheduleByDistributionId($input: UpdateVestingScheduleByDistributionIdInput!) {
updateVestingScheduleByDistributionId(input: $input) {
clientMutationId
vestingSchedule {
...VestingScheduleFragment
}
query {
...QueryFragment
}
distributionByDistributionId {
...DistributionFragment
}
vestingDurationByDuration {
...VestingDurationFragment
}
vestingScheduleEdge {
...VestingSchedulesEdgeFragment
}
}
}
Variables
{"input": UpdateVestingScheduleByDistributionIdInput}
Response
{
"data": {
"updateVestingScheduleByDistributionId": {
"clientMutationId": "abc123",
"vestingSchedule": VestingSchedule,
"query": Query,
"distributionByDistributionId": Distribution,
"vestingDurationByDuration": VestingDuration,
"vestingScheduleEdge": VestingSchedulesEdge
}
}
}
updateVestingScheduleById
Description
Updates a single VestingSchedule using a unique key and a patch.
Response
Returns an UpdateVestingSchedulePayload
Arguments
| Name | Description |
|---|---|
input - UpdateVestingScheduleByIdInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation updateVestingScheduleById($input: UpdateVestingScheduleByIdInput!) {
updateVestingScheduleById(input: $input) {
clientMutationId
vestingSchedule {
...VestingScheduleFragment
}
query {
...QueryFragment
}
distributionByDistributionId {
...DistributionFragment
}
vestingDurationByDuration {
...VestingDurationFragment
}
vestingScheduleEdge {
...VestingSchedulesEdgeFragment
}
}
}
Variables
{"input": UpdateVestingScheduleByIdInput}
Response
{
"data": {
"updateVestingScheduleById": {
"clientMutationId": "abc123",
"vestingSchedule": VestingSchedule,
"query": Query,
"distributionByDistributionId": Distribution,
"vestingDurationByDuration": VestingDuration,
"vestingScheduleEdge": VestingSchedulesEdge
}
}
}
updateWalletAssignment
Description
Updates a single WalletAssignment using its globally unique id and a patch.
Response
Returns an UpdateWalletAssignmentPayload
Arguments
| Name | Description |
|---|---|
input - UpdateWalletAssignmentInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation updateWalletAssignment($input: UpdateWalletAssignmentInput!) {
updateWalletAssignment(input: $input) {
clientMutationId
walletAssignment {
...WalletAssignmentFragment
}
query {
...QueryFragment
}
distributionByDistributionId {
...DistributionFragment
}
blockchainAddressByBlockchainAddressId {
...BlockchainAddressFragment
}
walletAssignmentEdge {
...WalletAssignmentsEdgeFragment
}
}
}
Variables
{"input": UpdateWalletAssignmentInput}
Response
{
"data": {
"updateWalletAssignment": {
"clientMutationId": "abc123",
"walletAssignment": WalletAssignment,
"query": Query,
"distributionByDistributionId": Distribution,
"blockchainAddressByBlockchainAddressId": BlockchainAddress,
"walletAssignmentEdge": WalletAssignmentsEdge
}
}
}
updateWalletAssignmentByDistributionId
Description
Updates a single WalletAssignment using a unique key and a patch.
Response
Returns an UpdateWalletAssignmentPayload
Arguments
| Name | Description |
|---|---|
input - UpdateWalletAssignmentByDistributionIdInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation updateWalletAssignmentByDistributionId($input: UpdateWalletAssignmentByDistributionIdInput!) {
updateWalletAssignmentByDistributionId(input: $input) {
clientMutationId
walletAssignment {
...WalletAssignmentFragment
}
query {
...QueryFragment
}
distributionByDistributionId {
...DistributionFragment
}
blockchainAddressByBlockchainAddressId {
...BlockchainAddressFragment
}
walletAssignmentEdge {
...WalletAssignmentsEdgeFragment
}
}
}
Variables
{"input": UpdateWalletAssignmentByDistributionIdInput}
Response
{
"data": {
"updateWalletAssignmentByDistributionId": {
"clientMutationId": "abc123",
"walletAssignment": WalletAssignment,
"query": Query,
"distributionByDistributionId": Distribution,
"blockchainAddressByBlockchainAddressId": BlockchainAddress,
"walletAssignmentEdge": WalletAssignmentsEdge
}
}
}
updateWalletAssignmentById
Description
Updates a single WalletAssignment using a unique key and a patch.
Response
Returns an UpdateWalletAssignmentPayload
Arguments
| Name | Description |
|---|---|
input - UpdateWalletAssignmentByIdInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation updateWalletAssignmentById($input: UpdateWalletAssignmentByIdInput!) {
updateWalletAssignmentById(input: $input) {
clientMutationId
walletAssignment {
...WalletAssignmentFragment
}
query {
...QueryFragment
}
distributionByDistributionId {
...DistributionFragment
}
blockchainAddressByBlockchainAddressId {
...BlockchainAddressFragment
}
walletAssignmentEdge {
...WalletAssignmentsEdgeFragment
}
}
}
Variables
{"input": UpdateWalletAssignmentByIdInput}
Response
{
"data": {
"updateWalletAssignmentById": {
"clientMutationId": "xyz789",
"walletAssignment": WalletAssignment,
"query": Query,
"distributionByDistributionId": Distribution,
"blockchainAddressByBlockchainAddressId": BlockchainAddress,
"walletAssignmentEdge": WalletAssignmentsEdge
}
}
}
updateWebhookConfiguration
Description
Updates a single WebhookConfiguration using its globally unique id and a patch.
Response
Returns an UpdateWebhookConfigurationPayload
Arguments
| Name | Description |
|---|---|
input - UpdateWebhookConfigurationInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation updateWebhookConfiguration($input: UpdateWebhookConfigurationInput!) {
updateWebhookConfiguration(input: $input) {
clientMutationId
webhookConfiguration {
...WebhookConfigurationFragment
}
query {
...QueryFragment
}
webhookLevelByLevel {
...WebhookLevelFragment
}
accountByAccountId {
...AccountFragment
}
webhookConfigurationEdge {
...WebhookConfigurationsEdgeFragment
}
}
}
Variables
{"input": UpdateWebhookConfigurationInput}
Response
{
"data": {
"updateWebhookConfiguration": {
"clientMutationId": "xyz789",
"webhookConfiguration": WebhookConfiguration,
"query": Query,
"webhookLevelByLevel": WebhookLevel,
"accountByAccountId": Account,
"webhookConfigurationEdge": WebhookConfigurationsEdge
}
}
}
updateWebhookConfigurationById
Description
Updates a single WebhookConfiguration using a unique key and a patch.
Response
Returns an UpdateWebhookConfigurationPayload
Arguments
| Name | Description |
|---|---|
input - UpdateWebhookConfigurationByIdInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation updateWebhookConfigurationById($input: UpdateWebhookConfigurationByIdInput!) {
updateWebhookConfigurationById(input: $input) {
clientMutationId
webhookConfiguration {
...WebhookConfigurationFragment
}
query {
...QueryFragment
}
webhookLevelByLevel {
...WebhookLevelFragment
}
accountByAccountId {
...AccountFragment
}
webhookConfigurationEdge {
...WebhookConfigurationsEdgeFragment
}
}
}
Variables
{"input": UpdateWebhookConfigurationByIdInput}
Response
{
"data": {
"updateWebhookConfigurationById": {
"clientMutationId": "xyz789",
"webhookConfiguration": WebhookConfiguration,
"query": Query,
"webhookLevelByLevel": WebhookLevel,
"accountByAccountId": Account,
"webhookConfigurationEdge": WebhookConfigurationsEdge
}
}
}
updateWebhookConfigurationByLevelAndAccountId
Description
Updates a single WebhookConfiguration using a unique key and a patch.
Response
Returns an UpdateWebhookConfigurationPayload
Arguments
| Name | Description |
|---|---|
input - UpdateWebhookConfigurationByLevelAndAccountIdInput!
|
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields. |
Example
Query
mutation updateWebhookConfigurationByLevelAndAccountId($input: UpdateWebhookConfigurationByLevelAndAccountIdInput!) {
updateWebhookConfigurationByLevelAndAccountId(input: $input) {
clientMutationId
webhookConfiguration {
...WebhookConfigurationFragment
}
query {
...QueryFragment
}
webhookLevelByLevel {
...WebhookLevelFragment
}
accountByAccountId {
...AccountFragment
}
webhookConfigurationEdge {
...WebhookConfigurationsEdgeFragment
}
}
}
Variables
{
"input": UpdateWebhookConfigurationByLevelAndAccountIdInput
}
Response
{
"data": {
"updateWebhookConfigurationByLevelAndAccountId": {
"clientMutationId": "xyz789",
"webhookConfiguration": WebhookConfiguration,
"query": Query,
"webhookLevelByLevel": WebhookLevel,
"accountByAccountId": Account,
"webhookConfigurationEdge": WebhookConfigurationsEdge
}
}
}
Types
AcceptTermsInput
Description
All input for the acceptTerms mutation.
Example
{
"clientMutationId": "xyz789",
"termsId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
AcceptTermsPayload
Description
The output of our acceptTerms mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
The exact same clientMutationId that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations. |
termsOfService - TermsOfService
|
|
query - Query
|
Our root query field type. Allows us to run any query from our mutation payload. |
termsOfServiceTypeByType - TermsOfServiceType
|
Reads a single TermsOfServiceType that is related to this TermsOfService. |
termsOfServiceEdge - TermsOfServicesEdge
|
An edge for our TermsOfService. May be used by Relay 1. |
Arguments
|
|
Example
{
"clientMutationId": "xyz789",
"termsOfService": TermsOfService,
"query": Query,
"termsOfServiceTypeByType": TermsOfServiceType,
"termsOfServiceEdge": TermsOfServicesEdge
}
Account
Fields
| Field Name | Description |
|---|---|
nodeId - ID!
|
A globally unique identifier. Can be used in various places throughout the system to identify this single value. |
type - String!
|
|
company - UUID
|
|
name - String!
|
|
jurisdiction - UUID!
|
|
email - String!
|
|
url - String
|
|
slug - String
|
|
twitterHandle - String
|
|
supportEmail - String
|
|
newId - UUID!
|
|
setup - Boolean!
|
|
entity - Boolean!
|
|
oldId - Int
|
|
id - UUID!
|
|
createdOn - Datetime!
|
|
investorType - String
|
|
formationDate - Date
|
|
externalEmail - String!
|
|
useReal - Boolean!
|
|
auxAccountByType - AuxAccount
|
Reads a single AuxAccount that is related to this Account. |
companyByCompany - Company
|
Reads a single Company that is related to this Account. |
countryByJurisdiction - Country
|
Reads a single Country that is related to this Account. |
investorAccountTypeByInvestorType - InvestorAccountType
|
Reads a single InvestorAccountType that is related to this Account. |
customersByVendorId - CustomersConnection!
|
Reads and enables pagination through a set of Customer. |
Arguments
|
|
customersByInvestorId - CustomersConnection!
|
Reads and enables pagination through a set of Customer. |
Arguments
|
|
usersAccountsByAccountId - UsersAccountsConnection!
|
Reads and enables pagination through a set of UsersAccount. |
Arguments
|
|
accountsBlockchainAddressesByAccountId - AccountsBlockchainAddressesConnection!
|
Reads and enables pagination through a set of AccountsBlockchainAddress. |
Arguments
|
|
blockchainRegistrationsByAccountId - BlockchainRegistrationsConnection!
|
Reads and enables pagination through a set of BlockchainRegistration. |
Arguments
|
|
assetsByIssuerId - AssetsConnection!
|
Reads and enables pagination through a set of Asset. |
Arguments
|
|
assetArchivesByAccountId - AssetArchivesConnection!
|
Reads and enables pagination through a set of AssetArchive. |
Arguments
|
|
allocationsByOwnerId - AllocationsConnection!
|
Reads and enables pagination through a set of Allocation. |
Arguments
|
|
allocationsByIssuerId - AllocationsConnection!
|
Reads and enables pagination through a set of Allocation. |
Arguments
|
|
allocationArchivesByAccountId - AllocationArchivesConnection!
|
Reads and enables pagination through a set of AllocationArchive. |
Arguments
|
|
brokerAllocationsByBrokerId - BrokerAllocationsConnection!
|
Reads and enables pagination through a set of BrokerAllocation. |
Arguments
|
|
distributionsByInvestorId - DistributionsConnection!
|
Reads and enables pagination through a set of Distribution. |
Arguments
|
|
transactionsByBrokerId - TransactionsConnection!
|
Reads and enables pagination through a set of Transaction. |
Arguments
|
|
ledgersByInvestorId - LedgersConnection!
|
Reads and enables pagination through a set of Ledger. |
Arguments
|
|
distributionAnnotationsByAccountId - DistributionAnnotationsConnection!
|
Reads and enables pagination through a set of DistributionAnnotation. |
Arguments
|
|
assetAnnotationsByAccountId - AssetAnnotationsConnection!
|
Reads and enables pagination through a set of AssetAnnotation. |
Arguments
|
|
allocationAnnotationsByAccountId - AllocationAnnotationsConnection!
|
Reads and enables pagination through a set of AllocationAnnotation. |
Arguments
|
|
transactionAnnotationsByAccountId - TransactionAnnotationsConnection!
|
Reads and enables pagination through a set of TransactionAnnotation. |
Arguments
|
|
managedAccountsByManagerId - ManagedAccountsConnection!
|
Reads and enables pagination through a set of ManagedAccount. |
Arguments
|
|
managedAccountsByEntityId - ManagedAccountsConnection!
|
Reads and enables pagination through a set of ManagedAccount. |
Arguments
|
|
accountIntegrationsByAccountId - AccountIntegrationsConnection!
|
Reads and enables pagination through a set of AccountIntegration. |
Arguments
|
|
vendorQualificationsByAccountId - VendorQualificationsConnection!
|
Reads and enables pagination through a set of VendorQualification. |
Arguments
|
|
stepsByOwnedBy - StepsConnection!
|
Reads and enables pagination through a set of Step. |
Arguments
|
|
stepsByExecuteBy - StepsConnection!
|
Reads and enables pagination through a set of Step. |
Arguments
|
|
distributionCustomFieldsByCreatedBy - DistributionCustomFieldsConnection!
|
Reads and enables pagination through a set of DistributionCustomField. |
Arguments
|
|
signingAccountsByAccountId - SigningAccountsConnection!
|
Reads and enables pagination through a set of SigningAccount. |
Arguments
|
|
signingTemplatesByAccountId - SigningTemplatesConnection!
|
Reads and enables pagination through a set of SigningTemplate. |
Arguments
|
|
mappedSigningTemplatesByAccountId - MappedSigningTemplatesConnection!
|
Reads and enables pagination through a set of MappedSigningTemplate. |
Arguments
|
|
sentSigningDocumentsBySentTo - SentSigningDocumentsConnection!
|
Reads and enables pagination through a set of SentSigningDocument. |
Arguments
|
|
allocationOfferingLinksByCreatedBy - AllocationOfferingLinksConnection!
|
Reads and enables pagination through a set of AllocationOfferingLink. |
Arguments
|
|
allocationOfferingLinksByAgentId - AllocationOfferingLinksConnection!
|
Reads and enables pagination through a set of AllocationOfferingLink. |
Arguments
|
|
accountPhoneNumbersByAccountId - AccountPhoneNumbersConnection!
|
Reads and enables pagination through a set of AccountPhoneNumber. |
Arguments
|
|
accountRegDStatusByAccountId - AccountRegDStatus
|
Reads a single AccountRegDStatus that is related to this Account. |
accountRegDStatusesByAccountId - AccountRegDStatusesConnection!
|
Reads and enables pagination through a set of AccountRegDStatus. Please use accountRegDStatusByAccountId instead
|
Arguments
|
|
accountTaxInformationsByAccountId - AccountTaxInformationsConnection!
|
Reads and enables pagination through a set of AccountTaxInformation. |
Arguments
|
|
onboardingQuestionSetsByAccountId - OnboardingQuestionSetsConnection!
|
Reads and enables pagination through a set of OnboardingQuestionSet. |
Arguments
|
|
onboardingQuestionsByAccountId - OnboardingQuestionsConnection!
|
Reads and enables pagination through a set of OnboardingQuestion. |
Arguments
|
|
instancedAccountInformationsByAccountId - InstancedAccountInformationsConnection!
|
Reads and enables pagination through a set of InstancedAccountInformation. |
Arguments
|
|
instancedAccountInformationsByVendorAccountId - InstancedAccountInformationsConnection!
|
Reads and enables pagination through a set of InstancedAccountInformation. |
Arguments
|
|
instancedMappingFieldsByAccountId - InstancedMappingFieldsConnection!
|
Reads and enables pagination through a set of InstancedMappingField. |
Arguments
|
|
vendorDefaultEmailPreferenceByAccountId - VendorDefaultEmailPreference
|
Reads a single VendorDefaultEmailPreference that is related to this Account. |
vendorDefaultEmailPreferencesByAccountId - VendorDefaultEmailPreferencesConnection!
|
Reads and enables pagination through a set of VendorDefaultEmailPreference. Please use vendorDefaultEmailPreferenceByAccountId instead
|
Arguments
|
|
allocationEmailPreferencesByAccountId - AllocationEmailPreferencesConnection!
|
Reads and enables pagination through a set of AllocationEmailPreference. |
Arguments
|
|
securitiesByIssuerId - SecuritiesConnection!
|
Reads and enables pagination through a set of Security. |
Arguments
|
|
securitiesByTaId - SecuritiesConnection!
|
Reads and enables pagination through a set of Security. |
Arguments
|
|
holdingsByInvestorId - HoldingsConnection!
|
Reads and enables pagination through a set of Holding. |
Arguments
|
|
issuanceEventsByInvestorId - IssuanceEventsConnection!
|
Reads and enables pagination through a set of IssuanceEvent. |
Arguments
|
|
issuanceEventsByIssuerId - IssuanceEventsConnection!
|
Reads and enables pagination through a set of IssuanceEvent. |
Arguments
|
|
vendorAgentsByAgentId - VendorAgentsConnection!
|
Reads and enables pagination through a set of VendorAgent. |
Arguments
|
|
vendorAgentsByVendorId - VendorAgentsConnection!
|
Reads and enables pagination through a set of VendorAgent. |
Arguments
|
|
securityListingsByIssuerId - SecurityListingsConnection!
|
Reads and enables pagination through a set of SecurityListing. |
Arguments
|
|
securityListingsByAtsId - SecurityListingsConnection!
|
Reads and enables pagination through a set of SecurityListing. |
Arguments
|
|
documentsByUploadedBy - DocumentsConnection!
|
Reads and enables pagination through a set of Document. |
Arguments
|
|
accountDocumentsByFromAccountId - AccountDocumentsConnection!
|
Reads and enables pagination through a set of AccountDocument. |
Arguments
|
|
accountDocumentsByToAccountId - AccountDocumentsConnection!
|
Reads and enables pagination through a set of AccountDocument. |
Arguments
|
|
documentSharingsByUploaderId - DocumentSharingsConnection!
|
Reads and enables pagination through a set of DocumentSharing. |
Arguments
|
|
accountRestrictionsByAccountId - AccountRestrictionsConnection!
|
Reads and enables pagination through a set of AccountRestriction. |
Arguments
|
|
accountRestrictionsByCreatorAccountId - AccountRestrictionsConnection!
|
Reads and enables pagination through a set of AccountRestriction. |
Arguments
|
|
paymentAccountsByAccountId - PaymentAccountsConnection!
|
Reads and enables pagination through a set of PaymentAccount. |
Arguments
|
|
paymentMethodsByAccountId - PaymentMethodsConnection!
|
Reads and enables pagination through a set of PaymentMethod. |
Arguments
|
|
paymentIssuersByIssuerId - PaymentIssuersConnection!
|
Reads and enables pagination through a set of PaymentIssuer. |
Arguments
|
|
paymentIssuersByAccountId - PaymentIssuersConnection!
|
Reads and enables pagination through a set of PaymentIssuer. |
Arguments
|
|
omnibusHoldingsByAccountId - OmnibusHoldingsConnection!
|
Reads and enables pagination through a set of OmnibusHolding. |
Arguments
|
|
omnibusInvestorsByInvestorId - OmnibusInvestorsConnection!
|
Reads and enables pagination through a set of OmnibusInvestor. |
Arguments
|
|
omnibusInvestorsByAccountId - OmnibusInvestorsConnection!
|
Reads and enables pagination through a set of OmnibusInvestor. |
Arguments
|
|
webhookConfigurationsByAccountId - WebhookConfigurationsConnection!
|
Reads and enables pagination through a set of WebhookConfiguration. |
Arguments
|
|
customerPartiesByCreatorAccountId - CustomerPartiesConnection!
|
Reads and enables pagination through a set of CustomerParty. |
Arguments
|
|
customerAddressesByCreatorAccountId - CustomerAddressesConnection!
|
Reads and enables pagination through a set of CustomerAddress. |
Arguments
|
|
customerPartyAddressesByCreatorAccountId - CustomerPartyAddressesConnection!
|
Reads and enables pagination through a set of CustomerPartyAddress. |
Arguments
|
|
blockchainAddressSourcesByVendorId - BlockchainAddressSourcesConnection!
|
Reads and enables pagination through a set of BlockchainAddressSource. |
Arguments
|
|
blockchainAddressSourcesByInvestorId - BlockchainAddressSourcesConnection!
|
Reads and enables pagination through a set of BlockchainAddressSource. |
Arguments
|
|
blockchainAddressSourcesByCreatorAccountId - BlockchainAddressSourcesConnection!
|
Reads and enables pagination through a set of BlockchainAddressSource. |
Arguments
|
|
taRequestsByVendorId - TaRequestsConnection!
|
Reads and enables pagination through a set of TaRequest. |
Arguments
|
|
taRequestsByInvestorId - TaRequestsConnection!
|
Reads and enables pagination through a set of TaRequest. |
Arguments
|
|
taRequestsByCreatorAccountId - TaRequestsConnection!
|
Reads and enables pagination through a set of TaRequest. |
Arguments
|
|
accountAddressesByAccountId - AccountAddressesConnection!
|
Reads and enables pagination through a set of AccountAddress. |
Arguments
|
|
atsTagsByAccountId - AtsTagsConnection!
|
Reads and enables pagination through a set of AtsTag. |
Arguments
|
|
idempotentsByAtsId - IdempotentsConnection!
|
Reads and enables pagination through a set of Idempotent. |
Arguments
|
|
partiesByAccountId - PartiesConnection!
|
Reads and enables pagination through a set of Party. |
Arguments
|
|
partyAddressesByAccountId - PartyAddressesConnection!
|
Reads and enables pagination through a set of PartyAddress. |
Arguments
|
|
requestsByAccountId - RequestsConnection!
|
Reads and enables pagination through a set of Request. |
Arguments
|
|
stagedBalanceTransfersByToAccountId - StagedBalanceTransfersConnection!
|
Reads and enables pagination through a set of StagedBalanceTransfer. |
Arguments
|
|
stagedBalanceTransfersByFromAccountId - StagedBalanceTransfersConnection!
|
Reads and enables pagination through a set of StagedBalanceTransfer. |
Arguments
|
|
stagedTransfersByAccountId - StagedTransfersConnection!
|
Reads and enables pagination through a set of StagedTransfer. |
Arguments
|
|
tradesByAtsId - TradesConnection!
|
Reads and enables pagination through a set of Trade. |
Arguments
|
|
tradesByFromAccountId - TradesConnection!
|
Reads and enables pagination through a set of Trade. |
Arguments
|
|
tradesByToAccountId - TradesConnection!
|
Reads and enables pagination through a set of Trade. |
Arguments
|
|
transfersByAtsId - TransfersConnection!
|
Reads and enables pagination through a set of Transfer. |
Arguments
|
|
transfersByFromAccountId - TransfersConnection!
|
Reads and enables pagination through a set of Transfer. |
Arguments
|
|
transfersByToAccountId - TransfersConnection!
|
Reads and enables pagination through a set of Transfer. |
Arguments
|
|
contactName - String
|
|
holdings - BigFloat
|
|
taxShort - String
|
|
Example
{
"nodeId": "4",
"type": "abc123",
"company": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"name": "abc123",
"jurisdiction": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"email": "abc123",
"url": "abc123",
"slug": "xyz789",
"twitterHandle": "xyz789",
"supportEmail": "abc123",
"newId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"setup": false,
"entity": true,
"oldId": 987,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"createdOn": Datetime,
"investorType": "abc123",
"formationDate": "2007-12-03",
"externalEmail": "abc123",
"useReal": false,
"auxAccountByType": AuxAccount,
"companyByCompany": Company,
"countryByJurisdiction": Country,
"investorAccountTypeByInvestorType": InvestorAccountType,
"customersByVendorId": CustomersConnection,
"customersByInvestorId": CustomersConnection,
"usersAccountsByAccountId": UsersAccountsConnection,
"accountsBlockchainAddressesByAccountId": AccountsBlockchainAddressesConnection,
"blockchainRegistrationsByAccountId": BlockchainRegistrationsConnection,
"assetsByIssuerId": AssetsConnection,
"assetArchivesByAccountId": AssetArchivesConnection,
"allocationsByOwnerId": AllocationsConnection,
"allocationsByIssuerId": AllocationsConnection,
"allocationArchivesByAccountId": AllocationArchivesConnection,
"brokerAllocationsByBrokerId": BrokerAllocationsConnection,
"distributionsByInvestorId": DistributionsConnection,
"transactionsByBrokerId": TransactionsConnection,
"ledgersByInvestorId": LedgersConnection,
"distributionAnnotationsByAccountId": DistributionAnnotationsConnection,
"assetAnnotationsByAccountId": AssetAnnotationsConnection,
"allocationAnnotationsByAccountId": AllocationAnnotationsConnection,
"transactionAnnotationsByAccountId": TransactionAnnotationsConnection,
"managedAccountsByManagerId": ManagedAccountsConnection,
"managedAccountsByEntityId": ManagedAccountsConnection,
"accountIntegrationsByAccountId": AccountIntegrationsConnection,
"vendorQualificationsByAccountId": VendorQualificationsConnection,
"stepsByOwnedBy": StepsConnection,
"stepsByExecuteBy": StepsConnection,
"distributionCustomFieldsByCreatedBy": DistributionCustomFieldsConnection,
"signingAccountsByAccountId": SigningAccountsConnection,
"signingTemplatesByAccountId": SigningTemplatesConnection,
"mappedSigningTemplatesByAccountId": MappedSigningTemplatesConnection,
"sentSigningDocumentsBySentTo": SentSigningDocumentsConnection,
"allocationOfferingLinksByCreatedBy": AllocationOfferingLinksConnection,
"allocationOfferingLinksByAgentId": AllocationOfferingLinksConnection,
"accountPhoneNumbersByAccountId": AccountPhoneNumbersConnection,
"accountRegDStatusByAccountId": AccountRegDStatus,
"accountRegDStatusesByAccountId": AccountRegDStatusesConnection,
"accountTaxInformationsByAccountId": AccountTaxInformationsConnection,
"onboardingQuestionSetsByAccountId": OnboardingQuestionSetsConnection,
"onboardingQuestionsByAccountId": OnboardingQuestionsConnection,
"instancedAccountInformationsByAccountId": InstancedAccountInformationsConnection,
"instancedAccountInformationsByVendorAccountId": InstancedAccountInformationsConnection,
"instancedMappingFieldsByAccountId": InstancedMappingFieldsConnection,
"vendorDefaultEmailPreferenceByAccountId": VendorDefaultEmailPreference,
"vendorDefaultEmailPreferencesByAccountId": VendorDefaultEmailPreferencesConnection,
"allocationEmailPreferencesByAccountId": AllocationEmailPreferencesConnection,
"securitiesByIssuerId": SecuritiesConnection,
"securitiesByTaId": SecuritiesConnection,
"holdingsByInvestorId": HoldingsConnection,
"issuanceEventsByInvestorId": IssuanceEventsConnection,
"issuanceEventsByIssuerId": IssuanceEventsConnection,
"vendorAgentsByAgentId": VendorAgentsConnection,
"vendorAgentsByVendorId": VendorAgentsConnection,
"securityListingsByIssuerId": SecurityListingsConnection,
"securityListingsByAtsId": SecurityListingsConnection,
"documentsByUploadedBy": DocumentsConnection,
"accountDocumentsByFromAccountId": AccountDocumentsConnection,
"accountDocumentsByToAccountId": AccountDocumentsConnection,
"documentSharingsByUploaderId": DocumentSharingsConnection,
"accountRestrictionsByAccountId": AccountRestrictionsConnection,
"accountRestrictionsByCreatorAccountId": AccountRestrictionsConnection,
"paymentAccountsByAccountId": PaymentAccountsConnection,
"paymentMethodsByAccountId": PaymentMethodsConnection,
"paymentIssuersByIssuerId": PaymentIssuersConnection,
"paymentIssuersByAccountId": PaymentIssuersConnection,
"omnibusHoldingsByAccountId": OmnibusHoldingsConnection,
"omnibusInvestorsByInvestorId": OmnibusInvestorsConnection,
"omnibusInvestorsByAccountId": OmnibusInvestorsConnection,
"webhookConfigurationsByAccountId": WebhookConfigurationsConnection,
"customerPartiesByCreatorAccountId": CustomerPartiesConnection,
"customerAddressesByCreatorAccountId": CustomerAddressesConnection,
"customerPartyAddressesByCreatorAccountId": CustomerPartyAddressesConnection,
"blockchainAddressSourcesByVendorId": BlockchainAddressSourcesConnection,
"blockchainAddressSourcesByInvestorId": BlockchainAddressSourcesConnection,
"blockchainAddressSourcesByCreatorAccountId": BlockchainAddressSourcesConnection,
"taRequestsByVendorId": TaRequestsConnection,
"taRequestsByInvestorId": TaRequestsConnection,
"taRequestsByCreatorAccountId": TaRequestsConnection,
"accountAddressesByAccountId": AccountAddressesConnection,
"atsTagsByAccountId": AtsTagsConnection,
"idempotentsByAtsId": IdempotentsConnection,
"partiesByAccountId": PartiesConnection,
"partyAddressesByAccountId": PartyAddressesConnection,
"requestsByAccountId": RequestsConnection,
"stagedBalanceTransfersByToAccountId": StagedBalanceTransfersConnection,
"stagedBalanceTransfersByFromAccountId": StagedBalanceTransfersConnection,
"stagedTransfersByAccountId": StagedTransfersConnection,
"tradesByAtsId": TradesConnection,
"tradesByFromAccountId": TradesConnection,
"tradesByToAccountId": TradesConnection,
"transfersByAtsId": TransfersConnection,
"transfersByFromAccountId": TransfersConnection,
"transfersByToAccountId": TransfersConnection,
"contactName": "abc123",
"holdings": BigFloat,
"taxShort": "abc123"
}
AccountAddress
Description
@foreignKey(type) REFERENCES vertalo.address_types(type) @foreignKey(account_id) REFERENCES vertalo.accounts(id) @foreignKey(address_id) REFERENCES vertalo.addresses(id) @foreignKey(party_id) REFERENCES vertalo.parties(id) @omit create,update,delete
Fields
| Field Name | Description |
|---|---|
id - UUID
|
|
accountId - UUID
|
|
addressId - UUID
|
|
type - String
|
|
addressTypeByType - AddressType
|
Reads a single AddressType that is related to this AccountAddress. |
addressByAddressId - Address
|
Reads a single Address that is related to this AccountAddress. |
accountByAccountId - Account
|
Reads a single Account that is related to this AccountAddress. |
Example
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"addressId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"type": "xyz789",
"addressTypeByType": AddressType,
"addressByAddressId": Address,
"accountByAccountId": Account
}
AccountAddressCondition
Description
A condition to be used against AccountAddress object types. All fields are tested for equality and combined with a logical ‘and.’
Example
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"addressId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"type": "abc123"
}
AccountAddressFilter
Description
A filter to be used against AccountAddress object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
id - UUIDFilter
|
Filter by the object’s id field. |
accountId - UUIDFilter
|
Filter by the object’s accountId field. |
addressId - UUIDFilter
|
Filter by the object’s addressId field. |
type - StringFilter
|
Filter by the object’s type field. |
addressTypeByType - AddressTypeFilter
|
Filter by the object’s addressTypeByType relation. |
addressTypeByTypeExists - Boolean
|
A related addressTypeByType exists. |
addressByAddressId - AddressFilter
|
Filter by the object’s addressByAddressId relation. |
addressByAddressIdExists - Boolean
|
A related addressByAddressId exists. |
accountByAccountId - AccountFilter
|
Filter by the object’s accountByAccountId relation. |
accountByAccountIdExists - Boolean
|
A related accountByAccountId exists. |
and - [AccountAddressFilter!]
|
Checks for all expressions in this list. |
or - [AccountAddressFilter!]
|
Checks for any expressions in this list. |
not - AccountAddressFilter
|
Negates the expression. |
Example
{
"id": UUIDFilter,
"accountId": UUIDFilter,
"addressId": UUIDFilter,
"type": StringFilter,
"addressTypeByType": AddressTypeFilter,
"addressTypeByTypeExists": true,
"addressByAddressId": AddressFilter,
"addressByAddressIdExists": false,
"accountByAccountId": AccountFilter,
"accountByAccountIdExists": false,
"and": [AccountAddressFilter],
"or": [AccountAddressFilter],
"not": AccountAddressFilter
}
AccountAddressesConnection
Description
A connection to a list of AccountAddress values.
Fields
| Field Name | Description |
|---|---|
nodes - [AccountAddress]!
|
A list of AccountAddress objects. |
edges - [AccountAddressesEdge!]!
|
A list of edges which contains the AccountAddress and cursor to aid in pagination. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The count of all AccountAddress you could get from the connection. |
Example
{
"nodes": [AccountAddress],
"edges": [AccountAddressesEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
AccountAddressesEdge
Description
A AccountAddress edge in the connection.
Fields
| Field Name | Description |
|---|---|
cursor - Cursor
|
A cursor for use in pagination. |
node - AccountAddress
|
The AccountAddress at the end of the edge. |
Example
{
"cursor": Cursor,
"node": AccountAddress
}
AccountAddressesOrderBy
Description
Methods to use when ordering AccountAddress.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NATURAL"
AccountCondition
Description
A condition to be used against Account object types. All fields are tested for equality and combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
type - String
|
Checks for equality with the object’s type field. |
company - UUID
|
Checks for equality with the object’s company field. |
name - String
|
Checks for equality with the object’s name field. |
jurisdiction - UUID
|
Checks for equality with the object’s jurisdiction field. |
email - String
|
Checks for equality with the object’s email field. |
url - String
|
Checks for equality with the object’s url field. |
slug - String
|
Checks for equality with the object’s slug field. |
twitterHandle - String
|
Checks for equality with the object’s twitterHandle field. |
supportEmail - String
|
Checks for equality with the object’s supportEmail field. |
newId - UUID
|
Checks for equality with the object’s newId field. |
setup - Boolean
|
Checks for equality with the object’s setup field. |
entity - Boolean
|
Checks for equality with the object’s entity field. |
oldId - Int
|
Checks for equality with the object’s oldId field. |
id - UUID
|
Checks for equality with the object’s id field. |
createdOn - Datetime
|
Checks for equality with the object’s createdOn field. |
investorType - String
|
Checks for equality with the object’s investorType field. |
formationDate - Date
|
Checks for equality with the object’s formationDate field. |
externalEmail - String
|
Checks for equality with the object’s externalEmail field. |
useReal - Boolean
|
Checks for equality with the object’s useReal field. |
Example
{
"type": "xyz789",
"company": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"name": "abc123",
"jurisdiction": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"email": "abc123",
"url": "xyz789",
"slug": "xyz789",
"twitterHandle": "abc123",
"supportEmail": "abc123",
"newId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"setup": true,
"entity": true,
"oldId": 987,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"createdOn": Datetime,
"investorType": "abc123",
"formationDate": "2007-12-03",
"externalEmail": "abc123",
"useReal": false
}
AccountDocument
Fields
| Field Name | Description |
|---|---|
nodeId - ID!
|
A globally unique identifier. Can be used in various places throughout the system to identify this single value. |
id - UUID!
|
|
documentId - UUID!
|
|
fromAccountId - UUID!
|
|
toAccountId - UUID!
|
|
createdOn - Datetime!
|
|
createdBy - UUID!
|
|
documentByDocumentId - Document
|
Reads a single Document that is related to this AccountDocument. |
accountByFromAccountId - Account
|
Reads a single Account that is related to this AccountDocument. |
accountByToAccountId - Account
|
Reads a single Account that is related to this AccountDocument. |
userByCreatedBy - User
|
Reads a single User that is related to this AccountDocument. |
Example
{
"nodeId": "4",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"documentId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"fromAccountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"toAccountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"createdOn": Datetime,
"createdBy": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"documentByDocumentId": Document,
"accountByFromAccountId": Account,
"accountByToAccountId": Account,
"userByCreatedBy": User
}
AccountDocumentCondition
Description
A condition to be used against AccountDocument object types. All fields are tested for equality and combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
id - UUID
|
Checks for equality with the object’s id field. |
documentId - UUID
|
Checks for equality with the object’s documentId field. |
fromAccountId - UUID
|
Checks for equality with the object’s fromAccountId field. |
toAccountId - UUID
|
Checks for equality with the object’s toAccountId field. |
createdOn - Datetime
|
Checks for equality with the object’s createdOn field. |
createdBy - UUID
|
Checks for equality with the object’s createdBy field. |
Example
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"documentId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"fromAccountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"toAccountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"createdOn": Datetime,
"createdBy": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
AccountDocumentFilter
Description
A filter to be used against AccountDocument object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
id - UUIDFilter
|
Filter by the object’s id field. |
documentId - UUIDFilter
|
Filter by the object’s documentId field. |
fromAccountId - UUIDFilter
|
Filter by the object’s fromAccountId field. |
toAccountId - UUIDFilter
|
Filter by the object’s toAccountId field. |
createdOn - DatetimeFilter
|
Filter by the object’s createdOn field. |
createdBy - UUIDFilter
|
Filter by the object’s createdBy field. |
documentByDocumentId - DocumentFilter
|
Filter by the object’s documentByDocumentId relation. |
accountByFromAccountId - AccountFilter
|
Filter by the object’s accountByFromAccountId relation. |
accountByToAccountId - AccountFilter
|
Filter by the object’s accountByToAccountId relation. |
userByCreatedBy - UserFilter
|
Filter by the object’s userByCreatedBy relation. |
and - [AccountDocumentFilter!]
|
Checks for all expressions in this list. |
or - [AccountDocumentFilter!]
|
Checks for any expressions in this list. |
not - AccountDocumentFilter
|
Negates the expression. |
Example
{
"id": UUIDFilter,
"documentId": UUIDFilter,
"fromAccountId": UUIDFilter,
"toAccountId": UUIDFilter,
"createdOn": DatetimeFilter,
"createdBy": UUIDFilter,
"documentByDocumentId": DocumentFilter,
"accountByFromAccountId": AccountFilter,
"accountByToAccountId": AccountFilter,
"userByCreatedBy": UserFilter,
"and": [AccountDocumentFilter],
"or": [AccountDocumentFilter],
"not": AccountDocumentFilter
}
AccountDocumentsConnection
Description
A connection to a list of AccountDocument values.
Fields
| Field Name | Description |
|---|---|
nodes - [AccountDocument]!
|
A list of AccountDocument objects. |
edges - [AccountDocumentsEdge!]!
|
A list of edges which contains the AccountDocument and cursor to aid in pagination. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The count of all AccountDocument you could get from the connection. |
Example
{
"nodes": [AccountDocument],
"edges": [AccountDocumentsEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
AccountDocumentsEdge
Description
A AccountDocument edge in the connection.
Fields
| Field Name | Description |
|---|---|
cursor - Cursor
|
A cursor for use in pagination. |
node - AccountDocument
|
The AccountDocument at the end of the edge. |
Example
{
"cursor": Cursor,
"node": AccountDocument
}
AccountDocumentsOrderBy
Description
Methods to use when ordering AccountDocument.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NATURAL"
AccountFilter
Description
A filter to be used against Account object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
type - StringFilter
|
Filter by the object’s type field. |
company - UUIDFilter
|
Filter by the object’s company field. |
name - StringFilter
|
Filter by the object’s name field. |
jurisdiction - UUIDFilter
|
Filter by the object’s jurisdiction field. |
email - StringFilter
|
Filter by the object’s email field. |
url - StringFilter
|
Filter by the object’s url field. |
slug - StringFilter
|
Filter by the object’s slug field. |
twitterHandle - StringFilter
|
Filter by the object’s twitterHandle field. |
supportEmail - StringFilter
|
Filter by the object’s supportEmail field. |
newId - UUIDFilter
|
Filter by the object’s newId field. |
setup - BooleanFilter
|
Filter by the object’s setup field. |
entity - BooleanFilter
|
Filter by the object’s entity field. |
oldId - IntFilter
|
Filter by the object’s oldId field. |
id - UUIDFilter
|
Filter by the object’s id field. |
createdOn - DatetimeFilter
|
Filter by the object’s createdOn field. |
investorType - StringFilter
|
Filter by the object’s investorType field. |
formationDate - DateFilter
|
Filter by the object’s formationDate field. |
externalEmail - StringFilter
|
Filter by the object’s externalEmail field. |
useReal - BooleanFilter
|
Filter by the object’s useReal field. |
contactName - StringFilter
|
Filter by the object’s contactName field. |
holdings - BigFloatFilter
|
Filter by the object’s holdings field. |
taxShort - StringFilter
|
Filter by the object’s taxShort field. |
customersByVendorId - AccountToManyCustomerFilter
|
Filter by the object’s customersByVendorId relation. |
customersByVendorIdExist - Boolean
|
Some related customersByVendorId exist. |
customersByInvestorId - AccountToManyCustomerFilter
|
Filter by the object’s customersByInvestorId relation. |
customersByInvestorIdExist - Boolean
|
Some related customersByInvestorId exist. |
usersAccountsByAccountId - AccountToManyUsersAccountFilter
|
Filter by the object’s usersAccountsByAccountId relation. |
usersAccountsByAccountIdExist - Boolean
|
Some related usersAccountsByAccountId exist. |
accountsBlockchainAddressesByAccountId - AccountToManyAccountsBlockchainAddressFilter
|
Filter by the object’s accountsBlockchainAddressesByAccountId relation. |
accountsBlockchainAddressesByAccountIdExist - Boolean
|
Some related accountsBlockchainAddressesByAccountId exist. |
blockchainRegistrationsByAccountId - AccountToManyBlockchainRegistrationFilter
|
Filter by the object’s blockchainRegistrationsByAccountId relation. |
blockchainRegistrationsByAccountIdExist - Boolean
|
Some related blockchainRegistrationsByAccountId exist. |
assetsByIssuerId - AccountToManyAssetFilter
|
Filter by the object’s assetsByIssuerId relation. |
assetsByIssuerIdExist - Boolean
|
Some related assetsByIssuerId exist. |
assetArchivesByAccountId - AccountToManyAssetArchiveFilter
|
Filter by the object’s assetArchivesByAccountId relation. |
assetArchivesByAccountIdExist - Boolean
|
Some related assetArchivesByAccountId exist. |
allocationsByOwnerId - AccountToManyAllocationFilter
|
Filter by the object’s allocationsByOwnerId relation. |
allocationsByOwnerIdExist - Boolean
|
Some related allocationsByOwnerId exist. |
allocationsByIssuerId - AccountToManyAllocationFilter
|
Filter by the object’s allocationsByIssuerId relation. |
allocationsByIssuerIdExist - Boolean
|
Some related allocationsByIssuerId exist. |
allocationArchivesByAccountId - AccountToManyAllocationArchiveFilter
|
Filter by the object’s allocationArchivesByAccountId relation. |
allocationArchivesByAccountIdExist - Boolean
|
Some related allocationArchivesByAccountId exist. |
brokerAllocationsByBrokerId - AccountToManyBrokerAllocationFilter
|
Filter by the object’s brokerAllocationsByBrokerId relation. |
brokerAllocationsByBrokerIdExist - Boolean
|
Some related brokerAllocationsByBrokerId exist. |
distributionsByInvestorId - AccountToManyDistributionFilter
|
Filter by the object’s distributionsByInvestorId relation. |
distributionsByInvestorIdExist - Boolean
|
Some related distributionsByInvestorId exist. |
transactionsByBrokerId - AccountToManyTransactionFilter
|
Filter by the object’s transactionsByBrokerId relation. |
transactionsByBrokerIdExist - Boolean
|
Some related transactionsByBrokerId exist. |
ledgersByInvestorId - AccountToManyLedgerFilter
|
Filter by the object’s ledgersByInvestorId relation. |
ledgersByInvestorIdExist - Boolean
|
Some related ledgersByInvestorId exist. |
distributionAnnotationsByAccountId - AccountToManyDistributionAnnotationFilter
|
Filter by the object’s distributionAnnotationsByAccountId relation. |
distributionAnnotationsByAccountIdExist - Boolean
|
Some related distributionAnnotationsByAccountId exist. |
assetAnnotationsByAccountId - AccountToManyAssetAnnotationFilter
|
Filter by the object’s assetAnnotationsByAccountId relation. |
assetAnnotationsByAccountIdExist - Boolean
|
Some related assetAnnotationsByAccountId exist. |
allocationAnnotationsByAccountId - AccountToManyAllocationAnnotationFilter
|
Filter by the object’s allocationAnnotationsByAccountId relation. |
allocationAnnotationsByAccountIdExist - Boolean
|
Some related allocationAnnotationsByAccountId exist. |
transactionAnnotationsByAccountId - AccountToManyTransactionAnnotationFilter
|
Filter by the object’s transactionAnnotationsByAccountId relation. |
transactionAnnotationsByAccountIdExist - Boolean
|
Some related transactionAnnotationsByAccountId exist. |
managedAccountsByManagerId - AccountToManyManagedAccountFilter
|
Filter by the object’s managedAccountsByManagerId relation. |
managedAccountsByManagerIdExist - Boolean
|
Some related managedAccountsByManagerId exist. |
managedAccountsByEntityId - AccountToManyManagedAccountFilter
|
Filter by the object’s managedAccountsByEntityId relation. |
managedAccountsByEntityIdExist - Boolean
|
Some related managedAccountsByEntityId exist. |
accountIntegrationsByAccountId - AccountToManyAccountIntegrationFilter
|
Filter by the object’s accountIntegrationsByAccountId relation. |
accountIntegrationsByAccountIdExist - Boolean
|
Some related accountIntegrationsByAccountId exist. |
vendorQualificationsByAccountId - AccountToManyVendorQualificationFilter
|
Filter by the object’s vendorQualificationsByAccountId relation. |
vendorQualificationsByAccountIdExist - Boolean
|
Some related vendorQualificationsByAccountId exist. |
stepsByOwnedBy - AccountToManyStepFilter
|
Filter by the object’s stepsByOwnedBy relation. |
stepsByOwnedByExist - Boolean
|
Some related stepsByOwnedBy exist. |
stepsByExecuteBy - AccountToManyStepFilter
|
Filter by the object’s stepsByExecuteBy relation. |
stepsByExecuteByExist - Boolean
|
Some related stepsByExecuteBy exist. |
distributionCustomFieldsByCreatedBy - AccountToManyDistributionCustomFieldFilter
|
Filter by the object’s distributionCustomFieldsByCreatedBy relation. |
distributionCustomFieldsByCreatedByExist - Boolean
|
Some related distributionCustomFieldsByCreatedBy exist. |
signingAccountsByAccountId - AccountToManySigningAccountFilter
|
Filter by the object’s signingAccountsByAccountId relation. |
signingAccountsByAccountIdExist - Boolean
|
Some related signingAccountsByAccountId exist. |
signingTemplatesByAccountId - AccountToManySigningTemplateFilter
|
Filter by the object’s signingTemplatesByAccountId relation. |
signingTemplatesByAccountIdExist - Boolean
|
Some related signingTemplatesByAccountId exist. |
mappedSigningTemplatesByAccountId - AccountToManyMappedSigningTemplateFilter
|
Filter by the object’s mappedSigningTemplatesByAccountId relation. |
mappedSigningTemplatesByAccountIdExist - Boolean
|
Some related mappedSigningTemplatesByAccountId exist. |
sentSigningDocumentsBySentTo - AccountToManySentSigningDocumentFilter
|
Filter by the object’s sentSigningDocumentsBySentTo relation. |
sentSigningDocumentsBySentToExist - Boolean
|
Some related sentSigningDocumentsBySentTo exist. |
allocationOfferingLinksByCreatedBy - AccountToManyAllocationOfferingLinkFilter
|
Filter by the object’s allocationOfferingLinksByCreatedBy relation. |
allocationOfferingLinksByCreatedByExist - Boolean
|
Some related allocationOfferingLinksByCreatedBy exist. |
allocationOfferingLinksByAgentId - AccountToManyAllocationOfferingLinkFilter
|
Filter by the object’s allocationOfferingLinksByAgentId relation. |
allocationOfferingLinksByAgentIdExist - Boolean
|
Some related allocationOfferingLinksByAgentId exist. |
accountPhoneNumbersByAccountId - AccountToManyAccountPhoneNumberFilter
|
Filter by the object’s accountPhoneNumbersByAccountId relation. |
accountPhoneNumbersByAccountIdExist - Boolean
|
Some related accountPhoneNumbersByAccountId exist. |
accountRegDStatusByAccountId - AccountRegDStatusFilter
|
Filter by the object’s accountRegDStatusByAccountId relation. |
accountRegDStatusByAccountIdExists - Boolean
|
A related accountRegDStatusByAccountId exists. |
accountTaxInformationsByAccountId - AccountToManyAccountTaxInformationFilter
|
Filter by the object’s accountTaxInformationsByAccountId relation. |
accountTaxInformationsByAccountIdExist - Boolean
|
Some related accountTaxInformationsByAccountId exist. |
onboardingQuestionSetsByAccountId - AccountToManyOnboardingQuestionSetFilter
|
Filter by the object’s onboardingQuestionSetsByAccountId relation. |
onboardingQuestionSetsByAccountIdExist - Boolean
|
Some related onboardingQuestionSetsByAccountId exist. |
onboardingQuestionsByAccountId - AccountToManyOnboardingQuestionFilter
|
Filter by the object’s onboardingQuestionsByAccountId relation. |
onboardingQuestionsByAccountIdExist - Boolean
|
Some related onboardingQuestionsByAccountId exist. |
instancedAccountInformationsByAccountId - AccountToManyInstancedAccountInformationFilter
|
Filter by the object’s instancedAccountInformationsByAccountId relation. |
instancedAccountInformationsByAccountIdExist - Boolean
|
Some related instancedAccountInformationsByAccountId exist. |
instancedAccountInformationsByVendorAccountId - AccountToManyInstancedAccountInformationFilter
|
Filter by the object’s instancedAccountInformationsByVendorAccountId relation. |
instancedAccountInformationsByVendorAccountIdExist - Boolean
|
Some related instancedAccountInformationsByVendorAccountId exist. |
instancedMappingFieldsByAccountId - AccountToManyInstancedMappingFieldFilter
|
Filter by the object’s instancedMappingFieldsByAccountId relation. |
instancedMappingFieldsByAccountIdExist - Boolean
|
Some related instancedMappingFieldsByAccountId exist. |
vendorDefaultEmailPreferenceByAccountId - VendorDefaultEmailPreferenceFilter
|
Filter by the object’s vendorDefaultEmailPreferenceByAccountId relation. |
vendorDefaultEmailPreferenceByAccountIdExists - Boolean
|
A related vendorDefaultEmailPreferenceByAccountId exists. |
allocationEmailPreferencesByAccountId - AccountToManyAllocationEmailPreferenceFilter
|
Filter by the object’s allocationEmailPreferencesByAccountId relation. |
allocationEmailPreferencesByAccountIdExist - Boolean
|
Some related allocationEmailPreferencesByAccountId exist. |
securitiesByIssuerId - AccountToManySecurityFilter
|
Filter by the object’s securitiesByIssuerId relation. |
securitiesByIssuerIdExist - Boolean
|
Some related securitiesByIssuerId exist. |
securitiesByTaId - AccountToManySecurityFilter
|
Filter by the object’s securitiesByTaId relation. |
securitiesByTaIdExist - Boolean
|
Some related securitiesByTaId exist. |
holdingsByInvestorId - AccountToManyHoldingFilter
|
Filter by the object’s holdingsByInvestorId relation. |
holdingsByInvestorIdExist - Boolean
|
Some related holdingsByInvestorId exist. |
issuanceEventsByInvestorId - AccountToManyIssuanceEventFilter
|
Filter by the object’s issuanceEventsByInvestorId relation. |
issuanceEventsByInvestorIdExist - Boolean
|
Some related issuanceEventsByInvestorId exist. |
issuanceEventsByIssuerId - AccountToManyIssuanceEventFilter
|
Filter by the object’s issuanceEventsByIssuerId relation. |
issuanceEventsByIssuerIdExist - Boolean
|
Some related issuanceEventsByIssuerId exist. |
vendorAgentsByAgentId - AccountToManyVendorAgentFilter
|
Filter by the object’s vendorAgentsByAgentId relation. |
vendorAgentsByAgentIdExist - Boolean
|
Some related vendorAgentsByAgentId exist. |
vendorAgentsByVendorId - AccountToManyVendorAgentFilter
|
Filter by the object’s vendorAgentsByVendorId relation. |
vendorAgentsByVendorIdExist - Boolean
|
Some related vendorAgentsByVendorId exist. |
securityListingsByIssuerId - AccountToManySecurityListingFilter
|
Filter by the object’s securityListingsByIssuerId relation. |
securityListingsByIssuerIdExist - Boolean
|
Some related securityListingsByIssuerId exist. |
securityListingsByAtsId - AccountToManySecurityListingFilter
|
Filter by the object’s securityListingsByAtsId relation. |
securityListingsByAtsIdExist - Boolean
|
Some related securityListingsByAtsId exist. |
documentsByUploadedBy - AccountToManyDocumentFilter
|
Filter by the object’s documentsByUploadedBy relation. |
documentsByUploadedByExist - Boolean
|
Some related documentsByUploadedBy exist. |
accountDocumentsByFromAccountId - AccountToManyAccountDocumentFilter
|
Filter by the object’s accountDocumentsByFromAccountId relation. |
accountDocumentsByFromAccountIdExist - Boolean
|
Some related accountDocumentsByFromAccountId exist. |
accountDocumentsByToAccountId - AccountToManyAccountDocumentFilter
|
Filter by the object’s accountDocumentsByToAccountId relation. |
accountDocumentsByToAccountIdExist - Boolean
|
Some related accountDocumentsByToAccountId exist. |
documentSharingsByUploaderId - AccountToManyDocumentSharingFilter
|
Filter by the object’s documentSharingsByUploaderId relation. |
documentSharingsByUploaderIdExist - Boolean
|
Some related documentSharingsByUploaderId exist. |
accountRestrictionsByAccountId - AccountToManyAccountRestrictionFilter
|
Filter by the object’s accountRestrictionsByAccountId relation. |
accountRestrictionsByAccountIdExist - Boolean
|
Some related accountRestrictionsByAccountId exist. |
accountRestrictionsByCreatorAccountId - AccountToManyAccountRestrictionFilter
|
Filter by the object’s accountRestrictionsByCreatorAccountId relation. |
accountRestrictionsByCreatorAccountIdExist - Boolean
|
Some related accountRestrictionsByCreatorAccountId exist. |
paymentAccountsByAccountId - AccountToManyPaymentAccountFilter
|
Filter by the object’s paymentAccountsByAccountId relation. |
paymentAccountsByAccountIdExist - Boolean
|
Some related paymentAccountsByAccountId exist. |
paymentMethodsByAccountId - AccountToManyPaymentMethodFilter
|
Filter by the object’s paymentMethodsByAccountId relation. |
paymentMethodsByAccountIdExist - Boolean
|
Some related paymentMethodsByAccountId exist. |
paymentIssuersByIssuerId - AccountToManyPaymentIssuerFilter
|
Filter by the object’s paymentIssuersByIssuerId relation. |
paymentIssuersByIssuerIdExist - Boolean
|
Some related paymentIssuersByIssuerId exist. |
paymentIssuersByAccountId - AccountToManyPaymentIssuerFilter
|
Filter by the object’s paymentIssuersByAccountId relation. |
paymentIssuersByAccountIdExist - Boolean
|
Some related paymentIssuersByAccountId exist. |
omnibusHoldingsByAccountId - AccountToManyOmnibusHoldingFilter
|
Filter by the object’s omnibusHoldingsByAccountId relation. |
omnibusHoldingsByAccountIdExist - Boolean
|
Some related omnibusHoldingsByAccountId exist. |
omnibusInvestorsByInvestorId - AccountToManyOmnibusInvestorFilter
|
Filter by the object’s omnibusInvestorsByInvestorId relation. |
omnibusInvestorsByInvestorIdExist - Boolean
|
Some related omnibusInvestorsByInvestorId exist. |
omnibusInvestorsByAccountId - AccountToManyOmnibusInvestorFilter
|
Filter by the object’s omnibusInvestorsByAccountId relation. |
omnibusInvestorsByAccountIdExist - Boolean
|
Some related omnibusInvestorsByAccountId exist. |
webhookConfigurationsByAccountId - AccountToManyWebhookConfigurationFilter
|
Filter by the object’s webhookConfigurationsByAccountId relation. |
webhookConfigurationsByAccountIdExist - Boolean
|
Some related webhookConfigurationsByAccountId exist. |
customerPartiesByCreatorAccountId - AccountToManyCustomerPartyFilter
|
Filter by the object’s customerPartiesByCreatorAccountId relation. |
customerPartiesByCreatorAccountIdExist - Boolean
|
Some related customerPartiesByCreatorAccountId exist. |
customerAddressesByCreatorAccountId - AccountToManyCustomerAddressFilter
|
Filter by the object’s customerAddressesByCreatorAccountId relation. |
customerAddressesByCreatorAccountIdExist - Boolean
|
Some related customerAddressesByCreatorAccountId exist. |
customerPartyAddressesByCreatorAccountId - AccountToManyCustomerPartyAddressFilter
|
Filter by the object’s customerPartyAddressesByCreatorAccountId relation. |
customerPartyAddressesByCreatorAccountIdExist - Boolean
|
Some related customerPartyAddressesByCreatorAccountId exist. |
blockchainAddressSourcesByVendorId - AccountToManyBlockchainAddressSourceFilter
|
Filter by the object’s blockchainAddressSourcesByVendorId relation. |
blockchainAddressSourcesByVendorIdExist - Boolean
|
Some related blockchainAddressSourcesByVendorId exist. |
blockchainAddressSourcesByInvestorId - AccountToManyBlockchainAddressSourceFilter
|
Filter by the object’s blockchainAddressSourcesByInvestorId relation. |
blockchainAddressSourcesByInvestorIdExist - Boolean
|
Some related blockchainAddressSourcesByInvestorId exist. |
blockchainAddressSourcesByCreatorAccountId - AccountToManyBlockchainAddressSourceFilter
|
Filter by the object’s blockchainAddressSourcesByCreatorAccountId relation. |
blockchainAddressSourcesByCreatorAccountIdExist - Boolean
|
Some related blockchainAddressSourcesByCreatorAccountId exist. |
taRequestsByVendorId - AccountToManyTaRequestFilter
|
Filter by the object’s taRequestsByVendorId relation. |
taRequestsByVendorIdExist - Boolean
|
Some related taRequestsByVendorId exist. |
taRequestsByInvestorId - AccountToManyTaRequestFilter
|
Filter by the object’s taRequestsByInvestorId relation. |
taRequestsByInvestorIdExist - Boolean
|
Some related taRequestsByInvestorId exist. |
taRequestsByCreatorAccountId - AccountToManyTaRequestFilter
|
Filter by the object’s taRequestsByCreatorAccountId relation. |
taRequestsByCreatorAccountIdExist - Boolean
|
Some related taRequestsByCreatorAccountId exist. |
accountAddressesByAccountId - AccountToManyAccountAddressFilter
|
Filter by the object’s accountAddressesByAccountId relation. |
accountAddressesByAccountIdExist - Boolean
|
Some related accountAddressesByAccountId exist. |
atsTagsByAccountId - AccountToManyAtsTagFilter
|
Filter by the object’s atsTagsByAccountId relation. |
atsTagsByAccountIdExist - Boolean
|
Some related atsTagsByAccountId exist. |
idempotentsByAtsId - AccountToManyIdempotentFilter
|
Filter by the object’s idempotentsByAtsId relation. |
idempotentsByAtsIdExist - Boolean
|
Some related idempotentsByAtsId exist. |
partiesByAccountId - AccountToManyPartyFilter
|
Filter by the object’s partiesByAccountId relation. |
partiesByAccountIdExist - Boolean
|
Some related partiesByAccountId exist. |
partyAddressesByAccountId - AccountToManyPartyAddressFilter
|
Filter by the object’s partyAddressesByAccountId relation. |
partyAddressesByAccountIdExist - Boolean
|
Some related partyAddressesByAccountId exist. |
requestsByAccountId - AccountToManyRequestFilter
|
Filter by the object’s requestsByAccountId relation. |
requestsByAccountIdExist - Boolean
|
Some related requestsByAccountId exist. |
stagedBalanceTransfersByToAccountId - AccountToManyStagedBalanceTransferFilter
|
Filter by the object’s stagedBalanceTransfersByToAccountId relation. |
stagedBalanceTransfersByToAccountIdExist - Boolean
|
Some related stagedBalanceTransfersByToAccountId exist. |
stagedBalanceTransfersByFromAccountId - AccountToManyStagedBalanceTransferFilter
|
Filter by the object’s stagedBalanceTransfersByFromAccountId relation. |
stagedBalanceTransfersByFromAccountIdExist - Boolean
|
Some related stagedBalanceTransfersByFromAccountId exist. |
stagedTransfersByAccountId - AccountToManyStagedTransferFilter
|
Filter by the object’s stagedTransfersByAccountId relation. |
stagedTransfersByAccountIdExist - Boolean
|
Some related stagedTransfersByAccountId exist. |
tradesByAtsId - AccountToManyTradeFilter
|
Filter by the object’s tradesByAtsId relation. |
tradesByAtsIdExist - Boolean
|
Some related tradesByAtsId exist. |
tradesByFromAccountId - AccountToManyTradeFilter
|
Filter by the object’s tradesByFromAccountId relation. |
tradesByFromAccountIdExist - Boolean
|
Some related tradesByFromAccountId exist. |
tradesByToAccountId - AccountToManyTradeFilter
|
Filter by the object’s tradesByToAccountId relation. |
tradesByToAccountIdExist - Boolean
|
Some related tradesByToAccountId exist. |
transfersByAtsId - AccountToManyTransferFilter
|
Filter by the object’s transfersByAtsId relation. |
transfersByAtsIdExist - Boolean
|
Some related transfersByAtsId exist. |
transfersByFromAccountId - AccountToManyTransferFilter
|
Filter by the object’s transfersByFromAccountId relation. |
transfersByFromAccountIdExist - Boolean
|
Some related transfersByFromAccountId exist. |
transfersByToAccountId - AccountToManyTransferFilter
|
Filter by the object’s transfersByToAccountId relation. |
transfersByToAccountIdExist - Boolean
|
Some related transfersByToAccountId exist. |
auxAccountByType - AuxAccountFilter
|
Filter by the object’s auxAccountByType relation. |
companyByCompany - CompanyFilter
|
Filter by the object’s companyByCompany relation. |
companyByCompanyExists - Boolean
|
A related companyByCompany exists. |
countryByJurisdiction - CountryFilter
|
Filter by the object’s countryByJurisdiction relation. |
investorAccountTypeByInvestorType - InvestorAccountTypeFilter
|
Filter by the object’s investorAccountTypeByInvestorType relation. |
investorAccountTypeByInvestorTypeExists - Boolean
|
A related investorAccountTypeByInvestorType exists. |
and - [AccountFilter!]
|
Checks for all expressions in this list. |
or - [AccountFilter!]
|
Checks for any expressions in this list. |
not - AccountFilter
|
Negates the expression. |
Example
{
"type": StringFilter,
"company": UUIDFilter,
"name": StringFilter,
"jurisdiction": UUIDFilter,
"email": StringFilter,
"url": StringFilter,
"slug": StringFilter,
"twitterHandle": StringFilter,
"supportEmail": StringFilter,
"newId": UUIDFilter,
"setup": BooleanFilter,
"entity": BooleanFilter,
"oldId": IntFilter,
"id": UUIDFilter,
"createdOn": DatetimeFilter,
"investorType": StringFilter,
"formationDate": DateFilter,
"externalEmail": StringFilter,
"useReal": BooleanFilter,
"contactName": StringFilter,
"holdings": BigFloatFilter,
"taxShort": StringFilter,
"customersByVendorId": AccountToManyCustomerFilter,
"customersByVendorIdExist": false,
"customersByInvestorId": AccountToManyCustomerFilter,
"customersByInvestorIdExist": true,
"usersAccountsByAccountId": AccountToManyUsersAccountFilter,
"usersAccountsByAccountIdExist": false,
"accountsBlockchainAddressesByAccountId": AccountToManyAccountsBlockchainAddressFilter,
"accountsBlockchainAddressesByAccountIdExist": true,
"blockchainRegistrationsByAccountId": AccountToManyBlockchainRegistrationFilter,
"blockchainRegistrationsByAccountIdExist": true,
"assetsByIssuerId": AccountToManyAssetFilter,
"assetsByIssuerIdExist": false,
"assetArchivesByAccountId": AccountToManyAssetArchiveFilter,
"assetArchivesByAccountIdExist": false,
"allocationsByOwnerId": AccountToManyAllocationFilter,
"allocationsByOwnerIdExist": false,
"allocationsByIssuerId": AccountToManyAllocationFilter,
"allocationsByIssuerIdExist": false,
"allocationArchivesByAccountId": AccountToManyAllocationArchiveFilter,
"allocationArchivesByAccountIdExist": false,
"brokerAllocationsByBrokerId": AccountToManyBrokerAllocationFilter,
"brokerAllocationsByBrokerIdExist": true,
"distributionsByInvestorId": AccountToManyDistributionFilter,
"distributionsByInvestorIdExist": true,
"transactionsByBrokerId": AccountToManyTransactionFilter,
"transactionsByBrokerIdExist": true,
"ledgersByInvestorId": AccountToManyLedgerFilter,
"ledgersByInvestorIdExist": false,
"distributionAnnotationsByAccountId": AccountToManyDistributionAnnotationFilter,
"distributionAnnotationsByAccountIdExist": true,
"assetAnnotationsByAccountId": AccountToManyAssetAnnotationFilter,
"assetAnnotationsByAccountIdExist": false,
"allocationAnnotationsByAccountId": AccountToManyAllocationAnnotationFilter,
"allocationAnnotationsByAccountIdExist": false,
"transactionAnnotationsByAccountId": AccountToManyTransactionAnnotationFilter,
"transactionAnnotationsByAccountIdExist": true,
"managedAccountsByManagerId": AccountToManyManagedAccountFilter,
"managedAccountsByManagerIdExist": true,
"managedAccountsByEntityId": AccountToManyManagedAccountFilter,
"managedAccountsByEntityIdExist": false,
"accountIntegrationsByAccountId": AccountToManyAccountIntegrationFilter,
"accountIntegrationsByAccountIdExist": false,
"vendorQualificationsByAccountId": AccountToManyVendorQualificationFilter,
"vendorQualificationsByAccountIdExist": true,
"stepsByOwnedBy": AccountToManyStepFilter,
"stepsByOwnedByExist": true,
"stepsByExecuteBy": AccountToManyStepFilter,
"stepsByExecuteByExist": false,
"distributionCustomFieldsByCreatedBy": AccountToManyDistributionCustomFieldFilter,
"distributionCustomFieldsByCreatedByExist": false,
"signingAccountsByAccountId": AccountToManySigningAccountFilter,
"signingAccountsByAccountIdExist": false,
"signingTemplatesByAccountId": AccountToManySigningTemplateFilter,
"signingTemplatesByAccountIdExist": true,
"mappedSigningTemplatesByAccountId": AccountToManyMappedSigningTemplateFilter,
"mappedSigningTemplatesByAccountIdExist": true,
"sentSigningDocumentsBySentTo": AccountToManySentSigningDocumentFilter,
"sentSigningDocumentsBySentToExist": true,
"allocationOfferingLinksByCreatedBy": AccountToManyAllocationOfferingLinkFilter,
"allocationOfferingLinksByCreatedByExist": true,
"allocationOfferingLinksByAgentId": AccountToManyAllocationOfferingLinkFilter,
"allocationOfferingLinksByAgentIdExist": false,
"accountPhoneNumbersByAccountId": AccountToManyAccountPhoneNumberFilter,
"accountPhoneNumbersByAccountIdExist": true,
"accountRegDStatusByAccountId": AccountRegDStatusFilter,
"accountRegDStatusByAccountIdExists": true,
"accountTaxInformationsByAccountId": AccountToManyAccountTaxInformationFilter,
"accountTaxInformationsByAccountIdExist": false,
"onboardingQuestionSetsByAccountId": AccountToManyOnboardingQuestionSetFilter,
"onboardingQuestionSetsByAccountIdExist": false,
"onboardingQuestionsByAccountId": AccountToManyOnboardingQuestionFilter,
"onboardingQuestionsByAccountIdExist": true,
"instancedAccountInformationsByAccountId": AccountToManyInstancedAccountInformationFilter,
"instancedAccountInformationsByAccountIdExist": true,
"instancedAccountInformationsByVendorAccountId": AccountToManyInstancedAccountInformationFilter,
"instancedAccountInformationsByVendorAccountIdExist": false,
"instancedMappingFieldsByAccountId": AccountToManyInstancedMappingFieldFilter,
"instancedMappingFieldsByAccountIdExist": true,
"vendorDefaultEmailPreferenceByAccountId": VendorDefaultEmailPreferenceFilter,
"vendorDefaultEmailPreferenceByAccountIdExists": true,
"allocationEmailPreferencesByAccountId": AccountToManyAllocationEmailPreferenceFilter,
"allocationEmailPreferencesByAccountIdExist": true,
"securitiesByIssuerId": AccountToManySecurityFilter,
"securitiesByIssuerIdExist": false,
"securitiesByTaId": AccountToManySecurityFilter,
"securitiesByTaIdExist": true,
"holdingsByInvestorId": AccountToManyHoldingFilter,
"holdingsByInvestorIdExist": false,
"issuanceEventsByInvestorId": AccountToManyIssuanceEventFilter,
"issuanceEventsByInvestorIdExist": false,
"issuanceEventsByIssuerId": AccountToManyIssuanceEventFilter,
"issuanceEventsByIssuerIdExist": true,
"vendorAgentsByAgentId": AccountToManyVendorAgentFilter,
"vendorAgentsByAgentIdExist": true,
"vendorAgentsByVendorId": AccountToManyVendorAgentFilter,
"vendorAgentsByVendorIdExist": false,
"securityListingsByIssuerId": AccountToManySecurityListingFilter,
"securityListingsByIssuerIdExist": true,
"securityListingsByAtsId": AccountToManySecurityListingFilter,
"securityListingsByAtsIdExist": false,
"documentsByUploadedBy": AccountToManyDocumentFilter,
"documentsByUploadedByExist": true,
"accountDocumentsByFromAccountId": AccountToManyAccountDocumentFilter,
"accountDocumentsByFromAccountIdExist": true,
"accountDocumentsByToAccountId": AccountToManyAccountDocumentFilter,
"accountDocumentsByToAccountIdExist": true,
"documentSharingsByUploaderId": AccountToManyDocumentSharingFilter,
"documentSharingsByUploaderIdExist": true,
"accountRestrictionsByAccountId": AccountToManyAccountRestrictionFilter,
"accountRestrictionsByAccountIdExist": false,
"accountRestrictionsByCreatorAccountId": AccountToManyAccountRestrictionFilter,
"accountRestrictionsByCreatorAccountIdExist": true,
"paymentAccountsByAccountId": AccountToManyPaymentAccountFilter,
"paymentAccountsByAccountIdExist": true,
"paymentMethodsByAccountId": AccountToManyPaymentMethodFilter,
"paymentMethodsByAccountIdExist": true,
"paymentIssuersByIssuerId": AccountToManyPaymentIssuerFilter,
"paymentIssuersByIssuerIdExist": false,
"paymentIssuersByAccountId": AccountToManyPaymentIssuerFilter,
"paymentIssuersByAccountIdExist": true,
"omnibusHoldingsByAccountId": AccountToManyOmnibusHoldingFilter,
"omnibusHoldingsByAccountIdExist": false,
"omnibusInvestorsByInvestorId": AccountToManyOmnibusInvestorFilter,
"omnibusInvestorsByInvestorIdExist": true,
"omnibusInvestorsByAccountId": AccountToManyOmnibusInvestorFilter,
"omnibusInvestorsByAccountIdExist": false,
"webhookConfigurationsByAccountId": AccountToManyWebhookConfigurationFilter,
"webhookConfigurationsByAccountIdExist": false,
"customerPartiesByCreatorAccountId": AccountToManyCustomerPartyFilter,
"customerPartiesByCreatorAccountIdExist": false,
"customerAddressesByCreatorAccountId": AccountToManyCustomerAddressFilter,
"customerAddressesByCreatorAccountIdExist": true,
"customerPartyAddressesByCreatorAccountId": AccountToManyCustomerPartyAddressFilter,
"customerPartyAddressesByCreatorAccountIdExist": true,
"blockchainAddressSourcesByVendorId": AccountToManyBlockchainAddressSourceFilter,
"blockchainAddressSourcesByVendorIdExist": true,
"blockchainAddressSourcesByInvestorId": AccountToManyBlockchainAddressSourceFilter,
"blockchainAddressSourcesByInvestorIdExist": true,
"blockchainAddressSourcesByCreatorAccountId": AccountToManyBlockchainAddressSourceFilter,
"blockchainAddressSourcesByCreatorAccountIdExist": false,
"taRequestsByVendorId": AccountToManyTaRequestFilter,
"taRequestsByVendorIdExist": true,
"taRequestsByInvestorId": AccountToManyTaRequestFilter,
"taRequestsByInvestorIdExist": true,
"taRequestsByCreatorAccountId": AccountToManyTaRequestFilter,
"taRequestsByCreatorAccountIdExist": false,
"accountAddressesByAccountId": AccountToManyAccountAddressFilter,
"accountAddressesByAccountIdExist": true,
"atsTagsByAccountId": AccountToManyAtsTagFilter,
"atsTagsByAccountIdExist": false,
"idempotentsByAtsId": AccountToManyIdempotentFilter,
"idempotentsByAtsIdExist": true,
"partiesByAccountId": AccountToManyPartyFilter,
"partiesByAccountIdExist": true,
"partyAddressesByAccountId": AccountToManyPartyAddressFilter,
"partyAddressesByAccountIdExist": true,
"requestsByAccountId": AccountToManyRequestFilter,
"requestsByAccountIdExist": false,
"stagedBalanceTransfersByToAccountId": AccountToManyStagedBalanceTransferFilter,
"stagedBalanceTransfersByToAccountIdExist": true,
"stagedBalanceTransfersByFromAccountId": AccountToManyStagedBalanceTransferFilter,
"stagedBalanceTransfersByFromAccountIdExist": false,
"stagedTransfersByAccountId": AccountToManyStagedTransferFilter,
"stagedTransfersByAccountIdExist": true,
"tradesByAtsId": AccountToManyTradeFilter,
"tradesByAtsIdExist": true,
"tradesByFromAccountId": AccountToManyTradeFilter,
"tradesByFromAccountIdExist": true,
"tradesByToAccountId": AccountToManyTradeFilter,
"tradesByToAccountIdExist": true,
"transfersByAtsId": AccountToManyTransferFilter,
"transfersByAtsIdExist": true,
"transfersByFromAccountId": AccountToManyTransferFilter,
"transfersByFromAccountIdExist": false,
"transfersByToAccountId": AccountToManyTransferFilter,
"transfersByToAccountIdExist": false,
"auxAccountByType": AuxAccountFilter,
"companyByCompany": CompanyFilter,
"companyByCompanyExists": false,
"countryByJurisdiction": CountryFilter,
"investorAccountTypeByInvestorType": InvestorAccountTypeFilter,
"investorAccountTypeByInvestorTypeExists": false,
"and": [AccountFilter],
"or": [AccountFilter],
"not": AccountFilter
}
AccountIdInput
Description
All input for the accountId mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
Example
{"clientMutationId": "xyz789"}
AccountIdPayload
Description
The output of our accountId mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
The exact same clientMutationId that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations. |
uuid - UUID
|
|
query - Query
|
Our root query field type. Allows us to run any query from our mutation payload. |
Example
{
"clientMutationId": "xyz789",
"uuid": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"query": Query
}
AccountIntegration
Fields
| Field Name | Description |
|---|---|
nodeId - ID!
|
A globally unique identifier. Can be used in various places throughout the system to identify this single value. |
id - UUID!
|
|
integrationId - UUID!
|
|
accountId - UUID!
|
|
stepId - UUID
|
|
integrationByIntegrationId - Integration
|
Reads a single Integration that is related to this AccountIntegration. |
accountByAccountId - Account
|
Reads a single Account that is related to this AccountIntegration. |
stepByStepId - Step
|
Reads a single Step that is related to this AccountIntegration. |
Example
{
"nodeId": 4,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"integrationId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"stepId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"integrationByIntegrationId": Integration,
"accountByAccountId": Account,
"stepByStepId": Step
}
AccountIntegrationCondition
Description
A condition to be used against AccountIntegration object types. All fields are tested for equality and combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
id - UUID
|
Checks for equality with the object’s id field. |
integrationId - UUID
|
Checks for equality with the object’s integrationId field. |
accountId - UUID
|
Checks for equality with the object’s accountId field. |
stepId - UUID
|
Checks for equality with the object’s stepId field. |
Example
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"integrationId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"stepId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
AccountIntegrationFilter
Description
A filter to be used against AccountIntegration object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
id - UUIDFilter
|
Filter by the object’s id field. |
integrationId - UUIDFilter
|
Filter by the object’s integrationId field. |
accountId - UUIDFilter
|
Filter by the object’s accountId field. |
stepId - UUIDFilter
|
Filter by the object’s stepId field. |
integrationByIntegrationId - IntegrationFilter
|
Filter by the object’s integrationByIntegrationId relation. |
accountByAccountId - AccountFilter
|
Filter by the object’s accountByAccountId relation. |
stepByStepId - StepFilter
|
Filter by the object’s stepByStepId relation. |
stepByStepIdExists - Boolean
|
A related stepByStepId exists. |
and - [AccountIntegrationFilter!]
|
Checks for all expressions in this list. |
or - [AccountIntegrationFilter!]
|
Checks for any expressions in this list. |
not - AccountIntegrationFilter
|
Negates the expression. |
Example
{
"id": UUIDFilter,
"integrationId": UUIDFilter,
"accountId": UUIDFilter,
"stepId": UUIDFilter,
"integrationByIntegrationId": IntegrationFilter,
"accountByAccountId": AccountFilter,
"stepByStepId": StepFilter,
"stepByStepIdExists": false,
"and": [AccountIntegrationFilter],
"or": [AccountIntegrationFilter],
"not": AccountIntegrationFilter
}
AccountIntegrationInput
Description
An input for mutations affecting AccountIntegration
Example
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"integrationId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"stepId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
AccountIntegrationsConnection
Description
A connection to a list of AccountIntegration values.
Fields
| Field Name | Description |
|---|---|
nodes - [AccountIntegration]!
|
A list of AccountIntegration objects. |
edges - [AccountIntegrationsEdge!]!
|
A list of edges which contains the AccountIntegration and cursor to aid in pagination. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The count of all AccountIntegration you could get from the connection. |
Example
{
"nodes": [AccountIntegration],
"edges": [AccountIntegrationsEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
AccountIntegrationsEdge
Description
A AccountIntegration edge in the connection.
Fields
| Field Name | Description |
|---|---|
cursor - Cursor
|
A cursor for use in pagination. |
node - AccountIntegration
|
The AccountIntegration at the end of the edge. |
Example
{
"cursor": Cursor,
"node": AccountIntegration
}
AccountIntegrationsOrderBy
Description
Methods to use when ordering AccountIntegration.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NATURAL"
AccountPatch
Description
Represents an update to a Account. Fields that are set will be updated.
Fields
| Input Field | Description |
|---|---|
type - String
|
|
company - UUID
|
|
name - String
|
|
jurisdiction - UUID
|
|
email - String
|
|
url - String
|
|
slug - String
|
|
twitterHandle - String
|
|
supportEmail - String
|
|
newId - UUID
|
|
setup - Boolean
|
|
entity - Boolean
|
|
oldId - Int
|
|
id - UUID
|
|
createdOn - Datetime
|
|
investorType - String
|
|
formationDate - Date
|
|
externalEmail - String
|
|
useReal - Boolean
|
Example
{
"type": "abc123",
"company": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"name": "abc123",
"jurisdiction": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"email": "xyz789",
"url": "xyz789",
"slug": "xyz789",
"twitterHandle": "xyz789",
"supportEmail": "abc123",
"newId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"setup": true,
"entity": false,
"oldId": 123,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"createdOn": Datetime,
"investorType": "abc123",
"formationDate": "2007-12-03",
"externalEmail": "xyz789",
"useReal": true
}
AccountPhoneNumber
Fields
| Field Name | Description |
|---|---|
nodeId - ID!
|
A globally unique identifier. Can be used in various places throughout the system to identify this single value. |
id - UUID!
|
|
accountId - UUID!
|
|
phoneNumber - String!
|
|
type - String!
|
|
accountByAccountId - Account
|
Reads a single Account that is related to this AccountPhoneNumber. |
phoneNumberTypeByType - PhoneNumberType
|
Reads a single PhoneNumberType that is related to this AccountPhoneNumber. |
Example
{
"nodeId": "4",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"phoneNumber": "abc123",
"type": "xyz789",
"accountByAccountId": Account,
"phoneNumberTypeByType": PhoneNumberType
}
AccountPhoneNumberCondition
Description
A condition to be used against AccountPhoneNumber object types. All fields are tested for equality and combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
id - UUID
|
Checks for equality with the object’s id field. |
accountId - UUID
|
Checks for equality with the object’s accountId field. |
phoneNumber - String
|
Checks for equality with the object’s phoneNumber field. |
type - String
|
Checks for equality with the object’s type field. |
Example
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"phoneNumber": "abc123",
"type": "xyz789"
}
AccountPhoneNumberFilter
Description
A filter to be used against AccountPhoneNumber object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
id - UUIDFilter
|
Filter by the object’s id field. |
accountId - UUIDFilter
|
Filter by the object’s accountId field. |
phoneNumber - StringFilter
|
Filter by the object’s phoneNumber field. |
type - StringFilter
|
Filter by the object’s type field. |
accountByAccountId - AccountFilter
|
Filter by the object’s accountByAccountId relation. |
phoneNumberTypeByType - PhoneNumberTypeFilter
|
Filter by the object’s phoneNumberTypeByType relation. |
and - [AccountPhoneNumberFilter!]
|
Checks for all expressions in this list. |
or - [AccountPhoneNumberFilter!]
|
Checks for any expressions in this list. |
not - AccountPhoneNumberFilter
|
Negates the expression. |
Example
{
"id": UUIDFilter,
"accountId": UUIDFilter,
"phoneNumber": StringFilter,
"type": StringFilter,
"accountByAccountId": AccountFilter,
"phoneNumberTypeByType": PhoneNumberTypeFilter,
"and": [AccountPhoneNumberFilter],
"or": [AccountPhoneNumberFilter],
"not": AccountPhoneNumberFilter
}
AccountPhoneNumberInput
Description
An input for mutations affecting AccountPhoneNumber
Example
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"phoneNumber": "abc123",
"type": "abc123"
}
AccountPhoneNumberPatch
Description
Represents an update to a AccountPhoneNumber. Fields that are set will be updated.
Example
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"phoneNumber": "xyz789",
"type": "abc123"
}
AccountPhoneNumbersConnection
Description
A connection to a list of AccountPhoneNumber values.
Fields
| Field Name | Description |
|---|---|
nodes - [AccountPhoneNumber]!
|
A list of AccountPhoneNumber objects. |
edges - [AccountPhoneNumbersEdge!]!
|
A list of edges which contains the AccountPhoneNumber and cursor to aid in pagination. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The count of all AccountPhoneNumber you could get from the connection. |
Example
{
"nodes": [AccountPhoneNumber],
"edges": [AccountPhoneNumbersEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
AccountPhoneNumbersEdge
Description
A AccountPhoneNumber edge in the connection.
Fields
| Field Name | Description |
|---|---|
cursor - Cursor
|
A cursor for use in pagination. |
node - AccountPhoneNumber
|
The AccountPhoneNumber at the end of the edge. |
Example
{
"cursor": Cursor,
"node": AccountPhoneNumber
}
AccountPhoneNumbersOrderBy
Description
Methods to use when ordering AccountPhoneNumber.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NATURAL"
AccountRegDStatus
Fields
| Field Name | Description |
|---|---|
nodeId - ID!
|
A globally unique identifier. Can be used in various places throughout the system to identify this single value. |
id - UUID!
|
|
accountId - UUID!
|
|
usCitizen - Boolean!
|
|
usFileTax - Boolean!
|
|
usResidence - Boolean!
|
|
canRegD - Boolean
|
|
accountByAccountId - Account
|
Reads a single Account that is related to this AccountRegDStatus. |
Example
{
"nodeId": "4",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"usCitizen": false,
"usFileTax": false,
"usResidence": true,
"canRegD": true,
"accountByAccountId": Account
}
AccountRegDStatusCondition
Description
A condition to be used against AccountRegDStatus object types. All fields are tested for equality and combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
id - UUID
|
Checks for equality with the object’s id field. |
accountId - UUID
|
Checks for equality with the object’s accountId field. |
usCitizen - Boolean
|
Checks for equality with the object’s usCitizen field. |
usFileTax - Boolean
|
Checks for equality with the object’s usFileTax field. |
usResidence - Boolean
|
Checks for equality with the object’s usResidence field. |
canRegD - Boolean
|
Checks for equality with the object’s canRegD field. |
Example
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"usCitizen": true,
"usFileTax": false,
"usResidence": false,
"canRegD": true
}
AccountRegDStatusFilter
Description
A filter to be used against AccountRegDStatus object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
id - UUIDFilter
|
Filter by the object’s id field. |
accountId - UUIDFilter
|
Filter by the object’s accountId field. |
usCitizen - BooleanFilter
|
Filter by the object’s usCitizen field. |
usFileTax - BooleanFilter
|
Filter by the object’s usFileTax field. |
usResidence - BooleanFilter
|
Filter by the object’s usResidence field. |
canRegD - BooleanFilter
|
Filter by the object’s canRegD field. |
accountByAccountId - AccountFilter
|
Filter by the object’s accountByAccountId relation. |
and - [AccountRegDStatusFilter!]
|
Checks for all expressions in this list. |
or - [AccountRegDStatusFilter!]
|
Checks for any expressions in this list. |
not - AccountRegDStatusFilter
|
Negates the expression. |
Example
{
"id": UUIDFilter,
"accountId": UUIDFilter,
"usCitizen": BooleanFilter,
"usFileTax": BooleanFilter,
"usResidence": BooleanFilter,
"canRegD": BooleanFilter,
"accountByAccountId": AccountFilter,
"and": [AccountRegDStatusFilter],
"or": [AccountRegDStatusFilter],
"not": AccountRegDStatusFilter
}
AccountRegDStatusInput
Description
An input for mutations affecting AccountRegDStatus
Example
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"usCitizen": false,
"usFileTax": true,
"usResidence": false,
"canRegD": true
}
AccountRegDStatusPatch
Description
Represents an update to a AccountRegDStatus. Fields that are set will be updated.
Example
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"usCitizen": false,
"usFileTax": false,
"usResidence": false,
"canRegD": true
}
AccountRegDStatusesConnection
Description
A connection to a list of AccountRegDStatus values.
Fields
| Field Name | Description |
|---|---|
nodes - [AccountRegDStatus]!
|
A list of AccountRegDStatus objects. |
edges - [AccountRegDStatusesEdge!]!
|
A list of edges which contains the AccountRegDStatus and cursor to aid in pagination. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The count of all AccountRegDStatus you could get from the connection. |
Example
{
"nodes": [AccountRegDStatus],
"edges": [AccountRegDStatusesEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
AccountRegDStatusesEdge
Description
A AccountRegDStatus edge in the connection.
Fields
| Field Name | Description |
|---|---|
cursor - Cursor
|
A cursor for use in pagination. |
node - AccountRegDStatus
|
The AccountRegDStatus at the end of the edge. |
Example
{
"cursor": Cursor,
"node": AccountRegDStatus
}
AccountRegDStatusesOrderBy
Description
Methods to use when ordering AccountRegDStatus.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NATURAL"
AccountRestriction
Fields
| Field Name | Description |
|---|---|
nodeId - ID!
|
A globally unique identifier. Can be used in various places throughout the system to identify this single value. |
id - UUID!
|
|
accountId - UUID!
|
|
reasonId - Int!
|
|
creatorUserId - UUID!
|
|
creatorAccountId - UUID!
|
|
createdOn - Datetime!
|
|
accountByAccountId - Account
|
Reads a single Account that is related to this AccountRestriction. |
restrictionReasonByReasonId - RestrictionReason
|
Reads a single RestrictionReason that is related to this AccountRestriction. |
userByCreatorUserId - User
|
Reads a single User that is related to this AccountRestriction. |
accountByCreatorAccountId - Account
|
Reads a single Account that is related to this AccountRestriction. |
Example
{
"nodeId": "4",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"reasonId": 123,
"creatorUserId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"creatorAccountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"createdOn": Datetime,
"accountByAccountId": Account,
"restrictionReasonByReasonId": RestrictionReason,
"userByCreatorUserId": User,
"accountByCreatorAccountId": Account
}
AccountRestrictionCondition
Description
A condition to be used against AccountRestriction object types. All fields are tested for equality and combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
id - UUID
|
Checks for equality with the object’s id field. |
accountId - UUID
|
Checks for equality with the object’s accountId field. |
reasonId - Int
|
Checks for equality with the object’s reasonId field. |
creatorUserId - UUID
|
Checks for equality with the object’s creatorUserId field. |
creatorAccountId - UUID
|
Checks for equality with the object’s creatorAccountId field. |
createdOn - Datetime
|
Checks for equality with the object’s createdOn field. |
Example
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"reasonId": 987,
"creatorUserId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"creatorAccountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"createdOn": Datetime
}
AccountRestrictionFilter
Description
A filter to be used against AccountRestriction object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
id - UUIDFilter
|
Filter by the object’s id field. |
accountId - UUIDFilter
|
Filter by the object’s accountId field. |
reasonId - IntFilter
|
Filter by the object’s reasonId field. |
creatorUserId - UUIDFilter
|
Filter by the object’s creatorUserId field. |
creatorAccountId - UUIDFilter
|
Filter by the object’s creatorAccountId field. |
createdOn - DatetimeFilter
|
Filter by the object’s createdOn field. |
accountByAccountId - AccountFilter
|
Filter by the object’s accountByAccountId relation. |
restrictionReasonByReasonId - RestrictionReasonFilter
|
Filter by the object’s restrictionReasonByReasonId relation. |
userByCreatorUserId - UserFilter
|
Filter by the object’s userByCreatorUserId relation. |
accountByCreatorAccountId - AccountFilter
|
Filter by the object’s accountByCreatorAccountId relation. |
and - [AccountRestrictionFilter!]
|
Checks for all expressions in this list. |
or - [AccountRestrictionFilter!]
|
Checks for any expressions in this list. |
not - AccountRestrictionFilter
|
Negates the expression. |
Example
{
"id": UUIDFilter,
"accountId": UUIDFilter,
"reasonId": IntFilter,
"creatorUserId": UUIDFilter,
"creatorAccountId": UUIDFilter,
"createdOn": DatetimeFilter,
"accountByAccountId": AccountFilter,
"restrictionReasonByReasonId": RestrictionReasonFilter,
"userByCreatorUserId": UserFilter,
"accountByCreatorAccountId": AccountFilter,
"and": [AccountRestrictionFilter],
"or": [AccountRestrictionFilter],
"not": AccountRestrictionFilter
}
AccountRestrictionInput
Description
An input for mutations affecting AccountRestriction
Example
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"reasonId": 987,
"creatorUserId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"creatorAccountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"createdOn": Datetime
}
AccountRestrictionPatch
Description
Represents an update to a AccountRestriction. Fields that are set will be updated.
Example
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"reasonId": 987,
"creatorUserId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"creatorAccountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"createdOn": Datetime
}
AccountRestrictionsConnection
Description
A connection to a list of AccountRestriction values.
Fields
| Field Name | Description |
|---|---|
nodes - [AccountRestriction]!
|
A list of AccountRestriction objects. |
edges - [AccountRestrictionsEdge!]!
|
A list of edges which contains the AccountRestriction and cursor to aid in pagination. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The count of all AccountRestriction you could get from the connection. |
Example
{
"nodes": [AccountRestriction],
"edges": [AccountRestrictionsEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
AccountRestrictionsEdge
Description
A AccountRestriction edge in the connection.
Fields
| Field Name | Description |
|---|---|
cursor - Cursor
|
A cursor for use in pagination. |
node - AccountRestriction
|
The AccountRestriction at the end of the edge. |
Example
{
"cursor": Cursor,
"node": AccountRestriction
}
AccountRestrictionsOrderBy
Description
Methods to use when ordering AccountRestriction.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NATURAL"
AccountTaxInformation
Fields
| Field Name | Description |
|---|---|
nodeId - ID!
|
A globally unique identifier. Can be used in various places throughout the system to identify this single value. |
id - UUID!
|
|
accountId - UUID!
|
|
taxRegionId - UUID!
|
|
lastFour - String
|
|
accountByAccountId - Account
|
Reads a single Account that is related to this AccountTaxInformation. |
taxRegionByTaxRegionId - TaxRegion
|
Reads a single TaxRegion that is related to this AccountTaxInformation. |
Example
{
"nodeId": 4,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"taxRegionId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"lastFour": "xyz789",
"accountByAccountId": Account,
"taxRegionByTaxRegionId": TaxRegion
}
AccountTaxInformationCondition
Description
A condition to be used against AccountTaxInformation object types. All fields are tested for equality and combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
id - UUID
|
Checks for equality with the object’s id field. |
accountId - UUID
|
Checks for equality with the object’s accountId field. |
taxRegionId - UUID
|
Checks for equality with the object’s taxRegionId field. |
lastFour - String
|
Checks for equality with the object’s lastFour field. |
Example
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"taxRegionId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"lastFour": "xyz789"
}
AccountTaxInformationFilter
Description
A filter to be used against AccountTaxInformation object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
id - UUIDFilter
|
Filter by the object’s id field. |
accountId - UUIDFilter
|
Filter by the object’s accountId field. |
taxRegionId - UUIDFilter
|
Filter by the object’s taxRegionId field. |
lastFour - StringFilter
|
Filter by the object’s lastFour field. |
accountByAccountId - AccountFilter
|
Filter by the object’s accountByAccountId relation. |
taxRegionByTaxRegionId - TaxRegionFilter
|
Filter by the object’s taxRegionByTaxRegionId relation. |
and - [AccountTaxInformationFilter!]
|
Checks for all expressions in this list. |
or - [AccountTaxInformationFilter!]
|
Checks for any expressions in this list. |
not - AccountTaxInformationFilter
|
Negates the expression. |
Example
{
"id": UUIDFilter,
"accountId": UUIDFilter,
"taxRegionId": UUIDFilter,
"lastFour": StringFilter,
"accountByAccountId": AccountFilter,
"taxRegionByTaxRegionId": TaxRegionFilter,
"and": [AccountTaxInformationFilter],
"or": [AccountTaxInformationFilter],
"not": AccountTaxInformationFilter
}
AccountTaxInformationsConnection
Description
A connection to a list of AccountTaxInformation values.
Fields
| Field Name | Description |
|---|---|
nodes - [AccountTaxInformation]!
|
A list of AccountTaxInformation objects. |
edges - [AccountTaxInformationsEdge!]!
|
A list of edges which contains the AccountTaxInformation and cursor to aid in pagination. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The count of all AccountTaxInformation you could get from the connection. |
Example
{
"nodes": [AccountTaxInformation],
"edges": [AccountTaxInformationsEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
AccountTaxInformationsEdge
Description
A AccountTaxInformation edge in the connection.
Fields
| Field Name | Description |
|---|---|
cursor - Cursor
|
A cursor for use in pagination. |
node - AccountTaxInformation
|
The AccountTaxInformation at the end of the edge. |
Example
{
"cursor": Cursor,
"node": AccountTaxInformation
}
AccountTaxInformationsOrderBy
Description
Methods to use when ordering AccountTaxInformation.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NATURAL"
AccountToManyAccountAddressFilter
Description
A filter to be used against many AccountAddress object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - AccountAddressFilter
|
Every related AccountAddress matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - AccountAddressFilter
|
Some related AccountAddress matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - AccountAddressFilter
|
No related AccountAddress matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": AccountAddressFilter,
"some": AccountAddressFilter,
"none": AccountAddressFilter
}
AccountToManyAccountDocumentFilter
Description
A filter to be used against many AccountDocument object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - AccountDocumentFilter
|
Every related AccountDocument matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - AccountDocumentFilter
|
Some related AccountDocument matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - AccountDocumentFilter
|
No related AccountDocument matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": AccountDocumentFilter,
"some": AccountDocumentFilter,
"none": AccountDocumentFilter
}
AccountToManyAccountIntegrationFilter
Description
A filter to be used against many AccountIntegration object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - AccountIntegrationFilter
|
Every related AccountIntegration matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - AccountIntegrationFilter
|
Some related AccountIntegration matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - AccountIntegrationFilter
|
No related AccountIntegration matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": AccountIntegrationFilter,
"some": AccountIntegrationFilter,
"none": AccountIntegrationFilter
}
AccountToManyAccountPhoneNumberFilter
Description
A filter to be used against many AccountPhoneNumber object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - AccountPhoneNumberFilter
|
Every related AccountPhoneNumber matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - AccountPhoneNumberFilter
|
Some related AccountPhoneNumber matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - AccountPhoneNumberFilter
|
No related AccountPhoneNumber matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": AccountPhoneNumberFilter,
"some": AccountPhoneNumberFilter,
"none": AccountPhoneNumberFilter
}
AccountToManyAccountRestrictionFilter
Description
A filter to be used against many AccountRestriction object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - AccountRestrictionFilter
|
Every related AccountRestriction matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - AccountRestrictionFilter
|
Some related AccountRestriction matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - AccountRestrictionFilter
|
No related AccountRestriction matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": AccountRestrictionFilter,
"some": AccountRestrictionFilter,
"none": AccountRestrictionFilter
}
AccountToManyAccountTaxInformationFilter
Description
A filter to be used against many AccountTaxInformation object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - AccountTaxInformationFilter
|
Every related AccountTaxInformation matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - AccountTaxInformationFilter
|
Some related AccountTaxInformation matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - AccountTaxInformationFilter
|
No related AccountTaxInformation matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": AccountTaxInformationFilter,
"some": AccountTaxInformationFilter,
"none": AccountTaxInformationFilter
}
AccountToManyAccountsBlockchainAddressFilter
Description
A filter to be used against many AccountsBlockchainAddress object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - AccountsBlockchainAddressFilter
|
Every related AccountsBlockchainAddress matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - AccountsBlockchainAddressFilter
|
Some related AccountsBlockchainAddress matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - AccountsBlockchainAddressFilter
|
No related AccountsBlockchainAddress matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": AccountsBlockchainAddressFilter,
"some": AccountsBlockchainAddressFilter,
"none": AccountsBlockchainAddressFilter
}
AccountToManyAllocationAnnotationFilter
Description
A filter to be used against many AllocationAnnotation object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - AllocationAnnotationFilter
|
Every related AllocationAnnotation matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - AllocationAnnotationFilter
|
Some related AllocationAnnotation matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - AllocationAnnotationFilter
|
No related AllocationAnnotation matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": AllocationAnnotationFilter,
"some": AllocationAnnotationFilter,
"none": AllocationAnnotationFilter
}
AccountToManyAllocationArchiveFilter
Description
A filter to be used against many AllocationArchive object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - AllocationArchiveFilter
|
Every related AllocationArchive matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - AllocationArchiveFilter
|
Some related AllocationArchive matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - AllocationArchiveFilter
|
No related AllocationArchive matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": AllocationArchiveFilter,
"some": AllocationArchiveFilter,
"none": AllocationArchiveFilter
}
AccountToManyAllocationEmailPreferenceFilter
Description
A filter to be used against many AllocationEmailPreference object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - AllocationEmailPreferenceFilter
|
Every related AllocationEmailPreference matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - AllocationEmailPreferenceFilter
|
Some related AllocationEmailPreference matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - AllocationEmailPreferenceFilter
|
No related AllocationEmailPreference matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": AllocationEmailPreferenceFilter,
"some": AllocationEmailPreferenceFilter,
"none": AllocationEmailPreferenceFilter
}
AccountToManyAllocationFilter
Description
A filter to be used against many Allocation object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - AllocationFilter
|
Every related Allocation matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - AllocationFilter
|
Some related Allocation matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - AllocationFilter
|
No related Allocation matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": AllocationFilter,
"some": AllocationFilter,
"none": AllocationFilter
}
AccountToManyAllocationOfferingLinkFilter
Description
A filter to be used against many AllocationOfferingLink object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - AllocationOfferingLinkFilter
|
Every related AllocationOfferingLink matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - AllocationOfferingLinkFilter
|
Some related AllocationOfferingLink matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - AllocationOfferingLinkFilter
|
No related AllocationOfferingLink matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": AllocationOfferingLinkFilter,
"some": AllocationOfferingLinkFilter,
"none": AllocationOfferingLinkFilter
}
AccountToManyAssetAnnotationFilter
Description
A filter to be used against many AssetAnnotation object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - AssetAnnotationFilter
|
Every related AssetAnnotation matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - AssetAnnotationFilter
|
Some related AssetAnnotation matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - AssetAnnotationFilter
|
No related AssetAnnotation matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": AssetAnnotationFilter,
"some": AssetAnnotationFilter,
"none": AssetAnnotationFilter
}
AccountToManyAssetArchiveFilter
Description
A filter to be used against many AssetArchive object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - AssetArchiveFilter
|
Every related AssetArchive matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - AssetArchiveFilter
|
Some related AssetArchive matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - AssetArchiveFilter
|
No related AssetArchive matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": AssetArchiveFilter,
"some": AssetArchiveFilter,
"none": AssetArchiveFilter
}
AccountToManyAssetFilter
Description
A filter to be used against many Asset object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - AssetFilter
|
Every related Asset matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - AssetFilter
|
Some related Asset matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - AssetFilter
|
No related Asset matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": AssetFilter,
"some": AssetFilter,
"none": AssetFilter
}
AccountToManyAtsTagFilter
Description
A filter to be used against many AtsTag object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - AtsTagFilter
|
Every related AtsTag matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - AtsTagFilter
|
Some related AtsTag matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - AtsTagFilter
|
No related AtsTag matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": AtsTagFilter,
"some": AtsTagFilter,
"none": AtsTagFilter
}
AccountToManyBlockchainAddressSourceFilter
Description
A filter to be used against many BlockchainAddressSource object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - BlockchainAddressSourceFilter
|
Every related BlockchainAddressSource matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - BlockchainAddressSourceFilter
|
Some related BlockchainAddressSource matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - BlockchainAddressSourceFilter
|
No related BlockchainAddressSource matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": BlockchainAddressSourceFilter,
"some": BlockchainAddressSourceFilter,
"none": BlockchainAddressSourceFilter
}
AccountToManyBlockchainRegistrationFilter
Description
A filter to be used against many BlockchainRegistration object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - BlockchainRegistrationFilter
|
Every related BlockchainRegistration matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - BlockchainRegistrationFilter
|
Some related BlockchainRegistration matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - BlockchainRegistrationFilter
|
No related BlockchainRegistration matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": BlockchainRegistrationFilter,
"some": BlockchainRegistrationFilter,
"none": BlockchainRegistrationFilter
}
AccountToManyBrokerAllocationFilter
Description
A filter to be used against many BrokerAllocation object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - BrokerAllocationFilter
|
Every related BrokerAllocation matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - BrokerAllocationFilter
|
Some related BrokerAllocation matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - BrokerAllocationFilter
|
No related BrokerAllocation matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": BrokerAllocationFilter,
"some": BrokerAllocationFilter,
"none": BrokerAllocationFilter
}
AccountToManyCustomerAddressFilter
Description
A filter to be used against many CustomerAddress object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - CustomerAddressFilter
|
Every related CustomerAddress matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - CustomerAddressFilter
|
Some related CustomerAddress matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - CustomerAddressFilter
|
No related CustomerAddress matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": CustomerAddressFilter,
"some": CustomerAddressFilter,
"none": CustomerAddressFilter
}
AccountToManyCustomerFilter
Description
A filter to be used against many Customer object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - CustomerFilter
|
Every related Customer matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - CustomerFilter
|
Some related Customer matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - CustomerFilter
|
No related Customer matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": CustomerFilter,
"some": CustomerFilter,
"none": CustomerFilter
}
AccountToManyCustomerPartyAddressFilter
Description
A filter to be used against many CustomerPartyAddress object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - CustomerPartyAddressFilter
|
Every related CustomerPartyAddress matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - CustomerPartyAddressFilter
|
Some related CustomerPartyAddress matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - CustomerPartyAddressFilter
|
No related CustomerPartyAddress matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": CustomerPartyAddressFilter,
"some": CustomerPartyAddressFilter,
"none": CustomerPartyAddressFilter
}
AccountToManyCustomerPartyFilter
Description
A filter to be used against many CustomerParty object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - CustomerPartyFilter
|
Every related CustomerParty matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - CustomerPartyFilter
|
Some related CustomerParty matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - CustomerPartyFilter
|
No related CustomerParty matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": CustomerPartyFilter,
"some": CustomerPartyFilter,
"none": CustomerPartyFilter
}
AccountToManyDistributionAnnotationFilter
Description
A filter to be used against many DistributionAnnotation object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - DistributionAnnotationFilter
|
Every related DistributionAnnotation matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - DistributionAnnotationFilter
|
Some related DistributionAnnotation matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - DistributionAnnotationFilter
|
No related DistributionAnnotation matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": DistributionAnnotationFilter,
"some": DistributionAnnotationFilter,
"none": DistributionAnnotationFilter
}
AccountToManyDistributionCustomFieldFilter
Description
A filter to be used against many DistributionCustomField object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - DistributionCustomFieldFilter
|
Every related DistributionCustomField matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - DistributionCustomFieldFilter
|
Some related DistributionCustomField matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - DistributionCustomFieldFilter
|
No related DistributionCustomField matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": DistributionCustomFieldFilter,
"some": DistributionCustomFieldFilter,
"none": DistributionCustomFieldFilter
}
AccountToManyDistributionFilter
Description
A filter to be used against many Distribution object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - DistributionFilter
|
Every related Distribution matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - DistributionFilter
|
Some related Distribution matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - DistributionFilter
|
No related Distribution matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": DistributionFilter,
"some": DistributionFilter,
"none": DistributionFilter
}
AccountToManyDocumentFilter
Description
A filter to be used against many Document object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - DocumentFilter
|
Every related Document matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - DocumentFilter
|
Some related Document matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - DocumentFilter
|
No related Document matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": DocumentFilter,
"some": DocumentFilter,
"none": DocumentFilter
}
AccountToManyDocumentSharingFilter
Description
A filter to be used against many DocumentSharing object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - DocumentSharingFilter
|
Every related DocumentSharing matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - DocumentSharingFilter
|
Some related DocumentSharing matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - DocumentSharingFilter
|
No related DocumentSharing matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": DocumentSharingFilter,
"some": DocumentSharingFilter,
"none": DocumentSharingFilter
}
AccountToManyHoldingFilter
Description
A filter to be used against many Holding object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - HoldingFilter
|
Every related Holding matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - HoldingFilter
|
Some related Holding matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - HoldingFilter
|
No related Holding matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": HoldingFilter,
"some": HoldingFilter,
"none": HoldingFilter
}
AccountToManyIdempotentFilter
Description
A filter to be used against many Idempotent object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - IdempotentFilter
|
Every related Idempotent matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - IdempotentFilter
|
Some related Idempotent matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - IdempotentFilter
|
No related Idempotent matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": IdempotentFilter,
"some": IdempotentFilter,
"none": IdempotentFilter
}
AccountToManyInstancedAccountInformationFilter
Description
A filter to be used against many InstancedAccountInformation object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - InstancedAccountInformationFilter
|
Every related InstancedAccountInformation matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - InstancedAccountInformationFilter
|
Some related InstancedAccountInformation matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - InstancedAccountInformationFilter
|
No related InstancedAccountInformation matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": InstancedAccountInformationFilter,
"some": InstancedAccountInformationFilter,
"none": InstancedAccountInformationFilter
}
AccountToManyInstancedMappingFieldFilter
Description
A filter to be used against many InstancedMappingField object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - InstancedMappingFieldFilter
|
Every related InstancedMappingField matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - InstancedMappingFieldFilter
|
Some related InstancedMappingField matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - InstancedMappingFieldFilter
|
No related InstancedMappingField matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": InstancedMappingFieldFilter,
"some": InstancedMappingFieldFilter,
"none": InstancedMappingFieldFilter
}
AccountToManyIssuanceEventFilter
Description
A filter to be used against many IssuanceEvent object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - IssuanceEventFilter
|
Every related IssuanceEvent matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - IssuanceEventFilter
|
Some related IssuanceEvent matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - IssuanceEventFilter
|
No related IssuanceEvent matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": IssuanceEventFilter,
"some": IssuanceEventFilter,
"none": IssuanceEventFilter
}
AccountToManyLedgerFilter
Description
A filter to be used against many Ledger object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - LedgerFilter
|
Every related Ledger matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - LedgerFilter
|
Some related Ledger matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - LedgerFilter
|
No related Ledger matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": LedgerFilter,
"some": LedgerFilter,
"none": LedgerFilter
}
AccountToManyManagedAccountFilter
Description
A filter to be used against many ManagedAccount object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - ManagedAccountFilter
|
Every related ManagedAccount matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - ManagedAccountFilter
|
Some related ManagedAccount matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - ManagedAccountFilter
|
No related ManagedAccount matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": ManagedAccountFilter,
"some": ManagedAccountFilter,
"none": ManagedAccountFilter
}
AccountToManyMappedSigningTemplateFilter
Description
A filter to be used against many MappedSigningTemplate object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - MappedSigningTemplateFilter
|
Every related MappedSigningTemplate matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - MappedSigningTemplateFilter
|
Some related MappedSigningTemplate matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - MappedSigningTemplateFilter
|
No related MappedSigningTemplate matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": MappedSigningTemplateFilter,
"some": MappedSigningTemplateFilter,
"none": MappedSigningTemplateFilter
}
AccountToManyOmnibusHoldingFilter
Description
A filter to be used against many OmnibusHolding object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - OmnibusHoldingFilter
|
Every related OmnibusHolding matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - OmnibusHoldingFilter
|
Some related OmnibusHolding matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - OmnibusHoldingFilter
|
No related OmnibusHolding matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": OmnibusHoldingFilter,
"some": OmnibusHoldingFilter,
"none": OmnibusHoldingFilter
}
AccountToManyOmnibusInvestorFilter
Description
A filter to be used against many OmnibusInvestor object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - OmnibusInvestorFilter
|
Every related OmnibusInvestor matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - OmnibusInvestorFilter
|
Some related OmnibusInvestor matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - OmnibusInvestorFilter
|
No related OmnibusInvestor matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": OmnibusInvestorFilter,
"some": OmnibusInvestorFilter,
"none": OmnibusInvestorFilter
}
AccountToManyOnboardingQuestionFilter
Description
A filter to be used against many OnboardingQuestion object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - OnboardingQuestionFilter
|
Every related OnboardingQuestion matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - OnboardingQuestionFilter
|
Some related OnboardingQuestion matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - OnboardingQuestionFilter
|
No related OnboardingQuestion matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": OnboardingQuestionFilter,
"some": OnboardingQuestionFilter,
"none": OnboardingQuestionFilter
}
AccountToManyOnboardingQuestionSetFilter
Description
A filter to be used against many OnboardingQuestionSet object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - OnboardingQuestionSetFilter
|
Every related OnboardingQuestionSet matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - OnboardingQuestionSetFilter
|
Some related OnboardingQuestionSet matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - OnboardingQuestionSetFilter
|
No related OnboardingQuestionSet matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": OnboardingQuestionSetFilter,
"some": OnboardingQuestionSetFilter,
"none": OnboardingQuestionSetFilter
}
AccountToManyPartyAddressFilter
Description
A filter to be used against many PartyAddress object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - PartyAddressFilter
|
Every related PartyAddress matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - PartyAddressFilter
|
Some related PartyAddress matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - PartyAddressFilter
|
No related PartyAddress matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": PartyAddressFilter,
"some": PartyAddressFilter,
"none": PartyAddressFilter
}
AccountToManyPartyFilter
Description
A filter to be used against many Party object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - PartyFilter
|
Every related Party matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - PartyFilter
|
Some related Party matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - PartyFilter
|
No related Party matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": PartyFilter,
"some": PartyFilter,
"none": PartyFilter
}
AccountToManyPaymentAccountFilter
Description
A filter to be used against many PaymentAccount object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - PaymentAccountFilter
|
Every related PaymentAccount matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - PaymentAccountFilter
|
Some related PaymentAccount matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - PaymentAccountFilter
|
No related PaymentAccount matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": PaymentAccountFilter,
"some": PaymentAccountFilter,
"none": PaymentAccountFilter
}
AccountToManyPaymentIssuerFilter
Description
A filter to be used against many PaymentIssuer object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - PaymentIssuerFilter
|
Every related PaymentIssuer matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - PaymentIssuerFilter
|
Some related PaymentIssuer matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - PaymentIssuerFilter
|
No related PaymentIssuer matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": PaymentIssuerFilter,
"some": PaymentIssuerFilter,
"none": PaymentIssuerFilter
}
AccountToManyPaymentMethodFilter
Description
A filter to be used against many PaymentMethod object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - PaymentMethodFilter
|
Every related PaymentMethod matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - PaymentMethodFilter
|
Some related PaymentMethod matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - PaymentMethodFilter
|
No related PaymentMethod matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": PaymentMethodFilter,
"some": PaymentMethodFilter,
"none": PaymentMethodFilter
}
AccountToManyRequestFilter
Description
A filter to be used against many Request object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - RequestFilter
|
Every related Request matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - RequestFilter
|
Some related Request matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - RequestFilter
|
No related Request matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": RequestFilter,
"some": RequestFilter,
"none": RequestFilter
}
AccountToManySecurityFilter
Description
A filter to be used against many Security object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - SecurityFilter
|
Every related Security matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - SecurityFilter
|
Some related Security matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - SecurityFilter
|
No related Security matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": SecurityFilter,
"some": SecurityFilter,
"none": SecurityFilter
}
AccountToManySecurityListingFilter
Description
A filter to be used against many SecurityListing object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - SecurityListingFilter
|
Every related SecurityListing matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - SecurityListingFilter
|
Some related SecurityListing matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - SecurityListingFilter
|
No related SecurityListing matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": SecurityListingFilter,
"some": SecurityListingFilter,
"none": SecurityListingFilter
}
AccountToManySentSigningDocumentFilter
Description
A filter to be used against many SentSigningDocument object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - SentSigningDocumentFilter
|
Every related SentSigningDocument matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - SentSigningDocumentFilter
|
Some related SentSigningDocument matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - SentSigningDocumentFilter
|
No related SentSigningDocument matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": SentSigningDocumentFilter,
"some": SentSigningDocumentFilter,
"none": SentSigningDocumentFilter
}
AccountToManySigningAccountFilter
Description
A filter to be used against many SigningAccount object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - SigningAccountFilter
|
Every related SigningAccount matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - SigningAccountFilter
|
Some related SigningAccount matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - SigningAccountFilter
|
No related SigningAccount matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": SigningAccountFilter,
"some": SigningAccountFilter,
"none": SigningAccountFilter
}
AccountToManySigningTemplateFilter
Description
A filter to be used against many SigningTemplate object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - SigningTemplateFilter
|
Every related SigningTemplate matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - SigningTemplateFilter
|
Some related SigningTemplate matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - SigningTemplateFilter
|
No related SigningTemplate matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": SigningTemplateFilter,
"some": SigningTemplateFilter,
"none": SigningTemplateFilter
}
AccountToManyStagedBalanceTransferFilter
Description
A filter to be used against many StagedBalanceTransfer object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - StagedBalanceTransferFilter
|
Every related StagedBalanceTransfer matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - StagedBalanceTransferFilter
|
Some related StagedBalanceTransfer matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - StagedBalanceTransferFilter
|
No related StagedBalanceTransfer matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": StagedBalanceTransferFilter,
"some": StagedBalanceTransferFilter,
"none": StagedBalanceTransferFilter
}
AccountToManyStagedTransferFilter
Description
A filter to be used against many StagedTransfer object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - StagedTransferFilter
|
Every related StagedTransfer matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - StagedTransferFilter
|
Some related StagedTransfer matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - StagedTransferFilter
|
No related StagedTransfer matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": StagedTransferFilter,
"some": StagedTransferFilter,
"none": StagedTransferFilter
}
AccountToManyStepFilter
Description
A filter to be used against many Step object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - StepFilter
|
Every related Step matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - StepFilter
|
Some related Step matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - StepFilter
|
No related Step matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": StepFilter,
"some": StepFilter,
"none": StepFilter
}
AccountToManyTaRequestFilter
Description
A filter to be used against many TaRequest object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - TaRequestFilter
|
Every related TaRequest matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - TaRequestFilter
|
Some related TaRequest matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - TaRequestFilter
|
No related TaRequest matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": TaRequestFilter,
"some": TaRequestFilter,
"none": TaRequestFilter
}
AccountToManyTradeFilter
Description
A filter to be used against many Trade object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - TradeFilter
|
Every related Trade matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - TradeFilter
|
Some related Trade matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - TradeFilter
|
No related Trade matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": TradeFilter,
"some": TradeFilter,
"none": TradeFilter
}
AccountToManyTransactionAnnotationFilter
Description
A filter to be used against many TransactionAnnotation object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - TransactionAnnotationFilter
|
Every related TransactionAnnotation matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - TransactionAnnotationFilter
|
Some related TransactionAnnotation matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - TransactionAnnotationFilter
|
No related TransactionAnnotation matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": TransactionAnnotationFilter,
"some": TransactionAnnotationFilter,
"none": TransactionAnnotationFilter
}
AccountToManyTransactionFilter
Description
A filter to be used against many Transaction object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - TransactionFilter
|
Every related Transaction matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - TransactionFilter
|
Some related Transaction matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - TransactionFilter
|
No related Transaction matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": TransactionFilter,
"some": TransactionFilter,
"none": TransactionFilter
}
AccountToManyTransferFilter
Description
A filter to be used against many Transfer object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - TransferFilter
|
Every related Transfer matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - TransferFilter
|
Some related Transfer matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - TransferFilter
|
No related Transfer matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": TransferFilter,
"some": TransferFilter,
"none": TransferFilter
}
AccountToManyUsersAccountFilter
Description
A filter to be used against many UsersAccount object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - UsersAccountFilter
|
Every related UsersAccount matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - UsersAccountFilter
|
Some related UsersAccount matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - UsersAccountFilter
|
No related UsersAccount matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": UsersAccountFilter,
"some": UsersAccountFilter,
"none": UsersAccountFilter
}
AccountToManyVendorAgentFilter
Description
A filter to be used against many VendorAgent object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - VendorAgentFilter
|
Every related VendorAgent matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - VendorAgentFilter
|
Some related VendorAgent matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - VendorAgentFilter
|
No related VendorAgent matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": VendorAgentFilter,
"some": VendorAgentFilter,
"none": VendorAgentFilter
}
AccountToManyVendorQualificationFilter
Description
A filter to be used against many VendorQualification object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - VendorQualificationFilter
|
Every related VendorQualification matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - VendorQualificationFilter
|
Some related VendorQualification matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - VendorQualificationFilter
|
No related VendorQualification matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": VendorQualificationFilter,
"some": VendorQualificationFilter,
"none": VendorQualificationFilter
}
AccountToManyWebhookConfigurationFilter
Description
A filter to be used against many WebhookConfiguration object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - WebhookConfigurationFilter
|
Every related WebhookConfiguration matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - WebhookConfigurationFilter
|
Some related WebhookConfiguration matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - WebhookConfigurationFilter
|
No related WebhookConfiguration matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": WebhookConfigurationFilter,
"some": WebhookConfigurationFilter,
"none": WebhookConfigurationFilter
}
AccountingType
Fields
| Field Name | Description |
|---|---|
nodeId - ID!
|
A globally unique identifier. Can be used in various places throughout the system to identify this single value. |
type - String!
|
|
assetTypesByAccountingType - AssetTypesConnection!
|
Reads and enables pagination through a set of AssetType. |
Arguments
|
|
ledgersByType - LedgersConnection!
|
Reads and enables pagination through a set of Ledger. |
Arguments
|
|
Example
{
"nodeId": "4",
"type": "abc123",
"assetTypesByAccountingType": AssetTypesConnection,
"ledgersByType": LedgersConnection
}
AccountingTypeCondition
Description
A condition to be used against AccountingType object types. All fields are tested for equality and combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
type - String
|
Checks for equality with the object’s type field. |
Example
{"type": "xyz789"}
AccountingTypeFilter
Description
A filter to be used against AccountingType object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
type - StringFilter
|
Filter by the object’s type field. |
assetTypesByAccountingType - AccountingTypeToManyAssetTypeFilter
|
Filter by the object’s assetTypesByAccountingType relation. |
assetTypesByAccountingTypeExist - Boolean
|
Some related assetTypesByAccountingType exist. |
ledgersByType - AccountingTypeToManyLedgerFilter
|
Filter by the object’s ledgersByType relation. |
ledgersByTypeExist - Boolean
|
Some related ledgersByType exist. |
and - [AccountingTypeFilter!]
|
Checks for all expressions in this list. |
or - [AccountingTypeFilter!]
|
Checks for any expressions in this list. |
not - AccountingTypeFilter
|
Negates the expression. |
Example
{
"type": StringFilter,
"assetTypesByAccountingType": AccountingTypeToManyAssetTypeFilter,
"assetTypesByAccountingTypeExist": false,
"ledgersByType": AccountingTypeToManyLedgerFilter,
"ledgersByTypeExist": true,
"and": [AccountingTypeFilter],
"or": [AccountingTypeFilter],
"not": AccountingTypeFilter
}
AccountingTypeToManyAssetTypeFilter
Description
A filter to be used against many AssetType object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - AssetTypeFilter
|
Every related AssetType matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - AssetTypeFilter
|
Some related AssetType matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - AssetTypeFilter
|
No related AssetType matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": AssetTypeFilter,
"some": AssetTypeFilter,
"none": AssetTypeFilter
}
AccountingTypeToManyLedgerFilter
Description
A filter to be used against many Ledger object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - LedgerFilter
|
Every related Ledger matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - LedgerFilter
|
Some related Ledger matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - LedgerFilter
|
No related Ledger matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": LedgerFilter,
"some": LedgerFilter,
"none": LedgerFilter
}
AccountingTypesConnection
Description
A connection to a list of AccountingType values.
Fields
| Field Name | Description |
|---|---|
nodes - [AccountingType]!
|
A list of AccountingType objects. |
edges - [AccountingTypesEdge!]!
|
A list of edges which contains the AccountingType and cursor to aid in pagination. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The count of all AccountingType you could get from the connection. |
Example
{
"nodes": [AccountingType],
"edges": [AccountingTypesEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
AccountingTypesEdge
Description
A AccountingType edge in the connection.
Fields
| Field Name | Description |
|---|---|
cursor - Cursor
|
A cursor for use in pagination. |
node - AccountingType
|
The AccountingType at the end of the edge. |
Example
{
"cursor": Cursor,
"node": AccountingType
}
AccountingTypesOrderBy
Description
Methods to use when ordering AccountingType.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NATURAL"
AccountsBlockchainAddress
Fields
| Field Name | Description |
|---|---|
nodeId - ID!
|
A globally unique identifier. Can be used in various places throughout the system to identify this single value. |
accountId - UUID!
|
|
blockchainAddressId - UUID!
|
|
blockchainAddressGroupId - UUID
|
|
name - String!
|
|
id - UUID!
|
|
accountByAccountId - Account
|
Reads a single Account that is related to this AccountsBlockchainAddress. |
blockchainAddressByBlockchainAddressId - BlockchainAddress
|
Reads a single BlockchainAddress that is related to this AccountsBlockchainAddress. |
blockchainAddressGroupByBlockchainAddressGroupId - BlockchainAddressGroup
|
Reads a single BlockchainAddressGroup that is related to this AccountsBlockchainAddress. |
Example
{
"nodeId": 4,
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"blockchainAddressId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"blockchainAddressGroupId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"name": "xyz789",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountByAccountId": Account,
"blockchainAddressByBlockchainAddressId": BlockchainAddress,
"blockchainAddressGroupByBlockchainAddressGroupId": BlockchainAddressGroup
}
AccountsBlockchainAddressCondition
Description
A condition to be used against AccountsBlockchainAddress object types. All fields are tested for equality and combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
accountId - UUID
|
Checks for equality with the object’s accountId field. |
blockchainAddressId - UUID
|
Checks for equality with the object’s blockchainAddressId field. |
blockchainAddressGroupId - UUID
|
Checks for equality with the object’s blockchainAddressGroupId field. |
name - String
|
Checks for equality with the object’s name field. |
id - UUID
|
Checks for equality with the object’s id field. |
Example
{
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"blockchainAddressId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"blockchainAddressGroupId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"name": "xyz789",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
AccountsBlockchainAddressFilter
Description
A filter to be used against AccountsBlockchainAddress object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
accountId - UUIDFilter
|
Filter by the object’s accountId field. |
blockchainAddressId - UUIDFilter
|
Filter by the object’s blockchainAddressId field. |
blockchainAddressGroupId - UUIDFilter
|
Filter by the object’s blockchainAddressGroupId field. |
name - StringFilter
|
Filter by the object’s name field. |
id - UUIDFilter
|
Filter by the object’s id field. |
accountByAccountId - AccountFilter
|
Filter by the object’s accountByAccountId relation. |
blockchainAddressByBlockchainAddressId - BlockchainAddressFilter
|
Filter by the object’s blockchainAddressByBlockchainAddressId relation. |
blockchainAddressGroupByBlockchainAddressGroupId - BlockchainAddressGroupFilter
|
Filter by the object’s blockchainAddressGroupByBlockchainAddressGroupId relation. |
blockchainAddressGroupByBlockchainAddressGroupIdExists - Boolean
|
A related blockchainAddressGroupByBlockchainAddressGroupId exists. |
and - [AccountsBlockchainAddressFilter!]
|
Checks for all expressions in this list. |
or - [AccountsBlockchainAddressFilter!]
|
Checks for any expressions in this list. |
not - AccountsBlockchainAddressFilter
|
Negates the expression. |
Example
{
"accountId": UUIDFilter,
"blockchainAddressId": UUIDFilter,
"blockchainAddressGroupId": UUIDFilter,
"name": StringFilter,
"id": UUIDFilter,
"accountByAccountId": AccountFilter,
"blockchainAddressByBlockchainAddressId": BlockchainAddressFilter,
"blockchainAddressGroupByBlockchainAddressGroupId": BlockchainAddressGroupFilter,
"blockchainAddressGroupByBlockchainAddressGroupIdExists": true,
"and": [AccountsBlockchainAddressFilter],
"or": [AccountsBlockchainAddressFilter],
"not": AccountsBlockchainAddressFilter
}
AccountsBlockchainAddressesConnection
Description
A connection to a list of AccountsBlockchainAddress values.
Fields
| Field Name | Description |
|---|---|
nodes - [AccountsBlockchainAddress]!
|
A list of AccountsBlockchainAddress objects. |
edges - [AccountsBlockchainAddressesEdge!]!
|
A list of edges which contains the AccountsBlockchainAddress and cursor to aid in pagination. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The count of all AccountsBlockchainAddress you could get from the connection. |
Example
{
"nodes": [AccountsBlockchainAddress],
"edges": [AccountsBlockchainAddressesEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
AccountsBlockchainAddressesEdge
Description
A AccountsBlockchainAddress edge in the connection.
Fields
| Field Name | Description |
|---|---|
cursor - Cursor
|
A cursor for use in pagination. |
node - AccountsBlockchainAddress
|
The AccountsBlockchainAddress at the end of the edge. |
Example
{
"cursor": Cursor,
"node": AccountsBlockchainAddress
}
AccountsBlockchainAddressesOrderBy
Description
Methods to use when ordering AccountsBlockchainAddress.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NATURAL"
AccountsConnection
Description
A connection to a list of Account values.
Fields
| Field Name | Description |
|---|---|
nodes - [Account]!
|
A list of Account objects. |
edges - [AccountsEdge!]!
|
A list of edges which contains the Account and cursor to aid in pagination. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The count of all Account you could get from the connection. |
Example
{
"nodes": [Account],
"edges": [AccountsEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
AccountsEdge
AccountsOrderBy
Description
Methods to use when ordering Account.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NATURAL"
ActiveUser
Example
{
"userId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"firstName": "abc123",
"lastName": "abc123",
"usersAccountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"userRole": "abc123",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountName": "xyz789",
"accountType": "abc123",
"email": "xyz789",
"slug": "xyz789"
}
ActiveUserCondition
Description
A condition to be used against ActiveUser object types. All fields are tested for equality and combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
userId - UUID
|
Checks for equality with the object’s userId field. |
firstName - String
|
Checks for equality with the object’s firstName field. |
lastName - String
|
Checks for equality with the object’s lastName field. |
usersAccountId - UUID
|
Checks for equality with the object’s usersAccountId field. |
userRole - String
|
Checks for equality with the object’s userRole field. |
accountId - UUID
|
Checks for equality with the object’s accountId field. |
accountName - String
|
Checks for equality with the object’s accountName field. |
accountType - String
|
Checks for equality with the object’s accountType field. |
email - String
|
Checks for equality with the object’s email field. |
slug - String
|
Checks for equality with the object’s slug field. |
Example
{
"userId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"firstName": "abc123",
"lastName": "abc123",
"usersAccountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"userRole": "xyz789",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountName": "xyz789",
"accountType": "abc123",
"email": "abc123",
"slug": "abc123"
}
ActiveUserFilter
Description
A filter to be used against ActiveUser object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
userId - UUIDFilter
|
Filter by the object’s userId field. |
firstName - StringFilter
|
Filter by the object’s firstName field. |
lastName - StringFilter
|
Filter by the object’s lastName field. |
usersAccountId - UUIDFilter
|
Filter by the object’s usersAccountId field. |
userRole - StringFilter
|
Filter by the object’s userRole field. |
accountId - UUIDFilter
|
Filter by the object’s accountId field. |
accountName - StringFilter
|
Filter by the object’s accountName field. |
accountType - StringFilter
|
Filter by the object’s accountType field. |
email - StringFilter
|
Filter by the object’s email field. |
slug - StringFilter
|
Filter by the object’s slug field. |
and - [ActiveUserFilter!]
|
Checks for all expressions in this list. |
or - [ActiveUserFilter!]
|
Checks for any expressions in this list. |
not - ActiveUserFilter
|
Negates the expression. |
Example
{
"userId": UUIDFilter,
"firstName": StringFilter,
"lastName": StringFilter,
"usersAccountId": UUIDFilter,
"userRole": StringFilter,
"accountId": UUIDFilter,
"accountName": StringFilter,
"accountType": StringFilter,
"email": StringFilter,
"slug": StringFilter,
"and": [ActiveUserFilter],
"or": [ActiveUserFilter],
"not": ActiveUserFilter
}
ActiveUsersConnection
Description
A connection to a list of ActiveUser values.
Fields
| Field Name | Description |
|---|---|
nodes - [ActiveUser]!
|
A list of ActiveUser objects. |
edges - [ActiveUsersEdge!]!
|
A list of edges which contains the ActiveUser and cursor to aid in pagination. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The count of all ActiveUser you could get from the connection. |
Example
{
"nodes": [ActiveUser],
"edges": [ActiveUsersEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
ActiveUsersEdge
Description
A ActiveUser edge in the connection.
Fields
| Field Name | Description |
|---|---|
cursor - Cursor
|
A cursor for use in pagination. |
node - ActiveUser
|
The ActiveUser at the end of the edge. |
Example
{
"cursor": Cursor,
"node": ActiveUser
}
ActiveUsersOrderBy
Description
Methods to use when ordering ActiveUser.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NATURAL"
Address
Fields
| Field Name | Description |
|---|---|
nodeId - ID!
|
A globally unique identifier. Can be used in various places throughout the system to identify this single value. |
country - UUID!
|
|
lineOne - String!
|
|
lineTwo - String
|
|
lineThree - String
|
|
lineFour - String
|
|
city - String!
|
|
postalCode - String!
|
|
province - String!
|
|
other - String
|
|
id - UUID!
|
|
countryByCountry - Country
|
Reads a single Country that is related to this Address. |
customerAddressByAddressId - CustomerAddress
|
Reads a single CustomerAddress that is related to this Address. |
customerAddressesByAddressId - CustomerAddressesConnection!
|
Reads and enables pagination through a set of CustomerAddress. Please use customerAddressByAddressId instead
|
Arguments
|
|
customerPartyAddressByAddressId - CustomerPartyAddress
|
Reads a single CustomerPartyAddress that is related to this Address. |
customerPartyAddressesByAddressId - CustomerPartyAddressesConnection!
|
Reads and enables pagination through a set of CustomerPartyAddress. Please use customerPartyAddressByAddressId instead
|
Arguments
|
|
accountAddressesByAddressId - AccountAddressesConnection!
|
Reads and enables pagination through a set of AccountAddress. |
Arguments
|
|
partyAddressesByAddressId - PartyAddressesConnection!
|
Reads and enables pagination through a set of PartyAddress. |
Arguments
|
|
Example
{
"nodeId": "4",
"country": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"lineOne": "abc123",
"lineTwo": "xyz789",
"lineThree": "xyz789",
"lineFour": "xyz789",
"city": "xyz789",
"postalCode": "xyz789",
"province": "abc123",
"other": "abc123",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"countryByCountry": Country,
"customerAddressByAddressId": CustomerAddress,
"customerAddressesByAddressId": CustomerAddressesConnection,
"customerPartyAddressByAddressId": CustomerPartyAddress,
"customerPartyAddressesByAddressId": CustomerPartyAddressesConnection,
"accountAddressesByAddressId": AccountAddressesConnection,
"partyAddressesByAddressId": PartyAddressesConnection
}
AddressCondition
Description
A condition to be used against Address object types. All fields are tested for equality and combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
country - UUID
|
Checks for equality with the object’s country field. |
lineOne - String
|
Checks for equality with the object’s lineOne field. |
lineTwo - String
|
Checks for equality with the object’s lineTwo field. |
lineThree - String
|
Checks for equality with the object’s lineThree field. |
lineFour - String
|
Checks for equality with the object’s lineFour field. |
city - String
|
Checks for equality with the object’s city field. |
postalCode - String
|
Checks for equality with the object’s postalCode field. |
province - String
|
Checks for equality with the object’s province field. |
other - String
|
Checks for equality with the object’s other field. |
id - UUID
|
Checks for equality with the object’s id field. |
Example
{
"country": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"lineOne": "xyz789",
"lineTwo": "xyz789",
"lineThree": "xyz789",
"lineFour": "abc123",
"city": "xyz789",
"postalCode": "xyz789",
"province": "xyz789",
"other": "abc123",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
AddressFilter
Description
A filter to be used against Address object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
country - UUIDFilter
|
Filter by the object’s country field. |
lineOne - StringFilter
|
Filter by the object’s lineOne field. |
lineTwo - StringFilter
|
Filter by the object’s lineTwo field. |
lineThree - StringFilter
|
Filter by the object’s lineThree field. |
lineFour - StringFilter
|
Filter by the object’s lineFour field. |
city - StringFilter
|
Filter by the object’s city field. |
postalCode - StringFilter
|
Filter by the object’s postalCode field. |
province - StringFilter
|
Filter by the object’s province field. |
other - StringFilter
|
Filter by the object’s other field. |
id - UUIDFilter
|
Filter by the object’s id field. |
customerAddressByAddressId - CustomerAddressFilter
|
Filter by the object’s customerAddressByAddressId relation. |
customerAddressByAddressIdExists - Boolean
|
A related customerAddressByAddressId exists. |
customerPartyAddressByAddressId - CustomerPartyAddressFilter
|
Filter by the object’s customerPartyAddressByAddressId relation. |
customerPartyAddressByAddressIdExists - Boolean
|
A related customerPartyAddressByAddressId exists. |
accountAddressesByAddressId - AddressToManyAccountAddressFilter
|
Filter by the object’s accountAddressesByAddressId relation. |
accountAddressesByAddressIdExist - Boolean
|
Some related accountAddressesByAddressId exist. |
partyAddressesByAddressId - AddressToManyPartyAddressFilter
|
Filter by the object’s partyAddressesByAddressId relation. |
partyAddressesByAddressIdExist - Boolean
|
Some related partyAddressesByAddressId exist. |
countryByCountry - CountryFilter
|
Filter by the object’s countryByCountry relation. |
and - [AddressFilter!]
|
Checks for all expressions in this list. |
or - [AddressFilter!]
|
Checks for any expressions in this list. |
not - AddressFilter
|
Negates the expression. |
Example
{
"country": UUIDFilter,
"lineOne": StringFilter,
"lineTwo": StringFilter,
"lineThree": StringFilter,
"lineFour": StringFilter,
"city": StringFilter,
"postalCode": StringFilter,
"province": StringFilter,
"other": StringFilter,
"id": UUIDFilter,
"customerAddressByAddressId": CustomerAddressFilter,
"customerAddressByAddressIdExists": false,
"customerPartyAddressByAddressId": CustomerPartyAddressFilter,
"customerPartyAddressByAddressIdExists": true,
"accountAddressesByAddressId": AddressToManyAccountAddressFilter,
"accountAddressesByAddressIdExist": false,
"partyAddressesByAddressId": AddressToManyPartyAddressFilter,
"partyAddressesByAddressIdExist": true,
"countryByCountry": CountryFilter,
"and": [AddressFilter],
"or": [AddressFilter],
"not": AddressFilter
}
AddressPatch
Description
Represents an update to a Address. Fields that are set will be updated.
Example
{
"country": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"lineOne": "abc123",
"lineTwo": "xyz789",
"lineThree": "xyz789",
"lineFour": "abc123",
"city": "abc123",
"postalCode": "abc123",
"province": "xyz789",
"other": "xyz789",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
AddressToManyAccountAddressFilter
Description
A filter to be used against many AccountAddress object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - AccountAddressFilter
|
Every related AccountAddress matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - AccountAddressFilter
|
Some related AccountAddress matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - AccountAddressFilter
|
No related AccountAddress matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": AccountAddressFilter,
"some": AccountAddressFilter,
"none": AccountAddressFilter
}
AddressToManyPartyAddressFilter
Description
A filter to be used against many PartyAddress object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - PartyAddressFilter
|
Every related PartyAddress matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - PartyAddressFilter
|
Some related PartyAddress matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - PartyAddressFilter
|
No related PartyAddress matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": PartyAddressFilter,
"some": PartyAddressFilter,
"none": PartyAddressFilter
}
AddressType
Fields
| Field Name | Description |
|---|---|
nodeId - ID!
|
A globally unique identifier. Can be used in various places throughout the system to identify this single value. |
type - String!
|
|
customerAddressesByType - CustomerAddressesConnection!
|
Reads and enables pagination through a set of CustomerAddress. |
Arguments
|
|
customerPartyAddressesByType - CustomerPartyAddressesConnection!
|
Reads and enables pagination through a set of CustomerPartyAddress. |
Arguments
|
|
accountAddressesByType - AccountAddressesConnection!
|
Reads and enables pagination through a set of AccountAddress. |
Arguments
|
|
partyAddressesByType - PartyAddressesConnection!
|
Reads and enables pagination through a set of PartyAddress. |
Arguments
|
|
Example
{
"nodeId": 4,
"type": "abc123",
"customerAddressesByType": CustomerAddressesConnection,
"customerPartyAddressesByType": CustomerPartyAddressesConnection,
"accountAddressesByType": AccountAddressesConnection,
"partyAddressesByType": PartyAddressesConnection
}
AddressTypeCondition
Description
A condition to be used against AddressType object types. All fields are tested for equality and combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
type - String
|
Checks for equality with the object’s type field. |
Example
{"type": "xyz789"}
AddressTypeFilter
Description
A filter to be used against AddressType object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
type - StringFilter
|
Filter by the object’s type field. |
customerAddressesByType - AddressTypeToManyCustomerAddressFilter
|
Filter by the object’s customerAddressesByType relation. |
customerAddressesByTypeExist - Boolean
|
Some related customerAddressesByType exist. |
customerPartyAddressesByType - AddressTypeToManyCustomerPartyAddressFilter
|
Filter by the object’s customerPartyAddressesByType relation. |
customerPartyAddressesByTypeExist - Boolean
|
Some related customerPartyAddressesByType exist. |
accountAddressesByType - AddressTypeToManyAccountAddressFilter
|
Filter by the object’s accountAddressesByType relation. |
accountAddressesByTypeExist - Boolean
|
Some related accountAddressesByType exist. |
partyAddressesByType - AddressTypeToManyPartyAddressFilter
|
Filter by the object’s partyAddressesByType relation. |
partyAddressesByTypeExist - Boolean
|
Some related partyAddressesByType exist. |
and - [AddressTypeFilter!]
|
Checks for all expressions in this list. |
or - [AddressTypeFilter!]
|
Checks for any expressions in this list. |
not - AddressTypeFilter
|
Negates the expression. |
Example
{
"type": StringFilter,
"customerAddressesByType": AddressTypeToManyCustomerAddressFilter,
"customerAddressesByTypeExist": false,
"customerPartyAddressesByType": AddressTypeToManyCustomerPartyAddressFilter,
"customerPartyAddressesByTypeExist": true,
"accountAddressesByType": AddressTypeToManyAccountAddressFilter,
"accountAddressesByTypeExist": false,
"partyAddressesByType": AddressTypeToManyPartyAddressFilter,
"partyAddressesByTypeExist": true,
"and": [AddressTypeFilter],
"or": [AddressTypeFilter],
"not": AddressTypeFilter
}
AddressTypeToManyAccountAddressFilter
Description
A filter to be used against many AccountAddress object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - AccountAddressFilter
|
Every related AccountAddress matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - AccountAddressFilter
|
Some related AccountAddress matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - AccountAddressFilter
|
No related AccountAddress matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": AccountAddressFilter,
"some": AccountAddressFilter,
"none": AccountAddressFilter
}
AddressTypeToManyCustomerAddressFilter
Description
A filter to be used against many CustomerAddress object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - CustomerAddressFilter
|
Every related CustomerAddress matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - CustomerAddressFilter
|
Some related CustomerAddress matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - CustomerAddressFilter
|
No related CustomerAddress matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": CustomerAddressFilter,
"some": CustomerAddressFilter,
"none": CustomerAddressFilter
}
AddressTypeToManyCustomerPartyAddressFilter
Description
A filter to be used against many CustomerPartyAddress object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - CustomerPartyAddressFilter
|
Every related CustomerPartyAddress matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - CustomerPartyAddressFilter
|
Some related CustomerPartyAddress matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - CustomerPartyAddressFilter
|
No related CustomerPartyAddress matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": CustomerPartyAddressFilter,
"some": CustomerPartyAddressFilter,
"none": CustomerPartyAddressFilter
}
AddressTypeToManyPartyAddressFilter
Description
A filter to be used against many PartyAddress object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - PartyAddressFilter
|
Every related PartyAddress matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - PartyAddressFilter
|
Some related PartyAddress matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - PartyAddressFilter
|
No related PartyAddress matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": PartyAddressFilter,
"some": PartyAddressFilter,
"none": PartyAddressFilter
}
AddressTypesConnection
Description
A connection to a list of AddressType values.
Fields
| Field Name | Description |
|---|---|
nodes - [AddressType]!
|
A list of AddressType objects. |
edges - [AddressTypesEdge!]!
|
A list of edges which contains the AddressType and cursor to aid in pagination. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The count of all AddressType you could get from the connection. |
Example
{
"nodes": [AddressType],
"edges": [AddressTypesEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
AddressTypesEdge
Description
A AddressType edge in the connection.
Fields
| Field Name | Description |
|---|---|
cursor - Cursor
|
A cursor for use in pagination. |
node - AddressType
|
The AddressType at the end of the edge. |
Example
{
"cursor": Cursor,
"node": AddressType
}
AddressTypesOrderBy
Description
Methods to use when ordering AddressType.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NATURAL"
AddressesConnection
Description
A connection to a list of Address values.
Fields
| Field Name | Description |
|---|---|
nodes - [Address]!
|
A list of Address objects. |
edges - [AddressesEdge!]!
|
A list of edges which contains the Address and cursor to aid in pagination. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The count of all Address you could get from the connection. |
Example
{
"nodes": [Address],
"edges": [AddressesEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
AddressesEdge
AddressesOrderBy
Description
Methods to use when ordering Address.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NATURAL"
Allocation
Fields
| Field Name | Description |
|---|---|
nodeId - ID!
|
A globally unique identifier. Can be used in various places throughout the system to identify this single value. |
ownerId - UUID!
|
|
blockchainAddressId - UUID
|
|
issuerId - UUID!
|
|
name - String!
|
|
createdOn - Datetime!
|
|
opensOn - Datetime!
|
|
closesOn - Datetime!
|
|
status - String!
|
|
roundId - UUID!
|
|
id - UUID!
|
|
accountByOwnerId - Account
|
Reads a single Account that is related to this Allocation. |
blockchainAddressByBlockchainAddressId - BlockchainAddress
|
Reads a single BlockchainAddress that is related to this Allocation. |
accountByIssuerId - Account
|
Reads a single Account that is related to this Allocation. |
assetStatusByStatus - AssetStatus
|
Reads a single AssetStatus that is related to this Allocation. |
roundByRoundId - Round
|
Reads a single Round that is related to this Allocation. |
allocationArchivesByAllocationId - AllocationArchivesConnection!
|
Reads and enables pagination through a set of AllocationArchive. |
Arguments
|
|
distributionsByAllocationId - DistributionsConnection!
|
Reads and enables pagination through a set of Distribution. |
Arguments
|
|
allocationAnnotationsByAllocationId - AllocationAnnotationsConnection!
|
Reads and enables pagination through a set of AllocationAnnotation. |
Arguments
|
|
allocationsVestingScheduleByAllocationId - AllocationsVestingSchedule
|
Reads a single AllocationsVestingSchedule that is related to this Allocation. |
allocationsVestingSchedulesByAllocationId - AllocationsVestingSchedulesConnection!
|
Reads and enables pagination through a set of AllocationsVestingSchedule. Please use allocationsVestingScheduleByAllocationId instead
|
Arguments
|
|
allocationQualificationsByAllocationId - AllocationQualificationsConnection!
|
Reads and enables pagination through a set of AllocationQualification. |
Arguments
|
|
allocationOfferingLinksByAllocationId - AllocationOfferingLinksConnection!
|
Reads and enables pagination through a set of AllocationOfferingLink. |
Arguments
|
|
allocationEmailPreferenceByAllocationId - AllocationEmailPreference
|
Reads a single AllocationEmailPreference that is related to this Allocation. |
allocationEmailPreferencesByAllocationId - AllocationEmailPreferencesConnection!
|
Reads and enables pagination through a set of AllocationEmailPreference. Please use allocationEmailPreferenceByAllocationId instead
|
Arguments
|
|
managedUnits - BigFloat
|
|
Example
{
"nodeId": "4",
"ownerId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"blockchainAddressId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"issuerId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"name": "xyz789",
"createdOn": Datetime,
"opensOn": Datetime,
"closesOn": Datetime,
"status": "abc123",
"roundId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountByOwnerId": Account,
"blockchainAddressByBlockchainAddressId": BlockchainAddress,
"accountByIssuerId": Account,
"assetStatusByStatus": AssetStatus,
"roundByRoundId": Round,
"allocationArchivesByAllocationId": AllocationArchivesConnection,
"distributionsByAllocationId": DistributionsConnection,
"allocationAnnotationsByAllocationId": AllocationAnnotationsConnection,
"allocationsVestingScheduleByAllocationId": AllocationsVestingSchedule,
"allocationsVestingSchedulesByAllocationId": AllocationsVestingSchedulesConnection,
"allocationQualificationsByAllocationId": AllocationQualificationsConnection,
"allocationOfferingLinksByAllocationId": AllocationOfferingLinksConnection,
"allocationEmailPreferenceByAllocationId": AllocationEmailPreference,
"allocationEmailPreferencesByAllocationId": AllocationEmailPreferencesConnection,
"managedUnits": BigFloat
}
AllocationAnnotation
Fields
| Field Name | Description |
|---|---|
nodeId - ID!
|
A globally unique identifier. Can be used in various places throughout the system to identify this single value. |
allocationId - UUID!
|
|
writtenBy - UUID!
|
|
accountId - UUID!
|
|
annotation - String!
|
|
archive - Boolean!
|
|
createdOn - Datetime!
|
|
id - UUID!
|
|
allocationByAllocationId - Allocation
|
Reads a single Allocation that is related to this AllocationAnnotation. |
userByWrittenBy - User
|
Reads a single User that is related to this AllocationAnnotation. |
accountByAccountId - Account
|
Reads a single Account that is related to this AllocationAnnotation. |
Example
{
"nodeId": 4,
"allocationId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"writtenBy": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"annotation": "xyz789",
"archive": true,
"createdOn": Datetime,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"allocationByAllocationId": Allocation,
"userByWrittenBy": User,
"accountByAccountId": Account
}
AllocationAnnotationCondition
Description
A condition to be used against AllocationAnnotation object types. All fields are tested for equality and combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
allocationId - UUID
|
Checks for equality with the object’s allocationId field. |
writtenBy - UUID
|
Checks for equality with the object’s writtenBy field. |
accountId - UUID
|
Checks for equality with the object’s accountId field. |
annotation - String
|
Checks for equality with the object’s annotation field. |
archive - Boolean
|
Checks for equality with the object’s archive field. |
createdOn - Datetime
|
Checks for equality with the object’s createdOn field. |
id - UUID
|
Checks for equality with the object’s id field. |
Example
{
"allocationId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"writtenBy": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"annotation": "abc123",
"archive": false,
"createdOn": Datetime,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
AllocationAnnotationFilter
Description
A filter to be used against AllocationAnnotation object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
allocationId - UUIDFilter
|
Filter by the object’s allocationId field. |
writtenBy - UUIDFilter
|
Filter by the object’s writtenBy field. |
accountId - UUIDFilter
|
Filter by the object’s accountId field. |
annotation - StringFilter
|
Filter by the object’s annotation field. |
archive - BooleanFilter
|
Filter by the object’s archive field. |
createdOn - DatetimeFilter
|
Filter by the object’s createdOn field. |
id - UUIDFilter
|
Filter by the object’s id field. |
allocationByAllocationId - AllocationFilter
|
Filter by the object’s allocationByAllocationId relation. |
userByWrittenBy - UserFilter
|
Filter by the object’s userByWrittenBy relation. |
accountByAccountId - AccountFilter
|
Filter by the object’s accountByAccountId relation. |
and - [AllocationAnnotationFilter!]
|
Checks for all expressions in this list. |
or - [AllocationAnnotationFilter!]
|
Checks for any expressions in this list. |
not - AllocationAnnotationFilter
|
Negates the expression. |
Example
{
"allocationId": UUIDFilter,
"writtenBy": UUIDFilter,
"accountId": UUIDFilter,
"annotation": StringFilter,
"archive": BooleanFilter,
"createdOn": DatetimeFilter,
"id": UUIDFilter,
"allocationByAllocationId": AllocationFilter,
"userByWrittenBy": UserFilter,
"accountByAccountId": AccountFilter,
"and": [AllocationAnnotationFilter],
"or": [AllocationAnnotationFilter],
"not": AllocationAnnotationFilter
}
AllocationAnnotationInput
Description
An input for mutations affecting AllocationAnnotation
Example
{
"allocationId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"writtenBy": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"annotation": "abc123",
"archive": true,
"createdOn": Datetime,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
AllocationAnnotationPatch
Description
Represents an update to a AllocationAnnotation. Fields that are set will be updated.
Example
{
"allocationId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"writtenBy": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"annotation": "xyz789",
"archive": false,
"createdOn": Datetime,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
AllocationAnnotationsConnection
Description
A connection to a list of AllocationAnnotation values.
Fields
| Field Name | Description |
|---|---|
nodes - [AllocationAnnotation]!
|
A list of AllocationAnnotation objects. |
edges - [AllocationAnnotationsEdge!]!
|
A list of edges which contains the AllocationAnnotation and cursor to aid in pagination. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The count of all AllocationAnnotation you could get from the connection. |
Example
{
"nodes": [AllocationAnnotation],
"edges": [AllocationAnnotationsEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
AllocationAnnotationsEdge
Description
A AllocationAnnotation edge in the connection.
Fields
| Field Name | Description |
|---|---|
cursor - Cursor
|
A cursor for use in pagination. |
node - AllocationAnnotation
|
The AllocationAnnotation at the end of the edge. |
Example
{
"cursor": Cursor,
"node": AllocationAnnotation
}
AllocationAnnotationsOrderBy
Description
Methods to use when ordering AllocationAnnotation.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NATURAL"
AllocationArchive
Fields
| Field Name | Description |
|---|---|
nodeId - ID!
|
A globally unique identifier. Can be used in various places throughout the system to identify this single value. |
allocationId - UUID!
|
|
accountId - UUID!
|
|
archive - Boolean!
|
|
displayOrder - Int!
|
|
id - UUID!
|
|
allocationByAllocationId - Allocation
|
Reads a single Allocation that is related to this AllocationArchive. |
accountByAccountId - Account
|
Reads a single Account that is related to this AllocationArchive. |
Example
{
"nodeId": 4,
"allocationId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"archive": false,
"displayOrder": 123,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"allocationByAllocationId": Allocation,
"accountByAccountId": Account
}
AllocationArchiveCondition
Description
A condition to be used against AllocationArchive object types. All fields are tested for equality and combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
allocationId - UUID
|
Checks for equality with the object’s allocationId field. |
accountId - UUID
|
Checks for equality with the object’s accountId field. |
archive - Boolean
|
Checks for equality with the object’s archive field. |
displayOrder - Int
|
Checks for equality with the object’s displayOrder field. |
id - UUID
|
Checks for equality with the object’s id field. |
Example
{
"allocationId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"archive": false,
"displayOrder": 987,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
AllocationArchiveFilter
Description
A filter to be used against AllocationArchive object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
allocationId - UUIDFilter
|
Filter by the object’s allocationId field. |
accountId - UUIDFilter
|
Filter by the object’s accountId field. |
archive - BooleanFilter
|
Filter by the object’s archive field. |
displayOrder - IntFilter
|
Filter by the object’s displayOrder field. |
id - UUIDFilter
|
Filter by the object’s id field. |
allocationByAllocationId - AllocationFilter
|
Filter by the object’s allocationByAllocationId relation. |
accountByAccountId - AccountFilter
|
Filter by the object’s accountByAccountId relation. |
and - [AllocationArchiveFilter!]
|
Checks for all expressions in this list. |
or - [AllocationArchiveFilter!]
|
Checks for any expressions in this list. |
not - AllocationArchiveFilter
|
Negates the expression. |
Example
{
"allocationId": UUIDFilter,
"accountId": UUIDFilter,
"archive": BooleanFilter,
"displayOrder": IntFilter,
"id": UUIDFilter,
"allocationByAllocationId": AllocationFilter,
"accountByAccountId": AccountFilter,
"and": [AllocationArchiveFilter],
"or": [AllocationArchiveFilter],
"not": AllocationArchiveFilter
}
AllocationArchivesConnection
Description
A connection to a list of AllocationArchive values.
Fields
| Field Name | Description |
|---|---|
nodes - [AllocationArchive]!
|
A list of AllocationArchive objects. |
edges - [AllocationArchivesEdge!]!
|
A list of edges which contains the AllocationArchive and cursor to aid in pagination. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The count of all AllocationArchive you could get from the connection. |
Example
{
"nodes": [AllocationArchive],
"edges": [AllocationArchivesEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
AllocationArchivesEdge
Description
A AllocationArchive edge in the connection.
Fields
| Field Name | Description |
|---|---|
cursor - Cursor
|
A cursor for use in pagination. |
node - AllocationArchive
|
The AllocationArchive at the end of the edge. |
Example
{
"cursor": Cursor,
"node": AllocationArchive
}
AllocationArchivesOrderBy
Description
Methods to use when ordering AllocationArchive.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NATURAL"
AllocationCondition
Description
A condition to be used against Allocation object types. All fields are tested for equality and combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
ownerId - UUID
|
Checks for equality with the object’s ownerId field. |
blockchainAddressId - UUID
|
Checks for equality with the object’s blockchainAddressId field. |
issuerId - UUID
|
Checks for equality with the object’s issuerId field. |
name - String
|
Checks for equality with the object’s name field. |
createdOn - Datetime
|
Checks for equality with the object’s createdOn field. |
opensOn - Datetime
|
Checks for equality with the object’s opensOn field. |
closesOn - Datetime
|
Checks for equality with the object’s closesOn field. |
status - String
|
Checks for equality with the object’s status field. |
roundId - UUID
|
Checks for equality with the object’s roundId field. |
id - UUID
|
Checks for equality with the object’s id field. |
Example
{
"ownerId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"blockchainAddressId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"issuerId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"name": "abc123",
"createdOn": Datetime,
"opensOn": Datetime,
"closesOn": Datetime,
"status": "xyz789",
"roundId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
AllocationEmailPreference
Description
This table is an MVP setting for disabling distribution based emails, will be replaced with full email preferences at some point.
Fields
| Field Name | Description |
|---|---|
nodeId - ID!
|
A globally unique identifier. Can be used in various places throughout the system to identify this single value. |
id - UUID!
|
|
accountId - UUID!
|
|
allocationId - UUID!
|
|
sendDistribution - Boolean!
|
|
accountByAccountId - Account
|
Reads a single Account that is related to this AllocationEmailPreference. |
allocationByAllocationId - Allocation
|
Reads a single Allocation that is related to this AllocationEmailPreference. |
Example
{
"nodeId": "4",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"allocationId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"sendDistribution": true,
"accountByAccountId": Account,
"allocationByAllocationId": Allocation
}
AllocationEmailPreferenceCondition
Description
A condition to be used against AllocationEmailPreference object types. All fields are tested for equality and combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
id - UUID
|
Checks for equality with the object’s id field. |
accountId - UUID
|
Checks for equality with the object’s accountId field. |
allocationId - UUID
|
Checks for equality with the object’s allocationId field. |
sendDistribution - Boolean
|
Checks for equality with the object’s sendDistribution field. |
Example
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"allocationId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"sendDistribution": false
}
AllocationEmailPreferenceFilter
Description
A filter to be used against AllocationEmailPreference object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
id - UUIDFilter
|
Filter by the object’s id field. |
accountId - UUIDFilter
|
Filter by the object’s accountId field. |
allocationId - UUIDFilter
|
Filter by the object’s allocationId field. |
sendDistribution - BooleanFilter
|
Filter by the object’s sendDistribution field. |
accountByAccountId - AccountFilter
|
Filter by the object’s accountByAccountId relation. |
allocationByAllocationId - AllocationFilter
|
Filter by the object’s allocationByAllocationId relation. |
and - [AllocationEmailPreferenceFilter!]
|
Checks for all expressions in this list. |
or - [AllocationEmailPreferenceFilter!]
|
Checks for any expressions in this list. |
not - AllocationEmailPreferenceFilter
|
Negates the expression. |
Example
{
"id": UUIDFilter,
"accountId": UUIDFilter,
"allocationId": UUIDFilter,
"sendDistribution": BooleanFilter,
"accountByAccountId": AccountFilter,
"allocationByAllocationId": AllocationFilter,
"and": [AllocationEmailPreferenceFilter],
"or": [AllocationEmailPreferenceFilter],
"not": AllocationEmailPreferenceFilter
}
AllocationEmailPreferencePatch
Description
Represents an update to a AllocationEmailPreference. Fields that are set will be updated.
Example
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"allocationId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"sendDistribution": false
}
AllocationEmailPreferencesConnection
Description
A connection to a list of AllocationEmailPreference values.
Fields
| Field Name | Description |
|---|---|
nodes - [AllocationEmailPreference]!
|
A list of AllocationEmailPreference objects. |
edges - [AllocationEmailPreferencesEdge!]!
|
A list of edges which contains the AllocationEmailPreference and cursor to aid in pagination. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The count of all AllocationEmailPreference you could get from the connection. |
Example
{
"nodes": [AllocationEmailPreference],
"edges": [AllocationEmailPreferencesEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
AllocationEmailPreferencesEdge
Description
A AllocationEmailPreference edge in the connection.
Fields
| Field Name | Description |
|---|---|
cursor - Cursor
|
A cursor for use in pagination. |
node - AllocationEmailPreference
|
The AllocationEmailPreference at the end of the edge. |
Example
{
"cursor": Cursor,
"node": AllocationEmailPreference
}
AllocationEmailPreferencesOrderBy
Description
Methods to use when ordering AllocationEmailPreference.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NATURAL"
AllocationFilter
Description
A filter to be used against Allocation object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
ownerId - UUIDFilter
|
Filter by the object’s ownerId field. |
blockchainAddressId - UUIDFilter
|
Filter by the object’s blockchainAddressId field. |
issuerId - UUIDFilter
|
Filter by the object’s issuerId field. |
name - StringFilter
|
Filter by the object’s name field. |
createdOn - DatetimeFilter
|
Filter by the object’s createdOn field. |
opensOn - DatetimeFilter
|
Filter by the object’s opensOn field. |
closesOn - DatetimeFilter
|
Filter by the object’s closesOn field. |
status - StringFilter
|
Filter by the object’s status field. |
roundId - UUIDFilter
|
Filter by the object’s roundId field. |
id - UUIDFilter
|
Filter by the object’s id field. |
managedUnits - BigFloatFilter
|
Filter by the object’s managedUnits field. |
allocationArchivesByAllocationId - AllocationToManyAllocationArchiveFilter
|
Filter by the object’s allocationArchivesByAllocationId relation. |
allocationArchivesByAllocationIdExist - Boolean
|
Some related allocationArchivesByAllocationId exist. |
distributionsByAllocationId - AllocationToManyDistributionFilter
|
Filter by the object’s distributionsByAllocationId relation. |
distributionsByAllocationIdExist - Boolean
|
Some related distributionsByAllocationId exist. |
allocationAnnotationsByAllocationId - AllocationToManyAllocationAnnotationFilter
|
Filter by the object’s allocationAnnotationsByAllocationId relation. |
allocationAnnotationsByAllocationIdExist - Boolean
|
Some related allocationAnnotationsByAllocationId exist. |
allocationsVestingScheduleByAllocationId - AllocationsVestingScheduleFilter
|
Filter by the object’s allocationsVestingScheduleByAllocationId relation. |
allocationsVestingScheduleByAllocationIdExists - Boolean
|
A related allocationsVestingScheduleByAllocationId exists. |
allocationQualificationsByAllocationId - AllocationToManyAllocationQualificationFilter
|
Filter by the object’s allocationQualificationsByAllocationId relation. |
allocationQualificationsByAllocationIdExist - Boolean
|
Some related allocationQualificationsByAllocationId exist. |
allocationOfferingLinksByAllocationId - AllocationToManyAllocationOfferingLinkFilter
|
Filter by the object’s allocationOfferingLinksByAllocationId relation. |
allocationOfferingLinksByAllocationIdExist - Boolean
|
Some related allocationOfferingLinksByAllocationId exist. |
allocationEmailPreferenceByAllocationId - AllocationEmailPreferenceFilter
|
Filter by the object’s allocationEmailPreferenceByAllocationId relation. |
allocationEmailPreferenceByAllocationIdExists - Boolean
|
A related allocationEmailPreferenceByAllocationId exists. |
accountByOwnerId - AccountFilter
|
Filter by the object’s accountByOwnerId relation. |
blockchainAddressByBlockchainAddressId - BlockchainAddressFilter
|
Filter by the object’s blockchainAddressByBlockchainAddressId relation. |
blockchainAddressByBlockchainAddressIdExists - Boolean
|
A related blockchainAddressByBlockchainAddressId exists. |
accountByIssuerId - AccountFilter
|
Filter by the object’s accountByIssuerId relation. |
assetStatusByStatus - AssetStatusFilter
|
Filter by the object’s assetStatusByStatus relation. |
roundByRoundId - RoundFilter
|
Filter by the object’s roundByRoundId relation. |
and - [AllocationFilter!]
|
Checks for all expressions in this list. |
or - [AllocationFilter!]
|
Checks for any expressions in this list. |
not - AllocationFilter
|
Negates the expression. |
Example
{
"ownerId": UUIDFilter,
"blockchainAddressId": UUIDFilter,
"issuerId": UUIDFilter,
"name": StringFilter,
"createdOn": DatetimeFilter,
"opensOn": DatetimeFilter,
"closesOn": DatetimeFilter,
"status": StringFilter,
"roundId": UUIDFilter,
"id": UUIDFilter,
"managedUnits": BigFloatFilter,
"allocationArchivesByAllocationId": AllocationToManyAllocationArchiveFilter,
"allocationArchivesByAllocationIdExist": false,
"distributionsByAllocationId": AllocationToManyDistributionFilter,
"distributionsByAllocationIdExist": false,
"allocationAnnotationsByAllocationId": AllocationToManyAllocationAnnotationFilter,
"allocationAnnotationsByAllocationIdExist": true,
"allocationsVestingScheduleByAllocationId": AllocationsVestingScheduleFilter,
"allocationsVestingScheduleByAllocationIdExists": false,
"allocationQualificationsByAllocationId": AllocationToManyAllocationQualificationFilter,
"allocationQualificationsByAllocationIdExist": false,
"allocationOfferingLinksByAllocationId": AllocationToManyAllocationOfferingLinkFilter,
"allocationOfferingLinksByAllocationIdExist": true,
"allocationEmailPreferenceByAllocationId": AllocationEmailPreferenceFilter,
"allocationEmailPreferenceByAllocationIdExists": false,
"accountByOwnerId": AccountFilter,
"blockchainAddressByBlockchainAddressId": BlockchainAddressFilter,
"blockchainAddressByBlockchainAddressIdExists": false,
"accountByIssuerId": AccountFilter,
"assetStatusByStatus": AssetStatusFilter,
"roundByRoundId": RoundFilter,
"and": [AllocationFilter],
"or": [AllocationFilter],
"not": AllocationFilter
}
AllocationInput
Description
An input for mutations affecting Allocation
Example
{
"ownerId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"blockchainAddressId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"issuerId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"name": "xyz789",
"createdOn": Datetime,
"opensOn": Datetime,
"closesOn": Datetime,
"status": "xyz789",
"roundId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
AllocationOfferingLink
Fields
| Field Name | Description |
|---|---|
nodeId - ID!
|
A globally unique identifier. Can be used in various places throughout the system to identify this single value. |
id - UUID!
|
|
allocationId - UUID!
|
|
authorizedLink - String!
|
|
unauthorizedLink - String!
|
|
name - String
|
|
createdBy - UUID!
|
|
createdOn - Datetime
|
|
agentId - UUID
|
|
allocationByAllocationId - Allocation
|
Reads a single Allocation that is related to this AllocationOfferingLink. |
accountByCreatedBy - Account
|
Reads a single Account that is related to this AllocationOfferingLink. |
accountByAgentId - Account
|
Reads a single Account that is related to this AllocationOfferingLink. |
Example
{
"nodeId": 4,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"allocationId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"authorizedLink": "xyz789",
"unauthorizedLink": "abc123",
"name": "xyz789",
"createdBy": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"createdOn": Datetime,
"agentId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"allocationByAllocationId": Allocation,
"accountByCreatedBy": Account,
"accountByAgentId": Account
}
AllocationOfferingLinkCondition
Description
A condition to be used against AllocationOfferingLink object types. All fields are tested for equality and combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
id - UUID
|
Checks for equality with the object’s id field. |
allocationId - UUID
|
Checks for equality with the object’s allocationId field. |
authorizedLink - String
|
Checks for equality with the object’s authorizedLink field. |
unauthorizedLink - String
|
Checks for equality with the object’s unauthorizedLink field. |
name - String
|
Checks for equality with the object’s name field. |
createdBy - UUID
|
Checks for equality with the object’s createdBy field. |
createdOn - Datetime
|
Checks for equality with the object’s createdOn field. |
agentId - UUID
|
Checks for equality with the object’s agentId field. |
Example
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"allocationId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"authorizedLink": "xyz789",
"unauthorizedLink": "abc123",
"name": "abc123",
"createdBy": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"createdOn": Datetime,
"agentId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
AllocationOfferingLinkFilter
Description
A filter to be used against AllocationOfferingLink object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
id - UUIDFilter
|
Filter by the object’s id field. |
allocationId - UUIDFilter
|
Filter by the object’s allocationId field. |
authorizedLink - StringFilter
|
Filter by the object’s authorizedLink field. |
unauthorizedLink - StringFilter
|
Filter by the object’s unauthorizedLink field. |
name - StringFilter
|
Filter by the object’s name field. |
createdBy - UUIDFilter
|
Filter by the object’s createdBy field. |
createdOn - DatetimeFilter
|
Filter by the object’s createdOn field. |
agentId - UUIDFilter
|
Filter by the object’s agentId field. |
allocationByAllocationId - AllocationFilter
|
Filter by the object’s allocationByAllocationId relation. |
accountByCreatedBy - AccountFilter
|
Filter by the object’s accountByCreatedBy relation. |
accountByAgentId - AccountFilter
|
Filter by the object’s accountByAgentId relation. |
accountByAgentIdExists - Boolean
|
A related accountByAgentId exists. |
and - [AllocationOfferingLinkFilter!]
|
Checks for all expressions in this list. |
or - [AllocationOfferingLinkFilter!]
|
Checks for any expressions in this list. |
not - AllocationOfferingLinkFilter
|
Negates the expression. |
Example
{
"id": UUIDFilter,
"allocationId": UUIDFilter,
"authorizedLink": StringFilter,
"unauthorizedLink": StringFilter,
"name": StringFilter,
"createdBy": UUIDFilter,
"createdOn": DatetimeFilter,
"agentId": UUIDFilter,
"allocationByAllocationId": AllocationFilter,
"accountByCreatedBy": AccountFilter,
"accountByAgentId": AccountFilter,
"accountByAgentIdExists": true,
"and": [AllocationOfferingLinkFilter],
"or": [AllocationOfferingLinkFilter],
"not": AllocationOfferingLinkFilter
}
AllocationOfferingLinkPatch
Description
Represents an update to a AllocationOfferingLink. Fields that are set will be updated.
Example
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"allocationId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"authorizedLink": "xyz789",
"unauthorizedLink": "xyz789",
"name": "xyz789",
"createdBy": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"createdOn": Datetime,
"agentId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
AllocationOfferingLinksConnection
Description
A connection to a list of AllocationOfferingLink values.
Fields
| Field Name | Description |
|---|---|
nodes - [AllocationOfferingLink]!
|
A list of AllocationOfferingLink objects. |
edges - [AllocationOfferingLinksEdge!]!
|
A list of edges which contains the AllocationOfferingLink and cursor to aid in pagination. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The count of all AllocationOfferingLink you could get from the connection. |
Example
{
"nodes": [AllocationOfferingLink],
"edges": [AllocationOfferingLinksEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
AllocationOfferingLinksEdge
Description
A AllocationOfferingLink edge in the connection.
Fields
| Field Name | Description |
|---|---|
cursor - Cursor
|
A cursor for use in pagination. |
node - AllocationOfferingLink
|
The AllocationOfferingLink at the end of the edge. |
Example
{
"cursor": Cursor,
"node": AllocationOfferingLink
}
AllocationOfferingLinksOrderBy
Description
Methods to use when ordering AllocationOfferingLink.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NATURAL"
AllocationPatch
Description
Represents an update to a Allocation. Fields that are set will be updated.
Example
{
"ownerId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"blockchainAddressId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"issuerId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"name": "xyz789",
"createdOn": Datetime,
"opensOn": Datetime,
"closesOn": Datetime,
"status": "xyz789",
"roundId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
AllocationQualification
Fields
| Field Name | Description |
|---|---|
nodeId - ID!
|
A globally unique identifier. Can be used in various places throughout the system to identify this single value. |
id - UUID!
|
|
allocationId - UUID!
|
|
vendorQualificationId - UUID!
|
|
executeOrder - Int!
|
|
allocationByAllocationId - Allocation
|
Reads a single Allocation that is related to this AllocationQualification. |
vendorQualificationByVendorQualificationId - VendorQualification
|
Reads a single VendorQualification that is related to this AllocationQualification. |
Example
{
"nodeId": 4,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"allocationId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"vendorQualificationId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"executeOrder": 123,
"allocationByAllocationId": Allocation,
"vendorQualificationByVendorQualificationId": VendorQualification
}
AllocationQualificationCondition
Description
A condition to be used against AllocationQualification object types. All fields are tested for equality and combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
id - UUID
|
Checks for equality with the object’s id field. |
allocationId - UUID
|
Checks for equality with the object’s allocationId field. |
vendorQualificationId - UUID
|
Checks for equality with the object’s vendorQualificationId field. |
executeOrder - Int
|
Checks for equality with the object’s executeOrder field. |
Example
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"allocationId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"vendorQualificationId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"executeOrder": 123
}
AllocationQualificationFilter
Description
A filter to be used against AllocationQualification object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
id - UUIDFilter
|
Filter by the object’s id field. |
allocationId - UUIDFilter
|
Filter by the object’s allocationId field. |
vendorQualificationId - UUIDFilter
|
Filter by the object’s vendorQualificationId field. |
executeOrder - IntFilter
|
Filter by the object’s executeOrder field. |
allocationByAllocationId - AllocationFilter
|
Filter by the object’s allocationByAllocationId relation. |
vendorQualificationByVendorQualificationId - VendorQualificationFilter
|
Filter by the object’s vendorQualificationByVendorQualificationId relation. |
and - [AllocationQualificationFilter!]
|
Checks for all expressions in this list. |
or - [AllocationQualificationFilter!]
|
Checks for any expressions in this list. |
not - AllocationQualificationFilter
|
Negates the expression. |
Example
{
"id": UUIDFilter,
"allocationId": UUIDFilter,
"vendorQualificationId": UUIDFilter,
"executeOrder": IntFilter,
"allocationByAllocationId": AllocationFilter,
"vendorQualificationByVendorQualificationId": VendorQualificationFilter,
"and": [AllocationQualificationFilter],
"or": [AllocationQualificationFilter],
"not": AllocationQualificationFilter
}
AllocationQualificationInput
Description
An input for mutations affecting AllocationQualification
Example
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"allocationId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"vendorQualificationId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"executeOrder": 123
}
AllocationQualificationPatch
Description
Represents an update to a AllocationQualification. Fields that are set will be updated.
Example
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"allocationId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"vendorQualificationId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"executeOrder": 123
}
AllocationQualificationsConnection
Description
A connection to a list of AllocationQualification values.
Fields
| Field Name | Description |
|---|---|
nodes - [AllocationQualification]!
|
A list of AllocationQualification objects. |
edges - [AllocationQualificationsEdge!]!
|
A list of edges which contains the AllocationQualification and cursor to aid in pagination. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The count of all AllocationQualification you could get from the connection. |
Example
{
"nodes": [AllocationQualification],
"edges": [AllocationQualificationsEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
AllocationQualificationsEdge
Description
A AllocationQualification edge in the connection.
Fields
| Field Name | Description |
|---|---|
cursor - Cursor
|
A cursor for use in pagination. |
node - AllocationQualification
|
The AllocationQualification at the end of the edge. |
Example
{
"cursor": Cursor,
"node": AllocationQualification
}
AllocationQualificationsOrderBy
Description
Methods to use when ordering AllocationQualification.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NATURAL"
AllocationToManyAllocationAnnotationFilter
Description
A filter to be used against many AllocationAnnotation object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - AllocationAnnotationFilter
|
Every related AllocationAnnotation matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - AllocationAnnotationFilter
|
Some related AllocationAnnotation matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - AllocationAnnotationFilter
|
No related AllocationAnnotation matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": AllocationAnnotationFilter,
"some": AllocationAnnotationFilter,
"none": AllocationAnnotationFilter
}
AllocationToManyAllocationArchiveFilter
Description
A filter to be used against many AllocationArchive object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - AllocationArchiveFilter
|
Every related AllocationArchive matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - AllocationArchiveFilter
|
Some related AllocationArchive matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - AllocationArchiveFilter
|
No related AllocationArchive matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": AllocationArchiveFilter,
"some": AllocationArchiveFilter,
"none": AllocationArchiveFilter
}
AllocationToManyAllocationOfferingLinkFilter
Description
A filter to be used against many AllocationOfferingLink object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - AllocationOfferingLinkFilter
|
Every related AllocationOfferingLink matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - AllocationOfferingLinkFilter
|
Some related AllocationOfferingLink matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - AllocationOfferingLinkFilter
|
No related AllocationOfferingLink matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": AllocationOfferingLinkFilter,
"some": AllocationOfferingLinkFilter,
"none": AllocationOfferingLinkFilter
}
AllocationToManyAllocationQualificationFilter
Description
A filter to be used against many AllocationQualification object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - AllocationQualificationFilter
|
Every related AllocationQualification matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - AllocationQualificationFilter
|
Some related AllocationQualification matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - AllocationQualificationFilter
|
No related AllocationQualification matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": AllocationQualificationFilter,
"some": AllocationQualificationFilter,
"none": AllocationQualificationFilter
}
AllocationToManyDistributionFilter
Description
A filter to be used against many Distribution object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - DistributionFilter
|
Every related Distribution matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - DistributionFilter
|
Some related Distribution matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - DistributionFilter
|
No related Distribution matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": DistributionFilter,
"some": DistributionFilter,
"none": DistributionFilter
}
AllocationsConnection
Description
A connection to a list of Allocation values.
Fields
| Field Name | Description |
|---|---|
nodes - [Allocation]!
|
A list of Allocation objects. |
edges - [AllocationsEdge!]!
|
A list of edges which contains the Allocation and cursor to aid in pagination. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The count of all Allocation you could get from the connection. |
Example
{
"nodes": [Allocation],
"edges": [AllocationsEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
AllocationsEdge
Description
A Allocation edge in the connection.
Fields
| Field Name | Description |
|---|---|
cursor - Cursor
|
A cursor for use in pagination. |
node - Allocation
|
The Allocation at the end of the edge. |
Example
{
"cursor": Cursor,
"node": Allocation
}
AllocationsOrderBy
Description
Methods to use when ordering Allocation.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NATURAL"
AllocationsVestingSchedule
Fields
| Field Name | Description |
|---|---|
nodeId - ID!
|
A globally unique identifier. Can be used in various places throughout the system to identify this single value. |
allocationId - UUID!
|
|
duration - String!
|
|
cliff - Int!
|
|
periods - Int!
|
|
startsOn - Datetime!
|
|
automatic - Boolean
|
|
id - UUID!
|
|
allocationByAllocationId - Allocation
|
Reads a single Allocation that is related to this AllocationsVestingSchedule. |
vestingDurationByDuration - VestingDuration
|
Reads a single VestingDuration that is related to this AllocationsVestingSchedule. |
Example
{
"nodeId": "4",
"allocationId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"duration": "abc123",
"cliff": 987,
"periods": 987,
"startsOn": Datetime,
"automatic": false,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"allocationByAllocationId": Allocation,
"vestingDurationByDuration": VestingDuration
}
AllocationsVestingScheduleCondition
Description
A condition to be used against AllocationsVestingSchedule object types. All fields are tested for equality and combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
allocationId - UUID
|
Checks for equality with the object’s allocationId field. |
duration - String
|
Checks for equality with the object’s duration field. |
cliff - Int
|
Checks for equality with the object’s cliff field. |
periods - Int
|
Checks for equality with the object’s periods field. |
startsOn - Datetime
|
Checks for equality with the object’s startsOn field. |
automatic - Boolean
|
Checks for equality with the object’s automatic field. |
id - UUID
|
Checks for equality with the object’s id field. |
Example
{
"allocationId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"duration": "abc123",
"cliff": 123,
"periods": 987,
"startsOn": Datetime,
"automatic": false,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
AllocationsVestingScheduleFilter
Description
A filter to be used against AllocationsVestingSchedule object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
allocationId - UUIDFilter
|
Filter by the object’s allocationId field. |
duration - StringFilter
|
Filter by the object’s duration field. |
cliff - IntFilter
|
Filter by the object’s cliff field. |
periods - IntFilter
|
Filter by the object’s periods field. |
startsOn - DatetimeFilter
|
Filter by the object’s startsOn field. |
automatic - BooleanFilter
|
Filter by the object’s automatic field. |
id - UUIDFilter
|
Filter by the object’s id field. |
allocationByAllocationId - AllocationFilter
|
Filter by the object’s allocationByAllocationId relation. |
vestingDurationByDuration - VestingDurationFilter
|
Filter by the object’s vestingDurationByDuration relation. |
and - [AllocationsVestingScheduleFilter!]
|
Checks for all expressions in this list. |
or - [AllocationsVestingScheduleFilter!]
|
Checks for any expressions in this list. |
not - AllocationsVestingScheduleFilter
|
Negates the expression. |
Example
{
"allocationId": UUIDFilter,
"duration": StringFilter,
"cliff": IntFilter,
"periods": IntFilter,
"startsOn": DatetimeFilter,
"automatic": BooleanFilter,
"id": UUIDFilter,
"allocationByAllocationId": AllocationFilter,
"vestingDurationByDuration": VestingDurationFilter,
"and": [AllocationsVestingScheduleFilter],
"or": [AllocationsVestingScheduleFilter],
"not": AllocationsVestingScheduleFilter
}
AllocationsVestingScheduleInput
Description
An input for mutations affecting AllocationsVestingSchedule
Example
{
"allocationId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"duration": "abc123",
"cliff": 123,
"periods": 123,
"startsOn": Datetime,
"automatic": false,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
AllocationsVestingSchedulePatch
Description
Represents an update to a AllocationsVestingSchedule. Fields that are set will be updated.
Example
{
"allocationId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"duration": "abc123",
"cliff": 123,
"periods": 987,
"startsOn": Datetime,
"automatic": true,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
AllocationsVestingSchedulesConnection
Description
A connection to a list of AllocationsVestingSchedule values.
Fields
| Field Name | Description |
|---|---|
nodes - [AllocationsVestingSchedule]!
|
A list of AllocationsVestingSchedule objects. |
edges - [AllocationsVestingSchedulesEdge!]!
|
A list of edges which contains the AllocationsVestingSchedule and cursor to aid in pagination. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The count of all AllocationsVestingSchedule you could get from the connection. |
Example
{
"nodes": [AllocationsVestingSchedule],
"edges": [AllocationsVestingSchedulesEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
AllocationsVestingSchedulesEdge
Description
A AllocationsVestingSchedule edge in the connection.
Fields
| Field Name | Description |
|---|---|
cursor - Cursor
|
A cursor for use in pagination. |
node - AllocationsVestingSchedule
|
The AllocationsVestingSchedule at the end of the edge. |
Example
{
"cursor": Cursor,
"node": AllocationsVestingSchedule
}
AllocationsVestingSchedulesOrderBy
Description
Methods to use when ordering AllocationsVestingSchedule.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NATURAL"
Asset
Fields
| Field Name | Description |
|---|---|
nodeId - ID!
|
A globally unique identifier. Can be used in various places throughout the system to identify this single value. |
issuerId - UUID!
|
|
type - String!
|
|
name - String!
|
|
authorizedTotal - BigFloat
|
|
createdOn - Datetime!
|
|
status - String!
|
|
id - UUID!
|
|
accountByIssuerId - Account
|
Reads a single Account that is related to this Asset. |
assetTypeByType - AssetType
|
Reads a single AssetType that is related to this Asset. |
assetStatusByStatus - AssetStatus
|
Reads a single AssetStatus that is related to this Asset. |
assetArchivesByAssetId - AssetArchivesConnection!
|
Reads and enables pagination through a set of AssetArchive. |
Arguments
|
|
roundsByAssetId - RoundsConnection!
|
Reads and enables pagination through a set of Round. |
Arguments
|
|
assetAnnotationsByAssetId - AssetAnnotationsConnection!
|
Reads and enables pagination through a set of AssetAnnotation. |
Arguments
|
|
issuanceEventsByAssetId - IssuanceEventsConnection!
|
Reads and enables pagination through a set of IssuanceEvent. |
Arguments
|
|
holdings - BigFloat
|
|
Example
{
"nodeId": 4,
"issuerId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"type": "abc123",
"name": "abc123",
"authorizedTotal": BigFloat,
"createdOn": Datetime,
"status": "abc123",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountByIssuerId": Account,
"assetTypeByType": AssetType,
"assetStatusByStatus": AssetStatus,
"assetArchivesByAssetId": AssetArchivesConnection,
"roundsByAssetId": RoundsConnection,
"assetAnnotationsByAssetId": AssetAnnotationsConnection,
"issuanceEventsByAssetId": IssuanceEventsConnection,
"holdings": BigFloat
}
AssetAnnotation
Fields
| Field Name | Description |
|---|---|
nodeId - ID!
|
A globally unique identifier. Can be used in various places throughout the system to identify this single value. |
assetId - UUID!
|
|
writtenBy - UUID!
|
|
accountId - UUID!
|
|
annotation - String!
|
|
archive - Boolean!
|
|
createdOn - Datetime!
|
|
id - UUID!
|
|
assetByAssetId - Asset
|
Reads a single Asset that is related to this AssetAnnotation. |
userByWrittenBy - User
|
Reads a single User that is related to this AssetAnnotation. |
accountByAccountId - Account
|
Reads a single Account that is related to this AssetAnnotation. |
Example
{
"nodeId": "4",
"assetId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"writtenBy": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"annotation": "abc123",
"archive": false,
"createdOn": Datetime,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"assetByAssetId": Asset,
"userByWrittenBy": User,
"accountByAccountId": Account
}
AssetAnnotationCondition
Description
A condition to be used against AssetAnnotation object types. All fields are tested for equality and combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
assetId - UUID
|
Checks for equality with the object’s assetId field. |
writtenBy - UUID
|
Checks for equality with the object’s writtenBy field. |
accountId - UUID
|
Checks for equality with the object’s accountId field. |
annotation - String
|
Checks for equality with the object’s annotation field. |
archive - Boolean
|
Checks for equality with the object’s archive field. |
createdOn - Datetime
|
Checks for equality with the object’s createdOn field. |
id - UUID
|
Checks for equality with the object’s id field. |
Example
{
"assetId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"writtenBy": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"annotation": "xyz789",
"archive": true,
"createdOn": Datetime,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
AssetAnnotationFilter
Description
A filter to be used against AssetAnnotation object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
assetId - UUIDFilter
|
Filter by the object’s assetId field. |
writtenBy - UUIDFilter
|
Filter by the object’s writtenBy field. |
accountId - UUIDFilter
|
Filter by the object’s accountId field. |
annotation - StringFilter
|
Filter by the object’s annotation field. |
archive - BooleanFilter
|
Filter by the object’s archive field. |
createdOn - DatetimeFilter
|
Filter by the object’s createdOn field. |
id - UUIDFilter
|
Filter by the object’s id field. |
assetByAssetId - AssetFilter
|
Filter by the object’s assetByAssetId relation. |
userByWrittenBy - UserFilter
|
Filter by the object’s userByWrittenBy relation. |
accountByAccountId - AccountFilter
|
Filter by the object’s accountByAccountId relation. |
and - [AssetAnnotationFilter!]
|
Checks for all expressions in this list. |
or - [AssetAnnotationFilter!]
|
Checks for any expressions in this list. |
not - AssetAnnotationFilter
|
Negates the expression. |
Example
{
"assetId": UUIDFilter,
"writtenBy": UUIDFilter,
"accountId": UUIDFilter,
"annotation": StringFilter,
"archive": BooleanFilter,
"createdOn": DatetimeFilter,
"id": UUIDFilter,
"assetByAssetId": AssetFilter,
"userByWrittenBy": UserFilter,
"accountByAccountId": AccountFilter,
"and": [AssetAnnotationFilter],
"or": [AssetAnnotationFilter],
"not": AssetAnnotationFilter
}
AssetAnnotationInput
Description
An input for mutations affecting AssetAnnotation
Example
{
"assetId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"writtenBy": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"annotation": "xyz789",
"archive": false,
"createdOn": Datetime,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
AssetAnnotationPatch
Description
Represents an update to a AssetAnnotation. Fields that are set will be updated.
Example
{
"assetId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"writtenBy": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"annotation": "xyz789",
"archive": true,
"createdOn": Datetime,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
AssetAnnotationsConnection
Description
A connection to a list of AssetAnnotation values.
Fields
| Field Name | Description |
|---|---|
nodes - [AssetAnnotation]!
|
A list of AssetAnnotation objects. |
edges - [AssetAnnotationsEdge!]!
|
A list of edges which contains the AssetAnnotation and cursor to aid in pagination. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The count of all AssetAnnotation you could get from the connection. |
Example
{
"nodes": [AssetAnnotation],
"edges": [AssetAnnotationsEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
AssetAnnotationsEdge
Description
A AssetAnnotation edge in the connection.
Fields
| Field Name | Description |
|---|---|
cursor - Cursor
|
A cursor for use in pagination. |
node - AssetAnnotation
|
The AssetAnnotation at the end of the edge. |
Example
{
"cursor": Cursor,
"node": AssetAnnotation
}
AssetAnnotationsOrderBy
Description
Methods to use when ordering AssetAnnotation.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NATURAL"
AssetArchive
Fields
| Field Name | Description |
|---|---|
nodeId - ID!
|
A globally unique identifier. Can be used in various places throughout the system to identify this single value. |
assetId - UUID!
|
|
accountId - UUID!
|
|
archive - Boolean!
|
|
displayOrder - Int!
|
|
id - UUID!
|
|
assetByAssetId - Asset
|
Reads a single Asset that is related to this AssetArchive. |
accountByAccountId - Account
|
Reads a single Account that is related to this AssetArchive. |
Example
{
"nodeId": 4,
"assetId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"archive": false,
"displayOrder": 987,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"assetByAssetId": Asset,
"accountByAccountId": Account
}
AssetArchiveCondition
Description
A condition to be used against AssetArchive object types. All fields are tested for equality and combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
assetId - UUID
|
Checks for equality with the object’s assetId field. |
accountId - UUID
|
Checks for equality with the object’s accountId field. |
archive - Boolean
|
Checks for equality with the object’s archive field. |
displayOrder - Int
|
Checks for equality with the object’s displayOrder field. |
id - UUID
|
Checks for equality with the object’s id field. |
Example
{
"assetId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"archive": false,
"displayOrder": 123,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
AssetArchiveFilter
Description
A filter to be used against AssetArchive object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
assetId - UUIDFilter
|
Filter by the object’s assetId field. |
accountId - UUIDFilter
|
Filter by the object’s accountId field. |
archive - BooleanFilter
|
Filter by the object’s archive field. |
displayOrder - IntFilter
|
Filter by the object’s displayOrder field. |
id - UUIDFilter
|
Filter by the object’s id field. |
assetByAssetId - AssetFilter
|
Filter by the object’s assetByAssetId relation. |
accountByAccountId - AccountFilter
|
Filter by the object’s accountByAccountId relation. |
and - [AssetArchiveFilter!]
|
Checks for all expressions in this list. |
or - [AssetArchiveFilter!]
|
Checks for any expressions in this list. |
not - AssetArchiveFilter
|
Negates the expression. |
Example
{
"assetId": UUIDFilter,
"accountId": UUIDFilter,
"archive": BooleanFilter,
"displayOrder": IntFilter,
"id": UUIDFilter,
"assetByAssetId": AssetFilter,
"accountByAccountId": AccountFilter,
"and": [AssetArchiveFilter],
"or": [AssetArchiveFilter],
"not": AssetArchiveFilter
}
AssetArchivesConnection
Description
A connection to a list of AssetArchive values.
Fields
| Field Name | Description |
|---|---|
nodes - [AssetArchive]!
|
A list of AssetArchive objects. |
edges - [AssetArchivesEdge!]!
|
A list of edges which contains the AssetArchive and cursor to aid in pagination. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The count of all AssetArchive you could get from the connection. |
Example
{
"nodes": [AssetArchive],
"edges": [AssetArchivesEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
AssetArchivesEdge
Description
A AssetArchive edge in the connection.
Fields
| Field Name | Description |
|---|---|
cursor - Cursor
|
A cursor for use in pagination. |
node - AssetArchive
|
The AssetArchive at the end of the edge. |
Example
{
"cursor": Cursor,
"node": AssetArchive
}
AssetArchivesOrderBy
Description
Methods to use when ordering AssetArchive.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NATURAL"
AssetCondition
Description
A condition to be used against Asset object types. All fields are tested for equality and combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
issuerId - UUID
|
Checks for equality with the object’s issuerId field. |
type - String
|
Checks for equality with the object’s type field. |
name - String
|
Checks for equality with the object’s name field. |
authorizedTotal - BigFloat
|
Checks for equality with the object’s authorizedTotal field. |
createdOn - Datetime
|
Checks for equality with the object’s createdOn field. |
status - String
|
Checks for equality with the object’s status field. |
id - UUID
|
Checks for equality with the object’s id field. |
Example
{
"issuerId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"type": "abc123",
"name": "abc123",
"authorizedTotal": BigFloat,
"createdOn": Datetime,
"status": "abc123",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
AssetFilter
Description
A filter to be used against Asset object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
issuerId - UUIDFilter
|
Filter by the object’s issuerId field. |
type - StringFilter
|
Filter by the object’s type field. |
name - StringFilter
|
Filter by the object’s name field. |
authorizedTotal - BigFloatFilter
|
Filter by the object’s authorizedTotal field. |
createdOn - DatetimeFilter
|
Filter by the object’s createdOn field. |
status - StringFilter
|
Filter by the object’s status field. |
id - UUIDFilter
|
Filter by the object’s id field. |
holdings - BigFloatFilter
|
Filter by the object’s holdings field. |
assetArchivesByAssetId - AssetToManyAssetArchiveFilter
|
Filter by the object’s assetArchivesByAssetId relation. |
assetArchivesByAssetIdExist - Boolean
|
Some related assetArchivesByAssetId exist. |
roundsByAssetId - AssetToManyRoundFilter
|
Filter by the object’s roundsByAssetId relation. |
roundsByAssetIdExist - Boolean
|
Some related roundsByAssetId exist. |
assetAnnotationsByAssetId - AssetToManyAssetAnnotationFilter
|
Filter by the object’s assetAnnotationsByAssetId relation. |
assetAnnotationsByAssetIdExist - Boolean
|
Some related assetAnnotationsByAssetId exist. |
issuanceEventsByAssetId - AssetToManyIssuanceEventFilter
|
Filter by the object’s issuanceEventsByAssetId relation. |
issuanceEventsByAssetIdExist - Boolean
|
Some related issuanceEventsByAssetId exist. |
accountByIssuerId - AccountFilter
|
Filter by the object’s accountByIssuerId relation. |
assetTypeByType - AssetTypeFilter
|
Filter by the object’s assetTypeByType relation. |
assetStatusByStatus - AssetStatusFilter
|
Filter by the object’s assetStatusByStatus relation. |
and - [AssetFilter!]
|
Checks for all expressions in this list. |
or - [AssetFilter!]
|
Checks for any expressions in this list. |
not - AssetFilter
|
Negates the expression. |
Example
{
"issuerId": UUIDFilter,
"type": StringFilter,
"name": StringFilter,
"authorizedTotal": BigFloatFilter,
"createdOn": DatetimeFilter,
"status": StringFilter,
"id": UUIDFilter,
"holdings": BigFloatFilter,
"assetArchivesByAssetId": AssetToManyAssetArchiveFilter,
"assetArchivesByAssetIdExist": false,
"roundsByAssetId": AssetToManyRoundFilter,
"roundsByAssetIdExist": false,
"assetAnnotationsByAssetId": AssetToManyAssetAnnotationFilter,
"assetAnnotationsByAssetIdExist": false,
"issuanceEventsByAssetId": AssetToManyIssuanceEventFilter,
"issuanceEventsByAssetIdExist": true,
"accountByIssuerId": AccountFilter,
"assetTypeByType": AssetTypeFilter,
"assetStatusByStatus": AssetStatusFilter,
"and": [AssetFilter],
"or": [AssetFilter],
"not": AssetFilter
}
AssetInput
Description
An input for mutations affecting Asset
Example
{
"issuerId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"type": "abc123",
"name": "abc123",
"authorizedTotal": BigFloat,
"createdOn": Datetime,
"status": "xyz789",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
AssetPatch
Description
Represents an update to a Asset. Fields that are set will be updated.
Example
{
"issuerId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"type": "abc123",
"name": "xyz789",
"authorizedTotal": BigFloat,
"createdOn": Datetime,
"status": "abc123",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
AssetStatus
Fields
| Field Name | Description |
|---|---|
nodeId - ID!
|
A globally unique identifier. Can be used in various places throughout the system to identify this single value. |
status - String!
|
|
assetsByStatus - AssetsConnection!
|
Reads and enables pagination through a set of Asset. |
Arguments
|
|
roundsByStatus - RoundsConnection!
|
Reads and enables pagination through a set of Round. |
Arguments
|
|
allocationsByStatus - AllocationsConnection!
|
Reads and enables pagination through a set of Allocation. |
Arguments
|
|
Example
{
"nodeId": 4,
"status": "xyz789",
"assetsByStatus": AssetsConnection,
"roundsByStatus": RoundsConnection,
"allocationsByStatus": AllocationsConnection
}
AssetStatusCondition
Description
A condition to be used against AssetStatus object types. All fields are tested for equality and combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
status - String
|
Checks for equality with the object’s status field. |
Example
{"status": "abc123"}
AssetStatusFilter
Description
A filter to be used against AssetStatus object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
status - StringFilter
|
Filter by the object’s status field. |
assetsByStatus - AssetStatusToManyAssetFilter
|
Filter by the object’s assetsByStatus relation. |
assetsByStatusExist - Boolean
|
Some related assetsByStatus exist. |
roundsByStatus - AssetStatusToManyRoundFilter
|
Filter by the object’s roundsByStatus relation. |
roundsByStatusExist - Boolean
|
Some related roundsByStatus exist. |
allocationsByStatus - AssetStatusToManyAllocationFilter
|
Filter by the object’s allocationsByStatus relation. |
allocationsByStatusExist - Boolean
|
Some related allocationsByStatus exist. |
and - [AssetStatusFilter!]
|
Checks for all expressions in this list. |
or - [AssetStatusFilter!]
|
Checks for any expressions in this list. |
not - AssetStatusFilter
|
Negates the expression. |
Example
{
"status": StringFilter,
"assetsByStatus": AssetStatusToManyAssetFilter,
"assetsByStatusExist": true,
"roundsByStatus": AssetStatusToManyRoundFilter,
"roundsByStatusExist": false,
"allocationsByStatus": AssetStatusToManyAllocationFilter,
"allocationsByStatusExist": false,
"and": [AssetStatusFilter],
"or": [AssetStatusFilter],
"not": AssetStatusFilter
}
AssetStatusToManyAllocationFilter
Description
A filter to be used against many Allocation object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - AllocationFilter
|
Every related Allocation matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - AllocationFilter
|
Some related Allocation matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - AllocationFilter
|
No related Allocation matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": AllocationFilter,
"some": AllocationFilter,
"none": AllocationFilter
}
AssetStatusToManyAssetFilter
Description
A filter to be used against many Asset object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - AssetFilter
|
Every related Asset matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - AssetFilter
|
Some related Asset matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - AssetFilter
|
No related Asset matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": AssetFilter,
"some": AssetFilter,
"none": AssetFilter
}
AssetStatusToManyRoundFilter
Description
A filter to be used against many Round object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - RoundFilter
|
Every related Round matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - RoundFilter
|
Some related Round matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - RoundFilter
|
No related Round matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": RoundFilter,
"some": RoundFilter,
"none": RoundFilter
}
AssetStatusesConnection
Description
A connection to a list of AssetStatus values.
Fields
| Field Name | Description |
|---|---|
nodes - [AssetStatus]!
|
A list of AssetStatus objects. |
edges - [AssetStatusesEdge!]!
|
A list of edges which contains the AssetStatus and cursor to aid in pagination. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The count of all AssetStatus you could get from the connection. |
Example
{
"nodes": [AssetStatus],
"edges": [AssetStatusesEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
AssetStatusesEdge
Description
A AssetStatus edge in the connection.
Fields
| Field Name | Description |
|---|---|
cursor - Cursor
|
A cursor for use in pagination. |
node - AssetStatus
|
The AssetStatus at the end of the edge. |
Example
{
"cursor": Cursor,
"node": AssetStatus
}
AssetStatusesOrderBy
Description
Methods to use when ordering AssetStatus.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NATURAL"
AssetToManyAssetAnnotationFilter
Description
A filter to be used against many AssetAnnotation object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - AssetAnnotationFilter
|
Every related AssetAnnotation matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - AssetAnnotationFilter
|
Some related AssetAnnotation matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - AssetAnnotationFilter
|
No related AssetAnnotation matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": AssetAnnotationFilter,
"some": AssetAnnotationFilter,
"none": AssetAnnotationFilter
}
AssetToManyAssetArchiveFilter
Description
A filter to be used against many AssetArchive object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - AssetArchiveFilter
|
Every related AssetArchive matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - AssetArchiveFilter
|
Some related AssetArchive matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - AssetArchiveFilter
|
No related AssetArchive matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": AssetArchiveFilter,
"some": AssetArchiveFilter,
"none": AssetArchiveFilter
}
AssetToManyIssuanceEventFilter
Description
A filter to be used against many IssuanceEvent object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - IssuanceEventFilter
|
Every related IssuanceEvent matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - IssuanceEventFilter
|
Some related IssuanceEvent matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - IssuanceEventFilter
|
No related IssuanceEvent matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": IssuanceEventFilter,
"some": IssuanceEventFilter,
"none": IssuanceEventFilter
}
AssetToManyRoundFilter
Description
A filter to be used against many Round object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - RoundFilter
|
Every related Round matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - RoundFilter
|
Some related Round matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - RoundFilter
|
No related Round matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": RoundFilter,
"some": RoundFilter,
"none": RoundFilter
}
AssetType
Fields
| Field Name | Description |
|---|---|
nodeId - ID!
|
A globally unique identifier. Can be used in various places throughout the system to identify this single value. |
type - String!
|
|
accountingType - String!
|
|
accountingTypeByAccountingType - AccountingType
|
Reads a single AccountingType that is related to this AssetType. |
assetsByType - AssetsConnection!
|
Reads and enables pagination through a set of Asset. |
Arguments
|
|
Example
{
"nodeId": 4,
"type": "abc123",
"accountingType": "xyz789",
"accountingTypeByAccountingType": AccountingType,
"assetsByType": AssetsConnection
}
AssetTypeCondition
Description
A condition to be used against AssetType object types. All fields are tested for equality and combined with a logical ‘and.’
Example
{
"type": "xyz789",
"accountingType": "abc123"
}
AssetTypeFilter
Description
A filter to be used against AssetType object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
type - StringFilter
|
Filter by the object’s type field. |
accountingType - StringFilter
|
Filter by the object’s accountingType field. |
assetsByType - AssetTypeToManyAssetFilter
|
Filter by the object’s assetsByType relation. |
assetsByTypeExist - Boolean
|
Some related assetsByType exist. |
accountingTypeByAccountingType - AccountingTypeFilter
|
Filter by the object’s accountingTypeByAccountingType relation. |
and - [AssetTypeFilter!]
|
Checks for all expressions in this list. |
or - [AssetTypeFilter!]
|
Checks for any expressions in this list. |
not - AssetTypeFilter
|
Negates the expression. |
Example
{
"type": StringFilter,
"accountingType": StringFilter,
"assetsByType": AssetTypeToManyAssetFilter,
"assetsByTypeExist": false,
"accountingTypeByAccountingType": AccountingTypeFilter,
"and": [AssetTypeFilter],
"or": [AssetTypeFilter],
"not": AssetTypeFilter
}
AssetTypeToManyAssetFilter
Description
A filter to be used against many Asset object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - AssetFilter
|
Every related Asset matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - AssetFilter
|
Some related Asset matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - AssetFilter
|
No related Asset matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": AssetFilter,
"some": AssetFilter,
"none": AssetFilter
}
AssetTypesConnection
Description
A connection to a list of AssetType values.
Fields
| Field Name | Description |
|---|---|
nodes - [AssetType]!
|
A list of AssetType objects. |
edges - [AssetTypesEdge!]!
|
A list of edges which contains the AssetType and cursor to aid in pagination. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The count of all AssetType you could get from the connection. |
Example
{
"nodes": [AssetType],
"edges": [AssetTypesEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
AssetTypesEdge
AssetTypesOrderBy
Description
Methods to use when ordering AssetType.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NATURAL"
AssetsConnection
Description
A connection to a list of Asset values.
Fields
| Field Name | Description |
|---|---|
nodes - [Asset]!
|
A list of Asset objects. |
edges - [AssetsEdge!]!
|
A list of edges which contains the Asset and cursor to aid in pagination. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The count of all Asset you could get from the connection. |
Example
{
"nodes": [Asset],
"edges": [AssetsEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
AssetsEdge
AssetsOrderBy
Description
Methods to use when ordering Asset.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NATURAL"
AtsHoldingInput
AtsPriceInput
AtsTag
Fields
| Field Name | Description |
|---|---|
id - UUID
|
|
accountId - UUID
|
|
key - String
|
|
data - JSON
|
|
accountByAccountId - Account
|
Reads a single Account that is related to this AtsTag. |
stagedTransferAtsTagsByAtsTagId - StagedTransferAtsTagsConnection!
|
Reads and enables pagination through a set of StagedTransferAtsTag. |
Arguments
|
|
Example
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"key": "xyz789",
"data": {},
"accountByAccountId": Account,
"stagedTransferAtsTagsByAtsTagId": StagedTransferAtsTagsConnection
}
AtsTagCondition
Description
A condition to be used against AtsTag object types. All fields are tested for equality and combined with a logical ‘and.’
Example
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"key": "xyz789",
"data": {}
}
AtsTagFilter
Description
A filter to be used against AtsTag object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
id - UUIDFilter
|
Filter by the object’s id field. |
accountId - UUIDFilter
|
Filter by the object’s accountId field. |
key - StringFilter
|
Filter by the object’s key field. |
data - JSONFilter
|
Filter by the object’s data field. |
stagedTransferAtsTagsByAtsTagId - AtsTagToManyStagedTransferAtsTagFilter
|
Filter by the object’s stagedTransferAtsTagsByAtsTagId relation. |
stagedTransferAtsTagsByAtsTagIdExist - Boolean
|
Some related stagedTransferAtsTagsByAtsTagId exist. |
accountByAccountId - AccountFilter
|
Filter by the object’s accountByAccountId relation. |
accountByAccountIdExists - Boolean
|
A related accountByAccountId exists. |
and - [AtsTagFilter!]
|
Checks for all expressions in this list. |
or - [AtsTagFilter!]
|
Checks for any expressions in this list. |
not - AtsTagFilter
|
Negates the expression. |
Example
{
"id": UUIDFilter,
"accountId": UUIDFilter,
"key": StringFilter,
"data": JSONFilter,
"stagedTransferAtsTagsByAtsTagId": AtsTagToManyStagedTransferAtsTagFilter,
"stagedTransferAtsTagsByAtsTagIdExist": false,
"accountByAccountId": AccountFilter,
"accountByAccountIdExists": true,
"and": [AtsTagFilter],
"or": [AtsTagFilter],
"not": AtsTagFilter
}
AtsTagToManyStagedTransferAtsTagFilter
Description
A filter to be used against many StagedTransferAtsTag object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - StagedTransferAtsTagFilter
|
Every related StagedTransferAtsTag matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - StagedTransferAtsTagFilter
|
Some related StagedTransferAtsTag matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - StagedTransferAtsTagFilter
|
No related StagedTransferAtsTag matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": StagedTransferAtsTagFilter,
"some": StagedTransferAtsTagFilter,
"none": StagedTransferAtsTagFilter
}
AtsTagsConnection
Description
A connection to a list of AtsTag values.
Fields
| Field Name | Description |
|---|---|
nodes - [AtsTag]!
|
A list of AtsTag objects. |
edges - [AtsTagsEdge!]!
|
A list of edges which contains the AtsTag and cursor to aid in pagination. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The count of all AtsTag you could get from the connection. |
Example
{
"nodes": [AtsTag],
"edges": [AtsTagsEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
AtsTagsEdge
AtsTagsOrderBy
Description
Methods to use when ordering AtsTag.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NATURAL"
AtsToInput
Fields
| Input Field | Description |
|---|---|
id - UUID
|
|
email - String
|
|
jurisdiction - String
|
|
name - String
|
|
accountSetupData - ShadowSetupAccountInput
|
|
investorInformation - DepositAccountInput
|
Example
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"email": "abc123",
"jurisdiction": "xyz789",
"name": "xyz789",
"accountSetupData": ShadowSetupAccountInput,
"investorInformation": DepositAccountInput
}
AtsTransferInput
Fields
| Input Field | Description |
|---|---|
idempotencyId - UUID!
|
|
fee - AtsPriceInput
|
|
investorId - UUID!
|
|
to - AtsToInput!
|
|
externalInvestorId - String
|
|
holdings - [AtsHoldingInput!]!
|
|
signature - DepositSignatureInput!
|
|
investorInformation - DepositAccountInput
|
|
usdPrice - BigFloat!
|
|
transferPrice - AtsPriceInput
|
|
tags - [DepositTagInput]
|
|
data - JSON
|
|
securityId - UUID!
|
|
matchedOn - Datetime
|
|
settledOn - Datetime
|
Example
{
"idempotencyId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"fee": AtsPriceInput,
"investorId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"to": AtsToInput,
"externalInvestorId": "xyz789",
"holdings": [AtsHoldingInput],
"signature": DepositSignatureInput,
"investorInformation": DepositAccountInput,
"usdPrice": BigFloat,
"transferPrice": AtsPriceInput,
"tags": [DepositTagInput],
"data": {},
"securityId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"matchedOn": Datetime,
"settledOn": Datetime
}
AuxAccount
Fields
| Field Name | Description |
|---|---|
nodeId - ID!
|
A globally unique identifier. Can be used in various places throughout the system to identify this single value. |
type - String!
|
|
accountsByType - AccountsConnection!
|
Reads and enables pagination through a set of Account. |
Arguments
|
|
documentSharingAllowedSharesByFromAccountType - DocumentSharingAllowedSharesConnection!
|
Reads and enables pagination through a set of DocumentSharingAllowedShare. |
Arguments
|
|
Example
{
"nodeId": "4",
"type": "xyz789",
"accountsByType": AccountsConnection,
"documentSharingAllowedSharesByFromAccountType": DocumentSharingAllowedSharesConnection
}
AuxAccountCondition
Description
A condition to be used against AuxAccount object types. All fields are tested for equality and combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
type - String
|
Checks for equality with the object’s type field. |
Example
{"type": "xyz789"}
AuxAccountFilter
Description
A filter to be used against AuxAccount object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
type - StringFilter
|
Filter by the object’s type field. |
accountsByType - AuxAccountToManyAccountFilter
|
Filter by the object’s accountsByType relation. |
accountsByTypeExist - Boolean
|
Some related accountsByType exist. |
documentSharingAllowedSharesByFromAccountType - AuxAccountToManyDocumentSharingAllowedShareFilter
|
Filter by the object’s documentSharingAllowedSharesByFromAccountType relation. |
documentSharingAllowedSharesByFromAccountTypeExist - Boolean
|
Some related documentSharingAllowedSharesByFromAccountType exist. |
and - [AuxAccountFilter!]
|
Checks for all expressions in this list. |
or - [AuxAccountFilter!]
|
Checks for any expressions in this list. |
not - AuxAccountFilter
|
Negates the expression. |
Example
{
"type": StringFilter,
"accountsByType": AuxAccountToManyAccountFilter,
"accountsByTypeExist": true,
"documentSharingAllowedSharesByFromAccountType": AuxAccountToManyDocumentSharingAllowedShareFilter,
"documentSharingAllowedSharesByFromAccountTypeExist": true,
"and": [AuxAccountFilter],
"or": [AuxAccountFilter],
"not": AuxAccountFilter
}
AuxAccountInput
Description
An input for mutations affecting AuxAccount
Fields
| Input Field | Description |
|---|---|
type - String!
|
Example
{"type": "xyz789"}
AuxAccountPatch
Description
Represents an update to a AuxAccount. Fields that are set will be updated.
Fields
| Input Field | Description |
|---|---|
type - String
|
Example
{"type": "abc123"}
AuxAccountToManyAccountFilter
Description
A filter to be used against many Account object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - AccountFilter
|
Every related Account matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - AccountFilter
|
Some related Account matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - AccountFilter
|
No related Account matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": AccountFilter,
"some": AccountFilter,
"none": AccountFilter
}
AuxAccountsConnection
Description
A connection to a list of AuxAccount values.
Fields
| Field Name | Description |
|---|---|
nodes - [AuxAccount]!
|
A list of AuxAccount objects. |
edges - [AuxAccountsEdge!]!
|
A list of edges which contains the AuxAccount and cursor to aid in pagination. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The count of all AuxAccount you could get from the connection. |
Example
{
"nodes": [AuxAccount],
"edges": [AuxAccountsEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
AuxAccountsEdge
Description
A AuxAccount edge in the connection.
Fields
| Field Name | Description |
|---|---|
cursor - Cursor
|
A cursor for use in pagination. |
node - AuxAccount
|
The AuxAccount at the end of the edge. |
Example
{
"cursor": Cursor,
"node": AuxAccount
}
AuxAccountsOrderBy
Description
Methods to use when ordering AuxAccount.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NATURAL"
AuxRole
Fields
| Field Name | Description |
|---|---|
nodeId - ID!
|
A globally unique identifier. Can be used in various places throughout the system to identify this single value. |
role - String!
|
|
usersAccountsByRole - UsersAccountsConnection!
|
Reads and enables pagination through a set of UsersAccount. |
Arguments
|
|
Example
{
"nodeId": "4",
"role": "xyz789",
"usersAccountsByRole": UsersAccountsConnection
}
AuxRoleCondition
Description
A condition to be used against AuxRole object types. All fields are tested for equality and combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
role - String
|
Checks for equality with the object’s role field. |
Example
{"role": "xyz789"}
AuxRoleFilter
Description
A filter to be used against AuxRole object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
role - StringFilter
|
Filter by the object’s role field. |
usersAccountsByRole - AuxRoleToManyUsersAccountFilter
|
Filter by the object’s usersAccountsByRole relation. |
usersAccountsByRoleExist - Boolean
|
Some related usersAccountsByRole exist. |
and - [AuxRoleFilter!]
|
Checks for all expressions in this list. |
or - [AuxRoleFilter!]
|
Checks for any expressions in this list. |
not - AuxRoleFilter
|
Negates the expression. |
Example
{
"role": StringFilter,
"usersAccountsByRole": AuxRoleToManyUsersAccountFilter,
"usersAccountsByRoleExist": false,
"and": [AuxRoleFilter],
"or": [AuxRoleFilter],
"not": AuxRoleFilter
}
AuxRoleInput
Description
An input for mutations affecting AuxRole
Fields
| Input Field | Description |
|---|---|
role - String!
|
Example
{"role": "abc123"}
AuxRolePatch
Description
Represents an update to a AuxRole. Fields that are set will be updated.
Fields
| Input Field | Description |
|---|---|
role - String
|
Example
{"role": "abc123"}
AuxRoleToManyUsersAccountFilter
Description
A filter to be used against many UsersAccount object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - UsersAccountFilter
|
Every related UsersAccount matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - UsersAccountFilter
|
Some related UsersAccount matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - UsersAccountFilter
|
No related UsersAccount matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": UsersAccountFilter,
"some": UsersAccountFilter,
"none": UsersAccountFilter
}
AuxRolesConnection
Description
A connection to a list of AuxRole values.
Fields
| Field Name | Description |
|---|---|
nodes - [AuxRole]!
|
A list of AuxRole objects. |
edges - [AuxRolesEdge!]!
|
A list of edges which contains the AuxRole and cursor to aid in pagination. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The count of all AuxRole you could get from the connection. |
Example
{
"nodes": [AuxRole],
"edges": [AuxRolesEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
AuxRolesEdge
AuxRolesOrderBy
Description
Methods to use when ordering AuxRole.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NATURAL"
BatchTransferInput
Fields
| Input Field | Description |
|---|---|
idempotencyId - UUID!
|
|
transfer - [AtsTransferInput]
|
Example
{
"idempotencyId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"transfer": [AtsTransferInput]
}
BigFloat
Description
A floating point number that requires more precision than IEEE 754 binary 64
Example
BigFloat
BigFloatFilter
Description
A filter to be used against BigFloat fields. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
isNull - Boolean
|
Is null (if true is specified) or is not null (if false is specified). |
equalTo - BigFloat
|
Equal to the specified value. |
notEqualTo - BigFloat
|
Not equal to the specified value. |
distinctFrom - BigFloat
|
Not equal to the specified value, treating null like an ordinary value. |
notDistinctFrom - BigFloat
|
Equal to the specified value, treating null like an ordinary value. |
in - [BigFloat!]
|
Included in the specified list. |
notIn - [BigFloat!]
|
Not included in the specified list. |
lessThan - BigFloat
|
Less than the specified value. |
lessThanOrEqualTo - BigFloat
|
Less than or equal to the specified value. |
greaterThan - BigFloat
|
Greater than the specified value. |
greaterThanOrEqualTo - BigFloat
|
Greater than or equal to the specified value. |
Example
{
"isNull": true,
"equalTo": BigFloat,
"notEqualTo": BigFloat,
"distinctFrom": BigFloat,
"notDistinctFrom": BigFloat,
"in": [BigFloat],
"notIn": [BigFloat],
"lessThan": BigFloat,
"lessThanOrEqualTo": BigFloat,
"greaterThan": BigFloat,
"greaterThanOrEqualTo": BigFloat
}
BitString
Description
A string representing a series of binary bits
Example
BitString
BitStringFilter
Description
A filter to be used against BitString fields. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
isNull - Boolean
|
Is null (if true is specified) or is not null (if false is specified). |
equalTo - BitString
|
Equal to the specified value. |
notEqualTo - BitString
|
Not equal to the specified value. |
distinctFrom - BitString
|
Not equal to the specified value, treating null like an ordinary value. |
notDistinctFrom - BitString
|
Equal to the specified value, treating null like an ordinary value. |
in - [BitString!]
|
Included in the specified list. |
notIn - [BitString!]
|
Not included in the specified list. |
lessThan - BitString
|
Less than the specified value. |
lessThanOrEqualTo - BitString
|
Less than or equal to the specified value. |
greaterThan - BitString
|
Greater than the specified value. |
greaterThanOrEqualTo - BitString
|
Greater than or equal to the specified value. |
Example
{
"isNull": false,
"equalTo": BitString,
"notEqualTo": BitString,
"distinctFrom": BitString,
"notDistinctFrom": BitString,
"in": [BitString],
"notIn": [BitString],
"lessThan": BitString,
"lessThanOrEqualTo": BitString,
"greaterThan": BitString,
"greaterThanOrEqualTo": BitString
}
BlockchainAddress
Fields
| Field Name | Description |
|---|---|
nodeId - ID!
|
A globally unique identifier. Can be used in various places throughout the system to identify this single value. |
chain - String!
|
|
address - String!
|
|
createdOn - Datetime!
|
|
id - UUID!
|
|
chainByChain - Chain
|
Reads a single Chain that is related to this BlockchainAddress. |
capTablesByBlockchainAddressId - CapTablesConnection!
|
Reads and enables pagination through a set of CapTable. |
Arguments
|
|
accountsBlockchainAddressesByBlockchainAddressId - AccountsBlockchainAddressesConnection!
|
Reads and enables pagination through a set of AccountsBlockchainAddress. |
Arguments
|
|
blockchainRegistrationsByBlockchainAddressId - BlockchainRegistrationsConnection!
|
Reads and enables pagination through a set of BlockchainRegistration. |
Arguments
|
|
roundByBlockchainAddressId - Round
|
Reads a single Round that is related to this BlockchainAddress. |
roundsByBlockchainAddressId - RoundsConnection!
|
Reads and enables pagination through a set of Round. Please use roundByBlockchainAddressId instead
|
Arguments
|
|
allocationsByBlockchainAddressId - AllocationsConnection!
|
Reads and enables pagination through a set of Allocation. |
Arguments
|
|
walletAssignmentsByBlockchainAddressId - WalletAssignmentsConnection!
|
Reads and enables pagination through a set of WalletAssignment. |
Arguments
|
|
ledgersByBlockchainAddressId - LedgersConnection!
|
Reads and enables pagination through a set of Ledger. |
Arguments
|
|
securityByBlockchainAddressId - Security
|
Reads a single Security that is related to this BlockchainAddress. |
securitiesByBlockchainAddressId - SecuritiesConnection!
|
Reads and enables pagination through a set of Security. Please use securityByBlockchainAddressId instead
|
Arguments
|
|
holdingBlockchainAddressByBlockchainAddressId - HoldingBlockchainAddress
|
Reads a single HoldingBlockchainAddress that is related to this BlockchainAddress. |
holdingBlockchainAddressesByBlockchainAddressId - HoldingBlockchainAddressesConnection!
|
Reads and enables pagination through a set of HoldingBlockchainAddress. Please use holdingBlockchainAddressByBlockchainAddressId instead
|
Arguments
|
|
blockchainAddressSourcesByBlockchainAddressId - BlockchainAddressSourcesConnection!
|
Reads and enables pagination through a set of BlockchainAddressSource. |
Arguments
|
|
taRequestsByFromBlockchainAddressId - TaRequestsConnection!
|
Reads and enables pagination through a set of TaRequest. |
Arguments
|
|
taRequestsByToBlockchainAddressId - TaRequestsConnection!
|
Reads and enables pagination through a set of TaRequest. |
Arguments
|
|
Example
{
"nodeId": 4,
"chain": "xyz789",
"address": "abc123",
"createdOn": Datetime,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"chainByChain": Chain,
"capTablesByBlockchainAddressId": CapTablesConnection,
"accountsBlockchainAddressesByBlockchainAddressId": AccountsBlockchainAddressesConnection,
"blockchainRegistrationsByBlockchainAddressId": BlockchainRegistrationsConnection,
"roundByBlockchainAddressId": Round,
"roundsByBlockchainAddressId": RoundsConnection,
"allocationsByBlockchainAddressId": AllocationsConnection,
"walletAssignmentsByBlockchainAddressId": WalletAssignmentsConnection,
"ledgersByBlockchainAddressId": LedgersConnection,
"securityByBlockchainAddressId": Security,
"securitiesByBlockchainAddressId": SecuritiesConnection,
"holdingBlockchainAddressByBlockchainAddressId": HoldingBlockchainAddress,
"holdingBlockchainAddressesByBlockchainAddressId": HoldingBlockchainAddressesConnection,
"blockchainAddressSourcesByBlockchainAddressId": BlockchainAddressSourcesConnection,
"taRequestsByFromBlockchainAddressId": TaRequestsConnection,
"taRequestsByToBlockchainAddressId": TaRequestsConnection
}
BlockchainAddressCondition
Description
A condition to be used against BlockchainAddress object types. All fields are tested for equality and combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
chain - String
|
Checks for equality with the object’s chain field. |
address - String
|
Checks for equality with the object’s address field. |
createdOn - Datetime
|
Checks for equality with the object’s createdOn field. |
id - UUID
|
Checks for equality with the object’s id field. |
Example
{
"chain": "xyz789",
"address": "xyz789",
"createdOn": Datetime,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
BlockchainAddressFilter
Description
A filter to be used against BlockchainAddress object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
chain - StringFilter
|
Filter by the object’s chain field. |
address - StringFilter
|
Filter by the object’s address field. |
createdOn - DatetimeFilter
|
Filter by the object’s createdOn field. |
id - UUIDFilter
|
Filter by the object’s id field. |
capTablesByBlockchainAddressId - BlockchainAddressToManyCapTableFilter
|
Filter by the object’s capTablesByBlockchainAddressId relation. |
capTablesByBlockchainAddressIdExist - Boolean
|
Some related capTablesByBlockchainAddressId exist. |
accountsBlockchainAddressesByBlockchainAddressId - BlockchainAddressToManyAccountsBlockchainAddressFilter
|
Filter by the object’s accountsBlockchainAddressesByBlockchainAddressId relation. |
accountsBlockchainAddressesByBlockchainAddressIdExist - Boolean
|
Some related accountsBlockchainAddressesByBlockchainAddressId exist. |
blockchainRegistrationsByBlockchainAddressId - BlockchainAddressToManyBlockchainRegistrationFilter
|
Filter by the object’s blockchainRegistrationsByBlockchainAddressId relation. |
blockchainRegistrationsByBlockchainAddressIdExist - Boolean
|
Some related blockchainRegistrationsByBlockchainAddressId exist. |
roundByBlockchainAddressId - RoundFilter
|
Filter by the object’s roundByBlockchainAddressId relation. |
roundByBlockchainAddressIdExists - Boolean
|
A related roundByBlockchainAddressId exists. |
allocationsByBlockchainAddressId - BlockchainAddressToManyAllocationFilter
|
Filter by the object’s allocationsByBlockchainAddressId relation. |
allocationsByBlockchainAddressIdExist - Boolean
|
Some related allocationsByBlockchainAddressId exist. |
walletAssignmentsByBlockchainAddressId - BlockchainAddressToManyWalletAssignmentFilter
|
Filter by the object’s walletAssignmentsByBlockchainAddressId relation. |
walletAssignmentsByBlockchainAddressIdExist - Boolean
|
Some related walletAssignmentsByBlockchainAddressId exist. |
ledgersByBlockchainAddressId - BlockchainAddressToManyLedgerFilter
|
Filter by the object’s ledgersByBlockchainAddressId relation. |
ledgersByBlockchainAddressIdExist - Boolean
|
Some related ledgersByBlockchainAddressId exist. |
securityByBlockchainAddressId - SecurityFilter
|
Filter by the object’s securityByBlockchainAddressId relation. |
securityByBlockchainAddressIdExists - Boolean
|
A related securityByBlockchainAddressId exists. |
holdingBlockchainAddressByBlockchainAddressId - HoldingBlockchainAddressFilter
|
Filter by the object’s holdingBlockchainAddressByBlockchainAddressId relation. |
holdingBlockchainAddressByBlockchainAddressIdExists - Boolean
|
A related holdingBlockchainAddressByBlockchainAddressId exists. |
blockchainAddressSourcesByBlockchainAddressId - BlockchainAddressToManyBlockchainAddressSourceFilter
|
Filter by the object’s blockchainAddressSourcesByBlockchainAddressId relation. |
blockchainAddressSourcesByBlockchainAddressIdExist - Boolean
|
Some related blockchainAddressSourcesByBlockchainAddressId exist. |
taRequestsByFromBlockchainAddressId - BlockchainAddressToManyTaRequestFilter
|
Filter by the object’s taRequestsByFromBlockchainAddressId relation. |
taRequestsByFromBlockchainAddressIdExist - Boolean
|
Some related taRequestsByFromBlockchainAddressId exist. |
taRequestsByToBlockchainAddressId - BlockchainAddressToManyTaRequestFilter
|
Filter by the object’s taRequestsByToBlockchainAddressId relation. |
taRequestsByToBlockchainAddressIdExist - Boolean
|
Some related taRequestsByToBlockchainAddressId exist. |
chainByChain - ChainFilter
|
Filter by the object’s chainByChain relation. |
and - [BlockchainAddressFilter!]
|
Checks for all expressions in this list. |
or - [BlockchainAddressFilter!]
|
Checks for any expressions in this list. |
not - BlockchainAddressFilter
|
Negates the expression. |
Example
{
"chain": StringFilter,
"address": StringFilter,
"createdOn": DatetimeFilter,
"id": UUIDFilter,
"capTablesByBlockchainAddressId": BlockchainAddressToManyCapTableFilter,
"capTablesByBlockchainAddressIdExist": true,
"accountsBlockchainAddressesByBlockchainAddressId": BlockchainAddressToManyAccountsBlockchainAddressFilter,
"accountsBlockchainAddressesByBlockchainAddressIdExist": true,
"blockchainRegistrationsByBlockchainAddressId": BlockchainAddressToManyBlockchainRegistrationFilter,
"blockchainRegistrationsByBlockchainAddressIdExist": true,
"roundByBlockchainAddressId": RoundFilter,
"roundByBlockchainAddressIdExists": false,
"allocationsByBlockchainAddressId": BlockchainAddressToManyAllocationFilter,
"allocationsByBlockchainAddressIdExist": true,
"walletAssignmentsByBlockchainAddressId": BlockchainAddressToManyWalletAssignmentFilter,
"walletAssignmentsByBlockchainAddressIdExist": true,
"ledgersByBlockchainAddressId": BlockchainAddressToManyLedgerFilter,
"ledgersByBlockchainAddressIdExist": false,
"securityByBlockchainAddressId": SecurityFilter,
"securityByBlockchainAddressIdExists": true,
"holdingBlockchainAddressByBlockchainAddressId": HoldingBlockchainAddressFilter,
"holdingBlockchainAddressByBlockchainAddressIdExists": false,
"blockchainAddressSourcesByBlockchainAddressId": BlockchainAddressToManyBlockchainAddressSourceFilter,
"blockchainAddressSourcesByBlockchainAddressIdExist": true,
"taRequestsByFromBlockchainAddressId": BlockchainAddressToManyTaRequestFilter,
"taRequestsByFromBlockchainAddressIdExist": false,
"taRequestsByToBlockchainAddressId": BlockchainAddressToManyTaRequestFilter,
"taRequestsByToBlockchainAddressIdExist": true,
"chainByChain": ChainFilter,
"and": [BlockchainAddressFilter],
"or": [BlockchainAddressFilter],
"not": BlockchainAddressFilter
}
BlockchainAddressGroup
Fields
| Field Name | Description |
|---|---|
nodeId - ID!
|
A globally unique identifier. Can be used in various places throughout the system to identify this single value. |
id - UUID!
|
|
accountsBlockchainAddressesByBlockchainAddressGroupId - AccountsBlockchainAddressesConnection!
|
Reads and enables pagination through a set of AccountsBlockchainAddress. |
Arguments
|
|
Example
{
"nodeId": 4,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountsBlockchainAddressesByBlockchainAddressGroupId": AccountsBlockchainAddressesConnection
}
BlockchainAddressGroupCondition
Description
A condition to be used against BlockchainAddressGroup object types. All fields are tested for equality and combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
id - UUID
|
Checks for equality with the object’s id field. |
Example
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
BlockchainAddressGroupFilter
Description
A filter to be used against BlockchainAddressGroup object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
id - UUIDFilter
|
Filter by the object’s id field. |
accountsBlockchainAddressesByBlockchainAddressGroupId - BlockchainAddressGroupToManyAccountsBlockchainAddressFilter
|
Filter by the object’s accountsBlockchainAddressesByBlockchainAddressGroupId relation. |
accountsBlockchainAddressesByBlockchainAddressGroupIdExist - Boolean
|
Some related accountsBlockchainAddressesByBlockchainAddressGroupId exist. |
and - [BlockchainAddressGroupFilter!]
|
Checks for all expressions in this list. |
or - [BlockchainAddressGroupFilter!]
|
Checks for any expressions in this list. |
not - BlockchainAddressGroupFilter
|
Negates the expression. |
Example
{
"id": UUIDFilter,
"accountsBlockchainAddressesByBlockchainAddressGroupId": BlockchainAddressGroupToManyAccountsBlockchainAddressFilter,
"accountsBlockchainAddressesByBlockchainAddressGroupIdExist": true,
"and": [BlockchainAddressGroupFilter],
"or": [BlockchainAddressGroupFilter],
"not": BlockchainAddressGroupFilter
}
BlockchainAddressGroupToManyAccountsBlockchainAddressFilter
Description
A filter to be used against many AccountsBlockchainAddress object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - AccountsBlockchainAddressFilter
|
Every related AccountsBlockchainAddress matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - AccountsBlockchainAddressFilter
|
Some related AccountsBlockchainAddress matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - AccountsBlockchainAddressFilter
|
No related AccountsBlockchainAddress matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": AccountsBlockchainAddressFilter,
"some": AccountsBlockchainAddressFilter,
"none": AccountsBlockchainAddressFilter
}
BlockchainAddressGroupsConnection
Description
A connection to a list of BlockchainAddressGroup values.
Fields
| Field Name | Description |
|---|---|
nodes - [BlockchainAddressGroup]!
|
A list of BlockchainAddressGroup objects. |
edges - [BlockchainAddressGroupsEdge!]!
|
A list of edges which contains the BlockchainAddressGroup and cursor to aid in pagination. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The count of all BlockchainAddressGroup you could get from the connection. |
Example
{
"nodes": [BlockchainAddressGroup],
"edges": [BlockchainAddressGroupsEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
BlockchainAddressGroupsEdge
Description
A BlockchainAddressGroup edge in the connection.
Fields
| Field Name | Description |
|---|---|
cursor - Cursor
|
A cursor for use in pagination. |
node - BlockchainAddressGroup
|
The BlockchainAddressGroup at the end of the edge. |
Example
{
"cursor": Cursor,
"node": BlockchainAddressGroup
}
BlockchainAddressGroupsOrderBy
Description
Methods to use when ordering BlockchainAddressGroup.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NATURAL"
BlockchainAddressSource
Fields
| Field Name | Description |
|---|---|
nodeId - ID!
|
A globally unique identifier. Can be used in various places throughout the system to identify this single value. |
id - UUID!
|
|
blockchainAddressId - UUID!
|
|
vendorId - UUID!
|
|
investorId - UUID!
|
|
creatorAccountId - UUID!
|
|
creatorUserId - UUID!
|
|
createdOn - Datetime!
|
|
blockchainAddressByBlockchainAddressId - BlockchainAddress
|
Reads a single BlockchainAddress that is related to this BlockchainAddressSource. |
accountByVendorId - Account
|
Reads a single Account that is related to this BlockchainAddressSource. |
accountByInvestorId - Account
|
Reads a single Account that is related to this BlockchainAddressSource. |
accountByCreatorAccountId - Account
|
Reads a single Account that is related to this BlockchainAddressSource. |
userByCreatorUserId - User
|
Reads a single User that is related to this BlockchainAddressSource. |
Example
{
"nodeId": "4",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"blockchainAddressId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"vendorId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"investorId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"creatorAccountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"creatorUserId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"createdOn": Datetime,
"blockchainAddressByBlockchainAddressId": BlockchainAddress,
"accountByVendorId": Account,
"accountByInvestorId": Account,
"accountByCreatorAccountId": Account,
"userByCreatorUserId": User
}
BlockchainAddressSourceCondition
Description
A condition to be used against BlockchainAddressSource object types. All fields are tested for equality and combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
id - UUID
|
Checks for equality with the object’s id field. |
blockchainAddressId - UUID
|
Checks for equality with the object’s blockchainAddressId field. |
vendorId - UUID
|
Checks for equality with the object’s vendorId field. |
investorId - UUID
|
Checks for equality with the object’s investorId field. |
creatorAccountId - UUID
|
Checks for equality with the object’s creatorAccountId field. |
creatorUserId - UUID
|
Checks for equality with the object’s creatorUserId field. |
createdOn - Datetime
|
Checks for equality with the object’s createdOn field. |
Example
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"blockchainAddressId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"vendorId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"investorId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"creatorAccountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"creatorUserId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"createdOn": Datetime
}
BlockchainAddressSourceFilter
Description
A filter to be used against BlockchainAddressSource object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
id - UUIDFilter
|
Filter by the object’s id field. |
blockchainAddressId - UUIDFilter
|
Filter by the object’s blockchainAddressId field. |
vendorId - UUIDFilter
|
Filter by the object’s vendorId field. |
investorId - UUIDFilter
|
Filter by the object’s investorId field. |
creatorAccountId - UUIDFilter
|
Filter by the object’s creatorAccountId field. |
creatorUserId - UUIDFilter
|
Filter by the object’s creatorUserId field. |
createdOn - DatetimeFilter
|
Filter by the object’s createdOn field. |
blockchainAddressByBlockchainAddressId - BlockchainAddressFilter
|
Filter by the object’s blockchainAddressByBlockchainAddressId relation. |
accountByVendorId - AccountFilter
|
Filter by the object’s accountByVendorId relation. |
accountByInvestorId - AccountFilter
|
Filter by the object’s accountByInvestorId relation. |
accountByCreatorAccountId - AccountFilter
|
Filter by the object’s accountByCreatorAccountId relation. |
userByCreatorUserId - UserFilter
|
Filter by the object’s userByCreatorUserId relation. |
and - [BlockchainAddressSourceFilter!]
|
Checks for all expressions in this list. |
or - [BlockchainAddressSourceFilter!]
|
Checks for any expressions in this list. |
not - BlockchainAddressSourceFilter
|
Negates the expression. |
Example
{
"id": UUIDFilter,
"blockchainAddressId": UUIDFilter,
"vendorId": UUIDFilter,
"investorId": UUIDFilter,
"creatorAccountId": UUIDFilter,
"creatorUserId": UUIDFilter,
"createdOn": DatetimeFilter,
"blockchainAddressByBlockchainAddressId": BlockchainAddressFilter,
"accountByVendorId": AccountFilter,
"accountByInvestorId": AccountFilter,
"accountByCreatorAccountId": AccountFilter,
"userByCreatorUserId": UserFilter,
"and": [BlockchainAddressSourceFilter],
"or": [BlockchainAddressSourceFilter],
"not": BlockchainAddressSourceFilter
}
BlockchainAddressSourcesConnection
Description
A connection to a list of BlockchainAddressSource values.
Fields
| Field Name | Description |
|---|---|
nodes - [BlockchainAddressSource]!
|
A list of BlockchainAddressSource objects. |
edges - [BlockchainAddressSourcesEdge!]!
|
A list of edges which contains the BlockchainAddressSource and cursor to aid in pagination. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The count of all BlockchainAddressSource you could get from the connection. |
Example
{
"nodes": [BlockchainAddressSource],
"edges": [BlockchainAddressSourcesEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
BlockchainAddressSourcesEdge
Description
A BlockchainAddressSource edge in the connection.
Fields
| Field Name | Description |
|---|---|
cursor - Cursor
|
A cursor for use in pagination. |
node - BlockchainAddressSource
|
The BlockchainAddressSource at the end of the edge. |
Example
{
"cursor": Cursor,
"node": BlockchainAddressSource
}
BlockchainAddressSourcesOrderBy
Description
Methods to use when ordering BlockchainAddressSource.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NATURAL"
BlockchainAddressToManyAccountsBlockchainAddressFilter
Description
A filter to be used against many AccountsBlockchainAddress object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - AccountsBlockchainAddressFilter
|
Every related AccountsBlockchainAddress matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - AccountsBlockchainAddressFilter
|
Some related AccountsBlockchainAddress matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - AccountsBlockchainAddressFilter
|
No related AccountsBlockchainAddress matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": AccountsBlockchainAddressFilter,
"some": AccountsBlockchainAddressFilter,
"none": AccountsBlockchainAddressFilter
}
BlockchainAddressToManyAllocationFilter
Description
A filter to be used against many Allocation object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - AllocationFilter
|
Every related Allocation matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - AllocationFilter
|
Some related Allocation matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - AllocationFilter
|
No related Allocation matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": AllocationFilter,
"some": AllocationFilter,
"none": AllocationFilter
}
BlockchainAddressToManyBlockchainAddressSourceFilter
Description
A filter to be used against many BlockchainAddressSource object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - BlockchainAddressSourceFilter
|
Every related BlockchainAddressSource matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - BlockchainAddressSourceFilter
|
Some related BlockchainAddressSource matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - BlockchainAddressSourceFilter
|
No related BlockchainAddressSource matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": BlockchainAddressSourceFilter,
"some": BlockchainAddressSourceFilter,
"none": BlockchainAddressSourceFilter
}
BlockchainAddressToManyBlockchainRegistrationFilter
Description
A filter to be used against many BlockchainRegistration object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - BlockchainRegistrationFilter
|
Every related BlockchainRegistration matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - BlockchainRegistrationFilter
|
Some related BlockchainRegistration matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - BlockchainRegistrationFilter
|
No related BlockchainRegistration matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": BlockchainRegistrationFilter,
"some": BlockchainRegistrationFilter,
"none": BlockchainRegistrationFilter
}
BlockchainAddressToManyCapTableFilter
Description
A filter to be used against many CapTable object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - CapTableFilter
|
Every related CapTable matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - CapTableFilter
|
Some related CapTable matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - CapTableFilter
|
No related CapTable matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": CapTableFilter,
"some": CapTableFilter,
"none": CapTableFilter
}
BlockchainAddressToManyLedgerFilter
Description
A filter to be used against many Ledger object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - LedgerFilter
|
Every related Ledger matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - LedgerFilter
|
Some related Ledger matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - LedgerFilter
|
No related Ledger matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": LedgerFilter,
"some": LedgerFilter,
"none": LedgerFilter
}
BlockchainAddressToManyTaRequestFilter
Description
A filter to be used against many TaRequest object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - TaRequestFilter
|
Every related TaRequest matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - TaRequestFilter
|
Some related TaRequest matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - TaRequestFilter
|
No related TaRequest matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": TaRequestFilter,
"some": TaRequestFilter,
"none": TaRequestFilter
}
BlockchainAddressToManyWalletAssignmentFilter
Description
A filter to be used against many WalletAssignment object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - WalletAssignmentFilter
|
Every related WalletAssignment matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - WalletAssignmentFilter
|
Some related WalletAssignment matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - WalletAssignmentFilter
|
No related WalletAssignment matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": WalletAssignmentFilter,
"some": WalletAssignmentFilter,
"none": WalletAssignmentFilter
}
BlockchainAddressesConnection
Description
A connection to a list of BlockchainAddress values.
Fields
| Field Name | Description |
|---|---|
nodes - [BlockchainAddress]!
|
A list of BlockchainAddress objects. |
edges - [BlockchainAddressesEdge!]!
|
A list of edges which contains the BlockchainAddress and cursor to aid in pagination. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The count of all BlockchainAddress you could get from the connection. |
Example
{
"nodes": [BlockchainAddress],
"edges": [BlockchainAddressesEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
BlockchainAddressesEdge
Description
A BlockchainAddress edge in the connection.
Fields
| Field Name | Description |
|---|---|
cursor - Cursor
|
A cursor for use in pagination. |
node - BlockchainAddress
|
The BlockchainAddress at the end of the edge. |
Example
{
"cursor": Cursor,
"node": BlockchainAddress
}
BlockchainAddressesOrderBy
Description
Methods to use when ordering BlockchainAddress.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NATURAL"
BlockchainRegistration
Fields
| Field Name | Description |
|---|---|
nodeId - ID!
|
A globally unique identifier. Can be used in various places throughout the system to identify this single value. |
blockchainAddressId - UUID!
|
|
accountId - UUID!
|
|
usersAccountId - UUID
|
|
status - String!
|
|
chain - String!
|
|
method - String!
|
|
rawAddress - String
|
|
toAddress - String
|
|
amount - BigFloat
|
|
createdOn - Datetime!
|
|
startedOn - Datetime
|
|
completedOn - Datetime
|
|
nonce - String!
|
|
chainData - JSON
|
|
id - UUID!
|
|
blockchainAddressByBlockchainAddressId - BlockchainAddress
|
Reads a single BlockchainAddress that is related to this BlockchainRegistration. |
accountByAccountId - Account
|
Reads a single Account that is related to this BlockchainRegistration. |
usersAccountByUsersAccountId - UsersAccount
|
Reads a single UsersAccount that is related to this BlockchainRegistration. |
registrationStatusByStatus - RegistrationStatus
|
Reads a single RegistrationStatus that is related to this BlockchainRegistration. |
chainByChain - Chain
|
Reads a single Chain that is related to this BlockchainRegistration. |
registrationMethodByMethod - RegistrationMethod
|
Reads a single RegistrationMethod that is related to this BlockchainRegistration. |
Example
{
"nodeId": 4,
"blockchainAddressId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"usersAccountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"status": "xyz789",
"chain": "xyz789",
"method": "xyz789",
"rawAddress": "abc123",
"toAddress": "abc123",
"amount": BigFloat,
"createdOn": Datetime,
"startedOn": Datetime,
"completedOn": Datetime,
"nonce": "xyz789",
"chainData": {},
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"blockchainAddressByBlockchainAddressId": BlockchainAddress,
"accountByAccountId": Account,
"usersAccountByUsersAccountId": UsersAccount,
"registrationStatusByStatus": RegistrationStatus,
"chainByChain": Chain,
"registrationMethodByMethod": RegistrationMethod
}
BlockchainRegistrationCondition
Description
A condition to be used against BlockchainRegistration object types. All fields are tested for equality and combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
blockchainAddressId - UUID
|
Checks for equality with the object’s blockchainAddressId field. |
accountId - UUID
|
Checks for equality with the object’s accountId field. |
usersAccountId - UUID
|
Checks for equality with the object’s usersAccountId field. |
status - String
|
Checks for equality with the object’s status field. |
chain - String
|
Checks for equality with the object’s chain field. |
method - String
|
Checks for equality with the object’s method field. |
rawAddress - String
|
Checks for equality with the object’s rawAddress field. |
toAddress - String
|
Checks for equality with the object’s toAddress field. |
amount - BigFloat
|
Checks for equality with the object’s amount field. |
createdOn - Datetime
|
Checks for equality with the object’s createdOn field. |
startedOn - Datetime
|
Checks for equality with the object’s startedOn field. |
completedOn - Datetime
|
Checks for equality with the object’s completedOn field. |
nonce - String
|
Checks for equality with the object’s nonce field. |
chainData - JSON
|
Checks for equality with the object’s chainData field. |
id - UUID
|
Checks for equality with the object’s id field. |
Example
{
"blockchainAddressId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"usersAccountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"status": "xyz789",
"chain": "xyz789",
"method": "abc123",
"rawAddress": "abc123",
"toAddress": "xyz789",
"amount": BigFloat,
"createdOn": Datetime,
"startedOn": Datetime,
"completedOn": Datetime,
"nonce": "xyz789",
"chainData": {},
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
BlockchainRegistrationFilter
Description
A filter to be used against BlockchainRegistration object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
blockchainAddressId - UUIDFilter
|
Filter by the object’s blockchainAddressId field. |
accountId - UUIDFilter
|
Filter by the object’s accountId field. |
usersAccountId - UUIDFilter
|
Filter by the object’s usersAccountId field. |
status - StringFilter
|
Filter by the object’s status field. |
chain - StringFilter
|
Filter by the object’s chain field. |
method - StringFilter
|
Filter by the object’s method field. |
rawAddress - StringFilter
|
Filter by the object’s rawAddress field. |
toAddress - StringFilter
|
Filter by the object’s toAddress field. |
amount - BigFloatFilter
|
Filter by the object’s amount field. |
createdOn - DatetimeFilter
|
Filter by the object’s createdOn field. |
startedOn - DatetimeFilter
|
Filter by the object’s startedOn field. |
completedOn - DatetimeFilter
|
Filter by the object’s completedOn field. |
nonce - StringFilter
|
Filter by the object’s nonce field. |
chainData - JSONFilter
|
Filter by the object’s chainData field. |
id - UUIDFilter
|
Filter by the object’s id field. |
blockchainAddressByBlockchainAddressId - BlockchainAddressFilter
|
Filter by the object’s blockchainAddressByBlockchainAddressId relation. |
accountByAccountId - AccountFilter
|
Filter by the object’s accountByAccountId relation. |
usersAccountByUsersAccountId - UsersAccountFilter
|
Filter by the object’s usersAccountByUsersAccountId relation. |
usersAccountByUsersAccountIdExists - Boolean
|
A related usersAccountByUsersAccountId exists. |
registrationStatusByStatus - RegistrationStatusFilter
|
Filter by the object’s registrationStatusByStatus relation. |
chainByChain - ChainFilter
|
Filter by the object’s chainByChain relation. |
registrationMethodByMethod - RegistrationMethodFilter
|
Filter by the object’s registrationMethodByMethod relation. |
and - [BlockchainRegistrationFilter!]
|
Checks for all expressions in this list. |
or - [BlockchainRegistrationFilter!]
|
Checks for any expressions in this list. |
not - BlockchainRegistrationFilter
|
Negates the expression. |
Example
{
"blockchainAddressId": UUIDFilter,
"accountId": UUIDFilter,
"usersAccountId": UUIDFilter,
"status": StringFilter,
"chain": StringFilter,
"method": StringFilter,
"rawAddress": StringFilter,
"toAddress": StringFilter,
"amount": BigFloatFilter,
"createdOn": DatetimeFilter,
"startedOn": DatetimeFilter,
"completedOn": DatetimeFilter,
"nonce": StringFilter,
"chainData": JSONFilter,
"id": UUIDFilter,
"blockchainAddressByBlockchainAddressId": BlockchainAddressFilter,
"accountByAccountId": AccountFilter,
"usersAccountByUsersAccountId": UsersAccountFilter,
"usersAccountByUsersAccountIdExists": false,
"registrationStatusByStatus": RegistrationStatusFilter,
"chainByChain": ChainFilter,
"registrationMethodByMethod": RegistrationMethodFilter,
"and": [BlockchainRegistrationFilter],
"or": [BlockchainRegistrationFilter],
"not": BlockchainRegistrationFilter
}
BlockchainRegistrationPatch
Description
Represents an update to a BlockchainRegistration. Fields that are set will be updated.
Fields
| Input Field | Description |
|---|---|
blockchainAddressId - UUID
|
|
accountId - UUID
|
|
usersAccountId - UUID
|
|
status - String
|
|
chain - String
|
|
method - String
|
|
rawAddress - String
|
|
toAddress - String
|
|
amount - BigFloat
|
|
createdOn - Datetime
|
|
startedOn - Datetime
|
|
completedOn - Datetime
|
|
nonce - String
|
|
chainData - JSON
|
|
id - UUID
|
Example
{
"blockchainAddressId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"usersAccountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"status": "abc123",
"chain": "abc123",
"method": "xyz789",
"rawAddress": "xyz789",
"toAddress": "abc123",
"amount": BigFloat,
"createdOn": Datetime,
"startedOn": Datetime,
"completedOn": Datetime,
"nonce": "abc123",
"chainData": {},
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
BlockchainRegistrationsConnection
Description
A connection to a list of BlockchainRegistration values.
Fields
| Field Name | Description |
|---|---|
nodes - [BlockchainRegistration]!
|
A list of BlockchainRegistration objects. |
edges - [BlockchainRegistrationsEdge!]!
|
A list of edges which contains the BlockchainRegistration and cursor to aid in pagination. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The count of all BlockchainRegistration you could get from the connection. |
Example
{
"nodes": [BlockchainRegistration],
"edges": [BlockchainRegistrationsEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
BlockchainRegistrationsEdge
Description
A BlockchainRegistration edge in the connection.
Fields
| Field Name | Description |
|---|---|
cursor - Cursor
|
A cursor for use in pagination. |
node - BlockchainRegistration
|
The BlockchainRegistration at the end of the edge. |
Example
{
"cursor": Cursor,
"node": BlockchainRegistration
}
BlockchainRegistrationsOrderBy
Description
Methods to use when ordering BlockchainRegistration.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NATURAL"
Boolean
Description
The Boolean scalar type represents true or false.
BooleanFilter
Description
A filter to be used against Boolean fields. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
isNull - Boolean
|
Is null (if true is specified) or is not null (if false is specified). |
equalTo - Boolean
|
Equal to the specified value. |
notEqualTo - Boolean
|
Not equal to the specified value. |
distinctFrom - Boolean
|
Not equal to the specified value, treating null like an ordinary value. |
notDistinctFrom - Boolean
|
Equal to the specified value, treating null like an ordinary value. |
in - [Boolean!]
|
Included in the specified list. |
notIn - [Boolean!]
|
Not included in the specified list. |
lessThan - Boolean
|
Less than the specified value. |
lessThanOrEqualTo - Boolean
|
Less than or equal to the specified value. |
greaterThan - Boolean
|
Greater than the specified value. |
greaterThanOrEqualTo - Boolean
|
Greater than or equal to the specified value. |
Example
{
"isNull": true,
"equalTo": false,
"notEqualTo": true,
"distinctFrom": true,
"notDistinctFrom": false,
"in": [true],
"notIn": [true],
"lessThan": false,
"lessThanOrEqualTo": false,
"greaterThan": false,
"greaterThanOrEqualTo": false
}
BrokerAllocation
Fields
| Field Name | Description |
|---|---|
nodeId - ID!
|
A globally unique identifier. Can be used in various places throughout the system to identify this single value. |
brokerId - UUID!
|
|
status - String!
|
|
name - String!
|
|
roundId - UUID!
|
|
id - UUID!
|
|
accountByBrokerId - Account
|
Reads a single Account that is related to this BrokerAllocation. |
invitationStatusByStatus - InvitationStatus
|
Reads a single InvitationStatus that is related to this BrokerAllocation. |
roundByRoundId - Round
|
Reads a single Round that is related to this BrokerAllocation. |
managedUnits - BigFloat
|
Example
{
"nodeId": "4",
"brokerId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"status": "xyz789",
"name": "abc123",
"roundId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountByBrokerId": Account,
"invitationStatusByStatus": InvitationStatus,
"roundByRoundId": Round,
"managedUnits": BigFloat
}
BrokerAllocationCondition
Description
A condition to be used against BrokerAllocation object types. All fields are tested for equality and combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
brokerId - UUID
|
Checks for equality with the object’s brokerId field. |
status - String
|
Checks for equality with the object’s status field. |
name - String
|
Checks for equality with the object’s name field. |
roundId - UUID
|
Checks for equality with the object’s roundId field. |
id - UUID
|
Checks for equality with the object’s id field. |
Example
{
"brokerId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"status": "abc123",
"name": "xyz789",
"roundId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
BrokerAllocationFilter
Description
A filter to be used against BrokerAllocation object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
brokerId - UUIDFilter
|
Filter by the object’s brokerId field. |
status - StringFilter
|
Filter by the object’s status field. |
name - StringFilter
|
Filter by the object’s name field. |
roundId - UUIDFilter
|
Filter by the object’s roundId field. |
id - UUIDFilter
|
Filter by the object’s id field. |
managedUnits - BigFloatFilter
|
Filter by the object’s managedUnits field. |
accountByBrokerId - AccountFilter
|
Filter by the object’s accountByBrokerId relation. |
invitationStatusByStatus - InvitationStatusFilter
|
Filter by the object’s invitationStatusByStatus relation. |
roundByRoundId - RoundFilter
|
Filter by the object’s roundByRoundId relation. |
and - [BrokerAllocationFilter!]
|
Checks for all expressions in this list. |
or - [BrokerAllocationFilter!]
|
Checks for any expressions in this list. |
not - BrokerAllocationFilter
|
Negates the expression. |
Example
{
"brokerId": UUIDFilter,
"status": StringFilter,
"name": StringFilter,
"roundId": UUIDFilter,
"id": UUIDFilter,
"managedUnits": BigFloatFilter,
"accountByBrokerId": AccountFilter,
"invitationStatusByStatus": InvitationStatusFilter,
"roundByRoundId": RoundFilter,
"and": [BrokerAllocationFilter],
"or": [BrokerAllocationFilter],
"not": BrokerAllocationFilter
}
BrokerAllocationInput
Description
An input for mutations affecting BrokerAllocation
Example
{
"brokerId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"status": "abc123",
"name": "abc123",
"roundId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
BrokerAllocationPatch
Description
Represents an update to a BrokerAllocation. Fields that are set will be updated.
Example
{
"brokerId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"status": "xyz789",
"name": "xyz789",
"roundId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
BrokerAllocationsConnection
Description
A connection to a list of BrokerAllocation values.
Fields
| Field Name | Description |
|---|---|
nodes - [BrokerAllocation]!
|
A list of BrokerAllocation objects. |
edges - [BrokerAllocationsEdge!]!
|
A list of edges which contains the BrokerAllocation and cursor to aid in pagination. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The count of all BrokerAllocation you could get from the connection. |
Example
{
"nodes": [BrokerAllocation],
"edges": [BrokerAllocationsEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
BrokerAllocationsEdge
Description
A BrokerAllocation edge in the connection.
Fields
| Field Name | Description |
|---|---|
cursor - Cursor
|
A cursor for use in pagination. |
node - BrokerAllocation
|
The BrokerAllocation at the end of the edge. |
Example
{
"cursor": Cursor,
"node": BrokerAllocation
}
BrokerAllocationsOrderBy
Description
Methods to use when ordering BrokerAllocation.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NATURAL"
BulkDepositDepositInput
Fields
| Input Field | Description |
|---|---|
idempotencyId - UUID!
|
|
depositAddressId - UUID!
|
|
externalInvestorId - String!
|
|
investorId - UUID!
|
|
date - Date!
|
|
holdings - [DepositHoldingInput!]!
|
|
signature - DepositSignatureInput!
|
|
fee - DepositFeeInput
|
|
tags - [DepositTagInput!]
|
|
investorInformation - DepositAccountInput
|
Example
{
"idempotencyId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"depositAddressId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"externalInvestorId": "abc123",
"investorId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"date": "2007-12-03",
"holdings": [DepositHoldingInput],
"signature": DepositSignatureInput,
"fee": DepositFeeInput,
"tags": [DepositTagInput],
"investorInformation": DepositAccountInput
}
BulkDepositInput
Fields
| Input Field | Description |
|---|---|
securityId - UUID!
|
|
idempotencyId - UUID!
|
|
deposit - [BulkDepositDepositInput!]!
|
Example
{
"securityId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"idempotencyId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"deposit": [BulkDepositDepositInput]
}
CapTable
Fields
| Field Name | Description |
|---|---|
nodeId - ID!
|
A globally unique identifier. Can be used in various places throughout the system to identify this single value. |
blockchainAddressId - UUID!
|
|
tokenId - UUID!
|
|
amount - BigFloat!
|
|
id - UUID!
|
|
blockchainAddressByBlockchainAddressId - BlockchainAddress
|
Reads a single BlockchainAddress that is related to this CapTable. |
tokenByTokenId - Token
|
Reads a single Token that is related to this CapTable. |
Example
{
"nodeId": "4",
"blockchainAddressId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"tokenId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"amount": BigFloat,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"blockchainAddressByBlockchainAddressId": BlockchainAddress,
"tokenByTokenId": Token
}
CapTableCondition
Description
A condition to be used against CapTable object types. All fields are tested for equality and combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
blockchainAddressId - UUID
|
Checks for equality with the object’s blockchainAddressId field. |
tokenId - UUID
|
Checks for equality with the object’s tokenId field. |
amount - BigFloat
|
Checks for equality with the object’s amount field. |
id - UUID
|
Checks for equality with the object’s id field. |
Example
{
"blockchainAddressId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"tokenId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"amount": BigFloat,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
CapTableFilter
Description
A filter to be used against CapTable object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
blockchainAddressId - UUIDFilter
|
Filter by the object’s blockchainAddressId field. |
tokenId - UUIDFilter
|
Filter by the object’s tokenId field. |
amount - BigFloatFilter
|
Filter by the object’s amount field. |
id - UUIDFilter
|
Filter by the object’s id field. |
blockchainAddressByBlockchainAddressId - BlockchainAddressFilter
|
Filter by the object’s blockchainAddressByBlockchainAddressId relation. |
tokenByTokenId - TokenFilter
|
Filter by the object’s tokenByTokenId relation. |
and - [CapTableFilter!]
|
Checks for all expressions in this list. |
or - [CapTableFilter!]
|
Checks for any expressions in this list. |
not - CapTableFilter
|
Negates the expression. |
Example
{
"blockchainAddressId": UUIDFilter,
"tokenId": UUIDFilter,
"amount": BigFloatFilter,
"id": UUIDFilter,
"blockchainAddressByBlockchainAddressId": BlockchainAddressFilter,
"tokenByTokenId": TokenFilter,
"and": [CapTableFilter],
"or": [CapTableFilter],
"not": CapTableFilter
}
CapTablesConnection
Description
A connection to a list of CapTable values.
Fields
| Field Name | Description |
|---|---|
nodes - [CapTable]!
|
A list of CapTable objects. |
edges - [CapTablesEdge!]!
|
A list of edges which contains the CapTable and cursor to aid in pagination. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The count of all CapTable you could get from the connection. |
Example
{
"nodes": [CapTable],
"edges": [CapTablesEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
CapTablesEdge
CapTablesOrderBy
Description
Methods to use when ordering CapTable.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NATURAL"
CapitalDeployment
Fields
| Field Name | Description |
|---|---|
nodeId - ID!
|
A globally unique identifier. Can be used in various places throughout the system to identify this single value. |
id - UUID!
|
|
note - String!
|
|
amount - BigFloat!
|
|
paidOn - Datetime!
|
|
currency - UUID!
|
|
createdOn - Datetime
|
|
transactionGroupId - UUID!
|
|
roundId - UUID!
|
|
currencyByCurrency - Currency
|
Reads a single Currency that is related to this CapitalDeployment. |
roundByRoundId - Round
|
Reads a single Round that is related to this CapitalDeployment. |
Example
{
"nodeId": 4,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"note": "xyz789",
"amount": BigFloat,
"paidOn": Datetime,
"currency": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"createdOn": Datetime,
"transactionGroupId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"roundId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"currencyByCurrency": Currency,
"roundByRoundId": Round
}
CapitalDeploymentCondition
Description
A condition to be used against CapitalDeployment object types. All fields are tested for equality and combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
id - UUID
|
Checks for equality with the object’s id field. |
note - String
|
Checks for equality with the object’s note field. |
amount - BigFloat
|
Checks for equality with the object’s amount field. |
paidOn - Datetime
|
Checks for equality with the object’s paidOn field. |
currency - UUID
|
Checks for equality with the object’s currency field. |
createdOn - Datetime
|
Checks for equality with the object’s createdOn field. |
transactionGroupId - UUID
|
Checks for equality with the object’s transactionGroupId field. |
roundId - UUID
|
Checks for equality with the object’s roundId field. |
Example
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"note": "xyz789",
"amount": BigFloat,
"paidOn": Datetime,
"currency": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"createdOn": Datetime,
"transactionGroupId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"roundId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
CapitalDeploymentFilter
Description
A filter to be used against CapitalDeployment object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
id - UUIDFilter
|
Filter by the object’s id field. |
note - StringFilter
|
Filter by the object’s note field. |
amount - BigFloatFilter
|
Filter by the object’s amount field. |
paidOn - DatetimeFilter
|
Filter by the object’s paidOn field. |
currency - UUIDFilter
|
Filter by the object’s currency field. |
createdOn - DatetimeFilter
|
Filter by the object’s createdOn field. |
transactionGroupId - UUIDFilter
|
Filter by the object’s transactionGroupId field. |
roundId - UUIDFilter
|
Filter by the object’s roundId field. |
currencyByCurrency - CurrencyFilter
|
Filter by the object’s currencyByCurrency relation. |
roundByRoundId - RoundFilter
|
Filter by the object’s roundByRoundId relation. |
and - [CapitalDeploymentFilter!]
|
Checks for all expressions in this list. |
or - [CapitalDeploymentFilter!]
|
Checks for any expressions in this list. |
not - CapitalDeploymentFilter
|
Negates the expression. |
Example
{
"id": UUIDFilter,
"note": StringFilter,
"amount": BigFloatFilter,
"paidOn": DatetimeFilter,
"currency": UUIDFilter,
"createdOn": DatetimeFilter,
"transactionGroupId": UUIDFilter,
"roundId": UUIDFilter,
"currencyByCurrency": CurrencyFilter,
"roundByRoundId": RoundFilter,
"and": [CapitalDeploymentFilter],
"or": [CapitalDeploymentFilter],
"not": CapitalDeploymentFilter
}
CapitalDeploymentInput
Description
An input for mutations affecting CapitalDeployment
Example
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"note": "xyz789",
"amount": BigFloat,
"paidOn": Datetime,
"currency": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"createdOn": Datetime,
"transactionGroupId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"roundId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
CapitalDeploymentPatch
Description
Represents an update to a CapitalDeployment. Fields that are set will be updated.
Example
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"note": "abc123",
"amount": BigFloat,
"paidOn": Datetime,
"currency": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"createdOn": Datetime,
"transactionGroupId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"roundId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
CapitalDeploymentsConnection
Description
A connection to a list of CapitalDeployment values.
Fields
| Field Name | Description |
|---|---|
nodes - [CapitalDeployment]!
|
A list of CapitalDeployment objects. |
edges - [CapitalDeploymentsEdge!]!
|
A list of edges which contains the CapitalDeployment and cursor to aid in pagination. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The count of all CapitalDeployment you could get from the connection. |
Example
{
"nodes": [CapitalDeployment],
"edges": [CapitalDeploymentsEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
CapitalDeploymentsEdge
Description
A CapitalDeployment edge in the connection.
Fields
| Field Name | Description |
|---|---|
cursor - Cursor
|
A cursor for use in pagination. |
node - CapitalDeployment
|
The CapitalDeployment at the end of the edge. |
Example
{
"cursor": Cursor,
"node": CapitalDeployment
}
CapitalDeploymentsOrderBy
Description
Methods to use when ordering CapitalDeployment.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NATURAL"
Chain
Fields
| Field Name | Description |
|---|---|
nodeId - ID!
|
A globally unique identifier. Can be used in various places throughout the system to identify this single value. |
chain - String!
|
|
integrationsByChain - IntegrationsConnection!
|
Reads and enables pagination through a set of Integration. |
Arguments
|
|
blockchainAddressesByChain - BlockchainAddressesConnection!
|
Reads and enables pagination through a set of BlockchainAddress. |
Arguments
|
|
blockchainRegistrationsByChain - BlockchainRegistrationsConnection!
|
Reads and enables pagination through a set of BlockchainRegistration. |
Arguments
|
|
contractsByChain - ContractsConnection!
|
Reads and enables pagination through a set of Contract. |
Arguments
|
|
Example
{
"nodeId": "4",
"chain": "abc123",
"integrationsByChain": IntegrationsConnection,
"blockchainAddressesByChain": BlockchainAddressesConnection,
"blockchainRegistrationsByChain": BlockchainRegistrationsConnection,
"contractsByChain": ContractsConnection
}
ChainCondition
Description
A condition to be used against Chain object types. All fields are tested for equality and combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
chain - String
|
Checks for equality with the object’s chain field. |
Example
{"chain": "xyz789"}
ChainFilter
Description
A filter to be used against Chain object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
chain - StringFilter
|
Filter by the object’s chain field. |
integrationsByChain - ChainToManyIntegrationFilter
|
Filter by the object’s integrationsByChain relation. |
integrationsByChainExist - Boolean
|
Some related integrationsByChain exist. |
blockchainAddressesByChain - ChainToManyBlockchainAddressFilter
|
Filter by the object’s blockchainAddressesByChain relation. |
blockchainAddressesByChainExist - Boolean
|
Some related blockchainAddressesByChain exist. |
blockchainRegistrationsByChain - ChainToManyBlockchainRegistrationFilter
|
Filter by the object’s blockchainRegistrationsByChain relation. |
blockchainRegistrationsByChainExist - Boolean
|
Some related blockchainRegistrationsByChain exist. |
contractsByChain - ChainToManyContractFilter
|
Filter by the object’s contractsByChain relation. |
contractsByChainExist - Boolean
|
Some related contractsByChain exist. |
and - [ChainFilter!]
|
Checks for all expressions in this list. |
or - [ChainFilter!]
|
Checks for any expressions in this list. |
not - ChainFilter
|
Negates the expression. |
Example
{
"chain": StringFilter,
"integrationsByChain": ChainToManyIntegrationFilter,
"integrationsByChainExist": true,
"blockchainAddressesByChain": ChainToManyBlockchainAddressFilter,
"blockchainAddressesByChainExist": false,
"blockchainRegistrationsByChain": ChainToManyBlockchainRegistrationFilter,
"blockchainRegistrationsByChainExist": false,
"contractsByChain": ChainToManyContractFilter,
"contractsByChainExist": false,
"and": [ChainFilter],
"or": [ChainFilter],
"not": ChainFilter
}
ChainToManyBlockchainAddressFilter
Description
A filter to be used against many BlockchainAddress object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - BlockchainAddressFilter
|
Every related BlockchainAddress matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - BlockchainAddressFilter
|
Some related BlockchainAddress matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - BlockchainAddressFilter
|
No related BlockchainAddress matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": BlockchainAddressFilter,
"some": BlockchainAddressFilter,
"none": BlockchainAddressFilter
}
ChainToManyBlockchainRegistrationFilter
Description
A filter to be used against many BlockchainRegistration object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - BlockchainRegistrationFilter
|
Every related BlockchainRegistration matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - BlockchainRegistrationFilter
|
Some related BlockchainRegistration matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - BlockchainRegistrationFilter
|
No related BlockchainRegistration matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": BlockchainRegistrationFilter,
"some": BlockchainRegistrationFilter,
"none": BlockchainRegistrationFilter
}
ChainToManyContractFilter
Description
A filter to be used against many Contract object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - ContractFilter
|
Every related Contract matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - ContractFilter
|
Some related Contract matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - ContractFilter
|
No related Contract matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": ContractFilter,
"some": ContractFilter,
"none": ContractFilter
}
ChainToManyIntegrationFilter
Description
A filter to be used against many Integration object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - IntegrationFilter
|
Every related Integration matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - IntegrationFilter
|
Some related Integration matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - IntegrationFilter
|
No related Integration matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": IntegrationFilter,
"some": IntegrationFilter,
"none": IntegrationFilter
}
ChainsConnection
Description
A connection to a list of Chain values.
Fields
| Field Name | Description |
|---|---|
nodes - [Chain]!
|
A list of Chain objects. |
edges - [ChainsEdge!]!
|
A list of edges which contains the Chain and cursor to aid in pagination. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The count of all Chain you could get from the connection. |
Example
{
"nodes": [Chain],
"edges": [ChainsEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
ChainsEdge
ChainsOrderBy
Description
Methods to use when ordering Chain.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NATURAL"
ChangeAllocationArchivesInput
Description
All input for the changeAllocationArchives mutation.
Example
{
"clientMutationId": "abc123",
"archiveId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"_order": 123,
"_archive": false
}
ChangeAllocationArchivesPayload
Description
The output of our changeAllocationArchives mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
The exact same clientMutationId that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations. |
allocationArchives - [AllocationArchive]
|
|
query - Query
|
Our root query field type. Allows us to run any query from our mutation payload. |
Example
{
"clientMutationId": "abc123",
"allocationArchives": [AllocationArchive],
"query": Query
}
ChangeAssetArchivesInput
Description
All input for the changeAssetArchives mutation.
Example
{
"clientMutationId": "xyz789",
"archiveId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"_order": 123,
"_archive": false
}
ChangeAssetArchivesPayload
Description
The output of our changeAssetArchives mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
The exact same clientMutationId that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations. |
assetArchives - [AssetArchive]
|
|
query - Query
|
Our root query field type. Allows us to run any query from our mutation payload. |
Example
{
"clientMutationId": "abc123",
"assetArchives": [AssetArchive],
"query": Query
}
CompaniesConnection
Description
A connection to a list of Company values.
Fields
| Field Name | Description |
|---|---|
nodes - [Company]!
|
A list of Company objects. |
edges - [CompaniesEdge!]!
|
A list of edges which contains the Company and cursor to aid in pagination. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The count of all Company you could get from the connection. |
Example
{
"nodes": [Company],
"edges": [CompaniesEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
CompaniesEdge
CompaniesOrderBy
Description
Methods to use when ordering Company.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NATURAL"
Company
Fields
| Field Name | Description |
|---|---|
nodeId - ID!
|
A globally unique identifier. Can be used in various places throughout the system to identify this single value. |
id - UUID!
|
|
accountsByCompany - AccountsConnection!
|
Reads and enables pagination through a set of Account. |
Arguments
|
|
Example
{
"nodeId": "4",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountsByCompany": AccountsConnection
}
CompanyCondition
Description
A condition to be used against Company object types. All fields are tested for equality and combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
id - UUID
|
Checks for equality with the object’s id field. |
Example
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
CompanyFilter
Description
A filter to be used against Company object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
id - UUIDFilter
|
Filter by the object’s id field. |
accountsByCompany - CompanyToManyAccountFilter
|
Filter by the object’s accountsByCompany relation. |
accountsByCompanyExist - Boolean
|
Some related accountsByCompany exist. |
and - [CompanyFilter!]
|
Checks for all expressions in this list. |
or - [CompanyFilter!]
|
Checks for any expressions in this list. |
not - CompanyFilter
|
Negates the expression. |
Example
{
"id": UUIDFilter,
"accountsByCompany": CompanyToManyAccountFilter,
"accountsByCompanyExist": true,
"and": [CompanyFilter],
"or": [CompanyFilter],
"not": CompanyFilter
}
CompanyToManyAccountFilter
Description
A filter to be used against many Account object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - AccountFilter
|
Every related Account matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - AccountFilter
|
Some related Account matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - AccountFilter
|
No related Account matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": AccountFilter,
"some": AccountFilter,
"none": AccountFilter
}
CompleteAccountIntegrationStepInput
Description
All input for the completeAccountIntegrationStep mutation.
Example
{
"clientMutationId": "xyz789",
"accountIntegrationStepId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"stepId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"blob": {}
}
CompleteAccountIntegrationStepPayload
Description
The output of our completeAccountIntegrationStep mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
The exact same clientMutationId that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations. |
accountIntegration - AccountIntegration
|
|
query - Query
|
Our root query field type. Allows us to run any query from our mutation payload. |
integrationByIntegrationId - Integration
|
Reads a single Integration that is related to this AccountIntegration. |
accountByAccountId - Account
|
Reads a single Account that is related to this AccountIntegration. |
stepByStepId - Step
|
Reads a single Step that is related to this AccountIntegration. |
accountIntegrationEdge - AccountIntegrationsEdge
|
An edge for our AccountIntegration. May be used by Relay 1. |
Arguments
|
|
Example
{
"clientMutationId": "abc123",
"accountIntegration": AccountIntegration,
"query": Query,
"integrationByIntegrationId": Integration,
"accountByAccountId": Account,
"stepByStepId": Step,
"accountIntegrationEdge": AccountIntegrationsEdge
}
CompleteDistributionStepInput
Description
All input for the completeDistributionStep mutation.
Example
{
"clientMutationId": "abc123",
"distributionStepId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"stepId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"blob": {}
}
CompleteDistributionStepPayload
Description
The output of our completeDistributionStep mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
The exact same clientMutationId that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations. |
distribution - Distribution
|
|
query - Query
|
Our root query field type. Allows us to run any query from our mutation payload. |
allocationByAllocationId - Allocation
|
Reads a single Allocation that is related to this Distribution. |
accountByInvestorId - Account
|
Reads a single Account that is related to this Distribution. |
distributionStatusByStatus - DistributionStatus
|
Reads a single DistributionStatus that is related to this Distribution. |
stepByStepId - Step
|
Reads a single Step that is related to this Distribution. |
distributionEdge - DistributionsEdge
|
An edge for our Distribution. May be used by Relay 1. |
Arguments
|
|
Example
{
"clientMutationId": "abc123",
"distribution": Distribution,
"query": Query,
"allocationByAllocationId": Allocation,
"accountByInvestorId": Account,
"distributionStatusByStatus": DistributionStatus,
"stepByStepId": Step,
"distributionEdge": DistributionsEdge
}
CompleteStepInput
Description
All input for the completeStep mutation.
Example
{
"clientMutationId": "xyz789",
"_stepId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"blob": {}
}
CompleteStepPayload
Description
The output of our completeStep mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
The exact same clientMutationId that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations. |
step - Step
|
|
query - Query
|
Our root query field type. Allows us to run any query from our mutation payload. |
accountByOwnedBy - Account
|
Reads a single Account that is related to this Step. |
accountByExecuteBy - Account
|
Reads a single Account that is related to this Step. |
stepStatusByStatus - StepStatus
|
Reads a single StepStatus that is related to this Step. |
stepTypeByType - StepType
|
Reads a single StepType that is related to this Step. |
stepEdge - StepsEdge
|
An edge for our Step. May be used by Relay 1. |
Arguments
|
|
Example
{
"clientMutationId": "abc123",
"step": Step,
"query": Query,
"accountByOwnedBy": Account,
"accountByExecuteBy": Account,
"stepStatusByStatus": StepStatus,
"stepTypeByType": StepType,
"stepEdge": StepsEdge
}
Contract
Fields
| Field Name | Description |
|---|---|
nodeId - ID!
|
A globally unique identifier. Can be used in various places throughout the system to identify this single value. |
tokenId - UUID!
|
|
chain - String!
|
|
status - String!
|
|
contractAddress - String!
|
|
custodianId - UUID
|
|
issuancePlatformId - UUID
|
|
id - UUID!
|
|
tokenByTokenId - Token
|
Reads a single Token that is related to this Contract. |
chainByChain - Chain
|
Reads a single Chain that is related to this Contract. |
contractStatusByStatus - ContractStatus
|
Reads a single ContractStatus that is related to this Contract. |
integrationByCustodianId - Integration
|
Reads a single Integration that is related to this Contract. |
integrationByIssuancePlatformId - Integration
|
Reads a single Integration that is related to this Contract. |
Example
{
"nodeId": "4",
"tokenId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"chain": "abc123",
"status": "abc123",
"contractAddress": "xyz789",
"custodianId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"issuancePlatformId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"tokenByTokenId": Token,
"chainByChain": Chain,
"contractStatusByStatus": ContractStatus,
"integrationByCustodianId": Integration,
"integrationByIssuancePlatformId": Integration
}
ContractCondition
Description
A condition to be used against Contract object types. All fields are tested for equality and combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
tokenId - UUID
|
Checks for equality with the object’s tokenId field. |
chain - String
|
Checks for equality with the object’s chain field. |
status - String
|
Checks for equality with the object’s status field. |
contractAddress - String
|
Checks for equality with the object’s contractAddress field. |
custodianId - UUID
|
Checks for equality with the object’s custodianId field. |
issuancePlatformId - UUID
|
Checks for equality with the object’s issuancePlatformId field. |
id - UUID
|
Checks for equality with the object’s id field. |
Example
{
"tokenId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"chain": "abc123",
"status": "abc123",
"contractAddress": "abc123",
"custodianId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"issuancePlatformId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
ContractFilter
Description
A filter to be used against Contract object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
tokenId - UUIDFilter
|
Filter by the object’s tokenId field. |
chain - StringFilter
|
Filter by the object’s chain field. |
status - StringFilter
|
Filter by the object’s status field. |
contractAddress - StringFilter
|
Filter by the object’s contractAddress field. |
custodianId - UUIDFilter
|
Filter by the object’s custodianId field. |
issuancePlatformId - UUIDFilter
|
Filter by the object’s issuancePlatformId field. |
id - UUIDFilter
|
Filter by the object’s id field. |
tokenByTokenId - TokenFilter
|
Filter by the object’s tokenByTokenId relation. |
chainByChain - ChainFilter
|
Filter by the object’s chainByChain relation. |
contractStatusByStatus - ContractStatusFilter
|
Filter by the object’s contractStatusByStatus relation. |
integrationByCustodianId - IntegrationFilter
|
Filter by the object’s integrationByCustodianId relation. |
integrationByCustodianIdExists - Boolean
|
A related integrationByCustodianId exists. |
integrationByIssuancePlatformId - IntegrationFilter
|
Filter by the object’s integrationByIssuancePlatformId relation. |
integrationByIssuancePlatformIdExists - Boolean
|
A related integrationByIssuancePlatformId exists. |
and - [ContractFilter!]
|
Checks for all expressions in this list. |
or - [ContractFilter!]
|
Checks for any expressions in this list. |
not - ContractFilter
|
Negates the expression. |
Example
{
"tokenId": UUIDFilter,
"chain": StringFilter,
"status": StringFilter,
"contractAddress": StringFilter,
"custodianId": UUIDFilter,
"issuancePlatformId": UUIDFilter,
"id": UUIDFilter,
"tokenByTokenId": TokenFilter,
"chainByChain": ChainFilter,
"contractStatusByStatus": ContractStatusFilter,
"integrationByCustodianId": IntegrationFilter,
"integrationByCustodianIdExists": true,
"integrationByIssuancePlatformId": IntegrationFilter,
"integrationByIssuancePlatformIdExists": true,
"and": [ContractFilter],
"or": [ContractFilter],
"not": ContractFilter
}
ContractStatus
Fields
| Field Name | Description |
|---|---|
nodeId - ID!
|
A globally unique identifier. Can be used in various places throughout the system to identify this single value. |
status - String!
|
|
contractsByStatus - ContractsConnection!
|
Reads and enables pagination through a set of Contract. |
Arguments
|
|
Example
{
"nodeId": 4,
"status": "abc123",
"contractsByStatus": ContractsConnection
}
ContractStatusCondition
Description
A condition to be used against ContractStatus object types. All fields are tested for equality and combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
status - String
|
Checks for equality with the object’s status field. |
Example
{"status": "xyz789"}
ContractStatusFilter
Description
A filter to be used against ContractStatus object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
status - StringFilter
|
Filter by the object’s status field. |
contractsByStatus - ContractStatusToManyContractFilter
|
Filter by the object’s contractsByStatus relation. |
contractsByStatusExist - Boolean
|
Some related contractsByStatus exist. |
and - [ContractStatusFilter!]
|
Checks for all expressions in this list. |
or - [ContractStatusFilter!]
|
Checks for any expressions in this list. |
not - ContractStatusFilter
|
Negates the expression. |
Example
{
"status": StringFilter,
"contractsByStatus": ContractStatusToManyContractFilter,
"contractsByStatusExist": false,
"and": [ContractStatusFilter],
"or": [ContractStatusFilter],
"not": ContractStatusFilter
}
ContractStatusToManyContractFilter
Description
A filter to be used against many Contract object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - ContractFilter
|
Every related Contract matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - ContractFilter
|
Some related Contract matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - ContractFilter
|
No related Contract matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": ContractFilter,
"some": ContractFilter,
"none": ContractFilter
}
ContractStatusesConnection
Description
A connection to a list of ContractStatus values.
Fields
| Field Name | Description |
|---|---|
nodes - [ContractStatus]!
|
A list of ContractStatus objects. |
edges - [ContractStatusesEdge!]!
|
A list of edges which contains the ContractStatus and cursor to aid in pagination. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The count of all ContractStatus you could get from the connection. |
Example
{
"nodes": [ContractStatus],
"edges": [ContractStatusesEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
ContractStatusesEdge
Description
A ContractStatus edge in the connection.
Fields
| Field Name | Description |
|---|---|
cursor - Cursor
|
A cursor for use in pagination. |
node - ContractStatus
|
The ContractStatus at the end of the edge. |
Example
{
"cursor": Cursor,
"node": ContractStatus
}
ContractStatusesOrderBy
Description
Methods to use when ordering ContractStatus.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NATURAL"
ContractsConnection
Description
A connection to a list of Contract values.
Fields
| Field Name | Description |
|---|---|
nodes - [Contract]!
|
A list of Contract objects. |
edges - [ContractsEdge!]!
|
A list of edges which contains the Contract and cursor to aid in pagination. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The count of all Contract you could get from the connection. |
Example
{
"nodes": [Contract],
"edges": [ContractsEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
ContractsEdge
ContractsOrderBy
Description
Methods to use when ordering Contract.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NATURAL"
CountriesConnection
Description
A connection to a list of Country values.
Fields
| Field Name | Description |
|---|---|
nodes - [Country]!
|
A list of Country objects. |
edges - [CountriesEdge!]!
|
A list of edges which contains the Country and cursor to aid in pagination. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The count of all Country you could get from the connection. |
Example
{
"nodes": [Country],
"edges": [CountriesEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
CountriesEdge
CountriesOrderBy
Description
Methods to use when ordering Country.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NATURAL"
Country
Fields
| Field Name | Description |
|---|---|
nodeId - ID!
|
A globally unique identifier. Can be used in various places throughout the system to identify this single value. |
name - String!
|
|
alpha2 - String!
|
|
alpha3 - String!
|
|
num - String!
|
|
id - UUID!
|
|
accountsByJurisdiction - AccountsConnection!
|
Reads and enables pagination through a set of Account. |
Arguments
|
|
addressesByCountry - AddressesConnection!
|
Reads and enables pagination through a set of Address. |
Arguments
|
|
customersByJurisdiction - CustomersConnection!
|
Reads and enables pagination through a set of Customer. |
Arguments
|
|
taxRegionsByCountryId - TaxRegionsConnection!
|
Reads and enables pagination through a set of TaxRegion. |
Arguments
|
|
countryProvincesByCountryId - CountryProvincesConnection!
|
Reads and enables pagination through a set of CountryProvince. |
Arguments
|
|
Example
{
"nodeId": 4,
"name": "abc123",
"alpha2": "abc123",
"alpha3": "xyz789",
"num": "abc123",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountsByJurisdiction": AccountsConnection,
"addressesByCountry": AddressesConnection,
"customersByJurisdiction": CustomersConnection,
"taxRegionsByCountryId": TaxRegionsConnection,
"countryProvincesByCountryId": CountryProvincesConnection
}
CountryCondition
Description
A condition to be used against Country object types. All fields are tested for equality and combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
name - String
|
Checks for equality with the object’s name field. |
alpha2 - String
|
Checks for equality with the object’s alpha2 field. |
alpha3 - String
|
Checks for equality with the object’s alpha3 field. |
num - String
|
Checks for equality with the object’s num field. |
id - UUID
|
Checks for equality with the object’s id field. |
Example
{
"name": "abc123",
"alpha2": "xyz789",
"alpha3": "xyz789",
"num": "xyz789",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
CountryFilter
Description
A filter to be used against Country object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
name - StringFilter
|
Filter by the object’s name field. |
alpha2 - StringFilter
|
Filter by the object’s alpha2 field. |
alpha3 - StringFilter
|
Filter by the object’s alpha3 field. |
num - StringFilter
|
Filter by the object’s num field. |
id - UUIDFilter
|
Filter by the object’s id field. |
accountsByJurisdiction - CountryToManyAccountFilter
|
Filter by the object’s accountsByJurisdiction relation. |
accountsByJurisdictionExist - Boolean
|
Some related accountsByJurisdiction exist. |
addressesByCountry - CountryToManyAddressFilter
|
Filter by the object’s addressesByCountry relation. |
addressesByCountryExist - Boolean
|
Some related addressesByCountry exist. |
customersByJurisdiction - CountryToManyCustomerFilter
|
Filter by the object’s customersByJurisdiction relation. |
customersByJurisdictionExist - Boolean
|
Some related customersByJurisdiction exist. |
taxRegionsByCountryId - CountryToManyTaxRegionFilter
|
Filter by the object’s taxRegionsByCountryId relation. |
taxRegionsByCountryIdExist - Boolean
|
Some related taxRegionsByCountryId exist. |
countryProvincesByCountryId - CountryToManyCountryProvinceFilter
|
Filter by the object’s countryProvincesByCountryId relation. |
countryProvincesByCountryIdExist - Boolean
|
Some related countryProvincesByCountryId exist. |
and - [CountryFilter!]
|
Checks for all expressions in this list. |
or - [CountryFilter!]
|
Checks for any expressions in this list. |
not - CountryFilter
|
Negates the expression. |
Example
{
"name": StringFilter,
"alpha2": StringFilter,
"alpha3": StringFilter,
"num": StringFilter,
"id": UUIDFilter,
"accountsByJurisdiction": CountryToManyAccountFilter,
"accountsByJurisdictionExist": false,
"addressesByCountry": CountryToManyAddressFilter,
"addressesByCountryExist": false,
"customersByJurisdiction": CountryToManyCustomerFilter,
"customersByJurisdictionExist": true,
"taxRegionsByCountryId": CountryToManyTaxRegionFilter,
"taxRegionsByCountryIdExist": false,
"countryProvincesByCountryId": CountryToManyCountryProvinceFilter,
"countryProvincesByCountryIdExist": true,
"and": [CountryFilter],
"or": [CountryFilter],
"not": CountryFilter
}
CountryProvince
Fields
| Field Name | Description |
|---|---|
nodeId - ID!
|
A globally unique identifier. Can be used in various places throughout the system to identify this single value. |
id - UUID!
|
|
countryId - UUID!
|
|
name - String!
|
|
code - String!
|
|
countryByCountryId - Country
|
Reads a single Country that is related to this CountryProvince. |
Example
{
"nodeId": "4",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"countryId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"name": "abc123",
"code": "xyz789",
"countryByCountryId": Country
}
CountryProvinceCondition
Description
A condition to be used against CountryProvince object types. All fields are tested for equality and combined with a logical ‘and.’
Example
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"countryId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"name": "abc123",
"code": "xyz789"
}
CountryProvinceFilter
Description
A filter to be used against CountryProvince object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
id - UUIDFilter
|
Filter by the object’s id field. |
countryId - UUIDFilter
|
Filter by the object’s countryId field. |
name - StringFilter
|
Filter by the object’s name field. |
code - StringFilter
|
Filter by the object’s code field. |
countryByCountryId - CountryFilter
|
Filter by the object’s countryByCountryId relation. |
and - [CountryProvinceFilter!]
|
Checks for all expressions in this list. |
or - [CountryProvinceFilter!]
|
Checks for any expressions in this list. |
not - CountryProvinceFilter
|
Negates the expression. |
Example
{
"id": UUIDFilter,
"countryId": UUIDFilter,
"name": StringFilter,
"code": StringFilter,
"countryByCountryId": CountryFilter,
"and": [CountryProvinceFilter],
"or": [CountryProvinceFilter],
"not": CountryProvinceFilter
}
CountryProvincesConnection
Description
A connection to a list of CountryProvince values.
Fields
| Field Name | Description |
|---|---|
nodes - [CountryProvince]!
|
A list of CountryProvince objects. |
edges - [CountryProvincesEdge!]!
|
A list of edges which contains the CountryProvince and cursor to aid in pagination. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The count of all CountryProvince you could get from the connection. |
Example
{
"nodes": [CountryProvince],
"edges": [CountryProvincesEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
CountryProvincesEdge
Description
A CountryProvince edge in the connection.
Fields
| Field Name | Description |
|---|---|
cursor - Cursor
|
A cursor for use in pagination. |
node - CountryProvince
|
The CountryProvince at the end of the edge. |
Example
{
"cursor": Cursor,
"node": CountryProvince
}
CountryProvincesOrderBy
Description
Methods to use when ordering CountryProvince.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NATURAL"
CountryToManyAccountFilter
Description
A filter to be used against many Account object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - AccountFilter
|
Every related Account matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - AccountFilter
|
Some related Account matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - AccountFilter
|
No related Account matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": AccountFilter,
"some": AccountFilter,
"none": AccountFilter
}
CountryToManyAddressFilter
Description
A filter to be used against many Address object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - AddressFilter
|
Every related Address matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - AddressFilter
|
Some related Address matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - AddressFilter
|
No related Address matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": AddressFilter,
"some": AddressFilter,
"none": AddressFilter
}
CountryToManyCountryProvinceFilter
Description
A filter to be used against many CountryProvince object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - CountryProvinceFilter
|
Every related CountryProvince matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - CountryProvinceFilter
|
Some related CountryProvince matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - CountryProvinceFilter
|
No related CountryProvince matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": CountryProvinceFilter,
"some": CountryProvinceFilter,
"none": CountryProvinceFilter
}
CountryToManyCustomerFilter
Description
A filter to be used against many Customer object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - CustomerFilter
|
Every related Customer matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - CustomerFilter
|
Some related Customer matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - CustomerFilter
|
No related Customer matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": CustomerFilter,
"some": CustomerFilter,
"none": CustomerFilter
}
CountryToManyTaxRegionFilter
Description
A filter to be used against many TaxRegion object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - TaxRegionFilter
|
Every related TaxRegion matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - TaxRegionFilter
|
Some related TaxRegion matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - TaxRegionFilter
|
No related TaxRegion matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": TaxRegionFilter,
"some": TaxRegionFilter,
"none": TaxRegionFilter
}
CreateAccountIntegrationInput
Description
All input for the create AccountIntegration mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
accountIntegration - AccountIntegrationInput!
|
The AccountIntegration to be created by this mutation. |
Example
{
"clientMutationId": "abc123",
"accountIntegration": AccountIntegrationInput
}
CreateAccountIntegrationPayload
Description
The output of our create AccountIntegration mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
The exact same clientMutationId that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations. |
accountIntegration - AccountIntegration
|
The AccountIntegration that was created by this mutation. |
query - Query
|
Our root query field type. Allows us to run any query from our mutation payload. |
integrationByIntegrationId - Integration
|
Reads a single Integration that is related to this AccountIntegration. |
accountByAccountId - Account
|
Reads a single Account that is related to this AccountIntegration. |
stepByStepId - Step
|
Reads a single Step that is related to this AccountIntegration. |
accountIntegrationEdge - AccountIntegrationsEdge
|
An edge for our AccountIntegration. May be used by Relay 1. |
Arguments
|
|
Example
{
"clientMutationId": "abc123",
"accountIntegration": AccountIntegration,
"query": Query,
"integrationByIntegrationId": Integration,
"accountByAccountId": Account,
"stepByStepId": Step,
"accountIntegrationEdge": AccountIntegrationsEdge
}
CreateAccountPhoneNumberInput
Description
All input for the create AccountPhoneNumber mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
accountPhoneNumber - AccountPhoneNumberInput!
|
The AccountPhoneNumber to be created by this mutation. |
Example
{
"clientMutationId": "abc123",
"accountPhoneNumber": AccountPhoneNumberInput
}
CreateAccountPhoneNumberPayload
Description
The output of our create AccountPhoneNumber mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
The exact same clientMutationId that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations. |
accountPhoneNumber - AccountPhoneNumber
|
The AccountPhoneNumber that was created by this mutation. |
query - Query
|
Our root query field type. Allows us to run any query from our mutation payload. |
accountByAccountId - Account
|
Reads a single Account that is related to this AccountPhoneNumber. |
phoneNumberTypeByType - PhoneNumberType
|
Reads a single PhoneNumberType that is related to this AccountPhoneNumber. |
accountPhoneNumberEdge - AccountPhoneNumbersEdge
|
An edge for our AccountPhoneNumber. May be used by Relay 1. |
Arguments
|
|
Example
{
"clientMutationId": "abc123",
"accountPhoneNumber": AccountPhoneNumber,
"query": Query,
"accountByAccountId": Account,
"phoneNumberTypeByType": PhoneNumberType,
"accountPhoneNumberEdge": AccountPhoneNumbersEdge
}
CreateAccountRegDStatusInput
Description
All input for the create AccountRegDStatus mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
accountRegDStatus - AccountRegDStatusInput!
|
The AccountRegDStatus to be created by this mutation. |
Example
{
"clientMutationId": "abc123",
"accountRegDStatus": AccountRegDStatusInput
}
CreateAccountRegDStatusPayload
Description
The output of our create AccountRegDStatus mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
The exact same clientMutationId that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations. |
accountRegDStatus - AccountRegDStatus
|
The AccountRegDStatus that was created by this mutation. |
query - Query
|
Our root query field type. Allows us to run any query from our mutation payload. |
accountByAccountId - Account
|
Reads a single Account that is related to this AccountRegDStatus. |
accountRegDStatusEdge - AccountRegDStatusesEdge
|
An edge for our AccountRegDStatus. May be used by Relay 1. |
Arguments
|
|
Example
{
"clientMutationId": "xyz789",
"accountRegDStatus": AccountRegDStatus,
"query": Query,
"accountByAccountId": Account,
"accountRegDStatusEdge": AccountRegDStatusesEdge
}
CreateAccountRestrictionInput
Description
All input for the create AccountRestriction mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
accountRestriction - AccountRestrictionInput!
|
The AccountRestriction to be created by this mutation. |
Example
{
"clientMutationId": "abc123",
"accountRestriction": AccountRestrictionInput
}
CreateAccountRestrictionPayload
Description
The output of our create AccountRestriction mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
The exact same clientMutationId that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations. |
accountRestriction - AccountRestriction
|
The AccountRestriction that was created by this mutation. |
query - Query
|
Our root query field type. Allows us to run any query from our mutation payload. |
accountByAccountId - Account
|
Reads a single Account that is related to this AccountRestriction. |
restrictionReasonByReasonId - RestrictionReason
|
Reads a single RestrictionReason that is related to this AccountRestriction. |
userByCreatorUserId - User
|
Reads a single User that is related to this AccountRestriction. |
accountByCreatorAccountId - Account
|
Reads a single Account that is related to this AccountRestriction. |
accountRestrictionEdge - AccountRestrictionsEdge
|
An edge for our AccountRestriction. May be used by Relay 1. |
Arguments
|
|
Example
{
"clientMutationId": "abc123",
"accountRestriction": AccountRestriction,
"query": Query,
"accountByAccountId": Account,
"restrictionReasonByReasonId": RestrictionReason,
"userByCreatorUserId": User,
"accountByCreatorAccountId": Account,
"accountRestrictionEdge": AccountRestrictionsEdge
}
CreateAllocationAnnotationInput
Description
All input for the create AllocationAnnotation mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
allocationAnnotation - AllocationAnnotationInput!
|
The AllocationAnnotation to be created by this mutation. |
Example
{
"clientMutationId": "xyz789",
"allocationAnnotation": AllocationAnnotationInput
}
CreateAllocationAnnotationPayload
Description
The output of our create AllocationAnnotation mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
The exact same clientMutationId that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations. |
allocationAnnotation - AllocationAnnotation
|
The AllocationAnnotation that was created by this mutation. |
query - Query
|
Our root query field type. Allows us to run any query from our mutation payload. |
allocationByAllocationId - Allocation
|
Reads a single Allocation that is related to this AllocationAnnotation. |
userByWrittenBy - User
|
Reads a single User that is related to this AllocationAnnotation. |
accountByAccountId - Account
|
Reads a single Account that is related to this AllocationAnnotation. |
allocationAnnotationEdge - AllocationAnnotationsEdge
|
An edge for our AllocationAnnotation. May be used by Relay 1. |
Arguments
|
|
Example
{
"clientMutationId": "abc123",
"allocationAnnotation": AllocationAnnotation,
"query": Query,
"allocationByAllocationId": Allocation,
"userByWrittenBy": User,
"accountByAccountId": Account,
"allocationAnnotationEdge": AllocationAnnotationsEdge
}
CreateAllocationInput
Description
All input for the create Allocation mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
allocation - AllocationInput!
|
The Allocation to be created by this mutation. |
Example
{
"clientMutationId": "xyz789",
"allocation": AllocationInput
}
CreateAllocationPayload
Description
The output of our create Allocation mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
The exact same clientMutationId that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations. |
allocation - Allocation
|
The Allocation that was created by this mutation. |
query - Query
|
Our root query field type. Allows us to run any query from our mutation payload. |
accountByOwnerId - Account
|
Reads a single Account that is related to this Allocation. |
blockchainAddressByBlockchainAddressId - BlockchainAddress
|
Reads a single BlockchainAddress that is related to this Allocation. |
accountByIssuerId - Account
|
Reads a single Account that is related to this Allocation. |
assetStatusByStatus - AssetStatus
|
Reads a single AssetStatus that is related to this Allocation. |
roundByRoundId - Round
|
Reads a single Round that is related to this Allocation. |
allocationEdge - AllocationsEdge
|
An edge for our Allocation. May be used by Relay 1. |
Arguments
|
|
Example
{
"clientMutationId": "abc123",
"allocation": Allocation,
"query": Query,
"accountByOwnerId": Account,
"blockchainAddressByBlockchainAddressId": BlockchainAddress,
"accountByIssuerId": Account,
"assetStatusByStatus": AssetStatus,
"roundByRoundId": Round,
"allocationEdge": AllocationsEdge
}
CreateAllocationQualificationInput
Description
All input for the create AllocationQualification mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
allocationQualification - AllocationQualificationInput!
|
The AllocationQualification to be created by this mutation. |
Example
{
"clientMutationId": "abc123",
"allocationQualification": AllocationQualificationInput
}
CreateAllocationQualificationPayload
Description
The output of our create AllocationQualification mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
The exact same clientMutationId that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations. |
allocationQualification - AllocationQualification
|
The AllocationQualification that was created by this mutation. |
query - Query
|
Our root query field type. Allows us to run any query from our mutation payload. |
allocationByAllocationId - Allocation
|
Reads a single Allocation that is related to this AllocationQualification. |
vendorQualificationByVendorQualificationId - VendorQualification
|
Reads a single VendorQualification that is related to this AllocationQualification. |
allocationQualificationEdge - AllocationQualificationsEdge
|
An edge for our AllocationQualification. May be used by Relay 1. |
Arguments
|
|
Example
{
"clientMutationId": "abc123",
"allocationQualification": AllocationQualification,
"query": Query,
"allocationByAllocationId": Allocation,
"vendorQualificationByVendorQualificationId": VendorQualification,
"allocationQualificationEdge": AllocationQualificationsEdge
}
CreateAllocationsVestingScheduleInput
Description
All input for the create AllocationsVestingSchedule mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
allocationsVestingSchedule - AllocationsVestingScheduleInput!
|
The AllocationsVestingSchedule to be created by this mutation. |
Example
{
"clientMutationId": "xyz789",
"allocationsVestingSchedule": AllocationsVestingScheduleInput
}
CreateAllocationsVestingSchedulePayload
Description
The output of our create AllocationsVestingSchedule mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
The exact same clientMutationId that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations. |
allocationsVestingSchedule - AllocationsVestingSchedule
|
The AllocationsVestingSchedule that was created by this mutation. |
query - Query
|
Our root query field type. Allows us to run any query from our mutation payload. |
allocationByAllocationId - Allocation
|
Reads a single Allocation that is related to this AllocationsVestingSchedule. |
vestingDurationByDuration - VestingDuration
|
Reads a single VestingDuration that is related to this AllocationsVestingSchedule. |
allocationsVestingScheduleEdge - AllocationsVestingSchedulesEdge
|
An edge for our AllocationsVestingSchedule. May be used by Relay 1. |
Arguments
|
|
Example
{
"clientMutationId": "abc123",
"allocationsVestingSchedule": AllocationsVestingSchedule,
"query": Query,
"allocationByAllocationId": Allocation,
"vestingDurationByDuration": VestingDuration,
"allocationsVestingScheduleEdge": AllocationsVestingSchedulesEdge
}
CreateAssetAnnotationInput
Description
All input for the create AssetAnnotation mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
assetAnnotation - AssetAnnotationInput!
|
The AssetAnnotation to be created by this mutation. |
Example
{
"clientMutationId": "abc123",
"assetAnnotation": AssetAnnotationInput
}
CreateAssetAnnotationPayload
Description
The output of our create AssetAnnotation mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
The exact same clientMutationId that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations. |
assetAnnotation - AssetAnnotation
|
The AssetAnnotation that was created by this mutation. |
query - Query
|
Our root query field type. Allows us to run any query from our mutation payload. |
assetByAssetId - Asset
|
Reads a single Asset that is related to this AssetAnnotation. |
userByWrittenBy - User
|
Reads a single User that is related to this AssetAnnotation. |
accountByAccountId - Account
|
Reads a single Account that is related to this AssetAnnotation. |
assetAnnotationEdge - AssetAnnotationsEdge
|
An edge for our AssetAnnotation. May be used by Relay 1. |
Arguments
|
|
Example
{
"clientMutationId": "xyz789",
"assetAnnotation": AssetAnnotation,
"query": Query,
"assetByAssetId": Asset,
"userByWrittenBy": User,
"accountByAccountId": Account,
"assetAnnotationEdge": AssetAnnotationsEdge
}
CreateAssetInput
Description
All input for the create Asset mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
asset - AssetInput!
|
The Asset to be created by this mutation. |
Example
{
"clientMutationId": "xyz789",
"asset": AssetInput
}
CreateAssetPayload
Description
The output of our create Asset mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
The exact same clientMutationId that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations. |
asset - Asset
|
The Asset that was created by this mutation. |
query - Query
|
Our root query field type. Allows us to run any query from our mutation payload. |
accountByIssuerId - Account
|
Reads a single Account that is related to this Asset. |
assetTypeByType - AssetType
|
Reads a single AssetType that is related to this Asset. |
assetStatusByStatus - AssetStatus
|
Reads a single AssetStatus that is related to this Asset. |
assetEdge - AssetsEdge
|
An edge for our Asset. May be used by Relay 1. |
Arguments
|
|
Example
{
"clientMutationId": "abc123",
"asset": Asset,
"query": Query,
"accountByIssuerId": Account,
"assetTypeByType": AssetType,
"assetStatusByStatus": AssetStatus,
"assetEdge": AssetsEdge
}
CreateAuxAccountInput
Description
All input for the create AuxAccount mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
auxAccount - AuxAccountInput!
|
The AuxAccount to be created by this mutation. |
Example
{
"clientMutationId": "abc123",
"auxAccount": AuxAccountInput
}
CreateAuxAccountPayload
Description
The output of our create AuxAccount mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
The exact same clientMutationId that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations. |
auxAccount - AuxAccount
|
The AuxAccount that was created by this mutation. |
query - Query
|
Our root query field type. Allows us to run any query from our mutation payload. |
auxAccountEdge - AuxAccountsEdge
|
An edge for our AuxAccount. May be used by Relay 1. |
Arguments
|
|
Example
{
"clientMutationId": "xyz789",
"auxAccount": AuxAccount,
"query": Query,
"auxAccountEdge": AuxAccountsEdge
}
CreateAuxRoleInput
Description
All input for the create AuxRole mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
auxRole - AuxRoleInput!
|
The AuxRole to be created by this mutation. |
Example
{
"clientMutationId": "xyz789",
"auxRole": AuxRoleInput
}
CreateAuxRolePayload
Description
The output of our create AuxRole mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
The exact same clientMutationId that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations. |
auxRole - AuxRole
|
The AuxRole that was created by this mutation. |
query - Query
|
Our root query field type. Allows us to run any query from our mutation payload. |
auxRoleEdge - AuxRolesEdge
|
An edge for our AuxRole. May be used by Relay 1. |
Arguments
|
|
Example
{
"clientMutationId": "abc123",
"auxRole": AuxRole,
"query": Query,
"auxRoleEdge": AuxRolesEdge
}
CreateBrokerAllocationInput
Description
All input for the create BrokerAllocation mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
brokerAllocation - BrokerAllocationInput!
|
The BrokerAllocation to be created by this mutation. |
Example
{
"clientMutationId": "xyz789",
"brokerAllocation": BrokerAllocationInput
}
CreateBrokerAllocationPayload
Description
The output of our create BrokerAllocation mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
The exact same clientMutationId that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations. |
brokerAllocation - BrokerAllocation
|
The BrokerAllocation that was created by this mutation. |
query - Query
|
Our root query field type. Allows us to run any query from our mutation payload. |
accountByBrokerId - Account
|
Reads a single Account that is related to this BrokerAllocation. |
invitationStatusByStatus - InvitationStatus
|
Reads a single InvitationStatus that is related to this BrokerAllocation. |
roundByRoundId - Round
|
Reads a single Round that is related to this BrokerAllocation. |
brokerAllocationEdge - BrokerAllocationsEdge
|
An edge for our BrokerAllocation. May be used by Relay 1. |
Arguments
|
|
Example
{
"clientMutationId": "xyz789",
"brokerAllocation": BrokerAllocation,
"query": Query,
"accountByBrokerId": Account,
"invitationStatusByStatus": InvitationStatus,
"roundByRoundId": Round,
"brokerAllocationEdge": BrokerAllocationsEdge
}
CreateCapitalDeploymentInput
Description
All input for the create CapitalDeployment mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
capitalDeployment - CapitalDeploymentInput!
|
The CapitalDeployment to be created by this mutation. |
Example
{
"clientMutationId": "xyz789",
"capitalDeployment": CapitalDeploymentInput
}
CreateCapitalDeploymentPayload
Description
The output of our create CapitalDeployment mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
The exact same clientMutationId that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations. |
capitalDeployment - CapitalDeployment
|
The CapitalDeployment that was created by this mutation. |
query - Query
|
Our root query field type. Allows us to run any query from our mutation payload. |
currencyByCurrency - Currency
|
Reads a single Currency that is related to this CapitalDeployment. |
roundByRoundId - Round
|
Reads a single Round that is related to this CapitalDeployment. |
capitalDeploymentEdge - CapitalDeploymentsEdge
|
An edge for our CapitalDeployment. May be used by Relay 1. |
Arguments
|
|
Example
{
"clientMutationId": "xyz789",
"capitalDeployment": CapitalDeployment,
"query": Query,
"currencyByCurrency": Currency,
"roundByRoundId": Round,
"capitalDeploymentEdge": CapitalDeploymentsEdge
}
CreateDistributionAnnotationInput
Description
All input for the create DistributionAnnotation mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
distributionAnnotation - DistributionAnnotationInput!
|
The DistributionAnnotation to be created by this mutation. |
Example
{
"clientMutationId": "abc123",
"distributionAnnotation": DistributionAnnotationInput
}
CreateDistributionAnnotationPayload
Description
The output of our create DistributionAnnotation mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
The exact same clientMutationId that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations. |
distributionAnnotation - DistributionAnnotation
|
The DistributionAnnotation that was created by this mutation. |
query - Query
|
Our root query field type. Allows us to run any query from our mutation payload. |
distributionByDistributionId - Distribution
|
Reads a single Distribution that is related to this DistributionAnnotation. |
userByWrittenBy - User
|
Reads a single User that is related to this DistributionAnnotation. |
accountByAccountId - Account
|
Reads a single Account that is related to this DistributionAnnotation. |
distributionAnnotationEdge - DistributionAnnotationsEdge
|
An edge for our DistributionAnnotation. May be used by Relay 1. |
Arguments
|
|
Example
{
"clientMutationId": "xyz789",
"distributionAnnotation": DistributionAnnotation,
"query": Query,
"distributionByDistributionId": Distribution,
"userByWrittenBy": User,
"accountByAccountId": Account,
"distributionAnnotationEdge": DistributionAnnotationsEdge
}
CreateDistributionCustomFieldInput
Description
All input for the create DistributionCustomField mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
distributionCustomField - DistributionCustomFieldInput!
|
The DistributionCustomField to be created by this mutation. |
Example
{
"clientMutationId": "xyz789",
"distributionCustomField": DistributionCustomFieldInput
}
CreateDistributionCustomFieldPayload
Description
The output of our create DistributionCustomField mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
The exact same clientMutationId that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations. |
distributionCustomField - DistributionCustomField
|
The DistributionCustomField that was created by this mutation. |
query - Query
|
Our root query field type. Allows us to run any query from our mutation payload. |
accountByCreatedBy - Account
|
Reads a single Account that is related to this DistributionCustomField. |
distributionByDistributionId - Distribution
|
Reads a single Distribution that is related to this DistributionCustomField. |
distributionCustomFieldEdge - DistributionCustomFieldsEdge
|
An edge for our DistributionCustomField. May be used by Relay 1. |
Arguments
|
|
Example
{
"clientMutationId": "abc123",
"distributionCustomField": DistributionCustomField,
"query": Query,
"accountByCreatedBy": Account,
"distributionByDistributionId": Distribution,
"distributionCustomFieldEdge": DistributionCustomFieldsEdge
}
CreateDistributionInput
Description
All input for the create Distribution mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
distribution - DistributionInput!
|
The Distribution to be created by this mutation. |
Example
{
"clientMutationId": "abc123",
"distribution": DistributionInput
}
CreateDistributionPayload
Description
The output of our create Distribution mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
The exact same clientMutationId that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations. |
distribution - Distribution
|
The Distribution that was created by this mutation. |
query - Query
|
Our root query field type. Allows us to run any query from our mutation payload. |
allocationByAllocationId - Allocation
|
Reads a single Allocation that is related to this Distribution. |
accountByInvestorId - Account
|
Reads a single Account that is related to this Distribution. |
distributionStatusByStatus - DistributionStatus
|
Reads a single DistributionStatus that is related to this Distribution. |
stepByStepId - Step
|
Reads a single Step that is related to this Distribution. |
distributionEdge - DistributionsEdge
|
An edge for our Distribution. May be used by Relay 1. |
Arguments
|
|
Example
{
"clientMutationId": "abc123",
"distribution": Distribution,
"query": Query,
"allocationByAllocationId": Allocation,
"accountByInvestorId": Account,
"distributionStatusByStatus": DistributionStatus,
"stepByStepId": Step,
"distributionEdge": DistributionsEdge
}
CreateDistributionPaymentInput
Description
All input for the create DistributionPayment mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
distributionPayment - DistributionPaymentInput!
|
The DistributionPayment to be created by this mutation. |
Example
{
"clientMutationId": "abc123",
"distributionPayment": DistributionPaymentInput
}
CreateDistributionPaymentPayload
Description
The output of our create DistributionPayment mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
The exact same clientMutationId that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations. |
distributionPayment - DistributionPayment
|
The DistributionPayment that was created by this mutation. |
query - Query
|
Our root query field type. Allows us to run any query from our mutation payload. |
distributionByDistributionId - Distribution
|
Reads a single Distribution that is related to this DistributionPayment. |
currencyByCurrency - Currency
|
Reads a single Currency that is related to this DistributionPayment. |
distributionPaymentStatusByStatus - DistributionPaymentStatus
|
Reads a single DistributionPaymentStatus that is related to this DistributionPayment. |
distributionPaymentEdge - DistributionPaymentsEdge
|
An edge for our DistributionPayment. May be used by Relay 1. |
Arguments
|
|
Example
{
"clientMutationId": "abc123",
"distributionPayment": DistributionPayment,
"query": Query,
"distributionByDistributionId": Distribution,
"currencyByCurrency": Currency,
"distributionPaymentStatusByStatus": DistributionPaymentStatus,
"distributionPaymentEdge": DistributionPaymentsEdge
}
CreateDistributionPriceInput
Description
All input for the create DistributionPrice mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
distributionPrice - DistributionPriceInput!
|
The DistributionPrice to be created by this mutation. |
Example
{
"clientMutationId": "abc123",
"distributionPrice": DistributionPriceInput
}
CreateDistributionPricePayload
Description
The output of our create DistributionPrice mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
The exact same clientMutationId that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations. |
distributionPrice - DistributionPrice
|
The DistributionPrice that was created by this mutation. |
query - Query
|
Our root query field type. Allows us to run any query from our mutation payload. |
distributionByDistributionId - Distribution
|
Reads a single Distribution that is related to this DistributionPrice. |
currencyByCurrency - Currency
|
Reads a single Currency that is related to this DistributionPrice. |
distributionPriceEdge - DistributionPricesEdge
|
An edge for our DistributionPrice. May be used by Relay 1. |
Arguments
|
|
Example
{
"clientMutationId": "abc123",
"distributionPrice": DistributionPrice,
"query": Query,
"distributionByDistributionId": Distribution,
"currencyByCurrency": Currency,
"distributionPriceEdge": DistributionPricesEdge
}
CreateEmailTemplateToInput
Description
All input for the create EmailTemplateTo mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
emailTemplateTo - EmailTemplateToInput!
|
The EmailTemplateTo to be created by this mutation. |
Example
{
"clientMutationId": "abc123",
"emailTemplateTo": EmailTemplateToInput
}
CreateEmailTemplateToPayload
Description
The output of our create EmailTemplateTo mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
The exact same clientMutationId that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations. |
emailTemplateTo - EmailTemplateTo
|
The EmailTemplateTo that was created by this mutation. |
query - Query
|
Our root query field type. Allows us to run any query from our mutation payload. |
emailTemplateToEdge - EmailTemplateTosEdge
|
An edge for our EmailTemplateTo. May be used by Relay 1. |
Arguments
|
|
Example
{
"clientMutationId": "xyz789",
"emailTemplateTo": EmailTemplateTo,
"query": Query,
"emailTemplateToEdge": EmailTemplateTosEdge
}
CreateIdempotentTypeInput
Description
All input for the create IdempotentType mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
idempotentType - IdempotentTypeInput!
|
The IdempotentType to be created by this mutation. |
Example
{
"clientMutationId": "xyz789",
"idempotentType": IdempotentTypeInput
}
CreateIdempotentTypePayload
Description
The output of our create IdempotentType mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
The exact same clientMutationId that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations. |
idempotentType - IdempotentType
|
The IdempotentType that was created by this mutation. |
query - Query
|
Our root query field type. Allows us to run any query from our mutation payload. |
idempotentTypeEdge - IdempotentTypesEdge
|
An edge for our IdempotentType. May be used by Relay 1. |
Arguments
|
|
Example
{
"clientMutationId": "xyz789",
"idempotentType": IdempotentType,
"query": Query,
"idempotentTypeEdge": IdempotentTypesEdge
}
CreateInstancedAccountInformationHistoryInput
Description
All input for the create InstancedAccountInformationHistory mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
instancedAccountInformationHistory - InstancedAccountInformationHistoryInput!
|
The InstancedAccountInformationHistory to be created by this mutation. |
Example
{
"clientMutationId": "xyz789",
"instancedAccountInformationHistory": InstancedAccountInformationHistoryInput
}
CreateInstancedAccountInformationHistoryPayload
Description
The output of our create InstancedAccountInformationHistory mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
The exact same clientMutationId that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations. |
instancedAccountInformationHistory - InstancedAccountInformationHistory
|
The InstancedAccountInformationHistory that was created by this mutation. |
query - Query
|
Our root query field type. Allows us to run any query from our mutation payload. |
instancedAccountInformationByRecordId - InstancedAccountInformation
|
Reads a single InstancedAccountInformation that is related to this InstancedAccountInformationHistory. |
instancedAccountInformationHistoryEdge - InstancedAccountInformationHistoriesEdge
|
An edge for our InstancedAccountInformationHistory. May be used by Relay 1. |
Arguments
|
|
Example
{
"clientMutationId": "xyz789",
"instancedAccountInformationHistory": InstancedAccountInformationHistory,
"query": Query,
"instancedAccountInformationByRecordId": InstancedAccountInformation,
"instancedAccountInformationHistoryEdge": InstancedAccountInformationHistoriesEdge
}
CreateMappedSigningTemplateInput
Description
All input for the create MappedSigningTemplate mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
mappedSigningTemplate - MappedSigningTemplateInput!
|
The MappedSigningTemplate to be created by this mutation. |
Example
{
"clientMutationId": "abc123",
"mappedSigningTemplate": MappedSigningTemplateInput
}
CreateMappedSigningTemplatePayload
Description
The output of our create MappedSigningTemplate mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
The exact same clientMutationId that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations. |
mappedSigningTemplate - MappedSigningTemplate
|
The MappedSigningTemplate that was created by this mutation. |
query - Query
|
Our root query field type. Allows us to run any query from our mutation payload. |
accountByAccountId - Account
|
Reads a single Account that is related to this MappedSigningTemplate. |
signingTemplateBySigningTemplateId - SigningTemplate
|
Reads a single SigningTemplate that is related to this MappedSigningTemplate. |
stepByStepId - Step
|
Reads a single Step that is related to this MappedSigningTemplate. |
vendorQualificationByVendorQualificationId - VendorQualification
|
Reads a single VendorQualification that is related to this MappedSigningTemplate. |
signingStepTypeByQualificationStepType - SigningStepType
|
Reads a single SigningStepType that is related to this MappedSigningTemplate. |
mappedSigningTemplateEdge - MappedSigningTemplatesEdge
|
An edge for our MappedSigningTemplate. May be used by Relay 1. |
Arguments
|
|
Example
{
"clientMutationId": "xyz789",
"mappedSigningTemplate": MappedSigningTemplate,
"query": Query,
"accountByAccountId": Account,
"signingTemplateBySigningTemplateId": SigningTemplate,
"stepByStepId": Step,
"vendorQualificationByVendorQualificationId": VendorQualification,
"signingStepTypeByQualificationStepType": SigningStepType,
"mappedSigningTemplateEdge": MappedSigningTemplatesEdge
}
CreateMappedSigningTemplateQuestionSetInput
Description
All input for the create MappedSigningTemplateQuestionSet mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
mappedSigningTemplateQuestionSet - MappedSigningTemplateQuestionSetInput!
|
The MappedSigningTemplateQuestionSet to be created by this mutation. |
Example
{
"clientMutationId": "xyz789",
"mappedSigningTemplateQuestionSet": MappedSigningTemplateQuestionSetInput
}
CreateMappedSigningTemplateQuestionSetPayload
Description
The output of our create MappedSigningTemplateQuestionSet mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
The exact same clientMutationId that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations. |
mappedSigningTemplateQuestionSet - MappedSigningTemplateQuestionSet
|
The MappedSigningTemplateQuestionSet that was created by this mutation. |
query - Query
|
Our root query field type. Allows us to run any query from our mutation payload. |
onboardingQuestionSetByOnboardingQuestionSetId - OnboardingQuestionSet
|
Reads a single OnboardingQuestionSet that is related to this MappedSigningTemplateQuestionSet. |
mappedSigningTemplateByMappedSigningTemplateId - MappedSigningTemplate
|
Reads a single MappedSigningTemplate that is related to this MappedSigningTemplateQuestionSet. |
mappedSigningTemplateQuestionSetEdge - MappedSigningTemplateQuestionSetsEdge
|
An edge for our MappedSigningTemplateQuestionSet. May be used by Relay 1. |
Arguments
|
|
Example
{
"clientMutationId": "abc123",
"mappedSigningTemplateQuestionSet": MappedSigningTemplateQuestionSet,
"query": Query,
"onboardingQuestionSetByOnboardingQuestionSetId": OnboardingQuestionSet,
"mappedSigningTemplateByMappedSigningTemplateId": MappedSigningTemplate,
"mappedSigningTemplateQuestionSetEdge": MappedSigningTemplateQuestionSetsEdge
}
CreateOnboardingQuestionInput
Description
All input for the create OnboardingQuestion mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
onboardingQuestion - OnboardingQuestionInput!
|
The OnboardingQuestion to be created by this mutation. |
Example
{
"clientMutationId": "xyz789",
"onboardingQuestion": OnboardingQuestionInput
}
CreateOnboardingQuestionJoinInput
Description
All input for the create OnboardingQuestionJoin mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
onboardingQuestionJoin - OnboardingQuestionJoinInput!
|
The OnboardingQuestionJoin to be created by this mutation. |
Example
{
"clientMutationId": "abc123",
"onboardingQuestionJoin": OnboardingQuestionJoinInput
}
CreateOnboardingQuestionJoinPayload
Description
The output of our create OnboardingQuestionJoin mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
The exact same clientMutationId that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations. |
onboardingQuestionJoin - OnboardingQuestionJoin
|
The OnboardingQuestionJoin that was created by this mutation. |
query - Query
|
Our root query field type. Allows us to run any query from our mutation payload. |
onboardingQuestionSetByOnboardingQuestionSetId - OnboardingQuestionSet
|
Reads a single OnboardingQuestionSet that is related to this OnboardingQuestionJoin. |
onboardingQuestionByOnboardingQuestionId - OnboardingQuestion
|
Reads a single OnboardingQuestion that is related to this OnboardingQuestionJoin. |
onboardingQuestionJoinEdge - OnboardingQuestionJoinsEdge
|
An edge for our OnboardingQuestionJoin. May be used by Relay 1. |
Arguments
|
|
Example
{
"clientMutationId": "xyz789",
"onboardingQuestionJoin": OnboardingQuestionJoin,
"query": Query,
"onboardingQuestionSetByOnboardingQuestionSetId": OnboardingQuestionSet,
"onboardingQuestionByOnboardingQuestionId": OnboardingQuestion,
"onboardingQuestionJoinEdge": OnboardingQuestionJoinsEdge
}
CreateOnboardingQuestionPayload
Description
The output of our create OnboardingQuestion mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
The exact same clientMutationId that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations. |
onboardingQuestion - OnboardingQuestion
|
The OnboardingQuestion that was created by this mutation. |
query - Query
|
Our root query field type. Allows us to run any query from our mutation payload. |
accountByAccountId - Account
|
Reads a single Account that is related to this OnboardingQuestion. |
onboardingQuestionTypeByType - OnboardingQuestionType
|
Reads a single OnboardingQuestionType that is related to this OnboardingQuestion. |
onboardingQuestionEdge - OnboardingQuestionsEdge
|
An edge for our OnboardingQuestion. May be used by Relay 1. |
Arguments
|
|
Example
{
"clientMutationId": "xyz789",
"onboardingQuestion": OnboardingQuestion,
"query": Query,
"accountByAccountId": Account,
"onboardingQuestionTypeByType": OnboardingQuestionType,
"onboardingQuestionEdge": OnboardingQuestionsEdge
}
CreateOnboardingQuestionSetInput
Description
All input for the create OnboardingQuestionSet mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
onboardingQuestionSet - OnboardingQuestionSetInput!
|
The OnboardingQuestionSet to be created by this mutation. |
Example
{
"clientMutationId": "abc123",
"onboardingQuestionSet": OnboardingQuestionSetInput
}
CreateOnboardingQuestionSetPayload
Description
The output of our create OnboardingQuestionSet mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
The exact same clientMutationId that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations. |
onboardingQuestionSet - OnboardingQuestionSet
|
The OnboardingQuestionSet that was created by this mutation. |
query - Query
|
Our root query field type. Allows us to run any query from our mutation payload. |
accountByAccountId - Account
|
Reads a single Account that is related to this OnboardingQuestionSet. |
vendorQualificationByVendorQualificationId - VendorQualification
|
Reads a single VendorQualification that is related to this OnboardingQuestionSet. |
onboardingQuestionSetEdge - OnboardingQuestionSetsEdge
|
An edge for our OnboardingQuestionSet. May be used by Relay 1. |
Arguments
|
|
Example
{
"clientMutationId": "xyz789",
"onboardingQuestionSet": OnboardingQuestionSet,
"query": Query,
"accountByAccountId": Account,
"vendorQualificationByVendorQualificationId": VendorQualification,
"onboardingQuestionSetEdge": OnboardingQuestionSetsEdge
}
CreatePaymentMethodInput
Description
All input for the create PaymentMethod mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
paymentMethod - PaymentMethodInput!
|
The PaymentMethod to be created by this mutation. |
Example
{
"clientMutationId": "abc123",
"paymentMethod": PaymentMethodInput
}
CreatePaymentMethodPayload
Description
The output of our create PaymentMethod mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
The exact same clientMutationId that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations. |
paymentMethod - PaymentMethod
|
The PaymentMethod that was created by this mutation. |
query - Query
|
Our root query field type. Allows us to run any query from our mutation payload. |
accountByAccountId - Account
|
Reads a single Account that is related to this PaymentMethod. |
integrationByIntegrationId - Integration
|
Reads a single Integration that is related to this PaymentMethod. |
paymentMethodTypeByType - PaymentMethodType
|
Reads a single PaymentMethodType that is related to this PaymentMethod. |
paymentMethodEdge - PaymentMethodsEdge
|
An edge for our PaymentMethod. May be used by Relay 1. |
Arguments
|
|
Example
{
"clientMutationId": "abc123",
"paymentMethod": PaymentMethod,
"query": Query,
"accountByAccountId": Account,
"integrationByIntegrationId": Integration,
"paymentMethodTypeByType": PaymentMethodType,
"paymentMethodEdge": PaymentMethodsEdge
}
CreatePaymentMethodTypeInput
Description
All input for the create PaymentMethodType mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
paymentMethodType - PaymentMethodTypeInput!
|
The PaymentMethodType to be created by this mutation. |
Example
{
"clientMutationId": "abc123",
"paymentMethodType": PaymentMethodTypeInput
}
CreatePaymentMethodTypePayload
Description
The output of our create PaymentMethodType mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
The exact same clientMutationId that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations. |
paymentMethodType - PaymentMethodType
|
The PaymentMethodType that was created by this mutation. |
query - Query
|
Our root query field type. Allows us to run any query from our mutation payload. |
paymentMethodTypeEdge - PaymentMethodTypesEdge
|
An edge for our PaymentMethodType. May be used by Relay 1. |
Arguments
|
|
Example
{
"clientMutationId": "xyz789",
"paymentMethodType": PaymentMethodType,
"query": Query,
"paymentMethodTypeEdge": PaymentMethodTypesEdge
}
CreatePaymentStepTypeInput
Description
All input for the create PaymentStepType mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
paymentStepType - PaymentStepTypeInput!
|
The PaymentStepType to be created by this mutation. |
Example
{
"clientMutationId": "xyz789",
"paymentStepType": PaymentStepTypeInput
}
CreatePaymentStepTypePayload
Description
The output of our create PaymentStepType mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
The exact same clientMutationId that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations. |
paymentStepType - PaymentStepType
|
The PaymentStepType that was created by this mutation. |
query - Query
|
Our root query field type. Allows us to run any query from our mutation payload. |
paymentStepTypeEdge - PaymentStepTypesEdge
|
An edge for our PaymentStepType. May be used by Relay 1. |
Arguments
|
|
Example
{
"clientMutationId": "xyz789",
"paymentStepType": PaymentStepType,
"query": Query,
"paymentStepTypeEdge": PaymentStepTypesEdge
}
CreateRequestTypeInput
Description
All input for the create RequestType mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
requestType - RequestTypeInput!
|
The RequestType to be created by this mutation. |
Example
{
"clientMutationId": "xyz789",
"requestType": RequestTypeInput
}
CreateRequestTypePayload
Description
The output of our create RequestType mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
The exact same clientMutationId that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations. |
requestType - RequestType
|
The RequestType that was created by this mutation. |
query - Query
|
Our root query field type. Allows us to run any query from our mutation payload. |
requestTypeEdge - RequestTypesEdge
|
An edge for our RequestType. May be used by Relay 1. |
Arguments
|
|
Example
{
"clientMutationId": "abc123",
"requestType": RequestType,
"query": Query,
"requestTypeEdge": RequestTypesEdge
}
CreateRestrictionCategoryInput
Description
All input for the create RestrictionCategory mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
restrictionCategory - RestrictionCategoryInput!
|
The RestrictionCategory to be created by this mutation. |
Example
{
"clientMutationId": "abc123",
"restrictionCategory": RestrictionCategoryInput
}
CreateRestrictionCategoryPayload
Description
The output of our create RestrictionCategory mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
The exact same clientMutationId that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations. |
restrictionCategory - RestrictionCategory
|
The RestrictionCategory that was created by this mutation. |
query - Query
|
Our root query field type. Allows us to run any query from our mutation payload. |
restrictionCategoryEdge - RestrictionCategoriesEdge
|
An edge for our RestrictionCategory. May be used by Relay 1. |
Arguments
|
|
Example
{
"clientMutationId": "abc123",
"restrictionCategory": RestrictionCategory,
"query": Query,
"restrictionCategoryEdge": RestrictionCategoriesEdge
}
CreateRestrictionReasonInput
Description
All input for the create RestrictionReason mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
restrictionReason - RestrictionReasonInput!
|
The RestrictionReason to be created by this mutation. |
Example
{
"clientMutationId": "abc123",
"restrictionReason": RestrictionReasonInput
}
CreateRestrictionReasonPayload
Description
The output of our create RestrictionReason mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
The exact same clientMutationId that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations. |
restrictionReason - RestrictionReason
|
The RestrictionReason that was created by this mutation. |
query - Query
|
Our root query field type. Allows us to run any query from our mutation payload. |
restrictionCategoryByCategory - RestrictionCategory
|
Reads a single RestrictionCategory that is related to this RestrictionReason. |
restrictionReasonEdge - RestrictionReasonsEdge
|
An edge for our RestrictionReason. May be used by Relay 1. |
Arguments
|
|
Example
{
"clientMutationId": "xyz789",
"restrictionReason": RestrictionReason,
"query": Query,
"restrictionCategoryByCategory": RestrictionCategory,
"restrictionReasonEdge": RestrictionReasonsEdge
}
CreateRoundInput
Description
All input for the create Round mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
round - RoundInput!
|
The Round to be created by this mutation. |
Example
{
"clientMutationId": "abc123",
"round": RoundInput
}
CreateRoundPayload
Description
The output of our create Round mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
The exact same clientMutationId that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations. |
round - Round
|
The Round that was created by this mutation. |
query - Query
|
Our root query field type. Allows us to run any query from our mutation payload. |
assetByAssetId - Asset
|
Reads a single Asset that is related to this Round. |
tokenByTokenId - Token
|
Reads a single Token that is related to this Round. |
assetStatusByStatus - AssetStatus
|
Reads a single AssetStatus that is related to this Round. |
blockchainAddressByBlockchainAddressId - BlockchainAddress
|
Reads a single BlockchainAddress that is related to this Round. |
securityBySecurityId - Security
|
Reads a single Security that is related to this Round. |
roundEdge - RoundsEdge
|
An edge for our Round. May be used by Relay 1. |
Arguments
|
|
Example
{
"clientMutationId": "abc123",
"round": Round,
"query": Query,
"assetByAssetId": Asset,
"tokenByTokenId": Token,
"assetStatusByStatus": AssetStatus,
"blockchainAddressByBlockchainAddressId": BlockchainAddress,
"securityBySecurityId": Security,
"roundEdge": RoundsEdge
}
CreateSigningFieldInput
Description
All input for the create SigningField mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
signingField - SigningFieldInput!
|
The SigningField to be created by this mutation. |
Example
{
"clientMutationId": "xyz789",
"signingField": SigningFieldInput
}
CreateSigningFieldPayload
Description
The output of our create SigningField mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
The exact same clientMutationId that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations. |
signingField - SigningField
|
The SigningField that was created by this mutation. |
query - Query
|
Our root query field type. Allows us to run any query from our mutation payload. |
mappedSigningTemplateByMappedSigningTemplateId - MappedSigningTemplate
|
Reads a single MappedSigningTemplate that is related to this SigningField. |
signingDocumentBySigningDocumentId - SigningDocument
|
Reads a single SigningDocument that is related to this SigningField. |
signingRoleBySigningRoleId - SigningRole
|
Reads a single SigningRole that is related to this SigningField. |
signingFieldEdge - SigningFieldsEdge
|
An edge for our SigningField. May be used by Relay 1. |
Arguments
|
|
Example
{
"clientMutationId": "abc123",
"signingField": SigningField,
"query": Query,
"mappedSigningTemplateByMappedSigningTemplateId": MappedSigningTemplate,
"signingDocumentBySigningDocumentId": SigningDocument,
"signingRoleBySigningRoleId": SigningRole,
"signingFieldEdge": SigningFieldsEdge
}
CreateStagedTransferStatusInput
Description
All input for the create StagedTransferStatus mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
stagedTransferStatus - StagedTransferStatusInput!
|
The StagedTransferStatus to be created by this mutation. |
Example
{
"clientMutationId": "abc123",
"stagedTransferStatus": StagedTransferStatusInput
}
CreateStagedTransferStatusPayload
Description
The output of our create StagedTransferStatus mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
The exact same clientMutationId that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations. |
stagedTransferStatus - StagedTransferStatus
|
The StagedTransferStatus that was created by this mutation. |
query - Query
|
Our root query field type. Allows us to run any query from our mutation payload. |
stagedTransferStatusEdge - StagedTransferStatusesEdge
|
An edge for our StagedTransferStatus. May be used by Relay 1. |
Arguments
|
|
Example
{
"clientMutationId": "abc123",
"stagedTransferStatus": StagedTransferStatus,
"query": Query,
"stagedTransferStatusEdge": StagedTransferStatusesEdge
}
CreateTransactionAnnotationInput
Description
All input for the create TransactionAnnotation mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
transactionAnnotation - TransactionAnnotationInput!
|
The TransactionAnnotation to be created by this mutation. |
Example
{
"clientMutationId": "abc123",
"transactionAnnotation": TransactionAnnotationInput
}
CreateTransactionAnnotationPayload
Description
The output of our create TransactionAnnotation mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
The exact same clientMutationId that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations. |
transactionAnnotation - TransactionAnnotation
|
The TransactionAnnotation that was created by this mutation. |
query - Query
|
Our root query field type. Allows us to run any query from our mutation payload. |
transactionByTransactionId - Transaction
|
Reads a single Transaction that is related to this TransactionAnnotation. |
userByWrittenBy - User
|
Reads a single User that is related to this TransactionAnnotation. |
accountByAccountId - Account
|
Reads a single Account that is related to this TransactionAnnotation. |
transactionAnnotationEdge - TransactionAnnotationsEdge
|
An edge for our TransactionAnnotation. May be used by Relay 1. |
Arguments
|
|
Example
{
"clientMutationId": "xyz789",
"transactionAnnotation": TransactionAnnotation,
"query": Query,
"transactionByTransactionId": Transaction,
"userByWrittenBy": User,
"accountByAccountId": Account,
"transactionAnnotationEdge": TransactionAnnotationsEdge
}
CreateTransferTypeInput
Description
All input for the create TransferType mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
transferType - TransferTypeInput!
|
The TransferType to be created by this mutation. |
Example
{
"clientMutationId": "xyz789",
"transferType": TransferTypeInput
}
CreateTransferTypePayload
Description
The output of our create TransferType mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
The exact same clientMutationId that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations. |
transferType - TransferType
|
The TransferType that was created by this mutation. |
query - Query
|
Our root query field type. Allows us to run any query from our mutation payload. |
transferTypeEdge - TransferTypesEdge
|
An edge for our TransferType. May be used by Relay 1. |
Arguments
|
|
Example
{
"clientMutationId": "xyz789",
"transferType": TransferType,
"query": Query,
"transferTypeEdge": TransferTypesEdge
}
CreateVendorIntegrationStatusInput
Description
All input for the create VendorIntegrationStatus mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
vendorIntegrationStatus - VendorIntegrationStatusInput!
|
The VendorIntegrationStatus to be created by this mutation. |
Example
{
"clientMutationId": "abc123",
"vendorIntegrationStatus": VendorIntegrationStatusInput
}
CreateVendorIntegrationStatusPayload
Description
The output of our create VendorIntegrationStatus mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
The exact same clientMutationId that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations. |
vendorIntegrationStatus - VendorIntegrationStatus
|
The VendorIntegrationStatus that was created by this mutation. |
query - Query
|
Our root query field type. Allows us to run any query from our mutation payload. |
vendorIntegrationStatusEdge - VendorIntegrationStatusesEdge
|
An edge for our VendorIntegrationStatus. May be used by Relay 1. |
Arguments
|
|
Example
{
"clientMutationId": "xyz789",
"vendorIntegrationStatus": VendorIntegrationStatus,
"query": Query,
"vendorIntegrationStatusEdge": VendorIntegrationStatusesEdge
}
CreateVestingEventInput
Description
All input for the create VestingEvent mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
vestingEvent - VestingEventInput!
|
The VestingEvent to be created by this mutation. |
Example
{
"clientMutationId": "abc123",
"vestingEvent": VestingEventInput
}
CreateVestingEventPayload
Description
The output of our create VestingEvent mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
The exact same clientMutationId that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations. |
vestingEvent - VestingEvent
|
The VestingEvent that was created by this mutation. |
query - Query
|
Our root query field type. Allows us to run any query from our mutation payload. |
vestingScheduleByVestingScheduleId - VestingSchedule
|
Reads a single VestingSchedule that is related to this VestingEvent. |
transactionByTransactionId - Transaction
|
Reads a single Transaction that is related to this VestingEvent. |
vestingEventEdge - VestingEventsEdge
|
An edge for our VestingEvent. May be used by Relay 1. |
Arguments
|
|
Example
{
"clientMutationId": "xyz789",
"vestingEvent": VestingEvent,
"query": Query,
"vestingScheduleByVestingScheduleId": VestingSchedule,
"transactionByTransactionId": Transaction,
"vestingEventEdge": VestingEventsEdge
}
CreateVestingScheduleInput
Description
All input for the create VestingSchedule mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
vestingSchedule - VestingScheduleInput!
|
The VestingSchedule to be created by this mutation. |
Example
{
"clientMutationId": "abc123",
"vestingSchedule": VestingScheduleInput
}
CreateVestingSchedulePayload
Description
The output of our create VestingSchedule mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
The exact same clientMutationId that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations. |
vestingSchedule - VestingSchedule
|
The VestingSchedule that was created by this mutation. |
query - Query
|
Our root query field type. Allows us to run any query from our mutation payload. |
distributionByDistributionId - Distribution
|
Reads a single Distribution that is related to this VestingSchedule. |
vestingDurationByDuration - VestingDuration
|
Reads a single VestingDuration that is related to this VestingSchedule. |
vestingScheduleEdge - VestingSchedulesEdge
|
An edge for our VestingSchedule. May be used by Relay 1. |
Arguments
|
|
Example
{
"clientMutationId": "xyz789",
"vestingSchedule": VestingSchedule,
"query": Query,
"distributionByDistributionId": Distribution,
"vestingDurationByDuration": VestingDuration,
"vestingScheduleEdge": VestingSchedulesEdge
}
CreateWalletAssignmentInput
Description
All input for the create WalletAssignment mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
walletAssignment - WalletAssignmentInput!
|
The WalletAssignment to be created by this mutation. |
Example
{
"clientMutationId": "abc123",
"walletAssignment": WalletAssignmentInput
}
CreateWalletAssignmentPayload
Description
The output of our create WalletAssignment mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
The exact same clientMutationId that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations. |
walletAssignment - WalletAssignment
|
The WalletAssignment that was created by this mutation. |
query - Query
|
Our root query field type. Allows us to run any query from our mutation payload. |
distributionByDistributionId - Distribution
|
Reads a single Distribution that is related to this WalletAssignment. |
blockchainAddressByBlockchainAddressId - BlockchainAddress
|
Reads a single BlockchainAddress that is related to this WalletAssignment. |
walletAssignmentEdge - WalletAssignmentsEdge
|
An edge for our WalletAssignment. May be used by Relay 1. |
Arguments
|
|
Example
{
"clientMutationId": "xyz789",
"walletAssignment": WalletAssignment,
"query": Query,
"distributionByDistributionId": Distribution,
"blockchainAddressByBlockchainAddressId": BlockchainAddress,
"walletAssignmentEdge": WalletAssignmentsEdge
}
CreateWebhookConfigurationInput
Description
All input for the create WebhookConfiguration mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
webhookConfiguration - WebhookConfigurationInput!
|
The WebhookConfiguration to be created by this mutation. |
Example
{
"clientMutationId": "abc123",
"webhookConfiguration": WebhookConfigurationInput
}
CreateWebhookConfigurationPayload
Description
The output of our create WebhookConfiguration mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
The exact same clientMutationId that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations. |
webhookConfiguration - WebhookConfiguration
|
The WebhookConfiguration that was created by this mutation. |
query - Query
|
Our root query field type. Allows us to run any query from our mutation payload. |
webhookLevelByLevel - WebhookLevel
|
Reads a single WebhookLevel that is related to this WebhookConfiguration. |
accountByAccountId - Account
|
Reads a single Account that is related to this WebhookConfiguration. |
webhookConfigurationEdge - WebhookConfigurationsEdge
|
An edge for our WebhookConfiguration. May be used by Relay 1. |
Arguments
|
|
Example
{
"clientMutationId": "abc123",
"webhookConfiguration": WebhookConfiguration,
"query": Query,
"webhookLevelByLevel": WebhookLevel,
"accountByAccountId": Account,
"webhookConfigurationEdge": WebhookConfigurationsEdge
}
CurrenciesConnection
Description
A connection to a list of Currency values.
Fields
| Field Name | Description |
|---|---|
nodes - [Currency]!
|
A list of Currency objects. |
edges - [CurrenciesEdge!]!
|
A list of edges which contains the Currency and cursor to aid in pagination. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The count of all Currency you could get from the connection. |
Example
{
"nodes": [Currency],
"edges": [CurrenciesEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
CurrenciesEdge
CurrenciesOrderBy
Description
Methods to use when ordering Currency.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NATURAL"
Currency
Fields
| Field Name | Description |
|---|---|
nodeId - ID!
|
A globally unique identifier. Can be used in various places throughout the system to identify this single value. |
type - String!
|
|
name - String!
|
|
code - String!
|
|
num - String!
|
|
precision - Int!
|
|
tokenId - UUID!
|
|
id - UUID!
|
|
currencyTypeByType - CurrencyType
|
Reads a single CurrencyType that is related to this Currency. |
tokenByTokenId - Token
|
Reads a single Token that is related to this Currency. |
distributionPricesByCurrency - DistributionPricesConnection!
|
Reads and enables pagination through a set of DistributionPrice. |
Arguments
|
|
distributionPaymentsByCurrency - DistributionPaymentsConnection!
|
Reads and enables pagination through a set of DistributionPayment. |
Arguments
|
|
capitalDeploymentsByCurrency - CapitalDeploymentsConnection!
|
Reads and enables pagination through a set of CapitalDeployment. |
Arguments
|
|
holdingsByPurchaseCurrency - HoldingsConnection!
|
Reads and enables pagination through a set of Holding. |
Arguments
|
|
Example
{
"nodeId": "4",
"type": "xyz789",
"name": "xyz789",
"code": "xyz789",
"num": "abc123",
"precision": 987,
"tokenId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"currencyTypeByType": CurrencyType,
"tokenByTokenId": Token,
"distributionPricesByCurrency": DistributionPricesConnection,
"distributionPaymentsByCurrency": DistributionPaymentsConnection,
"capitalDeploymentsByCurrency": CapitalDeploymentsConnection,
"holdingsByPurchaseCurrency": HoldingsConnection
}
CurrencyCondition
Description
A condition to be used against Currency object types. All fields are tested for equality and combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
type - String
|
Checks for equality with the object’s type field. |
name - String
|
Checks for equality with the object’s name field. |
code - String
|
Checks for equality with the object’s code field. |
num - String
|
Checks for equality with the object’s num field. |
precision - Int
|
Checks for equality with the object’s precision field. |
tokenId - UUID
|
Checks for equality with the object’s tokenId field. |
id - UUID
|
Checks for equality with the object’s id field. |
Example
{
"type": "abc123",
"name": "xyz789",
"code": "xyz789",
"num": "abc123",
"precision": 987,
"tokenId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
CurrencyFilter
Description
A filter to be used against Currency object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
type - StringFilter
|
Filter by the object’s type field. |
name - StringFilter
|
Filter by the object’s name field. |
code - StringFilter
|
Filter by the object’s code field. |
num - StringFilter
|
Filter by the object’s num field. |
precision - IntFilter
|
Filter by the object’s precision field. |
tokenId - UUIDFilter
|
Filter by the object’s tokenId field. |
id - UUIDFilter
|
Filter by the object’s id field. |
distributionPricesByCurrency - CurrencyToManyDistributionPriceFilter
|
Filter by the object’s distributionPricesByCurrency relation. |
distributionPricesByCurrencyExist - Boolean
|
Some related distributionPricesByCurrency exist. |
distributionPaymentsByCurrency - CurrencyToManyDistributionPaymentFilter
|
Filter by the object’s distributionPaymentsByCurrency relation. |
distributionPaymentsByCurrencyExist - Boolean
|
Some related distributionPaymentsByCurrency exist. |
capitalDeploymentsByCurrency - CurrencyToManyCapitalDeploymentFilter
|
Filter by the object’s capitalDeploymentsByCurrency relation. |
capitalDeploymentsByCurrencyExist - Boolean
|
Some related capitalDeploymentsByCurrency exist. |
holdingsByPurchaseCurrency - CurrencyToManyHoldingFilter
|
Filter by the object’s holdingsByPurchaseCurrency relation. |
holdingsByPurchaseCurrencyExist - Boolean
|
Some related holdingsByPurchaseCurrency exist. |
currencyTypeByType - CurrencyTypeFilter
|
Filter by the object’s currencyTypeByType relation. |
tokenByTokenId - TokenFilter
|
Filter by the object’s tokenByTokenId relation. |
and - [CurrencyFilter!]
|
Checks for all expressions in this list. |
or - [CurrencyFilter!]
|
Checks for any expressions in this list. |
not - CurrencyFilter
|
Negates the expression. |
Example
{
"type": StringFilter,
"name": StringFilter,
"code": StringFilter,
"num": StringFilter,
"precision": IntFilter,
"tokenId": UUIDFilter,
"id": UUIDFilter,
"distributionPricesByCurrency": CurrencyToManyDistributionPriceFilter,
"distributionPricesByCurrencyExist": true,
"distributionPaymentsByCurrency": CurrencyToManyDistributionPaymentFilter,
"distributionPaymentsByCurrencyExist": false,
"capitalDeploymentsByCurrency": CurrencyToManyCapitalDeploymentFilter,
"capitalDeploymentsByCurrencyExist": false,
"holdingsByPurchaseCurrency": CurrencyToManyHoldingFilter,
"holdingsByPurchaseCurrencyExist": true,
"currencyTypeByType": CurrencyTypeFilter,
"tokenByTokenId": TokenFilter,
"and": [CurrencyFilter],
"or": [CurrencyFilter],
"not": CurrencyFilter
}
CurrencyToManyCapitalDeploymentFilter
Description
A filter to be used against many CapitalDeployment object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - CapitalDeploymentFilter
|
Every related CapitalDeployment matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - CapitalDeploymentFilter
|
Some related CapitalDeployment matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - CapitalDeploymentFilter
|
No related CapitalDeployment matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": CapitalDeploymentFilter,
"some": CapitalDeploymentFilter,
"none": CapitalDeploymentFilter
}
CurrencyToManyDistributionPaymentFilter
Description
A filter to be used against many DistributionPayment object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - DistributionPaymentFilter
|
Every related DistributionPayment matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - DistributionPaymentFilter
|
Some related DistributionPayment matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - DistributionPaymentFilter
|
No related DistributionPayment matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": DistributionPaymentFilter,
"some": DistributionPaymentFilter,
"none": DistributionPaymentFilter
}
CurrencyToManyDistributionPriceFilter
Description
A filter to be used against many DistributionPrice object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - DistributionPriceFilter
|
Every related DistributionPrice matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - DistributionPriceFilter
|
Some related DistributionPrice matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - DistributionPriceFilter
|
No related DistributionPrice matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": DistributionPriceFilter,
"some": DistributionPriceFilter,
"none": DistributionPriceFilter
}
CurrencyToManyHoldingFilter
Description
A filter to be used against many Holding object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - HoldingFilter
|
Every related Holding matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - HoldingFilter
|
Some related Holding matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - HoldingFilter
|
No related Holding matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": HoldingFilter,
"some": HoldingFilter,
"none": HoldingFilter
}
CurrencyType
Fields
| Field Name | Description |
|---|---|
nodeId - ID!
|
A globally unique identifier. Can be used in various places throughout the system to identify this single value. |
type - String!
|
|
currenciesByType - CurrenciesConnection!
|
Reads and enables pagination through a set of Currency. |
Arguments
|
|
Example
{
"nodeId": "4",
"type": "xyz789",
"currenciesByType": CurrenciesConnection
}
CurrencyTypeCondition
Description
A condition to be used against CurrencyType object types. All fields are tested for equality and combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
type - String
|
Checks for equality with the object’s type field. |
Example
{"type": "xyz789"}
CurrencyTypeFilter
Description
A filter to be used against CurrencyType object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
type - StringFilter
|
Filter by the object’s type field. |
currenciesByType - CurrencyTypeToManyCurrencyFilter
|
Filter by the object’s currenciesByType relation. |
currenciesByTypeExist - Boolean
|
Some related currenciesByType exist. |
and - [CurrencyTypeFilter!]
|
Checks for all expressions in this list. |
or - [CurrencyTypeFilter!]
|
Checks for any expressions in this list. |
not - CurrencyTypeFilter
|
Negates the expression. |
Example
{
"type": StringFilter,
"currenciesByType": CurrencyTypeToManyCurrencyFilter,
"currenciesByTypeExist": false,
"and": [CurrencyTypeFilter],
"or": [CurrencyTypeFilter],
"not": CurrencyTypeFilter
}
CurrencyTypeToManyCurrencyFilter
Description
A filter to be used against many Currency object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - CurrencyFilter
|
Every related Currency matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - CurrencyFilter
|
Some related Currency matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - CurrencyFilter
|
No related Currency matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": CurrencyFilter,
"some": CurrencyFilter,
"none": CurrencyFilter
}
CurrencyTypesConnection
Description
A connection to a list of CurrencyType values.
Fields
| Field Name | Description |
|---|---|
nodes - [CurrencyType]!
|
A list of CurrencyType objects. |
edges - [CurrencyTypesEdge!]!
|
A list of edges which contains the CurrencyType and cursor to aid in pagination. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The count of all CurrencyType you could get from the connection. |
Example
{
"nodes": [CurrencyType],
"edges": [CurrencyTypesEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
CurrencyTypesEdge
Description
A CurrencyType edge in the connection.
Fields
| Field Name | Description |
|---|---|
cursor - Cursor
|
A cursor for use in pagination. |
node - CurrencyType
|
The CurrencyType at the end of the edge. |
Example
{
"cursor": Cursor,
"node": CurrencyType
}
CurrencyTypesOrderBy
Description
Methods to use when ordering CurrencyType.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NATURAL"
CurrentStep
Example
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"ownedBy": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"executeBy": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"status": "xyz789",
"type": "abc123",
"schema": {},
"inputData": {},
"outputData": {},
"dynamicData": {}
}
Cursor
Description
A location in a connection that can be used for resuming pagination.
Example
Cursor
Customer
Fields
| Field Name | Description |
|---|---|
nodeId - ID!
|
A globally unique identifier. Can be used in various places throughout the system to identify this single value. |
vendorId - UUID!
|
|
investorId - UUID!
|
|
status - String!
|
|
name - String
|
|
id - UUID!
|
|
setup - Boolean!
|
|
formationDate - Date
|
|
investorType - String
|
|
jurisdiction - UUID
|
|
accountByVendorId - Account
|
Reads a single Account that is related to this Customer. |
accountByInvestorId - Account
|
Reads a single Account that is related to this Customer. |
invitationStatusByStatus - InvitationStatus
|
Reads a single InvitationStatus that is related to this Customer. |
investorAccountTypeByInvestorType - InvestorAccountType
|
Reads a single InvestorAccountType that is related to this Customer. |
countryByJurisdiction - Country
|
Reads a single Country that is related to this Customer. |
customerPartiesByCustomerId - CustomerPartiesConnection!
|
Reads and enables pagination through a set of CustomerParty. |
Arguments
|
|
customerAddressesByCustomerId - CustomerAddressesConnection!
|
Reads and enables pagination through a set of CustomerAddress. |
Arguments
|
|
Example
{
"nodeId": 4,
"vendorId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"investorId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"status": "xyz789",
"name": "xyz789",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"setup": false,
"formationDate": "2007-12-03",
"investorType": "abc123",
"jurisdiction": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountByVendorId": Account,
"accountByInvestorId": Account,
"invitationStatusByStatus": InvitationStatus,
"investorAccountTypeByInvestorType": InvestorAccountType,
"countryByJurisdiction": Country,
"customerPartiesByCustomerId": CustomerPartiesConnection,
"customerAddressesByCustomerId": CustomerAddressesConnection
}
CustomerAddress
Fields
| Field Name | Description |
|---|---|
nodeId - ID!
|
A globally unique identifier. Can be used in various places throughout the system to identify this single value. |
id - UUID!
|
|
addressId - UUID!
|
|
customerId - UUID!
|
|
type - String!
|
|
createdOn - Datetime!
|
|
creatorUserId - UUID!
|
|
creatorAccountId - UUID!
|
|
addressByAddressId - Address
|
Reads a single Address that is related to this CustomerAddress. |
customerByCustomerId - Customer
|
Reads a single Customer that is related to this CustomerAddress. |
addressTypeByType - AddressType
|
Reads a single AddressType that is related to this CustomerAddress. |
userByCreatorUserId - User
|
Reads a single User that is related to this CustomerAddress. |
accountByCreatorAccountId - Account
|
Reads a single Account that is related to this CustomerAddress. |
Example
{
"nodeId": "4",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"addressId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"customerId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"type": "xyz789",
"createdOn": Datetime,
"creatorUserId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"creatorAccountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"addressByAddressId": Address,
"customerByCustomerId": Customer,
"addressTypeByType": AddressType,
"userByCreatorUserId": User,
"accountByCreatorAccountId": Account
}
CustomerAddressCondition
Description
A condition to be used against CustomerAddress object types. All fields are tested for equality and combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
id - UUID
|
Checks for equality with the object’s id field. |
addressId - UUID
|
Checks for equality with the object’s addressId field. |
customerId - UUID
|
Checks for equality with the object’s customerId field. |
type - String
|
Checks for equality with the object’s type field. |
createdOn - Datetime
|
Checks for equality with the object’s createdOn field. |
creatorUserId - UUID
|
Checks for equality with the object’s creatorUserId field. |
creatorAccountId - UUID
|
Checks for equality with the object’s creatorAccountId field. |
Example
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"addressId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"customerId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"type": "abc123",
"createdOn": Datetime,
"creatorUserId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"creatorAccountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
CustomerAddressFilter
Description
A filter to be used against CustomerAddress object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
id - UUIDFilter
|
Filter by the object’s id field. |
addressId - UUIDFilter
|
Filter by the object’s addressId field. |
customerId - UUIDFilter
|
Filter by the object’s customerId field. |
type - StringFilter
|
Filter by the object’s type field. |
createdOn - DatetimeFilter
|
Filter by the object’s createdOn field. |
creatorUserId - UUIDFilter
|
Filter by the object’s creatorUserId field. |
creatorAccountId - UUIDFilter
|
Filter by the object’s creatorAccountId field. |
addressByAddressId - AddressFilter
|
Filter by the object’s addressByAddressId relation. |
customerByCustomerId - CustomerFilter
|
Filter by the object’s customerByCustomerId relation. |
addressTypeByType - AddressTypeFilter
|
Filter by the object’s addressTypeByType relation. |
userByCreatorUserId - UserFilter
|
Filter by the object’s userByCreatorUserId relation. |
accountByCreatorAccountId - AccountFilter
|
Filter by the object’s accountByCreatorAccountId relation. |
and - [CustomerAddressFilter!]
|
Checks for all expressions in this list. |
or - [CustomerAddressFilter!]
|
Checks for any expressions in this list. |
not - CustomerAddressFilter
|
Negates the expression. |
Example
{
"id": UUIDFilter,
"addressId": UUIDFilter,
"customerId": UUIDFilter,
"type": StringFilter,
"createdOn": DatetimeFilter,
"creatorUserId": UUIDFilter,
"creatorAccountId": UUIDFilter,
"addressByAddressId": AddressFilter,
"customerByCustomerId": CustomerFilter,
"addressTypeByType": AddressTypeFilter,
"userByCreatorUserId": UserFilter,
"accountByCreatorAccountId": AccountFilter,
"and": [CustomerAddressFilter],
"or": [CustomerAddressFilter],
"not": CustomerAddressFilter
}
CustomerAddressesConnection
Description
A connection to a list of CustomerAddress values.
Fields
| Field Name | Description |
|---|---|
nodes - [CustomerAddress]!
|
A list of CustomerAddress objects. |
edges - [CustomerAddressesEdge!]!
|
A list of edges which contains the CustomerAddress and cursor to aid in pagination. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The count of all CustomerAddress you could get from the connection. |
Example
{
"nodes": [CustomerAddress],
"edges": [CustomerAddressesEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
CustomerAddressesEdge
Description
A CustomerAddress edge in the connection.
Fields
| Field Name | Description |
|---|---|
cursor - Cursor
|
A cursor for use in pagination. |
node - CustomerAddress
|
The CustomerAddress at the end of the edge. |
Example
{
"cursor": Cursor,
"node": CustomerAddress
}
CustomerAddressesOrderBy
Description
Methods to use when ordering CustomerAddress.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NATURAL"
CustomerCondition
Description
A condition to be used against Customer object types. All fields are tested for equality and combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
vendorId - UUID
|
Checks for equality with the object’s vendorId field. |
investorId - UUID
|
Checks for equality with the object’s investorId field. |
status - String
|
Checks for equality with the object’s status field. |
name - String
|
Checks for equality with the object’s name field. |
id - UUID
|
Checks for equality with the object’s id field. |
setup - Boolean
|
Checks for equality with the object’s setup field. |
formationDate - Date
|
Checks for equality with the object’s formationDate field. |
investorType - String
|
Checks for equality with the object’s investorType field. |
jurisdiction - UUID
|
Checks for equality with the object’s jurisdiction field. |
Example
{
"vendorId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"investorId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"status": "xyz789",
"name": "xyz789",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"setup": false,
"formationDate": "2007-12-03",
"investorType": "abc123",
"jurisdiction": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
CustomerFilter
Description
A filter to be used against Customer object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
vendorId - UUIDFilter
|
Filter by the object’s vendorId field. |
investorId - UUIDFilter
|
Filter by the object’s investorId field. |
status - StringFilter
|
Filter by the object’s status field. |
name - StringFilter
|
Filter by the object’s name field. |
id - UUIDFilter
|
Filter by the object’s id field. |
setup - BooleanFilter
|
Filter by the object’s setup field. |
formationDate - DateFilter
|
Filter by the object’s formationDate field. |
investorType - StringFilter
|
Filter by the object’s investorType field. |
jurisdiction - UUIDFilter
|
Filter by the object’s jurisdiction field. |
customerPartiesByCustomerId - CustomerToManyCustomerPartyFilter
|
Filter by the object’s customerPartiesByCustomerId relation. |
customerPartiesByCustomerIdExist - Boolean
|
Some related customerPartiesByCustomerId exist. |
customerAddressesByCustomerId - CustomerToManyCustomerAddressFilter
|
Filter by the object’s customerAddressesByCustomerId relation. |
customerAddressesByCustomerIdExist - Boolean
|
Some related customerAddressesByCustomerId exist. |
accountByVendorId - AccountFilter
|
Filter by the object’s accountByVendorId relation. |
accountByInvestorId - AccountFilter
|
Filter by the object’s accountByInvestorId relation. |
invitationStatusByStatus - InvitationStatusFilter
|
Filter by the object’s invitationStatusByStatus relation. |
investorAccountTypeByInvestorType - InvestorAccountTypeFilter
|
Filter by the object’s investorAccountTypeByInvestorType relation. |
investorAccountTypeByInvestorTypeExists - Boolean
|
A related investorAccountTypeByInvestorType exists. |
countryByJurisdiction - CountryFilter
|
Filter by the object’s countryByJurisdiction relation. |
countryByJurisdictionExists - Boolean
|
A related countryByJurisdiction exists. |
and - [CustomerFilter!]
|
Checks for all expressions in this list. |
or - [CustomerFilter!]
|
Checks for any expressions in this list. |
not - CustomerFilter
|
Negates the expression. |
Example
{
"vendorId": UUIDFilter,
"investorId": UUIDFilter,
"status": StringFilter,
"name": StringFilter,
"id": UUIDFilter,
"setup": BooleanFilter,
"formationDate": DateFilter,
"investorType": StringFilter,
"jurisdiction": UUIDFilter,
"customerPartiesByCustomerId": CustomerToManyCustomerPartyFilter,
"customerPartiesByCustomerIdExist": true,
"customerAddressesByCustomerId": CustomerToManyCustomerAddressFilter,
"customerAddressesByCustomerIdExist": false,
"accountByVendorId": AccountFilter,
"accountByInvestorId": AccountFilter,
"invitationStatusByStatus": InvitationStatusFilter,
"investorAccountTypeByInvestorType": InvestorAccountTypeFilter,
"investorAccountTypeByInvestorTypeExists": true,
"countryByJurisdiction": CountryFilter,
"countryByJurisdictionExists": false,
"and": [CustomerFilter],
"or": [CustomerFilter],
"not": CustomerFilter
}
CustomerPartiesConnection
Description
A connection to a list of CustomerParty values.
Fields
| Field Name | Description |
|---|---|
nodes - [CustomerParty]!
|
A list of CustomerParty objects. |
edges - [CustomerPartiesEdge!]!
|
A list of edges which contains the CustomerParty and cursor to aid in pagination. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The count of all CustomerParty you could get from the connection. |
Example
{
"nodes": [CustomerParty],
"edges": [CustomerPartiesEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
CustomerPartiesEdge
Description
A CustomerParty edge in the connection.
Fields
| Field Name | Description |
|---|---|
cursor - Cursor
|
A cursor for use in pagination. |
node - CustomerParty
|
The CustomerParty at the end of the edge. |
Example
{
"cursor": Cursor,
"node": CustomerParty
}
CustomerPartiesOrderBy
Description
Methods to use when ordering CustomerParty.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NATURAL"
CustomerParty
Fields
| Field Name | Description |
|---|---|
nodeId - ID!
|
A globally unique identifier. Can be used in various places throughout the system to identify this single value. |
id - UUID!
|
|
customerId - UUID!
|
|
userId - UUID!
|
|
role - String
|
|
dateOfBirth - Date!
|
|
usCitizen - Boolean!
|
|
isPrimary - Boolean!
|
|
createdOn - Datetime!
|
|
creatorUserId - UUID!
|
|
creatorAccountId - UUID!
|
|
customerByCustomerId - Customer
|
Reads a single Customer that is related to this CustomerParty. |
userByUserId - User
|
Reads a single User that is related to this CustomerParty. |
partyRoleByRole - PartyRole
|
Reads a single PartyRole that is related to this CustomerParty. |
userByCreatorUserId - User
|
Reads a single User that is related to this CustomerParty. |
accountByCreatorAccountId - Account
|
Reads a single Account that is related to this CustomerParty. |
customerPartyAddressesByCustomerPartyId - CustomerPartyAddressesConnection!
|
Reads and enables pagination through a set of CustomerPartyAddress. |
Arguments
|
|
Example
{
"nodeId": 4,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"customerId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"userId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"role": "xyz789",
"dateOfBirth": "2007-12-03",
"usCitizen": false,
"isPrimary": true,
"createdOn": Datetime,
"creatorUserId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"creatorAccountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"customerByCustomerId": Customer,
"userByUserId": User,
"partyRoleByRole": PartyRole,
"userByCreatorUserId": User,
"accountByCreatorAccountId": Account,
"customerPartyAddressesByCustomerPartyId": CustomerPartyAddressesConnection
}
CustomerPartyAddress
Fields
| Field Name | Description |
|---|---|
nodeId - ID!
|
A globally unique identifier. Can be used in various places throughout the system to identify this single value. |
id - UUID!
|
|
addressId - UUID!
|
|
customerPartyId - UUID!
|
|
type - String!
|
|
createdOn - Datetime!
|
|
creatorUserId - UUID!
|
|
creatorAccountId - UUID!
|
|
addressByAddressId - Address
|
Reads a single Address that is related to this CustomerPartyAddress. |
customerPartyByCustomerPartyId - CustomerParty
|
Reads a single CustomerParty that is related to this CustomerPartyAddress. |
addressTypeByType - AddressType
|
Reads a single AddressType that is related to this CustomerPartyAddress. |
userByCreatorUserId - User
|
Reads a single User that is related to this CustomerPartyAddress. |
accountByCreatorAccountId - Account
|
Reads a single Account that is related to this CustomerPartyAddress. |
Example
{
"nodeId": "4",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"addressId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"customerPartyId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"type": "abc123",
"createdOn": Datetime,
"creatorUserId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"creatorAccountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"addressByAddressId": Address,
"customerPartyByCustomerPartyId": CustomerParty,
"addressTypeByType": AddressType,
"userByCreatorUserId": User,
"accountByCreatorAccountId": Account
}
CustomerPartyAddressCondition
Description
A condition to be used against CustomerPartyAddress object types. All fields are tested for equality and combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
id - UUID
|
Checks for equality with the object’s id field. |
addressId - UUID
|
Checks for equality with the object’s addressId field. |
customerPartyId - UUID
|
Checks for equality with the object’s customerPartyId field. |
type - String
|
Checks for equality with the object’s type field. |
createdOn - Datetime
|
Checks for equality with the object’s createdOn field. |
creatorUserId - UUID
|
Checks for equality with the object’s creatorUserId field. |
creatorAccountId - UUID
|
Checks for equality with the object’s creatorAccountId field. |
Example
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"addressId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"customerPartyId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"type": "abc123",
"createdOn": Datetime,
"creatorUserId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"creatorAccountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
CustomerPartyAddressFilter
Description
A filter to be used against CustomerPartyAddress object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
id - UUIDFilter
|
Filter by the object’s id field. |
addressId - UUIDFilter
|
Filter by the object’s addressId field. |
customerPartyId - UUIDFilter
|
Filter by the object’s customerPartyId field. |
type - StringFilter
|
Filter by the object’s type field. |
createdOn - DatetimeFilter
|
Filter by the object’s createdOn field. |
creatorUserId - UUIDFilter
|
Filter by the object’s creatorUserId field. |
creatorAccountId - UUIDFilter
|
Filter by the object’s creatorAccountId field. |
addressByAddressId - AddressFilter
|
Filter by the object’s addressByAddressId relation. |
customerPartyByCustomerPartyId - CustomerPartyFilter
|
Filter by the object’s customerPartyByCustomerPartyId relation. |
addressTypeByType - AddressTypeFilter
|
Filter by the object’s addressTypeByType relation. |
userByCreatorUserId - UserFilter
|
Filter by the object’s userByCreatorUserId relation. |
accountByCreatorAccountId - AccountFilter
|
Filter by the object’s accountByCreatorAccountId relation. |
and - [CustomerPartyAddressFilter!]
|
Checks for all expressions in this list. |
or - [CustomerPartyAddressFilter!]
|
Checks for any expressions in this list. |
not - CustomerPartyAddressFilter
|
Negates the expression. |
Example
{
"id": UUIDFilter,
"addressId": UUIDFilter,
"customerPartyId": UUIDFilter,
"type": StringFilter,
"createdOn": DatetimeFilter,
"creatorUserId": UUIDFilter,
"creatorAccountId": UUIDFilter,
"addressByAddressId": AddressFilter,
"customerPartyByCustomerPartyId": CustomerPartyFilter,
"addressTypeByType": AddressTypeFilter,
"userByCreatorUserId": UserFilter,
"accountByCreatorAccountId": AccountFilter,
"and": [CustomerPartyAddressFilter],
"or": [CustomerPartyAddressFilter],
"not": CustomerPartyAddressFilter
}
CustomerPartyAddressesConnection
Description
A connection to a list of CustomerPartyAddress values.
Fields
| Field Name | Description |
|---|---|
nodes - [CustomerPartyAddress]!
|
A list of CustomerPartyAddress objects. |
edges - [CustomerPartyAddressesEdge!]!
|
A list of edges which contains the CustomerPartyAddress and cursor to aid in pagination. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The count of all CustomerPartyAddress you could get from the connection. |
Example
{
"nodes": [CustomerPartyAddress],
"edges": [CustomerPartyAddressesEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
CustomerPartyAddressesEdge
Description
A CustomerPartyAddress edge in the connection.
Fields
| Field Name | Description |
|---|---|
cursor - Cursor
|
A cursor for use in pagination. |
node - CustomerPartyAddress
|
The CustomerPartyAddress at the end of the edge. |
Example
{
"cursor": Cursor,
"node": CustomerPartyAddress
}
CustomerPartyAddressesOrderBy
Description
Methods to use when ordering CustomerPartyAddress.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NATURAL"
CustomerPartyCondition
Description
A condition to be used against CustomerParty object types. All fields are tested for equality and combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
id - UUID
|
Checks for equality with the object’s id field. |
customerId - UUID
|
Checks for equality with the object’s customerId field. |
userId - UUID
|
Checks for equality with the object’s userId field. |
role - String
|
Checks for equality with the object’s role field. |
dateOfBirth - Date
|
Checks for equality with the object’s dateOfBirth field. |
usCitizen - Boolean
|
Checks for equality with the object’s usCitizen field. |
isPrimary - Boolean
|
Checks for equality with the object’s isPrimary field. |
createdOn - Datetime
|
Checks for equality with the object’s createdOn field. |
creatorUserId - UUID
|
Checks for equality with the object’s creatorUserId field. |
creatorAccountId - UUID
|
Checks for equality with the object’s creatorAccountId field. |
Example
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"customerId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"userId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"role": "xyz789",
"dateOfBirth": "2007-12-03",
"usCitizen": false,
"isPrimary": false,
"createdOn": Datetime,
"creatorUserId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"creatorAccountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
CustomerPartyFilter
Description
A filter to be used against CustomerParty object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
id - UUIDFilter
|
Filter by the object’s id field. |
customerId - UUIDFilter
|
Filter by the object’s customerId field. |
userId - UUIDFilter
|
Filter by the object’s userId field. |
role - StringFilter
|
Filter by the object’s role field. |
dateOfBirth - DateFilter
|
Filter by the object’s dateOfBirth field. |
usCitizen - BooleanFilter
|
Filter by the object’s usCitizen field. |
isPrimary - BooleanFilter
|
Filter by the object’s isPrimary field. |
createdOn - DatetimeFilter
|
Filter by the object’s createdOn field. |
creatorUserId - UUIDFilter
|
Filter by the object’s creatorUserId field. |
creatorAccountId - UUIDFilter
|
Filter by the object’s creatorAccountId field. |
customerPartyAddressesByCustomerPartyId - CustomerPartyToManyCustomerPartyAddressFilter
|
Filter by the object’s customerPartyAddressesByCustomerPartyId relation. |
customerPartyAddressesByCustomerPartyIdExist - Boolean
|
Some related customerPartyAddressesByCustomerPartyId exist. |
customerByCustomerId - CustomerFilter
|
Filter by the object’s customerByCustomerId relation. |
userByUserId - UserFilter
|
Filter by the object’s userByUserId relation. |
partyRoleByRole - PartyRoleFilter
|
Filter by the object’s partyRoleByRole relation. |
partyRoleByRoleExists - Boolean
|
A related partyRoleByRole exists. |
userByCreatorUserId - UserFilter
|
Filter by the object’s userByCreatorUserId relation. |
accountByCreatorAccountId - AccountFilter
|
Filter by the object’s accountByCreatorAccountId relation. |
and - [CustomerPartyFilter!]
|
Checks for all expressions in this list. |
or - [CustomerPartyFilter!]
|
Checks for any expressions in this list. |
not - CustomerPartyFilter
|
Negates the expression. |
Example
{
"id": UUIDFilter,
"customerId": UUIDFilter,
"userId": UUIDFilter,
"role": StringFilter,
"dateOfBirth": DateFilter,
"usCitizen": BooleanFilter,
"isPrimary": BooleanFilter,
"createdOn": DatetimeFilter,
"creatorUserId": UUIDFilter,
"creatorAccountId": UUIDFilter,
"customerPartyAddressesByCustomerPartyId": CustomerPartyToManyCustomerPartyAddressFilter,
"customerPartyAddressesByCustomerPartyIdExist": true,
"customerByCustomerId": CustomerFilter,
"userByUserId": UserFilter,
"partyRoleByRole": PartyRoleFilter,
"partyRoleByRoleExists": true,
"userByCreatorUserId": UserFilter,
"accountByCreatorAccountId": AccountFilter,
"and": [CustomerPartyFilter],
"or": [CustomerPartyFilter],
"not": CustomerPartyFilter
}
CustomerPartyToManyCustomerPartyAddressFilter
Description
A filter to be used against many CustomerPartyAddress object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - CustomerPartyAddressFilter
|
Every related CustomerPartyAddress matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - CustomerPartyAddressFilter
|
Some related CustomerPartyAddress matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - CustomerPartyAddressFilter
|
No related CustomerPartyAddress matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": CustomerPartyAddressFilter,
"some": CustomerPartyAddressFilter,
"none": CustomerPartyAddressFilter
}
CustomerPatch
Description
Represents an update to a Customer. Fields that are set will be updated.
Example
{
"vendorId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"investorId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"status": "abc123",
"name": "xyz789",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"setup": false,
"formationDate": "2007-12-03",
"investorType": "xyz789",
"jurisdiction": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
CustomerToManyCustomerAddressFilter
Description
A filter to be used against many CustomerAddress object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - CustomerAddressFilter
|
Every related CustomerAddress matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - CustomerAddressFilter
|
Some related CustomerAddress matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - CustomerAddressFilter
|
No related CustomerAddress matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": CustomerAddressFilter,
"some": CustomerAddressFilter,
"none": CustomerAddressFilter
}
CustomerToManyCustomerPartyFilter
Description
A filter to be used against many CustomerParty object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - CustomerPartyFilter
|
Every related CustomerParty matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - CustomerPartyFilter
|
Some related CustomerParty matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - CustomerPartyFilter
|
No related CustomerParty matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": CustomerPartyFilter,
"some": CustomerPartyFilter,
"none": CustomerPartyFilter
}
CustomersConnection
Description
A connection to a list of Customer values.
Fields
| Field Name | Description |
|---|---|
nodes - [Customer]!
|
A list of Customer objects. |
edges - [CustomersEdge!]!
|
A list of edges which contains the Customer and cursor to aid in pagination. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The count of all Customer you could get from the connection. |
Example
{
"nodes": [Customer],
"edges": [CustomersEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
CustomersEdge
CustomersOrderBy
Description
Methods to use when ordering Customer.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NATURAL"
Date
Description
The day, does not include a time.
Example
"2007-12-03"
DateFilter
Description
A filter to be used against Date fields. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
isNull - Boolean
|
Is null (if true is specified) or is not null (if false is specified). |
equalTo - Date
|
Equal to the specified value. |
notEqualTo - Date
|
Not equal to the specified value. |
distinctFrom - Date
|
Not equal to the specified value, treating null like an ordinary value. |
notDistinctFrom - Date
|
Equal to the specified value, treating null like an ordinary value. |
in - [Date!]
|
Included in the specified list. |
notIn - [Date!]
|
Not included in the specified list. |
lessThan - Date
|
Less than the specified value. |
lessThanOrEqualTo - Date
|
Less than or equal to the specified value. |
greaterThan - Date
|
Greater than the specified value. |
greaterThanOrEqualTo - Date
|
Greater than or equal to the specified value. |
Example
{
"isNull": true,
"equalTo": "2007-12-03",
"notEqualTo": "2007-12-03",
"distinctFrom": "2007-12-03",
"notDistinctFrom": "2007-12-03",
"in": ["2007-12-03"],
"notIn": ["2007-12-03"],
"lessThan": "2007-12-03",
"lessThanOrEqualTo": "2007-12-03",
"greaterThan": "2007-12-03",
"greaterThanOrEqualTo": "2007-12-03"
}
Datetime
Description
A point in time as described by the ISO 8601 standard. May or may not include a timezone.
Example
Datetime
DatetimeFilter
Description
A filter to be used against Datetime fields. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
isNull - Boolean
|
Is null (if true is specified) or is not null (if false is specified). |
equalTo - Datetime
|
Equal to the specified value. |
notEqualTo - Datetime
|
Not equal to the specified value. |
distinctFrom - Datetime
|
Not equal to the specified value, treating null like an ordinary value. |
notDistinctFrom - Datetime
|
Equal to the specified value, treating null like an ordinary value. |
in - [Datetime!]
|
Included in the specified list. |
notIn - [Datetime!]
|
Not included in the specified list. |
lessThan - Datetime
|
Less than the specified value. |
lessThanOrEqualTo - Datetime
|
Less than or equal to the specified value. |
greaterThan - Datetime
|
Greater than the specified value. |
greaterThanOrEqualTo - Datetime
|
Greater than or equal to the specified value. |
Example
{
"isNull": false,
"equalTo": Datetime,
"notEqualTo": Datetime,
"distinctFrom": Datetime,
"notDistinctFrom": Datetime,
"in": [Datetime],
"notIn": [Datetime],
"lessThan": Datetime,
"lessThanOrEqualTo": Datetime,
"greaterThan": Datetime,
"greaterThanOrEqualTo": Datetime
}
DefaultMappingField
Example
{
"nodeId": "4",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"field": "xyz789",
"description": "xyz789"
}
DefaultMappingFieldCondition
Description
A condition to be used against DefaultMappingField object types. All fields are tested for equality and combined with a logical ‘and.’
Example
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"field": "xyz789",
"description": "xyz789"
}
DefaultMappingFieldFilter
Description
A filter to be used against DefaultMappingField object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
id - UUIDFilter
|
Filter by the object’s id field. |
field - StringFilter
|
Filter by the object’s field field. |
description - StringFilter
|
Filter by the object’s description field. |
and - [DefaultMappingFieldFilter!]
|
Checks for all expressions in this list. |
or - [DefaultMappingFieldFilter!]
|
Checks for any expressions in this list. |
not - DefaultMappingFieldFilter
|
Negates the expression. |
Example
{
"id": UUIDFilter,
"field": StringFilter,
"description": StringFilter,
"and": [DefaultMappingFieldFilter],
"or": [DefaultMappingFieldFilter],
"not": DefaultMappingFieldFilter
}
DefaultMappingFieldsConnection
Description
A connection to a list of DefaultMappingField values.
Fields
| Field Name | Description |
|---|---|
nodes - [DefaultMappingField]!
|
A list of DefaultMappingField objects. |
edges - [DefaultMappingFieldsEdge!]!
|
A list of edges which contains the DefaultMappingField and cursor to aid in pagination. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The count of all DefaultMappingField you could get from the connection. |
Example
{
"nodes": [DefaultMappingField],
"edges": [DefaultMappingFieldsEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
DefaultMappingFieldsEdge
Description
A DefaultMappingField edge in the connection.
Fields
| Field Name | Description |
|---|---|
cursor - Cursor
|
A cursor for use in pagination. |
node - DefaultMappingField
|
The DefaultMappingField at the end of the edge. |
Example
{
"cursor": Cursor,
"node": DefaultMappingField
}
DefaultMappingFieldsOrderBy
Description
Methods to use when ordering DefaultMappingField.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NATURAL"
DeleteAccountPhoneNumberByAccountIdAndTypeInput
Description
All input for the deleteAccountPhoneNumberByAccountIdAndType mutation.
Example
{
"clientMutationId": "xyz789",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"type": "abc123"
}
DeleteAccountPhoneNumberByIdInput
Description
All input for the deleteAccountPhoneNumberById mutation.
Example
{
"clientMutationId": "abc123",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
DeleteAccountPhoneNumberInput
Description
All input for the deleteAccountPhoneNumber mutation.
Example
{"clientMutationId": "abc123", "nodeId": 4}
DeleteAccountPhoneNumberPayload
Description
The output of our delete AccountPhoneNumber mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
The exact same clientMutationId that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations. |
accountPhoneNumber - AccountPhoneNumber
|
The AccountPhoneNumber that was deleted by this mutation. |
deletedAccountPhoneNumberId - ID
|
|
query - Query
|
Our root query field type. Allows us to run any query from our mutation payload. |
accountByAccountId - Account
|
Reads a single Account that is related to this AccountPhoneNumber. |
phoneNumberTypeByType - PhoneNumberType
|
Reads a single PhoneNumberType that is related to this AccountPhoneNumber. |
accountPhoneNumberEdge - AccountPhoneNumbersEdge
|
An edge for our AccountPhoneNumber. May be used by Relay 1. |
Arguments
|
|
Example
{
"clientMutationId": "abc123",
"accountPhoneNumber": AccountPhoneNumber,
"deletedAccountPhoneNumberId": "4",
"query": Query,
"accountByAccountId": Account,
"phoneNumberTypeByType": PhoneNumberType,
"accountPhoneNumberEdge": AccountPhoneNumbersEdge
}
DeleteAccountRestrictionByAccountIdAndReasonIdInput
Description
All input for the deleteAccountRestrictionByAccountIdAndReasonId mutation.
Example
{
"clientMutationId": "abc123",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"reasonId": 987
}
DeleteAccountRestrictionByIdInput
Description
All input for the deleteAccountRestrictionById mutation.
Example
{
"clientMutationId": "xyz789",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
DeleteAccountRestrictionInput
Description
All input for the deleteAccountRestriction mutation.
Example
{"clientMutationId": "xyz789", "nodeId": 4}
DeleteAccountRestrictionPayload
Description
The output of our delete AccountRestriction mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
The exact same clientMutationId that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations. |
accountRestriction - AccountRestriction
|
The AccountRestriction that was deleted by this mutation. |
deletedAccountRestrictionId - ID
|
|
query - Query
|
Our root query field type. Allows us to run any query from our mutation payload. |
accountByAccountId - Account
|
Reads a single Account that is related to this AccountRestriction. |
restrictionReasonByReasonId - RestrictionReason
|
Reads a single RestrictionReason that is related to this AccountRestriction. |
userByCreatorUserId - User
|
Reads a single User that is related to this AccountRestriction. |
accountByCreatorAccountId - Account
|
Reads a single Account that is related to this AccountRestriction. |
accountRestrictionEdge - AccountRestrictionsEdge
|
An edge for our AccountRestriction. May be used by Relay 1. |
Arguments
|
|
Example
{
"clientMutationId": "abc123",
"accountRestriction": AccountRestriction,
"deletedAccountRestrictionId": 4,
"query": Query,
"accountByAccountId": Account,
"restrictionReasonByReasonId": RestrictionReason,
"userByCreatorUserId": User,
"accountByCreatorAccountId": Account,
"accountRestrictionEdge": AccountRestrictionsEdge
}
DeleteAllocationAnnotationByIdInput
Description
All input for the deleteAllocationAnnotationById mutation.
Example
{
"clientMutationId": "abc123",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
DeleteAllocationAnnotationInput
Description
All input for the deleteAllocationAnnotation mutation.
Example
{
"clientMutationId": "abc123",
"nodeId": "4"
}
DeleteAllocationAnnotationPayload
Description
The output of our delete AllocationAnnotation mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
The exact same clientMutationId that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations. |
allocationAnnotation - AllocationAnnotation
|
The AllocationAnnotation that was deleted by this mutation. |
deletedAllocationAnnotationId - ID
|
|
query - Query
|
Our root query field type. Allows us to run any query from our mutation payload. |
allocationByAllocationId - Allocation
|
Reads a single Allocation that is related to this AllocationAnnotation. |
userByWrittenBy - User
|
Reads a single User that is related to this AllocationAnnotation. |
accountByAccountId - Account
|
Reads a single Account that is related to this AllocationAnnotation. |
allocationAnnotationEdge - AllocationAnnotationsEdge
|
An edge for our AllocationAnnotation. May be used by Relay 1. |
Arguments
|
|
Example
{
"clientMutationId": "xyz789",
"allocationAnnotation": AllocationAnnotation,
"deletedAllocationAnnotationId": 4,
"query": Query,
"allocationByAllocationId": Allocation,
"userByWrittenBy": User,
"accountByAccountId": Account,
"allocationAnnotationEdge": AllocationAnnotationsEdge
}
DeleteAllocationQualificationByAllocationIdAndVendorQualificationIdInput
Description
All input for the deleteAllocationQualificationByAllocationIdAndVendorQualificationId mutation.
Example
{
"clientMutationId": "xyz789",
"allocationId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"vendorQualificationId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
DeleteAllocationQualificationByIdInput
Description
All input for the deleteAllocationQualificationById mutation.
Example
{
"clientMutationId": "abc123",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
DeleteAllocationQualificationInput
Description
All input for the deleteAllocationQualification mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
nodeId - ID!
|
The globally unique ID which will identify a single AllocationQualification to be deleted. |
Example
{
"clientMutationId": "abc123",
"nodeId": "4"
}
DeleteAllocationQualificationPayload
Description
The output of our delete AllocationQualification mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
The exact same clientMutationId that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations. |
allocationQualification - AllocationQualification
|
The AllocationQualification that was deleted by this mutation. |
deletedAllocationQualificationId - ID
|
|
query - Query
|
Our root query field type. Allows us to run any query from our mutation payload. |
allocationByAllocationId - Allocation
|
Reads a single Allocation that is related to this AllocationQualification. |
vendorQualificationByVendorQualificationId - VendorQualification
|
Reads a single VendorQualification that is related to this AllocationQualification. |
allocationQualificationEdge - AllocationQualificationsEdge
|
An edge for our AllocationQualification. May be used by Relay 1. |
Arguments
|
|
Example
{
"clientMutationId": "xyz789",
"allocationQualification": AllocationQualification,
"deletedAllocationQualificationId": 4,
"query": Query,
"allocationByAllocationId": Allocation,
"vendorQualificationByVendorQualificationId": VendorQualification,
"allocationQualificationEdge": AllocationQualificationsEdge
}
DeleteAllocationsVestingScheduleByAllocationIdInput
Description
All input for the deleteAllocationsVestingScheduleByAllocationId mutation.
Example
{
"clientMutationId": "xyz789",
"allocationId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
DeleteAllocationsVestingScheduleByIdInput
Description
All input for the deleteAllocationsVestingScheduleById mutation.
Example
{
"clientMutationId": "abc123",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
DeleteAllocationsVestingScheduleInput
Description
All input for the deleteAllocationsVestingSchedule mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
nodeId - ID!
|
The globally unique ID which will identify a single AllocationsVestingSchedule to be deleted. |
Example
{
"clientMutationId": "xyz789",
"nodeId": "4"
}
DeleteAllocationsVestingSchedulePayload
Description
The output of our delete AllocationsVestingSchedule mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
The exact same clientMutationId that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations. |
allocationsVestingSchedule - AllocationsVestingSchedule
|
The AllocationsVestingSchedule that was deleted by this mutation. |
deletedAllocationsVestingScheduleId - ID
|
|
query - Query
|
Our root query field type. Allows us to run any query from our mutation payload. |
allocationByAllocationId - Allocation
|
Reads a single Allocation that is related to this AllocationsVestingSchedule. |
vestingDurationByDuration - VestingDuration
|
Reads a single VestingDuration that is related to this AllocationsVestingSchedule. |
allocationsVestingScheduleEdge - AllocationsVestingSchedulesEdge
|
An edge for our AllocationsVestingSchedule. May be used by Relay 1. |
Arguments
|
|
Example
{
"clientMutationId": "abc123",
"allocationsVestingSchedule": AllocationsVestingSchedule,
"deletedAllocationsVestingScheduleId": 4,
"query": Query,
"allocationByAllocationId": Allocation,
"vestingDurationByDuration": VestingDuration,
"allocationsVestingScheduleEdge": AllocationsVestingSchedulesEdge
}
DeleteAssetAnnotationByIdInput
Description
All input for the deleteAssetAnnotationById mutation.
Example
{
"clientMutationId": "abc123",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
DeleteAssetAnnotationInput
Description
All input for the deleteAssetAnnotation mutation.
Example
{
"clientMutationId": "xyz789",
"nodeId": "4"
}
DeleteAssetAnnotationPayload
Description
The output of our delete AssetAnnotation mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
The exact same clientMutationId that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations. |
assetAnnotation - AssetAnnotation
|
The AssetAnnotation that was deleted by this mutation. |
deletedAssetAnnotationId - ID
|
|
query - Query
|
Our root query field type. Allows us to run any query from our mutation payload. |
assetByAssetId - Asset
|
Reads a single Asset that is related to this AssetAnnotation. |
userByWrittenBy - User
|
Reads a single User that is related to this AssetAnnotation. |
accountByAccountId - Account
|
Reads a single Account that is related to this AssetAnnotation. |
assetAnnotationEdge - AssetAnnotationsEdge
|
An edge for our AssetAnnotation. May be used by Relay 1. |
Arguments
|
|
Example
{
"clientMutationId": "xyz789",
"assetAnnotation": AssetAnnotation,
"deletedAssetAnnotationId": "4",
"query": Query,
"assetByAssetId": Asset,
"userByWrittenBy": User,
"accountByAccountId": Account,
"assetAnnotationEdge": AssetAnnotationsEdge
}
DeleteAuxAccountByTypeInput
Description
All input for the deleteAuxAccountByType mutation.
Example
{
"clientMutationId": "abc123",
"type": "abc123"
}
DeleteAuxAccountInput
Description
All input for the deleteAuxAccount mutation.
Example
{
"clientMutationId": "abc123",
"nodeId": "4"
}
DeleteAuxAccountPayload
Description
The output of our delete AuxAccount mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
The exact same clientMutationId that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations. |
auxAccount - AuxAccount
|
The AuxAccount that was deleted by this mutation. |
deletedAccountTypeId - ID
|
|
query - Query
|
Our root query field type. Allows us to run any query from our mutation payload. |
auxAccountEdge - AuxAccountsEdge
|
An edge for our AuxAccount. May be used by Relay 1. |
Arguments
|
|
Example
{
"clientMutationId": "abc123",
"auxAccount": AuxAccount,
"deletedAccountTypeId": "4",
"query": Query,
"auxAccountEdge": AuxAccountsEdge
}
DeleteAuxRoleByRoleInput
Description
All input for the deleteAuxRoleByRole mutation.
Example
{
"clientMutationId": "abc123",
"role": "xyz789"
}
DeleteAuxRoleInput
Description
All input for the deleteAuxRole mutation.
Example
{
"clientMutationId": "xyz789",
"nodeId": "4"
}
DeleteAuxRolePayload
Description
The output of our delete AuxRole mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
The exact same clientMutationId that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations. |
auxRole - AuxRole
|
The AuxRole that was deleted by this mutation. |
deletedRoleId - ID
|
|
query - Query
|
Our root query field type. Allows us to run any query from our mutation payload. |
auxRoleEdge - AuxRolesEdge
|
An edge for our AuxRole. May be used by Relay 1. |
Arguments
|
|
Example
{
"clientMutationId": "xyz789",
"auxRole": AuxRole,
"deletedRoleId": "4",
"query": Query,
"auxRoleEdge": AuxRolesEdge
}
DeleteCustomerByIdInput
Description
All input for the deleteCustomerById mutation.
Example
{
"clientMutationId": "abc123",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
DeleteCustomerByVendorIdAndInvestorIdInput
Description
All input for the deleteCustomerByVendorIdAndInvestorId mutation.
Example
{
"clientMutationId": "xyz789",
"vendorId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"investorId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
DeleteCustomerInput
Description
All input for the deleteCustomer mutation.
Example
{"clientMutationId": "xyz789", "nodeId": 4}
DeleteCustomerPayload
Description
The output of our delete Customer mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
The exact same clientMutationId that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations. |
customer - Customer
|
The Customer that was deleted by this mutation. |
deletedCustomerId - ID
|
|
query - Query
|
Our root query field type. Allows us to run any query from our mutation payload. |
accountByVendorId - Account
|
Reads a single Account that is related to this Customer. |
accountByInvestorId - Account
|
Reads a single Account that is related to this Customer. |
invitationStatusByStatus - InvitationStatus
|
Reads a single InvitationStatus that is related to this Customer. |
investorAccountTypeByInvestorType - InvestorAccountType
|
Reads a single InvestorAccountType that is related to this Customer. |
countryByJurisdiction - Country
|
Reads a single Country that is related to this Customer. |
customerEdge - CustomersEdge
|
An edge for our Customer. May be used by Relay 1. |
Arguments
|
|
Example
{
"clientMutationId": "xyz789",
"customer": Customer,
"deletedCustomerId": "4",
"query": Query,
"accountByVendorId": Account,
"accountByInvestorId": Account,
"invitationStatusByStatus": InvitationStatus,
"investorAccountTypeByInvestorType": InvestorAccountType,
"countryByJurisdiction": Country,
"customerEdge": CustomersEdge
}
DeleteDistributionAnnotationByIdInput
Description
All input for the deleteDistributionAnnotationById mutation.
Example
{
"clientMutationId": "abc123",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
DeleteDistributionAnnotationInput
Description
All input for the deleteDistributionAnnotation mutation.
Example
{"clientMutationId": "xyz789", "nodeId": 4}
DeleteDistributionAnnotationPayload
Description
The output of our delete DistributionAnnotation mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
The exact same clientMutationId that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations. |
distributionAnnotation - DistributionAnnotation
|
The DistributionAnnotation that was deleted by this mutation. |
deletedDistributionAnnotationId - ID
|
|
query - Query
|
Our root query field type. Allows us to run any query from our mutation payload. |
distributionByDistributionId - Distribution
|
Reads a single Distribution that is related to this DistributionAnnotation. |
userByWrittenBy - User
|
Reads a single User that is related to this DistributionAnnotation. |
accountByAccountId - Account
|
Reads a single Account that is related to this DistributionAnnotation. |
distributionAnnotationEdge - DistributionAnnotationsEdge
|
An edge for our DistributionAnnotation. May be used by Relay 1. |
Arguments
|
|
Example
{
"clientMutationId": "xyz789",
"distributionAnnotation": DistributionAnnotation,
"deletedDistributionAnnotationId": 4,
"query": Query,
"distributionByDistributionId": Distribution,
"userByWrittenBy": User,
"accountByAccountId": Account,
"distributionAnnotationEdge": DistributionAnnotationsEdge
}
DeleteDistributionByClosedBlockchainIdInput
Description
All input for the deleteDistributionByClosedBlockchainId mutation.
Example
{
"clientMutationId": "xyz789",
"closedBlockchainId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
DeleteDistributionByDraftedBlockchainIdInput
Description
All input for the deleteDistributionByDraftedBlockchainId mutation.
Example
{
"clientMutationId": "xyz789",
"draftedBlockchainId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
DeleteDistributionByIdInput
Description
All input for the deleteDistributionById mutation.
Example
{
"clientMutationId": "xyz789",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
DeleteDistributionByLockedBlockchainIdInput
Description
All input for the deleteDistributionByLockedBlockchainId mutation.
Example
{
"clientMutationId": "abc123",
"lockedBlockchainId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
DeleteDistributionByNewIdInput
Description
All input for the deleteDistributionByNewId mutation.
Example
{
"clientMutationId": "abc123",
"newId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
DeleteDistributionByOpenBlockchainIdInput
Description
All input for the deleteDistributionByOpenBlockchainId mutation.
Example
{
"clientMutationId": "abc123",
"openBlockchainId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
DeleteDistributionByStepIdInput
Description
All input for the deleteDistributionByStepId mutation.
Example
{
"clientMutationId": "xyz789",
"stepId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
DeleteDistributionCustomFieldByIdInput
Description
All input for the deleteDistributionCustomFieldById mutation.
Example
{
"clientMutationId": "xyz789",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
DeleteDistributionCustomFieldInput
Description
All input for the deleteDistributionCustomField mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
nodeId - ID!
|
The globally unique ID which will identify a single DistributionCustomField to be deleted. |
Example
{"clientMutationId": "abc123", "nodeId": 4}
DeleteDistributionCustomFieldPayload
Description
The output of our delete DistributionCustomField mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
The exact same clientMutationId that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations. |
distributionCustomField - DistributionCustomField
|
The DistributionCustomField that was deleted by this mutation. |
deletedDistributionCustomFieldId - ID
|
|
query - Query
|
Our root query field type. Allows us to run any query from our mutation payload. |
accountByCreatedBy - Account
|
Reads a single Account that is related to this DistributionCustomField. |
distributionByDistributionId - Distribution
|
Reads a single Distribution that is related to this DistributionCustomField. |
distributionCustomFieldEdge - DistributionCustomFieldsEdge
|
An edge for our DistributionCustomField. May be used by Relay 1. |
Arguments
|
|
Example
{
"clientMutationId": "abc123",
"distributionCustomField": DistributionCustomField,
"deletedDistributionCustomFieldId": "4",
"query": Query,
"accountByCreatedBy": Account,
"distributionByDistributionId": Distribution,
"distributionCustomFieldEdge": DistributionCustomFieldsEdge
}
DeleteDistributionInput
Description
All input for the deleteDistribution mutation.
Example
{"clientMutationId": "xyz789", "nodeId": 4}
DeleteDistributionPayload
Description
The output of our delete Distribution mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
The exact same clientMutationId that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations. |
distribution - Distribution
|
The Distribution that was deleted by this mutation. |
deletedDistributionId - ID
|
|
query - Query
|
Our root query field type. Allows us to run any query from our mutation payload. |
allocationByAllocationId - Allocation
|
Reads a single Allocation that is related to this Distribution. |
accountByInvestorId - Account
|
Reads a single Account that is related to this Distribution. |
distributionStatusByStatus - DistributionStatus
|
Reads a single DistributionStatus that is related to this Distribution. |
stepByStepId - Step
|
Reads a single Step that is related to this Distribution. |
distributionEdge - DistributionsEdge
|
An edge for our Distribution. May be used by Relay 1. |
Arguments
|
|
Example
{
"clientMutationId": "xyz789",
"distribution": Distribution,
"deletedDistributionId": 4,
"query": Query,
"allocationByAllocationId": Allocation,
"accountByInvestorId": Account,
"distributionStatusByStatus": DistributionStatus,
"stepByStepId": Step,
"distributionEdge": DistributionsEdge
}
DeleteDistributionPaymentByIdInput
Description
All input for the deleteDistributionPaymentById mutation.
Example
{
"clientMutationId": "abc123",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
DeleteDistributionPaymentInput
Description
All input for the deleteDistributionPayment mutation.
Example
{"clientMutationId": "xyz789", "nodeId": 4}
DeleteDistributionPaymentPayload
Description
The output of our delete DistributionPayment mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
The exact same clientMutationId that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations. |
distributionPayment - DistributionPayment
|
The DistributionPayment that was deleted by this mutation. |
deletedDistributionPaymentId - ID
|
|
query - Query
|
Our root query field type. Allows us to run any query from our mutation payload. |
distributionByDistributionId - Distribution
|
Reads a single Distribution that is related to this DistributionPayment. |
currencyByCurrency - Currency
|
Reads a single Currency that is related to this DistributionPayment. |
distributionPaymentStatusByStatus - DistributionPaymentStatus
|
Reads a single DistributionPaymentStatus that is related to this DistributionPayment. |
distributionPaymentEdge - DistributionPaymentsEdge
|
An edge for our DistributionPayment. May be used by Relay 1. |
Arguments
|
|
Example
{
"clientMutationId": "xyz789",
"distributionPayment": DistributionPayment,
"deletedDistributionPaymentId": "4",
"query": Query,
"distributionByDistributionId": Distribution,
"currencyByCurrency": Currency,
"distributionPaymentStatusByStatus": DistributionPaymentStatus,
"distributionPaymentEdge": DistributionPaymentsEdge
}
DeleteDistributionQualificationByDistributionIdAndVendorQualificationIdInput
Description
All input for the deleteDistributionQualificationByDistributionIdAndVendorQualificationId mutation.
Example
{
"clientMutationId": "xyz789",
"distributionId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"vendorQualificationId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
DeleteDistributionQualificationByIdInput
Description
All input for the deleteDistributionQualificationById mutation.
Example
{
"clientMutationId": "abc123",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
DeleteDistributionQualificationInput
Description
All input for the deleteDistributionQualification mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
nodeId - ID!
|
The globally unique ID which will identify a single DistributionQualification to be deleted. |
Example
{
"clientMutationId": "xyz789",
"nodeId": "4"
}
DeleteDistributionQualificationPayload
Description
The output of our delete DistributionQualification mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
The exact same clientMutationId that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations. |
distributionQualification - DistributionQualification
|
The DistributionQualification that was deleted by this mutation. |
deletedDistributionQualificationId - ID
|
|
query - Query
|
Our root query field type. Allows us to run any query from our mutation payload. |
vendorQualificationByVendorQualificationId - VendorQualification
|
Reads a single VendorQualification that is related to this DistributionQualification. |
distributionByDistributionId - Distribution
|
Reads a single Distribution that is related to this DistributionQualification. |
integrationByIntegrationId - Integration
|
Reads a single Integration that is related to this DistributionQualification. |
stepByStepId - Step
|
Reads a single Step that is related to this DistributionQualification. |
distributionQualificationEdge - DistributionQualificationsEdge
|
An edge for our DistributionQualification. May be used by Relay 1. |
Arguments
|
|
Example
{
"clientMutationId": "abc123",
"distributionQualification": DistributionQualification,
"deletedDistributionQualificationId": "4",
"query": Query,
"vendorQualificationByVendorQualificationId": VendorQualification,
"distributionByDistributionId": Distribution,
"integrationByIntegrationId": Integration,
"stepByStepId": Step,
"distributionQualificationEdge": DistributionQualificationsEdge
}
DeleteDocumentSharingByIdInput
Description
All input for the deleteDocumentSharingById mutation.
Example
{
"clientMutationId": "xyz789",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
DeleteDocumentSharingInput
Description
All input for the deleteDocumentSharing mutation.
Example
{"clientMutationId": "xyz789", "nodeId": 4}
DeleteDocumentSharingPayload
Description
The output of our delete DocumentSharing mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
The exact same clientMutationId that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations. |
documentSharing - DocumentSharing
|
The DocumentSharing that was deleted by this mutation. |
deletedDocumentSharingId - ID
|
|
query - Query
|
Our root query field type. Allows us to run any query from our mutation payload. |
documentByDocumentId - Document
|
Reads a single Document that is related to this DocumentSharing. |
accountByUploaderId - Account
|
Reads a single Account that is related to this DocumentSharing. |
documentSharingRoleByToRole - DocumentSharingRole
|
Reads a single DocumentSharingRole that is related to this DocumentSharing. |
userByCreatedBy - User
|
Reads a single User that is related to this DocumentSharing. |
documentSharingEdge - DocumentSharingsEdge
|
An edge for our DocumentSharing. May be used by Relay 1. |
Arguments
|
|
Example
{
"clientMutationId": "xyz789",
"documentSharing": DocumentSharing,
"deletedDocumentSharingId": "4",
"query": Query,
"documentByDocumentId": Document,
"accountByUploaderId": Account,
"documentSharingRoleByToRole": DocumentSharingRole,
"userByCreatedBy": User,
"documentSharingEdge": DocumentSharingsEdge
}
DeleteEmailTemplateToByToInput
Description
All input for the deleteEmailTemplateToByTo mutation.
Example
{
"clientMutationId": "abc123",
"to": "xyz789"
}
DeleteEmailTemplateToInput
Description
All input for the deleteEmailTemplateTo mutation.
Example
{"clientMutationId": "abc123", "nodeId": 4}
DeleteEmailTemplateToPayload
Description
The output of our delete EmailTemplateTo mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
The exact same clientMutationId that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations. |
emailTemplateTo - EmailTemplateTo
|
The EmailTemplateTo that was deleted by this mutation. |
deletedEmailTemplateToId - ID
|
|
query - Query
|
Our root query field type. Allows us to run any query from our mutation payload. |
emailTemplateToEdge - EmailTemplateTosEdge
|
An edge for our EmailTemplateTo. May be used by Relay 1. |
Arguments
|
|
Example
{
"clientMutationId": "abc123",
"emailTemplateTo": EmailTemplateTo,
"deletedEmailTemplateToId": 4,
"query": Query,
"emailTemplateToEdge": EmailTemplateTosEdge
}
DeleteHoldingDocumentInput
Description
All input for the deleteHoldingDocument mutation.
Example
{
"clientMutationId": "xyz789",
"holdingDocumentId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
DeleteHoldingDocumentPayload
Description
The output of our deleteHoldingDocument mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
The exact same clientMutationId that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations. |
holdingDocument - HoldingDocument
|
|
query - Query
|
Our root query field type. Allows us to run any query from our mutation payload. |
documentByDocumentId - Document
|
Reads a single Document that is related to this HoldingDocument. |
holdingByHoldingId - Holding
|
Reads a single Holding that is related to this HoldingDocument. |
holdingDocumentEdge - HoldingDocumentsEdge
|
An edge for our HoldingDocument. May be used by Relay 1. |
Arguments
|
|
Example
{
"clientMutationId": "xyz789",
"holdingDocument": HoldingDocument,
"query": Query,
"documentByDocumentId": Document,
"holdingByHoldingId": Holding,
"holdingDocumentEdge": HoldingDocumentsEdge
}
DeleteInstancedAccountInformationHistoryByIdInput
Description
All input for the deleteInstancedAccountInformationHistoryById mutation.
Example
{
"clientMutationId": "xyz789",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
DeleteInstancedAccountInformationHistoryInput
Description
All input for the deleteInstancedAccountInformationHistory mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
nodeId - ID!
|
The globally unique ID which will identify a single InstancedAccountInformationHistory to be deleted. |
Example
{"clientMutationId": "abc123", "nodeId": 4}
DeleteInstancedAccountInformationHistoryPayload
Description
The output of our delete InstancedAccountInformationHistory mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
The exact same clientMutationId that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations. |
instancedAccountInformationHistory - InstancedAccountInformationHistory
|
The InstancedAccountInformationHistory that was deleted by this mutation. |
deletedInstancedAccountInformationHistoryId - ID
|
|
query - Query
|
Our root query field type. Allows us to run any query from our mutation payload. |
instancedAccountInformationByRecordId - InstancedAccountInformation
|
Reads a single InstancedAccountInformation that is related to this InstancedAccountInformationHistory. |
instancedAccountInformationHistoryEdge - InstancedAccountInformationHistoriesEdge
|
An edge for our InstancedAccountInformationHistory. May be used by Relay 1. |
Arguments
|
|
Example
{
"clientMutationId": "abc123",
"instancedAccountInformationHistory": InstancedAccountInformationHistory,
"deletedInstancedAccountInformationHistoryId": 4,
"query": Query,
"instancedAccountInformationByRecordId": InstancedAccountInformation,
"instancedAccountInformationHistoryEdge": InstancedAccountInformationHistoriesEdge
}
DeleteMappedSigningTemplateQuestionSetByIdInput
Description
All input for the deleteMappedSigningTemplateQuestionSetById mutation.
Example
{
"clientMutationId": "xyz789",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
DeleteMappedSigningTemplateQuestionSetByOnboardingQuestionSetIdAndMappedSigningTemplateIdInput
Description
All input for the deleteMappedSigningTemplateQuestionSetByOnboardingQuestionSetIdAndMappedSigningTemplateId mutation.
Example
{
"clientMutationId": "abc123",
"onboardingQuestionSetId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"mappedSigningTemplateId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
DeleteMappedSigningTemplateQuestionSetInput
Description
All input for the deleteMappedSigningTemplateQuestionSet mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
nodeId - ID!
|
The globally unique ID which will identify a single MappedSigningTemplateQuestionSet to be deleted. |
Example
{
"clientMutationId": "xyz789",
"nodeId": "4"
}
DeleteMappedSigningTemplateQuestionSetPayload
Description
The output of our delete MappedSigningTemplateQuestionSet mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
The exact same clientMutationId that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations. |
mappedSigningTemplateQuestionSet - MappedSigningTemplateQuestionSet
|
The MappedSigningTemplateQuestionSet that was deleted by this mutation. |
deletedMappedSigningTemplateQuestionSetId - ID
|
|
query - Query
|
Our root query field type. Allows us to run any query from our mutation payload. |
onboardingQuestionSetByOnboardingQuestionSetId - OnboardingQuestionSet
|
Reads a single OnboardingQuestionSet that is related to this MappedSigningTemplateQuestionSet. |
mappedSigningTemplateByMappedSigningTemplateId - MappedSigningTemplate
|
Reads a single MappedSigningTemplate that is related to this MappedSigningTemplateQuestionSet. |
mappedSigningTemplateQuestionSetEdge - MappedSigningTemplateQuestionSetsEdge
|
An edge for our MappedSigningTemplateQuestionSet. May be used by Relay 1. |
Arguments
|
|
Example
{
"clientMutationId": "abc123",
"mappedSigningTemplateQuestionSet": MappedSigningTemplateQuestionSet,
"deletedMappedSigningTemplateQuestionSetId": "4",
"query": Query,
"onboardingQuestionSetByOnboardingQuestionSetId": OnboardingQuestionSet,
"mappedSigningTemplateByMappedSigningTemplateId": MappedSigningTemplate,
"mappedSigningTemplateQuestionSetEdge": MappedSigningTemplateQuestionSetsEdge
}
DeleteOnboardingQuestionByAccountIdAndNameInput
Description
All input for the deleteOnboardingQuestionByAccountIdAndName mutation.
Example
{
"clientMutationId": "xyz789",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"name": "abc123"
}
DeleteOnboardingQuestionByIdInput
Description
All input for the deleteOnboardingQuestionById mutation.
Example
{
"clientMutationId": "abc123",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
DeleteOnboardingQuestionInput
Description
All input for the deleteOnboardingQuestion mutation.
Example
{"clientMutationId": "xyz789", "nodeId": 4}
DeleteOnboardingQuestionJoinByIdInput
Description
All input for the deleteOnboardingQuestionJoinById mutation.
Example
{
"clientMutationId": "abc123",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
DeleteOnboardingQuestionJoinByOnboardingQuestionSetIdAndOnboardingQuestionIdInput
Description
All input for the deleteOnboardingQuestionJoinByOnboardingQuestionSetIdAndOnboardingQuestionId mutation.
Example
{
"clientMutationId": "xyz789",
"onboardingQuestionSetId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"onboardingQuestionId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
DeleteOnboardingQuestionJoinInput
Description
All input for the deleteOnboardingQuestionJoin mutation.
Example
{"clientMutationId": "abc123", "nodeId": 4}
DeleteOnboardingQuestionJoinPayload
Description
The output of our delete OnboardingQuestionJoin mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
The exact same clientMutationId that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations. |
onboardingQuestionJoin - OnboardingQuestionJoin
|
The OnboardingQuestionJoin that was deleted by this mutation. |
deletedOnboardingQuestionJoinId - ID
|
|
query - Query
|
Our root query field type. Allows us to run any query from our mutation payload. |
onboardingQuestionSetByOnboardingQuestionSetId - OnboardingQuestionSet
|
Reads a single OnboardingQuestionSet that is related to this OnboardingQuestionJoin. |
onboardingQuestionByOnboardingQuestionId - OnboardingQuestion
|
Reads a single OnboardingQuestion that is related to this OnboardingQuestionJoin. |
onboardingQuestionJoinEdge - OnboardingQuestionJoinsEdge
|
An edge for our OnboardingQuestionJoin. May be used by Relay 1. |
Arguments
|
|
Example
{
"clientMutationId": "abc123",
"onboardingQuestionJoin": OnboardingQuestionJoin,
"deletedOnboardingQuestionJoinId": "4",
"query": Query,
"onboardingQuestionSetByOnboardingQuestionSetId": OnboardingQuestionSet,
"onboardingQuestionByOnboardingQuestionId": OnboardingQuestion,
"onboardingQuestionJoinEdge": OnboardingQuestionJoinsEdge
}
DeleteOnboardingQuestionPayload
Description
The output of our delete OnboardingQuestion mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
The exact same clientMutationId that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations. |
onboardingQuestion - OnboardingQuestion
|
The OnboardingQuestion that was deleted by this mutation. |
deletedOnboardingQuestionId - ID
|
|
query - Query
|
Our root query field type. Allows us to run any query from our mutation payload. |
accountByAccountId - Account
|
Reads a single Account that is related to this OnboardingQuestion. |
onboardingQuestionTypeByType - OnboardingQuestionType
|
Reads a single OnboardingQuestionType that is related to this OnboardingQuestion. |
onboardingQuestionEdge - OnboardingQuestionsEdge
|
An edge for our OnboardingQuestion. May be used by Relay 1. |
Arguments
|
|
Example
{
"clientMutationId": "abc123",
"onboardingQuestion": OnboardingQuestion,
"deletedOnboardingQuestionId": "4",
"query": Query,
"accountByAccountId": Account,
"onboardingQuestionTypeByType": OnboardingQuestionType,
"onboardingQuestionEdge": OnboardingQuestionsEdge
}
DeleteOnboardingQuestionSetByAccountIdAndNameInput
Description
All input for the deleteOnboardingQuestionSetByAccountIdAndName mutation.
Example
{
"clientMutationId": "abc123",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"name": "xyz789"
}
DeleteOnboardingQuestionSetByIdInput
Description
All input for the deleteOnboardingQuestionSetById mutation.
Example
{
"clientMutationId": "xyz789",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
DeleteOnboardingQuestionSetByVendorQualificationIdInput
Description
All input for the deleteOnboardingQuestionSetByVendorQualificationId mutation.
Example
{
"clientMutationId": "xyz789",
"vendorQualificationId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
DeleteOnboardingQuestionSetInput
Description
All input for the deleteOnboardingQuestionSet mutation.
Example
{"clientMutationId": "xyz789", "nodeId": 4}
DeleteOnboardingQuestionSetPayload
Description
The output of our delete OnboardingQuestionSet mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
The exact same clientMutationId that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations. |
onboardingQuestionSet - OnboardingQuestionSet
|
The OnboardingQuestionSet that was deleted by this mutation. |
deletedOnboardingQuestionSetId - ID
|
|
query - Query
|
Our root query field type. Allows us to run any query from our mutation payload. |
accountByAccountId - Account
|
Reads a single Account that is related to this OnboardingQuestionSet. |
vendorQualificationByVendorQualificationId - VendorQualification
|
Reads a single VendorQualification that is related to this OnboardingQuestionSet. |
onboardingQuestionSetEdge - OnboardingQuestionSetsEdge
|
An edge for our OnboardingQuestionSet. May be used by Relay 1. |
Arguments
|
|
Example
{
"clientMutationId": "abc123",
"onboardingQuestionSet": OnboardingQuestionSet,
"deletedOnboardingQuestionSetId": 4,
"query": Query,
"accountByAccountId": Account,
"vendorQualificationByVendorQualificationId": VendorQualification,
"onboardingQuestionSetEdge": OnboardingQuestionSetsEdge
}
DeletePaymentMethodByAccountIdAndNameInput
Description
All input for the deletePaymentMethodByAccountIdAndName mutation.
Example
{
"clientMutationId": "abc123",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"name": "xyz789"
}
DeletePaymentMethodByEncryptedRecordIdInput
Description
All input for the deletePaymentMethodByEncryptedRecordId mutation.
Example
{
"clientMutationId": "xyz789",
"encryptedRecordId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
DeletePaymentMethodByIdInput
Description
All input for the deletePaymentMethodById mutation.
Example
{
"clientMutationId": "xyz789",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
DeletePaymentMethodInput
Description
All input for the deletePaymentMethod mutation.
Example
{"clientMutationId": "xyz789", "nodeId": 4}
DeletePaymentMethodPayload
Description
The output of our delete PaymentMethod mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
The exact same clientMutationId that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations. |
paymentMethod - PaymentMethod
|
The PaymentMethod that was deleted by this mutation. |
deletedPaymentMethodId - ID
|
|
query - Query
|
Our root query field type. Allows us to run any query from our mutation payload. |
accountByAccountId - Account
|
Reads a single Account that is related to this PaymentMethod. |
integrationByIntegrationId - Integration
|
Reads a single Integration that is related to this PaymentMethod. |
paymentMethodTypeByType - PaymentMethodType
|
Reads a single PaymentMethodType that is related to this PaymentMethod. |
paymentMethodEdge - PaymentMethodsEdge
|
An edge for our PaymentMethod. May be used by Relay 1. |
Arguments
|
|
Example
{
"clientMutationId": "xyz789",
"paymentMethod": PaymentMethod,
"deletedPaymentMethodId": 4,
"query": Query,
"accountByAccountId": Account,
"integrationByIntegrationId": Integration,
"paymentMethodTypeByType": PaymentMethodType,
"paymentMethodEdge": PaymentMethodsEdge
}
DeletePaymentMethodTypeByTypeInput
Description
All input for the deletePaymentMethodTypeByType mutation.
Example
{
"clientMutationId": "abc123",
"type": "xyz789"
}
DeletePaymentMethodTypeInput
Description
All input for the deletePaymentMethodType mutation.
Example
{"clientMutationId": "abc123", "nodeId": 4}
DeletePaymentMethodTypePayload
Description
The output of our delete PaymentMethodType mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
The exact same clientMutationId that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations. |
paymentMethodType - PaymentMethodType
|
The PaymentMethodType that was deleted by this mutation. |
deletedPaymentMethodTypeId - ID
|
|
query - Query
|
Our root query field type. Allows us to run any query from our mutation payload. |
paymentMethodTypeEdge - PaymentMethodTypesEdge
|
An edge for our PaymentMethodType. May be used by Relay 1. |
Arguments
|
|
Example
{
"clientMutationId": "xyz789",
"paymentMethodType": PaymentMethodType,
"deletedPaymentMethodTypeId": "4",
"query": Query,
"paymentMethodTypeEdge": PaymentMethodTypesEdge
}
DeletePaymentStepTypeByTypeInput
Description
All input for the deletePaymentStepTypeByType mutation.
Example
{
"clientMutationId": "xyz789",
"type": "abc123"
}
DeletePaymentStepTypeInput
Description
All input for the deletePaymentStepType mutation.
Example
{
"clientMutationId": "xyz789",
"nodeId": "4"
}
DeletePaymentStepTypePayload
Description
The output of our delete PaymentStepType mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
The exact same clientMutationId that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations. |
paymentStepType - PaymentStepType
|
The PaymentStepType that was deleted by this mutation. |
deletedPaymentStepTypeId - ID
|
|
query - Query
|
Our root query field type. Allows us to run any query from our mutation payload. |
paymentStepTypeEdge - PaymentStepTypesEdge
|
An edge for our PaymentStepType. May be used by Relay 1. |
Arguments
|
|
Example
{
"clientMutationId": "xyz789",
"paymentStepType": PaymentStepType,
"deletedPaymentStepTypeId": "4",
"query": Query,
"paymentStepTypeEdge": PaymentStepTypesEdge
}
DeleteRestrictionCategoryByCategoryInput
Description
All input for the deleteRestrictionCategoryByCategory mutation.
Example
{
"clientMutationId": "abc123",
"category": "xyz789"
}
DeleteRestrictionCategoryInput
Description
All input for the deleteRestrictionCategory mutation.
Example
{"clientMutationId": "xyz789", "nodeId": 4}
DeleteRestrictionCategoryPayload
Description
The output of our delete RestrictionCategory mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
The exact same clientMutationId that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations. |
restrictionCategory - RestrictionCategory
|
The RestrictionCategory that was deleted by this mutation. |
deletedRestrictionCategoryId - ID
|
|
query - Query
|
Our root query field type. Allows us to run any query from our mutation payload. |
restrictionCategoryEdge - RestrictionCategoriesEdge
|
An edge for our RestrictionCategory. May be used by Relay 1. |
Arguments
|
|
Example
{
"clientMutationId": "abc123",
"restrictionCategory": RestrictionCategory,
"deletedRestrictionCategoryId": "4",
"query": Query,
"restrictionCategoryEdge": RestrictionCategoriesEdge
}
DeleteRestrictionReasonByIdInput
Description
All input for the deleteRestrictionReasonById mutation.
Example
{"clientMutationId": "xyz789", "id": 987}
DeleteRestrictionReasonByReasonInput
Description
All input for the deleteRestrictionReasonByReason mutation.
Example
{
"clientMutationId": "xyz789",
"reason": "abc123"
}
DeleteRestrictionReasonInput
Description
All input for the deleteRestrictionReason mutation.
Example
{
"clientMutationId": "xyz789",
"nodeId": "4"
}
DeleteRestrictionReasonPayload
Description
The output of our delete RestrictionReason mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
The exact same clientMutationId that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations. |
restrictionReason - RestrictionReason
|
The RestrictionReason that was deleted by this mutation. |
deletedRestrictionReasonId - ID
|
|
query - Query
|
Our root query field type. Allows us to run any query from our mutation payload. |
restrictionCategoryByCategory - RestrictionCategory
|
Reads a single RestrictionCategory that is related to this RestrictionReason. |
restrictionReasonEdge - RestrictionReasonsEdge
|
An edge for our RestrictionReason. May be used by Relay 1. |
Arguments
|
|
Example
{
"clientMutationId": "xyz789",
"restrictionReason": RestrictionReason,
"deletedRestrictionReasonId": 4,
"query": Query,
"restrictionCategoryByCategory": RestrictionCategory,
"restrictionReasonEdge": RestrictionReasonsEdge
}
DeleteSecurityDocumentInput
Description
All input for the deleteSecurityDocument mutation.
Example
{
"clientMutationId": "xyz789",
"securityDocumentId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
DeleteSecurityDocumentPayload
Description
The output of our deleteSecurityDocument mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
The exact same clientMutationId that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations. |
securityDocument - SecurityDocument
|
|
query - Query
|
Our root query field type. Allows us to run any query from our mutation payload. |
documentByDocumentId - Document
|
Reads a single Document that is related to this SecurityDocument. |
securityBySecurityId - Security
|
Reads a single Security that is related to this SecurityDocument. |
securityDocumentEdge - SecurityDocumentsEdge
|
An edge for our SecurityDocument. May be used by Relay 1. |
Arguments
|
|
Example
{
"clientMutationId": "xyz789",
"securityDocument": SecurityDocument,
"query": Query,
"documentByDocumentId": Document,
"securityBySecurityId": Security,
"securityDocumentEdge": SecurityDocumentsEdge
}
DeleteSigningFieldByIdInput
Description
All input for the deleteSigningFieldById mutation.
Example
{
"clientMutationId": "xyz789",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
DeleteSigningFieldInput
Description
All input for the deleteSigningField mutation.
Example
{"clientMutationId": "xyz789", "nodeId": 4}
DeleteSigningFieldPayload
Description
The output of our delete SigningField mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
The exact same clientMutationId that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations. |
signingField - SigningField
|
The SigningField that was deleted by this mutation. |
deletedSigningFieldId - ID
|
|
query - Query
|
Our root query field type. Allows us to run any query from our mutation payload. |
mappedSigningTemplateByMappedSigningTemplateId - MappedSigningTemplate
|
Reads a single MappedSigningTemplate that is related to this SigningField. |
signingDocumentBySigningDocumentId - SigningDocument
|
Reads a single SigningDocument that is related to this SigningField. |
signingRoleBySigningRoleId - SigningRole
|
Reads a single SigningRole that is related to this SigningField. |
signingFieldEdge - SigningFieldsEdge
|
An edge for our SigningField. May be used by Relay 1. |
Arguments
|
|
Example
{
"clientMutationId": "abc123",
"signingField": SigningField,
"deletedSigningFieldId": "4",
"query": Query,
"mappedSigningTemplateByMappedSigningTemplateId": MappedSigningTemplate,
"signingDocumentBySigningDocumentId": SigningDocument,
"signingRoleBySigningRoleId": SigningRole,
"signingFieldEdge": SigningFieldsEdge
}
DeleteTransactionAnnotationByIdInput
Description
All input for the deleteTransactionAnnotationById mutation.
Example
{
"clientMutationId": "xyz789",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
DeleteTransactionAnnotationInput
Description
All input for the deleteTransactionAnnotation mutation.
Example
{"clientMutationId": "abc123", "nodeId": 4}
DeleteTransactionAnnotationPayload
Description
The output of our delete TransactionAnnotation mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
The exact same clientMutationId that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations. |
transactionAnnotation - TransactionAnnotation
|
The TransactionAnnotation that was deleted by this mutation. |
deletedTransactionAnnotationId - ID
|
|
query - Query
|
Our root query field type. Allows us to run any query from our mutation payload. |
transactionByTransactionId - Transaction
|
Reads a single Transaction that is related to this TransactionAnnotation. |
userByWrittenBy - User
|
Reads a single User that is related to this TransactionAnnotation. |
accountByAccountId - Account
|
Reads a single Account that is related to this TransactionAnnotation. |
transactionAnnotationEdge - TransactionAnnotationsEdge
|
An edge for our TransactionAnnotation. May be used by Relay 1. |
Arguments
|
|
Example
{
"clientMutationId": "abc123",
"transactionAnnotation": TransactionAnnotation,
"deletedTransactionAnnotationId": "4",
"query": Query,
"transactionByTransactionId": Transaction,
"userByWrittenBy": User,
"accountByAccountId": Account,
"transactionAnnotationEdge": TransactionAnnotationsEdge
}
DeleteVendorIntegrationStatusByStatusInput
Description
All input for the deleteVendorIntegrationStatusByStatus mutation.
Example
{
"clientMutationId": "xyz789",
"status": "xyz789"
}
DeleteVendorIntegrationStatusInput
Description
All input for the deleteVendorIntegrationStatus mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
nodeId - ID!
|
The globally unique ID which will identify a single VendorIntegrationStatus to be deleted. |
Example
{
"clientMutationId": "xyz789",
"nodeId": "4"
}
DeleteVendorIntegrationStatusPayload
Description
The output of our delete VendorIntegrationStatus mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
The exact same clientMutationId that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations. |
vendorIntegrationStatus - VendorIntegrationStatus
|
The VendorIntegrationStatus that was deleted by this mutation. |
deletedVendorIntegrationStatusId - ID
|
|
query - Query
|
Our root query field type. Allows us to run any query from our mutation payload. |
vendorIntegrationStatusEdge - VendorIntegrationStatusesEdge
|
An edge for our VendorIntegrationStatus. May be used by Relay 1. |
Arguments
|
|
Example
{
"clientMutationId": "xyz789",
"vendorIntegrationStatus": VendorIntegrationStatus,
"deletedVendorIntegrationStatusId": "4",
"query": Query,
"vendorIntegrationStatusEdge": VendorIntegrationStatusesEdge
}
DeleteVestingEventByIdInput
Description
All input for the deleteVestingEventById mutation.
Example
{
"clientMutationId": "abc123",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
DeleteVestingEventInput
Description
All input for the deleteVestingEvent mutation.
Example
{
"clientMutationId": "abc123",
"nodeId": "4"
}
DeleteVestingEventPayload
Description
The output of our delete VestingEvent mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
The exact same clientMutationId that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations. |
vestingEvent - VestingEvent
|
The VestingEvent that was deleted by this mutation. |
deletedVestingEventId - ID
|
|
query - Query
|
Our root query field type. Allows us to run any query from our mutation payload. |
vestingScheduleByVestingScheduleId - VestingSchedule
|
Reads a single VestingSchedule that is related to this VestingEvent. |
transactionByTransactionId - Transaction
|
Reads a single Transaction that is related to this VestingEvent. |
vestingEventEdge - VestingEventsEdge
|
An edge for our VestingEvent. May be used by Relay 1. |
Arguments
|
|
Example
{
"clientMutationId": "xyz789",
"vestingEvent": VestingEvent,
"deletedVestingEventId": "4",
"query": Query,
"vestingScheduleByVestingScheduleId": VestingSchedule,
"transactionByTransactionId": Transaction,
"vestingEventEdge": VestingEventsEdge
}
DeleteWalletAssignmentByDistributionIdInput
Description
All input for the deleteWalletAssignmentByDistributionId mutation.
Example
{
"clientMutationId": "xyz789",
"distributionId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
DeleteWalletAssignmentByIdInput
Description
All input for the deleteWalletAssignmentById mutation.
Example
{
"clientMutationId": "abc123",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
DeleteWalletAssignmentInput
Description
All input for the deleteWalletAssignment mutation.
Example
{
"clientMutationId": "xyz789",
"nodeId": "4"
}
DeleteWalletAssignmentPayload
Description
The output of our delete WalletAssignment mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
The exact same clientMutationId that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations. |
walletAssignment - WalletAssignment
|
The WalletAssignment that was deleted by this mutation. |
deletedWalletAssignmentId - ID
|
|
query - Query
|
Our root query field type. Allows us to run any query from our mutation payload. |
distributionByDistributionId - Distribution
|
Reads a single Distribution that is related to this WalletAssignment. |
blockchainAddressByBlockchainAddressId - BlockchainAddress
|
Reads a single BlockchainAddress that is related to this WalletAssignment. |
walletAssignmentEdge - WalletAssignmentsEdge
|
An edge for our WalletAssignment. May be used by Relay 1. |
Arguments
|
|
Example
{
"clientMutationId": "abc123",
"walletAssignment": WalletAssignment,
"deletedWalletAssignmentId": "4",
"query": Query,
"distributionByDistributionId": Distribution,
"blockchainAddressByBlockchainAddressId": BlockchainAddress,
"walletAssignmentEdge": WalletAssignmentsEdge
}
DeployContractInput
Description
All input for the deployContract mutation.
Example
{
"clientMutationId": "xyz789",
"_contractId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
DeployContractPayload
Description
The output of our deployContract mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
The exact same clientMutationId that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations. |
contract - Contract
|
|
query - Query
|
Our root query field type. Allows us to run any query from our mutation payload. |
tokenByTokenId - Token
|
Reads a single Token that is related to this Contract. |
chainByChain - Chain
|
Reads a single Chain that is related to this Contract. |
contractStatusByStatus - ContractStatus
|
Reads a single ContractStatus that is related to this Contract. |
integrationByCustodianId - Integration
|
Reads a single Integration that is related to this Contract. |
integrationByIssuancePlatformId - Integration
|
Reads a single Integration that is related to this Contract. |
contractEdge - ContractsEdge
|
An edge for our Contract. May be used by Relay 1. |
Arguments
|
|
Example
{
"clientMutationId": "xyz789",
"contract": Contract,
"query": Query,
"tokenByTokenId": Token,
"chainByChain": Chain,
"contractStatusByStatus": ContractStatus,
"integrationByCustodianId": Integration,
"integrationByIssuancePlatformId": Integration,
"contractEdge": ContractsEdge
}
DepositAccountInput
Fields
| Input Field | Description |
|---|---|
name - String!
|
|
taxId - String!
|
|
email - String!
|
|
data - JSON
|
|
parties - [DepositPartyInput!]
|
|
address - [DepositAddressInput!]
|
Example
{
"name": "xyz789",
"taxId": "abc123",
"email": "xyz789",
"data": {},
"parties": [DepositPartyInput],
"address": [DepositAddressInput]
}
DepositAddressInput
Example
{
"country": "abc123",
"city": "abc123",
"province": "xyz789",
"postalCode": "xyz789",
"lineOne": "xyz789",
"lineTwo": "abc123",
"lineThree": "abc123",
"lineFour": "abc123"
}
DepositFeeInput
DepositHoldingInput
DepositPartyInput
Fields
| Input Field | Description |
|---|---|
firstName - String!
|
|
lastName - String!
|
|
taxId - String!
|
|
email - String!
|
|
address - [DepositAddressInput!]
|
Example
{
"firstName": "xyz789",
"lastName": "abc123",
"taxId": "xyz789",
"email": "xyz789",
"address": [DepositAddressInput]
}
DepositSignatureInput
DepositTagInput
Distribution
Fields
| Field Name | Description |
|---|---|
nodeId - ID!
|
A globally unique identifier. Can be used in various places throughout the system to identify this single value. |
allocationId - UUID!
|
|
investorId - UUID!
|
|
status - String!
|
|
amount - BigFloat!
|
|
stepId - UUID!
|
|
newId - UUID!
|
|
draftedBlockchainId - UUID
|
|
openBlockchainId - UUID
|
|
closedBlockchainId - UUID
|
|
lockedBlockchainId - UUID
|
|
transactionGroupId - UUID
|
|
triggerArgs - JSON
|
|
oldId - Int
|
|
id - UUID!
|
|
createdOn - Datetime!
|
|
locked - Boolean!
|
|
roundId - UUID
|
|
allocationByAllocationId - Allocation
|
Reads a single Allocation that is related to this Distribution. |
accountByInvestorId - Account
|
Reads a single Account that is related to this Distribution. |
distributionStatusByStatus - DistributionStatus
|
Reads a single DistributionStatus that is related to this Distribution. |
stepByStepId - Step
|
Reads a single Step that is related to this Distribution. |
distributionPricesByDistributionId - DistributionPricesConnection!
|
Reads and enables pagination through a set of DistributionPrice. |
Arguments
|
|
vestingScheduleByDistributionId - VestingSchedule
|
Reads a single VestingSchedule that is related to this Distribution. |
vestingSchedulesByDistributionId - VestingSchedulesConnection!
|
Reads and enables pagination through a set of VestingSchedule. Please use vestingScheduleByDistributionId instead
|
Arguments
|
|
distributionPaymentsByDistributionId - DistributionPaymentsConnection!
|
Reads and enables pagination through a set of DistributionPayment. |
Arguments
|
|
walletAssignmentByDistributionId - WalletAssignment
|
Reads a single WalletAssignment that is related to this Distribution. |
walletAssignmentsByDistributionId - WalletAssignmentsConnection!
|
Reads and enables pagination through a set of WalletAssignment. Please use walletAssignmentByDistributionId instead
|
Arguments
|
|
distributionAnnotationsByDistributionId - DistributionAnnotationsConnection!
|
Reads and enables pagination through a set of DistributionAnnotation. |
Arguments
|
|
distributionQualificationsByDistributionId - DistributionQualificationsConnection!
|
Reads and enables pagination through a set of DistributionQualification. |
Arguments
|
|
distributionCustomFieldsByDistributionId - DistributionCustomFieldsConnection!
|
Reads and enables pagination through a set of DistributionCustomField. |
Arguments
|
|
issuanceEventByDistributionId - IssuanceEvent
|
Reads a single IssuanceEvent that is related to this Distribution. |
issuanceEventsByDistributionId - IssuanceEventsConnection!
|
Reads and enables pagination through a set of IssuanceEvent. Please use issuanceEventByDistributionId instead
|
Arguments
|
|
issuanceStatus - String
|
|
paidInCapital - BigFloat
|
|
purchasePrice - DistributionPrice
|
|
qualificationsComplete - Boolean
|
|
Example
{
"nodeId": "4",
"allocationId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"investorId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"status": "abc123",
"amount": BigFloat,
"stepId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"newId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"draftedBlockchainId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"openBlockchainId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"closedBlockchainId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"lockedBlockchainId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"transactionGroupId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"triggerArgs": {},
"oldId": 123,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"createdOn": Datetime,
"locked": true,
"roundId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"allocationByAllocationId": Allocation,
"accountByInvestorId": Account,
"distributionStatusByStatus": DistributionStatus,
"stepByStepId": Step,
"distributionPricesByDistributionId": DistributionPricesConnection,
"vestingScheduleByDistributionId": VestingSchedule,
"vestingSchedulesByDistributionId": VestingSchedulesConnection,
"distributionPaymentsByDistributionId": DistributionPaymentsConnection,
"walletAssignmentByDistributionId": WalletAssignment,
"walletAssignmentsByDistributionId": WalletAssignmentsConnection,
"distributionAnnotationsByDistributionId": DistributionAnnotationsConnection,
"distributionQualificationsByDistributionId": DistributionQualificationsConnection,
"distributionCustomFieldsByDistributionId": DistributionCustomFieldsConnection,
"issuanceEventByDistributionId": IssuanceEvent,
"issuanceEventsByDistributionId": IssuanceEventsConnection,
"issuanceStatus": "xyz789",
"paidInCapital": BigFloat,
"purchasePrice": DistributionPrice,
"qualificationsComplete": true
}
DistributionAnnotation
Fields
| Field Name | Description |
|---|---|
nodeId - ID!
|
A globally unique identifier. Can be used in various places throughout the system to identify this single value. |
distributionId - UUID!
|
|
writtenBy - UUID!
|
|
accountId - UUID!
|
|
annotation - String!
|
|
archive - Boolean!
|
|
createdOn - Datetime!
|
|
id - UUID!
|
|
distributionByDistributionId - Distribution
|
Reads a single Distribution that is related to this DistributionAnnotation. |
userByWrittenBy - User
|
Reads a single User that is related to this DistributionAnnotation. |
accountByAccountId - Account
|
Reads a single Account that is related to this DistributionAnnotation. |
Example
{
"nodeId": 4,
"distributionId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"writtenBy": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"annotation": "xyz789",
"archive": false,
"createdOn": Datetime,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"distributionByDistributionId": Distribution,
"userByWrittenBy": User,
"accountByAccountId": Account
}
DistributionAnnotationCondition
Description
A condition to be used against DistributionAnnotation object types. All fields are tested for equality and combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
distributionId - UUID
|
Checks for equality with the object’s distributionId field. |
writtenBy - UUID
|
Checks for equality with the object’s writtenBy field. |
accountId - UUID
|
Checks for equality with the object’s accountId field. |
annotation - String
|
Checks for equality with the object’s annotation field. |
archive - Boolean
|
Checks for equality with the object’s archive field. |
createdOn - Datetime
|
Checks for equality with the object’s createdOn field. |
id - UUID
|
Checks for equality with the object’s id field. |
Example
{
"distributionId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"writtenBy": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"annotation": "xyz789",
"archive": false,
"createdOn": Datetime,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
DistributionAnnotationFilter
Description
A filter to be used against DistributionAnnotation object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
distributionId - UUIDFilter
|
Filter by the object’s distributionId field. |
writtenBy - UUIDFilter
|
Filter by the object’s writtenBy field. |
accountId - UUIDFilter
|
Filter by the object’s accountId field. |
annotation - StringFilter
|
Filter by the object’s annotation field. |
archive - BooleanFilter
|
Filter by the object’s archive field. |
createdOn - DatetimeFilter
|
Filter by the object’s createdOn field. |
id - UUIDFilter
|
Filter by the object’s id field. |
distributionByDistributionId - DistributionFilter
|
Filter by the object’s distributionByDistributionId relation. |
userByWrittenBy - UserFilter
|
Filter by the object’s userByWrittenBy relation. |
accountByAccountId - AccountFilter
|
Filter by the object’s accountByAccountId relation. |
and - [DistributionAnnotationFilter!]
|
Checks for all expressions in this list. |
or - [DistributionAnnotationFilter!]
|
Checks for any expressions in this list. |
not - DistributionAnnotationFilter
|
Negates the expression. |
Example
{
"distributionId": UUIDFilter,
"writtenBy": UUIDFilter,
"accountId": UUIDFilter,
"annotation": StringFilter,
"archive": BooleanFilter,
"createdOn": DatetimeFilter,
"id": UUIDFilter,
"distributionByDistributionId": DistributionFilter,
"userByWrittenBy": UserFilter,
"accountByAccountId": AccountFilter,
"and": [DistributionAnnotationFilter],
"or": [DistributionAnnotationFilter],
"not": DistributionAnnotationFilter
}
DistributionAnnotationInput
Description
An input for mutations affecting DistributionAnnotation
Example
{
"distributionId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"writtenBy": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"annotation": "xyz789",
"archive": true,
"createdOn": Datetime,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
DistributionAnnotationPatch
Description
Represents an update to a DistributionAnnotation. Fields that are set will be updated.
Example
{
"distributionId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"writtenBy": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"annotation": "xyz789",
"archive": false,
"createdOn": Datetime,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
DistributionAnnotationsConnection
Description
A connection to a list of DistributionAnnotation values.
Fields
| Field Name | Description |
|---|---|
nodes - [DistributionAnnotation]!
|
A list of DistributionAnnotation objects. |
edges - [DistributionAnnotationsEdge!]!
|
A list of edges which contains the DistributionAnnotation and cursor to aid in pagination. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The count of all DistributionAnnotation you could get from the connection. |
Example
{
"nodes": [DistributionAnnotation],
"edges": [DistributionAnnotationsEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
DistributionAnnotationsEdge
Description
A DistributionAnnotation edge in the connection.
Fields
| Field Name | Description |
|---|---|
cursor - Cursor
|
A cursor for use in pagination. |
node - DistributionAnnotation
|
The DistributionAnnotation at the end of the edge. |
Example
{
"cursor": Cursor,
"node": DistributionAnnotation
}
DistributionAnnotationsOrderBy
Description
Methods to use when ordering DistributionAnnotation.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NATURAL"
DistributionCondition
Description
A condition to be used against Distribution object types. All fields are tested for equality and combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
allocationId - UUID
|
Checks for equality with the object’s allocationId field. |
investorId - UUID
|
Checks for equality with the object’s investorId field. |
status - String
|
Checks for equality with the object’s status field. |
amount - BigFloat
|
Checks for equality with the object’s amount field. |
stepId - UUID
|
Checks for equality with the object’s stepId field. |
newId - UUID
|
Checks for equality with the object’s newId field. |
draftedBlockchainId - UUID
|
Checks for equality with the object’s draftedBlockchainId field. |
openBlockchainId - UUID
|
Checks for equality with the object’s openBlockchainId field. |
closedBlockchainId - UUID
|
Checks for equality with the object’s closedBlockchainId field. |
lockedBlockchainId - UUID
|
Checks for equality with the object’s lockedBlockchainId field. |
transactionGroupId - UUID
|
Checks for equality with the object’s transactionGroupId field. |
triggerArgs - JSON
|
Checks for equality with the object’s triggerArgs field. |
oldId - Int
|
Checks for equality with the object’s oldId field. |
id - UUID
|
Checks for equality with the object’s id field. |
createdOn - Datetime
|
Checks for equality with the object’s createdOn field. |
locked - Boolean
|
Checks for equality with the object’s locked field. |
roundId - UUID
|
Checks for equality with the object’s roundId field. |
Example
{
"allocationId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"investorId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"status": "abc123",
"amount": BigFloat,
"stepId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"newId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"draftedBlockchainId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"openBlockchainId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"closedBlockchainId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"lockedBlockchainId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"transactionGroupId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"triggerArgs": {},
"oldId": 987,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"createdOn": Datetime,
"locked": true,
"roundId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
DistributionCustomField
Fields
| Field Name | Description |
|---|---|
nodeId - ID!
|
A globally unique identifier. Can be used in various places throughout the system to identify this single value. |
id - UUID!
|
|
createdBy - UUID
|
|
distributionId - UUID!
|
|
name - String!
|
|
value - String!
|
|
accountByCreatedBy - Account
|
Reads a single Account that is related to this DistributionCustomField. |
distributionByDistributionId - Distribution
|
Reads a single Distribution that is related to this DistributionCustomField. |
Example
{
"nodeId": 4,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"createdBy": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"distributionId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"name": "xyz789",
"value": "xyz789",
"accountByCreatedBy": Account,
"distributionByDistributionId": Distribution
}
DistributionCustomFieldCondition
Description
A condition to be used against DistributionCustomField object types. All fields are tested for equality and combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
id - UUID
|
Checks for equality with the object’s id field. |
createdBy - UUID
|
Checks for equality with the object’s createdBy field. |
distributionId - UUID
|
Checks for equality with the object’s distributionId field. |
name - String
|
Checks for equality with the object’s name field. |
value - String
|
Checks for equality with the object’s value field. |
Example
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"createdBy": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"distributionId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"name": "xyz789",
"value": "xyz789"
}
DistributionCustomFieldFilter
Description
A filter to be used against DistributionCustomField object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
id - UUIDFilter
|
Filter by the object’s id field. |
createdBy - UUIDFilter
|
Filter by the object’s createdBy field. |
distributionId - UUIDFilter
|
Filter by the object’s distributionId field. |
name - StringFilter
|
Filter by the object’s name field. |
value - StringFilter
|
Filter by the object’s value field. |
accountByCreatedBy - AccountFilter
|
Filter by the object’s accountByCreatedBy relation. |
accountByCreatedByExists - Boolean
|
A related accountByCreatedBy exists. |
distributionByDistributionId - DistributionFilter
|
Filter by the object’s distributionByDistributionId relation. |
and - [DistributionCustomFieldFilter!]
|
Checks for all expressions in this list. |
or - [DistributionCustomFieldFilter!]
|
Checks for any expressions in this list. |
not - DistributionCustomFieldFilter
|
Negates the expression. |
Example
{
"id": UUIDFilter,
"createdBy": UUIDFilter,
"distributionId": UUIDFilter,
"name": StringFilter,
"value": StringFilter,
"accountByCreatedBy": AccountFilter,
"accountByCreatedByExists": true,
"distributionByDistributionId": DistributionFilter,
"and": [DistributionCustomFieldFilter],
"or": [DistributionCustomFieldFilter],
"not": DistributionCustomFieldFilter
}
DistributionCustomFieldInput
Description
An input for mutations affecting DistributionCustomField
Example
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"createdBy": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"distributionId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"name": "xyz789",
"value": "xyz789"
}
DistributionCustomFieldPatch
Description
Represents an update to a DistributionCustomField. Fields that are set will be updated.
Example
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"createdBy": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"distributionId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"name": "abc123",
"value": "abc123"
}
DistributionCustomFieldsConnection
Description
A connection to a list of DistributionCustomField values.
Fields
| Field Name | Description |
|---|---|
nodes - [DistributionCustomField]!
|
A list of DistributionCustomField objects. |
edges - [DistributionCustomFieldsEdge!]!
|
A list of edges which contains the DistributionCustomField and cursor to aid in pagination. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The count of all DistributionCustomField you could get from the connection. |
Example
{
"nodes": [DistributionCustomField],
"edges": [DistributionCustomFieldsEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
DistributionCustomFieldsEdge
Description
A DistributionCustomField edge in the connection.
Fields
| Field Name | Description |
|---|---|
cursor - Cursor
|
A cursor for use in pagination. |
node - DistributionCustomField
|
The DistributionCustomField at the end of the edge. |
Example
{
"cursor": Cursor,
"node": DistributionCustomField
}
DistributionCustomFieldsOrderBy
Description
Methods to use when ordering DistributionCustomField.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NATURAL"
DistributionFilter
Description
A filter to be used against Distribution object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
allocationId - UUIDFilter
|
Filter by the object’s allocationId field. |
investorId - UUIDFilter
|
Filter by the object’s investorId field. |
status - StringFilter
|
Filter by the object’s status field. |
amount - BigFloatFilter
|
Filter by the object’s amount field. |
stepId - UUIDFilter
|
Filter by the object’s stepId field. |
newId - UUIDFilter
|
Filter by the object’s newId field. |
draftedBlockchainId - UUIDFilter
|
Filter by the object’s draftedBlockchainId field. |
openBlockchainId - UUIDFilter
|
Filter by the object’s openBlockchainId field. |
closedBlockchainId - UUIDFilter
|
Filter by the object’s closedBlockchainId field. |
lockedBlockchainId - UUIDFilter
|
Filter by the object’s lockedBlockchainId field. |
transactionGroupId - UUIDFilter
|
Filter by the object’s transactionGroupId field. |
triggerArgs - JSONFilter
|
Filter by the object’s triggerArgs field. |
oldId - IntFilter
|
Filter by the object’s oldId field. |
id - UUIDFilter
|
Filter by the object’s id field. |
createdOn - DatetimeFilter
|
Filter by the object’s createdOn field. |
locked - BooleanFilter
|
Filter by the object’s locked field. |
roundId - UUIDFilter
|
Filter by the object’s roundId field. |
issuanceStatus - StringFilter
|
Filter by the object’s issuanceStatus field. |
paidInCapital - BigFloatFilter
|
Filter by the object’s paidInCapital field. |
qualificationsComplete - BooleanFilter
|
Filter by the object’s qualificationsComplete field. |
distributionPricesByDistributionId - DistributionToManyDistributionPriceFilter
|
Filter by the object’s distributionPricesByDistributionId relation. |
distributionPricesByDistributionIdExist - Boolean
|
Some related distributionPricesByDistributionId exist. |
vestingScheduleByDistributionId - VestingScheduleFilter
|
Filter by the object’s vestingScheduleByDistributionId relation. |
vestingScheduleByDistributionIdExists - Boolean
|
A related vestingScheduleByDistributionId exists. |
distributionPaymentsByDistributionId - DistributionToManyDistributionPaymentFilter
|
Filter by the object’s distributionPaymentsByDistributionId relation. |
distributionPaymentsByDistributionIdExist - Boolean
|
Some related distributionPaymentsByDistributionId exist. |
walletAssignmentByDistributionId - WalletAssignmentFilter
|
Filter by the object’s walletAssignmentByDistributionId relation. |
walletAssignmentByDistributionIdExists - Boolean
|
A related walletAssignmentByDistributionId exists. |
distributionAnnotationsByDistributionId - DistributionToManyDistributionAnnotationFilter
|
Filter by the object’s distributionAnnotationsByDistributionId relation. |
distributionAnnotationsByDistributionIdExist - Boolean
|
Some related distributionAnnotationsByDistributionId exist. |
distributionQualificationsByDistributionId - DistributionToManyDistributionQualificationFilter
|
Filter by the object’s distributionQualificationsByDistributionId relation. |
distributionQualificationsByDistributionIdExist - Boolean
|
Some related distributionQualificationsByDistributionId exist. |
distributionCustomFieldsByDistributionId - DistributionToManyDistributionCustomFieldFilter
|
Filter by the object’s distributionCustomFieldsByDistributionId relation. |
distributionCustomFieldsByDistributionIdExist - Boolean
|
Some related distributionCustomFieldsByDistributionId exist. |
issuanceEventByDistributionId - IssuanceEventFilter
|
Filter by the object’s issuanceEventByDistributionId relation. |
issuanceEventByDistributionIdExists - Boolean
|
A related issuanceEventByDistributionId exists. |
allocationByAllocationId - AllocationFilter
|
Filter by the object’s allocationByAllocationId relation. |
accountByInvestorId - AccountFilter
|
Filter by the object’s accountByInvestorId relation. |
distributionStatusByStatus - DistributionStatusFilter
|
Filter by the object’s distributionStatusByStatus relation. |
stepByStepId - StepFilter
|
Filter by the object’s stepByStepId relation. |
and - [DistributionFilter!]
|
Checks for all expressions in this list. |
or - [DistributionFilter!]
|
Checks for any expressions in this list. |
not - DistributionFilter
|
Negates the expression. |
Example
{
"allocationId": UUIDFilter,
"investorId": UUIDFilter,
"status": StringFilter,
"amount": BigFloatFilter,
"stepId": UUIDFilter,
"newId": UUIDFilter,
"draftedBlockchainId": UUIDFilter,
"openBlockchainId": UUIDFilter,
"closedBlockchainId": UUIDFilter,
"lockedBlockchainId": UUIDFilter,
"transactionGroupId": UUIDFilter,
"triggerArgs": JSONFilter,
"oldId": IntFilter,
"id": UUIDFilter,
"createdOn": DatetimeFilter,
"locked": BooleanFilter,
"roundId": UUIDFilter,
"issuanceStatus": StringFilter,
"paidInCapital": BigFloatFilter,
"qualificationsComplete": BooleanFilter,
"distributionPricesByDistributionId": DistributionToManyDistributionPriceFilter,
"distributionPricesByDistributionIdExist": false,
"vestingScheduleByDistributionId": VestingScheduleFilter,
"vestingScheduleByDistributionIdExists": false,
"distributionPaymentsByDistributionId": DistributionToManyDistributionPaymentFilter,
"distributionPaymentsByDistributionIdExist": true,
"walletAssignmentByDistributionId": WalletAssignmentFilter,
"walletAssignmentByDistributionIdExists": false,
"distributionAnnotationsByDistributionId": DistributionToManyDistributionAnnotationFilter,
"distributionAnnotationsByDistributionIdExist": true,
"distributionQualificationsByDistributionId": DistributionToManyDistributionQualificationFilter,
"distributionQualificationsByDistributionIdExist": true,
"distributionCustomFieldsByDistributionId": DistributionToManyDistributionCustomFieldFilter,
"distributionCustomFieldsByDistributionIdExist": true,
"issuanceEventByDistributionId": IssuanceEventFilter,
"issuanceEventByDistributionIdExists": true,
"allocationByAllocationId": AllocationFilter,
"accountByInvestorId": AccountFilter,
"distributionStatusByStatus": DistributionStatusFilter,
"stepByStepId": StepFilter,
"and": [DistributionFilter],
"or": [DistributionFilter],
"not": DistributionFilter
}
DistributionInput
Description
An input for mutations affecting Distribution
Fields
| Input Field | Description |
|---|---|
allocationId - UUID!
|
|
investorId - UUID!
|
|
status - String
|
|
amount - BigFloat!
|
|
stepId - UUID!
|
|
newId - UUID
|
|
draftedBlockchainId - UUID
|
|
openBlockchainId - UUID
|
|
closedBlockchainId - UUID
|
|
lockedBlockchainId - UUID
|
|
transactionGroupId - UUID
|
|
triggerArgs - JSON
|
|
oldId - Int
|
|
id - UUID
|
|
createdOn - Datetime
|
|
locked - Boolean
|
|
roundId - UUID
|
Example
{
"allocationId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"investorId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"status": "abc123",
"amount": BigFloat,
"stepId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"newId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"draftedBlockchainId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"openBlockchainId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"closedBlockchainId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"lockedBlockchainId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"transactionGroupId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"triggerArgs": {},
"oldId": 987,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"createdOn": Datetime,
"locked": true,
"roundId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
DistributionPatch
Description
Represents an update to a Distribution. Fields that are set will be updated.
Fields
| Input Field | Description |
|---|---|
allocationId - UUID
|
|
investorId - UUID
|
|
status - String
|
|
amount - BigFloat
|
|
stepId - UUID
|
|
newId - UUID
|
|
draftedBlockchainId - UUID
|
|
openBlockchainId - UUID
|
|
closedBlockchainId - UUID
|
|
lockedBlockchainId - UUID
|
|
transactionGroupId - UUID
|
|
triggerArgs - JSON
|
|
oldId - Int
|
|
id - UUID
|
|
createdOn - Datetime
|
|
locked - Boolean
|
|
roundId - UUID
|
Example
{
"allocationId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"investorId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"status": "xyz789",
"amount": BigFloat,
"stepId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"newId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"draftedBlockchainId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"openBlockchainId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"closedBlockchainId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"lockedBlockchainId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"transactionGroupId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"triggerArgs": {},
"oldId": 987,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"createdOn": Datetime,
"locked": false,
"roundId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
DistributionPayment
Fields
| Field Name | Description |
|---|---|
nodeId - ID!
|
A globally unique identifier. Can be used in various places throughout the system to identify this single value. |
distributionId - UUID!
|
|
currency - UUID!
|
|
amount - BigFloat!
|
|
paidOn - Datetime
|
|
id - UUID!
|
|
transactionGroupId - UUID!
|
|
note - String
|
|
status - String!
|
|
distributionByDistributionId - Distribution
|
Reads a single Distribution that is related to this DistributionPayment. |
currencyByCurrency - Currency
|
Reads a single Currency that is related to this DistributionPayment. |
distributionPaymentStatusByStatus - DistributionPaymentStatus
|
Reads a single DistributionPaymentStatus that is related to this DistributionPayment. |
Example
{
"nodeId": 4,
"distributionId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"currency": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"amount": BigFloat,
"paidOn": Datetime,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"transactionGroupId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"note": "abc123",
"status": "xyz789",
"distributionByDistributionId": Distribution,
"currencyByCurrency": Currency,
"distributionPaymentStatusByStatus": DistributionPaymentStatus
}
DistributionPaymentCondition
Description
A condition to be used against DistributionPayment object types. All fields are tested for equality and combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
distributionId - UUID
|
Checks for equality with the object’s distributionId field. |
currency - UUID
|
Checks for equality with the object’s currency field. |
amount - BigFloat
|
Checks for equality with the object’s amount field. |
paidOn - Datetime
|
Checks for equality with the object’s paidOn field. |
id - UUID
|
Checks for equality with the object’s id field. |
transactionGroupId - UUID
|
Checks for equality with the object’s transactionGroupId field. |
note - String
|
Checks for equality with the object’s note field. |
status - String
|
Checks for equality with the object’s status field. |
Example
{
"distributionId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"currency": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"amount": BigFloat,
"paidOn": Datetime,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"transactionGroupId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"note": "xyz789",
"status": "abc123"
}
DistributionPaymentFilter
Description
A filter to be used against DistributionPayment object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
distributionId - UUIDFilter
|
Filter by the object’s distributionId field. |
currency - UUIDFilter
|
Filter by the object’s currency field. |
amount - BigFloatFilter
|
Filter by the object’s amount field. |
paidOn - DatetimeFilter
|
Filter by the object’s paidOn field. |
id - UUIDFilter
|
Filter by the object’s id field. |
transactionGroupId - UUIDFilter
|
Filter by the object’s transactionGroupId field. |
note - StringFilter
|
Filter by the object’s note field. |
status - StringFilter
|
Filter by the object’s status field. |
distributionByDistributionId - DistributionFilter
|
Filter by the object’s distributionByDistributionId relation. |
currencyByCurrency - CurrencyFilter
|
Filter by the object’s currencyByCurrency relation. |
distributionPaymentStatusByStatus - DistributionPaymentStatusFilter
|
Filter by the object’s distributionPaymentStatusByStatus relation. |
and - [DistributionPaymentFilter!]
|
Checks for all expressions in this list. |
or - [DistributionPaymentFilter!]
|
Checks for any expressions in this list. |
not - DistributionPaymentFilter
|
Negates the expression. |
Example
{
"distributionId": UUIDFilter,
"currency": UUIDFilter,
"amount": BigFloatFilter,
"paidOn": DatetimeFilter,
"id": UUIDFilter,
"transactionGroupId": UUIDFilter,
"note": StringFilter,
"status": StringFilter,
"distributionByDistributionId": DistributionFilter,
"currencyByCurrency": CurrencyFilter,
"distributionPaymentStatusByStatus": DistributionPaymentStatusFilter,
"and": [DistributionPaymentFilter],
"or": [DistributionPaymentFilter],
"not": DistributionPaymentFilter
}
DistributionPaymentInput
Description
An input for mutations affecting DistributionPayment
Example
{
"distributionId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"currency": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"amount": BigFloat,
"paidOn": Datetime,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"transactionGroupId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"note": "xyz789",
"status": "xyz789"
}
DistributionPaymentPatch
Description
Represents an update to a DistributionPayment. Fields that are set will be updated.
Example
{
"distributionId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"currency": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"amount": BigFloat,
"paidOn": Datetime,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"transactionGroupId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"note": "abc123",
"status": "xyz789"
}
DistributionPaymentStatus
Fields
| Field Name | Description |
|---|---|
nodeId - ID!
|
A globally unique identifier. Can be used in various places throughout the system to identify this single value. |
status - String!
|
|
distributionPaymentsByStatus - DistributionPaymentsConnection!
|
Reads and enables pagination through a set of DistributionPayment. |
Arguments
|
|
Example
{
"nodeId": "4",
"status": "xyz789",
"distributionPaymentsByStatus": DistributionPaymentsConnection
}
DistributionPaymentStatusCondition
Description
A condition to be used against DistributionPaymentStatus object types. All fields are tested for equality and combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
status - String
|
Checks for equality with the object’s status field. |
Example
{"status": "xyz789"}
DistributionPaymentStatusFilter
Description
A filter to be used against DistributionPaymentStatus object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
status - StringFilter
|
Filter by the object’s status field. |
distributionPaymentsByStatus - DistributionPaymentStatusToManyDistributionPaymentFilter
|
Filter by the object’s distributionPaymentsByStatus relation. |
distributionPaymentsByStatusExist - Boolean
|
Some related distributionPaymentsByStatus exist. |
and - [DistributionPaymentStatusFilter!]
|
Checks for all expressions in this list. |
or - [DistributionPaymentStatusFilter!]
|
Checks for any expressions in this list. |
not - DistributionPaymentStatusFilter
|
Negates the expression. |
Example
{
"status": StringFilter,
"distributionPaymentsByStatus": DistributionPaymentStatusToManyDistributionPaymentFilter,
"distributionPaymentsByStatusExist": true,
"and": [DistributionPaymentStatusFilter],
"or": [DistributionPaymentStatusFilter],
"not": DistributionPaymentStatusFilter
}
DistributionPaymentStatusToManyDistributionPaymentFilter
Description
A filter to be used against many DistributionPayment object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - DistributionPaymentFilter
|
Every related DistributionPayment matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - DistributionPaymentFilter
|
Some related DistributionPayment matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - DistributionPaymentFilter
|
No related DistributionPayment matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": DistributionPaymentFilter,
"some": DistributionPaymentFilter,
"none": DistributionPaymentFilter
}
DistributionPaymentStatusesConnection
Description
A connection to a list of DistributionPaymentStatus values.
Fields
| Field Name | Description |
|---|---|
nodes - [DistributionPaymentStatus]!
|
A list of DistributionPaymentStatus objects. |
edges - [DistributionPaymentStatusesEdge!]!
|
A list of edges which contains the DistributionPaymentStatus and cursor to aid in pagination. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The count of all DistributionPaymentStatus you could get from the connection. |
Example
{
"nodes": [DistributionPaymentStatus],
"edges": [DistributionPaymentStatusesEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
DistributionPaymentStatusesEdge
Description
A DistributionPaymentStatus edge in the connection.
Fields
| Field Name | Description |
|---|---|
cursor - Cursor
|
A cursor for use in pagination. |
node - DistributionPaymentStatus
|
The DistributionPaymentStatus at the end of the edge. |
Example
{
"cursor": Cursor,
"node": DistributionPaymentStatus
}
DistributionPaymentStatusesOrderBy
Description
Methods to use when ordering DistributionPaymentStatus.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NATURAL"
DistributionPaymentsConnection
Description
A connection to a list of DistributionPayment values.
Fields
| Field Name | Description |
|---|---|
nodes - [DistributionPayment]!
|
A list of DistributionPayment objects. |
edges - [DistributionPaymentsEdge!]!
|
A list of edges which contains the DistributionPayment and cursor to aid in pagination. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The count of all DistributionPayment you could get from the connection. |
Example
{
"nodes": [DistributionPayment],
"edges": [DistributionPaymentsEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
DistributionPaymentsEdge
Description
A DistributionPayment edge in the connection.
Fields
| Field Name | Description |
|---|---|
cursor - Cursor
|
A cursor for use in pagination. |
node - DistributionPayment
|
The DistributionPayment at the end of the edge. |
Example
{
"cursor": Cursor,
"node": DistributionPayment
}
DistributionPaymentsOrderBy
Description
Methods to use when ordering DistributionPayment.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NATURAL"
DistributionPrice
Fields
| Field Name | Description |
|---|---|
nodeId - ID!
|
A globally unique identifier. Can be used in various places throughout the system to identify this single value. |
distributionId - UUID!
|
|
currency - UUID!
|
|
price - BigFloat!
|
|
id - UUID!
|
|
isPurchase - Boolean!
|
|
locked - Boolean!
|
|
distributionByDistributionId - Distribution
|
Reads a single Distribution that is related to this DistributionPrice. |
currencyByCurrency - Currency
|
Reads a single Currency that is related to this DistributionPrice. |
Example
{
"nodeId": "4",
"distributionId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"currency": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"price": BigFloat,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"isPurchase": false,
"locked": false,
"distributionByDistributionId": Distribution,
"currencyByCurrency": Currency
}
DistributionPriceCondition
Description
A condition to be used against DistributionPrice object types. All fields are tested for equality and combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
distributionId - UUID
|
Checks for equality with the object’s distributionId field. |
currency - UUID
|
Checks for equality with the object’s currency field. |
price - BigFloat
|
Checks for equality with the object’s price field. |
id - UUID
|
Checks for equality with the object’s id field. |
isPurchase - Boolean
|
Checks for equality with the object’s isPurchase field. |
locked - Boolean
|
Checks for equality with the object’s locked field. |
Example
{
"distributionId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"currency": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"price": BigFloat,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"isPurchase": false,
"locked": false
}
DistributionPriceFilter
Description
A filter to be used against DistributionPrice object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
distributionId - UUIDFilter
|
Filter by the object’s distributionId field. |
currency - UUIDFilter
|
Filter by the object’s currency field. |
price - BigFloatFilter
|
Filter by the object’s price field. |
id - UUIDFilter
|
Filter by the object’s id field. |
isPurchase - BooleanFilter
|
Filter by the object’s isPurchase field. |
locked - BooleanFilter
|
Filter by the object’s locked field. |
distributionByDistributionId - DistributionFilter
|
Filter by the object’s distributionByDistributionId relation. |
currencyByCurrency - CurrencyFilter
|
Filter by the object’s currencyByCurrency relation. |
and - [DistributionPriceFilter!]
|
Checks for all expressions in this list. |
or - [DistributionPriceFilter!]
|
Checks for any expressions in this list. |
not - DistributionPriceFilter
|
Negates the expression. |
Example
{
"distributionId": UUIDFilter,
"currency": UUIDFilter,
"price": BigFloatFilter,
"id": UUIDFilter,
"isPurchase": BooleanFilter,
"locked": BooleanFilter,
"distributionByDistributionId": DistributionFilter,
"currencyByCurrency": CurrencyFilter,
"and": [DistributionPriceFilter],
"or": [DistributionPriceFilter],
"not": DistributionPriceFilter
}
DistributionPriceInput
Description
An input for mutations affecting DistributionPrice
Example
{
"distributionId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"currency": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"price": BigFloat,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"isPurchase": true,
"locked": true
}
DistributionPricePatch
Description
Represents an update to a DistributionPrice. Fields that are set will be updated.
Example
{
"distributionId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"currency": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"price": BigFloat,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"isPurchase": false,
"locked": false
}
DistributionPricesConnection
Description
A connection to a list of DistributionPrice values.
Fields
| Field Name | Description |
|---|---|
nodes - [DistributionPrice]!
|
A list of DistributionPrice objects. |
edges - [DistributionPricesEdge!]!
|
A list of edges which contains the DistributionPrice and cursor to aid in pagination. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The count of all DistributionPrice you could get from the connection. |
Example
{
"nodes": [DistributionPrice],
"edges": [DistributionPricesEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
DistributionPricesEdge
Description
A DistributionPrice edge in the connection.
Fields
| Field Name | Description |
|---|---|
cursor - Cursor
|
A cursor for use in pagination. |
node - DistributionPrice
|
The DistributionPrice at the end of the edge. |
Example
{
"cursor": Cursor,
"node": DistributionPrice
}
DistributionPricesOrderBy
Description
Methods to use when ordering DistributionPrice.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NATURAL"
DistributionQualification
Fields
| Field Name | Description |
|---|---|
nodeId - ID!
|
A globally unique identifier. Can be used in various places throughout the system to identify this single value. |
id - UUID!
|
|
vendorQualificationId - UUID!
|
|
distributionId - UUID!
|
|
integrationId - UUID!
|
|
stepId - UUID!
|
|
executeOrder - Int!
|
|
locked - Boolean!
|
|
vendorQualificationByVendorQualificationId - VendorQualification
|
Reads a single VendorQualification that is related to this DistributionQualification. |
distributionByDistributionId - Distribution
|
Reads a single Distribution that is related to this DistributionQualification. |
integrationByIntegrationId - Integration
|
Reads a single Integration that is related to this DistributionQualification. |
stepByStepId - Step
|
Reads a single Step that is related to this DistributionQualification. |
status - String
|
Example
{
"nodeId": "4",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"vendorQualificationId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"distributionId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"integrationId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"stepId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"executeOrder": 987,
"locked": false,
"vendorQualificationByVendorQualificationId": VendorQualification,
"distributionByDistributionId": Distribution,
"integrationByIntegrationId": Integration,
"stepByStepId": Step,
"status": "abc123"
}
DistributionQualificationCondition
Description
A condition to be used against DistributionQualification object types. All fields are tested for equality and combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
id - UUID
|
Checks for equality with the object’s id field. |
vendorQualificationId - UUID
|
Checks for equality with the object’s vendorQualificationId field. |
distributionId - UUID
|
Checks for equality with the object’s distributionId field. |
integrationId - UUID
|
Checks for equality with the object’s integrationId field. |
stepId - UUID
|
Checks for equality with the object’s stepId field. |
executeOrder - Int
|
Checks for equality with the object’s executeOrder field. |
locked - Boolean
|
Checks for equality with the object’s locked field. |
Example
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"vendorQualificationId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"distributionId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"integrationId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"stepId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"executeOrder": 987,
"locked": false
}
DistributionQualificationFilter
Description
A filter to be used against DistributionQualification object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
id - UUIDFilter
|
Filter by the object’s id field. |
vendorQualificationId - UUIDFilter
|
Filter by the object’s vendorQualificationId field. |
distributionId - UUIDFilter
|
Filter by the object’s distributionId field. |
integrationId - UUIDFilter
|
Filter by the object’s integrationId field. |
stepId - UUIDFilter
|
Filter by the object’s stepId field. |
executeOrder - IntFilter
|
Filter by the object’s executeOrder field. |
locked - BooleanFilter
|
Filter by the object’s locked field. |
status - StringFilter
|
Filter by the object’s status field. |
vendorQualificationByVendorQualificationId - VendorQualificationFilter
|
Filter by the object’s vendorQualificationByVendorQualificationId relation. |
distributionByDistributionId - DistributionFilter
|
Filter by the object’s distributionByDistributionId relation. |
integrationByIntegrationId - IntegrationFilter
|
Filter by the object’s integrationByIntegrationId relation. |
stepByStepId - StepFilter
|
Filter by the object’s stepByStepId relation. |
and - [DistributionQualificationFilter!]
|
Checks for all expressions in this list. |
or - [DistributionQualificationFilter!]
|
Checks for any expressions in this list. |
not - DistributionQualificationFilter
|
Negates the expression. |
Example
{
"id": UUIDFilter,
"vendorQualificationId": UUIDFilter,
"distributionId": UUIDFilter,
"integrationId": UUIDFilter,
"stepId": UUIDFilter,
"executeOrder": IntFilter,
"locked": BooleanFilter,
"status": StringFilter,
"vendorQualificationByVendorQualificationId": VendorQualificationFilter,
"distributionByDistributionId": DistributionFilter,
"integrationByIntegrationId": IntegrationFilter,
"stepByStepId": StepFilter,
"and": [DistributionQualificationFilter],
"or": [DistributionQualificationFilter],
"not": DistributionQualificationFilter
}
DistributionQualificationsConnection
Description
A connection to a list of DistributionQualification values.
Fields
| Field Name | Description |
|---|---|
nodes - [DistributionQualification]!
|
A list of DistributionQualification objects. |
edges - [DistributionQualificationsEdge!]!
|
A list of edges which contains the DistributionQualification and cursor to aid in pagination. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The count of all DistributionQualification you could get from the connection. |
Example
{
"nodes": [DistributionQualification],
"edges": [DistributionQualificationsEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
DistributionQualificationsEdge
Description
A DistributionQualification edge in the connection.
Fields
| Field Name | Description |
|---|---|
cursor - Cursor
|
A cursor for use in pagination. |
node - DistributionQualification
|
The DistributionQualification at the end of the edge. |
Example
{
"cursor": Cursor,
"node": DistributionQualification
}
DistributionQualificationsOrderBy
Description
Methods to use when ordering DistributionQualification.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NATURAL"
DistributionStatus
Fields
| Field Name | Description |
|---|---|
nodeId - ID!
|
A globally unique identifier. Can be used in various places throughout the system to identify this single value. |
status - String!
|
|
distributionsByStatus - DistributionsConnection!
|
Reads and enables pagination through a set of Distribution. |
Arguments
|
|
Example
{
"nodeId": 4,
"status": "abc123",
"distributionsByStatus": DistributionsConnection
}
DistributionStatusCondition
Description
A condition to be used against DistributionStatus object types. All fields are tested for equality and combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
status - String
|
Checks for equality with the object’s status field. |
Example
{"status": "xyz789"}
DistributionStatusFilter
Description
A filter to be used against DistributionStatus object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
status - StringFilter
|
Filter by the object’s status field. |
distributionsByStatus - DistributionStatusToManyDistributionFilter
|
Filter by the object’s distributionsByStatus relation. |
distributionsByStatusExist - Boolean
|
Some related distributionsByStatus exist. |
and - [DistributionStatusFilter!]
|
Checks for all expressions in this list. |
or - [DistributionStatusFilter!]
|
Checks for any expressions in this list. |
not - DistributionStatusFilter
|
Negates the expression. |
Example
{
"status": StringFilter,
"distributionsByStatus": DistributionStatusToManyDistributionFilter,
"distributionsByStatusExist": false,
"and": [DistributionStatusFilter],
"or": [DistributionStatusFilter],
"not": DistributionStatusFilter
}
DistributionStatusToManyDistributionFilter
Description
A filter to be used against many Distribution object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - DistributionFilter
|
Every related Distribution matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - DistributionFilter
|
Some related Distribution matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - DistributionFilter
|
No related Distribution matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": DistributionFilter,
"some": DistributionFilter,
"none": DistributionFilter
}
DistributionStatusesConnection
Description
A connection to a list of DistributionStatus values.
Fields
| Field Name | Description |
|---|---|
nodes - [DistributionStatus]!
|
A list of DistributionStatus objects. |
edges - [DistributionStatusesEdge!]!
|
A list of edges which contains the DistributionStatus and cursor to aid in pagination. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The count of all DistributionStatus you could get from the connection. |
Example
{
"nodes": [DistributionStatus],
"edges": [DistributionStatusesEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
DistributionStatusesEdge
Description
A DistributionStatus edge in the connection.
Fields
| Field Name | Description |
|---|---|
cursor - Cursor
|
A cursor for use in pagination. |
node - DistributionStatus
|
The DistributionStatus at the end of the edge. |
Example
{
"cursor": Cursor,
"node": DistributionStatus
}
DistributionStatusesOrderBy
Description
Methods to use when ordering DistributionStatus.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NATURAL"
DistributionToManyDistributionAnnotationFilter
Description
A filter to be used against many DistributionAnnotation object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - DistributionAnnotationFilter
|
Every related DistributionAnnotation matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - DistributionAnnotationFilter
|
Some related DistributionAnnotation matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - DistributionAnnotationFilter
|
No related DistributionAnnotation matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": DistributionAnnotationFilter,
"some": DistributionAnnotationFilter,
"none": DistributionAnnotationFilter
}
DistributionToManyDistributionCustomFieldFilter
Description
A filter to be used against many DistributionCustomField object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - DistributionCustomFieldFilter
|
Every related DistributionCustomField matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - DistributionCustomFieldFilter
|
Some related DistributionCustomField matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - DistributionCustomFieldFilter
|
No related DistributionCustomField matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": DistributionCustomFieldFilter,
"some": DistributionCustomFieldFilter,
"none": DistributionCustomFieldFilter
}
DistributionToManyDistributionPaymentFilter
Description
A filter to be used against many DistributionPayment object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - DistributionPaymentFilter
|
Every related DistributionPayment matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - DistributionPaymentFilter
|
Some related DistributionPayment matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - DistributionPaymentFilter
|
No related DistributionPayment matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": DistributionPaymentFilter,
"some": DistributionPaymentFilter,
"none": DistributionPaymentFilter
}
DistributionToManyDistributionPriceFilter
Description
A filter to be used against many DistributionPrice object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - DistributionPriceFilter
|
Every related DistributionPrice matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - DistributionPriceFilter
|
Some related DistributionPrice matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - DistributionPriceFilter
|
No related DistributionPrice matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": DistributionPriceFilter,
"some": DistributionPriceFilter,
"none": DistributionPriceFilter
}
DistributionToManyDistributionQualificationFilter
Description
A filter to be used against many DistributionQualification object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - DistributionQualificationFilter
|
Every related DistributionQualification matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - DistributionQualificationFilter
|
Some related DistributionQualification matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - DistributionQualificationFilter
|
No related DistributionQualification matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": DistributionQualificationFilter,
"some": DistributionQualificationFilter,
"none": DistributionQualificationFilter
}
DistributionsConnection
Description
A connection to a list of Distribution values.
Fields
| Field Name | Description |
|---|---|
nodes - [Distribution]!
|
A list of Distribution objects. |
edges - [DistributionsEdge!]!
|
A list of edges which contains the Distribution and cursor to aid in pagination. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The count of all Distribution you could get from the connection. |
Example
{
"nodes": [Distribution],
"edges": [DistributionsEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
DistributionsEdge
Description
A Distribution edge in the connection.
Fields
| Field Name | Description |
|---|---|
cursor - Cursor
|
A cursor for use in pagination. |
node - Distribution
|
The Distribution at the end of the edge. |
Example
{
"cursor": Cursor,
"node": Distribution
}
DistributionsOrderBy
Description
Methods to use when ordering Distribution.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NATURAL"
Document
Fields
| Field Name | Description |
|---|---|
nodeId - ID!
|
A globally unique identifier. Can be used in various places throughout the system to identify this single value. |
id - UUID!
|
|
name - String!
|
|
extension - String!
|
|
uploadEnd - Datetime
|
|
createdOn - Datetime!
|
|
uploadStatus - String!
|
|
uploadedBy - UUID!
|
|
type - String!
|
|
documentStatusByUploadStatus - DocumentStatus
|
Reads a single DocumentStatus that is related to this Document. |
accountByUploadedBy - Account
|
Reads a single Account that is related to this Document. |
documentTypeByType - DocumentType
|
Reads a single DocumentType that is related to this Document. |
holdingDocumentsByDocumentId - HoldingDocumentsConnection!
|
Reads and enables pagination through a set of HoldingDocument. |
Arguments
|
|
accountDocumentsByDocumentId - AccountDocumentsConnection!
|
Reads and enables pagination through a set of AccountDocument. |
Arguments
|
|
documentSharingsByDocumentId - DocumentSharingsConnection!
|
Reads and enables pagination through a set of DocumentSharing. |
Arguments
|
|
securityDocumentsByDocumentId - SecurityDocumentsConnection!
|
Reads and enables pagination through a set of SecurityDocument. |
Arguments
|
|
downloadUrl - String
|
|
Example
{
"nodeId": "4",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"name": "abc123",
"extension": "abc123",
"uploadEnd": Datetime,
"createdOn": Datetime,
"uploadStatus": "xyz789",
"uploadedBy": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"type": "xyz789",
"documentStatusByUploadStatus": DocumentStatus,
"accountByUploadedBy": Account,
"documentTypeByType": DocumentType,
"holdingDocumentsByDocumentId": HoldingDocumentsConnection,
"accountDocumentsByDocumentId": AccountDocumentsConnection,
"documentSharingsByDocumentId": DocumentSharingsConnection,
"securityDocumentsByDocumentId": SecurityDocumentsConnection,
"downloadUrl": "xyz789"
}
DocumentCondition
Description
A condition to be used against Document object types. All fields are tested for equality and combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
id - UUID
|
Checks for equality with the object’s id field. |
name - String
|
Checks for equality with the object’s name field. |
extension - String
|
Checks for equality with the object’s extension field. |
uploadEnd - Datetime
|
Checks for equality with the object’s uploadEnd field. |
createdOn - Datetime
|
Checks for equality with the object’s createdOn field. |
uploadStatus - String
|
Checks for equality with the object’s uploadStatus field. |
uploadedBy - UUID
|
Checks for equality with the object’s uploadedBy field. |
type - String
|
Checks for equality with the object’s type field. |
Example
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"name": "abc123",
"extension": "xyz789",
"uploadEnd": Datetime,
"createdOn": Datetime,
"uploadStatus": "xyz789",
"uploadedBy": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"type": "xyz789"
}
DocumentFilter
Description
A filter to be used against Document object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
id - UUIDFilter
|
Filter by the object’s id field. |
name - StringFilter
|
Filter by the object’s name field. |
extension - StringFilter
|
Filter by the object’s extension field. |
uploadEnd - DatetimeFilter
|
Filter by the object’s uploadEnd field. |
createdOn - DatetimeFilter
|
Filter by the object’s createdOn field. |
uploadStatus - StringFilter
|
Filter by the object’s uploadStatus field. |
uploadedBy - UUIDFilter
|
Filter by the object’s uploadedBy field. |
type - StringFilter
|
Filter by the object’s type field. |
holdingDocumentsByDocumentId - DocumentToManyHoldingDocumentFilter
|
Filter by the object’s holdingDocumentsByDocumentId relation. |
holdingDocumentsByDocumentIdExist - Boolean
|
Some related holdingDocumentsByDocumentId exist. |
accountDocumentsByDocumentId - DocumentToManyAccountDocumentFilter
|
Filter by the object’s accountDocumentsByDocumentId relation. |
accountDocumentsByDocumentIdExist - Boolean
|
Some related accountDocumentsByDocumentId exist. |
documentSharingsByDocumentId - DocumentToManyDocumentSharingFilter
|
Filter by the object’s documentSharingsByDocumentId relation. |
documentSharingsByDocumentIdExist - Boolean
|
Some related documentSharingsByDocumentId exist. |
securityDocumentsByDocumentId - DocumentToManySecurityDocumentFilter
|
Filter by the object’s securityDocumentsByDocumentId relation. |
securityDocumentsByDocumentIdExist - Boolean
|
Some related securityDocumentsByDocumentId exist. |
documentStatusByUploadStatus - DocumentStatusFilter
|
Filter by the object’s documentStatusByUploadStatus relation. |
accountByUploadedBy - AccountFilter
|
Filter by the object’s accountByUploadedBy relation. |
documentTypeByType - DocumentTypeFilter
|
Filter by the object’s documentTypeByType relation. |
and - [DocumentFilter!]
|
Checks for all expressions in this list. |
or - [DocumentFilter!]
|
Checks for any expressions in this list. |
not - DocumentFilter
|
Negates the expression. |
Example
{
"id": UUIDFilter,
"name": StringFilter,
"extension": StringFilter,
"uploadEnd": DatetimeFilter,
"createdOn": DatetimeFilter,
"uploadStatus": StringFilter,
"uploadedBy": UUIDFilter,
"type": StringFilter,
"holdingDocumentsByDocumentId": DocumentToManyHoldingDocumentFilter,
"holdingDocumentsByDocumentIdExist": true,
"accountDocumentsByDocumentId": DocumentToManyAccountDocumentFilter,
"accountDocumentsByDocumentIdExist": true,
"documentSharingsByDocumentId": DocumentToManyDocumentSharingFilter,
"documentSharingsByDocumentIdExist": false,
"securityDocumentsByDocumentId": DocumentToManySecurityDocumentFilter,
"securityDocumentsByDocumentIdExist": true,
"documentStatusByUploadStatus": DocumentStatusFilter,
"accountByUploadedBy": AccountFilter,
"documentTypeByType": DocumentTypeFilter,
"and": [DocumentFilter],
"or": [DocumentFilter],
"not": DocumentFilter
}
DocumentSharing
Fields
| Field Name | Description |
|---|---|
nodeId - ID!
|
A globally unique identifier. Can be used in various places throughout the system to identify this single value. |
id - UUID!
|
|
documentId - UUID!
|
|
uploaderId - UUID!
|
|
toRole - String!
|
|
createdBy - UUID!
|
|
documentSharingAllowedShareId - UUID!
|
|
name - String!
|
|
documentByDocumentId - Document
|
Reads a single Document that is related to this DocumentSharing. |
accountByUploaderId - Account
|
Reads a single Account that is related to this DocumentSharing. |
documentSharingRoleByToRole - DocumentSharingRole
|
Reads a single DocumentSharingRole that is related to this DocumentSharing. |
userByCreatedBy - User
|
Reads a single User that is related to this DocumentSharing. |
Example
{
"nodeId": 4,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"documentId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"uploaderId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"toRole": "abc123",
"createdBy": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"documentSharingAllowedShareId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"name": "xyz789",
"documentByDocumentId": Document,
"accountByUploaderId": Account,
"documentSharingRoleByToRole": DocumentSharingRole,
"userByCreatedBy": User
}
DocumentSharingCondition
Description
A condition to be used against DocumentSharing object types. All fields are tested for equality and combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
id - UUID
|
Checks for equality with the object’s id field. |
documentId - UUID
|
Checks for equality with the object’s documentId field. |
uploaderId - UUID
|
Checks for equality with the object’s uploaderId field. |
toRole - String
|
Checks for equality with the object’s toRole field. |
createdBy - UUID
|
Checks for equality with the object’s createdBy field. |
documentSharingAllowedShareId - UUID
|
Checks for equality with the object’s documentSharingAllowedShareId field. |
name - String
|
Checks for equality with the object’s name field. |
Example
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"documentId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"uploaderId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"toRole": "xyz789",
"createdBy": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"documentSharingAllowedShareId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"name": "xyz789"
}
DocumentSharingFilter
Description
A filter to be used against DocumentSharing object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
id - UUIDFilter
|
Filter by the object’s id field. |
documentId - UUIDFilter
|
Filter by the object’s documentId field. |
uploaderId - UUIDFilter
|
Filter by the object’s uploaderId field. |
toRole - StringFilter
|
Filter by the object’s toRole field. |
createdBy - UUIDFilter
|
Filter by the object’s createdBy field. |
documentSharingAllowedShareId - UUIDFilter
|
Filter by the object’s documentSharingAllowedShareId field. |
name - StringFilter
|
Filter by the object’s name field. |
documentByDocumentId - DocumentFilter
|
Filter by the object’s documentByDocumentId relation. |
accountByUploaderId - AccountFilter
|
Filter by the object’s accountByUploaderId relation. |
documentSharingRoleByToRole - DocumentSharingRoleFilter
|
Filter by the object’s documentSharingRoleByToRole relation. |
userByCreatedBy - UserFilter
|
Filter by the object’s userByCreatedBy relation. |
and - [DocumentSharingFilter!]
|
Checks for all expressions in this list. |
or - [DocumentSharingFilter!]
|
Checks for any expressions in this list. |
not - DocumentSharingFilter
|
Negates the expression. |
Example
{
"id": UUIDFilter,
"documentId": UUIDFilter,
"uploaderId": UUIDFilter,
"toRole": StringFilter,
"createdBy": UUIDFilter,
"documentSharingAllowedShareId": UUIDFilter,
"name": StringFilter,
"documentByDocumentId": DocumentFilter,
"accountByUploaderId": AccountFilter,
"documentSharingRoleByToRole": DocumentSharingRoleFilter,
"userByCreatedBy": UserFilter,
"and": [DocumentSharingFilter],
"or": [DocumentSharingFilter],
"not": DocumentSharingFilter
}
DocumentSharingRole
Fields
| Field Name | Description |
|---|---|
nodeId - ID!
|
A globally unique identifier. Can be used in various places throughout the system to identify this single value. |
role - String!
|
|
documentSharingAllowedSharesByToRole - DocumentSharingAllowedSharesConnection!
|
Reads and enables pagination through a set of DocumentSharingAllowedShare. |
Arguments
|
|
documentSharingsByToRole - DocumentSharingsConnection!
|
Reads and enables pagination through a set of DocumentSharing. |
Arguments
|
|
Example
{
"nodeId": 4,
"role": "abc123",
"documentSharingAllowedSharesByToRole": DocumentSharingAllowedSharesConnection,
"documentSharingsByToRole": DocumentSharingsConnection
}
DocumentSharingRoleCondition
Description
A condition to be used against DocumentSharingRole object types. All fields are tested for equality and combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
role - String
|
Checks for equality with the object’s role field. |
Example
{"role": "abc123"}
DocumentSharingRoleFilter
Description
A filter to be used against DocumentSharingRole object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
role - StringFilter
|
Filter by the object’s role field. |
documentSharingAllowedSharesByToRole - DocumentSharingRoleToManyDocumentSharingAllowedShareFilter
|
Filter by the object’s documentSharingAllowedSharesByToRole relation. |
documentSharingAllowedSharesByToRoleExist - Boolean
|
Some related documentSharingAllowedSharesByToRole exist. |
documentSharingsByToRole - DocumentSharingRoleToManyDocumentSharingFilter
|
Filter by the object’s documentSharingsByToRole relation. |
documentSharingsByToRoleExist - Boolean
|
Some related documentSharingsByToRole exist. |
and - [DocumentSharingRoleFilter!]
|
Checks for all expressions in this list. |
or - [DocumentSharingRoleFilter!]
|
Checks for any expressions in this list. |
not - DocumentSharingRoleFilter
|
Negates the expression. |
Example
{
"role": StringFilter,
"documentSharingAllowedSharesByToRole": DocumentSharingRoleToManyDocumentSharingAllowedShareFilter,
"documentSharingAllowedSharesByToRoleExist": true,
"documentSharingsByToRole": DocumentSharingRoleToManyDocumentSharingFilter,
"documentSharingsByToRoleExist": false,
"and": [DocumentSharingRoleFilter],
"or": [DocumentSharingRoleFilter],
"not": DocumentSharingRoleFilter
}
DocumentSharingRoleToManyDocumentSharingFilter
Description
A filter to be used against many DocumentSharing object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - DocumentSharingFilter
|
Every related DocumentSharing matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - DocumentSharingFilter
|
Some related DocumentSharing matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - DocumentSharingFilter
|
No related DocumentSharing matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": DocumentSharingFilter,
"some": DocumentSharingFilter,
"none": DocumentSharingFilter
}
DocumentSharingRolesConnection
Description
A connection to a list of DocumentSharingRole values.
Fields
| Field Name | Description |
|---|---|
nodes - [DocumentSharingRole]!
|
A list of DocumentSharingRole objects. |
edges - [DocumentSharingRolesEdge!]!
|
A list of edges which contains the DocumentSharingRole and cursor to aid in pagination. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The count of all DocumentSharingRole you could get from the connection. |
Example
{
"nodes": [DocumentSharingRole],
"edges": [DocumentSharingRolesEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
DocumentSharingRolesEdge
Description
A DocumentSharingRole edge in the connection.
Fields
| Field Name | Description |
|---|---|
cursor - Cursor
|
A cursor for use in pagination. |
node - DocumentSharingRole
|
The DocumentSharingRole at the end of the edge. |
Example
{
"cursor": Cursor,
"node": DocumentSharingRole
}
DocumentSharingRolesOrderBy
Description
Methods to use when ordering DocumentSharingRole.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NATURAL"
DocumentSharingsConnection
Description
A connection to a list of DocumentSharing values.
Fields
| Field Name | Description |
|---|---|
nodes - [DocumentSharing]!
|
A list of DocumentSharing objects. |
edges - [DocumentSharingsEdge!]!
|
A list of edges which contains the DocumentSharing and cursor to aid in pagination. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The count of all DocumentSharing you could get from the connection. |
Example
{
"nodes": [DocumentSharing],
"edges": [DocumentSharingsEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
DocumentSharingsEdge
Description
A DocumentSharing edge in the connection.
Fields
| Field Name | Description |
|---|---|
cursor - Cursor
|
A cursor for use in pagination. |
node - DocumentSharing
|
The DocumentSharing at the end of the edge. |
Example
{
"cursor": Cursor,
"node": DocumentSharing
}
DocumentSharingsOrderBy
Description
Methods to use when ordering DocumentSharing.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NATURAL"
DocumentStatus
Fields
| Field Name | Description |
|---|---|
nodeId - ID!
|
A globally unique identifier. Can be used in various places throughout the system to identify this single value. |
status - String!
|
|
documentsByUploadStatus - DocumentsConnection!
|
Reads and enables pagination through a set of Document. |
Arguments
|
|
Example
{
"nodeId": "4",
"status": "xyz789",
"documentsByUploadStatus": DocumentsConnection
}
DocumentStatusCondition
Description
A condition to be used against DocumentStatus object types. All fields are tested for equality and combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
status - String
|
Checks for equality with the object’s status field. |
Example
{"status": "xyz789"}
DocumentStatusFilter
Description
A filter to be used against DocumentStatus object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
status - StringFilter
|
Filter by the object’s status field. |
documentsByUploadStatus - DocumentStatusToManyDocumentFilter
|
Filter by the object’s documentsByUploadStatus relation. |
documentsByUploadStatusExist - Boolean
|
Some related documentsByUploadStatus exist. |
and - [DocumentStatusFilter!]
|
Checks for all expressions in this list. |
or - [DocumentStatusFilter!]
|
Checks for any expressions in this list. |
not - DocumentStatusFilter
|
Negates the expression. |
Example
{
"status": StringFilter,
"documentsByUploadStatus": DocumentStatusToManyDocumentFilter,
"documentsByUploadStatusExist": true,
"and": [DocumentStatusFilter],
"or": [DocumentStatusFilter],
"not": DocumentStatusFilter
}
DocumentStatusPatch
Description
Represents an update to a DocumentStatus. Fields that are set will be updated.
Fields
| Input Field | Description |
|---|---|
status - String
|
Example
{"status": "xyz789"}
DocumentStatusToManyDocumentFilter
Description
A filter to be used against many Document object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - DocumentFilter
|
Every related Document matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - DocumentFilter
|
Some related Document matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - DocumentFilter
|
No related Document matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": DocumentFilter,
"some": DocumentFilter,
"none": DocumentFilter
}
DocumentStatusesConnection
Description
A connection to a list of DocumentStatus values.
Fields
| Field Name | Description |
|---|---|
nodes - [DocumentStatus]!
|
A list of DocumentStatus objects. |
edges - [DocumentStatusesEdge!]!
|
A list of edges which contains the DocumentStatus and cursor to aid in pagination. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The count of all DocumentStatus you could get from the connection. |
Example
{
"nodes": [DocumentStatus],
"edges": [DocumentStatusesEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
DocumentStatusesEdge
Description
A DocumentStatus edge in the connection.
Fields
| Field Name | Description |
|---|---|
cursor - Cursor
|
A cursor for use in pagination. |
node - DocumentStatus
|
The DocumentStatus at the end of the edge. |
Example
{
"cursor": Cursor,
"node": DocumentStatus
}
DocumentStatusesOrderBy
Description
Methods to use when ordering DocumentStatus.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NATURAL"
DocumentToManyAccountDocumentFilter
Description
A filter to be used against many AccountDocument object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - AccountDocumentFilter
|
Every related AccountDocument matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - AccountDocumentFilter
|
Some related AccountDocument matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - AccountDocumentFilter
|
No related AccountDocument matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": AccountDocumentFilter,
"some": AccountDocumentFilter,
"none": AccountDocumentFilter
}
DocumentToManyDocumentSharingFilter
Description
A filter to be used against many DocumentSharing object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - DocumentSharingFilter
|
Every related DocumentSharing matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - DocumentSharingFilter
|
Some related DocumentSharing matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - DocumentSharingFilter
|
No related DocumentSharing matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": DocumentSharingFilter,
"some": DocumentSharingFilter,
"none": DocumentSharingFilter
}
DocumentToManyHoldingDocumentFilter
Description
A filter to be used against many HoldingDocument object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - HoldingDocumentFilter
|
Every related HoldingDocument matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - HoldingDocumentFilter
|
Some related HoldingDocument matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - HoldingDocumentFilter
|
No related HoldingDocument matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": HoldingDocumentFilter,
"some": HoldingDocumentFilter,
"none": HoldingDocumentFilter
}
DocumentToManySecurityDocumentFilter
Description
A filter to be used against many SecurityDocument object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - SecurityDocumentFilter
|
Every related SecurityDocument matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - SecurityDocumentFilter
|
Some related SecurityDocument matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - SecurityDocumentFilter
|
No related SecurityDocument matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": SecurityDocumentFilter,
"some": SecurityDocumentFilter,
"none": SecurityDocumentFilter
}
DocumentType
Fields
| Field Name | Description |
|---|---|
nodeId - ID!
|
A globally unique identifier. Can be used in various places throughout the system to identify this single value. |
type - String!
|
|
documentsByType - DocumentsConnection!
|
Reads and enables pagination through a set of Document. |
Arguments
|
|
Example
{
"nodeId": "4",
"type": "xyz789",
"documentsByType": DocumentsConnection
}
DocumentTypeCondition
Description
A condition to be used against DocumentType object types. All fields are tested for equality and combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
type - String
|
Checks for equality with the object’s type field. |
Example
{"type": "xyz789"}
DocumentTypeFilter
Description
A filter to be used against DocumentType object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
type - StringFilter
|
Filter by the object’s type field. |
documentsByType - DocumentTypeToManyDocumentFilter
|
Filter by the object’s documentsByType relation. |
documentsByTypeExist - Boolean
|
Some related documentsByType exist. |
and - [DocumentTypeFilter!]
|
Checks for all expressions in this list. |
or - [DocumentTypeFilter!]
|
Checks for any expressions in this list. |
not - DocumentTypeFilter
|
Negates the expression. |
Example
{
"type": StringFilter,
"documentsByType": DocumentTypeToManyDocumentFilter,
"documentsByTypeExist": false,
"and": [DocumentTypeFilter],
"or": [DocumentTypeFilter],
"not": DocumentTypeFilter
}
DocumentTypeToManyDocumentFilter
Description
A filter to be used against many Document object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - DocumentFilter
|
Every related Document matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - DocumentFilter
|
Some related Document matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - DocumentFilter
|
No related Document matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": DocumentFilter,
"some": DocumentFilter,
"none": DocumentFilter
}
DocumentTypesConnection
Description
A connection to a list of DocumentType values.
Fields
| Field Name | Description |
|---|---|
nodes - [DocumentType]!
|
A list of DocumentType objects. |
edges - [DocumentTypesEdge!]!
|
A list of edges which contains the DocumentType and cursor to aid in pagination. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The count of all DocumentType you could get from the connection. |
Example
{
"nodes": [DocumentType],
"edges": [DocumentTypesEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
DocumentTypesEdge
Description
A DocumentType edge in the connection.
Fields
| Field Name | Description |
|---|---|
cursor - Cursor
|
A cursor for use in pagination. |
node - DocumentType
|
The DocumentType at the end of the edge. |
Example
{
"cursor": Cursor,
"node": DocumentType
}
DocumentTypesOrderBy
Description
Methods to use when ordering DocumentType.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NATURAL"
DocumentsConnection
Description
A connection to a list of Document values.
Fields
| Field Name | Description |
|---|---|
nodes - [Document]!
|
A list of Document objects. |
edges - [DocumentsEdge!]!
|
A list of edges which contains the Document and cursor to aid in pagination. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The count of all Document you could get from the connection. |
Example
{
"nodes": [Document],
"edges": [DocumentsEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
DocumentsEdge
DocumentsOrderBy
Description
Methods to use when ordering Document.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NATURAL"
Example
{
"nodeId": 4,
"userId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"email": "xyz789",
"createdOn": Datetime,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"userByUserId": User
}
EmailCondition
Description
A condition to be used against Email object types. All fields are tested for equality and combined with a logical ‘and.’
Example
{
"userId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"email": "abc123",
"createdOn": Datetime,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
EmailFilter
Description
A filter to be used against Email object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
userId - UUIDFilter
|
Filter by the object’s userId field. |
email - StringFilter
|
Filter by the object’s email field. |
createdOn - DatetimeFilter
|
Filter by the object’s createdOn field. |
id - UUIDFilter
|
Filter by the object’s id field. |
userByUserId - UserFilter
|
Filter by the object’s userByUserId relation. |
and - [EmailFilter!]
|
Checks for all expressions in this list. |
or - [EmailFilter!]
|
Checks for any expressions in this list. |
not - EmailFilter
|
Negates the expression. |
Example
{
"userId": UUIDFilter,
"email": StringFilter,
"createdOn": DatetimeFilter,
"id": UUIDFilter,
"userByUserId": UserFilter,
"and": [EmailFilter],
"or": [EmailFilter],
"not": EmailFilter
}
EmailTemplateTo
EmailTemplateToCondition
Description
A condition to be used against EmailTemplateTo object types. All fields are tested for equality and combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
to - String
|
Checks for equality with the object’s to field. |
Example
{"to": "xyz789"}
EmailTemplateToFilter
Description
A filter to be used against EmailTemplateTo object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
to - StringFilter
|
Filter by the object’s to field. |
and - [EmailTemplateToFilter!]
|
Checks for all expressions in this list. |
or - [EmailTemplateToFilter!]
|
Checks for any expressions in this list. |
not - EmailTemplateToFilter
|
Negates the expression. |
Example
{
"to": StringFilter,
"and": [EmailTemplateToFilter],
"or": [EmailTemplateToFilter],
"not": EmailTemplateToFilter
}
EmailTemplateToInput
Description
An input for mutations affecting EmailTemplateTo
Fields
| Input Field | Description |
|---|---|
to - String!
|
Example
{"to": "xyz789"}
EmailTemplateToPatch
Description
Represents an update to a EmailTemplateTo. Fields that are set will be updated.
Fields
| Input Field | Description |
|---|---|
to - String
|
Example
{"to": "xyz789"}
EmailTemplateTosConnection
Description
A connection to a list of EmailTemplateTo values.
Fields
| Field Name | Description |
|---|---|
nodes - [EmailTemplateTo]!
|
A list of EmailTemplateTo objects. |
edges - [EmailTemplateTosEdge!]!
|
A list of edges which contains the EmailTemplateTo and cursor to aid in pagination. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The count of all EmailTemplateTo you could get from the connection. |
Example
{
"nodes": [EmailTemplateTo],
"edges": [EmailTemplateTosEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
EmailTemplateTosEdge
Description
A EmailTemplateTo edge in the connection.
Fields
| Field Name | Description |
|---|---|
cursor - Cursor
|
A cursor for use in pagination. |
node - EmailTemplateTo
|
The EmailTemplateTo at the end of the edge. |
Example
{
"cursor": Cursor,
"node": EmailTemplateTo
}
EmailTemplateTosOrderBy
Description
Methods to use when ordering EmailTemplateTo.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NATURAL"
EmailsConnection
Description
A connection to a list of Email values.
Fields
| Field Name | Description |
|---|---|
nodes - [Email]!
|
A list of Email objects. |
edges - [EmailsEdge!]!
|
A list of edges which contains the Email and cursor to aid in pagination. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The count of all Email you could get from the connection. |
Example
{
"nodes": [Email],
"edges": [EmailsEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
EmailsEdge
EmailsOrderBy
Description
Methods to use when ordering Email.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NATURAL"
Float
Description
The Float scalar type represents signed double-precision fractional values as specified by IEEE 754.
Example
123.45
FullHolding
Fields
| Field Name | Description |
|---|---|
id - UUID
|
|
securityName - String
|
|
total - BigFloat
|
|
amount - BigFloat
|
|
purchasePrice - BigFloat
|
|
totalValue - BigFloat
|
|
purchaseCurrency - UUID
|
|
securityId - UUID
|
|
investorId - UUID
|
|
issuedOn - Datetime
|
|
investorAccountEmail - String
|
|
investorAccountName - String
|
|
percentOfSecurity - BigFloat
|
|
chain - String
|
|
term - BigFloat
|
|
coupon - BigFloat
|
Example
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"securityName": "abc123",
"total": BigFloat,
"amount": BigFloat,
"purchasePrice": BigFloat,
"totalValue": BigFloat,
"purchaseCurrency": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"securityId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"investorId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"issuedOn": Datetime,
"investorAccountEmail": "abc123",
"investorAccountName": "xyz789",
"percentOfSecurity": BigFloat,
"chain": "abc123",
"term": BigFloat,
"coupon": BigFloat
}
FullHoldingCondition
Description
A condition to be used against FullHolding object types. All fields are tested for equality and combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
id - UUID
|
Checks for equality with the object’s id field. |
securityName - String
|
Checks for equality with the object’s securityName field. |
total - BigFloat
|
Checks for equality with the object’s total field. |
amount - BigFloat
|
Checks for equality with the object’s amount field. |
purchasePrice - BigFloat
|
Checks for equality with the object’s purchasePrice field. |
totalValue - BigFloat
|
Checks for equality with the object’s totalValue field. |
purchaseCurrency - UUID
|
Checks for equality with the object’s purchaseCurrency field. |
securityId - UUID
|
Checks for equality with the object’s securityId field. |
investorId - UUID
|
Checks for equality with the object’s investorId field. |
issuedOn - Datetime
|
Checks for equality with the object’s issuedOn field. |
investorAccountEmail - String
|
Checks for equality with the object’s investorAccountEmail field. |
investorAccountName - String
|
Checks for equality with the object’s investorAccountName field. |
percentOfSecurity - BigFloat
|
Checks for equality with the object’s percentOfSecurity field. |
chain - String
|
Checks for equality with the object’s chain field. |
term - BigFloat
|
Checks for equality with the object’s term field. |
coupon - BigFloat
|
Checks for equality with the object’s coupon field. |
Example
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"securityName": "abc123",
"total": BigFloat,
"amount": BigFloat,
"purchasePrice": BigFloat,
"totalValue": BigFloat,
"purchaseCurrency": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"securityId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"investorId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"issuedOn": Datetime,
"investorAccountEmail": "xyz789",
"investorAccountName": "abc123",
"percentOfSecurity": BigFloat,
"chain": "xyz789",
"term": BigFloat,
"coupon": BigFloat
}
FullHoldingFilter
Description
A filter to be used against FullHolding object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
id - UUIDFilter
|
Filter by the object’s id field. |
securityName - StringFilter
|
Filter by the object’s securityName field. |
total - BigFloatFilter
|
Filter by the object’s total field. |
amount - BigFloatFilter
|
Filter by the object’s amount field. |
purchasePrice - BigFloatFilter
|
Filter by the object’s purchasePrice field. |
totalValue - BigFloatFilter
|
Filter by the object’s totalValue field. |
purchaseCurrency - UUIDFilter
|
Filter by the object’s purchaseCurrency field. |
securityId - UUIDFilter
|
Filter by the object’s securityId field. |
investorId - UUIDFilter
|
Filter by the object’s investorId field. |
issuedOn - DatetimeFilter
|
Filter by the object’s issuedOn field. |
investorAccountEmail - StringFilter
|
Filter by the object’s investorAccountEmail field. |
investorAccountName - StringFilter
|
Filter by the object’s investorAccountName field. |
percentOfSecurity - BigFloatFilter
|
Filter by the object’s percentOfSecurity field. |
chain - StringFilter
|
Filter by the object’s chain field. |
term - BigFloatFilter
|
Filter by the object’s term field. |
coupon - BigFloatFilter
|
Filter by the object’s coupon field. |
and - [FullHoldingFilter!]
|
Checks for all expressions in this list. |
or - [FullHoldingFilter!]
|
Checks for any expressions in this list. |
not - FullHoldingFilter
|
Negates the expression. |
Example
{
"id": UUIDFilter,
"securityName": StringFilter,
"total": BigFloatFilter,
"amount": BigFloatFilter,
"purchasePrice": BigFloatFilter,
"totalValue": BigFloatFilter,
"purchaseCurrency": UUIDFilter,
"securityId": UUIDFilter,
"investorId": UUIDFilter,
"issuedOn": DatetimeFilter,
"investorAccountEmail": StringFilter,
"investorAccountName": StringFilter,
"percentOfSecurity": BigFloatFilter,
"chain": StringFilter,
"term": BigFloatFilter,
"coupon": BigFloatFilter,
"and": [FullHoldingFilter],
"or": [FullHoldingFilter],
"not": FullHoldingFilter
}
FullHoldingsConnection
Description
A connection to a list of FullHolding values.
Fields
| Field Name | Description |
|---|---|
nodes - [FullHolding]!
|
A list of FullHolding objects. |
edges - [FullHoldingsEdge!]!
|
A list of edges which contains the FullHolding and cursor to aid in pagination. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The count of all FullHolding you could get from the connection. |
Example
{
"nodes": [FullHolding],
"edges": [FullHoldingsEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
FullHoldingsEdge
Description
A FullHolding edge in the connection.
Fields
| Field Name | Description |
|---|---|
cursor - Cursor
|
A cursor for use in pagination. |
node - FullHolding
|
The FullHolding at the end of the edge. |
Example
{
"cursor": Cursor,
"node": FullHolding
}
FullHoldingsOrderBy
Description
Methods to use when ordering FullHolding.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NATURAL"
GetAddressInput
Description
All input for the getAddress mutation.
Example
{
"clientMutationId": "abc123",
"_address": "xyz789",
"_chain": "abc123"
}
GetAddressPayload
Description
The output of our getAddress mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
The exact same clientMutationId that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations. |
uuid - UUID
|
|
query - Query
|
Our root query field type. Allows us to run any query from our mutation payload. |
Example
{
"clientMutationId": "xyz789",
"uuid": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"query": Query
}
GetUsersDataRecord
Holding
Fields
| Field Name | Description |
|---|---|
nodeId - ID!
|
A globally unique identifier. Can be used in various places throughout the system to identify this single value. |
id - UUID!
|
|
investorId - UUID!
|
|
securityId - UUID!
|
|
amount - BigFloat!
|
|
purchasePrice - BigFloat!
|
|
purchaseCurrency - UUID!
|
|
createdOn - Datetime!
|
|
issuedOn - Datetime
|
|
staging - Boolean!
|
|
accountByInvestorId - Account
|
Reads a single Account that is related to this Holding. |
securityBySecurityId - Security
|
Reads a single Security that is related to this Holding. |
currencyByPurchaseCurrency - Currency
|
Reads a single Currency that is related to this Holding. |
holdingBlockchainAddressesByHoldingId - HoldingBlockchainAddressesConnection!
|
Reads and enables pagination through a set of HoldingBlockchainAddress. |
Arguments
|
|
issuanceEventsByHoldingId - IssuanceEventsConnection!
|
Reads and enables pagination through a set of IssuanceEvent. |
Arguments
|
|
holdingDocumentsByHoldingId - HoldingDocumentsConnection!
|
Reads and enables pagination through a set of HoldingDocument. |
Arguments
|
|
omnibusHoldingsByHoldingId - OmnibusHoldingsConnection!
|
Reads and enables pagination through a set of OmnibusHolding. |
Arguments
|
|
stagedBalanceTransfersByToHoldingId - StagedBalanceTransfersConnection!
|
Reads and enables pagination through a set of StagedBalanceTransfer. |
Arguments
|
|
stagedBalanceTransfersByFromHoldingId - StagedBalanceTransfersConnection!
|
Reads and enables pagination through a set of StagedBalanceTransfer. |
Arguments
|
|
transfersByFromHoldingId - TransfersConnection!
|
Reads and enables pagination through a set of Transfer. |
Arguments
|
|
transfersByToHoldingId - TransfersConnection!
|
Reads and enables pagination through a set of Transfer. |
Arguments
|
|
costBasis - BigFloat
|
|
lotPrice - BigFloat
|
|
percentOfSecurityTotal - BigFloat
|
|
Example
{
"nodeId": "4",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"investorId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"securityId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"amount": BigFloat,
"purchasePrice": BigFloat,
"purchaseCurrency": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"createdOn": Datetime,
"issuedOn": Datetime,
"staging": true,
"accountByInvestorId": Account,
"securityBySecurityId": Security,
"currencyByPurchaseCurrency": Currency,
"holdingBlockchainAddressesByHoldingId": HoldingBlockchainAddressesConnection,
"issuanceEventsByHoldingId": IssuanceEventsConnection,
"holdingDocumentsByHoldingId": HoldingDocumentsConnection,
"omnibusHoldingsByHoldingId": OmnibusHoldingsConnection,
"stagedBalanceTransfersByToHoldingId": StagedBalanceTransfersConnection,
"stagedBalanceTransfersByFromHoldingId": StagedBalanceTransfersConnection,
"transfersByFromHoldingId": TransfersConnection,
"transfersByToHoldingId": TransfersConnection,
"costBasis": BigFloat,
"lotPrice": BigFloat,
"percentOfSecurityTotal": BigFloat
}
HoldingBlockchainAddress
Fields
| Field Name | Description |
|---|---|
nodeId - ID!
|
A globally unique identifier. Can be used in various places throughout the system to identify this single value. |
id - UUID!
|
|
blockchainAddressId - UUID!
|
|
holdingId - UUID!
|
|
status - String!
|
|
createdOn - Datetime!
|
|
blockchainAddressByBlockchainAddressId - BlockchainAddress
|
Reads a single BlockchainAddress that is related to this HoldingBlockchainAddress. |
holdingByHoldingId - Holding
|
Reads a single Holding that is related to this HoldingBlockchainAddress. |
holdingBlockchainAddressStatusByStatus - HoldingBlockchainAddressStatus
|
Reads a single HoldingBlockchainAddressStatus that is related to this HoldingBlockchainAddress. |
Example
{
"nodeId": 4,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"blockchainAddressId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"holdingId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"status": "xyz789",
"createdOn": Datetime,
"blockchainAddressByBlockchainAddressId": BlockchainAddress,
"holdingByHoldingId": Holding,
"holdingBlockchainAddressStatusByStatus": HoldingBlockchainAddressStatus
}
HoldingBlockchainAddressCondition
Description
A condition to be used against HoldingBlockchainAddress object types. All fields are tested for equality and combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
id - UUID
|
Checks for equality with the object’s id field. |
blockchainAddressId - UUID
|
Checks for equality with the object’s blockchainAddressId field. |
holdingId - UUID
|
Checks for equality with the object’s holdingId field. |
status - String
|
Checks for equality with the object’s status field. |
createdOn - Datetime
|
Checks for equality with the object’s createdOn field. |
Example
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"blockchainAddressId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"holdingId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"status": "xyz789",
"createdOn": Datetime
}
HoldingBlockchainAddressFilter
Description
A filter to be used against HoldingBlockchainAddress object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
id - UUIDFilter
|
Filter by the object’s id field. |
blockchainAddressId - UUIDFilter
|
Filter by the object’s blockchainAddressId field. |
holdingId - UUIDFilter
|
Filter by the object’s holdingId field. |
status - StringFilter
|
Filter by the object’s status field. |
createdOn - DatetimeFilter
|
Filter by the object’s createdOn field. |
blockchainAddressByBlockchainAddressId - BlockchainAddressFilter
|
Filter by the object’s blockchainAddressByBlockchainAddressId relation. |
holdingByHoldingId - HoldingFilter
|
Filter by the object’s holdingByHoldingId relation. |
holdingBlockchainAddressStatusByStatus - HoldingBlockchainAddressStatusFilter
|
Filter by the object’s holdingBlockchainAddressStatusByStatus relation. |
and - [HoldingBlockchainAddressFilter!]
|
Checks for all expressions in this list. |
or - [HoldingBlockchainAddressFilter!]
|
Checks for any expressions in this list. |
not - HoldingBlockchainAddressFilter
|
Negates the expression. |
Example
{
"id": UUIDFilter,
"blockchainAddressId": UUIDFilter,
"holdingId": UUIDFilter,
"status": StringFilter,
"createdOn": DatetimeFilter,
"blockchainAddressByBlockchainAddressId": BlockchainAddressFilter,
"holdingByHoldingId": HoldingFilter,
"holdingBlockchainAddressStatusByStatus": HoldingBlockchainAddressStatusFilter,
"and": [HoldingBlockchainAddressFilter],
"or": [HoldingBlockchainAddressFilter],
"not": HoldingBlockchainAddressFilter
}
HoldingBlockchainAddressStatus
Fields
| Field Name | Description |
|---|---|
nodeId - ID!
|
A globally unique identifier. Can be used in various places throughout the system to identify this single value. |
status - String!
|
|
holdingBlockchainAddressesByStatus - HoldingBlockchainAddressesConnection!
|
Reads and enables pagination through a set of HoldingBlockchainAddress. |
Arguments
|
|
Example
{
"nodeId": 4,
"status": "abc123",
"holdingBlockchainAddressesByStatus": HoldingBlockchainAddressesConnection
}
HoldingBlockchainAddressStatusCondition
Description
A condition to be used against HoldingBlockchainAddressStatus object types. All fields are tested for equality and combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
status - String
|
Checks for equality with the object’s status field. |
Example
{"status": "abc123"}
HoldingBlockchainAddressStatusFilter
Description
A filter to be used against HoldingBlockchainAddressStatus object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
status - StringFilter
|
Filter by the object’s status field. |
holdingBlockchainAddressesByStatus - HoldingBlockchainAddressStatusToManyHoldingBlockchainAddressFilter
|
Filter by the object’s holdingBlockchainAddressesByStatus relation. |
holdingBlockchainAddressesByStatusExist - Boolean
|
Some related holdingBlockchainAddressesByStatus exist. |
and - [HoldingBlockchainAddressStatusFilter!]
|
Checks for all expressions in this list. |
or - [HoldingBlockchainAddressStatusFilter!]
|
Checks for any expressions in this list. |
not - HoldingBlockchainAddressStatusFilter
|
Negates the expression. |
Example
{
"status": StringFilter,
"holdingBlockchainAddressesByStatus": HoldingBlockchainAddressStatusToManyHoldingBlockchainAddressFilter,
"holdingBlockchainAddressesByStatusExist": true,
"and": [HoldingBlockchainAddressStatusFilter],
"or": [HoldingBlockchainAddressStatusFilter],
"not": HoldingBlockchainAddressStatusFilter
}
HoldingBlockchainAddressStatusToManyHoldingBlockchainAddressFilter
Description
A filter to be used against many HoldingBlockchainAddress object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - HoldingBlockchainAddressFilter
|
Every related HoldingBlockchainAddress matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - HoldingBlockchainAddressFilter
|
Some related HoldingBlockchainAddress matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - HoldingBlockchainAddressFilter
|
No related HoldingBlockchainAddress matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": HoldingBlockchainAddressFilter,
"some": HoldingBlockchainAddressFilter,
"none": HoldingBlockchainAddressFilter
}
HoldingBlockchainAddressStatusesConnection
Description
A connection to a list of HoldingBlockchainAddressStatus values.
Fields
| Field Name | Description |
|---|---|
nodes - [HoldingBlockchainAddressStatus]!
|
A list of HoldingBlockchainAddressStatus objects. |
edges - [HoldingBlockchainAddressStatusesEdge!]!
|
A list of edges which contains the HoldingBlockchainAddressStatus and cursor to aid in pagination. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The count of all HoldingBlockchainAddressStatus you could get from the connection. |
Example
{
"nodes": [HoldingBlockchainAddressStatus],
"edges": [HoldingBlockchainAddressStatusesEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
HoldingBlockchainAddressStatusesEdge
Description
A HoldingBlockchainAddressStatus edge in the connection.
Fields
| Field Name | Description |
|---|---|
cursor - Cursor
|
A cursor for use in pagination. |
node - HoldingBlockchainAddressStatus
|
The HoldingBlockchainAddressStatus at the end of the edge. |
Example
{
"cursor": Cursor,
"node": HoldingBlockchainAddressStatus
}
HoldingBlockchainAddressStatusesOrderBy
Description
Methods to use when ordering HoldingBlockchainAddressStatus.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NATURAL"
HoldingBlockchainAddressesConnection
Description
A connection to a list of HoldingBlockchainAddress values.
Fields
| Field Name | Description |
|---|---|
nodes - [HoldingBlockchainAddress]!
|
A list of HoldingBlockchainAddress objects. |
edges - [HoldingBlockchainAddressesEdge!]!
|
A list of edges which contains the HoldingBlockchainAddress and cursor to aid in pagination. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The count of all HoldingBlockchainAddress you could get from the connection. |
Example
{
"nodes": [HoldingBlockchainAddress],
"edges": [HoldingBlockchainAddressesEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
HoldingBlockchainAddressesEdge
Description
A HoldingBlockchainAddress edge in the connection.
Fields
| Field Name | Description |
|---|---|
cursor - Cursor
|
A cursor for use in pagination. |
node - HoldingBlockchainAddress
|
The HoldingBlockchainAddress at the end of the edge. |
Example
{
"cursor": Cursor,
"node": HoldingBlockchainAddress
}
HoldingBlockchainAddressesOrderBy
Description
Methods to use when ordering HoldingBlockchainAddress.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NATURAL"
HoldingCondition
Description
A condition to be used against Holding object types. All fields are tested for equality and combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
id - UUID
|
Checks for equality with the object’s id field. |
investorId - UUID
|
Checks for equality with the object’s investorId field. |
securityId - UUID
|
Checks for equality with the object’s securityId field. |
amount - BigFloat
|
Checks for equality with the object’s amount field. |
purchasePrice - BigFloat
|
Checks for equality with the object’s purchasePrice field. |
purchaseCurrency - UUID
|
Checks for equality with the object’s purchaseCurrency field. |
createdOn - Datetime
|
Checks for equality with the object’s createdOn field. |
issuedOn - Datetime
|
Checks for equality with the object’s issuedOn field. |
staging - Boolean
|
Checks for equality with the object’s staging field. |
Example
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"investorId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"securityId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"amount": BigFloat,
"purchasePrice": BigFloat,
"purchaseCurrency": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"createdOn": Datetime,
"issuedOn": Datetime,
"staging": false
}
HoldingDocument
Fields
| Field Name | Description |
|---|---|
nodeId - ID!
|
A globally unique identifier. Can be used in various places throughout the system to identify this single value. |
id - UUID!
|
|
documentId - UUID!
|
|
holdingId - UUID!
|
|
createdOn - Datetime!
|
|
documentByDocumentId - Document
|
Reads a single Document that is related to this HoldingDocument. |
holdingByHoldingId - Holding
|
Reads a single Holding that is related to this HoldingDocument. |
Example
{
"nodeId": 4,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"documentId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"holdingId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"createdOn": Datetime,
"documentByDocumentId": Document,
"holdingByHoldingId": Holding
}
HoldingDocumentCondition
Description
A condition to be used against HoldingDocument object types. All fields are tested for equality and combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
id - UUID
|
Checks for equality with the object’s id field. |
documentId - UUID
|
Checks for equality with the object’s documentId field. |
holdingId - UUID
|
Checks for equality with the object’s holdingId field. |
createdOn - Datetime
|
Checks for equality with the object’s createdOn field. |
Example
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"documentId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"holdingId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"createdOn": Datetime
}
HoldingDocumentFilter
Description
A filter to be used against HoldingDocument object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
id - UUIDFilter
|
Filter by the object’s id field. |
documentId - UUIDFilter
|
Filter by the object’s documentId field. |
holdingId - UUIDFilter
|
Filter by the object’s holdingId field. |
createdOn - DatetimeFilter
|
Filter by the object’s createdOn field. |
documentByDocumentId - DocumentFilter
|
Filter by the object’s documentByDocumentId relation. |
holdingByHoldingId - HoldingFilter
|
Filter by the object’s holdingByHoldingId relation. |
and - [HoldingDocumentFilter!]
|
Checks for all expressions in this list. |
or - [HoldingDocumentFilter!]
|
Checks for any expressions in this list. |
not - HoldingDocumentFilter
|
Negates the expression. |
Example
{
"id": UUIDFilter,
"documentId": UUIDFilter,
"holdingId": UUIDFilter,
"createdOn": DatetimeFilter,
"documentByDocumentId": DocumentFilter,
"holdingByHoldingId": HoldingFilter,
"and": [HoldingDocumentFilter],
"or": [HoldingDocumentFilter],
"not": HoldingDocumentFilter
}
HoldingDocumentUpload
Fields
| Field Name | Description |
|---|---|
uploadInfo - JSON
|
|
holdingDocumentId - UUID
|
|
accountDocumentId - UUID
|
|
documentId - UUID
|
|
holdingDocumentByHoldingDocumentId - HoldingDocument
|
|
accountDocumentByAccountDocumentId - AccountDocument
|
|
documentByDocumentId - Document
|
Example
{
"uploadInfo": {},
"holdingDocumentId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountDocumentId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"documentId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"holdingDocumentByHoldingDocumentId": HoldingDocument,
"accountDocumentByAccountDocumentId": AccountDocument,
"documentByDocumentId": Document
}
HoldingDocumentsConnection
Description
A connection to a list of HoldingDocument values.
Fields
| Field Name | Description |
|---|---|
nodes - [HoldingDocument]!
|
A list of HoldingDocument objects. |
edges - [HoldingDocumentsEdge!]!
|
A list of edges which contains the HoldingDocument and cursor to aid in pagination. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The count of all HoldingDocument you could get from the connection. |
Example
{
"nodes": [HoldingDocument],
"edges": [HoldingDocumentsEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
HoldingDocumentsEdge
Description
A HoldingDocument edge in the connection.
Fields
| Field Name | Description |
|---|---|
cursor - Cursor
|
A cursor for use in pagination. |
node - HoldingDocument
|
The HoldingDocument at the end of the edge. |
Example
{
"cursor": Cursor,
"node": HoldingDocument
}
HoldingDocumentsOrderBy
Description
Methods to use when ordering HoldingDocument.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NATURAL"
HoldingFilter
Description
A filter to be used against Holding object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
id - UUIDFilter
|
Filter by the object’s id field. |
investorId - UUIDFilter
|
Filter by the object’s investorId field. |
securityId - UUIDFilter
|
Filter by the object’s securityId field. |
amount - BigFloatFilter
|
Filter by the object’s amount field. |
purchasePrice - BigFloatFilter
|
Filter by the object’s purchasePrice field. |
purchaseCurrency - UUIDFilter
|
Filter by the object’s purchaseCurrency field. |
createdOn - DatetimeFilter
|
Filter by the object’s createdOn field. |
issuedOn - DatetimeFilter
|
Filter by the object’s issuedOn field. |
staging - BooleanFilter
|
Filter by the object’s staging field. |
costBasis - BigFloatFilter
|
Filter by the object’s costBasis field. |
lotPrice - BigFloatFilter
|
Filter by the object’s lotPrice field. |
percentOfSecurityTotal - BigFloatFilter
|
Filter by the object’s percentOfSecurityTotal field. |
holdingBlockchainAddressesByHoldingId - HoldingToManyHoldingBlockchainAddressFilter
|
Filter by the object’s holdingBlockchainAddressesByHoldingId relation. |
holdingBlockchainAddressesByHoldingIdExist - Boolean
|
Some related holdingBlockchainAddressesByHoldingId exist. |
issuanceEventsByHoldingId - HoldingToManyIssuanceEventFilter
|
Filter by the object’s issuanceEventsByHoldingId relation. |
issuanceEventsByHoldingIdExist - Boolean
|
Some related issuanceEventsByHoldingId exist. |
holdingDocumentsByHoldingId - HoldingToManyHoldingDocumentFilter
|
Filter by the object’s holdingDocumentsByHoldingId relation. |
holdingDocumentsByHoldingIdExist - Boolean
|
Some related holdingDocumentsByHoldingId exist. |
omnibusHoldingsByHoldingId - HoldingToManyOmnibusHoldingFilter
|
Filter by the object’s omnibusHoldingsByHoldingId relation. |
omnibusHoldingsByHoldingIdExist - Boolean
|
Some related omnibusHoldingsByHoldingId exist. |
stagedBalanceTransfersByToHoldingId - HoldingToManyStagedBalanceTransferFilter
|
Filter by the object’s stagedBalanceTransfersByToHoldingId relation. |
stagedBalanceTransfersByToHoldingIdExist - Boolean
|
Some related stagedBalanceTransfersByToHoldingId exist. |
stagedBalanceTransfersByFromHoldingId - HoldingToManyStagedBalanceTransferFilter
|
Filter by the object’s stagedBalanceTransfersByFromHoldingId relation. |
stagedBalanceTransfersByFromHoldingIdExist - Boolean
|
Some related stagedBalanceTransfersByFromHoldingId exist. |
transfersByFromHoldingId - HoldingToManyTransferFilter
|
Filter by the object’s transfersByFromHoldingId relation. |
transfersByFromHoldingIdExist - Boolean
|
Some related transfersByFromHoldingId exist. |
transfersByToHoldingId - HoldingToManyTransferFilter
|
Filter by the object’s transfersByToHoldingId relation. |
transfersByToHoldingIdExist - Boolean
|
Some related transfersByToHoldingId exist. |
accountByInvestorId - AccountFilter
|
Filter by the object’s accountByInvestorId relation. |
securityBySecurityId - SecurityFilter
|
Filter by the object’s securityBySecurityId relation. |
currencyByPurchaseCurrency - CurrencyFilter
|
Filter by the object’s currencyByPurchaseCurrency relation. |
and - [HoldingFilter!]
|
Checks for all expressions in this list. |
or - [HoldingFilter!]
|
Checks for any expressions in this list. |
not - HoldingFilter
|
Negates the expression. |
Example
{
"id": UUIDFilter,
"investorId": UUIDFilter,
"securityId": UUIDFilter,
"amount": BigFloatFilter,
"purchasePrice": BigFloatFilter,
"purchaseCurrency": UUIDFilter,
"createdOn": DatetimeFilter,
"issuedOn": DatetimeFilter,
"staging": BooleanFilter,
"costBasis": BigFloatFilter,
"lotPrice": BigFloatFilter,
"percentOfSecurityTotal": BigFloatFilter,
"holdingBlockchainAddressesByHoldingId": HoldingToManyHoldingBlockchainAddressFilter,
"holdingBlockchainAddressesByHoldingIdExist": false,
"issuanceEventsByHoldingId": HoldingToManyIssuanceEventFilter,
"issuanceEventsByHoldingIdExist": false,
"holdingDocumentsByHoldingId": HoldingToManyHoldingDocumentFilter,
"holdingDocumentsByHoldingIdExist": true,
"omnibusHoldingsByHoldingId": HoldingToManyOmnibusHoldingFilter,
"omnibusHoldingsByHoldingIdExist": true,
"stagedBalanceTransfersByToHoldingId": HoldingToManyStagedBalanceTransferFilter,
"stagedBalanceTransfersByToHoldingIdExist": false,
"stagedBalanceTransfersByFromHoldingId": HoldingToManyStagedBalanceTransferFilter,
"stagedBalanceTransfersByFromHoldingIdExist": true,
"transfersByFromHoldingId": HoldingToManyTransferFilter,
"transfersByFromHoldingIdExist": false,
"transfersByToHoldingId": HoldingToManyTransferFilter,
"transfersByToHoldingIdExist": true,
"accountByInvestorId": AccountFilter,
"securityBySecurityId": SecurityFilter,
"currencyByPurchaseCurrency": CurrencyFilter,
"and": [HoldingFilter],
"or": [HoldingFilter],
"not": HoldingFilter
}
HoldingToManyHoldingBlockchainAddressFilter
Description
A filter to be used against many HoldingBlockchainAddress object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - HoldingBlockchainAddressFilter
|
Every related HoldingBlockchainAddress matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - HoldingBlockchainAddressFilter
|
Some related HoldingBlockchainAddress matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - HoldingBlockchainAddressFilter
|
No related HoldingBlockchainAddress matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": HoldingBlockchainAddressFilter,
"some": HoldingBlockchainAddressFilter,
"none": HoldingBlockchainAddressFilter
}
HoldingToManyHoldingDocumentFilter
Description
A filter to be used against many HoldingDocument object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - HoldingDocumentFilter
|
Every related HoldingDocument matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - HoldingDocumentFilter
|
Some related HoldingDocument matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - HoldingDocumentFilter
|
No related HoldingDocument matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": HoldingDocumentFilter,
"some": HoldingDocumentFilter,
"none": HoldingDocumentFilter
}
HoldingToManyIssuanceEventFilter
Description
A filter to be used against many IssuanceEvent object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - IssuanceEventFilter
|
Every related IssuanceEvent matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - IssuanceEventFilter
|
Some related IssuanceEvent matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - IssuanceEventFilter
|
No related IssuanceEvent matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": IssuanceEventFilter,
"some": IssuanceEventFilter,
"none": IssuanceEventFilter
}
HoldingToManyOmnibusHoldingFilter
Description
A filter to be used against many OmnibusHolding object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - OmnibusHoldingFilter
|
Every related OmnibusHolding matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - OmnibusHoldingFilter
|
Some related OmnibusHolding matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - OmnibusHoldingFilter
|
No related OmnibusHolding matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": OmnibusHoldingFilter,
"some": OmnibusHoldingFilter,
"none": OmnibusHoldingFilter
}
HoldingToManyStagedBalanceTransferFilter
Description
A filter to be used against many StagedBalanceTransfer object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - StagedBalanceTransferFilter
|
Every related StagedBalanceTransfer matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - StagedBalanceTransferFilter
|
Some related StagedBalanceTransfer matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - StagedBalanceTransferFilter
|
No related StagedBalanceTransfer matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": StagedBalanceTransferFilter,
"some": StagedBalanceTransferFilter,
"none": StagedBalanceTransferFilter
}
HoldingToManyTransferFilter
Description
A filter to be used against many Transfer object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - TransferFilter
|
Every related Transfer matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - TransferFilter
|
Some related Transfer matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - TransferFilter
|
No related Transfer matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": TransferFilter,
"some": TransferFilter,
"none": TransferFilter
}
HoldingsConnection
Description
A connection to a list of Holding values.
Fields
| Field Name | Description |
|---|---|
nodes - [Holding]!
|
A list of Holding objects. |
edges - [HoldingsEdge!]!
|
A list of edges which contains the Holding and cursor to aid in pagination. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The count of all Holding you could get from the connection. |
Example
{
"nodes": [Holding],
"edges": [HoldingsEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
HoldingsEdge
HoldingsOrderBy
Description
Methods to use when ordering Holding.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NATURAL"
ID
Description
The ID scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "4") or integer (such as 4) input value will be accepted as an ID.
Example
"4"
Idempotent
Example
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"atsId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"type": "abc123",
"idempotent": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"recordId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountByAtsId": Account,
"idempotentTypeByType": IdempotentType
}
IdempotentCondition
Description
A condition to be used against Idempotent object types. All fields are tested for equality and combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
id - UUID
|
Checks for equality with the object’s id field. |
atsId - UUID
|
Checks for equality with the object’s atsId field. |
type - String
|
Checks for equality with the object’s type field. |
idempotent - UUID
|
Checks for equality with the object’s idempotent field. |
recordId - UUID
|
Checks for equality with the object’s recordId field. |
Example
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"atsId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"type": "xyz789",
"idempotent": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"recordId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
IdempotentFilter
Description
A filter to be used against Idempotent object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
id - UUIDFilter
|
Filter by the object’s id field. |
atsId - UUIDFilter
|
Filter by the object’s atsId field. |
type - StringFilter
|
Filter by the object’s type field. |
idempotent - UUIDFilter
|
Filter by the object’s idempotent field. |
recordId - UUIDFilter
|
Filter by the object’s recordId field. |
accountByAtsId - AccountFilter
|
Filter by the object’s accountByAtsId relation. |
accountByAtsIdExists - Boolean
|
A related accountByAtsId exists. |
idempotentTypeByType - IdempotentTypeFilter
|
Filter by the object’s idempotentTypeByType relation. |
idempotentTypeByTypeExists - Boolean
|
A related idempotentTypeByType exists. |
and - [IdempotentFilter!]
|
Checks for all expressions in this list. |
or - [IdempotentFilter!]
|
Checks for any expressions in this list. |
not - IdempotentFilter
|
Negates the expression. |
Example
{
"id": UUIDFilter,
"atsId": UUIDFilter,
"type": StringFilter,
"idempotent": UUIDFilter,
"recordId": UUIDFilter,
"accountByAtsId": AccountFilter,
"accountByAtsIdExists": true,
"idempotentTypeByType": IdempotentTypeFilter,
"idempotentTypeByTypeExists": false,
"and": [IdempotentFilter],
"or": [IdempotentFilter],
"not": IdempotentFilter
}
IdempotentType
Fields
| Field Name | Description |
|---|---|
type - String
|
|
idempotentsByType - IdempotentsConnection!
|
Reads and enables pagination through a set of Idempotent. |
Arguments
|
|
Example
{
"type": "xyz789",
"idempotentsByType": IdempotentsConnection
}
IdempotentTypeCondition
Description
A condition to be used against IdempotentType object types. All fields are tested for equality and combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
type - String
|
Checks for equality with the object’s type field. |
Example
{"type": "abc123"}
IdempotentTypeFilter
Description
A filter to be used against IdempotentType object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
type - StringFilter
|
Filter by the object’s type field. |
idempotentsByType - IdempotentTypeToManyIdempotentFilter
|
Filter by the object’s idempotentsByType relation. |
idempotentsByTypeExist - Boolean
|
Some related idempotentsByType exist. |
and - [IdempotentTypeFilter!]
|
Checks for all expressions in this list. |
or - [IdempotentTypeFilter!]
|
Checks for any expressions in this list. |
not - IdempotentTypeFilter
|
Negates the expression. |
Example
{
"type": StringFilter,
"idempotentsByType": IdempotentTypeToManyIdempotentFilter,
"idempotentsByTypeExist": true,
"and": [IdempotentTypeFilter],
"or": [IdempotentTypeFilter],
"not": IdempotentTypeFilter
}
IdempotentTypeInput
Description
An input for mutations affecting IdempotentType
Fields
| Input Field | Description |
|---|---|
type - String
|
Example
{"type": "xyz789"}
IdempotentTypeToManyIdempotentFilter
Description
A filter to be used against many Idempotent object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - IdempotentFilter
|
Every related Idempotent matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - IdempotentFilter
|
Some related Idempotent matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - IdempotentFilter
|
No related Idempotent matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": IdempotentFilter,
"some": IdempotentFilter,
"none": IdempotentFilter
}
IdempotentTypesConnection
Description
A connection to a list of IdempotentType values.
Fields
| Field Name | Description |
|---|---|
nodes - [IdempotentType]!
|
A list of IdempotentType objects. |
edges - [IdempotentTypesEdge!]!
|
A list of edges which contains the IdempotentType and cursor to aid in pagination. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The count of all IdempotentType you could get from the connection. |
Example
{
"nodes": [IdempotentType],
"edges": [IdempotentTypesEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
IdempotentTypesEdge
Description
A IdempotentType edge in the connection.
Fields
| Field Name | Description |
|---|---|
cursor - Cursor
|
A cursor for use in pagination. |
node - IdempotentType
|
The IdempotentType at the end of the edge. |
Example
{
"cursor": Cursor,
"node": IdempotentType
}
IdempotentTypesOrderBy
Description
Methods to use when ordering IdempotentType.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"NATURAL"
IdempotentsConnection
Description
A connection to a list of Idempotent values.
Fields
| Field Name | Description |
|---|---|
nodes - [Idempotent]!
|
A list of Idempotent objects. |
edges - [IdempotentsEdge!]!
|
A list of edges which contains the Idempotent and cursor to aid in pagination. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The count of all Idempotent you could get from the connection. |
Example
{
"nodes": [Idempotent],
"edges": [IdempotentsEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
IdempotentsEdge
Description
A Idempotent edge in the connection.
Fields
| Field Name | Description |
|---|---|
cursor - Cursor
|
A cursor for use in pagination. |
node - Idempotent
|
The Idempotent at the end of the edge. |
Example
{
"cursor": Cursor,
"node": Idempotent
}
IdempotentsOrderBy
Description
Methods to use when ordering Idempotent.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NATURAL"
InstancedAccountInformation
Fields
| Field Name | Description |
|---|---|
nodeId - ID!
|
A globally unique identifier. Can be used in various places throughout the system to identify this single value. |
id - UUID!
|
|
accountId - UUID!
|
|
vendorAccountId - UUID!
|
|
field - String!
|
|
value - String!
|
|
permissionMask - BitString!
|
|
accountByAccountId - Account
|
Reads a single Account that is related to this InstancedAccountInformation. |
accountByVendorAccountId - Account
|
Reads a single Account that is related to this InstancedAccountInformation. |
instancedAccountInformationHistoriesByRecordId - InstancedAccountInformationHistoriesConnection!
|
Reads and enables pagination through a set of InstancedAccountInformationHistory. |
Arguments
|
|
Example
{
"nodeId": "4",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"vendorAccountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"field": "abc123",
"value": "abc123",
"permissionMask": BitString,
"accountByAccountId": Account,
"accountByVendorAccountId": Account,
"instancedAccountInformationHistoriesByRecordId": InstancedAccountInformationHistoriesConnection
}
InstancedAccountInformationCondition
Description
A condition to be used against InstancedAccountInformation object types. All fields are tested for equality and combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
id - UUID
|
Checks for equality with the object’s id field. |
accountId - UUID
|
Checks for equality with the object’s accountId field. |
vendorAccountId - UUID
|
Checks for equality with the object’s vendorAccountId field. |
field - String
|
Checks for equality with the object’s field field. |
value - String
|
Checks for equality with the object’s value field. |
permissionMask - BitString
|
Checks for equality with the object’s permissionMask field. |
Example
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"vendorAccountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"field": "xyz789",
"value": "xyz789",
"permissionMask": BitString
}
InstancedAccountInformationFilter
Description
A filter to be used against InstancedAccountInformation object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
id - UUIDFilter
|
Filter by the object’s id field. |
accountId - UUIDFilter
|
Filter by the object’s accountId field. |
vendorAccountId - UUIDFilter
|
Filter by the object’s vendorAccountId field. |
field - StringFilter
|
Filter by the object’s field field. |
value - StringFilter
|
Filter by the object’s value field. |
permissionMask - BitStringFilter
|
Filter by the object’s permissionMask field. |
instancedAccountInformationHistoriesByRecordId - InstancedAccountInformationToManyInstancedAccountInformationHistoryFilter
|
Filter by the object’s instancedAccountInformationHistoriesByRecordId relation. |
instancedAccountInformationHistoriesByRecordIdExist - Boolean
|
Some related instancedAccountInformationHistoriesByRecordId exist. |
accountByAccountId - AccountFilter
|
Filter by the object’s accountByAccountId relation. |
accountByVendorAccountId - AccountFilter
|
Filter by the object’s accountByVendorAccountId relation. |
and - [InstancedAccountInformationFilter!]
|
Checks for all expressions in this list. |
or - [InstancedAccountInformationFilter!]
|
Checks for any expressions in this list. |
not - InstancedAccountInformationFilter
|
Negates the expression. |
Example
{
"id": UUIDFilter,
"accountId": UUIDFilter,
"vendorAccountId": UUIDFilter,
"field": StringFilter,
"value": StringFilter,
"permissionMask": BitStringFilter,
"instancedAccountInformationHistoriesByRecordId": InstancedAccountInformationToManyInstancedAccountInformationHistoryFilter,
"instancedAccountInformationHistoriesByRecordIdExist": true,
"accountByAccountId": AccountFilter,
"accountByVendorAccountId": AccountFilter,
"and": [InstancedAccountInformationFilter],
"or": [InstancedAccountInformationFilter],
"not": InstancedAccountInformationFilter
}
InstancedAccountInformationHistoriesConnection
Description
A connection to a list of InstancedAccountInformationHistory values.
Fields
| Field Name | Description |
|---|---|
nodes - [InstancedAccountInformationHistory]!
|
A list of InstancedAccountInformationHistory objects. |
edges - [InstancedAccountInformationHistoriesEdge!]!
|
A list of edges which contains the InstancedAccountInformationHistory and cursor to aid in pagination. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The count of all InstancedAccountInformationHistory you could get from the connection. |
Example
{
"nodes": [InstancedAccountInformationHistory],
"edges": [InstancedAccountInformationHistoriesEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
InstancedAccountInformationHistoriesEdge
Description
A InstancedAccountInformationHistory edge in the connection.
Fields
| Field Name | Description |
|---|---|
cursor - Cursor
|
A cursor for use in pagination. |
node - InstancedAccountInformationHistory
|
The InstancedAccountInformationHistory at the end of the edge. |
Example
{
"cursor": Cursor,
"node": InstancedAccountInformationHistory
}
InstancedAccountInformationHistoriesOrderBy
Description
Methods to use when ordering InstancedAccountInformationHistory.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NATURAL"
InstancedAccountInformationHistory
Fields
| Field Name | Description |
|---|---|
nodeId - ID!
|
A globally unique identifier. Can be used in various places throughout the system to identify this single value. |
id - UUID!
|
|
recordId - UUID!
|
|
accountId - UUID!
|
|
vendorAccountId - UUID!
|
|
field - String!
|
|
value - String!
|
|
permissionMask - BitString!
|
|
updatedOn - Datetime!
|
|
updatedUserId - UUID
|
|
updatedAccountId - UUID
|
|
instancedAccountInformationByRecordId - InstancedAccountInformation
|
Reads a single InstancedAccountInformation that is related to this InstancedAccountInformationHistory. |
Example
{
"nodeId": "4",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"recordId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"vendorAccountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"field": "xyz789",
"value": "xyz789",
"permissionMask": BitString,
"updatedOn": Datetime,
"updatedUserId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"updatedAccountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"instancedAccountInformationByRecordId": InstancedAccountInformation
}
InstancedAccountInformationHistoryCondition
Description
A condition to be used against InstancedAccountInformationHistory object types. All fields are tested for equality and combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
id - UUID
|
Checks for equality with the object’s id field. |
recordId - UUID
|
Checks for equality with the object’s recordId field. |
accountId - UUID
|
Checks for equality with the object’s accountId field. |
vendorAccountId - UUID
|
Checks for equality with the object’s vendorAccountId field. |
field - String
|
Checks for equality with the object’s field field. |
value - String
|
Checks for equality with the object’s value field. |
permissionMask - BitString
|
Checks for equality with the object’s permissionMask field. |
updatedOn - Datetime
|
Checks for equality with the object’s updatedOn field. |
updatedUserId - UUID
|
Checks for equality with the object’s updatedUserId field. |
updatedAccountId - UUID
|
Checks for equality with the object’s updatedAccountId field. |
Example
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"recordId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"vendorAccountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"field": "xyz789",
"value": "abc123",
"permissionMask": BitString,
"updatedOn": Datetime,
"updatedUserId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"updatedAccountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
InstancedAccountInformationHistoryFilter
Description
A filter to be used against InstancedAccountInformationHistory object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
id - UUIDFilter
|
Filter by the object’s id field. |
recordId - UUIDFilter
|
Filter by the object’s recordId field. |
accountId - UUIDFilter
|
Filter by the object’s accountId field. |
vendorAccountId - UUIDFilter
|
Filter by the object’s vendorAccountId field. |
field - StringFilter
|
Filter by the object’s field field. |
value - StringFilter
|
Filter by the object’s value field. |
permissionMask - BitStringFilter
|
Filter by the object’s permissionMask field. |
updatedOn - DatetimeFilter
|
Filter by the object’s updatedOn field. |
updatedUserId - UUIDFilter
|
Filter by the object’s updatedUserId field. |
updatedAccountId - UUIDFilter
|
Filter by the object’s updatedAccountId field. |
instancedAccountInformationByRecordId - InstancedAccountInformationFilter
|
Filter by the object’s instancedAccountInformationByRecordId relation. |
and - [InstancedAccountInformationHistoryFilter!]
|
Checks for all expressions in this list. |
or - [InstancedAccountInformationHistoryFilter!]
|
Checks for any expressions in this list. |
not - InstancedAccountInformationHistoryFilter
|
Negates the expression. |
Example
{
"id": UUIDFilter,
"recordId": UUIDFilter,
"accountId": UUIDFilter,
"vendorAccountId": UUIDFilter,
"field": StringFilter,
"value": StringFilter,
"permissionMask": BitStringFilter,
"updatedOn": DatetimeFilter,
"updatedUserId": UUIDFilter,
"updatedAccountId": UUIDFilter,
"instancedAccountInformationByRecordId": InstancedAccountInformationFilter,
"and": [InstancedAccountInformationHistoryFilter],
"or": [InstancedAccountInformationHistoryFilter],
"not": InstancedAccountInformationHistoryFilter
}
InstancedAccountInformationHistoryInput
Description
An input for mutations affecting InstancedAccountInformationHistory
Example
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"recordId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"vendorAccountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"field": "xyz789",
"value": "abc123",
"permissionMask": BitString,
"updatedOn": Datetime,
"updatedUserId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"updatedAccountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
InstancedAccountInformationHistoryPatch
Description
Represents an update to a InstancedAccountInformationHistory. Fields that are set will be updated.
Example
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"recordId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"vendorAccountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"field": "abc123",
"value": "abc123",
"permissionMask": BitString,
"updatedOn": Datetime,
"updatedUserId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"updatedAccountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
InstancedAccountInformationToManyInstancedAccountInformationHistoryFilter
Description
A filter to be used against many InstancedAccountInformationHistory object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - InstancedAccountInformationHistoryFilter
|
Every related InstancedAccountInformationHistory matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - InstancedAccountInformationHistoryFilter
|
Some related InstancedAccountInformationHistory matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - InstancedAccountInformationHistoryFilter
|
No related InstancedAccountInformationHistory matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": InstancedAccountInformationHistoryFilter,
"some": InstancedAccountInformationHistoryFilter,
"none": InstancedAccountInformationHistoryFilter
}
InstancedAccountInformationsConnection
Description
A connection to a list of InstancedAccountInformation values.
Fields
| Field Name | Description |
|---|---|
nodes - [InstancedAccountInformation]!
|
A list of InstancedAccountInformation objects. |
edges - [InstancedAccountInformationsEdge!]!
|
A list of edges which contains the InstancedAccountInformation and cursor to aid in pagination. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The count of all InstancedAccountInformation you could get from the connection. |
Example
{
"nodes": [InstancedAccountInformation],
"edges": [InstancedAccountInformationsEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
InstancedAccountInformationsEdge
Description
A InstancedAccountInformation edge in the connection.
Fields
| Field Name | Description |
|---|---|
cursor - Cursor
|
A cursor for use in pagination. |
node - InstancedAccountInformation
|
The InstancedAccountInformation at the end of the edge. |
Example
{
"cursor": Cursor,
"node": InstancedAccountInformation
}
InstancedAccountInformationsOrderBy
Description
Methods to use when ordering InstancedAccountInformation.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NATURAL"
InstancedMappingField
Fields
| Field Name | Description |
|---|---|
nodeId - ID!
|
A globally unique identifier. Can be used in various places throughout the system to identify this single value. |
id - UUID!
|
|
accountId - UUID!
|
|
mappedSigningTemplateId - UUID!
|
|
onboardingQuestionId - UUID!
|
|
field - String!
|
|
description - String!
|
|
accountByAccountId - Account
|
Reads a single Account that is related to this InstancedMappingField. |
mappedSigningTemplateByMappedSigningTemplateId - MappedSigningTemplate
|
Reads a single MappedSigningTemplate that is related to this InstancedMappingField. |
onboardingQuestionByOnboardingQuestionId - OnboardingQuestion
|
Reads a single OnboardingQuestion that is related to this InstancedMappingField. |
Example
{
"nodeId": 4,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"mappedSigningTemplateId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"onboardingQuestionId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"field": "xyz789",
"description": "xyz789",
"accountByAccountId": Account,
"mappedSigningTemplateByMappedSigningTemplateId": MappedSigningTemplate,
"onboardingQuestionByOnboardingQuestionId": OnboardingQuestion
}
InstancedMappingFieldCondition
Description
A condition to be used against InstancedMappingField object types. All fields are tested for equality and combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
id - UUID
|
Checks for equality with the object’s id field. |
accountId - UUID
|
Checks for equality with the object’s accountId field. |
mappedSigningTemplateId - UUID
|
Checks for equality with the object’s mappedSigningTemplateId field. |
onboardingQuestionId - UUID
|
Checks for equality with the object’s onboardingQuestionId field. |
field - String
|
Checks for equality with the object’s field field. |
description - String
|
Checks for equality with the object’s description field. |
Example
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"mappedSigningTemplateId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"onboardingQuestionId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"field": "abc123",
"description": "abc123"
}
InstancedMappingFieldFilter
Description
A filter to be used against InstancedMappingField object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
id - UUIDFilter
|
Filter by the object’s id field. |
accountId - UUIDFilter
|
Filter by the object’s accountId field. |
mappedSigningTemplateId - UUIDFilter
|
Filter by the object’s mappedSigningTemplateId field. |
onboardingQuestionId - UUIDFilter
|
Filter by the object’s onboardingQuestionId field. |
field - StringFilter
|
Filter by the object’s field field. |
description - StringFilter
|
Filter by the object’s description field. |
accountByAccountId - AccountFilter
|
Filter by the object’s accountByAccountId relation. |
mappedSigningTemplateByMappedSigningTemplateId - MappedSigningTemplateFilter
|
Filter by the object’s mappedSigningTemplateByMappedSigningTemplateId relation. |
onboardingQuestionByOnboardingQuestionId - OnboardingQuestionFilter
|
Filter by the object’s onboardingQuestionByOnboardingQuestionId relation. |
and - [InstancedMappingFieldFilter!]
|
Checks for all expressions in this list. |
or - [InstancedMappingFieldFilter!]
|
Checks for any expressions in this list. |
not - InstancedMappingFieldFilter
|
Negates the expression. |
Example
{
"id": UUIDFilter,
"accountId": UUIDFilter,
"mappedSigningTemplateId": UUIDFilter,
"onboardingQuestionId": UUIDFilter,
"field": StringFilter,
"description": StringFilter,
"accountByAccountId": AccountFilter,
"mappedSigningTemplateByMappedSigningTemplateId": MappedSigningTemplateFilter,
"onboardingQuestionByOnboardingQuestionId": OnboardingQuestionFilter,
"and": [InstancedMappingFieldFilter],
"or": [InstancedMappingFieldFilter],
"not": InstancedMappingFieldFilter
}
InstancedMappingFieldsConnection
Description
A connection to a list of InstancedMappingField values.
Fields
| Field Name | Description |
|---|---|
nodes - [InstancedMappingField]!
|
A list of InstancedMappingField objects. |
edges - [InstancedMappingFieldsEdge!]!
|
A list of edges which contains the InstancedMappingField and cursor to aid in pagination. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The count of all InstancedMappingField you could get from the connection. |
Example
{
"nodes": [InstancedMappingField],
"edges": [InstancedMappingFieldsEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
InstancedMappingFieldsEdge
Description
A InstancedMappingField edge in the connection.
Fields
| Field Name | Description |
|---|---|
cursor - Cursor
|
A cursor for use in pagination. |
node - InstancedMappingField
|
The InstancedMappingField at the end of the edge. |
Example
{
"cursor": Cursor,
"node": InstancedMappingField
}
InstancedMappingFieldsOrderBy
Description
Methods to use when ordering InstancedMappingField.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NATURAL"
Int
Description
The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.
Example
123
IntFilter
Description
A filter to be used against Int fields. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
isNull - Boolean
|
Is null (if true is specified) or is not null (if false is specified). |
equalTo - Int
|
Equal to the specified value. |
notEqualTo - Int
|
Not equal to the specified value. |
distinctFrom - Int
|
Not equal to the specified value, treating null like an ordinary value. |
notDistinctFrom - Int
|
Equal to the specified value, treating null like an ordinary value. |
in - [Int!]
|
Included in the specified list. |
notIn - [Int!]
|
Not included in the specified list. |
lessThan - Int
|
Less than the specified value. |
lessThanOrEqualTo - Int
|
Less than or equal to the specified value. |
greaterThan - Int
|
Greater than the specified value. |
greaterThanOrEqualTo - Int
|
Greater than or equal to the specified value. |
Example
{
"isNull": true,
"equalTo": 987,
"notEqualTo": 987,
"distinctFrom": 123,
"notDistinctFrom": 987,
"in": [987],
"notIn": [987],
"lessThan": 123,
"lessThanOrEqualTo": 987,
"greaterThan": 123,
"greaterThanOrEqualTo": 123
}
Integration
Fields
| Field Name | Description |
|---|---|
nodeId - ID!
|
A globally unique identifier. Can be used in various places throughout the system to identify this single value. |
type - String!
|
|
service - String!
|
|
chain - String!
|
|
partnerId - UUID!
|
|
description - String
|
|
mask - BitString!
|
|
id - UUID!
|
|
integrationTypeByType - IntegrationType
|
Reads a single IntegrationType that is related to this Integration. |
chainByChain - Chain
|
Reads a single Chain that is related to this Integration. |
integrationPartnerByPartnerId - IntegrationPartner
|
Reads a single IntegrationPartner that is related to this Integration. |
contractsByCustodianId - ContractsConnection!
|
Reads and enables pagination through a set of Contract. |
Arguments
|
|
contractsByIssuancePlatformId - ContractsConnection!
|
Reads and enables pagination through a set of Contract. |
Arguments
|
|
accountIntegrationsByIntegrationId - AccountIntegrationsConnection!
|
Reads and enables pagination through a set of AccountIntegration. |
Arguments
|
|
vendorQualificationsByIntegrationId - VendorQualificationsConnection!
|
Reads and enables pagination through a set of VendorQualification. |
Arguments
|
|
distributionQualificationsByIntegrationId - DistributionQualificationsConnection!
|
Reads and enables pagination through a set of DistributionQualification. |
Arguments
|
|
signingAccountsByIntegrationId - SigningAccountsConnection!
|
Reads and enables pagination through a set of SigningAccount. |
Arguments
|
|
paymentAccountsByIntegrationId - PaymentAccountsConnection!
|
Reads and enables pagination through a set of PaymentAccount. |
Arguments
|
|
paymentMethodsByIntegrationId - PaymentMethodsConnection!
|
Reads and enables pagination through a set of PaymentMethod. |
Arguments
|
|
accountIntegrationByIntegrationId - AccountIntegration
|
|
Example
{
"nodeId": 4,
"type": "abc123",
"service": "xyz789",
"chain": "xyz789",
"partnerId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"description": "xyz789",
"mask": BitString,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"integrationTypeByType": IntegrationType,
"chainByChain": Chain,
"integrationPartnerByPartnerId": IntegrationPartner,
"contractsByCustodianId": ContractsConnection,
"contractsByIssuancePlatformId": ContractsConnection,
"accountIntegrationsByIntegrationId": AccountIntegrationsConnection,
"vendorQualificationsByIntegrationId": VendorQualificationsConnection,
"distributionQualificationsByIntegrationId": DistributionQualificationsConnection,
"signingAccountsByIntegrationId": SigningAccountsConnection,
"paymentAccountsByIntegrationId": PaymentAccountsConnection,
"paymentMethodsByIntegrationId": PaymentMethodsConnection,
"accountIntegrationByIntegrationId": AccountIntegration
}
IntegrationCondition
Description
A condition to be used against Integration object types. All fields are tested for equality and combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
type - String
|
Checks for equality with the object’s type field. |
service - String
|
Checks for equality with the object’s service field. |
chain - String
|
Checks for equality with the object’s chain field. |
partnerId - UUID
|
Checks for equality with the object’s partnerId field. |
description - String
|
Checks for equality with the object’s description field. |
mask - BitString
|
Checks for equality with the object’s mask field. |
id - UUID
|
Checks for equality with the object’s id field. |
Example
{
"type": "abc123",
"service": "abc123",
"chain": "xyz789",
"partnerId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"description": "xyz789",
"mask": BitString,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
IntegrationFilter
Description
A filter to be used against Integration object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
type - StringFilter
|
Filter by the object’s type field. |
service - StringFilter
|
Filter by the object’s service field. |
chain - StringFilter
|
Filter by the object’s chain field. |
partnerId - UUIDFilter
|
Filter by the object’s partnerId field. |
description - StringFilter
|
Filter by the object’s description field. |
mask - BitStringFilter
|
Filter by the object’s mask field. |
id - UUIDFilter
|
Filter by the object’s id field. |
contractsByCustodianId - IntegrationToManyContractFilter
|
Filter by the object’s contractsByCustodianId relation. |
contractsByCustodianIdExist - Boolean
|
Some related contractsByCustodianId exist. |
contractsByIssuancePlatformId - IntegrationToManyContractFilter
|
Filter by the object’s contractsByIssuancePlatformId relation. |
contractsByIssuancePlatformIdExist - Boolean
|
Some related contractsByIssuancePlatformId exist. |
accountIntegrationsByIntegrationId - IntegrationToManyAccountIntegrationFilter
|
Filter by the object’s accountIntegrationsByIntegrationId relation. |
accountIntegrationsByIntegrationIdExist - Boolean
|
Some related accountIntegrationsByIntegrationId exist. |
vendorQualificationsByIntegrationId - IntegrationToManyVendorQualificationFilter
|
Filter by the object’s vendorQualificationsByIntegrationId relation. |
vendorQualificationsByIntegrationIdExist - Boolean
|
Some related vendorQualificationsByIntegrationId exist. |
distributionQualificationsByIntegrationId - IntegrationToManyDistributionQualificationFilter
|
Filter by the object’s distributionQualificationsByIntegrationId relation. |
distributionQualificationsByIntegrationIdExist - Boolean
|
Some related distributionQualificationsByIntegrationId exist. |
signingAccountsByIntegrationId - IntegrationToManySigningAccountFilter
|
Filter by the object’s signingAccountsByIntegrationId relation. |
signingAccountsByIntegrationIdExist - Boolean
|
Some related signingAccountsByIntegrationId exist. |
paymentAccountsByIntegrationId - IntegrationToManyPaymentAccountFilter
|
Filter by the object’s paymentAccountsByIntegrationId relation. |
paymentAccountsByIntegrationIdExist - Boolean
|
Some related paymentAccountsByIntegrationId exist. |
paymentMethodsByIntegrationId - IntegrationToManyPaymentMethodFilter
|
Filter by the object’s paymentMethodsByIntegrationId relation. |
paymentMethodsByIntegrationIdExist - Boolean
|
Some related paymentMethodsByIntegrationId exist. |
integrationTypeByType - IntegrationTypeFilter
|
Filter by the object’s integrationTypeByType relation. |
chainByChain - ChainFilter
|
Filter by the object’s chainByChain relation. |
integrationPartnerByPartnerId - IntegrationPartnerFilter
|
Filter by the object’s integrationPartnerByPartnerId relation. |
and - [IntegrationFilter!]
|
Checks for all expressions in this list. |
or - [IntegrationFilter!]
|
Checks for any expressions in this list. |
not - IntegrationFilter
|
Negates the expression. |
Example
{
"type": StringFilter,
"service": StringFilter,
"chain": StringFilter,
"partnerId": UUIDFilter,
"description": StringFilter,
"mask": BitStringFilter,
"id": UUIDFilter,
"contractsByCustodianId": IntegrationToManyContractFilter,
"contractsByCustodianIdExist": false,
"contractsByIssuancePlatformId": IntegrationToManyContractFilter,
"contractsByIssuancePlatformIdExist": true,
"accountIntegrationsByIntegrationId": IntegrationToManyAccountIntegrationFilter,
"accountIntegrationsByIntegrationIdExist": true,
"vendorQualificationsByIntegrationId": IntegrationToManyVendorQualificationFilter,
"vendorQualificationsByIntegrationIdExist": false,
"distributionQualificationsByIntegrationId": IntegrationToManyDistributionQualificationFilter,
"distributionQualificationsByIntegrationIdExist": true,
"signingAccountsByIntegrationId": IntegrationToManySigningAccountFilter,
"signingAccountsByIntegrationIdExist": false,
"paymentAccountsByIntegrationId": IntegrationToManyPaymentAccountFilter,
"paymentAccountsByIntegrationIdExist": true,
"paymentMethodsByIntegrationId": IntegrationToManyPaymentMethodFilter,
"paymentMethodsByIntegrationIdExist": true,
"integrationTypeByType": IntegrationTypeFilter,
"chainByChain": ChainFilter,
"integrationPartnerByPartnerId": IntegrationPartnerFilter,
"and": [IntegrationFilter],
"or": [IntegrationFilter],
"not": IntegrationFilter
}
IntegrationPartner
Fields
| Field Name | Description |
|---|---|
nodeId - ID!
|
A globally unique identifier. Can be used in various places throughout the system to identify this single value. |
id - UUID!
|
|
name - String!
|
|
url - String
|
|
logo - String
|
|
integrationsByPartnerId - IntegrationsConnection!
|
Reads and enables pagination through a set of Integration. |
Arguments
|
|
Example
{
"nodeId": 4,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"name": "xyz789",
"url": "xyz789",
"logo": "xyz789",
"integrationsByPartnerId": IntegrationsConnection
}
IntegrationPartnerCondition
Description
A condition to be used against IntegrationPartner object types. All fields are tested for equality and combined with a logical ‘and.’
Example
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"name": "xyz789",
"url": "abc123",
"logo": "xyz789"
}
IntegrationPartnerFilter
Description
A filter to be used against IntegrationPartner object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
id - UUIDFilter
|
Filter by the object’s id field. |
name - StringFilter
|
Filter by the object’s name field. |
url - StringFilter
|
Filter by the object’s url field. |
logo - StringFilter
|
Filter by the object’s logo field. |
integrationsByPartnerId - IntegrationPartnerToManyIntegrationFilter
|
Filter by the object’s integrationsByPartnerId relation. |
integrationsByPartnerIdExist - Boolean
|
Some related integrationsByPartnerId exist. |
and - [IntegrationPartnerFilter!]
|
Checks for all expressions in this list. |
or - [IntegrationPartnerFilter!]
|
Checks for any expressions in this list. |
not - IntegrationPartnerFilter
|
Negates the expression. |
Example
{
"id": UUIDFilter,
"name": StringFilter,
"url": StringFilter,
"logo": StringFilter,
"integrationsByPartnerId": IntegrationPartnerToManyIntegrationFilter,
"integrationsByPartnerIdExist": true,
"and": [IntegrationPartnerFilter],
"or": [IntegrationPartnerFilter],
"not": IntegrationPartnerFilter
}
IntegrationPartnerToManyIntegrationFilter
Description
A filter to be used against many Integration object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - IntegrationFilter
|
Every related Integration matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - IntegrationFilter
|
Some related Integration matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - IntegrationFilter
|
No related Integration matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": IntegrationFilter,
"some": IntegrationFilter,
"none": IntegrationFilter
}
IntegrationPartnersConnection
Description
A connection to a list of IntegrationPartner values.
Fields
| Field Name | Description |
|---|---|
nodes - [IntegrationPartner]!
|
A list of IntegrationPartner objects. |
edges - [IntegrationPartnersEdge!]!
|
A list of edges which contains the IntegrationPartner and cursor to aid in pagination. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The count of all IntegrationPartner you could get from the connection. |
Example
{
"nodes": [IntegrationPartner],
"edges": [IntegrationPartnersEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
IntegrationPartnersEdge
Description
A IntegrationPartner edge in the connection.
Fields
| Field Name | Description |
|---|---|
cursor - Cursor
|
A cursor for use in pagination. |
node - IntegrationPartner
|
The IntegrationPartner at the end of the edge. |
Example
{
"cursor": Cursor,
"node": IntegrationPartner
}
IntegrationPartnersOrderBy
Description
Methods to use when ordering IntegrationPartner.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NATURAL"
IntegrationToManyAccountIntegrationFilter
Description
A filter to be used against many AccountIntegration object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - AccountIntegrationFilter
|
Every related AccountIntegration matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - AccountIntegrationFilter
|
Some related AccountIntegration matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - AccountIntegrationFilter
|
No related AccountIntegration matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": AccountIntegrationFilter,
"some": AccountIntegrationFilter,
"none": AccountIntegrationFilter
}
IntegrationToManyContractFilter
Description
A filter to be used against many Contract object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - ContractFilter
|
Every related Contract matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - ContractFilter
|
Some related Contract matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - ContractFilter
|
No related Contract matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": ContractFilter,
"some": ContractFilter,
"none": ContractFilter
}
IntegrationToManyDistributionQualificationFilter
Description
A filter to be used against many DistributionQualification object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - DistributionQualificationFilter
|
Every related DistributionQualification matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - DistributionQualificationFilter
|
Some related DistributionQualification matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - DistributionQualificationFilter
|
No related DistributionQualification matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": DistributionQualificationFilter,
"some": DistributionQualificationFilter,
"none": DistributionQualificationFilter
}
IntegrationToManyPaymentAccountFilter
Description
A filter to be used against many PaymentAccount object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - PaymentAccountFilter
|
Every related PaymentAccount matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - PaymentAccountFilter
|
Some related PaymentAccount matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - PaymentAccountFilter
|
No related PaymentAccount matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": PaymentAccountFilter,
"some": PaymentAccountFilter,
"none": PaymentAccountFilter
}
IntegrationToManyPaymentMethodFilter
Description
A filter to be used against many PaymentMethod object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - PaymentMethodFilter
|
Every related PaymentMethod matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - PaymentMethodFilter
|
Some related PaymentMethod matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - PaymentMethodFilter
|
No related PaymentMethod matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": PaymentMethodFilter,
"some": PaymentMethodFilter,
"none": PaymentMethodFilter
}
IntegrationToManySigningAccountFilter
Description
A filter to be used against many SigningAccount object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - SigningAccountFilter
|
Every related SigningAccount matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - SigningAccountFilter
|
Some related SigningAccount matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - SigningAccountFilter
|
No related SigningAccount matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": SigningAccountFilter,
"some": SigningAccountFilter,
"none": SigningAccountFilter
}
IntegrationToManyVendorQualificationFilter
Description
A filter to be used against many VendorQualification object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - VendorQualificationFilter
|
Every related VendorQualification matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - VendorQualificationFilter
|
Some related VendorQualification matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - VendorQualificationFilter
|
No related VendorQualification matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": VendorQualificationFilter,
"some": VendorQualificationFilter,
"none": VendorQualificationFilter
}
IntegrationType
Fields
| Field Name | Description |
|---|---|
nodeId - ID!
|
A globally unique identifier. Can be used in various places throughout the system to identify this single value. |
type - String!
|
|
integrationsByType - IntegrationsConnection!
|
Reads and enables pagination through a set of Integration. |
Arguments
|
|
Example
{
"nodeId": "4",
"type": "xyz789",
"integrationsByType": IntegrationsConnection
}
IntegrationTypeCondition
Description
A condition to be used against IntegrationType object types. All fields are tested for equality and combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
type - String
|
Checks for equality with the object’s type field. |
Example
{"type": "abc123"}
IntegrationTypeFilter
Description
A filter to be used against IntegrationType object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
type - StringFilter
|
Filter by the object’s type field. |
integrationsByType - IntegrationTypeToManyIntegrationFilter
|
Filter by the object’s integrationsByType relation. |
integrationsByTypeExist - Boolean
|
Some related integrationsByType exist. |
and - [IntegrationTypeFilter!]
|
Checks for all expressions in this list. |
or - [IntegrationTypeFilter!]
|
Checks for any expressions in this list. |
not - IntegrationTypeFilter
|
Negates the expression. |
Example
{
"type": StringFilter,
"integrationsByType": IntegrationTypeToManyIntegrationFilter,
"integrationsByTypeExist": true,
"and": [IntegrationTypeFilter],
"or": [IntegrationTypeFilter],
"not": IntegrationTypeFilter
}
IntegrationTypeToManyIntegrationFilter
Description
A filter to be used against many Integration object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - IntegrationFilter
|
Every related Integration matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - IntegrationFilter
|
Some related Integration matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - IntegrationFilter
|
No related Integration matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": IntegrationFilter,
"some": IntegrationFilter,
"none": IntegrationFilter
}
IntegrationTypesConnection
Description
A connection to a list of IntegrationType values.
Fields
| Field Name | Description |
|---|---|
nodes - [IntegrationType]!
|
A list of IntegrationType objects. |
edges - [IntegrationTypesEdge!]!
|
A list of edges which contains the IntegrationType and cursor to aid in pagination. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The count of all IntegrationType you could get from the connection. |
Example
{
"nodes": [IntegrationType],
"edges": [IntegrationTypesEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
IntegrationTypesEdge
Description
A IntegrationType edge in the connection.
Fields
| Field Name | Description |
|---|---|
cursor - Cursor
|
A cursor for use in pagination. |
node - IntegrationType
|
The IntegrationType at the end of the edge. |
Example
{
"cursor": Cursor,
"node": IntegrationType
}
IntegrationTypesOrderBy
Description
Methods to use when ordering IntegrationType.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NATURAL"
IntegrationsConnection
Description
A connection to a list of Integration values.
Fields
| Field Name | Description |
|---|---|
nodes - [Integration]!
|
A list of Integration objects. |
edges - [IntegrationsEdge!]!
|
A list of edges which contains the Integration and cursor to aid in pagination. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The count of all Integration you could get from the connection. |
Example
{
"nodes": [Integration],
"edges": [IntegrationsEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
IntegrationsEdge
Description
A Integration edge in the connection.
Fields
| Field Name | Description |
|---|---|
cursor - Cursor
|
A cursor for use in pagination. |
node - Integration
|
The Integration at the end of the edge. |
Example
{
"cursor": Cursor,
"node": Integration
}
IntegrationsOrderBy
Description
Methods to use when ordering Integration.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NATURAL"
InvestorAccountType
Fields
| Field Name | Description |
|---|---|
nodeId - ID!
|
A globally unique identifier. Can be used in various places throughout the system to identify this single value. |
type - String!
|
|
accountsByInvestorType - AccountsConnection!
|
Reads and enables pagination through a set of Account. |
Arguments
|
|
customersByInvestorType - CustomersConnection!
|
Reads and enables pagination through a set of Customer. |
Arguments
|
|
Example
{
"nodeId": "4",
"type": "xyz789",
"accountsByInvestorType": AccountsConnection,
"customersByInvestorType": CustomersConnection
}
InvestorAccountTypeCondition
Description
A condition to be used against InvestorAccountType object types. All fields are tested for equality and combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
type - String
|
Checks for equality with the object’s type field. |
Example
{"type": "xyz789"}
InvestorAccountTypeFilter
Description
A filter to be used against InvestorAccountType object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
type - StringFilter
|
Filter by the object’s type field. |
accountsByInvestorType - InvestorAccountTypeToManyAccountFilter
|
Filter by the object’s accountsByInvestorType relation. |
accountsByInvestorTypeExist - Boolean
|
Some related accountsByInvestorType exist. |
customersByInvestorType - InvestorAccountTypeToManyCustomerFilter
|
Filter by the object’s customersByInvestorType relation. |
customersByInvestorTypeExist - Boolean
|
Some related customersByInvestorType exist. |
and - [InvestorAccountTypeFilter!]
|
Checks for all expressions in this list. |
or - [InvestorAccountTypeFilter!]
|
Checks for any expressions in this list. |
not - InvestorAccountTypeFilter
|
Negates the expression. |
Example
{
"type": StringFilter,
"accountsByInvestorType": InvestorAccountTypeToManyAccountFilter,
"accountsByInvestorTypeExist": true,
"customersByInvestorType": InvestorAccountTypeToManyCustomerFilter,
"customersByInvestorTypeExist": false,
"and": [InvestorAccountTypeFilter],
"or": [InvestorAccountTypeFilter],
"not": InvestorAccountTypeFilter
}
InvestorAccountTypeToManyAccountFilter
Description
A filter to be used against many Account object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - AccountFilter
|
Every related Account matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - AccountFilter
|
Some related Account matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - AccountFilter
|
No related Account matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": AccountFilter,
"some": AccountFilter,
"none": AccountFilter
}
InvestorAccountTypeToManyCustomerFilter
Description
A filter to be used against many Customer object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - CustomerFilter
|
Every related Customer matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - CustomerFilter
|
Some related Customer matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - CustomerFilter
|
No related Customer matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": CustomerFilter,
"some": CustomerFilter,
"none": CustomerFilter
}
InvestorAccountTypesConnection
Description
A connection to a list of InvestorAccountType values.
Fields
| Field Name | Description |
|---|---|
nodes - [InvestorAccountType]!
|
A list of InvestorAccountType objects. |
edges - [InvestorAccountTypesEdge!]!
|
A list of edges which contains the InvestorAccountType and cursor to aid in pagination. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The count of all InvestorAccountType you could get from the connection. |
Example
{
"nodes": [InvestorAccountType],
"edges": [InvestorAccountTypesEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
InvestorAccountTypesEdge
Description
A InvestorAccountType edge in the connection.
Fields
| Field Name | Description |
|---|---|
cursor - Cursor
|
A cursor for use in pagination. |
node - InvestorAccountType
|
The InvestorAccountType at the end of the edge. |
Example
{
"cursor": Cursor,
"node": InvestorAccountType
}
InvestorAccountTypesOrderBy
Description
Methods to use when ordering InvestorAccountType.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NATURAL"
InvestorMakeDistributionInput
Description
All input for the investorMakeDistribution mutation.
Example
{
"clientMutationId": "abc123",
"offeringId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"amount": BigFloat
}
InvestorMakeDistributionPayload
Description
The output of our investorMakeDistribution mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
The exact same clientMutationId that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations. |
distribution - Distribution
|
|
query - Query
|
Our root query field type. Allows us to run any query from our mutation payload. |
allocationByAllocationId - Allocation
|
Reads a single Allocation that is related to this Distribution. |
accountByInvestorId - Account
|
Reads a single Account that is related to this Distribution. |
distributionStatusByStatus - DistributionStatus
|
Reads a single DistributionStatus that is related to this Distribution. |
stepByStepId - Step
|
Reads a single Step that is related to this Distribution. |
distributionEdge - DistributionsEdge
|
An edge for our Distribution. May be used by Relay 1. |
Arguments
|
|
Example
{
"clientMutationId": "abc123",
"distribution": Distribution,
"query": Query,
"allocationByAllocationId": Allocation,
"accountByInvestorId": Account,
"distributionStatusByStatus": DistributionStatus,
"stepByStepId": Step,
"distributionEdge": DistributionsEdge
}
InvestorOfferingDetail
Example
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"issuerName": "abc123",
"sellerName": "abc123",
"assetName": "xyz789",
"className": "xyz789",
"classPrice": BigFloat
}
InvitationStatus
Fields
| Field Name | Description |
|---|---|
nodeId - ID!
|
A globally unique identifier. Can be used in various places throughout the system to identify this single value. |
status - String!
|
|
customersByStatus - CustomersConnection!
|
Reads and enables pagination through a set of Customer. |
Arguments
|
|
brokerAllocationsByStatus - BrokerAllocationsConnection!
|
Reads and enables pagination through a set of BrokerAllocation. |
Arguments
|
|
vendorAgentsByStatus - VendorAgentsConnection!
|
Reads and enables pagination through a set of VendorAgent. |
Arguments
|
|
securityListingsByStatus - SecurityListingsConnection!
|
Reads and enables pagination through a set of SecurityListing. |
Arguments
|
|
Example
{
"nodeId": "4",
"status": "abc123",
"customersByStatus": CustomersConnection,
"brokerAllocationsByStatus": BrokerAllocationsConnection,
"vendorAgentsByStatus": VendorAgentsConnection,
"securityListingsByStatus": SecurityListingsConnection
}
InvitationStatusCondition
Description
A condition to be used against InvitationStatus object types. All fields are tested for equality and combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
status - String
|
Checks for equality with the object’s status field. |
Example
{"status": "abc123"}
InvitationStatusFilter
Description
A filter to be used against InvitationStatus object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
status - StringFilter
|
Filter by the object’s status field. |
customersByStatus - InvitationStatusToManyCustomerFilter
|
Filter by the object’s customersByStatus relation. |
customersByStatusExist - Boolean
|
Some related customersByStatus exist. |
brokerAllocationsByStatus - InvitationStatusToManyBrokerAllocationFilter
|
Filter by the object’s brokerAllocationsByStatus relation. |
brokerAllocationsByStatusExist - Boolean
|
Some related brokerAllocationsByStatus exist. |
vendorAgentsByStatus - InvitationStatusToManyVendorAgentFilter
|
Filter by the object’s vendorAgentsByStatus relation. |
vendorAgentsByStatusExist - Boolean
|
Some related vendorAgentsByStatus exist. |
securityListingsByStatus - InvitationStatusToManySecurityListingFilter
|
Filter by the object’s securityListingsByStatus relation. |
securityListingsByStatusExist - Boolean
|
Some related securityListingsByStatus exist. |
and - [InvitationStatusFilter!]
|
Checks for all expressions in this list. |
or - [InvitationStatusFilter!]
|
Checks for any expressions in this list. |
not - InvitationStatusFilter
|
Negates the expression. |
Example
{
"status": StringFilter,
"customersByStatus": InvitationStatusToManyCustomerFilter,
"customersByStatusExist": false,
"brokerAllocationsByStatus": InvitationStatusToManyBrokerAllocationFilter,
"brokerAllocationsByStatusExist": true,
"vendorAgentsByStatus": InvitationStatusToManyVendorAgentFilter,
"vendorAgentsByStatusExist": true,
"securityListingsByStatus": InvitationStatusToManySecurityListingFilter,
"securityListingsByStatusExist": true,
"and": [InvitationStatusFilter],
"or": [InvitationStatusFilter],
"not": InvitationStatusFilter
}
InvitationStatusToManyBrokerAllocationFilter
Description
A filter to be used against many BrokerAllocation object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - BrokerAllocationFilter
|
Every related BrokerAllocation matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - BrokerAllocationFilter
|
Some related BrokerAllocation matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - BrokerAllocationFilter
|
No related BrokerAllocation matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": BrokerAllocationFilter,
"some": BrokerAllocationFilter,
"none": BrokerAllocationFilter
}
InvitationStatusToManyCustomerFilter
Description
A filter to be used against many Customer object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - CustomerFilter
|
Every related Customer matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - CustomerFilter
|
Some related Customer matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - CustomerFilter
|
No related Customer matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": CustomerFilter,
"some": CustomerFilter,
"none": CustomerFilter
}
InvitationStatusToManySecurityListingFilter
Description
A filter to be used against many SecurityListing object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - SecurityListingFilter
|
Every related SecurityListing matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - SecurityListingFilter
|
Some related SecurityListing matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - SecurityListingFilter
|
No related SecurityListing matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": SecurityListingFilter,
"some": SecurityListingFilter,
"none": SecurityListingFilter
}
InvitationStatusToManyVendorAgentFilter
Description
A filter to be used against many VendorAgent object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - VendorAgentFilter
|
Every related VendorAgent matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - VendorAgentFilter
|
Some related VendorAgent matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - VendorAgentFilter
|
No related VendorAgent matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": VendorAgentFilter,
"some": VendorAgentFilter,
"none": VendorAgentFilter
}
InvitationStatusesConnection
Description
A connection to a list of InvitationStatus values.
Fields
| Field Name | Description |
|---|---|
nodes - [InvitationStatus]!
|
A list of InvitationStatus objects. |
edges - [InvitationStatusesEdge!]!
|
A list of edges which contains the InvitationStatus and cursor to aid in pagination. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The count of all InvitationStatus you could get from the connection. |
Example
{
"nodes": [InvitationStatus],
"edges": [InvitationStatusesEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
InvitationStatusesEdge
Description
A InvitationStatus edge in the connection.
Fields
| Field Name | Description |
|---|---|
cursor - Cursor
|
A cursor for use in pagination. |
node - InvitationStatus
|
The InvitationStatus at the end of the edge. |
Example
{
"cursor": Cursor,
"node": InvitationStatus
}
InvitationStatusesOrderBy
Description
Methods to use when ordering InvitationStatus.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NATURAL"
IssuanceEvent
Fields
| Field Name | Description |
|---|---|
nodeId - ID!
|
A globally unique identifier. Can be used in various places throughout the system to identify this single value. |
id - UUID!
|
|
assetId - UUID!
|
|
assetClassId - UUID!
|
|
distributionId - UUID!
|
|
investorId - UUID!
|
|
issuerId - UUID!
|
|
securityId - UUID!
|
|
holdingId - UUID!
|
|
createdOn - Datetime!
|
|
createdBy - UUID!
|
|
assetByAssetId - Asset
|
Reads a single Asset that is related to this IssuanceEvent. |
roundByAssetClassId - Round
|
Reads a single Round that is related to this IssuanceEvent. |
distributionByDistributionId - Distribution
|
Reads a single Distribution that is related to this IssuanceEvent. |
accountByInvestorId - Account
|
Reads a single Account that is related to this IssuanceEvent. |
accountByIssuerId - Account
|
Reads a single Account that is related to this IssuanceEvent. |
securityBySecurityId - Security
|
Reads a single Security that is related to this IssuanceEvent. |
holdingByHoldingId - Holding
|
Reads a single Holding that is related to this IssuanceEvent. |
userByCreatedBy - User
|
Reads a single User that is related to this IssuanceEvent. |
Example
{
"nodeId": 4,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"assetId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"assetClassId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"distributionId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"investorId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"issuerId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"securityId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"holdingId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"createdOn": Datetime,
"createdBy": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"assetByAssetId": Asset,
"roundByAssetClassId": Round,
"distributionByDistributionId": Distribution,
"accountByInvestorId": Account,
"accountByIssuerId": Account,
"securityBySecurityId": Security,
"holdingByHoldingId": Holding,
"userByCreatedBy": User
}
IssuanceEventCondition
Description
A condition to be used against IssuanceEvent object types. All fields are tested for equality and combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
id - UUID
|
Checks for equality with the object’s id field. |
assetId - UUID
|
Checks for equality with the object’s assetId field. |
assetClassId - UUID
|
Checks for equality with the object’s assetClassId field. |
distributionId - UUID
|
Checks for equality with the object’s distributionId field. |
investorId - UUID
|
Checks for equality with the object’s investorId field. |
issuerId - UUID
|
Checks for equality with the object’s issuerId field. |
securityId - UUID
|
Checks for equality with the object’s securityId field. |
holdingId - UUID
|
Checks for equality with the object’s holdingId field. |
createdOn - Datetime
|
Checks for equality with the object’s createdOn field. |
createdBy - UUID
|
Checks for equality with the object’s createdBy field. |
Example
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"assetId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"assetClassId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"distributionId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"investorId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"issuerId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"securityId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"holdingId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"createdOn": Datetime,
"createdBy": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
IssuanceEventFilter
Description
A filter to be used against IssuanceEvent object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
id - UUIDFilter
|
Filter by the object’s id field. |
assetId - UUIDFilter
|
Filter by the object’s assetId field. |
assetClassId - UUIDFilter
|
Filter by the object’s assetClassId field. |
distributionId - UUIDFilter
|
Filter by the object’s distributionId field. |
investorId - UUIDFilter
|
Filter by the object’s investorId field. |
issuerId - UUIDFilter
|
Filter by the object’s issuerId field. |
securityId - UUIDFilter
|
Filter by the object’s securityId field. |
holdingId - UUIDFilter
|
Filter by the object’s holdingId field. |
createdOn - DatetimeFilter
|
Filter by the object’s createdOn field. |
createdBy - UUIDFilter
|
Filter by the object’s createdBy field. |
assetByAssetId - AssetFilter
|
Filter by the object’s assetByAssetId relation. |
roundByAssetClassId - RoundFilter
|
Filter by the object’s roundByAssetClassId relation. |
distributionByDistributionId - DistributionFilter
|
Filter by the object’s distributionByDistributionId relation. |
accountByInvestorId - AccountFilter
|
Filter by the object’s accountByInvestorId relation. |
accountByIssuerId - AccountFilter
|
Filter by the object’s accountByIssuerId relation. |
securityBySecurityId - SecurityFilter
|
Filter by the object’s securityBySecurityId relation. |
holdingByHoldingId - HoldingFilter
|
Filter by the object’s holdingByHoldingId relation. |
userByCreatedBy - UserFilter
|
Filter by the object’s userByCreatedBy relation. |
and - [IssuanceEventFilter!]
|
Checks for all expressions in this list. |
or - [IssuanceEventFilter!]
|
Checks for any expressions in this list. |
not - IssuanceEventFilter
|
Negates the expression. |
Example
{
"id": UUIDFilter,
"assetId": UUIDFilter,
"assetClassId": UUIDFilter,
"distributionId": UUIDFilter,
"investorId": UUIDFilter,
"issuerId": UUIDFilter,
"securityId": UUIDFilter,
"holdingId": UUIDFilter,
"createdOn": DatetimeFilter,
"createdBy": UUIDFilter,
"assetByAssetId": AssetFilter,
"roundByAssetClassId": RoundFilter,
"distributionByDistributionId": DistributionFilter,
"accountByInvestorId": AccountFilter,
"accountByIssuerId": AccountFilter,
"securityBySecurityId": SecurityFilter,
"holdingByHoldingId": HoldingFilter,
"userByCreatedBy": UserFilter,
"and": [IssuanceEventFilter],
"or": [IssuanceEventFilter],
"not": IssuanceEventFilter
}
IssuanceEventsConnection
Description
A connection to a list of IssuanceEvent values.
Fields
| Field Name | Description |
|---|---|
nodes - [IssuanceEvent]!
|
A list of IssuanceEvent objects. |
edges - [IssuanceEventsEdge!]!
|
A list of edges which contains the IssuanceEvent and cursor to aid in pagination. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The count of all IssuanceEvent you could get from the connection. |
Example
{
"nodes": [IssuanceEvent],
"edges": [IssuanceEventsEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
IssuanceEventsEdge
Description
A IssuanceEvent edge in the connection.
Fields
| Field Name | Description |
|---|---|
cursor - Cursor
|
A cursor for use in pagination. |
node - IssuanceEvent
|
The IssuanceEvent at the end of the edge. |
Example
{
"cursor": Cursor,
"node": IssuanceEvent
}
IssuanceEventsOrderBy
Description
Methods to use when ordering IssuanceEvent.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NATURAL"
IssueAllocationsInput
Description
All input for the issueAllocations mutation.
Example
{
"clientMutationId": "xyz789",
"allocationIds": [
"429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
]
}
IssueAllocationsPayload
Description
The output of our issueAllocations mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
The exact same clientMutationId that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations. |
allocations - [Allocation]
|
|
query - Query
|
Our root query field type. Allows us to run any query from our mutation payload. |
Example
{
"clientMutationId": "abc123",
"allocations": [Allocation],
"query": Query
}
IssueDistributionsInput
Description
All input for the issueDistributions mutation.
Example
{
"clientMutationId": "xyz789",
"distributionIds": [
"429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
]
}
IssueDistributionsPayload
Description
The output of our issueDistributions mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
The exact same clientMutationId that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations. |
issuanceEvents - [IssuanceEvent]
|
|
query - Query
|
Our root query field type. Allows us to run any query from our mutation payload. |
Example
{
"clientMutationId": "abc123",
"issuanceEvents": [IssuanceEvent],
"query": Query
}
JSON
Description
The JSON scalar type represents JSON values as specified by ECMA-404.
Example
{}
JSONFilter
Description
A filter to be used against JSON fields. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
isNull - Boolean
|
Is null (if true is specified) or is not null (if false is specified). |
equalTo - JSON
|
Equal to the specified value. |
notEqualTo - JSON
|
Not equal to the specified value. |
distinctFrom - JSON
|
Not equal to the specified value, treating null like an ordinary value. |
notDistinctFrom - JSON
|
Equal to the specified value, treating null like an ordinary value. |
in - [JSON!]
|
Included in the specified list. |
notIn - [JSON!]
|
Not included in the specified list. |
lessThan - JSON
|
Less than the specified value. |
lessThanOrEqualTo - JSON
|
Less than or equal to the specified value. |
greaterThan - JSON
|
Greater than the specified value. |
greaterThanOrEqualTo - JSON
|
Greater than or equal to the specified value. |
contains - JSON
|
Contains the specified JSON. |
containsKey - String
|
Contains the specified key. |
containsAllKeys - [String!]
|
Contains all of the specified keys. |
containsAnyKeys - [String!]
|
Contains any of the specified keys. |
containedBy - JSON
|
Contained by the specified JSON. |
Example
{
"isNull": false,
"equalTo": {},
"notEqualTo": {},
"distinctFrom": {},
"notDistinctFrom": {},
"in": [{}],
"notIn": [{}],
"lessThan": {},
"lessThanOrEqualTo": {},
"greaterThan": {},
"greaterThanOrEqualTo": {},
"contains": {},
"containsKey": "xyz789",
"containsAllKeys": ["abc123"],
"containsAnyKeys": ["xyz789"],
"containedBy": {}
}
Ledger
Fields
| Field Name | Description |
|---|---|
nodeId - ID!
|
A globally unique identifier. Can be used in various places throughout the system to identify this single value. |
type - String
|
|
tokenId - UUID
|
|
blockchainAddressId - UUID!
|
|
investorId - UUID!
|
|
transactionId - String!
|
|
amount - BigFloat
|
|
createdOn - Datetime
|
|
id - UUID!
|
|
accountingTypeByType - AccountingType
|
Reads a single AccountingType that is related to this Ledger. |
tokenByTokenId - Token
|
Reads a single Token that is related to this Ledger. |
blockchainAddressByBlockchainAddressId - BlockchainAddress
|
Reads a single BlockchainAddress that is related to this Ledger. |
accountByInvestorId - Account
|
Reads a single Account that is related to this Ledger. |
transactionByTransactionId - Transaction
|
Reads a single Transaction that is related to this Ledger. |
Example
{
"nodeId": 4,
"type": "abc123",
"tokenId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"blockchainAddressId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"investorId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"transactionId": "abc123",
"amount": BigFloat,
"createdOn": Datetime,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountingTypeByType": AccountingType,
"tokenByTokenId": Token,
"blockchainAddressByBlockchainAddressId": BlockchainAddress,
"accountByInvestorId": Account,
"transactionByTransactionId": Transaction
}
LedgerCondition
Description
A condition to be used against Ledger object types. All fields are tested for equality and combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
type - String
|
Checks for equality with the object’s type field. |
tokenId - UUID
|
Checks for equality with the object’s tokenId field. |
blockchainAddressId - UUID
|
Checks for equality with the object’s blockchainAddressId field. |
investorId - UUID
|
Checks for equality with the object’s investorId field. |
transactionId - String
|
Checks for equality with the object’s transactionId field. |
amount - BigFloat
|
Checks for equality with the object’s amount field. |
createdOn - Datetime
|
Checks for equality with the object’s createdOn field. |
id - UUID
|
Checks for equality with the object’s id field. |
Example
{
"type": "abc123",
"tokenId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"blockchainAddressId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"investorId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"transactionId": "abc123",
"amount": BigFloat,
"createdOn": Datetime,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
LedgerFilter
Description
A filter to be used against Ledger object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
type - StringFilter
|
Filter by the object’s type field. |
tokenId - UUIDFilter
|
Filter by the object’s tokenId field. |
blockchainAddressId - UUIDFilter
|
Filter by the object’s blockchainAddressId field. |
investorId - UUIDFilter
|
Filter by the object’s investorId field. |
transactionId - StringFilter
|
Filter by the object’s transactionId field. |
amount - BigFloatFilter
|
Filter by the object’s amount field. |
createdOn - DatetimeFilter
|
Filter by the object’s createdOn field. |
id - UUIDFilter
|
Filter by the object’s id field. |
accountingTypeByType - AccountingTypeFilter
|
Filter by the object’s accountingTypeByType relation. |
accountingTypeByTypeExists - Boolean
|
A related accountingTypeByType exists. |
tokenByTokenId - TokenFilter
|
Filter by the object’s tokenByTokenId relation. |
tokenByTokenIdExists - Boolean
|
A related tokenByTokenId exists. |
blockchainAddressByBlockchainAddressId - BlockchainAddressFilter
|
Filter by the object’s blockchainAddressByBlockchainAddressId relation. |
accountByInvestorId - AccountFilter
|
Filter by the object’s accountByInvestorId relation. |
transactionByTransactionId - TransactionFilter
|
Filter by the object’s transactionByTransactionId relation. |
and - [LedgerFilter!]
|
Checks for all expressions in this list. |
or - [LedgerFilter!]
|
Checks for any expressions in this list. |
not - LedgerFilter
|
Negates the expression. |
Example
{
"type": StringFilter,
"tokenId": UUIDFilter,
"blockchainAddressId": UUIDFilter,
"investorId": UUIDFilter,
"transactionId": StringFilter,
"amount": BigFloatFilter,
"createdOn": DatetimeFilter,
"id": UUIDFilter,
"accountingTypeByType": AccountingTypeFilter,
"accountingTypeByTypeExists": false,
"tokenByTokenId": TokenFilter,
"tokenByTokenIdExists": true,
"blockchainAddressByBlockchainAddressId": BlockchainAddressFilter,
"accountByInvestorId": AccountFilter,
"transactionByTransactionId": TransactionFilter,
"and": [LedgerFilter],
"or": [LedgerFilter],
"not": LedgerFilter
}
LedgersConnection
Description
A connection to a list of Ledger values.
Fields
| Field Name | Description |
|---|---|
nodes - [Ledger]!
|
A list of Ledger objects. |
edges - [LedgersEdge!]!
|
A list of edges which contains the Ledger and cursor to aid in pagination. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The count of all Ledger you could get from the connection. |
Example
{
"nodes": [Ledger],
"edges": [LedgersEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
LedgersEdge
LedgersOrderBy
Description
Methods to use when ordering Ledger.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NATURAL"
MakeAllocationOfferingLinkInput
Description
All input for the makeAllocationOfferingLink mutation.
Example
{
"clientMutationId": "xyz789",
"_name": "abc123",
"_allocationId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"_agentId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
MakeAllocationOfferingLinkPayload
Description
The output of our makeAllocationOfferingLink mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
The exact same clientMutationId that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations. |
allocationOfferingLink - AllocationOfferingLink
|
|
query - Query
|
Our root query field type. Allows us to run any query from our mutation payload. |
allocationByAllocationId - Allocation
|
Reads a single Allocation that is related to this AllocationOfferingLink. |
accountByCreatedBy - Account
|
Reads a single Account that is related to this AllocationOfferingLink. |
accountByAgentId - Account
|
Reads a single Account that is related to this AllocationOfferingLink. |
allocationOfferingLinkEdge - AllocationOfferingLinksEdge
|
An edge for our AllocationOfferingLink. May be used by Relay 1. |
Arguments
|
|
Example
{
"clientMutationId": "abc123",
"allocationOfferingLink": AllocationOfferingLink,
"query": Query,
"allocationByAllocationId": Allocation,
"accountByCreatedBy": Account,
"accountByAgentId": Account,
"allocationOfferingLinkEdge": AllocationOfferingLinksEdge
}
MakeBlockchainAddressInput
Description
All input for the makeBlockchainAddress mutation.
Example
{
"clientMutationId": "xyz789",
"_name": "abc123",
"_address": "xyz789",
"_chain": "xyz789",
"_method": "abc123"
}
MakeBlockchainAddressPayload
Description
The output of our makeBlockchainAddress mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
The exact same clientMutationId that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations. |
blockchainAddress - BlockchainAddress
|
|
query - Query
|
Our root query field type. Allows us to run any query from our mutation payload. |
chainByChain - Chain
|
Reads a single Chain that is related to this BlockchainAddress. |
blockchainAddressEdge - BlockchainAddressesEdge
|
An edge for our BlockchainAddress. May be used by Relay 1. |
Arguments
|
|
Example
{
"clientMutationId": "xyz789",
"blockchainAddress": BlockchainAddress,
"query": Query,
"chainByChain": Chain,
"blockchainAddressEdge": BlockchainAddressesEdge
}
MakeCustomerInput
Description
All input for the makeCustomer mutation.
Example
{
"clientMutationId": "xyz789",
"_email": "abc123",
"name": "abc123"
}
MakeCustomerPayload
Description
The output of our makeCustomer mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
The exact same clientMutationId that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations. |
customer - Customer
|
|
query - Query
|
Our root query field type. Allows us to run any query from our mutation payload. |
accountByVendorId - Account
|
Reads a single Account that is related to this Customer. |
accountByInvestorId - Account
|
Reads a single Account that is related to this Customer. |
invitationStatusByStatus - InvitationStatus
|
Reads a single InvitationStatus that is related to this Customer. |
investorAccountTypeByInvestorType - InvestorAccountType
|
Reads a single InvestorAccountType that is related to this Customer. |
countryByJurisdiction - Country
|
Reads a single Country that is related to this Customer. |
customerEdge - CustomersEdge
|
An edge for our Customer. May be used by Relay 1. |
Arguments
|
|
Example
{
"clientMutationId": "abc123",
"customer": Customer,
"query": Query,
"accountByVendorId": Account,
"accountByInvestorId": Account,
"invitationStatusByStatus": InvitationStatus,
"investorAccountTypeByInvestorType": InvestorAccountType,
"countryByJurisdiction": Country,
"customerEdge": CustomersEdge
}
MakeDelegateInput
Description
All input for the makeDelegate mutation.
Example
{
"clientMutationId": "abc123",
"role": "xyz789",
"email": "xyz789",
"firstName": "abc123",
"lastName": "abc123"
}
MakeDelegatePayload
Description
The output of our makeDelegate mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
The exact same clientMutationId that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations. |
usersAccount - UsersAccount
|
|
query - Query
|
Our root query field type. Allows us to run any query from our mutation payload. |
userByUserId - User
|
Reads a single User that is related to this UsersAccount. |
accountByAccountId - Account
|
Reads a single Account that is related to this UsersAccount. |
auxRoleByRole - AuxRole
|
Reads a single AuxRole that is related to this UsersAccount. |
userStatusByStatus - UserStatus
|
Reads a single UserStatus that is related to this UsersAccount. |
usersAccountEdge - UsersAccountsEdge
|
An edge for our UsersAccount. May be used by Relay 1. |
Arguments
|
|
Example
{
"clientMutationId": "abc123",
"usersAccount": UsersAccount,
"query": Query,
"userByUserId": User,
"accountByAccountId": Account,
"auxRoleByRole": AuxRole,
"userStatusByStatus": UserStatus,
"usersAccountEdge": UsersAccountsEdge
}
MakeDistributionInput
Description
All input for the makeDistribution mutation.
Example
{
"clientMutationId": "abc123",
"_allocationId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountEmail": "abc123",
"amount": BigFloat,
"name": "abc123"
}
MakeDistributionPayload
Description
The output of our makeDistribution mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
The exact same clientMutationId that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations. |
distribution - Distribution
|
|
query - Query
|
Our root query field type. Allows us to run any query from our mutation payload. |
allocationByAllocationId - Allocation
|
Reads a single Allocation that is related to this Distribution. |
accountByInvestorId - Account
|
Reads a single Account that is related to this Distribution. |
distributionStatusByStatus - DistributionStatus
|
Reads a single DistributionStatus that is related to this Distribution. |
stepByStepId - Step
|
Reads a single Step that is related to this Distribution. |
distributionEdge - DistributionsEdge
|
An edge for our Distribution. May be used by Relay 1. |
Arguments
|
|
Example
{
"clientMutationId": "abc123",
"distribution": Distribution,
"query": Query,
"allocationByAllocationId": Allocation,
"accountByInvestorId": Account,
"distributionStatusByStatus": DistributionStatus,
"stepByStepId": Step,
"distributionEdge": DistributionsEdge
}
MakeDistributionQualificationsInput
Description
All input for the makeDistributionQualifications mutation.
Example
{
"clientMutationId": "abc123",
"distributionId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"vendorQualificationIds": [
"429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
]
}
MakeDistributionQualificationsPayload
Description
The output of our makeDistributionQualifications mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
The exact same clientMutationId that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations. |
distributionQualifications - [DistributionQualification]
|
|
query - Query
|
Our root query field type. Allows us to run any query from our mutation payload. |
Example
{
"clientMutationId": "abc123",
"distributionQualifications": [
DistributionQualification
],
"query": Query
}
MakeExternalBlockchainAddressInput
Description
All input for the makeExternalBlockchainAddress mutation.
Example
{
"clientMutationId": "xyz789",
"address": "abc123",
"chain": "abc123",
"investorId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
MakeExternalBlockchainAddressPayload
Description
The output of our makeExternalBlockchainAddress mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
The exact same clientMutationId that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations. |
blockchainAddress - BlockchainAddress
|
|
query - Query
|
Our root query field type. Allows us to run any query from our mutation payload. |
chainByChain - Chain
|
Reads a single Chain that is related to this BlockchainAddress. |
blockchainAddressEdge - BlockchainAddressesEdge
|
An edge for our BlockchainAddress. May be used by Relay 1. |
Arguments
|
|
Example
{
"clientMutationId": "xyz789",
"blockchainAddress": BlockchainAddress,
"query": Query,
"chainByChain": Chain,
"blockchainAddressEdge": BlockchainAddressesEdge
}
MakeHoldingDocumentInput
MakeInvestorInput
Description
All input for the makeInvestor mutation.
Example
{
"clientMutationId": "xyz789",
"email": "xyz789",
"name": "xyz789",
"data": {}
}
MakeInvestorPayload
Description
The output of our makeInvestor mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
The exact same clientMutationId that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations. |
account - Account
|
|
query - Query
|
Our root query field type. Allows us to run any query from our mutation payload. |
auxAccountByType - AuxAccount
|
Reads a single AuxAccount that is related to this Account. |
companyByCompany - Company
|
Reads a single Company that is related to this Account. |
countryByJurisdiction - Country
|
Reads a single Country that is related to this Account. |
investorAccountTypeByInvestorType - InvestorAccountType
|
Reads a single InvestorAccountType that is related to this Account. |
accountEdge - AccountsEdge
|
An edge for our Account. May be used by Relay 1. |
Arguments
|
|
Example
{
"clientMutationId": "abc123",
"account": Account,
"query": Query,
"auxAccountByType": AuxAccount,
"companyByCompany": Company,
"countryByJurisdiction": Country,
"investorAccountTypeByInvestorType": InvestorAccountType,
"accountEdge": AccountsEdge
}
MakeIssuerAccountInput
Description
All input for the makeIssuerAccount mutation.
Example
{
"clientMutationId": "abc123",
"companyName": "xyz789",
"companyEmail": "abc123"
}
MakeIssuerAccountPayload
Description
The output of our makeIssuerAccount mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
The exact same clientMutationId that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations. |
account - Account
|
|
query - Query
|
Our root query field type. Allows us to run any query from our mutation payload. |
auxAccountByType - AuxAccount
|
Reads a single AuxAccount that is related to this Account. |
companyByCompany - Company
|
Reads a single Company that is related to this Account. |
countryByJurisdiction - Country
|
Reads a single Country that is related to this Account. |
investorAccountTypeByInvestorType - InvestorAccountType
|
Reads a single InvestorAccountType that is related to this Account. |
accountEdge - AccountsEdge
|
An edge for our Account. May be used by Relay 1. |
Arguments
|
|
Example
{
"clientMutationId": "xyz789",
"account": Account,
"query": Query,
"auxAccountByType": AuxAccount,
"companyByCompany": Company,
"countryByJurisdiction": Country,
"investorAccountTypeByInvestorType": InvestorAccountType,
"accountEdge": AccountsEdge
}
MakeRealCustomerInput
Description
All input for the makeRealCustomer mutation.
Example
{
"clientMutationId": "abc123",
"email": "xyz789",
"name": "xyz789"
}
MakeRealCustomerPayload
Description
The output of our makeRealCustomer mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
The exact same clientMutationId that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations. |
customer - Customer
|
|
query - Query
|
Our root query field type. Allows us to run any query from our mutation payload. |
accountByVendorId - Account
|
Reads a single Account that is related to this Customer. |
accountByInvestorId - Account
|
Reads a single Account that is related to this Customer. |
invitationStatusByStatus - InvitationStatus
|
Reads a single InvitationStatus that is related to this Customer. |
investorAccountTypeByInvestorType - InvestorAccountType
|
Reads a single InvestorAccountType that is related to this Customer. |
countryByJurisdiction - Country
|
Reads a single Country that is related to this Customer. |
customerEdge - CustomersEdge
|
An edge for our Customer. May be used by Relay 1. |
Arguments
|
|
Example
{
"clientMutationId": "xyz789",
"customer": Customer,
"query": Query,
"accountByVendorId": Account,
"accountByInvestorId": Account,
"invitationStatusByStatus": InvitationStatus,
"investorAccountTypeByInvestorType": InvestorAccountType,
"countryByJurisdiction": Country,
"customerEdge": CustomersEdge
}
MakeRealDistributionInput
Description
All input for the makeRealDistribution mutation.
Example
{
"clientMutationId": "abc123",
"allocationId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountEmail": "abc123",
"amount": BigFloat,
"name": "xyz789"
}
MakeRealDistributionPayload
Description
The output of our makeRealDistribution mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
The exact same clientMutationId that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations. |
distribution - Distribution
|
|
query - Query
|
Our root query field type. Allows us to run any query from our mutation payload. |
allocationByAllocationId - Allocation
|
Reads a single Allocation that is related to this Distribution. |
accountByInvestorId - Account
|
Reads a single Account that is related to this Distribution. |
distributionStatusByStatus - DistributionStatus
|
Reads a single DistributionStatus that is related to this Distribution. |
stepByStepId - Step
|
Reads a single Step that is related to this Distribution. |
distributionEdge - DistributionsEdge
|
An edge for our Distribution. May be used by Relay 1. |
Arguments
|
|
Example
{
"clientMutationId": "abc123",
"distribution": Distribution,
"query": Query,
"allocationByAllocationId": Allocation,
"accountByInvestorId": Account,
"distributionStatusByStatus": DistributionStatus,
"stepByStepId": Step,
"distributionEdge": DistributionsEdge
}
MakeRoundInput
Description
All input for the makeRound mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
assetId - UUID
|
|
status - String
|
|
price - BigFloat
|
|
opensOn - Datetime
|
|
closesOn - Datetime
|
|
termsUrl - String
|
|
name - String
|
|
total - BigFloat
|
Example
{
"clientMutationId": "xyz789",
"assetId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"status": "abc123",
"price": BigFloat,
"opensOn": Datetime,
"closesOn": Datetime,
"termsUrl": "xyz789",
"name": "abc123",
"total": BigFloat
}
MakeRoundPayload
Description
The output of our makeRound mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
The exact same clientMutationId that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations. |
round - Round
|
|
query - Query
|
Our root query field type. Allows us to run any query from our mutation payload. |
assetByAssetId - Asset
|
Reads a single Asset that is related to this Round. |
tokenByTokenId - Token
|
Reads a single Token that is related to this Round. |
assetStatusByStatus - AssetStatus
|
Reads a single AssetStatus that is related to this Round. |
blockchainAddressByBlockchainAddressId - BlockchainAddress
|
Reads a single BlockchainAddress that is related to this Round. |
securityBySecurityId - Security
|
Reads a single Security that is related to this Round. |
roundEdge - RoundsEdge
|
An edge for our Round. May be used by Relay 1. |
Arguments
|
|
Example
{
"clientMutationId": "abc123",
"round": Round,
"query": Query,
"assetByAssetId": Asset,
"tokenByTokenId": Token,
"assetStatusByStatus": AssetStatus,
"blockchainAddressByBlockchainAddressId": BlockchainAddress,
"securityBySecurityId": Security,
"roundEdge": RoundsEdge
}
MakeSecurityDocumentInput
MakeShadowCustomerInput
Fields
| Input Field | Description |
|---|---|
name - String!
|
|
email - String!
|
|
clientMutationId - String
|
|
accountSetupData - ShadowSetupAccountInput
|
Example
{
"name": "xyz789",
"email": "abc123",
"clientMutationId": "xyz789",
"accountSetupData": ShadowSetupAccountInput
}
MakeShadowCustomerPayload
MakeShadowDistributionInput
Example
{
"name": "xyz789",
"accountEmail": "abc123",
"clientMutationId": "xyz789",
"allocationId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"amount": BigFloat,
"accountSetupData": ShadowSetupAccountInput
}
MakeShadowDistributionPayload
Fields
| Field Name | Description |
|---|---|
query - Query
|
|
distribution - Distribution
|
|
clientMutationId - String
|
Example
{
"query": Query,
"distribution": Distribution,
"clientMutationId": "abc123"
}
MakeTaRequestDistributionIssuanceInput
Description
All input for the makeTaRequestDistributionIssuance mutation.
Example
{
"clientMutationId": "xyz789",
"distributionId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"issuanceDate": Datetime
}
MakeTaRequestDistributionIssuancePayload
Description
The output of our makeTaRequestDistributionIssuance mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
The exact same clientMutationId that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations. |
taRequest - TaRequest
|
|
query - Query
|
Our root query field type. Allows us to run any query from our mutation payload. |
accountByVendorId - Account
|
Reads a single Account that is related to this TaRequest. |
accountByInvestorId - Account
|
Reads a single Account that is related to this TaRequest. |
taRequestTypeByType - TaRequestType
|
Reads a single TaRequestType that is related to this TaRequest. |
taRequestStatusByStatus - TaRequestStatus
|
Reads a single TaRequestStatus that is related to this TaRequest. |
taRequestBlockchainLocationByFromBlockchainAddressLocation - TaRequestBlockchainLocation
|
Reads a single TaRequestBlockchainLocation that is related to this TaRequest. |
blockchainAddressByFromBlockchainAddressId - BlockchainAddress
|
Reads a single BlockchainAddress that is related to this TaRequest. |
taRequestBlockchainLocationByToBlockchainAddressLocation - TaRequestBlockchainLocation
|
Reads a single TaRequestBlockchainLocation that is related to this TaRequest. |
blockchainAddressByToBlockchainAddressId - BlockchainAddress
|
Reads a single BlockchainAddress that is related to this TaRequest. |
accountByCreatorAccountId - Account
|
Reads a single Account that is related to this TaRequest. |
userByCreatorUserId - User
|
Reads a single User that is related to this TaRequest. |
taRequestEdge - TaRequestsEdge
|
An edge for our TaRequest. May be used by Relay 1. |
Arguments
|
|
Example
{
"clientMutationId": "xyz789",
"taRequest": TaRequest,
"query": Query,
"accountByVendorId": Account,
"accountByInvestorId": Account,
"taRequestTypeByType": TaRequestType,
"taRequestStatusByStatus": TaRequestStatus,
"taRequestBlockchainLocationByFromBlockchainAddressLocation": TaRequestBlockchainLocation,
"blockchainAddressByFromBlockchainAddressId": BlockchainAddress,
"taRequestBlockchainLocationByToBlockchainAddressLocation": TaRequestBlockchainLocation,
"blockchainAddressByToBlockchainAddressId": BlockchainAddress,
"accountByCreatorAccountId": Account,
"userByCreatorUserId": User,
"taRequestEdge": TaRequestsEdge
}
MakeTaRequestDistributionIssuancesInput
Description
All input for the makeTaRequestDistributionIssuances mutation.
Example
{
"clientMutationId": "xyz789",
"distributionIds": [
"429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
]
}
MakeTaRequestDistributionIssuancesPayload
Description
The output of our makeTaRequestDistributionIssuances mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
The exact same clientMutationId that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations. |
taRequests - [TaRequest]
|
|
query - Query
|
Our root query field type. Allows us to run any query from our mutation payload. |
Example
{
"clientMutationId": "xyz789",
"taRequests": [TaRequest],
"query": Query
}
MakeTaRequestIssuanceInput
Description
All input for the makeTaRequestIssuance mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
securityId - UUID!
|
|
toAccountId - UUID!
|
|
amount - BigFloat!
|
|
issuanceDate - Datetime!
|
|
costBasis - BigFloat!
|
Example
{
"clientMutationId": "xyz789",
"securityId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"toAccountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"amount": BigFloat,
"issuanceDate": Datetime,
"costBasis": BigFloat
}
MakeTaRequestIssuancePayload
Description
The output of our makeTaRequestIssuance mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
The exact same clientMutationId that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations. |
taRequest - TaRequest
|
|
query - Query
|
Our root query field type. Allows us to run any query from our mutation payload. |
accountByVendorId - Account
|
Reads a single Account that is related to this TaRequest. |
accountByInvestorId - Account
|
Reads a single Account that is related to this TaRequest. |
taRequestTypeByType - TaRequestType
|
Reads a single TaRequestType that is related to this TaRequest. |
taRequestStatusByStatus - TaRequestStatus
|
Reads a single TaRequestStatus that is related to this TaRequest. |
taRequestBlockchainLocationByFromBlockchainAddressLocation - TaRequestBlockchainLocation
|
Reads a single TaRequestBlockchainLocation that is related to this TaRequest. |
blockchainAddressByFromBlockchainAddressId - BlockchainAddress
|
Reads a single BlockchainAddress that is related to this TaRequest. |
taRequestBlockchainLocationByToBlockchainAddressLocation - TaRequestBlockchainLocation
|
Reads a single TaRequestBlockchainLocation that is related to this TaRequest. |
blockchainAddressByToBlockchainAddressId - BlockchainAddress
|
Reads a single BlockchainAddress that is related to this TaRequest. |
accountByCreatorAccountId - Account
|
Reads a single Account that is related to this TaRequest. |
userByCreatorUserId - User
|
Reads a single User that is related to this TaRequest. |
taRequestEdge - TaRequestsEdge
|
An edge for our TaRequest. May be used by Relay 1. |
Arguments
|
|
Example
{
"clientMutationId": "xyz789",
"taRequest": TaRequest,
"query": Query,
"accountByVendorId": Account,
"accountByInvestorId": Account,
"taRequestTypeByType": TaRequestType,
"taRequestStatusByStatus": TaRequestStatus,
"taRequestBlockchainLocationByFromBlockchainAddressLocation": TaRequestBlockchainLocation,
"blockchainAddressByFromBlockchainAddressId": BlockchainAddress,
"taRequestBlockchainLocationByToBlockchainAddressLocation": TaRequestBlockchainLocation,
"blockchainAddressByToBlockchainAddressId": BlockchainAddress,
"accountByCreatorAccountId": Account,
"userByCreatorUserId": User,
"taRequestEdge": TaRequestsEdge
}
MakeTokenInput
Description
All input for the makeToken mutation.
Example
{
"clientMutationId": "abc123",
"_tokenId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"_chain": "abc123",
"_name": "abc123",
"_symbol": "abc123",
"_contractAddressId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
MakeTokenPayload
Description
The output of our makeToken mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
The exact same clientMutationId that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations. |
token - Token
|
|
query - Query
|
Our root query field type. Allows us to run any query from our mutation payload. |
tokenStatusByStatus - TokenStatus
|
Reads a single TokenStatus that is related to this Token. |
tokenTypeByType - TokenType
|
Reads a single TokenType that is related to this Token. |
tokenEdge - TokensEdge
|
An edge for our Token. May be used by Relay 1. |
Arguments
|
|
Example
{
"clientMutationId": "xyz789",
"token": Token,
"query": Query,
"tokenStatusByStatus": TokenStatus,
"tokenTypeByType": TokenType,
"tokenEdge": TokensEdge
}
MakeTrancheInput
Description
All input for the makeTranche mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
assetId - UUID
|
|
status - String
|
|
price - BigFloat
|
|
opensOn - Datetime
|
|
closesOn - Datetime
|
|
termsUrl - String
|
|
name - String
|
|
total - BigFloat
|
|
term - BigFloat
|
|
coupon - BigFloat
|
Example
{
"clientMutationId": "abc123",
"assetId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"status": "abc123",
"price": BigFloat,
"opensOn": Datetime,
"closesOn": Datetime,
"termsUrl": "abc123",
"name": "xyz789",
"total": BigFloat,
"term": BigFloat,
"coupon": BigFloat
}
MakeTranchePayload
Description
The output of our makeTranche mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
The exact same clientMutationId that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations. |
round - Round
|
|
query - Query
|
Our root query field type. Allows us to run any query from our mutation payload. |
assetByAssetId - Asset
|
Reads a single Asset that is related to this Round. |
tokenByTokenId - Token
|
Reads a single Token that is related to this Round. |
assetStatusByStatus - AssetStatus
|
Reads a single AssetStatus that is related to this Round. |
blockchainAddressByBlockchainAddressId - BlockchainAddress
|
Reads a single BlockchainAddress that is related to this Round. |
securityBySecurityId - Security
|
Reads a single Security that is related to this Round. |
roundEdge - RoundsEdge
|
An edge for our Round. May be used by Relay 1. |
Arguments
|
|
Example
{
"clientMutationId": "xyz789",
"round": Round,
"query": Query,
"assetByAssetId": Asset,
"tokenByTokenId": Token,
"assetStatusByStatus": AssetStatus,
"blockchainAddressByBlockchainAddressId": BlockchainAddress,
"securityBySecurityId": Security,
"roundEdge": RoundsEdge
}
ManagedAccount
Fields
| Field Name | Description |
|---|---|
nodeId - ID!
|
A globally unique identifier. Can be used in various places throughout the system to identify this single value. |
managerId - UUID!
|
|
entityId - UUID!
|
|
createdBy - UUID!
|
|
createdOn - Datetime!
|
|
id - UUID!
|
|
accountByManagerId - Account
|
Reads a single Account that is related to this ManagedAccount. |
accountByEntityId - Account
|
Reads a single Account that is related to this ManagedAccount. |
userByCreatedBy - User
|
Reads a single User that is related to this ManagedAccount. |
Example
{
"nodeId": "4",
"managerId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"entityId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"createdBy": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"createdOn": Datetime,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountByManagerId": Account,
"accountByEntityId": Account,
"userByCreatedBy": User
}
ManagedAccountCondition
Description
A condition to be used against ManagedAccount object types. All fields are tested for equality and combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
managerId - UUID
|
Checks for equality with the object’s managerId field. |
entityId - UUID
|
Checks for equality with the object’s entityId field. |
createdBy - UUID
|
Checks for equality with the object’s createdBy field. |
createdOn - Datetime
|
Checks for equality with the object’s createdOn field. |
id - UUID
|
Checks for equality with the object’s id field. |
Example
{
"managerId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"entityId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"createdBy": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"createdOn": Datetime,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
ManagedAccountFilter
Description
A filter to be used against ManagedAccount object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
managerId - UUIDFilter
|
Filter by the object’s managerId field. |
entityId - UUIDFilter
|
Filter by the object’s entityId field. |
createdBy - UUIDFilter
|
Filter by the object’s createdBy field. |
createdOn - DatetimeFilter
|
Filter by the object’s createdOn field. |
id - UUIDFilter
|
Filter by the object’s id field. |
accountByManagerId - AccountFilter
|
Filter by the object’s accountByManagerId relation. |
accountByEntityId - AccountFilter
|
Filter by the object’s accountByEntityId relation. |
userByCreatedBy - UserFilter
|
Filter by the object’s userByCreatedBy relation. |
and - [ManagedAccountFilter!]
|
Checks for all expressions in this list. |
or - [ManagedAccountFilter!]
|
Checks for any expressions in this list. |
not - ManagedAccountFilter
|
Negates the expression. |
Example
{
"managerId": UUIDFilter,
"entityId": UUIDFilter,
"createdBy": UUIDFilter,
"createdOn": DatetimeFilter,
"id": UUIDFilter,
"accountByManagerId": AccountFilter,
"accountByEntityId": AccountFilter,
"userByCreatedBy": UserFilter,
"and": [ManagedAccountFilter],
"or": [ManagedAccountFilter],
"not": ManagedAccountFilter
}
ManagedAccountsConnection
Description
A connection to a list of ManagedAccount values.
Fields
| Field Name | Description |
|---|---|
nodes - [ManagedAccount]!
|
A list of ManagedAccount objects. |
edges - [ManagedAccountsEdge!]!
|
A list of edges which contains the ManagedAccount and cursor to aid in pagination. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The count of all ManagedAccount you could get from the connection. |
Example
{
"nodes": [ManagedAccount],
"edges": [ManagedAccountsEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
ManagedAccountsEdge
Description
A ManagedAccount edge in the connection.
Fields
| Field Name | Description |
|---|---|
cursor - Cursor
|
A cursor for use in pagination. |
node - ManagedAccount
|
The ManagedAccount at the end of the edge. |
Example
{
"cursor": Cursor,
"node": ManagedAccount
}
ManagedAccountsOrderBy
Description
Methods to use when ordering ManagedAccount.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NATURAL"
MappedSigningTemplate
Fields
| Field Name | Description |
|---|---|
nodeId - ID!
|
A globally unique identifier. Can be used in various places throughout the system to identify this single value. |
id - UUID!
|
|
accountId - UUID!
|
|
signingTemplateId - UUID!
|
|
stepId - UUID!
|
|
vendorQualificationId - UUID
|
|
name - String!
|
|
templateCopyOn - Datetime
|
|
templateUpdatedOn - Datetime
|
|
deleted - Boolean!
|
|
locked - Boolean!
|
|
active - Boolean!
|
|
templateUri - String
|
|
qualificationStepType - String!
|
|
accountByAccountId - Account
|
Reads a single Account that is related to this MappedSigningTemplate. |
signingTemplateBySigningTemplateId - SigningTemplate
|
Reads a single SigningTemplate that is related to this MappedSigningTemplate. |
stepByStepId - Step
|
Reads a single Step that is related to this MappedSigningTemplate. |
vendorQualificationByVendorQualificationId - VendorQualification
|
Reads a single VendorQualification that is related to this MappedSigningTemplate. |
signingStepTypeByQualificationStepType - SigningStepType
|
Reads a single SigningStepType that is related to this MappedSigningTemplate. |
signingRolesByMappedSigningTemplateId - SigningRolesConnection!
|
Reads and enables pagination through a set of SigningRole. |
Arguments
|
|
signingDocumentsByMappedSigningTemplateId - SigningDocumentsConnection!
|
Reads and enables pagination through a set of SigningDocument. |
Arguments
|
|
signingFieldsByMappedSigningTemplateId - SigningFieldsConnection!
|
Reads and enables pagination through a set of SigningField. |
Arguments
|
|
sentSigningDocumentsByMappedSigningTemplateId - SentSigningDocumentsConnection!
|
Reads and enables pagination through a set of SentSigningDocument. |
Arguments
|
|
instancedMappingFieldsByMappedSigningTemplateId - InstancedMappingFieldsConnection!
|
Reads and enables pagination through a set of InstancedMappingField. |
Arguments
|
|
mappedSigningTemplateQuestionSetsByMappedSigningTemplateId - MappedSigningTemplateQuestionSetsConnection!
|
Reads and enables pagination through a set of MappedSigningTemplateQuestionSet. |
Arguments
|
|
mappingFields - MappingFieldsConnection!
|
Reads and enables pagination through a set of MappingField. |
Arguments
|
|
Example
{
"nodeId": "4",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"signingTemplateId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"stepId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"vendorQualificationId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"name": "xyz789",
"templateCopyOn": Datetime,
"templateUpdatedOn": Datetime,
"deleted": false,
"locked": true,
"active": true,
"templateUri": "xyz789",
"qualificationStepType": "abc123",
"accountByAccountId": Account,
"signingTemplateBySigningTemplateId": SigningTemplate,
"stepByStepId": Step,
"vendorQualificationByVendorQualificationId": VendorQualification,
"signingStepTypeByQualificationStepType": SigningStepType,
"signingRolesByMappedSigningTemplateId": SigningRolesConnection,
"signingDocumentsByMappedSigningTemplateId": SigningDocumentsConnection,
"signingFieldsByMappedSigningTemplateId": SigningFieldsConnection,
"sentSigningDocumentsByMappedSigningTemplateId": SentSigningDocumentsConnection,
"instancedMappingFieldsByMappedSigningTemplateId": InstancedMappingFieldsConnection,
"mappedSigningTemplateQuestionSetsByMappedSigningTemplateId": MappedSigningTemplateQuestionSetsConnection,
"mappingFields": MappingFieldsConnection
}
MappedSigningTemplateCondition
Description
A condition to be used against MappedSigningTemplate object types. All fields are tested for equality and combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
id - UUID
|
Checks for equality with the object’s id field. |
accountId - UUID
|
Checks for equality with the object’s accountId field. |
signingTemplateId - UUID
|
Checks for equality with the object’s signingTemplateId field. |
stepId - UUID
|
Checks for equality with the object’s stepId field. |
vendorQualificationId - UUID
|
Checks for equality with the object’s vendorQualificationId field. |
name - String
|
Checks for equality with the object’s name field. |
templateCopyOn - Datetime
|
Checks for equality with the object’s templateCopyOn field. |
templateUpdatedOn - Datetime
|
Checks for equality with the object’s templateUpdatedOn field. |
deleted - Boolean
|
Checks for equality with the object’s deleted field. |
locked - Boolean
|
Checks for equality with the object’s locked field. |
active - Boolean
|
Checks for equality with the object’s active field. |
templateUri - String
|
Checks for equality with the object’s templateUri field. |
qualificationStepType - String
|
Checks for equality with the object’s qualificationStepType field. |
Example
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"signingTemplateId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"stepId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"vendorQualificationId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"name": "abc123",
"templateCopyOn": Datetime,
"templateUpdatedOn": Datetime,
"deleted": false,
"locked": false,
"active": true,
"templateUri": "abc123",
"qualificationStepType": "xyz789"
}
MappedSigningTemplateFilter
Description
A filter to be used against MappedSigningTemplate object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
id - UUIDFilter
|
Filter by the object’s id field. |
accountId - UUIDFilter
|
Filter by the object’s accountId field. |
signingTemplateId - UUIDFilter
|
Filter by the object’s signingTemplateId field. |
stepId - UUIDFilter
|
Filter by the object’s stepId field. |
vendorQualificationId - UUIDFilter
|
Filter by the object’s vendorQualificationId field. |
name - StringFilter
|
Filter by the object’s name field. |
templateCopyOn - DatetimeFilter
|
Filter by the object’s templateCopyOn field. |
templateUpdatedOn - DatetimeFilter
|
Filter by the object’s templateUpdatedOn field. |
deleted - BooleanFilter
|
Filter by the object’s deleted field. |
locked - BooleanFilter
|
Filter by the object’s locked field. |
active - BooleanFilter
|
Filter by the object’s active field. |
templateUri - StringFilter
|
Filter by the object’s templateUri field. |
qualificationStepType - StringFilter
|
Filter by the object’s qualificationStepType field. |
signingRolesByMappedSigningTemplateId - MappedSigningTemplateToManySigningRoleFilter
|
Filter by the object’s signingRolesByMappedSigningTemplateId relation. |
signingRolesByMappedSigningTemplateIdExist - Boolean
|
Some related signingRolesByMappedSigningTemplateId exist. |
signingDocumentsByMappedSigningTemplateId - MappedSigningTemplateToManySigningDocumentFilter
|
Filter by the object’s signingDocumentsByMappedSigningTemplateId relation. |
signingDocumentsByMappedSigningTemplateIdExist - Boolean
|
Some related signingDocumentsByMappedSigningTemplateId exist. |
signingFieldsByMappedSigningTemplateId - MappedSigningTemplateToManySigningFieldFilter
|
Filter by the object’s signingFieldsByMappedSigningTemplateId relation. |
signingFieldsByMappedSigningTemplateIdExist - Boolean
|
Some related signingFieldsByMappedSigningTemplateId exist. |
sentSigningDocumentsByMappedSigningTemplateId - MappedSigningTemplateToManySentSigningDocumentFilter
|
Filter by the object’s sentSigningDocumentsByMappedSigningTemplateId relation. |
sentSigningDocumentsByMappedSigningTemplateIdExist - Boolean
|
Some related sentSigningDocumentsByMappedSigningTemplateId exist. |
instancedMappingFieldsByMappedSigningTemplateId - MappedSigningTemplateToManyInstancedMappingFieldFilter
|
Filter by the object’s instancedMappingFieldsByMappedSigningTemplateId relation. |
instancedMappingFieldsByMappedSigningTemplateIdExist - Boolean
|
Some related instancedMappingFieldsByMappedSigningTemplateId exist. |
mappedSigningTemplateQuestionSetsByMappedSigningTemplateId - MappedSigningTemplateToManyMappedSigningTemplateQuestionSetFilter
|
Filter by the object’s mappedSigningTemplateQuestionSetsByMappedSigningTemplateId relation. |
mappedSigningTemplateQuestionSetsByMappedSigningTemplateIdExist - Boolean
|
Some related mappedSigningTemplateQuestionSetsByMappedSigningTemplateId exist. |
accountByAccountId - AccountFilter
|
Filter by the object’s accountByAccountId relation. |
signingTemplateBySigningTemplateId - SigningTemplateFilter
|
Filter by the object’s signingTemplateBySigningTemplateId relation. |
stepByStepId - StepFilter
|
Filter by the object’s stepByStepId relation. |
vendorQualificationByVendorQualificationId - VendorQualificationFilter
|
Filter by the object’s vendorQualificationByVendorQualificationId relation. |
vendorQualificationByVendorQualificationIdExists - Boolean
|
A related vendorQualificationByVendorQualificationId exists. |
signingStepTypeByQualificationStepType - SigningStepTypeFilter
|
Filter by the object’s signingStepTypeByQualificationStepType relation. |
and - [MappedSigningTemplateFilter!]
|
Checks for all expressions in this list. |
or - [MappedSigningTemplateFilter!]
|
Checks for any expressions in this list. |
not - MappedSigningTemplateFilter
|
Negates the expression. |
Example
{
"id": UUIDFilter,
"accountId": UUIDFilter,
"signingTemplateId": UUIDFilter,
"stepId": UUIDFilter,
"vendorQualificationId": UUIDFilter,
"name": StringFilter,
"templateCopyOn": DatetimeFilter,
"templateUpdatedOn": DatetimeFilter,
"deleted": BooleanFilter,
"locked": BooleanFilter,
"active": BooleanFilter,
"templateUri": StringFilter,
"qualificationStepType": StringFilter,
"signingRolesByMappedSigningTemplateId": MappedSigningTemplateToManySigningRoleFilter,
"signingRolesByMappedSigningTemplateIdExist": false,
"signingDocumentsByMappedSigningTemplateId": MappedSigningTemplateToManySigningDocumentFilter,
"signingDocumentsByMappedSigningTemplateIdExist": true,
"signingFieldsByMappedSigningTemplateId": MappedSigningTemplateToManySigningFieldFilter,
"signingFieldsByMappedSigningTemplateIdExist": true,
"sentSigningDocumentsByMappedSigningTemplateId": MappedSigningTemplateToManySentSigningDocumentFilter,
"sentSigningDocumentsByMappedSigningTemplateIdExist": false,
"instancedMappingFieldsByMappedSigningTemplateId": MappedSigningTemplateToManyInstancedMappingFieldFilter,
"instancedMappingFieldsByMappedSigningTemplateIdExist": true,
"mappedSigningTemplateQuestionSetsByMappedSigningTemplateId": MappedSigningTemplateToManyMappedSigningTemplateQuestionSetFilter,
"mappedSigningTemplateQuestionSetsByMappedSigningTemplateIdExist": false,
"accountByAccountId": AccountFilter,
"signingTemplateBySigningTemplateId": SigningTemplateFilter,
"stepByStepId": StepFilter,
"vendorQualificationByVendorQualificationId": VendorQualificationFilter,
"vendorQualificationByVendorQualificationIdExists": true,
"signingStepTypeByQualificationStepType": SigningStepTypeFilter,
"and": [MappedSigningTemplateFilter],
"or": [MappedSigningTemplateFilter],
"not": MappedSigningTemplateFilter
}
MappedSigningTemplateInput
Description
An input for mutations affecting MappedSigningTemplate
Fields
| Input Field | Description |
|---|---|
id - UUID
|
|
accountId - UUID
|
|
signingTemplateId - UUID!
|
|
stepId - UUID
|
|
vendorQualificationId - UUID
|
|
name - String!
|
|
templateCopyOn - Datetime
|
|
templateUpdatedOn - Datetime
|
|
deleted - Boolean
|
|
locked - Boolean
|
|
active - Boolean
|
|
templateUri - String
|
|
qualificationStepType - String
|
Example
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"signingTemplateId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"stepId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"vendorQualificationId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"name": "xyz789",
"templateCopyOn": Datetime,
"templateUpdatedOn": Datetime,
"deleted": false,
"locked": true,
"active": true,
"templateUri": "xyz789",
"qualificationStepType": "xyz789"
}
MappedSigningTemplatePatch
Description
Represents an update to a MappedSigningTemplate. Fields that are set will be updated.
Example
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"signingTemplateId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"stepId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"vendorQualificationId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"name": "xyz789",
"templateCopyOn": Datetime,
"templateUpdatedOn": Datetime,
"deleted": false,
"locked": false,
"active": true,
"templateUri": "xyz789",
"qualificationStepType": "xyz789"
}
MappedSigningTemplateQuestionSet
Fields
| Field Name | Description |
|---|---|
nodeId - ID!
|
A globally unique identifier. Can be used in various places throughout the system to identify this single value. |
id - UUID!
|
|
onboardingQuestionSetId - UUID!
|
|
mappedSigningTemplateId - UUID!
|
|
onboardingQuestionSetByOnboardingQuestionSetId - OnboardingQuestionSet
|
Reads a single OnboardingQuestionSet that is related to this MappedSigningTemplateQuestionSet. |
mappedSigningTemplateByMappedSigningTemplateId - MappedSigningTemplate
|
Reads a single MappedSigningTemplate that is related to this MappedSigningTemplateQuestionSet. |
Example
{
"nodeId": "4",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"onboardingQuestionSetId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"mappedSigningTemplateId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"onboardingQuestionSetByOnboardingQuestionSetId": OnboardingQuestionSet,
"mappedSigningTemplateByMappedSigningTemplateId": MappedSigningTemplate
}
MappedSigningTemplateQuestionSetCondition
Description
A condition to be used against MappedSigningTemplateQuestionSet object types. All fields are tested for equality and combined with a logical ‘and.’
Example
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"onboardingQuestionSetId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"mappedSigningTemplateId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
MappedSigningTemplateQuestionSetFilter
Description
A filter to be used against MappedSigningTemplateQuestionSet object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
id - UUIDFilter
|
Filter by the object’s id field. |
onboardingQuestionSetId - UUIDFilter
|
Filter by the object’s onboardingQuestionSetId field. |
mappedSigningTemplateId - UUIDFilter
|
Filter by the object’s mappedSigningTemplateId field. |
onboardingQuestionSetByOnboardingQuestionSetId - OnboardingQuestionSetFilter
|
Filter by the object’s onboardingQuestionSetByOnboardingQuestionSetId relation. |
mappedSigningTemplateByMappedSigningTemplateId - MappedSigningTemplateFilter
|
Filter by the object’s mappedSigningTemplateByMappedSigningTemplateId relation. |
and - [MappedSigningTemplateQuestionSetFilter!]
|
Checks for all expressions in this list. |
or - [MappedSigningTemplateQuestionSetFilter!]
|
Checks for any expressions in this list. |
not - MappedSigningTemplateQuestionSetFilter
|
Negates the expression. |
Example
{
"id": UUIDFilter,
"onboardingQuestionSetId": UUIDFilter,
"mappedSigningTemplateId": UUIDFilter,
"onboardingQuestionSetByOnboardingQuestionSetId": OnboardingQuestionSetFilter,
"mappedSigningTemplateByMappedSigningTemplateId": MappedSigningTemplateFilter,
"and": [MappedSigningTemplateQuestionSetFilter],
"or": [MappedSigningTemplateQuestionSetFilter],
"not": MappedSigningTemplateQuestionSetFilter
}
MappedSigningTemplateQuestionSetInput
Description
An input for mutations affecting MappedSigningTemplateQuestionSet
Example
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"onboardingQuestionSetId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"mappedSigningTemplateId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
MappedSigningTemplateQuestionSetPatch
Description
Represents an update to a MappedSigningTemplateQuestionSet. Fields that are set will be updated.
Example
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"onboardingQuestionSetId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"mappedSigningTemplateId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
MappedSigningTemplateQuestionSetsConnection
Description
A connection to a list of MappedSigningTemplateQuestionSet values.
Fields
| Field Name | Description |
|---|---|
nodes - [MappedSigningTemplateQuestionSet]!
|
A list of MappedSigningTemplateQuestionSet objects. |
edges - [MappedSigningTemplateQuestionSetsEdge!]!
|
A list of edges which contains the MappedSigningTemplateQuestionSet and cursor to aid in pagination. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The count of all MappedSigningTemplateQuestionSet you could get from the connection. |
Example
{
"nodes": [MappedSigningTemplateQuestionSet],
"edges": [MappedSigningTemplateQuestionSetsEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
MappedSigningTemplateQuestionSetsEdge
Description
A MappedSigningTemplateQuestionSet edge in the connection.
Fields
| Field Name | Description |
|---|---|
cursor - Cursor
|
A cursor for use in pagination. |
node - MappedSigningTemplateQuestionSet
|
The MappedSigningTemplateQuestionSet at the end of the edge. |
Example
{
"cursor": Cursor,
"node": MappedSigningTemplateQuestionSet
}
MappedSigningTemplateQuestionSetsOrderBy
Description
Methods to use when ordering MappedSigningTemplateQuestionSet.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NATURAL"
MappedSigningTemplateToManyInstancedMappingFieldFilter
Description
A filter to be used against many InstancedMappingField object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - InstancedMappingFieldFilter
|
Every related InstancedMappingField matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - InstancedMappingFieldFilter
|
Some related InstancedMappingField matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - InstancedMappingFieldFilter
|
No related InstancedMappingField matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": InstancedMappingFieldFilter,
"some": InstancedMappingFieldFilter,
"none": InstancedMappingFieldFilter
}
MappedSigningTemplateToManyMappedSigningTemplateQuestionSetFilter
Description
A filter to be used against many MappedSigningTemplateQuestionSet object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - MappedSigningTemplateQuestionSetFilter
|
Every related MappedSigningTemplateQuestionSet matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - MappedSigningTemplateQuestionSetFilter
|
Some related MappedSigningTemplateQuestionSet matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - MappedSigningTemplateQuestionSetFilter
|
No related MappedSigningTemplateQuestionSet matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": MappedSigningTemplateQuestionSetFilter,
"some": MappedSigningTemplateQuestionSetFilter,
"none": MappedSigningTemplateQuestionSetFilter
}
MappedSigningTemplateToManySentSigningDocumentFilter
Description
A filter to be used against many SentSigningDocument object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - SentSigningDocumentFilter
|
Every related SentSigningDocument matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - SentSigningDocumentFilter
|
Some related SentSigningDocument matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - SentSigningDocumentFilter
|
No related SentSigningDocument matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": SentSigningDocumentFilter,
"some": SentSigningDocumentFilter,
"none": SentSigningDocumentFilter
}
MappedSigningTemplateToManySigningDocumentFilter
Description
A filter to be used against many SigningDocument object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - SigningDocumentFilter
|
Every related SigningDocument matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - SigningDocumentFilter
|
Some related SigningDocument matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - SigningDocumentFilter
|
No related SigningDocument matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": SigningDocumentFilter,
"some": SigningDocumentFilter,
"none": SigningDocumentFilter
}
MappedSigningTemplateToManySigningFieldFilter
Description
A filter to be used against many SigningField object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - SigningFieldFilter
|
Every related SigningField matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - SigningFieldFilter
|
Some related SigningField matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - SigningFieldFilter
|
No related SigningField matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": SigningFieldFilter,
"some": SigningFieldFilter,
"none": SigningFieldFilter
}
MappedSigningTemplateToManySigningRoleFilter
Description
A filter to be used against many SigningRole object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - SigningRoleFilter
|
Every related SigningRole matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - SigningRoleFilter
|
Some related SigningRole matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - SigningRoleFilter
|
No related SigningRole matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": SigningRoleFilter,
"some": SigningRoleFilter,
"none": SigningRoleFilter
}
MappedSigningTemplatesConnection
Description
A connection to a list of MappedSigningTemplate values.
Fields
| Field Name | Description |
|---|---|
nodes - [MappedSigningTemplate]!
|
A list of MappedSigningTemplate objects. |
edges - [MappedSigningTemplatesEdge!]!
|
A list of edges which contains the MappedSigningTemplate and cursor to aid in pagination. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The count of all MappedSigningTemplate you could get from the connection. |
Example
{
"nodes": [MappedSigningTemplate],
"edges": [MappedSigningTemplatesEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
MappedSigningTemplatesEdge
Description
A MappedSigningTemplate edge in the connection.
Fields
| Field Name | Description |
|---|---|
cursor - Cursor
|
A cursor for use in pagination. |
node - MappedSigningTemplate
|
The MappedSigningTemplate at the end of the edge. |
Example
{
"cursor": Cursor,
"node": MappedSigningTemplate
}
MappedSigningTemplatesOrderBy
Description
Methods to use when ordering MappedSigningTemplate.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NATURAL"
MappingField
MappingFieldFilter
Description
A filter to be used against MappingField object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
id - UUIDFilter
|
Filter by the object’s id field. |
field - StringFilter
|
Filter by the object’s field field. |
description - StringFilter
|
Filter by the object’s description field. |
and - [MappingFieldFilter!]
|
Checks for all expressions in this list. |
or - [MappingFieldFilter!]
|
Checks for any expressions in this list. |
not - MappingFieldFilter
|
Negates the expression. |
Example
{
"id": UUIDFilter,
"field": StringFilter,
"description": StringFilter,
"and": [MappingFieldFilter],
"or": [MappingFieldFilter],
"not": MappingFieldFilter
}
MappingFieldsConnection
Description
A connection to a list of MappingField values.
Fields
| Field Name | Description |
|---|---|
nodes - [MappingField]!
|
A list of MappingField objects. |
edges - [MappingFieldsEdge!]!
|
A list of edges which contains the MappingField and cursor to aid in pagination. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The count of all MappingField you could get from the connection. |
Example
{
"nodes": [MappingField],
"edges": [MappingFieldsEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
MappingFieldsEdge
Description
A MappingField edge in the connection.
Fields
| Field Name | Description |
|---|---|
cursor - Cursor
|
A cursor for use in pagination. |
node - MappingField
|
The MappingField at the end of the edge. |
Example
{
"cursor": Cursor,
"node": MappingField
}
MappingRole
Fields
| Field Name | Description |
|---|---|
nodeId - ID!
|
A globally unique identifier. Can be used in various places throughout the system to identify this single value. |
id - String!
|
|
description - String!
|
|
signingRolesByMapTo - SigningRolesConnection!
|
Reads and enables pagination through a set of SigningRole. |
Arguments
|
|
Example
{
"nodeId": "4",
"id": "xyz789",
"description": "abc123",
"signingRolesByMapTo": SigningRolesConnection
}
MappingRoleCondition
Description
A condition to be used against MappingRole object types. All fields are tested for equality and combined with a logical ‘and.’
Example
{
"id": "abc123",
"description": "xyz789"
}
MappingRoleFilter
Description
A filter to be used against MappingRole object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
id - StringFilter
|
Filter by the object’s id field. |
description - StringFilter
|
Filter by the object’s description field. |
signingRolesByMapTo - MappingRoleToManySigningRoleFilter
|
Filter by the object’s signingRolesByMapTo relation. |
signingRolesByMapToExist - Boolean
|
Some related signingRolesByMapTo exist. |
and - [MappingRoleFilter!]
|
Checks for all expressions in this list. |
or - [MappingRoleFilter!]
|
Checks for any expressions in this list. |
not - MappingRoleFilter
|
Negates the expression. |
Example
{
"id": StringFilter,
"description": StringFilter,
"signingRolesByMapTo": MappingRoleToManySigningRoleFilter,
"signingRolesByMapToExist": false,
"and": [MappingRoleFilter],
"or": [MappingRoleFilter],
"not": MappingRoleFilter
}
MappingRoleToManySigningRoleFilter
Description
A filter to be used against many SigningRole object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - SigningRoleFilter
|
Every related SigningRole matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - SigningRoleFilter
|
Some related SigningRole matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - SigningRoleFilter
|
No related SigningRole matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": SigningRoleFilter,
"some": SigningRoleFilter,
"none": SigningRoleFilter
}
MappingRoleType
Fields
| Field Name | Description |
|---|---|
nodeId - ID!
|
A globally unique identifier. Can be used in various places throughout the system to identify this single value. |
type - String!
|
|
signingRolesByType - SigningRolesConnection!
|
Reads and enables pagination through a set of SigningRole. |
Arguments
|
|
Example
{
"nodeId": 4,
"type": "xyz789",
"signingRolesByType": SigningRolesConnection
}
MappingRoleTypeCondition
Description
A condition to be used against MappingRoleType object types. All fields are tested for equality and combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
type - String
|
Checks for equality with the object’s type field. |
Example
{"type": "abc123"}
MappingRoleTypeFilter
Description
A filter to be used against MappingRoleType object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
type - StringFilter
|
Filter by the object’s type field. |
signingRolesByType - MappingRoleTypeToManySigningRoleFilter
|
Filter by the object’s signingRolesByType relation. |
signingRolesByTypeExist - Boolean
|
Some related signingRolesByType exist. |
and - [MappingRoleTypeFilter!]
|
Checks for all expressions in this list. |
or - [MappingRoleTypeFilter!]
|
Checks for any expressions in this list. |
not - MappingRoleTypeFilter
|
Negates the expression. |
Example
{
"type": StringFilter,
"signingRolesByType": MappingRoleTypeToManySigningRoleFilter,
"signingRolesByTypeExist": false,
"and": [MappingRoleTypeFilter],
"or": [MappingRoleTypeFilter],
"not": MappingRoleTypeFilter
}
MappingRoleTypeToManySigningRoleFilter
Description
A filter to be used against many SigningRole object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - SigningRoleFilter
|
Every related SigningRole matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - SigningRoleFilter
|
Some related SigningRole matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - SigningRoleFilter
|
No related SigningRole matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": SigningRoleFilter,
"some": SigningRoleFilter,
"none": SigningRoleFilter
}
MappingRoleTypesConnection
Description
A connection to a list of MappingRoleType values.
Fields
| Field Name | Description |
|---|---|
nodes - [MappingRoleType]!
|
A list of MappingRoleType objects. |
edges - [MappingRoleTypesEdge!]!
|
A list of edges which contains the MappingRoleType and cursor to aid in pagination. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The count of all MappingRoleType you could get from the connection. |
Example
{
"nodes": [MappingRoleType],
"edges": [MappingRoleTypesEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
MappingRoleTypesEdge
Description
A MappingRoleType edge in the connection.
Fields
| Field Name | Description |
|---|---|
cursor - Cursor
|
A cursor for use in pagination. |
node - MappingRoleType
|
The MappingRoleType at the end of the edge. |
Example
{
"cursor": Cursor,
"node": MappingRoleType
}
MappingRoleTypesOrderBy
Description
Methods to use when ordering MappingRoleType.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NATURAL"
MappingRolesConnection
Description
A connection to a list of MappingRole values.
Fields
| Field Name | Description |
|---|---|
nodes - [MappingRole]!
|
A list of MappingRole objects. |
edges - [MappingRolesEdge!]!
|
A list of edges which contains the MappingRole and cursor to aid in pagination. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The count of all MappingRole you could get from the connection. |
Example
{
"nodes": [MappingRole],
"edges": [MappingRolesEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
MappingRolesEdge
Description
A MappingRole edge in the connection.
Fields
| Field Name | Description |
|---|---|
cursor - Cursor
|
A cursor for use in pagination. |
node - MappingRole
|
The MappingRole at the end of the edge. |
Example
{
"cursor": Cursor,
"node": MappingRole
}
MappingRolesOrderBy
Description
Methods to use when ordering MappingRole.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NATURAL"
Node
Description
An object with a globally unique ID.
Fields
| Field Name | Description |
|---|---|
nodeId - ID!
|
A globally unique identifier. Can be used in various places throughout the system to identify this single value. |
Possible Types
| Node Types |
|---|
Example
{"nodeId": 4}
OmnibusHolding
Fields
| Field Name | Description |
|---|---|
nodeId - ID!
|
A globally unique identifier. Can be used in various places throughout the system to identify this single value. |
id - UUID!
|
|
securityId - UUID!
|
|
holdingId - UUID!
|
|
accountId - UUID!
|
|
securityBySecurityId - Security
|
Reads a single Security that is related to this OmnibusHolding. |
holdingByHoldingId - Holding
|
Reads a single Holding that is related to this OmnibusHolding. |
accountByAccountId - Account
|
Reads a single Account that is related to this OmnibusHolding. |
Example
{
"nodeId": 4,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"securityId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"holdingId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"securityBySecurityId": Security,
"holdingByHoldingId": Holding,
"accountByAccountId": Account
}
OmnibusHoldingCondition
Description
A condition to be used against OmnibusHolding object types. All fields are tested for equality and combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
id - UUID
|
Checks for equality with the object’s id field. |
securityId - UUID
|
Checks for equality with the object’s securityId field. |
holdingId - UUID
|
Checks for equality with the object’s holdingId field. |
accountId - UUID
|
Checks for equality with the object’s accountId field. |
Example
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"securityId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"holdingId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
OmnibusHoldingFilter
Description
A filter to be used against OmnibusHolding object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
id - UUIDFilter
|
Filter by the object’s id field. |
securityId - UUIDFilter
|
Filter by the object’s securityId field. |
holdingId - UUIDFilter
|
Filter by the object’s holdingId field. |
accountId - UUIDFilter
|
Filter by the object’s accountId field. |
securityBySecurityId - SecurityFilter
|
Filter by the object’s securityBySecurityId relation. |
holdingByHoldingId - HoldingFilter
|
Filter by the object’s holdingByHoldingId relation. |
accountByAccountId - AccountFilter
|
Filter by the object’s accountByAccountId relation. |
and - [OmnibusHoldingFilter!]
|
Checks for all expressions in this list. |
or - [OmnibusHoldingFilter!]
|
Checks for any expressions in this list. |
not - OmnibusHoldingFilter
|
Negates the expression. |
Example
{
"id": UUIDFilter,
"securityId": UUIDFilter,
"holdingId": UUIDFilter,
"accountId": UUIDFilter,
"securityBySecurityId": SecurityFilter,
"holdingByHoldingId": HoldingFilter,
"accountByAccountId": AccountFilter,
"and": [OmnibusHoldingFilter],
"or": [OmnibusHoldingFilter],
"not": OmnibusHoldingFilter
}
OmnibusHoldingsConnection
Description
A connection to a list of OmnibusHolding values.
Fields
| Field Name | Description |
|---|---|
nodes - [OmnibusHolding]!
|
A list of OmnibusHolding objects. |
edges - [OmnibusHoldingsEdge!]!
|
A list of edges which contains the OmnibusHolding and cursor to aid in pagination. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The count of all OmnibusHolding you could get from the connection. |
Example
{
"nodes": [OmnibusHolding],
"edges": [OmnibusHoldingsEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
OmnibusHoldingsEdge
Description
A OmnibusHolding edge in the connection.
Fields
| Field Name | Description |
|---|---|
cursor - Cursor
|
A cursor for use in pagination. |
node - OmnibusHolding
|
The OmnibusHolding at the end of the edge. |
Example
{
"cursor": Cursor,
"node": OmnibusHolding
}
OmnibusHoldingsOrderBy
Description
Methods to use when ordering OmnibusHolding.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NATURAL"
OmnibusInvestor
Fields
| Field Name | Description |
|---|---|
nodeId - ID!
|
A globally unique identifier. Can be used in various places throughout the system to identify this single value. |
id - UUID!
|
|
securityId - UUID!
|
|
investorId - UUID!
|
|
accountId - UUID!
|
|
securityBySecurityId - Security
|
Reads a single Security that is related to this OmnibusInvestor. |
accountByInvestorId - Account
|
Reads a single Account that is related to this OmnibusInvestor. |
accountByAccountId - Account
|
Reads a single Account that is related to this OmnibusInvestor. |
Example
{
"nodeId": 4,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"securityId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"investorId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"securityBySecurityId": Security,
"accountByInvestorId": Account,
"accountByAccountId": Account
}
OmnibusInvestorCondition
Description
A condition to be used against OmnibusInvestor object types. All fields are tested for equality and combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
id - UUID
|
Checks for equality with the object’s id field. |
securityId - UUID
|
Checks for equality with the object’s securityId field. |
investorId - UUID
|
Checks for equality with the object’s investorId field. |
accountId - UUID
|
Checks for equality with the object’s accountId field. |
Example
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"securityId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"investorId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
OmnibusInvestorFilter
Description
A filter to be used against OmnibusInvestor object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
id - UUIDFilter
|
Filter by the object’s id field. |
securityId - UUIDFilter
|
Filter by the object’s securityId field. |
investorId - UUIDFilter
|
Filter by the object’s investorId field. |
accountId - UUIDFilter
|
Filter by the object’s accountId field. |
securityBySecurityId - SecurityFilter
|
Filter by the object’s securityBySecurityId relation. |
accountByInvestorId - AccountFilter
|
Filter by the object’s accountByInvestorId relation. |
accountByAccountId - AccountFilter
|
Filter by the object’s accountByAccountId relation. |
and - [OmnibusInvestorFilter!]
|
Checks for all expressions in this list. |
or - [OmnibusInvestorFilter!]
|
Checks for any expressions in this list. |
not - OmnibusInvestorFilter
|
Negates the expression. |
Example
{
"id": UUIDFilter,
"securityId": UUIDFilter,
"investorId": UUIDFilter,
"accountId": UUIDFilter,
"securityBySecurityId": SecurityFilter,
"accountByInvestorId": AccountFilter,
"accountByAccountId": AccountFilter,
"and": [OmnibusInvestorFilter],
"or": [OmnibusInvestorFilter],
"not": OmnibusInvestorFilter
}
OmnibusInvestorsConnection
Description
A connection to a list of OmnibusInvestor values.
Fields
| Field Name | Description |
|---|---|
nodes - [OmnibusInvestor]!
|
A list of OmnibusInvestor objects. |
edges - [OmnibusInvestorsEdge!]!
|
A list of edges which contains the OmnibusInvestor and cursor to aid in pagination. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The count of all OmnibusInvestor you could get from the connection. |
Example
{
"nodes": [OmnibusInvestor],
"edges": [OmnibusInvestorsEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
OmnibusInvestorsEdge
Description
A OmnibusInvestor edge in the connection.
Fields
| Field Name | Description |
|---|---|
cursor - Cursor
|
A cursor for use in pagination. |
node - OmnibusInvestor
|
The OmnibusInvestor at the end of the edge. |
Example
{
"cursor": Cursor,
"node": OmnibusInvestor
}
OmnibusInvestorsOrderBy
Description
Methods to use when ordering OmnibusInvestor.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NATURAL"
OnboardingQuestion
Fields
| Field Name | Description |
|---|---|
nodeId - ID!
|
A globally unique identifier. Can be used in various places throughout the system to identify this single value. |
id - UUID!
|
|
accountId - UUID!
|
|
type - String!
|
|
name - String!
|
|
description - String!
|
|
errorMessage - String!
|
|
accountByAccountId - Account
|
Reads a single Account that is related to this OnboardingQuestion. |
onboardingQuestionTypeByType - OnboardingQuestionType
|
Reads a single OnboardingQuestionType that is related to this OnboardingQuestion. |
onboardingQuestionJoinsByOnboardingQuestionId - OnboardingQuestionJoinsConnection!
|
Reads and enables pagination through a set of OnboardingQuestionJoin. |
Arguments
|
|
instancedMappingFieldsByOnboardingQuestionId - InstancedMappingFieldsConnection!
|
Reads and enables pagination through a set of InstancedMappingField. |
Arguments
|
|
Example
{
"nodeId": "4",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"type": "xyz789",
"name": "xyz789",
"description": "abc123",
"errorMessage": "xyz789",
"accountByAccountId": Account,
"onboardingQuestionTypeByType": OnboardingQuestionType,
"onboardingQuestionJoinsByOnboardingQuestionId": OnboardingQuestionJoinsConnection,
"instancedMappingFieldsByOnboardingQuestionId": InstancedMappingFieldsConnection
}
OnboardingQuestionCondition
Description
A condition to be used against OnboardingQuestion object types. All fields are tested for equality and combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
id - UUID
|
Checks for equality with the object’s id field. |
accountId - UUID
|
Checks for equality with the object’s accountId field. |
type - String
|
Checks for equality with the object’s type field. |
name - String
|
Checks for equality with the object’s name field. |
description - String
|
Checks for equality with the object’s description field. |
errorMessage - String
|
Checks for equality with the object’s errorMessage field. |
Example
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"type": "xyz789",
"name": "xyz789",
"description": "xyz789",
"errorMessage": "xyz789"
}
OnboardingQuestionFilter
Description
A filter to be used against OnboardingQuestion object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
id - UUIDFilter
|
Filter by the object’s id field. |
accountId - UUIDFilter
|
Filter by the object’s accountId field. |
type - StringFilter
|
Filter by the object’s type field. |
name - StringFilter
|
Filter by the object’s name field. |
description - StringFilter
|
Filter by the object’s description field. |
errorMessage - StringFilter
|
Filter by the object’s errorMessage field. |
onboardingQuestionJoinsByOnboardingQuestionId - OnboardingQuestionToManyOnboardingQuestionJoinFilter
|
Filter by the object’s onboardingQuestionJoinsByOnboardingQuestionId relation. |
onboardingQuestionJoinsByOnboardingQuestionIdExist - Boolean
|
Some related onboardingQuestionJoinsByOnboardingQuestionId exist. |
instancedMappingFieldsByOnboardingQuestionId - OnboardingQuestionToManyInstancedMappingFieldFilter
|
Filter by the object’s instancedMappingFieldsByOnboardingQuestionId relation. |
instancedMappingFieldsByOnboardingQuestionIdExist - Boolean
|
Some related instancedMappingFieldsByOnboardingQuestionId exist. |
accountByAccountId - AccountFilter
|
Filter by the object’s accountByAccountId relation. |
onboardingQuestionTypeByType - OnboardingQuestionTypeFilter
|
Filter by the object’s onboardingQuestionTypeByType relation. |
and - [OnboardingQuestionFilter!]
|
Checks for all expressions in this list. |
or - [OnboardingQuestionFilter!]
|
Checks for any expressions in this list. |
not - OnboardingQuestionFilter
|
Negates the expression. |
Example
{
"id": UUIDFilter,
"accountId": UUIDFilter,
"type": StringFilter,
"name": StringFilter,
"description": StringFilter,
"errorMessage": StringFilter,
"onboardingQuestionJoinsByOnboardingQuestionId": OnboardingQuestionToManyOnboardingQuestionJoinFilter,
"onboardingQuestionJoinsByOnboardingQuestionIdExist": false,
"instancedMappingFieldsByOnboardingQuestionId": OnboardingQuestionToManyInstancedMappingFieldFilter,
"instancedMappingFieldsByOnboardingQuestionIdExist": true,
"accountByAccountId": AccountFilter,
"onboardingQuestionTypeByType": OnboardingQuestionTypeFilter,
"and": [OnboardingQuestionFilter],
"or": [OnboardingQuestionFilter],
"not": OnboardingQuestionFilter
}
OnboardingQuestionInput
Description
An input for mutations affecting OnboardingQuestion
Example
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"type": "abc123",
"name": "abc123",
"description": "abc123",
"errorMessage": "xyz789"
}
OnboardingQuestionJoin
Fields
| Field Name | Description |
|---|---|
nodeId - ID!
|
A globally unique identifier. Can be used in various places throughout the system to identify this single value. |
id - UUID!
|
|
onboardingQuestionSetId - UUID!
|
|
onboardingQuestionId - UUID!
|
|
executeOrder - Int!
|
|
onboardingQuestionSetByOnboardingQuestionSetId - OnboardingQuestionSet
|
Reads a single OnboardingQuestionSet that is related to this OnboardingQuestionJoin. |
onboardingQuestionByOnboardingQuestionId - OnboardingQuestion
|
Reads a single OnboardingQuestion that is related to this OnboardingQuestionJoin. |
Example
{
"nodeId": 4,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"onboardingQuestionSetId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"onboardingQuestionId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"executeOrder": 123,
"onboardingQuestionSetByOnboardingQuestionSetId": OnboardingQuestionSet,
"onboardingQuestionByOnboardingQuestionId": OnboardingQuestion
}
OnboardingQuestionJoinCondition
Description
A condition to be used against OnboardingQuestionJoin object types. All fields are tested for equality and combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
id - UUID
|
Checks for equality with the object’s id field. |
onboardingQuestionSetId - UUID
|
Checks for equality with the object’s onboardingQuestionSetId field. |
onboardingQuestionId - UUID
|
Checks for equality with the object’s onboardingQuestionId field. |
executeOrder - Int
|
Checks for equality with the object’s executeOrder field. |
Example
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"onboardingQuestionSetId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"onboardingQuestionId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"executeOrder": 987
}
OnboardingQuestionJoinFilter
Description
A filter to be used against OnboardingQuestionJoin object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
id - UUIDFilter
|
Filter by the object’s id field. |
onboardingQuestionSetId - UUIDFilter
|
Filter by the object’s onboardingQuestionSetId field. |
onboardingQuestionId - UUIDFilter
|
Filter by the object’s onboardingQuestionId field. |
executeOrder - IntFilter
|
Filter by the object’s executeOrder field. |
onboardingQuestionSetByOnboardingQuestionSetId - OnboardingQuestionSetFilter
|
Filter by the object’s onboardingQuestionSetByOnboardingQuestionSetId relation. |
onboardingQuestionByOnboardingQuestionId - OnboardingQuestionFilter
|
Filter by the object’s onboardingQuestionByOnboardingQuestionId relation. |
and - [OnboardingQuestionJoinFilter!]
|
Checks for all expressions in this list. |
or - [OnboardingQuestionJoinFilter!]
|
Checks for any expressions in this list. |
not - OnboardingQuestionJoinFilter
|
Negates the expression. |
Example
{
"id": UUIDFilter,
"onboardingQuestionSetId": UUIDFilter,
"onboardingQuestionId": UUIDFilter,
"executeOrder": IntFilter,
"onboardingQuestionSetByOnboardingQuestionSetId": OnboardingQuestionSetFilter,
"onboardingQuestionByOnboardingQuestionId": OnboardingQuestionFilter,
"and": [OnboardingQuestionJoinFilter],
"or": [OnboardingQuestionJoinFilter],
"not": OnboardingQuestionJoinFilter
}
OnboardingQuestionJoinInput
Description
An input for mutations affecting OnboardingQuestionJoin
Example
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"onboardingQuestionSetId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"onboardingQuestionId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"executeOrder": 123
}
OnboardingQuestionJoinsConnection
Description
A connection to a list of OnboardingQuestionJoin values.
Fields
| Field Name | Description |
|---|---|
nodes - [OnboardingQuestionJoin]!
|
A list of OnboardingQuestionJoin objects. |
edges - [OnboardingQuestionJoinsEdge!]!
|
A list of edges which contains the OnboardingQuestionJoin and cursor to aid in pagination. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The count of all OnboardingQuestionJoin you could get from the connection. |
Example
{
"nodes": [OnboardingQuestionJoin],
"edges": [OnboardingQuestionJoinsEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
OnboardingQuestionJoinsEdge
Description
A OnboardingQuestionJoin edge in the connection.
Fields
| Field Name | Description |
|---|---|
cursor - Cursor
|
A cursor for use in pagination. |
node - OnboardingQuestionJoin
|
The OnboardingQuestionJoin at the end of the edge. |
Example
{
"cursor": Cursor,
"node": OnboardingQuestionJoin
}
OnboardingQuestionJoinsOrderBy
Description
Methods to use when ordering OnboardingQuestionJoin.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NATURAL"
OnboardingQuestionPatch
Description
Represents an update to a OnboardingQuestion. Fields that are set will be updated.
Example
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"type": "abc123",
"name": "abc123",
"description": "xyz789",
"errorMessage": "abc123"
}
OnboardingQuestionSet
Fields
| Field Name | Description |
|---|---|
nodeId - ID!
|
A globally unique identifier. Can be used in various places throughout the system to identify this single value. |
id - UUID!
|
|
accountId - UUID!
|
|
name - String!
|
|
locked - Boolean!
|
|
active - Boolean
|
|
vendorQualificationId - UUID
|
|
accountByAccountId - Account
|
Reads a single Account that is related to this OnboardingQuestionSet. |
vendorQualificationByVendorQualificationId - VendorQualification
|
Reads a single VendorQualification that is related to this OnboardingQuestionSet. |
onboardingQuestionJoinsByOnboardingQuestionSetId - OnboardingQuestionJoinsConnection!
|
Reads and enables pagination through a set of OnboardingQuestionJoin. |
Arguments
|
|
mappedSigningTemplateQuestionSetsByOnboardingQuestionSetId - MappedSigningTemplateQuestionSetsConnection!
|
Reads and enables pagination through a set of MappedSigningTemplateQuestionSet. |
Arguments
|
|
Example
{
"nodeId": 4,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"name": "xyz789",
"locked": false,
"active": false,
"vendorQualificationId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountByAccountId": Account,
"vendorQualificationByVendorQualificationId": VendorQualification,
"onboardingQuestionJoinsByOnboardingQuestionSetId": OnboardingQuestionJoinsConnection,
"mappedSigningTemplateQuestionSetsByOnboardingQuestionSetId": MappedSigningTemplateQuestionSetsConnection
}
OnboardingQuestionSetCondition
Description
A condition to be used against OnboardingQuestionSet object types. All fields are tested for equality and combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
id - UUID
|
Checks for equality with the object’s id field. |
accountId - UUID
|
Checks for equality with the object’s accountId field. |
name - String
|
Checks for equality with the object’s name field. |
locked - Boolean
|
Checks for equality with the object’s locked field. |
active - Boolean
|
Checks for equality with the object’s active field. |
vendorQualificationId - UUID
|
Checks for equality with the object’s vendorQualificationId field. |
Example
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"name": "xyz789",
"locked": true,
"active": false,
"vendorQualificationId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
OnboardingQuestionSetFilter
Description
A filter to be used against OnboardingQuestionSet object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
id - UUIDFilter
|
Filter by the object’s id field. |
accountId - UUIDFilter
|
Filter by the object’s accountId field. |
name - StringFilter
|
Filter by the object’s name field. |
locked - BooleanFilter
|
Filter by the object’s locked field. |
active - BooleanFilter
|
Filter by the object’s active field. |
vendorQualificationId - UUIDFilter
|
Filter by the object’s vendorQualificationId field. |
onboardingQuestionJoinsByOnboardingQuestionSetId - OnboardingQuestionSetToManyOnboardingQuestionJoinFilter
|
Filter by the object’s onboardingQuestionJoinsByOnboardingQuestionSetId relation. |
onboardingQuestionJoinsByOnboardingQuestionSetIdExist - Boolean
|
Some related onboardingQuestionJoinsByOnboardingQuestionSetId exist. |
mappedSigningTemplateQuestionSetsByOnboardingQuestionSetId - OnboardingQuestionSetToManyMappedSigningTemplateQuestionSetFilter
|
Filter by the object’s mappedSigningTemplateQuestionSetsByOnboardingQuestionSetId relation. |
mappedSigningTemplateQuestionSetsByOnboardingQuestionSetIdExist - Boolean
|
Some related mappedSigningTemplateQuestionSetsByOnboardingQuestionSetId exist. |
accountByAccountId - AccountFilter
|
Filter by the object’s accountByAccountId relation. |
vendorQualificationByVendorQualificationId - VendorQualificationFilter
|
Filter by the object’s vendorQualificationByVendorQualificationId relation. |
vendorQualificationByVendorQualificationIdExists - Boolean
|
A related vendorQualificationByVendorQualificationId exists. |
and - [OnboardingQuestionSetFilter!]
|
Checks for all expressions in this list. |
or - [OnboardingQuestionSetFilter!]
|
Checks for any expressions in this list. |
not - OnboardingQuestionSetFilter
|
Negates the expression. |
Example
{
"id": UUIDFilter,
"accountId": UUIDFilter,
"name": StringFilter,
"locked": BooleanFilter,
"active": BooleanFilter,
"vendorQualificationId": UUIDFilter,
"onboardingQuestionJoinsByOnboardingQuestionSetId": OnboardingQuestionSetToManyOnboardingQuestionJoinFilter,
"onboardingQuestionJoinsByOnboardingQuestionSetIdExist": false,
"mappedSigningTemplateQuestionSetsByOnboardingQuestionSetId": OnboardingQuestionSetToManyMappedSigningTemplateQuestionSetFilter,
"mappedSigningTemplateQuestionSetsByOnboardingQuestionSetIdExist": true,
"accountByAccountId": AccountFilter,
"vendorQualificationByVendorQualificationId": VendorQualificationFilter,
"vendorQualificationByVendorQualificationIdExists": true,
"and": [OnboardingQuestionSetFilter],
"or": [OnboardingQuestionSetFilter],
"not": OnboardingQuestionSetFilter
}
OnboardingQuestionSetInput
Description
An input for mutations affecting OnboardingQuestionSet
Example
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"name": "xyz789",
"locked": true,
"active": false,
"vendorQualificationId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
OnboardingQuestionSetPatch
Description
Represents an update to a OnboardingQuestionSet. Fields that are set will be updated.
Example
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"name": "abc123",
"locked": false,
"active": false,
"vendorQualificationId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
OnboardingQuestionSetToManyMappedSigningTemplateQuestionSetFilter
Description
A filter to be used against many MappedSigningTemplateQuestionSet object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - MappedSigningTemplateQuestionSetFilter
|
Every related MappedSigningTemplateQuestionSet matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - MappedSigningTemplateQuestionSetFilter
|
Some related MappedSigningTemplateQuestionSet matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - MappedSigningTemplateQuestionSetFilter
|
No related MappedSigningTemplateQuestionSet matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": MappedSigningTemplateQuestionSetFilter,
"some": MappedSigningTemplateQuestionSetFilter,
"none": MappedSigningTemplateQuestionSetFilter
}
OnboardingQuestionSetToManyOnboardingQuestionJoinFilter
Description
A filter to be used against many OnboardingQuestionJoin object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - OnboardingQuestionJoinFilter
|
Every related OnboardingQuestionJoin matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - OnboardingQuestionJoinFilter
|
Some related OnboardingQuestionJoin matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - OnboardingQuestionJoinFilter
|
No related OnboardingQuestionJoin matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": OnboardingQuestionJoinFilter,
"some": OnboardingQuestionJoinFilter,
"none": OnboardingQuestionJoinFilter
}
OnboardingQuestionSetsConnection
Description
A connection to a list of OnboardingQuestionSet values.
Fields
| Field Name | Description |
|---|---|
nodes - [OnboardingQuestionSet]!
|
A list of OnboardingQuestionSet objects. |
edges - [OnboardingQuestionSetsEdge!]!
|
A list of edges which contains the OnboardingQuestionSet and cursor to aid in pagination. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The count of all OnboardingQuestionSet you could get from the connection. |
Example
{
"nodes": [OnboardingQuestionSet],
"edges": [OnboardingQuestionSetsEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
OnboardingQuestionSetsEdge
Description
A OnboardingQuestionSet edge in the connection.
Fields
| Field Name | Description |
|---|---|
cursor - Cursor
|
A cursor for use in pagination. |
node - OnboardingQuestionSet
|
The OnboardingQuestionSet at the end of the edge. |
Example
{
"cursor": Cursor,
"node": OnboardingQuestionSet
}
OnboardingQuestionSetsOrderBy
Description
Methods to use when ordering OnboardingQuestionSet.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NATURAL"
OnboardingQuestionToManyInstancedMappingFieldFilter
Description
A filter to be used against many InstancedMappingField object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - InstancedMappingFieldFilter
|
Every related InstancedMappingField matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - InstancedMappingFieldFilter
|
Some related InstancedMappingField matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - InstancedMappingFieldFilter
|
No related InstancedMappingField matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": InstancedMappingFieldFilter,
"some": InstancedMappingFieldFilter,
"none": InstancedMappingFieldFilter
}
OnboardingQuestionToManyOnboardingQuestionJoinFilter
Description
A filter to be used against many OnboardingQuestionJoin object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - OnboardingQuestionJoinFilter
|
Every related OnboardingQuestionJoin matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - OnboardingQuestionJoinFilter
|
Some related OnboardingQuestionJoin matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - OnboardingQuestionJoinFilter
|
No related OnboardingQuestionJoin matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": OnboardingQuestionJoinFilter,
"some": OnboardingQuestionJoinFilter,
"none": OnboardingQuestionJoinFilter
}
OnboardingQuestionType
Fields
| Field Name | Description |
|---|---|
nodeId - ID!
|
A globally unique identifier. Can be used in various places throughout the system to identify this single value. |
type - String!
|
|
regex - String!
|
|
internalType - String!
|
|
onboardingQuestionsByType - OnboardingQuestionsConnection!
|
Reads and enables pagination through a set of OnboardingQuestion. |
Arguments
|
|
Example
{
"nodeId": 4,
"type": "xyz789",
"regex": "abc123",
"internalType": "abc123",
"onboardingQuestionsByType": OnboardingQuestionsConnection
}
OnboardingQuestionTypeCondition
Description
A condition to be used against OnboardingQuestionType object types. All fields are tested for equality and combined with a logical ‘and.’
Example
{
"type": "abc123",
"regex": "abc123",
"internalType": "abc123"
}
OnboardingQuestionTypeFilter
Description
A filter to be used against OnboardingQuestionType object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
type - StringFilter
|
Filter by the object’s type field. |
regex - StringFilter
|
Filter by the object’s regex field. |
internalType - StringFilter
|
Filter by the object’s internalType field. |
onboardingQuestionsByType - OnboardingQuestionTypeToManyOnboardingQuestionFilter
|
Filter by the object’s onboardingQuestionsByType relation. |
onboardingQuestionsByTypeExist - Boolean
|
Some related onboardingQuestionsByType exist. |
and - [OnboardingQuestionTypeFilter!]
|
Checks for all expressions in this list. |
or - [OnboardingQuestionTypeFilter!]
|
Checks for any expressions in this list. |
not - OnboardingQuestionTypeFilter
|
Negates the expression. |
Example
{
"type": StringFilter,
"regex": StringFilter,
"internalType": StringFilter,
"onboardingQuestionsByType": OnboardingQuestionTypeToManyOnboardingQuestionFilter,
"onboardingQuestionsByTypeExist": false,
"and": [OnboardingQuestionTypeFilter],
"or": [OnboardingQuestionTypeFilter],
"not": OnboardingQuestionTypeFilter
}
OnboardingQuestionTypeToManyOnboardingQuestionFilter
Description
A filter to be used against many OnboardingQuestion object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - OnboardingQuestionFilter
|
Every related OnboardingQuestion matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - OnboardingQuestionFilter
|
Some related OnboardingQuestion matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - OnboardingQuestionFilter
|
No related OnboardingQuestion matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": OnboardingQuestionFilter,
"some": OnboardingQuestionFilter,
"none": OnboardingQuestionFilter
}
OnboardingQuestionTypesConnection
Description
A connection to a list of OnboardingQuestionType values.
Fields
| Field Name | Description |
|---|---|
nodes - [OnboardingQuestionType]!
|
A list of OnboardingQuestionType objects. |
edges - [OnboardingQuestionTypesEdge!]!
|
A list of edges which contains the OnboardingQuestionType and cursor to aid in pagination. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The count of all OnboardingQuestionType you could get from the connection. |
Example
{
"nodes": [OnboardingQuestionType],
"edges": [OnboardingQuestionTypesEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
OnboardingQuestionTypesEdge
Description
A OnboardingQuestionType edge in the connection.
Fields
| Field Name | Description |
|---|---|
cursor - Cursor
|
A cursor for use in pagination. |
node - OnboardingQuestionType
|
The OnboardingQuestionType at the end of the edge. |
Example
{
"cursor": Cursor,
"node": OnboardingQuestionType
}
OnboardingQuestionTypesOrderBy
Description
Methods to use when ordering OnboardingQuestionType.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NATURAL"
OnboardingQuestionsConnection
Description
A connection to a list of OnboardingQuestion values.
Fields
| Field Name | Description |
|---|---|
nodes - [OnboardingQuestion]!
|
A list of OnboardingQuestion objects. |
edges - [OnboardingQuestionsEdge!]!
|
A list of edges which contains the OnboardingQuestion and cursor to aid in pagination. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The count of all OnboardingQuestion you could get from the connection. |
Example
{
"nodes": [OnboardingQuestion],
"edges": [OnboardingQuestionsEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
OnboardingQuestionsEdge
Description
A OnboardingQuestion edge in the connection.
Fields
| Field Name | Description |
|---|---|
cursor - Cursor
|
A cursor for use in pagination. |
node - OnboardingQuestion
|
The OnboardingQuestion at the end of the edge. |
Example
{
"cursor": Cursor,
"node": OnboardingQuestion
}
OnboardingQuestionsOrderBy
Description
Methods to use when ordering OnboardingQuestion.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NATURAL"
PageInfo
Description
Information about pagination in a connection.
Fields
| Field Name | Description |
|---|---|
hasNextPage - Boolean!
|
When paginating forwards, are there more items? |
hasPreviousPage - Boolean!
|
When paginating backwards, are there more items? |
startCursor - Cursor
|
When paginating backwards, the cursor to continue. |
endCursor - Cursor
|
When paginating forwards, the cursor to continue. |
Example
{
"hasNextPage": true,
"hasPreviousPage": true,
"startCursor": Cursor,
"endCursor": Cursor
}
PartiesConnection
Description
A connection to a list of Party values.
Fields
| Field Name | Description |
|---|---|
nodes - [Party]!
|
A list of Party objects. |
edges - [PartiesEdge!]!
|
A list of edges which contains the Party and cursor to aid in pagination. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The count of all Party you could get from the connection. |
Example
{
"nodes": [Party],
"edges": [PartiesEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
PartiesEdge
PartiesOrderBy
Description
Methods to use when ordering Party.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NATURAL"
Party
Description
@foreignKey(account_id) REFERENCES vertalo.accounts(id) @foreignKey(user_id) REFERENCES vertalo.users(id) @omit create,update,delete
Fields
| Field Name | Description |
|---|---|
id - UUID
|
|
accountId - UUID
|
|
userId - UUID
|
|
role - String
|
|
dateOfBirth - Date
|
|
usCitizen - Boolean
|
|
isPrimary - Boolean
|
|
accountByAccountId - Account
|
Reads a single Account that is related to this Party. |
userByUserId - User
|
Reads a single User that is related to this Party. |
partyAddressesByPartyId - PartyAddressesConnection!
|
Reads and enables pagination through a set of PartyAddress. |
Arguments
|
|
taxShort - String
|
|
Example
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"userId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"role": "abc123",
"dateOfBirth": "2007-12-03",
"usCitizen": false,
"isPrimary": false,
"accountByAccountId": Account,
"userByUserId": User,
"partyAddressesByPartyId": PartyAddressesConnection,
"taxShort": "xyz789"
}
PartyAddress
Description
@foreignKey(type) REFERENCES vertalo.address_types(type) @foreignKey(account_id) REFERENCES vertalo.accounts(id) @foreignKey(address_id) REFERENCES vertalo.addresses(id) @foreignKey(party_id) REFERENCES vertalo.parties(id) @omit create,update,delete
Fields
| Field Name | Description |
|---|---|
id - UUID
|
|
addressId - UUID
|
|
partyId - UUID
|
|
accountId - UUID
|
|
type - String
|
|
addressTypeByType - AddressType
|
Reads a single AddressType that is related to this PartyAddress. |
partyByPartyId - Party
|
Reads a single Party that is related to this PartyAddress. |
addressByAddressId - Address
|
Reads a single Address that is related to this PartyAddress. |
accountByAccountId - Account
|
Reads a single Account that is related to this PartyAddress. |
Example
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"addressId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"partyId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"type": "abc123",
"addressTypeByType": AddressType,
"partyByPartyId": Party,
"addressByAddressId": Address,
"accountByAccountId": Account
}
PartyAddressCondition
Description
A condition to be used against PartyAddress object types. All fields are tested for equality and combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
id - UUID
|
Checks for equality with the object’s id field. |
addressId - UUID
|
Checks for equality with the object’s addressId field. |
partyId - UUID
|
Checks for equality with the object’s partyId field. |
accountId - UUID
|
Checks for equality with the object’s accountId field. |
type - String
|
Checks for equality with the object’s type field. |
Example
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"addressId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"partyId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"type": "xyz789"
}
PartyAddressFilter
Description
A filter to be used against PartyAddress object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
id - UUIDFilter
|
Filter by the object’s id field. |
addressId - UUIDFilter
|
Filter by the object’s addressId field. |
partyId - UUIDFilter
|
Filter by the object’s partyId field. |
accountId - UUIDFilter
|
Filter by the object’s accountId field. |
type - StringFilter
|
Filter by the object’s type field. |
addressTypeByType - AddressTypeFilter
|
Filter by the object’s addressTypeByType relation. |
addressTypeByTypeExists - Boolean
|
A related addressTypeByType exists. |
partyByPartyId - PartyFilter
|
Filter by the object’s partyByPartyId relation. |
partyByPartyIdExists - Boolean
|
A related partyByPartyId exists. |
addressByAddressId - AddressFilter
|
Filter by the object’s addressByAddressId relation. |
addressByAddressIdExists - Boolean
|
A related addressByAddressId exists. |
accountByAccountId - AccountFilter
|
Filter by the object’s accountByAccountId relation. |
accountByAccountIdExists - Boolean
|
A related accountByAccountId exists. |
and - [PartyAddressFilter!]
|
Checks for all expressions in this list. |
or - [PartyAddressFilter!]
|
Checks for any expressions in this list. |
not - PartyAddressFilter
|
Negates the expression. |
Example
{
"id": UUIDFilter,
"addressId": UUIDFilter,
"partyId": UUIDFilter,
"accountId": UUIDFilter,
"type": StringFilter,
"addressTypeByType": AddressTypeFilter,
"addressTypeByTypeExists": false,
"partyByPartyId": PartyFilter,
"partyByPartyIdExists": false,
"addressByAddressId": AddressFilter,
"addressByAddressIdExists": true,
"accountByAccountId": AccountFilter,
"accountByAccountIdExists": false,
"and": [PartyAddressFilter],
"or": [PartyAddressFilter],
"not": PartyAddressFilter
}
PartyAddressesConnection
Description
A connection to a list of PartyAddress values.
Fields
| Field Name | Description |
|---|---|
nodes - [PartyAddress]!
|
A list of PartyAddress objects. |
edges - [PartyAddressesEdge!]!
|
A list of edges which contains the PartyAddress and cursor to aid in pagination. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The count of all PartyAddress you could get from the connection. |
Example
{
"nodes": [PartyAddress],
"edges": [PartyAddressesEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
PartyAddressesEdge
Description
A PartyAddress edge in the connection.
Fields
| Field Name | Description |
|---|---|
cursor - Cursor
|
A cursor for use in pagination. |
node - PartyAddress
|
The PartyAddress at the end of the edge. |
Example
{
"cursor": Cursor,
"node": PartyAddress
}
PartyAddressesOrderBy
Description
Methods to use when ordering PartyAddress.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NATURAL"
PartyCondition
Description
A condition to be used against Party object types. All fields are tested for equality and combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
id - UUID
|
Checks for equality with the object’s id field. |
accountId - UUID
|
Checks for equality with the object’s accountId field. |
userId - UUID
|
Checks for equality with the object’s userId field. |
role - String
|
Checks for equality with the object’s role field. |
dateOfBirth - Date
|
Checks for equality with the object’s dateOfBirth field. |
usCitizen - Boolean
|
Checks for equality with the object’s usCitizen field. |
isPrimary - Boolean
|
Checks for equality with the object’s isPrimary field. |
Example
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"userId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"role": "xyz789",
"dateOfBirth": "2007-12-03",
"usCitizen": true,
"isPrimary": false
}
PartyFilter
Description
A filter to be used against Party object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
id - UUIDFilter
|
Filter by the object’s id field. |
accountId - UUIDFilter
|
Filter by the object’s accountId field. |
userId - UUIDFilter
|
Filter by the object’s userId field. |
role - StringFilter
|
Filter by the object’s role field. |
dateOfBirth - DateFilter
|
Filter by the object’s dateOfBirth field. |
usCitizen - BooleanFilter
|
Filter by the object’s usCitizen field. |
isPrimary - BooleanFilter
|
Filter by the object’s isPrimary field. |
taxShort - StringFilter
|
Filter by the object’s taxShort field. |
partyAddressesByPartyId - PartyToManyPartyAddressFilter
|
Filter by the object’s partyAddressesByPartyId relation. |
partyAddressesByPartyIdExist - Boolean
|
Some related partyAddressesByPartyId exist. |
accountByAccountId - AccountFilter
|
Filter by the object’s accountByAccountId relation. |
accountByAccountIdExists - Boolean
|
A related accountByAccountId exists. |
userByUserId - UserFilter
|
Filter by the object’s userByUserId relation. |
userByUserIdExists - Boolean
|
A related userByUserId exists. |
and - [PartyFilter!]
|
Checks for all expressions in this list. |
or - [PartyFilter!]
|
Checks for any expressions in this list. |
not - PartyFilter
|
Negates the expression. |
Example
{
"id": UUIDFilter,
"accountId": UUIDFilter,
"userId": UUIDFilter,
"role": StringFilter,
"dateOfBirth": DateFilter,
"usCitizen": BooleanFilter,
"isPrimary": BooleanFilter,
"taxShort": StringFilter,
"partyAddressesByPartyId": PartyToManyPartyAddressFilter,
"partyAddressesByPartyIdExist": false,
"accountByAccountId": AccountFilter,
"accountByAccountIdExists": false,
"userByUserId": UserFilter,
"userByUserIdExists": false,
"and": [PartyFilter],
"or": [PartyFilter],
"not": PartyFilter
}
PartyRole
Fields
| Field Name | Description |
|---|---|
nodeId - ID!
|
A globally unique identifier. Can be used in various places throughout the system to identify this single value. |
role - String!
|
|
customerPartiesByRole - CustomerPartiesConnection!
|
Reads and enables pagination through a set of CustomerParty. |
Arguments
|
|
Example
{
"nodeId": "4",
"role": "abc123",
"customerPartiesByRole": CustomerPartiesConnection
}
PartyRoleCondition
Description
A condition to be used against PartyRole object types. All fields are tested for equality and combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
role - String
|
Checks for equality with the object’s role field. |
Example
{"role": "abc123"}
PartyRoleFilter
Description
A filter to be used against PartyRole object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
role - StringFilter
|
Filter by the object’s role field. |
customerPartiesByRole - PartyRoleToManyCustomerPartyFilter
|
Filter by the object’s customerPartiesByRole relation. |
customerPartiesByRoleExist - Boolean
|
Some related customerPartiesByRole exist. |
and - [PartyRoleFilter!]
|
Checks for all expressions in this list. |
or - [PartyRoleFilter!]
|
Checks for any expressions in this list. |
not - PartyRoleFilter
|
Negates the expression. |
Example
{
"role": StringFilter,
"customerPartiesByRole": PartyRoleToManyCustomerPartyFilter,
"customerPartiesByRoleExist": false,
"and": [PartyRoleFilter],
"or": [PartyRoleFilter],
"not": PartyRoleFilter
}
PartyRoleToManyCustomerPartyFilter
Description
A filter to be used against many CustomerParty object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - CustomerPartyFilter
|
Every related CustomerParty matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - CustomerPartyFilter
|
Some related CustomerParty matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - CustomerPartyFilter
|
No related CustomerParty matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": CustomerPartyFilter,
"some": CustomerPartyFilter,
"none": CustomerPartyFilter
}
PartyRolesConnection
Description
A connection to a list of PartyRole values.
Fields
| Field Name | Description |
|---|---|
nodes - [PartyRole]!
|
A list of PartyRole objects. |
edges - [PartyRolesEdge!]!
|
A list of edges which contains the PartyRole and cursor to aid in pagination. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The count of all PartyRole you could get from the connection. |
Example
{
"nodes": [PartyRole],
"edges": [PartyRolesEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
PartyRolesEdge
PartyRolesOrderBy
Description
Methods to use when ordering PartyRole.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NATURAL"
PartyToManyPartyAddressFilter
Description
A filter to be used against many PartyAddress object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - PartyAddressFilter
|
Every related PartyAddress matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - PartyAddressFilter
|
Some related PartyAddress matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - PartyAddressFilter
|
No related PartyAddress matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": PartyAddressFilter,
"some": PartyAddressFilter,
"none": PartyAddressFilter
}
PauseHoldingsInput
Description
All input for the pauseHoldings mutation.
Example
{
"clientMutationId": "xyz789",
"holdingIds": [
"429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
]
}
PauseHoldingsPayload
Description
The output of our pauseHoldings mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
The exact same clientMutationId that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations. |
holdings - [Holding]
|
|
query - Query
|
Our root query field type. Allows us to run any query from our mutation payload. |
Example
{
"clientMutationId": "abc123",
"holdings": [Holding],
"query": Query
}
PaymentAccount
Fields
| Field Name | Description |
|---|---|
nodeId - ID!
|
A globally unique identifier. Can be used in various places throughout the system to identify this single value. |
id - UUID!
|
|
integrationId - UUID!
|
|
accountId - UUID!
|
|
syncedOn - Datetime
|
|
integrationByIntegrationId - Integration
|
Reads a single Integration that is related to this PaymentAccount. |
accountByAccountId - Account
|
Reads a single Account that is related to this PaymentAccount. |
paymentIssuersByPaymentAccountId - PaymentIssuersConnection!
|
Reads and enables pagination through a set of PaymentIssuer. |
Arguments
|
|
Example
{
"nodeId": 4,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"integrationId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"syncedOn": Datetime,
"integrationByIntegrationId": Integration,
"accountByAccountId": Account,
"paymentIssuersByPaymentAccountId": PaymentIssuersConnection
}
PaymentAccountCondition
Description
A condition to be used against PaymentAccount object types. All fields are tested for equality and combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
id - UUID
|
Checks for equality with the object’s id field. |
integrationId - UUID
|
Checks for equality with the object’s integrationId field. |
accountId - UUID
|
Checks for equality with the object’s accountId field. |
syncedOn - Datetime
|
Checks for equality with the object’s syncedOn field. |
Example
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"integrationId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"syncedOn": Datetime
}
PaymentAccountFilter
Description
A filter to be used against PaymentAccount object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
id - UUIDFilter
|
Filter by the object’s id field. |
integrationId - UUIDFilter
|
Filter by the object’s integrationId field. |
accountId - UUIDFilter
|
Filter by the object’s accountId field. |
syncedOn - DatetimeFilter
|
Filter by the object’s syncedOn field. |
paymentIssuersByPaymentAccountId - PaymentAccountToManyPaymentIssuerFilter
|
Filter by the object’s paymentIssuersByPaymentAccountId relation. |
paymentIssuersByPaymentAccountIdExist - Boolean
|
Some related paymentIssuersByPaymentAccountId exist. |
integrationByIntegrationId - IntegrationFilter
|
Filter by the object’s integrationByIntegrationId relation. |
accountByAccountId - AccountFilter
|
Filter by the object’s accountByAccountId relation. |
and - [PaymentAccountFilter!]
|
Checks for all expressions in this list. |
or - [PaymentAccountFilter!]
|
Checks for any expressions in this list. |
not - PaymentAccountFilter
|
Negates the expression. |
Example
{
"id": UUIDFilter,
"integrationId": UUIDFilter,
"accountId": UUIDFilter,
"syncedOn": DatetimeFilter,
"paymentIssuersByPaymentAccountId": PaymentAccountToManyPaymentIssuerFilter,
"paymentIssuersByPaymentAccountIdExist": true,
"integrationByIntegrationId": IntegrationFilter,
"accountByAccountId": AccountFilter,
"and": [PaymentAccountFilter],
"or": [PaymentAccountFilter],
"not": PaymentAccountFilter
}
PaymentAccountToManyPaymentIssuerFilter
Description
A filter to be used against many PaymentIssuer object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - PaymentIssuerFilter
|
Every related PaymentIssuer matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - PaymentIssuerFilter
|
Some related PaymentIssuer matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - PaymentIssuerFilter
|
No related PaymentIssuer matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": PaymentIssuerFilter,
"some": PaymentIssuerFilter,
"none": PaymentIssuerFilter
}
PaymentAccountsConnection
Description
A connection to a list of PaymentAccount values.
Fields
| Field Name | Description |
|---|---|
nodes - [PaymentAccount]!
|
A list of PaymentAccount objects. |
edges - [PaymentAccountsEdge!]!
|
A list of edges which contains the PaymentAccount and cursor to aid in pagination. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The count of all PaymentAccount you could get from the connection. |
Example
{
"nodes": [PaymentAccount],
"edges": [PaymentAccountsEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
PaymentAccountsEdge
Description
A PaymentAccount edge in the connection.
Fields
| Field Name | Description |
|---|---|
cursor - Cursor
|
A cursor for use in pagination. |
node - PaymentAccount
|
The PaymentAccount at the end of the edge. |
Example
{
"cursor": Cursor,
"node": PaymentAccount
}
PaymentAccountsOrderBy
Description
Methods to use when ordering PaymentAccount.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NATURAL"
PaymentInstrument
Fields
| Field Name | Description |
|---|---|
nodeId - ID!
|
A globally unique identifier. Can be used in various places throughout the system to identify this single value. |
id - UUID!
|
|
paymentIssuerId - UUID!
|
|
roundId - UUID
|
|
stepId - UUID!
|
|
name - String!
|
|
stepType - String!
|
|
vendorQualificationId - UUID
|
|
createdOn - Datetime!
|
|
paymentIssuerByPaymentIssuerId - PaymentIssuer
|
Reads a single PaymentIssuer that is related to this PaymentInstrument. |
roundByRoundId - Round
|
Reads a single Round that is related to this PaymentInstrument. |
stepByStepId - Step
|
Reads a single Step that is related to this PaymentInstrument. |
paymentStepTypeByStepType - PaymentStepType
|
Reads a single PaymentStepType that is related to this PaymentInstrument. |
vendorQualificationByVendorQualificationId - VendorQualification
|
Reads a single VendorQualification that is related to this PaymentInstrument. |
Example
{
"nodeId": 4,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"paymentIssuerId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"roundId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"stepId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"name": "abc123",
"stepType": "xyz789",
"vendorQualificationId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"createdOn": Datetime,
"paymentIssuerByPaymentIssuerId": PaymentIssuer,
"roundByRoundId": Round,
"stepByStepId": Step,
"paymentStepTypeByStepType": PaymentStepType,
"vendorQualificationByVendorQualificationId": VendorQualification
}
PaymentInstrumentCondition
Description
A condition to be used against PaymentInstrument object types. All fields are tested for equality and combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
id - UUID
|
Checks for equality with the object’s id field. |
paymentIssuerId - UUID
|
Checks for equality with the object’s paymentIssuerId field. |
roundId - UUID
|
Checks for equality with the object’s roundId field. |
stepId - UUID
|
Checks for equality with the object’s stepId field. |
name - String
|
Checks for equality with the object’s name field. |
stepType - String
|
Checks for equality with the object’s stepType field. |
vendorQualificationId - UUID
|
Checks for equality with the object’s vendorQualificationId field. |
createdOn - Datetime
|
Checks for equality with the object’s createdOn field. |
Example
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"paymentIssuerId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"roundId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"stepId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"name": "abc123",
"stepType": "abc123",
"vendorQualificationId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"createdOn": Datetime
}
PaymentInstrumentFilter
Description
A filter to be used against PaymentInstrument object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
id - UUIDFilter
|
Filter by the object’s id field. |
paymentIssuerId - UUIDFilter
|
Filter by the object’s paymentIssuerId field. |
roundId - UUIDFilter
|
Filter by the object’s roundId field. |
stepId - UUIDFilter
|
Filter by the object’s stepId field. |
name - StringFilter
|
Filter by the object’s name field. |
stepType - StringFilter
|
Filter by the object’s stepType field. |
vendorQualificationId - UUIDFilter
|
Filter by the object’s vendorQualificationId field. |
createdOn - DatetimeFilter
|
Filter by the object’s createdOn field. |
paymentIssuerByPaymentIssuerId - PaymentIssuerFilter
|
Filter by the object’s paymentIssuerByPaymentIssuerId relation. |
roundByRoundId - RoundFilter
|
Filter by the object’s roundByRoundId relation. |
roundByRoundIdExists - Boolean
|
A related roundByRoundId exists. |
stepByStepId - StepFilter
|
Filter by the object’s stepByStepId relation. |
paymentStepTypeByStepType - PaymentStepTypeFilter
|
Filter by the object’s paymentStepTypeByStepType relation. |
vendorQualificationByVendorQualificationId - VendorQualificationFilter
|
Filter by the object’s vendorQualificationByVendorQualificationId relation. |
vendorQualificationByVendorQualificationIdExists - Boolean
|
A related vendorQualificationByVendorQualificationId exists. |
and - [PaymentInstrumentFilter!]
|
Checks for all expressions in this list. |
or - [PaymentInstrumentFilter!]
|
Checks for any expressions in this list. |
not - PaymentInstrumentFilter
|
Negates the expression. |
Example
{
"id": UUIDFilter,
"paymentIssuerId": UUIDFilter,
"roundId": UUIDFilter,
"stepId": UUIDFilter,
"name": StringFilter,
"stepType": StringFilter,
"vendorQualificationId": UUIDFilter,
"createdOn": DatetimeFilter,
"paymentIssuerByPaymentIssuerId": PaymentIssuerFilter,
"roundByRoundId": RoundFilter,
"roundByRoundIdExists": false,
"stepByStepId": StepFilter,
"paymentStepTypeByStepType": PaymentStepTypeFilter,
"vendorQualificationByVendorQualificationId": VendorQualificationFilter,
"vendorQualificationByVendorQualificationIdExists": false,
"and": [PaymentInstrumentFilter],
"or": [PaymentInstrumentFilter],
"not": PaymentInstrumentFilter
}
PaymentInstrumentsConnection
Description
A connection to a list of PaymentInstrument values.
Fields
| Field Name | Description |
|---|---|
nodes - [PaymentInstrument]!
|
A list of PaymentInstrument objects. |
edges - [PaymentInstrumentsEdge!]!
|
A list of edges which contains the PaymentInstrument and cursor to aid in pagination. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The count of all PaymentInstrument you could get from the connection. |
Example
{
"nodes": [PaymentInstrument],
"edges": [PaymentInstrumentsEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
PaymentInstrumentsEdge
Description
A PaymentInstrument edge in the connection.
Fields
| Field Name | Description |
|---|---|
cursor - Cursor
|
A cursor for use in pagination. |
node - PaymentInstrument
|
The PaymentInstrument at the end of the edge. |
Example
{
"cursor": Cursor,
"node": PaymentInstrument
}
PaymentInstrumentsOrderBy
Description
Methods to use when ordering PaymentInstrument.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NATURAL"
PaymentIssuer
Fields
| Field Name | Description |
|---|---|
nodeId - ID!
|
A globally unique identifier. Can be used in various places throughout the system to identify this single value. |
id - UUID!
|
|
issuerId - UUID
|
|
accountId - UUID!
|
|
paymentAccountId - UUID!
|
|
stepId - UUID!
|
|
name - String!
|
|
email - String!
|
|
createdOn - Datetime!
|
|
archive - Boolean!
|
|
stepType - String!
|
|
accountByIssuerId - Account
|
Reads a single Account that is related to this PaymentIssuer. |
accountByAccountId - Account
|
Reads a single Account that is related to this PaymentIssuer. |
paymentAccountByPaymentAccountId - PaymentAccount
|
Reads a single PaymentAccount that is related to this PaymentIssuer. |
stepByStepId - Step
|
Reads a single Step that is related to this PaymentIssuer. |
paymentStepTypeByStepType - PaymentStepType
|
Reads a single PaymentStepType that is related to this PaymentIssuer. |
paymentInstrumentsByPaymentIssuerId - PaymentInstrumentsConnection!
|
Reads and enables pagination through a set of PaymentInstrument. |
Arguments
|
|
Example
{
"nodeId": 4,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"issuerId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"paymentAccountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"stepId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"name": "xyz789",
"email": "abc123",
"createdOn": Datetime,
"archive": true,
"stepType": "abc123",
"accountByIssuerId": Account,
"accountByAccountId": Account,
"paymentAccountByPaymentAccountId": PaymentAccount,
"stepByStepId": Step,
"paymentStepTypeByStepType": PaymentStepType,
"paymentInstrumentsByPaymentIssuerId": PaymentInstrumentsConnection
}
PaymentIssuerCondition
Description
A condition to be used against PaymentIssuer object types. All fields are tested for equality and combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
id - UUID
|
Checks for equality with the object’s id field. |
issuerId - UUID
|
Checks for equality with the object’s issuerId field. |
accountId - UUID
|
Checks for equality with the object’s accountId field. |
paymentAccountId - UUID
|
Checks for equality with the object’s paymentAccountId field. |
stepId - UUID
|
Checks for equality with the object’s stepId field. |
name - String
|
Checks for equality with the object’s name field. |
email - String
|
Checks for equality with the object’s email field. |
createdOn - Datetime
|
Checks for equality with the object’s createdOn field. |
archive - Boolean
|
Checks for equality with the object’s archive field. |
stepType - String
|
Checks for equality with the object’s stepType field. |
Example
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"issuerId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"paymentAccountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"stepId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"name": "abc123",
"email": "xyz789",
"createdOn": Datetime,
"archive": false,
"stepType": "xyz789"
}
PaymentIssuerFilter
Description
A filter to be used against PaymentIssuer object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
id - UUIDFilter
|
Filter by the object’s id field. |
issuerId - UUIDFilter
|
Filter by the object’s issuerId field. |
accountId - UUIDFilter
|
Filter by the object’s accountId field. |
paymentAccountId - UUIDFilter
|
Filter by the object’s paymentAccountId field. |
stepId - UUIDFilter
|
Filter by the object’s stepId field. |
name - StringFilter
|
Filter by the object’s name field. |
email - StringFilter
|
Filter by the object’s email field. |
createdOn - DatetimeFilter
|
Filter by the object’s createdOn field. |
archive - BooleanFilter
|
Filter by the object’s archive field. |
stepType - StringFilter
|
Filter by the object’s stepType field. |
paymentInstrumentsByPaymentIssuerId - PaymentIssuerToManyPaymentInstrumentFilter
|
Filter by the object’s paymentInstrumentsByPaymentIssuerId relation. |
paymentInstrumentsByPaymentIssuerIdExist - Boolean
|
Some related paymentInstrumentsByPaymentIssuerId exist. |
accountByIssuerId - AccountFilter
|
Filter by the object’s accountByIssuerId relation. |
accountByIssuerIdExists - Boolean
|
A related accountByIssuerId exists. |
accountByAccountId - AccountFilter
|
Filter by the object’s accountByAccountId relation. |
paymentAccountByPaymentAccountId - PaymentAccountFilter
|
Filter by the object’s paymentAccountByPaymentAccountId relation. |
stepByStepId - StepFilter
|
Filter by the object’s stepByStepId relation. |
paymentStepTypeByStepType - PaymentStepTypeFilter
|
Filter by the object’s paymentStepTypeByStepType relation. |
and - [PaymentIssuerFilter!]
|
Checks for all expressions in this list. |
or - [PaymentIssuerFilter!]
|
Checks for any expressions in this list. |
not - PaymentIssuerFilter
|
Negates the expression. |
Example
{
"id": UUIDFilter,
"issuerId": UUIDFilter,
"accountId": UUIDFilter,
"paymentAccountId": UUIDFilter,
"stepId": UUIDFilter,
"name": StringFilter,
"email": StringFilter,
"createdOn": DatetimeFilter,
"archive": BooleanFilter,
"stepType": StringFilter,
"paymentInstrumentsByPaymentIssuerId": PaymentIssuerToManyPaymentInstrumentFilter,
"paymentInstrumentsByPaymentIssuerIdExist": false,
"accountByIssuerId": AccountFilter,
"accountByIssuerIdExists": true,
"accountByAccountId": AccountFilter,
"paymentAccountByPaymentAccountId": PaymentAccountFilter,
"stepByStepId": StepFilter,
"paymentStepTypeByStepType": PaymentStepTypeFilter,
"and": [PaymentIssuerFilter],
"or": [PaymentIssuerFilter],
"not": PaymentIssuerFilter
}
PaymentIssuerToManyPaymentInstrumentFilter
Description
A filter to be used against many PaymentInstrument object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - PaymentInstrumentFilter
|
Every related PaymentInstrument matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - PaymentInstrumentFilter
|
Some related PaymentInstrument matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - PaymentInstrumentFilter
|
No related PaymentInstrument matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": PaymentInstrumentFilter,
"some": PaymentInstrumentFilter,
"none": PaymentInstrumentFilter
}
PaymentIssuersConnection
Description
A connection to a list of PaymentIssuer values.
Fields
| Field Name | Description |
|---|---|
nodes - [PaymentIssuer]!
|
A list of PaymentIssuer objects. |
edges - [PaymentIssuersEdge!]!
|
A list of edges which contains the PaymentIssuer and cursor to aid in pagination. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The count of all PaymentIssuer you could get from the connection. |
Example
{
"nodes": [PaymentIssuer],
"edges": [PaymentIssuersEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
PaymentIssuersEdge
Description
A PaymentIssuer edge in the connection.
Fields
| Field Name | Description |
|---|---|
cursor - Cursor
|
A cursor for use in pagination. |
node - PaymentIssuer
|
The PaymentIssuer at the end of the edge. |
Example
{
"cursor": Cursor,
"node": PaymentIssuer
}
PaymentIssuersOrderBy
Description
Methods to use when ordering PaymentIssuer.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NATURAL"
PaymentMethod
Fields
| Field Name | Description |
|---|---|
nodeId - ID!
|
A globally unique identifier. Can be used in various places throughout the system to identify this single value. |
id - UUID!
|
|
accountId - UUID!
|
|
integrationId - UUID!
|
|
name - String!
|
|
hash - String!
|
|
unlockHash - String!
|
|
encryptedRecordId - UUID!
|
|
type - String!
|
|
accountByAccountId - Account
|
Reads a single Account that is related to this PaymentMethod. |
integrationByIntegrationId - Integration
|
Reads a single Integration that is related to this PaymentMethod. |
paymentMethodTypeByType - PaymentMethodType
|
Reads a single PaymentMethodType that is related to this PaymentMethod. |
Example
{
"nodeId": "4",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"integrationId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"name": "abc123",
"hash": "xyz789",
"unlockHash": "abc123",
"encryptedRecordId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"type": "xyz789",
"accountByAccountId": Account,
"integrationByIntegrationId": Integration,
"paymentMethodTypeByType": PaymentMethodType
}
PaymentMethodCondition
Description
A condition to be used against PaymentMethod object types. All fields are tested for equality and combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
id - UUID
|
Checks for equality with the object’s id field. |
accountId - UUID
|
Checks for equality with the object’s accountId field. |
integrationId - UUID
|
Checks for equality with the object’s integrationId field. |
name - String
|
Checks for equality with the object’s name field. |
hash - String
|
Checks for equality with the object’s hash field. |
unlockHash - String
|
Checks for equality with the object’s unlockHash field. |
encryptedRecordId - UUID
|
Checks for equality with the object’s encryptedRecordId field. |
type - String
|
Checks for equality with the object’s type field. |
Example
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"integrationId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"name": "abc123",
"hash": "abc123",
"unlockHash": "abc123",
"encryptedRecordId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"type": "xyz789"
}
PaymentMethodFilter
Description
A filter to be used against PaymentMethod object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
id - UUIDFilter
|
Filter by the object’s id field. |
accountId - UUIDFilter
|
Filter by the object’s accountId field. |
integrationId - UUIDFilter
|
Filter by the object’s integrationId field. |
name - StringFilter
|
Filter by the object’s name field. |
hash - StringFilter
|
Filter by the object’s hash field. |
unlockHash - StringFilter
|
Filter by the object’s unlockHash field. |
encryptedRecordId - UUIDFilter
|
Filter by the object’s encryptedRecordId field. |
type - StringFilter
|
Filter by the object’s type field. |
accountByAccountId - AccountFilter
|
Filter by the object’s accountByAccountId relation. |
integrationByIntegrationId - IntegrationFilter
|
Filter by the object’s integrationByIntegrationId relation. |
paymentMethodTypeByType - PaymentMethodTypeFilter
|
Filter by the object’s paymentMethodTypeByType relation. |
and - [PaymentMethodFilter!]
|
Checks for all expressions in this list. |
or - [PaymentMethodFilter!]
|
Checks for any expressions in this list. |
not - PaymentMethodFilter
|
Negates the expression. |
Example
{
"id": UUIDFilter,
"accountId": UUIDFilter,
"integrationId": UUIDFilter,
"name": StringFilter,
"hash": StringFilter,
"unlockHash": StringFilter,
"encryptedRecordId": UUIDFilter,
"type": StringFilter,
"accountByAccountId": AccountFilter,
"integrationByIntegrationId": IntegrationFilter,
"paymentMethodTypeByType": PaymentMethodTypeFilter,
"and": [PaymentMethodFilter],
"or": [PaymentMethodFilter],
"not": PaymentMethodFilter
}
PaymentMethodInput
Description
An input for mutations affecting PaymentMethod
Example
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"integrationId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"name": "abc123",
"hash": "abc123",
"unlockHash": "abc123",
"encryptedRecordId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"type": "abc123"
}
PaymentMethodPatch
Description
Represents an update to a PaymentMethod. Fields that are set will be updated.
Example
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"integrationId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"name": "xyz789",
"hash": "abc123",
"unlockHash": "abc123",
"encryptedRecordId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"type": "abc123"
}
PaymentMethodType
Fields
| Field Name | Description |
|---|---|
nodeId - ID!
|
A globally unique identifier. Can be used in various places throughout the system to identify this single value. |
type - String!
|
|
paymentMethodsByType - PaymentMethodsConnection!
|
Reads and enables pagination through a set of PaymentMethod. |
Arguments
|
|
Example
{
"nodeId": 4,
"type": "abc123",
"paymentMethodsByType": PaymentMethodsConnection
}
PaymentMethodTypeCondition
Description
A condition to be used against PaymentMethodType object types. All fields are tested for equality and combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
type - String
|
Checks for equality with the object’s type field. |
Example
{"type": "abc123"}
PaymentMethodTypeFilter
Description
A filter to be used against PaymentMethodType object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
type - StringFilter
|
Filter by the object’s type field. |
paymentMethodsByType - PaymentMethodTypeToManyPaymentMethodFilter
|
Filter by the object’s paymentMethodsByType relation. |
paymentMethodsByTypeExist - Boolean
|
Some related paymentMethodsByType exist. |
and - [PaymentMethodTypeFilter!]
|
Checks for all expressions in this list. |
or - [PaymentMethodTypeFilter!]
|
Checks for any expressions in this list. |
not - PaymentMethodTypeFilter
|
Negates the expression. |
Example
{
"type": StringFilter,
"paymentMethodsByType": PaymentMethodTypeToManyPaymentMethodFilter,
"paymentMethodsByTypeExist": true,
"and": [PaymentMethodTypeFilter],
"or": [PaymentMethodTypeFilter],
"not": PaymentMethodTypeFilter
}
PaymentMethodTypeInput
Description
An input for mutations affecting PaymentMethodType
Fields
| Input Field | Description |
|---|---|
type - String!
|
Example
{"type": "abc123"}
PaymentMethodTypePatch
Description
Represents an update to a PaymentMethodType. Fields that are set will be updated.
Fields
| Input Field | Description |
|---|---|
type - String
|
Example
{"type": "abc123"}
PaymentMethodTypeToManyPaymentMethodFilter
Description
A filter to be used against many PaymentMethod object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - PaymentMethodFilter
|
Every related PaymentMethod matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - PaymentMethodFilter
|
Some related PaymentMethod matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - PaymentMethodFilter
|
No related PaymentMethod matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": PaymentMethodFilter,
"some": PaymentMethodFilter,
"none": PaymentMethodFilter
}
PaymentMethodTypesConnection
Description
A connection to a list of PaymentMethodType values.
Fields
| Field Name | Description |
|---|---|
nodes - [PaymentMethodType]!
|
A list of PaymentMethodType objects. |
edges - [PaymentMethodTypesEdge!]!
|
A list of edges which contains the PaymentMethodType and cursor to aid in pagination. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The count of all PaymentMethodType you could get from the connection. |
Example
{
"nodes": [PaymentMethodType],
"edges": [PaymentMethodTypesEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
PaymentMethodTypesEdge
Description
A PaymentMethodType edge in the connection.
Fields
| Field Name | Description |
|---|---|
cursor - Cursor
|
A cursor for use in pagination. |
node - PaymentMethodType
|
The PaymentMethodType at the end of the edge. |
Example
{
"cursor": Cursor,
"node": PaymentMethodType
}
PaymentMethodTypesOrderBy
Description
Methods to use when ordering PaymentMethodType.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NATURAL"
PaymentMethodsConnection
Description
A connection to a list of PaymentMethod values.
Fields
| Field Name | Description |
|---|---|
nodes - [PaymentMethod]!
|
A list of PaymentMethod objects. |
edges - [PaymentMethodsEdge!]!
|
A list of edges which contains the PaymentMethod and cursor to aid in pagination. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The count of all PaymentMethod you could get from the connection. |
Example
{
"nodes": [PaymentMethod],
"edges": [PaymentMethodsEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
PaymentMethodsEdge
Description
A PaymentMethod edge in the connection.
Fields
| Field Name | Description |
|---|---|
cursor - Cursor
|
A cursor for use in pagination. |
node - PaymentMethod
|
The PaymentMethod at the end of the edge. |
Example
{
"cursor": Cursor,
"node": PaymentMethod
}
PaymentMethodsOrderBy
Description
Methods to use when ordering PaymentMethod.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NATURAL"
PaymentStepType
Fields
| Field Name | Description |
|---|---|
nodeId - ID!
|
A globally unique identifier. Can be used in various places throughout the system to identify this single value. |
type - String!
|
|
paymentIssuersByStepType - PaymentIssuersConnection!
|
Reads and enables pagination through a set of PaymentIssuer. |
Arguments
|
|
paymentInstrumentsByStepType - PaymentInstrumentsConnection!
|
Reads and enables pagination through a set of PaymentInstrument. |
Arguments
|
|
Example
{
"nodeId": 4,
"type": "xyz789",
"paymentIssuersByStepType": PaymentIssuersConnection,
"paymentInstrumentsByStepType": PaymentInstrumentsConnection
}
PaymentStepTypeCondition
Description
A condition to be used against PaymentStepType object types. All fields are tested for equality and combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
type - String
|
Checks for equality with the object’s type field. |
Example
{"type": "xyz789"}
PaymentStepTypeFilter
Description
A filter to be used against PaymentStepType object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
type - StringFilter
|
Filter by the object’s type field. |
paymentIssuersByStepType - PaymentStepTypeToManyPaymentIssuerFilter
|
Filter by the object’s paymentIssuersByStepType relation. |
paymentIssuersByStepTypeExist - Boolean
|
Some related paymentIssuersByStepType exist. |
paymentInstrumentsByStepType - PaymentStepTypeToManyPaymentInstrumentFilter
|
Filter by the object’s paymentInstrumentsByStepType relation. |
paymentInstrumentsByStepTypeExist - Boolean
|
Some related paymentInstrumentsByStepType exist. |
and - [PaymentStepTypeFilter!]
|
Checks for all expressions in this list. |
or - [PaymentStepTypeFilter!]
|
Checks for any expressions in this list. |
not - PaymentStepTypeFilter
|
Negates the expression. |
Example
{
"type": StringFilter,
"paymentIssuersByStepType": PaymentStepTypeToManyPaymentIssuerFilter,
"paymentIssuersByStepTypeExist": false,
"paymentInstrumentsByStepType": PaymentStepTypeToManyPaymentInstrumentFilter,
"paymentInstrumentsByStepTypeExist": true,
"and": [PaymentStepTypeFilter],
"or": [PaymentStepTypeFilter],
"not": PaymentStepTypeFilter
}
PaymentStepTypeInput
Description
An input for mutations affecting PaymentStepType
Fields
| Input Field | Description |
|---|---|
type - String!
|
Example
{"type": "xyz789"}
PaymentStepTypePatch
Description
Represents an update to a PaymentStepType. Fields that are set will be updated.
Fields
| Input Field | Description |
|---|---|
type - String
|
Example
{"type": "abc123"}
PaymentStepTypeToManyPaymentInstrumentFilter
Description
A filter to be used against many PaymentInstrument object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - PaymentInstrumentFilter
|
Every related PaymentInstrument matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - PaymentInstrumentFilter
|
Some related PaymentInstrument matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - PaymentInstrumentFilter
|
No related PaymentInstrument matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": PaymentInstrumentFilter,
"some": PaymentInstrumentFilter,
"none": PaymentInstrumentFilter
}
PaymentStepTypeToManyPaymentIssuerFilter
Description
A filter to be used against many PaymentIssuer object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - PaymentIssuerFilter
|
Every related PaymentIssuer matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - PaymentIssuerFilter
|
Some related PaymentIssuer matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - PaymentIssuerFilter
|
No related PaymentIssuer matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": PaymentIssuerFilter,
"some": PaymentIssuerFilter,
"none": PaymentIssuerFilter
}
PaymentStepTypesConnection
Description
A connection to a list of PaymentStepType values.
Fields
| Field Name | Description |
|---|---|
nodes - [PaymentStepType]!
|
A list of PaymentStepType objects. |
edges - [PaymentStepTypesEdge!]!
|
A list of edges which contains the PaymentStepType and cursor to aid in pagination. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The count of all PaymentStepType you could get from the connection. |
Example
{
"nodes": [PaymentStepType],
"edges": [PaymentStepTypesEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
PaymentStepTypesEdge
Description
A PaymentStepType edge in the connection.
Fields
| Field Name | Description |
|---|---|
cursor - Cursor
|
A cursor for use in pagination. |
node - PaymentStepType
|
The PaymentStepType at the end of the edge. |
Example
{
"cursor": Cursor,
"node": PaymentStepType
}
PaymentStepTypesOrderBy
Description
Methods to use when ordering PaymentStepType.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NATURAL"
PhoneNumberType
Fields
| Field Name | Description |
|---|---|
nodeId - ID!
|
A globally unique identifier. Can be used in various places throughout the system to identify this single value. |
type - String!
|
|
accountPhoneNumbersByType - AccountPhoneNumbersConnection!
|
Reads and enables pagination through a set of AccountPhoneNumber. |
Arguments
|
|
Example
{
"nodeId": "4",
"type": "xyz789",
"accountPhoneNumbersByType": AccountPhoneNumbersConnection
}
PhoneNumberTypeCondition
Description
A condition to be used against PhoneNumberType object types. All fields are tested for equality and combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
type - String
|
Checks for equality with the object’s type field. |
Example
{"type": "abc123"}
PhoneNumberTypeFilter
Description
A filter to be used against PhoneNumberType object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
type - StringFilter
|
Filter by the object’s type field. |
accountPhoneNumbersByType - PhoneNumberTypeToManyAccountPhoneNumberFilter
|
Filter by the object’s accountPhoneNumbersByType relation. |
accountPhoneNumbersByTypeExist - Boolean
|
Some related accountPhoneNumbersByType exist. |
and - [PhoneNumberTypeFilter!]
|
Checks for all expressions in this list. |
or - [PhoneNumberTypeFilter!]
|
Checks for any expressions in this list. |
not - PhoneNumberTypeFilter
|
Negates the expression. |
Example
{
"type": StringFilter,
"accountPhoneNumbersByType": PhoneNumberTypeToManyAccountPhoneNumberFilter,
"accountPhoneNumbersByTypeExist": true,
"and": [PhoneNumberTypeFilter],
"or": [PhoneNumberTypeFilter],
"not": PhoneNumberTypeFilter
}
PhoneNumberTypeToManyAccountPhoneNumberFilter
Description
A filter to be used against many AccountPhoneNumber object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - AccountPhoneNumberFilter
|
Every related AccountPhoneNumber matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - AccountPhoneNumberFilter
|
Some related AccountPhoneNumber matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - AccountPhoneNumberFilter
|
No related AccountPhoneNumber matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": AccountPhoneNumberFilter,
"some": AccountPhoneNumberFilter,
"none": AccountPhoneNumberFilter
}
PhoneNumberTypesConnection
Description
A connection to a list of PhoneNumberType values.
Fields
| Field Name | Description |
|---|---|
nodes - [PhoneNumberType]!
|
A list of PhoneNumberType objects. |
edges - [PhoneNumberTypesEdge!]!
|
A list of edges which contains the PhoneNumberType and cursor to aid in pagination. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The count of all PhoneNumberType you could get from the connection. |
Example
{
"nodes": [PhoneNumberType],
"edges": [PhoneNumberTypesEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
PhoneNumberTypesEdge
Description
A PhoneNumberType edge in the connection.
Fields
| Field Name | Description |
|---|---|
cursor - Cursor
|
A cursor for use in pagination. |
node - PhoneNumberType
|
The PhoneNumberType at the end of the edge. |
Example
{
"cursor": Cursor,
"node": PhoneNumberType
}
PhoneNumberTypesOrderBy
Description
Methods to use when ordering PhoneNumberType.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NATURAL"
QualificationStatus
QualificationStatusCondition
Description
A condition to be used against QualificationStatus object types. All fields are tested for equality and combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
status - String
|
Checks for equality with the object’s status field. |
Example
{"status": "abc123"}
QualificationStatusFilter
Description
A filter to be used against QualificationStatus object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
status - StringFilter
|
Filter by the object’s status field. |
and - [QualificationStatusFilter!]
|
Checks for all expressions in this list. |
or - [QualificationStatusFilter!]
|
Checks for any expressions in this list. |
not - QualificationStatusFilter
|
Negates the expression. |
Example
{
"status": StringFilter,
"and": [QualificationStatusFilter],
"or": [QualificationStatusFilter],
"not": QualificationStatusFilter
}
QualificationStatusesConnection
Description
A connection to a list of QualificationStatus values.
Fields
| Field Name | Description |
|---|---|
nodes - [QualificationStatus]!
|
A list of QualificationStatus objects. |
edges - [QualificationStatusesEdge!]!
|
A list of edges which contains the QualificationStatus and cursor to aid in pagination. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The count of all QualificationStatus you could get from the connection. |
Example
{
"nodes": [QualificationStatus],
"edges": [QualificationStatusesEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
QualificationStatusesEdge
Description
A QualificationStatus edge in the connection.
Fields
| Field Name | Description |
|---|---|
cursor - Cursor
|
A cursor for use in pagination. |
node - QualificationStatus
|
The QualificationStatus at the end of the edge. |
Example
{
"cursor": Cursor,
"node": QualificationStatus
}
QualificationStatusesOrderBy
Description
Methods to use when ordering QualificationStatus.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NATURAL"
RegistrationMethod
Fields
| Field Name | Description |
|---|---|
nodeId - ID!
|
A globally unique identifier. Can be used in various places throughout the system to identify this single value. |
method - String!
|
|
blockchainRegistrationsByMethod - BlockchainRegistrationsConnection!
|
Reads and enables pagination through a set of BlockchainRegistration. |
Arguments
|
|
Example
{
"nodeId": 4,
"method": "xyz789",
"blockchainRegistrationsByMethod": BlockchainRegistrationsConnection
}
RegistrationMethodCondition
Description
A condition to be used against RegistrationMethod object types. All fields are tested for equality and combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
method - String
|
Checks for equality with the object’s method field. |
Example
{"method": "abc123"}
RegistrationMethodFilter
Description
A filter to be used against RegistrationMethod object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
method - StringFilter
|
Filter by the object’s method field. |
blockchainRegistrationsByMethod - RegistrationMethodToManyBlockchainRegistrationFilter
|
Filter by the object’s blockchainRegistrationsByMethod relation. |
blockchainRegistrationsByMethodExist - Boolean
|
Some related blockchainRegistrationsByMethod exist. |
and - [RegistrationMethodFilter!]
|
Checks for all expressions in this list. |
or - [RegistrationMethodFilter!]
|
Checks for any expressions in this list. |
not - RegistrationMethodFilter
|
Negates the expression. |
Example
{
"method": StringFilter,
"blockchainRegistrationsByMethod": RegistrationMethodToManyBlockchainRegistrationFilter,
"blockchainRegistrationsByMethodExist": false,
"and": [RegistrationMethodFilter],
"or": [RegistrationMethodFilter],
"not": RegistrationMethodFilter
}
RegistrationMethodToManyBlockchainRegistrationFilter
Description
A filter to be used against many BlockchainRegistration object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - BlockchainRegistrationFilter
|
Every related BlockchainRegistration matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - BlockchainRegistrationFilter
|
Some related BlockchainRegistration matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - BlockchainRegistrationFilter
|
No related BlockchainRegistration matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": BlockchainRegistrationFilter,
"some": BlockchainRegistrationFilter,
"none": BlockchainRegistrationFilter
}
RegistrationMethodsConnection
Description
A connection to a list of RegistrationMethod values.
Fields
| Field Name | Description |
|---|---|
nodes - [RegistrationMethod]!
|
A list of RegistrationMethod objects. |
edges - [RegistrationMethodsEdge!]!
|
A list of edges which contains the RegistrationMethod and cursor to aid in pagination. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The count of all RegistrationMethod you could get from the connection. |
Example
{
"nodes": [RegistrationMethod],
"edges": [RegistrationMethodsEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
RegistrationMethodsEdge
Description
A RegistrationMethod edge in the connection.
Fields
| Field Name | Description |
|---|---|
cursor - Cursor
|
A cursor for use in pagination. |
node - RegistrationMethod
|
The RegistrationMethod at the end of the edge. |
Example
{
"cursor": Cursor,
"node": RegistrationMethod
}
RegistrationMethodsOrderBy
Description
Methods to use when ordering RegistrationMethod.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NATURAL"
RegistrationStatus
Fields
| Field Name | Description |
|---|---|
nodeId - ID!
|
A globally unique identifier. Can be used in various places throughout the system to identify this single value. |
status - String!
|
|
blockchainRegistrationsByStatus - BlockchainRegistrationsConnection!
|
Reads and enables pagination through a set of BlockchainRegistration. |
Arguments
|
|
Example
{
"nodeId": 4,
"status": "xyz789",
"blockchainRegistrationsByStatus": BlockchainRegistrationsConnection
}
RegistrationStatusCondition
Description
A condition to be used against RegistrationStatus object types. All fields are tested for equality and combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
status - String
|
Checks for equality with the object’s status field. |
Example
{"status": "xyz789"}
RegistrationStatusFilter
Description
A filter to be used against RegistrationStatus object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
status - StringFilter
|
Filter by the object’s status field. |
blockchainRegistrationsByStatus - RegistrationStatusToManyBlockchainRegistrationFilter
|
Filter by the object’s blockchainRegistrationsByStatus relation. |
blockchainRegistrationsByStatusExist - Boolean
|
Some related blockchainRegistrationsByStatus exist. |
and - [RegistrationStatusFilter!]
|
Checks for all expressions in this list. |
or - [RegistrationStatusFilter!]
|
Checks for any expressions in this list. |
not - RegistrationStatusFilter
|
Negates the expression. |
Example
{
"status": StringFilter,
"blockchainRegistrationsByStatus": RegistrationStatusToManyBlockchainRegistrationFilter,
"blockchainRegistrationsByStatusExist": true,
"and": [RegistrationStatusFilter],
"or": [RegistrationStatusFilter],
"not": RegistrationStatusFilter
}
RegistrationStatusToManyBlockchainRegistrationFilter
Description
A filter to be used against many BlockchainRegistration object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - BlockchainRegistrationFilter
|
Every related BlockchainRegistration matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - BlockchainRegistrationFilter
|
Some related BlockchainRegistration matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - BlockchainRegistrationFilter
|
No related BlockchainRegistration matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": BlockchainRegistrationFilter,
"some": BlockchainRegistrationFilter,
"none": BlockchainRegistrationFilter
}
RegistrationStatusesConnection
Description
A connection to a list of RegistrationStatus values.
Fields
| Field Name | Description |
|---|---|
nodes - [RegistrationStatus]!
|
A list of RegistrationStatus objects. |
edges - [RegistrationStatusesEdge!]!
|
A list of edges which contains the RegistrationStatus and cursor to aid in pagination. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The count of all RegistrationStatus you could get from the connection. |
Example
{
"nodes": [RegistrationStatus],
"edges": [RegistrationStatusesEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
RegistrationStatusesEdge
Description
A RegistrationStatus edge in the connection.
Fields
| Field Name | Description |
|---|---|
cursor - Cursor
|
A cursor for use in pagination. |
node - RegistrationStatus
|
The RegistrationStatus at the end of the edge. |
Example
{
"cursor": Cursor,
"node": RegistrationStatus
}
RegistrationStatusesOrderBy
Description
Methods to use when ordering RegistrationStatus.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NATURAL"
Request
Fields
| Field Name | Description |
|---|---|
id - UUID
|
|
accountId - UUID
|
|
data - JSON
|
|
type - String
|
|
createdOn - Datetime
|
|
requestTypeByType - RequestType
|
Reads a single RequestType that is related to this Request. |
accountByAccountId - Account
|
Reads a single Account that is related to this Request. |
stagedTransfersByRequestId - StagedTransfersConnection!
|
Reads and enables pagination through a set of StagedTransfer. |
Arguments
|
|
Example
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"data": {},
"type": "abc123",
"createdOn": Datetime,
"requestTypeByType": RequestType,
"accountByAccountId": Account,
"stagedTransfersByRequestId": StagedTransfersConnection
}
RequestCondition
Description
A condition to be used against Request object types. All fields are tested for equality and combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
id - UUID
|
Checks for equality with the object’s id field. |
accountId - UUID
|
Checks for equality with the object’s accountId field. |
data - JSON
|
Checks for equality with the object’s data field. |
type - String
|
Checks for equality with the object’s type field. |
createdOn - Datetime
|
Checks for equality with the object’s createdOn field. |
Example
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"data": {},
"type": "xyz789",
"createdOn": Datetime
}
RequestFilter
Description
A filter to be used against Request object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
id - UUIDFilter
|
Filter by the object’s id field. |
accountId - UUIDFilter
|
Filter by the object’s accountId field. |
data - JSONFilter
|
Filter by the object’s data field. |
type - StringFilter
|
Filter by the object’s type field. |
createdOn - DatetimeFilter
|
Filter by the object’s createdOn field. |
stagedTransfersByRequestId - RequestToManyStagedTransferFilter
|
Filter by the object’s stagedTransfersByRequestId relation. |
stagedTransfersByRequestIdExist - Boolean
|
Some related stagedTransfersByRequestId exist. |
requestTypeByType - RequestTypeFilter
|
Filter by the object’s requestTypeByType relation. |
requestTypeByTypeExists - Boolean
|
A related requestTypeByType exists. |
accountByAccountId - AccountFilter
|
Filter by the object’s accountByAccountId relation. |
accountByAccountIdExists - Boolean
|
A related accountByAccountId exists. |
and - [RequestFilter!]
|
Checks for all expressions in this list. |
or - [RequestFilter!]
|
Checks for any expressions in this list. |
not - RequestFilter
|
Negates the expression. |
Example
{
"id": UUIDFilter,
"accountId": UUIDFilter,
"data": JSONFilter,
"type": StringFilter,
"createdOn": DatetimeFilter,
"stagedTransfersByRequestId": RequestToManyStagedTransferFilter,
"stagedTransfersByRequestIdExist": true,
"requestTypeByType": RequestTypeFilter,
"requestTypeByTypeExists": true,
"accountByAccountId": AccountFilter,
"accountByAccountIdExists": true,
"and": [RequestFilter],
"or": [RequestFilter],
"not": RequestFilter
}
RequestToManyStagedTransferFilter
Description
A filter to be used against many StagedTransfer object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - StagedTransferFilter
|
Every related StagedTransfer matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - StagedTransferFilter
|
Some related StagedTransfer matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - StagedTransferFilter
|
No related StagedTransfer matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": StagedTransferFilter,
"some": StagedTransferFilter,
"none": StagedTransferFilter
}
RequestType
Fields
| Field Name | Description |
|---|---|
type - String
|
|
requestsByType - RequestsConnection!
|
Reads and enables pagination through a set of Request. |
Arguments
|
|
Example
{
"type": "abc123",
"requestsByType": RequestsConnection
}
RequestTypeCondition
Description
A condition to be used against RequestType object types. All fields are tested for equality and combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
type - String
|
Checks for equality with the object’s type field. |
Example
{"type": "xyz789"}
RequestTypeFilter
Description
A filter to be used against RequestType object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
type - StringFilter
|
Filter by the object’s type field. |
requestsByType - RequestTypeToManyRequestFilter
|
Filter by the object’s requestsByType relation. |
requestsByTypeExist - Boolean
|
Some related requestsByType exist. |
and - [RequestTypeFilter!]
|
Checks for all expressions in this list. |
or - [RequestTypeFilter!]
|
Checks for any expressions in this list. |
not - RequestTypeFilter
|
Negates the expression. |
Example
{
"type": StringFilter,
"requestsByType": RequestTypeToManyRequestFilter,
"requestsByTypeExist": true,
"and": [RequestTypeFilter],
"or": [RequestTypeFilter],
"not": RequestTypeFilter
}
RequestTypeInput
Description
An input for mutations affecting RequestType
Fields
| Input Field | Description |
|---|---|
type - String
|
Example
{"type": "xyz789"}
RequestTypeToManyRequestFilter
Description
A filter to be used against many Request object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - RequestFilter
|
Every related Request matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - RequestFilter
|
Some related Request matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - RequestFilter
|
No related Request matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": RequestFilter,
"some": RequestFilter,
"none": RequestFilter
}
RequestTypesConnection
Description
A connection to a list of RequestType values.
Fields
| Field Name | Description |
|---|---|
nodes - [RequestType]!
|
A list of RequestType objects. |
edges - [RequestTypesEdge!]!
|
A list of edges which contains the RequestType and cursor to aid in pagination. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The count of all RequestType you could get from the connection. |
Example
{
"nodes": [RequestType],
"edges": [RequestTypesEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
RequestTypesEdge
Description
A RequestType edge in the connection.
Fields
| Field Name | Description |
|---|---|
cursor - Cursor
|
A cursor for use in pagination. |
node - RequestType
|
The RequestType at the end of the edge. |
Example
{
"cursor": Cursor,
"node": RequestType
}
RequestTypesOrderBy
Description
Methods to use when ordering RequestType.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"NATURAL"
RequestsConnection
Description
A connection to a list of Request values.
Fields
| Field Name | Description |
|---|---|
nodes - [Request]!
|
A list of Request objects. |
edges - [RequestsEdge!]!
|
A list of edges which contains the Request and cursor to aid in pagination. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The count of all Request you could get from the connection. |
Example
{
"nodes": [Request],
"edges": [RequestsEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
RequestsEdge
RequestsOrderBy
Description
Methods to use when ordering Request.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NATURAL"
ResendClaimEmailInput
Fields
| Input Field | Description |
|---|---|
accountEmail - String!
|
Example
{"accountEmail": "abc123"}
ResendEmailInput
Description
All input for the resendEmail mutation.
Example
{
"clientMutationId": "abc123",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
ResendEmailPayload
Description
The output of our resendEmail mutation.
Example
{
"clientMutationId": "abc123",
"query": Query
}
ResendExpiredClaimEmailInput
Fields
| Input Field | Description |
|---|---|
id - UUID!
|
Example
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
RestrictionCategoriesConnection
Description
A connection to a list of RestrictionCategory values.
Fields
| Field Name | Description |
|---|---|
nodes - [RestrictionCategory]!
|
A list of RestrictionCategory objects. |
edges - [RestrictionCategoriesEdge!]!
|
A list of edges which contains the RestrictionCategory and cursor to aid in pagination. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The count of all RestrictionCategory you could get from the connection. |
Example
{
"nodes": [RestrictionCategory],
"edges": [RestrictionCategoriesEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
RestrictionCategoriesEdge
Description
A RestrictionCategory edge in the connection.
Fields
| Field Name | Description |
|---|---|
cursor - Cursor
|
A cursor for use in pagination. |
node - RestrictionCategory
|
The RestrictionCategory at the end of the edge. |
Example
{
"cursor": Cursor,
"node": RestrictionCategory
}
RestrictionCategoriesOrderBy
Description
Methods to use when ordering RestrictionCategory.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NATURAL"
RestrictionCategory
Fields
| Field Name | Description |
|---|---|
nodeId - ID!
|
A globally unique identifier. Can be used in various places throughout the system to identify this single value. |
category - String!
|
|
restrictionReasonsByCategory - RestrictionReasonsConnection!
|
Reads and enables pagination through a set of RestrictionReason. |
Arguments
|
|
Example
{
"nodeId": 4,
"category": "abc123",
"restrictionReasonsByCategory": RestrictionReasonsConnection
}
RestrictionCategoryCondition
Description
A condition to be used against RestrictionCategory object types. All fields are tested for equality and combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
category - String
|
Checks for equality with the object’s category field. |
Example
{"category": "abc123"}
RestrictionCategoryFilter
Description
A filter to be used against RestrictionCategory object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
category - StringFilter
|
Filter by the object’s category field. |
restrictionReasonsByCategory - RestrictionCategoryToManyRestrictionReasonFilter
|
Filter by the object’s restrictionReasonsByCategory relation. |
restrictionReasonsByCategoryExist - Boolean
|
Some related restrictionReasonsByCategory exist. |
and - [RestrictionCategoryFilter!]
|
Checks for all expressions in this list. |
or - [RestrictionCategoryFilter!]
|
Checks for any expressions in this list. |
not - RestrictionCategoryFilter
|
Negates the expression. |
Example
{
"category": StringFilter,
"restrictionReasonsByCategory": RestrictionCategoryToManyRestrictionReasonFilter,
"restrictionReasonsByCategoryExist": false,
"and": [RestrictionCategoryFilter],
"or": [RestrictionCategoryFilter],
"not": RestrictionCategoryFilter
}
RestrictionCategoryInput
Description
An input for mutations affecting RestrictionCategory
Fields
| Input Field | Description |
|---|---|
category - String!
|
Example
{"category": "xyz789"}
RestrictionCategoryPatch
Description
Represents an update to a RestrictionCategory. Fields that are set will be updated.
Fields
| Input Field | Description |
|---|---|
category - String
|
Example
{"category": "xyz789"}
RestrictionCategoryToManyRestrictionReasonFilter
Description
A filter to be used against many RestrictionReason object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - RestrictionReasonFilter
|
Every related RestrictionReason matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - RestrictionReasonFilter
|
Some related RestrictionReason matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - RestrictionReasonFilter
|
No related RestrictionReason matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": RestrictionReasonFilter,
"some": RestrictionReasonFilter,
"none": RestrictionReasonFilter
}
RestrictionReason
Fields
| Field Name | Description |
|---|---|
nodeId - ID!
|
A globally unique identifier. Can be used in various places throughout the system to identify this single value. |
id - Int!
|
|
category - String!
|
|
reason - String!
|
|
status - String!
|
|
restrictionCategoryByCategory - RestrictionCategory
|
Reads a single RestrictionCategory that is related to this RestrictionReason. |
accountRestrictionsByReasonId - AccountRestrictionsConnection!
|
Reads and enables pagination through a set of AccountRestriction. |
Arguments
|
|
Example
{
"nodeId": 4,
"id": 987,
"category": "abc123",
"reason": "abc123",
"status": "abc123",
"restrictionCategoryByCategory": RestrictionCategory,
"accountRestrictionsByReasonId": AccountRestrictionsConnection
}
RestrictionReasonCondition
Description
A condition to be used against RestrictionReason object types. All fields are tested for equality and combined with a logical ‘and.’
Example
{
"id": 987,
"category": "xyz789",
"reason": "abc123",
"status": "xyz789"
}
RestrictionReasonFilter
Description
A filter to be used against RestrictionReason object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
id - IntFilter
|
Filter by the object’s id field. |
category - StringFilter
|
Filter by the object’s category field. |
reason - StringFilter
|
Filter by the object’s reason field. |
status - StringFilter
|
Filter by the object’s status field. |
accountRestrictionsByReasonId - RestrictionReasonToManyAccountRestrictionFilter
|
Filter by the object’s accountRestrictionsByReasonId relation. |
accountRestrictionsByReasonIdExist - Boolean
|
Some related accountRestrictionsByReasonId exist. |
restrictionCategoryByCategory - RestrictionCategoryFilter
|
Filter by the object’s restrictionCategoryByCategory relation. |
and - [RestrictionReasonFilter!]
|
Checks for all expressions in this list. |
or - [RestrictionReasonFilter!]
|
Checks for any expressions in this list. |
not - RestrictionReasonFilter
|
Negates the expression. |
Example
{
"id": IntFilter,
"category": StringFilter,
"reason": StringFilter,
"status": StringFilter,
"accountRestrictionsByReasonId": RestrictionReasonToManyAccountRestrictionFilter,
"accountRestrictionsByReasonIdExist": true,
"restrictionCategoryByCategory": RestrictionCategoryFilter,
"and": [RestrictionReasonFilter],
"or": [RestrictionReasonFilter],
"not": RestrictionReasonFilter
}
RestrictionReasonInput
RestrictionReasonPatch
RestrictionReasonToManyAccountRestrictionFilter
Description
A filter to be used against many AccountRestriction object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - AccountRestrictionFilter
|
Every related AccountRestriction matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - AccountRestrictionFilter
|
Some related AccountRestriction matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - AccountRestrictionFilter
|
No related AccountRestriction matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": AccountRestrictionFilter,
"some": AccountRestrictionFilter,
"none": AccountRestrictionFilter
}
RestrictionReasonsConnection
Description
A connection to a list of RestrictionReason values.
Fields
| Field Name | Description |
|---|---|
nodes - [RestrictionReason]!
|
A list of RestrictionReason objects. |
edges - [RestrictionReasonsEdge!]!
|
A list of edges which contains the RestrictionReason and cursor to aid in pagination. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The count of all RestrictionReason you could get from the connection. |
Example
{
"nodes": [RestrictionReason],
"edges": [RestrictionReasonsEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
RestrictionReasonsEdge
Description
A RestrictionReason edge in the connection.
Fields
| Field Name | Description |
|---|---|
cursor - Cursor
|
A cursor for use in pagination. |
node - RestrictionReason
|
The RestrictionReason at the end of the edge. |
Example
{
"cursor": Cursor,
"node": RestrictionReason
}
RestrictionReasonsOrderBy
Description
Methods to use when ordering RestrictionReason.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NATURAL"
Round
Fields
| Field Name | Description |
|---|---|
nodeId - ID!
|
A globally unique identifier. Can be used in various places throughout the system to identify this single value. |
assetId - UUID!
|
|
tokenId - UUID!
|
|
name - String!
|
|
termsUrl - String!
|
|
price - BigFloat!
|
|
opensOn - Datetime!
|
|
closesOn - Datetime!
|
|
status - String!
|
|
total - BigFloat!
|
|
blockchainAddressId - UUID!
|
|
id - UUID!
|
|
securityId - UUID!
|
|
assetByAssetId - Asset
|
Reads a single Asset that is related to this Round. |
tokenByTokenId - Token
|
Reads a single Token that is related to this Round. |
assetStatusByStatus - AssetStatus
|
Reads a single AssetStatus that is related to this Round. |
blockchainAddressByBlockchainAddressId - BlockchainAddress
|
Reads a single BlockchainAddress that is related to this Round. |
securityBySecurityId - Security
|
Reads a single Security that is related to this Round. |
allocationsByRoundId - AllocationsConnection!
|
Reads and enables pagination through a set of Allocation. |
Arguments
|
|
brokerAllocationsByRoundId - BrokerAllocationsConnection!
|
Reads and enables pagination through a set of BrokerAllocation. |
Arguments
|
|
capitalDeploymentsByRoundId - CapitalDeploymentsConnection!
|
Reads and enables pagination through a set of CapitalDeployment. |
Arguments
|
|
issuanceEventsByAssetClassId - IssuanceEventsConnection!
|
Reads and enables pagination through a set of IssuanceEvent. |
Arguments
|
|
trancheBondDatumByRoundId - TrancheBondDatum
|
Reads a single TrancheBondDatum that is related to this Round. |
trancheBondDataByRoundId - TrancheBondDataConnection!
|
Reads and enables pagination through a set of TrancheBondDatum. Please use trancheBondDatumByRoundId instead
|
Arguments
|
|
paymentInstrumentsByRoundId - PaymentInstrumentsConnection!
|
Reads and enables pagination through a set of PaymentInstrument. |
Arguments
|
|
vendorQualificationConstraintsByRoundId - VendorQualificationConstraintsConnection!
|
Reads and enables pagination through a set of VendorQualificationConstraint. |
Arguments
|
|
holdings - BigFloat
|
|
managedUnits - BigFloat
|
|
totalCapitalDeployed - BigFloat
|
|
unitValue - BigFloat
|
|
Example
{
"nodeId": 4,
"assetId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"tokenId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"name": "xyz789",
"termsUrl": "xyz789",
"price": BigFloat,
"opensOn": Datetime,
"closesOn": Datetime,
"status": "xyz789",
"total": BigFloat,
"blockchainAddressId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"securityId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"assetByAssetId": Asset,
"tokenByTokenId": Token,
"assetStatusByStatus": AssetStatus,
"blockchainAddressByBlockchainAddressId": BlockchainAddress,
"securityBySecurityId": Security,
"allocationsByRoundId": AllocationsConnection,
"brokerAllocationsByRoundId": BrokerAllocationsConnection,
"capitalDeploymentsByRoundId": CapitalDeploymentsConnection,
"issuanceEventsByAssetClassId": IssuanceEventsConnection,
"trancheBondDatumByRoundId": TrancheBondDatum,
"trancheBondDataByRoundId": TrancheBondDataConnection,
"paymentInstrumentsByRoundId": PaymentInstrumentsConnection,
"vendorQualificationConstraintsByRoundId": VendorQualificationConstraintsConnection,
"holdings": BigFloat,
"managedUnits": BigFloat,
"totalCapitalDeployed": BigFloat,
"unitValue": BigFloat
}
RoundCondition
Description
A condition to be used against Round object types. All fields are tested for equality and combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
assetId - UUID
|
Checks for equality with the object’s assetId field. |
tokenId - UUID
|
Checks for equality with the object’s tokenId field. |
name - String
|
Checks for equality with the object’s name field. |
termsUrl - String
|
Checks for equality with the object’s termsUrl field. |
price - BigFloat
|
Checks for equality with the object’s price field. |
opensOn - Datetime
|
Checks for equality with the object’s opensOn field. |
closesOn - Datetime
|
Checks for equality with the object’s closesOn field. |
status - String
|
Checks for equality with the object’s status field. |
total - BigFloat
|
Checks for equality with the object’s total field. |
blockchainAddressId - UUID
|
Checks for equality with the object’s blockchainAddressId field. |
id - UUID
|
Checks for equality with the object’s id field. |
securityId - UUID
|
Checks for equality with the object’s securityId field. |
Example
{
"assetId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"tokenId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"name": "abc123",
"termsUrl": "abc123",
"price": BigFloat,
"opensOn": Datetime,
"closesOn": Datetime,
"status": "xyz789",
"total": BigFloat,
"blockchainAddressId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"securityId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
RoundFilter
Description
A filter to be used against Round object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
assetId - UUIDFilter
|
Filter by the object’s assetId field. |
tokenId - UUIDFilter
|
Filter by the object’s tokenId field. |
name - StringFilter
|
Filter by the object’s name field. |
termsUrl - StringFilter
|
Filter by the object’s termsUrl field. |
price - BigFloatFilter
|
Filter by the object’s price field. |
opensOn - DatetimeFilter
|
Filter by the object’s opensOn field. |
closesOn - DatetimeFilter
|
Filter by the object’s closesOn field. |
status - StringFilter
|
Filter by the object’s status field. |
total - BigFloatFilter
|
Filter by the object’s total field. |
blockchainAddressId - UUIDFilter
|
Filter by the object’s blockchainAddressId field. |
id - UUIDFilter
|
Filter by the object’s id field. |
securityId - UUIDFilter
|
Filter by the object’s securityId field. |
holdings - BigFloatFilter
|
Filter by the object’s holdings field. |
managedUnits - BigFloatFilter
|
Filter by the object’s managedUnits field. |
totalCapitalDeployed - BigFloatFilter
|
Filter by the object’s totalCapitalDeployed field. |
unitValue - BigFloatFilter
|
Filter by the object’s unitValue field. |
allocationsByRoundId - RoundToManyAllocationFilter
|
Filter by the object’s allocationsByRoundId relation. |
allocationsByRoundIdExist - Boolean
|
Some related allocationsByRoundId exist. |
brokerAllocationsByRoundId - RoundToManyBrokerAllocationFilter
|
Filter by the object’s brokerAllocationsByRoundId relation. |
brokerAllocationsByRoundIdExist - Boolean
|
Some related brokerAllocationsByRoundId exist. |
capitalDeploymentsByRoundId - RoundToManyCapitalDeploymentFilter
|
Filter by the object’s capitalDeploymentsByRoundId relation. |
capitalDeploymentsByRoundIdExist - Boolean
|
Some related capitalDeploymentsByRoundId exist. |
issuanceEventsByAssetClassId - RoundToManyIssuanceEventFilter
|
Filter by the object’s issuanceEventsByAssetClassId relation. |
issuanceEventsByAssetClassIdExist - Boolean
|
Some related issuanceEventsByAssetClassId exist. |
trancheBondDatumByRoundId - TrancheBondDatumFilter
|
Filter by the object’s trancheBondDatumByRoundId relation. |
trancheBondDatumByRoundIdExists - Boolean
|
A related trancheBondDatumByRoundId exists. |
paymentInstrumentsByRoundId - RoundToManyPaymentInstrumentFilter
|
Filter by the object’s paymentInstrumentsByRoundId relation. |
paymentInstrumentsByRoundIdExist - Boolean
|
Some related paymentInstrumentsByRoundId exist. |
vendorQualificationConstraintsByRoundId - RoundToManyVendorQualificationConstraintFilter
|
Filter by the object’s vendorQualificationConstraintsByRoundId relation. |
vendorQualificationConstraintsByRoundIdExist - Boolean
|
Some related vendorQualificationConstraintsByRoundId exist. |
assetByAssetId - AssetFilter
|
Filter by the object’s assetByAssetId relation. |
tokenByTokenId - TokenFilter
|
Filter by the object’s tokenByTokenId relation. |
assetStatusByStatus - AssetStatusFilter
|
Filter by the object’s assetStatusByStatus relation. |
blockchainAddressByBlockchainAddressId - BlockchainAddressFilter
|
Filter by the object’s blockchainAddressByBlockchainAddressId relation. |
securityBySecurityId - SecurityFilter
|
Filter by the object’s securityBySecurityId relation. |
and - [RoundFilter!]
|
Checks for all expressions in this list. |
or - [RoundFilter!]
|
Checks for any expressions in this list. |
not - RoundFilter
|
Negates the expression. |
Example
{
"assetId": UUIDFilter,
"tokenId": UUIDFilter,
"name": StringFilter,
"termsUrl": StringFilter,
"price": BigFloatFilter,
"opensOn": DatetimeFilter,
"closesOn": DatetimeFilter,
"status": StringFilter,
"total": BigFloatFilter,
"blockchainAddressId": UUIDFilter,
"id": UUIDFilter,
"securityId": UUIDFilter,
"holdings": BigFloatFilter,
"managedUnits": BigFloatFilter,
"totalCapitalDeployed": BigFloatFilter,
"unitValue": BigFloatFilter,
"allocationsByRoundId": RoundToManyAllocationFilter,
"allocationsByRoundIdExist": false,
"brokerAllocationsByRoundId": RoundToManyBrokerAllocationFilter,
"brokerAllocationsByRoundIdExist": true,
"capitalDeploymentsByRoundId": RoundToManyCapitalDeploymentFilter,
"capitalDeploymentsByRoundIdExist": true,
"issuanceEventsByAssetClassId": RoundToManyIssuanceEventFilter,
"issuanceEventsByAssetClassIdExist": false,
"trancheBondDatumByRoundId": TrancheBondDatumFilter,
"trancheBondDatumByRoundIdExists": true,
"paymentInstrumentsByRoundId": RoundToManyPaymentInstrumentFilter,
"paymentInstrumentsByRoundIdExist": false,
"vendorQualificationConstraintsByRoundId": RoundToManyVendorQualificationConstraintFilter,
"vendorQualificationConstraintsByRoundIdExist": false,
"assetByAssetId": AssetFilter,
"tokenByTokenId": TokenFilter,
"assetStatusByStatus": AssetStatusFilter,
"blockchainAddressByBlockchainAddressId": BlockchainAddressFilter,
"securityBySecurityId": SecurityFilter,
"and": [RoundFilter],
"or": [RoundFilter],
"not": RoundFilter
}
RoundInput
Description
An input for mutations affecting Round
Example
{
"assetId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"tokenId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"name": "xyz789",
"termsUrl": "abc123",
"price": BigFloat,
"opensOn": Datetime,
"closesOn": Datetime,
"status": "xyz789",
"total": BigFloat,
"blockchainAddressId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"securityId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
RoundPatch
Description
Represents an update to a Round. Fields that are set will be updated.
Example
{
"assetId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"tokenId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"name": "abc123",
"termsUrl": "xyz789",
"price": BigFloat,
"opensOn": Datetime,
"closesOn": Datetime,
"status": "abc123",
"total": BigFloat,
"blockchainAddressId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"securityId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
RoundToManyAllocationFilter
Description
A filter to be used against many Allocation object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - AllocationFilter
|
Every related Allocation matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - AllocationFilter
|
Some related Allocation matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - AllocationFilter
|
No related Allocation matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": AllocationFilter,
"some": AllocationFilter,
"none": AllocationFilter
}
RoundToManyBrokerAllocationFilter
Description
A filter to be used against many BrokerAllocation object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - BrokerAllocationFilter
|
Every related BrokerAllocation matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - BrokerAllocationFilter
|
Some related BrokerAllocation matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - BrokerAllocationFilter
|
No related BrokerAllocation matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": BrokerAllocationFilter,
"some": BrokerAllocationFilter,
"none": BrokerAllocationFilter
}
RoundToManyCapitalDeploymentFilter
Description
A filter to be used against many CapitalDeployment object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - CapitalDeploymentFilter
|
Every related CapitalDeployment matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - CapitalDeploymentFilter
|
Some related CapitalDeployment matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - CapitalDeploymentFilter
|
No related CapitalDeployment matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": CapitalDeploymentFilter,
"some": CapitalDeploymentFilter,
"none": CapitalDeploymentFilter
}
RoundToManyIssuanceEventFilter
Description
A filter to be used against many IssuanceEvent object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - IssuanceEventFilter
|
Every related IssuanceEvent matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - IssuanceEventFilter
|
Some related IssuanceEvent matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - IssuanceEventFilter
|
No related IssuanceEvent matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": IssuanceEventFilter,
"some": IssuanceEventFilter,
"none": IssuanceEventFilter
}
RoundToManyPaymentInstrumentFilter
Description
A filter to be used against many PaymentInstrument object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - PaymentInstrumentFilter
|
Every related PaymentInstrument matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - PaymentInstrumentFilter
|
Some related PaymentInstrument matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - PaymentInstrumentFilter
|
No related PaymentInstrument matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": PaymentInstrumentFilter,
"some": PaymentInstrumentFilter,
"none": PaymentInstrumentFilter
}
RoundToManyVendorQualificationConstraintFilter
Description
A filter to be used against many VendorQualificationConstraint object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - VendorQualificationConstraintFilter
|
Every related VendorQualificationConstraint matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - VendorQualificationConstraintFilter
|
Some related VendorQualificationConstraint matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - VendorQualificationConstraintFilter
|
No related VendorQualificationConstraint matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": VendorQualificationConstraintFilter,
"some": VendorQualificationConstraintFilter,
"none": VendorQualificationConstraintFilter
}
RoundsConnection
Description
A connection to a list of Round values.
Fields
| Field Name | Description |
|---|---|
nodes - [Round]!
|
A list of Round objects. |
edges - [RoundsEdge!]!
|
A list of edges which contains the Round and cursor to aid in pagination. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The count of all Round you could get from the connection. |
Example
{
"nodes": [Round],
"edges": [RoundsEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
RoundsEdge
RoundsOrderBy
Description
Methods to use when ordering Round.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NATURAL"
SecuritiesConnection
Description
A connection to a list of Security values.
Fields
| Field Name | Description |
|---|---|
nodes - [Security]!
|
A list of Security objects. |
edges - [SecuritiesEdge!]!
|
A list of edges which contains the Security and cursor to aid in pagination. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The count of all Security you could get from the connection. |
Example
{
"nodes": [Security],
"edges": [SecuritiesEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
SecuritiesEdge
SecuritiesOrderBy
Description
Methods to use when ordering Security.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NATURAL"
Security
Fields
| Field Name | Description |
|---|---|
nodeId - ID!
|
A globally unique identifier. Can be used in various places throughout the system to identify this single value. |
id - UUID!
|
|
issuerId - UUID!
|
|
unitValue - BigFloat!
|
|
name - String!
|
|
ticker - String
|
|
total - BigFloat!
|
|
blockchainAddressId - UUID!
|
|
taId - UUID!
|
|
accountByIssuerId - Account
|
Reads a single Account that is related to this Security. |
blockchainAddressByBlockchainAddressId - BlockchainAddress
|
Reads a single BlockchainAddress that is related to this Security. |
accountByTaId - Account
|
Reads a single Account that is related to this Security. |
roundsBySecurityId - RoundsConnection!
|
Reads and enables pagination through a set of Round. |
Arguments
|
|
holdingsBySecurityId - HoldingsConnection!
|
Reads and enables pagination through a set of Holding. |
Arguments
|
|
issuanceEventsBySecurityId - IssuanceEventsConnection!
|
Reads and enables pagination through a set of IssuanceEvent. |
Arguments
|
|
securityListingBySecurityId - SecurityListing
|
Reads a single SecurityListing that is related to this Security. |
securityListingsBySecurityId - SecurityListingsConnection!
|
Reads and enables pagination through a set of SecurityListing. Please use securityListingBySecurityId instead
|
Arguments
|
|
securityDocumentsBySecurityId - SecurityDocumentsConnection!
|
Reads and enables pagination through a set of SecurityDocument. |
Arguments
|
|
omnibusHoldingsBySecurityId - OmnibusHoldingsConnection!
|
Reads and enables pagination through a set of OmnibusHolding. |
Arguments
|
|
omnibusInvestorsBySecurityId - OmnibusInvestorsConnection!
|
Reads and enables pagination through a set of OmnibusInvestor. |
Arguments
|
|
stagedBalanceTransfersBySecurityId - StagedBalanceTransfersConnection!
|
Reads and enables pagination through a set of StagedBalanceTransfer. |
Arguments
|
|
stagedTransfersBySecurityId - StagedTransfersConnection!
|
Reads and enables pagination through a set of StagedTransfer. |
Arguments
|
|
tradesBySecurityId - TradesConnection!
|
Reads and enables pagination through a set of Trade. |
Arguments
|
|
transfersBySecurityId - TransfersConnection!
|
Reads and enables pagination through a set of Transfer. |
Arguments
|
|
Example
{
"nodeId": 4,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"issuerId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"unitValue": BigFloat,
"name": "abc123",
"ticker": "xyz789",
"total": BigFloat,
"blockchainAddressId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"taId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountByIssuerId": Account,
"blockchainAddressByBlockchainAddressId": BlockchainAddress,
"accountByTaId": Account,
"roundsBySecurityId": RoundsConnection,
"holdingsBySecurityId": HoldingsConnection,
"issuanceEventsBySecurityId": IssuanceEventsConnection,
"securityListingBySecurityId": SecurityListing,
"securityListingsBySecurityId": SecurityListingsConnection,
"securityDocumentsBySecurityId": SecurityDocumentsConnection,
"omnibusHoldingsBySecurityId": OmnibusHoldingsConnection,
"omnibusInvestorsBySecurityId": OmnibusInvestorsConnection,
"stagedBalanceTransfersBySecurityId": StagedBalanceTransfersConnection,
"stagedTransfersBySecurityId": StagedTransfersConnection,
"tradesBySecurityId": TradesConnection,
"transfersBySecurityId": TransfersConnection
}
SecurityCondition
Description
A condition to be used against Security object types. All fields are tested for equality and combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
id - UUID
|
Checks for equality with the object’s id field. |
issuerId - UUID
|
Checks for equality with the object’s issuerId field. |
unitValue - BigFloat
|
Checks for equality with the object’s unitValue field. |
name - String
|
Checks for equality with the object’s name field. |
ticker - String
|
Checks for equality with the object’s ticker field. |
total - BigFloat
|
Checks for equality with the object’s total field. |
blockchainAddressId - UUID
|
Checks for equality with the object’s blockchainAddressId field. |
taId - UUID
|
Checks for equality with the object’s taId field. |
Example
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"issuerId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"unitValue": BigFloat,
"name": "abc123",
"ticker": "xyz789",
"total": BigFloat,
"blockchainAddressId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"taId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
SecurityDocument
Fields
| Field Name | Description |
|---|---|
nodeId - ID!
|
A globally unique identifier. Can be used in various places throughout the system to identify this single value. |
id - UUID!
|
|
documentId - UUID!
|
|
securityId - UUID!
|
|
createdOn - Datetime!
|
|
documentByDocumentId - Document
|
Reads a single Document that is related to this SecurityDocument. |
securityBySecurityId - Security
|
Reads a single Security that is related to this SecurityDocument. |
Example
{
"nodeId": 4,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"documentId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"securityId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"createdOn": Datetime,
"documentByDocumentId": Document,
"securityBySecurityId": Security
}
SecurityDocumentCondition
Description
A condition to be used against SecurityDocument object types. All fields are tested for equality and combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
id - UUID
|
Checks for equality with the object’s id field. |
documentId - UUID
|
Checks for equality with the object’s documentId field. |
securityId - UUID
|
Checks for equality with the object’s securityId field. |
createdOn - Datetime
|
Checks for equality with the object’s createdOn field. |
Example
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"documentId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"securityId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"createdOn": Datetime
}
SecurityDocumentFilter
Description
A filter to be used against SecurityDocument object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
id - UUIDFilter
|
Filter by the object’s id field. |
documentId - UUIDFilter
|
Filter by the object’s documentId field. |
securityId - UUIDFilter
|
Filter by the object’s securityId field. |
createdOn - DatetimeFilter
|
Filter by the object’s createdOn field. |
documentByDocumentId - DocumentFilter
|
Filter by the object’s documentByDocumentId relation. |
securityBySecurityId - SecurityFilter
|
Filter by the object’s securityBySecurityId relation. |
and - [SecurityDocumentFilter!]
|
Checks for all expressions in this list. |
or - [SecurityDocumentFilter!]
|
Checks for any expressions in this list. |
not - SecurityDocumentFilter
|
Negates the expression. |
Example
{
"id": UUIDFilter,
"documentId": UUIDFilter,
"securityId": UUIDFilter,
"createdOn": DatetimeFilter,
"documentByDocumentId": DocumentFilter,
"securityBySecurityId": SecurityFilter,
"and": [SecurityDocumentFilter],
"or": [SecurityDocumentFilter],
"not": SecurityDocumentFilter
}
SecurityDocumentUpload
Fields
| Field Name | Description |
|---|---|
uploadInfo - JSON
|
|
securityDocumentId - UUID
|
|
accountDocumentId - UUID
|
|
documentId - UUID
|
|
securityDocumentBySecurityDocumentId - SecurityDocument
|
|
accountDocumentByAccountDocumentId - AccountDocument
|
|
documentByDocumentId - Document
|
Example
{
"uploadInfo": {},
"securityDocumentId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountDocumentId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"documentId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"securityDocumentBySecurityDocumentId": SecurityDocument,
"accountDocumentByAccountDocumentId": AccountDocument,
"documentByDocumentId": Document
}
SecurityDocumentsConnection
Description
A connection to a list of SecurityDocument values.
Fields
| Field Name | Description |
|---|---|
nodes - [SecurityDocument]!
|
A list of SecurityDocument objects. |
edges - [SecurityDocumentsEdge!]!
|
A list of edges which contains the SecurityDocument and cursor to aid in pagination. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The count of all SecurityDocument you could get from the connection. |
Example
{
"nodes": [SecurityDocument],
"edges": [SecurityDocumentsEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
SecurityDocumentsEdge
Description
A SecurityDocument edge in the connection.
Fields
| Field Name | Description |
|---|---|
cursor - Cursor
|
A cursor for use in pagination. |
node - SecurityDocument
|
The SecurityDocument at the end of the edge. |
Example
{
"cursor": Cursor,
"node": SecurityDocument
}
SecurityDocumentsOrderBy
Description
Methods to use when ordering SecurityDocument.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NATURAL"
SecurityFilter
Description
A filter to be used against Security object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
id - UUIDFilter
|
Filter by the object’s id field. |
issuerId - UUIDFilter
|
Filter by the object’s issuerId field. |
unitValue - BigFloatFilter
|
Filter by the object’s unitValue field. |
name - StringFilter
|
Filter by the object’s name field. |
ticker - StringFilter
|
Filter by the object’s ticker field. |
total - BigFloatFilter
|
Filter by the object’s total field. |
blockchainAddressId - UUIDFilter
|
Filter by the object’s blockchainAddressId field. |
taId - UUIDFilter
|
Filter by the object’s taId field. |
roundsBySecurityId - SecurityToManyRoundFilter
|
Filter by the object’s roundsBySecurityId relation. |
roundsBySecurityIdExist - Boolean
|
Some related roundsBySecurityId exist. |
holdingsBySecurityId - SecurityToManyHoldingFilter
|
Filter by the object’s holdingsBySecurityId relation. |
holdingsBySecurityIdExist - Boolean
|
Some related holdingsBySecurityId exist. |
issuanceEventsBySecurityId - SecurityToManyIssuanceEventFilter
|
Filter by the object’s issuanceEventsBySecurityId relation. |
issuanceEventsBySecurityIdExist - Boolean
|
Some related issuanceEventsBySecurityId exist. |
securityListingBySecurityId - SecurityListingFilter
|
Filter by the object’s securityListingBySecurityId relation. |
securityListingBySecurityIdExists - Boolean
|
A related securityListingBySecurityId exists. |
securityDocumentsBySecurityId - SecurityToManySecurityDocumentFilter
|
Filter by the object’s securityDocumentsBySecurityId relation. |
securityDocumentsBySecurityIdExist - Boolean
|
Some related securityDocumentsBySecurityId exist. |
omnibusHoldingsBySecurityId - SecurityToManyOmnibusHoldingFilter
|
Filter by the object’s omnibusHoldingsBySecurityId relation. |
omnibusHoldingsBySecurityIdExist - Boolean
|
Some related omnibusHoldingsBySecurityId exist. |
omnibusInvestorsBySecurityId - SecurityToManyOmnibusInvestorFilter
|
Filter by the object’s omnibusInvestorsBySecurityId relation. |
omnibusInvestorsBySecurityIdExist - Boolean
|
Some related omnibusInvestorsBySecurityId exist. |
stagedBalanceTransfersBySecurityId - SecurityToManyStagedBalanceTransferFilter
|
Filter by the object’s stagedBalanceTransfersBySecurityId relation. |
stagedBalanceTransfersBySecurityIdExist - Boolean
|
Some related stagedBalanceTransfersBySecurityId exist. |
stagedTransfersBySecurityId - SecurityToManyStagedTransferFilter
|
Filter by the object’s stagedTransfersBySecurityId relation. |
stagedTransfersBySecurityIdExist - Boolean
|
Some related stagedTransfersBySecurityId exist. |
tradesBySecurityId - SecurityToManyTradeFilter
|
Filter by the object’s tradesBySecurityId relation. |
tradesBySecurityIdExist - Boolean
|
Some related tradesBySecurityId exist. |
transfersBySecurityId - SecurityToManyTransferFilter
|
Filter by the object’s transfersBySecurityId relation. |
transfersBySecurityIdExist - Boolean
|
Some related transfersBySecurityId exist. |
accountByIssuerId - AccountFilter
|
Filter by the object’s accountByIssuerId relation. |
blockchainAddressByBlockchainAddressId - BlockchainAddressFilter
|
Filter by the object’s blockchainAddressByBlockchainAddressId relation. |
accountByTaId - AccountFilter
|
Filter by the object’s accountByTaId relation. |
and - [SecurityFilter!]
|
Checks for all expressions in this list. |
or - [SecurityFilter!]
|
Checks for any expressions in this list. |
not - SecurityFilter
|
Negates the expression. |
Example
{
"id": UUIDFilter,
"issuerId": UUIDFilter,
"unitValue": BigFloatFilter,
"name": StringFilter,
"ticker": StringFilter,
"total": BigFloatFilter,
"blockchainAddressId": UUIDFilter,
"taId": UUIDFilter,
"roundsBySecurityId": SecurityToManyRoundFilter,
"roundsBySecurityIdExist": true,
"holdingsBySecurityId": SecurityToManyHoldingFilter,
"holdingsBySecurityIdExist": false,
"issuanceEventsBySecurityId": SecurityToManyIssuanceEventFilter,
"issuanceEventsBySecurityIdExist": true,
"securityListingBySecurityId": SecurityListingFilter,
"securityListingBySecurityIdExists": false,
"securityDocumentsBySecurityId": SecurityToManySecurityDocumentFilter,
"securityDocumentsBySecurityIdExist": false,
"omnibusHoldingsBySecurityId": SecurityToManyOmnibusHoldingFilter,
"omnibusHoldingsBySecurityIdExist": false,
"omnibusInvestorsBySecurityId": SecurityToManyOmnibusInvestorFilter,
"omnibusInvestorsBySecurityIdExist": false,
"stagedBalanceTransfersBySecurityId": SecurityToManyStagedBalanceTransferFilter,
"stagedBalanceTransfersBySecurityIdExist": true,
"stagedTransfersBySecurityId": SecurityToManyStagedTransferFilter,
"stagedTransfersBySecurityIdExist": false,
"tradesBySecurityId": SecurityToManyTradeFilter,
"tradesBySecurityIdExist": true,
"transfersBySecurityId": SecurityToManyTransferFilter,
"transfersBySecurityIdExist": false,
"accountByIssuerId": AccountFilter,
"blockchainAddressByBlockchainAddressId": BlockchainAddressFilter,
"accountByTaId": AccountFilter,
"and": [SecurityFilter],
"or": [SecurityFilter],
"not": SecurityFilter
}
SecurityListing
Fields
| Field Name | Description |
|---|---|
nodeId - ID!
|
A globally unique identifier. Can be used in various places throughout the system to identify this single value. |
id - UUID!
|
|
securityId - UUID!
|
|
issuerId - UUID!
|
|
atsId - UUID!
|
|
status - String!
|
|
securityBySecurityId - Security
|
Reads a single Security that is related to this SecurityListing. |
accountByIssuerId - Account
|
Reads a single Account that is related to this SecurityListing. |
accountByAtsId - Account
|
Reads a single Account that is related to this SecurityListing. |
invitationStatusByStatus - InvitationStatus
|
Reads a single InvitationStatus that is related to this SecurityListing. |
Example
{
"nodeId": "4",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"securityId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"issuerId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"atsId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"status": "xyz789",
"securityBySecurityId": Security,
"accountByIssuerId": Account,
"accountByAtsId": Account,
"invitationStatusByStatus": InvitationStatus
}
SecurityListingCondition
Description
A condition to be used against SecurityListing object types. All fields are tested for equality and combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
id - UUID
|
Checks for equality with the object’s id field. |
securityId - UUID
|
Checks for equality with the object’s securityId field. |
issuerId - UUID
|
Checks for equality with the object’s issuerId field. |
atsId - UUID
|
Checks for equality with the object’s atsId field. |
status - String
|
Checks for equality with the object’s status field. |
Example
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"securityId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"issuerId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"atsId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"status": "xyz789"
}
SecurityListingFilter
Description
A filter to be used against SecurityListing object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
id - UUIDFilter
|
Filter by the object’s id field. |
securityId - UUIDFilter
|
Filter by the object’s securityId field. |
issuerId - UUIDFilter
|
Filter by the object’s issuerId field. |
atsId - UUIDFilter
|
Filter by the object’s atsId field. |
status - StringFilter
|
Filter by the object’s status field. |
securityBySecurityId - SecurityFilter
|
Filter by the object’s securityBySecurityId relation. |
accountByIssuerId - AccountFilter
|
Filter by the object’s accountByIssuerId relation. |
accountByAtsId - AccountFilter
|
Filter by the object’s accountByAtsId relation. |
invitationStatusByStatus - InvitationStatusFilter
|
Filter by the object’s invitationStatusByStatus relation. |
and - [SecurityListingFilter!]
|
Checks for all expressions in this list. |
or - [SecurityListingFilter!]
|
Checks for any expressions in this list. |
not - SecurityListingFilter
|
Negates the expression. |
Example
{
"id": UUIDFilter,
"securityId": UUIDFilter,
"issuerId": UUIDFilter,
"atsId": UUIDFilter,
"status": StringFilter,
"securityBySecurityId": SecurityFilter,
"accountByIssuerId": AccountFilter,
"accountByAtsId": AccountFilter,
"invitationStatusByStatus": InvitationStatusFilter,
"and": [SecurityListingFilter],
"or": [SecurityListingFilter],
"not": SecurityListingFilter
}
SecurityListingsConnection
Description
A connection to a list of SecurityListing values.
Fields
| Field Name | Description |
|---|---|
nodes - [SecurityListing]!
|
A list of SecurityListing objects. |
edges - [SecurityListingsEdge!]!
|
A list of edges which contains the SecurityListing and cursor to aid in pagination. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The count of all SecurityListing you could get from the connection. |
Example
{
"nodes": [SecurityListing],
"edges": [SecurityListingsEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
SecurityListingsEdge
Description
A SecurityListing edge in the connection.
Fields
| Field Name | Description |
|---|---|
cursor - Cursor
|
A cursor for use in pagination. |
node - SecurityListing
|
The SecurityListing at the end of the edge. |
Example
{
"cursor": Cursor,
"node": SecurityListing
}
SecurityListingsOrderBy
Description
Methods to use when ordering SecurityListing.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NATURAL"
SecurityPatch
Description
Represents an update to a Security. Fields that are set will be updated.
Example
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"issuerId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"unitValue": BigFloat,
"name": "abc123",
"ticker": "abc123",
"total": BigFloat,
"blockchainAddressId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"taId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
SecurityToManyHoldingFilter
Description
A filter to be used against many Holding object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - HoldingFilter
|
Every related Holding matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - HoldingFilter
|
Some related Holding matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - HoldingFilter
|
No related Holding matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": HoldingFilter,
"some": HoldingFilter,
"none": HoldingFilter
}
SecurityToManyIssuanceEventFilter
Description
A filter to be used against many IssuanceEvent object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - IssuanceEventFilter
|
Every related IssuanceEvent matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - IssuanceEventFilter
|
Some related IssuanceEvent matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - IssuanceEventFilter
|
No related IssuanceEvent matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": IssuanceEventFilter,
"some": IssuanceEventFilter,
"none": IssuanceEventFilter
}
SecurityToManyOmnibusHoldingFilter
Description
A filter to be used against many OmnibusHolding object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - OmnibusHoldingFilter
|
Every related OmnibusHolding matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - OmnibusHoldingFilter
|
Some related OmnibusHolding matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - OmnibusHoldingFilter
|
No related OmnibusHolding matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": OmnibusHoldingFilter,
"some": OmnibusHoldingFilter,
"none": OmnibusHoldingFilter
}
SecurityToManyOmnibusInvestorFilter
Description
A filter to be used against many OmnibusInvestor object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - OmnibusInvestorFilter
|
Every related OmnibusInvestor matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - OmnibusInvestorFilter
|
Some related OmnibusInvestor matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - OmnibusInvestorFilter
|
No related OmnibusInvestor matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": OmnibusInvestorFilter,
"some": OmnibusInvestorFilter,
"none": OmnibusInvestorFilter
}
SecurityToManyRoundFilter
Description
A filter to be used against many Round object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - RoundFilter
|
Every related Round matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - RoundFilter
|
Some related Round matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - RoundFilter
|
No related Round matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": RoundFilter,
"some": RoundFilter,
"none": RoundFilter
}
SecurityToManySecurityDocumentFilter
Description
A filter to be used against many SecurityDocument object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - SecurityDocumentFilter
|
Every related SecurityDocument matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - SecurityDocumentFilter
|
Some related SecurityDocument matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - SecurityDocumentFilter
|
No related SecurityDocument matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": SecurityDocumentFilter,
"some": SecurityDocumentFilter,
"none": SecurityDocumentFilter
}
SecurityToManyStagedBalanceTransferFilter
Description
A filter to be used against many StagedBalanceTransfer object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - StagedBalanceTransferFilter
|
Every related StagedBalanceTransfer matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - StagedBalanceTransferFilter
|
Some related StagedBalanceTransfer matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - StagedBalanceTransferFilter
|
No related StagedBalanceTransfer matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": StagedBalanceTransferFilter,
"some": StagedBalanceTransferFilter,
"none": StagedBalanceTransferFilter
}
SecurityToManyStagedTransferFilter
Description
A filter to be used against many StagedTransfer object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - StagedTransferFilter
|
Every related StagedTransfer matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - StagedTransferFilter
|
Some related StagedTransfer matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - StagedTransferFilter
|
No related StagedTransfer matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": StagedTransferFilter,
"some": StagedTransferFilter,
"none": StagedTransferFilter
}
SecurityToManyTradeFilter
Description
A filter to be used against many Trade object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - TradeFilter
|
Every related Trade matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - TradeFilter
|
Some related Trade matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - TradeFilter
|
No related Trade matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": TradeFilter,
"some": TradeFilter,
"none": TradeFilter
}
SecurityToManyTransferFilter
Description
A filter to be used against many Transfer object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - TransferFilter
|
Every related Transfer matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - TransferFilter
|
Some related Transfer matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - TransferFilter
|
No related Transfer matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": TransferFilter,
"some": TransferFilter,
"none": TransferFilter
}
SendClaimAccountEmailInput
Description
All input for the sendClaimAccountEmail mutation.
Example
{
"clientMutationId": "abc123",
"email": "xyz789"
}
SendClaimAccountEmailPayload
Description
The output of our sendClaimAccountEmail mutation.
Example
{
"clientMutationId": "xyz789",
"query": Query
}
SentSigningDocument
Fields
| Field Name | Description |
|---|---|
nodeId - ID!
|
A globally unique identifier. Can be used in various places throughout the system to identify this single value. |
id - UUID!
|
|
mappedSigningTemplateId - UUID!
|
|
stepId - UUID!
|
|
sentTo - UUID!
|
|
status - String!
|
|
documentUri - String!
|
|
documentId - String!
|
|
sentOn - Datetime
|
|
completeOn - Datetime
|
|
mappedSigningTemplateByMappedSigningTemplateId - MappedSigningTemplate
|
Reads a single MappedSigningTemplate that is related to this SentSigningDocument. |
stepByStepId - Step
|
Reads a single Step that is related to this SentSigningDocument. |
accountBySentTo - Account
|
Reads a single Account that is related to this SentSigningDocument. |
sentSigningDocumentStatusByStatus - SentSigningDocumentStatus
|
Reads a single SentSigningDocumentStatus that is related to this SentSigningDocument. |
Example
{
"nodeId": 4,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"mappedSigningTemplateId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"stepId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"sentTo": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"status": "abc123",
"documentUri": "abc123",
"documentId": "abc123",
"sentOn": Datetime,
"completeOn": Datetime,
"mappedSigningTemplateByMappedSigningTemplateId": MappedSigningTemplate,
"stepByStepId": Step,
"accountBySentTo": Account,
"sentSigningDocumentStatusByStatus": SentSigningDocumentStatus
}
SentSigningDocumentCondition
Description
A condition to be used against SentSigningDocument object types. All fields are tested for equality and combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
id - UUID
|
Checks for equality with the object’s id field. |
mappedSigningTemplateId - UUID
|
Checks for equality with the object’s mappedSigningTemplateId field. |
stepId - UUID
|
Checks for equality with the object’s stepId field. |
sentTo - UUID
|
Checks for equality with the object’s sentTo field. |
status - String
|
Checks for equality with the object’s status field. |
documentUri - String
|
Checks for equality with the object’s documentUri field. |
documentId - String
|
Checks for equality with the object’s documentId field. |
sentOn - Datetime
|
Checks for equality with the object’s sentOn field. |
completeOn - Datetime
|
Checks for equality with the object’s completeOn field. |
Example
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"mappedSigningTemplateId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"stepId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"sentTo": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"status": "xyz789",
"documentUri": "xyz789",
"documentId": "xyz789",
"sentOn": Datetime,
"completeOn": Datetime
}
SentSigningDocumentFilter
Description
A filter to be used against SentSigningDocument object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
id - UUIDFilter
|
Filter by the object’s id field. |
mappedSigningTemplateId - UUIDFilter
|
Filter by the object’s mappedSigningTemplateId field. |
stepId - UUIDFilter
|
Filter by the object’s stepId field. |
sentTo - UUIDFilter
|
Filter by the object’s sentTo field. |
status - StringFilter
|
Filter by the object’s status field. |
documentUri - StringFilter
|
Filter by the object’s documentUri field. |
documentId - StringFilter
|
Filter by the object’s documentId field. |
sentOn - DatetimeFilter
|
Filter by the object’s sentOn field. |
completeOn - DatetimeFilter
|
Filter by the object’s completeOn field. |
mappedSigningTemplateByMappedSigningTemplateId - MappedSigningTemplateFilter
|
Filter by the object’s mappedSigningTemplateByMappedSigningTemplateId relation. |
stepByStepId - StepFilter
|
Filter by the object’s stepByStepId relation. |
accountBySentTo - AccountFilter
|
Filter by the object’s accountBySentTo relation. |
sentSigningDocumentStatusByStatus - SentSigningDocumentStatusFilter
|
Filter by the object’s sentSigningDocumentStatusByStatus relation. |
and - [SentSigningDocumentFilter!]
|
Checks for all expressions in this list. |
or - [SentSigningDocumentFilter!]
|
Checks for any expressions in this list. |
not - SentSigningDocumentFilter
|
Negates the expression. |
Example
{
"id": UUIDFilter,
"mappedSigningTemplateId": UUIDFilter,
"stepId": UUIDFilter,
"sentTo": UUIDFilter,
"status": StringFilter,
"documentUri": StringFilter,
"documentId": StringFilter,
"sentOn": DatetimeFilter,
"completeOn": DatetimeFilter,
"mappedSigningTemplateByMappedSigningTemplateId": MappedSigningTemplateFilter,
"stepByStepId": StepFilter,
"accountBySentTo": AccountFilter,
"sentSigningDocumentStatusByStatus": SentSigningDocumentStatusFilter,
"and": [SentSigningDocumentFilter],
"or": [SentSigningDocumentFilter],
"not": SentSigningDocumentFilter
}
SentSigningDocumentStatus
Fields
| Field Name | Description |
|---|---|
nodeId - ID!
|
A globally unique identifier. Can be used in various places throughout the system to identify this single value. |
status - String!
|
|
sentSigningDocumentsByStatus - SentSigningDocumentsConnection!
|
Reads and enables pagination through a set of SentSigningDocument. |
Arguments
|
|
Example
{
"nodeId": 4,
"status": "xyz789",
"sentSigningDocumentsByStatus": SentSigningDocumentsConnection
}
SentSigningDocumentStatusCondition
Description
A condition to be used against SentSigningDocumentStatus object types. All fields are tested for equality and combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
status - String
|
Checks for equality with the object’s status field. |
Example
{"status": "xyz789"}
SentSigningDocumentStatusFilter
Description
A filter to be used against SentSigningDocumentStatus object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
status - StringFilter
|
Filter by the object’s status field. |
sentSigningDocumentsByStatus - SentSigningDocumentStatusToManySentSigningDocumentFilter
|
Filter by the object’s sentSigningDocumentsByStatus relation. |
sentSigningDocumentsByStatusExist - Boolean
|
Some related sentSigningDocumentsByStatus exist. |
and - [SentSigningDocumentStatusFilter!]
|
Checks for all expressions in this list. |
or - [SentSigningDocumentStatusFilter!]
|
Checks for any expressions in this list. |
not - SentSigningDocumentStatusFilter
|
Negates the expression. |
Example
{
"status": StringFilter,
"sentSigningDocumentsByStatus": SentSigningDocumentStatusToManySentSigningDocumentFilter,
"sentSigningDocumentsByStatusExist": false,
"and": [SentSigningDocumentStatusFilter],
"or": [SentSigningDocumentStatusFilter],
"not": SentSigningDocumentStatusFilter
}
SentSigningDocumentStatusToManySentSigningDocumentFilter
Description
A filter to be used against many SentSigningDocument object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - SentSigningDocumentFilter
|
Every related SentSigningDocument matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - SentSigningDocumentFilter
|
Some related SentSigningDocument matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - SentSigningDocumentFilter
|
No related SentSigningDocument matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": SentSigningDocumentFilter,
"some": SentSigningDocumentFilter,
"none": SentSigningDocumentFilter
}
SentSigningDocumentStatusesConnection
Description
A connection to a list of SentSigningDocumentStatus values.
Fields
| Field Name | Description |
|---|---|
nodes - [SentSigningDocumentStatus]!
|
A list of SentSigningDocumentStatus objects. |
edges - [SentSigningDocumentStatusesEdge!]!
|
A list of edges which contains the SentSigningDocumentStatus and cursor to aid in pagination. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The count of all SentSigningDocumentStatus you could get from the connection. |
Example
{
"nodes": [SentSigningDocumentStatus],
"edges": [SentSigningDocumentStatusesEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
SentSigningDocumentStatusesEdge
Description
A SentSigningDocumentStatus edge in the connection.
Fields
| Field Name | Description |
|---|---|
cursor - Cursor
|
A cursor for use in pagination. |
node - SentSigningDocumentStatus
|
The SentSigningDocumentStatus at the end of the edge. |
Example
{
"cursor": Cursor,
"node": SentSigningDocumentStatus
}
SentSigningDocumentStatusesOrderBy
Description
Methods to use when ordering SentSigningDocumentStatus.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NATURAL"
SentSigningDocumentsConnection
Description
A connection to a list of SentSigningDocument values.
Fields
| Field Name | Description |
|---|---|
nodes - [SentSigningDocument]!
|
A list of SentSigningDocument objects. |
edges - [SentSigningDocumentsEdge!]!
|
A list of edges which contains the SentSigningDocument and cursor to aid in pagination. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The count of all SentSigningDocument you could get from the connection. |
Example
{
"nodes": [SentSigningDocument],
"edges": [SentSigningDocumentsEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
SentSigningDocumentsEdge
Description
A SentSigningDocument edge in the connection.
Fields
| Field Name | Description |
|---|---|
cursor - Cursor
|
A cursor for use in pagination. |
node - SentSigningDocument
|
The SentSigningDocument at the end of the edge. |
Example
{
"cursor": Cursor,
"node": SentSigningDocument
}
SentSigningDocumentsOrderBy
Description
Methods to use when ordering SentSigningDocument.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NATURAL"
SetupAccountAddressInput
Example
{
"country": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"lineOne": "xyz789",
"lineTwo": "abc123",
"lineThree": "xyz789",
"lineFour": "abc123",
"city": "abc123",
"postalCode": "xyz789",
"province": "abc123",
"type": "abc123"
}
SetupAccountInput
Fields
| Input Field | Description |
|---|---|
accountName - String!
|
|
type - String!
|
|
formationDate - Datetime!
|
|
taxId - String!
|
|
addresses - [SetupAccountAddressInput!]!
|
|
parties - [SetupAccountPartiesInput!]!
|
|
attestation - Boolean!
|
Example
{
"accountName": "xyz789",
"type": "xyz789",
"formationDate": Datetime,
"taxId": "abc123",
"addresses": [SetupAccountAddressInput],
"parties": [SetupAccountPartiesInput],
"attestation": false
}
SetupAccountPartiesInput
Example
{
"addresses": [SetupAccountAddressInput],
"firstName": "abc123",
"lastName": "abc123",
"dateOfBirth": Datetime,
"taxId": "abc123",
"email": "xyz789",
"usCitizen": false,
"allowLogin": false,
"isPrimary": true
}
SetupCustomerInput
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
|
name - String!
|
|
email - String!
|
|
accountSetupData - ShadowSetupAccountInput
|
Example
{
"clientMutationId": "xyz789",
"name": "xyz789",
"email": "xyz789",
"accountSetupData": ShadowSetupAccountInput
}
SetupCustomerPayload
ShadowSetupAccountInput
Fields
| Input Field | Description |
|---|---|
type - String!
|
|
formationDate - Datetime!
|
|
taxId - String!
|
|
addresses - [SetupAccountAddressInput!]!
|
|
parties - [SetupAccountPartiesInput!]!
|
Example
{
"type": "xyz789",
"formationDate": Datetime,
"taxId": "abc123",
"addresses": [SetupAccountAddressInput],
"parties": [SetupAccountPartiesInput]
}
ShortStep
ShortStepFilter
Description
A filter to be used against ShortStep object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
id - UUIDFilter
|
Filter by the object’s id field. |
order - IntFilter
|
Filter by the object’s order field. |
status - StringFilter
|
Filter by the object’s status field. |
and - [ShortStepFilter!]
|
Checks for all expressions in this list. |
or - [ShortStepFilter!]
|
Checks for any expressions in this list. |
not - ShortStepFilter
|
Negates the expression. |
Example
{
"id": UUIDFilter,
"order": IntFilter,
"status": StringFilter,
"and": [ShortStepFilter],
"or": [ShortStepFilter],
"not": ShortStepFilter
}
ShortStepsConnection
Description
A connection to a list of ShortStep values.
Fields
| Field Name | Description |
|---|---|
nodes - [ShortStep]!
|
A list of ShortStep objects. |
edges - [ShortStepsEdge!]!
|
A list of edges which contains the ShortStep and cursor to aid in pagination. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The count of all ShortStep you could get from the connection. |
Example
{
"nodes": [ShortStep],
"edges": [ShortStepsEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
ShortStepsEdge
SigningAccount
Fields
| Field Name | Description |
|---|---|
nodeId - ID!
|
A globally unique identifier. Can be used in various places throughout the system to identify this single value. |
id - UUID!
|
|
accountId - UUID!
|
|
integrationId - UUID!
|
|
name - String!
|
|
syncedOn - Datetime
|
|
accountByAccountId - Account
|
Reads a single Account that is related to this SigningAccount. |
integrationByIntegrationId - Integration
|
Reads a single Integration that is related to this SigningAccount. |
signingTemplatesBySigningAccountId - SigningTemplatesConnection!
|
Reads and enables pagination through a set of SigningTemplate. |
Arguments
|
|
Example
{
"nodeId": 4,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"integrationId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"name": "abc123",
"syncedOn": Datetime,
"accountByAccountId": Account,
"integrationByIntegrationId": Integration,
"signingTemplatesBySigningAccountId": SigningTemplatesConnection
}
SigningAccountCondition
Description
A condition to be used against SigningAccount object types. All fields are tested for equality and combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
id - UUID
|
Checks for equality with the object’s id field. |
accountId - UUID
|
Checks for equality with the object’s accountId field. |
integrationId - UUID
|
Checks for equality with the object’s integrationId field. |
name - String
|
Checks for equality with the object’s name field. |
syncedOn - Datetime
|
Checks for equality with the object’s syncedOn field. |
Example
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"integrationId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"name": "xyz789",
"syncedOn": Datetime
}
SigningAccountFilter
Description
A filter to be used against SigningAccount object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
id - UUIDFilter
|
Filter by the object’s id field. |
accountId - UUIDFilter
|
Filter by the object’s accountId field. |
integrationId - UUIDFilter
|
Filter by the object’s integrationId field. |
name - StringFilter
|
Filter by the object’s name field. |
syncedOn - DatetimeFilter
|
Filter by the object’s syncedOn field. |
signingTemplatesBySigningAccountId - SigningAccountToManySigningTemplateFilter
|
Filter by the object’s signingTemplatesBySigningAccountId relation. |
signingTemplatesBySigningAccountIdExist - Boolean
|
Some related signingTemplatesBySigningAccountId exist. |
accountByAccountId - AccountFilter
|
Filter by the object’s accountByAccountId relation. |
integrationByIntegrationId - IntegrationFilter
|
Filter by the object’s integrationByIntegrationId relation. |
and - [SigningAccountFilter!]
|
Checks for all expressions in this list. |
or - [SigningAccountFilter!]
|
Checks for any expressions in this list. |
not - SigningAccountFilter
|
Negates the expression. |
Example
{
"id": UUIDFilter,
"accountId": UUIDFilter,
"integrationId": UUIDFilter,
"name": StringFilter,
"syncedOn": DatetimeFilter,
"signingTemplatesBySigningAccountId": SigningAccountToManySigningTemplateFilter,
"signingTemplatesBySigningAccountIdExist": true,
"accountByAccountId": AccountFilter,
"integrationByIntegrationId": IntegrationFilter,
"and": [SigningAccountFilter],
"or": [SigningAccountFilter],
"not": SigningAccountFilter
}
SigningAccountToManySigningTemplateFilter
Description
A filter to be used against many SigningTemplate object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - SigningTemplateFilter
|
Every related SigningTemplate matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - SigningTemplateFilter
|
Some related SigningTemplate matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - SigningTemplateFilter
|
No related SigningTemplate matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": SigningTemplateFilter,
"some": SigningTemplateFilter,
"none": SigningTemplateFilter
}
SigningAccountsConnection
Description
A connection to a list of SigningAccount values.
Fields
| Field Name | Description |
|---|---|
nodes - [SigningAccount]!
|
A list of SigningAccount objects. |
edges - [SigningAccountsEdge!]!
|
A list of edges which contains the SigningAccount and cursor to aid in pagination. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The count of all SigningAccount you could get from the connection. |
Example
{
"nodes": [SigningAccount],
"edges": [SigningAccountsEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
SigningAccountsEdge
Description
A SigningAccount edge in the connection.
Fields
| Field Name | Description |
|---|---|
cursor - Cursor
|
A cursor for use in pagination. |
node - SigningAccount
|
The SigningAccount at the end of the edge. |
Example
{
"cursor": Cursor,
"node": SigningAccount
}
SigningAccountsOrderBy
Description
Methods to use when ordering SigningAccount.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NATURAL"
SigningDocument
Fields
| Field Name | Description |
|---|---|
nodeId - ID!
|
A globally unique identifier. Can be used in various places throughout the system to identify this single value. |
id - UUID!
|
|
mappedSigningTemplateId - UUID!
|
|
name - String!
|
|
documentUri - String!
|
|
mappedSigningTemplateByMappedSigningTemplateId - MappedSigningTemplate
|
Reads a single MappedSigningTemplate that is related to this SigningDocument. |
signingFieldsBySigningDocumentId - SigningFieldsConnection!
|
Reads and enables pagination through a set of SigningField. |
Arguments
|
|
Example
{
"nodeId": 4,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"mappedSigningTemplateId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"name": "xyz789",
"documentUri": "abc123",
"mappedSigningTemplateByMappedSigningTemplateId": MappedSigningTemplate,
"signingFieldsBySigningDocumentId": SigningFieldsConnection
}
SigningDocumentCondition
Description
A condition to be used against SigningDocument object types. All fields are tested for equality and combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
id - UUID
|
Checks for equality with the object’s id field. |
mappedSigningTemplateId - UUID
|
Checks for equality with the object’s mappedSigningTemplateId field. |
name - String
|
Checks for equality with the object’s name field. |
documentUri - String
|
Checks for equality with the object’s documentUri field. |
Example
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"mappedSigningTemplateId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"name": "abc123",
"documentUri": "abc123"
}
SigningDocumentFilter
Description
A filter to be used against SigningDocument object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
id - UUIDFilter
|
Filter by the object’s id field. |
mappedSigningTemplateId - UUIDFilter
|
Filter by the object’s mappedSigningTemplateId field. |
name - StringFilter
|
Filter by the object’s name field. |
documentUri - StringFilter
|
Filter by the object’s documentUri field. |
signingFieldsBySigningDocumentId - SigningDocumentToManySigningFieldFilter
|
Filter by the object’s signingFieldsBySigningDocumentId relation. |
signingFieldsBySigningDocumentIdExist - Boolean
|
Some related signingFieldsBySigningDocumentId exist. |
mappedSigningTemplateByMappedSigningTemplateId - MappedSigningTemplateFilter
|
Filter by the object’s mappedSigningTemplateByMappedSigningTemplateId relation. |
and - [SigningDocumentFilter!]
|
Checks for all expressions in this list. |
or - [SigningDocumentFilter!]
|
Checks for any expressions in this list. |
not - SigningDocumentFilter
|
Negates the expression. |
Example
{
"id": UUIDFilter,
"mappedSigningTemplateId": UUIDFilter,
"name": StringFilter,
"documentUri": StringFilter,
"signingFieldsBySigningDocumentId": SigningDocumentToManySigningFieldFilter,
"signingFieldsBySigningDocumentIdExist": true,
"mappedSigningTemplateByMappedSigningTemplateId": MappedSigningTemplateFilter,
"and": [SigningDocumentFilter],
"or": [SigningDocumentFilter],
"not": SigningDocumentFilter
}
SigningDocumentToManySigningFieldFilter
Description
A filter to be used against many SigningField object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - SigningFieldFilter
|
Every related SigningField matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - SigningFieldFilter
|
Some related SigningField matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - SigningFieldFilter
|
No related SigningField matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": SigningFieldFilter,
"some": SigningFieldFilter,
"none": SigningFieldFilter
}
SigningDocumentsConnection
Description
A connection to a list of SigningDocument values.
Fields
| Field Name | Description |
|---|---|
nodes - [SigningDocument]!
|
A list of SigningDocument objects. |
edges - [SigningDocumentsEdge!]!
|
A list of edges which contains the SigningDocument and cursor to aid in pagination. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The count of all SigningDocument you could get from the connection. |
Example
{
"nodes": [SigningDocument],
"edges": [SigningDocumentsEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
SigningDocumentsEdge
Description
A SigningDocument edge in the connection.
Fields
| Field Name | Description |
|---|---|
cursor - Cursor
|
A cursor for use in pagination. |
node - SigningDocument
|
The SigningDocument at the end of the edge. |
Example
{
"cursor": Cursor,
"node": SigningDocument
}
SigningDocumentsOrderBy
Description
Methods to use when ordering SigningDocument.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NATURAL"
SigningField
Fields
| Field Name | Description |
|---|---|
nodeId - ID!
|
A globally unique identifier. Can be used in various places throughout the system to identify this single value. |
id - UUID!
|
|
mappedSigningTemplateId - UUID!
|
|
signingDocumentId - UUID!
|
|
signingRoleId - UUID!
|
|
type - String!
|
|
name - String!
|
|
value - String
|
|
valueVariable - String
|
|
mapTo - UUID
|
|
mappedSigningTemplateByMappedSigningTemplateId - MappedSigningTemplate
|
Reads a single MappedSigningTemplate that is related to this SigningField. |
signingDocumentBySigningDocumentId - SigningDocument
|
Reads a single SigningDocument that is related to this SigningField. |
signingRoleBySigningRoleId - SigningRole
|
Reads a single SigningRole that is related to this SigningField. |
mappingFieldByMapTo - MappingField
|
Example
{
"nodeId": 4,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"mappedSigningTemplateId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"signingDocumentId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"signingRoleId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"type": "abc123",
"name": "xyz789",
"value": "xyz789",
"valueVariable": "abc123",
"mapTo": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"mappedSigningTemplateByMappedSigningTemplateId": MappedSigningTemplate,
"signingDocumentBySigningDocumentId": SigningDocument,
"signingRoleBySigningRoleId": SigningRole,
"mappingFieldByMapTo": MappingField
}
SigningFieldCondition
Description
A condition to be used against SigningField object types. All fields are tested for equality and combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
id - UUID
|
Checks for equality with the object’s id field. |
mappedSigningTemplateId - UUID
|
Checks for equality with the object’s mappedSigningTemplateId field. |
signingDocumentId - UUID
|
Checks for equality with the object’s signingDocumentId field. |
signingRoleId - UUID
|
Checks for equality with the object’s signingRoleId field. |
type - String
|
Checks for equality with the object’s type field. |
name - String
|
Checks for equality with the object’s name field. |
value - String
|
Checks for equality with the object’s value field. |
valueVariable - String
|
Checks for equality with the object’s valueVariable field. |
mapTo - UUID
|
Checks for equality with the object’s mapTo field. |
Example
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"mappedSigningTemplateId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"signingDocumentId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"signingRoleId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"type": "abc123",
"name": "xyz789",
"value": "xyz789",
"valueVariable": "abc123",
"mapTo": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
SigningFieldFilter
Description
A filter to be used against SigningField object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
id - UUIDFilter
|
Filter by the object’s id field. |
mappedSigningTemplateId - UUIDFilter
|
Filter by the object’s mappedSigningTemplateId field. |
signingDocumentId - UUIDFilter
|
Filter by the object’s signingDocumentId field. |
signingRoleId - UUIDFilter
|
Filter by the object’s signingRoleId field. |
type - StringFilter
|
Filter by the object’s type field. |
name - StringFilter
|
Filter by the object’s name field. |
value - StringFilter
|
Filter by the object’s value field. |
valueVariable - StringFilter
|
Filter by the object’s valueVariable field. |
mapTo - UUIDFilter
|
Filter by the object’s mapTo field. |
mappedSigningTemplateByMappedSigningTemplateId - MappedSigningTemplateFilter
|
Filter by the object’s mappedSigningTemplateByMappedSigningTemplateId relation. |
signingDocumentBySigningDocumentId - SigningDocumentFilter
|
Filter by the object’s signingDocumentBySigningDocumentId relation. |
signingRoleBySigningRoleId - SigningRoleFilter
|
Filter by the object’s signingRoleBySigningRoleId relation. |
and - [SigningFieldFilter!]
|
Checks for all expressions in this list. |
or - [SigningFieldFilter!]
|
Checks for any expressions in this list. |
not - SigningFieldFilter
|
Negates the expression. |
Example
{
"id": UUIDFilter,
"mappedSigningTemplateId": UUIDFilter,
"signingDocumentId": UUIDFilter,
"signingRoleId": UUIDFilter,
"type": StringFilter,
"name": StringFilter,
"value": StringFilter,
"valueVariable": StringFilter,
"mapTo": UUIDFilter,
"mappedSigningTemplateByMappedSigningTemplateId": MappedSigningTemplateFilter,
"signingDocumentBySigningDocumentId": SigningDocumentFilter,
"signingRoleBySigningRoleId": SigningRoleFilter,
"and": [SigningFieldFilter],
"or": [SigningFieldFilter],
"not": SigningFieldFilter
}
SigningFieldInput
Description
An input for mutations affecting SigningField
Example
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"mappedSigningTemplateId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"signingDocumentId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"signingRoleId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"type": "xyz789",
"name": "abc123",
"value": "xyz789",
"valueVariable": "abc123",
"mapTo": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
SigningFieldPatch
Description
Represents an update to a SigningField. Fields that are set will be updated.
Example
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"mappedSigningTemplateId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"signingDocumentId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"signingRoleId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"type": "xyz789",
"name": "abc123",
"value": "abc123",
"valueVariable": "abc123",
"mapTo": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
SigningFieldsConnection
Description
A connection to a list of SigningField values.
Fields
| Field Name | Description |
|---|---|
nodes - [SigningField]!
|
A list of SigningField objects. |
edges - [SigningFieldsEdge!]!
|
A list of edges which contains the SigningField and cursor to aid in pagination. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The count of all SigningField you could get from the connection. |
Example
{
"nodes": [SigningField],
"edges": [SigningFieldsEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
SigningFieldsEdge
Description
A SigningField edge in the connection.
Fields
| Field Name | Description |
|---|---|
cursor - Cursor
|
A cursor for use in pagination. |
node - SigningField
|
The SigningField at the end of the edge. |
Example
{
"cursor": Cursor,
"node": SigningField
}
SigningFieldsOrderBy
Description
Methods to use when ordering SigningField.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NATURAL"
SigningRole
Fields
| Field Name | Description |
|---|---|
nodeId - ID!
|
A globally unique identifier. Can be used in various places throughout the system to identify this single value. |
id - UUID!
|
|
mappedSigningTemplateId - UUID!
|
|
mapTo - String!
|
|
type - String!
|
|
name - String!
|
|
toEmail - String
|
|
toName - String
|
|
mappedSigningTemplateByMappedSigningTemplateId - MappedSigningTemplate
|
Reads a single MappedSigningTemplate that is related to this SigningRole. |
mappingRoleByMapTo - MappingRole
|
Reads a single MappingRole that is related to this SigningRole. |
mappingRoleTypeByType - MappingRoleType
|
Reads a single MappingRoleType that is related to this SigningRole. |
signingFieldsBySigningRoleId - SigningFieldsConnection!
|
Reads and enables pagination through a set of SigningField. |
Arguments
|
|
Example
{
"nodeId": "4",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"mappedSigningTemplateId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"mapTo": "xyz789",
"type": "xyz789",
"name": "xyz789",
"toEmail": "xyz789",
"toName": "xyz789",
"mappedSigningTemplateByMappedSigningTemplateId": MappedSigningTemplate,
"mappingRoleByMapTo": MappingRole,
"mappingRoleTypeByType": MappingRoleType,
"signingFieldsBySigningRoleId": SigningFieldsConnection
}
SigningRoleCondition
Description
A condition to be used against SigningRole object types. All fields are tested for equality and combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
id - UUID
|
Checks for equality with the object’s id field. |
mappedSigningTemplateId - UUID
|
Checks for equality with the object’s mappedSigningTemplateId field. |
mapTo - String
|
Checks for equality with the object’s mapTo field. |
type - String
|
Checks for equality with the object’s type field. |
name - String
|
Checks for equality with the object’s name field. |
toEmail - String
|
Checks for equality with the object’s toEmail field. |
toName - String
|
Checks for equality with the object’s toName field. |
Example
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"mappedSigningTemplateId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"mapTo": "xyz789",
"type": "xyz789",
"name": "abc123",
"toEmail": "abc123",
"toName": "xyz789"
}
SigningRoleFilter
Description
A filter to be used against SigningRole object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
id - UUIDFilter
|
Filter by the object’s id field. |
mappedSigningTemplateId - UUIDFilter
|
Filter by the object’s mappedSigningTemplateId field. |
mapTo - StringFilter
|
Filter by the object’s mapTo field. |
type - StringFilter
|
Filter by the object’s type field. |
name - StringFilter
|
Filter by the object’s name field. |
toEmail - StringFilter
|
Filter by the object’s toEmail field. |
toName - StringFilter
|
Filter by the object’s toName field. |
signingFieldsBySigningRoleId - SigningRoleToManySigningFieldFilter
|
Filter by the object’s signingFieldsBySigningRoleId relation. |
signingFieldsBySigningRoleIdExist - Boolean
|
Some related signingFieldsBySigningRoleId exist. |
mappedSigningTemplateByMappedSigningTemplateId - MappedSigningTemplateFilter
|
Filter by the object’s mappedSigningTemplateByMappedSigningTemplateId relation. |
mappingRoleByMapTo - MappingRoleFilter
|
Filter by the object’s mappingRoleByMapTo relation. |
mappingRoleTypeByType - MappingRoleTypeFilter
|
Filter by the object’s mappingRoleTypeByType relation. |
and - [SigningRoleFilter!]
|
Checks for all expressions in this list. |
or - [SigningRoleFilter!]
|
Checks for any expressions in this list. |
not - SigningRoleFilter
|
Negates the expression. |
Example
{
"id": UUIDFilter,
"mappedSigningTemplateId": UUIDFilter,
"mapTo": StringFilter,
"type": StringFilter,
"name": StringFilter,
"toEmail": StringFilter,
"toName": StringFilter,
"signingFieldsBySigningRoleId": SigningRoleToManySigningFieldFilter,
"signingFieldsBySigningRoleIdExist": true,
"mappedSigningTemplateByMappedSigningTemplateId": MappedSigningTemplateFilter,
"mappingRoleByMapTo": MappingRoleFilter,
"mappingRoleTypeByType": MappingRoleTypeFilter,
"and": [SigningRoleFilter],
"or": [SigningRoleFilter],
"not": SigningRoleFilter
}
SigningRolePatch
Description
Represents an update to a SigningRole. Fields that are set will be updated.
Example
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"mappedSigningTemplateId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"mapTo": "abc123",
"type": "xyz789",
"name": "xyz789",
"toEmail": "abc123",
"toName": "xyz789"
}
SigningRoleToManySigningFieldFilter
Description
A filter to be used against many SigningField object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - SigningFieldFilter
|
Every related SigningField matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - SigningFieldFilter
|
Some related SigningField matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - SigningFieldFilter
|
No related SigningField matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": SigningFieldFilter,
"some": SigningFieldFilter,
"none": SigningFieldFilter
}
SigningRolesConnection
Description
A connection to a list of SigningRole values.
Fields
| Field Name | Description |
|---|---|
nodes - [SigningRole]!
|
A list of SigningRole objects. |
edges - [SigningRolesEdge!]!
|
A list of edges which contains the SigningRole and cursor to aid in pagination. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The count of all SigningRole you could get from the connection. |
Example
{
"nodes": [SigningRole],
"edges": [SigningRolesEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
SigningRolesEdge
Description
A SigningRole edge in the connection.
Fields
| Field Name | Description |
|---|---|
cursor - Cursor
|
A cursor for use in pagination. |
node - SigningRole
|
The SigningRole at the end of the edge. |
Example
{
"cursor": Cursor,
"node": SigningRole
}
SigningRolesOrderBy
Description
Methods to use when ordering SigningRole.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NATURAL"
SigningStepType
Fields
| Field Name | Description |
|---|---|
nodeId - ID!
|
A globally unique identifier. Can be used in various places throughout the system to identify this single value. |
type - String!
|
|
mappedSigningTemplatesByQualificationStepType - MappedSigningTemplatesConnection!
|
Reads and enables pagination through a set of MappedSigningTemplate. |
Arguments
|
|
Example
{
"nodeId": "4",
"type": "abc123",
"mappedSigningTemplatesByQualificationStepType": MappedSigningTemplatesConnection
}
SigningStepTypeCondition
Description
A condition to be used against SigningStepType object types. All fields are tested for equality and combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
type - String
|
Checks for equality with the object’s type field. |
Example
{"type": "abc123"}
SigningStepTypeFilter
Description
A filter to be used against SigningStepType object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
type - StringFilter
|
Filter by the object’s type field. |
mappedSigningTemplatesByQualificationStepType - SigningStepTypeToManyMappedSigningTemplateFilter
|
Filter by the object’s mappedSigningTemplatesByQualificationStepType relation. |
mappedSigningTemplatesByQualificationStepTypeExist - Boolean
|
Some related mappedSigningTemplatesByQualificationStepType exist. |
and - [SigningStepTypeFilter!]
|
Checks for all expressions in this list. |
or - [SigningStepTypeFilter!]
|
Checks for any expressions in this list. |
not - SigningStepTypeFilter
|
Negates the expression. |
Example
{
"type": StringFilter,
"mappedSigningTemplatesByQualificationStepType": SigningStepTypeToManyMappedSigningTemplateFilter,
"mappedSigningTemplatesByQualificationStepTypeExist": false,
"and": [SigningStepTypeFilter],
"or": [SigningStepTypeFilter],
"not": SigningStepTypeFilter
}
SigningStepTypeToManyMappedSigningTemplateFilter
Description
A filter to be used against many MappedSigningTemplate object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - MappedSigningTemplateFilter
|
Every related MappedSigningTemplate matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - MappedSigningTemplateFilter
|
Some related MappedSigningTemplate matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - MappedSigningTemplateFilter
|
No related MappedSigningTemplate matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": MappedSigningTemplateFilter,
"some": MappedSigningTemplateFilter,
"none": MappedSigningTemplateFilter
}
SigningStepTypesConnection
Description
A connection to a list of SigningStepType values.
Fields
| Field Name | Description |
|---|---|
nodes - [SigningStepType]!
|
A list of SigningStepType objects. |
edges - [SigningStepTypesEdge!]!
|
A list of edges which contains the SigningStepType and cursor to aid in pagination. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The count of all SigningStepType you could get from the connection. |
Example
{
"nodes": [SigningStepType],
"edges": [SigningStepTypesEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
SigningStepTypesEdge
Description
A SigningStepType edge in the connection.
Fields
| Field Name | Description |
|---|---|
cursor - Cursor
|
A cursor for use in pagination. |
node - SigningStepType
|
The SigningStepType at the end of the edge. |
Example
{
"cursor": Cursor,
"node": SigningStepType
}
SigningStepTypesOrderBy
Description
Methods to use when ordering SigningStepType.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NATURAL"
SigningTemplate
Fields
| Field Name | Description |
|---|---|
nodeId - ID!
|
A globally unique identifier. Can be used in various places throughout the system to identify this single value. |
id - UUID!
|
|
signingAccountId - UUID!
|
|
accountId - UUID!
|
|
name - String!
|
|
description - String!
|
|
updatedOn - Datetime!
|
|
syncedOn - Datetime!
|
|
deleted - Boolean!
|
|
templateUri - String!
|
|
signingAccountBySigningAccountId - SigningAccount
|
Reads a single SigningAccount that is related to this SigningTemplate. |
accountByAccountId - Account
|
Reads a single Account that is related to this SigningTemplate. |
mappedSigningTemplatesBySigningTemplateId - MappedSigningTemplatesConnection!
|
Reads and enables pagination through a set of MappedSigningTemplate. |
Arguments
|
|
Example
{
"nodeId": "4",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"signingAccountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"name": "xyz789",
"description": "xyz789",
"updatedOn": Datetime,
"syncedOn": Datetime,
"deleted": false,
"templateUri": "xyz789",
"signingAccountBySigningAccountId": SigningAccount,
"accountByAccountId": Account,
"mappedSigningTemplatesBySigningTemplateId": MappedSigningTemplatesConnection
}
SigningTemplateCondition
Description
A condition to be used against SigningTemplate object types. All fields are tested for equality and combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
id - UUID
|
Checks for equality with the object’s id field. |
signingAccountId - UUID
|
Checks for equality with the object’s signingAccountId field. |
accountId - UUID
|
Checks for equality with the object’s accountId field. |
name - String
|
Checks for equality with the object’s name field. |
description - String
|
Checks for equality with the object’s description field. |
updatedOn - Datetime
|
Checks for equality with the object’s updatedOn field. |
syncedOn - Datetime
|
Checks for equality with the object’s syncedOn field. |
deleted - Boolean
|
Checks for equality with the object’s deleted field. |
templateUri - String
|
Checks for equality with the object’s templateUri field. |
Example
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"signingAccountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"name": "xyz789",
"description": "abc123",
"updatedOn": Datetime,
"syncedOn": Datetime,
"deleted": true,
"templateUri": "xyz789"
}
SigningTemplateFilter
Description
A filter to be used against SigningTemplate object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
id - UUIDFilter
|
Filter by the object’s id field. |
signingAccountId - UUIDFilter
|
Filter by the object’s signingAccountId field. |
accountId - UUIDFilter
|
Filter by the object’s accountId field. |
name - StringFilter
|
Filter by the object’s name field. |
description - StringFilter
|
Filter by the object’s description field. |
updatedOn - DatetimeFilter
|
Filter by the object’s updatedOn field. |
syncedOn - DatetimeFilter
|
Filter by the object’s syncedOn field. |
deleted - BooleanFilter
|
Filter by the object’s deleted field. |
templateUri - StringFilter
|
Filter by the object’s templateUri field. |
mappedSigningTemplatesBySigningTemplateId - SigningTemplateToManyMappedSigningTemplateFilter
|
Filter by the object’s mappedSigningTemplatesBySigningTemplateId relation. |
mappedSigningTemplatesBySigningTemplateIdExist - Boolean
|
Some related mappedSigningTemplatesBySigningTemplateId exist. |
signingAccountBySigningAccountId - SigningAccountFilter
|
Filter by the object’s signingAccountBySigningAccountId relation. |
accountByAccountId - AccountFilter
|
Filter by the object’s accountByAccountId relation. |
and - [SigningTemplateFilter!]
|
Checks for all expressions in this list. |
or - [SigningTemplateFilter!]
|
Checks for any expressions in this list. |
not - SigningTemplateFilter
|
Negates the expression. |
Example
{
"id": UUIDFilter,
"signingAccountId": UUIDFilter,
"accountId": UUIDFilter,
"name": StringFilter,
"description": StringFilter,
"updatedOn": DatetimeFilter,
"syncedOn": DatetimeFilter,
"deleted": BooleanFilter,
"templateUri": StringFilter,
"mappedSigningTemplatesBySigningTemplateId": SigningTemplateToManyMappedSigningTemplateFilter,
"mappedSigningTemplatesBySigningTemplateIdExist": true,
"signingAccountBySigningAccountId": SigningAccountFilter,
"accountByAccountId": AccountFilter,
"and": [SigningTemplateFilter],
"or": [SigningTemplateFilter],
"not": SigningTemplateFilter
}
SigningTemplateToManyMappedSigningTemplateFilter
Description
A filter to be used against many MappedSigningTemplate object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - MappedSigningTemplateFilter
|
Every related MappedSigningTemplate matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - MappedSigningTemplateFilter
|
Some related MappedSigningTemplate matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - MappedSigningTemplateFilter
|
No related MappedSigningTemplate matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": MappedSigningTemplateFilter,
"some": MappedSigningTemplateFilter,
"none": MappedSigningTemplateFilter
}
SigningTemplatesConnection
Description
A connection to a list of SigningTemplate values.
Fields
| Field Name | Description |
|---|---|
nodes - [SigningTemplate]!
|
A list of SigningTemplate objects. |
edges - [SigningTemplatesEdge!]!
|
A list of edges which contains the SigningTemplate and cursor to aid in pagination. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The count of all SigningTemplate you could get from the connection. |
Example
{
"nodes": [SigningTemplate],
"edges": [SigningTemplatesEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
SigningTemplatesEdge
Description
A SigningTemplate edge in the connection.
Fields
| Field Name | Description |
|---|---|
cursor - Cursor
|
A cursor for use in pagination. |
node - SigningTemplate
|
The SigningTemplate at the end of the edge. |
Example
{
"cursor": Cursor,
"node": SigningTemplate
}
SigningTemplatesOrderBy
Description
Methods to use when ordering SigningTemplate.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NATURAL"
StagedBalanceTransfer
Fields
| Field Name | Description |
|---|---|
id - UUID
|
|
transferId - UUID
|
|
securityId - UUID
|
|
fromAccountId - UUID
|
|
toAccountId - UUID
|
|
fromHoldingId - UUID
|
|
toHoldingId - UUID
|
|
amount - BigFloat
|
|
createdOn - Datetime
|
|
holdingByToHoldingId - Holding
|
Reads a single Holding that is related to this StagedBalanceTransfer. |
accountByToAccountId - Account
|
Reads a single Account that is related to this StagedBalanceTransfer. |
securityBySecurityId - Security
|
Reads a single Security that is related to this StagedBalanceTransfer. |
holdingByFromHoldingId - Holding
|
Reads a single Holding that is related to this StagedBalanceTransfer. |
accountByFromAccountId - Account
|
Reads a single Account that is related to this StagedBalanceTransfer. |
stagedTransferByTransferId - StagedTransfer
|
Reads a single StagedTransfer that is related to this StagedBalanceTransfer. |
Example
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"transferId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"securityId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"fromAccountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"toAccountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"fromHoldingId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"toHoldingId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"amount": BigFloat,
"createdOn": Datetime,
"holdingByToHoldingId": Holding,
"accountByToAccountId": Account,
"securityBySecurityId": Security,
"holdingByFromHoldingId": Holding,
"accountByFromAccountId": Account,
"stagedTransferByTransferId": StagedTransfer
}
StagedBalanceTransferCondition
Description
A condition to be used against StagedBalanceTransfer object types. All fields are tested for equality and combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
id - UUID
|
Checks for equality with the object’s id field. |
transferId - UUID
|
Checks for equality with the object’s transferId field. |
securityId - UUID
|
Checks for equality with the object’s securityId field. |
fromAccountId - UUID
|
Checks for equality with the object’s fromAccountId field. |
toAccountId - UUID
|
Checks for equality with the object’s toAccountId field. |
fromHoldingId - UUID
|
Checks for equality with the object’s fromHoldingId field. |
toHoldingId - UUID
|
Checks for equality with the object’s toHoldingId field. |
amount - BigFloat
|
Checks for equality with the object’s amount field. |
createdOn - Datetime
|
Checks for equality with the object’s createdOn field. |
Example
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"transferId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"securityId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"fromAccountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"toAccountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"fromHoldingId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"toHoldingId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"amount": BigFloat,
"createdOn": Datetime
}
StagedBalanceTransferFilter
Description
A filter to be used against StagedBalanceTransfer object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
id - UUIDFilter
|
Filter by the object’s id field. |
transferId - UUIDFilter
|
Filter by the object’s transferId field. |
securityId - UUIDFilter
|
Filter by the object’s securityId field. |
fromAccountId - UUIDFilter
|
Filter by the object’s fromAccountId field. |
toAccountId - UUIDFilter
|
Filter by the object’s toAccountId field. |
fromHoldingId - UUIDFilter
|
Filter by the object’s fromHoldingId field. |
toHoldingId - UUIDFilter
|
Filter by the object’s toHoldingId field. |
amount - BigFloatFilter
|
Filter by the object’s amount field. |
createdOn - DatetimeFilter
|
Filter by the object’s createdOn field. |
holdingByToHoldingId - HoldingFilter
|
Filter by the object’s holdingByToHoldingId relation. |
holdingByToHoldingIdExists - Boolean
|
A related holdingByToHoldingId exists. |
accountByToAccountId - AccountFilter
|
Filter by the object’s accountByToAccountId relation. |
accountByToAccountIdExists - Boolean
|
A related accountByToAccountId exists. |
securityBySecurityId - SecurityFilter
|
Filter by the object’s securityBySecurityId relation. |
securityBySecurityIdExists - Boolean
|
A related securityBySecurityId exists. |
holdingByFromHoldingId - HoldingFilter
|
Filter by the object’s holdingByFromHoldingId relation. |
holdingByFromHoldingIdExists - Boolean
|
A related holdingByFromHoldingId exists. |
accountByFromAccountId - AccountFilter
|
Filter by the object’s accountByFromAccountId relation. |
accountByFromAccountIdExists - Boolean
|
A related accountByFromAccountId exists. |
stagedTransferByTransferId - StagedTransferFilter
|
Filter by the object’s stagedTransferByTransferId relation. |
stagedTransferByTransferIdExists - Boolean
|
A related stagedTransferByTransferId exists. |
and - [StagedBalanceTransferFilter!]
|
Checks for all expressions in this list. |
or - [StagedBalanceTransferFilter!]
|
Checks for any expressions in this list. |
not - StagedBalanceTransferFilter
|
Negates the expression. |
Example
{
"id": UUIDFilter,
"transferId": UUIDFilter,
"securityId": UUIDFilter,
"fromAccountId": UUIDFilter,
"toAccountId": UUIDFilter,
"fromHoldingId": UUIDFilter,
"toHoldingId": UUIDFilter,
"amount": BigFloatFilter,
"createdOn": DatetimeFilter,
"holdingByToHoldingId": HoldingFilter,
"holdingByToHoldingIdExists": false,
"accountByToAccountId": AccountFilter,
"accountByToAccountIdExists": true,
"securityBySecurityId": SecurityFilter,
"securityBySecurityIdExists": false,
"holdingByFromHoldingId": HoldingFilter,
"holdingByFromHoldingIdExists": false,
"accountByFromAccountId": AccountFilter,
"accountByFromAccountIdExists": false,
"stagedTransferByTransferId": StagedTransferFilter,
"stagedTransferByTransferIdExists": false,
"and": [StagedBalanceTransferFilter],
"or": [StagedBalanceTransferFilter],
"not": StagedBalanceTransferFilter
}
StagedBalanceTransfersConnection
Description
A connection to a list of StagedBalanceTransfer values.
Fields
| Field Name | Description |
|---|---|
nodes - [StagedBalanceTransfer]!
|
A list of StagedBalanceTransfer objects. |
edges - [StagedBalanceTransfersEdge!]!
|
A list of edges which contains the StagedBalanceTransfer and cursor to aid in pagination. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The count of all StagedBalanceTransfer you could get from the connection. |
Example
{
"nodes": [StagedBalanceTransfer],
"edges": [StagedBalanceTransfersEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
StagedBalanceTransfersEdge
Description
A StagedBalanceTransfer edge in the connection.
Fields
| Field Name | Description |
|---|---|
cursor - Cursor
|
A cursor for use in pagination. |
node - StagedBalanceTransfer
|
The StagedBalanceTransfer at the end of the edge. |
Example
{
"cursor": Cursor,
"node": StagedBalanceTransfer
}
StagedBalanceTransfersOrderBy
Description
Methods to use when ordering StagedBalanceTransfer.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NATURAL"
StagedTransfer
Fields
| Field Name | Description |
|---|---|
id - UUID
|
|
accountId - UUID
|
|
securityId - UUID
|
|
type - String
|
|
status - String
|
|
requestId - UUID
|
|
webhookId - UUID
|
|
data - JSON
|
|
createdOn - Datetime
|
|
executedOn - Datetime
|
|
order - Int
|
|
securityBySecurityId - Security
|
Reads a single Security that is related to this StagedTransfer. |
accountByAccountId - Account
|
Reads a single Account that is related to this StagedTransfer. |
requestByRequestId - Request
|
Reads a single Request that is related to this StagedTransfer. |
stagedTransferStatusByStatus - StagedTransferStatus
|
Reads a single StagedTransferStatus that is related to this StagedTransfer. |
transferTypeByType - TransferType
|
Reads a single TransferType that is related to this StagedTransfer. |
stagedBalanceTransfersByTransferId - StagedBalanceTransfersConnection!
|
Reads and enables pagination through a set of StagedBalanceTransfer. |
Arguments
|
|
stagedTransferAtsTagsByStagedTransferId - StagedTransferAtsTagsConnection!
|
Reads and enables pagination through a set of StagedTransferAtsTag. |
Arguments
|
|
Example
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"securityId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"type": "xyz789",
"status": "xyz789",
"requestId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"webhookId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"data": {},
"createdOn": Datetime,
"executedOn": Datetime,
"order": 123,
"securityBySecurityId": Security,
"accountByAccountId": Account,
"requestByRequestId": Request,
"stagedTransferStatusByStatus": StagedTransferStatus,
"transferTypeByType": TransferType,
"stagedBalanceTransfersByTransferId": StagedBalanceTransfersConnection,
"stagedTransferAtsTagsByStagedTransferId": StagedTransferAtsTagsConnection
}
StagedTransferAtsTag
Fields
| Field Name | Description |
|---|---|
id - UUID
|
|
atsTagId - UUID
|
|
stagedTransferId - UUID
|
|
stagedTransferByStagedTransferId - StagedTransfer
|
Reads a single StagedTransfer that is related to this StagedTransferAtsTag. |
atsTagByAtsTagId - AtsTag
|
Reads a single AtsTag that is related to this StagedTransferAtsTag. |
Example
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"atsTagId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"stagedTransferId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"stagedTransferByStagedTransferId": StagedTransfer,
"atsTagByAtsTagId": AtsTag
}
StagedTransferAtsTagCondition
Description
A condition to be used against StagedTransferAtsTag object types. All fields are tested for equality and combined with a logical ‘and.’
Example
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"atsTagId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"stagedTransferId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
StagedTransferAtsTagFilter
Description
A filter to be used against StagedTransferAtsTag object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
id - UUIDFilter
|
Filter by the object’s id field. |
atsTagId - UUIDFilter
|
Filter by the object’s atsTagId field. |
stagedTransferId - UUIDFilter
|
Filter by the object’s stagedTransferId field. |
stagedTransferByStagedTransferId - StagedTransferFilter
|
Filter by the object’s stagedTransferByStagedTransferId relation. |
stagedTransferByStagedTransferIdExists - Boolean
|
A related stagedTransferByStagedTransferId exists. |
atsTagByAtsTagId - AtsTagFilter
|
Filter by the object’s atsTagByAtsTagId relation. |
atsTagByAtsTagIdExists - Boolean
|
A related atsTagByAtsTagId exists. |
and - [StagedTransferAtsTagFilter!]
|
Checks for all expressions in this list. |
or - [StagedTransferAtsTagFilter!]
|
Checks for any expressions in this list. |
not - StagedTransferAtsTagFilter
|
Negates the expression. |
Example
{
"id": UUIDFilter,
"atsTagId": UUIDFilter,
"stagedTransferId": UUIDFilter,
"stagedTransferByStagedTransferId": StagedTransferFilter,
"stagedTransferByStagedTransferIdExists": false,
"atsTagByAtsTagId": AtsTagFilter,
"atsTagByAtsTagIdExists": true,
"and": [StagedTransferAtsTagFilter],
"or": [StagedTransferAtsTagFilter],
"not": StagedTransferAtsTagFilter
}
StagedTransferAtsTagsConnection
Description
A connection to a list of StagedTransferAtsTag values.
Fields
| Field Name | Description |
|---|---|
nodes - [StagedTransferAtsTag]!
|
A list of StagedTransferAtsTag objects. |
edges - [StagedTransferAtsTagsEdge!]!
|
A list of edges which contains the StagedTransferAtsTag and cursor to aid in pagination. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The count of all StagedTransferAtsTag you could get from the connection. |
Example
{
"nodes": [StagedTransferAtsTag],
"edges": [StagedTransferAtsTagsEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
StagedTransferAtsTagsEdge
Description
A StagedTransferAtsTag edge in the connection.
Fields
| Field Name | Description |
|---|---|
cursor - Cursor
|
A cursor for use in pagination. |
node - StagedTransferAtsTag
|
The StagedTransferAtsTag at the end of the edge. |
Example
{
"cursor": Cursor,
"node": StagedTransferAtsTag
}
StagedTransferAtsTagsOrderBy
Description
Methods to use when ordering StagedTransferAtsTag.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NATURAL"
StagedTransferCondition
Description
A condition to be used against StagedTransfer object types. All fields are tested for equality and combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
id - UUID
|
Checks for equality with the object’s id field. |
accountId - UUID
|
Checks for equality with the object’s accountId field. |
securityId - UUID
|
Checks for equality with the object’s securityId field. |
type - String
|
Checks for equality with the object’s type field. |
status - String
|
Checks for equality with the object’s status field. |
requestId - UUID
|
Checks for equality with the object’s requestId field. |
webhookId - UUID
|
Checks for equality with the object’s webhookId field. |
data - JSON
|
Checks for equality with the object’s data field. |
createdOn - Datetime
|
Checks for equality with the object’s createdOn field. |
executedOn - Datetime
|
Checks for equality with the object’s executedOn field. |
order - Int
|
Checks for equality with the object’s order field. |
Example
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"securityId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"type": "abc123",
"status": "xyz789",
"requestId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"webhookId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"data": {},
"createdOn": Datetime,
"executedOn": Datetime,
"order": 123
}
StagedTransferFilter
Description
A filter to be used against StagedTransfer object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
id - UUIDFilter
|
Filter by the object’s id field. |
accountId - UUIDFilter
|
Filter by the object’s accountId field. |
securityId - UUIDFilter
|
Filter by the object’s securityId field. |
type - StringFilter
|
Filter by the object’s type field. |
status - StringFilter
|
Filter by the object’s status field. |
requestId - UUIDFilter
|
Filter by the object’s requestId field. |
webhookId - UUIDFilter
|
Filter by the object’s webhookId field. |
data - JSONFilter
|
Filter by the object’s data field. |
createdOn - DatetimeFilter
|
Filter by the object’s createdOn field. |
executedOn - DatetimeFilter
|
Filter by the object’s executedOn field. |
order - IntFilter
|
Filter by the object’s order field. |
stagedBalanceTransfersByTransferId - StagedTransferToManyStagedBalanceTransferFilter
|
Filter by the object’s stagedBalanceTransfersByTransferId relation. |
stagedBalanceTransfersByTransferIdExist - Boolean
|
Some related stagedBalanceTransfersByTransferId exist. |
stagedTransferAtsTagsByStagedTransferId - StagedTransferToManyStagedTransferAtsTagFilter
|
Filter by the object’s stagedTransferAtsTagsByStagedTransferId relation. |
stagedTransferAtsTagsByStagedTransferIdExist - Boolean
|
Some related stagedTransferAtsTagsByStagedTransferId exist. |
securityBySecurityId - SecurityFilter
|
Filter by the object’s securityBySecurityId relation. |
securityBySecurityIdExists - Boolean
|
A related securityBySecurityId exists. |
accountByAccountId - AccountFilter
|
Filter by the object’s accountByAccountId relation. |
accountByAccountIdExists - Boolean
|
A related accountByAccountId exists. |
requestByRequestId - RequestFilter
|
Filter by the object’s requestByRequestId relation. |
requestByRequestIdExists - Boolean
|
A related requestByRequestId exists. |
stagedTransferStatusByStatus - StagedTransferStatusFilter
|
Filter by the object’s stagedTransferStatusByStatus relation. |
stagedTransferStatusByStatusExists - Boolean
|
A related stagedTransferStatusByStatus exists. |
transferTypeByType - TransferTypeFilter
|
Filter by the object’s transferTypeByType relation. |
transferTypeByTypeExists - Boolean
|
A related transferTypeByType exists. |
and - [StagedTransferFilter!]
|
Checks for all expressions in this list. |
or - [StagedTransferFilter!]
|
Checks for any expressions in this list. |
not - StagedTransferFilter
|
Negates the expression. |
Example
{
"id": UUIDFilter,
"accountId": UUIDFilter,
"securityId": UUIDFilter,
"type": StringFilter,
"status": StringFilter,
"requestId": UUIDFilter,
"webhookId": UUIDFilter,
"data": JSONFilter,
"createdOn": DatetimeFilter,
"executedOn": DatetimeFilter,
"order": IntFilter,
"stagedBalanceTransfersByTransferId": StagedTransferToManyStagedBalanceTransferFilter,
"stagedBalanceTransfersByTransferIdExist": false,
"stagedTransferAtsTagsByStagedTransferId": StagedTransferToManyStagedTransferAtsTagFilter,
"stagedTransferAtsTagsByStagedTransferIdExist": false,
"securityBySecurityId": SecurityFilter,
"securityBySecurityIdExists": true,
"accountByAccountId": AccountFilter,
"accountByAccountIdExists": true,
"requestByRequestId": RequestFilter,
"requestByRequestIdExists": true,
"stagedTransferStatusByStatus": StagedTransferStatusFilter,
"stagedTransferStatusByStatusExists": true,
"transferTypeByType": TransferTypeFilter,
"transferTypeByTypeExists": false,
"and": [StagedTransferFilter],
"or": [StagedTransferFilter],
"not": StagedTransferFilter
}
StagedTransferStatus
Fields
| Field Name | Description |
|---|---|
status - String
|
|
stagedTransfersByStatus - StagedTransfersConnection!
|
Reads and enables pagination through a set of StagedTransfer. |
Arguments
|
|
Example
{
"status": "abc123",
"stagedTransfersByStatus": StagedTransfersConnection
}
StagedTransferStatusCondition
Description
A condition to be used against StagedTransferStatus object types. All fields are tested for equality and combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
status - String
|
Checks for equality with the object’s status field. |
Example
{"status": "abc123"}
StagedTransferStatusFilter
Description
A filter to be used against StagedTransferStatus object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
status - StringFilter
|
Filter by the object’s status field. |
stagedTransfersByStatus - StagedTransferStatusToManyStagedTransferFilter
|
Filter by the object’s stagedTransfersByStatus relation. |
stagedTransfersByStatusExist - Boolean
|
Some related stagedTransfersByStatus exist. |
and - [StagedTransferStatusFilter!]
|
Checks for all expressions in this list. |
or - [StagedTransferStatusFilter!]
|
Checks for any expressions in this list. |
not - StagedTransferStatusFilter
|
Negates the expression. |
Example
{
"status": StringFilter,
"stagedTransfersByStatus": StagedTransferStatusToManyStagedTransferFilter,
"stagedTransfersByStatusExist": false,
"and": [StagedTransferStatusFilter],
"or": [StagedTransferStatusFilter],
"not": StagedTransferStatusFilter
}
StagedTransferStatusInput
Description
An input for mutations affecting StagedTransferStatus
Fields
| Input Field | Description |
|---|---|
status - String
|
Example
{"status": "xyz789"}
StagedTransferStatusToManyStagedTransferFilter
Description
A filter to be used against many StagedTransfer object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - StagedTransferFilter
|
Every related StagedTransfer matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - StagedTransferFilter
|
Some related StagedTransfer matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - StagedTransferFilter
|
No related StagedTransfer matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": StagedTransferFilter,
"some": StagedTransferFilter,
"none": StagedTransferFilter
}
StagedTransferStatusesConnection
Description
A connection to a list of StagedTransferStatus values.
Fields
| Field Name | Description |
|---|---|
nodes - [StagedTransferStatus]!
|
A list of StagedTransferStatus objects. |
edges - [StagedTransferStatusesEdge!]!
|
A list of edges which contains the StagedTransferStatus and cursor to aid in pagination. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The count of all StagedTransferStatus you could get from the connection. |
Example
{
"nodes": [StagedTransferStatus],
"edges": [StagedTransferStatusesEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
StagedTransferStatusesEdge
Description
A StagedTransferStatus edge in the connection.
Fields
| Field Name | Description |
|---|---|
cursor - Cursor
|
A cursor for use in pagination. |
node - StagedTransferStatus
|
The StagedTransferStatus at the end of the edge. |
Example
{
"cursor": Cursor,
"node": StagedTransferStatus
}
StagedTransferStatusesOrderBy
Description
Methods to use when ordering StagedTransferStatus.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"NATURAL"
StagedTransferToManyStagedBalanceTransferFilter
Description
A filter to be used against many StagedBalanceTransfer object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - StagedBalanceTransferFilter
|
Every related StagedBalanceTransfer matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - StagedBalanceTransferFilter
|
Some related StagedBalanceTransfer matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - StagedBalanceTransferFilter
|
No related StagedBalanceTransfer matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": StagedBalanceTransferFilter,
"some": StagedBalanceTransferFilter,
"none": StagedBalanceTransferFilter
}
StagedTransferToManyStagedTransferAtsTagFilter
Description
A filter to be used against many StagedTransferAtsTag object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - StagedTransferAtsTagFilter
|
Every related StagedTransferAtsTag matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - StagedTransferAtsTagFilter
|
Some related StagedTransferAtsTag matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - StagedTransferAtsTagFilter
|
No related StagedTransferAtsTag matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": StagedTransferAtsTagFilter,
"some": StagedTransferAtsTagFilter,
"none": StagedTransferAtsTagFilter
}
StagedTransfersConnection
Description
A connection to a list of StagedTransfer values.
Fields
| Field Name | Description |
|---|---|
nodes - [StagedTransfer]!
|
A list of StagedTransfer objects. |
edges - [StagedTransfersEdge!]!
|
A list of edges which contains the StagedTransfer and cursor to aid in pagination. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The count of all StagedTransfer you could get from the connection. |
Example
{
"nodes": [StagedTransfer],
"edges": [StagedTransfersEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
StagedTransfersEdge
Description
A StagedTransfer edge in the connection.
Fields
| Field Name | Description |
|---|---|
cursor - Cursor
|
A cursor for use in pagination. |
node - StagedTransfer
|
The StagedTransfer at the end of the edge. |
Example
{
"cursor": Cursor,
"node": StagedTransfer
}
StagedTransfersOrderBy
Description
Methods to use when ordering StagedTransfer.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NATURAL"
Step
Fields
| Field Name | Description |
|---|---|
nodeId - ID!
|
A globally unique identifier. Can be used in various places throughout the system to identify this single value. |
id - UUID!
|
|
ownedBy - UUID!
|
|
executeBy - UUID!
|
|
status - String!
|
|
type - String!
|
|
schema - JSON
|
|
inputData - JSON
|
|
outputData - JSON
|
|
valid - Boolean!
|
|
retry - Int!
|
|
templateId - UUID!
|
|
rootStepId - UUID!
|
|
completeState - BitString!
|
|
state - BitString!
|
|
createdOn - Datetime!
|
|
accountByOwnedBy - Account
|
Reads a single Account that is related to this Step. |
accountByExecuteBy - Account
|
Reads a single Account that is related to this Step. |
stepStatusByStatus - StepStatus
|
Reads a single StepStatus that is related to this Step. |
stepTypeByType - StepType
|
Reads a single StepType that is related to this Step. |
distributionByStepId - Distribution
|
Reads a single Distribution that is related to this Step. |
distributionsByStepId - DistributionsConnection!
|
Reads and enables pagination through a set of Distribution. Please use distributionByStepId instead
|
Arguments
|
|
accountIntegrationByStepId - AccountIntegration
|
Reads a single AccountIntegration that is related to this Step. |
accountIntegrationsByStepId - AccountIntegrationsConnection!
|
Reads and enables pagination through a set of AccountIntegration. Please use accountIntegrationByStepId instead
|
Arguments
|
|
distributionQualificationsByStepId - DistributionQualificationsConnection!
|
Reads and enables pagination through a set of DistributionQualification. |
Arguments
|
|
mappedSigningTemplateByStepId - MappedSigningTemplate
|
Reads a single MappedSigningTemplate that is related to this Step. |
mappedSigningTemplatesByStepId - MappedSigningTemplatesConnection!
|
Reads and enables pagination through a set of MappedSigningTemplate. Please use mappedSigningTemplateByStepId instead
|
Arguments
|
|
sentSigningDocumentsByStepId - SentSigningDocumentsConnection!
|
Reads and enables pagination through a set of SentSigningDocument. |
Arguments
|
|
paymentIssuersByStepId - PaymentIssuersConnection!
|
Reads and enables pagination through a set of PaymentIssuer. |
Arguments
|
|
paymentInstrumentsByStepId - PaymentInstrumentsConnection!
|
Reads and enables pagination through a set of PaymentInstrument. |
Arguments
|
|
currentStep - CurrentStep
|
|
renderAttribute - JSON
|
|
shortSteps - ShortStepsConnection!
|
Reads and enables pagination through a set of ShortStep. |
Arguments
|
|
Example
{
"nodeId": "4",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"ownedBy": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"executeBy": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"status": "xyz789",
"type": "abc123",
"schema": {},
"inputData": {},
"outputData": {},
"valid": false,
"retry": 987,
"templateId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"rootStepId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"completeState": BitString,
"state": BitString,
"createdOn": Datetime,
"accountByOwnedBy": Account,
"accountByExecuteBy": Account,
"stepStatusByStatus": StepStatus,
"stepTypeByType": StepType,
"distributionByStepId": Distribution,
"distributionsByStepId": DistributionsConnection,
"accountIntegrationByStepId": AccountIntegration,
"accountIntegrationsByStepId": AccountIntegrationsConnection,
"distributionQualificationsByStepId": DistributionQualificationsConnection,
"mappedSigningTemplateByStepId": MappedSigningTemplate,
"mappedSigningTemplatesByStepId": MappedSigningTemplatesConnection,
"sentSigningDocumentsByStepId": SentSigningDocumentsConnection,
"paymentIssuersByStepId": PaymentIssuersConnection,
"paymentInstrumentsByStepId": PaymentInstrumentsConnection,
"currentStep": CurrentStep,
"renderAttribute": {},
"shortSteps": ShortStepsConnection
}
StepCondition
Description
A condition to be used against Step object types. All fields are tested for equality and combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
id - UUID
|
Checks for equality with the object’s id field. |
ownedBy - UUID
|
Checks for equality with the object’s ownedBy field. |
executeBy - UUID
|
Checks for equality with the object’s executeBy field. |
status - String
|
Checks for equality with the object’s status field. |
type - String
|
Checks for equality with the object’s type field. |
schema - JSON
|
Checks for equality with the object’s schema field. |
inputData - JSON
|
Checks for equality with the object’s inputData field. |
outputData - JSON
|
Checks for equality with the object’s outputData field. |
valid - Boolean
|
Checks for equality with the object’s valid field. |
retry - Int
|
Checks for equality with the object’s retry field. |
templateId - UUID
|
Checks for equality with the object’s templateId field. |
rootStepId - UUID
|
Checks for equality with the object’s rootStepId field. |
completeState - BitString
|
Checks for equality with the object’s completeState field. |
state - BitString
|
Checks for equality with the object’s state field. |
createdOn - Datetime
|
Checks for equality with the object’s createdOn field. |
Example
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"ownedBy": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"executeBy": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"status": "xyz789",
"type": "xyz789",
"schema": {},
"inputData": {},
"outputData": {},
"valid": false,
"retry": 123,
"templateId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"rootStepId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"completeState": BitString,
"state": BitString,
"createdOn": Datetime
}
StepFilter
Description
A filter to be used against Step object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
id - UUIDFilter
|
Filter by the object’s id field. |
ownedBy - UUIDFilter
|
Filter by the object’s ownedBy field. |
executeBy - UUIDFilter
|
Filter by the object’s executeBy field. |
status - StringFilter
|
Filter by the object’s status field. |
type - StringFilter
|
Filter by the object’s type field. |
schema - JSONFilter
|
Filter by the object’s schema field. |
inputData - JSONFilter
|
Filter by the object’s inputData field. |
outputData - JSONFilter
|
Filter by the object’s outputData field. |
valid - BooleanFilter
|
Filter by the object’s valid field. |
retry - IntFilter
|
Filter by the object’s retry field. |
templateId - UUIDFilter
|
Filter by the object’s templateId field. |
rootStepId - UUIDFilter
|
Filter by the object’s rootStepId field. |
completeState - BitStringFilter
|
Filter by the object’s completeState field. |
state - BitStringFilter
|
Filter by the object’s state field. |
createdOn - DatetimeFilter
|
Filter by the object’s createdOn field. |
distributionByStepId - DistributionFilter
|
Filter by the object’s distributionByStepId relation. |
distributionByStepIdExists - Boolean
|
A related distributionByStepId exists. |
accountIntegrationByStepId - AccountIntegrationFilter
|
Filter by the object’s accountIntegrationByStepId relation. |
accountIntegrationByStepIdExists - Boolean
|
A related accountIntegrationByStepId exists. |
distributionQualificationsByStepId - StepToManyDistributionQualificationFilter
|
Filter by the object’s distributionQualificationsByStepId relation. |
distributionQualificationsByStepIdExist - Boolean
|
Some related distributionQualificationsByStepId exist. |
mappedSigningTemplateByStepId - MappedSigningTemplateFilter
|
Filter by the object’s mappedSigningTemplateByStepId relation. |
mappedSigningTemplateByStepIdExists - Boolean
|
A related mappedSigningTemplateByStepId exists. |
sentSigningDocumentsByStepId - StepToManySentSigningDocumentFilter
|
Filter by the object’s sentSigningDocumentsByStepId relation. |
sentSigningDocumentsByStepIdExist - Boolean
|
Some related sentSigningDocumentsByStepId exist. |
paymentIssuersByStepId - StepToManyPaymentIssuerFilter
|
Filter by the object’s paymentIssuersByStepId relation. |
paymentIssuersByStepIdExist - Boolean
|
Some related paymentIssuersByStepId exist. |
paymentInstrumentsByStepId - StepToManyPaymentInstrumentFilter
|
Filter by the object’s paymentInstrumentsByStepId relation. |
paymentInstrumentsByStepIdExist - Boolean
|
Some related paymentInstrumentsByStepId exist. |
accountByOwnedBy - AccountFilter
|
Filter by the object’s accountByOwnedBy relation. |
accountByExecuteBy - AccountFilter
|
Filter by the object’s accountByExecuteBy relation. |
stepStatusByStatus - StepStatusFilter
|
Filter by the object’s stepStatusByStatus relation. |
stepTypeByType - StepTypeFilter
|
Filter by the object’s stepTypeByType relation. |
and - [StepFilter!]
|
Checks for all expressions in this list. |
or - [StepFilter!]
|
Checks for any expressions in this list. |
not - StepFilter
|
Negates the expression. |
Example
{
"id": UUIDFilter,
"ownedBy": UUIDFilter,
"executeBy": UUIDFilter,
"status": StringFilter,
"type": StringFilter,
"schema": JSONFilter,
"inputData": JSONFilter,
"outputData": JSONFilter,
"valid": BooleanFilter,
"retry": IntFilter,
"templateId": UUIDFilter,
"rootStepId": UUIDFilter,
"completeState": BitStringFilter,
"state": BitStringFilter,
"createdOn": DatetimeFilter,
"distributionByStepId": DistributionFilter,
"distributionByStepIdExists": false,
"accountIntegrationByStepId": AccountIntegrationFilter,
"accountIntegrationByStepIdExists": false,
"distributionQualificationsByStepId": StepToManyDistributionQualificationFilter,
"distributionQualificationsByStepIdExist": true,
"mappedSigningTemplateByStepId": MappedSigningTemplateFilter,
"mappedSigningTemplateByStepIdExists": false,
"sentSigningDocumentsByStepId": StepToManySentSigningDocumentFilter,
"sentSigningDocumentsByStepIdExist": true,
"paymentIssuersByStepId": StepToManyPaymentIssuerFilter,
"paymentIssuersByStepIdExist": true,
"paymentInstrumentsByStepId": StepToManyPaymentInstrumentFilter,
"paymentInstrumentsByStepIdExist": false,
"accountByOwnedBy": AccountFilter,
"accountByExecuteBy": AccountFilter,
"stepStatusByStatus": StepStatusFilter,
"stepTypeByType": StepTypeFilter,
"and": [StepFilter],
"or": [StepFilter],
"not": StepFilter
}
StepStatus
Fields
| Field Name | Description |
|---|---|
nodeId - ID!
|
A globally unique identifier. Can be used in various places throughout the system to identify this single value. |
status - String!
|
|
stepsByStatus - StepsConnection!
|
Reads and enables pagination through a set of Step. |
Arguments
|
|
Example
{
"nodeId": 4,
"status": "xyz789",
"stepsByStatus": StepsConnection
}
StepStatusCondition
Description
A condition to be used against StepStatus object types. All fields are tested for equality and combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
status - String
|
Checks for equality with the object’s status field. |
Example
{"status": "abc123"}
StepStatusFilter
Description
A filter to be used against StepStatus object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
status - StringFilter
|
Filter by the object’s status field. |
stepsByStatus - StepStatusToManyStepFilter
|
Filter by the object’s stepsByStatus relation. |
stepsByStatusExist - Boolean
|
Some related stepsByStatus exist. |
and - [StepStatusFilter!]
|
Checks for all expressions in this list. |
or - [StepStatusFilter!]
|
Checks for any expressions in this list. |
not - StepStatusFilter
|
Negates the expression. |
Example
{
"status": StringFilter,
"stepsByStatus": StepStatusToManyStepFilter,
"stepsByStatusExist": true,
"and": [StepStatusFilter],
"or": [StepStatusFilter],
"not": StepStatusFilter
}
StepStatusToManyStepFilter
Description
A filter to be used against many Step object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - StepFilter
|
Every related Step matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - StepFilter
|
Some related Step matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - StepFilter
|
No related Step matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": StepFilter,
"some": StepFilter,
"none": StepFilter
}
StepStatusesConnection
Description
A connection to a list of StepStatus values.
Fields
| Field Name | Description |
|---|---|
nodes - [StepStatus]!
|
A list of StepStatus objects. |
edges - [StepStatusesEdge!]!
|
A list of edges which contains the StepStatus and cursor to aid in pagination. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The count of all StepStatus you could get from the connection. |
Example
{
"nodes": [StepStatus],
"edges": [StepStatusesEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
StepStatusesEdge
Description
A StepStatus edge in the connection.
Fields
| Field Name | Description |
|---|---|
cursor - Cursor
|
A cursor for use in pagination. |
node - StepStatus
|
The StepStatus at the end of the edge. |
Example
{
"cursor": Cursor,
"node": StepStatus
}
StepStatusesOrderBy
Description
Methods to use when ordering StepStatus.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NATURAL"
StepToManyDistributionQualificationFilter
Description
A filter to be used against many DistributionQualification object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - DistributionQualificationFilter
|
Every related DistributionQualification matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - DistributionQualificationFilter
|
Some related DistributionQualification matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - DistributionQualificationFilter
|
No related DistributionQualification matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": DistributionQualificationFilter,
"some": DistributionQualificationFilter,
"none": DistributionQualificationFilter
}
StepToManyPaymentInstrumentFilter
Description
A filter to be used against many PaymentInstrument object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - PaymentInstrumentFilter
|
Every related PaymentInstrument matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - PaymentInstrumentFilter
|
Some related PaymentInstrument matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - PaymentInstrumentFilter
|
No related PaymentInstrument matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": PaymentInstrumentFilter,
"some": PaymentInstrumentFilter,
"none": PaymentInstrumentFilter
}
StepToManyPaymentIssuerFilter
Description
A filter to be used against many PaymentIssuer object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - PaymentIssuerFilter
|
Every related PaymentIssuer matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - PaymentIssuerFilter
|
Some related PaymentIssuer matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - PaymentIssuerFilter
|
No related PaymentIssuer matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": PaymentIssuerFilter,
"some": PaymentIssuerFilter,
"none": PaymentIssuerFilter
}
StepToManySentSigningDocumentFilter
Description
A filter to be used against many SentSigningDocument object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - SentSigningDocumentFilter
|
Every related SentSigningDocument matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - SentSigningDocumentFilter
|
Some related SentSigningDocument matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - SentSigningDocumentFilter
|
No related SentSigningDocument matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": SentSigningDocumentFilter,
"some": SentSigningDocumentFilter,
"none": SentSigningDocumentFilter
}
StepType
Fields
| Field Name | Description |
|---|---|
nodeId - ID!
|
A globally unique identifier. Can be used in various places throughout the system to identify this single value. |
type - String!
|
|
stepsByType - StepsConnection!
|
Reads and enables pagination through a set of Step. |
Arguments
|
|
Example
{
"nodeId": 4,
"type": "xyz789",
"stepsByType": StepsConnection
}
StepTypeCondition
Description
A condition to be used against StepType object types. All fields are tested for equality and combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
type - String
|
Checks for equality with the object’s type field. |
Example
{"type": "abc123"}
StepTypeFilter
Description
A filter to be used against StepType object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
type - StringFilter
|
Filter by the object’s type field. |
stepsByType - StepTypeToManyStepFilter
|
Filter by the object’s stepsByType relation. |
stepsByTypeExist - Boolean
|
Some related stepsByType exist. |
and - [StepTypeFilter!]
|
Checks for all expressions in this list. |
or - [StepTypeFilter!]
|
Checks for any expressions in this list. |
not - StepTypeFilter
|
Negates the expression. |
Example
{
"type": StringFilter,
"stepsByType": StepTypeToManyStepFilter,
"stepsByTypeExist": false,
"and": [StepTypeFilter],
"or": [StepTypeFilter],
"not": StepTypeFilter
}
StepTypeToManyStepFilter
Description
A filter to be used against many Step object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - StepFilter
|
Every related Step matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - StepFilter
|
Some related Step matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - StepFilter
|
No related Step matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": StepFilter,
"some": StepFilter,
"none": StepFilter
}
StepTypesConnection
Description
A connection to a list of StepType values.
Fields
| Field Name | Description |
|---|---|
nodes - [StepType]!
|
A list of StepType objects. |
edges - [StepTypesEdge!]!
|
A list of edges which contains the StepType and cursor to aid in pagination. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The count of all StepType you could get from the connection. |
Example
{
"nodes": [StepType],
"edges": [StepTypesEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
StepTypesEdge
StepTypesOrderBy
Description
Methods to use when ordering StepType.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NATURAL"
StepsConnection
Description
A connection to a list of Step values.
Fields
| Field Name | Description |
|---|---|
nodes - [Step]!
|
A list of Step objects. |
edges - [StepsEdge!]!
|
A list of edges which contains the Step and cursor to aid in pagination. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The count of all Step you could get from the connection. |
Example
{
"nodes": [Step],
"edges": [StepsEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
StepsEdge
StepsOrderBy
Description
Methods to use when ordering Step.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NATURAL"
String
Description
The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
Example
"xyz789"
StringFilter
Description
A filter to be used against String fields. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
isNull - Boolean
|
Is null (if true is specified) or is not null (if false is specified). |
equalTo - String
|
Equal to the specified value. |
notEqualTo - String
|
Not equal to the specified value. |
distinctFrom - String
|
Not equal to the specified value, treating null like an ordinary value. |
notDistinctFrom - String
|
Equal to the specified value, treating null like an ordinary value. |
in - [String!]
|
Included in the specified list. |
notIn - [String!]
|
Not included in the specified list. |
lessThan - String
|
Less than the specified value. |
lessThanOrEqualTo - String
|
Less than or equal to the specified value. |
greaterThan - String
|
Greater than the specified value. |
greaterThanOrEqualTo - String
|
Greater than or equal to the specified value. |
includes - String
|
Contains the specified string (case-sensitive). |
notIncludes - String
|
Does not contain the specified string (case-sensitive). |
includesInsensitive - String
|
Contains the specified string (case-insensitive). |
notIncludesInsensitive - String
|
Does not contain the specified string (case-insensitive). |
startsWith - String
|
Starts with the specified string (case-sensitive). |
notStartsWith - String
|
Does not start with the specified string (case-sensitive). |
startsWithInsensitive - String
|
Starts with the specified string (case-insensitive). |
notStartsWithInsensitive - String
|
Does not start with the specified string (case-insensitive). |
endsWith - String
|
Ends with the specified string (case-sensitive). |
notEndsWith - String
|
Does not end with the specified string (case-sensitive). |
endsWithInsensitive - String
|
Ends with the specified string (case-insensitive). |
notEndsWithInsensitive - String
|
Does not end with the specified string (case-insensitive). |
like - String
|
Matches the specified pattern (case-sensitive). An underscore (_) matches any single character; a percent sign (%) matches any sequence of zero or more characters. |
notLike - String
|
Does not match the specified pattern (case-sensitive). An underscore (_) matches any single character; a percent sign (%) matches any sequence of zero or more characters. |
likeInsensitive - String
|
Matches the specified pattern (case-insensitive). An underscore (_) matches any single character; a percent sign (%) matches any sequence of zero or more characters. |
notLikeInsensitive - String
|
Does not match the specified pattern (case-insensitive). An underscore (_) matches any single character; a percent sign (%) matches any sequence of zero or more characters. |
similarTo - String
|
Matches the specified pattern using the SQL standard's definition of a regular expression. |
notSimilarTo - String
|
Does not match the specified pattern using the SQL standard's definition of a regular expression. |
Example
{
"isNull": true,
"equalTo": "xyz789",
"notEqualTo": "xyz789",
"distinctFrom": "xyz789",
"notDistinctFrom": "xyz789",
"in": ["abc123"],
"notIn": ["abc123"],
"lessThan": "abc123",
"lessThanOrEqualTo": "xyz789",
"greaterThan": "xyz789",
"greaterThanOrEqualTo": "xyz789",
"includes": "xyz789",
"notIncludes": "xyz789",
"includesInsensitive": "abc123",
"notIncludesInsensitive": "abc123",
"startsWith": "xyz789",
"notStartsWith": "xyz789",
"startsWithInsensitive": "abc123",
"notStartsWithInsensitive": "abc123",
"endsWith": "abc123",
"notEndsWith": "abc123",
"endsWithInsensitive": "abc123",
"notEndsWithInsensitive": "abc123",
"like": "abc123",
"notLike": "xyz789",
"likeInsensitive": "xyz789",
"notLikeInsensitive": "abc123",
"similarTo": "xyz789",
"notSimilarTo": "xyz789"
}
TaRequest
Fields
| Field Name | Description |
|---|---|
nodeId - ID!
|
A globally unique identifier. Can be used in various places throughout the system to identify this single value. |
id - UUID!
|
|
vendorId - UUID!
|
|
investorId - UUID!
|
|
type - String!
|
|
status - String!
|
|
fromBlockchainAddressLocation - String!
|
|
fromBlockchainAddressId - UUID
|
|
toBlockchainAddressLocation - String!
|
|
toBlockchainAddressId - UUID
|
|
creatorAccountId - UUID!
|
|
creatorUserId - UUID!
|
|
createdOn - Datetime!
|
|
stagedTransferId - UUID
|
|
distributionId - UUID
|
|
accountByVendorId - Account
|
Reads a single Account that is related to this TaRequest. |
accountByInvestorId - Account
|
Reads a single Account that is related to this TaRequest. |
taRequestTypeByType - TaRequestType
|
Reads a single TaRequestType that is related to this TaRequest. |
taRequestStatusByStatus - TaRequestStatus
|
Reads a single TaRequestStatus that is related to this TaRequest. |
taRequestBlockchainLocationByFromBlockchainAddressLocation - TaRequestBlockchainLocation
|
Reads a single TaRequestBlockchainLocation that is related to this TaRequest. |
blockchainAddressByFromBlockchainAddressId - BlockchainAddress
|
Reads a single BlockchainAddress that is related to this TaRequest. |
taRequestBlockchainLocationByToBlockchainAddressLocation - TaRequestBlockchainLocation
|
Reads a single TaRequestBlockchainLocation that is related to this TaRequest. |
blockchainAddressByToBlockchainAddressId - BlockchainAddress
|
Reads a single BlockchainAddress that is related to this TaRequest. |
accountByCreatorAccountId - Account
|
Reads a single Account that is related to this TaRequest. |
userByCreatorUserId - User
|
Reads a single User that is related to this TaRequest. |
Example
{
"nodeId": "4",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"vendorId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"investorId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"type": "abc123",
"status": "abc123",
"fromBlockchainAddressLocation": "xyz789",
"fromBlockchainAddressId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"toBlockchainAddressLocation": "abc123",
"toBlockchainAddressId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"creatorAccountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"creatorUserId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"createdOn": Datetime,
"stagedTransferId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"distributionId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountByVendorId": Account,
"accountByInvestorId": Account,
"taRequestTypeByType": TaRequestType,
"taRequestStatusByStatus": TaRequestStatus,
"taRequestBlockchainLocationByFromBlockchainAddressLocation": TaRequestBlockchainLocation,
"blockchainAddressByFromBlockchainAddressId": BlockchainAddress,
"taRequestBlockchainLocationByToBlockchainAddressLocation": TaRequestBlockchainLocation,
"blockchainAddressByToBlockchainAddressId": BlockchainAddress,
"accountByCreatorAccountId": Account,
"userByCreatorUserId": User
}
TaRequestBlockchainLocation
Fields
| Field Name | Description |
|---|---|
nodeId - ID!
|
A globally unique identifier. Can be used in various places throughout the system to identify this single value. |
location - String!
|
|
taRequestsByFromBlockchainAddressLocation - TaRequestsConnection!
|
Reads and enables pagination through a set of TaRequest. |
Arguments
|
|
taRequestsByToBlockchainAddressLocation - TaRequestsConnection!
|
Reads and enables pagination through a set of TaRequest. |
Arguments
|
|
Example
{
"nodeId": "4",
"location": "abc123",
"taRequestsByFromBlockchainAddressLocation": TaRequestsConnection,
"taRequestsByToBlockchainAddressLocation": TaRequestsConnection
}
TaRequestBlockchainLocationCondition
Description
A condition to be used against TaRequestBlockchainLocation object types. All fields are tested for equality and combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
location - String
|
Checks for equality with the object’s location field. |
Example
{"location": "abc123"}
TaRequestBlockchainLocationFilter
Description
A filter to be used against TaRequestBlockchainLocation object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
location - StringFilter
|
Filter by the object’s location field. |
taRequestsByFromBlockchainAddressLocation - TaRequestBlockchainLocationToManyTaRequestFilter
|
Filter by the object’s taRequestsByFromBlockchainAddressLocation relation. |
taRequestsByFromBlockchainAddressLocationExist - Boolean
|
Some related taRequestsByFromBlockchainAddressLocation exist. |
taRequestsByToBlockchainAddressLocation - TaRequestBlockchainLocationToManyTaRequestFilter
|
Filter by the object’s taRequestsByToBlockchainAddressLocation relation. |
taRequestsByToBlockchainAddressLocationExist - Boolean
|
Some related taRequestsByToBlockchainAddressLocation exist. |
and - [TaRequestBlockchainLocationFilter!]
|
Checks for all expressions in this list. |
or - [TaRequestBlockchainLocationFilter!]
|
Checks for any expressions in this list. |
not - TaRequestBlockchainLocationFilter
|
Negates the expression. |
Example
{
"location": StringFilter,
"taRequestsByFromBlockchainAddressLocation": TaRequestBlockchainLocationToManyTaRequestFilter,
"taRequestsByFromBlockchainAddressLocationExist": true,
"taRequestsByToBlockchainAddressLocation": TaRequestBlockchainLocationToManyTaRequestFilter,
"taRequestsByToBlockchainAddressLocationExist": false,
"and": [TaRequestBlockchainLocationFilter],
"or": [TaRequestBlockchainLocationFilter],
"not": TaRequestBlockchainLocationFilter
}
TaRequestBlockchainLocationToManyTaRequestFilter
Description
A filter to be used against many TaRequest object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - TaRequestFilter
|
Every related TaRequest matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - TaRequestFilter
|
Some related TaRequest matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - TaRequestFilter
|
No related TaRequest matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": TaRequestFilter,
"some": TaRequestFilter,
"none": TaRequestFilter
}
TaRequestBlockchainLocationsConnection
Description
A connection to a list of TaRequestBlockchainLocation values.
Fields
| Field Name | Description |
|---|---|
nodes - [TaRequestBlockchainLocation]!
|
A list of TaRequestBlockchainLocation objects. |
edges - [TaRequestBlockchainLocationsEdge!]!
|
A list of edges which contains the TaRequestBlockchainLocation and cursor to aid in pagination. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The count of all TaRequestBlockchainLocation you could get from the connection. |
Example
{
"nodes": [TaRequestBlockchainLocation],
"edges": [TaRequestBlockchainLocationsEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
TaRequestBlockchainLocationsEdge
Description
A TaRequestBlockchainLocation edge in the connection.
Fields
| Field Name | Description |
|---|---|
cursor - Cursor
|
A cursor for use in pagination. |
node - TaRequestBlockchainLocation
|
The TaRequestBlockchainLocation at the end of the edge. |
Example
{
"cursor": Cursor,
"node": TaRequestBlockchainLocation
}
TaRequestBlockchainLocationsOrderBy
Description
Methods to use when ordering TaRequestBlockchainLocation.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NATURAL"
TaRequestCondition
Description
A condition to be used against TaRequest object types. All fields are tested for equality and combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
id - UUID
|
Checks for equality with the object’s id field. |
vendorId - UUID
|
Checks for equality with the object’s vendorId field. |
investorId - UUID
|
Checks for equality with the object’s investorId field. |
type - String
|
Checks for equality with the object’s type field. |
status - String
|
Checks for equality with the object’s status field. |
fromBlockchainAddressLocation - String
|
Checks for equality with the object’s fromBlockchainAddressLocation field. |
fromBlockchainAddressId - UUID
|
Checks for equality with the object’s fromBlockchainAddressId field. |
toBlockchainAddressLocation - String
|
Checks for equality with the object’s toBlockchainAddressLocation field. |
toBlockchainAddressId - UUID
|
Checks for equality with the object’s toBlockchainAddressId field. |
creatorAccountId - UUID
|
Checks for equality with the object’s creatorAccountId field. |
creatorUserId - UUID
|
Checks for equality with the object’s creatorUserId field. |
createdOn - Datetime
|
Checks for equality with the object’s createdOn field. |
stagedTransferId - UUID
|
Checks for equality with the object’s stagedTransferId field. |
distributionId - UUID
|
Checks for equality with the object’s distributionId field. |
Example
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"vendorId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"investorId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"type": "abc123",
"status": "abc123",
"fromBlockchainAddressLocation": "abc123",
"fromBlockchainAddressId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"toBlockchainAddressLocation": "abc123",
"toBlockchainAddressId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"creatorAccountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"creatorUserId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"createdOn": Datetime,
"stagedTransferId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"distributionId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
TaRequestFilter
Description
A filter to be used against TaRequest object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
id - UUIDFilter
|
Filter by the object’s id field. |
vendorId - UUIDFilter
|
Filter by the object’s vendorId field. |
investorId - UUIDFilter
|
Filter by the object’s investorId field. |
type - StringFilter
|
Filter by the object’s type field. |
status - StringFilter
|
Filter by the object’s status field. |
fromBlockchainAddressLocation - StringFilter
|
Filter by the object’s fromBlockchainAddressLocation field. |
fromBlockchainAddressId - UUIDFilter
|
Filter by the object’s fromBlockchainAddressId field. |
toBlockchainAddressLocation - StringFilter
|
Filter by the object’s toBlockchainAddressLocation field. |
toBlockchainAddressId - UUIDFilter
|
Filter by the object’s toBlockchainAddressId field. |
creatorAccountId - UUIDFilter
|
Filter by the object’s creatorAccountId field. |
creatorUserId - UUIDFilter
|
Filter by the object’s creatorUserId field. |
createdOn - DatetimeFilter
|
Filter by the object’s createdOn field. |
stagedTransferId - UUIDFilter
|
Filter by the object’s stagedTransferId field. |
distributionId - UUIDFilter
|
Filter by the object’s distributionId field. |
accountByVendorId - AccountFilter
|
Filter by the object’s accountByVendorId relation. |
accountByInvestorId - AccountFilter
|
Filter by the object’s accountByInvestorId relation. |
taRequestTypeByType - TaRequestTypeFilter
|
Filter by the object’s taRequestTypeByType relation. |
taRequestStatusByStatus - TaRequestStatusFilter
|
Filter by the object’s taRequestStatusByStatus relation. |
taRequestBlockchainLocationByFromBlockchainAddressLocation - TaRequestBlockchainLocationFilter
|
Filter by the object’s taRequestBlockchainLocationByFromBlockchainAddressLocation relation. |
blockchainAddressByFromBlockchainAddressId - BlockchainAddressFilter
|
Filter by the object’s blockchainAddressByFromBlockchainAddressId relation. |
blockchainAddressByFromBlockchainAddressIdExists - Boolean
|
A related blockchainAddressByFromBlockchainAddressId exists. |
taRequestBlockchainLocationByToBlockchainAddressLocation - TaRequestBlockchainLocationFilter
|
Filter by the object’s taRequestBlockchainLocationByToBlockchainAddressLocation relation. |
blockchainAddressByToBlockchainAddressId - BlockchainAddressFilter
|
Filter by the object’s blockchainAddressByToBlockchainAddressId relation. |
blockchainAddressByToBlockchainAddressIdExists - Boolean
|
A related blockchainAddressByToBlockchainAddressId exists. |
accountByCreatorAccountId - AccountFilter
|
Filter by the object’s accountByCreatorAccountId relation. |
userByCreatorUserId - UserFilter
|
Filter by the object’s userByCreatorUserId relation. |
and - [TaRequestFilter!]
|
Checks for all expressions in this list. |
or - [TaRequestFilter!]
|
Checks for any expressions in this list. |
not - TaRequestFilter
|
Negates the expression. |
Example
{
"id": UUIDFilter,
"vendorId": UUIDFilter,
"investorId": UUIDFilter,
"type": StringFilter,
"status": StringFilter,
"fromBlockchainAddressLocation": StringFilter,
"fromBlockchainAddressId": UUIDFilter,
"toBlockchainAddressLocation": StringFilter,
"toBlockchainAddressId": UUIDFilter,
"creatorAccountId": UUIDFilter,
"creatorUserId": UUIDFilter,
"createdOn": DatetimeFilter,
"stagedTransferId": UUIDFilter,
"distributionId": UUIDFilter,
"accountByVendorId": AccountFilter,
"accountByInvestorId": AccountFilter,
"taRequestTypeByType": TaRequestTypeFilter,
"taRequestStatusByStatus": TaRequestStatusFilter,
"taRequestBlockchainLocationByFromBlockchainAddressLocation": TaRequestBlockchainLocationFilter,
"blockchainAddressByFromBlockchainAddressId": BlockchainAddressFilter,
"blockchainAddressByFromBlockchainAddressIdExists": true,
"taRequestBlockchainLocationByToBlockchainAddressLocation": TaRequestBlockchainLocationFilter,
"blockchainAddressByToBlockchainAddressId": BlockchainAddressFilter,
"blockchainAddressByToBlockchainAddressIdExists": true,
"accountByCreatorAccountId": AccountFilter,
"userByCreatorUserId": UserFilter,
"and": [TaRequestFilter],
"or": [TaRequestFilter],
"not": TaRequestFilter
}
TaRequestStatus
Fields
| Field Name | Description |
|---|---|
nodeId - ID!
|
A globally unique identifier. Can be used in various places throughout the system to identify this single value. |
status - String!
|
|
taRequestsByStatus - TaRequestsConnection!
|
Reads and enables pagination through a set of TaRequest. |
Arguments
|
|
Example
{
"nodeId": 4,
"status": "abc123",
"taRequestsByStatus": TaRequestsConnection
}
TaRequestStatusCondition
Description
A condition to be used against TaRequestStatus object types. All fields are tested for equality and combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
status - String
|
Checks for equality with the object’s status field. |
Example
{"status": "xyz789"}
TaRequestStatusFilter
Description
A filter to be used against TaRequestStatus object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
status - StringFilter
|
Filter by the object’s status field. |
taRequestsByStatus - TaRequestStatusToManyTaRequestFilter
|
Filter by the object’s taRequestsByStatus relation. |
taRequestsByStatusExist - Boolean
|
Some related taRequestsByStatus exist. |
and - [TaRequestStatusFilter!]
|
Checks for all expressions in this list. |
or - [TaRequestStatusFilter!]
|
Checks for any expressions in this list. |
not - TaRequestStatusFilter
|
Negates the expression. |
Example
{
"status": StringFilter,
"taRequestsByStatus": TaRequestStatusToManyTaRequestFilter,
"taRequestsByStatusExist": false,
"and": [TaRequestStatusFilter],
"or": [TaRequestStatusFilter],
"not": TaRequestStatusFilter
}
TaRequestStatusToManyTaRequestFilter
Description
A filter to be used against many TaRequest object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - TaRequestFilter
|
Every related TaRequest matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - TaRequestFilter
|
Some related TaRequest matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - TaRequestFilter
|
No related TaRequest matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": TaRequestFilter,
"some": TaRequestFilter,
"none": TaRequestFilter
}
TaRequestStatusesConnection
Description
A connection to a list of TaRequestStatus values.
Fields
| Field Name | Description |
|---|---|
nodes - [TaRequestStatus]!
|
A list of TaRequestStatus objects. |
edges - [TaRequestStatusesEdge!]!
|
A list of edges which contains the TaRequestStatus and cursor to aid in pagination. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The count of all TaRequestStatus you could get from the connection. |
Example
{
"nodes": [TaRequestStatus],
"edges": [TaRequestStatusesEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
TaRequestStatusesEdge
Description
A TaRequestStatus edge in the connection.
Fields
| Field Name | Description |
|---|---|
cursor - Cursor
|
A cursor for use in pagination. |
node - TaRequestStatus
|
The TaRequestStatus at the end of the edge. |
Example
{
"cursor": Cursor,
"node": TaRequestStatus
}
TaRequestStatusesOrderBy
Description
Methods to use when ordering TaRequestStatus.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NATURAL"
TaRequestType
Fields
| Field Name | Description |
|---|---|
nodeId - ID!
|
A globally unique identifier. Can be used in various places throughout the system to identify this single value. |
type - String!
|
|
taRequestsByType - TaRequestsConnection!
|
Reads and enables pagination through a set of TaRequest. |
Arguments
|
|
Example
{
"nodeId": "4",
"type": "xyz789",
"taRequestsByType": TaRequestsConnection
}
TaRequestTypeCondition
Description
A condition to be used against TaRequestType object types. All fields are tested for equality and combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
type - String
|
Checks for equality with the object’s type field. |
Example
{"type": "xyz789"}
TaRequestTypeFilter
Description
A filter to be used against TaRequestType object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
type - StringFilter
|
Filter by the object’s type field. |
taRequestsByType - TaRequestTypeToManyTaRequestFilter
|
Filter by the object’s taRequestsByType relation. |
taRequestsByTypeExist - Boolean
|
Some related taRequestsByType exist. |
and - [TaRequestTypeFilter!]
|
Checks for all expressions in this list. |
or - [TaRequestTypeFilter!]
|
Checks for any expressions in this list. |
not - TaRequestTypeFilter
|
Negates the expression. |
Example
{
"type": StringFilter,
"taRequestsByType": TaRequestTypeToManyTaRequestFilter,
"taRequestsByTypeExist": false,
"and": [TaRequestTypeFilter],
"or": [TaRequestTypeFilter],
"not": TaRequestTypeFilter
}
TaRequestTypeToManyTaRequestFilter
Description
A filter to be used against many TaRequest object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - TaRequestFilter
|
Every related TaRequest matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - TaRequestFilter
|
Some related TaRequest matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - TaRequestFilter
|
No related TaRequest matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": TaRequestFilter,
"some": TaRequestFilter,
"none": TaRequestFilter
}
TaRequestTypesConnection
Description
A connection to a list of TaRequestType values.
Fields
| Field Name | Description |
|---|---|
nodes - [TaRequestType]!
|
A list of TaRequestType objects. |
edges - [TaRequestTypesEdge!]!
|
A list of edges which contains the TaRequestType and cursor to aid in pagination. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The count of all TaRequestType you could get from the connection. |
Example
{
"nodes": [TaRequestType],
"edges": [TaRequestTypesEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
TaRequestTypesEdge
Description
A TaRequestType edge in the connection.
Fields
| Field Name | Description |
|---|---|
cursor - Cursor
|
A cursor for use in pagination. |
node - TaRequestType
|
The TaRequestType at the end of the edge. |
Example
{
"cursor": Cursor,
"node": TaRequestType
}
TaRequestTypesOrderBy
Description
Methods to use when ordering TaRequestType.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NATURAL"
TaRequestsConnection
Description
A connection to a list of TaRequest values.
Fields
| Field Name | Description |
|---|---|
nodes - [TaRequest]!
|
A list of TaRequest objects. |
edges - [TaRequestsEdge!]!
|
A list of edges which contains the TaRequest and cursor to aid in pagination. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The count of all TaRequest you could get from the connection. |
Example
{
"nodes": [TaRequest],
"edges": [TaRequestsEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
TaRequestsEdge
TaRequestsOrderBy
Description
Methods to use when ordering TaRequest.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NATURAL"
TaxRegion
Fields
| Field Name | Description |
|---|---|
nodeId - ID!
|
A globally unique identifier. Can be used in various places throughout the system to identify this single value. |
id - UUID!
|
|
name - String!
|
|
countryId - UUID!
|
|
regex - String!
|
|
format - String!
|
|
countryByCountryId - Country
|
Reads a single Country that is related to this TaxRegion. |
accountTaxInformationsByTaxRegionId - AccountTaxInformationsConnection!
|
Reads and enables pagination through a set of AccountTaxInformation. |
Arguments
|
|
Example
{
"nodeId": "4",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"name": "xyz789",
"countryId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"regex": "xyz789",
"format": "abc123",
"countryByCountryId": Country,
"accountTaxInformationsByTaxRegionId": AccountTaxInformationsConnection
}
TaxRegionCondition
Description
A condition to be used against TaxRegion object types. All fields are tested for equality and combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
id - UUID
|
Checks for equality with the object’s id field. |
name - String
|
Checks for equality with the object’s name field. |
countryId - UUID
|
Checks for equality with the object’s countryId field. |
regex - String
|
Checks for equality with the object’s regex field. |
format - String
|
Checks for equality with the object’s format field. |
Example
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"name": "abc123",
"countryId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"regex": "xyz789",
"format": "xyz789"
}
TaxRegionFilter
Description
A filter to be used against TaxRegion object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
id - UUIDFilter
|
Filter by the object’s id field. |
name - StringFilter
|
Filter by the object’s name field. |
countryId - UUIDFilter
|
Filter by the object’s countryId field. |
regex - StringFilter
|
Filter by the object’s regex field. |
format - StringFilter
|
Filter by the object’s format field. |
accountTaxInformationsByTaxRegionId - TaxRegionToManyAccountTaxInformationFilter
|
Filter by the object’s accountTaxInformationsByTaxRegionId relation. |
accountTaxInformationsByTaxRegionIdExist - Boolean
|
Some related accountTaxInformationsByTaxRegionId exist. |
countryByCountryId - CountryFilter
|
Filter by the object’s countryByCountryId relation. |
and - [TaxRegionFilter!]
|
Checks for all expressions in this list. |
or - [TaxRegionFilter!]
|
Checks for any expressions in this list. |
not - TaxRegionFilter
|
Negates the expression. |
Example
{
"id": UUIDFilter,
"name": StringFilter,
"countryId": UUIDFilter,
"regex": StringFilter,
"format": StringFilter,
"accountTaxInformationsByTaxRegionId": TaxRegionToManyAccountTaxInformationFilter,
"accountTaxInformationsByTaxRegionIdExist": true,
"countryByCountryId": CountryFilter,
"and": [TaxRegionFilter],
"or": [TaxRegionFilter],
"not": TaxRegionFilter
}
TaxRegionToManyAccountTaxInformationFilter
Description
A filter to be used against many AccountTaxInformation object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - AccountTaxInformationFilter
|
Every related AccountTaxInformation matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - AccountTaxInformationFilter
|
Some related AccountTaxInformation matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - AccountTaxInformationFilter
|
No related AccountTaxInformation matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": AccountTaxInformationFilter,
"some": AccountTaxInformationFilter,
"none": AccountTaxInformationFilter
}
TaxRegionsConnection
Description
A connection to a list of TaxRegion values.
Fields
| Field Name | Description |
|---|---|
nodes - [TaxRegion]!
|
A list of TaxRegion objects. |
edges - [TaxRegionsEdge!]!
|
A list of edges which contains the TaxRegion and cursor to aid in pagination. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The count of all TaxRegion you could get from the connection. |
Example
{
"nodes": [TaxRegion],
"edges": [TaxRegionsEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
TaxRegionsEdge
TaxRegionsOrderBy
Description
Methods to use when ordering TaxRegion.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NATURAL"
TermsOfService
Fields
| Field Name | Description |
|---|---|
nodeId - ID!
|
A globally unique identifier. Can be used in various places throughout the system to identify this single value. |
id - UUID!
|
|
type - String!
|
|
agreement - String!
|
|
createdOn - Datetime
|
|
termsOfServiceTypeByType - TermsOfServiceType
|
Reads a single TermsOfServiceType that is related to this TermsOfService. |
userTermsOfServicesByTermsOfServiceId - UserTermsOfServicesConnection!
|
Reads and enables pagination through a set of UserTermsOfService. |
Arguments
|
|
Example
{
"nodeId": "4",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"type": "abc123",
"agreement": "abc123",
"createdOn": Datetime,
"termsOfServiceTypeByType": TermsOfServiceType,
"userTermsOfServicesByTermsOfServiceId": UserTermsOfServicesConnection
}
TermsOfServiceCondition
Description
A condition to be used against TermsOfService object types. All fields are tested for equality and combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
id - UUID
|
Checks for equality with the object’s id field. |
type - String
|
Checks for equality with the object’s type field. |
agreement - String
|
Checks for equality with the object’s agreement field. |
createdOn - Datetime
|
Checks for equality with the object’s createdOn field. |
Example
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"type": "xyz789",
"agreement": "xyz789",
"createdOn": Datetime
}
TermsOfServiceFilter
Description
A filter to be used against TermsOfService object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
id - UUIDFilter
|
Filter by the object’s id field. |
type - StringFilter
|
Filter by the object’s type field. |
agreement - StringFilter
|
Filter by the object’s agreement field. |
createdOn - DatetimeFilter
|
Filter by the object’s createdOn field. |
userTermsOfServicesByTermsOfServiceId - TermsOfServiceToManyUserTermsOfServiceFilter
|
Filter by the object’s userTermsOfServicesByTermsOfServiceId relation. |
userTermsOfServicesByTermsOfServiceIdExist - Boolean
|
Some related userTermsOfServicesByTermsOfServiceId exist. |
termsOfServiceTypeByType - TermsOfServiceTypeFilter
|
Filter by the object’s termsOfServiceTypeByType relation. |
and - [TermsOfServiceFilter!]
|
Checks for all expressions in this list. |
or - [TermsOfServiceFilter!]
|
Checks for any expressions in this list. |
not - TermsOfServiceFilter
|
Negates the expression. |
Example
{
"id": UUIDFilter,
"type": StringFilter,
"agreement": StringFilter,
"createdOn": DatetimeFilter,
"userTermsOfServicesByTermsOfServiceId": TermsOfServiceToManyUserTermsOfServiceFilter,
"userTermsOfServicesByTermsOfServiceIdExist": true,
"termsOfServiceTypeByType": TermsOfServiceTypeFilter,
"and": [TermsOfServiceFilter],
"or": [TermsOfServiceFilter],
"not": TermsOfServiceFilter
}
TermsOfServiceToManyUserTermsOfServiceFilter
Description
A filter to be used against many UserTermsOfService object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - UserTermsOfServiceFilter
|
Every related UserTermsOfService matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - UserTermsOfServiceFilter
|
Some related UserTermsOfService matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - UserTermsOfServiceFilter
|
No related UserTermsOfService matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": UserTermsOfServiceFilter,
"some": UserTermsOfServiceFilter,
"none": UserTermsOfServiceFilter
}
TermsOfServiceType
Fields
| Field Name | Description |
|---|---|
nodeId - ID!
|
A globally unique identifier. Can be used in various places throughout the system to identify this single value. |
type - String!
|
|
termsOfServicesByType - TermsOfServicesConnection!
|
Reads and enables pagination through a set of TermsOfService. |
Arguments
|
|
Example
{
"nodeId": "4",
"type": "xyz789",
"termsOfServicesByType": TermsOfServicesConnection
}
TermsOfServiceTypeCondition
Description
A condition to be used against TermsOfServiceType object types. All fields are tested for equality and combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
type - String
|
Checks for equality with the object’s type field. |
Example
{"type": "abc123"}
TermsOfServiceTypeFilter
Description
A filter to be used against TermsOfServiceType object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
type - StringFilter
|
Filter by the object’s type field. |
termsOfServicesByType - TermsOfServiceTypeToManyTermsOfServiceFilter
|
Filter by the object’s termsOfServicesByType relation. |
termsOfServicesByTypeExist - Boolean
|
Some related termsOfServicesByType exist. |
and - [TermsOfServiceTypeFilter!]
|
Checks for all expressions in this list. |
or - [TermsOfServiceTypeFilter!]
|
Checks for any expressions in this list. |
not - TermsOfServiceTypeFilter
|
Negates the expression. |
Example
{
"type": StringFilter,
"termsOfServicesByType": TermsOfServiceTypeToManyTermsOfServiceFilter,
"termsOfServicesByTypeExist": true,
"and": [TermsOfServiceTypeFilter],
"or": [TermsOfServiceTypeFilter],
"not": TermsOfServiceTypeFilter
}
TermsOfServiceTypeToManyTermsOfServiceFilter
Description
A filter to be used against many TermsOfService object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - TermsOfServiceFilter
|
Every related TermsOfService matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - TermsOfServiceFilter
|
Some related TermsOfService matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - TermsOfServiceFilter
|
No related TermsOfService matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": TermsOfServiceFilter,
"some": TermsOfServiceFilter,
"none": TermsOfServiceFilter
}
TermsOfServiceTypesConnection
Description
A connection to a list of TermsOfServiceType values.
Fields
| Field Name | Description |
|---|---|
nodes - [TermsOfServiceType]!
|
A list of TermsOfServiceType objects. |
edges - [TermsOfServiceTypesEdge!]!
|
A list of edges which contains the TermsOfServiceType and cursor to aid in pagination. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The count of all TermsOfServiceType you could get from the connection. |
Example
{
"nodes": [TermsOfServiceType],
"edges": [TermsOfServiceTypesEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
TermsOfServiceTypesEdge
Description
A TermsOfServiceType edge in the connection.
Fields
| Field Name | Description |
|---|---|
cursor - Cursor
|
A cursor for use in pagination. |
node - TermsOfServiceType
|
The TermsOfServiceType at the end of the edge. |
Example
{
"cursor": Cursor,
"node": TermsOfServiceType
}
TermsOfServiceTypesOrderBy
Description
Methods to use when ordering TermsOfServiceType.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NATURAL"
TermsOfServicesConnection
Description
A connection to a list of TermsOfService values.
Fields
| Field Name | Description |
|---|---|
nodes - [TermsOfService]!
|
A list of TermsOfService objects. |
edges - [TermsOfServicesEdge!]!
|
A list of edges which contains the TermsOfService and cursor to aid in pagination. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The count of all TermsOfService you could get from the connection. |
Example
{
"nodes": [TermsOfService],
"edges": [TermsOfServicesEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
TermsOfServicesEdge
Description
A TermsOfService edge in the connection.
Fields
| Field Name | Description |
|---|---|
cursor - Cursor
|
A cursor for use in pagination. |
node - TermsOfService
|
The TermsOfService at the end of the edge. |
Example
{
"cursor": Cursor,
"node": TermsOfService
}
TermsOfServicesOrderBy
Description
Methods to use when ordering TermsOfService.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NATURAL"
Token
Fields
| Field Name | Description |
|---|---|
nodeId - ID!
|
A globally unique identifier. Can be used in various places throughout the system to identify this single value. |
status - String!
|
|
type - String!
|
|
name - String!
|
|
symbol - String!
|
|
precision - Int!
|
|
total - BigFloat!
|
|
chainData - JSON
|
|
id - UUID!
|
|
tokenStatusByStatus - TokenStatus
|
Reads a single TokenStatus that is related to this Token. |
tokenTypeByType - TokenType
|
Reads a single TokenType that is related to this Token. |
currenciesByTokenId - CurrenciesConnection!
|
Reads and enables pagination through a set of Currency. |
Arguments
|
|
capTablesByTokenId - CapTablesConnection!
|
Reads and enables pagination through a set of CapTable. |
Arguments
|
|
roundByTokenId - Round
|
Reads a single Round that is related to this Token. |
roundsByTokenId - RoundsConnection!
|
Reads and enables pagination through a set of Round. Please use roundByTokenId instead
|
Arguments
|
|
ledgersByTokenId - LedgersConnection!
|
Reads and enables pagination through a set of Ledger. |
Arguments
|
|
contractsByTokenId - ContractsConnection!
|
Reads and enables pagination through a set of Contract. |
Arguments
|
|
coinbaseBuyPriceUSD - Float
|
|
coinbaseSellPriceUSD - Float
|
|
coinbaseSpotPriceUSD - Float
|
|
Example
{
"nodeId": "4",
"status": "abc123",
"type": "abc123",
"name": "abc123",
"symbol": "abc123",
"precision": 123,
"total": BigFloat,
"chainData": {},
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"tokenStatusByStatus": TokenStatus,
"tokenTypeByType": TokenType,
"currenciesByTokenId": CurrenciesConnection,
"capTablesByTokenId": CapTablesConnection,
"roundByTokenId": Round,
"roundsByTokenId": RoundsConnection,
"ledgersByTokenId": LedgersConnection,
"contractsByTokenId": ContractsConnection,
"coinbaseBuyPriceUSD": 123.45,
"coinbaseSellPriceUSD": 987.65,
"coinbaseSpotPriceUSD": 987.65
}
TokenCondition
Description
A condition to be used against Token object types. All fields are tested for equality and combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
status - String
|
Checks for equality with the object’s status field. |
type - String
|
Checks for equality with the object’s type field. |
name - String
|
Checks for equality with the object’s name field. |
symbol - String
|
Checks for equality with the object’s symbol field. |
precision - Int
|
Checks for equality with the object’s precision field. |
total - BigFloat
|
Checks for equality with the object’s total field. |
chainData - JSON
|
Checks for equality with the object’s chainData field. |
id - UUID
|
Checks for equality with the object’s id field. |
Example
{
"status": "abc123",
"type": "xyz789",
"name": "xyz789",
"symbol": "abc123",
"precision": 987,
"total": BigFloat,
"chainData": {},
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
TokenFilter
Description
A filter to be used against Token object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
status - StringFilter
|
Filter by the object’s status field. |
type - StringFilter
|
Filter by the object’s type field. |
name - StringFilter
|
Filter by the object’s name field. |
symbol - StringFilter
|
Filter by the object’s symbol field. |
precision - IntFilter
|
Filter by the object’s precision field. |
total - BigFloatFilter
|
Filter by the object’s total field. |
chainData - JSONFilter
|
Filter by the object’s chainData field. |
id - UUIDFilter
|
Filter by the object’s id field. |
currenciesByTokenId - TokenToManyCurrencyFilter
|
Filter by the object’s currenciesByTokenId relation. |
currenciesByTokenIdExist - Boolean
|
Some related currenciesByTokenId exist. |
capTablesByTokenId - TokenToManyCapTableFilter
|
Filter by the object’s capTablesByTokenId relation. |
capTablesByTokenIdExist - Boolean
|
Some related capTablesByTokenId exist. |
roundByTokenId - RoundFilter
|
Filter by the object’s roundByTokenId relation. |
roundByTokenIdExists - Boolean
|
A related roundByTokenId exists. |
ledgersByTokenId - TokenToManyLedgerFilter
|
Filter by the object’s ledgersByTokenId relation. |
ledgersByTokenIdExist - Boolean
|
Some related ledgersByTokenId exist. |
contractsByTokenId - TokenToManyContractFilter
|
Filter by the object’s contractsByTokenId relation. |
contractsByTokenIdExist - Boolean
|
Some related contractsByTokenId exist. |
tokenStatusByStatus - TokenStatusFilter
|
Filter by the object’s tokenStatusByStatus relation. |
tokenTypeByType - TokenTypeFilter
|
Filter by the object’s tokenTypeByType relation. |
and - [TokenFilter!]
|
Checks for all expressions in this list. |
or - [TokenFilter!]
|
Checks for any expressions in this list. |
not - TokenFilter
|
Negates the expression. |
Example
{
"status": StringFilter,
"type": StringFilter,
"name": StringFilter,
"symbol": StringFilter,
"precision": IntFilter,
"total": BigFloatFilter,
"chainData": JSONFilter,
"id": UUIDFilter,
"currenciesByTokenId": TokenToManyCurrencyFilter,
"currenciesByTokenIdExist": false,
"capTablesByTokenId": TokenToManyCapTableFilter,
"capTablesByTokenIdExist": true,
"roundByTokenId": RoundFilter,
"roundByTokenIdExists": true,
"ledgersByTokenId": TokenToManyLedgerFilter,
"ledgersByTokenIdExist": true,
"contractsByTokenId": TokenToManyContractFilter,
"contractsByTokenIdExist": true,
"tokenStatusByStatus": TokenStatusFilter,
"tokenTypeByType": TokenTypeFilter,
"and": [TokenFilter],
"or": [TokenFilter],
"not": TokenFilter
}
TokenStatus
Fields
| Field Name | Description |
|---|---|
nodeId - ID!
|
A globally unique identifier. Can be used in various places throughout the system to identify this single value. |
status - String!
|
|
tokensByStatus - TokensConnection!
|
Reads and enables pagination through a set of Token. |
Arguments
|
|
Example
{
"nodeId": "4",
"status": "abc123",
"tokensByStatus": TokensConnection
}
TokenStatusCondition
Description
A condition to be used against TokenStatus object types. All fields are tested for equality and combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
status - String
|
Checks for equality with the object’s status field. |
Example
{"status": "xyz789"}
TokenStatusFilter
Description
A filter to be used against TokenStatus object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
status - StringFilter
|
Filter by the object’s status field. |
tokensByStatus - TokenStatusToManyTokenFilter
|
Filter by the object’s tokensByStatus relation. |
tokensByStatusExist - Boolean
|
Some related tokensByStatus exist. |
and - [TokenStatusFilter!]
|
Checks for all expressions in this list. |
or - [TokenStatusFilter!]
|
Checks for any expressions in this list. |
not - TokenStatusFilter
|
Negates the expression. |
Example
{
"status": StringFilter,
"tokensByStatus": TokenStatusToManyTokenFilter,
"tokensByStatusExist": false,
"and": [TokenStatusFilter],
"or": [TokenStatusFilter],
"not": TokenStatusFilter
}
TokenStatusToManyTokenFilter
Description
A filter to be used against many Token object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - TokenFilter
|
Every related Token matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - TokenFilter
|
Some related Token matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - TokenFilter
|
No related Token matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": TokenFilter,
"some": TokenFilter,
"none": TokenFilter
}
TokenStatusesConnection
Description
A connection to a list of TokenStatus values.
Fields
| Field Name | Description |
|---|---|
nodes - [TokenStatus]!
|
A list of TokenStatus objects. |
edges - [TokenStatusesEdge!]!
|
A list of edges which contains the TokenStatus and cursor to aid in pagination. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The count of all TokenStatus you could get from the connection. |
Example
{
"nodes": [TokenStatus],
"edges": [TokenStatusesEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
TokenStatusesEdge
Description
A TokenStatus edge in the connection.
Fields
| Field Name | Description |
|---|---|
cursor - Cursor
|
A cursor for use in pagination. |
node - TokenStatus
|
The TokenStatus at the end of the edge. |
Example
{
"cursor": Cursor,
"node": TokenStatus
}
TokenStatusesOrderBy
Description
Methods to use when ordering TokenStatus.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NATURAL"
TokenToManyCapTableFilter
Description
A filter to be used against many CapTable object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - CapTableFilter
|
Every related CapTable matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - CapTableFilter
|
Some related CapTable matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - CapTableFilter
|
No related CapTable matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": CapTableFilter,
"some": CapTableFilter,
"none": CapTableFilter
}
TokenToManyContractFilter
Description
A filter to be used against many Contract object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - ContractFilter
|
Every related Contract matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - ContractFilter
|
Some related Contract matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - ContractFilter
|
No related Contract matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": ContractFilter,
"some": ContractFilter,
"none": ContractFilter
}
TokenToManyCurrencyFilter
Description
A filter to be used against many Currency object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - CurrencyFilter
|
Every related Currency matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - CurrencyFilter
|
Some related Currency matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - CurrencyFilter
|
No related Currency matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": CurrencyFilter,
"some": CurrencyFilter,
"none": CurrencyFilter
}
TokenToManyLedgerFilter
Description
A filter to be used against many Ledger object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - LedgerFilter
|
Every related Ledger matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - LedgerFilter
|
Some related Ledger matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - LedgerFilter
|
No related Ledger matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": LedgerFilter,
"some": LedgerFilter,
"none": LedgerFilter
}
TokenType
Fields
| Field Name | Description |
|---|---|
nodeId - ID!
|
A globally unique identifier. Can be used in various places throughout the system to identify this single value. |
type - String!
|
|
tokensByType - TokensConnection!
|
Reads and enables pagination through a set of Token. |
Arguments
|
|
Example
{
"nodeId": "4",
"type": "xyz789",
"tokensByType": TokensConnection
}
TokenTypeCondition
Description
A condition to be used against TokenType object types. All fields are tested for equality and combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
type - String
|
Checks for equality with the object’s type field. |
Example
{"type": "xyz789"}
TokenTypeFilter
Description
A filter to be used against TokenType object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
type - StringFilter
|
Filter by the object’s type field. |
tokensByType - TokenTypeToManyTokenFilter
|
Filter by the object’s tokensByType relation. |
tokensByTypeExist - Boolean
|
Some related tokensByType exist. |
and - [TokenTypeFilter!]
|
Checks for all expressions in this list. |
or - [TokenTypeFilter!]
|
Checks for any expressions in this list. |
not - TokenTypeFilter
|
Negates the expression. |
Example
{
"type": StringFilter,
"tokensByType": TokenTypeToManyTokenFilter,
"tokensByTypeExist": true,
"and": [TokenTypeFilter],
"or": [TokenTypeFilter],
"not": TokenTypeFilter
}
TokenTypeToManyTokenFilter
Description
A filter to be used against many Token object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - TokenFilter
|
Every related Token matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - TokenFilter
|
Some related Token matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - TokenFilter
|
No related Token matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": TokenFilter,
"some": TokenFilter,
"none": TokenFilter
}
TokenTypesConnection
Description
A connection to a list of TokenType values.
Fields
| Field Name | Description |
|---|---|
nodes - [TokenType]!
|
A list of TokenType objects. |
edges - [TokenTypesEdge!]!
|
A list of edges which contains the TokenType and cursor to aid in pagination. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The count of all TokenType you could get from the connection. |
Example
{
"nodes": [TokenType],
"edges": [TokenTypesEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
TokenTypesEdge
TokenTypesOrderBy
Description
Methods to use when ordering TokenType.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NATURAL"
TokenizeHoldingsInput
Description
All input for the tokenizeHoldings mutation.
Example
{
"clientMutationId": "abc123",
"holdingIds": [
"429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
]
}
TokenizeHoldingsPayload
Description
The output of our tokenizeHoldings mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
The exact same clientMutationId that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations. |
holdings - [Holding]
|
|
query - Query
|
Our root query field type. Allows us to run any query from our mutation payload. |
Example
{
"clientMutationId": "xyz789",
"holdings": [Holding],
"query": Query
}
TokensConnection
Description
A connection to a list of Token values.
Fields
| Field Name | Description |
|---|---|
nodes - [Token]!
|
A list of Token objects. |
edges - [TokensEdge!]!
|
A list of edges which contains the Token and cursor to aid in pagination. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The count of all Token you could get from the connection. |
Example
{
"nodes": [Token],
"edges": [TokensEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
TokensEdge
TokensOrderBy
Description
Methods to use when ordering Token.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NATURAL"
Trade
Fields
| Field Name | Description |
|---|---|
id - UUID
|
|
atsId - UUID
|
|
securityId - UUID
|
|
data - JSON
|
|
fromAccountId - UUID
|
|
toAccountId - UUID
|
|
createdOn - Datetime
|
|
accountByAtsId - Account
|
Reads a single Account that is related to this Trade. |
accountByFromAccountId - Account
|
Reads a single Account that is related to this Trade. |
accountByToAccountId - Account
|
Reads a single Account that is related to this Trade. |
securityBySecurityId - Security
|
Reads a single Security that is related to this Trade. |
transfersByTradeId - TransfersConnection!
|
Reads and enables pagination through a set of Transfer. |
Arguments
|
|
Example
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"atsId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"securityId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"data": {},
"fromAccountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"toAccountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"createdOn": Datetime,
"accountByAtsId": Account,
"accountByFromAccountId": Account,
"accountByToAccountId": Account,
"securityBySecurityId": Security,
"transfersByTradeId": TransfersConnection
}
TradeCondition
Description
A condition to be used against Trade object types. All fields are tested for equality and combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
id - UUID
|
Checks for equality with the object’s id field. |
atsId - UUID
|
Checks for equality with the object’s atsId field. |
securityId - UUID
|
Checks for equality with the object’s securityId field. |
data - JSON
|
Checks for equality with the object’s data field. |
fromAccountId - UUID
|
Checks for equality with the object’s fromAccountId field. |
toAccountId - UUID
|
Checks for equality with the object’s toAccountId field. |
createdOn - Datetime
|
Checks for equality with the object’s createdOn field. |
Example
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"atsId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"securityId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"data": {},
"fromAccountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"toAccountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"createdOn": Datetime
}
TradeFilter
Description
A filter to be used against Trade object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
id - UUIDFilter
|
Filter by the object’s id field. |
atsId - UUIDFilter
|
Filter by the object’s atsId field. |
securityId - UUIDFilter
|
Filter by the object’s securityId field. |
data - JSONFilter
|
Filter by the object’s data field. |
fromAccountId - UUIDFilter
|
Filter by the object’s fromAccountId field. |
toAccountId - UUIDFilter
|
Filter by the object’s toAccountId field. |
createdOn - DatetimeFilter
|
Filter by the object’s createdOn field. |
transfersByTradeId - TradeToManyTransferFilter
|
Filter by the object’s transfersByTradeId relation. |
transfersByTradeIdExist - Boolean
|
Some related transfersByTradeId exist. |
accountByAtsId - AccountFilter
|
Filter by the object’s accountByAtsId relation. |
accountByAtsIdExists - Boolean
|
A related accountByAtsId exists. |
accountByFromAccountId - AccountFilter
|
Filter by the object’s accountByFromAccountId relation. |
accountByFromAccountIdExists - Boolean
|
A related accountByFromAccountId exists. |
accountByToAccountId - AccountFilter
|
Filter by the object’s accountByToAccountId relation. |
accountByToAccountIdExists - Boolean
|
A related accountByToAccountId exists. |
securityBySecurityId - SecurityFilter
|
Filter by the object’s securityBySecurityId relation. |
securityBySecurityIdExists - Boolean
|
A related securityBySecurityId exists. |
and - [TradeFilter!]
|
Checks for all expressions in this list. |
or - [TradeFilter!]
|
Checks for any expressions in this list. |
not - TradeFilter
|
Negates the expression. |
Example
{
"id": UUIDFilter,
"atsId": UUIDFilter,
"securityId": UUIDFilter,
"data": JSONFilter,
"fromAccountId": UUIDFilter,
"toAccountId": UUIDFilter,
"createdOn": DatetimeFilter,
"transfersByTradeId": TradeToManyTransferFilter,
"transfersByTradeIdExist": false,
"accountByAtsId": AccountFilter,
"accountByAtsIdExists": false,
"accountByFromAccountId": AccountFilter,
"accountByFromAccountIdExists": false,
"accountByToAccountId": AccountFilter,
"accountByToAccountIdExists": false,
"securityBySecurityId": SecurityFilter,
"securityBySecurityIdExists": true,
"and": [TradeFilter],
"or": [TradeFilter],
"not": TradeFilter
}
TradeToManyTransferFilter
Description
A filter to be used against many Transfer object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - TransferFilter
|
Every related Transfer matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - TransferFilter
|
Some related Transfer matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - TransferFilter
|
No related Transfer matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": TransferFilter,
"some": TransferFilter,
"none": TransferFilter
}
TradesConnection
Description
A connection to a list of Trade values.
Fields
| Field Name | Description |
|---|---|
nodes - [Trade]!
|
A list of Trade objects. |
edges - [TradesEdge!]!
|
A list of edges which contains the Trade and cursor to aid in pagination. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The count of all Trade you could get from the connection. |
Example
{
"nodes": [Trade],
"edges": [TradesEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
TradesEdge
TradesOrderBy
Description
Methods to use when ordering Trade.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NATURAL"
TrancheBondDataConnection
Description
A connection to a list of TrancheBondDatum values.
Fields
| Field Name | Description |
|---|---|
nodes - [TrancheBondDatum]!
|
A list of TrancheBondDatum objects. |
edges - [TrancheBondDataEdge!]!
|
A list of edges which contains the TrancheBondDatum and cursor to aid in pagination. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The count of all TrancheBondDatum you could get from the connection. |
Example
{
"nodes": [TrancheBondDatum],
"edges": [TrancheBondDataEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
TrancheBondDataEdge
Description
A TrancheBondDatum edge in the connection.
Fields
| Field Name | Description |
|---|---|
cursor - Cursor
|
A cursor for use in pagination. |
node - TrancheBondDatum
|
The TrancheBondDatum at the end of the edge. |
Example
{
"cursor": Cursor,
"node": TrancheBondDatum
}
TrancheBondDataOrderBy
Description
Methods to use when ordering TrancheBondDatum.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NATURAL"
TrancheBondDatum
Fields
| Field Name | Description |
|---|---|
nodeId - ID!
|
A globally unique identifier. Can be used in various places throughout the system to identify this single value. |
id - UUID!
|
|
roundId - UUID!
|
|
coupon - BigFloat!
|
|
term - BigFloat!
|
|
createdOn - Datetime!
|
|
roundByRoundId - Round
|
Reads a single Round that is related to this TrancheBondDatum. |
Example
{
"nodeId": 4,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"roundId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"coupon": BigFloat,
"term": BigFloat,
"createdOn": Datetime,
"roundByRoundId": Round
}
TrancheBondDatumCondition
Description
A condition to be used against TrancheBondDatum object types. All fields are tested for equality and combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
id - UUID
|
Checks for equality with the object’s id field. |
roundId - UUID
|
Checks for equality with the object’s roundId field. |
coupon - BigFloat
|
Checks for equality with the object’s coupon field. |
term - BigFloat
|
Checks for equality with the object’s term field. |
createdOn - Datetime
|
Checks for equality with the object’s createdOn field. |
Example
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"roundId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"coupon": BigFloat,
"term": BigFloat,
"createdOn": Datetime
}
TrancheBondDatumFilter
Description
A filter to be used against TrancheBondDatum object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
id - UUIDFilter
|
Filter by the object’s id field. |
roundId - UUIDFilter
|
Filter by the object’s roundId field. |
coupon - BigFloatFilter
|
Filter by the object’s coupon field. |
term - BigFloatFilter
|
Filter by the object’s term field. |
createdOn - DatetimeFilter
|
Filter by the object’s createdOn field. |
roundByRoundId - RoundFilter
|
Filter by the object’s roundByRoundId relation. |
and - [TrancheBondDatumFilter!]
|
Checks for all expressions in this list. |
or - [TrancheBondDatumFilter!]
|
Checks for any expressions in this list. |
not - TrancheBondDatumFilter
|
Negates the expression. |
Example
{
"id": UUIDFilter,
"roundId": UUIDFilter,
"coupon": BigFloatFilter,
"term": BigFloatFilter,
"createdOn": DatetimeFilter,
"roundByRoundId": RoundFilter,
"and": [TrancheBondDatumFilter],
"or": [TrancheBondDatumFilter],
"not": TrancheBondDatumFilter
}
TrancheBondDatumPatch
Description
Represents an update to a TrancheBondDatum. Fields that are set will be updated.
Example
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"roundId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"coupon": BigFloat,
"term": BigFloat,
"createdOn": Datetime
}
Transaction
Fields
| Field Name | Description |
|---|---|
nodeId - ID!
|
A globally unique identifier. Can be used in various places throughout the system to identify this single value. |
id - String!
|
|
brokerId - UUID!
|
|
blockTimestamp - Datetime
|
|
chainData - JSON
|
|
accountByBrokerId - Account
|
Reads a single Account that is related to this Transaction. |
vestingEventsByTransactionId - VestingEventsConnection!
|
Reads and enables pagination through a set of VestingEvent. |
Arguments
|
|
ledgersByTransactionId - LedgersConnection!
|
Reads and enables pagination through a set of Ledger. |
Arguments
|
|
transactionAnnotationsByTransactionId - TransactionAnnotationsConnection!
|
Reads and enables pagination through a set of TransactionAnnotation. |
Arguments
|
|
Example
{
"nodeId": 4,
"id": "abc123",
"brokerId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"blockTimestamp": Datetime,
"chainData": {},
"accountByBrokerId": Account,
"vestingEventsByTransactionId": VestingEventsConnection,
"ledgersByTransactionId": LedgersConnection,
"transactionAnnotationsByTransactionId": TransactionAnnotationsConnection
}
TransactionAnnotation
Fields
| Field Name | Description |
|---|---|
nodeId - ID!
|
A globally unique identifier. Can be used in various places throughout the system to identify this single value. |
transactionId - String!
|
|
writtenBy - UUID!
|
|
accountId - UUID!
|
|
annotation - String!
|
|
archive - Boolean!
|
|
createdOn - Datetime!
|
|
id - UUID!
|
|
transactionByTransactionId - Transaction
|
Reads a single Transaction that is related to this TransactionAnnotation. |
userByWrittenBy - User
|
Reads a single User that is related to this TransactionAnnotation. |
accountByAccountId - Account
|
Reads a single Account that is related to this TransactionAnnotation. |
Example
{
"nodeId": 4,
"transactionId": "abc123",
"writtenBy": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"annotation": "xyz789",
"archive": false,
"createdOn": Datetime,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"transactionByTransactionId": Transaction,
"userByWrittenBy": User,
"accountByAccountId": Account
}
TransactionAnnotationCondition
Description
A condition to be used against TransactionAnnotation object types. All fields are tested for equality and combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
transactionId - String
|
Checks for equality with the object’s transactionId field. |
writtenBy - UUID
|
Checks for equality with the object’s writtenBy field. |
accountId - UUID
|
Checks for equality with the object’s accountId field. |
annotation - String
|
Checks for equality with the object’s annotation field. |
archive - Boolean
|
Checks for equality with the object’s archive field. |
createdOn - Datetime
|
Checks for equality with the object’s createdOn field. |
id - UUID
|
Checks for equality with the object’s id field. |
Example
{
"transactionId": "abc123",
"writtenBy": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"annotation": "xyz789",
"archive": true,
"createdOn": Datetime,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
TransactionAnnotationFilter
Description
A filter to be used against TransactionAnnotation object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
transactionId - StringFilter
|
Filter by the object’s transactionId field. |
writtenBy - UUIDFilter
|
Filter by the object’s writtenBy field. |
accountId - UUIDFilter
|
Filter by the object’s accountId field. |
annotation - StringFilter
|
Filter by the object’s annotation field. |
archive - BooleanFilter
|
Filter by the object’s archive field. |
createdOn - DatetimeFilter
|
Filter by the object’s createdOn field. |
id - UUIDFilter
|
Filter by the object’s id field. |
transactionByTransactionId - TransactionFilter
|
Filter by the object’s transactionByTransactionId relation. |
userByWrittenBy - UserFilter
|
Filter by the object’s userByWrittenBy relation. |
accountByAccountId - AccountFilter
|
Filter by the object’s accountByAccountId relation. |
and - [TransactionAnnotationFilter!]
|
Checks for all expressions in this list. |
or - [TransactionAnnotationFilter!]
|
Checks for any expressions in this list. |
not - TransactionAnnotationFilter
|
Negates the expression. |
Example
{
"transactionId": StringFilter,
"writtenBy": UUIDFilter,
"accountId": UUIDFilter,
"annotation": StringFilter,
"archive": BooleanFilter,
"createdOn": DatetimeFilter,
"id": UUIDFilter,
"transactionByTransactionId": TransactionFilter,
"userByWrittenBy": UserFilter,
"accountByAccountId": AccountFilter,
"and": [TransactionAnnotationFilter],
"or": [TransactionAnnotationFilter],
"not": TransactionAnnotationFilter
}
TransactionAnnotationInput
Description
An input for mutations affecting TransactionAnnotation
Example
{
"transactionId": "xyz789",
"writtenBy": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"annotation": "abc123",
"archive": true,
"createdOn": Datetime,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
TransactionAnnotationPatch
Description
Represents an update to a TransactionAnnotation. Fields that are set will be updated.
Example
{
"transactionId": "xyz789",
"writtenBy": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"annotation": "xyz789",
"archive": true,
"createdOn": Datetime,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
TransactionAnnotationsConnection
Description
A connection to a list of TransactionAnnotation values.
Fields
| Field Name | Description |
|---|---|
nodes - [TransactionAnnotation]!
|
A list of TransactionAnnotation objects. |
edges - [TransactionAnnotationsEdge!]!
|
A list of edges which contains the TransactionAnnotation and cursor to aid in pagination. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The count of all TransactionAnnotation you could get from the connection. |
Example
{
"nodes": [TransactionAnnotation],
"edges": [TransactionAnnotationsEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
TransactionAnnotationsEdge
Description
A TransactionAnnotation edge in the connection.
Fields
| Field Name | Description |
|---|---|
cursor - Cursor
|
A cursor for use in pagination. |
node - TransactionAnnotation
|
The TransactionAnnotation at the end of the edge. |
Example
{
"cursor": Cursor,
"node": TransactionAnnotation
}
TransactionAnnotationsOrderBy
Description
Methods to use when ordering TransactionAnnotation.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NATURAL"
TransactionCondition
Description
A condition to be used against Transaction object types. All fields are tested for equality and combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
id - String
|
Checks for equality with the object’s id field. |
brokerId - UUID
|
Checks for equality with the object’s brokerId field. |
blockTimestamp - Datetime
|
Checks for equality with the object’s blockTimestamp field. |
chainData - JSON
|
Checks for equality with the object’s chainData field. |
Example
{
"id": "xyz789",
"brokerId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"blockTimestamp": Datetime,
"chainData": {}
}
TransactionFilter
Description
A filter to be used against Transaction object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
id - StringFilter
|
Filter by the object’s id field. |
brokerId - UUIDFilter
|
Filter by the object’s brokerId field. |
blockTimestamp - DatetimeFilter
|
Filter by the object’s blockTimestamp field. |
chainData - JSONFilter
|
Filter by the object’s chainData field. |
vestingEventsByTransactionId - TransactionToManyVestingEventFilter
|
Filter by the object’s vestingEventsByTransactionId relation. |
vestingEventsByTransactionIdExist - Boolean
|
Some related vestingEventsByTransactionId exist. |
ledgersByTransactionId - TransactionToManyLedgerFilter
|
Filter by the object’s ledgersByTransactionId relation. |
ledgersByTransactionIdExist - Boolean
|
Some related ledgersByTransactionId exist. |
transactionAnnotationsByTransactionId - TransactionToManyTransactionAnnotationFilter
|
Filter by the object’s transactionAnnotationsByTransactionId relation. |
transactionAnnotationsByTransactionIdExist - Boolean
|
Some related transactionAnnotationsByTransactionId exist. |
accountByBrokerId - AccountFilter
|
Filter by the object’s accountByBrokerId relation. |
and - [TransactionFilter!]
|
Checks for all expressions in this list. |
or - [TransactionFilter!]
|
Checks for any expressions in this list. |
not - TransactionFilter
|
Negates the expression. |
Example
{
"id": StringFilter,
"brokerId": UUIDFilter,
"blockTimestamp": DatetimeFilter,
"chainData": JSONFilter,
"vestingEventsByTransactionId": TransactionToManyVestingEventFilter,
"vestingEventsByTransactionIdExist": true,
"ledgersByTransactionId": TransactionToManyLedgerFilter,
"ledgersByTransactionIdExist": false,
"transactionAnnotationsByTransactionId": TransactionToManyTransactionAnnotationFilter,
"transactionAnnotationsByTransactionIdExist": false,
"accountByBrokerId": AccountFilter,
"and": [TransactionFilter],
"or": [TransactionFilter],
"not": TransactionFilter
}
TransactionGroupType
TransactionGroupTypeCondition
Description
A condition to be used against TransactionGroupType object types. All fields are tested for equality and combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
type - String
|
Checks for equality with the object’s type field. |
Example
{"type": "abc123"}
TransactionGroupTypeFilter
Description
A filter to be used against TransactionGroupType object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
type - StringFilter
|
Filter by the object’s type field. |
and - [TransactionGroupTypeFilter!]
|
Checks for all expressions in this list. |
or - [TransactionGroupTypeFilter!]
|
Checks for any expressions in this list. |
not - TransactionGroupTypeFilter
|
Negates the expression. |
Example
{
"type": StringFilter,
"and": [TransactionGroupTypeFilter],
"or": [TransactionGroupTypeFilter],
"not": TransactionGroupTypeFilter
}
TransactionGroupTypePatch
Description
Represents an update to a TransactionGroupType. Fields that are set will be updated.
Fields
| Input Field | Description |
|---|---|
type - String
|
Example
{"type": "abc123"}
TransactionGroupTypesConnection
Description
A connection to a list of TransactionGroupType values.
Fields
| Field Name | Description |
|---|---|
nodes - [TransactionGroupType]!
|
A list of TransactionGroupType objects. |
edges - [TransactionGroupTypesEdge!]!
|
A list of edges which contains the TransactionGroupType and cursor to aid in pagination. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The count of all TransactionGroupType you could get from the connection. |
Example
{
"nodes": [TransactionGroupType],
"edges": [TransactionGroupTypesEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
TransactionGroupTypesEdge
Description
A TransactionGroupType edge in the connection.
Fields
| Field Name | Description |
|---|---|
cursor - Cursor
|
A cursor for use in pagination. |
node - TransactionGroupType
|
The TransactionGroupType at the end of the edge. |
Example
{
"cursor": Cursor,
"node": TransactionGroupType
}
TransactionGroupTypesOrderBy
Description
Methods to use when ordering TransactionGroupType.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NATURAL"
TransactionToManyLedgerFilter
Description
A filter to be used against many Ledger object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - LedgerFilter
|
Every related Ledger matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - LedgerFilter
|
Some related Ledger matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - LedgerFilter
|
No related Ledger matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": LedgerFilter,
"some": LedgerFilter,
"none": LedgerFilter
}
TransactionToManyTransactionAnnotationFilter
Description
A filter to be used against many TransactionAnnotation object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - TransactionAnnotationFilter
|
Every related TransactionAnnotation matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - TransactionAnnotationFilter
|
Some related TransactionAnnotation matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - TransactionAnnotationFilter
|
No related TransactionAnnotation matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": TransactionAnnotationFilter,
"some": TransactionAnnotationFilter,
"none": TransactionAnnotationFilter
}
TransactionToManyVestingEventFilter
Description
A filter to be used against many VestingEvent object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - VestingEventFilter
|
Every related VestingEvent matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - VestingEventFilter
|
Some related VestingEvent matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - VestingEventFilter
|
No related VestingEvent matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": VestingEventFilter,
"some": VestingEventFilter,
"none": VestingEventFilter
}
TransactionsConnection
Description
A connection to a list of Transaction values.
Fields
| Field Name | Description |
|---|---|
nodes - [Transaction]!
|
A list of Transaction objects. |
edges - [TransactionsEdge!]!
|
A list of edges which contains the Transaction and cursor to aid in pagination. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The count of all Transaction you could get from the connection. |
Example
{
"nodes": [Transaction],
"edges": [TransactionsEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
TransactionsEdge
Description
A Transaction edge in the connection.
Fields
| Field Name | Description |
|---|---|
cursor - Cursor
|
A cursor for use in pagination. |
node - Transaction
|
The Transaction at the end of the edge. |
Example
{
"cursor": Cursor,
"node": Transaction
}
TransactionsOrderBy
Description
Methods to use when ordering Transaction.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NATURAL"
Transfer
Fields
| Field Name | Description |
|---|---|
id - UUID
|
|
tradeId - UUID
|
|
securityId - UUID
|
|
fromHoldingId - UUID
|
|
fromAccountId - UUID
|
|
toHoldingId - UUID
|
|
toAccountId - UUID
|
|
amount - BigFloat
|
|
atsId - UUID
|
|
accountByAtsId - Account
|
Reads a single Account that is related to this Transfer. |
accountByFromAccountId - Account
|
Reads a single Account that is related to this Transfer. |
accountByToAccountId - Account
|
Reads a single Account that is related to this Transfer. |
securityBySecurityId - Security
|
Reads a single Security that is related to this Transfer. |
holdingByFromHoldingId - Holding
|
Reads a single Holding that is related to this Transfer. |
holdingByToHoldingId - Holding
|
Reads a single Holding that is related to this Transfer. |
tradeByTradeId - Trade
|
Reads a single Trade that is related to this Transfer. |
Example
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"tradeId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"securityId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"fromHoldingId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"fromAccountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"toHoldingId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"toAccountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"amount": BigFloat,
"atsId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountByAtsId": Account,
"accountByFromAccountId": Account,
"accountByToAccountId": Account,
"securityBySecurityId": Security,
"holdingByFromHoldingId": Holding,
"holdingByToHoldingId": Holding,
"tradeByTradeId": Trade
}
TransferCondition
Description
A condition to be used against Transfer object types. All fields are tested for equality and combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
id - UUID
|
Checks for equality with the object’s id field. |
tradeId - UUID
|
Checks for equality with the object’s tradeId field. |
securityId - UUID
|
Checks for equality with the object’s securityId field. |
fromHoldingId - UUID
|
Checks for equality with the object’s fromHoldingId field. |
fromAccountId - UUID
|
Checks for equality with the object’s fromAccountId field. |
toHoldingId - UUID
|
Checks for equality with the object’s toHoldingId field. |
toAccountId - UUID
|
Checks for equality with the object’s toAccountId field. |
amount - BigFloat
|
Checks for equality with the object’s amount field. |
atsId - UUID
|
Checks for equality with the object’s atsId field. |
Example
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"tradeId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"securityId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"fromHoldingId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"fromAccountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"toHoldingId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"toAccountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"amount": BigFloat,
"atsId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
TransferFilter
Description
A filter to be used against Transfer object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
id - UUIDFilter
|
Filter by the object’s id field. |
tradeId - UUIDFilter
|
Filter by the object’s tradeId field. |
securityId - UUIDFilter
|
Filter by the object’s securityId field. |
fromHoldingId - UUIDFilter
|
Filter by the object’s fromHoldingId field. |
fromAccountId - UUIDFilter
|
Filter by the object’s fromAccountId field. |
toHoldingId - UUIDFilter
|
Filter by the object’s toHoldingId field. |
toAccountId - UUIDFilter
|
Filter by the object’s toAccountId field. |
amount - BigFloatFilter
|
Filter by the object’s amount field. |
atsId - UUIDFilter
|
Filter by the object’s atsId field. |
accountByAtsId - AccountFilter
|
Filter by the object’s accountByAtsId relation. |
accountByAtsIdExists - Boolean
|
A related accountByAtsId exists. |
accountByFromAccountId - AccountFilter
|
Filter by the object’s accountByFromAccountId relation. |
accountByFromAccountIdExists - Boolean
|
A related accountByFromAccountId exists. |
accountByToAccountId - AccountFilter
|
Filter by the object’s accountByToAccountId relation. |
accountByToAccountIdExists - Boolean
|
A related accountByToAccountId exists. |
securityBySecurityId - SecurityFilter
|
Filter by the object’s securityBySecurityId relation. |
securityBySecurityIdExists - Boolean
|
A related securityBySecurityId exists. |
holdingByFromHoldingId - HoldingFilter
|
Filter by the object’s holdingByFromHoldingId relation. |
holdingByFromHoldingIdExists - Boolean
|
A related holdingByFromHoldingId exists. |
holdingByToHoldingId - HoldingFilter
|
Filter by the object’s holdingByToHoldingId relation. |
holdingByToHoldingIdExists - Boolean
|
A related holdingByToHoldingId exists. |
tradeByTradeId - TradeFilter
|
Filter by the object’s tradeByTradeId relation. |
tradeByTradeIdExists - Boolean
|
A related tradeByTradeId exists. |
and - [TransferFilter!]
|
Checks for all expressions in this list. |
or - [TransferFilter!]
|
Checks for any expressions in this list. |
not - TransferFilter
|
Negates the expression. |
Example
{
"id": UUIDFilter,
"tradeId": UUIDFilter,
"securityId": UUIDFilter,
"fromHoldingId": UUIDFilter,
"fromAccountId": UUIDFilter,
"toHoldingId": UUIDFilter,
"toAccountId": UUIDFilter,
"amount": BigFloatFilter,
"atsId": UUIDFilter,
"accountByAtsId": AccountFilter,
"accountByAtsIdExists": true,
"accountByFromAccountId": AccountFilter,
"accountByFromAccountIdExists": true,
"accountByToAccountId": AccountFilter,
"accountByToAccountIdExists": false,
"securityBySecurityId": SecurityFilter,
"securityBySecurityIdExists": true,
"holdingByFromHoldingId": HoldingFilter,
"holdingByFromHoldingIdExists": true,
"holdingByToHoldingId": HoldingFilter,
"holdingByToHoldingIdExists": true,
"tradeByTradeId": TradeFilter,
"tradeByTradeIdExists": true,
"and": [TransferFilter],
"or": [TransferFilter],
"not": TransferFilter
}
TransferOwnershipInput
Description
All input for the transferOwnership mutation.
Example
{
"clientMutationId": "abc123",
"_email": "abc123"
}
TransferOwnershipPayload
Description
The output of our transferOwnership mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
The exact same clientMutationId that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations. |
usersAccounts - [UsersAccount]
|
|
query - Query
|
Our root query field type. Allows us to run any query from our mutation payload. |
Example
{
"clientMutationId": "abc123",
"usersAccounts": [UsersAccount],
"query": Query
}
TransferType
Fields
| Field Name | Description |
|---|---|
type - String
|
|
stagedTransfersByType - StagedTransfersConnection!
|
Reads and enables pagination through a set of StagedTransfer. |
Arguments
|
|
Example
{
"type": "abc123",
"stagedTransfersByType": StagedTransfersConnection
}
TransferTypeCondition
Description
A condition to be used against TransferType object types. All fields are tested for equality and combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
type - String
|
Checks for equality with the object’s type field. |
Example
{"type": "abc123"}
TransferTypeFilter
Description
A filter to be used against TransferType object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
type - StringFilter
|
Filter by the object’s type field. |
stagedTransfersByType - TransferTypeToManyStagedTransferFilter
|
Filter by the object’s stagedTransfersByType relation. |
stagedTransfersByTypeExist - Boolean
|
Some related stagedTransfersByType exist. |
and - [TransferTypeFilter!]
|
Checks for all expressions in this list. |
or - [TransferTypeFilter!]
|
Checks for any expressions in this list. |
not - TransferTypeFilter
|
Negates the expression. |
Example
{
"type": StringFilter,
"stagedTransfersByType": TransferTypeToManyStagedTransferFilter,
"stagedTransfersByTypeExist": false,
"and": [TransferTypeFilter],
"or": [TransferTypeFilter],
"not": TransferTypeFilter
}
TransferTypeInput
Description
An input for mutations affecting TransferType
Fields
| Input Field | Description |
|---|---|
type - String
|
Example
{"type": "xyz789"}
TransferTypeToManyStagedTransferFilter
Description
A filter to be used against many StagedTransfer object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - StagedTransferFilter
|
Every related StagedTransfer matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - StagedTransferFilter
|
Some related StagedTransfer matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - StagedTransferFilter
|
No related StagedTransfer matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": StagedTransferFilter,
"some": StagedTransferFilter,
"none": StagedTransferFilter
}
TransferTypesConnection
Description
A connection to a list of TransferType values.
Fields
| Field Name | Description |
|---|---|
nodes - [TransferType]!
|
A list of TransferType objects. |
edges - [TransferTypesEdge!]!
|
A list of edges which contains the TransferType and cursor to aid in pagination. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The count of all TransferType you could get from the connection. |
Example
{
"nodes": [TransferType],
"edges": [TransferTypesEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
TransferTypesEdge
Description
A TransferType edge in the connection.
Fields
| Field Name | Description |
|---|---|
cursor - Cursor
|
A cursor for use in pagination. |
node - TransferType
|
The TransferType at the end of the edge. |
Example
{
"cursor": Cursor,
"node": TransferType
}
TransferTypesOrderBy
Description
Methods to use when ordering TransferType.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"NATURAL"
TransfersConnection
Description
A connection to a list of Transfer values.
Fields
| Field Name | Description |
|---|---|
nodes - [Transfer]!
|
A list of Transfer objects. |
edges - [TransfersEdge!]!
|
A list of edges which contains the Transfer and cursor to aid in pagination. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The count of all Transfer you could get from the connection. |
Example
{
"nodes": [Transfer],
"edges": [TransfersEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
TransfersEdge
TransfersOrderBy
Description
Methods to use when ordering Transfer.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NATURAL"
UUID
Description
A universally unique identifier as defined by RFC 4122.
Example
"429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
UUIDFilter
Description
A filter to be used against UUID fields. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
isNull - Boolean
|
Is null (if true is specified) or is not null (if false is specified). |
equalTo - UUID
|
Equal to the specified value. |
notEqualTo - UUID
|
Not equal to the specified value. |
distinctFrom - UUID
|
Not equal to the specified value, treating null like an ordinary value. |
notDistinctFrom - UUID
|
Equal to the specified value, treating null like an ordinary value. |
in - [UUID!]
|
Included in the specified list. |
notIn - [UUID!]
|
Not included in the specified list. |
lessThan - UUID
|
Less than the specified value. |
lessThanOrEqualTo - UUID
|
Less than or equal to the specified value. |
greaterThan - UUID
|
Greater than the specified value. |
greaterThanOrEqualTo - UUID
|
Greater than or equal to the specified value. |
Example
{
"isNull": true,
"equalTo": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"notEqualTo": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"distinctFrom": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"notDistinctFrom": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"in": [
"429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
],
"notIn": [
"429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
],
"lessThan": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"lessThanOrEqualTo": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"greaterThan": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"greaterThanOrEqualTo": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
UnpauseHoldingsInput
Description
All input for the unpauseHoldings mutation.
Example
{
"clientMutationId": "xyz789",
"holdingIds": [
"429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
]
}
UnpauseHoldingsPayload
Description
The output of our unpauseHoldings mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
The exact same clientMutationId that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations. |
holdings - [Holding]
|
|
query - Query
|
Our root query field type. Allows us to run any query from our mutation payload. |
Example
{
"clientMutationId": "xyz789",
"holdings": [Holding],
"query": Query
}
UpdateAccountByIdInput
Description
All input for the updateAccountById mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
accountPatch - AccountPatch!
|
An object where the defined keys will be set on the Account being updated. |
id - UUID!
|
Example
{
"clientMutationId": "xyz789",
"accountPatch": AccountPatch,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
UpdateAccountBySupportEmailInput
Description
All input for the updateAccountBySupportEmail mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
accountPatch - AccountPatch!
|
An object where the defined keys will be set on the Account being updated. |
supportEmail - String!
|
Example
{
"clientMutationId": "xyz789",
"accountPatch": AccountPatch,
"supportEmail": "abc123"
}
UpdateAccountByTypeAndEmailInput
Description
All input for the updateAccountByTypeAndEmail mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
accountPatch - AccountPatch!
|
An object where the defined keys will be set on the Account being updated. |
type - String!
|
|
email - String!
|
Example
{
"clientMutationId": "abc123",
"accountPatch": AccountPatch,
"type": "xyz789",
"email": "xyz789"
}
UpdateAccountInput
Description
All input for the updateAccount mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
nodeId - ID!
|
The globally unique ID which will identify a single Account to be updated. |
accountPatch - AccountPatch!
|
An object where the defined keys will be set on the Account being updated. |
Example
{
"clientMutationId": "xyz789",
"nodeId": 4,
"accountPatch": AccountPatch
}
UpdateAccountPayload
Description
The output of our update Account mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
The exact same clientMutationId that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations. |
account - Account
|
The Account that was updated by this mutation. |
query - Query
|
Our root query field type. Allows us to run any query from our mutation payload. |
auxAccountByType - AuxAccount
|
Reads a single AuxAccount that is related to this Account. |
companyByCompany - Company
|
Reads a single Company that is related to this Account. |
countryByJurisdiction - Country
|
Reads a single Country that is related to this Account. |
investorAccountTypeByInvestorType - InvestorAccountType
|
Reads a single InvestorAccountType that is related to this Account. |
accountEdge - AccountsEdge
|
An edge for our Account. May be used by Relay 1. |
Arguments
|
|
Example
{
"clientMutationId": "xyz789",
"account": Account,
"query": Query,
"auxAccountByType": AuxAccount,
"companyByCompany": Company,
"countryByJurisdiction": Country,
"investorAccountTypeByInvestorType": InvestorAccountType,
"accountEdge": AccountsEdge
}
UpdateAccountPhoneNumberByAccountIdAndTypeInput
Description
All input for the updateAccountPhoneNumberByAccountIdAndType mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
accountPhoneNumberPatch - AccountPhoneNumberPatch!
|
An object where the defined keys will be set on the AccountPhoneNumber being updated. |
accountId - UUID!
|
|
type - String!
|
Example
{
"clientMutationId": "xyz789",
"accountPhoneNumberPatch": AccountPhoneNumberPatch,
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"type": "xyz789"
}
UpdateAccountPhoneNumberByIdInput
Description
All input for the updateAccountPhoneNumberById mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
accountPhoneNumberPatch - AccountPhoneNumberPatch!
|
An object where the defined keys will be set on the AccountPhoneNumber being updated. |
id - UUID!
|
Example
{
"clientMutationId": "xyz789",
"accountPhoneNumberPatch": AccountPhoneNumberPatch,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
UpdateAccountPhoneNumberInput
Description
All input for the updateAccountPhoneNumber mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
nodeId - ID!
|
The globally unique ID which will identify a single AccountPhoneNumber to be updated. |
accountPhoneNumberPatch - AccountPhoneNumberPatch!
|
An object where the defined keys will be set on the AccountPhoneNumber being updated. |
Example
{
"clientMutationId": "abc123",
"nodeId": 4,
"accountPhoneNumberPatch": AccountPhoneNumberPatch
}
UpdateAccountPhoneNumberPayload
Description
The output of our update AccountPhoneNumber mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
The exact same clientMutationId that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations. |
accountPhoneNumber - AccountPhoneNumber
|
The AccountPhoneNumber that was updated by this mutation. |
query - Query
|
Our root query field type. Allows us to run any query from our mutation payload. |
accountByAccountId - Account
|
Reads a single Account that is related to this AccountPhoneNumber. |
phoneNumberTypeByType - PhoneNumberType
|
Reads a single PhoneNumberType that is related to this AccountPhoneNumber. |
accountPhoneNumberEdge - AccountPhoneNumbersEdge
|
An edge for our AccountPhoneNumber. May be used by Relay 1. |
Arguments
|
|
Example
{
"clientMutationId": "abc123",
"accountPhoneNumber": AccountPhoneNumber,
"query": Query,
"accountByAccountId": Account,
"phoneNumberTypeByType": PhoneNumberType,
"accountPhoneNumberEdge": AccountPhoneNumbersEdge
}
UpdateAccountRegDStatusByAccountIdInput
Description
All input for the updateAccountRegDStatusByAccountId mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
accountRegDStatusPatch - AccountRegDStatusPatch!
|
An object where the defined keys will be set on the AccountRegDStatus being updated. |
accountId - UUID!
|
Example
{
"clientMutationId": "xyz789",
"accountRegDStatusPatch": AccountRegDStatusPatch,
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
UpdateAccountRegDStatusByIdInput
Description
All input for the updateAccountRegDStatusById mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
accountRegDStatusPatch - AccountRegDStatusPatch!
|
An object where the defined keys will be set on the AccountRegDStatus being updated. |
id - UUID!
|
Example
{
"clientMutationId": "abc123",
"accountRegDStatusPatch": AccountRegDStatusPatch,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
UpdateAccountRegDStatusInput
Description
All input for the updateAccountRegDStatus mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
nodeId - ID!
|
The globally unique ID which will identify a single AccountRegDStatus to be updated. |
accountRegDStatusPatch - AccountRegDStatusPatch!
|
An object where the defined keys will be set on the AccountRegDStatus being updated. |
Example
{
"clientMutationId": "abc123",
"nodeId": 4,
"accountRegDStatusPatch": AccountRegDStatusPatch
}
UpdateAccountRegDStatusPayload
Description
The output of our update AccountRegDStatus mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
The exact same clientMutationId that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations. |
accountRegDStatus - AccountRegDStatus
|
The AccountRegDStatus that was updated by this mutation. |
query - Query
|
Our root query field type. Allows us to run any query from our mutation payload. |
accountByAccountId - Account
|
Reads a single Account that is related to this AccountRegDStatus. |
accountRegDStatusEdge - AccountRegDStatusesEdge
|
An edge for our AccountRegDStatus. May be used by Relay 1. |
Arguments
|
|
Example
{
"clientMutationId": "xyz789",
"accountRegDStatus": AccountRegDStatus,
"query": Query,
"accountByAccountId": Account,
"accountRegDStatusEdge": AccountRegDStatusesEdge
}
UpdateAccountRestrictionByAccountIdAndReasonIdInput
Description
All input for the updateAccountRestrictionByAccountIdAndReasonId mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
accountRestrictionPatch - AccountRestrictionPatch!
|
An object where the defined keys will be set on the AccountRestriction being updated. |
accountId - UUID!
|
|
reasonId - Int!
|
Example
{
"clientMutationId": "abc123",
"accountRestrictionPatch": AccountRestrictionPatch,
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"reasonId": 123
}
UpdateAccountRestrictionByIdInput
Description
All input for the updateAccountRestrictionById mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
accountRestrictionPatch - AccountRestrictionPatch!
|
An object where the defined keys will be set on the AccountRestriction being updated. |
id - UUID!
|
Example
{
"clientMutationId": "abc123",
"accountRestrictionPatch": AccountRestrictionPatch,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
UpdateAccountRestrictionInput
Description
All input for the updateAccountRestriction mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
nodeId - ID!
|
The globally unique ID which will identify a single AccountRestriction to be updated. |
accountRestrictionPatch - AccountRestrictionPatch!
|
An object where the defined keys will be set on the AccountRestriction being updated. |
Example
{
"clientMutationId": "abc123",
"nodeId": "4",
"accountRestrictionPatch": AccountRestrictionPatch
}
UpdateAccountRestrictionPayload
Description
The output of our update AccountRestriction mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
The exact same clientMutationId that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations. |
accountRestriction - AccountRestriction
|
The AccountRestriction that was updated by this mutation. |
query - Query
|
Our root query field type. Allows us to run any query from our mutation payload. |
accountByAccountId - Account
|
Reads a single Account that is related to this AccountRestriction. |
restrictionReasonByReasonId - RestrictionReason
|
Reads a single RestrictionReason that is related to this AccountRestriction. |
userByCreatorUserId - User
|
Reads a single User that is related to this AccountRestriction. |
accountByCreatorAccountId - Account
|
Reads a single Account that is related to this AccountRestriction. |
accountRestrictionEdge - AccountRestrictionsEdge
|
An edge for our AccountRestriction. May be used by Relay 1. |
Arguments
|
|
Example
{
"clientMutationId": "xyz789",
"accountRestriction": AccountRestriction,
"query": Query,
"accountByAccountId": Account,
"restrictionReasonByReasonId": RestrictionReason,
"userByCreatorUserId": User,
"accountByCreatorAccountId": Account,
"accountRestrictionEdge": AccountRestrictionsEdge
}
UpdateAddressByIdInput
Description
All input for the updateAddressById mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
addressPatch - AddressPatch!
|
An object where the defined keys will be set on the Address being updated. |
id - UUID!
|
Example
{
"clientMutationId": "abc123",
"addressPatch": AddressPatch,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
UpdateAddressInput
Description
All input for the updateAddress mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
nodeId - ID!
|
The globally unique ID which will identify a single Address to be updated. |
addressPatch - AddressPatch!
|
An object where the defined keys will be set on the Address being updated. |
Example
{
"clientMutationId": "xyz789",
"nodeId": "4",
"addressPatch": AddressPatch
}
UpdateAddressPayload
Description
The output of our update Address mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
The exact same clientMutationId that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations. |
address - Address
|
The Address that was updated by this mutation. |
query - Query
|
Our root query field type. Allows us to run any query from our mutation payload. |
countryByCountry - Country
|
Reads a single Country that is related to this Address. |
addressEdge - AddressesEdge
|
An edge for our Address. May be used by Relay 1. |
Arguments
|
|
Example
{
"clientMutationId": "abc123",
"address": Address,
"query": Query,
"countryByCountry": Country,
"addressEdge": AddressesEdge
}
UpdateAllocationAnnotationByIdInput
Description
All input for the updateAllocationAnnotationById mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
allocationAnnotationPatch - AllocationAnnotationPatch!
|
An object where the defined keys will be set on the AllocationAnnotation being updated. |
id - UUID!
|
Example
{
"clientMutationId": "abc123",
"allocationAnnotationPatch": AllocationAnnotationPatch,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
UpdateAllocationAnnotationInput
Description
All input for the updateAllocationAnnotation mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
nodeId - ID!
|
The globally unique ID which will identify a single AllocationAnnotation to be updated. |
allocationAnnotationPatch - AllocationAnnotationPatch!
|
An object where the defined keys will be set on the AllocationAnnotation being updated. |
Example
{
"clientMutationId": "xyz789",
"nodeId": "4",
"allocationAnnotationPatch": AllocationAnnotationPatch
}
UpdateAllocationAnnotationPayload
Description
The output of our update AllocationAnnotation mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
The exact same clientMutationId that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations. |
allocationAnnotation - AllocationAnnotation
|
The AllocationAnnotation that was updated by this mutation. |
query - Query
|
Our root query field type. Allows us to run any query from our mutation payload. |
allocationByAllocationId - Allocation
|
Reads a single Allocation that is related to this AllocationAnnotation. |
userByWrittenBy - User
|
Reads a single User that is related to this AllocationAnnotation. |
accountByAccountId - Account
|
Reads a single Account that is related to this AllocationAnnotation. |
allocationAnnotationEdge - AllocationAnnotationsEdge
|
An edge for our AllocationAnnotation. May be used by Relay 1. |
Arguments
|
|
Example
{
"clientMutationId": "xyz789",
"allocationAnnotation": AllocationAnnotation,
"query": Query,
"allocationByAllocationId": Allocation,
"userByWrittenBy": User,
"accountByAccountId": Account,
"allocationAnnotationEdge": AllocationAnnotationsEdge
}
UpdateAllocationByIdInput
Description
All input for the updateAllocationById mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
allocationPatch - AllocationPatch!
|
An object where the defined keys will be set on the Allocation being updated. |
id - UUID!
|
Example
{
"clientMutationId": "abc123",
"allocationPatch": AllocationPatch,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
UpdateAllocationEmailPreferenceByAllocationIdInput
Description
All input for the updateAllocationEmailPreferenceByAllocationId mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
allocationEmailPreferencePatch - AllocationEmailPreferencePatch!
|
An object where the defined keys will be set on the AllocationEmailPreference being updated. |
allocationId - UUID!
|
Example
{
"clientMutationId": "abc123",
"allocationEmailPreferencePatch": AllocationEmailPreferencePatch,
"allocationId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
UpdateAllocationEmailPreferenceByIdInput
Description
All input for the updateAllocationEmailPreferenceById mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
allocationEmailPreferencePatch - AllocationEmailPreferencePatch!
|
An object where the defined keys will be set on the AllocationEmailPreference being updated. |
id - UUID!
|
Example
{
"clientMutationId": "abc123",
"allocationEmailPreferencePatch": AllocationEmailPreferencePatch,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
UpdateAllocationEmailPreferenceInput
Description
All input for the updateAllocationEmailPreference mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
nodeId - ID!
|
The globally unique ID which will identify a single AllocationEmailPreference to be updated. |
allocationEmailPreferencePatch - AllocationEmailPreferencePatch!
|
An object where the defined keys will be set on the AllocationEmailPreference being updated. |
Example
{
"clientMutationId": "abc123",
"nodeId": "4",
"allocationEmailPreferencePatch": AllocationEmailPreferencePatch
}
UpdateAllocationEmailPreferencePayload
Description
The output of our update AllocationEmailPreference mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
The exact same clientMutationId that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations. |
allocationEmailPreference - AllocationEmailPreference
|
The AllocationEmailPreference that was updated by this mutation. |
query - Query
|
Our root query field type. Allows us to run any query from our mutation payload. |
accountByAccountId - Account
|
Reads a single Account that is related to this AllocationEmailPreference. |
allocationByAllocationId - Allocation
|
Reads a single Allocation that is related to this AllocationEmailPreference. |
allocationEmailPreferenceEdge - AllocationEmailPreferencesEdge
|
An edge for our AllocationEmailPreference. May be used by Relay 1. |
Arguments
|
|
Example
{
"clientMutationId": "xyz789",
"allocationEmailPreference": AllocationEmailPreference,
"query": Query,
"accountByAccountId": Account,
"allocationByAllocationId": Allocation,
"allocationEmailPreferenceEdge": AllocationEmailPreferencesEdge
}
UpdateAllocationInput
Description
All input for the updateAllocation mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
nodeId - ID!
|
The globally unique ID which will identify a single Allocation to be updated. |
allocationPatch - AllocationPatch!
|
An object where the defined keys will be set on the Allocation being updated. |
Example
{
"clientMutationId": "abc123",
"nodeId": "4",
"allocationPatch": AllocationPatch
}
UpdateAllocationOfferingLinkByIdInput
Description
All input for the updateAllocationOfferingLinkById mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
allocationOfferingLinkPatch - AllocationOfferingLinkPatch!
|
An object where the defined keys will be set on the AllocationOfferingLink being updated. |
id - UUID!
|
Example
{
"clientMutationId": "abc123",
"allocationOfferingLinkPatch": AllocationOfferingLinkPatch,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
UpdateAllocationOfferingLinkInput
Description
All input for the updateAllocationOfferingLink mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
nodeId - ID!
|
The globally unique ID which will identify a single AllocationOfferingLink to be updated. |
allocationOfferingLinkPatch - AllocationOfferingLinkPatch!
|
An object where the defined keys will be set on the AllocationOfferingLink being updated. |
Example
{
"clientMutationId": "xyz789",
"nodeId": 4,
"allocationOfferingLinkPatch": AllocationOfferingLinkPatch
}
UpdateAllocationOfferingLinkPayload
Description
The output of our update AllocationOfferingLink mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
The exact same clientMutationId that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations. |
allocationOfferingLink - AllocationOfferingLink
|
The AllocationOfferingLink that was updated by this mutation. |
query - Query
|
Our root query field type. Allows us to run any query from our mutation payload. |
allocationByAllocationId - Allocation
|
Reads a single Allocation that is related to this AllocationOfferingLink. |
accountByCreatedBy - Account
|
Reads a single Account that is related to this AllocationOfferingLink. |
accountByAgentId - Account
|
Reads a single Account that is related to this AllocationOfferingLink. |
allocationOfferingLinkEdge - AllocationOfferingLinksEdge
|
An edge for our AllocationOfferingLink. May be used by Relay 1. |
Arguments
|
|
Example
{
"clientMutationId": "abc123",
"allocationOfferingLink": AllocationOfferingLink,
"query": Query,
"allocationByAllocationId": Allocation,
"accountByCreatedBy": Account,
"accountByAgentId": Account,
"allocationOfferingLinkEdge": AllocationOfferingLinksEdge
}
UpdateAllocationPayload
Description
The output of our update Allocation mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
The exact same clientMutationId that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations. |
allocation - Allocation
|
The Allocation that was updated by this mutation. |
query - Query
|
Our root query field type. Allows us to run any query from our mutation payload. |
accountByOwnerId - Account
|
Reads a single Account that is related to this Allocation. |
blockchainAddressByBlockchainAddressId - BlockchainAddress
|
Reads a single BlockchainAddress that is related to this Allocation. |
accountByIssuerId - Account
|
Reads a single Account that is related to this Allocation. |
assetStatusByStatus - AssetStatus
|
Reads a single AssetStatus that is related to this Allocation. |
roundByRoundId - Round
|
Reads a single Round that is related to this Allocation. |
allocationEdge - AllocationsEdge
|
An edge for our Allocation. May be used by Relay 1. |
Arguments
|
|
Example
{
"clientMutationId": "xyz789",
"allocation": Allocation,
"query": Query,
"accountByOwnerId": Account,
"blockchainAddressByBlockchainAddressId": BlockchainAddress,
"accountByIssuerId": Account,
"assetStatusByStatus": AssetStatus,
"roundByRoundId": Round,
"allocationEdge": AllocationsEdge
}
UpdateAllocationQualificationByAllocationIdAndVendorQualificationIdInput
Description
All input for the updateAllocationQualificationByAllocationIdAndVendorQualificationId mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
allocationQualificationPatch - AllocationQualificationPatch!
|
An object where the defined keys will be set on the AllocationQualification being updated. |
allocationId - UUID!
|
|
vendorQualificationId - UUID!
|
Example
{
"clientMutationId": "xyz789",
"allocationQualificationPatch": AllocationQualificationPatch,
"allocationId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"vendorQualificationId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
UpdateAllocationQualificationByIdInput
Description
All input for the updateAllocationQualificationById mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
allocationQualificationPatch - AllocationQualificationPatch!
|
An object where the defined keys will be set on the AllocationQualification being updated. |
id - UUID!
|
Example
{
"clientMutationId": "xyz789",
"allocationQualificationPatch": AllocationQualificationPatch,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
UpdateAllocationQualificationInput
Description
All input for the updateAllocationQualification mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
nodeId - ID!
|
The globally unique ID which will identify a single AllocationQualification to be updated. |
allocationQualificationPatch - AllocationQualificationPatch!
|
An object where the defined keys will be set on the AllocationQualification being updated. |
Example
{
"clientMutationId": "xyz789",
"nodeId": "4",
"allocationQualificationPatch": AllocationQualificationPatch
}
UpdateAllocationQualificationPayload
Description
The output of our update AllocationQualification mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
The exact same clientMutationId that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations. |
allocationQualification - AllocationQualification
|
The AllocationQualification that was updated by this mutation. |
query - Query
|
Our root query field type. Allows us to run any query from our mutation payload. |
allocationByAllocationId - Allocation
|
Reads a single Allocation that is related to this AllocationQualification. |
vendorQualificationByVendorQualificationId - VendorQualification
|
Reads a single VendorQualification that is related to this AllocationQualification. |
allocationQualificationEdge - AllocationQualificationsEdge
|
An edge for our AllocationQualification. May be used by Relay 1. |
Arguments
|
|
Example
{
"clientMutationId": "abc123",
"allocationQualification": AllocationQualification,
"query": Query,
"allocationByAllocationId": Allocation,
"vendorQualificationByVendorQualificationId": VendorQualification,
"allocationQualificationEdge": AllocationQualificationsEdge
}
UpdateAllocationsVestingScheduleByAllocationIdInput
Description
All input for the updateAllocationsVestingScheduleByAllocationId mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
allocationsVestingSchedulePatch - AllocationsVestingSchedulePatch!
|
An object where the defined keys will be set on the AllocationsVestingSchedule being updated. |
allocationId - UUID!
|
Example
{
"clientMutationId": "xyz789",
"allocationsVestingSchedulePatch": AllocationsVestingSchedulePatch,
"allocationId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
UpdateAllocationsVestingScheduleByIdInput
Description
All input for the updateAllocationsVestingScheduleById mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
allocationsVestingSchedulePatch - AllocationsVestingSchedulePatch!
|
An object where the defined keys will be set on the AllocationsVestingSchedule being updated. |
id - UUID!
|
Example
{
"clientMutationId": "xyz789",
"allocationsVestingSchedulePatch": AllocationsVestingSchedulePatch,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
UpdateAllocationsVestingScheduleInput
Description
All input for the updateAllocationsVestingSchedule mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
nodeId - ID!
|
The globally unique ID which will identify a single AllocationsVestingSchedule to be updated. |
allocationsVestingSchedulePatch - AllocationsVestingSchedulePatch!
|
An object where the defined keys will be set on the AllocationsVestingSchedule being updated. |
Example
{
"clientMutationId": "abc123",
"nodeId": "4",
"allocationsVestingSchedulePatch": AllocationsVestingSchedulePatch
}
UpdateAllocationsVestingSchedulePayload
Description
The output of our update AllocationsVestingSchedule mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
The exact same clientMutationId that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations. |
allocationsVestingSchedule - AllocationsVestingSchedule
|
The AllocationsVestingSchedule that was updated by this mutation. |
query - Query
|
Our root query field type. Allows us to run any query from our mutation payload. |
allocationByAllocationId - Allocation
|
Reads a single Allocation that is related to this AllocationsVestingSchedule. |
vestingDurationByDuration - VestingDuration
|
Reads a single VestingDuration that is related to this AllocationsVestingSchedule. |
allocationsVestingScheduleEdge - AllocationsVestingSchedulesEdge
|
An edge for our AllocationsVestingSchedule. May be used by Relay 1. |
Arguments
|
|
Example
{
"clientMutationId": "xyz789",
"allocationsVestingSchedule": AllocationsVestingSchedule,
"query": Query,
"allocationByAllocationId": Allocation,
"vestingDurationByDuration": VestingDuration,
"allocationsVestingScheduleEdge": AllocationsVestingSchedulesEdge
}
UpdateAssetAnnotationByIdInput
Description
All input for the updateAssetAnnotationById mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
assetAnnotationPatch - AssetAnnotationPatch!
|
An object where the defined keys will be set on the AssetAnnotation being updated. |
id - UUID!
|
Example
{
"clientMutationId": "xyz789",
"assetAnnotationPatch": AssetAnnotationPatch,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
UpdateAssetAnnotationInput
Description
All input for the updateAssetAnnotation mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
nodeId - ID!
|
The globally unique ID which will identify a single AssetAnnotation to be updated. |
assetAnnotationPatch - AssetAnnotationPatch!
|
An object where the defined keys will be set on the AssetAnnotation being updated. |
Example
{
"clientMutationId": "abc123",
"nodeId": 4,
"assetAnnotationPatch": AssetAnnotationPatch
}
UpdateAssetAnnotationPayload
Description
The output of our update AssetAnnotation mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
The exact same clientMutationId that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations. |
assetAnnotation - AssetAnnotation
|
The AssetAnnotation that was updated by this mutation. |
query - Query
|
Our root query field type. Allows us to run any query from our mutation payload. |
assetByAssetId - Asset
|
Reads a single Asset that is related to this AssetAnnotation. |
userByWrittenBy - User
|
Reads a single User that is related to this AssetAnnotation. |
accountByAccountId - Account
|
Reads a single Account that is related to this AssetAnnotation. |
assetAnnotationEdge - AssetAnnotationsEdge
|
An edge for our AssetAnnotation. May be used by Relay 1. |
Arguments
|
|
Example
{
"clientMutationId": "abc123",
"assetAnnotation": AssetAnnotation,
"query": Query,
"assetByAssetId": Asset,
"userByWrittenBy": User,
"accountByAccountId": Account,
"assetAnnotationEdge": AssetAnnotationsEdge
}
UpdateAssetByIdInput
Description
All input for the updateAssetById mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
assetPatch - AssetPatch!
|
An object where the defined keys will be set on the Asset being updated. |
id - UUID!
|
Example
{
"clientMutationId": "xyz789",
"assetPatch": AssetPatch,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
UpdateAssetInput
Description
All input for the updateAsset mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
nodeId - ID!
|
The globally unique ID which will identify a single Asset to be updated. |
assetPatch - AssetPatch!
|
An object where the defined keys will be set on the Asset being updated. |
Example
{
"clientMutationId": "abc123",
"nodeId": "4",
"assetPatch": AssetPatch
}
UpdateAssetPayload
Description
The output of our update Asset mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
The exact same clientMutationId that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations. |
asset - Asset
|
The Asset that was updated by this mutation. |
query - Query
|
Our root query field type. Allows us to run any query from our mutation payload. |
accountByIssuerId - Account
|
Reads a single Account that is related to this Asset. |
assetTypeByType - AssetType
|
Reads a single AssetType that is related to this Asset. |
assetStatusByStatus - AssetStatus
|
Reads a single AssetStatus that is related to this Asset. |
assetEdge - AssetsEdge
|
An edge for our Asset. May be used by Relay 1. |
Arguments
|
|
Example
{
"clientMutationId": "xyz789",
"asset": Asset,
"query": Query,
"accountByIssuerId": Account,
"assetTypeByType": AssetType,
"assetStatusByStatus": AssetStatus,
"assetEdge": AssetsEdge
}
UpdateAuxAccountByTypeInput
Description
All input for the updateAuxAccountByType mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
auxAccountPatch - AuxAccountPatch!
|
An object where the defined keys will be set on the AuxAccount being updated. |
type - String!
|
Example
{
"clientMutationId": "xyz789",
"auxAccountPatch": AuxAccountPatch,
"type": "abc123"
}
UpdateAuxAccountInput
Description
All input for the updateAuxAccount mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
nodeId - ID!
|
The globally unique ID which will identify a single AuxAccount to be updated. |
auxAccountPatch - AuxAccountPatch!
|
An object where the defined keys will be set on the AuxAccount being updated. |
Example
{
"clientMutationId": "abc123",
"nodeId": 4,
"auxAccountPatch": AuxAccountPatch
}
UpdateAuxAccountPayload
Description
The output of our update AuxAccount mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
The exact same clientMutationId that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations. |
auxAccount - AuxAccount
|
The AuxAccount that was updated by this mutation. |
query - Query
|
Our root query field type. Allows us to run any query from our mutation payload. |
auxAccountEdge - AuxAccountsEdge
|
An edge for our AuxAccount. May be used by Relay 1. |
Arguments
|
|
Example
{
"clientMutationId": "xyz789",
"auxAccount": AuxAccount,
"query": Query,
"auxAccountEdge": AuxAccountsEdge
}
UpdateAuxRoleByRoleInput
Description
All input for the updateAuxRoleByRole mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
auxRolePatch - AuxRolePatch!
|
An object where the defined keys will be set on the AuxRole being updated. |
role - String!
|
Example
{
"clientMutationId": "abc123",
"auxRolePatch": AuxRolePatch,
"role": "abc123"
}
UpdateAuxRoleInput
Description
All input for the updateAuxRole mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
nodeId - ID!
|
The globally unique ID which will identify a single AuxRole to be updated. |
auxRolePatch - AuxRolePatch!
|
An object where the defined keys will be set on the AuxRole being updated. |
Example
{
"clientMutationId": "xyz789",
"nodeId": 4,
"auxRolePatch": AuxRolePatch
}
UpdateAuxRolePayload
Description
The output of our update AuxRole mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
The exact same clientMutationId that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations. |
auxRole - AuxRole
|
The AuxRole that was updated by this mutation. |
query - Query
|
Our root query field type. Allows us to run any query from our mutation payload. |
auxRoleEdge - AuxRolesEdge
|
An edge for our AuxRole. May be used by Relay 1. |
Arguments
|
|
Example
{
"clientMutationId": "abc123",
"auxRole": AuxRole,
"query": Query,
"auxRoleEdge": AuxRolesEdge
}
UpdateBlockchainRegistrationByIdInput
Description
All input for the updateBlockchainRegistrationById mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
blockchainRegistrationPatch - BlockchainRegistrationPatch!
|
An object where the defined keys will be set on the BlockchainRegistration being updated. |
id - UUID!
|
Example
{
"clientMutationId": "abc123",
"blockchainRegistrationPatch": BlockchainRegistrationPatch,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
UpdateBlockchainRegistrationByNonceInput
Description
All input for the updateBlockchainRegistrationByNonce mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
blockchainRegistrationPatch - BlockchainRegistrationPatch!
|
An object where the defined keys will be set on the BlockchainRegistration being updated. |
nonce - String!
|
Example
{
"clientMutationId": "abc123",
"blockchainRegistrationPatch": BlockchainRegistrationPatch,
"nonce": "abc123"
}
UpdateBlockchainRegistrationInput
Description
All input for the updateBlockchainRegistration mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
nodeId - ID!
|
The globally unique ID which will identify a single BlockchainRegistration to be updated. |
blockchainRegistrationPatch - BlockchainRegistrationPatch!
|
An object where the defined keys will be set on the BlockchainRegistration being updated. |
Example
{
"clientMutationId": "abc123",
"nodeId": "4",
"blockchainRegistrationPatch": BlockchainRegistrationPatch
}
UpdateBlockchainRegistrationPayload
Description
The output of our update BlockchainRegistration mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
The exact same clientMutationId that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations. |
blockchainRegistration - BlockchainRegistration
|
The BlockchainRegistration that was updated by this mutation. |
query - Query
|
Our root query field type. Allows us to run any query from our mutation payload. |
blockchainAddressByBlockchainAddressId - BlockchainAddress
|
Reads a single BlockchainAddress that is related to this BlockchainRegistration. |
accountByAccountId - Account
|
Reads a single Account that is related to this BlockchainRegistration. |
usersAccountByUsersAccountId - UsersAccount
|
Reads a single UsersAccount that is related to this BlockchainRegistration. |
registrationStatusByStatus - RegistrationStatus
|
Reads a single RegistrationStatus that is related to this BlockchainRegistration. |
chainByChain - Chain
|
Reads a single Chain that is related to this BlockchainRegistration. |
registrationMethodByMethod - RegistrationMethod
|
Reads a single RegistrationMethod that is related to this BlockchainRegistration. |
blockchainRegistrationEdge - BlockchainRegistrationsEdge
|
An edge for our BlockchainRegistration. May be used by Relay 1. |
Arguments
|
|
Example
{
"clientMutationId": "xyz789",
"blockchainRegistration": BlockchainRegistration,
"query": Query,
"blockchainAddressByBlockchainAddressId": BlockchainAddress,
"accountByAccountId": Account,
"usersAccountByUsersAccountId": UsersAccount,
"registrationStatusByStatus": RegistrationStatus,
"chainByChain": Chain,
"registrationMethodByMethod": RegistrationMethod,
"blockchainRegistrationEdge": BlockchainRegistrationsEdge
}
UpdateBrokerAllocationByIdInput
Description
All input for the updateBrokerAllocationById mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
brokerAllocationPatch - BrokerAllocationPatch!
|
An object where the defined keys will be set on the BrokerAllocation being updated. |
id - UUID!
|
Example
{
"clientMutationId": "abc123",
"brokerAllocationPatch": BrokerAllocationPatch,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
UpdateBrokerAllocationInput
Description
All input for the updateBrokerAllocation mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
nodeId - ID!
|
The globally unique ID which will identify a single BrokerAllocation to be updated. |
brokerAllocationPatch - BrokerAllocationPatch!
|
An object where the defined keys will be set on the BrokerAllocation being updated. |
Example
{
"clientMutationId": "abc123",
"nodeId": "4",
"brokerAllocationPatch": BrokerAllocationPatch
}
UpdateBrokerAllocationPayload
Description
The output of our update BrokerAllocation mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
The exact same clientMutationId that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations. |
brokerAllocation - BrokerAllocation
|
The BrokerAllocation that was updated by this mutation. |
query - Query
|
Our root query field type. Allows us to run any query from our mutation payload. |
accountByBrokerId - Account
|
Reads a single Account that is related to this BrokerAllocation. |
invitationStatusByStatus - InvitationStatus
|
Reads a single InvitationStatus that is related to this BrokerAllocation. |
roundByRoundId - Round
|
Reads a single Round that is related to this BrokerAllocation. |
brokerAllocationEdge - BrokerAllocationsEdge
|
An edge for our BrokerAllocation. May be used by Relay 1. |
Arguments
|
|
Example
{
"clientMutationId": "abc123",
"brokerAllocation": BrokerAllocation,
"query": Query,
"accountByBrokerId": Account,
"invitationStatusByStatus": InvitationStatus,
"roundByRoundId": Round,
"brokerAllocationEdge": BrokerAllocationsEdge
}
UpdateCapitalDeploymentByIdInput
Description
All input for the updateCapitalDeploymentById mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
capitalDeploymentPatch - CapitalDeploymentPatch!
|
An object where the defined keys will be set on the CapitalDeployment being updated. |
id - UUID!
|
Example
{
"clientMutationId": "abc123",
"capitalDeploymentPatch": CapitalDeploymentPatch,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
UpdateCapitalDeploymentByTransactionGroupIdInput
Description
All input for the updateCapitalDeploymentByTransactionGroupId mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
capitalDeploymentPatch - CapitalDeploymentPatch!
|
An object where the defined keys will be set on the CapitalDeployment being updated. |
transactionGroupId - UUID!
|
Example
{
"clientMutationId": "xyz789",
"capitalDeploymentPatch": CapitalDeploymentPatch,
"transactionGroupId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
UpdateCapitalDeploymentInput
Description
All input for the updateCapitalDeployment mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
nodeId - ID!
|
The globally unique ID which will identify a single CapitalDeployment to be updated. |
capitalDeploymentPatch - CapitalDeploymentPatch!
|
An object where the defined keys will be set on the CapitalDeployment being updated. |
Example
{
"clientMutationId": "xyz789",
"nodeId": 4,
"capitalDeploymentPatch": CapitalDeploymentPatch
}
UpdateCapitalDeploymentPayload
Description
The output of our update CapitalDeployment mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
The exact same clientMutationId that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations. |
capitalDeployment - CapitalDeployment
|
The CapitalDeployment that was updated by this mutation. |
query - Query
|
Our root query field type. Allows us to run any query from our mutation payload. |
currencyByCurrency - Currency
|
Reads a single Currency that is related to this CapitalDeployment. |
roundByRoundId - Round
|
Reads a single Round that is related to this CapitalDeployment. |
capitalDeploymentEdge - CapitalDeploymentsEdge
|
An edge for our CapitalDeployment. May be used by Relay 1. |
Arguments
|
|
Example
{
"clientMutationId": "abc123",
"capitalDeployment": CapitalDeployment,
"query": Query,
"currencyByCurrency": Currency,
"roundByRoundId": Round,
"capitalDeploymentEdge": CapitalDeploymentsEdge
}
UpdateCustomerByIdInput
Description
All input for the updateCustomerById mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
customerPatch - CustomerPatch!
|
An object where the defined keys will be set on the Customer being updated. |
id - UUID!
|
Example
{
"clientMutationId": "xyz789",
"customerPatch": CustomerPatch,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
UpdateCustomerByVendorIdAndInvestorIdInput
Description
All input for the updateCustomerByVendorIdAndInvestorId mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
customerPatch - CustomerPatch!
|
An object where the defined keys will be set on the Customer being updated. |
vendorId - UUID!
|
|
investorId - UUID!
|
Example
{
"clientMutationId": "abc123",
"customerPatch": CustomerPatch,
"vendorId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"investorId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
UpdateCustomerInput
Description
All input for the updateCustomer mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
nodeId - ID!
|
The globally unique ID which will identify a single Customer to be updated. |
customerPatch - CustomerPatch!
|
An object where the defined keys will be set on the Customer being updated. |
Example
{
"clientMutationId": "xyz789",
"nodeId": 4,
"customerPatch": CustomerPatch
}
UpdateCustomerPayload
Description
The output of our update Customer mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
The exact same clientMutationId that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations. |
customer - Customer
|
The Customer that was updated by this mutation. |
query - Query
|
Our root query field type. Allows us to run any query from our mutation payload. |
accountByVendorId - Account
|
Reads a single Account that is related to this Customer. |
accountByInvestorId - Account
|
Reads a single Account that is related to this Customer. |
invitationStatusByStatus - InvitationStatus
|
Reads a single InvitationStatus that is related to this Customer. |
investorAccountTypeByInvestorType - InvestorAccountType
|
Reads a single InvestorAccountType that is related to this Customer. |
countryByJurisdiction - Country
|
Reads a single Country that is related to this Customer. |
customerEdge - CustomersEdge
|
An edge for our Customer. May be used by Relay 1. |
Arguments
|
|
Example
{
"clientMutationId": "xyz789",
"customer": Customer,
"query": Query,
"accountByVendorId": Account,
"accountByInvestorId": Account,
"invitationStatusByStatus": InvitationStatus,
"investorAccountTypeByInvestorType": InvestorAccountType,
"countryByJurisdiction": Country,
"customerEdge": CustomersEdge
}
UpdateDistributionAnnotationByIdInput
Description
All input for the updateDistributionAnnotationById mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
distributionAnnotationPatch - DistributionAnnotationPatch!
|
An object where the defined keys will be set on the DistributionAnnotation being updated. |
id - UUID!
|
Example
{
"clientMutationId": "xyz789",
"distributionAnnotationPatch": DistributionAnnotationPatch,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
UpdateDistributionAnnotationInput
Description
All input for the updateDistributionAnnotation mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
nodeId - ID!
|
The globally unique ID which will identify a single DistributionAnnotation to be updated. |
distributionAnnotationPatch - DistributionAnnotationPatch!
|
An object where the defined keys will be set on the DistributionAnnotation being updated. |
Example
{
"clientMutationId": "xyz789",
"nodeId": 4,
"distributionAnnotationPatch": DistributionAnnotationPatch
}
UpdateDistributionAnnotationPayload
Description
The output of our update DistributionAnnotation mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
The exact same clientMutationId that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations. |
distributionAnnotation - DistributionAnnotation
|
The DistributionAnnotation that was updated by this mutation. |
query - Query
|
Our root query field type. Allows us to run any query from our mutation payload. |
distributionByDistributionId - Distribution
|
Reads a single Distribution that is related to this DistributionAnnotation. |
userByWrittenBy - User
|
Reads a single User that is related to this DistributionAnnotation. |
accountByAccountId - Account
|
Reads a single Account that is related to this DistributionAnnotation. |
distributionAnnotationEdge - DistributionAnnotationsEdge
|
An edge for our DistributionAnnotation. May be used by Relay 1. |
Arguments
|
|
Example
{
"clientMutationId": "xyz789",
"distributionAnnotation": DistributionAnnotation,
"query": Query,
"distributionByDistributionId": Distribution,
"userByWrittenBy": User,
"accountByAccountId": Account,
"distributionAnnotationEdge": DistributionAnnotationsEdge
}
UpdateDistributionByClosedBlockchainIdInput
Description
All input for the updateDistributionByClosedBlockchainId mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
distributionPatch - DistributionPatch!
|
An object where the defined keys will be set on the Distribution being updated. |
closedBlockchainId - UUID!
|
Example
{
"clientMutationId": "xyz789",
"distributionPatch": DistributionPatch,
"closedBlockchainId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
UpdateDistributionByDraftedBlockchainIdInput
Description
All input for the updateDistributionByDraftedBlockchainId mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
distributionPatch - DistributionPatch!
|
An object where the defined keys will be set on the Distribution being updated. |
draftedBlockchainId - UUID!
|
Example
{
"clientMutationId": "xyz789",
"distributionPatch": DistributionPatch,
"draftedBlockchainId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
UpdateDistributionByIdInput
Description
All input for the updateDistributionById mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
distributionPatch - DistributionPatch!
|
An object where the defined keys will be set on the Distribution being updated. |
id - UUID!
|
Example
{
"clientMutationId": "abc123",
"distributionPatch": DistributionPatch,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
UpdateDistributionByLockedBlockchainIdInput
Description
All input for the updateDistributionByLockedBlockchainId mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
distributionPatch - DistributionPatch!
|
An object where the defined keys will be set on the Distribution being updated. |
lockedBlockchainId - UUID!
|
Example
{
"clientMutationId": "abc123",
"distributionPatch": DistributionPatch,
"lockedBlockchainId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
UpdateDistributionByNewIdInput
Description
All input for the updateDistributionByNewId mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
distributionPatch - DistributionPatch!
|
An object where the defined keys will be set on the Distribution being updated. |
newId - UUID!
|
Example
{
"clientMutationId": "xyz789",
"distributionPatch": DistributionPatch,
"newId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
UpdateDistributionByOpenBlockchainIdInput
Description
All input for the updateDistributionByOpenBlockchainId mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
distributionPatch - DistributionPatch!
|
An object where the defined keys will be set on the Distribution being updated. |
openBlockchainId - UUID!
|
Example
{
"clientMutationId": "xyz789",
"distributionPatch": DistributionPatch,
"openBlockchainId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
UpdateDistributionByStepIdInput
Description
All input for the updateDistributionByStepId mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
distributionPatch - DistributionPatch!
|
An object where the defined keys will be set on the Distribution being updated. |
stepId - UUID!
|
Example
{
"clientMutationId": "abc123",
"distributionPatch": DistributionPatch,
"stepId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
UpdateDistributionCustomFieldByIdInput
Description
All input for the updateDistributionCustomFieldById mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
distributionCustomFieldPatch - DistributionCustomFieldPatch!
|
An object where the defined keys will be set on the DistributionCustomField being updated. |
id - UUID!
|
Example
{
"clientMutationId": "xyz789",
"distributionCustomFieldPatch": DistributionCustomFieldPatch,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
UpdateDistributionCustomFieldInput
Description
All input for the updateDistributionCustomField mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
nodeId - ID!
|
The globally unique ID which will identify a single DistributionCustomField to be updated. |
distributionCustomFieldPatch - DistributionCustomFieldPatch!
|
An object where the defined keys will be set on the DistributionCustomField being updated. |
Example
{
"clientMutationId": "xyz789",
"nodeId": 4,
"distributionCustomFieldPatch": DistributionCustomFieldPatch
}
UpdateDistributionCustomFieldPayload
Description
The output of our update DistributionCustomField mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
The exact same clientMutationId that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations. |
distributionCustomField - DistributionCustomField
|
The DistributionCustomField that was updated by this mutation. |
query - Query
|
Our root query field type. Allows us to run any query from our mutation payload. |
accountByCreatedBy - Account
|
Reads a single Account that is related to this DistributionCustomField. |
distributionByDistributionId - Distribution
|
Reads a single Distribution that is related to this DistributionCustomField. |
distributionCustomFieldEdge - DistributionCustomFieldsEdge
|
An edge for our DistributionCustomField. May be used by Relay 1. |
Arguments
|
|
Example
{
"clientMutationId": "xyz789",
"distributionCustomField": DistributionCustomField,
"query": Query,
"accountByCreatedBy": Account,
"distributionByDistributionId": Distribution,
"distributionCustomFieldEdge": DistributionCustomFieldsEdge
}
UpdateDistributionInput
Description
All input for the updateDistribution mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
nodeId - ID!
|
The globally unique ID which will identify a single Distribution to be updated. |
distributionPatch - DistributionPatch!
|
An object where the defined keys will be set on the Distribution being updated. |
Example
{
"clientMutationId": "xyz789",
"nodeId": "4",
"distributionPatch": DistributionPatch
}
UpdateDistributionPayload
Description
The output of our update Distribution mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
The exact same clientMutationId that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations. |
distribution - Distribution
|
The Distribution that was updated by this mutation. |
query - Query
|
Our root query field type. Allows us to run any query from our mutation payload. |
allocationByAllocationId - Allocation
|
Reads a single Allocation that is related to this Distribution. |
accountByInvestorId - Account
|
Reads a single Account that is related to this Distribution. |
distributionStatusByStatus - DistributionStatus
|
Reads a single DistributionStatus that is related to this Distribution. |
stepByStepId - Step
|
Reads a single Step that is related to this Distribution. |
distributionEdge - DistributionsEdge
|
An edge for our Distribution. May be used by Relay 1. |
Arguments
|
|
Example
{
"clientMutationId": "abc123",
"distribution": Distribution,
"query": Query,
"allocationByAllocationId": Allocation,
"accountByInvestorId": Account,
"distributionStatusByStatus": DistributionStatus,
"stepByStepId": Step,
"distributionEdge": DistributionsEdge
}
UpdateDistributionPaymentByIdInput
Description
All input for the updateDistributionPaymentById mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
distributionPaymentPatch - DistributionPaymentPatch!
|
An object where the defined keys will be set on the DistributionPayment being updated. |
id - UUID!
|
Example
{
"clientMutationId": "xyz789",
"distributionPaymentPatch": DistributionPaymentPatch,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
UpdateDistributionPaymentInput
Description
All input for the updateDistributionPayment mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
nodeId - ID!
|
The globally unique ID which will identify a single DistributionPayment to be updated. |
distributionPaymentPatch - DistributionPaymentPatch!
|
An object where the defined keys will be set on the DistributionPayment being updated. |
Example
{
"clientMutationId": "xyz789",
"nodeId": 4,
"distributionPaymentPatch": DistributionPaymentPatch
}
UpdateDistributionPaymentPayload
Description
The output of our update DistributionPayment mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
The exact same clientMutationId that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations. |
distributionPayment - DistributionPayment
|
The DistributionPayment that was updated by this mutation. |
query - Query
|
Our root query field type. Allows us to run any query from our mutation payload. |
distributionByDistributionId - Distribution
|
Reads a single Distribution that is related to this DistributionPayment. |
currencyByCurrency - Currency
|
Reads a single Currency that is related to this DistributionPayment. |
distributionPaymentStatusByStatus - DistributionPaymentStatus
|
Reads a single DistributionPaymentStatus that is related to this DistributionPayment. |
distributionPaymentEdge - DistributionPaymentsEdge
|
An edge for our DistributionPayment. May be used by Relay 1. |
Arguments
|
|
Example
{
"clientMutationId": "xyz789",
"distributionPayment": DistributionPayment,
"query": Query,
"distributionByDistributionId": Distribution,
"currencyByCurrency": Currency,
"distributionPaymentStatusByStatus": DistributionPaymentStatus,
"distributionPaymentEdge": DistributionPaymentsEdge
}
UpdateDistributionPriceByIdInput
Description
All input for the updateDistributionPriceById mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
distributionPricePatch - DistributionPricePatch!
|
An object where the defined keys will be set on the DistributionPrice being updated. |
id - UUID!
|
Example
{
"clientMutationId": "xyz789",
"distributionPricePatch": DistributionPricePatch,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
UpdateDistributionPriceInput
Description
All input for the updateDistributionPrice mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
nodeId - ID!
|
The globally unique ID which will identify a single DistributionPrice to be updated. |
distributionPricePatch - DistributionPricePatch!
|
An object where the defined keys will be set on the DistributionPrice being updated. |
Example
{
"clientMutationId": "xyz789",
"nodeId": 4,
"distributionPricePatch": DistributionPricePatch
}
UpdateDistributionPricePayload
Description
The output of our update DistributionPrice mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
The exact same clientMutationId that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations. |
distributionPrice - DistributionPrice
|
The DistributionPrice that was updated by this mutation. |
query - Query
|
Our root query field type. Allows us to run any query from our mutation payload. |
distributionByDistributionId - Distribution
|
Reads a single Distribution that is related to this DistributionPrice. |
currencyByCurrency - Currency
|
Reads a single Currency that is related to this DistributionPrice. |
distributionPriceEdge - DistributionPricesEdge
|
An edge for our DistributionPrice. May be used by Relay 1. |
Arguments
|
|
Example
{
"clientMutationId": "xyz789",
"distributionPrice": DistributionPrice,
"query": Query,
"distributionByDistributionId": Distribution,
"currencyByCurrency": Currency,
"distributionPriceEdge": DistributionPricesEdge
}
UpdateDistributionQualificationOrderInput
Description
All input for the updateDistributionQualificationOrder mutation.
Example
{
"clientMutationId": "xyz789",
"distributionQualificationId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"_order": 987
}
UpdateDistributionQualificationOrderPayload
Description
The output of our updateDistributionQualificationOrder mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
The exact same clientMutationId that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations. |
distribution - Distribution
|
|
query - Query
|
Our root query field type. Allows us to run any query from our mutation payload. |
allocationByAllocationId - Allocation
|
Reads a single Allocation that is related to this Distribution. |
accountByInvestorId - Account
|
Reads a single Account that is related to this Distribution. |
distributionStatusByStatus - DistributionStatus
|
Reads a single DistributionStatus that is related to this Distribution. |
stepByStepId - Step
|
Reads a single Step that is related to this Distribution. |
distributionEdge - DistributionsEdge
|
An edge for our Distribution. May be used by Relay 1. |
Arguments
|
|
Example
{
"clientMutationId": "abc123",
"distribution": Distribution,
"query": Query,
"allocationByAllocationId": Allocation,
"accountByInvestorId": Account,
"distributionStatusByStatus": DistributionStatus,
"stepByStepId": Step,
"distributionEdge": DistributionsEdge
}
UpdateDocumentStatusByStatusInput
Description
All input for the updateDocumentStatusByStatus mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
documentStatusPatch - DocumentStatusPatch!
|
An object where the defined keys will be set on the DocumentStatus being updated. |
status - String!
|
Example
{
"clientMutationId": "abc123",
"documentStatusPatch": DocumentStatusPatch,
"status": "xyz789"
}
UpdateDocumentStatusInput
Description
All input for the updateDocumentStatus mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
nodeId - ID!
|
The globally unique ID which will identify a single DocumentStatus to be updated. |
documentStatusPatch - DocumentStatusPatch!
|
An object where the defined keys will be set on the DocumentStatus being updated. |
Example
{
"clientMutationId": "abc123",
"nodeId": "4",
"documentStatusPatch": DocumentStatusPatch
}
UpdateDocumentStatusPayload
Description
The output of our update DocumentStatus mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
The exact same clientMutationId that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations. |
documentStatus - DocumentStatus
|
The DocumentStatus that was updated by this mutation. |
query - Query
|
Our root query field type. Allows us to run any query from our mutation payload. |
documentStatusEdge - DocumentStatusesEdge
|
An edge for our DocumentStatus. May be used by Relay 1. |
Arguments
|
|
Example
{
"clientMutationId": "abc123",
"documentStatus": DocumentStatus,
"query": Query,
"documentStatusEdge": DocumentStatusesEdge
}
UpdateEmailTemplateToByToInput
Description
All input for the updateEmailTemplateToByTo mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
emailTemplateToPatch - EmailTemplateToPatch!
|
An object where the defined keys will be set on the EmailTemplateTo being updated. |
to - String!
|
Example
{
"clientMutationId": "xyz789",
"emailTemplateToPatch": EmailTemplateToPatch,
"to": "xyz789"
}
UpdateEmailTemplateToInput
Description
All input for the updateEmailTemplateTo mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
nodeId - ID!
|
The globally unique ID which will identify a single EmailTemplateTo to be updated. |
emailTemplateToPatch - EmailTemplateToPatch!
|
An object where the defined keys will be set on the EmailTemplateTo being updated. |
Example
{
"clientMutationId": "xyz789",
"nodeId": "4",
"emailTemplateToPatch": EmailTemplateToPatch
}
UpdateEmailTemplateToPayload
Description
The output of our update EmailTemplateTo mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
The exact same clientMutationId that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations. |
emailTemplateTo - EmailTemplateTo
|
The EmailTemplateTo that was updated by this mutation. |
query - Query
|
Our root query field type. Allows us to run any query from our mutation payload. |
emailTemplateToEdge - EmailTemplateTosEdge
|
An edge for our EmailTemplateTo. May be used by Relay 1. |
Arguments
|
|
Example
{
"clientMutationId": "abc123",
"emailTemplateTo": EmailTemplateTo,
"query": Query,
"emailTemplateToEdge": EmailTemplateTosEdge
}
UpdateInstancedAccountInformationHistoryByIdInput
Description
All input for the updateInstancedAccountInformationHistoryById mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
instancedAccountInformationHistoryPatch - InstancedAccountInformationHistoryPatch!
|
An object where the defined keys will be set on the InstancedAccountInformationHistory being updated. |
id - UUID!
|
Example
{
"clientMutationId": "xyz789",
"instancedAccountInformationHistoryPatch": InstancedAccountInformationHistoryPatch,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
UpdateInstancedAccountInformationHistoryInput
Description
All input for the updateInstancedAccountInformationHistory mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
nodeId - ID!
|
The globally unique ID which will identify a single InstancedAccountInformationHistory to be updated. |
instancedAccountInformationHistoryPatch - InstancedAccountInformationHistoryPatch!
|
An object where the defined keys will be set on the InstancedAccountInformationHistory being updated. |
Example
{
"clientMutationId": "abc123",
"nodeId": 4,
"instancedAccountInformationHistoryPatch": InstancedAccountInformationHistoryPatch
}
UpdateInstancedAccountInformationHistoryPayload
Description
The output of our update InstancedAccountInformationHistory mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
The exact same clientMutationId that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations. |
instancedAccountInformationHistory - InstancedAccountInformationHistory
|
The InstancedAccountInformationHistory that was updated by this mutation. |
query - Query
|
Our root query field type. Allows us to run any query from our mutation payload. |
instancedAccountInformationByRecordId - InstancedAccountInformation
|
Reads a single InstancedAccountInformation that is related to this InstancedAccountInformationHistory. |
instancedAccountInformationHistoryEdge - InstancedAccountInformationHistoriesEdge
|
An edge for our InstancedAccountInformationHistory. May be used by Relay 1. |
Arguments
|
|
Example
{
"clientMutationId": "abc123",
"instancedAccountInformationHistory": InstancedAccountInformationHistory,
"query": Query,
"instancedAccountInformationByRecordId": InstancedAccountInformation,
"instancedAccountInformationHistoryEdge": InstancedAccountInformationHistoriesEdge
}
UpdateMappedSigningTemplateByAccountIdAndNameInput
Description
All input for the updateMappedSigningTemplateByAccountIdAndName mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
mappedSigningTemplatePatch - MappedSigningTemplatePatch!
|
An object where the defined keys will be set on the MappedSigningTemplate being updated. |
accountId - UUID!
|
|
name - String!
|
Example
{
"clientMutationId": "abc123",
"mappedSigningTemplatePatch": MappedSigningTemplatePatch,
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"name": "abc123"
}
UpdateMappedSigningTemplateByIdInput
Description
All input for the updateMappedSigningTemplateById mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
mappedSigningTemplatePatch - MappedSigningTemplatePatch!
|
An object where the defined keys will be set on the MappedSigningTemplate being updated. |
id - UUID!
|
Example
{
"clientMutationId": "xyz789",
"mappedSigningTemplatePatch": MappedSigningTemplatePatch,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
UpdateMappedSigningTemplateByStepIdInput
Description
All input for the updateMappedSigningTemplateByStepId mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
mappedSigningTemplatePatch - MappedSigningTemplatePatch!
|
An object where the defined keys will be set on the MappedSigningTemplate being updated. |
stepId - UUID!
|
Example
{
"clientMutationId": "xyz789",
"mappedSigningTemplatePatch": MappedSigningTemplatePatch,
"stepId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
UpdateMappedSigningTemplateByVendorQualificationIdInput
Description
All input for the updateMappedSigningTemplateByVendorQualificationId mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
mappedSigningTemplatePatch - MappedSigningTemplatePatch!
|
An object where the defined keys will be set on the MappedSigningTemplate being updated. |
vendorQualificationId - UUID!
|
Example
{
"clientMutationId": "xyz789",
"mappedSigningTemplatePatch": MappedSigningTemplatePatch,
"vendorQualificationId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
UpdateMappedSigningTemplateInput
Description
All input for the updateMappedSigningTemplate mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
nodeId - ID!
|
The globally unique ID which will identify a single MappedSigningTemplate to be updated. |
mappedSigningTemplatePatch - MappedSigningTemplatePatch!
|
An object where the defined keys will be set on the MappedSigningTemplate being updated. |
Example
{
"clientMutationId": "xyz789",
"nodeId": "4",
"mappedSigningTemplatePatch": MappedSigningTemplatePatch
}
UpdateMappedSigningTemplatePayload
Description
The output of our update MappedSigningTemplate mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
The exact same clientMutationId that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations. |
mappedSigningTemplate - MappedSigningTemplate
|
The MappedSigningTemplate that was updated by this mutation. |
query - Query
|
Our root query field type. Allows us to run any query from our mutation payload. |
accountByAccountId - Account
|
Reads a single Account that is related to this MappedSigningTemplate. |
signingTemplateBySigningTemplateId - SigningTemplate
|
Reads a single SigningTemplate that is related to this MappedSigningTemplate. |
stepByStepId - Step
|
Reads a single Step that is related to this MappedSigningTemplate. |
vendorQualificationByVendorQualificationId - VendorQualification
|
Reads a single VendorQualification that is related to this MappedSigningTemplate. |
signingStepTypeByQualificationStepType - SigningStepType
|
Reads a single SigningStepType that is related to this MappedSigningTemplate. |
mappedSigningTemplateEdge - MappedSigningTemplatesEdge
|
An edge for our MappedSigningTemplate. May be used by Relay 1. |
Arguments
|
|
Example
{
"clientMutationId": "abc123",
"mappedSigningTemplate": MappedSigningTemplate,
"query": Query,
"accountByAccountId": Account,
"signingTemplateBySigningTemplateId": SigningTemplate,
"stepByStepId": Step,
"vendorQualificationByVendorQualificationId": VendorQualification,
"signingStepTypeByQualificationStepType": SigningStepType,
"mappedSigningTemplateEdge": MappedSigningTemplatesEdge
}
UpdateMappedSigningTemplateQuestionSetByIdInput
Description
All input for the updateMappedSigningTemplateQuestionSetById mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
mappedSigningTemplateQuestionSetPatch - MappedSigningTemplateQuestionSetPatch!
|
An object where the defined keys will be set on the MappedSigningTemplateQuestionSet being updated. |
id - UUID!
|
Example
{
"clientMutationId": "xyz789",
"mappedSigningTemplateQuestionSetPatch": MappedSigningTemplateQuestionSetPatch,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
UpdateMappedSigningTemplateQuestionSetByOnboardingQuestionSetIdAndMappedSigningTemplateIdInput
Description
All input for the updateMappedSigningTemplateQuestionSetByOnboardingQuestionSetIdAndMappedSigningTemplateId mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
mappedSigningTemplateQuestionSetPatch - MappedSigningTemplateQuestionSetPatch!
|
An object where the defined keys will be set on the MappedSigningTemplateQuestionSet being updated. |
onboardingQuestionSetId - UUID!
|
|
mappedSigningTemplateId - UUID!
|
Example
{
"clientMutationId": "xyz789",
"mappedSigningTemplateQuestionSetPatch": MappedSigningTemplateQuestionSetPatch,
"onboardingQuestionSetId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"mappedSigningTemplateId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
UpdateMappedSigningTemplateQuestionSetInput
Description
All input for the updateMappedSigningTemplateQuestionSet mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
nodeId - ID!
|
The globally unique ID which will identify a single MappedSigningTemplateQuestionSet to be updated. |
mappedSigningTemplateQuestionSetPatch - MappedSigningTemplateQuestionSetPatch!
|
An object where the defined keys will be set on the MappedSigningTemplateQuestionSet being updated. |
Example
{
"clientMutationId": "xyz789",
"nodeId": "4",
"mappedSigningTemplateQuestionSetPatch": MappedSigningTemplateQuestionSetPatch
}
UpdateMappedSigningTemplateQuestionSetPayload
Description
The output of our update MappedSigningTemplateQuestionSet mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
The exact same clientMutationId that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations. |
mappedSigningTemplateQuestionSet - MappedSigningTemplateQuestionSet
|
The MappedSigningTemplateQuestionSet that was updated by this mutation. |
query - Query
|
Our root query field type. Allows us to run any query from our mutation payload. |
onboardingQuestionSetByOnboardingQuestionSetId - OnboardingQuestionSet
|
Reads a single OnboardingQuestionSet that is related to this MappedSigningTemplateQuestionSet. |
mappedSigningTemplateByMappedSigningTemplateId - MappedSigningTemplate
|
Reads a single MappedSigningTemplate that is related to this MappedSigningTemplateQuestionSet. |
mappedSigningTemplateQuestionSetEdge - MappedSigningTemplateQuestionSetsEdge
|
An edge for our MappedSigningTemplateQuestionSet. May be used by Relay 1. |
Arguments
|
|
Example
{
"clientMutationId": "xyz789",
"mappedSigningTemplateQuestionSet": MappedSigningTemplateQuestionSet,
"query": Query,
"onboardingQuestionSetByOnboardingQuestionSetId": OnboardingQuestionSet,
"mappedSigningTemplateByMappedSigningTemplateId": MappedSigningTemplate,
"mappedSigningTemplateQuestionSetEdge": MappedSigningTemplateQuestionSetsEdge
}
UpdateOnboardingQuestionByAccountIdAndNameInput
Description
All input for the updateOnboardingQuestionByAccountIdAndName mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
onboardingQuestionPatch - OnboardingQuestionPatch!
|
An object where the defined keys will be set on the OnboardingQuestion being updated. |
accountId - UUID!
|
|
name - String!
|
Example
{
"clientMutationId": "abc123",
"onboardingQuestionPatch": OnboardingQuestionPatch,
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"name": "abc123"
}
UpdateOnboardingQuestionByIdInput
Description
All input for the updateOnboardingQuestionById mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
onboardingQuestionPatch - OnboardingQuestionPatch!
|
An object where the defined keys will be set on the OnboardingQuestion being updated. |
id - UUID!
|
Example
{
"clientMutationId": "xyz789",
"onboardingQuestionPatch": OnboardingQuestionPatch,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
UpdateOnboardingQuestionInput
Description
All input for the updateOnboardingQuestion mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
nodeId - ID!
|
The globally unique ID which will identify a single OnboardingQuestion to be updated. |
onboardingQuestionPatch - OnboardingQuestionPatch!
|
An object where the defined keys will be set on the OnboardingQuestion being updated. |
Example
{
"clientMutationId": "abc123",
"nodeId": 4,
"onboardingQuestionPatch": OnboardingQuestionPatch
}
UpdateOnboardingQuestionPayload
Description
The output of our update OnboardingQuestion mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
The exact same clientMutationId that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations. |
onboardingQuestion - OnboardingQuestion
|
The OnboardingQuestion that was updated by this mutation. |
query - Query
|
Our root query field type. Allows us to run any query from our mutation payload. |
accountByAccountId - Account
|
Reads a single Account that is related to this OnboardingQuestion. |
onboardingQuestionTypeByType - OnboardingQuestionType
|
Reads a single OnboardingQuestionType that is related to this OnboardingQuestion. |
onboardingQuestionEdge - OnboardingQuestionsEdge
|
An edge for our OnboardingQuestion. May be used by Relay 1. |
Arguments
|
|
Example
{
"clientMutationId": "abc123",
"onboardingQuestion": OnboardingQuestion,
"query": Query,
"accountByAccountId": Account,
"onboardingQuestionTypeByType": OnboardingQuestionType,
"onboardingQuestionEdge": OnboardingQuestionsEdge
}
UpdateOnboardingQuestionSetByAccountIdAndNameInput
Description
All input for the updateOnboardingQuestionSetByAccountIdAndName mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
onboardingQuestionSetPatch - OnboardingQuestionSetPatch!
|
An object where the defined keys will be set on the OnboardingQuestionSet being updated. |
accountId - UUID!
|
|
name - String!
|
Example
{
"clientMutationId": "xyz789",
"onboardingQuestionSetPatch": OnboardingQuestionSetPatch,
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"name": "xyz789"
}
UpdateOnboardingQuestionSetByIdInput
Description
All input for the updateOnboardingQuestionSetById mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
onboardingQuestionSetPatch - OnboardingQuestionSetPatch!
|
An object where the defined keys will be set on the OnboardingQuestionSet being updated. |
id - UUID!
|
Example
{
"clientMutationId": "abc123",
"onboardingQuestionSetPatch": OnboardingQuestionSetPatch,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
UpdateOnboardingQuestionSetByVendorQualificationIdInput
Description
All input for the updateOnboardingQuestionSetByVendorQualificationId mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
onboardingQuestionSetPatch - OnboardingQuestionSetPatch!
|
An object where the defined keys will be set on the OnboardingQuestionSet being updated. |
vendorQualificationId - UUID!
|
Example
{
"clientMutationId": "xyz789",
"onboardingQuestionSetPatch": OnboardingQuestionSetPatch,
"vendorQualificationId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
UpdateOnboardingQuestionSetInput
Description
All input for the updateOnboardingQuestionSet mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
nodeId - ID!
|
The globally unique ID which will identify a single OnboardingQuestionSet to be updated. |
onboardingQuestionSetPatch - OnboardingQuestionSetPatch!
|
An object where the defined keys will be set on the OnboardingQuestionSet being updated. |
Example
{
"clientMutationId": "abc123",
"nodeId": 4,
"onboardingQuestionSetPatch": OnboardingQuestionSetPatch
}
UpdateOnboardingQuestionSetPayload
Description
The output of our update OnboardingQuestionSet mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
The exact same clientMutationId that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations. |
onboardingQuestionSet - OnboardingQuestionSet
|
The OnboardingQuestionSet that was updated by this mutation. |
query - Query
|
Our root query field type. Allows us to run any query from our mutation payload. |
accountByAccountId - Account
|
Reads a single Account that is related to this OnboardingQuestionSet. |
vendorQualificationByVendorQualificationId - VendorQualification
|
Reads a single VendorQualification that is related to this OnboardingQuestionSet. |
onboardingQuestionSetEdge - OnboardingQuestionSetsEdge
|
An edge for our OnboardingQuestionSet. May be used by Relay 1. |
Arguments
|
|
Example
{
"clientMutationId": "abc123",
"onboardingQuestionSet": OnboardingQuestionSet,
"query": Query,
"accountByAccountId": Account,
"vendorQualificationByVendorQualificationId": VendorQualification,
"onboardingQuestionSetEdge": OnboardingQuestionSetsEdge
}
UpdatePaymentMethodByAccountIdAndNameInput
Description
All input for the updatePaymentMethodByAccountIdAndName mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
paymentMethodPatch - PaymentMethodPatch!
|
An object where the defined keys will be set on the PaymentMethod being updated. |
accountId - UUID!
|
|
name - String!
|
Example
{
"clientMutationId": "xyz789",
"paymentMethodPatch": PaymentMethodPatch,
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"name": "abc123"
}
UpdatePaymentMethodByEncryptedRecordIdInput
Description
All input for the updatePaymentMethodByEncryptedRecordId mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
paymentMethodPatch - PaymentMethodPatch!
|
An object where the defined keys will be set on the PaymentMethod being updated. |
encryptedRecordId - UUID!
|
Example
{
"clientMutationId": "abc123",
"paymentMethodPatch": PaymentMethodPatch,
"encryptedRecordId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
UpdatePaymentMethodByIdInput
Description
All input for the updatePaymentMethodById mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
paymentMethodPatch - PaymentMethodPatch!
|
An object where the defined keys will be set on the PaymentMethod being updated. |
id - UUID!
|
Example
{
"clientMutationId": "abc123",
"paymentMethodPatch": PaymentMethodPatch,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
UpdatePaymentMethodInput
Description
All input for the updatePaymentMethod mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
nodeId - ID!
|
The globally unique ID which will identify a single PaymentMethod to be updated. |
paymentMethodPatch - PaymentMethodPatch!
|
An object where the defined keys will be set on the PaymentMethod being updated. |
Example
{
"clientMutationId": "xyz789",
"nodeId": 4,
"paymentMethodPatch": PaymentMethodPatch
}
UpdatePaymentMethodPayload
Description
The output of our update PaymentMethod mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
The exact same clientMutationId that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations. |
paymentMethod - PaymentMethod
|
The PaymentMethod that was updated by this mutation. |
query - Query
|
Our root query field type. Allows us to run any query from our mutation payload. |
accountByAccountId - Account
|
Reads a single Account that is related to this PaymentMethod. |
integrationByIntegrationId - Integration
|
Reads a single Integration that is related to this PaymentMethod. |
paymentMethodTypeByType - PaymentMethodType
|
Reads a single PaymentMethodType that is related to this PaymentMethod. |
paymentMethodEdge - PaymentMethodsEdge
|
An edge for our PaymentMethod. May be used by Relay 1. |
Arguments
|
|
Example
{
"clientMutationId": "abc123",
"paymentMethod": PaymentMethod,
"query": Query,
"accountByAccountId": Account,
"integrationByIntegrationId": Integration,
"paymentMethodTypeByType": PaymentMethodType,
"paymentMethodEdge": PaymentMethodsEdge
}
UpdatePaymentMethodTypeByTypeInput
Description
All input for the updatePaymentMethodTypeByType mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
paymentMethodTypePatch - PaymentMethodTypePatch!
|
An object where the defined keys will be set on the PaymentMethodType being updated. |
type - String!
|
Example
{
"clientMutationId": "abc123",
"paymentMethodTypePatch": PaymentMethodTypePatch,
"type": "xyz789"
}
UpdatePaymentMethodTypeInput
Description
All input for the updatePaymentMethodType mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
nodeId - ID!
|
The globally unique ID which will identify a single PaymentMethodType to be updated. |
paymentMethodTypePatch - PaymentMethodTypePatch!
|
An object where the defined keys will be set on the PaymentMethodType being updated. |
Example
{
"clientMutationId": "abc123",
"nodeId": 4,
"paymentMethodTypePatch": PaymentMethodTypePatch
}
UpdatePaymentMethodTypePayload
Description
The output of our update PaymentMethodType mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
The exact same clientMutationId that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations. |
paymentMethodType - PaymentMethodType
|
The PaymentMethodType that was updated by this mutation. |
query - Query
|
Our root query field type. Allows us to run any query from our mutation payload. |
paymentMethodTypeEdge - PaymentMethodTypesEdge
|
An edge for our PaymentMethodType. May be used by Relay 1. |
Arguments
|
|
Example
{
"clientMutationId": "xyz789",
"paymentMethodType": PaymentMethodType,
"query": Query,
"paymentMethodTypeEdge": PaymentMethodTypesEdge
}
UpdatePaymentStepTypeByTypeInput
Description
All input for the updatePaymentStepTypeByType mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
paymentStepTypePatch - PaymentStepTypePatch!
|
An object where the defined keys will be set on the PaymentStepType being updated. |
type - String!
|
Example
{
"clientMutationId": "abc123",
"paymentStepTypePatch": PaymentStepTypePatch,
"type": "xyz789"
}
UpdatePaymentStepTypeInput
Description
All input for the updatePaymentStepType mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
nodeId - ID!
|
The globally unique ID which will identify a single PaymentStepType to be updated. |
paymentStepTypePatch - PaymentStepTypePatch!
|
An object where the defined keys will be set on the PaymentStepType being updated. |
Example
{
"clientMutationId": "xyz789",
"nodeId": "4",
"paymentStepTypePatch": PaymentStepTypePatch
}
UpdatePaymentStepTypePayload
Description
The output of our update PaymentStepType mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
The exact same clientMutationId that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations. |
paymentStepType - PaymentStepType
|
The PaymentStepType that was updated by this mutation. |
query - Query
|
Our root query field type. Allows us to run any query from our mutation payload. |
paymentStepTypeEdge - PaymentStepTypesEdge
|
An edge for our PaymentStepType. May be used by Relay 1. |
Arguments
|
|
Example
{
"clientMutationId": "xyz789",
"paymentStepType": PaymentStepType,
"query": Query,
"paymentStepTypeEdge": PaymentStepTypesEdge
}
UpdateRestrictionCategoryByCategoryInput
Description
All input for the updateRestrictionCategoryByCategory mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
restrictionCategoryPatch - RestrictionCategoryPatch!
|
An object where the defined keys will be set on the RestrictionCategory being updated. |
category - String!
|
Example
{
"clientMutationId": "abc123",
"restrictionCategoryPatch": RestrictionCategoryPatch,
"category": "abc123"
}
UpdateRestrictionCategoryInput
Description
All input for the updateRestrictionCategory mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
nodeId - ID!
|
The globally unique ID which will identify a single RestrictionCategory to be updated. |
restrictionCategoryPatch - RestrictionCategoryPatch!
|
An object where the defined keys will be set on the RestrictionCategory being updated. |
Example
{
"clientMutationId": "xyz789",
"nodeId": 4,
"restrictionCategoryPatch": RestrictionCategoryPatch
}
UpdateRestrictionCategoryPayload
Description
The output of our update RestrictionCategory mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
The exact same clientMutationId that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations. |
restrictionCategory - RestrictionCategory
|
The RestrictionCategory that was updated by this mutation. |
query - Query
|
Our root query field type. Allows us to run any query from our mutation payload. |
restrictionCategoryEdge - RestrictionCategoriesEdge
|
An edge for our RestrictionCategory. May be used by Relay 1. |
Arguments
|
|
Example
{
"clientMutationId": "abc123",
"restrictionCategory": RestrictionCategory,
"query": Query,
"restrictionCategoryEdge": RestrictionCategoriesEdge
}
UpdateRestrictionReasonByIdInput
Description
All input for the updateRestrictionReasonById mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
restrictionReasonPatch - RestrictionReasonPatch!
|
An object where the defined keys will be set on the RestrictionReason being updated. |
id - Int!
|
Example
{
"clientMutationId": "abc123",
"restrictionReasonPatch": RestrictionReasonPatch,
"id": 123
}
UpdateRestrictionReasonByReasonInput
Description
All input for the updateRestrictionReasonByReason mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
restrictionReasonPatch - RestrictionReasonPatch!
|
An object where the defined keys will be set on the RestrictionReason being updated. |
reason - String!
|
Example
{
"clientMutationId": "xyz789",
"restrictionReasonPatch": RestrictionReasonPatch,
"reason": "xyz789"
}
UpdateRestrictionReasonInput
Description
All input for the updateRestrictionReason mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
nodeId - ID!
|
The globally unique ID which will identify a single RestrictionReason to be updated. |
restrictionReasonPatch - RestrictionReasonPatch!
|
An object where the defined keys will be set on the RestrictionReason being updated. |
Example
{
"clientMutationId": "abc123",
"nodeId": "4",
"restrictionReasonPatch": RestrictionReasonPatch
}
UpdateRestrictionReasonPayload
Description
The output of our update RestrictionReason mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
The exact same clientMutationId that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations. |
restrictionReason - RestrictionReason
|
The RestrictionReason that was updated by this mutation. |
query - Query
|
Our root query field type. Allows us to run any query from our mutation payload. |
restrictionCategoryByCategory - RestrictionCategory
|
Reads a single RestrictionCategory that is related to this RestrictionReason. |
restrictionReasonEdge - RestrictionReasonsEdge
|
An edge for our RestrictionReason. May be used by Relay 1. |
Arguments
|
|
Example
{
"clientMutationId": "xyz789",
"restrictionReason": RestrictionReason,
"query": Query,
"restrictionCategoryByCategory": RestrictionCategory,
"restrictionReasonEdge": RestrictionReasonsEdge
}
UpdateRoundByBlockchainAddressIdInput
Description
All input for the updateRoundByBlockchainAddressId mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
roundPatch - RoundPatch!
|
An object where the defined keys will be set on the Round being updated. |
blockchainAddressId - UUID!
|
Example
{
"clientMutationId": "xyz789",
"roundPatch": RoundPatch,
"blockchainAddressId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
UpdateRoundByIdInput
Description
All input for the updateRoundById mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
roundPatch - RoundPatch!
|
An object where the defined keys will be set on the Round being updated. |
id - UUID!
|
Example
{
"clientMutationId": "abc123",
"roundPatch": RoundPatch,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
UpdateRoundByTokenIdInput
Description
All input for the updateRoundByTokenId mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
roundPatch - RoundPatch!
|
An object where the defined keys will be set on the Round being updated. |
tokenId - UUID!
|
Example
{
"clientMutationId": "xyz789",
"roundPatch": RoundPatch,
"tokenId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
UpdateRoundInput
Description
All input for the updateRound mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
nodeId - ID!
|
The globally unique ID which will identify a single Round to be updated. |
roundPatch - RoundPatch!
|
An object where the defined keys will be set on the Round being updated. |
Example
{
"clientMutationId": "xyz789",
"nodeId": 4,
"roundPatch": RoundPatch
}
UpdateRoundPayload
Description
The output of our update Round mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
The exact same clientMutationId that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations. |
round - Round
|
The Round that was updated by this mutation. |
query - Query
|
Our root query field type. Allows us to run any query from our mutation payload. |
assetByAssetId - Asset
|
Reads a single Asset that is related to this Round. |
tokenByTokenId - Token
|
Reads a single Token that is related to this Round. |
assetStatusByStatus - AssetStatus
|
Reads a single AssetStatus that is related to this Round. |
blockchainAddressByBlockchainAddressId - BlockchainAddress
|
Reads a single BlockchainAddress that is related to this Round. |
securityBySecurityId - Security
|
Reads a single Security that is related to this Round. |
roundEdge - RoundsEdge
|
An edge for our Round. May be used by Relay 1. |
Arguments
|
|
Example
{
"clientMutationId": "xyz789",
"round": Round,
"query": Query,
"assetByAssetId": Asset,
"tokenByTokenId": Token,
"assetStatusByStatus": AssetStatus,
"blockchainAddressByBlockchainAddressId": BlockchainAddress,
"securityBySecurityId": Security,
"roundEdge": RoundsEdge
}
UpdateSecurityByBlockchainAddressIdInput
Description
All input for the updateSecurityByBlockchainAddressId mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
securityPatch - SecurityPatch!
|
An object where the defined keys will be set on the Security being updated. |
blockchainAddressId - UUID!
|
Example
{
"clientMutationId": "xyz789",
"securityPatch": SecurityPatch,
"blockchainAddressId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
UpdateSecurityByIdInput
Description
All input for the updateSecurityById mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
securityPatch - SecurityPatch!
|
An object where the defined keys will be set on the Security being updated. |
id - UUID!
|
Example
{
"clientMutationId": "abc123",
"securityPatch": SecurityPatch,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
UpdateSecurityInput
Description
All input for the updateSecurity mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
nodeId - ID!
|
The globally unique ID which will identify a single Security to be updated. |
securityPatch - SecurityPatch!
|
An object where the defined keys will be set on the Security being updated. |
Example
{
"clientMutationId": "xyz789",
"nodeId": 4,
"securityPatch": SecurityPatch
}
UpdateSecurityPayload
Description
The output of our update Security mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
The exact same clientMutationId that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations. |
security - Security
|
The Security that was updated by this mutation. |
query - Query
|
Our root query field type. Allows us to run any query from our mutation payload. |
accountByIssuerId - Account
|
Reads a single Account that is related to this Security. |
blockchainAddressByBlockchainAddressId - BlockchainAddress
|
Reads a single BlockchainAddress that is related to this Security. |
accountByTaId - Account
|
Reads a single Account that is related to this Security. |
securityEdge - SecuritiesEdge
|
An edge for our Security. May be used by Relay 1. |
Arguments
|
|
Example
{
"clientMutationId": "abc123",
"security": Security,
"query": Query,
"accountByIssuerId": Account,
"blockchainAddressByBlockchainAddressId": BlockchainAddress,
"accountByTaId": Account,
"securityEdge": SecuritiesEdge
}
UpdateSigningFieldByIdInput
Description
All input for the updateSigningFieldById mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
signingFieldPatch - SigningFieldPatch!
|
An object where the defined keys will be set on the SigningField being updated. |
id - UUID!
|
Example
{
"clientMutationId": "xyz789",
"signingFieldPatch": SigningFieldPatch,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
UpdateSigningFieldInput
Description
All input for the updateSigningField mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
nodeId - ID!
|
The globally unique ID which will identify a single SigningField to be updated. |
signingFieldPatch - SigningFieldPatch!
|
An object where the defined keys will be set on the SigningField being updated. |
Example
{
"clientMutationId": "xyz789",
"nodeId": 4,
"signingFieldPatch": SigningFieldPatch
}
UpdateSigningFieldPayload
Description
The output of our update SigningField mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
The exact same clientMutationId that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations. |
signingField - SigningField
|
The SigningField that was updated by this mutation. |
query - Query
|
Our root query field type. Allows us to run any query from our mutation payload. |
mappedSigningTemplateByMappedSigningTemplateId - MappedSigningTemplate
|
Reads a single MappedSigningTemplate that is related to this SigningField. |
signingDocumentBySigningDocumentId - SigningDocument
|
Reads a single SigningDocument that is related to this SigningField. |
signingRoleBySigningRoleId - SigningRole
|
Reads a single SigningRole that is related to this SigningField. |
signingFieldEdge - SigningFieldsEdge
|
An edge for our SigningField. May be used by Relay 1. |
Arguments
|
|
Example
{
"clientMutationId": "abc123",
"signingField": SigningField,
"query": Query,
"mappedSigningTemplateByMappedSigningTemplateId": MappedSigningTemplate,
"signingDocumentBySigningDocumentId": SigningDocument,
"signingRoleBySigningRoleId": SigningRole,
"signingFieldEdge": SigningFieldsEdge
}
UpdateSigningRoleByIdInput
Description
All input for the updateSigningRoleById mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
signingRolePatch - SigningRolePatch!
|
An object where the defined keys will be set on the SigningRole being updated. |
id - UUID!
|
Example
{
"clientMutationId": "abc123",
"signingRolePatch": SigningRolePatch,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
UpdateSigningRoleInput
Description
All input for the updateSigningRole mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
nodeId - ID!
|
The globally unique ID which will identify a single SigningRole to be updated. |
signingRolePatch - SigningRolePatch!
|
An object where the defined keys will be set on the SigningRole being updated. |
Example
{
"clientMutationId": "xyz789",
"nodeId": "4",
"signingRolePatch": SigningRolePatch
}
UpdateSigningRolePayload
Description
The output of our update SigningRole mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
The exact same clientMutationId that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations. |
signingRole - SigningRole
|
The SigningRole that was updated by this mutation. |
query - Query
|
Our root query field type. Allows us to run any query from our mutation payload. |
mappedSigningTemplateByMappedSigningTemplateId - MappedSigningTemplate
|
Reads a single MappedSigningTemplate that is related to this SigningRole. |
mappingRoleByMapTo - MappingRole
|
Reads a single MappingRole that is related to this SigningRole. |
mappingRoleTypeByType - MappingRoleType
|
Reads a single MappingRoleType that is related to this SigningRole. |
signingRoleEdge - SigningRolesEdge
|
An edge for our SigningRole. May be used by Relay 1. |
Arguments
|
|
Example
{
"clientMutationId": "xyz789",
"signingRole": SigningRole,
"query": Query,
"mappedSigningTemplateByMappedSigningTemplateId": MappedSigningTemplate,
"mappingRoleByMapTo": MappingRole,
"mappingRoleTypeByType": MappingRoleType,
"signingRoleEdge": SigningRolesEdge
}
UpdateTrancheBondDatumByIdInput
Description
All input for the updateTrancheBondDatumById mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
trancheBondDatumPatch - TrancheBondDatumPatch!
|
An object where the defined keys will be set on the TrancheBondDatum being updated. |
id - UUID!
|
Example
{
"clientMutationId": "abc123",
"trancheBondDatumPatch": TrancheBondDatumPatch,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
UpdateTrancheBondDatumByRoundIdInput
Description
All input for the updateTrancheBondDatumByRoundId mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
trancheBondDatumPatch - TrancheBondDatumPatch!
|
An object where the defined keys will be set on the TrancheBondDatum being updated. |
roundId - UUID!
|
Example
{
"clientMutationId": "abc123",
"trancheBondDatumPatch": TrancheBondDatumPatch,
"roundId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
UpdateTrancheBondDatumInput
Description
All input for the updateTrancheBondDatum mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
nodeId - ID!
|
The globally unique ID which will identify a single TrancheBondDatum to be updated. |
trancheBondDatumPatch - TrancheBondDatumPatch!
|
An object where the defined keys will be set on the TrancheBondDatum being updated. |
Example
{
"clientMutationId": "abc123",
"nodeId": "4",
"trancheBondDatumPatch": TrancheBondDatumPatch
}
UpdateTrancheBondDatumPayload
Description
The output of our update TrancheBondDatum mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
The exact same clientMutationId that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations. |
trancheBondDatum - TrancheBondDatum
|
The TrancheBondDatum that was updated by this mutation. |
query - Query
|
Our root query field type. Allows us to run any query from our mutation payload. |
roundByRoundId - Round
|
Reads a single Round that is related to this TrancheBondDatum. |
trancheBondDatumEdge - TrancheBondDataEdge
|
An edge for our TrancheBondDatum. May be used by Relay 1. |
Arguments
|
|
Example
{
"clientMutationId": "abc123",
"trancheBondDatum": TrancheBondDatum,
"query": Query,
"roundByRoundId": Round,
"trancheBondDatumEdge": TrancheBondDataEdge
}
UpdateTransactionAnnotationByIdInput
Description
All input for the updateTransactionAnnotationById mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
transactionAnnotationPatch - TransactionAnnotationPatch!
|
An object where the defined keys will be set on the TransactionAnnotation being updated. |
id - UUID!
|
Example
{
"clientMutationId": "abc123",
"transactionAnnotationPatch": TransactionAnnotationPatch,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
UpdateTransactionAnnotationInput
Description
All input for the updateTransactionAnnotation mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
nodeId - ID!
|
The globally unique ID which will identify a single TransactionAnnotation to be updated. |
transactionAnnotationPatch - TransactionAnnotationPatch!
|
An object where the defined keys will be set on the TransactionAnnotation being updated. |
Example
{
"clientMutationId": "xyz789",
"nodeId": "4",
"transactionAnnotationPatch": TransactionAnnotationPatch
}
UpdateTransactionAnnotationPayload
Description
The output of our update TransactionAnnotation mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
The exact same clientMutationId that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations. |
transactionAnnotation - TransactionAnnotation
|
The TransactionAnnotation that was updated by this mutation. |
query - Query
|
Our root query field type. Allows us to run any query from our mutation payload. |
transactionByTransactionId - Transaction
|
Reads a single Transaction that is related to this TransactionAnnotation. |
userByWrittenBy - User
|
Reads a single User that is related to this TransactionAnnotation. |
accountByAccountId - Account
|
Reads a single Account that is related to this TransactionAnnotation. |
transactionAnnotationEdge - TransactionAnnotationsEdge
|
An edge for our TransactionAnnotation. May be used by Relay 1. |
Arguments
|
|
Example
{
"clientMutationId": "xyz789",
"transactionAnnotation": TransactionAnnotation,
"query": Query,
"transactionByTransactionId": Transaction,
"userByWrittenBy": User,
"accountByAccountId": Account,
"transactionAnnotationEdge": TransactionAnnotationsEdge
}
UpdateTransactionGroupTypeByTypeInput
Description
All input for the updateTransactionGroupTypeByType mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
transactionGroupTypePatch - TransactionGroupTypePatch!
|
An object where the defined keys will be set on the TransactionGroupType being updated. |
type - String!
|
Example
{
"clientMutationId": "xyz789",
"transactionGroupTypePatch": TransactionGroupTypePatch,
"type": "xyz789"
}
UpdateTransactionGroupTypeInput
Description
All input for the updateTransactionGroupType mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
nodeId - ID!
|
The globally unique ID which will identify a single TransactionGroupType to be updated. |
transactionGroupTypePatch - TransactionGroupTypePatch!
|
An object where the defined keys will be set on the TransactionGroupType being updated. |
Example
{
"clientMutationId": "abc123",
"nodeId": "4",
"transactionGroupTypePatch": TransactionGroupTypePatch
}
UpdateTransactionGroupTypePayload
Description
The output of our update TransactionGroupType mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
The exact same clientMutationId that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations. |
transactionGroupType - TransactionGroupType
|
The TransactionGroupType that was updated by this mutation. |
query - Query
|
Our root query field type. Allows us to run any query from our mutation payload. |
transactionGroupTypeEdge - TransactionGroupTypesEdge
|
An edge for our TransactionGroupType. May be used by Relay 1. |
Arguments
|
|
Example
{
"clientMutationId": "abc123",
"transactionGroupType": TransactionGroupType,
"query": Query,
"transactionGroupTypeEdge": TransactionGroupTypesEdge
}
UpdateUsersAccountByIdInput
Description
All input for the updateUsersAccountById mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
usersAccountPatch - UsersAccountPatch!
|
An object where the defined keys will be set on the UsersAccount being updated. |
id - UUID!
|
Example
{
"clientMutationId": "abc123",
"usersAccountPatch": UsersAccountPatch,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
UpdateUsersAccountByUserIdAndAccountIdInput
Description
All input for the updateUsersAccountByUserIdAndAccountId mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
usersAccountPatch - UsersAccountPatch!
|
An object where the defined keys will be set on the UsersAccount being updated. |
userId - UUID!
|
|
accountId - UUID!
|
Example
{
"clientMutationId": "abc123",
"usersAccountPatch": UsersAccountPatch,
"userId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
UpdateUsersAccountInput
Description
All input for the updateUsersAccount mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
nodeId - ID!
|
The globally unique ID which will identify a single UsersAccount to be updated. |
usersAccountPatch - UsersAccountPatch!
|
An object where the defined keys will be set on the UsersAccount being updated. |
Example
{
"clientMutationId": "abc123",
"nodeId": 4,
"usersAccountPatch": UsersAccountPatch
}
UpdateUsersAccountPayload
Description
The output of our update UsersAccount mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
The exact same clientMutationId that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations. |
usersAccount - UsersAccount
|
The UsersAccount that was updated by this mutation. |
query - Query
|
Our root query field type. Allows us to run any query from our mutation payload. |
userByUserId - User
|
Reads a single User that is related to this UsersAccount. |
accountByAccountId - Account
|
Reads a single Account that is related to this UsersAccount. |
auxRoleByRole - AuxRole
|
Reads a single AuxRole that is related to this UsersAccount. |
userStatusByStatus - UserStatus
|
Reads a single UserStatus that is related to this UsersAccount. |
usersAccountEdge - UsersAccountsEdge
|
An edge for our UsersAccount. May be used by Relay 1. |
Arguments
|
|
Example
{
"clientMutationId": "xyz789",
"usersAccount": UsersAccount,
"query": Query,
"userByUserId": User,
"accountByAccountId": Account,
"auxRoleByRole": AuxRole,
"userStatusByStatus": UserStatus,
"usersAccountEdge": UsersAccountsEdge
}
UpdateVendorAgentByAgentIdAndVendorIdInput
Description
All input for the updateVendorAgentByAgentIdAndVendorId mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
vendorAgentPatch - VendorAgentPatch!
|
An object where the defined keys will be set on the VendorAgent being updated. |
agentId - UUID!
|
|
vendorId - UUID!
|
Example
{
"clientMutationId": "abc123",
"vendorAgentPatch": VendorAgentPatch,
"agentId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"vendorId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
UpdateVendorAgentByIdInput
Description
All input for the updateVendorAgentById mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
vendorAgentPatch - VendorAgentPatch!
|
An object where the defined keys will be set on the VendorAgent being updated. |
id - UUID!
|
Example
{
"clientMutationId": "abc123",
"vendorAgentPatch": VendorAgentPatch,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
UpdateVendorAgentInput
Description
All input for the updateVendorAgent mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
nodeId - ID!
|
The globally unique ID which will identify a single VendorAgent to be updated. |
vendorAgentPatch - VendorAgentPatch!
|
An object where the defined keys will be set on the VendorAgent being updated. |
Example
{
"clientMutationId": "abc123",
"nodeId": 4,
"vendorAgentPatch": VendorAgentPatch
}
UpdateVendorAgentPayload
Description
The output of our update VendorAgent mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
The exact same clientMutationId that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations. |
vendorAgent - VendorAgent
|
The VendorAgent that was updated by this mutation. |
query - Query
|
Our root query field type. Allows us to run any query from our mutation payload. |
accountByAgentId - Account
|
Reads a single Account that is related to this VendorAgent. |
accountByVendorId - Account
|
Reads a single Account that is related to this VendorAgent. |
invitationStatusByStatus - InvitationStatus
|
Reads a single InvitationStatus that is related to this VendorAgent. |
vendorAgentEdge - VendorAgentsEdge
|
An edge for our VendorAgent. May be used by Relay 1. |
Arguments
|
|
Example
{
"clientMutationId": "abc123",
"vendorAgent": VendorAgent,
"query": Query,
"accountByAgentId": Account,
"accountByVendorId": Account,
"invitationStatusByStatus": InvitationStatus,
"vendorAgentEdge": VendorAgentsEdge
}
UpdateVendorDefaultEmailPreferenceByAccountIdInput
Description
All input for the updateVendorDefaultEmailPreferenceByAccountId mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
vendorDefaultEmailPreferencePatch - VendorDefaultEmailPreferencePatch!
|
An object where the defined keys will be set on the VendorDefaultEmailPreference being updated. |
accountId - UUID!
|
Example
{
"clientMutationId": "abc123",
"vendorDefaultEmailPreferencePatch": VendorDefaultEmailPreferencePatch,
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
UpdateVendorDefaultEmailPreferenceByIdInput
Description
All input for the updateVendorDefaultEmailPreferenceById mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
vendorDefaultEmailPreferencePatch - VendorDefaultEmailPreferencePatch!
|
An object where the defined keys will be set on the VendorDefaultEmailPreference being updated. |
id - UUID!
|
Example
{
"clientMutationId": "xyz789",
"vendorDefaultEmailPreferencePatch": VendorDefaultEmailPreferencePatch,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
UpdateVendorDefaultEmailPreferenceInput
Description
All input for the updateVendorDefaultEmailPreference mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
nodeId - ID!
|
The globally unique ID which will identify a single VendorDefaultEmailPreference to be updated. |
vendorDefaultEmailPreferencePatch - VendorDefaultEmailPreferencePatch!
|
An object where the defined keys will be set on the VendorDefaultEmailPreference being updated. |
Example
{
"clientMutationId": "abc123",
"nodeId": 4,
"vendorDefaultEmailPreferencePatch": VendorDefaultEmailPreferencePatch
}
UpdateVendorDefaultEmailPreferencePayload
Description
The output of our update VendorDefaultEmailPreference mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
The exact same clientMutationId that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations. |
vendorDefaultEmailPreference - VendorDefaultEmailPreference
|
The VendorDefaultEmailPreference that was updated by this mutation. |
query - Query
|
Our root query field type. Allows us to run any query from our mutation payload. |
accountByAccountId - Account
|
Reads a single Account that is related to this VendorDefaultEmailPreference. |
vendorDefaultEmailPreferenceEdge - VendorDefaultEmailPreferencesEdge
|
An edge for our VendorDefaultEmailPreference. May be used by Relay 1. |
Arguments
|
|
Example
{
"clientMutationId": "abc123",
"vendorDefaultEmailPreference": VendorDefaultEmailPreference,
"query": Query,
"accountByAccountId": Account,
"vendorDefaultEmailPreferenceEdge": VendorDefaultEmailPreferencesEdge
}
UpdateVendorIntegrationStatusByStatusInput
Description
All input for the updateVendorIntegrationStatusByStatus mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
vendorIntegrationStatusPatch - VendorIntegrationStatusPatch!
|
An object where the defined keys will be set on the VendorIntegrationStatus being updated. |
status - String!
|
Example
{
"clientMutationId": "xyz789",
"vendorIntegrationStatusPatch": VendorIntegrationStatusPatch,
"status": "abc123"
}
UpdateVendorIntegrationStatusInput
Description
All input for the updateVendorIntegrationStatus mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
nodeId - ID!
|
The globally unique ID which will identify a single VendorIntegrationStatus to be updated. |
vendorIntegrationStatusPatch - VendorIntegrationStatusPatch!
|
An object where the defined keys will be set on the VendorIntegrationStatus being updated. |
Example
{
"clientMutationId": "xyz789",
"nodeId": "4",
"vendorIntegrationStatusPatch": VendorIntegrationStatusPatch
}
UpdateVendorIntegrationStatusPayload
Description
The output of our update VendorIntegrationStatus mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
The exact same clientMutationId that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations. |
vendorIntegrationStatus - VendorIntegrationStatus
|
The VendorIntegrationStatus that was updated by this mutation. |
query - Query
|
Our root query field type. Allows us to run any query from our mutation payload. |
vendorIntegrationStatusEdge - VendorIntegrationStatusesEdge
|
An edge for our VendorIntegrationStatus. May be used by Relay 1. |
Arguments
|
|
Example
{
"clientMutationId": "abc123",
"vendorIntegrationStatus": VendorIntegrationStatus,
"query": Query,
"vendorIntegrationStatusEdge": VendorIntegrationStatusesEdge
}
UpdateVestingEventByIdInput
Description
All input for the updateVestingEventById mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
vestingEventPatch - VestingEventPatch!
|
An object where the defined keys will be set on the VestingEvent being updated. |
id - UUID!
|
Example
{
"clientMutationId": "xyz789",
"vestingEventPatch": VestingEventPatch,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
UpdateVestingEventInput
Description
All input for the updateVestingEvent mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
nodeId - ID!
|
The globally unique ID which will identify a single VestingEvent to be updated. |
vestingEventPatch - VestingEventPatch!
|
An object where the defined keys will be set on the VestingEvent being updated. |
Example
{
"clientMutationId": "xyz789",
"nodeId": 4,
"vestingEventPatch": VestingEventPatch
}
UpdateVestingEventPayload
Description
The output of our update VestingEvent mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
The exact same clientMutationId that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations. |
vestingEvent - VestingEvent
|
The VestingEvent that was updated by this mutation. |
query - Query
|
Our root query field type. Allows us to run any query from our mutation payload. |
vestingScheduleByVestingScheduleId - VestingSchedule
|
Reads a single VestingSchedule that is related to this VestingEvent. |
transactionByTransactionId - Transaction
|
Reads a single Transaction that is related to this VestingEvent. |
vestingEventEdge - VestingEventsEdge
|
An edge for our VestingEvent. May be used by Relay 1. |
Arguments
|
|
Example
{
"clientMutationId": "abc123",
"vestingEvent": VestingEvent,
"query": Query,
"vestingScheduleByVestingScheduleId": VestingSchedule,
"transactionByTransactionId": Transaction,
"vestingEventEdge": VestingEventsEdge
}
UpdateVestingScheduleByDistributionIdInput
Description
All input for the updateVestingScheduleByDistributionId mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
vestingSchedulePatch - VestingSchedulePatch!
|
An object where the defined keys will be set on the VestingSchedule being updated. |
distributionId - UUID!
|
Example
{
"clientMutationId": "xyz789",
"vestingSchedulePatch": VestingSchedulePatch,
"distributionId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
UpdateVestingScheduleByIdInput
Description
All input for the updateVestingScheduleById mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
vestingSchedulePatch - VestingSchedulePatch!
|
An object where the defined keys will be set on the VestingSchedule being updated. |
id - UUID!
|
Example
{
"clientMutationId": "abc123",
"vestingSchedulePatch": VestingSchedulePatch,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
UpdateVestingScheduleInput
Description
All input for the updateVestingSchedule mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
nodeId - ID!
|
The globally unique ID which will identify a single VestingSchedule to be updated. |
vestingSchedulePatch - VestingSchedulePatch!
|
An object where the defined keys will be set on the VestingSchedule being updated. |
Example
{
"clientMutationId": "abc123",
"nodeId": 4,
"vestingSchedulePatch": VestingSchedulePatch
}
UpdateVestingSchedulePayload
Description
The output of our update VestingSchedule mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
The exact same clientMutationId that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations. |
vestingSchedule - VestingSchedule
|
The VestingSchedule that was updated by this mutation. |
query - Query
|
Our root query field type. Allows us to run any query from our mutation payload. |
distributionByDistributionId - Distribution
|
Reads a single Distribution that is related to this VestingSchedule. |
vestingDurationByDuration - VestingDuration
|
Reads a single VestingDuration that is related to this VestingSchedule. |
vestingScheduleEdge - VestingSchedulesEdge
|
An edge for our VestingSchedule. May be used by Relay 1. |
Arguments
|
|
Example
{
"clientMutationId": "abc123",
"vestingSchedule": VestingSchedule,
"query": Query,
"distributionByDistributionId": Distribution,
"vestingDurationByDuration": VestingDuration,
"vestingScheduleEdge": VestingSchedulesEdge
}
UpdateWalletAssignmentByDistributionIdInput
Description
All input for the updateWalletAssignmentByDistributionId mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
walletAssignmentPatch - WalletAssignmentPatch!
|
An object where the defined keys will be set on the WalletAssignment being updated. |
distributionId - UUID!
|
Example
{
"clientMutationId": "abc123",
"walletAssignmentPatch": WalletAssignmentPatch,
"distributionId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
UpdateWalletAssignmentByIdInput
Description
All input for the updateWalletAssignmentById mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
walletAssignmentPatch - WalletAssignmentPatch!
|
An object where the defined keys will be set on the WalletAssignment being updated. |
id - UUID!
|
Example
{
"clientMutationId": "abc123",
"walletAssignmentPatch": WalletAssignmentPatch,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
UpdateWalletAssignmentInput
Description
All input for the updateWalletAssignment mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
nodeId - ID!
|
The globally unique ID which will identify a single WalletAssignment to be updated. |
walletAssignmentPatch - WalletAssignmentPatch!
|
An object where the defined keys will be set on the WalletAssignment being updated. |
Example
{
"clientMutationId": "abc123",
"nodeId": "4",
"walletAssignmentPatch": WalletAssignmentPatch
}
UpdateWalletAssignmentPayload
Description
The output of our update WalletAssignment mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
The exact same clientMutationId that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations. |
walletAssignment - WalletAssignment
|
The WalletAssignment that was updated by this mutation. |
query - Query
|
Our root query field type. Allows us to run any query from our mutation payload. |
distributionByDistributionId - Distribution
|
Reads a single Distribution that is related to this WalletAssignment. |
blockchainAddressByBlockchainAddressId - BlockchainAddress
|
Reads a single BlockchainAddress that is related to this WalletAssignment. |
walletAssignmentEdge - WalletAssignmentsEdge
|
An edge for our WalletAssignment. May be used by Relay 1. |
Arguments
|
|
Example
{
"clientMutationId": "abc123",
"walletAssignment": WalletAssignment,
"query": Query,
"distributionByDistributionId": Distribution,
"blockchainAddressByBlockchainAddressId": BlockchainAddress,
"walletAssignmentEdge": WalletAssignmentsEdge
}
UpdateWebhookConfigurationByIdInput
Description
All input for the updateWebhookConfigurationById mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
webhookConfigurationPatch - WebhookConfigurationPatch!
|
An object where the defined keys will be set on the WebhookConfiguration being updated. |
id - UUID!
|
Example
{
"clientMutationId": "xyz789",
"webhookConfigurationPatch": WebhookConfigurationPatch,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
UpdateWebhookConfigurationByLevelAndAccountIdInput
Description
All input for the updateWebhookConfigurationByLevelAndAccountId mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
webhookConfigurationPatch - WebhookConfigurationPatch!
|
An object where the defined keys will be set on the WebhookConfiguration being updated. |
level - String!
|
|
accountId - UUID!
|
Example
{
"clientMutationId": "abc123",
"webhookConfigurationPatch": WebhookConfigurationPatch,
"level": "xyz789",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
UpdateWebhookConfigurationInput
Description
All input for the updateWebhookConfiguration mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client. |
nodeId - ID!
|
The globally unique ID which will identify a single WebhookConfiguration to be updated. |
webhookConfigurationPatch - WebhookConfigurationPatch!
|
An object where the defined keys will be set on the WebhookConfiguration being updated. |
Example
{
"clientMutationId": "abc123",
"nodeId": 4,
"webhookConfigurationPatch": WebhookConfigurationPatch
}
UpdateWebhookConfigurationPayload
Description
The output of our update WebhookConfiguration mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
The exact same clientMutationId that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations. |
webhookConfiguration - WebhookConfiguration
|
The WebhookConfiguration that was updated by this mutation. |
query - Query
|
Our root query field type. Allows us to run any query from our mutation payload. |
webhookLevelByLevel - WebhookLevel
|
Reads a single WebhookLevel that is related to this WebhookConfiguration. |
accountByAccountId - Account
|
Reads a single Account that is related to this WebhookConfiguration. |
webhookConfigurationEdge - WebhookConfigurationsEdge
|
An edge for our WebhookConfiguration. May be used by Relay 1. |
Arguments
|
|
Example
{
"clientMutationId": "abc123",
"webhookConfiguration": WebhookConfiguration,
"query": Query,
"webhookLevelByLevel": WebhookLevel,
"accountByAccountId": Account,
"webhookConfigurationEdge": WebhookConfigurationsEdge
}
User
Fields
| Field Name | Description |
|---|---|
nodeId - ID!
|
A globally unique identifier. Can be used in various places throughout the system to identify this single value. |
status - String!
|
|
firstName - String!
|
|
lastName - String!
|
|
createdOn - Datetime!
|
|
hasInvestorAccount - Boolean
|
|
id - UUID!
|
|
userStatusByStatus - UserStatus
|
Reads a single UserStatus that is related to this User. |
emailsByUserId - EmailsConnection!
|
Reads and enables pagination through a set of Email. |
Arguments
|
|
usersAccountsByUserId - UsersAccountsConnection!
|
Reads and enables pagination through a set of UsersAccount. |
Arguments
|
|
distributionAnnotationsByWrittenBy - DistributionAnnotationsConnection!
|
Reads and enables pagination through a set of DistributionAnnotation. |
Arguments
|
|
assetAnnotationsByWrittenBy - AssetAnnotationsConnection!
|
Reads and enables pagination through a set of AssetAnnotation. |
Arguments
|
|
allocationAnnotationsByWrittenBy - AllocationAnnotationsConnection!
|
Reads and enables pagination through a set of AllocationAnnotation. |
Arguments
|
|
transactionAnnotationsByWrittenBy - TransactionAnnotationsConnection!
|
Reads and enables pagination through a set of TransactionAnnotation. |
Arguments
|
|
managedAccountsByCreatedBy - ManagedAccountsConnection!
|
Reads and enables pagination through a set of ManagedAccount. |
Arguments
|
|
userTermsOfServicesByUserId - UserTermsOfServicesConnection!
|
Reads and enables pagination through a set of UserTermsOfService. |
Arguments
|
|
issuanceEventsByCreatedBy - IssuanceEventsConnection!
|
Reads and enables pagination through a set of IssuanceEvent. |
Arguments
|
|
accountDocumentsByCreatedBy - AccountDocumentsConnection!
|
Reads and enables pagination through a set of AccountDocument. |
Arguments
|
|
documentSharingsByCreatedBy - DocumentSharingsConnection!
|
Reads and enables pagination through a set of DocumentSharing. |
Arguments
|
|
accountRestrictionsByCreatorUserId - AccountRestrictionsConnection!
|
Reads and enables pagination through a set of AccountRestriction. |
Arguments
|
|
customerPartiesByUserId - CustomerPartiesConnection!
|
Reads and enables pagination through a set of CustomerParty. |
Arguments
|
|
customerPartiesByCreatorUserId - CustomerPartiesConnection!
|
Reads and enables pagination through a set of CustomerParty. |
Arguments
|
|
customerAddressesByCreatorUserId - CustomerAddressesConnection!
|
Reads and enables pagination through a set of CustomerAddress. |
Arguments
|
|
customerPartyAddressesByCreatorUserId - CustomerPartyAddressesConnection!
|
Reads and enables pagination through a set of CustomerPartyAddress. |
Arguments
|
|
blockchainAddressSourcesByCreatorUserId - BlockchainAddressSourcesConnection!
|
Reads and enables pagination through a set of BlockchainAddressSource. |
Arguments
|
|
taRequestsByCreatorUserId - TaRequestsConnection!
|
Reads and enables pagination through a set of TaRequest. |
Arguments
|
|
partiesByUserId - PartiesConnection!
|
Reads and enables pagination through a set of Party. |
Arguments
|
|
pendingTermsOfService - TermsOfService
|
|
Example
{
"nodeId": "4",
"status": "abc123",
"firstName": "abc123",
"lastName": "abc123",
"createdOn": Datetime,
"hasInvestorAccount": false,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"userStatusByStatus": UserStatus,
"emailsByUserId": EmailsConnection,
"usersAccountsByUserId": UsersAccountsConnection,
"distributionAnnotationsByWrittenBy": DistributionAnnotationsConnection,
"assetAnnotationsByWrittenBy": AssetAnnotationsConnection,
"allocationAnnotationsByWrittenBy": AllocationAnnotationsConnection,
"transactionAnnotationsByWrittenBy": TransactionAnnotationsConnection,
"managedAccountsByCreatedBy": ManagedAccountsConnection,
"userTermsOfServicesByUserId": UserTermsOfServicesConnection,
"issuanceEventsByCreatedBy": IssuanceEventsConnection,
"accountDocumentsByCreatedBy": AccountDocumentsConnection,
"documentSharingsByCreatedBy": DocumentSharingsConnection,
"accountRestrictionsByCreatorUserId": AccountRestrictionsConnection,
"customerPartiesByUserId": CustomerPartiesConnection,
"customerPartiesByCreatorUserId": CustomerPartiesConnection,
"customerAddressesByCreatorUserId": CustomerAddressesConnection,
"customerPartyAddressesByCreatorUserId": CustomerPartyAddressesConnection,
"blockchainAddressSourcesByCreatorUserId": BlockchainAddressSourcesConnection,
"taRequestsByCreatorUserId": TaRequestsConnection,
"partiesByUserId": PartiesConnection,
"pendingTermsOfService": TermsOfService
}
UserCondition
Description
A condition to be used against User object types. All fields are tested for equality and combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
status - String
|
Checks for equality with the object’s status field. |
firstName - String
|
Checks for equality with the object’s firstName field. |
lastName - String
|
Checks for equality with the object’s lastName field. |
createdOn - Datetime
|
Checks for equality with the object’s createdOn field. |
hasInvestorAccount - Boolean
|
Checks for equality with the object’s hasInvestorAccount field. |
id - UUID
|
Checks for equality with the object’s id field. |
Example
{
"status": "abc123",
"firstName": "abc123",
"lastName": "xyz789",
"createdOn": Datetime,
"hasInvestorAccount": false,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
UserFilter
Description
A filter to be used against User object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
status - StringFilter
|
Filter by the object’s status field. |
firstName - StringFilter
|
Filter by the object’s firstName field. |
lastName - StringFilter
|
Filter by the object’s lastName field. |
createdOn - DatetimeFilter
|
Filter by the object’s createdOn field. |
hasInvestorAccount - BooleanFilter
|
Filter by the object’s hasInvestorAccount field. |
id - UUIDFilter
|
Filter by the object’s id field. |
emailsByUserId - UserToManyEmailFilter
|
Filter by the object’s emailsByUserId relation. |
emailsByUserIdExist - Boolean
|
Some related emailsByUserId exist. |
usersAccountsByUserId - UserToManyUsersAccountFilter
|
Filter by the object’s usersAccountsByUserId relation. |
usersAccountsByUserIdExist - Boolean
|
Some related usersAccountsByUserId exist. |
distributionAnnotationsByWrittenBy - UserToManyDistributionAnnotationFilter
|
Filter by the object’s distributionAnnotationsByWrittenBy relation. |
distributionAnnotationsByWrittenByExist - Boolean
|
Some related distributionAnnotationsByWrittenBy exist. |
assetAnnotationsByWrittenBy - UserToManyAssetAnnotationFilter
|
Filter by the object’s assetAnnotationsByWrittenBy relation. |
assetAnnotationsByWrittenByExist - Boolean
|
Some related assetAnnotationsByWrittenBy exist. |
allocationAnnotationsByWrittenBy - UserToManyAllocationAnnotationFilter
|
Filter by the object’s allocationAnnotationsByWrittenBy relation. |
allocationAnnotationsByWrittenByExist - Boolean
|
Some related allocationAnnotationsByWrittenBy exist. |
transactionAnnotationsByWrittenBy - UserToManyTransactionAnnotationFilter
|
Filter by the object’s transactionAnnotationsByWrittenBy relation. |
transactionAnnotationsByWrittenByExist - Boolean
|
Some related transactionAnnotationsByWrittenBy exist. |
managedAccountsByCreatedBy - UserToManyManagedAccountFilter
|
Filter by the object’s managedAccountsByCreatedBy relation. |
managedAccountsByCreatedByExist - Boolean
|
Some related managedAccountsByCreatedBy exist. |
userTermsOfServicesByUserId - UserToManyUserTermsOfServiceFilter
|
Filter by the object’s userTermsOfServicesByUserId relation. |
userTermsOfServicesByUserIdExist - Boolean
|
Some related userTermsOfServicesByUserId exist. |
issuanceEventsByCreatedBy - UserToManyIssuanceEventFilter
|
Filter by the object’s issuanceEventsByCreatedBy relation. |
issuanceEventsByCreatedByExist - Boolean
|
Some related issuanceEventsByCreatedBy exist. |
accountDocumentsByCreatedBy - UserToManyAccountDocumentFilter
|
Filter by the object’s accountDocumentsByCreatedBy relation. |
accountDocumentsByCreatedByExist - Boolean
|
Some related accountDocumentsByCreatedBy exist. |
documentSharingsByCreatedBy - UserToManyDocumentSharingFilter
|
Filter by the object’s documentSharingsByCreatedBy relation. |
documentSharingsByCreatedByExist - Boolean
|
Some related documentSharingsByCreatedBy exist. |
accountRestrictionsByCreatorUserId - UserToManyAccountRestrictionFilter
|
Filter by the object’s accountRestrictionsByCreatorUserId relation. |
accountRestrictionsByCreatorUserIdExist - Boolean
|
Some related accountRestrictionsByCreatorUserId exist. |
customerPartiesByUserId - UserToManyCustomerPartyFilter
|
Filter by the object’s customerPartiesByUserId relation. |
customerPartiesByUserIdExist - Boolean
|
Some related customerPartiesByUserId exist. |
customerPartiesByCreatorUserId - UserToManyCustomerPartyFilter
|
Filter by the object’s customerPartiesByCreatorUserId relation. |
customerPartiesByCreatorUserIdExist - Boolean
|
Some related customerPartiesByCreatorUserId exist. |
customerAddressesByCreatorUserId - UserToManyCustomerAddressFilter
|
Filter by the object’s customerAddressesByCreatorUserId relation. |
customerAddressesByCreatorUserIdExist - Boolean
|
Some related customerAddressesByCreatorUserId exist. |
customerPartyAddressesByCreatorUserId - UserToManyCustomerPartyAddressFilter
|
Filter by the object’s customerPartyAddressesByCreatorUserId relation. |
customerPartyAddressesByCreatorUserIdExist - Boolean
|
Some related customerPartyAddressesByCreatorUserId exist. |
blockchainAddressSourcesByCreatorUserId - UserToManyBlockchainAddressSourceFilter
|
Filter by the object’s blockchainAddressSourcesByCreatorUserId relation. |
blockchainAddressSourcesByCreatorUserIdExist - Boolean
|
Some related blockchainAddressSourcesByCreatorUserId exist. |
taRequestsByCreatorUserId - UserToManyTaRequestFilter
|
Filter by the object’s taRequestsByCreatorUserId relation. |
taRequestsByCreatorUserIdExist - Boolean
|
Some related taRequestsByCreatorUserId exist. |
partiesByUserId - UserToManyPartyFilter
|
Filter by the object’s partiesByUserId relation. |
partiesByUserIdExist - Boolean
|
Some related partiesByUserId exist. |
userStatusByStatus - UserStatusFilter
|
Filter by the object’s userStatusByStatus relation. |
and - [UserFilter!]
|
Checks for all expressions in this list. |
or - [UserFilter!]
|
Checks for any expressions in this list. |
not - UserFilter
|
Negates the expression. |
Example
{
"status": StringFilter,
"firstName": StringFilter,
"lastName": StringFilter,
"createdOn": DatetimeFilter,
"hasInvestorAccount": BooleanFilter,
"id": UUIDFilter,
"emailsByUserId": UserToManyEmailFilter,
"emailsByUserIdExist": true,
"usersAccountsByUserId": UserToManyUsersAccountFilter,
"usersAccountsByUserIdExist": false,
"distributionAnnotationsByWrittenBy": UserToManyDistributionAnnotationFilter,
"distributionAnnotationsByWrittenByExist": false,
"assetAnnotationsByWrittenBy": UserToManyAssetAnnotationFilter,
"assetAnnotationsByWrittenByExist": true,
"allocationAnnotationsByWrittenBy": UserToManyAllocationAnnotationFilter,
"allocationAnnotationsByWrittenByExist": false,
"transactionAnnotationsByWrittenBy": UserToManyTransactionAnnotationFilter,
"transactionAnnotationsByWrittenByExist": false,
"managedAccountsByCreatedBy": UserToManyManagedAccountFilter,
"managedAccountsByCreatedByExist": false,
"userTermsOfServicesByUserId": UserToManyUserTermsOfServiceFilter,
"userTermsOfServicesByUserIdExist": true,
"issuanceEventsByCreatedBy": UserToManyIssuanceEventFilter,
"issuanceEventsByCreatedByExist": true,
"accountDocumentsByCreatedBy": UserToManyAccountDocumentFilter,
"accountDocumentsByCreatedByExist": false,
"documentSharingsByCreatedBy": UserToManyDocumentSharingFilter,
"documentSharingsByCreatedByExist": false,
"accountRestrictionsByCreatorUserId": UserToManyAccountRestrictionFilter,
"accountRestrictionsByCreatorUserIdExist": true,
"customerPartiesByUserId": UserToManyCustomerPartyFilter,
"customerPartiesByUserIdExist": false,
"customerPartiesByCreatorUserId": UserToManyCustomerPartyFilter,
"customerPartiesByCreatorUserIdExist": true,
"customerAddressesByCreatorUserId": UserToManyCustomerAddressFilter,
"customerAddressesByCreatorUserIdExist": false,
"customerPartyAddressesByCreatorUserId": UserToManyCustomerPartyAddressFilter,
"customerPartyAddressesByCreatorUserIdExist": false,
"blockchainAddressSourcesByCreatorUserId": UserToManyBlockchainAddressSourceFilter,
"blockchainAddressSourcesByCreatorUserIdExist": false,
"taRequestsByCreatorUserId": UserToManyTaRequestFilter,
"taRequestsByCreatorUserIdExist": false,
"partiesByUserId": UserToManyPartyFilter,
"partiesByUserIdExist": false,
"userStatusByStatus": UserStatusFilter,
"and": [UserFilter],
"or": [UserFilter],
"not": UserFilter
}
UserStatus
Fields
| Field Name | Description |
|---|---|
nodeId - ID!
|
A globally unique identifier. Can be used in various places throughout the system to identify this single value. |
status - String!
|
|
usersByStatus - UsersConnection!
|
Reads and enables pagination through a set of User. |
Arguments
|
|
usersAccountsByStatus - UsersAccountsConnection!
|
Reads and enables pagination through a set of UsersAccount. |
Arguments
|
|
Example
{
"nodeId": "4",
"status": "abc123",
"usersByStatus": UsersConnection,
"usersAccountsByStatus": UsersAccountsConnection
}
UserStatusCondition
Description
A condition to be used against UserStatus object types. All fields are tested for equality and combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
status - String
|
Checks for equality with the object’s status field. |
Example
{"status": "abc123"}
UserStatusFilter
Description
A filter to be used against UserStatus object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
status - StringFilter
|
Filter by the object’s status field. |
usersByStatus - UserStatusToManyUserFilter
|
Filter by the object’s usersByStatus relation. |
usersByStatusExist - Boolean
|
Some related usersByStatus exist. |
usersAccountsByStatus - UserStatusToManyUsersAccountFilter
|
Filter by the object’s usersAccountsByStatus relation. |
usersAccountsByStatusExist - Boolean
|
Some related usersAccountsByStatus exist. |
and - [UserStatusFilter!]
|
Checks for all expressions in this list. |
or - [UserStatusFilter!]
|
Checks for any expressions in this list. |
not - UserStatusFilter
|
Negates the expression. |
Example
{
"status": StringFilter,
"usersByStatus": UserStatusToManyUserFilter,
"usersByStatusExist": true,
"usersAccountsByStatus": UserStatusToManyUsersAccountFilter,
"usersAccountsByStatusExist": true,
"and": [UserStatusFilter],
"or": [UserStatusFilter],
"not": UserStatusFilter
}
UserStatusToManyUserFilter
Description
A filter to be used against many User object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - UserFilter
|
Every related User matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - UserFilter
|
Some related User matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - UserFilter
|
No related User matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": UserFilter,
"some": UserFilter,
"none": UserFilter
}
UserStatusToManyUsersAccountFilter
Description
A filter to be used against many UsersAccount object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - UsersAccountFilter
|
Every related UsersAccount matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - UsersAccountFilter
|
Some related UsersAccount matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - UsersAccountFilter
|
No related UsersAccount matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": UsersAccountFilter,
"some": UsersAccountFilter,
"none": UsersAccountFilter
}
UserStatusesConnection
Description
A connection to a list of UserStatus values.
Fields
| Field Name | Description |
|---|---|
nodes - [UserStatus]!
|
A list of UserStatus objects. |
edges - [UserStatusesEdge!]!
|
A list of edges which contains the UserStatus and cursor to aid in pagination. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The count of all UserStatus you could get from the connection. |
Example
{
"nodes": [UserStatus],
"edges": [UserStatusesEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
UserStatusesEdge
Description
A UserStatus edge in the connection.
Fields
| Field Name | Description |
|---|---|
cursor - Cursor
|
A cursor for use in pagination. |
node - UserStatus
|
The UserStatus at the end of the edge. |
Example
{
"cursor": Cursor,
"node": UserStatus
}
UserStatusesOrderBy
Description
Methods to use when ordering UserStatus.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NATURAL"
UserTermsOfService
Fields
| Field Name | Description |
|---|---|
nodeId - ID!
|
A globally unique identifier. Can be used in various places throughout the system to identify this single value. |
id - UUID!
|
|
userId - UUID!
|
|
termsOfServiceId - UUID!
|
|
createdOn - Datetime
|
|
userByUserId - User
|
Reads a single User that is related to this UserTermsOfService. |
termsOfServiceByTermsOfServiceId - TermsOfService
|
Reads a single TermsOfService that is related to this UserTermsOfService. |
Example
{
"nodeId": 4,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"userId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"termsOfServiceId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"createdOn": Datetime,
"userByUserId": User,
"termsOfServiceByTermsOfServiceId": TermsOfService
}
UserTermsOfServiceCondition
Description
A condition to be used against UserTermsOfService object types. All fields are tested for equality and combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
id - UUID
|
Checks for equality with the object’s id field. |
userId - UUID
|
Checks for equality with the object’s userId field. |
termsOfServiceId - UUID
|
Checks for equality with the object’s termsOfServiceId field. |
createdOn - Datetime
|
Checks for equality with the object’s createdOn field. |
Example
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"userId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"termsOfServiceId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"createdOn": Datetime
}
UserTermsOfServiceFilter
Description
A filter to be used against UserTermsOfService object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
id - UUIDFilter
|
Filter by the object’s id field. |
userId - UUIDFilter
|
Filter by the object’s userId field. |
termsOfServiceId - UUIDFilter
|
Filter by the object’s termsOfServiceId field. |
createdOn - DatetimeFilter
|
Filter by the object’s createdOn field. |
userByUserId - UserFilter
|
Filter by the object’s userByUserId relation. |
termsOfServiceByTermsOfServiceId - TermsOfServiceFilter
|
Filter by the object’s termsOfServiceByTermsOfServiceId relation. |
and - [UserTermsOfServiceFilter!]
|
Checks for all expressions in this list. |
or - [UserTermsOfServiceFilter!]
|
Checks for any expressions in this list. |
not - UserTermsOfServiceFilter
|
Negates the expression. |
Example
{
"id": UUIDFilter,
"userId": UUIDFilter,
"termsOfServiceId": UUIDFilter,
"createdOn": DatetimeFilter,
"userByUserId": UserFilter,
"termsOfServiceByTermsOfServiceId": TermsOfServiceFilter,
"and": [UserTermsOfServiceFilter],
"or": [UserTermsOfServiceFilter],
"not": UserTermsOfServiceFilter
}
UserTermsOfServicesConnection
Description
A connection to a list of UserTermsOfService values.
Fields
| Field Name | Description |
|---|---|
nodes - [UserTermsOfService]!
|
A list of UserTermsOfService objects. |
edges - [UserTermsOfServicesEdge!]!
|
A list of edges which contains the UserTermsOfService and cursor to aid in pagination. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The count of all UserTermsOfService you could get from the connection. |
Example
{
"nodes": [UserTermsOfService],
"edges": [UserTermsOfServicesEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
UserTermsOfServicesEdge
Description
A UserTermsOfService edge in the connection.
Fields
| Field Name | Description |
|---|---|
cursor - Cursor
|
A cursor for use in pagination. |
node - UserTermsOfService
|
The UserTermsOfService at the end of the edge. |
Example
{
"cursor": Cursor,
"node": UserTermsOfService
}
UserTermsOfServicesOrderBy
Description
Methods to use when ordering UserTermsOfService.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NATURAL"
UserToManyAccountDocumentFilter
Description
A filter to be used against many AccountDocument object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - AccountDocumentFilter
|
Every related AccountDocument matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - AccountDocumentFilter
|
Some related AccountDocument matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - AccountDocumentFilter
|
No related AccountDocument matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": AccountDocumentFilter,
"some": AccountDocumentFilter,
"none": AccountDocumentFilter
}
UserToManyAccountRestrictionFilter
Description
A filter to be used against many AccountRestriction object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - AccountRestrictionFilter
|
Every related AccountRestriction matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - AccountRestrictionFilter
|
Some related AccountRestriction matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - AccountRestrictionFilter
|
No related AccountRestriction matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": AccountRestrictionFilter,
"some": AccountRestrictionFilter,
"none": AccountRestrictionFilter
}
UserToManyAllocationAnnotationFilter
Description
A filter to be used against many AllocationAnnotation object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - AllocationAnnotationFilter
|
Every related AllocationAnnotation matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - AllocationAnnotationFilter
|
Some related AllocationAnnotation matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - AllocationAnnotationFilter
|
No related AllocationAnnotation matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": AllocationAnnotationFilter,
"some": AllocationAnnotationFilter,
"none": AllocationAnnotationFilter
}
UserToManyAssetAnnotationFilter
Description
A filter to be used against many AssetAnnotation object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - AssetAnnotationFilter
|
Every related AssetAnnotation matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - AssetAnnotationFilter
|
Some related AssetAnnotation matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - AssetAnnotationFilter
|
No related AssetAnnotation matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": AssetAnnotationFilter,
"some": AssetAnnotationFilter,
"none": AssetAnnotationFilter
}
UserToManyBlockchainAddressSourceFilter
Description
A filter to be used against many BlockchainAddressSource object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - BlockchainAddressSourceFilter
|
Every related BlockchainAddressSource matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - BlockchainAddressSourceFilter
|
Some related BlockchainAddressSource matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - BlockchainAddressSourceFilter
|
No related BlockchainAddressSource matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": BlockchainAddressSourceFilter,
"some": BlockchainAddressSourceFilter,
"none": BlockchainAddressSourceFilter
}
UserToManyCustomerAddressFilter
Description
A filter to be used against many CustomerAddress object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - CustomerAddressFilter
|
Every related CustomerAddress matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - CustomerAddressFilter
|
Some related CustomerAddress matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - CustomerAddressFilter
|
No related CustomerAddress matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": CustomerAddressFilter,
"some": CustomerAddressFilter,
"none": CustomerAddressFilter
}
UserToManyCustomerPartyAddressFilter
Description
A filter to be used against many CustomerPartyAddress object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - CustomerPartyAddressFilter
|
Every related CustomerPartyAddress matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - CustomerPartyAddressFilter
|
Some related CustomerPartyAddress matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - CustomerPartyAddressFilter
|
No related CustomerPartyAddress matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": CustomerPartyAddressFilter,
"some": CustomerPartyAddressFilter,
"none": CustomerPartyAddressFilter
}
UserToManyCustomerPartyFilter
Description
A filter to be used against many CustomerParty object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - CustomerPartyFilter
|
Every related CustomerParty matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - CustomerPartyFilter
|
Some related CustomerParty matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - CustomerPartyFilter
|
No related CustomerParty matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": CustomerPartyFilter,
"some": CustomerPartyFilter,
"none": CustomerPartyFilter
}
UserToManyDistributionAnnotationFilter
Description
A filter to be used against many DistributionAnnotation object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - DistributionAnnotationFilter
|
Every related DistributionAnnotation matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - DistributionAnnotationFilter
|
Some related DistributionAnnotation matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - DistributionAnnotationFilter
|
No related DistributionAnnotation matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": DistributionAnnotationFilter,
"some": DistributionAnnotationFilter,
"none": DistributionAnnotationFilter
}
UserToManyDocumentSharingFilter
Description
A filter to be used against many DocumentSharing object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - DocumentSharingFilter
|
Every related DocumentSharing matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - DocumentSharingFilter
|
Some related DocumentSharing matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - DocumentSharingFilter
|
No related DocumentSharing matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": DocumentSharingFilter,
"some": DocumentSharingFilter,
"none": DocumentSharingFilter
}
UserToManyEmailFilter
Description
A filter to be used against many Email object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - EmailFilter
|
Every related Email matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - EmailFilter
|
Some related Email matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - EmailFilter
|
No related Email matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": EmailFilter,
"some": EmailFilter,
"none": EmailFilter
}
UserToManyIssuanceEventFilter
Description
A filter to be used against many IssuanceEvent object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - IssuanceEventFilter
|
Every related IssuanceEvent matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - IssuanceEventFilter
|
Some related IssuanceEvent matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - IssuanceEventFilter
|
No related IssuanceEvent matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": IssuanceEventFilter,
"some": IssuanceEventFilter,
"none": IssuanceEventFilter
}
UserToManyManagedAccountFilter
Description
A filter to be used against many ManagedAccount object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - ManagedAccountFilter
|
Every related ManagedAccount matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - ManagedAccountFilter
|
Some related ManagedAccount matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - ManagedAccountFilter
|
No related ManagedAccount matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": ManagedAccountFilter,
"some": ManagedAccountFilter,
"none": ManagedAccountFilter
}
UserToManyPartyFilter
Description
A filter to be used against many Party object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - PartyFilter
|
Every related Party matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - PartyFilter
|
Some related Party matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - PartyFilter
|
No related Party matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": PartyFilter,
"some": PartyFilter,
"none": PartyFilter
}
UserToManyTaRequestFilter
Description
A filter to be used against many TaRequest object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - TaRequestFilter
|
Every related TaRequest matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - TaRequestFilter
|
Some related TaRequest matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - TaRequestFilter
|
No related TaRequest matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": TaRequestFilter,
"some": TaRequestFilter,
"none": TaRequestFilter
}
UserToManyTransactionAnnotationFilter
Description
A filter to be used against many TransactionAnnotation object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - TransactionAnnotationFilter
|
Every related TransactionAnnotation matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - TransactionAnnotationFilter
|
Some related TransactionAnnotation matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - TransactionAnnotationFilter
|
No related TransactionAnnotation matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": TransactionAnnotationFilter,
"some": TransactionAnnotationFilter,
"none": TransactionAnnotationFilter
}
UserToManyUserTermsOfServiceFilter
Description
A filter to be used against many UserTermsOfService object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - UserTermsOfServiceFilter
|
Every related UserTermsOfService matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - UserTermsOfServiceFilter
|
Some related UserTermsOfService matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - UserTermsOfServiceFilter
|
No related UserTermsOfService matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": UserTermsOfServiceFilter,
"some": UserTermsOfServiceFilter,
"none": UserTermsOfServiceFilter
}
UserToManyUsersAccountFilter
Description
A filter to be used against many UsersAccount object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - UsersAccountFilter
|
Every related UsersAccount matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - UsersAccountFilter
|
Some related UsersAccount matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - UsersAccountFilter
|
No related UsersAccount matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": UsersAccountFilter,
"some": UsersAccountFilter,
"none": UsersAccountFilter
}
UsersAccount
Fields
| Field Name | Description |
|---|---|
nodeId - ID!
|
A globally unique identifier. Can be used in various places throughout the system to identify this single value. |
userId - UUID!
|
|
accountId - UUID!
|
|
role - String!
|
|
status - String!
|
|
id - UUID!
|
|
userByUserId - User
|
Reads a single User that is related to this UsersAccount. |
accountByAccountId - Account
|
Reads a single Account that is related to this UsersAccount. |
auxRoleByRole - AuxRole
|
Reads a single AuxRole that is related to this UsersAccount. |
userStatusByStatus - UserStatus
|
Reads a single UserStatus that is related to this UsersAccount. |
blockchainRegistrationsByUsersAccountId - BlockchainRegistrationsConnection!
|
Reads and enables pagination through a set of BlockchainRegistration. |
Arguments
|
|
Example
{
"nodeId": "4",
"userId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"role": "xyz789",
"status": "abc123",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"userByUserId": User,
"accountByAccountId": Account,
"auxRoleByRole": AuxRole,
"userStatusByStatus": UserStatus,
"blockchainRegistrationsByUsersAccountId": BlockchainRegistrationsConnection
}
UsersAccountCondition
Description
A condition to be used against UsersAccount object types. All fields are tested for equality and combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
userId - UUID
|
Checks for equality with the object’s userId field. |
accountId - UUID
|
Checks for equality with the object’s accountId field. |
role - String
|
Checks for equality with the object’s role field. |
status - String
|
Checks for equality with the object’s status field. |
id - UUID
|
Checks for equality with the object’s id field. |
Example
{
"userId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"role": "xyz789",
"status": "xyz789",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
UsersAccountFilter
Description
A filter to be used against UsersAccount object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
userId - UUIDFilter
|
Filter by the object’s userId field. |
accountId - UUIDFilter
|
Filter by the object’s accountId field. |
role - StringFilter
|
Filter by the object’s role field. |
status - StringFilter
|
Filter by the object’s status field. |
id - UUIDFilter
|
Filter by the object’s id field. |
blockchainRegistrationsByUsersAccountId - UsersAccountToManyBlockchainRegistrationFilter
|
Filter by the object’s blockchainRegistrationsByUsersAccountId relation. |
blockchainRegistrationsByUsersAccountIdExist - Boolean
|
Some related blockchainRegistrationsByUsersAccountId exist. |
userByUserId - UserFilter
|
Filter by the object’s userByUserId relation. |
accountByAccountId - AccountFilter
|
Filter by the object’s accountByAccountId relation. |
auxRoleByRole - AuxRoleFilter
|
Filter by the object’s auxRoleByRole relation. |
userStatusByStatus - UserStatusFilter
|
Filter by the object’s userStatusByStatus relation. |
and - [UsersAccountFilter!]
|
Checks for all expressions in this list. |
or - [UsersAccountFilter!]
|
Checks for any expressions in this list. |
not - UsersAccountFilter
|
Negates the expression. |
Example
{
"userId": UUIDFilter,
"accountId": UUIDFilter,
"role": StringFilter,
"status": StringFilter,
"id": UUIDFilter,
"blockchainRegistrationsByUsersAccountId": UsersAccountToManyBlockchainRegistrationFilter,
"blockchainRegistrationsByUsersAccountIdExist": true,
"userByUserId": UserFilter,
"accountByAccountId": AccountFilter,
"auxRoleByRole": AuxRoleFilter,
"userStatusByStatus": UserStatusFilter,
"and": [UsersAccountFilter],
"or": [UsersAccountFilter],
"not": UsersAccountFilter
}
UsersAccountPatch
Description
Represents an update to a UsersAccount. Fields that are set will be updated.
Example
{
"userId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"role": "xyz789",
"status": "xyz789",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
UsersAccountToManyBlockchainRegistrationFilter
Description
A filter to be used against many BlockchainRegistration object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - BlockchainRegistrationFilter
|
Every related BlockchainRegistration matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - BlockchainRegistrationFilter
|
Some related BlockchainRegistration matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - BlockchainRegistrationFilter
|
No related BlockchainRegistration matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": BlockchainRegistrationFilter,
"some": BlockchainRegistrationFilter,
"none": BlockchainRegistrationFilter
}
UsersAccountsConnection
Description
A connection to a list of UsersAccount values.
Fields
| Field Name | Description |
|---|---|
nodes - [UsersAccount]!
|
A list of UsersAccount objects. |
edges - [UsersAccountsEdge!]!
|
A list of edges which contains the UsersAccount and cursor to aid in pagination. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The count of all UsersAccount you could get from the connection. |
Example
{
"nodes": [UsersAccount],
"edges": [UsersAccountsEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
UsersAccountsEdge
Description
A UsersAccount edge in the connection.
Fields
| Field Name | Description |
|---|---|
cursor - Cursor
|
A cursor for use in pagination. |
node - UsersAccount
|
The UsersAccount at the end of the edge. |
Example
{
"cursor": Cursor,
"node": UsersAccount
}
UsersAccountsOrderBy
Description
Methods to use when ordering UsersAccount.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NATURAL"
UsersConnection
Description
A connection to a list of User values.
Fields
| Field Name | Description |
|---|---|
nodes - [User]!
|
A list of User objects. |
edges - [UsersEdge!]!
|
A list of edges which contains the User and cursor to aid in pagination. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The count of all User you could get from the connection. |
Example
{
"nodes": [User],
"edges": [UsersEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
UsersEdge
UsersOrderBy
Description
Methods to use when ordering User.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NATURAL"
VendorAgent
Fields
| Field Name | Description |
|---|---|
nodeId - ID!
|
A globally unique identifier. Can be used in various places throughout the system to identify this single value. |
id - UUID!
|
|
agentId - UUID!
|
|
vendorId - UUID!
|
|
status - String!
|
|
name - String!
|
|
accountByAgentId - Account
|
Reads a single Account that is related to this VendorAgent. |
accountByVendorId - Account
|
Reads a single Account that is related to this VendorAgent. |
invitationStatusByStatus - InvitationStatus
|
Reads a single InvitationStatus that is related to this VendorAgent. |
Example
{
"nodeId": 4,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"agentId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"vendorId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"status": "xyz789",
"name": "xyz789",
"accountByAgentId": Account,
"accountByVendorId": Account,
"invitationStatusByStatus": InvitationStatus
}
VendorAgentCondition
Description
A condition to be used against VendorAgent object types. All fields are tested for equality and combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
id - UUID
|
Checks for equality with the object’s id field. |
agentId - UUID
|
Checks for equality with the object’s agentId field. |
vendorId - UUID
|
Checks for equality with the object’s vendorId field. |
status - String
|
Checks for equality with the object’s status field. |
name - String
|
Checks for equality with the object’s name field. |
Example
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"agentId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"vendorId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"status": "abc123",
"name": "abc123"
}
VendorAgentFilter
Description
A filter to be used against VendorAgent object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
id - UUIDFilter
|
Filter by the object’s id field. |
agentId - UUIDFilter
|
Filter by the object’s agentId field. |
vendorId - UUIDFilter
|
Filter by the object’s vendorId field. |
status - StringFilter
|
Filter by the object’s status field. |
name - StringFilter
|
Filter by the object’s name field. |
accountByAgentId - AccountFilter
|
Filter by the object’s accountByAgentId relation. |
accountByVendorId - AccountFilter
|
Filter by the object’s accountByVendorId relation. |
invitationStatusByStatus - InvitationStatusFilter
|
Filter by the object’s invitationStatusByStatus relation. |
and - [VendorAgentFilter!]
|
Checks for all expressions in this list. |
or - [VendorAgentFilter!]
|
Checks for any expressions in this list. |
not - VendorAgentFilter
|
Negates the expression. |
Example
{
"id": UUIDFilter,
"agentId": UUIDFilter,
"vendorId": UUIDFilter,
"status": StringFilter,
"name": StringFilter,
"accountByAgentId": AccountFilter,
"accountByVendorId": AccountFilter,
"invitationStatusByStatus": InvitationStatusFilter,
"and": [VendorAgentFilter],
"or": [VendorAgentFilter],
"not": VendorAgentFilter
}
VendorAgentPatch
Description
Represents an update to a VendorAgent. Fields that are set will be updated.
Example
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"agentId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"vendorId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"status": "abc123",
"name": "abc123"
}
VendorAgentsConnection
Description
A connection to a list of VendorAgent values.
Fields
| Field Name | Description |
|---|---|
nodes - [VendorAgent]!
|
A list of VendorAgent objects. |
edges - [VendorAgentsEdge!]!
|
A list of edges which contains the VendorAgent and cursor to aid in pagination. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The count of all VendorAgent you could get from the connection. |
Example
{
"nodes": [VendorAgent],
"edges": [VendorAgentsEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
VendorAgentsEdge
Description
A VendorAgent edge in the connection.
Fields
| Field Name | Description |
|---|---|
cursor - Cursor
|
A cursor for use in pagination. |
node - VendorAgent
|
The VendorAgent at the end of the edge. |
Example
{
"cursor": Cursor,
"node": VendorAgent
}
VendorAgentsOrderBy
Description
Methods to use when ordering VendorAgent.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NATURAL"
VendorDefaultEmailPreference
Description
This table is an MVP way to set the default for allocation_email_preferences, will be replaced with full email preferences at some point.
Fields
| Field Name | Description |
|---|---|
nodeId - ID!
|
A globally unique identifier. Can be used in various places throughout the system to identify this single value. |
id - UUID!
|
|
accountId - UUID!
|
|
sendDistribution - Boolean!
|
|
accountByAccountId - Account
|
Reads a single Account that is related to this VendorDefaultEmailPreference. |
Example
{
"nodeId": "4",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"sendDistribution": false,
"accountByAccountId": Account
}
VendorDefaultEmailPreferenceCondition
Description
A condition to be used against VendorDefaultEmailPreference object types. All fields are tested for equality and combined with a logical ‘and.’
Example
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"sendDistribution": true
}
VendorDefaultEmailPreferenceFilter
Description
A filter to be used against VendorDefaultEmailPreference object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
id - UUIDFilter
|
Filter by the object’s id field. |
accountId - UUIDFilter
|
Filter by the object’s accountId field. |
sendDistribution - BooleanFilter
|
Filter by the object’s sendDistribution field. |
accountByAccountId - AccountFilter
|
Filter by the object’s accountByAccountId relation. |
and - [VendorDefaultEmailPreferenceFilter!]
|
Checks for all expressions in this list. |
or - [VendorDefaultEmailPreferenceFilter!]
|
Checks for any expressions in this list. |
not - VendorDefaultEmailPreferenceFilter
|
Negates the expression. |
Example
{
"id": UUIDFilter,
"accountId": UUIDFilter,
"sendDistribution": BooleanFilter,
"accountByAccountId": AccountFilter,
"and": [VendorDefaultEmailPreferenceFilter],
"or": [VendorDefaultEmailPreferenceFilter],
"not": VendorDefaultEmailPreferenceFilter
}
VendorDefaultEmailPreferencePatch
Description
Represents an update to a VendorDefaultEmailPreference. Fields that are set will be updated.
Example
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"sendDistribution": true
}
VendorDefaultEmailPreferencesConnection
Description
A connection to a list of VendorDefaultEmailPreference values.
Fields
| Field Name | Description |
|---|---|
nodes - [VendorDefaultEmailPreference]!
|
A list of VendorDefaultEmailPreference objects. |
edges - [VendorDefaultEmailPreferencesEdge!]!
|
A list of edges which contains the VendorDefaultEmailPreference and cursor to aid in pagination. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The count of all VendorDefaultEmailPreference you could get from the connection. |
Example
{
"nodes": [VendorDefaultEmailPreference],
"edges": [VendorDefaultEmailPreferencesEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
VendorDefaultEmailPreferencesEdge
Description
A VendorDefaultEmailPreference edge in the connection.
Fields
| Field Name | Description |
|---|---|
cursor - Cursor
|
A cursor for use in pagination. |
node - VendorDefaultEmailPreference
|
The VendorDefaultEmailPreference at the end of the edge. |
Example
{
"cursor": Cursor,
"node": VendorDefaultEmailPreference
}
VendorDefaultEmailPreferencesOrderBy
Description
Methods to use when ordering VendorDefaultEmailPreference.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NATURAL"
VendorIntegrationStatus
VendorIntegrationStatusCondition
Description
A condition to be used against VendorIntegrationStatus object types. All fields are tested for equality and combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
status - String
|
Checks for equality with the object’s status field. |
Example
{"status": "xyz789"}
VendorIntegrationStatusFilter
Description
A filter to be used against VendorIntegrationStatus object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
status - StringFilter
|
Filter by the object’s status field. |
and - [VendorIntegrationStatusFilter!]
|
Checks for all expressions in this list. |
or - [VendorIntegrationStatusFilter!]
|
Checks for any expressions in this list. |
not - VendorIntegrationStatusFilter
|
Negates the expression. |
Example
{
"status": StringFilter,
"and": [VendorIntegrationStatusFilter],
"or": [VendorIntegrationStatusFilter],
"not": VendorIntegrationStatusFilter
}
VendorIntegrationStatusInput
Description
An input for mutations affecting VendorIntegrationStatus
Fields
| Input Field | Description |
|---|---|
status - String!
|
Example
{"status": "abc123"}
VendorIntegrationStatusPatch
Description
Represents an update to a VendorIntegrationStatus. Fields that are set will be updated.
Fields
| Input Field | Description |
|---|---|
status - String
|
Example
{"status": "abc123"}
VendorIntegrationStatusesConnection
Description
A connection to a list of VendorIntegrationStatus values.
Fields
| Field Name | Description |
|---|---|
nodes - [VendorIntegrationStatus]!
|
A list of VendorIntegrationStatus objects. |
edges - [VendorIntegrationStatusesEdge!]!
|
A list of edges which contains the VendorIntegrationStatus and cursor to aid in pagination. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The count of all VendorIntegrationStatus you could get from the connection. |
Example
{
"nodes": [VendorIntegrationStatus],
"edges": [VendorIntegrationStatusesEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
VendorIntegrationStatusesEdge
Description
A VendorIntegrationStatus edge in the connection.
Fields
| Field Name | Description |
|---|---|
cursor - Cursor
|
A cursor for use in pagination. |
node - VendorIntegrationStatus
|
The VendorIntegrationStatus at the end of the edge. |
Example
{
"cursor": Cursor,
"node": VendorIntegrationStatus
}
VendorIntegrationStatusesOrderBy
Description
Methods to use when ordering VendorIntegrationStatus.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NATURAL"
VendorQualification
Fields
| Field Name | Description |
|---|---|
nodeId - ID!
|
A globally unique identifier. Can be used in various places throughout the system to identify this single value. |
id - UUID!
|
|
accountId - UUID!
|
|
integrationId - UUID!
|
|
name - String
|
|
active - Boolean!
|
|
constrained - Boolean!
|
|
stepType - String
|
|
accountByAccountId - Account
|
Reads a single Account that is related to this VendorQualification. |
integrationByIntegrationId - Integration
|
Reads a single Integration that is related to this VendorQualification. |
vendorQualificationStepTypeByStepType - VendorQualificationStepType
|
Reads a single VendorQualificationStepType that is related to this VendorQualification. |
distributionQualificationsByVendorQualificationId - DistributionQualificationsConnection!
|
Reads and enables pagination through a set of DistributionQualification. |
Arguments
|
|
allocationQualificationsByVendorQualificationId - AllocationQualificationsConnection!
|
Reads and enables pagination through a set of AllocationQualification. |
Arguments
|
|
mappedSigningTemplateByVendorQualificationId - MappedSigningTemplate
|
Reads a single MappedSigningTemplate that is related to this VendorQualification. |
mappedSigningTemplatesByVendorQualificationId - MappedSigningTemplatesConnection!
|
Reads and enables pagination through a set of MappedSigningTemplate. Please use mappedSigningTemplateByVendorQualificationId instead
|
Arguments
|
|
onboardingQuestionSetByVendorQualificationId - OnboardingQuestionSet
|
Reads a single OnboardingQuestionSet that is related to this VendorQualification. |
onboardingQuestionSetsByVendorQualificationId - OnboardingQuestionSetsConnection!
|
Reads and enables pagination through a set of OnboardingQuestionSet. Please use onboardingQuestionSetByVendorQualificationId instead
|
Arguments
|
|
paymentInstrumentsByVendorQualificationId - PaymentInstrumentsConnection!
|
Reads and enables pagination through a set of PaymentInstrument. |
Arguments
|
|
vendorQualificationConstraintsByVendorQualificationId - VendorQualificationConstraintsConnection!
|
Reads and enables pagination through a set of VendorQualificationConstraint. |
Arguments
|
|
Example
{
"nodeId": "4",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"integrationId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"name": "abc123",
"active": true,
"constrained": false,
"stepType": "abc123",
"accountByAccountId": Account,
"integrationByIntegrationId": Integration,
"vendorQualificationStepTypeByStepType": VendorQualificationStepType,
"distributionQualificationsByVendorQualificationId": DistributionQualificationsConnection,
"allocationQualificationsByVendorQualificationId": AllocationQualificationsConnection,
"mappedSigningTemplateByVendorQualificationId": MappedSigningTemplate,
"mappedSigningTemplatesByVendorQualificationId": MappedSigningTemplatesConnection,
"onboardingQuestionSetByVendorQualificationId": OnboardingQuestionSet,
"onboardingQuestionSetsByVendorQualificationId": OnboardingQuestionSetsConnection,
"paymentInstrumentsByVendorQualificationId": PaymentInstrumentsConnection,
"vendorQualificationConstraintsByVendorQualificationId": VendorQualificationConstraintsConnection
}
VendorQualificationCondition
Description
A condition to be used against VendorQualification object types. All fields are tested for equality and combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
id - UUID
|
Checks for equality with the object’s id field. |
accountId - UUID
|
Checks for equality with the object’s accountId field. |
integrationId - UUID
|
Checks for equality with the object’s integrationId field. |
name - String
|
Checks for equality with the object’s name field. |
active - Boolean
|
Checks for equality with the object’s active field. |
constrained - Boolean
|
Checks for equality with the object’s constrained field. |
stepType - String
|
Checks for equality with the object’s stepType field. |
Example
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"integrationId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"name": "xyz789",
"active": false,
"constrained": true,
"stepType": "xyz789"
}
VendorQualificationConstraint
Fields
| Field Name | Description |
|---|---|
nodeId - ID!
|
A globally unique identifier. Can be used in various places throughout the system to identify this single value. |
id - UUID!
|
|
vendorQualificationId - UUID!
|
|
roundId - UUID!
|
|
vendorQualificationByVendorQualificationId - VendorQualification
|
Reads a single VendorQualification that is related to this VendorQualificationConstraint. |
roundByRoundId - Round
|
Reads a single Round that is related to this VendorQualificationConstraint. |
Example
{
"nodeId": "4",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"vendorQualificationId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"roundId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"vendorQualificationByVendorQualificationId": VendorQualification,
"roundByRoundId": Round
}
VendorQualificationConstraintCondition
Description
A condition to be used against VendorQualificationConstraint object types. All fields are tested for equality and combined with a logical ‘and.’
Example
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"vendorQualificationId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"roundId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
VendorQualificationConstraintFilter
Description
A filter to be used against VendorQualificationConstraint object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
id - UUIDFilter
|
Filter by the object’s id field. |
vendorQualificationId - UUIDFilter
|
Filter by the object’s vendorQualificationId field. |
roundId - UUIDFilter
|
Filter by the object’s roundId field. |
vendorQualificationByVendorQualificationId - VendorQualificationFilter
|
Filter by the object’s vendorQualificationByVendorQualificationId relation. |
roundByRoundId - RoundFilter
|
Filter by the object’s roundByRoundId relation. |
and - [VendorQualificationConstraintFilter!]
|
Checks for all expressions in this list. |
or - [VendorQualificationConstraintFilter!]
|
Checks for any expressions in this list. |
not - VendorQualificationConstraintFilter
|
Negates the expression. |
Example
{
"id": UUIDFilter,
"vendorQualificationId": UUIDFilter,
"roundId": UUIDFilter,
"vendorQualificationByVendorQualificationId": VendorQualificationFilter,
"roundByRoundId": RoundFilter,
"and": [VendorQualificationConstraintFilter],
"or": [VendorQualificationConstraintFilter],
"not": VendorQualificationConstraintFilter
}
VendorQualificationConstraintsConnection
Description
A connection to a list of VendorQualificationConstraint values.
Fields
| Field Name | Description |
|---|---|
nodes - [VendorQualificationConstraint]!
|
A list of VendorQualificationConstraint objects. |
edges - [VendorQualificationConstraintsEdge!]!
|
A list of edges which contains the VendorQualificationConstraint and cursor to aid in pagination. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The count of all VendorQualificationConstraint you could get from the connection. |
Example
{
"nodes": [VendorQualificationConstraint],
"edges": [VendorQualificationConstraintsEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
VendorQualificationConstraintsEdge
Description
A VendorQualificationConstraint edge in the connection.
Fields
| Field Name | Description |
|---|---|
cursor - Cursor
|
A cursor for use in pagination. |
node - VendorQualificationConstraint
|
The VendorQualificationConstraint at the end of the edge. |
Example
{
"cursor": Cursor,
"node": VendorQualificationConstraint
}
VendorQualificationConstraintsOrderBy
Description
Methods to use when ordering VendorQualificationConstraint.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NATURAL"
VendorQualificationFilter
Description
A filter to be used against VendorQualification object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
id - UUIDFilter
|
Filter by the object’s id field. |
accountId - UUIDFilter
|
Filter by the object’s accountId field. |
integrationId - UUIDFilter
|
Filter by the object’s integrationId field. |
name - StringFilter
|
Filter by the object’s name field. |
active - BooleanFilter
|
Filter by the object’s active field. |
constrained - BooleanFilter
|
Filter by the object’s constrained field. |
stepType - StringFilter
|
Filter by the object’s stepType field. |
distributionQualificationsByVendorQualificationId - VendorQualificationToManyDistributionQualificationFilter
|
Filter by the object’s distributionQualificationsByVendorQualificationId relation. |
distributionQualificationsByVendorQualificationIdExist - Boolean
|
Some related distributionQualificationsByVendorQualificationId exist. |
allocationQualificationsByVendorQualificationId - VendorQualificationToManyAllocationQualificationFilter
|
Filter by the object’s allocationQualificationsByVendorQualificationId relation. |
allocationQualificationsByVendorQualificationIdExist - Boolean
|
Some related allocationQualificationsByVendorQualificationId exist. |
mappedSigningTemplateByVendorQualificationId - MappedSigningTemplateFilter
|
Filter by the object’s mappedSigningTemplateByVendorQualificationId relation. |
mappedSigningTemplateByVendorQualificationIdExists - Boolean
|
A related mappedSigningTemplateByVendorQualificationId exists. |
onboardingQuestionSetByVendorQualificationId - OnboardingQuestionSetFilter
|
Filter by the object’s onboardingQuestionSetByVendorQualificationId relation. |
onboardingQuestionSetByVendorQualificationIdExists - Boolean
|
A related onboardingQuestionSetByVendorQualificationId exists. |
paymentInstrumentsByVendorQualificationId - VendorQualificationToManyPaymentInstrumentFilter
|
Filter by the object’s paymentInstrumentsByVendorQualificationId relation. |
paymentInstrumentsByVendorQualificationIdExist - Boolean
|
Some related paymentInstrumentsByVendorQualificationId exist. |
vendorQualificationConstraintsByVendorQualificationId - VendorQualificationToManyVendorQualificationConstraintFilter
|
Filter by the object’s vendorQualificationConstraintsByVendorQualificationId relation. |
vendorQualificationConstraintsByVendorQualificationIdExist - Boolean
|
Some related vendorQualificationConstraintsByVendorQualificationId exist. |
accountByAccountId - AccountFilter
|
Filter by the object’s accountByAccountId relation. |
integrationByIntegrationId - IntegrationFilter
|
Filter by the object’s integrationByIntegrationId relation. |
vendorQualificationStepTypeByStepType - VendorQualificationStepTypeFilter
|
Filter by the object’s vendorQualificationStepTypeByStepType relation. |
vendorQualificationStepTypeByStepTypeExists - Boolean
|
A related vendorQualificationStepTypeByStepType exists. |
and - [VendorQualificationFilter!]
|
Checks for all expressions in this list. |
or - [VendorQualificationFilter!]
|
Checks for any expressions in this list. |
not - VendorQualificationFilter
|
Negates the expression. |
Example
{
"id": UUIDFilter,
"accountId": UUIDFilter,
"integrationId": UUIDFilter,
"name": StringFilter,
"active": BooleanFilter,
"constrained": BooleanFilter,
"stepType": StringFilter,
"distributionQualificationsByVendorQualificationId": VendorQualificationToManyDistributionQualificationFilter,
"distributionQualificationsByVendorQualificationIdExist": false,
"allocationQualificationsByVendorQualificationId": VendorQualificationToManyAllocationQualificationFilter,
"allocationQualificationsByVendorQualificationIdExist": true,
"mappedSigningTemplateByVendorQualificationId": MappedSigningTemplateFilter,
"mappedSigningTemplateByVendorQualificationIdExists": false,
"onboardingQuestionSetByVendorQualificationId": OnboardingQuestionSetFilter,
"onboardingQuestionSetByVendorQualificationIdExists": true,
"paymentInstrumentsByVendorQualificationId": VendorQualificationToManyPaymentInstrumentFilter,
"paymentInstrumentsByVendorQualificationIdExist": false,
"vendorQualificationConstraintsByVendorQualificationId": VendorQualificationToManyVendorQualificationConstraintFilter,
"vendorQualificationConstraintsByVendorQualificationIdExist": true,
"accountByAccountId": AccountFilter,
"integrationByIntegrationId": IntegrationFilter,
"vendorQualificationStepTypeByStepType": VendorQualificationStepTypeFilter,
"vendorQualificationStepTypeByStepTypeExists": false,
"and": [VendorQualificationFilter],
"or": [VendorQualificationFilter],
"not": VendorQualificationFilter
}
VendorQualificationStepType
Fields
| Field Name | Description |
|---|---|
nodeId - ID!
|
A globally unique identifier. Can be used in various places throughout the system to identify this single value. |
type - String!
|
|
vendorQualificationsByStepType - VendorQualificationsConnection!
|
Reads and enables pagination through a set of VendorQualification. |
Arguments
|
|
Example
{
"nodeId": 4,
"type": "abc123",
"vendorQualificationsByStepType": VendorQualificationsConnection
}
VendorQualificationStepTypeCondition
Description
A condition to be used against VendorQualificationStepType object types. All fields are tested for equality and combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
type - String
|
Checks for equality with the object’s type field. |
Example
{"type": "abc123"}
VendorQualificationStepTypeFilter
Description
A filter to be used against VendorQualificationStepType object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
type - StringFilter
|
Filter by the object’s type field. |
vendorQualificationsByStepType - VendorQualificationStepTypeToManyVendorQualificationFilter
|
Filter by the object’s vendorQualificationsByStepType relation. |
vendorQualificationsByStepTypeExist - Boolean
|
Some related vendorQualificationsByStepType exist. |
and - [VendorQualificationStepTypeFilter!]
|
Checks for all expressions in this list. |
or - [VendorQualificationStepTypeFilter!]
|
Checks for any expressions in this list. |
not - VendorQualificationStepTypeFilter
|
Negates the expression. |
Example
{
"type": StringFilter,
"vendorQualificationsByStepType": VendorQualificationStepTypeToManyVendorQualificationFilter,
"vendorQualificationsByStepTypeExist": true,
"and": [VendorQualificationStepTypeFilter],
"or": [VendorQualificationStepTypeFilter],
"not": VendorQualificationStepTypeFilter
}
VendorQualificationStepTypeToManyVendorQualificationFilter
Description
A filter to be used against many VendorQualification object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - VendorQualificationFilter
|
Every related VendorQualification matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - VendorQualificationFilter
|
Some related VendorQualification matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - VendorQualificationFilter
|
No related VendorQualification matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": VendorQualificationFilter,
"some": VendorQualificationFilter,
"none": VendorQualificationFilter
}
VendorQualificationStepTypesConnection
Description
A connection to a list of VendorQualificationStepType values.
Fields
| Field Name | Description |
|---|---|
nodes - [VendorQualificationStepType]!
|
A list of VendorQualificationStepType objects. |
edges - [VendorQualificationStepTypesEdge!]!
|
A list of edges which contains the VendorQualificationStepType and cursor to aid in pagination. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The count of all VendorQualificationStepType you could get from the connection. |
Example
{
"nodes": [VendorQualificationStepType],
"edges": [VendorQualificationStepTypesEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
VendorQualificationStepTypesEdge
Description
A VendorQualificationStepType edge in the connection.
Fields
| Field Name | Description |
|---|---|
cursor - Cursor
|
A cursor for use in pagination. |
node - VendorQualificationStepType
|
The VendorQualificationStepType at the end of the edge. |
Example
{
"cursor": Cursor,
"node": VendorQualificationStepType
}
VendorQualificationStepTypesOrderBy
Description
Methods to use when ordering VendorQualificationStepType.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NATURAL"
VendorQualificationToManyAllocationQualificationFilter
Description
A filter to be used against many AllocationQualification object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - AllocationQualificationFilter
|
Every related AllocationQualification matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - AllocationQualificationFilter
|
Some related AllocationQualification matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - AllocationQualificationFilter
|
No related AllocationQualification matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": AllocationQualificationFilter,
"some": AllocationQualificationFilter,
"none": AllocationQualificationFilter
}
VendorQualificationToManyDistributionQualificationFilter
Description
A filter to be used against many DistributionQualification object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - DistributionQualificationFilter
|
Every related DistributionQualification matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - DistributionQualificationFilter
|
Some related DistributionQualification matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - DistributionQualificationFilter
|
No related DistributionQualification matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": DistributionQualificationFilter,
"some": DistributionQualificationFilter,
"none": DistributionQualificationFilter
}
VendorQualificationToManyPaymentInstrumentFilter
Description
A filter to be used against many PaymentInstrument object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - PaymentInstrumentFilter
|
Every related PaymentInstrument matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - PaymentInstrumentFilter
|
Some related PaymentInstrument matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - PaymentInstrumentFilter
|
No related PaymentInstrument matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": PaymentInstrumentFilter,
"some": PaymentInstrumentFilter,
"none": PaymentInstrumentFilter
}
VendorQualificationToManyVendorQualificationConstraintFilter
Description
A filter to be used against many VendorQualificationConstraint object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - VendorQualificationConstraintFilter
|
Every related VendorQualificationConstraint matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - VendorQualificationConstraintFilter
|
Some related VendorQualificationConstraint matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - VendorQualificationConstraintFilter
|
No related VendorQualificationConstraint matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": VendorQualificationConstraintFilter,
"some": VendorQualificationConstraintFilter,
"none": VendorQualificationConstraintFilter
}
VendorQualificationsConnection
Description
A connection to a list of VendorQualification values.
Fields
| Field Name | Description |
|---|---|
nodes - [VendorQualification]!
|
A list of VendorQualification objects. |
edges - [VendorQualificationsEdge!]!
|
A list of edges which contains the VendorQualification and cursor to aid in pagination. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The count of all VendorQualification you could get from the connection. |
Example
{
"nodes": [VendorQualification],
"edges": [VendorQualificationsEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
VendorQualificationsEdge
Description
A VendorQualification edge in the connection.
Fields
| Field Name | Description |
|---|---|
cursor - Cursor
|
A cursor for use in pagination. |
node - VendorQualification
|
The VendorQualification at the end of the edge. |
Example
{
"cursor": Cursor,
"node": VendorQualification
}
VendorQualificationsOrderBy
Description
Methods to use when ordering VendorQualification.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NATURAL"
VestingDuration
Fields
| Field Name | Description |
|---|---|
nodeId - ID!
|
A globally unique identifier. Can be used in various places throughout the system to identify this single value. |
duration - String!
|
|
vestingSchedulesByDuration - VestingSchedulesConnection!
|
Reads and enables pagination through a set of VestingSchedule. |
Arguments
|
|
allocationsVestingSchedulesByDuration - AllocationsVestingSchedulesConnection!
|
Reads and enables pagination through a set of AllocationsVestingSchedule. |
Arguments
|
|
Example
{
"nodeId": "4",
"duration": "xyz789",
"vestingSchedulesByDuration": VestingSchedulesConnection,
"allocationsVestingSchedulesByDuration": AllocationsVestingSchedulesConnection
}
VestingDurationCondition
Description
A condition to be used against VestingDuration object types. All fields are tested for equality and combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
duration - String
|
Checks for equality with the object’s duration field. |
Example
{"duration": "xyz789"}
VestingDurationFilter
Description
A filter to be used against VestingDuration object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
duration - StringFilter
|
Filter by the object’s duration field. |
vestingSchedulesByDuration - VestingDurationToManyVestingScheduleFilter
|
Filter by the object’s vestingSchedulesByDuration relation. |
vestingSchedulesByDurationExist - Boolean
|
Some related vestingSchedulesByDuration exist. |
allocationsVestingSchedulesByDuration - VestingDurationToManyAllocationsVestingScheduleFilter
|
Filter by the object’s allocationsVestingSchedulesByDuration relation. |
allocationsVestingSchedulesByDurationExist - Boolean
|
Some related allocationsVestingSchedulesByDuration exist. |
and - [VestingDurationFilter!]
|
Checks for all expressions in this list. |
or - [VestingDurationFilter!]
|
Checks for any expressions in this list. |
not - VestingDurationFilter
|
Negates the expression. |
Example
{
"duration": StringFilter,
"vestingSchedulesByDuration": VestingDurationToManyVestingScheduleFilter,
"vestingSchedulesByDurationExist": true,
"allocationsVestingSchedulesByDuration": VestingDurationToManyAllocationsVestingScheduleFilter,
"allocationsVestingSchedulesByDurationExist": true,
"and": [VestingDurationFilter],
"or": [VestingDurationFilter],
"not": VestingDurationFilter
}
VestingDurationToManyAllocationsVestingScheduleFilter
Description
A filter to be used against many AllocationsVestingSchedule object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - AllocationsVestingScheduleFilter
|
Every related AllocationsVestingSchedule matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - AllocationsVestingScheduleFilter
|
Some related AllocationsVestingSchedule matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - AllocationsVestingScheduleFilter
|
No related AllocationsVestingSchedule matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": AllocationsVestingScheduleFilter,
"some": AllocationsVestingScheduleFilter,
"none": AllocationsVestingScheduleFilter
}
VestingDurationToManyVestingScheduleFilter
Description
A filter to be used against many VestingSchedule object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - VestingScheduleFilter
|
Every related VestingSchedule matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - VestingScheduleFilter
|
Some related VestingSchedule matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - VestingScheduleFilter
|
No related VestingSchedule matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": VestingScheduleFilter,
"some": VestingScheduleFilter,
"none": VestingScheduleFilter
}
VestingDurationsConnection
Description
A connection to a list of VestingDuration values.
Fields
| Field Name | Description |
|---|---|
nodes - [VestingDuration]!
|
A list of VestingDuration objects. |
edges - [VestingDurationsEdge!]!
|
A list of edges which contains the VestingDuration and cursor to aid in pagination. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The count of all VestingDuration you could get from the connection. |
Example
{
"nodes": [VestingDuration],
"edges": [VestingDurationsEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
VestingDurationsEdge
Description
A VestingDuration edge in the connection.
Fields
| Field Name | Description |
|---|---|
cursor - Cursor
|
A cursor for use in pagination. |
node - VestingDuration
|
The VestingDuration at the end of the edge. |
Example
{
"cursor": Cursor,
"node": VestingDuration
}
VestingDurationsOrderBy
Description
Methods to use when ordering VestingDuration.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NATURAL"
VestingEvent
Fields
| Field Name | Description |
|---|---|
nodeId - ID!
|
A globally unique identifier. Can be used in various places throughout the system to identify this single value. |
vestingScheduleId - UUID!
|
|
transactionId - String!
|
|
startPeriod - Int!
|
|
endPeriod - Int!
|
|
id - UUID!
|
|
vestingScheduleByVestingScheduleId - VestingSchedule
|
Reads a single VestingSchedule that is related to this VestingEvent. |
transactionByTransactionId - Transaction
|
Reads a single Transaction that is related to this VestingEvent. |
Example
{
"nodeId": "4",
"vestingScheduleId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"transactionId": "abc123",
"startPeriod": 987,
"endPeriod": 987,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"vestingScheduleByVestingScheduleId": VestingSchedule,
"transactionByTransactionId": Transaction
}
VestingEventCondition
Description
A condition to be used against VestingEvent object types. All fields are tested for equality and combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
vestingScheduleId - UUID
|
Checks for equality with the object’s vestingScheduleId field. |
transactionId - String
|
Checks for equality with the object’s transactionId field. |
startPeriod - Int
|
Checks for equality with the object’s startPeriod field. |
endPeriod - Int
|
Checks for equality with the object’s endPeriod field. |
id - UUID
|
Checks for equality with the object’s id field. |
Example
{
"vestingScheduleId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"transactionId": "xyz789",
"startPeriod": 123,
"endPeriod": 123,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
VestingEventFilter
Description
A filter to be used against VestingEvent object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
vestingScheduleId - UUIDFilter
|
Filter by the object’s vestingScheduleId field. |
transactionId - StringFilter
|
Filter by the object’s transactionId field. |
startPeriod - IntFilter
|
Filter by the object’s startPeriod field. |
endPeriod - IntFilter
|
Filter by the object’s endPeriod field. |
id - UUIDFilter
|
Filter by the object’s id field. |
vestingScheduleByVestingScheduleId - VestingScheduleFilter
|
Filter by the object’s vestingScheduleByVestingScheduleId relation. |
transactionByTransactionId - TransactionFilter
|
Filter by the object’s transactionByTransactionId relation. |
and - [VestingEventFilter!]
|
Checks for all expressions in this list. |
or - [VestingEventFilter!]
|
Checks for any expressions in this list. |
not - VestingEventFilter
|
Negates the expression. |
Example
{
"vestingScheduleId": UUIDFilter,
"transactionId": StringFilter,
"startPeriod": IntFilter,
"endPeriod": IntFilter,
"id": UUIDFilter,
"vestingScheduleByVestingScheduleId": VestingScheduleFilter,
"transactionByTransactionId": TransactionFilter,
"and": [VestingEventFilter],
"or": [VestingEventFilter],
"not": VestingEventFilter
}
VestingEventInput
Description
An input for mutations affecting VestingEvent
Example
{
"vestingScheduleId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"transactionId": "abc123",
"startPeriod": 123,
"endPeriod": 987,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
VestingEventPatch
Description
Represents an update to a VestingEvent. Fields that are set will be updated.
Example
{
"vestingScheduleId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"transactionId": "xyz789",
"startPeriod": 123,
"endPeriod": 123,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
VestingEventsConnection
Description
A connection to a list of VestingEvent values.
Fields
| Field Name | Description |
|---|---|
nodes - [VestingEvent]!
|
A list of VestingEvent objects. |
edges - [VestingEventsEdge!]!
|
A list of edges which contains the VestingEvent and cursor to aid in pagination. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The count of all VestingEvent you could get from the connection. |
Example
{
"nodes": [VestingEvent],
"edges": [VestingEventsEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
VestingEventsEdge
Description
A VestingEvent edge in the connection.
Fields
| Field Name | Description |
|---|---|
cursor - Cursor
|
A cursor for use in pagination. |
node - VestingEvent
|
The VestingEvent at the end of the edge. |
Example
{
"cursor": Cursor,
"node": VestingEvent
}
VestingEventsOrderBy
Description
Methods to use when ordering VestingEvent.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NATURAL"
VestingSchedule
Fields
| Field Name | Description |
|---|---|
nodeId - ID!
|
A globally unique identifier. Can be used in various places throughout the system to identify this single value. |
distributionId - UUID!
|
|
duration - String!
|
|
cliff - Int!
|
|
periods - Int!
|
|
startsOn - Datetime!
|
|
currentPeriod - Int!
|
|
automatic - Boolean
|
|
id - UUID!
|
|
distributionByDistributionId - Distribution
|
Reads a single Distribution that is related to this VestingSchedule. |
vestingDurationByDuration - VestingDuration
|
Reads a single VestingDuration that is related to this VestingSchedule. |
vestingEventsByVestingScheduleId - VestingEventsConnection!
|
Reads and enables pagination through a set of VestingEvent. |
Arguments
|
|
Example
{
"nodeId": "4",
"distributionId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"duration": "abc123",
"cliff": 987,
"periods": 987,
"startsOn": Datetime,
"currentPeriod": 123,
"automatic": true,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"distributionByDistributionId": Distribution,
"vestingDurationByDuration": VestingDuration,
"vestingEventsByVestingScheduleId": VestingEventsConnection
}
VestingScheduleCondition
Description
A condition to be used against VestingSchedule object types. All fields are tested for equality and combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
distributionId - UUID
|
Checks for equality with the object’s distributionId field. |
duration - String
|
Checks for equality with the object’s duration field. |
cliff - Int
|
Checks for equality with the object’s cliff field. |
periods - Int
|
Checks for equality with the object’s periods field. |
startsOn - Datetime
|
Checks for equality with the object’s startsOn field. |
currentPeriod - Int
|
Checks for equality with the object’s currentPeriod field. |
automatic - Boolean
|
Checks for equality with the object’s automatic field. |
id - UUID
|
Checks for equality with the object’s id field. |
Example
{
"distributionId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"duration": "abc123",
"cliff": 987,
"periods": 123,
"startsOn": Datetime,
"currentPeriod": 987,
"automatic": true,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
VestingScheduleFilter
Description
A filter to be used against VestingSchedule object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
distributionId - UUIDFilter
|
Filter by the object’s distributionId field. |
duration - StringFilter
|
Filter by the object’s duration field. |
cliff - IntFilter
|
Filter by the object’s cliff field. |
periods - IntFilter
|
Filter by the object’s periods field. |
startsOn - DatetimeFilter
|
Filter by the object’s startsOn field. |
currentPeriod - IntFilter
|
Filter by the object’s currentPeriod field. |
automatic - BooleanFilter
|
Filter by the object’s automatic field. |
id - UUIDFilter
|
Filter by the object’s id field. |
vestingEventsByVestingScheduleId - VestingScheduleToManyVestingEventFilter
|
Filter by the object’s vestingEventsByVestingScheduleId relation. |
vestingEventsByVestingScheduleIdExist - Boolean
|
Some related vestingEventsByVestingScheduleId exist. |
distributionByDistributionId - DistributionFilter
|
Filter by the object’s distributionByDistributionId relation. |
vestingDurationByDuration - VestingDurationFilter
|
Filter by the object’s vestingDurationByDuration relation. |
and - [VestingScheduleFilter!]
|
Checks for all expressions in this list. |
or - [VestingScheduleFilter!]
|
Checks for any expressions in this list. |
not - VestingScheduleFilter
|
Negates the expression. |
Example
{
"distributionId": UUIDFilter,
"duration": StringFilter,
"cliff": IntFilter,
"periods": IntFilter,
"startsOn": DatetimeFilter,
"currentPeriod": IntFilter,
"automatic": BooleanFilter,
"id": UUIDFilter,
"vestingEventsByVestingScheduleId": VestingScheduleToManyVestingEventFilter,
"vestingEventsByVestingScheduleIdExist": false,
"distributionByDistributionId": DistributionFilter,
"vestingDurationByDuration": VestingDurationFilter,
"and": [VestingScheduleFilter],
"or": [VestingScheduleFilter],
"not": VestingScheduleFilter
}
VestingScheduleInput
Description
An input for mutations affecting VestingSchedule
Example
{
"distributionId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"duration": "xyz789",
"cliff": 123,
"periods": 123,
"startsOn": Datetime,
"currentPeriod": 987,
"automatic": false,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
VestingSchedulePatch
Description
Represents an update to a VestingSchedule. Fields that are set will be updated.
Example
{
"distributionId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"duration": "abc123",
"cliff": 987,
"periods": 123,
"startsOn": Datetime,
"currentPeriod": 987,
"automatic": false,
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
VestingScheduleToManyVestingEventFilter
Description
A filter to be used against many VestingEvent object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - VestingEventFilter
|
Every related VestingEvent matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - VestingEventFilter
|
Some related VestingEvent matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - VestingEventFilter
|
No related VestingEvent matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": VestingEventFilter,
"some": VestingEventFilter,
"none": VestingEventFilter
}
VestingSchedulesConnection
Description
A connection to a list of VestingSchedule values.
Fields
| Field Name | Description |
|---|---|
nodes - [VestingSchedule]!
|
A list of VestingSchedule objects. |
edges - [VestingSchedulesEdge!]!
|
A list of edges which contains the VestingSchedule and cursor to aid in pagination. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The count of all VestingSchedule you could get from the connection. |
Example
{
"nodes": [VestingSchedule],
"edges": [VestingSchedulesEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
VestingSchedulesEdge
Description
A VestingSchedule edge in the connection.
Fields
| Field Name | Description |
|---|---|
cursor - Cursor
|
A cursor for use in pagination. |
node - VestingSchedule
|
The VestingSchedule at the end of the edge. |
Example
{
"cursor": Cursor,
"node": VestingSchedule
}
VestingSchedulesOrderBy
Description
Methods to use when ordering VestingSchedule.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NATURAL"
WalletAssignment
Fields
| Field Name | Description |
|---|---|
nodeId - ID!
|
A globally unique identifier. Can be used in various places throughout the system to identify this single value. |
distributionId - UUID!
|
|
blockchainAddressId - UUID!
|
|
id - UUID!
|
|
distributionByDistributionId - Distribution
|
Reads a single Distribution that is related to this WalletAssignment. |
blockchainAddressByBlockchainAddressId - BlockchainAddress
|
Reads a single BlockchainAddress that is related to this WalletAssignment. |
Example
{
"nodeId": 4,
"distributionId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"blockchainAddressId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"distributionByDistributionId": Distribution,
"blockchainAddressByBlockchainAddressId": BlockchainAddress
}
WalletAssignmentCondition
Description
A condition to be used against WalletAssignment object types. All fields are tested for equality and combined with a logical ‘and.’
Example
{
"distributionId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"blockchainAddressId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
WalletAssignmentFilter
Description
A filter to be used against WalletAssignment object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
distributionId - UUIDFilter
|
Filter by the object’s distributionId field. |
blockchainAddressId - UUIDFilter
|
Filter by the object’s blockchainAddressId field. |
id - UUIDFilter
|
Filter by the object’s id field. |
distributionByDistributionId - DistributionFilter
|
Filter by the object’s distributionByDistributionId relation. |
blockchainAddressByBlockchainAddressId - BlockchainAddressFilter
|
Filter by the object’s blockchainAddressByBlockchainAddressId relation. |
and - [WalletAssignmentFilter!]
|
Checks for all expressions in this list. |
or - [WalletAssignmentFilter!]
|
Checks for any expressions in this list. |
not - WalletAssignmentFilter
|
Negates the expression. |
Example
{
"distributionId": UUIDFilter,
"blockchainAddressId": UUIDFilter,
"id": UUIDFilter,
"distributionByDistributionId": DistributionFilter,
"blockchainAddressByBlockchainAddressId": BlockchainAddressFilter,
"and": [WalletAssignmentFilter],
"or": [WalletAssignmentFilter],
"not": WalletAssignmentFilter
}
WalletAssignmentInput
Description
An input for mutations affecting WalletAssignment
Example
{
"distributionId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"blockchainAddressId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
WalletAssignmentPatch
Description
Represents an update to a WalletAssignment. Fields that are set will be updated.
Example
{
"distributionId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"blockchainAddressId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb"
}
WalletAssignmentsConnection
Description
A connection to a list of WalletAssignment values.
Fields
| Field Name | Description |
|---|---|
nodes - [WalletAssignment]!
|
A list of WalletAssignment objects. |
edges - [WalletAssignmentsEdge!]!
|
A list of edges which contains the WalletAssignment and cursor to aid in pagination. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The count of all WalletAssignment you could get from the connection. |
Example
{
"nodes": [WalletAssignment],
"edges": [WalletAssignmentsEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
WalletAssignmentsEdge
Description
A WalletAssignment edge in the connection.
Fields
| Field Name | Description |
|---|---|
cursor - Cursor
|
A cursor for use in pagination. |
node - WalletAssignment
|
The WalletAssignment at the end of the edge. |
Example
{
"cursor": Cursor,
"node": WalletAssignment
}
WalletAssignmentsOrderBy
Description
Methods to use when ordering WalletAssignment.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NATURAL"
WebhookConfiguration
Fields
| Field Name | Description |
|---|---|
nodeId - ID!
|
A globally unique identifier. Can be used in various places throughout the system to identify this single value. |
id - UUID!
|
|
level - String
|
|
accountId - UUID
|
|
url - String!
|
|
enabled - Boolean!
|
|
createdOn - Datetime!
|
|
secretKeyName - String
|
|
webhookLevelByLevel - WebhookLevel
|
Reads a single WebhookLevel that is related to this WebhookConfiguration. |
accountByAccountId - Account
|
Reads a single Account that is related to this WebhookConfiguration. |
Example
{
"nodeId": "4",
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"level": "abc123",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"url": "xyz789",
"enabled": false,
"createdOn": Datetime,
"secretKeyName": "xyz789",
"webhookLevelByLevel": WebhookLevel,
"accountByAccountId": Account
}
WebhookConfigurationCondition
Description
A condition to be used against WebhookConfiguration object types. All fields are tested for equality and combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
id - UUID
|
Checks for equality with the object’s id field. |
level - String
|
Checks for equality with the object’s level field. |
accountId - UUID
|
Checks for equality with the object’s accountId field. |
url - String
|
Checks for equality with the object’s url field. |
enabled - Boolean
|
Checks for equality with the object’s enabled field. |
createdOn - Datetime
|
Checks for equality with the object’s createdOn field. |
secretKeyName - String
|
Checks for equality with the object’s secretKeyName field. |
Example
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"level": "abc123",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"url": "xyz789",
"enabled": false,
"createdOn": Datetime,
"secretKeyName": "xyz789"
}
WebhookConfigurationFilter
Description
A filter to be used against WebhookConfiguration object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
id - UUIDFilter
|
Filter by the object’s id field. |
level - StringFilter
|
Filter by the object’s level field. |
accountId - UUIDFilter
|
Filter by the object’s accountId field. |
url - StringFilter
|
Filter by the object’s url field. |
enabled - BooleanFilter
|
Filter by the object’s enabled field. |
createdOn - DatetimeFilter
|
Filter by the object’s createdOn field. |
secretKeyName - StringFilter
|
Filter by the object’s secretKeyName field. |
webhookLevelByLevel - WebhookLevelFilter
|
Filter by the object’s webhookLevelByLevel relation. |
webhookLevelByLevelExists - Boolean
|
A related webhookLevelByLevel exists. |
accountByAccountId - AccountFilter
|
Filter by the object’s accountByAccountId relation. |
accountByAccountIdExists - Boolean
|
A related accountByAccountId exists. |
and - [WebhookConfigurationFilter!]
|
Checks for all expressions in this list. |
or - [WebhookConfigurationFilter!]
|
Checks for any expressions in this list. |
not - WebhookConfigurationFilter
|
Negates the expression. |
Example
{
"id": UUIDFilter,
"level": StringFilter,
"accountId": UUIDFilter,
"url": StringFilter,
"enabled": BooleanFilter,
"createdOn": DatetimeFilter,
"secretKeyName": StringFilter,
"webhookLevelByLevel": WebhookLevelFilter,
"webhookLevelByLevelExists": true,
"accountByAccountId": AccountFilter,
"accountByAccountIdExists": false,
"and": [WebhookConfigurationFilter],
"or": [WebhookConfigurationFilter],
"not": WebhookConfigurationFilter
}
WebhookConfigurationInput
Description
An input for mutations affecting WebhookConfiguration
Example
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"level": "abc123",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"url": "xyz789",
"enabled": true,
"createdOn": Datetime,
"secretKeyName": "abc123"
}
WebhookConfigurationPatch
Description
Represents an update to a WebhookConfiguration. Fields that are set will be updated.
Example
{
"id": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"level": "abc123",
"accountId": "429b60eb-fbd8-4037-8072-5ce7ba9d36fb",
"url": "xyz789",
"enabled": false,
"createdOn": Datetime,
"secretKeyName": "abc123"
}
WebhookConfigurationsConnection
Description
A connection to a list of WebhookConfiguration values.
Fields
| Field Name | Description |
|---|---|
nodes - [WebhookConfiguration]!
|
A list of WebhookConfiguration objects. |
edges - [WebhookConfigurationsEdge!]!
|
A list of edges which contains the WebhookConfiguration and cursor to aid in pagination. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The count of all WebhookConfiguration you could get from the connection. |
Example
{
"nodes": [WebhookConfiguration],
"edges": [WebhookConfigurationsEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
WebhookConfigurationsEdge
Description
A WebhookConfiguration edge in the connection.
Fields
| Field Name | Description |
|---|---|
cursor - Cursor
|
A cursor for use in pagination. |
node - WebhookConfiguration
|
The WebhookConfiguration at the end of the edge. |
Example
{
"cursor": Cursor,
"node": WebhookConfiguration
}
WebhookConfigurationsOrderBy
Description
Methods to use when ordering WebhookConfiguration.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NATURAL"
WebhookLevel
Fields
| Field Name | Description |
|---|---|
nodeId - ID!
|
A globally unique identifier. Can be used in various places throughout the system to identify this single value. |
level - String!
|
|
webhookConfigurationsByLevel - WebhookConfigurationsConnection!
|
Reads and enables pagination through a set of WebhookConfiguration. |
Arguments
|
|
Example
{
"nodeId": 4,
"level": "abc123",
"webhookConfigurationsByLevel": WebhookConfigurationsConnection
}
WebhookLevelCondition
Description
A condition to be used against WebhookLevel object types. All fields are tested for equality and combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
level - String
|
Checks for equality with the object’s level field. |
Example
{"level": "xyz789"}
WebhookLevelFilter
Description
A filter to be used against WebhookLevel object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
level - StringFilter
|
Filter by the object’s level field. |
webhookConfigurationsByLevel - WebhookLevelToManyWebhookConfigurationFilter
|
Filter by the object’s webhookConfigurationsByLevel relation. |
webhookConfigurationsByLevelExist - Boolean
|
Some related webhookConfigurationsByLevel exist. |
and - [WebhookLevelFilter!]
|
Checks for all expressions in this list. |
or - [WebhookLevelFilter!]
|
Checks for any expressions in this list. |
not - WebhookLevelFilter
|
Negates the expression. |
Example
{
"level": StringFilter,
"webhookConfigurationsByLevel": WebhookLevelToManyWebhookConfigurationFilter,
"webhookConfigurationsByLevelExist": true,
"and": [WebhookLevelFilter],
"or": [WebhookLevelFilter],
"not": WebhookLevelFilter
}
WebhookLevelToManyWebhookConfigurationFilter
Description
A filter to be used against many WebhookConfiguration object types. All fields are combined with a logical ‘and.’
Fields
| Input Field | Description |
|---|---|
every - WebhookConfigurationFilter
|
Every related WebhookConfiguration matches the filter criteria. All fields are combined with a logical ‘and.’ |
some - WebhookConfigurationFilter
|
Some related WebhookConfiguration matches the filter criteria. All fields are combined with a logical ‘and.’ |
none - WebhookConfigurationFilter
|
No related WebhookConfiguration matches the filter criteria. All fields are combined with a logical ‘and.’ |
Example
{
"every": WebhookConfigurationFilter,
"some": WebhookConfigurationFilter,
"none": WebhookConfigurationFilter
}
WebhookLevelsConnection
Description
A connection to a list of WebhookLevel values.
Fields
| Field Name | Description |
|---|---|
nodes - [WebhookLevel]!
|
A list of WebhookLevel objects. |
edges - [WebhookLevelsEdge!]!
|
A list of edges which contains the WebhookLevel and cursor to aid in pagination. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The count of all WebhookLevel you could get from the connection. |
Example
{
"nodes": [WebhookLevel],
"edges": [WebhookLevelsEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
WebhookLevelsEdge
Description
A WebhookLevel edge in the connection.
Fields
| Field Name | Description |
|---|---|
cursor - Cursor
|
A cursor for use in pagination. |
node - WebhookLevel
|
The WebhookLevel at the end of the edge. |
Example
{
"cursor": Cursor,
"node": WebhookLevel
}
WebhookLevelsOrderBy
Description
Methods to use when ordering WebhookLevel.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NATURAL"