API

Rental APIs

POST rental/contracts/{rentalContractId}/items

Append rental contract item

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

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

Required/mandatory field

Number of units ordered

Minimum value: 1

>{Integer}</Quantity>
3
     <RequestedDeliveryDate
RequestedDeliveryDate

The date the customer would like to have the rental unit at their site

This field is optional.

>{Date}</RequestedDeliveryDate>
4
     <ConfirmedDeliveryDate
ConfirmedDeliveryDate

The confirmed date that the customer will have the rental unit at their site

This field is optional.

>{Date}</ConfirmedDeliveryDate>
5
     <Period
Period

This field is optional.

>
6
          <EffectiveDate
EffectiveDate

Start date for the recurring contract item

This field is optional.

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

End date for the recurring contract item

This field is optional.

>{Date}</ExpirationDate>
8
     </Period>
9
     <RecurringRate
RecurringRate

This field is optional.

>
10
          <RecurringRateId
RecurringRateId

Recurring rate identifier

Minimum value: 100000

This field is optional.

>{Integer}</RecurringRateId>
11
     </RecurringRate>
12
     <Product
Product

This field is optional.

>
13
          <ProductId
ProductId

Product identifier

Minimum value: 10000

This field is optional.

>{Integer}</ProductId>
14
     </Product>
15
</RentalContractItem>
1
{
2
     "rentalContractItem": {
3
          "quantity
Quantity

Required/mandatory field

Number of units ordered

Minimum value: 1

": "{Integer}",
4
          "requestedDeliveryDate
RequestedDeliveryDate

The date the customer would like to have the rental unit at their site

This field is optional.

": "{Date}",
5
          "confirmedDeliveryDate
ConfirmedDeliveryDate

The confirmed date that the customer will have the rental unit at their site

This field is optional.

": "{Date}",
6
          "period
Period

This field is optional.

": {
7
               "effectiveDate
EffectiveDate

Start date for the recurring contract item

This field is optional.

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

End date for the recurring contract item

This field is optional.

": "{Date}"
9
          },
10
          "recurringRate
RecurringRate

This field is optional.

": {
11
               "recurringRateId
RecurringRateId

Recurring rate identifier

Minimum value: 100000

This field is optional.

": "{Integer}"
12
          },
13
          "product
Product

This field is optional.

": {
14
               "productId
ProductId

Product identifier

Minimum value: 10000

This field is optional.

": "{Integer}"
15
          }
16
     }
17
}

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.

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

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

>
9
               <UserId
UserId

User identifier

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

Name of the user

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

First name of the user

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

User reference

>{String}</UserLink>
13
          </Revision>
14
          <RentalContractVersionLink
RentalContractVersionLink

Rentlal contract version reference

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

Rental contract quote identifier

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

Quote name

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

Indicates whether version is active one

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

Status with regard to the stage of the item

Possible domain values can be found here

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

Item type: 1- Subscription, 2 - Rental

Possible domain values can be found here

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

Note for contract item

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

Internal note for the contract item

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

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

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

Rental contract item identifier

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

Value added tax percent

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

Customer identifier

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

Customer reference

>{String}</CustomerLink>
34
     </Customer>
35
     <Product>
36
          <ProductId
ProductId

Product identifier

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

Name of the product

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

Type of product

Possible domain values can be found here

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

Description of the product

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

Product reference

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

Number of units ordered

>{Integer}</Quantity>
43
     <RemainingQuantity
RemainingQuantity

Quantity of rental units that haven't been shipped yet

>{Integer}</RemainingQuantity>
44
     <RequestedDeliveryDate
RequestedDeliveryDate

The date the customer would like to have the rental unit at their site

>{Date}</RequestedDeliveryDate>
45
     <ConfirmedDeliveryDate
ConfirmedDeliveryDate

The confirmed date that the customer will have the rental unit at their site

>{Date}</ConfirmedDeliveryDate>
46
     <DiscountPercent
DiscountPercent

The discount in percent for this item.

>{Decimal}</DiscountPercent>
47
     <RecurringRate>
48
          <RecurringRateId
RecurringRateId

Recurring rate identifier

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

Status of recurring rate

Possible domain values can be found here

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

Three character code following the ISO 4217 standard

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

Interval of recurring rate

Possible domain values can be found here

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

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

Possible domain values can be found here

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

Number of rate steps

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

Recurring rate reference

>{String}</RecurringRateLink>
55
     </RecurringRate>
