API

Rental APIs

POST rental/contracts

Creation of new rental contract

HTTP method POST
URI https://api.rambase.net/rental/contracts
Supported formats Xml, Html, Json (ex. $format=json)
Custom fields Custom fields supported
Successful HTTP status code 201
API resource identifier 5759, version 8

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
<RentalContract>
2
     <Name
Name

Required/mandatory field

Short description for the rental contract

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

Detailed description for the recurring rental contract

This field is optional.

>{String}</Description>
4
     <Currency
Currency

Required/mandatory field

Three character code following the ISO 4217 standard

Applicable domain values can be found here

>{String}</Currency>
5
     <RentalType
RentalType

Type of contract: Subscription, Rent-to-Rent, Rent-to-Purchase, Customer owned, Re-rent

Applicable domain values can be found here

This field is optional.

>{Integer}</RentalType>
6
     <InvoiceFrequency
InvoiceFrequency

Sets frequency at which invoice can be issued.

Applicable domain values can be found here

This field is optional.

>{Integer}</InvoiceFrequency>
7
     <BaseDate
BaseDate

A date from which invoices will start to be generated from

This field is optional.

>{Date}</BaseDate>
8
     <IsAutomaticallyIssued
IsAutomaticallyIssued

"True" if invoices in this rental contract should be released automatically

Default value: False

This field is optional.

>{Boolean}</IsAutomaticallyIssued>
9
     <AdvanceInvoicing
AdvanceInvoicing

This field is optional.

>
10
          <IsInvoicedInAdvance
IsInvoicedInAdvance

True if rental contract is invoiced in advance

Default value: False

This field is optional.

>{Boolean}</IsInvoicedInAdvance>
11
          <BaseDateAdvanceDays
BaseDateAdvanceDays

Number of days to advance invoicing from base date

Minimum value: 0

This field is optional.

>{Integer}</BaseDateAdvanceDays>
12
     </AdvanceInvoicing>
13
     <Period
Period

This field is optional.

>
14
          <EffectiveDate
EffectiveDate

Start date for the recurring contract

This field is optional.

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

End date of the recurring contract

This field is optional.

>{Date}</ExpirationDate>
16
     </Period>
17
     <Customer>
18
          <CustomerId
CustomerId

Required/mandatory field

Customer identifier

Minimum value: 10000

>{Integer}</CustomerId>
19
     </Customer>
20
     <Responsible
Responsible

PID reference of sales assistant for the contract

This field is optional.

>
21
          <UserId
UserId

User identifier

Minimum value: 100

This field is optional.

>{Integer}</UserId>
22
     </Responsible>
23
     <InvoiceAddress
InvoiceAddress

This field is optional.

>
24
          <AddressId
AddressId

Reference to customer's invoice address

Minimum value: 1

This field is optional.

>{Integer}</AddressId>
25
     </InvoiceAddress>
26
     <ShippingAddress
ShippingAddress

This field is optional.

>
27
          <AddressId
AddressId

Reference to customer's shipping address

Minimum value: 1

This field is optional.

>{Integer}</AddressId>
28
     </ShippingAddress>
29
     <Payment
Payment

This field is optional.

>
30
          <PaymentTerms
PaymentTerms

Payment terms for rental contract

Applicable domain values can be found here

This field is optional.

>{String}</PaymentTerms>
31
     </Payment>
32
     <VATDetails
VATDetails

This field is optional.

>
33
          <VATHandling
VATHandling

Specifies how value added tax (VAT) should be calculated. Either always include VAT, always exclude VAT or use standard/default VAT rules.

Applicable domain values can be found here

This field is optional.

>{String}</VATHandling>
34
     </VATDetails>
