POST api/v1/Quotes

Obtain a detailed quote from the system based on the given parameters.

Request Information

URI Parameters

None.

Body Parameters

Based on this input a price for the journey will be calulated

Name	Description	Type	Additional information
AccountCode	This account code specifies under which TBR client the job is to be created. Could be an integer, ie one of 2573, 7070, 7165, 7145 or any other identifier	string	Required
TotalTime	Total hours the car is needed for in minutes (if known)	integer	None.
TotalMileage	Total distance the car is needed for (if known)	decimal number	None.
Currency	Leave blank to receive the rates in all enabled currencies OR specify one. IsoCode, e.g. USD, GBP, EUR, .. If you specify a currency that is not supported, no rate can be produced.	string	None.
GroupBookingName	If requesting rates for a particular event, please specify the event / groupbooking name here so the rate you receive is in line with the agreed rate.	string	None.
ContextJobID	When producing a quote for an exisiting job, provide the jobID here so the back-end knows to apply rules for this scenario	integer	None.
RouteType	The type of job; Transfer or AsDirected. String from the Enum of RouteType	string	Required
ShareCar	Whether the booker wants to make the car available to other travellers from the same company	boolean	None.
Passengers	A list of all passengers.	Collection of Passenger	None.
Pickup	Pickup Details	Pickup	Required
Midpoints	A list of Stops / Midpoints	Collection of Midpoint	None.
Dropoff	Dropoff Details	Dropoff	Required
VehicleType	The requested vehicle type. String based on Enum in Constants.VehicleType	string	Required
ExpectedPassengerCount	Total expected number of Passengers.	integer	None.
UserDefinedFields	An arbitrary collection of keys and values, allowing you to pass in any number of references you wish. Will be included in the invoice	Collection of UserDefinedField	None.
VoucherCode	Voucher code to use	string	None.
SelectedExtras	A list of selected extras from the quote which you wish to include. These will be added to the price you are charged.	Collection of SelectedQuoteExtra	None.
ExtRefID	An external reference provided by you returned to you. This should not be visible to the end user and only serves the purpose to link up different system.	string	None.
ExtUserID	External User ID (for audit purposes) in the querying system.	string	Required

Request Formats

application/json, text/json

Sample:

