Create a loan proceed

curl --request POST \ --url https://sandbox.layerfi.com/v1/businesses/{businessId}/loans/{loanId}/proceeds \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data ' { "loan_proceed_type": "DISBURSEMENT", "external_id": "mca-001-proceed-1", "amount": 2000000, "date": "2024-03-01", "method": "ACH" } '

{ "data": { "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "business_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "loan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "amount": 123, "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>", "asset_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "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 proceed to create.

Asset proceed
Disbursement proceed

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

loan_proceed_type

enum<string>

required

Discriminator. Must be ASSET.

Available options:

ASSET

amount

integer<int64>

required

Proceed amount, in cents.

date

string<date>

required

Date the proceed was received.

asset

Existing asset · object

required

Reference to the asset funded by an ASSET proceed. Either link an existing asset by id or external_id, or create a new asset inline with new_asset.

Existing asset
New asset

Show child attributes

external_id

string | null

Unique ID of the proceed in your system for linking purposes.

included_in_opening_balance

boolean

default:false

Set to true when recording a historical proceed that the loan's opening balance already reflects. The proceed must be dated before the opening balance's effective_at (its date is evaluated as midnight US Eastern time at the start of the day). Layer decreases the opening balance by the proceed's amount and moves the opening balance's effective_at back to the proceed date, so the explicit record replaces what the opening balance implied and the loan's balance is unchanged. Without this flag, proceeds dated before the opening balance's effective_at are rejected with a 400. Sending the flag when the loan has no active opening balance, or when the event is not dated before it, also fails with a 400.

Response

201 - application/json

Loan proceed created successfully.

data

object

required

A loan proceed: funds (or an asset) received when a loan is drawn. See the Loan Proceed object.

Show child attributes

Businesses

Financial Activity

Accounting Reports

Platform Configuration

Activity Metrics

Integrations

Create a loan proceed

Authorizations

Path Parameters

Body

Response