/v1/definitions/{key}/underwriting/{id}Change definitions key underwriting id
Writes the fields the underwriting tab's inline editors change on one underwriting record: engagementStatus and creditWorthinessDecision, the money figures in minor units (eligible loan amount, monthly payment, guaranty fee, closing costs, working capital, debt refinance, annual revenue, existing debt, personal revolving balance and limit), the rates, the scores (SBSS, FICO, time in business, employees), the milestone dates, and the underwriter and closer. :id names the UNDERWRITING record, not the deal — its id already names one deal. A patch naming nothing is refused rather than treated as a read. Deals page only.
Access class: def:read.
Send request
Use the documented inputs to call this endpoint directly.
Parameters
Values are applied to the request and the example on the right.
Request body
application/jsonrequiredResponses
the action's answer
{
"data": {
"annualRevenueMinor": 1,
"applicationDate": "string",
"attorneyReviewSubmittedAt": "string",
"baseRate": 1.5,
"checkingAccountSetupAt": "string",
"closerUserId": 1,
"closingCostsMinor": 1,
"createdAt": "string",
"creditDecisionDate": "string",
"creditDecisionIsEstimate": true,
"creditWorthinessDecision": "string",
"criteriaResults": [
{
"criterion": "string",
"criterionId": "",
"evaluatedAt": "string",
"evaluatedBy": "string",
"evidence": "string",
"id": "",
"note": "string",
"numericValue": "string",
"source": "string",
"status": "string",
"version": "string"
}
],
"daysToClose": 1,
"dealRowId": "",
"debtRefinanceAmountMinor": 1,
"eligibleLoanAmountMinor": 1,
"employeeCount": 1,
"engagementStatus": "string",
"estimatedClosingDate": "string",
"evaluationVersion": 1,
"existingNonReDebtMinor": 1,
"existingReDebtMinor": 1,
"ficoScore": 1,
"fileLocation": "string",
"finalReviewInitiatedAt": "string",
"guarantyFeeMinor": 1,
"id": 1,
"interestRate": 1.5,
"losCompleted": true,
"monthlyPaymentMinor": 1,
"naicsCode": "string",
"needsList": "string",
"notes": "string",
"onlineApplicationCompleted": true,
"originationPhase": "string",
"personalRevolvingBalanceMinor": 1,
"personalRevolvingLimitMinor": 1,
"plpNumber": "string",
"plpNumberReceivedAt": "string",
"proformaDebtRatio": 1.5,
"referralFeeSubmittedAt": "string",
"revolvingUtilizationRatio": 1.5,
"sbssScore": 1,
"scorecardCompleted": true,
"sourceOfLoan": "string",
"spread": 1.5,
"startedBy": 1,
"timeInBusinessYears": 1.5,
"underwriterUserId": 1,
"updatedAt": "string",
"vendorInvoiceProcessedAt": "string",
"workingCapitalAmountMinor": 1
}
}a refusal: {"error": "<what a person needs to read>"}. 401 no credential, 402 the plan does not include this, 403 the seat does not, 404 the thing does not exist or is not yours to see.
{
"error": "string"
}