Create contract fee booking
Use case
In this article, we will review how to create a loan contract fee booking.
Use case data
API parameters with values
Contract booking fee type. We will book an account administration fee.
The date when the fee must be reversed. The date format is: YYYY-MM-DD.
The fee amount is 10 EUR.
The fee will be applied with the next payment. Note that you can also use the INSTANT option to apply the fee instantly.
Sample API call
To create a contract fee booking, make the following API call.
Sample request
Below is an example request of the API call for creating a fee booking.
{
"componentTypeCode": "ADM",
"effectiveDate": "2023-08-08",
"money": {
"amount": "10",
"currencyCode": "EUR"
},
"repaymentTypeCode": "WITH_NEXT_PAYMENT"
}
curl --location 'https://loan-api.sandbox.tuumplatform.com/api/v1/contracts/ID-1664282485/fees' \
--header 'x-channel-code: SYSTEM' \
--header 'x-auth-token: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHBpcnlEVGltZSI6IjIwMjMtMDgtMDhUMTA6Mzg6MjEiLCJyb2xlcyI6WyJBRE1JTiJdLCJuYW1lIjoiSm9obiBPZmZpY2VyIiwiZW1wbG95ZWVJZCI6IjEiLCJ0ZW5hbnRDb2RlIjoiTUIiLCJleHAiOjE2OTE0OTExMDF9.c_BuJjt1pt5OLjS6E4rSMli0yNQ5k8w3DTen6-9TXm4' \
--header 'Content-Type: application/json' \
--data '{
"componentTypeCode": "ADM",
"effectiveDate": "2023-08-08",
"money": {
"amount": "10",
"currencyCode": "EUR"
},
"repaymentTypeCode": "WITH_NEXT_PAYMENT"
}'
Sample response
Below you find an example response body to the API call above.
Response
{
"errors": null,
"validationErrors": null,
"data": {
"bookingId": "ID-1017",
"headerId": "ID-1664282485",
"componentTypeCode": "ADM",
"typeCode": "BOOKING",
"postingDate": "2023-08-08",
"effectiveDate": "2023-08-08",
"details": null,
"accrualRange": {
"endDate": "2023-09-07",
"startDate": "2023-08-08"
},
"active": true,
"contractNumber": "INST2-1004",
"originalBookingId": null,
"accruedUntilDate": "2023-08-08",
"reversedMoney": {
"amount": 0.00,
"currencyCode": "EUR"
},
"money": {
"amount": 10.00,
"currencyCode": "EUR"
},
"bookedMoney": {
"amount": 0.33,
"currencyCode": "EUR"
},
"balanceMoney": {
"amount": 10.00,
"currencyCode": "EUR"
},
"eventTypeCode": "DEFERRED_TO_INC",
"source": null,
"repaymentTypeCode": "WITH_NEXT_PAYMENT",
"numberOfPayments": null,
"reasonCode": null,
"solvencyLevelCode": null,
"feeSubtypeCode": null,
"statusCode": "BOOKED"
}
}
Result
A new fee booking ID-1017 was created.
