Create terms | Neobits API Documentation

postCreate terms

Saves the interest rates and repayment durations Fuse uses for your estimates, from startDate. Terms starting after the active terms began end those terms at that date; a future startDate schedules them. Requires terms:write. Returns 409 when startDate overlaps other terms, or when scheduled terms exist that must be deleted first.

curl --request POST \
  --url https://your-tenant.fuse.server.test.neobits.ai/v2/terms \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{"terms":{"chargeCard":{"rate":0.18,"duration":60},"creditCard":{"rate":0.18,"duration":60},"otherDebts":{"rate":0.18,"duration":60},"repaymentLoan":{"rate":0.15,"duration":60},"movables":{"rate":0.0629,"duration":96},"mortgages":{"rate":0.05,"duration":300},"studentLoans":{"rate":0.0395,"duration":240}},"startDate":"2027-01-01T00:00:00.000Z"}'

Request

Headers

Authorization•string
Bearer token authentication using OAuth 2.0 client credentials flow.
Required

Body

terms•object
Required
chargeCard•object
Required
rate•number
Annual interest rate as a fraction, so `0.05` is 5%.
Required
duration•number
Repayment duration in months.
Required
creditCard•object
Required
rate•number
Annual interest rate as a fraction, so `0.05` is 5%.
Required
duration•number
Repayment duration in months.
Required
otherDebts•object
Required
rate•number
Annual interest rate as a fraction, so `0.05` is 5%.
Required
duration•number
Repayment duration in months.
Required
repaymentLoan•object
Required
rate•number
Annual interest rate as a fraction, so `0.05` is 5%.
Required
duration•number
Repayment duration in months.
Required
movables•object
Required
rate•number
Annual interest rate as a fraction, so `0.05` is 5%.
Required
duration•number
Repayment duration in months.
Required
mortgages•object
Required
rate•number
Annual interest rate as a fraction, so `0.05` is 5%.
Required
duration•number
Repayment duration in months.
Required
studentLoans•object
Required
rate•number
Annual interest rate as a fraction, so `0.05` is 5%.
Required
duration•number
Repayment duration in months.
Required
startDate•string<date-time>
When these terms take effect.
Required

Response

Headers

Content-Type•string
The content type of the response.
X-Request-ID•string<uuid>
UUID generated on each request. Provide this id to customer support if an error occurs.

Body

id•string<uuid>
Required
terms•object
Required
chargeCard•object
Required
rate•number
Annual interest rate as a fraction, so `0.05` is 5%.
Required
duration•number
Repayment duration in months.
Required
creditCard•object
Required
rate•number
Annual interest rate as a fraction, so `0.05` is 5%.
Required
duration•number
Repayment duration in months.
Required
otherDebts•object
Required
rate•number
Annual interest rate as a fraction, so `0.05` is 5%.
Required
duration•number
Repayment duration in months.
Required
repaymentLoan•object
Required
rate•number
Annual interest rate as a fraction, so `0.05` is 5%.
Required
duration•number
Repayment duration in months.
Required
movables•object
Required
rate•number
Annual interest rate as a fraction, so `0.05` is 5%.
Required
duration•number
Repayment duration in months.
Required
mortgages•object
Required
rate•number
Annual interest rate as a fraction, so `0.05` is 5%.
Required
duration•number
Repayment duration in months.
Required
studentLoans•object
Required
rate•number
Annual interest rate as a fraction, so `0.05` is 5%.
Required
duration•number
Repayment duration in months.
Required
startDate•string<date-time>
When these terms take effect.
Required
endDate•string<date-time>
When these terms stop applying. Null while nothing replaces them.
RequiredNullable
status•string
`ACTIVE` terms apply now, `SCHEDULED` terms start in the future and `SUPERSEDED` terms have ended.
Required
createdAt•string<date-time>
Required
updatedAt•string<date-time>
Required