API

Rental APIs

GET rental/contract-items

Get list of rental contract items.

HTTP method GET
URI https://api.rambase.net/rental/contract-items
Supported formats Xml, Html, Json (ex. $format=json)
Maximum page size ($top) 80
Successful HTTP status code 200
API resource identifier 5850, version 9

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
OrderItems() Named filter Order items
Amount Decimal Total amount.
ContainingRecurringRateId Integer Recurring rate identifier.
CreatedAt Datetime Date of item creation. Available macros: now(), startOfDay(), endOfDay(), currentDate(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
CustomerId String Customer identifier.
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()
InitialRentalContractItemId Integer Original item identifier.
IsActive Boolean Indicates whether version is active one.
LineNumber Integer Line- or sequence number of the item. The LineNumber is used for sorting items in applications, prints, reports etc.
LocationId Integer Location identifier.
ProductDescription String Description of the product.
ProductId Integer Product identifier.
ProductName String Name of the product.
Quantity Decimal Number of units ordered.
QuoteNumber Integer Quote number.
RentalContractId Integer Rental contract identifier.
RentalContractItemId Integer Rental contract item identifier.
RentalContractQuoteId Integer Rental contract quote identifier.
RentalContractVersionId Integer Rental contract version identifier.
Revision Integer Rental contract item revision.
Stage Integer Contract item stage.
Status String Status with regard to the stage of the item.
Type Integer Item type: 1- Subscription, 2 - Rental.
Version Integer Rental contract item version.

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

Amount Decimal Total amount
ContainingRecurringRateId Integer Recurring rate identifier
CreatedAt Datetime Date of item creation
CustomerId String Customer identifier
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
InitialRentalContractItemId Integer Original item identifier
IsActive Boolean Indicates whether version is active one
LineNumber Integer Line- or sequence number of the item. The LineNumber is used for sorting items in applications, prints, reports etc.
LocationId Integer Location identifier
ProductDescription String Description of the product
ProductId Integer Product identifier
ProductName String Name of the product
Quantity Decimal Number of units ordered
QuoteNumber Integer Quote number
RentalContractId Integer Rental contract identifier
RentalContractItemId Integer Rental contract item identifier
RentalContractQuoteId Integer Rental contract quote identifier
RentalContractVersionId Integer Rental contract version identifier
Revision Integer Rental contract item revision
Stage Integer Contract item stage
Status String Status with regard to the stage of the item
Type Integer Item type: 1- Subscription, 2 - Rental
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
          <RentalContract>
5
               <RentalContractId
RentalContractId

Rental contract identifier

>{Integer}</RentalContractId>
6
               <RentalContractLink
RentalContractLink

Rental contract reference

>{String}</RentalContractLink>
7
          </RentalContract>
8
          <LineNumber
LineNumber

Line- or sequence number of the item

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

Date of item creation

>{Datetime}</CreatedAt>
10
          <RentalContractVersion>
11
               <RentalContractVersionId
RentalContractVersionId

Rental contract version identifier

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

Rental contract item version

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

Rental contract item revision

>{Integer}</Revision>
14
               <CreatedBy
CreatedBy

PID of the user who created the version

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

>
15
                    <UserId
UserId

User identifier

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

>{Integer}</UserId>
16
                    <Name
Name

Name of the user

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

>{String}</Name>
17
                    <FirstName
FirstName

First name of the user

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

>{String}</FirstName>
18
                    <UserLink
UserLink

User reference

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

>{String}</UserLink>
19
               </CreatedBy>
20
               <RentalContractVersionLink
RentalContractVersionLink

Rentlal contract version reference

>{String}</RentalContractVersionLink>
21
          </RentalContractVersion>
22
          <RentalContractQuote>
23
               <RentalContractQuoteId
RentalContractQuoteId

Rental contract quote identifier

>{Integer}</RentalContractQuoteId>
24
               <Name
Name

Quote name

>{String}</Name>
25
          </RentalContractQuote>
26
          <IsActive
IsActive

Indicates whether version is active one

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

Status with regard to the stage of the item

Possible domain values can be found here

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

Item type: 1- Subscription, 2 - Rental

Possible domain values can be found here

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

Note for contract item

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

Internal note for the contract item

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

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

>{String}</CustomersReferenceNumber>
32
          <RateChangeType
RateChangeType

Change type of recurring rate (FIXED, MANUAL, AUTO). Defines if and how the recurring rate can be updated.

Possible domain values can be found here

>{Integer}</RateChangeType>
33
          <InitialRentalContractItem>
34
               <RentalContractItemId
RentalContractItemId

Rental contract item identifier

>{Integer}</RentalContractItemId>
35
          </InitialRentalContractItem>
36
          <Product>
37
               <ProductId
ProductId

Product identifier

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

Name of the product

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

Type of product

Possible domain values can be found here

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

Description of the product

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

Product reference

>{String}</ProductLink>
42
          </Product>
43
          <Quantity
Quantity

Number of units ordered

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

The discount in percent for this item.

>{Decimal}</DiscountPercent>
45
          <RecurringRate>
46
               <RecurringRateId
RecurringRateId

Recurring rate identifier

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

Status of recurring rate

Possible domain values can be found here

>{String}</Status>
48
               <Currency
Currency

Three character code following the ISO 4217 standard

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

Interval of recurring rate

Possible domain values can be found here

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

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

Possible domain values can be found here

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

Number of rate steps

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

Recurring rate reference

>{String}</RecurringRateLink>
53
          </RecurringRate>
54
          <CurrentRateStep>
55
               <Currency
Currency

Three character code following the ISO 4217 standard

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

Value of step rate

>{Decimal}</Rate>
57
          </CurrentRateStep>
58
          <Period>
59
               <EffectiveDate
EffectiveDate

Start date for the recurring contract item

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

End date for the recurring contract item

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

Termination date of item

>{Date}</TerminationDate>
62
          </Period>
63
          <OnRentDays
OnRentDays

Number of on-rent days

>{Integer}</OnRentDays>
64
          <AverageRatePerDay
AverageRatePerDay

Average rate per day

>{Decimal}</AverageRatePerDay>
65
          <ShippingAddress
ShippingAddress

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

>
66
               <AddressId
AddressId

Address identifier

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

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

Address reference

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

>{String}</AddressLink>
68
          </ShippingAddress>
69
          <ShippingService
ShippingService

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

>
70
               <ShippingServiceId
ShippingServiceId

Shipping service identifier

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

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

Shipping service reference

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

>{String}</ShippingServiceLink>
72
          </ShippingService>
73
          <Totals>
74
               <Currency
Currency

Three character code following the ISO 4217 standard

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

Total amount

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

Total discount

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

Total amount after discount

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

Total accrued amount for contract item

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

Invoiced amount for contract item

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

Total forecasted revenue for contract item

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

Total earned revenue for contract item

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

Total deferred revenue of rental contract item

>{Decimal}</DeferredRevenue>
83
          </Totals>
84
          <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

>
85
               <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>
86
               <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>
87
               <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>
88
               <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>
89
               <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>
90
               <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>
91
          </TotalsConverted>
92
          <CalendarSummary
CalendarSummary

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

>
93
               <Quantity
Quantity

Quantity change range from min to max

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

>
94
                    <Min
Min

Minimum quantity

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

>{Integer}</Min>
95
                    <Max
Max

Maximum quantity

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

>{Integer}</Max>
96
                    <Current
Current

Rental calendar day quantity

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

>{Integer}</Current>
97
                    <NumberOfChanges
NumberOfChanges

Number of changes

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

>{Integer}</NumberOfChanges>
98
               </Quantity>
99
               <RecurringRate
RecurringRate

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

>
100
                    <NumberOfChanges
NumberOfChanges

Number of recurring rates used by rental contract item

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

>{Integer}</NumberOfChanges>
101
                    <CurrentRecurringRate
CurrentRecurringRate

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

>
102
                         <RecurringRateId
RecurringRateId

Recurring rate identifier

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

>{Integer}</RecurringRateId>
103
                         <RecurringRateLink
RecurringRateLink

Recurring rate reference

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

>{String}</RecurringRateLink>
104
                    </CurrentRecurringRate>
105
               </RecurringRate>
106
               <DiscountPercentage
DiscountPercentage

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

>
107
                    <Min
Min

Minimum discount per centage

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

>{Decimal}</Min>
108
                    <Max
Max

Maximum discount percentage

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

>{Decimal}</Max>
109
                    <Current
Current

Discount percent for calendar day

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

>{Decimal}</Current>
110
                    <NumberOfChanges
NumberOfChanges

Number of changes

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

>{Integer}</NumberOfChanges>
111
               </DiscountPercentage>
112
          </CalendarSummary>
113
     </RentalContractItem>
114
     <Paging
Paging

Detailed paging information for this list.

>
115
          <PageSize
PageSize

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

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

Position of the first element in the list

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

Page index

>{Integer}</Page>
118
          <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>
119
          <FirstPage
FirstPage

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

>{String}</FirstPage>
120
          <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>
121
          <PreviousPage
PreviousPage

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

>{String}</PreviousPage>
122
          <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>
123
          <NextPage
NextPage

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

>{String}</NextPage>
124
          <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>
125
          <LastPage
LastPage

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

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

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

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

Rental contract item identifier

": "{Integer}",
5
               "rentalContract": {
6
                    "rentalContractId
RentalContractId

Rental contract identifier

": "{Integer}",
7
                    "rentalContractLink
RentalContractLink

Rental contract reference

": "{String}"
8
               },
9
               "lineNumber
LineNumber

Line- or sequence number of the item

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

Date of item creation

": "{Datetime}",
11
               "rentalContractVersion": {
12
                    "rentalContractVersionId
RentalContractVersionId

Rental contract version identifier

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

Rental contract item version

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

Rental contract item revision

": "{Integer}",
15
                    "createdBy
CreatedBy

PID of the user who created the version

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

": {
16
                         "userId
UserId

User identifier

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

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

Name of the user

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

": "{String}",
18
                         "firstName
FirstName

First name of the user

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

": "{String}",
19
                         "userLink
UserLink

User reference

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

": "{String}"
20
                    },
21
                    "rentalContractVersionLink
RentalContractVersionLink

Rentlal contract version reference

": "{String}"
22
               },
