Export API Methods

Export API Methods

Overview

Rental Car Manager offers an Export API to export certain datasets.  Each of the methods available is discussed below.
For detailed information about getting started with connecting to the Export API, see the article Getting Started with Export API.

There is a cost to set up these APIs, please contact RCM support (support@rentalcarmanager.com) for more information.

Available Export Methods

The following export methods are part of the Export API:
  1. Vehicles - returns all vehicle information for those vehicles added, updated or deleted during the date range entered.
  2. Reservations - returns all Reservations which have been updated within the input date range.
  3. Locations - returns all information about a renting location.
  4. Season - Returns all of the seasons.
  5. Agencies - Exports all agency data.
  6. Booking Extra Fees - Returns the extra fees applied to a particular reservation, location or across a date range. Does not include bonds or insurances.
  7. Reservation Rate Details - Returns the reservation rate details applied to a particular reservation, location or across a date range.
  8. Reservation Payment Details - Get reservation payment details across a date range.
  9. Reservation Notes - Get notes recorded against reservations, either by a date range (last updated) or specific reservation number.
  10. Customers - Returns customer details by customer id and/or date range for last updated or last hired.
  11. Extra Items - Returns all extra items and insurances.
  12. Rental Source - Returns all items from the Rental Source list.
  13. RCM Operators - Gets data about all active RCM users.
  14. Vehicle Service Records - Gets data about periodic or manual services for vehicles.
  15. On Road Repairs - Returns any On Road Repairs that have been recorded during the date range entered.
  16. Maintenance Bookings - Returns data about maintenance bookings.
  17. Agent Payments - Returns data about payments from and to Agents.
  18. Agent Rates - Returns the agent rates for the date range entered. This can only be run using an Agent Export API key and will only return the rates for the agent specified in the API key.
  19. Web Rates - Return the seasonal rental rates for the date range entered.
  20. Reservation Custom Fields - Returns the customs fields for the date rage entered or for a particular reservation.

Vehicles

Return all vehicle information for those vehicles added, updated or deleted within the input date range.  Initial data load can be performed with very large date range (e.g. 01-01-2000 to today), then each day they can just request the previous day’s changes.
Method Information:

method - "vehicle"
Example Call -  {URL}?key={key}&method=vehicle&vid=0&sd=20160501&ed=20160502
Restrictions - Date range is maximum 1 day. May be called up to 6 times per day, where hours are specified.

Input:
The following parameters exist for this method

Parameter
Description
vid
An integer vehicle is to restrict the report to a single vehicle.
A value of 0 returns all vehicles
sd
Start Date
vehicles altered on or after this date will be returned.
string format is yyyyMMdd-HHmm
ed
End Date
vehicles altered on or before this date will be returned.
string format is yyyyMMdd-HHmm
newfleet
(Optional Field)
Pass a value of "1" here to ONLY see vehicles that have been newly added to the fleet within the date range.

Output:

Field
Description
ID 
This is a unique identifier for the vehicle
CategoryType
The Category Type that has been assigned to the vehicle
Type
The Vehicle type that has been assigned to the vehicle
Size
This is the Vehicle Category that has been assigned to the vehicle
Make
The Make of the vehicle
Model
The Model of the vehicle
Year
The year of manufacture of the vehicle
RegistrationNo
The Registration number of the vehicle
RegistrationDate
The Registration Expiry date for the vehicle
FleetNo
The Fleet number of the vehicle
VIN
The VIN of the vehicle
Chassis
The Chassis no of the vehicle 
CurrentLocation
The current location of the vehicle. This is returned as the location code for the location.
OwningLocationCode
Owning location of the vehicle, as location code
OwningLocationName
Owning location of the vehicle, as full name
Grade
The Grade that has been saved against the vehicle
FuelCapacity
The fuel capacity of the vehicle.
DateOnFleet
The date the vehicle was on-fleeted. This can be different to the date the vehicle was added to the RCM system.
Date On Fleet  is the date the vehicle became available for hire.
DateOffFleet
The date the vehicle was removed from the fleet.
cDateEntered
The date the vehicle was added to the RCM system.
cUpdatedDate
The date and time the vehicle was last updated.
DeleteDate
The date the vehicle was deleted from the RCM system.
If the value in this field is "2100-12-31", this means the vehicle has not been deleted yet.
PurchaseDate
The date the vehicle was purchased.
PurchasePrice
The price that was paid when the vehicle was purchased.
PurchaseMileage
When the vehicle was purchased, the odometer reading for the vehicle.
InsuredAmount
From Vehicle Insurance record
ResidualValue
The Residual Value that has been assigned to this vehicle.
DepreciationRate
The depreciation rate for this vehicle.
MonthlyPayment
The monthly payment for this vehicle. 
FinanceCompany
The Finance Company recorded against the vehicles finance information.
FinanceStartDate
The start date of the finance period for this vehicle.
FinanceEndDate
The end date of the finance period for this vehicle.
FinanceTerm
The number of months in the vehicles finance term. 
BuybackAgreementNumber
The number of the agreement made with the Finance Company about Buyback
BuybackTerm
The number of months in the Buyback agreement's term
BuybackDealer
The name of the dealer involved in the Buyback
BuybackKilometers
The number of kilometers at which Buyback will occur
BuybackPrice
The price that will be paid at Buyback.
ContractNumber
The phone number for the Finance companies contact. 
DisposalDate
The disposal date that has been assigned to this vehicle.
When you delete a vehicle you can choose to save the disposal information.
DisposalPrice
The price set for the vehicle at the time of disposal.
DisposalMileage
The Odometer reading for the vehicle that was recorded as part of the disposal information.
Transmission
The transmission type for the vehicle
FuelType
the type of fuel that this vehicle uses.
CurrentMileage
The current odometer reading for this vehicle.
It is important to note that this value is current at the time of export.
RadioCode
The radio code that has been assigned to this vehicle.
RegoExpiryDate
The registration expiry date for this vehicle
StateCode
The state that this vehicle has been registered in.
COFDate
The RWC/WOF due date for this vehicle.
EleWOFDate
The Electrical WOF due date for this vehicle.
Utilise
The utilise flag for this vehicle.
This flag determines whether this vehicle will be included in any utilisation reports run within RCM.
UtiliseStartDate
The starting date for the utilisation period for this vehicle.
UtiliseEndDate
The ending date for the utilisation period for this vehicle.
Available
The available for booking flag for this vehicle
PMBaseDate
The date to be used to determine the date due for the first PM (Periodic Maintenance) service for this vehicle.
Once a PM service has been recorded, that information will be used to determine the next due date.
PMScheduleCategory
The PM Schedule Category that has been assigned to this vehicle.
ContainmentWof
The expiry date of the vehicle's Containment certificate
GasInsDate
The due date of the vehicles next gas inspection
DeviceIDTelemax GPS DeviceID (if recorded)
TotalMileage
The total mileage travelled for this vehicle while on-fleet for this company.
This is calculated by Disposal Mileage minus Purchase Mileage. If neither of these two fields have values, then this will be 0.
TotalMaintenanceCost
The total cost of any maintenance done on this vehicle.
This will be calculated using any services that have been recorded inside RCM. This includes PM and Manual services.

