Admin API Reference
This API reference has been automatically generated from the Admin GraphQL schema.
Queries
accountEntryCsv
Fetches the CSV export document for a specific ledger account
accountEntryCsv(
ledgerAccountId: UUID!
): AccountingCsvDocument
Arguments
accountEntryCsv.ledgerAccountId ● UUID! non-null scalar
Type
AccountingCsvDocument object
approvalProcess
Fetches a specific approval process by its unique identifier
approvalProcess(
id: UUID!
): ApprovalProcess
Arguments
approvalProcess.id ● UUID! non-null scalar
Type
ApprovalProcess object
approvalProcesses
Returns a paginated list of all approval processes
approvalProcesses(
first: Int!
after: String
): ApprovalProcessConnection!
Arguments
approvalProcesses.first ● Int! non-null scalar
approvalProcesses.after ● String scalar
Type
ApprovalProcessConnection object
audit
Returns a paginated list of audit log entries
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
Returns a list of distinct audit log subjects
auditSubjects: [AuditSubjectId!]!
Type
AuditSubjectId scalar
balanceSheet
Generates a balance sheet report for the specified date range
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: UUID!
): Committee
Arguments
committee.id ● UUID! non-null scalar
Type
Committee object
committees
Returns a paginated list of all committees
committees(
first: Int!
after: String
): CommitteeConnection!
Arguments
committees.first ● Int! non-null scalar
committees.after ● String scalar
Type
CommitteeConnection object
creditConfig
Returns the current credit module configuration
creditConfig: CreditModuleConfig
Type
CreditModuleConfig object
creditFacilities
Returns a paginated, sortable, and filterable list of credit facilities
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
Fetches a specific credit facility by its unique identifier
creditFacility(
id: UUID!
): CreditFacility
Arguments
creditFacility.id ● UUID! non-null scalar
Type
CreditFacility 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
creditFacilityProposal
Fetches a specific credit facility proposal by its unique identifier
creditFacilityProposal(
id: UUID!
): CreditFacilityProposal
Arguments
creditFacilityProposal.id ● UUID! non-null scalar
Type
CreditFacilityProposal object
creditFacilityProposals
Returns a paginated list of all credit facility proposals
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
Returns a paginated list of all configured custodians
custodians(
first: Int!
after: String
): CustodianConnection!
Arguments
custodians.first ● Int! non-null scalar
custodians.after ● String scalar
Type
CustodianConnection object
customer
Fetches a specific customer by their unique identifier
customer(
id: UUID!
): Customer
Arguments
customer.id ● UUID! 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: UUID!
): CustomerDocument
Arguments
customerDocument.id ● UUID! non-null scalar
Type
CustomerDocument object
customers
Returns a paginated, sortable, and filterable list of customers
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
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: UUID!
): Deposit
Arguments
deposit.id ● UUID! non-null scalar
Type
Deposit object
depositAccount
Fetches a specific deposit account by its unique identifier
depositAccount(
id: UUID!
): DepositAccount
Arguments
depositAccount.id ● UUID! 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
depositAccounts
Returns a paginated list of all deposit accounts
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
Fetches a deposit by its public-facing identifier
depositByPublicId(
id: PublicId!
): Deposit
Arguments
depositByPublicId.id ● PublicId! non-null scalar
Type
Deposit object
depositConfig
Returns the current deposit module configuration
depositConfig: DepositModuleConfig
Type
DepositModuleConfig object
deposits
Returns a paginated list of all deposits
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
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!
): [AccountInfo!]!
Arguments
descendantAccountSetsByCategory.category ● AccountCategory! non-null enum
Type
AccountInfo object
disbursal
Fetches a specific disbursal by its unique identifier
disbursal(
id: UUID!
): CreditFacilityDisbursal
Arguments
disbursal.id ● UUID! 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 list of all disbursals
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
Returns a paginated list of all domain configuration settings
domainConfigs(
first: Int!
after: String
): DomainConfigConnection!
Arguments
domainConfigs.first ● Int! non-null scalar
domainConfigs.after ● String scalar
Type
DomainConfigConnection object
fiscalYear
Fetches a specific fiscal year by its unique identifier
fiscalYear(
id: UUID!
): FiscalYear
Arguments
fiscalYear.id ● UUID! 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(
first: Int!
after: String
): FiscalYearConnection!
Arguments
fiscalYears.first ● Int! non-null scalar
fiscalYears.after ● String scalar
Type
FiscalYearConnection object
journalEntries
Returns a paginated list of all journal entries
journalEntries(
first: Int!
after: String
): JournalEntryConnection!
Arguments
journalEntries.first ● Int! non-null scalar
journalEntries.after ● String scalar
Type
JournalEntryConnection object
ledgerAccount
Fetches a specific ledger account by its unique identifier
ledgerAccount(
id: UUID!
): LedgerAccount
Arguments
ledgerAccount.id ● UUID! non-null scalar
Type
LedgerAccount object
ledgerAccountByCode
Fetches a ledger account by its account code
ledgerAccountByCode(
code: String!
): LedgerAccount
Arguments
ledgerAccountByCode.code ● String! non-null scalar
Type
LedgerAccount object
ledgerTransaction
Fetches a specific ledger transaction by its unique identifier
ledgerTransaction(
id: UUID!
): LedgerTransaction
Arguments
ledgerTransaction.id ● UUID! non-null scalar
Type
LedgerTransaction object
ledgerTransactionsForTemplateCode
Returns a paginated list of ledger transactions for a specific template code
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
Fetches a specific liquidation by its unique identifier
liquidation(
id: UUID!
): Liquidation
Arguments
liquidation.id ● UUID! non-null scalar
Type
Liquidation object
liquidations
Returns a paginated list of all liquidations
liquidations(
first: Int!
after: String
): LiquidationConnection!