API

Rental APIs

GET system/reports/117350/result-set

This report provides total values for each unit including other details. Supplier owned or customer owned units are excluded from the report.

Report name Rental unit total values
Report identifier 117350
HTTP method GET
URI https://api.rambase.net/system/reports/117350/result-set
Supported formats Xml, Html, Json (ex. $format=json)
Maximum page size ($top) 80
Successful HTTP status code 200
API resource identifier 6906, version 10

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.

$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.

AvailableFromDate Date Date from which the rental unit is available. Available macros: today(), yesterday(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
CurrentLocationShortName String Unique abbreviation/short name of the location.
Description String Description of rental unit.
FixedAssetId Integer Fixed asset identifier.
FixedAssetStatus Integer Status of fixed asset.
HomeLocationShortName String Unique abbreviation/short name of the location.
ProductCollectionId Integer Product identifier.
ProductDescription String Description of the product.
ProductId Integer Product identifier.
ProductName String Name of the product.
RentalUnitId Integer Rental unit identifier.
SerialNumber String Serial number.
Status String Status.
Total Decimal The total price in company currency from the goods reception, or Balance from the fixed asset if the rental unit is tied to a fixed asset.

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

AvailableFromDate Date Date from which the rental unit is available
Description String Description of rental unit
ProductCollectionId Integer Product identifier
ProductDescription String Description of the product
ProductId Integer Product identifier
ProductName String Name of the product
RentalUnitId Integer Rental unit identifier
SerialNumber String Serial number
Status String Status
Total Decimal The total price in company currency from the goods reception, or Balance from the fixed asset if the rental unit is tied to a fixed asset

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

Possible domain values can be found here

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

Rental unit identifier

>{Integer}</RentalUnitId>
6
               <Description
Description

Description of rental unit

>{String}</Description>
7
               <Availability
Availability

Availability for selected period

>
8
                    <AvailableFromDate
AvailableFromDate

Date from which the rental unit is available

>{Date}</AvailableFromDate>
9
               </Availability>
10
               <Product
Product

Product of the unit

>
11
                    <ProductId
ProductId

Product identifier

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

Name of the product

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

Description of the product

>{String}</Description>
14
                    <ProductLink
ProductLink

Product reference

>{String}</ProductLink>
15
               </Product>
16
               <ProductCollection
ProductCollection

Reference to product collection

>
17
                    <ProductId
ProductId

Product identifier

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

Name of the product

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

Description of the product

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

Product reference

>{String}</ProductCollectionLink>
21
               </ProductCollection>
22
               <ProductUnit
ProductUnit

Product unit of the unit

>
23
                    <ProductUnitId
ProductUnitId

Product unit identifier

>{Integer}</ProductUnitId>
24
                    <SerialNumber
SerialNumber

Serial number

>{String}</SerialNumber>
25
                    <ProductUnitLink
ProductUnitLink

Product unit reference

>{String}</ProductUnitLink>
26
               </ProductUnit>
27
               <CurrentLocation
CurrentLocation

Reference to current location of the unit

>
28
                    <ShortName
ShortName

Unique abbreviation/short name of the location

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

Location reference

>{String}</LocationLink>
30
               </CurrentLocation>
31
               <HomeLocation
HomeLocation

Reference to home location of the rental unit

>
32
                    <LocationId
LocationId

Location identifier

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

>{Integer}</LocationId>
33
                    <ShortName
ShortName

Unique abbreviation/short name of the location

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

Location reference

>{String}</LocationLink>
35
               </HomeLocation>
36
               <FixedAsset
FixedAsset

Fixed asset assigned to rental unit

>
37
                    <Status
Status

Status of fixed asset

Possible domain values can be found here

>{Integer}</Status>
38
                    <FixedAssetId
FixedAssetId

Fixed asset identifier

>{Integer}</FixedAssetId>
39
                    <Name
Name

Name of fixed asset

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

Description of fixed asset

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

Depreciation details for the fixed asset

>
42
                         <Currency
Currency

Currency of the object. Three character code following the ISO 4217 standard.

>{String}</Currency>
43
                         <DepreciatedAmount
DepreciatedAmount

Represents the depreciated amount of the fixed asset.

>{Decimal}</DepreciatedAmount>
44
                    </Depreciation>
45
               </FixedAsset>
46
               <OriginalEquipmentCost
OriginalEquipmentCost

Undepreciated acquisition cost of the equipment, fixed in company currency

>{Decimal}</OriginalEquipmentCost>
47
               <Total
Total

The total price in company currency from the goods reception, or Balance from the fixed asset if the rental unit is tied to a fixed asset

>{Decimal}</Total>
48
               <Currency
Currency

Currency of the object. Three character code following the ISO 4217 standard.

Possible domain values can be found here

>{String}</Currency>
49
               <CurrentReceptionItem
CurrentReceptionItem

The current goods reception that the rental unit is located on. This will get a new value each time the rental unit is returned from rent.

>
50
                    <GoodsReceptionItemId
GoodsReceptionItemId

Item-/line-number of the goods reception

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

>{Integer}</GoodsReceptionItemId>
51
                    <GoodsReception
GoodsReception

Goods reception reference

>
52
                         <GoodsReceptionId
GoodsReceptionId

Goods reception identifier

>{Integer}</GoodsReceptionId>
53
                         <GoodsReceptionLink
GoodsReceptionLink

Goods reception identifier

>{String}</GoodsReceptionLink>
54
                    </GoodsReception>
55
                    <GoodsReceptionItemLink
GoodsReceptionItemLink

Goods reception item reference

>{String}</GoodsReceptionItemLink>
56
               </CurrentReceptionItem>
57
               <InitialReceptionItem
InitialReceptionItem

Initial goods reception that was used when moving a product from sales to the rental fleet

>
58
                    <GoodsReceptionItemId
GoodsReceptionItemId

Item-/line-number of the goods reception

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

>{Integer}</GoodsReceptionItemId>
59
                    <GoodsReception
GoodsReception

Goods reception reference

>
60
                         <GoodsReceptionId
GoodsReceptionId

Goods reception identifier

>{Integer}</GoodsReceptionId>
61
                         <GoodsReceptionLink
GoodsReceptionLink

Goods reception identifier

>{String}</GoodsReceptionLink>
62
                    </GoodsReception>
63
                    <GoodsReceptionItemLink
GoodsReceptionItemLink

Goods reception item reference

>{String}</GoodsReceptionItemLink>
64
               </InitialReceptionItem>
65
               <Inspect>
66
                    <TargetApplication
TargetApplication

Application reference when inspecting a line in a report.

>{String}</TargetApplication>
67
               </Inspect>
68
          </Row>
69
     </Rows>
70
     <Aggregated
Aggregated

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

>
71
          <Total
Total

The total price in company currency from the goods reception, or Balance from the fixed asset if the rental unit is tied to a fixed asset

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

>{Decimal}</Total>
72
     </Aggregated>
73
     <Paging
Paging

Detailed paging information for this list.

>
74
          <PageSize
PageSize

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

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

Position of the first element in the list

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

Page index

>{Integer}</Page>
77
          <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>
78
          <FirstPage
FirstPage

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

>{String}</FirstPage>
79
          <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>
80
          <PreviousPage
PreviousPage

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

>{String}</PreviousPage>
81
          <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>
82
          <NextPage
NextPage

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

>{String}</NextPage>
83
          <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>
84
          <LastPage
LastPage

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

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

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

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

Status

Possible domain values can be found here

": "{String}",
6
                    "rentalUnitId
RentalUnitId

Rental unit identifier

": "{Integer}",
7
                    "description
Description

Description of rental unit

": "{String}",
8
                    "availability
Availability

Availability for selected period

": {
9
                         "availableFromDate
AvailableFromDate

Date from which the rental unit is available

": "{Date}"
10
                    },