Return to top

Reservations

Return all Reservations which have been updated within the input date range. Date range will need to be restricted in order to prevent very large datasets.  Regular requests can query for changes made since the previous request.  Note that updates that were made may not affect the information that will be returned, for e.g. if an operator updated a fee or insurance details, you will receive the reservation again despite it not have changed the information you receive.

Method Information:

method - "repbookingexport"
Example call - {URL}?key={key}&method=repbookingexport&lid=2&sd=20160501-0000&ed=20160502-0000
Restrictions - Date range is maximum 1 day. May be called up to 6 times per day, where hours are specified.

Input:

Parameter
Description
lid
An integer location ID to restrict the report to a particular location.
A value of 0 returns all locations.
sd
Start date - bookings altered on or after this date will be returned.
String format is yyyyMMdd-HHmm.
ed
End date - bookings altered on or before this date will be returned.
String format is yyyyMMdd-HHmm
td
Type of Date - this export can be restricted to reservation with a certain type of date that falls in the date range entered.
The options available for this are:
  1. pickup
  2. dropoff
  3. updated
If nothing is specified, the updated date will be used.
nonrev
A flag to state whether No Revenue bookings will be included in the results or not.
The default option for this is to not include the Non Revenue bookings. This means that if a value is not passed in for this flag then Non Revenue bookings will not be included in the returning information.

Output:

Field
Description
BookingType (This could also be called ReservationStatus.)
The booking type for this reservation. Some options are as follows:
  1. Reservation
  2. Hired
  3. Returned
  4. Cancelled
  5. Unallocated Reservation
  6. Unallocated Quotation
