API

Rental APIs

GET rental/contracts/{rentalContractId}/quotes/{rentalContractQuoteId}/items

Get rental contract quote items

HTTP method GET
URI https://api.rambase.net/rental/contracts/{rentalContractId}/quotes/{rentalContractQuoteId}/items
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {rentalContractId} Rental contract identifier
Integer, minimum 100000
- URI parameter {rentalContractQuoteId} Rental contract quote identifier
Integer, minimum 1
Maximum page size ($top) 80
Successful HTTP status code 200
API resource identifier 6013, version 12

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.

OpenItems() Named filter Open items
CreatedAt Datetime Date of item creation. Available macros: now(), startOfDay(), endOfDay(), currentDate(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
CustomersReferenceNumber String Customers item reference number. Typically to the customers internal system.
IsActive Boolean Indicates whether version is active one.
LineNumber Integer Line- or sequence number of the item.
ProductId Integer Product identifier.
ProductType String Type of product.
Quantity Decimal Number of units ordered.
RentalContractItemId Integer Rental contract item identifier.
Revision Integer Rental contract item revision.
Status Integer Status of contract item.
Version Integer Rental contract item version.

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

CreatedAt Datetime Date of item creation
CustomersReferenceNumber String Customers item reference number. Typically to the customers internal system.
IsActive Boolean Indicates whether version is active one
LineNumber Integer Line- or sequence number of the item
ProductId Integer Product identifier
ProductType String Type of product
Quantity Decimal Number of units ordered
RentalContractItemId Integer Rental contract item identifier
Revision Integer Rental contract item revision
Status Integer Status of contract item
Version Integer Rental contract item version

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
<RentalContractItems>
2
     <RentalContractItem>
3
          <RentalContractItemId
RentalContractItemId

Rental contract item identifier

>{Integer}</RentalContractItemId>
4
          <LineNumber
LineNumber

Line- or sequence number of the item

>{Integer}</LineNumber>
5
          <CreatedAt
CreatedAt

Date of item creation

>{Datetime}</CreatedAt>
6
          <RentalContractVersion>
7
               <RentalContractVersionId
RentalContractVersionId

Rental contract version identifier

>{Integer}</RentalContractVersionId>
8
               <Version
Version

Rental contract item version

>{Integer}</Version>
9
               <Revision
Revision

Rental contract item revision

>{Integer}</Revision>
10
               <RentalContractVersionLink
RentalContractVersionLink

Rentlal contract version reference

>{String}</RentalContractVersionLink>
11
          </RentalContractVersion>
12
          <IsActive
IsActive

Indicates whether version is active one

>{Boolean}</IsActive>
13
          <Status
Status

Status with regard to the stage of the item

Possible domain values can be found here

>{String}</Status>
14
          <Type
Type

Item type: 1- Subscription, 2 - Rental

Possible domain values can be found here

>{Integer}</Type>
15
          <Note
Note

Note for contract item

>{String}</Note>
16
          <InternalNote
InternalNote

Internal note for the contract item

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

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

>{String}</CustomersReferenceNumber>
18
          <Product>
19
               <ProductId
ProductId

Product identifier

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

Name of the product

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

Type of product

Possible domain values can be found here

>{String}</Type>
22
               <Description
Description

Description of the product

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

Product reference

>{String}</ProductLink>
24
          </Product>
25
          <Quantity
Quantity

Number of units ordered

>{Integer}</Quantity>
26
          <DiscountPercent
DiscountPercent

The discount in percent for this item.

>{Decimal}</DiscountPercent>
27
          <RecurringRate>
28
               <RecurringRateId
RecurringRateId

Recurring rate identifier

>{Integer}</RecurringRateId>
29
               <Status
Status

Status of recurring rate

Possible domain values can be found here

>{Integer}</Status>
30
               <Currency
Currency

Three character code following the ISO 4217 standard

>{String}</Currency>
31
               <RateInterval
RateInterval

Interval of recurring rate

Possible domain values can be found here

>{Integer}</RateInterval>
32
               <Type
Type

Type of recurring rate: 1 - Standard, 2 - Special

Possible domain values can be found here

>{Integer}</Type>
33
               <NumberOfRateSteps
NumberOfRateSteps

Number of rate steps

>{Integer}</NumberOfRateSteps>
34
               <RecurringRateLink
RecurringRateLink

Recurring rate reference

>{String}</RecurringRateLink>
35
          </RecurringRate>
36
          <CurrentRateStep>
37
               <Currency
Currency

Three character code following the ISO 4217 standard

>{String}</Currency>
38
               <Rate
Rate

Value of step rate

>{Decimal}</Rate>
39
          </CurrentRateStep>
40
          <Period>
41
               <EffectiveDate
EffectiveDate

Start date for the recurring contract item

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

End date for the recurring contract item

>{Date}</ExpirationDate>
43
               <TerminationDate
TerminationDate

Termination date of item

>{Date}</TerminationDate>
44
          </Period>
45
          <OnRentDays
OnRentDays

Number of on-rent days

>{Integer}</OnRentDays>
46
          <ShippingAddress>
47
               <AddressId
AddressId

Address identifier

>{Integer}</AddressId>
48
               <AddressLink
AddressLink

Address reference

>{String}</AddressLink>
49
          </ShippingAddress>
50
          <ShippingService>
51
               <ShippingServiceId
ShippingServiceId

Shipping service identifier

>{Integer}</ShippingServiceId>
52
               <ShippingServiceLink
ShippingServiceLink

Shipping service reference

>{String}</ShippingServiceLink>
53
          </ShippingService>
54
          <Totals
Totals

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

>
55
               <Currency
Currency

Three character code following the ISO 4217 standard

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

>{String}</Currency>
56
               <TotalAmount
TotalAmount

Total amount

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

>{Decimal}</TotalAmount>
57
               <DiscountAmount
DiscountAmount

Total discount

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

>{Decimal}</DiscountAmount>
58
               <TotalNetAmount
TotalNetAmount

Total amount after discount

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

>{Decimal}</TotalNetAmount>
59
               <AccruedRevenue
AccruedRevenue

Total accrued amount for contract item

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

>{Decimal}</AccruedRevenue>
60
               <InvoicedAmount
InvoicedAmount

Invoiced amount for contract item

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

>{Decimal}</InvoicedAmount>
61
               <ForecastedRevenue
ForecastedRevenue

Total forecasted revenue for contract item

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

>{Decimal}</ForecastedRevenue>
62
               <EarnedRevenue
EarnedRevenue

Total earned revenue for contract item

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

>{Decimal}</EarnedRevenue>
63
               <DeferredRevenue
DeferredRevenue

Total deferred revenue of rental contract item

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

>{Decimal}</DeferredRevenue>
64
          </Totals>
65
          <TotalsConverted
TotalsConverted

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

>
66
               <Currency
Currency

Three character code following the ISO 4217 standard

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

>{String}</Currency>
67
               <TotalAmount
TotalAmount

Total amount for contract item in company currency

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

>{Decimal}</TotalAmount>
68
               <AccruedRevenue
AccruedRevenue

Total accrued revenue for contract item in company currency.

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

>{Decimal}</AccruedRevenue>
69
               <InvoicedAmount
InvoicedAmount

Invoiced amount for contract item in company currency.

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

>{Decimal}</InvoicedAmount>
70
               <ForecastedRevenue
ForecastedRevenue

Total forecasted revenue for contract item in company currency.

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

>{Decimal}</ForecastedRevenue>
71
               <DeferredRevenue
DeferredRevenue

Total deferred revenue for rental contract item in company currency.

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

>{Decimal}</DeferredRevenue>
72
          </TotalsConverted>
73
     </RentalContractItem>
74
     <Paging
Paging

Detailed paging information for this list.

>
75
          <PageSize
PageSize

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

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

Position of the first element in the list

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

Page index

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

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

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

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

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

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

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

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

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

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

>{Integer}</Size>
87
     </Paging>
88
</RentalContractItems>
1
{
2
     "rentalContractItems": [
3
          {
4
               "rentalContractItemId
RentalContractItemId

Rental contract item identifier

": "{Integer}",
5
               "lineNumber
LineNumber

Line- or sequence number of the item

": "{Integer}",
6
               "createdAt
CreatedAt

Date of item creation

": "{Datetime}",
7
               "rentalContractVersion": {
8
                    "rentalContractVersionId
RentalContractVersionId

Rental contract version identifier

": "{Integer}",
9
                    "version
Version

Rental contract item version

": "{Integer}",
10
                    "revision
Revision

Rental contract item revision

": "{Integer}",
11
                    "rentalContractVersionLink
RentalContractVersionLink

Rentlal contract version reference

": "{String}"
12
               },
13
               "isActive
IsActive

Indicates whether version is active one

": "{Boolean}",
14
               "status
Status

Status with regard to the stage of the item

Possible domain values can be found here

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

Item type: 1- Subscription, 2 - Rental

Possible domain values can be found here

": "{Integer}",
16
               "note
Note

Note for contract item

": "{String}",
17
               "internalNote
InternalNote

Internal note for the contract item

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

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

": "{String}",
19
               "product": {
20
                    "productId
ProductId

Product identifier

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

Name of the product

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

Type of product

Possible domain values can be found here

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

Description of the product

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

Product reference

": "{String}"
25
               },
26
               "quantity
Quantity

Number of units ordered

": "{Integer}",
27
               "discountPercent
DiscountPercent

The discount in percent for this item.

": "{Decimal}",
28
               "recurringRate": {
29
                    "recurringRateId
RecurringRateId

Recurring rate identifier

": "{Integer}",
30
                    "status
Status

Status of recurring rate

Possible domain values can be found here

": "{Integer}",
31
                    "currency
Currency

Three character code following the ISO 4217 standard

": "{String}",
32
                    "rateInterval
RateInterval

Interval of recurring rate

Possible domain values can be found here

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

Type of recurring rate: 1 - Standard, 2 - Special

Possible domain values can be found here

": "{Integer}",
34
                    "numberOfRateSteps
NumberOfRateSteps

Number of rate steps

": "{Integer}",
35
                    "recurringRateLink
RecurringRateLink

Recurring rate reference

": "{String}"
36
               },
37
               "currentRateStep": {
38
                    "currency
Currency

Three character code following the ISO 4217 standard

": "{String}",
39
                    "rate
Rate

Value of step rate

": "{Decimal}"
40
               },
41
               "period": {
42
                    "effectiveDate
EffectiveDate

Start date for the recurring contract item

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

End date for the recurring contract item

": "{Date}",
44
                    "terminationDate
TerminationDate

Termination date of item

": "{Date}"
45
               },
46
               "onRentDays
OnRentDays

Number of on-rent days

": "{Integer}",
47
               "shippingAddress": {
48
                    "addressId
AddressId

Address identifier

": "{Integer}",
49
                    "addressLink
AddressLink

Address reference

": "{String}"
50
               },
51
               "shippingService": {
52
                    "shippingServiceId
ShippingServiceId

Shipping service identifier

": "{Integer}",
53
                    "shippingServiceLink
ShippingServiceLink

Shipping service reference

": "{String}"
54
               },
55
               "totals
Totals

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

": {
56
                    "currency
Currency

Three character code following the ISO 4217 standard

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

": "{String}",
57
                    "totalAmount
TotalAmount

Total amount

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

": "{Decimal}",
58
                    "discountAmount
DiscountAmount

Total discount

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

": "{Decimal}",
59
                    "totalNetAmount
TotalNetAmount

Total amount after discount

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

": "{Decimal}",
60
                    "accruedRevenue
AccruedRevenue

Total accrued amount for contract item

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

": "{Decimal}",
61
                    "invoicedAmount
InvoicedAmount

Invoiced amount for contract item

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

": "{Decimal}",
62
                    "forecastedRevenue
ForecastedRevenue

Total forecasted revenue for contract item

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

": "{Decimal}",
63
                    "earnedRevenue
EarnedRevenue

Total earned revenue for contract item

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

": "{Decimal}",
64
                    "deferredRevenue
DeferredRevenue

Total deferred revenue of rental contract item

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

": "{Decimal}"
65
               },
66
               "totalsConverted
TotalsConverted

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

": {
67
                    "currency
Currency

Three character code following the ISO 4217 standard

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

": "{String}",
68
                    "totalAmount
TotalAmount

Total amount for contract item in company currency

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

": "{Decimal}",
69
                    "accruedRevenue
AccruedRevenue

Total accrued revenue for contract item in company currency.

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

": "{Decimal}",
70
                    "invoicedAmount
InvoicedAmount

Invoiced amount for contract item in company currency.

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

": "{Decimal}",
71
                    "forecastedRevenue
ForecastedRevenue

Total forecasted revenue for contract item in company currency.

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

": "{Decimal}",
72
                    "deferredRevenue
DeferredRevenue

Total deferred revenue for rental contract item in company currency.

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

": "{Decimal}"
73
               }
74
          }
75
     ],
76
     "paging
Paging

Detailed paging information for this list.

": {
77
          "pageSize
PageSize

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

": "{Integer}",
78
          "position
Position

Position of the first element in the list

": "{Integer}",
79
          "page
Page

Page index

": "{Integer}",
80
          "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}",
81
          "firstPage
FirstPage

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

": "{String}",
82
          "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}",
83
          "previousPage
PreviousPage

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

": "{String}",
84
          "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}",
85
          "nextPage
NextPage

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

": "{String}",
86
          "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}",
87
          "lastPage
LastPage

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

": "{String}",
88
          "size
Size

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

": "{Integer}"
89
     }
90
}

Possible error codes the response might return:

Error 107999 HTTP 400 Rental contract not found
Error 108395 HTTP 404 Contract quote not found
Error 105970 HTTP 400 End date is required