35
</RentalContract>
1
{
2
     "rentalContract": {
3
          "name
Name

Required/mandatory field

Short description for the rental contract

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

Detailed description for the recurring rental contract

This field is optional.

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

Required/mandatory field

Three character code following the ISO 4217 standard

Applicable domain values can be found here

": "{String}",
6
          "rentalType
RentalType

Type of contract: Subscription, Rent-to-Rent, Rent-to-Purchase, Customer owned, Re-rent

Applicable domain values can be found here

This field is optional.

": "{Integer}",
7
          "invoiceFrequency
InvoiceFrequency

Sets frequency at which invoice can be issued.

Applicable domain values can be found here

This field is optional.

": "{Integer}",
8
          "baseDate
BaseDate

A date from which invoices will start to be generated from

This field is optional.

": "{Date}",
9
          "isAutomaticallyIssued
IsAutomaticallyIssued

"True" if invoices in this rental contract should be released automatically

Default value: False

This field is optional.

": "{Boolean}",
10
          "advanceInvoicing
AdvanceInvoicing

This field is optional.

": {
11
               "isInvoicedInAdvance
IsInvoicedInAdvance

True if rental contract is invoiced in advance

Default value: False

This field is optional.

": "{Boolean}",
12
               "baseDateAdvanceDays
BaseDateAdvanceDays

Number of days to advance invoicing from base date

Minimum value: 0

This field is optional.

": "{Integer}"
13
          },
14
          "period
Period

This field is optional.

": {
15
               "effectiveDate
EffectiveDate

Start date for the recurring contract

This field is optional.

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

End date of the recurring contract

This field is optional.

": "{Date}"
17
          },
18
          "customer": {
19
               "customerId
CustomerId

Required/mandatory field

Customer identifier

Minimum value: 10000

": "{Integer}"
20
          },
21
          "responsible
Responsible

PID reference of sales assistant for the contract

This field is optional.

": {
22
               "userId
UserId

User identifier

Minimum value: 100

This field is optional.

": "{Integer}"
23
          },
24
          "invoiceAddress
InvoiceAddress

This field is optional.

": {
25
               "addressId
AddressId

Reference to customer's invoice address

Minimum value: 1

This field is optional.

": "{Integer}"
26
          },
27
          "shippingAddress
ShippingAddress

This field is optional.

": {
28
               "addressId
AddressId

Reference to customer's shipping address

Minimum value: 1

This field is optional.

": "{Integer}"
29
          },
30
          "payment
Payment

This field is optional.

": {
31
               "paymentTerms
PaymentTerms

Payment terms for rental contract

Applicable domain values can be found here

This field is optional.

": "{String}"
32
          },
33
          "vATDetails
VATDetails

This field is optional.

": {
34
               "vATHandling
VATHandling

Specifies how value added tax (VAT) should be calculated. Either always include VAT, always exclude VAT or use standard/default VAT rules.

Applicable domain values can be found here

This field is optional.

": "{String}"
35
          }
36
     }
37
}

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
<RentalContract>
2
     <RentalContractId
RentalContractId

Rental contract identifier

>{Integer}</RentalContractId>
3
     <Status
Status

Rental contract status

Possible domain values can be found here

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

Date and time of creation

>{Datetime}</CreatedAt>
5
     <Name
Name

Short description for the rental contract

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

Detailed description for the recurring rental contract

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

Three character code following the ISO 4217 standard

Possible domain values can be found here

>{String}</Currency>
8
     <CustomersReference
CustomersReference

Customers reference. Typically a person.

>{String}</CustomersReference>
9
     <CustomersReferenceNumber
CustomersReferenceNumber

Customers reference number. E.g. the internal sales order id the customer use in their own system.

>{String}</CustomersReferenceNumber>
10
     <RentalType
RentalType

Type of contract: Subscription, Rent-to-Rent, Rent-to-Purchase, Customer owned, Re-rent

Possible domain values can be found here

>{Integer}</RentalType>
11
     <InvoiceFrequency
InvoiceFrequency

Sets frequency at which invoice can be issued.

Possible domain values can be found here

>{Integer}</InvoiceFrequency>
12
     <BaseDate
