API – Getting Tenant Settings

Introduction

This article explains how to pull tenant settings information via the API.

This request is read-only. It does not allow for changing any of these settings—you can only view them.

How To

This request allows you to pull tenant settings information in groups. For example, to see your tenant's date and time settings, you would add company.date to the URL. To pull tenant settings information, send a GET request to the following endpoint:

GET https://loanpro.simnang.com/api/public/api/1/tenant.settings({group})

Groups

Here are the available settings groups that can used in this request:

Group Name

Description

alert.usury

Usury alert

company.date

Company date/time settings

company.settings

General settings

companysettings.notifications

Notification settings

customer.default

Default customer settings

customermanager

Customer manager settings

data.usage

Data usage settings and statistics

duedate.change.fee

Settings for due date change fees

latefee

Settings for late fees

loan.settings

Loan settings

loanmanager

Loan manager settings

loansettings.alerts.flags

Loan flag settings

loansettings.alerts.stoplights

Loan stoplight settings

loansettings.ruleapplied.apdreset

Rules applied for APD reset

loansettings.ruleapplied.chargeoff

Rules applied for charge off

loansettings.ruleapplied.checklist

Rules applied for checklists

loansettings.ruleapplied.duedates

Rules applied for due dates

loansettings.ruleapplied.loansettings

Rules applied for loan settings

loansettings.setupnewloan.activation

Settings for activating new loans

merchant.nacha

Settings for NACHA files

merchant.paynearme

Settings for PayNearMe

numbering

Settings for numbering accounts

numbering.holdingAccount

Settings for numbering holding accounts

payment

Settings for payments

pmt.reversal.charge

Fee settings for reversing payments

settings.customerWebsite

Customer website settings

settings.defaults.holdingaccount

Default settings for holding accounts

tenant.emailqueueprocess

Settings for email queue processing

tenant.usage.prices

Settings for usage costs


How did we do?


Powered by HelpDocs (opens in a new tab)