API – Linked Loans

Setting Linked List

This article explains how to link loans through the API. For more general info or how to link loans loans in the UI, see our article on Account Linking.

To link two loans in the API, send a PUT request to the base loan that you want to use in a link. For example, for setting up linked loans for a loan with ID 346, send a request to the URL: https://loanpro.simnang.com/api/public/api/1/odata.svc/Loans(346).

Base loans can only form a link to one other loan.

The payload looks like the following

{
"__id": 346,
"__update": true,
    "LinkedLoanValues": {
      "results": [
        {
          "linkedLoanId": 5,
          "optionId": 5,
          "value": 1
        },
        {
          "linkedLoanId": 5,
          "optionId": 7,
          "value": 1
        }
      ]
    }
  }
  • linkedLoanId – The ID of the loan to link to
  • optionId – The option ID
    • 5 – Header Link
    • 7 – Payments (All) – You can use either this option or the Split Payment option, not both
    • 6 – Charges
    • 9 – Split Payment – You can use either this option or the Payments (All) option, not both
  • value – Set to “1” to set a link option, set to “0” to unset a link option

Clearing Settings

To clear settings, send the following body

[
  {
    "LinkedLoanValues": {
      "results": [
      ]
    }
  }
]


How did we do?


Powered by HelpDocs (opens in a new tab)