ReservationNo
Unique ID for this reservation. This is the reservation number for the allocated booking.
If this reservation has not been allocated to a vehicle, then this field will have a value of 0.
UnallocatedReservationNo
Unique ID for the reservation. This is not the same value as the ReservationNo. This is the unallocated booking number.
Some reservations will have a 0 value in this field. If they were created as an allocated booking, rather than an unallocated booking and then had a vehicle allocated.
PickupLocationID
The location ID of the pickup location for this reservation.
DropOffLocationID
The location ID of the drop off location for this booking.
RentalDaysInReportPeriod
The amount of days for this reservation that occur within the date range entered for this export.
For example, if the total number of days for a booking is 12, and you run this export for a period of 5 days where the 5 day period is within the reservation dates. The value returned in this field will be 5, as 5 of the reservation days occur in the date range you run the export for.
TotalRentalDays
The total number of rental days for this reservation.
DailyRate
The average daily rate for this reservation.
InsuranceDailyRate
The daily rate for the insurance option that has been assigned to this reservation.
InsuranceID
The ID of the insurance option assigned to this reservation.
RentalSource
The rental source for this reservation.
PickupDatetime
The pickup date and time for this reservation.
The format for this field is yyyy-MM-dd hh:mm:ss
DropoffDatetime
the drop off date and time for this reservation.
The format for this field is yyyy-MM-dd hh:mm:ss
DropoffLocation
The location code of the drop off location for this reservation.
PickupLocation
The location code of the pickup location for this reservation.
DateEntered
The date and time this reservation was entered into RCM.
LastUpdateDate
The date and time this booking was last updated within RCM.
PaymentType
The payment type that has been assigned to this reservation.
BookingOperator
The name of the RCM operator who entered this reservation into RCM.
sBrand
The brand assigned to this reservation.
This field will only have a value returned if the Branding function is being used within the RCM system.
BookedCategoryType
The original category type that was assigned to this reservation when it was entered into RCM.
VehicleCategory
The original vehicle category that was assigned to this reservation when it was entered into RCM.
CarID (This could also be called VehilceID)
The unique identifier of the vehicle that has been allocated to this reservation. this matched the ID in the Vehicles export
CustomerID (This could also be called acID)
The unique identifier of the customer against this reservation. This matches the ID in the Customers export.
BookingAgency
The Agent that has been assigned to this reservation.
CompanyName
The Company Name that has been assigned to this reservation.
CustomerEmail
The customer email address that has been saved against this reservation.
CustomerFirstName
The first name of the customer against the reservation.
CustomerLastName
The last name of the customer against the reservation.
DOB
The customer's date of birth.
Phone
The customer's phone number.
Mobile
The customer's mobile number.
Country
The customer's country.
StampDuty
Any Stamp Duty that has been calculated and charged for the booking.
GST
The GST amount of the reservation.
Statestax
Any Stamp Duty that has been calculated and charged for the booking.
StatesTax_GLCode
The GL Code that has been assigned to Stamp Duty within the RCM system.
SalesTax
The GST amount of the reservation.
SalesTax_GLCode
Teh GL Code that has been assigned to GST within the RCM system.
AgentCommission
The Agent Commission amount for this reservation.
AgentCollected
The amount of money the Agent collected for this reservation.
KmsOut
The amount of Kms on the odometer of the vehicle when it was hired out.
KmsIn
The amount of Kms on the odometer of the vehicle when it was returned.
FuelOut
The fuel level in the tank when the vehicle was hired out.
FuelIn
the fuel level in the tank when the vehicle was returned.
AgenyBranch
The Agency Branch name that has been assigned to this reservation.
AgencyBranchContact
The contact name of the agency branch assigned to this reservation.
AgentBranchEmail
The email address for the agency branch assigned to this reservation.
ReferenceNo
The reference number saved against this reservation.
Closed
 A flag to show whether this reservation has been closed or not. A reservation can only be closed if it has been returned and it has a balance owing of $0.
Date Closed
The date and time the reservation was closed.
BookingTotal
The total cost for the reservation.
ActualCategoryType
The category type that is currently against this reservation. 
ActualCategory
The vehicle category that is currently against this reservation.
ExtraRevenue
The total cost of any extra fees against the reservation.
CancellationReason
The cancellation reason that was assigned when the reservation was cancelled.
DateCancelled
The date and time the reservation was cancelled.
CancelOperator
The name of the RCM Operator who cancelled this reservation.
ReservationRef
This is a unique identifier for this reservation which is used by the various APIs. 
If a booking started as an unallocated booking and then was allocated a vehicle, this value is the same for both of these.
CampaignCode
The campaign code that was used when making this booking.
IsNonRevenueBooking
A boolean flag to show if the booking is a Non Revenue Booking or not.

Locations

Return all information about a renting location.

Method Information:

method = "location"

Example call - {URL}?key={key}&method=location&lid=2

Restrictions: May be called once per day. May be called more times if a specific item id is passed in

Inputs:

Parameter
Description
lid
An integer value for the location id to restrict the export to. 
A value of 0 will return all locations.

Outputs:

Field
Description
ID
A unique identifier for the location.
LocationName
The location name.
CityCode
The location code that has been set for this location.
Country
The country that has been saved against this location.
City
The city that has been saved against this location.

Return to top

Season

Returns all of the seasons.
Method Information:
method = "season"

Example call - {URL}?key={key}&method=season

Restrictions: May be called once per day. 
Inputs:
There are no additional parameters for this call
Outputs:

Field
Description
ID
A unique identifier for this season.
Season
The name of the season.
LocationID
The ID of the location that has been associated with this season.
StartDate
The start date for this season
EndDate
The end date for this season.
notActive
A flag when shows if the season is active or not.
  1. 0 - the season is active.
  2. 1 - the season is not active.

Agencies

Exports all agency data
Method Information:
method = "agency"

Example call - {URL}?key={key}&method=agency

Restrictions: May be called once per day. 
Inputs:
There are no additional parameters for this call
Outputs:

Field
Description
AgencyID
A unique identifier for the Agent.
AgencyDiscountID
The unique identifier for the rate discount that has been assigned to the agent.
AgencyCommissionType
The commission type that has been assigned to the agent.
The values are:
  1. p - percentage
  2. d - dollars
AgencyName
The agent name.
AgencyCode
The code that has been assigned to the agent.
AgencyLocationID
This is an out-dated field and can be ignored.
AgencyCity
The name of the city that has been assigned to the agent.
AgencyAddress
The street address that has been saved against this agent.
AgencySuburb
The suburb that has been saved against this agent.
AgencyState
The state that has been saved against this agent.
AgencyPostCode
The post code that has been saved against this agent.
AgencyEmail
The email address that has been saved against this agent.
AgencyCountry
The country that has been saved against this agent.
AgencyContact
The contact name that has been saved against this agent.
AgencyNotes
Any notes that have been saved against this agent.
AgencyIsNotActive
A flag which states if an agent is active or not.
  1. 0 - means active
  2. 1 - means not active
