API

Rental APIs

GET rental/contracts/{rentalContractId}/items/{itemId}

Get rental contract item

HTTP method GET
URI https://api.rambase.net/rental/contracts/{rentalContractId}/items/{itemId}
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {rentalContractId} Rental contract identifier
Integer, minimum 100000
- URI parameter {itemId} Rental contract item identifier
Integer, minimum 1
Custom fields Custom fields supported
Successful HTTP status code 200
API resource identifier 5769, version 50

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
$format String, optional Set the format of the response to use for the request. Accepted values are "xml", "html", "jsonstream", "json"
$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.
$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.
$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.
$showCustomFields Boolean, optional Set to "true" to include custom fields. Default value is false.

Read more about filters and sorting on how to use filter parameters and named filters.

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

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

Rental contract item identifier

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

Line- or sequence number of the item

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

Date of item creation

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

Rental contract version identifier

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

Rental contract item version

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

Rental contract item revision

>{Integer}</Revision>
9
          <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=RentalContractVersion.CreatedBy in your request URI to get this field

>
10
               <UserId
UserId

User identifier

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

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

Name of the user

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

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

First name of the user

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

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

User reference

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

>{String}</UserLink>
14
          </CreatedBy>
15
          <RentalContractVersionLink
RentalContractVersionLink

Rentlal contract version reference

>{String}</RentalContractVersionLink>
16
     </RentalContractVersion>
17
     <RentalContractQuote>
18
          <RentalContractQuoteId
RentalContractQuoteId

Rental contract quote identifier

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

Quote name

>{String}</Name>
20
     </RentalContractQuote>
21
     <IsActive
IsActive

Indicates whether version is active one

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

Status with regard to the stage of the item

Possible domain values can be found here

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

Item type: 1- Subscription, 2 - Rental

Possible domain values can be found here

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

Note for contract item

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

Internal note for the contract item

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

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

>{String}</CustomersReferenceNumber>
27
     <InitialRentalContractItem>
28
          <RentalContractItemId
RentalContractItemId

Rental contract item identifier

>{Integer}</RentalContractItemId>
29
     </InitialRentalContractItem>
30
     <VATPercent
VATPercent

Value added tax percent

>{Decimal}</VATPercent>
31
     <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>
32
     <Customer>
33
          <CustomerId
CustomerId

Customer identifier

>{Integer}</CustomerId>
34
          <CustomerLink
CustomerLink

Customer reference

>{String}</CustomerLink>
35
     </Customer>
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

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

