Renteon Web API Help

IMPORTANT NOTE: Depending on your integration strategy, you may choose to map some of ID-s to your system ID-s (e.g. car categories, offices, equipment, pricelists). If you do that, please note that ID-s WILL BE DIFFERENT ON PRODUCTION AND TEST ENVIRONMENTS, so you should make it easily configurable on your side.

This list show all available controllers and methods in this API. Click the link to show details about request and response for each method.

Additions

Exposes methods for retrieving provider's additions information.

API	Description
GET {culture}/api/additions	Returns list of equipment with basic information.
GET {culture}/api/additions/getall?pricelistId={pricelistId}&pickupOfficeId={pickupOfficeId}	Returns list of all additions with basic information.

Bookings

Exposes methods for bookings management. Search for available cars, create new booking, modify or cancel existing booking, and search existing bookings.

API	Description
GET {culture}/api/bookings/{number}/vehicle	This method is used in keyless booking scenario. Returns vehicle information for a booking and assigns the car if it is not already assigned.
GET {culture}/api/bookings/getBookingsInfoByGPSNumbers	Gets list of car activities that contain sent GPS numbers in a certain date period
GET {culture}/api/bookings/getContractPdf?number={number}&printHeader={printHeader}&printFooter={printFooter}&printSignatures={printSignatures}	Returns printable version of booking in PDF format as binary data.
GET {culture}/api/bookings/getPdf?id={id}&printHeader={printHeader}&printFooter={printFooter}&printSignatures={printSignatures}&hidePrePaidPrices={hidePrePaidPrices}	Returns printable version of booking in PDF format as binary data.
GET {culture}/api/bookings/open/{number}	Opens existing saved booking. Used to retrieve booking details, or for modification of existing booking by using "open" and "save".
POST {culture}/api/bookings/{number}/checkin	This method is used in keyless booking scenario. It is called when a customer returns a vehicle.
POST {culture}/api/bookings/{number}/checkout	This method is used in keyless booking scenario. It is called when a customer collects a vehicle.
POST {culture}/api/bookings/availability	Searches for available cars. Return lists of available car categories with pricing information.
POST {culture}/api/bookings/calculate	Recalculates booking. Returns unsaved booking model.
POST {culture}/api/bookings/create	Calculates prices and adds mandatory additions and available additional services. Returns unsaved booking model.
POST {culture}/api/bookings/save	Saves the booking. Returns saved booking model.
POST {culture}/api/bookings/search	Search bookings. Return list of bookings with basic information.
POST {culture}/api/bookings/sendReservationConfirmationMail?number={number}&language={language}&recipientMail={recipientMail}	Sends a reservation confirmation email.
DELETE {culture}/api/bookings/cancel/{number}	Cancels the booking. Returns cancelled booking model.

CarCategories

Exposes methods for retrieving provider's car category information.

API	Description
GET {culture}/api/carCategories	Returns list of car categories (SIPP-s).
GET {culture}/api/carCategories/{id}	Returns single car category.

DropOffLocations

Exposes methods for retrieving provider's droppOff location information.

API	Description
GET {culture}/api/dropOffLocations	Returns list of dropOff locations with basic information.
GET {culture}/api/dropOffLocations/{id}	Returns single dropOff location.

FinanceDocuments

Exposes methods for retrieving invoices.

API	Description
GET {culture}/api/financeDocuments/getPdf?id={id}&printHeader={printHeader}&printFooter={printFooter}	Returns printable version of finance document in PDF format as binary data.
POST {culture}/api/financeDocuments/create	Create a new finance document for reservation or booking.
POST {culture}/api/financeDocuments/GetMaximumBookingPaymentAmount	Returns details about maximum amount that can be paid for a specific booking.
POST {culture}/api/financeDocuments/search	Search finance documents. Return list of finance documents with basic information.
DELETE {culture}/api/financeDocuments/cancel?id={id}&description={description}	Cancels the finance document. Returns cancelled finance document model.

Offices

Exposes methods for retrieving provider's pick-up and drop-off offices information.

API	Description
GET {culture}/api/offices	Returns list of offices with basic information.
GET {culture}/api/offices/{id}	Returns single office with extended information.
GET {culture}/api/offices/extendedList	Returns list of offices with extended information.

Payments

Exposes methods for retrieving payments.

API	Description
GET {culture}/api/payments/getPdf?id={id}&printHeader={printHeader}&printFooter={printFooter}	Returns printable version of payment in PDF format as binary data.
POST {culture}/api/payments/create	Create a new payment for reservation or booking.
POST {culture}/api/payments/search	Search payments. Return list of payments with basic information.

Pricelists

Exposes methods for retrieving available pricelists information, and downloading prices.

API	Description
GET {culture}/api/pricelists	Returns list of pricelists with basic information.
GET {culture}/api/pricelists/{id}/{currency}	Returns single pricelist including current prices.
GET {culture}/api/pricelists/{id}/CategoryMinPrice/{currency}	Returns lowest prices per car category for a single pricelist.

Settings

Exposes method for retrieving general settings for this API.

API	Description
GET {culture}/api/settings	Returns general settings for this API.