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.

ExAddition

Exposes methods to the external system regarding addition data

API	Description
GET {culture}/api/ExAddition/{id}	Returns data for a single addition
GET {culture}/api/ExAddition/GetServicesAndTypesForMapping	Returns list of servies and service types for mapping purposes
GET {culture}/api/ExAddition/List?pricelistId={pricelistId}&pickupOfficeId={pickupOfficeId}	Returns list of all additions with basic information

ExAddressBook

Exposes methods to the external system to work with address book data

API	Description
GET {culture}/api/ExAddressBook/{id}	Returns address book data for single address book entry, based on identifier
POST {culture}/api/ExAddressBook	Adds new address book entry to the system
POST {culture}/api/ExAddressBook/Search	Returns list of addresses based on search criteria
PUT {culture}/api/ExAddressBook/{id}	Updates data for the address book entry specified by identifier

ExAddressBookType

Exposes methods to the external system regarding address book type

API	Description
GET {culture}/api/ExAddressBookType	Retrives all address book types

ExArticle

Exposes methods for the external system regarding articles

API	Description
POST {culture}/api/ExArticle/Search	Returns list of articles based on criteria

ExArticleType

Exposes methods to the external system regarding article types

API	Description
GET {culture}/api/ExArticleType	Retrives all article types

ExBooking

Exposes methods for the bookings

API	Description
GET {culture}/api/ExBooking/{number}	Opens existing saved booking. Used to retrieve booking details, or for modification of existing booking by using "open" and "save".
GET {culture}/api/ExBooking/CarServicesByGPSNumber	Gets currently purchased services for the vehicle
GET {culture}/api/ExBooking/GetPdf?bookingNumber={bookingNumber}	Returns printable version of booking in PDF format as binary data.
GET {culture}/api/ExBooking/GetSignatures?bookingNumber={bookingNumber}	Returns bookings signatures
POST {culture}/api/ExBooking/AddSignatures	Adds signature to a booking
POST {culture}/api/ExBooking/Availability	Searches for available cars. Returns lists of available car categories with pricing information.
POST {culture}/api/ExBooking/BasicSearch	Basic booking search. Returns list of bookings with basic information.
POST {culture}/api/ExBooking/Calculate	Recalculates booking. Returns unsaved booking model.
POST {culture}/api/ExBooking/CheckOut?bookingNumber={bookingNumber}&officeCode={officeCode}	Checkout booking
POST {culture}/api/ExBooking/Create	Calculates prices and adds mandatory additions and available additional services. Returns unsaved booking model.
POST {culture}/api/ExBooking/Save	Saves the booking. Returns saved booking model.
POST {culture}/api/ExBooking/Search	Search bookings. Return list of bookings with basic information.
POST {culture}/api/ExBooking/SearchForInsurance	Search for insurance. Returns list of bookings with basic information.
POST {culture}/api/ExBooking/SearchSimple	Search bookings. Return list of bookings with basic information.
POST {culture}/api/ExBooking/SendContractNotificationEmail?bookingNumber={bookingNumber}&language={language}&recipientMail={recipientMail}&senderMail={senderMail}	No documentation available.
DELETE {culture}/api/ExBooking/Cancel/{number}	Cancels the booking. Returns cancelled booking model.

ExBookingChannel

API	Description
GET {culture}/api/ExBookingChannel	No documentation available.

ExBookingSource

API	Description
GET {culture}/api/ExBookingSource	No documentation available.

ExCar

Exposes methods for the external system to work with cars information.

API	Description
GET {culture}/api/ExCar/{id}	Returns data for a single car
GET {culture}/api/ExCar/GetBasicCarExpensesData	Returns a summary list of all car expenses with their basic data
GET {culture}/api/ExCar/GetCarStateByDay?from={from}&to={to}	No documentation available.
POST {culture}/api/ExCar	Adds new car to the system
POST {culture}/api/ExCar/Search	Returns list of cars with basic information.
PUT {culture}/api/ExCar/{id}	Updates data for the car specified by identifier
PUT {culture}/api/ExCar/Activate?id={id}&carActivateDate={carActivateDate}	Sets existing car in the system as active
DELETE {culture}/api/ExCar/Deactivate?CarId={CarId}&CarInactiveStatusId={CarInactiveStatusId}&CarInactiveSubStatusId={CarInactiveSubStatusId}&CarInactiveStatusDate={CarInactiveStatusDate}	Sets existing car in the system as inactive