56
     <CurrentRateStep>
57
          <Currency
Currency

Three character code following the ISO 4217 standard

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

Value of step rate

>{Decimal}</Rate>
59
     </CurrentRateStep>
60
     <Period>
61
          <EffectiveDate
EffectiveDate

Start date for the recurring contract item

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

End date for the recurring contract item

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

Termination date of item

>{Date}</TerminationDate>
64
     </Period>
65
     <AverageRatePerDay
AverageRatePerDay

Average rate per day

>
66
          <ExpectedDate
ExpectedDate

Expected check-out date (shipment)

>{Date}</ExpectedDate>
67
          <CheckOutStatus
CheckOutStatus

Status of item shipping

Possible domain values can be found here

>{Integer}</CheckOutStatus>
68
          <Location>
69
               <LocationId
LocationId

Location identifier

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

Unique abbreviation/short name of the location

>{String}</ShortName>
71
               <Address>
72
                    <CountryCode
CountryCode

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

>{String}</CountryCode>
73
               </Address>
74
               <LocationLink
LocationLink

Location reference

>{String}</LocationLink>
75
          </Location>
76
          <ExpectedDate
ExpectedDate

Expected check-in date (return)

>{Date}</ExpectedDate>
77
          <Location>
78
               <LocationId
LocationId

Location identifier

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

Unique abbreviation/short name of the location

>{String}</ShortName>
80
               <Address>
81
                    <CountryCode
CountryCode

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

>{String}</CountryCode>
82
               </Address>
83
               <LocationLink
LocationLink

Location reference

>{String}</LocationLink>
84
          </Location>
85
          <AddressId
AddressId

Address identifier

>{Integer}</AddressId>
86
          <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.

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

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

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

First address line

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

Second address line

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

Postalcode/Postcode/ZIP

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

City/town/village

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

Region/province/state

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

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

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

English name of country.

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

Address reference

>{String}</AddressLink>
96
          <ShippingServiceId
ShippingServiceId

Shipping service identifier

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

Shipping service reference

>{String}</ShippingServiceLink>
98
          <Currency
Currency

Three character code following the ISO 4217 standard

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

Total amount

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

Total discount

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

Total amount after discount

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

Total accrued amount for contract item

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

Invoiced amount for contract item

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

Total forecasted revenue for contract item

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

Total earned revenue for contract item

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

Total deferred revenue of rental contract item

>{Decimal}</DeferredRevenue>
107
          <Currency
Currency

Three character code following the ISO 4217 standard

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

Total amount for contract item in company currency

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

Total discount in local currency

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

Total amount in local currency after the discount

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

Total accrued revenue for contract item in company currency.

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

Invoiced amount for contract item in company currency.

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

Total forecasted revenue for contract item in company currency.

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

Total earned revenue in local currency

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

Total deferred revenue for rental contract item in company currency.

>{Decimal}</DeferredRevenue>
116
     </AverageRatePerDay>
117
     <Seller
Seller

Reference to the seller of the item

>
118
          <EmployeeId
EmployeeId

Employee identifier

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

First name of employee

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

Last name of employee

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

Employee reference

>{String}</EmployeeLink>
122
     </Seller>
123
     <Accounting
Accounting

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

>
124
          <VATCodeDefinition>
125
               <VATCode
VATCode

Code that determines VAT rules used for VAT calculations.

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

Value added tax percent

>{Decimal}</VATPercent>
127
          </VATCodeDefinition>
128
          <GeneralLedgerAccount>
129
               <GeneralLedgerAccountId
GeneralLedgerAccountId

General ledger account identifier

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

General ledger account reference

>{String}</GeneralLedgerAccountLink>
131
          </GeneralLedgerAccount>
132
          <Department
Department

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

>
133
               <DepartmentId
DepartmentId

Department identifier

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

Finance department reference

>{String}</DepartmentLink>
135
          </Department>
136
          <FinanceProject
FinanceProject

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

>
137
               <FinanceProjectId
FinanceProjectId

Finance project identifier

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

Finance project reference

>{String}</FinanceProjectLink>
139
          </FinanceProject>
140
          <Asset
Asset

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

>
141
               <AssetId
AssetId

Asset identifier

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

Asset reference

>{String}</AssetLink>
143
          </Asset>
144
          <Quantity
Quantity

Quantity change range from min to max

>
145
               <Min
Min

Minimum quantity

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

Maximum quantity

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

Rental calendar day quantity

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

Number of changes

