POST /bookings | Fleetee API documentation

POST /bookings Run in API Explorer

POST /bookings

Api key Secret key

application/json

Body

reference string
amount number
start_date string
end_date string
source string
status string
vehicle_category integer
vehicle_id integer
start_agency integer
end_agency integer
package_id integer
options array[object]
Hide options attributes Show options attributes object
- option_id integer
- quantity integer
drivers array[object]

Conducteurs additionnels
Hide drivers attributes Show drivers attributes object
- first_name string
- last_name string
- birthday string
  
  Date de naissance : YYYY-MM-DD
- license_number string
- license_date string
  
  Date d'obtention : YYYY-MM-DD
- license_country string
customer object
Hide customer attributes Show customer attributes object
- email string
- phone_number string
- first_name string
- last_name string
- address object
  Hide address attributes Show address attributes object
  
  street_line_one string
  
  street_line_two string
  
  district string
  
  postcode integer
  
  city string
- birthday string
  
  Date YYYY-MM-DD
- country string
  
  Code pays ex: FR
- nationality string
  
  Code pays ex: FR
- accounting_code string
  
  Code comptable
- birth_city string
- driving_license object
  Hide driving_license attributes Show driving_license attributes object
  
  license_number string
  
  license_date string
  
  Date YYYY-MM-DD
  
  license_country string
  
  Code pays ex: FR
- is_company boolean
  
  Default value is false.
- company_name string
  
  Nom de l'entreprise
franchise_levels array[object]
Hide franchise_levels attribute Show franchise_levels attribute object
- id integer
properties object
coupons array[object]
Hide coupons attribute Show coupons attribute object
- code string

Responses

200 application/json

200 response
Hide response attributes Show response attributes object
- id integer
- start_date string
- end_date string
- reference string
- vehicle object
  
  Hide vehicle attributes Show vehicle attributes object
  
  id integer
  
  registration_year integer
  
  registration_number string
  
  brand string
  
  model string
  
  category object
  
  Hide category attributes Show category attributes object
  
  id integer
  
  name string
- nb_days number
- status string
  
  Status des locations
  
  Values are waiting, confirm, check-in, check-out, or cancel.
- total_amount number
- source string
- created_at string
- start_agency object
  
  Agence
  
  Hide start_agency attributes Show start_agency attributes object
  
  id integer
  
  name string
  
  code string
  
  address object
  
  Hide address attributes Show address attributes object
  
  street_line_one string
  
  street_line_two string
  
  district string
  
  postcode integer
  
  city string
- end_agency object
  
  Agence
  
  Hide end_agency attributes Show end_agency attributes object
  
  id integer
  
  name string
  
  code string
  
  address object
  
  Hide address attributes Show address attributes object
  
  street_line_one string
  
  street_line_two string
  
  district string
  
  postcode integer
  
  city string
- amount number
- paid_amount number
- option_amount number
- coupon_amount number
- contract_url string
- category object
  
  Hide category attributes Show category attributes object
  
  id string
  
  name string
- option array[object]
  
  Hide option attributes Show option attributes object
  
  name string
  
  comment string
  
  quantity integer
  
  code_option string
  
  amount number
- pre_auth_amount number
- customer object
  
  Hide customer attributes Show customer attributes object
  
  id integer
  
  created_at string
  
  email string
  
  phone_number string
  
  first_name string
  
  last_name string
  
  name string
- secondary_drivers array[object]
  
  Hide secondary_drivers attributes Show secondary_drivers attributes object
  
  id integer
  
  created_at string
  
  email string
  
  phone_number string
  
  first_name string
  
  last_name string
  
  name string
  
  address object
  
  Hide address attributes Show address attributes object
  
  street_line_one string
  
  street_line_two string
  
  district string
  
  postcode integer
  
  city string
  
  driving_licenses array[object]
