Rental APIs
Report provides a consolidated view of revenue for rental contracts and related services, segmented by revenue stage and grouped by Rental contracts.
| Report name | Rental: Recurring revenue summary by Rental contract |
| Report identifier | 117397 |
| HTTP method | GET |
| URI | https://api.rambase.net/system/reports/117397/result-set?includeInactiveContractItems={includeInactiveContractItems}&view={view}&fromDate={fromDate}&toDate={toDate} |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| Maximum page size ($top) | 80 |
| Successful HTTP status code | 200 |
| API resource identifier | 6922, version 5 |
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.
| includeInactiveContractItems Boolean, optional |
Include inactive contracts in report
Default: FALSE |
| view String, optional |
Selection of documents to include
Default: ORDERSANDQUOTES |
| fromDate Date, optional | Dates from and including date |
| toDate Date, optional | Dates to and including date |
| $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.
| RentalContractId Integer | Rental contract identifier. |
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.
RentalContract
Rental contract
>RentalContractId
Rental contract identifier
>{Integer}</RentalContractId>Name
Short description for the rental contract
>{String}</Name>RentalContractLink
Rental contract reference
>{String}</RentalContractLink>Customer
Customer reference
>CustomerId
Customer identifier
>{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>TotalsConverted
Total amounts
>Currency
Three character code following the ISO 4217 standard
>{String}</Currency>ForecastedRevenue
Total forecasted revenue for contract item in company currency.
>{Decimal}</ForecastedRevenue>EstimatedRevenue
Estimated revenue in company currency
>{Decimal}</EstimatedRevenue>AccruedRevenue
Total accrued revenue for contract item in company currency.
>{Decimal}</AccruedRevenue>EarnedRevenue
Total earned revenue for contract item in company currency
>{Decimal}</EarnedRevenue>DeferredRevenue
Total deferred revenue for rental contract item in company currency.
>{Decimal}</DeferredRevenue>InvoicedAmount
Invoiced amount for contract item in company currency.
>{Decimal}</InvoicedAmount>TargetApplication
Application reference when inspecting a line in a report.
>{String}</TargetApplication>Filter
Filter used when inspecting a line in a report.
>{String}</Filter>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>RentalContract
Rental contract
": {RentalContractId
Rental contract identifier
": "{Integer}",Name
Short description for the rental contract
": "{String}",RentalContractLink
Rental contract reference
": "{String}"Customer
Customer reference
": {CustomerId
Customer identifier
": "{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}"TotalsConverted
Total amounts
": {Currency
Three character code following the ISO 4217 standard
": "{String}",ForecastedRevenue
Total forecasted revenue for contract item in company currency.
": "{Decimal}",EstimatedRevenue
Estimated revenue in company currency
": "{Decimal}",AccruedRevenue
Total accrued revenue for contract item in company currency.
": "{Decimal}",EarnedRevenue
Total earned revenue for contract item in company currency
": "{Decimal}",DeferredRevenue
Total deferred revenue for rental contract item in company currency.
": "{Decimal}",InvoicedAmount
Invoiced amount for contract item in company currency.
": "{Decimal}"TargetApplication
Application reference when inspecting a line in a report.
": "{String}",Filter
Filter used when inspecting a line in a report.
": "{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 |