Rental APIs
Add new item to rental check-in
| HTTP method | POST |
| URI | https://api.rambase.net/rental/check-ins/{checkinId}/items |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| - URI parameter {checkinId} |
Rental check-in identifier
Integer, minimum 100000 |
| Successful HTTP status code | 201 |
| API resource identifier | 7122, version 4 |
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.
CheckInDate
Date the rental unit was checked-in
This field is optional.
>{Date}</CheckInDate>RentalContractItemId
Required/mandatory field
Rental contract item identifier
Minimum value: 1
>{Integer}</RentalContractItemId>RentalContractId
Required/mandatory field
Rental contract identifier
Minimum value: 100000
>{Integer}</RentalContractId>LocationId
Required/mandatory field
Location identifier
Minimum value: 10000
>{Integer}</LocationId>StockLocation
This field is optional.
>StockLocationId
Stock location identifier
Minimum value: 100000
This field is optional.
>{Integer}</StockLocationId>RentalUnitId
Required/mandatory field
Rental unit identifier
Minimum value: 100000
>{Integer}</RentalUnitId>CheckInDate
Date the rental unit was checked-in
This field is optional.
": "{Date}",RentalContractItemId
Required/mandatory field
Rental contract item identifier
Minimum value: 1
": "{Integer}",RentalContractId
Required/mandatory field
Rental contract identifier
Minimum value: 100000
": "{Integer}"LocationId
Required/mandatory field
Location identifier
Minimum value: 10000
": "{Integer}"StockLocation
This field is optional.
": {StockLocationId
Stock location identifier
Minimum value: 100000
This field is optional.
": "{Integer}"RentalUnitId
Required/mandatory field
Rental unit identifier
Minimum value: 100000
": "{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] |
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.
RentalCheckInItemId
Rental check-in item identifier
>{Integer}</RentalCheckInItemId>CheckInDate
Date the rental unit was checked-in
>{Date}</CheckInDate>RentalContractItemId
Rental contract item identifier
>{Integer}</RentalContractItemId>LineNumber
Line- or sequence number of the item
>{Integer}</LineNumber>RentalContractItemId
Rental contract item identifier
>{Integer}</RentalContractItemId>Quantity
Number of units ordered
>{Integer}</Quantity>OnRentDays
Estimated number of days with active rental or subscription
>{Integer}</OnRentDays>RentalContractId
Rental contract identifier
>CustomerId
Customer identifier
>{Integer}</CustomerId>Name
Name of customer (name of company or surname/familyname/lastname of a person)
>{String}</Name>FirstName
Secondary name of a company or firstname of a person
>{String}</FirstName>CustomerLink
Customer reference
>{String}</CustomerLink>RentalContractLink
Rental contract reference
>{String}</RentalContractLink>RentalContractItemLink
Rental contract item reference
>{String}</RentalContractItemLink>LocationId
Location identifier
>{Integer}</LocationId>Name
Name of warehouse location
>{String}</Name>ShortName
Unique abbreviation/short name of the location
>{String}</ShortName>LocationLink
Location reference
>{String}</LocationLink>StockLocationId
Stock location identifier
>{Integer}</StockLocationId>Name
Name of stock location
>{String}</Name>Label
Name of current- and parent stock locations, including seperator for location
>{String}</Label>StockLocationLink
Stock location reference
>{String}</StockLocationLink>RentalUnitId
Rental unit identifier
>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>ObjectId
Account code of owner
>{Integer}</ObjectId>ObjectType
ObjectType of the owner, can be either a customer (CUS) or a supplier (SUP).
>{String}</ObjectType>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>RentalUnitLink
Rental unit reference
>{String}</RentalUnitLink>RentalAssignmentId
Rental assignment identifier
>{Integer}</RentalAssignmentId>Date
Check-in date
>{Date}</Date>ExpectedDate
Expected check-in date
>{Date}</ExpectedDate>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>Date
Check-out date
>{Date}</Date>RentalAssignmentLink
Rental assignment reference
>{String}</RentalAssignmentLink>RentalAssignmentId
Rental assignment identifier
>{Integer}</RentalAssignmentId>StartDate
Start date of reservation
>{Date}</StartDate>RentalAssignmentLink
Rental assignment reference
>{String}</RentalAssignmentLink>Status
Status of the rental calendar day
Possible domain values can be found here
>{Integer}</Status>Date
Rental calendar date of day
>{Date}</Date>NumberOfSalesInvoiceItems
Number of sales invoices issued for given day
>{Integer}</NumberOfSalesInvoiceItems>NumberOfSalesCreditNoteItems
Number of credit notes issued for given day
>{Integer}</NumberOfSalesCreditNoteItems>RemainingOnRentQuantity
The sum of all rental units linked to a specific rental contract item that are currently still rented out (not returned or expired)
>{Integer}</RemainingOnRentQuantity>RentalCheckInItemId
Rental check-in item identifier
": "{Integer}",CheckInDate
Date the rental unit was checked-in
": "{Date}",RentalContractItemId
Rental contract item identifier
": "{Integer}",LineNumber
Line- or sequence number of the item
": "{Integer}",RentalContractItemId
Rental contract item identifier
": "{Integer}"Quantity
Number of units ordered
": "{Integer}",OnRentDays
Estimated number of days with active rental or subscription
": "{Integer}",RentalContractId
Rental contract identifier
": {CustomerId
Customer identifier
": "{Integer}",Name
Name of customer (name of company or surname/familyname/lastname of a person)
": "{String}",FirstName
Secondary name of a company or firstname of a person
": "{String}",CustomerLink
Customer reference
": "{String}"RentalContractLink
Rental contract reference
": "{String}"RentalContractItemLink
Rental contract item reference
": "{String}"LocationId
Location identifier
": "{Integer}",Name
Name of warehouse location
": "{String}",ShortName
Unique abbreviation/short name of the location
": "{String}",LocationLink
Location reference
": "{String}"StockLocationId
Stock location identifier
": "{Integer}",Name
Name of stock location
": "{String}",Label
Name of current- and parent stock locations, including seperator for location
": "{String}",StockLocationLink
Stock location reference
": "{String}"RentalUnitId
Rental unit identifier
": {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}",SerialNumber
Serial number
": "{String}",ProductUnitLink
Product unit reference
": "{String}",ObjectId
Account code of owner
": "{Integer}",ObjectType
ObjectType of the owner, can be either a customer (CUS) or a supplier (SUP).
": "{String}",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}"RentalUnitLink
Rental unit reference
": "{String}",RentalAssignmentId
Rental assignment identifier
": "{Integer}",Date
Check-in date
": "{Date}",ExpectedDate
Expected check-in date
": "{Date}",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}"Date
Check-out date
": "{Date}"RentalAssignmentLink
Rental assignment reference
": "{String}"RentalAssignmentId
Rental assignment identifier
": "{Integer}",StartDate
Start date of reservation
": "{Date}"RentalAssignmentLink
Rental assignment reference
": "{String}"Status
Status of the rental calendar day
Possible domain values can be found here
": "{Integer}",Date
Rental calendar date of day
": "{Date}",NumberOfSalesInvoiceItems
Number of sales invoices issued for given day
": "{Integer}",NumberOfSalesCreditNoteItems
Number of credit notes issued for given day
": "{Integer}"RemainingOnRentQuantity
The sum of all rental units linked to a specific rental contract item that are currently still rented out (not returned or expired)
": "{Integer}"
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 108262 HTTP 404 | Recurring rate not found |
| Error 105969 HTTP 400 | Start date is required |
| Error 105970 HTTP 400 | End date is required |
| Error 109843 HTTP 400 | Not allowed for rental contracts with registered items (status 2) |
| Error 109862 HTTP 400 | Not allowed for already cancelled rental items |
| Error 109846 HTTP 400 | Not allowed for rental contracts with items pending final invoice (status 8) |
| Error 108955 HTTP 400 | Not allowed for closed rental contract items |
| Error 108830 HTTP 400 | Rental contract item is not active |
| Error 109122 HTTP 400 | Not allowed for rental subscription items |
| Error 100199 HTTP 404 | Location is not found |
| Error 101294 HTTP 400 | Location is not active (status 4) |
| Error 101327 HTTP 400 | The stock location has to be active (status 4) |
| Error 110138 HTTP 400 | Stock location {0} does not belong to {1} location |
| Error 109463 HTTP 400 | Rental unit is not active (ST=4) |
| Error 110133 HTTP 400 | Rental unit {0} is already added to this check‑in |
| Error 110152 HTTP 400 | The rental unit '{0}' assigned to '{1}' rental item has not been shipped yet |
| Error 110153 HTTP 400 | The rental unit '{0}' assigned to '{1}' rental item has been already returned to the rental fleet |
| Error 110136 HTTP 400 | Rental unit {0} is not assigned to {1} |
| Error 110119 HTTP 400 | Return date is not defined |