Rental APIs
Delete rental contract item
| HTTP method | DELETE |
| 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 |
| Successful HTTP status code | 202 |
| API resource identifier | 5778, version 2 |
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.
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. |
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 109535 HTTP 400 | The rental unit cannot be changed to the selected one because the location does not match |
| Error 106927 HTTP 400 | The new rental unit is not available for the selected period |
| Error 108349 HTTP 400 | Cannot change rental unit because of conflicting assignments |
| 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 |