Skip to content

Set the use of proceeds

Request

Replace the use-of-proceeds lines a banker enters. A line is a category from GET /use-of-proceeds-categories, the part of it the loan funds, and the non-loan money on it. A line that is not in the list is removed. The bank keeps the guarantee fee and closing costs lines, and the lines the debt schedule derives, and recalculates the guarantee fee and the project cost from the new lines. The loan amount does not change: send centsAmount with PATCH /loans/{id}. The response is useOfProceeds as GET /loans/{id} returns it.

Security
ApiKeyAuth
Path
idstringrequired
Headers
Idempotency-Keystring, <= 255 characters

Optional opaque key (e.g. a UUID) to make this write safely retryable. A replay with the same key returns the original response instead of repeating the side effect.

Bodyapplication/jsonrequired
lineItemsArray of objectsrequired

The lines a banker enters. It replaces them: a line that is not in the list is removed. The guarantee fee and closing costs lines belong to the bank and keep their value, and so do lines the debt schedule derives. You can send back a useOfProceeds.lineItems array from GET /loans/{id} as it is. centsAmount of the loan does not change: send it with PATCH /loans/{id}.

curl -i -X PUT \
  'https://api.pioneerft.com/api/public/v1/loans/{id}/use-of-proceeds' \
  -H 'Authorization: Bearer <YOUR_API Key_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: string' \
  -d '{
    "lineItems": [
      {
        "name": "string",
        "centsLoanAmount": 0,
        "nonLoanFunding": []
      }
    ]
  }'

Responses

The use of proceeds after the write

Bodyapplication/json
dataobject(PublicUseOfProceeds)
Response
{ "data": { "centsProjectCost": -9007199254740991, "centsRoundingPlug": -9007199254740991, "lineItems": [ { "name": "string", "label": "string", "centsProjectCost": -9007199254740991, "centsLoanAmount": -9007199254740991, "nonLoanFunding": [ { "source": "equity_injection", "centsAmount": -9007199254740991 } ], "isRefinance": true, "isGuaranteeFee": true, "isClosingCosts": true, "disbursementClass": "BORROWER", "source": "manual", "displayOrder": -9007199254740991, "notes": "string" } ] } }