Update Deal financing terms

PATCH/deals/{deal_id}/terms/

Patch financing details with the current revision. Omitted fields stay unchanged. equipment_entries replaces the complete equipment list; [] clears it. Application answers and lifecycle decisions use their own operations.

Required permissions: deals:write
Available scopes: Entire Portal or Selected source channels

Headers and URL parameters

Name	Location	Type	Required
`deal_id` View parameter schema	path	string	Yes
`If-Match` View parameter schema	header	string	Yes
`Idempotency-Key` View parameter schema	header	string	Yes

Request body

application/json · Required body

Field	Type	Required
`actual_interest_rate`	See schema	No
`additional_notes`	See schema	No
`advance_rate_percent`	See schema	No
`advisory_fee_amount`	See schema	No
`advisory_fee_percent`	See schema	No
`buy_rate`	See schema	No
`commission_actual_payment_date`	See schema	No
`commission_notes`	See schema	No
`commission_status`	See schema	No
`currency`	See schema	No
`deal_length_interval`	See schema	No
`deal_length_value`	See schema	No
`deal_revenue`	See schema	No
`deal_status`	See schema	No
`deal_type`	See schema	No
`disbursed_date`	See schema	No
`equipment_entries`The complete equipment list. Replaces the existing list when supplied; [] clears it.	array	No
`factor_rate`	See schema	No
`financing_type`	See schema	No
`funded_amount`	See schema	No
`is_stacked_deal`	See schema	No
`is_syndication`	See schema	No
`maturity_date`	See schema	No
`net_funded_amount`	See schema	No
`not_applicable_fields`	array	No
`notes_to_accounting`	See schema	No
`nr_payments`	See schema	No
`offered_amount`	See schema	No
`origination_fee_amount`	See schema	No
`origination_fee_percent`	See schema	No
`other_fee`	See schema	No
`other_fee_description`	See schema	No
`payment_frequency_interval`	See schema	No
`processing_fee`	See schema	No
`property_loan_to_value`	See schema	No
`property_type`	See schema	No
`property_use`	See schema	No
`property_value`	See schema	No
`proposed_amount`	See schema	No
`real_estate_property_address`	See schema	No
`renewal_followup_date`	See schema	No
`repayment_holdback_percentage`	See schema	No
`repayment_payment_amount`	See schema	No
`requested_amount`	See schema	No
`sell_rate`	See schema	No
`stacked_with`	See schema	No
`syndication_amount`	See schema	No
`syndication_percent`	See schema	No
`target_interest_rate`	See schema	No
`total_repayment_amount`	See schema	No

View request schema

Example request

curl --request PATCH \
  --url "https://api.staging.levr.ai/v1/deals/$DEAL_ID/terms/" \
  --header "Authorization: Bearer $LEVR_API_KEY" \
  --header "If-Match: $IF_MATCH" \
  --header "Idempotency-Key: $IDEMPOTENCY_KEY" \
  --header "Content-Type: application/json" \
  --data "@request.json"

curl --request PATCH \
  --url "https://api.staging.levr.ai/v1/deals/$DEAL_ID/terms/" \
  --header "Authorization: Bearer $LEVR_API_KEY" \
  --header "If-Match: $IF_MATCH" \
  --header "Idempotency-Key: $IDEMPOTENCY_KEY" \
  --header "Content-Type: application/json" \
  --data '{
  "currency": "CAD"
}'

Responses

Status	What it means
`200`	Successful response. View response headers `application/json` View response schema Illustrative data. Use the identifiers, cursors, and URLs returned by your requests. View example response
`400`	Correct the request fields and try again. View response headers `application/json` View response schema Illustrative data. Use the identifiers, cursors, and URLs returned by your requests. View example response
`401`	Provide a valid API key and try again. View response headers `application/json` View response schema Illustrative data. Use the identifiers, cursors, and URLs returned by your requests. View example response
`403`	This API key does not allow the requested action. View response headers `application/json` View response schema Illustrative data. Use the identifiers, cursors, and URLs returned by your requests. View example response
`404`	The requested resource was not found or is not available to this API key. View response headers `application/json` View response schema Illustrative data. Use the identifiers, cursors, and URLs returned by your requests. View example response
`409`	The request conflicts with the resource's current state. Refresh it before trying again. View response headers `application/json` View response schema Illustrative data. Use the identifiers, cursors, and URLs returned by your requests. View example response
`412`	The request was not completed. View response headers `application/json` View response schema Illustrative data. Use the identifiers, cursors, and URLs returned by your requests. View example response
`429`	Too many requests were sent. Wait before trying again. View response headers `application/json` View response schema Illustrative data. Use the identifiers, cursors, and URLs returned by your requests. View example response
`500`	Levr could not complete the request. Keep the request ID and retry when safe. View response headers `application/json` View response schema Illustrative data. Use the identifiers, cursors, and URLs returned by your requests. View example response

Copy instructions to your AI agent

Request an integration