ExCarActivity

Exposes actions related to car activities to the external system

API	Description
GET {culture}/api/ExCarActivity/{id}	Returns single car activity
GET {culture}/api/ExCarActivity/GetNewEstimatedInCorrection/{id}	Returns single car activity
GET {culture}/api/ExCarActivity/SearchForDamage	Returns car activities for damage
POST {culture}/api/ExCarActivity	Creates new car activity
POST {culture}/api/ExCarActivity/GetNewByDate	Returns new car activity
POST {culture}/api/ExCarActivity/Search	Returns list of car activities based on criteria
PUT {culture}/api/ExCarActivity/{id}	Changes data for the car activity specified by identifier
PUT {culture}/api/ExCarActivity/AddRemark/{id}	Changes remark for the car activity specified by identifier
PUT {culture}/api/ExCarActivity/UpdateEstimatedIn/{id}	Updates car activity estimated in data
DELETE {culture}/api/ExCarActivity/Cancel/{id}?description={description}	Cancells car activity based on identifier

ExCarActivityDefinition

Exposes methods to the external system regarding car activity definitions

API	Description
GET {culture}/api/ExCarActivityDefinition	Retrives all car definitions
GET {culture}/api/ExCarActivityDefinition/GetAvailableDefinitionsForCar?carId={carId}&carActivityId={carActivityId}	Retrives available car definitions

ExCarActivityDefinitionType

Exposes methods to the external system regarding car activity definition types

API	Description
GET {culture}/api/ExCarActivityDefinitionType	Retrives all car activity definition types

ExCarActivityExpenseType

Exposes methods to the external system regarding car activity expense types

API	Description
GET {culture}/api/ExCarActivityExpenseType	Retrives all car activity expense types

ExCarAvailabilityExternal

Exposes methods for the external system to work with external car availability.

API	Description
GET {culture}/api/ExCarAvailabilityExternal/Search	Returns car availability items based on search criteria
POST {culture}/api/ExCarAvailabilityExternal/Save	Saves provided external car availability items to the database. Provided items will override existing items.

ExCarCategory

Exposes methods for the external system to work with car category information.

API	Description
GET {culture}/api/ExCarCategory/{id}	Returns single car category
POST {culture}/api/ExCarCategory/Search	Returns list of car categories based on criteria

ExCarColor

Exposes methods to the external system to work with car colors

API	Description
GET {culture}/api/ExCarColor	Retrives all car colors

ExCarFleet

Exposes methods to the external system regarding car fleet data

API	Description
GET {culture}/api/ExCarFleet	Retrives all car fleets

ExCarInactiveStatus

Exposes methods to the external system to work with car inactive status information

API	Description
GET {culture}/api/ExCarInactiveStatus	Retrives car inactive statuses

ExCarInactiveSubStatus

Exposes methods to the external system to work with car inactive status information

API	Description
GET {culture}/api/ExCarInactiveSubStatus/{carInactiveStatusId}	Retrives car inactive substatuses

ExCarInsurance

Exposes methods for the external system regarding car insurances

API	Description
GET {culture}/api/ExCarInsurance/{id}	Returns single car insurance
POST {culture}/api/ExCarInsurance/Search	Returns list of car insurances based on criteria

ExCarInsuranceType

Exposes methods to the external system regarding car insurance types

API	Description
GET {culture}/api/ExCarInsuranceType	Retrives all car insurance types

ExCarMake

Exposes methods to the external system to work with car makes

API	Description
GET {culture}/api/ExCarMake	Retrives all car makes

ExCarModel

Exposes methods to the external system to work with car model information

API	Description
GET {culture}/api/ExCarModel/{id}	Returns single car model based on identifier
POST {culture}/api/ExCarModel/Search	Returns list of car models

ExCarOwnershipType

Exposes methods to the external system regarding car ownership types

API	Description
GET {culture}/api/ExCarOwnershipType	Retrives all car ownership types

ExCarPart

Exposes methods for car parts

API	Description
GET {culture}/api/ExCarPart	Retrives all car parts

ExCarRegistration

Exposes methods for the external system regarding car registrations

