Mambu integration summary

Stitch’s Mambu integration replicates data using the Mambu v2.0 and v1.0 APIs. Refer to the Schema section for a list of objects available for replication.

Mambu feature snapshot

A high-level look at Stitch's Mambu integration, including release status, useful links, and the features supported in Stitch.

STITCH
Release Status

Open Beta

Supported By

Singer Community

Stitch Plan

Free

Singer GitHub Repository

Mambu Repository

DATA SELECTION
Table Selection

Supported

Column Selection

Supported

REPLICATION SETTINGS
Anchor Scheduling

Supported

Advanced Scheduling

Supported

Table-level Reset

Unsupported

Configurable Replication Methods

Unsupported

TRANSPARENCY
Extraction Logs

Supported

Loading Reports

Supported

Connecting Mambu

Mambu setup requirements

To set up Mambu in Stitch, you need:

  • A Mambu account with API access. The Mambu integration requires an account login with API access. In Mambu’s app, API access can be granted to any existing user.

Step 1: Add Mambu as a Stitch data source

  1. Sign into your Stitch account.
  2. On the Stitch Dashboard page, click the Add Integration button.

  3. Click the Mambu icon.

  4. Enter a name for the integration. This is the name that will display on the Stitch Dashboard for the integration; it’ll also be used to create the schema in your destination.

    For example, the name “Stitch Mambu” would create a schema called stitch_mambu in the destination. Note: Schema names cannot be changed after you save the integration.

  5. In the Subdomain field, enter your Mambu subdomain. For example: If the subdomain were stitch.mambu.com, only stitch would be entered into this field.
  6. In the Username and Password fields, enter the username and password of the Mambu user with Mambu API access.

Step 2: Define the historical sync

The Sync Historical Data setting will define the starting date for your Mambu integration. This means that:

  • For tables using Incremental Replication, data equal to or newer than this date will be replicated to your data warehouse.
  • For tables using Full Table Replication, all data - including records that are older, equal to, or newer than this date - will be replicated to your data warehouse.

Change this setting if you want to replicate data beyond Mambu’s default setting of 1 year. For a detailed look at historical replication jobs, check out the Syncing Historical SaaS Data guide.

Step 3: Create a replication schedule

In the Replication Frequency section, you’ll create the integration’s replication schedule. An integration’s replication schedule determines how often Stitch runs a replication job, and the time that job begins.

Mambu integrations support the following replication scheduling methods:

To keep your row usage low, consider setting the integration to replicate less frequently. See the Understanding and Reducing Your Row Usage guide for tips on reducing your usage.

Step 4: Set tables and columns to replicate

To complete the setup, you’ll need to select the tables and columns you want to replicate to your data warehouse.

Check out the Schema section to learn more about the available tables in Mambu and how they replicate.

  1. In the list of tables that displays - or in the Tables to Replicate tab, if you skipped this step during setup - locate a table you want to replicate.
  2. To track a table, click the checkbox next to the table’s name. A green checkmark means the table is set to replicate.

  3. To track a column, click the checkbox next to the column’s name. A green checkmark means the column is set to replicate.

  4. Repeat this process for all the tables and columns you want to replicate.
  5. When finished, click the Finalize Your Selections button at the bottom of the screen to save your selections.

Note: If you change these settings while a replication job is still in progress, they will not be used until the next job starts.

Initial and historical replication jobs

After you finish setting up Mambu, its Sync Status may show as Pending on either the Stitch Dashboard or in the Integration Details page.

For a new integration, a Pending status indicates that Stitch is in the process of scheduling the initial replication job for the integration. This may take some time to complete.

Free historical data loads

The first seven days of replication, beginning when data is first replicated, are free. Rows replicated from the new integration during this time won’t count towards your quota. Stitch offers this as a way of testing new integrations, measuring usage, and ensuring historical data volumes don’t quickly consume your quota.


Mambu table schemas

Replication Method :

Key-based Incremental

Replication Key :

last_modified_date

Primary Key :

id

API endpoint :

Get all branches

This table contains information about Branches.

id
STRING

The unique branch ID.

last_modified_date
DATE-TIME

The last date and time that the branch was modified.

addresses
ARRAY

A list of branch addresses.

