API

Rental APIs

GET system/reports/117357/result-set?expireWithinNumberOfDays={ExpireWithinNumberOfDays}

Lists all active rental contract items, meaning items which has at least one rentalunit being physically on rent, with expiration dates falling within a configurable look-ahead window.

Report name Expiring rental contract items
Report identifier 117357
HTTP method GET
URI https://api.rambase.net/system/reports/117357/result-set?expireWithinNumberOfDays={ExpireWithinNumberOfDays}
Supported formats Xml, Html, Json (ex. $format=json)
Maximum page size ($top) 80
Successful HTTP status code 200
API resource identifier 6907, version 7

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.

Format:
1
1

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.

expireWithinNumberOfDays Integer, optional Number of days untill the contract item expires, 0 means today. If you set 7 it will list all items that will expire within the next seven days.

Minimum: 0,
Maximum: 400,
Default: 7
$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.

CheckOutLocationShortName String Unique abbreviation/short name of the location.
CustomerId Integer Customer identifier.
CustomerName String Name of customer (name of company or surname/familyname/lastname of a person).
CustomersReferenceNumber String Customers item reference number. Typically to the customers internal system.
EffectiveDate Date Start date for the recurring contract item. Available macros: today(), yesterday(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
ExpirationDate Date End date for the recurring contract item. Available macros: today(), yesterday(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
Name String Short description for the rental contract.
ProductDescription String Description of the product.
ProductId Integer Product identifier.
ProductName String Name of the product.
RentalContractId Integer Rental contract identifier.
SellerId Integer Employee identifier.
SellerName String Last name of employee.

Read more about filters and sorting on how to use sortable parameters

CheckOutLocationShortName String Unique abbreviation/short name of the location
CustomerId Integer Customer identifier
CustomerName String Name of customer (name of company or surname/familyname/lastname of a person)
CustomersReferenceNumber String Customers item reference number. Typically to the customers internal system.
EffectiveDate Date Start date for the recurring contract item
ExpirationDate Date End date for the recurring contract item
Name String Short description for the rental contract
ProductDescription String Description of the product
ProductId Integer Product identifier
ProductName String Name of the product
RentalContractId Integer Rental contract identifier
SellerId Integer Employee identifier
SellerName String Last name of employee

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.

Format:
1
<Report>
2
     <Rows>
3
          <Row>
4
               <Status
Status

Status of the rental contract order item

Possible domain values can be found here

>{String}</Status>
5
               <RentalContract
RentalContract

Rental contract

>
6
                    <RentalContractId
RentalContractId

Rental contract identifier

>{Integer}</RentalContractId>
7
                    <Name
Name

Short description for the rental contract

>{String}</Name>
8
                    <RentalContractLink
RentalContractLink

Rental contract reference

>{String}</RentalContractLink>
9
                    <Customer
Customer

Reference to customer

>
10
                         <CustomerId
CustomerId

Customer identifier

>{Integer}</CustomerId>
11
                         <Name
Name

Name of customer (name of company or surname/familyname/lastname of a person)

>{String}</Name>
12
                         <CustomerLink
CustomerLink

Customer reference

>{String}</CustomerLink>
13
                    </Customer>
14
               </RentalContract>
15
               <LineNumber
LineNumber

Line- or sequence number of the item

>{Integer}</LineNumber>
16
               <Type
Type

Item type: 1- Subscription, 2 - Rental

Possible domain values can be found here

This field is greyed out because it is an expandable field. You have to add $expand=Rows.Row.Type in your request URI to get this field

>{Integer}</Type>
17
               <InternalNote
InternalNote

Internal note for the contract item

This field is greyed out because it is an expandable field. You have to add $expand=Rows.Row.InternalNote in your request URI to get this field

>{String}</InternalNote>
18
               <CustomersReferenceNumber
CustomersReferenceNumber

Customers item reference number. Typically to the customers internal system.

This field is greyed out because it is an expandable field. You have to add $expand=Rows.Row.CustomersReferenceNumber in your request URI to get this field

>{String}</CustomersReferenceNumber>
19
               <CheckOut
CheckOut

Check ot details

>
20
                    <Location
Location

Check out location

>
21
                         <ShortName
ShortName

Unique abbreviation/short name of the location

>{String}</ShortName>
22
                         <LocationLink
LocationLink

Location reference

>{String}</LocationLink>
23
                    </Location>
24
               </CheckOut>
25
               <CheckIn
CheckIn

Check in details

>
26
                    <Location
Location

Check in location

>
27
                         <ShortName
ShortName

Unique abbreviation/short name of the location

>{String}</ShortName>
28
                         <LocationLink
LocationLink

Location reference

>{String}</LocationLink>
29
                    </Location>
30
               </CheckIn>
31
               <Product
Product

Reference to product

>
32
                    <ProductId
ProductId

Product identifier

>{Integer}</ProductId>
33
                    <Name
Name

Name of the product

>{String}</Name>
34
                    <Type
Type

Type of product

Possible domain values can be found here

This field is greyed out because it is an expandable field. You have to add $expand=Rows.Row.Product.Type in your request URI to get this field

>{String}</Type>
35
                    <ProductLink
ProductLink

Product reference

>{String}</ProductLink>
36
               </Product>
37
               <ProductDescription
ProductDescription

Description of the product

>{String}</ProductDescription>
38
               <ProductCollection
ProductCollection

Reference to product collection

>
39
                    <ProductId
ProductId

Product identifier

>{Integer}</ProductId>
40
                    <Name
Name

Name of the product

>{String}</Name>
41
                    <Description
Description

Description of the product

>{String}</Description>
42
                    <ProductCollectionLink
ProductCollectionLink

Product reference

>{String}</ProductCollectionLink>
43
               </ProductCollection>
44
               <Quantity
Quantity

Number of units ordered

>{Integer}</Quantity>
45
               <OnRentQuantity
OnRentQuantity

Quantity of rental units that are on rent

>{Integer}</OnRentQuantity>
46
               <Period
Period

Effective period

>
47
                    <EffectiveDate
EffectiveDate

Start date for the recurring contract item

>{Date}</EffectiveDate>
48
                    <ExpirationDate
ExpirationDate

End date for the recurring contract item

>{Date}</ExpirationDate>
49
               </Period>
50
               <Seller
Seller

Reference to the seller of the item

>
51
                    <EmployeeId
EmployeeId

Employee identifier

>{Integer}</EmployeeId>
52
                    <FirstName
FirstName

First name of employee

>{String}</FirstName>
53
                    <LastName
LastName

Last name of employee

>{String}</LastName>
54
                    <EmployeeLink
EmployeeLink

Employee reference

>{String}</EmployeeLink>
55
               </Seller>
56
               <Inspect>
57
                    <TargetApplication
TargetApplication

Application reference when inspecting a line in a report.

>{String}</TargetApplication>
58
               </Inspect>
59
          </Row>
60
     </Rows>
61
     <Paging
Paging

Detailed paging information for this list.

>
62
          <PageSize
PageSize

Number of elements in the list, as defined in $top. Default is 10.

>{Integer}</PageSize>
63
          <Position
Position

Position of the first element in the list

>{Integer}</Position>
64
          <Page
Page

Page index

>{Integer}</Page>
65
          <FirstPageKey
FirstPageKey

Page key to use for navigating to the first page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

>{String}</FirstPageKey>
66
          <FirstPage
FirstPage

Link to the first page in the list. $pageKey is set to FirstPageKey.

>{String}</FirstPage>
67
          <PreviousPageKey
PreviousPageKey

Page key to use for navigating to previous page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

>{String}</PreviousPageKey>
68
          <PreviousPage
PreviousPage

Link to the previous page in the list. $pageKey is set to PreviousPageKey.

>{String}</PreviousPage>
69
          <NextPageKey
NextPageKey

Page key to use for navigating to next page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

>{String}</NextPageKey>
70
          <NextPage
NextPage

Link to the next page in the list. $pageKey is set to NextPageKey.

>{String}</NextPage>
71
          <LastPageKey
LastPageKey

Page key to use for navigating to last page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

>{String}</LastPageKey>
72
          <LastPage
LastPage

Link to the last page in the list. $pageKey is set to LastPageKey.

>{String}</LastPage>
73
          <Size
Size

Total number of records in the list. Use $inlinecount=allpages in the request uri to include this

>{Integer}</Size>
74
     </Paging>
75
</Report>
1
{
2
     "report": {
3
          "rows": [
4
               {
5
                    "status
Status

Status of the rental contract order item

Possible domain values can be found here

": "{String}",
6
                    "rentalContract
RentalContract

Rental contract

": {
7
                         "rentalContractId
RentalContractId

Rental contract identifier

": "{Integer}",
8
                         "name
Name

Short description for the rental contract

": "{String}",
9
                         "rentalContractLink
RentalContractLink

Rental contract reference

": "{String}",
10
                         "customer
Customer

Reference to customer

": {
11
                              "customerId
CustomerId

Customer identifier

": "{Integer}",
12
                              "name
Name

Name of customer (name of company or surname/familyname/lastname of a person)

": "{String}",
13
                              "customerLink
CustomerLink

Customer reference

": "{String}"
14
                         }
15
                    },
16
                    "lineNumber
LineNumber

Line- or sequence number of the item

": "{Integer}",
17
                    "type
Type

Item type: 1- Subscription, 2 - Rental

Possible domain values can be found here

This field is greyed out because it is an expandable field. You have to add $expand=Rows.Row.Type in your request URI to get this field

": "{Integer}",
18
                    "internalNote
InternalNote

Internal note for the contract item

This field is greyed out because it is an expandable field. You have to add $expand=Rows.Row.InternalNote in your request URI to get this field

": "{String}",
19
                    "customersReferenceNumber
CustomersReferenceNumber

Customers item reference number. Typically to the customers internal system.

This field is greyed out because it is an expandable field. You have to add $expand=Rows.Row.CustomersReferenceNumber in your request URI to get this field

": "{String}",
20
                    "checkOut
CheckOut

Check ot details

": {
21
                         "location
Location

Check out location

": {
22
                              "shortName
ShortName

Unique abbreviation/short name of the location

": "{String}",
23
                              "locationLink
LocationLink

Location reference

": "{String}"
24
                         }
25
                    },
26
                    "checkIn
CheckIn

Check in details

": {
27
                         "location
Location

Check in location

": {
28
                              "shortName
ShortName

Unique abbreviation/short name of the location

": "{String}",
29
                              "locationLink
LocationLink

Location reference

": "{String}"
30
                         }
31
                    },
