Skip to main content

Amendment Request Creation


To make an amendment request, you need to make a request using the unique key that represents the fund (FUND_CLASS_KEY, provided by Qi Tech) and the unique key that represents the amendment pipeline configurations (AMENDMENT_CONFIGURATION_KEY, provided by Qi Tech).

In amendments made through this system, it is allowed to change the payment flow or nominal rate of the contract or both. It is also possible to define that the amendment will be made together with a down payment made by the debtor.

Request

ENDPOINT
/asset_amendment/fund_class/FUND_CLASS_KEY/amendment_configuration/AMENDMENT_CONFIGURATION_KEY/asset_amendment
METHOD
POST
Request Body
{
"asset_external_id": "931e9437-d025-41ab-bb53-6b94e10fd361",
"amendment_date": "2024-04-01",
"amendment_type": "all_contract",
"down_payment_value": 400.23,
"installments":[
{
"maturity_date": "2025-01-31",
"face_value": 1000.31,
"installment_number": 1
},
{
"maturity_date": "2025-02-31",
"face_value": 1000.31,
"installment_number": 2
}
],
"pre_fixed":{
"monthly_rate": 0.02,
"calendar_base": "workdays"
}
}

Body Params

FieldTypeDescriptionRequired
asset_external_idstringUnique identification key of the contract being amended.Yes
amendment_datestringDate when the amendment is being made (format: YYYY-MM-DD)Yes
amendment_typestringType of amendment to be made. See **Amendment Type EnumeratorYes
down_payment_valuenumberDown payment amount to be paid by the debtor at the time of amendmentNo
installmentsarrayList of contract installments after the amendmentYes
installments[].maturity_datestringInstallment due date (format: YYYY-MM-DD)Yes
installments[].face_valuenumberNominal value of the installmentYes
installments[].installment_numbernumberSequential number of the installmentYes
pre_fixedobjectPre-fixed rate configurationsYes
pre_fixed.monthly_ratenumberMonthly rate to be appliedYes
pre_fixed.calendar_basestringCalendar base for calculation (e.g.: "workdays")Yes

Response

STATUS
201
Response Body
{
"asset_amendment_key": "a914aac6-93ff-45ee-8574-f4dbaf6c0642",
"status": "pending_assets_insertion",
}

Amendment Type Enumerator

EnumeratorDescription
payment_flowAmendment of payment flow only
nominal_rateAmendment of contract nominal rate only
all_contractAmendment of both payment flow and contract nominal rate
Attention

The installments and pre_fixed fields should exist or not according to the type of amendment to be made as per the following table

Amendment typeinstallmentspre_fixed
all_contractRequiredRequired
pre_fixedShould not be sentRequired
payment_flowRequiredShould not be sent