country
STRING

parent_key
STRING

city
STRING

latitude
NUMBER

postcode
STRING

index_in_list
INTEGER

encoded_key
STRING

region
STRING

line2
STRING

line1
STRING

longitude
NUMBER

branches (table), addresses (attribute)

branch_holidays
ARRAY

A list of branch holidays.

name
STRING

date
STRING

encoded_key
STRING

is_anually_recurring
BOOLEAN

creation_date
STRING

branches (table), branch_holidays (attribute)

creation_date
DATE-TIME

The branch creation date.

custom_field_sets
ARRAY

custom_field_set_id
STRING

Reference:

custom_field_values
ARRAY

branches (table), custom_field_sets (attribute)

email_address
STRING

The branch email address.

encoded_key
STRING

The entity’s encoded key. This value is generated and globally unique.

Reference:

name
STRING

The branch name.

notes
STRING

Notes about the branch.

phone_number
STRING

The branch phone number.

state
STRING

The branch state.


Replication Method :

Full Table

Primary Key :

deposit_id : reference_token

API endpoint :

Get all cards

This table contains information about cards.

Note: To replicate this table, the deposit_accounts table must also be set to replicate.

deposit_id
STRING

The deposit ID.

reference_token
STRING

The token used to externally identify the card.


Replication Method :

Key-based Incremental

Replication Key :

last_modified_date

Primary Key :

id

API endpoint :

Get all centres

This table contains information about Centers.

id
STRING

The unique center ID.

last_modified_date
DATE-TIME

The last date and time that the center was modified.

addresses
ARRAY

The list of addresses for a center.

country
STRING

parent_key
STRING

city
STRING

latitude
NUMBER

postcode
STRING

index_in_list
INTEGER

encoded_key
STRING

region
STRING

line2
STRING

line1
STRING

longitude
NUMBER

centres (table), addresses (attribute)

assigned_branch_key
STRING

The encoded key of the branch that the center is assigned to.

Reference:

creation_date
DATE-TIME

The center creation date.

custom_field_sets
ARRAY

custom_field_set_id
STRING

Reference:

custom_field_values
ARRAY

centres (table), custom_field_sets (attribute)

encoded_key
STRING

The encoded key of the entity. This value is generated and globally unique.

Reference:

meeting_day
STRING

The day of the week that repayments are collected.

name
STRING

The center name.

notes
STRING

Notes about the center.

state
STRING

The center state.


Replication Method :

Key-based Incremental

Replication Key :

last_modified_date

Primary Key :

id

API endpoint :

Get all clients

This table contains information about Clients.

id
STRING

The unique client ID.

last_modified_date
DATE-TIME

The last date and time that the client was modified.

activation_date
DATE-TIME

The first date that the client was set as active.

addresses
ARRAY

country
STRING

parent_key
STRING

city
STRING

latitude
NUMBER

postcode
STRING

index_in_list
INTEGER

encoded_key
STRING

region
STRING

line2
STRING

line1
STRING

longitude
NUMBER

clients (table), addresses (attribute)

approved_date
DATE-TIME

The date when the client was approved.

assigned_centre_key
STRING

Ended key of the center that the client is assigned to.

Reference:

assigned_user_key
STRING

The encoded key of the user that the client is assigned to.

Reference:

birth_date
DATE

The date that the client born.

client_role_key
STRING

The role which describes the client’s use within the system.

closed_date
DATE-TIME

The date that the client was closed.

creation_date
DATE-TIME

The date that the client was created.

custom_field_sets
ARRAY

custom_field_set_id
STRING

Reference:

custom_field_values
ARRAY

clients (table), custom_field_sets (attribute)

email_address
STRING

The client’s email address.

encoded_key
STRING

The encoded key of the client. This value is generated and globally unique.

first_name
STRING

The client’s first name.

gender
STRING

The client’s gender.

group_loan_cycle
INTEGER

The number of paid and closed accounts for this client’s group.

home_phone
STRING

The client’s home phone number.

id_documents
ARRAY

identification_document_template_key
STRING

issuing_authority
STRING

client_key
STRING

document_type
STRING

index_in_list
INTEGER

valid_until
STRING

encoded_key
STRING

document_id
STRING