>{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=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=ShippingAddress in your request URI to get this field

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

Name of receiver (Name of company or last name of a person). Note that default invoice address must have the same name as the customer.

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

>{String}</Name>
68
          <Firstname
Firstname

Firstname if the receiver is a person. Note that default invoice address must have the same firstname as the customer.

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

>{String}</Firstname>
69
          <AddressLine1
AddressLine1

First address line

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

>{String}</AddressLine1>
70
          <AddressLine2
AddressLine2

Second address line

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

>{String}</AddressLine2>
71
          <PostalCode
PostalCode

Postalcode/Postcode/ZIP

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

>{String}</PostalCode>
72
          <City
City

City/town/village

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

>{String}</City>
73
          <Region
Region

Region/province/state

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

>{String}</Region>
74
          <CountryCode
CountryCode

Two-character code (ISO 3166) identifying the country.

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

>{String}</CountryCode>
75
          <Country
Country

English name of country.

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

>{String}</Country>
76
          <AddressLink
AddressLink

Address reference

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

>{String}</AddressLink>
77
     </ShippingAddress>
78
     <ShippingService
ShippingService

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

>
79
          <ShippingServiceId
ShippingServiceId

Shipping service identifier

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

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

Shipping service reference

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

>{String}</ShippingServiceLink>
81
     </ShippingService>
82
     <Totals
Totals

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

>
83
          <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=Totals in your request URI to get this field

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

Total amount

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

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

Total discount

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

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

Total amount after discount

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

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

Total accrued amount for contract item

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

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

Invoiced amount for contract item

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

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

Total forecasted revenue for contract item

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

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

Total earned revenue for contract item

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

>{Decimal}</EarnedRevenue>
91
          <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=Totals in your request URI to get this field

>{Decimal}</DeferredRevenue>
92
     </Totals>
93
     <TotalsConverted
TotalsConverted

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

>
94
          <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=TotalsConverted in your request URI to get this field

>{String}</Currency>
95
          <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=TotalsConverted in your request URI to get this field

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

Total discount in local currency

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

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

Total amount in local currency after the discount

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

>{Decimal}</TotalNetAmount>
98
          <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=TotalsConverted in your request URI to get this field

>{Decimal}</AccruedRevenue>
99
          <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=TotalsConverted in your request URI to get this field

>{Decimal}</InvoicedAmount>
100
          <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=TotalsConverted in your request URI to get this field

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

Total earned revenue in local currency

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

>{Decimal}</EarnedRevenue>
102
          <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=TotalsConverted in your request URI to get this field

>{Decimal}</DeferredRevenue>
103
     </TotalsConverted>
104
     <Seller
Seller

Reference to the seller of the item

>
105
          <EmployeeId
EmployeeId

Employee identifier

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

First name of employee

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

Last name of employee

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

Employee reference

>{String}</EmployeeLink>
109
     </Seller>
110
     <Accounting
Accounting

Accounting details for the item, including fixed/system dimensions. For all dimensions, see seperate resource.

>
111
          <VATCodeDefinition>
112
               <VATCode
VATCode

Code that determines VAT rules used for VAT calculations.

>{String}</VATCode>
113
               <VATPercent
VATPercent

Value added tax percent

>{Decimal}</VATPercent>
114
          </VATCodeDefinition>
115
          <GeneralLedgerAccount>
116
               <GeneralLedgerAccountId
GeneralLedgerAccountId

General ledger account identifier

>{Integer}</GeneralLedgerAccountId>
117
               <GeneralLedgerAccountLink
GeneralLedgerAccountLink

General ledger account reference

>{String}</GeneralLedgerAccountLink>
118
          </GeneralLedgerAccount>
119
          <Department
Department

The department related to the item. One of the system/fixed account dimensions.

>
120
               <DepartmentId
DepartmentId

Department identifier

>{Integer}</DepartmentId>
121
               <DepartmentLink
DepartmentLink

Finance department reference

>{String}</DepartmentLink>
122
          </Department>
123
          <FinanceProject
FinanceProject

The finance project related to the item. One of the system/fixed account dimensions.

>
124
               <FinanceProjectId
FinanceProjectId

Finance project identifier

>{Integer}</FinanceProjectId>
125
               <FinanceProjectLink
FinanceProjectLink

Finance project reference

>{String}</FinanceProjectLink>
126
          </FinanceProject>
127
          <Asset
Asset

The asset related to the item. One of the system/fixed account dimensions.

>
128
               <AssetId
AssetId

Asset identifier

>{Integer}</AssetId>
129
               <AssetLink
AssetLink

Asset reference

>{String}</AssetLink>
130
          </Asset>
131
     </Accounting>
132
     <CalendarSummary
CalendarSummary

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

>
133
          <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=CalendarSummary in your request URI to get this field

>
134
               <Min
Min

Minimum quantity

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

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

Maximum quantity

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

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

Rental calendar day quantity

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

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

Number of changes

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

>{Integer}</NumberOfChanges>
138
          </Quantity>
139
          <RecurringRate
RecurringRate

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

>
140
               <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=CalendarSummary in your request URI to get this field

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

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

>
142
                    <RecurringRateId
RecurringRateId

Recurring rate identifier

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

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

Recurring rate reference

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

>{String}</RecurringRateLink>
144
               </CurrentRecurringRate>
145
          </RecurringRate>
146
          <DiscountPercentage
DiscountPercentage

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

>
147
               <Min
Min

Minimum discount per centage

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

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

Maximum discount percentage

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

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

Discount percent for calendar day

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

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

Number of changes

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

>{Integer}</NumberOfChanges>
151
          </DiscountPercentage>
152
     </CalendarSummary>
153
</RentalContractItem>
1
{
2
     "rentalContractItem": {
3
          "rentalContractItemId
RentalContractItemId

Rental contract item identifier

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

Line- or sequence number of the item

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

Date of item creation

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

Rental contract version identifier

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

Rental contract item version

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

Rental contract item revision

": "{Integer}",
10
               "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=RentalContractVersion.CreatedBy in your request URI to get this field

": {
11
                    "userId
UserId

User identifier

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

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

Name of the user

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

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

First name of the user

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

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

User reference

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

": "{String}"
15
               },
16
               "rentalContractVersionLink
RentalContractVersionLink

Rentlal contract version reference

": "{String}"
17
          },
18
          "rentalContractQuote": {
19
               "rentalContractQuoteId
RentalContractQuoteId

Rental contract quote identifier

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

Quote name

": "{String}"
21
          },
22
          "isActive
IsActive

Indicates whether version is active one

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

Status with regard to the stage of the item

Possible domain values can be found here

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

Item type: 1- Subscription, 2 - Rental

Possible domain values can be found here

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

Note for contract item

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

Internal note for the contract item

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

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

": "{String}",
28
          "initialRentalContractItem": {
29
               "rentalContractItemId
RentalContractItemId

Rental contract item identifier

": "{Integer}"
30
          },
31
          "vATPercent
VATPercent

Value added tax percent

": "{Decimal}",
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}",
33
          "customer": {
34
               "customerId
CustomerId

Customer identifier

": "{Integer}",
35
               "customerLink
CustomerLink

Customer reference

": "{String}"
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

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

": "{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=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=ShippingAddress in your request URI to get this field

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

Name of receiver (Name of company or last name of a person). Note that default invoice address must have the same name as the customer.

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

": "{String}",
69
               "firstname
Firstname

Firstname if the receiver is a person. Note that default invoice address must have the same firstname as the customer.

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

": "{String}",
70
               "addressLine1
AddressLine1

First address line

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

": "{String}",
71
               "addressLine2
AddressLine2

Second address line

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

": "{String}",
72
               "postalCode
PostalCode

Postalcode/Postcode/ZIP

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

": "{String}",
73
               "city
City

City/town/village

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

": "{String}",
74
               "region
Region

Region/province/state

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

": "{String}",
75
               "countryCode
CountryCode

Two-character code (ISO 3166) identifying the country.

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

": "{String}",
76
               "country
Country

English name of country.

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

": "{String}",
77
               "addressLink
AddressLink

Address reference

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

": "{String}"
78
          },
79
          "shippingService
ShippingService

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

": {
80
               "shippingServiceId
ShippingServiceId

Shipping service identifier

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

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

Shipping service reference

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

": "{String}"
82
          },
