Skip to main content
PATCH
/
v1
/
businesses
/
{businessId}
/
loans
/
{loanId}
Update a loan
curl --request PATCH \
  --url https://sandbox.layerfi.com/v1/businesses/{businessId}/loans/{loanId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "loan_type": "TERM_LOAN",
  "display_name": "<string>",
  "origination_date": "2023-12-25",
  "original_principal": 123,
  "loan_term_months": 123,
  "proceeds": [
    {
      "loan_proceed_type": "ASSET",
      "amount": 123,
      "date": "2023-12-25",
      "asset": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "external_id": "<string>"
      },
      "external_id": "<string>"
    }
  ],
  "memo": "<string>",
  "metadata": {},
  "reference_number": "<string>"
}
'
{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "business_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "display_name": "<string>",
    "loan_account": {
      "type": "Single_Chart_Account",
      "id": {
        "type": "AccountId",
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      },
      "name": "Current Assets",
      "account_number": "4000",
      "stable_name": {
        "type": "StableName",
        "stable_name": "CURRENT_ASSETS"
      },
      "account_type": {
        "display_name": "Asset"
      },
      "account_subtype": {
        "display_name": "Current Assets"
      }
    },
    "current_balance": 123,
    "origination_date": "2023-12-25",
    "transaction_tags": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "key": "ExampleTagKey",
        "value": "ExampleTagValue",
        "dimension_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "definition_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "dimension_display_name": "<string>",
        "value_display_name": "<string>",
        "archived_at": "2023-11-07T05:31:56Z"
      }
    ],
    "external_id": "<string>",
    "original_principal": 123,
    "credit_limit": 123,
    "fee_percentage": "<string>",
    "loan_term_months": 123,
    "completed_at": "2023-11-07T05:31:56Z",
    "cancelled_at": "2023-11-07T05:31:56Z",
    "archived_at": "2023-11-07T05:31:56Z",
    "memo": "<string>",
    "metadata": {},
    "reference_number": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
businessId
string<uuid>
required

The UUID of the business.

​
loanId
string<uuid>
required

The UUID of the loan.

Body

application/json

The loan fields to update.

Parameters for updating a loan. The shape depends on loan_type.

​
loan_type
enum<string>
required

Discriminator. Must be TERM_LOAN.

Available options:
TERM_LOAN
​
display_name
string

Updated display name for the loan.

​
origination_date
string<date>

Updated origination date.

​
original_principal
integer<int64>

Updated original principal, in cents.

​
loan_term_months
integer<int32> | null

Updated term, in months.

​
proceeds
(Asset proceed · object | Disbursement proceed · object)[]

Replaces the loan's proceeds with this list.

A loan proceed: funds (or an asset) received from the loan.

​
memo
string | null

Updated internal note.

​
metadata
object

Arbitrary JSON object you can attach for your own use. Layer stores and returns it unchanged.

​
reference_number
string | null

Updated reference number.

Response

200 - application/json

The updated loan.

​
data
object
required

A loan held by a business. Each loan has a dedicated child ledger (liability) account.