>{Integer}</NumberOfChanges>
149
          </Quantity>
150
          <RecurringRate>
151
               <NumberOfChanges
NumberOfChanges

Number of recurring rates used by rental contract item

>{Integer}</NumberOfChanges>
152
               <CurrentRecurringRate>
153
                    <RecurringRateId
RecurringRateId

Recurring rate identifier

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

Recurring rate reference

>{String}</RecurringRateLink>
155
               </CurrentRecurringRate>
156
          </RecurringRate>
157
          <DiscountPercentage>
158
               <Min
Min

Minimum discount per centage

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

Maximum discount percentage

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

Discount percent for calendar day

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

Number of changes

>{Integer}</NumberOfChanges>
162
          </DiscountPercentage>
163
     </Accounting>
164
</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

": {
10
                    "userId
UserId

User identifier

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

Name of the user

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

First name of the user

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

User reference

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

Rentlal contract version reference

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

Rental contract quote identifier

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

Quote name

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

Indicates whether version is active one

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

Status with regard to the stage of the item

Possible domain values can be found here

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

Item type: 1- Subscription, 2 - Rental

Possible domain values can be found here

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

Note for contract item

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

Internal note for the contract item

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

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

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

Rental contract item identifier

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

Value added tax percent

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

Customer identifier

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

Customer reference

": "{String}"
35
          },
36
          "product": {
37
               "productId
ProductId

Product identifier

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

Name of the product

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

Type of product

Possible domain values can be found here

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

Description of the product

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

Product reference

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

Number of units ordered

": "{Integer}",
44
          "remainingQuantity
RemainingQuantity

Quantity of rental units that haven't been shipped yet

": "{Integer}",
45
          "requestedDeliveryDate
RequestedDeliveryDate

The date the customer would like to have the rental unit at their site

": "{Date}",
46
          "confirmedDeliveryDate
ConfirmedDeliveryDate

The confirmed date that the customer will have the rental unit at their site

": "{Date}",
47
          "discountPercent
DiscountPercent

The discount in percent for this item.

": "{Decimal}",
48
          "recurringRate": {
49
               "recurringRateId
RecurringRateId

Recurring rate identifier

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

Status of recurring rate

Possible domain values can be found here

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

Three character code following the ISO 4217 standard

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

Interval of recurring rate

Possible domain values can be found here

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

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

Possible domain values can be found here

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

Number of rate steps

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

Recurring rate reference

": "{String}"
56
          },
57
          "currentRateStep": {
58
               "currency
Currency

Three character code following the ISO 4217 standard

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

Value of step rate

": "{Decimal}"
60
          },
61
          "period": {
62
               "effectiveDate
EffectiveDate

Start date for the recurring contract item

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

End date for the recurring contract item

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

Termination date of item

": "{Date}"
65
          },
66
          "averageRatePerDay
AverageRatePerDay

Average rate per day

": {
67
               "expectedDate
ExpectedDate

Expected check-out date (shipment)

": "{Date}",
68
               "checkOutStatus
CheckOutStatus

Status of item shipping

Possible domain values can be found here

": "{Integer}",
69
               "location": {
70
                    "locationId
LocationId

Location identifier

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

Unique abbreviation/short name of the location

": "{String}",
72
                    "address": {
73
                         "countryCode
CountryCode

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

": "{String}"
74
                    },
75
                    "locationLink
LocationLink

Location reference

": "{String}"
76
               },
77
               "expectedDate
ExpectedDate

Expected check-in date (return)

": "{Date}",
78
               "location": {
79
                    "locationId
LocationId

Location identifier

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

Unique abbreviation/short name of the location

": "{String}",
81
                    "address": {
82
                         "countryCode
CountryCode

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

": "{String}"
83
                    },
84
                    "locationLink
LocationLink

Location reference

": "{String}"
85
               },
86
               "addressId
AddressId

Address identifier

": "{Integer}",
87
               "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.

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

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

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

First address line

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

Second address line

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

Postalcode/Postcode/ZIP

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

City/town/village

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

Region/province/state

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

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

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

English name of country.

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

Address reference

": "{String}",
97
               "shippingServiceId
ShippingServiceId

Shipping service identifier

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

Shipping service reference

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

Three character code following the ISO 4217 standard

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

Total amount

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

Total discount

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

Total amount after discount

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

Total accrued amount for contract item

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

Invoiced amount for contract item

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

Total forecasted revenue for contract item

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

Total earned revenue for contract item

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

Total deferred revenue of rental contract item

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

Three character code following the ISO 4217 standard

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

Total amount for contract item in company currency

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

Total discount in local currency

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

Total amount in local currency after the discount

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

Total accrued revenue for contract item in company currency.

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

Invoiced amount for contract item in company currency.

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

Total forecasted revenue for contract item in company currency.

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

Total earned revenue in local currency

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

Total deferred revenue for rental contract item in company currency.

": "{Decimal}"
117
          },
