Rental APIs
Creates a new rental unit
| HTTP method | POST |
| URI | https://api.rambase.net/rental/units |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| Custom fields | Custom fields supported |
| Successful HTTP status code | 201 |
| API resource identifier | 4788, version 12 |
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.
Description
Description of rental unit
This field is optional.
>{String}</Description>Availability
This field is optional.
>AvailableFromDate
Date from which the rental unit is available
This field is optional.
>{Date}</AvailableFromDate>EndOfLifeDate
Date to which the rental unit is available
This field is optional.
>{Date}</EndOfLifeDate>ProductCollection
Product collection
This field is optional.
>ProductId
Product identifier
Minimum value: 10000
This field is optional.
>{Integer}</ProductId>Product
Required/mandatory field
Product assigned to rental unit
>ProductId
Required/mandatory field
Product identifier
Minimum value: 10000
>{Integer}</ProductId>ProductUnit
Product unit assigned to rental unit
This field is optional.
>ProductUnitId
Product unit identifier
Minimum value: 100000
This field is optional.
>{Integer}</ProductUnitId>Description
Description of rental unit
This field is optional.
": "{String}",Availability
This field is optional.
": {AvailableFromDate
Date from which the rental unit is available
This field is optional.
": "{Date}",EndOfLifeDate
Date to which the rental unit is available
This field is optional.
": "{Date}"ProductCollection
Product collection
This field is optional.
": {ProductId
Product identifier
Minimum value: 10000
This field is optional.
": "{Integer}"Product
Required/mandatory field
Product assigned to rental unit
": {ProductId
Required/mandatory field
Product identifier
Minimum value: 10000
": "{Integer}"ProductUnit
Product unit assigned to rental unit
This field is optional.
": {ProductUnitId
Product unit 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. |
| $showDomainDescriptions Boolean, optional | Set to "true" to include domain descriptions for fields using domain values. See the Domain values page for more information. Default value is false. |
| $lang String, optional | Specifies the language used in the response, following the 3-letter ISO-639-1 [lll] |
| $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.
Please note that some fields may be removed from the response, based on user roles/duties/permissions.
RentalUnitId
Rental unit identifier
>{Integer}</RentalUnitId>Description
Description of rental unit
>{String}</Description>OperationalStatus
Assignment status of a given rental unit for current day
Possible domain values can be found here
>{Integer}</OperationalStatus>AvailableFromDate
Date from which the rental unit is available
>{Date}</AvailableFromDate>BlockedForRental
Indicates if a rental unit is blocked for rental
>{Boolean}</BlockedForRental>EndOfLifeDate
Date to which the rental unit is available
>{Date}</EndOfLifeDate>FileId
File identifier
>{Integer}</FileId>FileLink
File reference
>{String}</FileLink>ProductId
Product identifier
>{Integer}</ProductId>Name
Name of the product
>{String}</Name>Description
Description of the product
>{String}</Description>ProductLink
Product reference
>{String}</ProductLink>ProductId
Product identifier
>{Integer}</ProductId>Name
Name of the product
>{String}</Name>Description
Description of the product
>{String}</Description>ProductLink
Product reference
>{String}</ProductLink>ProductUnitId
Product unit identifier
>{Integer}</ProductUnitId>SerialNumber
Serial number
>{String}</SerialNumber>ProductUnitLink
Product unit reference
>{String}</ProductUnitLink>CurrentLocation
Current location of rental unit
>LocationId
Location identifier
>{Integer}</LocationId>ShortName
Unique abbreviation/short name of the location
>{String}</ShortName>LocationLink
Location reference
>{String}</LocationLink>HomeLocation
Home location of rental unit
>LocationId
Location identifier
>{Integer}</LocationId>ShortName
Unique abbreviation/short name of the location
>{String}</ShortName>LocationLink
Location reference
>{String}</LocationLink>FixedAsset
Fixed asset assigned to rental unit
>FixedAssetId
Fixed asset identifier
>{Integer}</FixedAssetId>Name
Name of fixed asset
>{String}</Name>Description
Description of fixed asset
>{String}</Description>InitialReceptionItem
Initial goods reception that was used when moving a product from sales to the rental fleet
>GoodsReceptionItemId
Item-/line-number of the goods reception
>{Integer}</GoodsReceptionItemId>GoodsReceptionId
Goods reception identifier
>{Integer}</GoodsReceptionId>GoodsReceptionLink
Goods reception identifier
>{String}</GoodsReceptionLink>GoodsReceptionItemLink
Goods reception item reference
>{String}</GoodsReceptionItemLink>CurrentReceptionItem
The current goods reception that the rental unit is located on. This will get a new value each time the rental unit is returned from rent.
>GoodsReceptionItemId
Item-/line-number of the goods reception
>{Integer}</GoodsReceptionItemId>GoodsReceptionId
Goods reception identifier
>{Integer}</GoodsReceptionId>GoodsReceptionLink
Goods reception identifier
>{String}</GoodsReceptionLink>GoodsReceptionItemLink
Goods reception item reference
>{String}</GoodsReceptionItemLink>Owner
Owner of the rental unit
>ObjectType
ObjectType of the owner, can be either a customer (CUS) or a supplier (SUP).
>{String}</ObjectType>ObjectId
Account code of owner
>{Integer}</ObjectId>Name
Name of the customer/supplier, or last name if it is a person.
>{String}</Name>FirstName
First name of the customer/supplier
>{String}</FirstName>ObjectLink
Owner reference
>{String}</ObjectLink>Total
The total price in company currency from the goods reception, or Balance from the fixed asset if the rental unit is tied to a fixed asset
>{Decimal}</Total>RentalUnitId
Rental unit identifier
": "{Integer}",Status
Status
Possible domain values can be found here
": "{String}",Description
Description of rental unit
": "{String}",OperationalStatus
Assignment status of a given rental unit for current day
Possible domain values can be found here
": "{Integer}",AvailableFromDate
Date from which the rental unit is available
": "{Date}",BlockedForRental
Indicates if a rental unit is blocked for rental
": "{Boolean}",EndOfLifeDate
Date to which the rental unit is available
": "{Date}"FileId
File identifier
": "{Integer}",FileLink
File reference
": "{String}",ProductId
Product identifier
": "{Integer}",Name
Name of the product
": "{String}",Description
Description of the product
": "{String}",ProductLink
Product reference
": "{String}",ProductId
Product identifier
": "{Integer}",Name
Name of the product
": "{String}",Description
Description of the product
": "{String}",ProductLink
Product reference
": "{String}",ProductUnitId
Product unit identifier
": "{Integer}",Status
Status of product unit
Possible domain values can be found here
": "{Integer}",SerialNumber
Serial number
": "{String}",ProductUnitLink
Product unit reference
": "{String}"CurrentLocation
Current location of rental unit
": {LocationId
Location identifier
": "{Integer}",ShortName
Unique abbreviation/short name of the location
": "{String}",LocationLink
Location reference
": "{String}"HomeLocation
Home location of rental unit
": {LocationId
Location identifier
": "{Integer}",ShortName
Unique abbreviation/short name of the location
": "{String}",LocationLink
Location reference
": "{String}"FixedAsset
Fixed asset assigned to rental unit
": {FixedAssetId
Fixed asset identifier
": "{Integer}",Status
Status of fixed asset
Possible domain values can be found here
": "{Integer}",Name
Name of fixed asset
": "{String}",Description
Description of fixed asset
": "{String}"InitialReceptionItem
Initial goods reception that was used when moving a product from sales to the rental fleet
": {GoodsReceptionItemId
Item-/line-number of the goods reception
": "{Integer}",GoodsReceptionId
Goods reception identifier
": "{Integer}",GoodsReceptionLink
Goods reception identifier
": "{String}"GoodsReceptionItemLink
Goods reception item reference
": "{String}"CurrentReceptionItem
The current goods reception that the rental unit is located on. This will get a new value each time the rental unit is returned from rent.
": {GoodsReceptionItemId
Item-/line-number of the goods reception
": "{Integer}",GoodsReceptionId
Goods reception identifier
": "{Integer}",GoodsReceptionLink
Goods reception identifier
": "{String}"GoodsReceptionItemLink
Goods reception item reference
": "{String}"Owner
Owner of the rental unit
": {ObjectType
ObjectType of the owner, can be either a customer (CUS) or a supplier (SUP).
": "{String}",ObjectId
Account code of owner
": "{Integer}",Name
Name of the customer/supplier, or last name if it is a person.
": "{String}",FirstName
First name of the customer/supplier
": "{String}",ObjectLink
Owner reference
": "{String}"Total
The total price in company currency from the goods reception, or Balance from the fixed asset if the rental unit is tied to a fixed asset
": "{Decimal}"
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 106410 HTTP 404 | Rental assignment not found |
| Error 100053 HTTP 403 | You have only admittance to your own suppliers |
| Error 101420 HTTP 404 | Setting definition not found |
| Error 107320 HTTP 400 | Already exists rental unit with selected serial number. |
| Error 109293 HTTP 400 | It is not allowed to assign a fixed asset to a rental unit owned by a third party |
| Error 109035 HTTP 400 | Only active fixed assets are allowed (ST=3 or ST=4 or ST=8) |
| Error 109170 HTTP 400 | The selected fixed asset is already assigned to a rental unit. You cannot assign the same fixed asset multiple times. |
| Error 109670 HTTP 400 | The connection to the fixed asset cannot be removed because it has financial transactions or the rental unit is currently on rent |
| Error 101235 HTTP 404 | Goods reception item {0} not found |
| Error 107276 HTTP 400 | Serial number of registered rental unit cannot be modified |
| Error 109482 HTTP 400 | The availability start date for non-owners must not precede the rental unit's availability date |
| Error 109483 HTTP 400 | The end date of availability for non-owners cannot be later than the end date of the rental unit |