URL Expired

The URL for this request expired after 30 days.

id

integer

required

the contract ID

api-version

integer

required

Target API version

``200 Success

object

id

integer

required

database id of the contract

actual_pickup_at

date-time | null

required

actual_dropoff_at

date-time | null

required

booked_car_detailed_description

object

required

acriss_code

string

acriss_model_description

string

city_mpg

string

fuel_tank

string

hwy_mpg

string

luggage

string

make

string

model

string

passengers

string

style

string

type

string

year

string

booked_by_name

string | null

required

booking_application

string | null

required

Client application type that created the reservation (e.g. web, iphone-appstore, scheduler).

booking_channel

string | null

required

Partner integration source for the booking (e.g. mykaarma, xtime, redcap, toyota-oneapp) or dealerware for Dealerware-native bookings.

capabilities

object

required

payments

object

payments object

confirmation_token

string

required

also referred to as contract id

contactless

boolean

required

denotes whether or not the contract is a contactless contract

created_at

date-time

required

daily_rate_override

number

required

The daily rate to charge for this contract, if different from the default rate for the vehicle

damage_inspections

array of objects

required

Damage inspection statuses for the active car reservations on this contract.

damage_inspections*

object

vehicle_id

integer

required

The vehicle ID for the associated car reservation.

status

string

required

The status of the associated damage inspection. Returns not_inspected

when no damage inspection exists for that car reservation.

pdf_report_url

uri | null

required

The URL for the attached damage inspection PDF report, if present.

Returns null when no PDF report has been attached for that car reservation.

external_deposit_amount

number | null

required

The amount of the external deposit, if any, that was collected for this contract

finished_by_name

string | null

required

fuel

object

required

starting_fuel_gallons

number | null

Fuel amount at the start of the contract in gallons

starting_fuel_liters

number | null

Fuel amount at the start of the contract in liters

ending_fuel_gallons

number | null

Fuel amount at the end of the contract in gallons

ending_fuel_liters

number | null

Fuel amount at the end of the contract in liters

starting_fuel_percentage

float | null

Starting fuel as a percentage of the tank capacity

ending_fuel_percentage

float | null

Ending fuel as a percentage of the tank capacity

location_sequence

integer

required

sequence id of the contract for its location

odometer

object

required

starting_odometer_miles

number | null

Odometer reading at the start of the contract in miles

starting_odometer_km

number | null

Odometer reading at the start of the contract in kilometers

ending_odometer_miles

number | null

Odometer reading at the end of the contract in miles

ending_odometer_km

number | null

Odometer reading at the end of the contract in kilometers

purchase_order

string | null

required

The optional purchase order number associated with this contract

repair_order

string | null

required

The optional repair order sent from a contract creation request

service_vehicle_id

string | null

required

The optional service vehicle ID sent from a contract creation request

service_vehicle_id_valid

boolean

Whether the service vehicle ID is a valid VIN

status

string

enum

required

booked``cancelled``pending_agreement``started``finished``no_showed

scheduled_pickup_at

date-time

required

scheduled_dropoff_at

date-time

required

service_advisor_name

string | null

required

service_advisor_id

integer | null

required

signed

boolean

required

denotes whether or not the required contract signatures are present

updated_at

date-time

required

program_minimum_age integer | null required

The minimum age requirement for drivers in this contract's program

ineligibility_reasons

object

required

Detailed information about why drivers may be ineligible for this contract

ineligible_drivers

array of objects

Array of drivers who do not meet the program requirements

ineligible_drivers

object

customer_id

integer | null

The customer ID (null for additional drivers)

is_primary_driver

boolean

Whether this is the primary driver

drivers_name

string

The driver's full name

born_on

date

The driver's date of birth in YYYY-MM-DD format

reason

string

The reason for ineligibility

is_contract_eligible

boolean

required

Whether the contract is eligible to start based on all eligibility checks

max_vehicle_swaps

integer

required

