Remove a Credit

General

Credits are used when a lender decides to forgive a portion of a borrower's loan. Many credits are used as promotional incentives or relief. Here's what you need to know about this request:

• This request will remove an existing credit. Removing a credit will update the loan's balance.
• A credit differs from an advancement. Credits function similar to payments, and they affect loan calculations. An advancement simply increases a loan's principal balance.
• Credits apply to the portions of a loan in the order that is determined by the paymentType in the payload.

For an example of how credits work within the UI, take a look at our Log an Advancement/Credit article on our help site.

Database

For information on credits database tables, see the following articles:

• Database – Loan Credit Entity (loan_credit_entity)
• Database – Credit Category Entity (credit_category_entity)

{
    "Credits": {
        "results": [
            {
                "__id": 372,
                "__destroy": true
            }
        ]
    }
}

🚧

Try It Instructions

Our requests often provide sample payload information so that you can receive a 200 response from simply hitting the Try It button. This request is a bit different.

We can’t provide sample values that will work for multiple users. But, if you’d like to see a sample of a 200 response, click the response examples located under the Try It button.

To receive a 200 response from the Try It button, you will have to try this request with your own tenant credentials. If you plan on doing so, make sure to change the headers to match your own authentication information.