Insights Data Catalog
The Insights data catalog provides an overview of the available Gold Standard data products. These datasets are modeled, versioned, and aligned with Mambu's APIs to provide a stable and reliable view of your core banking entities. There can be minor differences in the availability of the fields in Mambu Insights and fields in the API V2, and this page specifies cases where a field is not available in Mambu Insights.
Activity
The Activity entity is designed to track and record various actions and events that occur within the system to provide operational insights.
| Field Path | Status | Source | Implementation Notes |
|---|---|---|---|
| encodedKey | Available | ACTIVITY.ENCODEDKEY | Primary key (UUID) |
| transactionID | Available | ACTIVITY.TRANSACTIONID | Unique transaction identifier (bigint) |
| timestamp | Available | ACTIVITY.TIMESTAMP | When activity occurred (UTC datetime) |
| type | Available | ACTIVITY.TYPE | ActivityType enum (e.g., TASK_DELETED, CLIENT_CREATED) |
| notes | Available | ACTIVITY.NOTES | Activity description/notes (varchar(256)) |
| userKey | Available | ACTIVITY.USERKEY | User who performed the activity (FK to User) |
| assignedUserKey | Available | ACTIVITY.ASSIGNEDUSERKEY | User assigned to be notified (FK to User) |
| branchKey | Available | ACTIVITY.BRANCHKEY | Branch reference (FK to Branch, nullable) |
| clientKey | Available | ACTIVITY.CLIENTKEY | Client reference (FK to Client, nullable) |
| groupKey | Available | ACTIVITY.GROUPKEY | Group reference (FK to Group, nullable) |
| centreKey | Available | ACTIVITY.CENTREKEY | Centre reference (FK to Centre, nullable) |
| loanAccountKey | Available | ACTIVITY.LOANACCOUNTKEY | Loan account reference (FK to LoanAccount, nullable) |
| loanProductKey | Available | ACTIVITY.LOANPRODUCTKEY | Loan product reference (FK to LoanProduct, nullable) |
| savingsAccountKey | Available | ACTIVITY.SAVINGSACCOUNTKEY | Savings account reference (FK to SavingsAccount, nullable) |
| savingsProductKey | Available | ACTIVITY.SAVINGSPRODUCTKEY | Savings product reference (FK to SavingsProduct, nullable) |
| lineOfCreditKey | Available | ACTIVITY.LINEOFCREDITKEY | Line of credit reference (FK to LineOfCredit, nullable) |
| taskKey | Available | ACTIVITY.TASKKEY | Task reference (FK to Task, nullable) |
| glAccountKey | Available | ACTIVITY.GLACCOUNTKEY | GL account reference (FK to GLAccount, nullable) |
| glAccountsClosureKey | Available | ACTIVITY.GLACCOUNTSCLOSUREKEY | GL accounts closure reference (FK to GLAccountsClosure, nullable) |
| assignedCentreKey | Available | ACTIVITY.ASSIGNEDCENTREKEY | Assigned centre reference (FK to Centre, nullable) |
| entityKey | Available | ACTIVITY.ENTITYKEY | Generic entity key (varchar(32), nullable) |
| entityType | Available | ACTIVITY.ENTITYTYPE | Type of entity (e.g., LOAN_TRANSACTION, SAVINGS_TRANSACTION, GL_JOURNAL_ENTRY, nullable) |
| parentKey | Available | ACTIVITY.PARENT_KEY | Parent activity reference for sub-activities (self-referencing FK, nullable) |
| fieldChangeName | Available | ACTIVITY.FIELDCHANGENAME | Field change name for sub-activities (nullable) |
| fieldChanges[] | Available | FIELDCHANGEITEM table | Array of field change objects (1:N) |
| └─ id | Available | FIELDCHANGEITEM.ID | Field change identifier (bigint) |
| └─ fieldChangeName | Available | FIELDCHANGEITEM.FIELDCHANGENAME | Name of the changed field (varchar(256)) |
| └─ fieldDetailName | Available | FIELDCHANGEITEM.FIELDDETAILNAME | Optional detailed name (e.g., custom field name, nullable) |
| └─ fieldDetailKey | Available | FIELDCHANGEITEM.FIELDDETAILKEY | Optional detailed key (e.g., custom field key, nullable) |
| └─ originalValue | Available | FIELDCHANGEITEM.ORIGINALVALUE | Original value before change (mediumtext, nullable) |
| └─ newValue | Available | FIELDCHANGEITEM.NEWVALUE | New value after change (mediumtext, nullable) |
Branch
The Branch Gold data product provides organizational branch information with associated addresses and holiday calendars. This is a master data entity used throughout Mambu for organizational structure and geographical hierarchy.
| Field Path | Status | Source | Implementation Notes |
|---|---|---|---|
| encodedKey | Available | BRANCH.ENCODEDKEY | Primary key (UUID) |
| id | Available | BRANCH.ID | Business identifier, unique, user-defined |
| name | Available | BRANCH.NAME | Branch display name |
| creationDate | Available | BRANCH.CREATIONDATE | Stored as UTC timestamp |
| lastModifiedDate | Available | BRANCH.LASTMODIFIEDDATE | Stored as UTC timestamp |
| emailAddress | Available | BRANCH.EMAILADDRESS | Contact email |
| phoneNumber | Available | BRANCH.PHONENUMBER | Contact phone |
| notes | Available | BRANCH.NOTES | Long text description |
| state | Available | BRANCH.STATE | ACTIVE, INACTIVE, or DELETED |
| addresses[] | Available | ADDRESS table | Array of address objects (1:N) |
| └─ encodedKey | Available | ADDRESS.ENCODEDKEY | Address identifier |
| └─ parentKey | Available | ADDRESS.PARENTKEY | FK back to BRANCH |
| └─ line1 | Available | ADDRESS.LINE1 | Street address line 1 |
| └─ line2 | Available | ADDRESS.LINE2 | Street address line 2 |
| └─ city | Available | ADDRESS.CITY | City name |
| └─ region | Available | ADDRESS.REGION | State/province/region |
| └─ postcode | Available | ADDRESS.POSTCODE | Postal/ZIP code |
| └─ country | Available | ADDRESS.COUNTRY | Country name |
| └─ indexInList | Available | ADDRESS.INDEXINLIST | Ordering in address list |
| └─ latitude | Available | ADDRESS.LATITUDE | GPS latitude (DDD.dddd, -90 to +90) |
| └─ longitude | Available | ADDRESS.LONGITUDE | GPS longitude (DDD.dddd, -180 to +180) |
| branchHolidays[] | Available | HOLIDAY table | Array of holiday objects (1:N) |
| └─ encodedKey | Available | HOLIDAY.ENCODEDKEY | Holiday identifier |
| └─ id | Available | HOLIDAY.KEYID | Numeric ID |
| └─ name | Available | HOLIDAY.NAME | Holiday name |
| └─ date | Available | Constructed from YEAR/MONTH/DAY | ISO date format (YYYY-MM-DD) |
| └─ isAnnuallyRecurring | Available | HOLIDAY.ISANNUALYRECURRING | TRUE if holiday repeats yearly |
| └─ creationDate | Available | HOLIDAY.CREATIONDATE | When holiday was created |
Client
The Client Gold data product provides comprehensive client/customer information including personal details, contact information, addresses, identification documents, group memberships, and custom fields. This is a core master data entity representing individual customers who use the banking services.
| Field Path | Status | Source | Implementation Notes |
|---|---|---|---|
| encodedKey | Available | CLIENT.ENCODEDKEY | Primary key (UUID, auto-generated) |
| id | Available | CLIENT.ID | Business identifier, unique, user-defined |
| firstName | Available | CLIENT.FIRSTNAME | Required field |
| lastName | Available | CLIENT.LASTNAME | Required field |
| middleName | Available | CLIENT.MIDDLENAME | Optional middle name |
| creationDate | Available | CLIENT.CREATIONDATE | Stored as UTC timestamp |
| lastModifiedDate | Available | CLIENT.LASTMODIFIEDDATE | Stored as UTC timestamp |
| activationDate | Available | CLIENT.ACTIVATIONDATE | When client was first set to ACTIVE |
| approvedDate | Available | CLIENT.APPROVEDDATE | When client was approved |
| closedDate | Available | CLIENT.CLOSEDDATE | When client was closed/exited/blacklisted |
| birthDate | Available | CLIENT.BIRTHDATE | Stored as Organization Time (no timezone) |
| gender | Available | CLIENT.GENDER | MALE, FEMALE, or NULL |
| state | Available | CLIENT.STATE | PENDING_APPROVAL, ACTIVE, INACTIVE, EXITED, REJECTED, WITHDRAWN, BLACKLISTED |
| emailAddress | Available | CLIENT.EMAILADDRESS | Primary email |
| homePhone | Available | CLIENT.HOMEPHONE | Home telephone number |
| mobilePhone | Available | CLIENT.MOBILEPHONE1 | Primary mobile number |
| mobilePhone2 | Available | CLIENT.MOBILEPHONE2 | Secondary mobile number |
| notes | Available | CLIENT.NOTES | Long text field (LONGVARCHAR, lazy-loaded) |
| assignedBranchKey | Available | CLIENT.ASSIGNEDBRANCHKEY | FK to BRANCH table |
| assignedCentreKey | Available | CLIENT.ASSIGNEDCENTREKEY | FK to CENTRE table (optional) |
| assignedUserKey | Available | CLIENT.ASSIGNEDUSERKEY | FK to USER table (loan officer) |
| clientRoleKey | Available | CLIENT.CLIENTROLEKEY | FK to CLIENTROLE table |
| profilePictureKey | Available | CLIENT.PROFILEPICTUREKEY | FK to IMAGE table |
| profileSignatureKey | Available | CLIENT.PROFILESIGNATUREKEY | FK to IMAGE table |
| preferredLanguage | Available | CLIENT.PREFERREDLANGUAGE | ISO 639-1 language code |
| loanCycle | Available | CLIENT.LOANCYCLE | Number of loans completed |
| groupLoanCycle | Available | CLIENT.GROUPLOANCYCLE | Number of group loans completed |
| migrationEventKey | Available | CLIENT.MIGRATIONEVENTKEY | FK to data migration event |
| addresses[] | Available | ADDRESS table | Array of addresses (1:N), filtered by PARENTKEY |
| idDocuments[] | Available | IDENTIFICATIONDOCUMENT table | Array of identification documents (1:N) |
| groupKeys[] | Available | GROUPMEMBER table | Array of group encoded keys (client memberships) |
| customFields | Available | CUSTOMFIELDVALUE table | Map of custom field sets to field values |
| portalSettings | Not available | PORTALPREFERENCES table | Portal preferences (@NotPersistent, separate table) |
| idDocuments[].attachments[] | Not available | ATTACHMENT table | Document attachments (requires ATTACHMENT join) |
| numCenters | Not available | @NotPersistent | Runtime-calculated count |
Credit Arrangements
The CreditArrangement Gold data product provides a comprehensive line of credit information including credit limits, available credit calculations, consumed credit amounts, holder information, and custom fields. This is a core credit management entity representing credit facilities that can be shared across multiple loan and savings accounts.
| Field Path | Status | Source | Implementation Notes |
|---|---|---|---|
| encodedKey | Available | LINEOFCREDIT.ENCODEDKEY | Primary key (UUID) |
| id | Available | LINEOFCREDIT.ID | Business identifier, unique, user-defined |
| amount | Available | LINEOFCREDIT.AMOUNT | Total credit limit amount (Decimal(38,18)) |
| state | Available | LINEOFCREDIT.STATE | Credit arrangement state (e.g., PENDING_APPROVAL, APPROVED, ACTIVE, CLOSED) |
| subState | Available | LINEOFCREDIT.SUBSTATE | Sub-state for additional state classification (nullable) |
| exposureLimitType | Available | LINEOFCREDIT.EXPOSURELIMITTYPE | Type of exposure limit (APPROVED_AMOUNT or other) |
| notes | Available | LINEOFCREDIT.NOTES | Credit arrangement notes (varchar, nullable) |
| creationDate | Available | LINEOFCREDIT.CREATIONDATE | When credit arrangement was created (UTC timestamp) |
| lastModifiedDate | Available | LINEOFCREDIT.LASTMODIFIEDDATE | Last modification timestamp (UTC, nullable) |
| approvedDate | Available | LINEOFCREDIT.APPROVEDDATE | When credit arrangement was approved (UTC timestamp, nullable) |
| closedDate | Available | LINEOFCREDIT.CLOSEDDATE | When credit arrangement was closed (UTC timestamp, nullable) |
| startDate | Available | LINEOFCREDIT.STARTDATE | Credit arrangement start date (UTC timestamp) |
| expireDate | Available | LINEOFCREDIT.EXPIREDATE | Credit arrangement expiry date (UTC timestamp, nullable) |
| currency | Available | LINEOFCREDIT table | Struct containing currency information |
| └─ currencyCode | Available | LINEOFCREDIT.CURRENCYCODE | ISO currency code (nullable) |
| availableCreditAmount | Available | Calculated | Available credit = amount - consumed (calculated from savings/loan accounts) |
| consumedCreditAmount | Available | Calculated | Consumed credit = amount - availableCreditAmount |
| holderKey | Available | LOANACCOUNT.ACCOUNTHOLDERKEY | Account holder key (from first loan account, nullable) |
| holderType | Available | LOANACCOUNT.ACCOUNTHOLDERTYPE | Account holder type CLIENT or GROUP (from first loan account, nullable) |
| customFields[] | Available | CUSTOMFIELD + CUSTOMFIELDVALUE tables | Array of custom field objects (1:N) |
| └─ fieldKey | Available | CUSTOMFIELD.ENCODEDKEY | Custom field identifier |
| └─ fieldName | Available | CUSTOMFIELD.NAME | Custom field name |
| └─ fieldValue | Available | CUSTOMFIELDVALUE.VALUE | Custom field value |
Deposit Account
The DepositAccount Gold data product provides comprehensive deposit/savings account information including account details, balances, interest settings, overdraft settings, and custom fields. This is a core transactional entity representing customer deposit accounts in the Mambu banking system.
| Field Path | Status | Source | Implementation Notes |
|---|---|---|---|
| encodedKey | Available | SAVINGSACCOUNT.ENCODEDKEY | Primary key (UUID) |
| id | Available | SAVINGSACCOUNT.ID | Business identifier, unique, user-defined |
| name | Available | SAVINGSACCOUNT.NAME | Account display name |
| accountHolderKey | Available | SAVINGSACCOUNT.ACCOUNTHOLDERKEY | FK to account holder (Client/Group) |
| accountHolderType | Available | SAVINGSACCOUNT.ACCOUNTHOLDERTYPE | CLIENT or GROUP |
| accountState | Available | SAVINGSACCOUNT.ACCOUNTSTATE | PENDING_APPROVAL, APPROVED, ACTIVE, ACTIVE_IN_ARREARS, CLOSED, etc. |
| balance | Available | SAVINGSACCOUNT.BALANCE | Current account balance (Decimal(38,18)) |
| currencyCode | Available | SAVINGSACCOUNT.CURRENCYCODE | ISO currency code |
| productTypeKey | Available | SAVINGSACCOUNT.PRODUCTTYPEKEY | FK to SavingsProduct |
| creditArrangementKey | Available | SAVINGSACCOUNT.LINEOFCREDITKEY | FK to LineOfCredit (optional) |
| assignedBranchKey | Available | SAVINGSACCOUNT.ASSIGNEDBRANCHKEY | FK to Branch (optional) |
| assignedCentreKey | Available | SAVINGSACCOUNT.ASSIGNEDCENTREKEY | FK to Centre (optional) |
| assignedUserKey | Available | SAVINGSACCOUNT.ASSIGNEDUSERKEY | FK to User (optional) |
| withholdingTaxSourceKey | Available | SAVINGSACCOUNT.WITHHOLDINGTAXSOURCEKEY | FK to IndexRateSource (optional) |
| migrationEventKey | Available | SAVINGSACCOUNT.MIGRATIONEVENTKEY | FK to data migration event (optional) |
| notes | Available | SAVINGSACCOUNT.NOTES | Account notes (varchar) |
| creationDate | Available | SAVINGSACCOUNT.CREATIONDATE | When account was created (UTC timestamp) |
| lastModifiedDate | Available | SAVINGSACCOUNT.LASTMODIFIEDDATE | Last modification timestamp (UTC) |
| activationDate | Available | SAVINGSACCOUNT.ACTIVATIONDATE | When account was activated (UTC timestamp, nullable) |
| approvedDate | Available | SAVINGSACCOUNT.APPROVEDDATE | When account was approved (UTC timestamp, nullable) |
| closedDate | Available | SAVINGSACCOUNT.CLOSEDDATE | When account was closed (UTC timestamp, nullable) |
| lockedDate | Available | SAVINGSACCOUNT.LOCKEDDATE | When account was locked (UTC timestamp, nullable) |
| maturityDate | Available | SAVINGSACCOUNT.MATURITYDATE | Account maturity date (UTC timestamp, nullable) |
| lastAccountAppraisalDate | Available | SAVINGSACCOUNT.LASTACCOUNTAPPRAISALDATE | Last appraisal date (UTC timestamp, nullable) |
| lastInterestCalculationDate | Available | SAVINGSACCOUNT.LASTINTERESTCALCULATIONDATE | Last interest calculation (UTC timestamp, nullable) |
| lastInterestStoredDate | Available | SAVINGSACCOUNT.LASTINTERESTSTOREDDATE | Last interest storage date (UTC timestamp, nullable) |
| lastInterestReviewDate | Available | SAVINGSACCOUNT.LASTINTERESTREVIEWDATE | Last interest review date (UTC timestamp, nullable) |
| lastOverdraftInterestReviewDate | Available | SAVINGSACCOUNT.LASTOVERDRAFTINTERESTREVIEWDATE | Last overdraft interest review (UTC timestamp, nullable) |
| lastSetToArrearsDate | Available | SAVINGSACCOUNT.LASTSETTOARREARSDATE | Last time account was set to arrears (UTC timestamp, nullable) |
| accruedAmounts | Available | SAVINGSACCOUNT table | Struct containing accrued interest amounts |
| └─ interestAccrued | Available | SAVINGSACCOUNT.ACCRUEDINTEREST | Accrued interest amount |
| └─ negativeInterestAccrued | Available | SAVINGSACCOUNT.NEGATIVEINTERESTACCRUED | Negative interest accrued |
| └─ overdraftInterestAccrued | Available | SAVINGSACCOUNT.OVERDRAFTINTERESTACCRUED | Overdraft interest accrued |
| └─ technicalOverdraftInterestAccrued | Available | SAVINGSACCOUNT.TECHNICALOVERDRAFTINTERESTACCRUED | Technical overdraft interest accrued |
| balances | Available | SAVINGSACCOUNT table | Struct containing all balance components |
| └─ availableBalance | Available | SAVINGSACCOUNT.BALANCE | Available balance (same as balance) |
| └─ blockedBalance | Available | SAVINGSACCOUNT.BLOCKEDBALANCE | Blocked balance amount |
| └─ feesDue | Available | SAVINGSACCOUNT.FEESDUE | Fees due amount |
| └─ forwardAvailableBalance | Available | SAVINGSACCOUNT.FORWARDAVAILABLEBALANCE | Forward available balance |
| └─ holdBalance | Available | SAVINGSACCOUNT.HOLDBALANCE | Hold balance amount |
| └─ lockedBalance | Available | SAVINGSACCOUNT.LOCKEDBALANCE | Locked balance amount |
| └─ overdraftAmount | Available | SAVINGSACCOUNT.OVERDRAFTAMOUNT | Overdraft amount |
| └─ overdraftInterestDue | Available | SAVINGSACCOUNT.TECHNICALINTERESTDUE | Overdraft interest due |
| └─ technicalOverdraftAmount | Available | SAVINGSACCOUNT.TECHNICALOVERDRAFTAMOUNT | Technical overdraft amount |
| └─ technicalOverdraftInterestDue | Available | SAVINGSACCOUNT.TECHNICALINTERESTDUE | Technical overdraft interest due |
| └─ totalBalance | Available | SAVINGSACCOUNT.BALANCE | Total balance (same as balance) |
| interestSettings | Available | SAVINGSACCOUNT table | Struct containing interest payment settings |
| └─ interestPaymentSettings | Available | SAVINGSACCOUNT table | Nested struct for payment settings |
| └─ └─ interestPaymentDates | Available | SAVINGSACCOUNT.INTERESTPAYMENTDATES | Binary field for payment dates |
| └─ interestPaymentPoint | Available | SAVINGSACCOUNT.INTERESTPAYMENTPOINT | Interest payment point |
| interestRateSettings | Available | INTERESTACCOUNTSETTINGS + INTERESTBASESETTINGS | Struct from joined tables |
| └─ encodedKey | Available | INTERESTACCOUNTSETTINGS.ENCODEDKEY | Interest settings identifier |
| └─ interestChargeFrequency | Available | INTERESTBASESETTINGS.INTERESTCHARGEFREQUENCY | Charge frequency (e.g., MONTHLY) |
| └─ interestChargeFrequencyCount | Available | INTERESTBASESETTINGS.INTERESTCHARGEFREQUENCYCOUNT | Frequency count |
| └─ interestRate | Available | INTERESTACCOUNTSETTINGS.INTERESTRATE | Interest rate (Decimal(38,18)) |
| └─ interestRateReviewCount | Available | INTERESTBASESETTINGS.INTERESTRATEREVIEWCOUNT | Review count |
| └─ interestRateSource | Available | INTERESTBASESETTINGS.INTERESTRATESOURCE | Rate source |
| └─ interestRateTerms | Available | INTERESTBASESETTINGS.INTERESTRATETERMS | Rate terms |
| └─ interestSpread | Available | INTERESTACCOUNTSETTINGS.INTERESTSPREAD | Interest spread (Decimal(38,18)) |
| overdraftInterestSettings | Available | INTERESTACCOUNTSETTINGS + INTERESTBASESETTINGS | Struct from joined tables (overdraft) |
| └─ encodedKey | Available | INTERESTACCOUNTSETTINGS.ENCODEDKEY | Overdraft interest settings identifier |
| └─ interestChargeFrequency | Available | INTERESTBASESETTINGS.INTERESTCHARGEFREQUENCY | Charge frequency |
| └─ interestChargeFrequencyCount | Available | INTERESTBASESETTINGS.INTERESTCHARGEFREQUENCYCOUNT | Frequency count |
| └─ interestRate | Available | INTERESTACCOUNTSETTINGS.INTERESTRATE | Overdraft interest rate |
| └─ interestRateReviewCount | Available | INTERESTBASESETTINGS.INTERESTRATEREVIEWCOUNT | Review count |
| └─ interestRateSource | Available | INTERESTBASESETTINGS.INTERESTRATESOURCE | Rate source |
| └─ interestRateTerms | Available | INTERESTBASESETTINGS.INTERESTRATETERMS | Rate terms |
| └─ interestSpread | Available | INTERESTACCOUNTSETTINGS.INTERESTSPREAD | Interest spread |
| overdraftSettings | Available | SAVINGSACCOUNT table | Struct containing overdraft configuration |
| └─ allowOverdraft | Available | SAVINGSACCOUNT.ALLOWOVERDRAFT | Boolean flag for overdraft allowance |
| └─ overdraftExpiryDate | Available | SAVINGSACCOUNT.OVERDRAFTEXPIRYDATE | Overdraft expiry date (UTC timestamp, nullable) |
| └─ overdraftLimit | Available | SAVINGSACCOUNT.OVERDRAFTLIMIT | Overdraft limit amount (Decimal(38,18)) |
| internalControls | Available | SAVINGSACCOUNT table | Struct containing internal control limits |
| └─ maxdepositbalance | Available | SAVINGSACCOUNT.MAXDEPOSITBALANCE | Maximum deposit balance (Decimal(38,18), nullable) |
| └─ maxwithdrawalamount | Available | SAVINGSACCOUNT.MAXWIDTHDRAWLAMOUNT | Maximum withdrawal amount (Decimal(38,18), nullable) |
| └─ recommendedDepositAmount | Available | SAVINGSACCOUNT.RECOMMENDEDDEPOSITAMOUNT | Recommended deposit amount (Decimal(38,18), nullable) |
| └─ targetAmount | Available | SAVINGSACCOUNT.TARGETAMOUNT | Target amount (Decimal(38,18), nullable) |
| customFields[] | Available | CUSTOMFIELD + CUSTOMFIELDVALUE tables | Array of custom field objects (1:N) |
| └─ fieldKey | Available | CUSTOMFIELD.ENCODEDKEY | Custom field identifier |
| └─ fieldName | Available | CUSTOMFIELD.NAME | Custom field name |
| └─ fieldValue | Available | CUSTOMFIELDVALUE.VALUE | Custom field value |
Deposit Products
The DepositProduct Gold data product provides comprehensive deposit product information with nested structures for accounting settings, availability settings, currency settings, fees settings, interest settings, overdraft settings, and more.
| API Field | Status | Source Table | Source Column | Notes |
|---|---|---|---|---|
| Top-Level Fields | ||||
customFields | Available | CUSTOMFIELD + CUSTOMFIELDVALUE | Aggregated from SAVINGS_PRODUCT_INFO type custom fields | Array of structs with fieldKey, fieldName, fieldValue |
encodedKey | Available | SAVINGSPRODUCT | ENCODEDKEY | Primary key |
id | Available | SAVINGSPRODUCT | ID | Product identifier |
name | Available | SAVINGSPRODUCT | NAME | Product name |
creationDate | Available | SAVINGSPRODUCT | CREATIONDATE | Product creation timestamp |
lastModifiedDate | Available | SAVINGSPRODUCT | LASTMODIFIEDDATE | Last modification timestamp |
notes | Available | SAVINGSPRODUCT | DESCRIPTION | Product description/notes |
type | Available | SAVINGSPRODUCT | PRODUCTTYPE | Product type enum |
category | Available | SAVINGSPRODUCT | CATEGORY | Product category |
state | Available | SAVINGSPRODUCT | ACTIVATED | Transformed: 1 → ACTIVE, 0 → INACTIVE |
| Accounting Settings | ||||
accountingSettings.accountingMethod | Available | SAVINGSPRODUCT | ACCOUNTINGMETHOD | Accounting method enum |
accountingSettings.interestAccrualCalculation | Available | SAVINGSPRODUCT | INTERESTACCRUALCALCULATION | Interest accrual calculation method |
accountingSettings.interestAccruedAccountingMethod | Available | SAVINGSPRODUCT | INTERESTACCRUEDACCOUNTINGMETHOD | Interest accrued accounting method |
accountingSettings.accountingRules | Available | GLACCOUNTINGRULE | Aggregated by PRODUCTKEY | Array of structs with all GL accounting rule fields |
| Availability Settings | ||||
availabilitySettings.availableFor | Available | SAVINGSPRODUCT | FORINDIVIDUALS, FORGROUPS | Array: 1 → INDIVIDUALS/GROUPS |
availabilitySettings.branchSettings.forAllBranches | Available | SAVINGSPRODUCT | FORALLBRANCHES | Boolean flag |
availabilitySettings.branchSettings.availableProductBranches | Available | SAVINGSPRODUCTBRANCH | Aggregated BRANCHKEY by PRODUCTKEY | Array of branch keys |
| Currency Settings | ||||
currencySettings.currencies | Available | CURRENCYMAPPING + CURRENCY | Aggregated by PARENTKEY | Array of currency structs (joined CURRENCYMAPPING to CURRENCY on CURRENCYCODE == CODE) |
| Fees Settings | ||||
feesSettings.allowArbitraryFees | Available | SAVINGSPRODUCT | ALLOWARBITRARYFEES | Boolean flag |
feesSettings.fees | Available | SAVINGSPREDEFINEDFEE + SAVINGSPREDEFINEDFEEAMOUNT + PREDEFINEDFEE | Aggregated by SAVINGSPRODUCT_ENCODEDKEY | Array of fee structs with all fee-related fields |
| Interest Settings | ||||
interestSettings.collectInterestWhenLocked | Available | SAVINGSPRODUCT | COLLECTINTERESTWHENLOCKED | Boolean flag |
interestSettings.daysInYear | Available | SAVINGSPRODUCT | INTERESTDAYSINYEAR | Days in year method enum |
interestSettings.interestCalculationBalance | Available | SAVINGSPRODUCT | INTERESTCALCULATIONBALANCE | Interest calculation balance enum |
interestSettings.interestGainsProvidedStartDate | Available | SAVINGSPRODUCT | INTERESTSETEXTERNALLYSTARTDATE | Date field |
interestSettings.interestGainsProvidedEndDate | Available | SAVINGSPRODUCT | INTERESTSETEXTERNALLYENDDATE | Date field |
interestSettings.interestPaidIntoAccount | Available | SAVINGSPRODUCT | INTERESTPAIDINTOACCOUNT | Boolean flag |
interestSettings.interestPaymentSettings.interestPaymentDates | Available | SAVINGSPRODUCT | INTERESTPAYMENTDATES | Array of dates |
interestSettings.interestPaymentSettings.interestPaymentPoint | Available | SAVINGSPRODUCT | INTERESTPAYMENTPOINT | Payment point enum |
interestSettings.interestRateSettings | Available | INTERESTPRODUCTSETTINGS + INTERESTBASESETTINGS + INDEXRATESOURCE + INDEXRATE + INTERESTRATETIER | Complex aggregation | Array of structs with interest rate settings, index rates, and tiers |
interestSettings.maximumBalance | Available | SAVINGSPRODUCT | MAXIMUMBALANCE | Decimal field |
| Internal Controls | ||||
internalControls.dormancyPeriodDays | Available | SAVINGSPRODUCT | DORMANCYPERIODDAYS | Integer field |
internalControls.maxWithdrawalAmount | Available | SAVINGSPRODUCT | MAXWIDTHDRAWLAMOUNT | Decimal field |
internalControls.openingBalance.defaultValue | Available | SAVINGSPRODUCT | DEFAULTOPENINGBALANCE | Decimal field |
internalControls.openingBalance.maxValue | Available | SAVINGSPRODUCT | MAXOPENINGBALANCE | Decimal field |
internalControls.openingBalance.minValue | Available | SAVINGSPRODUCT | MINOPENINGBALANCE | Decimal field |
internalControls.recommendedDepositAmount | Available | SAVINGSPRODUCT | RECOMMENDEDDEPOSITAMOUNT | Decimal field |
| Maturity Settings | ||||
maturitySettings.maturityPeriod.defaultValue | Available | SAVINGSPRODUCT | DEFAULTMATURITYPERIOD | Integer field |
maturitySettings.maturityPeriod.maxValue | Available | SAVINGSPRODUCT | MAXMATURITYPERIOD | Integer field |
maturitySettings.maturityPeriod.minValue | Available | SAVINGSPRODUCT | MINMATURITYPERIOD | Integer field |
maturitySettings.maturityPeriodUnit | Available | SAVINGSPRODUCT | MATURITYPERIODUNIT | Maturity period unit enum |
| New Account Settings | ||||
newAccountSettings.idGeneratorType | Available | SAVINGSPRODUCT | IDGENERATORTYPE | ID generator type enum |
newAccountSettings.idPattern | Available | SAVINGSPRODUCT | IDPATTERN | ID pattern string |
| Offset Settings | ||||
offsetSettings.allowOffset | Available | SAVINGSPRODUCT | ALLOWOFFSET | Boolean flag |
| Overdraft Interest Settings | ||||
overdraftInterestSettings.daysInYear | Available | SAVINGSPRODUCT | OVERDRAFTDAYSINYEAR | Days in year method enum |
overdraftInterestSettings.interestCalculationBalance | Available | SAVINGSPRODUCT | OVERDRAFTINTERESTCALCULATIONBALANCE | Interest calculation balance enum |
overdraftInterestSettings.interestRateSettings | Available | INTERESTPRODUCTSETTINGS + INTERESTBASESETTINGS + INDEXRATESOURCE + INDEXRATE + INTERESTRATETIER | Complex aggregation via OVERDRAFTINTERESTRATESETTINGSKEY | Struct with indexSourceKey, interestRate, interestRateSource, interestRateTerms, interestChargeFrequency, interestRateReviewUnit, interestRateTiers |
| Overdraft Settings | ||||
overdraftSettings.allowOverdraft | Available | SAVINGSPRODUCT | ALLOWOVERDRAFT | Boolean flag |
overdraftSettings.allowTechnicalOverdraft | Available | SAVINGSPRODUCT | ALLOWTECHNICALOVERDRAFT | Boolean flag |
overdraftSettings.maxOverdraftLimit | Available | SAVINGSPRODUCT | MAXOVERDRAFTLIMIT | Decimal field |
| Tax Settings | ||||
taxSettings.withholdingTaxEnabled | Available | SAVINGSPRODUCT | WITHHOLDINGTAXENABLED | Boolean flag |
| Unmapped Fields | ||||
creditArrangementSettings | Available | SAVINGSPRODUCT | LINEOFCREDITREQUIREMENT | Field exists in source but not yet mapped in _transform_to_json |
templates | Not available | PRODUCTTEMPLATE or similar | Unknown | Document templates - not currently mapped |
technicalOverdraftInterestSettings | Not available | N/A | N/A | Explicitly ignored in API mapper (@Mapping(target = "technicalOverdraftInterestSettings", ignore = true)) |
Deposit Transaction
The DepositsTransaction Gold data product provides comprehensive deposit transaction information with nested structures for account balances, affected amounts, fees, taxes, terms, card transactions, payment details, and transaction details.
| Field Path | Status | Source | Implementation Notes |
|---|---|---|---|
| accountBalances | Available | SAVINGSTRANSACTION | Nested struct with balance fields |
| └─ totalBalance | Available | SAVINGSTRANSACTION.BALANCE | Total balance |
| adjustmentTransactionKey | Available | SAVINGSTRANSACTION.REVERSALTRANSACTIONKEY | Key of reversal transaction |
| affectedAmounts | Available | SAVINGSTRANSACTION | Nested struct with 9 amount fields |
| └─ feesAmount | Available | SAVINGSTRANSACTION.FEESAMOUNT | Fees amount |
| └─ fractionAmount | Available | SAVINGSTRANSACTION.FRACTIONAMOUNT | Fraction amount |
| └─ fundsAmount | Available | SAVINGSTRANSACTION.FUNDSAMOUNT | Funds amount |
| └─ interestAmount | Available | SAVINGSTRANSACTION.INTERESTAMOUNT | Interest amount |
| └─ overdraftAmount | Available | SAVINGSTRANSACTION.OVERDRAFTAMOUNT | Overdraft amount |
| └─ overdraftFeesAmount | Available | SAVINGSTRANSACTION.OVERDRAFTFEESAMOUNT | Overdraft fees amount |
| └─ overdraftInterestAmount | Available | SAVINGSTRANSACTION.OVERDRAFTINTERESTAMOUNT | Overdraft interest amount |
| └─ technicalOverdraftAmount | Available | SAVINGSTRANSACTION.TECHNICALOVERDRAFTAMOUNT | Technical overdraft amount |
| └─ technicalOverdraftInterestAmount | Available | SAVINGSTRANSACTION.TECHNICALOVERDRAFTINTERESTAMOUNT | Technical overdraft interest amount |
| amount | Available | SAVINGSTRANSACTION.AMOUNT | Transaction amount |
| blockId | Not available | BLOCKFUNDTRANSACTIONSOURCE.BLOCKFUNDKEY → BLOCKFUND.ENCODEDKEY | Block fund ID (table not in Silver yet - will be added as new field) |
| bookingDate | Not available | GLJOURNALENTRY.ENTRYDATE | Date when journal entry is booked (table not in Silver yet - will be added as new field) |
| branchKey | Available | SAVINGSTRANSACTION.BRANCHKEY | Branch where transaction was performed |
| cardTransaction | Available | CARDTRANSACTIONSOURCE + CARDACCEPTOR | Nested struct with card transaction details |
| └─ advice | Available | CARDTRANSACTIONSOURCE.ISADVICE | Whether transaction is advice |
| └─ amount | Available | CARDTRANSACTIONSOURCE.AMOUNT | Card transaction amount |
| └─ cardAcceptor | Available | CARDACCEPTOR | Nested card acceptor details |
| └─ city | Available | CARDACCEPTOR.CITY | City |
| └─ country | Available | CARDACCEPTOR.COUNTRY | Country |
| └─ mcc | Available | CARDACCEPTOR.MCC | Merchant category code |
| └─ name | Available | CARDACCEPTOR.NAME | Merchant name |
| └─ state | Available | CARDACCEPTOR.STATE | State |
| └─ street | Available | CARDACCEPTOR.STREET | Street address |
| └─ zip | Available | CARDACCEPTOR.ZIP | ZIP code |
| └─ cardToken | Available | CARDTRANSACTIONSOURCE.CARDREFERENCETOKEN | Card reference token |
| └─ currencyCode | Available | CARDTRANSACTIONSOURCE.CURRENCYCODE | Currency code |
| └─ encodedKey | Available | CARDTRANSACTIONSOURCE.ENCODEDKEY | Card transaction source key |
| └─ externalAuthorizationReferenceId | Available | CARDTRANSACTIONSOURCE.EXTERNALAUTHORIZATIONREFERENCEID | External authorization reference |
| └─ externalReferenceId | Available | CARDTRANSACTIONSOURCE.EXTERNALREFERENCEID | External reference ID |
| └─ userTransactionTime | Available | CARDTRANSACTIONSOURCE.USERTRANSACTIONTIME | User transaction time |
| centreKey | Available | SAVINGSTRANSACTION.CENTREKEY | Centre where transaction was performed |
| creationDate | Available | SAVINGSTRANSACTION.CREATIONDATE | Transaction creation date (UTC) |
| currencyCode | Available | SAVINGSTRANSACTION.CURRENCYCODE | Currency code |
| encodedKey | Available | SAVINGSTRANSACTION.ENCODEDKEY | Primary key (UUID) |
| externalId | Available | SAVINGSTRANSACTION.EXTERNALID | External ID |
| fees | Available | SAVINGSPREDEFINEDFEE + SAVINGSPREDEFINEDFEEAMOUNT + PREDEFINEDFEE | Array of fee structures |
| └─ (all fee fields) | Available | Aggregated from multiple tables | Complete fee structure with amounts and predefined fee details |
| holdExternalReferenceId | Available | BLOCKFUND.EXTERNALREFERENCEID | External reference ID of account authorization hold |
| id | Available | SAVINGSTRANSACTION.TRANSACTIONID | Transaction ID |
| interestAccruedAmounts | Available | SAVINGSINTERESTTRANSACTIONAMOUNTS | Nested struct with interest accrued amounts |
| └─ interestAccrued | Available | SAVINGSINTERESTTRANSACTIONAMOUNTS.INTERESTACCRUED | Interest accrued |
| └─ negativeInterestAccrued | Available | SAVINGSINTERESTTRANSACTIONAMOUNTS.NEGATIVEINTERESTACCRUED | Negative interest accrued |
| └─ overdraftInterestAccrued | Available | SAVINGSINTERESTTRANSACTIONAMOUNTS.OVERDRAFTINTERESTACCRUED | Overdraft interest accrued |
| └─ technicalOverdraftInterestAccrued | Available | SAVINGSINTERESTTRANSACTIONAMOUNTS.TECHNICALOVERDRAFTINTERESTACCRUED | Technical overdraft interest accrued |
| migrationEventKey | Available | SAVINGSTRANSACTION.MIGRATIONEVENTKEY | Migration event key |
| notes | Available | SAVINGSTRANSACTION.COMMENT | Transaction notes/comment |
| originalTransactionKey | Not available | Service logic (OriginalTransactionApiEnhancer) | Original transaction key for reversal transactions (complex service logic - will be added when logic can be replicated) |
| parentAccountKey | Available | SAVINGSTRANSACTION.PARENTACCOUNTKEY | Parent deposit account key |
| paymentDetails | Available | PAYMENTDETAILS | Nested struct with payment details (creditor, debtor, payment identification, etc.) |
| └─ creditor | Available | PAYMENTDETAILS.CREDITORNAME | Creditor name |
| └─ creditorAccount | Available | PAYMENTDETAILS | Creditor account details (currency, IBAN, other identification) |
| └─ creditorAgent | Available | PAYMENTDETAILS.CREDITORAGENTBIC | Creditor agent BIC |
| └─ debtor | Available | PAYMENTDETAILS.DEBTORNAME | Debtor name |
| └─ debtorAccount | Available | PAYMENTDETAILS | Debtor account details (currency, IBAN, other identification) |
| └─ debtorAgent | Available | PAYMENTDETAILS.DEBTORAGENTBIC | Debtor agent BIC |
| └─ paymentIdentfication | Available | PAYMENTDETAILS | Payment identification (end-to-end, instruction, transaction) |
| └─ paymentTypeInformation | Available | PAYMENTDETAILS.SERVICELEVELCODE | Payment type information (service level code) |
| └─ remittanceInformation | Available | PAYMENTDETAILS | Remittance information (structured and unstructured) |
| paymentOrderId | Available | SAVINGSTRANSACTION.PAYMENTORDERID | Payment order ID |
| taxes | Available | INDEXRATE | Nested struct with tax rate |
| └─ taxRate | Available | INDEXRATE.RATE | Tax rate (from TAXRATE_ENCODEDKEY_OID) |
| terms | Available | SAVINGSTRANSACTION + INTERESTACCOUNTSETTINGS + INDEXRATE + SAVINGSACCOUNT | Nested struct with interest settings, overdraft settings |
| └─ interestSettings | Available | Nested struct | Interest rate settings |
| └─ indexInterestRate | Available | INDEXRATE.RATE (conditional) | Index interest rate (if transaction type is INTEREST_RATE_CHANGED) |
| └─ interestRate | Available | INTERESTACCOUNTSETTINGS.INTERESTRATE | Transaction interest rate |
| └─ overdraftInterestSettings | Available | Nested struct | Overdraft interest rate settings |
| └─ indexInterestRate | Available | INDEXRATE.RATE (conditional) | Index interest rate (if transaction type is NOT INTEREST_RATE_CHANGED) |
| └─ interestRate | Available | INDEXRATE.RATE (from OVERDRAFT_INDEXRATE_KEY) | Overdraft interest rate |
| └─ overdraftSettings | Available | Nested struct | Overdraft settings |
| └─ overdraftLimit | Available | SAVINGSACCOUNT.OVERDRAFTLIMIT | Overdraft limit |
| tillKey | Available | SAVINGSTRANSACTION.TILLKEY | Till key |
| transactionDetails | Available | TRANSACTIONDETAILS + TRANSACTIONCHANNEL | Nested struct with transaction channel info |
| └─ transactionChannelId | Available | TRANSACTIONCHANNEL.ID | Transaction channel ID |
| └─ transactionChannelKey | Available | INDEXRATE.ENCODEDKEY (from tax rate) | Transaction channel key (mapped from tax rate encoded key) |
| transferDetails | Available | SAVINGSTRANSACTION | Nested struct with linked transaction keys |
| └─ linkedDepositTransactionKey | Available | SAVINGSTRANSACTION.LINKEDSAVINGSTRANSACTIONKEY | Linked deposit transaction key |
| └─ linkedLoandTransactionKey | Available | SAVINGSTRANSACTION.LINKEDLOANTRANSACTIONKEY | Linked loan transaction key |
| type | Available | SAVINGSTRANSACTION.TYPE | Transaction type |
| userKey | Available | SAVINGSTRANSACTION.USERKEY | User who performed the transaction |
| valueDate | Available | SAVINGSTRANSACTION.ENTRYDATE | Date of the entry (as Organization Time) |
General Ledger Account
The GlAccount Gold data product provides General Ledger account information with currency details and account configuration settings.
| Field Path | Status | Source | Implementation Notes |
|---|---|---|---|
| activated | Available | GLACCOUNT.ACTIVATED | Boolean flag for account activation status |
| allowManualJournalEntries | Available | GLACCOUNT.ALLOWMANUALJOURNALENTRIES | Whether manual journal entries are allowed |
| balance | Not available | @NotPersistent | Runtime calculation from GLJournalEntry records |
| creationDate | Available | GLACCOUNT.CREATIONDATE | Stored as UTC timestamp |
| currency | Available | GLACCOUNT.CURRENCYCODE → CURRENCY | Nested currency object |
| └─ code | Available | CURRENCY.CODE | ISO-4217 currency code or NON_FIAT |
| └─ currencyCode | Available | CURRENCY.CODE | Same as code (API requirement) |
| description | Available | GLACCOUNT.DESCRIPTION | Long text description of the account |
| encodedKey | Available | GLACCOUNT.ENCODEDKEY | Primary key (UUID) |
| glCode | Available | GLACCOUNT.GLCODE | GL code for categorization (e.g., "3201") |
| lastModifiedDate | Available | GLACCOUNT.LASTMODIFIEDDATE | Stored as UTC timestamp |
| migrationEventKey | Available | GLACCOUNT.MIGRATIONEVENTKEY | Data migration event reference |
| name | Available | GLACCOUNT.NAME | Account display name |
| stripTrailingZeros | Available | GLACCOUNT.STRIPTRAILINGZEROS | Boolean for report formatting |
| type | Available | GLACCOUNT.TYPE | ASSET, LIABILITY, INCOME, EXPENSE, EQUITY |
| usage | Available | GLACCOUNT.USAGE | DETAIL or HEADER |
General Ledger Journal Entry
The GLJournalEntry Gold data product provides General Ledger journal entry transactions with complete GL Account information, foreign currency details, and accounting rate conversions.
| Field Path | Status | Source | Implementation Notes |
|---|---|---|---|
| accountKey | Available | GLJOURNALENTRY.ACCOUNTKEY | FK to account entity (loan/savings), NULL for manual entries |
| amount | Available | GLJOURNALENTRY.AMOUNT | Amount in organization currency, DECIMAL(60, 20) |
| assignedBranchKey | Available | GLJOURNALENTRY.ASSIGNEDBRANCHKEY | FK to BRANCH table |
| bookingDate | Available | GLJOURNALENTRY.ENTRYDATE | Stored as Organization Time |
| creationDate | Available | GLJOURNALENTRY.CREATIONDATE | Stored as UTC timestamp |
| encodedKey | Available | GLJOURNALENTRY.ENCODEDKEY | Primary key (UUID) |
| entryID | Available | GLJOURNALENTRY.ENTRYID | Auto-increment ID, unique per entry |
| foreignAmount | Available | GLJOURNALENTRYFOREIGNAMOUNT | Optional nested object for foreign currency |
| └─ accountingRate | Available | ACCOUNTINGRATE | Exchange rate used for conversion |
| └─ encodedKey | Available | ACCOUNTINGRATE.ENCODEDKEY | Rate identifier |
| └─ endDate | Available | ACCOUNTINGRATE.ENDDATE | Rate validity end (Organization Time) |
| └─ fromCurrencyCode | Available | ACCOUNTINGRATE.FROMCURRENCYCODE | Organization currency |
| └─ rate | Available | ACCOUNTINGRATE.RATE | Conversion rate value |
| └─ startDate | Available | ACCOUNTINGRATE.STARTDATE | Rate validity start (Organization Time) |
| └─ toCurrencyCode | Available | ACCOUNTINGRATE.TOCURRENCYCODE | Foreign currency |
| └─ amount | Available | GLJOURNALENTRYFOREIGNAMOUNT.AMOUNT | Amount in foreign currency |
| └─ currency | Available | CURRENCY via GLJOURNALENTRYFOREIGNAMOUNT.CURRENCYCODE | Foreign currency details |
| └ ─ code | Available | CURRENCY.CODE | Currency code |
| └─ currencyCode | Available | CURRENCY.CODE | Same as code (API requirement) |
| glAccount | Available | GLACCOUNT | Full nested GL Account object |
| └─ activated | Available | GLACCOUNT.ACTIVATED | Account activation status |
| └─ allowManualJournalEntries | Available | GLACCOUNT.ALLOWMANUALJOURNALENTRIES | Configuration flag |
| └─ balance | Not available | @NotPersistent | See GlAccount mapping analysis |
| └─ creationDate | Available | GLACCOUNT.CREATIONDATE | Account creation timestamp |
| └─ currency | Available | CURRENCY via GLACCOUNT.CURRENCYCODE | GL Account currency |
| └─ code | Available | CURRENCY.CODE | Currency code |
| └─ currencyCode | Available | CURRENCY.CODE | Same as code |
| └─ description | Available | GLACCOUNT.DESCRIPTION | Account description |
| └─ encodedKey | Available | GLACCOUNT.ENCODEDKEY | GL Account identifier |
| └─ glCode | Available | GLACCOUNT.GLCODE | GL code for categorization |
| └─ lastModifiedDate | Available | GLACCOUNT.LASTMODIFIEDDATE | Last modification timestamp |
| └─ migrationEventKey | Available | GLACCOUNT.MIGRATIONEVENTKEY | Migration reference |
| └─ name | Available | GLACCOUNT.NAME | Account display name |
| └─ stripTrailingZeros | Available | GLACCOUNT.STRIPTRAILINGZEROS | Formatting flag |
| └─ type | Available | GLACCOUNT.TYPE | ASSET, LIABILITY, INCOME, EXPENSE, EQUITY |
| └─ usage | Available | GLACCOUNT.USAGE | DETAIL or HEADER |
| notes | Available | GLJOURNALENTRY.NOTES | Optional user notes |
| productKey | Available | GLJOURNALENTRY.PRODUCTKEY | FK to product entity, NULL for manual entries |
| productType | Available | GLJOURNALENTRY.PRODUCTTYPE | LOAN, SAVINGS, etc., NULL for manual entries |
| reversalEntryKey | Available | GLJOURNALENTRY.REVERSALENTRYKEY | FK to reversing journal entry, NULL if not reversed |
| transactionId | Available | GLJOURNALENTRY.TRANSACTIONID | Groups related journal entries |
| type | Available | GLJOURNALENTRY.TYPE | DEBIT or CREDIT |
| userKey | Available | GLJOURNALENTRY.USERKEY | User who performed the transaction |
Group
The Group Gold data product provides information about client groups (solidarity groups, village banking groups, etc.) including group details, addresses, and member information with roles. Groups are used for group lending methodologies where multiple clients form a collective borrowing unit.
| Field Path | Status | Source | Implementation Notes |
|---|---|---|---|
| encodedKey | Available | GROUP.ENCODEDKEY | Primary key (UUID, auto-generated) |
| id | Available | GROUP.ID | Business identifier, unique, user-defined |
| groupName | Available | GROUP.GROUPNAME | Required field |
| creationDate | Available | GROUP.CREATIONDATE | Stored as UTC timestamp |
| lastModifiedDate | Available | GROUP.LASTMODIFIEDDATE | Stored as UTC timestamp |
| emailAddress | Available | GROUP.EMAILADDRESS | Group email |
| homePhone | Available | GROUP.HOMEPHONE | Group phone |
| mobilePhone | Available | GROUP.MOBILEPHONE1 | Group mobile |
| notes | Available | GROUP.NOTES | Long text field (LONGVARCHAR, lazy-loaded) |
| assignedBranchKey | Available | GROUP.ASSIGNEDBRANCHKEY | FK to BRANCH table |
| assignedCentreKey | Available | GROUP.ASSIGNEDCENTREKEY | FK to CENTRE table (optional) |
| assignedUserKey | Available | GROUP.ASSIGNEDUSERKEY | FK to USER table (loan officer) |
| groupRoleKey | Available | GROUP.CLIENTROLEKEY | FK to CLIENTROLE table |
| loanCycle | Available | GROUP.LOANCYCLE | Number of group loans completed |
| migrationEventKey | Available | GROUP.MIGRATIONEVENTKEY | FK to data migration event |
| preferredLanguage | Available | GROUP.PREFERREDLANGUAGE | ISO 639-1 language code |
| addresses[] | Available | ADDRESS table | Array of addresses (1:N), filtered by PARENTKEY |
| └─ All address fields | Available | Same as Branch/Client | Same ADDRESS table structure |
| groupMembers[] | Available | GROUPMEMBER + GROUPROLE | Member list with complete role mapping |
| └─ clientKey | Available | GROUPMEMBER.CLIENTKEY | FK to CLIENT table |
| └─ roles[] | Available | GROUPROLE table | Aggregated via CTE with collect_list |
| └─ encodedKey | Available | GROUPROLE.ENCODEDKEY | Role assignment identifier |
| └─ groupRoleNameKey | Available | GROUPROLE.GROUPROLENAMEKEY | FK to GROUPROLENAME |
| └─ roleName | Available | GROUPROLENAME.NAME | Role display name (e.g., "President") |
| └─ roleNameId | Available | GROUPROLENAME.ID | Role ID (e.g., "PRESIDENT") |
| customFields | Not available | CUSTOMFIELDVALUE table | Not implemented (GROUP_INFO entity type) |
Loan Account
The LoanAccount Gold data product provides comprehensive loan account information with nested structures for arrears settings, balances, disbursement details, interest settings, penalty settings, assets, guarantors, and funding sources.
| Field Path | Status | Source | Implementation Notes |
|---|---|---|---|
| accountArrearsSettings | Available | ACCOUNTARREARSSETTINGS + BASEARREARSSETTINGS | Joined via joinArrearsSettings() |
| └─ dateCalculationMethod | Available | BASEARREARSSETTINGS.DATECALCULATIONMETHOD | Direct mapping |
| └─ encodedKey | Available | BASEARREARSSETTINGS.ENCODEDKEY | Direct mapping |