Rental APIs
Creates a new recurring rate
| HTTP method | POST |
| URI | https://api.rambase.net/rental/recurring-rates |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| Custom fields | Custom fields supported |
| Successful HTTP status code | 201 |
| API resource identifier | 5947, version 9 |
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.
Type
Required/mandatory field
Type of recurring rate: 1 - Standard, 2 - Special
Applicable domain values can be found here
>{Integer}</Type>Currency
Required/mandatory field
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}$
>{String}</Currency>RateInterval
Required/mandatory field
Interval of recurring rate
Applicable domain values can be found here
>{Integer}</RateInterval>IsDefault
Determines whether or not the recurring rate is a default rate for the combination of its product and currency
Default value: False
This field is optional.
>{Boolean}</IsDefault>RateAspect
Required/mandatory field
Which aspect should be changed in additional rate steps, e.g. from duration or from quantity
Applicable domain values can be found here
>{Integer}</RateAspect>PricingMethod
Required/mandatory field
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
>{Integer}</PricingMethod>Reason
Reason for creation of recurring rate
This field is optional.
>{String}</Reason>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>ProductId
Required/mandatory field
Product identifier
Minimum value: 10000
>{Integer}</ProductId>Location
This field is optional.
>LocationId
Location identifier
Minimum value: 10000
This field is optional.
>{Integer}</LocationId>Type
Required/mandatory field
Type of recurring rate: 1 - Standard, 2 - Special
Applicable domain values can be found here
": "{Integer}",Currency
Required/mandatory field
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}$
": "{String}",RateInterval
Required/mandatory field
Interval of recurring rate
Applicable domain values can be found here
": "{Integer}",IsDefault
Determines whether or not the recurring rate is a default rate for the combination of its product and currency
Default value: False
This field is optional.
": "{Boolean}",RateAspect
Required/mandatory field
Which aspect should be changed in additional rate steps, e.g. from duration or from quantity
Applicable domain values can be found here
": "{Integer}",PricingMethod
Required/mandatory field
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
": "{Integer}",Reason
Reason for creation of recurring rate
This field is optional.
": "{String}",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}"ProductId
Required/mandatory field
Product identifier
Minimum value: 10000
": "{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. |
| $showDomainDescriptions Boolean, optional | Set to "true" to include domain descriptions for fields using domain values. See the Domain values page for more information. Default value is false. |
| $lang String, optional | Specifies the language used in the response, following the 3-letter ISO-639-1 [lll] |
| $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.
Please note that some fields may be removed from the response, based on user roles/duties/permissions.
RecurringRateId
Recurring rate identifier
>{Integer}</RecurringRateId>CreatedAt
Date and time of creation
>{Datetime}</CreatedAt>Type
Type of recurring rate: 1 - Standard, 2 - Special
Possible domain values can be found here
>{Integer}</Type>Currency
Three character code following the ISO 4217 standard
Possible domain values can be found here
>{String}</Currency>IsDefault
Determines whether or not the recurring rate is a default rate for the combination of its product and currency
>{Boolean}</IsDefault>RateInterval
Interval of recurring rate
Possible domain values can be found here
>{Integer}</RateInterval>Reason
Reason for creation of recurring rate
>{String}</Reason>RateAspect
Which aspect should be changed in additional rate steps, e.g. from duration or from quantity
Possible domain values can be found here
>{Integer}</RateAspect>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
Possible domain values can be found here
>{Integer}</PricingMethod>NumberOfRateSteps
Number of rate steps
>{Integer}</NumberOfRateSteps>RateStepId
Rate step identifier
>{Integer}</RateStepId>Rate
Value of step rate
>{Decimal}</Rate>RateStepLink
Rate step reference
>{String}</RateStepLink>EffectiveDate
Date from rate is valid
>{Date}</EffectiveDate>ExpirationDate
Date until rate is valid
>{Date}</ExpirationDate>ReplacesRecurringRate
Identifier of a recurring rate that is going to be replaced by this rate
>RecurringRateId
Recurring rate identifier
>{Integer}</RecurringRateId>RecurringRateLink
Recurring rate reference
>{String}</RecurringRateLink>ProductId
Product identifier
>{Integer}</ProductId>Name
Name of the product
>{String}</Name>Description
Description of the product
>{String}</Description>ProductLink
Product reference
>{String}</ProductLink>LocationId
Location identifier
>{Integer}</LocationId>ShortName
Unique abbreviation/short name of the location
>{String}</ShortName>LocationLink
Location reference
>{String}</LocationLink>RecurringRateLink
Recurring rate reference
>{String}</RecurringRateLink>RecurringRateId
Recurring rate identifier
": "{Integer}",CreatedAt
Date and time of creation
": "{Datetime}",Type
Type of recurring rate: 1 - Standard, 2 - Special
Possible domain values can be found here
": "{Integer}",Status
Status of recurring rate
Possible domain values can be found here
": "{Integer}",Currency
Three character code following the ISO 4217 standard
Possible domain values can be found here
": "{String}",IsDefault
Determines whether or not the recurring rate is a default rate for the combination of its product and currency
": "{Boolean}",RateInterval
Interval of recurring rate
Possible domain values can be found here
": "{Integer}",Reason
Reason for creation of recurring rate
": "{String}",RateAspect
Which aspect should be changed in additional rate steps, e.g. from duration or from quantity
Possible domain values can be found here
": "{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
Possible domain values can be found here
": "{Integer}",NumberOfRateSteps
Number of rate steps
": "{Integer}",RateStepId
Rate step identifier
": "{Integer}",Rate
Value of step rate
": "{Decimal}",RateStepLink
Rate step reference
": "{String}"EffectiveDate
Date from rate is valid
": "{Date}",ExpirationDate
Date until rate is valid
": "{Date}"ReplacesRecurringRate
Identifier of a recurring rate that is going to be replaced by this rate
": {RecurringRateId
Recurring rate identifier
": "{Integer}",RecurringRateLink
Recurring rate reference
": "{String}"ProductId
Product identifier
": "{Integer}",Name
Name of the product
": "{String}",Description
Description of the product
": "{String}",Type
Type of product
Possible domain values can be found here
": "{String}",ProductLink
Product reference
": "{String}"LocationId
Location identifier
": "{Integer}",ShortName
Unique abbreviation/short name of the location
": "{String}",LocationLink
Location reference
": "{String}"RecurringRateLink
Recurring rate reference
": "{String}"
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 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 |
| Error 108848 HTTP 400 | Invalid pricing method |
| Error 108850 HTTP 400 | Rate type is required |
| Error 108851 HTTP 400 | Invalid rate type |
| Error 108650 HTTP 400 | Effective date must be before expiration date |