Admin API Reference
This API reference has been automatically generated from the Admin GraphQL schema.
Queries
accountingCurrencyPolicy
No description
accountingCurrencyPolicy: AccountingCurrencyPolicy
Type
AccountingCurrencyPolicy object
appConfig
No description
appConfig: Yaml!
Type
Yaml scalar
approvalProcess
No description
approvalProcess(
id: ApprovalProcessId!
): ApprovalProcess
Arguments
approvalProcess.id ● ApprovalProcessId! non-null scalar
Type
ApprovalProcess object
approvalProcesses
No description
approvalProcesses(
after: String
first: Int!
): ApprovalProcessConnection!
Arguments
approvalProcesses.after ● String scalar
approvalProcesses.first ● Int! non-null scalar
Type
ApprovalProcessConnection object
audit
No description
audit(
action: String
after: String
authorized: Boolean
first: Int!
object: String
requestIp: String
subject: AuditSubjectId
userAgent: String
): AuditEntryConnection!
Arguments
audit.action ● String scalar
audit.after ● String scalar
audit.authorized ● Boolean scalar
audit.first ● Int! non-null scalar
audit.object ● String scalar
audit.requestIp ● String scalar
audit.subject ● AuditSubjectId scalar
audit.userAgent ● String scalar
Type
AuditEntryConnection object
auditSubjects
No description
auditSubjects: [AuditSubjectId!]!
Type
AuditSubjectId scalar
availableReportDefinitions
No description
availableReportDefinitions: [ReportDefinition!]!
Type
ReportDefinition object
balanceSheet
No description
balanceSheet(
asOf: Date!
): BalanceSheet!
Arguments
balanceSheet.asOf ● Date! non-null scalar
Type
BalanceSheet object
bitcoinInventory
No description
bitcoinInventory: BitcoinInventory
Type
BitcoinInventory object
The bank's proprietary BTC inventory position: the sats held for sale and
their carrying value under the configured cost method. The carrying value
is null once the pool is exhausted — a zero balance's currency is only
knowable from the accounting currency policy, not the position.
bitcoinPurchase
No description
bitcoinPurchase(
id: BitcoinPurchaseId!
): BitcoinPurchase
Arguments
bitcoinPurchase.id ● BitcoinPurchaseId! non-null scalar
Type
BitcoinPurchase object
bitcoinPurchases
No description
bitcoinPurchases(
after: String
filter: BitcoinPurchaseFilter
first: Int!
sort: BitcoinPurchaseSort = { by: CREATED_AT, direction: DESC }
): BitcoinPurchaseConnection!
Arguments
bitcoinPurchases.after ● String scalar
bitcoinPurchases.filter ● BitcoinPurchaseFilter input
bitcoinPurchases.first ● Int! non-null scalar
bitcoinPurchases.sort ● BitcoinPurchaseSort input
Type
BitcoinPurchaseConnection object
buildInfo
No description
buildInfo: BuildInfo!
Type
BuildInfo object
chartOfAccounts
No description
chartOfAccounts: ChartOfAccounts!
Type
ChartOfAccounts object
committee
No description
committee(
id: CommitteeId!
): Committee
Arguments
committee.id ● CommitteeId! non-null scalar
Type
Committee object
committees
No description
committees(
after: String
first: Int!
sort: CommitteeSort = { by: CREATED_AT, direction: DESC }
): CommitteeConnection!
Arguments
committees.after ● String scalar
committees.first ● Int! non-null scalar
committees.sort ● CommitteeSort input
Type
CommitteeConnection object
creditAccountingIntegration
No description
creditAccountingIntegration: CreditAccountingIntegration
Type
CreditAccountingIntegration object
creditCurrencyPolicy
No description
creditCurrencyPolicy: CreditCurrencyPolicy
Type
CreditCurrencyPolicy object
creditFacilities
No description
creditFacilities(
after: String
filter: CreditFacilityFilter
first: Int!
sort: CreditFacilitySort = { by: CREATED_AT, direction: DESC }
): CreditFacilityConnection!
Arguments
creditFacilities.after ● String scalar
creditFacilities.filter ● CreditFacilityFilter input
creditFacilities.first ● Int! non-null scalar
creditFacilities.sort ● CreditFacilitySort input
Type
CreditFacilityConnection object
creditFacility
No description
creditFacility(
id: CreditFacilityId!
): CreditFacility
Arguments
creditFacility.id ● CreditFacilityId! non-null scalar
Type
CreditFacility object
creditFacilityAgreement
No description
creditFacilityAgreement(
id: CreditFacilityAgreementId!
): CreditFacilityAgreement
Arguments
creditFacilityAgreement.id ● CreditFacilityAgreementId! non-null scalar
Type
CreditFacilityAgreement object
creditFacilityByPublicId
No description
creditFacilityByPublicId(
id: PublicId!
): CreditFacility
Arguments
creditFacilityByPublicId.id ● PublicId! non-null scalar
Type
CreditFacility object
creditFacilityProduct
No description
creditFacilityProduct(
id: CreditFacilityProductId!
): CreditFacilityProduct
Arguments
creditFacilityProduct.id ● CreditFacilityProductId! non-null scalar
Type
CreditFacilityProduct object
creditFacilityProducts
No description
creditFacilityProducts(
after: String
filter: CreditFacilityProductFilter
first: Int!
sort: CreditFacilityProductSort = { by: CREATED_AT, direction: DESC }
): CreditFacilityProductConnection!
Arguments
creditFacilityProducts.after ● String scalar
creditFacilityProducts.filter ● CreditFacilityProductFilter input
creditFacilityProducts.first ● Int! non-null scalar
creditFacilityProducts.sort ● CreditFacilityProductSort input
Type
CreditFacilityProductConnection object
creditFacilityProposal
No description
creditFacilityProposal(
id: CreditFacilityProposalId!
): CreditFacilityProposal
Arguments
creditFacilityProposal.id ● CreditFacilityProposalId! non-null scalar
Type
CreditFacilityProposal object
creditFacilityProposals
No description
creditFacilityProposals(
after: String
filter: CreditFacilityProposalFilter
first: Int!
sort: CreditFacilityProposalSort = { by: CREATED_AT, direction: DESC }
): CreditFacilityProposalConnection!
Arguments
creditFacilityProposals.after ● String scalar
creditFacilityProposals.filter ● CreditFacilityProposalFilter input
creditFacilityProposals.first ● Int! non-null scalar
creditFacilityProposals.sort ● CreditFacilityProposalSort input
Type
CreditFacilityProposalConnection object
custodian
No description
custodian(
id: CustodianId!
): Custodian
Arguments
custodian.id ● CustodianId! non-null scalar
Type
Custodian object
custodians
No description
custodians(
after: String
first: Int!
sort: CustodianSort = { by: CREATED_AT, direction: DESC }
): CustodianConnection!
Arguments
custodians.after ● String scalar
custodians.first ● Int! non-null scalar
custodians.sort ● CustodianSort input
Type
CustodianConnection object
customer
No description
customer(
id: CustomerId!
): Customer
Arguments
customer.id ● CustomerId! non-null scalar
Type
Customer object
customerByPublicId
No description
customerByPublicId(
id: PublicId!
): Customer
Arguments
customerByPublicId.id ● PublicId! non-null scalar
Type
Customer object
customerDocument
No description
customerDocument(
id: CustomerDocumentId!
): CustomerDocument
Arguments
customerDocument.id ● CustomerDocumentId! non-null scalar
Type
CustomerDocument object
customers
No description
customers(
after: String
filter: CustomerFilter
first: Int!
sort: CustomerSort = { by: CREATED_AT, direction: DESC }
): CustomerConnection!
Arguments
customers.after ● String scalar
customers.filter ● CustomerFilter input
customers.first ● Int! non-null scalar
customers.sort ● CustomerSort input
Type
CustomerConnection object
dashboard
No description
dashboard: Dashboard!
Type
Dashboard object
dataMartModelDetails
Full definitions (description + columns) of the named data-mart
models, in request order. columns filters each model's columns by
case-insensitive glob (when the filter contains a *) or substring.
dataMartModelDetails(
columns: [String!]
models: [String!]!
): [DataMartModel!]!
Arguments
dataMartModelDetails.columns ● [String!] list scalar
dataMartModelDetails.models ● [String!]! non-null scalar
Type
DataMartModel object
The full definition of one data-mart model: its grain-bearing description
and its columns. The describe half of progressive disclosure - returned
only for the models a caller explicitly names.
dataMartModels
dbt data-mart (fct_* / dim_* / bridge_*) model summaries,
auto-extracted from the dbt schema YAML: name, full description and
column count. Read-only slim catalog of the modeled DW layer; use
dataMartModelDetails for full column schemas.
dataMartModels: [DataMartModelSummary!]!
Type
DataMartModelSummary object
The catalog-listing entry for one data-mart model: name, full description and column count - the whole catalog travels in one small payload.
deposit
No description
deposit(
id: DepositId!
): Deposit
Arguments
deposit.id ● DepositId! non-null scalar
Type
Deposit object
depositAccount
No description
depositAccount(
id: DepositAccountId!
): DepositAccount
Arguments
depositAccount.id ● DepositAccountId! non-null scalar
Type
DepositAccount object
depositAccountByPublicId
No description
depositAccountByPublicId(
id: PublicId!
): DepositAccount
Arguments
depositAccountByPublicId.id ● PublicId! non-null scalar
Type
DepositAccount object
depositAccountingIntegration
No description
depositAccountingIntegration: DepositAccountingIntegration
Type
DepositAccountingIntegration object
depositAccountProduct
No description
depositAccountProduct(
id: DepositAccountProductId!
): DepositAccountProduct
Arguments
depositAccountProduct.id ● DepositAccountProductId! non-null scalar
Type
DepositAccountProduct object
depositAccountProducts
No description
depositAccountProducts(
after: String
filter: DepositAccountProductFilter
first: Int!
sort: DepositAccountProductSort = { by: CREATED_AT, direction: DESC }
): DepositAccountProductConnection!
Arguments
depositAccountProducts.after ● String scalar
depositAccountProducts.filter ● DepositAccountProductFilter input
depositAccountProducts.first ● Int! non-null scalar
depositAccountProducts.sort ● DepositAccountProductSort input
Type
DepositAccountProductConnection object
depositAccounts
No description
depositAccounts(
after: String
filter: DepositAccountFilter
first: Int!
sort: DepositAccountSort = { by: CREATED_AT, direction: DESC }
): DepositAccountConnection!
Arguments
depositAccounts.after ● String scalar
depositAccounts.filter ● DepositAccountFilter input
depositAccounts.first ● Int! non-null scalar
depositAccounts.sort ● DepositAccountSort input
Type
DepositAccountConnection object
depositByPublicId
No description
depositByPublicId(
id: PublicId!
): Deposit
Arguments
depositByPublicId.id ● PublicId! non-null scalar
Type
Deposit object
depositCurrencyPolicy
No description
depositCurrencyPolicy: DepositCurrencyPolicy
Type
DepositCurrencyPolicy object
deposits
No description
deposits(
after: String
filter: DepositFilter
first: Int!
sort: DepositSort = { by: CREATED_AT, direction: DESC }
): DepositConnection!
Arguments
deposits.after ● String scalar
deposits.filter ● DepositFilter input
deposits.first ● Int! non-null scalar
deposits.sort ● DepositSort input
Type
DepositConnection object
descendantAccountSetsByCategory
No description
descendantAccountSetsByCategory(
category: AccountCategory!
): [ChartNode!]!
Arguments
descendantAccountSetsByCategory.category ● AccountCategory! non-null enum
Type
ChartNode object
disbursal
No description
disbursal(
id: CreditFacilityDisbursalId!
): CreditFacilityDisbursal
Arguments
disbursal.id ● CreditFacilityDisbursalId! non-null scalar
Type
CreditFacilityDisbursal object
disbursalByPublicId
No description
disbursalByPublicId(
id: PublicId!
): CreditFacilityDisbursal
Arguments
disbursalByPublicId.id ● PublicId! non-null scalar
Type
CreditFacilityDisbursal object
disbursals
No description
disbursals(
after: String
filter: DisbursalFilter
first: Int!
sort: DisbursalSort = { by: CREATED_AT, direction: DESC }
): CreditFacilityDisbursalConnection!
Arguments
disbursals.after ● String scalar
disbursals.filter ● DisbursalFilter input
disbursals.first ● Int! non-null scalar
disbursals.sort ● DisbursalSort input
Type
CreditFacilityDisbursalConnection object
domainConfig
No description
domainConfig(
id: DomainConfigId!
): DomainConfig
Arguments
domainConfig.id ● DomainConfigId! non-null scalar
Type
DomainConfig object
domainConfigs
No description
domainConfigs(
after: String
first: Int!
): DomainConfigConnection!
Arguments
domainConfigs.after ● String scalar
domainConfigs.first ● Int! non-null scalar
Type
DomainConfigConnection object
dwRunReadonlyQuery
Runs a validated read-only SQL query against the data warehouse.
Accepts a single SELECT over the modeled data-mart (fct_* / dim_*
/ bridge_*) and report_* layers only; executes in a READ ONLY
transaction with a row cap.
dwRunReadonlyQuery(
sql: String!
): DwReadOnlyQueryResult!
Arguments
dwRunReadonlyQuery.sql ● String! non-null scalar
Type
DwReadOnlyQueryResult object
Result of a validated read-only DW query. rows is a JSON array of row
objects (column name -> value); truncated is true if the row cap or
the byte budget cut the result short.
environmentBanner
Optional environment banner message for this instance (e.g. a demo-environment disclaimer rendered across the top of the admin panel). Null when not configured.
environmentBanner: String
Type
String scalar
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.
eodProcess
No description
eodProcess(
id: EodProcessId!
): EodProcess
Arguments
eodProcess.id ● EodProcessId! non-null scalar
Type
EodProcess object
eodProcesses
No description
eodProcesses(
after: String
filter: EodProcessFilter
first: Int!
sort: EodProcessSort = { by: DAY, direction: DESC }
): EodProcessConnection!
Arguments
eodProcesses.after ● String scalar
eodProcesses.filter ● EodProcessFilter input
eodProcesses.first ● Int! non-null scalar
eodProcesses.sort ● EodProcessSort input
Type
EodProcessConnection object
exchangeAccountingIntegration
No description
exchangeAccountingIntegration: ExchangeAccountingIntegration
Type
ExchangeAccountingIntegration object
exchangeRateProvider
No description
exchangeRateProvider(
id: PriceProviderId!
): ExchangeRateProvider
Arguments
exchangeRateProvider.id ● PriceProviderId! non-null scalar
Type
ExchangeRateProvider object
exchangeRateProviders
No description
exchangeRateProviders(
after: String
first: Int!
sort: ExchangeRateProviderSort = { by: CREATED_AT, direction: DESC }
): ExchangeRateProviderConnection!
Arguments
exchangeRateProviders.after ● String scalar
exchangeRateProviders.first ● Int! non-null scalar
exchangeRateProviders.sort ● ExchangeRateProviderSort input
Type
ExchangeRateProviderConnection object
exchangeRates
No description
exchangeRates: [ExchangeRate!]!
Type
ExchangeRate object
fiscalYear
No description
fiscalYear(
id: OpenFiscalYearId!
): OpenFiscalYear
Arguments
fiscalYear.id ● OpenFiscalYearId! non-null scalar
Type
OpenFiscalYear object
fiscalYearByYear
No description
fiscalYearByYear(
year: FiscalYearLabel!
): OpenFiscalYear
Arguments
fiscalYearByYear.year ● FiscalYearLabel! non-null scalar
Type
OpenFiscalYear object
fiscalYears
No description
fiscalYears(
after: String
first: Int!
sort: FiscalYearSort = { by: CREATED_AT, direction: DESC }
): FiscalYearConnection!
Arguments
fiscalYears.after ● String scalar
fiscalYears.first ● Int! non-null scalar
fiscalYears.sort ● FiscalYearSort input
Type
FiscalYearConnection object
fxConfig
No description
fxConfig: FxModuleConfig
Type
FxModuleConfig object
isSimulatedTime
Whether the environment clock is in simulated time mode. In simulated mode, wall-clock-based features (e.g. cloud storage retention windows) may diverge from the environment clock.
isSimulatedTime: Boolean!
Type
Boolean scalar
The Boolean scalar type represents true or false.
kycProvider
No description
kycProvider(
id: KycProviderId!
): KycProvider
Arguments
kycProvider.id ● KycProviderId! non-null scalar
Type
KycProvider object
kycProviders
No description
kycProviders(
after: String
first: Int!
sort: KycProviderSort = { by: CREATED_AT, direction: DESC }
): KycProviderConnection!
Arguments
kycProviders.after ● String scalar
kycProviders.first ● Int! non-null scalar
kycProviders.sort ● KycProviderSort input
Type
KycProviderConnection object
ledgerAccount
No description
ledgerAccount(
id: LedgerAccountId!
): LedgerAccount
Arguments
ledgerAccount.id ● LedgerAccountId! non-null scalar
Type
LedgerAccount object
ledgerAccountByCode
No description
ledgerAccountByCode(
code: AccountCode!
): LedgerAccount
Arguments
ledgerAccountByCode.code ● AccountCode! non-null scalar
Type
LedgerAccount object
ledgerAccountCsv
No description
ledgerAccountCsv(
ledgerAccountId: LedgerAccountId!
): LedgerAccountCsvDocument
Arguments
ledgerAccountCsv.ledgerAccountId ● LedgerAccountId! non-null scalar
Type
LedgerAccountCsvDocument object
ledgerEntries
No description
ledgerEntries(
after: String
filter: JournalEntriesFilter
first: Int!
): LedgerEntryConnection!
Arguments
ledgerEntries.after ● String scalar
ledgerEntries.filter ● JournalEntriesFilter input
ledgerEntries.first ● Int! non-null scalar
Type
LedgerEntryConnection object
ledgerTransaction
No description
ledgerTransaction(
id: LedgerTransactionId!
): LedgerTransaction
Arguments
ledgerTransaction.id ● LedgerTransactionId! non-null scalar
Type
LedgerTransaction object
ledgerTransactionsForTemplateCode
No description
ledgerTransactionsForTemplateCode(
after: String
first: Int!
templateCode: String!
): LedgerTransactionConnection!
Arguments
ledgerTransactionsForTemplateCode.after ● String scalar
ledgerTransactionsForTemplateCode.first ● Int! non-null scalar
ledgerTransactionsForTemplateCode.templateCode ● String! non-null scalar
Type
LedgerTransactionConnection object
liquidation
No description
liquidation(
id: LiquidationId!
): Liquidation
Arguments
liquidation.id ● LiquidationId! non-null scalar
Type
Liquidation object
liquidationPaymentCalculate
No description
liquidationPaymentCalculate(
input: LiquidationPaymentCalculateInput!
): LiquidationPayment!
Arguments
liquidationPaymentCalculate.input ● LiquidationPaymentCalculateInput! non-null input
Type
LiquidationPayment object
liquidations
No description
liquidations(
after: String
first: Int!
sort: LiquidationSort = { by: CREATED_AT, direction: DESC }
): LiquidationConnection!
Arguments
liquidations.after ● String scalar
liquidations.first ● Int! non-null scalar
liquidations.sort ● LiquidationSort input
Type
LiquidationConnection object
manualTransaction
No description
manualTransaction(
id: ManualTransactionId!
): ManualTransaction
Arguments
manualTransaction.id ● ManualTransactionId! non-null scalar
Type
ManualTransaction object
manualTransactionByReference
References are globally unique. Returns null for an unknown reference, including one too long to have been created.
manualTransactionByReference(
reference: String!
): ManualTransaction
Arguments
manualTransactionByReference.reference ● String! non-null scalar
Type
ManualTransaction object
manualTransactionDraft
No description
manualTransactionDraft(
id: ManualTransactionDraftId!
): ManualTransactionDraft
Arguments
manualTransactionDraft.id ● ManualTransactionDraftId! non-null scalar
Type
ManualTransactionDraft object
manualTransactionDrafts
No description
manualTransactionDrafts(
after: String
filter: ManualTransactionDraftFilter
first: Int!
): ManualTransactionDraftConnection!
Arguments
manualTransactionDrafts.after ● String scalar
manualTransactionDrafts.filter ● ManualTransactionDraftFilter input
manualTransactionDrafts.first ● Int! non-null scalar
Type
ManualTransactionDraftConnection object
manualTransactions
No description
manualTransactions(
after: String
filter: ManualTransactionFilter
first: Int!
): ManualTransactionConnection!
Arguments
manualTransactions.after ● String scalar
manualTransactions.filter ● ManualTransactionFilter input
manualTransactions.first ● Int! non-null scalar
Type
ManualTransactionConnection object
manualTransactionValidate
No description
manualTransactionValidate(
input: ManualTransactionValidateInput!
): ManualTransactionValidatePayload!
Arguments
manualTransactionValidate.input ● ManualTransactionValidateInput! non-null input
Type
ManualTransactionValidatePayload union
me
No description
me: Me!
Type
Me object
notificationProvider
No description
notificationProvider(
id: NotificationProviderId!
): NotificationProvider
Arguments
notificationProvider.id ● NotificationProviderId! non-null scalar
Type
NotificationProvider object
notificationProviders
No description
notificationProviders(
after: String
first: Int!
sort: NotificationProviderSort = { by: CREATED_AT, direction: DESC }
): NotificationProviderConnection!
Arguments
notificationProviders.after ● String scalar
notificationProviders.first ● Int! non-null scalar
notificationProviders.sort ● NotificationProviderSort input
Type
NotificationProviderConnection object
obligations
No description
obligations(
after: String
filter: ObligationFilter
first: Int!
sort: ObligationSort = { by: CREATED_AT, direction: DESC }
): ObligationConnection!
Arguments
obligations.after ● String scalar
obligations.filter ● ObligationFilter input
obligations.first ● Int! non-null scalar
obligations.sort ● ObligationSort input
Type
ObligationConnection object
partner
No description
partner(
id: PartnerId!
): Partner
Arguments
partner.id ● PartnerId! non-null scalar
Type
Partner object
partners
No description
partners(
after: String
first: Int!
sort: PartnerSort = { by: CREATED_AT, direction: DESC }
): PartnerConnection!
Arguments
partners.after ● String scalar
partners.first ● Int! non-null scalar
partners.sort ● PartnerSort input
Type
PartnerConnection object
paymentProvider
No description
paymentProvider(
id: PaymentProviderId!
): PaymentProvider
Arguments
paymentProvider.id ● PaymentProviderId! non-null scalar
Type
PaymentProvider object
paymentProviders
No description
paymentProviders(
after: String
first: Int!
): PaymentProviderConnection!
Arguments
paymentProviders.after ● String scalar
paymentProviders.first ● Int! non-null scalar
Type
PaymentProviderConnection object
payout
No description
payout(
id: PayoutId!
): Payout
Arguments
payout.id ● PayoutId! non-null scalar
Type
Payout object
payouts
No description
payouts(
after: String
first: Int!
sort: PayoutSort = { by: CREATED_AT, direction: DESC }
): PayoutConnection!
Arguments
payouts.after ● String scalar
payouts.first ● Int! non-null scalar
payouts.sort ● PayoutSort input
Type
PayoutConnection object
pendingCreditFacilities
No description
pendingCreditFacilities(
after: String
filter: PendingCreditFacilityFilter
first: Int!
sort: PendingCreditFacilitySort = { by: CREATED_AT, direction: DESC }
): PendingCreditFacilityConnection!
Arguments
pendingCreditFacilities.after ● String scalar
pendingCreditFacilities.filter ● PendingCreditFacilityFilter input
pendingCreditFacilities.first ● Int! non-null scalar
pendingCreditFacilities.sort ● PendingCreditFacilitySort input
Type
PendingCreditFacilityConnection object
pendingCreditFacility
Get a pending credit facility.
pendingCreditFacility(
id: PendingCreditFacilityId!
): PendingCreditFacility
Arguments
pendingCreditFacility.id ● PendingCreditFacilityId! non-null scalar
Type
PendingCreditFacility object
permissionSet
No description
permissionSet(
id: PermissionSetId!
): PermissionSet
Arguments
permissionSet.id ● PermissionSetId! non-null scalar
Type
PermissionSet object
permissionSets
No description
permissionSets(
after: String
first: Int!
): PermissionSetConnection!
Arguments
permissionSets.after ● String scalar
permissionSets.first ● Int! non-null scalar
Type
PermissionSetConnection object
piiErasureProcess
Look up a PII erasure process by id. Requires the PII erasure viewer permission; errors otherwise.
piiErasureProcess(
id: PiiErasureProcessId!
): PiiErasureProcess
Arguments
piiErasureProcess.id ● PiiErasureProcessId! non-null scalar
Type
PiiErasureProcess object
piiErasureProcesses
List PII erasure processes across all subjects, including completed and cancelled ones. Requires the PII erasure viewer permission; errors otherwise.
piiErasureProcesses(
after: String
filter: PiiErasureProcessFilter
first: Int!
sort: PiiErasureProcessSort = { by: CREATED_AT, direction: DESC }
): PiiErasureProcessConnection!
Arguments
piiErasureProcesses.after ● String scalar
piiErasureProcesses.filter ● PiiErasureProcessFilter input
piiErasureProcesses.first ● Int! non-null scalar
piiErasureProcesses.sort ● PiiErasureProcessSort input
Type
PiiErasureProcessConnection object
pipelineRun
No description
pipelineRun(
id: PipelineRunId!
): PipelineRun
Arguments
pipelineRun.id ● PipelineRunId! non-null scalar
Type
PipelineRun object
pipelineRuns
No description
pipelineRuns(
after: String
filter: PipelineRunFilter
first: Int!
sort: PipelineRunSort = { by: DAY, direction: DESC }
): PipelineRunConnection!
Arguments
pipelineRuns.after ● String scalar
pipelineRuns.filter ● PipelineRunFilter input
pipelineRuns.first ● Int! non-null scalar
pipelineRuns.sort ● PipelineRunSort input
Type
PipelineRunConnection object
policies
No description
policies(
after: String
first: Int!
): PolicyConnection!
Arguments
policies.after ● String scalar
policies.first ● Int! non-null scalar
Type
PolicyConnection object
policy
No description
policy(
id: PolicyId!
): Policy
Arguments
policy.id ● PolicyId! non-null scalar
Type
Policy object
profitAndLossStatement
No description
profitAndLossStatement(
range: DateRangeInput!
): ProfitAndLossStatement!
Arguments
profitAndLossStatement.range ● DateRangeInput! non-null input
Type
ProfitAndLossStatement object
prospect
No description
prospect(
id: ProspectId!
): Prospect
Arguments
prospect.id ● ProspectId! non-null scalar
Type
Prospect object
prospectByPublicId
No description
prospectByPublicId(
id: PublicId!
): Prospect
Arguments
prospectByPublicId.id ● PublicId! non-null scalar
Type
Prospect object
prospects
No description
prospects(
after: String
filter: ProspectFilter
first: Int!
sort: ProspectSort = { by: CREATED_AT, direction: DESC }
): ProspectConnection!
Arguments
prospects.after ● String scalar
prospects.filter ● ProspectFilter input
prospects.first ● Int! non-null scalar
prospects.sort ● ProspectSort input
Type
ProspectConnection object
publicIdTarget
No description
publicIdTarget(
id: PublicId!
): PublicIdTarget
Arguments
publicIdTarget.id ● PublicId! non-null scalar
Type
PublicIdTarget union
queryTemplate
No description
queryTemplate(
id: QueryTemplateId!
): QueryTemplate
Arguments
queryTemplate.id ● QueryTemplateId! non-null scalar
Type
QueryTemplate object
A curated read-only data-mart query over one or more functional categories.
queryTemplates
No description
queryTemplates(
after: String
filter: QueryTemplateFilter
first: Int!
sort: QueryTemplateSort = { by: CREATED_AT, direction: DESC }
): QueryTemplateConnection!
Arguments
queryTemplates.after ● String scalar
queryTemplates.filter ● QueryTemplateFilter input
queryTemplates.first ● Int! non-null scalar
queryTemplates.sort ● QueryTemplateSort input
Type
QueryTemplateConnection object
rail
No description
rail(
id: RailId!
): Rail
Arguments
rail.id ● RailId! non-null scalar
Type
Rail object
rails
No description
rails(
after: String
first: Int!
sort: RailSort = { by: CREATED_AT, direction: DESC }
): RailConnection!
Arguments
rails.after ● String scalar
rails.first ● Int! non-null scalar
rails.sort ● RailSort input
Type
RailConnection object
receipt
No description
receipt(
id: ReceiptId!
): Receipt
Arguments
receipt.id ● ReceiptId! non-null scalar
Type
Receipt object
receipts
No description
receipts(
after: String
first: Int!
sort: ReceiptSort = { by: CREATED_AT, direction: DESC }
): ReceiptConnection!
Arguments
receipts.after ● String scalar
receipts.first ● Int! non-null scalar
receipts.sort ● ReceiptSort input
Type
ReceiptConnection object
role
No description
role(
id: RoleId!
): Role
Arguments
role.id ● RoleId! non-null scalar
Type
Role object
roles
No description
roles(
after: String
first: Int!
sort: RoleSort = { by: CREATED_AT, direction: DESC }
): RoleConnection!
Arguments
roles.after ● String scalar
roles.first ● Int! non-null scalar
roles.sort ● RoleSort input
Type
RoleConnection object
time
Returns the current environment clock state, including the next configured end-of-day boundary.
time: Time!
Type
Time object
transactionTemplates
No description
transactionTemplates(
after: String
first: Int!
): TransactionTemplateConnection!
Arguments
transactionTemplates.after ● String scalar
transactionTemplates.first ● Int! non-null scalar
Type
TransactionTemplateConnection object
trialBalance
No description
trialBalance(
range: DateRangeInput!
): TrialBalance!
Arguments
trialBalance.range ● DateRangeInput! non-null input
Type
TrialBalance object
user
No description
user(
id: UserId!
): User
Arguments
user.id ● UserId! non-null scalar
Type
User object
users
No description
users(
after: String
first: Int!
sort: UserSort = { by: CREATED_AT, direction: DESC }
): UserConnection!
Arguments
users.after ● String scalar
users.first ● Int! non-null scalar
users.sort ● UserSort input
Type
UserConnection object
withdrawal
No description
withdrawal(
id: WithdrawalId!
): Withdrawal
Arguments
withdrawal.id ● WithdrawalId! non-null scalar
Type
Withdrawal object
withdrawalByPublicId
No description
withdrawalByPublicId(
id: PublicId!
): Withdrawal
Arguments
withdrawalByPublicId.id ● PublicId! non-null scalar
Type
Withdrawal object
withdrawals
No description
withdrawals(
after: String
filter: WithdrawalFilter
first: Int!
sort: WithdrawalSort = { by: CREATED_AT, direction: DESC }
): WithdrawalConnection!
Arguments
withdrawals.after ● String scalar
withdrawals.filter ● WithdrawalFilter input
withdrawals.first ● Int! non-null scalar
withdrawals.sort ● WithdrawalSort input
Type
WithdrawalConnection object
Mutations
accountingCurrencyPolicyConfigure
No description
accountingCurrencyPolicyConfigure(
input: AccountingCurrencyPolicyConfigureInput!
): AccountingCurrencyPolicyConfigurePayload!
Arguments
accountingCurrencyPolicyConfigure.input ● AccountingCurrencyPolicyConfigureInput! non-null input
Type
AccountingCurrencyPolicyConfigurePayload union
approvalProcessApprove
No description
approvalProcessApprove(
input: ApprovalProcessApproveInput!
): ApprovalProcessApprovePayload!
Arguments
approvalProcessApprove.input ● ApprovalProcessApproveInput! non-null input
Type
ApprovalProcessApprovePayload union
approvalProcessDeny
No description
approvalProcessDeny(
input: ApprovalProcessDenyInput!
): ApprovalProcessDenyPayload!
Arguments
approvalProcessDeny.input ● ApprovalProcessDenyInput! non-null input
Type
ApprovalProcessDenyPayload union
bitcoinInventoryFund
No description
bitcoinInventoryFund(
input: BitcoinInventoryFundInput!
): BitcoinInventoryFundPayload!
Arguments
bitcoinInventoryFund.input ● BitcoinInventoryFundInput! non-null input
Type
BitcoinInventoryFundPayload union
bitcoinPurchaseExecute
No description
bitcoinPurchaseExecute(
input: BitcoinPurchaseExecuteInput!
): BitcoinPurchaseExecutePayload!
Arguments
bitcoinPurchaseExecute.input ● BitcoinPurchaseExecuteInput! non-null input
Type
BitcoinPurchaseExecutePayload union
chartOfAccountsAddChildNode
No description
chartOfAccountsAddChildNode(
input: ChartOfAccountsAddChildNodeInput!
): ChartOfAccountsAddChildNodePayload!
Arguments
chartOfAccountsAddChildNode.input ● ChartOfAccountsAddChildNodeInput! non-null input
Type
ChartOfAccountsAddChildNodePayload union
chartOfAccountsInitialize
No description
chartOfAccountsInitialize(
input: ChartOfAccountsInitializeInput!
): ChartOfAccountsInitializePayload!
Arguments
chartOfAccountsInitialize.input ● ChartOfAccountsInitializeInput! non-null input
Type
ChartOfAccountsInitializePayload union
collateralRecordLiquidationSale
Records an executed collateral sale and recognizes its net proceeds as a receivable. This does not record cash settlement.
collateralRecordLiquidationSale(
input: CollateralRecordLiquidationSaleInput!
): CollateralRecordLiquidationSalePayload!
Arguments
collateralRecordLiquidationSale.input ● CollateralRecordLiquidationSaleInput! non-null input
Type
CollateralRecordLiquidationSalePayload union
collateralRecordSentToLiquidation
No description
collateralRecordSentToLiquidation(
input: CollateralRecordSentToLiquidationInput!
): CollateralRecordSentToLiquidationPayload!
Arguments
collateralRecordSentToLiquidation.input ● CollateralRecordSentToLiquidationInput! non-null input
Type
CollateralRecordSentToLiquidationPayload union
collateralUpdate
Update collateral for a pending or active facility.
collateralUpdate(
input: CollateralUpdateInput!
): CollateralUpdatePayload!
Arguments
collateralUpdate.input ● CollateralUpdateInput! non-null input
Type
CollateralUpdatePayload union
committeeCreate
No description
committeeCreate(
input: CommitteeCreateInput!
): CommitteeCreatePayload!
Arguments
committeeCreate.input ● CommitteeCreateInput! non-null input
Type
CommitteeCreatePayload union
committeeUserAdd
No description
committeeUserAdd(
input: CommitteeUserAddInput!
): CommitteeUserAddPayload!
Arguments
committeeUserAdd.input ● CommitteeUserAddInput! non-null input
Type
CommitteeUserAddPayload union
committeeUserRemove
No description
committeeUserRemove(
input: CommitteeUserRemoveInput!
): CommitteeUserRemovePayload!
Arguments
committeeUserRemove.input ● CommitteeUserRemoveInput! non-null input
Type
CommitteeUserRemovePayload union
creditAccountingIntegrationConfigure
No description
creditAccountingIntegrationConfigure(
input: CreditAccountingIntegrationConfigureInput!
): CreditAccountingIntegrationConfigurePayload!
Arguments
creditAccountingIntegrationConfigure.input ● CreditAccountingIntegrationConfigureInput! non-null input
Type
CreditAccountingIntegrationConfigurePayload union
creditCurrencyPolicyConfigure
No description
creditCurrencyPolicyConfigure(
input: CreditCurrencyPolicyConfigureInput!
): CreditCurrencyPolicyConfigurePayload!
Arguments
creditCurrencyPolicyConfigure.input ● CreditCurrencyPolicyConfigureInput! non-null input
Type
CreditCurrencyPolicyConfigurePayload union
creditFacilityAgreementDownloadLinkGenerate
Generate a download link for a credit facility agreement.
creditFacilityAgreementDownloadLinkGenerate(
input: CreditFacilityAgreementDownloadLinksGenerateInput!
): CreditFacilityAgreementDownloadLinksGeneratePayload!
Arguments
creditFacilityAgreementDownloadLinkGenerate.input ● CreditFacilityAgreementDownloadLinksGenerateInput! non-null input
Type
CreditFacilityAgreementDownloadLinksGeneratePayload object
creditFacilityAgreementGenerate
Generate a credit facility agreement.
creditFacilityAgreementGenerate(
input: CreditFacilityAgreementGenerateInput!
): CreditFacilityAgreementGeneratePayload!
Arguments
creditFacilityAgreementGenerate.input ● CreditFacilityAgreementGenerateInput! non-null input
Type
CreditFacilityAgreementGeneratePayload union
creditFacilityComplete
No description
creditFacilityComplete(
input: CreditFacilityCompleteInput!
): CreditFacilityCompletePayload!
Arguments
creditFacilityComplete.input ● CreditFacilityCompleteInput! non-null input
Type
CreditFacilityCompletePayload union
creditFacilityDisbursalInitiate
Initiate a credit facility disbursal.
creditFacilityDisbursalInitiate(
input: CreditFacilityDisbursalInitiateInput!
): CreditFacilityDisbursalInitiatePayload!
Arguments
creditFacilityDisbursalInitiate.input ● CreditFacilityDisbursalInitiateInput! non-null input
Type
CreditFacilityDisbursalInitiatePayload union
creditFacilityPartialPaymentRecord
No description
creditFacilityPartialPaymentRecord(
input: CreditFacilityPartialPaymentRecordInput!
): CreditFacilityPartialPaymentRecordPayload!
Arguments
creditFacilityPartialPaymentRecord.input ● CreditFacilityPartialPaymentRecordInput! non-null input
Type
CreditFacilityPartialPaymentRecordPayload union
creditFacilityPartialPaymentWithDateRecord
No description
creditFacilityPartialPaymentWithDateRecord(
input: CreditFacilityPartialPaymentWithDateRecordInput!
): CreditFacilityPartialPaymentRecordPayload!
Arguments
creditFacilityPartialPaymentWithDateRecord.input ● CreditFacilityPartialPaymentWithDateRecordInput! non-null input
Type
CreditFacilityPartialPaymentRecordPayload union
creditFacilityProductCreate
Create a credit facility product.
creditFacilityProductCreate(
input: CreditFacilityProductCreateInput!
): CreditFacilityProductCreatePayload!
Arguments
creditFacilityProductCreate.input ● CreditFacilityProductCreateInput! non-null input
Type
CreditFacilityProductCreatePayload union
creditFacilityProductUpdateStatus
No description
creditFacilityProductUpdateStatus(
input: CreditFacilityProductUpdateStatusInput!
): CreditFacilityProductUpdateStatusPayload!
Arguments
creditFacilityProductUpdateStatus.input ● CreditFacilityProductUpdateStatusInput! non-null input
Type
CreditFacilityProductUpdateStatusPayload union
creditFacilityProductUpdateTerms
No description
creditFacilityProductUpdateTerms(
input: CreditFacilityProductUpdateTermsInput!
): CreditFacilityProductUpdateTermsPayload!
Arguments
creditFacilityProductUpdateTerms.input ● CreditFacilityProductUpdateTermsInput! non-null input
Type
CreditFacilityProductUpdateTermsPayload union
creditFacilityProposalCreate
Create a credit facility proposal.
The requested facility amount uses UsdCents, so pass the number of
cents as a JSON number, not a dollar amount string. For example,
1000000 means USD 10,000.00.
If the selected terms use SINGLE_DISBURSAL, the resulting facility may
disburse automatically as part of activation after approval and
collateralization. In that case, a later
creditFacilityDisbursalInitiate call can fail with
"OnlyOneDisbursalAllowed".
creditFacilityProposalCreate(
input: CreditFacilityProposalCreateInput!
): CreditFacilityProposalCreatePayload!
Arguments
creditFacilityProposalCreate.input ● CreditFacilityProposalCreateInput! non-null input
Type
CreditFacilityProposalCreatePayload union
creditFacilityProposalCustomerApprovalConclude
Conclude customer approval for a credit facility proposal.
creditFacilityProposalCustomerApprovalConclude(
input: CreditFacilityProposalCustomerApprovalConcludeInput!
): CreditFacilityProposalCustomerApprovalConcludePayload!
Arguments
creditFacilityProposalCustomerApprovalConclude.input ● CreditFacilityProposalCustomerApprovalConcludeInput! non-null input
Type
CreditFacilityProposalCustomerApprovalConcludePayload union
custodianConfigUpdate
No description
custodianConfigUpdate(
input: CustodianConfigUpdateInput!
): CustodianConfigUpdatePayload!
Arguments
custodianConfigUpdate.input ● CustodianConfigUpdateInput! non-null input
Type
CustodianConfigUpdatePayload union
custodianCreate
No description
custodianCreate(
input: CustodianCreateInput!
): CustodianCreatePayload!
Arguments
custodianCreate.input ● CustodianCreateInput! non-null input
Type
CustodianCreatePayload union
customerClose
Close a customer, moving it to the CLOSED status — a terminal state that requires all of the customer's credit facilities, proposals, deposit accounts and withdrawals to be settled first.
customerClose(
input: CustomerCloseInput!
): CustomerClosePayload!
Arguments
customerClose.input ● CustomerCloseInput! non-null input
Type
CustomerClosePayload union
customerDocumentArchive
No description
customerDocumentArchive(
input: CustomerDocumentArchiveInput!
): CustomerDocumentArchivePayload!
Arguments
customerDocumentArchive.input ● CustomerDocumentArchiveInput! non-null input
Type
CustomerDocumentArchivePayload union
customerDocumentCreate
No description
customerDocumentCreate(
input: CustomerDocumentCreateInput!
): CustomerDocumentCreatePayload!
Arguments
customerDocumentCreate.input ● CustomerDocumentCreateInput! non-null input
Type
CustomerDocumentCreatePayload union
customerDocumentCreateInline
Creates a customer document from inline UTF-8 text (no upload), for callers that speak plain JSON variables - e.g. the MCP tool surface.
customerDocumentCreateInline(
input: CustomerDocumentCreateInlineInput!
): CustomerDocumentCreateInlinePayload!
Arguments
customerDocumentCreateInline.input ● CustomerDocumentCreateInlineInput! non-null input
Type
CustomerDocumentCreateInlinePayload union
customerDocumentDelete
No description
customerDocumentDelete(
input: CustomerDocumentDeleteInput!
): CustomerDocumentDeletePayload!
Arguments
customerDocumentDelete.input ● CustomerDocumentDeleteInput! non-null input
Type
CustomerDocumentDeletePayload object
customerDocumentDownloadLinkGenerate
No description
customerDocumentDownloadLinkGenerate(
input: CustomerDocumentDownloadLinksGenerateInput!
): CustomerDocumentDownloadLinksGeneratePayload!
Arguments
customerDocumentDownloadLinkGenerate.input ● CustomerDocumentDownloadLinksGenerateInput! non-null input
Type
CustomerDocumentDownloadLinksGeneratePayload union
customerFreeze
Freeze a customer, moving it to the FROZEN status (blocks further customer activity until it is unfrozen).
customerFreeze(
input: CustomerFreezeInput!
): CustomerFreezePayload!
Arguments
customerFreeze.input ● CustomerFreezeInput! non-null input
Type
CustomerFreezePayload union
customerNoteCreate
No description
customerNoteCreate(
input: CustomerNoteCreateInput!
): CustomerNoteCreatePayload!
Arguments
customerNoteCreate.input ● CustomerNoteCreateInput! non-null input
Type
CustomerNoteCreatePayload union
customerNoteUpdate
No description
customerNoteUpdate(
input: CustomerNoteUpdateInput!
): CustomerNoteUpdatePayload!
Arguments
customerNoteUpdate.input ● CustomerNoteUpdateInput! non-null input
Type
CustomerNoteUpdatePayload union
customerUnfreeze
No description
customerUnfreeze(
input: CustomerUnfreezeInput!
): CustomerUnfreezePayload!
Arguments
customerUnfreeze.input ● CustomerUnfreezeInput! non-null input
Type
CustomerUnfreezePayload union
depositAccountClose
Close a deposit account, moving it to the CLOSED status (no further activity is allowed).
depositAccountClose(
input: DepositAccountCloseInput!
): DepositAccountClosePayload!
Arguments
depositAccountClose.input ● DepositAccountCloseInput! non-null input
Type
DepositAccountClosePayload union
depositAccountCreateFromProduct
Create a deposit account for a customer from a deposit account product.
depositAccountCreateFromProduct(
input: DepositAccountCreateFromProductInput!
): DepositAccountCreateFromProductPayload!
Arguments
depositAccountCreateFromProduct.input ● DepositAccountCreateFromProductInput! non-null input
Type
DepositAccountCreateFromProductPayload union
depositAccountFreeze
Freeze a deposit account, moving it to the FROZEN status (no further activity is allowed until it is unfrozen).
depositAccountFreeze(
input: DepositAccountFreezeInput!
): DepositAccountFreezePayload!
Arguments
depositAccountFreeze.input ● DepositAccountFreezeInput! non-null input
Type
DepositAccountFreezePayload union
depositAccountingIntegrationConfigure
No description
depositAccountingIntegrationConfigure(
input: DepositAccountingIntegrationConfigureInput!
): DepositAccountingIntegrationConfigurePayload!
Arguments
depositAccountingIntegrationConfigure.input ● DepositAccountingIntegrationConfigureInput! non-null input
Type
DepositAccountingIntegrationConfigurePayload union
depositAccountProductCreate
Create a deposit account product.
depositAccountProductCreate(
input: DepositAccountProductCreateInput!
): DepositAccountProductCreatePayload!
Arguments
depositAccountProductCreate.input ● DepositAccountProductCreateInput! non-null input
Type
DepositAccountProductCreatePayload union
depositAccountProductUpdateStatus
No description
depositAccountProductUpdateStatus(
input: DepositAccountProductUpdateStatusInput!
): DepositAccountProductUpdateStatusPayload!
Arguments
depositAccountProductUpdateStatus.input ● DepositAccountProductUpdateStatusInput! non-null input
Type
DepositAccountProductUpdateStatusPayload union
depositAccountProductUpdateTerms
No description
depositAccountProductUpdateTerms(
input: DepositAccountProductUpdateTermsInput!
): DepositAccountProductUpdateTermsPayload!
Arguments
depositAccountProductUpdateTerms.input ● DepositAccountProductUpdateTermsInput! non-null input
Type
DepositAccountProductUpdateTermsPayload union
depositAccountUnfreeze
No description
depositAccountUnfreeze(
input: DepositAccountUnfreezeInput!
): DepositAccountUnfreezePayload!
Arguments
depositAccountUnfreeze.input ● DepositAccountUnfreezeInput! non-null input
Type
DepositAccountUnfreezePayload union
depositCurrencyPolicyConfigure
No description
depositCurrencyPolicyConfigure(
input: DepositCurrencyPolicyConfigureInput!
): DepositCurrencyPolicyConfigurePayload!
Arguments
depositCurrencyPolicyConfigure.input ● DepositCurrencyPolicyConfigureInput! non-null input
Type
DepositCurrencyPolicyConfigurePayload union
depositRevert
No description
depositRevert(
input: DepositRevertInput!
): DepositRevertPayload!
Arguments
depositRevert.input ● DepositRevertInput! non-null input
Type
DepositRevertPayload union
domainConfigUpdate
No description
domainConfigUpdate(
input: DomainConfigUpdateInput!
): DomainConfigUpdatePayload!
Arguments
domainConfigUpdate.input ● DomainConfigUpdateInput! non-null input
Type
DomainConfigUpdatePayload union
dwReadonlyQueryExportLinkGenerate
Exports a validated read-only DW query as a downloadable file (CSV or
gzipped CSV) and returns its download link. Runs at a higher row cap
and byte budget than dwRunReadonlyQuery; truncated in the payload
reports whether either cap was hit.
dwReadonlyQueryExportLinkGenerate(
input: DwReadonlyQueryExportLinkGenerateInput!
): DwReadonlyQueryExportLinkGeneratePayload!
Arguments
dwReadonlyQueryExportLinkGenerate.input ● DwReadonlyQueryExportLinkGenerateInput! non-null input
Type
DwReadonlyQueryExportLinkGeneratePayload object
Download link for an exported read-only DW query, plus the shape of what
made it into the file. rowCount is the number of exported rows;
truncated is true if the export row cap or byte budget cut the result.
eodProcessRestart
Restarts a stopped EOD process: the failed phase is started again and the remaining phases continue from where the process stopped.
eodProcessRestart(
input: EodProcessRestartInput!
): EodProcessRestartPayload!
Arguments
eodProcessRestart.input ● EodProcessRestartInput! non-null input
Type
EodProcessRestartPayload union
exchangeAccountingIntegrationConfigure
No description
exchangeAccountingIntegrationConfigure(
input: ExchangeAccountingIntegrationConfigureInput!
): ExchangeAccountingIntegrationConfigurePayload!
Arguments
exchangeAccountingIntegrationConfigure.input ● ExchangeAccountingIntegrationConfigureInput! non-null input
Type
ExchangeAccountingIntegrationConfigurePayload union
exchangeRateProviderActivate
No description
exchangeRateProviderActivate(
input: ExchangeRateProviderActivateInput!
): ExchangeRateProviderActivatePayload!
Arguments
exchangeRateProviderActivate.input ● ExchangeRateProviderActivateInput! non-null input
Type
ExchangeRateProviderActivatePayload union
exchangeRateProviderDeactivate
No description
exchangeRateProviderDeactivate(
input: ExchangeRateProviderDeactivateInput!
): ExchangeRateProviderDeactivatePayload!
Arguments
exchangeRateProviderDeactivate.input ● ExchangeRateProviderDeactivateInput! non-null input
Type
ExchangeRateProviderDeactivatePayload union
exchangeRateProviderManualExchangeRateUpdate
No description
exchangeRateProviderManualExchangeRateUpdate(
input: ExchangeRateProviderManualExchangeRateUpdateInput!
): ExchangeRateProviderManualExchangeRateUpdatePayload!
Arguments
exchangeRateProviderManualExchangeRateUpdate.input ● ExchangeRateProviderManualExchangeRateUpdateInput! non-null input
Type
ExchangeRateProviderManualExchangeRateUpdatePayload union
fiscalYearClose
No description
fiscalYearClose(
input: FiscalYearCloseInput!
): FiscalYearClosePayload!
Arguments
fiscalYearClose.input ● FiscalYearCloseInput! non-null input
Type
FiscalYearClosePayload union
fiscalYearCloseMonth
No description
fiscalYearCloseMonth(
input: FiscalYearCloseMonthInput!
): FiscalYearCloseMonthPayload!
Arguments
fiscalYearCloseMonth.input ● FiscalYearCloseMonthInput! non-null input
Type
FiscalYearCloseMonthPayload union
fiscalYearInit
No description
fiscalYearInit(
input: FiscalYearInitInput!
): FiscalYearInitPayload!
Arguments
fiscalYearInit.input ● FiscalYearInitInput! non-null input
Type
FiscalYearInitPayload union
fxCurrencyPolicyConfigure
No description
fxCurrencyPolicyConfigure(
input: FxCurrencyPolicyConfigureInput!
): FxCurrencyPolicyConfigurePayload!
Arguments
fxCurrencyPolicyConfigure.input ● FxCurrencyPolicyConfigureInput! non-null input
Type
FxCurrencyPolicyConfigurePayload union
fxModuleConfigure
No description
fxModuleConfigure(
input: FxModuleConfigureInput!
): FxModuleConfigurePayload!
Arguments
fxModuleConfigure.input ● FxModuleConfigureInput! non-null input
Type
FxModuleConfigurePayload union
individualPartyCreate
No description
individualPartyCreate(
input: IndividualPartyCreateInput!
): IndividualPartyCreatePayload!
Arguments
individualPartyCreate.input ● IndividualPartyCreateInput! non-null input
Type
IndividualPartyCreatePayload union
individualPartyEmailUpdate
No description
individualPartyEmailUpdate(
input: IndividualPartyEmailUpdateInput!
): IndividualPartyEmailUpdatePayload!
Arguments
individualPartyEmailUpdate.input ● IndividualPartyEmailUpdateInput! non-null input
Type
IndividualPartyEmailUpdatePayload union
individualPartyPersonalInfoUpdate
No description
individualPartyPersonalInfoUpdate(
input: IndividualPartyPersonalInfoUpdateInput!
): IndividualPartyPersonalInfoUpdatePayload!
Arguments
individualPartyPersonalInfoUpdate.input ● IndividualPartyPersonalInfoUpdateInput! non-null input
Type
IndividualPartyPersonalInfoUpdatePayload union
individualPartyVerificationApproveManually
No description
individualPartyVerificationApproveManually(
input: IndividualPartyVerificationApproveManuallyInput!
): VerificationApproveManuallyPayload!
Arguments
individualPartyVerificationApproveManually.input ● IndividualPartyVerificationApproveManuallyInput! non-null input
Type
VerificationApproveManuallyPayload union
individualPartyVerificationLinkCreate
No description
individualPartyVerificationLinkCreate(
input: IndividualPartyVerificationLinkCreateInput!
): VerificationLinkCreatePayload!
Arguments
individualPartyVerificationLinkCreate.input ● IndividualPartyVerificationLinkCreateInput! non-null input
Type
VerificationLinkCreatePayload union
kycProviderConfigUpdate
No description
kycProviderConfigUpdate(
input: KycProviderConfigUpdateInput!
): KycProviderConfigUpdatePayload!
Arguments
kycProviderConfigUpdate.input ● KycProviderConfigUpdateInput! non-null input
Type
KycProviderConfigUpdatePayload union
kycProviderCreate
No description
kycProviderCreate(
input: KycProviderCreateInput!
): KycProviderCreatePayload!
Arguments
kycProviderCreate.input ● KycProviderCreateInput! non-null input
Type
KycProviderCreatePayload union
ledgerAccountCsvCreate
No description
ledgerAccountCsvCreate(
input: LedgerAccountCsvCreateInput!
): LedgerAccountCsvCreatePayload!
Arguments
ledgerAccountCsvCreate.input ● LedgerAccountCsvCreateInput! non-null input
Type
LedgerAccountCsvCreatePayload union
ledgerAccountCsvDownloadLinkGenerate
No description
ledgerAccountCsvDownloadLinkGenerate(
input: LedgerAccountCsvDownloadLinkGenerateInput!
): LedgerAccountCsvDownloadLinkGeneratePayload!
Arguments
ledgerAccountCsvDownloadLinkGenerate.input ● LedgerAccountCsvDownloadLinkGenerateInput! non-null input
Type
LedgerAccountCsvDownloadLinkGeneratePayload union
manualTransactionDraftClose
Discard a manual transaction draft (status CLOSED) without posting it to the ledger, so it can no longer be edited or posted.
manualTransactionDraftClose(
input: ManualTransactionDraftCloseInput!
): ManualTransactionDraftClosePayload!
Arguments
manualTransactionDraftClose.input ● ManualTransactionDraftCloseInput! non-null input
Type
ManualTransactionDraftClosePayload union
manualTransactionDraftCreate
Create a manual transaction draft (status DRAFT) without posting it to the ledger, so entries can be prepared and reviewed before posting.
manualTransactionDraftCreate(
input: ManualTransactionDraftCreateInput!
): ManualTransactionDraftCreatePayload!
Arguments
manualTransactionDraftCreate.input ● ManualTransactionDraftCreateInput! non-null input
Type
ManualTransactionDraftCreatePayload union
manualTransactionDraftPost
No description
manualTransactionDraftPost(
input: ManualTransactionDraftPostInput!
): ManualTransactionDraftPostPayload!
Arguments
manualTransactionDraftPost.input ● ManualTransactionDraftPostInput! non-null input
Type
ManualTransactionDraftPostPayload union
manualTransactionDraftUpdate
No description
manualTransactionDraftUpdate(
input: ManualTransactionDraftUpdateInput!
): ManualTransactionDraftUpdatePayload!
Arguments
manualTransactionDraftUpdate.input ● ManualTransactionDraftUpdateInput! non-null input
Type
ManualTransactionDraftUpdatePayload union
manualTransactionPost
Post a balanced manual transaction (a set of debit/credit journal entries against chart accounts) to the ledger, effective on a given date.
manualTransactionPost(
input: ManualTransactionPostInput!
): ManualTransactionPostPayload!
Arguments
manualTransactionPost.input ● ManualTransactionPostInput! non-null input
Type
ManualTransactionPostPayload union
notificationProviderConfigUpdate
No description
notificationProviderConfigUpdate(
input: NotificationProviderConfigUpdateInput!
): NotificationProviderConfigUpdatePayload!
Arguments
notificationProviderConfigUpdate.input ● NotificationProviderConfigUpdateInput! non-null input
Type
NotificationProviderConfigUpdatePayload union
notificationProviderCreate
No description
notificationProviderCreate(
input: NotificationProviderCreateInput!
): NotificationProviderCreatePayload!
Arguments
notificationProviderCreate.input ● NotificationProviderCreateInput! non-null input
Type
NotificationProviderCreatePayload union
organizationPartyDetailsUpdate
No description
organizationPartyDetailsUpdate(
input: OrganizationPartyDetailsUpdateInput!
): OrganizationPartyDetailsUpdatePayload!
Arguments
organizationPartyDetailsUpdate.input ● OrganizationPartyDetailsUpdateInput! non-null input
Type
OrganizationPartyDetailsUpdatePayload union
organizationPartyEmailUpdate
No description
organizationPartyEmailUpdate(
input: OrganizationPartyEmailUpdateInput!
): OrganizationPartyEmailUpdatePayload!
Arguments
organizationPartyEmailUpdate.input ● OrganizationPartyEmailUpdateInput! non-null input
Type
OrganizationPartyEmailUpdatePayload union
organizationPartyMemberAdd
No description
organizationPartyMemberAdd(
input: OrganizationPartyMemberAddInput!
): OrganizationPartyMemberAddPayload!
Arguments
organizationPartyMemberAdd.input ● OrganizationPartyMemberAddInput! non-null input
Type
OrganizationPartyMemberAddPayload union
organizationPartyMemberRemove
No description
organizationPartyMemberRemove(
input: OrganizationPartyMemberRemoveInput!
): OrganizationPartyMemberRemovePayload!
Arguments
organizationPartyMemberRemove.input ● OrganizationPartyMemberRemoveInput! non-null input
Type
OrganizationPartyMemberRemovePayload union
organizationPartyMemberRoleAdd
No description
organizationPartyMemberRoleAdd(
input: OrganizationPartyMemberRoleAddInput!
): OrganizationPartyMemberRoleAddPayload!
Arguments
organizationPartyMemberRoleAdd.input ● OrganizationPartyMemberRoleAddInput! non-null input
Type
OrganizationPartyMemberRoleAddPayload union
organizationPartyMemberRoleRemove
No description
organizationPartyMemberRoleRemove(
input: OrganizationPartyMemberRoleRemoveInput!
): OrganizationPartyMemberRoleRemovePayload!
Arguments
organizationPartyMemberRoleRemove.input ● OrganizationPartyMemberRoleRemoveInput! non-null input
Type
OrganizationPartyMemberRoleRemovePayload union
organizationPartyVerificationApproveManually
No description
organizationPartyVerificationApproveManually(
input: OrganizationPartyVerificationApproveManuallyInput!
): VerificationApproveManuallyPayload!
Arguments
organizationPartyVerificationApproveManually.input ● OrganizationPartyVerificationApproveManuallyInput! non-null input
Type
VerificationApproveManuallyPayload union
organizationPartyVerificationLinkCreate
No description
organizationPartyVerificationLinkCreate(
input: OrganizationPartyVerificationLinkCreateInput!
): VerificationLinkCreatePayload!
Arguments
organizationPartyVerificationLinkCreate.input ● OrganizationPartyVerificationLinkCreateInput! non-null input
Type
VerificationLinkCreatePayload union
partnerActivate
No description
partnerActivate(
input: PartnerActivateInput!
): PartnerActivatePayload!
Arguments
partnerActivate.input ● PartnerActivateInput! non-null input
Type
PartnerActivatePayload union
partnerCreate
Create a partner (a channel/origination partner the bank onboards customers and products through) and invite its first admin user.
partnerCreate(
input: PartnerCreateInput!
): PartnerCreatePayload!
Arguments
partnerCreate.input ● PartnerCreateInput! non-null input
Type
PartnerCreatePayload union
partnerDeactivate
No description
partnerDeactivate(
input: PartnerDeactivateInput!
): PartnerDeactivatePayload!
Arguments
partnerDeactivate.input ● PartnerDeactivateInput! non-null input
Type
PartnerDeactivatePayload union
partnerUpdate
No description
partnerUpdate(
input: PartnerUpdateInput!
): PartnerUpdatePayload!
Arguments
partnerUpdate.input ● PartnerUpdateInput! non-null input
Type
PartnerUpdatePayload union
paymentProviderConfigUpdate
No description
paymentProviderConfigUpdate(
input: PaymentProviderConfigUpdateInput!
): PaymentProviderConfigUpdatePayload!
Arguments
paymentProviderConfigUpdate.input ● PaymentProviderConfigUpdateInput! non-null input
Type
PaymentProviderConfigUpdatePayload union
paymentProviderCreate
No description
paymentProviderCreate(
input: PaymentProviderCreateInput!
): PaymentProviderCreatePayload!
Arguments
paymentProviderCreate.input ● PaymentProviderCreateInput! non-null input
Type
PaymentProviderCreatePayload union
payoutCancel
No description
payoutCancel(
input: PayoutCancelInput!
): PayoutCancelPayload!
Arguments
payoutCancel.input ● PayoutCancelInput! non-null input
Type
PayoutCancelPayload union
payoutFail
No description
payoutFail(
input: PayoutFailInput!
): PayoutFailPayload!
Arguments
payoutFail.input ● PayoutFailInput! non-null input
Type
PayoutFailPayload union
payoutRevert
No description
payoutRevert(
input: PayoutRevertInput!
): PayoutRevertPayload!
Arguments
payoutRevert.input ● PayoutRevertInput! non-null input
Type
PayoutRevertPayload union
payoutSettle
No description
payoutSettle(
input: PayoutSettleInput!
): PayoutSettlePayload!
Arguments
payoutSettle.input ● PayoutSettleInput! non-null input
Type
PayoutSettlePayload union
piiErasureProcessCancel
No description
piiErasureProcessCancel(
input: PiiErasureProcessCancelInput!
): PiiErasureProcessCancelPayload!
Arguments
piiErasureProcessCancel.input ● PiiErasureProcessCancelInput! non-null input
Type
PiiErasureProcessCancelPayload union
piiErasureProcessSchedule
No description
piiErasureProcessSchedule(
input: PiiErasureProcessScheduleInput!
): PiiErasureProcessSchedulePayload!
Arguments
piiErasureProcessSchedule.input ● PiiErasureProcessScheduleInput! non-null input
Type
PiiErasureProcessSchedulePayload union
pipelineRunRequest
Queue a full or partial dbt refresh on demand, without advancing end-of-day freshness. If an on-demand run with the same refresh mode is already queued or executing, that run is returned — a duplicate request joins the in-flight build instead of queueing behind it. Requests racing in separate transactions can each queue a run; queue compaction then collapses the duplicates, and only the latest arrival per refresh mode runs dbt.
pipelineRunRequest(
refreshMode: PipelineRunRefreshMode! = FULL
): PipelineRunRequestPayload!
Arguments
pipelineRunRequest.refreshMode ● PipelineRunRefreshMode! non-null enum
Type
PipelineRunRequestPayload union
policyCommitteeAssign
No description
policyCommitteeAssign(
input: PolicyCommitteeAssignInput!
): PolicyCommitteeAssignPayload!
Arguments
policyCommitteeAssign.input ● PolicyCommitteeAssignInput! non-null input
Type
PolicyCommitteeAssignPayload union
prospectClose
Close a prospect, moving it to the CLOSED stage — a terminal state that abandons onboarding without converting the prospect to a customer.
prospectClose(
input: ProspectCloseInput!
): ProspectClosePayload!
Arguments
prospectClose.input ● ProspectCloseInput! non-null input
Type
ProspectClosePayload union
prospectCreateIndividual
Create an individual prospect for onboarding.
prospectCreateIndividual(
input: IndividualProspectCreateInput!
): ProspectCreatePayload!
Arguments
prospectCreateIndividual.input ● IndividualProspectCreateInput! non-null input
Type
ProspectCreatePayload union
prospectCreateOrganization
Create an organization prospect for onboarding.
prospectCreateOrganization(
input: OrganizationProspectCreateInput!
): ProspectCreatePayload!
Arguments
prospectCreateOrganization.input ● OrganizationProspectCreateInput! non-null input
Type
ProspectCreatePayload union
queryTemplateCreate
No description
queryTemplateCreate(
input: QueryTemplateCreateInput!
): QueryTemplateCreatePayload!
Arguments
queryTemplateCreate.input ● QueryTemplateCreateInput! non-null input
Type
QueryTemplateCreatePayload union
queryTemplateDelete
No description
queryTemplateDelete(
input: QueryTemplateDeleteInput!
): QueryTemplateDeletePayload!
Arguments
queryTemplateDelete.input ● QueryTemplateDeleteInput! non-null input
Type
QueryTemplateDeletePayload union
queryTemplateUpdate
No description
queryTemplateUpdate(
input: QueryTemplateUpdateInput!
): QueryTemplateUpdatePayload!
Arguments
queryTemplateUpdate.input ● QueryTemplateUpdateInput! non-null input
Type
QueryTemplateUpdatePayload union
railCreate
No description
railCreate(
input: RailCreateInput!
): RailCreatePayload!
Arguments
railCreate.input ● RailCreateInput! non-null input
Type
RailCreatePayload union
receiptCancel
Cancel a receipt before it settles, from pending or cleared. A credit already booked is left unchanged; only a deposit still awaiting settlement is cancelled.
receiptCancel(
input: ReceiptCancelInput!
): ReceiptCancelPayload!
Arguments
receiptCancel.input ● ReceiptCancelInput! non-null input
Type
ReceiptCancelPayload union
receiptFail
Mark a receipt as failed on its rail, from pending or cleared. A credit already booked is left unchanged; only a deposit still awaiting settlement is cancelled.
receiptFail(
input: ReceiptFailInput!
): ReceiptFailPayload!
Arguments
receiptFail.input ● ReceiptFailInput! non-null input
Type
ReceiptFailPayload union
receiptSettle
Mark a receipt as settled, from pending or cleared. The deposit module's receipt-transition job records the settlement and posts the ledger credit for a deposit still awaiting settlement.
receiptSettle(
input: ReceiptSettleInput!
): ReceiptSettlePayload!
Arguments
receiptSettle.input ● ReceiptSettleInput! non-null input
Type
ReceiptSettlePayload union
receiptSubmit
Submit an inbound receipt to the payment hub. Creates a pending receipt instruction on the resolved rail; the deposit-settlement saga runs when the receipt is later settled.
receiptSubmit(
input: ReceiptSubmitInput!
): ReceiptSubmitPayload!
Arguments
receiptSubmit.input ● ReceiptSubmitInput! non-null input
Type
ReceiptSubmitPayload union
reportFileDownloadLinkGenerate
No description
reportFileDownloadLinkGenerate(
input: ReportFileDownloadLinkGenerateInput!
): ReportFileDownloadLinkGeneratePayload!
Arguments
reportFileDownloadLinkGenerate.input ● ReportFileDownloadLinkGenerateInput! non-null input
Type
ReportFileDownloadLinkGeneratePayload object
roleCreate
No description
roleCreate(
input: RoleCreateInput!
): RoleCreatePayload!
Arguments
roleCreate.input ● RoleCreateInput! non-null input
Type
RoleCreatePayload union
rolePermissionSetsAdd
No description
rolePermissionSetsAdd(
input: RolePermissionSetsAddInput!
): RolePermissionSetsAddPayload!
Arguments
rolePermissionSetsAdd.input ● RolePermissionSetsAddInput! non-null input
Type
RolePermissionSetsAddPayload union
rolePermissionSetsRemove
No description
rolePermissionSetsRemove(
input: RolePermissionSetsRemoveInput!
): RolePermissionSetsRemovePayload!
Arguments
rolePermissionSetsRemove.input ● RolePermissionSetsRemoveInput! non-null input
Type
RolePermissionSetsRemovePayload union
timeAdvanceToNextEndOfDay
Advances manual environment time to the next configured end-of-day boundary and returns the updated clock state.
timeAdvanceToNextEndOfDay: TimeAdvanceToNextEndOfDayPayload!
Type
TimeAdvanceToNextEndOfDayPayload union
timeAdvanceToNextHour
No description
timeAdvanceToNextHour: TimeAdvanceToNextHourPayload!
Type
TimeAdvanceToNextHourPayload union
timeAutoAdvancePause
No description
timeAutoAdvancePause: TimeAutoAdvancePausePayload!
Type
TimeAutoAdvancePausePayload union
timeAutoAdvanceResume
No description
timeAutoAdvanceResume: TimeAutoAdvanceResumePayload!
Type
TimeAutoAdvanceResumePayload union
userCreate
Create a backoffice user with the given email and assign them a role.
userCreate(
input: UserCreateInput!
): UserCreatePayload!
Arguments
userCreate.input ● UserCreateInput! non-null input
Type
UserCreatePayload union
userRoleUpdate
No description
userRoleUpdate(
input: UserRoleUpdateInput!
): UserRoleUpdatePayload!
Arguments
userRoleUpdate.input ● UserRoleUpdateInput! non-null input
Type
UserRoleUpdatePayload union
withdrawalInitiate
Initiate a withdrawal from a deposit account.
withdrawalInitiate(
input: WithdrawalInitiateInput!
): WithdrawalInitiatePayload!
Arguments
withdrawalInitiate.input ● WithdrawalInitiateInput! non-null input
Type
WithdrawalInitiatePayload union
Subscriptions
creditFacilityProposalUpdated
No description
creditFacilityProposalUpdated(
creditFacilityProposalId: CreditFacilityProposalId!
): CreditFacilityProposal
Arguments
creditFacilityProposalUpdated.creditFacilityProposalId ● CreditFacilityProposalId! non-null scalar
Type
CreditFacilityProposal object
creditFacilityUpdated
No description
creditFacilityUpdated(
creditFacilityId: CreditFacilityId!
): CreditFacility
Arguments
creditFacilityUpdated.creditFacilityId ● CreditFacilityId! non-null scalar
Type
CreditFacility object
customerCreditFacilitiesUpdated
The customer's credit facilities: lifecycle and collateralization transitions.
customerCreditFacilitiesUpdated(
customerId: CustomerId!
): Customer
Arguments
customerCreditFacilitiesUpdated.customerId ● CustomerId! non-null scalar
Type
Customer object
customerCreditFacilityProposalsUpdated
The customer's credit facility proposals.
customerCreditFacilityProposalsUpdated(
customerId: CustomerId!
): Customer
Arguments
customerCreditFacilityProposalsUpdated.customerId ● CustomerId! non-null scalar
Type
Customer object
customerDepositAccountsUpdated
The customer's deposit accounts: new accounts and balance
movements. Subscribers select the slice of Customer they render.
customerDepositAccountsUpdated(
customerId: CustomerId!
): Customer
Arguments
customerDepositAccountsUpdated.customerId ● CustomerId! non-null scalar
Type
Customer object
customerPendingCreditFacilitiesUpdated
The customer's pending credit facilities: creation (via proposal conclusion), collateralization, completion, and activation.
customerPendingCreditFacilitiesUpdated(
customerId: CustomerId!
): Customer
Arguments
customerPendingCreditFacilitiesUpdated.customerId ● CustomerId! non-null scalar
Type
Customer object
customerUpdated
The customer detail cards: customer lifecycle and party changes.
KYC changes stream through verificationUpdated with the
customer's verification id.
customerUpdated(
customerId: CustomerId!
): Customer
Arguments
customerUpdated.customerId ● CustomerId! non-null scalar
Type
Customer object
disbursalUpdated
No description
disbursalUpdated(
disbursalId: CreditFacilityDisbursalId!
): CreditFacilityDisbursal
Arguments
disbursalUpdated.disbursalId ● CreditFacilityDisbursalId! non-null scalar
Type
CreditFacilityDisbursal object
eodProcessUpdated
No description
eodProcessUpdated: EodProcess
Type
EodProcess object
exchangeRateUpdated
No description
exchangeRateUpdated: ExchangeRate!
Type
ExchangeRate object
ledgerAccountCsvExportUploaded
No description
ledgerAccountCsvExportUploaded(
ledgerAccountId: LedgerAccountId!
): LedgerAccountCsvExportUploadedPayload!
Arguments
ledgerAccountCsvExportUploaded.ledgerAccountId ● LedgerAccountId! non-null scalar
Type
LedgerAccountCsvExportUploadedPayload object
pendingCreditFacilityUpdated
No description
pendingCreditFacilityUpdated(
pendingCreditFacilityId: PendingCreditFacilityId!
): PendingCreditFacility
Arguments
pendingCreditFacilityUpdated.pendingCreditFacilityId ● PendingCreditFacilityId! non-null scalar
Type
PendingCreditFacility object
pipelineRunUpdated
No description
pipelineRunUpdated: PipelineRun
Type
PipelineRun object
prospectUpdated
No description
prospectUpdated(
prospectId: ProspectId!
): Prospect
Arguments
prospectUpdated.prospectId ● ProspectId! non-null scalar
Type
Prospect object
verificationUpdated
No description
verificationUpdated(
verificationId: VerificationId!
): Verification
Arguments
verificationUpdated.verificationId ● VerificationId! non-null scalar
Type
Verification object
withdrawalUpdated
No description
withdrawalUpdated(
withdrawalId: WithdrawalId!
): Withdrawal
Arguments
withdrawalUpdated.withdrawalId ● WithdrawalId! non-null scalar
Type
Withdrawal object
Directives (Operations)
include
Directs the executor to include this field or fragment only when the if argument is true.
directive @include(
if: Boolean!
) on
| FIELD
| FRAGMENT_SPREAD
| INLINE_FRAGMENT
Arguments
include.if ● Boolean! non-null scalar
skip
Directs the executor to skip this field or fragment when the if argument is true.
directive @skip(
if: Boolean!
) on
| FIELD
| FRAGMENT_SPREAD
| INLINE_FRAGMENT
Arguments
skip.if ● Boolean! non-null scalar
Objects
AccountingBaseConfigOutput
No description
type AccountingBaseConfigOutput {
assetsCode: AccountCode!
costOfRevenueCode: AccountCode!
equityCode: AccountCode!
equityRetainedEarningsGainCode: AccountCode!
equityRetainedEarningsLossCode: AccountCode!
expensesCode: AccountCode!
liabilitiesCode: AccountCode!
revenueCode: AccountCode!
}
Fields
AccountingBaseConfigOutput.assetsCode ● AccountCode! non-null scalar
AccountingBaseConfigOutput.costOfRevenueCode ● AccountCode! non-null scalar
AccountingBaseConfigOutput.equityCode ● AccountCode! non-null scalar
AccountingBaseConfigOutput.equityRetainedEarningsGainCode ● AccountCode! non-null scalar
AccountingBaseConfigOutput.equityRetainedEarningsLossCode ● AccountCode! non-null scalar
AccountingBaseConfigOutput.expensesCode ● AccountCode! non-null scalar
AccountingBaseConfigOutput.liabilitiesCode ● AccountCode! non-null scalar
AccountingBaseConfigOutput.revenueCode ● AccountCode! non-null scalar
Member Of
ChartOfAccounts object
AccountingCurrencyPolicy
No description
type AccountingCurrencyPolicy {
functional: Currency!
supported: [Currency!]!
}
Fields
AccountingCurrencyPolicy.functional ● Currency! non-null object
AccountingCurrencyPolicy.supported ● [Currency!]! non-null object
Returned By
accountingCurrencyPolicy query
Member Of
AccountingCurrencyPolicyConfigurePayloadSuccess object
AccountingCurrencyPolicyConfigurePayloadError
No description
type AccountingCurrencyPolicyConfigurePayloadError {
code: AccountingCurrencyPolicyConfigureErrorCode!
}
Fields
AccountingCurrencyPolicyConfigurePayloadError.code ● AccountingCurrencyPolicyConfigureErrorCode! non-null enum
Implemented By
AccountingCurrencyPolicyConfigurePayload union
AccountingCurrencyPolicyConfigurePayloadSuccess
No description
type AccountingCurrencyPolicyConfigurePayloadSuccess {
accountingCurrencyPolicy: AccountingCurrencyPolicy!
}
Fields
AccountingCurrencyPolicyConfigurePayloadSuccess.accountingCurrencyPolicy ● AccountingCurrencyPolicy! non-null object
Implemented By
AccountingCurrencyPolicyConfigurePayload union
ApprovalProcess
No description
type ApprovalProcess {
approvalProcessId: ApprovalProcessId!
approvalProcessType: ApprovalProcessType!
createdAt: Timestamp!
deniedReason: String
eventHistory(
after: String
first: Int!
): EventTimelineEntryConnection!
policy: Policy
rules: ApprovalRules!
status: ApprovalProcessStatus!
target: ApprovalProcessTarget
userCanSubmitDecision: Boolean
voters: [ApprovalProcessVoter!]
}
Fields
ApprovalProcess.approvalProcessId ● ApprovalProcessId! non-null scalar
ApprovalProcess.approvalProcessType ● ApprovalProcessType! non-null enum
ApprovalProcess.createdAt ● Timestamp! non-null scalar
ApprovalProcess.deniedReason ● String scalar
ApprovalProcess.eventHistory ● EventTimelineEntryConnection! non-null object
ApprovalProcess.eventHistory.after ● String scalar
ApprovalProcess.eventHistory.first ● Int! non-null scalar
ApprovalProcess.policy ● Policy object
ApprovalProcess.rules ● ApprovalRules! non-null union
ApprovalProcess.status ● ApprovalProcessStatus! non-null enum
ApprovalProcess.target ● ApprovalProcessTarget union
ApprovalProcess.userCanSubmitDecision ● Boolean scalar
ApprovalProcess.voters ● [ApprovalProcessVoter!] list object
Returned By
approvalProcess query
Member Of
ApprovalProcessApprovePayloadSuccess object ● ApprovalProcessConnection object ● ApprovalProcessDenyPayloadSuccess object ● ApprovalProcessEdge object ● CreditFacilityDisbursal object ● CreditFacilityProposal object ● PendingCreditFacility object ● Withdrawal object
ApprovalProcessApprovePayloadError
No description
type ApprovalProcessApprovePayloadError {
code: ApprovalProcessApproveErrorCode!
}
Fields
ApprovalProcessApprovePayloadError.code ● ApprovalProcessApproveErrorCode! non-null enum
Implemented By
ApprovalProcessApprovePayload union
ApprovalProcessApprovePayloadSuccess
No description
type ApprovalProcessApprovePayloadSuccess {
approvalProcess: ApprovalProcess!
}
Fields
ApprovalProcessApprovePayloadSuccess.approvalProcess ● ApprovalProcess! non-null object
Implemented By
ApprovalProcessApprovePayload union
ApprovalProcessConnection
No description
type ApprovalProcessConnection {
edges: [ApprovalProcessEdge!]!
nodes: [ApprovalProcess!]!
pageInfo: PageInfo!
}
Fields
ApprovalProcessConnection.edges ● [ApprovalProcessEdge!]! non-null object
A list of edges.
ApprovalProcessConnection.nodes ● [ApprovalProcess!]! non-null object
A list of nodes.
ApprovalProcessConnection.pageInfo ● PageInfo! non-null object
Information to aid in pagination.
Returned By
approvalProcesses query
ApprovalProcessDenyPayloadError
No description
type ApprovalProcessDenyPayloadError {
code: ApprovalProcessDenyErrorCode!
}
Fields
ApprovalProcessDenyPayloadError.code ● ApprovalProcessDenyErrorCode! non-null enum
Implemented By
ApprovalProcessDenyPayload union
ApprovalProcessDenyPayloadSuccess
No description
type ApprovalProcessDenyPayloadSuccess {
approvalProcess: ApprovalProcess!
}
Fields
ApprovalProcessDenyPayloadSuccess.approvalProcess ● ApprovalProcess! non-null object
Implemented By
ApprovalProcessDenyPayload union
ApprovalProcessEdge
An edge in a connection.
type ApprovalProcessEdge {
cursor: String!
node: ApprovalProcess!
}
Fields
ApprovalProcessEdge.cursor ● String! non-null scalar
A cursor for use in pagination
ApprovalProcessEdge.node ● ApprovalProcess! non-null object
The item at the end of the edge
Member Of
ApprovalProcessConnection object
ApprovalProcessVoter
No description
type ApprovalProcessVoter {
didApprove: Boolean!
didDeny: Boolean!
didVote: Boolean!
user: User
votedAt: Timestamp
}
Fields
ApprovalProcessVoter.didApprove ● Boolean! non-null scalar
ApprovalProcessVoter.didDeny ● Boolean! non-null scalar
ApprovalProcessVoter.didVote ● Boolean! non-null scalar
ApprovalProcessVoter.user ● User object
ApprovalProcessVoter.votedAt ● Timestamp scalar
Member Of
ApprovalProcess object
AuditEntry
No description
type AuditEntry {
action: String!
auditEntryId: AuditEntryId!
authorized: Boolean!
object: String!
recordedAt: Timestamp!
requestIp: String
subject: AuditSubject
userAgent: String
}
Fields
AuditEntry.action ● String! non-null scalar
AuditEntry.auditEntryId ● AuditEntryId! non-null scalar
AuditEntry.authorized ● Boolean! non-null scalar
AuditEntry.object ● String! non-null scalar
AuditEntry.recordedAt ● Timestamp! non-null scalar
AuditEntry.requestIp ● String scalar
AuditEntry.subject ● AuditSubject union
AuditEntry.userAgent ● String scalar
Member Of
AuditEntryConnection object ● AuditEntryEdge object
AuditEntryConnection
No description
type AuditEntryConnection {
edges: [AuditEntryEdge!]!
nodes: [AuditEntry!]!
pageInfo: PageInfo!
}
Fields
AuditEntryConnection.edges ● [AuditEntryEdge!]! non-null object
A list of edges.
AuditEntryConnection.nodes ● [AuditEntry!]! non-null object
A list of nodes.
AuditEntryConnection.pageInfo ● PageInfo! non-null object
Information to aid in pagination.
Returned By
audit query
AuditEntryEdge
An edge in a connection.
type AuditEntryEdge {
cursor: String!
node: AuditEntry!
}
Fields
AuditEntryEdge.cursor ● String! non-null scalar
A cursor for use in pagination
AuditEntryEdge.node ● AuditEntry! non-null object
The item at the end of the edge
Member Of
AuditEntryConnection object
AutoApproval
No description
type AutoApproval {
autoApprove: Boolean!
}
Fields
AutoApproval.autoApprove ● Boolean! non-null scalar
Placeholder field — the type name itself indicates auto-approval.
Implemented By
ApprovalRules union
Automation
No description
type Automation {
module: String!
}
Fields
Automation.module ● String! non-null scalar
Implemented By
AuditSubject union
BalanceSheet
No description
type BalanceSheet {
accounts: [BalanceSheetAccountFlat!]!
categories: [BalanceSheetAccount!]
name: String!
}
Fields
BalanceSheet.accounts ● [BalanceSheetAccountFlat!]! non-null object
BalanceSheet.categories ● [BalanceSheetAccount!] list object
BalanceSheet.name ● String! non-null scalar
Returned By
balanceSheet query
BalanceSheetAccount
No description
type BalanceSheetAccount {
balance: LedgerAccountBalance!
balancesByCurrency: [LedgerAccountBalance!]!
code: AccountCode
ledgerAccountId: LedgerAccountId!
name: String!
}
Fields
BalanceSheetAccount.balance ● LedgerAccountBalance! non-null object
BalanceSheetAccount.balancesByCurrency ● [LedgerAccountBalance!]! non-null object
BalanceSheetAccount.code ● AccountCode scalar
BalanceSheetAccount.ledgerAccountId ● LedgerAccountId! non-null scalar
BalanceSheetAccount.name ● String! non-null scalar
Member Of
BalanceSheet object
BalanceSheetAccountFlat
A statement account row, flattened: the chart tree is delivered as one ordered list with each account's parent, so clients can render it at any depth without nesting their selection.
type BalanceSheetAccountFlat {
balance: LedgerAccountBalance!
balancesByCurrency: [LedgerAccountBalance!]!
code: AccountCode
ledgerAccountId: LedgerAccountId!
name: String!
parentLedgerAccountId: LedgerAccountId!
}
Fields
BalanceSheetAccountFlat.balance ● LedgerAccountBalance! non-null object
BalanceSheetAccountFlat.balancesByCurrency ● [LedgerAccountBalance!]! non-null object
BalanceSheetAccountFlat.code ● AccountCode scalar
BalanceSheetAccountFlat.ledgerAccountId ● LedgerAccountId! non-null scalar
BalanceSheetAccountFlat.name ● String! non-null scalar
BalanceSheetAccountFlat.parentLedgerAccountId ● LedgerAccountId! non-null scalar
Member Of
BalanceSheet object
BitcoinInventory
The bank's proprietary BTC inventory position: the sats held for sale and
their carrying value under the configured cost method. The carrying value
is null once the pool is exhausted — a zero balance's currency is only
knowable from the accounting currency policy, not the position.
type BitcoinInventory {
carryingValue: Money
costMethod: BitcoinInventoryCostMethod!
quantity: Money!
}
Fields
BitcoinInventory.carryingValue ● Money object
BitcoinInventory.costMethod ● BitcoinInventoryCostMethod! non-null enum
BitcoinInventory.quantity ● Money! non-null object
Returned By
bitcoinInventory query
BitcoinInventoryFundPayloadError
No description
type BitcoinInventoryFundPayloadError {
code: BitcoinInventoryFundErrorCode!
}
Fields
BitcoinInventoryFundPayloadError.code ● BitcoinInventoryFundErrorCode! non-null enum
Implemented By
BitcoinInventoryFundPayload union
BitcoinInventoryFundPayloadSuccess
No description
type BitcoinInventoryFundPayloadSuccess {
bitcoinInventoryFundingId: BitcoinInventoryFundingId!
}
Fields
BitcoinInventoryFundPayloadSuccess.bitcoinInventoryFundingId ● BitcoinInventoryFundingId! non-null scalar
Implemented By
BitcoinInventoryFundPayload union
BitcoinPurchase
No description
type BitcoinPurchase {
bitcoinAmount: Money!
bitcoinPurchaseId: BitcoinPurchaseId!
createdAt: Timestamp!
customer: Customer
destinationBtcDepositAccountId: DepositAccountId!
eventHistory(
after: String
first: Int!
): EventTimelineEntryConnection!
fiatAmount: Money!
publicId: PublicId!
sourceFiatDepositAccountId: DepositAccountId!
spotRateAsOf: Timestamp!
spotRateFiatPerBtc: Decimal!
spread: Decimal!
}
Fields
BitcoinPurchase.bitcoinAmount ● Money! non-null object
BitcoinPurchase.bitcoinPurchaseId ● BitcoinPurchaseId! non-null scalar
BitcoinPurchase.createdAt ● Timestamp! non-null scalar
BitcoinPurchase.customer ● Customer object
BitcoinPurchase.destinationBtcDepositAccountId ● DepositAccountId! non-null scalar
BitcoinPurchase.eventHistory ● EventTimelineEntryConnection! non-null object
BitcoinPurchase.eventHistory.after ● String scalar
BitcoinPurchase.eventHistory.first ● Int! non-null scalar
BitcoinPurchase.fiatAmount ● Money! non-null object
BitcoinPurchase.publicId ● PublicId! non-null scalar
BitcoinPurchase.sourceFiatDepositAccountId ● DepositAccountId! non-null scalar
BitcoinPurchase.spotRateAsOf ● Timestamp! non-null scalar
BitcoinPurchase.spotRateFiatPerBtc ● Decimal! non-null scalar
BitcoinPurchase.spread ● Decimal! non-null scalar
Returned By
bitcoinPurchase query
Member Of
BitcoinPurchaseConnection object ● BitcoinPurchaseEdge object ● BitcoinPurchaseExecutePayloadSuccess object ● CustomerBitcoinPurchaseExecuted object
BitcoinPurchaseConnection
No description
type BitcoinPurchaseConnection {
edges: [BitcoinPurchaseEdge!]!
nodes: [BitcoinPurchase!]!
pageInfo: PageInfo!
}
Fields
BitcoinPurchaseConnection.edges ● [BitcoinPurchaseEdge!]! non-null object
A list of edges.
BitcoinPurchaseConnection.nodes ● [BitcoinPurchase!]! non-null object
A list of nodes.
BitcoinPurchaseConnection.pageInfo ● PageInfo! non-null object
Information to aid in pagination.
Returned By
bitcoinPurchases query
BitcoinPurchaseEdge
An edge in a connection.
type BitcoinPurchaseEdge {
cursor: String!
node: BitcoinPurchase!
}
Fields
BitcoinPurchaseEdge.cursor ● String! non-null scalar
A cursor for use in pagination
BitcoinPurchaseEdge.node ● BitcoinPurchase! non-null object
The item at the end of the edge
Member Of
BitcoinPurchaseConnection object
BitcoinPurchaseExecutePayloadError
No description
type BitcoinPurchaseExecutePayloadError {
code: BitcoinPurchaseExecuteErrorCode!
}
Fields
BitcoinPurchaseExecutePayloadError.code ● BitcoinPurchaseExecuteErrorCode! non-null enum
Implemented By
BitcoinPurchaseExecutePayload union
BitcoinPurchaseExecutePayloadSuccess
No description
type BitcoinPurchaseExecutePayloadSuccess {
bitcoinPurchase: BitcoinPurchase!
}
Fields
BitcoinPurchaseExecutePayloadSuccess.bitcoinPurchase ● BitcoinPurchase! non-null object
Implemented By
BitcoinPurchaseExecutePayload union
BuildInfo
No description
type BuildInfo {
buildProfile: String!
buildTarget: String!
enabledFeatures: [String!]!
version: String!
}
Fields
BuildInfo.buildProfile ● String! non-null scalar
BuildInfo.buildTarget ● String! non-null scalar
BuildInfo.enabledFeatures ● [String!]! non-null scalar
BuildInfo.version ● String! non-null scalar
Returned By
buildInfo query
CancelledWithdrawalEntry
No description
type CancelledWithdrawalEntry {
recordedAt: Timestamp!
withdrawal: Withdrawal!
}
Fields
CancelledWithdrawalEntry.recordedAt ● Timestamp! non-null scalar
CancelledWithdrawalEntry.withdrawal ● Withdrawal! non-null object
Implemented By
DepositAccountHistoryEntry union
ChartIntegrationBinding
No description
type ChartIntegrationBinding {
parentAccountSetId: LedgerAccountId!
parentCode: AccountCode!
}
Fields
ChartIntegrationBinding.parentAccountSetId ● LedgerAccountId! non-null scalar
ChartIntegrationBinding.parentCode ● AccountCode! non-null scalar
Member Of
CreditAccountingIntegration object ● CreditDefaultedReceivableParents object ● CreditIncomeParents object ● CreditOmnibusParents object ● CreditOperationalSummaryParents object ● CreditReceivableParents object ● DepositBalanceStateParents object ● DepositOmnibusIntegration object
ChartNode
No description
type ChartNode {
accountCode: AccountCode!
manualTransactionsPossible: Boolean!
name: String!
parentAccountCode: AccountCode
}
Fields
ChartNode.accountCode ● AccountCode! non-null scalar
ChartNode.manualTransactionsPossible ● Boolean! non-null scalar
Whether manual transactions can be posted to this account (leaf nodes only).
ChartNode.name ● String! non-null scalar
ChartNode.parentAccountCode ● AccountCode scalar
Root nodes have no parent, so this is None for top-level accounts.
Returned By
descendantAccountSetsByCategory query
Member Of
ChartOfAccounts object
ChartOfAccounts
No description
type ChartOfAccounts {
accountingBaseConfig: AccountingBaseConfigOutput
chartOfAccountsId: ChartOfAccountsId!
name: String!
nodes: [ChartNode!]!
}
Fields
ChartOfAccounts.accountingBaseConfig ● AccountingBaseConfigOutput object
ChartOfAccounts.chartOfAccountsId ● ChartOfAccountsId! non-null scalar
ChartOfAccounts.name ● String! non-null scalar
ChartOfAccounts.nodes ● [ChartNode!]! non-null object
Returned By
chartOfAccounts query
Member Of
ChartOfAccountsAddChildNodePayloadSuccess object ● ChartOfAccountsInitializePayloadSuccess object
ChartOfAccountsAddChildNodePayloadError
No description
type ChartOfAccountsAddChildNodePayloadError {
code: ChartOfAccountsAddChildNodeErrorCode!
}
Fields
ChartOfAccountsAddChildNodePayloadError.code ● ChartOfAccountsAddChildNodeErrorCode! non-null enum
Implemented By
ChartOfAccountsAddChildNodePayload union
ChartOfAccountsAddChildNodePayloadSuccess
No description
type ChartOfAccountsAddChildNodePayloadSuccess {
chartOfAccounts: ChartOfAccounts!
}
Fields
ChartOfAccountsAddChildNodePayloadSuccess.chartOfAccounts ● ChartOfAccounts! non-null object
Implemented By
ChartOfAccountsAddChildNodePayload union
ChartOfAccountsInitializePayloadError
No description
type ChartOfAccountsInitializePayloadError {
code: ChartOfAccountsInitializeErrorCode!
}
Fields
ChartOfAccountsInitializePayloadError.code ● ChartOfAccountsInitializeErrorCode! non-null enum
Implemented By
ChartOfAccountsInitializePayload union
ChartOfAccountsInitializePayloadSuccess
No description
type ChartOfAccountsInitializePayloadSuccess {
chartOfAccounts: ChartOfAccounts!
}
Fields
ChartOfAccountsInitializePayloadSuccess.chartOfAccounts ● ChartOfAccounts! non-null object
Implemented By
ChartOfAccountsInitializePayload union
Collateral
No description
type Collateral {
account: LedgerAccount
accountId: LedgerAccountId!
collateralId: CollateralId!
creditFacility: CreditFacility
eventHistory(
after: String
first: Int!
): EventTimelineEntryConnection!
walletId: WalletId
}
Fields
Collateral.account ● LedgerAccount object
Collateral.accountId ● LedgerAccountId! non-null scalar
Collateral.collateralId ● CollateralId! non-null scalar
Collateral.creditFacility ● CreditFacility object
Collateral.eventHistory ● EventTimelineEntryConnection! non-null object
Collateral.eventHistory.after ● String scalar
Collateral.eventHistory.first ● Int! non-null scalar
Collateral.walletId ● WalletId scalar
Member Of
CollateralRecordLiquidationSalePayloadSuccess object ● CollateralRecordSentToLiquidationPayloadSuccess object ● CollateralUpdatePayloadSuccess object ● Liquidation object
Implemented By
LedgerAccountEntity union
CollateralRecordLiquidationSalePayloadError
No description
type CollateralRecordLiquidationSalePayloadError {
code: CollateralRecordLiquidationSaleErrorCode!
}
Fields
CollateralRecordLiquidationSalePayloadError.code ● CollateralRecordLiquidationSaleErrorCode! non-null enum
Implemented By
CollateralRecordLiquidationSalePayload union
CollateralRecordLiquidationSalePayloadSuccess
No description
type CollateralRecordLiquidationSalePayloadSuccess {
collateral: Collateral!
}
Fields
CollateralRecordLiquidationSalePayloadSuccess.collateral ● Collateral! non-null object
Implemented By
CollateralRecordLiquidationSalePayload union
CollateralRecordSentToLiquidationPayloadError
No description
type CollateralRecordSentToLiquidationPayloadError {
code: CollateralRecordSentToLiquidationErrorCode!
}
Fields
CollateralRecordSentToLiquidationPayloadError.code ● CollateralRecordSentToLiquidationErrorCode! non-null enum
Implemented By
CollateralRecordSentToLiquidationPayload union
CollateralRecordSentToLiquidationPayloadSuccess
No description
type CollateralRecordSentToLiquidationPayloadSuccess {
collateral: Collateral!
}
Fields
CollateralRecordSentToLiquidationPayloadSuccess.collateral ● Collateral! non-null object
Implemented By
CollateralRecordSentToLiquidationPayload union
CollateralUpdatePayloadError
No description
type CollateralUpdatePayloadError {
code: CollateralUpdateErrorCode!
}
Fields
CollateralUpdatePayloadError.code ● CollateralUpdateErrorCode! non-null enum
Implemented By
CollateralUpdatePayload union
CollateralUpdatePayloadSuccess
No description
type CollateralUpdatePayloadSuccess {
collateral: Collateral!
}
Fields
CollateralUpdatePayloadSuccess.collateral ● Collateral! non-null object
Implemented By
CollateralUpdatePayload union
Committee
No description
type Committee {
committeeId: CommitteeId!
createdAt: Timestamp!
currentMembers: [User!]
eventHistory(
after: String
first: Int!
): EventTimelineEntryConnection!
name: String!
}
Fields
Committee.committeeId ● CommitteeId! non-null scalar
Committee.createdAt ● Timestamp! non-null scalar
Committee.currentMembers ● [User!] list object
Committee.eventHistory ● EventTimelineEntryConnection! non-null object
Committee.eventHistory.after ● String scalar
Committee.eventHistory.first ● Int! non-null scalar
Committee.name ● String! non-null scalar
Returned By
committee query
Member Of
CommitteeApproval object ● CommitteeConnection object ● CommitteeCreatePayloadSuccess object ● CommitteeEdge object ● CommitteeUserAddPayloadSuccess object ● CommitteeUserRemovePayloadSuccess object
CommitteeApproval
No description
type CommitteeApproval {
committee: Committee
}
Fields
CommitteeApproval.committee ● Committee object
Implemented By
ApprovalRules union
CommitteeConnection
No description
type CommitteeConnection {
edges: [CommitteeEdge!]!
nodes: [Committee!]!
pageInfo: PageInfo!
}
Fields
CommitteeConnection.edges ● [CommitteeEdge!]! non-null object
A list of edges.
CommitteeConnection.nodes ● [Committee!]! non-null object
A list of nodes.
CommitteeConnection.pageInfo ● PageInfo! non-null object
Information to aid in pagination.
Returned By
committees query
CommitteeCreatePayloadError
No description
type CommitteeCreatePayloadError {
code: CommitteeCreateErrorCode!
}
Fields
CommitteeCreatePayloadError.code ● CommitteeCreateErrorCode! non-null enum
Implemented By
CommitteeCreatePayload union
CommitteeCreatePayloadSuccess
No description
type CommitteeCreatePayloadSuccess {
committee: Committee!
}
Fields
CommitteeCreatePayloadSuccess.committee ● Committee! non-null object
Implemented By
CommitteeCreatePayload union
CommitteeEdge
An edge in a connection.
type CommitteeEdge {
cursor: String!
node: Committee!
}
Fields
CommitteeEdge.cursor ● String! non-null scalar
A cursor for use in pagination
CommitteeEdge.node ● Committee! non-null object
The item at the end of the edge
Member Of
CommitteeConnection object
CommitteeUserAddPayloadError
No description
type CommitteeUserAddPayloadError {
code: CommitteeUserAddErrorCode!
}
Fields
CommitteeUserAddPayloadError.code ● CommitteeUserAddErrorCode! non-null enum
Implemented By
CommitteeUserAddPayload union
CommitteeUserAddPayloadSuccess
No description
type CommitteeUserAddPayloadSuccess {
committee: Committee!
}
Fields
CommitteeUserAddPayloadSuccess.committee ● Committee! non-null object
Implemented By
CommitteeUserAddPayload union
CommitteeUserRemovePayloadError
No description
type CommitteeUserRemovePayloadError {
code: CommitteeUserRemoveErrorCode!
}
Fields
CommitteeUserRemovePayloadError.code ● CommitteeUserRemoveErrorCode! non-null enum
Implemented By
CommitteeUserRemovePayload union
CommitteeUserRemovePayloadSuccess
No description
type CommitteeUserRemovePayloadSuccess {
committee: Committee!
}
Fields
CommitteeUserRemovePayloadSuccess.committee ● Committee! non-null object
Implemented By
CommitteeUserRemovePayload union
CreditAccountingIntegration
No description
type CreditAccountingIntegration {
chartOfAccountsId: ChartOfAccountsId!
income: CreditIncomeParents!
lendingIntents: [CreditLendingIntentIntegration!]!
omnibus: CreditOmnibusParents!
operationalSummary: CreditOperationalSummaryParents!
paymentHolding: ChartIntegrationBinding!
}
Fields
CreditAccountingIntegration.chartOfAccountsId ● ChartOfAccountsId! non-null scalar
CreditAccountingIntegration.income ● CreditIncomeParents! non-null object
CreditAccountingIntegration.lendingIntents ● [CreditLendingIntentIntegration!]! non-null object
CreditAccountingIntegration.omnibus ● CreditOmnibusParents! non-null object
CreditAccountingIntegration.operationalSummary ● CreditOperationalSummaryParents! non-null object
CreditAccountingIntegration.paymentHolding ● ChartIntegrationBinding! non-null object
Returned By
creditAccountingIntegration query
Member Of
CreditAccountingIntegrationConfigurePayloadSuccess object
CreditAccountingIntegrationConfigurePayloadError
No description
type CreditAccountingIntegrationConfigurePayloadError {
code: CreditAccountingIntegrationConfigureErrorCode!
}
Fields
CreditAccountingIntegrationConfigurePayloadError.code ● CreditAccountingIntegrationConfigureErrorCode! non-null enum
Implemented By
CreditAccountingIntegrationConfigurePayload union
CreditAccountingIntegrationConfigurePayloadSuccess
No description
type CreditAccountingIntegrationConfigurePayloadSuccess {
creditAccountingIntegration: CreditAccountingIntegration!
}
Fields
CreditAccountingIntegrationConfigurePayloadSuccess.creditAccountingIntegration ● CreditAccountingIntegration! non-null object
Implemented By
CreditAccountingIntegrationConfigurePayload union
CreditCurrencyPolicy
No description
type CreditCurrencyPolicy {
functional: Currency!
supportedCollateral: [Currency!]!
supportedFacility: [Currency!]!
}
Fields
CreditCurrencyPolicy.functional ● Currency! non-null object
CreditCurrencyPolicy.supportedCollateral ● [Currency!]! non-null object
CreditCurrencyPolicy.supportedFacility ● [Currency!]! non-null object
Returned By
creditCurrencyPolicy query
Member Of
CreditCurrencyPolicyConfigurePayloadSuccess object
CreditCurrencyPolicyConfigurePayloadError
No description
type CreditCurrencyPolicyConfigurePayloadError {
code: CreditCurrencyPolicyConfigureErrorCode!
}
Fields
CreditCurrencyPolicyConfigurePayloadError.code ● CreditCurrencyPolicyConfigureErrorCode! non-null enum
Implemented By
CreditCurrencyPolicyConfigurePayload union
CreditCurrencyPolicyConfigurePayloadSuccess
No description
type CreditCurrencyPolicyConfigurePayloadSuccess {
creditCurrencyPolicy: CreditCurrencyPolicy!
}
Fields
CreditCurrencyPolicyConfigurePayloadSuccess.creditCurrencyPolicy ● CreditCurrencyPolicy! non-null object
Implemented By
CreditCurrencyPolicyConfigurePayload union
CreditCustomerIntegration
No description
type CreditCustomerIntegration {
customerType: CustomerType!
functional: CreditReceivableParents!
nonFunctional: CreditReceivableParents!
}
Fields
CreditCustomerIntegration.customerType ● CustomerType! non-null enum
CreditCustomerIntegration.functional ● CreditReceivableParents! non-null object
CreditCustomerIntegration.nonFunctional ● CreditReceivableParents! non-null object
Member Of
CreditLendingIntentIntegration object
CreditDefaultedReceivableParents
No description
type CreditDefaultedReceivableParents {
disbursed: ChartIntegrationBinding!
interest: ChartIntegrationBinding!
}
Fields
CreditDefaultedReceivableParents.disbursed ● ChartIntegrationBinding! non-null object
CreditDefaultedReceivableParents.interest ● ChartIntegrationBinding! non-null object
Member Of
CreditDefaultedReceivables object
CreditDefaultedReceivables
No description
type CreditDefaultedReceivables {
functional: CreditDefaultedReceivableParents!
nonFunctional: CreditDefaultedReceivableParents!
}
Fields
CreditDefaultedReceivables.functional ● CreditDefaultedReceivableParents! non-null object
CreditDefaultedReceivables.nonFunctional ● CreditDefaultedReceivableParents! non-null object
Member Of
CreditLendingIntentIntegration object
CreditFacility
No description
type CreditFacility {
activatedAt: Timestamp!
balance: CreditFacilityBalance!
canBeCompleted: Boolean!
collateralCurrency: Currency!
collateralId: CollateralId!
collateralizationState: CollateralizationState!
createdAt: Timestamp!
creditFacilityId: CreditFacilityId!
creditFacilityTerms: TermValues!
currentLtv: LtvPct!
custodian: Custodian
customer: Customer
disbursals: [CreditFacilityDisbursal!]!
eventHistory(
after: String
first: Int!
): EventTimelineEntryConnection!
facilityAmount: Money!
history: [CreditFacilityHistoryEntry!]!
ledgerAccounts: CreditFacilityLedgerAccounts!
liquidations: [Liquidation!]!
maturityDate: AccountingDate!
product: CreditFacilityProduct
productId: CreditFacilityProductId!
publicId: PublicId!
repaymentPlan: [CreditFacilityRepaymentPlanEntry!]
status: CreditFacilityStatus!
userCanComplete: Boolean!
userCanInitiateDisbursal: Boolean!
userCanRecordPayment: Boolean!
userCanRecordPaymentWithDate: Boolean!
userCanUpdateCollateral: Boolean!
wallet: Wallet
}
Fields
CreditFacility.activatedAt ● Timestamp! non-null scalar
CreditFacility.balance ● CreditFacilityBalance! non-null object
CreditFacility.canBeCompleted ● Boolean! non-null scalar
CreditFacility.collateralCurrency ● Currency! non-null object
CreditFacility.collateralId ● CollateralId! non-null scalar
CreditFacility.collateralizationState ● CollateralizationState! non-null enum
CreditFacility.createdAt ● Timestamp! non-null scalar
CreditFacility.creditFacilityId ● CreditFacilityId! non-null scalar
CreditFacility.creditFacilityTerms ● TermValues! non-null object
CreditFacility.currentLtv ● LtvPct! non-null union
CreditFacility.custodian ● Custodian object
CreditFacility.customer ● Customer object
CreditFacility.disbursals ● [CreditFacilityDisbursal!]! non-null object
CreditFacility.eventHistory ● EventTimelineEntryConnection! non-null object
CreditFacility.eventHistory.after ● String scalar
CreditFacility.eventHistory.first ● Int! non-null scalar
CreditFacility.facilityAmount ● Money! non-null object
CreditFacility.history ● [CreditFacilityHistoryEntry!]! non-null union
CreditFacility.ledgerAccounts ● CreditFacilityLedgerAccounts! non-null object
CreditFacility.liquidations ● [Liquidation!]! non-null object
CreditFacility.maturityDate ● AccountingDate! non-null scalar
CreditFacility.product ● CreditFacilityProduct object
CreditFacility.productId ● CreditFacilityProductId! non-null scalar
CreditFacility.publicId ● PublicId! non-null scalar
CreditFacility.repaymentPlan ● [CreditFacilityRepaymentPlanEntry!] list object
CreditFacility.status ● CreditFacilityStatus! non-null enum
CreditFacility.userCanComplete ● Boolean! non-null scalar
CreditFacility.userCanInitiateDisbursal ● Boolean! non-null scalar
CreditFacility.userCanRecordPayment ● Boolean! non-null scalar
CreditFacility.userCanRecordPaymentWithDate ● Boolean! non-null scalar
CreditFacility.userCanUpdateCollateral ● Boolean! non-null scalar
CreditFacility.wallet ● Wallet object
Returned By
creditFacility query ● creditFacilityByPublicId query ● creditFacilityUpdated subscription
Member Of
Collateral object ● CreditFacilityCompletePayloadSuccess object ● CreditFacilityConnection object ● CreditFacilityDisbursal object ● CreditFacilityEdge object ● CreditFacilityPartialPaymentRecordPayloadSuccess object ● CreditFacilityPaymentAllocation object ● Customer object ● CustomerCreditFacilityActivated object ● CustomerCreditFacilityCompleted object ● CustomerCreditFacilityMatured object ● Obligation object
Implemented By
LedgerAccountEntity union ● PublicIdTarget union
CreditFacilityAgreement
No description
type CreditFacilityAgreement {
createdAt: Timestamp!
creditFacilityAgreementId: CreditFacilityAgreementId!
status: CreditFacilityAgreementStatus!
}
Fields
CreditFacilityAgreement.createdAt ● Timestamp! non-null scalar
CreditFacilityAgreement.creditFacilityAgreementId ● CreditFacilityAgreementId! non-null scalar
CreditFacilityAgreement.status ● CreditFacilityAgreementStatus! non-null enum
Returned By
creditFacilityAgreement query
Member Of
CreditFacilityAgreementGeneratePayloadSuccess object
CreditFacilityAgreementDownloadLinksGeneratePayload
No description
type CreditFacilityAgreementDownloadLinksGeneratePayload {
link: Url!
}
Fields
CreditFacilityAgreementDownloadLinksGeneratePayload.link ● Url! non-null scalar
Returned By
creditFacilityAgreementDownloadLinkGenerate mutation
CreditFacilityAgreementGeneratePayloadError
No description
type CreditFacilityAgreementGeneratePayloadError {
code: CreditFacilityAgreementGenerateErrorCode!
}
Fields
CreditFacilityAgreementGeneratePayloadError.code ● CreditFacilityAgreementGenerateErrorCode! non-null enum
Implemented By
CreditFacilityAgreementGeneratePayload union
CreditFacilityAgreementGeneratePayloadSuccess
No description
type CreditFacilityAgreementGeneratePayloadSuccess {
creditFacilityAgreement: CreditFacilityAgreement!
}
Fields
CreditFacilityAgreementGeneratePayloadSuccess.creditFacilityAgreement ● CreditFacilityAgreement! non-null object
Implemented By
CreditFacilityAgreementGeneratePayload union
CreditFacilityApproved
No description
type CreditFacilityApproved {
amount: Money!
effective: AccountingDate!
ledgerTransactionId: LedgerTransactionId!
recordedAt: Timestamp!
}
Fields
CreditFacilityApproved.amount ● Money! non-null object
CreditFacilityApproved.effective ● AccountingDate! non-null scalar
CreditFacilityApproved.ledgerTransactionId ● LedgerTransactionId! non-null scalar
CreditFacilityApproved.recordedAt ● Timestamp! non-null scalar
Implemented By
CreditFacilityHistoryEntry union
CreditFacilityBalance
No description
type CreditFacilityBalance {
collateral: Money!
disbursed: Disbursed!
dueOutstanding: Money!
facilityRemaining: Money!
interest: Interest!
outstanding: Money!
outstandingPayable: Money!
paymentsUnapplied: Money!
}
Fields
CreditFacilityBalance.collateral ● Money! non-null object
CreditFacilityBalance.disbursed ● Disbursed! non-null object
CreditFacilityBalance.dueOutstanding ● Money! non-null object
CreditFacilityBalance.facilityRemaining ● Money! non-null object
CreditFacilityBalance.interest ● Interest! non-null object
CreditFacilityBalance.outstanding ● Money! non-null object
CreditFacilityBalance.outstandingPayable ● Money! non-null object
CreditFacilityBalance.paymentsUnapplied ● Money! non-null object
Member Of
CreditFacility object
CreditFacilityCollateralizationUpdated
No description
type CreditFacilityCollateralizationUpdated {
collateral: Money!
effective: AccountingDate!
exchangeRate: Money!
liquidationId: LiquidationId
outstandingDisbursal: Money!
outstandingInterest: Money!
recordedAt: Timestamp!
state: CollateralizationState!
}
Fields
CreditFacilityCollateralizationUpdated.collateral ● Money! non-null object
CreditFacilityCollateralizationUpdated.effective ● AccountingDate! non-null scalar
CreditFacilityCollateralizationUpdated.exchangeRate ● Money! non-null object
CreditFacilityCollateralizationUpdated.liquidationId ● LiquidationId scalar
CreditFacilityCollateralizationUpdated.outstandingDisbursal ● Money! non-null object
CreditFacilityCollateralizationUpdated.outstandingInterest ● Money! non-null object
CreditFacilityCollateralizationUpdated.recordedAt ● Timestamp! non-null scalar
CreditFacilityCollateralizationUpdated.state ● CollateralizationState! non-null enum
Implemented By
CreditFacilityHistoryEntry union
CreditFacilityCollateralSentOut
No description
type CreditFacilityCollateralSentOut {
amount: Money!
effective: AccountingDate!
ledgerTransactionId: LedgerTransactionId!
recordedAt: Timestamp!
}
Fields
CreditFacilityCollateralSentOut.amount ● Money! non-null object
CreditFacilityCollateralSentOut.effective ● AccountingDate! non-null scalar
CreditFacilityCollateralSentOut.ledgerTransactionId ● LedgerTransactionId! non-null scalar
CreditFacilityCollateralSentOut.recordedAt ● Timestamp! non-null scalar
Implemented By
CreditFacilityHistoryEntry union
CreditFacilityCollateralUpdated
No description
type CreditFacilityCollateralUpdated {
amount: Money!
effective: AccountingDate!
recordedAt: Timestamp!
}
Fields
CreditFacilityCollateralUpdated.amount ● Money! non-null object
CreditFacilityCollateralUpdated.effective ● AccountingDate! non-null scalar
CreditFacilityCollateralUpdated.recordedAt ● Timestamp! non-null scalar
Implemented By
CreditFacilityHistoryEntry union
CreditFacilityCompletePayloadError
No description
type CreditFacilityCompletePayloadError {
code: CreditFacilityCompleteErrorCode!
}
Fields
CreditFacilityCompletePayloadError.code ● CreditFacilityCompleteErrorCode! non-null enum
Implemented By
CreditFacilityCompletePayload union
CreditFacilityCompletePayloadSuccess
No description
type CreditFacilityCompletePayloadSuccess {
creditFacility: CreditFacility!
}
Fields
CreditFacilityCompletePayloadSuccess.creditFacility ● CreditFacility! non-null object
Implemented By
CreditFacilityCompletePayload union
CreditFacilityConnection
No description
type CreditFacilityConnection {
edges: [CreditFacilityEdge!]!
nodes: [CreditFacility!]!
pageInfo: PageInfo!
}
Fields
CreditFacilityConnection.edges ● [CreditFacilityEdge!]! non-null object
A list of edges.
CreditFacilityConnection.nodes ● [CreditFacility!]! non-null object
A list of nodes.
CreditFacilityConnection.pageInfo ● PageInfo! non-null object
Information to aid in pagination.
Returned By
creditFacilities query
CreditFacilityDisbursal
No description
type CreditFacilityDisbursal {
amount: Money!
approvalProcess: ApprovalProcess
createdAt: Timestamp!
creditFacility: CreditFacility
creditFacilityDisbursalId: CreditFacilityDisbursalId!
eventHistory(
after: String
first: Int!
): EventTimelineEntryConnection!
ledgerTransactions: [LedgerTransaction!]
publicId: PublicId!
status: DisbursalStatus!
}
Fields
CreditFacilityDisbursal.amount ● Money! non-null object
CreditFacilityDisbursal.approvalProcess ● ApprovalProcess object
CreditFacilityDisbursal.createdAt ● Timestamp! non-null scalar
CreditFacilityDisbursal.creditFacility ● CreditFacility object
CreditFacilityDisbursal.creditFacilityDisbursalId ● CreditFacilityDisbursalId! non-null scalar
CreditFacilityDisbursal.eventHistory ● EventTimelineEntryConnection! non-null object
CreditFacilityDisbursal.eventHistory.after ● String scalar
CreditFacilityDisbursal.eventHistory.first ● Int! non-null scalar
CreditFacilityDisbursal.ledgerTransactions ● [LedgerTransaction!] list object
CreditFacilityDisbursal.publicId ● PublicId! non-null scalar
CreditFacilityDisbursal.status ● DisbursalStatus! non-null enum
Returned By
disbursal query ● disbursalByPublicId query ● disbursalUpdated subscription
Member Of
CreditFacility object ● CreditFacilityDisbursalConnection object ● CreditFacilityDisbursalEdge object ● CreditFacilityDisbursalInitiatePayloadSuccess object ● DisbursalEntry object
Implemented By
ApprovalProcessTarget union ● LedgerTransactionEntity union ● PublicIdTarget union
CreditFacilityDisbursalConnection
No description
type CreditFacilityDisbursalConnection {
edges: [CreditFacilityDisbursalEdge!]!
nodes: [CreditFacilityDisbursal!]!
pageInfo: PageInfo!
}
Fields
CreditFacilityDisbursalConnection.edges ● [CreditFacilityDisbursalEdge!]! non-null object
A list of edges.
CreditFacilityDisbursalConnection.nodes ● [CreditFacilityDisbursal!]! non-null object
A list of nodes.
CreditFacilityDisbursalConnection.pageInfo ● PageInfo! non-null object
Information to aid in pagination.
Returned By
disbursals query
CreditFacilityDisbursalEdge
An edge in a connection.
type CreditFacilityDisbursalEdge {
cursor: String!
node: CreditFacilityDisbursal!
}
Fields
CreditFacilityDisbursalEdge.cursor ● String! non-null scalar
A cursor for use in pagination
CreditFacilityDisbursalEdge.node ● CreditFacilityDisbursal! non-null object
The item at the end of the edge
Member Of
CreditFacilityDisbursalConnection object
CreditFacilityDisbursalExecuted
No description
type CreditFacilityDisbursalExecuted {
amount: Money!
effective: AccountingDate!
ledgerTransactionId: LedgerTransactionId!
recordedAt: Timestamp!
}
Fields
CreditFacilityDisbursalExecuted.amount ● Money! non-null object
CreditFacilityDisbursalExecuted.effective ● AccountingDate! non-null scalar
CreditFacilityDisbursalExecuted.ledgerTransactionId ● LedgerTransactionId! non-null scalar
CreditFacilityDisbursalExecuted.recordedAt ● Timestamp! non-null scalar
Implemented By
CreditFacilityHistoryEntry union
CreditFacilityDisbursalInitiatePayloadError
No description
type CreditFacilityDisbursalInitiatePayloadError {
code: CreditFacilityDisbursalInitiateErrorCode!
}
Fields
CreditFacilityDisbursalInitiatePayloadError.code ● CreditFacilityDisbursalInitiateErrorCode! non-null enum
Implemented By
CreditFacilityDisbursalInitiatePayload union
CreditFacilityDisbursalInitiatePayloadSuccess
No description
type CreditFacilityDisbursalInitiatePayloadSuccess {
creditFacilityDisbursal: CreditFacilityDisbursal!
}
Fields
CreditFacilityDisbursalInitiatePayloadSuccess.creditFacilityDisbursal ● CreditFacilityDisbursal! non-null object
Implemented By
CreditFacilityDisbursalInitiatePayload union
CreditFacilityEdge
An edge in a connection.
type CreditFacilityEdge {
cursor: String!
node: CreditFacility!
}
Fields
CreditFacilityEdge.cursor ● String! non-null scalar
A cursor for use in pagination
CreditFacilityEdge.node ● CreditFacility! non-null object
The item at the end of the edge
Member Of
CreditFacilityConnection object
CreditFacilityIncrementalPayment
No description
type CreditFacilityIncrementalPayment {
amount: Money!
effective: AccountingDate!
paymentAllocationId: PaymentAllocationId!
recordedAt: Timestamp!
}
Fields
CreditFacilityIncrementalPayment.amount ● Money! non-null object
CreditFacilityIncrementalPayment.effective ● AccountingDate! non-null scalar
CreditFacilityIncrementalPayment.paymentAllocationId ● PaymentAllocationId! non-null scalar
CreditFacilityIncrementalPayment.recordedAt ● Timestamp! non-null scalar
Implemented By
CreditFacilityHistoryEntry union
CreditFacilityInterestAccrued
No description
type CreditFacilityInterestAccrued {
amount: Money!
days: Int!
effective: AccountingDate!
ledgerTransactionId: LedgerTransactionId!
recordedAt: Timestamp!
}
Fields
CreditFacilityInterestAccrued.amount ● Money! non-null object
CreditFacilityInterestAccrued.days ● Int! non-null scalar
CreditFacilityInterestAccrued.effective ● AccountingDate! non-null scalar
CreditFacilityInterestAccrued.ledgerTransactionId ● LedgerTransactionId! non-null scalar
CreditFacilityInterestAccrued.recordedAt ● Timestamp! non-null scalar
Implemented By
CreditFacilityHistoryEntry union
CreditFacilityLedgerAccounts
No description
type CreditFacilityLedgerAccounts {
collateralAccount: LedgerAccount
collateralInLiquidationAccount: LedgerAccount
disbursedDefaultedAccount: LedgerAccount
disbursedReceivableDueAccount: LedgerAccount
disbursedReceivableNotYetDueAccount: LedgerAccount
disbursedReceivableOverdueAccount: LedgerAccount
facilityAccount: LedgerAccount
feeIncomeAccount: LedgerAccount
interestDefaultedAccount: LedgerAccount
interestIncomeAccount: LedgerAccount
interestReceivableDueAccount: LedgerAccount
interestReceivableNotYetDueAccount: LedgerAccount
interestReceivableOverdueAccount: LedgerAccount
paymentHoldingAccount: LedgerAccount
proceedsFromLiquidationAccount: LedgerAccount
uncoveredOutstandingAccount: LedgerAccount
}
Fields
CreditFacilityLedgerAccounts.collateralAccount ● LedgerAccount object
CreditFacilityLedgerAccounts.collateralInLiquidationAccount ● LedgerAccount object
CreditFacilityLedgerAccounts.disbursedDefaultedAccount ● LedgerAccount object
CreditFacilityLedgerAccounts.disbursedReceivableDueAccount ● LedgerAccount object
CreditFacilityLedgerAccounts.disbursedReceivableNotYetDueAccount ● LedgerAccount object
CreditFacilityLedgerAccounts.disbursedReceivableOverdueAccount ● LedgerAccount object
CreditFacilityLedgerAccounts.facilityAccount ● LedgerAccount object
CreditFacilityLedgerAccounts.feeIncomeAccount ● LedgerAccount object
CreditFacilityLedgerAccounts.interestDefaultedAccount ● LedgerAccount object
CreditFacilityLedgerAccounts.interestIncomeAccount ● LedgerAccount object
CreditFacilityLedgerAccounts.interestReceivableDueAccount ● LedgerAccount object
CreditFacilityLedgerAccounts.interestReceivableNotYetDueAccount ● LedgerAccount object
CreditFacilityLedgerAccounts.interestReceivableOverdueAccount ● LedgerAccount object
CreditFacilityLedgerAccounts.paymentHoldingAccount ● LedgerAccount object
CreditFacilityLedgerAccounts.proceedsFromLiquidationAccount ● LedgerAccount object
CreditFacilityLedgerAccounts.uncoveredOutstandingAccount ● LedgerAccount object
Member Of
CreditFacility object
CreditFacilityLiquidationSaleRecorded
No description
type CreditFacilityLiquidationSaleRecorded {
effective: AccountingDate!
ledgerTransactionId: LedgerTransactionId!
netProceeds: Money!
recordedAt: Timestamp!
}
Fields
CreditFacilityLiquidationSaleRecorded.effective ● AccountingDate! non-null scalar
CreditFacilityLiquidationSaleRecorded.ledgerTransactionId ● LedgerTransactionId! non-null scalar
CreditFacilityLiquidationSaleRecorded.netProceeds ● Money! non-null object
CreditFacilityLiquidationSaleRecorded.recordedAt ● Timestamp! non-null scalar
Implemented By
CreditFacilityHistoryEntry union
CreditFacilityPartialPaymentRecordPayloadError
No description
type CreditFacilityPartialPaymentRecordPayloadError {
code: CreditFacilityPartialPaymentRecordErrorCode!
}
Fields
CreditFacilityPartialPaymentRecordPayloadError.code ● CreditFacilityPartialPaymentRecordErrorCode! non-null enum
Implemented By
CreditFacilityPartialPaymentRecordPayload union
CreditFacilityPartialPaymentRecordPayloadSuccess
No description
type CreditFacilityPartialPaymentRecordPayloadSuccess {
creditFacility: CreditFacility!
}
Fields
CreditFacilityPartialPaymentRecordPayloadSuccess.creditFacility ● CreditFacility! non-null object
Implemented By
CreditFacilityPartialPaymentRecordPayload union
CreditFacilityPaymentAllocation
No description
type CreditFacilityPaymentAllocation {
amount: Money!
createdAt: Timestamp!
creditFacility: CreditFacility!
creditFacilityPaymentAllocationId: CreditFacilityPaymentAllocationId!
eventHistory(
after: String
first: Int!
): EventTimelineEntryConnection!
}
Fields
CreditFacilityPaymentAllocation.amount ● Money! non-null object
CreditFacilityPaymentAllocation.createdAt ● Timestamp! non-null scalar
CreditFacilityPaymentAllocation.creditFacility ● CreditFacility! non-null object
CreditFacilityPaymentAllocation.creditFacilityPaymentAllocationId ● CreditFacilityPaymentAllocationId! non-null scalar
CreditFacilityPaymentAllocation.eventHistory ● EventTimelineEntryConnection! non-null object
CreditFacilityPaymentAllocation.eventHistory.after ● String scalar
CreditFacilityPaymentAllocation.eventHistory.first ● Int! non-null scalar
Member Of
PaymentEntry object
CreditFacilityProduct
No description
type CreditFacilityProduct {
accountingConfig: CreditFacilityProductAccountingConfig!
createdAt: Timestamp!
creditFacilityProductId: CreditFacilityProductId!
customerType: CustomerType!
name: String!
partner: Partner
partnerId: PartnerId!
status: CreditFacilityProductStatus!
terms: VersionedCreditFacilityProductTerms!
userCanUpdateCreditFacilityProduct: Boolean!
}
Fields
CreditFacilityProduct.accountingConfig ● CreditFacilityProductAccountingConfig! non-null object
CreditFacilityProduct.createdAt ● Timestamp! non-null scalar
CreditFacilityProduct.creditFacilityProductId ● CreditFacilityProductId! non-null scalar
CreditFacilityProduct.customerType ● CustomerType! non-null enum
CreditFacilityProduct.name ● String! non-null scalar
CreditFacilityProduct.partner ● Partner object
CreditFacilityProduct.partnerId ● PartnerId! non-null scalar
CreditFacilityProduct.status ● CreditFacilityProductStatus! non-null enum
CreditFacilityProduct.terms ● VersionedCreditFacilityProductTerms! non-null object
CreditFacilityProduct.userCanUpdateCreditFacilityProduct ● Boolean! non-null scalar
Returned By
creditFacilityProduct query
Member Of
CreditFacility object ● CreditFacilityProductConnection object ● CreditFacilityProductCreatePayloadSuccess object ● CreditFacilityProductEdge object ● CreditFacilityProductUpdateStatusPayloadSuccess object ● CreditFacilityProductUpdateTermsPayloadSuccess object ● CreditFacilityProposal object ● Customer object ● PendingCreditFacility object
CreditFacilityProductAccountingConfig
No description
type CreditFacilityProductAccountingConfig {
chartOfAccountsId: ChartOfAccountsId!
lendingIntents: [CreditFacilityProductLendingIntentAccounting!]!
omnibus: CreditFacilityProductOmnibusAccounting!
summary: CreditFacilityProductSummaryAccounting!
}
Fields
CreditFacilityProductAccountingConfig.chartOfAccountsId ● ChartOfAccountsId! non-null scalar
CreditFacilityProductAccountingConfig.lendingIntents ● [CreditFacilityProductLendingIntentAccounting!]! non-null object
CreditFacilityProductAccountingConfig.omnibus ● CreditFacilityProductOmnibusAccounting! non-null object
CreditFacilityProductAccountingConfig.summary ● CreditFacilityProductSummaryAccounting! non-null object
Member Of
CreditFacilityProduct object
CreditFacilityProductConnection
No description
type CreditFacilityProductConnection {
edges: [CreditFacilityProductEdge!]!
nodes: [CreditFacilityProduct!]!
pageInfo: PageInfo!
}
Fields
CreditFacilityProductConnection.edges ● [CreditFacilityProductEdge!]! non-null object
A list of edges.
CreditFacilityProductConnection.nodes ● [CreditFacilityProduct!]! non-null object
A list of nodes.
CreditFacilityProductConnection.pageInfo ● PageInfo! non-null object
Information to aid in pagination.
Returned By
creditFacilityProducts query
CreditFacilityProductCreatePayloadError
No description
type CreditFacilityProductCreatePayloadError {
code: CreditFacilityProductCreateErrorCode!
}
Fields
CreditFacilityProductCreatePayloadError.code ● CreditFacilityProductCreateErrorCode! non-null enum
Implemented By
CreditFacilityProductCreatePayload union
CreditFacilityProductCreatePayloadSuccess
No description
type CreditFacilityProductCreatePayloadSuccess {
creditFacilityProduct: CreditFacilityProduct!
}
Fields
CreditFacilityProductCreatePayloadSuccess.creditFacilityProduct ● CreditFacilityProduct! non-null object
Implemented By
CreditFacilityProductCreatePayload union
CreditFacilityProductDefaultedReceivableAccounting
No description
type CreditFacilityProductDefaultedReceivableAccounting {
disbursed: CreditFacilityProductSetAttachment!
interest: CreditFacilityProductSetAttachment!
}
Fields
CreditFacilityProductDefaultedReceivableAccounting.disbursed ● CreditFacilityProductSetAttachment! non-null object
CreditFacilityProductDefaultedReceivableAccounting.interest ● CreditFacilityProductSetAttachment! non-null object
Member Of
CreditFacilityProductDefaultedReceivableCurrencyAccounting object
CreditFacilityProductDefaultedReceivableCurrencyAccounting
No description
type CreditFacilityProductDefaultedReceivableCurrencyAccounting {
functional: CreditFacilityProductDefaultedReceivableAccounting!
nonFunctional: CreditFacilityProductDefaultedReceivableAccounting!
}
Fields
CreditFacilityProductDefaultedReceivableCurrencyAccounting.functional ● CreditFacilityProductDefaultedReceivableAccounting! non-null object
CreditFacilityProductDefaultedReceivableCurrencyAccounting.nonFunctional ● CreditFacilityProductDefaultedReceivableAccounting! non-null object
Member Of
CreditFacilityProductLendingIntentAccounting object
CreditFacilityProductEdge
An edge in a connection.
type CreditFacilityProductEdge {
cursor: String!
node: CreditFacilityProduct!
}
Fields
CreditFacilityProductEdge.cursor ● String! non-null scalar
A cursor for use in pagination
CreditFacilityProductEdge.node ● CreditFacilityProduct! non-null object
The item at the end of the edge
Member Of
CreditFacilityProductConnection object
CreditFacilityProductLendingIntentAccounting
No description
type CreditFacilityProductLendingIntentAccounting {
defaultedReceivables: CreditFacilityProductDefaultedReceivableCurrencyAccounting!
lendingIntent: LendingIntent!
receivables: CreditFacilityProductReceivableCurrencyAccounting!
}
Fields
CreditFacilityProductLendingIntentAccounting.defaultedReceivables ● CreditFacilityProductDefaultedReceivableCurrencyAccounting! non-null object
CreditFacilityProductLendingIntentAccounting.lendingIntent ● LendingIntent! non-null enum
CreditFacilityProductLendingIntentAccounting.receivables ● CreditFacilityProductReceivableCurrencyAccounting! non-null object
Member Of
CreditFacilityProductAccountingConfig object
CreditFacilityProductOmnibusAccounting
No description
type CreditFacilityProductOmnibusAccounting {
collateral: CreditFacilityProductOmnibusAttachment!
facility: CreditFacilityProductOmnibusAttachment!
interestAddedToObligations: CreditFacilityProductOmnibusAttachment!
liquidationProceeds: CreditFacilityProductOmnibusAttachment!
paymentsMade: CreditFacilityProductOmnibusAttachment!
}
Fields
CreditFacilityProductOmnibusAccounting.collateral ● CreditFacilityProductOmnibusAttachment! non-null object
CreditFacilityProductOmnibusAccounting.facility ● CreditFacilityProductOmnibusAttachment! non-null object
CreditFacilityProductOmnibusAccounting.interestAddedToObligations ● CreditFacilityProductOmnibusAttachment! non-null object
CreditFacilityProductOmnibusAccounting.liquidationProceeds ● CreditFacilityProductOmnibusAttachment! non-null object
CreditFacilityProductOmnibusAccounting.paymentsMade ● CreditFacilityProductOmnibusAttachment! non-null object
Member Of
CreditFacilityProductAccountingConfig object
CreditFacilityProductOmnibusAttachment
No description
type CreditFacilityProductOmnibusAttachment {
accountId: LedgerAccountId!
accountSetId: LedgerAccountId!
parentAccountSetId: LedgerAccountId!
parentCode: AccountCode!
}
Fields
CreditFacilityProductOmnibusAttachment.accountId ● LedgerAccountId! non-null scalar
CreditFacilityProductOmnibusAttachment.accountSetId ● LedgerAccountId! non-null scalar
CreditFacilityProductOmnibusAttachment.parentAccountSetId ● LedgerAccountId! non-null scalar
CreditFacilityProductOmnibusAttachment.parentCode ● AccountCode! non-null scalar
Member Of
CreditFacilityProductOmnibusAccounting object ● CreditFacilityProductSummaryAccounting object
CreditFacilityProductReceivableAccounting
No description
type CreditFacilityProductReceivableAccounting {
longTermDisbursed: CreditFacilityProductSetAttachment!
longTermInterest: CreditFacilityProductSetAttachment!
overdueDisbursed: CreditFacilityProductSetAttachment!
overdueInterest: CreditFacilityProductSetAttachment!
shortTermDisbursed: CreditFacilityProductSetAttachment!
shortTermInterest: CreditFacilityProductSetAttachment!
}
Fields
CreditFacilityProductReceivableAccounting.longTermDisbursed ● CreditFacilityProductSetAttachment! non-null object
CreditFacilityProductReceivableAccounting.longTermInterest ● CreditFacilityProductSetAttachment! non-null object
CreditFacilityProductReceivableAccounting.overdueDisbursed ● CreditFacilityProductSetAttachment! non-null object
CreditFacilityProductReceivableAccounting.overdueInterest ● CreditFacilityProductSetAttachment! non-null object
CreditFacilityProductReceivableAccounting.shortTermDisbursed ● CreditFacilityProductSetAttachment! non-null object
CreditFacilityProductReceivableAccounting.shortTermInterest ● CreditFacilityProductSetAttachment! non-null object
Member Of
CreditFacilityProductReceivableCurrencyAccounting object
CreditFacilityProductReceivableCurrencyAccounting
No description
type CreditFacilityProductReceivableCurrencyAccounting {
functional: CreditFacilityProductReceivableAccounting!
nonFunctional: CreditFacilityProductReceivableAccounting!
}
Fields
CreditFacilityProductReceivableCurrencyAccounting.functional ● CreditFacilityProductReceivableAccounting! non-null object
CreditFacilityProductReceivableCurrencyAccounting.nonFunctional ● CreditFacilityProductReceivableAccounting! non-null object
Member Of
CreditFacilityProductLendingIntentAccounting object
CreditFacilityProductSetAttachment
No description
type CreditFacilityProductSetAttachment {
accountSetId: LedgerAccountId!
parentAccountSetId: LedgerAccountId!
parentCode: AccountCode!
}
Fields
CreditFacilityProductSetAttachment.accountSetId ● LedgerAccountId! non-null scalar
CreditFacilityProductSetAttachment.parentAccountSetId ● LedgerAccountId! non-null scalar
CreditFacilityProductSetAttachment.parentCode ● AccountCode! non-null scalar
Member Of
CreditFacilityProductDefaultedReceivableAccounting object ● CreditFacilityProductReceivableAccounting object ● CreditFacilityProductSummaryAccounting object
CreditFacilityProductSummaryAccounting
No description
type CreditFacilityProductSummaryAccounting {
collateral: CreditFacilityProductSetAttachment!
collateralInLiquidation: CreditFacilityProductSetAttachment!
facility: CreditFacilityProductSetAttachment!
feeIncome: CreditFacilityProductSetAttachment!
interestIncome: CreditFacilityProductOmnibusAttachment!
paymentHolding: CreditFacilityProductSetAttachment!
proceedsFromLiquidation: CreditFacilityProductSetAttachment!
uncoveredOutstanding: CreditFacilityProductSetAttachment!
}
Fields
CreditFacilityProductSummaryAccounting.collateral ● CreditFacilityProductSetAttachment! non-null object
CreditFacilityProductSummaryAccounting.collateralInLiquidation ● CreditFacilityProductSetAttachment! non-null object
CreditFacilityProductSummaryAccounting.facility ● CreditFacilityProductSetAttachment! non-null object
CreditFacilityProductSummaryAccounting.feeIncome ● CreditFacilityProductSetAttachment! non-null object
CreditFacilityProductSummaryAccounting.interestIncome ● CreditFacilityProductOmnibusAttachment! non-null object
CreditFacilityProductSummaryAccounting.paymentHolding ● CreditFacilityProductSetAttachment! non-null object
CreditFacilityProductSummaryAccounting.proceedsFromLiquidation ● CreditFacilityProductSetAttachment! non-null object
CreditFacilityProductSummaryAccounting.uncoveredOutstanding ● CreditFacilityProductSetAttachment! non-null object
Member Of
CreditFacilityProductAccountingConfig object
CreditFacilityProductUpdateStatusPayloadError
No description
type CreditFacilityProductUpdateStatusPayloadError {
code: CreditFacilityProductUpdateStatusErrorCode!
}
Fields
CreditFacilityProductUpdateStatusPayloadError.code ● CreditFacilityProductUpdateStatusErrorCode! non-null enum
Implemented By
CreditFacilityProductUpdateStatusPayload union
CreditFacilityProductUpdateStatusPayloadSuccess
No description
type CreditFacilityProductUpdateStatusPayloadSuccess {
creditFacilityProduct: CreditFacilityProduct!
}
Fields
CreditFacilityProductUpdateStatusPayloadSuccess.creditFacilityProduct ● CreditFacilityProduct! non-null object
Implemented By
CreditFacilityProductUpdateStatusPayload union
CreditFacilityProductUpdateTermsPayloadError
No description
type CreditFacilityProductUpdateTermsPayloadError {
code: CreditFacilityProductUpdateTermsErrorCode!
}
Fields
CreditFacilityProductUpdateTermsPayloadError.code ● CreditFacilityProductUpdateTermsErrorCode! non-null enum
Implemented By
CreditFacilityProductUpdateTermsPayload union
CreditFacilityProductUpdateTermsPayloadSuccess
No description
type CreditFacilityProductUpdateTermsPayloadSuccess {
creditFacilityProduct: CreditFacilityProduct!
}
Fields
CreditFacilityProductUpdateTermsPayloadSuccess.creditFacilityProduct ● CreditFacilityProduct! non-null object
Implemented By
CreditFacilityProductUpdateTermsPayload union
CreditFacilityProposal
No description
type CreditFacilityProposal {
approvalProcess: ApprovalProcess
approvalProcessId: ApprovalProcessId
collateralCurrency: Currency!
createdAt: Timestamp!
creditFacilityProposalId: CreditFacilityProposalId!
custodian: Custodian
customer: Customer
effectiveTerms: TermValues!
eventHistory(
after: String
first: Int!
): EventTimelineEntryConnection!
facilityAmount: Money!
product: CreditFacilityProduct
productId: CreditFacilityProductId!
productTerms: VersionedCreditFacilityProductTerms!
repaymentPlan: [CreditFacilityRepaymentPlanEntry!]!
status: CreditFacilityProposalStatus!
termsAlterations: [CreditFacilityTermsAlteration!]!
}
Fields
CreditFacilityProposal.approvalProcess ● ApprovalProcess object
CreditFacilityProposal.approvalProcessId ● ApprovalProcessId scalar
CreditFacilityProposal.collateralCurrency ● Currency! non-null object
CreditFacilityProposal.createdAt ● Timestamp! non-null scalar
CreditFacilityProposal.creditFacilityProposalId ● CreditFacilityProposalId! non-null scalar
CreditFacilityProposal.custodian ● Custodian object
CreditFacilityProposal.customer ● Customer object
CreditFacilityProposal.effectiveTerms ● TermValues! non-null object
CreditFacilityProposal.eventHistory ● EventTimelineEntryConnection! non-null object
CreditFacilityProposal.eventHistory.after ● String scalar
CreditFacilityProposal.eventHistory.first ● Int! non-null scalar
CreditFacilityProposal.facilityAmount ● Money! non-null object
CreditFacilityProposal.product ● CreditFacilityProduct object
CreditFacilityProposal.productId ● CreditFacilityProductId! non-null scalar
CreditFacilityProposal.productTerms ● VersionedCreditFacilityProductTerms! non-null object
CreditFacilityProposal.repaymentPlan ● [CreditFacilityRepaymentPlanEntry!]! non-null object
CreditFacilityProposal.status ● CreditFacilityProposalStatus! non-null enum
CreditFacilityProposal.termsAlterations ● [CreditFacilityTermsAlteration!]! non-null object
Returned By
creditFacilityProposal query ● creditFacilityProposalUpdated subscription
Member Of
CreditFacilityProposalConnection object ● CreditFacilityProposalCreatePayloadSuccess object ● CreditFacilityProposalCustomerApprovalConcludePayloadSuccess object ● CreditFacilityProposalEdge object ● Customer object ● CustomerCreditFacilityProposalApproved object ● CustomerCreditFacilityProposalCreated object ● CustomerCreditFacilityProposalDenied object
Implemented By
ApprovalProcessTarget union
CreditFacilityProposalConnection
No description
type CreditFacilityProposalConnection {
edges: [CreditFacilityProposalEdge!]!
nodes: [CreditFacilityProposal!]!
pageInfo: PageInfo!
}
Fields
CreditFacilityProposalConnection.edges ● [CreditFacilityProposalEdge!]! non-null object
A list of edges.
CreditFacilityProposalConnection.nodes ● [CreditFacilityProposal!]! non-null object
A list of nodes.
CreditFacilityProposalConnection.pageInfo ● PageInfo! non-null object
Information to aid in pagination.
Returned By
creditFacilityProposals query
CreditFacilityProposalCreatePayloadError
No description
type CreditFacilityProposalCreatePayloadError {
code: CreditFacilityProposalCreateErrorCode!
}
Fields
CreditFacilityProposalCreatePayloadError.code ● CreditFacilityProposalCreateErrorCode! non-null enum
Implemented By
CreditFacilityProposalCreatePayload union
CreditFacilityProposalCreatePayloadSuccess
No description
type CreditFacilityProposalCreatePayloadSuccess {
creditFacilityProposal: CreditFacilityProposal!
}
Fields
CreditFacilityProposalCreatePayloadSuccess.creditFacilityProposal ● CreditFacilityProposal! non-null object
Implemented By
CreditFacilityProposalCreatePayload union
CreditFacilityProposalCustomerApprovalConcludePayloadError
No description
type CreditFacilityProposalCustomerApprovalConcludePayloadError {
code: CreditFacilityProposalCustomerApprovalConcludeErrorCode!
}
Fields
CreditFacilityProposalCustomerApprovalConcludePayloadError.code ● CreditFacilityProposalCustomerApprovalConcludeErrorCode! non-null enum
Implemented By
CreditFacilityProposalCustomerApprovalConcludePayload union
CreditFacilityProposalCustomerApprovalConcludePayloadSuccess
No description
type CreditFacilityProposalCustomerApprovalConcludePayloadSuccess {
creditFacilityProposal: CreditFacilityProposal!
}
Fields
CreditFacilityProposalCustomerApprovalConcludePayloadSuccess.creditFacilityProposal ● CreditFacilityProposal! non-null object
Implemented By
CreditFacilityProposalCustomerApprovalConcludePayload union
CreditFacilityProposalEdge
An edge in a connection.
type CreditFacilityProposalEdge {
cursor: String!
node: CreditFacilityProposal!
}
Fields
CreditFacilityProposalEdge.cursor ● String! non-null scalar
A cursor for use in pagination
CreditFacilityProposalEdge.node ● CreditFacilityProposal! non-null object
The item at the end of the edge
Member Of
CreditFacilityProposalConnection object
CreditFacilityRepaymentPlanEntry
No description
type CreditFacilityRepaymentPlanEntry {
accrualAt: Timestamp!
dueAt: AccountingDate!
initial: Money!
outstanding: Money!
repaymentType: CreditFacilityRepaymentType!
status: CreditFacilityRepaymentStatus!
}
Fields
CreditFacilityRepaymentPlanEntry.accrualAt ● Timestamp! non-null scalar
CreditFacilityRepaymentPlanEntry.dueAt ● AccountingDate! non-null scalar
CreditFacilityRepaymentPlanEntry.initial ● Money! non-null object
CreditFacilityRepaymentPlanEntry.outstanding ● Money! non-null object
CreditFacilityRepaymentPlanEntry.repaymentType ● CreditFacilityRepaymentType! non-null enum
CreditFacilityRepaymentPlanEntry.status ● CreditFacilityRepaymentStatus! non-null enum
Member Of
CreditFacility object ● CreditFacilityProposal object ● PendingCreditFacility object
CreditFacilityTermsAlteration
No description
type CreditFacilityTermsAlteration {
accrualCycleInterval: InterestInterval
annualRate: AnnualRatePct
disbursalPolicy: DisbursalPolicy
duration: Duration
initialLtvLimit: LtvPct
interestDueDurationFromAccrual: Duration
liquidationLtvLimit: LtvPct
marginCallLtvLimit: LtvPct
obligationDefaultedDurationFromDue: Duration
obligationLiquidationDurationFromDue: Duration
obligationOverdueDurationFromDue: Duration
oneTimeFeeRate: OneTimeFeeRatePct
}
Fields
CreditFacilityTermsAlteration.accrualCycleInterval ● InterestInterval enum
CreditFacilityTermsAlteration.annualRate ● AnnualRatePct scalar
CreditFacilityTermsAlteration.disbursalPolicy ● DisbursalPolicy enum
CreditFacilityTermsAlteration.duration ● Duration object
CreditFacilityTermsAlteration.initialLtvLimit ● LtvPct union
CreditFacilityTermsAlteration.interestDueDurationFromAccrual ● Duration object
CreditFacilityTermsAlteration.liquidationLtvLimit ● LtvPct union
CreditFacilityTermsAlteration.marginCallLtvLimit ● LtvPct union
CreditFacilityTermsAlteration.obligationDefaultedDurationFromDue ● Duration object
CreditFacilityTermsAlteration.obligationLiquidationDurationFromDue ● Duration object
CreditFacilityTermsAlteration.obligationOverdueDurationFromDue ● Duration object
CreditFacilityTermsAlteration.oneTimeFeeRate ● OneTimeFeeRatePct scalar
Member Of
CreditFacilityProposal object
CreditIncomeParents
No description
type CreditIncomeParents {
fee: ChartIntegrationBinding!
interest: ChartIntegrationBinding!
}
Fields
CreditIncomeParents.fee ● ChartIntegrationBinding! non-null object
CreditIncomeParents.interest ● ChartIntegrationBinding! non-null object
Member Of
CreditAccountingIntegration object
CreditLendingIntentIntegration
No description
type CreditLendingIntentIntegration {
customerIntegrations: [CreditCustomerIntegration!]!
defaultedReceivables: CreditDefaultedReceivables!
lendingIntent: LendingIntent!
}
Fields
CreditLendingIntentIntegration.customerIntegrations ● [CreditCustomerIntegration!]! non-null object
CreditLendingIntentIntegration.defaultedReceivables ● CreditDefaultedReceivables! non-null object
CreditLendingIntentIntegration.lendingIntent ● LendingIntent! non-null enum
Member Of
CreditAccountingIntegration object
CreditOmnibusParents
No description
type CreditOmnibusParents {
collateral: ChartIntegrationBinding!
facility: ChartIntegrationBinding!
interestAddedToObligations: ChartIntegrationBinding!
liquidationProceeds: ChartIntegrationBinding!
paymentsMade: ChartIntegrationBinding!
}
Fields
CreditOmnibusParents.collateral ● ChartIntegrationBinding! non-null object
CreditOmnibusParents.facility ● ChartIntegrationBinding! non-null object
CreditOmnibusParents.interestAddedToObligations ● ChartIntegrationBinding! non-null object
CreditOmnibusParents.liquidationProceeds ● ChartIntegrationBinding! non-null object
CreditOmnibusParents.paymentsMade ● ChartIntegrationBinding! non-null object
Member Of
CreditAccountingIntegration object
CreditOperationalSummaryParents
No description
type CreditOperationalSummaryParents {
collateral: ChartIntegrationBinding!
collateralInLiquidation: ChartIntegrationBinding!
facilityRemaining: ChartIntegrationBinding!
proceedsFromLiquidation: ChartIntegrationBinding!
uncoveredOutstanding: ChartIntegrationBinding!
}
Fields
CreditOperationalSummaryParents.collateral ● ChartIntegrationBinding! non-null object
CreditOperationalSummaryParents.collateralInLiquidation ● ChartIntegrationBinding! non-null object
CreditOperationalSummaryParents.facilityRemaining ● ChartIntegrationBinding! non-null object
CreditOperationalSummaryParents.proceedsFromLiquidation ● ChartIntegrationBinding! non-null object
CreditOperationalSummaryParents.uncoveredOutstanding ● ChartIntegrationBinding! non-null object
Member Of
CreditAccountingIntegration object
CreditReceivableParents
No description
type CreditReceivableParents {
longTermDisbursed: ChartIntegrationBinding!
longTermInterest: ChartIntegrationBinding!
overdueDisbursed: ChartIntegrationBinding!
overdueInterest: ChartIntegrationBinding!
shortTermDisbursed: ChartIntegrationBinding!
shortTermInterest: ChartIntegrationBinding!
}
Fields
CreditReceivableParents.longTermDisbursed ● ChartIntegrationBinding! non-null object
CreditReceivableParents.longTermInterest ● ChartIntegrationBinding! non-null object
CreditReceivableParents.overdueDisbursed ● ChartIntegrationBinding! non-null object
CreditReceivableParents.overdueInterest ● ChartIntegrationBinding! non-null object
CreditReceivableParents.shortTermDisbursed ● ChartIntegrationBinding! non-null object
CreditReceivableParents.shortTermInterest ● ChartIntegrationBinding! non-null object
Member Of
CreditCustomerIntegration object
Currency
No description
type Currency {
code: CurrencyCode!
isFiat: Boolean!
minorUnitsPerMajor: Int!
}
Fields
Currency.code ● CurrencyCode! non-null scalar
Currency.isFiat ● Boolean! non-null scalar
Currency.minorUnitsPerMajor ● Int! non-null scalar
Member Of
AccountingCurrencyPolicy object ● CreditCurrencyPolicy object ● CreditFacility object ● CreditFacilityProposal object ● CurrencyPair object ● DepositAccount object ● DepositAccountProduct object ● DepositCurrencyPolicy object ● LedgerAccountBalance object ● LedgerAccountBalanceRange object ● Money object ● PendingCreditFacility object ● SignedMoney object
CurrencyPair
No description
type CurrencyPair {
base: Currency!
quote: Currency!
}
Fields
CurrencyPair.base ● Currency! non-null object
CurrencyPair.quote ● Currency! non-null object
Member Of
ExchangeRate object ● ExchangeRateProvider object
CurrencyVariant
No description
type CurrencyVariant {
code: CurrencyCode!
qualifier: String!
}
Fields
CurrencyVariant.code ● CurrencyCode! non-null scalar
CurrencyVariant.qualifier ● String! non-null scalar
Member Of
PaymentProvider object ● PayoutDestination object ● RailCurrency object
Custodian
No description
type Custodian {
createdAt: Timestamp!
custodianId: CustodianId!
name: String!
provider: String!
}
Fields
Custodian.createdAt ● Timestamp! non-null scalar
Custodian.custodianId ● CustodianId! non-null scalar
Custodian.name ● String! non-null scalar
Custodian.provider ● String! non-null scalar
Returned By
custodian query
Member Of
CreditFacility object ● CreditFacilityProposal object ● CustodianConfigUpdatePayloadSuccess object ● CustodianConnection object ● CustodianCreatePayloadSuccess object ● CustodianEdge object ● PendingCreditFacility object ● Wallet object
CustodianConfigUpdatePayloadError
No description
type CustodianConfigUpdatePayloadError {
code: CustodianConfigUpdateErrorCode!
}
Fields
CustodianConfigUpdatePayloadError.code ● CustodianConfigUpdateErrorCode! non-null enum
Implemented By
CustodianConfigUpdatePayload union
CustodianConfigUpdatePayloadSuccess
No description
type CustodianConfigUpdatePayloadSuccess {
custodian: Custodian!
}
Fields
CustodianConfigUpdatePayloadSuccess.custodian ● Custodian! non-null object
Implemented By
CustodianConfigUpdatePayload union
CustodianConnection
No description
type CustodianConnection {
edges: [CustodianEdge!]!
nodes: [Custodian!]!
pageInfo: PageInfo!
}
Fields
CustodianConnection.edges ● [CustodianEdge!]! non-null object
A list of edges.
CustodianConnection.nodes ● [Custodian!]! non-null object
A list of nodes.
CustodianConnection.pageInfo ● PageInfo! non-null object
Information to aid in pagination.
Returned By
custodians query
CustodianCreatePayloadError
No description
type CustodianCreatePayloadError {
code: CustodianCreateErrorCode!
}
Fields
CustodianCreatePayloadError.code ● CustodianCreateErrorCode! non-null enum
Implemented By
CustodianCreatePayload union
CustodianCreatePayloadSuccess
No description
type CustodianCreatePayloadSuccess {
custodian: Custodian!
}
Fields
CustodianCreatePayloadSuccess.custodian ● Custodian! non-null object
Implemented By
CustodianCreatePayload union
CustodianEdge
An edge in a connection.
type CustodianEdge {
cursor: String!
node: Custodian!
}
Fields
CustodianEdge.cursor ● String! non-null scalar
A cursor for use in pagination
CustodianEdge.node ● Custodian! non-null object
The item at the end of the edge
Member Of
CustodianConnection object
Customer
No description
type Customer {
createdAt: Timestamp!
creditFacilities: [CreditFacility!]!
creditFacilityProductsForProposalCreation: [CreditFacilityProduct!]!
creditFacilityProposals: [CreditFacilityProposal!]!
customerId: CustomerId!
depositAccountProductsForAccountCreation: [DepositAccountProduct!]!
depositAccounts: [DepositAccount!]
documents: [CustomerDocument!]!
eventHistory(
after: String
first: Int!
): EventTimelineEntryConnection!
level: KycLevel!
notes(
after: String
first: Int!
): NoteConnection!
partner: Partner
partnerId: PartnerId!
party: Party
pendingCreditFacilities: [PendingCreditFacility!]!
piiErasureProcess: PiiErasureProcess
publicId: PublicId!
status: CustomerStatus!
timeline(
after: String
first: Int!
): CustomerTimelineEntryConnection!
userCanCancelPiiErasure: Boolean!
userCanCreateCreditFacility: Boolean!
userCanSchedulePiiErasure: Boolean!
}
Fields
Customer.createdAt ● Timestamp! non-null scalar
Customer.creditFacilities ● [CreditFacility!]! non-null object
Customer.creditFacilityProductsForProposalCreation ● [CreditFacilityProduct!]! non-null object
Customer.creditFacilityProposals ● [CreditFacilityProposal!]! non-null object
Customer.customerId ● CustomerId! non-null scalar
Customer.depositAccountProductsForAccountCreation ● [DepositAccountProduct!]! non-null object
Customer.depositAccounts ● [DepositAccount!] list object
Customer.documents ● [CustomerDocument!]! non-null object
Customer.eventHistory ● EventTimelineEntryConnection! non-null object
Customer.eventHistory.after ● String scalar
Customer.eventHistory.first ● Int! non-null scalar
Customer.level ● KycLevel! non-null enum
Customer.notes ● NoteConnection! non-null object
Customer.notes.after ● String scalar
Customer.notes.first ● Int! non-null scalar
Customer.partner ● Partner object
Customer.partnerId ● PartnerId! non-null scalar
Customer.party ● Party union
Customer.pendingCreditFacilities ● [PendingCreditFacility!]! non-null object
Customer.piiErasureProcess ● PiiErasureProcess object
The customer's PII erasure process: the scheduled or in-progress run, or the completed one that erased its PII. Cancelled runs are not surfaced.
Requires the PII erasure viewer permission. Resolves to null when the subject lacks it — regardless of whether a process exists, so existence is not disclosed — which keeps customer queries that select this field usable for non-viewers.
Customer.publicId ● PublicId! non-null scalar
Customer.status ● CustomerStatus! non-null enum
Customer.timeline ● CustomerTimelineEntryConnection! non-null object
Customer.timeline.after ● String scalar
Customer.timeline.first ● Int! non-null scalar
Customer.userCanCancelPiiErasure ● Boolean! non-null scalar
Customer.userCanCreateCreditFacility ● Boolean! non-null scalar
Customer.userCanSchedulePiiErasure ● Boolean! non-null scalar
Returned By
customer query ● customerByPublicId query ● customerCreditFacilitiesUpdated subscription ● customerCreditFacilityProposalsUpdated subscription ● customerDepositAccountsUpdated subscription ● customerPendingCreditFacilitiesUpdated subscription ● customerUpdated subscription
Member Of
BitcoinPurchase object ● CreditFacility object ● CreditFacilityProposal object ● CustomerClosePayloadSuccess object ● CustomerConnection object ● CustomerEdge object ● CustomerFreezePayloadSuccess object ● CustomerUnfreezePayloadSuccess object ● DepositAccount object ● Obligation object ● PendingCreditFacility object ● Prospect object
Implemented By
AuditSubject union ● PiiErasureSubject union ● PublicIdTarget union
CustomerBitcoinPurchaseExecuted
No description
type CustomerBitcoinPurchaseExecuted {
bitcoinPurchase: BitcoinPurchase
bitcoinPurchaseId: BitcoinPurchaseId!
recordedAt: Timestamp!
}
Fields
CustomerBitcoinPurchaseExecuted.bitcoinPurchase ● BitcoinPurchase object
CustomerBitcoinPurchaseExecuted.bitcoinPurchaseId ● BitcoinPurchaseId! non-null scalar
CustomerBitcoinPurchaseExecuted.recordedAt ● Timestamp! non-null scalar
Implemented By
CustomerTimelineEntry union
CustomerClosed
No description
type CustomerClosed {
reason: String
recordedAt: Timestamp!
}
Fields
CustomerClosed.reason ● String scalar
CustomerClosed.recordedAt ● Timestamp! non-null scalar
Implemented By
CustomerTimelineEntry union
CustomerClosePayloadError
No description
type CustomerClosePayloadError {
code: CustomerCloseErrorCode!
}
Fields
CustomerClosePayloadError.code ● CustomerCloseErrorCode! non-null enum
Implemented By
CustomerClosePayload union
CustomerClosePayloadSuccess
No description
type CustomerClosePayloadSuccess {
customer: Customer!
}
Fields
CustomerClosePayloadSuccess.customer ● Customer! non-null object
Implemented By
CustomerClosePayload union
CustomerCollateralLiquidationStarted
No description
type CustomerCollateralLiquidationStarted {
liquidation: Liquidation
liquidationId: LiquidationId!
recordedAt: Timestamp!
}
Fields
CustomerCollateralLiquidationStarted.liquidation ● Liquidation object
CustomerCollateralLiquidationStarted.liquidationId ● LiquidationId! non-null scalar
CustomerCollateralLiquidationStarted.recordedAt ● Timestamp! non-null scalar
Implemented By
CustomerTimelineEntry union
CustomerConnection
No description
type CustomerConnection {
edges: [CustomerEdge!]!
nodes: [Customer!]!
pageInfo: PageInfo!
}
Fields
CustomerConnection.edges ● [CustomerEdge!]! non-null object
A list of edges.
CustomerConnection.nodes ● [Customer!]! non-null object
A list of nodes.
CustomerConnection.pageInfo ● PageInfo! non-null object
Information to aid in pagination.
Returned By
customers query
CustomerCreated
No description
type CustomerCreated {
recordedAt: Timestamp!
}
Fields
CustomerCreated.recordedAt ● Timestamp! non-null scalar
Implemented By
CustomerTimelineEntry union
CustomerCreditFacilityActivated
No description
type CustomerCreditFacilityActivated {
creditFacility: CreditFacility
creditFacilityId: CreditFacilityId!
recordedAt: Timestamp!
}
Fields
CustomerCreditFacilityActivated.creditFacility ● CreditFacility object
CustomerCreditFacilityActivated.creditFacilityId ● CreditFacilityId! non-null scalar
CustomerCreditFacilityActivated.recordedAt ● Timestamp! non-null scalar
Implemented By
CustomerTimelineEntry union
CustomerCreditFacilityCompleted
No description
type CustomerCreditFacilityCompleted {
creditFacility: CreditFacility
creditFacilityId: CreditFacilityId!
recordedAt: Timestamp!
}
Fields
CustomerCreditFacilityCompleted.creditFacility ● CreditFacility object
CustomerCreditFacilityCompleted.creditFacilityId ● CreditFacilityId! non-null scalar
CustomerCreditFacilityCompleted.recordedAt ● Timestamp! non-null scalar
Implemented By
CustomerTimelineEntry union
CustomerCreditFacilityMatured
No description
type CustomerCreditFacilityMatured {
creditFacility: CreditFacility
creditFacilityId: CreditFacilityId!
recordedAt: Timestamp!
}
Fields
CustomerCreditFacilityMatured.creditFacility ● CreditFacility object
CustomerCreditFacilityMatured.creditFacilityId ● CreditFacilityId! non-null scalar
CustomerCreditFacilityMatured.recordedAt ● Timestamp! non-null scalar
Implemented By
CustomerTimelineEntry union
CustomerCreditFacilityProposalApproved
No description
type CustomerCreditFacilityProposalApproved {
creditFacilityProposal: CreditFacilityProposal
creditFacilityProposalId: CreditFacilityProposalId!
recordedAt: Timestamp!
}
Fields
CustomerCreditFacilityProposalApproved.creditFacilityProposal ● CreditFacilityProposal object
CustomerCreditFacilityProposalApproved.creditFacilityProposalId ● CreditFacilityProposalId! non-null scalar
CustomerCreditFacilityProposalApproved.recordedAt ● Timestamp! non-null scalar
Implemented By
CustomerTimelineEntry union
CustomerCreditFacilityProposalCreated
No description
type CustomerCreditFacilityProposalCreated {
creditFacilityProposal: CreditFacilityProposal
creditFacilityProposalId: CreditFacilityProposalId!
recordedAt: Timestamp!
}
Fields
CustomerCreditFacilityProposalCreated.creditFacilityProposal ● CreditFacilityProposal object
CustomerCreditFacilityProposalCreated.creditFacilityProposalId ● CreditFacilityProposalId! non-null scalar
CustomerCreditFacilityProposalCreated.recordedAt ● Timestamp! non-null scalar
Implemented By
CustomerTimelineEntry union
CustomerCreditFacilityProposalDenied
No description
type CustomerCreditFacilityProposalDenied {
creditFacilityProposal: CreditFacilityProposal
creditFacilityProposalId: CreditFacilityProposalId!
recordedAt: Timestamp!
}
Fields
CustomerCreditFacilityProposalDenied.creditFacilityProposal ● CreditFacilityProposal object
CustomerCreditFacilityProposalDenied.creditFacilityProposalId ● CreditFacilityProposalId! non-null scalar
CustomerCreditFacilityProposalDenied.recordedAt ● Timestamp! non-null scalar
Implemented By
CustomerTimelineEntry union
CustomerDepositAccountClosed
No description
type CustomerDepositAccountClosed {
depositAccount: DepositAccount
depositAccountId: DepositAccountId!
recordedAt: Timestamp!
}
Fields
CustomerDepositAccountClosed.depositAccount ● DepositAccount object
CustomerDepositAccountClosed.depositAccountId ● DepositAccountId! non-null scalar
CustomerDepositAccountClosed.recordedAt ● Timestamp! non-null scalar
Implemented By
CustomerTimelineEntry union
CustomerDepositAccountEscheatable
No description
type CustomerDepositAccountEscheatable {
depositAccount: DepositAccount
depositAccountId: DepositAccountId!
recordedAt: Timestamp!
}
Fields
CustomerDepositAccountEscheatable.depositAccount ● DepositAccount object
CustomerDepositAccountEscheatable.depositAccountId ● DepositAccountId! non-null scalar
CustomerDepositAccountEscheatable.recordedAt ● Timestamp! non-null scalar
Implemented By
CustomerTimelineEntry union
CustomerDepositAccountFrozen
No description
type CustomerDepositAccountFrozen {
depositAccount: DepositAccount
depositAccountId: DepositAccountId!
recordedAt: Timestamp!
}
Fields
CustomerDepositAccountFrozen.depositAccount ● DepositAccount object
CustomerDepositAccountFrozen.depositAccountId ● DepositAccountId! non-null scalar
CustomerDepositAccountFrozen.recordedAt ● Timestamp! non-null scalar
Implemented By
CustomerTimelineEntry union
CustomerDepositAccountOpened
No description
type CustomerDepositAccountOpened {
depositAccount: DepositAccount
depositAccountId: DepositAccountId!
recordedAt: Timestamp!
}
Fields
CustomerDepositAccountOpened.depositAccount ● DepositAccount object
CustomerDepositAccountOpened.depositAccountId ● DepositAccountId! non-null scalar
CustomerDepositAccountOpened.recordedAt ● Timestamp! non-null scalar
Implemented By
CustomerTimelineEntry union
CustomerDepositAccountUnfrozen
No description
type CustomerDepositAccountUnfrozen {
depositAccount: DepositAccount
depositAccountId: DepositAccountId!
recordedAt: Timestamp!
}
Fields
CustomerDepositAccountUnfrozen.depositAccount ● DepositAccount object
CustomerDepositAccountUnfrozen.depositAccountId ● DepositAccountId! non-null scalar
CustomerDepositAccountUnfrozen.recordedAt ● Timestamp! non-null scalar
Implemented By
CustomerTimelineEntry union
CustomerDocument
No description
type CustomerDocument {
customerDocumentId: CustomerDocumentId!
customerId: CustomerId!
deletableAt: Timestamp!
eventHistory(
after: String
first: Int!
): EventTimelineEntryConnection!
filename: String!
status: DocumentStatus!
}
Fields
CustomerDocument.customerDocumentId ● CustomerDocumentId! non-null scalar
CustomerDocument.customerId ● CustomerId! non-null scalar
CustomerDocument.deletableAt ● Timestamp! non-null scalar
When the document becomes deletable under the bucket retention policy. Equals the creation time when no retention policy is configured — the document has always been deletable.
CustomerDocument.eventHistory ● EventTimelineEntryConnection! non-null object
CustomerDocument.eventHistory.after ● String scalar
CustomerDocument.eventHistory.first ● Int! non-null scalar
CustomerDocument.filename ● String! non-null scalar
CustomerDocument.status ● DocumentStatus! non-null enum
Returned By
customerDocument query
Member Of
Customer object ● CustomerDocumentArchived object ● CustomerDocumentArchivePayloadSuccess object ● CustomerDocumentCreated object ● CustomerDocumentCreateInlinePayloadSuccess object ● CustomerDocumentCreatePayloadSuccess object ● CustomerDocumentDeletionRequested object
CustomerDocumentArchived
No description
type CustomerDocumentArchived {
customerDocument: CustomerDocument
customerDocumentId: CustomerDocumentId!
recordedAt: Timestamp!
}
Fields
CustomerDocumentArchived.customerDocument ● CustomerDocument object
CustomerDocumentArchived.customerDocumentId ● CustomerDocumentId! non-null scalar
CustomerDocumentArchived.recordedAt ● Timestamp! non-null scalar
Implemented By
CustomerTimelineEntry union
CustomerDocumentArchivePayloadError
No description
type CustomerDocumentArchivePayloadError {
code: CustomerDocumentArchiveErrorCode!
}
Fields
CustomerDocumentArchivePayloadError.code ● CustomerDocumentArchiveErrorCode! non-null enum
Implemented By
CustomerDocumentArchivePayload union
CustomerDocumentArchivePayloadSuccess
No description
type CustomerDocumentArchivePayloadSuccess {
customerDocument: CustomerDocument!
}
Fields
CustomerDocumentArchivePayloadSuccess.customerDocument ● CustomerDocument! non-null object
Implemented By
CustomerDocumentArchivePayload union
CustomerDocumentCreated
No description
type CustomerDocumentCreated {
customerDocument: CustomerDocument
customerDocumentId: CustomerDocumentId!
recordedAt: Timestamp!
}
Fields
CustomerDocumentCreated.customerDocument ● CustomerDocument object
CustomerDocumentCreated.customerDocumentId ● CustomerDocumentId! non-null scalar
CustomerDocumentCreated.recordedAt ● Timestamp! non-null scalar
Implemented By
CustomerTimelineEntry union
CustomerDocumentCreateInlinePayloadError
No description
type CustomerDocumentCreateInlinePayloadError {
code: CustomerDocumentCreateInlineErrorCode!
}
Fields
CustomerDocumentCreateInlinePayloadError.code ● CustomerDocumentCreateInlineErrorCode! non-null enum
Implemented By
CustomerDocumentCreateInlinePayload union
CustomerDocumentCreateInlinePayloadSuccess
No description
type CustomerDocumentCreateInlinePayloadSuccess {
customerDocument: CustomerDocument!
}
Fields
CustomerDocumentCreateInlinePayloadSuccess.customerDocument ● CustomerDocument! non-null object
Implemented By
CustomerDocumentCreateInlinePayload union
CustomerDocumentCreatePayloadError
No description
type CustomerDocumentCreatePayloadError {
code: CustomerDocumentCreateErrorCode!
}
Fields
CustomerDocumentCreatePayloadError.code ● CustomerDocumentCreateErrorCode! non-null enum
Implemented By
CustomerDocumentCreatePayload union
CustomerDocumentCreatePayloadSuccess
No description
type CustomerDocumentCreatePayloadSuccess {
customerDocument: CustomerDocument!
}
Fields
CustomerDocumentCreatePayloadSuccess.customerDocument ● CustomerDocument! non-null object
Implemented By
CustomerDocumentCreatePayload union
CustomerDocumentDeletePayload
No description
type CustomerDocumentDeletePayload {
deletedDocumentId: CustomerDocumentId!
}
Fields
CustomerDocumentDeletePayload.deletedDocumentId ● CustomerDocumentId! non-null scalar
Returned By
customerDocumentDelete mutation
CustomerDocumentDeletionRequested
No description
type CustomerDocumentDeletionRequested {
customerDocument: CustomerDocument
customerDocumentId: CustomerDocumentId!
recordedAt: Timestamp!
}
Fields
CustomerDocumentDeletionRequested.customerDocument ● CustomerDocument object
CustomerDocumentDeletionRequested.customerDocumentId ● CustomerDocumentId! non-null scalar
CustomerDocumentDeletionRequested.recordedAt ● Timestamp! non-null scalar
Implemented By
CustomerTimelineEntry union
CustomerDocumentDownloadLinksGeneratePayloadError
No description
type CustomerDocumentDownloadLinksGeneratePayloadError {
code: CustomerDocumentDownloadLinksGenerateErrorCode!
}
Fields
CustomerDocumentDownloadLinksGeneratePayloadError.code ● CustomerDocumentDownloadLinksGenerateErrorCode! non-null enum
Implemented By
CustomerDocumentDownloadLinksGeneratePayload union
CustomerDocumentDownloadLinksGeneratePayloadSuccess
No description
type CustomerDocumentDownloadLinksGeneratePayloadSuccess {
link: Url!
}
Fields
CustomerDocumentDownloadLinksGeneratePayloadSuccess.link ● Url! non-null scalar
Implemented By
CustomerDocumentDownloadLinksGeneratePayload union
CustomerEdge
An edge in a connection.
type CustomerEdge {
cursor: String!
node: Customer!
}
Fields
CustomerEdge.cursor ● String! non-null scalar
A cursor for use in pagination
CustomerEdge.node ● Customer! non-null object
The item at the end of the edge
Member Of
CustomerConnection object
CustomerFreezePayloadError
No description
type CustomerFreezePayloadError {
code: CustomerFreezeErrorCode!
}
Fields
CustomerFreezePayloadError.code ● CustomerFreezeErrorCode! non-null enum
Implemented By
CustomerFreezePayload union
CustomerFreezePayloadSuccess
No description
type CustomerFreezePayloadSuccess {
customer: Customer!
}
Fields
CustomerFreezePayloadSuccess.customer ● Customer! non-null object
Implemented By
CustomerFreezePayload union
CustomerFrozen
No description
type CustomerFrozen {
reason: String
recordedAt: Timestamp!
}
Fields
CustomerFrozen.reason ● String scalar
CustomerFrozen.recordedAt ● Timestamp! non-null scalar
Implemented By
CustomerTimelineEntry union
CustomerNoteCreated
No description
type CustomerNoteCreated {
note: Note
noteId: NoteId!
recordedAt: Timestamp!
}
Fields
CustomerNoteCreated.note ● Note object
CustomerNoteCreated.noteId ● NoteId! non-null scalar
CustomerNoteCreated.recordedAt ● Timestamp! non-null scalar
Implemented By
CustomerTimelineEntry union
CustomerNoteCreatePayloadError
No description
type CustomerNoteCreatePayloadError {
code: CustomerNoteCreateErrorCode!
}
Fields
CustomerNoteCreatePayloadError.code ● CustomerNoteCreateErrorCode! non-null enum
Implemented By
CustomerNoteCreatePayload union
CustomerNoteCreatePayloadSuccess
No description
type CustomerNoteCreatePayloadSuccess {
note: Note!
}
Fields
CustomerNoteCreatePayloadSuccess.note ● Note! non-null object
Implemented By
CustomerNoteCreatePayload union
CustomerNoteUpdatePayloadError
No description
type CustomerNoteUpdatePayloadError {
code: CustomerNoteUpdateErrorCode!
}
Fields
CustomerNoteUpdatePayloadError.code ● CustomerNoteUpdateErrorCode! non-null enum
Implemented By
CustomerNoteUpdatePayload union
CustomerNoteUpdatePayloadSuccess
No description
type CustomerNoteUpdatePayloadSuccess {
note: Note!
}
Fields
CustomerNoteUpdatePayloadSuccess.note ● Note! non-null object
Implemented By
CustomerNoteUpdatePayload union
CustomerObligationDefaulted
No description
type CustomerObligationDefaulted {
obligation: Obligation
obligationId: ObligationId!
recordedAt: Timestamp!
}
Fields
CustomerObligationDefaulted.obligation ● Obligation object
CustomerObligationDefaulted.obligationId ● ObligationId! non-null scalar
CustomerObligationDefaulted.recordedAt ● Timestamp! non-null scalar
Implemented By
CustomerTimelineEntry union
CustomerPiiErasureCancelled
No description
type CustomerPiiErasureCancelled {
recordedAt: Timestamp!
}
Fields
CustomerPiiErasureCancelled.recordedAt ● Timestamp! non-null scalar
Implemented By
CustomerTimelineEntry union
CustomerPiiErasureCompleted
No description
type CustomerPiiErasureCompleted {
recordedAt: Timestamp!
}
Fields
CustomerPiiErasureCompleted.recordedAt ● Timestamp! non-null scalar
Implemented By
CustomerTimelineEntry union
CustomerPiiErasureScheduled
No description
type CustomerPiiErasureScheduled {
recordedAt: Timestamp!
}
Fields
CustomerPiiErasureScheduled.recordedAt ● Timestamp! non-null scalar
Implemented By
CustomerTimelineEntry union
CustomerTimelineEntryConnection
No description
type CustomerTimelineEntryConnection {
edges: [CustomerTimelineEntryEdge!]!
nodes: [CustomerTimelineEntry!]!
pageInfo: PageInfo!
}
Fields
CustomerTimelineEntryConnection.edges ● [CustomerTimelineEntryEdge!]! non-null object
A list of edges.
CustomerTimelineEntryConnection.nodes ● [CustomerTimelineEntry!]! non-null union
A list of nodes.
CustomerTimelineEntryConnection.pageInfo ● PageInfo! non-null object
Information to aid in pagination.
Member Of
Customer object
CustomerTimelineEntryEdge
An edge in a connection.
type CustomerTimelineEntryEdge {
cursor: String!
node: CustomerTimelineEntry!
}
Fields
CustomerTimelineEntryEdge.cursor ● String! non-null scalar
A cursor for use in pagination
CustomerTimelineEntryEdge.node ● CustomerTimelineEntry! non-null union
The item at the end of the edge
Member Of
CustomerTimelineEntryConnection object
CustomerUnfreezePayloadError
No description
type CustomerUnfreezePayloadError {
code: CustomerUnfreezeErrorCode!
}
Fields
CustomerUnfreezePayloadError.code ● CustomerUnfreezeErrorCode! non-null enum
Implemented By
CustomerUnfreezePayload union
CustomerUnfreezePayloadSuccess
No description
type CustomerUnfreezePayloadSuccess {
customer: Customer!
}
Fields
CustomerUnfreezePayloadSuccess.customer ● Customer! non-null object
Implemented By
CustomerUnfreezePayload union
CustomerUnfrozen
No description
type CustomerUnfrozen {
reason: String
recordedAt: Timestamp!
}
Fields
CustomerUnfrozen.reason ● String scalar
CustomerUnfrozen.recordedAt ● Timestamp! non-null scalar
Implemented By
CustomerTimelineEntry union
Dashboard
No description
type Dashboard {
cards: [DashboardCard!]!
lastRefreshedAt: Timestamp
}
Fields
Dashboard.cards ● [DashboardCard!]! non-null object
Dashboard.lastRefreshedAt ● Timestamp scalar
Completion time of the latest warehouse pipeline run, including intraday refreshes.
Returned By
dashboard query
DashboardCard
No description
type DashboardCard {
queryTemplate: DashboardCardTemplate!
result: DwReadOnlyQueryResult
}
Fields
DashboardCard.queryTemplate ● DashboardCardTemplate! non-null object
DashboardCard.result ● DwReadOnlyQueryResult object
null, with an error at the card's path, when the card could not
be served.
Member Of
Dashboard object
DashboardCardTemplate
Display metadata only; SQL access remains protected by template-library permissions.
type DashboardCardTemplate {
categories: [QueryTemplateCategory!]!
description: String!
name: String!
queryTemplateId: QueryTemplateId!
}
Fields
DashboardCardTemplate.categories ● [QueryTemplateCategory!]! non-null enum
DashboardCardTemplate.description ● String! non-null scalar
DashboardCardTemplate.name ● String! non-null scalar
DashboardCardTemplate.queryTemplateId ● QueryTemplateId! non-null scalar
Member Of
DashboardCard object
DataMartColumn
No description
type DataMartColumn {
description: String
name: String!
}
Fields
DataMartColumn.description ● String scalar
DataMartColumn.name ● String! non-null scalar
Member Of
DataMartModel object
DataMartModel
The full definition of one data-mart model: its grain-bearing description
and its columns. The describe half of progressive disclosure - returned
only for the models a caller explicitly names.
type DataMartModel {
columns: [DataMartColumn!]!
description: String
name: String!
}
Fields
DataMartModel.columns ● [DataMartColumn!]! non-null object
DataMartModel.description ● String scalar
DataMartModel.name ● String! non-null scalar
Returned By
dataMartModelDetails query
DataMartModelSummary
The catalog-listing entry for one data-mart model: name, full description and column count - the whole catalog travels in one small payload.
type DataMartModelSummary {
columnCount: Int!
description: String
name: String!
}
Fields
DataMartModelSummary.columnCount ● Int! non-null scalar
DataMartModelSummary.description ● String scalar
DataMartModelSummary.name ● String! non-null scalar
Returned By
dataMartModels query
Deposit
No description
type Deposit {
account: DepositAccount
accountId: DepositAccountId!
amount: Money!
createdAt: Timestamp!
depositId: DepositId!
eventHistory(
after: String
first: Int!
): EventTimelineEntryConnection!
ledgerTransactions: [LedgerTransaction!]
publicId: PublicId!
reference: String!
status: DepositStatus!
}
Fields
Deposit.account ● DepositAccount object
Deposit.accountId ● DepositAccountId! non-null scalar
Deposit.amount ● Money! non-null object
Deposit.createdAt ● Timestamp! non-null scalar
Deposit.depositId ● DepositId! non-null scalar
Deposit.eventHistory ● EventTimelineEntryConnection! non-null object
Deposit.eventHistory.after ● String scalar
Deposit.eventHistory.first ● Int! non-null scalar
Deposit.ledgerTransactions ● [LedgerTransaction!] list object
Deposit.publicId ● PublicId! non-null scalar
Deposit.reference ● String! non-null scalar
Deposit.status ● DepositStatus! non-null enum
Returned By
deposit query ● depositByPublicId query
Member Of
DepositAccount object ● DepositConnection object ● DepositEdge object ● DepositEntry object ● DepositRevertPayloadSuccess object
Implemented By
LedgerTransactionEntity union ● PublicIdTarget union
DepositAccount
No description
type DepositAccount {
activity: DepositAccountActivity!
balance: DepositAccountBalance
createdAt: Timestamp!
currency: Currency!
customer: Customer
customerId: CustomerId!
depositAccountId: DepositAccountId!
deposits: [Deposit!]!
eventHistory(
after: String
first: Int!
): EventTimelineEntryConnection!
history(
after: String
first: Int!
): DepositAccountHistoryEntryConnection!
ledgerAccounts: DepositAccountLedgerAccounts!
paymentEndpoint: PaymentEndpoint
productAgreement: DepositAccountProductAgreement!
publicId: PublicId!
status: DepositAccountStatus!
withdrawals: [Withdrawal!]!
}
Fields
DepositAccount.activity ● DepositAccountActivity! non-null enum
DepositAccount.balance ● DepositAccountBalance object
DepositAccount.createdAt ● Timestamp! non-null scalar
DepositAccount.currency ● Currency! non-null object
DepositAccount.customer ● Customer object
DepositAccount.customerId ● CustomerId! non-null scalar
DepositAccount.depositAccountId ● DepositAccountId! non-null scalar
DepositAccount.deposits ● [Deposit!]! non-null object
DepositAccount.eventHistory ● EventTimelineEntryConnection! non-null object
DepositAccount.eventHistory.after ● String scalar
DepositAccount.eventHistory.first ● Int! non-null scalar
DepositAccount.history ● DepositAccountHistoryEntryConnection! non-null object
DepositAccount.history.after ● String scalar
DepositAccount.history.first ● Int! non-null scalar
DepositAccount.ledgerAccounts ● DepositAccountLedgerAccounts! non-null object
DepositAccount.paymentEndpoint ● PaymentEndpoint object
DepositAccount.productAgreement ● DepositAccountProductAgreement! non-null object
DepositAccount.publicId ● PublicId! non-null scalar
DepositAccount.status ● DepositAccountStatus! non-null enum
DepositAccount.withdrawals ● [Withdrawal!]! non-null object
Returned By
depositAccount query ● depositAccountByPublicId query
Member Of
Customer object ● CustomerDepositAccountClosed object ● CustomerDepositAccountEscheatable object ● CustomerDepositAccountFrozen object ● CustomerDepositAccountOpened object ● CustomerDepositAccountUnfrozen object ● Deposit object ● DepositAccountClosePayloadSuccess object ● DepositAccountConnection object ● DepositAccountCreateFromProductPayloadSuccess object ● DepositAccountEdge object ● DepositAccountFreezePayloadSuccess object ● DepositAccountProductAgreement object ● DepositAccountUnfreezePayloadSuccess object ● Withdrawal object
Implemented By
LedgerAccountEntity union ● PublicIdTarget union ● ReceiptDestination union
DepositAccountBalance
No description
type DepositAccountBalance {
pending: Money!
settled: Money!
}
Fields
DepositAccountBalance.pending ● Money! non-null object
DepositAccountBalance.settled ● Money! non-null object
Member Of
DepositAccount object
DepositAccountClosePayloadError
No description
type DepositAccountClosePayloadError {
code: DepositAccountCloseErrorCode!
}
Fields
DepositAccountClosePayloadError.code ● DepositAccountCloseErrorCode! non-null enum
Implemented By
DepositAccountClosePayload union
DepositAccountClosePayloadSuccess
No description
type DepositAccountClosePayloadSuccess {
depositAccount: DepositAccount!
}
Fields
DepositAccountClosePayloadSuccess.depositAccount ● DepositAccount! non-null object
Implemented By
DepositAccountClosePayload union
DepositAccountConnection
No description
type DepositAccountConnection {
edges: [DepositAccountEdge!]!
nodes: [DepositAccount!]!
pageInfo: PageInfo!
}
Fields
DepositAccountConnection.edges ● [DepositAccountEdge!]! non-null object
A list of edges.
DepositAccountConnection.nodes ● [DepositAccount!]! non-null object
A list of nodes.
DepositAccountConnection.pageInfo ● PageInfo! non-null object
Information to aid in pagination.
Returned By
depositAccounts query
DepositAccountCreateFromProductPayloadError
No description
type DepositAccountCreateFromProductPayloadError {
code: DepositAccountCreateFromProductErrorCode!
}
Fields
DepositAccountCreateFromProductPayloadError.code ● DepositAccountCreateFromProductErrorCode! non-null enum
Implemented By
DepositAccountCreateFromProductPayload union
DepositAccountCreateFromProductPayloadSuccess
No description
type DepositAccountCreateFromProductPayloadSuccess {
depositAccount: DepositAccount!
}
Fields
DepositAccountCreateFromProductPayloadSuccess.depositAccount ● DepositAccount! non-null object
Implemented By
DepositAccountCreateFromProductPayload union
DepositAccountEdge
An edge in a connection.
type DepositAccountEdge {
cursor: String!
node: DepositAccount!
}
Fields
DepositAccountEdge.cursor ● String! non-null scalar
A cursor for use in pagination
DepositAccountEdge.node ● DepositAccount! non-null object
The item at the end of the edge
Member Of
DepositAccountConnection object
DepositAccountFreezePayloadError
No description
type DepositAccountFreezePayloadError {
code: DepositAccountFreezeErrorCode!
}
Fields
DepositAccountFreezePayloadError.code ● DepositAccountFreezeErrorCode! non-null enum
Implemented By
DepositAccountFreezePayload union
DepositAccountFreezePayloadSuccess
No description
type DepositAccountFreezePayloadSuccess {
depositAccount: DepositAccount!
}
Fields
DepositAccountFreezePayloadSuccess.depositAccount ● DepositAccount! non-null object
Implemented By
DepositAccountFreezePayload union
DepositAccountHistoryEntryConnection
No description
type DepositAccountHistoryEntryConnection {
edges: [DepositAccountHistoryEntryEdge!]!
nodes: [DepositAccountHistoryEntry!]!
pageInfo: PageInfo!
}
Fields
DepositAccountHistoryEntryConnection.edges ● [DepositAccountHistoryEntryEdge!]! non-null object
A list of edges.
DepositAccountHistoryEntryConnection.nodes ● [DepositAccountHistoryEntry!]! non-null union
A list of nodes.
DepositAccountHistoryEntryConnection.pageInfo ● PageInfo! non-null object
Information to aid in pagination.
Member Of
DepositAccount object
DepositAccountHistoryEntryEdge
An edge in a connection.
type DepositAccountHistoryEntryEdge {
cursor: String!
node: DepositAccountHistoryEntry!
}
Fields
DepositAccountHistoryEntryEdge.cursor ● String! non-null scalar
A cursor for use in pagination
DepositAccountHistoryEntryEdge.node ● DepositAccountHistoryEntry! non-null union
The item at the end of the edge
Member Of
DepositAccountHistoryEntryConnection object
DepositAccountingIntegration
No description
type DepositAccountingIntegration {
chartOfAccountsId: ChartOfAccountsId!
omnibus: DepositOmnibusIntegration!
productIntegrations: [DepositProductIntegration!]!
}
Fields
DepositAccountingIntegration.chartOfAccountsId ● ChartOfAccountsId! non-null scalar
DepositAccountingIntegration.omnibus ● DepositOmnibusIntegration! non-null object
DepositAccountingIntegration.productIntegrations ● [DepositProductIntegration!]! non-null object
Returned By
depositAccountingIntegration query
Member Of
DepositAccountingIntegrationConfigurePayloadSuccess object
DepositAccountingIntegrationConfigurePayloadError
No description
type DepositAccountingIntegrationConfigurePayloadError {
code: DepositAccountingIntegrationConfigureErrorCode!
}
Fields
DepositAccountingIntegrationConfigurePayloadError.code ● DepositAccountingIntegrationConfigureErrorCode! non-null enum
Implemented By
DepositAccountingIntegrationConfigurePayload union
DepositAccountingIntegrationConfigurePayloadSuccess
No description
type DepositAccountingIntegrationConfigurePayloadSuccess {
depositAccountingIntegration: DepositAccountingIntegration!
}
Fields
DepositAccountingIntegrationConfigurePayloadSuccess.depositAccountingIntegration ● DepositAccountingIntegration! non-null object
Implemented By
DepositAccountingIntegrationConfigurePayload union
DepositAccountLedgerAccounts
No description
type DepositAccountLedgerAccounts {
depositAccount: LedgerAccount
depositOmnibusAccount: LedgerAccount
frozenDepositAccount: LedgerAccount
}
Fields
DepositAccountLedgerAccounts.depositAccount ● LedgerAccount object
DepositAccountLedgerAccounts.depositOmnibusAccount ● LedgerAccount object
DepositAccountLedgerAccounts.frozenDepositAccount ● LedgerAccount object
Member Of
DepositAccount object
DepositAccountProduct
No description
type DepositAccountProduct {
accountingConfig: DepositAccountProductAccountingConfig!
createdAt: Timestamp!
currency: Currency!
customerType: CustomerType!
depositAccountProductId: DepositAccountProductId!
eventHistory(
after: String
first: Int!
): EventTimelineEntryConnection!
name: String!
partner: Partner
partnerId: PartnerId!
status: DepositAccountProductStatus!
terms: VersionedDepositAccountProductTerms!
userCanUpdateDepositAccountProduct: Boolean!
}
Fields
DepositAccountProduct.accountingConfig ● DepositAccountProductAccountingConfig! non-null object
DepositAccountProduct.createdAt ● Timestamp! non-null scalar
DepositAccountProduct.currency ● Currency! non-null object
DepositAccountProduct.customerType ● CustomerType! non-null enum
DepositAccountProduct.depositAccountProductId ● DepositAccountProductId! non-null scalar
DepositAccountProduct.eventHistory ● EventTimelineEntryConnection! non-null object
DepositAccountProduct.eventHistory.after ● String scalar
DepositAccountProduct.eventHistory.first ● Int! non-null scalar
DepositAccountProduct.name ● String! non-null scalar
DepositAccountProduct.partner ● Partner object
DepositAccountProduct.partnerId ● PartnerId! non-null scalar
DepositAccountProduct.status ● DepositAccountProductStatus! non-null enum
DepositAccountProduct.terms ● VersionedDepositAccountProductTerms! non-null object
DepositAccountProduct.userCanUpdateDepositAccountProduct ● Boolean! non-null scalar
Returned By
depositAccountProduct query
Member Of
Customer object ● DepositAccountProductAgreement object ● DepositAccountProductConnection object ● DepositAccountProductCreatePayloadSuccess object ● DepositAccountProductEdge object ● DepositAccountProductUpdateStatusPayloadSuccess object ● DepositAccountProductUpdateTermsPayloadSuccess object
DepositAccountProductAccountingConfig
No description
type DepositAccountProductAccountingConfig {
accountSets: DepositAccountProductAccountSets!
chartOfAccountsId: ChartOfAccountsId!
currencyCategory: DepositCurrencyCategory!
omnibus: DepositAccountProductOmnibusAccounting!
productType: DepositAccountProductType!
}
Fields
DepositAccountProductAccountingConfig.accountSets ● DepositAccountProductAccountSets! non-null object
DepositAccountProductAccountingConfig.chartOfAccountsId ● ChartOfAccountsId! non-null scalar
DepositAccountProductAccountingConfig.currencyCategory ● DepositCurrencyCategory! non-null enum
DepositAccountProductAccountingConfig.omnibus ● DepositAccountProductOmnibusAccounting! non-null object
DepositAccountProductAccountingConfig.productType ● DepositAccountProductType! non-null enum
Member Of
DepositAccountProduct object
DepositAccountProductAccountSets
No description
type DepositAccountProductAccountSets {
depositAccountSetId: LedgerAccountId!
depositAccountsParentAccountSetId: LedgerAccountId!
depositAccountsParentCode: AccountCode!
frozenDepositAccountSetId: LedgerAccountId!
frozenDepositAccountsParentAccountSetId: LedgerAccountId!
frozenDepositAccountsParentCode: AccountCode!
}
Fields
DepositAccountProductAccountSets.depositAccountSetId ● LedgerAccountId! non-null scalar
DepositAccountProductAccountSets.depositAccountsParentAccountSetId ● LedgerAccountId! non-null scalar
DepositAccountProductAccountSets.depositAccountsParentCode ● AccountCode! non-null scalar
DepositAccountProductAccountSets.frozenDepositAccountSetId ● LedgerAccountId! non-null scalar
DepositAccountProductAccountSets.frozenDepositAccountsParentAccountSetId ● LedgerAccountId! non-null scalar
DepositAccountProductAccountSets.frozenDepositAccountsParentCode ● AccountCode! non-null scalar
Member Of
DepositAccountProductAccountingConfig object
DepositAccountProductAgreement
No description
type DepositAccountProductAgreement {
acceptedAt: Timestamp!
depositAccount: DepositAccount
depositAccountId: DepositAccountId!
depositAccountProductAgreementId: DepositAccountProductAgreementId!
effectiveTerms: DepositAccountProductTerms!
eventHistory(
after: String
first: Int!
): EventTimelineEntryConnection!
product: DepositAccountProduct
productId: DepositAccountProductId!
productTerms: VersionedDepositAccountProductTerms!
}
Fields
DepositAccountProductAgreement.acceptedAt ● Timestamp! non-null scalar
DepositAccountProductAgreement.depositAccount ● DepositAccount object
DepositAccountProductAgreement.depositAccountId ● DepositAccountId! non-null scalar
DepositAccountProductAgreement.depositAccountProductAgreementId ● DepositAccountProductAgreementId! non-null scalar
DepositAccountProductAgreement.effectiveTerms ● DepositAccountProductTerms! non-null object
DepositAccountProductAgreement.eventHistory ● EventTimelineEntryConnection! non-null object
DepositAccountProductAgreement.eventHistory.after ● String scalar
DepositAccountProductAgreement.eventHistory.first ● Int! non-null scalar
DepositAccountProductAgreement.product ● DepositAccountProduct object
DepositAccountProductAgreement.productId ● DepositAccountProductId! non-null scalar
DepositAccountProductAgreement.productTerms ● VersionedDepositAccountProductTerms! non-null object
Member Of
DepositAccount object
DepositAccountProductConnection
No description
type DepositAccountProductConnection {
edges: [DepositAccountProductEdge!]!
nodes: [DepositAccountProduct!]!
pageInfo: PageInfo!
}
Fields
DepositAccountProductConnection.edges ● [DepositAccountProductEdge!]! non-null object
A list of edges.
DepositAccountProductConnection.nodes ● [DepositAccountProduct!]! non-null object
A list of nodes.
DepositAccountProductConnection.pageInfo ● PageInfo! non-null object
Information to aid in pagination.
Returned By
depositAccountProducts query
DepositAccountProductCreatePayloadError
No description
type DepositAccountProductCreatePayloadError {
code: DepositAccountProductCreateErrorCode!
}
Fields
DepositAccountProductCreatePayloadError.code ● DepositAccountProductCreateErrorCode! non-null enum
Implemented By
DepositAccountProductCreatePayload union
DepositAccountProductCreatePayloadSuccess
No description
type DepositAccountProductCreatePayloadSuccess {
depositAccountProduct: DepositAccountProduct!
}
Fields
DepositAccountProductCreatePayloadSuccess.depositAccountProduct ● DepositAccountProduct! non-null object
Implemented By
DepositAccountProductCreatePayload union
DepositAccountProductEdge
An edge in a connection.
type DepositAccountProductEdge {
cursor: String!
node: DepositAccountProduct!
}
Fields
DepositAccountProductEdge.cursor ● String! non-null scalar
A cursor for use in pagination
DepositAccountProductEdge.node ● DepositAccountProduct! non-null object
The item at the end of the edge
Member Of
DepositAccountProductConnection object
DepositAccountProductOmnibusAccounting
No description
type DepositAccountProductOmnibusAccounting {
omnibusAccountId: LedgerAccountId!
omnibusAccountSetId: LedgerAccountId!
omnibusParentAccountSetId: LedgerAccountId!
omnibusParentCode: AccountCode!
}
Fields
DepositAccountProductOmnibusAccounting.omnibusAccountId ● LedgerAccountId! non-null scalar
DepositAccountProductOmnibusAccounting.omnibusAccountSetId ● LedgerAccountId! non-null scalar
DepositAccountProductOmnibusAccounting.omnibusParentAccountSetId ● LedgerAccountId! non-null scalar
DepositAccountProductOmnibusAccounting.omnibusParentCode ● AccountCode! non-null scalar
Member Of
DepositAccountProductAccountingConfig object
DepositAccountProductTerms
No description
type DepositAccountProductTerms {
maxWithdrawalAmountPerTransaction: MaxWithdrawalAmountPerTransaction!
}
Fields
DepositAccountProductTerms.maxWithdrawalAmountPerTransaction ● MaxWithdrawalAmountPerTransaction! non-null union
Member Of
DepositAccountProductAgreement object ● VersionedDepositAccountProductTerms object
DepositAccountProductUpdateStatusPayloadError
No description
type DepositAccountProductUpdateStatusPayloadError {
code: DepositAccountProductUpdateStatusErrorCode!
}
Fields
DepositAccountProductUpdateStatusPayloadError.code ● DepositAccountProductUpdateStatusErrorCode! non-null enum
Implemented By
DepositAccountProductUpdateStatusPayload union
DepositAccountProductUpdateStatusPayloadSuccess
No description
type DepositAccountProductUpdateStatusPayloadSuccess {
depositAccountProduct: DepositAccountProduct!
}
Fields
DepositAccountProductUpdateStatusPayloadSuccess.depositAccountProduct ● DepositAccountProduct! non-null object
Implemented By
DepositAccountProductUpdateStatusPayload union
DepositAccountProductUpdateTermsPayloadError
No description
type DepositAccountProductUpdateTermsPayloadError {
code: DepositAccountProductUpdateTermsErrorCode!
}
Fields
DepositAccountProductUpdateTermsPayloadError.code ● DepositAccountProductUpdateTermsErrorCode! non-null enum
Implemented By
DepositAccountProductUpdateTermsPayload union
DepositAccountProductUpdateTermsPayloadSuccess
No description
type DepositAccountProductUpdateTermsPayloadSuccess {
depositAccountProduct: DepositAccountProduct!
}
Fields
DepositAccountProductUpdateTermsPayloadSuccess.depositAccountProduct ● DepositAccountProduct! non-null object
Implemented By
DepositAccountProductUpdateTermsPayload union
DepositAccountUnfreezePayloadError
No description
type DepositAccountUnfreezePayloadError {
code: DepositAccountUnfreezeErrorCode!
}
Fields
DepositAccountUnfreezePayloadError.code ● DepositAccountUnfreezeErrorCode! non-null enum
Implemented By
DepositAccountUnfreezePayload union
DepositAccountUnfreezePayloadSuccess
No description
type DepositAccountUnfreezePayloadSuccess {
depositAccount: DepositAccount!
}
Fields
DepositAccountUnfreezePayloadSuccess.depositAccount ● DepositAccount! non-null object
Implemented By
DepositAccountUnfreezePayload union
DepositBalanceStateParents
No description
type DepositBalanceStateParents {
active: ChartIntegrationBinding!
frozen: ChartIntegrationBinding!
}
Fields
DepositBalanceStateParents.active ● ChartIntegrationBinding! non-null object
DepositBalanceStateParents.frozen ● ChartIntegrationBinding! non-null object
Member Of
DepositCustomerIntegration object
DepositConnection
No description
type DepositConnection {
edges: [DepositEdge!]!
nodes: [Deposit!]!
pageInfo: PageInfo!
}
Fields
DepositConnection.edges ● [DepositEdge!]! non-null object
A list of edges.
DepositConnection.nodes ● [Deposit!]! non-null object
A list of nodes.
DepositConnection.pageInfo ● PageInfo! non-null object
Information to aid in pagination.
Returned By
deposits query
DepositCurrencyPolicy
No description
type DepositCurrencyPolicy {
functional: Currency!
supported: [Currency!]!
}
Fields
DepositCurrencyPolicy.functional ● Currency! non-null object
DepositCurrencyPolicy.supported ● [Currency!]! non-null object
Returned By
depositCurrencyPolicy query
Member Of
DepositCurrencyPolicyConfigurePayloadSuccess object
DepositCurrencyPolicyConfigurePayloadError
No description
type DepositCurrencyPolicyConfigurePayloadError {
code: DepositCurrencyPolicyConfigureErrorCode!
}
Fields
DepositCurrencyPolicyConfigurePayloadError.code ● DepositCurrencyPolicyConfigureErrorCode! non-null enum
Implemented By
DepositCurrencyPolicyConfigurePayload union
DepositCurrencyPolicyConfigurePayloadSuccess
No description
type DepositCurrencyPolicyConfigurePayloadSuccess {
depositCurrencyPolicy: DepositCurrencyPolicy!
}
Fields
DepositCurrencyPolicyConfigurePayloadSuccess.depositCurrencyPolicy ● DepositCurrencyPolicy! non-null object
Implemented By
DepositCurrencyPolicyConfigurePayload union
DepositCustomerIntegration
No description
type DepositCustomerIntegration {
customerType: CustomerType!
functional: DepositBalanceStateParents!
nonFunctional: DepositBalanceStateParents!
}
Fields
DepositCustomerIntegration.customerType ● CustomerType! non-null enum
DepositCustomerIntegration.functional ● DepositBalanceStateParents! non-null object
DepositCustomerIntegration.nonFunctional ● DepositBalanceStateParents! non-null object
Member Of
DepositProductIntegration object
DepositEdge
An edge in a connection.
type DepositEdge {
cursor: String!
node: Deposit!
}
Fields
DepositEdge.cursor ● String! non-null scalar
A cursor for use in pagination
DepositEdge.node ● Deposit! non-null object
The item at the end of the edge
Member Of
DepositConnection object
DepositEntry
No description
type DepositEntry {
deposit: Deposit!
recordedAt: Timestamp!
}
Fields
DepositEntry.deposit ● Deposit! non-null object
DepositEntry.recordedAt ● Timestamp! non-null scalar
Implemented By
DepositAccountHistoryEntry union
DepositOmnibusIntegration
No description
type DepositOmnibusIntegration {
functional: ChartIntegrationBinding!
nonFunctional: ChartIntegrationBinding!
}
Fields
DepositOmnibusIntegration.functional ● ChartIntegrationBinding! non-null object
DepositOmnibusIntegration.nonFunctional ● ChartIntegrationBinding! non-null object
Member Of
DepositAccountingIntegration object
DepositProductIntegration
No description
type DepositProductIntegration {
customerIntegrations: [DepositCustomerIntegration!]!
productType: DepositAccountProductType!
}
Fields
DepositProductIntegration.customerIntegrations ● [DepositCustomerIntegration!]! non-null object
DepositProductIntegration.productType ● DepositAccountProductType! non-null enum
Member Of
DepositAccountingIntegration object
DepositRevertPayloadError
No description
type DepositRevertPayloadError {
code: DepositRevertErrorCode!
}
Fields
DepositRevertPayloadError.code ● DepositRevertErrorCode! non-null enum
Implemented By
DepositRevertPayload union
DepositRevertPayloadSuccess
No description
type DepositRevertPayloadSuccess {
deposit: Deposit!
}
Fields
DepositRevertPayloadSuccess.deposit ● Deposit! non-null object
Implemented By
DepositRevertPayload union
DestinationInfo
The reference operators/rails record at receipt submission time. The hub
treats it as opaque; tenants (like the deposit module) inspect it and
try their own lookups. For the initial manual + deposit case, this is
a deposit-account PublicId.
type DestinationInfo {
reference: String!
}
Fields
DestinationInfo.reference ● String! non-null scalar
Member Of
Receipt object
DisbursalEntry
No description
type DisbursalEntry {
amount: Money!
disbursal: CreditFacilityDisbursal!
recordedAt: Timestamp!
}
Fields
DisbursalEntry.amount ● Money! non-null object
DisbursalEntry.disbursal ● CreditFacilityDisbursal! non-null object
DisbursalEntry.recordedAt ● Timestamp! non-null scalar
Implemented By
DepositAccountHistoryEntry union
Disbursed
No description
type Disbursed {
outstanding: Money!
outstandingPayable: Money!
total: Money!
}
Fields
Disbursed.outstanding ● Money! non-null object
Disbursed.outstandingPayable ● Money! non-null object
Disbursed.total ● Money! non-null object
Member Of
CreditFacilityBalance object
DomainConfig
No description
type DomainConfig {
allowedValues: [String!]
configType: ConfigType!
domainConfigId: DomainConfigId!
hasValue: Boolean!
key: String!
value: Json!
}
Fields
DomainConfig.allowedValues ● [String!] list scalar
DomainConfig.configType ● ConfigType! non-null enum
DomainConfig.domainConfigId ● DomainConfigId! non-null scalar
DomainConfig.hasValue ● Boolean! non-null scalar
DomainConfig.key ● String! non-null scalar
DomainConfig.value ● Json! non-null scalar
Returned By
domainConfig query
Member Of
DomainConfigConnection object ● DomainConfigEdge object ● DomainConfigUpdatePayloadSuccess object
DomainConfigConnection
No description
type DomainConfigConnection {
edges: [DomainConfigEdge!]!
nodes: [DomainConfig!]!
pageInfo: PageInfo!
}
Fields
DomainConfigConnection.edges ● [DomainConfigEdge!]! non-null object
A list of edges.
DomainConfigConnection.nodes ● [DomainConfig!]! non-null object
A list of nodes.
DomainConfigConnection.pageInfo ● PageInfo! non-null object
Information to aid in pagination.
Returned By
domainConfigs query
DomainConfigEdge
An edge in a connection.
type DomainConfigEdge {
cursor: String!
node: DomainConfig!
}
Fields
DomainConfigEdge.cursor ● String! non-null scalar
A cursor for use in pagination
DomainConfigEdge.node ● DomainConfig! non-null object
The item at the end of the edge
Member Of
DomainConfigConnection object
DomainConfigUpdatePayloadError
No description
type DomainConfigUpdatePayloadError {
code: DomainConfigUpdateErrorCode!
}
Fields
DomainConfigUpdatePayloadError.code ● DomainConfigUpdateErrorCode! non-null enum
Implemented By
DomainConfigUpdatePayload union
DomainConfigUpdatePayloadSuccess
No description
type DomainConfigUpdatePayloadSuccess {
domainConfig: DomainConfig!
}
Fields
DomainConfigUpdatePayloadSuccess.domainConfig ● DomainConfig! non-null object
Implemented By
DomainConfigUpdatePayload union
Duration
No description
type Duration {
period: Period!
units: Int!
}
Fields
Duration.period ● Period! non-null enum
Duration.units ● Int! non-null scalar
Member Of
CreditFacilityTermsAlteration object ● TermValues object
DwReadonlyQueryExportLinkGeneratePayload
Download link for an exported read-only DW query, plus the shape of what
made it into the file. rowCount is the number of exported rows;
truncated is true if the export row cap or byte budget cut the result.
type DwReadonlyQueryExportLinkGeneratePayload {
rowCount: Int!
truncated: Boolean!
url: Url!
}
Fields
DwReadonlyQueryExportLinkGeneratePayload.rowCount ● Int! non-null scalar
DwReadonlyQueryExportLinkGeneratePayload.truncated ● Boolean! non-null scalar
DwReadonlyQueryExportLinkGeneratePayload.url ● Url! non-null scalar
Returned By
dwReadonlyQueryExportLinkGenerate mutation
DwReadOnlyQueryResult
Result of a validated read-only DW query. rows is a JSON array of row
objects (column name -> value); truncated is true if the row cap or
the byte budget cut the result short.
type DwReadOnlyQueryResult {
fields: [String!]!
rowCount: Int!
rows: JSON!
truncated: Boolean!
}
Fields
DwReadOnlyQueryResult.fields ● [String!]! non-null scalar
DwReadOnlyQueryResult.rowCount ● Int! non-null scalar
DwReadOnlyQueryResult.rows ● JSON! non-null scalar
DwReadOnlyQueryResult.truncated ● Boolean! non-null scalar
Returned By
dwRunReadonlyQuery query
Member Of
DashboardCard object
EodProcess
No description
type EodProcess {
completedAt: Timestamp
currentPhaseName: String
day: AccountingDate!
eodProcessId: EodProcessId!
phases: [EodProcessPhase!]!
startedAt: Timestamp!
status: EodProcessStatus!
}
Fields
EodProcess.completedAt ● Timestamp scalar
EodProcess.currentPhaseName ● String scalar
EodProcess.day ● AccountingDate! non-null scalar
EodProcess.eodProcessId ● EodProcessId! non-null scalar
EodProcess.phases ● [EodProcessPhase!]! non-null object
EodProcess.startedAt ● Timestamp! non-null scalar
EodProcess.status ● EodProcessStatus! non-null enum
Returned By
eodProcess query ● eodProcessUpdated subscription
Member Of
EodProcessConnection object ● EodProcessEdge object ● EodProcessRestartPayloadSuccess object
EodProcessConnection
No description
type EodProcessConnection {
edges: [EodProcessEdge!]!
nodes: [EodProcess!]!
pageInfo: PageInfo!
}
Fields
EodProcessConnection.edges ● [EodProcessEdge!]! non-null object
A list of edges.
EodProcessConnection.nodes ● [EodProcess!]! non-null object
A list of nodes.
EodProcessConnection.pageInfo ● PageInfo! non-null object
Information to aid in pagination.
Returned By
eodProcesses query
EodProcessEdge
An edge in a connection.
type EodProcessEdge {
cursor: String!
node: EodProcess!
}
Fields
EodProcessEdge.cursor ● String! non-null scalar
A cursor for use in pagination
EodProcessEdge.node ● EodProcess! non-null object
The item at the end of the edge
Member Of
EodProcessConnection object
EodProcessPhase
No description
type EodProcessPhase {
completedAt: Timestamp
failureReason: String
name: String!
startedAt: Timestamp
status: EodPhaseExecutionStatus!
}
Fields
EodProcessPhase.completedAt ● Timestamp scalar
EodProcessPhase.failureReason ● String scalar
EodProcessPhase.name ● String! non-null scalar
EodProcessPhase.startedAt ● Timestamp scalar
EodProcessPhase.status ● EodPhaseExecutionStatus! non-null enum
Member Of
EodProcess object
EodProcessRestartPayloadError
No description
type EodProcessRestartPayloadError {
code: EodProcessRestartErrorCode!
}
Fields
EodProcessRestartPayloadError.code ● EodProcessRestartErrorCode! non-null enum
Implemented By
EodProcessRestartPayload union
EodProcessRestartPayloadSuccess
No description
type EodProcessRestartPayloadSuccess {
eodProcess: EodProcess!
}
Fields
EodProcessRestartPayloadSuccess.eodProcess ● EodProcess! non-null object
Implemented By
EodProcessRestartPayload union
EventTimelineEntry
No description
type EventTimelineEntry {
auditEntryId: AuditEntryId
eventType: String!
payload: Json!
recordedAt: Timestamp!
sequence: Int!
subject: AuditSubject
}
Fields
EventTimelineEntry.auditEntryId ● AuditEntryId scalar
EventTimelineEntry.eventType ● String! non-null scalar
EventTimelineEntry.payload ● Json! non-null scalar
EventTimelineEntry.recordedAt ● Timestamp! non-null scalar
EventTimelineEntry.sequence ● Int! non-null scalar
EventTimelineEntry.subject ● AuditSubject union
Member Of
EventTimelineEntryConnection object ● EventTimelineEntryEdge object
EventTimelineEntryConnection
No description
type EventTimelineEntryConnection {
edges: [EventTimelineEntryEdge!]!
nodes: [EventTimelineEntry!]!
pageInfo: PageInfo!
}
Fields
EventTimelineEntryConnection.edges ● [EventTimelineEntryEdge!]! non-null object
A list of edges.
EventTimelineEntryConnection.nodes ● [EventTimelineEntry!]! non-null object
A list of nodes.
EventTimelineEntryConnection.pageInfo ● PageInfo! non-null object
Information to aid in pagination.
Member Of
ApprovalProcess object ● BitcoinPurchase object ● Collateral object ● Committee object ● CreditFacility object ● CreditFacilityDisbursal object ● CreditFacilityPaymentAllocation object ● CreditFacilityProposal object ● Customer object ● CustomerDocument object ● Deposit object ● DepositAccount object ● DepositAccountProduct object ● DepositAccountProductAgreement object ● Liquidation object ● Note object ● OpenFiscalYear object ● PendingCreditFacility object ● PermissionSet object ● Policy object ● Prospect object ● Role object ● User object ● Withdrawal object
EventTimelineEntryEdge
An edge in a connection.
type EventTimelineEntryEdge {
cursor: String!
node: EventTimelineEntry!
}
Fields
EventTimelineEntryEdge.cursor ● String! non-null scalar
A cursor for use in pagination
EventTimelineEntryEdge.node ● EventTimelineEntry! non-null object
The item at the end of the edge
Member Of
EventTimelineEntryConnection object
ExchangeAccountingIntegration
No description
type ExchangeAccountingIntegration {
bitcoinCostOfRevenueParentCode: AccountCode!
bitcoinSalesRevenueParentCode: AccountCode!
chartOfAccountsId: ChartOfAccountsId!
proprietaryBtcInventoryParentCode: AccountCode!
proprietaryBtcInventorySourceParentCode: AccountCode!
}
Fields
ExchangeAccountingIntegration.bitcoinCostOfRevenueParentCode ● AccountCode! non-null scalar
ExchangeAccountingIntegration.bitcoinSalesRevenueParentCode ● AccountCode! non-null scalar
ExchangeAccountingIntegration.chartOfAccountsId ● ChartOfAccountsId! non-null scalar
ExchangeAccountingIntegration.proprietaryBtcInventoryParentCode ● AccountCode! non-null scalar
ExchangeAccountingIntegration.proprietaryBtcInventorySourceParentCode ● AccountCode! non-null scalar
Returned By
exchangeAccountingIntegration query
Member Of
ExchangeAccountingIntegrationConfigurePayloadSuccess object
ExchangeAccountingIntegrationConfigurePayloadError
No description
type ExchangeAccountingIntegrationConfigurePayloadError {
code: ExchangeAccountingIntegrationConfigureErrorCode!
}
Fields
ExchangeAccountingIntegrationConfigurePayloadError.code ● ExchangeAccountingIntegrationConfigureErrorCode! non-null enum
Implemented By
ExchangeAccountingIntegrationConfigurePayload union
ExchangeAccountingIntegrationConfigurePayloadSuccess
No description
type ExchangeAccountingIntegrationConfigurePayloadSuccess {
exchangeAccountingIntegration: ExchangeAccountingIntegration!
}
Fields
ExchangeAccountingIntegrationConfigurePayloadSuccess.exchangeAccountingIntegration ● ExchangeAccountingIntegration! non-null object
Implemented By
ExchangeAccountingIntegrationConfigurePayload union
ExchangeRate
No description
type ExchangeRate {
asOf: Timestamp
freshness: Freshness!
pair: CurrencyPair!
rate: Decimal!
rateInQuote: Money!
}
Fields
ExchangeRate.asOf ● Timestamp scalar
ExchangeRate.freshness ● Freshness! non-null enum
ExchangeRate.pair ● CurrencyPair! non-null object
ExchangeRate.rate ● Decimal! non-null scalar
ExchangeRate.rateInQuote ● Money! non-null object
Returned By
exchangeRates query ● exchangeRateUpdated subscription
ExchangeRateProvider
No description
type ExchangeRateProvider {
active: Boolean!
createdAt: Timestamp!
exchangeRateProviderId: PriceProviderId!
isManual: Boolean!
latestExchangeRate: Decimal
name: String!
pair: CurrencyPair!
provider: String!
}
Fields
ExchangeRateProvider.active ● Boolean! non-null scalar
ExchangeRateProvider.createdAt ● Timestamp! non-null scalar
ExchangeRateProvider.exchangeRateProviderId ● PriceProviderId! non-null scalar
ExchangeRateProvider.isManual ● Boolean! non-null scalar
ExchangeRateProvider.latestExchangeRate ● Decimal scalar
Latest provider rate in quote major units per base major unit, without rounding to the quote currency's minor units. Null for inactive providers or providers with no observation.
ExchangeRateProvider.name ● String! non-null scalar
ExchangeRateProvider.pair ● CurrencyPair! non-null object
ExchangeRateProvider.provider ● String! non-null scalar
Returned By
exchangeRateProvider query
Member Of
ExchangeRateProviderActivatePayloadSuccess object ● ExchangeRateProviderConnection object ● ExchangeRateProviderDeactivatePayloadSuccess object ● ExchangeRateProviderEdge object ● ExchangeRateProviderManualExchangeRateUpdatePayloadSuccess object
ExchangeRateProviderActivatePayloadError
No description
type ExchangeRateProviderActivatePayloadError {
code: ExchangeRateProviderActivateErrorCode!
}
Fields
ExchangeRateProviderActivatePayloadError.code ● ExchangeRateProviderActivateErrorCode! non-null enum
Implemented By
ExchangeRateProviderActivatePayload union
ExchangeRateProviderActivatePayloadSuccess
No description
type ExchangeRateProviderActivatePayloadSuccess {
exchangeRateProvider: ExchangeRateProvider!
}
Fields
ExchangeRateProviderActivatePayloadSuccess.exchangeRateProvider ● ExchangeRateProvider! non-null object
Implemented By
ExchangeRateProviderActivatePayload union
ExchangeRateProviderConnection
No description
type ExchangeRateProviderConnection {
edges: [ExchangeRateProviderEdge!]!
nodes: [ExchangeRateProvider!]!
pageInfo: PageInfo!
}
Fields
ExchangeRateProviderConnection.edges ● [ExchangeRateProviderEdge!]! non-null object
A list of edges.
ExchangeRateProviderConnection.nodes ● [ExchangeRateProvider!]! non-null object
A list of nodes.
ExchangeRateProviderConnection.pageInfo ● PageInfo! non-null object
Information to aid in pagination.
Returned By
exchangeRateProviders query
ExchangeRateProviderDeactivatePayloadError
No description
type ExchangeRateProviderDeactivatePayloadError {
code: ExchangeRateProviderDeactivateErrorCode!
}
Fields
ExchangeRateProviderDeactivatePayloadError.code ● ExchangeRateProviderDeactivateErrorCode! non-null enum
Implemented By
ExchangeRateProviderDeactivatePayload union
ExchangeRateProviderDeactivatePayloadSuccess
No description
type ExchangeRateProviderDeactivatePayloadSuccess {
exchangeRateProvider: ExchangeRateProvider!
}
Fields
ExchangeRateProviderDeactivatePayloadSuccess.exchangeRateProvider ● ExchangeRateProvider! non-null object
Implemented By
ExchangeRateProviderDeactivatePayload union
ExchangeRateProviderEdge
An edge in a connection.
type ExchangeRateProviderEdge {
cursor: String!
node: ExchangeRateProvider!
}
Fields
ExchangeRateProviderEdge.cursor ● String! non-null scalar
A cursor for use in pagination
ExchangeRateProviderEdge.node ● ExchangeRateProvider! non-null object
The item at the end of the edge
Member Of
ExchangeRateProviderConnection object
ExchangeRateProviderManualExchangeRateUpdatePayloadError
No description
type ExchangeRateProviderManualExchangeRateUpdatePayloadError {
code: ExchangeRateProviderManualExchangeRateUpdateErrorCode!
}
Fields
ExchangeRateProviderManualExchangeRateUpdatePayloadError.code ● ExchangeRateProviderManualExchangeRateUpdateErrorCode! non-null enum
Implemented By
ExchangeRateProviderManualExchangeRateUpdatePayload union
ExchangeRateProviderManualExchangeRateUpdatePayloadSuccess
No description
type ExchangeRateProviderManualExchangeRateUpdatePayloadSuccess {
exchangeRateProvider: ExchangeRateProvider!
}
Fields
ExchangeRateProviderManualExchangeRateUpdatePayloadSuccess.exchangeRateProvider ● ExchangeRateProvider! non-null object
Implemented By
ExchangeRateProviderManualExchangeRateUpdatePayload union
FiniteLtvPct
No description
type FiniteLtvPct {
value: LtvPctValue!
}
Fields
FiniteLtvPct.value ● LtvPctValue! non-null scalar
Implemented By
LtvPct union
FiscalMonthClosure
No description
type FiscalMonthClosure {
closedAsOf: AccountingDate!
closedAt: Timestamp!
}
Fields
FiscalMonthClosure.closedAsOf ● AccountingDate! non-null scalar
FiscalMonthClosure.closedAt ● Timestamp! non-null scalar
Member Of
OpenFiscalYear object
FiscalYear
No description
type FiscalYear {
chartOfAccountsId: ChartOfAccountsId!
createdAt: Timestamp!
fiscalYearId: FiscalYearId!
openedAsOf: AccountingDate!
reference: String!
status: FiscalYearStatus!
year: String!
}
Fields
FiscalYear.chartOfAccountsId ● ChartOfAccountsId! non-null scalar
FiscalYear.createdAt ● Timestamp! non-null scalar
FiscalYear.fiscalYearId ● FiscalYearId! non-null scalar
FiscalYear.openedAsOf ● AccountingDate! non-null scalar
FiscalYear.reference ● String! non-null scalar
FiscalYear.status ● FiscalYearStatus! non-null enum
FiscalYear.year ● String! non-null scalar
Member Of
FiscalYearConnection object ● FiscalYearEdge object
FiscalYearCloseMonthPayloadError
No description
type FiscalYearCloseMonthPayloadError {
code: FiscalYearCloseMonthErrorCode!
}
Fields
FiscalYearCloseMonthPayloadError.code ● FiscalYearCloseMonthErrorCode! non-null enum
Implemented By
FiscalYearCloseMonthPayload union
FiscalYearCloseMonthPayloadSuccess
No description
type FiscalYearCloseMonthPayloadSuccess {
openFiscalYear: OpenFiscalYear!
}
Fields
FiscalYearCloseMonthPayloadSuccess.openFiscalYear ● OpenFiscalYear! non-null object
Implemented By
FiscalYearCloseMonthPayload union
FiscalYearClosePayloadError
No description
type FiscalYearClosePayloadError {
code: FiscalYearCloseErrorCode!
}
Fields
FiscalYearClosePayloadError.code ● FiscalYearCloseErrorCode! non-null enum
Implemented By
FiscalYearClosePayload union
FiscalYearClosePayloadSuccess
No description
type FiscalYearClosePayloadSuccess {
pastFiscalYear: PastFiscalYear!
}
Fields
FiscalYearClosePayloadSuccess.pastFiscalYear ● PastFiscalYear! non-null object
Implemented By
FiscalYearClosePayload union
FiscalYearConnection
No description
type FiscalYearConnection {
edges: [FiscalYearEdge!]!
nodes: [FiscalYear!]!
pageInfo: PageInfo!
}
Fields
FiscalYearConnection.edges ● [FiscalYearEdge!]! non-null object
A list of edges.
FiscalYearConnection.nodes ● [FiscalYear!]! non-null object
A list of nodes.
FiscalYearConnection.pageInfo ● PageInfo! non-null object
Information to aid in pagination.
Returned By
fiscalYears query
FiscalYearEdge
An edge in a connection.
type FiscalYearEdge {
cursor: String!
node: FiscalYear!
}
Fields
FiscalYearEdge.cursor ● String! non-null scalar
A cursor for use in pagination
FiscalYearEdge.node ● FiscalYear! non-null object
The item at the end of the edge
Member Of
FiscalYearConnection object
FiscalYearInitPayloadError
No description
type FiscalYearInitPayloadError {
code: FiscalYearInitErrorCode!
}
Fields
FiscalYearInitPayloadError.code ● FiscalYearInitErrorCode! non-null enum
Implemented By
FiscalYearInitPayload union
FiscalYearInitPayloadSuccess
No description
type FiscalYearInitPayloadSuccess {
openFiscalYear: OpenFiscalYear!
}
Fields
FiscalYearInitPayloadSuccess.openFiscalYear ● OpenFiscalYear! non-null object
Implemented By
FiscalYearInitPayload union
FreezeEntry
No description
type FreezeEntry {
amount: Money!
ledgerTransactionId: LedgerTransactionId!
recordedAt: Timestamp!
}
Fields
FreezeEntry.amount ● Money! non-null object
FreezeEntry.ledgerTransactionId ● LedgerTransactionId! non-null scalar
FreezeEntry.recordedAt ● Timestamp! non-null scalar
Implemented By
DepositAccountHistoryEntry union
FullName
No description
type FullName {
first: String!
last: String!
}
Fields
FullName.first ● String! non-null scalar
FullName.last ● String! non-null scalar
Member Of
PersonalInfo object
FxCurrencyPolicy
No description
type FxCurrencyPolicy {
functional: CurrencyCode!
supported: [CurrencyCode!]!
}
Fields
FxCurrencyPolicy.functional ● CurrencyCode! non-null scalar
FxCurrencyPolicy.supported ● [CurrencyCode!]! non-null scalar
Member Of
FxCurrencyPolicyConfigurePayloadSuccess object
FxCurrencyPolicyConfigurePayloadError
No description
type FxCurrencyPolicyConfigurePayloadError {
code: FxCurrencyPolicyConfigureErrorCode!
}
Fields
FxCurrencyPolicyConfigurePayloadError.code ● FxCurrencyPolicyConfigureErrorCode! non-null enum
Implemented By
FxCurrencyPolicyConfigurePayload union
FxCurrencyPolicyConfigurePayloadSuccess
No description
type FxCurrencyPolicyConfigurePayloadSuccess {
fxCurrencyPolicy: FxCurrencyPolicy!
}
Fields
FxCurrencyPolicyConfigurePayloadSuccess.fxCurrencyPolicy ● FxCurrencyPolicy! non-null object
Implemented By
FxCurrencyPolicyConfigurePayload union
FxModuleConfig
No description
type FxModuleConfig {
chartOfAccountsId: ChartOfAccountsId!
realizedGainParentCode: AccountCode!
realizedLossParentCode: AccountCode!
tradingAccountParentCode: AccountCode!
unrealizedGainParentCode: AccountCode!
unrealizedLossParentCode: AccountCode!
}
Fields
FxModuleConfig.chartOfAccountsId ● ChartOfAccountsId! non-null scalar
FxModuleConfig.realizedGainParentCode ● AccountCode! non-null scalar
FxModuleConfig.realizedLossParentCode ● AccountCode! non-null scalar
FxModuleConfig.tradingAccountParentCode ● AccountCode! non-null scalar
FxModuleConfig.unrealizedGainParentCode ● AccountCode! non-null scalar
FxModuleConfig.unrealizedLossParentCode ● AccountCode! non-null scalar
Returned By
fxConfig query
Member Of
FxModuleConfigurePayloadSuccess object
FxModuleConfigurePayloadError
No description
type FxModuleConfigurePayloadError {
code: FxModuleConfigureErrorCode!
}
Fields
FxModuleConfigurePayloadError.code ● FxModuleConfigureErrorCode! non-null enum
Implemented By
FxModuleConfigurePayload union
FxModuleConfigurePayloadSuccess
No description
type FxModuleConfigurePayloadSuccess {
fxConfig: FxModuleConfig!
}
Fields
FxModuleConfigurePayloadSuccess.fxConfig ● FxModuleConfig! non-null object
Implemented By
FxModuleConfigurePayload union
GovernanceNavigationItems
No description
type GovernanceNavigationItems {
approvalProcess: Boolean!
committee: Boolean!
policy: Boolean!
}
Fields
GovernanceNavigationItems.approvalProcess ● Boolean! non-null scalar
GovernanceNavigationItems.committee ● Boolean! non-null scalar
GovernanceNavigationItems.policy ● Boolean! non-null scalar
Member Of
VisibleNavigationItems object
IndividualParty
No description
type IndividualParty {
customerType: CustomerType!
email: PiiEmail!
individualPartyId: IndividualPartyId!
personalInfo: PiiPersonalInfo!
userCanUpdatePii: Boolean!
verification: Verification
}
Fields
IndividualParty.customerType ● CustomerType! non-null enum
IndividualParty.email ● PiiEmail! non-null object
IndividualParty.individualPartyId ● IndividualPartyId! non-null scalar
IndividualParty.personalInfo ● PiiPersonalInfo! non-null object
IndividualParty.userCanUpdatePii ● Boolean! non-null scalar
IndividualParty.verification ● Verification object
Member Of
IndividualPartyCreatePayloadSuccess object ● IndividualPartyEmailUpdatePayloadSuccess object ● IndividualPartyPersonalInfoUpdatePayloadSuccess object ● OrganizationMember object
Implemented By
Party union
IndividualPartyCreatePayloadError
No description
type IndividualPartyCreatePayloadError {
code: IndividualPartyCreateErrorCode!
}
Fields
IndividualPartyCreatePayloadError.code ● IndividualPartyCreateErrorCode! non-null enum
Implemented By
IndividualPartyCreatePayload union
IndividualPartyCreatePayloadSuccess
No description
type IndividualPartyCreatePayloadSuccess {
party: IndividualParty!
}
Fields
IndividualPartyCreatePayloadSuccess.party ● IndividualParty! non-null object
Implemented By
IndividualPartyCreatePayload union
IndividualPartyEmailUpdatePayloadError
No description
type IndividualPartyEmailUpdatePayloadError {
code: IndividualPartyEmailUpdateErrorCode!
}
Fields
IndividualPartyEmailUpdatePayloadError.code ● IndividualPartyEmailUpdateErrorCode! non-null enum
Implemented By
IndividualPartyEmailUpdatePayload union
IndividualPartyEmailUpdatePayloadSuccess
No description
type IndividualPartyEmailUpdatePayloadSuccess {
party: IndividualParty!
}
Fields
IndividualPartyEmailUpdatePayloadSuccess.party ● IndividualParty! non-null object
Implemented By
IndividualPartyEmailUpdatePayload union
IndividualPartyPersonalInfoUpdatePayloadError
No description
type IndividualPartyPersonalInfoUpdatePayloadError {
code: IndividualPartyPersonalInfoUpdateErrorCode!
}
Fields
IndividualPartyPersonalInfoUpdatePayloadError.code ● IndividualPartyPersonalInfoUpdateErrorCode! non-null enum
Implemented By
IndividualPartyPersonalInfoUpdatePayload union
IndividualPartyPersonalInfoUpdatePayloadSuccess
No description
type IndividualPartyPersonalInfoUpdatePayloadSuccess {
party: IndividualParty!
}
Fields
IndividualPartyPersonalInfoUpdatePayloadSuccess.party ● IndividualParty! non-null object
Implemented By
IndividualPartyPersonalInfoUpdatePayload union
InfiniteLtvPct
No description
type InfiniteLtvPct {
isInfinite: Boolean!
}
Fields
InfiniteLtvPct.isInfinite ● Boolean! non-null scalar
Implemented By
LtvPct union
Integration
No description
type Integration {
system: String!
}
Fields
Integration.system ● String! non-null scalar
Implemented By
AuditSubject union
Interest
No description
type Interest {
outstanding: Money!
outstandingPayable: Money!
total: Money!
}
Fields
Interest.outstanding ● Money! non-null object
Interest.outstandingPayable ● Money! non-null object
Interest.total ● Money! non-null object
Member Of
CreditFacilityBalance object
KycProvider
No description
type KycProvider {
createdAt: Timestamp!
kycProviderId: KycProviderId!
name: String!
provider: String!
}
Fields
KycProvider.createdAt ● Timestamp! non-null scalar
KycProvider.kycProviderId ● KycProviderId! non-null scalar
KycProvider.name ● String! non-null scalar
KycProvider.provider ● String! non-null scalar
Returned By
kycProvider query
Member Of
KycProviderConfigUpdatePayloadSuccess object ● KycProviderConnection object ● KycProviderCreatePayloadSuccess object ● KycProviderEdge object ● Verification object
KycProviderConfigUpdatePayloadError
No description
type KycProviderConfigUpdatePayloadError {
code: KycProviderConfigUpdateErrorCode!
}
Fields
KycProviderConfigUpdatePayloadError.code ● KycProviderConfigUpdateErrorCode! non-null enum
Implemented By
KycProviderConfigUpdatePayload union
KycProviderConfigUpdatePayloadSuccess
No description
type KycProviderConfigUpdatePayloadSuccess {
kycProvider: KycProvider!
}
Fields
KycProviderConfigUpdatePayloadSuccess.kycProvider ● KycProvider! non-null object
Implemented By
KycProviderConfigUpdatePayload union
KycProviderConnection
No description
type KycProviderConnection {
edges: [KycProviderEdge!]!
nodes: [KycProvider!]!
pageInfo: PageInfo!
}
Fields
KycProviderConnection.edges ● [KycProviderEdge!]! non-null object
A list of edges.
KycProviderConnection.nodes ● [KycProvider!]! non-null object
A list of nodes.
KycProviderConnection.pageInfo ● PageInfo! non-null object
Information to aid in pagination.
Returned By
kycProviders query
KycProviderCreatePayloadError
No description
type KycProviderCreatePayloadError {
code: KycProviderCreateErrorCode!
}
Fields
KycProviderCreatePayloadError.code ● KycProviderCreateErrorCode! non-null enum
Implemented By
KycProviderCreatePayload union
KycProviderCreatePayloadSuccess
No description
type KycProviderCreatePayloadSuccess {
kycProvider: KycProvider!
}
Fields
KycProviderCreatePayloadSuccess.kycProvider ● KycProvider! non-null object
Implemented By
KycProviderCreatePayload union
KycProviderEdge
An edge in a connection.
type KycProviderEdge {
cursor: String!
node: KycProvider!
}
Fields
KycProviderEdge.cursor ● String! non-null scalar
A cursor for use in pagination
KycProviderEdge.node ● KycProvider! non-null object
The item at the end of the edge
Member Of
KycProviderConnection object
LedgerAccount
No description
type LedgerAccount {
ancestors: [LedgerAccount!]
balanceRange: LedgerAccountBalanceRange!
balancesByCurrency: [LedgerAccountBalanceRange!]!
children: [LedgerAccount!]
closestAccountWithCode: LedgerAccount
code: AccountCode
entity: LedgerAccountEntity
history(
after: String
first: Int!
): LedgerEntryConnection!
isRootAccount: Boolean!
ledgerAccountId: LedgerAccountId!
name: String!
normalBalanceType: DebitOrCredit!
}
Fields
LedgerAccount.ancestors ● [LedgerAccount!] list object
LedgerAccount.balanceRange ● LedgerAccountBalanceRange! non-null object
LedgerAccount.balancesByCurrency ● [LedgerAccountBalanceRange!]! non-null object
LedgerAccount.children ● [LedgerAccount!] list object
LedgerAccount.closestAccountWithCode ● LedgerAccount object
LedgerAccount.code ● AccountCode scalar
LedgerAccount.entity ● LedgerAccountEntity union
LedgerAccount.history ● LedgerEntryConnection! non-null object
LedgerAccount.history.after ● String scalar
LedgerAccount.history.first ● Int! non-null scalar
LedgerAccount.isRootAccount ● Boolean! non-null scalar
LedgerAccount.ledgerAccountId ● LedgerAccountId! non-null scalar
LedgerAccount.name ● String! non-null scalar
LedgerAccount.normalBalanceType ● DebitOrCredit! non-null enum
Returned By
ledgerAccount query ● ledgerAccountByCode query
Member Of
Collateral object ● CreditFacilityLedgerAccounts object ● DepositAccountLedgerAccounts object ● LedgerAccount object ● LedgerEntry object ● TrialBalance object
LedgerAccountBalance
No description
type LedgerAccountBalance {
currency: Currency!
encumbrance: LedgerAccountBalanceDetails!
pending: LedgerAccountBalanceDetails!
settled: LedgerAccountBalanceDetails!
}
Fields
LedgerAccountBalance.currency ● Currency! non-null object
LedgerAccountBalance.encumbrance ● LedgerAccountBalanceDetails! non-null object
LedgerAccountBalance.pending ● LedgerAccountBalanceDetails! non-null object
LedgerAccountBalance.settled ● LedgerAccountBalanceDetails! non-null object
Member Of
BalanceSheetAccount object ● BalanceSheetAccountFlat object ● LedgerAccountBalanceRange object
LedgerAccountBalanceDetails
No description
type LedgerAccountBalanceDetails {
credit: Money!
debit: Money!
net: SignedMoney!
}
Fields
LedgerAccountBalanceDetails.credit ● Money! non-null object
LedgerAccountBalanceDetails.debit ● Money! non-null object
LedgerAccountBalanceDetails.net ● SignedMoney! non-null object
Member Of
LedgerAccountBalance object
LedgerAccountBalanceRange
No description
type LedgerAccountBalanceRange {
close: LedgerAccountBalance!
currency: Currency!
open: LedgerAccountBalance!
periodActivity: LedgerAccountBalance!
}
Fields
LedgerAccountBalanceRange.close ● LedgerAccountBalance! non-null object
LedgerAccountBalanceRange.currency ● Currency! non-null object
LedgerAccountBalanceRange.open ● LedgerAccountBalance! non-null object
LedgerAccountBalanceRange.periodActivity ● LedgerAccountBalance! non-null object
Member Of
LedgerAccount object ● ProfitAndLossAccount object ● ProfitAndLossAccountFlat object ● ProfitAndLossStatement object ● TrialBalance object
LedgerAccountCsvCreatePayloadError
No description
type LedgerAccountCsvCreatePayloadError {
code: LedgerAccountCsvCreateErrorCode!
}
Fields
LedgerAccountCsvCreatePayloadError.code ● LedgerAccountCsvCreateErrorCode! non-null enum
Implemented By
LedgerAccountCsvCreatePayload union
LedgerAccountCsvCreatePayloadSuccess
No description
type LedgerAccountCsvCreatePayloadSuccess {
ledgerAccountCsvDocument: LedgerAccountCsvDocument!
}
Fields
LedgerAccountCsvCreatePayloadSuccess.ledgerAccountCsvDocument ● LedgerAccountCsvDocument! non-null object
Implemented By
LedgerAccountCsvCreatePayload union
LedgerAccountCsvDocument
No description
type LedgerAccountCsvDocument {
createdAt: Timestamp!
filename: String!
ledgerAccountCsvDocumentId: LedgerAccountCsvDocumentId!
ledgerAccountId: LedgerAccountId!
status: DocumentStatus!
}
Fields
LedgerAccountCsvDocument.createdAt ● Timestamp! non-null scalar
LedgerAccountCsvDocument.filename ● String! non-null scalar
LedgerAccountCsvDocument.ledgerAccountCsvDocumentId ● LedgerAccountCsvDocumentId! non-null scalar
LedgerAccountCsvDocument.ledgerAccountId ● LedgerAccountId! non-null scalar
LedgerAccountCsvDocument.status ● DocumentStatus! non-null enum
Returned By
ledgerAccountCsv query
Member Of
LedgerAccountCsvCreatePayloadSuccess object
LedgerAccountCsvDownloadLinkGeneratePayloadError
No description
type LedgerAccountCsvDownloadLinkGeneratePayloadError {
code: LedgerAccountCsvDownloadLinkGenerateErrorCode!
}
Fields
LedgerAccountCsvDownloadLinkGeneratePayloadError.code ● LedgerAccountCsvDownloadLinkGenerateErrorCode! non-null enum
Implemented By
LedgerAccountCsvDownloadLinkGeneratePayload union
LedgerAccountCsvDownloadLinkGeneratePayloadSuccess
No description
type LedgerAccountCsvDownloadLinkGeneratePayloadSuccess {
url: Url!
}
Fields
LedgerAccountCsvDownloadLinkGeneratePayloadSuccess.url ● Url! non-null scalar
Implemented By
LedgerAccountCsvDownloadLinkGeneratePayload union
LedgerAccountCsvExportUploadedPayload
No description
type LedgerAccountCsvExportUploadedPayload {
documentId: LedgerAccountCsvDocumentId!
}
Fields
LedgerAccountCsvExportUploadedPayload.documentId ● LedgerAccountCsvDocumentId! non-null scalar
Returned By
ledgerAccountCsvExportUploaded subscription
LedgerEntry
No description
type LedgerEntry {
amount: Money!
createdAt: Timestamp!
description: String
direction: DebitOrCredit!
entryType: String!
layer: Layer!
ledgerAccount: LedgerAccount
ledgerEntryId: LedgerEntryId!
ledgerTransaction: LedgerTransaction
}
Fields
LedgerEntry.amount ● Money! non-null object
LedgerEntry.createdAt ● Timestamp! non-null scalar
LedgerEntry.description ● String scalar
LedgerEntry.direction ● DebitOrCredit! non-null enum
LedgerEntry.entryType ● String! non-null scalar
LedgerEntry.layer ● Layer! non-null enum
LedgerEntry.ledgerAccount ● LedgerAccount object
LedgerEntry.ledgerEntryId ● LedgerEntryId! non-null scalar
LedgerEntry.ledgerTransaction ● LedgerTransaction object
Member Of
LedgerEntryConnection object ● LedgerEntryEdge object ● LedgerTransaction object
LedgerEntryConnection
No description
type LedgerEntryConnection {
edges: [LedgerEntryEdge!]!
nodes: [LedgerEntry!]!
pageInfo: PageInfo!
}
Fields
LedgerEntryConnection.edges ● [LedgerEntryEdge!]! non-null object
A list of edges.
LedgerEntryConnection.nodes ● [LedgerEntry!]! non-null object
A list of nodes.
LedgerEntryConnection.pageInfo ● PageInfo! non-null object
Information to aid in pagination.
Returned By
ledgerEntries query
Member Of
LedgerAccount object
LedgerEntryEdge
An edge in a connection.
type LedgerEntryEdge {
cursor: String!
node: LedgerEntry!
}
Fields
LedgerEntryEdge.cursor ● String! non-null scalar
A cursor for use in pagination
LedgerEntryEdge.node ● LedgerEntry! non-null object
The item at the end of the edge
Member Of
LedgerEntryConnection object
LedgerTransaction
No description
type LedgerTransaction {
createdAt: Timestamp!
description: String
effective: Date!
entity: LedgerTransactionEntity
entries: [LedgerEntry!]!
initiatedBy: AuditSubject
ledgerTransactionId: LedgerTransactionId!
}
Fields
LedgerTransaction.createdAt ● Timestamp! non-null scalar
LedgerTransaction.description ● String scalar
LedgerTransaction.effective ● Date! non-null scalar
LedgerTransaction.entity ● LedgerTransactionEntity union
LedgerTransaction.entries ● [LedgerEntry!]! non-null object
LedgerTransaction.initiatedBy ● AuditSubject union
LedgerTransaction.ledgerTransactionId ● LedgerTransactionId! non-null scalar
Returned By
ledgerTransaction query
Member Of
CreditFacilityDisbursal object ● Deposit object ● LedgerEntry object ● LedgerTransactionConnection object ● LedgerTransactionEdge object ● ManualTransaction object ● Withdrawal object
LedgerTransactionConnection
No description
type LedgerTransactionConnection {
edges: [LedgerTransactionEdge!]!
nodes: [LedgerTransaction!]!
pageInfo: PageInfo!
}
Fields
LedgerTransactionConnection.edges ● [LedgerTransactionEdge!]! non-null object
A list of edges.
LedgerTransactionConnection.nodes ● [LedgerTransaction!]! non-null object
A list of nodes.
LedgerTransactionConnection.pageInfo ● PageInfo! non-null object
Information to aid in pagination.
Returned By
ledgerTransactionsForTemplateCode query
LedgerTransactionEdge
An edge in a connection.
type LedgerTransactionEdge {
cursor: String!
node: LedgerTransaction!
}
Fields
LedgerTransactionEdge.cursor ● String! non-null scalar
A cursor for use in pagination
LedgerTransactionEdge.node ● LedgerTransaction! non-null object
The item at the end of the edge
Member Of
LedgerTransactionConnection object
LimitedMaxWithdrawalAmountPerTransaction
No description
type LimitedMaxWithdrawalAmountPerTransaction {
amount: Money!
}
Fields
LimitedMaxWithdrawalAmountPerTransaction.amount ● Money! non-null object
Implemented By
MaxWithdrawalAmountPerTransaction union
Liquidation
No description
type Liquidation {
collateral: Collateral
collateralId: CollateralId!
createdAt: Timestamp!
eventHistory(
after: String
first: Int!
): EventTimelineEntryConnection!
expectedToReceive: Money!
initiallyEstimatedToLiquidate: Money!
liquidationId: LiquidationId!
netProceeds: Money!
saleRecorded: Boolean!
sales: [LiquidationSale!]!
sentCollateral: [LiquidationCollateralSent!]!
sentTotal: Money!
}
Fields
Liquidation.collateral ● Collateral object
Liquidation.collateralId ● CollateralId! non-null scalar
Liquidation.createdAt ● Timestamp! non-null scalar
Liquidation.eventHistory ● EventTimelineEntryConnection! non-null object
Liquidation.eventHistory.after ● String scalar
Liquidation.eventHistory.first ● Int! non-null scalar
Liquidation.expectedToReceive ● Money! non-null object
Liquidation.initiallyEstimatedToLiquidate ● Money! non-null object
Liquidation.liquidationId ● LiquidationId! non-null scalar
Liquidation.netProceeds ● Money! non-null object
Liquidation.saleRecorded ● Boolean! non-null scalar
Liquidation.sales ● [LiquidationSale!]! non-null object
Liquidation.sentCollateral ● [LiquidationCollateralSent!]! non-null object
Liquidation.sentTotal ● Money! non-null object
Returned By
liquidation query
Member Of
CreditFacility object ● CustomerCollateralLiquidationStarted object ● LiquidationConnection object ● LiquidationEdge object
LiquidationCollateralSent
No description
type LiquidationCollateralSent {
amount: Money!
ledgerTransactionId: LedgerTransactionId!
}
Fields
LiquidationCollateralSent.amount ● Money! non-null object
LiquidationCollateralSent.ledgerTransactionId ● LedgerTransactionId! non-null scalar
Member Of
Liquidation object
LiquidationConnection
No description
type LiquidationConnection {
edges: [LiquidationEdge!]!
nodes: [Liquidation!]!
pageInfo: PageInfo!
}
Fields
LiquidationConnection.edges ● [LiquidationEdge!]! non-null object
A list of edges.
LiquidationConnection.nodes ● [Liquidation!]! non-null object
A list of nodes.
LiquidationConnection.pageInfo ● PageInfo! non-null object
Information to aid in pagination.
Returned By
liquidations query
LiquidationEdge
An edge in a connection.
type LiquidationEdge {
cursor: String!
node: Liquidation!
}
Fields
LiquidationEdge.cursor ● String! non-null scalar
A cursor for use in pagination
LiquidationEdge.node ● Liquidation! non-null object
The item at the end of the edge
Member Of
LiquidationConnection object
LiquidationPayment
No description
type LiquidationPayment {
effectiveLiquidationExchangeRate: Money!
exchangeRate: Money!
liquidationPremiumPct: Decimal!
targetLtv: LtvPct!
toLiquidate: Money!
toReceive: Money!
}
Fields
LiquidationPayment.effectiveLiquidationExchangeRate ● Money! non-null object
LiquidationPayment.exchangeRate ● Money! non-null object
LiquidationPayment.liquidationPremiumPct ● Decimal! non-null scalar
LiquidationPayment.targetLtv ● LtvPct! non-null union
LiquidationPayment.toLiquidate ● Money! non-null object
LiquidationPayment.toReceive ● Money! non-null object
Returned By
liquidationPaymentCalculate query
LiquidationSale
No description
type LiquidationSale {
ledgerTransactionId: LedgerTransactionId!
netProceeds: Money!
}
Fields
LiquidationSale.ledgerTransactionId ● LedgerTransactionId! non-null scalar
LiquidationSale.netProceeds ● Money! non-null object
Member Of
Liquidation object
ManualTransaction
No description
type ManualTransaction {
createdAt: Timestamp!
description: String!
effective: AccountingDate!
entries: [ManualTransactionEntry!]!
ledgerTransaction: LedgerTransaction
manualTransactionId: ManualTransactionId!
reference: String!
}
Fields
ManualTransaction.createdAt ● Timestamp! non-null scalar
ManualTransaction.description ● String! non-null scalar
ManualTransaction.effective ● AccountingDate! non-null scalar
ManualTransaction.entries ● [ManualTransactionEntry!]! non-null object
ManualTransaction.ledgerTransaction ● LedgerTransaction object
ManualTransaction.manualTransactionId ● ManualTransactionId! non-null scalar
ManualTransaction.reference ● String! non-null scalar
Returned By
manualTransaction query ● manualTransactionByReference query
Member Of
ManualTransactionConnection object ● ManualTransactionDraftPostPayloadSuccess object ● ManualTransactionEdge object ● ManualTransactionPostPayloadSuccess object
ManualTransactionConnection
No description
type ManualTransactionConnection {
edges: [ManualTransactionEdge!]!
nodes: [ManualTransaction!]!
pageInfo: PageInfo!
}
Fields
ManualTransactionConnection.edges ● [ManualTransactionEdge!]! non-null object
A list of edges.
ManualTransactionConnection.nodes ● [ManualTransaction!]! non-null object
A list of nodes.
ManualTransactionConnection.pageInfo ● PageInfo! non-null object
Information to aid in pagination.
Returned By
manualTransactions query
ManualTransactionDraft
No description
type ManualTransactionDraft {
createdAt: Timestamp!
description: String!
effective: AccountingDate
entries: [ManualTransactionDraftEntry!]!
manualTransactionDraftId: ManualTransactionDraftId!
reference: String
status: ManualTransactionDraftStatus!
}
Fields
ManualTransactionDraft.createdAt ● Timestamp! non-null scalar
ManualTransactionDraft.description ● String! non-null scalar
ManualTransactionDraft.effective ● AccountingDate scalar
ManualTransactionDraft.entries ● [ManualTransactionDraftEntry!]! non-null object
ManualTransactionDraft.manualTransactionDraftId ● ManualTransactionDraftId! non-null scalar
ManualTransactionDraft.reference ● String scalar
ManualTransactionDraft.status ● ManualTransactionDraftStatus! non-null enum
Returned By
manualTransactionDraft query
Member Of
ManualTransactionDraftClosePayloadSuccess object ● ManualTransactionDraftConnection object ● ManualTransactionDraftCreatePayloadSuccess object ● ManualTransactionDraftEdge object ● ManualTransactionDraftUpdatePayloadSuccess object
ManualTransactionDraftClosePayloadError
No description
type ManualTransactionDraftClosePayloadError {
code: ManualTransactionDraftCloseErrorCode!
}
Fields
ManualTransactionDraftClosePayloadError.code ● ManualTransactionDraftCloseErrorCode! non-null enum
Implemented By
ManualTransactionDraftClosePayload union
ManualTransactionDraftClosePayloadSuccess
No description
type ManualTransactionDraftClosePayloadSuccess {
manualTransactionDraft: ManualTransactionDraft!
}
Fields
ManualTransactionDraftClosePayloadSuccess.manualTransactionDraft ● ManualTransactionDraft! non-null object
Implemented By
ManualTransactionDraftClosePayload union
ManualTransactionDraftConnection
No description
type ManualTransactionDraftConnection {
edges: [ManualTransactionDraftEdge!]!
nodes: [ManualTransactionDraft!]!
pageInfo: PageInfo!
}
Fields
ManualTransactionDraftConnection.edges ● [ManualTransactionDraftEdge!]! non-null object
A list of edges.
ManualTransactionDraftConnection.nodes ● [ManualTransactionDraft!]! non-null object
A list of nodes.
ManualTransactionDraftConnection.pageInfo ● PageInfo! non-null object
Information to aid in pagination.
Returned By
manualTransactionDrafts query
ManualTransactionDraftCreatePayloadError
No description
type ManualTransactionDraftCreatePayloadError {
code: ManualTransactionDraftCreateErrorCode!
}
Fields
ManualTransactionDraftCreatePayloadError.code ● ManualTransactionDraftCreateErrorCode! non-null enum
Implemented By
ManualTransactionDraftCreatePayload union
ManualTransactionDraftCreatePayloadSuccess
No description
type ManualTransactionDraftCreatePayloadSuccess {
manualTransactionDraft: ManualTransactionDraft!
}
Fields
ManualTransactionDraftCreatePayloadSuccess.manualTransactionDraft ● ManualTransactionDraft! non-null object
Implemented By
ManualTransactionDraftCreatePayload union
ManualTransactionDraftEdge
An edge in a connection.
type ManualTransactionDraftEdge {
cursor: String!
node: ManualTransactionDraft!
}
Fields
ManualTransactionDraftEdge.cursor ● String! non-null scalar
A cursor for use in pagination
ManualTransactionDraftEdge.node ● ManualTransactionDraft! non-null object
The item at the end of the edge
Member Of
ManualTransactionDraftConnection object
ManualTransactionDraftEntry
No description
type ManualTransactionDraftEntry {
accountRef: AccountCode
amount: MinorUnits
currency: CurrencyCode
description: String
direction: DebitOrCredit
}
Fields
ManualTransactionDraftEntry.accountRef ● AccountCode scalar
ManualTransactionDraftEntry.amount ● MinorUnits scalar
ManualTransactionDraftEntry.currency ● CurrencyCode scalar
ManualTransactionDraftEntry.description ● String scalar
ManualTransactionDraftEntry.direction ● DebitOrCredit enum
Member Of
ManualTransactionDraft object
ManualTransactionDraftPostPayloadError
No description
type ManualTransactionDraftPostPayloadError {
code: ManualTransactionDraftPostErrorCode!
}
Fields
ManualTransactionDraftPostPayloadError.code ● ManualTransactionDraftPostErrorCode! non-null enum
Implemented By
ManualTransactionDraftPostPayload union
ManualTransactionDraftPostPayloadSuccess
No description
type ManualTransactionDraftPostPayloadSuccess {
manualTransaction: ManualTransaction!
}
Fields
ManualTransactionDraftPostPayloadSuccess.manualTransaction ● ManualTransaction! non-null object
Implemented By
ManualTransactionDraftPostPayload union
ManualTransactionDraftUpdatePayloadError
No description
type ManualTransactionDraftUpdatePayloadError {
code: ManualTransactionDraftUpdateErrorCode!
}
Fields
ManualTransactionDraftUpdatePayloadError.code ● ManualTransactionDraftUpdateErrorCode! non-null enum
Implemented By
ManualTransactionDraftUpdatePayload union
ManualTransactionDraftUpdatePayloadSuccess
No description
type ManualTransactionDraftUpdatePayloadSuccess {
manualTransactionDraft: ManualTransactionDraft!
}
Fields
ManualTransactionDraftUpdatePayloadSuccess.manualTransactionDraft ● ManualTransactionDraft! non-null object
Implemented By
ManualTransactionDraftUpdatePayload union
ManualTransactionEdge
An edge in a connection.
type ManualTransactionEdge {
cursor: String!
node: ManualTransaction!
}
Fields
ManualTransactionEdge.cursor ● String! non-null scalar
A cursor for use in pagination
ManualTransactionEdge.node ● ManualTransaction! non-null object
The item at the end of the edge
Member Of
ManualTransactionConnection object
ManualTransactionEntry
No description
type ManualTransactionEntry {
accountRef: String!
amount: Money!
description: String!
direction: DebitOrCredit!
}
Fields
ManualTransactionEntry.accountRef ● String! non-null scalar
ManualTransactionEntry.amount ● Money! non-null object
ManualTransactionEntry.description ● String! non-null scalar
ManualTransactionEntry.direction ● DebitOrCredit! non-null enum
Member Of
ManualTransaction object
ManualTransactionPostPayloadError
No description
type ManualTransactionPostPayloadError {
code: ManualTransactionPostErrorCode!
}
Fields
ManualTransactionPostPayloadError.code ● ManualTransactionPostErrorCode! non-null enum
Implemented By
ManualTransactionPostPayload union
ManualTransactionPostPayloadSuccess
No description
type ManualTransactionPostPayloadSuccess {
manualTransaction: ManualTransaction!
}
Fields
ManualTransactionPostPayloadSuccess.manualTransaction ● ManualTransaction! non-null object
Implemented By
ManualTransactionPostPayload union
ManualTransactionValidatePayloadError
No description
type ManualTransactionValidatePayloadError {
code: ManualTransactionValidateErrorCode!
}
Fields
ManualTransactionValidatePayloadError.code ● ManualTransactionValidateErrorCode! non-null enum
Implemented By
ManualTransactionValidatePayload union
ManualTransactionValidatePayloadSuccess
No description
type ManualTransactionValidatePayloadSuccess {
valid: Boolean!
}
Fields
ManualTransactionValidatePayloadSuccess.valid ● Boolean! non-null scalar
Implemented By
ManualTransactionValidatePayload union
Me
No description
type Me {
user: User!
userCanCreateCreditFacilityProduct: Boolean!
userCanCreateCustodian: Boolean!
userCanCreateDepositAccountProduct: Boolean!
userCanCreateNotificationProvider: Boolean!
userCanCreatePartner: Boolean!
userCanCreateProspect: Boolean!
userCanCreateUser: Boolean!
userCanRequestPipelineRun: Boolean!
visibleNavigationItems: VisibleNavigationItems!
}
Fields
Me.user ● User! non-null object
Me.userCanCreateCreditFacilityProduct ● Boolean! non-null scalar
Me.userCanCreateCustodian ● Boolean! non-null scalar
Me.userCanCreateDepositAccountProduct ● Boolean! non-null scalar
Me.userCanCreateNotificationProvider ● Boolean! non-null scalar
Me.userCanCreatePartner ● Boolean! non-null scalar
Me.userCanCreateProspect ● Boolean! non-null scalar
Me.userCanCreateUser ● Boolean! non-null scalar
Me.userCanRequestPipelineRun ● Boolean! non-null scalar
Me.visibleNavigationItems ● VisibleNavigationItems! non-null object
Returned By
me query
Money
No description
type Money {
amount: MinorUnits!
currency: Currency!
}
Fields
Money.amount ● MinorUnits! non-null scalar
Money.currency ● Currency! non-null object
Member Of
BitcoinInventory object ● BitcoinPurchase object ● CreditFacility object ● CreditFacilityApproved object ● CreditFacilityBalance object ● CreditFacilityCollateralizationUpdated object ● CreditFacilityCollateralSentOut object ● CreditFacilityCollateralUpdated object ● CreditFacilityDisbursal object ● CreditFacilityDisbursalExecuted object ● CreditFacilityIncrementalPayment object ● CreditFacilityInterestAccrued object ● CreditFacilityLiquidationSaleRecorded object ● CreditFacilityPaymentAllocation object ● CreditFacilityProposal object ● CreditFacilityRepaymentPlanEntry object ● Deposit object ● DepositAccountBalance object ● DisbursalEntry object ● Disbursed object ● ExchangeRate object ● FreezeEntry object ● Interest object ● LedgerAccountBalanceDetails object ● LedgerEntry object ● LimitedMaxWithdrawalAmountPerTransaction object ● Liquidation object ● LiquidationCollateralSent object ● LiquidationPayment object ● LiquidationSale object ● ManualTransactionEntry object ● Obligation object ● Payout object ● PayoutDraft object ● PendingCreditFacility object ● PendingCreditFacilityCollateralizationUpdated object ● RailLiquidityByCurrency object ● Receipt object ● UnfreezeEntry object ● Withdrawal object
Note
No description
type Note {
author: AuditSubject
body: String!
createdAt: Timestamp!
editedAt: Timestamp
eventHistory(
after: String
first: Int!
): EventTimelineEntryConnection!
noteId: NoteId!
}
Fields
Note.author ● AuditSubject union
Note.body ● String! non-null scalar
Note.createdAt ● Timestamp! non-null scalar
Note.editedAt ● Timestamp scalar
Note.eventHistory ● EventTimelineEntryConnection! non-null object
Note.eventHistory.after ● String scalar
Note.eventHistory.first ● Int! non-null scalar
Note.noteId ● NoteId! non-null scalar
Member Of
CustomerNoteCreated object ● CustomerNoteCreatePayloadSuccess object ● CustomerNoteUpdatePayloadSuccess object ● NoteConnection object ● NoteEdge object
NoteConnection
No description
type NoteConnection {
edges: [NoteEdge!]!
nodes: [Note!]!
pageInfo: PageInfo!
}
Fields
NoteConnection.edges ● [NoteEdge!]! non-null object
A list of edges.
NoteConnection.nodes ● [Note!]! non-null object
A list of nodes.
NoteConnection.pageInfo ● PageInfo! non-null object
Information to aid in pagination.
Member Of
Customer object
NoteEdge
An edge in a connection.
type NoteEdge {
cursor: String!
node: Note!
}
Fields
NoteEdge.cursor ● String! non-null scalar
A cursor for use in pagination
NoteEdge.node ● Note! non-null object
The item at the end of the edge
Member Of
NoteConnection object
NotificationProvider
No description
type NotificationProvider {
createdAt: Timestamp!
name: String!
notificationProviderId: NotificationProviderId!
provider: NotificationProviderKind!
}
Fields
NotificationProvider.createdAt ● Timestamp! non-null scalar
NotificationProvider.name ● String! non-null scalar
NotificationProvider.notificationProviderId ● NotificationProviderId! non-null scalar
NotificationProvider.provider ● NotificationProviderKind! non-null enum
Returned By
notificationProvider query
Member Of
NotificationProviderConfigUpdatePayloadSuccess object ● NotificationProviderConnection object ● NotificationProviderCreatePayloadSuccess object ● NotificationProviderEdge object
NotificationProviderConfigUpdatePayloadError
No description
type NotificationProviderConfigUpdatePayloadError {
code: NotificationProviderConfigUpdateErrorCode!
}
Fields
NotificationProviderConfigUpdatePayloadError.code ● NotificationProviderConfigUpdateErrorCode! non-null enum
Implemented By
NotificationProviderConfigUpdatePayload union
NotificationProviderConfigUpdatePayloadSuccess
No description
type NotificationProviderConfigUpdatePayloadSuccess {
notificationProvider: NotificationProvider!
}
Fields
NotificationProviderConfigUpdatePayloadSuccess.notificationProvider ● NotificationProvider! non-null object
Implemented By
NotificationProviderConfigUpdatePayload union
NotificationProviderConnection
No description
type NotificationProviderConnection {
edges: [NotificationProviderEdge!]!
nodes: [NotificationProvider!]!
pageInfo: PageInfo!
}
Fields
NotificationProviderConnection.edges ● [NotificationProviderEdge!]! non-null object
A list of edges.
NotificationProviderConnection.nodes ● [NotificationProvider!]! non-null object
A list of nodes.
NotificationProviderConnection.pageInfo ● PageInfo! non-null object
Information to aid in pagination.
Returned By
notificationProviders query
NotificationProviderCreatePayloadError
No description
type NotificationProviderCreatePayloadError {
code: NotificationProviderCreateErrorCode!
}
Fields
NotificationProviderCreatePayloadError.code ● NotificationProviderCreateErrorCode! non-null enum
Implemented By
NotificationProviderCreatePayload union
NotificationProviderCreatePayloadSuccess
No description
type NotificationProviderCreatePayloadSuccess {
notificationProvider: NotificationProvider!
}
Fields
NotificationProviderCreatePayloadSuccess.notificationProvider ● NotificationProvider! non-null object
Implemented By
NotificationProviderCreatePayload union
NotificationProviderEdge
An edge in a connection.
type NotificationProviderEdge {
cursor: String!
node: NotificationProvider!
}
Fields
NotificationProviderEdge.cursor ● String! non-null scalar
A cursor for use in pagination
NotificationProviderEdge.node ● NotificationProvider! non-null object
The item at the end of the edge
Member Of
NotificationProviderConnection object
Obligation
No description
type Obligation {
createdAt: Timestamp!
creditFacility: CreditFacility
creditFacilityId: CreditFacilityId!
customer: Customer
defaultedAt: AccountingDate
dueAt: AccountingDate!
initialAmount: Money!
obligationId: ObligationId!
obligationType: ObligationType!
outstanding: Money!
overdueAt: AccountingDate
status: ObligationStatus!
}
Fields
Obligation.createdAt ● Timestamp! non-null scalar
Obligation.creditFacility ● CreditFacility object
Obligation.creditFacilityId ● CreditFacilityId! non-null scalar
Obligation.customer ● Customer object
Obligation.defaultedAt ● AccountingDate scalar
Obligation.dueAt ● AccountingDate! non-null scalar
Obligation.initialAmount ● Money! non-null object
Obligation.obligationId ● ObligationId! non-null scalar
Obligation.obligationType ● ObligationType! non-null enum
Obligation.outstanding ● Money! non-null object
Obligation.overdueAt ● AccountingDate scalar
Obligation.status ● ObligationStatus! non-null enum
Member Of
CustomerObligationDefaulted object ● ObligationConnection object ● ObligationEdge object
ObligationConnection
No description
type ObligationConnection {
edges: [ObligationEdge!]!
nodes: [Obligation!]!
pageInfo: PageInfo!
}
Fields
ObligationConnection.edges ● [ObligationEdge!]! non-null object
A list of edges.
ObligationConnection.nodes ● [Obligation!]! non-null object
A list of nodes.
ObligationConnection.pageInfo ● PageInfo! non-null object
Information to aid in pagination.
Returned By
obligations query
ObligationEdge
An edge in a connection.
type ObligationEdge {
cursor: String!
node: Obligation!
}
Fields
ObligationEdge.cursor ● String! non-null scalar
A cursor for use in pagination
ObligationEdge.node ● Obligation! non-null object
The item at the end of the edge
Member Of
ObligationConnection object
OpenFiscalYear
No description
type OpenFiscalYear {
chartOfAccountsId: ChartOfAccountsId!
createdAt: Timestamp!
eventHistory(
after: String
first: Int!
): EventTimelineEntryConnection!
isLastMonthOfYearClosed: Boolean!
isOpen: Boolean!
monthClosures: [FiscalMonthClosure!]!
nextMonthToClose: AccountingDate
openFiscalYearId: OpenFiscalYearId!
openedAsOf: AccountingDate!
pastFiscalYear: PastFiscalYear
reference: String!
year: String!
}
Fields
OpenFiscalYear.chartOfAccountsId ● ChartOfAccountsId! non-null scalar
OpenFiscalYear.createdAt ● Timestamp! non-null scalar
OpenFiscalYear.eventHistory ● EventTimelineEntryConnection! non-null object
OpenFiscalYear.eventHistory.after ● String scalar
OpenFiscalYear.eventHistory.first ● Int! non-null scalar
OpenFiscalYear.isLastMonthOfYearClosed ● Boolean! non-null scalar
OpenFiscalYear.isOpen ● Boolean! non-null scalar
OpenFiscalYear.monthClosures ● [FiscalMonthClosure!]! non-null object
OpenFiscalYear.nextMonthToClose ● AccountingDate scalar
OpenFiscalYear.openFiscalYearId ● OpenFiscalYearId! non-null scalar
OpenFiscalYear.openedAsOf ● AccountingDate! non-null scalar
OpenFiscalYear.pastFiscalYear ● PastFiscalYear object
OpenFiscalYear.reference ● String! non-null scalar
OpenFiscalYear.year ● String! non-null scalar
Returned By
fiscalYear query ● fiscalYearByYear query
Member Of
FiscalYearCloseMonthPayloadSuccess object ● FiscalYearInitPayloadSuccess object
OrganizationMember
No description
type OrganizationMember {
individualParty: IndividualParty
individualPartyId: IndividualPartyId!
organizationMemberId: OrganizationMemberId!
roles: [String!]!
}
Fields
OrganizationMember.individualParty ● IndividualParty object
OrganizationMember.individualPartyId ● IndividualPartyId! non-null scalar
OrganizationMember.organizationMemberId ● OrganizationMemberId! non-null scalar
OrganizationMember.roles ● [String!]! non-null scalar
Member Of
OrganizationParty object
OrganizationParty
No description
type OrganizationParty {
companyName: String!
countryOfIncorporation: CountryCode!
customerType: CustomerType!
email: PiiEmail!
members: [OrganizationMember!]!
organizationPartyId: OrganizationPartyId!
userCanUpdatePii: Boolean!
verification: Verification
}
Fields
OrganizationParty.companyName ● String! non-null scalar
OrganizationParty.countryOfIncorporation ● CountryCode! non-null scalar
OrganizationParty.customerType ● CustomerType! non-null enum
OrganizationParty.email ● PiiEmail! non-null object
OrganizationParty.members ● [OrganizationMember!]! non-null object
OrganizationParty.organizationPartyId ● OrganizationPartyId! non-null scalar
OrganizationParty.userCanUpdatePii ● Boolean! non-null scalar
OrganizationParty.verification ● Verification object
Member Of
OrganizationPartyDetailsUpdatePayloadSuccess object ● OrganizationPartyEmailUpdatePayloadSuccess object ● OrganizationPartyMemberAddPayloadSuccess object ● OrganizationPartyMemberRemovePayloadSuccess object ● OrganizationPartyMemberRoleAddPayloadSuccess object ● OrganizationPartyMemberRoleRemovePayloadSuccess object
Implemented By
Party union
OrganizationPartyDetailsUpdatePayloadError
No description
type OrganizationPartyDetailsUpdatePayloadError {
code: OrganizationPartyDetailsUpdateErrorCode!
}
Fields
OrganizationPartyDetailsUpdatePayloadError.code ● OrganizationPartyDetailsUpdateErrorCode! non-null enum
Implemented By
OrganizationPartyDetailsUpdatePayload union
OrganizationPartyDetailsUpdatePayloadSuccess
No description
type OrganizationPartyDetailsUpdatePayloadSuccess {
party: OrganizationParty!
}
Fields
OrganizationPartyDetailsUpdatePayloadSuccess.party ● OrganizationParty! non-null object
Implemented By
OrganizationPartyDetailsUpdatePayload union
OrganizationPartyEmailUpdatePayloadError
No description
type OrganizationPartyEmailUpdatePayloadError {
code: OrganizationPartyEmailUpdateErrorCode!
}
Fields
OrganizationPartyEmailUpdatePayloadError.code ● OrganizationPartyEmailUpdateErrorCode! non-null enum
Implemented By
OrganizationPartyEmailUpdatePayload union
OrganizationPartyEmailUpdatePayloadSuccess
No description
type OrganizationPartyEmailUpdatePayloadSuccess {
party: OrganizationParty!
}
Fields
OrganizationPartyEmailUpdatePayloadSuccess.party ● OrganizationParty! non-null object
Implemented By
OrganizationPartyEmailUpdatePayload union
OrganizationPartyMemberAddPayloadError
No description
type OrganizationPartyMemberAddPayloadError {
code: OrganizationPartyMemberAddErrorCode!
}
Fields
OrganizationPartyMemberAddPayloadError.code ● OrganizationPartyMemberAddErrorCode! non-null enum
Implemented By
OrganizationPartyMemberAddPayload union
OrganizationPartyMemberAddPayloadSuccess
No description
type OrganizationPartyMemberAddPayloadSuccess {
party: OrganizationParty!
}
Fields
OrganizationPartyMemberAddPayloadSuccess.party ● OrganizationParty! non-null object
Implemented By
OrganizationPartyMemberAddPayload union
OrganizationPartyMemberRemovePayloadError
No description
type OrganizationPartyMemberRemovePayloadError {
code: OrganizationPartyMemberRemoveErrorCode!
}
Fields
OrganizationPartyMemberRemovePayloadError.code ● OrganizationPartyMemberRemoveErrorCode! non-null enum
Implemented By
OrganizationPartyMemberRemovePayload union
OrganizationPartyMemberRemovePayloadSuccess
No description
type OrganizationPartyMemberRemovePayloadSuccess {
party: OrganizationParty!
}
Fields
OrganizationPartyMemberRemovePayloadSuccess.party ● OrganizationParty! non-null object
Implemented By
OrganizationPartyMemberRemovePayload union
OrganizationPartyMemberRoleAddPayloadError
No description
type OrganizationPartyMemberRoleAddPayloadError {
code: OrganizationPartyMemberRoleAddErrorCode!
}
Fields
OrganizationPartyMemberRoleAddPayloadError.code ● OrganizationPartyMemberRoleAddErrorCode! non-null enum
Implemented By
OrganizationPartyMemberRoleAddPayload union
OrganizationPartyMemberRoleAddPayloadSuccess
No description
type OrganizationPartyMemberRoleAddPayloadSuccess {
party: OrganizationParty!
}
Fields
OrganizationPartyMemberRoleAddPayloadSuccess.party ● OrganizationParty! non-null object
Implemented By
OrganizationPartyMemberRoleAddPayload union
OrganizationPartyMemberRoleRemovePayloadError
No description
type OrganizationPartyMemberRoleRemovePayloadError {
code: OrganizationPartyMemberRoleRemoveErrorCode!
}
Fields
OrganizationPartyMemberRoleRemovePayloadError.code ● OrganizationPartyMemberRoleRemoveErrorCode! non-null enum
Implemented By
OrganizationPartyMemberRoleRemovePayload union
OrganizationPartyMemberRoleRemovePayloadSuccess
No description
type OrganizationPartyMemberRoleRemovePayloadSuccess {
party: OrganizationParty!
}
Fields
OrganizationPartyMemberRoleRemovePayloadSuccess.party ● OrganizationParty! non-null object
Implemented By
OrganizationPartyMemberRoleRemovePayload union
PageInfo
Information about pagination in a connection
type PageInfo {
endCursor: String
hasNextPage: Boolean!
hasPreviousPage: Boolean!
startCursor: String
}
Fields
PageInfo.endCursor ● String scalar
When paginating forwards, the cursor to continue.
PageInfo.hasNextPage ● Boolean! non-null scalar
When paginating forwards, are there more items?
PageInfo.hasPreviousPage ● Boolean! non-null scalar
When paginating backwards, are there more items?
PageInfo.startCursor ● String scalar
When paginating backwards, the cursor to continue.
Member Of
ApprovalProcessConnection object ● AuditEntryConnection object ● BitcoinPurchaseConnection object ● CommitteeConnection object ● CreditFacilityConnection object ● CreditFacilityDisbursalConnection object ● CreditFacilityProductConnection object ● CreditFacilityProposalConnection object ● CustodianConnection object ● CustomerConnection object ● CustomerTimelineEntryConnection object ● DepositAccountConnection object ● DepositAccountHistoryEntryConnection object ● DepositAccountProductConnection object ● DepositConnection object ● DomainConfigConnection object ● EodProcessConnection object ● EventTimelineEntryConnection object ● ExchangeRateProviderConnection object ● FiscalYearConnection object ● KycProviderConnection object ● LedgerEntryConnection object ● LedgerTransactionConnection object ● LiquidationConnection object ● ManualTransactionConnection object ● ManualTransactionDraftConnection object ● NoteConnection object ● NotificationProviderConnection object ● ObligationConnection object ● PartnerConnection object ● PartnerUserConnection object ● PaymentProviderConnection object ● PayoutConnection object ● PendingCreditFacilityConnection object ● PermissionSetConnection object ● PiiErasureProcessConnection object ● PipelineRunConnection object ● PolicyConnection object ● ProspectConnection object ● QueryTemplateConnection object ● RailConnection object ● ReceiptConnection object ● RoleConnection object ● TransactionTemplateConnection object ● UserConnection object ● WithdrawalConnection object
Partner
No description
type Partner {
createdAt: Timestamp!
name: String!
partnerId: PartnerId!
partnerUsers(
after: String
first: Int!
): PartnerUserConnection!
status: PartnerStatus!
}
Fields
Partner.createdAt ● Timestamp! non-null scalar
Partner.name ● String! non-null scalar
Partner.partnerId ● PartnerId! non-null scalar
Partner.partnerUsers ● PartnerUserConnection! non-null object
Partner.partnerUsers.after ● String scalar
Partner.partnerUsers.first ● Int! non-null scalar
Partner.status ● PartnerStatus! non-null enum
Returned By
partner query
Member Of
CreditFacilityProduct object ● Customer object ● DepositAccountProduct object ● PartnerActivatePayloadSuccess object ● PartnerConnection object ● PartnerDeactivatePayloadSuccess object ● PartnerEdge object ● PartnerInvitation object ● PartnerUpdatePayloadSuccess object ● Prospect object
PartnerActivatePayloadError
No description
type PartnerActivatePayloadError {
code: PartnerActivateErrorCode!
}
Fields
PartnerActivatePayloadError.code ● PartnerActivateErrorCode! non-null enum
Implemented By
PartnerActivatePayload union
PartnerActivatePayloadSuccess
No description
type PartnerActivatePayloadSuccess {
partner: Partner!
}
Fields
PartnerActivatePayloadSuccess.partner ● Partner! non-null object
Implemented By
PartnerActivatePayload union
PartnerApiKey
No description
type PartnerApiKey {
createdAt: Timestamp!
name: String!
partnerApiKeyId: PartnerApiKeyId!
partnerId: PartnerId!
}
Fields
PartnerApiKey.createdAt ● Timestamp! non-null scalar
PartnerApiKey.name ● String! non-null scalar
PartnerApiKey.partnerApiKeyId ● PartnerApiKeyId! non-null scalar
PartnerApiKey.partnerId ● PartnerId! non-null scalar
Implemented By
AuditSubject union
PartnerConnection
No description
type PartnerConnection {
edges: [PartnerEdge!]!
nodes: [Partner!]!
pageInfo: PageInfo!
}
Fields
PartnerConnection.edges ● [PartnerEdge!]! non-null object
A list of edges.
PartnerConnection.nodes ● [Partner!]! non-null object
A list of nodes.
PartnerConnection.pageInfo ● PageInfo! non-null object
Information to aid in pagination.
Returned By
partners query
PartnerCreatePayloadError
No description
type PartnerCreatePayloadError {
code: PartnerCreateErrorCode!
}
Fields
PartnerCreatePayloadError.code ● PartnerCreateErrorCode! non-null enum
Implemented By
PartnerCreatePayload union
PartnerCreatePayloadSuccess
No description
type PartnerCreatePayloadSuccess {
invitation: PartnerInvitation!
}
Fields
PartnerCreatePayloadSuccess.invitation ● PartnerInvitation! non-null object
Implemented By
PartnerCreatePayload union
PartnerDeactivatePayloadError
No description
type PartnerDeactivatePayloadError {
code: PartnerDeactivateErrorCode!
}
Fields
PartnerDeactivatePayloadError.code ● PartnerDeactivateErrorCode! non-null enum
Implemented By
PartnerDeactivatePayload union
PartnerDeactivatePayloadSuccess
No description
type PartnerDeactivatePayloadSuccess {
partner: Partner!
}
Fields
PartnerDeactivatePayloadSuccess.partner ● Partner! non-null object
Implemented By
PartnerDeactivatePayload union
PartnerEdge
An edge in a connection.
type PartnerEdge {
cursor: String!
node: Partner!
}
Fields
PartnerEdge.cursor ● String! non-null scalar
A cursor for use in pagination
PartnerEdge.node ● Partner! non-null object
The item at the end of the edge
Member Of
PartnerConnection object
PartnerInvitation
No description
type PartnerInvitation {
partner: Partner!
partnerUser: PartnerUser!
}
Fields
PartnerInvitation.partner ● Partner! non-null object
PartnerInvitation.partnerUser ● PartnerUser! non-null object
Member Of
PartnerCreatePayloadSuccess object
PartnerUpdatePayloadError
No description
type PartnerUpdatePayloadError {
code: PartnerUpdateErrorCode!
}
Fields
PartnerUpdatePayloadError.code ● PartnerUpdateErrorCode! non-null enum
Implemented By
PartnerUpdatePayload union
PartnerUpdatePayloadSuccess
No description
type PartnerUpdatePayloadSuccess {
partner: Partner!
}
Fields
PartnerUpdatePayloadSuccess.partner ● Partner! non-null object
Implemented By
PartnerUpdatePayload union
PartnerUser
No description
type PartnerUser {
createdAt: Timestamp!
email: String!
partnerId: PartnerId!
partnerUserId: PartnerUserId!
}
Fields
PartnerUser.createdAt ● Timestamp! non-null scalar
PartnerUser.email ● String! non-null scalar
PartnerUser.partnerId ● PartnerId! non-null scalar
PartnerUser.partnerUserId ● PartnerUserId! non-null scalar
Member Of
PartnerInvitation object ● PartnerUserConnection object ● PartnerUserEdge object
Implemented By
AuditSubject union
PartnerUserConnection
No description
type PartnerUserConnection {
edges: [PartnerUserEdge!]!
nodes: [PartnerUser!]!
pageInfo: PageInfo!
}
Fields
PartnerUserConnection.edges ● [PartnerUserEdge!]! non-null object
A list of edges.
PartnerUserConnection.nodes ● [PartnerUser!]! non-null object
A list of nodes.
PartnerUserConnection.pageInfo ● PageInfo! non-null object
Information to aid in pagination.
Member Of
Partner object
PartnerUserEdge
An edge in a connection.
type PartnerUserEdge {
cursor: String!
node: PartnerUser!
}
Fields
PartnerUserEdge.cursor ● String! non-null scalar
A cursor for use in pagination
PartnerUserEdge.node ● PartnerUser! non-null object
The item at the end of the edge
Member Of
PartnerUserConnection object
PastFiscalYear
No description
type PastFiscalYear {
chartOfAccountsId: ChartOfAccountsId!
closedAsOf: AccountingDate
createdAt: Timestamp!
openFiscalYearId: OpenFiscalYearId!
openedAsOf: AccountingDate!
pastFiscalYearId: PastFiscalYearId!
reference: String!
status: PastFiscalYearStatus!
year: String!
}
Fields
PastFiscalYear.chartOfAccountsId ● ChartOfAccountsId! non-null scalar
PastFiscalYear.closedAsOf ● AccountingDate scalar
PastFiscalYear.createdAt ● Timestamp! non-null scalar
PastFiscalYear.openFiscalYearId ● OpenFiscalYearId! non-null scalar
PastFiscalYear.openedAsOf ● AccountingDate! non-null scalar
PastFiscalYear.pastFiscalYearId ● PastFiscalYearId! non-null scalar
PastFiscalYear.reference ● String! non-null scalar
PastFiscalYear.status ● PastFiscalYearStatus! non-null enum
PastFiscalYear.year ● String! non-null scalar
Member Of
FiscalYearClosePayloadSuccess object ● OpenFiscalYear object
PaymentEndpoint
No description
type PaymentEndpoint {
locators: [PaymentEndpointLocator!]!
paymentEndpointId: PaymentEndpointId!
}
Fields
PaymentEndpoint.locators ● [PaymentEndpointLocator!]! non-null object
PaymentEndpoint.paymentEndpointId ● PaymentEndpointId! non-null scalar
Member Of
DepositAccount object
PaymentEndpointLocator
No description
type PaymentEndpointLocator {
label: String
locator: String!
locatorId: LocatorId!
}
Fields
PaymentEndpointLocator.label ● String scalar
PaymentEndpointLocator.locator ● String! non-null scalar
PaymentEndpointLocator.locatorId ● LocatorId! non-null scalar
Member Of
PaymentEndpoint object
PaymentEntry
No description
type PaymentEntry {
payment: CreditFacilityPaymentAllocation!
recordedAt: Timestamp!
}
Fields
PaymentEntry.payment ● CreditFacilityPaymentAllocation! non-null object
PaymentEntry.recordedAt ● Timestamp! non-null scalar
Implemented By
DepositAccountHistoryEntry union
PaymentProvider
No description
type PaymentProvider {
createdAt: Timestamp!
currencyVariants: [CurrencyVariant!]!
name: String!
paymentProviderId: PaymentProviderId!
provider: String!
}
Fields
PaymentProvider.createdAt ● Timestamp! non-null scalar
PaymentProvider.currencyVariants ● [CurrencyVariant!]! non-null object
Every form of value this provider settles.
PaymentProvider.name ● String! non-null scalar
PaymentProvider.paymentProviderId ● PaymentProviderId! non-null scalar
PaymentProvider.provider ● String! non-null scalar
Returned By
paymentProvider query
Member Of
PaymentProviderConfigUpdatePayloadSuccess object ● PaymentProviderConnection object ● PaymentProviderCreatePayloadSuccess object ● PaymentProviderEdge object ● Rail object
PaymentProviderConfigUpdatePayloadError
No description
type PaymentProviderConfigUpdatePayloadError {
code: PaymentProviderConfigUpdateErrorCode!
}
Fields
PaymentProviderConfigUpdatePayloadError.code ● PaymentProviderConfigUpdateErrorCode! non-null enum
Implemented By
PaymentProviderConfigUpdatePayload union
PaymentProviderConfigUpdatePayloadSuccess
No description
type PaymentProviderConfigUpdatePayloadSuccess {
paymentProvider: PaymentProvider!
}
Fields
PaymentProviderConfigUpdatePayloadSuccess.paymentProvider ● PaymentProvider! non-null object
Implemented By
PaymentProviderConfigUpdatePayload union
PaymentProviderConnection
No description
type PaymentProviderConnection {
edges: [PaymentProviderEdge!]!
nodes: [PaymentProvider!]!
pageInfo: PageInfo!
}
Fields
PaymentProviderConnection.edges ● [PaymentProviderEdge!]! non-null object
A list of edges.
PaymentProviderConnection.nodes ● [PaymentProvider!]! non-null object
A list of nodes.
PaymentProviderConnection.pageInfo ● PageInfo! non-null object
Information to aid in pagination.
Returned By
paymentProviders query
PaymentProviderCreatePayloadError
No description
type PaymentProviderCreatePayloadError {
code: PaymentProviderCreateErrorCode!
}
Fields
PaymentProviderCreatePayloadError.code ● PaymentProviderCreateErrorCode! non-null enum
Implemented By
PaymentProviderCreatePayload union
PaymentProviderCreatePayloadSuccess
No description
type PaymentProviderCreatePayloadSuccess {
paymentProvider: PaymentProvider!
}
Fields
PaymentProviderCreatePayloadSuccess.paymentProvider ● PaymentProvider! non-null object
Implemented By
PaymentProviderCreatePayload union
PaymentProviderEdge
An edge in a connection.
type PaymentProviderEdge {
cursor: String!
node: PaymentProvider!
}
Fields
PaymentProviderEdge.cursor ● String! non-null scalar
A cursor for use in pagination
PaymentProviderEdge.node ● PaymentProvider! non-null object
The item at the end of the edge
Member Of
PaymentProviderConnection object
Payout
No description
type Payout {
amount: Money!
createdAt: Timestamp!
destination: PayoutDestination!
externalId: String!
payoutId: PayoutId!
rail: Rail
railId: RailId!
settledAt: Timestamp
status: PayoutStatus!
withdrawal: Withdrawal
}
Fields
Payout.amount ● Money! non-null object
Payout.createdAt ● Timestamp! non-null scalar
Payout.destination ● PayoutDestination! non-null object
Payout.externalId ● String! non-null scalar
Payout.payoutId ● PayoutId! non-null scalar
Payout.rail ● Rail object
Payout.railId ● RailId! non-null scalar
Payout.settledAt ● Timestamp scalar
Payout.status ● PayoutStatus! non-null enum
Payout.withdrawal ● Withdrawal object
Returned By
payout query
Member Of
PayoutCancelPayloadSuccess object ● PayoutConnection object ● PayoutDraft object ● PayoutEdge object ● PayoutFailPayloadSuccess object ● PayoutRevertPayloadSuccess object ● PayoutSettlePayloadSuccess object ● Withdrawal object
PayoutCancelPayloadError
No description
type PayoutCancelPayloadError {
code: PayoutCancelErrorCode!
}
Fields
PayoutCancelPayloadError.code ● PayoutCancelErrorCode! non-null enum
Implemented By
PayoutCancelPayload union
PayoutCancelPayloadSuccess
No description
type PayoutCancelPayloadSuccess {
payout: Payout!
}
Fields
PayoutCancelPayloadSuccess.payout ● Payout! non-null object
Implemented By
PayoutCancelPayload union
PayoutConnection
No description
type PayoutConnection {
edges: [PayoutEdge!]!
nodes: [Payout!]!
pageInfo: PageInfo!
}
Fields
PayoutConnection.edges ● [PayoutEdge!]! non-null object
A list of edges.
PayoutConnection.nodes ● [Payout!]! non-null object
A list of nodes.
PayoutConnection.pageInfo ● PageInfo! non-null object
Information to aid in pagination.
Returned By
payouts query
PayoutDestination
No description
type PayoutDestination {
currencyVariant: CurrencyVariant!
reference: String!
}
Fields
PayoutDestination.currencyVariant ● CurrencyVariant! non-null object
PayoutDestination.reference ● String! non-null scalar
Member Of
Payout object ● PayoutDraft object
PayoutDraft
No description
type PayoutDraft {
amount: Money!
createdAt: Timestamp!
destination: PayoutDestination!
externalId: String!
payout: Payout
payoutDraftId: PayoutDraftId!
rail: Rail
railId: RailId!
status: PayoutDraftStatus!
withdrawal: Withdrawal
}
Fields
PayoutDraft.amount ● Money! non-null object
PayoutDraft.createdAt ● Timestamp! non-null scalar
PayoutDraft.destination ● PayoutDestination! non-null object
PayoutDraft.externalId ● String! non-null scalar
PayoutDraft.payout ● Payout object
PayoutDraft.payoutDraftId ● PayoutDraftId! non-null scalar
PayoutDraft.rail ● Rail object
PayoutDraft.railId ● RailId! non-null scalar
PayoutDraft.status ● PayoutDraftStatus! non-null enum
PayoutDraft.withdrawal ● Withdrawal object
Member Of
Withdrawal object
PayoutEdge
An edge in a connection.
type PayoutEdge {
cursor: String!
node: Payout!
}
Fields
PayoutEdge.cursor ● String! non-null scalar
A cursor for use in pagination
PayoutEdge.node ● Payout! non-null object
The item at the end of the edge
Member Of
PayoutConnection object
PayoutFailPayloadError
No description
type PayoutFailPayloadError {
code: PayoutFailErrorCode!
}
Fields
PayoutFailPayloadError.code ● PayoutFailErrorCode! non-null enum
Implemented By
PayoutFailPayload union
PayoutFailPayloadSuccess
No description
type PayoutFailPayloadSuccess {
payout: Payout!
}
Fields
PayoutFailPayloadSuccess.payout ● Payout! non-null object
Implemented By
PayoutFailPayload union
PayoutRevertPayloadError
No description
type PayoutRevertPayloadError {
code: PayoutRevertErrorCode!
}
Fields
PayoutRevertPayloadError.code ● PayoutRevertErrorCode! non-null enum
Implemented By
PayoutRevertPayload union
PayoutRevertPayloadSuccess
No description
type PayoutRevertPayloadSuccess {
payout: Payout!
}
Fields
PayoutRevertPayloadSuccess.payout ● Payout! non-null object
Implemented By
PayoutRevertPayload union
PayoutSettlePayloadError
No description
type PayoutSettlePayloadError {
code: PayoutSettleErrorCode!
}
Fields
PayoutSettlePayloadError.code ● PayoutSettleErrorCode! non-null enum
Implemented By
PayoutSettlePayload union
PayoutSettlePayloadSuccess
No description
type PayoutSettlePayloadSuccess {
payout: Payout!
}
Fields
PayoutSettlePayloadSuccess.payout ● Payout! non-null object
Implemented By
PayoutSettlePayload union
PendingCreditFacility
No description
type PendingCreditFacility {
approvalProcess: ApprovalProcess
approvalProcessId: ApprovalProcessId!
collateral: Money!
collateralCurrency: Currency!
collateralId: CollateralId!
collateralizationState: PendingCreditFacilityCollateralizationState!
createdAt: Timestamp!
creditFacilityId: CreditFacilityId!
creditFacilityTerms: TermValues!
custodian: Custodian
customer: Customer
eventHistory(
after: String
first: Int!
): EventTimelineEntryConnection!
facilityAmount: Money!
pendingCreditFacilityId: PendingCreditFacilityId!
product: CreditFacilityProduct
productId: CreditFacilityProductId!
repaymentPlan: [CreditFacilityRepaymentPlanEntry!]!
status: PendingCreditFacilityStatus!
wallet: Wallet
}
Fields
PendingCreditFacility.approvalProcess ● ApprovalProcess object
PendingCreditFacility.approvalProcessId ● ApprovalProcessId! non-null scalar
PendingCreditFacility.collateral ● Money! non-null object
PendingCreditFacility.collateralCurrency ● Currency! non-null object
PendingCreditFacility.collateralId ● CollateralId! non-null scalar
PendingCreditFacility.collateralizationState ● PendingCreditFacilityCollateralizationState! non-null enum
PendingCreditFacility.createdAt ● Timestamp! non-null scalar
PendingCreditFacility.creditFacilityId ● CreditFacilityId! non-null scalar
Canonical credit facility identifier reserved for this facility.
Today this matches pendingCreditFacilityId, but clients should use
this field when they need the active facility reference.
PendingCreditFacility.creditFacilityTerms ● TermValues! non-null object
PendingCreditFacility.custodian ● Custodian object
PendingCreditFacility.customer ● Customer object
PendingCreditFacility.eventHistory ● EventTimelineEntryConnection! non-null object
PendingCreditFacility.eventHistory.after ● String scalar
PendingCreditFacility.eventHistory.first ● Int! non-null scalar
PendingCreditFacility.facilityAmount ● Money! non-null object
PendingCreditFacility.pendingCreditFacilityId ● PendingCreditFacilityId! non-null scalar
PendingCreditFacility.product ● CreditFacilityProduct object
PendingCreditFacility.productId ● CreditFacilityProductId! non-null scalar
PendingCreditFacility.repaymentPlan ● [CreditFacilityRepaymentPlanEntry!]! non-null object
PendingCreditFacility.status ● PendingCreditFacilityStatus! non-null enum
PendingCreditFacility.wallet ● Wallet object
Returned By
pendingCreditFacility query ● pendingCreditFacilityUpdated subscription
Member Of
Customer object ● PendingCreditFacilityConnection object ● PendingCreditFacilityEdge object
PendingCreditFacilityCollateralizationUpdated
No description
type PendingCreditFacilityCollateralizationUpdated {
collateral: Money!
effective: AccountingDate!
exchangeRate: Money!
recordedAt: Timestamp!
state: PendingCreditFacilityCollateralizationState!
}
Fields
PendingCreditFacilityCollateralizationUpdated.collateral ● Money! non-null object
PendingCreditFacilityCollateralizationUpdated.effective ● AccountingDate! non-null scalar
PendingCreditFacilityCollateralizationUpdated.exchangeRate ● Money! non-null object
PendingCreditFacilityCollateralizationUpdated.recordedAt ● Timestamp! non-null scalar
PendingCreditFacilityCollateralizationUpdated.state ● PendingCreditFacilityCollateralizationState! non-null enum
Implemented By
CreditFacilityHistoryEntry union
PendingCreditFacilityConnection
No description
type PendingCreditFacilityConnection {
edges: [PendingCreditFacilityEdge!]!
nodes: [PendingCreditFacility!]!
pageInfo: PageInfo!
}
Fields
PendingCreditFacilityConnection.edges ● [PendingCreditFacilityEdge!]! non-null object
A list of edges.
PendingCreditFacilityConnection.nodes ● [PendingCreditFacility!]! non-null object
A list of nodes.
PendingCreditFacilityConnection.pageInfo ● PageInfo! non-null object
Information to aid in pagination.
Returned By
pendingCreditFacilities query
PendingCreditFacilityEdge
An edge in a connection.
type PendingCreditFacilityEdge {
cursor: String!
node: PendingCreditFacility!
}
Fields
PendingCreditFacilityEdge.cursor ● String! non-null scalar
A cursor for use in pagination
PendingCreditFacilityEdge.node ● PendingCreditFacility! non-null object
The item at the end of the edge
Member Of
PendingCreditFacilityConnection object
PermissionSet
No description
type PermissionSet {
description: String!
eventHistory(
after: String
first: Int!
): EventTimelineEntryConnection!
name: String!
permissionSetId: PermissionSetId!
}
Fields
PermissionSet.description ● String! non-null scalar
PermissionSet.eventHistory ● EventTimelineEntryConnection! non-null object
PermissionSet.eventHistory.after ● String scalar
PermissionSet.eventHistory.first ● Int! non-null scalar
PermissionSet.name ● String! non-null scalar
PermissionSet.permissionSetId ● PermissionSetId! non-null scalar
Returned By
permissionSet query
Member Of
PermissionSetConnection object ● PermissionSetEdge object ● Role object
PermissionSetConnection
No description
type PermissionSetConnection {
edges: [PermissionSetEdge!]!
nodes: [PermissionSet!]!
pageInfo: PageInfo!
}
Fields
PermissionSetConnection.edges ● [PermissionSetEdge!]! non-null object
A list of edges.
PermissionSetConnection.nodes ● [PermissionSet!]! non-null object
A list of nodes.
PermissionSetConnection.pageInfo ● PageInfo! non-null object
Information to aid in pagination.
Returned By
permissionSets query
PermissionSetEdge
An edge in a connection.
type PermissionSetEdge {
cursor: String!
node: PermissionSet!
}
Fields
PermissionSetEdge.cursor ● String! non-null scalar
A cursor for use in pagination
PermissionSetEdge.node ● PermissionSet! non-null object
The item at the end of the edge
Member Of
PermissionSetConnection object
PersonalInfo
No description
type PersonalInfo {
address: PostalAddress
dateOfBirth: Date
name: FullName!
nationality: CountryCode
}
Fields
PersonalInfo.address ● PostalAddress object
PersonalInfo.dateOfBirth ● Date scalar
PersonalInfo.name ● FullName! non-null object
PersonalInfo.nationality ● CountryCode scalar
Member Of
PiiPersonalInfo object
PiiEmail
A PII field together with its visibility. value is non-null iff status
is VISIBLE.
type PiiEmail {
status: PiiStatus!
value: String
}
Fields
PiiEmail.status ● PiiStatus! non-null enum
PiiEmail.value ● String scalar
Member Of
IndividualParty object ● OrganizationParty object
PiiErasureProcess
No description
type PiiErasureProcess {
cancelledAt: Timestamp
completedAt: Timestamp
createdAt: Timestamp!
executeOn: AccountingDate!
phases: [PiiErasureProcessPhase!]!
piiErasureProcessId: PiiErasureProcessId!
status: PiiErasureProcessStatus!
subject: PiiErasureSubject
}
Fields
PiiErasureProcess.cancelledAt ● Timestamp scalar
PiiErasureProcess.completedAt ● Timestamp scalar
PiiErasureProcess.createdAt ● Timestamp! non-null scalar
PiiErasureProcess.executeOn ● AccountingDate! non-null scalar
PiiErasureProcess.phases ● [PiiErasureProcessPhase!]! non-null object
PiiErasureProcess.piiErasureProcessId ● PiiErasureProcessId! non-null scalar
PiiErasureProcess.status ● PiiErasureProcessStatus! non-null enum
PiiErasureProcess.subject ● PiiErasureSubject union
The customer or prospect this erasure process targets.
Returned By
piiErasureProcess query
Member Of
Customer object ● PiiErasureProcessCancelPayloadSuccess object ● PiiErasureProcessConnection object ● PiiErasureProcessEdge object ● PiiErasureProcessSchedulePayloadSuccess object ● Prospect object
PiiErasureProcessCancelPayloadError
No description
type PiiErasureProcessCancelPayloadError {
code: PiiErasureProcessCancelErrorCode!
}
Fields
PiiErasureProcessCancelPayloadError.code ● PiiErasureProcessCancelErrorCode! non-null enum
Implemented By
PiiErasureProcessCancelPayload union
PiiErasureProcessCancelPayloadSuccess
No description
type PiiErasureProcessCancelPayloadSuccess {
piiErasureProcess: PiiErasureProcess!
}
Fields
PiiErasureProcessCancelPayloadSuccess.piiErasureProcess ● PiiErasureProcess! non-null object
Implemented By
PiiErasureProcessCancelPayload union
PiiErasureProcessConnection
No description
type PiiErasureProcessConnection {
edges: [PiiErasureProcessEdge!]!
nodes: [PiiErasureProcess!]!
pageInfo: PageInfo!
}
Fields
PiiErasureProcessConnection.edges ● [PiiErasureProcessEdge!]! non-null object
A list of edges.
PiiErasureProcessConnection.nodes ● [PiiErasureProcess!]! non-null object
A list of nodes.
PiiErasureProcessConnection.pageInfo ● PageInfo! non-null object
Information to aid in pagination.
Returned By
piiErasureProcesses query
PiiErasureProcessEdge
An edge in a connection.
type PiiErasureProcessEdge {
cursor: String!
node: PiiErasureProcess!
}
Fields
PiiErasureProcessEdge.cursor ● String! non-null scalar
A cursor for use in pagination
PiiErasureProcessEdge.node ● PiiErasureProcess! non-null object
The item at the end of the edge
Member Of
PiiErasureProcessConnection object
PiiErasureProcessPhase
No description
type PiiErasureProcessPhase {
completedAt: Timestamp
name: String!
startedAt: Timestamp
status: PiiErasurePhaseExecutionStatus!
}
Fields
PiiErasureProcessPhase.completedAt ● Timestamp scalar
PiiErasureProcessPhase.name ● String! non-null scalar
PiiErasureProcessPhase.startedAt ● Timestamp scalar
PiiErasureProcessPhase.status ● PiiErasurePhaseExecutionStatus! non-null enum
Member Of
PiiErasureProcess object
PiiErasureProcessSchedulePayloadError
No description
type PiiErasureProcessSchedulePayloadError {
code: PiiErasureProcessScheduleErrorCode!
documentsRetainedUntil: AccountingDate
}
Fields
PiiErasureProcessSchedulePayloadError.code ● PiiErasureProcessScheduleErrorCode! non-null enum
PiiErasureProcessSchedulePayloadError.documentsRetainedUntil ● AccountingDate scalar
The last day the subject's documents are retained. Present when
code is PII_ERASURE_DOCUMENTS_RETAINED; erasure can be scheduled
for any later day.
Implemented By
PiiErasureProcessSchedulePayload union
PiiErasureProcessSchedulePayloadSuccess
No description
type PiiErasureProcessSchedulePayloadSuccess {
piiErasureProcess: PiiErasureProcess!
}
Fields
PiiErasureProcessSchedulePayloadSuccess.piiErasureProcess ● PiiErasureProcess! non-null object
Implemented By
PiiErasureProcessSchedulePayload union
PiiPersonalInfo
A PII field together with its visibility. value is non-null iff status
is VISIBLE.
type PiiPersonalInfo {
status: PiiStatus!
value: PersonalInfo
}
Fields
PiiPersonalInfo.status ● PiiStatus! non-null enum
PiiPersonalInfo.value ● PersonalInfo object
Member Of
IndividualParty object
PipelineRun
No description
type PipelineRun {
completedAt: Timestamp
day: AccountingDate!
failureReason: String
kind: PipelineRunKind!
nodeResults: [PipelineRunNodeResult!]!
pipelineRunId: PipelineRunId!
refreshMode: PipelineRunRefreshMode!
startedAt: Timestamp
status: PipelineRunStatus!
}
Fields
PipelineRun.completedAt ● Timestamp scalar
PipelineRun.day ● AccountingDate! non-null scalar
The day this run is labelled with. It names the run, not a historical snapshot: a run rebuilds the warehouse as it stands when dbt executes, so it does not guarantee the marts reflect that day's state.
PipelineRun.failureReason ● String scalar
PipelineRun.kind ● PipelineRunKind! non-null enum
PipelineRun.nodeResults ● [PipelineRunNodeResult!]! non-null object
Per-node outcomes of the latest attempt's dbt invocation. Empty while an attempt is in flight or if the invocation recorded none.
PipelineRun.pipelineRunId ● PipelineRunId! non-null scalar
PipelineRun.refreshMode ● PipelineRunRefreshMode! non-null enum
PipelineRun.startedAt ● Timestamp scalar
PipelineRun.status ● PipelineRunStatus! non-null enum
Returned By
pipelineRun query ● pipelineRunUpdated subscription
Member Of
PipelineRunConnection object ● PipelineRunEdge object ● PipelineRunRequestPayloadSuccess object
PipelineRunConnection
No description
type PipelineRunConnection {
edges: [PipelineRunEdge!]!
nodes: [PipelineRun!]!
pageInfo: PageInfo!
}
Fields
PipelineRunConnection.edges ● [PipelineRunEdge!]! non-null object
A list of edges.
PipelineRunConnection.nodes ● [PipelineRun!]! non-null object
A list of nodes.
PipelineRunConnection.pageInfo ● PageInfo! non-null object
Information to aid in pagination.
Returned By
pipelineRuns query
PipelineRunEdge
An edge in a connection.
type PipelineRunEdge {
cursor: String!
node: PipelineRun!
}
Fields
PipelineRunEdge.cursor ● String! non-null scalar
A cursor for use in pagination
PipelineRunEdge.node ● PipelineRun! non-null object
The item at the end of the edge
Member Of
PipelineRunConnection object
PipelineRunNodeResult
No description
type PipelineRunNodeResult {
executionTime: Float
failures: Int
message: String
nodeName: String!
resourceType: String!
status: String!
uniqueId: String!
}
Fields
PipelineRunNodeResult.executionTime ● Float scalar
Elapsed seconds of the node's dbt run task as reported by dbt 2: includes time waiting for an execution worker, so it is not a measure of SQL execution time and cannot rank nodes by query cost.
PipelineRunNodeResult.failures ● Int scalar
For tests: number of failing rows.
PipelineRunNodeResult.message ● String scalar
dbt's result message, e.g. CREATE VIEW or a test failure detail.
PipelineRunNodeResult.nodeName ● String! non-null scalar
Bare node name, e.g. report_x.
PipelineRunNodeResult.resourceType ● String! non-null scalar
dbt resource type: model, test, seed, ...
PipelineRunNodeResult.status ● String! non-null scalar
dbt-reported node status: success, pass, fail, error, skipped, ...
PipelineRunNodeResult.uniqueId ● String! non-null scalar
Full dbt node id, e.g. model.dbt_lana_pg_dw.report_x.
Member Of
PipelineRun object
PipelineRunRequestPayloadError
No description
type PipelineRunRequestPayloadError {
code: PipelineRunRequestErrorCode!
}
Fields
PipelineRunRequestPayloadError.code ● PipelineRunRequestErrorCode! non-null enum
Implemented By
PipelineRunRequestPayload union
PipelineRunRequestPayloadSuccess
No description
type PipelineRunRequestPayloadSuccess {
pipelineRun: PipelineRun!
}
Fields
PipelineRunRequestPayloadSuccess.pipelineRun ● PipelineRun! non-null object
Implemented By
PipelineRunRequestPayload union
Policy
No description
type Policy {
approvalProcessType: ApprovalProcessType!
eventHistory(
after: String
first: Int!
): EventTimelineEntryConnection!
policyId: PolicyId!
rules: ApprovalRules!
}
Fields
Policy.approvalProcessType ● ApprovalProcessType! non-null enum
Policy.eventHistory ● EventTimelineEntryConnection! non-null object
Policy.eventHistory.after ● String scalar
Policy.eventHistory.first ● Int! non-null scalar
Policy.policyId ● PolicyId! non-null scalar
Policy.rules ● ApprovalRules! non-null union
Returned By
policy query
Member Of
ApprovalProcess object ● PolicyCommitteeAssignPayloadSuccess object ● PolicyConnection object ● PolicyEdge object
PolicyCommitteeAssignPayloadError
No description
type PolicyCommitteeAssignPayloadError {
code: PolicyCommitteeAssignErrorCode!
}
Fields
PolicyCommitteeAssignPayloadError.code ● PolicyCommitteeAssignErrorCode! non-null enum
Implemented By
PolicyCommitteeAssignPayload union
PolicyCommitteeAssignPayloadSuccess
No description
type PolicyCommitteeAssignPayloadSuccess {
policy: Policy!
}
Fields
PolicyCommitteeAssignPayloadSuccess.policy ● Policy! non-null object
Implemented By
PolicyCommitteeAssignPayload union
PolicyConnection
No description
type PolicyConnection {
edges: [PolicyEdge!]!
nodes: [Policy!]!
pageInfo: PageInfo!
}
Fields
PolicyConnection.edges ● [PolicyEdge!]! non-null object
A list of edges.
PolicyConnection.nodes ● [Policy!]! non-null object
A list of nodes.
PolicyConnection.pageInfo ● PageInfo! non-null object
Information to aid in pagination.
Returned By
policies query
PolicyEdge
An edge in a connection.
type PolicyEdge {
cursor: String!
node: Policy!
}
Fields
PolicyEdge.cursor ● String! non-null scalar
A cursor for use in pagination
PolicyEdge.node ● Policy! non-null object
The item at the end of the edge
Member Of
PolicyConnection object
PostalAddress
No description
type PostalAddress {
city: String!
country: CountryCode!
line1: String!
line2: String
state: String
zipCode: String
}
Fields
PostalAddress.city ● String! non-null scalar
PostalAddress.country ● CountryCode! non-null scalar
PostalAddress.line1 ● String! non-null scalar
PostalAddress.line2 ● String scalar
PostalAddress.state ● String scalar
PostalAddress.zipCode ● String scalar
Member Of
PersonalInfo object
ProfitAndLossAccount
No description
type ProfitAndLossAccount {
balanceRange: LedgerAccountBalanceRange!
balancesByCurrency: [LedgerAccountBalanceRange!]!
code: AccountCode
ledgerAccountId: LedgerAccountId!
name: String!
}
Fields
ProfitAndLossAccount.balanceRange ● LedgerAccountBalanceRange! non-null object
ProfitAndLossAccount.balancesByCurrency ● [LedgerAccountBalanceRange!]! non-null object
ProfitAndLossAccount.code ● AccountCode scalar
ProfitAndLossAccount.ledgerAccountId ● LedgerAccountId! non-null scalar
ProfitAndLossAccount.name ● String! non-null scalar
Member Of
ProfitAndLossStatement object
ProfitAndLossAccountFlat
A statement account row, flattened: the chart tree is delivered as one ordered list with each account's parent, so clients can render it at any depth without nesting their selection.
type ProfitAndLossAccountFlat {
balanceRange: LedgerAccountBalanceRange!
balancesByCurrency: [LedgerAccountBalanceRange!]!
code: AccountCode
ledgerAccountId: LedgerAccountId!
name: String!
parentLedgerAccountId: LedgerAccountId!
}
Fields
ProfitAndLossAccountFlat.balanceRange ● LedgerAccountBalanceRange! non-null object
ProfitAndLossAccountFlat.balancesByCurrency ● [LedgerAccountBalanceRange!]! non-null object
ProfitAndLossAccountFlat.code ● AccountCode scalar
ProfitAndLossAccountFlat.ledgerAccountId ● LedgerAccountId! non-null scalar
ProfitAndLossAccountFlat.name ● String! non-null scalar
ProfitAndLossAccountFlat.parentLedgerAccountId ● LedgerAccountId! non-null scalar
Member Of
ProfitAndLossStatement object
ProfitAndLossStatement
No description
type ProfitAndLossStatement {
accounts: [ProfitAndLossAccountFlat!]!
balancesByCurrency: [LedgerAccountBalanceRange!]!
categories: [ProfitAndLossAccount!]
name: String!
total: LedgerAccountBalanceRange!
}
Fields
ProfitAndLossStatement.accounts ● [ProfitAndLossAccountFlat!]! non-null object
ProfitAndLossStatement.balancesByCurrency ● [LedgerAccountBalanceRange!]! non-null object
ProfitAndLossStatement.categories ● [ProfitAndLossAccount!] list object
ProfitAndLossStatement.name ● String! non-null scalar
ProfitAndLossStatement.total ● LedgerAccountBalanceRange! non-null object
Returned By
profitAndLossStatement query
Prospect
No description
type Prospect {
createdAt: Timestamp!
customer: Customer
eventHistory(
after: String
first: Int!
): EventTimelineEntryConnection!
kycStatus: KycStatus!
level: KycLevel!
partner: Partner
party: Party
piiErasureProcess: PiiErasureProcess
prospectId: ProspectId!
publicId: PublicId!
stage: ProspectStage!
userCanCancelPiiErasure: Boolean!
userCanSchedulePiiErasure: Boolean!
}
Fields
Prospect.createdAt ● Timestamp! non-null scalar
Prospect.customer ● Customer object
Prospect.eventHistory ● EventTimelineEntryConnection! non-null object
Prospect.eventHistory.after ● String scalar
Prospect.eventHistory.first ● Int! non-null scalar
Prospect.kycStatus ● KycStatus! non-null enum
Prospect.level ● KycLevel! non-null enum
Prospect.partner ● Partner object
Prospect.party ● Party union
Prospect.piiErasureProcess ● PiiErasureProcess object
The prospect's PII erasure process: the scheduled or in-progress run, or the completed one that erased its PII. Cancelled runs are not surfaced.
Requires the PII erasure viewer permission. Resolves to null when the subject lacks it — regardless of whether a process exists, so existence is not disclosed — which keeps prospect queries that select this field usable for non-viewers.
Prospect.prospectId ● ProspectId! non-null scalar
Prospect.publicId ● PublicId! non-null scalar
Prospect.stage ● ProspectStage! non-null enum
Prospect.userCanCancelPiiErasure ● Boolean! non-null scalar
Prospect.userCanSchedulePiiErasure ● Boolean! non-null scalar
Returned By
prospect query ● prospectByPublicId query ● prospectUpdated subscription
Member Of
ProspectClosePayloadSuccess object ● ProspectConnection object ● ProspectCreatePayloadSuccess object ● ProspectEdge object
Implemented By
PiiErasureSubject union ● PublicIdTarget union
ProspectClosePayloadError
No description
type ProspectClosePayloadError {
code: ProspectCloseErrorCode!
}
Fields
ProspectClosePayloadError.code ● ProspectCloseErrorCode! non-null enum
Implemented By
ProspectClosePayload union
ProspectClosePayloadSuccess
No description
type ProspectClosePayloadSuccess {
prospect: Prospect!
}
Fields
ProspectClosePayloadSuccess.prospect ● Prospect! non-null object
Implemented By
ProspectClosePayload union
ProspectConnection
No description
type ProspectConnection {
edges: [ProspectEdge!]!
nodes: [Prospect!]!
pageInfo: PageInfo!
}
Fields
ProspectConnection.edges ● [ProspectEdge!]! non-null object
A list of edges.
ProspectConnection.nodes ● [Prospect!]! non-null object
A list of nodes.
ProspectConnection.pageInfo ● PageInfo! non-null object
Information to aid in pagination.
Returned By
prospects query
ProspectCreatePayloadError
No description
type ProspectCreatePayloadError {
code: ProspectCreateErrorCode!
}
Fields
ProspectCreatePayloadError.code ● ProspectCreateErrorCode! non-null enum
Implemented By
ProspectCreatePayload union
ProspectCreatePayloadSuccess
No description
type ProspectCreatePayloadSuccess {
prospect: Prospect!
}
Fields
ProspectCreatePayloadSuccess.prospect ● Prospect! non-null object
Implemented By
ProspectCreatePayload union
ProspectEdge
An edge in a connection.
type ProspectEdge {
cursor: String!
node: Prospect!
}
Fields
ProspectEdge.cursor ● String! non-null scalar
A cursor for use in pagination
ProspectEdge.node ● Prospect! non-null object
The item at the end of the edge
Member Of
ProspectConnection object
QueryTemplate
A curated read-only data-mart query over one or more functional categories.
type QueryTemplate {
categories: [QueryTemplateCategory!]!
createdAt: Timestamp!
description: String!
name: String!
queryTemplateId: QueryTemplateId!
sql: String!
}
Fields
QueryTemplate.categories ● [QueryTemplateCategory!]! non-null enum
QueryTemplate.createdAt ● Timestamp! non-null scalar
QueryTemplate.description ● String! non-null scalar
QueryTemplate.name ● String! non-null scalar
QueryTemplate.queryTemplateId ● QueryTemplateId! non-null scalar
QueryTemplate.sql ● String! non-null scalar
Returned By
queryTemplate query
Member Of
QueryTemplateConnection object ● QueryTemplateCreatePayloadSuccess object ● QueryTemplateEdge object ● QueryTemplateUpdatePayloadSuccess object
QueryTemplateConnection
No description
type QueryTemplateConnection {
edges: [QueryTemplateEdge!]!
nodes: [QueryTemplate!]!
pageInfo: PageInfo!
}
Fields
QueryTemplateConnection.edges ● [QueryTemplateEdge!]! non-null object
A list of edges.
QueryTemplateConnection.nodes ● [QueryTemplate!]! non-null object
A list of nodes.
QueryTemplateConnection.pageInfo ● PageInfo! non-null object
Information to aid in pagination.
Returned By
queryTemplates query
QueryTemplateCreatePayloadError
No description
type QueryTemplateCreatePayloadError {
code: QueryTemplateCreateErrorCode!
}
Fields
QueryTemplateCreatePayloadError.code ● QueryTemplateCreateErrorCode! non-null enum
Implemented By
QueryTemplateCreatePayload union
QueryTemplateCreatePayloadSuccess
No description
type QueryTemplateCreatePayloadSuccess {
queryTemplate: QueryTemplate!
}
Fields
QueryTemplateCreatePayloadSuccess.queryTemplate ● QueryTemplate! non-null object
Implemented By
QueryTemplateCreatePayload union
QueryTemplateDeletePayloadError
No description
type QueryTemplateDeletePayloadError {
code: QueryTemplateDeleteErrorCode!
}
Fields
QueryTemplateDeletePayloadError.code ● QueryTemplateDeleteErrorCode! non-null enum
Implemented By
QueryTemplateDeletePayload union
QueryTemplateDeletePayloadSuccess
No description
type QueryTemplateDeletePayloadSuccess {
deletedQueryTemplateId: QueryTemplateId!
}
Fields
QueryTemplateDeletePayloadSuccess.deletedQueryTemplateId ● QueryTemplateId! non-null scalar
Implemented By
QueryTemplateDeletePayload union
QueryTemplateEdge
An edge in a connection.
type QueryTemplateEdge {
cursor: String!
node: QueryTemplate!
}
Fields
QueryTemplateEdge.cursor ● String! non-null scalar
A cursor for use in pagination
QueryTemplateEdge.node ● QueryTemplate! non-null object
The item at the end of the edge
Member Of
QueryTemplateConnection object
QueryTemplateUpdatePayloadError
No description
type QueryTemplateUpdatePayloadError {
code: QueryTemplateUpdateErrorCode!
}
Fields
QueryTemplateUpdatePayloadError.code ● QueryTemplateUpdateErrorCode! non-null enum
Implemented By
QueryTemplateUpdatePayload union
QueryTemplateUpdatePayloadSuccess
No description
type QueryTemplateUpdatePayloadSuccess {
queryTemplate: QueryTemplate!
}
Fields
QueryTemplateUpdatePayloadSuccess.queryTemplate ● QueryTemplate! non-null object
Implemented By
QueryTemplateUpdatePayload union
Rail
No description
type Rail {
createdAt: Timestamp!
currency: RailCurrency!
inboundCreditTiming: InboundCreditTiming!
liquidity: RailLiquidity!
name: String!
provider: PaymentProvider
railId: RailId!
}
Fields
Rail.createdAt ● Timestamp! non-null scalar
Rail.currency ● RailCurrency! non-null object
The currency forms accepted by this rail.
Rail.inboundCreditTiming ● InboundCreditTiming! non-null enum
When a cleared inbound payment on this rail may be booked as a customer credit.
Rail.liquidity ● RailLiquidity! non-null object
This rail's liquidity across all currencies: pending (in-flight) vs settled (cleared) money, split by direction (outbound payouts / inbound receipts), with one entry per currency.
Rail.name ● String! non-null scalar
Rail.provider ● PaymentProvider object
Rail.railId ● RailId! non-null scalar
Returned By
rail query
Member Of
Payout object ● PayoutDraft object ● RailConnection object ● RailCreatePayloadSuccess object ● RailEdge object
RailConnection
No description
type RailConnection {
edges: [RailEdge!]!
nodes: [Rail!]!
pageInfo: PageInfo!
}
Fields
RailConnection.edges ● [RailEdge!]! non-null object
A list of edges.
RailConnection.nodes ● [Rail!]! non-null object
A list of nodes.
RailConnection.pageInfo ● PageInfo! non-null object
Information to aid in pagination.
Returned By
rails query
RailCreatePayloadError
No description
type RailCreatePayloadError {
code: RailCreateErrorCode!
}
Fields
RailCreatePayloadError.code ● RailCreateErrorCode! non-null enum
Implemented By
RailCreatePayload union
RailCreatePayloadSuccess
No description
type RailCreatePayloadSuccess {
rail: Rail!
}
Fields
RailCreatePayloadSuccess.rail ● Rail! non-null object
Implemented By
RailCreatePayload union
RailCurrency
The currency scope of a rail and its specific form, when applicable.
type RailCurrency {
type: RailCurrencyType!
variant: CurrencyVariant
}
Fields
RailCurrency.type ● RailCurrencyType! non-null enum
RailCurrency.variant ● CurrencyVariant object
Member Of
Rail object
RailEdge
An edge in a connection.
type RailEdge {
cursor: String!
node: Rail!
}
Fields
RailEdge.cursor ● String! non-null scalar
A cursor for use in pagination
RailEdge.node ● Rail! non-null object
The item at the end of the edge
Member Of
RailConnection object
RailLiquidity
Per-rail liquidity snapshot with one entry per currency. Each amount is
split by CALA layer: encumbered is drafted and awaiting release,
pending is in-flight (submitted, not yet settled) and settled is the
cleared cumulative flow.
type RailLiquidity {
currencies: [RailLiquidityByCurrency!]!
railId: RailId!
}
Fields
RailLiquidity.currencies ● [RailLiquidityByCurrency!]! non-null object
RailLiquidity.railId ● RailId! non-null scalar
Member Of
Rail object
RailLiquidityByCurrency
No description
type RailLiquidityByCurrency {
currency: CurrencyCode!
inboundPending: Money!
inboundSettled: Money!
outboundEncumbered: Money!
outboundPending: Money!
outboundSettled: Money!
}
Fields
RailLiquidityByCurrency.currency ● CurrencyCode! non-null scalar
RailLiquidityByCurrency.inboundPending ● Money! non-null object
RailLiquidityByCurrency.inboundSettled ● Money! non-null object
RailLiquidityByCurrency.outboundEncumbered ● Money! non-null object
RailLiquidityByCurrency.outboundPending ● Money! non-null object
RailLiquidityByCurrency.outboundSettled ● Money! non-null object
Member Of
RailLiquidity object
Receipt
No description
type Receipt {
amount: Money!
claim: ReceiptClaim
createdAt: Timestamp!
destination: ReceiptDestination
destinationInfo: DestinationInfo!
externalId: String!
railId: RailId!
receiptId: ReceiptId!
settledAt: Timestamp
status: ReceiptStatus!
}
Fields
Receipt.amount ● Money! non-null object
Receipt.claim ● ReceiptClaim object
Receipt.createdAt ● Timestamp! non-null scalar
Receipt.destination ● ReceiptDestination union
Receipt.destinationInfo ● DestinationInfo! non-null object
Receipt.externalId ● String! non-null scalar
Receipt.railId ● RailId! non-null scalar
Receipt.receiptId ● ReceiptId! non-null scalar
Receipt.settledAt ● Timestamp scalar
Receipt.status ● ReceiptStatus! non-null enum
Returned By
receipt query
Member Of
ReceiptCancelPayloadSuccess object ● ReceiptConnection object ● ReceiptEdge object ● ReceiptFailPayloadSuccess object ● ReceiptSettlePayloadSuccess object ● ReceiptSubmitPayloadSuccess object
ReceiptCancelPayloadError
No description
type ReceiptCancelPayloadError {
code: ReceiptCancelErrorCode!
}
Fields
ReceiptCancelPayloadError.code ● ReceiptCancelErrorCode! non-null enum
Implemented By
ReceiptCancelPayload union
ReceiptCancelPayloadSuccess
No description
type ReceiptCancelPayloadSuccess {
receipt: Receipt!
}
Fields
ReceiptCancelPayloadSuccess.receipt ● Receipt! non-null object
Implemented By
ReceiptCancelPayload union
ReceiptClaim
Recorded when a tenant router claims a receipt. The entity guarantees at-most-one claim per receipt.
type ReceiptClaim {
tenant: String!
tenantReference: String!
}
Fields
ReceiptClaim.tenant ● String! non-null scalar
Tenant discriminator, e.g. "deposit_account".
ReceiptClaim.tenantReference ● String! non-null scalar
Tenant-owned reference, e.g. "deposit_account:<uuid>".
Member Of
Receipt object
ReceiptConnection
No description
type ReceiptConnection {
edges: [ReceiptEdge!]!
nodes: [Receipt!]!
pageInfo: PageInfo!
}
Fields
ReceiptConnection.edges ● [ReceiptEdge!]! non-null object
A list of edges.
ReceiptConnection.nodes ● [Receipt!]! non-null object
A list of nodes.
ReceiptConnection.pageInfo ● PageInfo! non-null object
Information to aid in pagination.
Returned By
receipts query
ReceiptEdge
An edge in a connection.
type ReceiptEdge {
cursor: String!
node: Receipt!
}
Fields
ReceiptEdge.cursor ● String! non-null scalar
A cursor for use in pagination
ReceiptEdge.node ● Receipt! non-null object
The item at the end of the edge
Member Of
ReceiptConnection object
ReceiptFailPayloadError
No description
type ReceiptFailPayloadError {
code: ReceiptFailErrorCode!
}
Fields
ReceiptFailPayloadError.code ● ReceiptFailErrorCode! non-null enum
Implemented By
ReceiptFailPayload union
ReceiptFailPayloadSuccess
No description
type ReceiptFailPayloadSuccess {
receipt: Receipt!
}
Fields
ReceiptFailPayloadSuccess.receipt ● Receipt! non-null object
Implemented By
ReceiptFailPayload union
ReceiptSettlePayloadError
No description
type ReceiptSettlePayloadError {
code: ReceiptSettleErrorCode!
}
Fields
ReceiptSettlePayloadError.code ● ReceiptSettleErrorCode! non-null enum
Implemented By
ReceiptSettlePayload union
ReceiptSettlePayloadSuccess
No description
type ReceiptSettlePayloadSuccess {
receipt: Receipt!
}
Fields
ReceiptSettlePayloadSuccess.receipt ● Receipt! non-null object
Implemented By
ReceiptSettlePayload union
ReceiptSubmitPayloadError
No description
type ReceiptSubmitPayloadError {
code: ReceiptSubmitErrorCode!
}
Fields
ReceiptSubmitPayloadError.code ● ReceiptSubmitErrorCode! non-null enum
Implemented By
ReceiptSubmitPayload union
ReceiptSubmitPayloadSuccess
No description
type ReceiptSubmitPayloadSuccess {
receipt: Receipt!
}
Fields
ReceiptSubmitPayloadSuccess.receipt ● Receipt! non-null object
Implemented By
ReceiptSubmitPayload union
ReportDefinition
No description
type ReportDefinition {
filterMode: ReportFilterMode!
friendlyName: String!
latestDataRefreshDate: AccountingDate
norm: String!
outputs: [ReportDefinitionOutput!]!
reportDefinitionId: ReportDefinitionId!
sourceTable: String!
}
Fields
ReportDefinition.filterMode ● ReportFilterMode! non-null enum
ReportDefinition.friendlyName ● String! non-null scalar
ReportDefinition.latestDataRefreshDate ● AccountingDate scalar
ReportDefinition.norm ● String! non-null scalar
ReportDefinition.outputs ● [ReportDefinitionOutput!]! non-null object
ReportDefinition.reportDefinitionId ● ReportDefinitionId! non-null scalar
ReportDefinition.sourceTable ● String! non-null scalar
Returned By
availableReportDefinitions query
ReportDefinitionOutput
No description
type ReportDefinitionOutput {
format: ReportOutputFormat!
}
Fields
ReportDefinitionOutput.format ● ReportOutputFormat! non-null enum
Member Of
ReportDefinition object
ReportFileDownloadLinkGeneratePayload
No description
type ReportFileDownloadLinkGeneratePayload {
url: Url!
}
Fields
ReportFileDownloadLinkGeneratePayload.url ● Url! non-null scalar
Returned By
reportFileDownloadLinkGenerate mutation
Role
No description
type Role {
createdAt: Timestamp!
eventHistory(
after: String
first: Int!
): EventTimelineEntryConnection!
name: String!
permissionSets: [PermissionSet!]
roleId: RoleId!
}
Fields
Role.createdAt ● Timestamp! non-null scalar
Role.eventHistory ● EventTimelineEntryConnection! non-null object
Role.eventHistory.after ● String scalar
Role.eventHistory.first ● Int! non-null scalar
Role.name ● String! non-null scalar
Role.permissionSets ● [PermissionSet!] list object
Role.roleId ● RoleId! non-null scalar
Returned By
role query
Member Of
RoleConnection object ● RoleCreatePayloadSuccess object ● RoleEdge object ● RolePermissionSetsAddPayloadSuccess object ● RolePermissionSetsRemovePayloadSuccess object ● User object
RoleConnection
No description
type RoleConnection {
edges: [RoleEdge!]!
nodes: [Role!]!
pageInfo: PageInfo!
}
Fields
RoleConnection.edges ● [RoleEdge!]! non-null object
A list of edges.
RoleConnection.nodes ● [Role!]! non-null object
A list of nodes.
RoleConnection.pageInfo ● PageInfo! non-null object
Information to aid in pagination.
Returned By
roles query
RoleCreatePayloadError
No description
type RoleCreatePayloadError {
code: RoleCreateErrorCode!
}
Fields
RoleCreatePayloadError.code ● RoleCreateErrorCode! non-null enum
Implemented By
RoleCreatePayload union
RoleCreatePayloadSuccess
No description
type RoleCreatePayloadSuccess {
role: Role!
}
Fields
RoleCreatePayloadSuccess.role ● Role! non-null object
Implemented By
RoleCreatePayload union
RoleEdge
An edge in a connection.
type RoleEdge {
cursor: String!
node: Role!
}
Fields
RoleEdge.cursor ● String! non-null scalar
A cursor for use in pagination
RoleEdge.node ● Role! non-null object
The item at the end of the edge
Member Of
RoleConnection object
RolePermissionSetsAddPayloadError
No description
type RolePermissionSetsAddPayloadError {
code: RolePermissionSetsAddErrorCode!
}
Fields
RolePermissionSetsAddPayloadError.code ● RolePermissionSetsAddErrorCode! non-null enum
Implemented By
RolePermissionSetsAddPayload union
RolePermissionSetsAddPayloadSuccess
No description
type RolePermissionSetsAddPayloadSuccess {
role: Role!
}
Fields
RolePermissionSetsAddPayloadSuccess.role ● Role! non-null object
Implemented By
RolePermissionSetsAddPayload union
RolePermissionSetsRemovePayloadError
No description
type RolePermissionSetsRemovePayloadError {
code: RolePermissionSetsRemoveErrorCode!
}
Fields
RolePermissionSetsRemovePayloadError.code ● RolePermissionSetsRemoveErrorCode! non-null enum
Implemented By
RolePermissionSetsRemovePayload union
RolePermissionSetsRemovePayloadSuccess
No description
type RolePermissionSetsRemovePayloadSuccess {
role: Role!
}
Fields
RolePermissionSetsRemovePayloadSuccess.role ● Role! non-null object
Implemented By
RolePermissionSetsRemovePayload union
SignedMoney
No description
type SignedMoney {
amount: SignedMinorUnits!
currency: Currency!
}
Fields
SignedMoney.amount ● SignedMinorUnits! non-null scalar
SignedMoney.currency ● Currency! non-null object
Member Of
LedgerAccountBalanceDetails object
TermValues
No description
type TermValues {
accrualCycleInterval: InterestInterval!
annualRate: AnnualRatePct!
disbursalPolicy: DisbursalPolicy!
duration: Duration!
effectiveAnnualRate: EffectiveAnnualRatePct!
initialLtvLimit: LtvPct!
interestDueDurationFromAccrual: Duration!
liquidationLtvLimit: LtvPct!
marginCallLtvLimit: LtvPct!
obligationDefaultedDurationFromDue: Duration
obligationLiquidationDurationFromDue: Duration
obligationOverdueDurationFromDue: Duration
oneTimeFeeRate: OneTimeFeeRatePct!
}
Fields
TermValues.accrualCycleInterval ● InterestInterval! non-null enum
TermValues.annualRate ● AnnualRatePct! non-null scalar
TermValues.disbursalPolicy ● DisbursalPolicy! non-null enum
TermValues.duration ● Duration! non-null object
TermValues.effectiveAnnualRate ● EffectiveAnnualRatePct! non-null scalar
TermValues.initialLtvLimit ● LtvPct! non-null union
TermValues.interestDueDurationFromAccrual ● Duration! non-null object
TermValues.liquidationLtvLimit ● LtvPct! non-null union
TermValues.marginCallLtvLimit ● LtvPct! non-null union
TermValues.obligationDefaultedDurationFromDue ● Duration object
TermValues.obligationLiquidationDurationFromDue ● Duration object
TermValues.obligationOverdueDurationFromDue ● Duration object
TermValues.oneTimeFeeRate ● OneTimeFeeRatePct! non-null scalar
Member Of
CreditFacility object ● CreditFacilityProposal object ● PendingCreditFacility object ● VersionedCreditFacilityProductTerms object
Time
No description
type Time {
accountingDate: AccountingDate!
canAdvanceToNextEndOfDay: Boolean!
currentDate: Date!
currentTime: Timestamp!
endOfDayTime: String!
eodStatus: EodProcessStatus
isAutoAdvancePaused: Boolean!
isSimulatedTime: Boolean!
nextEndOfDayAt: Timestamp!
timezone: String!
}
Fields
Time.accountingDate ● AccountingDate! non-null scalar
The accounting date currently open: a posting made now is filed under it.
Time.canAdvanceToNextEndOfDay ● Boolean! non-null scalar
Whether the environment clock can be advanced manually right now.
Time.currentDate ● Date! non-null scalar
Calendar date of the environment clock in the bank's timezone.
Time.currentTime ● Timestamp! non-null scalar
Current environment timestamp.
Time.endOfDayTime ● String! non-null scalar
Configured end-of-day time in HH:MM:SS format.
Time.eodStatus ● EodProcessStatus enum
Current status of the most recent end-of-day process, if any.
Time.isAutoAdvancePaused ● Boolean! non-null scalar
Time.isSimulatedTime ● Boolean! non-null scalar
Whether the environment clock is in simulated time mode.
Time.nextEndOfDayAt ● Timestamp! non-null scalar
Timestamp when the next end-of-day boundary will be reached.
Time.timezone ● String! non-null scalar
IANA timezone identifier for the environment (e.g. "America/New_York").
Returned By
time query
Member Of
TimeAdvanceToNextEndOfDayPayloadSuccess object ● TimeAdvanceToNextHourPayloadSuccess object ● TimeAutoAdvancePausePayloadSuccess object ● TimeAutoAdvanceResumePayloadSuccess object
TimeAdvanceToNextEndOfDayPayloadError
No description
type TimeAdvanceToNextEndOfDayPayloadError {
code: TimeAdvanceToNextEndOfDayErrorCode!
}
Fields
TimeAdvanceToNextEndOfDayPayloadError.code ● TimeAdvanceToNextEndOfDayErrorCode! non-null enum
Implemented By
TimeAdvanceToNextEndOfDayPayload union
TimeAdvanceToNextEndOfDayPayloadSuccess
No description
type TimeAdvanceToNextEndOfDayPayloadSuccess {
time: Time!
}
Fields
TimeAdvanceToNextEndOfDayPayloadSuccess.time ● Time! non-null object
Implemented By
TimeAdvanceToNextEndOfDayPayload union
TimeAdvanceToNextHourPayloadError
No description
type TimeAdvanceToNextHourPayloadError {
code: TimeAdvanceToNextHourErrorCode!
}
Fields
TimeAdvanceToNextHourPayloadError.code ● TimeAdvanceToNextHourErrorCode! non-null enum
Implemented By
TimeAdvanceToNextHourPayload union
TimeAdvanceToNextHourPayloadSuccess
No description
type TimeAdvanceToNextHourPayloadSuccess {
time: Time!
}
Fields
TimeAdvanceToNextHourPayloadSuccess.time ● Time! non-null object
Implemented By
TimeAdvanceToNextHourPayload union
TimeAutoAdvancePausePayloadError
No description
type TimeAutoAdvancePausePayloadError {
code: TimeAutoAdvancePauseErrorCode!
}
Fields
TimeAutoAdvancePausePayloadError.code ● TimeAutoAdvancePauseErrorCode! non-null enum
Implemented By
TimeAutoAdvancePausePayload union
TimeAutoAdvancePausePayloadSuccess
No description
type TimeAutoAdvancePausePayloadSuccess {
time: Time!
}
Fields
TimeAutoAdvancePausePayloadSuccess.time ● Time! non-null object
Implemented By
TimeAutoAdvancePausePayload union
TimeAutoAdvanceResumePayloadError
No description
type TimeAutoAdvanceResumePayloadError {
code: TimeAutoAdvanceResumeErrorCode!
}
Fields
TimeAutoAdvanceResumePayloadError.code ● TimeAutoAdvanceResumeErrorCode! non-null enum
Implemented By
TimeAutoAdvanceResumePayload union
TimeAutoAdvanceResumePayloadSuccess
No description
type TimeAutoAdvanceResumePayloadSuccess {
time: Time!
}
Fields
TimeAutoAdvanceResumePayloadSuccess.time ● Time! non-null object
Implemented By
TimeAutoAdvanceResumePayload union
TransactionTemplate
No description
type TransactionTemplate {
code: String!
transactionTemplateId: TransactionTemplateId!
}
Fields
TransactionTemplate.code ● String! non-null scalar
TransactionTemplate.transactionTemplateId ● TransactionTemplateId! non-null scalar
Member Of
TransactionTemplateConnection object ● TransactionTemplateEdge object
TransactionTemplateConnection
No description
type TransactionTemplateConnection {
edges: [TransactionTemplateEdge!]!
nodes: [TransactionTemplate!]!
pageInfo: PageInfo!
}
Fields
TransactionTemplateConnection.edges ● [TransactionTemplateEdge!]! non-null object
A list of edges.
TransactionTemplateConnection.nodes ● [TransactionTemplate!]! non-null object
A list of nodes.
TransactionTemplateConnection.pageInfo ● PageInfo! non-null object
Information to aid in pagination.
Returned By
transactionTemplates query
TransactionTemplateEdge
An edge in a connection.
type TransactionTemplateEdge {
cursor: String!
node: TransactionTemplate!
}
Fields
TransactionTemplateEdge.cursor ● String! non-null scalar
A cursor for use in pagination
TransactionTemplateEdge.node ● TransactionTemplate! non-null object
The item at the end of the edge
Member Of
TransactionTemplateConnection object
TrialBalance
No description
type TrialBalance {
accounts(
filter: ChartAccountsFilter! = NON_ZERO
): [LedgerAccount!]!
balancesByCurrency: [LedgerAccountBalanceRange!]!
name: String!
total: LedgerAccountBalanceRange!
}
Fields
TrialBalance.accounts ● [LedgerAccount!]! non-null object
TrialBalance.accounts.filter ● ChartAccountsFilter! non-null enum
Which chart accounts to list: NON_ZERO (default) keeps accounts with a non-zero balance or activity — balances rolled over from earlier periods count, so a dormant-but-funded account stays listed; ALL lists every chart account, the completeness view of the chart.
TrialBalance.balancesByCurrency ● [LedgerAccountBalanceRange!]! non-null object
TrialBalance.name ● String! non-null scalar
TrialBalance.total ● LedgerAccountBalanceRange! non-null object
Returned By
trialBalance query
UnfreezeEntry
No description
type UnfreezeEntry {
amount: Money!
ledgerTransactionId: LedgerTransactionId!
recordedAt: Timestamp!
}
Fields
UnfreezeEntry.amount ● Money! non-null object
UnfreezeEntry.ledgerTransactionId ● LedgerTransactionId! non-null scalar
UnfreezeEntry.recordedAt ● Timestamp! non-null scalar
Implemented By
DepositAccountHistoryEntry union
UnknownEntry
No description
type UnknownEntry {
ledgerTransactionId: LedgerTransactionId!
recordedAt: Timestamp!
}
Fields
UnknownEntry.ledgerTransactionId ● LedgerTransactionId! non-null scalar
UnknownEntry.recordedAt ● Timestamp! non-null scalar
Implemented By
DepositAccountHistoryEntry union
UnlimitedMaxWithdrawalAmountPerTransaction
No description
type UnlimitedMaxWithdrawalAmountPerTransaction {
isUnlimited: Boolean!
}
Fields
UnlimitedMaxWithdrawalAmountPerTransaction.isUnlimited ● Boolean! non-null scalar
Implemented By
MaxWithdrawalAmountPerTransaction union
User
No description
type User {
createdAt: Timestamp!
email: String!
eventHistory(
after: String
first: Int!
): EventTimelineEntryConnection!
role: Role
userCanUpdateRoleOfUser: Boolean!
userId: UserId!
}
Fields
User.createdAt ● Timestamp! non-null scalar
User.email ● String! non-null scalar
User.eventHistory ● EventTimelineEntryConnection! non-null object
User.eventHistory.after ● String scalar
User.eventHistory.first ● Int! non-null scalar
User.role ● Role object
User.userCanUpdateRoleOfUser ● Boolean! non-null scalar
User.userId ● UserId! non-null scalar
Returned By
user query
Member Of
ApprovalProcessVoter object ● Committee object ● Me object ● UserConnection object ● UserCreatePayloadSuccess object ● UserEdge object ● UserRoleUpdatePayloadSuccess object
Implemented By
AuditSubject union
UserConnection
No description
type UserConnection {
edges: [UserEdge!]!
nodes: [User!]!
pageInfo: PageInfo!
}
Fields
UserConnection.edges ● [UserEdge!]! non-null object
A list of edges.
UserConnection.nodes ● [User!]! non-null object
A list of nodes.
UserConnection.pageInfo ● PageInfo! non-null object
Information to aid in pagination.
Returned By
users query
UserCreatePayloadError
No description
type UserCreatePayloadError {
code: UserCreateErrorCode!
}
Fields
UserCreatePayloadError.code ● UserCreateErrorCode! non-null enum
Implemented By
UserCreatePayload union
UserCreatePayloadSuccess
No description
type UserCreatePayloadSuccess {
user: User!
}
Fields
UserCreatePayloadSuccess.user ● User! non-null object
Implemented By
UserCreatePayload union
UserEdge
An edge in a connection.
type UserEdge {
cursor: String!
node: User!
}
Fields
UserEdge.cursor ● String! non-null scalar
A cursor for use in pagination
UserEdge.node ● User! non-null object
The item at the end of the edge
Member Of
UserConnection object
UserRoleUpdatePayloadError
No description
type UserRoleUpdatePayloadError {
code: UserRoleUpdateErrorCode!
}
Fields
UserRoleUpdatePayloadError.code ● UserRoleUpdateErrorCode! non-null enum
Implemented By
UserRoleUpdatePayload union
UserRoleUpdatePayloadSuccess
No description
type UserRoleUpdatePayloadSuccess {
user: User!
}
Fields
UserRoleUpdatePayloadSuccess.user ● User! non-null object
Implemented By
UserRoleUpdatePayload union
Verification
No description
type Verification {
applicantId: String
createdAt: Timestamp!
kycProvider: KycProvider
party: Party
providerVerificationId: String
status: VerificationStatus!
verificationId: VerificationId!
}
Fields
Verification.applicantId ● String scalar
Verification.createdAt ● Timestamp! non-null scalar
Verification.kycProvider ● KycProvider object
Verification.party ● Party union
Verification.providerVerificationId ● String scalar
Verification.status ● VerificationStatus! non-null enum
Verification.verificationId ● VerificationId! non-null scalar
Returned By
verificationUpdated subscription
Member Of
IndividualParty object ● OrganizationParty object ● VerificationApproveManuallyPayloadSuccess object
VerificationApproveManuallyPayloadError
No description
type VerificationApproveManuallyPayloadError {
code: VerificationApproveManuallyErrorCode!
}
Fields
VerificationApproveManuallyPayloadError.code ● VerificationApproveManuallyErrorCode! non-null enum
Implemented By
VerificationApproveManuallyPayload union
VerificationApproveManuallyPayloadSuccess
No description
type VerificationApproveManuallyPayloadSuccess {
verification: Verification!
}
Fields
VerificationApproveManuallyPayloadSuccess.verification ● Verification! non-null object
Implemented By
VerificationApproveManuallyPayload union
VerificationLinkCreatePayloadError
No description
type VerificationLinkCreatePayloadError {
code: VerificationLinkCreateErrorCode!
}
Fields
VerificationLinkCreatePayloadError.code ● VerificationLinkCreateErrorCode! non-null enum
Implemented By
VerificationLinkCreatePayload union
VerificationLinkCreatePayloadSuccess
No description
type VerificationLinkCreatePayloadSuccess {
url: Url!
}
Fields
VerificationLinkCreatePayloadSuccess.url ● Url! non-null scalar
Implemented By
VerificationLinkCreatePayload union
VersionedCreditFacilityProductTerms
No description
type VersionedCreditFacilityProductTerms {
terms: TermValues!
version: Int!
}
Fields
VersionedCreditFacilityProductTerms.terms ● TermValues! non-null object
VersionedCreditFacilityProductTerms.version ● Int! non-null scalar
Member Of
CreditFacilityProduct object ● CreditFacilityProposal object
VersionedDepositAccountProductTerms
No description
type VersionedDepositAccountProductTerms {
terms: DepositAccountProductTerms!
version: Int!
}
Fields
VersionedDepositAccountProductTerms.terms ● DepositAccountProductTerms! non-null object
VersionedDepositAccountProductTerms.version ● Int! non-null scalar
Member Of
DepositAccountProduct object ● DepositAccountProductAgreement object
VisibleNavigationItems
No description
type VisibleNavigationItems {
audit: Boolean!
creditFacilities: Boolean!
customer: Boolean!
deposit: Boolean!
eodProcesses: Boolean!
financials: Boolean!
governance: GovernanceNavigationItems!
partner: Boolean!
user: Boolean!
withdraw: Boolean!
}
Fields
VisibleNavigationItems.audit ● Boolean! non-null scalar
VisibleNavigationItems.creditFacilities ● Boolean! non-null scalar
VisibleNavigationItems.customer ● Boolean! non-null scalar
VisibleNavigationItems.deposit ● Boolean! non-null scalar
VisibleNavigationItems.eodProcesses ● Boolean! non-null scalar
VisibleNavigationItems.financials ● Boolean! non-null scalar
VisibleNavigationItems.governance ● GovernanceNavigationItems! non-null object
VisibleNavigationItems.partner ● Boolean! non-null scalar
VisibleNavigationItems.user ● Boolean! non-null scalar
VisibleNavigationItems.withdraw ● Boolean! non-null scalar
Member Of
Me object
Wallet
No description
type Wallet {
address: String
custodian: Custodian
network: WalletNetwork
status: WalletStatus!
walletId: WalletId!
}
Fields
Wallet.address ● String scalar
null while the wallet is Provisioning — see status.
Wallet.custodian ● Custodian object
Wallet.network ● WalletNetwork enum
Wallet.status ● WalletStatus! non-null enum
Wallet.walletId ● WalletId! non-null scalar
Member Of
CreditFacility object ● PendingCreditFacility object
Withdrawal
No description
type Withdrawal {
account: DepositAccount
accountId: DepositAccountId!
amount: Money!
approvalProcess: ApprovalProcess
approvalProcessId: ApprovalProcessId!
createdAt: Timestamp!
eventHistory(
after: String
first: Int!
): EventTimelineEntryConnection!
ledgerTransactions: [LedgerTransaction!]
payout: Payout
payoutDraft: PayoutDraft
publicId: PublicId!
reference: String!
status: WithdrawalStatus!
withdrawalId: WithdrawalId!
}
Fields
Withdrawal.account ● DepositAccount object
Withdrawal.accountId ● DepositAccountId! non-null scalar
Withdrawal.amount ● Money! non-null object
Withdrawal.approvalProcess ● ApprovalProcess object
Withdrawal.approvalProcessId ● ApprovalProcessId! non-null scalar
Withdrawal.createdAt ● Timestamp! non-null scalar
Withdrawal.eventHistory ● EventTimelineEntryConnection! non-null object
Withdrawal.eventHistory.after ● String scalar
Withdrawal.eventHistory.first ● Int! non-null scalar
Withdrawal.ledgerTransactions ● [LedgerTransaction!] list object
Withdrawal.payout ● Payout object
Withdrawal.payoutDraft ● PayoutDraft object
Withdrawal.publicId ● PublicId! non-null scalar
Withdrawal.reference ● String! non-null scalar
Withdrawal.status ● WithdrawalStatus! non-null enum
Withdrawal.withdrawalId ● WithdrawalId! non-null scalar
Returned By
withdrawal query ● withdrawalByPublicId query ● withdrawalUpdated subscription
Member Of
CancelledWithdrawalEntry object ● DepositAccount object ● Payout object ● PayoutDraft object ● WithdrawalConnection object ● WithdrawalEdge object ● WithdrawalEntry object ● WithdrawalInitiatePayloadSuccess object
Implemented By
ApprovalProcessTarget union ● LedgerTransactionEntity union ● PublicIdTarget union
WithdrawalConnection
No description
type WithdrawalConnection {
edges: [WithdrawalEdge!]!
nodes: [Withdrawal!]!
pageInfo: PageInfo!
}
Fields
WithdrawalConnection.edges ● [WithdrawalEdge!]! non-null object
A list of edges.
WithdrawalConnection.nodes ● [Withdrawal!]! non-null object
A list of nodes.
WithdrawalConnection.pageInfo ● PageInfo! non-null object
Information to aid in pagination.
Returned By
withdrawals query
WithdrawalEdge
An edge in a connection.
type WithdrawalEdge {
cursor: String!
node: Withdrawal!
}
Fields
WithdrawalEdge.cursor ● String! non-null scalar
A cursor for use in pagination
WithdrawalEdge.node ● Withdrawal! non-null object
The item at the end of the edge
Member Of
WithdrawalConnection object
WithdrawalEntry
No description
type WithdrawalEntry {
recordedAt: Timestamp!
withdrawal: Withdrawal!
}
Fields
WithdrawalEntry.recordedAt ● Timestamp! non-null scalar
WithdrawalEntry.withdrawal ● Withdrawal! non-null object
Implemented By
DepositAccountHistoryEntry union
WithdrawalInitiatePayloadError
No description
type WithdrawalInitiatePayloadError {
code: WithdrawalInitiateErrorCode!
}
Fields
WithdrawalInitiatePayloadError.code ● WithdrawalInitiateErrorCode! non-null enum
Implemented By
WithdrawalInitiatePayload union
WithdrawalInitiatePayloadSuccess
No description
type WithdrawalInitiatePayloadSuccess {
withdrawal: Withdrawal!
}
Fields
WithdrawalInitiatePayloadSuccess.withdrawal ● Withdrawal! non-null object
Implemented By
WithdrawalInitiatePayload union
Enums
AccountCategory
No description
enum AccountCategory {
ASSET
COST_OF_REVENUE
EQUITY
EXPENSES
LIABILITY
OFF_BALANCE_SHEET
REVENUE
}
Values
AccountCategory.ASSET
AccountCategory.COST_OF_REVENUE
AccountCategory.EQUITY
AccountCategory.EXPENSES
AccountCategory.LIABILITY
AccountCategory.OFF_BALANCE_SHEET
AccountCategory.REVENUE
Member Of
descendantAccountSetsByCategory query
AccountingCurrencyPolicyConfigureErrorCode
No description
enum AccountingCurrencyPolicyConfigureErrorCode {
ACCOUNTING_CURRENCY_POLICY_FUNCTIONAL_CURRENCY_MISMATCH
ACCOUNTING_CURRENCY_POLICY_SUPPORTED_CURRENCY_REMOVED
ACCOUNTING_CURRENCY_POLICY_UNSUPPORTED_CURRENCY
}
Values
AccountingCurrencyPolicyConfigureErrorCode.ACCOUNTING_CURRENCY_POLICY_FUNCTIONAL_CURRENCY_MISMATCH
The functional currency cannot be changed after configuration.
AccountingCurrencyPolicyConfigureErrorCode.ACCOUNTING_CURRENCY_POLICY_SUPPORTED_CURRENCY_REMOVED
An existing supported currency cannot be removed.
AccountingCurrencyPolicyConfigureErrorCode.ACCOUNTING_CURRENCY_POLICY_UNSUPPORTED_CURRENCY
This currency is not supported for accounting.
Member Of
AccountingCurrencyPolicyConfigurePayloadError object
ApprovalProcessApproveErrorCode
No description
enum ApprovalProcessApproveErrorCode {
GOVERNANCE_APPROVAL_PROCESS_ALREADY_APPROVED
GOVERNANCE_APPROVAL_PROCESS_ALREADY_DENIED
GOVERNANCE_APPROVAL_PROCESS_NOT_FOUND
GOVERNANCE_NOT_ELIGIBLE_TO_VOTE
GOVERNANCE_SUBJECT_IS_NOT_COMMITTEE_MEMBER
}
Values
ApprovalProcessApproveErrorCode.GOVERNANCE_APPROVAL_PROCESS_ALREADY_APPROVED
The approval process was already approved, so it can no longer be denied.
ApprovalProcessApproveErrorCode.GOVERNANCE_APPROVAL_PROCESS_ALREADY_DENIED
The approval process was already denied, so it can no longer be approved.
ApprovalProcessApproveErrorCode.GOVERNANCE_APPROVAL_PROCESS_NOT_FOUND
No approval process exists with the supplied id.
ApprovalProcessApproveErrorCode.GOVERNANCE_NOT_ELIGIBLE_TO_VOTE
The subject is a committee member but is not eligible to vote on this approval process.
ApprovalProcessApproveErrorCode.GOVERNANCE_SUBJECT_IS_NOT_COMMITTEE_MEMBER
The subject is not a committee member, so it cannot take part in approvals.
Member Of
ApprovalProcessApprovePayloadError object
ApprovalProcessDenyErrorCode
No description
enum ApprovalProcessDenyErrorCode {
GOVERNANCE_APPROVAL_PROCESS_ALREADY_APPROVED
GOVERNANCE_APPROVAL_PROCESS_ALREADY_DENIED
GOVERNANCE_APPROVAL_PROCESS_NOT_FOUND
GOVERNANCE_NOT_ELIGIBLE_TO_VOTE
GOVERNANCE_SUBJECT_IS_NOT_COMMITTEE_MEMBER
}
Values
ApprovalProcessDenyErrorCode.GOVERNANCE_APPROVAL_PROCESS_ALREADY_APPROVED
The approval process was already approved, so it can no longer be denied.
ApprovalProcessDenyErrorCode.GOVERNANCE_APPROVAL_PROCESS_ALREADY_DENIED
The approval process was already denied, so it can no longer be approved.
ApprovalProcessDenyErrorCode.GOVERNANCE_APPROVAL_PROCESS_NOT_FOUND
No approval process exists with the supplied id.
ApprovalProcessDenyErrorCode.GOVERNANCE_NOT_ELIGIBLE_TO_VOTE
The subject is a committee member but is not eligible to vote on this approval process.
ApprovalProcessDenyErrorCode.GOVERNANCE_SUBJECT_IS_NOT_COMMITTEE_MEMBER
The subject is not a committee member, so it cannot take part in approvals.
Member Of
ApprovalProcessDenyPayloadError object
ApprovalProcessStatus
No description
enum ApprovalProcessStatus {
APPROVED
DENIED
IN_PROGRESS
}
Values
ApprovalProcessStatus.APPROVED
ApprovalProcessStatus.DENIED
ApprovalProcessStatus.IN_PROGRESS
Member Of
ApprovalProcess object
ApprovalProcessType
No description
enum ApprovalProcessType {
CREDIT_FACILITY_PROPOSAL_APPROVAL
DISBURSAL_APPROVAL
WITHDRAWAL_APPROVAL
}
Values
ApprovalProcessType.CREDIT_FACILITY_PROPOSAL_APPROVAL
ApprovalProcessType.DISBURSAL_APPROVAL
ApprovalProcessType.WITHDRAWAL_APPROVAL
Member Of
ApprovalProcess object ● Policy object
BitcoinInventoryCostMethod
No description
enum BitcoinInventoryCostMethod {
MOVING_WEIGHTED_AVERAGE
}
Values
BitcoinInventoryCostMethod.MOVING_WEIGHTED_AVERAGE
Member Of
BitcoinInventory object
BitcoinInventoryFundErrorCode
No description
enum BitcoinInventoryFundErrorCode {
ACCOUNTING_CURRENCY_POLICY_NOT_CONFIGURED
EXCHANGE_ACCOUNTING_INTEGRATION_NOT_CONFIGURED
EXCHANGE_ACQUISITION_MUST_BE_POSITIVE
EXCHANGE_AMOUNT_EXCEEDS_CURRENCY_SUPPLY
EXCHANGE_CARRYING_VALUE_CURRENCY_MISMATCH
EXCHANGE_MISSING_CARRYING_VALUE
MONEY_OVERFLOW
MONEY_UNSUPPORTED_CURRENCY
}
Values
BitcoinInventoryFundErrorCode.ACCOUNTING_CURRENCY_POLICY_NOT_CONFIGURED
The accounting currency policy has not been configured.
BitcoinInventoryFundErrorCode.EXCHANGE_ACCOUNTING_INTEGRATION_NOT_CONFIGURED
The exchange accounting integration has not been configured.
BitcoinInventoryFundErrorCode.EXCHANGE_ACQUISITION_MUST_BE_POSITIVE
The inventory acquisition must be greater than zero.
BitcoinInventoryFundErrorCode.EXCHANGE_AMOUNT_EXCEEDS_CURRENCY_SUPPLY
The inventory amount exceeds the total supply of the currency.
BitcoinInventoryFundErrorCode.EXCHANGE_CARRYING_VALUE_CURRENCY_MISMATCH
The carrying value must be in the functional currency.
BitcoinInventoryFundErrorCode.EXCHANGE_MISSING_CARRYING_VALUE
The inventory acquisition carries no functional value.
BitcoinInventoryFundErrorCode.MONEY_OVERFLOW
The amount exceeds the maximum supported value.
BitcoinInventoryFundErrorCode.MONEY_UNSUPPORTED_CURRENCY
The amount uses an unsupported currency.
Member Of
BitcoinInventoryFundPayloadError object
BitcoinPurchaseExecuteErrorCode
No description
enum BitcoinPurchaseExecuteErrorCode {
ACCOUNTING_CURRENCY_POLICY_NOT_CONFIGURED
DEPOSIT_ACCOUNT_NOT_FOUND
EXCHANGE_ACCOUNTING_INTEGRATION_NOT_CONFIGURED
EXCHANGE_ACCOUNT_HOLDER_MISMATCH
EXCHANGE_CALCULATED_MARKET_VALUE_MUST_BE_POSITIVE
EXCHANGE_CALCULATED_SATOSHIS_MUST_BE_POSITIVE
EXCHANGE_DEPOSIT_ACCOUNT_LOCKED
EXCHANGE_DESTINATION_ACCOUNT_ACTIVITY_INACTIVE
EXCHANGE_DESTINATION_ACCOUNT_INACTIVE
EXCHANGE_DESTINATION_ACCOUNT_MUST_BE_BTC
EXCHANGE_EMPTY_INVENTORY
EXCHANGE_INSUFFICIENT_BITCOIN_INVENTORY
EXCHANGE_INSUFFICIENT_CUSTOMER_FUNDS
EXCHANGE_PARTNER_MISMATCH
EXCHANGE_RELEASED_CARRYING_VALUE_ROUNDS_TO_ZERO
EXCHANGE_REQUESTED_FIAT_AMOUNT_MUST_BE_POSITIVE
EXCHANGE_SOURCE_ACCOUNT_ACTIVITY_INACTIVE
EXCHANGE_SOURCE_ACCOUNT_CURRENCY_MISMATCH
EXCHANGE_SOURCE_ACCOUNT_INACTIVE
EXCHANGE_SOURCE_ACCOUNT_MUST_BE_FIAT
EXCHANGE_SPOT_RATE_UNAVAILABLE
MONEY_OVERFLOW
MONEY_UNSUPPORTED_CURRENCY
}
Values
BitcoinPurchaseExecuteErrorCode.ACCOUNTING_CURRENCY_POLICY_NOT_CONFIGURED
The accounting currency policy has not been configured.
BitcoinPurchaseExecuteErrorCode.DEPOSIT_ACCOUNT_NOT_FOUND
No deposit account exists with the supplied id.
BitcoinPurchaseExecuteErrorCode.EXCHANGE_ACCOUNTING_INTEGRATION_NOT_CONFIGURED
The exchange accounting integration has not been configured.
BitcoinPurchaseExecuteErrorCode.EXCHANGE_ACCOUNT_HOLDER_MISMATCH
Both deposit accounts must belong to the purchasing customer.
BitcoinPurchaseExecuteErrorCode.EXCHANGE_CALCULATED_MARKET_VALUE_MUST_BE_POSITIVE
The purchased bitcoin has no functional market value.
BitcoinPurchaseExecuteErrorCode.EXCHANGE_CALCULATED_SATOSHIS_MUST_BE_POSITIVE
The requested amount buys no whole satoshi.
BitcoinPurchaseExecuteErrorCode.EXCHANGE_DEPOSIT_ACCOUNT_LOCKED
A deposit account in the purchase was frozen before the purchase settled.
BitcoinPurchaseExecuteErrorCode.EXCHANGE_DESTINATION_ACCOUNT_ACTIVITY_INACTIVE
The destination deposit account has no recent activity.
BitcoinPurchaseExecuteErrorCode.EXCHANGE_DESTINATION_ACCOUNT_INACTIVE
The destination deposit account is not active.
BitcoinPurchaseExecuteErrorCode.EXCHANGE_DESTINATION_ACCOUNT_MUST_BE_BTC
The destination deposit account must hold bitcoin.
BitcoinPurchaseExecuteErrorCode.EXCHANGE_EMPTY_INVENTORY
Proprietary bitcoin inventory holds no bitcoin.
BitcoinPurchaseExecuteErrorCode.EXCHANGE_INSUFFICIENT_BITCOIN_INVENTORY
The exchange does not hold enough proprietary bitcoin inventory.
BitcoinPurchaseExecuteErrorCode.EXCHANGE_INSUFFICIENT_CUSTOMER_FUNDS
The customer's fiat deposit account does not hold enough funds.
BitcoinPurchaseExecuteErrorCode.EXCHANGE_PARTNER_MISMATCH
Both deposit accounts must belong to the same partner.
BitcoinPurchaseExecuteErrorCode.EXCHANGE_RELEASED_CARRYING_VALUE_ROUNDS_TO_ZERO
The released carrying value rounds to zero.
BitcoinPurchaseExecuteErrorCode.EXCHANGE_REQUESTED_FIAT_AMOUNT_MUST_BE_POSITIVE
The requested fiat amount must be greater than zero.
BitcoinPurchaseExecuteErrorCode.EXCHANGE_SOURCE_ACCOUNT_ACTIVITY_INACTIVE
The source deposit account has no recent activity.
BitcoinPurchaseExecuteErrorCode.EXCHANGE_SOURCE_ACCOUNT_CURRENCY_MISMATCH
The source deposit account currency differs from the functional or requested currency.
BitcoinPurchaseExecuteErrorCode.EXCHANGE_SOURCE_ACCOUNT_INACTIVE
The source deposit account is not active.
BitcoinPurchaseExecuteErrorCode.EXCHANGE_SOURCE_ACCOUNT_MUST_BE_FIAT
The source deposit account must hold a fiat currency.
BitcoinPurchaseExecuteErrorCode.EXCHANGE_SPOT_RATE_UNAVAILABLE
No fresh transaction spot rate is available.
BitcoinPurchaseExecuteErrorCode.MONEY_OVERFLOW
The amount exceeds the maximum supported value.
BitcoinPurchaseExecuteErrorCode.MONEY_UNSUPPORTED_CURRENCY
The amount uses an unsupported currency.
Member Of
BitcoinPurchaseExecutePayloadError object
BitcoinPurchaseSortBy
No description
enum BitcoinPurchaseSortBy {
CREATED_AT
}
Values
BitcoinPurchaseSortBy.CREATED_AT
Member Of
BitcoinPurchaseSort input
ChartAccountsFilter
Which chart accounts a statement report lists.
enum ChartAccountsFilter {
ALL
NON_ZERO
}
Values
ChartAccountsFilter.ALL
Every chart account, including zero-balance ones without activity — the completeness view of the chart.
ChartAccountsFilter.NON_ZERO
Accounts with a non-zero balance or activity — balances rolled over from earlier periods count, so a dormant-but-funded account stays listed.
ChartOfAccountsAddChildNodeErrorCode
No description
enum ChartOfAccountsAddChildNodeErrorCode {
ACCOUNT_CODE_INVALID_PARENT
ACCOUNT_CODE_TOO_DEEP
CHART_OF_ACCOUNTS_CODE_ALREADY_EXISTS
CHART_OF_ACCOUNTS_NOT_FOUND_BY_REFERENCE
CHART_OF_ACCOUNTS_PARENT_ACCOUNT_NOT_FOUND
}
Values
ChartOfAccountsAddChildNodeErrorCode.ACCOUNT_CODE_INVALID_PARENT
Account code does not match its parent.
ChartOfAccountsAddChildNodeErrorCode.ACCOUNT_CODE_TOO_DEEP
Account code has more sections than the ledger can nest.
ChartOfAccountsAddChildNodeErrorCode.CHART_OF_ACCOUNTS_CODE_ALREADY_EXISTS
The account code already exists in this chart.
ChartOfAccountsAddChildNodeErrorCode.CHART_OF_ACCOUNTS_NOT_FOUND_BY_REFERENCE
No chart exists with the supplied reference.
ChartOfAccountsAddChildNodeErrorCode.CHART_OF_ACCOUNTS_PARENT_ACCOUNT_NOT_FOUND
The parent account does not exist in this chart.
Member Of
ChartOfAccountsAddChildNodePayloadError object
ChartOfAccountsInitializeErrorCode
No description
enum ChartOfAccountsInitializeErrorCode {
ACCOUNTING_BASE_CONFIG_ACCOUNT_CODE_NOT_TOP_LEVEL
ACCOUNTING_BASE_CONFIG_DUPLICATE_ACCOUNT_CODE
ACCOUNTING_BASE_CONFIG_RETAINED_EARNINGS_CODE_NOT_CHILD_OF_EQUITY
ACCOUNT_CODE_TOO_DEEP
ACCOUNT_NAME_PARSE_TOO_LONG
ACCOUNT_NAME_PARSE_UNSUPPORTED_SCRIPT
CHART_OF_ACCOUNTS_ACCOUNT_CODE_HAS_INVALID_PARENT
CHART_OF_ACCOUNTS_BASE_CONFIG_ALREADY_INITIALIZED_WITH_DIFFERENT_CONFIG
CHART_OF_ACCOUNTS_CODE_NOT_FOUND_IN_CHART
CHART_OF_ACCOUNTS_CSV_CODE_INHERITS_NOTHING
CHART_OF_ACCOUNTS_NOT_FOUND_BY_REFERENCE
CHART_OF_ACCOUNTS_REFERENCE_TAKEN
FISCAL_YEAR_ALREADY_INITIALIZED
FISCAL_YEAR_OPENED_AS_OF_IN_FUTURE
}
Values
ChartOfAccountsInitializeErrorCode.ACCOUNTING_BASE_CONFIG_ACCOUNT_CODE_NOT_TOP_LEVEL
Accounting base configuration requires top level account codes.
ChartOfAccountsInitializeErrorCode.ACCOUNTING_BASE_CONFIG_DUPLICATE_ACCOUNT_CODE
Accounting base configuration codes must be distinct.
ChartOfAccountsInitializeErrorCode.ACCOUNTING_BASE_CONFIG_RETAINED_EARNINGS_CODE_NOT_CHILD_OF_EQUITY
Retained earnings must be a child of the equity account.
ChartOfAccountsInitializeErrorCode.ACCOUNT_CODE_TOO_DEEP
Account code has more sections than the ledger can nest.
ChartOfAccountsInitializeErrorCode.ACCOUNT_NAME_PARSE_TOO_LONG
Account name must contain at most 255 characters.
ChartOfAccountsInitializeErrorCode.ACCOUNT_NAME_PARSE_UNSUPPORTED_SCRIPT
Account name contains unsupported characters.
ChartOfAccountsInitializeErrorCode.CHART_OF_ACCOUNTS_ACCOUNT_CODE_HAS_INVALID_PARENT
The configured account code has an invalid parent.
ChartOfAccountsInitializeErrorCode.CHART_OF_ACCOUNTS_BASE_CONFIG_ALREADY_INITIALIZED_WITH_DIFFERENT_CONFIG
The chart was already initialized with a different base configuration.
ChartOfAccountsInitializeErrorCode.CHART_OF_ACCOUNTS_CODE_NOT_FOUND_IN_CHART
The account code does not exist in this chart.
ChartOfAccountsInitializeErrorCode.CHART_OF_ACCOUNTS_CSV_CODE_INHERITS_NOTHING
A blank leading code cell has no account code on the previous row to inherit from.
ChartOfAccountsInitializeErrorCode.CHART_OF_ACCOUNTS_NOT_FOUND_BY_REFERENCE
No chart exists with the supplied reference.
ChartOfAccountsInitializeErrorCode.CHART_OF_ACCOUNTS_REFERENCE_TAKEN
A chart already uses this reference.
ChartOfAccountsInitializeErrorCode.FISCAL_YEAR_ALREADY_INITIALIZED
Fiscal year already initialized with a different opening date.
ChartOfAccountsInitializeErrorCode.FISCAL_YEAR_OPENED_AS_OF_IN_FUTURE
Fiscal year opening date is in the future.
Member Of
ChartOfAccountsInitializePayloadError object
CollateralizationState
No description
enum CollateralizationState {
FULLY_COLLATERALIZED
NO_COLLATERAL
NO_EXPOSURE
UNDER_LIQUIDATION_THRESHOLD
UNDER_MARGIN_CALL_THRESHOLD
}
Values
CollateralizationState.FULLY_COLLATERALIZED
CollateralizationState.NO_COLLATERAL
CollateralizationState.NO_EXPOSURE
CollateralizationState.UNDER_LIQUIDATION_THRESHOLD
CollateralizationState.UNDER_MARGIN_CALL_THRESHOLD
Member Of
CreditFacility object ● CreditFacilityCollateralizationUpdated object ● CreditFacilityFilter input
CollateralRecordLiquidationSaleErrorCode
No description
enum CollateralRecordLiquidationSaleErrorCode {
COLLATERAL_AMOUNT_MUST_NOT_BE_ZERO
COLLATERAL_LIQUIDATION_NOT_FOUND
COLLATERAL_LIQUIDATION_SALE_CONFLICT
COLLATERAL_NO_ACTIVE_LIQUIDATION
COLLATERAL_NO_COLLATERAL_SENT_TO_LIQUIDATION
COLLATERAL_PROCEEDS_CURRENCY_MISMATCH
MONEY_OVERFLOW
MONEY_UNSUPPORTED_CURRENCY
}
Values
CollateralRecordLiquidationSaleErrorCode.COLLATERAL_AMOUNT_MUST_NOT_BE_ZERO
The amount must not be zero.
CollateralRecordLiquidationSaleErrorCode.COLLATERAL_LIQUIDATION_NOT_FOUND
No liquidation exists with the supplied id.
CollateralRecordLiquidationSaleErrorCode.COLLATERAL_LIQUIDATION_SALE_CONFLICT
The liquidation sale was already recorded with a different proceeds amount or effective date.
CollateralRecordLiquidationSaleErrorCode.COLLATERAL_NO_ACTIVE_LIQUIDATION
The collateral has no active liquidation.
CollateralRecordLiquidationSaleErrorCode.COLLATERAL_NO_COLLATERAL_SENT_TO_LIQUIDATION
No collateral has been sent to the active liquidation yet.
CollateralRecordLiquidationSaleErrorCode.COLLATERAL_PROCEEDS_CURRENCY_MISMATCH
The proceeds are not in the currency the liquidation expects to receive.
CollateralRecordLiquidationSaleErrorCode.MONEY_OVERFLOW
The amount exceeds the maximum supported value.
CollateralRecordLiquidationSaleErrorCode.MONEY_UNSUPPORTED_CURRENCY
The amount uses an unsupported currency.
Member Of
CollateralRecordLiquidationSalePayloadError object
CollateralRecordSentToLiquidationErrorCode
No description
enum CollateralRecordSentToLiquidationErrorCode {
COLLATERAL_AMOUNT_MUST_NOT_BE_ZERO
COLLATERAL_CURRENCY_MISMATCH
COLLATERAL_EXCHANGE_RATE_CURRENCY_MISMATCH
COLLATERAL_INSUFFICIENT_LOTS_FOR_LIQUIDATION
COLLATERAL_LIQUIDATION_AMOUNT_EXCEEDS_COLLATERAL
COLLATERAL_NOT_FOUND
COLLATERAL_NO_ACTIVE_LIQUIDATION
MONEY_OVERFLOW
MONEY_UNSUPPORTED_CURRENCY
}
Values
CollateralRecordSentToLiquidationErrorCode.COLLATERAL_AMOUNT_MUST_NOT_BE_ZERO
The amount must not be zero.
CollateralRecordSentToLiquidationErrorCode.COLLATERAL_CURRENCY_MISMATCH
The amount is not in the currency of the collateral.
CollateralRecordSentToLiquidationErrorCode.COLLATERAL_EXCHANGE_RATE_CURRENCY_MISMATCH
The exchange rate is quoted in the collateral's own currency.
CollateralRecordSentToLiquidationErrorCode.COLLATERAL_INSUFFICIENT_LOTS_FOR_LIQUIDATION
The active lots do not hold enough collateral to liquidate the amount.
CollateralRecordSentToLiquidationErrorCode.COLLATERAL_LIQUIDATION_AMOUNT_EXCEEDS_COLLATERAL
The amount sent to liquidation exceeds the collateral held.
CollateralRecordSentToLiquidationErrorCode.COLLATERAL_NOT_FOUND
No collateral exists with the supplied id.
CollateralRecordSentToLiquidationErrorCode.COLLATERAL_NO_ACTIVE_LIQUIDATION
The collateral has no active liquidation.
CollateralRecordSentToLiquidationErrorCode.MONEY_OVERFLOW
The amount exceeds the maximum supported value.
CollateralRecordSentToLiquidationErrorCode.MONEY_UNSUPPORTED_CURRENCY
The amount uses an unsupported currency.
Member Of
CollateralRecordSentToLiquidationPayloadError object
CollateralUpdateErrorCode
No description
enum CollateralUpdateErrorCode {
COLLATERAL_AMOUNT_EXCEEDS_CURRENCY_SUPPLY
COLLATERAL_CURRENCY_MISMATCH
COLLATERAL_CUSTODIAN_MANAGED
COLLATERAL_EFFECTIVE_DATE_IN_CLOSED_PERIOD
COLLATERAL_EFFECTIVE_DATE_IN_FUTURE
COLLATERAL_EXCHANGE_RATE_CURRENCY_MISMATCH
COLLATERAL_INSUFFICIENT_LOTS_FOR_RELEASE
COLLATERAL_NOT_FOUND
MONEY_OVERFLOW
MONEY_UNSUPPORTED_CURRENCY
}
Values
CollateralUpdateErrorCode.COLLATERAL_AMOUNT_EXCEEDS_CURRENCY_SUPPLY
The collateral amount exceeds the total supply of its currency.
CollateralUpdateErrorCode.COLLATERAL_CURRENCY_MISMATCH
The amount is not in the currency of the collateral.
CollateralUpdateErrorCode.COLLATERAL_CUSTODIAN_MANAGED
The collateral is held with a custodian, so it cannot be updated by hand.
CollateralUpdateErrorCode.COLLATERAL_EFFECTIVE_DATE_IN_CLOSED_PERIOD
The effective date of a collateral update is in a closed accounting period.
CollateralUpdateErrorCode.COLLATERAL_EFFECTIVE_DATE_IN_FUTURE
The effective date of a collateral update cannot be in the future.
CollateralUpdateErrorCode.COLLATERAL_EXCHANGE_RATE_CURRENCY_MISMATCH
The exchange rate is quoted in the collateral's own currency.
CollateralUpdateErrorCode.COLLATERAL_INSUFFICIENT_LOTS_FOR_RELEASE
The active lots do not hold enough collateral to release the amount.
CollateralUpdateErrorCode.COLLATERAL_NOT_FOUND
No collateral exists with the supplied id.
CollateralUpdateErrorCode.MONEY_OVERFLOW
The amount exceeds the maximum supported value.
CollateralUpdateErrorCode.MONEY_UNSUPPORTED_CURRENCY
The amount uses an unsupported currency.
Member Of
CollateralUpdatePayloadError object
CommitteeCreateErrorCode
No description
enum CommitteeCreateErrorCode {
ACCESS_USER_NOT_FOUND
GOVERNANCE_COMMITTEE_MUST_HAVE_AT_LEAST_ONE_MEMBER
GOVERNANCE_COMMITTEE_NAME_TAKEN
}
Values
CommitteeCreateErrorCode.ACCESS_USER_NOT_FOUND
No user exists with the supplied id.
CommitteeCreateErrorCode.GOVERNANCE_COMMITTEE_MUST_HAVE_AT_LEAST_ONE_MEMBER
A committee needs at least one member.
CommitteeCreateErrorCode.GOVERNANCE_COMMITTEE_NAME_TAKEN
A committee with this name already exists.
Member Of
CommitteeCreatePayloadError object
CommitteeSortBy
No description
enum CommitteeSortBy {
CREATED_AT
NAME
}
Values
CommitteeSortBy.CREATED_AT
CommitteeSortBy.NAME
Member Of
CommitteeSort input
CommitteeUserAddErrorCode
No description
enum CommitteeUserAddErrorCode {
ACCESS_USER_NOT_FOUND
GOVERNANCE_COMMITTEE_NOT_FOUND
}
Values
CommitteeUserAddErrorCode.ACCESS_USER_NOT_FOUND
No user exists with the supplied id.
CommitteeUserAddErrorCode.GOVERNANCE_COMMITTEE_NOT_FOUND
No committee exists with the supplied id.
Member Of
CommitteeUserAddPayloadError object
CommitteeUserRemoveErrorCode
No description
enum CommitteeUserRemoveErrorCode {
GOVERNANCE_CANNOT_REMOVE_LAST_MEMBER
GOVERNANCE_COMMITTEE_NOT_FOUND
GOVERNANCE_NOT_A_COMMITTEE_MEMBER
}
Values
CommitteeUserRemoveErrorCode.GOVERNANCE_CANNOT_REMOVE_LAST_MEMBER
The last member of a committee cannot be removed.
CommitteeUserRemoveErrorCode.GOVERNANCE_COMMITTEE_NOT_FOUND
No committee exists with the supplied id.
CommitteeUserRemoveErrorCode.GOVERNANCE_NOT_A_COMMITTEE_MEMBER
The subject is not a member of this committee.
Member Of
CommitteeUserRemovePayloadError object
ConfigType
No description
enum ConfigType {
BOOL
COMPLEX
DECIMAL
ENUM
INT
STRING
TIME
TIMEZONE
UINT
}
Values
ConfigType.BOOL
ConfigType.COMPLEX
ConfigType.DECIMAL
ConfigType.ENUM
ConfigType.INT
ConfigType.STRING
ConfigType.TIME
ConfigType.TIMEZONE
ConfigType.UINT
Member Of
DomainConfig object
CreditAccountingIntegrationConfigureErrorCode
No description
enum CreditAccountingIntegrationConfigureErrorCode {
CHART_LOOKUP_INVALID_ACCOUNT_CATEGORY
CHART_OF_ACCOUNTS_BASE_CONFIG_NOT_INITIALIZED
CREDIT_ACCOUNTING_INTEGRATION_CHART_OF_ACCOUNTS_CHANGED
CREDIT_ACCOUNTING_INTEGRATION_FIXED_INTEGRATION_CHANGED
CREDIT_ACCOUNTING_INTEGRATION_LENDING_INTENT_INTEGRATION_NOT_PRESERVED
CREDIT_ACCOUNTING_INTEGRATION_NOT_PRESERVED
CREDIT_ACCOUNTING_SPEC_DUPLICATE_CUSTOMER_TYPE
CREDIT_ACCOUNTING_SPEC_DUPLICATE_LENDING_INTENT
CREDIT_ACCOUNTING_SPEC_HELD_FOR_INVESTMENT_REQUIRED
CREDIT_ACCOUNTING_SPEC_INCOMPLETE_CUSTOMER_TYPE_COVERAGE
GRAPHQL_CREDIT_EMPTY_CUSTOMER_INTEGRATION_GROUP
}
Values
CreditAccountingIntegrationConfigureErrorCode.CHART_LOOKUP_INVALID_ACCOUNT_CATEGORY
Account code does not belong to the required category.
CreditAccountingIntegrationConfigureErrorCode.CHART_OF_ACCOUNTS_BASE_CONFIG_NOT_INITIALIZED
The chart base configuration has not been initialized.
CreditAccountingIntegrationConfigureErrorCode.CREDIT_ACCOUNTING_INTEGRATION_CHART_OF_ACCOUNTS_CHANGED
The chart of accounts cannot be changed.
CreditAccountingIntegrationConfigureErrorCode.CREDIT_ACCOUNTING_INTEGRATION_FIXED_INTEGRATION_CHANGED
Existing fixed accounting integrations cannot be changed.
CreditAccountingIntegrationConfigureErrorCode.CREDIT_ACCOUNTING_INTEGRATION_LENDING_INTENT_INTEGRATION_NOT_PRESERVED
An existing lending intent integration must be preserved.
CreditAccountingIntegrationConfigureErrorCode.CREDIT_ACCOUNTING_INTEGRATION_NOT_PRESERVED
An existing customer accounting integration must be preserved.
CreditAccountingIntegrationConfigureErrorCode.CREDIT_ACCOUNTING_SPEC_DUPLICATE_CUSTOMER_TYPE
A customer type appears more than once in a lending intent integration.
CreditAccountingIntegrationConfigureErrorCode.CREDIT_ACCOUNTING_SPEC_DUPLICATE_LENDING_INTENT
A lending intent appears more than once in the credit accounting integration.
CreditAccountingIntegrationConfigureErrorCode.CREDIT_ACCOUNTING_SPEC_HELD_FOR_INVESTMENT_REQUIRED
The credit accounting integration must route held-for-investment facilities.
CreditAccountingIntegrationConfigureErrorCode.CREDIT_ACCOUNTING_SPEC_INCOMPLETE_CUSTOMER_TYPE_COVERAGE
A lending intent integration must cover every customer type.
CreditAccountingIntegrationConfigureErrorCode.GRAPHQL_CREDIT_EMPTY_CUSTOMER_INTEGRATION_GROUP
A customer integration group must contain at least one customer type.
Member Of
CreditAccountingIntegrationConfigurePayloadError object
CreditCurrencyPolicyConfigureErrorCode
No description
enum CreditCurrencyPolicyConfigureErrorCode {
CREDIT_CURRENCY_POLICY_COLLATERAL_CURRENCY_MUST_BE_NON_FIAT
CREDIT_CURRENCY_POLICY_FACILITY_CURRENCY_MUST_BE_FIAT
CREDIT_CURRENCY_POLICY_FUNCTIONAL_CURRENCY_MISMATCH
CREDIT_CURRENCY_POLICY_SUPPORTED_COLLATERAL_CURRENCY_REMOVED
CREDIT_CURRENCY_POLICY_SUPPORTED_CURRENCIES_REQUIRED
CREDIT_CURRENCY_POLICY_SUPPORTED_FACILITY_CURRENCY_REMOVED
MONEY_UNSUPPORTED_CURRENCY
}
Values
CreditCurrencyPolicyConfigureErrorCode.CREDIT_CURRENCY_POLICY_COLLATERAL_CURRENCY_MUST_BE_NON_FIAT
A supported collateral currency must not be a fiat currency.
CreditCurrencyPolicyConfigureErrorCode.CREDIT_CURRENCY_POLICY_FACILITY_CURRENCY_MUST_BE_FIAT
A supported facility currency must be a fiat currency.
CreditCurrencyPolicyConfigureErrorCode.CREDIT_CURRENCY_POLICY_FUNCTIONAL_CURRENCY_MISMATCH
The functional currency cannot be changed after configuration.
CreditCurrencyPolicyConfigureErrorCode.CREDIT_CURRENCY_POLICY_SUPPORTED_COLLATERAL_CURRENCY_REMOVED
An existing collateral currency cannot be removed.
CreditCurrencyPolicyConfigureErrorCode.CREDIT_CURRENCY_POLICY_SUPPORTED_CURRENCIES_REQUIRED
At least one collateral currency and one facility currency must be supported.
CreditCurrencyPolicyConfigureErrorCode.CREDIT_CURRENCY_POLICY_SUPPORTED_FACILITY_CURRENCY_REMOVED
An existing facility currency cannot be removed.
CreditCurrencyPolicyConfigureErrorCode.MONEY_UNSUPPORTED_CURRENCY
The amount uses an unsupported currency.
Member Of
CreditCurrencyPolicyConfigurePayloadError object
CreditFacilityAgreementGenerateErrorCode
No description
enum CreditFacilityAgreementGenerateErrorCode {
CREDIT_FACILITY_NOT_FOUND
CUSTOMER_IS_CLOSED
}
Values
CreditFacilityAgreementGenerateErrorCode.CREDIT_FACILITY_NOT_FOUND
No credit facility exists with the supplied id.
CreditFacilityAgreementGenerateErrorCode.CUSTOMER_IS_CLOSED
the customer is closed
Member Of
CreditFacilityAgreementGeneratePayloadError object
CreditFacilityAgreementStatus
No description
enum CreditFacilityAgreementStatus {
COMPLETED
FAILED
PENDING
}
Values
CreditFacilityAgreementStatus.COMPLETED
CreditFacilityAgreementStatus.FAILED
CreditFacilityAgreementStatus.PENDING
Member Of
CreditFacilityAgreement object
CreditFacilityCompleteErrorCode
No description
enum CreditFacilityCompleteErrorCode {
COLLATERAL_CUSTODIAN_MANAGED
COLLATERAL_INSUFFICIENT_LOTS_FOR_RELEASE
CREDIT_FACILITY_NOT_FOUND
CREDIT_FACILITY_OUTSTANDING_AMOUNT
CREDIT_FACILITY_PAYMENTS_UNAPPLIED
}
Values
CreditFacilityCompleteErrorCode.COLLATERAL_CUSTODIAN_MANAGED
The collateral is held with a custodian, so it cannot be updated by hand.
CreditFacilityCompleteErrorCode.COLLATERAL_INSUFFICIENT_LOTS_FOR_RELEASE
The active lots do not hold enough collateral to release the amount.
CreditFacilityCompleteErrorCode.CREDIT_FACILITY_NOT_FOUND
No credit facility exists with the supplied id.
CreditFacilityCompleteErrorCode.CREDIT_FACILITY_OUTSTANDING_AMOUNT
The facility still has outstanding or defaulted amounts, so it cannot be completed.
CreditFacilityCompleteErrorCode.CREDIT_FACILITY_PAYMENTS_UNAPPLIED
The facility still holds payments that have not been applied, so it cannot be completed.
Member Of
CreditFacilityCompletePayloadError object
CreditFacilityDisbursalInitiateErrorCode
No description
enum CreditFacilityDisbursalInitiateErrorCode {
CREDIT_DISBURSAL_AMOUNT_MUST_NOT_BE_ZERO
CREDIT_DISBURSAL_AMOUNT_TOO_LARGE
CREDIT_DISBURSAL_CURRENCY_MISMATCH
CREDIT_DISBURSAL_LIMIT_EXCEEDED
CREDIT_DISBURSAL_MARGIN_LIMIT_EXCEEDED
CREDIT_DISBURSAL_ON_INACTIVE_FACILITY
CREDIT_DISBURSAL_PAST_MATURITY_DATE
CREDIT_FACILITY_NOT_FOUND
CREDIT_ONLY_ONE_DISBURSAL_ALLOWED
CUSTOMER_IS_CLOSED
CUSTOMER_IS_FROZEN
MONEY_OVERFLOW
MONEY_UNSUPPORTED_CURRENCY
PAYMENTS_DESTINATION_RECEIVES_ANOTHER_FORM
PAYMENTS_NO_MATCHING_RAIL
PAYMENTS_PAYMENT_ENDPOINT_RETIRED
PAYMENTS_PAYOUT_DRAFT_AMOUNT_MUST_NOT_BE_ZERO
PAYMENTS_PAYOUT_DRAFT_CURRENCY_MISMATCH
PAYMENTS_PAYOUT_DRAFT_DESTINATION_REFERENCE_MUST_NOT_BE_EMPTY
}
Values
CreditFacilityDisbursalInitiateErrorCode.CREDIT_DISBURSAL_AMOUNT_MUST_NOT_BE_ZERO
The disbursal amount must not be zero.
CreditFacilityDisbursalInitiateErrorCode.CREDIT_DISBURSAL_AMOUNT_TOO_LARGE
The disbursal amount is larger than the facility's remaining balance.
CreditFacilityDisbursalInitiateErrorCode.CREDIT_DISBURSAL_CURRENCY_MISMATCH
The disbursal is in a different currency than the facility.
CreditFacilityDisbursalInitiateErrorCode.CREDIT_DISBURSAL_LIMIT_EXCEEDED
The disbursal would exceed the facility's disbursal limit on the ledger.
CreditFacilityDisbursalInitiateErrorCode.CREDIT_DISBURSAL_MARGIN_LIMIT_EXCEEDED
The disbursal would take the loan-to-value past the margin call limit.
CreditFacilityDisbursalInitiateErrorCode.CREDIT_DISBURSAL_ON_INACTIVE_FACILITY
Disbursals can only be initiated against an active facility.
CreditFacilityDisbursalInitiateErrorCode.CREDIT_DISBURSAL_PAST_MATURITY_DATE
The facility has reached its maturity date, so it can no longer be disbursed.
CreditFacilityDisbursalInitiateErrorCode.CREDIT_FACILITY_NOT_FOUND
No credit facility exists with the supplied id.
CreditFacilityDisbursalInitiateErrorCode.CREDIT_ONLY_ONE_DISBURSAL_ALLOWED
The facility's terms allow a single disbursal, and it was already made.
CreditFacilityDisbursalInitiateErrorCode.CUSTOMER_IS_CLOSED
the customer is closed
CreditFacilityDisbursalInitiateErrorCode.CUSTOMER_IS_FROZEN
the customer is frozen
CreditFacilityDisbursalInitiateErrorCode.MONEY_OVERFLOW
The amount exceeds the maximum supported value.
CreditFacilityDisbursalInitiateErrorCode.MONEY_UNSUPPORTED_CURRENCY
The amount uses an unsupported currency.
CreditFacilityDisbursalInitiateErrorCode.PAYMENTS_DESTINATION_RECEIVES_ANOTHER_FORM
The destination receives a different form of the currency than the one sent.
CreditFacilityDisbursalInitiateErrorCode.PAYMENTS_NO_MATCHING_RAIL
No configured rail can carry the requested currency variant.
CreditFacilityDisbursalInitiateErrorCode.PAYMENTS_PAYMENT_ENDPOINT_RETIRED
The payment endpoint is retired and no longer accepts payments.
CreditFacilityDisbursalInitiateErrorCode.PAYMENTS_PAYOUT_DRAFT_AMOUNT_MUST_NOT_BE_ZERO
A payout draft must carry a non-zero amount.
CreditFacilityDisbursalInitiateErrorCode.PAYMENTS_PAYOUT_DRAFT_CURRENCY_MISMATCH
The payout draft amount is not in the currency its destination settles.
CreditFacilityDisbursalInitiateErrorCode.PAYMENTS_PAYOUT_DRAFT_DESTINATION_REFERENCE_MUST_NOT_BE_EMPTY
A payout draft must name a destination reference.
Member Of
CreditFacilityDisbursalInitiatePayloadError object
CreditFacilityPartialPaymentRecordErrorCode
No description
enum CreditFacilityPartialPaymentRecordErrorCode {
COLLECTION_PAYMENT_AMOUNT_MUST_NOT_BE_ZERO
COLLECTION_PAYMENT_EXCEEDS_OUTSTANDING
CREDIT_EXTERNAL_PAYMENT_DURING_LIQUIDATION
CREDIT_FACILITY_NOT_FOUND
CREDIT_PAYMENT_BEFORE_FACILITY_ACTIVATION
CREDIT_PAYMENT_CURRENCY_MISMATCH
CREDIT_PAYMENT_IN_FUTURE
CREDIT_PAYMENT_ON_CLOSED_FACILITY
DEPOSIT_ACCOUNT_CLOSED
DEPOSIT_ACCOUNT_FOR_CURRENCY_NOT_FOUND
DEPOSIT_ACCOUNT_FROZEN
HOLDING_ACCOUNT_LOCKED
HOLDING_LIMIT_EXCEEDED
MONEY_OVERFLOW
MONEY_UNSUPPORTED_CURRENCY
}
Values
CreditFacilityPartialPaymentRecordErrorCode.COLLECTION_PAYMENT_AMOUNT_MUST_NOT_BE_ZERO
A payment must carry a non-zero amount.
CreditFacilityPartialPaymentRecordErrorCode.COLLECTION_PAYMENT_EXCEEDS_OUTSTANDING
The payment is larger than the beneficiary's outstanding obligations.
CreditFacilityPartialPaymentRecordErrorCode.CREDIT_EXTERNAL_PAYMENT_DURING_LIQUIDATION
External payments cannot be recorded while liquidation recovery is pending.
CreditFacilityPartialPaymentRecordErrorCode.CREDIT_FACILITY_NOT_FOUND
No credit facility exists with the supplied id.
CreditFacilityPartialPaymentRecordErrorCode.CREDIT_PAYMENT_BEFORE_FACILITY_ACTIVATION
The payment's effective date is before the facility was activated.
CreditFacilityPartialPaymentRecordErrorCode.CREDIT_PAYMENT_CURRENCY_MISMATCH
The payment is in a different currency than the facility.
CreditFacilityPartialPaymentRecordErrorCode.CREDIT_PAYMENT_IN_FUTURE
The payment's effective date is in the future.
CreditFacilityPartialPaymentRecordErrorCode.CREDIT_PAYMENT_ON_CLOSED_FACILITY
Payments cannot be recorded against a closed facility.
CreditFacilityPartialPaymentRecordErrorCode.DEPOSIT_ACCOUNT_CLOSED
The deposit account is closed.
CreditFacilityPartialPaymentRecordErrorCode.DEPOSIT_ACCOUNT_FOR_CURRENCY_NOT_FOUND
The account holder has no open deposit account in this currency.
CreditFacilityPartialPaymentRecordErrorCode.DEPOSIT_ACCOUNT_FROZEN
The deposit account is frozen.
CreditFacilityPartialPaymentRecordErrorCode.HOLDING_ACCOUNT_LOCKED
One of the posted accounts is locked.
CreditFacilityPartialPaymentRecordErrorCode.HOLDING_LIMIT_EXCEEDED
A velocity limit on one of the posted accounts refused the entry.
CreditFacilityPartialPaymentRecordErrorCode.MONEY_OVERFLOW
The amount exceeds the maximum supported value.
CreditFacilityPartialPaymentRecordErrorCode.MONEY_UNSUPPORTED_CURRENCY
The amount uses an unsupported currency.
Member Of
CreditFacilityPartialPaymentRecordPayloadError object
CreditFacilityProductCreateErrorCode
No description
enum CreditFacilityProductCreateErrorCode {
CREDIT_ACCOUNTING_CUSTOMER_TYPE_NOT_CONFIGURED
CREDIT_ACCOUNTING_INTEGRATION_NOT_CONFIGURED
CREDIT_ACCOUNTING_LENDING_INTENT_NOT_CONFIGURED
CREDIT_FACILITY_PRODUCT_NAME_MUST_NOT_BE_EMPTY
CREDIT_FACILITY_PRODUCT_NAME_TAKEN
CREDIT_SUPPORTED_LENDING_INTENTS_REQUIRED
CREDIT_SUPPORTED_LENDING_INTENT_DUPLICATED
CREDIT_SUPPORTED_LENDING_INTENT_NOT_SUPPORTED
CREDIT_TERMS_DEFAULTED_DURATION_BELOW_OVERDUE_DURATION
CREDIT_TERMS_FACILITY_DURATION_NOT_POSITIVE
CREDIT_TERMS_LOAN_TO_VALUE_NOT_FINITE
CREDIT_TERMS_LOAN_TO_VALUE_NOT_POSITIVE
CREDIT_TERMS_LOAN_TO_VALUE_TOO_LARGE
CREDIT_TERMS_MARGIN_CALL_ABOVE_LIQUIDATION_LIMIT
CREDIT_TERMS_MARGIN_CALL_BELOW_INITIAL_LIMIT
GRAPHQL_FACILITY_DURATION_PERIOD_MUST_BE_MONTHS
GRAPHQL_OBLIGATION_DURATION_PERIOD_MUST_BE_DAYS
PARTNER_NOT_ACTIVE
PARTNER_NOT_FOUND
}
Values
CreditFacilityProductCreateErrorCode.CREDIT_ACCOUNTING_CUSTOMER_TYPE_NOT_CONFIGURED
The credit accounting integration has no entry for this customer type under the lending intent.
CreditFacilityProductCreateErrorCode.CREDIT_ACCOUNTING_INTEGRATION_NOT_CONFIGURED
The credit accounting integration has not been configured.
CreditFacilityProductCreateErrorCode.CREDIT_ACCOUNTING_LENDING_INTENT_NOT_CONFIGURED
The credit accounting integration has no entry for this lending intent.
CreditFacilityProductCreateErrorCode.CREDIT_FACILITY_PRODUCT_NAME_MUST_NOT_BE_EMPTY
A credit facility product must have a name.
CreditFacilityProductCreateErrorCode.CREDIT_FACILITY_PRODUCT_NAME_TAKEN
Another credit facility product of the partner already uses this name.
CreditFacilityProductCreateErrorCode.CREDIT_SUPPORTED_LENDING_INTENTS_REQUIRED
A product must support at least one lending intent.
CreditFacilityProductCreateErrorCode.CREDIT_SUPPORTED_LENDING_INTENT_DUPLICATED
A lending intent appears more than once.
CreditFacilityProductCreateErrorCode.CREDIT_SUPPORTED_LENDING_INTENT_NOT_SUPPORTED
The lending intent cannot be supported by a credit facility product.
CreditFacilityProductCreateErrorCode.CREDIT_TERMS_DEFAULTED_DURATION_BELOW_OVERDUE_DURATION
The defaulted duration must not be shorter than the overdue duration.
CreditFacilityProductCreateErrorCode.CREDIT_TERMS_FACILITY_DURATION_NOT_POSITIVE
The facility duration must be positive.
CreditFacilityProductCreateErrorCode.CREDIT_TERMS_LOAN_TO_VALUE_NOT_FINITE
The loan-to-value must be finite, which requires collateral above zero.
CreditFacilityProductCreateErrorCode.CREDIT_TERMS_LOAN_TO_VALUE_NOT_POSITIVE
The loan-to-value must be strictly greater than 0%.
CreditFacilityProductCreateErrorCode.CREDIT_TERMS_LOAN_TO_VALUE_TOO_LARGE
The loan-to-value must be strictly less than 100%.
CreditFacilityProductCreateErrorCode.CREDIT_TERMS_MARGIN_CALL_ABOVE_LIQUIDATION_LIMIT
The margin call limit must be below the liquidation loan-to-value limit.
CreditFacilityProductCreateErrorCode.CREDIT_TERMS_MARGIN_CALL_BELOW_INITIAL_LIMIT
The margin call limit must be above the initial loan-to-value limit.
CreditFacilityProductCreateErrorCode.GRAPHQL_FACILITY_DURATION_PERIOD_MUST_BE_MONTHS
The facility duration period must be MONTHS.
CreditFacilityProductCreateErrorCode.GRAPHQL_OBLIGATION_DURATION_PERIOD_MUST_BE_DAYS
The obligation duration period must be DAYS.
CreditFacilityProductCreateErrorCode.PARTNER_NOT_ACTIVE
The partner is not active.
CreditFacilityProductCreateErrorCode.PARTNER_NOT_FOUND
No partner exists with the supplied id.
Member Of
CreditFacilityProductCreatePayloadError object
CreditFacilityProductSortBy
No description
enum CreditFacilityProductSortBy {
ANNUAL_RATE
CREATED_AT
DURATION
NAME
}
Values
CreditFacilityProductSortBy.ANNUAL_RATE
CreditFacilityProductSortBy.CREATED_AT
CreditFacilityProductSortBy.DURATION
CreditFacilityProductSortBy.NAME
Member Of
CreditFacilityProductSort input
CreditFacilityProductStatus
No description
enum CreditFacilityProductStatus {
ACTIVE
NEW
RETIRED
}
Values
CreditFacilityProductStatus.ACTIVE
CreditFacilityProductStatus.NEW
CreditFacilityProductStatus.RETIRED
Member Of
CreditFacilityProduct object ● CreditFacilityProductFilter input ● CreditFacilityProductUpdateStatusInput input
CreditFacilityProductUpdateStatusErrorCode
No description
enum CreditFacilityProductUpdateStatusErrorCode {
CREDIT_FACILITY_PRODUCT_NOT_FOUND
}
Values
CreditFacilityProductUpdateStatusErrorCode.CREDIT_FACILITY_PRODUCT_NOT_FOUND
No credit facility product exists with the supplied id.
Member Of
CreditFacilityProductUpdateStatusPayloadError object
CreditFacilityProductUpdateTermsErrorCode
No description
enum CreditFacilityProductUpdateTermsErrorCode {
CREDIT_FACILITY_PRODUCT_NOT_FOUND
CREDIT_PRODUCT_TERMS_VERSION_MISMATCH
CREDIT_TERMS_DEFAULTED_DURATION_BELOW_OVERDUE_DURATION
CREDIT_TERMS_FACILITY_DURATION_NOT_POSITIVE
CREDIT_TERMS_LOAN_TO_VALUE_NOT_FINITE
CREDIT_TERMS_LOAN_TO_VALUE_NOT_POSITIVE
CREDIT_TERMS_LOAN_TO_VALUE_TOO_LARGE
CREDIT_TERMS_MARGIN_CALL_ABOVE_LIQUIDATION_LIMIT
CREDIT_TERMS_MARGIN_CALL_BELOW_INITIAL_LIMIT
GRAPHQL_FACILITY_DURATION_PERIOD_MUST_BE_MONTHS
GRAPHQL_OBLIGATION_DURATION_PERIOD_MUST_BE_DAYS
}
Values
CreditFacilityProductUpdateTermsErrorCode.CREDIT_FACILITY_PRODUCT_NOT_FOUND
No credit facility product exists with the supplied id.
CreditFacilityProductUpdateTermsErrorCode.CREDIT_PRODUCT_TERMS_VERSION_MISMATCH
The product terms changed since the caller read them.
CreditFacilityProductUpdateTermsErrorCode.CREDIT_TERMS_DEFAULTED_DURATION_BELOW_OVERDUE_DURATION
The defaulted duration must not be shorter than the overdue duration.
CreditFacilityProductUpdateTermsErrorCode.CREDIT_TERMS_FACILITY_DURATION_NOT_POSITIVE
The facility duration must be positive.
CreditFacilityProductUpdateTermsErrorCode.CREDIT_TERMS_LOAN_TO_VALUE_NOT_FINITE
The loan-to-value must be finite, which requires collateral above zero.
CreditFacilityProductUpdateTermsErrorCode.CREDIT_TERMS_LOAN_TO_VALUE_NOT_POSITIVE
The loan-to-value must be strictly greater than 0%.
CreditFacilityProductUpdateTermsErrorCode.CREDIT_TERMS_LOAN_TO_VALUE_TOO_LARGE
The loan-to-value must be strictly less than 100%.
CreditFacilityProductUpdateTermsErrorCode.CREDIT_TERMS_MARGIN_CALL_ABOVE_LIQUIDATION_LIMIT
The margin call limit must be below the liquidation loan-to-value limit.
CreditFacilityProductUpdateTermsErrorCode.CREDIT_TERMS_MARGIN_CALL_BELOW_INITIAL_LIMIT
The margin call limit must be above the initial loan-to-value limit.
CreditFacilityProductUpdateTermsErrorCode.GRAPHQL_FACILITY_DURATION_PERIOD_MUST_BE_MONTHS
The facility duration period must be MONTHS.
CreditFacilityProductUpdateTermsErrorCode.GRAPHQL_OBLIGATION_DURATION_PERIOD_MUST_BE_DAYS
The obligation duration period must be DAYS.
Member Of
CreditFacilityProductUpdateTermsPayloadError object
CreditFacilityProposalCreateErrorCode
No description
enum CreditFacilityProposalCreateErrorCode {
CREDIT_CURRENCY_POLICY_NOT_CONFIGURED
CREDIT_CURRENCY_POLICY_UNSUPPORTED_COLLATERAL_CURRENCY
CREDIT_CURRENCY_POLICY_UNSUPPORTED_FACILITY_CURRENCY
CREDIT_FACILITY_PRODUCT_NOT_ACTIVE
CREDIT_FACILITY_PRODUCT_NOT_FOUND
CREDIT_FACILITY_PROPOSAL_AMOUNT_MUST_NOT_BE_ZERO
CREDIT_FACILITY_TERMS_ALTERATION_DUPLICATED
CREDIT_PRODUCT_CUSTOMER_TYPE_NOT_SUPPORTED
CREDIT_PRODUCT_PARTNER_MISMATCH
CREDIT_PRODUCT_TERMS_VERSION_MISMATCH
CREDIT_TERMS_DEFAULTED_DURATION_BELOW_OVERDUE_DURATION
CREDIT_TERMS_FACILITY_DURATION_NOT_POSITIVE
CREDIT_TERMS_LOAN_TO_VALUE_NOT_FINITE
CREDIT_TERMS_LOAN_TO_VALUE_NOT_POSITIVE
CREDIT_TERMS_LOAN_TO_VALUE_TOO_LARGE
CREDIT_TERMS_MARGIN_CALL_ABOVE_LIQUIDATION_LIMIT
CREDIT_TERMS_MARGIN_CALL_BELOW_INITIAL_LIMIT
CUSTOMER_IS_CLOSED
CUSTOMER_IS_FROZEN
CUSTOMER_NOT_FOUND
DEPOSIT_ACCOUNT_CLOSED
DEPOSIT_ACCOUNT_FOR_CURRENCY_NOT_FOUND
DEPOSIT_ACCOUNT_FROZEN
GRAPHQL_FACILITY_DURATION_PERIOD_MUST_BE_MONTHS
GRAPHQL_OBLIGATION_DURATION_PERIOD_MUST_BE_DAYS
MONEY_OVERFLOW
MONEY_UNSUPPORTED_CURRENCY
}
Values
CreditFacilityProposalCreateErrorCode.CREDIT_CURRENCY_POLICY_NOT_CONFIGURED
The credit currency policy has not been configured.
CreditFacilityProposalCreateErrorCode.CREDIT_CURRENCY_POLICY_UNSUPPORTED_COLLATERAL_CURRENCY
The currency is not a supported collateral currency.
CreditFacilityProposalCreateErrorCode.CREDIT_CURRENCY_POLICY_UNSUPPORTED_FACILITY_CURRENCY
The currency is not a supported facility currency.
CreditFacilityProposalCreateErrorCode.CREDIT_FACILITY_PRODUCT_NOT_ACTIVE
The credit facility product is not active, so proposals cannot be created against it.
CreditFacilityProposalCreateErrorCode.CREDIT_FACILITY_PRODUCT_NOT_FOUND
No credit facility product exists with the supplied id.
CreditFacilityProposalCreateErrorCode.CREDIT_FACILITY_PROPOSAL_AMOUNT_MUST_NOT_BE_ZERO
The facility amount of a proposal must not be zero.
CreditFacilityProposalCreateErrorCode.CREDIT_FACILITY_TERMS_ALTERATION_DUPLICATED
A terms alteration of the same kind was supplied more than once.
CreditFacilityProposalCreateErrorCode.CREDIT_PRODUCT_CUSTOMER_TYPE_NOT_SUPPORTED
The product does not serve the customer's type.
CreditFacilityProposalCreateErrorCode.CREDIT_PRODUCT_PARTNER_MISMATCH
The product belongs to a different partner than the customer.
CreditFacilityProposalCreateErrorCode.CREDIT_PRODUCT_TERMS_VERSION_MISMATCH
The product terms changed since the caller read them.
CreditFacilityProposalCreateErrorCode.CREDIT_TERMS_DEFAULTED_DURATION_BELOW_OVERDUE_DURATION
The defaulted duration must not be shorter than the overdue duration.
CreditFacilityProposalCreateErrorCode.CREDIT_TERMS_FACILITY_DURATION_NOT_POSITIVE
The facility duration must be positive.
CreditFacilityProposalCreateErrorCode.CREDIT_TERMS_LOAN_TO_VALUE_NOT_FINITE
The loan-to-value must be finite, which requires collateral above zero.
CreditFacilityProposalCreateErrorCode.CREDIT_TERMS_LOAN_TO_VALUE_NOT_POSITIVE
The loan-to-value must be strictly greater than 0%.
CreditFacilityProposalCreateErrorCode.CREDIT_TERMS_LOAN_TO_VALUE_TOO_LARGE
The loan-to-value must be strictly less than 100%.
CreditFacilityProposalCreateErrorCode.CREDIT_TERMS_MARGIN_CALL_ABOVE_LIQUIDATION_LIMIT
The margin call limit must be below the liquidation loan-to-value limit.
CreditFacilityProposalCreateErrorCode.CREDIT_TERMS_MARGIN_CALL_BELOW_INITIAL_LIMIT
The margin call limit must be above the initial loan-to-value limit.
CreditFacilityProposalCreateErrorCode.CUSTOMER_IS_CLOSED
the customer is closed
CreditFacilityProposalCreateErrorCode.CUSTOMER_IS_FROZEN
the customer is frozen
CreditFacilityProposalCreateErrorCode.CUSTOMER_NOT_FOUND
the customer was not found
CreditFacilityProposalCreateErrorCode.DEPOSIT_ACCOUNT_CLOSED
The deposit account is closed.
CreditFacilityProposalCreateErrorCode.DEPOSIT_ACCOUNT_FOR_CURRENCY_NOT_FOUND
The account holder has no open deposit account in this currency.
CreditFacilityProposalCreateErrorCode.DEPOSIT_ACCOUNT_FROZEN
The deposit account is frozen.
CreditFacilityProposalCreateErrorCode.GRAPHQL_FACILITY_DURATION_PERIOD_MUST_BE_MONTHS
The facility duration period must be MONTHS.
CreditFacilityProposalCreateErrorCode.GRAPHQL_OBLIGATION_DURATION_PERIOD_MUST_BE_DAYS
The obligation duration period must be DAYS.
CreditFacilityProposalCreateErrorCode.MONEY_OVERFLOW
The amount exceeds the maximum supported value.
CreditFacilityProposalCreateErrorCode.MONEY_UNSUPPORTED_CURRENCY
The amount uses an unsupported currency.
Member Of
CreditFacilityProposalCreatePayloadError object
CreditFacilityProposalCustomerApprovalConcludeErrorCode
No description
enum CreditFacilityProposalCustomerApprovalConcludeErrorCode {
CREDIT_FACILITY_PROPOSAL_NOT_FOUND
CUSTOMER_IS_CLOSED
CUSTOMER_IS_FROZEN
}
Values
CreditFacilityProposalCustomerApprovalConcludeErrorCode.CREDIT_FACILITY_PROPOSAL_NOT_FOUND
No credit facility proposal exists with the supplied id.
CreditFacilityProposalCustomerApprovalConcludeErrorCode.CUSTOMER_IS_CLOSED
the customer is closed
CreditFacilityProposalCustomerApprovalConcludeErrorCode.CUSTOMER_IS_FROZEN
the customer is frozen
Member Of
CreditFacilityProposalCustomerApprovalConcludePayloadError object
CreditFacilityProposalSortBy
No description
enum CreditFacilityProposalSortBy {
CREATED_AT
FACILITY_AMOUNT
}
Values
CreditFacilityProposalSortBy.CREATED_AT
CreditFacilityProposalSortBy.FACILITY_AMOUNT
Member Of
CreditFacilityProposalSort input
CreditFacilityProposalStatus
No description
enum CreditFacilityProposalStatus {
APPROVED
CUSTOMER_DENIED
DENIED
PENDING_APPROVAL
PENDING_CUSTOMER_APPROVAL
}
Values
CreditFacilityProposalStatus.APPROVED
CreditFacilityProposalStatus.CUSTOMER_DENIED
CreditFacilityProposalStatus.DENIED
CreditFacilityProposalStatus.PENDING_APPROVAL
CreditFacilityProposalStatus.PENDING_CUSTOMER_APPROVAL
Member Of
CreditFacilityProposal object ● CreditFacilityProposalFilter input
CreditFacilityRepaymentStatus
No description
enum CreditFacilityRepaymentStatus {
DEFAULTED
DUE
NOT_YET_DUE
OVERDUE
PAID
UPCOMING
}
Values
CreditFacilityRepaymentStatus.DEFAULTED
CreditFacilityRepaymentStatus.DUE
CreditFacilityRepaymentStatus.NOT_YET_DUE
CreditFacilityRepaymentStatus.OVERDUE
CreditFacilityRepaymentStatus.PAID
CreditFacilityRepaymentStatus.UPCOMING
Member Of
CreditFacilityRepaymentPlanEntry object
CreditFacilityRepaymentType
No description
enum CreditFacilityRepaymentType {
DISBURSAL
INTEREST
}
Values
CreditFacilityRepaymentType.DISBURSAL
CreditFacilityRepaymentType.INTEREST
Member Of
CreditFacilityRepaymentPlanEntry object
CreditFacilitySortBy
No description
enum CreditFacilitySortBy {
CREATED_AT
LTV
}
Values
CreditFacilitySortBy.CREATED_AT
CreditFacilitySortBy.LTV
Member Of
CreditFacilitySort input
CreditFacilityStatus
No description
enum CreditFacilityStatus {
ACTIVE
CLOSED
MATURED
}
Values
CreditFacilityStatus.ACTIVE
CreditFacilityStatus.CLOSED
CreditFacilityStatus.MATURED
Member Of
CreditFacility object ● CreditFacilityFilter input
CustodianConfigUpdateErrorCode
No description
enum CustodianConfigUpdateErrorCode {
CUSTODY_CUSTODIAN_NOT_FOUND
CUSTODY_PROVIDER_TYPE_MISMATCH
}
Values
CustodianConfigUpdateErrorCode.CUSTODY_CUSTODIAN_NOT_FOUND
No custodian exists with the supplied id.
CustodianConfigUpdateErrorCode.CUSTODY_PROVIDER_TYPE_MISMATCH
A custodian cannot change from one kind of provider to another.
Member Of
CustodianConfigUpdatePayloadError object
CustodianCreateErrorCode
No description
enum CustodianCreateErrorCode {
CUSTODY_CUSTODIAN_NAME_TAKEN
CUSTODY_CUSTODIAN_PROVIDER_TAKEN
}
Values
CustodianCreateErrorCode.CUSTODY_CUSTODIAN_NAME_TAKEN
Another custodian already uses this name.
CustodianCreateErrorCode.CUSTODY_CUSTODIAN_PROVIDER_TAKEN
Another custodian is already configured for this provider.
Member Of
CustodianCreatePayloadError object
CustodianSortBy
No description
enum CustodianSortBy {
CREATED_AT
NAME
}
Values
CustodianSortBy.CREATED_AT
CustodianSortBy.NAME
Member Of
CustodianSort input
CustomerCloseErrorCode
No description
enum CustomerCloseErrorCode {
CUSTOMER_CLOSE_HAS_ACTIVE_CREDIT_FACILITIES
CUSTOMER_CLOSE_HAS_ACTIVE_DEPOSIT_ACCOUNTS
CUSTOMER_CLOSE_HAS_PENDING_COLLATERALIZATION
CUSTOMER_CLOSE_HAS_PENDING_PROPOSALS
CUSTOMER_CLOSE_HAS_PENDING_WITHDRAWALS
}
Values
CustomerCloseErrorCode.CUSTOMER_CLOSE_HAS_ACTIVE_CREDIT_FACILITIES
The customer still has active credit facilities and cannot be closed.
CustomerCloseErrorCode.CUSTOMER_CLOSE_HAS_ACTIVE_DEPOSIT_ACCOUNTS
The customer still has active deposit accounts and cannot be closed.
CustomerCloseErrorCode.CUSTOMER_CLOSE_HAS_PENDING_COLLATERALIZATION
The customer has credit facilities awaiting collateralization and cannot be closed.
CustomerCloseErrorCode.CUSTOMER_CLOSE_HAS_PENDING_PROPOSALS
The customer still has pending credit facility proposals and cannot be closed.
CustomerCloseErrorCode.CUSTOMER_CLOSE_HAS_PENDING_WITHDRAWALS
The customer still has pending withdrawals and cannot be closed.
Member Of
CustomerClosePayloadError object
CustomerDocumentArchiveErrorCode
No description
enum CustomerDocumentArchiveErrorCode {
DOCUMENT_DELETED
DOCUMENT_DELETION_REQUESTED
DOCUMENT_NOT_FOUND
DOCUMENT_NOT_READY
}
Values
CustomerDocumentArchiveErrorCode.DOCUMENT_DELETED
The document has been deleted and cannot be archived.
CustomerDocumentArchiveErrorCode.DOCUMENT_DELETION_REQUESTED
The document is being deleted and cannot be archived.
CustomerDocumentArchiveErrorCode.DOCUMENT_NOT_FOUND
No document exists with the supplied id.
CustomerDocumentArchiveErrorCode.DOCUMENT_NOT_READY
The document has not finished uploading and cannot be archived yet.
Member Of
CustomerDocumentArchivePayloadError object
CustomerDocumentCreateErrorCode
No description
enum CustomerDocumentCreateErrorCode {
CUSTOMER_IS_CLOSED
}
Values
CustomerDocumentCreateErrorCode.CUSTOMER_IS_CLOSED
the customer is closed
Member Of
CustomerDocumentCreatePayloadError object
CustomerDocumentCreateInlineErrorCode
No description
enum CustomerDocumentCreateInlineErrorCode {
CUSTOMER_IS_CLOSED
GRAPHQL_DOCUMENT_CONTENT_TOO_LARGE
GRAPHQL_DOCUMENT_CONTENT_TYPE_REQUIRED
GRAPHQL_DOCUMENT_FILENAME_REQUIRED
}
Values
CustomerDocumentCreateInlineErrorCode.CUSTOMER_IS_CLOSED
the customer is closed
CustomerDocumentCreateInlineErrorCode.GRAPHQL_DOCUMENT_CONTENT_TOO_LARGE
The inline content exceeds the inline size limit; use the upload mutation.
CustomerDocumentCreateInlineErrorCode.GRAPHQL_DOCUMENT_CONTENT_TYPE_REQUIRED
The content type must not be empty when provided.
CustomerDocumentCreateInlineErrorCode.GRAPHQL_DOCUMENT_FILENAME_REQUIRED
The document filename must not be empty.
Member Of
CustomerDocumentCreateInlinePayloadError object
CustomerDocumentDownloadLinksGenerateErrorCode
No description
enum CustomerDocumentDownloadLinksGenerateErrorCode {
DOCUMENT_NOT_DOWNLOADABLE
DOCUMENT_NOT_FOUND
}
Values
CustomerDocumentDownloadLinksGenerateErrorCode.DOCUMENT_NOT_DOWNLOADABLE
Only an active document can be downloaded.
CustomerDocumentDownloadLinksGenerateErrorCode.DOCUMENT_NOT_FOUND
No document exists with the supplied id.
Member Of
CustomerDocumentDownloadLinksGeneratePayloadError object
CustomerFreezeErrorCode
No description
enum CustomerFreezeErrorCode {
CUSTOMER_IS_CLOSED
}
Values
CustomerFreezeErrorCode.CUSTOMER_IS_CLOSED
the customer is closed
Member Of
CustomerFreezePayloadError object
CustomerNoteCreateErrorCode
No description
enum CustomerNoteCreateErrorCode {
CUSTOMER_NOT_FOUND
NOTE_BODY_REQUIRED
NOTE_BODY_TOO_LONG
}
Values
CustomerNoteCreateErrorCode.CUSTOMER_NOT_FOUND
the customer was not found
CustomerNoteCreateErrorCode.NOTE_BODY_REQUIRED
note body is empty or only whitespace
CustomerNoteCreateErrorCode.NOTE_BODY_TOO_LONG
note body exceeds 4096 characters
Member Of
CustomerNoteCreatePayloadError object
CustomerNoteUpdateErrorCode
No description
enum CustomerNoteUpdateErrorCode {
NOTE_BODY_REQUIRED
NOTE_BODY_TOO_LONG
NOTE_NOT_FOUND
}
Values
CustomerNoteUpdateErrorCode.NOTE_BODY_REQUIRED
note body is empty or only whitespace
CustomerNoteUpdateErrorCode.NOTE_BODY_TOO_LONG
note body exceeds 4096 characters
CustomerNoteUpdateErrorCode.NOTE_NOT_FOUND
the note was not found
Member Of
CustomerNoteUpdatePayloadError object
CustomerSortBy
No description
enum CustomerSortBy {
CREATED_AT
}
Values
CustomerSortBy.CREATED_AT
Member Of
CustomerSort input
CustomerStatus
No description
enum CustomerStatus {
ACTIVE
CLOSED
FROZEN
}
Values
CustomerStatus.ACTIVE
CustomerStatus.CLOSED
CustomerStatus.FROZEN
Member Of
Customer object ● CustomerFilter input
CustomerType
No description
enum CustomerType {
BANK
FINANCIAL_INSTITUTION
FOREIGN_AGENCY_OR_SUBSIDIARY
GOVERNMENT_ENTITY
INDIVIDUAL
NON_DOMICILED_COMPANY
PRIVATE_COMPANY
}
Values
CustomerType.BANK
CustomerType.FINANCIAL_INSTITUTION
CustomerType.FOREIGN_AGENCY_OR_SUBSIDIARY
CustomerType.GOVERNMENT_ENTITY
CustomerType.INDIVIDUAL
CustomerType.NON_DOMICILED_COMPANY
CustomerType.PRIVATE_COMPANY
Member Of
CreditCustomerIntegration object ● CreditCustomerIntegrationGroupInput input ● CreditFacilityProduct object ● CreditFacilityProductCreateInput input ● CreditFacilityProductFilter input ● CustomerFilter input ● DepositAccountProduct object ● DepositAccountProductCreateInput input ● DepositAccountProductFilter input ● DepositCustomerIntegration object ● DepositCustomerIntegrationGroupInput input ● IndividualParty object ● OrganizationParty object ● OrganizationProspectCreateInput input ● ProspectFilter input
CustomerUnfreezeErrorCode
No description
enum CustomerUnfreezeErrorCode {
CUSTOMER_IS_CLOSED
}
Values
CustomerUnfreezeErrorCode.CUSTOMER_IS_CLOSED
the customer is closed
Member Of
CustomerUnfreezePayloadError object
DebitOrCredit
No description
enum DebitOrCredit {
CREDIT
DEBIT
}
Values
DebitOrCredit.CREDIT
DebitOrCredit.DEBIT
Member Of
LedgerAccount object ● LedgerEntry object ● ManualTransactionDraftEntry object ● ManualTransactionDraftEntryInput input ● ManualTransactionEntry object ● ManualTransactionEntryInput input
DepositAccountActivity
No description
enum DepositAccountActivity {
ACTIVE
ESCHEATABLE
INACTIVE
}
Values
DepositAccountActivity.ACTIVE
DepositAccountActivity.ESCHEATABLE
DepositAccountActivity.INACTIVE
Member Of
DepositAccount object ● DepositAccountFilter input
DepositAccountCloseErrorCode
No description
enum DepositAccountCloseErrorCode {
DEPOSIT_ACCOUNT_BALANCE_IS_NOT_ZERO
DEPOSIT_ACCOUNT_FROZEN
DEPOSIT_ACCOUNT_NOT_FOUND
PAYMENTS_RECEIPTS_IN_FLIGHT
}
Values
DepositAccountCloseErrorCode.DEPOSIT_ACCOUNT_BALANCE_IS_NOT_ZERO
The deposit account still holds a balance.
DepositAccountCloseErrorCode.DEPOSIT_ACCOUNT_FROZEN
The deposit account is frozen.
DepositAccountCloseErrorCode.DEPOSIT_ACCOUNT_NOT_FOUND
No deposit account exists with the supplied id.
DepositAccountCloseErrorCode.PAYMENTS_RECEIPTS_IN_FLIGHT
The payment endpoint still has receipts in flight.
Member Of
DepositAccountClosePayloadError object
DepositAccountCreateFromProductErrorCode
No description
enum DepositAccountCreateFromProductErrorCode {
CUSTOMER_IS_CLOSED
CUSTOMER_IS_FROZEN
CUSTOMER_NOT_FOUND
DEPOSIT_ACCOUNT_FOR_CURRENCY_EXISTS
DEPOSIT_ACCOUNT_PRODUCT_CUSTOMER_TYPE_NOT_SUPPORTED
DEPOSIT_ACCOUNT_PRODUCT_NOT_ACTIVE
DEPOSIT_ACCOUNT_PRODUCT_NOT_AVAILABLE_TO_PARTNER
DEPOSIT_ACCOUNT_PRODUCT_NOT_FOUND
DEPOSIT_ACCOUNT_PRODUCT_TERMS_VERSION_MISMATCH
DEPOSIT_UNSUPPORTED_ACCOUNT_CUSTOMER_TYPE
}
Values
DepositAccountCreateFromProductErrorCode.CUSTOMER_IS_CLOSED
the customer is closed
DepositAccountCreateFromProductErrorCode.CUSTOMER_IS_FROZEN
the customer is frozen
DepositAccountCreateFromProductErrorCode.CUSTOMER_NOT_FOUND
the customer was not found
DepositAccountCreateFromProductErrorCode.DEPOSIT_ACCOUNT_FOR_CURRENCY_EXISTS
The account holder already has an open deposit account in this currency.
DepositAccountCreateFromProductErrorCode.DEPOSIT_ACCOUNT_PRODUCT_CUSTOMER_TYPE_NOT_SUPPORTED
The deposit account product does not support this customer type.
DepositAccountCreateFromProductErrorCode.DEPOSIT_ACCOUNT_PRODUCT_NOT_ACTIVE
The deposit account product is not active.
DepositAccountCreateFromProductErrorCode.DEPOSIT_ACCOUNT_PRODUCT_NOT_AVAILABLE_TO_PARTNER
The deposit account product belongs to a different partner.
DepositAccountCreateFromProductErrorCode.DEPOSIT_ACCOUNT_PRODUCT_NOT_FOUND
No deposit account product exists with the supplied id.
DepositAccountCreateFromProductErrorCode.DEPOSIT_ACCOUNT_PRODUCT_TERMS_VERSION_MISMATCH
The product terms were changed since the supplied version.
DepositAccountCreateFromProductErrorCode.DEPOSIT_UNSUPPORTED_ACCOUNT_CUSTOMER_TYPE
The customer type cannot hold a deposit account.
Member Of
DepositAccountCreateFromProductPayloadError object
DepositAccountFreezeErrorCode
No description
enum DepositAccountFreezeErrorCode {
DEPOSIT_ACCOUNT_CLOSED
DEPOSIT_ACCOUNT_NOT_FOUND
}
Values
DepositAccountFreezeErrorCode.DEPOSIT_ACCOUNT_CLOSED
The deposit account is closed.
DepositAccountFreezeErrorCode.DEPOSIT_ACCOUNT_NOT_FOUND
No deposit account exists with the supplied id.
Member Of
DepositAccountFreezePayloadError object
DepositAccountingIntegrationConfigureErrorCode
No description
enum DepositAccountingIntegrationConfigureErrorCode {
CHART_LOOKUP_INVALID_ACCOUNT_CATEGORY
CHART_OF_ACCOUNTS_BASE_CONFIG_NOT_INITIALIZED
DEPOSIT_ACCOUNTING_INTEGRATION_CHART_OF_ACCOUNTS_CHANGED
DEPOSIT_ACCOUNTING_INTEGRATION_NOT_PRESERVED
DEPOSIT_ACCOUNTING_INTEGRATION_OMNIBUS_INTEGRATION_CHANGED
DEPOSIT_ACCOUNTING_SPEC_DUPLICATE_CUSTOMER_TYPE
DEPOSIT_ACCOUNTING_SPEC_DUPLICATE_PRODUCT_TYPE
DEPOSIT_ACCOUNTING_SPEC_INCOMPLETE_CUSTOMER_TYPE_COVERAGE
DEPOSIT_ACCOUNTING_SPEC_PRODUCT_TYPES_MUST_NOT_BE_EMPTY
DEPOSIT_UNSUPPORTED_ACCOUNT_CUSTOMER_TYPE
GRAPHQL_DEPOSIT_EMPTY_CUSTOMER_INTEGRATION_GROUP
}
Values
DepositAccountingIntegrationConfigureErrorCode.CHART_LOOKUP_INVALID_ACCOUNT_CATEGORY
Account code does not belong to the required category.
DepositAccountingIntegrationConfigureErrorCode.CHART_OF_ACCOUNTS_BASE_CONFIG_NOT_INITIALIZED
The chart base configuration has not been initialized.
DepositAccountingIntegrationConfigureErrorCode.DEPOSIT_ACCOUNTING_INTEGRATION_CHART_OF_ACCOUNTS_CHANGED
The chart of accounts cannot be changed.
DepositAccountingIntegrationConfigureErrorCode.DEPOSIT_ACCOUNTING_INTEGRATION_NOT_PRESERVED
An existing customer accounting integration must be preserved.
DepositAccountingIntegrationConfigureErrorCode.DEPOSIT_ACCOUNTING_INTEGRATION_OMNIBUS_INTEGRATION_CHANGED
Existing omnibus accounting integrations cannot be changed.
DepositAccountingIntegrationConfigureErrorCode.DEPOSIT_ACCOUNTING_SPEC_DUPLICATE_CUSTOMER_TYPE
A customer type appears more than once in a deposit customer integration.
DepositAccountingIntegrationConfigureErrorCode.DEPOSIT_ACCOUNTING_SPEC_DUPLICATE_PRODUCT_TYPE
A product type appears more than once in the deposit accounting integration.
DepositAccountingIntegrationConfigureErrorCode.DEPOSIT_ACCOUNTING_SPEC_INCOMPLETE_CUSTOMER_TYPE_COVERAGE
A deposit customer integration must cover every customer type.
DepositAccountingIntegrationConfigureErrorCode.DEPOSIT_ACCOUNTING_SPEC_PRODUCT_TYPES_MUST_NOT_BE_EMPTY
The deposit accounting integration must contain at least one product type.
DepositAccountingIntegrationConfigureErrorCode.DEPOSIT_UNSUPPORTED_ACCOUNT_CUSTOMER_TYPE
The customer type cannot hold a deposit account.
DepositAccountingIntegrationConfigureErrorCode.GRAPHQL_DEPOSIT_EMPTY_CUSTOMER_INTEGRATION_GROUP
A customer integration group must contain at least one customer type.
Member Of
DepositAccountingIntegrationConfigurePayloadError object
DepositAccountProductCreateErrorCode
No description
enum DepositAccountProductCreateErrorCode {
DEPOSIT_ACCOUNTING_CUSTOMER_TYPE_NOT_CONFIGURED
DEPOSIT_ACCOUNTING_INTEGRATION_NOT_CONFIGURED
DEPOSIT_ACCOUNTING_PRODUCT_TYPE_NOT_CONFIGURED
DEPOSIT_ACCOUNT_PRODUCT_MAX_WITHDRAWAL_AMOUNT_PER_TRANSACTION_MUST_BE_POSITIVE
DEPOSIT_ACCOUNT_PRODUCT_NAME_TAKEN
DEPOSIT_ACCOUNT_PRODUCT_TERMS_CURRENCY_MISMATCH
DEPOSIT_CURRENCY_POLICY_NOT_CONFIGURED
DEPOSIT_UNSUPPORTED_ACCOUNT_CUSTOMER_TYPE
DEPOSIT_UNSUPPORTED_CURRENCY
MONEY_OVERFLOW
MONEY_UNSUPPORTED_CURRENCY
PARTNER_NOT_ACTIVE
PARTNER_NOT_FOUND
}
Values
DepositAccountProductCreateErrorCode.DEPOSIT_ACCOUNTING_CUSTOMER_TYPE_NOT_CONFIGURED
The deposit accounting integration has no entry for this customer type under the product type.
DepositAccountProductCreateErrorCode.DEPOSIT_ACCOUNTING_INTEGRATION_NOT_CONFIGURED
The deposit accounting integration has not been configured.
DepositAccountProductCreateErrorCode.DEPOSIT_ACCOUNTING_PRODUCT_TYPE_NOT_CONFIGURED
The deposit accounting integration has no entry for this product type.
DepositAccountProductCreateErrorCode.DEPOSIT_ACCOUNT_PRODUCT_MAX_WITHDRAWAL_AMOUNT_PER_TRANSACTION_MUST_BE_POSITIVE
The maximum withdrawal amount per transaction must be greater than zero.
DepositAccountProductCreateErrorCode.DEPOSIT_ACCOUNT_PRODUCT_NAME_TAKEN
Another deposit account product of this partner already uses this name.
DepositAccountProductCreateErrorCode.DEPOSIT_ACCOUNT_PRODUCT_TERMS_CURRENCY_MISMATCH
The product terms use a different currency than the product.
DepositAccountProductCreateErrorCode.DEPOSIT_CURRENCY_POLICY_NOT_CONFIGURED
The deposit currency policy has not been configured.
DepositAccountProductCreateErrorCode.DEPOSIT_UNSUPPORTED_ACCOUNT_CUSTOMER_TYPE
The customer type cannot hold a deposit account.
DepositAccountProductCreateErrorCode.DEPOSIT_UNSUPPORTED_CURRENCY
The currency is not supported by the deposit currency policy.
DepositAccountProductCreateErrorCode.MONEY_OVERFLOW
The amount exceeds the maximum supported value.
DepositAccountProductCreateErrorCode.MONEY_UNSUPPORTED_CURRENCY
The amount uses an unsupported currency.
DepositAccountProductCreateErrorCode.PARTNER_NOT_ACTIVE
The partner is not active.
DepositAccountProductCreateErrorCode.PARTNER_NOT_FOUND
No partner exists with the supplied id.
Member Of
DepositAccountProductCreatePayloadError object
DepositAccountProductSortBy
No description
enum DepositAccountProductSortBy {
CREATED_AT
NAME
}
Values
DepositAccountProductSortBy.CREATED_AT
DepositAccountProductSortBy.NAME
Member Of
DepositAccountProductSort input
DepositAccountProductStatus
No description
enum DepositAccountProductStatus {
ACTIVE
NEW
RETIRED
}
Values
DepositAccountProductStatus.ACTIVE
DepositAccountProductStatus.NEW
DepositAccountProductStatus.RETIRED
Member Of
DepositAccountProduct object ● DepositAccountProductFilter input ● DepositAccountProductUpdateStatusInput input
DepositAccountProductType
No description
enum DepositAccountProductType {
NONINTEREST_BEARING_DEMAND
}
Values
DepositAccountProductType.NONINTEREST_BEARING_DEMAND
Member Of
DepositAccountProductAccountingConfig object ● DepositAccountProductCreateInput input ● DepositProductIntegration object ● DepositProductTypeIntegrationInput input
DepositAccountProductUpdateStatusErrorCode
No description
enum DepositAccountProductUpdateStatusErrorCode {
DEPOSIT_ACCOUNT_PRODUCT_NOT_FOUND
DEPOSIT_ACCOUNT_PRODUCT_RETIRED
}
Values
DepositAccountProductUpdateStatusErrorCode.DEPOSIT_ACCOUNT_PRODUCT_NOT_FOUND
No deposit account product exists with the supplied id.
DepositAccountProductUpdateStatusErrorCode.DEPOSIT_ACCOUNT_PRODUCT_RETIRED
The deposit account product is retired.
Member Of
DepositAccountProductUpdateStatusPayloadError object
DepositAccountProductUpdateTermsErrorCode
No description
enum DepositAccountProductUpdateTermsErrorCode {
DEPOSIT_ACCOUNT_PRODUCT_MAX_WITHDRAWAL_AMOUNT_PER_TRANSACTION_MUST_BE_POSITIVE
DEPOSIT_ACCOUNT_PRODUCT_NOT_FOUND
DEPOSIT_ACCOUNT_PRODUCT_RETIRED
DEPOSIT_ACCOUNT_PRODUCT_TERMS_CURRENCY_MISMATCH
DEPOSIT_ACCOUNT_PRODUCT_TERMS_VERSION_MISMATCH
MONEY_OVERFLOW
MONEY_UNSUPPORTED_CURRENCY
}
Values
DepositAccountProductUpdateTermsErrorCode.DEPOSIT_ACCOUNT_PRODUCT_MAX_WITHDRAWAL_AMOUNT_PER_TRANSACTION_MUST_BE_POSITIVE
The maximum withdrawal amount per transaction must be greater than zero.
DepositAccountProductUpdateTermsErrorCode.DEPOSIT_ACCOUNT_PRODUCT_NOT_FOUND
No deposit account product exists with the supplied id.
DepositAccountProductUpdateTermsErrorCode.DEPOSIT_ACCOUNT_PRODUCT_RETIRED
The deposit account product is retired.
DepositAccountProductUpdateTermsErrorCode.DEPOSIT_ACCOUNT_PRODUCT_TERMS_CURRENCY_MISMATCH
The product terms use a different currency than the product.
DepositAccountProductUpdateTermsErrorCode.DEPOSIT_ACCOUNT_PRODUCT_TERMS_VERSION_MISMATCH
The product terms were changed since the supplied version.
DepositAccountProductUpdateTermsErrorCode.MONEY_OVERFLOW
The amount exceeds the maximum supported value.
DepositAccountProductUpdateTermsErrorCode.MONEY_UNSUPPORTED_CURRENCY
The amount uses an unsupported currency.
Member Of
DepositAccountProductUpdateTermsPayloadError object
DepositAccountSortBy
No description
enum DepositAccountSortBy {
CREATED_AT
PUBLIC_ID
}
Values
DepositAccountSortBy.CREATED_AT
DepositAccountSortBy.PUBLIC_ID
Member Of
DepositAccountSort input
DepositAccountStatus
No description
enum DepositAccountStatus {
ACTIVE
CLOSED
FROZEN
}
Values
DepositAccountStatus.ACTIVE
DepositAccountStatus.CLOSED
DepositAccountStatus.FROZEN
Member Of
DepositAccount object ● DepositAccountFilter input
DepositAccountUnfreezeErrorCode
No description
enum DepositAccountUnfreezeErrorCode {
CUSTOMER_IS_CLOSED
CUSTOMER_IS_FROZEN
DEPOSIT_ACCOUNT_CLOSED
DEPOSIT_ACCOUNT_NOT_FOUND
}
Values
DepositAccountUnfreezeErrorCode.CUSTOMER_IS_CLOSED
the customer is closed
DepositAccountUnfreezeErrorCode.CUSTOMER_IS_FROZEN
the customer is frozen
DepositAccountUnfreezeErrorCode.DEPOSIT_ACCOUNT_CLOSED
The deposit account is closed.
DepositAccountUnfreezeErrorCode.DEPOSIT_ACCOUNT_NOT_FOUND
No deposit account exists with the supplied id.
Member Of
DepositAccountUnfreezePayloadError object
DepositCurrencyCategory
No description
enum DepositCurrencyCategory {
FUNCTIONAL
NON_FUNCTIONAL
}
Values
DepositCurrencyCategory.FUNCTIONAL
DepositCurrencyCategory.NON_FUNCTIONAL
Member Of
DepositAccountProductAccountingConfig object
DepositCurrencyPolicyConfigureErrorCode
No description
enum DepositCurrencyPolicyConfigureErrorCode {
DEPOSIT_CURRENCY_POLICY_FUNCTIONAL_CURRENCY_IN_ADDITIONAL_SUPPORTED
DEPOSIT_CURRENCY_POLICY_FUNCTIONAL_CURRENCY_MISMATCH
DEPOSIT_CURRENCY_POLICY_SUPPORTED_CURRENCY_REMOVED
MONEY_UNSUPPORTED_CURRENCY
}
Values
DepositCurrencyPolicyConfigureErrorCode.DEPOSIT_CURRENCY_POLICY_FUNCTIONAL_CURRENCY_IN_ADDITIONAL_SUPPORTED
The functional currency is already supported and must not be listed again.
DepositCurrencyPolicyConfigureErrorCode.DEPOSIT_CURRENCY_POLICY_FUNCTIONAL_CURRENCY_MISMATCH
The functional currency cannot be changed after configuration.
DepositCurrencyPolicyConfigureErrorCode.DEPOSIT_CURRENCY_POLICY_SUPPORTED_CURRENCY_REMOVED
An existing supported currency cannot be removed.
DepositCurrencyPolicyConfigureErrorCode.MONEY_UNSUPPORTED_CURRENCY
The amount uses an unsupported currency.
Member Of
DepositCurrencyPolicyConfigurePayloadError object
DepositRevertErrorCode
No description
enum DepositRevertErrorCode {
DEPOSIT_ACCOUNT_CLOSED
DEPOSIT_ACCOUNT_FROZEN
DEPOSIT_INSUFFICIENT_FUNDS
DEPOSIT_NOT_CONFIRMED
DEPOSIT_NOT_FOUND
}
Values
DepositRevertErrorCode.DEPOSIT_ACCOUNT_CLOSED
The deposit account is closed.
DepositRevertErrorCode.DEPOSIT_ACCOUNT_FROZEN
The deposit account is frozen.
DepositRevertErrorCode.DEPOSIT_INSUFFICIENT_FUNDS
The deposit account does not hold enough funds for the operation.
DepositRevertErrorCode.DEPOSIT_NOT_CONFIRMED
Only a confirmed deposit can be reverted.
DepositRevertErrorCode.DEPOSIT_NOT_FOUND
No deposit exists with the supplied id.
Member Of
DepositRevertPayloadError object
DepositSortBy
No description
enum DepositSortBy {
AMOUNT
CREATED_AT
PUBLIC_ID
}
Values
DepositSortBy.AMOUNT
DepositSortBy.CREATED_AT
DepositSortBy.PUBLIC_ID
Member Of
DepositSort input
DepositStatus
No description
enum DepositStatus {
CANCELLED
CONFIRMED
PENDING
REVERTED
}
Values
DepositStatus.CANCELLED
DepositStatus.CONFIRMED
DepositStatus.PENDING
DepositStatus.REVERTED
Member Of
Deposit object ● DepositFilter input
DisbursalPolicy
No description
enum DisbursalPolicy {
MULTIPLE_DISBURSAL
SINGLE_DISBURSAL
}
Values
DisbursalPolicy.MULTIPLE_DISBURSAL
DisbursalPolicy.SINGLE_DISBURSAL
Member Of
CreditFacilityTermsAlteration object ● CreditFacilityTermsAlterationsInput input ● TermsInput input ● TermValues object
DisbursalSortBy
No description
enum DisbursalSortBy {
CREATED_AT
}
Values
DisbursalSortBy.CREATED_AT
Member Of
DisbursalSort input
DisbursalStatus
No description
enum DisbursalStatus {
APPROVED
DENIED
NEW
SETTLED
}
Values
DisbursalStatus.APPROVED
DisbursalStatus.DENIED
DisbursalStatus.NEW
DisbursalStatus.SETTLED
Member Of
CreditFacilityDisbursal object ● DisbursalFilter input
DocumentStatus
No description
enum DocumentStatus {
ACTIVE
ARCHIVED
DELETED
DELETION_REQUESTED
FAILED
NEW
}
Values
DocumentStatus.ACTIVE
DocumentStatus.ARCHIVED
DocumentStatus.DELETED
DocumentStatus.DELETION_REQUESTED
DocumentStatus.FAILED
DocumentStatus.NEW
Member Of
CustomerDocument object ● LedgerAccountCsvDocument object
DomainConfigUpdateErrorCode
No description
enum DomainConfigUpdateErrorCode {
DOMAIN_CONFIG_INVALID_INPUT
DOMAIN_CONFIG_NOT_EXPOSED
DOMAIN_CONFIG_NOT_FOUND
DOMAIN_CONFIG_UNPARSEABLE_VALUE
DOMAIN_CONFIG_WRONG_VALUE_TYPE
}
Values
DomainConfigUpdateErrorCode.DOMAIN_CONFIG_INVALID_INPUT
The supplied configuration value violates its validation rules.
DomainConfigUpdateErrorCode.DOMAIN_CONFIG_NOT_EXPOSED
This configuration cannot be updated through the exposed configuration API.
DomainConfigUpdateErrorCode.DOMAIN_CONFIG_NOT_FOUND
The configuration no longer exists.
DomainConfigUpdateErrorCode.DOMAIN_CONFIG_UNPARSEABLE_VALUE
The supplied configuration value cannot be parsed as the required type.
DomainConfigUpdateErrorCode.DOMAIN_CONFIG_WRONG_VALUE_TYPE
The supplied configuration value has the wrong JSON type.
Member Of
DomainConfigUpdatePayloadError object
DwQueryExportFormat
No description
enum DwQueryExportFormat {
CSV
CSV_GZ
}
Values
DwQueryExportFormat.CSV
Plain CSV.
DwQueryExportFormat.CSV_GZ
CSV compressed with gzip (several times smaller for repetitive rows).
Member Of
DwReadonlyQueryExportLinkGenerateInput input
EodPhaseExecutionStatus
No description
enum EodPhaseExecutionStatus {
COMPLETED
FAILED
IN_PROGRESS
PENDING
}
Values
EodPhaseExecutionStatus.COMPLETED
EodPhaseExecutionStatus.FAILED
EodPhaseExecutionStatus.IN_PROGRESS
EodPhaseExecutionStatus.PENDING
Member Of
EodProcessPhase object
EodProcessRestartErrorCode
No description
enum EodProcessRestartErrorCode {
EOD_PROCESS_NOT_FOUND
EOD_PROCESS_NOT_STOPPED
}
Values
EodProcessRestartErrorCode.EOD_PROCESS_NOT_FOUND
No EOD process exists with the supplied ID.
EodProcessRestartErrorCode.EOD_PROCESS_NOT_STOPPED
Only a stopped EOD process can be restarted.
Member Of
EodProcessRestartPayloadError object
EodProcessSortBy
No description
enum EodProcessSortBy {
DAY
STATUS
}
Values
EodProcessSortBy.DAY
EodProcessSortBy.STATUS
Member Of
EodProcessSort input
EodProcessStatus
No description
enum EodProcessStatus {
COMPLETED
INITIALIZED
IN_PROGRESS
STOPPED
}
Values
EodProcessStatus.COMPLETED
EodProcessStatus.INITIALIZED
EodProcessStatus.IN_PROGRESS
EodProcessStatus.STOPPED
Member Of
EodProcess object ● EodProcessFilter input ● Time object
ExchangeAccountingIntegrationConfigureErrorCode
No description
enum ExchangeAccountingIntegrationConfigureErrorCode {
CHART_LOOKUP_INVALID_ACCOUNT_CATEGORY
CHART_OF_ACCOUNTS_BASE_CONFIG_NOT_INITIALIZED
EXCHANGE_ACCOUNTING_INTEGRATION_INCOMPATIBLE_RECONFIGURATION
}
Values
ExchangeAccountingIntegrationConfigureErrorCode.CHART_LOOKUP_INVALID_ACCOUNT_CATEGORY
Account code does not belong to the required category.
ExchangeAccountingIntegrationConfigureErrorCode.CHART_OF_ACCOUNTS_BASE_CONFIG_NOT_INITIALIZED
The chart base configuration has not been initialized.
ExchangeAccountingIntegrationConfigureErrorCode.EXCHANGE_ACCOUNTING_INTEGRATION_INCOMPATIBLE_RECONFIGURATION
An existing exchange accounting integration cannot be changed.
Member Of
ExchangeAccountingIntegrationConfigurePayloadError object
ExchangeRateProviderActivateErrorCode
No description
enum ExchangeRateProviderActivateErrorCode {
PRICE_PROVIDER_NOT_FOUND
}
Values
ExchangeRateProviderActivateErrorCode.PRICE_PROVIDER_NOT_FOUND
No price provider exists with the supplied ID.
Member Of
ExchangeRateProviderActivatePayloadError object
ExchangeRateProviderDeactivateErrorCode
No description
enum ExchangeRateProviderDeactivateErrorCode {
PRICE_PROVIDER_NOT_FOUND
}
Values
ExchangeRateProviderDeactivateErrorCode.PRICE_PROVIDER_NOT_FOUND
No price provider exists with the supplied ID.
Member Of
ExchangeRateProviderDeactivatePayloadError object
ExchangeRateProviderManualExchangeRateUpdateErrorCode
No description
enum ExchangeRateProviderManualExchangeRateUpdateErrorCode {
MONEY_CURRENCY_MISMATCH
MONEY_OVERFLOW
MONEY_UNSUPPORTED_CURRENCY
PRICE_EXCHANGE_RATE_ZERO
PRICE_PROVIDER_NOT_FOUND
}
Values
ExchangeRateProviderManualExchangeRateUpdateErrorCode.MONEY_CURRENCY_MISMATCH
The amount uses a different currency than expected.
ExchangeRateProviderManualExchangeRateUpdateErrorCode.MONEY_OVERFLOW
The amount exceeds the maximum supported value.
ExchangeRateProviderManualExchangeRateUpdateErrorCode.MONEY_UNSUPPORTED_CURRENCY
The amount uses an unsupported currency.
ExchangeRateProviderManualExchangeRateUpdateErrorCode.PRICE_EXCHANGE_RATE_ZERO
The exchange rate must be non-zero.
ExchangeRateProviderManualExchangeRateUpdateErrorCode.PRICE_PROVIDER_NOT_FOUND
No price provider exists with the supplied ID.
Member Of
ExchangeRateProviderManualExchangeRateUpdatePayloadError object
ExchangeRateProviderSortBy
No description
enum ExchangeRateProviderSortBy {
CREATED_AT
NAME
}
Values
ExchangeRateProviderSortBy.CREATED_AT
ExchangeRateProviderSortBy.NAME
Member Of
ExchangeRateProviderSort input
FiscalYearCloseErrorCode
No description
enum FiscalYearCloseErrorCode {
CHART_OF_ACCOUNTS_BASE_CONFIG_NOT_INITIALIZED
FISCAL_YEAR_NOT_FOUND
}
Values
FiscalYearCloseErrorCode.CHART_OF_ACCOUNTS_BASE_CONFIG_NOT_INITIALIZED
The chart base configuration has not been initialized.
FiscalYearCloseErrorCode.FISCAL_YEAR_NOT_FOUND
Fiscal year not found.
Member Of
FiscalYearClosePayloadError object
FiscalYearCloseMonthErrorCode
No description
enum FiscalYearCloseMonthErrorCode {
FISCAL_YEAR_MONTH_HAS_NOT_ENDED
FISCAL_YEAR_NOT_FOUND
OPEN_FISCAL_YEAR_ALREADY_EXISTS
PAST_FISCAL_YEAR_ALREADY_EXISTS
}
Values
FiscalYearCloseMonthErrorCode.FISCAL_YEAR_MONTH_HAS_NOT_ENDED
Fiscal month has not ended.
FiscalYearCloseMonthErrorCode.FISCAL_YEAR_NOT_FOUND
Fiscal year not found.
FiscalYearCloseMonthErrorCode.OPEN_FISCAL_YEAR_ALREADY_EXISTS
An open fiscal year already exists.
FiscalYearCloseMonthErrorCode.PAST_FISCAL_YEAR_ALREADY_EXISTS
A past fiscal year is already adjusting.
Member Of
FiscalYearCloseMonthPayloadError object
FiscalYearInitErrorCode
No description
enum FiscalYearInitErrorCode {
CHART_OF_ACCOUNTS_NOT_FOUND_BY_REFERENCE
FISCAL_YEAR_ALREADY_INITIALIZED
FISCAL_YEAR_OPENED_AS_OF_IN_FUTURE
}
Values
FiscalYearInitErrorCode.CHART_OF_ACCOUNTS_NOT_FOUND_BY_REFERENCE
No chart exists with the supplied reference.
FiscalYearInitErrorCode.FISCAL_YEAR_ALREADY_INITIALIZED
Fiscal year already initialized with a different opening date.
FiscalYearInitErrorCode.FISCAL_YEAR_OPENED_AS_OF_IN_FUTURE
Fiscal year opening date is in the future.
Member Of
FiscalYearInitPayloadError object
FiscalYearSortBy
No description
enum FiscalYearSortBy {
CREATED_AT
OPENED_AS_OF
}
Values
FiscalYearSortBy.CREATED_AT
FiscalYearSortBy.OPENED_AS_OF
Member Of
FiscalYearSort input
FiscalYearStatus
No description
enum FiscalYearStatus {
ADJUSTING
CLOSED
OPEN
}
Values
FiscalYearStatus.ADJUSTING
FiscalYearStatus.CLOSED
FiscalYearStatus.OPEN
Member Of
FiscalYear object
Freshness
No description
enum Freshness {
FRESH
STALE
UNKNOWN
}
Values
Freshness.FRESH
Freshness.STALE
Freshness.UNKNOWN
Member Of
ExchangeRate object
FxCurrencyPolicyConfigureErrorCode
No description
enum FxCurrencyPolicyConfigureErrorCode {
FX_CURRENCY_POLICY_FUNCTIONAL_CURRENCY_MISMATCH
FX_CURRENCY_POLICY_SUPPORTED_CURRENCIES_REQUIRED
FX_CURRENCY_POLICY_SUPPORTED_CURRENCY_REMOVED
MONEY_UNSUPPORTED_CURRENCY
}
Values
FxCurrencyPolicyConfigureErrorCode.FX_CURRENCY_POLICY_FUNCTIONAL_CURRENCY_MISMATCH
The functional currency cannot be changed after configuration.
FxCurrencyPolicyConfigureErrorCode.FX_CURRENCY_POLICY_SUPPORTED_CURRENCIES_REQUIRED
At least one supported currency is required.
FxCurrencyPolicyConfigureErrorCode.FX_CURRENCY_POLICY_SUPPORTED_CURRENCY_REMOVED
An existing supported currency cannot be removed.
FxCurrencyPolicyConfigureErrorCode.MONEY_UNSUPPORTED_CURRENCY
The amount uses an unsupported currency.
Member Of
FxCurrencyPolicyConfigurePayloadError object
FxModuleConfigureErrorCode
No description
enum FxModuleConfigureErrorCode {
CHART_LOOKUP_INVALID_ACCOUNT_CATEGORY
CHART_OF_ACCOUNTS_BASE_CONFIG_NOT_INITIALIZED
FX_ACCOUNTING_CONFIG_ALREADY_SET
}
Values
FxModuleConfigureErrorCode.CHART_LOOKUP_INVALID_ACCOUNT_CATEGORY
Account code does not belong to the required category.
FxModuleConfigureErrorCode.CHART_OF_ACCOUNTS_BASE_CONFIG_NOT_INITIALIZED
The chart base configuration has not been initialized.
FxModuleConfigureErrorCode.FX_ACCOUNTING_CONFIG_ALREADY_SET
The fx chart of accounts integration has already been configured.
Member Of
FxModuleConfigurePayloadError object
InboundCreditTiming
When a cleared inbound payment may be booked as a customer credit.
A product bookkeeping choice, not a statement about interbank finality:
AtClearing books the credit once the receipt clears, AtSettlement waits
for settlement. A credit already booked is not automatically reversed by a
later provider failure or cancellation; any required adjustment is explicit
and separate.
enum InboundCreditTiming {
AT_CLEARING
AT_SETTLEMENT
}
Values
InboundCreditTiming.AT_CLEARING
Book when the provider clears the payment; settlement is a no-op for the deposit.
InboundCreditTiming.AT_SETTLEMENT
Wait for settlement before booking; clearing only claims the receipt.
Member Of
Rail object ● RailCreateInput input
IndividualPartyCreateErrorCode
No description
enum IndividualPartyCreateErrorCode {
EMAIL_INVALID_DOMAIN
EMAIL_LENGTH
EMAIL_NON_ASCII
EMAIL_QUOTED_LOCAL_PART
EMAIL_SYNTAX
EMAIL_UNKNOWN_PUBLIC_SUFFIX
PARTY_DATE_OF_BIRTH_IN_FUTURE
PARTY_EMAIL_ALREADY_EXISTS
PARTY_FIRST_AND_LAST_NAME_REQUIRED
}
Values
IndividualPartyCreateErrorCode.EMAIL_INVALID_DOMAIN
email address domain is not valid
IndividualPartyCreateErrorCode.EMAIL_LENGTH
email address is empty or exceeds 254 characters
IndividualPartyCreateErrorCode.EMAIL_NON_ASCII
email address contains non-ASCII characters
IndividualPartyCreateErrorCode.EMAIL_QUOTED_LOCAL_PART
email address has a quoted local part
IndividualPartyCreateErrorCode.EMAIL_SYNTAX
email address is malformed
IndividualPartyCreateErrorCode.EMAIL_UNKNOWN_PUBLIC_SUFFIX
email address domain does not end in a known public suffix
IndividualPartyCreateErrorCode.PARTY_DATE_OF_BIRTH_IN_FUTURE
the date of birth cannot be in the future
IndividualPartyCreateErrorCode.PARTY_EMAIL_ALREADY_EXISTS
another party already uses this email
IndividualPartyCreateErrorCode.PARTY_FIRST_AND_LAST_NAME_REQUIRED
both a first and a last name are required
Member Of
IndividualPartyCreatePayloadError object
IndividualPartyEmailUpdateErrorCode
No description
enum IndividualPartyEmailUpdateErrorCode {
EMAIL_INVALID_DOMAIN
EMAIL_LENGTH
EMAIL_NON_ASCII
EMAIL_QUOTED_LOCAL_PART
EMAIL_SYNTAX
EMAIL_UNKNOWN_PUBLIC_SUFFIX
PARTY_EMAIL_ALREADY_EXISTS
PARTY_INDIVIDUAL_NOT_FOUND
}
Values
IndividualPartyEmailUpdateErrorCode.EMAIL_INVALID_DOMAIN
email address domain is not valid
IndividualPartyEmailUpdateErrorCode.EMAIL_LENGTH
email address is empty or exceeds 254 characters
IndividualPartyEmailUpdateErrorCode.EMAIL_NON_ASCII
email address contains non-ASCII characters
IndividualPartyEmailUpdateErrorCode.EMAIL_QUOTED_LOCAL_PART
email address has a quoted local part
IndividualPartyEmailUpdateErrorCode.EMAIL_SYNTAX
email address is malformed
IndividualPartyEmailUpdateErrorCode.EMAIL_UNKNOWN_PUBLIC_SUFFIX
email address domain does not end in a known public suffix
IndividualPartyEmailUpdateErrorCode.PARTY_EMAIL_ALREADY_EXISTS
another party already uses this email
IndividualPartyEmailUpdateErrorCode.PARTY_INDIVIDUAL_NOT_FOUND
individual party not found
Member Of
IndividualPartyEmailUpdatePayloadError object
IndividualPartyPersonalInfoUpdateErrorCode
No description
enum IndividualPartyPersonalInfoUpdateErrorCode {
PARTY_DATE_OF_BIRTH_IN_FUTURE
PARTY_FIRST_AND_LAST_NAME_REQUIRED
PARTY_INDIVIDUAL_NOT_FOUND
}
Values
IndividualPartyPersonalInfoUpdateErrorCode.PARTY_DATE_OF_BIRTH_IN_FUTURE
the date of birth cannot be in the future
IndividualPartyPersonalInfoUpdateErrorCode.PARTY_FIRST_AND_LAST_NAME_REQUIRED
both a first and a last name are required
IndividualPartyPersonalInfoUpdateErrorCode.PARTY_INDIVIDUAL_NOT_FOUND
individual party not found
Member Of
IndividualPartyPersonalInfoUpdatePayloadError object
InterestInterval
No description
enum InterestInterval {
END_OF_DAY
END_OF_MONTH
}
Values
InterestInterval.END_OF_DAY
InterestInterval.END_OF_MONTH
Member Of
CreditFacilityTermsAlteration object ● CreditFacilityTermsAlterationsInput input ● TermsInput input ● TermValues object
KycLevel
No description
enum KycLevel {
ADVANCED
BASIC
NOT_KYCED
}
Values
KycLevel.ADVANCED
KycLevel.BASIC
KycLevel.NOT_KYCED
Member Of
Customer object ● Prospect object
KycProviderConfigUpdateErrorCode
No description
enum KycProviderConfigUpdateErrorCode {
KYC_PROVIDER_TYPE_MISMATCH
}
Values
KycProviderConfigUpdateErrorCode.KYC_PROVIDER_TYPE_MISMATCH
the config is for a different provider type than the provider
Member Of
KycProviderConfigUpdatePayloadError object
KycProviderCreateErrorCode
No description
enum KycProviderCreateErrorCode {
KYC_PROVIDER_ALREADY_EXISTS
KYC_PROVIDER_MANUAL_IS_SYSTEM_MANAGED
KYC_PROVIDER_NAME_ALREADY_EXISTS
}
Values
KycProviderCreateErrorCode.KYC_PROVIDER_ALREADY_EXISTS
a provider of this type already exists
KycProviderCreateErrorCode.KYC_PROVIDER_MANUAL_IS_SYSTEM_MANAGED
the manual provider is managed by the system and cannot be created
KycProviderCreateErrorCode.KYC_PROVIDER_NAME_ALREADY_EXISTS
another provider already uses this name
Member Of
KycProviderCreatePayloadError object
KycProviderSortBy
No description
enum KycProviderSortBy {
CREATED_AT
NAME
}
Values
KycProviderSortBy.CREATED_AT
KycProviderSortBy.NAME
Member Of
KycProviderSort input
KycStatus
No description
enum KycStatus {
APPROVED
DECLINED
NOT_STARTED
ON_HOLD
STARTED
}
Values
KycStatus.APPROVED
KycStatus.DECLINED
KycStatus.NOT_STARTED
KycStatus.ON_HOLD
KycStatus.STARTED
Member Of
Prospect object
Layer
No description
enum Layer {
ENCUMBRANCE
PENDING
SETTLED
}
Values
Layer.ENCUMBRANCE
Layer.PENDING
Layer.SETTLED
Member Of
LedgerEntry object
LedgerAccountCsvCreateErrorCode
No description
enum LedgerAccountCsvCreateErrorCode {
LEDGER_ACCOUNT_NOT_FOUND
}
Values
LedgerAccountCsvCreateErrorCode.LEDGER_ACCOUNT_NOT_FOUND
The requested ledger account does not exist.
Member Of
LedgerAccountCsvCreatePayloadError object
LedgerAccountCsvDownloadLinkGenerateErrorCode
No description
enum LedgerAccountCsvDownloadLinkGenerateErrorCode {
ACCOUNTING_CSV_DOCUMENT_NOT_FOUND
DOCUMENT_NOT_DOWNLOADABLE
}
Values
LedgerAccountCsvDownloadLinkGenerateErrorCode.ACCOUNTING_CSV_DOCUMENT_NOT_FOUND
The requested accounting CSV document does not exist.
LedgerAccountCsvDownloadLinkGenerateErrorCode.DOCUMENT_NOT_DOWNLOADABLE
Only an active document can be downloaded.
Member Of
LedgerAccountCsvDownloadLinkGeneratePayloadError object
LendingIntent
No description
enum LendingIntent {
HELD_FOR_INVESTMENT
HELD_FOR_SALE
}
Values
LendingIntent.HELD_FOR_INVESTMENT
LendingIntent.HELD_FOR_SALE
Member Of
CreditFacilityProductCreateInput input ● CreditFacilityProductLendingIntentAccounting object ● CreditLendingIntentIntegration object ● CreditLendingIntentIntegrationInput input
LiquidationSortBy
No description
enum LiquidationSortBy {
CREATED_AT
EXPECTED_TO_RECEIVE
NET_PROCEEDS
SENT_TOTAL
}
Values
LiquidationSortBy.CREATED_AT
LiquidationSortBy.EXPECTED_TO_RECEIVE
LiquidationSortBy.NET_PROCEEDS
LiquidationSortBy.SENT_TOTAL
Member Of
LiquidationSort input
ManualTransactionDraftCloseErrorCode
No description
enum ManualTransactionDraftCloseErrorCode {
MANUAL_TRANSACTION_DRAFT_CANNOT_CLOSE_NON_DRAFT
MANUAL_TRANSACTION_DRAFT_NOT_FOUND
}
Values
ManualTransactionDraftCloseErrorCode.MANUAL_TRANSACTION_DRAFT_CANNOT_CLOSE_NON_DRAFT
Only an open draft can be closed.
ManualTransactionDraftCloseErrorCode.MANUAL_TRANSACTION_DRAFT_NOT_FOUND
Manual transaction draft not found.
Member Of
ManualTransactionDraftClosePayloadError object
ManualTransactionDraftCreateErrorCode
No description
enum ManualTransactionDraftCreateErrorCode {
MANUAL_TRANSACTION_DESCRIPTION_TOO_LONG
MANUAL_TRANSACTION_ENTRY_DESCRIPTION_TOO_LONG
MANUAL_TRANSACTION_REFERENCE_TOO_LONG
}
Values
ManualTransactionDraftCreateErrorCode.MANUAL_TRANSACTION_DESCRIPTION_TOO_LONG
The transaction description is too long.
ManualTransactionDraftCreateErrorCode.MANUAL_TRANSACTION_ENTRY_DESCRIPTION_TOO_LONG
An entry description is too long.
ManualTransactionDraftCreateErrorCode.MANUAL_TRANSACTION_REFERENCE_TOO_LONG
The transaction reference is too long.
Member Of
ManualTransactionDraftCreatePayloadError object
ManualTransactionDraftPostErrorCode
No description
enum ManualTransactionDraftPostErrorCode {
CHART_OF_ACCOUNTS_CODE_NOT_FOUND_IN_CHART
CHART_OF_ACCOUNTS_NON_LEAF_ACCOUNT
CHART_OF_ACCOUNTS_NOT_FOUND_BY_REFERENCE
MANUAL_TRANSACTION_ACCOUNTING_PERIOD_CLOSED
MANUAL_TRANSACTION_DRAFT_CANNOT_POST_CLOSED_DRAFT
MANUAL_TRANSACTION_DRAFT_INCOMPLETE_ENTRIES
MANUAL_TRANSACTION_DRAFT_MISSING_EFFECTIVE_DATE
MANUAL_TRANSACTION_DRAFT_NOT_FOUND
MANUAL_TRANSACTION_EFFECTIVE_DATE_IN_FUTURE
MANUAL_TRANSACTION_ENTRY_AMOUNT_CANNOT_BE_ZERO
MANUAL_TRANSACTION_INSUFFICIENT_ENTRIES
MANUAL_TRANSACTION_REFERENCE_TAKEN
MANUAL_TRANSACTION_UNBALANCED
MONEY_OVERFLOW
MONEY_UNSUPPORTED_CURRENCY
}
Values
ManualTransactionDraftPostErrorCode.CHART_OF_ACCOUNTS_CODE_NOT_FOUND_IN_CHART
The account code does not exist in this chart.
ManualTransactionDraftPostErrorCode.CHART_OF_ACCOUNTS_NON_LEAF_ACCOUNT
Manual transactions require a leaf account.
ManualTransactionDraftPostErrorCode.CHART_OF_ACCOUNTS_NOT_FOUND_BY_REFERENCE
No chart exists with the supplied reference.
ManualTransactionDraftPostErrorCode.MANUAL_TRANSACTION_ACCOUNTING_PERIOD_CLOSED
Manual transaction effective date is in a closed accounting period.
ManualTransactionDraftPostErrorCode.MANUAL_TRANSACTION_DRAFT_CANNOT_POST_CLOSED_DRAFT
A closed draft cannot be posted.
ManualTransactionDraftPostErrorCode.MANUAL_TRANSACTION_DRAFT_INCOMPLETE_ENTRIES
All entry fields are required to post a draft.
ManualTransactionDraftPostErrorCode.MANUAL_TRANSACTION_DRAFT_MISSING_EFFECTIVE_DATE
An effective date is required to post a draft.
ManualTransactionDraftPostErrorCode.MANUAL_TRANSACTION_DRAFT_NOT_FOUND
Manual transaction draft not found.
ManualTransactionDraftPostErrorCode.MANUAL_TRANSACTION_EFFECTIVE_DATE_IN_FUTURE
The effective date must not be in the future.
ManualTransactionDraftPostErrorCode.MANUAL_TRANSACTION_ENTRY_AMOUNT_CANNOT_BE_ZERO
Entry amounts must be greater than zero.
ManualTransactionDraftPostErrorCode.MANUAL_TRANSACTION_INSUFFICIENT_ENTRIES
At least two entries are required.
ManualTransactionDraftPostErrorCode.MANUAL_TRANSACTION_REFERENCE_TAKEN
A manual transaction already uses this reference.
ManualTransactionDraftPostErrorCode.MANUAL_TRANSACTION_UNBALANCED
Manual transaction entries do not balance.
ManualTransactionDraftPostErrorCode.MONEY_OVERFLOW
The amount exceeds the maximum supported value.
ManualTransactionDraftPostErrorCode.MONEY_UNSUPPORTED_CURRENCY
The amount uses an unsupported currency.
Member Of
ManualTransactionDraftPostPayloadError object
ManualTransactionDraftStatus
No description
enum ManualTransactionDraftStatus {
CLOSED
DRAFT
POSTED
}
Values
ManualTransactionDraftStatus.CLOSED
ManualTransactionDraftStatus.DRAFT
ManualTransactionDraftStatus.POSTED
Member Of
ManualTransactionDraft object ● ManualTransactionDraftFilter input
ManualTransactionDraftUpdateErrorCode
No description
enum ManualTransactionDraftUpdateErrorCode {
MANUAL_TRANSACTION_DESCRIPTION_TOO_LONG
MANUAL_TRANSACTION_DRAFT_CANNOT_UPDATE_NON_DRAFT
MANUAL_TRANSACTION_DRAFT_NOT_FOUND
MANUAL_TRANSACTION_ENTRY_DESCRIPTION_TOO_LONG
MANUAL_TRANSACTION_REFERENCE_TOO_LONG
}
Values
ManualTransactionDraftUpdateErrorCode.MANUAL_TRANSACTION_DESCRIPTION_TOO_LONG
The transaction description is too long.
ManualTransactionDraftUpdateErrorCode.MANUAL_TRANSACTION_DRAFT_CANNOT_UPDATE_NON_DRAFT
Only an open draft can be updated.
ManualTransactionDraftUpdateErrorCode.MANUAL_TRANSACTION_DRAFT_NOT_FOUND
Manual transaction draft not found.
ManualTransactionDraftUpdateErrorCode.MANUAL_TRANSACTION_ENTRY_DESCRIPTION_TOO_LONG
An entry description is too long.
ManualTransactionDraftUpdateErrorCode.MANUAL_TRANSACTION_REFERENCE_TOO_LONG
The transaction reference is too long.
Member Of
ManualTransactionDraftUpdatePayloadError object
ManualTransactionPostErrorCode
No description
enum ManualTransactionPostErrorCode {
CHART_OF_ACCOUNTS_CODE_NOT_FOUND_IN_CHART
CHART_OF_ACCOUNTS_NON_LEAF_ACCOUNT
CHART_OF_ACCOUNTS_NOT_FOUND_BY_REFERENCE
MANUAL_TRANSACTION_ACCOUNTING_PERIOD_CLOSED
MANUAL_TRANSACTION_DESCRIPTION_TOO_LONG
MANUAL_TRANSACTION_EFFECTIVE_DATE_IN_FUTURE
MANUAL_TRANSACTION_ENTRY_AMOUNT_CANNOT_BE_ZERO
MANUAL_TRANSACTION_ENTRY_DESCRIPTION_TOO_LONG
MANUAL_TRANSACTION_INSUFFICIENT_ENTRIES
MANUAL_TRANSACTION_REFERENCE_TAKEN
MANUAL_TRANSACTION_REFERENCE_TOO_LONG
MANUAL_TRANSACTION_UNBALANCED
MONEY_OVERFLOW
MONEY_UNSUPPORTED_CURRENCY
}
Values
ManualTransactionPostErrorCode.CHART_OF_ACCOUNTS_CODE_NOT_FOUND_IN_CHART
The account code does not exist in this chart.
ManualTransactionPostErrorCode.CHART_OF_ACCOUNTS_NON_LEAF_ACCOUNT
Manual transactions require a leaf account.
ManualTransactionPostErrorCode.CHART_OF_ACCOUNTS_NOT_FOUND_BY_REFERENCE
No chart exists with the supplied reference.
ManualTransactionPostErrorCode.MANUAL_TRANSACTION_ACCOUNTING_PERIOD_CLOSED
Manual transaction effective date is in a closed accounting period.
ManualTransactionPostErrorCode.MANUAL_TRANSACTION_DESCRIPTION_TOO_LONG
The transaction description is too long.
ManualTransactionPostErrorCode.MANUAL_TRANSACTION_EFFECTIVE_DATE_IN_FUTURE
The effective date must not be in the future.
ManualTransactionPostErrorCode.MANUAL_TRANSACTION_ENTRY_AMOUNT_CANNOT_BE_ZERO
Entry amounts must be greater than zero.
ManualTransactionPostErrorCode.MANUAL_TRANSACTION_ENTRY_DESCRIPTION_TOO_LONG
An entry description is too long.
ManualTransactionPostErrorCode.MANUAL_TRANSACTION_INSUFFICIENT_ENTRIES
At least two entries are required.
ManualTransactionPostErrorCode.MANUAL_TRANSACTION_REFERENCE_TAKEN
A manual transaction already uses this reference.
ManualTransactionPostErrorCode.MANUAL_TRANSACTION_REFERENCE_TOO_LONG
The transaction reference is too long.
ManualTransactionPostErrorCode.MANUAL_TRANSACTION_UNBALANCED
Manual transaction entries do not balance.
ManualTransactionPostErrorCode.MONEY_OVERFLOW
The amount exceeds the maximum supported value.
ManualTransactionPostErrorCode.MONEY_UNSUPPORTED_CURRENCY
The amount uses an unsupported currency.
Member Of
ManualTransactionPostPayloadError object
ManualTransactionValidateErrorCode
No description
enum ManualTransactionValidateErrorCode {
CHART_OF_ACCOUNTS_CODE_NOT_FOUND_IN_CHART
CHART_OF_ACCOUNTS_NON_LEAF_ACCOUNT
CHART_OF_ACCOUNTS_NOT_FOUND_BY_REFERENCE
MANUAL_TRANSACTION_ACCOUNTING_PERIOD_CLOSED
MANUAL_TRANSACTION_DESCRIPTION_TOO_LONG
MANUAL_TRANSACTION_EFFECTIVE_DATE_IN_FUTURE
MANUAL_TRANSACTION_ENTRY_AMOUNT_CANNOT_BE_ZERO
MANUAL_TRANSACTION_ENTRY_DESCRIPTION_TOO_LONG
MANUAL_TRANSACTION_INSUFFICIENT_ENTRIES
MANUAL_TRANSACTION_REFERENCE_TAKEN
MANUAL_TRANSACTION_REFERENCE_TOO_LONG
MANUAL_TRANSACTION_UNBALANCED
MONEY_OVERFLOW
MONEY_UNSUPPORTED_CURRENCY
}
Values
ManualTransactionValidateErrorCode.CHART_OF_ACCOUNTS_CODE_NOT_FOUND_IN_CHART
The account code does not exist in this chart.
ManualTransactionValidateErrorCode.CHART_OF_ACCOUNTS_NON_LEAF_ACCOUNT
Manual transactions require a leaf account.
ManualTransactionValidateErrorCode.CHART_OF_ACCOUNTS_NOT_FOUND_BY_REFERENCE
No chart exists with the supplied reference.
ManualTransactionValidateErrorCode.MANUAL_TRANSACTION_ACCOUNTING_PERIOD_CLOSED
Manual transaction effective date is in a closed accounting period.
ManualTransactionValidateErrorCode.MANUAL_TRANSACTION_DESCRIPTION_TOO_LONG
The transaction description is too long.
ManualTransactionValidateErrorCode.MANUAL_TRANSACTION_EFFECTIVE_DATE_IN_FUTURE
The effective date must not be in the future.
ManualTransactionValidateErrorCode.MANUAL_TRANSACTION_ENTRY_AMOUNT_CANNOT_BE_ZERO
Entry amounts must be greater than zero.
ManualTransactionValidateErrorCode.MANUAL_TRANSACTION_ENTRY_DESCRIPTION_TOO_LONG
An entry description is too long.
ManualTransactionValidateErrorCode.MANUAL_TRANSACTION_INSUFFICIENT_ENTRIES
At least two entries are required.
ManualTransactionValidateErrorCode.MANUAL_TRANSACTION_REFERENCE_TAKEN
A manual transaction already uses this reference.
ManualTransactionValidateErrorCode.MANUAL_TRANSACTION_REFERENCE_TOO_LONG
The transaction reference is too long.
ManualTransactionValidateErrorCode.MANUAL_TRANSACTION_UNBALANCED
Manual transaction entries do not balance.
ManualTransactionValidateErrorCode.MONEY_OVERFLOW
The amount exceeds the maximum supported value.
ManualTransactionValidateErrorCode.MONEY_UNSUPPORTED_CURRENCY
The amount uses an unsupported currency.
Member Of
ManualTransactionValidatePayloadError object
NotificationProviderConfigUpdateErrorCode
No description
enum NotificationProviderConfigUpdateErrorCode {
NOTIFICATION_PROVIDER_CONFIG_FROM_EMAIL_INVALID
NOTIFICATION_PROVIDER_CONFIG_FROM_NAME_CONTROL_CHARACTERS
NOTIFICATION_PROVIDER_CONFIG_FROM_NAME_REQUIRED
NOTIFICATION_PROVIDER_CONFIG_FROM_NAME_TOO_LONG
NOTIFICATION_PROVIDER_CONFIG_PASSWORD_REQUIRED
NOTIFICATION_PROVIDER_CONFIG_PORT_REQUIRED
NOTIFICATION_PROVIDER_CONFIG_RELAY_NOT_ALLOWED
NOTIFICATION_PROVIDER_CONFIG_RELAY_REQUIRED
NOTIFICATION_PROVIDER_CONFIG_USERNAME_REQUIRED
NOTIFICATION_PROVIDER_NOT_FOUND
NOTIFICATION_PROVIDER_TYPE_MISMATCH
}
Values
NotificationProviderConfigUpdateErrorCode.NOTIFICATION_PROVIDER_CONFIG_FROM_EMAIL_INVALID
The sender email address is invalid.
NotificationProviderConfigUpdateErrorCode.NOTIFICATION_PROVIDER_CONFIG_FROM_NAME_CONTROL_CHARACTERS
The sender name must not contain control characters.
NotificationProviderConfigUpdateErrorCode.NOTIFICATION_PROVIDER_CONFIG_FROM_NAME_REQUIRED
The sender name is required.
NotificationProviderConfigUpdateErrorCode.NOTIFICATION_PROVIDER_CONFIG_FROM_NAME_TOO_LONG
The sender name is too long.
NotificationProviderConfigUpdateErrorCode.NOTIFICATION_PROVIDER_CONFIG_PASSWORD_REQUIRED
The SMTP password is required unless the connection is insecure.
NotificationProviderConfigUpdateErrorCode.NOTIFICATION_PROVIDER_CONFIG_PORT_REQUIRED
The SMTP port is required.
NotificationProviderConfigUpdateErrorCode.NOTIFICATION_PROVIDER_CONFIG_RELAY_NOT_ALLOWED
The SMTP relay and port are not allowed.
NotificationProviderConfigUpdateErrorCode.NOTIFICATION_PROVIDER_CONFIG_RELAY_REQUIRED
The SMTP relay is required.
NotificationProviderConfigUpdateErrorCode.NOTIFICATION_PROVIDER_CONFIG_USERNAME_REQUIRED
The SMTP username is required unless the connection is insecure.
NotificationProviderConfigUpdateErrorCode.NOTIFICATION_PROVIDER_NOT_FOUND
No notification provider exists with the supplied id.
NotificationProviderConfigUpdateErrorCode.NOTIFICATION_PROVIDER_TYPE_MISMATCH
A notification provider's type cannot be changed.
Member Of
NotificationProviderConfigUpdatePayloadError object
NotificationProviderCreateErrorCode
No description
enum NotificationProviderCreateErrorCode {
NOTIFICATION_PROVIDER_ALREADY_EXISTS
NOTIFICATION_PROVIDER_CONFIG_FROM_EMAIL_INVALID
NOTIFICATION_PROVIDER_CONFIG_FROM_NAME_CONTROL_CHARACTERS
NOTIFICATION_PROVIDER_CONFIG_FROM_NAME_REQUIRED
NOTIFICATION_PROVIDER_CONFIG_FROM_NAME_TOO_LONG
NOTIFICATION_PROVIDER_CONFIG_PASSWORD_REQUIRED
NOTIFICATION_PROVIDER_CONFIG_PORT_REQUIRED
NOTIFICATION_PROVIDER_CONFIG_RELAY_NOT_ALLOWED
NOTIFICATION_PROVIDER_CONFIG_RELAY_REQUIRED
NOTIFICATION_PROVIDER_CONFIG_USERNAME_REQUIRED
NOTIFICATION_PROVIDER_NAME_TAKEN
}
Values
NotificationProviderCreateErrorCode.NOTIFICATION_PROVIDER_ALREADY_EXISTS
A notification provider of this kind already exists.
NotificationProviderCreateErrorCode.NOTIFICATION_PROVIDER_CONFIG_FROM_EMAIL_INVALID
The sender email address is invalid.
NotificationProviderCreateErrorCode.NOTIFICATION_PROVIDER_CONFIG_FROM_NAME_CONTROL_CHARACTERS
The sender name must not contain control characters.
NotificationProviderCreateErrorCode.NOTIFICATION_PROVIDER_CONFIG_FROM_NAME_REQUIRED
The sender name is required.
NotificationProviderCreateErrorCode.NOTIFICATION_PROVIDER_CONFIG_FROM_NAME_TOO_LONG
The sender name is too long.
NotificationProviderCreateErrorCode.NOTIFICATION_PROVIDER_CONFIG_PASSWORD_REQUIRED
The SMTP password is required unless the connection is insecure.
NotificationProviderCreateErrorCode.NOTIFICATION_PROVIDER_CONFIG_PORT_REQUIRED
The SMTP port is required.
NotificationProviderCreateErrorCode.NOTIFICATION_PROVIDER_CONFIG_RELAY_NOT_ALLOWED
The SMTP relay and port are not allowed.
NotificationProviderCreateErrorCode.NOTIFICATION_PROVIDER_CONFIG_RELAY_REQUIRED
The SMTP relay is required.
NotificationProviderCreateErrorCode.NOTIFICATION_PROVIDER_CONFIG_USERNAME_REQUIRED
The SMTP username is required unless the connection is insecure.
NotificationProviderCreateErrorCode.NOTIFICATION_PROVIDER_NAME_TAKEN
Another notification provider already uses this name.
Member Of
NotificationProviderCreatePayloadError object
NotificationProviderKind
No description
enum NotificationProviderKind {
SMTP
}
Values
NotificationProviderKind.SMTP
Member Of
NotificationProvider object
NotificationProviderSortBy
No description
enum NotificationProviderSortBy {
CREATED_AT
NAME
}
Values
NotificationProviderSortBy.CREATED_AT
NotificationProviderSortBy.NAME
Member Of
NotificationProviderSort input
ObligationSortBy
No description
enum ObligationSortBy {
CREATED_AT
}
Values
ObligationSortBy.CREATED_AT
Member Of
ObligationSort input
ObligationStatus
No description
enum ObligationStatus {
DEFAULTED
DUE
NOT_YET_DUE
OVERDUE
PAID
}
Values
ObligationStatus.DEFAULTED
ObligationStatus.DUE
ObligationStatus.NOT_YET_DUE
ObligationStatus.OVERDUE
ObligationStatus.PAID
Member Of
Obligation object ● ObligationFilter input
ObligationType
No description
enum ObligationType {
DISBURSAL
INTEREST
}
Values
ObligationType.DISBURSAL
ObligationType.INTEREST
Member Of
Obligation object
OrganizationPartyDetailsUpdateErrorCode
No description
enum OrganizationPartyDetailsUpdateErrorCode {
PARTY_COMPANY_NAME_INVALID_CHARACTER
PARTY_COMPANY_NAME_TOO_LONG
PARTY_ORGANIZATION_DETAILS_REQUIRED
PARTY_ORGANIZATION_NOT_FOUND
}
Values
OrganizationPartyDetailsUpdateErrorCode.PARTY_COMPANY_NAME_INVALID_CHARACTER
the company name contains a disallowed character
OrganizationPartyDetailsUpdateErrorCode.PARTY_COMPANY_NAME_TOO_LONG
the company name is too long
OrganizationPartyDetailsUpdateErrorCode.PARTY_ORGANIZATION_DETAILS_REQUIRED
the organization details are required
OrganizationPartyDetailsUpdateErrorCode.PARTY_ORGANIZATION_NOT_FOUND
organization party not found
Member Of
OrganizationPartyDetailsUpdatePayloadError object
OrganizationPartyEmailUpdateErrorCode
No description
enum OrganizationPartyEmailUpdateErrorCode {
EMAIL_INVALID_DOMAIN
EMAIL_LENGTH
EMAIL_NON_ASCII
EMAIL_QUOTED_LOCAL_PART
EMAIL_SYNTAX
EMAIL_UNKNOWN_PUBLIC_SUFFIX
PARTY_EMAIL_ALREADY_EXISTS
PARTY_ORGANIZATION_NOT_FOUND
}
Values
OrganizationPartyEmailUpdateErrorCode.EMAIL_INVALID_DOMAIN
email address domain is not valid
OrganizationPartyEmailUpdateErrorCode.EMAIL_LENGTH
email address is empty or exceeds 254 characters
OrganizationPartyEmailUpdateErrorCode.EMAIL_NON_ASCII
email address contains non-ASCII characters
OrganizationPartyEmailUpdateErrorCode.EMAIL_QUOTED_LOCAL_PART
email address has a quoted local part
OrganizationPartyEmailUpdateErrorCode.EMAIL_SYNTAX
email address is malformed
OrganizationPartyEmailUpdateErrorCode.EMAIL_UNKNOWN_PUBLIC_SUFFIX
email address domain does not end in a known public suffix
OrganizationPartyEmailUpdateErrorCode.PARTY_EMAIL_ALREADY_EXISTS
another party already uses this email
OrganizationPartyEmailUpdateErrorCode.PARTY_ORGANIZATION_NOT_FOUND
organization party not found
Member Of
OrganizationPartyEmailUpdatePayloadError object
OrganizationPartyMemberAddErrorCode
No description
enum OrganizationPartyMemberAddErrorCode {
PARTY_INDIVIDUAL_NOT_FOUND
PARTY_ORGANIZATION_MEMBER_ALREADY_EXISTS
PARTY_ORGANIZATION_MEMBER_NOT_FOUND
PARTY_ORGANIZATION_MEMBER_PARTNER_MISMATCH
PARTY_ORGANIZATION_MEMBER_ROLE_INVALID_CHARACTER
PARTY_ORGANIZATION_MEMBER_ROLE_NOT_HELD
PARTY_ORGANIZATION_MEMBER_ROLE_REQUIRED
PARTY_ORGANIZATION_MEMBER_ROLE_TOO_LONG
PARTY_ORGANIZATION_NOT_FOUND
}
Values
OrganizationPartyMemberAddErrorCode.PARTY_INDIVIDUAL_NOT_FOUND
individual party not found
OrganizationPartyMemberAddErrorCode.PARTY_ORGANIZATION_MEMBER_ALREADY_EXISTS
the individual is already a member of the organization
OrganizationPartyMemberAddErrorCode.PARTY_ORGANIZATION_MEMBER_NOT_FOUND
the individual is not a member of the organization
OrganizationPartyMemberAddErrorCode.PARTY_ORGANIZATION_MEMBER_PARTNER_MISMATCH
the individual and the organization belong to different partners
OrganizationPartyMemberAddErrorCode.PARTY_ORGANIZATION_MEMBER_ROLE_INVALID_CHARACTER
the organization member role contains a disallowed character
OrganizationPartyMemberAddErrorCode.PARTY_ORGANIZATION_MEMBER_ROLE_NOT_HELD
the member does not hold the role
OrganizationPartyMemberAddErrorCode.PARTY_ORGANIZATION_MEMBER_ROLE_REQUIRED
at least one organization member role is required
OrganizationPartyMemberAddErrorCode.PARTY_ORGANIZATION_MEMBER_ROLE_TOO_LONG
the organization member role is too long
OrganizationPartyMemberAddErrorCode.PARTY_ORGANIZATION_NOT_FOUND
organization party not found
Member Of
OrganizationPartyMemberAddPayloadError object
OrganizationPartyMemberRemoveErrorCode
No description
enum OrganizationPartyMemberRemoveErrorCode {
PARTY_INDIVIDUAL_NOT_FOUND
PARTY_ORGANIZATION_MEMBER_ALREADY_EXISTS
PARTY_ORGANIZATION_MEMBER_NOT_FOUND
PARTY_ORGANIZATION_MEMBER_PARTNER_MISMATCH
PARTY_ORGANIZATION_MEMBER_ROLE_INVALID_CHARACTER
PARTY_ORGANIZATION_MEMBER_ROLE_NOT_HELD
PARTY_ORGANIZATION_MEMBER_ROLE_REQUIRED
PARTY_ORGANIZATION_MEMBER_ROLE_TOO_LONG
PARTY_ORGANIZATION_NOT_FOUND
}
Values
OrganizationPartyMemberRemoveErrorCode.PARTY_INDIVIDUAL_NOT_FOUND
individual party not found
OrganizationPartyMemberRemoveErrorCode.PARTY_ORGANIZATION_MEMBER_ALREADY_EXISTS
the individual is already a member of the organization
OrganizationPartyMemberRemoveErrorCode.PARTY_ORGANIZATION_MEMBER_NOT_FOUND
the individual is not a member of the organization
OrganizationPartyMemberRemoveErrorCode.PARTY_ORGANIZATION_MEMBER_PARTNER_MISMATCH
the individual and the organization belong to different partners
OrganizationPartyMemberRemoveErrorCode.PARTY_ORGANIZATION_MEMBER_ROLE_INVALID_CHARACTER
the organization member role contains a disallowed character
OrganizationPartyMemberRemoveErrorCode.PARTY_ORGANIZATION_MEMBER_ROLE_NOT_HELD
the member does not hold the role
OrganizationPartyMemberRemoveErrorCode.PARTY_ORGANIZATION_MEMBER_ROLE_REQUIRED
at least one organization member role is required
OrganizationPartyMemberRemoveErrorCode.PARTY_ORGANIZATION_MEMBER_ROLE_TOO_LONG
the organization member role is too long
OrganizationPartyMemberRemoveErrorCode.PARTY_ORGANIZATION_NOT_FOUND
organization party not found
Member Of
OrganizationPartyMemberRemovePayloadError object
OrganizationPartyMemberRoleAddErrorCode
No description
enum OrganizationPartyMemberRoleAddErrorCode {
PARTY_INDIVIDUAL_NOT_FOUND
PARTY_ORGANIZATION_MEMBER_ALREADY_EXISTS
PARTY_ORGANIZATION_MEMBER_NOT_FOUND
PARTY_ORGANIZATION_MEMBER_PARTNER_MISMATCH
PARTY_ORGANIZATION_MEMBER_ROLE_INVALID_CHARACTER
PARTY_ORGANIZATION_MEMBER_ROLE_NOT_HELD
PARTY_ORGANIZATION_MEMBER_ROLE_REQUIRED
PARTY_ORGANIZATION_MEMBER_ROLE_TOO_LONG
PARTY_ORGANIZATION_NOT_FOUND
}
Values
OrganizationPartyMemberRoleAddErrorCode.PARTY_INDIVIDUAL_NOT_FOUND
individual party not found
OrganizationPartyMemberRoleAddErrorCode.PARTY_ORGANIZATION_MEMBER_ALREADY_EXISTS
the individual is already a member of the organization
OrganizationPartyMemberRoleAddErrorCode.PARTY_ORGANIZATION_MEMBER_NOT_FOUND
the individual is not a member of the organization
OrganizationPartyMemberRoleAddErrorCode.PARTY_ORGANIZATION_MEMBER_PARTNER_MISMATCH
the individual and the organization belong to different partners
OrganizationPartyMemberRoleAddErrorCode.PARTY_ORGANIZATION_MEMBER_ROLE_INVALID_CHARACTER
the organization member role contains a disallowed character
OrganizationPartyMemberRoleAddErrorCode.PARTY_ORGANIZATION_MEMBER_ROLE_NOT_HELD
the member does not hold the role
OrganizationPartyMemberRoleAddErrorCode.PARTY_ORGANIZATION_MEMBER_ROLE_REQUIRED
at least one organization member role is required
OrganizationPartyMemberRoleAddErrorCode.PARTY_ORGANIZATION_MEMBER_ROLE_TOO_LONG
the organization member role is too long
OrganizationPartyMemberRoleAddErrorCode.PARTY_ORGANIZATION_NOT_FOUND
organization party not found
Member Of
OrganizationPartyMemberRoleAddPayloadError object
OrganizationPartyMemberRoleRemoveErrorCode
No description
enum OrganizationPartyMemberRoleRemoveErrorCode {
PARTY_INDIVIDUAL_NOT_FOUND
PARTY_ORGANIZATION_MEMBER_ALREADY_EXISTS
PARTY_ORGANIZATION_MEMBER_NOT_FOUND
PARTY_ORGANIZATION_MEMBER_PARTNER_MISMATCH
PARTY_ORGANIZATION_MEMBER_ROLE_INVALID_CHARACTER
PARTY_ORGANIZATION_MEMBER_ROLE_NOT_HELD
PARTY_ORGANIZATION_MEMBER_ROLE_REQUIRED
PARTY_ORGANIZATION_MEMBER_ROLE_TOO_LONG
PARTY_ORGANIZATION_NOT_FOUND
}
Values
OrganizationPartyMemberRoleRemoveErrorCode.PARTY_INDIVIDUAL_NOT_FOUND
individual party not found
OrganizationPartyMemberRoleRemoveErrorCode.PARTY_ORGANIZATION_MEMBER_ALREADY_EXISTS
the individual is already a member of the organization
OrganizationPartyMemberRoleRemoveErrorCode.PARTY_ORGANIZATION_MEMBER_NOT_FOUND
the individual is not a member of the organization
OrganizationPartyMemberRoleRemoveErrorCode.PARTY_ORGANIZATION_MEMBER_PARTNER_MISMATCH
the individual and the organization belong to different partners
OrganizationPartyMemberRoleRemoveErrorCode.PARTY_ORGANIZATION_MEMBER_ROLE_INVALID_CHARACTER
the organization member role contains a disallowed character
OrganizationPartyMemberRoleRemoveErrorCode.PARTY_ORGANIZATION_MEMBER_ROLE_NOT_HELD
the member does not hold the role
OrganizationPartyMemberRoleRemoveErrorCode.PARTY_ORGANIZATION_MEMBER_ROLE_REQUIRED
at least one organization member role is required
OrganizationPartyMemberRoleRemoveErrorCode.PARTY_ORGANIZATION_MEMBER_ROLE_TOO_LONG
the organization member role is too long
OrganizationPartyMemberRoleRemoveErrorCode.PARTY_ORGANIZATION_NOT_FOUND
organization party not found
Member Of
OrganizationPartyMemberRoleRemovePayloadError object
PartnerActivateErrorCode
No description
enum PartnerActivateErrorCode {
PARTNER_CLOSED
PARTNER_NOT_FOUND
}
Values
PartnerActivateErrorCode.PARTNER_CLOSED
The partner is closed.
PartnerActivateErrorCode.PARTNER_NOT_FOUND
No partner exists with the supplied id.
Member Of
PartnerActivatePayloadError object
PartnerCreateErrorCode
No description
enum PartnerCreateErrorCode {
EMAIL_INVALID_DOMAIN
EMAIL_LENGTH
EMAIL_NON_ASCII
EMAIL_QUOTED_LOCAL_PART
EMAIL_SYNTAX
EMAIL_UNKNOWN_PUBLIC_SUFFIX
PARTNER_ADMIN_EMAIL_TAKEN
PARTNER_NAME_ALREADY_EXISTS
}
Values
PartnerCreateErrorCode.EMAIL_INVALID_DOMAIN
email address domain is not valid
PartnerCreateErrorCode.EMAIL_LENGTH
email address is empty or exceeds 254 characters
PartnerCreateErrorCode.EMAIL_NON_ASCII
email address contains non-ASCII characters
PartnerCreateErrorCode.EMAIL_QUOTED_LOCAL_PART
email address has a quoted local part
PartnerCreateErrorCode.EMAIL_SYNTAX
email address is malformed
PartnerCreateErrorCode.EMAIL_UNKNOWN_PUBLIC_SUFFIX
email address domain does not end in a known public suffix
PartnerCreateErrorCode.PARTNER_ADMIN_EMAIL_TAKEN
Another partner user already uses this email.
PartnerCreateErrorCode.PARTNER_NAME_ALREADY_EXISTS
Another partner already uses this name.
Member Of
PartnerCreatePayloadError object
PartnerDeactivateErrorCode
No description
enum PartnerDeactivateErrorCode {
PARTNER_BANK_OWNED_CANNOT_BE_DEACTIVATED
PARTNER_CLOSED
PARTNER_NOT_FOUND
}
Values
PartnerDeactivateErrorCode.PARTNER_BANK_OWNED_CANNOT_BE_DEACTIVATED
The bank-owned partner cannot be deactivated.
PartnerDeactivateErrorCode.PARTNER_CLOSED
The partner is closed.
PartnerDeactivateErrorCode.PARTNER_NOT_FOUND
No partner exists with the supplied id.
Member Of
PartnerDeactivatePayloadError object
PartnerSortBy
No description
enum PartnerSortBy {
CREATED_AT
NAME
STATUS
}
Values
PartnerSortBy.CREATED_AT
PartnerSortBy.NAME
PartnerSortBy.STATUS
Member Of
PartnerSort input
PartnerStatus
No description
enum PartnerStatus {
ACTIVE
CLOSED
INITIALIZED
REVIEW_PENDING
}
Values
PartnerStatus.ACTIVE
PartnerStatus.CLOSED
PartnerStatus.INITIALIZED
PartnerStatus.REVIEW_PENDING
Member Of
Partner object
PartnerUpdateErrorCode
No description
enum PartnerUpdateErrorCode {
PARTNER_BANK_OWNED_CANNOT_BE_RENAMED
PARTNER_CLOSED
PARTNER_NAME_ALREADY_EXISTS
PARTNER_NOT_FOUND
}
Values
PartnerUpdateErrorCode.PARTNER_BANK_OWNED_CANNOT_BE_RENAMED
The bank-owned partner cannot be renamed.
PartnerUpdateErrorCode.PARTNER_CLOSED
The partner is closed.
PartnerUpdateErrorCode.PARTNER_NAME_ALREADY_EXISTS
Another partner already uses this name.
PartnerUpdateErrorCode.PARTNER_NOT_FOUND
No partner exists with the supplied id.
Member Of
PartnerUpdatePayloadError object
PastFiscalYearStatus
No description
enum PastFiscalYearStatus {
ADJUSTING
CLOSED
}
Values
PastFiscalYearStatus.ADJUSTING
PastFiscalYearStatus.CLOSED
Member Of
PastFiscalYear object
PaymentProviderConfigUpdateErrorCode
No description
enum PaymentProviderConfigUpdateErrorCode {
PAYMENTS_PAYMENT_PROVIDER_NOT_FOUND
PAYMENTS_PROVIDER_KIND_MISMATCH
PAYMENTS_PROVIDER_VERIFICATION_REJECTED
}
Values
PaymentProviderConfigUpdateErrorCode.PAYMENTS_PAYMENT_PROVIDER_NOT_FOUND
No payment provider exists with the supplied id.
PaymentProviderConfigUpdateErrorCode.PAYMENTS_PROVIDER_KIND_MISMATCH
A payment provider cannot change from one kind of provider to another.
PaymentProviderConfigUpdateErrorCode.PAYMENTS_PROVIDER_VERIFICATION_REJECTED
The payment provider rejected the supplied credentials.
Member Of
PaymentProviderConfigUpdatePayloadError object
PaymentProviderCreateErrorCode
No description
enum PaymentProviderCreateErrorCode {
PAYMENTS_PROVIDER_NAME_TAKEN
PAYMENTS_PROVIDER_VERIFICATION_REJECTED
}
Values
PaymentProviderCreateErrorCode.PAYMENTS_PROVIDER_NAME_TAKEN
Another payment provider already uses this name.
PaymentProviderCreateErrorCode.PAYMENTS_PROVIDER_VERIFICATION_REJECTED
The payment provider rejected the supplied credentials.
Member Of
PaymentProviderCreatePayloadError object
PayoutCancelErrorCode
No description
enum PayoutCancelErrorCode {
PAYMENTS_PAYOUT_NOT_CANCELLABLE
PAYMENTS_PAYOUT_NOT_FOUND
}
Values
PayoutCancelErrorCode.PAYMENTS_PAYOUT_NOT_CANCELLABLE
Only a pending payout can be cancelled.
PayoutCancelErrorCode.PAYMENTS_PAYOUT_NOT_FOUND
No payout exists with the supplied id.
Member Of
PayoutCancelPayloadError object
PayoutDraftStatus
No description
enum PayoutDraftStatus {
DISCARDED
PENDING
SUBMITTED
}
Values
PayoutDraftStatus.DISCARDED
PayoutDraftStatus.PENDING
PayoutDraftStatus.SUBMITTED
Member Of
PayoutDraft object
PayoutFailErrorCode
No description
enum PayoutFailErrorCode {
PAYMENTS_PAYOUT_NOT_FOUND
PAYMENTS_PAYOUT_NOT_PENDING_FOR_SETTLEMENT
}
Values
PayoutFailErrorCode.PAYMENTS_PAYOUT_NOT_FOUND
No payout exists with the supplied id.
PayoutFailErrorCode.PAYMENTS_PAYOUT_NOT_PENDING_FOR_SETTLEMENT
The payout is no longer pending, so it cannot be settled or failed.
Member Of
PayoutFailPayloadError object
PayoutRevertErrorCode
No description
enum PayoutRevertErrorCode {
PAYMENTS_ONLY_SETTLED_PAYOUT_CAN_REVERT
PAYMENTS_PAYOUT_IRREVOCABLE
PAYMENTS_PAYOUT_NOT_FOUND
}
Values
PayoutRevertErrorCode.PAYMENTS_ONLY_SETTLED_PAYOUT_CAN_REVERT
Only a settled payout can be reverted.
PayoutRevertErrorCode.PAYMENTS_PAYOUT_IRREVOCABLE
The payout was sent as irrevocable and cannot be reverted.
PayoutRevertErrorCode.PAYMENTS_PAYOUT_NOT_FOUND
No payout exists with the supplied id.
Member Of
PayoutRevertPayloadError object
PayoutSettleErrorCode
No description
enum PayoutSettleErrorCode {
PAYMENTS_PAYOUT_NOT_FOUND
PAYMENTS_PAYOUT_NOT_PENDING_FOR_SETTLEMENT
}
Values
PayoutSettleErrorCode.PAYMENTS_PAYOUT_NOT_FOUND
No payout exists with the supplied id.
PayoutSettleErrorCode.PAYMENTS_PAYOUT_NOT_PENDING_FOR_SETTLEMENT
The payout is no longer pending, so it cannot be settled or failed.
Member Of
PayoutSettlePayloadError object
PayoutSortBy
No description
enum PayoutSortBy {
CREATED_AT
}
Values
PayoutSortBy.CREATED_AT
Member Of
PayoutSort input
PayoutStatus
No description
enum PayoutStatus {
CANCELLED
FAILED
PENDING
REVERTED
SETTLED
}
Values
PayoutStatus.CANCELLED
PayoutStatus.FAILED
PayoutStatus.PENDING
PayoutStatus.REVERTED
PayoutStatus.SETTLED
Member Of
Payout object
PendingCreditFacilityCollateralizationState
No description
enum PendingCreditFacilityCollateralizationState {
FULLY_COLLATERALIZED
NOT_YET_COLLATERALIZED
UNDER_COLLATERALIZED
}
Values
PendingCreditFacilityCollateralizationState.FULLY_COLLATERALIZED
PendingCreditFacilityCollateralizationState.NOT_YET_COLLATERALIZED
PendingCreditFacilityCollateralizationState.UNDER_COLLATERALIZED
Member Of
PendingCreditFacility object ● PendingCreditFacilityCollateralizationUpdated object ● PendingCreditFacilityFilter input
PendingCreditFacilitySortBy
No description
enum PendingCreditFacilitySortBy {
CREATED_AT
FACILITY_AMOUNT
}
Values
PendingCreditFacilitySortBy.CREATED_AT
PendingCreditFacilitySortBy.FACILITY_AMOUNT
Member Of
PendingCreditFacilitySort input
PendingCreditFacilityStatus
No description
enum PendingCreditFacilityStatus {
COMPLETED
PENDING_COLLATERALIZATION
}
Values
PendingCreditFacilityStatus.COMPLETED
PendingCreditFacilityStatus.PENDING_COLLATERALIZATION
Member Of
PendingCreditFacility object ● PendingCreditFacilityFilter input
Period
No description
enum Period {
DAYS
MONTHS
}
Values
Period.DAYS
Period.MONTHS
Member Of
Duration object ● DurationInput input
PiiErasurePhaseExecutionStatus
No description
enum PiiErasurePhaseExecutionStatus {
COMPLETED
FAILED
IN_PROGRESS
}
Values
PiiErasurePhaseExecutionStatus.COMPLETED
PiiErasurePhaseExecutionStatus.FAILED
PiiErasurePhaseExecutionStatus.IN_PROGRESS
Member Of
PiiErasureProcessPhase object
PiiErasureProcessCancelErrorCode
No description
enum PiiErasureProcessCancelErrorCode {
CUSTOMER_NOT_FOUND
PII_ERASURE_EXECUTION_ALREADY_STARTED
PII_ERASURE_NOTHING_SCHEDULED
PROSPECT_NOT_FOUND
}
Values
PiiErasureProcessCancelErrorCode.CUSTOMER_NOT_FOUND
the customer was not found
PiiErasureProcessCancelErrorCode.PII_ERASURE_EXECUTION_ALREADY_STARTED
the erasure has already started and can no longer be changed
PiiErasureProcessCancelErrorCode.PII_ERASURE_NOTHING_SCHEDULED
no erasure is scheduled for this party
PiiErasureProcessCancelErrorCode.PROSPECT_NOT_FOUND
the prospect was not found
Member Of
PiiErasureProcessCancelPayloadError object
PiiErasureProcessScheduleErrorCode
No description
enum PiiErasureProcessScheduleErrorCode {
CUSTOMER_NOT_FOUND
PII_ERASURE_ALREADY_SCHEDULED
PII_ERASURE_CUSTOMER_NOT_CLOSED
PII_ERASURE_DOCUMENTS_RETAINED
PII_ERASURE_EXECUTE_ON_IN_PAST
PII_ERASURE_PROSPECT_NOT_CLOSED
PROSPECT_NOT_FOUND
}
Values
PiiErasureProcessScheduleErrorCode.CUSTOMER_NOT_FOUND
the customer was not found
PiiErasureProcessScheduleErrorCode.PII_ERASURE_ALREADY_SCHEDULED
an erasure is already scheduled for this party
PiiErasureProcessScheduleErrorCode.PII_ERASURE_CUSTOMER_NOT_CLOSED
the customer must be closed before its data can be erased
PiiErasureProcessScheduleErrorCode.PII_ERASURE_DOCUMENTS_RETAINED
subject documents are still retained
PiiErasureProcessScheduleErrorCode.PII_ERASURE_EXECUTE_ON_IN_PAST
the scheduled erasure date cannot be in the past
PiiErasureProcessScheduleErrorCode.PII_ERASURE_PROSPECT_NOT_CLOSED
the prospect must be closed before its data can be erased
PiiErasureProcessScheduleErrorCode.PROSPECT_NOT_FOUND
the prospect was not found
Member Of
PiiErasureProcessSchedulePayloadError object
PiiErasureProcessSortBy
No description
enum PiiErasureProcessSortBy {
CREATED_AT
EXECUTE_ON
}
Values
PiiErasureProcessSortBy.CREATED_AT
PiiErasureProcessSortBy.EXECUTE_ON
Member Of
PiiErasureProcessSort input
PiiErasureProcessStatus
No description
enum PiiErasureProcessStatus {
CANCELLED
COMPLETED
IN_PROGRESS
SCHEDULED
STOPPED
}
Values
PiiErasureProcessStatus.CANCELLED
PiiErasureProcessStatus.COMPLETED
PiiErasureProcessStatus.IN_PROGRESS
PiiErasureProcessStatus.SCHEDULED
PiiErasureProcessStatus.STOPPED
Member Of
PiiErasureProcess object ● PiiErasureProcessFilter input
PiiStatus
Visibility of a PII field for the requesting subject.
enum PiiStatus {
ERASED
HIDDEN
NOT_SET
VISIBLE
}
Values
PiiStatus.ERASED
The subject may view PII, but the party's PII has been erased.
PiiStatus.HIDDEN
The subject lacks the party_pii_viewer permission set; whether the
field has a value is not disclosed.
PiiStatus.NOT_SET
The subject may view PII but the field has no value: the party never provided one.
PiiStatus.VISIBLE
The subject holds the party_pii_viewer permission set and the field
has a value.
Member Of
PiiEmail object ● PiiPersonalInfo object
PipelineRunKind
No description
enum PipelineRunKind {
EOD
INITIALIZATION
INTRADAY
ON_DEMAND
}
Values
PipelineRunKind.EOD
PipelineRunKind.INITIALIZATION
PipelineRunKind.INTRADAY
PipelineRunKind.ON_DEMAND
Member Of
PipelineRun object ● PipelineRunFilter input
PipelineRunRefreshMode
No description
enum PipelineRunRefreshMode {
FULL
PARTIAL
}
Values
PipelineRunRefreshMode.FULL
Build the entire dbt DAG, including seeds and tests.
PipelineRunRefreshMode.PARTIAL
Build operational marts and their seeds using the intraday selector, without tests.
Member Of
PipelineRun object ● pipelineRunRequest mutation
PipelineRunRequestErrorCode
No description
enum PipelineRunRequestErrorCode {
DW_PIPELINE_WAREHOUSE_NOT_CONFIGURED
}
Values
PipelineRunRequestErrorCode.DW_PIPELINE_WAREHOUSE_NOT_CONFIGURED
The data warehouse is not configured, so no pipeline run can be requested.
Member Of
PipelineRunRequestPayloadError object
PipelineRunSortBy
No description
enum PipelineRunSortBy {
DAY
KIND
STATUS
}
Values
PipelineRunSortBy.DAY
PipelineRunSortBy.KIND
PipelineRunSortBy.STATUS
Member Of
PipelineRunSort input
PipelineRunStatus
No description
enum PipelineRunStatus {
COMPLETED
FAILED
IN_PROGRESS
PENDING
SKIPPED
}
Values
PipelineRunStatus.COMPLETED
PipelineRunStatus.FAILED
PipelineRunStatus.IN_PROGRESS
PipelineRunStatus.PENDING
PipelineRunStatus.SKIPPED
Superseded by a newer scheduled refresh, without running dbt.
Member Of
PipelineRun object ● PipelineRunFilter input
PolicyCommitteeAssignErrorCode
No description
enum PolicyCommitteeAssignErrorCode {
GOVERNANCE_COMMITTEE_NOT_FOUND
GOVERNANCE_POLICY_NOT_FOUND
}
Values
PolicyCommitteeAssignErrorCode.GOVERNANCE_COMMITTEE_NOT_FOUND
No committee exists with the supplied id.
PolicyCommitteeAssignErrorCode.GOVERNANCE_POLICY_NOT_FOUND
No policy exists with the supplied id.
Member Of
PolicyCommitteeAssignPayloadError object
ProspectCloseErrorCode
No description
enum ProspectCloseErrorCode {
PROSPECT_ALREADY_CLOSED
PROSPECT_ALREADY_CONVERTED
}
Values
ProspectCloseErrorCode.PROSPECT_ALREADY_CLOSED
the prospect has been closed
ProspectCloseErrorCode.PROSPECT_ALREADY_CONVERTED
the prospect has already been converted to a customer
Member Of
ProspectClosePayloadError object
ProspectCreateErrorCode
No description
enum ProspectCreateErrorCode {
EMAIL_INVALID_DOMAIN
EMAIL_LENGTH
EMAIL_NON_ASCII
EMAIL_QUOTED_LOCAL_PART
EMAIL_SYNTAX
EMAIL_UNKNOWN_PUBLIC_SUFFIX
PARTY_COMPANY_NAME_INVALID_CHARACTER
PARTY_COMPANY_NAME_TOO_LONG
PARTY_EMAIL_ALREADY_EXISTS
PARTY_ORGANIZATION_CUSTOMER_TYPE_INVALID
PARTY_ORGANIZATION_DETAILS_REQUIRED
}
Values
ProspectCreateErrorCode.EMAIL_INVALID_DOMAIN
email address domain is not valid
ProspectCreateErrorCode.EMAIL_LENGTH
email address is empty or exceeds 254 characters
ProspectCreateErrorCode.EMAIL_NON_ASCII
email address contains non-ASCII characters
ProspectCreateErrorCode.EMAIL_QUOTED_LOCAL_PART
email address has a quoted local part
ProspectCreateErrorCode.EMAIL_SYNTAX
email address is malformed
ProspectCreateErrorCode.EMAIL_UNKNOWN_PUBLIC_SUFFIX
email address domain does not end in a known public suffix
ProspectCreateErrorCode.PARTY_COMPANY_NAME_INVALID_CHARACTER
the company name contains a disallowed character
ProspectCreateErrorCode.PARTY_COMPANY_NAME_TOO_LONG
the company name is too long
ProspectCreateErrorCode.PARTY_EMAIL_ALREADY_EXISTS
another party already uses this email
ProspectCreateErrorCode.PARTY_ORGANIZATION_CUSTOMER_TYPE_INVALID
an organization cannot have the individual customer type
ProspectCreateErrorCode.PARTY_ORGANIZATION_DETAILS_REQUIRED
the organization details are required
Member Of
ProspectCreatePayloadError object
ProspectSortBy
No description
enum ProspectSortBy {
CREATED_AT
}
Values
ProspectSortBy.CREATED_AT
Member Of
ProspectSort input
ProspectStage
No description
enum ProspectStage {
CLOSED
CONVERTED
NEW
}
Values
ProspectStage.CLOSED
ProspectStage.CONVERTED
ProspectStage.NEW
Member Of
Prospect object ● ProspectFilter input
QueryTemplateCategory
No description
enum QueryTemplateCategory {
COMPLIANCE
CREDIT
DASHBOARD
DEPOSITS
GROWTH
OVERVIEW
RISK
}
Values
QueryTemplateCategory.COMPLIANCE
QueryTemplateCategory.CREDIT
QueryTemplateCategory.DASHBOARD
Pinning a template to the operators' home dashboard.
QueryTemplateCategory.DEPOSITS
QueryTemplateCategory.GROWTH
QueryTemplateCategory.OVERVIEW
QueryTemplateCategory.RISK
Member Of
DashboardCardTemplate object ● QueryTemplate object ● QueryTemplateCreateInput input ● QueryTemplateFilter input ● QueryTemplateUpdateInput input
QueryTemplateCreateErrorCode
No description
enum QueryTemplateCreateErrorCode {
REPORT_QUERY_TEMPLATE_CATEGORY_REQUIRED
REPORT_QUERY_TEMPLATE_DESCRIPTION_TOO_LONG
REPORT_QUERY_TEMPLATE_NAME_REQUIRED
REPORT_QUERY_TEMPLATE_NAME_TOO_LONG
REPORT_QUERY_TEMPLATE_SQL_TOO_LONG
REPORT_READONLY_QUERY_DISALLOWED_FUNCTION
REPORT_READONLY_QUERY_DISALLOWED_RELATION
REPORT_READONLY_QUERY_NOT_PARSEABLE
REPORT_READONLY_QUERY_NOT_SELECT
REPORT_READONLY_QUERY_NOT_SINGLE_STATEMENT
REPORT_READONLY_QUERY_RECURSIVE_CTE
REPORT_READONLY_QUERY_TOO_LONG
}
Values
QueryTemplateCreateErrorCode.REPORT_QUERY_TEMPLATE_CATEGORY_REQUIRED
A query template needs at least one category.
QueryTemplateCreateErrorCode.REPORT_QUERY_TEMPLATE_DESCRIPTION_TOO_LONG
The query template description exceeds the length limit.
QueryTemplateCreateErrorCode.REPORT_QUERY_TEMPLATE_NAME_REQUIRED
A query template name is required.
QueryTemplateCreateErrorCode.REPORT_QUERY_TEMPLATE_NAME_TOO_LONG
The query template name exceeds the length limit.
QueryTemplateCreateErrorCode.REPORT_QUERY_TEMPLATE_SQL_TOO_LONG
The query template SQL exceeds the length limit.
QueryTemplateCreateErrorCode.REPORT_READONLY_QUERY_DISALLOWED_FUNCTION
The query calls a function that is not allowed.
QueryTemplateCreateErrorCode.REPORT_READONLY_QUERY_DISALLOWED_RELATION
The query references a relation outside the allowed data-mart layers.
QueryTemplateCreateErrorCode.REPORT_READONLY_QUERY_NOT_PARSEABLE
The read-only query SQL could not be parsed.
QueryTemplateCreateErrorCode.REPORT_READONLY_QUERY_NOT_SELECT
Only SELECT queries are allowed.
QueryTemplateCreateErrorCode.REPORT_READONLY_QUERY_NOT_SINGLE_STATEMENT
A read-only query must be exactly one statement.
QueryTemplateCreateErrorCode.REPORT_READONLY_QUERY_RECURSIVE_CTE
Recursive common table expressions are not allowed.
QueryTemplateCreateErrorCode.REPORT_READONLY_QUERY_TOO_LONG
The read-only query SQL exceeds the length limit.
Member Of
QueryTemplateCreatePayloadError object
QueryTemplateDeleteErrorCode
No description
enum QueryTemplateDeleteErrorCode {
REPORT_QUERY_TEMPLATE_NOT_FOUND
}
Values
QueryTemplateDeleteErrorCode.REPORT_QUERY_TEMPLATE_NOT_FOUND
No query template exists with the supplied id.
Member Of
QueryTemplateDeletePayloadError object
QueryTemplateSortBy
No description
enum QueryTemplateSortBy {
CATEGORIES
CREATED_AT
NAME
}
Values
QueryTemplateSortBy.CATEGORIES
QueryTemplateSortBy.CREATED_AT
QueryTemplateSortBy.NAME
Member Of
QueryTemplateSort input
QueryTemplateUpdateErrorCode
No description
enum QueryTemplateUpdateErrorCode {
REPORT_QUERY_TEMPLATE_CATEGORY_REQUIRED
REPORT_QUERY_TEMPLATE_DESCRIPTION_TOO_LONG
REPORT_QUERY_TEMPLATE_NAME_REQUIRED
REPORT_QUERY_TEMPLATE_NAME_TOO_LONG
REPORT_QUERY_TEMPLATE_NOT_FOUND
REPORT_QUERY_TEMPLATE_SQL_TOO_LONG
REPORT_READONLY_QUERY_DISALLOWED_FUNCTION
REPORT_READONLY_QUERY_DISALLOWED_RELATION
REPORT_READONLY_QUERY_NOT_PARSEABLE
REPORT_READONLY_QUERY_NOT_SELECT
REPORT_READONLY_QUERY_NOT_SINGLE_STATEMENT
REPORT_READONLY_QUERY_RECURSIVE_CTE
REPORT_READONLY_QUERY_TOO_LONG
}
Values
QueryTemplateUpdateErrorCode.REPORT_QUERY_TEMPLATE_CATEGORY_REQUIRED
A query template needs at least one category.
QueryTemplateUpdateErrorCode.REPORT_QUERY_TEMPLATE_DESCRIPTION_TOO_LONG
The query template description exceeds the length limit.
QueryTemplateUpdateErrorCode.REPORT_QUERY_TEMPLATE_NAME_REQUIRED
A query template name is required.
QueryTemplateUpdateErrorCode.REPORT_QUERY_TEMPLATE_NAME_TOO_LONG
The query template name exceeds the length limit.
QueryTemplateUpdateErrorCode.REPORT_QUERY_TEMPLATE_NOT_FOUND
No query template exists with the supplied id.
QueryTemplateUpdateErrorCode.REPORT_QUERY_TEMPLATE_SQL_TOO_LONG
The query template SQL exceeds the length limit.
QueryTemplateUpdateErrorCode.REPORT_READONLY_QUERY_DISALLOWED_FUNCTION
The query calls a function that is not allowed.
QueryTemplateUpdateErrorCode.REPORT_READONLY_QUERY_DISALLOWED_RELATION
The query references a relation outside the allowed data-mart layers.
QueryTemplateUpdateErrorCode.REPORT_READONLY_QUERY_NOT_PARSEABLE
The read-only query SQL could not be parsed.
QueryTemplateUpdateErrorCode.REPORT_READONLY_QUERY_NOT_SELECT
Only SELECT queries are allowed.
QueryTemplateUpdateErrorCode.REPORT_READONLY_QUERY_NOT_SINGLE_STATEMENT
A read-only query must be exactly one statement.
QueryTemplateUpdateErrorCode.REPORT_READONLY_QUERY_RECURSIVE_CTE
Recursive common table expressions are not allowed.
QueryTemplateUpdateErrorCode.REPORT_READONLY_QUERY_TOO_LONG
The read-only query SQL exceeds the length limit.
Member Of
QueryTemplateUpdatePayloadError object
RailCreateErrorCode
No description
enum RailCreateErrorCode {
PAYMENTS_PAYMENT_PROVIDER_NOT_FOUND
PAYMENTS_PROVIDER_DOES_NOT_SETTLE
PAYMENTS_RAIL_NAME_TAKEN
}
Values
RailCreateErrorCode.PAYMENTS_PAYMENT_PROVIDER_NOT_FOUND
No payment provider exists with the supplied id.
RailCreateErrorCode.PAYMENTS_PROVIDER_DOES_NOT_SETTLE
The payment provider does not settle the requested currency variant.
RailCreateErrorCode.PAYMENTS_RAIL_NAME_TAKEN
Another rail already uses this name.
Member Of
RailCreatePayloadError object
RailCurrencyType
No description
enum RailCurrencyType {
ANY
SPECIFIC
}
Values
RailCurrencyType.ANY
RailCurrencyType.SPECIFIC
Member Of
RailCurrency object
RailSortBy
No description
enum RailSortBy {
CREATED_AT
NAME
}
Values
RailSortBy.CREATED_AT
RailSortBy.NAME
Member Of
RailSort input
ReceiptCancelErrorCode
No description
enum ReceiptCancelErrorCode {
PAYMENTS_RECEIPT_NOT_CANCELLABLE
PAYMENTS_RECEIPT_NOT_FOUND
}
Values
ReceiptCancelErrorCode.PAYMENTS_RECEIPT_NOT_CANCELLABLE
Only a pending receipt can be cancelled.
ReceiptCancelErrorCode.PAYMENTS_RECEIPT_NOT_FOUND
No receipt exists with the supplied id.
Member Of
ReceiptCancelPayloadError object
ReceiptFailErrorCode
No description
enum ReceiptFailErrorCode {
PAYMENTS_RECEIPT_NOT_FOUND
PAYMENTS_RECEIPT_NOT_PENDING_FOR_SETTLEMENT
}
Values
ReceiptFailErrorCode.PAYMENTS_RECEIPT_NOT_FOUND
No receipt exists with the supplied id.
ReceiptFailErrorCode.PAYMENTS_RECEIPT_NOT_PENDING_FOR_SETTLEMENT
The receipt is no longer awaiting settlement, so it cannot be settled or failed.
Member Of
ReceiptFailPayloadError object
ReceiptSettleErrorCode
No description
enum ReceiptSettleErrorCode {
PAYMENTS_RECEIPT_NOT_FOUND
PAYMENTS_RECEIPT_NOT_PENDING_FOR_SETTLEMENT
}
Values
ReceiptSettleErrorCode.PAYMENTS_RECEIPT_NOT_FOUND
No receipt exists with the supplied id.
ReceiptSettleErrorCode.PAYMENTS_RECEIPT_NOT_PENDING_FOR_SETTLEMENT
The receipt is no longer awaiting settlement, so it cannot be settled or failed.
Member Of
ReceiptSettlePayloadError object
ReceiptSortBy
No description
enum ReceiptSortBy {
CREATED_AT
}
Values
ReceiptSortBy.CREATED_AT
Member Of
ReceiptSort input
ReceiptStatus
No description
enum ReceiptStatus {
CANCELLED
CLEARED
FAILED
PENDING
SETTLED
}
Values
ReceiptStatus.CANCELLED
ReceiptStatus.CLEARED
The provider accepted and attributed the transfer; settlement may still be in progress, and clearing posts nothing to the hub's journal.
ReceiptStatus.FAILED
ReceiptStatus.PENDING
ReceiptStatus.SETTLED
Member Of
Receipt object
ReceiptSubmitErrorCode
No description
enum ReceiptSubmitErrorCode {
MONEY_OVERFLOW
MONEY_UNSUPPORTED_CURRENCY
PAYMENTS_ENDPOINT_CURRENCY_MISMATCH
PAYMENTS_NO_MATCHING_RAIL
PAYMENTS_PAYMENT_ENDPOINT_RETIRED
PAYMENTS_RAIL_CURRENCY_MISMATCH
PAYMENTS_RAIL_NOT_FOUND
PAYMENTS_RECEIPT_AMOUNT_MUST_NOT_BE_ZERO
PAYMENTS_RECEIPT_EXTERNAL_ID_TAKEN
PAYMENTS_RECEIPT_EXTERNAL_ID_TOO_LONG
PAYMENTS_UNKNOWN_LOCATOR
}
Values
ReceiptSubmitErrorCode.MONEY_OVERFLOW
The amount exceeds the maximum supported value.
ReceiptSubmitErrorCode.MONEY_UNSUPPORTED_CURRENCY
The amount uses an unsupported currency.
ReceiptSubmitErrorCode.PAYMENTS_ENDPOINT_CURRENCY_MISMATCH
The receipt currency differs from the currency the payment endpoint receives.
ReceiptSubmitErrorCode.PAYMENTS_NO_MATCHING_RAIL
No configured rail can carry the requested currency variant.
ReceiptSubmitErrorCode.PAYMENTS_PAYMENT_ENDPOINT_RETIRED
The payment endpoint is retired and no longer accepts payments.
ReceiptSubmitErrorCode.PAYMENTS_RAIL_CURRENCY_MISMATCH
The receipt currency is not carried by the rail.
ReceiptSubmitErrorCode.PAYMENTS_RAIL_NOT_FOUND
No rail exists with the supplied id.
ReceiptSubmitErrorCode.PAYMENTS_RECEIPT_AMOUNT_MUST_NOT_BE_ZERO
A receipt must carry a non-zero amount.
ReceiptSubmitErrorCode.PAYMENTS_RECEIPT_EXTERNAL_ID_TAKEN
Another receipt already uses this external id.
ReceiptSubmitErrorCode.PAYMENTS_RECEIPT_EXTERNAL_ID_TOO_LONG
The receipt external id exceeds the maximum length.
ReceiptSubmitErrorCode.PAYMENTS_UNKNOWN_LOCATOR
No payment endpoint is provisioned with the supplied locator.
Member Of
ReceiptSubmitPayloadError object
ReportFilterMode
No description
enum ReportFilterMode {
AS_OF
DURING
NONE
}
Values
ReportFilterMode.AS_OF
ReportFilterMode.DURING
ReportFilterMode.NONE
Member Of
ReportDefinition object
ReportOutputFormat
No description
enum ReportOutputFormat {
CSV
TXT
XML
}
Values
ReportOutputFormat.CSV
ReportOutputFormat.TXT
ReportOutputFormat.XML
Member Of
ReportDefinitionOutput object
RoleCreateErrorCode
No description
enum RoleCreateErrorCode {
ACCESS_PERMISSION_SET_NOT_FOUND
ACCESS_PERMISSION_SET_NOT_GRANTABLE
ACCESS_ROLE_NAME_ALREADY_EXISTS
}
Values
RoleCreateErrorCode.ACCESS_PERMISSION_SET_NOT_FOUND
No permission set exists with the supplied id.
RoleCreateErrorCode.ACCESS_PERMISSION_SET_NOT_GRANTABLE
The permission set is not held by the subject granting it.
RoleCreateErrorCode.ACCESS_ROLE_NAME_ALREADY_EXISTS
Another role already uses this name.
Member Of
RoleCreatePayloadError object
RolePermissionSetsAddErrorCode
No description
enum RolePermissionSetsAddErrorCode {
ACCESS_PERMISSION_SET_NOT_FOUND
ACCESS_PERMISSION_SET_NOT_GRANTABLE
ACCESS_ROLE_NOT_FOUND
}
Values
RolePermissionSetsAddErrorCode.ACCESS_PERMISSION_SET_NOT_FOUND
No permission set exists with the supplied id.
RolePermissionSetsAddErrorCode.ACCESS_PERMISSION_SET_NOT_GRANTABLE
The permission set is not held by the subject granting it.
RolePermissionSetsAddErrorCode.ACCESS_ROLE_NOT_FOUND
No role exists with the supplied id.
Member Of
RolePermissionSetsAddPayloadError object
RolePermissionSetsRemoveErrorCode
No description
enum RolePermissionSetsRemoveErrorCode {
ACCESS_PERMISSION_SET_NOT_FOUND
ACCESS_ROLE_NOT_FOUND
ACCESS_SUPERUSER_ROLE_PERMISSION_SETS_CANNOT_BE_REMOVED
}
Values
RolePermissionSetsRemoveErrorCode.ACCESS_PERMISSION_SET_NOT_FOUND
No permission set exists with the supplied id.
RolePermissionSetsRemoveErrorCode.ACCESS_ROLE_NOT_FOUND
No role exists with the supplied id.
RolePermissionSetsRemoveErrorCode.ACCESS_SUPERUSER_ROLE_PERMISSION_SETS_CANNOT_BE_REMOVED
Permission sets cannot be removed from the superuser role.
Member Of
RolePermissionSetsRemovePayloadError object
RoleSortBy
No description
enum RoleSortBy {
CREATED_AT
NAME
}
Values
RoleSortBy.CREATED_AT
RoleSortBy.NAME
Member Of
RoleSort input
SortDirection
No description
enum SortDirection {
ASC
DESC
}
Values
SortDirection.ASC
SortDirection.DESC
Member Of
BitcoinPurchaseSort input ● CommitteeSort input ● CreditFacilityProductSort input ● CreditFacilityProposalSort input ● CreditFacilitySort input ● CustodianSort input ● CustomerSort input ● DepositAccountProductSort input ● DepositAccountSort input ● DepositSort input ● DisbursalSort input ● EodProcessSort input ● ExchangeRateProviderSort input ● FiscalYearSort input ● KycProviderSort input ● LiquidationSort input ● NotificationProviderSort input ● ObligationSort input ● PartnerSort input ● PayoutSort input ● PendingCreditFacilitySort input ● PiiErasureProcessSort input ● PipelineRunSort input ● ProspectSort input ● QueryTemplateSort input ● RailSort input ● ReceiptSort input ● RoleSort input ● UserSort input ● WithdrawalSort input
TimeAdvanceToNextEndOfDayErrorCode
No description
enum TimeAdvanceToNextEndOfDayErrorCode {
EOD_PROCESS_FAILED_BLOCKING
EOD_PROCESS_IN_PROGRESS
TIME_ADVANCE_TARGET_NOT_IN_FUTURE
TIME_ADVANCE_UNAVAILABLE
}
Values
TimeAdvanceToNextEndOfDayErrorCode.EOD_PROCESS_FAILED_BLOCKING
The EOD process has a blocking failure.
TimeAdvanceToNextEndOfDayErrorCode.EOD_PROCESS_IN_PROGRESS
The EOD process is still running.
TimeAdvanceToNextEndOfDayErrorCode.TIME_ADVANCE_TARGET_NOT_IN_FUTURE
The advance target must be in the future.
TimeAdvanceToNextEndOfDayErrorCode.TIME_ADVANCE_UNAVAILABLE
The simulated clock cannot be advanced in this environment.
Member Of
TimeAdvanceToNextEndOfDayPayloadError object
TimeAdvanceToNextHourErrorCode
No description
enum TimeAdvanceToNextHourErrorCode {
TIME_ADVANCE_TARGET_NOT_IN_FUTURE
TIME_ADVANCE_UNAVAILABLE
}
Values
TimeAdvanceToNextHourErrorCode.TIME_ADVANCE_TARGET_NOT_IN_FUTURE
The advance target must be in the future.
TimeAdvanceToNextHourErrorCode.TIME_ADVANCE_UNAVAILABLE
The simulated clock cannot be advanced in this environment.
Member Of
TimeAdvanceToNextHourPayloadError object
TimeAutoAdvancePauseErrorCode
No description
enum TimeAutoAdvancePauseErrorCode {
TIME_ADVANCE_UNAVAILABLE
}
Values
TimeAutoAdvancePauseErrorCode.TIME_ADVANCE_UNAVAILABLE
The simulated clock cannot be advanced in this environment.
Member Of
TimeAutoAdvancePausePayloadError object
TimeAutoAdvanceResumeErrorCode
No description
enum TimeAutoAdvanceResumeErrorCode {
TIME_ADVANCE_UNAVAILABLE
}
Values
TimeAutoAdvanceResumeErrorCode.TIME_ADVANCE_UNAVAILABLE
The simulated clock cannot be advanced in this environment.
Member Of
TimeAutoAdvanceResumePayloadError object
UserCreateErrorCode
No description
enum UserCreateErrorCode {
ACCESS_ROLE_NOT_FOUND
ACCESS_SUPERUSER_ROLE_CANNOT_BE_ASSIGNED
ACCESS_USER_EMAIL_ALREADY_EXISTS
EMAIL_INVALID_DOMAIN
EMAIL_LENGTH
EMAIL_NON_ASCII
EMAIL_QUOTED_LOCAL_PART
EMAIL_SYNTAX
EMAIL_UNKNOWN_PUBLIC_SUFFIX
}
Values
UserCreateErrorCode.ACCESS_ROLE_NOT_FOUND
No role exists with the supplied id.
UserCreateErrorCode.ACCESS_SUPERUSER_ROLE_CANNOT_BE_ASSIGNED
The superuser role cannot be assigned to a user.
UserCreateErrorCode.ACCESS_USER_EMAIL_ALREADY_EXISTS
Another user already uses this email.
UserCreateErrorCode.EMAIL_INVALID_DOMAIN
email address domain is not valid
UserCreateErrorCode.EMAIL_LENGTH
email address is empty or exceeds 254 characters
UserCreateErrorCode.EMAIL_NON_ASCII
email address contains non-ASCII characters
UserCreateErrorCode.EMAIL_QUOTED_LOCAL_PART
email address has a quoted local part
UserCreateErrorCode.EMAIL_SYNTAX
email address is malformed
UserCreateErrorCode.EMAIL_UNKNOWN_PUBLIC_SUFFIX
email address domain does not end in a known public suffix
Member Of
UserCreatePayloadError object
UserRoleUpdateErrorCode
No description
enum UserRoleUpdateErrorCode {
ACCESS_ROLE_NOT_FOUND
ACCESS_SUPERUSER_ROLE_CANNOT_BE_ASSIGNED
ACCESS_SUPERUSER_ROLE_CANNOT_BE_REASSIGNED
ACCESS_USER_CANNOT_UPDATE_OWN_ROLE
ACCESS_USER_NOT_FOUND
}
Values
UserRoleUpdateErrorCode.ACCESS_ROLE_NOT_FOUND
No role exists with the supplied id.
UserRoleUpdateErrorCode.ACCESS_SUPERUSER_ROLE_CANNOT_BE_ASSIGNED
The superuser role cannot be assigned to a user.
UserRoleUpdateErrorCode.ACCESS_SUPERUSER_ROLE_CANNOT_BE_REASSIGNED
The superuser cannot be moved off the superuser role.
UserRoleUpdateErrorCode.ACCESS_USER_CANNOT_UPDATE_OWN_ROLE
A user cannot change their own role.
UserRoleUpdateErrorCode.ACCESS_USER_NOT_FOUND
No user exists with the supplied id.
Member Of
UserRoleUpdatePayloadError object
UserSortBy
No description
enum UserSortBy {
CREATED_AT
EMAIL
}
Values
UserSortBy.CREATED_AT
UserSortBy.EMAIL
Member Of
UserSort input
VerificationApproveManuallyErrorCode
No description
enum VerificationApproveManuallyErrorCode {
PARTY_INDIVIDUAL_NOT_FOUND
PARTY_PERSONAL_INFO_REQUIRED
VERIFICATION_ALREADY_DECIDED
VERIFICATION_NOT_FOUND
VERIFICATION_PROVIDER_MISMATCH
}
Values
VerificationApproveManuallyErrorCode.PARTY_INDIVIDUAL_NOT_FOUND
individual party not found
VerificationApproveManuallyErrorCode.PARTY_PERSONAL_INFO_REQUIRED
the personal information is required
VerificationApproveManuallyErrorCode.VERIFICATION_ALREADY_DECIDED
the verification has already been decided
VerificationApproveManuallyErrorCode.VERIFICATION_NOT_FOUND
no verification exists for the party
VerificationApproveManuallyErrorCode.VERIFICATION_PROVIDER_MISMATCH
the verification belongs to a different provider
Member Of
VerificationApproveManuallyPayloadError object
VerificationLinkCreateErrorCode
No description
enum VerificationLinkCreateErrorCode {
VERIFICATION_ALREADY_DECIDED
VERIFICATION_HOSTED_LINK_UNSUPPORTED
VERIFICATION_NOT_FOUND
VERIFICATION_PROVIDER_VERIFICATION_NOT_CREATED
}
Values
VerificationLinkCreateErrorCode.VERIFICATION_ALREADY_DECIDED
the verification has already been decided
VerificationLinkCreateErrorCode.VERIFICATION_HOSTED_LINK_UNSUPPORTED
the verification's provider offers no hosted verification link
VerificationLinkCreateErrorCode.VERIFICATION_NOT_FOUND
no verification exists for the party
VerificationLinkCreateErrorCode.VERIFICATION_PROVIDER_VERIFICATION_NOT_CREATED
the provider verification has not been created yet
Member Of
VerificationLinkCreatePayloadError object
VerificationStatus
No description
enum VerificationStatus {
APPROVED
DECLINED
ON_HOLD
PENDING
}
Values
VerificationStatus.APPROVED
VerificationStatus.DECLINED
VerificationStatus.ON_HOLD
VerificationStatus.PENDING
Member Of
Verification object
WalletNetwork
No description
enum WalletNetwork {
MAINNET
SIGNET
TESTNET3
TESTNET4
}
Values
WalletNetwork.MAINNET
WalletNetwork.SIGNET
WalletNetwork.TESTNET3
WalletNetwork.TESTNET4
Member Of
Wallet object
WalletStatus
Whether a wallet's external-provider record has landed yet.
A wallet is born Provisioning (its id is minted and it is already
linked from a Collateral row) and moves to Active once the
command.custody.initialize-wallet job records the provider's response.
See lana-dev/note-custody-async-wallet-init.md for why the external
call happens outside any transaction.
enum WalletStatus {
ACTIVE
PROVISIONING
}
Values
WalletStatus.ACTIVE
WalletStatus.PROVISIONING
Member Of
Wallet object
WithdrawalInitiateErrorCode
No description
enum WithdrawalInitiateErrorCode {
DEPOSIT_ACCOUNT_CLOSED
DEPOSIT_ACCOUNT_CURRENCY_MISMATCH
DEPOSIT_ACCOUNT_FROZEN
DEPOSIT_ACCOUNT_NOT_FOUND
DEPOSIT_INSUFFICIENT_FUNDS
DEPOSIT_WITHDRAWAL_AMOUNT_EXCEEDS_MAX_PER_TRANSACTION
DEPOSIT_WITHDRAWAL_AMOUNT_MUST_NOT_BE_ZERO
DEPOSIT_WITHDRAWAL_DESTINATION_CURRENCY_MISMATCH
DEPOSIT_WITHDRAWAL_REFERENCE_TAKEN
MONEY_OVERFLOW
MONEY_UNSUPPORTED_CURRENCY
PAYMENTS_DESTINATION_RECEIVES_ANOTHER_FORM
PAYMENTS_NO_MATCHING_RAIL
PAYMENTS_PAYMENT_ENDPOINT_RETIRED
PAYMENTS_PAYOUT_DRAFT_AMOUNT_MUST_NOT_BE_ZERO
PAYMENTS_PAYOUT_DRAFT_CURRENCY_MISMATCH
PAYMENTS_PAYOUT_DRAFT_DESTINATION_REFERENCE_MUST_NOT_BE_EMPTY
}
Values
WithdrawalInitiateErrorCode.DEPOSIT_ACCOUNT_CLOSED
The deposit account is closed.
WithdrawalInitiateErrorCode.DEPOSIT_ACCOUNT_CURRENCY_MISMATCH
The deposit account holds a different currency.
WithdrawalInitiateErrorCode.DEPOSIT_ACCOUNT_FROZEN
The deposit account is frozen.
WithdrawalInitiateErrorCode.DEPOSIT_ACCOUNT_NOT_FOUND
No deposit account exists with the supplied id.
WithdrawalInitiateErrorCode.DEPOSIT_INSUFFICIENT_FUNDS
The deposit account does not hold enough funds for the operation.
WithdrawalInitiateErrorCode.DEPOSIT_WITHDRAWAL_AMOUNT_EXCEEDS_MAX_PER_TRANSACTION
The withdrawal exceeds the maximum per transaction allowed by the account's product terms.
WithdrawalInitiateErrorCode.DEPOSIT_WITHDRAWAL_AMOUNT_MUST_NOT_BE_ZERO
A withdrawal must carry a non-zero amount.
WithdrawalInitiateErrorCode.DEPOSIT_WITHDRAWAL_DESTINATION_CURRENCY_MISMATCH
The withdrawn amount's currency must equal the destination currency.
WithdrawalInitiateErrorCode.DEPOSIT_WITHDRAWAL_REFERENCE_TAKEN
Another withdrawal already uses this reference.
WithdrawalInitiateErrorCode.MONEY_OVERFLOW
The amount exceeds the maximum supported value.
WithdrawalInitiateErrorCode.MONEY_UNSUPPORTED_CURRENCY
The amount uses an unsupported currency.
WithdrawalInitiateErrorCode.PAYMENTS_DESTINATION_RECEIVES_ANOTHER_FORM
The destination receives a different form of the currency than the one sent.
WithdrawalInitiateErrorCode.PAYMENTS_NO_MATCHING_RAIL
No configured rail can carry the requested currency variant.
WithdrawalInitiateErrorCode.PAYMENTS_PAYMENT_ENDPOINT_RETIRED
The payment endpoint is retired and no longer accepts payments.
WithdrawalInitiateErrorCode.PAYMENTS_PAYOUT_DRAFT_AMOUNT_MUST_NOT_BE_ZERO
A payout draft must carry a non-zero amount.
WithdrawalInitiateErrorCode.PAYMENTS_PAYOUT_DRAFT_CURRENCY_MISMATCH
The payout draft amount is not in the currency its destination settles.
WithdrawalInitiateErrorCode.PAYMENTS_PAYOUT_DRAFT_DESTINATION_REFERENCE_MUST_NOT_BE_EMPTY
A payout draft must name a destination reference.
Member Of
WithdrawalInitiatePayloadError object
WithdrawalSortBy
No description
enum WithdrawalSortBy {
AMOUNT
CREATED_AT
PUBLIC_ID
}
Values
WithdrawalSortBy.AMOUNT
WithdrawalSortBy.CREATED_AT
WithdrawalSortBy.PUBLIC_ID
Member Of
WithdrawalSort input
WithdrawalStatus
No description
enum WithdrawalStatus {
CANCELLED
CONFIRMED
DENIED
PENDING_APPROVAL
PENDING_CONFIRMATION
REVERTED
}
Values
WithdrawalStatus.CANCELLED
WithdrawalStatus.CONFIRMED
WithdrawalStatus.DENIED
WithdrawalStatus.PENDING_APPROVAL
WithdrawalStatus.PENDING_CONFIRMATION
WithdrawalStatus.REVERTED
Member Of
Withdrawal object ● WithdrawalFilter input
Input Types
AccountingBaseConfigInput
No description
input AccountingBaseConfigInput {
assetsCode: AccountCode!
costOfRevenueCode: AccountCode!
equityCode: AccountCode!
equityRetainedEarningsGainCode: AccountCode!
equityRetainedEarningsLossCode: AccountCode!
expensesCode: AccountCode!
liabilitiesCode: AccountCode!
revenueCode: AccountCode!
}
Fields
AccountingBaseConfigInput.assetsCode ● AccountCode! non-null scalar
AccountingBaseConfigInput.costOfRevenueCode ● AccountCode! non-null scalar
AccountingBaseConfigInput.equityCode ● AccountCode! non-null scalar
AccountingBaseConfigInput.equityRetainedEarningsGainCode ● AccountCode! non-null scalar
AccountingBaseConfigInput.equityRetainedEarningsLossCode ● AccountCode! non-null scalar
AccountingBaseConfigInput.expensesCode ● AccountCode! non-null scalar
AccountingBaseConfigInput.liabilitiesCode ● AccountCode! non-null scalar
AccountingBaseConfigInput.revenueCode ● AccountCode! non-null scalar
Member Of
ChartOfAccountsInitializeInput input
AccountingCurrencyPolicyConfigureInput
No description
input AccountingCurrencyPolicyConfigureInput {
functional: CurrencyCode!
supported: [CurrencyCode!]!
}
Fields
AccountingCurrencyPolicyConfigureInput.functional ● CurrencyCode! non-null scalar
AccountingCurrencyPolicyConfigureInput.supported ● [CurrencyCode!]! non-null scalar
Member Of
accountingCurrencyPolicyConfigure mutation
ApprovalProcessApproveInput
No description
input ApprovalProcessApproveInput {
approvalProcessId: ApprovalProcessId!
}
Fields
ApprovalProcessApproveInput.approvalProcessId ● ApprovalProcessId! non-null scalar
Member Of
approvalProcessApprove mutation
ApprovalProcessDenyInput
No description
input ApprovalProcessDenyInput {
approvalProcessId: ApprovalProcessId!
reason: String!
}
Fields
ApprovalProcessDenyInput.approvalProcessId ● ApprovalProcessId! non-null scalar
ApprovalProcessDenyInput.reason ● String! non-null scalar
Member Of
approvalProcessDeny mutation
BitcoinInventoryFundInput
No description
input BitcoinInventoryFundInput {
bitcoinAmount: MoneyInput!
carryingValue: MoneyInput!
}
Fields
BitcoinInventoryFundInput.bitcoinAmount ● MoneyInput! non-null input
BitcoinInventoryFundInput.carryingValue ● MoneyInput! non-null input
Member Of
bitcoinInventoryFund mutation
BitcoinPurchaseExecuteInput
No description
input BitcoinPurchaseExecuteInput {
customerId: CustomerId!
destinationBtcDepositAccountId: DepositAccountId!
fiat: MoneyInput!
sourceFiatDepositAccountId: DepositAccountId!
}
Fields
BitcoinPurchaseExecuteInput.customerId ● CustomerId! non-null scalar
BitcoinPurchaseExecuteInput.destinationBtcDepositAccountId ● DepositAccountId! non-null scalar
BitcoinPurchaseExecuteInput.fiat ● MoneyInput! non-null input
BitcoinPurchaseExecuteInput.sourceFiatDepositAccountId ● DepositAccountId! non-null scalar
Member Of
bitcoinPurchaseExecute mutation
BitcoinPurchaseFilter
No description
input BitcoinPurchaseFilter {
customerId: CustomerId
}
Fields
BitcoinPurchaseFilter.customerId ● CustomerId scalar
Member Of
bitcoinPurchases query
BitcoinPurchaseSort
No description
input BitcoinPurchaseSort {
by: BitcoinPurchaseSortBy!
direction: SortDirection!
}
Fields
BitcoinPurchaseSort.by ● BitcoinPurchaseSortBy! non-null enum
BitcoinPurchaseSort.direction ● SortDirection! non-null enum
Member Of
bitcoinPurchases query
BitgoConfigInput
No description
input BitgoConfigInput {
enterpriseId: String!
longLivedToken: Secret!
passphrase: Secret!
testingInstance: Boolean!
webhookSecret: Secret!
webhookUrl: Url!
}
Fields
BitgoConfigInput.enterpriseId ● String! non-null scalar
BitgoConfigInput.longLivedToken ● Secret! non-null scalar
BitgoConfigInput.passphrase ● Secret! non-null scalar
BitgoConfigInput.testingInstance ● Boolean! non-null scalar
BitgoConfigInput.webhookSecret ● Secret! non-null scalar
BitgoConfigInput.webhookUrl ● Url! non-null scalar
Member Of
BitgoCustodianCreateInput input ● CustodianConfigInput input
BitgoCustodianCreateInput
No description
input BitgoCustodianCreateInput {
config: BitgoConfigInput!
name: String!
}
Fields
BitgoCustodianCreateInput.config ● BitgoConfigInput! non-null input
BitgoCustodianCreateInput.name ● String! non-null scalar
Member Of
CustodianCreateInput input
ChartOfAccountsAddChildNodeInput
No description
input ChartOfAccountsAddChildNodeInput {
code: AccountCode!
name: AccountName!
parent: AccountCode!
}
Fields
ChartOfAccountsAddChildNodeInput.code ● AccountCode! non-null scalar
ChartOfAccountsAddChildNodeInput.name ● AccountName! non-null scalar
ChartOfAccountsAddChildNodeInput.parent ● AccountCode! non-null scalar
Member Of
chartOfAccountsAddChildNode mutation
ChartOfAccountsInitializeInput
No description
input ChartOfAccountsInitializeInput {
baseConfig: AccountingBaseConfigInput!
file: Upload!
openingDate: AccountingDate!
}
Fields
ChartOfAccountsInitializeInput.baseConfig ● AccountingBaseConfigInput! non-null input
ChartOfAccountsInitializeInput.file ● Upload! non-null scalar
ChartOfAccountsInitializeInput.openingDate ● AccountingDate! non-null scalar
Member Of
chartOfAccountsInitialize mutation
CircleProviderConfigInput
No description
input CircleProviderConfigInput {
apiKey: Secret!
entitySecret: Secret!
name: PaymentProviderName!
walletSetId: String!
webhookUrl: String!
}
Fields
CircleProviderConfigInput.apiKey ● Secret! non-null scalar
CircleProviderConfigInput.entitySecret ● Secret! non-null scalar
CircleProviderConfigInput.name ● PaymentProviderName! non-null scalar
CircleProviderConfigInput.walletSetId ● String! non-null scalar
CircleProviderConfigInput.webhookUrl ● String! non-null scalar
Public URL Circle posts notifications to, e.g. https://<host>/webhook/rail/circle
Member Of
PaymentProviderConfigInput input ● PaymentProviderCreateInput input
CollateralRecordLiquidationSaleInput
No description
input CollateralRecordLiquidationSaleInput {
liquidationId: LiquidationId!
netProceeds: MoneyInput!
}
Fields
CollateralRecordLiquidationSaleInput.liquidationId ● LiquidationId! non-null scalar
CollateralRecordLiquidationSaleInput.netProceeds ● MoneyInput! non-null input
Member Of
collateralRecordLiquidationSale mutation
CollateralRecordSentToLiquidationInput
No description
input CollateralRecordSentToLiquidationInput {
amount: MoneyInput!
collateralId: CollateralId!
}
Fields
CollateralRecordSentToLiquidationInput.amount ● MoneyInput! non-null input
CollateralRecordSentToLiquidationInput.collateralId ● CollateralId! non-null scalar
Member Of
collateralRecordSentToLiquidation mutation
CollateralUpdateInput
No description
input CollateralUpdateInput {
collateral: MoneyInput!
collateralId: CollateralId!
effective: AccountingDate!
}
Fields
CollateralUpdateInput.collateral ● MoneyInput! non-null input
CollateralUpdateInput.collateralId ● CollateralId! non-null scalar
CollateralUpdateInput.effective ● AccountingDate! non-null scalar
Member Of
collateralUpdate mutation
CommitteeCreateInput
No description
input CommitteeCreateInput {
memberUserIds: [UserId!]!
name: String!
}
Fields
CommitteeCreateInput.memberUserIds ● [UserId!]! non-null scalar
CommitteeCreateInput.name ● String! non-null scalar
Member Of
committeeCreate mutation
CommitteeSort
No description
input CommitteeSort {
by: CommitteeSortBy!
direction: SortDirection!
}
Fields
CommitteeSort.by ● CommitteeSortBy! non-null enum
CommitteeSort.direction ● SortDirection! non-null enum
Member Of
committees query
CommitteeUserAddInput
No description
input CommitteeUserAddInput {
committeeId: CommitteeId!
userId: UserId!
}
Fields
CommitteeUserAddInput.committeeId ● CommitteeId! non-null scalar
CommitteeUserAddInput.userId ● UserId! non-null scalar
Member Of
committeeUserAdd mutation
CommitteeUserRemoveInput
No description
input CommitteeUserRemoveInput {
committeeId: CommitteeId!
userId: UserId!
}
Fields
CommitteeUserRemoveInput.committeeId ● CommitteeId! non-null scalar
CommitteeUserRemoveInput.userId ● UserId! non-null scalar
Member Of
committeeUserRemove mutation
CreditAccountingIntegrationConfigureInput
No description
input CreditAccountingIntegrationConfigureInput {
income: CreditIncomeParentsInput!
lendingIntents: [CreditLendingIntentIntegrationInput!]!
omnibus: CreditOmnibusParentsInput!
operationalSummary: CreditOperationalSummaryParentsInput!
paymentHoldingParentCode: AccountCode!
}
Fields
CreditAccountingIntegrationConfigureInput.income ● CreditIncomeParentsInput! non-null input
CreditAccountingIntegrationConfigureInput.lendingIntents ● [CreditLendingIntentIntegrationInput!]! non-null input
CreditAccountingIntegrationConfigureInput.omnibus ● CreditOmnibusParentsInput! non-null input
CreditAccountingIntegrationConfigureInput.operationalSummary ● CreditOperationalSummaryParentsInput! non-null input
CreditAccountingIntegrationConfigureInput.paymentHoldingParentCode ● AccountCode! non-null scalar
Member Of
creditAccountingIntegrationConfigure mutation
CreditCurrencyPolicyConfigureInput
No description
input CreditCurrencyPolicyConfigureInput {
functional: CurrencyCode!
supportedCollateral: [CurrencyCode!]!
supportedFacility: [CurrencyCode!]!
}
Fields
CreditCurrencyPolicyConfigureInput.functional ● CurrencyCode! non-null scalar
CreditCurrencyPolicyConfigureInput.supportedCollateral ● [CurrencyCode!]! non-null scalar
CreditCurrencyPolicyConfigureInput.supportedFacility ● [CurrencyCode!]! non-null scalar
Member Of
creditCurrencyPolicyConfigure mutation
CreditCustomerIntegrationGroupInput
No description
input CreditCustomerIntegrationGroupInput {
customerTypes: [CustomerType!]!
functional: CreditReceivableParentsInput!
nonFunctional: CreditReceivableParentsInput!
}
Fields
CreditCustomerIntegrationGroupInput.customerTypes ● [CustomerType!]! non-null enum
CreditCustomerIntegrationGroupInput.functional ● CreditReceivableParentsInput! non-null input
CreditCustomerIntegrationGroupInput.nonFunctional ● CreditReceivableParentsInput! non-null input
Member Of
CreditLendingIntentIntegrationInput input
CreditDefaultedReceivableParentsInput
No description
input CreditDefaultedReceivableParentsInput {
disbursedParentCode: AccountCode!
interestParentCode: AccountCode!
}
Fields
CreditDefaultedReceivableParentsInput.disbursedParentCode ● AccountCode! non-null scalar
CreditDefaultedReceivableParentsInput.interestParentCode ● AccountCode! non-null scalar
Member Of
CreditDefaultedReceivablesInput input
CreditDefaultedReceivablesInput
No description
input CreditDefaultedReceivablesInput {
functional: CreditDefaultedReceivableParentsInput!
nonFunctional: CreditDefaultedReceivableParentsInput!
}
Fields
CreditDefaultedReceivablesInput.functional ● CreditDefaultedReceivableParentsInput! non-null input
CreditDefaultedReceivablesInput.nonFunctional ● CreditDefaultedReceivableParentsInput! non-null input
Member Of
CreditLendingIntentIntegrationInput input
CreditFacilityAgreementDownloadLinksGenerateInput
No description
input CreditFacilityAgreementDownloadLinksGenerateInput {
creditFacilityAgreementId: CreditFacilityAgreementId!
}
Fields
CreditFacilityAgreementDownloadLinksGenerateInput.creditFacilityAgreementId ● CreditFacilityAgreementId! non-null scalar
Member Of
creditFacilityAgreementDownloadLinkGenerate mutation
CreditFacilityAgreementGenerateInput
No description
input CreditFacilityAgreementGenerateInput {
creditFacilityId: CreditFacilityId!
}
Fields
CreditFacilityAgreementGenerateInput.creditFacilityId ● CreditFacilityId! non-null scalar
Member Of
creditFacilityAgreementGenerate mutation
CreditFacilityCompleteInput
No description
input CreditFacilityCompleteInput {
creditFacilityId: CreditFacilityId!
}
Fields
CreditFacilityCompleteInput.creditFacilityId ● CreditFacilityId! non-null scalar
Member Of
creditFacilityComplete mutation
CreditFacilityDisbursalInitiateInput
No description
input CreditFacilityDisbursalInitiateInput {
amount: MoneyInput!
creditFacilityId: CreditFacilityId!
}
Fields
CreditFacilityDisbursalInitiateInput.amount ● MoneyInput! non-null input
CreditFacilityDisbursalInitiateInput.creditFacilityId ● CreditFacilityId! non-null scalar
Member Of
creditFacilityDisbursalInitiate mutation
CreditFacilityFilter
No description
input CreditFacilityFilter {
collateralizationState: CollateralizationState
hasDueObligations: Boolean
partnerId: PartnerId
productId: CreditFacilityProductId
status: CreditFacilityStatus
}
Fields
CreditFacilityFilter.collateralizationState ● CollateralizationState enum
CreditFacilityFilter.hasDueObligations ● Boolean scalar
CreditFacilityFilter.partnerId ● PartnerId scalar
CreditFacilityFilter.productId ● CreditFacilityProductId scalar
CreditFacilityFilter.status ● CreditFacilityStatus enum
Member Of
creditFacilities query
CreditFacilityPartialPaymentRecordInput
No description
input CreditFacilityPartialPaymentRecordInput {
amount: MoneyInput!
creditFacilityId: CreditFacilityId!
}
Fields
CreditFacilityPartialPaymentRecordInput.amount ● MoneyInput! non-null input
CreditFacilityPartialPaymentRecordInput.creditFacilityId ● CreditFacilityId! non-null scalar
Member Of
creditFacilityPartialPaymentRecord mutation
CreditFacilityPartialPaymentWithDateRecordInput
No description
input CreditFacilityPartialPaymentWithDateRecordInput {
amount: MoneyInput!
creditFacilityId: CreditFacilityId!
effective: AccountingDate!
}
Fields
CreditFacilityPartialPaymentWithDateRecordInput.amount ● MoneyInput! non-null input
CreditFacilityPartialPaymentWithDateRecordInput.creditFacilityId ● CreditFacilityId! non-null scalar
CreditFacilityPartialPaymentWithDateRecordInput.effective ● AccountingDate! non-null scalar
Member Of
creditFacilityPartialPaymentWithDateRecord mutation
CreditFacilityProductCreateInput
No description
input CreditFacilityProductCreateInput {
customerType: CustomerType!
name: String!
partnerId: PartnerId
supportedLendingIntents: [LendingIntent!]!
terms: TermsInput!
}
Fields
CreditFacilityProductCreateInput.customerType ● CustomerType! non-null enum
The single customer type this product addresses.
CreditFacilityProductCreateInput.name ● String! non-null scalar
CreditFacilityProductCreateInput.partnerId ● PartnerId scalar
CreditFacilityProductCreateInput.supportedLendingIntents ● [LendingIntent!]! non-null enum
CreditFacilityProductCreateInput.terms ● TermsInput! non-null input
Member Of
creditFacilityProductCreate mutation
CreditFacilityProductFilter
No description
input CreditFacilityProductFilter {
customerType: CustomerType
partnerId: PartnerId
status: CreditFacilityProductStatus
}
Fields
CreditFacilityProductFilter.customerType ● CustomerType enum
CreditFacilityProductFilter.partnerId ● PartnerId scalar
CreditFacilityProductFilter.status ● CreditFacilityProductStatus enum
Member Of
creditFacilityProducts query
CreditFacilityProductSort
No description
input CreditFacilityProductSort {
by: CreditFacilityProductSortBy!
direction: SortDirection!
}
Fields
CreditFacilityProductSort.by ● CreditFacilityProductSortBy! non-null enum
CreditFacilityProductSort.direction ● SortDirection! non-null enum
Member Of
creditFacilityProducts query
CreditFacilityProductUpdateStatusInput
No description
input CreditFacilityProductUpdateStatusInput {
creditFacilityProductId: CreditFacilityProductId!
status: CreditFacilityProductStatus!
}
Fields
CreditFacilityProductUpdateStatusInput.creditFacilityProductId ● CreditFacilityProductId! non-null scalar
CreditFacilityProductUpdateStatusInput.status ● CreditFacilityProductStatus! non-null enum
Member Of
creditFacilityProductUpdateStatus mutation
CreditFacilityProductUpdateTermsInput
No description
input CreditFacilityProductUpdateTermsInput {
creditFacilityProductId: CreditFacilityProductId!
expectedProductTermsVersion: Int!
terms: TermsInput!
}
Fields
CreditFacilityProductUpdateTermsInput.creditFacilityProductId ● CreditFacilityProductId! non-null scalar
CreditFacilityProductUpdateTermsInput.expectedProductTermsVersion ● Int! non-null scalar
CreditFacilityProductUpdateTermsInput.terms ● TermsInput! non-null input
Member Of
creditFacilityProductUpdateTerms mutation
CreditFacilityProposalCreateInput
No description
input CreditFacilityProposalCreateInput {
collateralCurrencyCode: CurrencyCode!
custodianId: CustodianId!
customerId: CustomerId!
expectedProductTermsVersion: Int!
facility: MoneyInput!
productId: CreditFacilityProductId!
termsAlterations: CreditFacilityTermsAlterationsInput!
}
Fields
CreditFacilityProposalCreateInput.collateralCurrencyCode ● CurrencyCode! non-null scalar
CreditFacilityProposalCreateInput.custodianId ● CustodianId! non-null scalar
CreditFacilityProposalCreateInput.customerId ● CustomerId! non-null scalar
CreditFacilityProposalCreateInput.expectedProductTermsVersion ● Int! non-null scalar
CreditFacilityProposalCreateInput.facility ● MoneyInput! non-null input
CreditFacilityProposalCreateInput.productId ● CreditFacilityProductId! non-null scalar
CreditFacilityProposalCreateInput.termsAlterations ● CreditFacilityTermsAlterationsInput! non-null input
Member Of
creditFacilityProposalCreate mutation
CreditFacilityProposalCustomerApprovalConcludeInput
No description
input CreditFacilityProposalCustomerApprovalConcludeInput {
approved: Boolean!
creditFacilityProposalId: CreditFacilityProposalId!
}
Fields
CreditFacilityProposalCustomerApprovalConcludeInput.approved ● Boolean! non-null scalar
CreditFacilityProposalCustomerApprovalConcludeInput.creditFacilityProposalId ● CreditFacilityProposalId! non-null scalar
Member Of
creditFacilityProposalCustomerApprovalConclude mutation
CreditFacilityProposalFilter
No description
input CreditFacilityProposalFilter {
partnerId: PartnerId
productId: CreditFacilityProductId
status: CreditFacilityProposalStatus
}
Fields
CreditFacilityProposalFilter.partnerId ● PartnerId scalar
CreditFacilityProposalFilter.productId ● CreditFacilityProductId scalar
CreditFacilityProposalFilter.status ● CreditFacilityProposalStatus enum
Member Of
creditFacilityProposals query
CreditFacilityProposalSort
No description
input CreditFacilityProposalSort {
by: CreditFacilityProposalSortBy!
direction: SortDirection!
}
Fields
CreditFacilityProposalSort.by ● CreditFacilityProposalSortBy! non-null enum
CreditFacilityProposalSort.direction ● SortDirection! non-null enum
Member Of
creditFacilityProposals query
CreditFacilitySort
No description
input CreditFacilitySort {
by: CreditFacilitySortBy!
direction: SortDirection!
}
Fields
CreditFacilitySort.by ● CreditFacilitySortBy! non-null enum
CreditFacilitySort.direction ● SortDirection! non-null enum
Member Of
creditFacilities query
CreditFacilityTermsAlterationsInput
No description
input CreditFacilityTermsAlterationsInput {
accrualCycleInterval: InterestInterval
annualRate: AnnualRatePct
disbursalPolicy: DisbursalPolicy
duration: DurationInput
initialLtvLimit: LtvPctValue
interestDueDurationFromAccrual: DurationInput
liquidationLtvLimit: LtvPctValue
marginCallLtvLimit: LtvPctValue
obligationDefaultedDurationFromDue: DurationInput
obligationLiquidationDurationFromDue: DurationInput
obligationOverdueDurationFromDue: DurationInput
oneTimeFeeRate: OneTimeFeeRatePct
}
Fields
CreditFacilityTermsAlterationsInput.accrualCycleInterval ● InterestInterval enum
CreditFacilityTermsAlterationsInput.annualRate ● AnnualRatePct scalar
CreditFacilityTermsAlterationsInput.disbursalPolicy ● DisbursalPolicy enum
CreditFacilityTermsAlterationsInput.duration ● DurationInput input
CreditFacilityTermsAlterationsInput.initialLtvLimit ● LtvPctValue scalar
CreditFacilityTermsAlterationsInput.interestDueDurationFromAccrual ● DurationInput input
CreditFacilityTermsAlterationsInput.liquidationLtvLimit ● LtvPctValue scalar
CreditFacilityTermsAlterationsInput.marginCallLtvLimit ● LtvPctValue scalar
CreditFacilityTermsAlterationsInput.obligationDefaultedDurationFromDue ● DurationInput input
CreditFacilityTermsAlterationsInput.obligationLiquidationDurationFromDue ● DurationInput input
CreditFacilityTermsAlterationsInput.obligationOverdueDurationFromDue ● DurationInput input
CreditFacilityTermsAlterationsInput.oneTimeFeeRate ● OneTimeFeeRatePct scalar
Member Of
CreditFacilityProposalCreateInput input
CreditIncomeParentsInput
No description
input CreditIncomeParentsInput {
feeParentCode: AccountCode!
interestParentCode: AccountCode!
}
Fields
CreditIncomeParentsInput.feeParentCode ● AccountCode! non-null scalar
CreditIncomeParentsInput.interestParentCode ● AccountCode! non-null scalar
Member Of
CreditAccountingIntegrationConfigureInput input
CreditLendingIntentIntegrationInput
No description
input CreditLendingIntentIntegrationInput {
customerIntegrationGroups: [CreditCustomerIntegrationGroupInput!]!
defaultedReceivables: CreditDefaultedReceivablesInput!
lendingIntent: LendingIntent!
}
Fields
CreditLendingIntentIntegrationInput.customerIntegrationGroups ● [CreditCustomerIntegrationGroupInput!]! non-null input
CreditLendingIntentIntegrationInput.defaultedReceivables ● CreditDefaultedReceivablesInput! non-null input
CreditLendingIntentIntegrationInput.lendingIntent ● LendingIntent! non-null enum
Member Of
CreditAccountingIntegrationConfigureInput input
CreditOmnibusParentsInput
No description
input CreditOmnibusParentsInput {
collateralParentCode: AccountCode!
facilityParentCode: AccountCode!
interestAddedToObligationsParentCode: AccountCode!
liquidationProceedsParentCode: AccountCode!
paymentsMadeParentCode: AccountCode!
}
Fields
CreditOmnibusParentsInput.collateralParentCode ● AccountCode! non-null scalar
CreditOmnibusParentsInput.facilityParentCode ● AccountCode! non-null scalar
CreditOmnibusParentsInput.interestAddedToObligationsParentCode ● AccountCode! non-null scalar
CreditOmnibusParentsInput.liquidationProceedsParentCode ● AccountCode! non-null scalar
CreditOmnibusParentsInput.paymentsMadeParentCode ● AccountCode! non-null scalar
Member Of
CreditAccountingIntegrationConfigureInput input
CreditOperationalSummaryParentsInput
No description
input CreditOperationalSummaryParentsInput {
collateralInLiquidationParentCode: AccountCode!
collateralParentCode: AccountCode!
facilityRemainingParentCode: AccountCode!
proceedsFromLiquidationParentCode: AccountCode!
uncoveredOutstandingParentCode: AccountCode!
}
Fields
CreditOperationalSummaryParentsInput.collateralInLiquidationParentCode ● AccountCode! non-null scalar
CreditOperationalSummaryParentsInput.collateralParentCode ● AccountCode! non-null scalar
CreditOperationalSummaryParentsInput.facilityRemainingParentCode ● AccountCode! non-null scalar
CreditOperationalSummaryParentsInput.proceedsFromLiquidationParentCode ● AccountCode! non-null scalar
CreditOperationalSummaryParentsInput.uncoveredOutstandingParentCode ● AccountCode! non-null scalar
Member Of
CreditAccountingIntegrationConfigureInput input
CreditReceivableParentsInput
No description
input CreditReceivableParentsInput {
longTermDisbursedParentCode: AccountCode!
longTermInterestParentCode: AccountCode!
overdueDisbursedParentCode: AccountCode!
overdueInterestParentCode: AccountCode!
shortTermDisbursedParentCode: AccountCode!
shortTermInterestParentCode: AccountCode!
}
Fields
CreditReceivableParentsInput.longTermDisbursedParentCode ● AccountCode! non-null scalar
CreditReceivableParentsInput.longTermInterestParentCode ● AccountCode! non-null scalar
CreditReceivableParentsInput.overdueDisbursedParentCode ● AccountCode! non-null scalar
CreditReceivableParentsInput.overdueInterestParentCode ● AccountCode! non-null scalar
CreditReceivableParentsInput.shortTermDisbursedParentCode ● AccountCode! non-null scalar
CreditReceivableParentsInput.shortTermInterestParentCode ● AccountCode! non-null scalar
Member Of
CreditCustomerIntegrationGroupInput input
CurrencyVariantInput
No description
input CurrencyVariantInput {
code: CurrencyCode!
qualifier: String!
}
Fields
CurrencyVariantInput.code ● CurrencyCode! non-null scalar
CurrencyVariantInput.qualifier ● String! non-null scalar
Member Of
RailCreateInput input
CustodianConfigInput
No description
input CustodianConfigInput {
bitgo: BitgoConfigInput
komainu: KomainuConfigInput
}
Fields
CustodianConfigInput.bitgo ● BitgoConfigInput input
CustodianConfigInput.komainu ● KomainuConfigInput input
Member Of
CustodianConfigUpdateInput input
CustodianConfigUpdateInput
No description
input CustodianConfigUpdateInput {
config: CustodianConfigInput!
custodianId: CustodianId!
}
Fields
CustodianConfigUpdateInput.config ● CustodianConfigInput! non-null input
CustodianConfigUpdateInput.custodianId ● CustodianId! non-null scalar
Member Of
custodianConfigUpdate mutation
CustodianCreateInput
No description
input CustodianCreateInput {
bitgo: BitgoCustodianCreateInput
komainu: KomainuCustodianCreateInput
manual: ManualCustodianCreateInput
}
Fields
CustodianCreateInput.bitgo ● BitgoCustodianCreateInput input
CustodianCreateInput.komainu ● KomainuCustodianCreateInput input
CustodianCreateInput.manual ● ManualCustodianCreateInput input
Member Of
custodianCreate mutation
CustodianSort
No description
input CustodianSort {
by: CustodianSortBy!
direction: SortDirection!
}
Fields
CustodianSort.by ● CustodianSortBy! non-null enum
CustodianSort.direction ● SortDirection! non-null enum
Member Of
custodians query
CustomerCloseInput
No description
input CustomerCloseInput {
customerId: CustomerId!
reason: DecisionReason
}
Fields
CustomerCloseInput.customerId ● CustomerId! non-null scalar
CustomerCloseInput.reason ● DecisionReason scalar
Member Of
customerClose mutation
CustomerDocumentArchiveInput
No description
input CustomerDocumentArchiveInput {
customerDocumentId: CustomerDocumentId!
}
Fields
CustomerDocumentArchiveInput.customerDocumentId ● CustomerDocumentId! non-null scalar
Member Of
customerDocumentArchive mutation
CustomerDocumentCreateInlineInput
Creates a customer document from inline UTF-8 text instead of an upload.
The upload-based customerDocumentCreate requires a multipart request,
which channels that speak plain JSON variables (the MCP tool surface)
cannot produce. This variant carries the document body as a string and
reuses the same use case, so both entry points share authorization,
audit, and storage behavior.
input CustomerDocumentCreateInlineInput {
content: String!
contentType: String
customerId: CustomerId!
filename: String!
}
Fields
CustomerDocumentCreateInlineInput.content ● String! non-null scalar
Document body as UTF-8 text. Meant for agent- or API-authored text documents (memos, narratives); binary content needs the upload mutation. Secret in traces: the body carries investigation narratives naming customers, accounts, and transactions.
CustomerDocumentCreateInlineInput.contentType ● String scalar
MIME type of content. Defaults to text/markdown when omitted.
CustomerDocumentCreateInlineInput.customerId ● CustomerId! non-null scalar
CustomerDocumentCreateInlineInput.filename ● String! non-null scalar
Name the document is stored under, including its extension.
Member Of
customerDocumentCreateInline mutation
CustomerDocumentCreateInput
No description
input CustomerDocumentCreateInput {
customerId: CustomerId!
file: Upload!
}
Fields
CustomerDocumentCreateInput.customerId ● CustomerId! non-null scalar
CustomerDocumentCreateInput.file ● Upload! non-null scalar
Member Of
customerDocumentCreate mutation
CustomerDocumentDeleteInput
No description
input CustomerDocumentDeleteInput {
customerDocumentId: CustomerDocumentId!
}
Fields
CustomerDocumentDeleteInput.customerDocumentId ● CustomerDocumentId! non-null scalar
Member Of
customerDocumentDelete mutation
CustomerDocumentDownloadLinksGenerateInput
No description
input CustomerDocumentDownloadLinksGenerateInput {
customerDocumentId: CustomerDocumentId!
}
Fields
CustomerDocumentDownloadLinksGenerateInput.customerDocumentId ● CustomerDocumentId! non-null scalar
Member Of
customerDocumentDownloadLinkGenerate mutation
CustomerFilter
No description
input CustomerFilter {
customerType: CustomerType
partnerId: PartnerId
status: CustomerStatus
}
Fields
CustomerFilter.customerType ● CustomerType enum
CustomerFilter.partnerId ● PartnerId scalar
CustomerFilter.status ● CustomerStatus enum
Member Of
customers query
CustomerFreezeInput
No description
input CustomerFreezeInput {
customerId: CustomerId!
reason: DecisionReason
}
Fields
CustomerFreezeInput.customerId ● CustomerId! non-null scalar
CustomerFreezeInput.reason ● DecisionReason scalar
Member Of
customerFreeze mutation
CustomerNoteCreateInput
No description
input CustomerNoteCreateInput {
body: String!
customerId: CustomerId!
}
Fields
CustomerNoteCreateInput.body ● String! non-null scalar
CustomerNoteCreateInput.customerId ● CustomerId! non-null scalar
Member Of
customerNoteCreate mutation
CustomerNoteUpdateInput
No description
input CustomerNoteUpdateInput {
body: String!
noteId: NoteId!
}
Fields
CustomerNoteUpdateInput.body ● String! non-null scalar
CustomerNoteUpdateInput.noteId ● NoteId! non-null scalar
Member Of
customerNoteUpdate mutation
CustomerSort
No description
input CustomerSort {
by: CustomerSortBy!
direction: SortDirection!
}
Fields
CustomerSort.by ● CustomerSortBy! non-null enum
CustomerSort.direction ● SortDirection! non-null enum
Member Of
customers query
CustomerUnfreezeInput
No description
input CustomerUnfreezeInput {
customerId: CustomerId!
reason: DecisionReason
}
Fields
CustomerUnfreezeInput.customerId ● CustomerId! non-null scalar
CustomerUnfreezeInput.reason ● DecisionReason scalar
Member Of
customerUnfreeze mutation
DateRangeInput
No description
input DateRangeInput {
from: Date!
until: Date!
}
Fields
DateRangeInput.from ● Date! non-null scalar
DateRangeInput.until ● Date! non-null scalar
Member Of
profitAndLossStatement query ● ReportFileDownloadLinkGenerateInput input ● trialBalance query
DepositAccountCloseInput
No description
input DepositAccountCloseInput {
depositAccountId: DepositAccountId!
}
Fields
DepositAccountCloseInput.depositAccountId ● DepositAccountId! non-null scalar
Member Of
depositAccountClose mutation
DepositAccountCreateFromProductInput
No description
input DepositAccountCreateFromProductInput {
customerId: CustomerId!
depositAccountProductId: DepositAccountProductId!
expectedProductTermsVersion: Int!
}
Fields
DepositAccountCreateFromProductInput.customerId ● CustomerId! non-null scalar
DepositAccountCreateFromProductInput.depositAccountProductId ● DepositAccountProductId! non-null scalar
DepositAccountCreateFromProductInput.expectedProductTermsVersion ● Int! non-null scalar
Member Of
depositAccountCreateFromProduct mutation
DepositAccountFilter
No description
input DepositAccountFilter {
activity: DepositAccountActivity
currency: CurrencyCode
partnerId: PartnerId
productId: DepositAccountProductId
status: DepositAccountStatus
}
Fields
DepositAccountFilter.activity ● DepositAccountActivity enum
DepositAccountFilter.currency ● CurrencyCode scalar
DepositAccountFilter.partnerId ● PartnerId scalar
DepositAccountFilter.productId ● DepositAccountProductId scalar
DepositAccountFilter.status ● DepositAccountStatus enum
Member Of
depositAccounts query
DepositAccountFreezeInput
No description
input DepositAccountFreezeInput {
depositAccountId: DepositAccountId!
}
Fields
DepositAccountFreezeInput.depositAccountId ● DepositAccountId! non-null scalar
Member Of
depositAccountFreeze mutation
DepositAccountingIntegrationConfigureInput
No description
input DepositAccountingIntegrationConfigureInput {
omnibus: DepositOmnibusIntegrationInput!
productTypes: [DepositProductTypeIntegrationInput!]!
}
Fields
DepositAccountingIntegrationConfigureInput.omnibus ● DepositOmnibusIntegrationInput! non-null input
DepositAccountingIntegrationConfigureInput.productTypes ● [DepositProductTypeIntegrationInput!]! non-null input
Member Of
depositAccountingIntegrationConfigure mutation
DepositAccountProductCreateInput
No description
input DepositAccountProductCreateInput {
currencyCode: CurrencyCode!
customerType: CustomerType!
name: DepositAccountProductName!
partnerId: PartnerId
productType: DepositAccountProductType!
terms: DepositAccountProductTermsInput
}
Fields
DepositAccountProductCreateInput.currencyCode ● CurrencyCode! non-null scalar
DepositAccountProductCreateInput.customerType ● CustomerType! non-null enum
DepositAccountProductCreateInput.name ● DepositAccountProductName! non-null scalar
DepositAccountProductCreateInput.partnerId ● PartnerId scalar
DepositAccountProductCreateInput.productType ● DepositAccountProductType! non-null enum
DepositAccountProductCreateInput.terms ● DepositAccountProductTermsInput input
Member Of
depositAccountProductCreate mutation
DepositAccountProductFilter
No description
input DepositAccountProductFilter {
currencyCode: CurrencyCode
customerType: CustomerType
partnerId: PartnerId
status: DepositAccountProductStatus
}
Fields
DepositAccountProductFilter.currencyCode ● CurrencyCode scalar
DepositAccountProductFilter.customerType ● CustomerType enum
DepositAccountProductFilter.partnerId ● PartnerId scalar
DepositAccountProductFilter.status ● DepositAccountProductStatus enum
Member Of
depositAccountProducts query
DepositAccountProductSort
No description
input DepositAccountProductSort {
by: DepositAccountProductSortBy!
direction: SortDirection!
}
Fields
DepositAccountProductSort.by ● DepositAccountProductSortBy! non-null enum
DepositAccountProductSort.direction ● SortDirection! non-null enum
Member Of
depositAccountProducts query
DepositAccountProductTermsInput
No description
input DepositAccountProductTermsInput {
maxWithdrawalAmountPerTransaction: MoneyInput
}
Fields
DepositAccountProductTermsInput.maxWithdrawalAmountPerTransaction ● MoneyInput input
Member Of
DepositAccountProductCreateInput input ● DepositAccountProductUpdateTermsInput input
DepositAccountProductUpdateStatusInput
No description
input DepositAccountProductUpdateStatusInput {
depositAccountProductId: DepositAccountProductId!
status: DepositAccountProductStatus!
}
Fields
DepositAccountProductUpdateStatusInput.depositAccountProductId ● DepositAccountProductId! non-null scalar
DepositAccountProductUpdateStatusInput.status ● DepositAccountProductStatus! non-null enum
Member Of
depositAccountProductUpdateStatus mutation
DepositAccountProductUpdateTermsInput
No description
input DepositAccountProductUpdateTermsInput {
depositAccountProductId: DepositAccountProductId!
expectedProductTermsVersion: Int!
terms: DepositAccountProductTermsInput!
}
Fields
DepositAccountProductUpdateTermsInput.depositAccountProductId ● DepositAccountProductId! non-null scalar
DepositAccountProductUpdateTermsInput.expectedProductTermsVersion ● Int! non-null scalar
DepositAccountProductUpdateTermsInput.terms ● DepositAccountProductTermsInput! non-null input
Member Of
depositAccountProductUpdateTerms mutation
DepositAccountSort
No description
input DepositAccountSort {
by: DepositAccountSortBy!
direction: SortDirection!
}
Fields
DepositAccountSort.by ● DepositAccountSortBy! non-null enum
DepositAccountSort.direction ● SortDirection! non-null enum
Member Of
depositAccounts query
DepositAccountUnfreezeInput
No description
input DepositAccountUnfreezeInput {
depositAccountId: DepositAccountId!
}
Fields
DepositAccountUnfreezeInput.depositAccountId ● DepositAccountId! non-null scalar
Member Of
depositAccountUnfreeze mutation
DepositBalanceStateParentsInput
No description
input DepositBalanceStateParentsInput {
activeParentCode: AccountCode!
frozenParentCode: AccountCode!
}
Fields
DepositBalanceStateParentsInput.activeParentCode ● AccountCode! non-null scalar
DepositBalanceStateParentsInput.frozenParentCode ● AccountCode! non-null scalar
Member Of
DepositCustomerIntegrationGroupInput input
DepositCurrencyPolicyConfigureInput
No description
input DepositCurrencyPolicyConfigureInput {
functional: CurrencyCode!
supported: [CurrencyCode!]!
}
Fields
DepositCurrencyPolicyConfigureInput.functional ● CurrencyCode! non-null scalar
DepositCurrencyPolicyConfigureInput.supported ● [CurrencyCode!]! non-null scalar
Member Of
depositCurrencyPolicyConfigure mutation
DepositCustomerIntegrationGroupInput
No description
input DepositCustomerIntegrationGroupInput {
customerTypes: [CustomerType!]!
functional: DepositBalanceStateParentsInput!
nonFunctional: DepositBalanceStateParentsInput!
}
Fields
DepositCustomerIntegrationGroupInput.customerTypes ● [CustomerType!]! non-null enum
DepositCustomerIntegrationGroupInput.functional ● DepositBalanceStateParentsInput! non-null input
DepositCustomerIntegrationGroupInput.nonFunctional ● DepositBalanceStateParentsInput! non-null input
Member Of
DepositProductTypeIntegrationInput input
DepositFilter
No description
input DepositFilter {
status: DepositStatus
}
Fields
DepositFilter.status ● DepositStatus enum
Member Of
deposits query
DepositOmnibusIntegrationInput
No description
input DepositOmnibusIntegrationInput {
functionalParentCode: AccountCode!
nonFunctionalParentCode: AccountCode!
}
Fields
DepositOmnibusIntegrationInput.functionalParentCode ● AccountCode! non-null scalar
DepositOmnibusIntegrationInput.nonFunctionalParentCode ● AccountCode! non-null scalar
Member Of
DepositAccountingIntegrationConfigureInput input
DepositProductTypeIntegrationInput
No description
input DepositProductTypeIntegrationInput {
customerIntegrationGroups: [DepositCustomerIntegrationGroupInput!]!
productType: DepositAccountProductType!
}
Fields
DepositProductTypeIntegrationInput.customerIntegrationGroups ● [DepositCustomerIntegrationGroupInput!]! non-null input
DepositProductTypeIntegrationInput.productType ● DepositAccountProductType! non-null enum
Member Of
DepositAccountingIntegrationConfigureInput input
DepositRevertInput
No description
input DepositRevertInput {
depositId: DepositId!
}
Fields
DepositRevertInput.depositId ● DepositId! non-null scalar
Member Of
depositRevert mutation
DepositSort
No description
input DepositSort {
by: DepositSortBy!
direction: SortDirection!
}
Fields
DepositSort.by ● DepositSortBy! non-null enum
DepositSort.direction ● SortDirection! non-null enum
Member Of
deposits query
DestinationInfoInput
No description
input DestinationInfoInput {
reference: String!
}
Fields
DestinationInfoInput.reference ● String! non-null scalar
The destination reference to submit the receipt for. For the manual +
deposit case, this is the deposit account's payment endpoint id,
which resolves to a provisioned payment-endpoint locator at
submission. A reference that matches no provisioned locator is
rejected (PaymentEndpointNotFound).
Member Of
ReceiptSubmitInput input
DisbursalFilter
No description
input DisbursalFilter {
status: DisbursalStatus
}
Fields
DisbursalFilter.status ● DisbursalStatus enum
Member Of
disbursals query
DisbursalSort
No description
input DisbursalSort {
by: DisbursalSortBy!
direction: SortDirection!
}
Fields
DisbursalSort.by ● DisbursalSortBy! non-null enum
DisbursalSort.direction ● SortDirection! non-null enum
Member Of
disbursals query
DomainConfigUpdateInput
No description
input DomainConfigUpdateInput {
domainConfigId: DomainConfigId!
value: Json!
}
Fields
DomainConfigUpdateInput.domainConfigId ● DomainConfigId! non-null scalar
DomainConfigUpdateInput.value ● Json! non-null scalar
Member Of
domainConfigUpdate mutation
DurationInput
No description
input DurationInput {
period: Period!
units: Int!
}
Fields
DurationInput.period ● Period! non-null enum
DurationInput.units ● Int! non-null scalar
Member Of
CreditFacilityTermsAlterationsInput input ● TermsInput input
DwReadonlyQueryExportLinkGenerateInput
No description
input DwReadonlyQueryExportLinkGenerateInput {
format: DwQueryExportFormat!
sql: String!
}
Fields
DwReadonlyQueryExportLinkGenerateInput.format ● DwQueryExportFormat! non-null enum
DwReadonlyQueryExportLinkGenerateInput.sql ● String! non-null scalar
A single read-only SELECT over the data-mart layer (fct_* / dim_*
/ bridge_* / report_*), validated exactly like dwRunReadonlyQuery.
Member Of
dwReadonlyQueryExportLinkGenerate mutation
EodProcessFilter
No description
input EodProcessFilter {
day: AccountingDate
status: EodProcessStatus
}
Fields
EodProcessFilter.day ● AccountingDate scalar
Include only the process for this specific day.
EodProcessFilter.status ● EodProcessStatus enum
Include only processes with this status.
Member Of
eodProcesses query
EodProcessRestartInput
No description
input EodProcessRestartInput {
eodProcessId: EodProcessId!
}
Fields
EodProcessRestartInput.eodProcessId ● EodProcessId! non-null scalar
ID of the stopped EOD process to restart.
Member Of
eodProcessRestart mutation
EodProcessSort
No description
input EodProcessSort {
by: EodProcessSortBy!
direction: SortDirection!
}
Fields
EodProcessSort.by ● EodProcessSortBy! non-null enum
Field to sort by. Defaults to day.
EodProcessSort.direction ● SortDirection! non-null enum
Sort direction. Defaults to descending (newest first).
Member Of
eodProcesses query
ExchangeAccountingIntegrationConfigureInput
No description
input ExchangeAccountingIntegrationConfigureInput {
bitcoinCostOfRevenueParentCode: AccountCode!
bitcoinSalesRevenueParentCode: AccountCode!
proprietaryBtcInventoryParentCode: AccountCode!
proprietaryBtcInventorySourceParentCode: AccountCode!
}
Fields
ExchangeAccountingIntegrationConfigureInput.bitcoinCostOfRevenueParentCode ● AccountCode! non-null scalar
ExchangeAccountingIntegrationConfigureInput.bitcoinSalesRevenueParentCode ● AccountCode! non-null scalar
ExchangeAccountingIntegrationConfigureInput.proprietaryBtcInventoryParentCode ● AccountCode! non-null scalar
ExchangeAccountingIntegrationConfigureInput.proprietaryBtcInventorySourceParentCode ● AccountCode! non-null scalar
Member Of
exchangeAccountingIntegrationConfigure mutation
ExchangeRateProviderActivateInput
No description
input ExchangeRateProviderActivateInput {
exchangeRateProviderId: PriceProviderId!
}
Fields
ExchangeRateProviderActivateInput.exchangeRateProviderId ● PriceProviderId! non-null scalar
Member Of
exchangeRateProviderActivate mutation
ExchangeRateProviderDeactivateInput
No description
input ExchangeRateProviderDeactivateInput {
exchangeRateProviderId: PriceProviderId!
}
Fields
ExchangeRateProviderDeactivateInput.exchangeRateProviderId ● PriceProviderId! non-null scalar
Member Of
exchangeRateProviderDeactivate mutation
ExchangeRateProviderManualExchangeRateUpdateInput
No description
input ExchangeRateProviderManualExchangeRateUpdateInput {
exchangeRate: MoneyInput!
exchangeRateProviderId: PriceProviderId!
}
Fields
ExchangeRateProviderManualExchangeRateUpdateInput.exchangeRate ● MoneyInput! non-null input
ExchangeRateProviderManualExchangeRateUpdateInput.exchangeRateProviderId ● PriceProviderId! non-null scalar
Member Of
exchangeRateProviderManualExchangeRateUpdate mutation
ExchangeRateProviderSort
No description
input ExchangeRateProviderSort {
by: ExchangeRateProviderSortBy!
direction: SortDirection!
}
Fields
ExchangeRateProviderSort.by ● ExchangeRateProviderSortBy! non-null enum
ExchangeRateProviderSort.direction ● SortDirection! non-null enum
Member Of
exchangeRateProviders query
FiscalYearCloseInput
No description
input FiscalYearCloseInput {
pastFiscalYearId: PastFiscalYearId!
}
Fields
FiscalYearCloseInput.pastFiscalYearId ● PastFiscalYearId! non-null scalar
Member Of
fiscalYearClose mutation
FiscalYearCloseMonthInput
No description
input FiscalYearCloseMonthInput {
openFiscalYearId: OpenFiscalYearId!
}
Fields
FiscalYearCloseMonthInput.openFiscalYearId ● OpenFiscalYearId! non-null scalar
Member Of
fiscalYearCloseMonth mutation
FiscalYearInitInput
No description
input FiscalYearInitInput {
openedAsOf: AccountingDate!
}
Fields
FiscalYearInitInput.openedAsOf ● AccountingDate! non-null scalar
Member Of
fiscalYearInit mutation
FiscalYearSort
No description
input FiscalYearSort {
by: FiscalYearSortBy!
direction: SortDirection!
}
Fields
FiscalYearSort.by ● FiscalYearSortBy! non-null enum
FiscalYearSort.direction ● SortDirection! non-null enum
Member Of
fiscalYears query
FullNameInput
No description
input FullNameInput {
first: NamePart!
last: NamePart!
}
Fields
FullNameInput.first ● NamePart! non-null scalar
FullNameInput.last ● NamePart! non-null scalar
Member Of
IndividualPartyCreateInput input ● IndividualPartyPersonalInfoUpdateInput input
FxCurrencyPolicyConfigureInput
No description
input FxCurrencyPolicyConfigureInput {
functional: CurrencyCode!
supported: [CurrencyCode!]!
}
Fields
FxCurrencyPolicyConfigureInput.functional ● CurrencyCode! non-null scalar
FxCurrencyPolicyConfigureInput.supported ● [CurrencyCode!]! non-null scalar
Member Of
fxCurrencyPolicyConfigure mutation
FxModuleConfigureInput
No description
input FxModuleConfigureInput {
realizedGainParentCode: AccountCode!
realizedLossParentCode: AccountCode!
tradingAccountParentCode: AccountCode!
unrealizedGainParentCode: AccountCode!
unrealizedLossParentCode: AccountCode!
}
Fields
FxModuleConfigureInput.realizedGainParentCode ● AccountCode! non-null scalar
FxModuleConfigureInput.realizedLossParentCode ● AccountCode! non-null scalar
FxModuleConfigureInput.tradingAccountParentCode ● AccountCode! non-null scalar
FxModuleConfigureInput.unrealizedGainParentCode ● AccountCode! non-null scalar
FxModuleConfigureInput.unrealizedLossParentCode ● AccountCode! non-null scalar
Member Of
fxModuleConfigure mutation
IndividualPartyCreateInput
No description
input IndividualPartyCreateInput {
address: PostalAddressInput
dateOfBirth: Date
email: String!
name: FullNameInput!
nationality: CountryCode
}
Fields
IndividualPartyCreateInput.address ● PostalAddressInput input
IndividualPartyCreateInput.dateOfBirth ● Date scalar
IndividualPartyCreateInput.email ● String! non-null scalar
IndividualPartyCreateInput.name ● FullNameInput! non-null input
IndividualPartyCreateInput.nationality ● CountryCode scalar
Member Of
individualPartyCreate mutation
IndividualPartyEmailUpdateInput
No description
input IndividualPartyEmailUpdateInput {
email: String!
individualPartyId: IndividualPartyId!
}
Fields
IndividualPartyEmailUpdateInput.email ● String! non-null scalar
IndividualPartyEmailUpdateInput.individualPartyId ● IndividualPartyId! non-null scalar
Member Of
individualPartyEmailUpdate mutation
IndividualPartyPersonalInfoUpdateInput
No description
input IndividualPartyPersonalInfoUpdateInput {
address: PostalAddressInput
dateOfBirth: Date
individualPartyId: IndividualPartyId!
name: FullNameInput
nationality: CountryCode
}
Fields
IndividualPartyPersonalInfoUpdateInput.address ● PostalAddressInput input
IndividualPartyPersonalInfoUpdateInput.dateOfBirth ● Date scalar
IndividualPartyPersonalInfoUpdateInput.individualPartyId ● IndividualPartyId! non-null scalar
IndividualPartyPersonalInfoUpdateInput.name ● FullNameInput input
IndividualPartyPersonalInfoUpdateInput.nationality ● CountryCode scalar
Member Of
individualPartyPersonalInfoUpdate mutation
IndividualPartyVerificationApproveManuallyInput
No description
input IndividualPartyVerificationApproveManuallyInput {
individualPartyId: IndividualPartyId!
}
Fields
IndividualPartyVerificationApproveManuallyInput.individualPartyId ● IndividualPartyId! non-null scalar
Member Of
individualPartyVerificationApproveManually mutation
IndividualPartyVerificationLinkCreateInput
No description
input IndividualPartyVerificationLinkCreateInput {
individualPartyId: IndividualPartyId!
}
Fields
IndividualPartyVerificationLinkCreateInput.individualPartyId ● IndividualPartyId! non-null scalar
Member Of
individualPartyVerificationLinkCreate mutation
IndividualProspectCreateInput
No description
input IndividualProspectCreateInput {
email: String!
kycProviderId: KycProviderId!
}
Fields
IndividualProspectCreateInput.email ● String! non-null scalar
IndividualProspectCreateInput.kycProviderId ● KycProviderId! non-null scalar
Member Of
prospectCreateIndividual mutation
JournalEntriesFilter
Filter for the journal entry listing. All bounds are inclusive and combined with AND semantics.
input JournalEntriesFilter {
createdFrom: Timestamp
createdTo: Timestamp
effectiveFrom: Date
effectiveTo: Date
}
Fields
JournalEntriesFilter.createdFrom ● Timestamp scalar
Only include entries created at or after this timestamp.
JournalEntriesFilter.createdTo ● Timestamp scalar
Only include entries created at or before this timestamp.
JournalEntriesFilter.effectiveFrom ● Date scalar
Only include entries whose transaction is effective on or after this date.
JournalEntriesFilter.effectiveTo ● Date scalar
Only include entries whose transaction is effective on or before this date.
Member Of
ledgerEntries query
KomainuConfigInput
No description
input KomainuConfigInput {
apiKey: Secret!
apiSecret: Secret!
secretKey: Secret!
testingInstance: Boolean!
webhookSecret: Secret!
}
Fields
KomainuConfigInput.apiKey ● Secret! non-null scalar
KomainuConfigInput.apiSecret ● Secret! non-null scalar
KomainuConfigInput.secretKey ● Secret! non-null scalar
KomainuConfigInput.testingInstance ● Boolean! non-null scalar
KomainuConfigInput.webhookSecret ● Secret! non-null scalar
Member Of
CustodianConfigInput input ● KomainuCustodianCreateInput input
KomainuCustodianCreateInput
No description
input KomainuCustodianCreateInput {
config: KomainuConfigInput!
name: String!
}
Fields
KomainuCustodianCreateInput.config ● KomainuConfigInput! non-null input
KomainuCustodianCreateInput.name ● String! non-null scalar
Member Of
CustodianCreateInput input
KycProviderConfigInput
No description
input KycProviderConfigInput {
persona: PersonaKycProviderConfigInput
sumsub: SumsubKycProviderConfigInput
}
Fields
KycProviderConfigInput.persona ● PersonaKycProviderConfigInput input
KycProviderConfigInput.sumsub ● SumsubKycProviderConfigInput input
Member Of
KycProviderConfigUpdateInput input
KycProviderConfigUpdateInput
No description
input KycProviderConfigUpdateInput {
config: KycProviderConfigInput!
kycProviderId: KycProviderId!
}
Fields
KycProviderConfigUpdateInput.config ● KycProviderConfigInput! non-null input
KycProviderConfigUpdateInput.kycProviderId ● KycProviderId! non-null scalar
Member Of
kycProviderConfigUpdate mutation
KycProviderCreateInput
No description
input KycProviderCreateInput {
persona: PersonaKycProviderCreateInput
sumsub: SumsubKycProviderCreateInput
}
Fields
KycProviderCreateInput.persona ● PersonaKycProviderCreateInput input
KycProviderCreateInput.sumsub ● SumsubKycProviderCreateInput input
Member Of
kycProviderCreate mutation
KycProviderSort
No description
input KycProviderSort {
by: KycProviderSortBy!
direction: SortDirection!
}
Fields
KycProviderSort.by ● KycProviderSortBy! non-null enum
KycProviderSort.direction ● SortDirection! non-null enum
Member Of
kycProviders query
LedgerAccountCsvCreateInput
No description
input LedgerAccountCsvCreateInput {
ledgerAccountId: LedgerAccountId!
}
Fields
LedgerAccountCsvCreateInput.ledgerAccountId ● LedgerAccountId! non-null scalar
Member Of
ledgerAccountCsvCreate mutation
LedgerAccountCsvDownloadLinkGenerateInput
No description
input LedgerAccountCsvDownloadLinkGenerateInput {
ledgerAccountCsvDocumentId: LedgerAccountCsvDocumentId!
}
Fields
LedgerAccountCsvDownloadLinkGenerateInput.ledgerAccountCsvDocumentId ● LedgerAccountCsvDocumentId! non-null scalar
Member Of
ledgerAccountCsvDownloadLinkGenerate mutation
LiquidationPaymentCalculateInput
No description
input LiquidationPaymentCalculateInput {
liquidationId: LiquidationId!
outstanding: MoneyInput!
targetLtv: LtvPctValue
toLiquidate: MoneyInput
toReceive: MoneyInput
}
Fields
LiquidationPaymentCalculateInput.liquidationId ● LiquidationId! non-null scalar
LiquidationPaymentCalculateInput.outstanding ● MoneyInput! non-null input
LiquidationPaymentCalculateInput.targetLtv ● LtvPctValue scalar
LiquidationPaymentCalculateInput.toLiquidate ● MoneyInput input
LiquidationPaymentCalculateInput.toReceive ● MoneyInput input
Member Of
liquidationPaymentCalculate query
LiquidationSort
No description
input LiquidationSort {
by: LiquidationSortBy!
direction: SortDirection!
}
Fields
LiquidationSort.by ● LiquidationSortBy! non-null enum
LiquidationSort.direction ● SortDirection! non-null enum
Member Of
liquidations query
ManualCustodianCreateInput
No description
input ManualCustodianCreateInput {
name: String!
}
Fields
ManualCustodianCreateInput.name ● String! non-null scalar
Member Of
CustodianCreateInput input
ManualProviderConfigInput
No description
input ManualProviderConfigInput {
name: PaymentProviderName!
}
Fields
ManualProviderConfigInput.name ● PaymentProviderName! non-null scalar
Member Of
PaymentProviderConfigInput input ● PaymentProviderCreateInput input
ManualTransactionDraftCloseInput
No description
input ManualTransactionDraftCloseInput {
manualTransactionDraftId: ManualTransactionDraftId!
}
Fields
ManualTransactionDraftCloseInput.manualTransactionDraftId ● ManualTransactionDraftId! non-null scalar
Member Of
manualTransactionDraftClose mutation
ManualTransactionDraftCreateInput
No description
input ManualTransactionDraftCreateInput {
description: String!
effective: AccountingDate
entries: [ManualTransactionDraftEntryInput!]!
reference: String
}
Fields
ManualTransactionDraftCreateInput.description ● String! non-null scalar
ManualTransactionDraftCreateInput.effective ● AccountingDate scalar
ManualTransactionDraftCreateInput.entries ● [ManualTransactionDraftEntryInput!]! non-null input
ManualTransactionDraftCreateInput.reference ● String scalar
Member Of
manualTransactionDraftCreate mutation
ManualTransactionDraftEntryInput
No description
input ManualTransactionDraftEntryInput {
accountRef: AccountCode
amount: MinorUnits
currency: CurrencyCode
description: String
direction: DebitOrCredit
}
Fields
ManualTransactionDraftEntryInput.accountRef ● AccountCode scalar
ManualTransactionDraftEntryInput.amount ● MinorUnits scalar
ManualTransactionDraftEntryInput.currency ● CurrencyCode scalar
ManualTransactionDraftEntryInput.description ● String scalar
ManualTransactionDraftEntryInput.direction ● DebitOrCredit enum
Member Of
ManualTransactionDraftCreateInput input ● ManualTransactionDraftUpdateInput input
ManualTransactionDraftFilter
No description
input ManualTransactionDraftFilter {
status: ManualTransactionDraftStatus
}
Fields
ManualTransactionDraftFilter.status ● ManualTransactionDraftStatus enum
Member Of
manualTransactionDrafts query
ManualTransactionDraftPostInput
No description
input ManualTransactionDraftPostInput {
manualTransactionDraftId: ManualTransactionDraftId!
}
Fields
ManualTransactionDraftPostInput.manualTransactionDraftId ● ManualTransactionDraftId! non-null scalar
Member Of
manualTransactionDraftPost mutation
ManualTransactionDraftUpdateInput
Omitted fields keep their saved value; null clears a field.
input ManualTransactionDraftUpdateInput {
description: String
effective: AccountingDate
entries: [ManualTransactionDraftEntryInput!]
manualTransactionDraftId: ManualTransactionDraftId!
reference: String
}
Fields
ManualTransactionDraftUpdateInput.description ● String scalar
ManualTransactionDraftUpdateInput.effective ● AccountingDate scalar
ManualTransactionDraftUpdateInput.entries ● [ManualTransactionDraftEntryInput!] list input
ManualTransactionDraftUpdateInput.manualTransactionDraftId ● ManualTransactionDraftId! non-null scalar
ManualTransactionDraftUpdateInput.reference ● String scalar
Member Of
manualTransactionDraftUpdate mutation
ManualTransactionEntryInput
No description
input ManualTransactionEntryInput {
accountRef: AccountCode!
amount: MoneyInput!
description: String!
direction: DebitOrCredit!
}
Fields
ManualTransactionEntryInput.accountRef ● AccountCode! non-null scalar
ManualTransactionEntryInput.amount ● MoneyInput! non-null input
ManualTransactionEntryInput.description ● String! non-null scalar
ManualTransactionEntryInput.direction ● DebitOrCredit! non-null enum
Member Of
ManualTransactionPostInput input ● ManualTransactionValidateInput input
ManualTransactionFilter
No description
input ManualTransactionFilter {
createdFrom: Timestamp
createdTo: Timestamp
effectiveFrom: AccountingDate
effectiveTo: AccountingDate
}
Fields
ManualTransactionFilter.createdFrom ● Timestamp scalar
Inclusive creation-time lower bound.
ManualTransactionFilter.createdTo ● Timestamp scalar
Inclusive creation-time upper bound.
ManualTransactionFilter.effectiveFrom ● AccountingDate scalar
Inclusive effective-date lower bound.
ManualTransactionFilter.effectiveTo ● AccountingDate scalar
Inclusive effective-date upper bound.
Member Of
manualTransactions query
ManualTransactionPostInput
No description
input ManualTransactionPostInput {
description: String!
effective: AccountingDate!
entries: [ManualTransactionEntryInput!]!
reference: String
}
Fields
ManualTransactionPostInput.description ● String! non-null scalar
ManualTransactionPostInput.effective ● AccountingDate! non-null scalar
ManualTransactionPostInput.entries ● [ManualTransactionEntryInput!]! non-null input
ManualTransactionPostInput.reference ● String scalar
Member Of
manualTransactionPost mutation
ManualTransactionValidateInput
No description
input ManualTransactionValidateInput {
description: String!
effective: AccountingDate!
entries: [ManualTransactionEntryInput!]!
reference: String
}
Fields
ManualTransactionValidateInput.description ● String! non-null scalar
ManualTransactionValidateInput.effective ● AccountingDate! non-null scalar
ManualTransactionValidateInput.entries ● [ManualTransactionEntryInput!]! non-null input
ManualTransactionValidateInput.reference ● String scalar
Member Of
manualTransactionValidate query
MoneyInput
No description
input MoneyInput {
amount: MinorUnits!
currencyCode: CurrencyCode!
}
Fields
MoneyInput.amount ● MinorUnits! non-null scalar
MoneyInput.currencyCode ● CurrencyCode! non-null scalar
Member Of
BitcoinInventoryFundInput input ● BitcoinPurchaseExecuteInput input ● CollateralRecordLiquidationSaleInput input ● CollateralRecordSentToLiquidationInput input ● CollateralUpdateInput input ● CreditFacilityDisbursalInitiateInput input ● CreditFacilityPartialPaymentRecordInput input ● CreditFacilityPartialPaymentWithDateRecordInput input ● CreditFacilityProposalCreateInput input ● DepositAccountProductTermsInput input ● ExchangeRateProviderManualExchangeRateUpdateInput input ● LiquidationPaymentCalculateInput input ● ManualTransactionEntryInput input ● ReceiptSubmitInput input ● WithdrawalInitiateInput input
NotificationProviderConfigInput
No description
input NotificationProviderConfigInput {
smtp: SmtpNotificationProviderConfigInput
}
Fields
NotificationProviderConfigInput.smtp ● SmtpNotificationProviderConfigInput input
Member Of
NotificationProviderConfigUpdateInput input
NotificationProviderConfigUpdateInput
No description
input NotificationProviderConfigUpdateInput {
config: NotificationProviderConfigInput!
notificationProviderId: NotificationProviderId!
}
Fields
NotificationProviderConfigUpdateInput.config ● NotificationProviderConfigInput! non-null input
NotificationProviderConfigUpdateInput.notificationProviderId ● NotificationProviderId! non-null scalar
Member Of
notificationProviderConfigUpdate mutation
NotificationProviderCreateInput
No description
input NotificationProviderCreateInput {
smtp: SmtpNotificationProviderCreateInput
}
Fields
NotificationProviderCreateInput.smtp ● SmtpNotificationProviderCreateInput input
Member Of
notificationProviderCreate mutation
NotificationProviderSort
No description
input NotificationProviderSort {
by: NotificationProviderSortBy!
direction: SortDirection!
}
Fields
NotificationProviderSort.by ● NotificationProviderSortBy! non-null enum
NotificationProviderSort.direction ● SortDirection! non-null enum
Member Of
notificationProviders query
ObligationFilter
No description
input ObligationFilter {
creditFacilityId: CreditFacilityId
status: ObligationStatus
}
Fields
ObligationFilter.creditFacilityId ● CreditFacilityId scalar
ObligationFilter.status ● ObligationStatus enum
Member Of
obligations query
ObligationSort
No description
input ObligationSort {
by: ObligationSortBy!
direction: SortDirection!
}
Fields
ObligationSort.by ● ObligationSortBy! non-null enum
ObligationSort.direction ● SortDirection! non-null enum
Member Of
obligations query
OrganizationPartyDetailsUpdateInput
No description
input OrganizationPartyDetailsUpdateInput {
companyName: String!
countryOfIncorporation: CountryCode!
organizationPartyId: OrganizationPartyId!
}
Fields
OrganizationPartyDetailsUpdateInput.companyName ● String! non-null scalar
OrganizationPartyDetailsUpdateInput.countryOfIncorporation ● CountryCode! non-null scalar
OrganizationPartyDetailsUpdateInput.organizationPartyId ● OrganizationPartyId! non-null scalar
Member Of
organizationPartyDetailsUpdate mutation
OrganizationPartyEmailUpdateInput
No description
input OrganizationPartyEmailUpdateInput {
email: String!
organizationPartyId: OrganizationPartyId!
}
Fields
OrganizationPartyEmailUpdateInput.email ● String! non-null scalar
OrganizationPartyEmailUpdateInput.organizationPartyId ● OrganizationPartyId! non-null scalar
Member Of
organizationPartyEmailUpdate mutation
OrganizationPartyMemberAddInput
No description
input OrganizationPartyMemberAddInput {
individualPartyId: IndividualPartyId!
organizationPartyId: OrganizationPartyId!
roles: [String!]!
}
Fields
OrganizationPartyMemberAddInput.individualPartyId ● IndividualPartyId! non-null scalar
OrganizationPartyMemberAddInput.organizationPartyId ● OrganizationPartyId! non-null scalar
OrganizationPartyMemberAddInput.roles ● [String!]! non-null scalar
Member Of
organizationPartyMemberAdd mutation
OrganizationPartyMemberRemoveInput
No description
input OrganizationPartyMemberRemoveInput {
individualPartyId: IndividualPartyId!
organizationPartyId: OrganizationPartyId!
}
Fields
OrganizationPartyMemberRemoveInput.individualPartyId ● IndividualPartyId! non-null scalar
OrganizationPartyMemberRemoveInput.organizationPartyId ● OrganizationPartyId! non-null scalar
Member Of
organizationPartyMemberRemove mutation
OrganizationPartyMemberRoleAddInput
No description
input OrganizationPartyMemberRoleAddInput {
individualPartyId: IndividualPartyId!
organizationPartyId: OrganizationPartyId!
role: String!
}
Fields
OrganizationPartyMemberRoleAddInput.individualPartyId ● IndividualPartyId! non-null scalar
OrganizationPartyMemberRoleAddInput.organizationPartyId ● OrganizationPartyId! non-null scalar
OrganizationPartyMemberRoleAddInput.role ● String! non-null scalar
Member Of
organizationPartyMemberRoleAdd mutation
OrganizationPartyMemberRoleRemoveInput
No description
input OrganizationPartyMemberRoleRemoveInput {
individualPartyId: IndividualPartyId!
organizationPartyId: OrganizationPartyId!
role: String!
}
Fields
OrganizationPartyMemberRoleRemoveInput.individualPartyId ● IndividualPartyId! non-null scalar
OrganizationPartyMemberRoleRemoveInput.organizationPartyId ● OrganizationPartyId! non-null scalar
OrganizationPartyMemberRoleRemoveInput.role ● String! non-null scalar
Member Of
organizationPartyMemberRoleRemove mutation
OrganizationPartyVerificationApproveManuallyInput
No description
input OrganizationPartyVerificationApproveManuallyInput {
organizationPartyId: OrganizationPartyId!
}
Fields
OrganizationPartyVerificationApproveManuallyInput.organizationPartyId ● OrganizationPartyId! non-null scalar
Member Of
organizationPartyVerificationApproveManually mutation
OrganizationPartyVerificationLinkCreateInput
No description
input OrganizationPartyVerificationLinkCreateInput {
organizationPartyId: OrganizationPartyId!
}
Fields
OrganizationPartyVerificationLinkCreateInput.organizationPartyId ● OrganizationPartyId! non-null scalar
Member Of
organizationPartyVerificationLinkCreate mutation
OrganizationProspectCreateInput
No description
input OrganizationProspectCreateInput {
companyName: String!
countryOfIncorporation: CountryCode!
customerType: CustomerType!
email: String!
kycProviderId: KycProviderId!
}
Fields
OrganizationProspectCreateInput.companyName ● String! non-null scalar
OrganizationProspectCreateInput.countryOfIncorporation ● CountryCode! non-null scalar
OrganizationProspectCreateInput.customerType ● CustomerType! non-null enum
OrganizationProspectCreateInput.email ● String! non-null scalar
OrganizationProspectCreateInput.kycProviderId ● KycProviderId! non-null scalar
Member Of
prospectCreateOrganization mutation
PartnerActivateInput
No description
input PartnerActivateInput {
partnerId: PartnerId!
}
Fields
PartnerActivateInput.partnerId ● PartnerId! non-null scalar
Member Of
partnerActivate mutation
PartnerCreateInput
No description
input PartnerCreateInput {
invitedAdminEmail: String!
name: PartnerName!
}
Fields
PartnerCreateInput.invitedAdminEmail ● String! non-null scalar
PartnerCreateInput.name ● PartnerName! non-null scalar
Member Of
partnerCreate mutation
PartnerDeactivateInput
No description
input PartnerDeactivateInput {
partnerId: PartnerId!
}
Fields
PartnerDeactivateInput.partnerId ● PartnerId! non-null scalar
Member Of
partnerDeactivate mutation
PartnerSort
No description
input PartnerSort {
by: PartnerSortBy!
direction: SortDirection!
}
Fields
PartnerSort.by ● PartnerSortBy! non-null enum
PartnerSort.direction ● SortDirection! non-null enum
Member Of
partners query
PartnerUpdateInput
No description
input PartnerUpdateInput {
name: PartnerName!
partnerId: PartnerId!
}
Fields
PartnerUpdateInput.name ● PartnerName! non-null scalar
PartnerUpdateInput.partnerId ● PartnerId! non-null scalar
Member Of
partnerUpdate mutation
PaymentProviderConfigInput
No description
input PaymentProviderConfigInput {
circle: CircleProviderConfigInput
manual: ManualProviderConfigInput
}
Fields
PaymentProviderConfigInput.circle ● CircleProviderConfigInput input
PaymentProviderConfigInput.manual ● ManualProviderConfigInput input
Member Of
PaymentProviderConfigUpdateInput input
PaymentProviderConfigUpdateInput
No description
input PaymentProviderConfigUpdateInput {
config: PaymentProviderConfigInput!
paymentProviderId: PaymentProviderId!
}
Fields
PaymentProviderConfigUpdateInput.config ● PaymentProviderConfigInput! non-null input
PaymentProviderConfigUpdateInput.paymentProviderId ● PaymentProviderId! non-null scalar
Member Of
paymentProviderConfigUpdate mutation
PaymentProviderCreateInput
No description
input PaymentProviderCreateInput {
circle: CircleProviderConfigInput
manual: ManualProviderConfigInput
}
Fields
PaymentProviderCreateInput.circle ● CircleProviderConfigInput input
PaymentProviderCreateInput.manual ● ManualProviderConfigInput input
Member Of
paymentProviderCreate mutation
PayoutCancelInput
No description
input PayoutCancelInput {
payoutId: PayoutId!
}
Fields
PayoutCancelInput.payoutId ● PayoutId! non-null scalar
Member Of
payoutCancel mutation
PayoutFailInput
No description
input PayoutFailInput {
payoutId: PayoutId!
}
Fields
PayoutFailInput.payoutId ● PayoutId! non-null scalar
Member Of
payoutFail mutation
PayoutRevertInput
No description
input PayoutRevertInput {
payoutId: PayoutId!
}
Fields
PayoutRevertInput.payoutId ● PayoutId! non-null scalar
Member Of
payoutRevert mutation
PayoutSettleInput
No description
input PayoutSettleInput {
payoutId: PayoutId!
}
Fields
PayoutSettleInput.payoutId ● PayoutId! non-null scalar
Member Of
payoutSettle mutation
PayoutSort
No description
input PayoutSort {
by: PayoutSortBy!
direction: SortDirection!
}
Fields
PayoutSort.by ● PayoutSortBy! non-null enum
PayoutSort.direction ● SortDirection! non-null enum
Member Of
payouts query
PendingCreditFacilityFilter
No description
input PendingCreditFacilityFilter {
collateralizationState: PendingCreditFacilityCollateralizationState
partnerId: PartnerId
productId: CreditFacilityProductId
status: PendingCreditFacilityStatus
}
Fields
PendingCreditFacilityFilter.collateralizationState ● PendingCreditFacilityCollateralizationState enum
PendingCreditFacilityFilter.partnerId ● PartnerId scalar
PendingCreditFacilityFilter.productId ● CreditFacilityProductId scalar
PendingCreditFacilityFilter.status ● PendingCreditFacilityStatus enum
Member Of
pendingCreditFacilities query
PendingCreditFacilitySort
No description
input PendingCreditFacilitySort {
by: PendingCreditFacilitySortBy!
direction: SortDirection!
}
Fields
PendingCreditFacilitySort.by ● PendingCreditFacilitySortBy! non-null enum
PendingCreditFacilitySort.direction ● SortDirection! non-null enum
Member Of
pendingCreditFacilities query
PersonaKycProviderConfigInput
Persona config fields used on the **update** path. The provider's
name is fixed at creation time and cannot be changed via config update.
input PersonaKycProviderConfigInput {
apiKey: Secret!
kycInquiryTemplateId: String!
webhookSecret: Secret!
}
Fields
PersonaKycProviderConfigInput.apiKey ● Secret! non-null scalar
PersonaKycProviderConfigInput.kycInquiryTemplateId ● String! non-null scalar
PersonaKycProviderConfigInput.webhookSecret ● Secret! non-null scalar
Member Of
KycProviderConfigInput input
PersonaKycProviderCreateInput
Create payload for a Persona-backed KYC provider.
input PersonaKycProviderCreateInput {
apiKey: Secret!
kycInquiryTemplateId: String!
name: String!
webhookSecret: Secret!
}
Fields
PersonaKycProviderCreateInput.apiKey ● Secret! non-null scalar
PersonaKycProviderCreateInput.kycInquiryTemplateId ● String! non-null scalar
PersonaKycProviderCreateInput.name ● String! non-null scalar
PersonaKycProviderCreateInput.webhookSecret ● Secret! non-null scalar
Member Of
KycProviderCreateInput input
PiiErasureProcessCancelInput
No description
input PiiErasureProcessCancelInput {
subject: PiiErasureSubjectInput!
}
Fields
PiiErasureProcessCancelInput.subject ● PiiErasureSubjectInput! non-null input
The customer or (never-converted) prospect whose active erasure process should be cancelled.
Member Of
piiErasureProcessCancel mutation
PiiErasureProcessFilter
No description
input PiiErasureProcessFilter {
executeOn: AccountingDate
status: PiiErasureProcessStatus
subject: PiiErasureSubjectInput
}
Fields
PiiErasureProcessFilter.executeOn ● AccountingDate scalar
Only processes executing on exactly this accounting day.
PiiErasureProcessFilter.status ● PiiErasureProcessStatus enum
PiiErasureProcessFilter.subject ● PiiErasureSubjectInput input
Only processes targeting this customer or prospect.
Member Of
piiErasureProcesses query
PiiErasureProcessScheduleInput
No description
input PiiErasureProcessScheduleInput {
executeOn: AccountingDate!
subject: PiiErasureSubjectInput!
}
Fields
PiiErasureProcessScheduleInput.executeOn ● AccountingDate! non-null scalar
The accounting day on which the erasure process executes, at that day's end-of-day boundary. Must not be in the past.
PiiErasureProcessScheduleInput.subject ● PiiErasureSubjectInput! non-null input
The customer or (never-converted) prospect whose party PII should be erased.
Member Of
piiErasureProcessSchedule mutation
PiiErasureProcessSort
No description
input PiiErasureProcessSort {
by: PiiErasureProcessSortBy!
direction: SortDirection!
}
Fields
PiiErasureProcessSort.by ● PiiErasureProcessSortBy! non-null enum
PiiErasureProcessSort.direction ● SortDirection! non-null enum
Member Of
piiErasureProcesses query
PiiErasureSubjectInput
No description
input PiiErasureSubjectInput {
customerId: CustomerId
prospectId: ProspectId
}
Fields
PiiErasureSubjectInput.customerId ● CustomerId scalar
PiiErasureSubjectInput.prospectId ● ProspectId scalar
Member Of
PiiErasureProcessCancelInput input ● PiiErasureProcessFilter input ● PiiErasureProcessScheduleInput input
PipelineRunFilter
No description
input PipelineRunFilter {
day: AccountingDate
kind: PipelineRunKind
status: PipelineRunStatus
}
Fields
PipelineRunFilter.day ● AccountingDate scalar
Include only the pipeline run for this specific day.
PipelineRunFilter.kind ● PipelineRunKind enum
Include only pipeline runs of this kind.
PipelineRunFilter.status ● PipelineRunStatus enum
Include only pipeline runs with this status.
Member Of
pipelineRuns query
PipelineRunSort
No description
input PipelineRunSort {
by: PipelineRunSortBy!
direction: SortDirection!
}
Fields
PipelineRunSort.by ● PipelineRunSortBy! non-null enum
Field to sort by. Defaults to day.
PipelineRunSort.direction ● SortDirection! non-null enum
Sort direction. Defaults to descending (newest first).
Member Of
pipelineRuns query
PolicyCommitteeAssignInput
No description
input PolicyCommitteeAssignInput {
committeeId: CommitteeId!
policyId: PolicyId!
}
Fields
PolicyCommitteeAssignInput.committeeId ● CommitteeId! non-null scalar
PolicyCommitteeAssignInput.policyId ● PolicyId! non-null scalar
Member Of
policyCommitteeAssign mutation
PostalAddressInput
No description
input PostalAddressInput {
city: AddressPart!
country: CountryCode!
line1: AddressPart!
line2: OptionalAddressPart
state: OptionalAddressPart
zipCode: OptionalAddressPart
}
Fields
PostalAddressInput.city ● AddressPart! non-null scalar
PostalAddressInput.country ● CountryCode! non-null scalar
PostalAddressInput.line1 ● AddressPart! non-null scalar
PostalAddressInput.line2 ● OptionalAddressPart scalar
PostalAddressInput.state ● OptionalAddressPart scalar
PostalAddressInput.zipCode ● OptionalAddressPart scalar
Member Of
IndividualPartyCreateInput input ● IndividualPartyPersonalInfoUpdateInput input
ProspectCloseInput
No description
input ProspectCloseInput {
prospectId: ProspectId!
}
Fields
ProspectCloseInput.prospectId ● ProspectId! non-null scalar
Member Of
prospectClose mutation
ProspectFilter
No description
input ProspectFilter {
customerType: CustomerType
partnerId: PartnerId
stage: ProspectStage
}
Fields
ProspectFilter.customerType ● CustomerType enum
ProspectFilter.partnerId ● PartnerId scalar
ProspectFilter.stage ● ProspectStage enum
Member Of
prospects query
ProspectSort
No description
input ProspectSort {
by: ProspectSortBy!
direction: SortDirection!
}
Fields
ProspectSort.by ● ProspectSortBy! non-null enum
ProspectSort.direction ● SortDirection! non-null enum
Member Of
prospects query
QueryTemplateCreateInput
No description
input QueryTemplateCreateInput {
categories: [QueryTemplateCategory!]!
description: String!
name: String!
sql: String!
}
Fields
QueryTemplateCreateInput.categories ● [QueryTemplateCategory!]! non-null enum
At least one category is required.
QueryTemplateCreateInput.description ● String! non-null scalar
QueryTemplateCreateInput.name ● String! non-null scalar
QueryTemplateCreateInput.sql ● String! non-null scalar
A single read-only SELECT over the data-mart layer (fct_*, dim_*, bridge_*, report_*), without a trailing semicolon. Validated before the template is persisted.
Member Of
queryTemplateCreate mutation
QueryTemplateDeleteInput
No description
input QueryTemplateDeleteInput {
queryTemplateId: QueryTemplateId!
}
Fields
QueryTemplateDeleteInput.queryTemplateId ● QueryTemplateId! non-null scalar
Member Of
queryTemplateDelete mutation
QueryTemplateFilter
No description
input QueryTemplateFilter {
category: QueryTemplateCategory
}
Fields
QueryTemplateFilter.category ● QueryTemplateCategory enum
Keep only templates tagged with this category.
Member Of
queryTemplates query
QueryTemplateSort
No description
input QueryTemplateSort {
by: QueryTemplateSortBy!
direction: SortDirection!
}
Fields
QueryTemplateSort.by ● QueryTemplateSortBy! non-null enum
QueryTemplateSort.direction ● SortDirection! non-null enum
Member Of
queryTemplates query
QueryTemplateUpdateInput
No description
input QueryTemplateUpdateInput {
categories: [QueryTemplateCategory!]!
description: String!
name: String!
queryTemplateId: QueryTemplateId!
sql: String!
}
Fields
QueryTemplateUpdateInput.categories ● [QueryTemplateCategory!]! non-null enum
At least one category is required.
QueryTemplateUpdateInput.description ● String! non-null scalar
QueryTemplateUpdateInput.name ● String! non-null scalar
QueryTemplateUpdateInput.queryTemplateId ● QueryTemplateId! non-null scalar
QueryTemplateUpdateInput.sql ● String! non-null scalar
A single read-only SELECT over the data-mart layer (fct_*, dim_*, bridge_*, report_*), without a trailing semicolon.
Member Of
queryTemplateUpdate mutation
RailCreateInput
No description
input RailCreateInput {
currencyVariant: CurrencyVariantInput!
inboundCreditTiming: InboundCreditTiming!
name: RailName!
paymentProviderId: PaymentProviderId!
}
Fields
RailCreateInput.currencyVariant ● CurrencyVariantInput! non-null input
RailCreateInput.inboundCreditTiming ● InboundCreditTiming! non-null enum
RailCreateInput.name ● RailName! non-null scalar
RailCreateInput.paymentProviderId ● PaymentProviderId! non-null scalar
Member Of
railCreate mutation
RailSort
No description
input RailSort {
by: RailSortBy!
direction: SortDirection!
}
Fields
RailSort.by ● RailSortBy! non-null enum
RailSort.direction ● SortDirection! non-null enum
Member Of
rails query
ReceiptCancelInput
No description
input ReceiptCancelInput {
receiptId: ReceiptId!
}
Fields
ReceiptCancelInput.receiptId ● ReceiptId! non-null scalar
Member Of
receiptCancel mutation
ReceiptFailInput
No description
input ReceiptFailInput {
receiptId: ReceiptId!
}
Fields
ReceiptFailInput.receiptId ● ReceiptId! non-null scalar
Member Of
receiptFail mutation
ReceiptSettleInput
No description
input ReceiptSettleInput {
receiptId: ReceiptId!
}
Fields
ReceiptSettleInput.receiptId ● ReceiptId! non-null scalar
Member Of
receiptSettle mutation
ReceiptSort
No description
input ReceiptSort {
by: ReceiptSortBy!
direction: SortDirection!
}
Fields
ReceiptSort.by ● ReceiptSortBy! non-null enum
ReceiptSort.direction ● SortDirection! non-null enum
Member Of
receipts query
ReceiptSubmitInput
No description
input ReceiptSubmitInput {
amount: MoneyInput!
destination: DestinationInfoInput!
externalId: String
railId: RailId
}
Fields
ReceiptSubmitInput.amount ● MoneyInput! non-null input
ReceiptSubmitInput.destination ● DestinationInfoInput! non-null input
ReceiptSubmitInput.externalId ● String scalar
Optional free-form rail-side reference (e.g. SWIFT MT id, ACH trace number, bank statement line). Opaque to the hub.
ReceiptSubmitInput.railId ● RailId scalar
Optional rail id. When omitted, the hub picks the first Manual rail. Set when multiple rails of the same type exist and you need to pin the receipt to a specific one.
Member Of
receiptSubmit mutation
ReportFileDownloadLinkGenerateInput
No description
input ReportFileDownloadLinkGenerateInput {
asOfDate: Date
duringRange: DateRangeInput
extension: String!
reportDefinitionId: ReportDefinitionId!
}
Fields
ReportFileDownloadLinkGenerateInput.asOfDate ● Date scalar
ReportFileDownloadLinkGenerateInput.duringRange ● DateRangeInput input
ReportFileDownloadLinkGenerateInput.extension ● String! non-null scalar
ReportFileDownloadLinkGenerateInput.reportDefinitionId ● ReportDefinitionId! non-null scalar
Member Of
reportFileDownloadLinkGenerate mutation
RoleCreateInput
No description
input RoleCreateInput {
name: RoleName!
permissionSetIds: [PermissionSetId!]!
}
Fields
RoleCreateInput.name ● RoleName! non-null scalar
RoleCreateInput.permissionSetIds ● [PermissionSetId!]! non-null scalar
Member Of
roleCreate mutation
RolePermissionSetsAddInput
No description
input RolePermissionSetsAddInput {
permissionSetIds: [PermissionSetId!]!
roleId: RoleId!
}
Fields
RolePermissionSetsAddInput.permissionSetIds ● [PermissionSetId!]! non-null scalar
RolePermissionSetsAddInput.roleId ● RoleId! non-null scalar
Member Of
rolePermissionSetsAdd mutation
RolePermissionSetsRemoveInput
No description
input RolePermissionSetsRemoveInput {
permissionSetIds: [PermissionSetId!]!
roleId: RoleId!
}
Fields
RolePermissionSetsRemoveInput.permissionSetIds ● [PermissionSetId!]! non-null scalar
RolePermissionSetsRemoveInput.roleId ● RoleId! non-null scalar
Member Of
rolePermissionSetsRemove mutation
RoleSort
No description
input RoleSort {
by: RoleSortBy!
direction: SortDirection!
}
Fields
RoleSort.by ● RoleSortBy! non-null enum
RoleSort.direction ● SortDirection! non-null enum
Member Of
roles query
SmtpNotificationProviderConfigInput
No description
input SmtpNotificationProviderConfigInput {
fromEmail: String!
fromName: String!
insecure: Boolean!
password: Secret!
port: Int!
relay: String!
username: Secret!
}
Fields
SmtpNotificationProviderConfigInput.fromEmail ● String! non-null scalar
SmtpNotificationProviderConfigInput.fromName ● String! non-null scalar
SmtpNotificationProviderConfigInput.insecure ● Boolean! non-null scalar
SmtpNotificationProviderConfigInput.password ● Secret! non-null scalar
SmtpNotificationProviderConfigInput.port ● Int! non-null scalar
SmtpNotificationProviderConfigInput.relay ● String! non-null scalar
SmtpNotificationProviderConfigInput.username ● Secret! non-null scalar
Member Of
NotificationProviderConfigInput input
SmtpNotificationProviderCreateInput
No description
input SmtpNotificationProviderCreateInput {
fromEmail: String!
fromName: String!
insecure: Boolean!
name: String!
password: Secret!
port: Int!
relay: String!
username: Secret!
}
Fields
SmtpNotificationProviderCreateInput.fromEmail ● String! non-null scalar
SmtpNotificationProviderCreateInput.fromName ● String! non-null scalar
SmtpNotificationProviderCreateInput.insecure ● Boolean! non-null scalar
SmtpNotificationProviderCreateInput.name ● String! non-null scalar
SmtpNotificationProviderCreateInput.password ● Secret! non-null scalar
SmtpNotificationProviderCreateInput.port ● Int! non-null scalar
SmtpNotificationProviderCreateInput.relay ● String! non-null scalar
SmtpNotificationProviderCreateInput.username ● Secret! non-null scalar
Member Of
NotificationProviderCreateInput input
SumsubKycProviderConfigInput
Sumsub config fields used on the **update** path. The provider's
name is intentionally not on this struct — name is fixed at
creation time and cannot be changed via config update.
input SumsubKycProviderConfigInput {
apiKey: Secret!
apiSecret: Secret!
kybFlowName: String!
kycFlowName: String!
webhookSecret: Secret!
}
Fields
SumsubKycProviderConfigInput.apiKey ● Secret! non-null scalar
SumsubKycProviderConfigInput.apiSecret ● Secret! non-null scalar
SumsubKycProviderConfigInput.kybFlowName ● String! non-null scalar
SumsubKycProviderConfigInput.kycFlowName ● String! non-null scalar
SumsubKycProviderConfigInput.webhookSecret ● Secret! non-null scalar
Member Of
KycProviderConfigInput input
SumsubKycProviderCreateInput
Create payload for a Sumsub-backed KYC provider. Carries the provider name plus the same config fields as the update payload.
input SumsubKycProviderCreateInput {
apiKey: Secret!
apiSecret: Secret!
kybFlowName: String!
kycFlowName: String!
name: String!
webhookSecret: Secret!
}
Fields
SumsubKycProviderCreateInput.apiKey ● Secret! non-null scalar
SumsubKycProviderCreateInput.apiSecret ● Secret! non-null scalar
SumsubKycProviderCreateInput.kybFlowName ● String! non-null scalar
SumsubKycProviderCreateInput.kycFlowName ● String! non-null scalar
SumsubKycProviderCreateInput.name ● String! non-null scalar
SumsubKycProviderCreateInput.webhookSecret ● Secret! non-null scalar
Member Of
KycProviderCreateInput input
TermsInput
No description
input TermsInput {
accrualCycleInterval: InterestInterval!
annualRate: AnnualRatePct!
disbursalPolicy: DisbursalPolicy!
duration: DurationInput!
initialLtvLimit: LtvPctValue!
interestDueDurationFromAccrual: DurationInput!
liquidationLtvLimit: LtvPctValue!
marginCallLtvLimit: LtvPctValue!
obligationDefaultedDurationFromDue: DurationInput
obligationLiquidationDurationFromDue: DurationInput
obligationOverdueDurationFromDue: DurationInput
oneTimeFeeRate: OneTimeFeeRatePct!
}
Fields
TermsInput.accrualCycleInterval ● InterestInterval! non-null enum
TermsInput.annualRate ● AnnualRatePct! non-null scalar
TermsInput.disbursalPolicy ● DisbursalPolicy! non-null enum
TermsInput.duration ● DurationInput! non-null input
TermsInput.initialLtvLimit ● LtvPctValue! non-null scalar
TermsInput.interestDueDurationFromAccrual ● DurationInput! non-null input
TermsInput.liquidationLtvLimit ● LtvPctValue! non-null scalar
TermsInput.marginCallLtvLimit ● LtvPctValue! non-null scalar
TermsInput.obligationDefaultedDurationFromDue ● DurationInput input
TermsInput.obligationLiquidationDurationFromDue ● DurationInput input
TermsInput.obligationOverdueDurationFromDue ● DurationInput input
TermsInput.oneTimeFeeRate ● OneTimeFeeRatePct! non-null scalar
Member Of
CreditFacilityProductCreateInput input ● CreditFacilityProductUpdateTermsInput input
UserCreateInput
No description
input UserCreateInput {
email: String!
roleId: RoleId!
}
Fields
UserCreateInput.email ● String! non-null scalar
UserCreateInput.roleId ● RoleId! non-null scalar
Member Of
userCreate mutation
UserRoleUpdateInput
No description
input UserRoleUpdateInput {
roleId: RoleId!
userId: UserId!
}
Fields
UserRoleUpdateInput.roleId ● RoleId! non-null scalar
UserRoleUpdateInput.userId ● UserId! non-null scalar
Member Of
userRoleUpdate mutation
UserSort
No description
input UserSort {
by: UserSortBy!
direction: SortDirection!
}
Fields
UserSort.by ● UserSortBy! non-null enum
UserSort.direction ● SortDirection! non-null enum
Member Of
users query
WithdrawalDestinationInput
No description
input WithdrawalDestinationInput {
currencyCode: CurrencyCode!
qualifier: String!
reference: String!
}
Fields
WithdrawalDestinationInput.currencyCode ● CurrencyCode! non-null scalar
WithdrawalDestinationInput.qualifier ● String! non-null scalar
WithdrawalDestinationInput.reference ● String! non-null scalar
Member Of
WithdrawalInitiateInput input
WithdrawalFilter
No description
input WithdrawalFilter {
status: WithdrawalStatus
}
Fields
WithdrawalFilter.status ● WithdrawalStatus enum
Member Of
withdrawals query
WithdrawalInitiateInput
No description
input WithdrawalInitiateInput {
amount: MoneyInput!
depositAccountId: DepositAccountId!
destination: WithdrawalDestinationInput!
reference: String
}
Fields
WithdrawalInitiateInput.amount ● MoneyInput! non-null input
WithdrawalInitiateInput.depositAccountId ● DepositAccountId! non-null scalar
WithdrawalInitiateInput.destination ● WithdrawalDestinationInput! non-null input
WithdrawalInitiateInput.reference ● String scalar
Member Of
withdrawalInitiate mutation
WithdrawalSort
No description
input WithdrawalSort {
by: WithdrawalSortBy!
direction: SortDirection!
}
Fields
WithdrawalSort.by ● WithdrawalSortBy! non-null enum
WithdrawalSort.direction ● SortDirection! non-null enum
Member Of
withdrawals query
Scalars
AccountCode
No description
scalar AccountCode
Member Of
AccountingBaseConfigInput input ● AccountingBaseConfigOutput object ● BalanceSheetAccount object ● BalanceSheetAccountFlat object ● ChartIntegrationBinding object ● ChartNode object ● ChartOfAccountsAddChildNodeInput input ● CreditAccountingIntegrationConfigureInput input ● CreditDefaultedReceivableParentsInput input ● CreditFacilityProductOmnibusAttachment object ● CreditFacilityProductSetAttachment object ● CreditIncomeParentsInput input ● CreditOmnibusParentsInput input ● CreditOperationalSummaryParentsInput input ● CreditReceivableParentsInput input ● DepositAccountProductAccountSets object ● DepositAccountProductOmnibusAccounting object ● DepositBalanceStateParentsInput input ● DepositOmnibusIntegrationInput input ● ExchangeAccountingIntegration object ● ExchangeAccountingIntegrationConfigureInput input ● FxModuleConfig object ● FxModuleConfigureInput input ● LedgerAccount object ● ledgerAccountByCode query ● ManualTransactionDraftEntry object ● ManualTransactionDraftEntryInput input ● ManualTransactionEntryInput input ● ProfitAndLossAccount object ● ProfitAndLossAccountFlat object
AccountingDate
A day on the bank's accounting timeline as an ISO 8601 date (e.g. 2026-03-10).
scalar AccountingDate
Member Of
ChartOfAccountsInitializeInput input ● CollateralUpdateInput input ● CreditFacility object ● CreditFacilityApproved object ● CreditFacilityCollateralizationUpdated object ● CreditFacilityCollateralSentOut object ● CreditFacilityCollateralUpdated object ● CreditFacilityDisbursalExecuted object ● CreditFacilityIncrementalPayment object ● CreditFacilityInterestAccrued object ● CreditFacilityLiquidationSaleRecorded object ● CreditFacilityPartialPaymentWithDateRecordInput input ● CreditFacilityRepaymentPlanEntry object ● EodProcess object ● EodProcessFilter input ● FiscalMonthClosure object ● FiscalYear object ● FiscalYearInitInput input ● ManualTransaction object ● ManualTransactionDraft object ● ManualTransactionDraftCreateInput input ● ManualTransactionDraftUpdateInput input ● ManualTransactionFilter input ● ManualTransactionPostInput input ● ManualTransactionValidateInput input ● Obligation object ● OpenFiscalYear object ● PastFiscalYear object ● PendingCreditFacilityCollateralizationUpdated object ● PiiErasureProcess object ● PiiErasureProcessFilter input ● PiiErasureProcessScheduleInput input ● PiiErasureProcessSchedulePayloadError object ● PipelineRun object ● PipelineRunFilter input ● ReportDefinition object ● Time object
AccountName
No description
scalar AccountName
Member Of
ChartOfAccountsAddChildNodeInput input
AddressPart
One part of a postal address: trimmed, non-empty, at most 255 characters, without markup or invisible characters.
scalar AddressPart
Member Of
PostalAddressInput input
AnnualRatePct
No description
scalar AnnualRatePct
Member Of
CreditFacilityTermsAlteration object ● CreditFacilityTermsAlterationsInput input ● TermsInput input ● TermValues object
ApprovalProcessId
No description
scalar ApprovalProcessId
Member Of
approvalProcess query ● ApprovalProcess object ● ApprovalProcessApproveInput input ● ApprovalProcessDenyInput input ● CreditFacilityProposal object ● PendingCreditFacility object ● Withdrawal object
AuditEntryId
No description
scalar AuditEntryId
Member Of
AuditEntry object ● EventTimelineEntry object
AuditSubjectId
No description
scalar AuditSubjectId
Returned By
auditSubjects query
Member Of
audit query
BitcoinInventoryFundingId
No description
scalar BitcoinInventoryFundingId
Member Of
BitcoinInventoryFundPayloadSuccess object
BitcoinPurchaseId
No description
scalar BitcoinPurchaseId
Member Of
bitcoinPurchase query ● BitcoinPurchase object ● CustomerBitcoinPurchaseExecuted object
Boolean
The Boolean scalar type represents true or false.
scalar Boolean
Returned By
isSimulatedTime query
Member Of
ApprovalProcess object ● ApprovalProcessVoter object ● audit query ● AuditEntry object ● AutoApproval object ● BitgoConfigInput input ● ChartNode object ● CreditFacility object ● CreditFacilityFilter input ● CreditFacilityProduct object ● CreditFacilityProposalCustomerApprovalConcludeInput input ● Currency object ● Customer object ● DepositAccountProduct object ● DomainConfig object ● DwReadonlyQueryExportLinkGeneratePayload object ● DwReadOnlyQueryResult object ● ExchangeRateProvider object ● GovernanceNavigationItems object ● include directive ● IndividualParty object ● InfiniteLtvPct object ● KomainuConfigInput input ● LedgerAccount object ● Liquidation object ● ManualTransactionValidatePayloadSuccess object ● Me object ● OpenFiscalYear object ● OrganizationParty object ● PageInfo object ● Prospect object ● skip directive ● SmtpNotificationProviderConfigInput input ● SmtpNotificationProviderCreateInput input ● Time object ● UnlimitedMaxWithdrawalAmountPerTransaction object ● User object ● VisibleNavigationItems object
ChartOfAccountsId
No description
scalar ChartOfAccountsId
Member Of
ChartOfAccounts object ● CreditAccountingIntegration object ● CreditFacilityProductAccountingConfig object ● DepositAccountingIntegration object ● DepositAccountProductAccountingConfig object ● ExchangeAccountingIntegration object ● FiscalYear object ● FxModuleConfig object ● OpenFiscalYear object ● PastFiscalYear object
CollateralId
No description
scalar CollateralId
Member Of
Collateral object ● CollateralRecordSentToLiquidationInput input ● CollateralUpdateInput input ● CreditFacility object ● Liquidation object ● PendingCreditFacility object
CommitteeId
No description
scalar CommitteeId
Member Of
committee query ● Committee object ● CommitteeUserAddInput input ● CommitteeUserRemoveInput input ● PolicyCommitteeAssignInput input
CountryCode
An ISO 3166-1 alpha-3 country code in canonical uppercase form.
scalar CountryCode
Member Of
IndividualPartyCreateInput input ● IndividualPartyPersonalInfoUpdateInput input ● OrganizationParty object ● OrganizationPartyDetailsUpdateInput input ● OrganizationProspectCreateInput input ● PersonalInfo object ● PostalAddress object ● PostalAddressInput input
CreditFacilityAgreementId
No description
scalar CreditFacilityAgreementId
Member Of
creditFacilityAgreement query ● CreditFacilityAgreement object ● CreditFacilityAgreementDownloadLinksGenerateInput input
CreditFacilityDisbursalId
No description
scalar CreditFacilityDisbursalId
Member Of
CreditFacilityDisbursal object ● disbursal query ● disbursalUpdated subscription
CreditFacilityId
No description
scalar CreditFacilityId
Member Of
creditFacility query ● CreditFacility object ● CreditFacilityAgreementGenerateInput input ● CreditFacilityCompleteInput input ● CreditFacilityDisbursalInitiateInput input ● CreditFacilityPartialPaymentRecordInput input ● CreditFacilityPartialPaymentWithDateRecordInput input ● creditFacilityUpdated subscription ● CustomerCreditFacilityActivated object ● CustomerCreditFacilityCompleted object ● CustomerCreditFacilityMatured object ● Obligation object ● ObligationFilter input ● PendingCreditFacility object
CreditFacilityPaymentAllocationId
No description
scalar CreditFacilityPaymentAllocationId
Member Of
CreditFacilityPaymentAllocation object
CreditFacilityProductId
No description
scalar CreditFacilityProductId
Member Of
CreditFacility object ● CreditFacilityFilter input ● creditFacilityProduct query ● CreditFacilityProduct object ● CreditFacilityProductUpdateStatusInput input ● CreditFacilityProductUpdateTermsInput input ● CreditFacilityProposal object ● CreditFacilityProposalCreateInput input ● CreditFacilityProposalFilter input ● PendingCreditFacility object ● PendingCreditFacilityFilter input
CreditFacilityProposalId
No description
scalar CreditFacilityProposalId
Member Of
creditFacilityProposal query ● CreditFacilityProposal object ● CreditFacilityProposalCustomerApprovalConcludeInput input ● creditFacilityProposalUpdated subscription ● CustomerCreditFacilityProposalApproved object ● CustomerCreditFacilityProposalCreated object ● CustomerCreditFacilityProposalDenied object
CurrencyCode
No description
scalar CurrencyCode
Member Of
AccountingCurrencyPolicyConfigureInput input ● CreditCurrencyPolicyConfigureInput input ● CreditFacilityProposalCreateInput input ● Currency object ● CurrencyVariant object ● CurrencyVariantInput input ● DepositAccountFilter input ● DepositAccountProductCreateInput input ● DepositAccountProductFilter input ● DepositCurrencyPolicyConfigureInput input ● FxCurrencyPolicy object ● FxCurrencyPolicyConfigureInput input ● ManualTransactionDraftEntry object ● ManualTransactionDraftEntryInput input ● MoneyInput input ● RailLiquidityByCurrency object ● WithdrawalDestinationInput input
CustodianId
No description
scalar CustodianId
Member Of
CreditFacilityProposalCreateInput input ● custodian query ● Custodian object ● CustodianConfigUpdateInput input
CustomerDocumentId
No description
scalar CustomerDocumentId
Member Of
customerDocument query ● CustomerDocument object ● CustomerDocumentArchived object ● CustomerDocumentArchiveInput input ● CustomerDocumentCreated object ● CustomerDocumentDeleteInput input ● CustomerDocumentDeletePayload object ● CustomerDocumentDeletionRequested object ● CustomerDocumentDownloadLinksGenerateInput input
CustomerId
No description
scalar CustomerId
Member Of
BitcoinPurchaseExecuteInput input ● BitcoinPurchaseFilter input ● CreditFacilityProposalCreateInput input ● customer query ● Customer object ● CustomerCloseInput input ● customerCreditFacilitiesUpdated subscription ● customerCreditFacilityProposalsUpdated subscription ● customerDepositAccountsUpdated subscription ● CustomerDocument object ● CustomerDocumentCreateInlineInput input ● CustomerDocumentCreateInput input ● CustomerFreezeInput input ● CustomerNoteCreateInput input ● customerPendingCreditFacilitiesUpdated subscription ● CustomerUnfreezeInput input ● customerUpdated subscription ● DepositAccount object ● DepositAccountCreateFromProductInput input ● PiiErasureSubjectInput input
Date
An ISO 8601 calendar date without time or timezone (e.g., 2024-01-15). The field defines what the date represents.
scalar Date
Member Of
balanceSheet query ● DateRangeInput input ● IndividualPartyCreateInput input ● IndividualPartyPersonalInfoUpdateInput input ● JournalEntriesFilter input ● LedgerTransaction object ● PersonalInfo object ● ReportFileDownloadLinkGenerateInput input ● Time object
Decimal
No description
scalar Decimal
Member Of
BitcoinPurchase object ● ExchangeRate object ● ExchangeRateProvider object ● LiquidationPayment object
DecisionReason
A decision reason: trimmed, non-empty, at most 1000 characters, without control, formatting or markup characters other than newlines.
scalar DecisionReason
Member Of
CustomerCloseInput input ● CustomerFreezeInput input ● CustomerUnfreezeInput input
DepositAccountId
No description
scalar DepositAccountId
Member Of
BitcoinPurchase object ● BitcoinPurchaseExecuteInput input ● CustomerDepositAccountClosed object ● CustomerDepositAccountEscheatable object ● CustomerDepositAccountFrozen object ● CustomerDepositAccountOpened object ● CustomerDepositAccountUnfrozen object ● Deposit object ● depositAccount query ● DepositAccount object ● DepositAccountCloseInput input ● DepositAccountFreezeInput input ● DepositAccountProductAgreement object ● DepositAccountUnfreezeInput input ● Withdrawal object ● WithdrawalInitiateInput input
DepositAccountProductAgreementId
No description
scalar DepositAccountProductAgreementId
Member Of
DepositAccountProductAgreement object
DepositAccountProductId
No description
scalar DepositAccountProductId
Member Of
DepositAccountCreateFromProductInput input ● DepositAccountFilter input ● depositAccountProduct query ● DepositAccountProduct object ● DepositAccountProductAgreement object ● DepositAccountProductUpdateStatusInput input ● DepositAccountProductUpdateTermsInput input
DepositAccountProductName
A deposit account product name: trimmed, non-empty, at most 100 characters, without control characters.
scalar DepositAccountProductName
Member Of
DepositAccountProductCreateInput input
DepositId
No description
scalar DepositId
Member Of
deposit query ● Deposit object ● DepositRevertInput input
DomainConfigId
No description
scalar DomainConfigId
Member Of
domainConfig query ● DomainConfig object ● DomainConfigUpdateInput input
EffectiveAnnualRatePct
No description
scalar EffectiveAnnualRatePct
Member Of
TermValues object
EodProcessId
No description
scalar EodProcessId
Member Of
eodProcess query ● EodProcess object ● EodProcessRestartInput input
FiscalYearId
No description
scalar FiscalYearId
Member Of
FiscalYear object
FiscalYearLabel
A four-digit fiscal year.
scalar FiscalYearLabel
Member Of
fiscalYearByYear query
Float
The Float scalar type represents signed double-precision fractional values as specified by IEEE 754.
scalar Float
Member Of
PipelineRunNodeResult object
IndividualPartyId
No description
scalar IndividualPartyId
Member Of
IndividualParty object ● IndividualPartyEmailUpdateInput input ● IndividualPartyPersonalInfoUpdateInput input ● IndividualPartyVerificationApproveManuallyInput input ● IndividualPartyVerificationLinkCreateInput input ● OrganizationMember object ● OrganizationPartyMemberAddInput input ● OrganizationPartyMemberRemoveInput input ● OrganizationPartyMemberRoleAddInput input ● OrganizationPartyMemberRoleRemoveInput input
Int
The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.
scalar Int
Member Of
approvalProcesses query ● audit query ● bitcoinPurchases query ● committees query ● creditFacilities query ● CreditFacilityInterestAccrued object ● creditFacilityProducts query ● CreditFacilityProductUpdateTermsInput input ● CreditFacilityProposalCreateInput input ● creditFacilityProposals query ● Currency object ● custodians query ● customers query ● DataMartModelSummary object ● DepositAccountCreateFromProductInput input ● depositAccountProducts query ● DepositAccountProductUpdateTermsInput input ● depositAccounts query ● deposits query ● disbursals query ● domainConfigs query ● Duration object ● DurationInput input ● DwReadonlyQueryExportLinkGeneratePayload object ● DwReadOnlyQueryResult object ● eodProcesses query ● EventTimelineEntry object ● exchangeRateProviders query ● fiscalYears query ● kycProviders query ● ledgerEntries query ● ledgerTransactionsForTemplateCode query ● liquidations query ● manualTransactionDrafts query ● manualTransactions query ● notificationProviders query ● obligations query ● partners query ● paymentProviders query ● payouts query ● pendingCreditFacilities query ● permissionSets query ● piiErasureProcesses query ● PipelineRunNodeResult object ● pipelineRuns query ● policies query ● prospects query ● queryTemplates query ● rails query ● receipts query ● roles query ● SmtpNotificationProviderConfigInput input ● SmtpNotificationProviderCreateInput input ● transactionTemplates query ● users query ● VersionedCreditFacilityProductTerms object ● VersionedDepositAccountProductTerms object ● withdrawals query
Json
No description
scalar Json
Member Of
DomainConfig object ● DomainConfigUpdateInput input ● EventTimelineEntry object
KycProviderId
No description
scalar KycProviderId
Member Of
IndividualProspectCreateInput input ● kycProvider query ● KycProvider object ● KycProviderConfigUpdateInput input ● OrganizationProspectCreateInput input
LedgerAccountCsvDocumentId
No description
scalar LedgerAccountCsvDocumentId
Member Of
LedgerAccountCsvDocument object ● LedgerAccountCsvDownloadLinkGenerateInput input ● LedgerAccountCsvExportUploadedPayload object
LedgerAccountId
No description
scalar LedgerAccountId
Member Of
BalanceSheetAccount object ● BalanceSheetAccountFlat object ● ChartIntegrationBinding object ● Collateral object ● CreditFacilityProductOmnibusAttachment object ● CreditFacilityProductSetAttachment object ● DepositAccountProductAccountSets object ● DepositAccountProductOmnibusAccounting object ● ledgerAccount query ● LedgerAccount object ● ledgerAccountCsv query ● LedgerAccountCsvCreateInput input ● LedgerAccountCsvDocument object ● ledgerAccountCsvExportUploaded subscription ● ProfitAndLossAccount object ● ProfitAndLossAccountFlat object
LedgerEntryId
No description
scalar LedgerEntryId
Member Of
LedgerEntry object
LedgerTransactionId
No description
scalar LedgerTransactionId
Member Of
CreditFacilityApproved object ● CreditFacilityCollateralSentOut object ● CreditFacilityDisbursalExecuted object ● CreditFacilityInterestAccrued object ● CreditFacilityLiquidationSaleRecorded object ● FreezeEntry object ● ledgerTransaction query ● LedgerTransaction object ● LiquidationCollateralSent object ● LiquidationSale object ● UnfreezeEntry object ● UnknownEntry object
LiquidationId
No description
scalar LiquidationId
Member Of
CollateralRecordLiquidationSaleInput input ● CreditFacilityCollateralizationUpdated object ● CustomerCollateralLiquidationStarted object ● liquidation query ● Liquidation object ● LiquidationPaymentCalculateInput input
LocatorId
No description
scalar LocatorId
Member Of
PaymentEndpointLocator object
LtvPctValue
No description
scalar LtvPctValue
Member Of
CreditFacilityTermsAlterationsInput input ● FiniteLtvPct object ● LiquidationPaymentCalculateInput input ● TermsInput input
ManualTransactionDraftId
No description
scalar ManualTransactionDraftId
Member Of
manualTransactionDraft query ● ManualTransactionDraft object ● ManualTransactionDraftCloseInput input ● ManualTransactionDraftPostInput input ● ManualTransactionDraftUpdateInput input
ManualTransactionId
No description
scalar ManualTransactionId
Member Of
manualTransaction query ● ManualTransaction object
MinorUnits
No description
scalar MinorUnits
Member Of
ManualTransactionDraftEntry object ● ManualTransactionDraftEntryInput input ● Money object ● MoneyInput input
NamePart
One part of a full name: trimmed, non-empty, at most 255 characters, without markup or invisible characters.
scalar NamePart
Member Of
FullNameInput input
NoteId
No description
scalar NoteId
Member Of
CustomerNoteCreated object ● CustomerNoteUpdateInput input ● Note object
NotificationProviderId
No description
scalar NotificationProviderId
Member Of
notificationProvider query ● NotificationProvider object ● NotificationProviderConfigUpdateInput input
ObligationId
No description
scalar ObligationId
Member Of
CustomerObligationDefaulted object ● Obligation object
OneTimeFeeRatePct
No description
scalar OneTimeFeeRatePct
Member Of
CreditFacilityTermsAlteration object ● CreditFacilityTermsAlterationsInput input ● TermsInput input ● TermValues object
OpenFiscalYearId
No description
scalar OpenFiscalYearId
Member Of
fiscalYear query ● FiscalYearCloseMonthInput input ● OpenFiscalYear object ● PastFiscalYear object
OptionalAddressPart
An optional part of a postal address: a blank value means absent, otherwise trimmed, at most 255 characters, without markup or invisible characters.
scalar OptionalAddressPart
Member Of
PostalAddressInput input
OrganizationMemberId
No description
scalar OrganizationMemberId
Member Of
OrganizationMember object
OrganizationPartyId
No description
scalar OrganizationPartyId
Member Of
OrganizationParty object ● OrganizationPartyDetailsUpdateInput input ● OrganizationPartyEmailUpdateInput input ● OrganizationPartyMemberAddInput input ● OrganizationPartyMemberRemoveInput input ● OrganizationPartyMemberRoleAddInput input ● OrganizationPartyMemberRoleRemoveInput input ● OrganizationPartyVerificationApproveManuallyInput input ● OrganizationPartyVerificationLinkCreateInput input
PartnerApiKeyId
No description
scalar PartnerApiKeyId
Member Of
PartnerApiKey object
PartnerId
No description
scalar PartnerId
Member Of
CreditFacilityFilter input ● CreditFacilityProduct object ● CreditFacilityProductCreateInput input ● CreditFacilityProductFilter input ● CreditFacilityProposalFilter input ● Customer object ● CustomerFilter input ● DepositAccountFilter input ● DepositAccountProduct object ● DepositAccountProductCreateInput input ● DepositAccountProductFilter input ● partner query ● Partner object ● PartnerActivateInput input ● PartnerApiKey object ● PartnerDeactivateInput input ● PartnerUpdateInput input ● PartnerUser object ● PendingCreditFacilityFilter input ● ProspectFilter input
PartnerName
A partner name: trimmed, non-empty, without markup or control characters.
scalar PartnerName
Member Of
PartnerCreateInput input ● PartnerUpdateInput input
PartnerUserId
No description
scalar PartnerUserId
Member Of
PartnerUser object
PastFiscalYearId
No description
scalar PastFiscalYearId
Member Of
FiscalYearCloseInput input ● PastFiscalYear object
PaymentAllocationId
No description
scalar PaymentAllocationId
Member Of
CreditFacilityIncrementalPayment object
PaymentEndpointId
No description
scalar PaymentEndpointId
Member Of
PaymentEndpoint object
PaymentProviderId
No description
scalar PaymentProviderId
Member Of
paymentProvider query ● PaymentProvider object ● PaymentProviderConfigUpdateInput input ● RailCreateInput input
PaymentProviderName
The name of a payment provider: not blank.
scalar PaymentProviderName
Member Of
CircleProviderConfigInput input ● ManualProviderConfigInput input
PayoutDraftId
No description
scalar PayoutDraftId
Member Of
PayoutDraft object
PayoutId
No description
scalar PayoutId
Member Of
payout query ● Payout object ● PayoutCancelInput input ● PayoutFailInput input ● PayoutRevertInput input ● PayoutSettleInput input
PendingCreditFacilityId
No description
scalar PendingCreditFacilityId
Member Of
pendingCreditFacility query ● PendingCreditFacility object ● pendingCreditFacilityUpdated subscription
PermissionSetId
No description
scalar PermissionSetId
Member Of
permissionSet query ● PermissionSet object ● RoleCreateInput input ● RolePermissionSetsAddInput input ● RolePermissionSetsRemoveInput input
PiiErasureProcessId
No description
scalar PiiErasureProcessId
Member Of
piiErasureProcess query ● PiiErasureProcess object
PipelineRunId
No description
scalar PipelineRunId
Member Of
pipelineRun query ● PipelineRun object
PolicyId
No description
scalar PolicyId
Member Of
policy query ● Policy object ● PolicyCommitteeAssignInput input
PriceProviderId
No description
scalar PriceProviderId
Member Of
exchangeRateProvider query ● ExchangeRateProvider object ● ExchangeRateProviderActivateInput input ● ExchangeRateProviderDeactivateInput input ● ExchangeRateProviderManualExchangeRateUpdateInput input
ProspectId
No description
scalar ProspectId
Member Of
PiiErasureSubjectInput input ● prospect query ● Prospect object ● ProspectCloseInput input ● prospectUpdated subscription
PublicId
No description
scalar PublicId
Member Of
BitcoinPurchase object ● CreditFacility object ● creditFacilityByPublicId query ● CreditFacilityDisbursal object ● Customer object ● customerByPublicId query ● Deposit object ● DepositAccount object ● depositAccountByPublicId query ● depositByPublicId query ● disbursalByPublicId query ● Prospect object ● prospectByPublicId query ● publicIdTarget query ● Withdrawal object ● withdrawalByPublicId query
QueryTemplateId
No description
scalar QueryTemplateId
Member Of
DashboardCardTemplate object ● queryTemplate query ● QueryTemplate object ● QueryTemplateDeleteInput input ● QueryTemplateDeletePayloadSuccess object ● QueryTemplateUpdateInput input
RailId
No description
scalar RailId
Member Of
Payout object ● PayoutDraft object ● rail query ● Rail object ● RailLiquidity object ● Receipt object ● ReceiptSubmitInput input
RailName
The name of a rail: not blank.
scalar RailName
Member Of
RailCreateInput input
ReceiptId
No description
scalar ReceiptId
Member Of
receipt query ● Receipt object ● ReceiptCancelInput input ● ReceiptFailInput input ● ReceiptSettleInput input
ReportDefinitionId
No description
scalar ReportDefinitionId
Member Of
ReportDefinition object ● ReportFileDownloadLinkGenerateInput input
RoleId
No description
scalar RoleId
Member Of
role query ● Role object ● RolePermissionSetsAddInput input ● RolePermissionSetsRemoveInput input ● UserCreateInput input ● UserRoleUpdateInput input
RoleName
The name of a role: lowercase Latin letters, digits and hyphens after canonicalization, at most 100 characters.
scalar RoleName
Member Of
RoleCreateInput input
Secret
An opaque secret value (token, password, API key). Treated as write-only — never echoed back in query responses.
scalar Secret
Member Of
BitgoConfigInput input ● CircleProviderConfigInput input ● KomainuConfigInput input ● PersonaKycProviderConfigInput input ● PersonaKycProviderCreateInput input ● SmtpNotificationProviderConfigInput input ● SmtpNotificationProviderCreateInput input ● SumsubKycProviderConfigInput input ● SumsubKycProviderCreateInput input
SignedMinorUnits
No description
scalar SignedMinorUnits
Member Of
SignedMoney object
String
The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
scalar String
Returned By
environmentBanner query
Member Of
ApprovalProcess object ● ApprovalProcessDenyInput input ● ApprovalProcessEdge object ● approvalProcesses query ● audit query ● AuditEntry object ● AuditEntryEdge object ● Automation object ● BalanceSheet object ● BalanceSheetAccount object ● BalanceSheetAccountFlat object ● BitcoinPurchaseEdge object ● bitcoinPurchases query ● BitgoConfigInput input ● BitgoCustodianCreateInput input ● BuildInfo object ● ChartNode object ● ChartOfAccounts object ● CircleProviderConfigInput input ● Committee object ● CommitteeCreateInput input ● CommitteeEdge object ● committees query ● creditFacilities query ● CreditFacilityDisbursalEdge object ● CreditFacilityEdge object ● CreditFacilityProduct object ● CreditFacilityProductCreateInput input ● CreditFacilityProductEdge object ● creditFacilityProducts query ● CreditFacilityProposalEdge object ● creditFacilityProposals query ● CurrencyVariant object ● CurrencyVariantInput input ● Custodian object ● CustodianEdge object ● custodians query ● CustomerClosed object ● CustomerDocument object ● CustomerDocumentCreateInlineInput input ● CustomerEdge object ● CustomerFrozen object ● CustomerNoteCreateInput input ● CustomerNoteUpdateInput input ● customers query ● CustomerTimelineEntryEdge object ● CustomerUnfrozen object ● DashboardCardTemplate object ● DataMartColumn object ● DataMartModel object ● dataMartModelDetails query ● DataMartModelSummary object ● Deposit object ● DepositAccountEdge object ● DepositAccountHistoryEntryEdge object ● DepositAccountProduct object ● DepositAccountProductEdge object ● depositAccountProducts query ● depositAccounts query ● DepositEdge object ● deposits query ● deprecated directive ● DestinationInfo object ● DestinationInfoInput input ● disbursals query ● DomainConfig object ● DomainConfigEdge object ● domainConfigs query ● DwReadonlyQueryExportLinkGenerateInput input ● DwReadOnlyQueryResult object ● dwRunReadonlyQuery query ● EodProcess object ● EodProcessEdge object ● eodProcesses query ● EodProcessPhase object ● EventTimelineEntry object ● EventTimelineEntryEdge object ● ExchangeRateProvider object ● ExchangeRateProviderEdge object ● exchangeRateProviders query ● FiscalYear object ● FiscalYearEdge object ● fiscalYears query ● FullName object ● IndividualPartyCreateInput input ● IndividualPartyEmailUpdateInput input ● IndividualProspectCreateInput input ● Integration object ● KomainuCustodianCreateInput input ● KycProvider object ● KycProviderEdge object ● kycProviders query ● LedgerAccount object ● LedgerAccountCsvDocument object ● ledgerEntries query ● LedgerEntry object ● LedgerEntryEdge object ● LedgerTransaction object ● LedgerTransactionEdge object ● ledgerTransactionsForTemplateCode query ● LiquidationEdge object ● liquidations query ● ManualCustodianCreateInput input ● ManualTransaction object ● manualTransactionByReference query ● ManualTransactionDraft object ● ManualTransactionDraftCreateInput input ● ManualTransactionDraftEdge object ● ManualTransactionDraftEntry object ● ManualTransactionDraftEntryInput input ● manualTransactionDrafts query ● ManualTransactionDraftUpdateInput input ● ManualTransactionEdge object ● ManualTransactionEntry object ● ManualTransactionEntryInput input ● ManualTransactionPostInput input ● manualTransactions query ● ManualTransactionValidateInput input ● Note object ● NoteEdge object ● NotificationProvider object ● NotificationProviderEdge object ● notificationProviders query ● ObligationEdge object ● obligations query ● OpenFiscalYear object ● OrganizationMember object ● OrganizationParty object ● OrganizationPartyDetailsUpdateInput input ● OrganizationPartyEmailUpdateInput input ● OrganizationPartyMemberAddInput input ● OrganizationPartyMemberRoleAddInput input ● OrganizationPartyMemberRoleRemoveInput input ● OrganizationProspectCreateInput input ● PageInfo object ● Partner object ● PartnerApiKey object ● PartnerCreateInput input ● PartnerEdge object ● partners query ● PartnerUser object ● PartnerUserEdge object ● PastFiscalYear object ● PaymentEndpointLocator object ● PaymentProvider object ● PaymentProviderEdge object ● paymentProviders query ● Payout object ● PayoutDestination object ● PayoutDraft object ● PayoutEdge object ● payouts query ● pendingCreditFacilities query ● PendingCreditFacilityEdge object ● PermissionSet object ● PermissionSetEdge object ● permissionSets query ● PersonaKycProviderConfigInput input ● PersonaKycProviderCreateInput input ● PiiEmail object ● PiiErasureProcessEdge object ● piiErasureProcesses query ● PiiErasureProcessPhase object ● PipelineRun object ● PipelineRunEdge object ● PipelineRunNodeResult object ● pipelineRuns query ● policies query ● PolicyEdge object ● PostalAddress object ● ProfitAndLossAccount object ● ProfitAndLossAccountFlat object ● ProfitAndLossStatement object ● ProspectEdge object ● prospects query ● QueryTemplate object ● QueryTemplateCreateInput input ● QueryTemplateEdge object ● queryTemplates query ● QueryTemplateUpdateInput input ● Rail object ● RailEdge object ● rails query ● Receipt object ● ReceiptClaim object ● ReceiptEdge object ● receipts query ● ReceiptSubmitInput input ● ReportDefinition object ● ReportFileDownloadLinkGenerateInput input ● Role object ● RoleEdge object ● roles query ● SmtpNotificationProviderConfigInput input ● SmtpNotificationProviderCreateInput input ● specifiedBy directive ● SumsubKycProviderConfigInput input ● SumsubKycProviderCreateInput input ● Time object ● TransactionTemplate object ● TransactionTemplateEdge object ● transactionTemplates query ● TrialBalance object ● User object ● UserCreateInput input ● UserEdge object ● users query ● Verification object ● Wallet object ● Withdrawal object ● WithdrawalDestinationInput input ● WithdrawalEdge object ● WithdrawalInitiateInput input ● withdrawals query ● workflow_output directive ● workflow_require directive
Timestamp
An ISO 8601 UTC timestamp (e.g., 2024-01-15T09:30:00Z). Always in UTC.
scalar Timestamp
Member Of
ApprovalProcess object ● ApprovalProcessVoter object ● AuditEntry object ● BitcoinPurchase object ● CancelledWithdrawalEntry object ● Committee object ● CreditFacility object ● CreditFacilityAgreement object ● CreditFacilityApproved object ● CreditFacilityCollateralizationUpdated object ● CreditFacilityCollateralSentOut object ● CreditFacilityCollateralUpdated object ● CreditFacilityDisbursal object ● CreditFacilityDisbursalExecuted object ● CreditFacilityIncrementalPayment object ● CreditFacilityInterestAccrued object ● CreditFacilityLiquidationSaleRecorded object ● CreditFacilityPaymentAllocation object ● CreditFacilityProduct object ● CreditFacilityProposal object ● CreditFacilityRepaymentPlanEntry object ● Custodian object ● Customer object ● CustomerBitcoinPurchaseExecuted object ● CustomerClosed object ● CustomerCollateralLiquidationStarted object ● CustomerCreated object ● CustomerCreditFacilityActivated object ● CustomerCreditFacilityCompleted object ● CustomerCreditFacilityMatured object ● CustomerCreditFacilityProposalApproved object ● CustomerCreditFacilityProposalCreated object ● CustomerCreditFacilityProposalDenied object ● CustomerDepositAccountClosed object ● CustomerDepositAccountEscheatable object ● CustomerDepositAccountFrozen object ● CustomerDepositAccountOpened object ● CustomerDepositAccountUnfrozen object ● CustomerDocument object ● CustomerDocumentArchived object ● CustomerDocumentCreated object ● CustomerDocumentDeletionRequested object ● CustomerFrozen object ● CustomerNoteCreated object ● CustomerObligationDefaulted object ● CustomerPiiErasureCancelled object ● CustomerPiiErasureCompleted object ● CustomerPiiErasureScheduled object ● CustomerUnfrozen object ● Dashboard object ● Deposit object ● DepositAccount object ● DepositAccountProduct object ● DepositAccountProductAgreement object ● DepositEntry object ● DisbursalEntry object ● EodProcess object ● EodProcessPhase object ● EventTimelineEntry object ● ExchangeRate object ● ExchangeRateProvider object ● FiscalMonthClosure object ● FiscalYear object ● FreezeEntry object ● JournalEntriesFilter input ● KycProvider object ● LedgerAccountCsvDocument object ● LedgerEntry object ● LedgerTransaction object ● Liquidation object ● ManualTransaction object ● ManualTransactionDraft object ● ManualTransactionFilter input ● Note object ● NotificationProvider object ● Obligation object ● OpenFiscalYear object ● Partner object ● PartnerApiKey object ● PartnerUser object ● PastFiscalYear object ● PaymentEntry object ● PaymentProvider object ● Payout object ● PayoutDraft object ● PendingCreditFacility object ● PendingCreditFacilityCollateralizationUpdated object ● PiiErasureProcess object ● PiiErasureProcessPhase object ● PipelineRun object ● Prospect object ● QueryTemplate object ● Rail object ● Receipt object ● Role object ● Time object ● UnfreezeEntry object ● UnknownEntry object ● User object ● Verification object ● Withdrawal object ● WithdrawalEntry object
TransactionTemplateId
No description
scalar TransactionTemplateId
Member Of
TransactionTemplate object
Upload
A multipart file upload
scalar Upload
Member Of
ChartOfAccountsInitializeInput input ● CustomerDocumentCreateInput input
Url
A valid URL string (e.g., https://example.com/path).
scalar Url
Member Of
BitgoConfigInput input ● CreditFacilityAgreementDownloadLinksGeneratePayload object ● CustomerDocumentDownloadLinksGeneratePayloadSuccess object ● DwReadonlyQueryExportLinkGeneratePayload object ● LedgerAccountCsvDownloadLinkGeneratePayloadSuccess object ● ReportFileDownloadLinkGeneratePayload object ● VerificationLinkCreatePayloadSuccess object
UserId
No description
scalar UserId
Member Of
CommitteeCreateInput input ● CommitteeUserAddInput input ● CommitteeUserRemoveInput input ● user query ● User object ● UserRoleUpdateInput input
VerificationId
No description
scalar VerificationId
Member Of
Verification object ● verificationUpdated subscription
WalletId
No description
scalar WalletId
Member Of
Collateral object ● Wallet object
WithdrawalId
No description
scalar WithdrawalId
Member Of
withdrawal query ● Withdrawal object ● withdrawalUpdated subscription
Yaml
No description
scalar Yaml
Returned By
appConfig query
Unions
AccountingCurrencyPolicyConfigurePayload
No description
union AccountingCurrencyPolicyConfigurePayload = AccountingCurrencyPolicyConfigurePayloadSuccess | AccountingCurrencyPolicyConfigurePayloadError
Possible types
AccountingCurrencyPolicyConfigurePayload.AccountingCurrencyPolicyConfigurePayloadSuccess object
AccountingCurrencyPolicyConfigurePayload.AccountingCurrencyPolicyConfigurePayloadError object
Returned By
accountingCurrencyPolicyConfigure mutation
ApprovalProcessApprovePayload
No description
union ApprovalProcessApprovePayload = ApprovalProcessApprovePayloadSuccess | ApprovalProcessApprovePayloadError
Possible types
ApprovalProcessApprovePayload.ApprovalProcessApprovePayloadSuccess object
ApprovalProcessApprovePayload.ApprovalProcessApprovePayloadError object
Returned By
approvalProcessApprove mutation
ApprovalProcessDenyPayload
No description
union ApprovalProcessDenyPayload = ApprovalProcessDenyPayloadSuccess | ApprovalProcessDenyPayloadError
Possible types
ApprovalProcessDenyPayload.ApprovalProcessDenyPayloadSuccess object
ApprovalProcessDenyPayload.ApprovalProcessDenyPayloadError object
Returned By
approvalProcessDeny mutation
ApprovalProcessTarget
No description
union ApprovalProcessTarget = Withdrawal | CreditFacilityProposal | CreditFacilityDisbursal
Possible types
ApprovalProcessTarget.Withdrawal object
ApprovalProcessTarget.CreditFacilityProposal object
ApprovalProcessTarget.CreditFacilityDisbursal object
Member Of
ApprovalProcess object
ApprovalRules
No description
union ApprovalRules = AutoApproval | CommitteeApproval
Possible types
ApprovalRules.AutoApproval object
ApprovalRules.CommitteeApproval object
Member Of
ApprovalProcess object ● Policy object
AuditSubject
No description
union AuditSubject = User | Automation | Integration | Customer | PartnerUser | PartnerApiKey
Possible types
AuditSubject.User object
AuditSubject.Automation object
AuditSubject.Integration object
AuditSubject.Customer object
AuditSubject.PartnerUser object
AuditSubject.PartnerApiKey object
Member Of
AuditEntry object ● EventTimelineEntry object ● LedgerTransaction object ● Note object
BitcoinInventoryFundPayload
No description
union BitcoinInventoryFundPayload = BitcoinInventoryFundPayloadSuccess | BitcoinInventoryFundPayloadError
Possible types
BitcoinInventoryFundPayload.BitcoinInventoryFundPayloadSuccess object
BitcoinInventoryFundPayload.BitcoinInventoryFundPayloadError object
Returned By
bitcoinInventoryFund mutation
BitcoinPurchaseExecutePayload
No description
union BitcoinPurchaseExecutePayload = BitcoinPurchaseExecutePayloadSuccess | BitcoinPurchaseExecutePayloadError
Possible types
BitcoinPurchaseExecutePayload.BitcoinPurchaseExecutePayloadSuccess object
BitcoinPurchaseExecutePayload.BitcoinPurchaseExecutePayloadError object
Returned By
bitcoinPurchaseExecute mutation
ChartOfAccountsAddChildNodePayload
No description
union ChartOfAccountsAddChildNodePayload = ChartOfAccountsAddChildNodePayloadSuccess | ChartOfAccountsAddChildNodePayloadError
Possible types
ChartOfAccountsAddChildNodePayload.ChartOfAccountsAddChildNodePayloadSuccess object
ChartOfAccountsAddChildNodePayload.ChartOfAccountsAddChildNodePayloadError object
Returned By
chartOfAccountsAddChildNode mutation
ChartOfAccountsInitializePayload
No description
union ChartOfAccountsInitializePayload = ChartOfAccountsInitializePayloadSuccess | ChartOfAccountsInitializePayloadError
Possible types
ChartOfAccountsInitializePayload.ChartOfAccountsInitializePayloadSuccess object
ChartOfAccountsInitializePayload.ChartOfAccountsInitializePayloadError object
Returned By
chartOfAccountsInitialize mutation
CollateralRecordLiquidationSalePayload
No description
union CollateralRecordLiquidationSalePayload = CollateralRecordLiquidationSalePayloadSuccess | CollateralRecordLiquidationSalePayloadError
Possible types
CollateralRecordLiquidationSalePayload.CollateralRecordLiquidationSalePayloadSuccess object
CollateralRecordLiquidationSalePayload.CollateralRecordLiquidationSalePayloadError object
Returned By
collateralRecordLiquidationSale mutation
CollateralRecordSentToLiquidationPayload
No description
union CollateralRecordSentToLiquidationPayload = CollateralRecordSentToLiquidationPayloadSuccess | CollateralRecordSentToLiquidationPayloadError
Possible types
CollateralRecordSentToLiquidationPayload.CollateralRecordSentToLiquidationPayloadSuccess object
CollateralRecordSentToLiquidationPayload.CollateralRecordSentToLiquidationPayloadError object
Returned By
collateralRecordSentToLiquidation mutation
CollateralUpdatePayload
No description
union CollateralUpdatePayload = CollateralUpdatePayloadSuccess | CollateralUpdatePayloadError
Possible types
CollateralUpdatePayload.CollateralUpdatePayloadSuccess object
CollateralUpdatePayload.CollateralUpdatePayloadError object
Returned By
collateralUpdate mutation
CommitteeCreatePayload
No description
union CommitteeCreatePayload = CommitteeCreatePayloadSuccess | CommitteeCreatePayloadError
Possible types
CommitteeCreatePayload.CommitteeCreatePayloadSuccess object
CommitteeCreatePayload.CommitteeCreatePayloadError object
Returned By
committeeCreate mutation
CommitteeUserAddPayload
No description
union CommitteeUserAddPayload = CommitteeUserAddPayloadSuccess | CommitteeUserAddPayloadError
Possible types
CommitteeUserAddPayload.CommitteeUserAddPayloadSuccess object
CommitteeUserAddPayload.CommitteeUserAddPayloadError object
Returned By
committeeUserAdd mutation
CommitteeUserRemovePayload
No description
union CommitteeUserRemovePayload = CommitteeUserRemovePayloadSuccess | CommitteeUserRemovePayloadError
Possible types
CommitteeUserRemovePayload.CommitteeUserRemovePayloadSuccess object
CommitteeUserRemovePayload.CommitteeUserRemovePayloadError object
Returned By
committeeUserRemove mutation
CreditAccountingIntegrationConfigurePayload
No description
union CreditAccountingIntegrationConfigurePayload = CreditAccountingIntegrationConfigurePayloadSuccess | CreditAccountingIntegrationConfigurePayloadError
Possible types
CreditAccountingIntegrationConfigurePayload.CreditAccountingIntegrationConfigurePayloadSuccess object
CreditAccountingIntegrationConfigurePayload.CreditAccountingIntegrationConfigurePayloadError object
Returned By
creditAccountingIntegrationConfigure mutation
CreditCurrencyPolicyConfigurePayload
No description
union CreditCurrencyPolicyConfigurePayload = CreditCurrencyPolicyConfigurePayloadSuccess | CreditCurrencyPolicyConfigurePayloadError
Possible types
CreditCurrencyPolicyConfigurePayload.CreditCurrencyPolicyConfigurePayloadSuccess object
CreditCurrencyPolicyConfigurePayload.CreditCurrencyPolicyConfigurePayloadError object
Returned By
creditCurrencyPolicyConfigure mutation
CreditFacilityAgreementGeneratePayload
No description
union CreditFacilityAgreementGeneratePayload = CreditFacilityAgreementGeneratePayloadSuccess | CreditFacilityAgreementGeneratePayloadError
Possible types
CreditFacilityAgreementGeneratePayload.CreditFacilityAgreementGeneratePayloadSuccess object
CreditFacilityAgreementGeneratePayload.CreditFacilityAgreementGeneratePayloadError object
Returned By
creditFacilityAgreementGenerate mutation
CreditFacilityCompletePayload
No description
union CreditFacilityCompletePayload = CreditFacilityCompletePayloadSuccess | CreditFacilityCompletePayloadError
Possible types
CreditFacilityCompletePayload.CreditFacilityCompletePayloadSuccess object
CreditFacilityCompletePayload.CreditFacilityCompletePayloadError object
Returned By
creditFacilityComplete mutation
CreditFacilityDisbursalInitiatePayload
No description
union CreditFacilityDisbursalInitiatePayload = CreditFacilityDisbursalInitiatePayloadSuccess | CreditFacilityDisbursalInitiatePayloadError
Possible types
CreditFacilityDisbursalInitiatePayload.CreditFacilityDisbursalInitiatePayloadSuccess object
CreditFacilityDisbursalInitiatePayload.CreditFacilityDisbursalInitiatePayloadError object
Returned By
creditFacilityDisbursalInitiate mutation
CreditFacilityHistoryEntry
No description
union CreditFacilityHistoryEntry = CreditFacilityIncrementalPayment | CreditFacilityCollateralUpdated | CreditFacilityApproved | PendingCreditFacilityCollateralizationUpdated | CreditFacilityCollateralizationUpdated | CreditFacilityDisbursalExecuted | CreditFacilityInterestAccrued | CreditFacilityCollateralSentOut | CreditFacilityLiquidationSaleRecorded
Possible types
CreditFacilityHistoryEntry.CreditFacilityIncrementalPayment object
CreditFacilityHistoryEntry.CreditFacilityCollateralUpdated object
CreditFacilityHistoryEntry.CreditFacilityApproved object
CreditFacilityHistoryEntry.PendingCreditFacilityCollateralizationUpdated object
CreditFacilityHistoryEntry.CreditFacilityCollateralizationUpdated object
CreditFacilityHistoryEntry.CreditFacilityDisbursalExecuted object
CreditFacilityHistoryEntry.CreditFacilityInterestAccrued object
CreditFacilityHistoryEntry.CreditFacilityCollateralSentOut object
CreditFacilityHistoryEntry.CreditFacilityLiquidationSaleRecorded object
Member Of
CreditFacility object
CreditFacilityPartialPaymentRecordPayload
No description
union CreditFacilityPartialPaymentRecordPayload = CreditFacilityPartialPaymentRecordPayloadSuccess | CreditFacilityPartialPaymentRecordPayloadError
Possible types
CreditFacilityPartialPaymentRecordPayload.CreditFacilityPartialPaymentRecordPayloadSuccess object
CreditFacilityPartialPaymentRecordPayload.CreditFacilityPartialPaymentRecordPayloadError object
Returned By
creditFacilityPartialPaymentRecord mutation ● creditFacilityPartialPaymentWithDateRecord mutation
CreditFacilityProductCreatePayload
No description
union CreditFacilityProductCreatePayload = CreditFacilityProductCreatePayloadSuccess | CreditFacilityProductCreatePayloadError
Possible types
CreditFacilityProductCreatePayload.CreditFacilityProductCreatePayloadSuccess object
CreditFacilityProductCreatePayload.CreditFacilityProductCreatePayloadError object
Returned By
creditFacilityProductCreate mutation
CreditFacilityProductUpdateStatusPayload
No description
union CreditFacilityProductUpdateStatusPayload = CreditFacilityProductUpdateStatusPayloadSuccess | CreditFacilityProductUpdateStatusPayloadError
Possible types
CreditFacilityProductUpdateStatusPayload.CreditFacilityProductUpdateStatusPayloadSuccess object
CreditFacilityProductUpdateStatusPayload.CreditFacilityProductUpdateStatusPayloadError object
Returned By
creditFacilityProductUpdateStatus mutation
CreditFacilityProductUpdateTermsPayload
No description
union CreditFacilityProductUpdateTermsPayload = CreditFacilityProductUpdateTermsPayloadSuccess | CreditFacilityProductUpdateTermsPayloadError
Possible types
CreditFacilityProductUpdateTermsPayload.CreditFacilityProductUpdateTermsPayloadSuccess object
CreditFacilityProductUpdateTermsPayload.CreditFacilityProductUpdateTermsPayloadError object
Returned By
creditFacilityProductUpdateTerms mutation
CreditFacilityProposalCreatePayload
No description
union CreditFacilityProposalCreatePayload = CreditFacilityProposalCreatePayloadSuccess | CreditFacilityProposalCreatePayloadError
Possible types
CreditFacilityProposalCreatePayload.CreditFacilityProposalCreatePayloadSuccess object
CreditFacilityProposalCreatePayload.CreditFacilityProposalCreatePayloadError object
Returned By
creditFacilityProposalCreate mutation
CreditFacilityProposalCustomerApprovalConcludePayload
No description
union CreditFacilityProposalCustomerApprovalConcludePayload = CreditFacilityProposalCustomerApprovalConcludePayloadSuccess | CreditFacilityProposalCustomerApprovalConcludePayloadError
Possible types
CreditFacilityProposalCustomerApprovalConcludePayload.CreditFacilityProposalCustomerApprovalConcludePayloadSuccess object
CreditFacilityProposalCustomerApprovalConcludePayload.CreditFacilityProposalCustomerApprovalConcludePayloadError object
Returned By
creditFacilityProposalCustomerApprovalConclude mutation
CustodianConfigUpdatePayload
No description
union CustodianConfigUpdatePayload = CustodianConfigUpdatePayloadSuccess | CustodianConfigUpdatePayloadError
Possible types
CustodianConfigUpdatePayload.CustodianConfigUpdatePayloadSuccess object
CustodianConfigUpdatePayload.CustodianConfigUpdatePayloadError object
Returned By
custodianConfigUpdate mutation
CustodianCreatePayload
No description
union CustodianCreatePayload = CustodianCreatePayloadSuccess | CustodianCreatePayloadError
Possible types
CustodianCreatePayload.CustodianCreatePayloadSuccess object
CustodianCreatePayload.CustodianCreatePayloadError object
Returned By
custodianCreate mutation
CustomerClosePayload
No description
union CustomerClosePayload = CustomerClosePayloadSuccess | CustomerClosePayloadError
Possible types
CustomerClosePayload.CustomerClosePayloadSuccess object
CustomerClosePayload.CustomerClosePayloadError object
Returned By
customerClose mutation
CustomerDocumentArchivePayload
No description
union CustomerDocumentArchivePayload = CustomerDocumentArchivePayloadSuccess | CustomerDocumentArchivePayloadError
Possible types
CustomerDocumentArchivePayload.CustomerDocumentArchivePayloadSuccess object
CustomerDocumentArchivePayload.CustomerDocumentArchivePayloadError object
Returned By
customerDocumentArchive mutation
CustomerDocumentCreateInlinePayload
No description
union CustomerDocumentCreateInlinePayload = CustomerDocumentCreateInlinePayloadSuccess | CustomerDocumentCreateInlinePayloadError
Possible types
CustomerDocumentCreateInlinePayload.CustomerDocumentCreateInlinePayloadSuccess object
CustomerDocumentCreateInlinePayload.CustomerDocumentCreateInlinePayloadError object
Returned By
customerDocumentCreateInline mutation
CustomerDocumentCreatePayload
No description
union CustomerDocumentCreatePayload = CustomerDocumentCreatePayloadSuccess | CustomerDocumentCreatePayloadError
Possible types
CustomerDocumentCreatePayload.CustomerDocumentCreatePayloadSuccess object
CustomerDocumentCreatePayload.CustomerDocumentCreatePayloadError object
Returned By
customerDocumentCreate mutation
CustomerDocumentDownloadLinksGeneratePayload
No description
union CustomerDocumentDownloadLinksGeneratePayload = CustomerDocumentDownloadLinksGeneratePayloadSuccess | CustomerDocumentDownloadLinksGeneratePayloadError
Possible types
CustomerDocumentDownloadLinksGeneratePayload.CustomerDocumentDownloadLinksGeneratePayloadSuccess object
CustomerDocumentDownloadLinksGeneratePayload.CustomerDocumentDownloadLinksGeneratePayloadError object
Returned By
customerDocumentDownloadLinkGenerate mutation
CustomerFreezePayload
No description
union CustomerFreezePayload = CustomerFreezePayloadSuccess | CustomerFreezePayloadError
Possible types
CustomerFreezePayload.CustomerFreezePayloadSuccess object
CustomerFreezePayload.CustomerFreezePayloadError object
Returned By
customerFreeze mutation
CustomerNoteCreatePayload
No description
union CustomerNoteCreatePayload = CustomerNoteCreatePayloadSuccess | CustomerNoteCreatePayloadError
Possible types
CustomerNoteCreatePayload.CustomerNoteCreatePayloadSuccess object
CustomerNoteCreatePayload.CustomerNoteCreatePayloadError object
Returned By
customerNoteCreate mutation
CustomerNoteUpdatePayload
No description
union CustomerNoteUpdatePayload = CustomerNoteUpdatePayloadSuccess | CustomerNoteUpdatePayloadError
Possible types
CustomerNoteUpdatePayload.CustomerNoteUpdatePayloadSuccess object
CustomerNoteUpdatePayload.CustomerNoteUpdatePayloadError object
Returned By
customerNoteUpdate mutation
CustomerTimelineEntry
No description
union CustomerTimelineEntry = CustomerCreated | CustomerFrozen | CustomerUnfrozen | CustomerClosed | CustomerPiiErasureScheduled | CustomerPiiErasureCancelled | CustomerPiiErasureCompleted | CustomerDepositAccountOpened | CustomerDepositAccountFrozen | CustomerDepositAccountUnfrozen | CustomerDepositAccountClosed | CustomerDepositAccountEscheatable | CustomerCreditFacilityProposalCreated | CustomerCreditFacilityProposalApproved | CustomerCreditFacilityProposalDenied | CustomerCreditFacilityActivated | CustomerCreditFacilityMatured | CustomerCreditFacilityCompleted | CustomerCollateralLiquidationStarted | CustomerObligationDefaulted | CustomerBitcoinPurchaseExecuted | CustomerDocumentCreated | CustomerDocumentArchived | CustomerDocumentDeletionRequested | CustomerNoteCreated
Possible types
CustomerTimelineEntry.CustomerCreated object
CustomerTimelineEntry.CustomerFrozen object
CustomerTimelineEntry.CustomerUnfrozen object
CustomerTimelineEntry.CustomerClosed object
CustomerTimelineEntry.CustomerPiiErasureScheduled object
CustomerTimelineEntry.CustomerPiiErasureCancelled object
CustomerTimelineEntry.CustomerPiiErasureCompleted object
CustomerTimelineEntry.CustomerDepositAccountOpened object
CustomerTimelineEntry.CustomerDepositAccountFrozen object
CustomerTimelineEntry.CustomerDepositAccountUnfrozen object
CustomerTimelineEntry.CustomerDepositAccountClosed object
CustomerTimelineEntry.CustomerDepositAccountEscheatable object
CustomerTimelineEntry.CustomerCreditFacilityProposalCreated object
CustomerTimelineEntry.CustomerCreditFacilityProposalApproved object
CustomerTimelineEntry.CustomerCreditFacilityProposalDenied object
CustomerTimelineEntry.CustomerCreditFacilityActivated object
CustomerTimelineEntry.CustomerCreditFacilityMatured object
CustomerTimelineEntry.CustomerCreditFacilityCompleted object
CustomerTimelineEntry.CustomerCollateralLiquidationStarted object
CustomerTimelineEntry.CustomerObligationDefaulted object
CustomerTimelineEntry.CustomerBitcoinPurchaseExecuted object
CustomerTimelineEntry.CustomerDocumentCreated object
CustomerTimelineEntry.CustomerDocumentArchived object
CustomerTimelineEntry.CustomerDocumentDeletionRequested object
CustomerTimelineEntry.CustomerNoteCreated object
Member Of
CustomerTimelineEntryConnection object ● CustomerTimelineEntryEdge object
CustomerUnfreezePayload
No description
union CustomerUnfreezePayload = CustomerUnfreezePayloadSuccess | CustomerUnfreezePayloadError
Possible types
CustomerUnfreezePayload.CustomerUnfreezePayloadSuccess object
CustomerUnfreezePayload.CustomerUnfreezePayloadError object
Returned By
customerUnfreeze mutation
DepositAccountClosePayload
No description
union DepositAccountClosePayload = DepositAccountClosePayloadSuccess | DepositAccountClosePayloadError
Possible types
DepositAccountClosePayload.DepositAccountClosePayloadSuccess object
DepositAccountClosePayload.DepositAccountClosePayloadError object
Returned By
depositAccountClose mutation
DepositAccountCreateFromProductPayload
No description
union DepositAccountCreateFromProductPayload = DepositAccountCreateFromProductPayloadSuccess | DepositAccountCreateFromProductPayloadError
Possible types
DepositAccountCreateFromProductPayload.DepositAccountCreateFromProductPayloadSuccess object
DepositAccountCreateFromProductPayload.DepositAccountCreateFromProductPayloadError object
Returned By
depositAccountCreateFromProduct mutation
DepositAccountFreezePayload
No description
union DepositAccountFreezePayload = DepositAccountFreezePayloadSuccess | DepositAccountFreezePayloadError
Possible types
DepositAccountFreezePayload.DepositAccountFreezePayloadSuccess object
DepositAccountFreezePayload.DepositAccountFreezePayloadError object
Returned By
depositAccountFreeze mutation
DepositAccountHistoryEntry
No description
union DepositAccountHistoryEntry = DepositEntry | WithdrawalEntry | CancelledWithdrawalEntry | DisbursalEntry | PaymentEntry | FreezeEntry | UnfreezeEntry | UnknownEntry
Possible types
DepositAccountHistoryEntry.DepositEntry object
DepositAccountHistoryEntry.WithdrawalEntry object
DepositAccountHistoryEntry.CancelledWithdrawalEntry object
DepositAccountHistoryEntry.DisbursalEntry object
DepositAccountHistoryEntry.PaymentEntry object
DepositAccountHistoryEntry.FreezeEntry object
DepositAccountHistoryEntry.UnfreezeEntry object
DepositAccountHistoryEntry.UnknownEntry object
Member Of
DepositAccountHistoryEntryConnection object ● DepositAccountHistoryEntryEdge object
DepositAccountingIntegrationConfigurePayload
No description
union DepositAccountingIntegrationConfigurePayload = DepositAccountingIntegrationConfigurePayloadSuccess | DepositAccountingIntegrationConfigurePayloadError
Possible types
DepositAccountingIntegrationConfigurePayload.DepositAccountingIntegrationConfigurePayloadSuccess object
DepositAccountingIntegrationConfigurePayload.DepositAccountingIntegrationConfigurePayloadError object
Returned By
depositAccountingIntegrationConfigure mutation
DepositAccountProductCreatePayload
No description
union DepositAccountProductCreatePayload = DepositAccountProductCreatePayloadSuccess | DepositAccountProductCreatePayloadError
Possible types
DepositAccountProductCreatePayload.DepositAccountProductCreatePayloadSuccess object
DepositAccountProductCreatePayload.DepositAccountProductCreatePayloadError object
Returned By
depositAccountProductCreate mutation
DepositAccountProductUpdateStatusPayload
No description
union DepositAccountProductUpdateStatusPayload = DepositAccountProductUpdateStatusPayloadSuccess | DepositAccountProductUpdateStatusPayloadError
Possible types
DepositAccountProductUpdateStatusPayload.DepositAccountProductUpdateStatusPayloadSuccess object
DepositAccountProductUpdateStatusPayload.DepositAccountProductUpdateStatusPayloadError object
Returned By
depositAccountProductUpdateStatus mutation
DepositAccountProductUpdateTermsPayload
No description
union DepositAccountProductUpdateTermsPayload = DepositAccountProductUpdateTermsPayloadSuccess | DepositAccountProductUpdateTermsPayloadError
Possible types
DepositAccountProductUpdateTermsPayload.DepositAccountProductUpdateTermsPayloadSuccess object
DepositAccountProductUpdateTermsPayload.DepositAccountProductUpdateTermsPayloadError object
Returned By
depositAccountProductUpdateTerms mutation
DepositAccountUnfreezePayload
No description
union DepositAccountUnfreezePayload = DepositAccountUnfreezePayloadSuccess | DepositAccountUnfreezePayloadError
Possible types
DepositAccountUnfreezePayload.DepositAccountUnfreezePayloadSuccess object
DepositAccountUnfreezePayload.DepositAccountUnfreezePayloadError object
Returned By
depositAccountUnfreeze mutation
DepositCurrencyPolicyConfigurePayload
No description
union DepositCurrencyPolicyConfigurePayload = DepositCurrencyPolicyConfigurePayloadSuccess | DepositCurrencyPolicyConfigurePayloadError
Possible types
DepositCurrencyPolicyConfigurePayload.DepositCurrencyPolicyConfigurePayloadSuccess object
DepositCurrencyPolicyConfigurePayload.DepositCurrencyPolicyConfigurePayloadError object
Returned By
depositCurrencyPolicyConfigure mutation
DepositRevertPayload
No description
union DepositRevertPayload = DepositRevertPayloadSuccess | DepositRevertPayloadError
Possible types
DepositRevertPayload.DepositRevertPayloadSuccess object
DepositRevertPayload.DepositRevertPayloadError object
Returned By
depositRevert mutation
DomainConfigUpdatePayload
No description
union DomainConfigUpdatePayload = DomainConfigUpdatePayloadSuccess | DomainConfigUpdatePayloadError
Possible types
DomainConfigUpdatePayload.DomainConfigUpdatePayloadSuccess object
DomainConfigUpdatePayload.DomainConfigUpdatePayloadError object
Returned By
domainConfigUpdate mutation
EodProcessRestartPayload
No description
union EodProcessRestartPayload = EodProcessRestartPayloadSuccess | EodProcessRestartPayloadError
Possible types
EodProcessRestartPayload.EodProcessRestartPayloadSuccess object
EodProcessRestartPayload.EodProcessRestartPayloadError object
Returned By
eodProcessRestart mutation
ExchangeAccountingIntegrationConfigurePayload
No description
union ExchangeAccountingIntegrationConfigurePayload = ExchangeAccountingIntegrationConfigurePayloadSuccess | ExchangeAccountingIntegrationConfigurePayloadError
Possible types
ExchangeAccountingIntegrationConfigurePayload.ExchangeAccountingIntegrationConfigurePayloadSuccess object
ExchangeAccountingIntegrationConfigurePayload.ExchangeAccountingIntegrationConfigurePayloadError object
Returned By
exchangeAccountingIntegrationConfigure mutation
ExchangeRateProviderActivatePayload
No description
union ExchangeRateProviderActivatePayload = ExchangeRateProviderActivatePayloadSuccess | ExchangeRateProviderActivatePayloadError
Possible types
ExchangeRateProviderActivatePayload.ExchangeRateProviderActivatePayloadSuccess object
ExchangeRateProviderActivatePayload.ExchangeRateProviderActivatePayloadError object
Returned By
exchangeRateProviderActivate mutation
ExchangeRateProviderDeactivatePayload
No description
union ExchangeRateProviderDeactivatePayload = ExchangeRateProviderDeactivatePayloadSuccess | ExchangeRateProviderDeactivatePayloadError
Possible types
ExchangeRateProviderDeactivatePayload.ExchangeRateProviderDeactivatePayloadSuccess object
ExchangeRateProviderDeactivatePayload.ExchangeRateProviderDeactivatePayloadError object
Returned By
exchangeRateProviderDeactivate mutation
ExchangeRateProviderManualExchangeRateUpdatePayload
No description
union ExchangeRateProviderManualExchangeRateUpdatePayload = ExchangeRateProviderManualExchangeRateUpdatePayloadSuccess | ExchangeRateProviderManualExchangeRateUpdatePayloadError
Possible types
ExchangeRateProviderManualExchangeRateUpdatePayload.ExchangeRateProviderManualExchangeRateUpdatePayloadSuccess object
ExchangeRateProviderManualExchangeRateUpdatePayload.ExchangeRateProviderManualExchangeRateUpdatePayloadError object
Returned By
exchangeRateProviderManualExchangeRateUpdate mutation
FiscalYearCloseMonthPayload
No description
union FiscalYearCloseMonthPayload = FiscalYearCloseMonthPayloadSuccess | FiscalYearCloseMonthPayloadError
Possible types
FiscalYearCloseMonthPayload.FiscalYearCloseMonthPayloadSuccess object
FiscalYearCloseMonthPayload.FiscalYearCloseMonthPayloadError object
Returned By
fiscalYearCloseMonth mutation
FiscalYearClosePayload
No description
union FiscalYearClosePayload = FiscalYearClosePayloadSuccess | FiscalYearClosePayloadError
Possible types
FiscalYearClosePayload.FiscalYearClosePayloadSuccess object
FiscalYearClosePayload.FiscalYearClosePayloadError object
Returned By
fiscalYearClose mutation
FiscalYearInitPayload
No description
union FiscalYearInitPayload = FiscalYearInitPayloadSuccess | FiscalYearInitPayloadError
Possible types
FiscalYearInitPayload.FiscalYearInitPayloadSuccess object
FiscalYearInitPayload.FiscalYearInitPayloadError object
Returned By
fiscalYearInit mutation
FxCurrencyPolicyConfigurePayload
No description
union FxCurrencyPolicyConfigurePayload = FxCurrencyPolicyConfigurePayloadSuccess | FxCurrencyPolicyConfigurePayloadError
Possible types
FxCurrencyPolicyConfigurePayload.FxCurrencyPolicyConfigurePayloadSuccess object
FxCurrencyPolicyConfigurePayload.FxCurrencyPolicyConfigurePayloadError object
Returned By
fxCurrencyPolicyConfigure mutation
FxModuleConfigurePayload
No description
union FxModuleConfigurePayload = FxModuleConfigurePayloadSuccess | FxModuleConfigurePayloadError
Possible types
FxModuleConfigurePayload.FxModuleConfigurePayloadSuccess object
FxModuleConfigurePayload.FxModuleConfigurePayloadError object
Returned By
fxModuleConfigure mutation
IndividualPartyCreatePayload
No description
union IndividualPartyCreatePayload = IndividualPartyCreatePayloadSuccess | IndividualPartyCreatePayloadError
Possible types
IndividualPartyCreatePayload.IndividualPartyCreatePayloadSuccess object
IndividualPartyCreatePayload.IndividualPartyCreatePayloadError object
Returned By
individualPartyCreate mutation
IndividualPartyEmailUpdatePayload
No description
union IndividualPartyEmailUpdatePayload = IndividualPartyEmailUpdatePayloadSuccess | IndividualPartyEmailUpdatePayloadError
Possible types
IndividualPartyEmailUpdatePayload.IndividualPartyEmailUpdatePayloadSuccess object
IndividualPartyEmailUpdatePayload.IndividualPartyEmailUpdatePayloadError object
Returned By
individualPartyEmailUpdate mutation
IndividualPartyPersonalInfoUpdatePayload
No description
union IndividualPartyPersonalInfoUpdatePayload = IndividualPartyPersonalInfoUpdatePayloadSuccess | IndividualPartyPersonalInfoUpdatePayloadError
Possible types
IndividualPartyPersonalInfoUpdatePayload.IndividualPartyPersonalInfoUpdatePayloadSuccess object
IndividualPartyPersonalInfoUpdatePayload.IndividualPartyPersonalInfoUpdatePayloadError object
Returned By
individualPartyPersonalInfoUpdate mutation
KycProviderConfigUpdatePayload
No description
union KycProviderConfigUpdatePayload = KycProviderConfigUpdatePayloadSuccess | KycProviderConfigUpdatePayloadError
Possible types
KycProviderConfigUpdatePayload.KycProviderConfigUpdatePayloadSuccess object
KycProviderConfigUpdatePayload.KycProviderConfigUpdatePayloadError object
Returned By
kycProviderConfigUpdate mutation
KycProviderCreatePayload
No description
union KycProviderCreatePayload = KycProviderCreatePayloadSuccess | KycProviderCreatePayloadError
Possible types
KycProviderCreatePayload.KycProviderCreatePayloadSuccess object
KycProviderCreatePayload.KycProviderCreatePayloadError object
Returned By
kycProviderCreate mutation
LedgerAccountCsvCreatePayload
No description
union LedgerAccountCsvCreatePayload = LedgerAccountCsvCreatePayloadSuccess | LedgerAccountCsvCreatePayloadError
Possible types
LedgerAccountCsvCreatePayload.LedgerAccountCsvCreatePayloadSuccess object
LedgerAccountCsvCreatePayload.LedgerAccountCsvCreatePayloadError object
Returned By
ledgerAccountCsvCreate mutation
LedgerAccountCsvDownloadLinkGeneratePayload
No description
union LedgerAccountCsvDownloadLinkGeneratePayload = LedgerAccountCsvDownloadLinkGeneratePayloadSuccess | LedgerAccountCsvDownloadLinkGeneratePayloadError
Possible types
LedgerAccountCsvDownloadLinkGeneratePayload.LedgerAccountCsvDownloadLinkGeneratePayloadSuccess object
LedgerAccountCsvDownloadLinkGeneratePayload.LedgerAccountCsvDownloadLinkGeneratePayloadError object
Returned By
ledgerAccountCsvDownloadLinkGenerate mutation
LedgerAccountEntity
No description
union LedgerAccountEntity = DepositAccount | CreditFacility | Collateral
Possible types
LedgerAccountEntity.DepositAccount object
LedgerAccountEntity.CreditFacility object
LedgerAccountEntity.Collateral object
Member Of
LedgerAccount object
LedgerTransactionEntity
No description
union LedgerTransactionEntity = Deposit | Withdrawal | CreditFacilityDisbursal
Possible types
LedgerTransactionEntity.Deposit object
LedgerTransactionEntity.Withdrawal object
LedgerTransactionEntity.CreditFacilityDisbursal object
Member Of
LedgerTransaction object
LtvPct
No description
union LtvPct = FiniteLtvPct | InfiniteLtvPct
Possible types
LtvPct.FiniteLtvPct object
LtvPct.InfiniteLtvPct object
Member Of
CreditFacility object ● CreditFacilityTermsAlteration object ● LiquidationPayment object ● TermValues object
ManualTransactionDraftClosePayload
No description
union ManualTransactionDraftClosePayload = ManualTransactionDraftClosePayloadSuccess | ManualTransactionDraftClosePayloadError
Possible types
ManualTransactionDraftClosePayload.ManualTransactionDraftClosePayloadSuccess object
ManualTransactionDraftClosePayload.ManualTransactionDraftClosePayloadError object
Returned By
manualTransactionDraftClose mutation
ManualTransactionDraftCreatePayload
No description
union ManualTransactionDraftCreatePayload = ManualTransactionDraftCreatePayloadSuccess | ManualTransactionDraftCreatePayloadError
Possible types
ManualTransactionDraftCreatePayload.ManualTransactionDraftCreatePayloadSuccess object
ManualTransactionDraftCreatePayload.ManualTransactionDraftCreatePayloadError object
Returned By
manualTransactionDraftCreate mutation
ManualTransactionDraftPostPayload
No description
union ManualTransactionDraftPostPayload = ManualTransactionDraftPostPayloadSuccess | ManualTransactionDraftPostPayloadError
Possible types
ManualTransactionDraftPostPayload.ManualTransactionDraftPostPayloadSuccess object
ManualTransactionDraftPostPayload.ManualTransactionDraftPostPayloadError object
Returned By
manualTransactionDraftPost mutation
ManualTransactionDraftUpdatePayload
No description
union ManualTransactionDraftUpdatePayload = ManualTransactionDraftUpdatePayloadSuccess | ManualTransactionDraftUpdatePayloadError
Possible types
ManualTransactionDraftUpdatePayload.ManualTransactionDraftUpdatePayloadSuccess object
ManualTransactionDraftUpdatePayload.ManualTransactionDraftUpdatePayloadError object
Returned By
manualTransactionDraftUpdate mutation
ManualTransactionPostPayload
No description
union ManualTransactionPostPayload = ManualTransactionPostPayloadSuccess | ManualTransactionPostPayloadError
Possible types
ManualTransactionPostPayload.ManualTransactionPostPayloadSuccess object
ManualTransactionPostPayload.ManualTransactionPostPayloadError object
Returned By
manualTransactionPost mutation
ManualTransactionValidatePayload
No description
union ManualTransactionValidatePayload = ManualTransactionValidatePayloadSuccess | ManualTransactionValidatePayloadError
Possible types
ManualTransactionValidatePayload.ManualTransactionValidatePayloadSuccess object
ManualTransactionValidatePayload.ManualTransactionValidatePayloadError object
Returned By
manualTransactionValidate query
MaxWithdrawalAmountPerTransaction
No description
union MaxWithdrawalAmountPerTransaction = LimitedMaxWithdrawalAmountPerTransaction | UnlimitedMaxWithdrawalAmountPerTransaction
Possible types
MaxWithdrawalAmountPerTransaction.LimitedMaxWithdrawalAmountPerTransaction object
MaxWithdrawalAmountPerTransaction.UnlimitedMaxWithdrawalAmountPerTransaction object
Member Of
DepositAccountProductTerms object
NotificationProviderConfigUpdatePayload
No description
union NotificationProviderConfigUpdatePayload = NotificationProviderConfigUpdatePayloadSuccess | NotificationProviderConfigUpdatePayloadError
Possible types
NotificationProviderConfigUpdatePayload.NotificationProviderConfigUpdatePayloadSuccess object
NotificationProviderConfigUpdatePayload.NotificationProviderConfigUpdatePayloadError object
Returned By
notificationProviderConfigUpdate mutation
NotificationProviderCreatePayload
No description
union NotificationProviderCreatePayload = NotificationProviderCreatePayloadSuccess | NotificationProviderCreatePayloadError
Possible types
NotificationProviderCreatePayload.NotificationProviderCreatePayloadSuccess object
NotificationProviderCreatePayload.NotificationProviderCreatePayloadError object
Returned By
notificationProviderCreate mutation
OrganizationPartyDetailsUpdatePayload
No description
union OrganizationPartyDetailsUpdatePayload = OrganizationPartyDetailsUpdatePayloadSuccess | OrganizationPartyDetailsUpdatePayloadError
Possible types
OrganizationPartyDetailsUpdatePayload.OrganizationPartyDetailsUpdatePayloadSuccess object
OrganizationPartyDetailsUpdatePayload.OrganizationPartyDetailsUpdatePayloadError object
Returned By
organizationPartyDetailsUpdate mutation
OrganizationPartyEmailUpdatePayload
No description
union OrganizationPartyEmailUpdatePayload = OrganizationPartyEmailUpdatePayloadSuccess | OrganizationPartyEmailUpdatePayloadError
Possible types
OrganizationPartyEmailUpdatePayload.OrganizationPartyEmailUpdatePayloadSuccess object
OrganizationPartyEmailUpdatePayload.OrganizationPartyEmailUpdatePayloadError object
Returned By
organizationPartyEmailUpdate mutation
OrganizationPartyMemberAddPayload
No description
union OrganizationPartyMemberAddPayload = OrganizationPartyMemberAddPayloadSuccess | OrganizationPartyMemberAddPayloadError
Possible types
OrganizationPartyMemberAddPayload.OrganizationPartyMemberAddPayloadSuccess object
OrganizationPartyMemberAddPayload.OrganizationPartyMemberAddPayloadError object
Returned By
organizationPartyMemberAdd mutation
OrganizationPartyMemberRemovePayload
No description
union OrganizationPartyMemberRemovePayload = OrganizationPartyMemberRemovePayloadSuccess | OrganizationPartyMemberRemovePayloadError
Possible types
OrganizationPartyMemberRemovePayload.OrganizationPartyMemberRemovePayloadSuccess object
OrganizationPartyMemberRemovePayload.OrganizationPartyMemberRemovePayloadError object
Returned By
organizationPartyMemberRemove mutation
OrganizationPartyMemberRoleAddPayload
No description
union OrganizationPartyMemberRoleAddPayload = OrganizationPartyMemberRoleAddPayloadSuccess | OrganizationPartyMemberRoleAddPayloadError
Possible types
OrganizationPartyMemberRoleAddPayload.OrganizationPartyMemberRoleAddPayloadSuccess object
OrganizationPartyMemberRoleAddPayload.OrganizationPartyMemberRoleAddPayloadError object
Returned By
organizationPartyMemberRoleAdd mutation
OrganizationPartyMemberRoleRemovePayload
No description
union OrganizationPartyMemberRoleRemovePayload = OrganizationPartyMemberRoleRemovePayloadSuccess | OrganizationPartyMemberRoleRemovePayloadError
Possible types
OrganizationPartyMemberRoleRemovePayload.OrganizationPartyMemberRoleRemovePayloadSuccess object
OrganizationPartyMemberRoleRemovePayload.OrganizationPartyMemberRoleRemovePayloadError object
Returned By
organizationPartyMemberRoleRemove mutation
PartnerActivatePayload
No description
union PartnerActivatePayload = PartnerActivatePayloadSuccess | PartnerActivatePayloadError
Possible types
PartnerActivatePayload.PartnerActivatePayloadSuccess object
PartnerActivatePayload.PartnerActivatePayloadError object
Returned By
partnerActivate mutation
PartnerCreatePayload
No description
union PartnerCreatePayload = PartnerCreatePayloadSuccess | PartnerCreatePayloadError
Possible types
PartnerCreatePayload.PartnerCreatePayloadSuccess object
PartnerCreatePayload.PartnerCreatePayloadError object
Returned By
partnerCreate mutation
PartnerDeactivatePayload
No description
union PartnerDeactivatePayload = PartnerDeactivatePayloadSuccess | PartnerDeactivatePayloadError
Possible types
PartnerDeactivatePayload.PartnerDeactivatePayloadSuccess object
PartnerDeactivatePayload.PartnerDeactivatePayloadError object
Returned By
partnerDeactivate mutation
PartnerUpdatePayload
No description
union PartnerUpdatePayload = PartnerUpdatePayloadSuccess | PartnerUpdatePayloadError
Possible types
PartnerUpdatePayload.PartnerUpdatePayloadSuccess object
PartnerUpdatePayload.PartnerUpdatePayloadError object
Returned By
partnerUpdate mutation
Party
No description
union Party = IndividualParty | OrganizationParty
Possible types
Party.IndividualParty object
Party.OrganizationParty object
Member Of
Customer object ● Prospect object ● Verification object
PaymentProviderConfigUpdatePayload
No description
union PaymentProviderConfigUpdatePayload = PaymentProviderConfigUpdatePayloadSuccess | PaymentProviderConfigUpdatePayloadError
Possible types
PaymentProviderConfigUpdatePayload.PaymentProviderConfigUpdatePayloadSuccess object
PaymentProviderConfigUpdatePayload.PaymentProviderConfigUpdatePayloadError object
Returned By
paymentProviderConfigUpdate mutation
PaymentProviderCreatePayload
No description
union PaymentProviderCreatePayload = PaymentProviderCreatePayloadSuccess | PaymentProviderCreatePayloadError
Possible types
PaymentProviderCreatePayload.PaymentProviderCreatePayloadSuccess object
PaymentProviderCreatePayload.PaymentProviderCreatePayloadError object
Returned By
paymentProviderCreate mutation
PayoutCancelPayload
No description
union PayoutCancelPayload = PayoutCancelPayloadSuccess | PayoutCancelPayloadError
Possible types
PayoutCancelPayload.PayoutCancelPayloadSuccess object
PayoutCancelPayload.PayoutCancelPayloadError object
Returned By
payoutCancel mutation
PayoutFailPayload
No description
union PayoutFailPayload = PayoutFailPayloadSuccess | PayoutFailPayloadError
Possible types
PayoutFailPayload.PayoutFailPayloadSuccess object
PayoutFailPayload.PayoutFailPayloadError object
Returned By
payoutFail mutation
PayoutRevertPayload
No description
union PayoutRevertPayload = PayoutRevertPayloadSuccess | PayoutRevertPayloadError
Possible types
PayoutRevertPayload.PayoutRevertPayloadSuccess object
PayoutRevertPayload.PayoutRevertPayloadError object
Returned By
payoutRevert mutation
PayoutSettlePayload
No description
union PayoutSettlePayload = PayoutSettlePayloadSuccess | PayoutSettlePayloadError
Possible types
PayoutSettlePayload.PayoutSettlePayloadSuccess object
PayoutSettlePayload.PayoutSettlePayloadError object
Returned By
payoutSettle mutation
PiiErasureProcessCancelPayload
No description
union PiiErasureProcessCancelPayload = PiiErasureProcessCancelPayloadSuccess | PiiErasureProcessCancelPayloadError
Possible types
PiiErasureProcessCancelPayload.PiiErasureProcessCancelPayloadSuccess object
PiiErasureProcessCancelPayload.PiiErasureProcessCancelPayloadError object
Returned By
piiErasureProcessCancel mutation
PiiErasureProcessSchedulePayload
No description
union PiiErasureProcessSchedulePayload = PiiErasureProcessSchedulePayloadSuccess | PiiErasureProcessSchedulePayloadError
Possible types
PiiErasureProcessSchedulePayload.PiiErasureProcessSchedulePayloadSuccess object
PiiErasureProcessSchedulePayload.PiiErasureProcessSchedulePayloadError object
Returned By
piiErasureProcessSchedule mutation
PiiErasureSubject
No description
union PiiErasureSubject = Customer | Prospect
Possible types
PiiErasureSubject.Customer object
PiiErasureSubject.Prospect object
Member Of
PiiErasureProcess object
PipelineRunRequestPayload
No description
union PipelineRunRequestPayload = PipelineRunRequestPayloadSuccess | PipelineRunRequestPayloadError
Possible types
PipelineRunRequestPayload.PipelineRunRequestPayloadSuccess object
PipelineRunRequestPayload.PipelineRunRequestPayloadError object
Returned By
pipelineRunRequest mutation
PolicyCommitteeAssignPayload
No description
union PolicyCommitteeAssignPayload = PolicyCommitteeAssignPayloadSuccess | PolicyCommitteeAssignPayloadError
Possible types
PolicyCommitteeAssignPayload.PolicyCommitteeAssignPayloadSuccess object
PolicyCommitteeAssignPayload.PolicyCommitteeAssignPayloadError object
Returned By
policyCommitteeAssign mutation
ProspectClosePayload
No description
union ProspectClosePayload = ProspectClosePayloadSuccess | ProspectClosePayloadError
Possible types
ProspectClosePayload.ProspectClosePayloadSuccess object
ProspectClosePayload.ProspectClosePayloadError object
Returned By
prospectClose mutation
ProspectCreatePayload
No description
union ProspectCreatePayload = ProspectCreatePayloadSuccess | ProspectCreatePayloadError
Possible types
ProspectCreatePayload.ProspectCreatePayloadSuccess object
ProspectCreatePayload.ProspectCreatePayloadError object
Returned By
prospectCreateIndividual mutation ● prospectCreateOrganization mutation
PublicIdTarget
No description
union PublicIdTarget = Customer | Prospect | DepositAccount | Deposit | Withdrawal | CreditFacility | CreditFacilityDisbursal
Possible types
PublicIdTarget.Customer object
PublicIdTarget.Prospect object
PublicIdTarget.DepositAccount object
PublicIdTarget.Deposit object
PublicIdTarget.Withdrawal object
PublicIdTarget.CreditFacility object
PublicIdTarget.CreditFacilityDisbursal object
Returned By
publicIdTarget query
QueryTemplateCreatePayload
No description
union QueryTemplateCreatePayload = QueryTemplateCreatePayloadSuccess | QueryTemplateCreatePayloadError
Possible types
QueryTemplateCreatePayload.QueryTemplateCreatePayloadSuccess object
QueryTemplateCreatePayload.QueryTemplateCreatePayloadError object
Returned By
queryTemplateCreate mutation
QueryTemplateDeletePayload
No description
union QueryTemplateDeletePayload = QueryTemplateDeletePayloadSuccess | QueryTemplateDeletePayloadError
Possible types
QueryTemplateDeletePayload.QueryTemplateDeletePayloadSuccess object
QueryTemplateDeletePayload.QueryTemplateDeletePayloadError object
Returned By
queryTemplateDelete mutation
QueryTemplateUpdatePayload
No description
union QueryTemplateUpdatePayload = QueryTemplateUpdatePayloadSuccess | QueryTemplateUpdatePayloadError
Possible types
QueryTemplateUpdatePayload.QueryTemplateUpdatePayloadSuccess object
QueryTemplateUpdatePayload.QueryTemplateUpdatePayloadError object
Returned By
queryTemplateUpdate mutation
RailCreatePayload
No description
union RailCreatePayload = RailCreatePayloadSuccess | RailCreatePayloadError
Possible types
RailCreatePayload.RailCreatePayloadSuccess object
RailCreatePayload.RailCreatePayloadError object
Returned By
railCreate mutation
ReceiptCancelPayload
No description
union ReceiptCancelPayload = ReceiptCancelPayloadSuccess | ReceiptCancelPayloadError
Possible types
ReceiptCancelPayload.ReceiptCancelPayloadSuccess object
ReceiptCancelPayload.ReceiptCancelPayloadError object
Returned By
receiptCancel mutation
ReceiptDestination
No description
union ReceiptDestination = DepositAccount
Possible types
ReceiptDestination.DepositAccount object
Member Of
Receipt object
ReceiptFailPayload
No description
union ReceiptFailPayload = ReceiptFailPayloadSuccess | ReceiptFailPayloadError
Possible types
ReceiptFailPayload.ReceiptFailPayloadSuccess object
ReceiptFailPayload.ReceiptFailPayloadError object
Returned By
receiptFail mutation
ReceiptSettlePayload
No description
union ReceiptSettlePayload = ReceiptSettlePayloadSuccess | ReceiptSettlePayloadError
Possible types
ReceiptSettlePayload.ReceiptSettlePayloadSuccess object
ReceiptSettlePayload.ReceiptSettlePayloadError object
Returned By
receiptSettle mutation
ReceiptSubmitPayload
No description
union ReceiptSubmitPayload = ReceiptSubmitPayloadSuccess | ReceiptSubmitPayloadError
Possible types
ReceiptSubmitPayload.ReceiptSubmitPayloadSuccess object
ReceiptSubmitPayload.ReceiptSubmitPayloadError object
Returned By
receiptSubmit mutation
RoleCreatePayload
No description
union RoleCreatePayload = RoleCreatePayloadSuccess | RoleCreatePayloadError
Possible types
RoleCreatePayload.RoleCreatePayloadSuccess object
RoleCreatePayload.RoleCreatePayloadError object
Returned By
roleCreate mutation
RolePermissionSetsAddPayload
No description
union RolePermissionSetsAddPayload = RolePermissionSetsAddPayloadSuccess | RolePermissionSetsAddPayloadError
Possible types
RolePermissionSetsAddPayload.RolePermissionSetsAddPayloadSuccess object
RolePermissionSetsAddPayload.RolePermissionSetsAddPayloadError object
Returned By
rolePermissionSetsAdd mutation
RolePermissionSetsRemovePayload
No description
union RolePermissionSetsRemovePayload = RolePermissionSetsRemovePayloadSuccess | RolePermissionSetsRemovePayloadError
Possible types
RolePermissionSetsRemovePayload.RolePermissionSetsRemovePayloadSuccess object
RolePermissionSetsRemovePayload.RolePermissionSetsRemovePayloadError object
Returned By
rolePermissionSetsRemove mutation
TimeAdvanceToNextEndOfDayPayload
No description
union TimeAdvanceToNextEndOfDayPayload = TimeAdvanceToNextEndOfDayPayloadSuccess | TimeAdvanceToNextEndOfDayPayloadError
Possible types
TimeAdvanceToNextEndOfDayPayload.TimeAdvanceToNextEndOfDayPayloadSuccess object
TimeAdvanceToNextEndOfDayPayload.TimeAdvanceToNextEndOfDayPayloadError object
Returned By
timeAdvanceToNextEndOfDay mutation
TimeAdvanceToNextHourPayload
No description
union TimeAdvanceToNextHourPayload = TimeAdvanceToNextHourPayloadSuccess | TimeAdvanceToNextHourPayloadError
Possible types
TimeAdvanceToNextHourPayload.TimeAdvanceToNextHourPayloadSuccess object
TimeAdvanceToNextHourPayload.TimeAdvanceToNextHourPayloadError object
Returned By
timeAdvanceToNextHour mutation
TimeAutoAdvancePausePayload
No description
union TimeAutoAdvancePausePayload = TimeAutoAdvancePausePayloadSuccess | TimeAutoAdvancePausePayloadError
Possible types
TimeAutoAdvancePausePayload.TimeAutoAdvancePausePayloadSuccess object
TimeAutoAdvancePausePayload.TimeAutoAdvancePausePayloadError object
Returned By
timeAutoAdvancePause mutation
TimeAutoAdvanceResumePayload
No description
union TimeAutoAdvanceResumePayload = TimeAutoAdvanceResumePayloadSuccess | TimeAutoAdvanceResumePayloadError
Possible types
TimeAutoAdvanceResumePayload.TimeAutoAdvanceResumePayloadSuccess object
TimeAutoAdvanceResumePayload.TimeAutoAdvanceResumePayloadError object
Returned By
timeAutoAdvanceResume mutation
UserCreatePayload
No description
union UserCreatePayload = UserCreatePayloadSuccess | UserCreatePayloadError
Possible types
UserCreatePayload.UserCreatePayloadSuccess object
UserCreatePayload.UserCreatePayloadError object
Returned By
userCreate mutation
UserRoleUpdatePayload
No description
union UserRoleUpdatePayload = UserRoleUpdatePayloadSuccess | UserRoleUpdatePayloadError
Possible types
UserRoleUpdatePayload.UserRoleUpdatePayloadSuccess object
UserRoleUpdatePayload.UserRoleUpdatePayloadError object
Returned By
userRoleUpdate mutation
VerificationApproveManuallyPayload
No description
union VerificationApproveManuallyPayload = VerificationApproveManuallyPayloadSuccess | VerificationApproveManuallyPayloadError
Possible types
VerificationApproveManuallyPayload.VerificationApproveManuallyPayloadSuccess object
VerificationApproveManuallyPayload.VerificationApproveManuallyPayloadError object
Returned By
individualPartyVerificationApproveManually mutation ● organizationPartyVerificationApproveManually mutation
VerificationLinkCreatePayload
No description
union VerificationLinkCreatePayload = VerificationLinkCreatePayloadSuccess | VerificationLinkCreatePayloadError
Possible types
VerificationLinkCreatePayload.VerificationLinkCreatePayloadSuccess object
VerificationLinkCreatePayload.VerificationLinkCreatePayloadError object
Returned By
individualPartyVerificationLinkCreate mutation ● organizationPartyVerificationLinkCreate mutation
WithdrawalInitiatePayload
No description
union WithdrawalInitiatePayload = WithdrawalInitiatePayloadSuccess | WithdrawalInitiatePayloadError
Possible types
WithdrawalInitiatePayload.WithdrawalInitiatePayloadSuccess object
WithdrawalInitiatePayload.WithdrawalInitiatePayloadError object
Returned By
withdrawalInitiate mutation
Directives (Types)
deprecated
Marks an element of a GraphQL schema as no longer supported.
directive @deprecated(
reason: String = "No longer supported"
) on
| FIELD_DEFINITION
| ARGUMENT_DEFINITION
| INPUT_FIELD_DEFINITION
| ENUM_VALUE
| DIRECTIVE_DEFINITION
Arguments
deprecated.reason ● String scalar
Explains why this element was deprecated, usually also including a suggestion for how to access supported similar data. Formatted using the Markdown syntax, as specified by CommonMark.
entity
No description
directive @entity on OBJECT
oneOf
Indicates that an Input Object is a OneOf Input Object (and thus requires exactly one of its field be provided)
directive @oneOf on INPUT_OBJECT
specifiedBy
Provides a scalar specification URL for specifying the behavior of custom scalar types.
directive @specifiedBy(
url: String!
) on SCALAR
Arguments
specifiedBy.url ● String! non-null scalar
workflow_output
No description
directive @workflow_output(
path: String!
) on FIELD_DEFINITION
Arguments
workflow_output.path ● String! non-null scalar
workflow_require
No description
directive @workflow_require(
token: String!
) on FIELD_DEFINITION