11
                    "product
Product

Product of the unit

": {
12
                         "productId
ProductId

Product identifier

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

Name of the product

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

Description of the product

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

Product reference

": "{String}"
16
                    },
17
                    "productCollection
ProductCollection

Reference to product collection

": {
18
                         "productId
ProductId

Product identifier

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

Name of the product

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

Description of the product

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

Product reference

": "{String}"
22
                    },
23
                    "productUnit
ProductUnit

Product unit of the unit

": {
24
                         "productUnitId
ProductUnitId

Product unit identifier

": "{Integer}",
25
                         "serialNumber
SerialNumber

Serial number

": "{String}",
26
                         "productUnitLink
ProductUnitLink

Product unit reference

": "{String}"
27
                    },
28
                    "currentLocation
CurrentLocation

Reference to current location of the unit

": {
29
                         "shortName
ShortName

Unique abbreviation/short name of the location

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

Location reference

": "{String}"
31
                    },
32
                    "homeLocation
HomeLocation

Reference to home location of the rental unit

": {
33
                         "locationId
LocationId

Location identifier

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

": "{Integer}",
34
                         "shortName
ShortName

Unique abbreviation/short name of the location

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

Location reference

": "{String}"
36
                    },
37
                    "fixedAsset
FixedAsset

Fixed asset assigned to rental unit