- driving_licences array[object]
  
  Hide driving_licences attributes Show driving_licences attributes object
  
  first_name string
  
  last_name string
  
  license_number string
  
  license_date string
  
  recto_url string
  
  verso_url string
  
  country string
- payments array[object]
  
  Hide payments attributes Show payments attributes object
  
  reference string
  
  amount number
  
  paid_amount number
  
  payment_method string
  
  Mode de paiement
  
  Values are card, check, cash, bank_transfer, vacation_check, or tourist_check.
  
  payment_type string
  
  Type de paiement
  
  Values are payment, down_payment, or deposit.
  
  card_type string
  
  date string
  
  comment string
  
  receipt_url string
- documents array[object]
  
  Hide documents attributes Show documents attributes object
  
  name string
  
  url string
- start_agency_extra_amount number
- end_agency_extra_amount number
- coupons object
  
  Hide coupons attributes Show coupons attributes object
  
  name string
  
  amount number
- start_inventory object
  
  Hide start_inventory attributes Show start_inventory attributes object
  
  date string
  
  kilometers integer
  
  fuel_level integer
  
  Niveau de carburant
  
  Values are 0, 1, 2, 4, 5, 6, 7, or 8.
  
  inside_clean boolean
  
  outside_clean boolean
  
  url string
- end_inventory object
  
  Hide end_inventory attributes Show end_inventory attributes object
  
  date string
  
  kilometers integer
  
  fuel_level integer
  
  Niveau de carburant
  
  Values are 0, 1, 2, 4, 5, 6, 7, or 8.
  
  inside_clean boolean
  
  outside_clean boolean
  
  url string
- franchise_levels array[object]
  
  Hide franchise_levels attributes Show franchise_levels attributes object
  
  id integer
  
  name string
  
  franchise_amount number
  
  amount number
  
  price_type string
  
  Type tarification d'option
  
  Values are per_day or total.
  
  deposit_amount number
  
  agencies array[object]
  
  Hide agencies attributes Show agencies attributes object
  
  id integer
  
  name string
  
  code string

POST /bookings

curl \
 --request POST 'https://api.fleetee.io/bookings' \
 --header "x-api-key: $API_KEY" \
 --header "Content-Type: application/json" \
 --data '{"reference":"string","amount":42.0,"start_date":"string","end_date":"string","source":"string","status":"string","vehicle_category":42,"vehicle_id":42,"start_agency":42,"end_agency":42,"package_id":42,"options":[{"option_id":42,"quantity":42}],"drivers":[{"first_name":"string","last_name":"string","birthday":"string","license_number":"string","license_date":"string","license_country":"string"}],"customer":{"email":"string","phone_number":"string","first_name":"string","last_name":"string","address":{"street_line_one":"string","street_line_two":"string","district":"string","postcode":42,"city":"string"},"birthday":"string","country":"string","nationality":"string","accounting_code":"string","birth_city":"string","driving_license":{"license_number":"string","license_date":"string","license_country":"string"},"is_company":false,"company_name":"string"},"franchise_levels":[{"id":42}],"properties":{},"coupons":[{"code":"string"}]}'

Request examples

{
  "reference": "string",
  "amount": 42.0,
  "start_date": "string",
  "end_date": "string",
  "source": "string",
  "status": "string",
  "vehicle_category": 42,
  "vehicle_id": 42,
  "start_agency": 42,
  "end_agency": 42,
  "package_id": 42,
  "options": [
    {
      "option_id": 42,
      "quantity": 42
    }
  ],
  "drivers": [
    {
      "first_name": "string",
      "last_name": "string",
      "birthday": "string",
      "license_number": "string",
      "license_date": "string",
      "license_country": "string"
    }
  ],
  "customer": {
    "email": "string",
    "phone_number": "string",
    "first_name": "string",
    "last_name": "string",
    "address": {
      "street_line_one": "string",
      "street_line_two": "string",
      "district": "string",
      "postcode": 42,
      "city": "string"
    },
    "birthday": "string",
    "country": "string",
    "nationality": "string",
    "accounting_code": "string",
    "birth_city": "string",
    "driving_license": {
      "license_number": "string",
      "license_date": "string",
      "license_country": "string"
    },
    "is_company": false,
    "company_name": "string"
  },
  "franchise_levels": [
    {
      "id": 42
    }
  ],
  "properties": {},
  "coupons": [
    {
      "code": "string"
    }
  ]
}

