Get Account Totals

This endpoint retrieves the total amounts associated with a specified lending account.

Request Parameters

• lending_account (string)
  The unique identifier for the lending account.
  Example: LA-002385

Expected Response

• The response includes total amounts related to the specified lending account.
• The structure may include various financial metrics.
• Specific response fields are dependent on account configuration.

Notes

Request Body

• This is a GET request.
• No request body is required.
• Parameters must be passed via the query string.

Example:

doctype=LMS+Lending+Accounts&name=LA-007455

Response Structure

The API response returns aggregated balance information for a lending account along with detailed balance documents and related child records.

Root Object

• message (object)
  Contains overall totals and detailed balance documents for the lending account.

Top-Level Fields (message)

• total_balance (number)
  Total outstanding balance across all balances for the lending account.

• total_past_due_with_fees (number)
  Total past-due amount including applicable fees.

• total_actual_due_with_fees (number)
  Total amount currently due including fees.

• total_ptp_due (number)
  Total amount promised to pay (PTP).

• last_paid_amount (number)
  Amount of the most recent payment made.

• last_paid_date (string | null)
  Date of the most recent payment.

• lms_balances_docs (array)
  List of balance documents associated with the lending account.

LMS Balance Document (lms_balances_docs[])

Each object represents a balance associated with the lending account.

Core Balance Details

• name (string) – Unique balance identifier
• lending_account_number (string) – Lending account reference
• balance_type (string) – Type of balance (e.g., Primary Loan, Deferred Down, Side Note)
• balance_description (string) – Description of the balance
• balance_status (string) – Current status of the balance
• posting_date (string) – Balance posting date
• funded_date (string) – Loan funded date
• maturity_date (string) – Loan maturity date

Financial Amounts

• amount_financed (number)
• principal_amount (number)
• principal_balance (number)
• interest_bearing_principal_balance (number)
• interest_rate (number)
• interest_balance_due (number)
• total_balance (number)

Payment Information

• payment_frequency (string) – Payment schedule frequency
• regular_payment_amount (number) – Scheduled payment amount
• next_due_date (string) – Upcoming due date
• next_due_amount (number) – Amount due on the next payment date
• days_past_due (number) – Number of days past due

Payment Streams (payment_streams[])

Defines how payments are structured over time.

• payment_stream_type (string) – Type of payment stream
• term (number) – Number of payments in the stream
• payment_amount (number) – Payment amount per period
• start_date (string) – Payment start date
• end_date (string) – Payment end date
• payment_frequency_type (string) – Frequency of payments

Original Payment Schedule (original_payment_schedule[])

Represents the original amortization schedule.

• payment_number (number) – Installment number
• payment_date (string) – Scheduled payment date
• payment_amount (number) – Total payment amount
• interest_charge (number) – Interest charged for the period
• to_principal (number) – Principal portion of the payment
• principal_balance (number) – Remaining principal after payment

Notes

• The response may include multiple balance documents per lending account.
• Monetary values are represented as numbers.
• Dates are returned in YYYY-MM-DD format.

Example Response

{
  "message": {
    "total_balance": 10720.31,
    "total_past_due_with_fees": 0.0,
    "total_actual_due_with_fees": 0.0,
    "total_ptp_due": 0.0,
    "last_paid_amount": 0,
    "last_paid_date": null,
    "lms_balances_docs": [
      {
        "name": "BA-016781",
        "lending_account_number": "LA-007215",
        "balance_type": "Primary Loan",
        "balance_status": "Open",
        "posting_date": "2026-01-13",
        "funded_date": "2026-01-13",
        "amount_financed": 8691.58,
        "principal_amount": 8691.58,
        "interest_rate": 10.0,
        "payment_frequency": "Weekly",
        "regular_payment_amount": 150.0,
        "maturity_date": "2027-02-16",
        "total_balance": 8720.31,
        "principal_balance": 8691.58,
        "interest_balance_due": 28.73,
        "next_due_date": "2026-02-28",
        "next_due_amount": 300.0,
        "days_past_due": 0,
        "payment_streams": [
          {
            "payment_stream_type": "Regular",
            "payment_amount": 150.0,
            "start_date": "2026-01-20",
            "end_date": "2026-01-20",
            "payment_frequency_type": "Weekly"
          }
        ],
        "original_payment_schedule": [
          {
            "payment_number": 1,
            "payment_date": "2026-01-20",
            "payment_amount": 150.0,
            "interest_charge": 15.47,
            "to_principal": 123.94,
            "principal_balance": 7942.64
          }
        ]
      }
    ]
  }
}