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 30

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
     <LineNumber
LineNumber

Line- or sequence number of the item

Minimum value: 1

This field is optional.

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

Note for contract item

This field is optional.

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

Internal note for the contract item

This field is optional.

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

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

This field is optional.

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

This field is optional.

>
7
          <ProductId
ProductId

Product identifier

Minimum value: 10000

This field is optional.

>{Integer}</ProductId>
8
     </Product>
9
     <ProductDescription
ProductDescription

Description of the product

This field is optional.

>{String}</ProductDescription>
10
     <Quantity
Quantity

Number of units ordered

Minimum value: 1

This field is optional.

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

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

This field is optional.

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

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

This field is optional.

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

The discount in percent for this item.

Minimum value: 0

Maximum value: 100

This field is optional.

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

This field is optional.

>
15
          <RecurringRateId
RecurringRateId

Recurring rate identifier

Minimum value: 100000

This field is optional.

>{Integer}</RecurringRateId>
16
     </RecurringRate>
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}</RateChangeType>
18
     <Period
Period

This field is optional.

>
19
          <EffectiveDate
EffectiveDate

Start date for the recurring contract item

This field is optional.

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

End date for the recurring contract item

This field is optional.

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

The termination date is the date when the item is ended before its scheduled expiration.

This field is optional.

>{Date}</TerminationDate>
22
     </Period>
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}</EmployeeId>
25
     </Seller>
26
     <CheckOut
CheckOut

This field is optional.

>
27
          <ExpectedDate
ExpectedDate

Expected check-out date (shipment)

This field is optional.

>{Date}</ExpectedDate>
28
     </CheckOut>
29
     <CheckIn
CheckIn

This field is optional.

>
30
          <ExpectedDate
ExpectedDate

Expected check-in date (return)

This field is optional.

>{Date}</ExpectedDate>
31
     </CheckIn>
32
     <ShippingAddress
ShippingAddress

This field is optional.

>
33
          <AddressId
AddressId

Address identifier

Minimum value: 1

This field is optional.

>{Integer}</AddressId>
34
     </ShippingAddress>
35
     <ShippingAddressDeliveryTerms
ShippingAddressDeliveryTerms

Delivery terms that apply for the shipping address. The delivery terms is based on the Incoterms rules from ICC (International Chamber of Commerce).

Applicable domain values can be found here

This field is optional.

>{String}</ShippingAddressDeliveryTerms>
36
     <ShippingAddressDeliveryTermPlace
ShippingAddressDeliveryTermPlace

Named place related to delivery terms (Incoterms)

This field is optional.

>{String}</ShippingAddressDeliveryTermPlace>
37
     <ShippingService
ShippingService

This field is optional.

>
38
          <ShippingServiceId
ShippingServiceId

Shipping service identifier

Minimum value: 100000

This field is optional.

>{Integer}</ShippingServiceId>
39
     </ShippingService>
40
     <Accounting
Accounting

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

This field is optional.

>
41
          <VATCodeDefinition
VATCodeDefinition

This field is optional.

>
42
               <VATCode
VATCode

Code that determines VAT rules used for VAT calculations.

This field is optional.

>{String}</VATCode>
43
          </VATCodeDefinition>
44
     </Accounting>
45
</RentalContractItem>
1
{
2
     "rentalContractItem
RentalContractItem

This field is optional.

": {
3
          "lineNumber
LineNumber

Line- or sequence number of the item

Minimum value: 1

This field is optional.

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

Note for contract item

This field is optional.

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

Internal note for the contract item

This field is optional.

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

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

This field is optional.

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

This field is optional.

": {
8
               "productId
ProductId

Product identifier

Minimum value: 10000

This field is optional.

": "{Integer}"
9
          },
10
          "productDescription
ProductDescription

Description of the product

This field is optional.

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

Number of units ordered

Minimum value: 1

This field is optional.

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

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

This field is optional.

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

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

This field is optional.

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

The discount in percent for this item.

Minimum value: 0

Maximum value: 100

This field is optional.

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

This field is optional.

": {
16
               "recurringRateId
RecurringRateId

Recurring rate identifier

Minimum value: 100000

This field is optional.

": "{Integer}"
17
          },
18
          "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}",
19
          "period
Period

This field is optional.

": {
20
               "effectiveDate
EffectiveDate

Start date for the recurring contract item

This field is optional.

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

End date for the recurring contract item

This field is optional.

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

The termination date is the date when the item is ended before its scheduled expiration.

This field is optional.

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

Reference to the seller of the item

This field is optional.

": {
25
               "employeeId
EmployeeId

Employee identifier

Minimum value: 100