118
          "seller
Seller

Reference to the seller of the item

": {
119
               "employeeId
EmployeeId

Employee identifier

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

First name of employee

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

Last name of employee

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

Employee reference

": "{String}"
123
          },
124
          "accounting
Accounting

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

": {
125
               "vATCodeDefinition": {
126
                    "vATCode
VATCode

Code that determines VAT rules used for VAT calculations.

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

Value added tax percent

": "{Decimal}"
128
               },
129
               "generalLedgerAccount": {
130
                    "generalLedgerAccountId
GeneralLedgerAccountId

General ledger account identifier

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

General ledger account reference

": "{String}"
132
               },
133
               "department
Department

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

": {
134
                    "departmentId
DepartmentId

Department identifier

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

Finance department reference

": "{String}"
136
               },
137
               "financeProject
FinanceProject

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

": {
138
                    "financeProjectId
FinanceProjectId

Finance project identifier

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

Finance project reference

": "{String}"
140
               },
141
               "asset
Asset

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

": {
142
                    "assetId
AssetId

Asset identifier

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

Asset reference

": "{String}"
144
               },
145
               "quantity
Quantity

Quantity change range from min to max

": {
146
                    "min
Min

Minimum quantity

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

Maximum quantity

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

Rental calendar day quantity

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

Number of changes

": "{Integer}"
150
               },
151
               "recurringRate": {
152
                    "numberOfChanges
NumberOfChanges

Number of recurring rates used by rental contract item

": "{Integer}",
153
                    "currentRecurringRate": {
154
                         "recurringRateId
RecurringRateId

Recurring rate identifier

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

Recurring rate reference

": "{String}"
156
                    }
157
               },
158
               "discountPercentage": {
159
                    "min
Min

Minimum discount per centage

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

Maximum discount percentage

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

Discount percent for calendar day

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

Number of changes

": "{Integer}"
163
               }
164
          }
165
     }
166
}

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 101013 HTTP 404 Sub-module not found
Error 102018 HTTP 403 You need permission {0}. Duties with this permission: {1}
Error 105970 HTTP 400 End date is required
Error 107154 HTTP 400 Start date is required
Error 107155 HTTP 400 End date is required
Error 107156 HTTP 400 End date must be later than start date
Error 107177 HTTP 400 Rental unit not defined
Error 107159 HTTP 400 Rental unit is locked and thus cannot be changed
Error 107223 HTTP 400 Number of maintenance days must not be negative
Error 108674 HTTP 400 Termination date cannot be earlier then the effective date
Error 108675 HTTP 400 Termination date cannot be later then the expiration date
Error 108672 HTTP 400 Closing date cannot be earlier then the effective date
Error 108673 HTTP 400 Closing date cannot be later then the expiration date
Error 108969 HTTP 400 The selected default check-out location ({0}) is not active
Error 108970 HTTP 400 The selected default check-out location ({0}) is not a rental depot capable location
Error 108971 HTTP 400 The selected default check-in location ({0}) is not active
Error 108972 HTTP 400 The selected default check-in location ({0}) is not a rental depot capable location
Error 105743 HTTP 400 Start date is required
Error 104971 HTTP 400 The start date cannot be later than the end date
Error 103491 HTTP 400 Invalid expiration date
Error 108679 HTTP 400 Expected check-in date cannot be earlier then expected check-out date
Error 108262 HTTP 404 Recurring rate not found
Error 108691 HTTP 400 Recurring rate is not active
Error 108018 HTTP 400 Currency mismatch
Error 108016 HTTP 400 Product id mismatch
Error 108824 HTTP 400 Cannot apply recurring rate as it is not valid for selected period
Error 108671 HTTP 400 The effective date cannot be changed because earlier days have already been invoiced
Error 108684 HTTP 400 The expiration date cannot be changed because later days have already been invoiced
Error 108683 HTTP 400 Termination date must be earlier then the expiration date
Error 107278 HTTP 400 No available rental unit found for specified product and date range