API	Description
GET {culture}/api/ExCarRegistration/{id}	Returns single car registration data
POST {culture}/api/ExCarRegistration	Creates new car registration
POST {culture}/api/ExCarRegistration/Search	Returns list of car registrations based on criteria
PUT {culture}/api/ExCarRegistration/{id}	Updates data for the car registration specified by identifier
DELETE {culture}/api/ExCarRegistration/{id}	Deactivates car registration on identifier

ExCarRegistrationType

Exposes methods to the external system about car registration type

API	Description
GET {culture}/api/ExCarRegistrationType	Retrieves all car registration types

ExCarService

Exposes methods to the external system to work with car services

API	Description
GET {culture}/api/ExCarService/{id}	Retrives single car service
GET {culture}/api/ExCarService/New	No documentation available.
POST {culture}/api/ExCarService	Creates new car service
POST {culture}/api/ExCarService/Search	Retrives list of car services based on criteria
PUT {culture}/api/ExCarService/{id}	Changes existing car service
DELETE {culture}/api/ExCarService/{id}	Deactivates car service based on identifier

ExCarServiceType

Exposes methods to the external system to work with car service type information

API	Description
GET {culture}/api/ExCarServiceType?isActive={isActive}	Retrives car service types

ExCarTireChange

Exposes methods for the external system regarding car registrations

API	Description
GET {culture}/api/ExCarTireChange/{id}	Returns single car tire change
POST {culture}/api/ExCarTireChange	Creates new car tire change
POST {culture}/api/ExCarTireChange/Search	Returns list of car tire changes based on criteria
PUT {culture}/api/ExCarTireChange/{id}	Updates data for the car tire change specified by identifier
DELETE {culture}/api/ExCarTireChange/{id}	Deactivates car tire change on identifier

ExCarTireDiameter

Exposes methods for car tire diameters

API	Description
GET {culture}/api/ExCarTireDiameter	Retrives all car tire diameters

ExCarTireHeight

Exposes methods for car tire heights

API	Description
GET {culture}/api/ExCarTireHeight	Retrives all car tire Heights

ExCarTireMake

Exposes methods for car tire makes

API	Description
GET {culture}/api/ExCarTireMakes	Retrives all car tire Makes

ExCarTirePosition

Exposes methods for car tire positions

API	Description
GET {culture}/api/ExCarTirePosition	Retrives all car tire positions

ExCarTireSeason

Exposes methods for car tire seasons

API	Description
GET {culture}/api/ExCarTireSeason	Retrives all car tire seasons

ExCarTireWidth

Exposes methods for car tire widths

API	Description
GET {culture}/api/ExCarTireWidth	Retrives all car tire widths

ExCarType

Exposes methods to the external system to work with car types

API	Description
GET {culture}/api/ExCarType	Retrives all car types

ExClientsPaymentBalanceCheck

Exposes methods for clients payments balance check

API	Description
POST {culture}/api/ExClientsPaymentBalanceCheck/Search	Retrives clients payments balance check

ExCompanyType

Exposes methods to the external system regarding company type data

API	Description
POST {culture}/api/ExCompanyType/Search	Retrives all company types

ExCountry

Exposes methods to the external system regarding country data

API	Description
POST {culture}/api/ExCountry/Search	Retrives countries

ExCreditCardType

Exposes methods to the external system to work with credit card type information

API	Description
GET {culture}/api/ExCreditCardType	Retrieves all credit card types

ExCurrency

Exposes methods for currency handling

API	Description
POST {culture}/api/ExCurrency/Search	Retrives currencies

ExDamage

Exposes damage handling methods

API	Description
GET {culture}/api/ExDamage/{id}	Returns data for single damage
POST {culture}/api/ExDamage	Adds new damage to the system
POST {culture}/api/ExDamage/Search	Returns list of damage data based on criteria
PUT {culture}/api/ExDamage/{id}	Updates damage data specified by identifier
DELETE {culture}/api/ExDamage/{id}	Deactivates damage by its identifier

ExDamageType

Exposes methods for damage types

API	Description
GET {culture}/api/ExDamageType	Retrives all damage types

ExDropOffLocation

Exposes methods to the external system regarding drop off location data

