Admin API Reference
This API reference has been automatically generated from the Admin GraphQL schema.
Queries
appConfig
Returns the YAML-serialized runtime configuration for the environment
appConfig: Yaml!
Type
Yaml scalar
approvalProcess
Fetches a specific approval process by its unique identifier
approvalProcess(
id: ApprovalProcessId!
): ApprovalProcess
Arguments
approvalProcess.id ● ApprovalProcessId! non-null scalar
Type
ApprovalProcess object
approvalProcesses
Returns a paginated list of all approval processes
approvalProcesses(
after: String
first: Int!
): ApprovalProcessConnection!
Arguments
approvalProcesses.after ● String scalar
approvalProcesses.first ● Int! non-null scalar
Type
ApprovalProcessConnection object
audit
Returns a paginated list of audit log entries
audit(
action: String
after: String
authorized: Boolean
first: Int!
object: String
subject: AuditSubjectId
): 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.subject ● AuditSubjectId scalar
Type
AuditEntryConnection object
auditSubjects
Returns a list of distinct audit log subjects
auditSubjects: [AuditSubjectId!]!
Type
AuditSubjectId scalar
availableReportDefinitions
Returns the report definitions that can be generated manually, including output formats and whether an as-of date is required
availableReportDefinitions: [ReportDefinition!]!
Type
ReportDefinition object
balanceSheet
Generates a point-in-time balance sheet snapshot for a specified as-of date
balanceSheet(
asOf: Date!
): BalanceSheet!
Arguments
balanceSheet.asOf ● Date! non-null scalar
Type
BalanceSheet object
buildInfo
Returns build version, profile, and target information for the running server
buildInfo: BuildInfo!
Type
BuildInfo object
chartOfAccounts
Returns the chart of accounts structure
chartOfAccounts: ChartOfAccounts!
Type
ChartOfAccounts object
committee
Fetches a specific committee by its unique identifier
committee(
id: CommitteeId!
): Committee
Arguments
committee.id ● CommitteeId! non-null scalar
Type
Committee object
committees
Returns a paginated list of all committees
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
creditFacilities
Returns a paginated, sortable, and filterable list of credit facilities
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
Fetches a specific credit facility by its unique identifier
creditFacility(
id: CreditFacilityId!
): CreditFacility
Arguments
creditFacility.id ● CreditFacilityId! non-null scalar
Type
CreditFacility object
creditFacilityAgreement
Fetches a specific credit facility agreement by its unique identifier
creditFacilityAgreement(
id: CreditFacilityAgreementId!
): CreditFacilityAgreement
Arguments
creditFacilityAgreement.id ● CreditFacilityAgreementId! non-null scalar
Type
CreditFacilityAgreement object
creditFacilityByPublicId
Fetches a credit facility by its public-facing identifier
creditFacilityByPublicId(
id: PublicId!
): CreditFacility
Arguments
creditFacilityByPublicId.id ● PublicId! non-null scalar
Type
CreditFacility object
creditFacilityConfig
Returns the current credit module configuration
creditFacilityConfig: CreditFacilityModuleConfig
Type
CreditFacilityModuleConfig object
creditFacilityProposal
Fetches a specific credit facility proposal by its unique identifier
creditFacilityProposal(
id: CreditFacilityProposalId!
): CreditFacilityProposal
Arguments
creditFacilityProposal.id ● CreditFacilityProposalId! non-null scalar
Type
CreditFacilityProposal object
creditFacilityProposals
Returns a paginated, sortable, and filterable list of all credit facility proposals
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
Fetches a specific custodian by its unique identifier
custodian(
id: CustodianId!
): Custodian
Arguments
custodian.id ● CustodianId! non-null scalar
Type
Custodian object
custodians
Returns a paginated list of all configured custodians
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
Fetches a specific customer by their unique identifier
customer(
id: CustomerId!
): Customer
Arguments
customer.id ● CustomerId! non-null scalar
Type
Customer object
customerByEmail
Fetches a customer by their email address
customerByEmail(
email: String!
): Customer
Arguments
customerByEmail.email ● String! non-null scalar
Type
Customer object
customerByPublicId
Fetches a customer by their public-facing identifier
customerByPublicId(
id: PublicId!
): Customer
Arguments
customerByPublicId.id ● PublicId! non-null scalar
Type
Customer object
customerDocument
Fetches a specific customer document by its unique identifier
customerDocument(
id: CustomerDocumentId!
): CustomerDocument
Arguments
customerDocument.id ● CustomerDocumentId! non-null scalar
Type
CustomerDocument object
customers
Returns a paginated, sortable, and filterable list of customers
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
Retrieves dashboard statistics including active facilities, pending facilities, total disbursed amount, and total collateral
dashboard: Dashboard!
Type
Dashboard object
deposit
Fetches a specific deposit by its unique identifier
deposit(
id: DepositId!
): Deposit
Arguments
deposit.id ● DepositId! non-null scalar
Type
Deposit object
depositAccount
Fetches a specific deposit account by its unique identifier
depositAccount(
id: DepositAccountId!
): DepositAccount
Arguments
depositAccount.id ● DepositAccountId! non-null scalar
Type
DepositAccount object
depositAccountByPublicId
Fetches a deposit account by its public-facing identifier
depositAccountByPublicId(
id: PublicId!
): DepositAccount
Arguments
depositAccountByPublicId.id ● PublicId! non-null scalar
Type
DepositAccount object
depositAccountConfig
Returns the current deposit module configuration
depositAccountConfig: DepositAccountModuleConfig
Type
DepositAccountModuleConfig object
depositAccounts
Returns a paginated and filterable list of all deposit accounts
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
Fetches a deposit by its public-facing identifier
depositByPublicId(
id: PublicId!
): Deposit
Arguments
depositByPublicId.id ● PublicId! non-null scalar
Type
Deposit object
deposits
Returns a paginated and filterable list of all deposits
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
Returns descendant account sets (non-leaf accounts) under a specified accounting category (asset, liability, equity, revenue, cost of revenue, expenses, or off-balance-sheet)
descendantAccountSetsByCategory(
category: AccountCategory!
): [ChartNode!]!
Arguments
descendantAccountSetsByCategory.category ● AccountCategory! non-null enum
Type
ChartNode object
disbursal
Fetches a specific disbursal by its unique identifier
disbursal(
id: CreditFacilityDisbursalId!
): CreditFacilityDisbursal
Arguments
disbursal.id ● CreditFacilityDisbursalId! non-null scalar
Type
CreditFacilityDisbursal object
disbursalByPublicId
Fetches a disbursal by its public-facing identifier
disbursalByPublicId(
id: PublicId!
): CreditFacilityDisbursal
Arguments
disbursalByPublicId.id ● PublicId! non-null scalar
Type
CreditFacilityDisbursal object
disbursals
Returns a paginated and filterable list of all disbursals
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
Fetches a specific domain configuration setting by its unique identifier
domainConfig(
id: DomainConfigId!
): DomainConfig
Arguments
domainConfig.id ● DomainConfigId! non-null scalar
Type
DomainConfig object
domainConfigs
Returns a paginated list of all domain configuration settings
domainConfigs(
after: String
first: Int!
): DomainConfigConnection!
Arguments
domainConfigs.after ● String scalar
domainConfigs.first ● Int! non-null scalar
Type
DomainConfigConnection object
eodProcess
Fetches a specific end-of-day process by its unique identifier, including phase-level status details
eodProcess(
id: EodProcessId!
): EodProcess
Arguments
eodProcess.id ● EodProcessId! non-null scalar
Type
EodProcess object
eodProcesses
Returns a paginated, sortable, and filterable list of end-of-day processes with optional single-day and status filtering
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
fiscalYear
Fetches a specific fiscal year by its unique identifier
fiscalYear(
id: FiscalYearId!
): FiscalYear
Arguments
fiscalYear.id ● FiscalYearId! non-null scalar
Type
FiscalYear object
fiscalYearByYear
Fetches a fiscal year by its year string (e.g., '2024')
fiscalYearByYear(
year: String!
): FiscalYear
Arguments
fiscalYearByYear.year ● String! non-null scalar
Type
FiscalYear object
fiscalYears
Returns a paginated list of all fiscal years
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
ledgerAccount
Fetches a specific ledger account by its unique identifier
ledgerAccount(
id: LedgerAccountId!
): LedgerAccount
Arguments
ledgerAccount.id ● LedgerAccountId! non-null scalar
Type
LedgerAccount object
ledgerAccountByCode
Fetches a ledger account by its account code
ledgerAccountByCode(
code: AccountCode!
): LedgerAccount
Arguments
ledgerAccountByCode.code ● AccountCode! non-null scalar
Type
LedgerAccount object
ledgerAccountCsv
Fetches the CSV export document for a specific ledger account
ledgerAccountCsv(
ledgerAccountId: LedgerAccountId!
): LedgerAccountCsvDocument
Arguments
ledgerAccountCsv.ledgerAccountId ● LedgerAccountId! non-null scalar
Type
LedgerAccountCsvDocument object
ledgerEntries
Returns a paginated list of all ledger entries
ledgerEntries(
after: String
first: Int!
): LedgerEntryConnection!
Arguments
ledgerEntries.after ● String scalar
ledgerEntries.first ● Int! non-null scalar
Type
LedgerEntryConnection object
ledgerTransaction
Fetches a specific ledger transaction by its unique identifier
ledgerTransaction(
id: LedgerTransactionId!
): LedgerTransaction
Arguments
ledgerTransaction.id ● LedgerTransactionId! non-null scalar
Type
LedgerTransaction object
ledgerTransactionsForTemplateCode
Returns a paginated list of ledger transactions for a specific template code
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
Fetches a specific liquidation by its unique identifier
liquidation(
id: LiquidationId!
): Liquidation
Arguments
liquidation.id ● LiquidationId! non-null scalar
Type
Liquidation object
liquidationPaymentCalculate
Calculates the amounts of liquidation payment
liquidationPaymentCalculate(
input: LiquidationPaymentCalculateInput!
): LiquidationPayment!
Arguments
liquidationPaymentCalculate.input ● LiquidationPaymentCalculateInput! non-null input
Type
LiquidationPayment object
liquidations
Returns a paginated list of all liquidations
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
me
Returns the current authenticated user's information and visible navigation items
me: Me!
Type
Me object
pendingCreditFacilities
Returns a paginated, sortable, and filterable list of all pending credit facilities awaiting collateralization
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
Fetches a specific permission set by its unique identifier
permissionSet(
id: PermissionSetId!
): PermissionSet
Arguments
permissionSet.id ● PermissionSetId! non-null scalar
Type
PermissionSet object
permissionSets
Returns a paginated list of all available permission sets
permissionSets(
after: String
first: Int!
): PermissionSetConnection!
Arguments
permissionSets.after ● String scalar
permissionSets.first ● Int! non-null scalar
Type
PermissionSetConnection object
policies
Returns a paginated list of all approval policies
policies(
after: String
first: Int!
): PolicyConnection!
Arguments
policies.after ● String scalar
policies.first ● Int! non-null scalar
Type
PolicyConnection object
policy
Fetches a specific approval policy by its unique identifier
policy(
id: PolicyId!
): Policy
Arguments
policy.id ● PolicyId! non-null scalar
Type
Policy object
priceProvider
Fetches a specific price provider by its unique identifier
priceProvider(
id: PriceProviderId!
): PriceProvider
Arguments
priceProvider.id ● PriceProviderId! non-null scalar
Type
PriceProvider object
priceProviders
Returns a paginated list of all configured price providers
priceProviders(
after: String
first: Int!
sort: PriceProviderSort = { by: CREATED_AT, direction: DESC }
): PriceProviderConnection!
Arguments
priceProviders.after ● String scalar
priceProviders.first ● Int! non-null scalar
priceProviders.sort ● PriceProviderSort input
Type
PriceProviderConnection object
profitAndLossStatement
Generates a profit and loss statement for the specified date range
profitAndLossStatement(
from: Date!
until: Date!
): ProfitAndLossStatement!
Arguments
profitAndLossStatement.from ● Date! non-null scalar
profitAndLossStatement.until ● Date! non-null scalar
Type
ProfitAndLossStatement object
prospect
Fetches a specific prospect by their unique identifier
prospect(
id: ProspectId!
): Prospect
Arguments
prospect.id ● ProspectId! non-null scalar
Type
Prospect object
prospectByPublicId
Fetches a prospect by their public-facing identifier
prospectByPublicId(
id: PublicId!
): Prospect
Arguments
prospectByPublicId.id ● PublicId! non-null scalar
Type
Prospect object
prospects
Returns a paginated and filterable list of all prospects
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
Resolves a public ID to its target entity (customer, deposit, withdrawal, etc.)
publicIdTarget(
id: PublicId!
): PublicIdTarget
Arguments
publicIdTarget.id ● PublicId! non-null scalar
Type
PublicIdTarget union
realtimePrice
Returns the current BTC/USD exchange rate
realtimePrice: RealtimePrice!
Type
RealtimePrice object
reportRun
Fetches a specific report run by its unique identifier
reportRun(
id: ReportRunId!
): ReportRun
Arguments
reportRun.id ● ReportRunId! non-null scalar
Type
ReportRun object
reportRuns
Returns a paginated list of all report runs
reportRuns(
after: String
first: Int!
sort: ReportRunSort = { by: START_TIME, direction: DESC }
): ReportRunConnection!
Arguments
reportRuns.after ● String scalar
reportRuns.first ● Int! non-null scalar
reportRuns.sort ● ReportRunSort input
Type
ReportRunConnection object
role
Fetches a specific role by its unique identifier
role(
id: RoleId!
): Role
Arguments
role.id ● RoleId! non-null scalar
Type
Role object
roles
Returns a paginated list of all roles in the system
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
termsTemplate
Fetches a specific credit facility terms template by its unique identifier
termsTemplate(
id: TermsTemplateId!
): TermsTemplate
Arguments
termsTemplate.id ● TermsTemplateId! non-null scalar
Type
TermsTemplate object
termsTemplates
Returns a paginated list of all credit facility terms templates
termsTemplates(
after: String
first: Int!
): TermsTemplateConnection!
Arguments
termsTemplates.after ● String scalar
termsTemplates.first ● Int! non-null scalar
Type
TermsTemplateConnection object
time
Returns the current environment clock state, including the next configured end-of-day boundary.
time: Time!
Type
Time object
transactionTemplates
Returns a paginated list of all ledger transaction templates
transactionTemplates(
after: String
first: Int!
): TransactionTemplateConnection!
Arguments
transactionTemplates.after ● String scalar
transactionTemplates.first ● Int! non-null scalar
Type
TransactionTemplateConnection object
trialBalance
Generates a trial balance report for the specified date range
trialBalance(
from: Date!
until: Date!
): TrialBalance!
Arguments
trialBalance.from ● Date! non-null scalar
trialBalance.until ● Date! non-null scalar
Type
TrialBalance object
user
Fetches a specific user by their unique identifier
user(
id: UserId!
): User
Arguments
user.id ● UserId! non-null scalar
Type
User object
users
Returns a list of all users in the system
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
Fetches a specific withdrawal by its unique identifier
withdrawal(
id: WithdrawalId!
): Withdrawal
Arguments
withdrawal.id ● WithdrawalId! non-null scalar
Type
Withdrawal object
withdrawalByPublicId
Fetches a withdrawal by its public-facing identifier
withdrawalByPublicId(
id: PublicId!
): Withdrawal
Arguments
withdrawalByPublicId.id ● PublicId! non-null scalar
Type
Withdrawal object
withdrawals
Returns a paginated and filterable list of all withdrawals
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
approvalProcessApprove
Casts an approval vote in an approval process
approvalProcessApprove(
input: ApprovalProcessApproveInput!
): ApprovalProcessApprovePayload!
Arguments
approvalProcessApprove.input ● ApprovalProcessApproveInput! non-null input
Type
ApprovalProcessApprovePayload union
approvalProcessDeny
Casts a denial vote in an approval process with a reason
approvalProcessDeny(
input: ApprovalProcessDenyInput!
): ApprovalProcessDenyPayload!
Arguments
approvalProcessDeny.input ● ApprovalProcessDenyInput! non-null input
Type
ApprovalProcessDenyPayload union
chartOfAccountsAddChildNode
Adds a child node under a parent in the chart of accounts
chartOfAccountsAddChildNode(
input: ChartOfAccountsAddChildNodeInput!
): ChartOfAccountsAddChildNodePayload!
Arguments
chartOfAccountsAddChildNode.input ● ChartOfAccountsAddChildNodeInput! non-null input
Type
ChartOfAccountsAddChildNodePayload union
chartOfAccountsInitialize
Initializes the chart of accounts from a CSV file with base configuration settings
chartOfAccountsInitialize(
input: ChartOfAccountsInitializeInput!
): ChartOfAccountsInitializePayload!
Arguments
chartOfAccountsInitialize.input ● ChartOfAccountsInitializeInput! non-null input
Type
ChartOfAccountsInitializePayload object
collateralRecordProceedsFromLiquidation
Records proceeds received from a liquidation
collateralRecordProceedsFromLiquidation(
input: CollateralRecordProceedsFromLiquidationInput!
): CollateralRecordProceedsFromLiquidationPayload!
Arguments
collateralRecordProceedsFromLiquidation.input ● CollateralRecordProceedsFromLiquidationInput! non-null input
Type
CollateralRecordProceedsFromLiquidationPayload union
collateralRecordSentToLiquidation
Records collateral sent to liquidation
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
Creates a new approval committee
committeeCreate(
input: CommitteeCreateInput!
): CommitteeCreatePayload!
Arguments
committeeCreate.input ● CommitteeCreateInput! non-null input
Type
CommitteeCreatePayload object
committeeUserAdd
Adds a user to an approval committee
committeeUserAdd(
input: CommitteeUserAddInput!
): CommitteeUserAddPayload!
Arguments
committeeUserAdd.input ● CommitteeUserAddInput! non-null input
Type
CommitteeUserAddPayload object
committeeUserRemove
Removes a user from an approval committee
committeeUserRemove(
input: CommitteeUserRemoveInput!
): CommitteeUserRemovePayload!
Arguments
committeeUserRemove.input ● CommitteeUserRemoveInput! non-null input
Type
CommitteeUserRemovePayload object
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 object
creditFacilityComplete
Marks a credit facility as complete after full repayment
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
creditFacilityModuleConfigure
Configures the credit facility module's chart of accounts mappings
creditFacilityModuleConfigure(
input: CreditFacilityModuleConfigureInput!
): CreditFacilityModuleConfigurePayload!
Arguments
creditFacilityModuleConfigure.input ● CreditFacilityModuleConfigureInput! non-null input
Type
CreditFacilityModuleConfigurePayload object
creditFacilityPartialPaymentRecord
Records a partial payment towards a credit facility
creditFacilityPartialPaymentRecord(
input: CreditFacilityPartialPaymentRecordInput!
): CreditFacilityPartialPaymentRecordPayload!
Arguments
creditFacilityPartialPaymentRecord.input ● CreditFacilityPartialPaymentRecordInput! non-null input
Type
CreditFacilityPartialPaymentRecordPayload object
creditFacilityPartialPaymentWithDateRecord
Records a partial payment towards a credit facility with a specific effective date
creditFacilityPartialPaymentWithDateRecord(
input: CreditFacilityPartialPaymentWithDateRecordInput!
): CreditFacilityPartialPaymentRecordPayload!
Arguments
creditFacilityPartialPaymentWithDateRecord.input ● CreditFacilityPartialPaymentWithDateRecordInput! non-null input
Type
CreditFacilityPartialPaymentRecordPayload object
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 object
creditFacilityProposalCustomerApprovalConclude
Conclude customer approval for a credit facility proposal.
creditFacilityProposalCustomerApprovalConclude(
input: CreditFacilityProposalCustomerApprovalConcludeInput!
): CreditFacilityProposalCustomerApprovalConcludePayload!
Arguments
creditFacilityProposalCustomerApprovalConclude.input ● CreditFacilityProposalCustomerApprovalConcludeInput! non-null input
Type
CreditFacilityProposalCustomerApprovalConcludePayload object
custodianConfigUpdate
Updates the configuration for an existing custodian integration
custodianConfigUpdate(
input: CustodianConfigUpdateInput!
): CustodianConfigUpdatePayload!
Arguments
custodianConfigUpdate.input ● CustodianConfigUpdateInput! non-null input
Type
CustodianConfigUpdatePayload object
custodianCreate
Creates a new custodian integration (Komainu, BitGo, or xpub-based self-custody)
custodianCreate(
input: CustodianCreateInput!
): CustodianCreatePayload!
Arguments
custodianCreate.input ● CustodianCreateInput! non-null input
Type
CustodianCreatePayload object
customerClose
Closes a customer account after verifying all preconditions are met
customerClose(
input: CustomerCloseInput!
): CustomerClosePayload!
Arguments
customerClose.input ● CustomerCloseInput! non-null input
Type
CustomerClosePayload union
customerDocumentArchive
Archives a customer document
customerDocumentArchive(
input: CustomerDocumentArchiveInput!
): CustomerDocumentArchivePayload!
Arguments
customerDocumentArchive.input ● CustomerDocumentArchiveInput! non-null input
Type
CustomerDocumentArchivePayload object
customerDocumentCreate
Uploads and attaches a document to a customer's profile
customerDocumentCreate(
input: CustomerDocumentCreateInput!
): CustomerDocumentCreatePayload!
Arguments
customerDocumentCreate.input ● CustomerDocumentCreateInput! non-null input
Type
CustomerDocumentCreatePayload object
customerDocumentDelete
Permanently deletes a customer document
customerDocumentDelete(
input: CustomerDocumentDeleteInput!
): CustomerDocumentDeletePayload!
Arguments
customerDocumentDelete.input ● CustomerDocumentDeleteInput! non-null input
Type
CustomerDocumentDeletePayload object
customerDocumentDownloadLinkGenerate
Generates a temporary download link for a customer document
customerDocumentDownloadLinkGenerate(
input: CustomerDocumentDownloadLinksGenerateInput!
): CustomerDocumentDownloadLinksGeneratePayload!
Arguments
customerDocumentDownloadLinkGenerate.input ● CustomerDocumentDownloadLinksGenerateInput! non-null input
Type
CustomerDocumentDownloadLinksGeneratePayload object
customerEmailUpdate
Updates a customer's email address
customerEmailUpdate(
input: CustomerEmailUpdateInput!
): CustomerEmailUpdatePayload!
Arguments
customerEmailUpdate.input ● CustomerEmailUpdateInput! non-null input
Type
CustomerEmailUpdatePayload object
customerFreeze
Freezes a customer account, blocking all financial operations and freezing their deposit accounts
customerFreeze(
input: CustomerFreezeInput!
): CustomerFreezePayload!
Arguments
customerFreeze.input ● CustomerFreezeInput! non-null input
Type
CustomerFreezePayload union
customerTelegramHandleUpdate
Updates a customer's Telegram handle
customerTelegramHandleUpdate(
input: CustomerTelegramHandleUpdateInput!
): CustomerTelegramHandleUpdatePayload!
Arguments
customerTelegramHandleUpdate.input ● CustomerTelegramHandleUpdateInput! non-null input
Type
CustomerTelegramHandleUpdatePayload object
customerUnfreeze
Unfreezes a previously frozen customer account, restoring normal operations and unfreezing their deposit accounts
customerUnfreeze(
input: CustomerUnfreezeInput!
): CustomerUnfreezePayload!
Arguments
customerUnfreeze.input ● CustomerUnfreezeInput! non-null input
Type
CustomerUnfreezePayload union
depositAccountClose
Closes a deposit account
depositAccountClose(
input: DepositAccountCloseInput!
): DepositAccountClosePayload!
Arguments
depositAccountClose.input ● DepositAccountCloseInput! non-null input
Type
DepositAccountClosePayload union
depositAccountCreate
Create a deposit account for a customer.
depositAccountCreate(
input: DepositAccountCreateInput!
): DepositAccountCreatePayload!
Arguments
depositAccountCreate.input ● DepositAccountCreateInput! non-null input
Type
DepositAccountCreatePayload object
depositAccountFreeze
Freezes a deposit account, preventing transactions
depositAccountFreeze(
input: DepositAccountFreezeInput!
): DepositAccountFreezePayload!
Arguments
depositAccountFreeze.input ● DepositAccountFreezeInput! non-null input
Type
DepositAccountFreezePayload union
depositAccountModuleConfigure
Configures the deposit account module's chart of accounts mappings
depositAccountModuleConfigure(
input: DepositAccountModuleConfigureInput!
): DepositAccountModuleConfigurePayload!
Arguments
depositAccountModuleConfigure.input ● DepositAccountModuleConfigureInput! non-null input
Type
DepositAccountModuleConfigurePayload object
depositAccountUnfreeze
Unfreezes a previously frozen deposit account
depositAccountUnfreeze(
input: DepositAccountUnfreezeInput!
): DepositAccountUnfreezePayload!
Arguments
depositAccountUnfreeze.input ● DepositAccountUnfreezeInput! non-null input
Type
DepositAccountUnfreezePayload union
depositRecord
Record a deposit on an account.
depositRecord(
input: DepositRecordInput!
): DepositRecordPayload!
Arguments
depositRecord.input ● DepositRecordInput! non-null input
Type
DepositRecordPayload union
depositRevert
Reverts a confirmed deposit
depositRevert(
input: DepositRevertInput!
): DepositRevertPayload!
Arguments
depositRevert.input ● DepositRevertInput! non-null input
Type
DepositRevertPayload object
domainConfigUpdate
Updates a domain configuration setting
domainConfigUpdate(
input: DomainConfigUpdateInput!
): DomainConfigUpdatePayload!
Arguments
domainConfigUpdate.input ● DomainConfigUpdateInput! non-null input
Type
DomainConfigUpdatePayload object
fiscalYearClose
Closes a fiscal year
fiscalYearClose(
input: FiscalYearCloseInput!
): FiscalYearClosePayload!
Arguments
fiscalYearClose.input ● FiscalYearCloseInput! non-null input
Type
FiscalYearClosePayload union
fiscalYearCloseMonth
Closes the current month in a fiscal year
fiscalYearCloseMonth(
input: FiscalYearCloseMonthInput!
): FiscalYearCloseMonthPayload!
Arguments
fiscalYearCloseMonth.input ● FiscalYearCloseMonthInput! non-null input
Type
FiscalYearCloseMonthPayload union
fiscalYearInit
Initializes a new fiscal year
fiscalYearInit(
input: FiscalYearInitInput!
): FiscalYearInitPayload!
Arguments
fiscalYearInit.input ● FiscalYearInitInput! non-null input
Type
FiscalYearInitPayload union
fiscalYearOpenNext
Opens the next fiscal year
fiscalYearOpenNext(
input: FiscalYearOpenNextInput!
): FiscalYearOpenNextPayload!
Arguments
fiscalYearOpenNext.input ● FiscalYearOpenNextInput! non-null input
Type
FiscalYearOpenNextPayload union
ledgerAccountCsvCreate
Creates a CSV export for a ledger account
ledgerAccountCsvCreate(
input: LedgerAccountCsvCreateInput!
): LedgerAccountCsvCreatePayload!
Arguments
ledgerAccountCsvCreate.input ● LedgerAccountCsvCreateInput! non-null input
Type
LedgerAccountCsvCreatePayload object
ledgerAccountCsvDownloadLinkGenerate
Generates a download link for a ledger account CSV document
ledgerAccountCsvDownloadLinkGenerate(
input: LedgerAccountCsvDownloadLinkGenerateInput!
): LedgerAccountCsvDownloadLinkGeneratePayload!
Arguments
ledgerAccountCsvDownloadLinkGenerate.input ● LedgerAccountCsvDownloadLinkGenerateInput! non-null input
Type
LedgerAccountCsvDownloadLinkGeneratePayload object
ledgerManualTransactionExecute
Executes a manual ledger transaction with specified entries
ledgerManualTransactionExecute(
input: LedgerManualTransactionExecuteInput!
): LedgerManualTransactionExecutePayload!
Arguments
ledgerManualTransactionExecute.input ● LedgerManualTransactionExecuteInput! non-null input
Type
LedgerManualTransactionExecutePayload union
policyCommitteeAssign
Assigns a committee to an approval policy with a threshold
policyCommitteeAssign(
input: PolicyCommitteeAssignInput!
): PolicyCommitteeAssignPayload!
Arguments
policyCommitteeAssign.input ● PolicyCommitteeAssignInput! non-null input
Type
PolicyCommitteeAssignPayload object
priceProviderActivate
Activates a price provider so it contributes to the median price calculation
priceProviderActivate(
input: PriceProviderActivateInput!
): PriceProviderActivatePayload!
Arguments
priceProviderActivate.input ● PriceProviderActivateInput! non-null input
Type
PriceProviderActivatePayload object
priceProviderDeactivate
Deactivates a price provider so it no longer contributes to price calculation
priceProviderDeactivate(
input: PriceProviderDeactivateInput!
): PriceProviderDeactivatePayload!
Arguments
priceProviderDeactivate.input ● PriceProviderDeactivateInput! non-null input
Type
PriceProviderDeactivatePayload object
priceProviderManualPriceUpdate
Updates the manual price provider with a specific USD/BTC price
priceProviderManualPriceUpdate(
input: PriceProviderManualPriceUpdateInput!
): PriceProviderManualPriceUpdatePayload!
Arguments
priceProviderManualPriceUpdate.input ● PriceProviderManualPriceUpdateInput! non-null input
Type
PriceProviderManualPriceUpdatePayload object
prospectClose
Closes a prospect, ending their onboarding process
prospectClose(
input: ProspectCloseInput!
): ProspectClosePayload!
Arguments
prospectClose.input ● ProspectCloseInput! non-null input
Type
ProspectClosePayload union
prospectConvert
Convert a prospect into a customer.
prospectConvert(
input: ProspectConvertInput!
): ProspectConvertPayload!
Arguments
prospectConvert.input ● ProspectConvertInput! non-null input
Type
ProspectConvertPayload union
prospectCreate
Create a prospect.
prospectCreate(
input: ProspectCreateInput!
): ProspectCreatePayload!
Arguments
prospectCreate.input ● ProspectCreateInput! non-null input
Type
ProspectCreatePayload object
prospectKycLinkCreate
Generates a KYC verification link for a prospect
prospectKycLinkCreate(
input: ProspectKycLinkCreateInput!
): ProspectKycLinkCreatePayload!
Arguments
prospectKycLinkCreate.input ● ProspectKycLinkCreateInput! non-null input
Type
ProspectKycLinkCreatePayload object
reportFileDownloadLinkGenerate
Generates a download link for a report file
reportFileDownloadLinkGenerate(
input: ReportFileDownloadLinkGenerateInput!
): ReportFileDownloadLinkGeneratePayload!
Arguments
reportFileDownloadLinkGenerate.input ● ReportFileDownloadLinkGenerateInput! non-null input
Type
ReportFileDownloadLinkGeneratePayload object
reportRunTrigger
Triggers manual generation for a single report definition, with an optional as-of date when the selected report requires one
reportRunTrigger(
input: ReportRunTriggerInput!
): ReportRunTriggerPayload!
Arguments
reportRunTrigger.input ● ReportRunTriggerInput! non-null input
Type
ReportRunTriggerPayload object
roleCreate
Creates a new role with specified permission sets
roleCreate(
input: RoleCreateInput!
): RoleCreatePayload!
Arguments
roleCreate.input ● RoleCreateInput! non-null input
Type
RoleCreatePayload object
rolePermissionSetsAdd
Adds permission sets to an existing role
rolePermissionSetsAdd(
input: RolePermissionSetsAddInput!
): RolePermissionSetsAddPayload!
Arguments
rolePermissionSetsAdd.input ● RolePermissionSetsAddInput! non-null input
Type
RolePermissionSetsAddPayload union
rolePermissionSetsRemove
Removes permission sets from an existing role
rolePermissionSetsRemove(
input: RolePermissionSetsRemoveInput!
): RolePermissionSetsRemovePayload!
Arguments
rolePermissionSetsRemove.input ● RolePermissionSetsRemoveInput! non-null input
Type
RolePermissionSetsRemovePayload union
termsTemplateCreate
Create a terms template.
termsTemplateCreate(
input: TermsTemplateCreateInput!
): TermsTemplateCreatePayload!
Arguments
termsTemplateCreate.input ● TermsTemplateCreateInput! non-null input
Type
TermsTemplateCreatePayload union
termsTemplateUpdate
Updates an existing credit facility terms template
termsTemplateUpdate(
input: TermsTemplateUpdateInput!
): TermsTemplateUpdatePayload!
Arguments
termsTemplateUpdate.input ● TermsTemplateUpdateInput! non-null input
Type
TermsTemplateUpdatePayload object
timeAdvanceToNextEndOfDay
Advances manual environment time to the next configured end-of-day boundary and returns the updated clock state.
timeAdvanceToNextEndOfDay: TimeAdvanceToNextEndOfDayPayload!
Type
TimeAdvanceToNextEndOfDayPayload object
userCreate
Creates a new user with a specified role
userCreate(
input: UserCreateInput!
): UserCreatePayload!
Arguments
userCreate.input ● UserCreateInput! non-null input
Type
UserCreatePayload object
userRoleUpdate
Updates the role assigned to an existing user
userRoleUpdate(
input: UserRoleUpdateInput!
): UserRoleUpdatePayload!
Arguments
userRoleUpdate.input ● UserRoleUpdateInput! non-null input
Type
UserRoleUpdatePayload object
withdrawalCancel
Cancels a pending withdrawal request
withdrawalCancel(
input: WithdrawalCancelInput!
): WithdrawalCancelPayload!
Arguments
withdrawalCancel.input ● WithdrawalCancelInput! non-null input
Type
WithdrawalCancelPayload union
withdrawalConfirm
Confirm a withdrawal.
withdrawalConfirm(
input: WithdrawalConfirmInput!
): WithdrawalConfirmPayload!
Arguments
withdrawalConfirm.input ● WithdrawalConfirmInput! non-null input
Type
WithdrawalConfirmPayload union
withdrawalInitiate
Initiate a withdrawal from a deposit account.
withdrawalInitiate(
input: WithdrawalInitiateInput!
): WithdrawalInitiatePayload!
Arguments
withdrawalInitiate.input ● WithdrawalInitiateInput! non-null input
Type
WithdrawalInitiatePayload union
withdrawalRevert
Reverts a confirmed withdrawal
withdrawalRevert(
input: WithdrawalRevertInput!
): WithdrawalRevertPayload!
Arguments
withdrawalRevert.input ● WithdrawalRevertInput! non-null input
Type
WithdrawalRevertPayload 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
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
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
prospectUpdated
No description
prospectUpdated(
prospectId: ProspectId!
): Prospect!
Arguments
prospectUpdated.prospectId ● ProspectId! non-null scalar
Type
Prospect object
realtimePriceUpdated
No description
realtimePriceUpdated: RealtimePrice!
Type
RealtimePrice object
reportRunUpdated
No description
reportRunUpdated: ReportRunUpdatedPayload!
Type
ReportRunUpdatedPayload 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
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! non-null object
ApprovalProcess.rules ● ApprovalRules! non-null union
ApprovalProcess.status ● ApprovalProcessStatus! non-null enum
ApprovalProcess.target ● ApprovalProcessTarget! non-null union
ApprovalProcess.userCanSubmitDecision ● Boolean! non-null scalar
ApprovalProcess.voters ● [ApprovalProcessVoter!]! non-null 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! non-null object
ApprovalProcessVoter.votedAt ● Timestamp scalar
Member Of
ApprovalProcess object
AuditEntry
No description
type AuditEntry {
action: String!
auditEntryId: AuditEntryId!
authorized: Boolean!
object: String!
recordedAt: Timestamp!
subject: AuditSubject!
}
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.subject ● AuditSubject! non-null union
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
BalanceSheet
No description
type BalanceSheet {
assetsBalance: LedgerAccountBalanceByCurrency!
categories: [BalanceSheetAccount!]!
equityBalance: LedgerAccountBalanceByCurrency!
liabilitiesBalance: LedgerAccountBalanceByCurrency!
name: String!
}
Fields
BalanceSheet.assetsBalance ● LedgerAccountBalanceByCurrency! non-null object
BalanceSheet.categories ● [BalanceSheetAccount!]! non-null object
BalanceSheet.equityBalance ● LedgerAccountBalanceByCurrency! non-null object
BalanceSheet.liabilitiesBalance ● LedgerAccountBalanceByCurrency! non-null object
BalanceSheet.name ● String! non-null scalar
Returned By
balanceSheet query
BalanceSheetAccount
No description
type BalanceSheetAccount {
balance: LedgerAccountBalanceByCurrency!
children: [BalanceSheetAccount!]!
code: AccountCode
ledgerAccountId: LedgerAccountId!
name: String!
}
Fields
BalanceSheetAccount.balance ● LedgerAccountBalanceByCurrency! non-null object
BalanceSheetAccount.children ● [BalanceSheetAccount!]! non-null object
BalanceSheetAccount.code ● AccountCode scalar
BalanceSheetAccount.ledgerAccountId ● LedgerAccountId! non-null scalar
BalanceSheetAccount.name ● String! non-null scalar
Member Of
BalanceSheet object ● BalanceSheetAccount object
BtcAmount
No description
type BtcAmount {
btc: Satoshis!
}
Fields
BtcAmount.btc ● Satoshis! non-null scalar
Implemented By
LedgerEntryAmount union
BtcBalanceDetails
No description
type BtcBalanceDetails {
credit: Satoshis!
debit: Satoshis!
net: SignedSatoshis!
}
Fields
BtcBalanceDetails.credit ● Satoshis! non-null scalar
BtcBalanceDetails.debit ● Satoshis! non-null scalar
BtcBalanceDetails.net ● SignedSatoshis! non-null scalar
Member Of
BtcLedgerAccountBalance object
BtcLedgerAccountBalance
No description
type BtcLedgerAccountBalance {
encumbrance: BtcBalanceDetails!
pending: BtcBalanceDetails!
settled: BtcBalanceDetails!
}
Fields
BtcLedgerAccountBalance.encumbrance ● BtcBalanceDetails! non-null object
BtcLedgerAccountBalance.pending ● BtcBalanceDetails! non-null object
BtcLedgerAccountBalance.settled ● BtcBalanceDetails! non-null object
Member Of
BtcLedgerAccountBalanceRange object ● LedgerAccountBalanceByCurrency object
BtcLedgerAccountBalanceRange
No description
type BtcLedgerAccountBalanceRange {
close: BtcLedgerAccountBalance!
open: BtcLedgerAccountBalance!
periodActivity: BtcLedgerAccountBalance!
}
Fields
BtcLedgerAccountBalanceRange.close ● BtcLedgerAccountBalance! non-null object
BtcLedgerAccountBalanceRange.open ● BtcLedgerAccountBalance! non-null object
BtcLedgerAccountBalanceRange.periodActivity ● BtcLedgerAccountBalance! non-null object
Member Of
LedgerAccountBalanceRangeByCurrency object
Implemented By
LedgerAccountBalanceRange 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
ChartNode
No description
type ChartNode {
accountCode: AccountCode!
accountSetId: AccountSetId!
manualTransactionsPossible: Boolean!
name: String!
parentAccountCode: AccountCode
}
Fields
ChartNode.accountCode ● AccountCode! non-null scalar
ChartNode.accountSetId ● AccountSetId! 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 ● ChartOfAccountsInitializePayload 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
ChartOfAccountsInitializePayload
No description
type ChartOfAccountsInitializePayload {
chartOfAccounts: ChartOfAccounts!
}
Fields
ChartOfAccountsInitializePayload.chartOfAccounts ● ChartOfAccounts! non-null object
Returned By
chartOfAccountsInitialize mutation
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! non-null 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
CollateralRecordProceedsFromLiquidationPayloadSuccess object ● CollateralRecordSentToLiquidationPayloadSuccess object ● CollateralUpdatePayloadSuccess object ● Liquidation object
Implemented By
LedgerAccountEntity union
CollateralRecordProceedsFromLiquidationPayloadError
No description
type CollateralRecordProceedsFromLiquidationPayloadError {
code: CollateralRecordProceedsFromLiquidationErrorCode!
}
Fields
CollateralRecordProceedsFromLiquidationPayloadError.code ● CollateralRecordProceedsFromLiquidationErrorCode! non-null enum
Implemented By
CollateralRecordProceedsFromLiquidationPayload union
CollateralRecordProceedsFromLiquidationPayloadSuccess
No description
type CollateralRecordProceedsFromLiquidationPayloadSuccess {
collateral: Collateral!
}
Fields
CollateralRecordProceedsFromLiquidationPayloadSuccess.collateral ● Collateral! non-null object
Implemented By
CollateralRecordProceedsFromLiquidationPayload 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!]! non-null 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 ● CommitteeCreatePayload object ● CommitteeEdge object ● CommitteeUserAddPayload object ● CommitteeUserRemovePayload object
CommitteeApproval
No description
type CommitteeApproval {
committee: Committee!
}
Fields
CommitteeApproval.committee ● Committee! non-null 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
CommitteeCreatePayload
No description
type CommitteeCreatePayload {
committee: Committee!
}
Fields
CommitteeCreatePayload.committee ● Committee! non-null object
Returned By
committeeCreate mutation
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
CommitteeUserAddPayload
No description
type CommitteeUserAddPayload {
committee: Committee!
}
Fields
CommitteeUserAddPayload.committee ● Committee! non-null object
Returned By
committeeUserAdd mutation
CommitteeUserRemovePayload
No description
type CommitteeUserRemovePayload {
committee: Committee!
}
Fields
CommitteeUserRemovePayload.committee ● Committee! non-null object
Returned By
committeeUserRemove mutation
CreditFacility
No description
type CreditFacility {
activatedAt: Timestamp!
balance: CreditFacilityBalance!
canBeCompleted: Boolean!
collateralId: CollateralId!
collateralizationState: CollateralizationState!
createdAt: Timestamp!
creditFacilityId: CreditFacilityId!
creditFacilityTerms: TermValues!
currentCvl: CvlPct!
customer: Customer!
disbursals: [CreditFacilityDisbursal!]!
eventHistory(
after: String
first: Int!
): EventTimelineEntryConnection!
facilityAmount: UsdCents!
history: [CreditFacilityHistoryEntry!]!
ledgerAccounts: CreditFacilityLedgerAccounts!
liquidations: [Liquidation!]!
maturesAt: Timestamp!
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.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.currentCvl ● CvlPct! non-null union
CreditFacility.customer ● Customer! non-null 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 ● UsdCents! non-null scalar
CreditFacility.history ● [CreditFacilityHistoryEntry!]! non-null union
CreditFacility.ledgerAccounts ● CreditFacilityLedgerAccounts! non-null object
CreditFacility.liquidations ● [Liquidation!]! non-null object
CreditFacility.maturesAt ● Timestamp! non-null scalar
CreditFacility.publicId ● PublicId! non-null scalar
CreditFacility.repaymentPlan ● [CreditFacilityRepaymentPlanEntry!]! non-null 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 ● CreditFacilityPartialPaymentRecordPayload object ● CreditFacilityPaymentAllocation object ● Customer 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
CreditFacilityAgreementGeneratePayload object
CreditFacilityAgreementDownloadLinksGeneratePayload
No description
type CreditFacilityAgreementDownloadLinksGeneratePayload {
link: Url!
}
Fields
CreditFacilityAgreementDownloadLinksGeneratePayload.link ● Url! non-null scalar
Returned By
creditFacilityAgreementDownloadLinkGenerate mutation
CreditFacilityAgreementGeneratePayload
No description
type CreditFacilityAgreementGeneratePayload {
creditFacilityAgreement: CreditFacilityAgreement!
}
Fields
CreditFacilityAgreementGeneratePayload.creditFacilityAgreement ● CreditFacilityAgreement! non-null object
Returned By
creditFacilityAgreementGenerate mutation
CreditFacilityApproved
No description
type CreditFacilityApproved {
cents: UsdCents!
effective: Date!
ledgerTransactionId: LedgerTransactionId!
recordedAt: Timestamp!
}
Fields
CreditFacilityApproved.cents ● UsdCents! non-null scalar
CreditFacilityApproved.effective ● Date! 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: Satoshis!
disbursed: Disbursed!
dueOutstanding: UsdCents!
facilityRemaining: UsdCents!
interest: Interest!
outstanding: UsdCents!
outstandingPayable: UsdCents!
paymentsUnapplied: UsdCents!
}
Fields
CreditFacilityBalance.collateral ● Satoshis! non-null scalar
CreditFacilityBalance.disbursed ● Disbursed! non-null object
CreditFacilityBalance.dueOutstanding ● UsdCents! non-null scalar
CreditFacilityBalance.facilityRemaining ● UsdCents! non-null scalar
CreditFacilityBalance.interest ● Interest! non-null object
CreditFacilityBalance.outstanding ● UsdCents! non-null scalar
CreditFacilityBalance.outstandingPayable ● UsdCents! non-null scalar
CreditFacilityBalance.paymentsUnapplied ● UsdCents! non-null scalar
Member Of
CreditFacility object
CreditFacilityCollateralizationUpdated
No description
type CreditFacilityCollateralizationUpdated {
collateral: Satoshis!
effective: Date!
outstandingDisbursal: UsdCents!
outstandingInterest: UsdCents!
price: UsdCents!
recordedAt: Timestamp!
state: CollateralizationState!
}
Fields
CreditFacilityCollateralizationUpdated.collateral ● Satoshis! non-null scalar
CreditFacilityCollateralizationUpdated.effective ● Date! non-null scalar
CreditFacilityCollateralizationUpdated.outstandingDisbursal ● UsdCents! non-null scalar
CreditFacilityCollateralizationUpdated.outstandingInterest ● UsdCents! non-null scalar
CreditFacilityCollateralizationUpdated.price ● UsdCents! non-null scalar
CreditFacilityCollateralizationUpdated.recordedAt ● Timestamp! non-null scalar
CreditFacilityCollateralizationUpdated.state ● CollateralizationState! non-null enum
Implemented By
CreditFacilityHistoryEntry union
CreditFacilityCollateralSentOut
No description
type CreditFacilityCollateralSentOut {
amount: Satoshis!
effective: Date!
ledgerTransactionId: LedgerTransactionId!
recordedAt: Timestamp!
}
Fields
CreditFacilityCollateralSentOut.amount ● Satoshis! non-null scalar
CreditFacilityCollateralSentOut.effective ● Date! non-null scalar
CreditFacilityCollateralSentOut.ledgerTransactionId ● LedgerTransactionId! non-null scalar
CreditFacilityCollateralSentOut.recordedAt ● Timestamp! non-null scalar
Implemented By
CreditFacilityHistoryEntry union
CreditFacilityCollateralUpdated
No description
type CreditFacilityCollateralUpdated {
direction: CollateralDirection!
effective: Date!
ledgerTransactionId: LedgerTransactionId!
recordedAt: Timestamp!
satoshis: Satoshis!
}
Fields
CreditFacilityCollateralUpdated.direction ● CollateralDirection! non-null enum
CreditFacilityCollateralUpdated.effective ● Date! non-null scalar
CreditFacilityCollateralUpdated.ledgerTransactionId ● LedgerTransactionId! non-null scalar
CreditFacilityCollateralUpdated.recordedAt ● Timestamp! non-null scalar
CreditFacilityCollateralUpdated.satoshis ● Satoshis! 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: UsdCents!
approvalProcess: ApprovalProcess!
createdAt: Timestamp!
creditFacility: CreditFacility!
creditFacilityDisbursalId: CreditFacilityDisbursalId!
eventHistory(
after: String
first: Int!
): EventTimelineEntryConnection!
ledgerTransactions: [LedgerTransaction!]!
publicId: PublicId!
status: DisbursalStatus!
}
Fields
CreditFacilityDisbursal.amount ● UsdCents! non-null scalar
CreditFacilityDisbursal.approvalProcess ● ApprovalProcess! non-null object
CreditFacilityDisbursal.createdAt ● Timestamp! non-null scalar
CreditFacilityDisbursal.creditFacility ● CreditFacility! non-null 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!]! non-null 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 {
cents: UsdCents!
effective: Date!
ledgerTransactionId: LedgerTransactionId!
recordedAt: Timestamp!
}
Fields
CreditFacilityDisbursalExecuted.cents ● UsdCents! non-null scalar
CreditFacilityDisbursalExecuted.effective ● Date! 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 {
cents: UsdCents!
effective: Date!
paymentAllocationId: PaymentAllocationId!
recordedAt: Timestamp!
}
Fields
CreditFacilityIncrementalPayment.cents ● UsdCents! non-null scalar
CreditFacilityIncrementalPayment.effective ● Date! non-null scalar
CreditFacilityIncrementalPayment.paymentAllocationId ● PaymentAllocationId! non-null scalar
CreditFacilityIncrementalPayment.recordedAt ● Timestamp! non-null scalar
Implemented By
CreditFacilityHistoryEntry union
CreditFacilityInterestAccrued
No description
type CreditFacilityInterestAccrued {
cents: UsdCents!
days: Int!
effective: Date!
ledgerTransactionId: LedgerTransactionId!
recordedAt: Timestamp!
}
Fields
CreditFacilityInterestAccrued.cents ● UsdCents! non-null scalar
CreditFacilityInterestAccrued.days ● Int! non-null scalar
CreditFacilityInterestAccrued.effective ● Date! 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!
liquidatedCollateralAccount: LedgerAccount!
paymentHoldingAccount: LedgerAccount!
proceedsFromLiquidationAccount: LedgerAccount!
uncoveredOutstandingAccount: LedgerAccount!
}
Fields
CreditFacilityLedgerAccounts.collateralAccount ● LedgerAccount! non-null object
CreditFacilityLedgerAccounts.collateralInLiquidationAccount ● LedgerAccount! non-null object
CreditFacilityLedgerAccounts.disbursedDefaultedAccount ● LedgerAccount! non-null object
CreditFacilityLedgerAccounts.disbursedReceivableDueAccount ● LedgerAccount! non-null object
CreditFacilityLedgerAccounts.disbursedReceivableNotYetDueAccount ● LedgerAccount! non-null object
CreditFacilityLedgerAccounts.disbursedReceivableOverdueAccount ● LedgerAccount! non-null object
CreditFacilityLedgerAccounts.facilityAccount ● LedgerAccount! non-null object
CreditFacilityLedgerAccounts.feeIncomeAccount ● LedgerAccount! non-null object
CreditFacilityLedgerAccounts.interestDefaultedAccount ● LedgerAccount! non-null object
CreditFacilityLedgerAccounts.interestIncomeAccount ● LedgerAccount! non-null object
CreditFacilityLedgerAccounts.interestReceivableDueAccount ● LedgerAccount! non-null object
CreditFacilityLedgerAccounts.interestReceivableNotYetDueAccount ● LedgerAccount! non-null object
CreditFacilityLedgerAccounts.interestReceivableOverdueAccount ● LedgerAccount! non-null object
CreditFacilityLedgerAccounts.liquidatedCollateralAccount ● LedgerAccount! non-null object
CreditFacilityLedgerAccounts.paymentHoldingAccount ● LedgerAccount! non-null object
CreditFacilityLedgerAccounts.proceedsFromLiquidationAccount ● LedgerAccount! non-null object
CreditFacilityLedgerAccounts.uncoveredOutstandingAccount ● LedgerAccount! non-null object
Member Of
CreditFacility object
CreditFacilityModuleConfig
No description
type CreditFacilityModuleConfig {
chartOfAccountCollateralInLiquidationParentCode: AccountCode!
chartOfAccountCollateralOmnibusParentCode: AccountCode!
chartOfAccountCollateralParentCode: AccountCode!
chartOfAccountDisbursedDefaultedParentCode: AccountCode!
chartOfAccountFacilityOmnibusParentCode: AccountCode!
chartOfAccountFacilityParentCode: AccountCode!
chartOfAccountFeeIncomeParentCode: AccountCode!
chartOfAccountInterestAddedToObligationsOmnibusParentCode: AccountCode!
chartOfAccountInterestDefaultedParentCode: AccountCode!
chartOfAccountInterestIncomeParentCode: AccountCode!
chartOfAccountLiquidatedCollateralParentCode: AccountCode!
chartOfAccountLiquidationProceedsOmnibusParentCode: AccountCode!
chartOfAccountLongTermBankDisbursedReceivableParentCode: AccountCode!
chartOfAccountLongTermBankInterestReceivableParentCode: AccountCode!
chartOfAccountLongTermFinancialInstitutionDisbursedReceivableParentCode: AccountCode!
chartOfAccountLongTermFinancialInstitutionInterestReceivableParentCode: AccountCode!
chartOfAccountLongTermForeignAgencyOrSubsidiaryDisbursedReceivableParentCode: AccountCode!
chartOfAccountLongTermForeignAgencyOrSubsidiaryInterestReceivableParentCode: AccountCode!
chartOfAccountLongTermGovernmentEntityDisbursedReceivableParentCode: AccountCode!
chartOfAccountLongTermGovernmentEntityInterestReceivableParentCode: AccountCode!
chartOfAccountLongTermIndividualDisbursedReceivableParentCode: AccountCode!
chartOfAccountLongTermIndividualInterestReceivableParentCode: AccountCode!
chartOfAccountLongTermNonDomiciledCompanyDisbursedReceivableParentCode: AccountCode!
chartOfAccountLongTermNonDomiciledCompanyInterestReceivableParentCode: AccountCode!
chartOfAccountLongTermPrivateCompanyDisbursedReceivableParentCode: AccountCode!
chartOfAccountLongTermPrivateCompanyInterestReceivableParentCode: AccountCode!
chartOfAccountOverdueBankDisbursedReceivableParentCode: AccountCode!
chartOfAccountOverdueFinancialInstitutionDisbursedReceivableParentCode: AccountCode!
chartOfAccountOverdueForeignAgencyOrSubsidiaryDisbursedReceivableParentCode: AccountCode!
chartOfAccountOverdueGovernmentEntityDisbursedReceivableParentCode: AccountCode!
chartOfAccountOverdueIndividualDisbursedReceivableParentCode: AccountCode!
chartOfAccountOverdueNonDomiciledCompanyDisbursedReceivableParentCode: AccountCode!
chartOfAccountOverduePrivateCompanyDisbursedReceivableParentCode: AccountCode!
chartOfAccountPaymentHoldingParentCode: AccountCode!
chartOfAccountPaymentsMadeOmnibusParentCode: AccountCode!
chartOfAccountProceedsFromLiquidationParentCode: AccountCode!
chartOfAccountShortTermBankDisbursedReceivableParentCode: AccountCode!
chartOfAccountShortTermBankInterestReceivableParentCode: AccountCode!
chartOfAccountShortTermFinancialInstitutionDisbursedReceivableParentCode: AccountCode!
chartOfAccountShortTermFinancialInstitutionInterestReceivableParentCode: AccountCode!
chartOfAccountShortTermForeignAgencyOrSubsidiaryDisbursedReceivableParentCode: AccountCode!
chartOfAccountShortTermForeignAgencyOrSubsidiaryInterestReceivableParentCode: AccountCode!
chartOfAccountShortTermGovernmentEntityDisbursedReceivableParentCode: AccountCode!
chartOfAccountShortTermGovernmentEntityInterestReceivableParentCode: AccountCode!
chartOfAccountShortTermIndividualDisbursedReceivableParentCode: AccountCode!
chartOfAccountShortTermIndividualInterestReceivableParentCode: AccountCode!
chartOfAccountShortTermNonDomiciledCompanyDisbursedReceivableParentCode: AccountCode!
chartOfAccountShortTermNonDomiciledCompanyInterestReceivableParentCode: AccountCode!
chartOfAccountShortTermPrivateCompanyDisbursedReceivableParentCode: AccountCode!
chartOfAccountShortTermPrivateCompanyInterestReceivableParentCode: AccountCode!
chartOfAccountUncoveredOutstandingParentCode: AccountCode!
chartOfAccountsId: ChartOfAccountsId!
}
Fields
CreditFacilityModuleConfig.chartOfAccountCollateralInLiquidationParentCode ● AccountCode! non-null scalar
CreditFacilityModuleConfig.chartOfAccountCollateralOmnibusParentCode ● AccountCode! non-null scalar
CreditFacilityModuleConfig.chartOfAccountCollateralParentCode ● AccountCode! non-null scalar
CreditFacilityModuleConfig.chartOfAccountDisbursedDefaultedParentCode ● AccountCode! non-null scalar
CreditFacilityModuleConfig.chartOfAccountFacilityOmnibusParentCode ● AccountCode! non-null scalar
CreditFacilityModuleConfig.chartOfAccountFacilityParentCode ● AccountCode! non-null scalar
CreditFacilityModuleConfig.chartOfAccountFeeIncomeParentCode ● AccountCode! non-null scalar
CreditFacilityModuleConfig.chartOfAccountInterestAddedToObligationsOmnibusParentCode ● AccountCode! non-null scalar
CreditFacilityModuleConfig.chartOfAccountInterestDefaultedParentCode ● AccountCode! non-null scalar
CreditFacilityModuleConfig.chartOfAccountInterestIncomeParentCode ● AccountCode! non-null scalar
CreditFacilityModuleConfig.chartOfAccountLiquidatedCollateralParentCode ● AccountCode! non-null scalar
CreditFacilityModuleConfig.chartOfAccountLiquidationProceedsOmnibusParentCode ● AccountCode! non-null scalar
CreditFacilityModuleConfig.chartOfAccountLongTermBankDisbursedReceivableParentCode ● AccountCode! non-null scalar
CreditFacilityModuleConfig.chartOfAccountLongTermBankInterestReceivableParentCode ● AccountCode! non-null scalar
CreditFacilityModuleConfig.chartOfAccountLongTermFinancialInstitutionDisbursedReceivableParentCode ● AccountCode! non-null scalar
CreditFacilityModuleConfig.chartOfAccountLongTermFinancialInstitutionInterestReceivableParentCode ● AccountCode! non-null scalar
CreditFacilityModuleConfig.chartOfAccountLongTermForeignAgencyOrSubsidiaryDisbursedReceivableParentCode ● AccountCode! non-null scalar
CreditFacilityModuleConfig.chartOfAccountLongTermForeignAgencyOrSubsidiaryInterestReceivableParentCode ● AccountCode! non-null scalar
CreditFacilityModuleConfig.chartOfAccountLongTermGovernmentEntityDisbursedReceivableParentCode ● AccountCode! non-null scalar
CreditFacilityModuleConfig.chartOfAccountLongTermGovernmentEntityInterestReceivableParentCode ● AccountCode! non-null scalar
CreditFacilityModuleConfig.chartOfAccountLongTermIndividualDisbursedReceivableParentCode ● AccountCode! non-null scalar
CreditFacilityModuleConfig.chartOfAccountLongTermIndividualInterestReceivableParentCode ● AccountCode! non-null scalar
CreditFacilityModuleConfig.chartOfAccountLongTermNonDomiciledCompanyDisbursedReceivableParentCode ● AccountCode! non-null scalar
CreditFacilityModuleConfig.chartOfAccountLongTermNonDomiciledCompanyInterestReceivableParentCode ● AccountCode! non-null scalar
CreditFacilityModuleConfig.chartOfAccountLongTermPrivateCompanyDisbursedReceivableParentCode ● AccountCode! non-null scalar
CreditFacilityModuleConfig.chartOfAccountLongTermPrivateCompanyInterestReceivableParentCode ● AccountCode! non-null scalar
CreditFacilityModuleConfig.chartOfAccountOverdueBankDisbursedReceivableParentCode ● AccountCode! non-null scalar
CreditFacilityModuleConfig.chartOfAccountOverdueFinancialInstitutionDisbursedReceivableParentCode ● AccountCode! non-null scalar
CreditFacilityModuleConfig.chartOfAccountOverdueForeignAgencyOrSubsidiaryDisbursedReceivableParentCode ● AccountCode! non-null scalar
CreditFacilityModuleConfig.chartOfAccountOverdueGovernmentEntityDisbursedReceivableParentCode ● AccountCode! non-null scalar
CreditFacilityModuleConfig.chartOfAccountOverdueIndividualDisbursedReceivableParentCode ● AccountCode! non-null scalar
CreditFacilityModuleConfig.chartOfAccountOverdueNonDomiciledCompanyDisbursedReceivableParentCode ● AccountCode! non-null scalar
CreditFacilityModuleConfig.chartOfAccountOverduePrivateCompanyDisbursedReceivableParentCode ● AccountCode! non-null scalar
CreditFacilityModuleConfig.chartOfAccountPaymentHoldingParentCode ● AccountCode! non-null scalar
CreditFacilityModuleConfig.chartOfAccountPaymentsMadeOmnibusParentCode ● AccountCode! non-null scalar
CreditFacilityModuleConfig.chartOfAccountProceedsFromLiquidationParentCode ● AccountCode! non-null scalar
CreditFacilityModuleConfig.chartOfAccountShortTermBankDisbursedReceivableParentCode ● AccountCode! non-null scalar
CreditFacilityModuleConfig.chartOfAccountShortTermBankInterestReceivableParentCode ● AccountCode! non-null scalar
CreditFacilityModuleConfig.chartOfAccountShortTermFinancialInstitutionDisbursedReceivableParentCode ● AccountCode! non-null scalar
CreditFacilityModuleConfig.chartOfAccountShortTermFinancialInstitutionInterestReceivableParentCode ● AccountCode! non-null scalar
CreditFacilityModuleConfig.chartOfAccountShortTermForeignAgencyOrSubsidiaryDisbursedReceivableParentCode ● AccountCode! non-null scalar
CreditFacilityModuleConfig.chartOfAccountShortTermForeignAgencyOrSubsidiaryInterestReceivableParentCode ● AccountCode! non-null scalar
CreditFacilityModuleConfig.chartOfAccountShortTermGovernmentEntityDisbursedReceivableParentCode ● AccountCode! non-null scalar
CreditFacilityModuleConfig.chartOfAccountShortTermGovernmentEntityInterestReceivableParentCode ● AccountCode! non-null scalar
CreditFacilityModuleConfig.chartOfAccountShortTermIndividualDisbursedReceivableParentCode ● AccountCode! non-null scalar
CreditFacilityModuleConfig.chartOfAccountShortTermIndividualInterestReceivableParentCode ● AccountCode! non-null scalar
CreditFacilityModuleConfig.chartOfAccountShortTermNonDomiciledCompanyDisbursedReceivableParentCode ● AccountCode! non-null scalar
CreditFacilityModuleConfig.chartOfAccountShortTermNonDomiciledCompanyInterestReceivableParentCode ● AccountCode! non-null scalar
CreditFacilityModuleConfig.chartOfAccountShortTermPrivateCompanyDisbursedReceivableParentCode ● AccountCode! non-null scalar
CreditFacilityModuleConfig.chartOfAccountShortTermPrivateCompanyInterestReceivableParentCode ● AccountCode! non-null scalar
CreditFacilityModuleConfig.chartOfAccountUncoveredOutstandingParentCode ● AccountCode! non-null scalar
CreditFacilityModuleConfig.chartOfAccountsId ● ChartOfAccountsId! non-null scalar
Returned By
creditFacilityConfig query
Member Of
CreditFacilityModuleConfigurePayload object
CreditFacilityModuleConfigurePayload
No description
type CreditFacilityModuleConfigurePayload {
creditFacilityConfig: CreditFacilityModuleConfig!
}
Fields
CreditFacilityModuleConfigurePayload.creditFacilityConfig ● CreditFacilityModuleConfig! non-null object
Returned By
creditFacilityModuleConfigure mutation
CreditFacilityPartialPaymentRecordPayload
No description
type CreditFacilityPartialPaymentRecordPayload {
creditFacility: CreditFacility!
}
Fields
CreditFacilityPartialPaymentRecordPayload.creditFacility ● CreditFacility! non-null object
Returned By
creditFacilityPartialPaymentRecord mutation ● creditFacilityPartialPaymentWithDateRecord mutation
CreditFacilityPaymentAllocation
No description
type CreditFacilityPaymentAllocation {
amount: UsdCents!
createdAt: Timestamp!
creditFacility: CreditFacility!
creditFacilityPaymentAllocationId: CreditFacilityPaymentAllocationId!
eventHistory(
after: String
first: Int!
): EventTimelineEntryConnection!
}
Fields
CreditFacilityPaymentAllocation.amount ● UsdCents! non-null scalar
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
CreditFacilityProposal
No description
type CreditFacilityProposal {
approvalProcess: ApprovalProcess
approvalProcessId: ApprovalProcessId
createdAt: Timestamp!
creditFacilityProposalId: CreditFacilityProposalId!
creditFacilityTerms: TermValues!
custodian: Custodian!
customer: Customer!
eventHistory(
after: String
first: Int!
): EventTimelineEntryConnection!
facilityAmount: UsdCents!
repaymentPlan: [CreditFacilityRepaymentPlanEntry!]!
status: CreditFacilityProposalStatus!
}
Fields
CreditFacilityProposal.approvalProcess ● ApprovalProcess object
CreditFacilityProposal.approvalProcessId ● ApprovalProcessId scalar
CreditFacilityProposal.createdAt ● Timestamp! non-null scalar
CreditFacilityProposal.creditFacilityProposalId ● CreditFacilityProposalId! non-null scalar
CreditFacilityProposal.creditFacilityTerms ● TermValues! non-null object
CreditFacilityProposal.custodian ● Custodian! non-null object
CreditFacilityProposal.customer ● Customer! non-null object
CreditFacilityProposal.eventHistory ● EventTimelineEntryConnection! non-null object
CreditFacilityProposal.eventHistory.after ● String scalar
CreditFacilityProposal.eventHistory.first ● Int! non-null scalar
CreditFacilityProposal.facilityAmount ● UsdCents! non-null scalar
CreditFacilityProposal.repaymentPlan ● [CreditFacilityRepaymentPlanEntry!]! non-null object
CreditFacilityProposal.status ● CreditFacilityProposalStatus! non-null enum
Returned By
creditFacilityProposal query ● creditFacilityProposalUpdated subscription
Member Of
CreditFacilityProposalConnection object ● CreditFacilityProposalCreatePayload object ● CreditFacilityProposalCustomerApprovalConcludePayload object ● CreditFacilityProposalEdge object ● Customer 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
CreditFacilityProposalCreatePayload
No description
type CreditFacilityProposalCreatePayload {
creditFacilityProposal: CreditFacilityProposal!
}
Fields
CreditFacilityProposalCreatePayload.creditFacilityProposal ● CreditFacilityProposal! non-null object
Returned By
creditFacilityProposalCreate mutation
CreditFacilityProposalCustomerApprovalConcludePayload
No description
type CreditFacilityProposalCustomerApprovalConcludePayload {
creditFacilityProposal: CreditFacilityProposal!
}
Fields
CreditFacilityProposalCustomerApprovalConcludePayload.creditFacilityProposal ● CreditFacilityProposal! non-null object
Returned By
creditFacilityProposalCustomerApprovalConclude mutation
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
CreditFacilityRepaymentAmountReceived
No description
type CreditFacilityRepaymentAmountReceived {
cents: UsdCents!
effective: Date!
ledgerTransactionId: LedgerTransactionId!
recordedAt: Timestamp!
}
Fields
CreditFacilityRepaymentAmountReceived.cents ● UsdCents! non-null scalar
CreditFacilityRepaymentAmountReceived.effective ● Date! non-null scalar
CreditFacilityRepaymentAmountReceived.ledgerTransactionId ● LedgerTransactionId! non-null scalar
CreditFacilityRepaymentAmountReceived.recordedAt ● Timestamp! non-null scalar
Implemented By
CreditFacilityHistoryEntry union
CreditFacilityRepaymentPlanEntry
No description
type CreditFacilityRepaymentPlanEntry {
accrualAt: Timestamp!
dueAt: Date!
initial: UsdCents!
outstanding: UsdCents!
repaymentType: CreditFacilityRepaymentType!
status: CreditFacilityRepaymentStatus!
}
Fields
CreditFacilityRepaymentPlanEntry.accrualAt ● Timestamp! non-null scalar
CreditFacilityRepaymentPlanEntry.dueAt ● Date! non-null scalar
CreditFacilityRepaymentPlanEntry.initial ● UsdCents! non-null scalar
CreditFacilityRepaymentPlanEntry.outstanding ● UsdCents! non-null scalar
CreditFacilityRepaymentPlanEntry.repaymentType ● CreditFacilityRepaymentType! non-null enum
CreditFacilityRepaymentPlanEntry.status ● CreditFacilityRepaymentStatus! non-null enum
Member Of
CreditFacility object ● CreditFacilityProposal object ● PendingCreditFacility 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
CreditFacilityProposal object ● CustodianConfigUpdatePayload object ● CustodianConnection object ● CustodianCreatePayload object ● CustodianEdge object ● Wallet object
CustodianConfigUpdatePayload
No description
type CustodianConfigUpdatePayload {
custodian: Custodian!
}
Fields
CustodianConfigUpdatePayload.custodian ● Custodian! non-null object
Returned By
custodianConfigUpdate mutation
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
CustodianCreatePayload
No description
type CustodianCreatePayload {
custodian: Custodian!
}
Fields
CustodianCreatePayload.custodian ● Custodian! non-null object
Returned By
custodianCreate mutation
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 {
applicantId: String
conversionReason: ConversionReason!
createdAt: Timestamp!
creditFacilities: [CreditFacility!]!
creditFacilityProposals: [CreditFacilityProposal!]!
customerId: CustomerId!
customerType: CustomerType!
depositAccount: DepositAccount
documents: [CustomerDocument!]!
email: String!
eventHistory(
after: String
first: Int!
): EventTimelineEntryConnection!
level: KycLevel!
pendingCreditFacilities: [PendingCreditFacility!]!
personalInfo: PersonalInfo
publicId: PublicId!
status: CustomerStatus!
telegramHandle: String!
userCanCreateCreditFacility: Boolean!
}
Fields
Customer.applicantId ● String scalar
Customer.conversionReason ● ConversionReason! non-null enum
Customer.createdAt ● Timestamp! non-null scalar
Customer.creditFacilities ● [CreditFacility!]! non-null object
Customer.creditFacilityProposals ● [CreditFacilityProposal!]! non-null object
Customer.customerId ● CustomerId! non-null scalar
Customer.customerType ● CustomerType! non-null enum
Customer.depositAccount ● DepositAccount object
Customer.documents ● [CustomerDocument!]! non-null object
Customer.email ● String! non-null scalar
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.pendingCreditFacilities ● [PendingCreditFacility!]! non-null object
Customer.personalInfo ● PersonalInfo object
Customer.publicId ● PublicId! non-null scalar
Customer.status ● CustomerStatus! non-null enum
Customer.telegramHandle ● String! non-null scalar
Customer.userCanCreateCreditFacility ● Boolean! non-null scalar
Returned By
customer query ● customerByEmail query ● customerByPublicId query
Member Of
CreditFacility object ● CreditFacilityProposal object ● CustomerClosePayloadSuccess object ● CustomerConnection object ● CustomerEdge object ● CustomerEmailUpdatePayload object ● CustomerFreezePayloadSuccess object ● CustomerTelegramHandleUpdatePayload object ● CustomerUnfreezePayloadSuccess object ● DepositAccount object ● PendingCreditFacility object ● Prospect object ● ProspectConvertPayloadSuccess object
Implemented By
AuditSubject union ● PublicIdTarget 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
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
CustomerDocument
No description
type CustomerDocument {
customerDocumentId: CustomerDocumentId!
customerId: CustomerId!
eventHistory(
after: String
first: Int!
): EventTimelineEntryConnection!
filename: String!
status: DocumentStatus!
}
Fields
CustomerDocument.customerDocumentId ● CustomerDocumentId! non-null scalar
CustomerDocument.customerId ● CustomerId! non-null scalar
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 ● CustomerDocumentArchivePayload object ● CustomerDocumentCreatePayload object
CustomerDocumentArchivePayload
No description
type CustomerDocumentArchivePayload {
customerDocument: CustomerDocument!
}
Fields
CustomerDocumentArchivePayload.customerDocument ● CustomerDocument! non-null object
Returned By
customerDocumentArchive mutation
CustomerDocumentCreatePayload
No description
type CustomerDocumentCreatePayload {
customerDocument: CustomerDocument!
}
Fields
CustomerDocumentCreatePayload.customerDocument ● CustomerDocument! non-null object
Returned By
customerDocumentCreate mutation
CustomerDocumentDeletePayload
No description
type CustomerDocumentDeletePayload {
deletedDocumentId: CustomerDocumentId!
}
Fields
CustomerDocumentDeletePayload.deletedDocumentId ● CustomerDocumentId! non-null scalar
Returned By
customerDocumentDelete mutation
CustomerDocumentDownloadLinksGeneratePayload
No description
type CustomerDocumentDownloadLinksGeneratePayload {
link: Url!
}
Fields
CustomerDocumentDownloadLinksGeneratePayload.link ● Url! non-null scalar
Returned By
customerDocumentDownloadLinkGenerate mutation
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
CustomerEmailUpdatePayload
No description
type CustomerEmailUpdatePayload {
customer: Customer!
}
Fields
CustomerEmailUpdatePayload.customer ● Customer! non-null object
Returned By
customerEmailUpdate mutation
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
CustomerTelegramHandleUpdatePayload
No description
type CustomerTelegramHandleUpdatePayload {
customer: Customer!
}
Fields
CustomerTelegramHandleUpdatePayload.customer ● Customer! non-null object
Returned By
customerTelegramHandleUpdate mutation
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
Dashboard
No description
type Dashboard {
activeFacilities: Int!
pendingFacilities: Int!
totalCollateral: Satoshis!
totalDisbursed: UsdCents!
}
Fields
Dashboard.activeFacilities ● Int! non-null scalar
Dashboard.pendingFacilities ● Int! non-null scalar
Dashboard.totalCollateral ● Satoshis! non-null scalar
Dashboard.totalDisbursed ● UsdCents! non-null scalar
Returned By
dashboard query
Deposit
No description
type Deposit {
account: DepositAccount!
accountId: DepositAccountId!
amount: UsdCents!
createdAt: Timestamp!
depositId: DepositId!
eventHistory(
after: String
first: Int!
): EventTimelineEntryConnection!
ledgerTransactions: [LedgerTransaction!]!
publicId: PublicId!
reference: String!
status: DepositStatus!
}
Fields
Deposit.account ● DepositAccount! non-null object
Deposit.accountId ● DepositAccountId! non-null scalar
Deposit.amount ● UsdCents! non-null scalar
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!]! non-null 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 ● DepositRecordPayloadSuccess object ● DepositRevertPayload object
Implemented By
LedgerTransactionEntity union ● PublicIdTarget union
DepositAccount
No description
type DepositAccount {
activity: DepositAccountActivity!
balance: DepositAccountBalance!
createdAt: Timestamp!
customer: Customer!
customerId: CustomerId!
depositAccountId: DepositAccountId!
deposits: [Deposit!]!
eventHistory(
after: String
first: Int!
): EventTimelineEntryConnection!
history(
after: String
first: Int!
): DepositAccountHistoryEntryConnection!
ledgerAccounts: DepositAccountLedgerAccounts!
publicId: PublicId!
status: DepositAccountStatus!
withdrawals: [Withdrawal!]!
}
Fields
DepositAccount.activity ● DepositAccountActivity! non-null enum
DepositAccount.balance ● DepositAccountBalance! non-null object
DepositAccount.createdAt ● Timestamp! non-null scalar
DepositAccount.customer ● Customer! non-null 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.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 ● Deposit object ● DepositAccountClosePayloadSuccess object ● DepositAccountConnection object ● DepositAccountCreatePayload object ● DepositAccountEdge object ● DepositAccountFreezePayloadSuccess object ● DepositAccountUnfreezePayloadSuccess object ● Withdrawal object
Implemented By
LedgerAccountEntity union ● PublicIdTarget union
DepositAccountBalance
No description
type DepositAccountBalance {
pending: UsdCents!
settled: UsdCents!
}
Fields
DepositAccountBalance.pending ● UsdCents! non-null scalar
DepositAccountBalance.settled ● UsdCents! non-null scalar
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
DepositAccountCreatePayload
No description
type DepositAccountCreatePayload {
depositAccount: DepositAccount!
}
Fields
DepositAccountCreatePayload.depositAccount ● DepositAccount! non-null object
Returned By
depositAccountCreate mutation
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
DepositAccountLedgerAccounts
No description
type DepositAccountLedgerAccounts {
depositAccount: LedgerAccount!
frozenDepositAccount: LedgerAccount!
}
Fields
DepositAccountLedgerAccounts.depositAccount ● LedgerAccount! non-null object
DepositAccountLedgerAccounts.frozenDepositAccount ● LedgerAccount! non-null object
Member Of
DepositAccount object
DepositAccountModuleConfig
No description
type DepositAccountModuleConfig {
chartOfAccountsBankDepositAccountsParentCode: AccountCode!
chartOfAccountsFinancialInstitutionDepositAccountsParentCode: AccountCode!
chartOfAccountsFrozenBankDepositAccountsParentCode: AccountCode!
chartOfAccountsFrozenFinancialInstitutionDepositAccountsParentCode: AccountCode!
chartOfAccountsFrozenGovernmentEntityDepositAccountsParentCode: AccountCode!
chartOfAccountsFrozenIndividualDepositAccountsParentCode: AccountCode!
chartOfAccountsFrozenNonDomiciledCompanyDepositAccountsParentCode: AccountCode!
chartOfAccountsFrozenPrivateCompanyDepositAccountsParentCode: AccountCode!
chartOfAccountsGovernmentEntityDepositAccountsParentCode: AccountCode!
chartOfAccountsId: ChartOfAccountsId!
chartOfAccountsIndividualDepositAccountsParentCode: AccountCode!
chartOfAccountsNonDomiciledCompanyDepositAccountsParentCode: AccountCode!
chartOfAccountsOmnibusParentCode: AccountCode!
chartOfAccountsPrivateCompanyDepositAccountsParentCode: AccountCode!
}
Fields
DepositAccountModuleConfig.chartOfAccountsBankDepositAccountsParentCode ● AccountCode! non-null scalar
DepositAccountModuleConfig.chartOfAccountsFinancialInstitutionDepositAccountsParentCode ● AccountCode! non-null scalar
DepositAccountModuleConfig.chartOfAccountsFrozenBankDepositAccountsParentCode ● AccountCode! non-null scalar
DepositAccountModuleConfig.chartOfAccountsFrozenFinancialInstitutionDepositAccountsParentCode ● AccountCode! non-null scalar
DepositAccountModuleConfig.chartOfAccountsFrozenGovernmentEntityDepositAccountsParentCode ● AccountCode! non-null scalar
DepositAccountModuleConfig.chartOfAccountsFrozenIndividualDepositAccountsParentCode ● AccountCode! non-null scalar
DepositAccountModuleConfig.chartOfAccountsFrozenNonDomiciledCompanyDepositAccountsParentCode ● AccountCode! non-null scalar
DepositAccountModuleConfig.chartOfAccountsFrozenPrivateCompanyDepositAccountsParentCode ● AccountCode! non-null scalar
DepositAccountModuleConfig.chartOfAccountsGovernmentEntityDepositAccountsParentCode ● AccountCode! non-null scalar
DepositAccountModuleConfig.chartOfAccountsId ● ChartOfAccountsId! non-null scalar
DepositAccountModuleConfig.chartOfAccountsIndividualDepositAccountsParentCode ● AccountCode! non-null scalar
DepositAccountModuleConfig.chartOfAccountsNonDomiciledCompanyDepositAccountsParentCode ● AccountCode! non-null scalar
DepositAccountModuleConfig.chartOfAccountsOmnibusParentCode ● AccountCode! non-null scalar
DepositAccountModuleConfig.chartOfAccountsPrivateCompanyDepositAccountsParentCode ● AccountCode! non-null scalar
Returned By
depositAccountConfig query
Member Of
DepositAccountModuleConfigurePayload object
DepositAccountModuleConfigurePayload
No description
type DepositAccountModuleConfigurePayload {
depositAccountConfig: DepositAccountModuleConfig!
}
Fields
DepositAccountModuleConfigurePayload.depositAccountConfig ● DepositAccountModuleConfig! non-null object
Returned By
depositAccountModuleConfigure mutation
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
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
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
DepositRecordPayloadError
No description
type DepositRecordPayloadError {
code: DepositRecordErrorCode!
}
Fields
DepositRecordPayloadError.code ● DepositRecordErrorCode! non-null enum
Implemented By
DepositRecordPayload union
DepositRecordPayloadSuccess
No description
type DepositRecordPayloadSuccess {
deposit: Deposit!
}
Fields
DepositRecordPayloadSuccess.deposit ● Deposit! non-null object
Implemented By
DepositRecordPayload union
DepositRevertPayload
No description
type DepositRevertPayload {
deposit: Deposit!
}
Fields
DepositRevertPayload.deposit ● Deposit! non-null object
Returned By
depositRevert mutation
DisbursalEntry
No description
type DisbursalEntry {
disbursal: CreditFacilityDisbursal!
recordedAt: Timestamp!
}
Fields
DisbursalEntry.disbursal ● CreditFacilityDisbursal! non-null object
DisbursalEntry.recordedAt ● Timestamp! non-null scalar
Implemented By
DepositAccountHistoryEntry union
Disbursed
No description
type Disbursed {
outstanding: UsdCents!
outstandingPayable: UsdCents!
total: UsdCents!
}
Fields
Disbursed.outstanding ● UsdCents! non-null scalar
Disbursed.outstandingPayable ● UsdCents! non-null scalar
Disbursed.total ● UsdCents! non-null scalar
Member Of
CreditFacilityBalance object
DomainConfig
No description
type DomainConfig {
configType: ConfigType!
domainConfigId: DomainConfigId!
encrypted: Boolean!
isSet: Boolean!
key: String!
value: Json!
}
Fields
DomainConfig.configType ● ConfigType! non-null enum
DomainConfig.domainConfigId ● DomainConfigId! non-null scalar
DomainConfig.encrypted ● Boolean! non-null scalar
DomainConfig.isSet ● 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 ● DomainConfigUpdatePayload 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
DomainConfigUpdatePayload
No description
type DomainConfigUpdatePayload {
domainConfig: DomainConfig!
}
Fields
DomainConfigUpdatePayload.domainConfig ● DomainConfig! non-null object
Returned By
domainConfigUpdate mutation
Duration
No description
type Duration {
period: Period!
units: Int!
}
Fields
Duration.period ● Period! non-null enum
Duration.units ● Int! non-null scalar
Member Of
TermValues object
EodProcess
No description
type EodProcess {
completedAt: Timestamp
currentPhaseName: String
day: Date!
eodProcessId: EodProcessId!
phases: [EodProcessPhase!]!
startedAt: Timestamp!
status: EodProcessStatus!
}
Fields
EodProcess.completedAt ● Timestamp scalar
EodProcess.currentPhaseName ● String scalar
EodProcess.day ● Date! 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
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
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 ● Collateral object ● Committee object ● CreditFacility object ● CreditFacilityDisbursal object ● CreditFacilityPaymentAllocation object ● CreditFacilityProposal object ● Customer object ● CustomerDocument object ● Deposit object ● DepositAccount object ● FiscalYear object ● Liquidation object ● PendingCreditFacility object ● PermissionSet object ● Policy object ● Prospect object ● Role object ● TermsTemplate 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
FiniteCvlPct
No description
type FiniteCvlPct {
value: CVLPctValue!
}
Fields
FiniteCvlPct.value ● CVLPctValue! non-null scalar
Implemented By
CvlPct union
FiscalMonthClosure
No description
type FiscalMonthClosure {
closedAsOf: Date!
closedAt: Timestamp!
}
Fields
FiscalMonthClosure.closedAsOf ● Date! non-null scalar
FiscalMonthClosure.closedAt ● Timestamp! non-null scalar
Member Of
FiscalYear object
FiscalYear
No description
type FiscalYear {
chartOfAccountsId: ChartOfAccountsId!
closedAsOf: Date
createdAt: Timestamp!
eventHistory(
after: String
first: Int!
): EventTimelineEntryConnection!
fiscalYearId: FiscalYearId!
isLastMonthOfYearClosed: Boolean!
isOpen: Boolean!
monthClosures: [FiscalMonthClosure!]!
nextMonthToClose: Date
openedAsOf: Date!
reference: String!
year: String!
}
Fields
FiscalYear.chartOfAccountsId ● ChartOfAccountsId! non-null scalar
FiscalYear.closedAsOf ● Date scalar
FiscalYear.createdAt ● Timestamp! non-null scalar
FiscalYear.eventHistory ● EventTimelineEntryConnection! non-null object
FiscalYear.eventHistory.after ● String scalar
FiscalYear.eventHistory.first ● Int! non-null scalar
FiscalYear.fiscalYearId ● FiscalYearId! non-null scalar
FiscalYear.isLastMonthOfYearClosed ● Boolean! non-null scalar
FiscalYear.isOpen ● Boolean! non-null scalar
FiscalYear.monthClosures ● [FiscalMonthClosure!]! non-null object
FiscalYear.nextMonthToClose ● Date scalar
FiscalYear.openedAsOf ● Date! non-null scalar
FiscalYear.reference ● String! non-null scalar
FiscalYear.year ● String! non-null scalar
Returned By
fiscalYear query ● fiscalYearByYear query
Member Of
FiscalYearCloseMonthPayloadSuccess object ● FiscalYearClosePayloadSuccess object ● FiscalYearConnection object ● FiscalYearEdge object ● FiscalYearInitPayloadSuccess object ● FiscalYearOpenNextPayloadSuccess object
FiscalYearCloseMonthPayloadError
No description
type FiscalYearCloseMonthPayloadError {
code: FiscalYearCloseMonthErrorCode!
}
Fields
FiscalYearCloseMonthPayloadError.code ● FiscalYearCloseMonthErrorCode! non-null enum
Implemented By
FiscalYearCloseMonthPayload union
FiscalYearCloseMonthPayloadSuccess
No description
type FiscalYearCloseMonthPayloadSuccess {
fiscalYear: FiscalYear!
}
Fields
FiscalYearCloseMonthPayloadSuccess.fiscalYear ● FiscalYear! 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 {
fiscalYear: FiscalYear!
}
Fields
FiscalYearClosePayloadSuccess.fiscalYear ● FiscalYear! 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 {
fiscalYear: FiscalYear!
}
Fields
FiscalYearInitPayloadSuccess.fiscalYear ● FiscalYear! non-null object
Implemented By
FiscalYearInitPayload union
FiscalYearOpenNextPayloadError
No description
type FiscalYearOpenNextPayloadError {
code: FiscalYearOpenNextErrorCode!
}
Fields
FiscalYearOpenNextPayloadError.code ● FiscalYearOpenNextErrorCode! non-null enum
Implemented By
FiscalYearOpenNextPayload union
FiscalYearOpenNextPayloadSuccess
No description
type FiscalYearOpenNextPayloadSuccess {
fiscalYear: FiscalYear!
}
Fields
FiscalYearOpenNextPayloadSuccess.fiscalYear ● FiscalYear! non-null object
Implemented By
FiscalYearOpenNextPayload union
FreezeEntry
No description
type FreezeEntry {
amount: UsdCents!
ledgerTransactionId: LedgerTransactionId!
recordedAt: Timestamp!
}
Fields
FreezeEntry.amount ● UsdCents! non-null scalar
FreezeEntry.ledgerTransactionId ● LedgerTransactionId! non-null scalar
FreezeEntry.recordedAt ● Timestamp! non-null scalar
Implemented By
DepositAccountHistoryEntry 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
InfiniteCvlPct
No description
type InfiniteCvlPct {
isInfinite: Boolean!
}
Fields
InfiniteCvlPct.isInfinite ● Boolean! non-null scalar
Implemented By
CvlPct union
Interest
No description
type Interest {
outstanding: UsdCents!
outstandingPayable: UsdCents!
total: UsdCents!
}
Fields
Interest.outstanding ● UsdCents! non-null scalar
Interest.outstandingPayable ● UsdCents! non-null scalar
Interest.total ● UsdCents! non-null scalar
Member Of
CreditFacilityBalance object
LedgerAccount
No description
type LedgerAccount {
ancestors: [LedgerAccount!]!
balanceRange: 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!]! non-null object
LedgerAccount.balanceRange ● LedgerAccountBalanceRange! non-null union
LedgerAccount.children ● [LedgerAccount!]! non-null 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
LedgerAccountBalanceByCurrency
No description
type LedgerAccountBalanceByCurrency {
btc: BtcLedgerAccountBalance!
usd: UsdLedgerAccountBalance!
}
Fields
LedgerAccountBalanceByCurrency.btc ● BtcLedgerAccountBalance! non-null object
LedgerAccountBalanceByCurrency.usd ● UsdLedgerAccountBalance! non-null object
Member Of
BalanceSheet object ● BalanceSheetAccount object
LedgerAccountBalanceRangeByCurrency
No description
type LedgerAccountBalanceRangeByCurrency {
btc: BtcLedgerAccountBalanceRange!
usd: UsdLedgerAccountBalanceRange!
}
Fields
LedgerAccountBalanceRangeByCurrency.btc ● BtcLedgerAccountBalanceRange! non-null object
LedgerAccountBalanceRangeByCurrency.usd ● UsdLedgerAccountBalanceRange! non-null object
Member Of
ProfitAndLossAccount object ● ProfitAndLossStatement object ● TrialBalance object
LedgerAccountCsvCreatePayload
No description
type LedgerAccountCsvCreatePayload {
ledgerAccountCsvDocument: LedgerAccountCsvDocument!
}
Fields
LedgerAccountCsvCreatePayload.ledgerAccountCsvDocument ● LedgerAccountCsvDocument! non-null object
Returned By
ledgerAccountCsvCreate mutation
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
LedgerAccountCsvCreatePayload object
LedgerAccountCsvDownloadLinkGeneratePayload
No description
type LedgerAccountCsvDownloadLinkGeneratePayload {
url: Url!
}
Fields
LedgerAccountCsvDownloadLinkGeneratePayload.url ● Url! non-null scalar
Returned By
ledgerAccountCsvDownloadLinkGenerate mutation
LedgerAccountCsvExportUploadedPayload
No description
type LedgerAccountCsvExportUploadedPayload {
documentId: LedgerAccountCsvDocumentId!
}
Fields
LedgerAccountCsvExportUploadedPayload.documentId ● LedgerAccountCsvDocumentId! non-null scalar
Returned By
ledgerAccountCsvExportUploaded subscription
LedgerEntry
No description
type LedgerEntry {
amount: LedgerEntryAmount!
createdAt: Timestamp!
description: String
direction: DebitOrCredit!
entryType: String!
layer: Layer!
ledgerAccount: LedgerAccount!
ledgerEntryId: LedgerEntryId!
ledgerTransaction: LedgerTransaction!
}
Fields
LedgerEntry.amount ● LedgerEntryAmount! non-null union
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! non-null object
LedgerEntry.ledgerEntryId ● LedgerEntryId! non-null scalar
LedgerEntry.ledgerTransaction ● LedgerTransaction! non-null 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
LedgerManualTransactionExecutePayloadError
No description
type LedgerManualTransactionExecutePayloadError {
code: LedgerManualTransactionExecuteErrorCode!
}
Fields
LedgerManualTransactionExecutePayloadError.code ● LedgerManualTransactionExecuteErrorCode! non-null enum
Implemented By
LedgerManualTransactionExecutePayload union
LedgerManualTransactionExecutePayloadSuccess
No description
type LedgerManualTransactionExecutePayloadSuccess {
transaction: LedgerTransaction!
}
Fields
LedgerManualTransactionExecutePayloadSuccess.transaction ● LedgerTransaction! non-null object
Implemented By
LedgerManualTransactionExecutePayload union
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! non-null union
LedgerTransaction.ledgerTransactionId ● LedgerTransactionId! non-null scalar
Returned By
ledgerTransaction query
Member Of
CreditFacilityDisbursal object ● Deposit object ● LedgerEntry object ● LedgerManualTransactionExecutePayloadSuccess object ● LedgerTransactionConnection object ● LedgerTransactionEdge 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
Liquidation
No description
type Liquidation {
amountReceived: UsdCents!
collateral: Collateral!
collateralId: CollateralId!
completed: Boolean!
createdAt: Timestamp!
eventHistory(
after: String
first: Int!
): EventTimelineEntryConnection!
expectedToReceive: UsdCents!
initiallyEstimatedToLiquidate: Satoshis!
liquidationId: LiquidationId!
receivedProceeds: [LiquidationProceedsReceived!]!
sentCollateral: [LiquidationCollateralSent!]!
sentTotal: Satoshis!
}
Fields
Liquidation.amountReceived ● UsdCents! non-null scalar
Liquidation.collateral ● Collateral! non-null object
Liquidation.collateralId ● CollateralId! non-null scalar
Liquidation.completed ● Boolean! 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 ● UsdCents! non-null scalar
Liquidation.initiallyEstimatedToLiquidate ● Satoshis! non-null scalar
Liquidation.liquidationId ● LiquidationId! non-null scalar
Liquidation.receivedProceeds ● [LiquidationProceedsReceived!]! non-null object
Liquidation.sentCollateral ● [LiquidationCollateralSent!]! non-null object
Liquidation.sentTotal ● Satoshis! non-null scalar
Returned By
liquidation query
Member Of
CreditFacility object ● LiquidationConnection object ● LiquidationEdge object
LiquidationCollateralSent
No description
type LiquidationCollateralSent {
amount: Satoshis!
ledgerTransactionId: LedgerTransactionId!
}
Fields
LiquidationCollateralSent.amount ● Satoshis! non-null scalar
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 {
effectiveLiquidationPrice: UsdCents!
liquidationPremiumPct: Decimal!
price: UsdCents!
targetCvl: CvlPct!
toLiquidate: Satoshis!
toReceive: UsdCents!
}
Fields
LiquidationPayment.effectiveLiquidationPrice ● UsdCents! non-null scalar
LiquidationPayment.liquidationPremiumPct ● Decimal! non-null scalar
LiquidationPayment.price ● UsdCents! non-null scalar
LiquidationPayment.targetCvl ● CvlPct! non-null union
LiquidationPayment.toLiquidate ● Satoshis! non-null scalar
LiquidationPayment.toReceive ● UsdCents! non-null scalar
Returned By
liquidationPaymentCalculate query
LiquidationProceedsReceived
No description
type LiquidationProceedsReceived {
amount: UsdCents!
ledgerTransactionId: LedgerTransactionId!
}
Fields
LiquidationProceedsReceived.amount ● UsdCents! non-null scalar
LiquidationProceedsReceived.ledgerTransactionId ● LedgerTransactionId! non-null scalar
Member Of
Liquidation object
Me
No description
type Me {
user: User!
userCanCreateCustodian: Boolean!
userCanCreateProspect: Boolean!
userCanCreateTermsTemplate: Boolean!
userCanCreateUser: Boolean!
visibleNavigationItems: VisibleNavigationItems!
}
Fields
Me.user ● User! non-null object
Me.userCanCreateCustodian ● Boolean! non-null scalar
Me.userCanCreateProspect ● Boolean! non-null scalar
Me.userCanCreateTermsTemplate ● Boolean! non-null scalar
Me.userCanCreateUser ● Boolean! non-null scalar
Me.visibleNavigationItems ● VisibleNavigationItems! non-null object
Returned By
me query
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 ● CommitteeConnection object ● CreditFacilityConnection object ● CreditFacilityDisbursalConnection object ● CreditFacilityProposalConnection object ● CustodianConnection object ● CustomerConnection object ● DepositAccountConnection object ● DepositAccountHistoryEntryConnection object ● DepositConnection object ● DomainConfigConnection object ● EodProcessConnection object ● EventTimelineEntryConnection object ● FiscalYearConnection object ● LedgerEntryConnection object ● LedgerTransactionConnection object ● LiquidationConnection object ● PendingCreditFacilityConnection object ● PermissionSetConnection object ● PolicyConnection object ● PriceProviderConnection object ● ProspectConnection object ● ReportRunConnection object ● RoleConnection object ● TermsTemplateConnection object ● TransactionTemplateConnection object ● UserConnection object ● WithdrawalConnection 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
PendingCreditFacility
No description
type PendingCreditFacility {
approvalProcess: ApprovalProcess!
approvalProcessId: ApprovalProcessId!
collateral: Satoshis!
collateralId: CollateralId!
collateralizationState: PendingCreditFacilityCollateralizationState!
createdAt: Timestamp!
creditFacilityId: CreditFacilityId!
creditFacilityTerms: TermValues!
customer: Customer!
eventHistory(
after: String
first: Int!
): EventTimelineEntryConnection!
facilityAmount: UsdCents!
pendingCreditFacilityId: PendingCreditFacilityId!
repaymentPlan: [CreditFacilityRepaymentPlanEntry!]!
status: PendingCreditFacilityStatus!
wallet: Wallet
}
Fields
PendingCreditFacility.approvalProcess ● ApprovalProcess! non-null object
PendingCreditFacility.approvalProcessId ● ApprovalProcessId! non-null scalar
PendingCreditFacility.collateral ● Satoshis! non-null scalar
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.customer ● Customer! non-null object
PendingCreditFacility.eventHistory ● EventTimelineEntryConnection! non-null object
PendingCreditFacility.eventHistory.after ● String scalar
PendingCreditFacility.eventHistory.first ● Int! non-null scalar
PendingCreditFacility.facilityAmount ● UsdCents! non-null scalar
PendingCreditFacility.pendingCreditFacilityId ● PendingCreditFacilityId! 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: Satoshis!
effective: Date!
price: UsdCents!
recordedAt: Timestamp!
state: PendingCreditFacilityCollateralizationState!
}
Fields
PendingCreditFacilityCollateralizationUpdated.collateral ● Satoshis! non-null scalar
PendingCreditFacilityCollateralizationUpdated.effective ● Date! non-null scalar
PendingCreditFacilityCollateralizationUpdated.price ● UsdCents! non-null scalar
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: String
companyName: String
dateOfBirth: String
firstName: String!
lastName: String!
nationality: String
}
Fields
PersonalInfo.address ● String scalar
PersonalInfo.companyName ● String scalar
PersonalInfo.dateOfBirth ● String scalar
PersonalInfo.firstName ● String! non-null scalar
PersonalInfo.lastName ● String! non-null scalar
PersonalInfo.nationality ● String scalar
Member Of
Customer object ● Prospect object
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 ● PolicyCommitteeAssignPayload object ● PolicyConnection object ● PolicyEdge object
PolicyCommitteeAssignPayload
No description
type PolicyCommitteeAssignPayload {
policy: Policy!
}
Fields
PolicyCommitteeAssignPayload.policy ● Policy! non-null object
Returned By
policyCommitteeAssign mutation
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
PriceProvider
No description
type PriceProvider {
active: Boolean!
createdAt: Timestamp!
latestPrice: UsdCents
name: String!
priceProviderId: PriceProviderId!
provider: String!
}
Fields
PriceProvider.active ● Boolean! non-null scalar
PriceProvider.createdAt ● Timestamp! non-null scalar
PriceProvider.latestPrice ● UsdCents scalar
PriceProvider.name ● String! non-null scalar
PriceProvider.priceProviderId ● PriceProviderId! non-null scalar
PriceProvider.provider ● String! non-null scalar
Returned By
priceProvider query
Member Of
PriceProviderActivatePayload object ● PriceProviderConnection object ● PriceProviderDeactivatePayload object ● PriceProviderEdge object ● PriceProviderManualPriceUpdatePayload object
PriceProviderActivatePayload
No description
type PriceProviderActivatePayload {
priceProvider: PriceProvider!
}
Fields
PriceProviderActivatePayload.priceProvider ● PriceProvider! non-null object
Returned By
priceProviderActivate mutation
PriceProviderConnection
No description
type PriceProviderConnection {
edges: [PriceProviderEdge!]!
nodes: [PriceProvider!]!
pageInfo: PageInfo!
}
Fields
PriceProviderConnection.edges ● [PriceProviderEdge!]! non-null object
A list of edges.
PriceProviderConnection.nodes ● [PriceProvider!]! non-null object
A list of nodes.
PriceProviderConnection.pageInfo ● PageInfo! non-null object
Information to aid in pagination.
Returned By
priceProviders query
PriceProviderDeactivatePayload
No description
type PriceProviderDeactivatePayload {
priceProvider: PriceProvider!
}
Fields
PriceProviderDeactivatePayload.priceProvider ● PriceProvider! non-null object
Returned By
priceProviderDeactivate mutation
PriceProviderEdge
An edge in a connection.
type PriceProviderEdge {
cursor: String!
node: PriceProvider!
}
Fields
PriceProviderEdge.cursor ● String! non-null scalar
A cursor for use in pagination
PriceProviderEdge.node ● PriceProvider! non-null object
The item at the end of the edge
Member Of
PriceProviderConnection object
PriceProviderManualPriceUpdatePayload
No description
type PriceProviderManualPriceUpdatePayload {
priceProvider: PriceProvider!
}
Fields
PriceProviderManualPriceUpdatePayload.priceProvider ● PriceProvider! non-null object
Returned By
priceProviderManualPriceUpdate mutation
ProfitAndLossAccount
No description
type ProfitAndLossAccount {
balanceRange: LedgerAccountBalanceRangeByCurrency!
children: [ProfitAndLossAccount!]!
code: AccountCode
ledgerAccountId: LedgerAccountId!
name: String!
}
Fields
ProfitAndLossAccount.balanceRange ● LedgerAccountBalanceRangeByCurrency! non-null object
ProfitAndLossAccount.children ● [ProfitAndLossAccount!]! non-null object
ProfitAndLossAccount.code ● AccountCode scalar
ProfitAndLossAccount.ledgerAccountId ● LedgerAccountId! non-null scalar
ProfitAndLossAccount.name ● String! non-null scalar
Member Of
ProfitAndLossAccount object ● ProfitAndLossStatement object
ProfitAndLossStatement
No description
type ProfitAndLossStatement {
categories: [ProfitAndLossAccount!]!
name: String!
total: LedgerAccountBalanceRangeByCurrency!
}
Fields
ProfitAndLossStatement.categories ● [ProfitAndLossAccount!]! non-null object
ProfitAndLossStatement.name ● String! non-null scalar
ProfitAndLossStatement.total ● LedgerAccountBalanceRangeByCurrency! non-null object
Returned By
profitAndLossStatement query
Prospect
No description
type Prospect {
applicantId: String
createdAt: Timestamp!
customer: Customer
customerType: CustomerType!
email: String!
eventHistory(
after: String
first: Int!
): EventTimelineEntryConnection!
kycStatus: KycStatus!
level: KycLevel!
personalInfo: PersonalInfo
prospectId: ProspectId!
publicId: PublicId!
stage: ProspectStage!
telegramHandle: String!
verificationLink: String
verificationLinkCreatedAt: Timestamp
}
Fields
Prospect.applicantId ● String scalar
Prospect.createdAt ● Timestamp! non-null scalar
Prospect.customer ● Customer object
Prospect.customerType ● CustomerType! non-null enum
Prospect.email ● String! non-null scalar
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.personalInfo ● PersonalInfo object
Prospect.prospectId ● ProspectId! non-null scalar
Prospect.publicId ● PublicId! non-null scalar
Prospect.stage ● ProspectStage! non-null enum
Prospect.telegramHandle ● String! non-null scalar
Prospect.verificationLink ● String scalar
Prospect.verificationLinkCreatedAt ● Timestamp scalar
Returned By
prospect query ● prospectByPublicId query ● prospectUpdated subscription
Member Of
ProspectClosePayloadSuccess object ● ProspectConnection object ● ProspectCreatePayload object ● ProspectEdge object
Implemented By
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
ProspectConvertPayloadError
No description
type ProspectConvertPayloadError {
code: ProspectConvertErrorCode!
}
Fields
ProspectConvertPayloadError.code ● ProspectConvertErrorCode! non-null enum
Implemented By
ProspectConvertPayload union
ProspectConvertPayloadSuccess
No description
type ProspectConvertPayloadSuccess {
customer: Customer!
}
Fields
ProspectConvertPayloadSuccess.customer ● Customer! non-null object
Implemented By
ProspectConvertPayload union
ProspectCreatePayload
No description
type ProspectCreatePayload {
prospect: Prospect!
}
Fields
ProspectCreatePayload.prospect ● Prospect! non-null object
Returned By
prospectCreate mutation
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
ProspectKycLinkCreatePayload
No description
type ProspectKycLinkCreatePayload {
url: Url!
}
Fields
ProspectKycLinkCreatePayload.url ● Url! non-null scalar
Returned By
prospectKycLinkCreate mutation
RealtimePrice
No description
type RealtimePrice {
usdCentsPerBtc: UsdCents!
}
Fields
RealtimePrice.usdCentsPerBtc ● UsdCents! non-null scalar
Returned By
realtimePrice query ● realtimePriceUpdated subscription
Report
No description
type Report {
createdAt: Timestamp!
externalId: String!
files: [ReportFile!]!
name: String!
norm: String!
reportId: ReportId!
reportRun: ReportRun!
runId: ReportRunId!
}
Fields
Report.createdAt ● Timestamp! non-null scalar
Report.externalId ● String! non-null scalar
Report.files ● [ReportFile!]! non-null object
Report.name ● String! non-null scalar
Report.norm ● String! non-null scalar
Report.reportId ● ReportId! non-null scalar
Report.reportRun ● ReportRun! non-null object
Report.runId ● ReportRunId! non-null scalar
Member Of
ReportRun object
ReportDefinition
No description
type ReportDefinition {
friendlyName: String!
norm: String!
outputs: [ReportDefinitionOutput!]!
reportDefinitionId: ReportDefinitionId!
sourceTable: String!
supportsAsOf: Boolean!
}
Fields
ReportDefinition.friendlyName ● String! non-null 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
ReportDefinition.supportsAsOf ● Boolean! 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
ReportFile
No description
type ReportFile {
extension: String!
}
Fields
ReportFile.extension ● String! non-null scalar
Member Of
Report object
ReportFileDownloadLinkGeneratePayload
No description
type ReportFileDownloadLinkGeneratePayload {
url: Url!
}
Fields
ReportFileDownloadLinkGeneratePayload.url ● Url! non-null scalar
Returned By
reportFileDownloadLinkGenerate mutation
ReportRun
No description
type ReportRun {
reportRunId: ReportRunId!
reports: [Report!]!
requestedAsOfDate: Date
requestedReport: RequestedReport
runType: ReportRunType!
startTime: Timestamp
state: ReportRunState!
}
Fields
ReportRun.reportRunId ● ReportRunId! non-null scalar
ReportRun.reports ● [Report!]! non-null object
ReportRun.requestedAsOfDate ● Date scalar
ReportRun.requestedReport ● RequestedReport object
ReportRun.runType ● ReportRunType! non-null enum
ReportRun.startTime ● Timestamp scalar
ReportRun.state ● ReportRunState! non-null enum
Returned By
reportRun query
Member Of
Report object ● ReportRunConnection object ● ReportRunEdge object ● ReportRunTriggerPayload object ● ReportRunUpdatedPayload object
ReportRunConnection
No description
type ReportRunConnection {
edges: [ReportRunEdge!]!
nodes: [ReportRun!]!
pageInfo: PageInfo!
}
Fields
ReportRunConnection.edges ● [ReportRunEdge!]! non-null object
A list of edges.
ReportRunConnection.nodes ● [ReportRun!]! non-null object
A list of nodes.
ReportRunConnection.pageInfo ● PageInfo! non-null object
Information to aid in pagination.
Returned By
reportRuns query
ReportRunEdge
An edge in a connection.
type ReportRunEdge {
cursor: String!
node: ReportRun!
}
Fields
ReportRunEdge.cursor ● String! non-null scalar
A cursor for use in pagination
ReportRunEdge.node ● ReportRun! non-null object
The item at the end of the edge
Member Of
ReportRunConnection object
ReportRunTriggerPayload
No description
type ReportRunTriggerPayload {
reportRun: ReportRun!
}
Fields
ReportRunTriggerPayload.reportRun ● ReportRun! non-null object
Returned By
reportRunTrigger mutation
ReportRunUpdatedPayload
No description
type ReportRunUpdatedPayload {
reportRun: ReportRun!
}
Fields
ReportRunUpdatedPayload.reportRun ● ReportRun! non-null object
Returned By
reportRunUpdated subscription
RequestedReport
No description
type RequestedReport {
name: String!
norm: String!
reportDefinitionId: ReportDefinitionId!
}
Fields
RequestedReport.name ● String! non-null scalar
RequestedReport.norm ● String! non-null scalar
RequestedReport.reportDefinitionId ● ReportDefinitionId! non-null scalar
Member Of
ReportRun object
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!]! non-null object
Role.roleId ● RoleId! non-null scalar
Returned By
role query
Member Of
RoleConnection object ● RoleCreatePayload 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
RoleCreatePayload
No description
type RoleCreatePayload {
role: Role!
}
Fields
RoleCreatePayload.role ● Role! non-null object
Returned By
roleCreate mutation
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
System
No description
type System {
actor: String!
}
Fields
System.actor ● String! non-null scalar
Implemented By
AuditSubject union
TermsTemplate
No description
type TermsTemplate {
createdAt: Timestamp!
eventHistory(
after: String
first: Int!
): EventTimelineEntryConnection!
name: String!
termsTemplateId: TermsTemplateId!
userCanUpdateTermsTemplate: Boolean!
values: TermValues!
}
Fields
TermsTemplate.createdAt ● Timestamp! non-null scalar
TermsTemplate.eventHistory ● EventTimelineEntryConnection! non-null object
TermsTemplate.eventHistory.after ● String scalar
TermsTemplate.eventHistory.first ● Int! non-null scalar
TermsTemplate.name ● String! non-null scalar
TermsTemplate.termsTemplateId ● TermsTemplateId! non-null scalar
TermsTemplate.userCanUpdateTermsTemplate ● Boolean! non-null scalar
TermsTemplate.values ● TermValues! non-null object
Returned By
termsTemplate query
Member Of
TermsTemplateConnection object ● TermsTemplateCreatePayloadSuccess object ● TermsTemplateEdge object ● TermsTemplateUpdatePayload object
TermsTemplateConnection
No description
type TermsTemplateConnection {
edges: [TermsTemplateEdge!]!
nodes: [TermsTemplate!]!
pageInfo: PageInfo!
}
Fields
TermsTemplateConnection.edges ● [TermsTemplateEdge!]! non-null object
A list of edges.
TermsTemplateConnection.nodes ● [TermsTemplate!]! non-null object
A list of nodes.
TermsTemplateConnection.pageInfo ● PageInfo! non-null object
Information to aid in pagination.
Returned By
termsTemplates query
TermsTemplateCreatePayloadError
No description
type TermsTemplateCreatePayloadError {
code: TermsTemplateCreateErrorCode!
}
Fields
TermsTemplateCreatePayloadError.code ● TermsTemplateCreateErrorCode! non-null enum
Implemented By
TermsTemplateCreatePayload union
TermsTemplateCreatePayloadSuccess
No description
type TermsTemplateCreatePayloadSuccess {
termsTemplate: TermsTemplate!
}
Fields
TermsTemplateCreatePayloadSuccess.termsTemplate ● TermsTemplate! non-null object
Implemented By
TermsTemplateCreatePayload union
TermsTemplateEdge
An edge in a connection.
type TermsTemplateEdge {
cursor: String!
node: TermsTemplate!
}
Fields
TermsTemplateEdge.cursor ● String! non-null scalar
A cursor for use in pagination
TermsTemplateEdge.node ● TermsTemplate! non-null object
The item at the end of the edge
Member Of
TermsTemplateConnection object
TermsTemplateUpdatePayload
No description
type TermsTemplateUpdatePayload {
termsTemplate: TermsTemplate!
}
Fields
TermsTemplateUpdatePayload.termsTemplate ● TermsTemplate! non-null object
Returned By
termsTemplateUpdate mutation
TermValues
No description
type TermValues {
accrualCycleInterval: InterestInterval!
accrualInterval: InterestInterval!
annualRate: AnnualRatePct!
disbursalPolicy: DisbursalPolicy!
duration: Duration!
effectiveAnnualRate: AnnualRatePct!
initialCvl: CvlPct!
liquidationCvl: CvlPct!
marginCallCvl: CvlPct!
oneTimeFeeRate: OneTimeFeeRatePct!
}
Fields
TermValues.accrualCycleInterval ● InterestInterval! non-null enum
TermValues.accrualInterval ● InterestInterval! non-null enum
TermValues.annualRate ● AnnualRatePct! non-null scalar
TermValues.disbursalPolicy ● DisbursalPolicy! non-null enum
TermValues.duration ● Duration! non-null object
TermValues.effectiveAnnualRate ● AnnualRatePct! non-null scalar
TermValues.initialCvl ● CvlPct! non-null union
TermValues.liquidationCvl ● CvlPct! non-null union
TermValues.marginCallCvl ● CvlPct! non-null union
TermValues.oneTimeFeeRate ● OneTimeFeeRatePct! non-null scalar
Member Of
CreditFacility object ● CreditFacilityProposal object ● PendingCreditFacility object ● TermsTemplate object
Time
No description
type Time {
canAdvanceToNextEndOfDay: Boolean!
currentDate: Date!
currentTime: Timestamp!
endOfDayTime: String!
eodStatus: EodProcessStatus
nextEndOfDayAt: Timestamp!
timezone: String!
}
Fields
Time.canAdvanceToNextEndOfDay ● Boolean! non-null scalar
Whether the environment clock can be advanced manually.
Time.currentDate ● Date! non-null scalar
Current business date for the environment clock.
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.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
TimeAdvanceToNextEndOfDayPayload object
TimeAdvanceToNextEndOfDayPayload
No description
type TimeAdvanceToNextEndOfDayPayload {
time: Time!
}
Fields
TimeAdvanceToNextEndOfDayPayload.time ● Time! non-null object
Returned By
timeAdvanceToNextEndOfDay mutation
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: [LedgerAccount!]!
name: String!
total: LedgerAccountBalanceRangeByCurrency!
}
Fields
TrialBalance.accounts ● [LedgerAccount!]! non-null object
TrialBalance.name ● String! non-null scalar
TrialBalance.total ● LedgerAccountBalanceRangeByCurrency! non-null object
Returned By
trialBalance query
UnfreezeEntry
No description
type UnfreezeEntry {
amount: UsdCents!
ledgerTransactionId: LedgerTransactionId!
recordedAt: Timestamp!
}
Fields
UnfreezeEntry.amount ● UsdCents! non-null scalar
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
UsdAmount
No description
type UsdAmount {
usd: UsdCents!
}
Fields
UsdAmount.usd ● UsdCents! non-null scalar
Implemented By
LedgerEntryAmount union
UsdBalanceDetails
No description
type UsdBalanceDetails {
credit: UsdCents!
debit: UsdCents!
net: SignedUsdCents!
}
Fields
UsdBalanceDetails.credit ● UsdCents! non-null scalar
UsdBalanceDetails.debit ● UsdCents! non-null scalar
UsdBalanceDetails.net ● SignedUsdCents! non-null scalar
Member Of
UsdLedgerAccountBalance object
UsdLedgerAccountBalance
No description
type UsdLedgerAccountBalance {
encumbrance: UsdBalanceDetails!
pending: UsdBalanceDetails!
settled: UsdBalanceDetails!
}
Fields
UsdLedgerAccountBalance.encumbrance ● UsdBalanceDetails! non-null object
UsdLedgerAccountBalance.pending ● UsdBalanceDetails! non-null object
UsdLedgerAccountBalance.settled ● UsdBalanceDetails! non-null object
Member Of
LedgerAccountBalanceByCurrency object ● UsdLedgerAccountBalanceRange object
UsdLedgerAccountBalanceRange
No description
type UsdLedgerAccountBalanceRange {
close: UsdLedgerAccountBalance!
open: UsdLedgerAccountBalance!
periodActivity: UsdLedgerAccountBalance!
}
Fields
UsdLedgerAccountBalanceRange.close ● UsdLedgerAccountBalance! non-null object
UsdLedgerAccountBalanceRange.open ● UsdLedgerAccountBalance! non-null object
UsdLedgerAccountBalanceRange.periodActivity ● UsdLedgerAccountBalance! non-null object
Member Of
LedgerAccountBalanceRangeByCurrency object
Implemented By
LedgerAccountBalanceRange 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! non-null 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 ● UserCreatePayload object ● UserEdge object ● UserRoleUpdatePayload 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
UserCreatePayload
No description
type UserCreatePayload {
user: User!
}
Fields
UserCreatePayload.user ● User! non-null object
Returned By
userCreate mutation
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
UserRoleUpdatePayload
No description
type UserRoleUpdatePayload {
user: User!
}
Fields
UserRoleUpdatePayload.user ● User! non-null object
Returned By
userRoleUpdate mutation
VisibleNavigationItems
No description
type VisibleNavigationItems {
audit: Boolean!
creditFacilities: Boolean!
customer: Boolean!
deposit: Boolean!
eodProcesses: Boolean!
financials: Boolean!
governance: GovernanceNavigationItems!
term: 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.term ● 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!
walletId: WalletId!
}
Fields
Wallet.address ● String! non-null scalar
Wallet.custodian ● Custodian! non-null object
Wallet.network ● WalletNetwork! 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: UsdCents!
approvalProcess: ApprovalProcess!
approvalProcessId: ApprovalProcessId!
createdAt: Timestamp!
eventHistory(
after: String
first: Int!
): EventTimelineEntryConnection!
ledgerTransactions: [LedgerTransaction!]!
publicId: PublicId!
reference: String!
status: WithdrawalStatus!
withdrawalId: WithdrawalId!
}
Fields
Withdrawal.account ● DepositAccount! non-null object
Withdrawal.accountId ● DepositAccountId! non-null scalar
Withdrawal.amount ● UsdCents! non-null scalar
Withdrawal.approvalProcess ● ApprovalProcess! non-null 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!]! non-null 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 ● WithdrawalCancelPayloadSuccess object ● WithdrawalConfirmPayloadSuccess object ● WithdrawalConnection object ● WithdrawalEdge object ● WithdrawalEntry object ● WithdrawalInitiatePayloadSuccess object ● WithdrawalRevertPayloadSuccess object
Implemented By
ApprovalProcessTarget union ● LedgerTransactionEntity union ● PublicIdTarget union
WithdrawalCancelPayloadError
No description
type WithdrawalCancelPayloadError {
code: WithdrawalCancelErrorCode!
}
Fields
WithdrawalCancelPayloadError.code ● WithdrawalCancelErrorCode! non-null enum
Implemented By
WithdrawalCancelPayload union
WithdrawalCancelPayloadSuccess
No description
type WithdrawalCancelPayloadSuccess {
withdrawal: Withdrawal!
}
Fields
WithdrawalCancelPayloadSuccess.withdrawal ● Withdrawal! non-null object
Implemented By
WithdrawalCancelPayload union
WithdrawalConfirmPayloadError
No description
type WithdrawalConfirmPayloadError {
code: WithdrawalConfirmErrorCode!
}
Fields
WithdrawalConfirmPayloadError.code ● WithdrawalConfirmErrorCode! non-null enum
Implemented By
WithdrawalConfirmPayload union
WithdrawalConfirmPayloadSuccess
No description
type WithdrawalConfirmPayloadSuccess {
withdrawal: Withdrawal!
}
Fields
WithdrawalConfirmPayloadSuccess.withdrawal ● Withdrawal! non-null object
Implemented By
WithdrawalConfirmPayload 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
WithdrawalRevertPayloadError
No description
type WithdrawalRevertPayloadError {
code: WithdrawalRevertErrorCode!
}
Fields
WithdrawalRevertPayloadError.code ● WithdrawalRevertErrorCode! non-null enum
Implemented By
WithdrawalRevertPayload union
WithdrawalRevertPayloadSuccess
No description
type WithdrawalRevertPayloadSuccess {
withdrawal: Withdrawal!
}
Fields
WithdrawalRevertPayloadSuccess.withdrawal ● Withdrawal! non-null object
Implemented By
WithdrawalRevertPayload 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
ApprovalProcessApproveErrorCode
No description
enum ApprovalProcessApproveErrorCode {
SUBJECT_IS_NOT_COMMITTEE_MEMBER
}
Values
ApprovalProcessApproveErrorCode.SUBJECT_IS_NOT_COMMITTEE_MEMBER
Member Of
ApprovalProcessApprovePayloadError object
ApprovalProcessDenyErrorCode
No description
enum ApprovalProcessDenyErrorCode {
SUBJECT_IS_NOT_COMMITTEE_MEMBER
}
Values
ApprovalProcessDenyErrorCode.SUBJECT_IS_NOT_COMMITTEE_MEMBER
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
ChartOfAccountsAddChildNodeErrorCode
No description
enum ChartOfAccountsAddChildNodeErrorCode {
PARENT_ACCOUNT_NOT_FOUND
}
Values
ChartOfAccountsAddChildNodeErrorCode.PARENT_ACCOUNT_NOT_FOUND
Member Of
ChartOfAccountsAddChildNodePayloadError object
CollateralDirection
No description
enum CollateralDirection {
ADD
REMOVE
}
Values
CollateralDirection.ADD
CollateralDirection.REMOVE
Member Of
CreditFacilityCollateralUpdated 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
CollateralRecordProceedsFromLiquidationErrorCode
No description
enum CollateralRecordProceedsFromLiquidationErrorCode {
NO_ACTIVE_LIQUIDATION
}
Values
CollateralRecordProceedsFromLiquidationErrorCode.NO_ACTIVE_LIQUIDATION
Member Of
CollateralRecordProceedsFromLiquidationPayloadError object
CollateralRecordSentToLiquidationErrorCode
No description
enum CollateralRecordSentToLiquidationErrorCode {
NO_ACTIVE_LIQUIDATION
}
Values
CollateralRecordSentToLiquidationErrorCode.NO_ACTIVE_LIQUIDATION
Member Of
CollateralRecordSentToLiquidationPayloadError object
CollateralUpdateErrorCode
No description
enum CollateralUpdateErrorCode {
MANUAL_UPDATE_ERROR
}
Values
CollateralUpdateErrorCode.MANUAL_UPDATE_ERROR
Member Of
CollateralUpdatePayloadError object
CommitteeSortBy
No description
enum CommitteeSortBy {
CREATED_AT
NAME
}
Values
CommitteeSortBy.CREATED_AT
CommitteeSortBy.NAME
Member Of
CommitteeSort input
ConfigType
No description
enum ConfigType {
BOOL
COMPLEX
DECIMAL
INT
STRING
TIME
TIMEZONE
UINT
}
Values
ConfigType.BOOL
ConfigType.COMPLEX
ConfigType.DECIMAL
ConfigType.INT
ConfigType.STRING
ConfigType.TIME
ConfigType.TIMEZONE
ConfigType.UINT
Member Of
DomainConfig object
ConversionReason
No description
enum ConversionReason {
MANUALLY_CONVERTED
SUMSUB_APPROVED
}
Values
ConversionReason.MANUALLY_CONVERTED
ConversionReason.SUMSUB_APPROVED
Member Of
Customer 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 {
OUTSTANDING_AMOUNT
}
Values
CreditFacilityCompleteErrorCode.OUTSTANDING_AMOUNT
Member Of
CreditFacilityCompletePayloadError object
CreditFacilityDisbursalInitiateErrorCode
No description
enum CreditFacilityDisbursalInitiateErrorCode {
BELOW_MARGIN_LIMIT
CUSTOMER_NOT_ELIGIBLE_FOR_PRODUCT
DISBURSAL_AMOUNT_TOO_LARGE
DISBURSAL_ON_INACTIVE_FACILITY
DISBURSAL_PAST_MATURITY_DATE
NOT_ACTIVATED_YET
ONLY_ONE_DISBURSAL_ALLOWED
}
Values
CreditFacilityDisbursalInitiateErrorCode.BELOW_MARGIN_LIMIT
CreditFacilityDisbursalInitiateErrorCode.CUSTOMER_NOT_ELIGIBLE_FOR_PRODUCT
CreditFacilityDisbursalInitiateErrorCode.DISBURSAL_AMOUNT_TOO_LARGE
CreditFacilityDisbursalInitiateErrorCode.DISBURSAL_ON_INACTIVE_FACILITY
CreditFacilityDisbursalInitiateErrorCode.DISBURSAL_PAST_MATURITY_DATE
CreditFacilityDisbursalInitiateErrorCode.NOT_ACTIVATED_YET
CreditFacilityDisbursalInitiateErrorCode.ONLY_ONE_DISBURSAL_ALLOWED
Member Of
CreditFacilityDisbursalInitiatePayloadError 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
CVL
}
Values
CreditFacilitySortBy.CREATED_AT
CreditFacilitySortBy.CVL
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
CustodianSortBy
No description
enum CustodianSortBy {
CREATED_AT
NAME
}
Values
CustodianSortBy.CREATED_AT
CustodianSortBy.NAME
Member Of
CustodianSort input
CustomerCloseErrorCode
No description
enum CustomerCloseErrorCode {
ACTIVE_CREDIT_FACILITIES
ACTIVE_DEPOSIT_ACCOUNTS
PENDING_COLLATERALIZATION
PENDING_PROPOSALS
PENDING_WITHDRAWALS
}
Values
CustomerCloseErrorCode.ACTIVE_CREDIT_FACILITIES
CustomerCloseErrorCode.ACTIVE_DEPOSIT_ACCOUNTS
CustomerCloseErrorCode.PENDING_COLLATERALIZATION
CustomerCloseErrorCode.PENDING_PROPOSALS
CustomerCloseErrorCode.PENDING_WITHDRAWALS
Member Of
CustomerClosePayloadError object
CustomerFreezeErrorCode
No description
enum CustomerFreezeErrorCode {
CUSTOMER_IS_CLOSED
}
Values
CustomerFreezeErrorCode.CUSTOMER_IS_CLOSED
Member Of
CustomerFreezePayloadError 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
Customer object ● CustomerFilter input ● Prospect object ● ProspectCreateInput input ● ProspectFilter input
CustomerUnfreezeErrorCode
No description
enum CustomerUnfreezeErrorCode {
CUSTOMER_IS_CLOSED
}
Values
CustomerUnfreezeErrorCode.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 ● 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 {
BALANCE_IS_NOT_ZERO
DEPOSIT_ACCOUNT_FROZEN
}
Values
DepositAccountCloseErrorCode.BALANCE_IS_NOT_ZERO
DepositAccountCloseErrorCode.DEPOSIT_ACCOUNT_FROZEN
Member Of
DepositAccountClosePayloadError object
DepositAccountFreezeErrorCode
No description
enum DepositAccountFreezeErrorCode {
DEPOSIT_ACCOUNT_CLOSED
}
Values
DepositAccountFreezeErrorCode.DEPOSIT_ACCOUNT_CLOSED
Member Of
DepositAccountFreezePayloadError 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 {
DEPOSIT_ACCOUNT_CLOSED
}
Values
DepositAccountUnfreezeErrorCode.DEPOSIT_ACCOUNT_CLOSED
Member Of
DepositAccountUnfreezePayloadError object
DepositRecordErrorCode
No description
enum DepositRecordErrorCode {
DEPOSIT_ACCOUNT_CLOSED
DEPOSIT_ACCOUNT_FROZEN
}
Values
DepositRecordErrorCode.DEPOSIT_ACCOUNT_CLOSED
DepositRecordErrorCode.DEPOSIT_ACCOUNT_FROZEN
Member Of
DepositRecordPayloadError 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 {
CONFIRMED
REVERTED
}
Values
DepositStatus.CONFIRMED
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
TermsInput input ● TermValues object
DisbursalSortBy
No description
enum DisbursalSortBy {
AMOUNT
CREATED_AT
}
Values
DisbursalSortBy.AMOUNT
DisbursalSortBy.CREATED_AT
Member Of
DisbursalSort input
DisbursalStatus
No description
enum DisbursalStatus {
APPROVED
CONFIRMED
DENIED
NEW
}
Values
DisbursalStatus.APPROVED
DisbursalStatus.CONFIRMED
DisbursalStatus.DENIED
DisbursalStatus.NEW
Member Of
CreditFacilityDisbursal object ● DisbursalFilter input
DocumentStatus
No description
enum DocumentStatus {
ACTIVE
ARCHIVED
DELETED
FAILED
NEW
}
Values
DocumentStatus.ACTIVE
DocumentStatus.ARCHIVED
DocumentStatus.DELETED
DocumentStatus.FAILED
DocumentStatus.NEW
Member Of
CustomerDocument object ● LedgerAccountCsvDocument object
EodPhaseExecutionStatus
No description
enum EodPhaseExecutionStatus {
COMPLETED
FAILED
IN_PROGRESS
PENDING
}
Values
EodPhaseExecutionStatus.COMPLETED
EodPhaseExecutionStatus.FAILED
EodPhaseExecutionStatus.IN_PROGRESS
EodPhaseExecutionStatus.PENDING
Member Of
EodProcessPhase object
EodProcessSortBy
No description
enum EodProcessSortBy {
DAY
STATUS
}
Values
EodProcessSortBy.DAY
EodProcessSortBy.STATUS
Member Of
EodProcessSort input
EodProcessStatus
No description
enum EodProcessStatus {
COMPLETED
FAILED
INITIALIZED
IN_PROGRESS
}
Values
EodProcessStatus.COMPLETED
EodProcessStatus.FAILED
EodProcessStatus.INITIALIZED
EodProcessStatus.IN_PROGRESS
Member Of
EodProcess object ● EodProcessFilter input ● Time object
FiscalYearCloseErrorCode
No description
enum FiscalYearCloseErrorCode {
LAST_MONTH_NOT_CLOSED
}
Values
FiscalYearCloseErrorCode.LAST_MONTH_NOT_CLOSED
Member Of
FiscalYearClosePayloadError object
FiscalYearCloseMonthErrorCode
No description
enum FiscalYearCloseMonthErrorCode {
LAST_MONTH_NOT_CLOSED
MONTH_HAS_NOT_ENDED
}
Values
FiscalYearCloseMonthErrorCode.LAST_MONTH_NOT_CLOSED
FiscalYearCloseMonthErrorCode.MONTH_HAS_NOT_ENDED
Member Of
FiscalYearCloseMonthPayloadError object
FiscalYearInitErrorCode
No description
enum FiscalYearInitErrorCode {
ALREADY_OPENED
}
Values
FiscalYearInitErrorCode.ALREADY_OPENED
Member Of
FiscalYearInitPayloadError object
FiscalYearOpenNextErrorCode
No description
enum FiscalYearOpenNextErrorCode {
LAST_MONTH_NOT_CLOSED
}
Values
FiscalYearOpenNextErrorCode.LAST_MONTH_NOT_CLOSED
Member Of
FiscalYearOpenNextPayloadError object
FiscalYearSortBy
No description
enum FiscalYearSortBy {
CREATED_AT
OPENED_AS_OF
}
Values
FiscalYearSortBy.CREATED_AT
FiscalYearSortBy.OPENED_AS_OF
Member Of
FiscalYearSort input
InterestInterval
No description
enum InterestInterval {
END_OF_DAY
END_OF_MONTH
}
Values
InterestInterval.END_OF_DAY
InterestInterval.END_OF_MONTH
Member Of
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
KycStatus
No description
enum KycStatus {
APPROVED
DECLINED
NOT_STARTED
ON_HOLD
PENDING
STARTED
}
Values
KycStatus.APPROVED
KycStatus.DECLINED
KycStatus.NOT_STARTED
KycStatus.ON_HOLD
KycStatus.PENDING
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
LedgerManualTransactionExecuteErrorCode
No description
enum LedgerManualTransactionExecuteErrorCode {
INSUFFICIENT_ENTRIES
VELOCITY_ERROR
}
Values
LedgerManualTransactionExecuteErrorCode.INSUFFICIENT_ENTRIES
LedgerManualTransactionExecuteErrorCode.VELOCITY_ERROR
Member Of
LedgerManualTransactionExecutePayloadError object
LiquidationSortBy
No description
enum LiquidationSortBy {
AMOUNT_RECEIVED
CREATED_AT
EXPECTED_TO_RECEIVE
SENT_TOTAL
}
Values
LiquidationSortBy.AMOUNT_RECEIVED
LiquidationSortBy.CREATED_AT
LiquidationSortBy.EXPECTED_TO_RECEIVE
LiquidationSortBy.SENT_TOTAL
Member Of
LiquidationSort input
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
PriceProviderSortBy
No description
enum PriceProviderSortBy {
CREATED_AT
NAME
}
Values
PriceProviderSortBy.CREATED_AT
PriceProviderSortBy.NAME
Member Of
PriceProviderSort input
ProspectCloseErrorCode
No description
enum ProspectCloseErrorCode {
ALREADY_CLOSED
ALREADY_CONVERTED
}
Values
ProspectCloseErrorCode.ALREADY_CLOSED
ProspectCloseErrorCode.ALREADY_CONVERTED
Member Of
ProspectClosePayloadError object
ProspectConvertErrorCode
No description
enum ProspectConvertErrorCode {
ALREADY_CLOSED
MANUAL_CONVERSION_NOT_ALLOWED
}
Values
ProspectConvertErrorCode.ALREADY_CLOSED
ProspectConvertErrorCode.MANUAL_CONVERSION_NOT_ALLOWED
Member Of
ProspectConvertPayloadError object
ProspectSortBy
No description
enum ProspectSortBy {
CREATED_AT
}
Values
ProspectSortBy.CREATED_AT
Member Of
ProspectSort input
ProspectStage
No description
enum ProspectStage {
CLOSED
CONVERTED
KYC_DECLINED
KYC_ON_HOLD
KYC_PENDING
KYC_STARTED
NEW
}
Values
ProspectStage.CLOSED
ProspectStage.CONVERTED
ProspectStage.KYC_DECLINED
ProspectStage.KYC_ON_HOLD
ProspectStage.KYC_PENDING
ProspectStage.KYC_STARTED
ProspectStage.NEW
Member Of
Prospect object ● ProspectFilter input
ReportOutputFormat
No description
enum ReportOutputFormat {
CSV
TXT
XML
}
Values
ReportOutputFormat.CSV
ReportOutputFormat.TXT
ReportOutputFormat.XML
Member Of
ReportDefinitionOutput object
ReportRunSortBy
No description
enum ReportRunSortBy {
START_TIME
}
Values
ReportRunSortBy.START_TIME
Member Of
ReportRunSort input
ReportRunState
No description
enum ReportRunState {
FAILED
QUEUED
RUNNING
SUCCESS
}
Values
ReportRunState.FAILED
ReportRunState.QUEUED
ReportRunState.RUNNING
ReportRunState.SUCCESS
Member Of
ReportRun object
ReportRunType
No description
enum ReportRunType {
MANUAL
SCHEDULED
}
Values
ReportRunType.MANUAL
ReportRunType.SCHEDULED
Member Of
ReportRun object
RolePermissionSetsAddErrorCode
No description
enum RolePermissionSetsAddErrorCode {
PERMISSION_SET_NOT_FOUND
}
Values
RolePermissionSetsAddErrorCode.PERMISSION_SET_NOT_FOUND
Member Of
RolePermissionSetsAddPayloadError object
RolePermissionSetsRemoveErrorCode
No description
enum RolePermissionSetsRemoveErrorCode {
PERMISSION_SET_NOT_FOUND
}
Values
RolePermissionSetsRemoveErrorCode.PERMISSION_SET_NOT_FOUND
Member Of
RolePermissionSetsRemovePayloadError object
RoleSortBy
No description
enum RoleSortBy {
CREATED_AT
NAME
}
Values
RoleSortBy.CREATED_AT
RoleSortBy.NAME
Member Of
RoleSort input
SelfCustodyNetwork
No description
enum SelfCustodyNetwork {
MAINNET
SIGNET
TESTNET3
TESTNET4
}
Values
SelfCustodyNetwork.MAINNET
SelfCustodyNetwork.SIGNET
SelfCustodyNetwork.TESTNET3
SelfCustodyNetwork.TESTNET4
Member Of
SelfCustodyConfigInput input
SortDirection
No description
enum SortDirection {
ASC
DESC
}
Values
SortDirection.ASC
SortDirection.DESC
Member Of
CommitteeSort input ● CreditFacilityProposalSort input ● CreditFacilitySort input ● CustodianSort input ● CustomerSort input ● DepositAccountSort input ● DepositSort input ● DisbursalSort input ● EodProcessSort input ● FiscalYearSort input ● LiquidationSort input ● PendingCreditFacilitySort input ● PriceProviderSort input ● ProspectSort input ● ReportRunSort input ● RoleSort input ● UserSort input ● WithdrawalSort input
TermsTemplateCreateErrorCode
No description
enum TermsTemplateCreateErrorCode {
DUPLICATE_TERMS_TEMPLATE_NAME
}
Values
TermsTemplateCreateErrorCode.DUPLICATE_TERMS_TEMPLATE_NAME
Member Of
TermsTemplateCreatePayloadError object
UserSortBy
No description
enum UserSortBy {
CREATED_AT
EMAIL
}
Values
UserSortBy.CREATED_AT
UserSortBy.EMAIL
Member Of
UserSort input
WalletNetwork
No description
enum WalletNetwork {
MAINNET
SIGNET
TESTNET3
TESTNET4
}
Values
WalletNetwork.MAINNET
WalletNetwork.SIGNET
WalletNetwork.TESTNET3
WalletNetwork.TESTNET4
Member Of
Wallet object
WithdrawalCancelErrorCode
No description
enum WithdrawalCancelErrorCode {
ALREADY_CONFIRMED
DEPOSIT_ACCOUNT_CLOSED
DEPOSIT_ACCOUNT_FROZEN
}
Values
WithdrawalCancelErrorCode.ALREADY_CONFIRMED
WithdrawalCancelErrorCode.DEPOSIT_ACCOUNT_CLOSED
WithdrawalCancelErrorCode.DEPOSIT_ACCOUNT_FROZEN
Member Of
WithdrawalCancelPayloadError object
WithdrawalConfirmErrorCode
No description
enum WithdrawalConfirmErrorCode {
ALREADY_CANCELLED
DEPOSIT_ACCOUNT_CLOSED
DEPOSIT_ACCOUNT_FROZEN
NOT_APPROVED
}
Values
WithdrawalConfirmErrorCode.ALREADY_CANCELLED
WithdrawalConfirmErrorCode.DEPOSIT_ACCOUNT_CLOSED
WithdrawalConfirmErrorCode.DEPOSIT_ACCOUNT_FROZEN
WithdrawalConfirmErrorCode.NOT_APPROVED
Member Of
WithdrawalConfirmPayloadError object
WithdrawalInitiateErrorCode
No description
enum WithdrawalInitiateErrorCode {
DEPOSIT_ACCOUNT_CLOSED
DEPOSIT_ACCOUNT_FROZEN
}
Values
WithdrawalInitiateErrorCode.DEPOSIT_ACCOUNT_CLOSED
WithdrawalInitiateErrorCode.DEPOSIT_ACCOUNT_FROZEN
Member Of
WithdrawalInitiatePayloadError object
WithdrawalRevertErrorCode
No description
enum WithdrawalRevertErrorCode {
ALREADY_CANCELLED
DEPOSIT_ACCOUNT_CLOSED
DEPOSIT_ACCOUNT_FROZEN
NOT_CONFIRMED
}
Values
WithdrawalRevertErrorCode.ALREADY_CANCELLED
WithdrawalRevertErrorCode.DEPOSIT_ACCOUNT_CLOSED
WithdrawalRevertErrorCode.DEPOSIT_ACCOUNT_FROZEN
WithdrawalRevertErrorCode.NOT_CONFIRMED
Member Of
WithdrawalRevertPayloadError 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
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
BitgoConfigInput
No description
input BitgoConfigInput {
enterpriseId: String!
longLivedToken: Secret!
name: String!
passphrase: Secret!
testingInstance: Boolean!
webhookSecret: Secret!
webhookUrl: Url!
}
Fields
BitgoConfigInput.enterpriseId ● String! non-null scalar
BitgoConfigInput.longLivedToken ● Secret! non-null scalar
BitgoConfigInput.name ● String! 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
CustodianConfigInput input ● CustodianCreateInput input
ChartOfAccountsAddChildNodeInput
No description
input ChartOfAccountsAddChildNodeInput {
code: AccountCode!
name: String!
parent: AccountCode!
}
Fields
ChartOfAccountsAddChildNodeInput.code ● AccountCode! non-null scalar
ChartOfAccountsAddChildNodeInput.name ● String! non-null scalar
ChartOfAccountsAddChildNodeInput.parent ● AccountCode! non-null scalar
Member Of
chartOfAccountsAddChildNode mutation
ChartOfAccountsInitializeInput
No description
input ChartOfAccountsInitializeInput {
baseConfig: AccountingBaseConfigInput!
file: Upload!
}
Fields
ChartOfAccountsInitializeInput.baseConfig ● AccountingBaseConfigInput! non-null input
ChartOfAccountsInitializeInput.file ● Upload! non-null scalar
Member Of
chartOfAccountsInitialize mutation
CollateralRecordProceedsFromLiquidationInput
No description
input CollateralRecordProceedsFromLiquidationInput {
amount: UsdCents!
collateralId: CollateralId!
}
Fields
CollateralRecordProceedsFromLiquidationInput.amount ● UsdCents! non-null scalar
CollateralRecordProceedsFromLiquidationInput.collateralId ● CollateralId! non-null scalar
Member Of
collateralRecordProceedsFromLiquidation mutation
CollateralRecordSentToLiquidationInput
No description
input CollateralRecordSentToLiquidationInput {
amount: Satoshis!
collateralId: CollateralId!
}
Fields
CollateralRecordSentToLiquidationInput.amount ● Satoshis! non-null scalar
CollateralRecordSentToLiquidationInput.collateralId ● CollateralId! non-null scalar
Member Of
collateralRecordSentToLiquidation mutation
CollateralUpdateInput
No description
input CollateralUpdateInput {
collateral: Satoshis!
collateralId: CollateralId!
effective: Date!
}
Fields
CollateralUpdateInput.collateral ● Satoshis! non-null scalar
CollateralUpdateInput.collateralId ● CollateralId! non-null scalar
CollateralUpdateInput.effective ● Date! 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
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: UsdCents!
creditFacilityId: CreditFacilityId!
}
Fields
CreditFacilityDisbursalInitiateInput.amount ● UsdCents! non-null scalar
CreditFacilityDisbursalInitiateInput.creditFacilityId ● CreditFacilityId! non-null scalar
Member Of
creditFacilityDisbursalInitiate mutation
CreditFacilityFilter
No description
input CreditFacilityFilter {
collateralizationState: CollateralizationState
status: CreditFacilityStatus
}
Fields
CreditFacilityFilter.collateralizationState ● CollateralizationState enum
CreditFacilityFilter.status ● CreditFacilityStatus enum
Member Of
creditFacilities query
CreditFacilityModuleConfigureInput
No description
input CreditFacilityModuleConfigureInput {
chartOfAccountCollateralInLiquidationParentCode: AccountCode!
chartOfAccountCollateralOmnibusParentCode: AccountCode!
chartOfAccountCollateralParentCode: AccountCode!
chartOfAccountDisbursedDefaultedParentCode: AccountCode!
chartOfAccountFacilityOmnibusParentCode: AccountCode!
chartOfAccountFacilityParentCode: AccountCode!
chartOfAccountFeeIncomeParentCode: AccountCode!
chartOfAccountInterestAddedToObligationsOmnibusParentCode: AccountCode!
chartOfAccountInterestDefaultedParentCode: AccountCode!
chartOfAccountInterestIncomeParentCode: AccountCode!
chartOfAccountLiquidatedCollateralParentCode: AccountCode!
chartOfAccountLiquidationProceedsOmnibusParentCode: AccountCode!
chartOfAccountLongTermBankDisbursedReceivableParentCode: AccountCode!
chartOfAccountLongTermBankInterestReceivableParentCode: AccountCode!
chartOfAccountLongTermFinancialInstitutionDisbursedReceivableParentCode: AccountCode!
chartOfAccountLongTermFinancialInstitutionInterestReceivableParentCode: AccountCode!
chartOfAccountLongTermForeignAgencyOrSubsidiaryDisbursedReceivableParentCode: AccountCode!
chartOfAccountLongTermForeignAgencyOrSubsidiaryInterestReceivableParentCode: AccountCode!
chartOfAccountLongTermGovernmentEntityDisbursedReceivableParentCode: AccountCode!
chartOfAccountLongTermGovernmentEntityInterestReceivableParentCode: AccountCode!
chartOfAccountLongTermIndividualDisbursedReceivableParentCode: AccountCode!
chartOfAccountLongTermIndividualInterestReceivableParentCode: AccountCode!
chartOfAccountLongTermNonDomiciledCompanyDisbursedReceivableParentCode: AccountCode!
chartOfAccountLongTermNonDomiciledCompanyInterestReceivableParentCode: AccountCode!
chartOfAccountLongTermPrivateCompanyDisbursedReceivableParentCode: AccountCode!
chartOfAccountLongTermPrivateCompanyInterestReceivableParentCode: AccountCode!
chartOfAccountOverdueBankDisbursedReceivableParentCode: AccountCode!
chartOfAccountOverdueFinancialInstitutionDisbursedReceivableParentCode: AccountCode!
chartOfAccountOverdueForeignAgencyOrSubsidiaryDisbursedReceivableParentCode: AccountCode!
chartOfAccountOverdueGovernmentEntityDisbursedReceivableParentCode: AccountCode!
chartOfAccountOverdueIndividualDisbursedReceivableParentCode: AccountCode!
chartOfAccountOverdueNonDomiciledCompanyDisbursedReceivableParentCode: AccountCode!
chartOfAccountOverduePrivateCompanyDisbursedReceivableParentCode: AccountCode!
chartOfAccountPaymentHoldingParentCode: AccountCode!
chartOfAccountPaymentsMadeOmnibusParentCode: AccountCode!
chartOfAccountProceedsFromLiquidationParentCode: AccountCode!
chartOfAccountShortTermBankDisbursedReceivableParentCode: AccountCode!
chartOfAccountShortTermBankInterestReceivableParentCode: AccountCode!
chartOfAccountShortTermFinancialInstitutionDisbursedReceivableParentCode: AccountCode!
chartOfAccountShortTermFinancialInstitutionInterestReceivableParentCode: AccountCode!
chartOfAccountShortTermForeignAgencyOrSubsidiaryDisbursedReceivableParentCode: AccountCode!
chartOfAccountShortTermForeignAgencyOrSubsidiaryInterestReceivableParentCode: AccountCode!
chartOfAccountShortTermGovernmentEntityDisbursedReceivableParentCode: AccountCode!
chartOfAccountShortTermGovernmentEntityInterestReceivableParentCode: AccountCode!
chartOfAccountShortTermIndividualDisbursedReceivableParentCode: AccountCode!
chartOfAccountShortTermIndividualInterestReceivableParentCode: AccountCode!
chartOfAccountShortTermNonDomiciledCompanyDisbursedReceivableParentCode: AccountCode!
chartOfAccountShortTermNonDomiciledCompanyInterestReceivableParentCode: AccountCode!
chartOfAccountShortTermPrivateCompanyDisbursedReceivableParentCode: AccountCode!
chartOfAccountShortTermPrivateCompanyInterestReceivableParentCode: AccountCode!
chartOfAccountUncoveredOutstandingParentCode: AccountCode!
}
Fields
CreditFacilityModuleConfigureInput.chartOfAccountCollateralInLiquidationParentCode ● AccountCode! non-null scalar
CreditFacilityModuleConfigureInput.chartOfAccountCollateralOmnibusParentCode ● AccountCode! non-null scalar
CreditFacilityModuleConfigureInput.chartOfAccountCollateralParentCode ● AccountCode! non-null scalar
CreditFacilityModuleConfigureInput.chartOfAccountDisbursedDefaultedParentCode ● AccountCode! non-null scalar
CreditFacilityModuleConfigureInput.chartOfAccountFacilityOmnibusParentCode ● AccountCode! non-null scalar
CreditFacilityModuleConfigureInput.chartOfAccountFacilityParentCode ● AccountCode! non-null scalar
CreditFacilityModuleConfigureInput.chartOfAccountFeeIncomeParentCode ● AccountCode! non-null scalar
CreditFacilityModuleConfigureInput.chartOfAccountInterestAddedToObligationsOmnibusParentCode ● AccountCode! non-null scalar
CreditFacilityModuleConfigureInput.chartOfAccountInterestDefaultedParentCode ● AccountCode! non-null scalar
CreditFacilityModuleConfigureInput.chartOfAccountInterestIncomeParentCode ● AccountCode! non-null scalar
CreditFacilityModuleConfigureInput.chartOfAccountLiquidatedCollateralParentCode ● AccountCode! non-null scalar
CreditFacilityModuleConfigureInput.chartOfAccountLiquidationProceedsOmnibusParentCode ● AccountCode! non-null scalar
CreditFacilityModuleConfigureInput.chartOfAccountLongTermBankDisbursedReceivableParentCode ● AccountCode! non-null scalar
CreditFacilityModuleConfigureInput.chartOfAccountLongTermBankInterestReceivableParentCode ● AccountCode! non-null scalar
CreditFacilityModuleConfigureInput.chartOfAccountLongTermFinancialInstitutionDisbursedReceivableParentCode ● AccountCode! non-null scalar
CreditFacilityModuleConfigureInput.chartOfAccountLongTermFinancialInstitutionInterestReceivableParentCode ● AccountCode! non-null scalar
CreditFacilityModuleConfigureInput.chartOfAccountLongTermForeignAgencyOrSubsidiaryDisbursedReceivableParentCode ● AccountCode! non-null scalar
CreditFacilityModuleConfigureInput.chartOfAccountLongTermForeignAgencyOrSubsidiaryInterestReceivableParentCode ● AccountCode! non-null scalar
CreditFacilityModuleConfigureInput.chartOfAccountLongTermGovernmentEntityDisbursedReceivableParentCode ● AccountCode! non-null scalar
CreditFacilityModuleConfigureInput.chartOfAccountLongTermGovernmentEntityInterestReceivableParentCode ● AccountCode! non-null scalar
CreditFacilityModuleConfigureInput.chartOfAccountLongTermIndividualDisbursedReceivableParentCode ● AccountCode! non-null scalar
CreditFacilityModuleConfigureInput.chartOfAccountLongTermIndividualInterestReceivableParentCode ● AccountCode! non-null scalar
CreditFacilityModuleConfigureInput.chartOfAccountLongTermNonDomiciledCompanyDisbursedReceivableParentCode ● AccountCode! non-null scalar
CreditFacilityModuleConfigureInput.chartOfAccountLongTermNonDomiciledCompanyInterestReceivableParentCode ● AccountCode! non-null scalar
CreditFacilityModuleConfigureInput.chartOfAccountLongTermPrivateCompanyDisbursedReceivableParentCode ● AccountCode! non-null scalar
CreditFacilityModuleConfigureInput.chartOfAccountLongTermPrivateCompanyInterestReceivableParentCode ● AccountCode! non-null scalar
CreditFacilityModuleConfigureInput.chartOfAccountOverdueBankDisbursedReceivableParentCode ● AccountCode! non-null scalar
CreditFacilityModuleConfigureInput.chartOfAccountOverdueFinancialInstitutionDisbursedReceivableParentCode ● AccountCode! non-null scalar
CreditFacilityModuleConfigureInput.chartOfAccountOverdueForeignAgencyOrSubsidiaryDisbursedReceivableParentCode ● AccountCode! non-null scalar
CreditFacilityModuleConfigureInput.chartOfAccountOverdueGovernmentEntityDisbursedReceivableParentCode ● AccountCode! non-null scalar
CreditFacilityModuleConfigureInput.chartOfAccountOverdueIndividualDisbursedReceivableParentCode ● AccountCode! non-null scalar
CreditFacilityModuleConfigureInput.chartOfAccountOverdueNonDomiciledCompanyDisbursedReceivableParentCode ● AccountCode! non-null scalar
CreditFacilityModuleConfigureInput.chartOfAccountOverduePrivateCompanyDisbursedReceivableParentCode ● AccountCode! non-null scalar
CreditFacilityModuleConfigureInput.chartOfAccountPaymentHoldingParentCode ● AccountCode! non-null scalar
CreditFacilityModuleConfigureInput.chartOfAccountPaymentsMadeOmnibusParentCode ● AccountCode! non-null scalar
CreditFacilityModuleConfigureInput.chartOfAccountProceedsFromLiquidationParentCode ● AccountCode! non-null scalar
CreditFacilityModuleConfigureInput.chartOfAccountShortTermBankDisbursedReceivableParentCode ● AccountCode! non-null scalar
CreditFacilityModuleConfigureInput.chartOfAccountShortTermBankInterestReceivableParentCode ● AccountCode! non-null scalar
CreditFacilityModuleConfigureInput.chartOfAccountShortTermFinancialInstitutionDisbursedReceivableParentCode ● AccountCode! non-null scalar
CreditFacilityModuleConfigureInput.chartOfAccountShortTermFinancialInstitutionInterestReceivableParentCode ● AccountCode! non-null scalar
CreditFacilityModuleConfigureInput.chartOfAccountShortTermForeignAgencyOrSubsidiaryDisbursedReceivableParentCode ● AccountCode! non-null scalar
CreditFacilityModuleConfigureInput.chartOfAccountShortTermForeignAgencyOrSubsidiaryInterestReceivableParentCode ● AccountCode! non-null scalar
CreditFacilityModuleConfigureInput.chartOfAccountShortTermGovernmentEntityDisbursedReceivableParentCode ● AccountCode! non-null scalar
CreditFacilityModuleConfigureInput.chartOfAccountShortTermGovernmentEntityInterestReceivableParentCode ● AccountCode! non-null scalar
CreditFacilityModuleConfigureInput.chartOfAccountShortTermIndividualDisbursedReceivableParentCode ● AccountCode! non-null scalar
CreditFacilityModuleConfigureInput.chartOfAccountShortTermIndividualInterestReceivableParentCode ● AccountCode! non-null scalar
CreditFacilityModuleConfigureInput.chartOfAccountShortTermNonDomiciledCompanyDisbursedReceivableParentCode ● AccountCode! non-null scalar
CreditFacilityModuleConfigureInput.chartOfAccountShortTermNonDomiciledCompanyInterestReceivableParentCode ● AccountCode! non-null scalar
CreditFacilityModuleConfigureInput.chartOfAccountShortTermPrivateCompanyDisbursedReceivableParentCode ● AccountCode! non-null scalar
CreditFacilityModuleConfigureInput.chartOfAccountShortTermPrivateCompanyInterestReceivableParentCode ● AccountCode! non-null scalar
CreditFacilityModuleConfigureInput.chartOfAccountUncoveredOutstandingParentCode ● AccountCode! non-null scalar
Member Of
creditFacilityModuleConfigure mutation
CreditFacilityPartialPaymentRecordInput
No description
input CreditFacilityPartialPaymentRecordInput {
amount: UsdCents!
creditFacilityId: CreditFacilityId!
}
Fields
CreditFacilityPartialPaymentRecordInput.amount ● UsdCents! non-null scalar
CreditFacilityPartialPaymentRecordInput.creditFacilityId ● CreditFacilityId! non-null scalar
Member Of
creditFacilityPartialPaymentRecord mutation
CreditFacilityPartialPaymentWithDateRecordInput
No description
input CreditFacilityPartialPaymentWithDateRecordInput {
amount: UsdCents!
creditFacilityId: CreditFacilityId!
effective: Date!
}
Fields
CreditFacilityPartialPaymentWithDateRecordInput.amount ● UsdCents! non-null scalar
CreditFacilityPartialPaymentWithDateRecordInput.creditFacilityId ● CreditFacilityId! non-null scalar
CreditFacilityPartialPaymentWithDateRecordInput.effective ● Date! non-null scalar
Member Of
creditFacilityPartialPaymentWithDateRecord mutation
CreditFacilityProposalCreateInput
No description
input CreditFacilityProposalCreateInput {
custodianId: CustodianId!
customerId: CustomerId!
facility: UsdCents!
terms: TermsInput!
}
Fields
CreditFacilityProposalCreateInput.custodianId ● CustodianId! non-null scalar
CreditFacilityProposalCreateInput.customerId ● CustomerId! non-null scalar
CreditFacilityProposalCreateInput.facility ● UsdCents! non-null scalar
CreditFacilityProposalCreateInput.terms ● TermsInput! 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 {
status: CreditFacilityProposalStatus
}
Fields
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
CustodianConfigInput
No description
input CustodianConfigInput {
bitgo: BitgoConfigInput
komainu: KomainuConfigInput
selfCustody: SelfCustodyConfigInput
}
Fields
CustodianConfigInput.bitgo ● BitgoConfigInput input
CustodianConfigInput.komainu ● KomainuConfigInput input
CustodianConfigInput.selfCustody ● SelfCustodyConfigInput 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: BitgoConfigInput
komainu: KomainuConfigInput
manual: ManualConfigInput
selfCustody: SelfCustodyConfigInput
}
Fields
CustodianCreateInput.bitgo ● BitgoConfigInput input
CustodianCreateInput.komainu ● KomainuConfigInput input
CustodianCreateInput.manual ● ManualConfigInput input
CustodianCreateInput.selfCustody ● SelfCustodyConfigInput 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!
}
Fields
CustomerCloseInput.customerId ● CustomerId! non-null scalar
Member Of
customerClose mutation
CustomerDocumentArchiveInput
No description
input CustomerDocumentArchiveInput {
customerDocumentId: CustomerDocumentId!
}
Fields
CustomerDocumentArchiveInput.customerDocumentId ● CustomerDocumentId! non-null scalar
Member Of
customerDocumentArchive 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
CustomerEmailUpdateInput
No description
input CustomerEmailUpdateInput {
customerId: CustomerId!
email: String!
}
Fields
CustomerEmailUpdateInput.customerId ● CustomerId! non-null scalar
CustomerEmailUpdateInput.email ● String! non-null scalar
Member Of
customerEmailUpdate mutation
CustomerFilter
No description
input CustomerFilter {
customerType: CustomerType
status: CustomerStatus
}
Fields
CustomerFilter.customerType ● CustomerType enum
CustomerFilter.status ● CustomerStatus enum
Member Of
customers query
CustomerFreezeInput
No description
input CustomerFreezeInput {
customerId: CustomerId!
}
Fields
CustomerFreezeInput.customerId ● CustomerId! non-null scalar
Member Of
customerFreeze 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
CustomerTelegramHandleUpdateInput
No description
input CustomerTelegramHandleUpdateInput {
customerId: CustomerId!
telegramHandle: String!
}
Fields
CustomerTelegramHandleUpdateInput.customerId ● CustomerId! non-null scalar
CustomerTelegramHandleUpdateInput.telegramHandle ● String! non-null scalar
Member Of
customerTelegramHandleUpdate mutation
CustomerUnfreezeInput
No description
input CustomerUnfreezeInput {
customerId: CustomerId!
}
Fields
CustomerUnfreezeInput.customerId ● CustomerId! non-null scalar
Member Of
customerUnfreeze mutation
DepositAccountCloseInput
No description
input DepositAccountCloseInput {
depositAccountId: DepositAccountId!
}
Fields
DepositAccountCloseInput.depositAccountId ● DepositAccountId! non-null scalar
Member Of
depositAccountClose mutation
DepositAccountCreateInput
No description
input DepositAccountCreateInput {
customerId: CustomerId!
}
Fields
DepositAccountCreateInput.customerId ● CustomerId! non-null scalar
Member Of
depositAccountCreate mutation
DepositAccountFilter
No description
input DepositAccountFilter {
activity: DepositAccountActivity
status: DepositAccountStatus
}
Fields
DepositAccountFilter.activity ● DepositAccountActivity enum
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
DepositAccountModuleConfigureInput
No description
input DepositAccountModuleConfigureInput {
chartOfAccountsBankDepositAccountsParentCode: AccountCode!
chartOfAccountsFinancialInstitutionDepositAccountsParentCode: AccountCode!
chartOfAccountsFrozenBankDepositAccountsParentCode: AccountCode!
chartOfAccountsFrozenFinancialInstitutionDepositAccountsParentCode: AccountCode!
chartOfAccountsFrozenGovernmentEntityDepositAccountsParentCode: AccountCode!
chartOfAccountsFrozenIndividualDepositAccountsParentCode: AccountCode!
chartOfAccountsFrozenNonDomiciledCompanyDepositAccountsParentCode: AccountCode!
chartOfAccountsFrozenPrivateCompanyDepositAccountsParentCode: AccountCode!
chartOfAccountsGovernmentEntityDepositAccountsParentCode: AccountCode!
chartOfAccountsIndividualDepositAccountsParentCode: AccountCode!
chartOfAccountsNonDomiciledCompanyDepositAccountsParentCode: AccountCode!
chartOfAccountsOmnibusParentCode: AccountCode!
chartOfAccountsPrivateCompanyDepositAccountsParentCode: AccountCode!
}
Fields
DepositAccountModuleConfigureInput.chartOfAccountsBankDepositAccountsParentCode ● AccountCode! non-null scalar
DepositAccountModuleConfigureInput.chartOfAccountsFinancialInstitutionDepositAccountsParentCode ● AccountCode! non-null scalar
DepositAccountModuleConfigureInput.chartOfAccountsFrozenBankDepositAccountsParentCode ● AccountCode! non-null scalar
DepositAccountModuleConfigureInput.chartOfAccountsFrozenFinancialInstitutionDepositAccountsParentCode ● AccountCode! non-null scalar
DepositAccountModuleConfigureInput.chartOfAccountsFrozenGovernmentEntityDepositAccountsParentCode ● AccountCode! non-null scalar
DepositAccountModuleConfigureInput.chartOfAccountsFrozenIndividualDepositAccountsParentCode ● AccountCode! non-null scalar
DepositAccountModuleConfigureInput.chartOfAccountsFrozenNonDomiciledCompanyDepositAccountsParentCode ● AccountCode! non-null scalar
DepositAccountModuleConfigureInput.chartOfAccountsFrozenPrivateCompanyDepositAccountsParentCode ● AccountCode! non-null scalar
DepositAccountModuleConfigureInput.chartOfAccountsGovernmentEntityDepositAccountsParentCode ● AccountCode! non-null scalar
DepositAccountModuleConfigureInput.chartOfAccountsIndividualDepositAccountsParentCode ● AccountCode! non-null scalar
DepositAccountModuleConfigureInput.chartOfAccountsNonDomiciledCompanyDepositAccountsParentCode ● AccountCode! non-null scalar
DepositAccountModuleConfigureInput.chartOfAccountsOmnibusParentCode ● AccountCode! non-null scalar
DepositAccountModuleConfigureInput.chartOfAccountsPrivateCompanyDepositAccountsParentCode ● AccountCode! non-null scalar
Member Of
depositAccountModuleConfigure 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
DepositFilter
No description
input DepositFilter {
status: DepositStatus
}
Fields
DepositFilter.status ● DepositStatus enum
Member Of
deposits query
DepositRecordInput
No description
input DepositRecordInput {
amount: UsdCents!
depositAccountId: DepositAccountId!
reference: String
}
Fields
DepositRecordInput.amount ● UsdCents! non-null scalar
DepositRecordInput.depositAccountId ● DepositAccountId! non-null scalar
DepositRecordInput.reference ● String scalar
Member Of
depositRecord mutation
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
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
TermsInput input
EodProcessFilter
No description
input EodProcessFilter {
day: Date
status: EodProcessStatus
}
Fields
EodProcessFilter.day ● Date scalar
Include only the process for this specific day.
EodProcessFilter.status ● EodProcessStatus enum
Include only processes with this status.
Member Of
eodProcesses query
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
FiscalYearCloseInput
No description
input FiscalYearCloseInput {
fiscalYearId: FiscalYearId!
}
Fields
FiscalYearCloseInput.fiscalYearId ● FiscalYearId! non-null scalar
Member Of
fiscalYearClose mutation
FiscalYearCloseMonthInput
No description
input FiscalYearCloseMonthInput {
fiscalYearId: FiscalYearId!
}
Fields
FiscalYearCloseMonthInput.fiscalYearId ● FiscalYearId! non-null scalar
Member Of
fiscalYearCloseMonth mutation
FiscalYearInitInput
No description
input FiscalYearInitInput {
openedAsOf: Date!
}
Fields
FiscalYearInitInput.openedAsOf ● Date! non-null scalar
Member Of
fiscalYearInit mutation
FiscalYearOpenNextInput
No description
input FiscalYearOpenNextInput {
fiscalYearId: FiscalYearId!
}
Fields
FiscalYearOpenNextInput.fiscalYearId ● FiscalYearId! non-null scalar
Member Of
fiscalYearOpenNext 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
KomainuConfigInput
No description
input KomainuConfigInput {
apiKey: Secret!
apiSecret: Secret!
name: String!
secretKey: Secret!
testingInstance: Boolean!
webhookSecret: Secret!
}
Fields
KomainuConfigInput.apiKey ● Secret! non-null scalar
KomainuConfigInput.apiSecret ● Secret! non-null scalar
KomainuConfigInput.name ● String! 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 ● CustodianCreateInput input
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
LedgerManualTransactionExecuteInput
No description
input LedgerManualTransactionExecuteInput {
description: String!
effective: Date!
entries: [ManualTransactionEntryInput!]!
reference: String
}
Fields
LedgerManualTransactionExecuteInput.description ● String! non-null scalar
LedgerManualTransactionExecuteInput.effective ● Date! non-null scalar
LedgerManualTransactionExecuteInput.entries ● [ManualTransactionEntryInput!]! non-null input
LedgerManualTransactionExecuteInput.reference ● String scalar
Member Of
ledgerManualTransactionExecute mutation
LiquidationPaymentCalculateInput
No description
input LiquidationPaymentCalculateInput {
liquidationId: LiquidationId!
outstanding: UsdCents!
targetCvl: CVLPctValue
toLiquidate: Satoshis
toReceive: UsdCents
}
Fields
LiquidationPaymentCalculateInput.liquidationId ● LiquidationId! non-null scalar
LiquidationPaymentCalculateInput.outstanding ● UsdCents! non-null scalar
LiquidationPaymentCalculateInput.targetCvl ● CVLPctValue scalar
LiquidationPaymentCalculateInput.toLiquidate ● Satoshis scalar
LiquidationPaymentCalculateInput.toReceive ● UsdCents scalar
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
ManualConfigInput
No description
input ManualConfigInput {
name: String!
}
Fields
ManualConfigInput.name ● String! non-null scalar
Member Of
CustodianCreateInput input
ManualTransactionEntryInput
No description
input ManualTransactionEntryInput {
accountRef: String!
amount: Decimal!
currency: String!
description: String!
direction: DebitOrCredit!
}
Fields
ManualTransactionEntryInput.accountRef ● String! non-null scalar
ManualTransactionEntryInput.amount ● Decimal! non-null scalar
ManualTransactionEntryInput.currency ● String! non-null scalar
ManualTransactionEntryInput.description ● String! non-null scalar
ManualTransactionEntryInput.direction ● DebitOrCredit! non-null enum
Member Of
LedgerManualTransactionExecuteInput input
PendingCreditFacilityFilter
No description
input PendingCreditFacilityFilter {
collateralizationState: PendingCreditFacilityCollateralizationState
status: PendingCreditFacilityStatus
}
Fields
PendingCreditFacilityFilter.collateralizationState ● PendingCreditFacilityCollateralizationState enum
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
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
PriceProviderActivateInput
No description
input PriceProviderActivateInput {
priceProviderId: PriceProviderId!
}
Fields
PriceProviderActivateInput.priceProviderId ● PriceProviderId! non-null scalar
Member Of
priceProviderActivate mutation
PriceProviderDeactivateInput
No description
input PriceProviderDeactivateInput {
priceProviderId: PriceProviderId!
}
Fields
PriceProviderDeactivateInput.priceProviderId ● PriceProviderId! non-null scalar
Member Of
priceProviderDeactivate mutation
PriceProviderManualPriceUpdateInput
No description
input PriceProviderManualPriceUpdateInput {
usdCentsPerBtc: Int!
}
Fields
PriceProviderManualPriceUpdateInput.usdCentsPerBtc ● Int! non-null scalar
Member Of
priceProviderManualPriceUpdate mutation
PriceProviderSort
No description
input PriceProviderSort {
by: PriceProviderSortBy!
direction: SortDirection!
}
Fields
PriceProviderSort.by ● PriceProviderSortBy! non-null enum
PriceProviderSort.direction ● SortDirection! non-null enum
Member Of
priceProviders query
ProspectCloseInput
No description
input ProspectCloseInput {
prospectId: ProspectId!
}
Fields
ProspectCloseInput.prospectId ● ProspectId! non-null scalar
Member Of
prospectClose mutation
ProspectConvertInput
No description
input ProspectConvertInput {
prospectId: ProspectId!
}
Fields
ProspectConvertInput.prospectId ● ProspectId! non-null scalar
Member Of
prospectConvert mutation
ProspectCreateInput
No description
input ProspectCreateInput {
customerType: CustomerType!
email: String!
telegramHandle: String!
}
Fields
ProspectCreateInput.customerType ● CustomerType! non-null enum
ProspectCreateInput.email ● String! non-null scalar
ProspectCreateInput.telegramHandle ● String! non-null scalar
Member Of
prospectCreate mutation
ProspectFilter
No description
input ProspectFilter {
customerType: CustomerType
stage: ProspectStage
}
Fields
ProspectFilter.customerType ● CustomerType enum
ProspectFilter.stage ● ProspectStage enum
Member Of
prospects query
ProspectKycLinkCreateInput
No description
input ProspectKycLinkCreateInput {
prospectId: ProspectId!
}
Fields
ProspectKycLinkCreateInput.prospectId ● ProspectId! non-null scalar
Member Of
prospectKycLinkCreate mutation
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
ReportFileDownloadLinkGenerateInput
No description
input ReportFileDownloadLinkGenerateInput {
extension: String!
reportId: ReportId!
}
Fields
ReportFileDownloadLinkGenerateInput.extension ● String! non-null scalar
ReportFileDownloadLinkGenerateInput.reportId ● ReportId! non-null scalar
Member Of
reportFileDownloadLinkGenerate mutation
ReportRunSort
No description
input ReportRunSort {
by: ReportRunSortBy!
direction: SortDirection!
}
Fields
ReportRunSort.by ● ReportRunSortBy! non-null enum
ReportRunSort.direction ● SortDirection! non-null enum
Member Of
reportRuns query
ReportRunTriggerInput
No description
input ReportRunTriggerInput {
asOfDate: Date
reportDefinitionId: ReportDefinitionId!
}
Fields
ReportRunTriggerInput.asOfDate ● Date scalar
ReportRunTriggerInput.reportDefinitionId ● ReportDefinitionId! non-null scalar
Member Of
reportRunTrigger mutation
RoleCreateInput
No description
input RoleCreateInput {
name: String!
permissionSetIds: [PermissionSetId!]!
}
Fields
RoleCreateInput.name ● String! 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
SelfCustodyConfigInput
No description
input SelfCustodyConfigInput {
accountXpub: Secret!
name: String!
network: SelfCustodyNetwork!
}
Fields
SelfCustodyConfigInput.accountXpub ● Secret! non-null scalar
SelfCustodyConfigInput.name ● String! non-null scalar
SelfCustodyConfigInput.network ● SelfCustodyNetwork! non-null enum
Member Of
CustodianConfigInput input ● CustodianCreateInput input
TermsInput
No description
input TermsInput {
accrualCycleInterval: InterestInterval!
accrualInterval: InterestInterval!
annualRate: AnnualRatePct!
disbursalPolicy: DisbursalPolicy!
duration: DurationInput!
initialCvl: CVLPctValue!
interestDueDurationFromAccrual: DurationInput!
liquidationCvl: CVLPctValue!
marginCallCvl: CVLPctValue!
obligationLiquidationDurationFromDue: DurationInput!
obligationOverdueDurationFromDue: DurationInput!
oneTimeFeeRate: OneTimeFeeRatePct!
}
Fields
TermsInput.accrualCycleInterval ● InterestInterval! non-null enum
TermsInput.accrualInterval ● InterestInterval! non-null enum
TermsInput.annualRate ● AnnualRatePct! non-null scalar
TermsInput.disbursalPolicy ● DisbursalPolicy! non-null enum
TermsInput.duration ● DurationInput! non-null input
TermsInput.initialCvl ● CVLPctValue! non-null scalar
TermsInput.interestDueDurationFromAccrual ● DurationInput! non-null input
TermsInput.liquidationCvl ● CVLPctValue! non-null scalar
TermsInput.marginCallCvl ● CVLPctValue! non-null scalar
TermsInput.obligationLiquidationDurationFromDue ● DurationInput! non-null input
TermsInput.obligationOverdueDurationFromDue ● DurationInput! non-null input
TermsInput.oneTimeFeeRate ● OneTimeFeeRatePct! non-null scalar
Member Of
CreditFacilityProposalCreateInput input ● TermsTemplateCreateInput input ● TermsTemplateUpdateInput input
TermsTemplateCreateInput
No description
input TermsTemplateCreateInput {
name: String!
terms: TermsInput!
}
Fields
TermsTemplateCreateInput.name ● String! non-null scalar
TermsTemplateCreateInput.terms ● TermsInput! non-null input
Member Of
termsTemplateCreate mutation
TermsTemplateUpdateInput
No description
input TermsTemplateUpdateInput {
terms: TermsInput!
termsTemplateId: TermsTemplateId!
}
Fields
TermsTemplateUpdateInput.terms ● TermsInput! non-null input
TermsTemplateUpdateInput.termsTemplateId ● TermsTemplateId! non-null scalar
Member Of
termsTemplateUpdate mutation
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
WithdrawalCancelInput
No description
input WithdrawalCancelInput {
withdrawalId: WithdrawalId!
}
Fields
WithdrawalCancelInput.withdrawalId ● WithdrawalId! non-null scalar
Member Of
withdrawalCancel mutation
WithdrawalConfirmInput
No description
input WithdrawalConfirmInput {
withdrawalId: WithdrawalId!
}
Fields
WithdrawalConfirmInput.withdrawalId ● WithdrawalId! non-null scalar
Member Of
withdrawalConfirm mutation
WithdrawalFilter
No description
input WithdrawalFilter {
status: WithdrawalStatus
}
Fields
WithdrawalFilter.status ● WithdrawalStatus enum
Member Of
withdrawals query
WithdrawalInitiateInput
No description
input WithdrawalInitiateInput {
amount: UsdCents!
depositAccountId: DepositAccountId!
reference: String
}
Fields
WithdrawalInitiateInput.amount ● UsdCents! non-null scalar
WithdrawalInitiateInput.depositAccountId ● DepositAccountId! non-null scalar
WithdrawalInitiateInput.reference ● String scalar
Member Of
withdrawalInitiate mutation
WithdrawalRevertInput
No description
input WithdrawalRevertInput {
withdrawalId: WithdrawalId!
}
Fields
WithdrawalRevertInput.withdrawalId ● WithdrawalId! non-null scalar
Member Of
withdrawalRevert 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 ● ChartNode object ● ChartOfAccountsAddChildNodeInput input ● CreditFacilityModuleConfig object ● CreditFacilityModuleConfigureInput input ● DepositAccountModuleConfig object ● DepositAccountModuleConfigureInput input ● LedgerAccount object ● ledgerAccountByCode query ● ProfitAndLossAccount object
AccountSetId
No description
scalar AccountSetId
Member Of
ChartNode object
AnnualRatePct
No description
scalar AnnualRatePct
Member Of
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
Boolean
The Boolean scalar type represents true or false.
scalar Boolean
Member Of
ApprovalProcess object ● ApprovalProcessVoter object ● audit query ● AuditEntry object ● AutoApproval object ● BitgoConfigInput input ● ChartNode object ● CreditFacility object ● CreditFacilityProposalCustomerApprovalConcludeInput input ● Customer object ● DomainConfig object ● FiscalYear object ● GovernanceNavigationItems object ● include directive ● InfiniteCvlPct object ● KomainuConfigInput input ● LedgerAccount object ● Liquidation object ● Me object ● PageInfo object ● PriceProvider object ● ReportDefinition object ● skip directive ● TermsTemplate object ● Time object ● User object ● VisibleNavigationItems object
ChartOfAccountsId
No description
scalar ChartOfAccountsId
Member Of
ChartOfAccounts object ● CreditFacilityModuleConfig object ● DepositAccountModuleConfig object ● FiscalYear object
CollateralId
No description
scalar CollateralId
Member Of
Collateral object ● CollateralRecordProceedsFromLiquidationInput input ● 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
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 ● PendingCreditFacility object
CreditFacilityPaymentAllocationId
No description
scalar CreditFacilityPaymentAllocationId
Member Of
CreditFacilityPaymentAllocation object
CreditFacilityProposalId
No description
scalar CreditFacilityProposalId
Member Of
creditFacilityProposal query ● CreditFacilityProposal object ● CreditFacilityProposalCustomerApprovalConcludeInput input ● creditFacilityProposalUpdated subscription
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 ● CustomerDocumentArchiveInput input ● CustomerDocumentDeleteInput input ● CustomerDocumentDeletePayload object ● CustomerDocumentDownloadLinksGenerateInput input
CustomerId
No description
scalar CustomerId
Member Of
CreditFacilityProposalCreateInput input ● customer query ● Customer object ● CustomerCloseInput input ● CustomerDocument object ● CustomerDocumentCreateInput input ● CustomerEmailUpdateInput input ● CustomerFreezeInput input ● CustomerTelegramHandleUpdateInput input ● CustomerUnfreezeInput input ● DepositAccount object ● DepositAccountCreateInput input
CVLPctValue
No description
scalar CVLPctValue
Member Of
FiniteCvlPct object ● LiquidationPaymentCalculateInput input ● TermsInput input
Date
An ISO 8601 calendar date without time or timezone (e.g., 2024-01-15). Represents a business date; timezone-naive by design.
scalar Date
Member Of
balanceSheet query ● CollateralUpdateInput input ● CreditFacilityApproved object ● CreditFacilityCollateralizationUpdated object ● CreditFacilityCollateralSentOut object ● CreditFacilityCollateralUpdated object ● CreditFacilityDisbursalExecuted object ● CreditFacilityIncrementalPayment object ● CreditFacilityInterestAccrued object ● CreditFacilityPartialPaymentWithDateRecordInput input ● CreditFacilityRepaymentAmountReceived object ● CreditFacilityRepaymentPlanEntry object ● EodProcess object ● EodProcessFilter input ● FiscalMonthClosure object ● FiscalYear object ● FiscalYearInitInput input ● LedgerManualTransactionExecuteInput input ● LedgerTransaction object ● PendingCreditFacilityCollateralizationUpdated object ● profitAndLossStatement query ● ReportRun object ● ReportRunTriggerInput input ● Time object ● trialBalance query
Decimal
No description
scalar Decimal
Member Of
LiquidationPayment object ● ManualTransactionEntryInput input
DepositAccountId
No description
scalar DepositAccountId
Member Of
Deposit object ● depositAccount query ● DepositAccount object ● DepositAccountCloseInput input ● DepositAccountFreezeInput input ● DepositAccountUnfreezeInput input ● DepositRecordInput input ● Withdrawal object ● WithdrawalInitiateInput 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
EodProcessId
No description
scalar EodProcessId
Member Of
eodProcess query ● EodProcess object
FiscalYearId
No description
scalar FiscalYearId
Member Of
fiscalYear query ● FiscalYear object ● FiscalYearCloseInput input ● FiscalYearCloseMonthInput input ● FiscalYearOpenNextInput 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 ● committees query ● creditFacilities query ● CreditFacilityInterestAccrued object ● creditFacilityProposals query ● custodians query ● customers query ● Dashboard object ● depositAccounts query ● deposits query ● disbursals query ● domainConfigs query ● Duration object ● DurationInput input ● eodProcesses query ● EventTimelineEntry object ● fiscalYears query ● ledgerEntries query ● ledgerTransactionsForTemplateCode query ● liquidations query ● pendingCreditFacilities query ● permissionSets query ● policies query ● PriceProviderManualPriceUpdateInput input ● priceProviders query ● prospects query ● reportRuns query ● roles query ● termsTemplates query ● transactionTemplates query ● users query ● withdrawals query
Json
No description
scalar Json
Member Of
DomainConfig object ● DomainConfigUpdateInput input ● EventTimelineEntry object
LedgerAccountCsvDocumentId
No description
scalar LedgerAccountCsvDocumentId
Member Of
LedgerAccountCsvDocument object ● LedgerAccountCsvDownloadLinkGenerateInput input ● LedgerAccountCsvExportUploadedPayload object
LedgerAccountId
No description
scalar LedgerAccountId
Member Of
BalanceSheetAccount object ● Collateral object ● ledgerAccount query ● LedgerAccount object ● ledgerAccountCsv query ● LedgerAccountCsvCreateInput input ● LedgerAccountCsvDocument object ● ledgerAccountCsvExportUploaded subscription ● ProfitAndLossAccount object
LedgerEntryId
No description
scalar LedgerEntryId
Member Of
LedgerEntry object
LedgerTransactionId
No description
scalar LedgerTransactionId
Member Of
CreditFacilityApproved object ● CreditFacilityCollateralSentOut object ● CreditFacilityCollateralUpdated object ● CreditFacilityDisbursalExecuted object ● CreditFacilityInterestAccrued object ● CreditFacilityRepaymentAmountReceived object ● FreezeEntry object ● ledgerTransaction query ● LedgerTransaction object ● LiquidationCollateralSent object ● LiquidationProceedsReceived object ● UnfreezeEntry object ● UnknownEntry object
LiquidationId
No description
scalar LiquidationId
Member Of
liquidation query ● Liquidation object ● LiquidationPaymentCalculateInput input
OneTimeFeeRatePct
No description
scalar OneTimeFeeRatePct
Member Of
TermsInput input ● TermValues object
PaymentAllocationId
No description
scalar PaymentAllocationId
Member Of
CreditFacilityIncrementalPayment object
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
PolicyId
No description
scalar PolicyId
Member Of
policy query ● Policy object ● PolicyCommitteeAssignInput input
PriceProviderId
No description
scalar PriceProviderId
Member Of
priceProvider query ● PriceProvider object ● PriceProviderActivateInput input ● PriceProviderDeactivateInput input
ProspectId
No description
scalar ProspectId
Member Of
prospect query ● Prospect object ● ProspectCloseInput input ● ProspectConvertInput input ● ProspectKycLinkCreateInput input ● prospectUpdated subscription
PublicId
No description
scalar PublicId
Member Of
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
ReportDefinitionId
No description
scalar ReportDefinitionId
Member Of
ReportDefinition object ● ReportRunTriggerInput input ● RequestedReport object
ReportId
No description
scalar ReportId
Member Of
Report object ● ReportFileDownloadLinkGenerateInput input
ReportRunId
No description
scalar ReportRunId
Member Of
Report object ● reportRun query ● ReportRun object
RoleId
No description
scalar RoleId
Member Of
role query ● Role object ● RolePermissionSetsAddInput input ● RolePermissionSetsRemoveInput input ● UserCreateInput input ● UserRoleUpdateInput input
Satoshis
No description
scalar Satoshis
Member Of
BtcAmount object ● BtcBalanceDetails object ● CollateralRecordSentToLiquidationInput input ● CollateralUpdateInput input ● CreditFacilityBalance object ● CreditFacilityCollateralizationUpdated object ● CreditFacilityCollateralSentOut object ● CreditFacilityCollateralUpdated object ● Dashboard object ● Liquidation object ● LiquidationCollateralSent object ● LiquidationPayment object ● LiquidationPaymentCalculateInput input ● PendingCreditFacility object ● PendingCreditFacilityCollateralizationUpdated object
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 ● KomainuConfigInput input ● SelfCustodyConfigInput input
SignedSatoshis
No description
scalar SignedSatoshis
Member Of
BtcBalanceDetails object
SignedUsdCents
No description
scalar SignedUsdCents
Member Of
UsdBalanceDetails 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
Member Of
ApprovalProcess object ● ApprovalProcessDenyInput input ● ApprovalProcessEdge object ● approvalProcesses query ● audit query ● AuditEntry object ● AuditEntryEdge object ● BalanceSheet object ● BalanceSheetAccount object ● BitgoConfigInput input ● BuildInfo object ● ChartNode object ● ChartOfAccounts object ● ChartOfAccountsAddChildNodeInput input ● Committee object ● CommitteeCreateInput input ● CommitteeEdge object ● committees query ● creditFacilities query ● CreditFacilityDisbursalEdge object ● CreditFacilityEdge object ● CreditFacilityProposalEdge object ● creditFacilityProposals query ● Custodian object ● CustodianEdge object ● custodians query ● Customer object ● customerByEmail query ● CustomerDocument object ● CustomerEdge object ● CustomerEmailUpdateInput input ● customers query ● CustomerTelegramHandleUpdateInput input ● Deposit object ● DepositAccountEdge object ● DepositAccountHistoryEntryEdge object ● depositAccounts query ● DepositEdge object ● DepositRecordInput input ● deposits query ● deprecated directive ● disbursals query ● DomainConfig object ● DomainConfigEdge object ● domainConfigs query ● EodProcess object ● EodProcessEdge object ● eodProcesses query ● EodProcessPhase object ● EventTimelineEntry object ● EventTimelineEntryEdge object ● FiscalYear object ● fiscalYearByYear query ● FiscalYearEdge object ● fiscalYears query ● KomainuConfigInput input ● LedgerAccount object ● LedgerAccountCsvDocument object ● ledgerEntries query ● LedgerEntry object ● LedgerEntryEdge object ● LedgerManualTransactionExecuteInput input ● LedgerTransaction object ● LedgerTransactionEdge object ● ledgerTransactionsForTemplateCode query ● LiquidationEdge object ● liquidations query ● ManualConfigInput input ● ManualTransactionEntryInput input ● PageInfo object ● pendingCreditFacilities query ● PendingCreditFacilityEdge object ● PermissionSet object ● PermissionSetEdge object ● permissionSets query ● PersonalInfo object ● policies query ● PolicyEdge object ● PriceProvider object ● PriceProviderEdge object ● priceProviders query ● ProfitAndLossAccount object ● ProfitAndLossStatement object ● Prospect object ● ProspectCreateInput input ● ProspectEdge object ● prospects query ● Report object ● ReportDefinition object ● ReportFile object ● ReportFileDownloadLinkGenerateInput input ● ReportRunEdge object ● reportRuns query ● RequestedReport object ● Role object ● RoleCreateInput input ● RoleEdge object ● roles query ● SelfCustodyConfigInput input ● specifiedBy directive ● System object ● TermsTemplate object ● TermsTemplateCreateInput input ● TermsTemplateEdge object ● termsTemplates query ● Time object ● TransactionTemplate object ● TransactionTemplateEdge object ● transactionTemplates query ● TrialBalance object ● User object ● UserCreateInput input ● UserEdge object ● users query ● Wallet object ● Withdrawal object ● WithdrawalEdge object ● WithdrawalInitiateInput input ● withdrawals query ● workflow_output directive ● workflow_require directive
TermsTemplateId
No description
scalar TermsTemplateId
Member Of
termsTemplate query ● TermsTemplate object ● TermsTemplateUpdateInput input
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 ● CancelledWithdrawalEntry object ● Committee object ● CreditFacility object ● CreditFacilityAgreement object ● CreditFacilityApproved object ● CreditFacilityCollateralizationUpdated object ● CreditFacilityCollateralSentOut object ● CreditFacilityCollateralUpdated object ● CreditFacilityDisbursal object ● CreditFacilityDisbursalExecuted object ● CreditFacilityIncrementalPayment object ● CreditFacilityInterestAccrued object ● CreditFacilityPaymentAllocation object ● CreditFacilityProposal object ● CreditFacilityRepaymentAmountReceived object ● CreditFacilityRepaymentPlanEntry object ● Custodian object ● Customer object ● Deposit object ● DepositAccount object ● DepositEntry object ● DisbursalEntry object ● EodProcess object ● EodProcessPhase object ● EventTimelineEntry object ● FiscalMonthClosure object ● FiscalYear object ● FreezeEntry object ● LedgerAccountCsvDocument object ● LedgerEntry object ● LedgerTransaction object ● Liquidation object ● PaymentEntry object ● PendingCreditFacility object ● PendingCreditFacilityCollateralizationUpdated object ● PriceProvider object ● Prospect object ● Report object ● ReportRun object ● Role object ● TermsTemplate object ● Time object ● UnfreezeEntry object ● UnknownEntry object ● User 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 ● CustomerDocumentDownloadLinksGeneratePayload object ● LedgerAccountCsvDownloadLinkGeneratePayload object ● ProspectKycLinkCreatePayload object ● ReportFileDownloadLinkGeneratePayload object
UsdCents
No description
scalar UsdCents
Member Of
CollateralRecordProceedsFromLiquidationInput input ● CreditFacility object ● CreditFacilityApproved object ● CreditFacilityBalance object ● CreditFacilityCollateralizationUpdated object ● CreditFacilityDisbursal object ● CreditFacilityDisbursalExecuted object ● CreditFacilityDisbursalInitiateInput input ● CreditFacilityIncrementalPayment object ● CreditFacilityInterestAccrued object ● CreditFacilityPartialPaymentRecordInput input ● CreditFacilityPartialPaymentWithDateRecordInput input ● CreditFacilityPaymentAllocation object ● CreditFacilityProposal object ● CreditFacilityProposalCreateInput input ● CreditFacilityRepaymentAmountReceived object ● CreditFacilityRepaymentPlanEntry object ● Dashboard object ● Deposit object ● DepositAccountBalance object ● DepositRecordInput input ● Disbursed object ● FreezeEntry object ● Interest object ● Liquidation object ● LiquidationPayment object ● LiquidationPaymentCalculateInput input ● LiquidationProceedsReceived object ● PendingCreditFacility object ● PendingCreditFacilityCollateralizationUpdated object ● PriceProvider object ● RealtimePrice object ● UnfreezeEntry object ● UsdAmount object ● UsdBalanceDetails object ● Withdrawal object ● WithdrawalInitiateInput input
UserId
No description
scalar UserId
Member Of
CommitteeCreateInput input ● CommitteeUserAddInput input ● CommitteeUserRemoveInput input ● user query ● User object ● UserRoleUpdateInput input
WalletId
No description
scalar WalletId
Member Of
Collateral object ● Wallet object
WithdrawalId
No description
scalar WithdrawalId
Member Of
withdrawal query ● Withdrawal object ● WithdrawalCancelInput input ● WithdrawalConfirmInput input ● WithdrawalRevertInput input ● withdrawalUpdated subscription
Yaml
No description
scalar Yaml
Returned By
appConfig query
Unions
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 | System | Customer
Possible types
AuditSubject.User object
AuditSubject.System object
AuditSubject.Customer object
Member Of
AuditEntry object ● EventTimelineEntry object ● LedgerTransaction object
ChartOfAccountsAddChildNodePayload
No description
union ChartOfAccountsAddChildNodePayload = ChartOfAccountsAddChildNodePayloadSuccess | ChartOfAccountsAddChildNodePayloadError
Possible types
ChartOfAccountsAddChildNodePayload.ChartOfAccountsAddChildNodePayloadSuccess object
ChartOfAccountsAddChildNodePayload.ChartOfAccountsAddChildNodePayloadError object
Returned By
chartOfAccountsAddChildNode mutation
CollateralRecordProceedsFromLiquidationPayload
No description
union CollateralRecordProceedsFromLiquidationPayload = CollateralRecordProceedsFromLiquidationPayloadSuccess | CollateralRecordProceedsFromLiquidationPayloadError
Possible types
CollateralRecordProceedsFromLiquidationPayload.CollateralRecordProceedsFromLiquidationPayloadSuccess object
CollateralRecordProceedsFromLiquidationPayload.CollateralRecordProceedsFromLiquidationPayloadError object
Returned By
collateralRecordProceedsFromLiquidation 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
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 | CreditFacilityRepaymentAmountReceived
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.CreditFacilityRepaymentAmountReceived object
Member Of
CreditFacility object
CustomerClosePayload
No description
union CustomerClosePayload = CustomerClosePayloadSuccess | CustomerClosePayloadError
Possible types
CustomerClosePayload.CustomerClosePayloadSuccess object
CustomerClosePayload.CustomerClosePayloadError object
Returned By
customerClose mutation
CustomerFreezePayload
No description
union CustomerFreezePayload = CustomerFreezePayloadSuccess | CustomerFreezePayloadError
Possible types
CustomerFreezePayload.CustomerFreezePayloadSuccess object
CustomerFreezePayload.CustomerFreezePayloadError object
Returned By
customerFreeze mutation
CustomerUnfreezePayload
No description
union CustomerUnfreezePayload = CustomerUnfreezePayloadSuccess | CustomerUnfreezePayloadError
Possible types
CustomerUnfreezePayload.CustomerUnfreezePayloadSuccess object
CustomerUnfreezePayload.CustomerUnfreezePayloadError object
Returned By
customerUnfreeze mutation
CvlPct
No description
union CvlPct = FiniteCvlPct | InfiniteCvlPct
Possible types
CvlPct.FiniteCvlPct object
CvlPct.InfiniteCvlPct object
Member Of
CreditFacility object ● LiquidationPayment object ● TermValues object
DepositAccountClosePayload
No description
union DepositAccountClosePayload = DepositAccountClosePayloadSuccess | DepositAccountClosePayloadError
Possible types
DepositAccountClosePayload.DepositAccountClosePayloadSuccess object
DepositAccountClosePayload.DepositAccountClosePayloadError object
Returned By
depositAccountClose 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
DepositAccountUnfreezePayload
No description
union DepositAccountUnfreezePayload = DepositAccountUnfreezePayloadSuccess | DepositAccountUnfreezePayloadError
Possible types
DepositAccountUnfreezePayload.DepositAccountUnfreezePayloadSuccess object
DepositAccountUnfreezePayload.DepositAccountUnfreezePayloadError object
Returned By
depositAccountUnfreeze mutation
DepositRecordPayload
No description
union DepositRecordPayload = DepositRecordPayloadSuccess | DepositRecordPayloadError
Possible types
DepositRecordPayload.DepositRecordPayloadSuccess object
DepositRecordPayload.DepositRecordPayloadError object
Returned By
depositRecord 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
FiscalYearOpenNextPayload
No description
union FiscalYearOpenNextPayload = FiscalYearOpenNextPayloadSuccess | FiscalYearOpenNextPayloadError
Possible types
FiscalYearOpenNextPayload.FiscalYearOpenNextPayloadSuccess object
FiscalYearOpenNextPayload.FiscalYearOpenNextPayloadError object
Returned By
fiscalYearOpenNext mutation
LedgerAccountBalanceRange
No description
union LedgerAccountBalanceRange = UsdLedgerAccountBalanceRange | BtcLedgerAccountBalanceRange
Possible types
LedgerAccountBalanceRange.UsdLedgerAccountBalanceRange object
LedgerAccountBalanceRange.BtcLedgerAccountBalanceRange object
Member Of
LedgerAccount object
LedgerAccountEntity
No description
union LedgerAccountEntity = DepositAccount | CreditFacility | Collateral
Possible types
LedgerAccountEntity.DepositAccount object
LedgerAccountEntity.CreditFacility object
LedgerAccountEntity.Collateral object
Member Of
LedgerAccount object
LedgerEntryAmount
No description
union LedgerEntryAmount = UsdAmount | BtcAmount
Possible types
LedgerEntryAmount.UsdAmount object
LedgerEntryAmount.BtcAmount object
Member Of
LedgerEntry object
LedgerManualTransactionExecutePayload
No description
union LedgerManualTransactionExecutePayload = LedgerManualTransactionExecutePayloadSuccess | LedgerManualTransactionExecutePayloadError
Possible types
LedgerManualTransactionExecutePayload.LedgerManualTransactionExecutePayloadSuccess object
LedgerManualTransactionExecutePayload.LedgerManualTransactionExecutePayloadError object
Returned By
ledgerManualTransactionExecute mutation
LedgerTransactionEntity
No description
union LedgerTransactionEntity = Deposit | Withdrawal | CreditFacilityDisbursal
Possible types
LedgerTransactionEntity.Deposit object
LedgerTransactionEntity.Withdrawal object
LedgerTransactionEntity.CreditFacilityDisbursal object
Member Of
LedgerTransaction object
ProspectClosePayload
No description
union ProspectClosePayload = ProspectClosePayloadSuccess | ProspectClosePayloadError
Possible types
ProspectClosePayload.ProspectClosePayloadSuccess object
ProspectClosePayload.ProspectClosePayloadError object
Returned By
prospectClose mutation
ProspectConvertPayload
No description
union ProspectConvertPayload = ProspectConvertPayloadSuccess | ProspectConvertPayloadError
Possible types
ProspectConvertPayload.ProspectConvertPayloadSuccess object
ProspectConvertPayload.ProspectConvertPayloadError object
Returned By
prospectConvert 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
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
TermsTemplateCreatePayload
No description
union TermsTemplateCreatePayload = TermsTemplateCreatePayloadSuccess | TermsTemplateCreatePayloadError
Possible types
TermsTemplateCreatePayload.TermsTemplateCreatePayloadSuccess object
TermsTemplateCreatePayload.TermsTemplateCreatePayloadError object
Returned By
termsTemplateCreate mutation
WithdrawalCancelPayload
No description
union WithdrawalCancelPayload = WithdrawalCancelPayloadSuccess | WithdrawalCancelPayloadError
Possible types
WithdrawalCancelPayload.WithdrawalCancelPayloadSuccess object
WithdrawalCancelPayload.WithdrawalCancelPayloadError object
Returned By
withdrawalCancel mutation
WithdrawalConfirmPayload
No description
union WithdrawalConfirmPayload = WithdrawalConfirmPayloadSuccess | WithdrawalConfirmPayloadError
Possible types
WithdrawalConfirmPayload.WithdrawalConfirmPayloadSuccess object
WithdrawalConfirmPayload.WithdrawalConfirmPayloadError object
Returned By
withdrawalConfirm mutation
WithdrawalInitiatePayload
No description
union WithdrawalInitiatePayload = WithdrawalInitiatePayloadSuccess | WithdrawalInitiatePayloadError
Possible types
WithdrawalInitiatePayload.WithdrawalInitiatePayloadSuccess object
WithdrawalInitiatePayload.WithdrawalInitiatePayloadError object
Returned By
withdrawalInitiate mutation
WithdrawalRevertPayload
No description
union WithdrawalRevertPayload = WithdrawalRevertPayloadSuccess | WithdrawalRevertPayloadError
Possible types
WithdrawalRevertPayload.WithdrawalRevertPayloadSuccess object
WithdrawalRevertPayload.WithdrawalRevertPayloadError object
Returned By
withdrawalRevert 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
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