BaseDate

A date from which invoices will start to be generated from

>{Date}</BaseDate>
13
     <IsAutomaticallyIssued
IsAutomaticallyIssued

"True" if invoices in this rental contract should be released automatically

>{Boolean}</IsAutomaticallyIssued>
14
     <ShippingAddressAttention
ShippingAddressAttention

Attention of the shipping address. When changing shipping address, the ShippingAddressAttention will be overridden by the attention of the new shipping address.

>{String}</ShippingAddressAttention>
15
     <ShippingAddressPhone
ShippingAddressPhone

Phone number of the shipping address. When changing shipping address, the ShippingAddressPhone will be overridden by the phone number of the new shipping address.

>{String}</ShippingAddressPhone>
16
     <ShippingAddressEmail
ShippingAddressEmail

Email address of the shipping address. When changing shipping address, the ShippingAddressEmail will be overridden by the email of the new shipping address.

>{String}</ShippingAddressEmail>
17
     <InvoiceAddressAttention
InvoiceAddressAttention

Attention of the invoice address. When changing invoice address, the InvoiceAddressAttention will be overridden by the attention of the new invoice address.

>{String}</InvoiceAddressAttention>
18
     <AdvanceInvoicing>
19
          <IsInvoicedInAdvance
IsInvoicedInAdvance

True if rental contract is invoiced in advance

>{Boolean}</IsInvoicedInAdvance>
20
          <BaseDateAdvanceDays
BaseDateAdvanceDays

Number of days to advance invoicing from base date

>{Integer}</BaseDateAdvanceDays>
21
     </AdvanceInvoicing>
22
     <Period>
23
          <EffectiveDate
EffectiveDate

Start date for the recurring contract

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

End date of the recurring contract

>{Date}</ExpirationDate>
25
          <RegistrationDate
RegistrationDate

The date of registration of the contract

>{Date}</RegistrationDate>
26
          <TerminationDate
TerminationDate

The date of termination of the contract

>{Date}</TerminationDate>
27
          <ClosingDate
ClosingDate

The date after the final invoicing, and all logistics handled. The contract is sealed and cannot be changed

>{Date}</ClosingDate>
28
     </Period>
29
     <Customer>
30
          <CustomerId
CustomerId

Customer identifier

>{Integer}</CustomerId>
31
          <Name
Name

Name of customer (name of company or surname/familyname/lastname of a person)

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

Secondary name of a company or firstname of a person

>{String}</FirstName>
33
          <CustomerLink
CustomerLink

Customer reference

>{String}</CustomerLink>
34
     </Customer>
35
     <InvoiceAddress>
36
          <AddressId
AddressId

Reference to customer's invoice address

>{Integer}</AddressId>
37
          <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>
38
          <FirstName
FirstName

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

>{String}</FirstName>
39
          <AddressLine1
AddressLine1

First address line

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

Second address line

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

Postalcode/Postcode/ZIP

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

City/town/village

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

Region/province/state

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

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

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

English name of country.

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

Address reference

>{String}</AddressLink>
47
     </InvoiceAddress>
48
     <ShippingAddress>
49
          <AddressId
AddressId

Reference to customer's shipping address

>{Integer}</AddressId>
50
          <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>
51
          <FirstName
FirstName

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

>{String}</FirstName>
52
          <AddressLine1
AddressLine1

First address line

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

Second address line

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

Postalcode/Postcode/ZIP

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

City/town/village

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

Region/province/state

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

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

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

English name of country.

>{String}</Country>
59
          <ExternalReference
ExternalReference

External address identifier. Normally defined by the customer.

>{String}</ExternalReference>
60
          <AddressLink
AddressLink

Address reference

>{String}</AddressLink>
61
     </ShippingAddress>
62
     <Responsible
Responsible

PID reference of sales assistant for the contract

>
63
          <UserId
UserId

User identifier

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

Name of the user

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

