Create Interest Profile API

Create Interest Profile API

Description

Add a new interest profile

Security

Logged in user has client API permissions

URL

Parameters        

CreateInterestProfileRequest

Field
Type
Description
code
String
The interest profile code
description
String
The interest profile name
calculationMethod
Integer
Calculation method
minimumDebitAmount
Decimal
The minimum debit amount to post if a debit account
penaltyRate
Decimal
If the current is not clear the penalty rate is applied to the future ledger and added to the current
penaltyDaysGrace
Integer
Number of days grace before posting
penaltyAccountTransactionTypeCode
String
Code of the transaction type used for posting penalty interest
penaltyDaysInterestThreshold
Integer
Number of days interest before penalty interest is charged
debitLimit
Decimal
Upper limit of amounts to which the margin will apply
debitRateDecimalRate to apply

Response

Example

Notes

{                                                                                                                                          
"success": true,
"errorMessage": "string",
"documentNumber": "string"
} 

Error Codes

HTTP Status Code
Type
200
OK (Success)
400
Bad Request (request format error or validation failure)
401
Unauthorised (not Authenticated)
403
Forbidden (invalid Authorisation)
503
Service Unavailable (due to maintenance)

Online Documentation



    • Related Articles

    • Create Variable Loan Account API

      Description Add a new variable loan Security Logged in user has client API permissions URL POST http://example.com/api/accounts/CreateVariableLoanAccount Parameters CreateVariableLoanAccountRequest Field Type Description code String The account code ...

    • Get Interest Profile API

      Description Get details for a specific interest profile Security Logged in user has interest profile API permissions URL GET http://exampleserver.com/api/ interestProfiles/{ interestProfileId} Parameters interestProfileId: [Required, part of URL] ...

    • Get All Interest Profiles API

      Description Get a list of all interest profiles in the system Security Logged in user has interest profile API permissions URL GET http://exampleserver.com/api/ interestProfiles? ...

    • Argos Vault Release Notes V5.151

      Release Completion Date: ? Important Notes Please disregard modules listed in these release notes that are not relevant to your usage. For additional details on any change, refer to the [Help] button within the relevant dialog—unless otherwise ...

    • Argos Vault Release Notes V5.149

      Release Completion Date: 01/07/2025 Please disregard the release notes for the modules you do not use. Unless otherwise indicated, more detail about any change will be included in the relevant dialog [Help] button. Other documents referred to in the ...