The maximum number of vehicle swaps that can be performed for this contract.

vehicle_swaps_performed

integer

required

The number of vehicle swaps that have been performed for this contract.

links

object

required

vehicle

object

vehicle object

fleet

object

fleet object

customer

object

customer object

dealership

object

dealership object

``400 Bad Request

``401 Unauthorized

``403 Forbidden

``404 Not found

``406 Not Acceptable

Updated3 months ago

Did this page help you?

Yes

No

ShellNodeRubyPHPPython

Bearer

Base URL

https://api.dealerware.com/admin/contracts/{id}

xxxxxxxxxx

curl --request GET \
     --url https://api.dealerware.com/admin/contracts/id \
     --header 'accept: application/json'

xxxxxxxxxx

{

"id": 42,

"actual_pickup_at": "2023-01-14T20:00:00Z",

"actual_dropoff_at": "2023-01-16T20:00:00Z",

"booked_car_detailed_description": {

"acriss_code": "LCAR",

"acriss_model_description": "Luxy 2/4 Door Automatic with AC",

"city_mpg": "21",

"fuel_tank": "17.4",

"hwy_mpg": "32",

"luggage": "2-3",

"make": "Lexus",

"model": "IS",

"passengers": "5",

"style": "300",

"type": "Sedan",

"year": "2020"

},

"booked_by_name": "Alexton McAnderson",

"booking_application": "web",

"booking_channel": "mykaarma",

"capabilities": {

"payments": {

"on_platform": true,

"off_platform": false

}

},

"confirmation_token": "7713738FG3",

"contactless": false,

"created_at": "2021-01-15T19:38:26Z",

"daily_rate_override": 29.95,

"damage_inspections": [\
\
    {\
\
      "vehicle_id": 42,\
\
      "status": "report_generated",\
\
      "pdf_report_url": "https://api.dealerware.com/rails/active_storage/blobs/redirect/abc123/report.pdf"\
\
    }\
\
  ],

"external_deposit_amount": 100,

"finished_by_name": "J. Last",

"fuel": {

"starting_fuel_gallons": 10.5,

"starting_fuel_liters": 39.7,

"ending_fuel_gallons": 8.2,

"ending_fuel_liters": 31,

"starting_fuel_percentage": 75,

"ending_fuel_percentage": 58

},

"location_sequence": 42,

"odometer": {

"starting_odometer_miles": 15234,

"starting_odometer_km": 24517,

"ending_odometer_miles": 15321,

"ending_odometer_km": 24660

},

"purchase_order": "PO123",

"repair_order": "1234ABC",

"service_vehicle_id": "1234ABC",

"service_vehicle_id_valid": true,

"status": "booked",

"scheduled_pickup_at": "2021-01-14T20:00:00Z",

"scheduled_dropoff_at": "2021-01-17T15:00:00Z",

"service_advisor_name": "Orange Cassidy",

"service_advisor_id": 123,

"signed": true,

"updated_at": "2021-01-14T19:38:26Z",

"program_minimum_age": 21,

"ineligibility_reasons": {

"ineligible_drivers": [\
\
      {\
\
        "customer_id": 123,\
\
        "is_primary_driver": true,\
\
        "drivers_name": "John Doe",\
\
        "born_on": "2000-01-01",\
\
        "reason": "underage"\
\
      }\
\
    ]

},

"is_contract_eligible": false,

"max_vehicle_swaps": 2,

"vehicle_swaps_performed": 1,

"links": {

"vehicle": {

"id": 2,

"href": "https://api.dw-tst.com/admin/some_resources/2"

},

"fleet": {

"id": 2,

"href": "https://api.dw-tst.com/admin/some_resources/2"

},

"customer": {

"id": 2,

"href": "https://api.dw-tst.com/admin/some_resources/2"

},

"dealership": {

"id": 2,

"href": "https://api.dw-tst.com/admin/some_resources/2"

}

}

}

Updated3 months ago

* * *

Did this page help you?

Yes

No