Rental APIs
List recurring rates with steps
| Report name | Recurring Rates with Steps |
| Report identifier | 117789 |
| HTTP method | GET |
| URI | https://api.rambase.net/system/reports/117789/result-set |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| Maximum page size ($top) | 80 |
| Successful HTTP status code | 200 |
| API resource identifier | 6996, version 1 |
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.
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.
| $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] |
| $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 |
| $expand String, optional | Use to include output fields that are not returned by default in the response. Accepts a comma-separated list of expandable field names. See the Expand and Select page for more information. |
| $select String, optional | Use to define the fields to return in the response. Accepts a comma-separated list of field names. See the Expand and select page for more information. |
| $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. |
| $format String, optional | Set the format of the response to use for the request. Accepted values are "xml", "html", "jsonstream", "json" |
| $top String, optional | Specifies number of rows to return in each page. Maximum limit is specific for each API resource. Default value is 10. |
| $pageKey String, optional | Use to navigate to first, previous, next or last page in list. Add $expand=PagingDetails to add the different keys to the response. |
| $filter String, optional | Use to filter the result list, see the Filtering and sorting page for more information. |
| $orderby String, optional | Use to order the result list, see the Filtering and sorting page for more information. |
| $inlinecount String, optional | Set to "allpages" to include total number of rows in the response. Possible values are: "allpages", "none" |
Read more about filters and sorting on how to use filter parameters and named filters.
| Currency String | Three character code following the ISO 4217 standard. |
| CustomerId Integer | If customer is specified, only this customer can use this recurring rate for the specified product. |
| EffectiveDate Date | Date from rate is valid. Available macros: today(), yesterday(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth() |
| ExpirationDate Date | Date until rate is valid. Available macros: today(), yesterday(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth() |
| ProductId Integer | Product identifier. |
| RecurringRateId Integer | Recurring rate identifier. |
| Status Integer | Status of recurring rate. |
| Type Integer | Type of recurring rate: 1 - Standard, 2 - Special. |
Read more about filters and sorting on how to use sortable parameters
| Currency String | Three character code following the ISO 4217 standard |
| CustomerId Integer | If customer is specified, only this customer can use this recurring rate for the specified product. |
| EffectiveDate Date | Date from rate is valid |
| ExpirationDate Date | Date until rate is valid |
| ProductId Integer | Product identifier |
| RecurringRateId Integer | Recurring rate identifier |
| Status Integer | Status of recurring rate |
| Type Integer | Type of recurring rate: 1 - Standard, 2 - Special |
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.
RecurringRateId
Recurring rate identifier
>{Integer}</RecurringRateId>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. A rental rate (RRT) cannot be set as the default if the pricing method is Incremental, more than one rate step is defined, the rate type is Special, or another default RRT already exists for the same product, currency, from quantity, and period (effective and expiration date).
>{Boolean}</IsDefault>RateInterval
Interval of recurring rate
Possible domain values can be found here
>{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
Possible domain values can be found here
>{Integer}</PricingMethod>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>Period
Rate validity period
>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>Product
Product reference
>ProductId
Product identifier
>{Integer}</ProductId>Name
Name of the product
>{String}</Name>Description
Description of the product
>{String}</Description>ProductLink
Product reference
>{String}</ProductLink>Customer
Customer reference
>CustomerId
If customer is specified, only this customer can use this recurring rate for the specified product.
>{Integer}</CustomerId>Name
Name of customer (name of company or surname/familyname/lastname of a person)
>{String}</Name>FirstName
Secondary name of a company or firstname of a person
>{String}</FirstName>CustomerLink
Customer reference
>{String}</CustomerLink>RateStep
Rate step
>RateStepId
Rate step identifier
>{Integer}</RateStepId>Rate
Value of step rate
>{Decimal}</Rate>FromStep
Minimum number of intervals or qty triggering rate step
>{Integer}</FromStep>RateStepLink
Rate step reference
>{String}</RateStepLink>RecurringRateLink
Recurring rate reference
>{String}</RecurringRateLink>Paging
Detailed paging information for this list.
>PageSize
Number of elements in the list, as defined in $top. Default is 10.
>{Integer}</PageSize>Position
Position of the first element in the list
>{Integer}</Position>Page
Page index
>{Integer}</Page>FirstPage
Link to the first page in the list. $pageKey is set to FirstPageKey.
>{String}</FirstPage>PreviousPage
Link to the previous page in the list. $pageKey is set to PreviousPageKey.
>{String}</PreviousPage>NextPage
Link to the next page in the list. $pageKey is set to NextPageKey.
>{String}</NextPage>LastPage
Link to the last page in the list. $pageKey is set to LastPageKey.
>{String}</LastPage>Size
Total number of records in the list. Use $inlinecount=allpages in the request uri to include this
>{Integer}</Size>RecurringRateId
Recurring rate identifier
": "{Integer}",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. A rental rate (RRT) cannot be set as the default if the pricing method is Incremental, more than one rate step is defined, the rate type is Special, or another default RRT already exists for the same product, currency, from quantity, and period (effective and expiration date).
": "{Boolean}",RateInterval
Interval of recurring rate
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}",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}",Period
Rate validity period
": {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}"Product
Product reference
": {ProductId
Product identifier
": "{Integer}",Name
Name of the product
": "{String}",Description
Description of the product
": "{String}",ProductLink
Product reference
": "{String}"Customer
Customer reference
": {CustomerId
If customer is specified, only this customer can use this recurring rate for the specified product.
": "{Integer}",Name
Name of customer (name of company or surname/familyname/lastname of a person)
": "{String}",FirstName
Secondary name of a company or firstname of a person
": "{String}",CustomerLink
Customer reference
": "{String}"RateStep
Rate step
": {RateStepId
Rate step identifier
": "{Integer}",Rate
Value of step rate
": "{Decimal}",FromStep
Minimum number of intervals or qty triggering rate step
": "{Integer}",RateStepLink
Rate step 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 104920 HTTP 400 | Log text is required |
| Error 104921 HTTP 400 | Invalid log category |
| Error 101281 HTTP 400 | Too many {0} parameters. Maximum is {1}. |
| Error 100175 HTTP 400 | To date must be equal to, or later than from date. |
| Error 105710 HTTP 400 | Invalid output type |