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(
asOf: Date!
): BalanceSheet!
Arguments
balanceSheet.asOf ● Date! non-null scalar
Type
BalanceSheet object
buildInfo
No description
buildInfo: BuildInfo!
Type
BuildInfo 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
sort: CreditFacilityProposalsSort = { by: CREATED_AT, direction: ASC }
filter: CreditFacilityProposalsFilter
): CreditFacilityProposalConnection!
Arguments
creditFacilityProposals.first ● Int! non-null scalar
creditFacilityProposals.after ● String scalar
creditFacilityProposals.sort ● CreditFacilityProposalsSort input
creditFacilityProposals.filter ● CreditFacilityProposalsFilter input
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
filter: DepositAccountsFilter
): DepositAccountConnection!
Arguments
depositAccounts.first ● Int! non-null scalar
depositAccounts.after ● String scalar
depositAccounts.filter ● DepositAccountsFilter input
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
filter: DepositsFilter
): DepositConnection!
Arguments
deposits.first ● Int! non-null scalar
deposits.after ● String scalar
deposits.filter ● DepositsFilter input
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
filter: DisbursalsFilter
): CreditFacilityDisbursalConnection!
Arguments
disbursals.first ● Int! non-null scalar
disbursals.after ● String scalar
disbursals.filter ● DisbursalsFilter input
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(
id: UUID!
): FiscalYear
Arguments
fiscalYear.id ● 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
sort: PendingCreditFacilitiesSort = { by: CREATED_AT, direction: ASC }
filter: PendingCreditFacilitiesFilter
): PendingCreditFacilityConnection!
Arguments
pendingCreditFacilities.first ● Int! non-null scalar
pendingCreditFacilities.after ● String scalar
pendingCreditFacilities.sort ● PendingCreditFacilitiesSort input
pendingCreditFacilities.filter ● PendingCreditFacilitiesFilter input
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
sort: ProspectsSort = { by: CREATED_AT, direction: ASC }
filter: ProspectsFilter
): ProspectConnection!
Arguments
prospects.first ● Int! non-null scalar
prospects.after ● String scalar
prospects.sort ● ProspectsSort input
prospects.filter ● ProspectsFilter input
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
filter: WithdrawalsFilter
): WithdrawalConnection!
Arguments
withdrawals.first ● Int! non-null scalar
withdrawals.after ● String scalar
withdrawals.filter ● WithdrawalsFilter input
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!