clients (table), id_documents (attribute)

last_name
STRING

The client’s last name.

middle_name
STRING

The client’s middle name.

migration_event_key
STRING

The encoded key of the migration event that the client is assigned to.

mobile_phone
STRING

The client’s mobile phone number.

notes
STRING

Notes about the client.

preferred_language
STRING

The client’s preferred language selection in Mambu.

profile_picture_key
STRING

The encoded key of the client’s profile picture.

profile_signature_key
STRING

The encoded key of the client’s profile signature.

state
STRING

The state of the client’s workflow status.


Replication Method :

Key-based Incremental

Replication Key :

creation_date

Primary Key :

encoded_key

API endpoint :

Search all communications

This table contains information about Communications.

encoded_key
STRING

The encoded key of the communication. This value is generated and unique.

creation_date
DATE-TIME

The date and time the communication was created - as UTC.

body
STRING

The message body text.

client_key
STRING

The client the message was sent to.

Reference:

custom_field_sets
ARRAY

custom_field_set_id
STRING

Reference:

custom_field_values
ARRAY

communications (table), custom_field_sets (attribute)

deposit_account_key
STRING

The deposit account about which the message was sent.

Reference:

destination
STRING

The phone number or email address that the communication was sent to.

event
STRING

The event for which the message was sent.

failure_cause
STRING

The failure code of the failed message.

failure_reason
STRING

The reason the message failed to send.

group_key
STRING

The group that the message was sent to.

loan_account_key
STRING

The load account for which the message was sent.

num_retries
INTEGER

The number of retries to send the message.

reference_id
STRING

The reference ID of the communication. This value is generated by the SMS Dispatcher.

repayment_key
STRING

The repayment about which the the message was sent.

send_date
DATE-TIME

The date and time the communication was actually sent - as UTC.

sender_key
STRING

The encoded key of the sender.

state
STRING

The state of the message.

subject
STRING

The subject of the message.

template_key
STRING

The communication template key.

type
STRING

The type of communication.

user_key
STRING

The user the message was sent to.

Reference:


credit_arrangements

Replication Method :

Key-based Incremental

Replication Key :

last_modified_date

Primary Key :

id

API endpoint :

Get all credit arrangements

This table contains information about Credit Arrangements.

id
STRING

The unique credit arrangement ID.

last_modified_date
DATE-TIME

The last date and time that the credit arrangement was modified.

amount
NUMBER

The maximum credit amount the client can be exposed to.

approved_date
DATE-TIME

The date the credit arrangement was approved.

available_credit_amount
NUMBER

The amount of credit available in the arrangement.

consumed_credit_amount
NUMBER

The amount of credit used. This is the difference taken from the amount and available credit amount.

creation_date
DATE-TIME

The date the credit arrangement was created.

custom_field_sets
ARRAY

custom_field_set_id
STRING

Reference:

custom_field_values
ARRAY

credit_arrangements (table), custom_field_sets (attribute)

encoded_key
STRING

The encoded key of the credit arrangement. This value is auto-generated and unique.

expire_date
DATE-TIME

The date the credit arrangement expires.

holder_key
STRING

The encoded key of the client or group.

holder_type
STRING

The line of credit holder’s type - client or group.

notes
STRING

The description of the credit arrangement.

start_date
DATE-TIME

The start date from which the credit arrangement becomes active.

state
STRING

The state of the credit arrangement. Possible values are:

  • Pending Approval
  • Approved
  • Active
  • Closed

sub_state
STRING

The substate of the credit arrangement. This will either be Withdrawn or Rejected when the state of the arrangement is Closed.


custom_field_sets

Replication Method :

Full Table

Primary Key :

id

API endpoint :

Get custom field sets

This table contains information about Custom Field Sets.

id
STRING

Reference:

created_date
DATE-TIME

custom_fields
ARRAY

encoded_key
STRING

id
STRING

Reference:

name
STRING

type
STRING

data_type
STRING

value_length
STRING

is_default
BOOLEAN

is_required
BOOLEAN

index_in_list
INTEGER

state
STRING

unique
BOOLEAN

view_rights
OBJECT

encoded_key
STRING

is_accessible_by_all_users
BOOLEAN

