Neighborly Software Logo
Neighborly Software - OpenAPI 3.0

Loans

Endpoint:https://api.neighborlysoftware.com

Loans represent individual loan accounts within Neighborly Software programs.

The Loans API enables customers to retrieve detailed loan information programmatically to support integration with external ERP, accounting, and financial management systems.

This API is commonly used when external systems need to access loan terms, balances, status information, or other loan-level data to support disbursement workflows, portfolio reporting, or compliance requirements.

Common Use Cases

  • Retrieve Loan Details for Draw Processing — Validate draw requests by checking loan status, terms, and eligibility before approval or payment execution.
  • Sync Loan Data to ERP or Financial Systems — Import loan details into accounting systems for general ledger posting or to maintain loan master data consistency.
  • Support Portfolio Reporting and Analytics — Access loan data to power external reporting, BI tools, and executive dashboards.
  • Retrieve Borrower and Loan Terms for Compliance — Access loan details to support regulatory reporting, audit documentation, and third-party compliance verification.

Typical Integration Flow

  1. Retrieve loan details by ID
  2. Validate business rules using loan terms, balances, and status
  3. Process the request in the external system
  4. Update related records as needed

Get loan by ID

GET
https://api.neighborlysoftware.com
/loans/{id}

Retrieves an individual loan by id.

Get loan by ID › path Parameters

  • idinteger · required

    The id of the loan.

    Example: 123

Get loan by ID › Responses

The requested loan.

  • idinteger
  • caseIdinteger
  • createdDatestring · date-time

    All times UTC

    Example: 2023-10-04T12:00:00
  • statusIdinteger
  • hasPaymentsboolean
  • hasInterestboolean
  • hasForgivenessboolean
  • hasEscrowboolean
  • amountnumber · double
  • loanTerminteger | null
  • dateClosedstring | null · date-time

    All times UTC

    Example: 2023-10-04T12:00:00
  • calcPrincipalBalancenumber · double
  • calcInterestBalancenumber · double
  • calcFeesBalancenumber · double
  • calcPastDuenumber | null · double
  • maturityDatestring | null · date-time

    All times UTC

    Example: 2023-10-04T12:00:00
DrawsConfiguration