This field is optional.

": "{Integer}"
26
          },
27
          "checkOut
CheckOut

This field is optional.

": {
28
               "expectedDate
ExpectedDate

Expected check-out date (shipment)

This field is optional.

": "{Date}"
29
          },
30
          "checkIn
CheckIn

This field is optional.

": {
31
               "expectedDate
ExpectedDate

Expected check-in date (return)

This field is optional.

": "{Date}"
32
          },
33
          "shippingAddress
ShippingAddress

This field is optional.

": {
34
               "addressId
AddressId

Address identifier

Minimum value: 1

This field is optional.

": "{Integer}"
35
          },
36
          "shippingAddressDeliveryTerms
ShippingAddressDeliveryTerms

Delivery terms that apply for the shipping address. The delivery terms is based on the Incoterms rules from ICC (International Chamber of Commerce).

Applicable domain values can be found here

This field is optional.

": "{String}",
37
          "shippingAddressDeliveryTermPlace
ShippingAddressDeliveryTermPlace

Named place related to delivery terms (Incoterms)

This field is optional.

": "{String}",
38
          "shippingService
ShippingService

This field is optional.

": {
39
               "shippingServiceId
ShippingServiceId

Shipping service identifier

Minimum value: 100000

This field is optional.

": "{Integer}"
40
          },
41
          "accounting
Accounting

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

This field is optional.

": {
42
               "vATCodeDefinition
VATCodeDefinition

This field is optional.

": {
43
                    "vATCode
VATCode

Code that determines VAT rules used for VAT calculations.

This field is optional.

": "{String}"
44
               }
45
          }
46
     }
47
}

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 100027 HTTP 400 Missing mandatory parameter {0}
Error 100018 HTTP 404 Document {0} not found
Error 106383 HTTP 400 Minimum production order quantity must be a positive number if set
Error 103546 HTTP 400 Only product structures can be blocked for production
Error 107762 HTTP 400 Only product structures can auto create work orders for sub production
Error 107763 HTTP 400 Only product structures can be set up for line production
Error 107764 HTTP 400 Only product structures can be externally manufactured
Error 109643 HTTP 400 Safetystock cannot be greater than maximumstock
Error 103478 HTTP 400 Purchase price is required
Error 102109 HTTP 400 Supplier is required
Error 100047 HTTP 404 Supplier not found
Error 101097 HTTP 404 Given currency {0} mismatch with currencies of supplier {1}
Error 103551 HTTP 400 IsManufacturedInBatches can only be changed on product structures
Error 103554 HTTP 400 AutomaticallyCreateWorkOrdersForSubstructures can only be changed on product structures
Error 104253 HTTP 400 ProduceInMultipleOf can only be changed on product structures.
Error 107694 HTTP 400 Use line production can only be changed on product structeres
Error 106999 HTTP 400 Sub module 'Projectorder' is not activated in this company
Error 106436 HTTP 400 Unit can only be changed when status is equal to draft (status 1)
Error 100167 HTTP 404 Measurement unit not found
Error 104486 HTTP 400 Unit production is only allowed for measurment units (UNI) of type QTY
Error 100200 HTTP 404 Special handling code not found
Error 100092 HTTP 404 Service template not found
Error 103020 HTTP 404 Qcdoc not found
Error 101091 HTTP 404 Contry of origin is not valid: {0}
Error 101124 HTTP 400 Hardware code already exists
Error 106437 HTTP 400 Type can not be changed when status is not equal to draft (status 1)
Error 106680 HTTP 400 Not allowed when product is of subscription sales type
Error 101009 HTTP 400 The product has a structure. You can only change the product type to a type that can contain a structure.
Error 101010 HTTP 400 The product structure contains operations and can not be changed to become a phantom structure
Error 101008 HTTP 400 Cannot change product type from a physical type to a virtual type
Error 101007 HTTP 400 Cannot change product type from a virtual type to a physical type
Error 108988 HTTP 400 Sales type can not be changed when status is equal to completed(status 9)
Error 109184 HTTP 400 Sales type can not be changed to Subscription from other types.
Error 109185 HTTP 400 Sales type can not be changed to other types from Subscription.
Error 109180 HTTP 400 Sales type can not be changed from Rental/Sale to Sales
Error 103021 HTTP 400 Linkid must be a rental product
Error 104760 HTTP 400 Costing method can't be changed after product has been received
Error 104652 HTTP 400 Both minimum sales price and minimum sales price currency must be given
Error 100563 HTTP 400 Currency {0} is not supported by the system
Error 104653 HTTP 400 Minimum sales price can not be negative
Error 106506 HTTP 404 Image not found