roles
ARRAY

value
STRING

custom_field_sets (table), roles (attribute)
custom_field_sets (table), view_rights (attribute)

edit_rights
OBJECT

encoded_key
STRING

is_accessible_by_all_users
BOOLEAN

roles
ARRAY

value
STRING

custom_field_sets (table), roles (attribute)
custom_field_sets (table), edit_rights (attribute)

amounts
OBJECT

values
ARRAY

value
STRING

custom_field_sets (table), values (attribute)

custom_field_product_settings
ARRAY

encoded_key
STRING

link_type
STRING

product_key
STRING

is_default
BOOLEAN

is_required
BOOLEAN

custom_field_encoded_key
STRING

custom_field_sets (table), custom_field_product_settings (attribute)

custom_field_selection_options
ARRAY

encoded_key
STRING

value
STRING

score
STRING

is_default
STRING

custom_field_sets (table), custom_field_selection_options (attribute)
custom_field_sets (table), custom_fields (attribute)

encoded_key
STRING

index_in_list
INTEGER

last_modified_date
DATE-TIME

name
STRING

notes
STRING

type
STRING

usage
STRING


Replication Method :

Key-based Incremental

Replication Key :

last_modified_date

Primary Key :

id

API endpoint :

Get all deposit accounts

This table contains information about Deposit Accounts.

id
STRING

The deposit account ID.

last_modified_date
DATE-TIME

The date and time the deposit account was last modified.

account_holder_key
STRING

The encoded key of the client or group.

account_holder_type
STRING

The type of the account holder.

account_state
STRING

The state of the deposit account.

account_type
STRING

The type of deposit account.

accrued_amounts
OBJECT

Groups all fields related to a deposit account’s accrued amounts.

interest_accrued
NUMBER

The amount of interest that has been accrued in the account.

overdraft_interest_accrued
NUMBER

The amount of overdraft interest that has been accrued in the account.

technical_overdraft_interest_accrued
NUMBER

The amount of technical overdraft interest that has been accrued in the account.

deposit_accounts (table), accrued_amounts (attribute)

activation_date
DATE-TIME

The date this deposit account was activated.

approved_date
DATE-TIME

The date this deposit account was approved.

balances
OBJECT

Groups all fields related to a deposit account’s balances.

available_balance
NUMBER

The current available balance for deposit transactions.

fees_due
NUMBER

How much in fees is due to be paid on this account.

hold_balance
NUMBER

The sum of all the authorization hold amounts on this account.

locked_balance
NUMBER

No operation can modify the balance of the account and get it lower than this locked balance.

overdraft_amount
NUMBER

How much money has been taken out in overdraft.

overdraft_interest_due
NUMBER

How much interest is due to be paid on this account as a result of the authorized overdraft.

technical_overdraft_amount
NUMBER

How much money has been taken out as unplanned overdraft.

technical_overdraft_interest_due
NUMBER

How much interest is due to be paid on this account as a result of the technical overdraft.

total_balance
NUMBER

The current balance of the account.

deposit_accounts (table), balances (attribute)

closed_date
DATE-TIME

The date this deposit account was closed.

creation_date
DATE-TIME

The date this deposit account was created.

credit_arrangement_key
STRING

The key to the credit arrangement where this account is registered to.

Reference:

currency_code
STRING

custom_field_sets
ARRAY

custom_field_set_id
STRING

Reference:

custom_field_values
ARRAY

deposit_accounts (table), custom_field_sets (attribute)

encoded_key
STRING

interest_settings
OBJECT

interest_payment_settings
OBJECT

interest_payment_dates
NULL

interest_payment_point
STRING

deposit_accounts (table), interest_payment_settings (attribute)

interest_rate_settings
OBJECT

encoded_key
STRING

interest_charge_frequency
STRING

interest_charge_frequency_count
INTEGER

interest_rate
NUMBER

interest_rate_terms
STRING

interest_rate_tiers
NULL

deposit_accounts (table), interest_rate_settings (attribute)
deposit_accounts (table), interest_settings (attribute)

internal_controls
OBJECT

max_withdrawal_amount
NUMBER

recommended_deposit_amount
NUMBER

target_amount
NUMBER

deposit_accounts (table), internal_controls (attribute)