32
                    "product
Product

Reference to product

": {
33
                         "productId
ProductId

Product identifier

": "{Integer}",
34
                         "name
Name

Name of the product

": "{String}",
35
                         "type
Type

Type of product

Possible domain values can be found here

This field is greyed out because it is an expandable field. You have to add $expand=Rows.Row.Product.Type in your request URI to get this field

": "{String}",
36
                         "productLink
ProductLink

Product reference

": "{String}"
37
                    },
38
                    "productDescription
ProductDescription

Description of the product

": "{String}",
39
                    "productCollection
ProductCollection

Reference to product collection

": {
40
                         "productId
ProductId

Product identifier

": "{Integer}",
41
                         "name
Name

Name of the product

": "{String}",
42
                         "description
Description

Description of the product

": "{String}",
43
                         "productCollectionLink
ProductCollectionLink

Product reference

": "{String}"
44
                    },
45
                    "quantity
Quantity

Number of units ordered

": "{Integer}",
46
                    "onRentQuantity
OnRentQuantity

Quantity of rental units that are on rent

": "{Integer}",
47
                    "period
Period

Effective period

": {
48
                         "effectiveDate
EffectiveDate

Start date for the recurring contract item

": "{Date}",
49
                         "expirationDate
ExpirationDate

End date for the recurring contract item

": "{Date}"
50
                    },
51
                    "seller
Seller

Reference to the seller of the item

": {
52
                         "employeeId
EmployeeId

Employee identifier

": "{Integer}",
53
                         "firstName
FirstName

First name of employee

": "{String}",
54
                         "lastName
LastName

Last name of employee

": "{String}",
55
                         "employeeLink
EmployeeLink

Employee reference

": "{String}"
56
                    },
57
                    "inspect": {
58
                         "targetApplication
TargetApplication

Application reference when inspecting a line in a report.

": "{String}"
59
                    }
60
               }
61
          ]
62
     }
63
}

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