AgencyRateTypeID
The unique identifier of the Agent Rate Type that has been assigned to this Agent Branch.
AgenyRateType
The name of the agent rate type that has been assigned to this Agent Branch.
IsWholesaleAgency
A flag that state whether this is a wholesale agent or not.
AgencyWSAvailable
A flag that states whether this agent branch will be able to have access via the Agent API.
An Agent API key will still need to be setup. this just allows you to turn their access off if you want to.
AgencyBranchID
A unique identifier of the Agent Branch.
AgencyBranchDiscountID
A unique identifier for the Discount that has been assigned to this agent branch.
AgencyBranchIsNotActive
A flag which states if the agent branch is active or not.
  1. 0 - means active
  2. 1 - means not active
AgencyBranchCommissionType
The commission type that has been assigned to the agent branch.
The values are:
  1. p - percentage
  2. d - dollars
AgencyBranchName
The name of the agent branch.
AgencyBranchCode
The code that has been assigned to the agent branch.
AgencyBranchCommission
The amount of commission that will be applied for this agent branch.
AgencyBranchCity
The name of the city that has been assigned to the agent branch.
AgencyBranchAddress
The street address that has been assigned to the agent branch.
AgencyBranchSuburb
The suburb that has been assigned to the agent branch.
AgencyBranchState
The state that has been assigned to the agent branch.
AgencyBranchPostCode
The post code that has been assigned to the agent branch.
AgencyBranchEmail
The email address that has been assigned to the agent branch.
AgencyBranchContact
The contact name that has been assigned to the agent branch.
AgencyBranchNotes
The notes that have been saved against the agent branch.
AgencyBranchCountry
The country that has been assigned to the agent branch.
AgencyBranchRegionID
A unique identifier for the region that has been assigned to the agent branch.
AgencyBranchRegion
The region that has been assigned to the agent branch.
AgencyBranchPaymentTypeID
A unique identifier for the payment type that has been associated with the agent branch. This payment type is used by RCM to determine the "Agent Collected" amount for an agent booking.
The values and their meaning are as follows:
  1. 1 - Full payment
  2. 2 - Commission Only
  3. 3 - Zero Payment
  4. 4 - Commission Items
  5. 5 - Rates Only

Booking Extra Fees

Returns the extra fees applied to a particular reservation, location or across a date range. Does not include bonds or insurances
Method Information:
method = "bookingextrafees"

Example call - {URL}?key={key}&method=bookingextrafees&lid=2&sd=20150501-0000&ed=20150502-0000&res=10232

Restrictions: Date range is maximum 1 day. May be called up to 6 times per day, where hours are specified. May be called more times if a specific reservation no is passed in
Inputs:

Parameter
Description
lid
An integer for the location ID which will restrict the export to a particular location.
A value of 0 returns all locations.
res
An integer for the reservation number to restrict report by.
A value of 0 returns all reservations.
Note a value in this field will be matched against both allocated reservation numbers and unallocated reservation numbers. The returned data will indicate which field was matched.
sd
Start date - bookings altered on or after this date will be returned. 
String format is yyyyMMdd-HHmm.
ed
End date - bookings altered on or before this date will be returned.
String format is yyyyMMdd-HHmm

Outputs:

Field
Description
ExtraFeesID
A unique identifier for the extra fee.
Name
The name of the extra fee
ReservationNo
Unique ID for this reservation. This is the reservation number for the allocated booking.
If this reservation has not been allocated to a vehicle, then this field will have a value of 0.
UnallocatedReservationNo
Unique ID for the reservation. This is not the same value as the ReservationNo. This is the unallocated booking number.
Some reservations will have a 0 value in this field. If they were created as an allocated booking, rather than an unallocated booking and then had a vehicle allocated.
ExtraDailyRate
The average daily cost of the extra fee for this reservation. 
This is calculated by the total cost of the fee divided by the number of rental days.
Days
The number of days for this reservation.
GLCode
The GL Code that has been assigned to the extra fee within the RCM system.

Return to top

Reservation Rate Details

Returns the reservation rate details applied to a particular reservation, location or across a date range. 

As there may be more than one season applied to a booking, there may be more than record returned for a reservation. Each season will have it's own record returned.
Method Information:
method = "paymentdetails"

Example call - {URL}?key={key}&method=paymentdetails&sd=20150501-0900&ed=20150502-0900&lid=1&res=10231

Restrictions: Date range is maximum 1 day. May be called up to 6 times per day, where hours are specified. May be called more times if a specific reservation no is passed in
Inputs:

Parameter
Description
sd
Start date - bookings rates altered on or after this date will be returned. 
String format is yyyyMMdd-HHmm.
ed
End date – bookings rates altered on or before this date will be returned.
String format is yyyyMMdd-HHmm
res
 An integer for the reservation number to restrict report by.
A value of 0 returns all reservations.
Note a value in this field will be matched against both the allocated reservation number and the unallocated reservation number. Returned data will indicate which field was matched.
lid
An integer for the location id to restrict report by (as pickup location).
A value of 0 returns all locations.

Outputs:

Field
Description
ReservationNo
Unique ID for this reservation. This is the reservation number for the allocated booking.
If this reservation has not been allocated to a vehicle, then this field will have a value of 0.
UnallocatedReservationNo
Unique ID for the reservation. This is not the same value as the ReservationNo. This is the unallocated booking number.
Some reservations will have a 0 value in this field. If they were created as an allocated booking, rather than an unallocated booking and then had a vehicle allocated.
Days
The number of days being charged.
Rate
The rate that is being charged. This is a daily rate.
SeasonID
A unique identifier for the season this rate applies for.
Rate Name
The rate name being applied. This name explains the type of rate.
The values being returned are:
  1. daily 
  2. monthly rate
  3. weekly rate
  4. extented
