view

Core Resources / Views

Overview

View Resources provides queryable views of the system state.

Concepts

Account

Record in the ledger used to group postings.

Account Path

Debit or credit posting to an account to adjust a balance.

Account Total Debit Limit

Funded account available for disbursals.

Account Disbursements

The funding of an available balance via a commitment account.

Balances

Available and ledger balances, with account version, at point in time.

Card

Track obligations which require settlement.

Entry

Tracks outbound payments.

Fulfillment

Tracks outbound payments.

Group

Tracks outbound payments.

Pending Entry

Collection of postings.

Profile

Tracks accrued fees.

Program

Tracks inbound payments.

Relation

Tracks accrued interest.

Relation Subject

Tracks finalization etc.

Relation Predicate

Debits or credits for a specific account.

Relation Object

The transfer of funds to a payee.

Entry Transactions

Reversing an entry.

Queries

get-account-by-id

Retrieve account with given id.

get-accounts-by-path

Retrieve all accounts that exist with the given path prefix.

get-account-limit-total-debit-by-account-id

Obtains how much an account has progressed towards a total debit limit

get-account-disbursements-by-account-id

Obtains the total disbursements for an account

get-balances-by-account-id-list

Ledger and available balance for multiple accounts at the given time.

get-entry-by-id

Retrieve ledger entry with given id.

get-pending-entry-by-id

Retrieve pending ledger entry with given id.

get-profile-by-id

Retrieve a profile with a given id.

get-program-by-id

Retrieve a program with a given id.

get-programs-by-client-id

Retrieve programs with a given client profile id.

get-relation-by-subject

Retrieve relations for a subject.

get-relation-by-subject-predicate-object

Retrieve a relation.

get-cards-by-profile-id

Retrieve all cards for a profile.

get-card-request

Obtains an RSA asymetric public key for encrypting a pin. Calling the method with the same cardId and requestId will always return the same key

get-pack-by-group-id

Retrieve pack for a specific group.

get-fulfillment-by-group-id

Retrieve fulfillment records for group.

get-entry-transactions-by-group-id

Obtains an RSA asymetric public key for encrypting a pin. Calling the method with the same cardId and requestId will always return the same key