23
               "rentalContractQuote": {
24
                    "rentalContractQuoteId
RentalContractQuoteId

Rental contract quote identifier

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

Quote name

": "{String}"
26
               },
27
               "isActive
IsActive

Indicates whether version is active one

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

Status with regard to the stage of the item

Possible domain values can be found here

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

Item type: 1- Subscription, 2 - Rental

Possible domain values can be found here

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

Note for contract item

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

Internal note for the contract item

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

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

": "{String}",
33
               "rateChangeType
RateChangeType

Change type of recurring rate (FIXED, MANUAL, AUTO). Defines if and how the recurring rate can be updated.

Possible domain values can be found here

": "{Integer}",
34
               "initialRentalContractItem": {
35
                    "rentalContractItemId
RentalContractItemId

Rental contract item identifier

": "{Integer}"
36
               },
37
               "product": {
38
                    "productId
ProductId

Product identifier

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

Name of the product

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

Type of product

Possible domain values can be found here

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

Description of the product

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

Product reference

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

Number of units ordered

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

The discount in percent for this item.

": "{Decimal}",
46
               "recurringRate": {
47
                    "recurringRateId
RecurringRateId

Recurring rate identifier

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

Status of recurring rate

Possible domain values can be found here

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

Three character code following the ISO 4217 standard

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

Interval of recurring rate

Possible domain values can be found here

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

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

Possible domain values can be found here

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

Number of rate steps

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

Recurring rate reference

": "{String}"
54
               },
55
               "currentRateStep": {
56
                    "currency
Currency

Three character code following the ISO 4217 standard

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

Value of step rate

": "{Decimal}"
58
               },
59
               "period": {
60
                    "effectiveDate
EffectiveDate

Start date for the recurring contract item

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

End date for the recurring contract item

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

Termination date of item

": "{Date}"
63
               },
64
               "onRentDays
OnRentDays

Number of on-rent days

": "{Integer}",
65
               "averageRatePerDay
AverageRatePerDay

Average rate per day

": "{Decimal}",
66
               "shippingAddress
ShippingAddress

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

": {
67
                    "addressId
AddressId

Address identifier

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

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

Address reference

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

": "{String}"
69
               },