StandardRate
The rate being applied. This is rate before any discounts are applied.
DiscountPerc
The discount rate to be applied to the rental rate.
How you apply this depends upon the DiscountType returned.
DiscountID
A unique identifier for the discount applied.
DiscountType
The discount type being applied.
The value are:
  1. p - percentage discount
  2. d - daily discount
DiscountNmae
The name of the discount being applied.
TripRates
This is an out-dated field, it can be ignored.
ExtendRate
A flag to show whether this rate is an extended rate or not.
An extended rate is applied to a booking if it is extended after it has been hired out.
NoHours
If this is an hourly or a part-day rate, this will be shown here.

Return to top

Reservation Payment Details

Get reservation payment details across a date range

Method Information:
method = "respayment"

Example call - {URL}?key={key}&method=respayment&sd=20150501-0900&ed=20150502-0900

Restrictions: Date range is maximum 1 day. May be called up to 6 times per day, where hours are specified. May be called more times if a specific reservation no is passed in.
Inputs:

Parameter
Description
sd
Start date - bookings altered on or after this date will be returned. 
String format is yyyyMMdd-HHmm.
ed
End date - bookings altered on or before this date will be returned.
String format is yyyyMMdd-HHmm

Outputs:

Field
Description
PaymentID
A unique identifier for the payment.
ReservationNo
Unique ID for this reservation. This is the reservation number for the allocated booking.
If this reservation has not been allocated to a vehicle, then this field will have a value of 0.
UnallocatedReservationNo
Unique ID for the reservation. This is not the same value as the ReservationNo. This is the unallocated booking number.
Some reservations will have a 0 value in this field. If they were created as an allocated booking, rather than an unallocated booking and then had a vehicle allocated.
BillingLocationID
The location ID for the location the payment was recorded at. 
PaymentType
The type of payment.
This matches to one of the tender types that you have setup in your RCM system.
Unless it is an amount collected by an agent, then it will be "Agent Collected".
Paid
The amount of money taken as a payment.
PaymentDate
The date recorded as the payment date. 
as when a payment is entered, the operator can change the payment date, this may be different to the date the payment was actually recorded in RCM.
LoginID
The ID of the operator who recorded the payment.
CashReceiptName
This indicates whether the payment was recorded using the Cash Receipts function. the Cash Receipts function allows for the recording of a payment after the booking was closed.
If the value "Cash Receipts" is in this field, the payment was recorded using the Cash Receipts function.
OtherExtraDesc
The Reference value entered when recording the payment.
DMYCreated
The date/time the payment was recorded in the RCM system. This may be different to the PaymentDate as the operator can adjust the PaymentDate when recoding the payment.
InvPaymentID
If the invoicing function is being used and the payment is for an invoice, the invoice number will be recorded here.
loginIP
The IP address of the user who made the payment, if recorded.
PaymentTokenID
If the payment was taken using a Payment Gateway, the payment token will be recorded here.

Return to top

Reservation Notes

Get notes recorded against reservations, either by a date range (last updated) or specific reservation number

Method Information:
method = "resnotes"

Example call - {URL}?key={key}&method=resnotes&res=0&sd=20180501-0900&ed=20180502-0900

Restrictions: Date range is maximum 1 day. May be called up to 6 times per day, where hours are specified. May be called more times if a specific reservation no is passed in
Inputs:

Parameter
Description
res
An integer for the reservation number to restrict report by.
A value of 0 returns all reservations.
Note a value in this field will be matched against allocated reservation numbers and unallocated reservation numbers. Returned data will indicate which field was matched.
sd
Start date - notes altered on or after this date will be returned.  String format is yyyyMMdd-HHmm
ed
End date - notes altered on or before this date will be returned. String format is yyyyMMdd-HHmm

Outputs:

FieldDescription
NotesID
A unique identifier for the Note.
ReservationNo
Unique ID for this reservation. This is the reservation number for the allocated booking.
If this reservation has not been allocated to a vehicle, then this field will have a value of 0.
UnallocatedReservationNo
Unique ID for the reservation. This is not the same value as the ReservationNo. This is the unallocated booking number.
Some reservations will have a 0 value in this field. If they were created as an allocated booking, rather than an unallocated booking and then had a vehicle allocated.
Priority
The priority that has been assigned to this note.
Values:
  1. High
  2. Medium
  3. Low
Status
The status of the note.
Values:
  1. Active
  2. Closed
Subject
The subject assigned to the note. 
DateEntered
The date the note was entered.
EnteredByID
The ID of the RCM Operator who entered the note.
LastUpdated
The date the note was last updated.
LastUpdatedByID
The ID of the RCM Operator who last updated the note.
FollowUpOperatorID
The ID of the RCM operator who has been assigned as the follow-up operator on the note.
Notes
The note.

Return to top

Customers

Returns customer details by customer id and/or date range for last updated or last hired.

Method Information:

method = "customer"

Example call - {URL}?key={key}&method=customer&cid=0&sd=20170101-0900&ed=20170102-0900

Restrictions: Date range is maximum 1 day. May be called up to 6 times per day, where hours are specified. May be called more times if a specific customer id is passed in
Inputs:

Parameter
Description
cid
An integer customer id to restrict the report by. 
A value of 0 returns all customers.
sd
Start date - customer records or last hire dates altered on or after this date will be returned. 
String format is yyyyMMdd-HHmm.
ed
ed = End date - customer records or last hire dates altered on or before this date will be returned.
String format is yyyyMMdd-HHmm.

Outputs:

Field
Description
acID
A unique identifier for the customer.
acFirstName
The customer's first name.
acLastName
The customer's last name.
acDOB
The customer's date of birth.
Occupation
the occupation that has been saved against the customer.
acPostalAddress
The postal address of the customer.
acCity
The city that has been saved against the customer.
acState
The state that has been saved against the customer.
acPostcode
The post code that has been saved against the customer.
Country
The customer's country.
acPhone
The customer's phone number.
acMobile
The customer's mobile phone number.
acEmail
The email address saved against the customer.
acMaillist
A flag to state whether the customer is to be included on the mailing list.
acLastUpdateDate
The date the customer was last updated within RCM.
acLastHireDate
The last date the customer had a booking in RCM that went out on hire.
LicenseIssued
The country of Issue for the customer's driver's license.
LicenseNo
The customer's driver's license number.
PassportNo
The customer's passport number.

Return to top

Extra Items

Returns all extra items and insurances.
Method Information:

method = "extraitem"

Example call - {URL}?key={key}&method=extraitem&eid=2

Restrictions: May be called once per day. May be called more times if a specific item id is passed in
Inputs:

Parameter
Description
eid
An integer for the extra item ID to restrict the report to. 
A value of 0 returns all items.

Outputs:

Field
Description
ID
A unique identifier for the extra or insurance fee.
ExtraType
The type of extra.
Values:
  1. Insurance
  2. Extra Item
CategoryType
The category Type that has been assigned to this extra. If none has been assigned, this will return empty.
Having a value here means that this extra will only apply to reservations for this category type.
Category
The vehicle category that has been assigned to this extra. If none has been assigned, this will return empty.
Having a value here means that this extra will only apply to reservations for this vehicle category.
Description
The name of the extra/insurance fee.
MaxPrice
The maximum price that will be charged for the fee
Rate
The rate for the fee.
ExcessFee
If this is an insurance fee, the excess fee.
RateType
The type of rate that is charged for this fee.
Values:
  1. Daily
  2. Percentage
  3. Fixed

Rental Source

Returns all items from the Rental Source list.
Method Information:
method = "rentalsource"

Example call - {URL}?key={key}&method=rentalsource&rid=2

Restrictions: May be called once per day. May be called more times if a specific rental source id is passed in
Inputs:

Parameter
Description
rid
An integer for the rental source id to restrict report by. 
A value of 0 returns all rental sources.

Outputs:

Field
Description
ID
A unique identifier for the rental source
RentalSource
The Rental Source 
LocationID
The ID of the location that has been assigned to this rental source.
If a location has not been assigned, this value will be 0.

Return to top

RCM Operators (Sales Representatives)

Gets data about all active RCM users.
Method Information:

method = "salesrep"

Example call - {URL}?key={key}&method=salesrep&uid=2

Restrictions: May be called once per day. May be called more times if a specific user id is passed in
Inputs:

Parameter
Description
uid
An integer value for the userid to retrict the report by.
A value of 0 returns all active users.

Outputs:

Field
Description
ID
A unique identifier for the user.
LocationID
The location ID for the location that has been assigned to the user.
AccessLevel
The access level that has been assigned to the user.
Values:
  1. Head Office
  2. Head Office Operator
  3. Location Manager
  4. Location Operator
UserName
The username assigned to this Operator.
FirstName
The operator's first name.
LastName
The operator's last name
UserEmail
The operator's email address.

Vehicle Service Records

Gets data about periodic or manual services for vehicles. The services updated within the date range entered will be returned.
Method Information:
method = "service"

Example call - {URL}?key={key}&method=service&sd=20150501&ed=20150502&lid=1

Restrictions: Date range is maximum 1 day. May be called once per day, per location.
Inputs:

Parameter
Description
sd
Start date - service records entered or closed on or after this date will be returned.  String format is yyyyMMdd.
ed
End date – service records entered or closed on or before this date will be returned. String format is yyyyMMdd.
lid
An integer for the location ID to restrict the report by.
A value of 0 will return all locations.

Outputs:

Field
Description
VehicleServiceID
A unique identifier for the service record.
Branch
The location that has been assigned to this service. This is the location code.
RegistrationNo
The registration number for the vehicle.
FleetNo
The fleet number for the vehicle
SupplierName
The supplier name assigned to this service.
ServiceName
The service name of this service.
Service
An indication of whether this was a manual or a PM service.
Values:
  1. Manual
  2. PM
ServiceType
The service type assign to this service.
UnitsCompleted
The odometer of the vehicle when this service was recorded. 
This will either be in Kms or Miles depending on the setup of your RCM system.
LabourCost
The labour cost for this service.
PONo
The PO (Purchase Order) number for this service.
Notes
Any notes saved against this service.
InvoiceNo
The invoice number saved against this service.
Taxes
Any taxes recorded for this service.
ServiceCompleted
A flag to show whether the service has been completed or not.
CreatedByID
The ID of the RCM operator that recorded this service.
AuthorisedBy
The name of the person who authorised this service.
dateupdated
The date this service was last updated.
DateCompleted
The date this service was flagged as completed.
InvoiceDate
The invoice date recorded against this service.
ServiceCompleted
A flag to show whether the service has been completed or not.
DateClosed
The date the service was closed.
iGstAmount
The GST amount for this service.
NetCost
The net cost of this service.
The net cost is the Cost minus GST.
Cost
The cost of this service.