83
          "totals
Totals

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

": {
84
               "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=Totals in your request URI to get this field

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

Total amount

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

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

Total discount

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

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

Total amount after discount

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

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

Total accrued amount for contract item

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

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

Invoiced amount for contract item

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

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

Total forecasted revenue for contract item

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

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

Total earned revenue for contract item

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

": "{Decimal}",
92
               "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=Totals in your request URI to get this field

": "{Decimal}"
93
          },
94
          "totalsConverted
TotalsConverted

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

": {
95
               "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=TotalsConverted in your request URI to get this field

": "{String}",
96
               "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=TotalsConverted in your request URI to get this field

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

Total discount in local currency

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

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

Total amount in local currency after the discount

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

": "{Decimal}",
99
               "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=TotalsConverted in your request URI to get this field

": "{Decimal}",
100
               "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=TotalsConverted in your request URI to get this field

": "{Decimal}",
101
               "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=TotalsConverted in your request URI to get this field

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

Total earned revenue in local currency

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

": "{Decimal}",
103
               "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=TotalsConverted in your request URI to get this field

": "{Decimal}"
104
          },
105
          "seller
Seller

Reference to the seller of the item

": {
106
               "employeeId
EmployeeId

Employee identifier

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

First name of employee

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

Last name of employee

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

Employee reference

": "{String}"
110
          },
111
          "accounting
Accounting

Accounting details for the item, including fixed/system dimensions. For all dimensions, see seperate resource.

": {
112
               "vATCodeDefinition": {
113
                    "vATCode
VATCode

Code that determines VAT rules used for VAT calculations.

": "{String}",
114
                    "vATPercent
VATPercent

Value added tax percent

": "{Decimal}"
115
               },
116
               "generalLedgerAccount": {
117
                    "generalLedgerAccountId
GeneralLedgerAccountId

General ledger account identifier

": "{Integer}",
118
                    "generalLedgerAccountLink
GeneralLedgerAccountLink

General ledger account reference

": "{String}"
119
               },
120
               "department
Department

The department related to the item. One of the system/fixed account dimensions.

": {
121
                    "departmentId
DepartmentId

Department identifier

": "{Integer}",
122
                    "departmentLink
DepartmentLink

Finance department reference

": "{String}"
123
               },
124
               "financeProject
FinanceProject

The finance project related to the item. One of the system/fixed account dimensions.

": {
125
                    "financeProjectId
FinanceProjectId

Finance project identifier

": "{Integer}",
126
                    "financeProjectLink
FinanceProjectLink

Finance project reference

": "{String}"
127
               },
128
               "asset
Asset

The asset related to the item. One of the system/fixed account dimensions.

": {
129
                    "assetId
AssetId

Asset identifier

": "{Integer}",
130
                    "assetLink
AssetLink

Asset reference

": "{String}"
131
               }
132
          },
133
          "calendarSummary
CalendarSummary

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

": {
134
               "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=CalendarSummary in your request URI to get this field

": {
135
                    "min
Min

Minimum quantity

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

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

Maximum quantity

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

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

Rental calendar day quantity

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

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

Number of changes

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

": "{Integer}"
139
               },
140
               "recurringRate
RecurringRate

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

": {
141
                    "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=CalendarSummary in your request URI to get this field

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

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

": {
143
                         "recurringRateId
RecurringRateId

Recurring rate identifier

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

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

Recurring rate reference

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

": "{String}"
145
                    }
146
               },
147
               "discountPercentage
DiscountPercentage

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

": {
148
                    "min
Min

Minimum discount per centage

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

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

Maximum discount percentage

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

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

Discount percent for calendar day

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

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

Number of changes

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

": "{Integer}"
152
               }
153
          }
154
     }
155
}

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 100001 HTTP 404 Address not found