70
               "shippingService
ShippingService

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

": {
71
                    "shippingServiceId
ShippingServiceId

Shipping service identifier

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

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

Shipping service reference

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

": "{String}"
73
               },
74
               "totals": {
75
                    "currency
Currency

Three character code following the ISO 4217 standard

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

Total amount

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

Total discount

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

Total amount after discount

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

Total accrued amount for contract item

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

Invoiced amount for contract item

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

Total forecasted revenue for contract item

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

Total earned revenue for contract item

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

Total deferred revenue of rental contract item

": "{Decimal}"
84
               },
85
               "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

": {
86
                    "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}",
87
                    "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}",
88
                    "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}",
89
                    "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}",
90
                    "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}",
91
                    "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}"
92
               },
93
               "calendarSummary
CalendarSummary

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

": {
94
                    "quantity
Quantity

Quantity change range from min to max

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

": {
95
                         "min
Min

Minimum quantity

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

": "{Integer}",
96
                         "max
Max

Maximum quantity

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

": "{Integer}",
97
                         "current
Current

Rental calendar day quantity

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

": "{Integer}",
98
                         "numberOfChanges
NumberOfChanges

Number of changes

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

": "{Integer}"
99
                    },
100
                    "recurringRate
RecurringRate

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

": {
101
                         "numberOfChanges
NumberOfChanges

Number of recurring rates used by rental contract item

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

": "{Integer}",
102
                         "currentRecurringRate
CurrentRecurringRate

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

": {
103
                              "recurringRateId
RecurringRateId

Recurring rate identifier

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

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

Recurring rate reference

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

": "{String}"
105
                         }
106
                    },
107
                    "discountPercentage
DiscountPercentage

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

": {
108
                         "min
Min

Minimum discount per centage

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

": "{Decimal}",
109
                         "max
Max

Maximum discount percentage

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

": "{Decimal}",
110
                         "current
Current

Discount percent for calendar day

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

": "{Decimal}",
111
                         "numberOfChanges
NumberOfChanges

Number of changes

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

": "{Integer}"
112
                    }
113
               }
114
          }
115
     ],
116
     "paging
Paging

Detailed paging information for this list.

": {
117
          "pageSize
PageSize

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

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

Position of the first element in the list

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

Page index

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

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

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

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

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

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

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

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

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

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

": "{Integer}"
129
     }
130
}

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 102738 HTTP 404 Price list not found
Error 100055 HTTP 403 You have only admittance to your own objects
Error 105970 HTTP 400 End date is required