{
  "accountCode": "sample string 1",
  "totalTime": 2,
  "totalMileage": 3.0,
  "currency": "sample string 4",
  "groupBookingName": "sample string 5",
  "contextJobID": 6,
  "routeType": "sample string 7",
  "shareCar": true,
  "passengers": [
    {
      "name": "sample string 1",
      "email": "sample string 2",
      "mobile": "sample string 3",
      "company": "sample string 4"
    },
    {
      "name": "sample string 1",
      "email": "sample string 2",
      "mobile": "sample string 3",
      "company": "sample string 4"
    }
  ],
  "pickup": {
    "dateTime": "2024-11-21T10:00:38.8383426+00:00",
    "tbc": true,
    "address": {
      "airportCode": "sample string 1",
      "addressLine1": "sample string 2",
      "addressLine2": "sample string 3",
      "addressLine3": "sample string 4",
      "postcode": "sample string 5",
      "city": "sample string 6",
      "country": "sample string 7",
      "state": "sample string 8",
      "longitude": 9.1,
      "latitude": 10.1,
      "postalAddress": "sample string 11",
      "googlePlaceID": "sample string 12",
      "googleUserInputAddress": "sample string 13",
      "locationType": "sample string 14"
    },
    "connection": {
      "connectionType": "sample string 1",
      "number": "sample string 2",
      "origin": "sample string 3",
      "destination": "sample string 4",
      "dateTime": "2024-11-21T10:00:38.8383426Z",
      "directionType": "sample string 5",
      "terminal": "sample string 6",
      "verified": true,
      "signatureFlight": true
    }
  },
  "midpoints": [
    {
      "dateTime": "2024-11-21T10:00:38.8383426+00:00",
      "address": {
        "airportCode": "sample string 1",
        "addressLine1": "sample string 2",
        "addressLine2": "sample string 3",
        "addressLine3": "sample string 4",
        "postcode": "sample string 5",
        "city": "sample string 6",
        "country": "sample string 7",
        "state": "sample string 8",
        "longitude": 9.1,
        "latitude": 10.1,
        "postalAddress": "sample string 11",
        "googlePlaceID": "sample string 12",
        "googleUserInputAddress": "sample string 13",
        "locationType": "sample string 14"
      }
    },
    {
      "dateTime": "2024-11-21T10:00:38.8383426+00:00",
      "address": {
        "airportCode": "sample string 1",
        "addressLine1": "sample string 2",
        "addressLine2": "sample string 3",
        "addressLine3": "sample string 4",
        "postcode": "sample string 5",
        "city": "sample string 6",
        "country": "sample string 7",
        "state": "sample string 8",
        "longitude": 9.1,
        "latitude": 10.1,
        "postalAddress": "sample string 11",
        "googlePlaceID": "sample string 12",
        "googleUserInputAddress": "sample string 13",
        "locationType": "sample string 14"
      }
    }
  ],
  "dropoff": {
    "dateTime": "2024-11-21T10:00:38.8383426+00:00",
    "address": {
      "airportCode": "sample string 1",
      "addressLine1": "sample string 2",
      "addressLine2": "sample string 3",
      "addressLine3": "sample string 4",
      "postcode": "sample string 5",
      "city": "sample string 6",
      "country": "sample string 7",
      "state": "sample string 8",
      "longitude": 9.1,
      "latitude": 10.1,
      "postalAddress": "sample string 11",
      "googlePlaceID": "sample string 12",
      "googleUserInputAddress": "sample string 13",
      "locationType": "sample string 14"
    },
    "connection": {
      "connectionType": "sample string 1",
      "number": "sample string 2",
      "origin": "sample string 3",
      "destination": "sample string 4",
      "dateTime": "2024-11-21T10:00:38.8383426Z",
      "directionType": "sample string 5",
      "terminal": "sample string 6",
      "verified": true,
      "signatureFlight": true
    }
  },
  "vehicleType": "sample string 9",
  "expectedPassengerCount": 10,
  "userDefinedFields": [
    {
      "key": "sample string 1",
      "value": "sample string 2",
      "visibility": "sample string 3"
    },
    {
      "key": "sample string 1",
      "value": "sample string 2",
      "visibility": "sample string 3"
    }
  ],
  "voucherCode": "sample string 11",
  "selectedExtras": [
    {
      "name": "sample string 1",
      "quantity": 2
    },
    {
      "name": "sample string 1",
      "quantity": 2
    }
  ],
  "extRefID": "sample string 12",
  "extUserID": "sample string 13"
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Returns a detailed breakdown on all charges for this quote as well as terms and conditions

JobQuote

Name	Description	Type	Additional information
JobQuoteID	Unique TBR Job Quote identifier	integer	None.
ReferenceNumber	Unique TBR Quote Reference, in the form of Q21-01234567	string	None.
Partner	Information about the provider / partner of the quote	Partner	None.
Pickup	Pickup Details	Pickup	None.
Midpoints	A list of Stops / Midpoints	Collection of Midpoint	None.
Dropoff	Dropoff details	Dropoff	None.
TsandCs	Terms and conditions (if applicable)	string	None.
ExpectedPassengerCount	Total expected number of Passengers.	integer	None.
UserDefinedFields	An arbitrary collection of keys and values, allowing you to pass in any number of references you wish. Will be included in the invoice	Collection of UserDefinedField	None.
JobQuoteDetails	List of available Quotes / Rates	Collection of JobQuoteDetail	None.
ExtRefID	An external reference provided by you returned to you. This should not be visible to the end user and only serves the purpose to link up different system.	string	None.

Response Formats

application/json, text/json

Sample:

{
  "jobQuoteID": 1,
  "referenceNumber": "sample string 2",
  "partner": {
    "name": "sample string 1",
    "address": {
      "airportCode": "sample string 1",
      "addressLine1": "sample string 2",
      "addressLine2": "sample string 3",
      "addressLine3": "sample string 4",
      "postcode": "sample string 5",
      "city": "sample string 6",
      "country": "sample string 7",
      "state": "sample string 8",
      "longitude": 9.1,
      "latitude": 10.1,
      "postalAddress": "sample string 11",
      "googlePlaceID": "sample string 12",
      "googleUserInputAddress": "sample string 13",
      "locationType": "sample string 14"
    },
    "email": "sample string 2",
    "websiteURL": "sample string 3",
    "bookingWebsiteURL": "sample string 4",
    "notesToBooker": "sample string 5",
    "notes": "sample string 6",
    "phone": "sample string 7"
  },
  "pickup": {
    "dateTime": "2024-11-21T10:00:38.8383426+00:00",
    "tbc": true,
    "address": {
      "airportCode": "sample string 1",
      "addressLine1": "sample string 2",
      "addressLine2": "sample string 3",
      "addressLine3": "sample string 4",
      "postcode": "sample string 5",
      "city": "sample string 6",
      "country": "sample string 7",
      "state": "sample string 8",
      "longitude": 9.1,
      "latitude": 10.1,
      "postalAddress": "sample string 11",
      "googlePlaceID": "sample string 12",
      "googleUserInputAddress": "sample string 13",
      "locationType": "sample string 14"
    },
    "connection": {
      "connectionType": "sample string 1",
      "number": "sample string 2",
      "origin": "sample string 3",
      "destination": "sample string 4",
      "dateTime": "2024-11-21T10:00:38.8383426Z",
      "directionType": "sample string 5",
      "terminal": "sample string 6",
      "verified": true,
      "signatureFlight": true
    }
  },
  "midpoints": [
    {
      "dateTime": "2024-11-21T10:00:38.8383426+00:00",
      "address": {
        "airportCode": "sample string 1",
        "addressLine1": "sample string 2",
        "addressLine2": "sample string 3",
        "addressLine3": "sample string 4",
        "postcode": "sample string 5",
        "city": "sample string 6",
        "country": "sample string 7",
        "state": "sample string 8",
        "longitude": 9.1,
        "latitude": 10.1,
        "postalAddress": "sample string 11",
        "googlePlaceID": "sample string 12",
        "googleUserInputAddress": "sample string 13",
        "locationType": "sample string 14"
      }
    },
    {
      "dateTime": "2024-11-21T10:00:38.8383426+00:00",
      "address": {
        "airportCode": "sample string 1",
        "addressLine1": "sample string 2",
        "addressLine2": "sample string 3",
        "addressLine3": "sample string 4",
        "postcode": "sample string 5",
        "city": "sample string 6",
        "country": "sample string 7",
        "state": "sample string 8",
        "longitude": 9.1,
        "latitude": 10.1,
        "postalAddress": "sample string 11",
        "googlePlaceID": "sample string 12",
        "googleUserInputAddress": "sample string 13",
        "locationType": "sample string 14"
      }
    }
  ],
  "dropoff": {
    "dateTime": "2024-11-21T10:00:38.8383426+00:00",
    "address": {
      "airportCode": "sample string 1",
      "addressLine1": "sample string 2",
      "addressLine2": "sample string 3",
      "addressLine3": "sample string 4",
      "postcode": "sample string 5",
      "city": "sample string 6",
      "country": "sample string 7",
      "state": "sample string 8",
      "longitude": 9.1,
      "latitude": 10.1,
      "postalAddress": "sample string 11",
      "googlePlaceID": "sample string 12",
      "googleUserInputAddress": "sample string 13",
      "locationType": "sample string 14"
    },
    "connection": {
      "connectionType": "sample string 1",
      "number": "sample string 2",
      "origin": "sample string 3",
      "destination": "sample string 4",
      "dateTime": "2024-11-21T10:00:38.8383426Z",
      "directionType": "sample string 5",
      "terminal": "sample string 6",
      "verified": true,
      "signatureFlight": true
    }
  },
  "tsandCs": "sample string 3",
  "expectedPassengerCount": 4,
  "userDefinedFields": [
    {
      "key": "sample string 1",
      "value": "sample string 2",
      "visibility": "sample string 3"
    },
    {
      "key": "sample string 1",
      "value": "sample string 2",
      "visibility": "sample string 3"
    }
  ],
  "jobQuoteDetails": [
    {
      "quoteRateID": 1,
      "cancellationPolicy": "sample string 2",
      "chargeExcess": 3.0,
      "chargeHire": 4.0,
      "chargeHoliday": 5.0,
      "chargeNight": 6.0,
      "chargeWaiting": 7.0,
      "chargeWeekend": 8.0,
      "chargeExcessDistance": 9.0,
      "chargeExcessTime": 10.0,
      "chargeTotalNet": 11.0,
      "chargeTotalGross": 12.0,
      "chargeTotalTaxAmount": 13.0,
      "totalSavings": 14.0,
      "discountHirePercentage": 15.0,
      "distanceAdjust": 16,
      "distanceBooked": 17,
      "distanceTotal": 18,
      "distanceUnit": "sample string 19",
      "distanceExcess": 20,
      "excessRateDistance": 21.0,
      "excessRateTime": 22.0,
      "currency": "sample string 23",
      "includedDistance": 24,
      "includedTime": "sample string 25",
      "timeAdjust": "sample string 26",
      "timeBooked": "sample string 27",
      "timeExcess": "sample string 28",
      "timeTotal": "sample string 29",
      "timeWaiting": "sample string 30",
      "vehicleType": "sample string 31",
      "vehicleModel": "sample string 32",
      "rateType": "sample string 33",
      "vehiclePhotoURL": "sample string 34",
      "canBeBooked": true,
      "maxVehiclePassengers": 36,
      "maxVehicleLuggage": 37,
      "availableCurrencies": [
        {
          "currencyCode": "sample string 1",
          "chargeExcess": 2.0,
          "chargeExcessGross": 3.0,
          "chargeExcessTaxAmount": 4.0,
          "chargeHire": 5.0,
          "chargeHireGross": 6.0,
          "chargeHireTaxAmount": 7.0,
          "chargeHoliday": 8.0,
          "chargeNight": 9.0,
          "chargeWaiting": 10.0,
          "chargeWeekend": 11.0,
          "chargeTotalNet": 12.0,
          "chargeTotalGross": 13.0,
          "chargeTotalTaxAmount": 14.0,
          "totalSavings": 15.0,
          "paymentMethods": [
            "sample string 1",
            "sample string 2"
          ],
          "extras": [
            {
              "name": "sample string 1",
              "price": 2.0,
              "chargeTotalNet": 3.0,
              "chargeTotalGross": 4.0,
              "chargeTotalTaxAmount": 5.0,
              "optional": true,
              "included": true
            },
            {
              "name": "sample string 1",
              "price": 2.0,
              "chargeTotalNet": 3.0,
              "chargeTotalGross": 4.0,
              "chargeTotalTaxAmount": 5.0,
              "optional": true,
              "included": true
            }
          ],
          "chargeHireTaxRate": 16.0
        },
        {
          "currencyCode": "sample string 1",
          "chargeExcess": 2.0,
          "chargeExcessGross": 3.0,
          "chargeExcessTaxAmount": 4.0,
          "chargeHire": 5.0,
          "chargeHireGross": 6.0,
          "chargeHireTaxAmount": 7.0,
          "chargeHoliday": 8.0,
          "chargeNight": 9.0,
          "chargeWaiting": 10.0,
          "chargeWeekend": 11.0,
          "chargeTotalNet": 12.0,
          "chargeTotalGross": 13.0,
          "chargeTotalTaxAmount": 14.0,
          "totalSavings": 15.0,
          "paymentMethods": [
            "sample string 1",
            "sample string 2"
          ],
          "extras": [
            {
              "name": "sample string 1",
              "price": 2.0,
              "chargeTotalNet": 3.0,
              "chargeTotalGross": 4.0,
              "chargeTotalTaxAmount": 5.0,
              "optional": true,
              "included": true
            },
            {
              "name": "sample string 1",
              "price": 2.0,
              "chargeTotalNet": 3.0,
              "chargeTotalGross": 4.0,
              "chargeTotalTaxAmount": 5.0,
              "optional": true,
              "included": true
            }
          ],
          "chargeHireTaxRate": 16.0
        }
      ],
      "extras": [
        {
          "name": "sample string 1",
          "price": 2.0,
          "chargeTotalNet": 3.0,
          "chargeTotalGross": 4.0,
          "chargeTotalTaxAmount": 5.0,
          "optional": true,
          "included": true
        },
        {
          "name": "sample string 1",
          "price": 2.0,
          "chargeTotalNet": 3.0,
          "chargeTotalGross": 4.0,
          "chargeTotalTaxAmount": 5.0,
          "optional": true,
          "included": true
        }
      ],
      "notes": "sample string 38",
      "disclaimers": [
        {
          "label": "sample string 1",
          "text": "sample string 2",
          "locale": "sample string 3"
        },
        {
          "label": "sample string 1",
          "text": "sample string 2",
          "locale": "sample string 3"
        }
      ],
      "taxLabel": "sample string 39",
      "chargeHireTaxRate": 40.0,
      "newBookingThresholdHours": 41,
      "updateBookingThresholdHours": 42,
      "cancelBookingThresholdHours": 43
    },
    {
      "quoteRateID": 1,
      "cancellationPolicy": "sample string 2",
      "chargeExcess": 3.0,
      "chargeHire": 4.0,
      "chargeHoliday": 5.0,
      "chargeNight": 6.0,
      "chargeWaiting": 7.0,
      "chargeWeekend": 8.0,
      "chargeExcessDistance": 9.0,
      "chargeExcessTime": 10.0,
      "chargeTotalNet": 11.0,
      "chargeTotalGross": 12.0,
      "chargeTotalTaxAmount": 13.0,
      "totalSavings": 14.0,
      "discountHirePercentage": 15.0,
      "distanceAdjust": 16,
      "distanceBooked": 17,
      "distanceTotal": 18,
      "distanceUnit": "sample string 19",
      "distanceExcess": 20,
      "excessRateDistance": 21.0,
      "excessRateTime": 22.0,
      "currency": "sample string 23",
      "includedDistance": 24,
      "includedTime": "sample string 25",
      "timeAdjust": "sample string 26",
      "timeBooked": "sample string 27",
      "timeExcess": "sample string 28",
      "timeTotal": "sample string 29",
      "timeWaiting": "sample string 30",
      "vehicleType": "sample string 31",
      "vehicleModel": "sample string 32",
      "rateType": "sample string 33",
      "vehiclePhotoURL": "sample string 34",
      "canBeBooked": true,
      "maxVehiclePassengers": 36,
      "maxVehicleLuggage": 37,
      "availableCurrencies": [
        {
          "currencyCode": "sample string 1",
          "chargeExcess": 2.0,
          "chargeExcessGross": 3.0,
          "chargeExcessTaxAmount": 4.0,
          "chargeHire": 5.0,
          "chargeHireGross": 6.0,
          "chargeHireTaxAmount": 7.0,
          "chargeHoliday": 8.0,
          "chargeNight": 9.0,
          "chargeWaiting": 10.0,
          "chargeWeekend": 11.0,
          "chargeTotalNet": 12.0,
          "chargeTotalGross": 13.0,
          "chargeTotalTaxAmount": 14.0,
          "totalSavings": 15.0,
          "paymentMethods": [
            "sample string 1",
            "sample string 2"
          ],
          "extras": [
            {
              "name": "sample string 1",
              "price": 2.0,
              "chargeTotalNet": 3.0,
              "chargeTotalGross": 4.0,
              "chargeTotalTaxAmount": 5.0,
              "optional": true,
              "included": true
            },
            {
              "name": "sample string 1",
              "price": 2.0,
              "chargeTotalNet": 3.0,
              "chargeTotalGross": 4.0,
              "chargeTotalTaxAmount": 5.0,
              "optional": true,
              "included": true
            }
          ],
          "chargeHireTaxRate": 16.0
        },
        {
          "currencyCode": "sample string 1",
          "chargeExcess": 2.0,
          "chargeExcessGross": 3.0,
          "chargeExcessTaxAmount": 4.0,
          "chargeHire": 5.0,
          "chargeHireGross": 6.0,
          "chargeHireTaxAmount": 7.0,
          "chargeHoliday": 8.0,
          "chargeNight": 9.0,
          "chargeWaiting": 10.0,
          "chargeWeekend": 11.0,
          "chargeTotalNet": 12.0,
          "chargeTotalGross": 13.0,
          "chargeTotalTaxAmount": 14.0,
          "totalSavings": 15.0,
          "paymentMethods": [
            "sample string 1",
            "sample string 2"
          ],
          "extras": [
            {
              "name": "sample string 1",
              "price": 2.0,
              "chargeTotalNet": 3.0,
              "chargeTotalGross": 4.0,
              "chargeTotalTaxAmount": 5.0,
              "optional": true,
              "included": true
            },
            {
              "name": "sample string 1",
              "price": 2.0,
              "chargeTotalNet": 3.0,
              "chargeTotalGross": 4.0,
              "chargeTotalTaxAmount": 5.0,
              "optional": true,
              "included": true
            }
          ],
          "chargeHireTaxRate": 16.0
        }
      ],
      "extras": [
        {
          "name": "sample string 1",
          "price": 2.0,
          "chargeTotalNet": 3.0,
          "chargeTotalGross": 4.0,
          "chargeTotalTaxAmount": 5.0,
          "optional": true,
          "included": true
        },
        {
          "name": "sample string 1",
          "price": 2.0,
          "chargeTotalNet": 3.0,
          "chargeTotalGross": 4.0,
          "chargeTotalTaxAmount": 5.0,
          "optional": true,
          "included": true
        }
      ],
      "notes": "sample string 38",
      "disclaimers": [
        {
          "label": "sample string 1",
          "text": "sample string 2",
          "locale": "sample string 3"
        },
        {
          "label": "sample string 1",
          "text": "sample string 2",
          "locale": "sample string 3"
        }
      ],
      "taxLabel": "sample string 39",
      "chargeHireTaxRate": 40.0,
      "newBookingThresholdHours": 41,
      "updateBookingThresholdHours": 42,
      "cancelBookingThresholdHours": 43
    }
  ],
  "extRefID": "sample string 5"
}