Rental APIs
Update rental contract
| HTTP method | PUT |
| URI | https://api.rambase.net/rental/contracts/{rentalContractId} |
| 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 | 200 |
| API resource identifier | 5760, version 13 |
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.
RentalContract
This field is optional.
>Name
Short description for the rental contract
This field is optional.
>{String}</Name>Description
Detailed description for the recurring rental contract
This field is optional.
>{String}</Description>Currency
Three character code following the ISO 4217 standard
Applicable domain values can be found here
This field is optional.
>{String}</Currency>CustomersReference
Customers reference. Typically a person.
This field is optional.
>{String}</CustomersReference>CustomersReferenceNumber
Customers reference number. E.g. the internal sales order id the customer use in their own system.
This field is optional.
>{String}</CustomersReferenceNumber>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>InvoiceFrequency
Sets frequency at which invoice can be issued.
Applicable domain values can be found here
This field is optional.
>{Integer}</InvoiceFrequency>CreateAccountAdjustmentPlan
The control bit of a mechanism of automatic creation of periods adustments
This field is optional.
>{Boolean}</CreateAccountAdjustmentPlan>BaseDate
A date from which invoices will start to be generated from
This field is optional.
>{Date}</BaseDate>IsAutomaticallyIssued
"True" if invoices in this rental contract should be released automatically
This field is optional.
>{Boolean}</IsAutomaticallyIssued>ShippingAddressAttention
Attention of the shipping address. When changing shipping address, the ShippingAddressAttention will be overridden by the attention of the new shipping address.
This field is optional.
>{String}</ShippingAddressAttention>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.
Input must match the following regular expression pattern: ^([0-9\(\)\s\.\+\-])*$
This field is optional.
>{String}</ShippingAddressPhone>ShippingAddressEmail
Email address of the shipping address. When changing shipping address, the ShippingAddressEmail will be overridden by the email of the new shipping address.
Input must match the following regular expression pattern: ^\w+([-+.']\w+)*@\w+([-.]\w+)*\.\w+([-.]\w+)*$
This field is optional.
>{String}</ShippingAddressEmail>InvoiceAddressAttention
Attention of the invoice address. When changing invoice address, the InvoiceAddressAttention will be overridden by the attention of the new invoice address.
This field is optional.
>{String}</InvoiceAddressAttention>DefaultCheckOutLocation
A default check-out location for rental items
This field is optional.
>LocationId
Location identifier
Minimum value: 10000
This field is optional.
>{Integer}</LocationId>DefaultCheckInLocation
A default check-in location for rental items
This field is optional.
>LocationId
Location identifier
Minimum value: 10000
This field is optional.
>{Integer}</LocationId>AdvanceInvoicing
This field is optional.
>IsInvoicedInAdvance
True if rental contract is invoiced in advance
This field is optional.
>{Boolean}</IsInvoicedInAdvance>BaseDateAdvanceDays
Number of days to advance invoicing from base date
Minimum value: 0
This field is optional.
>{Integer}</BaseDateAdvanceDays>Period
This field is optional.
>EffectiveDate
Start date for the recurring contract
This field is optional.
>{Date}</EffectiveDate>ExpirationDate
End date of the recurring contract
This field is optional.
>{Date}</ExpirationDate>TerminationDate
The date of termination of the contract
This field is optional.
>{Date}</TerminationDate>ClosingDate
The date after the final invoicing, and all logistics handled. The contract is sealed and cannot be changed
This field is optional.
>{Date}</ClosingDate>Customer
This field is optional.
>CustomerId
Customer identifier
Minimum value: 10000
This field is optional.
>{Integer}</CustomerId>Responsible
PID reference of sales assistant for the contract
This field is optional.
>UserId
User identifier
Minimum value: 100
This field is optional.
>{Integer}</UserId>Assignee
PID reference of sales assistant for the contract
This field is optional.
>UserId
User identifier
Minimum value: 100
This field is optional.
>{Integer}</UserId>AccountManager
PID reference of sales assistant for the contract
This field is optional.
>UserId
User identifier
Minimum value: 100
This field is optional.
>{Integer}</UserId>InvoiceAddress
This field is optional.
>AddressId
Reference to customer's invoice address
Minimum value: 1
This field is optional.
>{Integer}</AddressId>ShippingAddress
This field is optional.
>AddressId
Reference to customer's shipping address
Minimum value: 1
This field is optional.
>{Integer}</AddressId>Payment
This field is optional.
>PaymentTerms
Payment terms for rental contract
Applicable domain values can be found here
This field is optional.
>{String}</PaymentTerms>VATDetails
This field is optional.
>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>Location
This field is optional.
>LocationId
Location identifier
Minimum value: 10000
This field is optional.
>{Integer}</LocationId>Shipment
This field is optional.
>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.
Applicable domain values can be found here
This field is optional.
>{String}</DeliveryTerms>DeliveryTermPlace
Named place related to delivery terms (Incoterms)
This field is optional.
>{String}</DeliveryTermPlace>ShippingService
This field is optional.
>ShippingServiceId
Shipping service identifier
Minimum value: 100000
This field is optional.
>{Integer}</ShippingServiceId>RentalContract
This field is optional.
": {Name
Short description for the rental contract
This field is optional.
": "{String}",Description
Detailed description for the recurring rental contract
This field is optional.
": "{String}",Currency
Three character code following the ISO 4217 standard
Applicable domain values can be found here
This field is optional.
": "{String}",CustomersReference
Customers reference. Typically a person.
This field is optional.
": "{String}",CustomersReferenceNumber
Customers reference number. E.g. the internal sales order id the customer use in their own system.
This field is optional.
": "{String}",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}",InvoiceFrequency
Sets frequency at which invoice can be issued.
Applicable domain values can be found here
This field is optional.
": "{Integer}",CreateAccountAdjustmentPlan
The control bit of a mechanism of automatic creation of periods adustments
This field is optional.
": "{Boolean}",BaseDate
A date from which invoices will start to be generated from
This field is optional.
": "{Date}",IsAutomaticallyIssued
"True" if invoices in this rental contract should be released automatically
This field is optional.
": "{Boolean}",ShippingAddressAttention
Attention of the shipping address. When changing shipping address, the ShippingAddressAttention will be overridden by the attention of the new shipping address.
This field is optional.
": "{String}",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.
Input must match the following regular expression pattern: ^([0-9\(\)\s\.\+\-])*$
This field is optional.
": "{String}",ShippingAddressEmail
Email address of the shipping address. When changing shipping address, the ShippingAddressEmail will be overridden by the email of the new shipping address.
Input must match the following regular expression pattern: ^\w+([-+.']\w+)*@\w+([-.]\w+)*\.\w+([-.]\w+)*$
This field is optional.
": "{String}",InvoiceAddressAttention
Attention of the invoice address. When changing invoice address, the InvoiceAddressAttention will be overridden by the attention of the new invoice address.
This field is optional.
": "{String}",DefaultCheckOutLocation
A default check-out location for rental items
This field is optional.
": {LocationId
Location identifier
Minimum value: 10000
This field is optional.
": "{Integer}"DefaultCheckInLocation
A default check-in location for rental items
This field is optional.
": {LocationId
Location identifier
Minimum value: 10000
This field is optional.
": "{Integer}"AdvanceInvoicing
This field is optional.
": {IsInvoicedInAdvance
True if rental contract is invoiced in advance
This field is optional.
": "{Boolean}",BaseDateAdvanceDays
Number of days to advance invoicing from base date
Minimum value: 0
This field is optional.
": "{Integer}"Period
This field is optional.
": {EffectiveDate
Start date for the recurring contract
This field is optional.
": "{Date}",ExpirationDate
End date of the recurring contract
This field is optional.
": "{Date}",TerminationDate
The date of termination of the contract
This field is optional.
": "{Date}",ClosingDate
The date after the final invoicing, and all logistics handled. The contract is sealed and cannot be changed
This field is optional.
": "{Date}"Customer
This field is optional.
": {CustomerId
Customer identifier
Minimum value: 10000
This field is optional.
": "{Integer}"Responsible
PID reference of sales assistant for the contract
This field is optional.
": {UserId
User identifier
Minimum value: 100
This field is optional.
": "{Integer}"Assignee
PID reference of sales assistant for the contract
This field is optional.
": {UserId
User identifier
Minimum value: 100
This field is optional.
": "{Integer}"AccountManager
PID reference of sales assistant for the contract
This field is optional.
": {UserId
User identifier
Minimum value: 100
This field is optional.
": "{Integer}"InvoiceAddress
This field is optional.
": {AddressId
Reference to customer's invoice address
Minimum value: 1
This field is optional.
": "{Integer}"ShippingAddress
This field is optional.
": {AddressId
Reference to customer's shipping address
Minimum value: 1
This field is optional.
": "{Integer}"Payment
This field is optional.
": {PaymentTerms
Payment terms for rental contract
Applicable domain values can be found here
This field is optional.
": "{String}"VATDetails
This field is optional.
": {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}"Location
This field is optional.
": {LocationId
Location identifier
Minimum value: 10000
This field is optional.
": "{Integer}"Shipment
This field is optional.
": {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.
Applicable domain values can be found here
This field is optional.
": "{String}",DeliveryTermPlace
Named place related to delivery terms (Incoterms)
This field is optional.
": "{String}",ShippingService
This field is optional.
": {ShippingServiceId
Shipping service identifier
Minimum value: 100000
This field is optional.
": "{Integer}"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.
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 108845 HTTP 400 | Product cannot be changed |
| 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 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 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 |