Return to top

On Road Repairs

Returns any On Road Repairs that have been recorded during the date range entered.
Method Information:
method = "onroad"

Example call - {URL}?key={key}&method=service&sd=20150501&ed=20150502

Restrictions: Date range is maximum 1 day. May be called once per day, per location. 
Inputs:

Parameter
Description
sd
Start date - repair records entered on or after this date will be returned.  String format is yyyyMMdd.
ed
End date – repair records entered on or before this date will be returned. String format is yyyyMMdd.

Outputs:

Field
Description
OnRoadRepairID
A unique identifier for the on road repair.
ReservationNo
The reservation number the repair was recorded against.
Rego
The registration number of the vehicle the repair was recorded against.
CustomerID
The customer ID for the customer recorded against the repair.
CustomerName
The name of the customer recorded against the repair.
DateCreated
The date the repair was entered into the system.
EnteredByID
The operator ID of the RCM operator who entered the repair into the system.
ProblemType
The problem type recorded against the repair.
ProblemDesc
A decsription of the problem.
Closed
A flag to show if the repair has been closed or not.

Return to top

Maintenance Bookings

Returns data about maintenance bookings with either a pick up or drop off date within the date range entered. They can also be restricted by by location and also if they have been cancelled.

Method Information:
method = "maintenance"

Example call - {URL}?key={key}&method=maintenance&lid=1&sd=20150501-0900&ed=20150502-0900&cancelled=1

Restrictions: Date range is maximum 1 day. May be called once per day, per location. 
Inputs:

Parameter
Description
sd
Start date - repair records entered on or after this date will be returned.  String format is yyyyMMdd-HHmm.
ed
End date – repair records entered on or before this date will be returned. String format is yyyyMMdd-HHmm.
lid
An integer for the location id to restrict report by (as pickup location). 
A value of 0 returns all locations.
cancelled
A flag to include cancelled bookings.
Will include them if the value is 1.
Any other value or no value will not return cancelled bookings.

Outputs:

Field
Description
ReservationNo
The reservation number of the maintenance booking
CategoryType
the category type associated with the booking.
Model
The model of the vehicle associated with the booking.
Rego
The registration number of the vehicle associated with the booking.
FleetNo
The fleet number of the vehicle associated with the booking.
Repairer
The customer's last name recorded on the booking.
CarID
The unique identifier for the vehicle.
notes
Any notes that were added to the booking.
PickupLocationID
The pickup location ID for the booking.
PickupLocation
The pickup location for the booking.
DropoffLocationID
The drop off location ID for the booking.
DropoffLocation
The drop off location for the booking.
PickupDateTime
The pickup date and time for the booking.
DropoffDateTime
The drop off date and time for the booking.
Status
The status of the booking.
LastUpdated
The date the booking was last updated.

Return to top

Agent Payments

Returns data about payments from and to Agents that were recorded during the date range entered.
Method Information:
method = "agentpayment"

Example call - {URL}?key={key}&method=agentpayment&sd=20150501&ed=20150502

Restrictions: Date range is maximum 1 day. May be called once per day. 
Inputs:

Parameter
Description
sd
Start date - payments entered on or after this date will be returned.  String format is yyyyMMdd.
ed
End date – payments entered on or before this date will be returned. String format is yyyyMMdd.

Outputs:

Field
Description
AgentPaymentID
A unique identifier for the agent payment.
ReservationNo
Unique ID for this reservation. This is the reservation number for the allocated booking.
If this reservation has not been allocated to a vehicle, then this field will have a value of 0.
UnallocatedReservationNo
Unique ID for the reservation. This is not the same value as the ReservationNo. This is the unallocated booking number.
Some reservations will have a 0 value in this field. If they were created as an allocated booking, rather than an unallocated booking and then had a vehicle allocated.
BillingLocationID
The location ID for the location the payment was recorded against.
PaymentType
The payment type. This is one of the tender types that have been setup in the RCM system.
PaymentDate
The date the payment was recorded.
CreatedByID
The ID of the RCM operator who recorded the payment.
Reference
The reference information that was recorded against the payment.
PaymentFromAgent
The amount of money that the agent paid to the rental car company.
PaymentToAgent
The amount of money the rental car company paid to the agent.

Agent Rates

Returns the seasonal agents rates for the date range specified.
It is important to note the following:
  1. This method can only be run by an Export API key that has been created for an Agent. Only the rates relevant to the agent will be returned.
  2. This is the only method that an "Agent" Export API key with have access to.
Method Information :
method = "agentrates"

Example call - {URL}?key={key}&method=agentrates&sd=20180101&ed=20180201

Restrictions: Date range is maximum 62 days, or 2 months. May be called up to 12 times per day.
Inputs:

Parameter
Description
sd
Start date - rates for seasons starting on or after this date will be returned.  String format is yyyyMMdd.
ed
End date – rates for seasons ending on or before this date will be returned. String format is yyyyMMdd.