First name of the user

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

User reference

>{String}</UserLink>
67
     </Responsible>
68
     <Assignee
Assignee

PID reference of sales assistant for the contract

>
69
          <UserId
UserId

User identifier

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

Name of the user

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

First name of the user

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

User reference

>{String}</UserLink>
73
     </Assignee>
74
     <AccountManager
AccountManager

PID reference of sales assistant for the contract

>
75
          <UserId
UserId

User identifier

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

Name of the user

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

First name of the user

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

User reference

>{String}</UserLink>
79
     </AccountManager>
80
     <Payment>
81
          <PaymentTerms
PaymentTerms

Payment terms for rental contract

Possible domain values can be found here

>{String}</PaymentTerms>
82
     </Payment>
83
     <VATDetails>
84
          <VATHandling
VATHandling

Specifies how value added tax (VAT) should be calculated. Either always include VAT, always exclude VAT or use standard/default VAT rules.

Possible domain values can be found here

>{String}</VATHandling>
85
     </VATDetails>
86
     <Location>
87
          <LocationId
LocationId

Location identifier

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

Unique abbreviation/short name of the location

>{String}</ShortName>
89
          <Address>
90
               <CountryCode
CountryCode

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

>{String}</CountryCode>
91
          </Address>
92
          <LocationLink
LocationLink

Location reference

>{String}</LocationLink>
93
     </Location>
94
     <Shipment>
95
          <DeliveryTerms
DeliveryTerms

Delivery terms when shipping the goods. The delivery terms is based on the Incoterms rules from ICC (International Chamber of Commerce). The delivery terms is by default retrieved from the customer.

Possible domain values can be found here

>{String}</DeliveryTerms>
96
          <DeliveryTermPlace
DeliveryTermPlace

Named place related to delivery terms (Incoterms)

>{String}</DeliveryTermPlace>
97
          <ShippingService>
98
               <ShippingServiceId
ShippingServiceId

Shipping service identifier

>{Integer}</ShippingServiceId>
99
               <Name
Name

Name of shipping service

>{String}</Name>
100
               <Carrier>
101
                    <CarrierId
CarrierId

Carrier identifier

>{Integer}</CarrierId>
102
                    <CarrierLink
CarrierLink

Carrier reference

>{String}</CarrierLink>
103
               </Carrier>
104
               <ShippingServiceLink
ShippingServiceLink

Shipping service reference

>{String}</ShippingServiceLink>
105
          </ShippingService>
106
     </Shipment>
107
     <Totals>
108
          <Currency
Currency

Three character code following the ISO 4217 standard

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

Total amount estimated per rental contract

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

Accumulated value of total discount

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

Accumulated sum of total amounts after the discounts

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

Accumulated value of accrued amounts

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

Accumulated value of invoiced amounts

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

Accumulated value of forecasted amounts

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

Accumulated value of earned revenue of all contract items

>{Decimal}</EarnedRevenue>
116
          <CountOfQuotes
CountOfQuotes

Count of items in stage quote

>{Integer}</CountOfQuotes>
117
          <Currency
Currency

Three character code following the ISO 4217 standard

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

Total amount estimated per rental contract

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

Accumulated value of total discount

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

Accumulated sum of total amounts after the discounts

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

Accumulated value of accrued amounts

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

Accumulated value of invoiced amounts

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

Accumulated value of forecasted amounts

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

Accumulated value of earned revenue of all contract items

>{Decimal}</EarnedRevenue>
125
     </Totals>