last_account_appraisal_date
DATE-TIME

last_interest_calculation_date
DATE-TIME

last_interest_stored_date
DATE-TIME

last_overdraft_interest_review_date
DATE-TIME

last_sent_to_arrears_date
DATE-TIME

linked_settlement_account_keys
NULL

locked_date
DATE-TIME

maturity_date
DATE-TIME

migration_event_key
STRING

name
STRING

notes
STRING

overdraft_interest_settings
OBJECT

interest_rate_settings
OBJECT

encoded_key
STRING

interest_charge_frequency
STRING

interest_charge_frequency_count
INTEGER

interest_rate
NUMBER

interest_rate_review_count
INTEGER

interest_rate_review_unit
STRING

interest_rate_source
STRING

interest_rate_terms
STRING

interest_rate_tiers
NULL

interest_spread
NUMBER

deposit_accounts (table), interest_rate_settings (attribute)
deposit_accounts (table), overdraft_interest_settings (attribute)

overdraft_settings
OBJECT

allowed_overdraft
BOOLEAN

overdraft_expiry_date
DATE-TIME

overdraft_limit
NUMBER

deposit_accounts (table), overdraft_settings (attribute)

product_type_key
STRING

withholding_tax_source_key
STRING


Replication Method :

Key-based Incremental

Replication Key :

last_modified_date

Primary Key :

id

API endpoint :

Get deposit products

This table contains information about deposit products.

id
STRING

The deposit product ID.

last_modified_date
DATE-TIME

The date and time the deposit product was last modified.

accounting_method
STRING

activated
BOOLEAN

allow_arbitrary_fees
BOOLEAN

allow_offset
BOOLEAN

allow_overdraft
BOOLEAN

allow_technical_overdraft
BOOLEAN

available_product_branches
ARRAY

encoded_key
STRING

branch_key
STRING

deposit_products (table), available_product_branches (attribute)

collect_interest_when_locked
BOOLEAN

creation_date
DATE-TIME

currencies
ARRAY

code
STRING

name
STRING

symbol
STRING

digits_after_decimal
INTEGER

currency_symbol_position
STRING

is_base_currency
BOOLEAN

creation_date
DATE-TIME

last_modified_date
STRING

deposit_products (table), currencies (attribute)

custom_field_values
ARRAY

encoded_key
STRING

parent_key
STRING

custom_field_key
STRING

custom_field
OBJECT

encoded_key
STRING

id
STRING

name
STRING

type
STRING

data_type
STRING

value_length
STRING

is_default
BOOLEAN

is_required
BOOLEAN

custom_field_set
OBJECT

encoded_key
STRING

id
STRING

name
STRING

creation_date
DATE-TIME

last_modified_date
DATE-TIME

index_in_list
INTEGER

type
STRING

usage
STRING

deposit_products (table), custom_field_set (attribute)

index_in_list
INTEGER

state
STRING

custom_field_selection_options
ARRAY

encoded_key
STRING

value
STRING

score
STRING

deposit_products (table), custom_field_selection_options (attribute)

view_rights
OBJECT

encoded_key
STRING

is_accessible_by_all_users
BOOLEAN

roles
ARRAY

value
STRING

deposit_products (table), roles (attribute)
deposit_products (table), view_rights (attribute)

edit_rights
OBJECT

encoded_key
STRING

is_accessible_by_all_users
BOOLEAN

roles
ARRAY

value
STRING

deposit_products (table), roles (attribute)
deposit_products (table), edit_rights (attribute)

unique
BOOLEAN

amounts
OBJECT

values
ARRAY

value
STRING

deposit_products (table), values (attribute)
deposit_products (table), custom_field (attribute)

value
STRING

amount
STRING

index_in_list
INTEGER

custom_field_id
STRING

custom_field_set_group_index
INTEGER

deposit_products (table), custom_field_values (attribute)

description
STRING

encoded_key
STRING

for_all_branches
BOOLEAN

for_groups
BOOLEAN

for_individuals
BOOLEAN

id_generator_type
STRING

id_pattern
STRING

interest_accrued_accounting_method
STRING

interest_calculation_balance
STRING

interest_days_in_year
STRING

