Index Rates Configuration
- 03 May 2023
- 4 Minutes To Read
- Print
- DarkLight
- PDF
Index Rates Configuration
- Updated On 03 May 2023
- 4 Minutes To Read
- Print
- DarkLight
- PDF
Article Summary
Share feedback
Thanks for sharing your feedback!
The index rates that can be configured are interest rate, value added tax rate, and wittholding tax. For more information, see Customizing Index Interest Rates & Tax Rates.
With Configuration as Code (CasC), you may batch configure your index rates configuration via the API using YAML. For general information on CasC, see Configuration as Code Overview.
API Operations
CasC for index rates supports two operations.
| Action | Endpoint | Description |
|---|---|---|
GET | /configuration/indexrates.yaml | Get the current index rates configuration. |
PUT | /configuration/indexrates.yaml | Write a new index rates configuration to Mambu. |
Please Note
If you PUT a configuration to Mambu, any current configuration settings not included in the new YAML configuration will be deleted. PATCH requests are not currently supported.
Requests
For general information on CasC requests such as authentication and required headers, see Configuration as Code Overview.
The following section shows sample requests using curl and basic authentication. For all examples, replace TENANT_NAME with your actual tenant name.
GET configuration
curl -X GET 'https://TENANT_NAME.mambu.com/api/configuration/indexrates.yaml' \
-H 'Accept: application/vnd.mambu.v2+yaml' \
-H 'Authorization: Basic {auth}'
{auth} is the base-64-encoded value of username:password. For more information, see Authentication in our API reference.
PUT configuration
curl -X PUT 'https://TENANT_NAME.mambu.com/api/configuration/indexrates.yaml' \
-H 'Accept: application/vnd.mambu.v2+yaml' \
-H 'Content-Type: application/yaml' \
-H 'Authorization: Basic {auth}' \
--data-binary @indexrates.yaml
{auth} is the base-64-encoded value of username:password. For more information, see Authentication in our API reference.
“@indexrates.yaml” represents the absolute path of the file on your device.
Use “--data-raw” if you want to specify the YAML body inline.
Configuration body example
---
indexRateSources:
- id: "1515528602"
name: "3 Month LIBOR"
type: "INTEREST_RATE"
notes: ""
indexRates:
- id: "54082948"
startDate: "2021-03-08T01:00:00+01:00"
rate: 0.85
notes: ""
- id: "384947284"
startDate: "2019-03-06T01:00:00+01:00"
rate: 2.33
notes: ""
- id: "951490027"
startDate: "2018-03-05T01:00:00+01:00"
rate: 2.3
notes: ""
- id: "865715514"
name: "1 Month LIBOR"
type: "INTEREST_RATE"
notes: ""
indexRates:
- id: "967424433"
startDate: "2020-10-05T02:00:00+02:00"
rate: 0.69
notes: ""
- id: "1306016671"
startDate: "2019-10-07T02:00:00+02:00"
rate: 2.22
notes: ""
- id: "703118600"
startDate: "2018-10-01T02:00:00+02:00"
rate: 2.02
notes: ""
- id: "1529349105"
name: "VAT Switzerland"
type: "TAX_RATE"
notes: ""
indexRates:
- id: "1662077234"
startDate: "2018-10-10T02:00:00+02:00"
rate: 7.7
notes: ""
- id: "1055113792"
startDate: "2017-10-03T02:00:00+02:00"
rate: 8
notes: ""
- id: "954835635"
name: "Wittholding Tax"
type: "WITHHOLDING_TAX_RATE"
notes: ""
indexRates:
- id: "1618217994"
startDate: "2019-10-07T02:00:00+02:00"
rate: 35
notes: ""
Attributes
| Name | Type | Description | Required |
|---|---|---|---|
id | String | The id of the index rate source. If created via the UI it is not required, using the API it is required. If it is not provided when created a rate via the UI, then a random nine digit number is created. | ✔ |
name | String | The name of the index rate source. | ✔ |
type | String | The type of the index rate source. The available types are INTEREST_RATE, TAX_RATE, and WITHHOLDING_TAX_RATE. | ✔ |
notes | String | Any custom text to be associated with the index rate source. | ✘ |
indexRates | IndexRateConfiguration | List of index rates associated with the index rate source. | ✘ |
indexRates.id | String | The id of the index rate. If created via the UI it is not required, using the API it is required. If it is not provided when created a rate via the UI, then a random ten digit number is created. | ✔ |
indexRates.startDate | String (date-time) | The date when this index rate starts being the active rate for its source. | ✔ |
indexRates.rate | Number | The percentage value of the index rate. | ✔ |
indexRates.notes | String | Any custom text to be associated with this index rate. | ✘ |
Replies
If you do not receive a 200 OK status code then fix any validation errors and make another PUT request until you receive a 200 OK status code.
Please Note
If you PUT a valid YAML configuration to the API and you do not receive a 200 OK status code within 60 seconds, you may receive a 504 Gateway Timeout status code. We expect all responses to be below 60 seconds.
If you encounter this issue, please contact us through Mambu Support so we can investigate it.
Requirements
The endpoints do not accept empty configurations or null/empty entries in a configuration.
| Name | Requirement |
|---|---|
id | Must be non blank, alphanumeric, unique in the list of index rate sources, and with a maximum length of 32 characters. |
name | Must be non blank, unique in the list of index rate sources, and with a maximum length of 32 characters. |
type | Must not be blank. in case the type is changed during an update operation, the index rate source must not be in use. |
notes | Can be blank, but if it is specified, the length must not be larger than 255 characters. |
indexRates | Can be blank. |
indexRates.id | Must be non blank, alphanumeric, unique in the list of index rates, and with a maximum length of 32 characters. |
indexRates.startDate | Must not be blank, must be unique in the index rate, and there must not be a transaction after the specified start date. Must follow the ISO 8601 format for date and time YYYY-MM-DD'T'hh:mm:ss±hh:mm. |
indexRates.rate | Must not be blank, must be between 0 and 100 for TAX_RATE index rate types, and must be between 0 and 1000 for other index rate types. |
indexRates.notes | Can be blank, but if it is specified, the length must not be larger than 255 characters. |
Warnings
An index rate source cannot be deleted when it is already in use, or if a transaction exists after its date. If you attempt to delete an index rate or index rate source that cannot be deleted, it will be deactivated and a warning message will be returned.
Was this article helpful?