": {
38
                         "status
Status

Status of fixed asset

Possible domain values can be found here

": "{Integer}",
39
                         "fixedAssetId
FixedAssetId

Fixed asset identifier

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

Name of fixed asset

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

Description of fixed asset

": "{String}",
42
                         "depreciation
Depreciation

Depreciation details for the fixed asset

": {
43
                              "currency
Currency

Currency of the object. Three character code following the ISO 4217 standard.

": "{String}",
44
                              "depreciatedAmount
DepreciatedAmount

Represents the depreciated amount of the fixed asset.

": "{Decimal}"
45
                         }
46
                    },
47
                    "originalEquipmentCost
OriginalEquipmentCost

Undepreciated acquisition cost of the equipment, fixed in company currency

": "{Decimal}",
48
                    "total
Total

The total price in company currency from the goods reception, or Balance from the fixed asset if the rental unit is tied to a fixed asset

": "{Decimal}",
49
                    "currency
Currency

Currency of the object. Three character code following the ISO 4217 standard.

Possible domain values can be found here

": "{String}",
50
                    "currentReceptionItem
CurrentReceptionItem

The current goods reception that the rental unit is located on. This will get a new value each time the rental unit is returned from rent.

": {
51
                         "goodsReceptionItemId
GoodsReceptionItemId

Item-/line-number of the goods reception

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

": "{Integer}",
52
                         "goodsReception
GoodsReception

Goods reception reference

": {
53
                              "goodsReceptionId
GoodsReceptionId

Goods reception identifier

": "{Integer}",
54
                              "goodsReceptionLink
GoodsReceptionLink

Goods reception identifier

": "{String}"
55
                         },
56
                         "goodsReceptionItemLink
GoodsReceptionItemLink

Goods reception item reference

": "{String}"
57
                    },
58
                    "initialReceptionItem
InitialReceptionItem

Initial goods reception that was used when moving a product from sales to the rental fleet

": {
59
                         "goodsReceptionItemId
GoodsReceptionItemId

Item-/line-number of the goods reception

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

": "{Integer}",
60
                         "goodsReception
GoodsReception

Goods reception reference

": {
61
                              "goodsReceptionId
GoodsReceptionId

Goods reception identifier

": "{Integer}",
62
                              "goodsReceptionLink
GoodsReceptionLink

Goods reception identifier

": "{String}"
63
                         },
64
                         "goodsReceptionItemLink
GoodsReceptionItemLink

Goods reception item reference

": "{String}"
65
                    },
66
                    "inspect": {
67
                         "targetApplication
TargetApplication

Application reference when inspecting a line in a report.

": "{String}"
68
                    }
69
               }
70
          ],
71
          "aggregated
Aggregated

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

": {
72
               "total
Total

The total price in company currency from the goods reception, or Balance from the fixed asset if the rental unit is tied to a fixed asset

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

": "{Decimal}"
73
          }
74
     }
75
}

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