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 18 |
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>InternalNote
Internal note for the contract
This field is optional.
>{String}</InternalNote>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>DiscountPercentage
This field originates from the Rental discount field on the customer. If changing this field it will not alter discount on existing items.
Minimum value: 0
Maximum value: 100
This field is optional.
>{Decimal}</DiscountPercentage>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>DeactivateExpirationDateExtending
Allows to deactivate the automatic extension of expiration dates setting for the contract
This field is optional.
>{Boolean}</DeactivateExpirationDateExtending>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>DefaultRateChangeType
Default setting of change rate type for all new rental contract items
Applicable domain values can be found here
This field is optional.
>{Integer}</DefaultRateChangeType>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>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}",InternalNote
Internal note for the 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}",DiscountPercentage
This field originates from the Rental discount field on the customer. If changing this field it will not alter discount on existing items.
Minimum value: 0
Maximum value: 100
This field is optional.
": "{Decimal}",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}",DeactivateExpirationDateExtending
Allows to deactivate the automatic extension of expiration dates setting for the contract
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}",DefaultRateChangeType
Default setting of change rate type for all new rental contract items
Applicable domain values can be found here
This field is optional.
": "{Integer}",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}"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 101015 HTTP 404 | Permission not found |
| Error 100053 HTTP 403 | You have only admittance to your own suppliers |
| Error 101420 HTTP 404 | Setting definition not found |
| Error 100992 HTTP 400 | This customer does not buy in this currency |
| Error 108717 HTTP 400 | Base date of rental contract is required |
| Error 100345 HTTP 400 | Location is required |
| Error 101294 HTTP 400 | Location is not active (status 4) |
| Error 109725 HTTP 400 | The new main location must follow the same country as there are some items already defined for the contract |
| Error 108514 HTTP 400 | Invalid invoice frequency |
| Error 102035 HTTP 400 | Effective date is required |
| Error 108421 HTTP 400 | The effective date cannot be later than the expiration date |
| Error 108635 HTTP 400 | Effective date cannot be later then effective date of any contract item |
| 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 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 109723 HTTP 400 | The country of selected default check-out location ({0}) is different than contract's main location country ({1}) |
| 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 109724 HTTP 400 | The country of selected default check-in location ({0}) is different than contract's main location country ({1}) |
| Error 109335 HTTP 400 | Selected payment term is not supported on rental contract |
| Error 108670 HTTP 400 | Discount percentage must be a number between 0 and 100 |
| Error 109623 HTTP 400 | VAT handling can't be changed since there has been made invoice(s) from this contract |