126
</RentalContract>
1
{
2
     "rentalContract": {
3
          "rentalContractId
RentalContractId

Rental contract identifier

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

Rental contract status

Possible domain values can be found here

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

Date and time of creation

": "{Datetime}",
6
          "name
Name

Short description for the rental contract

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

Detailed description for the recurring rental contract

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

Three character code following the ISO 4217 standard

Possible domain values can be found here

": "{String}",
9
          "customersReference
CustomersReference

Customers reference. Typically a person.

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

Customers reference number. E.g. the internal sales order id the customer use in their own system.

": "{String}",
11
          "rentalType
RentalType

Type of contract: Subscription, Rent-to-Rent, Rent-to-Purchase, Customer owned, Re-rent

Possible domain values can be found here

": "{Integer}",
12
          "invoiceFrequency
InvoiceFrequency

Sets frequency at which invoice can be issued.

Possible domain values can be found here

": "{Integer}",
13
          "baseDate
BaseDate

A date from which invoices will start to be generated from

": "{Date}",
14
          "isAutomaticallyIssued
IsAutomaticallyIssued

"True" if invoices in this rental contract should be released automatically

": "{Boolean}",
15
          "shippingAddressAttention
ShippingAddressAttention

Attention of the shipping address. When changing shipping address, the ShippingAddressAttention will be overridden by the attention of the new shipping address.

": "{String}",
16
          "shippingAddressPhone
ShippingAddressPhone

Phone number of the shipping address. When changing shipping address, the ShippingAddressPhone will be overridden by the phone number of the new shipping address.

": "{String}",
17
          "shippingAddressEmail
ShippingAddressEmail

Email address of the shipping address. When changing shipping address, the ShippingAddressEmail will be overridden by the email of the new shipping address.

": "{String}",
18
          "invoiceAddressAttention
InvoiceAddressAttention

Attention of the invoice address. When changing invoice address, the InvoiceAddressAttention will be overridden by the attention of the new invoice address.

": "{String}",
19
          "advanceInvoicing": {
20
               "isInvoicedInAdvance
IsInvoicedInAdvance

True if rental contract is invoiced in advance

": "{Boolean}",
21
               "baseDateAdvanceDays
BaseDateAdvanceDays

Number of days to advance invoicing from base date

": "{Integer}"
22
          },
23
          "period": {
24
               "effectiveDate
EffectiveDate

Start date for the recurring contract

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

End date of the recurring contract

": "{Date}",
26
               "registrationDate
RegistrationDate

The date of registration of the contract

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

The date of termination of the contract

": "{Date}",
28
               "closingDate
ClosingDate

The date after the final invoicing, and all logistics handled. The contract is sealed and cannot be changed

": "{Date}"
29
          },
30
          "customer": {
31
               "customerId
CustomerId

Customer identifier

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

Name of customer (name of company or surname/familyname/lastname of a person)

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

Secondary name of a company or firstname of a person

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

Customer reference

": "{String}"
35
          },
36
          "invoiceAddress": {
37
               "addressId
AddressId

Reference to customer's invoice address

": "{Integer}",
38
               "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}",
39
               "firstName
FirstName

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

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

First address line

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

Second address line

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

Postalcode/Postcode/ZIP

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

City/town/village

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

Region/province/state

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

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

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

English name of country.

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

Address reference

": "{String}"
48
          },
49
          "shippingAddress": {
50
               "addressId
AddressId

Reference to customer's shipping address

": "{Integer}",
51
               "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}",
52
               "firstName
FirstName

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

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

First address line

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

Second address line

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

Postalcode/Postcode/ZIP

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

City/town/village

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

Region/province/state

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

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

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

English name of country.

": "{String}",
60
               "externalReference
ExternalReference

External address identifier. Normally defined by the customer.

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

Address reference

": "{String}"
62
          },
63
          "responsible
Responsible

PID reference of sales assistant for the contract

": {
64
               "userId
UserId

User identifier

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

Name of the user

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

First name of the user

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

User reference

": "{String}"
68
          },
69
          "assignee
Assignee

PID reference of sales assistant for the contract

": {
70
               "userId
UserId

User identifier

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

Name of the user

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

First name of the user

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

User reference

": "{String}"
74
          },
75
          "accountManager
AccountManager

PID reference of sales assistant for the contract

": {
76
               "userId
UserId