API	Description
GET {culture}/api/ExDropOffLocation	Returns list of drop off locations
GET {culture}/api/ExDropOffLocation/{id}	Returns single drop off location data

ExExportBooking

Exposes methods for the export of the bookings

API	Description
GET {Culture}/api/ExExportBooking/GetPdf?Id={Id}&PrintHeader={PrintHeader}&PrintFooter={PrintFooter}&PrintSignatures={PrintSignatures}	Returns printable version of booking in PDF format as binary data.
POST {culture}/api/ExExportBooking/Search	Returns list of bookings based on criteria

ExExportBookingItem

Exposes methods for the export of the booking items

API	Description
GET {culture}/api/ExExportBookingItem/List/{bookingId}	Returns list of booking items based on booking identifier

ExExportBookingItemPrice

Exposes methods for the export of the booking item prices

API	Description
POST {culture}/api/ExExportBookingItemPrice/Search	Returns list of booking item prices based on criteria

ExExportClientPayment

Exposes methods for the export of the client payments

API	Description
POST {culture}/api/ExExportClientPayment/Search	Returns list of client payments based on criteria

ExExportFleetAvailability

Exposes methods for the export of the payments

API	Description
POST {culture}/api/ExExportFleetAvailability/Search	Returns filtered list of fleet availability information per day and car category (max 100.000 records).

ExExportInvoice

Exposes methods for the export of the invoices

API	Description
POST {culture}/api/ExExportInvoice/Search	Returns list of invoices based on criteria

ExExportPayment

Exposes methods for the export of the payments

API	Description
POST {culture}/api/ExExportPayment/Search	Returns list of payments, based on criteria

ExFinanceDocument

Exposes methods to the external system to work with finance document data

API	Description
GET {culture}/api/ExFinanceDocument/GetMaximumBookingPaymentAmount?BookingNumber={BookingNumber}&CurrencyCode={CurrencyCode}	Returns details about maximum amount that can be paid for a specific booking.
GET {Culture}/api/ExFinanceDocument/GetPdf?Id={Id}&PrintHeader={PrintHeader}&PrintFooter={PrintFooter}&PrintSignatures={PrintSignatures}	Returns printable version of finance document in PDF format as binary data.
POST {culture}/api/ExFinanceDocument/Create	Create a new finance document for reservation or booking.
POST {culture}/api/ExFinanceDocument/OdooExport	Returns list of finance documents based on criteria
POST {culture}/api/ExFinanceDocument/Search	Returns list of finance documents based on criteria

ExFleetChart

Exposes methods for the external system to work with fleet chart

API	Description
POST {culture}/api/ExFleetChartController/AssignCarToReservation	Assignes car to the reservation
POST {culture}/api/ExFleetChartController/DetachCarFromReservation	Detaches car from reservation

ExFuelType

Exposes methods to the external system to work with fuel type information

API	Description
GET {culture}/api/ExFuelType	Retrieves all fuel types

ExGame

Exposes methods to the external system regarding addition data

API	Description
GET {culture}/api/ExGame/CalculateBooking	Calculates and checks booking data and returns calculated booking date or eventual validation errors
GET {culture}/api/ExGame/GetBookingPdf?bookingNumber={bookingNumber}	Returns printable version of booking in PDF format as binary data.
GET {culture}/api/ExGame/GetBookingsForCheckIn	Returns list of bookings available for keybox checkin
GET {culture}/api/ExGame/GetBookingsForCheckout?pickupDateFrom={pickupDateFrom}&pickupDateTo={pickupDateTo}&keyBoxCode={keyBoxCode}	Returns list of bookings available for keybox checkout
GET {culture}/api/ExGame/GetInvoicePdf?bookingNumber={bookingNumber}&printHeader={printHeader}&printFooter={printFooter}	Returns printable version of finance document in PDF format as binary data.
GET {culture}/api/ExGame/GetSignatures?bookingNumber={bookingNumber}	Returns bookings signatures
GET {culture}/api/ExGame/OpenBooking?bookingNumber={bookingNumber}	Returns booking data
POST {culture}/api/ExGame/AddSignature	Adds signature to a booking
POST {culture}/api/ExGame/CheckInBooking	CheckIn booking
POST {culture}/api/ExGame/CheckOutBooking?bookingNumber={bookingNumber}	Checkout booking
POST {culture}/api/ExGame/CreateInvoice	Creates an invoice
POST {culture}/api/ExGame/PreCheckInBooking	Pre-checking booking
POST {culture}/api/ExGame/SaveBooking	Saves booking