interest_paid_into_account
BOOLEAN

interest_payment_point
STRING

interest_rate_settings
OBJECT

accrue_interest_after_maturity
BOOLEAN

encoded_key
STRING

interest_charge_frequency
STRING

interest_charge_frequency_count
INTEGER

interest_rate_source
STRING

interest_rate_terms
STRING

interest_rate_tiers
ARRAY

ending_balance
NUMBER

interest_rate
NUMBER

encoded_key
STRING

ending_day
INTEGER

deposit_products (table), interest_rate_tiers (attribute)
deposit_products (table), interest_rate_settings (attribute)

line_of_credit_requirement
STRING

maturity_period_limit
STRING

max_overdraft_limit
STRING

min_opening_balance
STRING

name
STRING

overdraft_days_in_year
STRING

overdraft_interest_rate_settings
OBJECT

accrue_interest_after_maturity
BOOLEAN

encoded_key
STRING

interest_charge_frequency
STRING

interest_charge_frequency_count
INTEGER

interest_rate_source
STRING

interest_rate_terms
STRING

interest_rate_tiers
ARRAY

ending_balance
NUMBER

interest_rate
NUMBER

encoded_key
STRING

ending_day
INTEGER

deposit_products (table), interest_rate_tiers (attribute)
deposit_products (table), overdraft_interest_rate_settings (attribute)

product_type
STRING

savings_fees
ARRAY

encoded_key
STRING

name
STRING

amount
STRING

amount_calculation_period
STRING

trigger
STRING

fee_application
STRING

active
BOOLEAN

creation_date
DATE-TIME

amortization_profile
STRING

fee_amortization_upon_reschedule_option
STRING

fee_product_rules
ARRAY

value
STRING

deposit_products (table), fee_product_rules (attribute)
deposit_products (table), savings_fees (attribute)

savings_product_rules
ARRAY

value
ANYTHING

deposit_products (table), savings_product_rules (attribute)

templates
ARRAY

type
STRING

name
STRING

creation_date
DATE-TIME

last_modified_date
DATE-TIME

type
STRING

deposit_products (table), templates (attribute)

withholding_tax_enabled
BOOLEAN


deposit_transactions

Replication Method :

Key-based Incremental

Replication Key :

creation_date

Primary Key :

encoded_key

API endpoint :

Search deposit transactions

This table contains information about Deposit Transactions.

encoded_key
STRING

The unique encoded key of the deposit transaction.

creation_date
DATE-TIME

The date when the deposit transaction was created.

account_balances
OBJECT

total_balance
NUMBER

deposit_transactions (table), account_balances (attribute)

adjustment_transaction_key
STRING

affected_amounts
OBJECT

fees_amount
NUMBER

fraction_amount
NUMBER

funds_amount
NUMBER

interest_amount
NUMBER

overdraft_amount
NUMBER

overdraft_fees_amount
NUMBER

overdraft_interest_amount
NUMBER

technical_overdraft_amount
NUMBER

technical_overdraft_interest_amount
NUMBER

deposit_transactions (table), affected_amounts (attribute)

amount
NUMBER

booking_date
DATE-TIME

branch_key
STRING

Reference:

card_transaction
OBJECT

advice
BOOLEAN

amount
NUMBER

card_acceptor
OBJECT

city
STRING

country
STRING

mcc
INTEGER

name
STRING

state
STRING

zip
STRING

deposit_transactions (table), card_acceptor (attribute)

card_token
STRING

currency_code
STRING

encoded_key
STRING

external_authorization_reference_id
STRING

external_reference_id
STRING

user_transaction_time
STRING

deposit_transactions (table), card_transaction (attribute)

centre_key
STRING

currency_code
STRING

custom_field_sets
ARRAY

custom_field_set_id
STRING

Reference:

custom_field_values
ARRAY

deposit_transactions (table), custom_field_sets (attribute)

external_id
STRING

fees
NULL

id
STRING

linked_loan_transaction_key
STRING

Reference:

migration_event_key
STRING

notes
STRING

original_transaction_key
STRING

parent_account_key
STRING

taxes
OBJECT

tax_rate
NUMBER

deposit_transactions (table), taxes (attribute)

terms
OBJECT

interest_settings
OBJECT

