API

Rental APIs

Tags and resources

GET
rental/contracts/{rentalContractId}/items
Get list of rental contract items including possible versions of same item
POST
rental/contracts/{rentalContractId}/items/api-operations/{apiOperationId}/instances
5 operation(s) for rental/contracts/{rentalContractId}/items
DELETE
rental/contracts/{rentalContractId}/items/{itemId}
Delete rental contract item
PUT
rental/contracts/{rentalContractId}/items/{itemId}
Update rental contract item
GET
rental/contracts/{rentalContractId}/items/{itemId}
Get rental contract item
POST
rental/contracts/{rentalContractId}/items/{itemId}/api-operations/{apiOperationId}/instances
15 operation(s) for rental/contracts/{rentalContractId}/items/{itemId}
GET
rental/contracts/{rentalContractId}/items/{itemId}/document-flow
RamBase stores the data of every step in an operational business process in the form of a document, for example, a purchase quote, a purchase order, a goods reception, or a supplier invoice. Since the steps of the business processes are often based on previous steps, the documents are likewise based on one another and thus form a consecutive document chain. This resource lists all documents in the flow of the provided rental contract item
GET
rental/contracts/{rentalContractId}/items/{itemId}/forward-destinations?objectType={objectType}
List of possible targets to forward rental contract item to
GET
rental/contracts/{rentalContractId}/items/{itemId}/invoice-periods
Get list of invoice periods per rental contract item
GET
rental/contracts/{rentalContractId}/items/{itemId}/invoice-periods/{invoicePeriodId}/billing-entries
Get list of billing period items per rental contract item and invoice period
GET
rental/contracts/{rentalContractId}/items/{itemId}/recurring-rates
Get recurring rates for contract item
GET
rental/contracts/{rentalContractId}/items/{itemId}/related-objects?includeAssignments={includeAssignments}
Lists objects related to rental contract item
GET
rental/contracts/{rentalContractId}/items/{itemId}/rental-units/applicable-rental-units
Get list of applicable rental units
GET
rental/contracts/{rentalContractId}/versions/{versionId}
Get rental contract version
GET
Expiring rental contract items
Lists all active rental contract items, meaning items which has at least one rentalunit being physically on rent, with expiration dates falling within a configurable look-ahead window.
GET
Pending Allocation Requests
This report lists all rental contract items currently linked to placeholder rental units, along with relevant contract and product details.