Rental APIs
Get rental contract quotes from the versions
| HTTP method | GET |
| URI | https://api.rambase.net/rental/contracts/{rentalContractId}/quotes |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| - URI parameter {rentalContractId} |
Rental contract identifier
Integer, minimum 100000 |
| Maximum page size ($top) | 80 |
| Successful HTTP status code | 200 |
| API resource identifier | 5936, version 19 |
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.
| ActiveQuotes() Named filter | Active and open quotes |
| CreatedBy Integer | PID of the user who created the version. Available macros: currentUser() |
| ExpirationDate Date | Date of quote expiry. Available macros: today(), yesterday(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth() |
| Name String | Name of rental quote. |
| ProcessedDate Date | Date that the rental quote was processed (status 9). Available macros: today(), yesterday(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth() |
| RegisteredBy Integer | PID of user who registered rental quote. Available macros: currentUser() |
| RegistrationDate Date | Date of registration. Available macros: today(), yesterday(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth() |
| RentalContractQuoteId Integer | Rental contract quote identifier. |
| Status Integer | Status of rental quote. |
Read more about filters and sorting on how to use sortable parameters
| CreatedBy Integer | PID of the user who created the version |
| ExpirationDate Date | Date of quote expiry |
| Name String | Name of rental quote |
| ProcessedDate Date | Date that the rental quote was processed (status 9) |
| RegisteredBy Integer | PID of user who registered rental quote |
| RegistrationDate Date | Date of registration |
| RentalContractQuoteId Integer | Rental contract quote identifier |
| Status Integer | Status of rental quote |
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.
RentalContractQuoteId
Rental contract quote identifier
>{Integer}</RentalContractQuoteId>CreatedAt
Date of rental quote creation
>{Datetime}</CreatedAt>Name
Name of rental quote
>{String}</Name>RegistrationDate
Date of registration
>{Date}</RegistrationDate>IssuedDate
Date set when all quote items are sent to customer
>{Date}</IssuedDate>ExpirationDate
Date of quote expiry
>{Date}</ExpirationDate>ProcessedDate
Date that the rental quote was processed (status 9)
>{Date}</ProcessedDate>Description
Description of quote and notes for printout
>{String}</Description>UserId
User identifier
>{Integer}</UserId>FirstName
First name of the user
>{String}</FirstName>LastName
Name of the user
>{String}</LastName>UserLink
User reference
>{String}</UserLink>Assignee
The user who has been assigned to work with this object.
>UserId
User identifier
>{Integer}</UserId>FirstName
First name of the user
>{String}</FirstName>LastName
Name of the user
>{String}</LastName>UserLink
User reference
>{String}</UserLink>UserId
User identifier
>{Integer}</UserId>UserLink
User reference
>{String}</UserLink>RentalContractQuoteLink
Rental contract quote identifier
>{String}</RentalContractQuoteLink>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>RentalContractQuoteId
Rental contract quote identifier
": "{Integer}",CreatedAt
Date of rental quote creation
": "{Datetime}",Name
Name of rental quote
": "{String}",Status
Status of rental quote
Possible domain values can be found here
": "{Integer}",RegistrationDate
Date of registration
": "{Date}",IssuedDate
Date set when all quote items are sent to customer
": "{Date}",ExpirationDate
Date of quote expiry
": "{Date}",ProcessedDate
Date that the rental quote was processed (status 9)
": "{Date}",Description
Description of quote and notes for printout
": "{String}",UserId
User identifier
": "{Integer}",FirstName
First name of the user
": "{String}",LastName
Name of the user
": "{String}",UserLink
User reference
": "{String}"Assignee
The user who has been assigned to work with this object.
": {UserId
User identifier
": "{Integer}",FirstName
First name of the user
": "{String}",LastName
Name of the user
": "{String}",UserLink
User reference
": "{String}"UserId
User identifier
": "{Integer}",UserLink
User reference
": "{String}"RentalContractQuoteLink
Rental contract quote identifier
": "{String}"Paging
Detailed paging information for this list.
": {PageSize
Number of elements in the list, as defined in $top. Default is 10.
": "{Integer}",Position
Position of the first element in the list
": "{Integer}",Page
Page index
": "{Integer}",FirstPage
Link to the first page in the list. $pageKey is set to FirstPageKey.
": "{String}",PreviousPage
Link to the previous page in the list. $pageKey is set to PreviousPageKey.
": "{String}",NextPage
Link to the next page in the list. $pageKey is set to NextPageKey.
": "{String}",LastPage
Link to the last page in the list. $pageKey is set to LastPageKey.
": "{String}",Size
Total number of records in the list. Use $inlinecount=allpages in the request uri to include this
": "{Integer}"
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 101814 HTTP 404 | Employee not found |