interest_rate
NUMBER

deposit_transactions (table), interest_settings (attribute)

overdraft_interest_settings
OBJECT

index_interest_rate
NUMBER

interest_rate
NUMBER

deposit_transactions (table), overdraft_interest_settings (attribute)

overdraft_settings
OBJECT

overdraft_limit
NUMBER

deposit_transactions (table), overdraft_settings (attribute)
deposit_transactions (table), terms (attribute)

till_key
STRING

transaction_details
OBJECT

transaction_channel_id
STRING

transaction_channel_key
STRING

deposit_transactions (table), transaction_details (attribute)

transfer_details
OBJECT

linked_deposit_transaction_key
STRING

Reference:

linked_loan_transaction_key
STRING

deposit_transactions (table), transfer_details (attribute)

type
STRING

user_key
STRING

Reference:

value_date
DATE-TIME


Replication Method :

Key-based Incremental

Replication Key :

last_modified_date

Primary Key :

id

API endpoint :

Get all groups

This table contains information about Groups.

id
STRING

The group ID.

last_modified_date
DATE-TIME

The date and time the group was last modified.

addresses
ARRAY

country
STRING

parent_key
STRING

city
STRING

latitude
NUMBER

postcode
STRING

index_in_list
INTEGER

encoded_key
STRING

region
STRING

line2
STRING

line1
STRING

longitude
NUMBER

groups (table), addresses (attribute)

assigned_branch_key
STRING

Reference:

assigned_centre_key
STRING

Reference:

assigned_user_key
STRING

Reference:

creation_date
DATE-TIME

custom_field_sets
ARRAY

custom_field_set_id
STRING

Reference:

custom_field_values
ARRAY

groups (table), custom_field_sets (attribute)

email_address
STRING

encoded_key
STRING

group_members
ARRAY

clientKey
STRING

Reference:

roles
ARRAY

roleName
STRING

encodedKey
STRING

groupRoleNameKey
STRING

groups (table), roles (attribute)
groups (table), group_members (attribute)

group_name
STRING

group_role_key
STRING

home_phone
STRING

loan_cycle
STRING

migration_event_key
STRING

mobile_phone
STRING

notes
STRING

preferred_language
STRING


Replication Method :

Key-based Incremental

Replication Key :

last_modified_date

Primary Key :

id

API endpoint :

Get all loan accounts

This table contains information about Loan Accounts.

id
STRING

The loan account ID.

last_modified_date
DATE-TIME

The date and time the loan account was last modified.

account_arrears_settings
OBJECT

date_calculation_method
STRING

encoded_key
STRING

monthly_tolerance_day
INTEGER

non_working_days_method
STRING

tolerance_calculation_method
STRING

tolerance_period
INTEGER

loan_accounts (table), account_arrears_settings (attribute)

account_holder_key
STRING

account_holder_type
STRING

account_state
STRING

account_sub_state
STRING

accrued_interest
NUMBER

accrued_penalty
NUMBER

activation_transaction_key
STRING

allow_offset
BOOLEAN

approved_date
DATE-TIME

arrears_tolerance_period
INTEGER

assets
ARRAY

amount
NUMBER

depositAccountKey
STRING

assetName
STRING

encodedKey
STRING

guarantorKey
STRING

guarantorType
STRING

loan_accounts (table), assets (attribute)

assigned_branch_key
STRING

Reference:

assigned_centre_key
STRING

Reference:

assigned_user_key
STRING

Reference:

balances
OBJECT

fees_balance
NUMBER

fees_due
NUMBER

fees_paid
NUMBER

interest_balance
NUMBER

interest_due
NUMBER

interest_from_arrears_balance
NUMBER

interest_from_arrears_due
NUMBER

interest_from_arrears_paid
NUMBER

interest_paid
NUMBER

penalty_balance
NUMBER

penalty_due
NUMBER

penalty_paid
NUMBER

principal_balance
NUMBER

principal_due
NUMBER

principal_paid
NUMBER

redraw_balance
NUMBER

loan_accounts (table), balances (attribute)

closed_date
DATE-TIME

creation_date
DATE-TIME

credit_arrangement_key
STRING

Reference:

custom_field_sets
ARRAY