Response examples (200)

{
  "id": 42,
  "start_date": "string",
  "end_date": "string",
  "reference": "string",
  "vehicle": {
    "id": 42,
    "registration_year": 42,
    "registration_number": "string",
    "brand": "string",
    "model": "string",
    "category": {
      "id": 42,
      "name": "string"
    }
  },
  "nb_days": 42.0,
  "status": "waiting",
  "total_amount": 42.0,
  "source": "string",
  "created_at": "string",
  "start_agency": {
    "id": 42,
    "name": "string",
    "code": "string",
    "address": {
      "street_line_one": "string",
      "street_line_two": "string",
      "district": "string",
      "postcode": 42,
      "city": "string"
    }
  },
  "end_agency": {
    "id": 42,
    "name": "string",
    "code": "string",
    "address": {
      "street_line_one": "string",
      "street_line_two": "string",
      "district": "string",
      "postcode": 42,
      "city": "string"
    }
  },
  "amount": 42.0,
  "paid_amount": 42.0,
  "option_amount": 42.0,
  "coupon_amount": 42.0,
  "contract_url": "string",
  "category": {
    "id": "string",
    "name": "string"
  },
  "option": [
    {
      "name": "string",
      "comment": "string",
      "quantity": 42,
      "code_option": "string",
      "amount": 42.0
    }
  ],
  "pre_auth_amount": 42.0,
  "customer": {
    "id": 42,
    "created_at": "string",
    "email": "string",
    "phone_number": "string",
    "first_name": "string",
    "last_name": "string",
    "name": "string"
  },
  "secondary_drivers": [
    {
      "id": 42,
      "created_at": "string",
      "email": "string",
      "phone_number": "string",
      "first_name": "string",
      "last_name": "string",
      "name": "string",
      "address": {
        "street_line_one": "string",
        "street_line_two": "string",
        "district": "string",
        "postcode": 42,
        "city": "string"
      },
      "driving_licenses": [
        {}
      ]
    }
  ],
  "driving_licences": [
    {
      "first_name": "string",
      "last_name": "string",
      "license_number": "string",
      "license_date": "string",
      "recto_url": "string",
      "verso_url": "string",
      "country": "string"
    }
  ],
  "payments": [
    {
      "reference": "string",
      "amount": 42.0,
      "paid_amount": 42.0,
      "payment_method": "card",
      "payment_type": "payment",
      "card_type": "string",
      "date": "string",
      "comment": "string",
      "receipt_url": "string"
    }
  ],
  "documents": [
    {
      "name": "string",
      "url": "string"
    }
  ],
  "start_agency_extra_amount": 42.0,
  "end_agency_extra_amount": 42.0,
  "coupons": {
    "name": "string",
    "amount": 42.0
  },
  "start_inventory": {
    "date": "string",
    "kilometers": 42,
    "fuel_level": 0,
    "inside_clean": true,
    "outside_clean": true,
    "url": "string"
  },
  "end_inventory": {
    "date": "string",
    "kilometers": 42,
    "fuel_level": 0,
    "inside_clean": true,
    "outside_clean": true,
    "url": "string"
  },
  "franchise_levels": [
    {
      "id": 42,
      "name": "string",
      "franchise_amount": 42.0,
      "amount": 42.0,
      "price_type": "per_day",
      "deposit_amount": 42.0,
      "agencies": [
        {
          "id": 42,
          "name": "string",
          "code": "string"
        }
      ]
    }
  ]
}