ExLeaseBooking

Exposes methods for the lease bookings

API	Description
GET {culture}/api/ExLeaseBooking/{number}	Opens existing saved booking. Used to retrieve booking details, or for modification of existing booking by using "open" and "save".
POST {culture}/api/ExLeaseBooking/Calculate	Recalculates booking. Returns unsaved booking model.
POST {culture}/api/ExLeaseBooking/Create	Calculates prices and adds mandatory additions and available additional services. Returns unsaved booking model.
POST {culture}/api/ExLeaseBooking/Save	Saves the booking. Returns saved booking model.
POST {culture}/api/ExLeaseBooking/Search	Search bookings. Return list of bookings with basic information.
DELETE {culture}/api/ExLeaseBooking/Cancel/{number}	Cancels the booking. Returns cancelled booking model.

ExOffice

Exposes methods to the external system to work with office data

API	Description
GET {culture}/api/ExOffice/{id}	Returns office data for single office based on identifier
POST {culture}/api/ExOffice/IsWorking/{id}	Returns office working status at a given time
POST {culture}/api/ExOffice/Search	Returns list of office data based on search criteria

ExPaymentType

Exposes methods to the external system to work with payment type information

API	Description
GET {culture}/api/ExPaymentType	Retrieves all payment types

ExPlannedFleet

Exposes methods for the planned fleet

API	Description
POST {culture}/api/ExPlannedFleet/Overview	No documentation available.

ExportInvoiceItem

Exposes methods for the export of the invoice items

API	Description
GET {culture}/api/ExExportInvoiceItem/List/{invoiceId}	Returns list of invoice items based on invoice identifier

ExportReport

Exposes methods for the export of the tenant report items

API	Description
GET {culture}/api/ExExportReport/GetFranchises	Returns list of franchises based on tenant identifier
POST {culture}/api/ExExportReport/BookingReportList	Returns list of report data based on tenant identifier

ExPostman

Exposes file with testing code for Postman

API	Description
GET {culture}/api/ExPostman/210	Returns json file with testing code examples in 2.1.0 format

ExPricelist

Exposes methods for working with pricelists and prices.

API	Description
GET {culture}/api/ExPricelist	Returns list of pricelists with basic information
GET {culture}/api/ExPricelist/{id}	Returns single pricelist including current prices
POST {culture}/api/ExPricelist/CopyPricelistToExisting	No documentation available.
POST {culture}/api/ExPricelist/CopyPricelistToNew	No documentation available.
POST {culture}/api/ExPricelist/GetPrices	Returns the prices by search criteria from the selected pricelist.
POST {culture}/api/ExPricelist/SavePrices?pricelistId={pricelistId}	Saves prices and takes care of modifying overlapping termins and creating pricelist history records.

ExService

Exposes methods to the external system for the various services

API	Description
GET {culture}/api/ExService/Search	Service search
GET {culture}/api/ExService/ServiceCodeList	Returns list of all service codes

ExSettings

Exposes methods regarding general settings for the API

API	Description
GET {culture}/api/ExSettings	Returns general settings for the API

ExSpareWheelType

Exposes methods to the external system to work with spare wheel types

API	Description
GET {culture}/api/ExSpareWheelType	Retrives all spare wheel types

ExTrafficFineManagement

Exposes traffic fine handling methods

API	Description
GET {culture}/api/ExTrafficFine/{id}	Returns data for single traffic fine
GET {culture}/api/ExTrafficFine/WriteOff?id={id}&writeOffReason={writeOffReason}	No documentation available.
POST {culture}/api/ExTrafficFine	Adds new traffic fine to the system
POST {culture}/api/ExTrafficFine/Search	Returns list of traffic fine data based on criteria
PUT {culture}/api/ExTrafficFine/{id}	Updates damage data specified by identifier
DELETE {culture}/api/ExTrafficFine/{id}	Deactivates traffic fine based on identifier

ExTrafficFineTypes

Exposes traffic fine type

API	Description
GET {culture}/api/ExTrafficFineTypes	Returns a list of traffic fine types