API

Rental APIs

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

Update rental contract item

HTTP method PUT
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 5774, version 15

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
RentalContractItem

This field is optional.

>
2
     <Type
Type

Item type: 1- Subscription, 2 - Rental

Applicable domain values can be found here

This field is optional.

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

Line- or sequence number of the item

Minimum value: 1

This field is optional.

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

Note for contract item

This field is optional.

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

Internal note for the contract item

This field is optional.

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

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

This field is optional.

>{String}</CustomersReferenceNumber>
7
     <Product
Product

This field is optional.

>
8
          <ProductId
ProductId

Product identifier

Minimum value: 10000

This field is optional.

>{Integer}</ProductId>
9
          <Description
Description

Description of the product

This field is optional.

>{String}</Description>
10
     </Product>
11
     <Quantity
Quantity

Number of units ordered

Minimum value: 1

This field is optional.

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

The discount in percent for this item.

Minimum value: 0

Maximum value: 100

This field is optional.

>{Decimal}</DiscountPercent>
13
     <RecurringRate
RecurringRate

This field is optional.

>
14
          <RecurringRateId
RecurringRateId

Recurring rate identifier

Minimum value: 100000

This field is optional.

>{Integer}</RecurringRateId>
15
     </RecurringRate>
16
     <RateChangeType
RateChangeType

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

Applicable domain values can be found here

This field is optional.

>{Integer}</RateChangeType>
17
     <Period
Period

This field is optional.

>
18
          <EffectiveDate
EffectiveDate

Start date for the recurring contract item

This field is optional.

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

End date for the recurring contract item

This field is optional.

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

Termination date of item

This field is optional.

>{Date}</TerminationDate>
21
     </Period>
22
     <Seller
Seller

Reference to the seller of the item

This field is optional.

>
23
          <EmployeeId
EmployeeId

Employee identifier

Minimum value: 100

This field is optional.

>{Integer}</EmployeeId>
24
     </Seller>
25
     <ShippingAddress
ShippingAddress

This field is optional.

>
26
          <AddressId
AddressId

Address identifier

Minimum value: 1

This field is optional.

>{Integer}</AddressId>
27
     </ShippingAddress>
28
     <ShippingService
ShippingService

This field is optional.

>
29
          <ShippingServiceId
ShippingServiceId

Shipping service identifier

Minimum value: 100000

This field is optional.

>{Integer}</ShippingServiceId>
30
     </ShippingService>
31
     <Accounting
Accounting

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

This field is optional.

>
32
          <VATCodeDefinition
VATCodeDefinition

This field is optional.

>
33
               <VATCode
VATCode

Code that determines VAT rules used for VAT calculations.

This field is optional.

>{String}</VATCode>
34
          </VATCodeDefinition>
35
     </Accounting>
36
</RentalContractItem>
1
{
2
     "rentalContractItem
RentalContractItem

This field is optional.

": {
3
          "type
Type

Item type: 1- Subscription, 2 - Rental

Applicable domain values can be found here

This field is optional.

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

Line- or sequence number of the item

Minimum value: 1

This field is optional.

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

Note for contract item

This field is optional.

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

Internal note for the contract item

This field is optional.

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

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

This field is optional.

": "{String}",
8
          "product
Product

This field is optional.

": {
9
               "productId
ProductId

Product identifier

Minimum value: 10000

This field is optional.

": "{Integer}",
10
               "description
Description

Description of the product

This field is optional.

": "{String}"
11
          },
12
          "quantity
Quantity

Number of units ordered

Minimum value: 1

This field is optional.

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

The discount in percent for this item.

Minimum value: 0

Maximum value: 100

This field is optional.

": "{Decimal}",
14
          "recurringRate
RecurringRate

This field is optional.

": {
15
               "recurringRateId
RecurringRateId

Recurring rate identifier

Minimum value: 100000

This field is optional.

": "{Integer}"
16
          },
17
          "rateChangeType
RateChangeType

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

Applicable domain values can be found here

This field is optional.

": "{Integer}",
18
          "period
Period

This field is optional.

": {
19
               "effectiveDate
EffectiveDate

Start date for the recurring contract item

This field is optional.

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

End date for the recurring contract item

This field is optional.

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

Termination date of item

This field is optional.

": "{Date}"
22
          },
23
          "seller
Seller

Reference to the seller of the item

This field is optional.

": {
24
               "employeeId
EmployeeId

Employee identifier

Minimum value: 100

This field is optional.

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

This field is optional.

": {
27
               "addressId
AddressId

Address identifier

Minimum value: 1

This field is optional.

": "{Integer}"
28
          },
29
          "shippingService
ShippingService

This field is optional.

": {
30
               "shippingServiceId
ShippingServiceId

Shipping service identifier

Minimum value: 100000

This field is optional.

": "{Integer}"
31
          },
32
          "accounting
Accounting

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

This field is optional.

": {
33
               "vATCodeDefinition
VATCodeDefinition

This field is optional.

": {
34
                    "vATCode
VATCode

Code that determines VAT rules used for VAT calculations.

This field is optional.

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

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

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 108386 HTTP 400 Rental calendar already exists for selected item
Error 100345 HTTP 400 Location is required
Error 108514 HTTP 400 Invalid invoice frequency
Error 108635 HTTP 400 Effective date cannot be later then effective date of any contract item
Error 108421 HTTP 400 The effective date cannot be later than the expiration date
Error 108735 HTTP 400 Expiration date of a contract cannot be earlier then expiration date of any of its quotes
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 104971 HTTP 400 The start date cannot be later than the end date
Error 103491 HTTP 400 Invalid expiration 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
Error 107278 HTTP 400 No available rental unit found for specified product and date range