Admin API Reference
This API reference has been automatically generated from the Admin GraphQL schema.
Queries
accountEntryCsv
No description
accountEntryCsv(
ledgerAccountId: UUID!
): AccountingCsvDocument
Arguments
accountEntryCsv.ledgerAccountId ● UUID! non-null scalar
Type
AccountingCsvDocument object
approvalProcess
No description
approvalProcess(
id: UUID!
): ApprovalProcess
Arguments
approvalProcess.id ● UUID! non-null scalar
Type
ApprovalProcess object
approvalProcesses
No description
approvalProcesses(
first: Int!
after: String
): ApprovalProcessConnection!
Arguments
approvalProcesses.first ● Int! non-null scalar
approvalProcesses.after ● String scalar
Type
ApprovalProcessConnection object
audit
No description
audit(
first: Int!
after: String
subject: AuditSubjectId
authorized: Boolean
object: String
action: String
): AuditEntryConnection!
Arguments
audit.first ● Int! non-null scalar
audit.after ● String scalar
audit.subject ● AuditSubjectId scalar
audit.authorized ● Boolean scalar
audit.object ● String scalar
audit.action ● String scalar
Type
AuditEntryConnection object
auditSubjects
No description
auditSubjects: [AuditSubjectId!]!
Type
AuditSubjectId scalar
balanceSheet
No description
balanceSheet(
from: Date!
until: Date
): BalanceSheet!
Arguments
balanceSheet.from ● Date! non-null scalar
balanceSheet.until ● Date scalar
Type
BalanceSheet object
chartOfAccounts
No description
chartOfAccounts: ChartOfAccounts!
Type
ChartOfAccounts object
committee
No description
committee(
id: UUID!
): Committee
Arguments
committee.id ● UUID! non-null scalar
Type
Committee object
committees
No description
committees(
first: Int!
after: String
): CommitteeConnection!
Arguments
committees.first ● Int! non-null scalar
committees.after ● String scalar
Type
CommitteeConnection object
creditConfig
No description
creditConfig: CreditModuleConfig
Type
CreditModuleConfig object
creditFacilities
No description
creditFacilities(
first: Int!
after: String
sort: CreditFacilitiesSort = { by: CREATED_AT, direction: ASC }
filter: CreditFacilitiesFilter
): CreditFacilityConnection!
Arguments
creditFacilities.first ● Int! non-null scalar
creditFacilities.after ● String scalar
creditFacilities.sort ● CreditFacilitiesSort input
creditFacilities.filter ● CreditFacilitiesFilter input
Type
CreditFacilityConnection object
creditFacility
No description
creditFacility(
id: UUID!
): CreditFacility
Arguments
creditFacility.id ● UUID! non-null scalar
Type
CreditFacility object
creditFacilityByPublicId
No description
creditFacilityByPublicId(
id: PublicId!
): CreditFacility
Arguments
creditFacilityByPublicId.id ● PublicId! non-null scalar
Type
CreditFacility object
creditFacilityProposal
No description
creditFacilityProposal(
id: UUID!
): CreditFacilityProposal
Arguments
creditFacilityProposal.id ● UUID! non-null scalar
Type
CreditFacilityProposal object
creditFacilityProposals
No description
creditFacilityProposals(
first: Int!
after: String
): CreditFacilityProposalConnection!
Arguments
creditFacilityProposals.first ● Int! non-null scalar
creditFacilityProposals.after ● String scalar
Type
CreditFacilityProposalConnection object
custodians
No description
custodians(
first: Int!
after: String
): CustodianConnection!
Arguments
custodians.first ● Int! non-null scalar
custodians.after ● String scalar
Type
CustodianConnection object
customer
No description
customer(
id: UUID!
): Customer
Arguments
customer.id ● UUID! non-null scalar
Type
Customer object
customerByEmail
No description
customerByEmail(
email: String!
): Customer
Arguments
customerByEmail.email ● String! non-null scalar
Type
Customer object
customerByPublicId
No description
customerByPublicId(
id: PublicId!
): Customer
Arguments
customerByPublicId.id ● PublicId! non-null scalar
Type
Customer object
customerDocument
No description
customerDocument(
id: UUID!
): CustomerDocument
Arguments
customerDocument.id ● UUID! non-null scalar
Type
CustomerDocument object
customers
No description
customers(
first: Int!
after: String
sort: CustomersSort = { by: CREATED_AT, direction: ASC }
filter: CustomersFilter
): CustomerConnection!
Arguments
customers.first ● Int! non-null scalar
customers.after ● String scalar
customers.sort ● CustomersSort input
customers.filter ● CustomersFilter input
Type
CustomerConnection object
dashboard
No description
dashboard: Dashboard!
Type
Dashboard object
deposit
No description
deposit(
id: UUID!
): Deposit
Arguments
deposit.id ● UUID! non-null scalar
Type
Deposit object
depositAccount
No description
depositAccount(
id: UUID!
): DepositAccount
Arguments
depositAccount.id ● UUID! non-null scalar
Type
DepositAccount object
depositAccountByPublicId
No description
depositAccountByPublicId(
id: PublicId!
): DepositAccount
Arguments
depositAccountByPublicId.id ● PublicId! non-null scalar
Type
DepositAccount object
depositAccounts
No description
depositAccounts(
first: Int!
after: String
): DepositAccountConnection!
Arguments
depositAccounts.first ● Int! non-null scalar
depositAccounts.after ● String scalar
Type
DepositAccountConnection object
depositByPublicId
No description
depositByPublicId(
id: PublicId!
): Deposit
Arguments
depositByPublicId.id ● PublicId! non-null scalar
Type
Deposit object
depositConfig
No description
depositConfig: DepositModuleConfig
Type
DepositModuleConfig object
deposits
No description
deposits(
first: Int!
after: String
): DepositConnection!
Arguments
deposits.first ● Int! non-null scalar
deposits.after ● String scalar
Type
DepositConnection object
descendantAccountSetsByCategory
No description
descendantAccountSetsByCategory(
category: AccountCategory!
): [AccountInfo!]!
Arguments
descendantAccountSetsByCategory.category ● AccountCategory! non-null enum
Type
AccountInfo object
disbursal
No description
disbursal(
id: UUID!
): CreditFacilityDisbursal
Arguments
disbursal.id ● UUID! non-null scalar
Type
CreditFacilityDisbursal object
disbursalByPublicId
No description
disbursalByPublicId(
id: PublicId!
): CreditFacilityDisbursal
Arguments
disbursalByPublicId.id ● PublicId! non-null scalar
Type
CreditFacilityDisbursal object
disbursals
No description
disbursals(
first: Int!
after: String
): CreditFacilityDisbursalConnection!
Arguments
disbursals.first ● Int! non-null scalar
disbursals.after ● String scalar
Type
CreditFacilityDisbursalConnection object
domainConfigs
No description
domainConfigs(
first: Int!
after: String
): DomainConfigConnection!
Arguments
domainConfigs.first ● Int! non-null scalar
domainConfigs.after ● String scalar
Type
DomainConfigConnection object
fiscalYear
No description
fiscalYear(
fiscalYearId: UUID!
): FiscalYear
Arguments
fiscalYear.fiscalYearId ● UUID! non-null scalar
Type
FiscalYear object
fiscalYearByYear
No description
fiscalYearByYear(
year: String!
): FiscalYear
Arguments
fiscalYearByYear.year ● String! non-null scalar
Type
FiscalYear object
fiscalYears
No description
fiscalYears(
first: Int!
after: String
): FiscalYearConnection!
Arguments
fiscalYears.first ● Int! non-null scalar
fiscalYears.after ● String scalar
Type
FiscalYearConnection object
journalEntries
No description
journalEntries(
first: Int!
after: String
): JournalEntryConnection!
Arguments
journalEntries.first ● Int! non-null scalar
journalEntries.after ● String scalar
Type
JournalEntryConnection object
ledgerAccount
No description
ledgerAccount(
id: UUID!
): LedgerAccount
Arguments
ledgerAccount.id ● UUID! non-null scalar
Type
LedgerAccount object
ledgerAccountByCode
No description
ledgerAccountByCode(
code: String!
): LedgerAccount
Arguments
ledgerAccountByCode.code ● String! non-null scalar
Type
LedgerAccount object
ledgerTransaction
No description
ledgerTransaction(
id: UUID!
): LedgerTransaction
Arguments
ledgerTransaction.id ● UUID! non-null scalar
Type
LedgerTransaction object
ledgerTransactionsForTemplateCode
No description
ledgerTransactionsForTemplateCode(
templateCode: String!
first: Int!
after: String
): LedgerTransactionConnection!
Arguments
ledgerTransactionsForTemplateCode.templateCode ● String! non-null scalar
ledgerTransactionsForTemplateCode.first ● Int! non-null scalar
ledgerTransactionsForTemplateCode.after ● String scalar
Type
LedgerTransactionConnection object
liquidation
No description
liquidation(
id: UUID!
): Liquidation
Arguments
liquidation.id ● UUID! non-null scalar
Type
Liquidation object
liquidations
No description
liquidations(
first: Int!
after: String
): LiquidationConnection!
Arguments
liquidations.first ● Int! non-null scalar
liquidations.after ● String scalar
Type
LiquidationConnection object
loanAgreement
No description
loanAgreement(
id: UUID!
): LoanAgreement
Arguments
loanAgreement.id ● UUID! non-null scalar
Type
LoanAgreement object
me
No description
me: Me!
Type
Me object
pendingCreditFacilities
No description
pendingCreditFacilities(
first: Int!
after: String
): PendingCreditFacilityConnection!
Arguments
pendingCreditFacilities.first ● Int! non-null scalar
pendingCreditFacilities.after ● String scalar
Type
PendingCreditFacilityConnection object
pendingCreditFacility
No description
pendingCreditFacility(
id: UUID!
): PendingCreditFacility
Arguments
pendingCreditFacility.id ● UUID! non-null scalar
Type
PendingCreditFacility object
permissionSets
No description
permissionSets(
first: Int!
after: String
): PermissionSetConnection!
Arguments
permissionSets.first ● Int! non-null scalar
permissionSets.after ● String scalar
Type
PermissionSetConnection object
policies
No description
policies(
first: Int!
after: String
): PolicyConnection!
Arguments
policies.first ● Int! non-null scalar
policies.after ● String scalar
Type
PolicyConnection object
policy
No description
policy(
id: UUID!
): Policy
Arguments
policy.id ● UUID! non-null scalar
Type
Policy object
profitAndLossStatement
No description
profitAndLossStatement(
from: Date!
until: Date
): ProfitAndLossStatement!
Arguments
profitAndLossStatement.from ● Date! non-null scalar
profitAndLossStatement.until ● Date scalar
Type
ProfitAndLossStatement object
prospect
No description
prospect(
id: UUID!
): Prospect
Arguments
prospect.id ● UUID! non-null scalar
Type
Prospect object
prospectByPublicId
No description
prospectByPublicId(
id: PublicId!
): Prospect
Arguments
prospectByPublicId.id ● PublicId! non-null scalar
Type
Prospect object
prospects
No description
prospects(
first: Int!
after: String
stage: ProspectStage
): ProspectConnection!
Arguments
prospects.first ● Int! non-null scalar
prospects.after ● String scalar
prospects.stage ● ProspectStage enum
Type
ProspectConnection object
publicIdTarget
No description
publicIdTarget(
id: PublicId!
): PublicIdTarget
Arguments
publicIdTarget.id ● PublicId! non-null scalar
Type
PublicIdTarget union
realtimePrice
No description
realtimePrice: RealtimePrice!
Type
RealtimePrice object
reportRun
No description
reportRun(
id: UUID!
): ReportRun
Arguments
reportRun.id ● UUID! non-null scalar
Type
ReportRun object
reportRuns
No description
reportRuns(
first: Int!
after: String
): ReportRunConnection!
Arguments
reportRuns.first ● Int! non-null scalar
reportRuns.after ● String scalar
Type
ReportRunConnection object
role
No description
role(
id: UUID!
): Role
Arguments
role.id ● UUID! non-null scalar
Type
Role object
roles
No description
roles(
first: Int!
after: String
): RoleConnection!
Arguments
roles.first ● Int! non-null scalar
roles.after ● String scalar
Type
RoleConnection object
termsTemplate
No description
termsTemplate(
id: UUID!
): TermsTemplate
Arguments
termsTemplate.id ● UUID! non-null scalar
Type
TermsTemplate object
termsTemplates
No description
termsTemplates: [TermsTemplate!]!
Type
TermsTemplate object
transactionTemplates
No description
transactionTemplates(
first: Int!
after: String
): TransactionTemplateConnection!
Arguments
transactionTemplates.first ● Int! non-null scalar
transactionTemplates.after ● String scalar
Type
TransactionTemplateConnection object
trialBalance
No description
trialBalance(
from: Date!
until: Date!
): TrialBalance!
Arguments
trialBalance.from ● Date! non-null scalar
trialBalance.until ● Date! non-null scalar
Type
TrialBalance object
user
No description
user(
id: UUID!
): User
Arguments
user.id ● UUID! non-null scalar
Type
User object
users
No description
users: [User!]!
Type
User object
withdrawal
No description
withdrawal(
id: UUID!
): Withdrawal
Arguments
withdrawal.id ● UUID! non-null scalar
Type
Withdrawal object
withdrawalByPublicId
No description
withdrawalByPublicId(
id: PublicId!
): Withdrawal
Arguments
withdrawalByPublicId.id ● PublicId! non-null scalar
Type
Withdrawal object
withdrawals
No description
withdrawals(
first: Int!
after: String
): WithdrawalConnection!
Arguments
withdrawals.first ● Int! non-null scalar
withdrawals.after ● String scalar
Type
WithdrawalConnection object
Mutations
accountingCsvDownloadLinkGenerate
No description
accountingCsvDownloadLinkGenerate(
input: AccountingCsvDownloadLinkGenerateInput!
): AccountingCsvDownloadLinkGeneratePayload!
Arguments
accountingCsvDownloadLinkGenerate.input ● AccountingCsvDownloadLinkGenerateInput! non-null input
Type
AccountingCsvDownloadLinkGeneratePayload object
approvalProcessApprove
No description
approvalProcessApprove(
input: ApprovalProcessApproveInput!
): ApprovalProcessApprovePayload!
Arguments
approvalProcessApprove.input ● ApprovalProcessApproveInput! non-null input
Type
ApprovalProcessApprovePayload object
approvalProcessDeny
No description
approvalProcessDeny(
input: ApprovalProcessDenyInput!
reason: String!
): ApprovalProcessDenyPayload!
Arguments
approvalProcessDeny.input ● ApprovalProcessDenyInput! non-null input
approvalProcessDeny.reason ● String! non-null scalar
Type
ApprovalProcessDenyPayload object
chartOfAccountsAddChildNode
No description
chartOfAccountsAddChildNode(
input: ChartOfAccountsAddChildNodeInput!
): ChartOfAccountsAddChildNodePayload!
Arguments
chartOfAccountsAddChildNode.input ● ChartOfAccountsAddChildNodeInput! non-null input
Type
ChartOfAccountsAddChildNodePayload object
chartOfAccountsAddRootNode
No description
chartOfAccountsAddRootNode(
input: ChartOfAccountsAddRootNodeInput!
): ChartOfAccountsAddRootNodePayload!
Arguments
chartOfAccountsAddRootNode.input ● ChartOfAccountsAddRootNodeInput! non-null input
Type
ChartOfAccountsAddRootNodePayload object
chartOfAccountsCsvImport
No description
chartOfAccountsCsvImport(
input: ChartOfAccountsCsvImportInput!
): ChartOfAccountsCsvImportPayload!
Arguments
chartOfAccountsCsvImport.input ● ChartOfAccountsCsvImportInput! non-null input
Type
ChartOfAccountsCsvImportPayload object
chartOfAccountsCsvImportWithBaseConfig
No description
chartOfAccountsCsvImportWithBaseConfig(
input: ChartOfAccountsCsvImportWithBaseConfigInput!
): ChartOfAccountsCsvImportWithBaseConfigPayload!
Arguments
chartOfAccountsCsvImportWithBaseConfig.input ● ChartOfAccountsCsvImportWithBaseConfigInput! non-null input
Type
ChartOfAccountsCsvImportWithBaseConfigPayload object
collateralRecordProceedsFromLiquidation
No description
collateralRecordProceedsFromLiquidation(
input: CollateralRecordProceedsFromLiquidationInput!
): CollateralRecordProceedsFromLiquidationPayload!
Arguments
collateralRecordProceedsFromLiquidation.input ● CollateralRecordProceedsFromLiquidationInput! non-null input
Type
CollateralRecordProceedsFromLiquidationPayload object
collateralRecordSentToLiquidation
No description
collateralRecordSentToLiquidation(
input: CollateralRecordSentToLiquidationInput!
): CollateralRecordSentToLiquidationPayload!
Arguments
collateralRecordSentToLiquidation.input ● CollateralRecordSentToLiquidationInput! non-null input
Type
CollateralRecordSentToLiquidationPayload object
collateralUpdate
No description
collateralUpdate(
input: CollateralUpdateInput!
): CollateralUpdatePayload!
Arguments
collateralUpdate.input ● CollateralUpdateInput! non-null input
Type
CollateralUpdatePayload object
committeeAddUser
No description
committeeAddUser(
input: CommitteeAddUserInput!
): CommitteeAddUserPayload!
Arguments
committeeAddUser.input ● CommitteeAddUserInput! non-null input
Type
CommitteeAddUserPayload object
committeeCreate
No description
committeeCreate(
input: CommitteeCreateInput!
): CommitteeCreatePayload!
Arguments
committeeCreate.input ● CommitteeCreateInput! non-null input
Type
CommitteeCreatePayload object
committeeRemoveUser
No description
committeeRemoveUser(
input: CommitteeRemoveUserInput!
): CommitteeRemoveUserPayload!
Arguments
committeeRemoveUser.input ● CommitteeRemoveUserInput! non-null input
Type
CommitteeRemoveUserPayload object
creditFacilityComplete
No description
creditFacilityComplete(
input: CreditFacilityCompleteInput!
): CreditFacilityCompletePayload!
Arguments
creditFacilityComplete.input ● CreditFacilityCompleteInput! non-null input
Type
CreditFacilityCompletePayload object
creditFacilityDisbursalInitiate
No description
creditFacilityDisbursalInitiate(
input: CreditFacilityDisbursalInitiateInput!
): CreditFacilityDisbursalInitiatePayload!
Arguments
creditFacilityDisbursalInitiate.input ● CreditFacilityDisbursalInitiateInput! non-null input
Type
CreditFacilityDisbursalInitiatePayload object
creditFacilityPartialPaymentRecord
No description
creditFacilityPartialPaymentRecord(
input: CreditFacilityPartialPaymentRecordInput!
): CreditFacilityPartialPaymentRecordPayload!
Arguments
creditFacilityPartialPaymentRecord.input ● CreditFacilityPartialPaymentRecordInput! non-null input
Type
CreditFacilityPartialPaymentRecordPayload object
creditFacilityPartialPaymentWithDateRecord
No description
creditFacilityPartialPaymentWithDateRecord(
input: CreditFacilityPartialPaymentWithDateRecordInput!
): CreditFacilityPartialPaymentRecordPayload!
Arguments
creditFacilityPartialPaymentWithDateRecord.input ● CreditFacilityPartialPaymentWithDateRecordInput! non-null input
Type
CreditFacilityPartialPaymentRecordPayload object
creditFacilityProposalCreate
No description
creditFacilityProposalCreate(
input: CreditFacilityProposalCreateInput!
): CreditFacilityProposalCreatePayload!
Arguments
creditFacilityProposalCreate.input ● CreditFacilityProposalCreateInput! non-null input
Type
CreditFacilityProposalCreatePayload object
creditFacilityProposalCustomerApprovalConclude
No description
creditFacilityProposalCustomerApprovalConclude(
input: CreditFacilityProposalCustomerApprovalConcludeInput!
): CreditFacilityProposalCustomerApprovalConcludePayload!
Arguments
creditFacilityProposalCustomerApprovalConclude.input ● CreditFacilityProposalCustomerApprovalConcludeInput! non-null input
Type
CreditFacilityProposalCustomerApprovalConcludePayload object
creditModuleConfigure
No description
creditModuleConfigure(
input: CreditModuleConfigureInput!
): CreditModuleConfigurePayload!
Arguments
creditModuleConfigure.input ● CreditModuleConfigureInput! non-null input
Type
CreditModuleConfigurePayload object
custodianConfigUpdate
No description
custodianConfigUpdate(
input: CustodianConfigUpdateInput!
): CustodianConfigUpdatePayload!
Arguments
custodianConfigUpdate.input ● CustodianConfigUpdateInput! non-null input
Type
CustodianConfigUpdatePayload object
custodianCreate
No description
custodianCreate(
input: CustodianCreateInput!
): CustodianCreatePayload!
Arguments
custodianCreate.input ● CustodianCreateInput! non-null input
Type
CustodianCreatePayload object
customerDocumentArchive
No description
customerDocumentArchive(
input: CustomerDocumentArchiveInput!
): CustomerDocumentArchivePayload!
Arguments
customerDocumentArchive.input ● CustomerDocumentArchiveInput! non-null input
Type
CustomerDocumentArchivePayload object
customerDocumentAttach
No description
customerDocumentAttach(
input: CustomerDocumentCreateInput!
): CustomerDocumentCreatePayload!
Arguments
customerDocumentAttach.input ● CustomerDocumentCreateInput! non-null input
Type
CustomerDocumentCreatePayload object
customerDocumentDelete
No description
customerDocumentDelete(
input: CustomerDocumentDeleteInput!
): CustomerDocumentDeletePayload!
Arguments
customerDocumentDelete.input ● CustomerDocumentDeleteInput! non-null input
Type
CustomerDocumentDeletePayload object
customerDocumentDownloadLinkGenerate
No description
customerDocumentDownloadLinkGenerate(
input: CustomerDocumentDownloadLinksGenerateInput!
): CustomerDocumentDownloadLinksGeneratePayload!
Arguments
customerDocumentDownloadLinkGenerate.input ● CustomerDocumentDownloadLinksGenerateInput! non-null input
Type
CustomerDocumentDownloadLinksGeneratePayload object
customerEmailUpdate
No description
customerEmailUpdate(
input: CustomerEmailUpdateInput!
): CustomerEmailUpdatePayload!
Arguments
customerEmailUpdate.input ● CustomerEmailUpdateInput! non-null input
Type
CustomerEmailUpdatePayload object
customerTelegramHandleUpdate
No description
customerTelegramHandleUpdate(
input: CustomerTelegramHandleUpdateInput!
): CustomerTelegramHandleUpdatePayload!
Arguments
customerTelegramHandleUpdate.input ● CustomerTelegramHandleUpdateInput! non-null input
Type
CustomerTelegramHandleUpdatePayload object
depositAccountClose
No description
depositAccountClose(
input: DepositAccountCloseInput!
): DepositAccountClosePayload!
Arguments
depositAccountClose.input ● DepositAccountCloseInput! non-null input
Type
DepositAccountClosePayload object
depositAccountCreate
No description
depositAccountCreate(
input: DepositAccountCreateInput!
): DepositAccountCreatePayload!
Arguments
depositAccountCreate.input ● DepositAccountCreateInput! non-null input
Type
DepositAccountCreatePayload object
depositAccountFreeze
No description
depositAccountFreeze(
input: DepositAccountFreezeInput!
): DepositAccountFreezePayload!
Arguments
depositAccountFreeze.input ● DepositAccountFreezeInput! non-null input
Type
DepositAccountFreezePayload object
depositAccountUnfreeze
No description
depositAccountUnfreeze(
input: DepositAccountUnfreezeInput!
): DepositAccountUnfreezePayload!
Arguments
depositAccountUnfreeze.input ● DepositAccountUnfreezeInput! non-null input
Type
DepositAccountUnfreezePayload object
depositModuleConfigure
No description
depositModuleConfigure(
input: DepositModuleConfigureInput!
): DepositModuleConfigurePayload!
Arguments
depositModuleConfigure.input ● DepositModuleConfigureInput! non-null input
Type
DepositModuleConfigurePayload object
depositRecord
No description
depositRecord(
input: DepositRecordInput!
): DepositRecordPayload!
Arguments
depositRecord.input ● DepositRecordInput! non-null input
Type
DepositRecordPayload object
depositRevert
No description
depositRevert(
input: DepositRevertInput!
): DepositRevertPayload!
Arguments
depositRevert.input ● DepositRevertInput! non-null input
Type
DepositRevertPayload object
domainConfigUpdate
No description
domainConfigUpdate(
input: DomainConfigUpdateInput!
): DomainConfigUpdatePayload!
Arguments
domainConfigUpdate.input ● DomainConfigUpdateInput! non-null input
Type
DomainConfigUpdatePayload object
fiscalYearClose
No description
fiscalYearClose(
input: FiscalYearCloseInput!
): FiscalYearClosePayload!
Arguments
fiscalYearClose.input ● FiscalYearCloseInput! non-null input
Type
FiscalYearClosePayload object
fiscalYearCloseMonth
No description
fiscalYearCloseMonth(
input: FiscalYearCloseMonthInput!
): FiscalYearCloseMonthPayload!
Arguments
fiscalYearCloseMonth.input ● FiscalYearCloseMonthInput! non-null input
Type
FiscalYearCloseMonthPayload object
fiscalYearInit
No description
fiscalYearInit(
input: FiscalYearInitInput!
): FiscalYearInitPayload!
Arguments
fiscalYearInit.input ● FiscalYearInitInput! non-null input
Type
FiscalYearInitPayload object
fiscalYearOpenNext
No description
fiscalYearOpenNext(
input: FiscalYearOpenNextInput!
): FiscalYearOpenNextPayload!
Arguments
fiscalYearOpenNext.input ● FiscalYearOpenNextInput! non-null input
Type
FiscalYearOpenNextPayload object
ledgerAccountCsvCreate
No description
ledgerAccountCsvCreate(
input: LedgerAccountCsvCreateInput!
): LedgerAccountCsvCreatePayload!
Arguments
ledgerAccountCsvCreate.input ● LedgerAccountCsvCreateInput! non-null input
Type
LedgerAccountCsvCreatePayload object
loanAgreementDownloadLinkGenerate
No description
loanAgreementDownloadLinkGenerate(
input: LoanAgreementDownloadLinksGenerateInput!
): LoanAgreementDownloadLinksGeneratePayload!
Arguments
loanAgreementDownloadLinkGenerate.input ● LoanAgreementDownloadLinksGenerateInput! non-null input
Type
LoanAgreementDownloadLinksGeneratePayload object
loanAgreementGenerate
No description
loanAgreementGenerate(
input: LoanAgreementGenerateInput!
): LoanAgreementGeneratePayload!
Arguments
loanAgreementGenerate.input ● LoanAgreementGenerateInput! non-null input
Type
LoanAgreementGeneratePayload object
manualTransactionExecute
No description
manualTransactionExecute(
input: ManualTransactionExecuteInput!
): ManualTransactionExecutePayload!
Arguments
manualTransactionExecute.input ● ManualTransactionExecuteInput! non-null input
Type
ManualTransactionExecutePayload object
policyAssignCommittee
No description
policyAssignCommittee(
input: PolicyAssignCommitteeInput!
): PolicyAssignCommitteePayload!
Arguments
policyAssignCommittee.input ● PolicyAssignCommitteeInput! non-null input
Type
PolicyAssignCommitteePayload object
prospectClose
No description
prospectClose(
input: ProspectCloseInput!
): ProspectClosePayload!
Arguments
prospectClose.input ● ProspectCloseInput! non-null input
Type
ProspectClosePayload object
prospectConvert
No description
prospectConvert(
input: ProspectConvertInput!
): ProspectConvertPayload!
Arguments
prospectConvert.input ● ProspectConvertInput! non-null input
Type
ProspectConvertPayload object
prospectCreate
No description
prospectCreate(
input: ProspectCreateInput!
): ProspectCreatePayload!
Arguments
prospectCreate.input ● ProspectCreateInput! non-null input
Type
ProspectCreatePayload object
reportFileGenerateDownloadLink
No description
reportFileGenerateDownloadLink(
input: ReportFileGenerateDownloadLinkInput!
): ReportFileGenerateDownloadLinkPayload!
Arguments
reportFileGenerateDownloadLink.input ● ReportFileGenerateDownloadLinkInput! non-null input
Type
ReportFileGenerateDownloadLinkPayload object
roleAddPermissionSets
No description
roleAddPermissionSets(
input: RoleAddPermissionSetsInput!
): RoleAddPermissionSetsPayload!
Arguments
roleAddPermissionSets.input ● RoleAddPermissionSetsInput! non-null input
Type
RoleAddPermissionSetsPayload object
roleCreate
No description
roleCreate(
input: RoleCreateInput!
): RoleCreatePayload!
Arguments
roleCreate.input ● RoleCreateInput! non-null input
Type
RoleCreatePayload object
roleRemovePermissionSets
No description
roleRemovePermissionSets(
input: RoleRemovePermissionSetsInput!
): RoleRemovePermissionSetsPayload!
Arguments
roleRemovePermissionSets.input ● RoleRemovePermissionSetsInput! non-null input
Type
RoleRemovePermissionSetsPayload object
sumsubPermalinkCreate
No description
sumsubPermalinkCreate(
input: SumsubPermalinkCreateInput!
): SumsubPermalinkCreatePayload!
Arguments
sumsubPermalinkCreate.input ● SumsubPermalinkCreateInput! non-null input
Type
SumsubPermalinkCreatePayload object
termsTemplateCreate
No description
termsTemplateCreate(
input: TermsTemplateCreateInput!
): TermsTemplateCreatePayload!
Arguments
termsTemplateCreate.input ● TermsTemplateCreateInput! non-null input
Type
TermsTemplateCreatePayload object
termsTemplateUpdate
No description
termsTemplateUpdate(
input: TermsTemplateUpdateInput!
): TermsTemplateUpdatePayload!
Arguments
termsTemplateUpdate.input ● TermsTemplateUpdateInput! non-null input
Type
TermsTemplateUpdatePayload object
triggerReportRun
No description
triggerReportRun: ReportRunCreatePayload!
Type
ReportRunCreatePayload object
userCreate
No description
userCreate(
input: UserCreateInput!
): UserCreatePayload!
Arguments
userCreate.input ● UserCreateInput! non-null input
Type
UserCreatePayload object
userUpdateRole
No description
userUpdateRole(
input: UserUpdateRoleInput!
): UserUpdateRolePayload!
Arguments
userUpdateRole.input ● UserUpdateRoleInput! non-null input
Type
UserUpdateRolePayload object
withdrawalCancel
No description
withdrawalCancel(
input: WithdrawalCancelInput!
): WithdrawalCancelPayload!
Arguments
withdrawalCancel.input ● WithdrawalCancelInput! non-null input
Type
WithdrawalCancelPayload object
withdrawalConfirm
No description
withdrawalConfirm(
input: WithdrawalConfirmInput!
): WithdrawalConfirmPayload!
Arguments
withdrawalConfirm.input ● WithdrawalConfirmInput! non-null input
Type
WithdrawalConfirmPayload object
withdrawalInitiate
No description
withdrawalInitiate(
input: WithdrawalInitiateInput!
): WithdrawalInitiatePayload!
Arguments
withdrawalInitiate.input ● WithdrawalInitiateInput! non-null input
Type
WithdrawalInitiatePayload object
withdrawalRevert
No description
withdrawalRevert(
input: WithdrawalRevertInput!
): WithdrawalRevertPayload!
Arguments
withdrawalRevert.input ● WithdrawalRevertInput! non-null input
Type
WithdrawalRevertPayload object
Subscriptions
creditFacilityCollateralizationUpdated
No description
creditFacilityCollateralizationUpdated(
creditFacilityId: UUID!
): CreditFacilityCollateralizationPayload!
Arguments
creditFacilityCollateralizationUpdated.creditFacilityId ● UUID! non-null scalar
Type
CreditFacilityCollateralizationPayload object
creditFacilityProposalConcluded
No description
creditFacilityProposalConcluded(
creditFacilityProposalId: UUID!
): CreditFacilityProposalConcludedPayload!
Arguments
creditFacilityProposalConcluded.creditFacilityProposalId ● UUID! non-null scalar
Type
CreditFacilityProposalConcludedPayload object
ledgerAccountCsvExportUploaded
No description
ledgerAccountCsvExportUploaded(
ledgerAccountId: UUID!
): LedgerAccountCsvExportUploadedPayload!
Arguments
ledgerAccountCsvExportUploaded.ledgerAccountId ● UUID! non-null scalar
Type
LedgerAccountCsvExportUploadedPayload object
pendingCreditFacilityCollateralizationUpdated
No description
pendingCreditFacilityCollateralizationUpdated(
pendingCreditFacilityId: UUID!
): PendingCreditFacilityCollateralizationPayload!
Arguments
pendingCreditFacilityCollateralizationUpdated.pendingCreditFacilityId ● UUID! non-null scalar
Type
PendingCreditFacilityCollateralizationPayload object
pendingCreditFacilityCompleted
No description
pendingCreditFacilityCompleted(
pendingCreditFacilityId: UUID!
): PendingCreditFacilityCompletedPayload!
Arguments
pendingCreditFacilityCompleted.pendingCreditFacilityId ● UUID! non-null scalar
Type
PendingCreditFacilityCompletedPayload object
realtimePriceUpdated
No description
realtimePriceUpdated: RealtimePrice!
Type
RealtimePrice object
reportRunUpdated
No description
reportRunUpdated: ReportRunUpdatedPayload!
Type
ReportRunUpdatedPayload 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
AccountInfo
No description
type AccountInfo {
accountSetId: UUID!
code: AccountCode!
name: String!
}
Fields
AccountInfo.accountSetId ● UUID! non-null scalar
AccountInfo.code ● AccountCode! non-null scalar
AccountInfo.name ● String! non-null scalar
Returned By
descendantAccountSetsByCategory query
AccountingBaseConfigOutput
No description
type AccountingBaseConfigOutput {
assetsCode: String!
liabilitiesCode: String!
equityCode: String!
equityRetainedEarningsGainCode: String!
equityRetainedEarningsLossCode: String!
revenueCode: String!
costOfRevenueCode: String!
expensesCode: String!
}
Fields
AccountingBaseConfigOutput.assetsCode ● String! non-null scalar
AccountingBaseConfigOutput.liabilitiesCode ● String! non-null scalar
AccountingBaseConfigOutput.equityCode ● String! non-null scalar
AccountingBaseConfigOutput.equityRetainedEarningsGainCode ● String! non-null scalar
AccountingBaseConfigOutput.equityRetainedEarningsLossCode ● String! non-null scalar
AccountingBaseConfigOutput.revenueCode ● String! non-null scalar
AccountingBaseConfigOutput.costOfRevenueCode ● String! non-null scalar
AccountingBaseConfigOutput.expensesCode ● String! non-null scalar
Member Of
ChartOfAccounts object
AccountingCsvDocument
No description
type AccountingCsvDocument {
id: ID!
documentId: UUID!
ledgerAccountId: UUID!
status: DocumentStatus!
createdAt: Timestamp!
filename: String!
}
Fields
AccountingCsvDocument.id ● ID! non-null scalar
AccountingCsvDocument.documentId ● UUID! non-null scalar
AccountingCsvDocument.ledgerAccountId ● UUID! non-null scalar
AccountingCsvDocument.status ● DocumentStatus! non-null enum
AccountingCsvDocument.createdAt ● Timestamp! non-null scalar
AccountingCsvDocument.filename ● String! non-null scalar
Returned By
accountEntryCsv query
Member Of
LedgerAccountCsvCreatePayload object
AccountingCsvDownloadLink
No description
type AccountingCsvDownloadLink {
url: String!
csvId: UUID!
}
Fields
AccountingCsvDownloadLink.url ● String! non-null scalar
AccountingCsvDownloadLink.csvId ● UUID! non-null scalar
Member Of
AccountingCsvDownloadLinkGeneratePayload object
AccountingCsvDownloadLinkGeneratePayload
No description
type AccountingCsvDownloadLinkGeneratePayload {
link: AccountingCsvDownloadLink!
}
Fields
AccountingCsvDownloadLinkGeneratePayload.link ● AccountingCsvDownloadLink! non-null object
Returned By
accountingCsvDownloadLinkGenerate mutation
ApprovalProcess
No description
type ApprovalProcess {
id: ID!
approvalProcessId: UUID!
approvalProcessType: ApprovalProcessType!
status: ApprovalProcessStatus!
createdAt: Timestamp!
rules: ApprovalRules!
deniedReason: String
policy: Policy!
userCanSubmitDecision: Boolean!
voters: [ApprovalProcessVoter!]!
target: ApprovalProcessTarget!
}
Fields
ApprovalProcess.id ● ID! non-null scalar
ApprovalProcess.approvalProcessId ● UUID! non-null scalar
ApprovalProcess.approvalProcessType ● ApprovalProcessType! non-null enum
ApprovalProcess.status ● ApprovalProcessStatus! non-null enum
ApprovalProcess.createdAt ● Timestamp! non-null scalar
ApprovalProcess.rules ● ApprovalRules! non-null union
ApprovalProcess.deniedReason ● String scalar
ApprovalProcess.policy ● Policy! non-null object
ApprovalProcess.userCanSubmitDecision ● Boolean! non-null scalar
ApprovalProcess.voters ● [ApprovalProcessVoter!]! non-null object
ApprovalProcess.target ● ApprovalProcessTarget! non-null union
Returned By
approvalProcess query
Member Of
ApprovalProcessApprovePayload object ● ApprovalProcessConnection object ● ApprovalProcessDenyPayload object ● ApprovalProcessEdge object ● CreditFacilityDisbursal object ● CreditFacilityProposal object ● PendingCreditFacility object ● Withdrawal object
ApprovalProcessApprovePayload
No description
type ApprovalProcessApprovePayload {
approvalProcess: ApprovalProcess!
}
Fields
ApprovalProcessApprovePayload.approvalProcess ● ApprovalProcess! non-null object
Returned By
approvalProcessApprove mutation
ApprovalProcessConnection
No description
type ApprovalProcessConnection {
pageInfo: PageInfo!
edges: [ApprovalProcessEdge!]!
nodes: [ApprovalProcess!]!
}
Fields
ApprovalProcessConnection.pageInfo ● PageInfo! non-null object
Information to aid in pagination.
ApprovalProcessConnection.edges ● [ApprovalProcessEdge!]! non-null object
A list of edges.
ApprovalProcessConnection.nodes ● [ApprovalProcess!]! non-null object
A list of nodes.
Returned By
approvalProcesses query
ApprovalProcessDenyPayload
No description
type ApprovalProcessDenyPayload {
approvalProcess: ApprovalProcess!
}
Fields
ApprovalProcessDenyPayload.approvalProcess ● ApprovalProcess! non-null object
Returned By
approvalProcessDeny mutation
ApprovalProcessEdge
An edge in a connection.
type ApprovalProcessEdge {
node: ApprovalProcess!
cursor: String!
}
Fields
ApprovalProcessEdge.node ● ApprovalProcess! non-null object
The item at the end of the edge
ApprovalProcessEdge.cursor ● String! non-null scalar
A cursor for use in pagination
Member Of
ApprovalProcessConnection object
ApprovalProcessVoter
No description
type ApprovalProcessVoter {
stillEligible: Boolean!
didVote: Boolean!
didApprove: Boolean!
didDeny: Boolean!
votedAt: Timestamp
user: User!
}
Fields
ApprovalProcessVoter.stillEligible ● Boolean! non-null scalar
ApprovalProcessVoter.didVote ● Boolean! non-null scalar
ApprovalProcessVoter.didApprove ● Boolean! non-null scalar
ApprovalProcessVoter.didDeny ● Boolean! non-null scalar
ApprovalProcessVoter.votedAt ● Timestamp scalar
ApprovalProcessVoter.user ● User! non-null object
Member Of
ApprovalProcess object
AuditEntry
No description
type AuditEntry {
id: ID!
auditEntryId: AuditEntryId!
object: String!
action: String!
authorized: Boolean!
recordedAt: Timestamp!
subject: AuditSubject!
}
Fields
AuditEntry.id ● ID! non-null scalar
AuditEntry.auditEntryId ● AuditEntryId! non-null scalar
AuditEntry.object ● String! non-null scalar
AuditEntry.action ● String! non-null scalar
AuditEntry.authorized ● Boolean! 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 {
pageInfo: PageInfo!
edges: [AuditEntryEdge!]!
nodes: [AuditEntry!]!
}
Fields
AuditEntryConnection.pageInfo ● PageInfo! non-null object
Information to aid in pagination.
AuditEntryConnection.edges ● [AuditEntryEdge!]! non-null object
A list of edges.
AuditEntryConnection.nodes ● [AuditEntry!]! non-null object
A list of nodes.
Returned By
audit query
AuditEntryEdge
An edge in a connection.
type AuditEntryEdge {
node: AuditEntry!
cursor: String!
}
Fields
AuditEntryEdge.node ● AuditEntry! non-null object
The item at the end of the edge
AuditEntryEdge.cursor ● String! non-null scalar
A cursor for use in pagination
Member Of
AuditEntryConnection object
BalanceSheet
No description
type BalanceSheet {
name: String!
balance: LedgerAccountBalanceRange!
categories: [LedgerAccount!]!
}
Fields
BalanceSheet.name ● String! non-null scalar
BalanceSheet.balance ● LedgerAccountBalanceRange! non-null union
BalanceSheet.categories ● [LedgerAccount!]! non-null object
Returned By
balanceSheet query
BtcAmount
No description
type BtcAmount {
btc: Satoshis!
}
Fields
BtcAmount.btc ● Satoshis! non-null scalar
Implemented By
JournalEntryAmount union
BtcBalanceDetails
No description
type BtcBalanceDetails {
debit: Satoshis!
credit: Satoshis!
net: SignedSatoshis!
}
Fields
BtcBalanceDetails.debit ● Satoshis! non-null scalar
BtcBalanceDetails.credit ● Satoshis! non-null scalar
BtcBalanceDetails.net ● SignedSatoshis! non-null scalar
Member Of
BtcLedgerAccountBalance object
BtcLedgerAccountBalance
No description
type BtcLedgerAccountBalance {
settled: BtcBalanceDetails!
pending: BtcBalanceDetails!
encumbrance: BtcBalanceDetails!
}
Fields
BtcLedgerAccountBalance.settled ● BtcBalanceDetails! non-null object
BtcLedgerAccountBalance.pending ● BtcBalanceDetails! non-null object
BtcLedgerAccountBalance.encumbrance ● BtcBalanceDetails! non-null object
Member Of
BtcLedgerAccountBalanceRange object
BtcLedgerAccountBalanceRange
No description
type BtcLedgerAccountBalanceRange {
open: BtcLedgerAccountBalance!
periodActivity: BtcLedgerAccountBalance!
close: BtcLedgerAccountBalance!
}
Fields
BtcLedgerAccountBalanceRange.open ● BtcLedgerAccountBalance! non-null object
BtcLedgerAccountBalanceRange.periodActivity ● BtcLedgerAccountBalance! non-null object
BtcLedgerAccountBalanceRange.close ● BtcLedgerAccountBalance! non-null object
Member Of
LedgerAccountBalanceRangeByCurrency object
Implemented By
LedgerAccountBalanceRange union
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 {
name: String!
accountCode: AccountCode!
children: [ChartNode!]!
}
Fields
ChartNode.name ● String! non-null scalar
ChartNode.accountCode ● AccountCode! non-null scalar
ChartNode.children ● [ChartNode!]! non-null object
Member Of
ChartNode object ● ChartOfAccounts object
ChartOfAccounts
No description
type ChartOfAccounts {
id: ID!
chartId: UUID!
name: String!
children: [ChartNode!]!
accountingBaseConfig: AccountingBaseConfigOutput
}
Fields
ChartOfAccounts.id ● ID! non-null scalar
ChartOfAccounts.chartId ● UUID! non-null scalar
ChartOfAccounts.name ● String! non-null scalar
ChartOfAccounts.children ● [ChartNode!]! non-null object
ChartOfAccounts.accountingBaseConfig ● AccountingBaseConfigOutput object
Returned By
chartOfAccounts query
Member Of
ChartOfAccountsAddChildNodePayload object ● ChartOfAccountsAddRootNodePayload object ● ChartOfAccountsCsvImportPayload object ● ChartOfAccountsCsvImportWithBaseConfigPayload object
ChartOfAccountsAddChildNodePayload
No description
type ChartOfAccountsAddChildNodePayload {
chartOfAccounts: ChartOfAccounts!
}
Fields
ChartOfAccountsAddChildNodePayload.chartOfAccounts ● ChartOfAccounts! non-null object
Returned By
chartOfAccountsAddChildNode mutation
ChartOfAccountsAddRootNodePayload
No description
type ChartOfAccountsAddRootNodePayload {
chartOfAccounts: ChartOfAccounts!
}
Fields
ChartOfAccountsAddRootNodePayload.chartOfAccounts ● ChartOfAccounts! non-null object
Returned By
chartOfAccountsAddRootNode mutation
ChartOfAccountsCsvImportPayload
No description
type ChartOfAccountsCsvImportPayload {
chartOfAccounts: ChartOfAccounts!
}
Fields
ChartOfAccountsCsvImportPayload.chartOfAccounts ● ChartOfAccounts! non-null object
Returned By
chartOfAccountsCsvImport mutation
ChartOfAccountsCsvImportWithBaseConfigPayload
No description
type ChartOfAccountsCsvImportWithBaseConfigPayload {
chartOfAccounts: ChartOfAccounts!
}
Fields
ChartOfAccountsCsvImportWithBaseConfigPayload.chartOfAccounts ● ChartOfAccounts! non-null object
Returned By
chartOfAccountsCsvImportWithBaseConfig mutation
Collateral
No description
type Collateral {
id: ID!
collateralId: UUID!
walletId: UUID
accountId: UUID!
account: LedgerAccount!
creditFacility: CreditFacility
}
Fields
Collateral.id ● ID! non-null scalar
Collateral.collateralId ● UUID! non-null scalar
Collateral.walletId ● UUID scalar
Collateral.accountId ● UUID! non-null scalar
Collateral.account ● LedgerAccount! non-null object
Collateral.creditFacility ● CreditFacility object
Member Of
CollateralRecordProceedsFromLiquidationPayload object ● CollateralRecordSentToLiquidationPayload object ● CollateralUpdatePayload object ● Liquidation object
Implemented By
LedgerAccountEntity union
CollateralBalance
No description
type CollateralBalance {
btcBalance: Satoshis!
}
Fields
CollateralBalance.btcBalance ● Satoshis! non-null scalar
Member Of
CreditFacilityBalance object ● PendingCreditFacility object
CollateralRecordProceedsFromLiquidationPayload
No description
type CollateralRecordProceedsFromLiquidationPayload {
collateral: Collateral!
}
Fields
CollateralRecordProceedsFromLiquidationPayload.collateral ● Collateral! non-null object
Returned By
collateralRecordProceedsFromLiquidation mutation
CollateralRecordSentToLiquidationPayload
No description
type CollateralRecordSentToLiquidationPayload {
collateral: Collateral!
}
Fields
CollateralRecordSentToLiquidationPayload.collateral ● Collateral! non-null object
Returned By
collateralRecordSentToLiquidation mutation
CollateralUpdatePayload
No description
type CollateralUpdatePayload {
collateral: Collateral!
}
Fields
CollateralUpdatePayload.collateral ● Collateral! non-null object
Returned By
collateralUpdate mutation
Committee
No description
type Committee {
id: ID!
committeeId: UUID!
createdAt: Timestamp!
name: String!
currentMembers: [User!]!
}
Fields
Committee.id ● ID! non-null scalar
Committee.committeeId ● UUID! non-null scalar
Committee.createdAt ● Timestamp! non-null scalar
Committee.name ● String! non-null scalar
Committee.currentMembers ● [User!]! non-null object
Returned By
committee query
Member Of
CommitteeAddUserPayload object ● CommitteeConnection object ● CommitteeCreatePayload object ● CommitteeEdge object ● CommitteeRemoveUserPayload object ● CommitteeThreshold object
CommitteeAddUserPayload
No description
type CommitteeAddUserPayload {
committee: Committee!
}
Fields
CommitteeAddUserPayload.committee ● Committee! non-null object
Returned By
committeeAddUser mutation
CommitteeConnection
No description
type CommitteeConnection {
pageInfo: PageInfo!
edges: [CommitteeEdge!]!
nodes: [Committee!]!
}
Fields
CommitteeConnection.pageInfo ● PageInfo! non-null object
Information to aid in pagination.
CommitteeConnection.edges ● [CommitteeEdge!]! non-null object
A list of edges.
CommitteeConnection.nodes ● [Committee!]! non-null object
A list of nodes.
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 {
node: Committee!
cursor: String!
}
Fields
CommitteeEdge.node ● Committee! non-null object
The item at the end of the edge
CommitteeEdge.cursor ● String! non-null scalar
A cursor for use in pagination
Member Of
CommitteeConnection object
CommitteeRemoveUserPayload
No description
type CommitteeRemoveUserPayload {
committee: Committee!
}
Fields
CommitteeRemoveUserPayload.committee ● Committee! non-null object
Returned By
committeeRemoveUser mutation
CommitteeThreshold
No description
type CommitteeThreshold {
threshold: Int!
committee: Committee!
}
Fields
CommitteeThreshold.threshold ● Int! non-null scalar
CommitteeThreshold.committee ● Committee! non-null object
Implemented By
ApprovalRules union
CreditFacility
No description
type CreditFacility {
id: ID!
creditFacilityId: UUID!
collateralId: UUID!
maturesAt: Timestamp!
activatedAt: Timestamp!
collateralizationState: CollateralizationState!
status: CreditFacilityStatus!
facilityAmount: UsdCents!
publicId: PublicId!
canBeCompleted: Boolean!
creditFacilityTerms: TermValues!
currentCvl: CvlPct!
history: [CreditFacilityHistoryEntry!]!
repaymentPlan: [CreditFacilityRepaymentPlanEntry!]!
disbursals: [CreditFacilityDisbursal!]!
liquidations: [Liquidation!]!
userCanUpdateCollateral: Boolean!
userCanInitiateDisbursal: Boolean!
userCanRecordPayment: Boolean!
userCanRecordPaymentWithDate: Boolean!
userCanComplete: Boolean!
customer: Customer!
balance: CreditFacilityBalance!
wallet: Wallet
ledgerAccounts: CreditFacilityLedgerAccounts!
}
Fields
CreditFacility.id ● ID! non-null scalar
CreditFacility.creditFacilityId ● UUID! non-null scalar
CreditFacility.collateralId ● UUID! non-null scalar
CreditFacility.maturesAt ● Timestamp! non-null scalar
CreditFacility.activatedAt ● Timestamp! non-null scalar
CreditFacility.collateralizationState ● CollateralizationState! non-null enum
CreditFacility.status ● CreditFacilityStatus! non-null enum
CreditFacility.facilityAmount ● UsdCents! non-null scalar
CreditFacility.publicId ● PublicId! non-null scalar
CreditFacility.canBeCompleted ● Boolean! non-null scalar
CreditFacility.creditFacilityTerms ● TermValues! non-null object
CreditFacility.currentCvl ● CvlPct! non-null union
CreditFacility.history ● [CreditFacilityHistoryEntry!]! non-null union
CreditFacility.repaymentPlan ● [CreditFacilityRepaymentPlanEntry!]! non-null object
CreditFacility.disbursals ● [CreditFacilityDisbursal!]! non-null object
CreditFacility.liquidations ● [Liquidation!]! non-null object
CreditFacility.userCanUpdateCollateral ● Boolean! non-null scalar
CreditFacility.userCanInitiateDisbursal ● Boolean! non-null scalar
CreditFacility.userCanRecordPayment ● Boolean! non-null scalar
CreditFacility.userCanRecordPaymentWithDate ● Boolean! non-null scalar
CreditFacility.userCanComplete ● Boolean! non-null scalar
CreditFacility.customer ● Customer! non-null object
CreditFacility.balance ● CreditFacilityBalance! non-null object
CreditFacility.wallet ● Wallet object
CreditFacility.ledgerAccounts ● CreditFacilityLedgerAccounts! non-null object
Returned By
creditFacility query ● creditFacilityByPublicId query
Member Of
Collateral object ● CreditFacilityCollateralizationPayload object ● CreditFacilityCompletePayload object ● CreditFacilityConnection object ● CreditFacilityDisbursal object ● CreditFacilityEdge object ● CreditFacilityPartialPaymentRecordPayload object ● CreditFacilityPaymentAllocation object ● Customer object
Implemented By
LedgerAccountEntity union ● PublicIdTarget union
CreditFacilityApproved
No description
type CreditFacilityApproved {
cents: UsdCents!
recordedAt: Timestamp!
effective: Date!
txId: UUID!
}
Fields
CreditFacilityApproved.cents ● UsdCents! non-null scalar
CreditFacilityApproved.recordedAt ● Timestamp! non-null scalar
CreditFacilityApproved.effective ● Date! non-null scalar
CreditFacilityApproved.txId ● UUID! non-null scalar
Implemented By
CreditFacilityHistoryEntry union
CreditFacilityBalance
No description
type CreditFacilityBalance {
facilityRemaining: FacilityRemaining!
disbursed: Disbursed!
interest: Interest!
outstanding: Outstanding!
outstandingPayable: Outstanding!
dueOutstanding: Outstanding!
collateral: CollateralBalance!
paymentsUnapplied: PaymentsUnapplied!
}
Fields
CreditFacilityBalance.facilityRemaining ● FacilityRemaining! non-null object
CreditFacilityBalance.disbursed ● Disbursed! non-null object
CreditFacilityBalance.interest ● Interest! non-null object
CreditFacilityBalance.outstanding ● Outstanding! non-null object
CreditFacilityBalance.outstandingPayable ● Outstanding! non-null object
CreditFacilityBalance.dueOutstanding ● Outstanding! non-null object
CreditFacilityBalance.collateral ● CollateralBalance! non-null object
CreditFacilityBalance.paymentsUnapplied ● PaymentsUnapplied! non-null object
Member Of
CreditFacility object
CreditFacilityCollateralizationPayload
No description
type CreditFacilityCollateralizationPayload {
state: CollateralizationState!
collateral: Satoshis!
outstandingInterest: UsdCents!
outstandingDisbursal: UsdCents!
recordedAt: Timestamp!
effective: Date!
price: UsdCents!
creditFacility: CreditFacility!
}
Fields
CreditFacilityCollateralizationPayload.state ● CollateralizationState! non-null enum
CreditFacilityCollateralizationPayload.collateral ● Satoshis! non-null scalar
CreditFacilityCollateralizationPayload.outstandingInterest ● UsdCents! non-null scalar
CreditFacilityCollateralizationPayload.outstandingDisbursal ● UsdCents! non-null scalar
CreditFacilityCollateralizationPayload.recordedAt ● Timestamp! non-null scalar
CreditFacilityCollateralizationPayload.effective ● Date! non-null scalar
CreditFacilityCollateralizationPayload.price ● UsdCents! non-null scalar
CreditFacilityCollateralizationPayload.creditFacility ● CreditFacility! non-null object
Returned By
creditFacilityCollateralizationUpdated subscription
CreditFacilityCollateralizationUpdated
No description
type CreditFacilityCollateralizationUpdated {
state: CollateralizationState!
collateral: Satoshis!
outstandingInterest: UsdCents!
outstandingDisbursal: UsdCents!
recordedAt: Timestamp!
effective: Date!
price: UsdCents!
}
Fields
CreditFacilityCollateralizationUpdated.state ● CollateralizationState! non-null enum
CreditFacilityCollateralizationUpdated.collateral ● Satoshis! non-null scalar
CreditFacilityCollateralizationUpdated.outstandingInterest ● UsdCents! non-null scalar
CreditFacilityCollateralizationUpdated.outstandingDisbursal ● UsdCents! non-null scalar
CreditFacilityCollateralizationUpdated.recordedAt ● Timestamp! non-null scalar
CreditFacilityCollateralizationUpdated.effective ● Date! non-null scalar
CreditFacilityCollateralizationUpdated.price ● UsdCents! non-null scalar
Implemented By
CreditFacilityHistoryEntry union
CreditFacilityCollateralSentOut
No description
type CreditFacilityCollateralSentOut {
amount: Satoshis!
recordedAt: Timestamp!
effective: Date!
txId: UUID!
}
Fields
CreditFacilityCollateralSentOut.amount ● Satoshis! non-null scalar
CreditFacilityCollateralSentOut.recordedAt ● Timestamp! non-null scalar
CreditFacilityCollateralSentOut.effective ● Date! non-null scalar
CreditFacilityCollateralSentOut.txId ● UUID! non-null scalar
Implemented By
CreditFacilityHistoryEntry union
CreditFacilityCollateralUpdated
No description
type CreditFacilityCollateralUpdated {
satoshis: Satoshis!
recordedAt: Timestamp!
effective: Date!
direction: CollateralDirection!
txId: UUID!
}
Fields
CreditFacilityCollateralUpdated.satoshis ● Satoshis! non-null scalar
CreditFacilityCollateralUpdated.recordedAt ● Timestamp! non-null scalar
CreditFacilityCollateralUpdated.effective ● Date! non-null scalar
CreditFacilityCollateralUpdated.direction ● CollateralDirection! non-null enum
CreditFacilityCollateralUpdated.txId ● UUID! non-null scalar
Implemented By
CreditFacilityHistoryEntry union
CreditFacilityCompletePayload
No description
type CreditFacilityCompletePayload {
creditFacility: CreditFacility!
}
Fields
CreditFacilityCompletePayload.creditFacility ● CreditFacility! non-null object
Returned By
creditFacilityComplete mutation
CreditFacilityConnection
No description
type CreditFacilityConnection {
pageInfo: PageInfo!
edges: [CreditFacilityEdge!]!
nodes: [CreditFacility!]!
}
Fields
CreditFacilityConnection.pageInfo ● PageInfo! non-null object
Information to aid in pagination.
CreditFacilityConnection.edges ● [CreditFacilityEdge!]! non-null object
A list of edges.
CreditFacilityConnection.nodes ● [CreditFacility!]! non-null object
A list of nodes.
Returned By
creditFacilities query
CreditFacilityDisbursal
No description
type CreditFacilityDisbursal {
id: ID!
disbursalId: UUID!
amount: UsdCents!
status: DisbursalStatus!
createdAt: Timestamp!
publicId: PublicId!
creditFacility: CreditFacility!
approvalProcess: ApprovalProcess!
ledgerTransactions: [LedgerTransaction!]!
}
Fields
CreditFacilityDisbursal.id ● ID! non-null scalar
CreditFacilityDisbursal.disbursalId ● UUID! non-null scalar
CreditFacilityDisbursal.amount ● UsdCents! non-null scalar
CreditFacilityDisbursal.status ● DisbursalStatus! non-null enum
CreditFacilityDisbursal.createdAt ● Timestamp! non-null scalar
CreditFacilityDisbursal.publicId ● PublicId! non-null scalar
CreditFacilityDisbursal.creditFacility ● CreditFacility! non-null object
CreditFacilityDisbursal.approvalProcess ● ApprovalProcess! non-null object
CreditFacilityDisbursal.ledgerTransactions ● [LedgerTransaction!]! non-null object
Returned By
disbursal query ● disbursalByPublicId query
Member Of
CreditFacility object ● CreditFacilityDisbursalConnection object ● CreditFacilityDisbursalEdge object ● CreditFacilityDisbursalInitiatePayload object ● DisbursalEntry object
Implemented By
ApprovalProcessTarget union ● LedgerTransactionEntity union ● PublicIdTarget union
CreditFacilityDisbursalConnection
No description
type CreditFacilityDisbursalConnection {
pageInfo: PageInfo!
edges: [CreditFacilityDisbursalEdge!]!
nodes: [CreditFacilityDisbursal!]!
}
Fields
CreditFacilityDisbursalConnection.pageInfo ● PageInfo! non-null object
Information to aid in pagination.
CreditFacilityDisbursalConnection.edges ● [CreditFacilityDisbursalEdge!]! non-null object
A list of edges.
CreditFacilityDisbursalConnection.nodes ● [CreditFacilityDisbursal!]! non-null object
A list of nodes.
Returned By
disbursals query
CreditFacilityDisbursalEdge
An edge in a connection.
type CreditFacilityDisbursalEdge {
node: CreditFacilityDisbursal!
cursor: String!
}
Fields
CreditFacilityDisbursalEdge.node ● CreditFacilityDisbursal! non-null object
The item at the end of the edge
CreditFacilityDisbursalEdge.cursor ● String! non-null scalar
A cursor for use in pagination
Member Of
CreditFacilityDisbursalConnection object
CreditFacilityDisbursalExecuted
No description
type CreditFacilityDisbursalExecuted {
cents: UsdCents!
recordedAt: Timestamp!
effective: Date!
txId: UUID!
}
Fields
CreditFacilityDisbursalExecuted.cents ● UsdCents! non-null scalar
CreditFacilityDisbursalExecuted.recordedAt ● Timestamp! non-null scalar
CreditFacilityDisbursalExecuted.effective ● Date! non-null scalar
CreditFacilityDisbursalExecuted.txId ● UUID! non-null scalar
Implemented By
CreditFacilityHistoryEntry union
CreditFacilityDisbursalInitiatePayload
No description
type CreditFacilityDisbursalInitiatePayload {
disbursal: CreditFacilityDisbursal!
}
Fields
CreditFacilityDisbursalInitiatePayload.disbursal ● CreditFacilityDisbursal! non-null object
Returned By
creditFacilityDisbursalInitiate mutation
CreditFacilityEdge
An edge in a connection.
type CreditFacilityEdge {
node: CreditFacility!
cursor: String!
}
Fields
CreditFacilityEdge.node ● CreditFacility! non-null object
The item at the end of the edge
CreditFacilityEdge.cursor ● String! non-null scalar
A cursor for use in pagination
Member Of
CreditFacilityConnection object
CreditFacilityIncrementalPayment
No description
type CreditFacilityIncrementalPayment {
cents: UsdCents!
recordedAt: Timestamp!
effective: Date!
txId: UUID!
}
Fields
CreditFacilityIncrementalPayment.cents ● UsdCents! non-null scalar
CreditFacilityIncrementalPayment.recordedAt ● Timestamp! non-null scalar
CreditFacilityIncrementalPayment.effective ● Date! non-null scalar
CreditFacilityIncrementalPayment.txId ● UUID! non-null scalar
Implemented By
CreditFacilityHistoryEntry union
CreditFacilityInterestAccrued
No description
type CreditFacilityInterestAccrued {
cents: UsdCents!
recordedAt: Timestamp!
effective: Date!
txId: UUID!
days: Int!
}
Fields
CreditFacilityInterestAccrued.cents ● UsdCents! non-null scalar
CreditFacilityInterestAccrued.recordedAt ● Timestamp! non-null scalar
CreditFacilityInterestAccrued.effective ● Date! non-null scalar
CreditFacilityInterestAccrued.txId ● UUID! non-null scalar
CreditFacilityInterestAccrued.days ● Int! non-null scalar
Implemented By
CreditFacilityHistoryEntry union
CreditFacilityLedgerAccounts
No description
type CreditFacilityLedgerAccounts {
facilityAccountId: UUID!
disbursedReceivableNotYetDueAccountId: UUID!
disbursedReceivableDueAccountId: UUID!
disbursedReceivableOverdueAccountId: UUID!
disbursedDefaultedAccountId: UUID!
collateralAccountId: UUID!
collateralInLiquidationAccountId: UUID!
liquidatedCollateralAccountId: UUID!
proceedsFromLiquidationAccountId: UUID!
interestReceivableNotYetDueAccountId: UUID!
interestReceivableDueAccountId: UUID!
interestReceivableOverdueAccountId: UUID!
interestDefaultedAccountId: UUID!
interestIncomeAccountId: UUID!
feeIncomeAccountId: UUID!
paymentHoldingAccountId: UUID!
uncoveredOutstandingAccountId: UUID!
facilityAccount: LedgerAccount!
disbursedReceivableNotYetDueAccount: LedgerAccount!
disbursedReceivableDueAccount: LedgerAccount!
disbursedReceivableOverdueAccount: LedgerAccount!
disbursedDefaultedAccount: LedgerAccount!
collateralAccount: LedgerAccount!
collateralInLiquidationAccount: LedgerAccount!
liquidatedCollateralAccount: LedgerAccount!
proceedsFromLiquidationAccount: LedgerAccount!
interestReceivableNotYetDueAccount: LedgerAccount!
interestReceivableDueAccount: LedgerAccount!
interestReceivableOverdueAccount: LedgerAccount!
interestDefaultedAccount: LedgerAccount!
interestIncomeAccount: LedgerAccount!
feeIncomeAccount: LedgerAccount!
paymentHoldingAccount: LedgerAccount!
uncoveredOutstandingAccount: LedgerAccount!
}