Outputs:

Field
Description
sFromDay
The starting number of days for the booking period this rate will apply to. This applies to the rental days of the booking,
A sFromDay of 1 and a sEndDay of 3, means that any booking between 1-3 days in length will have this rate applied.
sToDay
The ending number of days for the booking period this rate will apply to. This applies to the rental days of the booking,
A sFromDay of 1 and a sEndDay of 3, means that any booking between 1-3 days in length will have this rate applied.
sStartDate
The start date for the date range this rate will apply to.
sEndDate
The end date for the date range this rate will apply to.
Location
The location this rate will apply to.
VehicleCategoryID
The category ID this rate will apply to.
VehicleCategory
The category name this rate will apply to.
Rate
The rental rate.

Return to top

Web Rates

Returns a listing of the seasonal rates for the date range entered. This can be restricted to one location.
Method Information:
method = "webrates"

Example call - {URL}?key={key}&method=webrates&lid=0&sd=20210501&ed=20210502

Restrictions: Date range is maximum 62 days, or 2 months. May be called up to 12 times per day.
Inputs:

Parameter
Description
lid
An integer or the lcoation ID to restrict this report to. This is used as the pickup location.
A value of 0 returns all locations.
sd
Start date - rates for seasons starting on or after this date will be returned.  String format is yyyyMMdd.
ed
End date – rates for seasons ending on or before this date will be returned. String format is yyyyMMdd.

Output:

Field
Description
VehicleCategoryID
The category ID for this rate.
VehicleCategory
The category name for this rate
LocationID
The location ID for this rate. This applies to the pickup location.
LocationCode
The location Code for this rate.
Location
The location name for this rate.
SeasonID
The season ID for this rate.
Season
The season name for this rate.
SeasonStartDate
The start date of the season.
SeasonEndDate
The end date of the season.
FromDay
The starting number of days for the booking period this rate will apply to. This applies to the rental days of the booking,
A FromDay of 1 and a EndDay of 3, means that any booking between 1-3 days in length will have this rate applied.
ToDay
The ending number of days for the booking period this rate will apply to. This applies to the rental days of the booking,
A FromDay of 1 and a EndDay of 3, means that any booking between 1-3 days in length will have this rate applied.
Rate
The rental rate.

Reservation Custom Fields

Returns the customs fields for the date rage entered or for a particular reservation. This report can also be restricted to a particular location.
Method Information:
 
method = "bookingcustomfields" 

Example Call:
  1. by reservation: {URL}?key=<yourAPIKey>&method=bookingcustomfields&lid=0&res=<yourreservationno>
  2. by update date range (searches on whether the reservation has been updated, which may or may not include custom field updates):
    {URL}?key=<yourAPIKey>&method=bookingcustomfields&lid=0&res=0&sd=<start datetime yyyyMMdd-HHmm>&ed=<end datetime yyyyMMdd-HHmm>
Inputs:

Paremeter
Description
lid
An integer for the location ID which will restrict the export to a particular location.
A value of 0 returns all locations.
res
An integer for the reservation number to restrict report by.
A value of 0 returns all reservations.
Note a value in this field will be matched against both allocated reservation numbers and unallocated reservation numbers. The returned data will indicate which field was matched.
sd
Start date - bookings altered on or after this date will be returned. 
String format is yyyyMMdd-HHmm.
ed
End date - bookings altered on or before this date will be returned. 
String format is yyyyMMdd-HHmm.

Outputs:

Field
Description
FieldName
The name of the custom field.
FieldDescription
The description of the custom field
FieldValue
The value that has been saved for this custom field.
UnallocatedReservationNo
Unique ID for the reservation. This is not the same value as the ReservationNo. This is the unallocated booking number.
Some reservations will have a 0 value in this field. If they were created as an allocated booking, rather than an unallocated booking and then had a vehicle allocated.
ReservationNo
Unique ID for this reservation. This is the reservation number for the allocated booking.
If this reservation has not been allocated to a vehicle, then this field will have a value of 0.
ReservationRef
This is a unique identifier for this reservation which is used by the various APIs. 
If a booking started as an unallocated booking and then was allocated a vehicle, this value is the same for both of these.

Return to top

    Important Articles


      • Related Articles

      • Getting Started with Export API

        Overview Rental Car Manager offers an Export API to export certain datasets. There is a cost to set up these APIs, please contact RCM support (support@rentalcarmanager.com) for more information. Instructions for Use All data can be retrieved by ...

      • Useful API V3.2 Methods

        Overview As well as the methods which are used in the Booking Process, there are other methods which are part of the API V3.2. They are all discussed below. Editing a Booking or Quotation Post-booking methods are available to edit booking details ...

      • Useful Post Booking API Methods

        Overview As well as the methods which are used in the Post Booking Process, there are other methods which are part of the Post Booking API. They are all discussed below. Get Location Details (locationdetails) The locationdetails method can be used to ...

      • Infringement API

        Introduction The Infringement API can be used to look up vehicle and driver details for infringements such as traffic fines. You can also use it to record infringement details against a reservation, add a fee, and take a payment where applicable. ...

      • API V3.2 Booking Process

        Overview The RCM API and Agent API allow you to make unallocated bookings for a specified vehicle category, for a specified pickup and drop off date. An unallocated booking is a booking that has been made for a particular category (e.g. small car), ...