User identifier

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

Name of the user

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

First name of the user

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

User reference

": "{String}"
80
          },
81
          "payment": {
82
               "paymentTerms
PaymentTerms

Payment terms for rental contract

Possible domain values can be found here

": "{String}"
83
          },
84
          "vATDetails": {
85
               "vATHandling
VATHandling

Specifies how value added tax (VAT) should be calculated. Either always include VAT, always exclude VAT or use standard/default VAT rules.

Possible domain values can be found here

": "{String}"
86
          },
87
          "location": {
88
               "locationId
LocationId

Location identifier

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

Unique abbreviation/short name of the location

": "{String}",
90
               "address": {
91
                    "countryCode
CountryCode

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

": "{String}"
92
               },
93
               "locationLink
LocationLink

Location reference

": "{String}"
94
          },
95
          "shipment": {
96
               "deliveryTerms
DeliveryTerms

Delivery terms when shipping the goods. The delivery terms is based on the Incoterms rules from ICC (International Chamber of Commerce). The delivery terms is by default retrieved from the customer.

Possible domain values can be found here

": "{String}",
97
               "deliveryTermPlace
DeliveryTermPlace

Named place related to delivery terms (Incoterms)

": "{String}",
98
               "shippingService": {
99
                    "shippingServiceId
ShippingServiceId

Shipping service identifier

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

Name of shipping service

": "{String}",
101
                    "carrier": {
102
                         "carrierId
CarrierId

Carrier identifier

": "{Integer}",
103
                         "carrierLink
CarrierLink

Carrier reference

": "{String}"
104
                    },
105
                    "shippingServiceLink
ShippingServiceLink

Shipping service reference

": "{String}"
106
               }
107
          },
108
          "totals": {
109
               "currency
Currency

Three character code following the ISO 4217 standard

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

Total amount estimated per rental contract

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

Accumulated value of total discount

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

Accumulated sum of total amounts after the discounts

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

Accumulated value of accrued amounts

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

Accumulated value of invoiced amounts

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

Accumulated value of forecasted amounts

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

Accumulated value of earned revenue of all contract items

": "{Decimal}",
117
               "countOfQuotes
CountOfQuotes

Count of items in stage quote

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

Three character code following the ISO 4217 standard

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

Total amount estimated per rental contract

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

Accumulated value of total discount

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

Accumulated sum of total amounts after the discounts

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

Accumulated value of accrued amounts

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

Accumulated value of invoiced amounts

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

Accumulated value of forecasted amounts

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

Accumulated value of earned revenue of all contract items

": "{Decimal}"
126
          }
127
     }
128
}

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 105932 HTTP 400 From quantity should be greater than 0
Error 105969 HTTP 400 Start date is required
Error 105970 HTTP 400 End date is required
Error 100089 HTTP 404 Product not found
Error 106957 HTTP 400 Only rental or subscription products can be used in recurring contract's lines
Error 108351 HTTP 400 Type of rental contract item not found
Error 108856 HTTP 400 Rate change type not found
Error 108352 HTTP 400 Stage of rental contract item not found
Error 108474 HTTP 400 Quote reference is required for quote item
Error 101040 HTTP 400 Quantity must be filled in to create a new item
Error 108670 HTTP 400 Discount percentage must be a number between 0 and 100
Error 105743 HTTP 400 Start date is required
Error 107155 HTTP 400 End date is required
Error 104971 HTTP 400 The start date cannot be later than the end 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 108677 HTTP 400 Expected delivery date cannot be earlier than the effective date
Error 108678 HTTP 400 Expected collection date cannot be earlier than the effective date
Error 108679 HTTP 400 Expected collection date cannot be earlier then expected delivery date
Error 108680 HTTP 400 Collection date cannot be earlier then the effective date
Error 108681 HTTP 400 Collection date cannot be earlier then the expected delivery date
Error 108683 HTTP 400 Termination date must be earlier then the expiration date