Rental APIs
Update provided recurring rate
| HTTP method | PUT |
| URI | https://api.rambase.net/rental/recurring-rates/{recurringRateId} |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| - URI parameter {recurringRateId} |
Recurring rate identifier
Integer, minimum 100000 |
| Custom fields | Custom fields supported |
| Successful HTTP status code | 200 |
| API resource identifier | 5949, version 13 |
The following body must be added to the request. Mouse over fieldnames for description and other useful information about the fields. Note that fields in bold are required/mandatory.
RecurringRate
This field is optional.
>Currency
Three character code following the ISO 4217 standard
Applicable domain values can be found here
Input must match the following regular expression pattern: ^[A-Z]{3}$
This field is optional.
>{String}</Currency>RateInterval
Interval of recurring rate
Applicable domain values can be found here
This field is optional.
>{Integer}</RateInterval>PricingMethod
The method of which total price will be calculated for this recurring rate. 1 - Incremental: Sum of respective rates of each step
2 - Flat rate: One price decided by the quantity of the product
Applicable domain values can be found here
This field is optional.
>{Integer}</PricingMethod>IsDefault
Determines whether or not the recurring rate is a default rate for the combination of its product and currency
This field is optional.
>{Boolean}</IsDefault>Product
This field is optional.
>ProductId
Product identifier
Minimum value: 10000
This field is optional.
>{Integer}</ProductId>Period
This field is optional.
>EffectiveDate
Date from rate is valid
This field is optional.
>{Date}</EffectiveDate>ExpirationDate
Date until rate is valid
This field is optional.
>{Date}</ExpirationDate>ReplacesRecurringRate
Identifier of a recurring rate that is going to be replaced by this rate
This field is optional.
>RecurringRateId
Recurring rate identifier
Minimum value: 100000
This field is optional.
>{Integer}</RecurringRateId>Location
This field is optional.
>LocationId
Location identifier
Minimum value: 10000
This field is optional.
>{Integer}</LocationId>RecurringRate
This field is optional.
": {Currency
Three character code following the ISO 4217 standard
Applicable domain values can be found here
Input must match the following regular expression pattern: ^[A-Z]{3}$
This field is optional.
": "{String}",RateInterval
Interval of recurring rate
Applicable domain values can be found here
This field is optional.
": "{Integer}",PricingMethod
The method of which total price will be calculated for this recurring rate. 1 - Incremental: Sum of respective rates of each step
2 - Flat rate: One price decided by the quantity of the product
Applicable domain values can be found here
This field is optional.
": "{Integer}",IsDefault
Determines whether or not the recurring rate is a default rate for the combination of its product and currency
This field is optional.
": "{Boolean}",Product
This field is optional.
": {ProductId
Product identifier
Minimum value: 10000
This field is optional.
": "{Integer}"Period
This field is optional.
": {EffectiveDate
Date from rate is valid
This field is optional.
": "{Date}",ExpirationDate
Date until rate is valid
This field is optional.
": "{Date}"ReplacesRecurringRate
Identifier of a recurring rate that is going to be replaced by this rate
This field is optional.
": {RecurringRateId
Recurring rate identifier
Minimum value: 100000
This field is optional.
": "{Integer}"Location
This field is optional.
": {LocationId
Location identifier
Minimum value: 10000
This field is optional.
": "{Integer}"The query string is placed after the resource URL, seperated with a questionmark (?). The query string is composed of a series of query parameters with values. See the page about query parameters on how to use these parameters.
| $access_token String, optional | After successful login you get an access token which needs to be provided in all API requests. Even though it is possible to pass this token as query parameter, we recommended passing it using the HTTP request header as described in Authorization. Note that all access tokens have an expiration time. |
| $db String, optional | Set the database/company for the request |
| $useMinimumVersion Integer, optional | Used to run a new version of an API resource when your API client is running a deprecated API resource. See the Breaking changes page for more information. |
| $showCustomFields Boolean, optional | Set to "true" to include custom fields. Default value is false. |
Read more about filters and sorting on how to use filter parameters and named filters.
Read more about filters and sorting on how to use sortable parameters
Requesting this resource will yield the following response. Mouse over fieldnames (or fieldgroups) for descriptions and other useful information about the fields. Fields colored in grey is expandable fields.
Please note that some fields may be removed from the response, based on user roles/duties/permissions.
List of available operations/actions for this resource.
See the operations documentation for more information about API operations.
Possible error codes the response might return:
| Error 108262 HTTP 404 | Recurring rate not found |
| Error 108650 HTTP 400 | Effective date must be before expiration date |
| Error 108778 HTTP 400 | Changing currency for a replacing rate is not allowed |
| Error 108779 HTTP 400 | Changing product for a replacing rate is not allowed |
| Error 108780 HTTP 400 | Changing recurring period for a replacing rate is not allowed |
| Error 108781 HTTP 400 | Changing pricing method for a replacing rate is not allowed |
| Error 108782 HTTP 400 | Changing rate aspect for a replacing rate is not allowed |